Skip to content

Commit 65409ad

Browse files
appscisumupappscisumup
authored
chore: synced file(s) with sumup/apis (#374)
1 parent 21e53d5 commit 65409ad

8 files changed

Lines changed: 104 additions & 98 deletions

File tree

‎openapi.json‎

Lines changed: 88 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -3436,7 +3436,7 @@
34363436
"type": "object",
34373437
"properties": {
34383438
"nickname": {
3439-
"description": "User's preferred name. Used for display purposes only.",
3439+
"description": "User's nickname. Used for display purposes only.",
34403440
"type": "string",
34413441
"example": "Test User"
34423442
},
@@ -8016,7 +8016,7 @@
80168016
"format": "date-time"
80178017
},
80188018
"nickname": {
8019-
"description": "User's preferred name. Used for display purposes only.",
8019+
"description": "User's nickname. Used for display purposes only.",
80208020
"type": "string",
80218021
"example": "Test User"
80228022
},
@@ -8226,57 +8226,6 @@
82268226
},
82278227
"title": "Merchant"
82288228
},
8229-
"Company": {
8230-
"description": "Information about the company or business. This is legal information that is used for verification.\n",
8231-
"type": "object",
8232-
"properties": {
8233-
"name": {
8234-
"description": "The company's legal name.",
8235-
"type": "string",
8236-
"example": "Gin & Doughnuts Bar GmbH",
8237-
"maxLength": 150,
8238-
"minLength": 1
8239-
},
8240-
"merchant_category_code": {
8241-
"description": "The merchant category code for the account as specified by [ISO18245](https://www.iso.org/standard/33365.html). MCCs are used to classify businesses based on the goods or services they provide.\n",
8242-
"type": "string",
8243-
"example": "1532",
8244-
"pattern": "^[0-9]{4}$"
8245-
},
8246-
"legal_type": {
8247-
"$ref": "#/components/schemas/LegalType"
8248-
},
8249-
"address": {
8250-
"$ref": "#/components/schemas/Address"
8251-
},
8252-
"trading_address": {
8253-
"$ref": "#/components/schemas/Address"
8254-
},
8255-
"identifiers": {
8256-
"$ref": "#/components/schemas/CompanyIdentifiers"
8257-
},
8258-
"phone_number": {
8259-
"$ref": "#/components/schemas/PhoneNumber"
8260-
},
8261-
"website": {
8262-
"description": "HTTP(S) URL of the company's website.\n",
8263-
"type": "string",
8264-
"format": "uri",
8265-
"examples": [
8266-
"https://www.sumup.com"
8267-
],
8268-
"maxLength": 255,
8269-
"nullable": true
8270-
},
8271-
"attributes": {
8272-
"$ref": "#/components/schemas/Attributes"
8273-
}
8274-
},
8275-
"externalDocs": {
8276-
"description": "Company documentation",
8277-
"url": "https://developer.sumup.com/tools/glossary/merchant#company"
8278-
}
8279-
},
82808229
"Meta": {
82818230
"description": "A set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.\n\n**Warning**: Updating Meta will overwrite the existing data. Make sure to always include the complete JSON object.",
82828231
"type": "object",
@@ -8308,7 +8257,6 @@
83088257
"website": {
83098258
"description": "The business's publicly available website.",
83108259
"type": "string",
8311-
"format": "uri",
83128260
"example": "https://example.com",
83138261
"maxLength": 255
83148262
},
@@ -8668,35 +8616,13 @@
86688616
"share"
86698617
]
86708618
},
8671-
"PersonalIdentifier": {
8672-
"type": "object",
8673-
"properties": {
8674-
"ref": {
8675-
"description": "The unique reference for the personal identifier type as defined in the country SDK.\n",
8676-
"type": "string",
8677-
"examples": [
8678-
"br.cpf"
8679-
]
8680-
},
8681-
"value": {
8682-
"description": "The company identifier value.\n",
8683-
"type": "string",
8684-
"examples": [
8685-
"847.060.136-90"
8686-
],
8687-
"maxLength": 30
8688-
}
8619+
"PersonalIdentifiers": {
8620+
"description": "A list of country-specific personal identifiers.\n",
8621+
"type": "array",
8622+
"items": {
8623+
"$ref": "#/components/schemas/PersonalIdentifier"
86898624
},
8690-
"examples": [
8691-
{
8692-
"ref": "br.cpf",
8693-
"value": "847.060.136-90"
8694-
}
8695-
],
8696-
"required": [
8697-
"ref",
8698-
"value"
8699-
]
8625+
"maxItems": 5
87008626
},
87018627
"Version": {
87028628
"description": "The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH` endpoints.\n",
@@ -8778,12 +8704,7 @@
87788704
"$ref": "#/components/schemas/Address"
87798705
},
87808706
"identifiers": {
8781-
"description": "A list of country-specific personal identifiers.\n",
8782-
"type": "array",
8783-
"items": {
8784-
"$ref": "#/components/schemas/PersonalIdentifier"
8785-
},
8786-
"maxItems": 5
8707+
"$ref": "#/components/schemas/PersonalIdentifiers"
87878708
},
87888709
"citizenship": {
87898710
"$ref": "#/components/schemas/CountryCode"
@@ -8815,6 +8736,85 @@
88158736
"id"
88168737
]
88178738
},
8739+
"PersonalIdentifier": {
8740+
"type": "object",
8741+
"properties": {
8742+
"ref": {
8743+
"description": "The unique reference for the personal identifier type as defined in the country SDK.\n",
8744+
"type": "string",
8745+
"examples": [
8746+
"br.cpf"
8747+
]
8748+
},
8749+
"value": {
8750+
"description": "The value of the personal identifier.\n",
8751+
"type": "string",
8752+
"examples": [
8753+
"847.060.136-90"
8754+
],
8755+
"maxLength": 30
8756+
}
8757+
},
8758+
"examples": [
8759+
{
8760+
"ref": "br.cpf",
8761+
"value": "847.060.136-90"
8762+
}
8763+
],
8764+
"required": [
8765+
"ref",
8766+
"value"
8767+
]
8768+
},
8769+
"Company": {
8770+
"description": "Information about the company or business. This is legal information that is used for verification.\n",
8771+
"type": "object",
8772+
"properties": {
8773+
"name": {
8774+
"description": "The company's legal name.",
8775+
"type": "string",
8776+
"example": "Gin & Doughnuts Bar GmbH",
8777+
"maxLength": 150,
8778+
"minLength": 1
8779+
},
8780+
"merchant_category_code": {
8781+
"description": "The merchant category code for the account as specified by [ISO18245](https://www.iso.org/standard/33365.html). MCCs are used to classify businesses based on the goods or services they provide.\n",
8782+
"type": "string",
8783+
"example": "1532",
8784+
"pattern": "^[0-9]{4}$"
8785+
},
8786+
"legal_type": {
8787+
"$ref": "#/components/schemas/LegalType"
8788+
},
8789+
"address": {
8790+
"$ref": "#/components/schemas/Address"
8791+
},
8792+
"trading_address": {
8793+
"$ref": "#/components/schemas/Address"
8794+
},
8795+
"identifiers": {
8796+
"$ref": "#/components/schemas/CompanyIdentifiers"
8797+
},
8798+
"phone_number": {
8799+
"$ref": "#/components/schemas/PhoneNumber"
8800+
},
8801+
"website": {
8802+
"description": "HTTP(S) URL of the company's website.\n",
8803+
"type": "string",
8804+
"examples": [
8805+
"https://www.sumup.com"
8806+
],
8807+
"maxLength": 255
8808+
},
8809+
"attributes": {
8810+
"$ref": "#/components/schemas/Attributes"
8811+
}
8812+
},
8813+
"externalDocs": {
8814+
"description": "Company documentation",
8815+
"url": "https://developer.sumup.com/tools/glossary/merchant#company"
8816+
}
8817+
},
88188818
"ClassicMerchantIdentifiers": {
88198819
"type": "object",
88208820
"properties": {

‎sdk/src/resources/members/index.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export type UpdateMerchantMemberParams = {
6060
*/
6161
user?: {
6262
/**
63-
* User's preferred name. Used for display purposes only.
63+
* User's nickname. Used for display purposes only.
6464
*/
6565
nickname?: string;
6666
/**

‎sdk/src/types/base-person.ts‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import type { Address } from "./address";
44
import type { ChangeStatus } from "./change-status";
55
import type { CountryCode } from "./country-code";
66
import type { Ownership } from "./ownership";
7-
import type { PersonalIdentifier } from "./personal-identifier";
7+
import type { PersonalIdentifiers } from "./personal-identifiers";
88
import type { PhoneNumber } from "./phone-number";
99
import type { Version } from "./version";
1010

@@ -51,11 +51,7 @@ export type BasePerson = {
5151
relationships?: string[];
5252
ownership?: Ownership;
5353
address?: Address;
54-
/**
55-
* A list of country-specific personal identifiers.
56-
*
57-
*/
58-
identifiers?: PersonalIdentifier[];
54+
identifiers?: PersonalIdentifiers;
5955
citizenship?: CountryCode;
6056
/**
6157
* The persons nationality. May be an [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code, but legacy data may not conform to this standard.

‎sdk/src/types/company.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,6 @@ export type Company = {
3131
* HTTP(S) URL of the company's website.
3232
*
3333
*/
34-
website?: string | null;
34+
website?: string;
3535
attributes?: Attributes;
3636
};

‎sdk/src/types/index.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,7 @@ export type { PaymentType } from "./payment-type";
6767
export type { Person } from "./person";
6868
export type { PersonalDetails } from "./personal-details";
6969
export type { PersonalIdentifier } from "./personal-identifier";
70+
export type { PersonalIdentifiers } from "./personal-identifiers";
7071
export type { PhoneNumber } from "./phone-number";
7172
export type { Problem } from "./problem";
7273
export type { ProcessCheckout } from "./process-checkout";

‎sdk/src/types/membership-user.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ export type MembershipUser = {
3131
*/
3232
disabled_at?: string;
3333
/**
34-
* User's preferred name. Used for display purposes only.
34+
* User's nickname. Used for display purposes only.
3535
*/
3636
nickname?: string;
3737
/**

‎sdk/src/types/personal-identifier.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export type PersonalIdentifier = {
77
*/
88
ref: string;
99
/**
10-
* The company identifier value.
10+
* The value of the personal identifier.
1111
*
1212
*/
1313
value: string;

‎sdk/src/types/personal-identifiers.ts‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
// Code generated by @sumup/sumup-ts-codegen. DO NOT EDIT.
2+
3+
import type { PersonalIdentifier } from "./personal-identifier";
4+
5+
/**
6+
* A list of country-specific personal identifiers.
7+
*
8+
*/
9+
export type PersonalIdentifiers = PersonalIdentifier[];

0 commit comments

Comments
 (0)