@epilot/cli 0.1.187 → 0.1.189

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 (77) hide show
  1. package/README.md +1 -1
  2. package/definitions/chat.json +1092 -1
  3. package/definitions/journey.json +356 -10
  4. package/definitions/pricing.json +949 -130
  5. package/dist/{access-token-K3EEFITL.js → access-token-UJUJQOUE.js} +2 -2
  6. package/dist/{add-component-OHVF6GHM.js → add-component-4HL3TUU4.js} +2 -2
  7. package/dist/{add-function-EA5TLKE2.js → add-function-EM6WZYWO.js} +2 -2
  8. package/dist/{address-Q563EUDC.js → address-55TGVABB.js} +2 -2
  9. package/dist/{address-suggestions-J67M2EZM.js → address-suggestions-TIMMLNQB.js} +2 -2
  10. package/dist/{ai-agents-KPSDQOQE.js → ai-agents-RDL7T77Z.js} +2 -2
  11. package/dist/{api-DN6H6NZL.js → api-P45NF5FD.js} +2 -2
  12. package/dist/app-UVBNHZSK.js +26 -0
  13. package/dist/{audit-logs-4W2KJG4S.js → audit-logs-R542PF5Z.js} +2 -2
  14. package/dist/{automation-HNNOLK54.js → automation-4IDC5B26.js} +2 -2
  15. package/dist/{billing-IHYHZGCM.js → billing-2MMFM7KK.js} +2 -2
  16. package/dist/bin/epilot.js +59 -59
  17. package/dist/{blueprint-manifest-WMQKKRR6.js → blueprint-manifest-PJHTF5LA.js} +2 -2
  18. package/dist/{calendar-QAOQCWMU.js → calendar-ZCSK5LBJ.js} +2 -2
  19. package/dist/{chat-FB6S42LR.js → chat-HX5FFFSM.js} +2 -2
  20. package/dist/{chunk-XGWPL4S5.js → chunk-CO4V7P7K.js} +1 -1
  21. package/dist/{chunk-YG5ECCJY.js → chunk-DKMPNHV3.js} +1 -1
  22. package/dist/{chunk-SNOVAU6A.js → chunk-JHYOEUZW.js} +1 -1
  23. package/dist/{chunk-7PFIKD6A.js → chunk-SLIK7OKM.js} +4 -2
  24. package/dist/{completion-66QFFIPF.js → completion-EIR3ZIXT.js} +1 -1
  25. package/dist/{configuration-hub-2RKCSLMK.js → configuration-hub-YW6B6TQV.js} +2 -2
  26. package/dist/{consent-KUZLQGSQ.js → consent-UFYBI6NG.js} +2 -2
  27. package/dist/{customer-portal-L4OAHC25.js → customer-portal-HSQ77RKF.js} +2 -2
  28. package/dist/{dashboard-J6O7DHS5.js → dashboard-LWVTV6WW.js} +2 -2
  29. package/dist/{data-governance-ZTNSO4L6.js → data-governance-7RR7F37N.js} +2 -2
  30. package/dist/{deduplication-JJUFITO5.js → deduplication-KKUK4MTF.js} +2 -2
  31. package/dist/{deploy-QI74LC3D.js → deploy-R3LWHLYC.js} +2 -2
  32. package/dist/{design-24OWTREI.js → design-WAVFXO2W.js} +2 -2
  33. package/dist/{dev-7GTJJUWI.js → dev-6RVM6CNK.js} +2 -2
  34. package/dist/{document-XWYU4VUR.js → document-2VCLGYEE.js} +2 -2
  35. package/dist/{email-settings-4FNVKKGV.js → email-settings-FRCW37U3.js} +2 -2
  36. package/dist/{email-template-ABJVGRMS.js → email-template-Y5EAT2UK.js} +2 -2
  37. package/dist/{entity-MVS7KKYJ.js → entity-2UFS2OY4.js} +2 -2
  38. package/dist/{entity-mapping-SZPA74XW.js → entity-mapping-X2Z4QHBT.js} +2 -2
  39. package/dist/{environments-PJSBW4KC.js → environments-R54GEDYZ.js} +2 -2
  40. package/dist/{event-catalog-SFVC2TZ7.js → event-catalog-RLMNBT6X.js} +2 -2
  41. package/dist/{export-EWKCSRVL.js → export-JC5X2SPO.js} +2 -2
  42. package/dist/{file-3ZKFSH6X.js → file-PZLBKQ3U.js} +2 -2
  43. package/dist/{iban-IOPTU3FC.js → iban-MEB4KAS5.js} +2 -2
  44. package/dist/{identity-ETX5ULDF.js → identity-NRIXV4GK.js} +2 -2
  45. package/dist/{init-GGNG6IZP.js → init-ZEPYSB4O.js} +2 -2
  46. package/dist/{integration-toolkit-NRJ4R4G6.js → integration-toolkit-YYCLXFIA.js} +2 -2
  47. package/dist/{journey-VF7CPPQ4.js → journey-DEO3NAGR.js} +2 -2
  48. package/dist/{kanban-YKMTDP2O.js → kanban-5JQXZW46.js} +2 -2
  49. package/dist/{message-6LNPHKAQ.js → message-2FWWOXOY.js} +2 -2
  50. package/dist/{metering-AQEOH4PR.js → metering-LRQIIUJO.js} +2 -2
  51. package/dist/{notes-I22AIJYK.js → notes-EHL4T5RL.js} +2 -2
  52. package/dist/{notification-OEK2WBIM.js → notification-W6N3DYAP.js} +2 -2
  53. package/dist/{organization-WSP4VTUD.js → organization-WJM5DZAA.js} +2 -2
  54. package/dist/{partner-directory-LFGXNXS5.js → partner-directory-GIZKJO2U.js} +2 -2
  55. package/dist/{permissions-6IBCUAPQ.js → permissions-2P5LYYSY.js} +2 -2
  56. package/dist/{pricing-I6GSXY2I.js → pricing-ZHYD7L6E.js} +2 -2
  57. package/dist/{pricing-tier-USE6246Q.js → pricing-tier-7S56JOST.js} +2 -2
  58. package/dist/{purpose-2JMP6CTG.js → purpose-KQVLO7V7.js} +2 -2
  59. package/dist/{query-WL7WCZ7U.js → query-WAF2QDBY.js} +2 -2
  60. package/dist/{remove-component-DFHGAD4D.js → remove-component-EGBBJ43V.js} +2 -2
  61. package/dist/{review-G7KAQU56.js → review-NJTIE5ZW.js} +2 -2
  62. package/dist/{sandbox-OFY7FYGU.js → sandbox-TUHU5KDY.js} +2 -2
  63. package/dist/{sharing-DEPPPDIM.js → sharing-DFUEKWI2.js} +2 -2
  64. package/dist/{snapshot-U33QHUNG.js → snapshot-6U45AVFX.js} +2 -2
  65. package/dist/{submission-EWZK2TCC.js → submission-CP43MPNC.js} +2 -2
  66. package/dist/{targeting-JXNBGXZD.js → targeting-PMJ4AQXS.js} +2 -2
  67. package/dist/{template-variables-J3MAF5XC.js → template-variables-FICUOY2R.js} +2 -2
  68. package/dist/{upgrade-CTI2BSVA.js → upgrade-YL5RDPCW.js} +1 -1
  69. package/dist/{user-4Q4NL5RK.js → user-TBE54MCQ.js} +2 -2
  70. package/dist/{validate-K4HFNGEP.js → validate-BM5LIBZE.js} +2 -2
  71. package/dist/{validation-rules-6PJBDCEO.js → validation-rules-XTGQM4XT.js} +2 -2
  72. package/dist/{versions-MEZD24QW.js → versions-IO5XYEF5.js} +2 -2
  73. package/dist/{webhooks-AK7XHMWD.js → webhooks-TN2WPIBR.js} +2 -2
  74. package/dist/{workflow-R7XZRKNG.js → workflow-DNNWRX5J.js} +2 -2
  75. package/dist/{workflow-definition-7WT3RAQS.js → workflow-definition-CW2UEFH2.js} +2 -2
  76. package/package.json +1 -1
  77. package/dist/app-FTWXW43W.js +0 -26
