trinsic_api 2.2.0 → 2.3.0.pre.alpha1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7119195ef1973bb58ec167091a9fb2b4bec432da992452638f76af0163dff5b4
-  data.tar.gz: d725f104318f759292c70adf177d7e0a0909d97a5946720d28a9eed09e2e3108
+  metadata.gz: 26f9e70f0a127486cf561fa90e9b89a4344e6afe56c1a4cb36770623b61b0af7
+  data.tar.gz: 52e4df967dfcd364b11b63c6f9ac4e0274a604a3b33a09253e63af6a94bcd028
 SHA512:
-  metadata.gz: 29575cae410be8e818ff5918930730731b4efe8616023f7a99f2e1936c5e116c87849d4b6c295920e2fedcb355f9b0231d1bbba417ad3d27c15b6e4739e1189a
-  data.tar.gz: 1296cfb9a8eaa46d654431b010eb714c7b73f6890e2b28d48ac60e0162ca82e9e9b479512114ac95a5ecacd5a98d9ddcbcaf11c250dae95c01774b38789deb3a
+  metadata.gz: 20c8e01b1b83df0b5dfd193b50981fa9bce7e43ca3a8de1a0a4c57f4ec0481b582091b51ecd0818937bb1cf86be4f4317ac62b96f2583b130d5e2f18a891a907
+  data.tar.gz: 3fae13cb18c93d822708acf0f6b6b04fd1e03682b7f331571f51c8d72206a83fb3513a6ab893420f04c21f21fb234d5706a14558f3b8edb9d1cbf3e95d2a8ad7

data/docs/AddRedirectUriResponse.md

@@ -0,0 +1,18 @@
+# TrinsicApi::AddRedirectUriResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::AddRedirectUriResponse.new(
+  id: null
+)
+```
+

data/docs/ContractField.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the field as it appears in verification results. |  |
+| **scope** | **String** | The scope of the field as it appears in verification results. |  |
 | **outputted** | [**FieldAvailability**](FieldAvailability.md) | Indicates when this field will be present in verification results. |  |
 
 ## Example
@@ -14,6 +15,7 @@ require 'trinsic_api'
 
 instance = TrinsicApi::ContractField.new(
   name: person.givenName,
+  scope: person.givenName,
   outputted: null
 )
 ```

data/docs/ContractIdentifierField.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ContractIdentifierField
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scope** | **String** | The scope of the identifier as it appears in verification results. |  |
+| **outputted** | [**FieldAvailability**](FieldAvailability.md) | Indicates when this field will be present in verification results. |  |
+| **description** | **String** | A human-readable description of the identifier, written by Trinsic. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ContractIdentifierField.new(
+  scope: vatNumber,
+  outputted: null,
+  description: Italian fiscal number from the SPID identity
+)
+```
+

data/docs/CreateVerificationProfileResponse.md

@@ -0,0 +1,18 @@
+# TrinsicApi::CreateVerificationProfileResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the verification profile |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::CreateVerificationProfileResponse.new(
+  id: null
+)
+```
+

data/docs/EnvironmentRedirectUrisAddRequest.md

