digital-payments-sdk


Namedigital-payments-sdk JSON
Version 1.1.0 PyPI version JSON
download
home_pageNone
SummaryThe APIs detailed within this SDK will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.
upload_time2024-12-19 08:18:02
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseNone
keywords shell apimatic sdks apis digitalpayments
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            
# Getting Started with Shell SmartPay API

## Introduction

The APIs detailed within this document will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.

## Install the Package

The package is compatible with Python versions `3 >=3.7, <= 3.11`.
Install the package from PyPi using the following pip command:

```bash
pip install digital-payments-sdk==1.1.0
```

You can also view the package at:
https://pypi.python.org/pypi/digital-payments-sdk/1.1.0

## 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/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/client.md)

The following parameters are configurable for the API Client:

| Parameter | Type | Description |
|  --- | --- | --- |
| `environment` | `Environment` | The API environment. <br> **Default: `Environment.TEST`** |
| `http_client_instance` | `HttpClient` | 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']** |
| `mpp_token_credentials` | [`MppTokenCredentials`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
| `o_auth_token_post_credentials` | [`OAuthTokenPostCredentials`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |

The API client can be initialized as follows:

```python
client = ShellsmartpayapiClient(
    mpp_token_credentials=MppTokenCredentials(
        authorization='Authorization'
    ),
    o_auth_token_post_credentials=OAuthTokenPostCredentials(
        x_apigee_authorization='X-Apigee-Authorization'
    ),
    environment=Environment.TEST
)
```

## Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

### Fields

| Name | Description |
|  --- | --- |
| Test | **Default** |
| Production | - |

## Authorization

This API uses the following authentication schemes.

* [`MppToken (Custom Header Signature)`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/auth/custom-header-signature.md)
* [`oAuthTokenPost (Custom Header Signature)`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/auth/custom-header-signature-1.md)

## List of APIs

* [Shell API Platform Security Authentication](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/shell-api-platform-security-authentication.md)
* [Digital Payment Enablement](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/digital-payment-enablement.md)
* [Station Locator](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/station-locator.md)
* [Partner Notification](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/partner-notification.md)
* [Fueling](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/fueling.md)

## Classes Documentation

* [Utility Classes](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/http-request.md)

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "digital-payments-sdk",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": "Shell, APIMatic, SDKs, APIs, DigitalPayments",
    "author": null,
    "author_email": "developer sdksio <developer+sdksio@apimatic.io>",
    "download_url": "https://files.pythonhosted.org/packages/1c/80/746d7c7bbefcb184cd94b60b08db65f8918ab01e135b2e8677b5d8858eea/digital_payments_sdk-1.1.0.tar.gz",
    "platform": null,
    "description": "\n# Getting Started with Shell SmartPay API\n\n## Introduction\n\nThe APIs detailed within this document will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.\n\n## Install the Package\n\nThe package is compatible with Python versions `3 >=3.7, <= 3.11`.\nInstall the package from PyPi using the following pip command:\n\n```bash\npip install digital-payments-sdk==1.1.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/digital-payments-sdk/1.1.0\n\n## Test the SDK\n\nYou 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:\n\nNavigate to the root directory of the SDK and run the following commands\n\n```\npip install -r test-requirements.txt\npytest\n```\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n|  --- | --- | --- |\n| `environment` | `Environment` | The API environment. <br> **Default: `Environment.TEST`** |\n| `http_client_instance` | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| `override_http_client_configuration` | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| `http_call_back` | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| `timeout` | `float` | The value to use for connection timeout. <br> **Default: 60** |\n| `max_retries` | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| `backoff_factor` | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| `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]** |\n| `retry_methods` | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| `mpp_token_credentials` | [`MppTokenCredentials`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |\n| `o_auth_token_post_credentials` | [`OAuthTokenPostCredentials`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/auth/custom-header-signature-1.md) | The credential object for Custom Header Signature |\n\nThe API client can be initialized as follows:\n\n```python\nclient = ShellsmartpayapiClient(\n    mpp_token_credentials=MppTokenCredentials(\n        authorization='Authorization'\n    ),\n    o_auth_token_post_credentials=OAuthTokenPostCredentials(\n        x_apigee_authorization='X-Apigee-Authorization'\n    ),\n    environment=Environment.TEST\n)\n```\n\n## Environments\n\nThe SDK can be configured to use a different environment for making API calls. Available environments are:\n\n### Fields\n\n| Name | Description |\n|  --- | --- |\n| Test | **Default** |\n| Production | - |\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`MppToken (Custom Header Signature)`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/auth/custom-header-signature.md)\n* [`oAuthTokenPost (Custom Header Signature)`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/auth/custom-header-signature-1.md)\n\n## List of APIs\n\n* [Shell API Platform Security Authentication](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/shell-api-platform-security-authentication.md)\n* [Digital Payment Enablement](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/digital-payment-enablement.md)\n* [Station Locator](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/station-locator.md)\n* [Partner Notification](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/partner-notification.md)\n* [Fueling](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/controllers/fueling.md)\n\n## Classes Documentation\n\n* [Utility Classes](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.1.0/doc/http-request.md)\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "The APIs detailed within this SDK will enable Shell's Fleet Solutions Customers to digitalize Shell Card/s and use them to pay to refuel their vehicles at Shell Stations.",
    "version": "1.1.0",
    "project_urls": {
        "Documentation": "https://developer.shell.com/product-catalog/shell-smartpay-api/sdk#/http/setting-up-sdks"
    },
    "split_keywords": [
        "shell",
        " apimatic",
        " sdks",
        " apis",
        " digitalpayments"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d5d16ee6e37e77b8a240222d09a80bc53c04f1b895dee0f8c526fc3173cfd345",
                "md5": "0d99eab5c326b8a6ce62716693968272",
                "sha256": "f7937f997fb15d5950c44dff90774971c861da1bcc0c30f1b454bec5591b9649"
            },
            "downloads": -1,
            "filename": "digital_payments_sdk-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "0d99eab5c326b8a6ce62716693968272",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 69442,
            "upload_time": "2024-12-19T08:18:01",
            "upload_time_iso_8601": "2024-12-19T08:18:01.354643Z",
            "url": "https://files.pythonhosted.org/packages/d5/d1/6ee6e37e77b8a240222d09a80bc53c04f1b895dee0f8c526fc3173cfd345/digital_payments_sdk-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1c80746d7c7bbefcb184cd94b60b08db65f8918ab01e135b2e8677b5d8858eea",
                "md5": "a7bb2f1fe4021cf70638014ee80d1473",
                "sha256": "e06e7b420360b734bdb62f971f62619aa1889bbc4316ae0536ed2e0a3cdfe52a"
            },
            "downloads": -1,
            "filename": "digital_payments_sdk-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a7bb2f1fe4021cf70638014ee80d1473",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 32016,
            "upload_time": "2024-12-19T08:18:02",
            "upload_time_iso_8601": "2024-12-19T08:18:02.572686Z",
            "url": "https://files.pythonhosted.org/packages/1c/80/746d7c7bbefcb184cd94b60b08db65f8918ab01e135b2e8677b5d8858eea/digital_payments_sdk-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-19 08:18:02",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "digital-payments-sdk"
}
None
Elapsed time: 0.41730s