package/definitions/chat.json CHANGED
@@ -137,6 +137,83 @@
137
137
  },
138
138
  "nullable": true,
139
139
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
140
+ },
141
+ "self_service": {
142
+ "type": "object",
143
+ "additionalProperties": false,
144
+ "nullable": true,
145
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
146
+ "required": [
147
+ "actions"
148
+ ],
149
+ "properties": {
150
+ "actions": {
151
+ "type": "array",
152
+ "maxItems": 20,
153
+ "description": "Each action can be added once.",
154
+ "items": {
155
+ "type": "object",
156
+ "additionalProperties": false,
157
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
158
+ "required": [
159
+ "action",
160
+ "enabled",
161
+ "fulfilment",
162
+ "access"
163
+ ],
164
+ "properties": {
165
+ "action": {
166
+ "type": "string",
167
+ "enum": [
168
+ "submit_meter_reading",
169
+ "change_installment_rate",
170
+ "update_payment_method",
171
+ "change_billing_address",
172
+ "update_customer_details",
173
+ "change_tariff",
174
+ "report_move",
175
+ "terminate_contract"
176
+ ]
177
+ },
178
+ "enabled": {
179
+ "type": "boolean"
180
+ },
181
+ "fulfilment": {
182
+ "type": "string",
183
+ "enum": [
184
+ "in_chat",
185
+ "journey",
186
+ "link"
187
+ ]
188
+ },
189
+ "journey_id": {
190
+ "type": "string",
191
+ "format": "uuid",
192
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
193
+ },
194
+ "url": {
195
+ "type": "string",
196
+ "maxLength": 2048,
197
+ "description": "HTTPS address to open; only for link."
198
+ },
199
+ "access": {
200
+ "type": "string",
201
+ "enum": [
202
+ "anonymous",
203
+ "identified",
204
+ "verified"
205
+ ],
206
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
207
+ },
208
+ "guidance": {
209
+ "type": "string",
210
+ "maxLength": 500,
211
+ "description": "When the assistant should start this action."
212
+ }
213
+ }
214
+ }
215
+ }
216
+ }
140
217
  }
141
218
  }
