checkbook 1.0.1

data/lib/checkbook/api/bank.rb

@@ -0,0 +1,613 @@
+=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 'cgi'
+
+module Checkbook
+  class Bank
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Remove bank account
+    # Remove the specified bank account
+    # @param bank_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_bank(bank_id, opts = {})
+      delete_bank_with_http_info(bank_id, opts)
+      nil
+    end
+
+    # Remove bank account
+    # Remove the specified bank account
+    # @param bank_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_bank_with_http_info(bank_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Bank.delete_bank ...'
+      end
+      # verify the required parameter 'bank_id' is set
+      if @api_client.config.client_side_validation && bank_id.nil?
+        fail ArgumentError, "Missing the required parameter 'bank_id' when calling Bank.delete_bank"
+      end
+      # resource path
+      local_var_path = '/v3/account/bank/{bank_id}'.sub('{' + 'bank_id' + '}', CGI.escape(bank_id.to_s))
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Bank.delete_bank",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Bank#delete_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get institutions
+    # Return a list of our supported institutions for instant account verification
+    # @param [Hash] opts the optional parameters
+    # @return [GetInstitutionsResponse]
+    def get_bank_institutions(opts = {})
+      data, _status_code, _headers = get_bank_institutions_with_http_info(opts)
+      data
+    end
+
+    # Get institutions
+    # Return a list of our supported institutions for instant account verification
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetInstitutionsResponse, Integer, Hash)>] GetInstitutionsResponse data, response status code and response headers
+    def get_bank_institutions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Bank.get_bank_institutions ...'
+      end
+      # resource path
+      local_var_path = '/v3/account/bank/institutions'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetInstitutionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Bank.get_bank_institutions",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Bank#get_bank_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get bank accounts
+    # Get the bank accounts for a user
+    # @param [Hash] opts the optional parameters
+    # @return [GetBanksResponse]
+    def get_banks(opts = {})
+      data, _status_code, _headers = get_banks_with_http_info(opts)
+      data
+    end
+
+    # Get bank accounts
+    # Get the bank accounts for a user
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetBanksResponse, Integer, Hash)>] GetBanksResponse data, response status code and response headers
+    def get_banks_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Bank.get_banks ...'
+      end
+      # resource path
+      local_var_path = '/v3/account/bank'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetBanksResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Bank.get_banks",
+        :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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Bank#get_banks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add bank account
+    # Add a new bank account
+    # @param create_bank_request [CreateBankRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateBankResponse]
+    def post_bank(create_bank_request, opts = {})
+      data, _status_code, _headers = post_bank_with_http_info(create_bank_request, opts)
+      data
+    end
+
+    # Add bank account
+    # Add a new bank account
+    # @param create_bank_request [CreateBankRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateBankResponse, Integer, Hash)>] CreateBankResponse data, response status code and response headers
+    def post_bank_with_http_info(create_bank_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Bank.post_bank ...'
+      end
+      # verify the required parameter 'create_bank_request' is set
+      if @api_client.config.client_side_validation && create_bank_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_bank_request' when calling Bank.post_bank"
+      end
+      # resource path
+      local_var_path = '/v3/account/bank'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['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(create_bank_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateBankResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Bank.post_bank",
+        :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: Bank#post_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add bank account with IAV
+    # Add a new bank account with instant account verification
+    # @param post_bank_iav_request [PostBankIavRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [IAVLoginResponse]
+    def post_bank_iav(post_bank_iav_request, opts = {})
+      data, _status_code, _headers = post_bank_iav_with_http_info(post_bank_iav_request, opts)
+      data
+    end
+
+    # Add bank account with IAV
+    # Add a new bank account with instant account verification
+    # @param post_bank_iav_request [PostBankIavRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IAVLoginResponse, Integer, Hash)>] IAVLoginResponse data, response status code and response headers
+    def post_bank_iav_with_http_info(post_bank_iav_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Bank.post_bank_iav ...'
+      end
+      # verify the required parameter 'post_bank_iav_request' is set
+      if @api_client.config.client_side_validation && post_bank_iav_request.nil?
+        fail ArgumentError, "Missing the required parameter 'post_bank_iav_request' when calling Bank.post_bank_iav"
+      end
+      # resource path
+      local_var_path = '/v3/account/bank/iav'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['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(post_bank_iav_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IAVLoginResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Bank.post_bank_iav",
+        :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: Bank#post_bank_iav\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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 [IAVPlaidRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [IAVPlaidResponse]
+    def post_bank_plaid(iav_plaid_request, opts = {})
+      data, _status_code, _headers = post_bank_plaid_with_http_info(iav_plaid_request, opts)
+      data
+    end
+
+    # Retrieve bank account with Plaid
+    # Retrieve the bank account(s) associated with the Plaid token.   &gt; [!NOTE] &gt; **Common Errors** &gt; &gt; - **&#x60;User login is required&#x60;** or **&#x60;Token Expired&#x60;**: The specified Plaid processor token has expired and a new token is required.
+    # @param iav_plaid_request [IAVPlaidRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IAVPlaidResponse, Integer, Hash)>] IAVPlaidResponse data, response status code and response headers
+    def post_bank_plaid_with_http_info(iav_plaid_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Bank.post_bank_plaid ...'
+      end
+      # verify the required parameter 'iav_plaid_request' is set
+      if @api_client.config.client_side_validation && iav_plaid_request.nil?
+        fail ArgumentError, "Missing the required parameter 'iav_plaid_request' when calling Bank.post_bank_plaid"
+      end
+      # resource path
+      local_var_path = '/v3/account/bank/iav/plaid'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['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(iav_plaid_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'IAVPlaidResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Bank.post_bank_plaid",
+        :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: Bank#post_bank_plaid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Release micro-deposits
+    # Release the micro-deposits for a bank account
+    # @param bank_release_request [BankReleaseRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_bank_release(bank_release_request, opts = {})
+      post_bank_release_with_http_info(bank_release_request, opts)
+      nil
+    end
+
+    # Release micro-deposits
+    # Release the micro-deposits for a bank account
+    # @param bank_release_request [BankReleaseRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_bank_release_with_http_info(bank_release_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Bank.post_bank_release ...'
+      end
+      # verify the required parameter 'bank_release_request' is set
+      if @api_client.config.client_side_validation && bank_release_request.nil?
+        fail ArgumentError, "Missing the required parameter 'bank_release_request' when calling Bank.post_bank_release"
+      end
+      # resource path
+      local_var_path = '/v3/account/bank/release'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['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(bank_release_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Bank.post_bank_release",
+        :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: Bank#post_bank_release\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Verify micro-deposits
+    # Verify the micro-deposits for a bank account
+    # @param bank_verify_request [BankVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_bank_verify(bank_verify_request, opts = {})
+      post_bank_verify_with_http_info(bank_verify_request, opts)
+      nil
+    end
+
+    # Verify micro-deposits
+    # Verify the micro-deposits for a bank account
+    # @param bank_verify_request [BankVerifyRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_bank_verify_with_http_info(bank_verify_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Bank.post_bank_verify ...'
+      end
+      # verify the required parameter 'bank_verify_request' is set
+      if @api_client.config.client_side_validation && bank_verify_request.nil?
+        fail ArgumentError, "Missing the required parameter 'bank_verify_request' when calling Bank.post_bank_verify"
+      end
+      # resource path
+      local_var_path = '/v3/account/bank/verify'
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['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(bank_verify_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Bank.post_bank_verify",
+        :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: Bank#post_bank_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update bank account
+    # Update an existing bank account
+    # @param bank_id [String] 
+    # @param update_bank_request [UpdateBankRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def put_bank(bank_id, update_bank_request, opts = {})
+      put_bank_with_http_info(bank_id, update_bank_request, opts)
+      nil
+    end
+
+    # Update bank account
+    # Update an existing bank account
+    # @param bank_id [String] 
+    # @param update_bank_request [UpdateBankRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def put_bank_with_http_info(bank_id, update_bank_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Bank.put_bank ...'
+      end
+      # verify the required parameter 'bank_id' is set
+      if @api_client.config.client_side_validation && bank_id.nil?
+        fail ArgumentError, "Missing the required parameter 'bank_id' when calling Bank.put_bank"
+      end
+      # verify the required parameter 'update_bank_request' is set
+      if @api_client.config.client_side_validation && update_bank_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_bank_request' when calling Bank.put_bank"
+      end
+      # resource path
+      local_var_path = '/v3/account/bank/{bank_id}'.sub('{' + 'bank_id' + '}', CGI.escape(bank_id.to_s))
+
+      # 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']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['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(update_bank_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Bank.put_bank",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Bank#put_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end