Skip to content

chore: Sync account schemas#431

Merged
JasonCWang merged 1 commit intomainfrom
auto/sync-grid-schemas-20260501-165225
May 1, 2026
Merged

chore: Sync account schemas#431
JasonCWang merged 1 commit intomainfrom
auto/sync-grid-schemas-20260501-165225

Conversation

@lightspark-copybara
Copy link
Copy Markdown
Contributor

Auto-synced account schemas.

These schemas are generated from VASP adapter field definitions in sparkcore.

Synced schemas:

  • common/ — per-currency account info, beneficiary, and payment account schemas
  • common/PaymentInstructions.yaml — payment instructions oneOf (new currencies added)
  • external_accounts/ — per-currency external account schemas (reference common/)

Please review the changes before merging.

@vercel
Copy link
Copy Markdown

vercel Bot commented May 1, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
grid-flow-builder Ready Ready Preview, Comment May 1, 2026 4:53pm

Request Review

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 1, 2026

✱ Stainless preview builds

This PR will update the grid SDKs with the following commit messages.

kotlin

fix(types): make countryOfResidence optional across beneficiary models, phoneNumber required in Gtq

openapi

fix(types): make countryOfResidence optional, phoneNumber required in beneficiary types

python

fix(types): update field requirements in bdt/ghs/gtq/htg/jmd/pkr beneficiaries

typescript

fix(types): make countryOfResidence optional, phoneNumber required in beneficiary types
⚠️ grid-openapi studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️

⚠️ grid-kotlin studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️build ✅lint ✅test ✅

⚠️ grid-python studio · code

Your SDK build had at least one "warning" diagnostic.
generate ⚠️build ✅lint ✅test ✅

pip install https://pkg.stainless.com/s/grid-python/9709d31d9d9b7eb32f0d73d388f5363a268a8edf/grid-0.0.1-py3-none-any.whl
⚠️ grid-typescript studio · code

Your SDK build had a failure in the lint CI job, which is a regression from the base state.
generate ⚠️build ✅lint ❗test ✅

npm install https://pkg.stainless.com/s/grid-typescript/2fb820dba2d0b849fd47149d878a035e3f995153/dist.tar.gz

This comment is auto-generated by GitHub Actions and is automatically kept up to date as you push.
If you push custom code to the preview branch, re-run this workflow to update the comment.
Last updated: 2026-05-01 17:06:06 UTC

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 1, 2026

Greptile Summary

This auto-synced PR updates the required fields on six currency-specific beneficiary schemas (BDT, GHS, GTQ, HTG, JMD, PKR) in both openapi.yaml and mintlify/openapi.yaml. Five schemas relax validation by removing countryOfResidence from required (backwards-compatible); one schema tightens it.

  • GtqBeneficiary adds phoneNumber to required — this is a breaking change for existing API callers that submit GTQ beneficiaries without a phone number, which was previously allowed.

Confidence Score: 4/5

Safe to merge once the GTQ breaking change is confirmed intentional and downstream callers are updated.

Five of the six schema changes are backwards-compatible relaxations. The one P1 finding — adding phoneNumber as required in GtqBeneficiary — is a breaking change that could fail existing callers, but is likely intentional given this is an auto-sync from sparkcore. Confirmation is needed before merging.

openapi/components/schemas/common/GtqBeneficiary.yaml — adding a new required field is a breaking change

Important Files Changed

