Skip to content

Commit de29309

Browse files
lukasauklukasauk
committed
chore: Update OpenAPI specs
1 parent 83c6432 commit de29309

File tree

1 file changed

+140
-1
lines changed

1 file changed

+140
-1
lines changed

‎openapi.json‎

Lines changed: 140 additions & 1 deletion
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.0.101",
11+
"version": "0.0.102",
1212
"x-scalar-sdk-installation": [
1313
{
1414
"lang": "Shell",
@@ -1191,6 +1191,47 @@
11911191
}
11921192
}
11931193
},
1194+
"/api/reach/v1/contacts": {
1195+
"post": {
1196+
"tags": [
1197+
"Reach: Contacts"
1198+
],
1199+
"summary": "Create a new contact",
1200+
"description": "Create a new contact in the email marketing system.\n\nThis endpoint allows you to create a new contact with basic information like name, email, and surname.\nYou can optionally assign the contact to specific groups and add notes.\n\nThe contact will be automatically subscribed to email communications.",
1201+
"operationId": "reach_createANewContactV1",
1202+
"requestBody": {
1203+
"required": true,
1204+
"content": {
1205+
"application/json": {
1206+
"schema": {
1207+
"$ref": "#/components/schemas/Reach.V1.Contacts.StoreRequest"
1208+
}
1209+
}
1210+
}
1211+
},
1212+
"responses": {
1213+
"200": {
1214+
"description": "Success response",
1215+
"content": {
1216+
"application/json": {
1217+
"schema": {
1218+
"$ref": "#/components/schemas/Reach.V1.Contacts.ContactResource"
1219+
}
1220+
}
1221+
}
1222+
},
1223+
"422": {
1224+
"$ref": "#/components/responses/Common.Response.UnprocessableContentResponse"
1225+
},
1226+
"401": {
1227+
"$ref": "#/components/responses/Common.Response.UnauthorizedResponse"
1228+
},
1229+
"500": {
1230+
"$ref": "#/components/responses/Common.Response.ErrorResponse"
1231+
}
1232+
}
1233+
}
1234+
},
11941235
"/api/vps/v1/data-centers": {
11951236
"get": {
11961237
"tags": [
@@ -4006,6 +4047,43 @@
40064047
},
40074048
"type": "object"
40084049
},
4050+
"Reach.V1.Contacts.StoreRequest": {
4051+
"required": [
4052+
"email"
4053+
],
4054+
"properties": {
4055+
"email": {
4056+
"type": "string",
4057+
"example": "[email protected]"
4058+
},
4059+
"name": {
4060+
"type": "string",
4061+
"example": "John",
4062+
"nullable": true
4063+
},
4064+
"surname": {
4065+
"type": "string",
4066+
"example": "Doe",
4067+
"nullable": true
4068+
},
4069+
"group_uuids": {
4070+
"type": "array",
4071+
"items": {
4072+
"description": "Group UUID",
4073+
"type": "string",
4074+
"format": "uuid"
4075+
},
4076+
"nullable": true
4077+
},
4078+
"note": {
4079+
"type": "string",
4080+
"maxLength": 75,
4081+
"example": "VIP customer",
4082+
"nullable": true
4083+
}
4084+
},
4085+
"type": "object"
4086+
},
40094087
"VPS.V1.Firewall.Rules.StoreRequest": {
40104088
"required": [
40114089
"protocol",
@@ -5202,6 +5280,56 @@
52025280
"mydomain2.tld"
52035281
]
52045282
},
5283+
"Reach.V1.Contacts.ContactResource": {
5284+
"properties": {
5285+
"uuid": {
5286+
"type": "string",
5287+
"example": "550e8400-e29b-41d4-a716-446655440000"
5288+
},
5289+
"name": {
5290+
"type": "string",
5291+
"example": "John"
5292+
},
5293+
"surname": {
5294+
"type": "string",
5295+
"example": "Doe"
5296+
},
5297+
"email": {
5298+
"type": "string",
5299+
"example": "[email protected]"
5300+
},
5301+
"subscription_status": {
5302+
"type": "string",
5303+
"enum": [
5304+
"subscribed",
5305+
"unsubscribed"
5306+
],
5307+
"example": "subscribed"
5308+
},
5309+
"subscribed_at": {
5310+
"type": "string",
5311+
"format": "date-time",
5312+
"example": "2023-01-01T00:00:00Z"
5313+
},
5314+
"source": {
5315+
"type": "string",
5316+
"enum": [
5317+
"sync",
5318+
"import",
5319+
"manual"
5320+
],
5321+
"example": "sync",
5322+
"nullable": true
5323+
},
5324+
"note": {
5325+
"type": "string",
5326+
"maxLength": 75,
5327+
"example": "VIP customer",
5328+
"nullable": true
5329+
}
5330+
},
5331+
"type": "object"
5332+
},
52055333
"VPS.V1.Action.ActionCollection": {
52065334
"description": "Array of [`VPS.V1.Action.ActionResource`](#model/vpsv1actionactionresource)",
52075335
"type": "array",
@@ -6534,6 +6662,11 @@
65346662
"description": "Manage WHOIS contact profiles for your domains. This category includes endpoints for creating, updating, deleting, and retrieving WHOIS profiles.\nWHOIS profile stores registration data for domain names and is required for domain registration.",
65356663
"x-displayName": "WHOIS"
65366664
},
6665+
{
6666+
"name": "Reach: Contacts",
6667+
"description": "Manage your email contacts and contact groups. This category includes endpoints for creating, deleting, and listing contacts, as well as managing contact groups.",
6668+
"x-displayName": "Contacts"
6669+
},
65376670
{
65386671
"name": "VPS: Data centers",
65396672
"description": "Access information on available data centers, including location details, so you can choose the optimal region for deploying your virtual machines.",
@@ -6644,6 +6777,12 @@
66446777
"VPS: Virtual machine"
66456778
]
66466779
},
6780+
{
6781+
"name": "Reach",
6782+
"tags": [
6783+
"Reach: Contacts"
6784+
]
6785+
},
66476786
{
66486787
"name": "Miscellaneous",
66496788
"tags": [

0 commit comments

Comments
 (0)