ps-apimatic-sdk 0.0.1

data/lib/paysecure_api_documentation_live/apis/transaction_reporting_api.rb

@@ -0,0 +1,148 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # TransactionReportingApi
+  class TransactionReportingApi < BaseApi
+    # Fetches a paginated list of transactions. This endpoint is optimized for
+    # high-volume retrieval and returns a summary view of each transaction (ID
+    # and Status).
+    # #### **Important Path Params to consider:**
+    # | **Fields** | **Description** |
+    # | --- | --- |
+    # | page_no | The index number of the page to retrieve.  <br>Zero-based
+    # indexing: The first page is 0, the second is 1, etc.  <br>Example: To get
+    # the third page of results, send page_no=2 |
+    # | page_size | The number of records to return per page.  <br>Minimum: 1
+    # <br>Maximum: 100 (or whatever your API limit is).  <br>Usage: A larger
+    # page_size reduces the number of API calls but increases payload size. |
+    # | transaction_id | If you want to filter with a specific transaction id.
+    # Multiple ids are not supported.  <br>If a transaction id is passed, it has
+    # the highest priority. All the below mentioned filters are ommitted. |
+    # | start_date | If you want to filter between 2 dates.  <br>Format:
+    # 2026-01-07 16:12:00 +05:30  <br>Base timezone is in UTC. |
+    # | end_date | If you want to filter between 2 dates  <br>Format: 2026-01-07
+    # 16:12:00 +05:30  <br>Base timezone is in UTC. |
+    # | last_updated_start | If you want to filter with the last updated date of
+    # a transaction.  <br>Format: 2026-01-07 16:12:00 +05:30  <br>Base timezone
+    # is in UTC. |
+    # | last_updated_end | If you want to filter with the last updated date of a
+    # transaction.  <br>Format: 2026-01-07 16:12:00 +05:30  <br>Base timezone is
+    # in UTC. |
+    # | customer_id | If you want to filter with a specific customer id.
+    # Multiple ids are not supported. |
+    # | status | If you want to filter with the status. |
+    # | currency | If you want to filter with the currency. |
+    # @param [Integer] page_no Required parameter: TODO: type description here
+    # @param [Integer] page_size Required parameter: TODO: type description
+    # here
+    # @param [String] transaction_id Required parameter: TODO: type description
+    # here
+    # @param [String] start_date Required parameter: TODO: type description
+    # here
+    # @param [String] end_date Required parameter: TODO: type description here
+    # @param [String] last_updated_start Required parameter: TODO: type
+    # description here
+    # @param [String] last_updated_end Required parameter: TODO: type
+    # description here
+    # @param [String] customer_id Required parameter: TODO: type description
+    # here
+    # @param [String] status Required parameter: TODO: type description here
+    # @param [String] currency Required parameter: TODO: type description here
+    # @param [TrueClass | FalseClass] is_sandbox Required parameter: TODO: type
+    # description here
+    # @param [String] brand_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_transactions(page_no,
+                          page_size,
+                          transaction_id,
+                          start_date,
+                          end_date,
+                          last_updated_start,
+                          last_updated_end,
+                          customer_id,
+                          status,
+                          currency,
+                          is_sandbox,
+                          brand_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/external/transactions/list',
+                                     Server::SERVER_3)
+                   .query_param(new_parameter(page_no, key: 'page_no')
+                                 .is_required(true))
+                   .query_param(new_parameter(page_size, key: 'page_size')
+                                 .is_required(true))
+                   .query_param(new_parameter(transaction_id, key: 'transaction_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(start_date, key: 'start_date')
+                                 .is_required(true))
+                   .query_param(new_parameter(end_date, key: 'end_date')
+                                 .is_required(true))
+                   .query_param(new_parameter(last_updated_start, key: 'last_updated_start')
+                                 .is_required(true))
+                   .query_param(new_parameter(last_updated_end, key: 'last_updated_end')
+                                 .is_required(true))
+                   .query_param(new_parameter(customer_id, key: 'customer_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(status, key: 'status')
+                                 .is_required(true))
+                   .query_param(new_parameter(currency, key: 'currency')
+                                 .is_required(true))
+                   .query_param(new_parameter(is_sandbox, key: 'is_sandbox')
+                                 .is_required(true))
+                   .header_param(new_parameter(brand_id, key: 'BrandId')
+                                  .is_required(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 Success42Exception))
+        .execute
+    end
+
+    # Retrieves the complete details for a specific transaction. This includes
+    # customer info, payment method details, bank response codes, and hierarchy
+    # metadata (parent/child transactions).
+    # ### Additional query **parameters for this usecase:**
+    # | **Parameter** | **Notes** |
+    # | --- | --- |
+    # | include_subtransactions | Mandatory.  <br>Possible Values: true/false
+    # <br>  <br>If true, includes child transactions (e.g., recurring payments).
+    # |
+    # @param [Integer] page_no Required parameter: TODO: type description here
+    # @param [Integer] page_size Required parameter: TODO: type description
+    # here
+    # @param [TrueClass | FalseClass] include_subtransactions Required
+    # parameter: TODO: type description here
+    # @param [String] brand_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_detailed_transaction_details(page_no,
+                                         page_size,
+                                         include_subtransactions,
+                                         brand_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api/v1/external/transactions/data/69e20fd928bea6ca2e31b17c',
+                                     Server::SERVER_3)
+                   .query_param(new_parameter(page_no, key: 'page_no')
+                                 .is_required(true))
+                   .query_param(new_parameter(page_size, key: 'page_size')
+                                 .is_required(true))
+                   .query_param(new_parameter(include_subtransactions, key: 'include_subtransactions')
+                                 .is_required(true))
+                   .header_param(new_parameter(brand_id, key: 'BrandId')
+                                  .is_required(true)))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 Success44Exception))
+        .execute
+    end
+  end
+end

