apimatic-sticky-apis-sdk 0.0.1

This is a test SDK generated by APIMatic

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

Version 1 JSON API

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:

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.

The following parameters are configurable for the API Client:

Parameter	Type	Description
environment	Environment	The API environment. 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. Default: 60
max_retries	int	The number of times to retry an endpoint call if it fails. Default: 0
backoff_factor	float	A backoff factor to apply between attempts after the second try. Default: 2
retry_statuses	Array of int	The http statuses on which retry is to be done. 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. Default: ["GET", "PUT"]
proxy_settings	ProxySettings	Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
basic_credentials	BasicCredentials	The credential object for Basic Authentication
bearer_credentials	BearerCredentials	The credential object for OAuth 2 Bearer token

The API client can be initialized as follows:

Code-Based Client Initialization

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

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 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)
• bearer (OAuth 2 Bearer token)

List of APIs

• Billing Models
• Campaigns
• Payment Types Methods
• Promo Codes
• Custom Fields
• Start Stop Reset
• Line Item Custom Options
• Line Item Management
• Trial Workflows
• Payment Router
• Volume Discounts
• Permissions
• Affiliates
• Meta
• Addresses
• Wallet
• Interests
• Communications
• Contacts
• Coupons
• Customers
• Gateways
• Images
• Types
• Templates
• Notes
• Products
• Discount
• Credits
• Overrides
• Subscriptions
• Orders
• Configurations
• Offers
• Attributes
• Categories
• Variants
• Prospects
• Shipping
• Tokenization
• Users
• Chargeback
• Inventories
• Warehouse
• Order
• Subscription
• Misc

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime