Skip to main content

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.

List of APIs

SDK Infrastructure

Configuration

HTTP

Utilities

Metadata

Release files for apimatic-greendot-sdk 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for apimatic-greendot-sdk 0.0.1
File Size Uploaded Provenance Actions
apimatic_greendot_sdk-0.0.1.tar.gz 552.3 kB Without provenance Details for apimatic_greendot_sdk-0.0.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for apimatic-greendot-sdk 0.0.1
File Interpreter ABI Platform Actions
apimatic_greendot_sdk-0.0.1-py3-none-any.whl Python 3 none any Details for apimatic_greendot_sdk-0.0.1-py3-none-any.whl

Total release size: 2.1 MB

Release files / apimatic_greendot_sdk-0.0.1.tar.gz

Download URL apimatic_greendot_sdk-0.0.1.tar.gz
Size 552.3 kB
Tags Source
SHA-256 checksum
How to use checksums
eb8704138ada948939f59bdb589340e34197dc4aad004f1ce094856cf435c17b
BLAKE2b-256 checksum
How to use checksums
1899fc46506c442f3139afee7d468bb00d547c9d93ef74f5c4b8246d465af2ec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Release files / apimatic_greendot_sdk-0.0.1-py3-none-any.whl

Download URL apimatic_greendot_sdk-0.0.1-py3-none-any.whl
Size 1.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
697e309f0ab64eb3039c0077c217148faece7a180b42dbb5ba6791e97ce4b8b3
BLAKE2b-256 checksum
How to use checksums
46c143ff0c5c0ed62ec8664eb577e7ea6c704080f16fb7de584c65151d3b6ffe
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.13

Security for apimatic-greendot-sdk 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page