@epilot/cli 0.1.207 → 0.1.209

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 (78) hide show
  1. package/README.md +1 -1
  2. package/definitions/chat.json +257 -193
  3. package/definitions/message.json +1312 -14
  4. package/dist/{access-token-FGAUDV62.js → access-token-E52IDEQZ.js} +2 -2
  5. package/dist/{add-component-4GY7ZZC5.js → add-component-6PICQWS6.js} +2 -2
  6. package/dist/{add-function-WBYHWXDG.js → add-function-LE3Q7DOF.js} +2 -2
  7. package/dist/{address-RNSPQT7W.js → address-3ZLW6HF5.js} +2 -2
  8. package/dist/{address-suggestions-TI2JGGBU.js → address-suggestions-ZYXSSPPC.js} +2 -2
  9. package/dist/{ai-agents-IELGKT4V.js → ai-agents-TH2DSIKX.js} +2 -2
  10. package/dist/{api-UPKQZHPM.js → api-LAV4VRIY.js} +2 -2
  11. package/dist/app-W6AAYOLM.js +26 -0
  12. package/dist/{audit-logs-VJ7HJK2A.js → audit-logs-I75GPLBH.js} +2 -2
  13. package/dist/{automation-HR4PIS4I.js → automation-MEWP6VKG.js} +2 -2
  14. package/dist/{billing-65Y34GY4.js → billing-FER6BGVQ.js} +2 -2
  15. package/dist/bin/epilot.js +61 -61
  16. package/dist/{blueprint-manifest-BLY7IQIZ.js → blueprint-manifest-A2KBN4I2.js} +2 -2
  17. package/dist/{calendar-JUFY2LQM.js → calendar-ZNGEI4BI.js} +2 -2
  18. package/dist/{chat-G6AFUJUT.js → chat-PRUVSBON.js} +2 -2
  19. package/dist/{chunk-MUYLBXHF.js → chunk-5RFFYPAR.js} +3 -1
  20. package/dist/{chunk-HSTIWNGZ.js → chunk-D2MISITH.js} +1 -1
  21. package/dist/{chunk-SEIPXYY7.js → chunk-M5Y42I6C.js} +1 -1
  22. package/dist/{chunk-DNH3VFLE.js → chunk-QR5ZIWD4.js} +1 -1
  23. package/dist/{completion-OKQFJS6O.js → completion-P2M7EXKA.js} +1 -1
  24. package/dist/{configuration-hub-VELSIN7I.js → configuration-hub-JEUMPYF6.js} +2 -2
  25. package/dist/{consent-O5E5RMUK.js → consent-W2HRB57P.js} +2 -2
  26. package/dist/{customer-portal-657GYWHQ.js → customer-portal-CQUFAXCM.js} +2 -2
  27. package/dist/{dashboard-SDYBU545.js → dashboard-7WH45BNZ.js} +2 -2
  28. package/dist/{data-governance-3FKIXCJ2.js → data-governance-B44WSSIT.js} +2 -2
  29. package/dist/{deduplication-NICX34OO.js → deduplication-53D4VFOS.js} +2 -2
  30. package/dist/{deploy-4ADPLZHN.js → deploy-5FWLTH7E.js} +2 -2
  31. package/dist/{design-Q272PZ2D.js → design-HPFJHGAX.js} +2 -2
  32. package/dist/{dev-S35LJYLT.js → dev-YGN3F5RL.js} +2 -2
  33. package/dist/{document-C24KNKKO.js → document-HY6O2DNO.js} +2 -2
  34. package/dist/{email-settings-DML2QCD4.js → email-settings-B4FHJULW.js} +2 -2
  35. package/dist/{email-template-4BBQ2FBV.js → email-template-EHUOPCAC.js} +2 -2
  36. package/dist/{entity-YOBIQV6Y.js → entity-XO63VXCC.js} +2 -2
  37. package/dist/{entity-mapping-P6YJNT4X.js → entity-mapping-P4N7ZM5G.js} +2 -2
  38. package/dist/{environments-TX7LC4VR.js → environments-HSCAQDC3.js} +2 -2
  39. package/dist/{event-catalog-KUKYVZB2.js → event-catalog-7OQ2MOVY.js} +2 -2
  40. package/dist/{export-L7WWMWLO.js → export-VJXAEFNB.js} +2 -2
  41. package/dist/{external-values-MHDFHJBG.js → external-values-3PG3F3MG.js} +2 -2
  42. package/dist/{file-UI6IVACD.js → file-NWONL4MX.js} +2 -2
  43. package/dist/{iban-FMTDAKJZ.js → iban-J5N7IWI3.js} +2 -2
  44. package/dist/{identity-TRAUTLUC.js → identity-L6R5K6WS.js} +2 -2
  45. package/dist/{init-BLEPPNUE.js → init-LQG7W7ZE.js} +2 -2
  46. package/dist/{integration-toolkit-3RC7SUOX.js → integration-toolkit-4G42DHRB.js} +2 -2
  47. package/dist/{journey-M5VJ6XKZ.js → journey-OEDLPUOA.js} +2 -2
  48. package/dist/{kanban-5UBW23OA.js → kanban-N25RGSPR.js} +2 -2
  49. package/dist/{message-5ANGLTIZ.js → message-HEL37GGL.js} +2 -2
  50. package/dist/{metering-JQXPZR5D.js → metering-VAJVRFG7.js} +2 -2
  51. package/dist/{notes-SONXF7L4.js → notes-DDHZ45XX.js} +2 -2
  52. package/dist/{notification-25MWAEZN.js → notification-XUTRX4WO.js} +2 -2
  53. package/dist/{organization-U33ODSR2.js → organization-FB6NFYNF.js} +2 -2
  54. package/dist/{partner-directory-B7ERDOQM.js → partner-directory-F4FEXFWH.js} +2 -2
  55. package/dist/{permissions-VX65UISC.js → permissions-RGZKCTY3.js} +2 -2
  56. package/dist/{phone-integration-JXJL7DON.js → phone-integration-WCQDXTU4.js} +2 -2
  57. package/dist/{pricing-DPT7E33R.js → pricing-XCMOLJJY.js} +2 -2
  58. package/dist/{pricing-tier-NP36K747.js → pricing-tier-O5U5O4H7.js} +2 -2
  59. package/dist/{purpose-NCPSRGLG.js → purpose-MNT2KLTR.js} +2 -2
  60. package/dist/{query-RIWEIFX7.js → query-NJGJPCVW.js} +2 -2
  61. package/dist/{remove-component-K5N4V7N4.js → remove-component-PBGS5R3P.js} +2 -2
  62. package/dist/{review-YPTDVRHD.js → review-YLO4Z74J.js} +2 -2
  63. package/dist/{sandbox-MBK6JWP2.js → sandbox-RMVFAXYQ.js} +2 -2
  64. package/dist/{sharing-BQUYRLP2.js → sharing-5BVU7D7A.js} +2 -2
  65. package/dist/{snapshot-Z3MXNC2P.js → snapshot-KBKGLANK.js} +2 -2
  66. package/dist/{submission-UCQKKZ3R.js → submission-PTCDM2S4.js} +2 -2
  67. package/dist/{targeting-HBYF5ZGA.js → targeting-Q6QVR7I2.js} +2 -2
  68. package/dist/{template-variables-W3S6JI7M.js → template-variables-BPI76XDE.js} +2 -2
  69. package/dist/{upgrade-I5HC5ERF.js → upgrade-PZNJ5RMF.js} +1 -1
  70. package/dist/{user-OSY27VJN.js → user-VNIHFF25.js} +2 -2
  71. package/dist/{validate-TK5KPEQN.js → validate-MPJE7KAP.js} +2 -2
  72. package/dist/{validation-rules-BG6SCSVK.js → validation-rules-HCFUM22H.js} +2 -2
  73. package/dist/{versions-BZXZQXPL.js → versions-XDF5ICPC.js} +2 -2
  74. package/dist/{webhooks-5W3NFT33.js → webhooks-MP3P66SM.js} +2 -2
  75. package/dist/{workflow-LPXW2DBZ.js → workflow-ARLTRWC2.js} +2 -2
  76. package/dist/{workflow-definition-ZIKMLEGW.js → workflow-definition-YPO45D6Z.js} +2 -2
  77. package/package.json +1 -1
  78. package/dist/app-H2233TGE.js +0 -26
