Name | digital-payments-sdk JSON |
Version |
1.0.0
JSON |
| download |
home_page | None |
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. |
upload_time | 2024-06-06 10:47:59 |
maintainer | None |
docs_url | None |
author | None |
requires_python | >=3.7 |
license | None |
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 EV
## 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:
```python
pip install digital-payments-sdk==1.0.0
```
You can also view the package at:
https://pypi.python.org/pypi/digital-payments-sdk/1.0.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.0.0/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| `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.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/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.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/custom-header-signature-1.md) | The credential object for Custom Header Signature |
The API client can be initialized as follows:
```python
client = ShellevClient(
mpp_token_credentials=MppTokenCredentials(
authorization='Authorization'
),
o_auth_token_post_credentials=OAuthTokenPostCredentials(
x_apigee_authorization='X-Apigee-Authorization'
),
environment=Environment.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.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/custom-header-signature.md)
* [`oAuthTokenPost (Custom Header Signature)`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/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.0.0/doc/controllers/shell-api-platform-security-authentication.md)
* [Digital Payment Enablement](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/controllers/digital-payment-enablement.md)
* [Station Locator](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/controllers/station-locator.md)
* [Partner Notification](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/controllers/partner-notification.md)
* [Fueling](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/controllers/fueling.md)
## Classes Documentation
* [Utility Classes](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/utility-classes.md)
* [HttpResponse](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/http-response.md)
* [HttpRequest](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.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/86/52/d51563d9092d400605651e1b0ab789b70d15226cb6c78f69bd2562a75cef/digital_payments_sdk-1.0.0.tar.gz",
"platform": null,
"description": "\n# Getting Started with Shell EV\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```python\npip install digital-payments-sdk==1.0.0\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/digital-payments-sdk/1.0.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.0.0/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\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.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/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.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/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 = ShellevClient(\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.PRODUCTION\n)\n```\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.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/custom-header-signature.md)\n* [`oAuthTokenPost (Custom Header Signature)`](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/$a/https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/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.0.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.0.0/doc/controllers/digital-payment-enablement.md)\n* [Station Locator](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/controllers/station-locator.md)\n* [Partner Notification](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/controllers/partner-notification.md)\n* [Fueling](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.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.0.0/doc/utility-classes.md)\n* [HttpResponse](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.0/doc/http-response.md)\n* [HttpRequest](https://www.github.com/sdks-io/digital-payments-python-sdk/tree/1.0.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.0.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": "eb8c32ef8e58e210c78ca0c472ecdb09c76a7475d4b599bc07c24c1dad8d13a1",
"md5": "9467f3b9a1aadd041de4b1804640f2eb",
"sha256": "df5799424febb985bb0056e9559e9dc6f12f38f2a6c67f3098f6d397d630f714"
},
"downloads": -1,
"filename": "digital_payments_sdk-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9467f3b9a1aadd041de4b1804640f2eb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 68299,
"upload_time": "2024-06-06T10:47:57",
"upload_time_iso_8601": "2024-06-06T10:47:57.172181Z",
"url": "https://files.pythonhosted.org/packages/eb/8c/32ef8e58e210c78ca0c472ecdb09c76a7475d4b599bc07c24c1dad8d13a1/digital_payments_sdk-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8652d51563d9092d400605651e1b0ab789b70d15226cb6c78f69bd2562a75cef",
"md5": "28b49dba0fd15c169e12d5cce8692197",
"sha256": "472a18ffa9f5f644161f03abd37cf37a762bd7238853a2ce2273957359345d91"
},
"downloads": -1,
"filename": "digital_payments_sdk-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "28b49dba0fd15c169e12d5cce8692197",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 30616,
"upload_time": "2024-06-06T10:47:59",
"upload_time_iso_8601": "2024-06-06T10:47:59.103371Z",
"url": "https://files.pythonhosted.org/packages/86/52/d51563d9092d400605651e1b0ab789b70d15226cb6c78f69bd2562a75cef/digital_payments_sdk-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-06 10:47:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "digital-payments-sdk"
}