142
219
  },
@@ -392,6 +469,83 @@
392
469
  },
393
470
  "nullable": true,
394
471
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
472
+ },
473
+ "self_service": {
474
+ "type": "object",
475
+ "additionalProperties": false,
476
+ "nullable": true,
477
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
478
+ "required": [
479
+ "actions"
480
+ ],
481
+ "properties": {
482
+ "actions": {
483
+ "type": "array",
484
+ "maxItems": 20,
485
+ "description": "Each action can be added once.",
486
+ "items": {
487
+ "type": "object",
488
+ "additionalProperties": false,
489
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
490
+ "required": [
491
+ "action",
492
+ "enabled",
493
+ "fulfilment",
494
+ "access"
495
+ ],
496
+ "properties": {
497
+ "action": {
498
+ "type": "string",
499
+ "enum": [
500
+ "submit_meter_reading",
501
+ "change_installment_rate",
502
+ "update_payment_method",
503
+ "change_billing_address",
504
+ "update_customer_details",
505
+ "change_tariff",
506
+ "report_move",
507
+ "terminate_contract"
508
+ ]
509
+ },
510
+ "enabled": {
511
+ "type": "boolean"
512
+ },
513
+ "fulfilment": {
514
+ "type": "string",
515
+ "enum": [
516
+ "in_chat",
517
+ "journey",
518
+ "link"
519
+ ]
520
+ },
521
+ "journey_id": {
522
+ "type": "string",
523
+ "format": "uuid",
524
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
525
+ },
526
+ "url": {
527
+ "type": "string",
528
+ "maxLength": 2048,
529
+ "description": "HTTPS address to open; only for link."
530
+ },
531
+ "access": {
532
+ "type": "string",
533
+ "enum": [
534
+ "anonymous",
535
+ "identified",
536
+ "verified"
537
+ ],
538
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
539
+ },
540
+ "guidance": {
541
+ "type": "string",
542
+ "maxLength": 500,
543
+ "description": "When the assistant should start this action."
544
+ }
545
+ }
546
+ }
547
+ }
548
+ }
395
549
  }
396
550
  }
397
551
  },
@@ -613,6 +767,83 @@
613
767
  },
614
768
  "nullable": true,
615
769
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
770
+ },
771
+ "self_service": {
772
+ "type": "object",
773
+ "additionalProperties": false,
774
+ "nullable": true,
775
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
776
+ "required": [
777
+ "actions"
778
+ ],
779
+ "properties": {
780
+ "actions": {
781
+ "type": "array",
782
+ "maxItems": 20,
783
+ "description": "Each action can be added once.",
784
+ "items": {
785
+ "type": "object",
786
+ "additionalProperties": false,
787
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
788
+ "required": [
789
+ "action",
790
+ "enabled",
791
+ "fulfilment",
792
+ "access"
793
+ ],
794
+ "properties": {
795
+ "action": {
796
+ "type": "string",
797
+ "enum": [
798
+ "submit_meter_reading",
799
+ "change_installment_rate",
800
+ "update_payment_method",
801
+ "change_billing_address",
802
+ "update_customer_details",
803
+ "change_tariff",
804
+ "report_move",
805
+ "terminate_contract"
806
+ ]
807
+ },
808
+ "enabled": {
809
+ "type": "boolean"
810
+ },
811
+ "fulfilment": {
812
+ "type": "string",
813
+ "enum": [
814
+ "in_chat",
815
+ "journey",
816
+ "link"
817
+ ]
818
+ },
819
+ "journey_id": {
820
+ "type": "string",
821
+ "format": "uuid",
822
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
823
+ },
824
+ "url": {
825
+ "type": "string",
826
+ "maxLength": 2048,
827
+ "description": "HTTPS address to open; only for link."
828
+ },
829
+ "access": {
830
+ "type": "string",
831
+ "enum": [
832
+ "anonymous",
833
+ "identified",
834
+ "verified"
835
+ ],
836
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
837
+ },
838
+ "guidance": {
839
+ "type": "string",
840
+ "maxLength": 500,
841
+ "description": "When the assistant should start this action."
842
+ }
843
+ }
844
+ }
845
+ }
846
+ }
616
847
  }
617
848
  }
618
849
  }
@@ -747,6 +978,83 @@
747
978
  },
748
979
  "nullable": true,
