Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
176 changes: 88 additions & 88 deletions openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -3436,7 +3436,7 @@
"type": "object",
"properties": {
"nickname": {
"description": "User's preferred name. Used for display purposes only.",
"description": "User's nickname. Used for display purposes only.",
"type": "string",
"example": "Test User"
},
Expand Down Expand Up @@ -8016,7 +8016,7 @@
"format": "date-time"
},
"nickname": {
"description": "User's preferred name. Used for display purposes only.",
"description": "User's nickname. Used for display purposes only.",
"type": "string",
"example": "Test User"
},
Expand Down Expand Up @@ -8226,57 +8226,6 @@
},
"title": "Merchant"
},
"Company": {
"description": "Information about the company or business. This is legal information that is used for verification.\n",
"type": "object",
"properties": {
"name": {
"description": "The company's legal name.",
"type": "string",
"example": "Gin & Doughnuts Bar GmbH",
"maxLength": 150,
"minLength": 1
},
"merchant_category_code": {
"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",
"type": "string",
"example": "1532",
"pattern": "^[0-9]{4}$"
},
"legal_type": {
"$ref": "#/components/schemas/LegalType"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"trading_address": {
"$ref": "#/components/schemas/Address"
},
"identifiers": {
"$ref": "#/components/schemas/CompanyIdentifiers"
},
"phone_number": {
"$ref": "#/components/schemas/PhoneNumber"
},
"website": {
"description": "HTTP(S) URL of the company's website.\n",
"type": "string",
"format": "uri",
"examples": [
"https://www.sumup.com"
],
"maxLength": 255,
"nullable": true
},
"attributes": {
"$ref": "#/components/schemas/Attributes"
}
},
"externalDocs": {
"description": "Company documentation",
"url": "https://developer.sumup.com/tools/glossary/merchant#company"
}
},
"Meta": {
"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.",
"type": "object",
Expand Down Expand Up @@ -8308,7 +8257,6 @@
"website": {
"description": "The business's publicly available website.",
"type": "string",
"format": "uri",
"example": "https://example.com",
"maxLength": 255
},
Expand Down Expand Up @@ -8668,35 +8616,13 @@
"share"
]
},
"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 company identifier value.\n",
"type": "string",
"examples": [
"847.060.136-90"
],
"maxLength": 30
}
"PersonalIdentifiers": {
"description": "A list of country-specific personal identifiers.\n",
"type": "array",
"items": {
"$ref": "#/components/schemas/PersonalIdentifier"
},
"examples": [
{
"ref": "br.cpf",
"value": "847.060.136-90"
}
],
"required": [
"ref",
"value"
]
"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",
Expand Down Expand Up @@ -8778,12 +8704,7 @@
"$ref": "#/components/schemas/Address"
},
"identifiers": {
"description": "A list of country-specific personal identifiers.\n",
"type": "array",
"items": {
"$ref": "#/components/schemas/PersonalIdentifier"
},
"maxItems": 5
"$ref": "#/components/schemas/PersonalIdentifiers"
},
"citizenship": {
"$ref": "#/components/schemas/CountryCode"
Expand Down Expand Up @@ -8815,6 +8736,85 @@
"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",
"properties": {
"name": {
"description": "The company's legal name.",
"type": "string",
"example": "Gin & Doughnuts Bar GmbH",
"maxLength": 150,
"minLength": 1
},
"merchant_category_code": {
"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",
"type": "string",
"example": "1532",
"pattern": "^[0-9]{4}$"
},
"legal_type": {
"$ref": "#/components/schemas/LegalType"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"trading_address": {
"$ref": "#/components/schemas/Address"
},
"identifiers": {
"$ref": "#/components/schemas/CompanyIdentifiers"
},
"phone_number": {
"$ref": "#/components/schemas/PhoneNumber"
},
"website": {
"description": "HTTP(S) URL of the company's website.\n",
"type": "string",
"examples": [
"https://www.sumup.com"
],
"maxLength": 255
},
"attributes": {
"$ref": "#/components/schemas/Attributes"
}
},
"externalDocs": {
"description": "Company documentation",
"url": "https://developer.sumup.com/tools/glossary/merchant#company"
}
},
"ClassicMerchantIdentifiers": {
"type": "object",
"properties": {
Expand Down
2 changes: 1 addition & 1 deletion sdk/src/resources/members/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ export type UpdateMerchantMemberParams = {
*/
user?: {
/**
* User's preferred name. Used for display purposes only.
* User's nickname. Used for display purposes only.
*/
nickname?: string;
/**
Expand Down
8 changes: 2 additions & 6 deletions sdk/src/types/base-person.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import type { Address } from "./address";
import type { ChangeStatus } from "./change-status";
import type { CountryCode } from "./country-code";
import type { Ownership } from "./ownership";
import type { PersonalIdentifier } from "./personal-identifier";
import type { PersonalIdentifiers } from "./personal-identifiers";
import type { PhoneNumber } from "./phone-number";
import type { Version } from "./version";

Expand Down Expand Up @@ -51,11 +51,7 @@ export type BasePerson = {
relationships?: string[];
ownership?: Ownership;
address?: Address;
/**
* A list of country-specific personal identifiers.
*
*/
identifiers?: PersonalIdentifier[];
identifiers?: PersonalIdentifiers;
citizenship?: CountryCode;
/**
* 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.
Expand Down
2 changes: 1 addition & 1 deletion sdk/src/types/company.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ export type Company = {
* HTTP(S) URL of the company's website.
*
*/
website?: string | null;
website?: string;
attributes?: Attributes;
};
1 change: 1 addition & 0 deletions sdk/src/types/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ export type { PaymentType } from "./payment-type";
export type { Person } from "./person";
export type { PersonalDetails } from "./personal-details";
export type { PersonalIdentifier } from "./personal-identifier";
export type { PersonalIdentifiers } from "./personal-identifiers";
export type { PhoneNumber } from "./phone-number";
export type { Problem } from "./problem";
export type { ProcessCheckout } from "./process-checkout";
Expand Down
2 changes: 1 addition & 1 deletion sdk/src/types/membership-user.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export type MembershipUser = {
*/
disabled_at?: string;
/**
* User's preferred name. Used for display purposes only.
* User's nickname. Used for display purposes only.
*/
nickname?: string;
/**
Expand Down
2 changes: 1 addition & 1 deletion sdk/src/types/personal-identifier.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export type PersonalIdentifier = {
*/
ref: string;
/**
* The company identifier value.
* The value of the personal identifier.
*
*/
value: string;
Expand Down
9 changes: 9 additions & 0 deletions sdk/src/types/personal-identifiers.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Code generated by @sumup/sumup-ts-codegen. DO NOT EDIT.

import type { PersonalIdentifier } from "./personal-identifier";

/**
* A list of country-specific personal identifiers.
*
*/
export type PersonalIdentifiers = PersonalIdentifier[];
Loading