From 7a6e68c2b33dc8fb4de115e337fc80e44bbb73cb Mon Sep 17 00:00:00 2001 From: appscisumup Date: Wed, 17 Jun 2026 15:07:41 +0000 Subject: [PATCH 1/2] chore: synced local 'openapi.json' with remote 'specs/openapi.json' --- openapi.json | 423 ++++++++++++++++++++++++--------------------------- 1 file changed, 196 insertions(+), 227 deletions(-) diff --git a/openapi.json b/openapi.json index 0f566727..8e150357 100755 --- a/openapi.json +++ b/openapi.json @@ -7990,6 +7990,9 @@ "type": "string", "example": "44ca0f5b-813b-46e1-aee7-e6242010662e" }, + "type": { + "$ref": "#/components/schemas/UserType" + }, "email": { "description": "End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead.", "type": "string", @@ -8003,12 +8006,16 @@ "virtual_user": { "description": "True if the user is a virtual user (operator).", "type": "boolean", - "example": false + "example": false, + "deprecated": true, + "x-deprecation-notice": "Rely on `type` instead." }, "service_account_user": { "description": "True if the user is a service account.", "type": "boolean", - "example": false + "example": false, + "deprecated": true, + "x-deprecation-notice": "Rely on `type` instead." }, "disabled_at": { "description": "Time when the user has been disabled. Applies only to virtual users (`virtual_user: true`).", @@ -8032,6 +8039,7 @@ }, "required": [ "id", + "type", "email", "mfa_on_login_enabled", "virtual_user", @@ -8125,6 +8133,192 @@ "additionalProperties": true, "maxProperties": 64 }, + "UserType": { + "description": "Type of the user account.", + "type": "string", + "example": "user", + "enum": [ + "user", + "managed_user", + "service_account", + "system_account" + ] + }, + "Address": { + "description": "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`.\nWhether an address is valid or not depends on whether the locally required fields are present. Fields not supported in a country will be ignored.", + "type": "object", + "properties": { + "street_address": { + "type": "array", + "items": { + "type": "string", + "description": "The first line of the address.", + "maxLength": 100 + }, + "example": [ + "Paul-Linke-Ufer 39-40", + "2. Hinterhof" + ], + "maxItems": 2 + }, + "post_code": { + "description": "The postal code (aka. zip code) of the address.\n", + "type": "string", + "example": "10999", + "maxLength": 32 + }, + "country": { + "$ref": "#/components/schemas/CountryCode" + }, + "city": { + "description": "The city of the address.\n", + "type": "string", + "example": "Berlin", + "maxLength": 512 + }, + "province": { + "description": "The province where the address is located. This may not be relevant in some countries.\n", + "type": "string", + "example": "Berlin", + "maxLength": 512 + }, + "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 + }, + "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 + }, + "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 + }, + "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 + }, + "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 + }, + "neighborhood": { + "description": "Locality level of the address. Used in countries such as Brazil or Chile.\n", + "type": "string", + "example": "Copacabana", + "maxLength": 512 + }, + "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 + }, + "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 + }, + "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 + }, + "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 + }, + "zip_code": { + "description": "A US system of postal codes used by the United States Postal Service (USPS).\n", + "type": "string", + "example": "94103", + "maxLength": 512 + }, + "eircode": { + "description": "A postal address in Ireland.\n", + "type": "string", + "example": "D02 X285", + "maxLength": 512 + } + }, + "example": { + "street_address": [ + "Paul-Linke-Ufer 39-40", + "2. Hinterhof" + ], + "post_code": "10999", + "city": "Berlin", + "country": "DE" + }, + "externalDocs": { + "description": "Address documentation", + "url": "https://backstage.sumup.net/docs/default/Component/merchants/merchant/#addresses" + }, + "required": [ + "country" + ] + }, + "CountryCode": { + "description": "An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)\ncountry code. This definition users `oneOf` with a two-character string\ntype to allow for support of future countries in client code.", + "type": "string", + "example": "BR", + "maxLength": 2, + "minLength": 2, + "pattern": "^[A-Z]{2}$" + }, + "PersonalIdentifiers": { + "description": "A list of country-specific personal identifiers.", + "type": "array", + "items": { + "$ref": "#/components/schemas/PersonalIdentifier" + }, + "example": [ + { + "ref": "br.cpf", + "value": "847.060.136-90" + } + ], + "maxItems": 32 + }, + "PersonalIdentifier": { + "type": "object", + "properties": { + "ref": { + "description": "The unique reference for the personal identifier type.", + "type": "string", + "example": "br.cpf", + "maxLength": 32 + }, + "value": { + "description": "The company identifier value.", + "type": "string", + "example": "847.060.136-90", + "maxLength": 128 + } + }, + "example": { + "ref": "br.cpf", + "value": "847.060.136-90" + }, + "required": [ + "ref", + "value" + ] + }, "ListPersonsResponseBody": { "type": "object", "properties": { @@ -8285,199 +8479,12 @@ } ] }, - "CountryCode": { - "description": "An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This definition users `oneOf` with a two-character string type to allow for support of future countries in client code.\n", - "type": "string", - "examples": [ - "AR", - "AT", - "AU", - "BE", - "BG", - "BR", - "CH", - "CL", - "CO", - "CY", - "CZ", - "DE", - "DK", - "EE", - "ES", - "FI", - "FR", - "GB", - "GR", - "HU", - "IE", - "IT", - "LT", - "LU", - "LV", - "MT", - "MX", - "NL", - "NO", - "PE", - "PL", - "PT", - "RO", - "SE", - "SI", - "SK", - "US" - ], - "maxLength": 2, - "minLength": 2 - }, "PhoneNumber": { "description": "A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.\n", "type": "string", "example": "+420123456789", "maxLength": 16 }, - "Address": { - "description": "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`.\nWhether an address is valid or not depends on whether the locally required fields are present. Fields not supported in a country will be ignored.", - "type": "object", - "properties": { - "street_address": { - "type": "array", - "items": { - "type": "string", - "description": "The first line of the address.", - "maxLength": 100 - }, - "example": [ - "Paul-Linke-Ufer 39-40", - "2. Hinterhof" - ], - "maxItems": 2, - "minItems": 1 - }, - "post_code": { - "description": "The postal code (aka. zip code) of the address.\n", - "type": "string", - "example": "10999", - "maxLength": 10 - }, - "country": { - "$ref": "#/components/schemas/CountryCode" - }, - "city": { - "description": "The city of the address.\n", - "type": "string", - "example": "Berlin", - "maxLength": 60 - }, - "province": { - "description": "The province where the address is located. This may not be relevant in some countries.\n", - "type": "string", - "example": "Ontario", - "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": 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", - "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": 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": 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": 60 - }, - "neighborhood": { - "description": "Locality level of the address. Used in countries such as Brazil or Chile.\n", - "type": "string", - "example": "Copacabana", - "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": 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": 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": "Medellin", - "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", - "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": 10 - }, - "eircode": { - "description": "A postal address in Ireland.\n", - "type": "string", - "example": "D02 X285", - "maxLength": 10 - } - }, - "examples": [ - { - "street_address": [ - "Paul-Linke-Ufer 39-40", - "2. Hinterhof" - ], - "post_code": "10999", - "city": "Berlin", - "country": "DE" - }, - { - "street_address": [ - "156 Avenida Vida Nova", - "Apto 2" - ], - "city": "Taboão da Serra", - "post_code": "06764045", - "state": "SP", - "neighborhood": "Jardim Maria Rosa", - "country": "BR" - } - ], - "externalDocs": { - "description": "Address documentation", - "url": "https://developer.sumup.com/tools/glossary/merchant#addresses" - }, - "required": [ - "country" - ] - }, "Branding": { "description": "Settings used to apply the Merchant's branding to email receipts, invoices, checkouts, and other products.", "type": "object", @@ -8617,14 +8624,6 @@ "share" ] }, - "PersonalIdentifiers": { - "description": "A list of country-specific personal identifiers.\n", - "type": "array", - "items": { - "$ref": "#/components/schemas/PersonalIdentifier" - }, - "maxItems": 5 - }, "Version": { "description": "The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH` endpoints.\n", "type": "string", @@ -8737,36 +8736,6 @@ "id" ] }, - "PersonalIdentifier": { - "type": "object", - "properties": { - "ref": { - "description": "The unique reference for the personal identifier type as defined in the country SDK.\n", - "type": "string", - "examples": [ - "br.cpf" - ] - }, - "value": { - "description": "The value of the personal identifier.\n", - "type": "string", - "examples": [ - "847.060.136-90" - ], - "maxLength": 30 - } - }, - "examples": [ - { - "ref": "br.cpf", - "value": "847.060.136-90" - } - ], - "required": [ - "ref", - "value" - ] - }, "Company": { "description": "Information about the company or business. This is legal information that is used for verification.\n", "type": "object", From d2734e1ee99065c56a767dbe0c5cd1b0d36cabe1 Mon Sep 17 00:00:00 2001 From: appscisumup Date: Wed, 17 Jun 2026 15:07:41 +0000 Subject: [PATCH 2/2] chore: synced local 'openapi.yaml' with remote 'specs/openapi.yaml' --- openapi.yaml | 376 ++++++++++++++++++++++++--------------------------- 1 file changed, 174 insertions(+), 202 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 243b58c7..8b6b9f31 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -5701,6 +5701,8 @@ components: description: Identifier for the End-User (also called Subject). type: string example: 44ca0f5b-813b-46e1-aee7-e6242010662e + type: + $ref: '#/components/schemas/UserType' email: description: End-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, for unique identification use ID instead. type: string @@ -5713,10 +5715,14 @@ components: description: True if the user is a virtual user (operator). type: boolean example: false + deprecated: true + x-deprecation-notice: Rely on `type` instead. service_account_user: description: True if the user is a service account. type: boolean example: false + deprecated: true + x-deprecation-notice: Rely on `type` instead. disabled_at: description: 'Time when the user has been disabled. Applies only to virtual users (`virtual_user: true`).' type: string @@ -5734,6 +5740,7 @@ components: $ref: '#/components/schemas/MembershipUserClassic' required: - id + - type - email - mfa_on_login_enabled - virtual_user @@ -5807,6 +5814,173 @@ components: example: {} additionalProperties: true maxProperties: 64 + UserType: + description: Type of the user account. + type: string + example: user + enum: + - user + - managed_user + - service_account + - system_account + Address: + description: |- + 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. + type: object + properties: + street_address: + type: array + items: + type: string + description: The first line of the address. + maxLength: 100 + example: + - Paul-Linke-Ufer 39-40 + - 2. Hinterhof + maxItems: 2 + post_code: + description: | + The postal code (aka. zip code) of the address. + type: string + example: '10999' + maxLength: 32 + country: + $ref: '#/components/schemas/CountryCode' + city: + description: | + The city of the address. + type: string + example: Berlin + maxLength: 512 + province: + description: | + The province where the address is located. This may not be relevant in some countries. + type: string + example: Berlin + maxLength: 512 + region: + description: | + The region where the address is located. This may not be relevant in some countries. + type: string + example: Baden Wuerttemberg + maxLength: 512 + 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. + type: string + example: Dublin County + maxLength: 512 + autonomous_community: + description: | + In Spain, an autonomous community is the first sub-national level of political and administrative division. + type: string + example: Catalonia + maxLength: 512 + 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. + type: string + example: London + maxLength: 512 + 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. + type: string + example: California + maxLength: 512 + neighborhood: + description: | + Locality level of the address. Used in countries such as Brazil or Chile. + type: string + example: Copacabana + maxLength: 512 + 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. + type: string + example: Providencia + maxLength: 512 + department: + description: | + A department (French: département, Spanish: departamento) is an administrative or political division in several countries. Used in countries such as Colombia. + type: string + example: Antioquia + maxLength: 512 + 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. + type: string + example: Medellín + maxLength: 512 + 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. + type: string + example: Lisbon District + maxLength: 512 + zip_code: + description: | + A US system of postal codes used by the United States Postal Service (USPS). + type: string + example: '94103' + maxLength: 512 + eircode: + description: | + A postal address in Ireland. + type: string + example: D02 X285 + maxLength: 512 + example: + street_address: + - Paul-Linke-Ufer 39-40 + - 2. Hinterhof + post_code: '10999' + city: Berlin + country: DE + externalDocs: + description: Address documentation + url: https://backstage.sumup.net/docs/default/Component/merchants/merchant/#addresses + required: + - country + CountryCode: + description: |- + An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) + country code. This definition users `oneOf` with a two-character string + type to allow for support of future countries in client code. + type: string + example: BR + maxLength: 2 + minLength: 2 + pattern: ^[A-Z]{2}$ + PersonalIdentifiers: + description: A list of country-specific personal identifiers. + type: array + items: + $ref: '#/components/schemas/PersonalIdentifier' + example: + - ref: br.cpf + value: 847.060.136-90 + maxItems: 32 + PersonalIdentifier: + type: object + properties: + ref: + description: The unique reference for the personal identifier type. + type: string + example: br.cpf + maxLength: 32 + value: + description: The company identifier value. + type: string + example: 847.060.136-90 + maxLength: 128 + example: + ref: br.cpf + value: 847.060.136-90 + required: + - ref + - value ListPersonsResponseBody: type: object properties: @@ -5940,185 +6114,12 @@ components: Person: allOf: - $ref: '#/components/schemas/BasePerson' - CountryCode: - description: | - An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code. This definition users `oneOf` with a two-character string type to allow for support of future countries in client code. - type: string - examples: - - AR - - AT - - AU - - BE - - BG - - BR - - CH - - CL - - CO - - CY - - CZ - - DE - - DK - - EE - - ES - - FI - - FR - - GB - - GR - - HU - - IE - - IT - - LT - - LU - - LV - - MT - - MX - - NL - - NO - - PE - - PL - - PT - - RO - - SE - - SI - - SK - - US - maxLength: 2 - minLength: 2 PhoneNumber: description: | A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format. type: string example: '+420123456789' maxLength: 16 - Address: - description: |- - 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. - type: object - properties: - street_address: - type: array - items: - type: string - description: The first line of the address. - maxLength: 100 - example: - - Paul-Linke-Ufer 39-40 - - 2. Hinterhof - maxItems: 2 - minItems: 1 - post_code: - description: | - The postal code (aka. zip code) of the address. - type: string - example: '10999' - maxLength: 10 - country: - $ref: '#/components/schemas/CountryCode' - city: - description: | - The city of the address. - type: string - example: Berlin - maxLength: 60 - province: - description: | - The province where the address is located. This may not be relevant in some countries. - type: string - example: Ontario - maxLength: 60 - region: - description: | - The region where the address is located. This may not be relevant in some countries. - type: string - example: Baden-Wuerttemberg - 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. - type: string - example: Dublin - maxLength: 60 - autonomous_community: - description: | - In Spain, an autonomous community is the first sub-national level of political and administrative division. - type: string - example: Catalonia - 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. - type: string - example: London - 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. - type: string - example: California - maxLength: 60 - neighborhood: - description: | - Locality level of the address. Used in countries such as Brazil or Chile. - type: string - example: Copacabana - 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. - type: string - example: Providencia - 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. - type: string - example: Antioquia - 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. - type: string - example: Medellin - 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. - type: string - example: Lisbon - maxLength: 60 - zip_code: - description: | - A US system of postal codes used by the United States Postal Service (USPS). - type: string - example: '94103' - maxLength: 10 - eircode: - description: | - A postal address in Ireland. - type: string - example: D02 X285 - maxLength: 10 - examples: - - street_address: - - Paul-Linke-Ufer 39-40 - - 2. Hinterhof - post_code: '10999' - city: Berlin - country: DE - - street_address: - - 156 Avenida Vida Nova - - Apto 2 - city: Taboão da Serra - post_code: '06764045' - state: SP - neighborhood: Jardim Maria Rosa - country: BR - externalDocs: - description: Address documentation - url: https://developer.sumup.com/tools/glossary/merchant#addresses - required: - - country Branding: description: Settings used to apply the Merchant's branding to email receipts, invoices, checkouts, and other products. type: object @@ -6236,13 +6237,6 @@ components: minimum: 25000 required: - share - PersonalIdentifiers: - description: | - A list of country-specific personal identifiers. - type: array - items: - $ref: '#/components/schemas/PersonalIdentifier' - maxItems: 5 Version: description: | The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH` endpoints. @@ -6342,28 +6336,6 @@ components: url: https://developer.sumup.com/tools/glossary/merchant#persons required: - id - PersonalIdentifier: - type: object - properties: - ref: - description: | - The unique reference for the personal identifier type as defined in the country SDK. - type: string - examples: - - br.cpf - value: - description: | - The value of the personal identifier. - type: string - examples: - - 847.060.136-90 - maxLength: 30 - examples: - - ref: br.cpf - value: 847.060.136-90 - required: - - ref - - value Company: description: | Information about the company or business. This is legal information that is used for verification.