data/lib/paysecure_api_documentation_live/apis/trust_score_api.rb

@@ -0,0 +1,347 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  # TrustScoreApi
+  class TrustScoreApi < BaseApi
+    # ### Overview
+    # Paysecure TrustScore's proprietary API combines email, phone number, IP
+    # and URL so that you can request and receive a user trust score from our
+    # enriched data, rules, and scoring in a single API call.
+    # Our take on Trust is different from the usual approach to fraud. This API
+    # tells you how much you can trust this user. It’s based on 100+ data points
+    # to which we have access. We use complex algorithms based on data sanity
+    # and customer behaviour in our partner network.
+    # Also, the additional optional parameter would be used to boost the
+    # accuracy of our response. So the more data we get the better we can
+    # ascertain the users' trust. So please endeavour to send as much
+    # information about the user as possible.
+    # ### **Trust Score & Usage**
+    # TrustScore offers two distinct endpoints: `General` and `Detailed`.
+    # The General endpoint provides basic information by indicating whether a
+    # transaction is permitted or not. It gives a simple 'yes' or 'no' response
+    # regarding whether the transaction can proceed.
+    # On the other hand, the Detailed endpoint offers a more comprehensive
+    # evaluation. It furnishes an in-depth analysis of the transaction's
+    # authenticity, providing a detailed assessment beyond a simple allowance or
+    # denial, offering nuanced insights and information about the transaction's
+    # legitimacy.
+    # ### Detailed TrustScore
+    # Trust scores range from 0 to 5. A trust score of 0 indicates that we have
+    # limited information about the user, and it corresponds to the lowest level
+    # of trust. In addition to the TrustScore, we offer eight other flags to
+    # help assess the user's overall profile and determine appropriate actions
+    # to take. We suggest flagging or blocking users, transactions, or clicks as
+    # high risk based on a combination of the following factors: email
+    # deliverability, proxy usage, VPN usage, Tor usage, and recent abusive
+    # behavior.
+    # Every company has a unique target audience, so you might achieve better
+    # results by only flagging or blocking entities with low trust scores and
+    # recent instances of abuse. Keep in mind that mobile IP addresses are
+    # frequently misused and recycled by mobile carriers. Therefore, for mobile
+    # lookups, we advise giving more weight to the trust score, VPN usage, and
+    # Tor usage, as opposed to proxy usage.
+    # ### **Permission**
+    # Access to this API has to be given to you by the admin. So please contact
+    # your sales representative at PaySecure to get access to this API, if you
+    # get a 401 error of "You are not allowed to call this API service".
+    # ### Mandatory Parameters (in body)
+    # | **Parameters** | **Description** |
+    # | --- | --- |
+    # | ip | IP of the user. Both IP4 and IP6 are valid |
+    # | email | The email id of the user you want to trust score on |
+    # | url | The URL on which the user is trying to purchase or consume a
+    # product, service or data. |
+    # ### Other optional paramters:
+    # The optional parameters are self-explanatory and appropriate values can be
+    # given in string format.
+    # | **Parameters** | **Values** |
+    # | --- | --- |
+    # | last_bets | String |
+    # | last_wins | String |
+    # | total_bonuses | String |
+    # | last_real_bets | String |
+    # | last_real_wins | String |
+    # | total_deposits | String |
+    # | last_bonus_bets | String |
+    # | last_bonus_wins | String |
+    # | average_real_bet | String |
+    # | last_bets_amount | String |
+    # | last_wins_amount | String |
+    # | average_bonus_bet | String |
+    # | bonus_to_deposits | String |
+    # | last_deposit_date | String |
+    # | total_withdrawals | String |
+    # | is_phone_confirmed | String |
+    # | money_in_money_out | String |
+    # | last_deposit_amount | String |
+    # | last_freespins_date | String |
+    # | last_freespins_name | String |
+    # | last_free_bonus_date | String |
+    # | last_free_bonus_name | String |
+    # | total_bonuses_amount | String |
+    # | last_freespins_amount | String |
+    # | last_freespins_status | String |
+    # | last_real_bets_amount | String |
+    # | last_real_wins_amount | String |
+    # | total_deposits_amount | String |
+    # | last_bonus_bets_amount | String |
+    # | last_bonus_wins_amount | String |
+    # | last_free_bonus_amount | String |
+    # | last_free_bonus_status | String |
+    # | last_deposit_bonus_date | String |
+    # | last_deposit_bonus_name | String |
+    # | last_freespins_currency | String |
+    # | last_freespins_wagering | String |
+    # | withdrawals_to_deposits | String |
+    # | last_free_bonus_currency | String |
+    # | last_free_bonus_wagering | String |
+    # | total_withdrawals_amount | String |
+    # | withdrawal_ewallet_email | String |
+    # | last_deposit_bonus_amount | String |
+    # | last_deposit_bonus_status | String |
+    # | last_deposit_bonus_currency | String |
+    # | last_deposit_bonus_wagering | String |
+    # | session | String |
+    # | payment_mode | String |
+    # | card_fullname | String |
+    # | card_bin | String |
+    # | card_hash | String |
+    # | card_last | String |
+    # | card_expire | String |
+    # | avs_result | String |
+    # | cvv_result | String |
+    # | sca_method | String |
+    # | user_bank_account | String |
+    # | user_bank_name | String |
+    # | user_balance | String |
+    # | user_verification_level | String |
+    # | status_3d | String |
+    # | regulation | String |
+    # | payment_provider | String |
+    # | phone_number | String |
+    # | transaction_type | String |
+    # | transaction_amount | String |
+    # | transaction_currency | String |
+    # | merchant_id | String |
+    # | details_url | String |
+    # | name | String |
+    # | person_type | String |
+    # | gender | String |
+    # ### Response
+    # In the response examples, you can observe both instances of a successful
+    # TrustScore response and an unsuccessful one.
+    # Please note that there are a lot of parameters to determine the trust
+    # level and give you some additional details on the email and IP of the
+    # user.
+    # in a successful trust score call the following data would be provided:
+    # | **Response Item** | **Description** | **Possible Values** |
+    # | --- | --- | --- |
+    # | trustScore | The trust score attributed to the user by our algorithms |
+    # Integer 0 to 5 |
+    # | deliverable | Whether the email is deliverable, usually false means it
+    # wouldn't be a trustable user. | **Boolean** |
+    # | proxy | Is this IP address suspected to be a proxy? (SOCKS, Elite,
+    # Anonymous, VPN, Tor, etc.) | **Boolean** |
+    # | vpn | Is this IP suspected of being a VPN connection? This can include
+    # data center ranges which can become active VPNs at any time. The "proxy"
+    # status will always be true when this value is true. | **Boolean** |
+    # | tor | Is this IP suspected of being a TOR connection? This can include
+    # previously active TOR nodes and exits which can become active TOR exits at
+    # any time. The "proxy" status will always be true when this value is true.
+    # | **Boolean** |
+    # | active_vpn | Identifies active VPN connections used by popular VPN
+    # services and private VPN servers. | **Boolean** |
+    # | active_tor | Identifies active TOR exits on the TOR network. |
+    # **Boolean** |
+    # | recent_abuse | This value indicates whether the IP address has been
+    # associated with any recently verified abuse on our network, such as a
+    # confirmed chargeback, compromised device, or fake app install. |
+    # **Boolean** |
+    # | bot_status | Shows whether bots or non-human traffic recently used this
+    # IP address to engage in automated fraud. This provides strong evidence
+    # that the IP address is suspicious. | **Boolean** |
+    # ### Errors
+    # If there are any errors then it'll be in the format of :
+    # ``` json
+    # {
+    #     "message": "descriptive error message",
+    #     "code": "error_code"
+    # }
+    #  ```
+    # ### Possible Error Messages
+    # the possible error codes one can get on calling this APIs are:
+    # | **Code** |
+    # | --- |
+    # | 400, 404, 401, 415, 405 |
+    # for example:
+    # | **Code** | **Error Messages** |
+    # | --- | --- |
+    # | 401 | Incorrect secret_key |
+    # | 401 | You are not Allowed to call this API service |
+    # @param [TrustScoreDetailedRequest] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def trust_score_detailed(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/trustScore',
+                                     Server::SERVER_3)
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json; charset=utf-8', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TrustScoreExists.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 TrustScoreErrorException))
+        .execute
+    end
+
+    # ### General TrustScore
+    # Request for the checkTransactionAllowed endpoint is identical to the
+    # TrustScore API. Only thing different is the response. Instead of detailed
+    # score, this endpoint only returns `transactionAllowed` parameter that can
+    # have either `YES` or `NO` value.
+    # ### **Permission**
+    # Access to this API has to be given to you by the admin. So please contact
+    # your sales representative at Paysecure to get access to this API, if you
+    # get a 401 error of "You are not allowed to call this API service".
+    # ### Mandatory Parameters (in body)
+    # | **Parameters** | **Description** |
+    # | --- | --- |
+    # | ip | IP of the user. Both IP4 and IP6 are valid |
+    # | email | The email id of the user you want to trust score on |
+    # | url | The URL on which the user is trying to purchase or consume a
+    # product, service or data. |
+    # ### Other optional paramters:
+    # The optional parameters are self-explanatory and appropriate values can be
+    # given in string format.
+    # | **Parameters** | **Values** |
+    # | --- | --- |
+    # | last_bets | String |
+    # | last_wins | String |
+    # | total_bonuses | String |
+    # | last_real_bets | String |
+    # | last_real_wins | String |
+    # | total_deposits | String |
+    # | last_bonus_bets | String |
+    # | last_bonus_wins | String |
+    # | average_real_bet | String |
+    # | last_bets_amount | String |
+    # | last_wins_amount | String |
+    # | average_bonus_bet | String |
+    # | bonus_to_deposits | String |
+    # | last_deposit_date | String |
+    # | total_withdrawals | String |
+    # | is_phone_confirmed | String |
+    # | money_in_money_out | String |
+    # | last_deposit_amount | String |
+    # | last_freespins_date | String |
+    # | last_freespins_name | String |
+    # | last_free_bonus_date | String |
+    # | last_free_bonus_name | String |
+    # | total_bonuses_amount | String |
+    # | last_freespins_amount | String |
+    # | last_freespins_status | String |
+    # | last_real_bets_amount | String |
+    # | last_real_wins_amount | String |
+    # | total_deposits_amount | String |
+    # | last_bonus_bets_amount | String |
+    # | last_bonus_wins_amount | String |
+    # | last_free_bonus_amount | String |
+    # | last_free_bonus_status | String |
+    # | last_deposit_bonus_date | String |
+    # | last_deposit_bonus_name | String |
+    # | last_freespins_currency | String |
+    # | last_freespins_wagering | String |
+    # | withdrawals_to_deposits | String |
+    # | last_free_bonus_currency | String |
+    # | last_free_bonus_wagering | String |
+    # | total_withdrawals_amount | String |
+    # | withdrawal_ewallet_email | String |
+    # | last_deposit_bonus_amount | String |
+    # | last_deposit_bonus_status | String |
+    # | last_deposit_bonus_currency | String |
+    # | last_deposit_bonus_wagering | String |
+    # | session | String |
+    # | payment_mode | String |
+    # | card_fullname | String |
+    # | card_bin | String |
+    # | card_hash | String |
+    # | card_last | String |
+    # | card_expire | String |
+    # | avs_result | String |
+    # | cvv_result | String |
+    # | sca_method | String |
+    # | user_bank_account | String |
+    # | user_bank_name | String |
+    # | user_balance | String |
+    # | user_verification_level | String |
+    # | status_3d | String |
+    # | regulation | String |
+    # | payment_provider | String |
+    # | phone_number | String |
+    # | transaction_type | String |
+    # | transaction_amount | String |
+    # | transaction_currency | String |
+    # | merchant_id | String |
+    # | details_url | String |
+    # | name | String |
+    # | person_type | String |
+    # | gender | String |
+    # ### Response
+    # Response contains a single parameter: `transactionAllowed` which can
+    # either be `YES` or `NO` .
+    # ``` json
+    # {
+    # "transactionAllowed" : "YES"
+    # }
+    #  ```
+    # If there are any errors then it'll be in the format of :
+    # ``` json
+    # {
+    #     "message": "descriptive error message",
+    #     "code": "error_code"
+    # }
+    #  ```
+    # ### Possible Error Messages
+    # the possible error codes one can get on calling this APIs are:
+    # | **Code** |
+    # | --- |
+    # | 400, 404, 401, 415, 405 |
+    # for example:
+    # | **Code** | **Error Messages** |
+    # | --- | --- |
+    # | 401 | Incorrect secret_key |
+    # | 401 | You are not Allowed to call this API service |
+    # @param [CheckTransactionAllowedRequest] body Required parameter: TODO:
+    # type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def check_transaction_allowed(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api/v1/checkTransAllowed',
+                                     Server::SERVER_3)
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json; charset=utf-8', key: 'content-type'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TrustScoreExists1.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 TrustScoreErrorException))
+        .execute
+    end
+  end
+end

