checkbook 1.0.1

data/lib/checkbook.rb

@@ -0,0 +1,255 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+# Common files
+require 'checkbook/api_client'
+require 'checkbook/api_error'
+require 'checkbook/api_model_base'
+require 'checkbook/version'
+require 'checkbook/configuration'
+
+# Models
+require 'checkbook/models/api_key_list_response'
+require 'checkbook/models/api_key_response'
+require 'checkbook/models/address'
+require 'checkbook/models/address_response'
+require 'checkbook/models/approval'
+require 'checkbook/models/approval_number'
+require 'checkbook/models/approval_recipient'
+require 'checkbook/models/attachment'
+require 'checkbook/models/bank'
+require 'checkbook/models/bank_release_request'
+require 'checkbook/models/bank_settings'
+require 'checkbook/models/bank_verify_request'
+require 'checkbook/models/base_checkbook_request'
+require 'checkbook/models/brand'
+require 'checkbook/models/brand_response'
+require 'checkbook/models/button'
+require 'checkbook/models/card'
+require 'checkbook/models/card_address'
+require 'checkbook/models/check'
+require 'checkbook/models/check_address'
+require 'checkbook/models/check_response'
+require 'checkbook/models/check_settings'
+require 'checkbook/models/checkbook_address'
+require 'checkbook/models/color'
+require 'checkbook/models/convert_check_request'
+require 'checkbook/models/counterparty'
+require 'checkbook/models/create_bank_request'
+require 'checkbook/models/create_bank_response'
+require 'checkbook/models/create_card_intent'
+require 'checkbook/models/create_card_intent_response'
+require 'checkbook/models/create_card_request'
+require 'checkbook/models/create_card_response'
+require 'checkbook/models/create_check_subscription_request'
+require 'checkbook/models/create_check_subscription_request_recipient'
+require 'checkbook/models/create_digital_check_request'
+require 'checkbook/models/create_digital_check_request_attachment'
+require 'checkbook/models/create_digital_check_request_number'
+require 'checkbook/models/create_digital_check_request_recipient'
+require 'checkbook/models/create_direct_check_request'
+require 'checkbook/models/create_direct_check_request_number'
+require 'checkbook/models/create_directory_bank_request'
+require 'checkbook/models/create_directory_bank_response'
+require 'checkbook/models/create_directory_card_request'
+require 'checkbook/models/create_directory_card_response'
+require 'checkbook/models/create_directory_request'
+require 'checkbook/models/create_directory_response'
+require 'checkbook/models/create_instant_check_request'
+require 'checkbook/models/create_interac_request'
+require 'checkbook/models/create_invoice_request'
+require 'checkbook/models/create_invoice_request_attachment'
+require 'checkbook/models/create_invoice_response'
+require 'checkbook/models/create_invoice_subscription_request'
+require 'checkbook/models/create_mailbox_response'
+require 'checkbook/models/create_multi_check_request'
+require 'checkbook/models/create_paypal_request'
+require 'checkbook/models/create_physical_check_request'
+require 'checkbook/models/create_physical_check_request_number'
+require 'checkbook/models/create_physical_check_request_remittance_advice'
+require 'checkbook/models/create_subscription_response'
+require 'checkbook/models/create_subscription_response_recipient'
+require 'checkbook/models/create_user_request'
+require 'checkbook/models/create_user_response'
+require 'checkbook/models/create_vcc_request'
+require 'checkbook/models/create_vcc_response'
+require 'checkbook/models/create_venmo_request'
+require 'checkbook/models/create_wallet_request'
+require 'checkbook/models/create_wallet_response'
+require 'checkbook/models/create_wire_request'
+require 'checkbook/models/csv_approval_response'
+require 'checkbook/models/csv_check_request'
+require 'checkbook/models/csv_check_response'
+require 'checkbook/models/csv_invoice_request'
+require 'checkbook/models/csv_invoice_response'
+require 'checkbook/models/csv_multi_check_request'
+require 'checkbook/models/deposit_check_request'
+require 'checkbook/models/developer'
+require 'checkbook/models/digital_recipient'
+require 'checkbook/models/directory_account'
+require 'checkbook/models/directory_address'
+require 'checkbook/models/directory_request_address'
+require 'checkbook/models/endorse_check_request'
+require 'checkbook/models/error'
+require 'checkbook/models/file_row'
+require 'checkbook/models/get_api_key_response'
+require 'checkbook/models/get_approval_response'
+require 'checkbook/models/get_approvals_response'
+require 'checkbook/models/get_banks_response'
+require 'checkbook/models/get_cards_response'
+require 'checkbook/models/get_check_deposited_response'
+require 'checkbook/models/get_check_failed_response'
+require 'checkbook/models/get_check_response'
+require 'checkbook/models/get_check_tracking_response_express'
+require 'checkbook/models/get_check_tracking_response_first_class'
+require 'checkbook/models/get_checkbook_response'
+require 'checkbook/models/get_checkbook_tracking_response_express'
+require 'checkbook/models/get_checkbook_tracking_response_first_class'
+require 'checkbook/models/get_checkbooks_response'
+require 'checkbook/models/get_checks_response'
+require 'checkbook/models/get_directories_response'
+require 'checkbook/models/get_institutions_response'
+require 'checkbook/models/get_interac_response'
+require 'checkbook/models/get_invoice_response'
+require 'checkbook/models/get_invoices_response'
+require 'checkbook/models/get_mail_response'
+require 'checkbook/models/get_mailboxes_response'
+require 'checkbook/models/get_paypal_response'
+require 'checkbook/models/get_subscription_response'
+require 'checkbook/models/get_subscriptions_response'
+require 'checkbook/models/get_user_response'
+require 'checkbook/models/get_vcc_response'
+require 'checkbook/models/get_venmo_response'
+require 'checkbook/models/get_wallets_response'
+require 'checkbook/models/get_wire_response'
+require 'checkbook/models/iav_account'
+require 'checkbook/models/iav_login_response'
+require 'checkbook/models/iav_login_schema'
+require 'checkbook/models/iavmfa_schema'
+require 'checkbook/models/iav_plaid_request'
+require 'checkbook/models/iav_plaid_response'
+require 'checkbook/models/inline_response200'
+require 'checkbook/models/institution'
+require 'checkbook/models/interac_account_response'
+require 'checkbook/models/invoice_attachment'
+require 'checkbook/models/invoice_file_row'
+require 'checkbook/models/login_field'
+require 'checkbook/models/mfa_option'
+require 'checkbook/models/mail_response'
+require 'checkbook/models/mailbox_address'
+require 'checkbook/models/merchant'
+require 'checkbook/models/merchant_response'
+require 'checkbook/models/merchant_response_address'
+require 'checkbook/models/mfa_response_field'
+require 'checkbook/models/mfa_selection_field'
+require 'checkbook/models/multi_file_row'
+require 'checkbook/models/multi_recipient'
+require 'checkbook/models/new_api_key_request'
+require 'checkbook/models/new_api_key_response'
+require 'checkbook/models/number'
+require 'checkbook/models/number140416527981344'
+require 'checkbook/models/numbers'
+require 'checkbook/models/numbers140416527982288'
+require 'checkbook/models/options'
+require 'checkbook/models/parsed_address'
+require 'checkbook/models/parsed_address_address'
+require 'checkbook/models/pay_invoice_request'
+require 'checkbook/models/pay_invoice_response'
+require 'checkbook/models/payment'
+require 'checkbook/models/paypal_account_response'
+require 'checkbook/models/physical_check_recipient'
+require 'checkbook/models/pin'
+require 'checkbook/models/plaid_account'
+require 'checkbook/models/post_bank_iav_request'
+require 'checkbook/models/preview_check_request'
+require 'checkbook/models/preview_check_request_number'
+require 'checkbook/models/preview_check_response'
+require 'checkbook/models/provision_vcc_request'
+require 'checkbook/models/provision_vcc_response'
+require 'checkbook/models/register_user_request'
+require 'checkbook/models/release_check_request'
+require 'checkbook/models/remittance_advice'
+require 'checkbook/models/signature_request'
+require 'checkbook/models/subscription_address'
+require 'checkbook/models/tracking_event'
+require 'checkbook/models/tracking_number'
+require 'checkbook/models/trigger_user_webhook_request'
+require 'checkbook/models/trigger_webhook_request'
+require 'checkbook/models/update_approval_request'
+require 'checkbook/models/update_bank_request'
+require 'checkbook/models/update_card_request'
+require 'checkbook/models/update_check_request'
+require 'checkbook/models/update_directory_address'
+require 'checkbook/models/update_directory_request'
+require 'checkbook/models/update_interac_request'
+require 'checkbook/models/update_merchant_address'
+require 'checkbook/models/update_paypal_request'
+require 'checkbook/models/update_principal_address'
+require 'checkbook/models/update_subscription_request'
+require 'checkbook/models/update_user_request'
+require 'checkbook/models/update_vcc_request'
+require 'checkbook/models/update_venmo_request'
+require 'checkbook/models/update_wallet_request'
+require 'checkbook/models/update_wire_request'
+require 'checkbook/models/user'
+require 'checkbook/models/user_query_response'
+require 'checkbook/models/user_response'
+require 'checkbook/models/user_response_query'
+require 'checkbook/models/validate_address_request'
+require 'checkbook/models/validate_address_response'
+require 'checkbook/models/vcc'
+require 'checkbook/models/vcc_address'
+require 'checkbook/models/vcc_query_response'
+require 'checkbook/models/vcc_transaction'
+require 'checkbook/models/vcc_transactions_response'
+require 'checkbook/models/venmo_account_response'
+require 'checkbook/models/verify_check_request'
+require 'checkbook/models/verify_check_response'
+require 'checkbook/models/verify_user_request'
+require 'checkbook/models/wallet'
+require 'checkbook/models/wire_account_response'
+
+# APIs
+require 'checkbook/api/approval'
+require 'checkbook/api/bank'
+require 'checkbook/api/card'
+require 'checkbook/api/checkbook'
+require 'checkbook/api/directory'
+require 'checkbook/api/interac'
+require 'checkbook/api/invoice'
+require 'checkbook/api/mailbox'
+require 'checkbook/api/payment'
+require 'checkbook/api/paypal'
+require 'checkbook/api/subscription'
+require 'checkbook/api/user'
+require 'checkbook/api/vcc'
+require 'checkbook/api/venmo'
+require 'checkbook/api/wallet'
+require 'checkbook/api/wire'
+
+module Checkbook
+  class << self
+    # Customize default settings for the SDK using block.
+    #   Checkbook.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/approval_spec.rb

