@trinsic/api 3.0.1 → 3.1.0-preview1

package/dist/esm/apis/SessionsApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { CancelSessionResponse, CreateDirectProviderSessionRequest, CreateDirectProviderSessionResponse, CreateHostedProviderSessionRequest, CreateHostedProviderSessionResponse, CreateWidgetSessionRequest, CreateWidgetSessionResponse, GetAttachmentRequest, GetAttachmentResponse, GetSessionResponse, GetSessionResultRequest, GetSessionResultResponse, ListSessionsResponse, OrderDirection, RecommendProvidersRequest, RecommendProvidersResponse, RefreshStepContentRequest, RefreshStepContentResponse, SessionOrdering, SubmitNativeChallengeResponseRequest, SubmitNativeChallengeResponseResponse } from '../models/index';
+import type { CancelSessionResponse, CreateDirectProviderSessionRequest, CreateDirectProviderSessionResponse, CreateHostedProviderSessionRequest, CreateHostedProviderSessionResponse, GetAttachmentRequest, GetAttachmentResponse, GetSessionResponse, GetSessionResultRequest, GetSessionResultResponse, ListSessionsResponse, OrderDirection, RecommendProvidersRequest, RecommendProvidersResponse, RefreshStepContentRequest, RefreshStepContentResponse, SessionOrdering, SubmitNativeChallengeResponseRequest, SubmitNativeChallengeResponseResponse } from '../models/index';
 export interface CancelSessionRequest {
     sessionId: string;
 }
