Metadata-Version: 2.4
Name: apimatic-greendot-sdk
Version: 0.0.1
Summary: This is a test SDK created as a PoC for Greendot by APIMatic
Author-email: developer sdksio <developer+sdksio@apimatic.io>
Project-URL: Documentation, https://apimatic.io
Keywords: Apimatic,sdksio
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 Gd.Bos.V1

## Introduction

Green Dot BaaS Partner 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 apimatic-greendot-sdk==0.0.1
```

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

## Initialize the API Client

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

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| default_host | `str` | *Default*: `"www.example.com"` |
| environment | [`Environment`](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/README.md#environments) | The API environment. 
 **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. 
 **Default: 60** |
| max_retries | `int` | The number of times to retry an endpoint call if it fails. 
 **Default: 0** |
| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. 
 **Default: 2** |
| retry_statuses | `Array of int` | The http statuses on which retry is to be done. 
 **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. 
 **Default: ["GET", "PUT"]** |
| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/apimatic-greendot-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/apimatic-greendot-python-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| custom_header_authentication_credentials | [`CustomHeaderAuthenticationCredentials`](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |

The API client can be initialized as follows:

### Code-Based Client Initialization

```python
import logging

from gdbosv1.configuration import Environment
from gdbosv1.gdbosv_1_client import Gdbosv1Client
from gdbosv1.http.auth.custom_header_authentication import CustomHeaderAuthenticationCredentials
from gdbosv1.logging.configuration.api_logging_configuration import LoggingConfiguration
from gdbosv1.logging.configuration.api_logging_configuration import RequestLoggingConfiguration
from gdbosv1.logging.configuration.api_logging_configuration import ResponseLoggingConfiguration

client = Gdbosv1Client(
    custom_header_authentication_credentials=CustomHeaderAuthenticationCredentials(
        authorization='Authorization'
    ),
    environment=Environment.PRODUCTION,
    default_host='www.example.com',
    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 gdbosv1.gdbosv_1_client import Gdbosv1Client

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

See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/apimatic-greendot-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** |

## Authorization

This API uses the following authentication schemes.

* [`Bearer (Custom Header Signature)`](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/auth/custom-header-signature.md)

## List of APIs

* [Health Checks](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/health-checks.md)
* [AB Testing Admin](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/ab-testing-admin.md)
* [Account](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/account.md)
* [Adjustment](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/adjustment.md)
* [Affiliate](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/affiliate.md)
* [AMM Rule](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/amm-rule.md)
* [Authentication](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/authentication.md)
* [Bill Pay](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/bill-pay.md)
* [Business Profile](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/business-profile.md)
* [Card Option](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/card-option.md)
* [Care Case](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/care-case.md)
* [Cashback Reward](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/cashback-reward.md)
* [Categorize Transaction](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/categorize-transaction.md)
* [Contact Verification](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/contact-verification.md)
* [Credit Builder](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/credit-builder.md)
* [Custom Card](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/custom-card.md)
* [Device Verification](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/device-verification.md)
* [Direct Deposit](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/direct-deposit.md)
* [Disbursement](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/disbursement.md)
* [Dispute Automation](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/dispute-automation.md)
* [E Cash](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/e-cash.md)
* [E Gift](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/e-gift.md)
* [Enrollments](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/enrollments.md)
* [Event](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/event.md)
* [Experian](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/experian.md)
* [External Account](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/external-account.md)
* [External Cards](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/external-cards.md)
* [Feature Eligibility](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/feature-eligibility.md)
* [Fee](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/fee.md)
* [Guest Verification](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/guest-verification.md)
* [Health Check](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/health-check.md)
* [Hosted User Experience](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/hosted-user-experience.md)
* [Interest Rate](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/interest-rate.md)
* [Kyc](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/kyc.md)
* [Locator](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/locator.md)
* [Notification](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/notification.md)
* [Order](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/order.md)
* [Paper Check](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/paper-check.md)
* [Payment](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/payment.md)
* [Payment Instrument](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/payment-instrument.md)
* [Payment Instrument Token](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/payment-instrument-token.md)
* [Payment Instrument Vgs](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/payment-instrument-vgs.md)
* [Product Feature Limits](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/product-feature-limits.md)
* [Products](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/products.md)
* [Program](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/program.md)
* [Purse](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/purse.md)
* [Scc](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/scc.md)
* [Scc Eligibilities](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/scc-eligibilities.md)
* [Token Management](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/token-management.md)
* [Transaction Event](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/transaction-event.md)
* [Transactions](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/transactions.md)
* [Transfers](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/transfers.md)
* [Users](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/users.md)
* [VIP Feature](https://www.github.com/sdks-io/apimatic-greendot-python-sdk/tree/0.0.1/doc/controllers/vip-feature.md)

## SDK Infrastructure

### Configuration

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

### HTTP

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

### Utilities

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

