checkbook 1.0.1

data/lib/checkbook/api/subscription.rb

@@ -0,0 +1,463 @@
+=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 Subscription
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Remove subscription
+    # Remove the specified subscription
+    # @param subscription_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_subscription(subscription_id, opts = {})
+      delete_subscription_with_http_info(subscription_id, opts)
+      nil
+    end
+
+    # Remove subscription
+    # Remove the specified subscription
+    # @param subscription_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_subscription_with_http_info(subscription_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Subscription.delete_subscription ...'
+      end
+      # verify the required parameter 'subscription_id' is set
+      if @api_client.config.client_side_validation && subscription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_id' when calling Subscription.delete_subscription"
+      end
+      # resource path
+      local_var_path = '/v3/subscription/{subscription_id}'.sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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 => :"Subscription.delete_subscription",
+        :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: Subscription#delete_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get subscription
+    # Get the specified subscription
+    # @param subscription_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetSubscriptionResponse]
+    def get_subscription(subscription_id, opts = {})
+      data, _status_code, _headers = get_subscription_with_http_info(subscription_id, opts)
+      data
+    end
+
+    # Get subscription
+    # Get the specified subscription
+    # @param subscription_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetSubscriptionResponse, Integer, Hash)>] GetSubscriptionResponse data, response status code and response headers
+    def get_subscription_with_http_info(subscription_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Subscription.get_subscription ...'
+      end
+      # verify the required parameter 'subscription_id' is set
+      if @api_client.config.client_side_validation && subscription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_id' when calling Subscription.get_subscription"
+      end
+      # resource path
+      local_var_path = '/v3/subscription/{subscription_id}'.sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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] || 'GetSubscriptionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Subscription.get_subscription",
+        :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: Subscription#get_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get subscriptions
+    # Return the subscriptions
+    # @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 [GetSubscriptionsResponse]
+    def get_subscriptions(opts = {})
+      data, _status_code, _headers = get_subscriptions_with_http_info(opts)
+      data
+    end
+
+    # Get subscriptions
+    # Return the subscriptions
+    # @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<(GetSubscriptionsResponse, Integer, Hash)>] GetSubscriptionsResponse data, response status code and response headers
+    def get_subscriptions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Subscription.get_subscriptions ...'
+      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 Subscription.get_subscriptions, 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 Subscription.get_subscriptions, 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/subscription'
+
+      # 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] || 'GetSubscriptionsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Subscription.get_subscriptions",
+        :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: Subscription#get_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create payment subscription
+    # Create a new payment subscription
+    # @param create_check_subscription_request [CreateCheckSubscriptionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateSubscriptionResponse]
+    def post_subscription_check(create_check_subscription_request, opts = {})
+      data, _status_code, _headers = post_subscription_check_with_http_info(create_check_subscription_request, opts)
+      data
+    end
+
+    # Create payment subscription
+    # Create a new payment subscription
+    # @param create_check_subscription_request [CreateCheckSubscriptionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateSubscriptionResponse, Integer, Hash)>] CreateSubscriptionResponse data, response status code and response headers
+    def post_subscription_check_with_http_info(create_check_subscription_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Subscription.post_subscription_check ...'
+      end
+      # verify the required parameter 'create_check_subscription_request' is set
+      if @api_client.config.client_side_validation && create_check_subscription_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_check_subscription_request' when calling Subscription.post_subscription_check"
+      end
+      # resource path
+      local_var_path = '/v3/subscription/check'
+
+      # 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_check_subscription_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateSubscriptionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Subscription.post_subscription_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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: Subscription#post_subscription_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create invoice subscription
+    # Create a new invoice subscription
+    # @param create_invoice_subscription_request [CreateInvoiceSubscriptionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateSubscriptionResponse]
+    def post_subscription_invoice(create_invoice_subscription_request, opts = {})
+      data, _status_code, _headers = post_subscription_invoice_with_http_info(create_invoice_subscription_request, opts)
+      data
+    end
+
+    # Create invoice subscription
+    # Create a new invoice subscription
+    # @param create_invoice_subscription_request [CreateInvoiceSubscriptionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateSubscriptionResponse, Integer, Hash)>] CreateSubscriptionResponse data, response status code and response headers
+    def post_subscription_invoice_with_http_info(create_invoice_subscription_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Subscription.post_subscription_invoice ...'
+      end
+      # verify the required parameter 'create_invoice_subscription_request' is set
+      if @api_client.config.client_side_validation && create_invoice_subscription_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_invoice_subscription_request' when calling Subscription.post_subscription_invoice"
+      end
+      # resource path
+      local_var_path = '/v3/subscription/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_subscription_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateSubscriptionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Subscription.post_subscription_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: Subscription#post_subscription_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update subscription
+    # Update the specified subscription
+    # @param subscription_id [String] 
+    # @param update_subscription_request [UpdateSubscriptionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def put_subscription(subscription_id, update_subscription_request, opts = {})
+      put_subscription_with_http_info(subscription_id, update_subscription_request, opts)
+      nil
+    end
+
+    # Update subscription
+    # Update the specified subscription
+    # @param subscription_id [String] 
+    # @param update_subscription_request [UpdateSubscriptionRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def put_subscription_with_http_info(subscription_id, update_subscription_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: Subscription.put_subscription ...'
+      end
+      # verify the required parameter 'subscription_id' is set
+      if @api_client.config.client_side_validation && subscription_id.nil?
+        fail ArgumentError, "Missing the required parameter 'subscription_id' when calling Subscription.put_subscription"
+      end
+      # verify the required parameter 'update_subscription_request' is set
+      if @api_client.config.client_side_validation && update_subscription_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_subscription_request' when calling Subscription.put_subscription"
+      end
+      # resource path
+      local_var_path = '/v3/subscription/{subscription_id}'.sub('{' + 'subscription_id' + '}', CGI.escape(subscription_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_subscription_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['token']
+
+      new_options = opts.merge(
+        :operation => :"Subscription.put_subscription",
+        :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: Subscription#put_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end