raims 0.1.3__tar.gz

raims-0.1.3/.gitignore

@@ -0,0 +1,26 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+build/
+dist/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+.env
+
+# Internal planning is not part of public source.
+[Tt][Oo][Dd][Oo]
+[Tt][Oo][Dd][Oo][._-]*
+[Bb][Aa][Cc][Kk][Ll][Oo][Gg]
+[Bb][Aa][Cc][Kk][Ll][Oo][Gg][._-]*
+[Rr][Oo][Aa][Dd][Mm][Aa][Pp]
+[Rr][Oo][Aa][Dd][Mm][Aa][Pp][._-]*
+
+# Local project instructions and maintenance files.
+[Aa][Gg][Ee][Nn][Tt][Ss].[Mm][Dd]
+/[Dd][Oo][Cc][Ss]/[Mm][Aa][Ii][Nn][Tt][Ee][Nn][Aa][Nn][Cc][Ee].[Mm][Dd]
+/[Ss][Ee][Cc][Uu][Rr][Ii][Tt][Yy]/[Rr][Ee][Aa][Dd][Mm][Ee].[Mm][Dd]
+/[Tt][Ee][Mm][Pp][Ll][Aa][Tt][Ee][Ss]/[Cc][Ii]/

raims-0.1.3/CONTRIBUTING.md

@@ -0,0 +1,27 @@
+# Contributing
+
+Report bugs through this repository's GitHub issues. Include:
+
+- The SDK version or source commit.
+- The runtime version and operating system.
+- Expected and actual behavior.
+- A minimal reproduction using synthetic data.
+
+Report vulnerabilities privately as described in [SECURITY.md](SECURITY.md).
+Keep API keys, webhook secrets, customer data, and URLs that grant access to
+resources out of public reports and examples.
+
+## Working with the source
+
+Use Python 3.10 or later and install the SDK dependencies as described in the README.
+
+From the SDK root:
+
+```sh
+python scripts/generate.py --check
+python scripts/check-compatibility.py
+```
+
+Keep changes focused and preserve public API compatibility. Regenerate
+contract-derived files instead of editing them by hand. Preserve license
+notices and attribution in contributions.

raims-0.1.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Raims
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

raims-0.1.3/PKG-INFO