@@ -20,9 +20,6 @@ export interface CreateDirectProviderSessionOperationRequest {
 export interface CreateHostedProviderSessionOperationRequest {
     createHostedProviderSessionRequest?: CreateHostedProviderSessionRequest;
 }
-export interface CreateWidgetSessionOperationRequest {
-    createWidgetSessionRequest?: CreateWidgetSessionRequest;
-}
 export interface GetAttachmentOperationRequest {
     sessionId: string;
     attachmentId: string;
@@ -63,6 +60,13 @@ export interface SubmitNativeChallengeResponseOperationRequest {
  * @interface SessionsApiInterface
  */
 export interface SessionsApiInterface {
+    /**
+     * Creates request options for cancelSession without sending the request
+     * @param {string} sessionId
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    cancelSessionRequestOpts(requestParameters: CancelSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * Cancel a Session by its ID
      * @summary Cancel Session
@@ -77,6 +81,13 @@ export interface SessionsApiInterface {
      * Cancel Session
      */
     cancelSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CancelSessionResponse>;
+    /**
+     * Creates request options for createDirectProviderSession without sending the request
+     * @param {CreateDirectProviderSessionRequest} [createDirectProviderSessionRequest]
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    createDirectProviderSessionRequestOpts(requestParameters: CreateDirectProviderSessionOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * 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.
      * @summary Create Direct Provider Session
@@ -91,6 +102,13 @@ export interface SessionsApiInterface {
      * Create Direct Provider Session
      */
     createDirectProviderSession(createDirectProviderSessionRequest?: CreateDirectProviderSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateDirectProviderSessionResponse>;
+    /**
+     * Creates request options for createHostedProviderSession without sending the request
+     * @param {CreateHostedProviderSessionRequest} [createHostedProviderSessionRequest]
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    createHostedProviderSessionRequestOpts(requestParameters: CreateHostedProviderSessionOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Verify a user\'s identity with a specific provider, using Trinsic-hosted UI for providers which require additional user interaction.
      * @summary Create Hosted Provider Session
@@ -106,19 +124,14 @@ export interface SessionsApiInterface {
      */
     createHostedProviderSession(createHostedProviderSessionRequest?: CreateHostedProviderSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateHostedProviderSessionResponse>;
     /**
-     * Verify a user\'s identity using Trinsic\'s hosted Widget flow.
-     * @summary Create Widget Session
-     * @param {CreateWidgetSessionRequest} [createWidgetSessionRequest]
-     * @param {*} [options] Override http request option.
+     * Creates request options for getAttachment without sending the request
+     * @param {string} sessionId The ID of the Session to fetch the Attachment from
+     * @param {string} attachmentId The ID of the Attachment to fetch
+     * @param {GetAttachmentRequest} [getAttachmentRequest]
      * @throws {RequiredError}
      * @memberof SessionsApiInterface
      */
-    createWidgetSessionRaw(requestParameters: CreateWidgetSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWidgetSessionResponse>>;
-    /**
-     * Verify a user\'s identity using Trinsic\'s hosted Widget flow.
-     * Create Widget Session
-     */
-    createWidgetSession(createWidgetSessionRequest?: CreateWidgetSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWidgetSessionResponse>;
+    getAttachmentRequestOpts(requestParameters: GetAttachmentOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Fetch an Attachment\'s contents.
      * @summary Get Attachment
@@ -135,6 +148,13 @@ export interface SessionsApiInterface {
      * Get Attachment
      */
     getAttachment(sessionId: string, attachmentId: string, getAttachmentRequest?: GetAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttachmentResponse>;
+    /**
+     * Creates request options for getSession without sending the request
+     * @param {string} sessionId
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    getSessionRequestOpts(requestParameters: GetSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * Get a Session by its ID
      * @summary Get Session
@@ -149,6 +169,14 @@ export interface SessionsApiInterface {
      * Get Session
      */
     getSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSessionResponse>;
+    /**
+     * Creates request options for getSessionResult without sending the request
+     * @param {string} sessionId
+     * @param {GetSessionResultRequest} [getSessionResultRequest]
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    getSessionResultRequestOpts(requestParameters: GetSessionResultOperationRequest): Promise<runtime.RequestOpts>;
     /**
      *
      * @summary Get Session Results
@@ -163,6 +191,17 @@ export interface SessionsApiInterface {
      * Get Session Results
      */
     getSessionResult(sessionId: string, getSessionResultRequest?: GetSessionResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSessionResultResponse>;
+    /**
+     * Creates request options for listSessions without sending the request
+     * @param {string} verificationProfileId
+     * @param {SessionOrdering} [orderBy] The field by which sessions should be ordered
+     * @param {OrderDirection} [orderDirection]
+     * @param {number} [pageSize] The number of items to return per page -- must be between &#x60;1&#x60; and &#x60;50&#x60;
+     * @param {number} [page] The page number to return -- starts at &#x60;1&#x60;
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    listSessionsRequestOpts(requestParameters: ListSessionsRequest): Promise<runtime.RequestOpts>;
     /**
      * List Sessions created for a specific Verification Profile
      * @summary List Sessions
@@ -181,6 +220,13 @@ export interface SessionsApiInterface {
      * List Sessions
      */
     listSessions(verificationProfileId: string, orderBy?: SessionOrdering, orderDirection?: OrderDirection, pageSize?: number, page?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSessionsResponse>;
+    /**
+     * Creates request options for recommendProviders without sending the request
+     * @param {RecommendProvidersRequest} [recommendProvidersRequest]
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    recommendProvidersRequestOpts(requestParameters: RecommendProvidersOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * 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.
      * @summary Recommend Providers
@@ -195,6 +241,13 @@ export interface SessionsApiInterface {
      * Recommend Providers
      */
     recommendProviders(recommendProvidersRequest?: RecommendProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendProvidersResponse>;
+    /**
+     * Creates request options for redactSession without sending the request
+     * @param {string} sessionId
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    redactSessionRequestOpts(requestParameters: RedactSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * 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.
      * @summary Redact Session
@@ -209,6 +262,14 @@ export interface SessionsApiInterface {
      * Redact Session
      */
     redactSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for refreshStepContent without sending the request
+     * @param {string} sessionId
+     * @param {RefreshStepContentRequest} [refreshStepContentRequest]
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    refreshStepContentRequestOpts(requestParameters: RefreshStepContentOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Refreshes the content of a Step for a Direct Provider Session.
      * @summary Refresh Step Content
@@ -224,6 +285,14 @@ export interface SessionsApiInterface {
      * Refresh Step Content
      */
     refreshStepContent(sessionId: string, refreshStepContentRequest?: RefreshStepContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RefreshStepContentResponse>;
+    /**
+     * Creates request options for submitNativeChallengeResponse without sending the request
+     * @param {string} sessionId
+     * @param {SubmitNativeChallengeResponseRequest} [submitNativeChallengeResponseRequest]
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    submitNativeChallengeResponseRequestOpts(requestParameters: SubmitNativeChallengeResponseOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Submits the response from a Native Challenge (e.g., mDL exchange via DC API) and processes the results.
      * @summary Submit Native Challenge Response
@@ -244,6 +313,10 @@ export interface SessionsApiInterface {
  *
  */
 export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiInterface {
+    /**
+     * Creates request options for cancelSession without sending the request
+     */
+    cancelSessionRequestOpts(requestParameters: CancelSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * Cancel a Session by its ID
      * Cancel Session
@@ -254,6 +327,10 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      * Cancel Session
      */
     cancelSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CancelSessionResponse>;
+    /**
+     * Creates request options for createDirectProviderSession without sending the request
+     */
+    createDirectProviderSessionRequestOpts(requestParameters: CreateDirectProviderSessionOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -264,6 +341,10 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      * Create Direct Provider Session
      */
     createDirectProviderSession(createDirectProviderSessionRequest?: CreateDirectProviderSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateDirectProviderSessionResponse>;
+    /**
+     * Creates request options for createHostedProviderSession without sending the request
+     */
+    createHostedProviderSessionRequestOpts(requestParameters: CreateHostedProviderSessionOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Verify a user\'s identity with a specific provider, using Trinsic-hosted UI for providers which require additional user interaction.
      * Create Hosted Provider Session
@@ -275,15 +356,9 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      */
     createHostedProviderSession(createHostedProviderSessionRequest?: CreateHostedProviderSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateHostedProviderSessionResponse>;
     /**
-     * Verify a user\'s identity using Trinsic\'s hosted Widget flow.
-     * Create Widget Session
+     * Creates request options for getAttachment without sending the request
      */
-    createWidgetSessionRaw(requestParameters: CreateWidgetSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateWidgetSessionResponse>>;
-    /**
-     * Verify a user\'s identity using Trinsic\'s hosted Widget flow.
-     * Create Widget Session
-     */
-    createWidgetSession(createWidgetSessionRequest?: CreateWidgetSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateWidgetSessionResponse>;
+    getAttachmentRequestOpts(requestParameters: GetAttachmentOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Fetch an Attachment\'s contents.
      * Get Attachment
@@ -294,6 +369,10 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      * Get Attachment
      */
     getAttachment(sessionId: string, attachmentId: string, getAttachmentRequest?: GetAttachmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetAttachmentResponse>;
+    /**
+     * Creates request options for getSession without sending the request
+     */
+    getSessionRequestOpts(requestParameters: GetSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * Get a Session by its ID
      * Get Session
@@ -304,6 +383,10 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      * Get Session
      */
     getSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSessionResponse>;
+    /**
+     * Creates request options for getSessionResult without sending the request
+     */
+    getSessionResultRequestOpts(requestParameters: GetSessionResultOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Get Session Results
      */
@@ -312,6 +395,10 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      * Get Session Results
      */
     getSessionResult(sessionId: string, getSessionResultRequest?: GetSessionResultRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSessionResultResponse>;
+    /**
+     * Creates request options for listSessions without sending the request
+     */
+    listSessionsRequestOpts(requestParameters: ListSessionsRequest): Promise<runtime.RequestOpts>;
     /**
      * List Sessions created for a specific Verification Profile
      * List Sessions
@@ -322,6 +409,10 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      * List Sessions
      */
     listSessions(verificationProfileId: string, orderBy?: SessionOrdering, orderDirection?: OrderDirection, pageSize?: number, page?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSessionsResponse>;
+    /**
+     * Creates request options for recommendProviders without sending the request
+     */
+    recommendProvidersRequestOpts(requestParameters: RecommendProvidersOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -332,6 +423,10 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      * Recommend Providers
      */
     recommendProviders(recommendProvidersRequest?: RecommendProvidersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecommendProvidersResponse>;
+    /**
+     * Creates request options for redactSession without sending the request
+     */
+    redactSessionRequestOpts(requestParameters: RedactSessionRequest): Promise<runtime.RequestOpts>;
     /**
      * 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
@@ -342,6 +437,10 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      * Redact Session
      */
     redactSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for refreshStepContent without sending the request
+     */
+    refreshStepContentRequestOpts(requestParameters: RefreshStepContentOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Refreshes the content of a Step for a Direct Provider Session.
      * Refresh Step Content
@@ -352,6 +451,10 @@ export declare class SessionsApi extends runtime.BaseAPI implements SessionsApiI
      * Refresh Step Content
      */
     refreshStepContent(sessionId: string, refreshStepContentRequest?: RefreshStepContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RefreshStepContentResponse>;
+    /**
+     * Creates request options for submitNativeChallengeResponse without sending the request
+     */
+    submitNativeChallengeResponseRequestOpts(requestParameters: SubmitNativeChallengeResponseOperationRequest): Promise<runtime.RequestOpts>;
     /**
      * Submits the response from a Native Challenge (e.g., mDL exchange via DC API) and processes the results.
      * Submit Native Challenge Response