749
980
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
981
+ },
982
+ "self_service": {
983
+ "type": "object",
984
+ "additionalProperties": false,
985
+ "nullable": true,
986
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
987
+ "required": [
988
+ "actions"
989
+ ],
990
+ "properties": {
991
+ "actions": {
992
+ "type": "array",
993
+ "maxItems": 20,
994
+ "description": "Each action can be added once.",
995
+ "items": {
996
+ "type": "object",
997
+ "additionalProperties": false,
998
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
999
+ "required": [
1000
+ "action",
1001
+ "enabled",
1002
+ "fulfilment",
1003
+ "access"
1004
+ ],
1005
+ "properties": {
1006
+ "action": {
1007
+ "type": "string",
1008
+ "enum": [
1009
+ "submit_meter_reading",
1010
+ "change_installment_rate",
1011
+ "update_payment_method",
1012
+ "change_billing_address",
1013
+ "update_customer_details",
1014
+ "change_tariff",
1015
+ "report_move",
1016
+ "terminate_contract"
1017
+ ]
1018
+ },
1019
+ "enabled": {
1020
+ "type": "boolean"
1021
+ },
1022
+ "fulfilment": {
1023
+ "type": "string",
1024
+ "enum": [
1025
+ "in_chat",
1026
+ "journey",
1027
+ "link"
1028
+ ]
1029
+ },
1030
+ "journey_id": {
1031
+ "type": "string",
1032
+ "format": "uuid",
1033
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
1034
+ },
1035
+ "url": {
1036
+ "type": "string",
1037
+ "maxLength": 2048,
1038
+ "description": "HTTPS address to open; only for link."
1039
+ },
1040
+ "access": {
1041
+ "type": "string",
1042
+ "enum": [
1043
+ "anonymous",
1044
+ "identified",
1045
+ "verified"
1046
+ ],
1047
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
1048
+ },
1049
+ "guidance": {
1050
+ "type": "string",
1051
+ "maxLength": 500,
1052
+ "description": "When the assistant should start this action."
1053
+ }
1054
+ }
1055
+ }
1056
+ }
1057
+ }
750
1058
  }
751
1059
  }
752
1060
  },
@@ -986,6 +1294,83 @@
986
1294
  },
987
1295
  "nullable": true,
988
1296
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
1297
+ },
1298
+ "self_service": {
1299
+ "type": "object",
1300
+ "additionalProperties": false,
1301
+ "nullable": true,
1302
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
1303
+ "required": [
1304
+ "actions"
1305
+ ],
1306
+ "properties": {
1307
+ "actions": {
1308
+ "type": "array",
1309
+ "maxItems": 20,
1310
+ "description": "Each action can be added once.",
1311
+ "items": {
1312
+ "type": "object",
1313
+ "additionalProperties": false,
1314
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
1315
+ "required": [
1316
+ "action",
1317
+ "enabled",
1318
+ "fulfilment",
1319
+ "access"
1320
+ ],
1321
+ "properties": {
1322
+ "action": {
1323
+ "type": "string",
1324
+ "enum": [
1325
+ "submit_meter_reading",
1326
+ "change_installment_rate",
1327
+ "update_payment_method",
1328
+ "change_billing_address",
1329
+ "update_customer_details",
1330
+ "change_tariff",
1331
+ "report_move",
1332
+ "terminate_contract"
1333
+ ]
1334
+ },
1335
+ "enabled": {
1336
+ "type": "boolean"
1337
+ },
1338
+ "fulfilment": {
1339
+ "type": "string",
1340
+ "enum": [
1341
+ "in_chat",
1342
+ "journey",
1343
+ "link"
1344
+ ]
1345
+ },
1346
+ "journey_id": {
1347
+ "type": "string",
1348
+ "format": "uuid",
1349
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
1350
+ },
1351
+ "url": {
1352
+ "type": "string",
1353
+ "maxLength": 2048,
1354
+ "description": "HTTPS address to open; only for link."
1355
+ },
1356
+ "access": {
1357
+ "type": "string",
1358
+ "enum": [
1359
+ "anonymous",
1360
+ "identified",
1361
+ "verified"
1362
+ ],
1363
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
1364
+ },
1365
+ "guidance": {
1366
+ "type": "string",
1367
+ "maxLength": 500,
1368
+ "description": "When the assistant should start this action."
1369
+ }
1370
+ }
1371
+ }
1372
+ }
1373
+ }
989
1374
  }
990
1375
  }
991
1376
  },
@@ -1205,6 +1590,83 @@
1205
1590
  },
1206
1591
  "nullable": true,
1207
1592
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
1593
+ },
1594
+ "self_service": {
1595
+ "type": "object",
1596
+ "additionalProperties": false,
1597
+ "nullable": true,
1598
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
1599
+ "required": [
1600
+ "actions"
1601
+ ],
1602
+ "properties": {
1603
+ "actions": {
1604
+ "type": "array",
1605
+ "maxItems": 20,
1606
+ "description": "Each action can be added once.",
1607
+ "items": {
1608
+ "type": "object",
1609
+ "additionalProperties": false,
1610
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
1611
+ "required": [
1612
+ "action",
1613
+ "enabled",
1614
+ "fulfilment",
1615
+ "access"
1616
+ ],
1617
+ "properties": {
1618
+ "action": {
1619
+ "type": "string",
1620
+ "enum": [
1621
+ "submit_meter_reading",
1622
+ "change_installment_rate",
1623
+ "update_payment_method",
1624
+ "change_billing_address",
1625
+ "update_customer_details",
1626
+ "change_tariff",
1627
+ "report_move",
1628
+ "terminate_contract"
1629
+ ]
1630
+ },
1631
+ "enabled": {
1632
+ "type": "boolean"
1633
+ },
1634
+ "fulfilment": {
1635
+ "type": "string",
1636
+ "enum": [
1637
+ "in_chat",
1638
+ "journey",
1639
+ "link"
1640
+ ]
1641
+ },
1642
+ "journey_id": {
1643
+ "type": "string",
1644
+ "format": "uuid",
1645
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
1646
+ },
1647
+ "url": {
1648
+ "type": "string",
1649
+ "maxLength": 2048,
1650
+ "description": "HTTPS address to open; only for link."
1651
+ },
1652
+ "access": {
1653
+ "type": "string",
1654
+ "enum": [
1655
+ "anonymous",
1656
+ "identified",
1657
+ "verified"
1658
+ ],
1659
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
1660
+ },
1661
+ "guidance": {
1662
+ "type": "string",
1663
+ "maxLength": 500,
1664
+ "description": "When the assistant should start this action."
1665
+ }
1666
+ }
1667
+ }
1668
+ }
1669
+ }
1208
1670
  }