package/definitions/chat.json CHANGED
@@ -48,18 +48,12 @@
48
48
  "agent_id",
49
49
  "binding_id",
50
50
  "version",
51
- "name",
52
51
  "settings",
53
52
  "embed",
54
53
  "created_at",
55
54
  "updated_at"
56
55
  ],
57
56
  "properties": {
58
- "name": {
59
- "type": "string",
60
- "minLength": 1,
61
- "maxLength": 100
62
- },
63
57
  "agent_id": {
64
58
  "type": "string",
65
59
  "format": "uuid",
@@ -70,7 +64,6 @@
70
64
  "additionalProperties": false,
71
65
  "required": [
72
66
  "allowed_origins",
73
- "organisation_name",
74
67
  "default_locale"
75
68
  ],
76
69
  "properties": {
@@ -84,11 +77,6 @@
84
77
  "maxLength": 2048
85
78
  }
86
79
  },
87
- "organisation_name": {
88
- "type": "string",
89
- "minLength": 1,
90
- "maxLength": 100
91
- },
92
80
  "default_locale": {
93
81
  "type": "string",
94
82
  "enum": [
@@ -380,18 +368,12 @@
380
368
  "agent_id",
381
369
  "binding_id",
382
370
  "version",
383
- "name",
384
371
  "settings",
385
372
  "embed",
386
373
  "created_at",
387
374
  "updated_at"
388
375
  ],
389
376
  "properties": {
390
- "name": {
391
- "type": "string",
392
- "minLength": 1,
393
- "maxLength": 100
394
- },
395
377
  "agent_id": {
396
378
  "type": "string",
397
379
  "format": "uuid",
@@ -402,7 +384,6 @@
402
384
  "additionalProperties": false,
403
385
  "required": [
404
386
  "allowed_origins",
405
- "organisation_name",
406
387
  "default_locale"
407
388
  ],
408
389
  "properties": {
@@ -416,11 +397,6 @@
416
397
  "maxLength": 2048
417
398
  }
418
399
  },
419
- "organisation_name": {
420
- "type": "string",
421
- "minLength": 1,
422
- "maxLength": 100
423
- },
424
400
  "default_locale": {
425
401
  "type": "string",
426
402
  "enum": [
@@ -680,16 +656,10 @@
680
656
  "type": "object",
681
657
  "additionalProperties": false,
682
658
  "required": [
683
- "name",
684
659
  "agent_id",
685
660
  "settings"
686
661
  ],
687
662
  "properties": {
688
- "name": {
689
- "type": "string",
690
- "minLength": 1,
691
- "maxLength": 100
692
- },
693
663
  "agent_id": {
694
664
  "type": "string",
695
665
  "format": "uuid",
@@ -700,7 +670,6 @@
700
670
  "additionalProperties": false,
701
671
  "required": [
702
672
  "allowed_origins",
703
- "organisation_name",
704
673
  "default_locale"
705
674
  ],
706
675
  "properties": {
@@ -714,11 +683,6 @@
714
683
  "maxLength": 2048
715
684
  }
716
685
  },
717
- "organisation_name": {
718
- "type": "string",
719
- "minLength": 1,
720
- "maxLength": 100
721
- },
722
686
  "default_locale": {
723
687
  "type": "string",
724
688
  "enum": [
@@ -889,18 +853,12 @@
889
853
  "agent_id",
890
854
  "binding_id",
891
855
  "version",
892
- "name",
893
856
  "settings",
894
857
  "embed",
895
858
  "created_at",
896
859
  "updated_at"
897
860
  ],
898
861
  "properties": {
899
- "name": {
900
- "type": "string",
901
- "minLength": 1,
902
- "maxLength": 100
903
- },
904
862
  "agent_id": {
905
863
  "type": "string",
906
864
  "format": "uuid",
@@ -911,7 +869,6 @@
911
869
  "additionalProperties": false,
912
870
  "required": [
913
871
  "allowed_origins",
914
- "organisation_name",
915
872
  "default_locale"
916
873
  ],
917
874
  "properties": {
@@ -925,11 +882,6 @@
925
882
  "maxLength": 2048
926
883
  }
927
884
  },
928
- "organisation_name": {
929
- "type": "string",
930
- "minLength": 1,
931
- "maxLength": 100
932
- },
933
885
  "default_locale": {
934
886
  "type": "string",
935
887
  "enum": [
@@ -1205,18 +1157,12 @@
1205
1157
  "agent_id",
1206
1158
  "binding_id",
1207
1159
  "version",
1208
- "name",
1209
1160
  "settings",
1210
1161
  "embed",
1211
1162
  "created_at",
1212
1163
  "updated_at"
1213
1164
  ],
1214
1165
  "properties": {
1215
- "name": {
1216
- "type": "string",
1217
- "minLength": 1,
1218
- "maxLength": 100
1219
- },
1220
1166
  "agent_id": {
1221
1167
  "type": "string",
1222
1168
  "format": "uuid",
@@ -1227,7 +1173,6 @@
1227
1173
  "additionalProperties": false,
1228
1174
  "required": [
1229
1175
  "allowed_origins",
1230
- "organisation_name",
1231
1176
  "default_locale"
1232
1177
  ],
1233
1178
  "properties": {
@@ -1241,11 +1186,6 @@
1241
1186
  "maxLength": 2048
1242
1187
  }
1243
1188
  },
1244
- "organisation_name": {
1245
- "type": "string",
1246
- "minLength": 1,
1247
- "maxLength": 100
1248
- },
1249
1189
  "default_locale": {
1250
1190
  "type": "string",
1251
1191
  "enum": [
@@ -1508,11 +1448,6 @@
1508
1448
  "version"
1509
1449
  ],
1510
1450
  "properties": {
1511
- "name": {
1512
- "type": "string",
1513
- "minLength": 1,
1514
- "maxLength": 100
1515
- },
1516
1451
  "agent_id": {
1517
1452
  "type": "string",
1518
1453
  "format": "uuid",
@@ -1523,7 +1458,6 @@
1523
1458
  "additionalProperties": false,
1524
1459
  "required": [
1525
1460
  "allowed_origins",
1526
- "organisation_name",
1527
1461
  "default_locale"
1528
1462
  ],
1529
1463
  "properties": {
@@ -1537,11 +1471,6 @@
1537
1471
  "maxLength": 2048
1538
1472
  }
1539
1473
  },
1540
- "organisation_name": {
1541
- "type": "string",
1542
- "minLength": 1,
1543
- "maxLength": 100
1544
- },
1545
1474
  "default_locale": {
1546
1475
  "type": "string",
1547
1476
  "enum": [
@@ -1808,6 +1737,11 @@
1808
1737
  "format": "uuid",
1809
1738
  "nullable": true,
1810
1739
  "description": "Unsaved design to preview. Omit to keep the saved design; null previews the default design."
1740
+ },
1741
+ "demo_customer": {
1742
+ "type": "boolean",
1743
+ "default": false,
1744
+ "description": "Start the preview as a fictional, verified demo customer (no login, no sign-out). In-chat actions are simulated with demo data and write nothing; the Website Chat frame shows journeys as a simulated hand-off and never loads them."
1811
1745
  }
1812
1746
  }
1813
1747
  }
@@ -1844,8 +1778,6 @@
1844
1778
  "type": "object",
1845
1779
  "required": [
1846
1780
  "key",
1847
- "organisationName",
1848
- "assistantName",
1849
1781
  "defaultLocale",
1850
1782
  "locales",
1851
1783
  "login_methods"
@@ -1854,11 +1786,39 @@
1854
1786
  "key": {
1855
1787
  "type": "string"
1856
1788
  },
1857
- "organisationName": {
1858
- "type": "string"
1789
+ "assistant_name": {
1790
+ "type": "object",
1791
+ "additionalProperties": false,
1792
+ "description": "Display name of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
1793
+ "properties": {
1794
+ "de": {
1795
+ "type": "string",
1796
+ "minLength": 1,
1797
+ "maxLength": 100
1798
+ },
1799
+ "en": {
1800
+ "type": "string",
1801
+ "minLength": 1,
1802
+ "maxLength": 100
1803
+ }
1804
+ }
1859
1805
  },
1860
- "assistantName": {
1861
- "type": "string"
1806
+ "greeting": {
1807
+ "type": "object",
1808
+ "additionalProperties": false,
1809
+ "description": "Greeting of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
1810
+ "properties": {
1811
+ "de": {
1812
+ "type": "string",
1813
+ "minLength": 1,
1814
+ "maxLength": 1000
1815
+ },
1816
+ "en": {
1817
+ "type": "string",
1818
+ "minLength": 1,
1819
+ "maxLength": 1000
1820
+ }
1821
+ }
1862
1822
  },
1863
1823
  "defaultLocale": {
1864
1824
  "type": "string",
@@ -2182,8 +2142,6 @@
2182
2142
  "type": "object",
2183
2143
  "required": [
2184
2144
  "key",
2185
- "organisationName",
2186
- "assistantName",
2187
2145
  "defaultLocale",
2188
2146
  "locales",
2189
2147
  "login_methods"
@@ -2192,11 +2150,39 @@
2192
2150
  "key": {
2193
2151
  "type": "string"
2194
2152
  },
2195
- "organisationName": {
2196
- "type": "string"
2153
+ "assistant_name": {
2154
+ "type": "object",
2155
+ "additionalProperties": false,
2156
+ "description": "Display name of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
2157
+ "properties": {
2158
+ "de": {
2159
+ "type": "string",
2160
+ "minLength": 1,
2161
+ "maxLength": 100
2162
+ },
2163
+ "en": {
2164
+ "type": "string",
2165
+ "minLength": 1,
2166
+ "maxLength": 100
2167
+ }
2168
+ }
2197
2169
  },
2198
- "assistantName": {
2199
- "type": "string"
2170
+ "greeting": {
2171
+ "type": "object",
2172
+ "additionalProperties": false,
2173
+ "description": "Greeting of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
2174
+ "properties": {
2175
+ "de": {
2176
+ "type": "string",
2177
+ "minLength": 1,
2178
+ "maxLength": 1000
2179
+ },
2180
+ "en": {
2181
+ "type": "string",
2182
+ "minLength": 1,
2183
+ "maxLength": 1000
2184
+ }
2185
+ }
2200
2186
  },
2201
2187
  "defaultLocale": {
2202
2188
  "type": "string",
@@ -2598,7 +2584,7 @@
2598
2584
  },
2599
2585
  "responses": {
2600
2586
  "201": {
2601
- "description": "An isolated anonymous conversation",
2587
+ "description": "An isolated conversation. Anonymous, except that an Agent Builder demo customer preview starts verified (access method demo).",
2602
2588
  "content": {
2603
2589
  "application/json": {
2604
2590
  "schema": {
@@ -2625,8 +2611,6 @@
2625
2611
  "type": "object",
2626
2612
  "required": [
2627
2613
  "key",
2628
- "organisationName",
2629
- "assistantName",
2630
2614
  "defaultLocale",
2631
2615
  "locales",
2632
2616
  "login_methods"
@@ -2635,11 +2619,39 @@
2635
2619
  "key": {
2636
2620
  "type": "string"
2637
2621
  },
2638
- "organisationName": {
2639
- "type": "string"
2622
+ "assistant_name": {
2623
+ "type": "object",
2624
+ "additionalProperties": false,
2625
+ "description": "Display name of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
2626
+ "properties": {
2627
+ "de": {
2628
+ "type": "string",
2629
+ "minLength": 1,
2630
+ "maxLength": 100
2631
+ },
2632
+ "en": {
2633
+ "type": "string",
2634
+ "minLength": 1,
2635
+ "maxLength": 100
2636
+ }
2637
+ }
2640
2638
  },
2641
- "assistantName": {
2642
- "type": "string"
2639
+ "greeting": {
2640
+ "type": "object",
2641
+ "additionalProperties": false,
2642
+ "description": "Greeting of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
2643
+ "properties": {
2644
+ "de": {
2645
+ "type": "string",
2646
+ "minLength": 1,
2647
+ "maxLength": 1000
2648
+ },
2649
+ "en": {
2650
+ "type": "string",
2651
+ "minLength": 1,
2652
+ "maxLength": 1000
2653
+ }
2654
+ }
2643
2655
  },
2644
2656
  "defaultLocale": {
2645
2657
  "type": "string",
@@ -2848,6 +2860,33 @@
2848
2860
  "preview": {
2849
2861
  "type": "boolean",
2850
2862
  "description": "Agent Builder preview session; the frame only runs it inside the 360 portal."
2863
+ },
2864
+ "access": {
2865
+ "type": "object",
2866
+ "additionalProperties": false,
2867
+ "required": [
2868
+ "tier"
2869
+ ],
2870
+ "properties": {
2871
+ "tier": {
2872
+ "type": "string",
2873
+ "enum": [
2874
+ "anonymous",
2875
+ "identified",
2876
+ "verified"
2877
+ ],
2878
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
2879
+ },
2880
+ "method": {
2881
+ "type": "string",
2882
+ "enum": [
2883
+ "email_code",
2884
+ "portal_login",
2885
+ "demo"
2886
+ ],
2887
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
2888
+ }
2889
+ }
2851
2890
  }
2852
2891
  }
2853
2892
  }
@@ -3107,15 +3146,16 @@
3107
3146
  "identified",
3108
3147
  "verified"
3109
3148
  ],
3110
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
3149
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
3111
3150
  },
3112
3151
  "method": {
3113
3152
  "type": "string",
3114
3153
  "enum": [
3115
3154
  "email_code",
3116
- "portal_login"
3155
+ "portal_login",
3156
+ "demo"
3117
3157
  ],
3118
- "description": "How a customer can log in or verify themselves in the chat."
3158
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
3119
3159
  }
3120
3160
  }
3121
3161
  }
@@ -3293,15 +3333,16 @@
3293
3333
  "identified",
3294
3334
  "verified"
3295
3335
  ],
3296
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
3336
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
3297
3337
  },
3298
3338
  "method": {
3299
3339
  "type": "string",
3300
3340
  "enum": [
3301
3341
  "email_code",
3302
- "portal_login"
3342
+ "portal_login",
3343
+ "demo"
3303
3344
  ],
3304
- "description": "How a customer can log in or verify themselves in the chat."
3345
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
3305
3346
  }
3306
3347
  }
3307
3348
  }
@@ -3470,15 +3511,16 @@
3470
3511
  "identified",
3471
3512
  "verified"
3472
3513
  ],
3473
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
3514
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
3474
3515
  },
3475
3516
  "method": {
3476
3517
  "type": "string",
3477
3518
  "enum": [
3478
3519
  "email_code",
3479
- "portal_login"
3520
+ "portal_login",
3521
+ "demo"
3480
3522
  ],
3481
- "description": "How a customer can log in or verify themselves in the chat."
3523
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
3482
3524
  }
3483
3525
  }
3484
3526
  }
@@ -3622,15 +3664,16 @@
3622
3664
  "identified",
3623
3665
  "verified"
3624
3666
  ],
3625
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
3667
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
3626
3668
  },
3627
3669
  "method": {
3628
3670
  "type": "string",
3629
3671
  "enum": [
3630
3672
  "email_code",
3631
- "portal_login"
3673
+ "portal_login",
3674
+ "demo"
3632
3675
  ],
3633
- "description": "How a customer can log in or verify themselves in the chat."
3676
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
3634
3677
  }
3635
3678
  }
3636
3679
  }
@@ -3772,15 +3815,16 @@
3772
3815
  "identified",
3773
3816
  "verified"
3774
3817
  ],
3775
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
3818
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
3776
3819
  },
3777
3820
  "method": {
3778
3821
  "type": "string",
3779
3822
  "enum": [
3780
3823
  "email_code",
3781
- "portal_login"
3824
+ "portal_login",
3825
+ "demo"
3782
3826
  ],
3783
- "description": "How a customer can log in or verify themselves in the chat."
3827
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
3784
3828
  }
3785
3829
  }
3786
3830
  }
@@ -4038,15 +4082,16 @@
4038
4082
  "identified",
4039
4083
  "verified"
4040
4084
  ],
4041
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
4085
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
4042
4086
  },
4043
4087
  "method": {
4044
4088
  "type": "string",
4045
4089
  "enum": [
4046
4090
  "email_code",
4047
- "portal_login"
4091
+ "portal_login",
4092
+ "demo"
4048
4093
  ],
4049
- "description": "How a customer can log in or verify themselves in the chat."
4094
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
4050
4095
  }
4051
4096
  }
4052
4097
  }
@@ -4213,15 +4258,16 @@
4213
4258
  "identified",
4214
4259
  "verified"
4215
4260
  ],
