checkbook 1.0.1

data/lib/checkbook/api/invoice.rb

@@ -0,0 +1,452 @@
+=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 Invoice
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Void an invoice
+    # Cancel the specified invoice
+    # @param invoice_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_invoice(invoice_id, opts = {})
+      delete_invoice_with_http_info(invoice_id, opts)
+      nil
+    end
+
+    # Void an invoice
+    # Cancel the specified invoice
+    # @param invoice_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_invoice_with_http_info(invoice_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Invoice.delete_invoice ...'
+      end
+      # verify the required parameter 'invoice_id' is set
+      if @api_client.config.client_side_validation && invoice_id.nil?
+        fail ArgumentError, "Missing the required parameter 'invoice_id' when calling Invoice.delete_invoice"
+      end
+      # resource path
+      local_var_path = '/v3/invoice/{invoice_id}'.sub('{' + 'invoice_id' + '}', CGI.escape(invoice_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 => :"Invoice.delete_invoice",
+        :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: Invoice#delete_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get invoice
+    # Get the specified invoice
+    # @param invoice_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetInvoiceResponse]
+    def get_invoice(invoice_id, opts = {})
+      data, _status_code, _headers = get_invoice_with_http_info(invoice_id, opts)
+      data
+    end
+
+    # Get invoice
+    # Get the specified invoice
+    # @param invoice_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetInvoiceResponse, Integer, Hash)>] GetInvoiceResponse data, response status code and response headers
+    def get_invoice_with_http_info(invoice_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Invoice.get_invoice ...'
+      end
+      # verify the required parameter 'invoice_id' is set
+      if @api_client.config.client_side_validation && invoice_id.nil?
+        fail ArgumentError, "Missing the required parameter 'invoice_id' when calling Invoice.get_invoice"
+      end
+      # resource path
+      local_var_path = '/v3/invoice/{invoice_id}'.sub('{' + 'invoice_id' + '}', CGI.escape(invoice_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] || 'GetInvoiceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Invoice.get_invoice",
+        :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: Invoice#get_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get attachment for an invoice
+    # Get the attachment for an invoice
+    # @param invoice_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def get_invoice_attachment(invoice_id, opts = {})
+      data, _status_code, _headers = get_invoice_attachment_with_http_info(invoice_id, opts)
+      data
+    end
+
+    # Get attachment for an invoice
+    # Get the attachment for an invoice
+    # @param invoice_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def get_invoice_attachment_with_http_info(invoice_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Invoice.get_invoice_attachment ...'
+      end
+      # verify the required parameter 'invoice_id' is set
+      if @api_client.config.client_side_validation && invoice_id.nil?
+        fail ArgumentError, "Missing the required parameter 'invoice_id' when calling Invoice.get_invoice_attachment"
+      end
+      # resource path
+      local_var_path = '/v3/invoice/{invoice_id}/attachment'.sub('{' + 'invoice_id' + '}', CGI.escape(invoice_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/pdf', '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] || 'File'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Invoice.get_invoice_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: Invoice#get_invoice_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get sent/received invoices
+    # Get sent/received invoices
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :direction Direction
+    # @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 [String] :sort Sort
+    # @option opts [Date] :start_date Start date
+    # @option opts [String] :status Status
+    # @return [GetInvoicesResponse]
+    def get_invoices(opts = {})
+      data, _status_code, _headers = get_invoices_with_http_info(opts)
+      data
+    end
+
+    # Get sent/received invoices
+    # Get sent/received invoices
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :direction Direction
+    # @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 [String] :sort Sort
+    # @option opts [Date] :start_date Start date
+    # @option opts [String] :status Status
+    # @return [Array<(GetInvoicesResponse, Integer, Hash)>] GetInvoicesResponse data, response status code and response headers
+    def get_invoices_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Invoice.get_invoices ...'
+      end
+      allowable_values = ["INCOMING", "OUTGOING"]
+      if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
+        fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling Invoice.get_invoices, 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 Invoice.get_invoices, the character length must be smaller than or equal to 180.'
+      end
+
+      allowable_values = ["+NUMBER", "-NUMBER", "+TYPE", "-TYPE", "+AMOUNT", "-AMOUNT", "+STATUS", "-STATUS", "+DATE", "-DATE", "+UPDATE", "-UPDATE", "+DESCRIPTION", "-DESCRIPTION"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      allowable_values = ["PAID", "IN_PROCESS", "UNPAID", "VOID", "EXPIRED", "PRINTED", "MAILED", "FAILED", "REFUNDED"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v3/invoice'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
+      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[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].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] || 'GetInvoicesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Invoice.get_invoices",
+        :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: Invoice#get_invoices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create an invoice
+    # Create a new invoice
+    # @param create_invoice_request [CreateInvoiceRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateInvoiceResponse]
+    def post_invoice(create_invoice_request, opts = {})
+      data, _status_code, _headers = post_invoice_with_http_info(create_invoice_request, opts)
+      data
+    end
+
+    # Create an invoice
+    # Create a new invoice
+    # @param create_invoice_request [CreateInvoiceRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateInvoiceResponse, Integer, Hash)>] CreateInvoiceResponse data, response status code and response headers
+    def post_invoice_with_http_info(create_invoice_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Invoice.post_invoice ...'
+      end
+      # verify the required parameter 'create_invoice_request' is set
+      if @api_client.config.client_side_validation && create_invoice_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_invoice_request' when calling Invoice.post_invoice"
+      end
+      # resource path
+      local_var_path = '/v3/invoice'
+
+      # 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_invoice_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateInvoiceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Invoice.post_invoice",
+        :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: Invoice#post_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Pay an invoice
+    # Pay an outstanding invoice
+    # @param pay_invoice_request [PayInvoiceRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PayInvoiceResponse]
+    def post_invoice_payment(pay_invoice_request, opts = {})
+      data, _status_code, _headers = post_invoice_payment_with_http_info(pay_invoice_request, opts)
+      data
+    end
+
+    # Pay an invoice
+    # Pay an outstanding invoice
+    # @param pay_invoice_request [PayInvoiceRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayInvoiceResponse, Integer, Hash)>] PayInvoiceResponse data, response status code and response headers
+    def post_invoice_payment_with_http_info(pay_invoice_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Invoice.post_invoice_payment ...'
+      end
+      # verify the required parameter 'pay_invoice_request' is set
+      if @api_client.config.client_side_validation && pay_invoice_request.nil?
+        fail ArgumentError, "Missing the required parameter 'pay_invoice_request' when calling Invoice.post_invoice_payment"
+      end
+      # resource path
+      local_var_path = '/v3/invoice/payment'
+
+      # 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(pay_invoice_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayInvoiceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Invoice.post_invoice_payment",
+        :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: Invoice#post_invoice_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end