1209
1671
  }
1210
1672
  },
@@ -2060,7 +2522,7 @@
2060
2522
  },
2061
2523
  "responses": {
2062
2524
  "200": {
2063
- "description": "SSE data frames whose JSON payload follows the PublicEvent component schema.\nOnly delta, complete and error events are public. Completion follows persistence.\n",
2525
+ "description": "SSE data frames whose JSON payload follows the PublicEvent component schema.\nOnly delta, action, complete and error events are public. Completion follows persistence.\n",
2064
2526
  "content": {
2065
2527
  "text/event-stream": {
2066
2528
  "schema": {
@@ -4857,6 +5319,83 @@
4857
5319
  },
4858
5320
  "nullable": true,
4859
5321
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
5322
+ },
5323
+ "self_service": {
5324
+ "type": "object",
5325
+ "additionalProperties": false,
5326
+ "nullable": true,
5327
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
5328
+ "required": [
5329
+ "actions"
5330
+ ],
5331
+ "properties": {
5332
+ "actions": {
5333
+ "type": "array",
5334
+ "maxItems": 20,
5335
+ "description": "Each action can be added once.",
5336
+ "items": {
5337
+ "type": "object",
5338
+ "additionalProperties": false,
5339
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
5340
+ "required": [
5341
+ "action",
5342
+ "enabled",
5343
+ "fulfilment",
5344
+ "access"
5345
+ ],
5346
+ "properties": {
5347
+ "action": {
5348
+ "type": "string",
5349
+ "enum": [
5350
+ "submit_meter_reading",
5351
+ "change_installment_rate",
5352
+ "update_payment_method",
5353
+ "change_billing_address",
5354
+ "update_customer_details",
5355
+ "change_tariff",
5356
+ "report_move",
5357
+ "terminate_contract"
5358
+ ]
5359
+ },
5360
+ "enabled": {
5361
+ "type": "boolean"
5362
+ },
5363
+ "fulfilment": {
5364
+ "type": "string",
5365
+ "enum": [
5366
+ "in_chat",
5367
+ "journey",
5368
+ "link"
5369
+ ]
5370
+ },
5371
+ "journey_id": {
5372
+ "type": "string",
5373
+ "format": "uuid",
5374
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
5375
+ },
5376
+ "url": {
5377
+ "type": "string",
5378
+ "maxLength": 2048,
5379
+ "description": "HTTPS address to open; only for link."
5380
+ },
5381
+ "access": {
5382
+ "type": "string",
5383
+ "enum": [
5384
+ "anonymous",
5385
+ "identified",
5386
+ "verified"
5387
+ ],
5388
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
5389
+ },
5390
+ "guidance": {
5391
+ "type": "string",
5392
+ "maxLength": 500,
5393
+ "description": "When the assistant should start this action."
5394
+ }
5395
+ }
5396
+ }
5397
+ }
5398
+ }
4860
5399
  }
4861
5400
  }
4862
5401
  },
@@ -5019,6 +5558,83 @@
5019
5558
  },
5020
5559
  "nullable": true,
5021
5560
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
5561
+ },
5562
+ "self_service": {
5563
+ "type": "object",
5564
+ "additionalProperties": false,
5565
+ "nullable": true,
5566
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
5567
+ "required": [
5568
+ "actions"
5569
+ ],
5570
+ "properties": {
5571
+ "actions": {
5572
+ "type": "array",
5573
+ "maxItems": 20,
5574
+ "description": "Each action can be added once.",
5575
+ "items": {
5576
+ "type": "object",
5577
+ "additionalProperties": false,
5578
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
5579
+ "required": [
5580
+ "action",
5581
+ "enabled",
5582
+ "fulfilment",
5583
+ "access"
5584
+ ],
5585
+ "properties": {
5586
+ "action": {
5587
+ "type": "string",
5588
+ "enum": [
5589
+ "submit_meter_reading",
5590
+ "change_installment_rate",
5591
+ "update_payment_method",
5592
+ "change_billing_address",
5593
+ "update_customer_details",
5594
+ "change_tariff",
5595
+ "report_move",
5596
+ "terminate_contract"
5597
+ ]
5598
+ },
5599
+ "enabled": {
5600
+ "type": "boolean"
5601
+ },
5602
+ "fulfilment": {
5603
+ "type": "string",
5604
+ "enum": [
5605
+ "in_chat",
5606
+ "journey",
5607
+ "link"
5608
+ ]
5609
+ },
5610
+ "journey_id": {
5611
+ "type": "string",
5612
+ "format": "uuid",
5613
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
5614
+ },
5615
+ "url": {
5616
+ "type": "string",
5617
+ "maxLength": 2048,
5618
+ "description": "HTTPS address to open; only for link."
5619
+ },
5620
+ "access": {
5621
+ "type": "string",
5622
+ "enum": [
5623
+ "anonymous",
5624
+ "identified",
5625
+ "verified"
5626
+ ],
5627
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
5628
+ },
5629
+ "guidance": {
5630
+ "type": "string",
5631
+ "maxLength": 500,
5632
+ "description": "When the assistant should start this action."
5633
+ }
5634
+ }
5635
+ }
5636
+ }
5637
+ }
5022
5638
  }