@@ -0,0 +1,157 @@
+Metadata-Version: 2.5
+Name: raims
+Version: 0.1.3
+Summary: Official Python SDK for the Raims public API.
+Project-URL: Documentation, https://docs.raims.com/en/integracoes/sdk-python
+Project-URL: Repository, https://github.com/raimshq/raims-python
+Project-URL: Issues, https://github.com/raimshq/raims-python/issues
+Author: Raims
+License-Expression: MIT
+License-File: LICENSE
+Keywords: payments,pix,raims,sdk
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<0.29,>=0.28.1
+Description-Content-Type: text/markdown
+
+# Raims Python
+
+Official Python SDK for the Raims public API.
+
+Use the SDK in server applications, with synchronous and asynchronous clients,
+typed parameters, read-only responses, cursor pagination, and webhook signature
+verification.
+
+## Install
+
+Requires Python 3.10 or later. In your application's virtual environment:
+
+```sh
+python -m pip install raims
+```
+
+The package and import name are both `raims`. It uses HTTPX for HTTP transport.
+
+To update to the current stable version:
+
+```sh
+python -m pip install --upgrade raims
+```
+
+Read the [release notes](https://github.com/raimshq/raims-python/releases) and
+test your integration after updating. Pin the SDK and its dependencies in your
+application's dependency configuration to reproduce installations.
+Future updates are not applied automatically.
+
+[GitHub releases](https://github.com/raimshq/raims-python/releases/latest) also
+provide wheel and source archives. Verify the downloaded file with `SHA256SUMS`
+before installing it. Install the downloaded wheel in your application environment:
+
+```sh
+python -m pip install /path/to/downloaded-package.whl
+```
+
+## First request
+
+```python
+import os
+
+from raims import RaimsClient
+
+with RaimsClient(os.environ["RAIMS_API_KEY"]) as raims:
+    page = raims.customers.list({"page_size": 20})
+    for customer in page:
+        process_customer(customer.id)
+```
+
+`process_customer` represents your application's processing. The base URL is
+`https://api.raims.com` for both Sandbox and Production. The key determines the
+company, environment, and permissions. Keep it on the server and out of version
+control.
+
+## Create a charge
+
+`customer_id`, `due_date`, and `order_idempotency_key` are values your application
+has already defined and persisted for the order. The due date uses Unix seconds
+in UTC, and the amount uses integer cents: `15000` represents BRL 150.00.
+
+```python
+from raims import RequestOptions
+
+with RaimsClient(os.environ["RAIMS_API_KEY"]) as raims:
+    charge = raims.charges.create(
+        {
+            "customer_id": customer_id,
+            "amount_cents": 15000,
+            "due_date": due_date,
+            "title": "Order 1234",
+        },
+        options=RequestOptions(idempotency_key=order_idempotency_key),
+    )
+    response = charge.last_response
+    assert response is not None
+    request_id = response.request_id
+```
+
+The SDK does not generate idempotency keys or retry writes automatically.
+If you lose a response, keep the same key and parameters and follow the
+endpoint's rules for retrieving or retrying the operation. A `202` response
+means processing is pending; retrieve the resource to follow its outcome.
+
+## Asynchronous use
+
+```python
+from raims import AsyncRaimsClient
+
+async def load_customers(api_key: str) -> None:
+    async with AsyncRaimsClient(api_key) as raims:
+        page = await raims.customers.list({"page_size": 50})
+        async for customer in page.auto_paging_iter():
+            await process_customer_async(customer.id)
+```
+
+`process_customer_async` represents your application's asynchronous processing.
+Normal iteration over a page accesses only the items already received.
+`auto_paging_iter()` retrieves subsequent pages as you consume them.
+
+## Services
+
+| Property | Resources |
+| --- | --- |
+| `accounts` | Account context, number, fees, and checkout |
+| `balances` | Balance and forecast |
+| `customers` | Customer creation, retrieval, and deletion |
+| `charges` | Charges, payment, documents, and refunds for a charge |
+| `payment_links` | Payment links and email delivery requests |
+| `refunds` | Refunds and receipts |
+| `disputes` | Disputes |
+| `statements` | Account statements |
+| `withdrawals` | Withdrawals, limits, summary, and automatic settings |
+| `withdrawal_destinations` | Withdrawal destinations |
+| `webhooks` | Registration, health, pause, test, and secret rotation |
+| `webhook_event_types` | Available event types |
+| `simulations.charges` | Charge simulations with a Sandbox key |
+| `simulations.refunds` | Refund simulations with a Sandbox key |
+
+Services expose `create`, `retrieve`, `update`, `delete`, and `list` according
+to the operations available. The [reference](docs/reference.md) describes each
+method.
+
+## Documentation
+
+- [Configuration, responses, and documents](docs/usage.md)
+- [Pagination](docs/pagination.md)
+- [Errors, idempotency, and retries](docs/errors-and-retries.md)
+- [Receiving webhooks](docs/webhooks.md)
+- [Contributing](CONTRIBUTING.md) and [security](SECURITY.md)
+- [Installation and integration guide](https://docs.raims.com/en/integracoes/sdk-python)
+- [Public API](https://docs.raims.com/en/api)
+
+Distributed under the [MIT license](LICENSE).

raims-0.1.3/README.md

@@ -0,0 +1,134 @@
+# Raims Python
+
+Official Python SDK for the Raims public API.
+
+Use the SDK in server applications, with synchronous and asynchronous clients,
+typed parameters, read-only responses, cursor pagination, and webhook signature
+verification.
+
+## Install
+
+Requires Python 3.10 or later. In your application's virtual environment:
+
+```sh
+python -m pip install raims
+```
+
+The package and import name are both `raims`. It uses HTTPX for HTTP transport.
+
+To update to the current stable version:
+
+```sh
+python -m pip install --upgrade raims
+```
+
+Read the [release notes](https://github.com/raimshq/raims-python/releases) and
+test your integration after updating. Pin the SDK and its dependencies in your
+application's dependency configuration to reproduce installations.
+Future updates are not applied automatically.
+
+[GitHub releases](https://github.com/raimshq/raims-python/releases/latest) also
+provide wheel and source archives. Verify the downloaded file with `SHA256SUMS`
+before installing it. Install the downloaded wheel in your application environment:
+
+```sh
+python -m pip install /path/to/downloaded-package.whl
+```
+
+## First request
+
+```python
+import os
+
+from raims import RaimsClient
+
+with RaimsClient(os.environ["RAIMS_API_KEY"]) as raims:
+    page = raims.customers.list({"page_size": 20})
+    for customer in page:
+        process_customer(customer.id)
+```
+
+`process_customer` represents your application's processing. The base URL is
+`https://api.raims.com` for both Sandbox and Production. The key determines the
+company, environment, and permissions. Keep it on the server and out of version
+control.
+
+## Create a charge
+
+`customer_id`, `due_date`, and `order_idempotency_key` are values your application
+has already defined and persisted for the order. The due date uses Unix seconds
+in UTC, and the amount uses integer cents: `15000` represents BRL 150.00.
+
+```python
+from raims import RequestOptions
+
+with RaimsClient(os.environ["RAIMS_API_KEY"]) as raims:
+    charge = raims.charges.create(
+        {
+            "customer_id": customer_id,
+            "amount_cents": 15000,
+            "due_date": due_date,
+            "title": "Order 1234",
+        },
+        options=RequestOptions(idempotency_key=order_idempotency_key),
+    )
+    response = charge.last_response
+    assert response is not None
+    request_id = response.request_id
+```
+
+The SDK does not generate idempotency keys or retry writes automatically.
+If you lose a response, keep the same key and parameters and follow the
+endpoint's rules for retrieving or retrying the operation. A `202` response
+means processing is pending; retrieve the resource to follow its outcome.
+
+## Asynchronous use
+
+```python
+from raims import AsyncRaimsClient
+
+async def load_customers(api_key: str) -> None:
+    async with AsyncRaimsClient(api_key) as raims:
+        page = await raims.customers.list({"page_size": 50})
+        async for customer in page.auto_paging_iter():
+            await process_customer_async(customer.id)
+```
+
+`process_customer_async` represents your application's asynchronous processing.
+Normal iteration over a page accesses only the items already received.
+`auto_paging_iter()` retrieves subsequent pages as you consume them.
+
+## Services
+
+| Property | Resources |
+| --- | --- |
+| `accounts` | Account context, number, fees, and checkout |
+| `balances` | Balance and forecast |
+| `customers` | Customer creation, retrieval, and deletion |
+| `charges` | Charges, payment, documents, and refunds for a charge |
+| `payment_links` | Payment links and email delivery requests |
+| `refunds` | Refunds and receipts |
+| `disputes` | Disputes |
+| `statements` | Account statements |
+| `withdrawals` | Withdrawals, limits, summary, and automatic settings |
+| `withdrawal_destinations` | Withdrawal destinations |
+| `webhooks` | Registration, health, pause, test, and secret rotation |
+| `webhook_event_types` | Available event types |
+| `simulations.charges` | Charge simulations with a Sandbox key |
+| `simulations.refunds` | Refund simulations with a Sandbox key |
+
+Services expose `create`, `retrieve`, `update`, `delete`, and `list` according
+to the operations available. The [reference](docs/reference.md) describes each
+method.
+
+## Documentation
+
+- [Configuration, responses, and documents](docs/usage.md)
+- [Pagination](docs/pagination.md)
+- [Errors, idempotency, and retries](docs/errors-and-retries.md)
+- [Receiving webhooks](docs/webhooks.md)
+- [Contributing](CONTRIBUTING.md) and [security](SECURITY.md)
+- [Installation and integration guide](https://docs.raims.com/en/integracoes/sdk-python)
+- [Public API](https://docs.raims.com/en/api)
+
+Distributed under the [MIT license](LICENSE).

raims-0.1.3/SECURITY.md

@@ -0,0 +1,15 @@
+# Security
+
+Report vulnerabilities privately to `security@raims.com`. Do not open a public
+discussion containing credentials, personal data, real request or response
+bodies, webhook secrets, or temporary URLs. Describe the behavior, affected
+version, and a minimal reproduction using fictitious data.
+
+The SDK is intended for the integrator's server. Store keys and secrets in a
+vault, use the permissions your integration needs, and keep Python and its
+dependencies updated. Check company, environment, authorization, and
+idempotency in your application.
+
+Webhook verification authenticates the delivery. The integrator remains
+responsible for validating the event, deduplicating it, and persisting the work
+before acknowledging it over HTTP.