Skip to content

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

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
Feb 7, 2026
Merged

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

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
bee99d5
chore: synced local 'openapi.json' with remote 'specs/openapi.json'
Feb 7, 2026
92acdd3
chore: generate code
sumup-bot[bot] Feb 7, 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
184 changes: 110 additions & 74 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7286,10 +7286,14 @@
"$ref": "#/components/schemas/EventStatus"
},
"amount": {
"$ref": "#/components/schemas/AmountEvent"
"description": "Amount of the event.",
"type": "number",
"format": "float"
},
"timestamp": {
"$ref": "#/components/schemas/TimestampEvent"
"description": "Date and time of the transaction event.",
"type": "string",
"format": "date-time"
},
"fee_amount": {
"description": "Amount of the fee related to the event.",
Expand Down Expand Up @@ -7874,10 +7878,14 @@
"$ref": "#/components/schemas/EventStatus"
},
"amount": {
"$ref": "#/components/schemas/AmountEvent"
"description": "Amount of the event.",
"type": "string",
"format": "double"
},
"timestamp": {
"$ref": "#/components/schemas/TimestampEvent"
"description": "Date and time of the transaction event.",
"type": "string",
"format": "date-time"
},
"receipt_no": {
"type": "string"
Expand Down Expand Up @@ -8006,26 +8014,57 @@
"type": "object",
"properties": {
"name": {
"description": "Product name.",
"type": "string"
},
"description": {
"description": "Product description.",
"type": "string"
"description": "Product name",
"type": "string",
"example": "Coffee"
},
"price": {
"description": "Product price.",
"type": "number",
"format": "float"
"description": "Product price",
"type": "string",
"format": "double",
"example": "150.0"
},
"vat_rate": {
"description": "VAT rate",
"type": "string",
"format": "double",
"example": "0.0"
},
"single_vat_amount": {
"description": "VAT amount for a single product",
"type": "string",
"format": "double",
"example": "0.0"
},
"price_with_vat": {
"description": "Product price including VAT",
"type": "string",
"format": "double",
"example": "150.0"
},
"vat_amount": {
"description": "VAT amount",
"type": "string",
"format": "double",
"example": "0.0"
},
"quantity": {
"description": "Product quantity.",
"type": "integer"
"description": "Product quantity",
"type": "integer",
"format": "int64",
"example": 1
},
"total_price": {
"description": "Quantity x product price.",
"type": "number",
"format": "float"
"description": "Quantity x product price",
"type": "string",
"format": "double",
"example": "150.0"
},
"total_with_vat": {
"description": "Total price including VAT",
"type": "string",
"format": "double",
"example": "150.0"
}
}
}
Expand Down Expand Up @@ -8104,7 +8143,9 @@
"$ref": "#/components/schemas/EventStatus"
},
"amount": {
"$ref": "#/components/schemas/AmountEvent"
"description": "Amount of the event.",
"type": "number",
"format": "float"
},
"due_date": {
"description": "Date when the transaction event is due to occur.",
Expand All @@ -8121,7 +8162,9 @@
"type": "integer"
},
"timestamp": {
"$ref": "#/components/schemas/TimestampEvent"
"description": "Date and time of the transaction event.",
"type": "string",
"format": "date-time"
}
}
},
Expand Down Expand Up @@ -8531,11 +8574,6 @@
}
}
},
"AmountEvent": {
"description": "Amount of the event.",
"type": "number",
"format": "float"
},
"Currency": {
"description": "Three-letter [ISO4217](https://en.wikipedia.org/wiki/ISO_4217) code of the currency for the amount. Currently supported currency values are enumerated above.",
"type": "string",
Expand Down Expand Up @@ -8630,11 +8668,6 @@
"description": "Unique ID of the transaction.",
"type": "string"
},
"TimestampEvent": {
"description": "Date and time of the transaction event.",
"type": "string",
"format": "date-time"
},
"Permissions": {
"description": "Permissions assigned to an operator or user.",
"type": "object",
Expand Down Expand Up @@ -8721,12 +8754,41 @@
"example": {},
"additionalProperties": true
},
"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
"Problem": {
"description": "A RFC 9457 problem details object.\n\nAdditional properties specific to the problem type may be present.\n",
"type": "object",
"properties": {
"type": {
"description": "A URI reference that identifies the problem type.",
"type": "string",
"format": "uri",
"example": "https://developer.sumup.com/problem/not-found"
},
"title": {
"description": "A short, human-readable summary of the problem type.",
"type": "string",
"example": "Requested resource couldn't be found."
},
"status": {
"description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
"type": "integer",
"example": 404
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.",
"type": "string",
"example": "The requested resource doesn't exist or does not belong to you."
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.",
"type": "string",
"format": "uri"
}
},
"additionalProperties": true,
"required": [
"type"
]
},
"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.",
Expand Down Expand Up @@ -8856,18 +8918,28 @@
"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}$"
},
"PersonalIdentifier": {
"type": "object",
"properties": {
"ref": {
"description": "The unique reference for the personal identifier type.",
"type": "string",
"example": "br.cpf"
"example": "br.cpf",
"maxLength": 32
},
"value": {
"description": "The company identifier value.",
"type": "string",
"example": "847.060.136-90"
"example": "847.060.136-90",
"maxLength": 128
}
},
"example": {
Expand All @@ -8879,42 +8951,6 @@
"value"
]
},
"Problem": {
"description": "A RFC 9457 problem details object.\n\nAdditional properties specific to the problem type may be present.\n",
"type": "object",
"properties": {
"type": {
"description": "A URI reference that identifies the problem type.",
"type": "string",
"format": "uri"
},
"title": {
"description": "A short, human-readable summary of the problem type.",
"type": "string"
},
"status": {
"description": "The HTTP status code generated by the origin server for this occurrence of the problem.",
"type": "integer",
"example": 400,
"exclusiveMaximum": true,
"maximum": 600,
"minimum": 400
},
"detail": {
"description": "A human-readable explanation specific to this occurrence of the problem.",
"type": "string"
},
"instance": {
"description": "A URI reference that identifies the specific occurrence of the problem.",
"type": "string",
"format": "uri"
}
},
"additionalProperties": true,
"required": [
"type"
]
},
"MembershipStatus": {
"description": "The status of the membership.",
"type": "string",
Expand Down
54 changes: 32 additions & 22 deletions sdk/src/resources/receipts/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,6 @@ export type EventStatus =
| "SUCCESSFUL"
| "PAID_OUT";

/**
* Amount of the event.
*/
export type AmountEvent = number;

/**
* Date and time of the transaction event.
*/
export type TimestampEvent = string;

export type ReceiptCard = {
/**
* Card last 4 digits.
Expand All @@ -58,8 +48,14 @@ export type ReceiptEvent = {
transaction_id?: TransactionID;
type?: EventType;
status?: EventStatus;
amount?: AmountEvent;
timestamp?: TimestampEvent;
/**
* Amount of the event.
*/
amount?: string;
/**
* Date and time of the transaction event.
*/
timestamp?: string;
receipt_no?: string;
};

Expand Down Expand Up @@ -117,25 +113,41 @@ export type ReceiptTransaction = {
*/
products?: {
/**
* Product name.
* Product name
*/
name?: string;
/**
* Product description.
* Product price
*/
price?: string;
/**
* VAT rate
*/
vat_rate?: string;
/**
* VAT amount for a single product
*/
single_vat_amount?: string;
/**
* Product price including VAT
*/
description?: string;
price_with_vat?: string;
/**
* Product price.
* VAT amount
*/
price?: number;
vat_amount?: string;
/**
* Product quantity.
* Product quantity
*/
quantity?: number;
/**
* Quantity x product price.
* Quantity x product price
*/
total_price?: string;
/**
* Total price including VAT
*/
total_price?: number;
total_with_vat?: string;
}[];
/**
* Vat rates.
Expand Down Expand Up @@ -228,7 +240,6 @@ export class Receipts extends Core.APIResource {

export declare namespace Receipts {
export type {
AmountEvent,
EventID,
EventStatus,
EventType,
Expand All @@ -238,7 +249,6 @@ export declare namespace Receipts {
ReceiptEvent,
ReceiptMerchantData,
ReceiptTransaction,
TimestampEvent,
TransactionID,
};
}
Loading
Loading