data/lib/paysecure_api_documentation_live/client.rb

@@ -0,0 +1,163 @@
+# paysecure_api_documentation_live
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PaysecureApiDocumentationLive
+  #  paysecure_api_documentation_live client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Access to ap_is controller.
+    # @return [ApIsApi] Returns the controller instance.
+    def ap_is
+      @ap_is ||= ApIsApi.new @global_configuration
+    end
+
+    # Access to pay_in_api controller.
+    # @return [PayInApi] Returns the controller instance.
+    def pay_in_api
+      @pay_in_api ||= PayInApi.new @global_configuration
+    end
+
+    # Access to pay_out_api controller.
+    # @return [PayOutApi] Returns the controller instance.
+    def pay_out_api
+      @pay_out_api ||= PayOutApi.new @global_configuration
+    end
+
+    # Access to get_balance_api controller.
+    # @return [GetBalanceApi] Returns the controller instance.
+    def get_balance_api
+      @get_balance_api ||= GetBalanceApi.new @global_configuration
+    end
+
+    # Access to refund_api controller.
+    # @return [RefundApi] Returns the controller instance.
+    def refund_api
+      @refund_api ||= RefundApi.new @global_configuration
+    end
+
+    # Access to payout controller.
+    # @return [PayoutApi] Returns the controller instance.
+    def payout
+      @payout ||= PayoutApi.new @global_configuration
+    end
+
+    # Access to payin controller.
+    # @return [PayinApi] Returns the controller instance.
+    def payin
+      @payin ||= PayinApi.new @global_configuration
+    end
+
+    # Access to m_paypal_wallet controller.
+    # @return [MPaypalWalletApi] Returns the controller instance.
+    def m_paypal_wallet
+      @m_paypal_wallet ||= MPaypalWalletApi.new @global_configuration
+    end
+
+    # Access to m_virtual_cards_payout controller.
+    # @return [MVirtualCardsPayoutApi] Returns the controller instance.
+    def m_virtual_cards_payout
+      @m_virtual_cards_payout ||= MVirtualCardsPayoutApi.new @global_configuration
+    end
+
+    # Access to trust_score controller.
+    # @return [TrustScoreApi] Returns the controller instance.
+    def trust_score
+      @trust_score ||= TrustScoreApi.new @global_configuration
+    end
+
+    # Access to cashier_ap_is controller.
+    # @return [CashierApIsApi] Returns the controller instance.
+    def cashier_ap_is
+      @cashier_ap_is ||= CashierApIsApi.new @global_configuration
+    end
+
+    # Access to transaction_reporting controller.
+    # @return [TransactionReportingApi] Returns the controller instance.
+    def transaction_reporting
+      @transaction_reporting ||= TransactionReportingApi.new @global_configuration
+    end
+
+    # Access to get_balance_api_v2_orchestration controller.
+    # @return [GetBalanceApiV2OrchestrationApi] Returns the controller instance.
+    def get_balance_api_v2_orchestration
+      @get_balance_api_v2_orchestration ||= GetBalanceApiV2OrchestrationApi.new @global_configuration
+    end
+
+    # Access to global_collection controller.
+    # @return [GlobalCollectionApi] Returns the controller instance.
+    def global_collection
+      @global_collection ||= GlobalCollectionApi.new @global_configuration
+    end
+
+    # Access to payout_manual_review controller.
+    # @return [PayoutManualReviewApi] Returns the controller instance.
+    def payout_manual_review
+      @payout_manual_review ||= PayoutManualReviewApi.new @global_configuration
+    end
+
+    # Access to client controller.
+    # @return [Api] Returns the controller instance.
+    def client
+      @client ||= Api.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 30,
+      max_retries: 0, retry_interval: 1, backoff_factor: 2,
+      retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+      retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
+      logging_configuration: nil, environment: Environment::PRODUCTION,
+      bearer_auth_credentials: nil, config: nil
+    )
+      @config = if config.nil?
+                  Configuration.new(
+                    connection: connection, adapter: adapter, timeout: timeout,
+                    max_retries: max_retries, retry_interval: retry_interval,
+                    backoff_factor: backoff_factor,
+                    retry_statuses: retry_statuses,
+                    retry_methods: retry_methods, http_callback: http_callback,
+                    proxy_settings: proxy_settings,
+                    logging_configuration: logging_configuration,
+                    environment: environment,
+                    bearer_auth_credentials: bearer_auth_credentials
+                  )
+                else
+                  config
+                end
+      user_agent_params = BaseApi.user_agent_parameters
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseApi::GLOBAL_ERRORS)
+                                                 .user_agent(BaseApi.user_agent,
+                                                             agent_parameters: user_agent_params)
+
+      initialize_auth_managers(@global_configuration)
+      @global_configuration = @global_configuration.auth_managers(@auth_managers)
+    end
+
+    # Initializes the auth managers hash used for authenticating API calls.
+    # @param [GlobalConfiguration] global_config The global configuration of the SDK)
+    def initialize_auth_managers(global_config)
+      @auth_managers = {}
+      http_client_config = global_config.client_configuration
+      %w[bearer].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['bearer'] = Oauth2.new(http_client_config.bearer_auth_credentials)
+    end
+
+    # Creates a client directly from environment variables.
+    def self.from_env(**overrides)
+      default_config = Configuration.build_default_config_from_env
+      new_config = default_config.clone_with(**overrides)
+      new(config: new_config)
+    end
+  end
+end