@trinsic/api 0.4.3 → 0.5.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Trinsic Technologies, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@trinsic/api",
-  "version": "0.4.3",
-  "description": "OpenAPI client for @trinsic/api",
-  "author": "OpenAPI-Generator",
+  "version": "0.5.5",
+  "description": "Trinsic API TypeScript library.",
+  "author": "Trinsic",
   "repository": {
     "type": "git",
-    "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
+    "url": "https://github.com/trinsic-id/sdk"
   },
   "main": "./dist/index.js",
   "typings": "./dist/index.d.ts",
@@ -17,5 +17,7 @@
   },
   "devDependencies": {
     "typescript": "^4.0 || ^5.0"
-  }
+  },
+  "homepage": "https://trinsic.id",
+  "license": "MIT"
 }

package/src/apis/SessionsApi.ts

@@ -171,7 +171,7 @@ export interface SessionsApiInterface {
     listSessions(orderBy?: SessionOrdering, orderDirection?: OrderDirection, pageSize?: number, page?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListSessionsResponse>;
 
     /**
-     * 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.
+     * Redact a Session, removing all identity data from Trinsic\'s servers.  Every application 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.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
      * @summary Redact Session
      * @param {string} sessionId 
      * @param {*} [options] Override http request option.
@@ -181,7 +181,7 @@ export interface 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.
+     * Redact a Session, removing all identity data from Trinsic\'s servers.  Every application 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.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
      * Redact Session
      */
     redactSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
@@ -415,7 +415,7 @@ export class SessionsApi extends runtime.BaseAPI implements SessionsApiInterface
     }
 
     /**
-     * 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.
+     * Redact a Session, removing all identity data from Trinsic\'s servers.  Every application 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.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
      * Redact Session
      */
     async redactSessionRaw(requestParameters: RedactSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
@@ -449,7 +449,7 @@ export class SessionsApi extends runtime.BaseAPI implements SessionsApiInterface
     }
 
     /**
-     * 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.
+     * Redact a Session, removing all identity data from Trinsic\'s servers.  Every application 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.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
      * Redact Session
      */
     async redactSession(sessionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {

package/src/models/CreateSessionRequest.ts

@@ -27,16 +27,16 @@ import {
  */
 export interface CreateSessionRequest {
     /**
-     * Whether to immediately launch the identity provider, without invoking the Trinsic Connect Widget UI.
+     * Whether to immediately launch the identity provider, without invoking the Trinsic Widget UI.
      *             
-     * Users will not be shown the Connect Widget; therefore, reuse of Connect credentials, selection of an identity provider, and saving a verification for future reuse
+     * Users will not be shown the Widget; therefore, reuse of credentials, selection of an identity provider, and saving a verification for future reuse
      * are not available to the end user in this mode.
      *             
      * Sessions created with this option enabled must be created with a `RedirectUrl` specified, and cannot be invoked using the frontend SDK at this time.
      * @type {boolean}
      * @memberof CreateSessionRequest
      */
-    launchMethodDirectly?: boolean;
+    launchProviderDirectly?: boolean;
     /**
      * The list of allowed identity providers. If not specified, all available providers will be allowed.
      *             
@@ -71,7 +71,7 @@ export function CreateSessionRequestFromJSONTyped(json: any, ignoreDiscriminator
     }
     return {
         
-        'launchMethodDirectly': json['launchMethodDirectly'] == null ? undefined : json['launchMethodDirectly'],
+        'launchProviderDirectly': json['launchProviderDirectly'] == null ? undefined : json['launchProviderDirectly'],
         'providers': json['providers'] == null ? undefined : json['providers'],
         'disclosedFields': json['disclosedFields'] == null ? undefined : DisclosedFieldsRequestFromJSON(json['disclosedFields']),
     };
@@ -83,7 +83,7 @@ export function CreateSessionRequestToJSON(value?: CreateSessionRequest | null):
     }
     return {
         
-        'launchMethodDirectly': value['launchMethodDirectly'],
+        'launchProviderDirectly': value['launchProviderDirectly'],
         'providers': value['providers'],
         'disclosedFields': DisclosedFieldsRequestToJSON(value['disclosedFields']),
     };

package/src/models/CreateSessionResponse.ts

@@ -35,10 +35,8 @@ export interface CreateSessionResponse {
     /**
      * The URL that should be used to invoke the Acceptance Session on your user's device.
      *             
-     * If the Session was created with `LaunchMethodDirectly` set to `true`, you should redirect your user's browser to this URL. The frontend SDK cannot presently be used to
-     * invoke these Sessions.
-     *             
-     * Otherwise, you should pass this URL to your user's frontend and use the frontend SDK to invoke the Session.
+     * You can use our frontend SDKs to launch the user into the Acceptance Session, or you can redirect the user's browser to this URL.
+     * If the Session was created with `LaunchProviderDirectly` set to `true`, you can't use the iFrame mode.
      *             
      * This URL is sensitive and as such can only be obtained once. If you need to obtain it again, you will need to create a new Acceptance Session.
      * @type {string}