trinsic_api 0.2.3

data/docs/SessionsApi.md

@@ -0,0 +1,428 @@
+# TrinsicApi::SessionsApi
+
+All URIs are relative to *https://api.trinsic.id*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**cancel_session**](SessionsApi.md#cancel_session) | **POST** /api/v1/sessions/{sessionId}/cancel | Cancel a Session by its ID |
+| [**create_session**](SessionsApi.md#create_session) | **POST** /api/v1/sessions | Create a Session to verify a user's identity |
+| [**exchange_results_key**](SessionsApi.md#exchange_results_key) | **POST** /api/v1/sessions/{sessionId}/results/exchange | Exchange a Results Access Key for Identity Data |
+| [**get_session**](SessionsApi.md#get_session) | **GET** /api/v1/sessions/{sessionId} | Get a Session by its ID |
+| [**list_sessions**](SessionsApi.md#list_sessions) | **GET** /api/v1/sessions | List Sessions created by your account |
+| [**redact_session**](SessionsApi.md#redact_session) | **POST** /api/v1/sessions/{sessionId}/redact | Redact a Session, removing all identity data from Trinsic's servers.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted. |
+
+
+## cancel_session
+
+> <CancelSessionResponse> cancel_session(session_id)
+
+Cancel a Session by its ID
+
+### 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::SessionsApi.new
+session_id = 'session_id_example' # String | 
+
+begin
+  # Cancel a Session by its ID
+  result = api_instance.cancel_session(session_id)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->cancel_session: #{e}"
+end
+```
+
+#### Using the cancel_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CancelSessionResponse>, Integer, Hash)> cancel_session_with_http_info(session_id)
+
+```ruby
+begin
+  # Cancel a Session by its ID
+  data, status_code, headers = api_instance.cancel_session_with_http_info(session_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CancelSessionResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->cancel_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** |  |  |
+
+### Return type
+
+[**CancelSessionResponse**](CancelSessionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json
+
+
+## create_session
+
+> <CreateSessionResponse> create_session(opts)
+
+Create a Session to verify a user's identity
+
+### 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::SessionsApi.new
+opts = {
+  create_session_request: TrinsicApi::CreateSessionRequest.new # CreateSessionRequest | 
+}
+
+begin
+  # Create a Session to verify a user's identity
+  result = api_instance.create_session(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->create_session: #{e}"
+end
+```
+
+#### Using the create_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSessionResponse>, Integer, Hash)> create_session_with_http_info(opts)
+
+```ruby
+begin
+  # Create a Session to verify a user's identity
+  data, status_code, headers = api_instance.create_session_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSessionResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->create_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_session_request** | [**CreateSessionRequest**](CreateSessionRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateSessionResponse**](CreateSessionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json, application/*+json
+- **Accept**: text/plain, application/json, text/json
+
+
+## exchange_results_key
+
+> <ExchangeResultsKeyResponse> exchange_results_key(session_id, opts)
+
+Exchange a Results Access Key for Identity Data
+
+### 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::SessionsApi.new
+session_id = 'session_id_example' # String | 
+opts = {
+  exchange_results_key_request: TrinsicApi::ExchangeResultsKeyRequest.new({results_access_key: 'results_access_key_example'}) # ExchangeResultsKeyRequest | 
+}
+
+begin
+  # Exchange a Results Access Key for Identity Data
+  result = api_instance.exchange_results_key(session_id, opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->exchange_results_key: #{e}"
+end
+```
+
+#### Using the exchange_results_key_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ExchangeResultsKeyResponse>, Integer, Hash)> exchange_results_key_with_http_info(session_id, opts)
+
+```ruby
+begin
+  # Exchange a Results Access Key for Identity Data
+  data, status_code, headers = api_instance.exchange_results_key_with_http_info(session_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ExchangeResultsKeyResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->exchange_results_key_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** |  |  |
+| **exchange_results_key_request** | [**ExchangeResultsKeyRequest**](ExchangeResultsKeyRequest.md) |  | [optional] |
+
+### Return type
+
+[**ExchangeResultsKeyResponse**](ExchangeResultsKeyResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, text/json, application/*+json
+- **Accept**: text/plain, application/json, text/json
+
+
+## get_session
+
+> <GetSessionResponse> get_session(session_id)
+
+Get a Session by its ID
+
+### 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::SessionsApi.new
+session_id = 'session_id_example' # String | 
+
+begin
+  # Get a Session by its ID
+  result = api_instance.get_session(session_id)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->get_session: #{e}"
+end
+```
+
+#### Using the get_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetSessionResponse>, Integer, Hash)> get_session_with_http_info(session_id)
+
+```ruby
+begin
+  # Get a Session by its ID
+  data, status_code, headers = api_instance.get_session_with_http_info(session_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetSessionResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->get_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** |  |  |
+
+### Return type
+
+[**GetSessionResponse**](GetSessionResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json
+
+
+## list_sessions
+
+> <ListSessionsResponse> list_sessions(opts)
+
+List Sessions created by your account
+
+### 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::SessionsApi.new
+opts = {
+  order_by: TrinsicApi::SessionOrdering::CREATED, # SessionOrdering | The field by which sessions should be ordered
+  order_direction: TrinsicApi::OrderDirection::ASCENDING, # OrderDirection | 
+  page_size: 50, # Integer | The number of items to return per page -- must be between `1` and `50`
+  page: 1 # Integer | The page number to return -- starts at `1`
+}
+
+begin
+  # List Sessions created by your account
+  result = api_instance.list_sessions(opts)
+  p result
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->list_sessions: #{e}"
+end
+```
+
+#### Using the list_sessions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListSessionsResponse>, Integer, Hash)> list_sessions_with_http_info(opts)
+
+```ruby
+begin
+  # List Sessions created by your account
+  data, status_code, headers = api_instance.list_sessions_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListSessionsResponse>
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->list_sessions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_by** | [**SessionOrdering**](.md) | The field by which sessions should be ordered | [optional] |
+| **order_direction** | [**OrderDirection**](.md) |  | [optional] |
+| **page_size** | **Integer** | The number of items to return per page -- must be between &#x60;1&#x60; and &#x60;50&#x60; | [optional] |
+| **page** | **Integer** | The page number to return -- starts at &#x60;1&#x60; | [optional] |
+
+### Return type
+
+[**ListSessionsResponse**](ListSessionsResponse.md)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: text/plain, application/json, text/json
+
+
+## redact_session
+
+> redact_session(session_id)
+
+Redact a Session, removing all identity data from Trinsic's servers.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
+
+### 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::SessionsApi.new
+session_id = 'session_id_example' # String | 
+
+begin
+  # Redact a Session, removing all identity data from Trinsic's servers.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
+  api_instance.redact_session(session_id)
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->redact_session: #{e}"
+end
+```
+
+#### Using the redact_session_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)> redact_session_with_http_info(session_id)
+
+```ruby
+begin
+  # Redact a Session, removing all identity data from Trinsic's servers.                Identity data that a user has chosen to save in their passkey-protected wallet will not be deleted.
+  data, status_code, headers = api_instance.redact_session_with_http_info(session_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TrinsicApi::ApiError => e
+  puts "Error when calling SessionsApi->redact_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ValidationResult.md

@@ -0,0 +1,20 @@
+# TrinsicApi::ValidationResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **member_names** | **Array<String>** |  | [readonly] |
+| **error_message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::ValidationResult.new(
+  member_names: null,
+  error_message: null
+)
+```
+

data/docs/Verification.md

@@ -0,0 +1,20 @@
+# TrinsicApi::Verification
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | The identity provider that was used to perform the Verification, if any | [optional] |
+| **fail_code** | [**VerificationFailCode**](VerificationFailCode.md) | If the Verification is in state `VerificationFailed`, this field contains the reason for failure | [optional] |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::Verification.new(
+  provider: null,
+  fail_code: null
+)
+```
+

data/docs/VerificationFailCode.md

@@ -0,0 +1,15 @@
+# TrinsicApi::VerificationFailCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'trinsic_api'
+
+instance = TrinsicApi::VerificationFailCode.new()
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/lib/trinsic_api/api/attachments_api.rb

@@ -0,0 +1,84 @@
+=begin
+#Connect API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.7.0
+
+=end
+
+require 'cgi'
+
+module TrinsicApi
+  class AttachmentsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # 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 202 code, and you should try again later.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ExchangeAttachmentAccessKeyRequest] :exchange_attachment_access_key_request 
+    # @return [nil]
+    def exchange_attachment_access_key(opts = {})
+      exchange_attachment_access_key_with_http_info(opts)
+      nil
+    end
+
+    # 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 202 code, and you should try again later.
+    # @param [Hash] opts the optional parameters
+    # @option opts [ExchangeAttachmentAccessKeyRequest] :exchange_attachment_access_key_request 
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def exchange_attachment_access_key_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AttachmentsApi.exchange_attachment_access_key ...'
+      end
+      # resource path
+      local_var_path = '/api/v1/attachments/exchange'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'text/json', 'application/*+json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'exchange_attachment_access_key_request'])
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Bearer']
+
+      new_options = opts.merge(
+        :operation => :"AttachmentsApi.exchange_attachment_access_key",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AttachmentsApi#exchange_attachment_access_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end