trinsic_api 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19ee776fbe38a47650e1e3bdee0884ed5de859308a269779b4ba27ca04d3e965
-  data.tar.gz: 24e3e576b85b62a9d3ff2d9d9f5dc879f80f3d4bdcffa9b7d7d3c4696630c7c6
+  metadata.gz: 555547575f24bd34d4674407c0516a0569a3252af1f79da905d2dad43c5a2b75
+  data.tar.gz: d8c405fa2d8c7c46592901108e04b61edc1a39f7f7f540a687478f7b6c56e992
 SHA512:
-  metadata.gz: 53ec014f18bd5b36b451d0c3205857e1242a020b4a0eca6d156433cad78285b78e87e830c2b028e757fa24e2cc8b8cb6e3b64ba6ae4f8a883a6f66da3161d8e1
-  data.tar.gz: 9f8b6858c4307a06d28e836d1bffc1218652d26b61370a61d86ede011b38e070991c5d072a03894f5e4a0f369d3f7e3c4d3553b223b0717348b44e031171a114
+  metadata.gz: 39358ab2dd616d6c51d8e08931531ebd3a238c4f3bf58269c032f9df2c20dd06ea51265b0322ab432fbcbfab95b21ce99d8cc8f4f565d27340cab6b92b0ac36d
+  data.tar.gz: 43c7d0b6a7f400bc5f7d78916d3dcd4a439c721cb4e2e7cf76850692f2154513dd2389bb7dba91b464c90fdac612db3085ff33f9404cd72f595c1ea8e4ebd83a

data/docs/CreateSessionRequest.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **launch_provider_directly** | **Boolean** | Whether to immediately launch the identity provider, without invoking the Trinsic Widget UI.                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. | [optional] |
+| **enable_remember_me** | **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 | [optional] |
 | **providers** | **Array<String>** | The list of allowed identity providers. If not specified, all available providers will be allowed.                If `LaunchMethodDirectly` is `true`, this field must be set, and must have only a single entry.  If `LaunchMethodDirectly` is not specified or is `false`, this field may have any number of entries. | [optional] |
 | **disclosed_fields** | [**DisclosedFieldsRequest**](DisclosedFieldsRequest.md) | Specific identity attributes to request. If not provided, all available attributes will be requested. | [optional] |
 
@@ -15,6 +16,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::CreateSessionRequest.new(
   launch_provider_directly: null,
+  enable_remember_me: false,
   providers: null,
   disclosed_fields: null
 )

data/lib/trinsic_api/models/create_session_request.rb

@@ -18,6 +18,9 @@ module TrinsicApi
     # Whether to immediately launch the identity provider, without invoking the Trinsic Widget UI.                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.
     attr_accessor :launch_provider_directly
 
+    # 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
+    attr_accessor :enable_remember_me
+
     # The list of allowed identity providers. If not specified, all available providers will be allowed.                If `LaunchMethodDirectly` is `true`, this field must be set, and must have only a single entry.  If `LaunchMethodDirectly` is not specified or is `false`, this field may have any number of entries.
     attr_accessor :providers
 
@@ -28,6 +31,7 @@ module TrinsicApi
     def self.attribute_map
       {
         :'launch_provider_directly' => :'launchProviderDirectly',
+        :'enable_remember_me' => :'enableRememberMe',
         :'providers' => :'providers',
         :'disclosed_fields' => :'disclosedFields'
       }
@@ -42,6 +46,7 @@ module TrinsicApi
     def self.openapi_types
       {
         :'launch_provider_directly' => :'Boolean',
+        :'enable_remember_me' => :'Boolean',
         :'providers' => :'Array<String>',
         :'disclosed_fields' => :'DisclosedFieldsRequest'
       }
@@ -72,6 +77,10 @@ module TrinsicApi
         self.launch_provider_directly = attributes[:'launch_provider_directly']
       end
 
