@hosterai/types 0.0.21 → 0.0.23

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 (56) hide show
  1. package/README.md +29 -2
  2. package/dist/dtos/field.dto.d.ts +8 -4
  3. package/dist/dtos/field.dto.js +17 -7
  4. package/dist/dtos/info/info-notification.dto.d.ts +5 -0
  5. package/dist/dtos/info/info-notification.dto.js +7 -0
  6. package/dist/dtos/info/info.dto.d.ts +196 -0
  7. package/dist/dtos/info/info.dto.js +278 -0
  8. package/dist/dtos/info.dto.d.ts +2 -0
  9. package/dist/dtos/info.dto.js +17 -0
  10. package/dist/dtos/notification/notification-info.dto.js +7 -3
  11. package/dist/dtos/notification/notification-request.dto.d.ts +20 -0
  12. package/dist/dtos/notification/notification-request.dto.js +31 -0
  13. package/dist/dtos/product/product.interface.d.ts +4 -4
  14. package/dist/dtos/receiver/receiver-email.dto.d.ts +20 -0
  15. package/dist/dtos/receiver/receiver-email.dto.js +39 -0
  16. package/dist/dtos/receiver/receiver-push.dto.d.ts +15 -0
  17. package/dist/dtos/receiver/receiver-push.dto.js +31 -0
  18. package/dist/dtos/receiver/receiver-sms.dto.d.ts +11 -0
  19. package/dist/dtos/receiver/receiver-sms.dto.js +26 -0
  20. package/dist/dtos/request.dto.d.ts +20 -0
  21. package/dist/dtos/request.dto.js +31 -0
  22. package/dist/dtos/requests/validate-attributes-request.dto.d.ts +18 -0
  23. package/dist/dtos/{product/requests/product-upgradeable-request.dto.js → requests/validate-attributes-request.dto.js} +11 -17
  24. package/dist/dtos/responses/validate-attributes-response.dto.d.ts +13 -0
  25. package/dist/dtos/responses/validate-attributes-response.dto.js +11 -0
  26. package/dist/dtos/sender/sender-email.dto.d.ts +25 -0
  27. package/dist/dtos/sender/sender-email.dto.js +46 -0
  28. package/dist/dtos/sender/sender-push.dto.d.ts +31 -0
  29. package/dist/dtos/sender/sender-push.dto.js +50 -0
  30. package/dist/dtos/sender/sender-sms.dto.d.ts +15 -0
  31. package/dist/dtos/sender/sender-sms.dto.js +30 -0
  32. package/dist/enums/actions.enum.d.ts +1 -0
  33. package/dist/enums/actions.enum.js +1 -0
  34. package/dist/enums/message-type.enum.d.ts +5 -0
  35. package/dist/enums/message-type.enum.js +9 -0
  36. package/dist/index.d.ts +2 -4
  37. package/dist/index.js +4 -4
  38. package/dist/openapi/schemas/components.schemas.d.ts +166 -221
  39. package/dist/openapi/schemas/components.schemas.js +549 -600
  40. package/dist/validators/field-validator.spec.js +11 -10
  41. package/dist/validators/product-info-validator.spec.js +18 -13
  42. package/dist/validators/product-validate-attributes-request-validator.d.ts +1 -1
  43. package/dist/validators/product-validate-attributes-request-validator.js +5 -5
  44. package/dist/validators/product-validate-attributes-request-validator.spec.js +3 -3
  45. package/package.json +1 -1
  46. package/dist/dtos/product/requests/product-downgradeable-request.dto.d.ts +0 -18
  47. package/dist/dtos/product/requests/product-downgradeable-request.dto.js +0 -37
  48. package/dist/dtos/product/requests/product-upgradeable-request.dto.d.ts +0 -18
  49. package/dist/dtos/product/responses/product-downgradeable-response.dto.d.ts +0 -22
  50. package/dist/dtos/product/responses/product-downgradeable-response.dto.js +0 -11
  51. package/dist/dtos/product/responses/product-upgradeable-response.dto.d.ts +0 -22
  52. package/dist/dtos/product/responses/product-upgradeable-response.dto.js +0 -11
  53. package/dist/validators/product-downgradeable-request-validator.d.ts +0 -8
  54. package/dist/validators/product-downgradeable-request-validator.js +0 -17
  55. package/dist/validators/product-upgradeable-request-validator.d.ts +0 -8
  56. package/dist/validators/product-upgradeable-request-validator.js +0 -17
@@ -141,9 +141,6 @@ exports.ComponentsSchemas = {
141
141
  "$ref": "#/components/schemas/TabDto"
142
142
  },
143
143
  "type": "array",
144
- "not": {
145
- "type": "null"
146
- },
147
144
  "title": "Submenu",
148
145
  "description": "List of tabs that will appear in the submenu."
149
146
  },
