trinsic_api

TrinsicApi - the Ruby gem for the Connect API

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

API version: v1
Package version: 0.4.0
Generator version: 7.8.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build trinsic_api.gemspec

Then either install the gem locally:

gem install ./trinsic_api-0.4.0.gem

(for development, run gem install --dev ./trinsic_api-0.4.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'trinsic_api', '~> 0.4.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'trinsic_api', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'trinsic_api'

# Setup authorization
TrinsicApi.configure do |config|
  # Configure Bearer authorization: Bearer
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
end

api_instance = TrinsicApi::AttachmentsApi.new
opts = {
  get_attachment_request: TrinsicApi::GetAttachmentRequest.new({attachment_access_key: 'attachment_access_key_example'}) # GetAttachmentRequest | 
}

begin
  #Get Attachment
  api_instance.get_attachment(opts)
rescue TrinsicApi::ApiError => e
  puts "Exception when calling AttachmentsApi->get_attachment: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.trinsic.id

Class	Method	HTTP request	Description
TrinsicApi::AttachmentsApi	get_attachment	POST /api/v1/attachments/attachment	Get Attachment
TrinsicApi::NetworkApi	identity_lookup	GET /api/v1/network/identities/phoneNumber	Lookup Identity
TrinsicApi::NetworkApi	list_providers	GET /api/v1/network/providers	List Identity Providers
TrinsicApi::SessionsApi	cancel_session	POST /api/v1/sessions/sessionId/cancel	Cancel Session
TrinsicApi::SessionsApi	create_session	POST /api/v1/sessions	Create Session
TrinsicApi::SessionsApi	get_session	GET /api/v1/sessions/sessionId	Get Session
TrinsicApi::SessionsApi	get_session_result	POST /api/v1/sessions/sessionId/results	Get Session Results
TrinsicApi::SessionsApi	list_sessions	GET /api/v1/sessions	List Sessions
TrinsicApi::SessionsApi	redact_session	POST /api/v1/sessions/sessionId/redact	Redact Session