newstore-apimatic-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28cc1bff8a52cc08e2fa36a3360f1c0defcfaecaa58c9e2955f6dd1fbb712f65
+  data.tar.gz: 998d4a32961e89cbbfceb580757ff6d81bd25dcfd60b231abdc3cdc2d1855c2d
+SHA512:
+  metadata.gz: a4fd86eaef592eb13d96b1ec1b58054bbe4385d51633a4754f3c931a8a508d141948813ba797fa73273afff6463ee326f1846f5ca1d6ed3fd64654bd5b2ef225
+  data.tar.gz: 6dd86d9f1fc08e913f5a81924f37abe396a8486da65acecfabf14b63777f29d25a921b4ddb2c9f7a7650d0c25210b2af153db53fb0c8d86a1ac8338da4de5168

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,230 @@
+
+# Getting Started with NewStore API
+
+## Introduction
+
+NewStore public APIs
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install newstore-apimatic-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'newstore-apimatic-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the newstore-apimatic-sdk gem](https://rubygems.org/gems/newstore-apimatic-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 'new_store_api'
+include NewStoreApi
+```
+
+### 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/new_store_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/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| tenant | `String` | *Default*: `'dodici'` |
+| environment | [`Environment`](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.STAGING`** |
+| 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/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| client_credentials_auth_credentials | [`ClientCredentialsAuthCredentials`](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'new_store_api'
+include NewStoreApi
+
+client = Client.new(
+  client_credentials_auth_credentials: ClientCredentialsAuthCredentials.new(
+    o_auth_client_id: 'OAuthClientId',
+    o_auth_client_secret: 'OAuthClientSecret',
+    o_auth_scopes: [
+      OAuthScopeEnum::CATALOGIMPORT_SCHEMASREAD,
+      OAuthScopeEnum::CATALOGIMPORT_SCHEMASWRITE
+    ]
+  ),
+  environment: Environment::STAGING,
+  tenant: 'dodici'
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'new_store_api'
+include NewStoreApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/newstore-apimatic-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 |
+|  --- | --- |
+| STAGING | **Default** |
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`oauth (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md)
+
+## List of APIs
+
+* [Import Schemas](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/import-schemas.md)
+* [Pricebookexport](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/pricebookexport.md)
+* [Productexport](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/productexport.md)
+* [Financial Document](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/financial-document.md)
+* [Sales Goals Management](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/sales-goals-management.md)
+* [Store Reporting Config](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/store-reporting-config.md)
+* [Inventory Configuration](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/inventory-configuration.md)
+* [Reason Codes](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/reason-codes.md)
+* [Addresscompletion](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/addresscompletion.md)
+* [Devicenotifications](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/devicenotifications.md)
+* [Deviceregistrations](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/deviceregistrations.md)
+* [Devicesubscriptions](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/devicesubscriptions.md)
+* [Associate Appexperimentsconfiguration](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/associate-appexperimentsconfiguration.md)
+* [Platformeventcallbacks](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/platformeventcallbacks.md)
+* [Cart](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/cart.md)
+* [Notifications](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/notifications.md)
+* [Profiles](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/profiles.md)
+* [Customer Profile](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/customer-profile.md)
+* [Data](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/data.md)
+* [Token-Operations](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/token-operations.md)
+* [Address](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/address.md)
+* [Customer-Configuration](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/customer-configuration.md)
+* [Segmentation](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/segmentation.md)
+* [Datasets](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/datasets.md)
+* [Jobs](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/jobs.md)
+* [Events](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/events.md)
+* [Extensions](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/extensions.md)
+* [Installations](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/installations.md)
+* [Stores](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/stores.md)
+* [Cashboxes](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/cashboxes.md)
+* [Orders](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/orders.md)
+* [Fiscal-Providers](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/fiscal-providers.md)
+* [Tenant-Config](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/tenant-config.md)
+* [Easypost Adapter Config](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/easypost-adapter-config.md)
+* [Shipment-Configurations](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/shipment-configurations.md)
+* [Provider-Rates](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/provider-rates.md)
+* [Shipping-Options](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/shipping-options.md)
+* [Shipping-Option-Audits](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/shipping-option-audits.md)
+* [Shipping-Labels](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/shipping-labels.md)
+* [Manifests](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/manifests.md)
+* [Bookings](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/bookings.md)
+* [Fulfillment-Requests](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/fulfillment-requests.md)
+* [Fulfillment-Tasks](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/fulfillment-tasks.md)
+* [Shortings](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/shortings.md)
+* [Package-Types](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/package-types.md)
+* [Clients](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/clients.md)
+* [Identity-Providers](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/identity-providers.md)
+* [Users](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/users.md)
+* [Support-Users](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/support-users.md)
+* [Roles](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/roles.md)
+* [Insights](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/insights.md)
+* [Counting](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/counting.md)
+* [Transferring](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/transferring.md)
+* [Reservations](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/reservations.md)
+* [Phavda-Notifications](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/phavda-notifications.md)
+* [Sales-Orders](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/sales-orders.md)
+* [Stock](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/stock.md)
+* [Order-Placement](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/order-placement.md)
+* [Adyen-Adapter](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/adyen-adapter.md)
+* [Payment-Definitions](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/payment-definitions.md)
+* [Stripe-Webhook-Notifications](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/stripe-webhook-notifications.md)
+* [Providers](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/providers.md)
+* [Payment-Links](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/payment-links.md)
+* [Payment-Account](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/payment-account.md)
+* [Discounts](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/discounts.md)
+* [Tppe](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/tppe.md)
+* [Settings](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/settings.md)
+* [Platform-Status](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/platform-status.md)
+* [Simulation](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/simulation.md)
+* [Routing-Ruleset](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/routing-ruleset.md)
+* [Routing-Config](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/routing-config.md)
+* [Routing](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/routing.md)
+* [Order-Injection-Config](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/order-injection-config.md)
+* [Order-Injection](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/order-injection.md)
+* [Audit-Events](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/audit-events.md)
+* [Tax-Definitions](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/tax-definitions.md)
+* [Store-Tax-Configuration](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/store-tax-configuration.md)
+* [Tax-Transactions](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/tax-transactions.md)
+* [Tax-Quotations](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/tax-quotations.md)
+* [Tenant-Tax-Configuration](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/tenant-tax-configuration.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/sdks-io/newstore-apimatic-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/newstore-apimatic-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 'new_store_api'
+
+puts 'NewStoreApi SDK loaded!'
+puts 'You can now create a client with: client = NewStoreApi::Client.new'
+puts 'Or use from_env: client = NewStoreApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/new_store_api/api_helper.rb

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