4216
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
4261
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
4217
4262
  },
4218
4263
  "method": {
4219
4264
  "type": "string",
4220
4265
  "enum": [
4221
4266
  "email_code",
4222
- "portal_login"
4267
+ "portal_login",
4268
+ "demo"
4223
4269
  ],
4224
- "description": "How a customer can log in or verify themselves in the chat."
4270
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
4225
4271
  }
4226
4272
  }
4227
4273
  }
@@ -4363,15 +4409,16 @@
4363
4409
  "identified",
4364
4410
  "verified"
4365
4411
  ],
4366
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
4412
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
4367
4413
  },
4368
4414
  "method": {
4369
4415
  "type": "string",
4370
4416
  "enum": [
4371
4417
  "email_code",
4372
- "portal_login"
4418
+ "portal_login",
4419
+ "demo"
4373
4420
  ],
4374
- "description": "How a customer can log in or verify themselves in the chat."
4421
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
4375
4422
  }
4376
4423
  }
4377
4424
  }
@@ -4444,7 +4491,7 @@
4444
4491
  "AnonymousSession": []
4445
4492
  }
4446
4493
  ],
4447
- "description": "Clear the customer identity of any login method and pending challenges. Clearing an identity starts a new anonymous conversation.",
4494
+ "description": "Clear the customer identity of any login method and pending challenges. Clearing an identity starts a new anonymous conversation. The demo customer of an Agent Builder preview stays signed in for the whole session (403 LOGIN_DISABLED); it cannot start an email verification or portal login either.",
4448
4495
  "responses": {
4449
4496
  "200": {
4450
4497
  "description": "Anonymous access",
@@ -4476,15 +4523,16 @@
4476
4523
  "identified",
4477
4524
  "verified"
4478
4525
  ],
4479
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
4526
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
4480
4527
  },
