@trinsic/api 3.0.2-preview1 → 3.1.0-preview1

package/dist/apis/SessionsApi.js

@@ -30,10 +30,9 @@ const index_1 = require("../models/index");
  */
 class SessionsApi extends runtime.BaseAPI {
     /**
-     * Cancel a Session by its ID
-     * Cancel Session
+     * Creates request options for cancelSession without sending the request
      */
-    cancelSessionRaw(requestParameters, initOverrides) {
+    cancelSessionRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sessionId'] == null) {
                 throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling cancelSession().');
@@ -47,12 +46,24 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/{sessionId}/cancel`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            let urlPath = `/api/v1/sessions/{sessionId}/cancel`;
+            urlPath = urlPath.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Cancel a Session by its ID
+     * Cancel Session
+     */
+    cancelSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.cancelSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CancelSessionResponseFromJSON)(jsonValue));
         });
     }
@@ -67,10 +78,9 @@ class SessionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Verify a user\'s identity with a specific provider, handling additional user interaction in your own UI.   Signal which kinds of user interactions your UI can handle using the `Capabilities` field.   If `FallbackToHostedUi` is `true`, Trinsic\'s hosted UI will automatically be invoked to handle any capabilities you do not support.
-     * Create Direct Provider Session
+     * Creates request options for createDirectProviderSession without sending the request
      */
-    createDirectProviderSessionRaw(requestParameters, initOverrides) {
+    createDirectProviderSessionRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
@@ -82,13 +92,24 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/provider/direct`,
+            let urlPath = `/api/v1/sessions/provider/direct`;
+            return {
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.CreateDirectProviderSessionRequestToJSON)(requestParameters['createDirectProviderSessionRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Verify a user\'s identity with a specific provider, handling additional user interaction in your own UI.   Signal which kinds of user interactions your UI can handle using the `Capabilities` field.   If `FallbackToHostedUi` is `true`, Trinsic\'s hosted UI will automatically be invoked to handle any capabilities you do not support.
+     * Create Direct Provider Session
+     */
+    createDirectProviderSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createDirectProviderSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateDirectProviderSessionResponseFromJSON)(jsonValue));
         });
     }
@@ -103,10 +124,9 @@ class SessionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Verify a user\'s identity with a specific provider, using Trinsic-hosted UI for providers which require additional user interaction.
-     * Create Hosted Provider Session
+     * Creates request options for createHostedProviderSession without sending the request
      */
-    createHostedProviderSessionRaw(requestParameters, initOverrides) {
+    createHostedProviderSessionRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
@@ -118,67 +138,41 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/provider/hosted`,
+            let urlPath = `/api/v1/sessions/provider/hosted`;
+            return {
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.CreateHostedProviderSessionRequestToJSON)(requestParameters['createHostedProviderSessionRequest']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateHostedProviderSessionResponseFromJSON)(jsonValue));
+            };
         });
     }
     /**
      * Verify a user\'s identity with a specific provider, using Trinsic-hosted UI for providers which require additional user interaction.
      * Create Hosted Provider Session
      */
-    createHostedProviderSession(createHostedProviderSessionRequest, initOverrides) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.createHostedProviderSessionRaw({ createHostedProviderSessionRequest: createHostedProviderSessionRequest }, initOverrides);
-            return yield response.value();
-        });
-    }
-    /**
-     * Verify a user\'s identity using Trinsic\'s hosted Widget flow.
-     * Create Widget Session
-     */
-    createWidgetSessionRaw(requestParameters, initOverrides) {
+    createHostedProviderSessionRaw(requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const queryParameters = {};
-            const headerParameters = {};
-            headerParameters['Content-Type'] = 'application/json';
-            if (this.configuration && this.configuration.accessToken) {
-                const token = this.configuration.accessToken;
-                const tokenString = yield token("Bearer", []);
-                if (tokenString) {
-                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
-                }
-            }
-            const response = yield this.request({
-                path: `/api/v1/sessions/widget`,
-                method: 'POST',
-                headers: headerParameters,
-                query: queryParameters,
-                body: (0, index_1.CreateWidgetSessionRequestToJSON)(requestParameters['createWidgetSessionRequest']),
-            }, initOverrides);
-            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateWidgetSessionResponseFromJSON)(jsonValue));
+            const requestOptions = yield this.createHostedProviderSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.CreateHostedProviderSessionResponseFromJSON)(jsonValue));
         });
     }
     /**
-     * Verify a user\'s identity using Trinsic\'s hosted Widget flow.
-     * Create Widget Session
+     * Verify a user\'s identity with a specific provider, using Trinsic-hosted UI for providers which require additional user interaction.
+     * Create Hosted Provider Session
      */
-    createWidgetSession(createWidgetSessionRequest, initOverrides) {
+    createHostedProviderSession(createHostedProviderSessionRequest, initOverrides) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.createWidgetSessionRaw({ createWidgetSessionRequest: createWidgetSessionRequest }, initOverrides);
+            const response = yield this.createHostedProviderSessionRaw({ createHostedProviderSessionRequest: createHostedProviderSessionRequest }, initOverrides);
             return yield response.value();
         });
     }
     /**
-     * Fetch an Attachment\'s contents.
-     * Get Attachment
+     * Creates request options for getAttachment without sending the request
      */
-    getAttachmentRaw(requestParameters, initOverrides) {
+    getAttachmentRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sessionId'] == null) {
                 throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getAttachment().');
@@ -196,13 +190,26 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/{sessionId}/attachments/{attachmentId}/get`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))).replace(`{${"attachmentId"}}`, encodeURIComponent(String(requestParameters['attachmentId']))),
+            let urlPath = `/api/v1/sessions/{sessionId}/attachments/{attachmentId}/get`;
+            urlPath = urlPath.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId'])));
+            urlPath = urlPath.replace(`{${"attachmentId"}}`, encodeURIComponent(String(requestParameters['attachmentId'])));
+            return {
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.GetAttachmentRequestToJSON)(requestParameters['getAttachmentRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Fetch an Attachment\'s contents.
+     * Get Attachment
+     */
+    getAttachmentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getAttachmentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetAttachmentResponseFromJSON)(jsonValue));
         });
     }
