trinsic_api 2.3.0.pre.alpha2 → 3.0.0

data/docs/AttachmentAccessKeys.md

@@ -1,28 +0,0 @@
-# TrinsicApi::AttachmentAccessKeys
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **selfie** | **String** |  | [optional] |
-| **document_front** | **String** |  | [optional] |
-| **document_back** | **String** |  | [optional] |
-| **document_portrait** | **String** |  | [optional] |
-| **document_signature** | **String** |  | [optional] |
-| **provider** | [**ProviderAttachments**](ProviderAttachments.md) |  |  |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::AttachmentAccessKeys.new(
-  selfie: null,
-  document_front: null,
-  document_back: null,
-  document_portrait: null,
-  document_signature: null,
-  provider: null
-)
-```
-

data/docs/AttachmentsApi.md

@@ -1,79 +0,0 @@
-# TrinsicApi::AttachmentsApi
-
-All URIs are relative to *https://api.trinsic.id*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**get_attachment**](AttachmentsApi.md#get_attachment) | **POST** /api/v1/attachments/attachment | Get Attachment |
-
-
-## get_attachment
-
-> <GetAttachmentResponse> get_attachment(opts)
-
-Get Attachment
-
-Exchange an Attachment Access Key (from `IdentityData.AttachmentAccessKeys`) 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.
-
-### 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::AttachmentsApi.new
-opts = {
-  get_attachment_request: TrinsicApi::GetAttachmentRequest.new({attachment_access_key: 'attachment_access_key_example', session_id: '00000000-0000-0000-0000-000000000000'}) # GetAttachmentRequest | 
-}
-
-begin
-  # Get Attachment
-  result = api_instance.get_attachment(opts)
-  p result
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling AttachmentsApi->get_attachment: #{e}"
-end
-```
-
-#### Using the get_attachment_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<GetAttachmentResponse>, Integer, Hash)> get_attachment_with_http_info(opts)
-
-```ruby
-begin
-  # Get Attachment
-  data, status_code, headers = api_instance.get_attachment_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <GetAttachmentResponse>
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling AttachmentsApi->get_attachment_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **get_attachment_request** | [**GetAttachmentRequest**](GetAttachmentRequest.md) |  | [optional] |
-
-### Return type
-
-[**GetAttachmentResponse**](GetAttachmentResponse.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
-

data/docs/BangladeshNidInput.md

@@ -1,26 +0,0 @@
-# TrinsicApi::BangladeshNidInput
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **national_id_number** | **String** | The user's Bangladesh National ID number. |  |
-| **date_of_birth** | **Date** | The user's date of birth, in `YYYY-MM-DD` format |  |
-| **name** | **String** | The user's full name |  |
-| **photo_byes** | **String** | The raw bytes of the photo file collected from the user. | [optional] |
-| **photo_image_mime_type** | **String** | The MIME Type of the file contained in `PhotoByes`.              Must be one of `image/jpeg`, or `image/png`. | [optional] |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::BangladeshNidInput.new(
-  national_id_number: null,
-  date_of_birth: null,
-  name: null,
-  photo_byes: null,
-  photo_image_mime_type: null
-)
-```
-

data/docs/ContractField.md

