Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@W-16589742: [iOS] REST wrappers for select SFAP APIs #3801

Merged
merged 9 commits into from
Jan 17, 2025
Merged

@W-16589742: [iOS] REST wrappers for select SFAP APIs #3801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7d974c3
@W-16589742: [iOS] REST wrappers for select SFAP APIs
JohnsonEricAtSalesforce Jan 13, 2025
a401e1a
@W-16589742: [iOS] REST wrappers for select SFAP APIs (Self-Review Up…
JohnsonEricAtSalesforce Jan 13, 2025
70101dc
@W-16589742: [iOS] REST wrappers for select SFAP APIs (Team-Review Up…
JohnsonEricAtSalesforce Jan 14, 2025
8987b9a
@W-16589742: [iOS] REST wrappers for select SFAP APIs (Implementation…
JohnsonEricAtSalesforce Jan 16, 2025
84b883d
@W-16589742: [iOS] REST wrappers for select SFAP APIs (Rename SfapAPI…
JohnsonEricAtSalesforce Jan 16, 2025
5827e32
@W-16589742: [iOS] REST wrappers for select SFAP APIs (Update Xcode P…
JohnsonEricAtSalesforce Jan 16, 2025
981eab4
@W-16589742: [iOS] REST wrappers for select SFAP APIs (Team Code Revi…
JohnsonEricAtSalesforce Jan 16, 2025
74df154
@W-16589742: [iOS] REST wrappers for select SFAP APIs (One More `Sfap…
JohnsonEricAtSalesforce Jan 16, 2025
fe63b95
@W-16589742: [iOS] REST wrappers for select SFAP APIs (Additional Nam…
JohnsonEricAtSalesforce Jan 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 79 additions & 27 deletions libs/SalesforceSDKCore/SalesforceSDKCore.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -389,6 +389,17 @@
CED452ED1D808DEE009266EB /* SFNativeRestRequestListener.h in Headers */ = {isa = PBXBuildFile; fileRef = CED452E91D808DEE009266EB /* SFNativeRestRequestListener.h */; };
CED452EF1D808E0A009266EB /* SFNativeRestRequestListener.m in Sources */ = {isa = PBXBuildFile; fileRef = CED452EA1D808DEE009266EB /* SFNativeRestRequestListener.m */; };
CED452F01D808E0F009266EB /* SalesforceRestAPITests.m in Sources */ = {isa = PBXBuildFile; fileRef = CED452E81D808DEE009266EB /* SalesforceRestAPITests.m */; };
D3D675DB2D39EF01008E468E /* ChatGenerationsRequestBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675CF2D39EF01008E468E /* ChatGenerationsRequestBody.swift */; };
D3D675DC2D39EF01008E468E /* EmbeddingsRequestBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D12D39EF01008E468E /* EmbeddingsRequestBody.swift */; };
D3D675DD2D39EF01008E468E /* ChatGenerationsResponseBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D02D39EF01008E468E /* ChatGenerationsResponseBody.swift */; };
D3D675DE2D39EF01008E468E /* GenerationsResponseBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D62D39EF01008E468E /* GenerationsResponseBody.swift */; };
D3D675DF2D39EF01008E468E /* SfapClient.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D72D39EF01008E468E /* SfapClient.swift */; };
D3D675E02D39EF01008E468E /* SfapErrorResponseBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D92D39EF01008E468E /* SfapErrorResponseBody.swift */; };
D3D675E12D39EF01008E468E /* FeedbackResponseBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D42D39EF01008E468E /* FeedbackResponseBody.swift */; };
D3D675E22D39EF01008E468E /* SfapError.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D82D39EF01008E468E /* SfapError.swift */; };
D3D675E32D39EF01008E468E /* GenerationsRequestBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D52D39EF01008E468E /* GenerationsRequestBody.swift */; };
D3D675E42D39EF01008E468E /* FeedbackRequestBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D32D39EF01008E468E /* FeedbackRequestBody.swift */; };
D3D675E52D39EF01008E468E /* EmbeddingsResponseBody.swift in Sources */ = {isa = PBXBuildFile; fileRef = D3D675D22D39EF01008E468E /* EmbeddingsResponseBody.swift */; };
E1C80CDF1C5AEBFA001B3A21 /* SFLoginViewController.h in Headers */ = {isa = PBXBuildFile; fileRef = E1C80CDD1C5AEBFA001B3A21 /* SFLoginViewController.h */; settings = {ATTRIBUTES = (Public, ); }; };
E1C80CE01C5AEBFA001B3A21 /* SFLoginViewController.m in Sources */ = {isa = PBXBuildFile; fileRef = E1C80CDE1C5AEBFA001B3A21 /* SFLoginViewController.m */; };
E1C80CEC1C5AEE31001B3A21 /* SFSDKLoginHost.h in Headers */ = {isa = PBXBuildFile; fileRef = E1C80CE11C5AEE31001B3A21 /* SFSDKLoginHost.h */; settings = {ATTRIBUTES = (Public, ); }; };
Expand Down Expand Up @@ -894,6 +905,17 @@
CED452E81D808DEE009266EB /* SalesforceRestAPITests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SalesforceRestAPITests.m; path = SalesforceSDKCoreTests/SalesforceRestAPITests.m; sourceTree = SOURCE_ROOT; };
CED452E91D808DEE009266EB /* SFNativeRestRequestListener.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SFNativeRestRequestListener.h; path = SalesforceSDKCoreTests/SFNativeRestRequestListener.h; sourceTree = SOURCE_ROOT; };
CED452EA1D808DEE009266EB /* SFNativeRestRequestListener.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SFNativeRestRequestListener.m; path = SalesforceSDKCoreTests/SFNativeRestRequestListener.m; sourceTree = SOURCE_ROOT; };
D3D675CF2D39EF01008E468E /* ChatGenerationsRequestBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatGenerationsRequestBody.swift; sourceTree = "<group>"; };
D3D675D02D39EF01008E468E /* ChatGenerationsResponseBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ChatGenerationsResponseBody.swift; sourceTree = "<group>"; };
D3D675D12D39EF01008E468E /* EmbeddingsRequestBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EmbeddingsRequestBody.swift; sourceTree = "<group>"; };
D3D675D22D39EF01008E468E /* EmbeddingsResponseBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EmbeddingsResponseBody.swift; sourceTree = "<group>"; };
D3D675D32D39EF01008E468E /* FeedbackRequestBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FeedbackRequestBody.swift; sourceTree = "<group>"; };
D3D675D42D39EF01008E468E /* FeedbackResponseBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FeedbackResponseBody.swift; sourceTree = "<group>"; };
D3D675D52D39EF01008E468E /* GenerationsRequestBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GenerationsRequestBody.swift; sourceTree = "<group>"; };
D3D675D62D39EF01008E468E /* GenerationsResponseBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GenerationsResponseBody.swift; sourceTree = "<group>"; };
D3D675D72D39EF01008E468E /* SfapClient.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SfapClient.swift; sourceTree = "<group>"; };
D3D675D82D39EF01008E468E /* SfapError.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SfapError.swift; sourceTree = "<group>"; };
D3D675D92D39EF01008E468E /* SfapErrorResponseBody.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = SfapErrorResponseBody.swift; sourceTree = "<group>"; };
E1C80CDD1C5AEBFA001B3A21 /* SFLoginViewController.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SFLoginViewController.h; path = Login/SFLoginViewController.h; sourceTree = "<group>"; };
E1C80CDE1C5AEBFA001B3A21 /* SFLoginViewController.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = SFLoginViewController.m; path = Login/SFLoginViewController.m; sourceTree = "<group>"; };
E1C80CE11C5AEE31001B3A21 /* SFSDKLoginHost.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = SFSDKLoginHost.h; path = Login/LoginHost/SFSDKLoginHost.h; sourceTree = "<group>"; };
Expand Down Expand Up @@ -1387,23 +1409,23 @@
82AF840C16DFD95F008912EF /* Classes */ = {
isa = PBXGroup;
children = (
B722A702233C432E0089736E /* Extensions */,
B7FB26CA1F78096300FB25A2 /* URLHandlers */,
B7FB26B51F78094A00FB25A2 /* IDP */,
B7A20F7C1F25850E00D1E4B0 /* Views */,
CED452A81D808D0C009266EB /* RestAPI */,
CE145A881D137FD2003BCC20 /* Analytics */,
E139509E1C535F9C00575C03 /* Login */,
4F96FC511BFD32130022F021 /* Common */,
B722A702233C432E0089736E /* Extensions */,
4F96FC631BFD32130022F021 /* Identity */,
B7FB26B51F78094A00FB25A2 /* IDP */,
4F96FC691BFD32130022F021 /* Instrumentation */,
E139509E1C535F9C00575C03 /* Login */,
4F96FCC41BFD32130022F021 /* OAuth */,
4F96FCD81BFD32130022F021 /* PushNotification */,
6935FB9823FDE919002BEFCC /* UserAccount */,
CED452A81D808D0C009266EB /* RestAPI */,
4F96FCEA1BFD32130022F021 /* Security */,
69C5F99F24A3D999002C294D /* Storage */,
4F96FD2E1BFD32140022F021 /* Test */,
B7FB26CA1F78096300FB25A2 /* URLHandlers */,
6935FB9823FDE919002BEFCC /* UserAccount */,
4F96FD371BFD32140022F021 /* Util */,
B7A20F7C1F25850E00D1E4B0 /* Views */,
);
path = Classes;
sourceTree = "<group>";
Expand Down Expand Up @@ -1588,47 +1610,66 @@
CED452A81D808D0C009266EB /* RestAPI */ = {
isa = PBXGroup;
children = (
4F5727DC27F27F1A0008CDA4 /* SFSDKPrimingRecordsResponse.h */,
4F5727E227F27F1A0008CDA4 /* SFSDKPrimingRecordsResponse.m */,
69E2FD9622FB937F008E0AF0 /* SFSDKEncryptedURLCache.h */,
69E2FD9D22FB937F008E0AF0 /* SFSDKEncryptedURLCache.m */,
6938392423C82F38008E8E9A /* SFSDKNullURLCache.h */,
6938392523C82F38008E8E9A /* SFSDKNullURLCache.m */,
D3D675DA2D39EF01008E468E /* SfapAPI */,
CE7F66291E556CA800DC3FBB /* SFNetwork.h */,
CE7F662A1E556CA800DC3FBB /* SFNetwork.m */,
CED452B01D808D0C009266EB /* SFRestAPI.h */,
CED452B11D808D0C009266EB /* SFRestAPI.m */,
CED452A91D808D0C009266EB /* SFRestAPI+Blocks.h */,
CED452AA1D808D0C009266EB /* SFRestAPI+Blocks.m */,
CED452AB1D808D0C009266EB /* SFRestAPI+Files.h */,
CED452AC1D808D0C009266EB /* SFRestAPI+Files.m */,
CED452AD1D808D0C009266EB /* SFRestAPI+Internal.h */,
CED452AE1D808D0C009266EB /* SFRestAPI+QueryBuilder.h */,
CED452AF1D808D0C009266EB /* SFRestAPI+QueryBuilder.m */,
6900D802243D521C00888336 /* SFRestAPI+Notifications.h */,
6900D803243D521C00888336 /* SFRestAPI+Notifications.m */,
CED452B01D808D0C009266EB /* SFRestAPI.h */,
CED452B11D808D0C009266EB /* SFRestAPI.m */,
CED452B41D808D0C009266EB /* SFRestRequest+Internal.h */,
CED452AE1D808D0C009266EB /* SFRestAPI+QueryBuilder.h */,
CED452AF1D808D0C009266EB /* SFRestAPI+QueryBuilder.m */,
CED452B51D808D0C009266EB /* SFRestRequest.h */,
CED452B61D808D0C009266EB /* SFRestRequest.m */,
FDCECBE6688B51C1B9BDC524 /* SFSObjectTree.m */,
FDCEC40C4B860474C90D02AF /* SFSObjectTree.h */,
B7895D0B2345015B00765D85 /* SFSDKCompositeRequest.h */,
B7895D0C2345015B00765D85 /* SFSDKCompositeRequest.m */,
B7895D1323450E8E00765D85 /* SFSDKCompositeRequest+Internal.h */,
B7895D172345304800765D85 /* SFSDKCompositeResponse.h */,
B7895D8123469DE200765D85 /* SFSDKCompositeResponse+Internal.h */,
B7895D182345304800765D85 /* SFSDKCompositeResponse.m */,
CED452B41D808D0C009266EB /* SFRestRequest+Internal.h */,
B7460C0C2347DD4E00C7512E /* SFSDKBatchRequest.h */,
B7460C0D2347DD4E00C7512E /* SFSDKBatchRequest.m */,
B7460C192347E1A100C7512E /* SFSDKBatchResponse.h */,
B7460C1A2347E1A100C7512E /* SFSDKBatchResponse.m */,
B7460C0D2347DD4E00C7512E /* SFSDKBatchRequest.m */,
B7460C1D2347E1CB00C7512E /* SFSDKBatchResponse+Internal.h */,
4F2410A9282DC87A00E5EFE3 /* SFSDKCollectionResponse.h */,
4F2410B0282DCA4B00E5EFE3 /* SFSDKCollectionResponse.m */,
B7895D0B2345015B00765D85 /* SFSDKCompositeRequest.h */,
B7895D0C2345015B00765D85 /* SFSDKCompositeRequest.m */,
B7895D1323450E8E00765D85 /* SFSDKCompositeRequest+Internal.h */,
B7895D172345304800765D85 /* SFSDKCompositeResponse.h */,
B7895D182345304800765D85 /* SFSDKCompositeResponse.m */,
B7895D8123469DE200765D85 /* SFSDKCompositeResponse+Internal.h */,
69E2FD9622FB937F008E0AF0 /* SFSDKEncryptedURLCache.h */,
69E2FD9D22FB937F008E0AF0 /* SFSDKEncryptedURLCache.m */,
6938392423C82F38008E8E9A /* SFSDKNullURLCache.h */,
6938392523C82F38008E8E9A /* SFSDKNullURLCache.m */,
4F5727DC27F27F1A0008CDA4 /* SFSDKPrimingRecordsResponse.h */,
4F5727E227F27F1A0008CDA4 /* SFSDKPrimingRecordsResponse.m */,
FDCEC40C4B860474C90D02AF /* SFSObjectTree.h */,
FDCECBE6688B51C1B9BDC524 /* SFSObjectTree.m */,
);
path = RestAPI;
sourceTree = "<group>";
};
D3D675DA2D39EF01008E468E /* SfapAPI */ = {
isa = PBXGroup;
children = (
D3D675CF2D39EF01008E468E /* ChatGenerationsRequestBody.swift */,
D3D675D02D39EF01008E468E /* ChatGenerationsResponseBody.swift */,
D3D675D12D39EF01008E468E /* EmbeddingsRequestBody.swift */,
D3D675D22D39EF01008E468E /* EmbeddingsResponseBody.swift */,
D3D675D32D39EF01008E468E /* FeedbackRequestBody.swift */,
D3D675D42D39EF01008E468E /* FeedbackResponseBody.swift */,
D3D675D52D39EF01008E468E /* GenerationsRequestBody.swift */,
D3D675D62D39EF01008E468E /* GenerationsResponseBody.swift */,
D3D675D72D39EF01008E468E /* SfapClient.swift */,
D3D675D82D39EF01008E468E /* SfapError.swift */,
D3D675D92D39EF01008E468E /* SfapErrorResponseBody.swift */,
);
path = SfapAPI;
sourceTree = "<group>";
};
E139509E1C535F9C00575C03 /* Login */ = {
isa = PBXGroup;
children = (
Expand Down Expand Up @@ -2189,6 +2230,17 @@
CE4CE3261C0E523B009F6029 /* UIScreen+SFAdditions.m in Sources */,
B7C273F01F7EEFB700CE539D /* SFSDKIDPConstants.m in Sources */,
B767704D223AE5E400545C90 /* SFRestAPI+Instrumentation.m in Sources */,
D3D675DB2D39EF01008E468E /* ChatGenerationsRequestBody.swift in Sources */,
D3D675DC2D39EF01008E468E /* EmbeddingsRequestBody.swift in Sources */,
D3D675DD2D39EF01008E468E /* ChatGenerationsResponseBody.swift in Sources */,
D3D675DE2D39EF01008E468E /* GenerationsResponseBody.swift in Sources */,
D3D675DF2D39EF01008E468E /* SfapClient.swift in Sources */,
D3D675E02D39EF01008E468E /* SfapErrorResponseBody.swift in Sources */,
D3D675E12D39EF01008E468E /* FeedbackResponseBody.swift in Sources */,
D3D675E22D39EF01008E468E /* SfapError.swift in Sources */,
D3D675E32D39EF01008E468E /* GenerationsRequestBody.swift in Sources */,
D3D675E42D39EF01008E468E /* FeedbackRequestBody.swift in Sources */,
D3D675E52D39EF01008E468E /* EmbeddingsResponseBody.swift in Sources */,
695E86BA29EF8D6E002BDEA6 /* SFSDKIDPAuthCodeLoginRequestCommand.m in Sources */,
B7C2745C1F8151E300CE539D /* SFSDKAuthErrorCommand.m in Sources */,
CE4CE30A1C0E523B009F6029 /* NSURL+SFAdditions.m in Sources */,
Expand Down
115 changes: 115 additions & 0 deletions ...esforceSDKCore/SalesforceSDKCore/Classes/RestAPI/SFAPAPI/ChatGenerationsRequestBody.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
/*
ChatGenerationsRequestBody.swift
SalesforceSDKCore

Created by Eric C. Johnson ([email protected]) on 20250114.

Copyright (c) 2025-present, salesforce.com, inc. All rights reserved.

Redistribution and use of this software in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions
and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials provided
with the distribution.
* Neither the name of salesforce.com, inc. nor the names of its contributors may be used to
endorse or promote products derived from this software without specific prior written
permission of salesforce.com, inc.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

import Foundation

/**
* Models a `sfap_api` `chat-generations` endpoint request.
* See https://developer.salesforce.com/docs/einstein/genai/references/models-api?meta=generateChat
*
* The endpoint accepts a `tags` object. To provide `tags`, subclass and introduce a
* new parameter of any object type named `tags`. Also, the subclass will need to conform to
* `Codable` and provide handling for the custom `tags` object's encoding and decoding as in
* the following sample code.
* required init(from decoder: any Decoder) throws {
* let container = try decoder.container(keyedBy: CodingKeys.self)
* self.tags = try container.decode(Tags.self, forKey: .tags)
* try super.init(from: decoder)
* }
*
* public init(
* // Provide superclass parameters
* tags: Tags
* ) {
* self.tags = tags
* super.init( // Provide superclass parameters)
* }
*
* public override func encode(to encoder: any Encoder) throws {
* var container = encoder.container(keyedBy: CodingKeys.self)
* try container.encode(tags, forKey: .tag`)
* try super.encode(to: encoder)
* }
*/
@objc(SFChatGenerationsRequestBody)
open class ChatGenerationsRequestBody : NSObject, Codable {

/// The request messages parameter value
public let messages: Array<Message>

/// The request localization parameter value
public let localization: Localization

public init(
messages: Array<Message>,
localization: Localization
) {
self.messages = messages
self.localization = localization
}

public struct Message : Codable {
public let role: String
public let content: String

public init(role: String, content: String) {
self.role = role
self.content = content
}
}

public struct Localization : Codable {
public let defaultLocale: String
public let inputLocales: Array<Locale>
public let expectedLocales: Array<String>

public init(
defaultLocale: String,
inputLocales: Array<Locale>,
expectedLocales: Array<String>
) {
self.defaultLocale = defaultLocale
self.inputLocales = inputLocales
self.expectedLocales = expectedLocales
}
}

public struct Locale : Codable {
public let locale: String
public let probability: Double

public init(
locale: String,
probability: Double
) {
self.locale = locale
self.probability = probability
}
}
}
Loading
Loading