@@ -217,10 +224,9 @@ class SessionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get a Session by its ID
-     * Get Session
+     * Creates request options for getSession without sending the request
      */
-    getSessionRaw(requestParameters, initOverrides) {
+    getSessionRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sessionId'] == null) {
                 throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getSession().');
@@ -234,12 +240,24 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/{sessionId}`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            let urlPath = `/api/v1/sessions/{sessionId}`;
+            urlPath = urlPath.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Get a Session by its ID
+     * Get Session
+     */
+    getSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetSessionResponseFromJSON)(jsonValue));
         });
     }
@@ -254,9 +272,9 @@ class SessionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Get Session Results
+     * Creates request options for getSessionResult without sending the request
      */
-    getSessionResultRaw(requestParameters, initOverrides) {
+    getSessionResultRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sessionId'] == null) {
                 throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling getSessionResult().');
@@ -271,13 +289,24 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/{sessionId}/results`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            let urlPath = `/api/v1/sessions/{sessionId}/results`;
+            urlPath = urlPath.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.GetSessionResultRequestToJSON)(requestParameters['getSessionResultRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Get Session Results
+     */
+    getSessionResultRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getSessionResultRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetSessionResultResponseFromJSON)(jsonValue));
         });
     }
@@ -291,10 +320,9 @@ class SessionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * List Sessions created for a specific Verification Profile
-     * List Sessions
+     * Creates request options for listSessions without sending the request
      */
