Skip to content

docs: mark customer email/phoneNumber conditionally required#749

Merged
jklein24 merged 1 commit into
mainfrom
07-26-AT-5971-customer-contact-fields-conditionally-required
Jul 27, 2026
Merged

docs: mark customer email/phoneNumber conditionally required#749
jklein24 merged 1 commit into
mainfrom
07-26-AT-5971-customer-contact-fields-conditionally-required

Conversation

@jklein24

Copy link
Copy Markdown
Contributor

Summary

CustomerCreateRequest lists email and phoneNumber as flatly optional, but a customer in a region that verifies a contact channel before identity verification cannot be created without that channel's value — POST /customers rejects the request with INVALID_INPUT. The spec gave integrators no way to know that, so an EU onboarding that omits phoneNumber fails against a contract that says it's optional.

Documents the conditional requirement on both fields, as a region requirement.

Changes

  • openapi/components/schemas/customers/CustomerCreateRequest.yaml — expanded email and phoneNumber descriptions
  • openapi.yaml, mintlify/openapi.yaml — rebundled via make build

Description-only: no schema shape, type, or requirement-list change, so generated clients are unaffected and no version bump is needed. make lint-openapi passes (0 errors).

Requested by @jklein24

Original PR: #748

Both fields are optional on CustomerCreateRequest, but a customer whose
payment provider verifies a contact channel before identity verification
cannot be created without that channel's value — the request is rejected
with INVALID_INPUT. Say so on the fields, matching the wording already
used for the provider-conditional contactVerification object.

Co-Authored-By: jklein24 <[email protected]>
@vercel

vercel Bot commented Jul 26, 2026

Copy link
Copy Markdown

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

2 Skipped Deployments
Project Deployment Actions Updated (UTC)
grid-flow-builder Ignored Ignored Jul 26, 2026 9:57pm
grid-wallet-demo Ignored Ignored Jul 26, 2026 9:57pm

Request Review

akanter commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions

github-actions Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

✱ Stainless preview builds for grid

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

cli

chore(internal): regenerate SDK with no functional changes

go

docs(api): clarify email and phone requirements in customer create parameters

kotlin

docs(api): document regional requirements for email/phoneNumber in customers

openapi

docs(api): clarify regional requirements for customer email/phoneNumber

php

docs(api): update email and phoneNumber descriptions in customer create requests

python

docs(api): clarify regional requirements for email/phone in customer create params

ruby

docs(api): update email/phone_number descriptions in customer create requests

typescript

docs(api): clarify regional requirements for email/phoneNumber in customer requests
⚠️ grid-openapi studio · code

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

grid-ruby studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅build ✅lint ✅test ✅

⚠️ grid-go 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 ❗

go get github.com/stainless-sdks/grid-go@e67215503858fd86637711c546a465edaa72de55
⚠️ grid-kotlin studio · code

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

⚠️ grid-python 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 ❗

pip install https://pkg.stainless.com/s/grid-python/a85a00c8e94a611bdb9c63d5f664bba5faf97ff6/grid-0.0.1-py3-none-any.whl
grid-typescript studio · conflict

Your SDK build had at least one note diagnostic.

grid-php studio · code

Your SDK build had at least one "note" diagnostic.
generate ✅lint ✅test ✅

⚠️ grid-cli studio · code

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


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-07-27 01:00:29 UTC

@jklein24
jklein24 requested a review from shreyav July 26, 2026 22:08
@jklein24
jklein24 marked this pull request as ready for review July 26, 2026 22:08
@greptile-apps

greptile-apps Bot commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

        .       .
       / \m/ \m/ \
      |  (◉) (◉)  |
      |     V     |
       \  \___/  /
    ____\_______/____
   /____ GRID OR DIE _\
        /_|   |_\

⚡ CONDITIONAL CONTACTS, ETERNAL RIFFS ⚡

Clarifies the customer-creation contract:

  • Documents when email is conditionally required by regional verification rules.
  • Documents the equivalent conditional requirement for phoneNumber.
  • Regenerates both committed OpenAPI bundles from the source schema.

Confidence Score: 5/5

The PR appears safe to merge; the source schema and both generated bundles consistently document the conditional contact requirements.

The changes affect descriptions only, accurately preserve the existing schema shape, and keep both generated OpenAPI artifacts synchronized with the source.

Important Files Changed

Filename Overview
openapi/components/schemas/customers/CustomerCreateRequest.yaml Clarifies the region-dependent email and phone-number requirements without changing the request schema.
openapi.yaml Correctly carries the source description changes into the generated root bundle.
mintlify/openapi.yaml Remains synchronized with the generated root OpenAPI bundle.

Reviews (1): Last reviewed commit: "docs: mark customer email/phoneNumber co..." | Re-trigger Greptile

@jklein24
jklein24 merged commit c740ceb into main Jul 27, 2026
18 checks passed
@jklein24
jklein24 deleted the 07-26-AT-5971-customer-contact-fields-conditionally-required branch July 27, 2026 00:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants