splitit-python-sdk
Splitit's API
This Python package is automatically generated by the Konfig:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.PythonPriorClientCodegen
Requirements.
Python >=3.6
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/konfig-dev/splitit-sdks/tree/main/python.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/konfig-dev/splitit-sdks/tree/main/python.git)
Then import the package:
import splitit_client
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import splitit_client
Getting Started
Please follow the installation procedure and then run the following:
import time
import splitit_client
from pprint import pprint
from splitit_client.api import installment_plan_api
from splitit_client.model.failed_response import FailedResponse
from splitit_client.model.installment_plan_cancel_response import InstallmentPlanCancelResponse
from splitit_client.model.installment_plan_create_request import InstallmentPlanCreateRequest
from splitit_client.model.installment_plan_get_response import InstallmentPlanGetResponse
from splitit_client.model.installment_plan_model import InstallmentPlanModel
from splitit_client.model.installment_plan_refund_request import InstallmentPlanRefundRequest
from splitit_client.model.installment_plan_refund_response import InstallmentPlanRefundResponse
from splitit_client.model.installment_plan_update_request_by_identifier import InstallmentPlanUpdateRequestByIdentifier
from splitit_client.model.installment_plan_update_response import InstallmentPlanUpdateResponse
from splitit_client.model.plan_error_response import PlanErrorResponse
from splitit_client.model.update_order_request import UpdateOrderRequest
from splitit_client.model.verify_authorization_response import VerifyAuthorizationResponse
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
client_id = os.environ["CLIENT_ID"]
client_secret = os.environ["CLIENT_SECRET"]
configuration = splitit_client.Configuration(
# Defining the host is optional and defaults to https://web-api-v3.sandbox.splitit.com
# See configuration.py for a list of all supported configuration parameters.
host = 'https://web-api-v3.sandbox.splitit.com'
client_id=client_id,
client_secret=client_secret
)
# Enter a context with an instance of the API client
with splitit_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = installment_plan_api.InstallmentPlanApi(api_client)
installment_plan_number = "installmentPlanNumber_example" # str |
x_splitit_idempotency_key = "X-Splitit-IdempotencyKey_example" # str |
try:
api_response = api_instance.cancel(installment_plan_number, x_splitit_idempotency_key)
pprint(api_response)
except splitit_client.ApiException as e:
print("Exception when calling InstallmentPlanApi->cancel: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to https://web-api-v3.sandbox.splitit.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| InstallmentPlanApi | cancel | POST /api/installmentplans/{installmentPlanNumber}/cancel | |
| InstallmentPlanApi | get | GET /api/installmentplans/{installmentPlanNumber} | |
| InstallmentPlanApi | post | POST /api/installmentplans | |
| InstallmentPlanApi | refund | POST /api/installmentplans/{installmentPlanNumber}/refund | |
| InstallmentPlanApi | search | GET /api/installmentplans/search | |
| InstallmentPlanApi | update_order | PUT /api/installmentplans/{installmentPlanNumber}/updateorder | |
| InstallmentPlanApi | update_order2 | PUT /api/installmentplans/updateorder | |
| InstallmentPlanApi | verify_authorization | GET /api/installmentplans/{installmentPlanNumber}/verifyauthorization |
Documentation For Models
- AddressData
- AddressDataModel
- AuthorizationModel
- CardData
- Error
- ErrorExtended
- ErrorExtendedAllOf
- FailedResponse
- FailedResponseAllOf
- GwAuthorizationStatus
- IdentifierContract
- Installment
- InstallmentPlanCancelResponse
- InstallmentPlanCreateRequest
- InstallmentPlanGetResponse
- InstallmentPlanGetResponseAllOf
- InstallmentPlanModel
- InstallmentPlanModelAllOf
- InstallmentPlanRefundRequest
- InstallmentPlanRefundResponse
- InstallmentPlanRefundResponseAllOf
- InstallmentPlanUpdateRequest
- InstallmentPlanUpdateRequestByIdentifier
- InstallmentPlanUpdateRequestByIdentifierAllOf
- InstallmentPlanUpdateResponse
- InstallmentPlanUpdateResponseAllOf
- InstallmentStatus
- LinksData
- PaymentMethodModel
- PaymentMethodType
- PlanDataModel
- PlanErrorResponse
- PlanErrorResponseAllOf
- PlanStatus
- PurchaseMethod
- RedirectionEndpointsModel
- RefundStrategy
- RefundSummary
- ResponseV2
- ShippingStatus
- ShippingStatus2
- ShopperData
- TestModes
- ThreeDsRedirectData
- UpdateOrderRequest
- VerifyAuthorizationResponse
- VerifyAuthorizationResponseAllOf
Documentation For Authorization
bearer
- Type: OAuth
- Flow: application
- Authorization URL:
- Scopes:
- api.v3:
Author
Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in splitit_client.apis and splitit_client.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1: Use specific imports for apis and models like:
from splitit_client.api.default_api import DefaultApifrom splitit_client.model.pet import Pet
Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:
import sys
sys.setrecursionlimit(1500)
import splitit_client
from splitit_client.apis import *
from splitit_client.models import *
Metadata
Release files for splitit-python-sdk 1.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| splitit-python-sdk-1.0.0.tar.gz | 67.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| splitit_python_sdk-1.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 235.8 kB
Release files / splitit-python-sdk-1.0.0.tar.gz
| Download URL | splitit-python-sdk-1.0.0.tar.gz |
|---|---|
| Size | 67.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1ddbe683c6b53a25b18f051662c332f69663ee8596296b263144ab58789ef69b
|
|
BLAKE2b-256 checksum How to use checksums |
4c60952d4ce633f3491c4d9850e53596c76d5364918f06d9aaed82a027f63a7b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.8
|
Release files / splitit_python_sdk-1.0.0-py3-none-any.whl
| Download URL | splitit_python_sdk-1.0.0-py3-none-any.whl |
|---|---|
| Size | 168.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
13aadcfa7173e590275206d7e9aa4b0c6b46904c5d9995ca4f1888eb662fb32a
|
|
BLAKE2b-256 checksum How to use checksums |
1b4f714633bcdcca08aff1233272e6f13607494494e165afc272be23e05e3479
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.1 CPython/3.10.8
|