5023
5639
  }
5024
5640
  },
@@ -5150,6 +5766,221 @@
5150
5766
  },
5151
5767
  "nullable": true,
5152
5768
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
5769
+ },
5770
+ "self_service": {
5771
+ "type": "object",
5772
+ "additionalProperties": false,
5773
+ "nullable": true,
5774
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
5775
+ "required": [
5776
+ "actions"
5777
+ ],
5778
+ "properties": {
5779
+ "actions": {
5780
+ "type": "array",
5781
+ "maxItems": 20,
5782
+ "description": "Each action can be added once.",
5783
+ "items": {
5784
+ "type": "object",
5785
+ "additionalProperties": false,
5786
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
5787
+ "required": [
5788
+ "action",
5789
+ "enabled",
5790
+ "fulfilment",
5791
+ "access"
5792
+ ],
5793
+ "properties": {
5794
+ "action": {
5795
+ "type": "string",
5796
+ "enum": [
5797
+ "submit_meter_reading",
5798
+ "change_installment_rate",
5799
+ "update_payment_method",
5800
+ "change_billing_address",
5801
+ "update_customer_details",
5802
+ "change_tariff",
5803
+ "report_move",
5804
+ "terminate_contract"
5805
+ ]
5806
+ },
5807
+ "enabled": {
5808
+ "type": "boolean"
5809
+ },
5810
+ "fulfilment": {
5811
+ "type": "string",
5812
+ "enum": [
5813
+ "in_chat",
5814
+ "journey",
5815
+ "link"
5816
+ ]
5817
+ },
5818
+ "journey_id": {
5819
+ "type": "string",
5820
+ "format": "uuid",
5821
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
5822
+ },
5823
+ "url": {
5824
+ "type": "string",
5825
+ "maxLength": 2048,
5826
+ "description": "HTTPS address to open; only for link."
5827
+ },
5828
+ "access": {
5829
+ "type": "string",
5830
+ "enum": [
5831
+ "anonymous",
5832
+ "identified",
5833
+ "verified"
5834
+ ],
5835
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
5836
+ },
5837
+ "guidance": {
5838
+ "type": "string",
5839
+ "maxLength": 500,
5840
+ "description": "When the assistant should start this action."
5841
+ }
5842
+ }
5843
+ }
5844
+ }
5845
+ }
5846
+ }
5847
+ }
5848
+ },
5849
+ "SelfServiceSettings": {
5850
+ "type": "object",
5851
+ "additionalProperties": false,
5852
+ "nullable": true,
5853
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
5854
+ "required": [
5855
+ "actions"
5856
+ ],
5857
+ "properties": {
5858
+ "actions": {
5859
+ "type": "array",
5860
+ "maxItems": 20,
5861
+ "description": "Each action can be added once.",
5862
+ "items": {
5863
+ "type": "object",
5864
+ "additionalProperties": false,
5865
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
5866
+ "required": [
5867
+ "action",
5868
+ "enabled",
5869
+ "fulfilment",
5870
+ "access"
5871
+ ],
5872
+ "properties": {
5873
+ "action": {
5874
+ "type": "string",
5875
+ "enum": [
5876
+ "submit_meter_reading",
5877
+ "change_installment_rate",
5878
+ "update_payment_method",
5879
+ "change_billing_address",
5880
+ "update_customer_details",
5881
+ "change_tariff",
5882
+ "report_move",
5883
+ "terminate_contract"
5884
+ ]
5885
+ },
5886
+ "enabled": {
5887
+ "type": "boolean"
5888
+ },
5889
+ "fulfilment": {
5890
+ "type": "string",
5891
+ "enum": [
5892
+ "in_chat",
5893
+ "journey",
5894
+ "link"
5895
+ ]
5896
+ },
5897
+ "journey_id": {
5898
+ "type": "string",
5899
+ "format": "uuid",
5900
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
5901
+ },
5902
+ "url": {
5903
+ "type": "string",
5904
+ "maxLength": 2048,
5905
+ "description": "HTTPS address to open; only for link."
5906
+ },
5907
+ "access": {
5908
+ "type": "string",
5909
+ "enum": [
5910
+ "anonymous",
5911
+ "identified",
5912
+ "verified"
5913
+ ],
5914
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
5915
+ },
5916
+ "guidance": {
5917
+ "type": "string",
5918
+ "maxLength": 500,
5919
+ "description": "When the assistant should start this action."
5920
+ }
5921
+ }
5922
+ }
5923
+ }
5924
+ }
5925
+ },
5926
+ "SelfServiceAction": {
5927
+ "type": "object",
5928
+ "additionalProperties": false,
5929
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
5930
+ "required": [
5931
+ "action",
5932
+ "enabled",
5933
+ "fulfilment",
5934
+ "access"
5935
+ ],
5936
+ "properties": {
5937
+ "action": {
5938
+ "type": "string",
5939
+ "enum": [
5940
+ "submit_meter_reading",
5941
+ "change_installment_rate",
5942
+ "update_payment_method",
5943
+ "change_billing_address",
5944
+ "update_customer_details",
5945
+ "change_tariff",
5946
+ "report_move",
5947
+ "terminate_contract"
5948
+ ]
5949
+ },
5950
+ "enabled": {
5951
+ "type": "boolean"
5952
+ },
5953
+ "fulfilment": {
5954
+ "type": "string",
5955
+ "enum": [
5956
+ "in_chat",
5957
+ "journey",
5958
+ "link"
5959
+ ]
5960
+ },
5961
+ "journey_id": {
5962
+ "type": "string",
5963
+ "format": "uuid",
5964
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
5965
+ },
5966
+ "url": {
5967
+ "type": "string",
5968
+ "maxLength": 2048,
5969
+ "description": "HTTPS address to open; only for link."
5970
+ },
5971
+ "access": {
5972
+ "type": "string",
5973
+ "enum": [
5974
+ "anonymous",
5975
+ "identified",
5976
+ "verified"
5977
+ ],
5978
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
5979
+ },
5980
+ "guidance": {
5981
+ "type": "string",
5982
+ "maxLength": 500,
5983
+ "description": "When the assistant should start this action."
5153
5984
  }
5154
5985
  }
5155
5986
  },
