# splitit-onboarding-python-sdk
Splitit's Onboarding API
- API version: 1.0.0
- Package version: 3.0.0
## Requirements.
Python >=3.7
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install splitit-onboarding-python-sdk==3.0.0
```
(you may need to run `pip` with root permission: `sudo pip install splitit-onboarding-python-sdk==3.0.0`)
Then import the package:
```python
import splitit_client
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from pprint import pprint
from splitit_client import Splitit
splitit = Splitit(
# Defining the host is optional and defaults to https://onboarding-v2.sandbox.splitit.com
# See configuration.py for a list of all supported configuration parameters.
host = "https://onboarding-v2.sandbox.splitit.com",
# Configure OAuth2 access token for authorization: oauth2
access_token = 'YOUR_ACCESS_TOKEN'
)
get_countries_response = splitit.data.get_countries()
try:
pprint(get_countries_response.body["countries"])
pprint(get_countries_response.headers)
pprint(get_countries_response.status)
except ApiException as e:
print("Exception when calling CountriesResponse.get_countries: %s\n" % e)
pprint(e.body)
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
```
## Documentation for API Endpoints
All URIs are relative to *https://onboarding-v2.sandbox.splitit.com*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DataApi* | [**get_countries**](docs/apis/tags/DataApi.md#get_countries) | **get** /api/data/get-countries |
*DataApi* | [**get_currencies**](docs/apis/tags/DataApi.md#get_currencies) | **get** /api/data/get-currencies |
*DataApi* | [**get_processors**](docs/apis/tags/DataApi.md#get_processors) | **get** /api/data/get-processors |
*DataApi* | [**get_verticals**](docs/apis/tags/DataApi.md#get_verticals) | **get** /api/data/get-verticals |
*DataApi* | [**status_legend**](docs/apis/tags/DataApi.md#status_legend) | **get** /api/data/status-legend |
*MerchantsApi* | [**create**](docs/apis/tags/MerchantsApi.md#create) | **post** /api/merchants/create |
*MerchantsApi* | [**create_developer**](docs/apis/tags/MerchantsApi.md#create_developer) | **post** /api/merchants/create/developer |
*MerchantsApi* | [**get**](docs/apis/tags/MerchantsApi.md#get) | **get** /api/merchants/get |
*MerchantsApi* | [**get_details**](docs/apis/tags/MerchantsApi.md#get_details) | **get** /api/merchants/get-details |
## Documentation For Models
- [CountriesResponse](docs/models/CountriesResponse.md)
- [CountryResponse](docs/models/CountryResponse.md)
- [CreateDeveloperRequest](docs/models/CreateDeveloperRequest.md)
- [CreateMerchantRequest](docs/models/CreateMerchantRequest.md)
- [CreateMerchantResponse](docs/models/CreateMerchantResponse.md)
- [CurrenciesResponse](docs/models/CurrenciesResponse.md)
- [CurrencyResponse](docs/models/CurrencyResponse.md)
- [EnumDTO](docs/models/EnumDTO.md)
- [Error](docs/models/Error.md)
- [GetMerchantDetailsResponse](docs/models/GetMerchantDetailsResponse.md)
- [GetMerchantResponse](docs/models/GetMerchantResponse.md)
- [GetMerchantsResponse](docs/models/GetMerchantsResponse.md)
- [MerchantVerticalResponse](docs/models/MerchantVerticalResponse.md)
- [MerchantVerticalsResponse](docs/models/MerchantVerticalsResponse.md)
- [ProcessorAuthenticationParametersRequest](docs/models/ProcessorAuthenticationParametersRequest.md)
- [ProcessorResponse](docs/models/ProcessorResponse.md)
- [ProcessorsResponse](docs/models/ProcessorsResponse.md)
- [RequestHeaderSlim](docs/models/RequestHeaderSlim.md)
- [ResponseHeader](docs/models/ResponseHeader.md)
- [SelfOnBoardingErrorResponse](docs/models/SelfOnBoardingErrorResponse.md)
- [StatusLegendResponse](docs/models/StatusLegendResponse.md)
## Documentation For Authorization
Authentication schemes defined for the API:
## oauth2
- **Type**: OAuth
- **Flow**: application
- **Authorization URL**:
- **Scopes**:
- **onboarding.api.v2**: onboarding.api.v2
## Author
This Python package is automatically generated by [Konfig](https://konfigthis.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/konfig-dev/splitit-onboarding-sdks/tree/main/python",
"name": "splitit-onboarding-python-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "OpenAPI,Konfig,Splitit.OnBoarding.Api.V2",
"author": "Konfig",
"author_email": "engineering@konfigthis.com",
"download_url": "https://files.pythonhosted.org/packages/89/bc/bbdc0a5bb4336fdbdc11b52f7098ce065bc55b33d84780cf954012e95610/splitit-onboarding-python-sdk-3.0.0.tar.gz",
"platform": null,
"description": "# splitit-onboarding-python-sdk\nSplitit's Onboarding API\n\n- API version: 1.0.0\n- Package version: 3.0.0\n\n## Requirements.\n\nPython >=3.7\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install splitit-onboarding-python-sdk==3.0.0\n```\n(you may need to run `pip` with root permission: `sudo pip install splitit-onboarding-python-sdk==3.0.0`)\n\nThen import the package:\n```python\nimport splitit_client\n```\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom pprint import pprint\nfrom splitit_client import Splitit\n\nsplitit = Splitit(\n # Defining the host is optional and defaults to https://onboarding-v2.sandbox.splitit.com\n # See configuration.py for a list of all supported configuration parameters.\n host = \"https://onboarding-v2.sandbox.splitit.com\",\n\n # Configure OAuth2 access token for authorization: oauth2\n access_token = 'YOUR_ACCESS_TOKEN'\n)\n\nget_countries_response = splitit.data.get_countries()\ntry:\n pprint(get_countries_response.body[\"countries\"])\n pprint(get_countries_response.headers)\n pprint(get_countries_response.status)\nexcept ApiException as e:\n print(\"Exception when calling CountriesResponse.get_countries: %s\\n\" % e)\n pprint(e.body)\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://onboarding-v2.sandbox.splitit.com*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DataApi* | [**get_countries**](docs/apis/tags/DataApi.md#get_countries) | **get** /api/data/get-countries | \n*DataApi* | [**get_currencies**](docs/apis/tags/DataApi.md#get_currencies) | **get** /api/data/get-currencies | \n*DataApi* | [**get_processors**](docs/apis/tags/DataApi.md#get_processors) | **get** /api/data/get-processors | \n*DataApi* | [**get_verticals**](docs/apis/tags/DataApi.md#get_verticals) | **get** /api/data/get-verticals | \n*DataApi* | [**status_legend**](docs/apis/tags/DataApi.md#status_legend) | **get** /api/data/status-legend | \n*MerchantsApi* | [**create**](docs/apis/tags/MerchantsApi.md#create) | **post** /api/merchants/create | \n*MerchantsApi* | [**create_developer**](docs/apis/tags/MerchantsApi.md#create_developer) | **post** /api/merchants/create/developer | \n*MerchantsApi* | [**get**](docs/apis/tags/MerchantsApi.md#get) | **get** /api/merchants/get | \n*MerchantsApi* | [**get_details**](docs/apis/tags/MerchantsApi.md#get_details) | **get** /api/merchants/get-details | \n\n## Documentation For Models\n\n - [CountriesResponse](docs/models/CountriesResponse.md)\n - [CountryResponse](docs/models/CountryResponse.md)\n - [CreateDeveloperRequest](docs/models/CreateDeveloperRequest.md)\n - [CreateMerchantRequest](docs/models/CreateMerchantRequest.md)\n - [CreateMerchantResponse](docs/models/CreateMerchantResponse.md)\n - [CurrenciesResponse](docs/models/CurrenciesResponse.md)\n - [CurrencyResponse](docs/models/CurrencyResponse.md)\n - [EnumDTO](docs/models/EnumDTO.md)\n - [Error](docs/models/Error.md)\n - [GetMerchantDetailsResponse](docs/models/GetMerchantDetailsResponse.md)\n - [GetMerchantResponse](docs/models/GetMerchantResponse.md)\n - [GetMerchantsResponse](docs/models/GetMerchantsResponse.md)\n - [MerchantVerticalResponse](docs/models/MerchantVerticalResponse.md)\n - [MerchantVerticalsResponse](docs/models/MerchantVerticalsResponse.md)\n - [ProcessorAuthenticationParametersRequest](docs/models/ProcessorAuthenticationParametersRequest.md)\n - [ProcessorResponse](docs/models/ProcessorResponse.md)\n - [ProcessorsResponse](docs/models/ProcessorsResponse.md)\n - [RequestHeaderSlim](docs/models/RequestHeaderSlim.md)\n - [ResponseHeader](docs/models/ResponseHeader.md)\n - [SelfOnBoardingErrorResponse](docs/models/SelfOnBoardingErrorResponse.md)\n - [StatusLegendResponse](docs/models/StatusLegendResponse.md)\n\n## Documentation For Authorization\n\n Authentication schemes defined for the API:\n## oauth2\n\n- **Type**: OAuth\n- **Flow**: application\n- **Authorization URL**: \n- **Scopes**: \n - **onboarding.api.v2**: onboarding.api.v2\n\n\n\n## Author\nThis Python package is automatically generated by [Konfig](https://konfigthis.com)\n",
"bugtrack_url": null,
"license": "",
"summary": "Splitit.OnBoarding.Api.V2",
"version": "3.0.0",
"split_keywords": [
"openapi",
"konfig",
"splitit.onboarding.api.v2"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "05fd55f3c69b4e00de5fd409d40c84ff8e78d2a24a5a8c29f97c5bb755eb6dbb",
"md5": "1c7d57a9b56b96bfa37995464a416d5f",
"sha256": "7224ae4db38bad44f2eb675f2fd2a159a37d639edf899dcb903cefd4205339a3"
},
"downloads": -1,
"filename": "splitit_onboarding_python_sdk-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c7d57a9b56b96bfa37995464a416d5f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 98329,
"upload_time": "2023-03-23T10:04:18",
"upload_time_iso_8601": "2023-03-23T10:04:18.231383Z",
"url": "https://files.pythonhosted.org/packages/05/fd/55f3c69b4e00de5fd409d40c84ff8e78d2a24a5a8c29f97c5bb755eb6dbb/splitit_onboarding_python_sdk-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "89bcbbdc0a5bb4336fdbdc11b52f7098ce065bc55b33d84780cf954012e95610",
"md5": "ab94f2b6d2ade227f607dcc31395aa7e",
"sha256": "84f635f65759a0432785a3dacb3559bc0d2d27ef7995c7872e80167a493025da"
},
"downloads": -1,
"filename": "splitit-onboarding-python-sdk-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "ab94f2b6d2ade227f607dcc31395aa7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 58415,
"upload_time": "2023-03-23T10:04:21",
"upload_time_iso_8601": "2023-03-23T10:04:21.276001Z",
"url": "https://files.pythonhosted.org/packages/89/bc/bbdc0a5bb4336fdbdc11b52f7098ce065bc55b33d84780cf954012e95610/splitit-onboarding-python-sdk-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-03-23 10:04:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "splitit-onboarding-python-sdk"
}
JSON