@@ -1,22 +0,0 @@
-# TrinsicApi::ContractField
-
-## Properties
-
-| 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
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::ContractField.new(
-  name: person.givenName,
-  scope: person.givenName,
-  outputted: null
-)
-```
-

data/docs/ContractIdentifierField.md

@@ -1,22 +0,0 @@
-# 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/CreateMdlExchangeRequest.md

@@ -1,32 +0,0 @@
-# TrinsicApi::CreateMdlExchangeRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **verification_profile_id** | **String** | The ID of the VerificationProfile to use for this mDL exchange. |  |
-| **provider** | **String** | The ID of the provider to use for this mDL exchange. |  |
-| **exchange_mechanism** | [**MdlExchangeMechanism**](MdlExchangeMechanism.md) | The mechanism by which the mDL exchange will occur (web, native SDK, etc.) |  |
-| **document_type** | **String** | The document type to request from the wallet.              Typically, this is one of the following values:              - `org.iso.18013.5.1.mDL` (Mobile Driver's License) - `com.google.wallet.idcard.1` (Google Wallet ID Pass) |  |
-| **name_spaces** | **Hash<String, Hash<String, Boolean>>** | The namespaces and fields to request from the mDL.              This is a nested map / dictionary. The outer dictionary's keys are namespaces (e.g. \"org.iso.18013.5.1\"). The inner dictionary's keys are field names within each namespace, with boolean values indicating whether the specified field will be retained post-verification. |  |
-| **digital_credentials_api_host** | **String** | If using the `DigitalCredentialsApi` exchange mechanism, this is the hostname on which the Digital Credentials API will be called.              For example, if the user is on the page `https://foo.example.com/verify-mdl`, the proper value to use is `foo.example.com`.              Present for ease of testing only. May be removed as this API is stabilized. | [optional] |
-| **android_native_app_package_name** | **String** | If using the `NativeApp` exchange mechanism with the `google-wallet` provider, this is the package name of the Android App which will execute the mDL exchange.              This should be set to the package name of your app.              Present for ease of testing only. May be removed as this API is stabilized. | [optional] |
-| **android_native_app_signing_certificate_fingerprint** | **String** | If using the `NativeApp` exchange mechanism with the `google-wallet` provider, this is the SHA-256 fingerprint of the signing certificate used to sign the Android App which will execute the mDL exchange.              Present for ease of testing only. May be removed as this API is stabilized. | [optional] |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::CreateMdlExchangeRequest.new(
-  verification_profile_id: null,
-  provider: google-wallet,
-  exchange_mechanism: null,
-  document_type: org.iso.18013.5.1.mDL,
-  name_spaces: {"org.iso.18013.5.1":{"given_name":true,"family_name":true,"birth_date":true,"age_over_21":true}},
-  digital_credentials_api_host: verify.trinsic.id,
-  android_native_app_package_name: id.trinsic.example,
-  android_native_app_signing_certificate_fingerprint: 96:77:82:71:A3:FC:26:54:4C:8E:06:70:B7:BA:5D:E2:A5:36:F1:ED:8F:8A:70:81:26:98:EC:87:86:0F:D4:42
-)
-```
-

data/docs/CreateMdlExchangeResponse.md

@@ -1,22 +0,0 @@
-# TrinsicApi::CreateMdlExchangeResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **exchange_id** | **String** | The ID of the mDL exchange which was created. |  |
-| **request_object_base64_url** | **String** | The request object for this mDL exchange.              Pass this into a Trinsic mDL SDK (Web, iOS, Android) exactly as-is to initiate the mDL exchange. |  |
-| **exchange_context** | **String** | The encrypted exchange context for this mDL exchange.              This must be passed back to the API during finalization, alongside the response token from the wallet. |  |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::CreateMdlExchangeResponse.new(
-  exchange_id: null,
-  request_object_base64_url: null,
-  exchange_context: null
-)
-```
-

data/docs/DocumentScanAttachments.md

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

data/docs/FinalizeMdlExchangeRequest.md

@@ -1,24 +0,0 @@
-# TrinsicApi::FinalizeMdlExchangeRequest
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **verification_profile_id** | **String** | The ID of the VerificationProfile which was used to create the mDL exchange. |  |
-| **exchange_id** | **String** | The ID of the mDL exchange to finalize. |  |
-| **exchange_context** | **String** | The encrypted exchange context which was returned when the mDL exchange was created. |  |
-| **response_token** | **String** | The response token returned by Trinsic's SDK after a successful mDL exchange. |  |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::FinalizeMdlExchangeRequest.new(
-  verification_profile_id: null,
-  exchange_id: null,
-  exchange_context: null,
-  response_token: null
-)
-```
-

data/docs/FinalizeMdlExchangeResponse.md

@@ -1,24 +0,0 @@
-# TrinsicApi::FinalizeMdlExchangeResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **exchange_id** | **String** | The Exchange ID of the mDL exchange which was just finalized. |  |
-| **created_session** | [**Session**](Session.md) | The AcceptanceSession which was created as a result of finalizing this mDL exchange. |  |
-| **mdl_data** | [**MdlIdentityData**](MdlIdentityData.md) | The identity data from the mDL exchange, in a semi-normalized format.              Supports all possible fields and namespaces, but does not map them to Trinsic's common data model. | [optional] |
-| **normalized_identity_data** | [**IdentityData**](IdentityData.md) | The identity data from the mDL exchange, normalized into Trinsic's common data model. | [optional] |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::FinalizeMdlExchangeResponse.new(
-  exchange_id: null,
-  created_session: null,
-  mdl_data: null,
-  normalized_identity_data: null
-)
-```
-

data/docs/Identifier.md

@@ -1,22 +0,0 @@
-# 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/ListProviderContractsResponse.md