@@ -5258,6 +6089,83 @@
5258
6089
  },
5259
6090
  "nullable": true,
5260
6091
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
6092
+ },
6093
+ "self_service": {
6094
+ "type": "object",
6095
+ "additionalProperties": false,
6096
+ "nullable": true,
6097
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
6098
+ "required": [
6099
+ "actions"
6100
+ ],
6101
+ "properties": {
6102
+ "actions": {
6103
+ "type": "array",
6104
+ "maxItems": 20,
6105
+ "description": "Each action can be added once.",
6106
+ "items": {
6107
+ "type": "object",
6108
+ "additionalProperties": false,
6109
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
6110
+ "required": [
6111
+ "action",
6112
+ "enabled",
6113
+ "fulfilment",
6114
+ "access"
6115
+ ],
6116
+ "properties": {
6117
+ "action": {
6118
+ "type": "string",
6119
+ "enum": [
6120
+ "submit_meter_reading",
6121
+ "change_installment_rate",
6122
+ "update_payment_method",
6123
+ "change_billing_address",
6124
+ "update_customer_details",
6125
+ "change_tariff",
6126
+ "report_move",
6127
+ "terminate_contract"
6128
+ ]
6129
+ },
6130
+ "enabled": {
6131
+ "type": "boolean"
6132
+ },
6133
+ "fulfilment": {
6134
+ "type": "string",
6135
+ "enum": [
6136
+ "in_chat",
6137
+ "journey",
6138
+ "link"
6139
+ ]
6140
+ },
6141
+ "journey_id": {
6142
+ "type": "string",
6143
+ "format": "uuid",
6144
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
6145
+ },
6146
+ "url": {
6147
+ "type": "string",
6148
+ "maxLength": 2048,
6149
+ "description": "HTTPS address to open; only for link."
6150
+ },
6151
+ "access": {
6152
+ "type": "string",
6153
+ "enum": [
6154
+ "anonymous",
6155
+ "identified",
6156
+ "verified"
6157
+ ],
6158
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
6159
+ },
6160
+ "guidance": {
6161
+ "type": "string",
6162
+ "maxLength": 500,
6163
+ "description": "When the assistant should start this action."
6164
+ }
6165
+ }
6166
+ }
6167
+ }
6168
+ }
5261
6169
  }
5262
6170
  }
5263
6171
  }
@@ -5352,6 +6260,83 @@
5352
6260
  },
5353
6261
  "nullable": true,
5354
6262
  "description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
