Metadata-Version: 2.4
Name: areach-apimatic-sdk
Version: 0.0.1
Summary: Sample SDKs for Areach by APIMatic
Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
Project-URL: Documentation, https://docs.anyreach.ai/
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 Anyreach API

## Introduction

REST API for the Anyreach platform.

Every endpoint is scoped to one organization. Authenticate with a bearer token and, if your token can reach more than one organization, name the one you mean with the `X-Anyreach-Org` header. See [Authentication](https://docs.anyreach.ai/api-reference/authentication).

This reference is generated from the running service, so the request and response shapes here are the ones the API actually enforces.

## 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 areach-apimatic-sdk==0.0.1
```

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

## 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.](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, 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", "GET", "PUT"]** |
| proxy_settings | [`ProxySettings`](doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| bearer_auth_credentials | [`BearerAuthCredentials`](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 anyreachapi.anyreachapi_client import AnyreachapiClient
from anyreachapi.configuration import Environment
from anyreachapi.http.auth.o_auth_2 import BearerAuthCredentials

client = AnyreachapiClient(
    bearer_auth_credentials=BearerAuthCredentials(
        access_token='AccessToken'
    ),
    environment=Environment.PRODUCTION
)
```

### Environment-Based Client Initialization

```python
from anyreachapi.anyreachapi_client import AnyreachapiClient

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

See the [Environment-Based Client Initialization](doc/environment-based-client-initialization.md) section for details.

## Authorization

This API uses the following authentication schemes.

* [`bearerAuth (OAuth 2 Bearer token)`](doc/auth/oauth-2-bearer-token.md)

## List of APIs

* [Conversationattachments](doc/controllers/conversationattachments.md)
* [Conversationevents](doc/controllers/conversationevents.md)
* [Knowledgebases](doc/controllers/knowledgebases.md)
* [Knowledgebasesources](doc/controllers/knowledgebasesources.md)
* [Phonenumbers](doc/controllers/phonenumbers.md)
* [Inboundrouting](doc/controllers/inboundrouting.md)
* [Agentassist](doc/controllers/agentassist.md)
* [Humanhandoff](doc/controllers/humanhandoff.md)
* [Emaildomains](doc/controllers/emaildomains.md)
* [Emailaddresses](doc/controllers/emailaddresses.md)
* [Webwidgets](doc/controllers/webwidgets.md)
* [Campaigncontacts](doc/controllers/campaigncontacts.md)
* [Campaignconfigurations](doc/controllers/campaignconfigurations.md)
* [Campaignstats](doc/controllers/campaignstats.md)
* [Customdata](doc/controllers/customdata.md)
* [Evaluationruns](doc/controllers/evaluationruns.md)
* [Workflowtriggers](doc/controllers/workflowtriggers.md)
* [Workflowexecutions](doc/controllers/workflowexecutions.md)
* [Workflowcredentials](doc/controllers/workflowcredentials.md)
* [Agents](doc/controllers/agents.md)
* [Conversations](doc/controllers/conversations.md)
* [Sources](doc/controllers/sources.md)
* [Trunks](doc/controllers/trunks.md)
* [Unsubscribes](doc/controllers/unsubscribes.md)
* [Campaigns](doc/controllers/campaigns.md)
* [Metrics](doc/controllers/metrics.md)
* [Evaluations](doc/controllers/evaluations.md)
* [Workflows](doc/controllers/workflows.md)

## SDK Infrastructure

### Configuration

* [ProxySettings](doc/proxy-settings.md)
* [Environment-Based Client Initialization](doc/environment-based-client-initialization.md)

### HTTP

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

### Utilities

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

