mx-platform-ruby 1.10.0 → 1.10.1

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

@@ -0,0 +1,214 @@
+=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 MerchantsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List merchants
+    # This endpoint returns a paginated list of all the merchants in the MX system.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name This will list only merchants in which the appended string appears.
+    # @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 `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
+    # @return [MerchantsResponseBody]
+    def list_merchants(opts = {})
+      data, _status_code, _headers = list_merchants_with_http_info(opts)
+      data
+    end
+
+    # List merchants
+    # This endpoint returns a paginated list of all the merchants in the MX system.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name This will list only merchants in which the appended string appears.
+    # @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 `25`. The valid range is from `10` to `1000`. If the value exceeds `1000`, the default value of `25` will be used instead.
+    # @return [Array<(MerchantsResponseBody, Integer, Hash)>] MerchantsResponseBody data, response status code and response headers
+    def list_merchants_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MerchantsApi.list_merchants ...'
+      end
+      # resource path
+      local_var_path = '/merchants'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'name'] = opts[:'name'] if !opts[:'name'].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] || 'MerchantsResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MerchantsApi.list_merchants",
+        :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: MerchantsApi#list_merchants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read merchant
+    # Returns information about a particular merchant, such as a logo, name, and website.
+    # @param merchant_guid [String] The unique id for a &#x60;merchant&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [MerchantResponseBody]
+    def read_merchant(merchant_guid, opts = {})
+      data, _status_code, _headers = read_merchant_with_http_info(merchant_guid, opts)
+      data
+    end
+
+    # Read merchant
+    # Returns information about a particular merchant, such as a logo, name, and website.
+    # @param merchant_guid [String] The unique id for a &#x60;merchant&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MerchantResponseBody, Integer, Hash)>] MerchantResponseBody data, response status code and response headers
+    def read_merchant_with_http_info(merchant_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MerchantsApi.read_merchant ...'
+      end
+      # verify the required parameter 'merchant_guid' is set
+      if @api_client.config.client_side_validation && merchant_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_guid' when calling MerchantsApi.read_merchant"
+      end
+      # resource path
+      local_var_path = '/merchants/{merchant_guid}'.sub('{' + 'merchant_guid' + '}', CGI.escape(merchant_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] || 'MerchantResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MerchantsApi.read_merchant",
+        :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: MerchantsApi#read_merchant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read merchant location
+    # This endpoint returns the specified `merchant_location` resource. The `merchant_location_guid` can be found on `transaction` objects.
+    # @param merchant_location_guid [String] The unique id for a &#x60;merchant_location&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [MerchantLocationResponseBody]
+    def read_merchant_location(merchant_location_guid, opts = {})
+      data, _status_code, _headers = read_merchant_location_with_http_info(merchant_location_guid, opts)
+      data
+    end
+
+    # Read merchant location
+    # This endpoint returns the specified &#x60;merchant_location&#x60; resource. The &#x60;merchant_location_guid&#x60; can be found on &#x60;transaction&#x60; objects.
+    # @param merchant_location_guid [String] The unique id for a &#x60;merchant_location&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(MerchantLocationResponseBody, Integer, Hash)>] MerchantLocationResponseBody data, response status code and response headers
+    def read_merchant_location_with_http_info(merchant_location_guid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MerchantsApi.read_merchant_location ...'
+      end
+      # verify the required parameter 'merchant_location_guid' is set
+      if @api_client.config.client_side_validation && merchant_location_guid.nil?
+        fail ArgumentError, "Missing the required parameter 'merchant_location_guid' when calling MerchantsApi.read_merchant_location"
+      end
+      # resource path
+      local_var_path = '/merchant_locations/{merchant_location_guid}'.sub('{' + 'merchant_location_guid' + '}', CGI.escape(merchant_location_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] || 'MerchantLocationResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"MerchantsApi.read_merchant_location",
+        :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: MerchantsApi#read_merchant_location\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end