Skip to content

Commit 3891105

Browse files
appscisumupappscisumup
authored
chore: synced file(s) with sumup/apis (#8)
1 parent 6697c8e commit 3891105

File tree

3 files changed

+32
-205
lines changed

3 files changed

+32
-205
lines changed

‎openapi.json‎

Lines changed: 23 additions & 182 deletions
Original file line numberDiff line numberDiff line change
@@ -4933,26 +4933,11 @@
49334933
}
49344934
},
49354935
"404": {
4936-
"description": "No user with the specified ID exists.\n",
4936+
"description": "The requested Merchant does not exist.",
49374937
"content": {
4938-
"application/json": {
4938+
"application/problem+json": {
49394939
"schema": {
4940-
"allOf": [
4941-
{
4942-
"$ref": "#/components/schemas/BaseError"
4943-
},
4944-
{
4945-
"type": "object",
4946-
"properties": {
4947-
"category": {
4948-
"$ref": "#/components/schemas/ErrorCategoryClient"
4949-
},
4950-
"code": {
4951-
"$ref": "#/components/schemas/ErrorCodeNotFound"
4952-
}
4953-
}
4954-
}
4955-
]
4940+
"$ref": "#/components/schemas/Problem"
49564941
}
49574942
}
49584943
}
@@ -5028,51 +5013,21 @@
50285013
}
50295014
},
50305015
"404": {
5031-
"description": "No user with the specified ID exists.\n",
5016+
"description": "The requested Merchant does not exist.",
50325017
"content": {
5033-
"application/json": {
5018+
"application/problem+json": {
50345019
"schema": {
5035-
"allOf": [
5036-
{
5037-
"$ref": "#/components/schemas/BaseError"
5038-
},
5039-
{
5040-
"type": "object",
5041-
"properties": {
5042-
"category": {
5043-
"$ref": "#/components/schemas/ErrorCategoryClient"
5044-
},
5045-
"code": {
5046-
"$ref": "#/components/schemas/ErrorCodeNotFound"
5047-
}
5048-
}
5049-
}
5050-
]
5020+
"$ref": "#/components/schemas/Problem"
50515021
}
50525022
}
50535023
}
50545024
},
50555025
"500": {
50565026
"description": "An internal server error occurred.\n",
50575027
"content": {
5058-
"application/json": {
5028+
"application/problem+json": {
50595029
"schema": {
5060-
"allOf": [
5061-
{
5062-
"$ref": "#/components/schemas/BaseError"
5063-
},
5064-
{
5065-
"type": "object",
5066-
"properties": {
5067-
"category": {
5068-
"$ref": "#/components/schemas/ErrorCategoryServer"
5069-
},
5070-
"code": {
5071-
"$ref": "#/components/schemas/ErrorCodeInternalServerError"
5072-
}
5073-
}
5074-
}
5075-
]
5030+
"$ref": "#/components/schemas/Problem"
50765031
}
50775032
}
50785033
}
@@ -5162,51 +5117,21 @@
51625117
}
51635118
},
51645119
"404": {
5165-
"description": "No user with the specified ID exists.\n",
5120+
"description": "The requested Person does not exist.",
51665121
"content": {
5167-
"application/json": {
5122+
"application/problem+json": {
51685123
"schema": {
5169-
"allOf": [
5170-
{
5171-
"$ref": "#/components/schemas/BaseError"
5172-
},
5173-
{
5174-
"type": "object",
5175-
"properties": {
5176-
"category": {
5177-
"$ref": "#/components/schemas/ErrorCategoryClient"
5178-
},
5179-
"code": {
5180-
"$ref": "#/components/schemas/ErrorCodeNotFound"
5181-
}
5182-
}
5183-
}
5184-
]
5124+
"$ref": "#/components/schemas/Problem"
51855125
}
51865126
}
51875127
}
51885128
},
51895129
"500": {
51905130
"description": "An internal server error occurred.\n",
51915131
"content": {
5192-
"application/json": {
5132+
"application/problem+json": {
51935133
"schema": {
5194-
"allOf": [
5195-
{
5196-
"$ref": "#/components/schemas/BaseError"
5197-
},
5198-
{
5199-
"type": "object",
5200-
"properties": {
5201-
"category": {
5202-
"$ref": "#/components/schemas/ErrorCategoryServer"
5203-
},
5204-
"code": {
5205-
"$ref": "#/components/schemas/ErrorCodeInternalServerError"
5206-
}
5207-
}
5208-
}
5209-
]
5134+
"$ref": "#/components/schemas/Problem"
52105135
}
52115136
}
52125137
}
@@ -9533,25 +9458,26 @@
95339458
"name": {
95349459
"description": "The customer-facing business name.",
95359460
"type": "string",
9536-
"example": "Gin & Dougnuts",
9461+
"example": "Example Coffee",
95379462
"maxLength": 512
95389463
},
95399464
"dynamic_descriptor": {
95409465
"description": "The descriptor is the text that your customer sees on their bank account statement.\nThe more recognisable your descriptor is, the less risk you have of receiving disputes (e.g. chargebacks).\n",
95419466
"type": "string",
9467+
"example": "Example Coffee",
95429468
"maxLength": 30,
95439469
"pattern": "^[a-zA-Z0-9 \\-+\\'_.]{0,30}$"
95449470
},
95459471
"website": {
95469472
"description": "The business's publicly available website.",
95479473
"type": "string",
9548-
"example": "https://gindoughnuts.com",
9474+
"example": "https://example.com",
95499475
"maxLength": 512
95509476
},
95519477
"email": {
95529478
"description": "A publicly available email address.",
95539479
"type": "string",
9554-
"example": "contact@gindoughnuts.com",
9480+
"example": "contact@example.com",
95559481
"maxLength": 256
95569482
},
95579483
"phone_number": {
@@ -9876,47 +9802,6 @@
98769802
"updated_at"
98779803
]
98789804
},
9879-
"BaseError": {
9880-
"type": "object",
9881-
"properties": {
9882-
"instance": {
9883-
"description": "A unique identifier for the error instance. This can be used to trace the error back to the server logs.\n",
9884-
"type": "string"
9885-
},
9886-
"message": {
9887-
"description": "A human-readable message describing the error that occurred.\n",
9888-
"type": "string"
9889-
}
9890-
}
9891-
},
9892-
"ErrorCategoryClient": {
9893-
"description": "The category of the error.\n",
9894-
"type": "string",
9895-
"enum": [
9896-
"client_error"
9897-
]
9898-
},
9899-
"ErrorCodeNotFound": {
9900-
"description": "An error code specifying the exact error that occurred.\n",
9901-
"type": "string",
9902-
"enum": [
9903-
"not_found"
9904-
]
9905-
},
9906-
"ErrorCategoryServer": {
9907-
"description": "The category of the error.\n",
9908-
"type": "string",
9909-
"enum": [
9910-
"server_error"
9911-
]
9912-
},
9913-
"ErrorCodeInternalServerError": {
9914-
"description": "An error code specifying the exact error that occurred.\n",
9915-
"type": "string",
9916-
"enum": [
9917-
"internal_error"
9918-
]
9919-
},
99209805
"Reader": {
99219806
"description": "A physical card reader device that can accept in-person payments.",
99229807
"type": "object",
@@ -9936,6 +9821,12 @@
99369821
"metadata": {
99379822
"$ref": "#/components/schemas/Metadata"
99389823
},
9824+
"service_account_id": {
9825+
"description": "Identifier of the system-managed service account associated with this reader.\nPresent only for readers that are already paired.\nThis field is currently in beta and may change.",
9826+
"type": "string",
9827+
"format": "uuid",
9828+
"x-beta": true
9829+
},
99399830
"created_at": {
99409831
"description": "The timestamp of when the reader was created.",
99419832
"type": "string",
@@ -11988,56 +11879,6 @@
1198811879
}
1198911880
}
1199011881
}
11991-
},
11992-
"404NotFound": {
11993-
"description": "No user with the specified ID exists.\n",
11994-
"content": {
11995-
"application/json": {
11996-
"schema": {
11997-
"allOf": [
11998-
{
11999-
"$ref": "#/components/schemas/BaseError"
12000-
},
12001-
{
12002-
"type": "object",
12003-
"properties": {
12004-
"category": {
12005-
"$ref": "#/components/schemas/ErrorCategoryClient"
12006-
},
12007-
"code": {
12008-
"$ref": "#/components/schemas/ErrorCodeNotFound"
12009-
}
12010-
}
12011-
}
12012-
]
12013-
}
12014-
}
12015-
}
12016-
},
12017-
"500InternalServerError": {
12018-
"description": "An internal server error occurred.\n",
12019-
"content": {
12020-
"application/json": {
12021-
"schema": {
12022-
"allOf": [
12023-
{
12024-
"$ref": "#/components/schemas/BaseError"
12025-
},
12026-
{
12027-
"type": "object",
12028-
"properties": {
12029-
"category": {
12030-
"$ref": "#/components/schemas/ErrorCategoryServer"
12031-
},
12032-
"code": {
12033-
"$ref": "#/components/schemas/ErrorCodeInternalServerError"
12034-
}
12035-
}
12036-
}
12037-
]
12038-
}
12039-
}
12040-
}
1204111882
}
1204211883
},
1204311884
"securitySchemes": {

‎src/Types/BaseError.php‎

Lines changed: 0 additions & 23 deletions
This file was deleted.

‎src/Types/Reader.php‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,15 @@ class Reader
5050
*/
5151
public ?array $metadata = null;
5252

53+
/**
54+
* Identifier of the system-managed service account associated with this reader.
55+
* Present only for readers that are already paired.
56+
* This field is currently in beta and may change.
57+
*
58+
* @var string|null
59+
*/
60+
public ?string $serviceAccountId = null;
61+
5362
/**
5463
* The timestamp of when the reader was created.
5564
*

0 commit comments

Comments
 (0)