@hosterai/types 0.0.22 → 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 (49) hide show
  1. package/README.md +2 -2
  2. package/dist/dtos/info/info-notification.dto.d.ts +5 -0
  3. package/dist/dtos/info/info-notification.dto.js +7 -0
  4. package/dist/dtos/info/info.dto.d.ts +196 -0
  5. package/dist/dtos/info/info.dto.js +278 -0
  6. package/dist/dtos/info.dto.d.ts +2 -0
  7. package/dist/dtos/info.dto.js +17 -0
  8. package/dist/dtos/notification/notification-request.dto.d.ts +20 -0
  9. package/dist/dtos/notification/notification-request.dto.js +31 -0
  10. package/dist/dtos/product/product.interface.d.ts +4 -4
  11. package/dist/dtos/receiver/receiver-email.dto.d.ts +20 -0
  12. package/dist/dtos/receiver/receiver-email.dto.js +39 -0
  13. package/dist/dtos/receiver/receiver-push.dto.d.ts +15 -0
  14. package/dist/dtos/receiver/receiver-push.dto.js +31 -0
  15. package/dist/dtos/receiver/receiver-sms.dto.d.ts +11 -0
  16. package/dist/dtos/receiver/receiver-sms.dto.js +26 -0
  17. package/dist/dtos/request.dto.d.ts +20 -0
  18. package/dist/dtos/request.dto.js +31 -0
  19. package/dist/dtos/requests/validate-attributes-request.dto.d.ts +18 -0
  20. package/dist/dtos/{product/requests/product-upgradeable-request.dto.js → requests/validate-attributes-request.dto.js} +11 -17
  21. package/dist/dtos/responses/validate-attributes-response.dto.d.ts +13 -0
  22. package/dist/dtos/responses/validate-attributes-response.dto.js +11 -0
  23. package/dist/dtos/sender/sender-email.dto.d.ts +25 -0
  24. package/dist/dtos/sender/sender-email.dto.js +46 -0
  25. package/dist/dtos/sender/sender-push.dto.d.ts +31 -0
  26. package/dist/dtos/sender/sender-push.dto.js +50 -0
  27. package/dist/dtos/sender/sender-sms.dto.d.ts +15 -0
  28. package/dist/dtos/sender/sender-sms.dto.js +30 -0
  29. package/dist/enums/message-type.enum.d.ts +5 -0
  30. package/dist/enums/message-type.enum.js +9 -0
  31. package/dist/index.d.ts +2 -4
  32. package/dist/index.js +4 -4
  33. package/dist/openapi/schemas/components.schemas.d.ts +163 -226
  34. package/dist/openapi/schemas/components.schemas.js +533 -596
  35. package/dist/validators/product-validate-attributes-request-validator.d.ts +1 -1
  36. package/dist/validators/product-validate-attributes-request-validator.js +5 -5
  37. package/dist/validators/product-validate-attributes-request-validator.spec.js +3 -3
  38. package/package.json +1 -1
  39. package/dist/dtos/product/requests/product-downgradeable-request.dto.d.ts +0 -18
  40. package/dist/dtos/product/requests/product-downgradeable-request.dto.js +0 -37
  41. package/dist/dtos/product/requests/product-upgradeable-request.dto.d.ts +0 -18
  42. package/dist/dtos/product/responses/product-downgradeable-response.dto.d.ts +0 -22
  43. package/dist/dtos/product/responses/product-downgradeable-response.dto.js +0 -11
  44. package/dist/dtos/product/responses/product-upgradeable-response.dto.d.ts +0 -22
  45. package/dist/dtos/product/responses/product-upgradeable-response.dto.js +0 -11
  46. package/dist/validators/product-downgradeable-request-validator.d.ts +0 -8
  47. package/dist/validators/product-downgradeable-request-validator.js +0 -17
  48. package/dist/validators/product-upgradeable-request-validator.d.ts +0 -8
  49. package/dist/validators/product-upgradeable-request-validator.js +0 -17
package/dist/openapi/schemas/components.schemas.js CHANGED
@@ -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": [
@@ -1025,6 +1340,15 @@ exports.ComponentsSchemas = {
1025
1340
  "title": "Onboarding URL",
1026
1341
  "description": "URL to onboard/configure the integration.",
1027
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."
1028
1352
  }
1029
1353
  },
1030
1354
  "type": "object",
