pinelabs-python 0.1.0__py3-none-any.whl

pinelabs/types/upi_details_response_payer.py

@@ -0,0 +1,22 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel
+
+
+class UpiDetailsResponsePayer(UniversalBaseModel):
+    vpa: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Virtual Payment Address of the payer.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pinelabs/types/upi_details_response_txn_mode.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+UpiDetailsResponseTxnMode = typing.Union[typing.Literal["COLLECT", "INTENT"], typing.Any]

pinelabs_python-0.1.0.dist-info/METADATA

@@ -0,0 +1,213 @@
+Metadata-Version: 2.4
+Name: pinelabs-python
+Version: 0.1.0
+Summary: Official Pine Labs Online (Plural) Payment Gateway Python SDK.
+Project-URL: Homepage, https://github.com/plural-pinelabs/pinelabs-python
+Project-URL: Repository, https://github.com/plural-pinelabs/pinelabs-python
+Project-URL: Documentation, https://docs.pluralonline.com
+Project-URL: Bug Tracker, https://github.com/plural-pinelabs/pinelabs-python/issues
+Author: Pine Labs
+License: MIT
+License-File: LICENSE
+Keywords: api,payments,pinelabs,plural,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Requires-Dist: httpx>=0.21.2
+Requires-Dist: pydantic-core<3.0.0,>=2.18.2
+Requires-Dist: pydantic>=1.9.2
+Requires-Dist: typing-extensions>=4.0.0
+Description-Content-Type: text/markdown
+
+# Pinelabs Python Library
+
+[![pypi](https://img.shields.io/pypi/v/pinelabs)](https://pypi.python.org/pypi/pinelabs)
+
+The Pinelabs Python library provides convenient access to the Pinelabs APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install pinelabs
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from pinelabs import PinelabsApi
+
+client = PinelabsApi(
+    token="<token>",
+)
+
+client.authentication.generate_token(
+    client_id="a17ce30e-f88e-4f81-ada1-c3b4909ed232",
+    client_secret="abcdefgwei7egyhuggwp39w8rh",
+    grant_type="client_credentials",
+)
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from pinelabs import PinelabsApi
+from pinelabs.environment import PinelabsApiEnvironment
+
+client = PinelabsApi(
+    environment=PinelabsApiEnvironment.PRODUCTION,
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from pinelabs import AsyncPinelabsApi
+
+client = AsyncPinelabsApi(
+    token="<token>",
+)
+
+
+async def main() -> None:
+    await client.authentication.generate_token(
+        client_id="a17ce30e-f88e-4f81-ada1-c3b4909ed232",
+        client_secret="abcdefgwei7egyhuggwp39w8rh",
+        grant_type="client_credentials",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from pinelabs.core.api_error import ApiError
+
+try:
+    client.authentication.generate_token(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from pinelabs import PinelabsApi
+
+client = PinelabsApi(...)
+response = client.authentication.with_raw_response.generate_token(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.authentication.generate_token(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+from pinelabs import PinelabsApi
+
+client = PinelabsApi(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.authentication.generate_token(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from pinelabs import PinelabsApi
+
+client = PinelabsApi(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!