splitit-apimatic-sdk 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. splitit_apimatic_sdk-1.0.0/LICENSE +28 -0
  2. splitit_apimatic_sdk-1.0.0/MANIFEST.in +2 -0
  3. splitit_apimatic_sdk-1.0.0/PKG-INFO +135 -0
  4. splitit_apimatic_sdk-1.0.0/README.md +118 -0
  5. splitit_apimatic_sdk-1.0.0/pyproject.toml +25 -0
  6. splitit_apimatic_sdk-1.0.0/setup.cfg +8 -0
  7. splitit_apimatic_sdk-1.0.0/splitit_apimatic_sdk.egg-info/PKG-INFO +135 -0
  8. splitit_apimatic_sdk-1.0.0/splitit_apimatic_sdk.egg-info/SOURCES.txt +97 -0
  9. splitit_apimatic_sdk-1.0.0/splitit_apimatic_sdk.egg-info/dependency_links.txt +1 -0
  10. splitit_apimatic_sdk-1.0.0/splitit_apimatic_sdk.egg-info/requires.txt +7 -0
  11. splitit_apimatic_sdk-1.0.0/splitit_apimatic_sdk.egg-info/top_level.txt +3 -0
  12. splitit_apimatic_sdk-1.0.0/splititwebapiv4/__init__.py +12 -0
  13. splitit_apimatic_sdk-1.0.0/splititwebapiv4/api_helper.py +19 -0
  14. splitit_apimatic_sdk-1.0.0/splititwebapiv4/configuration.py +267 -0
  15. splitit_apimatic_sdk-1.0.0/splititwebapiv4/controllers/__init__.py +7 -0
  16. splitit_apimatic_sdk-1.0.0/splititwebapiv4/controllers/base_controller.py +67 -0
  17. splitit_apimatic_sdk-1.0.0/splititwebapiv4/controllers/installment_plan_controller.py +430 -0
  18. splitit_apimatic_sdk-1.0.0/splititwebapiv4/controllers/o_auth_authorization_controller.py +87 -0
  19. splitit_apimatic_sdk-1.0.0/splititwebapiv4/exceptions/__init__.py +7 -0
  20. splitit_apimatic_sdk-1.0.0/splititwebapiv4/exceptions/api_error_response_exception.py +71 -0
  21. splitit_apimatic_sdk-1.0.0/splititwebapiv4/exceptions/api_exception.py +36 -0
  22. splitit_apimatic_sdk-1.0.0/splititwebapiv4/exceptions/o_auth_provider_exception.py +73 -0
  23. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/__init__.py +11 -0
  24. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/auth/__init__.py +6 -0
  25. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/auth/api_key.py +100 -0
  26. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/auth/o_auth_2.py +350 -0
  27. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/http_call_back.py +20 -0
  28. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/http_client_provider.py +23 -0
  29. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/http_method_enum.py +25 -0
  30. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/http_request.py +55 -0
  31. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/http_response.py +45 -0
  32. splitit_apimatic_sdk-1.0.0/splititwebapiv4/http/proxy_settings.py +50 -0
  33. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/__init__.py +66 -0
  34. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/amount_data.py +98 -0
  35. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/api_error_model.py +154 -0
  36. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/apr_data.py +98 -0
  37. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/authorization_status_enum.py +46 -0
  38. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/authorize_authorization_data.py +265 -0
  39. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/authorize_request.py +178 -0
  40. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/authorize_response.py +357 -0
  41. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/billing_address_data.py +200 -0
  42. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/card_details.py +170 -0
  43. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/card_validity_request.py +89 -0
  44. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/card_validity_response.py +106 -0
  45. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/checkout_url_data.py +110 -0
  46. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/content_segment.py +154 -0
  47. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/external_provider_types_enum.py +52 -0
  48. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/inline_content.py +93 -0
  49. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/installment_item.py +141 -0
  50. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/installment_plan_details_response.py +459 -0
  51. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/installment_plan_search_details_response.py +93 -0
  52. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/installment_plan_search_request.py +109 -0
  53. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/installment_plan_status_enum.py +70 -0
  54. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/installment_status_enum.py +61 -0
  55. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/masked_card_details.py +131 -0
  56. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/metadata_item.py +108 -0
  57. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/o_auth_provider_error_enum.py +67 -0
  58. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/o_auth_scope_o_auth_2_enum.py +42 -0
  59. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/o_auth_token.py +113 -0
  60. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offer_item.py +277 -0
  61. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offers_billing_address.py +170 -0
  62. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offers_card_details.py +170 -0
  63. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offers_merchant_details.py +125 -0
  64. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offers_payment_method.py +82 -0
  65. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offers_payment_method_response.py +138 -0
  66. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offers_request.py +217 -0
  67. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offers_response.py +241 -0
  68. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offers_shopper_details.py +185 -0
  69. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/offers_store_location.py +170 -0
  70. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/payment_link_request.py +329 -0
  71. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/payment_link_response.py +171 -0
  72. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/payment_method.py +76 -0
  73. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/payment_method_data.py +120 -0
  74. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/payment_method_type_enum.py +40 -0
  75. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/pis_error_codes_enum.py +763 -0
  76. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/plan_authorization_data.py +290 -0
  77. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/plan_links_data.py +154 -0
  78. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/plan_status_enum.py +52 -0
  79. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/processing_data.py +85 -0
  80. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/purchase_method_enum.py +55 -0
  81. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/redirect_urls.py +121 -0
  82. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/refund_item.py +215 -0
  83. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/refund_request.py +98 -0
  84. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/refund_response.py +167 -0
  85. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/shipping_status_enum.py +46 -0
  86. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/shopper_details_data.py +205 -0
  87. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/three_ds_authentication_data.py +108 -0
  88. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/three_ds_execute.py +85 -0
  89. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/three_ds_redirect_data.py +154 -0
  90. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/three_ds_request_data.py +140 -0
  91. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/update_offers_payment_method.py +81 -0
  92. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/update_offers_request.py +171 -0
  93. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/update_order_request.py +152 -0
  94. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/update_order_response.py +198 -0
  95. splitit_apimatic_sdk-1.0.0/splititwebapiv4/models/validation_error.py +108 -0
  96. splitit_apimatic_sdk-1.0.0/splititwebapiv4/splititwebapiv_4_client.py +93 -0
  97. splitit_apimatic_sdk-1.0.0/splititwebapiv4/utilities/__init__.py +6 -0
  98. splitit_apimatic_sdk-1.0.0/splititwebapiv4/utilities/file_wrapper.py +45 -0
