orb-apiamtic-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ccb6cecf1f792c51e77396955e745e36a4f04f1c3dcbcb479f39687bf7535a7c
+  data.tar.gz: 304866c90583c15e70f1d166fd4877a35f4a5d2a5ca8eded67b96a22f4107be1
+SHA512:
+  metadata.gz: 119c5ea48752598e52868bacc41f7e6ec63b0558dfebbdbeab457c91e1376e0f3e74a107639b1d7cb496e7d78355a01cb5a0ea4724178cc9165864024cbdfc2d
+  data.tar.gz: 4984fb28a93d1427ebdf9ba382c818f3a50dcb0829ef4d39d091001f750d66a2a0085935f558bf586dc2361566e73a01241d20a0ea159ce1e0a5620d15157a8e

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,177 @@
+
+# Getting Started with API Reference
+
+## Introduction
+
+Orb's API is built with the following principles in mind:
+
+1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as
+   cursor-based pagination and standardized error output. To help with debugging in critical API
+   actions, the API always strives to provide detailed and actionable error messages. Aliases
+   such as external customer IDs aid in fast integration times.
+2. **Reliably real time**: Orb's event-based APIs, such as event ingestion are designed to handle extremely high
+   throughput and scale with concurrent load. Orb also provides a real-time event-level credits
+   ledger and a highly performant webhooks architecture.
+3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage
+   show the flexible nature of the platform.
+
+You can download the latest OpenAPI spec [here](https://api.withorb.com/spec.json) - pass `?version=3.0` for an
+OpenAPI 3.0-compatible spec.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install orb-apiamtic-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'orb-apiamtic-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the orb-apiamtic-sdk gem](https://rubygems.org/gems/orb-apiamtic-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 'api_reference'
+include ApiReference
+```
+
+### 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/api_reference
+```
+
+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/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| 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/orb-apiamtic-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/orb-apiamtic-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/orb-apiamtic-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 'api_reference'
+include ApiReference
+
+client = Client.new(
+  bearer_auth_credentials: BearerAuthCredentials.new(
+    access_token: 'AccessToken'
+  ),
+  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 'api_reference'
+include ApiReference
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`APIKeyAuth (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)
+
+## List of APIs
+
+* [Creditnote](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/creditnote.md)
+* [Dimensional Price Group](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/dimensional-price-group.md)
+* [Priceinterval](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/priceinterval.md)
+* [Subscription Change](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/subscription-change.md)
+* [Alert](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/alert.md)
+* [Availability](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/availability.md)
+* [Coupon](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/coupon.md)
+* [Credit](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/credit.md)
+* [Customer](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/customer.md)
+* [Event](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/event.md)
+* [Invoice](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/invoice.md)
+* [Item](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/item.md)
+* [License](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/license.md)
+* [License Type](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/license-type.md)
+* [Metric](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/metric.md)
+* [Plan](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/plan.md)
+* [Price](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/price.md)
+* [Subscription](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/controllers/subscription.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/orb-apiamtic-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/orb-apiamtic-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 'api_reference'
+
+puts 'ApiReference SDK loaded!'
+puts 'You can now create a client with: client = ApiReference::Client.new'
+puts 'Or use from_env: client = ApiReference::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/api_reference/api_helper.rb

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