splitit-apimatic-sdk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ac04d43312fd0cd38ea01736c8d1b2ebf13a95c07c9f3b95dbc2757a935dfbf5
+  data.tar.gz: e75a823afabd968f7c070ac15e9b558084e1a7f3441c2a4537067c299c112144
+SHA512:
+  metadata.gz: 2e5fc13544cc8ed97e4a86cd1abfe4c58e1576c136557c912704dd24bfa10093b9e7d0bc3fea7f0694d9b964fb1c013c20f26db50e67bb1e0b1b848e33fe578f
+  data.tar.gz: 8e5f15aca554fd628717fe792b7358c4dc39776ce534e59834199f538deb7b4b0b7b9d26fc85b5b257c1707f85e5a720905acab749138131765b22a8dbf8b0b9

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,154 @@
+
+# Getting Started with splitit-web-api-v4
+
+## Introduction
+
+Splitit Orchestration API for managing installment plans.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install splitit-apimatic-sdk -v 1.0.0
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'splitit-apimatic-sdk', '1.0.0'
+```
+
+For additional gem details, see the [RubyGems page for the splitit-apimatic-sdk gem](https://rubygems.org/gems/splitit-apimatic-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 'splitit_web_api_v4'
+include SplititWebApiV4
+```
+
+### 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/splitit_web_api_v4
+```
+
+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/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/splitit-apimatic-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/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| o_auth_2_credentials | [`OAuth2Credentials`](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+| api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/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 'splitit_web_api_v4'
+include SplititWebApiV4
+
+client = Client.new(
+  o_auth2_credentials: OAuth2Credentials.new(
+    o_auth_client_id: 'OAuthClientId',
+    o_auth_client_secret: 'OAuthClientSecret',
+    o_auth_scopes: [
+      OAuthScopeOAuth2Enum::API_V4
+    ]
+  ),
+  api_key_credentials: ApiKeyCredentials.new(
+    x_splitit_api_key: 'X-Splitit-Api-Key'
+  ),
+  environment: Environment::SANDBOX
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'splitit_web_api_v4'
+include SplititWebApiV4
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/splitit-apimatic-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 |
+|  --- | --- |
+| SANDBOX | **Default** Sandbox Environment (Transactional API) |
+| PRODUCTION | Production Environment (Transactional API) |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`OAuth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
+* [`ApiKey (Custom Header Signature)`](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/auth/custom-header-signature.md)
+
+## List of APIs
+
+* [Installment Plan](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/controllers/installment-plan.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/sdks-io/splitit-apimatic-ruby-sdk/tree/1.0.0/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/splitit-apimatic-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 'splitit_web_api_v4'
+
+puts 'SplititWebApiV4 SDK loaded!'
+puts 'You can now create a client with: client = SplititWebApiV4::Client.new'
+puts 'Or use from_env: client = SplititWebApiV4::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/splitit_web_api_v4/api_helper.rb

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

data/lib/splitit_web_api_v4/client.rb

@@ -0,0 +1,83 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  #  splitit_web_api_v4 client class.
+  class Client
+    include CoreLibrary
+    attr_reader :config, :auth_managers
+
+    def user_agent_detail
+      config.user_agent_detail
+    end
+
+    # Returns the configured authentication OAuth2 instance.
+    def o_auth2
+      @auth_managers['OAuth2']
+    end
+
+    # Access to installment_plan controller.
+    # @return [InstallmentPlanController] Returns the controller instance.
+    def installment_plan
+      @installment_plan ||= InstallmentPlanController.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,
+      environment: Environment::SANDBOX, o_auth2_credentials: nil,
+      api_key_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,
+                                    environment: environment,
+                                    o_auth2_credentials: o_auth2_credentials,
+                                    api_key_credentials: api_key_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[OAuth2 ApiKey].each { |auth| @auth_managers[auth] = nil }
+      @auth_managers['OAuth2'] = OAuth2.new(http_client_config.o_auth2_credentials, global_config)
+      @auth_managers['ApiKey'] = ApiKey.new(http_client_config.api_key_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

data/lib/splitit_web_api_v4/configuration.rb

@@ -0,0 +1,188 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # An enum for SDK environments.
+  class Environment
+    # SANDBOX: Sandbox Environment (Transactional API)
+    # PRODUCTION: Production Environment (Transactional API)
+    ENVIRONMENT = [
+      SANDBOX = 'Sandbox'.freeze,
+      PRODUCTION = 'Production'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Environment constant.
+    def self.from_value(value, default_value = SANDBOX)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'sandbox' then SANDBOX
+      when 'production' then PRODUCTION
+
+      else
+        warn "[Environment] Unknown environment '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # An enum for API servers.
+  class Server
+    SERVER = [
+      DEFAULT = 'default'.freeze,
+      ACCESS_TOKEN_SERVER = 'access token server'.freeze
+    ].freeze
+
+    # Converts a string or symbol into a valid Server constant.
+    def self.from_value(value, default_value = DEFAULT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip.downcase
+      case str
+      when 'default' then DEFAULT
+      when 'access_token_server' then ACCESS_TOKEN_SERVER
+
+      else
+        warn "[Server] Unknown server '#{value}', falling back to #{default_value} "
+        default_value
+      end
+    end
+  end
+
+  # All configuration including auth info and base URI for the API access
+  # are configured in this class.
+  class Configuration < CoreLibrary::HttpClientConfiguration
+    # The attribute readers for properties.
+    attr_reader :environment, :o_auth2_credentials, :api_key_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, proxy_settings: nil,
+      environment: Environment::SANDBOX, o_auth2_credentials: nil,
+      api_key_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,
+            proxy_settings: proxy_settings
+
+      # Current API environment
+      @environment = String(environment)
+
+      # The object holding OAuth 2 Client Credentials Grant credentials
+      @o_auth2_credentials = o_auth2_credentials
+
+      # The object holding Custom Header Signature credentials
+      @api_key_credentials = api_key_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,
+                   proxy_settings: nil, environment: nil,
+                   o_auth2_credentials: nil, api_key_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
+      proxy_settings ||= self.proxy_settings
+      environment ||= self.environment
+      o_auth2_credentials ||= self.o_auth2_credentials
+      api_key_credentials ||= self.api_key_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,
+                        proxy_settings: proxy_settings,
+                        environment: environment,
+                        o_auth2_credentials: o_auth2_credentials,
+                        api_key_credentials: api_key_credentials)
+    end
+
+
+    # All the environments the SDK can run in.
+    ENVIRONMENTS = {
+      Environment::SANDBOX => {
+        Server::DEFAULT => 'https://orch-api.sandbox.splitit.com',
+        Server::ACCESS_TOKEN_SERVER => 'https://id.sandbox.splitit.com/connect'
+      },
+      Environment::PRODUCTION => {
+        Server::DEFAULT => 'https://orch-api.splitit.com',
+        Server::ACCESS_TOKEN_SERVER => 'https://id.sandbox.splitit.com/connect'
+      }
+    }.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
+
+    # Builds a Configuration instance using environment variables.
+    def self.build_default_config_from_env
+      # === Core environment ===
+      environment = Environment.from_value(ENV.fetch('ENVIRONMENT', 'sandbox'))
+      timeout = (ENV['TIMEOUT'] || 60).to_f
+      max_retries = (ENV['MAX_RETRIES'] || 0).to_i
+      retry_interval = (ENV['RETRY_INTERVAL'] || 1).to_f
+      backoff_factor = (ENV['BACKOFF_FACTOR'] || 2).to_f
+      retry_statuses = ENV.fetch('RETRY_STATUSES',
+                                 '[408, 413, 429, 500, 502, 503, 504, 521, 522, 524]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+      retry_methods = ENV.fetch('RETRY_METHODS', '%i[get put]').gsub(/[\[\]]/, '')
+                                          .split(',')
+                                          .map(&:strip)
+                                          .map do |item|
+                                            item.match?(/\A\d+\z/) ? item.to_i : item.downcase
+                                          end
+
+      # === Authentication credentials ===
+      o_auth2_credentials = OAuth2Credentials.from_env
+      api_key_credentials = ApiKeyCredentials.from_env
+
+      # === Proxy settings ===
+      proxy_settings = ProxySettings.from_env
+
+      Configuration.new(
+        environment: environment,
+        timeout: timeout,
+        max_retries: max_retries,
+        retry_interval: retry_interval,
+        backoff_factor: backoff_factor,
+        retry_statuses: retry_statuses,
+        retry_methods: retry_methods,
+        o_auth2_credentials: o_auth2_credentials,
+        api_key_credentials: api_key_credentials,
+        proxy_settings: proxy_settings
+      )
+    end
+  end
+end

data/lib/splitit_web_api_v4/controllers/base_controller.rb

@@ -0,0 +1,60 @@
+# splitit_web_api_v4
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module SplititWebApiV4
+  # BaseController.
+  class BaseController
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'APIMATIC 3.0'
+    end
+
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end