@hosterai/types 0.0.17 → 0.0.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (194) hide show
  1. package/README.md +12 -9
  2. package/dist/decorators/all-or-none-validator.spec.d.ts +1 -0
  3. package/dist/decorators/all-or-none-validator.spec.js +91 -0
  4. package/dist/decorators/all-or-none.validator.d.ts +2 -0
  5. package/dist/decorators/all-or-none.validator.js +71 -0
  6. package/dist/decorators/at-least-one-non-empty-validator.spec.d.ts +1 -0
  7. package/dist/decorators/at-least-one-non-empty-validator.spec.js +79 -0
  8. package/dist/decorators/at-least-one-non-empty.validator.d.ts +2 -0
  9. package/dist/decorators/at-least-one-non-empty.validator.js +43 -0
  10. package/dist/decorators/is-of-allowed-types-validator.spec.d.ts +1 -0
  11. package/dist/decorators/is-of-allowed-types-validator.spec.js +188 -0
  12. package/dist/decorators/is-of-allowed-types.validator.d.ts +16 -0
  13. package/dist/decorators/is-of-allowed-types.validator.js +105 -0
  14. package/dist/decorators/is-one-of-validator.spec.d.ts +1 -0
  15. package/dist/decorators/is-one-of-validator.spec.js +51 -0
  16. package/dist/decorators/is-one-of.validator.d.ts +2 -0
  17. package/dist/decorators/is-one-of.validator.js +19 -0
  18. package/dist/decorators/is-plain-object-validator.spec.d.ts +1 -0
  19. package/dist/decorators/is-plain-object-validator.spec.js +46 -0
  20. package/dist/decorators/is-plain-object.validator.d.ts +2 -0
  21. package/dist/decorators/is-plain-object.validator.js +30 -0
  22. package/dist/decorators/is-property-forbidden-validator.spec.d.ts +1 -0
  23. package/dist/decorators/is-property-forbidden-validator.spec.js +62 -0
  24. package/dist/decorators/is-property-forbidden.validator.d.ts +2 -0
  25. package/dist/decorators/is-property-forbidden.validator.js +22 -0
  26. package/dist/decorators/is-regex-validator.spec.d.ts +1 -0
  27. package/dist/decorators/is-regex-validator.spec.js +46 -0
  28. package/dist/decorators/is-regex.validator.d.ts +2 -0
  29. package/dist/decorators/is-regex.validator.js +32 -0
  30. package/dist/decorators/min-less-or-equal-validator.spec.d.ts +1 -0
  31. package/dist/decorators/min-less-or-equal-validator.spec.js +60 -0
  32. package/dist/decorators/min-less-or-equal.validator.d.ts +2 -0
  33. package/dist/decorators/min-less-or-equal.validator.js +58 -0
  34. package/dist/decorators/unique-field-in-array-validator.spec.d.ts +1 -0
  35. package/dist/decorators/unique-field-in-array-validator.spec.js +39 -0
  36. package/dist/decorators/unique-field-in-array.validator.d.ts +6 -0
  37. package/dist/decorators/unique-field-in-array.validator.js +47 -0
  38. package/dist/dtos/action.dto.js +25 -1
  39. package/dist/dtos/admin-panel.dto.d.ts +38 -0
  40. package/dist/dtos/admin-panel.dto.js +241 -0
  41. package/dist/dtos/client-panel.dto.d.ts +24 -0
  42. package/dist/dtos/client-panel.dto.js +105 -0
  43. package/dist/dtos/company-data.dto.js +1 -1
  44. package/dist/dtos/field-option.dto.js +16 -0
  45. package/dist/dtos/field.dto.d.ts +2 -0
  46. package/dist/dtos/field.dto.js +112 -2
  47. package/dist/dtos/info.dto.d.ts +4 -79
  48. package/dist/dtos/info.dto.js +141 -0
  49. package/dist/dtos/menu.dto.d.ts +5 -6
  50. package/dist/dtos/menu.dto.js +108 -0
  51. package/dist/dtos/multilang-text.dto.js +1 -1
  52. package/dist/dtos/notification/notification-info.dto.js +42 -0
  53. package/dist/dtos/product/product-info.dto.js +73 -0
  54. package/dist/dtos/product/requests/product-downgradeable-request.dto.d.ts +18 -0
  55. package/dist/dtos/product/requests/product-downgradeable-request.dto.js +37 -0
  56. package/dist/dtos/product/requests/product-upgradeable-request.dto.d.ts +18 -0
  57. package/dist/dtos/product/requests/product-upgradeable-request.dto.js +37 -0
  58. package/dist/dtos/product/responses/product-downgradeable-response.dto.d.ts +22 -0
  59. package/dist/dtos/product/responses/product-downgradeable-response.dto.js +11 -0
  60. package/dist/dtos/product/responses/product-upgradeable-response.dto.d.ts +22 -0
  61. package/dist/dtos/product/responses/product-upgradeable-response.dto.js +11 -0
  62. package/dist/dtos/settings.dto.d.ts +14 -0
  63. package/dist/dtos/settings.dto.js +81 -0
  64. package/dist/dtos/tab.dto.js +32 -0
  65. package/dist/dtos/unit.dto.js +47 -0
  66. package/dist/index.d.ts +23 -7
  67. package/dist/index.js +26 -7
  68. package/dist/openapi/schemas/components.schemas.d.ts +991 -0
  69. package/dist/openapi/schemas/components.schemas.js +2552 -0
  70. package/dist/transformers/menu.transformer.d.ts +2 -0
  71. package/dist/transformers/menu.transformer.js +16 -0
  72. package/dist/transformers/settings.transformer.d.ts +1 -0
  73. package/dist/transformers/settings.transformer.js +15 -0
  74. package/dist/validators/action-validator.spec.d.ts +1 -0
  75. package/dist/validators/action-validator.spec.js +67 -0
  76. package/dist/validators/admin-panel-more-actions-validator.spec.d.ts +1 -0
  77. package/dist/validators/admin-panel-more-actions-validator.spec.js +129 -0
  78. package/dist/validators/admin-panel-more-actions.validator.d.ts +2 -0
  79. package/dist/validators/admin-panel-more-actions.validator.js +11 -0
  80. package/dist/validators/admin-panel-tabs-validator.spec.d.ts +1 -0
  81. package/dist/validators/admin-panel-tabs-validator.spec.js +39 -0
  82. package/dist/validators/admin-panel-tabs.validator.d.ts +2 -0
  83. package/dist/validators/admin-panel-tabs.validator.js +11 -0
  84. package/dist/validators/admin-panel-validator.spec.d.ts +1 -0
  85. package/dist/validators/admin-panel-validator.spec.js +112 -0
  86. package/dist/validators/admin-panel.validator.d.ts +2 -0
  87. package/dist/validators/admin-panel.validator.js +14 -0
  88. package/dist/validators/client-data-validator.spec.d.ts +1 -0
  89. package/dist/validators/client-data-validator.spec.js +35 -0
  90. package/dist/validators/client-panel-validator.spec.d.ts +1 -0
  91. package/dist/validators/client-panel-validator.spec.js +51 -0
  92. package/dist/validators/client-panel.validator.d.ts +2 -0
  93. package/dist/validators/client-panel.validator.js +14 -0
  94. package/dist/validators/company-data-validator.spec.d.ts +1 -0
  95. package/dist/validators/company-data-validator.spec.js +73 -0
  96. package/dist/validators/field-option-validator.spec.d.ts +1 -0
  97. package/dist/validators/field-option-validator.spec.js +28 -0
  98. package/dist/validators/field-option.validator.d.ts +2 -0
  99. package/dist/validators/field-option.validator.js +11 -0
  100. package/dist/validators/field-validator.spec.d.ts +1 -0
  101. package/dist/validators/field-validator.spec.js +102 -0
  102. package/dist/validators/jwt-validator.spec.d.ts +2 -0
  103. package/dist/validators/jwt-validator.spec.js +43 -0
  104. package/dist/validators/menu-with-submenu-validator.spec.d.ts +1 -0
  105. package/dist/validators/menu-with-submenu-validator.spec.js +52 -0
  106. package/dist/validators/menu-with-submenu.validator.d.ts +2 -0
  107. package/dist/validators/menu-with-submenu.validator.js +11 -0
  108. package/dist/validators/menu-with-url-validator.spec.d.ts +1 -0
  109. package/dist/validators/menu-with-url-validator.spec.js +70 -0
  110. package/dist/validators/menu-with-url.validator.d.ts +2 -0
  111. package/dist/validators/menu-with-url.validator.js +11 -0
  112. package/dist/validators/multilang-text-validator.spec.d.ts +1 -0
  113. package/dist/validators/multilang-text-validator.spec.js +33 -0
  114. package/dist/validators/notification-info-validator.spec.d.ts +1 -0
  115. package/dist/validators/notification-info-validator.spec.js +82 -0
  116. package/dist/validators/notification-info.validator.d.ts +7 -0
  117. package/dist/validators/notification-info.validator.js +16 -0
  118. package/dist/validators/notification-request-validator.spec.d.ts +1 -0
  119. package/dist/validators/notification-request-validator.spec.js +115 -0
  120. package/dist/validators/product-create-request-validator.spec.d.ts +2 -0
  121. package/dist/validators/product-create-request-validator.spec.js +44 -0
  122. package/dist/validators/product-delete-request-validator.spec.d.ts +1 -0
  123. package/dist/validators/product-delete-request-validator.spec.js +40 -0
  124. package/dist/validators/product-downgradable-request-validator.spec.d.ts +1 -0
  125. package/dist/validators/product-downgradable-request-validator.spec.js +40 -0
  126. package/dist/validators/product-downgrade-request-validator.spec.d.ts +1 -0
  127. package/dist/validators/product-downgrade-request-validator.spec.js +46 -0
  128. package/dist/validators/product-downgradeable-request-validator.d.ts +8 -0
  129. package/dist/validators/product-downgradeable-request-validator.js +17 -0
  130. package/dist/validators/product-info-validator.spec.d.ts +1 -0
  131. package/dist/validators/product-info-validator.spec.js +259 -0
  132. package/dist/validators/product-info.validator.d.ts +2 -0
  133. package/dist/validators/product-info.validator.js +11 -0
  134. package/dist/validators/product-renew-request-validator.spec.d.ts +1 -0
  135. package/dist/validators/product-renew-request-validator.spec.js +40 -0
  136. package/dist/validators/product-suspend-request-validator.spec.d.ts +1 -0
  137. package/dist/validators/product-suspend-request-validator.spec.js +40 -0
  138. package/dist/validators/product-unsuspend-request-validator.spec.d.ts +1 -0
  139. package/dist/validators/product-unsuspend-request-validator.spec.js +40 -0
  140. package/dist/validators/product-upgradable-request-validator.spec.d.ts +1 -0
  141. package/dist/validators/product-upgradable-request-validator.spec.js +40 -0
  142. package/dist/validators/product-upgrade-request-validator.spec.d.ts +1 -0
  143. package/dist/validators/product-upgrade-request-validator.spec.js +46 -0
  144. package/dist/validators/product-upgradeable-request-validator.d.ts +8 -0
  145. package/dist/validators/product-upgradeable-request-validator.js +17 -0
  146. package/dist/validators/product-validate-attributes-request-validator.spec.d.ts +1 -0
  147. package/dist/validators/product-validate-attributes-request-validator.spec.js +27 -0
  148. package/dist/validators/receiver-email-validator.spec.d.ts +1 -0
  149. package/dist/validators/receiver-email-validator.spec.js +32 -0
  150. package/dist/validators/receiver-push-validator.spec.d.ts +1 -0
  151. package/dist/validators/receiver-push-validator.spec.js +31 -0
  152. package/dist/validators/receiver-sms-validator.spec.d.ts +1 -0
  153. package/dist/validators/receiver-sms-validator.spec.js +29 -0
  154. package/dist/validators/sender-email-validator.spec.d.ts +2 -0
  155. package/dist/validators/sender-email-validator.spec.js +62 -0
  156. package/dist/validators/sender-push-validator.spec.d.ts +1 -0
  157. package/dist/validators/sender-push-validator.spec.js +38 -0
  158. package/dist/validators/sender-sms-validator.spec.d.ts +1 -0
  159. package/dist/validators/sender-sms-validator.spec.js +22 -0
  160. package/dist/validators/settings-with-tabs-validator.spec.d.ts +1 -0
  161. package/dist/validators/settings-with-tabs-validator.spec.js +29 -0
  162. package/dist/validators/settings-with-tabs.validator.d.ts +2 -0
  163. package/dist/validators/settings-with-tabs.validator.js +11 -0
  164. package/dist/validators/settings-with-url-validator.spec.d.ts +1 -0
  165. package/dist/validators/settings-with-url-validator.spec.js +29 -0
  166. package/dist/validators/settings-with-url.validator.d.ts +2 -0
  167. package/dist/validators/settings-with-url.validator.js +11 -0
  168. package/dist/validators/unit-validator.spec.d.ts +1 -0
  169. package/dist/validators/unit-validator.spec.js +27 -0
  170. package/dist/validators/unit.validator.d.ts +2 -0
  171. package/dist/validators/unit.validator.js +11 -0
  172. package/package.json +4 -1
  173. package/dist/dtos/info/info-notification.dto.d.ts +0 -5
  174. package/dist/dtos/info/info-notification.dto.js +0 -7
  175. package/dist/dtos/info/info.dto.d.ts +0 -196
  176. package/dist/dtos/info/info.dto.js +0 -278
  177. package/dist/dtos/notification/notification-request.dto.d.ts +0 -20
  178. package/dist/dtos/notification/notification-request.dto.js +0 -31
  179. package/dist/dtos/receiver/receiver-email.dto.d.ts +0 -20
  180. package/dist/dtos/receiver/receiver-email.dto.js +0 -39
  181. package/dist/dtos/receiver/receiver-push.dto.d.ts +0 -15
  182. package/dist/dtos/receiver/receiver-push.dto.js +0 -31
  183. package/dist/dtos/receiver/receiver-sms.dto.d.ts +0 -11
  184. package/dist/dtos/receiver/receiver-sms.dto.js +0 -26
  185. package/dist/dtos/request.dto.d.ts +0 -20
  186. package/dist/dtos/request.dto.js +0 -31
  187. package/dist/dtos/sender/sender-email.dto.d.ts +0 -25
  188. package/dist/dtos/sender/sender-email.dto.js +0 -46
  189. package/dist/dtos/sender/sender-push.dto.d.ts +0 -31
  190. package/dist/dtos/sender/sender-push.dto.js +0 -50
  191. package/dist/dtos/sender/sender-sms.dto.d.ts +0 -15
  192. package/dist/dtos/sender/sender-sms.dto.js +0 -30
  193. package/dist/enums/message-type.enum.d.ts +0 -5
  194. package/dist/enums/message-type.enum.js +0 -9