+      if attributes.key?(:'enable_remember_me')
+        self.enable_remember_me = attributes[:'enable_remember_me']
+      end
+
       if attributes.key?(:'providers')
         if (value = attributes[:'providers']).is_a?(Array)
           self.providers = value
@@ -104,6 +113,7 @@ module TrinsicApi
       return true if self.equal?(o)
       self.class == o.class &&
           launch_provider_directly == o.launch_provider_directly &&
+          enable_remember_me == o.enable_remember_me &&
           providers == o.providers &&
           disclosed_fields == o.disclosed_fields
     end
@@ -117,7 +127,7 @@ module TrinsicApi
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [launch_provider_directly, providers, disclosed_fields].hash
+      [launch_provider_directly, enable_remember_me, providers, disclosed_fields].hash
     end
 
     # Builds the object from hash

data/lib/trinsic_api/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.8.0
 =end
 
 module TrinsicApi
-  VERSION = '1.1.0'
+  VERSION = '1.1.2'
 end

data/spec/models/create_session_request_spec.rb

@@ -33,6 +33,12 @@ describe TrinsicApi::CreateSessionRequest do
     end
   end
 
+  describe 'test attribute "enable_remember_me"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
   describe 'test attribute "providers"' do
     it 'should work' do
       # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trinsic_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Trinsic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -186,35 +186,35 @@ signing_key:
 specification_version: 4
 summary: Trinsic API Ruby Library
 test_files:
+- spec/api/sessions_api_spec.rb
 - spec/api/attachments_api_spec.rb
 - spec/api/network_api_spec.rb
-- spec/api/sessions_api_spec.rb
-- spec/models/attachment_access_keys_spec.rb
-- spec/models/get_session_response_spec.rb
-- spec/models/create_session_response_spec.rb
-- spec/models/document_data_spec.rb
-- spec/models/identity_data_spec.rb
+- spec/models/session_spec.rb
 - spec/models/disclosed_fields_spec.rb
-- spec/models/session_state_spec.rb
-- spec/models/verification_spec.rb
-- spec/models/get_session_result_request_spec.rb
+- spec/models/disclosed_fields_request_spec.rb
 - spec/models/identity_lookup_response_spec.rb
-- spec/models/order_direction_spec.rb
-- spec/models/person_data_spec.rb
-- spec/models/session_spec.rb
 - spec/models/list_providers_response_spec.rb
-- spec/models/validation_result_spec.rb
-- spec/models/session_ordering_spec.rb
+- spec/models/attachment_access_keys_spec.rb
+- spec/models/cancel_session_response_spec.rb
+- spec/models/session_state_spec.rb
 - spec/models/verification_fail_code_spec.rb
+- spec/models/document_data_spec.rb
 - spec/models/get_session_result_response_spec.rb
-- spec/models/get_attachment_request_spec.rb
+- spec/models/verification_spec.rb
+- spec/models/list_sessions_response_spec.rb
+- spec/models/create_session_response_spec.rb
+- spec/models/order_direction_spec.rb
+- spec/models/validation_result_spec.rb
 - spec/models/provider_info_spec.rb
-- spec/models/cancel_session_response_spec.rb
-- spec/models/failure_message_spec.rb
+- spec/models/session_fail_code_spec.rb
+- spec/models/get_session_response_spec.rb
+- spec/models/get_attachment_request_spec.rb
 - spec/models/address_spec.rb
 - spec/models/get_attachment_response_spec.rb
-- spec/models/session_fail_code_spec.rb
-- spec/models/disclosed_fields_request_spec.rb
-- spec/models/list_sessions_response_spec.rb
 - spec/models/create_session_request_spec.rb
+- spec/models/session_ordering_spec.rb
+- spec/models/failure_message_spec.rb
+- spec/models/identity_data_spec.rb
+- spec/models/person_data_spec.rb
+- spec/models/get_session_result_request_spec.rb
 - spec/spec_helper.rb