Metadata-Version: 2.4
Name: apimatic-sticky-apis-sdk
Version: 0.0.1
Summary: This is a test SDK generated by APIMatic
Author-email: developer sdksio <developer+sdksio@apimatic.io>
Project-URL: Documentation, https://apimatic.io
Keywords: APIMatic,sdksio
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 sticky.io Restful API v2025.7.31

## Introduction

sticky.io Restful API offers some new functionality as well as fully restful routes. All request with a payload should be sent as JSON. The authorization used is [Basic Authentication](https://swagger.io/docs/specification/authentication/basic-authentication/)

[Version 1 JSON API](https://developer-prod.sticky.io)

**Requests**

API requests that call for a request body are expected to be in **JSON Format**.

**Responses**

The v2 standard JSON responses will usually contain at least the following:

| Field | Data Type | Description |
| --- | --- | --- |
| status | String | Status of the API call. "SUCCESS" or "FAILURE" are possible values. |
| data | Mixed | Data returned by API call. It could be an object or an array of objects. |

**List Responses**

GET requests that return a list of entities will usually contain the following:

| Field | Data Type | Description |
| --- | --- | --- |
| status | String | Status of the API call. "SUCCESS" or "FAILURE" are possible values. |
| data | Mixed | Data returned by API call. It could be an object or an array of objects. |
| current_page | Integer | Current page associated with the dataset returned in `data`. |
| first_page_url | String | URL that maps to the first paginated list of a given entity. |
| last_page | Integer | Number of pages in a given dataset. |
| last_page_url | String | URL that maps to the last paginated list of a given entity. |
| next_page_url | String | URL that maps to the next paginated list of a given entity. |
| path | String | URL that maps to the index page of a given entity. |
| per_page | Mixed | Data returned by API call. It could be an object or an array of objects. |
| prev_page_url | Mixed | Data returned by API call. It could be an object or an array of objects. |
| from | Integer | Offset record number lower bound. |
| to | Mixed | Offset record number upper bound. |
| total | Integer | Total amount of records that exist for a given entity. |

## 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 apimatic-sticky-apis-sdk==0.0.1
```

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

## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/apimatic-sticky-apis-python-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-sticky-apis-python-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| 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/apimatic-sticky-apis-python-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-sticky-apis-python-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| basic_credentials | [`BasicCredentials`](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
| bearer_credentials | [`BearerCredentials`](https://www.github.com/sdks-io/apimatic-sticky-apis-python-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

```python
import logging

from stickyiorestfulapiv2025731.configuration import Environment
from stickyiorestfulapiv2025731.http.auth.basic import BasicCredentials
from stickyiorestfulapiv2025731.http.auth.bearer import BearerCredentials
from stickyiorestfulapiv2025731.logging.configuration.api_logging_configuration import LoggingConfiguration
from stickyiorestfulapiv2025731.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from stickyiorestfulapiv2025731.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from stickyiorestfulapiv2025731.stickyiorestfulapiv_2025731_client import Stickyiorestfulapiv2025731Client

client = Stickyiorestfulapiv2025731Client(
    basic_credentials=BasicCredentials(
        username='username',
        password='password'
    ),
    bearer_credentials=BearerCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION,
    logging_configuration=LoggingConfiguration(
        log_level=logging.INFO,
        request_logging_config=RequestLoggingConfiguration(
            log_body=True
        ),
        response_logging_config=ResponseLoggingConfiguration(
            log_headers=True
        )
    )
)
```

### Environment-Based Client Initialization

```python
from stickyiorestfulapiv2025731.stickyiorestfulapiv_2025731_client import Stickyiorestfulapiv2025731Client

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

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-sticky-apis-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 |
|  --- | --- |
| PRODUCTION | **Default** |

## Authorization

This API uses the following authentication schemes.

* [`basic (Basic Authentication)`](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/auth/basic-authentication.md)
* [`bearer (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)

## List of APIs

* [Billing Models](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/billing-models.md)
* [Campaigns](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/campaigns.md)
* [Payment Types Methods](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/payment-types-methods.md)
* [Promo Codes](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/promo-codes.md)
* [Custom Fields](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/custom-fields.md)
* [Start Stop Reset](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/start-stop-reset.md)
* [Line Item Custom Options](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/line-item-custom-options.md)
* [Line Item Management](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/line-item-management.md)
* [Trial Workflows](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/trial-workflows.md)
* [Payment Router](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/payment-router.md)
* [Volume Discounts](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/volume-discounts.md)
* [Permissions](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/permissions.md)
* [Affiliates](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/affiliates.md)
* [Meta](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/meta.md)
* [Addresses](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/addresses.md)
* [Wallet](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/wallet.md)
* [Interests](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/interests.md)
* [Communications](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/communications.md)
* [Contacts](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/contacts.md)
* [Coupons](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/coupons.md)
* [Customers](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/customers.md)
* [Gateways](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/gateways.md)
* [Images](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/images.md)
* [Types](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/types.md)
* [Templates](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/templates.md)
* [Notes](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/notes.md)
* [Products](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/products.md)
* [Discount](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/discount.md)
* [Credits](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/credits.md)
* [Overrides](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/overrides.md)
* [Subscriptions](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/subscriptions.md)
* [Orders](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/orders.md)
* [Configurations](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/configurations.md)
* [Offers](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/offers.md)
* [Attributes](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/attributes.md)
* [Categories](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/categories.md)
* [Variants](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/variants.md)
* [Prospects](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/prospects.md)
* [Shipping](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/shipping.md)
* [Tokenization](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/tokenization.md)
* [Users](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/users.md)
* [Chargeback](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/chargeback.md)
* [Inventories](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/inventories.md)
* [Warehouse](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/warehouse.md)
* [Order](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/order.md)
* [Subscription](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/subscription.md)
* [Misc](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/controllers/misc.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
* [AbstractLogger](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/abstract-logger.md)
* [LoggingConfiguration](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/apimatic-sticky-apis-python-sdk/tree/0.0.1/doc/response-logging-configuration.md)

### HTTP

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

### Utilities

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