-    listSessionsRaw(requestParameters, initOverrides) {
+    listSessionsRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['verificationProfileId'] == null) {
                 throw new runtime.RequiredError('verificationProfileId', 'Required parameter "verificationProfileId" was null or undefined when calling listSessions().');
@@ -320,12 +348,24 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/verification-profiles/{verificationProfileId}/sessions`.replace(`{${"verificationProfileId"}}`, encodeURIComponent(String(requestParameters['verificationProfileId']))),
+            let urlPath = `/api/v1/verification-profiles/{verificationProfileId}/sessions`;
+            urlPath = urlPath.replace(`{${"verificationProfileId"}}`, encodeURIComponent(String(requestParameters['verificationProfileId'])));
+            return {
+                path: urlPath,
                 method: 'GET',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * List Sessions created for a specific Verification Profile
+     * List Sessions
+     */
+    listSessionsRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.listSessionsRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.ListSessionsResponseFromJSON)(jsonValue));
         });
     }
@@ -340,10 +380,9 @@ class SessionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Recommend providers for a specific user session. You can filter based on health (default=online) and specify country and subdivision information. Trinsic will use the phone number and IP address, if provided, to deduce the country and subdivision of the user and use that info for filtering the providers.
-     * Recommend Providers
+     * Creates request options for recommendProviders without sending the request
      */
-    recommendProvidersRaw(requestParameters, initOverrides) {
+    recommendProvidersRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             const queryParameters = {};
             const headerParameters = {};
@@ -355,13 +394,24 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/providers/recommend`,
+            let urlPath = `/api/v1/sessions/providers/recommend`;
+            return {
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.RecommendProvidersRequestToJSON)(requestParameters['recommendProvidersRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Recommend providers for a specific user session. You can filter based on health (default=online) and specify country and subdivision information. Trinsic will use the phone number and IP address, if provided, to deduce the country and subdivision of the user and use that info for filtering the providers.
+     * Recommend Providers
+     */
+    recommendProvidersRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.recommendProvidersRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RecommendProvidersResponseFromJSON)(jsonValue));
         });
     }
@@ -376,10 +426,9 @@ class SessionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Redact a Session, removing all identity data from Trinsic\'s servers. Every verification profile has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately.
-     * Redact Session
+     * Creates request options for redactSession without sending the request
      */
-    redactSessionRaw(requestParameters, initOverrides) {
+    redactSessionRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sessionId'] == null) {
                 throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling redactSession().');
@@ -393,12 +442,24 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/{sessionId}/redact`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            let urlPath = `/api/v1/sessions/{sessionId}/redact`;
+            urlPath = urlPath.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Redact a Session, removing all identity data from Trinsic\'s servers. Every verification profile has a redaction period that dictates how long we will hold on to your users\' PII data. Once a session falls outside the redaction cutoff date, all PII will automatically be removed from that session. You can utilize this endpoint to redact a session immediately.
+     * Redact Session
+     */
+    redactSessionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.redactSessionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.VoidApiResponse(response);
         });
     }
@@ -412,10 +473,9 @@ class SessionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Refreshes the content of a Step for a Direct Provider Session.
-     * Refresh Step Content
+     * Creates request options for refreshStepContent without sending the request
      */
-    refreshStepContentRaw(requestParameters, initOverrides) {
+    refreshStepContentRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sessionId'] == null) {
                 throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling refreshStepContent().');
@@ -430,13 +490,25 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/{sessionId}/step/refresh`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            let urlPath = `/api/v1/sessions/{sessionId}/step/refresh`;
+            urlPath = urlPath.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.RefreshStepContentRequestToJSON)(requestParameters['refreshStepContentRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Refreshes the content of a Step for a Direct Provider Session.
+     * Refresh Step Content
+     */
+    refreshStepContentRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.refreshStepContentRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.RefreshStepContentResponseFromJSON)(jsonValue));
         });
     }
@@ -451,10 +523,9 @@ class SessionsApi extends runtime.BaseAPI {
         });
     }
     /**
-     * Submits the response from a Native Challenge (e.g., mDL exchange via DC API) and processes the results.
-     * Submit Native Challenge Response
+     * Creates request options for submitNativeChallengeResponse without sending the request
      */
-    submitNativeChallengeResponseRaw(requestParameters, initOverrides) {
+    submitNativeChallengeResponseRequestOpts(requestParameters) {
         return __awaiter(this, void 0, void 0, function* () {
             if (requestParameters['sessionId'] == null) {
                 throw new runtime.RequiredError('sessionId', 'Required parameter "sessionId" was null or undefined when calling submitNativeChallengeResponse().');
@@ -469,13 +540,25 @@ class SessionsApi extends runtime.BaseAPI {
                     headerParameters["Authorization"] = `Bearer ${tokenString}`;
                 }
             }
-            const response = yield this.request({
-                path: `/api/v1/sessions/{sessionId}/native-challenge/submit`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            let urlPath = `/api/v1/sessions/{sessionId}/native-challenge/submit`;
+            urlPath = urlPath.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId'])));
+            return {
+                path: urlPath,
                 method: 'POST',
                 headers: headerParameters,
                 query: queryParameters,
                 body: (0, index_1.SubmitNativeChallengeResponseRequestToJSON)(requestParameters['submitNativeChallengeResponseRequest']),
-            }, initOverrides);
+            };
+        });
+    }
+    /**
+     * Submits the response from a Native Challenge (e.g., mDL exchange via DC API) and processes the results.
+     * Submit Native Challenge Response
+     */
+    submitNativeChallengeResponseRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.submitNativeChallengeResponseRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
             return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.SubmitNativeChallengeResponseResponseFromJSON)(jsonValue));
         });
     }

