checkbook 1.0.1

data/lib/checkbook/api/mailbox.rb

@@ -0,0 +1,441 @@
+=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 Mailbox
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a mailbox
+    # Create a new mailbox
+    # @param [Hash] opts the optional parameters
+    # @return [CreateMailboxResponse]
+    def create_mailbox(opts = {})
+      data, _status_code, _headers = create_mailbox_with_http_info(opts)
+      data
+    end
+
+    # Create a mailbox
+    # Create a new mailbox
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateMailboxResponse, Integer, Hash)>] CreateMailboxResponse data, response status code and response headers
+    def create_mailbox_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Mailbox.create_mailbox ...'
+      end
+      # resource path
+      local_var_path = '/v3/mailbox'
+
+      # 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] || 'CreateMailboxResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Mailbox.create_mailbox",
+        :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: Mailbox#create_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get mailbox info
+    # Get mailbox details
+    # @param mailbox_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateMailboxResponse]
+    def get_mailbox(mailbox_id, opts = {})
+      data, _status_code, _headers = get_mailbox_with_http_info(mailbox_id, opts)
+      data
+    end
+
+    # Get mailbox info
+    # Get mailbox details
+    # @param mailbox_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateMailboxResponse, Integer, Hash)>] CreateMailboxResponse data, response status code and response headers
+    def get_mailbox_with_http_info(mailbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Mailbox.get_mailbox ...'
+      end
+      # verify the required parameter 'mailbox_id' is set
+      if @api_client.config.client_side_validation && mailbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'mailbox_id' when calling Mailbox.get_mailbox"
+      end
+      # resource path
+      local_var_path = '/v3/mailbox/{mailbox_id}'.sub('{' + 'mailbox_id' + '}', CGI.escape(mailbox_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] || 'CreateMailboxResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Mailbox.get_mailbox",
+        :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: Mailbox#get_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get mailbox item
+    # Get mailbox item
+    # @param mailbox_id [String] 
+    # @param item_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [MailResponse]
+    def get_mailbox_item(mailbox_id, item_id, opts = {})
+      data, _status_code, _headers = get_mailbox_item_with_http_info(mailbox_id, item_id, opts)
+      data
+    end
+
+    # Get mailbox item
+    # Get mailbox item
+    # @param mailbox_id [String] 
+    # @param item_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MailResponse, Integer, Hash)>] MailResponse data, response status code and response headers
+    def get_mailbox_item_with_http_info(mailbox_id, item_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Mailbox.get_mailbox_item ...'
+      end
+      # verify the required parameter 'mailbox_id' is set
+      if @api_client.config.client_side_validation && mailbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'mailbox_id' when calling Mailbox.get_mailbox_item"
+      end
+      # verify the required parameter 'item_id' is set
+      if @api_client.config.client_side_validation && item_id.nil?
+        fail ArgumentError, "Missing the required parameter 'item_id' when calling Mailbox.get_mailbox_item"
+      end
+      # resource path
+      local_var_path = '/v3/mailbox/{mailbox_id}/mail/{item_id}'.sub('{' + 'mailbox_id' + '}', CGI.escape(mailbox_id.to_s)).sub('{' + 'item_id' + '}', CGI.escape(item_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] || 'MailResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Mailbox.get_mailbox_item",
+        :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: Mailbox#get_mailbox_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get attachment for a mail piece
+    # Get mailbox item
+    # @param mailbox_id [String] 
+    # @param item_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Error]
+    def get_mailbox_item_attachment(mailbox_id, item_id, opts = {})
+      data, _status_code, _headers = get_mailbox_item_attachment_with_http_info(mailbox_id, item_id, opts)
+      data
+    end
+
+    # Get attachment for a mail piece
+    # Get mailbox item
+    # @param mailbox_id [String] 
+    # @param item_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Error, Integer, Hash)>] Error data, response status code and response headers
+    def get_mailbox_item_attachment_with_http_info(mailbox_id, item_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Mailbox.get_mailbox_item_attachment ...'
+      end
+      # verify the required parameter 'mailbox_id' is set
+      if @api_client.config.client_side_validation && mailbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'mailbox_id' when calling Mailbox.get_mailbox_item_attachment"
+      end
+      # verify the required parameter 'item_id' is set
+      if @api_client.config.client_side_validation && item_id.nil?
+        fail ArgumentError, "Missing the required parameter 'item_id' when calling Mailbox.get_mailbox_item_attachment"
+      end
+      # resource path
+      local_var_path = '/v3/mailbox/{mailbox_id}/mail/{item_id}/attachment'.sub('{' + 'mailbox_id' + '}', CGI.escape(mailbox_id.to_s)).sub('{' + 'item_id' + '}', CGI.escape(item_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] || 'Error'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Mailbox.get_mailbox_item_attachment",
+        :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: Mailbox#get_mailbox_item_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get mailboxes
+    # Return the mailboxes for the current user
+    # @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)
+    # @return [GetMailboxesResponse]
+    def query_mailbox(opts = {})
+      data, _status_code, _headers = query_mailbox_with_http_info(opts)
+      data
+    end
+
+    # Get mailboxes
+    # Return the mailboxes for the current user
+    # @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)
+    # @return [Array<(GetMailboxesResponse, Integer, Hash)>] GetMailboxesResponse data, response status code and response headers
+    def query_mailbox_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Mailbox.query_mailbox ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling Mailbox.query_mailbox, must be greater than or equal to 1.'
+      end
+
+      allowable_values = [10, 25, 50, 100, 250]
+      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
+      # resource path
+      local_var_path = '/v3/mailbox'
+
+      # 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?
+
+      # 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] || 'GetMailboxesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Mailbox.query_mailbox",
+        :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: Mailbox#query_mailbox\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get mailbox info
+    # Get mailbox items
+    # @param mailbox_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :end_date End date
+    # @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
+    # @option opts [Date] :start_date Start date
+    # @return [GetMailResponse]
+    def query_mailbox_item(mailbox_id, opts = {})
+      data, _status_code, _headers = query_mailbox_item_with_http_info(mailbox_id, opts)
+      data
+    end
+
+    # Get mailbox info
+    # Get mailbox items
+    # @param mailbox_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Date] :end_date End date
+    # @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
+    # @option opts [Date] :start_date Start date
+    # @return [Array<(GetMailResponse, Integer, Hash)>] GetMailResponse data, response status code and response headers
+    def query_mailbox_item_with_http_info(mailbox_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Mailbox.query_mailbox_item ...'
+      end
+      # verify the required parameter 'mailbox_id' is set
+      if @api_client.config.client_side_validation && mailbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'mailbox_id' when calling Mailbox.query_mailbox_item"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling Mailbox.query_mailbox_item, must be greater than or equal to 1.'
+      end
+
+      allowable_values = [10, 25, 50, 100, 250]
+      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 Mailbox.query_mailbox_item, the character length must be smaller than or equal to 180.'
+      end
+
+      # resource path
+      local_var_path = '/v3/mailbox/{mailbox_id}/mail'.sub('{' + 'mailbox_id' + '}', CGI.escape(mailbox_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
+      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?
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].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] || 'GetMailResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Mailbox.query_mailbox_item",
+        :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: Mailbox#query_mailbox_item\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end