@@ -1,18 +0,0 @@
-# TrinsicApi::ListProviderContractsResponse
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **provider_contracts** | [**Array<ProviderContract>**](ProviderContract.md) | Contracts for all Providers available to your App, filtered by your App's current test mode setting. |  |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::ListProviderContractsResponse.new(
-  provider_contracts: null
-)
-```
-

data/docs/MdlApi.md

@@ -1,151 +0,0 @@
-# TrinsicApi::MdlApi
-
-All URIs are relative to *https://api.trinsic.id*
-
-| Method | HTTP request | Description |
-| ------ | ------------ | ----------- |
-| [**create_mdl_exchange**](MdlApi.md#create_mdl_exchange) | **POST** /api/valpha/mdl/exchanges/create | Create mDL Exchange |
-| [**finalize_mdl_exchange**](MdlApi.md#finalize_mdl_exchange) | **POST** /api/valpha/mdl/exchanges/finalize | Finalize mDL Exchange |
-
-
-## create_mdl_exchange
-
-> <CreateMdlExchangeResponse> create_mdl_exchange(opts)
-
-Create mDL Exchange
-
-Creates a new mDL Exchange, returning an exchange ID, request object string, and context string.              mDL Exchanges are ephemeral until completion -- no state is stored within Trinsic until the exchange is finalized.              This API currently only supports Google Wallet on Android via Web or Native. Apple Wallet support is coming soon.
-
-### 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::MdlApi.new
-opts = {
-  create_mdl_exchange_request: TrinsicApi::CreateMdlExchangeRequest.new({verification_profile_id: 'verification_profile_id_example', provider: 'google-wallet', exchange_mechanism: TrinsicApi::MdlExchangeMechanism::NATIVE_APP, document_type: 'org.iso.18013.5.1.mDL', name_spaces: { key: { key: false}}}) # CreateMdlExchangeRequest | 
-}
-
-begin
-  # Create mDL Exchange
-  result = api_instance.create_mdl_exchange(opts)
-  p result
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling MdlApi->create_mdl_exchange: #{e}"
-end
-```
-
-#### Using the create_mdl_exchange_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<CreateMdlExchangeResponse>, Integer, Hash)> create_mdl_exchange_with_http_info(opts)
-
-```ruby
-begin
-  # Create mDL Exchange
-  data, status_code, headers = api_instance.create_mdl_exchange_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <CreateMdlExchangeResponse>
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling MdlApi->create_mdl_exchange_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **create_mdl_exchange_request** | [**CreateMdlExchangeRequest**](CreateMdlExchangeRequest.md) |  | [optional] |
-
-### Return type
-
-[**CreateMdlExchangeResponse**](CreateMdlExchangeResponse.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
-
-
-## finalize_mdl_exchange
-
-> <FinalizeMdlExchangeResponse> finalize_mdl_exchange(opts)
-
-Finalize mDL Exchange
-
-Finalizes an mDL Exchange, processing the results
-
-### 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::MdlApi.new
-opts = {
-  finalize_mdl_exchange_request: TrinsicApi::FinalizeMdlExchangeRequest.new({verification_profile_id: 'verification_profile_id_example', exchange_id: 'exchange_id_example', exchange_context: 'exchange_context_example', response_token: 'response_token_example'}) # FinalizeMdlExchangeRequest | 
-}
-
-begin
-  # Finalize mDL Exchange
-  result = api_instance.finalize_mdl_exchange(opts)
-  p result
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling MdlApi->finalize_mdl_exchange: #{e}"
-end
-```
-
-#### Using the finalize_mdl_exchange_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<FinalizeMdlExchangeResponse>, Integer, Hash)> finalize_mdl_exchange_with_http_info(opts)
-
-```ruby
-begin
-  # Finalize mDL Exchange
-  data, status_code, headers = api_instance.finalize_mdl_exchange_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <FinalizeMdlExchangeResponse>
-rescue TrinsicApi::ApiError => e
-  puts "Error when calling MdlApi->finalize_mdl_exchange_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **finalize_mdl_exchange_request** | [**FinalizeMdlExchangeRequest**](FinalizeMdlExchangeRequest.md) |  | [optional] |
-
-### Return type
-
-[**FinalizeMdlExchangeResponse**](FinalizeMdlExchangeResponse.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
-

data/docs/MdlCertificateData.md

@@ -1,26 +0,0 @@
-# TrinsicApi::MdlCertificateData
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **serial_number** | **String** | The serial number of the certificate |  |
-| **common_name** | **String** | The common name (CN) of the certificate |  |
-| **state_or_province_name** | **String** | The state or province name (ST) of the certificate.              May be an empty string for certificates which are not state-specific (e.g., Google Wallet's ID Pass certificates). |  |
-| **not_before** | **Time** | The date before which this certificate is not valid. |  |
-| **not_after** | **Time** | The date after which this certificate is not valid. |  |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::MdlCertificateData.new(
-  serial_number: null,
-  common_name: null,
-  state_or_province_name: null,
-  not_before: null,
-  not_after: null
-)
-```
-

data/docs/MdlIdentityData.md

@@ -1,22 +0,0 @@
-# TrinsicApi::MdlIdentityData
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **iaca_root_certificate** | [**MdlCertificateData**](MdlCertificateData.md) | Information about the IACA Root Certificate which signed the Issuer Certificate for this mDL. |  |
-| **document_signer_certificate** | [**MdlCertificateData**](MdlCertificateData.md) | Information about the Document Signer Certificate which signed the mDL presented by the user. |  |
-| **name_spaces** | **Hash<String, Hash<String, ExternalMdlFieldData>>** | The namespaces, and fields within those namespaces, which were present in the processed mDL. |  |
-
-## Example
-
-```ruby
-require 'trinsic_api'
-
-instance = TrinsicApi::MdlIdentityData.new(
-  iaca_root_certificate: null,
-  document_signer_certificate: null,
-  name_spaces: {"org.iso.18013.5.1":{"family_name":{"type":"String","value":"DOE"},"given_name":{"type":"String","value":"JOHN"},"birth_date":{"type":"String","value":"2000-03-27"},"age_over_21":{"type":"Boolean","value":"true"}}}
-)
-```
-