feat!: complete the customers rename, remove receivers/api_keys (v3.0.0, held for #1799) - #55
Open
ericviana wants to merge 1 commit into
Open
feat!: complete the customers rename, remove receivers/api_keys (v3.0.0, held for #1799)#55ericviana wants to merge 1 commit into
ericviana wants to merge 1 commit into
Conversation
Collaborator
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
…re contract check Wave-2 breaking release (3.0.0): the remaining receiver_* field renames, removal of the receiver.* webhook events and legacy surface, and a mechanical contract-check in CI that validates every SDK-declared wire key and the webhook enum against the committed public spec snapshot (.api-sync/spec-snapshot.json). Held until blindpay-v2 #1799 reaches production; the branch history was rebuilt as this single commit so the snapshot only ever contains the public filtered spec. Claude-Session: https://claude.ai/code/session_01F1stiNzuNtJXoXtiW9ZCbs
ericviana
force-pushed
the
eric/customers-wave-2
branch
from
July 27, 2026 22:45
bba4d14 to
e2d1205
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Held: do not merge before blindpay-v2 #1799 deploys
This is wave 2 of the receivers-to-customers cutover. It targets the API shape that goes
live once #1799 reaches production, not what's deployed today. Merging this before
that deploy would break every consumer on the current API. The orchestrator merges it
after a production probe confirms the cutover; the
hold-until-1799-deploylabel marksthat.
What breaks
Field renames (requests and responses)
receiver_local_amountcustomer_local_amountreceiver_wallet_addresscustomer_wallet_addressreceiver_networkcustomer_networkreceiver_tokencustomer_tokenreceiver_invite_redirect_urlcustomer_invite_redirect_urlreceiver_idcustomer_idPayout,Payin,Transfer,Owner, terms-of-serviceinitiate()The last row wasn't spelled out in the sunset changelog text but is real: the target spec
(
.api-sync/spec-snapshot.json) has zeroreceiver_idproperties left anywhere, onlycustomer_id. Verified directly against the snapshot rather than assumed.Where wave 1 left a transitional dual key (
ListPayoutsInput.receiver_id+.customer_id,ListPayinsInputsame,Owner.receiver_id+.customer_id), thereceiver_idleg is dropped.Owner.customer_idstaysNotRequired-- the target spec'sowners[]item schema has norequiredarray at all, so nothing on it can be markedrequired.
Removed
receiversresource/module and itsclient.pydeprecation shim.api_keysresource (product decision: API Keys is intentionally absent from thepublic reference).
receiver.new/receiver.update/receiver.deletefrom the webhook event enum --they stop firing at cutover. They were marked deprecated in wave 1.
WebhookEventadditive-release shim fromtypes.py/__init__.py, exactly asplanned when wave 1 added it ("removal belongs in the next major, alongside dropping
the receiver.* members").
Unchanged by design (verified against the target spec, not assumed)
receiver_amount(singular) everywhere -- it's the receiving-side amount on quotes,payins, payouts and transfers.
currency_typestill accepts"sender" | "receiver".re_-prefixed ID values in tests are untouched; only thereceiver_idkeyname changed to
customer_id.otc_only_supported_for_sender_without_cover_fees_and_receiver_with_cover_feesslugisn't modeled by this SDK at all (no error-message registry here), so there was nothing
to preserve or break.
The contract check
Added
.api-sync/check_contract.py, a dependency-free script (stdlib only, one command:python3 .api-sync/check_contract.py) that:TypedDictinsrc/blindpayviaastandfails if any declared field name doesn't exist as a property name anywhere in the
committed spec snapshot (
.api-sync/spec-snapshot.json), unless the(ClassName, field)pair is in
.api-sync/allowlist.json.enum must be present in the SDK's
WebhookEventsliteral.counted but don't fail the build.
allowlist.jsonis seeded only with divergences that already exist onmainand areunrelated to this rename (stale
bank_accounts.get()field names, dead/unused inputtypes, the
from-keyword remap on FX rate inputs,tracking_partner_fee/billing_feefields the spec never had, undocumented
partner_feesCRUD, and a case-onlyusdb/usdc/usdtvsUSDB/USDC/USDTmismatch). Each entry has a reason and anowner. Nothing wave 2 was supposed to fix is in there.
Wired into
main.yamlas a newcontract-checkjob alongside lint/typecheck/tests.Versioning
Python bump is
feat!/BREAKING CHANGE-> release-please will produce3.0.0onmerge (no version files hand-edited;
uv.lock's recorded package version was updated byuv sync, not by hand).Test plan
uv run ruff format --check/uv run ruff check .uv run pyright/uv run mypy .uv run pytest --tb=short -q-- 145 passedpython3 .api-sync/check_contract.py-- passes; reverting any one rename locallymakes it fail (verified for both the field-rename direction and the webhook-enum
direction)
https://claude.ai/code/session_01F1stiNzuNtJXoXtiW9ZCbs