@trinsic/api 1.1.0 → 1.1.2

package/README.md

@@ -39,11 +39,11 @@ You can find a full TypeScript server example in the [samples](https://github.co
 
 ## SDK Versioning
 
-var configuration = new Configuration { AccessToken = "your-access-token" };
+Our SDKs follow the [Semantic Versioning](https://semver.org) ("SemVer") scheme.
 
-var attachments = new AttachmentsApi(configuration);
-var network = new NetworkApi(configuration);
-var sessions = new SessionsApi(configuration);
+For example, the version number `1.13.0` has a major version of `1`, a minor version of `13`, and a patch version of `0`.
+
+Breaking changes are only introduced alongside a new major version.
 
 ## Support
 

package/dist/esm/models/CreateSessionRequest.d.ts

@@ -27,6 +27,27 @@ export interface CreateSessionRequest {
      * @memberof CreateSessionRequest
      */
     launchProviderDirectly?: boolean;
+    /**
+     * Whether to enable Trinsic's "Remember Me" feature, which allows users to save their credentials for future use.
+     *
+     * This option is only relevant when `LaunchProviderDirectly` is unspecified or set to `false`.
+     * If `LaunchProviderDirectly` is `true`, this field must be unspecified or set to `false`.
+     *
+     * If this field is set to `true`, then:
+     *   - The user will be prompted to authenticate with their phone number at the start of the flow
+     *   - If the user has previously saved a verification for reuse with Trinsic, they will be offered the ability to reuse it
+     *   - After the user has verified their identity (and if the identity provider in question supports it), they will be prompted to save their credentials for future use
+     *
+     * If this field is set to `false`, then:
+     *   - The user will not be prompted to authenticate with their phone number at the start of the flow.
+     *     - Instead, the user will be immediately shown the list of available providers
+     *   - The user will not be offered the ability to reuse a previously-saved Trinsic credential
+     *   - After the user has verified their identity, they will not be prompted to save their credentials for future use
+     *     - Instead, they will immediately return to your product
+     * @type {boolean}
+     * @memberof CreateSessionRequest
+     */
+    enableRememberMe?: boolean;
     /**
      * The list of allowed identity providers. If not specified, all available providers will be allowed.
      *

package/dist/esm/models/CreateSessionRequest.js

@@ -27,6 +27,7 @@ export function CreateSessionRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'launchProviderDirectly': json['launchProviderDirectly'] == null ? undefined : json['launchProviderDirectly'],
+        'enableRememberMe': json['enableRememberMe'] == null ? undefined : json['enableRememberMe'],
         'providers': json['providers'] == null ? undefined : json['providers'],
         'disclosedFields': json['disclosedFields'] == null ? undefined : DisclosedFieldsRequestFromJSON(json['disclosedFields']),
     };
@@ -37,6 +38,7 @@ export function CreateSessionRequestToJSON(value) {
     }
     return {
         'launchProviderDirectly': value['launchProviderDirectly'],
+        'enableRememberMe': value['enableRememberMe'],
         'providers': value['providers'],
         'disclosedFields': DisclosedFieldsRequestToJSON(value['disclosedFields']),
     };

package/dist/models/CreateSessionRequest.d.ts

@@ -27,6 +27,27 @@ export interface CreateSessionRequest {
      * @memberof CreateSessionRequest
      */
     launchProviderDirectly?: boolean;
+    /**
+     * Whether to enable Trinsic's "Remember Me" feature, which allows users to save their credentials for future use.
+     *
+     * This option is only relevant when `LaunchProviderDirectly` is unspecified or set to `false`.
+     * If `LaunchProviderDirectly` is `true`, this field must be unspecified or set to `false`.
+     *
+     * If this field is set to `true`, then:
+     *   - The user will be prompted to authenticate with their phone number at the start of the flow
+     *   - If the user has previously saved a verification for reuse with Trinsic, they will be offered the ability to reuse it
+     *   - After the user has verified their identity (and if the identity provider in question supports it), they will be prompted to save their credentials for future use
+     *
+     * If this field is set to `false`, then:
+     *   - The user will not be prompted to authenticate with their phone number at the start of the flow.
+     *     - Instead, the user will be immediately shown the list of available providers
+     *   - The user will not be offered the ability to reuse a previously-saved Trinsic credential
+     *   - After the user has verified their identity, they will not be prompted to save their credentials for future use
+     *     - Instead, they will immediately return to your product
+     * @type {boolean}
+     * @memberof CreateSessionRequest
+     */
+    enableRememberMe?: boolean;
     /**
      * The list of allowed identity providers. If not specified, all available providers will be allowed.
      *

package/dist/models/CreateSessionRequest.js

@@ -33,6 +33,7 @@ function CreateSessionRequestFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'launchProviderDirectly': json['launchProviderDirectly'] == null ? undefined : json['launchProviderDirectly'],
+        'enableRememberMe': json['enableRememberMe'] == null ? undefined : json['enableRememberMe'],
         'providers': json['providers'] == null ? undefined : json['providers'],
         'disclosedFields': json['disclosedFields'] == null ? undefined : (0, DisclosedFieldsRequest_1.DisclosedFieldsRequestFromJSON)(json['disclosedFields']),
     };
@@ -43,6 +44,7 @@ function CreateSessionRequestToJSON(value) {
     }
     return {
         'launchProviderDirectly': value['launchProviderDirectly'],
+        'enableRememberMe': value['enableRememberMe'],
         'providers': value['providers'],
         'disclosedFields': (0, DisclosedFieldsRequest_1.DisclosedFieldsRequestToJSON)(value['disclosedFields']),
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trinsic/api",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "Trinsic API TypeScript library.",
   "author": "Trinsic",
   "repository": {

package/src/models/CreateSessionRequest.ts

@@ -37,6 +37,27 @@ export interface CreateSessionRequest {
      * @memberof CreateSessionRequest
      */
     launchProviderDirectly?: boolean;
+    /**
+     * Whether to enable Trinsic's "Remember Me" feature, which allows users to save their credentials for future use.
+     *             
+     * This option is only relevant when `LaunchProviderDirectly` is unspecified or set to `false`.
+     * If `LaunchProviderDirectly` is `true`, this field must be unspecified or set to `false`.
+     *             
+     * If this field is set to `true`, then:
+     *   - The user will be prompted to authenticate with their phone number at the start of the flow
+     *   - If the user has previously saved a verification for reuse with Trinsic, they will be offered the ability to reuse it
+     *   - After the user has verified their identity (and if the identity provider in question supports it), they will be prompted to save their credentials for future use
+     *             
+     * If this field is set to `false`, then:
+     *   - The user will not be prompted to authenticate with their phone number at the start of the flow.
+     *     - Instead, the user will be immediately shown the list of available providers
+     *   - The user will not be offered the ability to reuse a previously-saved Trinsic credential
+     *   - After the user has verified their identity, they will not be prompted to save their credentials for future use
+     *     - Instead, they will immediately return to your product
+     * @type {boolean}
+     * @memberof CreateSessionRequest
+     */
+    enableRememberMe?: boolean;
     /**
      * The list of allowed identity providers. If not specified, all available providers will be allowed.
      *             
@@ -72,6 +93,7 @@ export function CreateSessionRequestFromJSONTyped(json: any, ignoreDiscriminator
     return {
         
         'launchProviderDirectly': json['launchProviderDirectly'] == null ? undefined : json['launchProviderDirectly'],
+        'enableRememberMe': json['enableRememberMe'] == null ? undefined : json['enableRememberMe'],
         'providers': json['providers'] == null ? undefined : json['providers'],
         'disclosedFields': json['disclosedFields'] == null ? undefined : DisclosedFieldsRequestFromJSON(json['disclosedFields']),
     };
@@ -84,6 +106,7 @@ export function CreateSessionRequestToJSON(value?: CreateSessionRequest | null):
     return {
         
         'launchProviderDirectly': value['launchProviderDirectly'],
+        'enableRememberMe': value['enableRememberMe'],
         'providers': value['providers'],
         'disclosedFields': DisclosedFieldsRequestToJSON(value['disclosedFields']),
     };