dime-python-sdk 1.0.0__py3-none-any.whl

dime_payments/support/arr.py

@@ -0,0 +1,60 @@
+from typing import Any
+
+
+def arr_string(data: dict[str, Any], key: str, default: str | None = None) -> str | None:
+    value = data.get(key)
+    if value is None or isinstance(value, (dict, list)):
+        return default
+    if isinstance(value, bool):
+        return '1' if value else '0'
+    return str(value)
+
+
+def arr_string_from(data: dict[str, Any], keys: list[str], default: str | None = None) -> str | None:
+    for key in keys:
+        if key in data and data[key] is not None:
+            return arr_string(data, key, default)
+    return default
+
+
+def arr_int(data: dict[str, Any], key: str, default: int | None = None) -> int | None:
+    value = data.get(key)
+    if value is None:
+        return default
+    try:
+        return int(value)
+    except (TypeError, ValueError):
+        return default
+
+
+def arr_float(data: dict[str, Any], key: str, default: float | None = None) -> float | None:
+    value = data.get(key)
+    if value is None:
+        return default
+    try:
+        return float(value)
+    except (TypeError, ValueError):
+        return default
+
+
+def arr_bool(data: dict[str, Any], key: str, default: bool = False) -> bool:
+    value = data.get(key)
+    return default if value is None else bool(value)
+
+
+def arr_object(data: dict[str, Any], key: str) -> dict[str, Any]:
+    value = data.get(key)
+    return value if isinstance(value, dict) else {}
+
+
+def arr_object_from(data: dict[str, Any], keys: list[str]) -> dict[str, Any]:
+    for key in keys:
+        value = data.get(key)
+        if isinstance(value, dict):
+            return value
+    return {}
+
+
+def arr_array(data: dict[str, Any], key: str) -> list[Any]:
+    value = data.get(key)
+    return value if isinstance(value, list) else []

