Metadata-Version: 2.4
Name: newstore-apimatic-sdk
Version: 0.0.1
Summary: Sample SDKs for Newstore By APIMatic
Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
Project-URL: Documentation, https://developer.newstore.com/
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: apimatic-core>=0.2.24,~=0.2.0
Requires-Dist: apimatic-core-interfaces>=0.1.8,~=0.1.0
Requires-Dist: apimatic-requests-client-adapter>=0.1.10,~=0.1.0
Requires-Dist: python-dotenv<2.0,>=0.21
Provides-Extra: testutils
Requires-Dist: pytest>=7.2.2; extra == "testutils"
Dynamic: license-file


# Getting Started with NewStore API

## Introduction

NewStore public APIs

## Install the Package

The package is compatible with Python versions `3.7+`.
Install the package from PyPi using the following pip command:

```bash
pip install newstore-apimatic-sdk==0.0.1
```

You can also view the package at:
https://pypi.python.org/pypi/newstore-apimatic-sdk/0.0.1

## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| tenant | `str` | *Default*: `"dodici"` |
| environment | [`Environment`](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.STAGING`** |
| http_client_instance | `Union[Session, HttpClientProvider]` | The Http Client passed from the sdk user for making requests |
| override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
| http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
| timeout | `float` | The value to use for connection timeout. <br> **Default: 60** |
| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
| retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ["GET", "PUT"]** |
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/newstore-apimatic-python-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-python-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

```python
from newstoreapi.configuration import Environment
from newstoreapi.http.auth.o_auth_2 import ClientCredentialsAuthCredentials
from newstoreapi.models.o_auth_scope_enum import OAuthScopeEnum
from newstoreapi.newstoreapi_client import NewstoreapiClient

client = NewstoreapiClient(
    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
        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

```python
from newstoreapi.newstoreapi_client import NewstoreapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = NewstoreapiClient.from_environment(dotenv_path='/path/to/.env')
```

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/newstore-apimatic-python-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-python-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-python-sdk/tree/0.0.1/doc/controllers/import-schemas.md)
* [Pricebookexport](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/pricebookexport.md)
* [Productexport](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/productexport.md)
* [Financial Document](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/financial-document.md)
* [Sales Goals Management](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/sales-goals-management.md)
* [Store Reporting Config](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/store-reporting-config.md)
* [Inventory Configuration](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/inventory-configuration.md)
* [Reason Codes](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/reason-codes.md)
* [Addresscompletion](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/addresscompletion.md)
* [Devicenotifications](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/devicenotifications.md)
* [Deviceregistrations](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/deviceregistrations.md)
* [Devicesubscriptions](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/devicesubscriptions.md)
* [Associate Appexperimentsconfiguration](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/associate-appexperimentsconfiguration.md)
* [Platformeventcallbacks](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/platformeventcallbacks.md)
* [Cart](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/cart.md)
* [Notifications](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/notifications.md)
* [Profiles](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/profiles.md)
* [Customer Profile](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/customer-profile.md)
* [Data](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/data.md)
* [Token-Operations](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/token-operations.md)
* [Address](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/address.md)
* [Customer-Configuration](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/customer-configuration.md)
* [Segmentation](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/segmentation.md)
* [Datasets](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/datasets.md)
* [Jobs](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/jobs.md)
* [Events](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/events.md)
* [Extensions](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/extensions.md)
* [Installations](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/installations.md)
* [Stores](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/stores.md)
* [Cashboxes](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/cashboxes.md)
* [Orders](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/orders.md)
* [Fiscal-Providers](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/fiscal-providers.md)
* [Tenant-Config](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/tenant-config.md)
* [Easypost Adapter Config](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/easypost-adapter-config.md)
* [Shipment-Configurations](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/shipment-configurations.md)
* [Provider-Rates](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/provider-rates.md)
* [Shipping-Options](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/shipping-options.md)
* [Shipping-Option-Audits](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/shipping-option-audits.md)
* [Shipping-Labels](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/shipping-labels.md)
* [Manifests](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/manifests.md)
* [Bookings](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/bookings.md)
* [Fulfillment-Requests](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/fulfillment-requests.md)
* [Fulfillment-Tasks](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/fulfillment-tasks.md)
* [Shortings](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/shortings.md)
* [Package-Types](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/package-types.md)
* [Clients](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/clients.md)
* [Identity-Providers](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/identity-providers.md)
* [Users](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/users.md)
* [Support-Users](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/support-users.md)
* [Roles](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/roles.md)
* [Insights](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/insights.md)
* [Counting](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/counting.md)
* [Transferring](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/transferring.md)
* [Reservations](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/reservations.md)
* [Phavda-Notifications](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/phavda-notifications.md)
* [Sales-Orders](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/sales-orders.md)
* [Stock](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/stock.md)
* [Order-Placement](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/order-placement.md)
* [Adyen-Adapter](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/adyen-adapter.md)
* [Payment-Definitions](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/payment-definitions.md)
* [Stripe-Webhook-Notifications](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/stripe-webhook-notifications.md)
* [Providers](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/providers.md)
* [Payment-Links](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/payment-links.md)
* [Payment-Account](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/payment-account.md)
* [Discounts](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/discounts.md)
* [Tppe](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/tppe.md)
* [Settings](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/settings.md)
* [Platform-Status](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/platform-status.md)
* [Simulation](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/simulation.md)
* [Routing-Ruleset](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/routing-ruleset.md)
* [Routing-Config](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/routing-config.md)
* [Routing](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/routing.md)
* [Order-Injection-Config](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/order-injection-config.md)
* [Order-Injection](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/order-injection.md)
* [Audit-Events](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/audit-events.md)
* [Tax-Definitions](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/tax-definitions.md)
* [Store-Tax-Configuration](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/store-tax-configuration.md)
* [Tax-Transactions](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/tax-transactions.md)
* [Tax-Quotations](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/tax-quotations.md)
* [Tenant-Tax-Configuration](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/controllers/tenant-tax-configuration.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)

### HTTP

* [HttpResponse](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/http-request.md)

### Utilities

* [ApiHelper](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/sdks-io/newstore-apimatic-python-sdk/tree/0.0.1/doc/unix-date-time.md)

