apimatic-greendot-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72c9b6ff3103cee9ab7b3382ddc622cb4616891277405417be6d0ca0b74e25b2
+  data.tar.gz: d985758e3dca3574d179fc6df26244334688dd3c74921b9a99c228751044057f
+SHA512:
+  metadata.gz: 6af3592118d38a8545fb7cb13312761ae3c53ac24c2d63ab42c17de760b7d6636f6b64e43a4aac9cae72a831f5b935f8f6e5260f94bfe39f231aeff586563d7d
+  data.tar.gz: 54828c740971305146b3ca0951cc34691a7c05ac89bffbff06a9ab444327b34140fe044f6de84fbcbeea32dcb4958491e7a7de39bd9bbcd640194dce1eb84794

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,214 @@
+
+# Getting Started with Gd.Bos.V1
+
+## Introduction
+
+Green Dot BaaS Partner API
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install apimatic-greendot-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'apimatic-greendot-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the apimatic-greendot-sdk gem](https://rubygems.org/gems/apimatic-greendot-sdk/versions/0.0.1).
+
+## 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 'gd_bos_v1'
+include GdBosV1
+```
+
+### 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/gd_bos_v1
+```
+
+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/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| default_host | `String` | *Default*: `'www.example.com'` |
+| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/README.md#environments) | 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. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| custom_header_authentication_credentials | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'gd_bos_v1'
+include GdBosV1
+
+client = Client.new(
+  custom_header_authentication_credentials: CustomHeaderAuthenticationCredentials.new(
+    authorization: 'Authorization'
+  ),
+  environment: Environment::PRODUCTION,
+  default_host: 'www.example.com',
+  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 'gd_bos_v1'
+include GdBosV1
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/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 | **Default** |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`Bearer (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/auth/custom-header-signature.md)
+
+## List of APIs
+
+* [Health Checks](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/health-checks.md)
+* [AB Testing Admin](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/ab-testing-admin.md)
+* [Account](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/account.md)
+* [Adjustment](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/adjustment.md)
+* [Affiliate](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/affiliate.md)
+* [AMM Rule](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/amm-rule.md)
+* [Authentication](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/authentication.md)
+* [Bill Pay](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/bill-pay.md)
+* [Business Profile](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/business-profile.md)
+* [Card Option](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/card-option.md)
+* [Care Case](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/care-case.md)
+* [Cashback Reward](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/cashback-reward.md)
+* [Categorize Transaction](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/categorize-transaction.md)
+* [Contact Verification](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/contact-verification.md)
+* [Credit Builder](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/credit-builder.md)
+* [Custom Card](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/custom-card.md)
+* [Device Verification](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/device-verification.md)
+* [Direct Deposit](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/direct-deposit.md)
+* [Disbursement](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/disbursement.md)
+* [Dispute Automation](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/dispute-automation.md)
+* [E Cash](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/e-cash.md)
+* [E Gift](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/e-gift.md)
+* [Enrollments](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/enrollments.md)
+* [Event](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/event.md)
+* [Experian](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/experian.md)
+* [External Account](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/external-account.md)
+* [External Cards](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/external-cards.md)
+* [Feature Eligibility](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/feature-eligibility.md)
+* [Fee](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/fee.md)
+* [Guest Verification](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/guest-verification.md)
+* [Health Check](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/health-check.md)
+* [Hosted User Experience](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/hosted-user-experience.md)
+* [Interest Rate](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/interest-rate.md)
+* [Kyc](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/kyc.md)
+* [Locator](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/locator.md)
+* [Notification](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/notification.md)
+* [Order](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/order.md)
+* [Paper Check](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/paper-check.md)
+* [Payment](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/payment.md)
+* [Payment Instrument](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/payment-instrument.md)
+* [Payment Instrument Token](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/payment-instrument-token.md)
+* [Payment Instrument Vgs](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/payment-instrument-vgs.md)
+* [Product Feature Limits](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/product-feature-limits.md)
+* [Products](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/products.md)
+* [Program](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/program.md)
+* [Purse](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/purse.md)
+* [Scc](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/scc.md)
+* [Scc Eligibilities](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/scc-eligibilities.md)
+* [Token Management](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/token-management.md)
+* [Transaction Event](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/transaction-event.md)
+* [Transactions](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/transactions.md)
+* [Transfers](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/transfers.md)
+* [Users](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/users.md)
+* [VIP Feature](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/controllers/vip-feature.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-greendot-ruby-sdk/tree/0.0.1/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 'gd_bos_v1'
+
+puts 'GdBosV1 SDK loaded!'
+puts 'You can now create a client with: client = GdBosV1::Client.new'
+puts 'Or use from_env: client = GdBosV1::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/gd_bos_v1/api_helper.rb

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

data/lib/gd_bos_v1/apis/ab_testing_admin_api.rb

@@ -0,0 +1,89 @@
+# gd_bos_v1
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module GdBosV1
+  # AbTestingAdminApi
+  class AbTestingAdminApi < BaseApi
+    # Retrieves the AB testing policy for the specified type. The policy type
+    # must be a valid value from the ABTestingPolicyType enumeration.
+    # @param [String] policy_type Required parameter: The type of AB testing
+    # policy to retrieve. Valid values are "Adjustment" or "Transfer".
+    # @param [String] x_gd_request_id Required parameter: Request ID
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_ab_testing_policy(policy_type,
+                              x_gd_request_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/abtestingadmin/policy/{policyType}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(policy_type, key: 'policyType')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetAbTestingPolicyResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 GetAbTestingPolicyResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 GetAbTestingPolicyResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 GetAbTestingPolicyResponseErrorException))
+        .execute
+    end
+
+    # Updates the AB testing policy for the specified type. The policy must have
+    # a valid percentage (0-100) and a non-negative amount threshold.
+    # @param [String] x_gd_request_id Required parameter: Request ID
+    # @param [SetAbTestingPolicyRequest] body Optional parameter: The request
+    # payload containing the AB testing policy details to update.   -
+    # <b>PolicyType</b>: The type of AB testing policy ("Adjustment" or
+    # "Transfer").   - <b>Expiry</b>: The expiration time span for the policy.
+    # - <b>Policy</b>: The policy details, including percentage, amount
+    # threshold, and other settings.
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def set_ab_testing_policy(x_gd_request_id,
+                              body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/abtestingadmin/policy',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter(x_gd_request_id, key: 'X-GD-RequestId')
+                                  .is_required(true))
+                   .header_param(new_parameter('application/json-patch+json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('Bearer')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SetAbTestingPolicyResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 APIException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 SetAbTestingPolicyResponseErrorException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 SetAbTestingPolicyResponseErrorException)
+                    .local_error('503',
+                                 'Service Unavailable',
+                                 SetAbTestingPolicyResponseErrorException))
+        .execute
+    end
+  end
+end