Metadata-Version: 2.4
Name: loyalty-sdk
Version: 0.0.2
Summary: Loyalty APIs provides the end points needed in order to generate the user Authorization Tokens, manage offers assigned to a user, and retrieve the Loyalty Points balance of users.
Author-email: developer sdksio <developer+sdksio@apimatic.io>
Project-URL: Documentation, https://developer.shell.com/api-catalog/v2.6.2/loyalty-account-management
Keywords: Apimatic,shell,sdksio,loyalty,sdks
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 Loyalty APIs

## Introduction

Loyalty Account Management provides the end points needed in order to generate the user Authorization Tokens which will provide access to the Loyalty APIs and also to update the user profile.

## 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 loyalty-sdk==0.0.2
```

You can also view the package at:
https://pypi.python.org/pypi/loyalty-sdk/0.0.2

## Initialize the API Client

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

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| environment | [`Environment`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/README.md#environments) | The API environment. <br> **Default: `Environment.SIT`** |
| 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`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| public_bearer_token_credentials | [`PublicBearerTokenCredentials`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token.md) | The credential object for OAuth 2 Bearer token |
| public_basic_token_credentials | [`PublicBasicTokenCredentials`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
| private_basic_token_credentials | [`PrivateBasicTokenCredentials`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
| client_authorization_token_credentials | [`ClientAuthorizationTokenCredentials`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
| customer_header_credentials | [`CustomerHeaderCredentials`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/custom-header-signature-2.md) | The credential object for Custom Header Signature |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
import logging

from loyaltyapis.configuration import Environment
from loyaltyapis.http.auth.client_authorization_token import ClientAuthorizationTokenCredentials
from loyaltyapis.http.auth.customer_header import CustomerHeaderCredentials
from loyaltyapis.http.auth.private_basic_token import PrivateBasicTokenCredentials
from loyaltyapis.http.auth.public_basic_token import PublicBasicTokenCredentials
from loyaltyapis.http.auth.public_bearer_token import PublicBearerTokenCredentials
from loyaltyapis.logging.configuration.api_logging_configuration import LoggingConfiguration
from loyaltyapis.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from loyaltyapis.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from loyaltyapis.loyaltyapis_client import LoyaltyapisClient

client = LoyaltyapisClient(
    public_bearer_token_credentials=PublicBearerTokenCredentials(
        access_token='AccessToken'
    ),
    public_basic_token_credentials=PublicBasicTokenCredentials(
        public_basic_token='Public Basic Token'
    ),
    private_basic_token_credentials=PrivateBasicTokenCredentials(
        public_basic_token='Public Basic Token'
    ),
    client_authorization_token_credentials=ClientAuthorizationTokenCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret'
    ),
    customer_header_credentials=CustomerHeaderCredentials(
        authorization_token='Authorization-Token'
    ),
    environment=Environment.SIT,
    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 loyaltyapis.loyaltyapis_client import LoyaltyapisClient

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

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/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 |
|  --- | --- |
| SIT | **Default** |
| PRODUCTION | - |
| UAT | - |

## Authorization

This API uses the following authentication schemes.

* [`PublicBearerToken (OAuth 2 Bearer token)`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/oauth-2-bearer-token.md)
* [`PublicBasicToken (Custom Header Signature)`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/custom-header-signature.md)
* [`PrivateBasicToken (Custom Header Signature)`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/custom-header-signature-1.md)
* [`client-authorization-token (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/oauth-2-client-credentials-grant.md)
* [`customerHeader (Custom Header Signature)`](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/auth/custom-header-signature-2.md)

## List of APIs

* [Profile Management](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/controllers/profile-management.md)
* [Authorization](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/controllers/authorization.md)
* [Offer](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/controllers/offer.md)
* [Balances](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/controllers/balances.md)
* [Redemption](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/controllers/redemption.md)
* [Transaction](https://www.github.com/sdks-io/loyalty-python-sdk/tree/0.0.2/doc/controllers/transaction.md)

## SDK Infrastructure

### Configuration

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

### HTTP

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

### Utilities

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

