Metadata-Version: 2.4
Name: apimatic-splitit-sdk
Version: 1.0.1
Summary: APIMatic SDK for SplitIt API
Author-email: developer-sdksio <developer+sdksio@apimatic.io>
Project-URL: Documentation, https://docs.apimatic.io/
Keywords: apimatic,splitit,sdk,api
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 splitit-web-api-v4

## Introduction

Splitit Orchestration API for managing installment plans.

## 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-splitit-sdk==1.0.1
```

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

## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| environment | [`Environment`](README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION_ENVIRONMENT`** |
| 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: 30** |
| 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`](doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](doc/logging-configuration.md) | The SDK logging configuration for API calls |
| oauth_2_credentials | [`Oauth2Credentials`](__base_path/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
| api_key_credentials | [`ApiKeyCredentials`](__base_path/auth/custom-header-signature.md) | The credential object for Custom Header Signature |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
import logging

from splititwebapiv4.configuration import Environment
from splititwebapiv4.http.auth.api_key import ApiKeyCredentials
from splititwebapiv4.http.auth.oauth_2 import Oauth2Credentials
from splititwebapiv4.logging.configuration.api_logging_configuration import LoggingConfiguration
from splititwebapiv4.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from splititwebapiv4.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from splititwebapiv4.models.oauth_scope_oauth_2 import OauthScopeOauth2
from splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client

client = Splititwebapiv4Client(
    oauth_2_credentials=Oauth2Credentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_scopes=[
            OauthScopeOauth2.API_V4
        ]
    ),
    api_key_credentials=ApiKeyCredentials(
        x_splitit_api_key='X-Splitit-Api-Key'
    ),
    environment=Environment.PRODUCTION_ENVIRONMENT,
    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 splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client

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

See the [Environment-Based Client Initialization](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_ENVIRONMENT | **Default** |
| SANDBOX_ENVIRONMENT | - |

## Authorization

This API uses the following authentication schemes.

* [`OAuth2 (OAuth 2 Client Credentials Grant)`](__base_path/auth/oauth-2-client-credentials-grant.md)
* [`ApiKey (Custom Header Signature)`](__base_path/auth/custom-header-signature.md)

## List of APIs

* [Installment Plan](doc/controllers/installment-plan.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](doc/proxy-settings.md)
* [Environment-Based Client Initialization](doc/environment-based-client-initialization.md)
* [AbstractLogger](doc/abstract-logger.md)
* [LoggingConfiguration](doc/logging-configuration.md)
* [RequestLoggingConfiguration](doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](doc/response-logging-configuration.md)

### HTTP

* [HttpResponse](doc/http-response.md)
* [HttpRequest](doc/http-request.md)

### Utilities

* [ApiResponse](doc/api-response.md)
* [ApiHelper](doc/api-helper.md)
* [HttpDateTime](doc/http-date-time.md)
* [RFC3339DateTime](doc/rfc3339-date-time.md)
* [UnixDateTime](doc/unix-date-time.md)

