pnz-payments-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f99dbba022e67d5251e809c1c9b8fbc5e99243071bc0896a7ec87c13f21f4127
+  data.tar.gz: c0e6f1a93b48253d3aea1a6651da5736e3007e7994fdc26cfb89fdeec4bde9e2
+SHA512:
+  metadata.gz: 47464041a823b74b69a61d90546df5f238636da68c9f41eb61ec7924335c22446f0365010bdd7267375ca0cd6d87d3dfb050227eba0cfb1adcff501518ae4798
+  data.tar.gz: 1d3c0e9194ba8a5e68634ab675f8f5d5a4ec57261ca1ba129db31c78f75bcb094b0a7d5dcfb2ef2c1f02a6f929a106f25a3eba12f258158b5ddc316f65ff89c9

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2025 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,98 @@
+
+# Getting Started with Account and Transaction API Specification
+
+## Introduction
+
+Swagger for Account and Transaction API Specification. This is heavily derived from the Open Banking UK API - see www.openbanking.org.uk for details.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install pnz-payments-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'pnz-payments-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the pnz-payments-sdk gem](https://rubygems.org/gems/pnz-payments-sdk/versions/1.0.0).
+
+## 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/pnz-payments-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| `environment` | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
+| `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. |
+| `bearer_auth_credentials` | [`BearerAuthCredentials`](https://www.github.com/sdks-io/pnz-payments-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:
+
+```ruby
+client = AccountAndTransactionApiSpecification::Client.new(
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  environment: Environment::PRODUCTION
+)
+```
+
+## Environments
+
+The SDK can be configured to use a different environment for making API calls. Available environments are:
+
+### Fields
+
+| Name | Description |
+|  --- | --- |
+| production | **Default** |
+| environment2 | - |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`HTTPBearerAuthentication (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Direct Debits](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/direct-debits.md)
+* [Scheduled Payments](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/scheduled-payments.md)
+* [Standing Orders](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/standing-orders.md)
+* [Accounts](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/accounts.md)
+* [Balances](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/balances.md)
+* [Beneficiaries](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/beneficiaries.md)
+* [Offers](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/offers.md)
+* [Party](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/party.md)
+* [Statements](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/statements.md)
+* [Transactions](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/controllers/transactions.md)
+
+## Classes Documentation
+
+* [Utility Classes](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/utility-classes.md)
+* [HttpResponse](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/pnz-payments-ruby-sdk/tree/1.0.0/doc/http-request.md)
+

data/lib/account_and_transaction_api_specification/api_helper.rb

@@ -0,0 +1,10 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/account_and_transaction_api_specification/client.rb

@@ -0,0 +1,114 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  #  account_and_transaction_api_specification client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    # Access to accounts controller.
+    # @return [AccountsController] Returns the controller instance.
+    def accounts
+      @accounts ||= AccountsController.new @global_configuration
+    end
+
+    # Access to balances controller.
+    # @return [BalancesController] Returns the controller instance.
+    def balances
+      @balances ||= BalancesController.new @global_configuration
+    end
+
+    # Access to beneficiaries controller.
+    # @return [BeneficiariesController] Returns the controller instance.
+    def beneficiaries
+      @beneficiaries ||= BeneficiariesController.new @global_configuration
+    end
+
+    # Access to direct_debits controller.
+    # @return [DirectDebitsController] Returns the controller instance.
+    def direct_debits
+      @direct_debits ||= DirectDebitsController.new @global_configuration
+    end
+
+    # Access to offers controller.
+    # @return [OffersController] Returns the controller instance.
+    def offers
+      @offers ||= OffersController.new @global_configuration
+    end
+
+    # Access to party controller.
+    # @return [PartyController] Returns the controller instance.
+    def party
+      @party ||= PartyController.new @global_configuration
+    end
+
+    # Access to scheduled_payments controller.
+    # @return [ScheduledPaymentsController] Returns the controller instance.
+    def scheduled_payments
+      @scheduled_payments ||= ScheduledPaymentsController.new @global_configuration
+    end
+
+    # Access to standing_orders controller.
+    # @return [StandingOrdersController] Returns the controller instance.
+    def standing_orders
+      @standing_orders ||= StandingOrdersController.new @global_configuration
+    end
+
+    # Access to statements controller.
+    # @return [StatementsController] Returns the controller instance.
+    def statements
+      @statements ||= StatementsController.new @global_configuration
+    end
+
+    # Access to transactions controller.
+    # @return [TransactionsController] Returns the controller instance.
+    def transactions
+      @transactions ||= TransactionsController.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,
+      environment: Environment::PRODUCTION, access_token: nil,
+      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,
+                    environment: environment, access_token: access_token,
+                    bearer_auth_credentials: bearer_auth_credentials
+                  )
+                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)
+
+      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[HTTPBearerAuthentication].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['HTTPBearerAuthentication'] = OAuth2.new(
+        http_client_config.bearer_auth_credentials
+      )
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/configuration.rb