dime_python_sdk-1.0.0.dist-info/METADATA

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: dime-python-sdk
+Version: 1.0.0
+Summary: Python client for the Dime Payments API
+Author: Dime Technology
+License: MIT License
+        
+        Copyright (c) 2026 Dime Technology
+        
+        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.
+License-File: LICENSE
+Keywords: api,dime,payments,sdk
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+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
+Requires-Python: >=3.10
+Requires-Dist: requests>=2.28
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Dime Payments Python SDK
+
+A typed Python client for the [Dime Payments](https://dimepayments.com) API.
+Works with Python 3.10+ on any platform.
+
+```python
+from dime_payments import Client
+
+dime = Client('your-api-token')
+
+txn = dime.transactions.charge_card('000010', {
+    'amount': '49.99',
+    'token': 'tok_abc123',
+})
+
+print(txn.transaction_status)  # "Success"
+```
+
+## Requirements
+
+- Python 3.10+
+- A Dime API token (a Laravel Sanctum personal access token). Tokens are minted inside the
+  Dime application, not via this SDK, and carry abilities (e.g. `transaction:charge-card-token`,
+  `customer:read`) that gate which calls succeed.
+
+## Installation
+
+```bash
+pip install dime-python-sdk
+```
+
+## Configuration
+
+The simplest setup needs only a token:
+
+```python
+dime = Client('your-api-token')
+```
+
+Point it at another environment, or use `Config` for full control:
+
+```python
+from dime_payments import Client, Config
+
+# Staging environment
+dime = Client('your-api-token', 'https://staging.dimepayments.com')
+
+# Full control
+dime = Client(Config(
+    token='your-api-token',
+    base_url='https://app.dimepayments.com',
+    timeout=30.0,       # seconds
+    max_retries=2,      # retries 429 / 5xx / network errors with backoff
+    retry_base_delay=0.5,
+))
+```
+
+The SDK sends `Authorization: Bearer <token>` and JSON headers on every request. Transient
+failures (HTTP 429 and 5xx, network errors) are retried with exponential backoff, honoring the
+`Retry-After` header when present.
+
+## Resources
+
+Every resource hangs off the client as a property. The merchant `sid` is always passed
+explicitly; remaining fields go in an `attributes` or `filters` dict. All amounts are
+returned as strings to avoid float rounding.
+
+| Property                        | Endpoints                                                             |
+| ------------------------------- | --------------------------------------------------------------------- |
+| `dime.transactions`             | charge_card, charge_ach, tokenize_card, refund, void, show, list     |
+| `dime.customers`                | list, show, create, update, delete                                    |
+| `dime.payment_methods`          | list, show, create, update, delete                                    |
+| `dime.merchants`                | list, show, create, update, get_form_link                             |
+| `dime.addresses`                | list, show, create, update, delete                                    |
+| `dime.deposits`                 | list, list_with_transactions, show                                    |
+| `dime.recurring_payments`       | list, show, create, edit, pause, cancel, activate, delete             |
+
+### Transactions
+
+```python
+# Charge a stored token
+txn = dime.transactions.charge_card('000010', {
+    'amount': '100.00',
+    'token': 'tok_abc123',
+    'email': 'customer@example.com',
+})
+
+# Charge raw card details (merchant must be PCI compliant)
+txn = dime.transactions.charge_card('000010', {
+    'amount': '100.00',
+    'cardholder_name': 'John Doe',
+    'card_number': '4111111111111111',
+    'expiration_date': '01/2027',
+    'cvv': '123',
+})
+
+# ACH
+txn = dime.transactions.charge_ach('000010', {
+    'routing_number': '123456789',
+    'account_number': '9876543210',
+    'account_type': 'Checking',
+    'account_name': 'John Doe',
+    'amount': '75.00',
+})
+
+# Tokenize without charging
+result = dime.transactions.tokenize_card('000010', {
+    'cardholder_name': 'John Doe',
+    'card_number': '4111111111111111',
+    'expiration_date': '01/2027',
+})
+print(result.token)
+
+# Refund / void
+dime.transactions.refund('000010', {'amount': '25.00', 'transaction_info_id': 123456})
+dime.transactions.void('000010', 'CC', 123456)
+
+# Read
+txn = dime.transactions.show('000010', {'transaction_info_id': 123456})
+```
+
+### Customers, payment methods, addresses
+
+```python
+customer = dime.customers.create('000010', {
+    'first_name': 'Jane',
+    'last_name': 'Doe',
+    'email': 'jane@example.com',
+})
+
+pm = dime.payment_methods.create('000010', {
+    'uuid': customer.uuid,
+    'type': 'cc',
+    'cc_name_on_card': 'Jane Doe',
+    'cc_number': '4111111111111111',
+    'cc_expiration_date': '01/2027',
+    'cc_brand': 'Visa',
+    'default': True,
+})
+
+address = dime.addresses.create('000010', customer.uuid, {
+    'recipient': 'Jane Doe',
+    'line_one': '123 Main St',
+    'city': 'Atlanta',
+    'state': 'GA',
+    'zip': '30301',
+})
+```
+
+### Recurring payments
+
+```python
+rp = dime.recurring_payments.create('000010', {
+    'name': 'Monthly donation',
+    'amount': '25.00',
+    'start_date': '2026-07-01 00:00:00',
+    'recurrence_schedule': 'Monthly',
+    'payment_method': pm.id,
+    'customer_uuid': customer.uuid,
+})
+
+dime.recurring_payments.pause('000010', rp.id, '2026-09-01 00:00:00')
+dime.recurring_payments.activate('000010', rp.id)
+dime.recurring_payments.cancel('000010', rp.id)
+```
+
+## Pagination
+
+List endpoints return a `CursorPage`. Iterate one page, walk pages manually, or stream every
+item across all pages with `auto_paging()`:
+
+```python
+page = dime.transactions.list('000010', {
+    'start_date': '2026-01-01 00:00:00',
+    'end_date': '2026-01-31 23:59:59',
+})
+
+# First page only
+for txn in page:
+    print(txn.amount)
+
+# Next page manually
+if page.has_more():
+    next_page = page.next()
+
+# Every transaction across every page (fetches lazily)
+for txn in page.auto_paging():
+    print(txn.transaction_number)
+```
+
+## Error handling
+
+Every failure raises a `DimeException` subclass. Catch the base type, or a specific one:
+
+```python
+from dime_payments import (
+    DimeException,
+    ValidationException,
+    RateLimitException,
+)
+import time
+
+try:
+    dime.transactions.charge_card('000010', {'amount': '0'})
+except ValidationException as e:
+    e.get_errors()   # {'data.amount': ['must be greater than 0']}
+    e.first_error()
+except RateLimitException as e:
+    wait = e.get_retry_after() or 1
+    time.sleep(wait)
+except DimeException as e:
+    e.get_status_code()    # HTTP status
+    e.get_response_body()  # decoded API body
+```
+
+| Exception                    | When                                                         |
+| ---------------------------- | ------------------------------------------------------------ |
+| `ValidationException`        | HTTP 400/422 with field errors                               |
+| `AuthenticationException`    | HTTP 401 (missing/invalid token)                             |
+| `PermissionDeniedException`  | HTTP 403 (belongs-to-company guard)                          |
+| `NotFoundException`          | HTTP 404                                                     |
+| `RateLimitException`         | HTTP 429 (carries `Retry-After`)                             |
+| `ServerException`            | HTTP 5xx                                                     |
+| `ConnectionException`        | No HTTP response (DNS, timeout, network error)               |
+| `ApiException`               | Any other non-2xx                                            |
+
+## Notes
+
+- **GET requests carry a JSON body.** The Dime API expects read parameters in the request body
+  even for `GET` endpoints; the SDK handles this transparently.
+- **No API versioning.** Endpoints live under `/api` with no version prefix.
+
+## Development
+
+```bash
+python3.12 -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+pytest                  # run tests
+```
+
+## License
+
+MIT. See [LICENSE](LICENSE).

dime_python_sdk-1.0.0.dist-info/RECORD

@@ -0,0 +1,48 @@
+dime_payments/__init__.py,sha256=nJGtKtehbZMxar3wgdk8RIG_nNPSb6G9rmMyC2PnjqM,638
+dime_payments/client.py,sha256=K4riOAzgJJvZUfICZxuh34fD0q5oUDeqRExNH51xhRA,1120
+dime_payments/config.py,sha256=io97prwhlASHBRl0nm_YwckMuJxXFP2ylpsfbT7Bys8,847
+dime_payments/data_objects/__init__.py,sha256=1t2xoZ5rX7RoAO9r-rAsTHoyHBNsK8_sEzHQ_8o1pWY,888
+dime_payments/data_objects/address.py,sha256=ocnxRM3JDLr4mDtlnVgsnUb6Hy5u6vNQlWVRFHzuMIw,950
+dime_payments/data_objects/customer.py,sha256=fSUPB9PynX_R3Jntnjr130ExeZtgrmRZSVfds54rmV0,1141
+dime_payments/data_objects/deposit.py,sha256=b0rQdNgdprMtP0pdMrepsWG3jBt7fJ4FGZ1EuHTRQhA,1139
+dime_payments/data_objects/deposit_group.py,sha256=kmfwnDO0YgmvmlSvIakb4cMFYOMfYDDnXMR4eiabSKA,813
+dime_payments/data_objects/deposit_with_transactions.py,sha256=HjmWB5v2R67z5xgqoZt1rlV5nxvixrTmySS-zzUFA0c,1420
+dime_payments/data_objects/form_link.py,sha256=rPU7cJynsrfb_1QjT8DkZ8ShvXVXUScBqJNZVASeJCI,280
+dime_payments/data_objects/merchant.py,sha256=U6RbP3QJACjOtrSExyodfz9zOzeU2hThXwGD6M0XATI,1900
+dime_payments/data_objects/message_result.py,sha256=2gZYbokwPRdlBUz_vGgYzrJpxMnjMuzwtTdjXhUv1GM,299
+dime_payments/data_objects/payment_method.py,sha256=-3kcHBGoXD12mzHocMoKU0aBwoNJ_9GJFx5eldXUJxA,2460
+dime_payments/data_objects/recurring_payment.py,sha256=E6F3oX6aqWeE2Ek4ePqDDbZ79APdIKKXVip4bTcFU-g,2209
+dime_payments/data_objects/recurring_payment_method.py,sha256=P22ITvvxAUJ4NaEc7MH2ItCFm6wk1mEuxRs4ffSUDrg,402
+dime_payments/data_objects/tokenize_result.py,sha256=i27Hc0A-dFM8cX8s9A71yM95kd48ih25fvnb3SEml54,295
+dime_payments/data_objects/transaction.py,sha256=tP440NddFddKlWxE-9KVSOzkdW6bUwt_4sTNlvmmTTc,2623
+dime_payments/data_objects/transaction_address.py,sha256=pHSlwQBFayh8dWRovyNVvOpAavO3JI0NtzgagAdww0Y,788
+dime_payments/exceptions/__init__.py,sha256=1ZOOjwAyjip5Symv_6RMYQpj3Z9G0oNG1ISyJXad8sc,717
+dime_payments/exceptions/api_exception.py,sha256=OKUdGN_X4p9OnK6T1-uipWEwwHVf1RwLuO-k7FdHKTI,88
+dime_payments/exceptions/authentication_exception.py,sha256=8VsAGUIBAIQ-lTtHnSkiXOkK9bX7G_U3CH7IM99wC80,99
+dime_payments/exceptions/connection_exception.py,sha256=KGssG2OIo0nI7G-GC0Pnwue1xKkqhJMqWfHL9oLPAyg,95
+dime_payments/exceptions/dime_exception.py,sha256=3GsZOOMURwRoGztqf6hqej2A8Rvvwl1c1iSOn5CicIs,521
+dime_payments/exceptions/not_found_exception.py,sha256=OUqpYYyCuSgbuHEa9qeLWtUBaD8cOoLTKFmBBtYAE_w,93
+dime_payments/exceptions/permission_denied_exception.py,sha256=OswpsCq4_byi7VKLctxuEOKqzDGgmCsK9xwGHntxpkU,101
+dime_payments/exceptions/rate_limit_exception.py,sha256=UAmgtRrX0MmnsMqgrnssLdLqYS_647nhwuEkMy-WJxo,496
+dime_payments/exceptions/server_exception.py,sha256=SCUubaM1wTwFMW3E9mBSxry4A-0Q03JH6FQC0thFfvc,91
+dime_payments/exceptions/validation_exception.py,sha256=_HGMPN-5iFq6RWJY-06Oaak565MeD-yRf6GnbXp7Sog,689
+dime_payments/http/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dime_payments/http/error_handler.py,sha256=dqClsyDIcCPS6CtiqtGvEwTnORj24m2muXThXfHdhX0,2873
+dime_payments/http/transport.py,sha256=G2dPpXckNBUKjc0MwmzopF8YfACMR3LR3M9RROyX_Nw,2642
+dime_payments/pagination/__init__.py,sha256=J2k8htn29Nu92KQh4wtEeN0StyMc8cWxVY8jQydF-dQ,62
+dime_payments/pagination/cursor_page.py,sha256=Xpbt33ceBy_HQlqe3wFbxA93bUfx3rHcqXfhVAkOQJ0,2263
+dime_payments/resources/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dime_payments/resources/abstract_resource.py,sha256=-XmnqJvk2tVNe44JeY_TTAzD4UiUKsQkl3Hia6ANHiQ,1522
+dime_payments/resources/addresses.py,sha256=sg0q3YCnkdGlGM0onbBh_UsatrIu4VyzAA1BdZ1QRZ0,1713
+dime_payments/resources/customers.py,sha256=6_9gG9tc2uHN-onhzNFP0NO67NxGOYqbwZmF96vU4bo,1545
+dime_payments/resources/deposits.py,sha256=k8wE7kT_baHjXmXxzN9v6_2BqDb0GSUlINPRVtjmyUI,1213
+dime_payments/resources/merchants.py,sha256=blVx7JIAps9ktdpLjjQofEnVkK_KgXOQP8beBPkHrkg,1370
+dime_payments/resources/payment_methods.py,sha256=KJWryjnZadyohG1r6pmULjwPIjPIjScSK7ekQYamvYA,1775
+dime_payments/resources/recurring_payments.py,sha256=DPihjc-C7oLLfPrP5UveNpEKHmUxayv4k3hFpguJ35c,2940
+dime_payments/resources/transactions.py,sha256=Q0VwYDicdGuM1WQXqxPX_KS313A0KZVCeuVCyKS_G7k,2742
+dime_payments/support/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dime_payments/support/arr.py,sha256=_mboi_q3HGn_Sx_MgU2exkbl-fnP2gdDY8yeSC8hkNc,1722
+dime_python_sdk-1.0.0.dist-info/METADATA,sha256=YdWerOwvU8IBJOFjpxJg3HuuEbrDW-oC19Mp9SJJeBo,9553
+dime_python_sdk-1.0.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+dime_python_sdk-1.0.0.dist-info/licenses/LICENSE,sha256=-Xc5dLgfuFLVQLsSKNYmJKtNZCUU1_9ErffdGiwH-DU,1072
+dime_python_sdk-1.0.0.dist-info/RECORD,,

dime_python_sdk-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.30.1
+Root-Is-Purelib: true
+Tag: py3-none-any

dime_python_sdk-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dime Technology
+
+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.