@epilot/sdk 2.20.66 → 2.20.67

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 (129) hide show
  1. package/definitions/chat.json +257 -193
  2. package/dist/apis/access-token.cjs +6 -6
  3. package/dist/apis/access-token.js +1 -1
  4. package/dist/apis/address-suggestions.cjs +6 -6
  5. package/dist/apis/address-suggestions.js +1 -1
  6. package/dist/apis/address.cjs +6 -6
  7. package/dist/apis/address.js +1 -1
  8. package/dist/apis/ai-agents.cjs +6 -6
  9. package/dist/apis/ai-agents.js +1 -1
  10. package/dist/apis/app.cjs +6 -6
  11. package/dist/apis/app.js +1 -1
  12. package/dist/apis/audit-logs.cjs +6 -6
  13. package/dist/apis/audit-logs.js +1 -1
  14. package/dist/apis/automation.cjs +6 -6
  15. package/dist/apis/automation.js +1 -1
  16. package/dist/apis/billing.cjs +6 -6
  17. package/dist/apis/billing.js +1 -1
  18. package/dist/apis/blueprint-manifest.cjs +6 -6
  19. package/dist/apis/blueprint-manifest.js +1 -1
  20. package/dist/apis/calendar.cjs +6 -6
  21. package/dist/apis/calendar.js +1 -1
  22. package/dist/apis/chat.cjs +6 -6
  23. package/dist/apis/chat.d.cts +2 -2
  24. package/dist/apis/chat.d.ts +2 -2
  25. package/dist/apis/chat.js +1 -1
  26. package/dist/apis/configuration-hub.cjs +6 -6
  27. package/dist/apis/configuration-hub.js +1 -1
  28. package/dist/apis/consent.cjs +6 -6
  29. package/dist/apis/consent.js +1 -1
  30. package/dist/apis/customer-portal.cjs +6 -6
  31. package/dist/apis/customer-portal.js +1 -1
  32. package/dist/apis/dashboard.cjs +6 -6
  33. package/dist/apis/dashboard.js +1 -1
  34. package/dist/apis/data-governance.cjs +6 -6
  35. package/dist/apis/data-governance.js +1 -1
  36. package/dist/apis/deduplication.cjs +6 -6
  37. package/dist/apis/deduplication.js +1 -1
  38. package/dist/apis/design.cjs +6 -6
  39. package/dist/apis/design.js +1 -1
  40. package/dist/apis/document.cjs +6 -6
  41. package/dist/apis/document.js +1 -1
  42. package/dist/apis/email-settings.cjs +6 -6
  43. package/dist/apis/email-settings.js +1 -1
  44. package/dist/apis/email-template.cjs +6 -6
  45. package/dist/apis/email-template.js +1 -1
  46. package/dist/apis/entity-mapping.cjs +6 -6
  47. package/dist/apis/entity-mapping.js +1 -1
  48. package/dist/apis/entity.cjs +6 -6
  49. package/dist/apis/entity.js +1 -1
  50. package/dist/apis/environments.cjs +6 -6
  51. package/dist/apis/environments.js +1 -1
  52. package/dist/apis/event-catalog.cjs +6 -6
  53. package/dist/apis/event-catalog.js +1 -1
  54. package/dist/apis/external-values.cjs +6 -6
  55. package/dist/apis/external-values.js +1 -1
  56. package/dist/apis/file.cjs +6 -6
  57. package/dist/apis/file.js +1 -1
  58. package/dist/apis/iban.cjs +6 -6
  59. package/dist/apis/iban.js +1 -1
  60. package/dist/apis/identity.cjs +6 -6
  61. package/dist/apis/identity.js +1 -1
  62. package/dist/apis/integration-toolkit.cjs +6 -6
  63. package/dist/apis/integration-toolkit.js +1 -1
  64. package/dist/apis/journey.cjs +6 -6
  65. package/dist/apis/journey.js +1 -1
  66. package/dist/apis/kanban.cjs +6 -6
  67. package/dist/apis/kanban.js +1 -1
  68. package/dist/apis/message.cjs +6 -6
  69. package/dist/apis/message.js +1 -1
  70. package/dist/apis/metering.cjs +6 -6
  71. package/dist/apis/metering.js +1 -1
  72. package/dist/apis/notes.cjs +6 -6
  73. package/dist/apis/notes.js +1 -1
  74. package/dist/apis/notification.cjs +6 -6
  75. package/dist/apis/notification.js +1 -1
  76. package/dist/apis/organization.cjs +6 -6
  77. package/dist/apis/organization.js +1 -1
  78. package/dist/apis/partner-directory.cjs +6 -6
  79. package/dist/apis/partner-directory.js +1 -1
  80. package/dist/apis/permissions.cjs +6 -6
  81. package/dist/apis/permissions.js +1 -1
  82. package/dist/apis/phone-integration.cjs +6 -6
  83. package/dist/apis/phone-integration.js +1 -1
  84. package/dist/apis/pricing-tier.cjs +6 -6
  85. package/dist/apis/pricing-tier.js +1 -1
  86. package/dist/apis/pricing.cjs +6 -6
  87. package/dist/apis/pricing.js +1 -1
  88. package/dist/apis/purpose.cjs +6 -6
  89. package/dist/apis/purpose.js +1 -1
  90. package/dist/apis/query.cjs +6 -6
  91. package/dist/apis/query.js +1 -1
  92. package/dist/apis/sandbox.cjs +6 -6
  93. package/dist/apis/sandbox.js +1 -1
  94. package/dist/apis/sharing.cjs +6 -6
  95. package/dist/apis/sharing.js +1 -1
  96. package/dist/apis/snapshot.cjs +6 -6
  97. package/dist/apis/snapshot.js +1 -1
  98. package/dist/apis/submission.cjs +6 -6
  99. package/dist/apis/submission.js +1 -1
  100. package/dist/apis/target.cjs +6 -6
  101. package/dist/apis/target.js +1 -1
  102. package/dist/apis/targeting.cjs +6 -6
  103. package/dist/apis/targeting.js +1 -1
  104. package/dist/apis/template-variables.cjs +6 -6
  105. package/dist/apis/template-variables.js +1 -1
  106. package/dist/apis/user.cjs +6 -6
  107. package/dist/apis/user.js +1 -1
  108. package/dist/apis/validation-rules.cjs +6 -6
  109. package/dist/apis/validation-rules.js +1 -1
  110. package/dist/apis/webhooks.cjs +6 -6
  111. package/dist/apis/webhooks.js +1 -1
  112. package/dist/apis/workflow-definition.cjs +6 -6
  113. package/dist/apis/workflow-definition.js +1 -1
  114. package/dist/apis/workflow.cjs +6 -6
  115. package/dist/apis/workflow.js +1 -1
  116. package/dist/chat-QZJ5P6HQ.cjs +7 -0
  117. package/dist/chat-T6GUSV2K.js +7 -0
  118. package/dist/{chat.d-BUkItuYX.d.cts → chat.d-B6dICX6Y.d.cts} +177 -71
  119. package/dist/{chat.d-BUkItuYX.d.ts → chat.d-B6dICX6Y.d.ts} +177 -71
  120. package/dist/{chunk-3UL4JWCK.cjs → chunk-JJDDKFBB.cjs} +1 -1
  121. package/dist/{chunk-SGTQJYAX.js → chunk-OOBSXWVB.js} +1 -1
  122. package/dist/index.cjs +8 -8
  123. package/dist/index.d.cts +1 -1
  124. package/dist/index.d.ts +1 -1
  125. package/dist/index.js +1 -1
  126. package/docs/chat.md +64 -37
  127. package/package.json +1 -1
  128. package/dist/chat-UYCCJWAM.js +0 -7
  129. package/dist/chat-YYRMNUXU.cjs +0 -7