@@ -0,0 +1,28 @@
1
+ License:
2
+ ========
3
+ The MIT License (MIT)
4
+ http://opensource.org/licenses/MIT
5
+
6
+ Copyright (c) 2014 - 2026 APIMATIC Limited
7
+
8
+ Permission is hereby granted, free of charge, to any person obtaining a copy
9
+ of this software and associated documentation files (the "Software"), to deal
10
+ in the Software without restriction, including without limitation the rights
11
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12
+ copies of the Software, and to permit persons to whom the Software is
13
+ furnished to do so, subject to the following conditions:
14
+
15
+ The above copyright notice and this permission notice shall be included in
16
+ all copies or substantial portions of the Software.
17
+
18
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
24
+ THE SOFTWARE.
25
+
26
+ Trade Mark:
27
+ ==========
28
+ APIMATIC is a trade mark for APIMATIC Limited
@@ -0,0 +1,2 @@
1
+ include LICENSE
2
+ include README.md
@@ -0,0 +1,135 @@
1
+ Metadata-Version: 2.4
2
+ Name: splitit-apimatic-sdk
3
+ Version: 1.0.0
4
+ Summary: SDK for Splitit webapi
5
+ Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
6
+ Project-URL: Documentation, https://www.splitit.com/
7
+ Requires-Python: >=3.7
8
+ Description-Content-Type: text/markdown
9
+ License-File: LICENSE
10
+ Requires-Dist: apimatic-core>=0.2.24,~=0.2.0
11
+ Requires-Dist: apimatic-core-interfaces>=0.1.8,~=0.1.0
12
+ Requires-Dist: apimatic-requests-client-adapter>=0.1.10,~=0.1.0
13
+ Requires-Dist: python-dotenv<2.0,>=0.21
14
+ Provides-Extra: testutils
15
+ Requires-Dist: pytest>=7.2.2; extra == "testutils"
16
+ Dynamic: license-file
17
+
18
+
19
+ # Getting Started with splitit-web-api-v4
20
+
21
+ ## Introduction
22
+
23
+ Splitit Orchestration API for managing installment plans.
24
+
25
+ ## Install the Package
26
+
27
+ The package is compatible with Python versions `3.7+`.
28
+ Install the package from PyPi using the following pip command:
29
+
30
+ ```bash
31
+ pip install splitit-apimatic-sdk==1.0.0
32
+ ```
33
+
34
+ You can also view the package at:
35
+ https://pypi.python.org/pypi/splitit-apimatic-sdk/1.0.0
36
+
37
+ ## Initialize the API Client
38
+
39
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/client.md)
40
+
41
+ The following parameters are configurable for the API Client:
42
+
43
+ | Parameter | Type | Description |
44
+ | --- | --- | --- |
45
+ | environment | [`Environment`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
46
+ | http_client_instance | `Union[Session, HttpClientProvider]` | The Http Client passed from the sdk user for making requests |
47
+ | override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
48
+ | http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
49
+ | timeout | `float` | The value to use for connection timeout. <br> **Default: 60** |
50
+ | max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
51
+ | backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
52
+ | 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]** |
53
+ | retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ["GET", "PUT"]** |
54
+ | proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
55
+ | o_auth_2_credentials | [`OAuth2Credentials`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
56
+ | api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
57
+
58
+ The API client can be initialized as follows:
59
+
60
+ ### Code-Based Client Initialization
61
+
62
+ ```python
63
+ from splititwebapiv4.configuration import Environment
64
+ from splititwebapiv4.http.auth.api_key import ApiKeyCredentials
65
+ from splititwebapiv4.http.auth.o_auth_2 import OAuth2Credentials
66
+ from splititwebapiv4.models.o_auth_scope_o_auth_2_enum import OAuthScopeOAuth2Enum
67
+ from splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client
68
+
69
+ client = Splititwebapiv4Client(
70
+ o_auth_2_credentials=OAuth2Credentials(
71
+ o_auth_client_id='OAuthClientId',
72
+ o_auth_client_secret='OAuthClientSecret',
73
+ o_auth_scopes=[
74
+ OAuthScopeOAuth2Enum.API_V4
75
+ ]
76
+ ),
77
+ api_key_credentials=ApiKeyCredentials(
78
+ x_splitit_api_key='X-Splitit-Api-Key'
79
+ ),
80
+ environment=Environment.SANDBOX
81
+ )
82
+ ```
83
+
84
+ ### Environment-Based Client Initialization
85
+
86
+ ```python
87
+ from splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client
88
+
89
+ # Specify the path to your .env file if it’s located outside the project’s root directory.
90
+ client = Splititwebapiv4Client.from_environment(dotenv_path='/path/to/.env')
91
+ ```
92
+
93
+ See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
94
+
95
+ ## Environments
96
+
97
+ The SDK can be configured to use a different environment for making API calls. Available environments are:
98
+
99
+ ### Fields
100
+
101
+ | Name | Description |
102
+ | --- | --- |
103
+ | SANDBOX | **Default** Sandbox Environment (Transactional API) |
104
+ | PRODUCTION | Production Environment (Transactional API) |
105
+
106
+ ## Authorization
107
+
108
+ This API uses the following authentication schemes.
109
+
110
+ * [`OAuth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
111
+ * [`ApiKey (Custom Header Signature)`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/custom-header-signature.md)
112
+
113
+ ## List of APIs
114
+
115
+ * [Installment Plan](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/controllers/installment-plan.md)
116
+
117
+ ## SDK Infrastructure
118
+
119
+ ### Configuration
120
+
121
+ * [ProxySettings](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/proxy-settings.md)
122
+ * [Environment-Based Client Initialization](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
123
+
124
+ ### HTTP
125
+
126
+ * [HttpResponse](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/http-response.md)
127
+ * [HttpRequest](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/http-request.md)
128
+
129
+ ### Utilities
130
+
131
+ * [ApiHelper](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/api-helper.md)
132
+ * [HttpDateTime](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/http-date-time.md)
133
+ * [RFC3339DateTime](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/rfc3339-date-time.md)
134
+ * [UnixDateTime](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/unix-date-time.md)
135
+
@@ -0,0 +1,118 @@
1
+
2
+ # Getting Started with splitit-web-api-v4
3
+
4
+ ## Introduction
5
+
6
+ Splitit Orchestration API for managing installment plans.
7
+
8
+ ## Install the Package
9
+
10
+ The package is compatible with Python versions `3.7+`.
11
+ Install the package from PyPi using the following pip command:
12
+
13
+ ```bash
14
+ pip install splitit-apimatic-sdk==1.0.0
15
+ ```
16
+
17
+ You can also view the package at:
18
+ https://pypi.python.org/pypi/splitit-apimatic-sdk/1.0.0
19
+
20
+ ## Initialize the API Client
21
+
22
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/client.md)
23
+
24
+ The following parameters are configurable for the API Client:
25
+
26
+ | Parameter | Type | Description |
27
+ | --- | --- | --- |
28
+ | environment | [`Environment`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
29
+ | http_client_instance | `Union[Session, HttpClientProvider]` | The Http Client passed from the sdk user for making requests |
30
+ | override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
31
+ | http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
32
+ | timeout | `float` | The value to use for connection timeout. <br> **Default: 60** |
33
+ | max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
34
+ | backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
35
+ | 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]** |
36
+ | retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ["GET", "PUT"]** |
37
+ | proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
38
+ | o_auth_2_credentials | [`OAuth2Credentials`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
39
+ | api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
40
+
41
+ The API client can be initialized as follows:
42
+
43
+ ### Code-Based Client Initialization
44
+
45
+ ```python
46
+ from splititwebapiv4.configuration import Environment
47
+ from splititwebapiv4.http.auth.api_key import ApiKeyCredentials
48
+ from splititwebapiv4.http.auth.o_auth_2 import OAuth2Credentials
49
+ from splititwebapiv4.models.o_auth_scope_o_auth_2_enum import OAuthScopeOAuth2Enum
50
+ from splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client
51
+
52
+ client = Splititwebapiv4Client(
53
+ o_auth_2_credentials=OAuth2Credentials(
54
+ o_auth_client_id='OAuthClientId',
55
+ o_auth_client_secret='OAuthClientSecret',
56
+ o_auth_scopes=[
57
+ OAuthScopeOAuth2Enum.API_V4
58
+ ]
59
+ ),
60
+ api_key_credentials=ApiKeyCredentials(
61
+ x_splitit_api_key='X-Splitit-Api-Key'
62
+ ),
63
+ environment=Environment.SANDBOX
64
+ )
65
+ ```
66
+
67
+ ### Environment-Based Client Initialization
68
+
69
+ ```python
70
+ from splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client
71
+
72
+ # Specify the path to your .env file if it’s located outside the project’s root directory.
73
+ client = Splititwebapiv4Client.from_environment(dotenv_path='/path/to/.env')
74
+ ```
75
+
76
+ See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
77
+
78
+ ## Environments
79
+
80
+ The SDK can be configured to use a different environment for making API calls. Available environments are:
81
+
82
+ ### Fields
83
+
84
+ | Name | Description |
85
+ | --- | --- |
86
+ | SANDBOX | **Default** Sandbox Environment (Transactional API) |
87
+ | PRODUCTION | Production Environment (Transactional API) |
88
+
89
+ ## Authorization
90
+
91
+ This API uses the following authentication schemes.
92
+
93
+ * [`OAuth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
94
+ * [`ApiKey (Custom Header Signature)`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/custom-header-signature.md)
95
+
96
+ ## List of APIs
97
+
98
+ * [Installment Plan](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/controllers/installment-plan.md)
99
+
100
+ ## SDK Infrastructure
101
+
102
+ ### Configuration
103
+
104
+ * [ProxySettings](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/proxy-settings.md)
105
+ * [Environment-Based Client Initialization](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
106
+
107
+ ### HTTP
108
+
109
+ * [HttpResponse](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/http-response.md)
110
+ * [HttpRequest](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/http-request.md)
111
+
112
+ ### Utilities
113
+
114
+ * [ApiHelper](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/api-helper.md)
115
+ * [HttpDateTime](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/http-date-time.md)
116
+ * [RFC3339DateTime](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/rfc3339-date-time.md)
117
+ * [UnixDateTime](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/unix-date-time.md)
118
+
@@ -0,0 +1,25 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0"]
3
+ build-backend = "setuptools.build_meta"
4
+ [project]
5
+ name = "splitit-apimatic-sdk"
6
+ description = "SDK for Splitit webapi"
7
+ version = "1.0.0"
8
+ readme = "README.md"
9
+ keywords = []
10
+ dependencies = ["apimatic-core~=0.2.0, >= 0.2.24", "apimatic-core-interfaces~=0.1.0, >= 0.1.8", "apimatic-requests-client-adapter~=0.1.0, >= 0.1.10", "python-dotenv>=0.21, <2.0"]
11
+ classifiers = []
12
+ requires-python = ">=3.7"
13
+ [[project.authors]]
14
+ name = "Muhammad Rafay"
15
+ email = "muhammad.rafay@apimatic.io"
16
+
17
+ [project.urls]
18
+ Documentation = "https://www.splitit.com/"
19
+ [project.optional-dependencies]
20
+ testutils = ["pytest>=7.2.2"]
21
+ [tool]
22
+ [tool.setuptools]
23
+ [tool.setuptools.packages]
24
+ [tool.setuptools.packages.find]
25
+ exclude = ["tests", "tests.*"]
@@ -0,0 +1,8 @@
1
+ [meta-data]
2
+ license_files =
3
+ LICENSE
4
+
5
+ [egg_info]
6
+ tag_build =
7
+ tag_date = 0
8
+
@@ -0,0 +1,135 @@
1
+ Metadata-Version: 2.4
2
+ Name: splitit-apimatic-sdk
3
+ Version: 1.0.0
4
+ Summary: SDK for Splitit webapi
5
+ Author-email: Muhammad Rafay <muhammad.rafay@apimatic.io>
6
+ Project-URL: Documentation, https://www.splitit.com/
7
+ Requires-Python: >=3.7
8
+ Description-Content-Type: text/markdown
9
+ License-File: LICENSE
10
+ Requires-Dist: apimatic-core>=0.2.24,~=0.2.0
11
+ Requires-Dist: apimatic-core-interfaces>=0.1.8,~=0.1.0
12
+ Requires-Dist: apimatic-requests-client-adapter>=0.1.10,~=0.1.0
13
+ Requires-Dist: python-dotenv<2.0,>=0.21
14
+ Provides-Extra: testutils
15
+ Requires-Dist: pytest>=7.2.2; extra == "testutils"
16
+ Dynamic: license-file
17
+
18
+
19
+ # Getting Started with splitit-web-api-v4
20
+
21
+ ## Introduction
22
+
23
+ Splitit Orchestration API for managing installment plans.
24
+
25
+ ## Install the Package
26
+
27
+ The package is compatible with Python versions `3.7+`.
28
+ Install the package from PyPi using the following pip command:
29
+
30
+ ```bash
31
+ pip install splitit-apimatic-sdk==1.0.0
32
+ ```
33
+
34
+ You can also view the package at:
35
+ https://pypi.python.org/pypi/splitit-apimatic-sdk/1.0.0
36
+
37
+ ## Initialize the API Client
38
+
39
+ **_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/client.md)
40
+
41
+ The following parameters are configurable for the API Client:
42
+
43
+ | Parameter | Type | Description |
44
+ | --- | --- | --- |
45
+ | environment | [`Environment`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/README.md#environments) | The API environment. <br> **Default: `Environment.SANDBOX`** |
46
+ | http_client_instance | `Union[Session, HttpClientProvider]` | The Http Client passed from the sdk user for making requests |
47
+ | override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
48
+ | http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
49
+ | timeout | `float` | The value to use for connection timeout. <br> **Default: 60** |
50
+ | max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
51
+ | backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
52
+ | 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]** |
53
+ | retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ["GET", "PUT"]** |
54
+ | proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
55
+ | o_auth_2_credentials | [`OAuth2Credentials`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md) | The credential object for OAuth 2 Client Credentials Grant |
56
+ | api_key_credentials | [`ApiKeyCredentials`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/custom-header-signature.md) | The credential object for Custom Header Signature |
57
+
58
+ The API client can be initialized as follows:
59
+
60
+ ### Code-Based Client Initialization
61
+
62
+ ```python
63
+ from splititwebapiv4.configuration import Environment
64
+ from splititwebapiv4.http.auth.api_key import ApiKeyCredentials
65
+ from splititwebapiv4.http.auth.o_auth_2 import OAuth2Credentials
66
+ from splititwebapiv4.models.o_auth_scope_o_auth_2_enum import OAuthScopeOAuth2Enum
67
+ from splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client
68
+
69
+ client = Splititwebapiv4Client(
70
+ o_auth_2_credentials=OAuth2Credentials(
71
+ o_auth_client_id='OAuthClientId',
72
+ o_auth_client_secret='OAuthClientSecret',
73
+ o_auth_scopes=[
74
+ OAuthScopeOAuth2Enum.API_V4
75
+ ]
76
+ ),
77
+ api_key_credentials=ApiKeyCredentials(
78
+ x_splitit_api_key='X-Splitit-Api-Key'
79
+ ),
80
+ environment=Environment.SANDBOX
81
+ )
82
+ ```
83
+
84
+ ### Environment-Based Client Initialization
85
+
86
+ ```python
87
+ from splititwebapiv4.splititwebapiv_4_client import Splititwebapiv4Client
88
+
89
+ # Specify the path to your .env file if it’s located outside the project’s root directory.
90
+ client = Splititwebapiv4Client.from_environment(dotenv_path='/path/to/.env')
91
+ ```
92
+
93
+ See the [Environment-Based Client Initialization](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/environment-based-client-initialization.md) section for details.
94
+
95
+ ## Environments
96
+
97
+ The SDK can be configured to use a different environment for making API calls. Available environments are:
98
+
99
+ ### Fields
100
+
101
+ | Name | Description |
102
+ | --- | --- |
103
+ | SANDBOX | **Default** Sandbox Environment (Transactional API) |
104
+ | PRODUCTION | Production Environment (Transactional API) |
105
+
106
+ ## Authorization
107
+
108
+ This API uses the following authentication schemes.
109
+
110
+ * [`OAuth2 (OAuth 2 Client Credentials Grant)`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/oauth-2-client-credentials-grant.md)
111
+ * [`ApiKey (Custom Header Signature)`](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/auth/custom-header-signature.md)
112
+
113
+ ## List of APIs
114
+
115
+ * [Installment Plan](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/controllers/installment-plan.md)
116
+
117
+ ## SDK Infrastructure
118
+
119
+ ### Configuration
120
+
121
+ * [ProxySettings](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/proxy-settings.md)
122
+ * [Environment-Based Client Initialization](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/environment-based-client-initialization.md)
123
+
124
+ ### HTTP
125
+
126
+ * [HttpResponse](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/http-response.md)
127
+ * [HttpRequest](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/http-request.md)
128
+
129
+ ### Utilities
130
+
131
+ * [ApiHelper](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/api-helper.md)
132
+ * [HttpDateTime](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/http-date-time.md)
133
+ * [RFC3339DateTime](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/rfc3339-date-time.md)
134
+ * [UnixDateTime](https://www.github.com/sdks-io/splitit-apimatic-python-sdk/tree/1.0.0/doc/unix-date-time.md)
135
+
@@ -0,0 +1,97 @@
1
+ LICENSE
2
+ MANIFEST.in
3
+ README.md
4
+ pyproject.toml
5
+ setup.cfg
6
+ splitit_apimatic_sdk.egg-info/PKG-INFO
7
+ splitit_apimatic_sdk.egg-info/SOURCES.txt
8
+ splitit_apimatic_sdk.egg-info/dependency_links.txt
9
+ splitit_apimatic_sdk.egg-info/requires.txt
10
+ splitit_apimatic_sdk.egg-info/top_level.txt
11
+ splititwebapiv4/__init__.py
12
+ splititwebapiv4/api_helper.py
13
+ splititwebapiv4/configuration.py
14
+ splititwebapiv4/splititwebapiv_4_client.py
15
+ splititwebapiv4/controllers/__init__.py
16
+ splititwebapiv4/controllers/base_controller.py
17
+ splititwebapiv4/controllers/installment_plan_controller.py
18
+ splititwebapiv4/controllers/o_auth_authorization_controller.py
19
+ splititwebapiv4/exceptions/__init__.py
20
+ splititwebapiv4/exceptions/api_error_response_exception.py
21
+ splititwebapiv4/exceptions/api_exception.py
22
+ splititwebapiv4/exceptions/o_auth_provider_exception.py
23
+ splititwebapiv4/http/__init__.py
24
+ splititwebapiv4/http/http_call_back.py
25
+ splititwebapiv4/http/http_client_provider.py
26
+ splititwebapiv4/http/http_method_enum.py
27
+ splititwebapiv4/http/http_request.py
28
+ splititwebapiv4/http/http_response.py
29
+ splititwebapiv4/http/proxy_settings.py
30
+ splititwebapiv4/http/auth/__init__.py
31
+ splititwebapiv4/http/auth/api_key.py
32
+ splititwebapiv4/http/auth/o_auth_2.py
33
+ splititwebapiv4/models/__init__.py
34
+ splititwebapiv4/models/amount_data.py
35
+ splititwebapiv4/models/api_error_model.py
36
+ splititwebapiv4/models/apr_data.py
37
+ splititwebapiv4/models/authorization_status_enum.py
38
+ splititwebapiv4/models/authorize_authorization_data.py
39
+ splititwebapiv4/models/authorize_request.py
40
+ splititwebapiv4/models/authorize_response.py
41
+ splititwebapiv4/models/billing_address_data.py
42
+ splititwebapiv4/models/card_details.py
43
+ splititwebapiv4/models/card_validity_request.py
44
+ splititwebapiv4/models/card_validity_response.py
45
+ splititwebapiv4/models/checkout_url_data.py
46
+ splititwebapiv4/models/content_segment.py
47
+ splititwebapiv4/models/external_provider_types_enum.py
48
+ splititwebapiv4/models/inline_content.py
49
+ splititwebapiv4/models/installment_item.py
50
+ splititwebapiv4/models/installment_plan_details_response.py
51
+ splititwebapiv4/models/installment_plan_search_details_response.py
52
+ splititwebapiv4/models/installment_plan_search_request.py
53
+ splititwebapiv4/models/installment_plan_status_enum.py
54
+ splititwebapiv4/models/installment_status_enum.py
55
+ splititwebapiv4/models/masked_card_details.py
56
+ splititwebapiv4/models/metadata_item.py
57
+ splititwebapiv4/models/o_auth_provider_error_enum.py
58
+ splititwebapiv4/models/o_auth_scope_o_auth_2_enum.py
59
+ splititwebapiv4/models/o_auth_token.py
60
+ splititwebapiv4/models/offer_item.py
61
+ splititwebapiv4/models/offers_billing_address.py
62
+ splititwebapiv4/models/offers_card_details.py
63
+ splititwebapiv4/models/offers_merchant_details.py
64
+ splititwebapiv4/models/offers_payment_method.py
65
+ splititwebapiv4/models/offers_payment_method_response.py
66
+ splititwebapiv4/models/offers_request.py
67
+ splititwebapiv4/models/offers_response.py
68
+ splititwebapiv4/models/offers_shopper_details.py
69
+ splititwebapiv4/models/offers_store_location.py
70
+ splititwebapiv4/models/payment_link_request.py
71
+ splititwebapiv4/models/payment_link_response.py
72
+ splititwebapiv4/models/payment_method.py
73
+ splititwebapiv4/models/payment_method_data.py
74
+ splititwebapiv4/models/payment_method_type_enum.py
75
+ splititwebapiv4/models/pis_error_codes_enum.py
76
+ splititwebapiv4/models/plan_authorization_data.py
77
+ splititwebapiv4/models/plan_links_data.py
78
+ splititwebapiv4/models/plan_status_enum.py
79
+ splititwebapiv4/models/processing_data.py
80
+ splititwebapiv4/models/purchase_method_enum.py
81
+ splititwebapiv4/models/redirect_urls.py
82
+ splititwebapiv4/models/refund_item.py
83
+ splititwebapiv4/models/refund_request.py
84
+ splititwebapiv4/models/refund_response.py
85
+ splititwebapiv4/models/shipping_status_enum.py
86
+ splititwebapiv4/models/shopper_details_data.py
87
+ splititwebapiv4/models/three_ds_authentication_data.py
88
+ splititwebapiv4/models/three_ds_execute.py
89
+ splititwebapiv4/models/three_ds_redirect_data.py
90
+ splititwebapiv4/models/three_ds_request_data.py
91
+ splititwebapiv4/models/update_offers_payment_method.py
92
+ splititwebapiv4/models/update_offers_request.py
93
+ splititwebapiv4/models/update_order_request.py
94
+ splititwebapiv4/models/update_order_response.py
95
+ splititwebapiv4/models/validation_error.py
96
+ splititwebapiv4/utilities/__init__.py
97
+ splititwebapiv4/utilities/file_wrapper.py
@@ -0,0 +1,7 @@
1
+ apimatic-core>=0.2.24,~=0.2.0
2
+ apimatic-core-interfaces>=0.1.8,~=0.1.0
3
+ apimatic-requests-client-adapter>=0.1.10,~=0.1.0
4
+ python-dotenv<2.0,>=0.21
5
+
6
+ [testutils]
7
+ pytest>=7.2.2
@@ -0,0 +1,3 @@
1
+ dist
2
+ doc
3
+ splititwebapiv4
@@ -0,0 +1,12 @@
1
+ # ruff: noqa: D104 | Missing docstring in public package
2
+ # ruff: noqa: RUF022 | `__all__` is not sorted
3
+ __all__ = [
4
+ "api_helper",
5
+ "configuration",
6
+ "controllers",
7
+ "exceptions",
8
+ "http",
9
+ "models",
10
+ "splititwebapiv_4_client",
11
+ "utilities",
12
+ ]
@@ -0,0 +1,19 @@
1
+ """
2
+ splititwebapiv4
3
+
4
+ This file was automatically generated by APIMATIC v3.0 (
5
+ https://www.apimatic.io ).
6
+ """
7
+
8
+ from apimatic_core.utilities.api_helper import ApiHelper as CoreApiHelper
9
+
10
+
11
+ class APIHelper(CoreApiHelper):
12
+ """
13
+ A Helper Class for various functions associated with API Calls.
14
+
15
+ This class contains static methods for operations that need to be
16
+ performed during API requests. All of the methods inside this class are
17
+ static methods, there is no need to ever initialise an instance of this
18
+ class.
19
+ """