Metadata-Version: 2.4
Name: orb-apiamtic-sdk
Version: 0.0.1
Summary: Sample SDKs for ORB by APIMatic
Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
Project-URL: Documentation, https://docs.withorb.com/overview
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 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

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

```bash
pip install orb-apiamtic-sdk==0.0.1
```

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

## Initialize the API Client

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

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| 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/orb-apiamtic-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/orb-apiamtic-python-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-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 apireference.apireference_client import ApireferenceClient
from apireference.configuration import Environment
from apireference.http.auth.oauth_2 import BearerAuthCredentials
from apireference.logging.configuration.api_logging_configuration import LoggingConfiguration
from apireference.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from apireference.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = ApireferenceClient(
    bearer_auth_credentials=BearerAuthCredentials(
        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 apireference.apireference_client import ApireferenceClient

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

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/orb-apiamtic-python-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-python-sdk/tree/0.0.1/doc/auth/oauth-2-bearer-token.md)

## List of APIs

* [Creditnote](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/creditnote.md)
* [Dimensional Price Group](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/dimensional-price-group.md)
* [Priceinterval](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/priceinterval.md)
* [Subscription Change](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/subscription-change.md)
* [Alert](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/alert.md)
* [Availability](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/availability.md)
* [Coupon](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/coupon.md)
* [Credit](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/credit.md)
* [Customer](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/customer.md)
* [Event](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/event.md)
* [Invoice](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/invoice.md)
* [Item](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/item.md)
* [License](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/license.md)
* [License Type](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/license-type.md)
* [Metric](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/metric.md)
* [Plan](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/plan.md)
* [Price](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/price.md)
* [Subscription](https://www.github.com/sdks-io/orb-apiamtic-python-sdk/tree/0.0.1/doc/controllers/subscription.md)

## SDK Infrastructure

### Configuration

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

### HTTP

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

### Utilities

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