@@ -0,0 +1,127 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # An enum for SDK environments.
+  class Environment
+    ENVIRONMENT = [
+      PRODUCTION = 'production'.freeze,
+      ENVIRONMENT2 = 'environment2'.freeze
+    ].freeze
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze
+    ].freeze
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    def access_token
+      @bearer_auth_credentials.access_token
+    end
+
+    # The attribute readers for properties.
+    attr_reader :environment, :bearer_auth_credentials
+
+    class << self
+      attr_reader :environments
+    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,
+      environment: Environment::PRODUCTION, access_token: nil,
+      bearer_auth_credentials: nil
+    )
+
+      super 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
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The OAuth 2.0 Access Token to use for API requests.
+      @access_token = access_token
+
+      # Initializing OAuth 2 Bearer token credentials with the provided auth parameters
+      @bearer_auth_credentials = create_auth_credentials_object(
+        access_token, bearer_auth_credentials
+      )
+
+      # The Http Client to use for making requests.
+      set_http_client CoreLibrary::FaradayClient.new(self)
+    end
+
+    def clone_with(connection: nil, adapter: nil, timeout: nil,
+                   max_retries: nil, retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, http_callback: nil,
+                   environment: nil, access_token: nil,
+                   bearer_auth_credentials: nil)
+      connection ||= self.connection
+      adapter ||= self.adapter
+      timeout ||= self.timeout
+      max_retries ||= self.max_retries
+      retry_interval ||= self.retry_interval
+      backoff_factor ||= self.backoff_factor
+      retry_statuses ||= self.retry_statuses
+      retry_methods ||= self.retry_methods
+      http_callback ||= self.http_callback
+      environment ||= self.environment
+      bearer_auth_credentials = create_auth_credentials_object(
+        access_token, bearer_auth_credentials || self.bearer_auth_credentials
+      )
+
+      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, environment: environment,
+                        bearer_auth_credentials: bearer_auth_credentials)
+    end
+
+    def create_auth_credentials_object(access_token, bearer_auth_credentials)
+      return bearer_auth_credentials if access_token.nil?
+
+      warn('The \'access_token\' params are deprecated. Use \'bearer_auth_cred'\
+           'entials\' param instead.')
+
+      unless bearer_auth_credentials.nil?
+        return bearer_auth_credentials.clone_with(
+          access_token: access_token
+        )
+      end
+
+      BearerAuthCredentials.new(access_token: access_token)
+    end
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://api-nomatls.apicentre.middleware.co.nz/open-banking-nz/v2.3'
+      },
+      Environment::ENVIRONMENT2 => {
+        Server::DEFAULT => 'https://authserver.example'
+      }
+    }.freeze
+
+    # Generates the appropriate base URI for the environment and the server.
+    # @param [Configuration::Server] server The server enum for which the base URI is
+    # required.
+    # @return [String] The base URI.
+    def get_base_uri(server = Server::DEFAULT)
+      ENVIRONMENTS[environment][server].clone
+    end
+  end
+end

data/lib/account_and_transaction_api_specification/controllers/accounts_controller.rb