@@ -1038,9 +1362,6 @@ exports.ComponentsSchemas = {
1038
1362
  "id": {
1039
1363
  "minLength": 1,
1040
1364
  "type": "string",
1041
- "not": {
1042
- "type": "null"
1043
- },
1044
1365
  "title": "Unit ID",
1045
1366
  "description": "Unit identifier.",
1046
1367
  "example": "messages"
@@ -1048,9 +1369,6 @@ exports.ComponentsSchemas = {
1048
1369
  "unitDescription": {
1049
1370
  "minLength": 1,
1050
1371
  "type": "string",
1051
- "not": {
1052
- "type": "null"
1053
- },
1054
1372
  "title": "Unit Description",
1055
1373
  "description": "What is measured.",
1056
1374
  "example": "Message sent"
@@ -1058,9 +1376,6 @@ exports.ComponentsSchemas = {
1058
1376
  "intervalDescription": {
1059
1377
  "minLength": 1,
1060
1378
  "type": "string",
1061
- "not": {
1062
- "type": "null"
1063
- },
1064
1379
  "title": "Interval Description",
1065
1380
  "description": "Billing interval.",
1066
1381
  "example": "Per month"
@@ -1076,9 +1391,6 @@ exports.ComponentsSchemas = {
1076
1391
  "NotificationInfoDto": {
1077
1392
  "properties": {
1078
1393
  "type": {
1079
- "not": {
1080
- "type": "null"
1081
- },
1082
1394
  "enum": [
1083
1395
  "email",
1084
1396
  "sms",
@@ -1316,9 +1628,6 @@ exports.ComponentsSchemas = {
1316
1628
  },
1317
1629
  "minItems": 1,
1318
1630
  "type": "array",
1319
- "not": {
1320
- "type": "null"
1321
- },
1322
1631
  "title": "Supported Languages",
1323
1632
  "description": "Locales supported by the integration.",
1324
1633
  "example": [
@@ -1468,543 +1777,165 @@ exports.ComponentsSchemas = {
1468
1777
  "task/updated",
1469
1778
  "task/deleted",
1470
1779
  "task/canceled",
1471
- "task/in-progress",
1472
- "task/completed",
1473
- "task/percentage/updated",
1474
- "product/created",
1475
- "product/updated",
1476
- "product/deleted",
1477
- "product/auto-renew/updated",
1478
- "product/enabled",
1479
- "product/disabled",
1480
- "product/version-created",
1481
- "ip-group/created",
1482
- "ip-group/updated",
1483
- "ip-group/deleted",
1484
- "ip/created",
1485
- "ip/updated",
1486
- "ip/deleted",
1487
- "domain-name/created",
1488
- "domain-name/updated",
1489
- "domain-name/deleted",
1490
- "domain-name/locked",
1491
- "domain-name/unlocked",
1492
- "domain-name/idshield-activated",
1493
- "domain-name/idshield-deactivated",
1494
- "domain-name/bundle-added",
1495
- "domain-name/bundle-removed",
1496
- "domain-name/registrant-updated",
1497
- "domain-name/admin-updated",
1498
- "domain-name/tech-updated",
1499
- "domain-name/billing-updated",
1500
- "domain-name/additional-updated",
1501
- "item/created",
1502
- "item/updated",
1503
- "item/deleted",
1504
- "item/renewed",
1505
- "item/upgraded",
1506
- "item/downgraded",
1507
- "item/ip-attached",
1508
- "item/ip-detached",
1509
- "item/detached-from-order",
1510
- "item/postponed",
1511
- "item/transferred-in",
1512
- "item/canceled",
1513
- "item/suspended",
1514
- "item/unsuspended",
1515
- "item/affiliate/added",
1516
- "item/bundle/attached",
1517
- "item/bundle/detached",
1518
- "item/activated",
1519
- "item/set-inactive",
1520
- "item/processed",
1521
- "order/paid",
1522
- "test",
1523
- "dead-lettering",
1524
- "core-queue"
1525
- ],
1526
- "type": "string"
1527
- },
1528
- "minItems": 1,
1529
- "type": "array",
1530
- "title": "Listen Events",
1531
- "description": "Platform events the integration can subscribe to."
1532
- },
1533
- "requiredRoles": {
1534
- "items": {
1535
- "enum": [
1536
- "SIMPLE_USER",
1537
- "FULL_ACCESS",
1538
- "SUPER_ADMIN",
1539
- "ORDER_READ",
1540
- "ORDER_WRITE",
1541
- "ADDON_READ",
1542
- "ADDON_WRITE",
1543
- "AFFILIATE_READ",
1544
- "AFFILIATE_WRITE",
1545
- "COMPANY_READ",
1546
- "COMPANY_WRITE",
1547
- "TEMPLATE_READ",
1548
- "TEMPLATE_WRITE",
1549
- "COUPON_READ",
1550
- "COUPON_WRITE",
1551
- "DOMAIN_CATEGORY_READ",
1552
- "DOMAIN_CATEGORY_WRITE",
1553
- "DOMAIN_CONTACT_READ",
1554
- "DOMAIN_CONTACT_WRITE",
1555
- "DOMAIN_NAME_READ",
1556
- "DOMAIN_NAME_WRITE",
1557
- "INVOICE_CONTACT_READ",
1558
- "INVOICE_CONTACT_WRITE",
1559
- "INVOICE_READ",
1560
- "INVOICE_WRITE",
1561
- "IP_GROUPS_READ",
1562
- "IP_GROUPS_WRITE",
1563
- "IPS_READ",
1564
- "IPS_WRITE",
1565
- "ITEMS_READ",
1566
- "ITEMS_WRITE",
1567
- "ORDERS_READ",
1568
- "ORDERS_WRITE",
1569
- "TRANSACTIONS_READ",
1570
- "TRANSACTIONS_WRITE",
1571
- "POLICIES_READ",
1572
- "POLICIES_WRITE",
1573
- "PRODUCT_CATEGORIES_READ",
1574
- "PRODUCT_CATEGORIES_WRITE",
1575
- "PRODUCTS_READ",
1576
- "PRODUCTS_WRITE",
1577
- "SETTINGS_READ",
1578
- "SETTINGS_WRITE",
1579
- "INTEGRATIONS_READ",
1580
- "INTEGRATIONS_WRITE",
1581
- "TLDS_READ",
1582
- "TLDS_WRITE",
1583
- "USERS_READ",
1584
- "USERS_WRITE",
1585
- "ISSUES_WRITE",
1586
- "ISSUES_READ",
1587
- "ACTION_LOGS_READ"
1588
- ],
1589
- "type": "string"
1590
- },
1591
- "minItems": 1,
1592
- "type": "array",
1593
- "title": "Required Roles",
1594
- "description": "Roles required for this integration to operate."
1595
- },
1596
- "adminPanel": {
1597
- "$ref": "#/components/schemas/AdminPanelDto",
1598
- "title": "Admin Panel",
1599
- "description": "Admin UI links, tabs, and actions provided by the integration.",
1600
- "type": "object"
1601
- },
1602
- "clientPanel": {
1603
- "$ref": "#/components/schemas/ClientPanelDto",
1604
- "title": "Client Panel",
1605
- "description": "Client UI links, tabs, and actions provided by the integration.",
1606
- "type": "object"
1607
- },
1608
- "onboardingUrl": {
1609
- "format": "uri",
1610
- "type": "string",
1611
- "title": "Onboarding URL",
1612
- "description": "URL to onboard/configure the integration.",
1613
- "example": "https://example.com/onboarding"
1614
- }
1615
- },
1616
- "type": "object",
1617
- "required": [
1618
- "type",
1619
- "title",
1620
- "supportedLanguages"
1621
- ]
1622
- },
1623
- "MultilangTextDto": {
1624
- "properties": {
1625
- "language": {
1626
- "not": {
1627
- "type": "null"
1628
- },
1629
- "enum": [
1630
- "aa",
1631
- "af",
1632
- "ak",
1633
- "sq",
1634
- "am",
1635
- "ar",
1636
- "an",
1637
- "hy",
1638
- "as",
1639
- "av",
1640
- "ae",
1641
- "ay",
1642
- "az",
1643
- "bm",
1644
- "ba",
1645
- "eu",
1646
- "be",
1647
- "bn",
1648
- "bh",
1649
- "bi",
1650
- "bs",
1651
- "br",
1652
- "bg",
1653
- "my",
1654
- "ca",
1655
- "ch",
1656
- "ce",
1657
- "ny",
1658
- "zh",
1659
- "cv",
1660
- "kw",
1661
- "co",
1662
- "cr",
1663
- "hr",
1664
- "cs",
1665
- "da",
1666
- "dv",
1667
- "nl",
1668
- "dz",
1669
- "en",
1670
- "eo",
1671
- "et",
1672
- "ee",
1673
- "fo",
1674
- "fj",
1675
- "fi",
1676
- "fr",
1677
- "ff",
1678
- "gl",
1679
- "ka",
1680
- "de",
1681
- "el",
1682
- "gn",
1683
- "gu",
1684
- "ht",
1685
- "ha",
1686
- "he",
1687
- "hz",
1688
- "hi",
1689
- "ho",
1690
- "hu",
1691
- "ia",
1692
- "id",
1693
- "ie",
1694
- "ga",
1695
- "ig",
1696
- "ik",
1697
- "io",
1698
- "is",
1699
- "it",
1700
- "iu",
1701
- "ja",
1702
- "jv",
1703
- "kl",
1704
- "kn",
1705
- "kr",
1706
- "ks",
1707
- "kk",
1708
- "km",
1709
- "ki",
1710
- "rw",
1711
- "ky",
1712
- "kv",
1713
- "kg",
1714
- "ko",
1715
- "ku",
1716
- "kj",
1717
- "la",
1718
- "lb",
1719
- "lg",
1720
- "li",
1721
- "ln",
1722
- "lo",
1723
- "lt",
1724
- "lu",
1725
- "lv",
1726
- "gv",
1727
- "mk",
1728
- "mg",
1729
- "ms",
1730
- "ml",
1731
- "mt",
1732
- "mi",
1733
- "mr",
1734
- "mh",
1735
- "mn",
1736
- "na",
1737
- "nv",
1738
- "nd",
1739
- "ne",
1740
- "ng",
1741
- "nb",
1742
- "nn",
1743
- "no",
1744
- "ii",
1745
- "nr",
1746
- "oc",
1747
- "oj",
1748
- "cu",
1749
- "om",
1750
- "or",
1751
- "os",
1752
- "pa",
1753
- "pi",
1754
- "fa",
1755
- "pl",
1756
- "ps",
1757
- "pt",
1758
- "qu",
1759
- "rm",
1760
- "rn",
1761
- "ro",
1762
- "rh",
1763
- "ru",
1764
- "sa",
1765
- "sc",
1766
- "sd",
1767
- "se",
1768
- "sm",
1769
- "sg",
1770
- "sr",
1771
- "gd",
1772
- "sn",
1773
- "si",
1774
- "sk",
1775
- "sl",
1776
- "so",
1777
- "st",
1778
- "es",
1779
- "su",
1780
- "sw",
1781
- "ss",
1782
- "sv",
1783
- "ta",
1784
- "te",
1785
- "tg",
1786
- "th",
1787
- "ti",
1788
- "bo",
1789
- "tk",
1790
- "tl",
1791
- "tn",
1792
- "to",
1793
- "tr",
1794
- "ts",
1795
- "tt",
1796
- "tw",
1797
- "ty",
1798
- "ug",
1799
- "uk",
1800
- "ur",
1801
- "uz",
1802
- "ve",
1803
- "vi",
1804
- "vo",
1805
- "wa",
1806
- "cy",
1807
- "wo",
1808
- "fy",
1809
- "xh",
1810
- "yi",
1811
- "yo",
1812
- "za",
1813
- "zu"
1814
- ],
1815
- "type": "string"
1816
- },
1817
- "text": {
1818
- "minLength": 1,
1819
- "type": "string"
1820
- }
1821
- },
1822
- "type": "object",
1823
- "required": [
1824
- "language",
1825
- "text"
1826
- ]
1827
- },
1828
- "FieldOptionDto": {
1829
- "properties": {
1830
- "key": {
1831
- "not": {
1832
- "type": "null"
1833
- },
1834
- "type": "string",
1835
- "title": "Key",
1836
- "description": "Internal key for the option."
1837
- },
1838
- "value": {
1839
- "not": {
1840
- "type": "null"
1841
- },
1842
- "type": "string",
1843
- "title": "Value",
1844
- "description": "Display value for the option."
1845
- },
1846
- "disabled": {
1847
- "type": "boolean",
1848
- "title": "Disabled",
1849
- "description": "Whether the option is disabled."
1850
- }
1851
- },
1852
- "type": "object",
1853
- "required": [
1854
- "key",
1855
- "value"
1856
- ]
1857
- },
1858
- "FieldDto": {
1859
- "properties": {
1860
- "id": {
1861
- "not": {
1862
- "type": "null"
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"
1863
1836
  },
1864
- "type": "string",
1865
- "title": "ID",
1866
- "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."
1867
1841
  },
1868
- "label": {
1842
+ "requiredRoles": {
1869
1843
  "items": {
1870
- "$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"
1871
1899
  },
1872
1900
  "minItems": 1,
1873
1901
  "type": "array",
1874
- "title": "Label",
1875
- "description": "Multilingual label for the field."
1876
- },
1877
- "value": {
1878
- "not": {
1879
- "type": "null"
1880
- },
1881
- "title": "Value",
1882
- "description": "Value of the field. String/Number, or FieldOptionDto/FieldOptionDto[] depending on type.",
1883
- "oneOf": [
1884
- {
1885
- "title": "String",
1886
- "type": "string"
1887
- },
1888
- {
1889
- "title": "Number",
1890
- "type": "number"
1891
- },
1892
- {
1893
- "title": "Option",
1894
- "$ref": "#/components/schemas/FieldOptionDto"
1895
- },
1896
- {
1897
- "title": "Options Array",
1898
- "type": "array",
1899
- "items": {
1900
- "$ref": "#/components/schemas/FieldOptionDto"
1901
- }
1902
- }
1903
- ]
1904
- },
1905
- "type": {
1906
- "not": {
1907
- "type": "null"
1908
- },
1909
- "enum": [
1910
- "TEXT_BOX",
1911
- "TEXT_AREA",
1912
- "SELECT",
1913
- "MULTI_SELECT",
1914
- "DESCRIPTION",
1915
- "RADIO_BOX",
1916
- "CHECKBOX",
1917
- "SLIDER"
1918
- ],
1919
- "type": "string",
1920
- "title": "Field Type",
1921
- "description": "Type of the field."
1922
- },
1923
- "repeatableMin": {
1924
- "type": "number"
1925
- },
1926
- "repeatableMax": {
1927
- "type": "number"
1928
- },
1929
- "required": {
1930
- "not": {
1931
- "type": "null"
1932
- },
1933
- "type": "boolean",
1934
- "title": "Required",
1935
- "description": "Whether the field is required."
1936
- },
1937
- "disabled": {
1938
- "not": {
1939
- "type": "null"
1940
- },
1941
- "type": "boolean",
1942
- "title": "Disabled",
1943
- "description": "Whether the field is disabled."
1902
+ "title": "Required Roles",
1903
+ "description": "Roles required for this integration to operate."
1944
1904
  },
1945
- "visibleInOrder": {
1946
- "not": {
1947
- "type": "null"
1948
- },
1949
- "type": "boolean",
1950
- "title": "Visible In Order",
1951
- "description": "Whether the field is visible in order."
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"
1952
1910
  },
1953
- "visibleInClientPanel": {
1954
- "not": {
1955
- "type": "null"
1956
- },
1957
- "type": "boolean",
1958
- "title": "Visible In Client Panel",
1959
- "description": "Whether the field is visible in client panel."
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"
1960
1916
  },
1961
- "regexValidation": {
1917
+ "onboardingUrl": {
1918
+ "format": "uri",
1962
1919
  "type": "string",
1963
- "title": "Regex Validation",
1964
- "description": "Optional regex to validate input.",
1965
- "example": "^[A-Za-z0-9_-]+$"
1966
- },
1967
- "regexValidationErrorMessage": {
1968
- "items": {
1969
- "$ref": "#/components/schemas/MultilangTextDto"
1970
- },
1971
- "type": "array",
1972
- "title": "Regex Validation Error Message",
1973
- "description": "Localized error message shown when regex validation fails."
1974
- },
1975
- "triggersRemoteValidation": {
1976
- "type": "boolean",
1977
- "title": "Triggers Remote Validation",
1978
- "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"
1979
1923
  },
1980
- "remoteValidationErrorMessage": {
1924
+ "setupAttributes": {
1981
1925
  "items": {
1982
- "$ref": "#/components/schemas/MultilangTextDto"
1926
+ "$ref": "#/components/schemas/FieldDto"
1983
1927
  },
1984
1928
  "type": "array",
1985
- "title": "Remote Validation Error Message",
1986
- "description": "Localized error messages for remote validation."
1987
- },
1988
- "upgradable": {
1989
- "not": {
1990
- "type": "null"
1991
- },
1992
- "type": "boolean",
1993
- "title": "Upgradable",
1994
- "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."
1995
1932
  }
1996
1933
  },
1997
1934
  "type": "object",
1998
1935
  "required": [
1999
- "id",
2000
- "label",
2001
- "value",
2002
1936
  "type",
2003
- "required",
2004
- "disabled",
2005
- "visibleInOrder",
2006
- "visibleInClientPanel",
2007
- "upgradable"
1937
+ "title",
1938
+ "supportedLanguages"
2008
1939
  ]
2009
1940
  },
2010
1941
  "ProductInfoDto": {
@@ -2267,9 +2198,6 @@ exports.ComponentsSchemas = {
2267
2198
  },
2268
2199
  "minItems": 1,
2269
2200
  "type": "array",
2270
- "not": {
2271
- "type": "null"
2272
- },
2273
2201
  "title": "Supported Languages",
2274
2202
  "description": "Locales supported by the integration.",
2275
2203
  "example": [
@@ -2562,6 +2490,15 @@ exports.ComponentsSchemas = {
2562
2490
  "title": "Onboarding URL",
2563
2491
  "description": "URL to onboard/configure the integration.",
2564
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."
2565
2502
  }
2566
2503
  },
2567
2504
  "type": "object",