trinsic_api 2.0.0.pre.alpha3 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/docs/AttachmentsApi.md +1 -1
  4. data/docs/BrazilDigitalCnhInput.md +2 -2
  5. data/docs/CreateAdvancedProviderSessionRequest.md +3 -3
  6. data/docs/CreateHostedProviderSessionResponse.md +4 -2
  7. data/docs/CreateWidgetSessionRequest.md +3 -3
  8. data/docs/CreateWidgetSessionResponse.md +4 -2
  9. data/docs/IdentityData.md +2 -0
  10. data/docs/IdinInput.md +18 -0
  11. data/docs/Language.md +15 -0
  12. data/docs/ListProviderContractsResponse.md +18 -0
  13. data/docs/MobileIdInput.md +22 -0
  14. data/docs/NetworkApi.md +71 -4
  15. data/docs/ProviderContract.md +46 -0
  16. data/docs/ProviderInfo.md +1 -3
  17. data/docs/ProviderInformation.md +3 -3
  18. data/docs/ProviderInput.md +24 -12
  19. data/docs/RecommendRequest.md +2 -10
  20. data/docs/RecommendationInfo.md +24 -0
  21. data/docs/ResultCollection.md +2 -2
  22. data/docs/Session.md +3 -3
  23. data/docs/SessionsApi.md +2 -2
  24. data/docs/SmartIdInput.md +18 -0
  25. data/docs/SpidInput.md +18 -0
  26. data/docs/StepRefreshInfo.md +1 -1
  27. data/docs/SubProviderMetadata.md +24 -0
  28. data/docs/TrinsicTestDatabaseLookupInput.md +24 -0
  29. data/docs/TrinsicTestSubProvidersInput.md +18 -0
  30. data/lib/trinsic_api/api/attachments_api.rb +2 -2
  31. data/lib/trinsic_api/api/network_api.rb +59 -2
  32. data/lib/trinsic_api/api/sessions_api.rb +4 -4
  33. data/lib/trinsic_api/models/brazil_digital_cnh_input.rb +2 -2
  34. data/lib/trinsic_api/models/create_advanced_provider_session_request.rb +3 -3
  35. data/lib/trinsic_api/models/create_hosted_provider_session_response.rb +29 -6
  36. data/lib/trinsic_api/models/create_widget_session_request.rb +10 -10
  37. data/lib/trinsic_api/models/create_widget_session_response.rb +29 -6
  38. data/lib/trinsic_api/models/identity_data.rb +11 -1
  39. data/lib/trinsic_api/models/{known_identity_data.rb → idin_input.rb} +12 -13
  40. data/lib/trinsic_api/models/integration_launch_method.rb +2 -2
  41. data/lib/trinsic_api/models/language.rb +42 -0
  42. data/lib/trinsic_api/models/list_provider_contracts_response.rb +224 -0
  43. data/lib/trinsic_api/models/mobile_id_input.rb +260 -0
  44. data/lib/trinsic_api/models/provider_contract.rb +482 -0
  45. data/lib/trinsic_api/models/provider_info.rb +4 -17
  46. data/lib/trinsic_api/models/provider_input.rb +82 -16
  47. data/lib/trinsic_api/models/recommend_request.rb +9 -59
  48. data/lib/trinsic_api/models/recommendation_info.rb +256 -0
  49. data/lib/trinsic_api/models/result_collection.rb +8 -2
  50. data/lib/trinsic_api/models/session.rb +3 -3
  51. data/lib/trinsic_api/models/smart_id_input.rb +216 -0
  52. data/lib/trinsic_api/models/spid_input.rb +216 -0
  53. data/lib/trinsic_api/models/step_refresh_info.rb +1 -1
  54. data/lib/trinsic_api/models/{known_address.rb → sub_provider_metadata.rb} +59 -72
  55. data/lib/trinsic_api/models/{known_person_data.rb → trinsic_test_database_lookup_input.rb} +22 -66
  56. data/lib/trinsic_api/models/trinsic_test_sub_providers_input.rb +216 -0
  57. data/lib/trinsic_api/version.rb +1 -1
  58. data/lib/trinsic_api.rb +11 -3
  59. data/spec/api/attachments_api_spec.rb +1 -1
  60. data/spec/api/network_api_spec.rb +12 -1
  61. data/spec/api/sessions_api_spec.rb +2 -2
  62. data/spec/models/create_hosted_provider_session_response_spec.rb +6 -0
  63. data/spec/models/create_widget_session_request_spec.rb +1 -1
  64. data/spec/models/create_widget_session_response_spec.rb +6 -0
  65. data/spec/models/identity_data_spec.rb +6 -0
  66. data/spec/models/{known_identity_data_spec.rb → idin_input_spec.rb} +7 -7
  67. data/spec/models/language_spec.rb +30 -0
  68. data/spec/models/list_provider_contracts_response_spec.rb +36 -0
  69. data/spec/models/mobile_id_input_spec.rb +48 -0
  70. data/spec/models/provider_contract_spec.rb +120 -0
  71. data/spec/models/provider_info_spec.rb +0 -6
  72. data/spec/models/provider_input_spec.rb +36 -0
  73. data/spec/models/recommend_request_spec.rb +1 -25
  74. data/spec/models/recommendation_info_spec.rb +54 -0
  75. data/spec/models/smart_id_input_spec.rb +36 -0
  76. data/spec/models/spid_input_spec.rb +36 -0
  77. data/spec/models/sub_provider_metadata_spec.rb +54 -0
  78. data/spec/models/{known_person_data_spec.rb → trinsic_test_database_lookup_input_spec.rb} +8 -32
  79. data/spec/models/trinsic_test_sub_providers_input_spec.rb +36 -0
  80. metadata +46 -14
  81. data/docs/KnownAddress.md +0 -32
  82. data/docs/KnownIdentityData.md +0 -18
  83. data/docs/KnownPersonData.md +0 -32
  84. data/spec/models/known_address_spec.rb +0 -78
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::SubProviderMetadata
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | The ID of the sub-provider. This cannot be used as a standalone Provider ID when creating a Session. It must be passed in via the Provider-specific input. | |
8
+ | **name** | **String** | The name of the sub-provider | |
9
+ | **description** | **String** | Flavor text for the sub-provider | |
10
+ | **logo_url** | **String** | A URL pointing to the logo on Trinsic's CDN. May be a PNG, JPG, or SVG image. | |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::SubProviderMetadata.new(
18
+ id: null,
19
+ name: null,
20
+ description: null,
21
+ logo_url: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,24 @@
1
+ # TrinsicApi::TrinsicTestDatabaseLookupInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **given_name** | **String** | The given name to use for the output of the test Session. This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user. Can be any non-empty value. | [optional] |
8
+ | **family_name** | **String** | The family name to use for the output of the test Session. This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user. Can be any non-empty value. | [optional] |
9
+ | **identity_code** | **String** | A 6-digit code; must be \"123456\" for the Session to succeed. This is required; if not provided, Trinsic's Fallback UI will be invoked to collect it from the user. Any other value will cause the Session to fail. | [optional] |
10
+ | **selfie_base64** | **String** | An optional selfie image, base64-encoded. Will replace the existing test selfie attachment output if provided. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'trinsic_api'
16
+
17
+ instance = TrinsicApi::TrinsicTestDatabaseLookupInput.new(
18
+ given_name: null,
19
+ family_name: null,
20
+ identity_code: null,
21
+ selfie_base64: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,18 @@
1
+ # TrinsicApi::TrinsicTestSubProvidersInput
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **sub_provider_id** | **String** | The ID of the specific IDP to invoke within the test federated provider. Valid options are `sub-provider-a` and `sub-provider-b`. If not specified, the user will be prompted to select one. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'trinsic_api'
13
+
14
+ instance = TrinsicApi::TrinsicTestSubProvidersInput.new(
15
+ sub_provider_id: null
16
+ )
17
+ ```
18
+
@@ -20,7 +20,7 @@ module TrinsicApi
20
20
  @api_client = api_client
21
21
  end
22
22
  # Get Attachment
23
- # Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant. In some cases, attachments may not be immediately available after a verification is completed. If so, this endpoint will return an HTTP 503 code, and you should try again later.
23
+ # Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant. In some cases, attachments may not be immediately available after a verification is completed. If so, this endpoint will return an HTTP 503 code, and you should try again later.
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [GetAttachmentRequest] :get_attachment_request
26
26
  # @return [GetAttachmentResponse]
@@ -30,7 +30,7 @@ module TrinsicApi
30
30
  end
31
31
 
32
32
  # Get Attachment
33
- # Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant. In some cases, attachments may not be immediately available after a verification is completed. If so, this endpoint will return an HTTP 503 code, and you should try again later.
33
+ # Exchange an Attachment Access Key (from `IdentityData.Attachments`) for the raw contents of the attachment. Use this API to fetch document (front, back, portrait) or other (selfie) images from a verification, if relevant. In some cases, attachments may not be immediately available after a verification is completed. If so, this endpoint will return an HTTP 503 code, and you should try again later.
34
34
  # @param [Hash] opts the optional parameters
35
35
  # @option opts [GetAttachmentRequest] :get_attachment_request
36
36
  # @return [Array<(GetAttachmentResponse, Integer, Hash)>] GetAttachmentResponse data, response status code and response headers
@@ -19,7 +19,64 @@ module TrinsicApi
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # List Identity Providers
22
+ # List Provider Contracts
23
+ # List the contracts for all Providers available to your App. If your App is in test mode, this call will only return Providers available in test mode. If your App is not in test mode, this call will only return Providers available in production.
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [ListProviderContractsResponse]
26
+ def list_provider_contracts(opts = {})
27
+ data, _status_code, _headers = list_provider_contracts_with_http_info(opts)
28
+ data
29
+ end
30
+
31
+ # List Provider Contracts
32
+ # List the contracts for all Providers available to your App. If your App is in test mode, this call will only return Providers available in test mode. If your App is not in test mode, this call will only return Providers available in production.
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(ListProviderContractsResponse, Integer, Hash)>] ListProviderContractsResponse data, response status code and response headers
35
+ def list_provider_contracts_with_http_info(opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: NetworkApi.list_provider_contracts ...'
38
+ end
39
+ # resource path
40
+ local_var_path = '/api/v1/network/providers/contracts'
41
+
42
+ # query parameters
43
+ query_params = opts[:query_params] || {}
44
+
45
+ # header parameters
46
+ header_params = opts[:header_params] || {}
47
+ # HTTP header 'Accept' (if needed)
48
+ header_params['Accept'] = @api_client.select_header_accept(['text/plain', 'application/json', 'text/json']) unless header_params['Accept']
49
+
50
+ # form parameters
51
+ form_params = opts[:form_params] || {}
52
+
53
+ # http body (model)
54
+ post_body = opts[:debug_body]
55
+
56
+ # return_type
57
+ return_type = opts[:debug_return_type] || 'ListProviderContractsResponse'
58
+
59
+ # auth_names
60
+ auth_names = opts[:debug_auth_names] || ['Bearer']
61
+
62
+ new_options = opts.merge(
63
+ :operation => :"NetworkApi.list_provider_contracts",
64
+ :header_params => header_params,
65
+ :query_params => query_params,
66
+ :form_params => form_params,
67
+ :body => post_body,
68
+ :auth_names => auth_names,
69
+ :return_type => return_type
70
+ )
71
+
72
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
73
+ if @api_client.config.debugging
74
+ @api_client.config.logger.debug "API called: NetworkApi#list_provider_contracts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
+ end
76
+ return data, status_code, headers
77
+ end
78
+
79
+ # List Providers
23
80
  # List all identity providers available for use
24
81
  # @param [Hash] opts the optional parameters
25
82
  # @return [ListProvidersResponse]
@@ -28,7 +85,7 @@ module TrinsicApi
28
85
  data
29
86
  end
30
87
 
31
- # List Identity Providers
88
+ # List Providers
32
89
  # List all identity providers available for use
33
90
  # @param [Hash] opts the optional parameters
34
91
  # @return [Array<(ListProvidersResponse, Integer, Hash)>] ListProvidersResponse data, response status code and response headers
@@ -83,7 +83,7 @@ module TrinsicApi
83
83
  end
84
84
 
85
85
  # Create Advanced Provider Session
86
- # 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.
86
+ # 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.
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @option opts [CreateAdvancedProviderSessionRequest] :create_advanced_provider_session_request
89
89
  # @return [CreateAdvancedProviderSessionResponse]
@@ -93,7 +93,7 @@ module TrinsicApi
93
93
  end
94
94
 
95
95
  # Create Advanced Provider Session
96
- # Verify a user&#39;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 &#x60;Capabilities&#x60; field. If &#x60;FallbackToHostedUi&#x60; is &#x60;true&#x60;, Trinsic&#39;s hosted UI will automatically be invoked to handle any capabilities you do not support.
96
+ # Verify a user&#39;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 &#x60;Capabilities&#x60; field. If &#x60;FallbackToHostedUi&#x60; is &#x60;true&#x60;, Trinsic&#39;s hosted UI will automatically be invoked to handle any capabilities you do not support.
97
97
  # @param [Hash] opts the optional parameters
98
98
  # @option opts [CreateAdvancedProviderSessionRequest] :create_advanced_provider_session_request
99
99
  # @return [Array<(CreateAdvancedProviderSessionResponse, Integer, Hash)>] CreateAdvancedProviderSessionResponse data, response status code and response headers
@@ -491,7 +491,7 @@ module TrinsicApi
491
491
  end
492
492
 
493
493
  # Redact Session
494
- # 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.
494
+ # 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.
495
495
  # @param session_id [String]
496
496
  # @param [Hash] opts the optional parameters
497
497
  # @return [nil]
@@ -501,7 +501,7 @@ module TrinsicApi
501
501
  end
502
502
 
503
503
  # Redact Session
504
- # Redact a Session, removing all identity data from Trinsic&#39;s servers. Every application has a redaction period that dictates how long we will hold on to your users&#39; 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.
504
+ # Redact a Session, removing all identity data from Trinsic&#39;s servers. Every application has a redaction period that dictates how long we will hold on to your users&#39; 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.
505
505
  # @param session_id [String]
506
506
  # @param [Hash] opts the optional parameters
507
507
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -18,10 +18,10 @@ module TrinsicApi
18
18
  # The user's 11-digit, numeric CPF Number
19
19
  attr_accessor :cpf_number
20
20
 
21
- # The raw bytes of the digital CNH file collected from the user. TODO: Lucas or JP help me describe these below vvvvvvvv This can be: - An image containing a physical or digital QR code - A PDF file exported from the CNH app - Some scary third thing?
21
+ # The raw bytes of the digital CNH file collected from the user. TODO: Lucas or JP help me describe these below vvvvvvvv This can be: - An image containing a physical or digital QR code - A PDF file exported from the CNH app - Some scary third thing?
22
22
  attr_accessor :digital_cnh_file
23
23
 
24
- # The MIME Type of the file contained in `DigitalCnhFile`. Must be one of `application/pdf`, `image/jpeg`, or `image/png`.
24
+ # The MIME Type of the file contained in `DigitalCnhFile`. Must be one of `application/pdf`, `image/jpeg`, or `image/png`.
25
25
  attr_accessor :digital_cnh_file_content_type
26
26
 
27
27
  # The raw bytes of the image of the user's face, collected for biometric comparison.
@@ -21,13 +21,13 @@ module TrinsicApi
21
21
  # Provider-specific input for those providers which require it.
22
22
  attr_accessor :provider_input
23
23
 
24
- # The Redirect URL to which the user should be sent after the session is complete. This field is required for providers which employ a redirect-based flow.
24
+ # The Redirect URL to which the user should be sent after the session is complete. This field is required for providers which employ a redirect-based flow.
25
25
  attr_accessor :redirect_url
26
26
 
27
- # The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering. Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`. The exception being refresh content to support updating the content of the launch method. For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities. To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities. If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities. If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation. Read more on how to integrate at <a href=\"https://docs.trinsic.id/docs/advanced-provider-sessions\">the guide on Advanced Provider Sessions</a>
27
+ # The list of capabilities your integration supports. Capabilities are the core of Trinsic's whitelabel-with-optional-fallback offering. Most capabilities align with either an `IntegrationLaunchMethod` or an `IntegrationCollectionMethod`. The exception being refresh content to support updating the content of the launch method. For example, to support a basic redirect-based flow, you must include the `LaunchRedirect` and `CaptureRedirect` capabilities. To support a mobile deeplink / polling flow, you must include the `DeeplinkToMobile` and `PollForResults` capabilities. If `FallbackToHostedUi` is `true`, Trinsic will automatically fall back to a Trinsic-hosted UI to cover any gaps in your integration's capabilities. If `FallbackToHostedUi` is `false`, gaps in your integration's capabilities will result in an error during Session creation. Read more on how to integrate at <a href=\"https://docs.trinsic.id/docs/advanced-provider-sessions\">the guide on Advanced Provider Sessions</a>
28
28
  attr_accessor :capabilities
29
29
 
30
- # Whether the session should fall back to a Trinsic-hosted UI in certain instances. Specifically, fallback will occur if any of the following are true: - You attempted to launch a provider which requires a capability you did not express support for - In this case, Trinsic's hosted UI will perform the necessary capability - You attempted to launch a provider which requires input, and the input was either not provided or incomplete - In this case, Trinsic's hosted UI will collect the necessary input from the user If fallback occurs, the session's NextStep will always be LaunchBrowser, and the CollectionMethod will always be CaptureRedirect. If this field is set to `true`, you must also: 1. Set the `RedirectUrl` field to a non-empty value 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field
30
+ # Whether the session should fall back to a Trinsic-hosted UI in certain instances. Specifically, fallback will occur if any of the following are true: - You attempted to launch a provider which requires a capability you did not express support for - In this case, Trinsic's hosted UI will perform the necessary capability - You attempted to launch a provider which requires input, and the input was either not provided or incomplete - In this case, Trinsic's hosted UI will collect the necessary input from the user If fallback occurs, the session's NextStep will always be LaunchBrowser, and the CollectionMethod will always be CaptureRedirect. If this field is set to `true`, you must also: 1. Set the `RedirectUrl` field to a non-empty value 2. Include the `LaunchBrowser` and `CaptureRedirect` capabilities in the `Capabilities` field
31
31
  attr_accessor :fallback_to_hosted_ui
32
32
 
33
33
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -18,14 +18,18 @@ module TrinsicApi
18
18
  # The ID of the newly-created Acceptance Session
19
19
  attr_accessor :session_id
20
20
 
21
- # The URL that should be used to launch the Hosted Provider Session on your user's device. There are two recommended ways to do so: - Redirect their browser to the `LaunchUrl` as a top-level navigation - Open a popup window and navigate it to the `LaunchUrl` 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.
21
+ # The URL that should be used to launch the Hosted Provider Session on your user's device. There are two recommended ways to do so: - Redirect their browser to the `LaunchUrl` as a top-level navigation - Open a popup window and navigate it to the `LaunchUrl` 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.
22
22
  attr_accessor :launch_url
23
23
 
24
+ # The `resultsAccessKey` for the Acceptance Session. This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault. Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault. Trinsic cannot access a Session's Data Vault without this key.
25
+ attr_accessor :results_access_key
26
+
24
27
  # Attribute mapping from ruby-style variable name to JSON key.
25
28
  def self.attribute_map
26
29
  {
27
30
  :'session_id' => :'sessionId',
28
- :'launch_url' => :'launchUrl'
31
+ :'launch_url' => :'launchUrl',
32
+ :'results_access_key' => :'resultsAccessKey'
29
33
  }
30
34
  end
31
35
 
@@ -38,14 +42,14 @@ module TrinsicApi
38
42
  def self.openapi_types
39
43
  {
40
44
  :'session_id' => :'String',
41
- :'launch_url' => :'String'
45
+ :'launch_url' => :'String',
46
+ :'results_access_key' => :'String'
42
47
  }
43
48
  end
44
49
 
45
50
  # List of attributes with nullable: true
46
51
  def self.openapi_nullable
47
52
  Set.new([
48
- :'launch_url'
49
53
  ])
50
54
  end
51
55
 
@@ -72,6 +76,14 @@ module TrinsicApi
72
76
 
73
77
  if attributes.key?(:'launch_url')
74
78
  self.launch_url = attributes[:'launch_url']
79
+ else
80
+ self.launch_url = nil
81
+ end
82
+
83
+ if attributes.key?(:'results_access_key')
84
+ self.results_access_key = attributes[:'results_access_key']
85
+ else
86
+ self.results_access_key = nil
75
87
  end
76
88
  end
77
89
 
@@ -84,6 +96,14 @@ module TrinsicApi
84
96
  invalid_properties.push('invalid value for "session_id", session_id cannot be nil.')
85
97
  end
86
98
 
99
+ if @launch_url.nil?
100
+ invalid_properties.push('invalid value for "launch_url", launch_url cannot be nil.')
101
+ end
102
+
103
+ if @results_access_key.nil?
104
+ invalid_properties.push('invalid value for "results_access_key", results_access_key cannot be nil.')
105
+ end
106
+
87
107
  invalid_properties
88
108
  end
89
109
 
@@ -92,6 +112,8 @@ module TrinsicApi
92
112
  def valid?
93
113
  warn '[DEPRECATED] the `valid?` method is obsolete'
94
114
  return false if @session_id.nil?
115
+ return false if @launch_url.nil?
116
+ return false if @results_access_key.nil?
95
117
  true
96
118
  end
97
119
 
@@ -101,7 +123,8 @@ module TrinsicApi
101
123
  return true if self.equal?(o)
102
124
  self.class == o.class &&
103
125
  session_id == o.session_id &&
104
- launch_url == o.launch_url
126
+ launch_url == o.launch_url &&
127
+ results_access_key == o.results_access_key
105
128
  end
106
129
 
107
130
  # @see the `==` method
@@ -113,7 +136,7 @@ module TrinsicApi
113
136
  # Calculates hash code according to all attributes.
114
137
  # @return [Integer] Hash code
115
138
  def hash
116
- [session_id, launch_url].hash
139
+ [session_id, launch_url, results_access_key].hash
117
140
  end
118
141
 
119
142
  # Builds the object from hash
@@ -15,21 +15,21 @@ require 'time'
15
15
 
16
16
  module TrinsicApi
17
17
  class CreateWidgetSessionRequest
18
- # The URL to redirect the user to after the widget session is complete. *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget as an embedded iFrame or popup; in that case, session resolution is handled by our SDK, not via redirect.
18
+ # The URL to redirect the user to after the widget session is complete. *Note*: this should NOT be set if you intend to use Trinsic's Web UI SDK to launch the Widget as an embedded iFrame or popup; in that case, session resolution is handled by our SDK, not via redirect.
19
19
  attr_accessor :redirect_url
20
20
 
21
21
  # The list of allowed identity providers. If not specified, all available providers will be allowed.
22
22
  attr_accessor :providers
23
23
 
24
- # Known identity data of an individual being verified. Provide this to Trinsic during Session creation to enable improved identity provider selection recommendations.
25
- attr_accessor :known_identity_data
24
+ # Data that you already know about the user being verified. This data is used to improve the user experience during provider selection, by surfacing the most relevant providers first.
25
+ attr_accessor :recommendation_info
26
26
 
27
27
  # Attribute mapping from ruby-style variable name to JSON key.
28
28
  def self.attribute_map
29
29
  {
30
30
  :'redirect_url' => :'redirectUrl',
31
31
  :'providers' => :'providers',
32
- :'known_identity_data' => :'knownIdentityData'
32
+ :'recommendation_info' => :'recommendationInfo'
33
33
  }
34
34
  end
35
35
 
@@ -43,7 +43,7 @@ module TrinsicApi
43
43
  {
44
44
  :'redirect_url' => :'String',
45
45
  :'providers' => :'Array<String>',
46
- :'known_identity_data' => :'KnownIdentityData'
46
+ :'recommendation_info' => :'RecommendationInfo'
47
47
  }
48
48
  end
49
49
 
@@ -52,7 +52,7 @@ module TrinsicApi
52
52
  Set.new([
53
53
  :'redirect_url',
54
54
  :'providers',
55
- :'known_identity_data'
55
+ :'recommendation_info'
56
56
  ])
57
57
  end
58
58
 
@@ -81,8 +81,8 @@ module TrinsicApi
81
81
  end
82
82
  end
83
83
 
84
- if attributes.key?(:'known_identity_data')
85
- self.known_identity_data = attributes[:'known_identity_data']
84
+ if attributes.key?(:'recommendation_info')
85
+ self.recommendation_info = attributes[:'recommendation_info']
86
86
  end
87
87
  end
88
88
 
@@ -108,7 +108,7 @@ module TrinsicApi
108
108
  self.class == o.class &&
109
109
  redirect_url == o.redirect_url &&
110
110
  providers == o.providers &&
111
- known_identity_data == o.known_identity_data
111
+ recommendation_info == o.recommendation_info
112
112
  end
113
113
 
114
114
  # @see the `==` method
@@ -120,7 +120,7 @@ module TrinsicApi
120
120
  # Calculates hash code according to all attributes.
121
121
  # @return [Integer] Hash code
122
122
  def hash
123
- [redirect_url, providers, known_identity_data].hash
123
+ [redirect_url, providers, recommendation_info].hash
124
124
  end
125
125
 
126
126
  # Builds the object from hash
@@ -18,14 +18,18 @@ module TrinsicApi
18
18
  # The ID of the newly-created Acceptance Session
19
19
  attr_accessor :session_id
20
20
 
21
- # The URL that should be used to invoke the Acceptance Session on your user's device. 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. 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.
21
+ # The URL that should be used to invoke the Acceptance Session on your user's device. 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. 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.
22
22
  attr_accessor :launch_url
23
23
 
24
+ # The `resultsAccessKey` for the Acceptance Session. This is an encrypted payload which contains the decryption key necessary to access the Session's Data Vault. Save this securely in your systems; it must be passed back with any API call which requires access to the Session's Data Vault. Trinsic cannot access a Session's Data Vault without this key.
25
+ attr_accessor :results_access_key
26
+
24
27
  # Attribute mapping from ruby-style variable name to JSON key.
25
28
  def self.attribute_map
26
29
  {
27
30
  :'session_id' => :'sessionId',
28
- :'launch_url' => :'launchUrl'
31
+ :'launch_url' => :'launchUrl',
32
+ :'results_access_key' => :'resultsAccessKey'
29
33
  }
30
34
  end
31
35
 
@@ -38,14 +42,14 @@ module TrinsicApi
38
42
  def self.openapi_types
39
43
  {
40
44
  :'session_id' => :'String',
41
- :'launch_url' => :'String'
45
+ :'launch_url' => :'String',
46
+ :'results_access_key' => :'String'
42
47
  }
43
48
  end
44
49
 
45
50
  # List of attributes with nullable: true
46
51
  def self.openapi_nullable
47
52
  Set.new([
48
- :'launch_url'
49
53
  ])
50
54
  end
51
55
 
@@ -72,6 +76,14 @@ module TrinsicApi
72
76
 
73
77
  if attributes.key?(:'launch_url')
74
78
  self.launch_url = attributes[:'launch_url']
79
+ else
80
+ self.launch_url = nil
81
+ end
82
+
83
+ if attributes.key?(:'results_access_key')
84
+ self.results_access_key = attributes[:'results_access_key']
85
+ else
86
+ self.results_access_key = nil
75
87
  end
76
88
  end
77
89
 
@@ -84,6 +96,14 @@ module TrinsicApi
84
96
  invalid_properties.push('invalid value for "session_id", session_id cannot be nil.')
85
97
  end
86
98
 
99
+ if @launch_url.nil?
100
+ invalid_properties.push('invalid value for "launch_url", launch_url cannot be nil.')
101
+ end
102
+
103
+ if @results_access_key.nil?
104
+ invalid_properties.push('invalid value for "results_access_key", results_access_key cannot be nil.')
105
+ end
106
+
87
107
  invalid_properties
88
108
  end
89
109
 
@@ -92,6 +112,8 @@ module TrinsicApi
92
112
  def valid?
93
113
  warn '[DEPRECATED] the `valid?` method is obsolete'
94
114
  return false if @session_id.nil?
115
+ return false if @launch_url.nil?
116
+ return false if @results_access_key.nil?
95
117
  true
96
118
  end
97
119
 
@@ -101,7 +123,8 @@ module TrinsicApi
101
123
  return true if self.equal?(o)
102
124
  self.class == o.class &&
103
125
  session_id == o.session_id &&
104
- launch_url == o.launch_url
126
+ launch_url == o.launch_url &&
127
+ results_access_key == o.results_access_key
105
128
  end
106
129
 
107
130
  # @see the `==` method
@@ -113,7 +136,7 @@ module TrinsicApi
113
136
  # Calculates hash code according to all attributes.
114
137
  # @return [Integer] Hash code
115
138
  def hash
116
- [session_id, launch_url].hash
139
+ [session_id, launch_url, results_access_key].hash
117
140
  end
118
141
 
119
142
  # Builds the object from hash
@@ -17,6 +17,8 @@ module TrinsicApi
17
17
  class IdentityData
18
18
  attr_accessor :originating_provider_id
19
19
 
20
+ attr_accessor :originating_sub_provider_id
21
+
20
22
  attr_accessor :person
21
23
 
22
24
  attr_accessor :document
@@ -27,6 +29,7 @@ module TrinsicApi
27
29
  def self.attribute_map
28
30
  {
29
31
  :'originating_provider_id' => :'originatingProviderId',
32
+ :'originating_sub_provider_id' => :'originatingSubProviderId',
30
33
  :'person' => :'person',
31
34
  :'document' => :'document',
32
35
  :'attachment_access_keys' => :'attachmentAccessKeys'
@@ -42,6 +45,7 @@ module TrinsicApi
42
45
  def self.openapi_types
43
46
  {
44
47
  :'originating_provider_id' => :'String',
48
+ :'originating_sub_provider_id' => :'String',
45
49
  :'person' => :'PersonData',
46
50
  :'document' => :'DocumentData',
47
51
  :'attachment_access_keys' => :'AttachmentAccessKeys'
@@ -52,6 +56,7 @@ module TrinsicApi
52
56
  def self.openapi_nullable
53
57
  Set.new([
54
58
  :'originating_provider_id',
59
+ :'originating_sub_provider_id',
55
60
  :'person',
56
61
  :'document',
57
62
  :'attachment_access_keys'
@@ -77,6 +82,10 @@ module TrinsicApi
77
82
  self.originating_provider_id = attributes[:'originating_provider_id']
78
83
  end
79
84
 
85
+ if attributes.key?(:'originating_sub_provider_id')
86
+ self.originating_sub_provider_id = attributes[:'originating_sub_provider_id']
87
+ end
88
+
80
89
  if attributes.key?(:'person')
81
90
  self.person = attributes[:'person']
82
91
  end
@@ -111,6 +120,7 @@ module TrinsicApi
111
120
  return true if self.equal?(o)
112
121
  self.class == o.class &&
113
122
  originating_provider_id == o.originating_provider_id &&
123
+ originating_sub_provider_id == o.originating_sub_provider_id &&
114
124
  person == o.person &&
115
125
  document == o.document &&
116
126
  attachment_access_keys == o.attachment_access_keys
@@ -125,7 +135,7 @@ module TrinsicApi
125
135
  # Calculates hash code according to all attributes.
126
136
  # @return [Integer] Hash code
127
137
  def hash
128
- [originating_provider_id, person, document, attachment_access_keys].hash
138
+ [originating_provider_id, originating_sub_provider_id, person, document, attachment_access_keys].hash
129
139
  end
130
140
 
131
141
  # Builds the object from hash
@@ -14,15 +14,14 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module TrinsicApi
17
- # Known identity data of an individual being verified. Provide this to Trinsic during Session creation to enable improved identity provider selection recommendations.
18
- class KnownIdentityData
19
- # Known identity data specific to the person being verified
20
- attr_accessor :person
17
+ class IdinInput
18
+ # The ID of the specific bank to invoke with IDIN. If not specified, the user will be prompted to select a bank.
19
+ attr_accessor :sub_provider_id
21
20
 
22
21
  # Attribute mapping from ruby-style variable name to JSON key.
23
22
  def self.attribute_map
24
23
  {
25
- :'person' => :'person'
24
+ :'sub_provider_id' => :'subProviderId'
26
25
  }
27
26
  end
28
27
 
@@ -34,14 +33,14 @@ module TrinsicApi
34
33
  # Attribute type mapping.
35
34
  def self.openapi_types
36
35
  {
37
- :'person' => :'KnownPersonData'
36
+ :'sub_provider_id' => :'String'
38
37
  }
39
38
  end
40
39
 
41
40
  # List of attributes with nullable: true
42
41
  def self.openapi_nullable
43
42
  Set.new([
44
- :'person'
43
+ :'sub_provider_id'
45
44
  ])
46
45
  end
47
46
 
@@ -49,19 +48,19 @@ module TrinsicApi
49
48
  # @param [Hash] attributes Model attributes in the form of hash
50
49
  def initialize(attributes = {})
51
50
  if (!attributes.is_a?(Hash))
52
- fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::KnownIdentityData` initialize method"
51
+ fail ArgumentError, "The input argument (attributes) must be a hash in `TrinsicApi::IdinInput` initialize method"
53
52
  end
54
53
 
55
54
  # check to see if the attribute exists and convert string to symbol for hash key
56
55
  attributes = attributes.each_with_object({}) { |(k, v), h|
57
56
  if (!self.class.attribute_map.key?(k.to_sym))
58
- fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::KnownIdentityData`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
57
+ fail ArgumentError, "`#{k}` is not a valid attribute in `TrinsicApi::IdinInput`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
59
58
  end
60
59
  h[k.to_sym] = v
61
60
  }
62
61
 
63
- if attributes.key?(:'person')
64
- self.person = attributes[:'person']
62
+ if attributes.key?(:'sub_provider_id')
63
+ self.sub_provider_id = attributes[:'sub_provider_id']
65
64
  end
66
65
  end
67
66
 
@@ -85,7 +84,7 @@ module TrinsicApi
85
84
  def ==(o)
86
85
  return true if self.equal?(o)
87
86
  self.class == o.class &&
88
- person == o.person
87
+ sub_provider_id == o.sub_provider_id
89
88
  end
90
89
 
91
90
  # @see the `==` method
@@ -97,7 +96,7 @@ module TrinsicApi
97
96
  # Calculates hash code according to all attributes.
98
97
  # @return [Integer] Hash code
99
98
  def hash
100
- [person].hash
99
+ [sub_provider_id].hash
101
100
  end
102
101
 
103
102
  # Builds the object from hash
@@ -16,12 +16,12 @@ require 'time'
16
16
  module TrinsicApi
17
17
  class IntegrationLaunchMethod
18
18
  LAUNCH_BROWSER = "LaunchBrowser".freeze
19
- POLL_RESULT = "PollResult".freeze
19
+ NONE = "None".freeze
20
20
  DEEPLINK_TO_MOBILE = "DeeplinkToMobile".freeze
21
21
  SHOW_CONTENT = "ShowContent".freeze
22
22
 
23
23
  def self.all_vars
24
- @all_vars ||= [LAUNCH_BROWSER, POLL_RESULT, DEEPLINK_TO_MOBILE, SHOW_CONTENT].freeze
24
+ @all_vars ||= [LAUNCH_BROWSER, NONE, DEEPLINK_TO_MOBILE, SHOW_CONTENT].freeze
25
25
  end
26
26
 
27
27
  # Builds the enum from string