unit_openapi_ruby_sdk

UnitOpenapiRubySdk - the Ruby gem for the Unit OpenAPI specifications

An OpenAPI specifications for unit-sdk clients

This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.2.0
Package version: 0.1.0
Generator version: 7.9.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build unit_openapi_ruby_sdk.gemspec

Then either install the gem locally:

gem install ./unit_openapi_ruby_sdk-0.1.0.gem

(for development, run gem install --dev ./unit_openapi_ruby_sdk-0.1.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 'unit_openapi_ruby_sdk', '~> 0.1.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 'unit_openapi_ruby_sdk', :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 'unit_openapi_ruby_sdk'

# Setup authorization
UnitOpenapiRubySdk.configure do |config|
  # Configure Bearer authorization (JWT): bearerAuth
  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 = UnitOpenapiRubySdk::UnitApi.new
card_id = 'card_id_example' # String | ID of the card to activate

begin
  #Create Atm Deposit Simulation
  api_instance.activate_card_simulation(card_id)
rescue UnitOpenapiRubySdk::ApiError => e
  puts "Exception when calling UnitApi->activate_card_simulation: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.s.unit.sh

Class	Method	HTTP request	Description
UnitOpenapiRubySdk::UnitApi	activate_card_simulation	POST /sandbox/cards/cardId/activate	Create Atm Deposit Simulation
UnitOpenapiRubySdk::UnitApi	activate_control_agreement_for_account	POST /accounts/accountId/activate-daca	Activate Account Control Agreement by Id
UnitOpenapiRubySdk::UnitApi	add_account_owners	POST /accounts/accountId/relationships/customers	Add Owners to Account by Id
UnitOpenapiRubySdk::UnitApi	add_authorized_users	POST /customers/customerId/authorized-users	Add Authorized Users by Id
UnitOpenapiRubySdk::UnitApi	advance_received_payment	POST /received-payments/paymentId/advance	Advance Received Payment by Id
UnitOpenapiRubySdk::UnitApi	approve_authorization_request	POST /authorization-requests/authorizationId/approve	Approve Authorization Request by Id
UnitOpenapiRubySdk::UnitApi	approve_check_payment	POST /check-payments/checkPaymentId/approve	Approve Check Payment by Id
UnitOpenapiRubySdk::UnitApi	archive_customer	POST /customers/customerId/archive	Archive Customer by Id
UnitOpenapiRubySdk::UnitApi	cancel_application	POST /applications/applicationId/cancel	Cancel Application by Id
UnitOpenapiRubySdk::UnitApi	cancel_check_payment	POST /check-payments/checkPaymentId/cancel	Cancel Check Payment by Id
UnitOpenapiRubySdk::UnitApi	cancel_payment	POST /payments/paymentId/cancel	Cancel a Payment by Id
UnitOpenapiRubySdk::UnitApi	close_account	POST /accounts/accountId/close	Close an Account by Id
UnitOpenapiRubySdk::UnitApi	close_card	POST /cards/cardId/close	Close a Card
UnitOpenapiRubySdk::UnitApi	confirm_check_deposit	POST /check-deposits/checkDepositId/confirm	Confirm by Id
UnitOpenapiRubySdk::UnitApi	create_account	POST /accounts	Create Account
UnitOpenapiRubySdk::UnitApi	create_ach_received_payment_transaction_simulation	POST /sandbox/received-payments	Create ACH Received Payment Transaction Simulation
UnitOpenapiRubySdk::UnitApi	create_api_token	POST /users/userId/api-tokens	Create Org API Token
UnitOpenapiRubySdk::UnitApi	create_application	POST /applications	Create Application
UnitOpenapiRubySdk::UnitApi	create_application_document	POST /applications/applicationId/documents	Create an application document
UnitOpenapiRubySdk::UnitApi	create_application_form	POST /application-forms	Create Application Form
UnitOpenapiRubySdk::UnitApi	create_atm_deposit_simulation	POST /sandbox/atm-deposits	Create Atm Deposit Simulation
UnitOpenapiRubySdk::UnitApi	create_card	POST /cards	Create a Card
UnitOpenapiRubySdk::UnitApi	create_check_deposit	POST /check-deposits	Create Check Deposit
UnitOpenapiRubySdk::UnitApi	create_check_payment	POST /check-payments	Create Check Payment
UnitOpenapiRubySdk::UnitApi	create_counterparty	POST /counterparties	Create Counterparty
UnitOpenapiRubySdk::UnitApi	create_customer_token	POST /customers/customerId/token	Create Customer Token
UnitOpenapiRubySdk::UnitApi	create_customer_token_verification	POST /customers/customerId/token/verification	Create Customer Token Verification
UnitOpenapiRubySdk::UnitApi	create_fee	POST /fees	Create Fee
UnitOpenapiRubySdk::UnitApi	create_incoming_ach_payment_simulation	POST /sandbox/received-ach-payment	Create Incoming ACH Payment Simulation
UnitOpenapiRubySdk::UnitApi	create_payment	POST /payments	Create a Payment
UnitOpenapiRubySdk::UnitApi	create_recurring_payment	POST /recurring-payments	Create Recurring Payment
UnitOpenapiRubySdk::UnitApi	create_recurring_repayment	POST /recurring-repayments	Create a Recurring Repayment
UnitOpenapiRubySdk::UnitApi	create_repayment	POST /repayments	Create a Repayment
UnitOpenapiRubySdk::UnitApi	create_reward	POST /rewards	Create Reward
UnitOpenapiRubySdk::UnitApi	create_stop_payment	POST /stop-payments	Create Stop Payment
UnitOpenapiRubySdk::UnitApi	create_webhook	POST /webhooks	Create Webhook
UnitOpenapiRubySdk::UnitApi	deactivate_control_agreement_for_account	POST /accounts/accountId/deactivate-daca	Deactivate Account Control Agreement by Id
UnitOpenapiRubySdk::UnitApi	decline_authorization_request	POST /authorization-requests/authorizationId/decline	Decline Authorization Request
UnitOpenapiRubySdk::UnitApi	delete_counterparty	DELETE /counterparties/counterpartyId	Delete Counterparty by Id
UnitOpenapiRubySdk::UnitApi	delete_token	DELETE /users/userId/api-tokens/tokenId	Get Reward by Id
UnitOpenapiRubySdk::UnitApi	disable_recurring_payment	POST /recurring-payments/paymentId/disable	Disable Recurring Payment
UnitOpenapiRubySdk::UnitApi	disable_recurring_repayment	POST /recurring-repayments/recurringRepaymentId/disable	Disable Recurring Repayment by Id
UnitOpenapiRubySdk::UnitApi	disable_stop_payment	POST /stop-payments/stopPaymentId/disable	Disable a stop payment
UnitOpenapiRubySdk::UnitApi	disable_webhook	POST /webhooks/webhookId/disable	Disable a Webhook
UnitOpenapiRubySdk::UnitApi	download_application_back_side_document	GET /applications/applicationId/documents/documentId/download/back	Download a Document - Back Side
UnitOpenapiRubySdk::UnitApi	download_application_document	GET /applications/applicationId/documents/documentId/download	Download a Document
UnitOpenapiRubySdk::UnitApi	enable_recurring_payment	POST /recurring-payments/paymentId/enable	Enable Recurring Payment
UnitOpenapiRubySdk::UnitApi	enable_recurring_repayment	POST /recurring-repayments/recurringRepaymentId/enable	Enable Recurring Repayment by Id
UnitOpenapiRubySdk::UnitApi	enable_webhook	POST /webhooks/webhookId/enable	Enable Webhook
UnitOpenapiRubySdk::UnitApi	enter_control_agreement_for_account	POST /accounts/accountId/enter-daca	Enter Account Control Agreement by Id
UnitOpenapiRubySdk::UnitApi	fire_event	POST /events/eventId	Fire Event by Id
UnitOpenapiRubySdk::UnitApi	freeze_account	POST /accounts/accountId/freeze	Freeze Account by Id
UnitOpenapiRubySdk::UnitApi	freeze_card	POST /cards/cardId/freeze	Freeze a Card
UnitOpenapiRubySdk::UnitApi	generate_barcode	POST /cash-deposits/barcodes	Generate Cash Deposit Barcode
UnitOpenapiRubySdk::UnitApi	get_account	GET /accounts/accountId	Get Account by Id
UnitOpenapiRubySdk::UnitApi	get_account_balance_history	GET /account-end-of-day	Get Account Balance History
UnitOpenapiRubySdk::UnitApi	get_account_limits	GET /accounts/accountId/limits	Get Account Limits by Id
UnitOpenapiRubySdk::UnitApi	get_accounts_list	GET /accounts	Get List Accounts
UnitOpenapiRubySdk::UnitApi	get_api_tokens_list	GET /users/userId/api-tokens	Get List Org API Tokens
UnitOpenapiRubySdk::UnitApi	get_application	GET /applications/applicationId	Get Application by Id
UnitOpenapiRubySdk::UnitApi	get_application_documents	GET /applications/applicationId/documents	Get List of Documents
UnitOpenapiRubySdk::UnitApi	get_application_form	GET /application-forms/applicationFormId	Get ApplicationForm by Id
UnitOpenapiRubySdk::UnitApi	get_application_forms_list	GET /application-forms	Get List Application Forms
UnitOpenapiRubySdk::UnitApi	get_applications_list	GET /applications	Get List Application
UnitOpenapiRubySdk::UnitApi	get_atm_locations_list	GET /atm-locations	Get List of ATM Locations
UnitOpenapiRubySdk::UnitApi	get_authorization	GET /authorizations/authorizationId	Get Authorization by Id
UnitOpenapiRubySdk::UnitApi	get_authorization_request	GET /authorization-requests/authorizationId	Get Authorization Request by Id
UnitOpenapiRubySdk::UnitApi	get_authorization_requests_list	GET /authorization-requests	Get List Authorization Requests
UnitOpenapiRubySdk::UnitApi	get_authorizations_list	GET /authorizations	Get List authorizations
UnitOpenapiRubySdk::UnitApi	get_back_check_deposit	GET /check-deposits/checkDepositId/back	Get Back Check Deposit Image by Id
UnitOpenapiRubySdk::UnitApi	get_barcode_image	GET /cash-deposits/barcodes/barcodeNumber/image	Get Barcode Image By Barcode Number
UnitOpenapiRubySdk::UnitApi	get_card	GET /cards/cardId	Get Card by Id
UnitOpenapiRubySdk::UnitApi	get_card_limits	GET /cards/cardId/limits	Get Card Limit by Id
UnitOpenapiRubySdk::UnitApi	get_card_pin_status	GET /cards/cardId/secure-data/pin/status	Get Card PIN Status
UnitOpenapiRubySdk::UnitApi	get_cards_list	GET /cards	Get List of Cards
UnitOpenapiRubySdk::UnitApi	get_cash_deposit_store_locations_list	GET /store-locations	Get Cash Deposit Store Locations List By Coordinates
UnitOpenapiRubySdk::UnitApi	get_check_deposit	GET /check-deposits/checkDepositId	Get Check Deposit by Id
UnitOpenapiRubySdk::UnitApi	get_check_deposits_list	GET /check-deposits	Get List Check Deposits
UnitOpenapiRubySdk::UnitApi	get_check_payment	GET /check-payments/checkPaymentId	Get Check Payment by Id
UnitOpenapiRubySdk::UnitApi	get_check_payment_back	GET /check-payments/checkPaymentId/back	Get back image
UnitOpenapiRubySdk::UnitApi	get_check_payment_front	GET /check-payments/checkPaymentId/front	Get front image
UnitOpenapiRubySdk::UnitApi	get_check_payments_list	GET /check-payments	Get List Check Payments
UnitOpenapiRubySdk::UnitApi	get_counterparties_list	GET /counterparties	Get Counterparties List
UnitOpenapiRubySdk::UnitApi	get_counterparty	GET /counterparties/counterpartyId	Get Counterparty by Id
UnitOpenapiRubySdk::UnitApi	get_counterparty_balance	GET /counterparties/counterpartyId/balance	Get Counterparty Balance
UnitOpenapiRubySdk::UnitApi	get_customer	GET /customers/customerId	Get Customer by Id
UnitOpenapiRubySdk::UnitApi	get_customers_list	GET /customers	Get Customers List
UnitOpenapiRubySdk::UnitApi	get_deposit_products_list	GET /accounts/accountId/deposit-products	Get Deposit Products
UnitOpenapiRubySdk::UnitApi	get_dispute	GET /disputes/disputeId	Get Dispute by Id
UnitOpenapiRubySdk::UnitApi	get_disputes_list	GET /disputes	Get List Disputes
UnitOpenapiRubySdk::UnitApi	get_event	GET /events/eventId	Get Event by Id
UnitOpenapiRubySdk::UnitApi	get_events_list	GET /events	Get Events List
UnitOpenapiRubySdk::UnitApi	get_front_check_deposit	GET /check-deposits/checkDepositId/front	Get Front Check Deposit Image by Id
UnitOpenapiRubySdk::UnitApi	get_institution	GET /institutions/routingNumber	Get Institution by Routing Number
UnitOpenapiRubySdk::UnitApi	get_payment	GET /payments/paymentId	Get Payment by Id
UnitOpenapiRubySdk::UnitApi	get_payments_list	GET /payments	Get List Payments
UnitOpenapiRubySdk::UnitApi	get_received_payment	GET /received-payments/paymentId	Get Received Payment by Id
UnitOpenapiRubySdk::UnitApi	get_received_payments_list	GET /received-payments	Get Received Payments List
UnitOpenapiRubySdk::UnitApi	get_recurring_payment	GET /recurring-payments/paymentId	Get Recurring Payment
UnitOpenapiRubySdk::UnitApi	get_recurring_payments_list	GET /recurring-payments	Get Recurring Payments List
UnitOpenapiRubySdk::UnitApi	get_recurring_repayment	GET /recurring-repayments/recurringRepaymentId	Get Recurring Repayment by Id
UnitOpenapiRubySdk::UnitApi	get_recurring_repayments_list	GET /recurring-repayments	Get List Recurring Repayments
UnitOpenapiRubySdk::UnitApi	get_repayment	GET /repayments/repaymentId	Get Repayment by Id
UnitOpenapiRubySdk::UnitApi	get_repayment_information	GET /accounts/accountId/repayment-information	Get Repayment Information
UnitOpenapiRubySdk::UnitApi	get_repayments_list	GET /repayments	Get List Repayments
UnitOpenapiRubySdk::UnitApi	get_reward	GET /rewards/rewardId	Get Reward by Id
UnitOpenapiRubySdk::UnitApi	get_rewards_list	GET /rewards	Get Rewards List
UnitOpenapiRubySdk::UnitApi	get_statement_bank_pdf	GET /statements/accountId/bank/pdf	Get Bank verification PDF
UnitOpenapiRubySdk::UnitApi	get_statement_html	GET /statements/statementId/html	Get HTML Statement by Id
UnitOpenapiRubySdk::UnitApi	get_statement_pdf	GET /statements/statementId/pdf	Get PDF Statement by Id
UnitOpenapiRubySdk::UnitApi	get_statements_list	GET /statements	Get List Statements
UnitOpenapiRubySdk::UnitApi	get_stop_payment	GET /stop-payments/stopPaymentId	Get details of a specific stop payment
UnitOpenapiRubySdk::UnitApi	get_stop_payments_list	GET /stop-payments	Get a list of stop payments
UnitOpenapiRubySdk::UnitApi	get_tax_form	GET /tax-forms/taxFormId	Get Tax Form by Id
UnitOpenapiRubySdk::UnitApi	get_tax_form_pdf	GET /tax-forms/taxFormId/pdf	Get Tax Form pdf by Id
UnitOpenapiRubySdk::UnitApi	get_tax_forms_list	GET /tax-forms	Get Tax Forms List
UnitOpenapiRubySdk::UnitApi	get_transaction	GET /accounts/accountId/transactions/transactionId	Get Transaction by Id
UnitOpenapiRubySdk::UnitApi	get_transactions_list	GET /transactions	Get List Transactions
UnitOpenapiRubySdk::UnitApi	get_webhook	GET /webhooks/webhookId	Get Webhook Id
UnitOpenapiRubySdk::UnitApi	get_webhooks_list	GET /webhooks	Get List Webhooks
UnitOpenapiRubySdk::UnitApi	received_payments_payment_id_patch	PATCH /received-payments/paymentId	Update Received Payment
UnitOpenapiRubySdk::UnitApi	remove_account_owners	DELETE /accounts/accountId/relationships/customers	Remove Owners from Account by Id
UnitOpenapiRubySdk::UnitApi	remove_authorized_users	DELETE /customers/customerId/authorized-users	Remove Authorized Users by Id
UnitOpenapiRubySdk::UnitApi	reopen_account	POST /accounts/accountId/reopen	Reopen an Account by Id
UnitOpenapiRubySdk::UnitApi	replace_card	POST /cards/cardId/replace	Replace a Card
UnitOpenapiRubySdk::UnitApi	report_card_as_lost	POST /cards/cardId/report-lost	Report lost as stolen
UnitOpenapiRubySdk::UnitApi	report_card_as_stolen	POST /cards/cardId/report-stolen	Report card as stolen
UnitOpenapiRubySdk::UnitApi	reprocess_received_payment	POST /received-payments/paymentId/reprocess	Reprocess Received Payment by Id
UnitOpenapiRubySdk::UnitApi	return_check_payment	POST /check-payments/checkPaymentId/return	Return Check Payment by Id
UnitOpenapiRubySdk::UnitApi	return_received_ach_transaction	POST /returns/transactionId	Return Received ACH Transaction
UnitOpenapiRubySdk::UnitApi	reverse_fee	POST /fees/reverse	Reverse Fee
UnitOpenapiRubySdk::UnitApi	unfreeze_account	POST /accounts/accountId/unfreeze	Unfreeze Account by Id
UnitOpenapiRubySdk::UnitApi	unfreeze_card	POST /cards/cardId/unfreeze	Unfreeze a Card
UnitOpenapiRubySdk::UnitApi	update_account	PATCH /accounts/accountId	Update Account
UnitOpenapiRubySdk::UnitApi	update_application	PATCH /applications/applicationId	Update Application
UnitOpenapiRubySdk::UnitApi	update_business_beneficial_owner	PATCH /beneficial-owner/beneficialOwnerId	Update a Business Beneficial Owner via API
UnitOpenapiRubySdk::UnitApi	update_card	PATCH /cards/cardId	Update Card
UnitOpenapiRubySdk::UnitApi	update_check_deposit	PATCH /check-deposits/checkDepositId	Update Check Deposit
UnitOpenapiRubySdk::UnitApi	update_counterparty	PATCH /counterparties/counterpartyId	Update Counterparty
UnitOpenapiRubySdk::UnitApi	update_customer	PATCH /customers/customerId	Update Customer
UnitOpenapiRubySdk::UnitApi	update_payment	PATCH /payments/paymentId	Update Payment
UnitOpenapiRubySdk::UnitApi	update_stop_payment	POST /stop-payments/stopPaymentId	Update a stop payment
UnitOpenapiRubySdk::UnitApi	update_transaction	PATCH /accounts/accountId/transactions/transactionId	Update Transaction
UnitOpenapiRubySdk::UnitApi	update_webhook	PATCH /webhooks/webhookId	Update Webhook
UnitOpenapiRubySdk::UnitApi	upload_application_document_file	PUT /applications/applicationId/documents/documentId/multipart	Upload an application document file. Supports PDF, PNG and JPG files
UnitOpenapiRubySdk::UnitApi	upload_application_document_file_back_side	PUT /applications/applicationId/documents/documentId/back/multipart	Upload an application document file - Back Side. Supports PDF, PNG and JPG files
UnitOpenapiRubySdk::UnitApi	verify_application_document	PUT /applications/applicationId/documents/documentId/verify	Verify a document