checkbook 1.0.1

data/lib/checkbook/api/vcc.rb

@@ -0,0 +1,439 @@
+=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 Vcc
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Remove virtual card
+    # Remove the specified vcc
+    # @param vcc_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_vcc(vcc_id, opts = {})
+      delete_vcc_with_http_info(vcc_id, opts)
+      nil
+    end
+
+    # Remove virtual card
+    # Remove the specified vcc
+    # @param vcc_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_vcc_with_http_info(vcc_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Vcc.delete_vcc ...'
+      end
+      # verify the required parameter 'vcc_id' is set
+      if @api_client.config.client_side_validation && vcc_id.nil?
+        fail ArgumentError, "Missing the required parameter 'vcc_id' when calling Vcc.delete_vcc"
+      end
+      # resource path
+      local_var_path = '/v3/account/vcc/{vcc_id}'.sub('{' + 'vcc_id' + '}', CGI.escape(vcc_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 => :"Vcc.delete_vcc",
+        :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: Vcc#delete_vcc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get virtual card transactions
+    # Get the transactions for the specified VCC
+    # @param vcc_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :beta  (default to false)
+    # @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 [Date] :start_date Start date
+    # @return [VccTransactionsResponse]
+    def get_vcc_transaction(vcc_id, opts = {})
+      data, _status_code, _headers = get_vcc_transaction_with_http_info(vcc_id, opts)
+      data
+    end
+
+    # Get virtual card transactions
+    # Get the transactions for the specified VCC
+    # @param vcc_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :beta  (default to false)
+    # @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 [Date] :start_date Start date
+    # @return [Array<(VccTransactionsResponse, Integer, Hash)>] VccTransactionsResponse data, response status code and response headers
+    def get_vcc_transaction_with_http_info(vcc_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Vcc.get_vcc_transaction ...'
+      end
+      # verify the required parameter 'vcc_id' is set
+      if @api_client.config.client_side_validation && vcc_id.nil?
+        fail ArgumentError, "Missing the required parameter 'vcc_id' when calling Vcc.get_vcc_transaction"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling Vcc.get_vcc_transaction, 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
+      # resource path
+      local_var_path = '/v3/account/vcc/{vcc_id}/transaction'.sub('{' + 'vcc_id' + '}', CGI.escape(vcc_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'beta'] = opts[:'beta'] if !opts[:'beta'].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[:'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] || 'VccTransactionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Vcc.get_vcc_transaction",
+        :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: Vcc#get_vcc_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get virtual card transaction by ID
+    # Get the requested transaction for the specified VCC
+    # @param vcc_id [String] 
+    # @param transaction_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [VccTransaction]
+    def get_vcc_transaction_by_id(vcc_id, transaction_id, opts = {})
+      data, _status_code, _headers = get_vcc_transaction_by_id_with_http_info(vcc_id, transaction_id, opts)
+      data
+    end
+
+    # Get virtual card transaction by ID
+    # Get the requested transaction for the specified VCC
+    # @param vcc_id [String] 
+    # @param transaction_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VccTransaction, Integer, Hash)>] VccTransaction data, response status code and response headers
+    def get_vcc_transaction_by_id_with_http_info(vcc_id, transaction_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Vcc.get_vcc_transaction_by_id ...'
+      end
+      # verify the required parameter 'vcc_id' is set
+      if @api_client.config.client_side_validation && vcc_id.nil?
+        fail ArgumentError, "Missing the required parameter 'vcc_id' when calling Vcc.get_vcc_transaction_by_id"
+      end
+      # verify the required parameter 'transaction_id' is set
+      if @api_client.config.client_side_validation && transaction_id.nil?
+        fail ArgumentError, "Missing the required parameter 'transaction_id' when calling Vcc.get_vcc_transaction_by_id"
+      end
+      # resource path
+      local_var_path = '/v3/account/vcc/{vcc_id}/transaction/{transaction_id}'.sub('{' + 'vcc_id' + '}', CGI.escape(vcc_id.to_s)).sub('{' + 'transaction_id' + '}', CGI.escape(transaction_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] || 'VccTransaction'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Vcc.get_vcc_transaction_by_id",
+        :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: Vcc#get_vcc_transaction_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get virtual cards
+    # Return the virtual cards
+    # @param [Hash] opts the optional parameters
+    # @return [VccQueryResponse]
+    def get_vccs(opts = {})
+      data, _status_code, _headers = get_vccs_with_http_info(opts)
+      data
+    end
+
+    # Get virtual cards
+    # Return the virtual cards
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(VccQueryResponse, Integer, Hash)>] VccQueryResponse data, response status code and response headers
+    def get_vccs_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Vcc.get_vccs ...'
+      end
+      # resource path
+      local_var_path = '/v3/account/vcc'
+
+      # 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] || 'VccQueryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Vcc.get_vccs",
+        :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: Vcc#get_vccs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create virtual card
+    # Add a new vcc
+    # @param create_vcc_request [CreateVccRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateVccResponse]
+    def post_vcc(create_vcc_request, opts = {})
+      data, _status_code, _headers = post_vcc_with_http_info(create_vcc_request, opts)
+      data
+    end
+
+    # Create virtual card
+    # Add a new vcc
+    # @param create_vcc_request [CreateVccRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateVccResponse, Integer, Hash)>] CreateVccResponse data, response status code and response headers
+    def post_vcc_with_http_info(create_vcc_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Vcc.post_vcc ...'
+      end
+      # verify the required parameter 'create_vcc_request' is set
+      if @api_client.config.client_side_validation && create_vcc_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_vcc_request' when calling Vcc.post_vcc"
+      end
+      # resource path
+      local_var_path = '/v3/account/vcc'
+
+      # 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_vcc_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateVccResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Vcc.post_vcc",
+        :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: Vcc#post_vcc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update virtual card
+    # Update the specified vcc
+    # @param vcc_id [String] 
+    # @param update_vcc_request [UpdateVccRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def put_vcc(vcc_id, update_vcc_request, opts = {})
+      put_vcc_with_http_info(vcc_id, update_vcc_request, opts)
+      nil
+    end
+
+    # Update virtual card
+    # Update the specified vcc
+    # @param vcc_id [String] 
+    # @param update_vcc_request [UpdateVccRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def put_vcc_with_http_info(vcc_id, update_vcc_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Vcc.put_vcc ...'
+      end
+      # verify the required parameter 'vcc_id' is set
+      if @api_client.config.client_side_validation && vcc_id.nil?
+        fail ArgumentError, "Missing the required parameter 'vcc_id' when calling Vcc.put_vcc"
+      end
+      # verify the required parameter 'update_vcc_request' is set
+      if @api_client.config.client_side_validation && update_vcc_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_vcc_request' when calling Vcc.put_vcc"
+      end
+      # resource path
+      local_var_path = '/v3/account/vcc/{vcc_id}'.sub('{' + 'vcc_id' + '}', CGI.escape(vcc_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_vcc_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Vcc.put_vcc",
+        :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: Vcc#put_vcc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end