@@ -20,9 +20,16 @@ declare namespace Components {
20
20
  }
21
21
  }
22
22
  namespace Schemas {
23
+ /**
24
+ * How the current customer identity was established. demo is the fictional, verified
25
+ * customer of an Agent Builder preview; it is never a login method.
26
+ *
27
+ */
28
+ export type AccessMethod = "email_code" | "portal_login" | "demo";
23
29
  /**
24
30
  * anonymous: no customer identity. identified: the Contact is known but ownership
25
- * is not proven. verified: ownership is proven (an email code or a portal login).
31
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
32
+ * demo customer of an Agent Builder preview.
26
33
  *
27
34
  */
28
35
  export type AccessTier = "anonymous" | "identified" | "verified";
@@ -502,7 +509,6 @@ declare namespace Components {
502
509
  reason?: "NO_METERS" | "SUBMISSION_REJECTED" | "SUBMISSION_UNCERTAIN";
503
510
  }
504
511
  export interface CreateWebsiteChatRequest {
505
- name: string;
506
512
  agent_id: string | null; // uuid
507
513
  settings: {
508
514
  /**
@@ -560,7 +566,6 @@ declare namespace Components {
560
566
  string?,
561
567
  string?
562
568
  ];
563
- organisation_name: string;
564
569
  default_locale: "en" | "de";
565
570
  /**
566
571
  * Design Builder configuration for the Website Chat only.
@@ -1018,14 +1023,17 @@ declare namespace Components {
1018
1023
  export interface CustomerAccess {
1019
1024
  /**
1020
1025
  * anonymous: no customer identity. identified: the Contact is known but ownership
1021
- * is not proven. verified: ownership is proven (an email code or a portal login).
1026
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
1027
+ * demo customer of an Agent Builder preview.
1022
1028
  *
1023
1029
  */
1024
1030
  tier: "anonymous" | "identified" | "verified";
1025
1031
  /**
1026
- * How a customer can log in or verify themselves in the chat.
1032
+ * How the current customer identity was established. demo is the fictional, verified
1033
+ * customer of an Agent Builder preview; it is never a login method.
1034
+ *
1027
1035
  */
1028
- method?: "email_code" | "portal_login";
1036
+ method?: "email_code" | "portal_login" | "demo";
1029
1037
  }
1030
1038
  export interface Error {
1031
1039
  error?: string;
@@ -1036,7 +1044,6 @@ declare namespace Components {
1036
1044
  }
1037
1045
  export interface ListWebsiteChatsResponse {
1038
1046
  website_chats: {
1039
- name: string;
1040
1047
  agent_id: string | null; // uuid
1041
1048
  settings: {
1042
1049
  /**
@@ -1094,7 +1101,6 @@ declare namespace Components {
1094
1101
  string?,
1095
1102
  string?
1096
1103
  ];
1097
- organisation_name: string;
1098
1104
  default_locale: "en" | "de";
1099
1105
  /**
1100
1106
  * Design Builder configuration for the Website Chat only.
@@ -1587,14 +1593,17 @@ declare namespace Components {
1587
1593
  access: {
1588
1594
  /**
1589
1595
  * anonymous: no customer identity. identified: the Contact is known but ownership
1590
- * is not proven. verified: ownership is proven (an email code or a portal login).
1596
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
1597
+ * demo customer of an Agent Builder preview.
1591
1598
  *
1592
1599
  */
1593
1600
  tier: "anonymous" | "identified" | "verified";
1594
1601
  /**
1595
- * How a customer can log in or verify themselves in the chat.
1602
+ * How the current customer identity was established. demo is the fictional, verified
1603
+ * customer of an Agent Builder preview; it is never a login method.
1604
+ *
1596
1605
  */
1597
- method?: "email_code" | "portal_login";
1606
+ method?: "email_code" | "portal_login" | "demo";
1598
1607
  };
1599
1608
  }
1600
1609
  export interface PublicChatError {
@@ -1638,8 +1647,20 @@ declare namespace Components {
1638
1647
  };
1639
1648
  export interface PublicWebsiteChat {
1640
1649
  key: string;
1641
- organisationName: string;
1642
- assistantName: string;
1650
+ /**
1651
+ * 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.
1652
+ */
1653
+ assistant_name?: {
1654
+ de?: string;
1655
+ en?: string;
1656
+ };
1657
+ /**
1658
+ * 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.
1659
+ */
1660
+ greeting?: {
1661
+ de?: string;
1662
+ en?: string;
1663
+ };
1643
1664
  defaultLocale: "en" | "de";
1644
1665
  /**
1645
1666
  * Login methods currently available to the customer.
@@ -2178,7 +2199,6 @@ declare namespace Components {
2178
2199
  */
2179
2200
  export type StarterQuestions = string[];
2180
2201
  export interface UpdateWebsiteChatRequest {
2181
- name?: string;
2182
2202
  agent_id?: string | null; // uuid
2183
2203
  settings?: {
2184
2204
  /**
@@ -2236,7 +2256,6 @@ declare namespace Components {
2236
2256
  string?,
2237
2257
  string?
2238
2258
  ];
2239
- organisation_name: string;
2240
2259
  default_locale: "en" | "de";
2241
2260
  /**
2242
2261
  * Design Builder configuration for the Website Chat only.
@@ -2713,18 +2732,20 @@ declare namespace Components {
2713
2732
  access: {
2714
2733
  /**
2715
2734
  * anonymous: no customer identity. identified: the Contact is known but ownership
2716
- * is not proven. verified: ownership is proven (an email code or a portal login).
2735
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
2736
+ * demo customer of an Agent Builder preview.
2717
2737
  *
2718
2738
  */
2719
2739
  tier: "anonymous" | "identified" | "verified";
2720
2740
  /**
2721
- * How a customer can log in or verify themselves in the chat.
2741
+ * How the current customer identity was established. demo is the fictional, verified
2742
+ * customer of an Agent Builder preview; it is never a login method.
2743
+ *
2722
2744
  */
2723
- method?: "email_code" | "portal_login";
2745
+ method?: "email_code" | "portal_login" | "demo";
2724
2746
  };
2725
2747
  }
2726
2748
  export interface WebsiteChat {
2727
- name: string;
2728
2749
  agent_id: string | null; // uuid
2729
2750
  settings: {
2730
2751
  /**
@@ -2782,7 +2803,6 @@ declare namespace Components {
2782
2803
  string?,
2783
2804
  string?
2784
2805
  ];
2785
- organisation_name: string;
2786
2806
  default_locale: "en" | "de";
2787
2807
  /**
2788
2808
  * Design Builder configuration for the Website Chat only.
@@ -3302,8 +3322,20 @@ declare namespace Components {
3302
3322
  frame_origin: string; // uri
3303
3323
  website_chat: {
3304
3324
  key: string;
3305
- organisationName: string;
3306
- assistantName: string;
3325
+ /**
3326
+ * 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.
3327
+ */
3328
+ assistant_name?: {
3329
+ de?: string;
3330
+ en?: string;
3331
+ };
3332
+ /**
3333
+ * 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.
3334
+ */
3335
+ greeting?: {
3336
+ de?: string;
3337
+ en?: string;
3338
+ };
3307
3339
  defaultLocale: "en" | "de";
3308
3340
  /**
3309
3341
  * Login methods currently available to the customer.
@@ -3376,6 +3408,10 @@ declare namespace Components {
3376
3408
  * Unsaved design to preview. Omit to keep the saved design; null previews the default design.
3377
3409
  */
3378
3410
  design_id?: string | null; // uuid
3411
+ /**
3412
+ * 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.
3413
+ */
3414
+ demo_customer?: boolean;
3379
3415
  }
3380
3416
  export interface WebsiteChatSettings {
3381
3417
  /**
@@ -3433,7 +3469,6 @@ declare namespace Components {
3433
3469
  string?,
3434
3470
  string?
3435
3471
  ];
3436
- organisation_name: string;
3437
3472
  default_locale: "en" | "de";
3438
3473
  /**
3439
3474
  * Design Builder configuration for the Website Chat only.
@@ -4399,14 +4434,17 @@ declare namespace Paths {
4399
4434
  access: {
4400
4435
  /**
4401
4436
  * anonymous: no customer identity. identified: the Contact is known but ownership
4402
- * is not proven. verified: ownership is proven (an email code or a portal login).
4437
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
4438
+ * demo customer of an Agent Builder preview.
4403
4439
  *
4404
4440
  */
4405
4441
  tier: "anonymous" | "identified" | "verified";
4406
4442
  /**
4407
- * How a customer can log in or verify themselves in the chat.
4443
+ * How the current customer identity was established. demo is the fictional, verified
4444
+ * customer of an Agent Builder preview; it is never a login method.
4445
+ *
4408
4446
  */
4409
- method?: "email_code" | "portal_login";
4447
+ method?: "email_code" | "portal_login" | "demo";
4410
4448
  };
4411
4449
  }
4412
4450
  export interface Default {
@@ -4438,14 +4476,17 @@ declare namespace Paths {
4438
4476
  access: {
4439
4477
  /**
4440
4478
  * anonymous: no customer identity. identified: the Contact is known but ownership
4441
- * is not proven. verified: ownership is proven (an email code or a portal login).
4479
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
4480
+ * demo customer of an Agent Builder preview.
4442
4481
  *
4443
4482
  */
4444
4483
  tier: "anonymous" | "identified" | "verified";
4445
4484
  /**
4446
- * How a customer can log in or verify themselves in the chat.
4485
+ * How the current customer identity was established. demo is the fictional, verified
4486
+ * customer of an Agent Builder preview; it is never a login method.
4487
+ *
4447
4488
  */
4448
- method?: "email_code" | "portal_login";
4489
+ method?: "email_code" | "portal_login" | "demo";
4449
4490
  };
4450
4491
  }
4451
4492
  export interface Default {
@@ -4963,8 +5004,20 @@ declare namespace Paths {
4963
5004
  expires_at: number;
4964
5005
  website_chat: {
4965
5006
  key: string;
4966
- organisationName: string;
4967
- assistantName: string;
5007
+ /**
5008
+ * 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.
5009
+ */
5010
+ assistant_name?: {
5011
+ de?: string;
5012
+ en?: string;
5013
+ };
5014
+ /**
5015
+ * 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.
5016
+ */
5017
+ greeting?: {
5018
+ de?: string;
5019
+ en?: string;
5020
+ };
4968
5021
  defaultLocale: "en" | "de";
4969
5022
  /**
4970
5023
  * Login methods currently available to the customer.
@@ -5035,6 +5088,21 @@ declare namespace Paths {
5035
5088
  * Agent Builder preview session; the frame only runs it inside the 360 portal.
5036
5089
  */
5037
5090
  preview?: boolean;
5091
+ access?: {
5092
+ /**
5093
+ * anonymous: no customer identity. identified: the Contact is known but ownership
5094
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
5095
+ * demo customer of an Agent Builder preview.
5096
+ *
5097
+ */
5098
+ tier: "anonymous" | "identified" | "verified";
5099
+ /**
5100
+ * How the current customer identity was established. demo is the fictional, verified
5101
+ * customer of an Agent Builder preview; it is never a login method.
5102
+ *
5103
+ */
5104
+ method?: "email_code" | "portal_login" | "demo";
5105
+ };
5038
5106
  }
5039
5107
  export interface Default {
5040
5108
  code: "INVALID_VERIFICATION_CODE" | "VERIFICATION_EXPIRED" | "VERIFICATION_CONFLICT" | "VERIFICATION_DISABLED" | "VERIFICATION_UNAVAILABLE" | "IDENTITY_CHANGED" | "INVALID_REQUEST" | "ORIGIN_DENIED" | "NOT_FOUND" | "INVALID_GRANT" | "SESSION_EXPIRED" | "RATE_LIMITED" | "SESSION_LIMIT" | "USAGE_LIMIT" | "REQUEST_CONFLICT" | "IN_PROGRESS" | "UNAVAILABLE" | "TEMPORARILY_UNAVAILABLE" | "IDENTITY_REQUIRED" | "ACTION_UNAVAILABLE" | "ACTION_CONFLICT" | "ACTION_TARGET_DENIED" | "INVALID_LOGIN_CODE" | "LOGIN_EXPIRED" | "LOGIN_DISABLED" | "LOGIN_UNAVAILABLE" | "LOGIN_CONFLICT" | "LOGIN_REJECTED";
@@ -5070,7 +5138,6 @@ declare namespace Paths {
5070
5138
  }
5071
5139
  namespace CreateWebsiteChat {
5072
5140
  export interface RequestBody {
5073
- name: string;
5074
5141
  agent_id: string | null; // uuid
5075
5142
  settings: {
5076
5143
  /**
@@ -5128,7 +5195,6 @@ declare namespace Paths {
5128
5195
  string?,
5129
5196
  string?
5130
5197
  ];
5131
- organisation_name: string;
5132
5198
  default_locale: "en" | "de";
5133
5199
  /**
5134
5200
  * Design Builder configuration for the Website Chat only.
@@ -5585,7 +5651,6 @@ declare namespace Paths {
5585
5651
  }
5586
5652
  namespace Responses {
5587
5653
  export interface $201 {
5588
- name: string;
5589
5654
  agent_id: string | null; // uuid
5590
5655
  settings: {
5591
5656
  /**
@@ -5643,7 +5708,6 @@ declare namespace Paths {
5643
5708
  string?,
5644
5709
  string?
5645
5710
  ];
5646
- organisation_name: string;
5647
5711
  default_locale: "en" | "de";
5648
5712
  /**
5649
5713
  * Design Builder configuration for the Website Chat only.
@@ -6144,6 +6208,10 @@ declare namespace Paths {
6144
6208
  * Unsaved design to preview. Omit to keep the saved design; null previews the default design.
6145
6209
  */
6146
6210
  design_id?: string | null; // uuid
6211
+ /**
6212
+ * 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.
6213
+ */
6214
+ demo_customer?: boolean;
6147
6215
  }
6148
6216
  namespace Responses {
6149
6217
  export interface $201 {
@@ -6158,8 +6226,20 @@ declare namespace Paths {
6158
6226
  frame_origin: string; // uri
6159
6227
  website_chat: {
6160
6228
  key: string;
6161
- organisationName: string;
6162
- assistantName: string;
6229
+ /**
6230
+ * 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.
6231
+ */
6232
+ assistant_name?: {
6233
+ de?: string;
6234
+ en?: string;
6235
+ };
6236
+ /**
6237
+ * 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.
6238
+ */
6239
+ greeting?: {
6240
+ de?: string;
6241
+ en?: string;
6242
+ };
6163
6243
  defaultLocale: "en" | "de";
6164
6244
  /**
6165
6245
  * Login methods currently available to the customer.
@@ -6808,14 +6888,17 @@ declare namespace Paths {
6808
6888
  access: {
6809
6889
  /**
6810
6890
  * anonymous: no customer identity. identified: the Contact is known but ownership
6811
- * is not proven. verified: ownership is proven (an email code or a portal login).
6891
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
6892
+ * demo customer of an Agent Builder preview.
6812
6893
  *
6813
6894
  */
6814
6895
  tier: "anonymous" | "identified" | "verified";
6815
6896
  /**
6816
- * How a customer can log in or verify themselves in the chat.
6897
+ * How the current customer identity was established. demo is the fictional, verified
6898
+ * customer of an Agent Builder preview; it is never a login method.
6899
+ *
6817
6900
  */
6818
- method?: "email_code" | "portal_login";
6901
+ method?: "email_code" | "portal_login" | "demo";
6819
6902
  };
6820
6903
  }
6821
6904
  export interface Default {
@@ -6847,14 +6930,17 @@ declare namespace Paths {
6847
6930
  access: {
6848
6931
  /**
6849
6932
  * anonymous: no customer identity. identified: the Contact is known but ownership
6850
- * is not proven. verified: ownership is proven (an email code or a portal login).
6933
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
6934
+ * demo customer of an Agent Builder preview.
6851
6935
  *
6852
6936
  */
6853
6937
  tier: "anonymous" | "identified" | "verified";
6854
6938
  /**
6855
- * How a customer can log in or verify themselves in the chat.
6939
+ * How the current customer identity was established. demo is the fictional, verified
6940
+ * customer of an Agent Builder preview; it is never a login method.
6941
+ *
6856
6942
  */
6857
- method?: "email_code" | "portal_login";
6943
+ method?: "email_code" | "portal_login" | "demo";
6858
6944
  };
6859
6945
  }
6860
6946
  export interface Default {
@@ -6876,8 +6962,20 @@ declare namespace Paths {
6876
6962
  namespace Responses {
6877
6963
  export interface $200 {
6878
6964
  key: string;
6879
- organisationName: string;
6880
- assistantName: string;
6965
+ /**
6966
+ * 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.
6967
+ */
6968
+ assistant_name?: {
6969
+ de?: string;
6970
+ en?: string;
6971
+ };
6972
+ /**
6973
+ * 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.
6974
+ */
6975
+ greeting?: {
6976
+ de?: string;
6977
+ en?: string;
6978
+ };
6881
6979
  defaultLocale: "en" | "de";
6882
6980
  /**
6883
6981
  * Login methods currently available to the customer.
@@ -6956,7 +7054,6 @@ declare namespace Paths {
6956
7054
  namespace GetWebsiteChat {
6957
7055
  namespace Responses {
6958
7056
  export interface $200 {
6959
- name: string;
6960
7057
  agent_id: string | null; // uuid
6961
7058
  settings: {
6962
7059
  /**
@@ -7014,7 +7111,6 @@ declare namespace Paths {
7014
7111
  string?,
7015
7112
  string?
7016
7113
  ];
7017
- organisation_name: string;
7018
7114
  default_locale: "en" | "de";
7019
7115
  /**
7020
7116
  * Design Builder configuration for the Website Chat only.
@@ -7519,7 +7615,6 @@ declare namespace Paths {
7519
7615
  namespace Responses {
7520
7616
  export interface $200 {
7521
7617
  website_chats: {
7522
- name: string;
7523
7618
  agent_id: string | null; // uuid
7524
7619
  settings: {
7525
7620
  /**
@@ -7577,7 +7672,6 @@ declare namespace Paths {
7577
7672
  string?,
7578
7673
  string?
7579
7674
  ];
7580
- organisation_name: string;
7581
7675
  default_locale: "en" | "de";
7582
7676
  /**
7583
7677
  * Design Builder configuration for the Website Chat only.
@@ -8116,14 +8210,17 @@ declare namespace Paths {
8116
8210
  access: {
8117
8211
  /**
8118
8212
  * anonymous: no customer identity. identified: the Contact is known but ownership
8119
- * is not proven. verified: ownership is proven (an email code or a portal login).
8213
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
8214
+ * demo customer of an Agent Builder preview.
8120
8215
  *
8121
8216
  */
8122
8217
  tier: "anonymous" | "identified" | "verified";
8123
8218
  /**
8124
- * How a customer can log in or verify themselves in the chat.
8219
+ * How the current customer identity was established. demo is the fictional, verified
8220
+ * customer of an Agent Builder preview; it is never a login method.
8221
+ *
8125
8222
  */
8126
- method?: "email_code" | "portal_login";
8223
+ method?: "email_code" | "portal_login" | "demo";
8127
8224
  };
8128
8225
  }
8129
8226
  export interface Default {
@@ -8647,14 +8744,17 @@ declare namespace Paths {
8647
8744
  access: {
8648
8745
  /**
8649
8746
  * anonymous: no customer identity. identified: the Contact is known but ownership
8650
- * is not proven. verified: ownership is proven (an email code or a portal login).
8747
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
8748
+ * demo customer of an Agent Builder preview.
8651
8749
  *
8652
8750
  */
8653
8751
  tier: "anonymous" | "identified" | "verified";
8654
8752
  /**
8655
- * How a customer can log in or verify themselves in the chat.
8753
+ * How the current customer identity was established. demo is the fictional, verified
8754
+ * customer of an Agent Builder preview; it is never a login method.
8755
+ *
8656
8756
  */
8657
- method?: "email_code" | "portal_login";
8757
+ method?: "email_code" | "portal_login" | "demo";
8658
8758
  };
8659
8759
  }
8660
8760
  export interface Default {
@@ -8687,14 +8787,17 @@ declare namespace Paths {
8687
8787
  access: {
8688
8788
  /**
8689
8789
  * anonymous: no customer identity. identified: the Contact is known but ownership
8690
- * is not proven. verified: ownership is proven (an email code or a portal login).
8790
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
8791
+ * demo customer of an Agent Builder preview.
8691
8792
  *
8692
8793
  */
8693
8794
  tier: "anonymous" | "identified" | "verified";
8694
8795
  /**
8695
- * How a customer can log in or verify themselves in the chat.
8796
+ * How the current customer identity was established. demo is the fictional, verified
8797
+ * customer of an Agent Builder preview; it is never a login method.
8798
+ *
8696
8799
  */
8697
- method?: "email_code" | "portal_login";
8800
+ method?: "email_code" | "portal_login" | "demo";
8698
8801
  };
8699
8802
  }
8700
8803
  export interface Default {
@@ -9203,7 +9306,6 @@ declare namespace Paths {
9203
9306
  }
9204
9307
  namespace UpdateWebsiteChat {
9205
9308
  export interface RequestBody {
9206
- name?: string;
9207
9309
  agent_id?: string | null; // uuid
9208
9310
  settings?: {
9209
9311
  /**
@@ -9261,7 +9363,6 @@ declare namespace Paths {
9261
9363
  string?,
9262
9364
  string?
9263
9365
  ];
9264
- organisation_name: string;
9265
9366
  default_locale: "en" | "de";
9266
9367
  /**
9267
9368
  * Design Builder configuration for the Website Chat only.
@@ -9722,7 +9823,6 @@ declare namespace Paths {
9722
9823
  }
9723
9824
  namespace Responses {
9724
9825
  export interface $200 {
9725
- name: string;
9726
9826
  agent_id: string | null; // uuid
9727
9827
  settings: {
9728
9828
  /**
@@ -9780,7 +9880,6 @@ declare namespace Paths {
9780
9880
  string?,
9781
9881
  string?
9782
9882
  ];
9783
- organisation_name: string;
9784
9883
  default_locale: "en" | "de";
9785
9884
  /**
9786
9885
  * Design Builder configuration for the Website Chat only.
@@ -10315,14 +10414,17 @@ declare namespace Paths {
10315
10414
  access: {
10316
10415
  /**
10317
10416
  * anonymous: no customer identity. identified: the Contact is known but ownership
10318
- * is not proven. verified: ownership is proven (an email code or a portal login).
10417
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
10418
+ * demo customer of an Agent Builder preview.
10319
10419
  *
10320
10420
  */
10321
10421
  tier: "anonymous" | "identified" | "verified";
10322
10422
  /**
10323
- * How a customer can log in or verify themselves in the chat.
10423
+ * How the current customer identity was established. demo is the fictional, verified
10424
+ * customer of an Agent Builder preview; it is never a login method.
10425
+ *
10324
10426
  */
10325
- method?: "email_code" | "portal_login";
10427
+ method?: "email_code" | "portal_login" | "demo";
10326
10428
  };
10327
10429
  }
10328
10430
  export interface Default {
@@ -10355,14 +10457,17 @@ declare namespace Paths {
10355
10457
  access: {
10356
10458
  /**
10357
10459
  * anonymous: no customer identity. identified: the Contact is known but ownership
10358
- * is not proven. verified: ownership is proven (an email code or a portal login).
10460
+ * is not proven. verified: ownership is proven (an email code or a portal login), or the
10461
+ * demo customer of an Agent Builder preview.
10359
10462
  *
10360
10463
  */
10361
10464
  tier: "anonymous" | "identified" | "verified";
10362
10465
  /**
10363
- * How a customer can log in or verify themselves in the chat.
10466
+ * How the current customer identity was established. demo is the fictional, verified
10467
+ * customer of an Agent Builder preview; it is never a login method.
10468
+ *
10364
10469
  */
10365
- method?: "email_code" | "portal_login";
10470
+ method?: "email_code" | "portal_login" | "demo";
10366
10471
  };
10367
10472
  }
10368
10473
  export interface Default {
@@ -10543,7 +10648,7 @@ interface OperationMethods {
10543
10648
  config?: AxiosRequestConfig
10544
10649
  ): OperationResponse<Paths.CancelChatPortalLogin.Responses.$200 | Paths.CancelChatPortalLogin.Responses.Default>
10545
10650
  /**
10546
- * signOutChatCustomer - Clear the customer identity of any login method and pending challenges. Clearing an identity starts a new anonymous conversation.
10651
+ * signOutChatCustomer - 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.
10547
10652
  */
10548
10653
  'signOutChatCustomer'(
10549
10654
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -10799,7 +10904,7 @@ interface PathsDictionary {
10799
10904
  }
10800
10905
  ['/v1/login/sign-out']: {
10801
10906
  /**
10802
- * signOutChatCustomer - Clear the customer identity of any login method and pending challenges. Clearing an identity starts a new anonymous conversation.
10907
+ * signOutChatCustomer - 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.
10803
10908
  */
10804
10909
  'post'(
10805
10910
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -10870,6 +10975,7 @@ interface PathsDictionary {
10870
10975
  type Client = OpenAPIClient<OperationMethods, PathsDictionary>
10871
10976
 
10872
10977
 
10978
+ type AccessMethod = Components.Schemas.AccessMethod;
10873
10979
  type AccessTier = Components.Schemas.AccessTier;
10874
10980
  type ActionRevision = Components.Schemas.ActionRevision;
10875
10981
  type ActionState = Components.Schemas.ActionState;
@@ -10894,4 +11000,4 @@ type WebsiteChatPreviewGrant = Components.Schemas.WebsiteChatPreviewGrant;
10894
11000
  type WebsiteChatPreviewGrantRequest = Components.Schemas.WebsiteChatPreviewGrantRequest;
10895
11001
  type WebsiteChatSettings = Components.Schemas.WebsiteChatSettings;
10896
11002
 
10897
- export { type AccessTier as A, type Client as C, type Error as E, type ListWebsiteChatsResponse as L, type OperationMethods as O, Paths as P, type SelfServiceAction as S, type UpdateWebsiteChatRequest as U, type VerificationState as V, type WebsiteChat as W, Components as a, type PathsDictionary as b, type ActionRevision as c, type ActionState as d, type CreateWebsiteChatRequest as e, type CustomerAccess as f, type LoginMethod as g, type PortalLoginState as h, type PublicChatError as i, type PublicEvent as j, type PublicWebsiteChat as k, type SelfServiceDirective as l, type SelfServiceSettings as m, type StarterQuestions as n, type WebsiteChatDesign as o, type WebsiteChatPreviewGrant as p, type WebsiteChatPreviewGrantRequest as q, type WebsiteChatSettings as r };
11003
+ export { type AccessMethod as A, type Client as C, type Error as E, type ListWebsiteChatsResponse as L, type OperationMethods as O, Paths as P, type SelfServiceAction as S, type UpdateWebsiteChatRequest as U, type VerificationState as V, type WebsiteChat as W, Components as a, type PathsDictionary as b, type AccessTier as c, type ActionRevision as d, type ActionState as e, type CreateWebsiteChatRequest as f, type CustomerAccess as g, type LoginMethod as h, type PortalLoginState as i, type PublicChatError as j, type PublicEvent as k, type PublicWebsiteChat as l, type SelfServiceDirective as m, type SelfServiceSettings as n, type StarterQuestions as o, type WebsiteChatDesign as p, type WebsiteChatPreviewGrant as q, type WebsiteChatPreviewGrantRequest as r, type WebsiteChatSettings as s };
@@ -39,7 +39,7 @@ var globImport_docs = _chunkNJK5F5TFcjs.__glob.call(void 0, {
39
39
  "./docs/billing.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./billing-CKCFSK6K.cjs"))),
40
40
  "./docs/blueprint-manifest.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./blueprint-manifest-SXG3M6B4.cjs"))),
41
41
  "./docs/calendar.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./calendar-UADWQX7G.cjs"))),
42
- "./docs/chat.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./chat-YYRMNUXU.cjs"))),
42
+ "./docs/chat.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./chat-QZJ5P6HQ.cjs"))),
43
43
  "./docs/configuration-hub.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./configuration-hub-6TSL5AGX.cjs"))),
44
44
  "./docs/consent.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./consent-CS2ZBZX4.cjs"))),
45
45
  "./docs/customer-portal.json": () => Promise.resolve().then(() => _interopRequireWildcard(require("./customer-portal-2OT5REK6.cjs"))),
@@ -39,7 +39,7 @@ var globImport_docs = __glob({
39
39
  "./docs/billing.json": () => import("./billing-UJ6I7FPG.js"),
40
40
  "./docs/blueprint-manifest.json": () => import("./blueprint-manifest-YU2UZLHV.js"),
41
41
  "./docs/calendar.json": () => import("./calendar-2H4RGMV3.js"),
42
- "./docs/chat.json": () => import("./chat-UYCCJWAM.js"),
42
+ "./docs/chat.json": () => import("./chat-T6GUSV2K.js"),
43
43
  "./docs/configuration-hub.json": () => import("./configuration-hub-ZYOLN7ZX.js"),
44
44
  "./docs/consent.json": () => import("./consent-NNYHF2N4.js"),
45
45
  "./docs/customer-portal.json": () => import("./customer-portal-AO2K6VW2.js"),