pq-api-matic-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 971c24d9b86ec722646c3ad4f85fe1f67570fca40da5168cd581c4dde7b07381
+  data.tar.gz: 3fd46f87a0e676b9dafa3500f8c2b70a7601141354351a984e5fd406734e151a
+SHA512:
+  metadata.gz: 780623db68b5aea49561a03ec2ccbd9c19ccc52f39646344bc237bf7b27a8c4cc722a4c00373fd5f8f19324ae5466782e3c25a14f38ba5052a93221e25a6e5e2
+  data.tar.gz: eb9f24d33c6e5cf5f7dcdf196d6c53d908057db6dc812d0a8519e0f350150ce084c2c17de8a74a44b793c3ad1ed782d5e4816eabdd0ef5128ceda8ce684937bf

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,208 @@
+
+# Getting Started with PQ API v2
+
+## Introduction
+
+PayQuicker offers a secure and instant payout platform that delivers payment to a payee-owned and insured bank account linked to a debit card, similar to a standard checking account.
+
+As soon as the payment is made, funds are available in the insured account and available to spend instantly online through a virtual card, at retail with a plastic prepaid debit card, or by loading the card to a mobile wallet.
+
+PayQuicker provides a RESTful API that allows authorized clients to send and receive payments, debit user's accounts for spendback, retrieve user account balance, retrieve user reports, and retrieve transaction reports.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install pq-api-matic-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'pq-api-matic-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the pq-api-matic-sdk gem](https://rubygems.org/gems/pq-api-matic-sdk/versions/1.0.0).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'pay_quicker_sdk'
+include PayQuickerSdk
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/pay_quicker_sdk
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Test the SDK
+
+To run the tests, navigate to the root directory of the SDK in your terminal and execute the following command:
+
+```
+rake
+```
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| x_my_pay_quicker_version | `String` | Date-based API Version specified in the header *required* on all calls.<br>*Default*: `'2026.02.01'` |
+| sandbox_instance | `SandboxInstance` | Sandbox Environments<br>*Default*: `SandboxInstance::SANDBOX` |
+| uat_instance | `UatInstance` | UAT Environments<br>*Default*: `UatInstance::UAT1` |
+| environment | [`Environment`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 60** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| server_credentials | [`ServerCredentials`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| clientside_credentials | [`ClientsideCredentials`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'pay_quicker_sdk'
+include PayQuickerSdk
+
+client = Client.new(
+  x_my_pay_quicker_version: '2026.02.01',
+  server_credentials: ServerCredentials.new(
+    o_auth_client_id: 'OAuthClientId',
+    o_auth_client_secret: 'OAuthClientSecret',
+    o_auth_scopes: [
+      OAuthScopeServer::READONLY,
+      OAuthScopeServer::MODIFY
+    ]
+  ),
+  clientside_credentials: ClientsideCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  environment: Environment::SANDBOX,
+  sandbox_instance: SandboxInstance::SANDBOX,
+  uat_instance: UatInstance::UAT1,
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'pay_quicker_sdk'
+include PayQuickerSdk
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| PRODUCTION | Production |
+| SANDBOX | **Default** Sandbox is used for both sandbox testing and customer UAT. |
+| UAT | UAT is used for both sandbox testing and customer UAT. |
+| DEVELOPMENT | Development is used for local development testing. |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`server (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
+* [`clientside (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Agreements](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/agreements.md)
+* [Balances](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/balances.md)
+* [Bank Accounts](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/bank-accounts.md)
+* [Client Side](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/client-side.md)
+* [Compliance](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/compliance.md)
+* [Documents](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/documents.md)
+* [Electronic Wallets](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/electronic-wallets.md)
+* [Events](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/events.md)
+* [Invitations](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/invitations.md)
+* [Jobs](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/jobs.md)
+* [Payments](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/payments.md)
+* [Prepaid Cards](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/prepaid-cards.md)
+* [Program](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/program.md)
+* [Receipts](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/receipts.md)
+* [Spendback](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/spendback.md)
+* [Spendback Refunds](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/spendback-refunds.md)
+* [Statements](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/statements.md)
+* [Transfers](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/transfers.md)
+* [Users](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/users.md)
+* [Webhooks](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/controllers/webhooks.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/pq-api-matic-ruby-sdk/tree/1.0.0/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'pay_quicker_sdk'
+
+puts 'PayQuickerSdk SDK loaded!'
+puts 'You can now create a client with: client = PayQuickerSdk::Client.new'
+puts 'Or use from_env: client = PayQuickerSdk::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/pay_quicker_sdk/api_helper.rb

@@ -0,0 +1,10 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/pay_quicker_sdk/client.rb

@@ -0,0 +1,205 @@
+# pay_quicker_sdk
+#
+# This file was automatically generated for PayQuicker by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module PayQuickerSdk
+  #  pay_quicker_sdk client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Returns the configured authentication server instance.
+    def server
+      @auth_managers['server']
+    end
+
+    # Access to agreements controller.
+    # @return [AgreementsController] Returns the controller instance.
+    def agreements
+      @agreements ||= AgreementsController.new @global_configuration
+    end
+
+    # Access to balances controller.
+    # @return [BalancesController] Returns the controller instance.
+    def balances
+      @balances ||= BalancesController.new @global_configuration
+    end
+
+    # Access to bank_accounts controller.
+    # @return [BankAccountsController] Returns the controller instance.
+    def bank_accounts
+      @bank_accounts ||= BankAccountsController.new @global_configuration
+    end
+
+    # Access to client_side controller.
+    # @return [ClientSideController] Returns the controller instance.
+    def client_side
+      @client_side ||= ClientSideController.new @global_configuration
+    end
+
+    # Access to compliance controller.
+    # @return [ComplianceController] Returns the controller instance.
+    def compliance
+      @compliance ||= ComplianceController.new @global_configuration
+    end
+
+    # Access to documents controller.
+    # @return [DocumentsController] Returns the controller instance.
+    def documents
+      @documents ||= DocumentsController.new @global_configuration
+    end
+
+    # Access to electronic_wallets controller.
+    # @return [ElectronicWalletsController] Returns the controller instance.
+    def electronic_wallets
+      @electronic_wallets ||= ElectronicWalletsController.new @global_configuration
+    end
+
+    # Access to events controller.
+    # @return [EventsController] Returns the controller instance.
+    def events
+      @events ||= EventsController.new @global_configuration
+    end
+
+    # Access to payments controller.
+    # @return [PaymentsController] Returns the controller instance.
+    def payments
+      @payments ||= PaymentsController.new @global_configuration
+    end
+
+    # Access to prepaid_cards controller.
+    # @return [PrepaidCardsController] Returns the controller instance.
+    def prepaid_cards
+      @prepaid_cards ||= PrepaidCardsController.new @global_configuration
+    end
+
+    # Access to program controller.
+    # @return [ProgramController] Returns the controller instance.
+    def program
+      @program ||= ProgramController.new @global_configuration
+    end
+
+    # Access to receipts controller.
+    # @return [ReceiptsController] Returns the controller instance.
+    def receipts
+      @receipts ||= ReceiptsController.new @global_configuration
+    end
+
+    # Access to spendback controller.
+    # @return [SpendbackController] Returns the controller instance.
+    def spendback
+      @spendback ||= SpendbackController.new @global_configuration
+    end
+
+    # Access to spendback_refunds controller.
+    # @return [SpendbackRefundsController] Returns the controller instance.
+    def spendback_refunds
+      @spendback_refunds ||= SpendbackRefundsController.new @global_configuration
+    end
+
+    # Access to statements controller.
+    # @return [StatementsController] Returns the controller instance.
+    def statements
+      @statements ||= StatementsController.new @global_configuration
+    end
+
+    # Access to transfers controller.
+    # @return [TransfersController] Returns the controller instance.
+    def transfers
+      @transfers ||= TransfersController.new @global_configuration
+    end
+
+    # Access to users controller.
+    # @return [UsersController] Returns the controller instance.
+    def users
+      @users ||= UsersController.new @global_configuration
+    end
+
+    # Access to webhooks controller.
+    # @return [WebhooksController] Returns the controller instance.
+    def webhooks
+      @webhooks ||= WebhooksController.new @global_configuration
+    end
+
+    # Access to jobs controller.
+    # @return [JobsController] Returns the controller instance.
+    def jobs
+      @jobs ||= JobsController.new @global_configuration
+    end
+
+    # Access to invitations controller.
+    # @return [InvitationsController] Returns the controller instance.
+    def invitations
+      @invitations ||= InvitationsController.new @global_configuration
+    end
+
+    # Access to o_auth_authorization controller.
+    # @return [OAuthAuthorizationController] Returns the controller instance.
+    def o_auth_authorization
+      @o_auth_authorization ||= OAuthAuthorizationController.new @global_configuration
+    end
+
+    def initialize(
+      connection: nil, adapter: :net_http_persistent, timeout: 60,
+      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::SANDBOX,
+      sandbox_instance: SandboxInstance::SANDBOX,
+      uat_instance: UatInstance::UAT1, server_credentials: nil,
+      clientside_credentials: nil, x_my_pay_quicker_version: '2026.02.01',
+      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,
+                    sandbox_instance: sandbox_instance,
+                    uat_instance: uat_instance,
+                    server_credentials: server_credentials,
+                    clientside_credentials: clientside_credentials,
+                    x_my_pay_quicker_version: x_my_pay_quicker_version
+                  )
+                else
+                  config
+                end
+
+      @global_configuration = GlobalConfiguration.new(client_configuration: @config)
+                                                 .base_uri_executor(@config.method(:get_base_uri))
+                                                 .global_errors(BaseController::GLOBAL_ERRORS)
+                                                 .user_agent(BaseController.user_agent)
+                                                 .global_header('X-MyPayQuicker-Version', @config.x_my_pay_quicker_version)
+
+      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[server clientside].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['server'] = Server.new(http_client_config.server_credentials, global_config)
+      @auth_managers['clientside'] = Clientside.new(http_client_config.clientside_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