4481
4528
  "method": {
4482
4529
  "type": "string",
4483
4530
  "enum": [
4484
4531
  "email_code",
4485
- "portal_login"
4532
+ "portal_login",
4533
+ "demo"
4486
4534
  ],
4487
- "description": "How a customer can log in or verify themselves in the chat."
4535
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
4488
4536
  }
4489
4537
  }
4490
4538
  }
@@ -5857,18 +5905,12 @@
5857
5905
  "agent_id",
5858
5906
  "binding_id",
5859
5907
  "version",
5860
- "name",
5861
5908
  "settings",
5862
5909
  "embed",
5863
5910
  "created_at",
5864
5911
  "updated_at"
5865
5912
  ],
5866
5913
  "properties": {
5867
- "name": {
5868
- "type": "string",
5869
- "minLength": 1,
5870
- "maxLength": 100
5871
- },
5872
5914
  "agent_id": {
5873
5915
  "type": "string",
5874
5916
  "format": "uuid",
@@ -5879,7 +5921,6 @@
5879
5921
  "additionalProperties": false,
5880
5922
  "required": [
5881
5923
  "allowed_origins",
5882
- "organisation_name",
5883
5924
  "default_locale"
5884
5925
  ],
5885
5926
  "properties": {
@@ -5893,11 +5934,6 @@
5893
5934
  "maxLength": 2048
5894
5935
  }
5895
5936
  },
5896
- "organisation_name": {
5897
- "type": "string",
5898
- "minLength": 1,
5899
- "maxLength": 100
5900
- },
5901
5937
  "default_locale": {
5902
5938
  "type": "string",
5903
5939
  "enum": [
@@ -6096,18 +6132,12 @@
6096
6132
  "agent_id",
6097
6133
  "binding_id",
6098
6134
  "version",
6099
- "name",
6100
6135
  "settings",
6101
6136
  "embed",
6102
6137
  "created_at",
6103
6138
  "updated_at"
6104
6139
  ],
6105
6140
  "properties": {
6106
- "name": {
6107
- "type": "string",
6108
- "minLength": 1,
6109
- "maxLength": 100
6110
- },
6111
6141
  "agent_id": {
6112
6142
  "type": "string",
6113
6143
  "format": "uuid",
@@ -6118,7 +6148,6 @@
6118
6148
  "additionalProperties": false,
6119
6149
  "required": [
6120
6150
  "allowed_origins",
6121
- "organisation_name",
6122
6151
  "default_locale"
6123
6152
  ],
6124
6153
  "properties": {
@@ -6132,11 +6161,6 @@
6132
6161
  "maxLength": 2048
6133
6162
  }
6134
6163
  },
6135
- "organisation_name": {
6136
- "type": "string",
6137
- "minLength": 1,
6138
- "maxLength": 100
6139
- },
6140
6164
  "default_locale": {
6141
6165
  "type": "string",
6142
6166
  "enum": [
@@ -6326,7 +6350,6 @@
6326
6350
  "additionalProperties": false,
6327
6351
  "required": [
6328
6352
  "allowed_origins",
6329
- "organisation_name",
6330
6353
  "default_locale"
6331
6354
  ],
6332
6355
  "properties": {
@@ -6340,11 +6363,6 @@
6340
6363
  "maxLength": 2048
6341
6364
  }
6342
6365
  },
6343
- "organisation_name": {
6344
- "type": "string",
6345
- "minLength": 1,
6346
- "maxLength": 100
6347
- },
6348
6366
  "default_locale": {
6349
6367
  "type": "string",
6350
6368
  "enum": [
@@ -6620,6 +6638,11 @@
6620
6638
  "format": "uuid",
6621
6639
  "nullable": true,
6622
6640
  "description": "Unsaved design to preview. Omit to keep the saved design; null previews the default design."
6641
+ },
6642
+ "demo_customer": {
6643
+ "type": "boolean",
6644
+ "default": false,
6645
+ "description": "Start the preview as a fictional, verified demo customer (no login, no sign-out). In-chat actions are simulated with demo data and write nothing; the Website Chat frame shows journeys as a simulated hand-off and never loads them."
6623
6646
  }
6624
6647
  }
6625
6648
  },
@@ -6648,8 +6671,6 @@
6648
6671
  "type": "object",
6649
6672
  "required": [
6650
6673
  "key",
6651
- "organisationName",
6652
- "assistantName",
6653
6674
  "defaultLocale",
6654
6675
  "locales",
6655
6676
  "login_methods"
@@ -6658,11 +6679,39 @@
6658
6679
  "key": {
6659
6680
  "type": "string"
6660
6681
  },
6661
- "organisationName": {
6662
- "type": "string"
6682
+ "assistant_name": {
6683
+ "type": "object",
6684
+ "additionalProperties": false,
6685
+ "description": "Display name of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
6686
+ "properties": {
6687
+ "de": {
6688
+ "type": "string",
6689
+ "minLength": 1,
6690
+ "maxLength": 100
6691
+ },
6692
+ "en": {
6693
+ "type": "string",
6694
+ "minLength": 1,
6695
+ "maxLength": 100
6696
+ }
6697
+ }
6663
6698
  },
6664
- "assistantName": {
6665
- "type": "string"
6699
+ "greeting": {
6700
+ "type": "object",
6701
+ "additionalProperties": false,
6702
+ "description": "Greeting of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
6703
+ "properties": {
6704
+ "de": {
6705
+ "type": "string",
6706
+ "minLength": 1,
6707
+ "maxLength": 1000
6708
+ },
6709
+ "en": {
6710
+ "type": "string",
6711
+ "minLength": 1,
6712
+ "maxLength": 1000
6713
+ }
6714
+ }
6666
6715
  },
6667
6716
  "defaultLocale": {
6668
6717
  "type": "string",
@@ -6888,16 +6937,10 @@
6888
6937
  "type": "object",
6889
6938
  "additionalProperties": false,
6890
6939
  "required": [
6891
- "name",
6892
6940
  "agent_id",
6893
6941
  "settings"
6894
6942
  ],
6895
6943
  "properties": {
6896
- "name": {
6897
- "type": "string",
6898
- "minLength": 1,
6899
- "maxLength": 100
6900
- },
6901
6944
  "agent_id": {
6902
6945
  "type": "string",
6903
6946
  "format": "uuid",
@@ -6908,7 +6951,6 @@
6908
6951
  "additionalProperties": false,
6909
6952
  "required": [
6910
6953
  "allowed_origins",
6911
- "organisation_name",
6912
6954
  "default_locale"
6913
6955
  ],
6914
6956
  "properties": {
@@ -6922,11 +6964,6 @@
6922
6964
  "maxLength": 2048
6923
6965
  }
6924
6966
  },
6925
- "organisation_name": {
6926
- "type": "string",
6927
- "minLength": 1,
6928
- "maxLength": 100
6929
- },
6930
6967
  "default_locale": {
6931
6968
  "type": "string",
6932
6969
  "enum": [
@@ -7064,11 +7101,6 @@
7064
7101
  "version"
7065
7102
  ],
7066
7103
  "properties": {
7067
- "name": {
7068
- "type": "string",
7069
- "minLength": 1,
7070
- "maxLength": 100
7071
- },
7072
7104
  "agent_id": {
7073
7105
  "type": "string",
7074
7106
  "format": "uuid",
@@ -7079,7 +7111,6 @@
7079
7111
  "additionalProperties": false,
7080
7112
  "required": [
7081
7113
  "allowed_origins",
7082
- "organisation_name",
7083
7114
  "default_locale"
7084
7115
  ],
7085
7116
  "properties": {
@@ -7093,11 +7124,6 @@
7093
7124
  "maxLength": 2048
7094
7125
  }
7095
7126
  },
7096
- "organisation_name": {
7097
- "type": "string",
7098
- "minLength": 1,
7099
- "maxLength": 100
7100
- },
7101
7127
  "default_locale": {
7102
7128
  "type": "string",
7103
7129
  "enum": [
@@ -7447,15 +7473,16 @@
7447
7473
  "identified",
7448
7474
  "verified"
7449
7475
  ],
7450
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
7476
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
7451
7477
  },
7452
7478
  "method": {
7453
7479
  "type": "string",
7454
7480
  "enum": [
7455
7481
  "email_code",
7456
- "portal_login"
7482
+ "portal_login",
7483
+ "demo"
7457
7484
  ],
7458
- "description": "How a customer can log in or verify themselves in the chat."
7485
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
7459
7486
  }
7460
7487
  }
7461
7488
  }
@@ -7524,15 +7551,16 @@
7524
7551
  "identified",
7525
7552
  "verified"
7526
7553
  ],
7527
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
7554
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
7528
7555
  },
7529
7556
  "method": {
7530
7557
  "type": "string",
7531
7558
  "enum": [
7532
7559
  "email_code",
7533
- "portal_login"
7560
+ "portal_login",
7561
+ "demo"
7534
7562
  ],
7535
- "description": "How a customer can log in or verify themselves in the chat."
7563
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
7536
7564
  }
7537
7565
  }
7538
7566
  }
@@ -7546,6 +7574,15 @@
7546
7574
  ],
7547
7575
  "description": "How a customer can log in or verify themselves in the chat."
7548
7576
  },
7577
+ "AccessMethod": {
7578
+ "type": "string",
7579
+ "enum": [
7580
+ "email_code",
7581
+ "portal_login",
7582
+ "demo"
7583
+ ],
7584
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
7585
+ },
7549
7586
  "AccessTier": {
7550
7587
  "type": "string",
7551
7588
  "enum": [
@@ -7553,7 +7590,7 @@
7553
7590
  "identified",
7554
7591
  "verified"
7555
7592
  ],
7556
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
7593
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
7557
7594
  },
7558
7595
  "CustomerAccess": {
7559
7596
  "type": "object",
@@ -7569,15 +7606,16 @@
7569
7606
  "identified",
7570
7607
  "verified"
7571
7608
  ],
7572
- "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login).\n"
7609
+ "description": "anonymous: no customer identity. identified: the Contact is known but ownership\nis not proven. verified: ownership is proven (an email code or a portal login), or the\ndemo customer of an Agent Builder preview.\n"
7573
7610
  },
7574
7611
  "method": {
7575
7612
  "type": "string",
7576
7613
  "enum": [
7577
7614
  "email_code",
7578
- "portal_login"
7615
+ "portal_login",
7616
+ "demo"
7579
7617
  ],
7580
- "description": "How a customer can log in or verify themselves in the chat."
7618
+ "description": "How the current customer identity was established. demo is the fictional, verified\ncustomer of an Agent Builder preview; it is never a login method.\n"
7581
7619
  }
7582
7620
  }
