revaly-sdk 0.5.1__tar.gz

revaly_sdk-0.5.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

revaly_sdk-0.5.1/NOTICE

@@ -0,0 +1,2 @@
+Revaly RAP SDK
+Copyright 2026 Revaly Technologies Inc.

revaly_sdk-0.5.1/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.4
+Name: revaly-sdk
+Version: 0.5.1
+Summary: Revaly RAP V2 server-side SDK for Python (payments, payment methods, transactions, notify) with the merchant failover contract built in
+License: Apache-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: urllib3<3.0.0,>=2.7.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2.11
+Requires-Dist: typing-extensions>=4.7.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Dynamic: license-file
+
+# Revaly RAP SDK for Python
+
+Server-side Python SDK for the RAP V2 API: payments, payment methods, transactions and
+notify — with a **merchant-facing failover contract** built in. Every failed payment
+call raises exactly one of three typed classes that tell you what you may safely do
+next.
+
+> **Package status:** the PyPI name `revaly-sdk` is **[Proposed]** until registry
+> provisioning (OQ-3), and registry publish is embargoed — install from the
+> per-language GitHub release artifact until then. Requires Python ≥ 3.9.
+
+## Why the error classes matter (read this first)
+
+A failed `charge(...)` does **not** mean the payment didn't happen. If you
+blind-fail-over to your own gateway on an ambiguous failure, the cardholder can be
+charged **twice**. The SDK classifies every failure so you never have to guess:
+
+| Class | Meaning | What you do |
+| --- | --- | --- |
+| `RapPermanentRejection` | Received and rejected (400/401/403/404/422) | Fix or decline. **Never fail over** — the same request fails anywhere. |
+| `RapTransientFailure` | **Definitively not processed** (provably never sent, or `503` + `code: not_processed`) | Route to your own gateway immediately. |
+| `RapOutcomeUnknown` | **May have been processed** (timeout after send, reset, 5xx) | **Reconcile before acting** — see below. |
+
+## Quickstart (sandbox key → first charge, ≤ 15 minutes)
+
+Your API key's scope selects the environment: sandbox and live share the same URL —
+there is no separate sandbox host. Use the sandbox-scoped key issued by Enablement.
+
+```bash
+# Download revaly-sdk-python.tar.gz from the release, verify its .sha256, then:
+pip install ./revaly-sdk-python.tar.gz
+# (the release also attaches a wheel — either file installs the same package)
+```
+
+```python
+import os
+
+from revaly_sdk import (
+    CreditCard,
+    Found,
+    NotFoundYet,
+    PaymentMethod,
+    PaymentRequest,
+    RapClient,
+    RapOutcomeUnknown,
+    RapPermanentRejection,
+    RapTransactionOutcome,
+    RapTransientFailure,
+    ReconcilePolicy,
+)
+
+client = RapClient(os.environ["RAP_API_KEY"])
+
+request = PaymentRequest(
+    amount=1999,
+    currency="USD",
+    merchant_transaction_id="order-1042",  # required on every payment — it is your reconcile handle
+    order_id="order-1042",  # orderId + email below: the sandbox simulator requires both for an approval
+    # paymentMethodType is omitted — inferred from the one populated method object
+    payment_method=PaymentMethod(
+        full_name="Ada Lovelace",  # creditCard requires a cardholder name
+        email="ada@example.com",
+        credit_card=CreditCard(
+            number="4111111111111111",  # sandbox test PAN
+            card_verification_code="999",
+            expiry_month="12",
+            expiry_year="2030",
+        )
+    ),
+)
+
+try:
+    transaction = client.charge(request)
+    print("approved", transaction.transaction_id)
+except RapPermanentRejection as failure:
+    # Fix or decline. Never fail over — the same request fails anywhere.
+    print("rejected", failure.status, failure.api_error, failure.correlation_id)
+except RapTransientFailure:
+    # Definitively not processed — route to your own gateway immediately.
+    route_to_own_gateway()
+except RapOutcomeUnknown:
+    # May have been processed — reconcile BEFORE acting (double-charge hazard).
+    verdict = client.reconcile(
+        "order-1042",
+        ReconcilePolicy(max_attempts=5, overall_budget=30.0, initial_delay=0.5),
+    )
+    if isinstance(verdict, Found):
+        # The record IS visible. Found(APPROVED) means the money moved —
+        # failing over now would double-charge.
+        print("resolved", verdict.outcome, verdict.correlation_id)
+    elif isinstance(verdict, NotFoundYet):
+        # Not visible YET — absence is not provable in V1. Hold and escalate
+        # per your risk policy; do not treat this as "safe to fail over".
+        print("hold", verdict.attempts, verdict.last_correlation_id)
+    else:
+        # Verdicts are open for extension (SafeToFailover arrives with
+        # platform P-2 as a minor release). Always keep this branch.
+        escalate_to_operator(verdict)
+```
+
+### Timeouts
+
+`overall_deadline` defaults to **75 seconds** (`DEFAULT_OVERALL_DEADLINE`) — ratified
+from production latency telemetry (ADR-SDK-027): it clears every observed gateway
+tail cluster (the worst non-hung tail seen in 14 fleet days was 64 s), clips ≲0.007%
+of charges, and still classifies well before the platform's own ≈100 s ceiling.
+Tighten it per your checkout budget (RAP routes gateways server-side, so the default
+must cover the slowest common class), or pass an explicit `overall_deadline=None` to
+disable the SDK deadline. `connect_timeout` defaults to **10 seconds**
+(`DEFAULT_CONNECT_TIMEOUT`) — ratified from the OQ-11 edge verification (ADR-SDK-029):
+roughly 25× the observed cold client→edge TLS envelope, and 65 s below the overall
+deadline. Pass an explicit `connect_timeout=None` to disable the SDK connect bound.
+All timeouts are seconds:
+
+```python
+client = RapClient(api_key, connect_timeout=3.0, overall_deadline=10.0)
+# or per call:
+client.charge(request, overall_deadline=5.0)
+```
+
+Note the per-call asymmetry: passing `overall_deadline=None` (or omitting it) on a call
+means "use the client's configured value", never "disable" — disabling the deadline is
+a client-construction decision only (`RapClient(..., overall_deadline=None)`),
+deliberately without a per-call equivalent (the safe direction). The same asymmetry
+applies to `connect_timeout`.
+
+- `overall_deadline` expiry **after send** classifies `RapOutcomeUnknown` (reconcile),
+  never TransientFailure.
+- `connect_timeout` expiry proves the request never left the client and classifies
+  `RapTransientFailure` — urllib3 reports the connect phase distinctly even when only
+  an overall deadline is set.
+
+Python has no ambient cancellation token: bound calls with these timeout arguments and
+bound reconciliation with the `ReconcilePolicy` budget — that is this SDK's
+cancellation idiom.
+
+### API versioning
+
+Requests pin `X-Api-Version: 2.1` by default. `"2.0"` is selectable
+(`api_version="2.0"`) but narrows the contract: `ErrorResponse.code` is not part of
+the 2.0 documented surface, so a `503` + `not_processed` classifies
+`RapOutcomeUnknown` (reconcile) instead of `RapTransientFailure` (immediate failover).
+Pin 2.1 unless you have a frozen 2.0 integration.
+
+## Testing your failover handler — no network
+
+The mock transport scripts every row of the failure taxonomy and both reconcile
+verdicts, and asserts your requests carry the SDK User-Agent. It replaces only the
+wire: header injection and classification run exactly as in production.
+
+```python
+from revaly_sdk import RapClient
+from revaly_sdk.testing import RapMockTransport
+
+mock = RapMockTransport()
+mock.charge().returns_not_processed_503()  # → RapTransientFailure
+mock.reconcile().not_found_yet(2).then_found_approved()
+
+client = RapClient("sk-synthetic", transport=mock)
+# exercise YOUR suppression/escalation logic against scripted consecutive outcomes:
+mock.charge().returns_bare_503().throws_connection_refused().returns_approved()
+```
+
+Scenario methods mirror the contract: `returns_permanent_rejection(status)`,
+`returns_not_processed_503()`, `throws_connection_refused()`, `throws_dns_failure()`,
+`throws_ssl_handshake_failure()`, `throws_connect_timeout()`,
+`throws_timeout_after_send()`, `throws_connection_reset()`, `returns_bare_503()`,
+`returns_server_error()`, `pending()`, and raw escapes `returns(...)` /
+`throws_io(...)`. Transport failures are simulated with real urllib3 exception
+instances, so classification in your tests exercises the production code path.
+Synthetic data only — no real PAN/CVV/PII ever appears in the mock.
+
+## Logging & debugging
+
+- Logging uses the stdlib `logging` module (logger name `revaly_sdk`; silent until
+  your application configures handlers, or pass `logger=`). Default output is
+  **values-free** — operation, status, class, correlation id. `DEBUG` level carries
+  **allowlist-scrubbed** payloads only; PAN/CVV/PII and the API key can never appear
+  (the API key is also absent from every error message).
+- `wire_trace_hook`: a request/response observer for Enablement escalations —
+  payloads arrive already scrubbed by the runtime's central allowlist scrubber.
+- Every response and every typed error carries the `X-Correlation-ID`; quote it in
+  support tickets to join RAP-core telemetry directly.
+
+## What this SDK never does
+
+No hidden retries, no resubmission, no circuit breaker, no cross-request state, no
+`bypassPlatform`. The explicit, caller-bounded reconcile re-poll is the only loop the
+SDK owns. Classification never derives from message text, latency, or wait
+heuristics. (Concretely: urllib3's default connect retries and redirect-following are
+disabled on every request — a `307` on `POST /payments` comes back as a response and
+classifies `RapOutcomeUnknown` instead of being silently re-sent.)
+
+## Beyond payments
+
+The full generated V2 surface ships in the same package and flows through the same
+transport, headers and classification:
+
+```python
+methods = client.payment_methods.list_payment_methods()
+raw = client.transactions.get_transaction_by_id_without_preload_content("txn-1")
+```
+
+One logging caution on this surface: raw core operations raise the generator's
+`ApiException`, not the three typed classes — and `str(ApiException)` embeds the full
+HTTP response body. Response bodies can contain PII (names, emails, masked card data):
+never log raw core exceptions or response bodies; log the correlation id and the typed
+runtime errors (values-free by design) instead.

