mx-platform-ruby 1.10.0 → 1.10.1

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

@@ -0,0 +1,301 @@
+=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 InstitutionsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List favorite institutions
+    # This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include &#x60;US&#x60;, &#x60;CA&#x60;, and &#x60;MX&#x60; (Mexico).
+    # @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 [InstitutionsResponseBody]
+    def list_favorite_institutions(opts = {})
+      data, _status_code, _headers = list_favorite_institutions_with_http_info(opts)
+      data
+    end
+
+    # List favorite institutions
+    # This endpoint returns a paginated list containing institutions that have been set as the partner’s favorites, sorted by popularity. Please contact MX to set a list of favorites.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include &#x60;US&#x60;, &#x60;CA&#x60;, and &#x60;MX&#x60; (Mexico).
+    # @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<(InstitutionsResponseBody, Integer, Hash)>] InstitutionsResponseBody data, response status code and response headers
+    def list_favorite_institutions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InstitutionsApi.list_favorite_institutions ...'
+      end
+      # resource path
+      local_var_path = '/institutions/favorites'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'iso_country_code'] = @api_client.build_collection_param(opts[:'iso_country_code'], :multi) if !opts[:'iso_country_code'].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] || 'InstitutionsResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"InstitutionsApi.list_favorite_institutions",
+        :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: InstitutionsApi#list_favorite_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List institution credentials
+    # Use this endpoint to see which credentials will be needed to create a member for a specific institution.  Passing an invalid `institution_code` returns a `404`. 
+    # @param institution_code [String] The institution_code of the institution.
+    # @param [Hash] opts the optional parameters
+    # @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;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
+    # @return [CredentialsResponseBody]
+    def list_institution_credentials(institution_code, opts = {})
+      data, _status_code, _headers = list_institution_credentials_with_http_info(institution_code, opts)
+      data
+    end
+
+    # List institution credentials
+    # Use this endpoint to see which credentials will be needed to create a member for a specific institution.  Passing an invalid &#x60;institution_code&#x60; returns a &#x60;404&#x60;. 
+    # @param institution_code [String] The institution_code of the institution.
+    # @param [Hash] opts the optional parameters
+    # @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;1000&#x60;. If the value exceeds &#x60;1000&#x60;, the default value of &#x60;25&#x60; will be used instead.
+    # @return [Array<(CredentialsResponseBody, Integer, Hash)>] CredentialsResponseBody data, response status code and response headers
+    def list_institution_credentials_with_http_info(institution_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InstitutionsApi.list_institution_credentials ...'
+      end
+      # verify the required parameter 'institution_code' is set
+      if @api_client.config.client_side_validation && institution_code.nil?
+        fail ArgumentError, "Missing the required parameter 'institution_code' when calling InstitutionsApi.list_institution_credentials"
+      end
+      # resource path
+      local_var_path = '/institutions/{institution_code}/credentials'.sub('{' + 'institution_code' + '}', CGI.escape(institution_code.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      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] || 'CredentialsResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"InstitutionsApi.list_institution_credentials",
+        :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: InstitutionsApi#list_institution_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List institutions
+    # This endpoint returns a list of institutions based on the specified search term or parameter.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name This will list only institutions in which the appended string appears.
+    # @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include &#x60;US&#x60;, &#x60;CA&#x60;, and &#x60;MX&#x60; (Mexico).
+    # @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.
+    # @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
+    # @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
+    # @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
+    # @option opts [Boolean] :supports_transaction_history Filter only institutions which support extended transaction history.
+    # @return [InstitutionsResponseBody]
+    def list_institutions(opts = {})
+      data, _status_code, _headers = list_institutions_with_http_info(opts)
+      data
+    end
+
+    # List institutions
+    # This endpoint returns a list of institutions based on the specified search term or parameter.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name This will list only institutions in which the appended string appears.
+    # @option opts [Array<String>] :iso_country_code An array of strings that filters institutions in the widget by the specified country code. Acceptable codes include &#x60;US&#x60;, &#x60;CA&#x60;, and &#x60;MX&#x60; (Mexico).
+    # @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.
+    # @option opts [Boolean] :supports_account_identification Filter only institutions which support account identification.
+    # @option opts [Boolean] :supports_account_statement Filter only institutions which support account statements.
+    # @option opts [Boolean] :supports_account_verification Filter only institutions which support account verification.
+    # @option opts [Boolean] :supports_transaction_history Filter only institutions which support extended transaction history.
+    # @return [Array<(InstitutionsResponseBody, Integer, Hash)>] InstitutionsResponseBody data, response status code and response headers
+    def list_institutions_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InstitutionsApi.list_institutions ...'
+      end
+      # resource path
+      local_var_path = '/institutions'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
+      query_params[:'iso_country_code'] = @api_client.build_collection_param(opts[:'iso_country_code'], :multi) if !opts[:'iso_country_code'].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?
+      query_params[:'supports_account_identification'] = opts[:'supports_account_identification'] if !opts[:'supports_account_identification'].nil?
+      query_params[:'supports_account_statement'] = opts[:'supports_account_statement'] if !opts[:'supports_account_statement'].nil?
+      query_params[:'supports_account_verification'] = opts[:'supports_account_verification'] if !opts[:'supports_account_verification'].nil?
+      query_params[:'supports_transaction_history'] = opts[:'supports_transaction_history'] if !opts[:'supports_transaction_history'].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] || 'InstitutionsResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"InstitutionsApi.list_institutions",
+        :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: InstitutionsApi#list_institutions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Read institution
+    # This endpoint returns information about the institution specified by `institution_code`.
+    # @param institution_code [String] The institution_code of the institution.
+    # @param [Hash] opts the optional parameters
+    # @return [InstitutionResponseBody]
+    def read_institution(institution_code, opts = {})
+      data, _status_code, _headers = read_institution_with_http_info(institution_code, opts)
+      data
+    end
+
+    # Read institution
+    # This endpoint returns information about the institution specified by &#x60;institution_code&#x60;.
+    # @param institution_code [String] The institution_code of the institution.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InstitutionResponseBody, Integer, Hash)>] InstitutionResponseBody data, response status code and response headers
+    def read_institution_with_http_info(institution_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InstitutionsApi.read_institution ...'
+      end
+      # verify the required parameter 'institution_code' is set
+      if @api_client.config.client_side_validation && institution_code.nil?
+        fail ArgumentError, "Missing the required parameter 'institution_code' when calling InstitutionsApi.read_institution"
+      end
+      # resource path
+      local_var_path = '/institutions/{institution_code}'.sub('{' + 'institution_code' + '}', CGI.escape(institution_code.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] || 'InstitutionResponseBody'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['basicAuth']
+
+      new_options = opts.merge(
+        :operation => :"InstitutionsApi.read_institution",
+        :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: InstitutionsApi#read_institution\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end