Skip to content

Commit d4917f0

Browse files
lukasauklukasauk
committed
chore: Update OpenAPI specs
1 parent ded682d commit d4917f0

File tree

1 file changed

+179
-12
lines changed

1 file changed

+179
-12
lines changed

‎openapi.json‎

Lines changed: 179 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"url": "https://developers.hostinger.com",
99
"email": "[email protected]"
1010
},
11-
"version": "0.1.1",
11+
"version": "0.1.2",
1212
"x-scalar-sdk-installation": [
1313
{
1414
"lang": "Shell",
@@ -1191,7 +1191,113 @@
11911191
}
11921192
}
11931193
},
1194+
"/api/reach/v1/contacts/{uuid}": {
1195+
"delete": {
1196+
"tags": [
1197+
"Reach: Contacts"
1198+
],
1199+
"summary": "Delete a contact",
1200+
"description": "Delete a contact with the specified UUID.\n\nThis endpoint permanently removes a contact from the email marketing system.",
1201+
"operationId": "reach_deleteAContactV1",
1202+
"parameters": [
1203+
{
1204+
"$ref": "#/components/parameters/uuid"
1205+
}
1206+
],
1207+
"responses": {
1208+
"200": {
1209+
"description": "Success response",
1210+
"content": {
1211+
"application/json": {
1212+
"schema": {
1213+
"$ref": "#/components/schemas/Common.SuccessEmptyResource"
1214+
}
1215+
}
1216+
}
1217+
},
1218+
"401": {
1219+
"$ref": "#/components/responses/Common.Response.UnauthorizedResponse"
1220+
},
1221+
"500": {
1222+
"$ref": "#/components/responses/Common.Response.ErrorResponse"
1223+
}
1224+
}
1225+
}
1226+
},
1227+
"/api/reach/v1/contacts/groups": {
1228+
"get": {
1229+
"tags": [
1230+
"Reach: Contacts"
1231+
],
1232+
"summary": "List contact groups",
1233+
"description": "Get a list of all contact groups.\n\nThis endpoint returns a list of contact groups that can be used to organize contacts.",
1234+
"operationId": "reach_listContactGroupsV1",
1235+
"responses": {
1236+
"200": {
1237+
"description": "Success response",
1238+
"content": {
1239+
"application/json": {
1240+
"schema": {
1241+
"$ref": "#/components/schemas/Reach.V1.Contacts.Groups.ContactGroupCollection"
1242+
}
1243+
}
1244+
}
1245+
},
1246+
"401": {
1247+
"$ref": "#/components/responses/Common.Response.UnauthorizedResponse"
1248+
},
1249+
"500": {
1250+
"$ref": "#/components/responses/Common.Response.ErrorResponse"
1251+
}
1252+
}
1253+
}
1254+
},
11941255
"/api/reach/v1/contacts": {
1256+
"get": {
1257+
"tags": [
1258+
"Reach: Contacts"
1259+
],
1260+
"summary": "List contacts",
1261+
"description": "Get a list of contacts, optionally filtered by group and subscription status.\n\nThis endpoint returns a paginated list of contacts with their basic information.\nYou can filter contacts by group UUID and subscription status.",
1262+
"operationId": "reach_listContactsV1",
1263+
"parameters": [
1264+
{
1265+
"$ref": "#/components/parameters/group_uuid"
1266+
},
1267+
{
1268+
"$ref": "#/components/parameters/subscription_status"
1269+
},
1270+
{
1271+
"$ref": "#/components/parameters/page"
1272+
}
1273+
],
1274+
"responses": {
1275+
"200": {
1276+
"description": "Success response",
1277+
"content": {
1278+
"application/json": {
1279+
"schema": {
1280+
"properties": {
1281+
"data": {
1282+
"$ref": "#/components/schemas/Reach.V1.Contacts.ContactCollection"
1283+
},
1284+
"meta": {
1285+
"$ref": "#/components/schemas/Common.Schema.PaginationMetaSchema"
1286+
}
1287+
},
1288+
"type": "object"
1289+
}
1290+
}
1291+
}
1292+
},
1293+
"401": {
1294+
"$ref": "#/components/responses/Common.Response.UnauthorizedResponse"
1295+
},
1296+
"500": {
1297+
"$ref": "#/components/responses/Common.Response.ErrorResponse"
1298+
}
1299+
}
1300+
},
11951301
"post": {
11961302
"tags": [
11971303
"Reach: Contacts"
@@ -5280,6 +5386,13 @@
52805386
"mydomain2.tld"
52815387
]
52825388
},
5389+
"Reach.V1.Contacts.ContactCollection": {
5390+
"description": "Array of [`Reach.V1.Contacts.ContactResource`](#model/reachv1contactscontactresource)",
5391+
"type": "array",
5392+
"items": {
5393+
"$ref": "#/components/schemas/Reach.V1.Contacts.ContactResource"
5394+
}
5395+
},
52835396
"Reach.V1.Contacts.ContactResource": {
52845397
"properties": {
52855398
"uuid": {
@@ -5330,6 +5443,26 @@
53305443
},
53315444
"type": "object"
53325445
},
5446+
"Reach.V1.Contacts.Groups.ContactGroupCollection": {
5447+
"description": "Array of [`Reach.V1.Contacts.Groups.ContactGroupResource`](#model/reachv1contactsgroupscontactgroupresource)",
5448+
"type": "array",
5449+
"items": {
5450+
"$ref": "#/components/schemas/Reach.V1.Contacts.Groups.ContactGroupResource"
5451+
}
5452+
},
5453+
"Reach.V1.Contacts.Groups.ContactGroupResource": {
5454+
"properties": {
5455+
"uuid": {
5456+
"type": "string",
5457+
"example": "550e8400-e29b-41d4-a716-446655440000"
5458+
},
5459+
"title": {
5460+
"type": "string",
5461+
"example": "Newsletter Subscribers"
5462+
}
5463+
},
5464+
"type": "object"
5465+
},
53335466
"VPS.V1.Action.ActionCollection": {
53345467
"description": "Array of [`VPS.V1.Action.ActionResource`](#model/vpsv1actionactionresource)",
53355468
"type": "array",
@@ -6485,6 +6618,40 @@
64856618
"example": 564651
64866619
}
64876620
},
6621+
"uuid": {
6622+
"name": "uuid",
6623+
"in": "path",
6624+
"description": "UUID of the contact to delete",
6625+
"required": true,
6626+
"schema": {
6627+
"type": "string",
6628+
"format": "uuid"
6629+
}
6630+
},
6631+
"group_uuid": {
6632+
"name": "group_uuid",
6633+
"in": "query",
6634+
"description": "Filter contacts by group UUID",
6635+
"required": false,
6636+
"schema": {
6637+
"type": "string",
6638+
"example": "550e8400-e29b-41d4-a716-446655440000"
6639+
}
6640+
},
6641+
"subscription_status": {
6642+
"name": "subscription_status",
6643+
"in": "query",
6644+
"description": "Filter contacts by subscription status",
6645+
"required": false,
6646+
"schema": {
6647+
"type": "string",
6648+
"enum": [
6649+
"subscribed",
6650+
"unsubscribed"
6651+
],
6652+
"example": "subscribed"
6653+
}
6654+
},
64886655
"tokenId": {
64896656
"name": "tokenId",
64906657
"in": "path",
@@ -6734,6 +6901,15 @@
67346901
}
67356902
],
67366903
"x-tagGroups": [
6904+
{
6905+
"name": "Billing",
6906+
"tags": [
6907+
"Billing: Catalog",
6908+
"Billing: Orders",
6909+
"Billing: Payment methods",
6910+
"Billing: Subscriptions"
6911+
]
6912+
},
67376913
{
67386914
"name": "Domains",
67396915
"tags": [
@@ -6751,12 +6927,9 @@
67516927
]
67526928
},
67536929
{
6754-
"name": "Billing",
6930+
"name": "Reach",
67556931
"tags": [
6756-
"Billing: Catalog",
6757-
"Billing: Orders",
6758-
"Billing: Payment methods",
6759-
"Billing: Subscriptions"
6932+
"Reach: Contacts"
67606933
]
67616934
},
67626935
{
@@ -6777,12 +6950,6 @@
67776950
"VPS: Virtual machine"
67786951
]
67796952
},
6780-
{
6781-
"name": "Reach",
6782-
"tags": [
6783-
"Reach: Contacts"
6784-
]
6785-
},
67866953
{
67876954
"name": "Miscellaneous",
67886955
"tags": [

0 commit comments

Comments
 (0)