mx-platform-ruby 1.10.0 → 1.10.1

data/lib/mx-platform-ruby/api/ach_return_api.rb

@@ -0,0 +1,231 @@
+=begin
+#MX Platform API
+
+#The MX Platform API is a powerful, fully-featured API designed to make aggregating and enhancing financial data easy and reliable. It can seamlessly connect your app or website to tens of thousands of financial institutions.  Just getting started? See our [use case guides](/use-cases/). 
+
+The version of the OpenAPI document: 20111101
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'cgi'
+
+module MxPlatformRuby
+  class AchReturnApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create ACH Return
+    # :::warning The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. :::  Use this endpoint to create an ACH return in our system. 
+    # @param ach_return_create_request_body [ACHReturnCreateRequestBody] ACH return object to be created.
+    # @param [Hash] opts the optional parameters
+    # @return [ACHReturnResponseBody]
+    def create_ach_return(ach_return_create_request_body, opts = {})
+      data, _status_code, _headers = create_ach_return_with_http_info(ach_return_create_request_body, opts)
+      data
+    end
+
+    # Create ACH Return
+    # :::warning The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. :::  Use this endpoint to create an ACH return in our system. 
+    # @param ach_return_create_request_body [ACHReturnCreateRequestBody] ACH return object to be created.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ACHReturnResponseBody, Integer, Hash)>] ACHReturnResponseBody data, response status code and response headers
+    def create_ach_return_with_http_info(ach_return_create_request_body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AchReturnApi.create_ach_return ...'
+      end
+      # verify the required parameter 'ach_return_create_request_body' is set
+      if @api_client.config.client_side_validation && ach_return_create_request_body.nil?
+        fail ArgumentError, "Missing the required parameter 'ach_return_create_request_body' when calling AchReturnApi.create_ach_return"
+      end
+      # resource path
+      local_var_path = '/ach_returns'
+
+      # 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/vnd.mx.api.v1+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(ach_return_create_request_body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ACHReturnResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"AchReturnApi.create_ach_return",
+        :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: AchReturnApi#create_ach_return\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List ACH Returns
+    # :::warning The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. :::  Use this endpoint to get all ACH returns. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :institution_guid The identifier for the institution associated with the ACH return. Defined by MX.
+    # @option opts [String] :returned_at The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp.
+    # @option opts [String] :resolved_status_at The date and time when the return was resolved by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp
+    # @option opts [String] :return_code The associated ACH return code and notice of change code. See [Return Codes](/api-reference/platform-api/reference/ach-return-fields#return-codes) for a complete list.
+    # @option opts [String] :return_status The status of the return. See [Return Statuses](/api-reference/platform-api/reference/ach-return-fields#return-status) for a complete list.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead.
+    # @return [ACHReturnsResponseBody]
+    def list_ach_retruns(opts = {})
+      data, _status_code, _headers = list_ach_retruns_with_http_info(opts)
+      data
+    end
+
+    # List ACH Returns
+    # :::warning The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. :::  Use this endpoint to get all ACH returns. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :institution_guid The identifier for the institution associated with the ACH return. Defined by MX.
+    # @option opts [String] :returned_at The date and time when the return was reported by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp.
+    # @option opts [String] :resolved_status_at The date and time when the return was resolved by the Receiving Financial Depository Institution (RDFI) in ISO 8601 format without timestamp
+    # @option opts [String] :return_code The associated ACH return code and notice of change code. See [Return Codes](/api-reference/platform-api/reference/ach-return-fields#return-codes) for a complete list.
+    # @option opts [String] :return_status The status of the return. See [Return Statuses](/api-reference/platform-api/reference/ach-return-fields#return-status) for a complete list.
+    # @option opts [Integer] :page Results are paginated. Specify current page.
+    # @option opts [Integer] :records_per_page This specifies the number of records to be returned on each page. Defaults to &#x60;25&#x60;. The valid range is from &#x60;10&#x60; to &#x60;100&#x60;. If the value exceeds &#x60;100&#x60;, the default value of &#x60;25&#x60; will be used instead.
+    # @return [Array<(ACHReturnsResponseBody, Integer, Hash)>] ACHReturnsResponseBody data, response status code and response headers
+    def list_ach_retruns_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AchReturnApi.list_ach_retruns ...'
+      end
+      # resource path
+      local_var_path = '/ach_returns'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'institution_guid'] = opts[:'institution_guid'] if !opts[:'institution_guid'].nil?
+      query_params[:'returned_at'] = opts[:'returned_at'] if !opts[:'returned_at'].nil?
+      query_params[:'resolved_status_at'] = opts[:'resolved_status_at'] if !opts[:'resolved_status_at'].nil?
+      query_params[:'return_code'] = opts[:'return_code'] if !opts[:'return_code'].nil?
+      query_params[:'return_status'] = opts[:'return_status'] if !opts[:'return_status'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'records_per_page'] = opts[:'records_per_page'] if !opts[:'records_per_page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/vnd.mx.api.v1+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] || 'ACHReturnsResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"AchReturnApi.list_ach_retruns",
+        :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: AchReturnApi#list_ach_retruns\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read ACH Return
+    # :::warning The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. :::  Use this endpoint to get an ACH return by its `guid` or `id`. 
+    # @param ach_return_guid [String] The unique identifier (&#x60;guid&#x60;) for the ACH return. Defined by MX.
+    # @param [Hash] opts the optional parameters
+    # @return [ACHReturnResponseBody]
+    def read_ach_retrun(ach_return_guid, opts = {})
+      data, _status_code, _headers = read_ach_retrun_with_http_info(ach_return_guid, opts)
+      data
+    end
+
+    # Read ACH Return
+    # :::warning The features documented here are in a beta state, and this documentation is considered draft material subject to frequent change. :::  Use this endpoint to get an ACH return by its &#x60;guid&#x60; or &#x60;id&#x60;. 
+    # @param ach_return_guid [String] The unique identifier (&#x60;guid&#x60;) for the ACH return. Defined by MX.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ACHReturnResponseBody, Integer, Hash)>] ACHReturnResponseBody data, response status code and response headers
+    def read_ach_retrun_with_http_info(ach_return_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AchReturnApi.read_ach_retrun ...'
+      end
+      # verify the required parameter 'ach_return_guid' is set
+      if @api_client.config.client_side_validation && ach_return_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'ach_return_guid' when calling AchReturnApi.read_ach_retrun"
+      end
+      # resource path
+      local_var_path = '/ach_returns/{ach_return_guid}'.sub('{' + 'ach_return_guid' + '}', CGI.escape(ach_return_guid.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/vnd.mx.api.v1+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] || 'ACHReturnResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"AchReturnApi.read_ach_retrun",
+        :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: AchReturnApi#read_ach_retrun\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end