Metadata-Version: 2.4
Name: plaid-apimatic-sdk
Version: 1.0.0
Summary: The Plaid REST API. Please see https://plaid.com/docs/api for more details.
Keywords: plaid,apimatic,sdk,python
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 The Plaid API

## Introduction

The Plaid REST API. Please see https://plaid.com/docs/api for more details.

## 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 plaid-apimatic-sdk==1.0.0
```

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

## 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.SANDBOX`** |
| 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 |
| client_id_credentials | [`ClientIdCredentials`](__base_path/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
| secret_credentials | [`SecretCredentials`](__base_path/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
| plaid_version_credentials | [`PlaidVersionCredentials`](__base_path/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 theplaidapi.configuration import Environment
from theplaidapi.http.auth.client_id import ClientIdCredentials
from theplaidapi.http.auth.plaid_version import PlaidVersionCredentials
from theplaidapi.http.auth.secret import SecretCredentials
from theplaidapi.logging.configuration.api_logging_configuration import LoggingConfiguration
from theplaidapi.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from theplaidapi.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from theplaidapi.theplaidapi_client import TheplaidapiClient

client = TheplaidapiClient(
    client_id_credentials=ClientIdCredentials(
        plaid_client_id='PLAID-CLIENT-ID'
    ),
    secret_credentials=SecretCredentials(
        plaid_secret='PLAID-SECRET'
    ),
    plaid_version_credentials=PlaidVersionCredentials(
        plaid_version='Plaid-Version'
    ),
    environment=Environment.SANDBOX,
    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 theplaidapi.theplaidapi_client import TheplaidapiClient

# Specify the path to your .env file if it’s located outside the project’s root directory.
client = TheplaidapiClient.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 |
|  --- | --- |
| SANDBOX | **Default** |
| PRODUCTION | - |

## Authorization

This API uses the following authentication schemes.

* [`clientId (Custom Header Signature)`](__base_path/auth/custom-header-signature.md)
* [`secret (Custom Header Signature)`](__base_path/auth/custom-header-signature-1.md)
* [`plaidVersion (Custom Header Signature)`](__base_path/auth/custom-header-signature-2.md)

## List of APIs

* [Plaid](doc/controllers/plaid.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)

