apimatic-stax-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85c9d71e81be1ac3a551ced833897dbf3665c6a700466614415724c76b82e592
+  data.tar.gz: bd15d0a7ad167182cc72454187904b37c46244a7d9f753255799a7a45884dd3e
+SHA512:
+  metadata.gz: 8e3c7ea4b61b376ec1963b2166ee39f92b49effa70487477b6cd5a4cfa085748d32fc9eb244d02b4bc0d28d6eb0c3d15df8f06d1953084097c3371b7be185c7c
+  data.tar.gz: c04ef722c5f188627476ef7e622fdbe5a30d44edf20bb2cc124852588a44138dc6339d4c21d129b0192ef2d994bfc45b9d647d4acc8c955ace1e6fedf8138845

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,189 @@
+
+# Getting Started with Stax (FattMerchant) API
+
+## Introduction
+
+API specification auto-generated from Laravel route definitions.
+Base URL: https://apiprod.fattlabs.com
+All routes require JWT authentication unless otherwise noted.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install apimatic-stax-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'apimatic-stax-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the apimatic-stax-sdk gem](https://rubygems.org/gems/apimatic-stax-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 'stax_fatt_merchant_api'
+include StaxFattMerchantApi
+```
+
+### 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/stax_fatt_merchant_api
+```
+
+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-stax-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-stax-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: 30** |
+| 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-stax-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-stax-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| bearer_auth_credentials | [`BearerAuthCredentials`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/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 'stax_fatt_merchant_api'
+include StaxFattMerchantApi
+
+client = Client.new(
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  environment: Environment::PRODUCTION,
+  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 'stax_fatt_merchant_api'
+include StaxFattMerchantApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/apimatic-stax-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** Production |
+| ENVIRONMENT2 | Development |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`bearerAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Team Users](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/team-users.md)
+* [Team API Keys](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/team-api-keys.md)
+* [Team Options](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/team-options.md)
+* [Team Registration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/team-registration.md)
+* [Team Funding Accounts](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/team-funding-accounts.md)
+* [Invoice Schedule](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/invoice-schedule.md)
+* [Dispute File](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/dispute-file.md)
+* [Payment Method](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/payment-method.md)
+* [Merchant Admin](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/merchant-admin.md)
+* [User Admin](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/user-admin.md)
+* [Web Payment](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/web-payment.md)
+* [Self](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/self.md)
+* [Team](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/team.md)
+* [Webhook](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/webhook.md)
+* [Transaction](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/transaction.md)
+* [Invoice](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/invoice.md)
+* [Customer](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/customer.md)
+* [Item](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/item.md)
+* [File](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/file.md)
+* [Integration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/integration.md)
+* [Hello Sign](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/hello-sign.md)
+* [Reporting](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/reporting.md)
+* [Charge](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/charge.md)
+* [Credit](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/credit.md)
+* [Verify](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/verify.md)
+* [Terminal](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/terminal.md)
+* [Sandbox](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/sandbox.md)
+* [Cache](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/controllers/cache.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/apimatic-stax-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/apimatic-stax-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 'stax_fatt_merchant_api'
+
+puts 'StaxFattMerchantApi SDK loaded!'
+puts 'You can now create a client with: client = StaxFattMerchantApi::Client.new'
+puts 'Or use from_env: client = StaxFattMerchantApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/stax_fatt_merchant_api/api_helper.rb

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

data/lib/stax_fatt_merchant_api/apis/base_api.rb

@@ -0,0 +1,67 @@
+# stax_fatt_merchant_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module StaxFattMerchantApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    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

data/lib/stax_fatt_merchant_api/apis/cache_api.rb

@@ -0,0 +1,28 @@
+# stax_fatt_merchant_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module StaxFattMerchantApi
+  # CacheApi
+  class CacheApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [PostCacheTestRequestBodyJson] body Optional parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_cache_test(body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/ebworker/cachetest',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/stax_fatt_merchant_api/apis/charge_api.rb

@@ -0,0 +1,29 @@
+# stax_fatt_merchant_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module StaxFattMerchantApi
+  # ChargeApi
+  class ChargeApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [Object] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_charge(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/charge',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(APIHelper.method(:json_serialize))
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/stax_fatt_merchant_api/apis/credit_api.rb

@@ -0,0 +1,29 @@
+# stax_fatt_merchant_api
+#
+# This file was automatically generated by APIMATIC
+# v3.0 ( https://www.apimatic.io ).
+
+module StaxFattMerchantApi
+  # CreditApi
+  class CreditApi < BaseApi
+    # TODO: type endpoint description here
+    # @param [PostCreditRequestBodyJson] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def post_credit(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/credit',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('bearerAuth')))
+        .response(new_response_handler
+                    .is_response_void(true)
+                    .is_api_response(true))
+        .execute
+    end
+  end
+end