@@ -0,0 +1,151 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Checkbook::Approval
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Approval' do
+  before do
+    # run before each test
+    @api_instance = Checkbook::Approval.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Approval' do
+    it 'should create an instance of Approval' do
+      expect(@api_instance).to be_instance_of(Checkbook::Approval)
+    end
+  end
+
+  # unit tests for delete_approval_check
+  # Remove payment approval
+  # Cancel the specified check approval
+  # @param approval_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_approval_check test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_approval_attachment
+  # Get attachment for payment approval
+  # Get the attachment for a payment approval
+  # @param approval_id 
+  # @param [Hash] opts the optional parameters
+  # @return [File]
+  describe 'get_approval_attachment test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_approval_check
+  # Get payment approval
+  # Get the specified payment approval
+  # @param approval_id 
+  # @param [Hash] opts the optional parameters
+  # @return [GetApprovalResponse]
+  describe 'get_approval_check test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_approval_checks
+  # Get approval payments
+  # Return approvals
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :direction Direction
+  # @option opts [Date] :end_date End date
+  # @option opts [Integer] :page Page number
+  # @option opts [Integer] :per_page Items per page
+  # @option opts [String] :q Query
+  # @option opts [String] :sort Sort
+  # @option opts [Date] :start_date Start date
+  # @option opts [String] :status Status
+  # @return [GetApprovalsResponse]
+  describe 'get_approval_checks test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_approval_digital
+  # Create approval digital payment
+  # Create a new approval digital payment
+  # @param create_digital_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [GetApprovalResponse]
+  describe 'post_approval_digital test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_approval_multi
+  # Create multi-party payment approval
+  # Create a new multi-party payment approval
+  # @param create_multi_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [GetApprovalResponse]
+  describe 'post_approval_multi test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_approval_physical
+  # Create physical check approval
+  # Create a new physical check approval
+  # @param create_physical_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [GetApprovalResponse]
+  describe 'post_approval_physical test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_approval_release
+  # Approve payment
+  # Create a live payment from an approval
+  # @param release_check_request 
+  # @param [Hash] opts the optional parameters
+  # @return [GetCheckResponse]
+  describe 'post_approval_release test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for put_approval_check
+  # Update payment approval
+  # Update the specified payment approval
+  # @param approval_id 
+  # @param update_approval_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'put_approval_check test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/bank_spec.rb