@@ -174,24 +171,15 @@ exports.ComponentsSchemas = {
174
171
  "label": {
175
172
  "minLength": 1,
176
173
  "type": "string",
177
- "not": {
178
- "type": "null"
179
- },
180
174
  "title": "Label",
181
175
  "description": "Label of the settings page."
182
176
  },
183
177
  "icon": {
184
- "not": {
185
- "type": "null"
186
- },
187
178
  "type": "string",
188
179
  "title": "Icon",
189
180
  "description": "Icon of the settings page."
190
181
  },
191
182
  "description": {
192
- "not": {
193
- "type": "null"
194
- },
195
183
  "type": "string",
196
184
  "title": "Description",
197
185
  "description": "Description of the settings page."
@@ -213,24 +201,15 @@ exports.ComponentsSchemas = {
213
201
  "label": {
214
202
  "minLength": 1,
215
203
  "type": "string",
216
- "not": {
217
- "type": "null"
218
- },
219
204
  "title": "Label",
220
205
  "description": "Label of the settings page."
221
206
  },
222
207
  "icon": {
223
- "not": {
224
- "type": "null"
225
- },
226
208
  "type": "string",
227
209
  "title": "Icon",
228
210
  "description": "Icon of the settings page."
229
211
  },
230
212
  "description": {
231
- "not": {
232
- "type": "null"
233
- },
234
213
  "type": "string",
235
214
  "title": "Description",
236
215
  "description": "Description of the settings page."
@@ -258,24 +237,15 @@ exports.ComponentsSchemas = {
258
237
  "label": {
259
238
  "minLength": 1,
260
239
  "type": "string",
261
- "not": {
262
- "type": "null"
263
- },
264
240
  "title": "Label",
265
241
  "description": "Label of the settings page."
266
242
  },
267
243
  "icon": {
268
- "not": {
269
- "type": "null"
270
- },
271
244
  "type": "string",
272
245
  "title": "Icon",
273
246
  "description": "Icon of the settings page."
274
247
  },
275
248
  "description": {
276
- "not": {
277
- "type": "null"
278
- },
279
249
  "type": "string",
280
250
  "title": "Description",
281
251
  "description": "Description of the settings page."
@@ -338,8 +308,7 @@ exports.ComponentsSchemas = {
338
308
  "description": "Tabs shown on the order page in Admin panel."
339
309
  }
340
310
  },
341
- "type": "object",
342
- "required": []
311
+ "type": "object"
343
312
  },
344
313
  "AdminPanelMoreActionsDto": {
345
314
  "properties": {
@@ -389,8 +358,7 @@ exports.ComponentsSchemas = {
389
358
  "description": "Additional actions available on the order page."
390
359
  }
391
360
  },
392
- "type": "object",
393
- "required": []
361
+ "type": "object"
394
362
  },
395
363
  "AdminPanelDto": {
396
364
  "properties": {
@@ -443,8 +411,7 @@ exports.ComponentsSchemas = {
443
411
  ]
444
412
  }
445
413
  },
446
- "type": "object",
447
- "required": []
414
+ "type": "object"
448
415
  },
449
416
  "ClientPanelTabsDto": {
450
417
  "properties": {
@@ -458,8 +425,7 @@ exports.ComponentsSchemas = {
458
425
  "description": "Tabs shown on the item page in Client panel."
459
426
  }
460
427
  },
461
- "type": "object",
462
- "required": []
428
+ "type": "object"
463
429
  },
464
430
  "ClientPanelMoreActionsDto": {
465
431
  "properties": {
@@ -473,8 +439,7 @@ exports.ComponentsSchemas = {
473
439
  "description": "Additional actions available on the item page in Client panel."
474
440
  }
475
441
  },
476
- "type": "object",
477
- "required": []
442
+ "type": "object"
478
443
  },
479
444
  "ClientPanelDto": {
480
445
  "properties": {
@@ -513,32 +478,385 @@ exports.ComponentsSchemas = {
513
478
  ]
514
479
  }
515
480
  },
516
- "type": "object",
517
- "required": []
481
+ "type": "object"
518
482
  },
519
- "InfoDto": {
483
+ "MultilangTextDto": {
520
484
  "properties": {
521
- "title": {
485
+ "language": {
486
+ "enum": [
487
+ "aa",
488
+ "af",
489
+ "ak",
490
+ "sq",
491
+ "am",
492
+ "ar",
493
+ "an",
494
+ "hy",
495
+ "as",
496
+ "av",
497
+ "ae",
498
+ "ay",
499
+ "az",
500
+ "bm",
501
+ "ba",
502
+ "eu",
503
+ "be",
504
+ "bn",
505
+ "bh",
506
+ "bi",
507
+ "bs",
508
+ "br",
509
+ "bg",
510
+ "my",
511
+ "ca",
512
+ "ch",
513
+ "ce",
514
+ "ny",
515
+ "zh",
516
+ "cv",
517
+ "kw",
518
+ "co",
519
+ "cr",
520
+ "hr",
521
+ "cs",
522
+ "da",
523
+ "dv",
524
+ "nl",
525
+ "dz",
526
+ "en",
527
+ "eo",
528
+ "et",
529
+ "ee",
530
+ "fo",
531
+ "fj",
532
+ "fi",
533
+ "fr",
534
+ "ff",
535
+ "gl",
536
+ "ka",
537
+ "de",
538
+ "el",
539
+ "gn",
540
+ "gu",
541
+ "ht",
542
+ "ha",
543
+ "he",
544
+ "hz",
545
+ "hi",
546
+ "ho",
547
+ "hu",
548
+ "ia",
549
+ "id",
550
+ "ie",
551
+ "ga",
552
+ "ig",
553
+ "ik",
554
+ "io",
555
+ "is",
556
+ "it",
557
+ "iu",
558
+ "ja",
559
+ "jv",
560
+ "kl",
561
+ "kn",
562
+ "kr",
563
+ "ks",
564
+ "kk",
565
+ "km",
566
+ "ki",
567
+ "rw",
568
+ "ky",
569
+ "kv",
570
+ "kg",
571
+ "ko",
572
+ "ku",
573
+ "kj",
574
+ "la",
575
+ "lb",
576
+ "lg",
577
+ "li",
578
+ "ln",
579
+ "lo",
580
+ "lt",
581
+ "lu",
582
+ "lv",
583
+ "gv",
584
+ "mk",
585
+ "mg",
586
+ "ms",
587
+ "ml",
588
+ "mt",
589
+ "mi",
590
+ "mr",
591
+ "mh",
592
+ "mn",
593
+ "na",
594
+ "nv",
595
+ "nd",
596
+ "ne",
597
+ "ng",
598
+ "nb",
599
+ "nn",
600
+ "no",
601
+ "ii",
602
+ "nr",
603
+ "oc",
604
+ "oj",
605
+ "cu",
606
+ "om",
607
+ "or",
608
+ "os",
609
+ "pa",
610
+ "pi",
611
+ "fa",
612
+ "pl",
613
+ "ps",
614
+ "pt",
615
+ "qu",
616
+ "rm",
617
+ "rn",
618
+ "ro",
619
+ "rh",
620
+ "ru",
621
+ "sa",
622
+ "sc",
623
+ "sd",
624
+ "se",
625
+ "sm",
626
+ "sg",
627
+ "sr",
628
+ "gd",
629
+ "sn",
630
+ "si",
631
+ "sk",
632
+ "sl",
633
+ "so",
634
+ "st",
635
+ "es",
636
+ "su",
637
+ "sw",
638
+ "ss",
639
+ "sv",
640
+ "ta",
641
+ "te",
642
+ "tg",
643
+ "th",
644
+ "ti",
645
+ "bo",
646
+ "tk",
647
+ "tl",
648
+ "tn",
649
+ "to",
650
+ "tr",
651
+ "ts",
652
+ "tt",
653
+ "tw",
654
+ "ty",
655
+ "ug",
656
+ "uk",
657
+ "ur",
658
+ "uz",
659
+ "ve",
660
+ "vi",
661
+ "vo",
662
+ "wa",
663
+ "cy",
664
+ "wo",
665
+ "fy",
666
+ "xh",
667
+ "yi",
668
+ "yo",
669
+ "za",
670
+ "zu"
671
+ ],
672
+ "type": "string"
673
+ },
674
+ "text": {
522
675
  "minLength": 1,
676
+ "type": "string"
677
+ }
678
+ },
679
+ "type": "object",
680
+ "required": [
681
+ "language",
682
+ "text"
683
+ ]
684
+ },
685
+ "FieldOptionDto": {
686
+ "properties": {
687
+ "key": {
523
688
  "type": "string",
524
- "title": "Title",
525
- "description": "Integration display title.",
526
- "example": "Example Product"
689
+ "title": "Key",
690
+ "description": "Internal key for the option."
527
691
  },
528
- "logo": {
529
- "format": "uri",
692
+ "value": {
530
693
  "type": "string",
531
- "title": "Logo URL",
532
- "description": "Public HTTPS URL for the integration logo.",
533
- "example": "https://cdn.example.com/logo.png"
694
+ "title": "Value",
695
+ "description": "Display value for the option."
534
696
  },
535
- "description": {
697
+ "disabled": {
698
+ "type": "boolean",
699
+ "title": "Disabled",
700
+ "description": "Whether the option is disabled."
701
+ }
702
+ },
703
+ "type": "object",
704
+ "required": [
705
+ "key",
706
+ "value"
707
+ ]
708
+ },
709
+ "FieldDto": {
710
+ "properties": {
711
+ "id": {
536
712
  "type": "string",
537
- "title": "Description",
538
- "description": "Short description of the integration.",
539
- "example": "An example product integration."
713
+ "title": "ID",
714
+ "description": "Unique identifier for the field."
540
715
  },
541
- "supportedLanguages": {
716
+ "label": {
717
+ "items": {
718
+ "$ref": "#/components/schemas/MultilangTextDto"
719
+ },
720
+ "minItems": 1,
721
+ "type": "array",
722
+ "title": "Label",
723
+ "description": "Multilingual label for the field."
724
+ },
725
+ "value": {
726
+ "title": "Value",
727
+ "description": "Value of the field. String/Number, or FieldOptionDto/FieldOptionDto[] depending on type.",
728
+ "oneOf": [
729
+ {
730
+ "title": "String",
731
+ "type": "string"
732
+ },
733
+ {
734
+ "title": "Number",
735
+ "type": "number"
736
+ },
737
+ {
738
+ "title": "Option",
739
+ "$ref": "#/components/schemas/FieldOptionDto"
740
+ },
741
+ {
742
+ "title": "Options Array",
743
+ "type": "array",
744
+ "items": {
745
+ "$ref": "#/components/schemas/FieldOptionDto"
746
+ }
747
+ }
748
+ ]
749
+ },
750
+ "type": {
751
+ "enum": [
752
+ "TEXT_BOX",
753
+ "TEXT_AREA",
754
+ "SELECT",
755
+ "MULTI_SELECT",
756
+ "DESCRIPTION",
757
+ "RADIO_BOX",
758
+ "CHECKBOX",
759
+ "SLIDER"
760
+ ],
761
+ "type": "string",
762
+ "title": "Field Type",
763
+ "description": "Type of the field."
764
+ },
765
+ "repeatableMin": {
766
+ "type": "number"
767
+ },
768
+ "repeatableMax": {
769
+ "type": "number"
770
+ },
771
+ "required": {
772
+ "type": "boolean",
773
+ "title": "Required",
774
+ "description": "Whether the field is required."
775
+ },
776
+ "disabled": {
777
+ "type": "boolean",
778
+ "title": "Disabled",
779
+ "description": "Whether the field is disabled."
780
+ },
781
+ "visibleInOrder": {
782
+ "type": "boolean",
783
+ "title": "Visible In Order",
784
+ "description": "Whether the field is visible in order."
785
+ },
786
+ "visibleInClientPanel": {
787
+ "type": "boolean",
788
+ "title": "Visible In Client Panel",
789
+ "description": "Whether the field is visible in client panel."
790
+ },
791
+ "regexValidation": {
792
+ "type": "string",
793
+ "title": "Regex Validation",
794
+ "description": "Optional regex to validate input.",
795
+ "example": "^[A-Za-z0-9_-]+$"
796
+ },
797
+ "regexValidationErrorMessage": {
798
+ "items": {
799
+ "$ref": "#/components/schemas/MultilangTextDto"
800
+ },
801
+ "type": "array",
802
+ "title": "Regex Validation Error Message",
803
+ "description": "Localized error message shown when regex validation fails."
804
+ },
805
+ "triggersRemoteValidation": {
806
+ "type": "boolean",
807
+ "title": "Triggers Remote Validation",
808
+ "description": "If true, field triggers remote validation."
809
+ },
810
+ "remoteValidationErrorMessage": {
811
+ "items": {
812
+ "$ref": "#/components/schemas/MultilangTextDto"
813
+ },
814
+ "type": "array",
815
+ "title": "Remote Validation Error Message",
816
+ "description": "Localized error messages for remote validation."
817
+ },
818
+ "upgradable": {
819
+ "type": "boolean",
820
+ "title": "Upgradable",
821
+ "description": "Whether the item attribute is upgradable by the user."
822
+ }
823
+ },
824
+ "type": "object",
825
+ "required": [
826
+ "id",
827
+ "label",
828
+ "value",
829
+ "type",
830
+ "required",
831
+ "disabled",
832
+ "visibleInOrder",
833
+ "visibleInClientPanel",
834
+ "upgradable"
835
+ ]
836
+ },
837
+ "InfoDto": {
838
+ "properties": {
839
+ "title": {
840
+ "minLength": 1,
841
+ "type": "string",
842
+ "title": "Title",
843
+ "description": "Integration display title.",
844
+ "example": "Example Product"
845
+ },
846
+ "logo": {
847
+ "format": "uri",
848
+ "type": "string",
849
+ "title": "Logo URL",
850
+ "description": "Public HTTPS URL for the integration logo.",
851
+ "example": "https://cdn.example.com/logo.png"
852
+ },
853
+ "description": {
854
+ "type": "string",
855
+ "title": "Description",
856
+ "description": "Short description of the integration.",
857
+ "example": "An example product integration."
858
+ },
859
+ "supportedLanguages": {
542
860
  "items": {
543
861
  "enum": [
544
862
  "aa",
@@ -730,9 +1048,6 @@ exports.ComponentsSchemas = {
730
1048
  },
731
1049
  "minItems": 1,
732
1050
  "type": "array",
733
- "not": {
734
- "type": "null"
735
- },
736
1051
  "title": "Supported Languages",
737
1052
  "description": "Locales supported by the integration.",
738
1053
  "example": [
@@ -747,6 +1062,7 @@ exports.ComponentsSchemas = {
747
1062
  "upgrade",
748
1063
  "downgrade",
749
1064
  "transfer",
1065
+ "trade",
750
1066
  "suspend",
751
1067
  "unsuspend",
752
1068
  "delete"
@@ -1024,6 +1340,15 @@ exports.ComponentsSchemas = {
1024
1340
  "title": "Onboarding URL",
1025
1341
  "description": "URL to onboard/configure the integration.",
1026
1342
  "example": "https://example.com/onboarding"
1343
+ },
1344
+ "setupAttributes": {
1345
+ "items": {
1346
+ "$ref": "#/components/schemas/FieldDto"
1347
+ },
1348
+ "type": "array",
1349
+ "minItems": 1,
1350
+ "title": "Setup Attributes",
1351
+ "description": "Configurable attributes that are used in the setup process."
1027
1352
  }
1028
1353
  },
1029
1354
  "type": "object",
@@ -1037,9 +1362,6 @@ exports.ComponentsSchemas = {
1037
1362
  "id": {
1038
1363
  "minLength": 1,
1039
1364
  "type": "string",
1040
- "not": {
1041
- "type": "null"
1042
- },
1043
1365
  "title": "Unit ID",
1044
1366
  "description": "Unit identifier.",
1045
1367
  "example": "messages"
@@ -1047,9 +1369,6 @@ exports.ComponentsSchemas = {
1047
1369
  "unitDescription": {
1048
1370
  "minLength": 1,
1049
1371
  "type": "string",
1050
- "not": {
1051
- "type": "null"
1052
- },
1053
1372
  "title": "Unit Description",
1054
1373
  "description": "What is measured.",
1055
1374
  "example": "Message sent"
@@ -1057,9 +1376,6 @@ exports.ComponentsSchemas = {
1057
1376
  "intervalDescription": {
1058
1377
  "minLength": 1,
1059
1378
  "type": "string",
1060
- "not": {
1061
- "type": "null"
1062
- },
1063
1379
  "title": "Interval Description",
1064
1380
  "description": "Billing interval.",
1065
1381
  "example": "Per month"
@@ -1075,9 +1391,6 @@ exports.ComponentsSchemas = {
1075
1391
  "NotificationInfoDto": {
1076
1392
  "properties": {
1077
1393
  "type": {
1078
- "not": {
1079
- "type": "null"
1080
- },
1081
1394
  "enum": [
1082
1395
  "email",
1083
1396
  "sms",
@@ -1315,9 +1628,6 @@ exports.ComponentsSchemas = {
1315
1628
  },
1316
1629
  "minItems": 1,
1317
1630
  "type": "array",
1318
- "not": {
1319
- "type": "null"
1320
- },
1321
1631
  "title": "Supported Languages",
1322
1632
  "description": "Locales supported by the integration.",
1323
1633
  "example": [
@@ -1332,6 +1642,7 @@ exports.ComponentsSchemas = {
1332
1642
  "upgrade",
1333
1643
  "downgrade",
1334
1644
  "transfer",
1645
+ "trade",
1335
1646
  "suspend",
1336
1647
  "unsuspend",
1337
1648
  "delete"
@@ -1453,547 +1764,178 @@ exports.ComponentsSchemas = {
1453
1764
  "order/status/archived",
1454
1765
  "order/insufficient-balance",
1455
1766
  "order/item-detached",
1456
- "order/invoice-contact-changed",
1457
- "order/updated",
1458
- "order/deleted",
1459
- "setting/created",
1460
- "setting/updated",
1461
- "setting/deleted",
1462
- "issue/created",
1463
- "issue/updated",
1464
- "issue/deleted",
1465
- "task/created",
1466
- "task/updated",
1467
- "task/deleted",
1468
- "task/canceled",
1469
- "task/in-progress",
1470
- "task/completed",
1471
- "task/percentage/updated",
1472
- "product/created",
1473
- "product/updated",
1474
- "product/deleted",
1475
- "product/auto-renew/updated",
1476
- "product/enabled",
1477
- "product/disabled",
1478
- "product/version-created",
1479
- "ip-group/created",
1480
- "ip-group/updated",
1481
- "ip-group/deleted",
1482
- "ip/created",
1483
- "ip/updated",
1484
- "ip/deleted",
1485
- "domain-name/created",
1486
- "domain-name/updated",
1487
- "domain-name/deleted",
1488
- "domain-name/locked",
1489
- "domain-name/unlocked",
1490
- "domain-name/idshield-activated",
1491
- "domain-name/idshield-deactivated",
1492
- "domain-name/bundle-added",
1493
- "domain-name/bundle-removed",
1494
- "domain-name/registrant-updated",
1495
- "domain-name/admin-updated",
1496
- "domain-name/tech-updated",
1497
- "domain-name/billing-updated",
1498
- "domain-name/additional-updated",
1499
- "item/created",
1500
- "item/updated",
1501
- "item/deleted",
1502
- "item/renewed",
1503
- "item/upgraded",
1504
- "item/downgraded",
1505
- "item/ip-attached",
1506
- "item/ip-detached",
1507
- "item/detached-from-order",
1508
- "item/postponed",
1509
- "item/transferred-in",
1510
- "item/canceled",
1511
- "item/suspended",
1512
- "item/unsuspended",
1513
- "item/affiliate/added",
1514
- "item/bundle/attached",
1515
- "item/bundle/detached",
1516
- "item/activated",
1517
- "item/set-inactive",
1518
- "item/processed",
1519
- "order/paid",
1520
- "test",
1521
- "dead-lettering",
1522
- "core-queue"
1523
- ],
1524
- "type": "string"
1525
- },
1526
- "minItems": 1,
1527
- "type": "array",
1528
- "title": "Listen Events",
1529
- "description": "Platform events the integration can subscribe to."
1530
- },
1531
- "requiredRoles": {
1532
- "items": {
1533
- "enum": [
1534
- "SIMPLE_USER",
1535
- "FULL_ACCESS",
1536
- "SUPER_ADMIN",
1537
- "ORDER_READ",
1538
- "ORDER_WRITE",
1539
- "ADDON_READ",
1540
- "ADDON_WRITE",
1541
- "AFFILIATE_READ",
1542
- "AFFILIATE_WRITE",
1543
- "COMPANY_READ",
1544
- "COMPANY_WRITE",
1545
- "TEMPLATE_READ",
1546
- "TEMPLATE_WRITE",
1547
- "COUPON_READ",
1548
- "COUPON_WRITE",
1549
- "DOMAIN_CATEGORY_READ",
1550
- "DOMAIN_CATEGORY_WRITE",
1551
- "DOMAIN_CONTACT_READ",
1552
- "DOMAIN_CONTACT_WRITE",
1553
- "DOMAIN_NAME_READ",
1554
- "DOMAIN_NAME_WRITE",
1555
- "INVOICE_CONTACT_READ",
1556
- "INVOICE_CONTACT_WRITE",
1557
- "INVOICE_READ",
1558
- "INVOICE_WRITE",
1559
- "IP_GROUPS_READ",
1560
- "IP_GROUPS_WRITE",
1561
- "IPS_READ",
1562
- "IPS_WRITE",
1563
- "ITEMS_READ",
1564
- "ITEMS_WRITE",
1565
- "ORDERS_READ",
1566
- "ORDERS_WRITE",
1567
- "TRANSACTIONS_READ",
1568
- "TRANSACTIONS_WRITE",
1569
- "POLICIES_READ",
1570
- "POLICIES_WRITE",
1571
- "PRODUCT_CATEGORIES_READ",
1572
- "PRODUCT_CATEGORIES_WRITE",
1573
- "PRODUCTS_READ",
1574
- "PRODUCTS_WRITE",
1575
- "SETTINGS_READ",
1576
- "SETTINGS_WRITE",
1577
- "INTEGRATIONS_READ",
1578
- "INTEGRATIONS_WRITE",
1579
- "TLDS_READ",
1580
- "TLDS_WRITE",
1581
- "USERS_READ",
1582
- "USERS_WRITE",
1583
- "ISSUES_WRITE",
1584
- "ISSUES_READ",
1585
- "ACTION_LOGS_READ"
1586
- ],
1587
- "type": "string"
1588
- },
1589
- "minItems": 1,
1590
- "type": "array",
1591
- "title": "Required Roles",
1592
- "description": "Roles required for this integration to operate."
1593
- },
1594
- "adminPanel": {
1595
- "$ref": "#/components/schemas/AdminPanelDto",
1596
- "title": "Admin Panel",
1597
- "description": "Admin UI links, tabs, and actions provided by the integration.",
1598
- "type": "object"
1599
- },
1600
- "clientPanel": {
1601
- "$ref": "#/components/schemas/ClientPanelDto",
1602
- "title": "Client Panel",
1603
- "description": "Client UI links, tabs, and actions provided by the integration.",
1604
- "type": "object"
1605
- },
1606
- "onboardingUrl": {
1607
- "format": "uri",
1608
- "type": "string",
1609
- "title": "Onboarding URL",
1610
- "description": "URL to onboard/configure the integration.",
1611
- "example": "https://example.com/onboarding"
1612
- }
1613
- },
1614
- "type": "object",
1615
- "required": [
1616
- "type",
1617
- "title",
1618
- "supportedLanguages"
1619
- ]
1620
- },
1621
- "MultilangTextDto": {
1622
- "properties": {
1623
- "language": {
1624
- "not": {
1625
- "type": "null"
1626
- },
1627
- "enum": [
1628
- "aa",
1629
- "af",
1630
- "ak",
1631
- "sq",
1632
- "am",
1633
- "ar",
1634
- "an",
1635
- "hy",
1636
- "as",
1637
- "av",
1638
- "ae",
1639
- "ay",
1640
- "az",
1641
- "bm",
1642
- "ba",
1643
- "eu",
1644
- "be",
1645
- "bn",
1646
- "bh",
1647
- "bi",
1648
- "bs",
1649
- "br",
1650
- "bg",
1651
- "my",
1652
- "ca",
1653
- "ch",
1654
- "ce",
1655
- "ny",
1656
- "zh",
1657
- "cv",
1658
- "kw",
1659
- "co",
1660
- "cr",
1661
- "hr",
1662
- "cs",
1663
- "da",
1664
- "dv",
1665
- "nl",
1666
- "dz",
1667
- "en",
1668
- "eo",
1669
- "et",
1670
- "ee",
1671
- "fo",
1672
- "fj",
1673
- "fi",
1674
- "fr",
1675
- "ff",
1676
- "gl",
1677
- "ka",
1678
- "de",
1679
- "el",
1680
- "gn",
1681
- "gu",
1682
- "ht",
1683
- "ha",
1684
- "he",
1685
- "hz",
1686
- "hi",
1687
- "ho",
1688
- "hu",
1689
- "ia",
1690
- "id",
1691
- "ie",
1692
- "ga",
1693
- "ig",
1694
- "ik",
1695
- "io",
1696
- "is",
1697
- "it",
1698
- "iu",
1699
- "ja",
1700
- "jv",
1701
- "kl",
1702
- "kn",
1703
- "kr",
1704
- "ks",
1705
- "kk",
1706
- "km",
1707
- "ki",
1708
- "rw",
1709
- "ky",
1710
- "kv",
1711
- "kg",
1712
- "ko",
1713
- "ku",
1714
- "kj",
1715
- "la",
1716
- "lb",
1717
- "lg",
1718
- "li",
1719
- "ln",
1720
- "lo",
1721
- "lt",
1722
- "lu",
1723
- "lv",
1724
- "gv",
1725
- "mk",
1726
- "mg",
1727
- "ms",
1728
- "ml",
1729
- "mt",
1730
- "mi",
1731
- "mr",
1732
- "mh",
1733
- "mn",
1734
- "na",
1735
- "nv",
1736
- "nd",
1737
- "ne",
1738
- "ng",
1739
- "nb",
1740
- "nn",
1741
- "no",
1742
- "ii",
1743
- "nr",
1744
- "oc",
1745
- "oj",
1746
- "cu",
1747
- "om",
1748
- "or",
1749
- "os",
1750
- "pa",
1751
- "pi",
1752
- "fa",
1753
- "pl",
1754
- "ps",
1755
- "pt",
1756
- "qu",
1757
- "rm",
1758
- "rn",
1759
- "ro",
1760
- "rh",
1761
- "ru",
1762
- "sa",
1763
- "sc",
1764
- "sd",
1765
- "se",
1766
- "sm",
1767
- "sg",
1768
- "sr",
1769
- "gd",
1770
- "sn",
1771
- "si",
1772
- "sk",
1773
- "sl",
1774
- "so",
1775
- "st",
1776
- "es",
1777
- "su",
1778
- "sw",
1779
- "ss",
1780
- "sv",
1781
- "ta",
1782
- "te",
1783
- "tg",
1784
- "th",
1785
- "ti",
1786
- "bo",
1787
- "tk",
1788
- "tl",
1789
- "tn",
1790
- "to",
1791
- "tr",
1792
- "ts",
1793
- "tt",
1794
- "tw",
1795
- "ty",
1796
- "ug",
1797
- "uk",
1798
- "ur",
1799
- "uz",
1800
- "ve",
1801
- "vi",
1802
- "vo",
1803
- "wa",
1804
- "cy",
1805
- "wo",
1806
- "fy",
1807
- "xh",
1808
- "yi",
1809
- "yo",
1810
- "za",
1811
- "zu"
1812
- ],
1813
- "type": "string"
1814
- },
1815
- "text": {
1816
- "minLength": 1,
1817
- "type": "string"
1818
- }
1819
- },
1820
- "type": "object",
1821
- "required": [
1822
- "language",
1823
- "text"
1824
- ]
1825
- },
1826
- "FieldOptionDto": {
1827
- "properties": {
1828
- "key": {
1829
- "not": {
1830
- "type": "null"
1831
- },
1832
- "type": "string",
1833
- "title": "Key",
1834
- "description": "Internal key for the option."
1835
- },
1836
- "value": {
1837
- "not": {
1838
- "type": "null"
1839
- },
1840
- "type": "string",
1841
- "title": "Value",
1842
- "description": "Display value for the option."
1843
- },
1844
- "disabled": {
1845
- "type": "boolean",
1846
- "title": "Disabled",
1847
- "description": "Whether the option is disabled."
1848
- }
1849
- },
1850
- "type": "object",
1851
- "required": [
1852
- "key",
1853
- "value"
1854
- ]
1855
- },
1856
- "FieldDto": {
1857
- "properties": {
1858
- "id": {
1859
- "not": {
1860
- "type": "null"
1767
+ "order/invoice-contact-changed",
1768
+ "order/updated",
1769
+ "order/deleted",
1770
+ "setting/created",
1771
+ "setting/updated",
1772
+ "setting/deleted",
1773
+ "issue/created",
1774
+ "issue/updated",
1775
+ "issue/deleted",
1776
+ "task/created",
1777
+ "task/updated",
1778
+ "task/deleted",
1779
+ "task/canceled",
1780
+ "task/in-progress",
1781
+ "task/completed",
1782
+ "task/percentage/updated",
1783
+ "product/created",
1784
+ "product/updated",
1785
+ "product/deleted",
1786
+ "product/auto-renew/updated",
1787
+ "product/enabled",
1788
+ "product/disabled",
1789
+ "product/version-created",
1790
+ "ip-group/created",
1791
+ "ip-group/updated",
1792
+ "ip-group/deleted",
1793
+ "ip/created",
1794
+ "ip/updated",
1795
+ "ip/deleted",
1796
+ "domain-name/created",
1797
+ "domain-name/updated",
1798
+ "domain-name/deleted",
1799
+ "domain-name/locked",
1800
+ "domain-name/unlocked",
1801
+ "domain-name/idshield-activated",
1802
+ "domain-name/idshield-deactivated",
1803
+ "domain-name/bundle-added",
1804
+ "domain-name/bundle-removed",
1805
+ "domain-name/registrant-updated",
1806
+ "domain-name/admin-updated",
1807
+ "domain-name/tech-updated",
1808
+ "domain-name/billing-updated",
1809
+ "domain-name/additional-updated",
1810
+ "item/created",
1811
+ "item/updated",
1812
+ "item/deleted",
1813
+ "item/renewed",
1814
+ "item/upgraded",
1815
+ "item/downgraded",
1816
+ "item/ip-attached",
1817
+ "item/ip-detached",
1818
+ "item/detached-from-order",
1819
+ "item/postponed",
1820
+ "item/transferred-in",
1821
+ "item/canceled",
1822
+ "item/suspended",
1823
+ "item/unsuspended",
1824
+ "item/affiliate/added",
1825
+ "item/bundle/attached",
1826
+ "item/bundle/detached",
1827
+ "item/activated",
1828
+ "item/set-inactive",
1829
+ "item/processed",
1830
+ "order/paid",
1831
+ "test",
1832
+ "dead-lettering",
1833
+ "core-queue"
1834
+ ],
1835
+ "type": "string"
1861
1836
  },
1862
- "type": "string",
1863
- "title": "ID",
1864
- "description": "Unique identifier for the field."
1837
+ "minItems": 1,
1838
+ "type": "array",
1839
+ "title": "Listen Events",
1840
+ "description": "Platform events the integration can subscribe to."
1865
1841
  },
1866
- "label": {
1842
+ "requiredRoles": {
1867
1843
  "items": {
1868
- "$ref": "#/components/schemas/MultilangTextDto"
1844
+ "enum": [
1845
+ "SIMPLE_USER",
1846
+ "FULL_ACCESS",
1847
+ "SUPER_ADMIN",
1848
+ "ORDER_READ",
1849
+ "ORDER_WRITE",
1850
+ "ADDON_READ",
1851
+ "ADDON_WRITE",
1852
+ "AFFILIATE_READ",
1853
+ "AFFILIATE_WRITE",
1854
+ "COMPANY_READ",
1855
+ "COMPANY_WRITE",
1856
+ "TEMPLATE_READ",
1857
+ "TEMPLATE_WRITE",
1858
+ "COUPON_READ",
1859
+ "COUPON_WRITE",
1860
+ "DOMAIN_CATEGORY_READ",
1861
+ "DOMAIN_CATEGORY_WRITE",
1862
+ "DOMAIN_CONTACT_READ",
1863
+ "DOMAIN_CONTACT_WRITE",
1864
+ "DOMAIN_NAME_READ",
1865
+ "DOMAIN_NAME_WRITE",
1866
+ "INVOICE_CONTACT_READ",
1867
+ "INVOICE_CONTACT_WRITE",
1868
+ "INVOICE_READ",
1869
+ "INVOICE_WRITE",
1870
+ "IP_GROUPS_READ",
1871
+ "IP_GROUPS_WRITE",
1872
+ "IPS_READ",
1873
+ "IPS_WRITE",
1874
+ "ITEMS_READ",
1875
+ "ITEMS_WRITE",
1876
+ "ORDERS_READ",
1877
+ "ORDERS_WRITE",
1878
+ "TRANSACTIONS_READ",
1879
+ "TRANSACTIONS_WRITE",
1880
+ "POLICIES_READ",
1881
+ "POLICIES_WRITE",
1882
+ "PRODUCT_CATEGORIES_READ",
1883
+ "PRODUCT_CATEGORIES_WRITE",
1884
+ "PRODUCTS_READ",
1885
+ "PRODUCTS_WRITE",
1886
+ "SETTINGS_READ",
1887
+ "SETTINGS_WRITE",
1888
+ "INTEGRATIONS_READ",
1889
+ "INTEGRATIONS_WRITE",
1890
+ "TLDS_READ",
1891
+ "TLDS_WRITE",
1892
+ "USERS_READ",
1893
+ "USERS_WRITE",
1894
+ "ISSUES_WRITE",
1895
+ "ISSUES_READ",
1896
+ "ACTION_LOGS_READ"
1897
+ ],
1898
+ "type": "string"
1869
1899
  },
1870
1900
  "minItems": 1,
1871
1901
  "type": "array",
1872
- "title": "Label",
1873
- "description": "Multilingual label for the field."
1874
- },
1875
- "value": {
1876
- "not": {
1877
- "type": "null"
1878
- },
1879
- "title": "Value",
1880
- "description": "Value of the field. String/Number, or FieldOptionDto/FieldOptionDto[] depending on type.",
1881
- "oneOf": [
1882
- {
1883
- "title": "String",
1884
- "type": "string"
1885
- },
1886
- {
1887
- "title": "Number",
1888
- "type": "number"
1889
- },
1890
- {
1891
- "title": "Option",
1892
- "$ref": "#/components/schemas/FieldOptionDto"
1893
- },
1894
- {
1895
- "title": "Options Array",
1896
- "type": "array",
1897
- "items": {
1898
- "$ref": "#/components/schemas/FieldOptionDto"
1899
- }
1900
- }
1901
- ]
1902
- },
1903
- "type": {
1904
- "not": {
1905
- "type": "null"
1906
- },
1907
- "enum": [
1908
- "TEXT_BOX",
1909
- "TEXT_AREA",
1910
- "SELECT",
1911
- "MULTI_SELECT",
1912
- "DESCRIPTION",
1913
- "RADIO_BOX",
1914
- "CHECKBOX",
1915
- "SLIDER"
1916
- ],
1917
- "type": "string",
1918
- "title": "Field Type",
1919
- "description": "Type of the field."
1920
- },
1921
- "reapetableMin": {
1922
- "type": "number"
1923
- },
1924
- "reapetableMax": {
1925
- "type": "number"
1926
- },
1927
- "required": {
1928
- "not": {
1929
- "type": "null"
1930
- },
1931
- "type": "boolean",
1932
- "title": "Required",
1933
- "description": "Whether the field is required."
1902
+ "title": "Required Roles",
1903
+ "description": "Roles required for this integration to operate."
1934
1904
  },
1935
- "disabled": {
1936
- "not": {
1937
- "type": "null"
1938
- },
1939
- "type": "boolean",
1940
- "title": "Disabled",
1941
- "description": "Whether the field is disabled."
1905
+ "adminPanel": {
1906
+ "$ref": "#/components/schemas/AdminPanelDto",
1907
+ "title": "Admin Panel",
1908
+ "description": "Admin UI links, tabs, and actions provided by the integration.",
1909
+ "type": "object"
1942
1910
  },
1943
- "hidden": {
1944
- "not": {
1945
- "type": "null"
1946
- },
1947
- "type": "boolean",
1948
- "title": "Hidden",
1949
- "description": "Whether the field is hidden."
1911
+ "clientPanel": {
1912
+ "$ref": "#/components/schemas/ClientPanelDto",
1913
+ "title": "Client Panel",
1914
+ "description": "Client UI links, tabs, and actions provided by the integration.",
1915
+ "type": "object"
1950
1916
  },
1951
- "regexValidation": {
1917
+ "onboardingUrl": {
1918
+ "format": "uri",
1952
1919
  "type": "string",
1953
- "title": "Regex Validation",
1954
- "description": "Optional regex to validate input.",
1955
- "example": "^[A-Za-z0-9_-]+$"
1956
- },
1957
- "regexValidationErrorMessage": {
1958
- "items": {
1959
- "$ref": "#/components/schemas/MultilangTextDto"
1960
- },
1961
- "type": "array",
1962
- "title": "Regex Validation Error Message",
1963
- "description": "Localized error message shown when regex validation fails."
1964
- },
1965
- "triggersRemoteValidation": {
1966
- "type": "boolean",
1967
- "title": "Triggers Remote Validation",
1968
- "description": "If true, field triggers remote validation."
1920
+ "title": "Onboarding URL",
1921
+ "description": "URL to onboard/configure the integration.",
1922
+ "example": "https://example.com/onboarding"
1969
1923
  },
1970
- "remoteValidationErrorMessage": {
1924
+ "setupAttributes": {
1971
1925
  "items": {
1972
- "$ref": "#/components/schemas/MultilangTextDto"
1926
+ "$ref": "#/components/schemas/FieldDto"
1973
1927
  },
1974
1928
  "type": "array",
1975
- "title": "Remote Validation Error Message",
1976
- "description": "Localized error messages for remote validation."
1977
- },
1978
- "upgradable": {
1979
- "not": {
1980
- "type": "null"
1981
- },
1982
- "type": "boolean",
1983
- "title": "Upgradable",
1984
- "description": "Whether the item attribute is upgradable by the user."
1929
+ "minItems": 1,
1930
+ "title": "Setup Attributes",
1931
+ "description": "Configurable attributes that are used in the setup process."
1985
1932
  }
1986
1933
  },
1987
1934
  "type": "object",
1988
1935
  "required": [
1989
- "id",
1990
- "label",
1991
- "value",
1992
1936
  "type",
1993
- "required",
1994
- "disabled",
1995
- "hidden",
1996
- "upgradable"
1937
+ "title",
1938
+ "supportedLanguages"
1997
1939
  ]
1998
1940
  },
1999
1941
  "ProductInfoDto": {
@@ -2256,9 +2198,6 @@ exports.ComponentsSchemas = {
2256
2198
  },
2257
2199
  "minItems": 1,
2258
2200
  "type": "array",
2259
- "not": {
2260
- "type": "null"
2261
- },
2262
2201
  "title": "Supported Languages",
2263
2202
  "description": "Locales supported by the integration.",
2264
2203
  "example": [
@@ -2273,6 +2212,7 @@ exports.ComponentsSchemas = {
2273
2212
  "upgrade",
2274
2213
  "downgrade",
2275
2214
  "transfer",
2215
+ "trade",
2276
2216
  "suspend",
2277
2217
  "unsuspend",
2278
2218
  "delete"
@@ -2550,6 +2490,15 @@ exports.ComponentsSchemas = {
2550
2490
  "title": "Onboarding URL",
2551
2491
  "description": "URL to onboard/configure the integration.",
2552
2492
  "example": "https://example.com/onboarding"
2493
+ },
2494
+ "setupAttributes": {
2495
+ "items": {
2496
+ "$ref": "#/components/schemas/FieldDto"
2497
+ },
2498
+ "type": "array",
2499
+ "minItems": 1,
2500
+ "title": "Setup Attributes",
2501
+ "description": "Configurable attributes that are used in the setup process."
2553
2502
  }
2554
2503
  },
2555
2504
  "type": "object",