Metadata-Version: 2.4
Name: fdx-apimatic-sdk
Version: 0.0.1
Summary: Sample SDK from APIMatic
Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
Project-URL: Documentation, https://developer.financialdataexchange.org/
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 FDX V6.6.0 API

## Introduction

Financial Data Exchange V6.6.0 API (Core, Consent, Customer, Event Notifications, Fraud, Meta, Money Movement, Payroll, Recipient Registration, Registry, Tax)

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

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

## Initialize the API Client

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

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| environment | [`Environment`](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/README.md#environments) | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| 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/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| oauth_fapi_1_advanced_credentials | [`OauthFapi1AdvancedCredentials`](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
| oauth_fapi_1_baseline_credentials | [`OauthFapi1BaselineCredentials`](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
| tax_basic_auth_credentials | [`TaxBasicAuthCredentials`](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
import logging

from fdxv660api.configuration import Environment
from fdxv660api.fdxv_660_api_client import Fdxv660ApiClient
from fdxv660api.http.auth.oauth_fapi_1_advanced import OauthFapi1AdvancedCredentials
from fdxv660api.http.auth.oauth_fapi_1_baseline import OauthFapi1BaselineCredentials
from fdxv660api.http.auth.tax_basic_auth import TaxBasicAuthCredentials
from fdxv660api.logging.configuration.api_logging_configuration import LoggingConfiguration
from fdxv660api.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from fdxv660api.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration
from fdxv660api.models.oauth_scope_oauth_fapi_1_advanced import OauthScopeOauthFapi1Advanced
from fdxv660api.models.oauth_scope_oauth_fapi_1_baseline import OauthScopeOauthFapi1Baseline

client = Fdxv660ApiClient(
    oauth_fapi_1_advanced_credentials=OauthFapi1AdvancedCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_redirect_uri='OAuthRedirectUri',
        oauth_scopes=[
            OauthScopeOauthFapi1Advanced.FDXACCOUNTBASICREAD,
            OauthScopeOauthFapi1Advanced.FDXACCOUNTDETAILEDREAD
        ]
    ),
    oauth_fapi_1_baseline_credentials=OauthFapi1BaselineCredentials(
        oauth_client_id='OAuthClientId',
        oauth_client_secret='OAuthClientSecret',
        oauth_scopes=[
            OauthScopeOauthFapi1Baseline.FDXNOTIFICATIONSPUBLISH,
            OauthScopeOauthFapi1Baseline.FDXNOTIFICATIONSSUBSCRIBE
        ]
    ),
    tax_basic_auth_credentials=TaxBasicAuthCredentials(
        username='Username',
        password='Password'
    ),
    environment=Environment.PRODUCTION,
    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 fdxv660api.fdxv_660_api_client import Fdxv660ApiClient

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

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/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 | **Default** Financial Data Exchange V6 API (Data Provider / FI host) |
| ENVIRONMENT2 | FDX Registry host |

## Authorization

This API uses the following authentication schemes.

* [`OAuthFapi1Advanced (OAuth 2 Authorization Code Grant)`](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/auth/oauth-2-authorization-code-grant.md)
* [`OAuthFapi1Baseline (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/auth/oauth-2-client-credentials-grant.md)
* [`TaxBasicAuth (Basic Authentication)`](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/auth/basic-authentication.md)

## List of APIs

* [Account Information](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/account-information.md)
* [Account Statements](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/account-statements.md)
* [Account Transactions](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/account-transactions.md)
* [Money Movement](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/money-movement.md)
* [Personal Information](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/personal-information.md)
* [Reward Program Categories](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/reward-program-categories.md)
* [Reward Program Information](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/reward-program-information.md)
* [Terms and Conditions](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/terms-and-conditions.md)
* [User Consent](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/user-consent.md)
* [Event Notifications](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/event-notifications.md)
* [Fraud Notification](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/fraud-notification.md)
* [Internal Transfers](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/internal-transfers.md)
* [Payee Management](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/payee-management.md)
* [Payment Initiation Parties](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/payment-initiation-parties.md)
* [Recurring Payments](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/recurring-payments.md)
* [Request for Payments](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/request-for-payments.md)
* [Pay Stub Information](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/pay-stub-information.md)
* [Payroll Information](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/payroll-information.md)
* [Data Providers](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/data-providers.md)
* [Submit Tax Forms](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/submit-tax-forms.md)
* [Tax Forms](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/tax-forms.md)
* [Meta](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/meta.md)
* [Payments](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/payments.md)
* [Recipients](https://www.github.com/sdks-io/fdx-apimatic-python-sdk/tree/0.0.1/doc/controllers/recipients.md)

## SDK Infrastructure

### Configuration

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

### HTTP

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

### Utilities

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

