sirako-sdk 1.0.0__tar.gz

sirako_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.4
+Name: sirako_sdk
+Version: 1.0.0
+Summary: Sirako Merchant SDK API
+Home-page: 
+Author: OpenAPI Generator community
+Author-email: OpenAPI Generator Community <team@openapitools.org>
+Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
+Keywords: OpenAPI,OpenAPI-Generator,Sirako Merchant SDK API
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Dynamic: author
+
+# sirako-sdk
+Public endpoints for third-party merchant integrations.
+Authenticate every request with the `X-API-Key` header.
+
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Generator version: 7.24.0-SNAPSHOT
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.10+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import sirako_sdk
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import sirako_sdk
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import sirako_sdk
+from sirako_sdk.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://dev-sirako.fidelity-market.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = sirako_sdk.Configuration(
+    host = "https://dev-sirako.fidelity-market.com"
+)
+
+# 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.
+
+# Configure API key authorization: apiKeyAuth
+configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
+
+
+# Enter a context with an instance of the API client
+with sirako_sdk.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = sirako_sdk.MerchantPayInApi(api_client)
+    x_api_key = 'x_api_key_example' # str | 
+    payment_id = 'payment_id_example' # str | 
+
+    try:
+        # Read a merchant pay-in
+        api_response = api_instance.get_payment(x_api_key, payment_id)
+        print("The response of MerchantPayInApi->get_payment:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling MerchantPayInApi->get_payment: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://dev-sirako.fidelity-market.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MerchantPayInApi* | [**get_payment**](docs/MerchantPayInApi.md#get_payment) | **GET** /api/v1/payments/{paymentId} | Read a merchant pay-in
+*MerchantPayInApi* | [**get_payment_options**](docs/MerchantPayInApi.md#get_payment_options) | **GET** /api/v1/payments/options | Get available payment operators for a country
+*MerchantPayInApi* | [**initiate**](docs/MerchantPayInApi.md#initiate) | **POST** /api/v1/payments/initiate | Initiate a merchant pay-in
+*MerchantPayInApi* | [**submit_otp**](docs/MerchantPayInApi.md#submit_otp) | **POST** /api/v1/payments/{paymentId}/actions/otp | Submit a required OTP action
+
+
+## Documentation For Models
+
+ - [Customer](docs/Customer.md)
+ - [MerchantPaymentRequest](docs/MerchantPaymentRequest.md)
+ - [MerchantPaymentResponse](docs/MerchantPaymentResponse.md)
+ - [NextAction](docs/NextAction.md)
+ - [OtpActionRequest](docs/OtpActionRequest.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearerAuth"></a>
+### bearerAuth
+
+- **Type**: Bearer authentication (JWT)
+
+<a id="apiKeyAuth"></a>
+### apiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: X-API-Key
+- **Location**: HTTP header
+
+
+## Author
+
+
+
+

sirako_sdk-1.0.0/README.md

@@ -0,0 +1,138 @@
+# sirako-sdk
+Public endpoints for third-party merchant integrations.
+Authenticate every request with the `X-API-Key` header.
+
+
+This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Generator version: 7.24.0-SNAPSHOT
+- Build package: org.openapitools.codegen.languages.PythonClientCodegen
+
+## Requirements.
+
+Python 3.10+
+
+## Installation & Usage
+### pip install
+
+If the python package is hosted on a repository, you can install directly using:
+
+```sh
+pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
+```
+(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
+
+Then import the package:
+```python
+import sirako_sdk
+```
+
+### Setuptools
+
+Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
+
+```sh
+python setup.py install --user
+```
+(or `sudo python setup.py install` to install the package for all users)
+
+Then import the package:
+```python
+import sirako_sdk
+```
+
+### Tests
+
+Execute `pytest` to run the tests.
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then run the following:
+
+```python
+
+import sirako_sdk
+from sirako_sdk.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://dev-sirako.fidelity-market.com
+# See configuration.py for a list of all supported configuration parameters.
+configuration = sirako_sdk.Configuration(
+    host = "https://dev-sirako.fidelity-market.com"
+)
+
+# 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.
+
+# Configure API key authorization: apiKeyAuth
+configuration.api_key['apiKeyAuth'] = os.environ["API_KEY"]
+
+# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+# configuration.api_key_prefix['apiKeyAuth'] = 'Bearer'
+
+
+# Enter a context with an instance of the API client
+with sirako_sdk.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = sirako_sdk.MerchantPayInApi(api_client)
+    x_api_key = 'x_api_key_example' # str | 
+    payment_id = 'payment_id_example' # str | 
+
+    try:
+        # Read a merchant pay-in
+        api_response = api_instance.get_payment(x_api_key, payment_id)
+        print("The response of MerchantPayInApi->get_payment:\n")
+        pprint(api_response)
+    except ApiException as e:
+        print("Exception when calling MerchantPayInApi->get_payment: %s\n" % e)
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://dev-sirako.fidelity-market.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*MerchantPayInApi* | [**get_payment**](docs/MerchantPayInApi.md#get_payment) | **GET** /api/v1/payments/{paymentId} | Read a merchant pay-in
+*MerchantPayInApi* | [**get_payment_options**](docs/MerchantPayInApi.md#get_payment_options) | **GET** /api/v1/payments/options | Get available payment operators for a country
+*MerchantPayInApi* | [**initiate**](docs/MerchantPayInApi.md#initiate) | **POST** /api/v1/payments/initiate | Initiate a merchant pay-in
+*MerchantPayInApi* | [**submit_otp**](docs/MerchantPayInApi.md#submit_otp) | **POST** /api/v1/payments/{paymentId}/actions/otp | Submit a required OTP action
+
+
+## Documentation For Models
+
+ - [Customer](docs/Customer.md)
+ - [MerchantPaymentRequest](docs/MerchantPaymentRequest.md)
+ - [MerchantPaymentResponse](docs/MerchantPaymentResponse.md)
+ - [NextAction](docs/NextAction.md)
+ - [OtpActionRequest](docs/OtpActionRequest.md)
+
+
+<a id="documentation-for-authorization"></a>
+## Documentation For Authorization
+
+
+Authentication schemes defined for the API:
+<a id="bearerAuth"></a>
+### bearerAuth
+
+- **Type**: Bearer authentication (JWT)
+
+<a id="apiKeyAuth"></a>
+### apiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: X-API-Key
+- **Location**: HTTP header
+
+
+## Author
+
+
+
+

sirako_sdk-1.0.0/pyproject.toml

@@ -0,0 +1,94 @@
+[project]
+name = "sirako_sdk"
+version = "1.0.0"
+description = "Sirako Merchant SDK API"
+authors = [
+  {name = "OpenAPI Generator Community",email = "team@openapitools.org"},
+]
+readme = "README.md"
+keywords = ["OpenAPI", "OpenAPI-Generator", "Sirako Merchant SDK API"]
+requires-python = ">=3.9"
+
+dependencies = [
+  "urllib3 (>=2.1.0,<3.0.0)",
+  "python-dateutil (>=2.8.2)",
+  "pydantic (>=2.11)",
+  "typing-extensions (>=4.7.1)",
+]
+
+[project.urls]
+Repository = "https://github.com/GIT_USER_ID/GIT_REPO_ID"
+
+[tool.poetry]
+requires-poetry = ">=2.0"
+
+[tool.poetry.group.dev.dependencies]
+pytest = ">= 7.2.1"
+pytest-cov = ">= 2.8.1"
+tox = ">= 3.9.0"
+flake8 = ">= 4.0.0"
+types-python-dateutil = ">= 2.8.19.14"
+mypy = ">= 1.5"
+
+
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[tool.pylint.'MESSAGES CONTROL']
+extension-pkg-whitelist = "pydantic"
+
+[tool.mypy]
+files = [
+  "sirako_sdk",
+  #"test",  # auto-generated tests
+  "tests", # hand-written tests
+]
+# TODO: enable "strict" once all these individual checks are passing
+# strict = true
+
+# List from: https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options
+warn_unused_configs = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+
+## Getting these passing should be easy
+strict_equality = true
+extra_checks = true
+
+## Strongly recommend enabling this one as soon as you can
+check_untyped_defs = true
+
+## These shouldn't be too much additional work, but may be tricky to
+## get passing if you use a lot of untyped libraries
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+
+### These next few are various gradations of forcing use of type annotations
+#disallow_untyped_calls = true
+#disallow_incomplete_defs = true
+#disallow_untyped_defs = true
+#
+### This one isn't too hard to get passing, but return on investment is lower
+#no_implicit_reexport = true
+#
+### This one can be tricky to get passing if you use a lot of untyped libraries
+#warn_return_any = true
+
+[[tool.mypy.overrides]]
+module = [
+  "sirako_sdk.configuration",
+]
+warn_unused_ignores = true
+strict_equality = true
+extra_checks = true
+check_untyped_defs = true
+disallow_subclassing_any = true
+disallow_untyped_decorators = true
+disallow_any_generics = true
+disallow_untyped_calls = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+no_implicit_reexport = true
+warn_return_any = true

sirako_sdk-1.0.0/setup.cfg

@@ -0,0 +1,7 @@
+[flake8]
+max-line-length = 99
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

sirako_sdk-1.0.0/setup.py

@@ -0,0 +1,47 @@
+"""
+    Sirako Merchant SDK API
+
+    Public endpoints for third-party merchant integrations. Authenticate every request with the `X-API-Key` header. 
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from setuptools import setup, find_packages  # noqa: H301
+
+# To install the library, run the following
+#
+# python setup.py install
+#
+# prerequisite: setuptools
+# http://pypi.python.org/pypi/setuptools
+NAME = "sirako-sdk"
+VERSION = "1.0.0"
+PYTHON_REQUIRES = ">= 3.10"
+REQUIRES = [
+    "urllib3 >= 2.1.0, < 3.0.0",
+    "python-dateutil >= 2.8.2",
+    "pydantic >= 2.11",
+    "typing-extensions >= 4.7.1",
+]
+
+setup(
+    name=NAME,
+    version=VERSION,
+    description="Sirako Merchant SDK API",
+    author="OpenAPI Generator community",
+    author_email="team@openapitools.org",
+    url="",
+    keywords=["OpenAPI", "OpenAPI-Generator", "Sirako Merchant SDK API"],
+    install_requires=REQUIRES,
+    packages=find_packages(exclude=["test", "tests"]),
+    include_package_data=True,
+    long_description_content_type='text/markdown',
+    long_description="""\
+    Public endpoints for third-party merchant integrations. Authenticate every request with the &#x60;X-API-Key&#x60; header. 
+    """,  # noqa: E501
+    package_data={"sirako_sdk": ["py.typed"]},
+)

sirako_sdk-1.0.0/sirako_sdk/__init__.py

@@ -0,0 +1,58 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Sirako Merchant SDK API
+
+    Public endpoints for third-party merchant integrations. Authenticate every request with the `X-API-Key` header. 
+
+    The version of the OpenAPI document: 1.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# Define package exports
+__all__ = [
+    "MerchantPayInApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "Customer",
+    "MerchantPaymentRequest",
+    "MerchantPaymentResponse",
+    "NextAction",
+    "OtpActionRequest",
+]
+
+# import apis into sdk package
+from sirako_sdk.api.merchant_pay_in_api import MerchantPayInApi as MerchantPayInApi
+
+# import ApiClient
+from sirako_sdk.api_response import ApiResponse as ApiResponse
+from sirako_sdk.api_client import ApiClient as ApiClient
+from sirako_sdk.configuration import Configuration as Configuration
+from sirako_sdk.exceptions import OpenApiException as OpenApiException
+from sirako_sdk.exceptions import ApiTypeError as ApiTypeError
+from sirako_sdk.exceptions import ApiValueError as ApiValueError
+from sirako_sdk.exceptions import ApiKeyError as ApiKeyError
+from sirako_sdk.exceptions import ApiAttributeError as ApiAttributeError
+from sirako_sdk.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from sirako_sdk.models.customer import Customer as Customer
+from sirako_sdk.models.merchant_payment_request import MerchantPaymentRequest as MerchantPaymentRequest
+from sirako_sdk.models.merchant_payment_response import MerchantPaymentResponse as MerchantPaymentResponse
+from sirako_sdk.models.next_action import NextAction as NextAction
+from sirako_sdk.models.otp_action_request import OtpActionRequest as OtpActionRequest
+

sirako_sdk-1.0.0/sirako_sdk/api/__init__.py

@@ -0,0 +1,5 @@
+# flake8: noqa
+
+# import apis into api package
+from sirako_sdk.api.merchant_pay_in_api import MerchantPayInApi
+