@trinsic/api 0.2.4

package/src/apis/SessionsApi.ts

@@ -0,0 +1,444 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Connect API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  CancelSessionResponse,
+  CreateSessionRequest,
+  CreateSessionResponse,
+  ExchangeResultsKeyRequest,
+  ExchangeResultsKeyResponse,
+  FailureMessage,
+  GetSessionResponse,
+  ListSessionsResponse,
+  OrderDirection,
+  SessionOrdering,
+  ValidationResult,
+} from '../models/index';
+import {
+    CancelSessionResponseFromJSON,
+    CancelSessionResponseToJSON,
+    CreateSessionRequestFromJSON,
+    CreateSessionRequestToJSON,
+    CreateSessionResponseFromJSON,
+    CreateSessionResponseToJSON,
+    ExchangeResultsKeyRequestFromJSON,
+    ExchangeResultsKeyRequestToJSON,
+    ExchangeResultsKeyResponseFromJSON,
+    ExchangeResultsKeyResponseToJSON,
+    FailureMessageFromJSON,
+    FailureMessageToJSON,
+    GetSessionResponseFromJSON,
+    GetSessionResponseToJSON,
+    ListSessionsResponseFromJSON,
+    ListSessionsResponseToJSON,
+    OrderDirectionFromJSON,
+    OrderDirectionToJSON,
+    SessionOrderingFromJSON,
+    SessionOrderingToJSON,
+    ValidationResultFromJSON,
+    ValidationResultToJSON,
+} from '../models/index';
+
+export interface CancelSessionRequest {
+    sessionId: string;
+}
+
+export interface CreateSessionOperationRequest {
+    createSessionRequest?: CreateSessionRequest;
+}
+
+export interface ExchangeResultsKeyOperationRequest {
+    sessionId: string;
+    exchangeResultsKeyRequest?: ExchangeResultsKeyRequest;
+}
+
+export interface GetSessionRequest {
+    sessionId: string;
+}
+
+export interface ListSessionsRequest {
+    orderBy?: SessionOrdering;
+    orderDirection?: OrderDirection;
+    pageSize?: number;
+    page?: number;
+}
+
+export interface RedactSessionRequest {
+    sessionId: string;
+}
+
+/**
+ * SessionsApi - interface
+ * 
+ * @export
+ * @interface SessionsApiInterface
+ */
+export interface SessionsApiInterface {
+    /**
+     * 
+     * @summary Cancel a Session by its ID
+     * @param {string} sessionId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    cancelSessionRaw(requestParameters: CancelSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CancelSessionResponse>>;
+
+    /**
+     * Cancel a Session by its ID
+     */
+    cancelSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CancelSessionResponse>;
+
+    /**
+     * 
+     * @summary Create a Session to verify a user\'s identity
+     * @param {CreateSessionRequest} [createSessionRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    createSessionRaw(requestParameters: CreateSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSessionResponse>>;
+
+    /**
+     * Create a Session to verify a user\'s identity
+     */
+    createSession(createSessionRequest?: CreateSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSessionResponse>;
+
+    /**
+     * 
+     * @summary Exchange a Results Access Key for Identity Data
+     * @param {string} sessionId 
+     * @param {ExchangeResultsKeyRequest} [exchangeResultsKeyRequest] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    exchangeResultsKeyRaw(requestParameters: ExchangeResultsKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExchangeResultsKeyResponse>>;
+
+    /**
+     * Exchange a Results Access Key for Identity Data
+     */
+    exchangeResultsKey(sessionId: string, exchangeResultsKeyRequest?: ExchangeResultsKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExchangeResultsKeyResponse>;
+
+    /**
+     * 
+     * @summary Get a Session by its ID
+     * @param {string} sessionId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    getSessionRaw(requestParameters: GetSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSessionResponse>>;
+
+    /**
+     * Get a Session by its ID
+     */
+    getSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSessionResponse>;
+
+    /**
+     * 
+     * @summary List Sessions created by your account
+     * @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;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    listSessionsRaw(requestParameters: ListSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSessionsResponse>>;
+
+    /**
+     * List Sessions created by your account
+     */
+    listSessions(orderBy?: SessionOrdering, orderDirection?: OrderDirection, pageSize?: number, page?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSessionsResponse>;
+
+    /**
+     * 
+     * @summary Redact a Session, removing all identity data from Trinsic\'s servers.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
+     * @param {string} sessionId 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SessionsApiInterface
+     */
+    redactSessionRaw(requestParameters: RedactSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+
+    /**
+     * Redact a Session, removing all identity data from Trinsic\'s servers.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
+     */
+    redactSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+
+}
+
+/**
+ * 
+ */
+export class SessionsApi extends runtime.BaseAPI implements SessionsApiInterface {
+
+    /**
+     * Cancel a Session by its ID
+     */
+    async cancelSessionRaw(requestParameters: CancelSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CancelSessionResponse>> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling cancelSession().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sessions/{sessionId}/cancel`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CancelSessionResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Cancel a Session by its ID
+     */
+    async cancelSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CancelSessionResponse> {
+        const response = await this.cancelSessionRaw({ sessionId: sessionId }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Create a Session to verify a user\'s identity
+     */
+    async createSessionRaw(requestParameters: CreateSessionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateSessionResponse>> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sessions`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: CreateSessionRequestToJSON(requestParameters['createSessionRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CreateSessionResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Create a Session to verify a user\'s identity
+     */
+    async createSession(createSessionRequest?: CreateSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateSessionResponse> {
+        const response = await this.createSessionRaw({ createSessionRequest: createSessionRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Exchange a Results Access Key for Identity Data
+     */
+    async exchangeResultsKeyRaw(requestParameters: ExchangeResultsKeyOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ExchangeResultsKeyResponse>> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling exchangeResultsKey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sessions/{sessionId}/results/exchange`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ExchangeResultsKeyRequestToJSON(requestParameters['exchangeResultsKeyRequest']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ExchangeResultsKeyResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Exchange a Results Access Key for Identity Data
+     */
+    async exchangeResultsKey(sessionId: string, exchangeResultsKeyRequest?: ExchangeResultsKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ExchangeResultsKeyResponse> {
+        const response = await this.exchangeResultsKeyRaw({ sessionId: sessionId, exchangeResultsKeyRequest: exchangeResultsKeyRequest }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Get a Session by its ID
+     */
+    async getSessionRaw(requestParameters: GetSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetSessionResponse>> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling getSession().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sessions/{sessionId}`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetSessionResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get a Session by its ID
+     */
+    async getSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetSessionResponse> {
+        const response = await this.getSessionRaw({ sessionId: sessionId }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * List Sessions created by your account
+     */
+    async listSessionsRaw(requestParameters: ListSessionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListSessionsResponse>> {
+        const queryParameters: any = {};
+
+        if (requestParameters['orderBy'] != null) {
+            queryParameters['OrderBy'] = requestParameters['orderBy'];
+        }
+
+        if (requestParameters['orderDirection'] != null) {
+            queryParameters['OrderDirection'] = requestParameters['orderDirection'];
+        }
+
+        if (requestParameters['pageSize'] != null) {
+            queryParameters['PageSize'] = requestParameters['pageSize'];
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['Page'] = requestParameters['page'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sessions`,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListSessionsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List Sessions created by your account
+     */
+    async listSessions(orderBy?: SessionOrdering, orderDirection?: OrderDirection, pageSize?: number, page?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSessionsResponse> {
+        const response = await this.listSessionsRaw({ orderBy: orderBy, orderDirection: orderDirection, pageSize: pageSize, page: page }, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Redact a Session, removing all identity data from Trinsic\'s servers.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
+     */
+    async redactSessionRaw(requestParameters: RedactSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['sessionId'] == null) {
+            throw new runtime.RequiredError(
+                'sessionId',
+                'Required parameter "sessionId" was null or undefined when calling redactSession().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("Bearer", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+        const response = await this.request({
+            path: `/api/v1/sessions/{sessionId}/redact`.replace(`{${"sessionId"}}`, encodeURIComponent(String(requestParameters['sessionId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Redact a Session, removing all identity data from Trinsic\'s servers.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
+     */
+    async redactSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.redactSessionRaw({ sessionId: sessionId }, initOverrides);
+    }
+
+}

package/src/apis/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AttachmentsApi';
+export * from './NetworkApi';
+export * from './SessionsApi';

package/src/index.ts

@@ -0,0 +1,5 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './runtime';
+export * from './apis/index';
+export * from './models/index';

package/src/models/Address.ts

@@ -0,0 +1,116 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Connect API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Address information for an individual
+ * @export
+ * @interface Address
+ */
+export interface Address {
+    /**
+     * 
+     * @type {string}
+     * @memberof Address
+     */
+    line1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Address
+     */
+    line2?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Address
+     */
+    line3?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Address
+     */
+    city?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Address
+     */
+    state?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Address
+     */
+    postalCode?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Address
+     */
+    country?: string;
+    /**
+     * The full address as a single string
+     * @type {string}
+     * @memberof Address
+     */
+    fullAddress?: string;
+}
+
+/**
+ * Check if a given object implements the Address interface.
+ */
+export function instanceOfAddress(value: object): value is Address {
+    return true;
+}
+
+export function AddressFromJSON(json: any): Address {
+    return AddressFromJSONTyped(json, false);
+}
+
+export function AddressFromJSONTyped(json: any, ignoreDiscriminator: boolean): Address {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'line1': json['line1'] == null ? undefined : json['line1'],
+        'line2': json['line2'] == null ? undefined : json['line2'],
+        'line3': json['line3'] == null ? undefined : json['line3'],
+        'city': json['city'] == null ? undefined : json['city'],
+        'state': json['state'] == null ? undefined : json['state'],
+        'postalCode': json['postalCode'] == null ? undefined : json['postalCode'],
+        'country': json['country'] == null ? undefined : json['country'],
+        'fullAddress': json['fullAddress'] == null ? undefined : json['fullAddress'],
+    };
+}
+
+export function AddressToJSON(value?: Address | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'line1': value['line1'],
+        'line2': value['line2'],
+        'line3': value['line3'],
+        'city': value['city'],
+        'state': value['state'],
+        'postalCode': value['postalCode'],
+        'country': value['country'],
+        'fullAddress': value['fullAddress'],
+    };
+}
+

package/src/models/Attachments.ts

@@ -0,0 +1,86 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Connect API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Attachment Access Keys for attachments (eg document / selfie images)
+ * @export
+ * @interface Attachments
+ */
+export interface Attachments {
+    /**
+     * Key to access the selfie image (if relevant) for this verification
+     * @type {string}
+     * @memberof Attachments
+     */
+    selfie?: string;
+    /**
+     * Key to access the document front image (if relevant) for this verification
+     * @type {string}
+     * @memberof Attachments
+     */
+    documentFront?: string;
+    /**
+     * Key to access the document back image (if relevant) for this verification
+     * @type {string}
+     * @memberof Attachments
+     */
+    documentBack?: string;
+    /**
+     * Key to access the document portrait image (if relevant and available) for this verification.
+     *             
+     * Specifically, this is a cropped version of the document front image which includes only the portrait on the document.
+     * @type {string}
+     * @memberof Attachments
+     */
+    documentPortrait?: string;
+}
+
+/**
+ * Check if a given object implements the Attachments interface.
+ */
+export function instanceOfAttachments(value: object): value is Attachments {
+    return true;
+}
+
+export function AttachmentsFromJSON(json: any): Attachments {
+    return AttachmentsFromJSONTyped(json, false);
+}
+
+export function AttachmentsFromJSONTyped(json: any, ignoreDiscriminator: boolean): Attachments {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'selfie': json['selfie'] == null ? undefined : json['selfie'],
+        'documentFront': json['documentFront'] == null ? undefined : json['documentFront'],
+        'documentBack': json['documentBack'] == null ? undefined : json['documentBack'],
+        'documentPortrait': json['documentPortrait'] == null ? undefined : json['documentPortrait'],
+    };
+}
+
+export function AttachmentsToJSON(value?: Attachments | null): any {
+    if (value == null) {
+        return value;
+    }
+    return {
+        
+        'selfie': value['selfie'],
+        'documentFront': value['documentFront'],
+        'documentBack': value['documentBack'],
+        'documentPortrait': value['documentPortrait'],
+    };
+}
+