@@ -0,0 +1,146 @@
+# account_and_transaction_api_specification
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module AccountAndTransactionApiSpecification
+  # AccountsController
+  class AccountsController < BaseController
+    # Get an account
+    # @param [String] account_id Required parameter: A unique identifier used to
+    # identify the account resource.
+    # @param [String] x_fapi_auth_date Optional parameter: The time when the
+    # Customer last logged in with the Third Party. All dates in the HTTP
+    # headers are represented as RFC 7231 Full Dates. An example is below: Sun,
+    # 10 Sep 2017 19:43:31 UTC
+    # @param [String] x_fapi_customer_ip_address Optional parameter: The
+    # Customer's IP address if the Customer is currently logged in with the
+    # Third Party.
+    # @param [String] x_fapi_interaction_id Optional parameter: An RFC4122 UID
+    # used as a correlation id.
+    # @param [String] x_merchant_ip_address Optional parameter: The IP address
+    # of the merchant when making account information requests through a Third
+    # Party.
+    # @param [String] x_customer_user_agent Optional parameter: The User-Agent
+    # of the application on the customer device that is used to make the account
+    # information request
+    # @return [AccountResponse] response from the API call.
+    def get_account(account_id,
+                    x_fapi_auth_date: nil,
+                    x_fapi_customer_ip_address: nil,
+                    x_fapi_interaction_id: nil,
+                    x_merchant_ip_address: nil,
+                    x_customer_user_agent: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts/{AccountId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(account_id, key: 'AccountId')
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_fapi_auth_date, key: 'x-fapi-auth-date'))
+                   .header_param(new_parameter(x_fapi_customer_ip_address, key: 'x-fapi-customer-ip-address'))
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id'))
+                   .header_param(new_parameter(x_merchant_ip_address, key: 'x-merchant-ip-address'))
+                   .header_param(new_parameter(x_customer_user_agent, key: 'x-customer-user-agent'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('HTTPBearerAuthentication')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountResponse.method(:from_hash))
+                    .local_error('400',
+                                 'Bad Request',
+                                 Accounts400ErrorException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 Accounts403ErrorException)
+                    .local_error('405',
+                                 'Method Not Allowed',
+                                 APIException)
+                    .local_error('406',
+                                 'Not Acceptable',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 APIException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 Accounts500ErrorException)
+                    .local_error('501',
+                                 'Not Implemented',
+                                 APIException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 Accounts503ErrorException))
+        .execute
+    end
+
+    # Get a list of accounts
+    # @param [String] x_fapi_auth_date Optional parameter: The time when the
+    # Customer last logged in with the Third Party. All dates in the HTTP
+    # headers are represented as RFC 7231 Full Dates. An example is below: Sun,
+    # 10 Sep 2017 19:43:31 UTC
+    # @param [String] x_fapi_customer_ip_address Optional parameter: The
+    # Customer's IP address if the Customer is currently logged in with the
+    # Third Party.
+    # @param [String] x_fapi_interaction_id Optional parameter: An RFC4122 UID
+    # used as a correlation id.
+    # @param [String] x_merchant_ip_address Optional parameter: The IP address
+    # of the merchant when making account information requests through a Third
+    # Party.
+    # @param [String] x_customer_user_agent Optional parameter: The User-Agent
+    # of the application on the customer device that is used to make the account
+    # information request
+    # @return [AccountResponse] response from the API call.
+    def get_accounts(x_fapi_auth_date: nil,
+                     x_fapi_customer_ip_address: nil,
+                     x_fapi_interaction_id: nil,
+                     x_merchant_ip_address: nil,
+                     x_customer_user_agent: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/accounts',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_fapi_auth_date, key: 'x-fapi-auth-date'))
+                   .header_param(new_parameter(x_fapi_customer_ip_address, key: 'x-fapi-customer-ip-address'))
+                   .header_param(new_parameter(x_fapi_interaction_id, key: 'x-fapi-interaction-id'))
+                   .header_param(new_parameter(x_merchant_ip_address, key: 'x-merchant-ip-address'))
+                   .header_param(new_parameter(x_customer_user_agent, key: 'x-customer-user-agent'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('HTTPBearerAuthentication')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountResponse.method(:from_hash))
+                    .local_error('400',
+                                 'Bad Request',
+                                 Accounts400ErrorException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 Accounts403ErrorException)
+                    .local_error('405',
+                                 'Method Not Allowed',
+                                 APIException)
+                    .local_error('406',
+                                 'Not Acceptable',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 APIException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 Accounts500ErrorException)
+                    .local_error('501',
+                                 'Not Implemented',
+                                 APIException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 Accounts503ErrorException))
+        .execute
+    end
+  end
+end