apimatic-greendot-sdk 0.0.1

This is a test SDK created as a PoC for Greendot by APIMatic

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:

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.

The following parameters are configurable for the API Client:

Parameter	Type	Description
default_host	str	Default: "www.example.com"
environment	Environment	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	Optional proxy configuration to route HTTP requests through a proxy server.
logging_configuration	LoggingConfiguration	The SDK logging configuration for API calls
custom_header_authentication_credentials	CustomHeaderAuthenticationCredentials	The credential object for Custom Header Signature

The API client can be initialized as follows:

Code-Based Client Initialization

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

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 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)

List of APIs

• Health Checks
• AB Testing Admin
• Account
• Adjustment
• Affiliate
• AMM Rule
• Authentication
• Bill Pay
• Business Profile
• Card Option
• Care Case
• Cashback Reward
• Categorize Transaction
• Contact Verification
• Credit Builder
• Custom Card
• Device Verification
• Direct Deposit
• Disbursement
• Dispute Automation
• E Cash
• E Gift
• Enrollments
• Event
• Experian
• External Account
• External Cards
• Feature Eligibility
• Fee
• Guest Verification
• Health Check
• Hosted User Experience
• Interest Rate
• Kyc
• Locator
• Notification
• Order
• Paper Check
• Payment
• Payment Instrument
• Payment Instrument Token
• Payment Instrument Vgs
• Product Feature Limits
• Products
• Program
• Purse
• Scc
• Scc Eligibilities
• Token Management
• Transaction Event
• Transactions
• Transfers
• Users
• VIP Feature

SDK Infrastructure

Configuration

• ProxySettings
• Environment-Based Client Initialization
• AbstractLogger
• LoggingConfiguration
• RequestLoggingConfiguration
• ResponseLoggingConfiguration

HTTP

• HttpResponse
• HttpRequest

Utilities

• ApiResponse
• ApiHelper
• HttpDateTime
• RFC3339DateTime
• UnixDateTime