7583
7621
  },
@@ -7594,8 +7632,6 @@
7594
7632
  "type": "object",
7595
7633
  "required": [
7596
7634
  "key",
7597
- "organisationName",
7598
- "assistantName",
7599
7635
  "defaultLocale",
7600
7636
  "locales",
7601
7637
  "login_methods"
@@ -7604,11 +7640,39 @@
7604
7640
  "key": {
7605
7641
  "type": "string"
7606
7642
  },
7607
- "organisationName": {
7608
- "type": "string"
7643
+ "assistant_name": {
7644
+ "type": "object",
7645
+ "additionalProperties": false,
7646
+ "description": "Display name of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
7647
+ "properties": {
7648
+ "de": {
7649
+ "type": "string",
7650
+ "minLength": 1,
7651
+ "maxLength": 100
7652
+ },
7653
+ "en": {
7654
+ "type": "string",
7655
+ "minLength": 1,
7656
+ "maxLength": 100
7657
+ }
7658
+ }
7609
7659
  },
7610
- "assistantName": {
7611
- "type": "string"
7660
+ "greeting": {
7661
+ "type": "object",
7662
+ "additionalProperties": false,
7663
+ "description": "Greeting of the assigned Agent Builder website agent, by locale. Only locales with a value are present, and the object is absent when none has one; clients then show their own default.",
7664
+ "properties": {
7665
+ "de": {
7666
+ "type": "string",
7667
+ "minLength": 1,
7668
+ "maxLength": 1000
7669
+ },
7670
+ "en": {
7671
+ "type": "string",
7672
+ "minLength": 1,
7673
+ "maxLength": 1000
7674
+ }
7675
+ }
7612
7676
  },
7613
7677
  "defaultLocale": {
7614
7678
  "type": "string",