@@ -0,0 +1,2552 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ComponentsSchemas = void 0;
4
+ exports.ComponentsSchemas = {
5
+ "TabDto": {
6
+ "properties": {
7
+ "label": {
8
+ "minLength": 1,
9
+ "type": "string",
10
+ "title": "Label",
11
+ "description": "Text label for the tab."
12
+ },
13
+ "url": {
14
+ "minLength": 1,
15
+ "type": "string",
16
+ "format": "uri",
17
+ "title": "URL",
18
+ "description": "URL associated with the tab."
19
+ }
20
+ },
21
+ "type": "object",
22
+ "required": [
23
+ "label",
24
+ "url"
25
+ ]
26
+ },
27
+ "ActionDto": {
28
+ "properties": {
29
+ "icon": {
30
+ "minLength": 1,
31
+ "type": "string",
32
+ "title": "Icon",
33
+ "description": "Name of the icon to display for the action."
34
+ },
35
+ "label": {
36
+ "type": "string",
37
+ "title": "Label",
38
+ "description": "Text label for the action."
39
+ },
40
+ "openMethod": {
41
+ "minLength": 1,
42
+ "type": "string",
43
+ "enum": [
44
+ "ajax_call",
45
+ "small_iframe",
46
+ "medium_iframe",
47
+ "large_iframe"
48
+ ],
49
+ "title": "Open Method",
50
+ "description": "Method by which the action's URL should be opened."
51
+ },
52
+ "url": {
53
+ "minLength": 1,
54
+ "type": "string",
55
+ "format": "url",
56
+ "title": "URL",
57
+ "description": "URL to navigate to when the action is triggered."
58
+ }
59
+ },
60
+ "type": "object",
61
+ "required": [
62
+ "icon",
63
+ "openMethod",
64
+ "url"
65
+ ]
66
+ },
67
+ "BaseMenuDto": {
68
+ "properties": {
69
+ "icon": {
70
+ "minLength": 1,
71
+ "type": "string",
72
+ "title": "Icon",
73
+ "description": "Icon for the menu item."
74
+ },
75
+ "label": {
76
+ "minLength": 1,
77
+ "type": "string",
78
+ "title": "Label",
79
+ "description": "Label for the menu item."
80
+ }
81
+ },
82
+ "type": "object",
83
+ "required": [
84
+ "icon",
85
+ "label"
86
+ ]
87
+ },
88
+ "MenuDtoWithUrl": {
89
+ "properties": {
90
+ "type": {
91
+ "type": "string",
92
+ "enum": [
93
+ "only-url"
94
+ ],
95
+ "minLength": 1,
96
+ "title": "Type",
97
+ "description": "Type of the menu item."
98
+ },
99
+ "url": {
100
+ "minLength": 1,
101
+ "type": "string",
102
+ "format": "uri",
103
+ "title": "URL",
104
+ "description": "URL associated with the menu item."
105
+ },
106
+ "icon": {
107
+ "minLength": 1,
108
+ "type": "string",
109
+ "title": "Icon",
110
+ "description": "Icon for the menu item."
111
+ },
112
+ "label": {
113
+ "minLength": 1,
114
+ "type": "string",
115
+ "title": "Label",
116
+ "description": "Label for the menu item."
117
+ }
118
+ },
119
+ "type": "object",
120
+ "required": [
121
+ "type",
122
+ "url",
123
+ "submenu",
124
+ "icon",
125
+ "label"
126
+ ]
127
+ },
128
+ "MenuDtoWithSubmenu": {
129
+ "properties": {
130
+ "type": {
131
+ "type": "string",
132
+ "enum": [
133
+ "with-submenu"
134
+ ],
135
+ "minLength": 1,
136
+ "title": "Type",
137
+ "description": "Type of the menu item."
138
+ },
139
+ "submenu": {
140
+ "items": {
141
+ "$ref": "#/components/schemas/TabDto"
142
+ },
143
+ "type": "array",
144
+ "not": {
145
+ "type": "null"
146
+ },
147
+ "title": "Submenu",
148
+ "description": "List of tabs that will appear in the submenu."
149
+ },
150
+ "icon": {
151
+ "minLength": 1,
152
+ "type": "string",
153
+ "title": "Icon",
154
+ "description": "Icon for the menu item."
155
+ },
156
+ "label": {
157
+ "minLength": 1,
158
+ "type": "string",
159
+ "title": "Label",
160
+ "description": "Label for the menu item."
161
+ }
162
+ },
163
+ "type": "object",
164
+ "required": [
165
+ "type",
166
+ "url",
167
+ "submenu",
168
+ "icon",
169
+ "label"
170
+ ]
171
+ },
172
+ "SettingsDto": {
173
+ "properties": {
174
+ "label": {
175
+ "minLength": 1,
176
+ "type": "string",
177
+ "not": {
178
+ "type": "null"
179
+ },
180
+ "title": "Label",
181
+ "description": "Label of the settings page."
182
+ },
183
+ "icon": {
184
+ "not": {
185
+ "type": "null"
186
+ },
187
+ "type": "string",
188
+ "title": "Icon",
189
+ "description": "Icon of the settings page."
190
+ },
191
+ "description": {
192
+ "not": {
193
+ "type": "null"
194
+ },
195
+ "type": "string",
196
+ "title": "Description",
197
+ "description": "Description of the settings page."
198
+ }
199
+ },
200
+ "type": "object",
201
+ "required": [
202
+ "label",
203
+ "icon",
204
+ "description"
205
+ ]
206
+ },
207
+ "SettingsWithUrlDto": {
208
+ "properties": {
209
+ "url": {
210
+ "format": "url",
211
+ "type": "string"
212
+ },
213
+ "label": {
214
+ "minLength": 1,
215
+ "type": "string",
216
+ "not": {
217
+ "type": "null"
218
+ },
219
+ "title": "Label",
220
+ "description": "Label of the settings page."
221
+ },
222
+ "icon": {
223
+ "not": {
224
+ "type": "null"
225
+ },
226
+ "type": "string",
227
+ "title": "Icon",
228
+ "description": "Icon of the settings page."
229
+ },
230
+ "description": {
231
+ "not": {
232
+ "type": "null"
233
+ },
234
+ "type": "string",
235
+ "title": "Description",
236
+ "description": "Description of the settings page."
237
+ }
238
+ },
239
+ "type": "object",
240
+ "required": [
241
+ "url",
242
+ "tabs",
243
+ "label",
244
+ "icon",
245
+ "description"
246
+ ]
247
+ },
248
+ "SettingsWithTabsDto": {
249
+ "properties": {
250
+ "tabs": {
251
+ "items": {
252
+ "$ref": "#/components/schemas/TabDto"
253
+ },
254
+ "type": "array",
255
+ "title": "Tabs",
256
+ "description": "Tabs shown on the settings page."
257
+ },
258
+ "label": {
259
+ "minLength": 1,
260
+ "type": "string",
261
+ "not": {
262
+ "type": "null"
263
+ },
264
+ "title": "Label",
265
+ "description": "Label of the settings page."
266
+ },
267
+ "icon": {
268
+ "not": {
269
+ "type": "null"
270
+ },
271
+ "type": "string",
272
+ "title": "Icon",
273
+ "description": "Icon of the settings page."
274
+ },
275
+ "description": {
276
+ "not": {
277
+ "type": "null"
278
+ },
279
+ "type": "string",
280
+ "title": "Description",
281
+ "description": "Description of the settings page."
282
+ }
283
+ },
284
+ "type": "object",
285
+ "required": [
286
+ "tabs",
287
+ "url",
288
+ "label",
289
+ "icon",
290
+ "description"
291
+ ]
292
+ },
293
+ "AdminPanelTabsDto": {
294
+ "properties": {
295
+ "product": {
296
+ "items": {
297
+ "$ref": "#/components/schemas/TabDto"
298
+ },
299
+ "minItems": 1,
300
+ "type": "array",
301
+ "title": "Product Tabs",
302
+ "description": "Tabs shown on the product detail page in Admin panel."
303
+ },
304
+ "item": {
305
+ "items": {
306
+ "$ref": "#/components/schemas/TabDto"
307
+ },
308
+ "minItems": 1,
309
+ "type": "array",
310
+ "title": "Item Tabs",
311
+ "description": "Tabs shown on the item detail page in Admin panel."
312
+ },
313
+ "client": {
314
+ "items": {
315
+ "$ref": "#/components/schemas/TabDto"
316
+ },
317
+ "minItems": 1,
318
+ "type": "array",
319
+ "title": "Client Tabs",
320
+ "description": "Tabs shown on the client profile page in Admin panel."
321
+ },
322
+ "user": {
323
+ "items": {
324
+ "$ref": "#/components/schemas/TabDto"
325
+ },
326
+ "minItems": 1,
327
+ "type": "array",
328
+ "title": "User Tabs",
329
+ "description": "Tabs shown on the user page in Admin panel."
330
+ },
331
+ "order": {
332
+ "items": {
333
+ "$ref": "#/components/schemas/TabDto"
334
+ },
335
+ "minItems": 1,
336
+ "type": "array",
337
+ "title": "Order Tabs",
338
+ "description": "Tabs shown on the order page in Admin panel."
339
+ }
340
+ },
341
+ "type": "object",
342
+ "required": []
343
+ },
344
+ "AdminPanelMoreActionsDto": {
345
+ "properties": {
346
+ "client": {
347
+ "items": {
348
+ "$ref": "#/components/schemas/ActionDto"
349
+ },
350
+ "type": "array",
351
+ "minItems": 1,
352
+ "title": "Client Actions",
353
+ "description": "Additional actions available on the client page."
354
+ },
355
+ "item": {
356
+ "items": {
357
+ "$ref": "#/components/schemas/ActionDto"
358
+ },
359
+ "type": "array",
360
+ "minItems": 1,
361
+ "title": "Item Actions",
362
+ "description": "Additional actions available on the item page."
363
+ },
364
+ "invoice": {
365
+ "items": {
366
+ "$ref": "#/components/schemas/ActionDto"
367
+ },
368
+ "type": "array",
369
+ "minItems": 1,
370
+ "title": "Invoice Actions",
371
+ "description": "Additional actions available on the invoice page."
372
+ },
373
+ "user": {
374
+ "items": {
375
+ "$ref": "#/components/schemas/ActionDto"
376
+ },
377
+ "type": "array",
378
+ "minItems": 1,
379
+ "title": "User Actions",
380
+ "description": "Additional actions available on the user page."
381
+ },
382
+ "order": {
383
+ "items": {
384
+ "$ref": "#/components/schemas/ActionDto"
385
+ },
386
+ "type": "array",
387
+ "minItems": 1,
388
+ "title": "Order Actions",
389
+ "description": "Additional actions available on the order page."
390
+ }
391
+ },
392
+ "type": "object",
393
+ "required": []
394
+ },
395
+ "AdminPanelDto": {
396
+ "properties": {
397
+ "tabs": {
398
+ "$ref": "#/components/schemas/AdminPanelTabsDto",
399
+ "title": "Tabs",
400
+ "description": "Tab structure for Admin panel sections.",
401
+ "type": "object",
402
+ "properties": {
403
+ "tabs": {
404
+ "$ref": "#/components/schemas/AdminPanelTabsDto"
405
+ }
406
+ }
407
+ },
408
+ "moreActions": {
409
+ "$ref": "#/components/schemas/AdminPanelMoreActionsDto",
410
+ "title": "More Actions",
411
+ "description": "Additional actions in Admin panel sections.",
412
+ "type": "object",
413
+ "properties": {
414
+ "moreActions": {
415
+ "$ref": "#/components/schemas/AdminPanelMoreActionsDto"
416
+ }
417
+ }
418
+ },
419
+ "menu": {
420
+ "title": "Menu",
421
+ "description": "Admin panel main menu (URL or submenu variant).",
422
+ "type": "object",
423
+ "oneOf": [
424
+ {
425
+ "$ref": "#/components/schemas/MenuDtoWithSubmenu"
426
+ },
427
+ {
428
+ "$ref": "#/components/schemas/MenuDtoWithUrl"
429
+ }
430
+ ]
431
+ },
432
+ "settings": {
433
+ "title": "Settings",
434
+ "description": "Admin panel settings page configuration.",
435
+ "type": "object",
436
+ "oneOf": [
437
+ {
438
+ "$ref": "#/components/schemas/SettingsWithUrlDto"
439
+ },
440
+ {
441
+ "$ref": "#/components/schemas/SettingsWithTabsDto"
442
+ }
443
+ ]
444
+ }
445
+ },
446
+ "type": "object",
447
+ "required": []
448
+ },
449
+ "ClientPanelTabsDto": {
450
+ "properties": {
451
+ "item": {
452
+ "items": {
453
+ "$ref": "#/components/schemas/TabDto"
454
+ },
455
+ "type": "array",
456
+ "minItems": 1,
457
+ "title": "Item Tabs",
458
+ "description": "Tabs shown on the item page in Client panel."
459
+ }
460
+ },
461
+ "type": "object",
462
+ "required": []
463
+ },
464
+ "ClientPanelMoreActionsDto": {
465
+ "properties": {
466
+ "item": {
467
+ "items": {
468
+ "$ref": "#/components/schemas/ActionDto"
469
+ },
470
+ "type": "array",
471
+ "minItems": 1,
472
+ "title": "Item Actions",
473
+ "description": "Additional actions available on the item page in Client panel."
474
+ }
475
+ },
476
+ "type": "object",
477
+ "required": []
478
+ },
479
+ "ClientPanelDto": {
480
+ "properties": {
481
+ "tabs": {
482
+ "$ref": "#/components/schemas/ClientPanelTabsDto",
483
+ "title": "Tabs",
484
+ "description": "Tab structure for Client panel.",
485
+ "type": "object",
486
+ "properties": {
487
+ "tabs": {
488
+ "$ref": "#/components/schemas/ClientPanelTabsDto"
489
+ }
490
+ }
491
+ },
492
+ "moreActions": {
493
+ "$ref": "#/components/schemas/ClientPanelMoreActionsDto",
494
+ "title": "More Actions",
495
+ "description": "Additional actions in Client panel.",
496
+ "type": "object",
497
+ "properties": {
498
+ "moreActions": {
499
+ "$ref": "#/components/schemas/ClientPanelMoreActionsDto"
500
+ }
501
+ }
502
+ },
503
+ "menu": {
504
+ "title": "Menu",
505
+ "description": "Client panel main menu (URL or submenu variant).",
506
+ "oneOf": [
507
+ {
508
+ "$ref": "#/components/schemas/MenuDtoWithSubmenu"
509
+ },
510
+ {
511
+ "$ref": "#/components/schemas/MenuDtoWithUrl"
512
+ }
513
+ ]
514
+ }
515
+ },
516
+ "type": "object",
517
+ "required": []
518
+ },
519
+ "InfoDto": {
520
+ "properties": {
521
+ "title": {
522
+ "minLength": 1,
523
+ "type": "string",
524
+ "title": "Title",
525
+ "description": "Integration display title.",
526
+ "example": "Example Product"
527
+ },
528
+ "logo": {
529
+ "format": "uri",
530
+ "type": "string",
531
+ "title": "Logo URL",
532
+ "description": "Public HTTPS URL for the integration logo.",
533
+ "example": "https://cdn.example.com/logo.png"
534
+ },
535
+ "description": {
536
+ "type": "string",
537
+ "title": "Description",
538
+ "description": "Short description of the integration.",
539
+ "example": "An example product integration."
540
+ },
541
+ "supportedLanguages": {
542
+ "items": {
543
+ "enum": [
544
+ "aa",
545
+ "af",
546
+ "ak",
547
+ "sq",
548
+ "am",
549
+ "ar",
550
+ "an",
551
+ "hy",
552
+ "as",
553
+ "av",
554
+ "ae",
555
+ "ay",
556
+ "az",
557
+ "bm",
558
+ "ba",
559
+ "eu",
560
+ "be",
561
+ "bn",
562
+ "bh",
563
+ "bi",
564
+ "bs",
565
+ "br",
566
+ "bg",
567
+ "my",
568
+ "ca",
569
+ "ch",
570
+ "ce",
571
+ "ny",
572
+ "zh",
573
+ "cv",
574
+ "kw",
575
+ "co",
576
+ "cr",
577
+ "hr",
578
+ "cs",
579
+ "da",
580
+ "dv",
581
+ "nl",
582
+ "dz",
583
+ "en",
584
+ "eo",
585
+ "et",
586
+ "ee",
587
+ "fo",
588
+ "fj",
589
+ "fi",
590
+ "fr",
591
+ "ff",
592
+ "gl",
593
+ "ka",
594
+ "de",
595
+ "el",
596
+ "gn",
597
+ "gu",
598
+ "ht",
599
+ "ha",
600
+ "he",
601
+ "hz",
602
+ "hi",
603
+ "ho",
604
+ "hu",
605
+ "ia",
606
+ "id",
607
+ "ie",
608
+ "ga",
609
+ "ig",
610
+ "ik",
611
+ "io",
612
+ "is",
613
+ "it",
614
+ "iu",
615
+ "ja",
616
+ "jv",
617
+ "kl",
618
+ "kn",
619
+ "kr",
620
+ "ks",
621
+ "kk",
622
+ "km",
623
+ "ki",
624
+ "rw",
625
+ "ky",
626
+ "kv",
627
+ "kg",
628
+ "ko",
629
+ "ku",
630
+ "kj",
631
+ "la",
632
+ "lb",
633
+ "lg",
634
+ "li",
635
+ "ln",
636
+ "lo",
637
+ "lt",
638
+ "lu",
639
+ "lv",
640
+ "gv",
641
+ "mk",
642
+ "mg",
643
+ "ms",
644
+ "ml",
645
+ "mt",
646
+ "mi",
647
+ "mr",
648
+ "mh",
649
+ "mn",
650
+ "na",
651
+ "nv",
652
+ "nd",
653
+ "ne",
654
+ "ng",
655
+ "nb",
656
+ "nn",
657
+ "no",
658
+ "ii",
659
+ "nr",
660
+ "oc",
661
+ "oj",
662
+ "cu",
663
+ "om",
664
+ "or",
665
+ "os",
666
+ "pa",
667
+ "pi",
668
+ "fa",
669
+ "pl",
670
+ "ps",
671
+ "pt",
672
+ "qu",
673
+ "rm",
674
+ "rn",
675
+ "ro",
676
+ "rh",
677
+ "ru",
678
+ "sa",
679
+ "sc",
680
+ "sd",
681
+ "se",
682
+ "sm",
683
+ "sg",
684
+ "sr",
685
+ "gd",
686
+ "sn",
687
+ "si",
688
+ "sk",
689
+ "sl",
690
+ "so",
691
+ "st",
692
+ "es",
693
+ "su",
694
+ "sw",
695
+ "ss",
696
+ "sv",
697
+ "ta",
698
+ "te",
699
+ "tg",
700
+ "th",
701
+ "ti",
702
+ "bo",
703
+ "tk",
704
+ "tl",
705
+ "tn",
706
+ "to",
707
+ "tr",
708
+ "ts",
709
+ "tt",
710
+ "tw",
711
+ "ty",
712
+ "ug",
713
+ "uk",
714
+ "ur",
715
+ "uz",
716
+ "ve",
717
+ "vi",
718
+ "vo",
719
+ "wa",
720
+ "cy",
721
+ "wo",
722
+ "fy",
723
+ "xh",
724
+ "yi",
725
+ "yo",
726
+ "za",
727
+ "zu"
728
+ ],
729
+ "type": "string"
730
+ },
731
+ "minItems": 1,
732
+ "type": "array",
733
+ "not": {
734
+ "type": "null"
735
+ },
736
+ "title": "Supported Languages",
737
+ "description": "Locales supported by the integration.",
738
+ "example": [
739
+ "en"
740
+ ]
741
+ },
742
+ "supportedActions": {
743
+ "items": {
744
+ "enum": [
745
+ "create",
746
+ "renew",
747
+ "upgrade",
748
+ "downgrade",
749
+ "transfer",
750
+ "suspend",
751
+ "unsuspend",
752
+ "delete"
753
+ ],
754
+ "type": "string"
755
+ },
756
+ "type": "array",
757
+ "title": "Supported Actions",
758
+ "description": "Actions supported by this integration."
759
+ },
760
+ "listenEvents": {
761
+ "items": {
762
+ "enum": [
763
+ "user/created",
764
+ "user/updated",
765
+ "user/deleted",
766
+ "user/banned",
767
+ "user/unbanned",
768
+ "user/company/access/added",
769
+ "user/company/access/removed",
770
+ "user/locked",
771
+ "user/credit-balance/updated",
772
+ "user/unlocked",
773
+ "user/password/updated",
774
+ "user/email/updated",
775
+ "user/currency/updated",
776
+ "user/invoice-contact/updated",
777
+ "user/policy/updated",
778
+ "user/languages/updated",
779
+ "user/custom-price-policies/updated",
780
+ "user/custom-addon-price-policies/updated",
781
+ "user/custom-affiliate/added",
782
+ "user/custom-affiliate/removed",
783
+ "user/invoice-interval/updated",
784
+ "user/additional-notification-email/removed",
785
+ "user/additional-notification-email/added",
786
+ "user/comment/added",
787
+ "user/comment/removed",
788
+ "user/comment/updated",
789
+ "user/tags/updated",
790
+ "user/setting/added",
791
+ "user/setting/removed",
792
+ "user/setting/updated",
793
+ "user/start-selling",
794
+ "user/roles/updated",
795
+ "user/roles/added",
796
+ "user/roles/deleted",
797
+ "message/created",
798
+ "message/updated",
799
+ "message/deleted",
800
+ "notification/sent",
801
+ "policy/created",
802
+ "policy/updated",
803
+ "policy/deleted",
804
+ "product-category/created",
805
+ "product-category/updated",
806
+ "product-category/deleted",
807
+ "invoice-contact/created",
808
+ "invoice-contact/updated",
809
+ "invoice-contact/deleted",
810
+ "invoice/created",
811
+ "invoice/updated",
812
+ "invoice/deleted",
813
+ "currency/created",
814
+ "currency/updated",
815
+ "currency/deleted",
816
+ "affiliate/created",
817
+ "affiliate/updated",
818
+ "affiliate/deleted",
819
+ "company/created",
820
+ "company/updated",
821
+ "company/deleted",
822
+ "organization/integration/attached",
823
+ "organization/integration/detached",
824
+ "tld/created",
825
+ "tld/updated",
826
+ "tld/deleted",
827
+ "integration/created",
828
+ "integration/updated",
829
+ "integration/deleted",
830
+ "integration/installed",
831
+ "integration/uninstalled",
832
+ "integration/activated",
833
+ "integration/deactivated",
834
+ "integration/maintenance-started",
835
+ "integration/maintenance-finished",
836
+ "domain-contact/created",
837
+ "domain-contact/updated",
838
+ "domain-contact/deleted",
839
+ "domain-category/created",
840
+ "domain-category/updated",
841
+ "domain-category/deleted",
842
+ "addon/created",
843
+ "addon/updated",
844
+ "addon/deleted",
845
+ "transaction/created",
846
+ "transaction/canceled",
847
+ "transaction/failed",
848
+ "transaction/subscribed",
849
+ "transaction/unsubscribed",
850
+ "transaction/updated",
851
+ "transaction/deleted",
852
+ "transaction/completed",
853
+ "transaction/refunded",
854
+ "template/created",
855
+ "template/updated",
856
+ "template/deleted",
857
+ "coupon/created",
858
+ "coupon/updated",
859
+ "coupon/deleted",
860
+ "template-integration/created",
861
+ "template-integration/updated",
862
+ "template-integration/deleted",
863
+ "order/created",
864
+ "order/status/in-progress",
865
+ "order/status/completed",
866
+ "order/status/canceled",
867
+ "order/status/refunded",
868
+ "order/insufficient-balance",
869
+ "order/updated",
870
+ "order/deleted",
871
+ "setting/created",
872
+ "setting/updated",
873
+ "setting/deleted",
874
+ "issue/created",
875
+ "issue/updated",
876
+ "issue/deleted",
877
+ "task/created",
878
+ "task/updated",
879
+ "task/deleted",
880
+ "task/canceled",
881
+ "task/in-progress",
882
+ "task/completed",
883
+ "task/percentage/updated",
884
+ "product/created",
885
+ "product/updated",
886
+ "product/deleted",
887
+ "product/auto-renew/updated",
888
+ "product/enabled",
889
+ "product/disabled",
890
+ "product/version-created",
891
+ "ip-group/created",
892
+ "ip-group/updated",
893
+ "ip-group/deleted",
894
+ "ip/created",
895
+ "ip/updated",
896
+ "ip/deleted",
897
+ "domain-name/created",
898
+ "domain-name/updated",
899
+ "domain-name/deleted",
900
+ "domain-name/locked",
901
+ "domain-name/unlocked",
902
+ "domain-name/idshield-activated",
903
+ "domain-name/idshield-deactivated",
904
+ "domain-name/bundle-added",
905
+ "domain-name/bundle-removed",
906
+ "domain-name/registrant-updated",
907
+ "domain-name/admin-updated",
908
+ "domain-name/tech-updated",
909
+ "domain-name/billing-updated",
910
+ "domain-name/additional-updated",
911
+ "item/created",
912
+ "item/updated",
913
+ "item/deleted",
914
+ "item/renewed",
915
+ "item/upgraded",
916
+ "item/downgraded",
917
+ "item/ip-attached",
918
+ "item/ip-detached",
919
+ "item/detached-from-order",
920
+ "item/postponed",
921
+ "item/transferred-in",
922
+ "item/canceled",
923
+ "item/suspended",
924
+ "item/unsuspended",
925
+ "item/affiliate/added",
926
+ "item/bundle/attached",
927
+ "item/bundle/detached",
928
+ "item/activated",
929
+ "item/set-inactive",
930
+ "item/processed",
931
+ "order/paid",
932
+ "test",
933
+ "dead-lettering",
934
+ "core-queue"
935
+ ],
936
+ "type": "string"
937
+ },
938
+ "minItems": 1,
939
+ "type": "array",
940
+ "title": "Listen Events",
941
+ "description": "Platform events the integration can subscribe to."
942
+ },
943
+ "requiredRoles": {
944
+ "items": {
945
+ "enum": [
946
+ "SIMPLE_USER",
947
+ "FULL_ACCESS",
948
+ "SUPER_ADMIN",
949
+ "ORDER_READ",
950
+ "ORDER_WRITE",
951
+ "ADDON_READ",
952
+ "ADDON_WRITE",
953
+ "AFFILIATE_READ",
954
+ "AFFILIATE_WRITE",
955
+ "COMPANY_READ",
956
+ "COMPANY_WRITE",
957
+ "TEMPLATE_READ",
958
+ "TEMPLATE_WRITE",
959
+ "COUPON_READ",
960
+ "COUPON_WRITE",
961
+ "DOMAIN_CATEGORY_READ",
962
+ "DOMAIN_CATEGORY_WRITE",
963
+ "DOMAIN_CONTACT_READ",
964
+ "DOMAIN_CONTACT_WRITE",
965
+ "DOMAIN_NAME_READ",
966
+ "DOMAIN_NAME_WRITE",
967
+ "INVOICE_CONTACT_READ",
968
+ "INVOICE_CONTACT_WRITE",
969
+ "INVOICE_READ",
970
+ "INVOICE_WRITE",
971
+ "IP_GROUPS_READ",
972
+ "IP_GROUPS_WRITE",
973
+ "IPS_READ",
974
+ "IPS_WRITE",
975
+ "ITEMS_READ",
976
+ "ITEMS_WRITE",
977
+ "ORDERS_READ",
978
+ "ORDERS_WRITE",
979
+ "TRANSACTIONS_READ",
980
+ "TRANSACTIONS_WRITE",
981
+ "POLICIES_READ",
982
+ "POLICIES_WRITE",
983
+ "PRODUCT_CATEGORIES_READ",
984
+ "PRODUCT_CATEGORIES_WRITE",
985
+ "PRODUCTS_READ",
986
+ "PRODUCTS_WRITE",
987
+ "SETTINGS_READ",
988
+ "SETTINGS_WRITE",
989
+ "INTEGRATIONS_READ",
990
+ "INTEGRATIONS_WRITE",
991
+ "TLDS_READ",
992
+ "TLDS_WRITE",
993
+ "USERS_READ",
994
+ "USERS_WRITE",
995
+ "ISSUES_WRITE",
996
+ "ISSUES_READ",
997
+ "ACTION_LOGS_READ"
998
+ ],
999
+ "type": "string"
1000
+ },
1001
+ "minItems": 1,
1002
+ "type": "array",
1003
+ "title": "Required Roles",
1004
+ "description": "Roles required for this integration to operate."
1005
+ },
1006
+ "adminPanel": {
1007
+ "$ref": "#/components/schemas/AdminPanelDto",
1008
+ "title": "Admin Panel",
1009
+ "description": "Admin UI links, tabs, and actions provided by the integration.",
1010
+ "type": "object"
1011
+ },
1012
+ "clientPanel": {
1013
+ "$ref": "#/components/schemas/ClientPanelDto",
1014
+ "title": "Client Panel",
1015
+ "description": "Client UI links, tabs, and actions provided by the integration.",
1016
+ "type": "object"
1017
+ },
1018
+ "onboardingUrl": {
1019
+ "format": "uri",
1020
+ "type": "string",
1021
+ "title": "Onboarding URL",
1022
+ "description": "URL to onboard/configure the integration.",
1023
+ "example": "https://example.com/onboarding"
1024
+ }
1025
+ },
1026
+ "type": "object",
1027
+ "required": [
1028
+ "title",
1029
+ "supportedLanguages"
1030
+ ]
1031
+ },
1032
+ "UnitDto": {
1033
+ "properties": {
1034
+ "id": {
1035
+ "minLength": 1,
1036
+ "type": "string",
1037
+ "not": {
1038
+ "type": "null"
1039
+ },
1040
+ "title": "Unit ID",
1041
+ "description": "Unit identifier.",
1042
+ "example": "messages"
1043
+ },
1044
+ "unitDescription": {
1045
+ "minLength": 1,
1046
+ "type": "string",
1047
+ "not": {
1048
+ "type": "null"
1049
+ },
1050
+ "title": "Unit Description",
1051
+ "description": "What is measured.",
1052
+ "example": "Message sent"
1053
+ },
1054
+ "intervalDescription": {
1055
+ "minLength": 1,
1056
+ "type": "string",
1057
+ "not": {
1058
+ "type": "null"
1059
+ },
1060
+ "title": "Interval Description",
1061
+ "description": "Billing interval.",
1062
+ "example": "Per month"
1063
+ }
1064
+ },
1065
+ "type": "object",
1066
+ "required": [
1067
+ "id",
1068
+ "unitDescription",
1069
+ "intervalDescription"
1070
+ ]
1071
+ },
1072
+ "NotificationInfoDto": {
1073
+ "properties": {
1074
+ "type": {
1075
+ "not": {
1076
+ "type": "null"
1077
+ },
1078
+ "enum": [
1079
+ "email",
1080
+ "sms",
1081
+ "push"
1082
+ ],
1083
+ "type": "string",
1084
+ "title": "Notification Type",
1085
+ "description": "Notification channel type.",
1086
+ "example": "email"
1087
+ },
1088
+ "payPerUseUnits": {
1089
+ "items": {
1090
+ "$ref": "#/components/schemas/UnitDto"
1091
+ },
1092
+ "type": "array",
1093
+ "title": "Pay-Per-Use Units",
1094
+ "description": "Optional metering units for pay-per-use billing.",
1095
+ "example": [
1096
+ {
1097
+ "id": "messages",
1098
+ "unitDescription": "Message sent",
1099
+ "intervalDescription": "Per month"
1100
+ }
1101
+ ]
1102
+ },
1103
+ "title": {
1104
+ "minLength": 1,
1105
+ "type": "string",
1106
+ "title": "Title",
1107
+ "description": "Integration display title.",
1108
+ "example": "Example Product"
1109
+ },
1110
+ "logo": {
1111
+ "format": "uri",
1112
+ "type": "string",
1113
+ "title": "Logo URL",
1114
+ "description": "Public HTTPS URL for the integration logo.",
1115
+ "example": "https://cdn.example.com/logo.png"
1116
+ },
1117
+ "description": {
1118
+ "type": "string",
1119
+ "title": "Description",
1120
+ "description": "Short description of the integration.",
1121
+ "example": "An example product integration."
1122
+ },
1123
+ "supportedLanguages": {
1124
+ "items": {
1125
+ "enum": [
1126
+ "aa",
1127
+ "af",
1128
+ "ak",
1129
+ "sq",
1130
+ "am",
1131
+ "ar",
1132
+ "an",
1133
+ "hy",
1134
+ "as",
1135
+ "av",
1136
+ "ae",
1137
+ "ay",
1138
+ "az",
1139
+ "bm",
1140
+ "ba",
1141
+ "eu",
1142
+ "be",
1143
+ "bn",
1144
+ "bh",
1145
+ "bi",
1146
+ "bs",
1147
+ "br",
1148
+ "bg",
1149
+ "my",
1150
+ "ca",
1151
+ "ch",
1152
+ "ce",
1153
+ "ny",
1154
+ "zh",
1155
+ "cv",
1156
+ "kw",
1157
+ "co",
1158
+ "cr",
1159
+ "hr",
1160
+ "cs",
1161
+ "da",
1162
+ "dv",
1163
+ "nl",
1164
+ "dz",
1165
+ "en",
1166
+ "eo",
1167
+ "et",
1168
+ "ee",
1169
+ "fo",
1170
+ "fj",
1171
+ "fi",
1172
+ "fr",
1173
+ "ff",
1174
+ "gl",
1175
+ "ka",
1176
+ "de",
1177
+ "el",
1178
+ "gn",
1179
+ "gu",
1180
+ "ht",
1181
+ "ha",
1182
+ "he",
1183
+ "hz",
1184
+ "hi",
1185
+ "ho",
1186
+ "hu",
1187
+ "ia",
1188
+ "id",
1189
+ "ie",
1190
+ "ga",
1191
+ "ig",
1192
+ "ik",
1193
+ "io",
1194
+ "is",
1195
+ "it",
1196
+ "iu",
1197
+ "ja",
1198
+ "jv",
1199
+ "kl",
1200
+ "kn",
1201
+ "kr",
1202
+ "ks",
1203
+ "kk",
1204
+ "km",
1205
+ "ki",
1206
+ "rw",
1207
+ "ky",
1208
+ "kv",
1209
+ "kg",
1210
+ "ko",
1211
+ "ku",
1212
+ "kj",
1213
+ "la",
1214
+ "lb",
1215
+ "lg",
1216
+ "li",
1217
+ "ln",
1218
+ "lo",
1219
+ "lt",
1220
+ "lu",
1221
+ "lv",
1222
+ "gv",
1223
+ "mk",
1224
+ "mg",
1225
+ "ms",
1226
+ "ml",
1227
+ "mt",
1228
+ "mi",
1229
+ "mr",
1230
+ "mh",
1231
+ "mn",
1232
+ "na",
1233
+ "nv",
1234
+ "nd",
1235
+ "ne",
1236
+ "ng",
1237
+ "nb",
1238
+ "nn",
1239
+ "no",
1240
+ "ii",
1241
+ "nr",
1242
+ "oc",
1243
+ "oj",
1244
+ "cu",
1245
+ "om",
1246
+ "or",
1247
+ "os",
1248
+ "pa",
1249
+ "pi",
1250
+ "fa",
1251
+ "pl",
1252
+ "ps",
1253
+ "pt",
1254
+ "qu",
1255
+ "rm",
1256
+ "rn",
1257
+ "ro",
1258
+ "rh",
1259
+ "ru",
1260
+ "sa",
1261
+ "sc",
1262
+ "sd",
1263
+ "se",
1264
+ "sm",
1265
+ "sg",
1266
+ "sr",
1267
+ "gd",
1268
+ "sn",
1269
+ "si",
1270
+ "sk",
1271
+ "sl",
1272
+ "so",
1273
+ "st",
1274
+ "es",
1275
+ "su",
1276
+ "sw",
1277
+ "ss",
1278
+ "sv",
1279
+ "ta",
1280
+ "te",
1281
+ "tg",
1282
+ "th",
1283
+ "ti",
1284
+ "bo",
1285
+ "tk",
1286
+ "tl",
1287
+ "tn",
1288
+ "to",
1289
+ "tr",
1290
+ "ts",
1291
+ "tt",
1292
+ "tw",
1293
+ "ty",
1294
+ "ug",
1295
+ "uk",
1296
+ "ur",
1297
+ "uz",
1298
+ "ve",
1299
+ "vi",
1300
+ "vo",
1301
+ "wa",
1302
+ "cy",
1303
+ "wo",
1304
+ "fy",
1305
+ "xh",
1306
+ "yi",
1307
+ "yo",
1308
+ "za",
1309
+ "zu"
1310
+ ],
1311
+ "type": "string"
1312
+ },
1313
+ "minItems": 1,
1314
+ "type": "array",
1315
+ "not": {
1316
+ "type": "null"
1317
+ },
1318
+ "title": "Supported Languages",
1319
+ "description": "Locales supported by the integration.",
1320
+ "example": [
1321
+ "en"
1322
+ ]
1323
+ },
1324
+ "supportedActions": {
1325
+ "items": {
1326
+ "enum": [
1327
+ "create",
1328
+ "renew",
1329
+ "upgrade",
1330
+ "downgrade",
1331
+ "transfer",
1332
+ "suspend",
1333
+ "unsuspend",
1334
+ "delete"
1335
+ ],
1336
+ "type": "string"
1337
+ },
1338
+ "type": "array",
1339
+ "title": "Supported Actions",
1340
+ "description": "Actions supported by this integration."
1341
+ },
1342
+ "listenEvents": {
1343
+ "items": {
1344
+ "enum": [
1345
+ "user/created",
1346
+ "user/updated",
1347
+ "user/deleted",
1348
+ "user/banned",
1349
+ "user/unbanned",
1350
+ "user/company/access/added",
1351
+ "user/company/access/removed",
1352
+ "user/locked",
1353
+ "user/credit-balance/updated",
1354
+ "user/unlocked",
1355
+ "user/password/updated",
1356
+ "user/email/updated",
1357
+ "user/currency/updated",
1358
+ "user/invoice-contact/updated",
1359
+ "user/policy/updated",
1360
+ "user/languages/updated",
1361
+ "user/custom-price-policies/updated",
1362
+ "user/custom-addon-price-policies/updated",
1363
+ "user/custom-affiliate/added",
1364
+ "user/custom-affiliate/removed",
1365
+ "user/invoice-interval/updated",
1366
+ "user/additional-notification-email/removed",
1367
+ "user/additional-notification-email/added",
1368
+ "user/comment/added",
1369
+ "user/comment/removed",
1370
+ "user/comment/updated",
1371
+ "user/tags/updated",
1372
+ "user/setting/added",
1373
+ "user/setting/removed",
1374
+ "user/setting/updated",
1375
+ "user/start-selling",
1376
+ "user/roles/updated",
1377
+ "user/roles/added",
1378
+ "user/roles/deleted",
1379
+ "message/created",
1380
+ "message/updated",
1381
+ "message/deleted",
1382
+ "notification/sent",
1383
+ "policy/created",
1384
+ "policy/updated",
1385
+ "policy/deleted",
1386
+ "product-category/created",
1387
+ "product-category/updated",
1388
+ "product-category/deleted",
1389
+ "invoice-contact/created",
1390
+ "invoice-contact/updated",
1391
+ "invoice-contact/deleted",
1392
+ "invoice/created",
1393
+ "invoice/updated",
1394
+ "invoice/deleted",
1395
+ "currency/created",
1396
+ "currency/updated",
1397
+ "currency/deleted",
1398
+ "affiliate/created",
1399
+ "affiliate/updated",
1400
+ "affiliate/deleted",
1401
+ "company/created",
1402
+ "company/updated",
1403
+ "company/deleted",
1404
+ "organization/integration/attached",
1405
+ "organization/integration/detached",
1406
+ "tld/created",
1407
+ "tld/updated",
1408
+ "tld/deleted",
1409
+ "integration/created",
1410
+ "integration/updated",
1411
+ "integration/deleted",
1412
+ "integration/installed",
1413
+ "integration/uninstalled",
1414
+ "integration/activated",
1415
+ "integration/deactivated",
1416
+ "integration/maintenance-started",
1417
+ "integration/maintenance-finished",
1418
+ "domain-contact/created",
1419
+ "domain-contact/updated",
1420
+ "domain-contact/deleted",
1421
+ "domain-category/created",
1422
+ "domain-category/updated",
1423
+ "domain-category/deleted",
1424
+ "addon/created",
1425
+ "addon/updated",
1426
+ "addon/deleted",
1427
+ "transaction/created",
1428
+ "transaction/canceled",
1429
+ "transaction/failed",
1430
+ "transaction/subscribed",
1431
+ "transaction/unsubscribed",
1432
+ "transaction/updated",
1433
+ "transaction/deleted",
1434
+ "transaction/completed",
1435
+ "transaction/refunded",
1436
+ "template/created",
1437
+ "template/updated",
1438
+ "template/deleted",
1439
+ "coupon/created",
1440
+ "coupon/updated",
1441
+ "coupon/deleted",
1442
+ "template-integration/created",
1443
+ "template-integration/updated",
1444
+ "template-integration/deleted",
1445
+ "order/created",
1446
+ "order/status/in-progress",
1447
+ "order/status/completed",
1448
+ "order/status/canceled",
1449
+ "order/status/refunded",
1450
+ "order/insufficient-balance",
1451
+ "order/updated",
1452
+ "order/deleted",
1453
+ "setting/created",
1454
+ "setting/updated",
1455
+ "setting/deleted",
1456
+ "issue/created",
1457
+ "issue/updated",
1458
+ "issue/deleted",
1459
+ "task/created",
1460
+ "task/updated",
1461
+ "task/deleted",
1462
+ "task/canceled",
1463
+ "task/in-progress",
1464
+ "task/completed",
1465
+ "task/percentage/updated",
1466
+ "product/created",
1467
+ "product/updated",
1468
+ "product/deleted",
1469
+ "product/auto-renew/updated",
1470
+ "product/enabled",
1471
+ "product/disabled",
1472
+ "product/version-created",
1473
+ "ip-group/created",
1474
+ "ip-group/updated",
1475
+ "ip-group/deleted",
1476
+ "ip/created",
1477
+ "ip/updated",
1478
+ "ip/deleted",
1479
+ "domain-name/created",
1480
+ "domain-name/updated",
1481
+ "domain-name/deleted",
1482
+ "domain-name/locked",
1483
+ "domain-name/unlocked",
1484
+ "domain-name/idshield-activated",
1485
+ "domain-name/idshield-deactivated",
1486
+ "domain-name/bundle-added",
1487
+ "domain-name/bundle-removed",
1488
+ "domain-name/registrant-updated",
1489
+ "domain-name/admin-updated",
1490
+ "domain-name/tech-updated",
1491
+ "domain-name/billing-updated",
1492
+ "domain-name/additional-updated",
1493
+ "item/created",
1494
+ "item/updated",
1495
+ "item/deleted",
1496
+ "item/renewed",
1497
+ "item/upgraded",
1498
+ "item/downgraded",
1499
+ "item/ip-attached",
1500
+ "item/ip-detached",
1501
+ "item/detached-from-order",
1502
+ "item/postponed",
1503
+ "item/transferred-in",
1504
+ "item/canceled",
1505
+ "item/suspended",
1506
+ "item/unsuspended",
1507
+ "item/affiliate/added",
1508
+ "item/bundle/attached",
1509
+ "item/bundle/detached",
1510
+ "item/activated",
1511
+ "item/set-inactive",
1512
+ "item/processed",
1513
+ "order/paid",
1514
+ "test",
1515
+ "dead-lettering",
1516
+ "core-queue"
1517
+ ],
1518
+ "type": "string"
1519
+ },
1520
+ "minItems": 1,
1521
+ "type": "array",
1522
+ "title": "Listen Events",
1523
+ "description": "Platform events the integration can subscribe to."
1524
+ },
1525
+ "requiredRoles": {
1526
+ "items": {
1527
+ "enum": [
1528
+ "SIMPLE_USER",
1529
+ "FULL_ACCESS",
1530
+ "SUPER_ADMIN",
1531
+ "ORDER_READ",
1532
+ "ORDER_WRITE",
1533
+ "ADDON_READ",
1534
+ "ADDON_WRITE",
1535
+ "AFFILIATE_READ",
1536
+ "AFFILIATE_WRITE",
1537
+ "COMPANY_READ",
1538
+ "COMPANY_WRITE",
1539
+ "TEMPLATE_READ",
1540
+ "TEMPLATE_WRITE",
1541
+ "COUPON_READ",
1542
+ "COUPON_WRITE",
1543
+ "DOMAIN_CATEGORY_READ",
1544
+ "DOMAIN_CATEGORY_WRITE",
1545
+ "DOMAIN_CONTACT_READ",
1546
+ "DOMAIN_CONTACT_WRITE",
1547
+ "DOMAIN_NAME_READ",
1548
+ "DOMAIN_NAME_WRITE",
1549
+ "INVOICE_CONTACT_READ",
1550
+ "INVOICE_CONTACT_WRITE",
1551
+ "INVOICE_READ",
1552
+ "INVOICE_WRITE",
1553
+ "IP_GROUPS_READ",
1554
+ "IP_GROUPS_WRITE",
1555
+ "IPS_READ",
1556
+ "IPS_WRITE",
1557
+ "ITEMS_READ",
1558
+ "ITEMS_WRITE",
1559
+ "ORDERS_READ",
1560
+ "ORDERS_WRITE",
1561
+ "TRANSACTIONS_READ",
1562
+ "TRANSACTIONS_WRITE",
1563
+ "POLICIES_READ",
1564
+ "POLICIES_WRITE",
1565
+ "PRODUCT_CATEGORIES_READ",
1566
+ "PRODUCT_CATEGORIES_WRITE",
1567
+ "PRODUCTS_READ",
1568
+ "PRODUCTS_WRITE",
1569
+ "SETTINGS_READ",
1570
+ "SETTINGS_WRITE",
1571
+ "INTEGRATIONS_READ",
1572
+ "INTEGRATIONS_WRITE",
1573
+ "TLDS_READ",
1574
+ "TLDS_WRITE",
1575
+ "USERS_READ",
1576
+ "USERS_WRITE",
1577
+ "ISSUES_WRITE",
1578
+ "ISSUES_READ",
1579
+ "ACTION_LOGS_READ"
1580
+ ],
1581
+ "type": "string"
1582
+ },
1583
+ "minItems": 1,
1584
+ "type": "array",
1585
+ "title": "Required Roles",
1586
+ "description": "Roles required for this integration to operate."
1587
+ },
1588
+ "adminPanel": {
1589
+ "$ref": "#/components/schemas/AdminPanelDto",
1590
+ "title": "Admin Panel",
1591
+ "description": "Admin UI links, tabs, and actions provided by the integration.",
1592
+ "type": "object"
1593
+ },
1594
+ "clientPanel": {
1595
+ "$ref": "#/components/schemas/ClientPanelDto",
1596
+ "title": "Client Panel",
1597
+ "description": "Client UI links, tabs, and actions provided by the integration.",
1598
+ "type": "object"
1599
+ },
1600
+ "onboardingUrl": {
1601
+ "format": "uri",
1602
+ "type": "string",
1603
+ "title": "Onboarding URL",
1604
+ "description": "URL to onboard/configure the integration.",
1605
+ "example": "https://example.com/onboarding"
1606
+ }
1607
+ },
1608
+ "type": "object",
1609
+ "required": [
1610
+ "type",
1611
+ "title",
1612
+ "supportedLanguages"
1613
+ ]
1614
+ },
1615
+ "MultilangTextDto": {
1616
+ "properties": {
1617
+ "language": {
1618
+ "not": {
1619
+ "type": "null"
1620
+ },
1621
+ "enum": [
1622
+ "aa",
1623
+ "af",
1624
+ "ak",
1625
+ "sq",
1626
+ "am",
1627
+ "ar",
1628
+ "an",
1629
+ "hy",
1630
+ "as",
1631
+ "av",
1632
+ "ae",
1633
+ "ay",
1634
+ "az",
1635
+ "bm",
1636
+ "ba",
1637
+ "eu",
1638
+ "be",
1639
+ "bn",
1640
+ "bh",
1641
+ "bi",
1642
+ "bs",
1643
+ "br",
1644
+ "bg",
1645
+ "my",
1646
+ "ca",
1647
+ "ch",
1648
+ "ce",
1649
+ "ny",
1650
+ "zh",
1651
+ "cv",
1652
+ "kw",
1653
+ "co",
1654
+ "cr",
1655
+ "hr",
1656
+ "cs",
1657
+ "da",
1658
+ "dv",
1659
+ "nl",
1660
+ "dz",
1661
+ "en",
1662
+ "eo",
1663
+ "et",
1664
+ "ee",
1665
+ "fo",
1666
+ "fj",
1667
+ "fi",
1668
+ "fr",
1669
+ "ff",
1670
+ "gl",
1671
+ "ka",
1672
+ "de",
1673
+ "el",
1674
+ "gn",
1675
+ "gu",
1676
+ "ht",
1677
+ "ha",
1678
+ "he",
1679
+ "hz",
1680
+ "hi",
1681
+ "ho",
1682
+ "hu",
1683
+ "ia",
1684
+ "id",
1685
+ "ie",
1686
+ "ga",
1687
+ "ig",
1688
+ "ik",
1689
+ "io",
1690
+ "is",
1691
+ "it",
1692
+ "iu",
1693
+ "ja",
1694
+ "jv",
1695
+ "kl",
1696
+ "kn",
1697
+ "kr",
1698
+ "ks",
1699
+ "kk",
1700
+ "km",
1701
+ "ki",
1702
+ "rw",
1703
+ "ky",
1704
+ "kv",
1705
+ "kg",
1706
+ "ko",
1707
+ "ku",
1708
+ "kj",
1709
+ "la",
1710
+ "lb",
1711
+ "lg",
1712
+ "li",
1713
+ "ln",
1714
+ "lo",
1715
+ "lt",
1716
+ "lu",
1717
+ "lv",
1718
+ "gv",
1719
+ "mk",
1720
+ "mg",
1721
+ "ms",
1722
+ "ml",
1723
+ "mt",
1724
+ "mi",
1725
+ "mr",
1726
+ "mh",
1727
+ "mn",
1728
+ "na",
1729
+ "nv",
1730
+ "nd",
1731
+ "ne",
1732
+ "ng",
1733
+ "nb",
1734
+ "nn",
1735
+ "no",
1736
+ "ii",
1737
+ "nr",
1738
+ "oc",
1739
+ "oj",
1740
+ "cu",
1741
+ "om",
1742
+ "or",
1743
+ "os",
1744
+ "pa",
1745
+ "pi",
1746
+ "fa",
1747
+ "pl",
1748
+ "ps",
1749
+ "pt",
1750
+ "qu",
1751
+ "rm",
1752
+ "rn",
1753
+ "ro",
1754
+ "rh",
1755
+ "ru",
1756
+ "sa",
1757
+ "sc",
1758
+ "sd",
1759
+ "se",
1760
+ "sm",
1761
+ "sg",
1762
+ "sr",
1763
+ "gd",
1764
+ "sn",
1765
+ "si",
1766
+ "sk",
1767
+ "sl",
1768
+ "so",
1769
+ "st",
1770
+ "es",
1771
+ "su",
1772
+ "sw",
1773
+ "ss",
1774
+ "sv",
1775
+ "ta",
1776
+ "te",
1777
+ "tg",
1778
+ "th",
1779
+ "ti",
1780
+ "bo",
1781
+ "tk",
1782
+ "tl",
1783
+ "tn",
1784
+ "to",
1785
+ "tr",
1786
+ "ts",
1787
+ "tt",
1788
+ "tw",
1789
+ "ty",
1790
+ "ug",
1791
+ "uk",
1792
+ "ur",
1793
+ "uz",
1794
+ "ve",
1795
+ "vi",
1796
+ "vo",
1797
+ "wa",
1798
+ "cy",
1799
+ "wo",
1800
+ "fy",
1801
+ "xh",
1802
+ "yi",
1803
+ "yo",
1804
+ "za",
1805
+ "zu"
1806
+ ],
1807
+ "type": "string"
1808
+ },
1809
+ "text": {
1810
+ "minLength": 1,
1811
+ "type": "string"
1812
+ }
1813
+ },
1814
+ "type": "object",
1815
+ "required": [
1816
+ "language",
1817
+ "text"
1818
+ ]
1819
+ },
1820
+ "FieldOptionDto": {
1821
+ "properties": {
1822
+ "key": {
1823
+ "not": {
1824
+ "type": "null"
1825
+ },
1826
+ "type": "string",
1827
+ "title": "Key",
1828
+ "description": "Internal key for the option."
1829
+ },
1830
+ "value": {
1831
+ "not": {
1832
+ "type": "null"
1833
+ },
1834
+ "type": "string",
1835
+ "title": "Value",
1836
+ "description": "Display value for the option."
1837
+ },
1838
+ "disabled": {
1839
+ "type": "boolean",
1840
+ "title": "Disabled",
1841
+ "description": "Whether the option is disabled."
1842
+ }
1843
+ },
1844
+ "type": "object",
1845
+ "required": [
1846
+ "key",
1847
+ "value"
1848
+ ]
1849
+ },
1850
+ "FieldDto": {
1851
+ "properties": {
1852
+ "id": {
1853
+ "not": {
1854
+ "type": "null"
1855
+ },
1856
+ "type": "string",
1857
+ "title": "ID",
1858
+ "description": "Unique identifier for the field."
1859
+ },
1860
+ "label": {
1861
+ "items": {
1862
+ "$ref": "#/components/schemas/MultilangTextDto"
1863
+ },
1864
+ "minItems": 1,
1865
+ "type": "array",
1866
+ "title": "Label",
1867
+ "description": "Multilingual label for the field."
1868
+ },
1869
+ "value": {
1870
+ "not": {
1871
+ "type": "null"
1872
+ },
1873
+ "title": "Value",
1874
+ "description": "Value of the field. String/Number, or FieldOptionDto/FieldOptionDto[] depending on type.",
1875
+ "oneOf": [
1876
+ {
1877
+ "title": "String",
1878
+ "type": "string"
1879
+ },
1880
+ {
1881
+ "title": "Number",
1882
+ "type": "number"
1883
+ },
1884
+ {
1885
+ "title": "Option",
1886
+ "$ref": "#/components/schemas/FieldOptionDto"
1887
+ },
1888
+ {
1889
+ "title": "Options Array",
1890
+ "type": "array",
1891
+ "items": {
1892
+ "$ref": "#/components/schemas/FieldOptionDto"
1893
+ }
1894
+ }
1895
+ ]
1896
+ },
1897
+ "type": {
1898
+ "not": {
1899
+ "type": "null"
1900
+ },
1901
+ "enum": [
1902
+ "TEXT_BOX",
1903
+ "TEXT_AREA",
1904
+ "SELECT",
1905
+ "MULTI_SELECT",
1906
+ "DESCRIPTION",
1907
+ "RADIO_BOX",
1908
+ "CHECKBOX",
1909
+ "SLIDER"
1910
+ ],
1911
+ "type": "string",
1912
+ "title": "Field Type",
1913
+ "description": "Type of the field."
1914
+ },
1915
+ "reapetableMin": {
1916
+ "type": "number"
1917
+ },
1918
+ "reapetableMax": {
1919
+ "type": "number"
1920
+ },
1921
+ "required": {
1922
+ "not": {
1923
+ "type": "null"
1924
+ },
1925
+ "type": "boolean",
1926
+ "title": "Required",
1927
+ "description": "Whether the field is required."
1928
+ },
1929
+ "disabled": {
1930
+ "not": {
1931
+ "type": "null"
1932
+ },
1933
+ "type": "boolean",
1934
+ "title": "Disabled",
1935
+ "description": "Whether the field is disabled."
1936
+ },
1937
+ "hidden": {
1938
+ "not": {
1939
+ "type": "null"
1940
+ },
1941
+ "type": "boolean",
1942
+ "title": "Hidden",
1943
+ "description": "Whether the field is hidden."
1944
+ },
1945
+ "regexValidation": {
1946
+ "type": "string",
1947
+ "title": "Regex Validation",
1948
+ "description": "Optional regex to validate input.",
1949
+ "example": "^[A-Za-z0-9_-]+$"
1950
+ },
1951
+ "regexValidationErrorMessage": {
1952
+ "items": {
1953
+ "$ref": "#/components/schemas/MultilangTextDto"
1954
+ },
1955
+ "type": "array",
1956
+ "title": "Regex Validation Error Message",
1957
+ "description": "Localized error message shown when regex validation fails."
1958
+ },
1959
+ "triggersRemoteValidation": {
1960
+ "type": "boolean",
1961
+ "title": "Triggers Remote Validation",
1962
+ "description": "If true, field triggers remote validation."
1963
+ },
1964
+ "remoteValidationErrorMessage": {
1965
+ "items": {
1966
+ "$ref": "#/components/schemas/MultilangTextDto"
1967
+ },
1968
+ "type": "array",
1969
+ "title": "Remote Validation Error Message",
1970
+ "description": "Localized error messages for remote validation."
1971
+ },
1972
+ "upgradable": {
1973
+ "not": {
1974
+ "type": "null"
1975
+ },
1976
+ "type": "boolean",
1977
+ "title": "Upgradable",
1978
+ "description": "Whether the item attribute is upgradable by the user."
1979
+ }
1980
+ },
1981
+ "type": "object",
1982
+ "required": [
1983
+ "id",
1984
+ "label",
1985
+ "value",
1986
+ "type",
1987
+ "required",
1988
+ "disabled",
1989
+ "hidden",
1990
+ "upgradable"
1991
+ ]
1992
+ },
1993
+ "ProductInfoDto": {
1994
+ "properties": {
1995
+ "productAttributes": {
1996
+ "items": {
1997
+ "$ref": "#/components/schemas/FieldDto"
1998
+ },
1999
+ "type": "array",
2000
+ "minItems": 1,
2001
+ "title": "Product Attributes",
2002
+ "description": "Configurable attributes that apply at the product level."
2003
+ },
2004
+ "itemAttributes": {
2005
+ "items": {
2006
+ "$ref": "#/components/schemas/FieldDto"
2007
+ },
2008
+ "type": "array",
2009
+ "minItems": 1,
2010
+ "title": "Item Attributes",
2011
+ "description": "Configurable attributes that apply at the item level."
2012
+ },
2013
+ "payPerUseUnits": {
2014
+ "items": {
2015
+ "$ref": "#/components/schemas/UnitDto"
2016
+ },
2017
+ "type": "array",
2018
+ "minItems": 1,
2019
+ "title": "Pay-Per-Use Units",
2020
+ "description": "Optional metering units for pay-per-use billing.",
2021
+ "example": [
2022
+ {
2023
+ "id": "requests",
2024
+ "unitDescription": "API request",
2025
+ "intervalDescription": "Per month"
2026
+ }
2027
+ ]
2028
+ },
2029
+ "responseDataFieldNames": {
2030
+ "title": "Response Data Field Names",
2031
+ "description": "Mapping of field names used in provider responses.",
2032
+ "type": "object",
2033
+ "additionalProperties": {
2034
+ "type": "string"
2035
+ },
2036
+ "example": {
2037
+ "external_id": "id",
2038
+ "status_text": "status"
2039
+ }
2040
+ },
2041
+ "title": {
2042
+ "minLength": 1,
2043
+ "type": "string",
2044
+ "title": "Title",
2045
+ "description": "Integration display title.",
2046
+ "example": "Example Product"
2047
+ },
2048
+ "logo": {
2049
+ "format": "uri",
2050
+ "type": "string",
2051
+ "title": "Logo URL",
2052
+ "description": "Public HTTPS URL for the integration logo.",
2053
+ "example": "https://cdn.example.com/logo.png"
2054
+ },
2055
+ "description": {
2056
+ "type": "string",
2057
+ "title": "Description",
2058
+ "description": "Short description of the integration.",
2059
+ "example": "An example product integration."
2060
+ },
2061
+ "supportedLanguages": {
2062
+ "items": {
2063
+ "enum": [
2064
+ "aa",
2065
+ "af",
2066
+ "ak",
2067
+ "sq",
2068
+ "am",
2069
+ "ar",
2070
+ "an",
2071
+ "hy",
2072
+ "as",
2073
+ "av",
2074
+ "ae",
2075
+ "ay",
2076
+ "az",
2077
+ "bm",
2078
+ "ba",
2079
+ "eu",
2080
+ "be",
2081
+ "bn",
2082
+ "bh",
2083
+ "bi",
2084
+ "bs",
2085
+ "br",
2086
+ "bg",
2087
+ "my",
2088
+ "ca",
2089
+ "ch",
2090
+ "ce",
2091
+ "ny",
2092
+ "zh",
2093
+ "cv",
2094
+ "kw",
2095
+ "co",
2096
+ "cr",
2097
+ "hr",
2098
+ "cs",
2099
+ "da",
2100
+ "dv",
2101
+ "nl",
2102
+ "dz",
2103
+ "en",
2104
+ "eo",
2105
+ "et",
2106
+ "ee",
2107
+ "fo",
2108
+ "fj",
2109
+ "fi",
2110
+ "fr",
2111
+ "ff",
2112
+ "gl",
2113
+ "ka",
2114
+ "de",
2115
+ "el",
2116
+ "gn",
2117
+ "gu",
2118
+ "ht",
2119
+ "ha",
2120
+ "he",
2121
+ "hz",
2122
+ "hi",
2123
+ "ho",
2124
+ "hu",
2125
+ "ia",
2126
+ "id",
2127
+ "ie",
2128
+ "ga",
2129
+ "ig",
2130
+ "ik",
2131
+ "io",
2132
+ "is",
2133
+ "it",
2134
+ "iu",
2135
+ "ja",
2136
+ "jv",
2137
+ "kl",
2138
+ "kn",
2139
+ "kr",
2140
+ "ks",
2141
+ "kk",
2142
+ "km",
2143
+ "ki",
2144
+ "rw",
2145
+ "ky",
2146
+ "kv",
2147
+ "kg",
2148
+ "ko",
2149
+ "ku",
2150
+ "kj",
2151
+ "la",
2152
+ "lb",
2153
+ "lg",
2154
+ "li",
2155
+ "ln",
2156
+ "lo",
2157
+ "lt",
2158
+ "lu",
2159
+ "lv",
2160
+ "gv",
2161
+ "mk",
2162
+ "mg",
2163
+ "ms",
2164
+ "ml",
2165
+ "mt",
2166
+ "mi",
2167
+ "mr",
2168
+ "mh",
2169
+ "mn",
2170
+ "na",
2171
+ "nv",
2172
+ "nd",
2173
+ "ne",
2174
+ "ng",
2175
+ "nb",
2176
+ "nn",
2177
+ "no",
2178
+ "ii",
2179
+ "nr",
2180
+ "oc",
2181
+ "oj",
2182
+ "cu",
2183
+ "om",
2184
+ "or",
2185
+ "os",
2186
+ "pa",
2187
+ "pi",
2188
+ "fa",
2189
+ "pl",
2190
+ "ps",
2191
+ "pt",
2192
+ "qu",
2193
+ "rm",
2194
+ "rn",
2195
+ "ro",
2196
+ "rh",
2197
+ "ru",
2198
+ "sa",
2199
+ "sc",
2200
+ "sd",
2201
+ "se",
2202
+ "sm",
2203
+ "sg",
2204
+ "sr",
2205
+ "gd",
2206
+ "sn",
2207
+ "si",
2208
+ "sk",
2209
+ "sl",
2210
+ "so",
2211
+ "st",
2212
+ "es",
2213
+ "su",
2214
+ "sw",
2215
+ "ss",
2216
+ "sv",
2217
+ "ta",
2218
+ "te",
2219
+ "tg",
2220
+ "th",
2221
+ "ti",
2222
+ "bo",
2223
+ "tk",
2224
+ "tl",
2225
+ "tn",
2226
+ "to",
2227
+ "tr",
2228
+ "ts",
2229
+ "tt",
2230
+ "tw",
2231
+ "ty",
2232
+ "ug",
2233
+ "uk",
2234
+ "ur",
2235
+ "uz",
2236
+ "ve",
2237
+ "vi",
2238
+ "vo",
2239
+ "wa",
2240
+ "cy",
2241
+ "wo",
2242
+ "fy",
2243
+ "xh",
2244
+ "yi",
2245
+ "yo",
2246
+ "za",
2247
+ "zu"
2248
+ ],
2249
+ "type": "string"
2250
+ },
2251
+ "minItems": 1,
2252
+ "type": "array",
2253
+ "not": {
2254
+ "type": "null"
2255
+ },
2256
+ "title": "Supported Languages",
2257
+ "description": "Locales supported by the integration.",
2258
+ "example": [
2259
+ "en"
2260
+ ]
2261
+ },
2262
+ "supportedActions": {
2263
+ "items": {
2264
+ "enum": [
2265
+ "create",
2266
+ "renew",
2267
+ "upgrade",
2268
+ "downgrade",
2269
+ "transfer",
2270
+ "suspend",
2271
+ "unsuspend",
2272
+ "delete"
2273
+ ],
2274
+ "type": "string"
2275
+ },
2276
+ "type": "array",
2277
+ "title": "Supported Actions",
2278
+ "description": "Actions supported by this integration."
2279
+ },
2280
+ "listenEvents": {
2281
+ "items": {
2282
+ "enum": [
2283
+ "user/created",
2284
+ "user/updated",
2285
+ "user/deleted",
2286
+ "user/banned",
2287
+ "user/unbanned",
2288
+ "user/company/access/added",
2289
+ "user/company/access/removed",
2290
+ "user/locked",
2291
+ "user/credit-balance/updated",
2292
+ "user/unlocked",
2293
+ "user/password/updated",
2294
+ "user/email/updated",
2295
+ "user/currency/updated",
2296
+ "user/invoice-contact/updated",
2297
+ "user/policy/updated",
2298
+ "user/languages/updated",
2299
+ "user/custom-price-policies/updated",
2300
+ "user/custom-addon-price-policies/updated",
2301
+ "user/custom-affiliate/added",
2302
+ "user/custom-affiliate/removed",
2303
+ "user/invoice-interval/updated",
2304
+ "user/additional-notification-email/removed",
2305
+ "user/additional-notification-email/added",
2306
+ "user/comment/added",
2307
+ "user/comment/removed",
2308
+ "user/comment/updated",
2309
+ "user/tags/updated",
2310
+ "user/setting/added",
2311
+ "user/setting/removed",
2312
+ "user/setting/updated",
2313
+ "user/start-selling",
2314
+ "user/roles/updated",
2315
+ "user/roles/added",
2316
+ "user/roles/deleted",
2317
+ "message/created",
2318
+ "message/updated",
2319
+ "message/deleted",
2320
+ "notification/sent",
2321
+ "policy/created",
2322
+ "policy/updated",
2323
+ "policy/deleted",
2324
+ "product-category/created",
2325
+ "product-category/updated",
2326
+ "product-category/deleted",
2327
+ "invoice-contact/created",
2328
+ "invoice-contact/updated",
2329
+ "invoice-contact/deleted",
2330
+ "invoice/created",
2331
+ "invoice/updated",
2332
+ "invoice/deleted",
2333
+ "currency/created",
2334
+ "currency/updated",
2335
+ "currency/deleted",
2336
+ "affiliate/created",
2337
+ "affiliate/updated",
2338
+ "affiliate/deleted",
2339
+ "company/created",
2340
+ "company/updated",
2341
+ "company/deleted",
2342
+ "organization/integration/attached",
2343
+ "organization/integration/detached",
2344
+ "tld/created",
2345
+ "tld/updated",
2346
+ "tld/deleted",
2347
+ "integration/created",
2348
+ "integration/updated",
2349
+ "integration/deleted",
2350
+ "integration/installed",
2351
+ "integration/uninstalled",
2352
+ "integration/activated",
2353
+ "integration/deactivated",
2354
+ "integration/maintenance-started",
2355
+ "integration/maintenance-finished",
2356
+ "domain-contact/created",
2357
+ "domain-contact/updated",
2358
+ "domain-contact/deleted",
2359
+ "domain-category/created",
2360
+ "domain-category/updated",
2361
+ "domain-category/deleted",
2362
+ "addon/created",
2363
+ "addon/updated",
2364
+ "addon/deleted",
2365
+ "transaction/created",
2366
+ "transaction/canceled",
2367
+ "transaction/failed",
2368
+ "transaction/subscribed",
2369
+ "transaction/unsubscribed",
2370
+ "transaction/updated",
2371
+ "transaction/deleted",
2372
+ "transaction/completed",
2373
+ "transaction/refunded",
2374
+ "template/created",
2375
+ "template/updated",
2376
+ "template/deleted",
2377
+ "coupon/created",
2378
+ "coupon/updated",
2379
+ "coupon/deleted",
2380
+ "template-integration/created",
2381
+ "template-integration/updated",
2382
+ "template-integration/deleted",
2383
+ "order/created",
2384
+ "order/status/in-progress",
2385
+ "order/status/completed",
2386
+ "order/status/canceled",
2387
+ "order/status/refunded",
2388
+ "order/insufficient-balance",
2389
+ "order/updated",
2390
+ "order/deleted",
2391
+ "setting/created",
2392
+ "setting/updated",
2393
+ "setting/deleted",
2394
+ "issue/created",
2395
+ "issue/updated",
2396
+ "issue/deleted",
2397
+ "task/created",
2398
+ "task/updated",
2399
+ "task/deleted",
2400
+ "task/canceled",
2401
+ "task/in-progress",
2402
+ "task/completed",
2403
+ "task/percentage/updated",
2404
+ "product/created",
2405
+ "product/updated",
2406
+ "product/deleted",
2407
+ "product/auto-renew/updated",
2408
+ "product/enabled",
2409
+ "product/disabled",
2410
+ "product/version-created",
2411
+ "ip-group/created",
2412
+ "ip-group/updated",
2413
+ "ip-group/deleted",
2414
+ "ip/created",
2415
+ "ip/updated",
2416
+ "ip/deleted",
2417
+ "domain-name/created",
2418
+ "domain-name/updated",
2419
+ "domain-name/deleted",
2420
+ "domain-name/locked",
2421
+ "domain-name/unlocked",
2422
+ "domain-name/idshield-activated",
2423
+ "domain-name/idshield-deactivated",
2424
+ "domain-name/bundle-added",
2425
+ "domain-name/bundle-removed",
2426
+ "domain-name/registrant-updated",
2427
+ "domain-name/admin-updated",
2428
+ "domain-name/tech-updated",
2429
+ "domain-name/billing-updated",
2430
+ "domain-name/additional-updated",
2431
+ "item/created",
2432
+ "item/updated",
2433
+ "item/deleted",
2434
+ "item/renewed",
2435
+ "item/upgraded",
2436
+ "item/downgraded",
2437
+ "item/ip-attached",
2438
+ "item/ip-detached",
2439
+ "item/detached-from-order",
2440
+ "item/postponed",
2441
+ "item/transferred-in",
2442
+ "item/canceled",
2443
+ "item/suspended",
2444
+ "item/unsuspended",
2445
+ "item/affiliate/added",
2446
+ "item/bundle/attached",
2447
+ "item/bundle/detached",
2448
+ "item/activated",
2449
+ "item/set-inactive",
2450
+ "item/processed",
2451
+ "order/paid",
2452
+ "test",
2453
+ "dead-lettering",
2454
+ "core-queue"
2455
+ ],
2456
+ "type": "string"
2457
+ },
2458
+ "minItems": 1,
2459
+ "type": "array",
2460
+ "title": "Listen Events",
2461
+ "description": "Platform events the integration can subscribe to."
2462
+ },
2463
+ "requiredRoles": {
2464
+ "items": {
2465
+ "enum": [
2466
+ "SIMPLE_USER",
2467
+ "FULL_ACCESS",
2468
+ "SUPER_ADMIN",
2469
+ "ORDER_READ",
2470
+ "ORDER_WRITE",
2471
+ "ADDON_READ",
2472
+ "ADDON_WRITE",
2473
+ "AFFILIATE_READ",
2474
+ "AFFILIATE_WRITE",
2475
+ "COMPANY_READ",
2476
+ "COMPANY_WRITE",
2477
+ "TEMPLATE_READ",
2478
+ "TEMPLATE_WRITE",
2479
+ "COUPON_READ",
2480
+ "COUPON_WRITE",
2481
+ "DOMAIN_CATEGORY_READ",
2482
+ "DOMAIN_CATEGORY_WRITE",
2483
+ "DOMAIN_CONTACT_READ",
2484
+ "DOMAIN_CONTACT_WRITE",
2485
+ "DOMAIN_NAME_READ",
2486
+ "DOMAIN_NAME_WRITE",
2487
+ "INVOICE_CONTACT_READ",
2488
+ "INVOICE_CONTACT_WRITE",
2489
+ "INVOICE_READ",
2490
+ "INVOICE_WRITE",
2491
+ "IP_GROUPS_READ",
2492
+ "IP_GROUPS_WRITE",
2493
+ "IPS_READ",
2494
+ "IPS_WRITE",
2495
+ "ITEMS_READ",
2496
+ "ITEMS_WRITE",
2497
+ "ORDERS_READ",
2498
+ "ORDERS_WRITE",
2499
+ "TRANSACTIONS_READ",
2500
+ "TRANSACTIONS_WRITE",
2501
+ "POLICIES_READ",
2502
+ "POLICIES_WRITE",
2503
+ "PRODUCT_CATEGORIES_READ",
2504
+ "PRODUCT_CATEGORIES_WRITE",
2505
+ "PRODUCTS_READ",
2506
+ "PRODUCTS_WRITE",
2507
+ "SETTINGS_READ",
2508
+ "SETTINGS_WRITE",
2509
+ "INTEGRATIONS_READ",
2510
+ "INTEGRATIONS_WRITE",
2511
+ "TLDS_READ",
2512
+ "TLDS_WRITE",
2513
+ "USERS_READ",
2514
+ "USERS_WRITE",
2515
+ "ISSUES_WRITE",
2516
+ "ISSUES_READ",
2517
+ "ACTION_LOGS_READ"
2518
+ ],
2519
+ "type": "string"
2520
+ },
2521
+ "minItems": 1,
2522
+ "type": "array",
2523
+ "title": "Required Roles",
2524
+ "description": "Roles required for this integration to operate."
2525
+ },
2526
+ "adminPanel": {
2527
+ "$ref": "#/components/schemas/AdminPanelDto",
2528
+ "title": "Admin Panel",
2529
+ "description": "Admin UI links, tabs, and actions provided by the integration.",
2530
+ "type": "object"
2531
+ },
2532
+ "clientPanel": {
2533
+ "$ref": "#/components/schemas/ClientPanelDto",
2534
+ "title": "Client Panel",
2535
+ "description": "Client UI links, tabs, and actions provided by the integration.",
2536
+ "type": "object"
2537
+ },
2538
+ "onboardingUrl": {
2539
+ "format": "uri",
2540
+ "type": "string",
2541
+ "title": "Onboarding URL",
2542
+ "description": "URL to onboard/configure the integration.",
2543
+ "example": "https://example.com/onboarding"
2544
+ }
2545
+ },
2546
+ "type": "object",
2547
+ "required": [
2548
+ "title",
2549
+ "supportedLanguages"
2550
+ ]
2551
+ }
2552
+ };