@@ -0,0 +1,18 @@
+# TrinsicApi::EnvironmentRedirectUrisAddRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uri** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::EnvironmentRedirectUrisAddRequest.new(
+  uri: null
+)
+```
+

data/docs/EnvironmentRedirectUrisApi.md

@@ -0,0 +1,222 @@
+# TrinsicApi::EnvironmentRedirectUrisApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add**](EnvironmentRedirectUrisApi.md#add) | **POST** /api/valpha/environments/redirect-uris | Add Redirect URI |
+| [**delete**](EnvironmentRedirectUrisApi.md#delete) | **DELETE** /api/valpha/environments/redirect-uris/{id} | Delete Redirect URI |
+| [**list**](EnvironmentRedirectUrisApi.md#list) | **GET** /api/valpha/environments/redirect-uris | List Redirect URIs |
+
+
+## add
+
+> <AddRedirectUriResponse> add(opts)
+
+Add Redirect URI
+
+Add a new redirect uri to the environment.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::EnvironmentRedirectUrisApi.new
+opts = {
+  environment_redirect_uris_add_request: TrinsicApi::EnvironmentRedirectUrisAddRequest.new({uri: 'uri_example'}) # EnvironmentRedirectUrisAddRequest | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \"*\" accepted.
+}
+
+begin
+  # Add Redirect URI
+  result = api_instance.add(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->add: #{e}"
+end
+```
+
+#### Using the add_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AddRedirectUriResponse>, Integer, Hash)> add_with_http_info(opts)
+
+```ruby
+begin
+  # Add Redirect URI
+  data, status_code, headers = api_instance.add_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AddRedirectUriResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->add_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **environment_redirect_uris_add_request** | [**EnvironmentRedirectUrisAddRequest**](EnvironmentRedirectUrisAddRequest.md) | Request for uri to add to the environment. Must be absolute, not relative. Wildcard \&quot;*\&quot; accepted. | [optional] |
+
+### Return type
+
+[**AddRedirectUriResponse**](AddRedirectUriResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json, application/*+json
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+
+
+## delete
+
+> delete(id)
+
+Delete Redirect URI
+
+Delete a redirect uri from the environment.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::EnvironmentRedirectUrisApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id of the redirect uri to delete.
+
+begin
+  # Delete Redirect URI
+  api_instance.delete(id)
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->delete: #{e}"
+end
+```
+
+#### Using the delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_with_http_info(id)
+
+```ruby
+begin
+  # Delete Redirect URI
+  data, status_code, headers = api_instance.delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The id of the redirect uri to delete. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## list
+
+> <ListEnvironmentRedirectUrisResponse> list(opts)
+
+List Redirect URIs
+
+List redirect URIs within the environment.
+
+### Examples
+
+```ruby
+require 'time'
+require 'trinsic_api'
+# setup authorization
+TrinsicApi.configure do |config|
+  # Configure Bearer authorization: Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TrinsicApi::EnvironmentRedirectUrisApi.new
+opts = {
+  page: 56, # Integer | Number of pages of uris to return.
+  page_size: 56 # Integer | Size of the list to be returned. Accepted range from 1 to 100
+}
+
+begin
+  # List Redirect URIs
+  result = api_instance.list(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->list: #{e}"
+end
+```
+
+#### Using the list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListEnvironmentRedirectUrisResponse>, Integer, Hash)> list_with_http_info(opts)
+
+```ruby
+begin
+  # List Redirect URIs
+  data, status_code, headers = api_instance.list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListEnvironmentRedirectUrisResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling EnvironmentRedirectUrisApi->list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Number of pages of uris to return. | [optional][default to 1] |
+| **page_size** | **Integer** | Size of the list to be returned. Accepted range from 1 to 100 | [optional][default to 20] |
+
+### Return type
+
+[**ListEnvironmentRedirectUrisResponse**](ListEnvironmentRedirectUrisResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json, application/problem+json
+

data/docs/FaydaProviderOutput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::FaydaProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sub** | **String** | A unique eKYC identifying token used to match the original eKYC token received from the provider when the user was initially registered.              Since Fayda does not return identifying data, it is the responsibility of the relying party to keep the unique user token received from Fayda when the user was initially registered to do a comparison of the subs to verify that it is the same person. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::FaydaProviderOutput.new(
+  sub: null
+)
+```
+

data/docs/Identifier.md

@@ -0,0 +1,22 @@
+# TrinsicApi::Identifier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | **String** |  |  |
+| **scope** | **String** |  |  |
+| **description** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::Identifier.new(
+  identifier: null,
+  scope: null,
+  description: null
+)
+```
+

data/docs/IdentityData.md

@@ -10,6 +10,8 @@
 | **document** | [**DocumentData**](DocumentData.md) |  | [optional] |
 | **match** | [**MatchData**](MatchData.md) |  | [optional] |
 | **attachment_access_keys** | [**AttachmentAccessKeys**](AttachmentAccessKeys.md) |  | [optional] |
+| **provider_output** | [**ProviderOutput**](ProviderOutput.md) |  | [optional] |
+| **identifiers** | [**Array<Identifier>**](Identifier.md) |  |  |
 
 ## Example
 
@@ -22,7 +24,9 @@ instance = TrinsicApi::IdentityData.new(
   person: null,
   document: null,
   match: null,
-  attachment_access_keys: null
+  attachment_access_keys: null,
+  provider_output: null,
+  identifiers: null
 )
 ```
 

data/docs/ListEnvironmentRedirectUrisResponse.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ListEnvironmentRedirectUrisResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **uris** | [**Array<RedirectUriResponse>**](RedirectUriResponse.md) | List of redirect uris within the environment. |  |
+| **more** | **Boolean** | Whether there are additional pages of uris to retrieve |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ListEnvironmentRedirectUrisResponse.new(
+  uris: null,
+  more: true
+)
+```
+

data/docs/ListVerificationProfilesResponse.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ListVerificationProfilesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verification_profiles** | [**Array<VerificationProfileResponse>**](VerificationProfileResponse.md) |  |  |
+| **more** | **Boolean** | Whether there are additional pages of verification profiles to retrieve |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ListVerificationProfilesResponse.new(
+  verification_profiles: null,
+  more: true
+)
+```
+

data/docs/MexicoCurpProviderOutput.md

@@ -0,0 +1,18 @@
+# TrinsicApi::MexicoCurpProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **curp_status** | **String** | Curp status for the subject.              Possible values: - AN: Alta Normal (Normal registration) - Active - AH: Alta con Homonimia (Registration with homonymy) - Active - RCC: Registro de cambio afectando a CURP (Change affecting CURP) - Active - RCN: Registro de cambio no afectando a CURP (Change not affecting CURP) - Active - BAP: Baja por documento apócrifo (Low due to apocryphal document) - Inactive - BSU: Baja sin uso (Low curp without use) - Inactive - BD: Baja por defunción (Low curp due to death) - Inactive - BDM: Baja administrativa (Low, due to administrative process) - Inactive - BDP: Baja por adopción (Low, due to adoption) - Inactive - BJD: Baja Judicial (Low for judicial reasons) - Inactive | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::MexicoCurpProviderOutput.new(
+  curp_status: null
+)
+```
+

data/docs/ProviderContract.md

@@ -21,6 +21,7 @@
 | **supports_advanced_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API.              If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. |  |
 | **supports_direct_provider_sessions** | **Boolean** | Whether this Provider can be fully whitelabeled/OEMed through the Direct Provider Sessions API.              If `false`, the Provider may still be launched through Direct Provider Sessions; however, it will necessarily require a Trinsic-hosted UI to function. |  |
 | **available_fields** | [**Array<ContractField>**](ContractField.md) | Information about the fields that this Provider will return in verification results. | [optional] |
+| **available_identifiers** | [**Array<ContractIdentifierField>**](ContractIdentifierField.md) | Information about the identifiers this Provider returns in verification results. | [optional] |
 | **sub_providers** | [**Array<SubProviderMetadata>**](SubProviderMetadata.md) | Metadata about the sub-providers which are available for this Provider.              For example, Italy's SPID is a Provider which aggregates access to multiple sub-providers. | [optional] |
 | **health** | [**ProviderHealth**](ProviderHealth.md) | The health for an integration to be able to successfully perform a verification session. |  |
 
@@ -47,6 +48,7 @@ instance = TrinsicApi::ProviderContract.new(
   supports_advanced_provider_sessions: true,
   supports_direct_provider_sessions: true,
   available_fields: null,
+  available_identifiers: null,
   sub_providers: null,
   health: null
 )

data/docs/ProviderOutput.md

@@ -0,0 +1,22 @@
+# TrinsicApi::ProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **italy_spid** | [**SpidProviderOutput**](SpidProviderOutput.md) |  | [optional] |
+| **mexico_curp_lookup** | [**MexicoCurpProviderOutput**](MexicoCurpProviderOutput.md) |  | [optional] |
+| **ethiopia_fayda** | [**FaydaProviderOutput**](FaydaProviderOutput.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ProviderOutput.new(
+  italy_spid: null,
+  mexico_curp_lookup: null,
+  ethiopia_fayda: null
+)
+```
+

data/docs/RedirectUriResponse.md

@@ -0,0 +1,20 @@
+# TrinsicApi::RedirectUriResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **uri** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::RedirectUriResponse.new(
+  id: null,
+  uri: null
+)
+```
+

data/docs/SpidBillingInformation.md

@@ -0,0 +1,22 @@
+# TrinsicApi::SpidBillingInformation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_billable** | **Boolean** | Whether this SPID verification has resulted in a billable event. |  |
+| **verification_type** | **String** | The billable verification type for this SPID verification.              Possible values: \"Authentication\" | \"Registration\" |  |
+| **verification_level** | **Integer** | The billable verification level for this SPID verification.              Possible values: 1 | 2 | 3 |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::SpidBillingInformation.new(
+  is_billable: true,
+  verification_type: "Authentication",
+  verification_level: 1
+)
+```
+

data/docs/SpidInput.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **sub_provider_id** | **String** | The ID of the specific IDP to invoke within SPID.              If not specified, the user will be prompted to select an IDP. | [optional] |
+| **billing_tracking_secret** | **String** | Only applicable if period-based billing is enabled for your Verification Profile. Contact Trinsic to enable this.              A secret UTF-8 string between 32 and 64 characters in length, used to enable privacy-preserving tracking of unique user verifications during a billing period.              WARNING: This value must NOT change during the course of a billing period for a given Verification Profile, or double-billing may occur. If multiple Verification Profiles are configured to use the same Trinsic-managed SPID Service Provider, the same Billing Tracking Secret must be provided across all such Verification Profiles. | [optional] |
 
 ## Example
 
@@ -12,7 +13,8 @@
 require 'trinsic_api'
 
 instance = TrinsicApi::SpidInput.new(
-  sub_provider_id: null
+  sub_provider_id: null,
+  billing_tracking_secret: null
 )
 ```
 

data/docs/SpidProviderOutput.md

@@ -0,0 +1,26 @@
+# TrinsicApi::SpidProviderOutput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **billing_information** | [**SpidBillingInformation**](SpidBillingInformation.md) | Information about the billable status of this SPID Verification.              Present only if your account has period-based billing enabled for SPID. Contact Trinsic to enable this. | [optional] |
+| **fiscal_number** | **String** | Fiscal tax number for the subject. | [optional] |
+| **spid_code** | **String** | Unique user identifier contained within the SPID identity. | [optional] |
+| **iva_code** | **String** | VAT number for the subject. | [optional] |
+| **spid_credential_expiration_date** | **Date** | Expiration date of the user's SPID credential.              This is not the same as the expiration date of the underlying identity document (such as a passport) which was used to create the SPID identity. | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::SpidProviderOutput.new(
+  billing_information: null,
+  fiscal_number: null,
+  spid_code: null,
+  iva_code: null,
+  spid_credential_expiration_date: null
+)
+```
+

data/docs/VerificationProfileResponse.md

@@ -0,0 +1,28 @@
+# TrinsicApi::VerificationProfileResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the verification profile |  |
+| **_alias** | **String** | An alias of the verification profile shown to developers and administrators. |  |
+| **brand_name** | **String** | The brand name of the verification profile shown to end-users. |  |
+| **logo_url** | **String** | The URL of the verification profile's logo. |  |
+| **primary_color** | **String** | The primary color of the verification profile. |  |
+| **enabled_providers** | **Array<String>** | The providers that are currently enabled for the verification profile. |  |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::VerificationProfileResponse.new(
+  id: null,
+  _alias: null,
+  brand_name: null,
+  logo_url: null,
+  primary_color: null,
+  enabled_providers: null
+)
+```
+