Filename Overview
openapi/components/schemas/common/GtqBeneficiary.yaml Adds phoneNumber to required list — breaking change for existing GTQ beneficiary callers
openapi/components/schemas/common/JmdBeneficiary.yaml Removes countryOfResidence from required list (keeps address and phoneNumber required) — backwards-compatible relaxation
openapi/components/schemas/common/BdtBeneficiary.yaml Removes countryOfResidence from required list — backwards-compatible relaxation
openapi/components/schemas/common/GhsBeneficiary.yaml Removes countryOfResidence from required list — backwards-compatible relaxation
openapi/components/schemas/common/HtgBeneficiary.yaml Removes countryOfResidence from required list — backwards-compatible relaxation
openapi/components/schemas/common/PkrBeneficiary.yaml Removes countryOfResidence from required list — backwards-compatible relaxation
openapi.yaml Bundled spec updated to mirror all six YAML schema changes; reflects the GTQ breaking change at line ~10622
mintlify/openapi.yaml Mintlify copy of the spec updated identically to openapi.yaml — in sync

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    PR[Schema Sync PR] --> BDT & GHS & GTQ & HTG & JMD & PKR

    BDT[BdtBeneficiary\nBangladesh Taka]
    BDT --> BDT_R["required: beneficiaryType, fullName\n❌ countryOfResidence removed"]

    GHS[GhsBeneficiary\nGhanaian Cedi]
    GHS --> GHS_R["required: beneficiaryType, fullName\n❌ countryOfResidence removed"]

    GTQ[GtqBeneficiary\nGuatemalan Quetzal]
    GTQ --> GTQ_R["required: beneficiaryType, countryOfResidence, fullName\n✅ phoneNumber added ⚠️ breaking"]

    HTG[HtgBeneficiary\nHaitian Gourde]
    HTG --> HTG_R["required: beneficiaryType, fullName\n❌ countryOfResidence removed"]

    JMD[JmdBeneficiary\nJamaican Dollar]
    JMD --> JMD_R["required: beneficiaryType, address, fullName, phoneNumber\n❌ countryOfResidence removed"]

    PKR[PkrBeneficiary\nPakistani Rupee]
    PKR --> PKR_R["required: beneficiaryType, fullName\n❌ countryOfResidence removed"]

    style GTQ fill:#ff9999
    style GTQ_R fill:#ffcccc
Loading

Fix All in Claude Code

Prompt To Fix All With AI
Fix the following 1 code review issue. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 1
openapi/components/schemas/common/GtqBeneficiary.yaml:7
**Breaking change: `phoneNumber` newly required for GTQ**

`phoneNumber` was previously optional in `GtqBeneficiary` and is now listed as a required field. Any existing client that submits a GTQ payment without `phoneNumber` will receive a validation error after this change goes live. The other five currency schemas in this PR only *remove* a required field (backwards-compatible), while this one *adds* one — which is a breaking change for consumers. Please confirm this is intentional and that downstream callers have been updated or given a migration window.

Reviews (1): Last reviewed commit: "chore: Sync account schemas" | Re-trigger Greptile

- beneficiaryType
- countryOfResidence
- fullName
- phoneNumber
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Breaking change: phoneNumber newly required for GTQ

phoneNumber was previously optional in GtqBeneficiary and is now listed as a required field. Any existing client that submits a GTQ payment without phoneNumber will receive a validation error after this change goes live. The other five currency schemas in this PR only remove a required field (backwards-compatible), while this one adds one — which is a breaking change for consumers. Please confirm this is intentional and that downstream callers have been updated or given a migration window.

Prompt To Fix With AI
This is a comment left during a code review.
Path: openapi/components/schemas/common/GtqBeneficiary.yaml
Line: 7

Comment:
**Breaking change: `phoneNumber` newly required for GTQ**

`phoneNumber` was previously optional in `GtqBeneficiary` and is now listed as a required field. Any existing client that submits a GTQ payment without `phoneNumber` will receive a validation error after this change goes live. The other five currency schemas in this PR only *remove* a required field (backwards-compatible), while this one *adds* one — which is a breaking change for consumers. Please confirm this is intentional and that downstream callers have been updated or given a migration window.

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code

@JasonCWang JasonCWang merged commit e5d3db9 into main May 1, 2026
8 checks passed
@JasonCWang JasonCWang deleted the auto/sync-grid-schemas-20260501-165225 branch May 1, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant