Metadata-Version: 2.4
Name: colorado-booth-sdk
Version: 1.1.3
Summary: test
Author-email: Driscoll Dunn <pagave@mailinator.com>
Project-URL: Documentation, https://www.pytylypoty.us
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
Requires-Dist: deprecation~=2.1
Provides-Extra: testutils
Requires-Dist: pytest>=7.2.2; extra == "testutils"
Dynamic: license-file


# Getting Started with MultiAuth-Sample

## Introduction

API for Markdown Notes app.

## 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 colorado-booth-sdk==1.1.3
```

You can also view the package at:
https://pypi.python.org/pypi/colorado-booth-sdk/1.1.3

## Test the SDK

You can test the generated SDK and the server with test cases. `unittest` is used as the testing framework and `pytest` is used as the test runner. You can run the tests as follows:

Navigate to the root directory of the SDK and run the following commands


pip install -r test-requirements.txt
pytest


## Initialize the API Client

**_Note:_** Documentation for the client can be found [here.](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| access_token | `str` |  |
| port | `str` | *Default*: `"80"` |
| suites | `SuiteCodeEnum` | *Default*: `1` |
| environment | [`Environment`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/README.md#environments) | The API environment. <br> **Default: `Environment.TESTING`** |
| 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/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
| api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/custom-query-parameter.md) | The credential object for Custom Query Parameter |
| api_header_credentials | [`ApiHeaderCredentials`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
| o_auth_ccg_credentials | [`OAuthCCGCredentials`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
| o_auth_acg_credentials | [`OAuthACGCredentials`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
| o_auth_ropcg_credentials | [`OAuthROPCGCredentials`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/oauth-2-resource-owner-credentials-grant.md) | The credential object for OAuth 2 Resource Owner Credentials Grant |
| o_auth_bearer_token_credentials | [`OAuthBearerTokenCredentials`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/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
from multiauthsample.configuration import Environment
from multiauthsample.http.auth.api_header import ApiHeaderCredentials
from multiauthsample.http.auth.api_key import ApiKeyCredentials
from multiauthsample.http.auth.basic_auth import BasicAuthCredentials
from multiauthsample.http.auth.o_auth_acg import OAuthACGCredentials
from multiauthsample.http.auth.o_auth_bearer_token import OAuthBearerTokenCredentials
from multiauthsample.http.auth.o_auth_ccg import OAuthCCGCredentials
from multiauthsample.http.auth.o_auth_ropcg import OAuthROPCGCredentials
from multiauthsample.models.o_auth_scope_o_auth_acg_enum import OAuthScopeOAuthACGEnum
from multiauthsample.models.suite_code_enum import SuiteCodeEnum
from multiauthsample.multiauthsample_client import MultiauthsampleClient

client = MultiauthsampleClient(
    access_token='accessToken',
    basic_auth_credentials=BasicAuthCredentials(
        username='Username',
        password='Password'
    ),
    api_key_credentials=ApiKeyCredentials(
        token='token',
        api_key='api-key'
    ),
    api_header_credentials=ApiHeaderCredentials(
        token='token',
        api_key='api-key'
    ),
    o_auth_ccg_credentials=OAuthCCGCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret'
    ),
    o_auth_acg_credentials=OAuthACGCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret',
        o_auth_redirect_uri='OAuthRedirectUri',
        o_auth_scopes=[
            OAuthScopeOAuthACGEnum.READ_SCOPE
        ]
    ),
    o_auth_ropcg_credentials=OAuthROPCGCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret',
        o_auth_username='OAuthUsername',
        o_auth_password='OAuthPassword'
    ),
    o_auth_bearer_token_credentials=OAuthBearerTokenCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.TESTING,
    port='80',
    suites=SuiteCodeEnum.HEARTS
)
```

### Environment-Based Client Initialization

```python
from multiauthsample.multiauthsample_client import MultiauthsampleClient

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

See the [Environment-Based Client Initialization](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/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 | - |
| TESTING | **Default** |

## Authorization

This API uses the following authentication schemes.

* [`basicAuth (Basic Authentication)`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/basic-authentication.md)
* [`apiKey (Custom Query Parameter)`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/custom-query-parameter.md)
* [`apiHeader (Custom Header Signature)`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/custom-header-signature.md)
* [`OAuthCCG (OAuth 2 Client Credentials Grant)`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/oauth-2-client-credentials-grant.md)
* [`OAuthACG (OAuth 2 Authorization Code Grant)`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/oauth-2-authorization-code-grant.md)
* [`OAuthROPCG (OAuth 2 Resource Owner Credentials Grant)`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/oauth-2-resource-owner-credentials-grant.md)
* [`OAuthBearerToken (OAuth 2 Bearer token)`](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/auth/oauth-2-bearer-token.md)
* `CustomAuth (Custom Authentication)`

## List of APIs

* [Authentication](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/controllers/authentication.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/proxy-settings.md)
* [Environment-Based Client Initialization](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/environment-based-client-initialization.md)

### HTTP

* [HttpResponse](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/http-response.md)
* [HttpRequest](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/http-request.md)

### Utilities

* [ApiHelper](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/ZahraN444/colorado-booth-python-sdk/tree/1.1.3/doc/unix-date-time.md)