@@ -0,0 +1,142 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Checkbook::Bank
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Bank' do
+  before do
+    # run before each test
+    @api_instance = Checkbook::Bank.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Bank' do
+    it 'should create an instance of Bank' do
+      expect(@api_instance).to be_instance_of(Checkbook::Bank)
+    end
+  end
+
+  # unit tests for delete_bank
+  # Remove bank account
+  # Remove the specified bank account
+  # @param bank_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_bank test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_bank_institutions
+  # Get institutions
+  # Return a list of our supported institutions for instant account verification
+  # @param [Hash] opts the optional parameters
+  # @return [GetInstitutionsResponse]
+  describe 'get_bank_institutions test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_banks
+  # Get bank accounts
+  # Get the bank accounts for a user
+  # @param [Hash] opts the optional parameters
+  # @return [GetBanksResponse]
+  describe 'get_banks test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_bank
+  # Add bank account
+  # Add a new bank account
+  # @param create_bank_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateBankResponse]
+  describe 'post_bank test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_bank_iav
+  # Add bank account with IAV
+  # Add a new bank account with instant account verification
+  # @param post_bank_iav_request 
+  # @param [Hash] opts the optional parameters
+  # @return [IAVLoginResponse]
+  describe 'post_bank_iav test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_bank_plaid
+  # Retrieve bank account with Plaid
+  # Retrieve the bank account(s) associated with the Plaid token.   > [!NOTE] > **Common Errors** > > - **`User login is required`** or **`Token Expired`**: The specified Plaid processor token has expired and a new token is required.
+  # @param iav_plaid_request 
+  # @param [Hash] opts the optional parameters
+  # @return [IAVPlaidResponse]
+  describe 'post_bank_plaid test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_bank_release
+  # Release micro-deposits
+  # Release the micro-deposits for a bank account
+  # @param bank_release_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'post_bank_release test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_bank_verify
+  # Verify micro-deposits
+  # Verify the micro-deposits for a bank account
+  # @param bank_verify_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'post_bank_verify test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for put_bank
+  # Update bank account
+  # Update an existing bank account
+  # @param bank_id 
+  # @param update_bank_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'put_bank test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/card_spec.rb

@@ -0,0 +1,83 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for Checkbook::Card
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'Card' do
+  before do
+    # run before each test
+    @api_instance = Checkbook::Card.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of Card' do
+    it 'should create an instance of Card' do
+      expect(@api_instance).to be_instance_of(Checkbook::Card)
+    end
+  end
+
+  # unit tests for delete_card
+  # Remove card
+  # Remove the specified card
+  # @param card_id 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_card test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for get_cards
+  # Get cards
+  # Return the cards
+  # @param [Hash] opts the optional parameters
+  # @return [GetCardsResponse]
+  describe 'get_cards test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for post_card
+  # Add card
+  # Add a new card
+  # @param create_card_request 
+  # @param [Hash] opts the optional parameters
+  # @return [CreateCardResponse]
+  describe 'post_card test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for put_card
+  # Update card
+  # Update the specified card
+  # @param card_id 
+  # @param update_card_request 
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'put_card test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end