Skip to content

chore: synced file(s) with sumup/apis #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
matoous merged 2 commits into from
Jun 18, 2026
Merged

chore: synced file(s) with sumup/apis #385

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49afe6c
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
Jun 18, 2026
df6d09d
chore: generate code
sumup-release-bot[bot] Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8181,7 +8181,7 @@
"description": "The postal code (aka. zip code) of the address.\n",
"type": "string",
"example": "10999",
"maxLength": 32
"maxLength": 10
},
"country": {
"$ref": "#/components/schemas/CountryCode"
Expand All @@ -8190,85 +8190,85 @@
"description": "The city of the address.\n",
"type": "string",
"example": "Berlin",
"maxLength": 512
"maxLength": 60
},
"province": {
"description": "The province where the address is located. This may not be relevant in some countries.\n",
"type": "string",
"example": "Berlin",
"maxLength": 512
"maxLength": 60
},
"region": {
"description": "The region where the address is located. This may not be relevant in some countries.\n",
"type": "string",
"example": "Baden Wuerttemberg",
"maxLength": 512
"maxLength": 60
},
"county": {
"description": "A county is a geographic region of a country used for administrative or other purposes in some nations. Used in countries such as Ireland, Romania, etc.\n",
"type": "string",
"example": "Dublin County",
"maxLength": 512
"maxLength": 60
},
"autonomous_community": {
"description": "In Spain, an autonomous community is the first sub-national level of political and administrative division.\n",
"type": "string",
"example": "Catalonia",
"maxLength": 512
"maxLength": 60
},
"post_town": {
"description": "A post town is a required part of all postal addresses in the United Kingdom and Ireland, and a basic unit of the postal delivery system.\n",
"type": "string",
"example": "London",
"maxLength": 512
"maxLength": 60
},
"state": {
"description": "Most often, a country has a single state, with various administrative divisions. The term \"state\" is sometimes used to refer to the federated polities that make up the federation. Used in countries such as the United States and Brazil.\n",
"type": "string",
"example": "California",
"maxLength": 512
"maxLength": 60
},
"neighborhood": {
"description": "Locality level of the address. Used in countries such as Brazil or Chile.\n",
"type": "string",
"example": "Copacabana",
"maxLength": 512
"maxLength": 60
},
"commune": {
"description": "In many countries, terms cognate with \"commune\" are used, referring to the community living in the area and the common interest. Used in countries such as Chile.\n",
"type": "string",
"example": "Providencia",
"maxLength": 512
"maxLength": 60
},
"department": {
"description": "A department (French: département, Spanish: departamento) is an administrative or political division in several countries. Used in countries such as Colombia.\n",
"type": "string",
"example": "Antioquia",
"maxLength": 512
"maxLength": 60
},
"municipality": {
"description": "A municipality is usually a single administrative division having corporate status and powers of self-government or jurisdiction as granted by national and regional laws to which it is subordinate. Used in countries such as Colombia.\n",
"type": "string",
"example": "Medellín",
"maxLength": 512
"maxLength": 60
},
"district": {
"description": "A district is a type of administrative division that in some countries is managed by the local government. Used in countries such as Portugal.\n",
"type": "string",
"example": "Lisbon District",
"maxLength": 512
"maxLength": 60
},
"zip_code": {
"description": "A US system of postal codes used by the United States Postal Service (USPS).\n",
"type": "string",
"example": "94103",
"maxLength": 512
"maxLength": 10
},
"eircode": {
"description": "A postal address in Ireland.\n",
"type": "string",
"example": "D02 X285",
"maxLength": 512
"maxLength": 10
}
},
"example": {
Expand All @@ -8282,7 +8282,7 @@
},
"externalDocs": {
"description": "Address documentation",
"url": "https://backstage.sumup.net/docs/default/Component/merchants/merchant/#addresses"
"url": "https://developer.sumup.com/tools/glossary/address"
},
"required": [
"country"
Expand Down
2 changes: 1 addition & 1 deletion sdk/src/types/address.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import type { CountryCode } from "./country-code";
* An address somewhere in the world. The address fields used depend on the country conventions. For example, in Great Britain, `city` is `post_town`. In the United States, the top-level administrative unit used in addresses is `state`, whereas in Chile it's `region`.
* Whether an address is valid or not depends on whether the locally required fields are present. Fields not supported in a country will be ignored.
*
* Address documentation: https://backstage.sumup.net/docs/default/Component/merchants/merchant/#addresses
* Address documentation: https://developer.sumup.com/tools/glossary/address
*/
export type Address = {
street_address?: string[];
Expand Down
Loading