Document customer billing address on customer schema (API v2.2.1)#10
Draft
acallaghan wants to merge 2 commits into
Draft
Document customer billing address on customer schema (API v2.2.1)#10acallaghan wants to merge 2 commits into
acallaghan wants to merge 2 commits into
Conversation
Add a `customer_billing_address` schema and reference it from the
`customer` schema's new `address` property. The API already returns this
object on GET /customers, GET /customers/{id}, and the customer.created /
customer.updated webhooks; this documents it. Includes company,
address_1, address_2, town, state, postcode, country (ISO 3166-1
alpha-2) and a formatted_address convenience string, and adds it to the
customer example. Bump spec version to 2.2.1.
https://claude.ai/code/session_01RwYPyNgFzwDxnJLX4gPCde
Deploying api with
|
| Latest commit: |
3bd2be2
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://f81131a2.api-dwa.pages.dev |
| Branch Preview URL: | https://claude-great-ptolemy-96rmw.api-dwa.pages.dev |
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.
What
Documents the customer billing
addressobject in the OpenAPI spec. The API already returns this object (viaSvixEvents::CustomerSerializer), but it was undocumented.Changes
customer_billing_addressschema with:company,address_1,address_2,town,state,postcode,country(ISO 3166-1 alpha-2) and aformatted_addressconvenience string (full address as a single comma-separated line, country name expanded).addressproperty (referencing the new schema) to thecustomerschema. It isnullwhen the customer has no billing address.addressblock to thecustomer_example.info.version2.2.0 → 2.2.1 and added a changelog entry.This applies to
GET /customers,GET /customers/{id}, and thecustomer.created/customer.updatedwebhooks. No breaking changes — it documents an existing response field.Notes
v2/jammed-postman-collection.json) is regenerated automatically by the Update Postman Collection Action on push toclaude/**, so it isn't hand-edited here. I verifiedopenapi2postmanv2converts the updated spec cleanly.jammed-org/zapierchange that surfaces the billing address in the Zapier integration output.Testing
python3 -c "import yaml; yaml.safe_load(...)"— spec parses;customer.addressandcustomer_billing_addressresolve correctly.openapi2postmanv2 -s v2/jammed.yaml— conversion successful.https://claude.ai/code/session_01RwYPyNgFzwDxnJLX4gPCde
Generated by Claude Code
Note
Low Risk
Documentation-only OpenAPI and changelog updates; no API behavior changes.
Overview
Documents the customer
addressfield in OpenAPI for API v2.2.1, matching payloads the API already returns on customer list/detail andcustomer.created/customer.updatedwebhooks.Adds a reusable
customer_billing_addressschema (company, address lines, town, state, postcode, ISO country code, andformatted_address) and wiresaddresson thecustomerschema (nullable when unset), plus an example oncustomer_example.info.versionmoves to 2.2.1 with a matchingchangelog.mdentry. No runtime or contract change—spec-only documentation.Reviewed by Cursor Bugbot for commit 3bd2be2. Bugbot is set up for automated code reviews on this repo. Configure here.