package/dist/apis/VerificationProfilesApi.d.ts

@@ -15,12 +15,16 @@ export interface CreateVerificationProfileRequest {
     alias: string;
     brandName: string;
     primaryColor?: string;
+    externalId?: string;
     providers?: Array<string>;
     logo?: Blob;
     redactionPeriod?: string;
     sessionExpiration?: string;
     isProductionUsage?: boolean;
 }
+export interface GetVerificationProfileByExternalIdRequest {
+    externalId: string;
+}
 export interface GetVerificationProfileByIdRequest {
     id: string;
 }
@@ -35,12 +39,28 @@ export interface ListVerificationProfilesRequest {
  * @interface VerificationProfilesApiInterface
  */
 export interface VerificationProfilesApiInterface {
+    /**
+     * Creates request options for createVerificationProfile without sending the request
+     * @param {string} alias An alias of the verification profile shown to developers and administrators.
+     * @param {string} brandName The brand name of the verification profile shown to end-users.
+     * @param {string} [primaryColor] The primary color of the verification profile. Must be a 6-character hex string prefixed with a \\\&#39;#\\\&#39; character. Example: #000000
+     * @param {string} [externalId] A customer-defined external ID for this verification profile. Must be unique within your organization and be at most 255 characters long.
+     * @param {Array<string>} [providers] The list of providers you\\\&#39;d like to select for this profile. We will not currently enable any providers.
+     * @param {Blob} [logo] The logo of the verification profile.
+     * @param {string} [redactionPeriod] The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days.
+     * @param {string} [sessionExpiration] The session expiration for verification sessions created with this profile. Must be between 15 minutes and 24 hours. Defaults to 1 hour if not specified.
+     * @param {boolean} [isProductionUsage] Whether this profile is for production usage. Only applicable for Live environment profiles. If not specified for Live profiles, defaults to false (Demo).
+     * @throws {RequiredError}
+     * @memberof VerificationProfilesApiInterface
+     */
+    createVerificationProfileRequestOpts(requestParameters: CreateVerificationProfileRequest): Promise<runtime.RequestOpts>;
     /**
      * Creates a new verification profile within your organization.
      * @summary Create Verification Profile
      * @param {string} alias An alias of the verification profile shown to developers and administrators.
      * @param {string} brandName The brand name of the verification profile shown to end-users.
      * @param {string} [primaryColor] The primary color of the verification profile. Must be a 6-character hex string prefixed with a \\\&#39;#\\\&#39; character. Example: #000000
+     * @param {string} [externalId] A customer-defined external ID for this verification profile. Must be unique within your organization and be at most 255 characters long.
      * @param {Array<string>} [providers] The list of providers you\\\&#39;d like to select for this profile. We will not currently enable any providers.
      * @param {Blob} [logo] The logo of the verification profile.
      * @param {string} [redactionPeriod] The redaction period for verification data. Must be between 0 and 31 days, and at least 15 minutes greater than the session expiration. If not specified, defaults to 31 days.
@@ -55,7 +75,35 @@ export interface VerificationProfilesApiInterface {
      * Creates a new verification profile within your organization.
      * Create Verification Profile
      */
-    createVerificationProfile(alias: string, brandName: string, primaryColor?: string, providers?: Array<string>, logo?: Blob, redactionPeriod?: string, sessionExpiration?: string, isProductionUsage?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateVerificationProfileResponse>;
+    createVerificationProfile(alias: string, brandName: string, primaryColor?: string, externalId?: string, providers?: Array<string>, logo?: Blob, redactionPeriod?: string, sessionExpiration?: string, isProductionUsage?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateVerificationProfileResponse>;
+    /**
+     * Creates request options for getVerificationProfileByExternalId without sending the request
+     * @param {string} externalId Customer-defined external ID
+     * @throws {RequiredError}
+     * @memberof VerificationProfilesApiInterface
+     */
+    getVerificationProfileByExternalIdRequestOpts(requestParameters: GetVerificationProfileByExternalIdRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Gets a specific verification profile by its customer-defined external ID.
+     * @summary Get Verification Profile by External ID
+     * @param {string} externalId Customer-defined external ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof VerificationProfilesApiInterface
+     */
+    getVerificationProfileByExternalIdRaw(requestParameters: GetVerificationProfileByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VerificationProfileResponse>>;
+    /**
+     * Gets a specific verification profile by its customer-defined external ID.
+     * Get Verification Profile by External ID
+     */
+    getVerificationProfileByExternalId(externalId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerificationProfileResponse>;
+    /**
+     * Creates request options for getVerificationProfileById without sending the request
+     * @param {string} id
+     * @throws {RequiredError}
+     * @memberof VerificationProfilesApiInterface
+     */
+    getVerificationProfileByIdRequestOpts(requestParameters: GetVerificationProfileByIdRequest): Promise<runtime.RequestOpts>;
     /**
      * Gets a specific verification profile by ID.
      * @summary Get Verification Profile
@@ -70,6 +118,14 @@ export interface VerificationProfilesApiInterface {
      * Get Verification Profile
      */
     getVerificationProfileById(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerificationProfileResponse>;
+    /**
+     * Creates request options for listVerificationProfiles without sending the request
+     * @param {number} [page]
+     * @param {number} [pageSize] Size of the list to be returned. Accepted range from 1 to 100
+     * @throws {RequiredError}
+     * @memberof VerificationProfilesApiInterface
+     */
+    listVerificationProfilesRequestOpts(requestParameters: ListVerificationProfilesRequest): Promise<runtime.RequestOpts>;
     /**
      * List the verification profiles for the current organization and environment.
      * @summary List Verification Profiles
@@ -90,6 +146,10 @@ export interface VerificationProfilesApiInterface {
  *
  */
 export declare class VerificationProfilesApi extends runtime.BaseAPI implements VerificationProfilesApiInterface {
+    /**
+     * Creates request options for createVerificationProfile without sending the request
+     */
+    createVerificationProfileRequestOpts(requestParameters: CreateVerificationProfileRequest): Promise<runtime.RequestOpts>;
     /**
      * Creates a new verification profile within your organization.
      * Create Verification Profile
@@ -99,7 +159,25 @@ export declare class VerificationProfilesApi extends runtime.BaseAPI implements
      * Creates a new verification profile within your organization.
      * Create Verification Profile
      */
-    createVerificationProfile(alias: string, brandName: string, primaryColor?: string, providers?: Array<string>, logo?: Blob, redactionPeriod?: string, sessionExpiration?: string, isProductionUsage?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateVerificationProfileResponse>;
+    createVerificationProfile(alias: string, brandName: string, primaryColor?: string, externalId?: string, providers?: Array<string>, logo?: Blob, redactionPeriod?: string, sessionExpiration?: string, isProductionUsage?: boolean, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateVerificationProfileResponse>;
+    /**
+     * Creates request options for getVerificationProfileByExternalId without sending the request
+     */
+    getVerificationProfileByExternalIdRequestOpts(requestParameters: GetVerificationProfileByExternalIdRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Gets a specific verification profile by its customer-defined external ID.
+     * Get Verification Profile by External ID
+     */
+    getVerificationProfileByExternalIdRaw(requestParameters: GetVerificationProfileByExternalIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VerificationProfileResponse>>;
+    /**
+     * Gets a specific verification profile by its customer-defined external ID.
+     * Get Verification Profile by External ID
+     */
+    getVerificationProfileByExternalId(externalId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerificationProfileResponse>;
+    /**
+     * Creates request options for getVerificationProfileById without sending the request
+     */
+    getVerificationProfileByIdRequestOpts(requestParameters: GetVerificationProfileByIdRequest): Promise<runtime.RequestOpts>;
     /**
      * Gets a specific verification profile by ID.
      * Get Verification Profile
@@ -110,6 +188,10 @@ export declare class VerificationProfilesApi extends runtime.BaseAPI implements
      * Get Verification Profile
      */
     getVerificationProfileById(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VerificationProfileResponse>;
+    /**
+     * Creates request options for listVerificationProfiles without sending the request
+     */
+    listVerificationProfilesRequestOpts(requestParameters: ListVerificationProfilesRequest): Promise<runtime.RequestOpts>;
     /**
      * List the verification profiles for the current organization and environment.
      * List Verification Profiles