revaly_sdk-0.5.1/README.md

@@ -0,0 +1,208 @@
+# Revaly RAP SDK for Python
+
+Server-side Python SDK for the RAP V2 API: payments, payment methods, transactions and
+notify — with a **merchant-facing failover contract** built in. Every failed payment
+call raises exactly one of three typed classes that tell you what you may safely do
+next.
+
+> **Package status:** the PyPI name `revaly-sdk` is **[Proposed]** until registry
+> provisioning (OQ-3), and registry publish is embargoed — install from the
+> per-language GitHub release artifact until then. Requires Python ≥ 3.9.
+
+## Why the error classes matter (read this first)
+
+A failed `charge(...)` does **not** mean the payment didn't happen. If you
+blind-fail-over to your own gateway on an ambiguous failure, the cardholder can be
+charged **twice**. The SDK classifies every failure so you never have to guess:
+
+| Class | Meaning | What you do |
+| --- | --- | --- |
+| `RapPermanentRejection` | Received and rejected (400/401/403/404/422) | Fix or decline. **Never fail over** — the same request fails anywhere. |
+| `RapTransientFailure` | **Definitively not processed** (provably never sent, or `503` + `code: not_processed`) | Route to your own gateway immediately. |
+| `RapOutcomeUnknown` | **May have been processed** (timeout after send, reset, 5xx) | **Reconcile before acting** — see below. |
+
+## Quickstart (sandbox key → first charge, ≤ 15 minutes)
+
+Your API key's scope selects the environment: sandbox and live share the same URL —
+there is no separate sandbox host. Use the sandbox-scoped key issued by Enablement.
+
+```bash
+# Download revaly-sdk-python.tar.gz from the release, verify its .sha256, then:
+pip install ./revaly-sdk-python.tar.gz
+# (the release also attaches a wheel — either file installs the same package)
+```
+
+```python
+import os
+
+from revaly_sdk import (
+    CreditCard,
+    Found,
+    NotFoundYet,
+    PaymentMethod,
+    PaymentRequest,
+    RapClient,
+    RapOutcomeUnknown,
+    RapPermanentRejection,
+    RapTransactionOutcome,
+    RapTransientFailure,
+    ReconcilePolicy,
+)
+
+client = RapClient(os.environ["RAP_API_KEY"])
+
+request = PaymentRequest(
+    amount=1999,
+    currency="USD",
+    merchant_transaction_id="order-1042",  # required on every payment — it is your reconcile handle
+    order_id="order-1042",  # orderId + email below: the sandbox simulator requires both for an approval
+    # paymentMethodType is omitted — inferred from the one populated method object
+    payment_method=PaymentMethod(
+        full_name="Ada Lovelace",  # creditCard requires a cardholder name
+        email="ada@example.com",
+        credit_card=CreditCard(
+            number="4111111111111111",  # sandbox test PAN
+            card_verification_code="999",
+            expiry_month="12",
+            expiry_year="2030",
+        )
+    ),
+)
+
+try:
+    transaction = client.charge(request)
+    print("approved", transaction.transaction_id)
+except RapPermanentRejection as failure:
+    # Fix or decline. Never fail over — the same request fails anywhere.
+    print("rejected", failure.status, failure.api_error, failure.correlation_id)
+except RapTransientFailure:
+    # Definitively not processed — route to your own gateway immediately.
+    route_to_own_gateway()
+except RapOutcomeUnknown:
+    # May have been processed — reconcile BEFORE acting (double-charge hazard).
+    verdict = client.reconcile(
+        "order-1042",
+        ReconcilePolicy(max_attempts=5, overall_budget=30.0, initial_delay=0.5),
+    )
+    if isinstance(verdict, Found):
+        # The record IS visible. Found(APPROVED) means the money moved —
+        # failing over now would double-charge.
+        print("resolved", verdict.outcome, verdict.correlation_id)
+    elif isinstance(verdict, NotFoundYet):
+        # Not visible YET — absence is not provable in V1. Hold and escalate
+        # per your risk policy; do not treat this as "safe to fail over".
+        print("hold", verdict.attempts, verdict.last_correlation_id)
+    else:
+        # Verdicts are open for extension (SafeToFailover arrives with
+        # platform P-2 as a minor release). Always keep this branch.
+        escalate_to_operator(verdict)
+```
+
+### Timeouts
+
+`overall_deadline` defaults to **75 seconds** (`DEFAULT_OVERALL_DEADLINE`) — ratified
+from production latency telemetry (ADR-SDK-027): it clears every observed gateway
+tail cluster (the worst non-hung tail seen in 14 fleet days was 64 s), clips ≲0.007%
+of charges, and still classifies well before the platform's own ≈100 s ceiling.
+Tighten it per your checkout budget (RAP routes gateways server-side, so the default
+must cover the slowest common class), or pass an explicit `overall_deadline=None` to
+disable the SDK deadline. `connect_timeout` defaults to **10 seconds**
+(`DEFAULT_CONNECT_TIMEOUT`) — ratified from the OQ-11 edge verification (ADR-SDK-029):
+roughly 25× the observed cold client→edge TLS envelope, and 65 s below the overall
+deadline. Pass an explicit `connect_timeout=None` to disable the SDK connect bound.
+All timeouts are seconds:
+
+```python
+client = RapClient(api_key, connect_timeout=3.0, overall_deadline=10.0)
+# or per call:
+client.charge(request, overall_deadline=5.0)
+```
+
+Note the per-call asymmetry: passing `overall_deadline=None` (or omitting it) on a call
+means "use the client's configured value", never "disable" — disabling the deadline is
+a client-construction decision only (`RapClient(..., overall_deadline=None)`),
+deliberately without a per-call equivalent (the safe direction). The same asymmetry
+applies to `connect_timeout`.
+
+- `overall_deadline` expiry **after send** classifies `RapOutcomeUnknown` (reconcile),
+  never TransientFailure.
+- `connect_timeout` expiry proves the request never left the client and classifies
+  `RapTransientFailure` — urllib3 reports the connect phase distinctly even when only
+  an overall deadline is set.
+
+Python has no ambient cancellation token: bound calls with these timeout arguments and
+bound reconciliation with the `ReconcilePolicy` budget — that is this SDK's
+cancellation idiom.
+
+### API versioning
+
+Requests pin `X-Api-Version: 2.1` by default. `"2.0"` is selectable
+(`api_version="2.0"`) but narrows the contract: `ErrorResponse.code` is not part of
+the 2.0 documented surface, so a `503` + `not_processed` classifies
+`RapOutcomeUnknown` (reconcile) instead of `RapTransientFailure` (immediate failover).
+Pin 2.1 unless you have a frozen 2.0 integration.
+
+## Testing your failover handler — no network
+
+The mock transport scripts every row of the failure taxonomy and both reconcile
+verdicts, and asserts your requests carry the SDK User-Agent. It replaces only the
+wire: header injection and classification run exactly as in production.
+
+```python
+from revaly_sdk import RapClient
+from revaly_sdk.testing import RapMockTransport
+
+mock = RapMockTransport()
+mock.charge().returns_not_processed_503()  # → RapTransientFailure
+mock.reconcile().not_found_yet(2).then_found_approved()
+
+client = RapClient("sk-synthetic", transport=mock)
+# exercise YOUR suppression/escalation logic against scripted consecutive outcomes:
+mock.charge().returns_bare_503().throws_connection_refused().returns_approved()
+```
+
+Scenario methods mirror the contract: `returns_permanent_rejection(status)`,
+`returns_not_processed_503()`, `throws_connection_refused()`, `throws_dns_failure()`,
+`throws_ssl_handshake_failure()`, `throws_connect_timeout()`,
+`throws_timeout_after_send()`, `throws_connection_reset()`, `returns_bare_503()`,
+`returns_server_error()`, `pending()`, and raw escapes `returns(...)` /
+`throws_io(...)`. Transport failures are simulated with real urllib3 exception
+instances, so classification in your tests exercises the production code path.
+Synthetic data only — no real PAN/CVV/PII ever appears in the mock.
+
+## Logging & debugging
+
+- Logging uses the stdlib `logging` module (logger name `revaly_sdk`; silent until
+  your application configures handlers, or pass `logger=`). Default output is
+  **values-free** — operation, status, class, correlation id. `DEBUG` level carries
+  **allowlist-scrubbed** payloads only; PAN/CVV/PII and the API key can never appear
+  (the API key is also absent from every error message).
+- `wire_trace_hook`: a request/response observer for Enablement escalations —
+  payloads arrive already scrubbed by the runtime's central allowlist scrubber.
+- Every response and every typed error carries the `X-Correlation-ID`; quote it in
+  support tickets to join RAP-core telemetry directly.
+
+## What this SDK never does
+
+No hidden retries, no resubmission, no circuit breaker, no cross-request state, no
+`bypassPlatform`. The explicit, caller-bounded reconcile re-poll is the only loop the
+SDK owns. Classification never derives from message text, latency, or wait
+heuristics. (Concretely: urllib3's default connect retries and redirect-following are
+disabled on every request — a `307` on `POST /payments` comes back as a response and
+classifies `RapOutcomeUnknown` instead of being silently re-sent.)
+
+## Beyond payments
+
+The full generated V2 surface ships in the same package and flows through the same
+transport, headers and classification:
+
+```python
+methods = client.payment_methods.list_payment_methods()
+raw = client.transactions.get_transaction_by_id_without_preload_content("txn-1")
+```
+
+One logging caution on this surface: raw core operations raise the generator's
+`ApiException`, not the three typed classes — and `str(ApiException)` embeds the full
+HTTP response body. Response bodies can contain PII (names, emails, masked card data):
+never log raw core exceptions or response bodies; log the correlation id and the typed
+runtime errors (values-free by design) instead.