checkbook 1.0.1

data/lib/checkbook/api/payment.rb

@@ -0,0 +1,1188 @@
+=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 Payment
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Void a payment
+    # Void the specified payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_check(check_id, opts = {})
+      delete_check_with_http_info(check_id, opts)
+      nil
+    end
+
+    # Void a payment
+    # Void the specified payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_check_with_http_info(check_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.delete_check ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.delete_check"
+      end
+      # resource path
+      local_var_path = '/v3/check/{check_id}'.sub('{' + 'check_id' + '}', CGI.escape(check_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 => :"Payment.delete_check",
+        :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: Payment#delete_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get payment
+    # Get the specified payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetCheckResponse]
+    def get_check(check_id, opts = {})
+      data, _status_code, _headers = get_check_with_http_info(check_id, opts)
+      data
+    end
+
+    # Get payment
+    # Get the specified payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCheckResponse, Integer, Hash)>] GetCheckResponse data, response status code and response headers
+    def get_check_with_http_info(check_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.get_check ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.get_check"
+      end
+      # resource path
+      local_var_path = '/v3/check/{check_id}'.sub('{' + 'check_id' + '}', CGI.escape(check_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] || 'GetCheckResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.get_check",
+        :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: Payment#get_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get attachment for a payment
+    # Get the attachment for a payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def get_check_attachment(check_id, opts = {})
+      data, _status_code, _headers = get_check_attachment_with_http_info(check_id, opts)
+      data
+    end
+
+    # Get attachment for a payment
+    # Get the attachment for a payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def get_check_attachment_with_http_info(check_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.get_check_attachment ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.get_check_attachment"
+      end
+      # resource path
+      local_var_path = '/v3/check/{check_id}/attachment'.sub('{' + 'check_id' + '}', CGI.escape(check_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 => :"Payment.get_check_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: Payment#get_check_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get deposit details
+    # Get details on a deposited payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetCheckDepositedResponse]
+    def get_check_deposit(check_id, opts = {})
+      data, _status_code, _headers = get_check_deposit_with_http_info(check_id, opts)
+      data
+    end
+
+    # Get deposit details
+    # Get details on a deposited payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCheckDepositedResponse, Integer, Hash)>] GetCheckDepositedResponse data, response status code and response headers
+    def get_check_deposit_with_http_info(check_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.get_check_deposit ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.get_check_deposit"
+      end
+      # resource path
+      local_var_path = '/v3/check/{check_id}/deposit'.sub('{' + 'check_id' + '}', CGI.escape(check_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] || 'GetCheckDepositedResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.get_check_deposit",
+        :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: Payment#get_check_deposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get details on failed payment
+    # Get details on a failed payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetCheckFailedResponse]
+    def get_check_fail(check_id, opts = {})
+      data, _status_code, _headers = get_check_fail_with_http_info(check_id, opts)
+      data
+    end
+
+    # Get details on failed payment
+    # Get details on a failed payment
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCheckFailedResponse, Integer, Hash)>] GetCheckFailedResponse data, response status code and response headers
+    def get_check_fail_with_http_info(check_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.get_check_fail ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.get_check_fail"
+      end
+      # resource path
+      local_var_path = '/v3/check/{check_id}/fail'.sub('{' + 'check_id' + '}', CGI.escape(check_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] || 'GetCheckFailedResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.get_check_fail",
+        :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: Payment#get_check_fail\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get tracking details on mailed check
+    # Get tracking details on a mailed check
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetCheckTrackingResponseExpress]
+    def get_check_tracking(check_id, opts = {})
+      data, _status_code, _headers = get_check_tracking_with_http_info(check_id, opts)
+      data
+    end
+
+    # Get tracking details on mailed check
+    # Get tracking details on a mailed check
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCheckTrackingResponseExpress, Integer, Hash)>] GetCheckTrackingResponseExpress data, response status code and response headers
+    def get_check_tracking_with_http_info(check_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.get_check_tracking ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.get_check_tracking"
+      end
+      # resource path
+      local_var_path = '/v3/check/{check_id}/tracking'.sub('{' + 'check_id' + '}', CGI.escape(check_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] || 'GetCheckTrackingResponseExpress'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.get_check_tracking",
+        :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: Payment#get_check_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get verification code
+    # Get the verification code
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [VerifyCheckResponse]
+    def get_check_verification(check_id, opts = {})
+      data, _status_code, _headers = get_check_verification_with_http_info(check_id, opts)
+      data
+    end
+
+    # Get verification code
+    # Get the verification code
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VerifyCheckResponse, Integer, Hash)>] VerifyCheckResponse data, response status code and response headers
+    def get_check_verification_with_http_info(check_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.get_check_verification ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.get_check_verification"
+      end
+      # resource path
+      local_var_path = '/v3/check/{check_id}/verification'.sub('{' + 'check_id' + '}', CGI.escape(check_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] || 'VerifyCheckResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.get_check_verification",
+        :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: Payment#get_check_verification\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get sent/received payments
+    # Return the sent/received payments
+    # @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 [GetChecksResponse]
+    def get_checks(opts = {})
+      data, _status_code, _headers = get_checks_with_http_info(opts)
+      data
+    end
+
+    # Get sent/received payments
+    # Return the sent/received payments
+    # @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<(GetChecksResponse, Integer, Hash)>] GetChecksResponse data, response status code and response headers
+    def get_checks_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.get_checks ...'
+      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 Payment.get_checks, 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 Payment.get_checks, 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/check'
+
+      # 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] || 'GetChecksResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.get_checks",
+        :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: Payment#get_checks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Deposit a payment
+    # Deposit a payment
+    # @param check_id [String] 
+    # @param deposit_check_request [DepositCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetCheckResponse]
+    def post_check_deposit(check_id, deposit_check_request, opts = {})
+      data, _status_code, _headers = post_check_deposit_with_http_info(check_id, deposit_check_request, opts)
+      data
+    end
+
+    # Deposit a payment
+    # Deposit a payment
+    # @param check_id [String] 
+    # @param deposit_check_request [DepositCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCheckResponse, Integer, Hash)>] GetCheckResponse data, response status code and response headers
+    def post_check_deposit_with_http_info(check_id, deposit_check_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.post_check_deposit ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.post_check_deposit"
+      end
+      # verify the required parameter 'deposit_check_request' is set
+      if @api_client.config.client_side_validation && deposit_check_request.nil?
+        fail ArgumentError, "Missing the required parameter 'deposit_check_request' when calling Payment.post_check_deposit"
+      end
+      # resource path
+      local_var_path = '/v3/check/deposit/{check_id}'.sub('{' + 'check_id' + '}', CGI.escape(check_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(deposit_check_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetCheckResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.post_check_deposit",
+        :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: Payment#post_check_deposit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a digital payment
+    # Create a digital payment  > [!NOTE] > **Common Errors** > > - **`Invalid deposit option`:** If deposit options do not include `PRINT`, `MAIL`, or `BANK`, please ensure the payment is funded by a wallet. If you still encounter this error, please contact support@checkbook.io to ensure the specified payment rails are enabled for your account. > - **`Amount is larger than $2000 and requires signature`:** Please add a signature to the sender using [`v3/user/signature`](#tag/user/post/v3/user/signature). A signature is required for users to send out payments over $2000.
+    # @param create_digital_check_request [CreateDigitalCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetCheckResponse]
+    def post_check_digital(create_digital_check_request, opts = {})
+      data, _status_code, _headers = post_check_digital_with_http_info(create_digital_check_request, opts)
+      data
+    end
+
+    # Create a digital payment
+    # Create a digital payment  &gt; [!NOTE] &gt; **Common Errors** &gt; &gt; - **&#x60;Invalid deposit option&#x60;:** If deposit options do not include &#x60;PRINT&#x60;, &#x60;MAIL&#x60;, or &#x60;BANK&#x60;, please ensure the payment is funded by a wallet. If you still encounter this error, please contact support@checkbook.io to ensure the specified payment rails are enabled for your account. &gt; - **&#x60;Amount is larger than $2000 and requires signature&#x60;:** Please add a signature to the sender using [&#x60;v3/user/signature&#x60;](#tag/user/post/v3/user/signature). A signature is required for users to send out payments over $2000.
+    # @param create_digital_check_request [CreateDigitalCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCheckResponse, Integer, Hash)>] GetCheckResponse data, response status code and response headers
+    def post_check_digital_with_http_info(create_digital_check_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.post_check_digital ...'
+      end
+      # verify the required parameter 'create_digital_check_request' is set
+      if @api_client.config.client_side_validation && create_digital_check_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_digital_check_request' when calling Payment.post_check_digital"
+      end
+      # resource path
+      local_var_path = '/v3/check/digital'
+
+      # 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_digital_check_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetCheckResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.post_check_digital",
+        :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: Payment#post_check_digital\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Endorse a multi-party payment
+    # Endorse a multi party payment
+    # @param check_id [String] 
+    # @param endorse_check_request [EndorseCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_check_endorse(check_id, endorse_check_request, opts = {})
+      post_check_endorse_with_http_info(check_id, endorse_check_request, opts)
+      nil
+    end
+
+    # Endorse a multi-party payment
+    # Endorse a multi party payment
+    # @param check_id [String] 
+    # @param endorse_check_request [EndorseCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_check_endorse_with_http_info(check_id, endorse_check_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.post_check_endorse ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.post_check_endorse"
+      end
+      # verify the required parameter 'endorse_check_request' is set
+      if @api_client.config.client_side_validation && endorse_check_request.nil?
+        fail ArgumentError, "Missing the required parameter 'endorse_check_request' when calling Payment.post_check_endorse"
+      end
+      # resource path
+      local_var_path = '/v3/check/endorse/{check_id}'.sub('{' + 'check_id' + '}', CGI.escape(check_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(endorse_check_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.post_check_endorse",
+        :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: Payment#post_check_endorse\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a multi-party payment
+    # Create a new multi party payment
+    # @param create_multi_check_request [CreateMultiCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetCheckResponse]
+    def post_check_multi(create_multi_check_request, opts = {})
+      data, _status_code, _headers = post_check_multi_with_http_info(create_multi_check_request, opts)
+      data
+    end
+
+    # Create a multi-party payment
+    # Create a new multi party payment
+    # @param create_multi_check_request [CreateMultiCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCheckResponse, Integer, Hash)>] GetCheckResponse data, response status code and response headers
+    def post_check_multi_with_http_info(create_multi_check_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.post_check_multi ...'
+      end
+      # verify the required parameter 'create_multi_check_request' is set
+      if @api_client.config.client_side_validation && create_multi_check_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_multi_check_request' when calling Payment.post_check_multi"
+      end
+      # resource path
+      local_var_path = '/v3/check/multi'
+
+      # 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_multi_check_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetCheckResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.post_check_multi",
+        :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: Payment#post_check_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Resend payment notification
+    # Resend payment notification
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_check_notify(check_id, opts = {})
+      post_check_notify_with_http_info(check_id, opts)
+      nil
+    end
+
+    # Resend payment notification
+    # Resend payment notification
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_check_notify_with_http_info(check_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.post_check_notify ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.post_check_notify"
+      end
+      # resource path
+      local_var_path = '/v3/check/notify/{check_id}'.sub('{' + 'check_id' + '}', CGI.escape(check_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 => :"Payment.post_check_notify",
+        :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: Payment#post_check_notify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a physical check
+    # Create a new paper check
+    # @param create_physical_check_request [CreatePhysicalCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetCheckResponse]
+    def post_check_physical(create_physical_check_request, opts = {})
+      data, _status_code, _headers = post_check_physical_with_http_info(create_physical_check_request, opts)
+      data
+    end
+
+    # Create a physical check
+    # Create a new paper check
+    # @param create_physical_check_request [CreatePhysicalCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetCheckResponse, Integer, Hash)>] GetCheckResponse data, response status code and response headers
+    def post_check_physical_with_http_info(create_physical_check_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.post_check_physical ...'
+      end
+      # verify the required parameter 'create_physical_check_request' is set
+      if @api_client.config.client_side_validation && create_physical_check_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_physical_check_request' when calling Payment.post_check_physical"
+      end
+      # resource path
+      local_var_path = '/v3/check/physical'
+
+      # 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_physical_check_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetCheckResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.post_check_physical",
+        :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: Payment#post_check_physical\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Preview payment
+    # Preview a new payment
+    # @param preview_check_request [PreviewCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [PreviewCheckResponse]
+    def post_check_preview(preview_check_request, opts = {})
+      data, _status_code, _headers = post_check_preview_with_http_info(preview_check_request, opts)
+      data
+    end
+
+    # Preview payment
+    # Preview a new payment
+    # @param preview_check_request [PreviewCheckRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PreviewCheckResponse, Integer, Hash)>] PreviewCheckResponse data, response status code and response headers
+    def post_check_preview_with_http_info(preview_check_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.post_check_preview ...'
+      end
+      # verify the required parameter 'preview_check_request' is set
+      if @api_client.config.client_side_validation && preview_check_request.nil?
+        fail ArgumentError, "Missing the required parameter 'preview_check_request' when calling Payment.post_check_preview"
+      end
+      # resource path
+      local_var_path = '/v3/check/preview'
+
+      # 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(preview_check_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PreviewCheckResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.post_check_preview",
+        :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: Payment#post_check_preview\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Print a payment
+    # Print a check
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def post_check_print(check_id, opts = {})
+      data, _status_code, _headers = post_check_print_with_http_info(check_id, opts)
+      data
+    end
+
+    # Print a payment
+    # Print a check
+    # @param check_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def post_check_print_with_http_info(check_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.post_check_print ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.post_check_print"
+      end
+      # resource path
+      local_var_path = '/v3/check/print/{check_id}'.sub('{' + 'check_id' + '}', CGI.escape(check_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 => :"Payment.post_check_print",
+        :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: Payment#post_check_print\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a sandbox payment status
+    # Update a payment's status in sandbox. Triggers a sandbox check webhook notification.
+    # @param check_id [String] 
+    # @param trigger_webhook_request [TriggerWebhookRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def post_check_webhook(check_id, trigger_webhook_request, opts = {})
+      post_check_webhook_with_http_info(check_id, trigger_webhook_request, opts)
+      nil
+    end
+
+    # Update a sandbox payment status
+    # Update a payment&#39;s status in sandbox. Triggers a sandbox check webhook notification.
+    # @param check_id [String] 
+    # @param trigger_webhook_request [TriggerWebhookRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_check_webhook_with_http_info(check_id, trigger_webhook_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Payment.post_check_webhook ...'
+      end
+      # verify the required parameter 'check_id' is set
+      if @api_client.config.client_side_validation && check_id.nil?
+        fail ArgumentError, "Missing the required parameter 'check_id' when calling Payment.post_check_webhook"
+      end
+      # verify the required parameter 'trigger_webhook_request' is set
+      if @api_client.config.client_side_validation && trigger_webhook_request.nil?
+        fail ArgumentError, "Missing the required parameter 'trigger_webhook_request' when calling Payment.post_check_webhook"
+      end
+      # resource path
+      local_var_path = '/v3/check/webhook/{check_id}'.sub('{' + 'check_id' + '}', CGI.escape(check_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(trigger_webhook_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Payment.post_check_webhook",
+        :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: Payment#post_check_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end