apimatic-mx-apis-sdk 0.0.1

data/lib/mx_platform_api/apis/insights_api.rb

@@ -0,0 +1,415 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # InsightsApi
+  class InsightsApi < BaseApi
+    # Use this endpoint to list all insights associated with an account GUID.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] account_guid Required parameter: The unique id for an
+    # `account`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `100`. If the value exceeds `100`, the default value
+    # of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_insights_by_account(accept_version,
+                                 account_guid,
+                                 user_guid,
+                                 page: nil,
+                                 records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/accounts/{account_guid}/insights',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(account_guid, key: 'account_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InsightsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to list all the insights associated with the user.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `100`. If the value exceeds `100`, the default value
+    # of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_insights_user(accept_version,
+                           user_guid,
+                           page: nil,
+                           records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/insights',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InsightsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to list all the categories associated with the insight.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] insight_guid Required parameter: The unique identifier for
+    # the insight. Defined by MX.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `100`. If the value exceeds `100`, the default value
+    # of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_categories_insight(accept_version,
+                                user_guid,
+                                insight_guid,
+                                page: nil,
+                                records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/insights/{insight_guid}/categories',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(insight_guid, key: 'insight_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CategoriesResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to list all the accounts associated with the insight.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] insight_guid Required parameter: The unique identifier for
+    # the insight. Defined by MX.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `100`. If the value exceeds `100`, the default value
+    # of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_accounts_insight(accept_version,
+                              user_guid,
+                              insight_guid,
+                              page: nil,
+                              records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/insights/{insight_guid}/accounts',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(insight_guid, key: 'insight_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to list all the merchants associated with the insight.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] insight_guid Required parameter: The unique identifier for
+    # the insight. Defined by MX.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `100`. If the value exceeds `100`, the default value
+    # of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_merchants_insight(accept_version,
+                               user_guid,
+                               insight_guid,
+                               page: nil,
+                               records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/insights/{insight_guid}/merchants',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(insight_guid, key: 'insight_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MerchantsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to list all the scheduled payments associated with the
+    # insight.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] insight_guid Required parameter: The unique identifier for
+    # the insight. Defined by MX.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `100`. If the value exceeds `100`, the default value
+    # of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_scheduled_payments_insight(accept_version,
+                                        user_guid,
+                                        insight_guid,
+                                        page: nil,
+                                        records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/insights/{insight_guid}/scheduled_payments',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(insight_guid, key: 'insight_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ScheduledPaymentsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to list all the transactions associated with the
+    # insight.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] insight_guid Required parameter: The unique identifier for
+    # the insight. Defined by MX.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `100`. If the value exceeds `100`, the default value
+    # of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_transactions_insight(accept_version,
+                                  user_guid,
+                                  insight_guid,
+                                  page: nil,
+                                  records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/insights/{insight_guid}/transactions',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(insight_guid, key: 'insight_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TransactionsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to read the attributes of an insight according to its
+    # unique GUID.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] insight_guid Required parameter: The unique identifier for
+    # the insight. Defined by MX.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_insight_user(accept_version,
+                          user_guid,
+                          insight_guid)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/insights/{insight_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(insight_guid, key: 'insight_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InsightResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to update the attributes of an insight according to its
+    # unique GUID.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [String] insight_guid Required parameter: The unique identifier for
+    # the insight. Defined by MX.
+    # @param [InsightUpdateRequestBody] body Required parameter: The insight to
+    # be updated (None of these parameters are required, but the user object
+    # cannot be empty.)
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_insight(accept_version,
+                       user_guid,
+                       insight_guid,
+                       body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/users/{user_guid}/insights/{insight_guid}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(insight_guid, key: 'insight_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InsightResponse.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to list all insights associated with a transaction GUID.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] transaction_guid Required parameter: The unique id for a
+    # `transaction`.
+    # @param [String] user_guid Required parameter: The unique identifier for a
+    # `user`, beginning with the prefix `USR-`.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: This specifies the
+    # number of records to be returned on each page. Defaults to `25`. The valid
+    # range is from `10` to `100`. If the value exceeds `100`, the default value
+    # of `25` will be used instead.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_insights_by_transaction(accept_version,
+                                     transaction_guid,
+                                     user_guid,
+                                     page: nil,
+                                     records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/users/{user_guid}/transactions/{transaction_guid}/insights',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(transaction_guid, key: 'transaction_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(user_guid, key: 'user_guid')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InsightsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/mx_platform_api/apis/institutions_api.rb

@@ -0,0 +1,159 @@
+# mx_platform_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module MxPlatformApi
+  # InstitutionsApi
+  class InstitutionsApi < BaseApi
+    # Lists financial institutions available through the MX platform. This
+    # endpoint has been updated in `v20250224` to enhance search and filtering
+    # capabilities based on the products supported by each institution.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] name Optional parameter: This will list only institutions
+    # in which the appended string appears.
+    # @param [Array[String]] iso_country_code Optional parameter: An array of
+    # strings that filters institutions in the widget by the specified country
+    # code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: 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.
+    # @param [Array[SupportedProduct1]] supported_products Optional parameter:
+    # Filters institutions that support specific products. Values may include
+    # account_verification, identity_verification, transactions,
+    # transaction_history, statements, investments.  For example, institutions
+    # that support account_verification and statements,
+    # `?supported_products[]=account_verification&supported_products[]=statement
+    # s`.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_institutions(accept_version,
+                          name: nil,
+                          iso_country_code: nil,
+                          page: nil,
+                          records_per_page: nil,
+                          supported_products: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/institutions',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .query_param(new_parameter(name, key: 'name'))
+                   .query_param(new_parameter(iso_country_code, key: 'iso_country_code'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .query_param(new_parameter(supported_products, key: 'supported_products'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InstitutionsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint returns a paginated list containing institutions that have
+    # been set as favorites, sorted by popularity. Please contact MX to set a
+    # list of favorites.
+    # @param [Array[String]] iso_country_code Optional parameter: An array of
+    # strings that filters institutions in the widget by the specified country
+    # code. Acceptable codes include `US`, `CA`, and `MX` (Mexico).
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: 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 [ApiResponse] Complete http response with raw body and status code.
+    def list_favorite_institutions(iso_country_code: nil,
+                                   page: nil,
+                                   records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/institutions/favorites',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(iso_country_code, key: 'iso_country_code'))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InstitutionsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # This endpoint returns information about the institution specified by
+    # `institution_code`. The `v20250224` update enhances the granularity of the
+    # information provided about the services and products supported by the
+    # institution.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] institution_code Required parameter: A unique identifier
+    # for each institution, defined by MX.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def read_institution(accept_version,
+                         institution_code)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/institutions/{institution_code}',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(institution_code, key: 'institution_code')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(InstitutionResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+
+    # Use this endpoint to see which credentials will be needed to create a
+    # member for a specific institution.
+    # Passing an invalid `institution_identifier` returns a `404`.
+    # @param [String] accept_version Required parameter: MX Platform API
+    # version.
+    # @param [String] institution_identifier Required parameter: The identifier
+    # for the institution. For this identifier, use either the
+    # `institution_code` or the institution `guid`.
+    # @param [Integer] page Optional parameter: Results are paginated. Specify
+    # current page.
+    # @param [Integer] records_per_page Optional parameter: 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 [ApiResponse] Complete http response with raw body and status code.
+    def list_institution_credentials(accept_version,
+                                     institution_identifier,
+                                     page: nil,
+                                     records_per_page: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/institutions/{institution_identifier}/credentials',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(accept_version, key: 'Accept-Version')
+                                  .is_required(true))
+                   .template_param(new_parameter(institution_identifier, key: 'institution_identifier')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(page, key: 'page'))
+                   .query_param(new_parameter(records_per_page, key: 'records_per_page'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('basicAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CredentialsResponseBody.method(:from_hash))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end