fortis-python-sdk 1.0.8__tar.gz → 1.0.10__tar.gz

fortis_python_sdk-1.0.10/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE
+include README.md

fortis_python_sdk-1.0.10/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: fortis-python-sdk
+Version: 1.0.10
+Summary: Fortispay Python SDK
+Project-URL: docs, https://docs.fortis.tech
+Keywords: Fortis,payments,payment,erp,crm,embedded,integrated
+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 Fortis API
+
+## 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 fortis-python-sdk==1.0.10
+```
+
+You can also view the package at:
+https://pypi.python.org/pypi/fortis-python-sdk/1.0.10
+
+## 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/fortispay/pythonsdk/tree/1.0.10/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/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: 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/fortispay/pythonsdk/tree/1.0.10/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| user_id_credentials | [`UserIdCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+| user_api_key_credentials | [`UserApiKeyCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
+| developer_id_credentials | [`DeveloperIdCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-2.md) | The credential object for Custom Header Signature |
+| access_token_credentials | [`AccessTokenCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-3.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```python
+from fortisapi.configuration import Environment
+from fortisapi.fortisapi_client import FortisapiClient
+from fortisapi.http.auth.access_token import AccessTokenCredentials
+from fortisapi.http.auth.developer_id import DeveloperIdCredentials
+from fortisapi.http.auth.user_api_key import UserApiKeyCredentials
+from fortisapi.http.auth.user_id import UserIdCredentials
+
+client = FortisapiClient(
+    user_id_credentials=UserIdCredentials(
+        user_id='user-id'
+    ),
+    user_api_key_credentials=UserApiKeyCredentials(
+        user_api_key='user-api-key'
+    ),
+    developer_id_credentials=DeveloperIdCredentials(
+        developer_id='developer-id'
+    ),
+    access_token_credentials=AccessTokenCredentials(
+        access_token='access-token'
+    ),
+    environment=Environment.SANDBOX
+)
+```
+
+### Environment-Based Client Initialization
+
+```python
+from fortisapi.fortisapi_client import FortisapiClient
+
+# Specify the path to your .env file if it’s located outside the project’s root directory.
+client = FortisapiClient.from_environment(dotenv_path='/path/to/.env')
+```
+
+See the [Environment-Based Client Initialization](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/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.
+
+* [`user-id (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature.md)
+* [`user-api-key (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-1.md)
+* [`developer-id (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-2.md)
+* [`access-token (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-3.md)
+
+## List of APIs
+
+* [Async Processing](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/async-processing.md)
+* [Declined Recurring Transactions](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/declined-recurring-transactions.md)
+* [Device Terms](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/device-terms.md)
+* [Full Boarding](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/full-boarding.md)
+* [3 DS Authentication](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/3-ds-authentication.md)
+* [3 DS Transactions](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/3-ds-transactions.md)
+* [Merchant Deposits](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/merchant-deposits.md)
+* [Enterprise Link Redirect](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/enterprise-link-redirect.md)
+* [On Boarding](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/on-boarding.md)
+* [Payment Card Reader Token](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/payment-card-reader-token.md)
+* [Calculate Surcharge](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/calculate-surcharge.md)
+* [Quick Invoices](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/quick-invoices.md)
+* [Transaction ACH Retries](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transaction-ach-retries.md)
+* [Transactions-ACH](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-ach.md)
+* [Transactions-Cash](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-cash.md)
+* [Transactions-Credit Card](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-credit-card.md)
+* [Transactions-EBT Card](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-ebt-card.md)
+* [Transactions-Read](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-read.md)
+* [Level 3 Data](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/level-3-data.md)
+* [Transactions-Updates](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-updates.md)
+* [Apple Pay Validate Merchant](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/apple-pay-validate-merchant.md)
+* [Merchant Details](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/merchant-details.md)
+* [Batches](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/batches.md)
+* [Contacts](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/contacts.md)
+* [Elements](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/elements.md)
+* [Locations](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/locations.md)
+* [Paylinks](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/paylinks.md)
+* [Recurring](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/recurring.md)
+* [Reports](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/reports.md)
+* [Signatures](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/signatures.md)
+* [Tags](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/tags.md)
+* [Terminals](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/terminals.md)
+* [Tickets](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/tickets.md)
+* [Tokens](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/tokens.md)
+* [Webhooks](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/webhooks.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/http-response.md)
+* [HttpRequest](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/api-helper.md)
+* [HttpDateTime](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/http-date-time.md)
+* [RFC3339DateTime](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/rfc3339-date-time.md)
+* [UnixDateTime](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/unix-date-time.md)
+

fortis_python_sdk-1.0.10/README.md

@@ -0,0 +1,166 @@
+
+# Getting Started with Fortis API
+
+## 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 fortis-python-sdk==1.0.10
+```
+
+You can also view the package at:
+https://pypi.python.org/pypi/fortis-python-sdk/1.0.10
+
+## 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/fortispay/pythonsdk/tree/1.0.10/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/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: 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/fortispay/pythonsdk/tree/1.0.10/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| user_id_credentials | [`UserIdCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+| user_api_key_credentials | [`UserApiKeyCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
+| developer_id_credentials | [`DeveloperIdCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-2.md) | The credential object for Custom Header Signature |
+| access_token_credentials | [`AccessTokenCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-3.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```python
+from fortisapi.configuration import Environment
+from fortisapi.fortisapi_client import FortisapiClient
+from fortisapi.http.auth.access_token import AccessTokenCredentials
+from fortisapi.http.auth.developer_id import DeveloperIdCredentials
+from fortisapi.http.auth.user_api_key import UserApiKeyCredentials
+from fortisapi.http.auth.user_id import UserIdCredentials
+
+client = FortisapiClient(
+    user_id_credentials=UserIdCredentials(
+        user_id='user-id'
+    ),
+    user_api_key_credentials=UserApiKeyCredentials(
+        user_api_key='user-api-key'
+    ),
+    developer_id_credentials=DeveloperIdCredentials(
+        developer_id='developer-id'
+    ),
+    access_token_credentials=AccessTokenCredentials(
+        access_token='access-token'
+    ),
+    environment=Environment.SANDBOX
+)
+```
+
+### Environment-Based Client Initialization
+
+```python
+from fortisapi.fortisapi_client import FortisapiClient
+
+# Specify the path to your .env file if it’s located outside the project’s root directory.
+client = FortisapiClient.from_environment(dotenv_path='/path/to/.env')
+```
+
+See the [Environment-Based Client Initialization](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/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.
+
+* [`user-id (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature.md)
+* [`user-api-key (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-1.md)
+* [`developer-id (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-2.md)
+* [`access-token (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-3.md)
+
+## List of APIs
+
+* [Async Processing](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/async-processing.md)
+* [Declined Recurring Transactions](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/declined-recurring-transactions.md)
+* [Device Terms](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/device-terms.md)
+* [Full Boarding](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/full-boarding.md)
+* [3 DS Authentication](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/3-ds-authentication.md)
+* [3 DS Transactions](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/3-ds-transactions.md)
+* [Merchant Deposits](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/merchant-deposits.md)
+* [Enterprise Link Redirect](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/enterprise-link-redirect.md)
+* [On Boarding](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/on-boarding.md)
+* [Payment Card Reader Token](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/payment-card-reader-token.md)
+* [Calculate Surcharge](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/calculate-surcharge.md)
+* [Quick Invoices](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/quick-invoices.md)
+* [Transaction ACH Retries](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transaction-ach-retries.md)
+* [Transactions-ACH](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-ach.md)
+* [Transactions-Cash](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-cash.md)
+* [Transactions-Credit Card](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-credit-card.md)
+* [Transactions-EBT Card](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-ebt-card.md)
+* [Transactions-Read](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-read.md)
+* [Level 3 Data](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/level-3-data.md)
+* [Transactions-Updates](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-updates.md)
+* [Apple Pay Validate Merchant](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/apple-pay-validate-merchant.md)
+* [Merchant Details](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/merchant-details.md)
+* [Batches](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/batches.md)
+* [Contacts](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/contacts.md)
+* [Elements](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/elements.md)
+* [Locations](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/locations.md)
+* [Paylinks](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/paylinks.md)
+* [Recurring](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/recurring.md)
+* [Reports](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/reports.md)
+* [Signatures](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/signatures.md)
+* [Tags](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/tags.md)
+* [Terminals](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/terminals.md)
+* [Tickets](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/tickets.md)
+* [Tokens](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/tokens.md)
+* [Webhooks](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/webhooks.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/http-response.md)
+* [HttpRequest](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/api-helper.md)
+* [HttpDateTime](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/http-date-time.md)
+* [RFC3339DateTime](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/rfc3339-date-time.md)
+* [UnixDateTime](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/unix-date-time.md)
+

fortis_python_sdk-1.0.10/fortis_python_sdk.egg-info/PKG-INFO

@@ -0,0 +1,183 @@
+Metadata-Version: 2.4
+Name: fortis-python-sdk
+Version: 1.0.10
+Summary: Fortispay Python SDK
+Project-URL: docs, https://docs.fortis.tech
+Keywords: Fortis,payments,payment,erp,crm,embedded,integrated
+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 Fortis API
+
+## 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 fortis-python-sdk==1.0.10
+```
+
+You can also view the package at:
+https://pypi.python.org/pypi/fortis-python-sdk/1.0.10
+
+## 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/fortispay/pythonsdk/tree/1.0.10/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| environment | [`Environment`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/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: 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/fortispay/pythonsdk/tree/1.0.10/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| user_id_credentials | [`UserIdCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
+| user_api_key_credentials | [`UserApiKeyCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |
+| developer_id_credentials | [`DeveloperIdCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-2.md) | The credential object for Custom Header Signature |
+| access_token_credentials | [`AccessTokenCredentials`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-3.md) | The credential object for Custom Header Signature |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```python
+from fortisapi.configuration import Environment
+from fortisapi.fortisapi_client import FortisapiClient
+from fortisapi.http.auth.access_token import AccessTokenCredentials
+from fortisapi.http.auth.developer_id import DeveloperIdCredentials
+from fortisapi.http.auth.user_api_key import UserApiKeyCredentials
+from fortisapi.http.auth.user_id import UserIdCredentials
+
+client = FortisapiClient(
+    user_id_credentials=UserIdCredentials(
+        user_id='user-id'
+    ),
+    user_api_key_credentials=UserApiKeyCredentials(
+        user_api_key='user-api-key'
+    ),
+    developer_id_credentials=DeveloperIdCredentials(
+        developer_id='developer-id'
+    ),
+    access_token_credentials=AccessTokenCredentials(
+        access_token='access-token'
+    ),
+    environment=Environment.SANDBOX
+)
+```
+
+### Environment-Based Client Initialization
+
+```python
+from fortisapi.fortisapi_client import FortisapiClient
+
+# Specify the path to your .env file if it’s located outside the project’s root directory.
+client = FortisapiClient.from_environment(dotenv_path='/path/to/.env')
+```
+
+See the [Environment-Based Client Initialization](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/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.
+
+* [`user-id (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature.md)
+* [`user-api-key (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-1.md)
+* [`developer-id (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-2.md)
+* [`access-token (Custom Header Signature)`](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/auth/custom-header-signature-3.md)
+
+## List of APIs
+
+* [Async Processing](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/async-processing.md)
+* [Declined Recurring Transactions](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/declined-recurring-transactions.md)
+* [Device Terms](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/device-terms.md)
+* [Full Boarding](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/full-boarding.md)
+* [3 DS Authentication](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/3-ds-authentication.md)
+* [3 DS Transactions](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/3-ds-transactions.md)
+* [Merchant Deposits](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/merchant-deposits.md)
+* [Enterprise Link Redirect](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/enterprise-link-redirect.md)
+* [On Boarding](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/on-boarding.md)
+* [Payment Card Reader Token](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/payment-card-reader-token.md)
+* [Calculate Surcharge](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/calculate-surcharge.md)
+* [Quick Invoices](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/quick-invoices.md)
+* [Transaction ACH Retries](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transaction-ach-retries.md)
+* [Transactions-ACH](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-ach.md)
+* [Transactions-Cash](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-cash.md)
+* [Transactions-Credit Card](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-credit-card.md)
+* [Transactions-EBT Card](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-ebt-card.md)
+* [Transactions-Read](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-read.md)
+* [Level 3 Data](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/level-3-data.md)
+* [Transactions-Updates](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/transactions-updates.md)
+* [Apple Pay Validate Merchant](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/apple-pay-validate-merchant.md)
+* [Merchant Details](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/merchant-details.md)
+* [Batches](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/batches.md)
+* [Contacts](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/contacts.md)
+* [Elements](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/elements.md)
+* [Locations](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/locations.md)
+* [Paylinks](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/paylinks.md)
+* [Recurring](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/recurring.md)
+* [Reports](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/reports.md)
+* [Signatures](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/signatures.md)
+* [Tags](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/tags.md)
+* [Terminals](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/terminals.md)
+* [Tickets](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/tickets.md)
+* [Tokens](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/tokens.md)
+* [Webhooks](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/controllers/webhooks.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/environment-based-client-initialization.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/http-response.md)
+* [HttpRequest](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/http-request.md)
+
+### Utilities
+
+* [ApiHelper](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/api-helper.md)
+* [HttpDateTime](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/http-date-time.md)
+* [RFC3339DateTime](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/rfc3339-date-time.md)
+* [UnixDateTime](https://www.github.com/fortispay/pythonsdk/tree/1.0.10/doc/unix-date-time.md)
+