6263
+ },
6264
+ "self_service": {
6265
+ "type": "object",
6266
+ "additionalProperties": false,
6267
+ "nullable": true,
6268
+ "description": "Self-service actions customers can start in this Website Chat. On update, the list is replaced as a whole; null removes all actions.",
6269
+ "required": [
6270
+ "actions"
6271
+ ],
6272
+ "properties": {
6273
+ "actions": {
6274
+ "type": "array",
6275
+ "maxItems": 20,
6276
+ "description": "Each action can be added once.",
6277
+ "items": {
6278
+ "type": "object",
6279
+ "additionalProperties": false,
6280
+ "description": "How a self-service action is done and who can start it. A journey needs journey_id, a link needs url. in_chat is only available for submit_meter_reading and requires a verified customer.",
6281
+ "required": [
6282
+ "action",
6283
+ "enabled",
6284
+ "fulfilment",
6285
+ "access"
6286
+ ],
6287
+ "properties": {
6288
+ "action": {
6289
+ "type": "string",
6290
+ "enum": [
6291
+ "submit_meter_reading",
6292
+ "change_installment_rate",
6293
+ "update_payment_method",
6294
+ "change_billing_address",
6295
+ "update_customer_details",
6296
+ "change_tariff",
6297
+ "report_move",
6298
+ "terminate_contract"
6299
+ ]
6300
+ },
6301
+ "enabled": {
6302
+ "type": "boolean"
6303
+ },
6304
+ "fulfilment": {
6305
+ "type": "string",
6306
+ "enum": [
6307
+ "in_chat",
6308
+ "journey",
6309
+ "link"
6310
+ ]
6311
+ },
6312
+ "journey_id": {
6313
+ "type": "string",
6314
+ "format": "uuid",
6315
+ "description": "Journey to open; only for journey. Must be a journey of this organisation that the saving user can access."
6316
+ },
6317
+ "url": {
6318
+ "type": "string",
6319
+ "maxLength": 2048,
6320
+ "description": "HTTPS address to open; only for link."
6321
+ },
6322
+ "access": {
6323
+ "type": "string",
6324
+ "enum": [
6325
+ "anonymous",
6326
+ "identified",
6327
+ "verified"
6328
+ ],
6329
+ "description": "Who can start the action. verified customers log in first. identified is not available yet (identifiers login is planned) and is rejected."
6330
+ },
6331
+ "guidance": {
6332
+ "type": "string",
6333
+ "maxLength": 500,
6334
+ "description": "When the assistant should start this action."
6335
+ }
6336
+ }
6337
+ }
6338
+ }
6339
+ }
5355
6340
  }
5356
6341
  }
5357
6342
  },
@@ -6121,9 +7106,115 @@
6121
7106
  "format": "uuid"
6122
7107
  }
6123
7108
  }
7109
+ },
7110
+ {
7111
+ "type": "object",
7112
+ "description": "The assistant started a self-service action. Sent at most once per reply, just before complete. How it is done comes from the Website Chat's settings, never from the model. Clients should ignore event types they do not know.",
7113
+ "additionalProperties": false,
7114
+ "required": [
7115
+ "type",
7116
+ "action",
7117
+ "request_id"
7118
+ ],
7119
+ "properties": {
7120
+ "type": {
7121
+ "type": "string",
7122
+ "enum": [
7123
+ "action"
7124
+ ]
7125
+ },
7126
+ "action": {
7127
+ "type": "object",
7128
+ "additionalProperties": false,
7129
+ "required": [
7130
+ "action",
7131
+ "fulfilment",
7132
+ "access"
7133
+ ],
7134
+ "properties": {
7135
+ "action": {
7136
+ "type": "string",
7137
+ "pattern": "^[a-z][a-z_]{0,59}$"
7138
+ },
7139
+ "fulfilment": {
7140
+ "type": "string",
7141
+ "enum": [
7142
+ "in_chat",
7143
+ "journey",
7144
+ "link"
7145
+ ],
7146
+ "description": "in_chat uses the guided action endpoints; journey embeds journey_id; link opens url."
7147
+ },
7148
+ "journey_id": {
7149
+ "type": "string",
7150
+ "format": "uuid"
7151
+ },
7152
+ "url": {
7153
+ "type": "string",
7154
+ "pattern": "^https://",
7155
+ "maxLength": 2048
7156
+ },
7157
+ "access": {
7158
+ "type": "string",
7159
+ "enum": [
7160
+ "anonymous",
7161
+ "identified",
7162
+ "verified"
7163
+ ],
7164
+ "description": "The least the customer must have before the action opens. Log in first when below it."
7165
+ }
7166
+ }
7167
+ },
7168
+ "request_id": {
7169
+ "type": "string",
7170
+ "format": "uuid"
7171
+ }
7172
+ }
6124
7173
  }
6125
7174
  ]
6126
7175
  },
7176
+ "SelfServiceDirective": {
7177
+ "type": "object",
7178
+ "additionalProperties": false,
7179
+ "required": [
7180
+ "action",
7181
+ "fulfilment",
7182
+ "access"
7183
+ ],
7184
+ "properties": {
7185
+ "action": {
7186
+ "type": "string",
7187
+ "pattern": "^[a-z][a-z_]{0,59}$"
7188
+ },
7189
+ "fulfilment": {
7190
+ "type": "string",
7191
+ "enum": [
7192
+ "in_chat",
7193
+ "journey",
7194
+ "link"
7195
+ ],
7196
+ "description": "in_chat uses the guided action endpoints; journey embeds journey_id; link opens url."
7197
+ },
7198
+ "journey_id": {
7199
+ "type": "string",
7200
+ "format": "uuid"
7201
+ },
7202
+ "url": {
7203
+ "type": "string",
7204
+ "pattern": "^https://",
7205
+ "maxLength": 2048
7206
+ },
7207
+ "access": {
7208
+ "type": "string",
7209
+ "enum": [
7210
+ "anonymous",
7211
+ "identified",
7212
+ "verified"
7213
+ ],
7214
+ "description": "The least the customer must have before the action opens. Log in first when below it."
7215
+ }
7216
+ }
7217
+ },
6127
7218
  "PublicChatError": {
6128
7219
  "type": "object",
6129
7220
  "required": [