checkbook 1.0.1

data/lib/checkbook/api/directory.rb

@@ -0,0 +1,522 @@
+=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 Directory
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a directory entry
+    # Create a new directory item
+    # @param create_directory_request [CreateDirectoryRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateDirectoryResponse]
+    def create_directory(create_directory_request, opts = {})
+      data, _status_code, _headers = create_directory_with_http_info(create_directory_request, opts)
+      data
+    end
+
+    # Create a directory entry
+    # Create a new directory item
+    # @param create_directory_request [CreateDirectoryRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateDirectoryResponse, Integer, Hash)>] CreateDirectoryResponse data, response status code and response headers
+    def create_directory_with_http_info(create_directory_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Directory.create_directory ...'
+      end
+      # verify the required parameter 'create_directory_request' is set
+      if @api_client.config.client_side_validation && create_directory_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_directory_request' when calling Directory.create_directory"
+      end
+      # resource path
+      local_var_path = '/v3/directory'
+
+      # 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_directory_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateDirectoryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Directory.create_directory",
+        :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: Directory#create_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add a bank account to a directory entry
+    # Create a new directory bank account
+    # @param directory_id [String] 
+    # @param create_directory_bank_request [CreateDirectoryBankRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateDirectoryBankResponse]
+    def create_directory_bank(directory_id, create_directory_bank_request, opts = {})
+      data, _status_code, _headers = create_directory_bank_with_http_info(directory_id, create_directory_bank_request, opts)
+      data
+    end
+
+    # Add a bank account to a directory entry
+    # Create a new directory bank account
+    # @param directory_id [String] 
+    # @param create_directory_bank_request [CreateDirectoryBankRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateDirectoryBankResponse, Integer, Hash)>] CreateDirectoryBankResponse data, response status code and response headers
+    def create_directory_bank_with_http_info(directory_id, create_directory_bank_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Directory.create_directory_bank ...'
+      end
+      # verify the required parameter 'directory_id' is set
+      if @api_client.config.client_side_validation && directory_id.nil?
+        fail ArgumentError, "Missing the required parameter 'directory_id' when calling Directory.create_directory_bank"
+      end
+      # verify the required parameter 'create_directory_bank_request' is set
+      if @api_client.config.client_side_validation && create_directory_bank_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_directory_bank_request' when calling Directory.create_directory_bank"
+      end
+      # resource path
+      local_var_path = '/v3/directory/{directory_id}/account/bank'.sub('{' + 'directory_id' + '}', CGI.escape(directory_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(create_directory_bank_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateDirectoryBankResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Directory.create_directory_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: Directory#create_directory_bank\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Add a credit/debit card to a directory entry
+    # Create a new directory card account
+    # @param directory_id [String] 
+    # @param create_directory_card_request [CreateDirectoryCardRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateDirectoryCardResponse]
+    def create_directory_card(directory_id, create_directory_card_request, opts = {})
+      data, _status_code, _headers = create_directory_card_with_http_info(directory_id, create_directory_card_request, opts)
+      data
+    end
+
+    # Add a credit/debit card to a directory entry
+    # Create a new directory card account
+    # @param directory_id [String] 
+    # @param create_directory_card_request [CreateDirectoryCardRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateDirectoryCardResponse, Integer, Hash)>] CreateDirectoryCardResponse data, response status code and response headers
+    def create_directory_card_with_http_info(directory_id, create_directory_card_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Directory.create_directory_card ...'
+      end
+      # verify the required parameter 'directory_id' is set
+      if @api_client.config.client_side_validation && directory_id.nil?
+        fail ArgumentError, "Missing the required parameter 'directory_id' when calling Directory.create_directory_card"
+      end
+      # verify the required parameter 'create_directory_card_request' is set
+      if @api_client.config.client_side_validation && create_directory_card_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_directory_card_request' when calling Directory.create_directory_card"
+      end
+      # resource path
+      local_var_path = '/v3/directory/{directory_id}/account/card'.sub('{' + 'directory_id' + '}', CGI.escape(directory_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(create_directory_card_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateDirectoryCardResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Directory.create_directory_card",
+        :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: Directory#create_directory_card\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Remove a directory entry
+    # Remove the directory item
+    # @param directory_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_directory(directory_id, opts = {})
+      delete_directory_with_http_info(directory_id, opts)
+      nil
+    end
+
+    # Remove a directory entry
+    # Remove the directory item
+    # @param directory_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_directory_with_http_info(directory_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Directory.delete_directory ...'
+      end
+      # verify the required parameter 'directory_id' is set
+      if @api_client.config.client_side_validation && directory_id.nil?
+        fail ArgumentError, "Missing the required parameter 'directory_id' when calling Directory.delete_directory"
+      end
+      # resource path
+      local_var_path = '/v3/directory/{directory_id}'.sub('{' + 'directory_id' + '}', CGI.escape(directory_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 => :"Directory.delete_directory",
+        :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: Directory#delete_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Remove a payment account from a directory entry
+    # Remove a directory account
+    # @param directory_id [String] 
+    # @param account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_directory_account(directory_id, account_id, opts = {})
+      delete_directory_account_with_http_info(directory_id, account_id, opts)
+      nil
+    end
+
+    # Remove a payment account from a directory entry
+    # Remove a directory account
+    # @param directory_id [String] 
+    # @param account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_directory_account_with_http_info(directory_id, account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Directory.delete_directory_account ...'
+      end
+      # verify the required parameter 'directory_id' is set
+      if @api_client.config.client_side_validation && directory_id.nil?
+        fail ArgumentError, "Missing the required parameter 'directory_id' when calling Directory.delete_directory_account"
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling Directory.delete_directory_account"
+      end
+      # resource path
+      local_var_path = '/v3/directory/{directory_id}/account/{account_id}'.sub('{' + 'directory_id' + '}', CGI.escape(directory_id.to_s)).sub('{' + 'account_id' + '}', CGI.escape(account_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 => :"Directory.delete_directory_account",
+        :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: Directory#delete_directory_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get directory entries
+    # Return the directory entry
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (default to 1)
+    # @option opts [Integer] :per_page Items per page (default to 50)
+    # @option opts [String] :q Query
+    # @return [GetDirectoriesResponse]
+    def get_directory(opts = {})
+      data, _status_code, _headers = get_directory_with_http_info(opts)
+      data
+    end
+
+    # Get directory entries
+    # Return the directory entry
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (default to 1)
+    # @option opts [Integer] :per_page Items per page (default to 50)
+    # @option opts [String] :q Query
+    # @return [Array<(GetDirectoriesResponse, Integer, Hash)>] GetDirectoriesResponse data, response status code and response headers
+    def get_directory_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Directory.get_directory ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling Directory.get_directory, must be greater than or equal to 1.'
+      end
+
+      allowable_values = [10, 25, 50]
+      if @api_client.config.client_side_validation && opts[:'per_page'] && !allowable_values.include?(opts[:'per_page'])
+        fail ArgumentError, "invalid value for \"per_page\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'q'].nil? && opts[:'q'].to_s.length > 180
+        fail ArgumentError, 'invalid value for "opts[:"q"]" when calling Directory.get_directory, the character length must be smaller than or equal to 180.'
+      end
+
+      # resource path
+      local_var_path = '/v3/directory'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'q'] = opts[:'q'] if !opts[:'q'].nil?
+
+      # 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] || 'GetDirectoriesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Directory.get_directory",
+        :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: Directory#get_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a directory entry
+    # Update a directory item
+    # @param directory_id [String] 
+    # @param update_directory_request [UpdateDirectoryRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def update_directory(directory_id, update_directory_request, opts = {})
+      update_directory_with_http_info(directory_id, update_directory_request, opts)
+      nil
+    end
+
+    # Update a directory entry
+    # Update a directory item
+    # @param directory_id [String] 
+    # @param update_directory_request [UpdateDirectoryRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def update_directory_with_http_info(directory_id, update_directory_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Directory.update_directory ...'
+      end
+      # verify the required parameter 'directory_id' is set
+      if @api_client.config.client_side_validation && directory_id.nil?
+        fail ArgumentError, "Missing the required parameter 'directory_id' when calling Directory.update_directory"
+      end
+      # verify the required parameter 'update_directory_request' is set
+      if @api_client.config.client_side_validation && update_directory_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_directory_request' when calling Directory.update_directory"
+      end
+      # resource path
+      local_var_path = '/v3/directory/{directory_id}'.sub('{' + 'directory_id' + '}', CGI.escape(directory_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_directory_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Directory.update_directory",
+        :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: Directory#update_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end