@epilot/cli 0.1.205 → 0.1.207

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 +921 -0
  3. package/definitions/pricing.json +90 -56
  4. package/dist/{access-token-4QI7YZQP.js → access-token-FGAUDV62.js} +2 -2
  5. package/dist/{add-component-G2OOG56P.js → add-component-4GY7ZZC5.js} +2 -2
  6. package/dist/{add-function-JGOTYXER.js → add-function-WBYHWXDG.js} +2 -2
  7. package/dist/{address-JM5HOVBK.js → address-RNSPQT7W.js} +2 -2
  8. package/dist/{address-suggestions-OCQUOKBN.js → address-suggestions-TI2JGGBU.js} +2 -2
  9. package/dist/{ai-agents-JVYTU5CF.js → ai-agents-IELGKT4V.js} +2 -2
  10. package/dist/{api-2JSH5M6V.js → api-UPKQZHPM.js} +2 -2
  11. package/dist/app-H2233TGE.js +26 -0
  12. package/dist/{audit-logs-YWMCBMMJ.js → audit-logs-VJ7HJK2A.js} +2 -2
  13. package/dist/{automation-PRHESUBC.js → automation-HR4PIS4I.js} +2 -2
  14. package/dist/{billing-5JEDTUQM.js → billing-65Y34GY4.js} +2 -2
  15. package/dist/bin/epilot.js +61 -61
  16. package/dist/{blueprint-manifest-TSRRX6VM.js → blueprint-manifest-BLY7IQIZ.js} +2 -2
  17. package/dist/{calendar-7K42OAMA.js → calendar-JUFY2LQM.js} +2 -2
  18. package/dist/{chat-YSNWP7FZ.js → chat-G6AFUJUT.js} +2 -2
  19. package/dist/{chunk-3XYGSRCG.js → chunk-DNH3VFLE.js} +1 -1
  20. package/dist/{chunk-URL63EDY.js → chunk-HSTIWNGZ.js} +1 -1
  21. package/dist/{chunk-DRTGD5R2.js → chunk-MUYLBXHF.js} +4 -1
  22. package/dist/{chunk-F5PY5C36.js → chunk-SEIPXYY7.js} +1 -1
  23. package/dist/{completion-C3FOYNSQ.js → completion-OKQFJS6O.js} +1 -1
  24. package/dist/{configuration-hub-TDQM43H3.js → configuration-hub-VELSIN7I.js} +2 -2
  25. package/dist/{consent-5RGQ5FDR.js → consent-O5E5RMUK.js} +2 -2
  26. package/dist/{customer-portal-RM4MYRVW.js → customer-portal-657GYWHQ.js} +2 -2
  27. package/dist/{dashboard-BHDUE634.js → dashboard-SDYBU545.js} +2 -2
  28. package/dist/{data-governance-B4PDYLRV.js → data-governance-3FKIXCJ2.js} +2 -2
  29. package/dist/{deduplication-IDAD4ESK.js → deduplication-NICX34OO.js} +2 -2
  30. package/dist/{deploy-3TTURE4C.js → deploy-4ADPLZHN.js} +2 -2
  31. package/dist/{design-Q3OPVP35.js → design-Q272PZ2D.js} +2 -2
  32. package/dist/{dev-X4UJRQ5Q.js → dev-S35LJYLT.js} +2 -2
  33. package/dist/{document-XFGE6YMW.js → document-C24KNKKO.js} +2 -2
  34. package/dist/{email-settings-4N46SEKO.js → email-settings-DML2QCD4.js} +2 -2
  35. package/dist/{email-template-BO77S45X.js → email-template-4BBQ2FBV.js} +2 -2
  36. package/dist/{entity-NFAI52Y3.js → entity-YOBIQV6Y.js} +2 -2
  37. package/dist/{entity-mapping-LZBAOFAY.js → entity-mapping-P6YJNT4X.js} +2 -2
  38. package/dist/{environments-TLHE7ATR.js → environments-TX7LC4VR.js} +2 -2
  39. package/dist/{event-catalog-F2DSDAIM.js → event-catalog-KUKYVZB2.js} +2 -2
  40. package/dist/{export-MX3Z6MDG.js → export-L7WWMWLO.js} +2 -2
  41. package/dist/{external-values-B7XGKJQI.js → external-values-MHDFHJBG.js} +2 -2
  42. package/dist/{file-MMR4CYW5.js → file-UI6IVACD.js} +2 -2
  43. package/dist/{iban-SVBMEWEI.js → iban-FMTDAKJZ.js} +2 -2
  44. package/dist/{identity-RFTHG6J5.js → identity-TRAUTLUC.js} +2 -2
  45. package/dist/{init-4ORDLRPM.js → init-BLEPPNUE.js} +2 -2
  46. package/dist/{integration-toolkit-DQNRTP7E.js → integration-toolkit-3RC7SUOX.js} +2 -2
  47. package/dist/{journey-UDEB3LLE.js → journey-M5VJ6XKZ.js} +2 -2
  48. package/dist/{kanban-IGJYIPMC.js → kanban-5UBW23OA.js} +2 -2
  49. package/dist/{message-MWHGVVMZ.js → message-5ANGLTIZ.js} +2 -2
  50. package/dist/{metering-USLJN62O.js → metering-JQXPZR5D.js} +2 -2
  51. package/dist/{notes-REYCJLE3.js → notes-SONXF7L4.js} +2 -2
  52. package/dist/{notification-72UYQOAQ.js → notification-25MWAEZN.js} +2 -2
  53. package/dist/{organization-3O5IU2X7.js → organization-U33ODSR2.js} +2 -2
  54. package/dist/{partner-directory-O2QWOBCD.js → partner-directory-B7ERDOQM.js} +2 -2
  55. package/dist/{permissions-ZSSYUMHR.js → permissions-VX65UISC.js} +2 -2
  56. package/dist/{phone-integration-VIVW7ZLQ.js → phone-integration-JXJL7DON.js} +2 -2
  57. package/dist/{pricing-FUYF3AKR.js → pricing-DPT7E33R.js} +2 -2
  58. package/dist/{pricing-tier-MNTZGDKF.js → pricing-tier-NP36K747.js} +2 -2
  59. package/dist/{purpose-JTQFEE2E.js → purpose-NCPSRGLG.js} +2 -2
  60. package/dist/{query-GIGSBWPM.js → query-RIWEIFX7.js} +2 -2
  61. package/dist/{remove-component-CRH6BLBS.js → remove-component-K5N4V7N4.js} +2 -2
  62. package/dist/{review-MLCUEFVU.js → review-YPTDVRHD.js} +2 -2
  63. package/dist/{sandbox-QKJENY42.js → sandbox-MBK6JWP2.js} +2 -2
  64. package/dist/{sharing-UCMQKUCL.js → sharing-BQUYRLP2.js} +2 -2
  65. package/dist/{snapshot-BQAUBXY2.js → snapshot-Z3MXNC2P.js} +2 -2
  66. package/dist/{submission-JX2CPO4U.js → submission-UCQKKZ3R.js} +2 -2
  67. package/dist/{targeting-JP4HM22G.js → targeting-HBYF5ZGA.js} +2 -2
  68. package/dist/{template-variables-4W2SDOFN.js → template-variables-W3S6JI7M.js} +2 -2
  69. package/dist/{upgrade-KCSZTJLB.js → upgrade-I5HC5ERF.js} +1 -1
  70. package/dist/{user-CXXCDDAJ.js → user-OSY27VJN.js} +2 -2
  71. package/dist/{validate-MIESMMZW.js → validate-TK5KPEQN.js} +2 -2
  72. package/dist/{validation-rules-ABENGW45.js → validation-rules-BG6SCSVK.js} +2 -2
  73. package/dist/{versions-KRS5WVPG.js → versions-BZXZQXPL.js} +2 -2
  74. package/dist/{webhooks-JI2GNTAJ.js → webhooks-5W3NFT33.js} +2 -2
  75. package/dist/{workflow-D3WFPJLU.js → workflow-LPXW2DBZ.js} +2 -2
  76. package/dist/{workflow-definition-P6AQAET7.js → workflow-definition-ZIKMLEGW.js} +2 -2
  77. package/package.json +1 -1
  78. package/dist/app-IM6TG4KG.js +0 -26
package/definitions/chat.json CHANGED
@@ -1772,6 +1772,390 @@
1772
1772
  ]
1773
1773
  }
1774
1774
  },
1775
+ "/v1/website-chats/{website_chat_id}/preview-grant": {
1776
+ "parameters": [
1777
+ {
1778
+ "in": "path",
1779
+ "name": "website_chat_id",
1780
+ "required": true,
1781
+ "schema": {
1782
+ "type": "string",
1783
+ "format": "uuid"
1784
+ }
1785
+ }
1786
+ ],
1787
+ "post": {
1788
+ "tags": [
1789
+ "Website Chats"
1790
+ ],
1791
+ "operationId": "createWebsiteChatPreviewGrant",
1792
+ "description": "Issues a single-use grant for an Agent Builder preview of this Website Chat. Only callable from the 360 portal; the preview runs without allowed websites (also before any are added), is exempt from Website Chat analytics and ends after 15 minutes. The grant is exchanged at POST /v1/sessions within 60 seconds.",
1793
+ "security": [
1794
+ {
1795
+ "EpilotAuth": []
1796
+ }
1797
+ ],
1798
+ "requestBody": {
1799
+ "required": false,
1800
+ "content": {
1801
+ "application/json": {
1802
+ "schema": {
1803
+ "type": "object",
1804
+ "additionalProperties": false,
1805
+ "properties": {
1806
+ "design_id": {
1807
+ "type": "string",
1808
+ "format": "uuid",
1809
+ "nullable": true,
1810
+ "description": "Unsaved design to preview. Omit to keep the saved design; null previews the default design."
1811
+ }
1812
+ }
1813
+ }
1814
+ }
1815
+ }
1816
+ },
1817
+ "responses": {
1818
+ "201": {
1819
+ "description": "Preview grant",
1820
+ "content": {
1821
+ "application/json": {
1822
+ "schema": {
1823
+ "type": "object",
1824
+ "required": [
1825
+ "grant",
1826
+ "expires_in",
1827
+ "frame_origin",
1828
+ "website_chat"
1829
+ ],
1830
+ "properties": {
1831
+ "grant": {
1832
+ "type": "string",
1833
+ "description": "Single-use grant for POST /v1/sessions."
1834
+ },
1835
+ "expires_in": {
1836
+ "type": "integer",
1837
+ "description": "Seconds until the grant expires."
1838
+ },
1839
+ "frame_origin": {
1840
+ "type": "string",
1841
+ "format": "uri"
1842
+ },
1843
+ "website_chat": {
1844
+ "type": "object",
1845
+ "required": [
1846
+ "key",
1847
+ "organisationName",
1848
+ "assistantName",
1849
+ "defaultLocale",
1850
+ "locales",
1851
+ "login_methods"
1852
+ ],
1853
+ "properties": {
1854
+ "key": {
1855
+ "type": "string"
1856
+ },
1857
+ "organisationName": {
1858
+ "type": "string"
1859
+ },
1860
+ "assistantName": {
1861
+ "type": "string"
1862
+ },
1863
+ "defaultLocale": {
1864
+ "type": "string",
1865
+ "enum": [
1866
+ "en",
1867
+ "de"
1868
+ ]
1869
+ },
1870
+ "login_methods": {
1871
+ "type": "array",
1872
+ "description": "Login methods currently available to the customer.",
1873
+ "items": {
1874
+ "type": "string",
1875
+ "enum": [
1876
+ "email_code",
1877
+ "portal_login"
1878
+ ],
1879
+ "description": "How a customer can log in or verify themselves in the chat."
1880
+ }
1881
+ },
1882
+ "starters": {
1883
+ "type": "object",
1884
+ "additionalProperties": false,
1885
+ "description": "Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.",
1886
+ "properties": {
1887
+ "de": {
1888
+ "type": "array",
1889
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
1890
+ "items": {
1891
+ "type": "string",
1892
+ "minLength": 1,
1893
+ "maxLength": 120
1894
+ }
1895
+ },
1896
+ "en": {
1897
+ "type": "array",
1898
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
1899
+ "items": {
1900
+ "type": "string",
1901
+ "minLength": 1,
1902
+ "maxLength": 120
1903
+ }
1904
+ }
1905
+ }
1906
+ },
1907
+ "actions": {
1908
+ "type": "object",
1909
+ "additionalProperties": false,
1910
+ "description": "Prototype Guided Actions offered by this Website Chat.",
1911
+ "properties": {
1912
+ "meter_reading": {
1913
+ "type": "boolean"
1914
+ },
1915
+ "meter_reading_journey_id": {
1916
+ "type": "string",
1917
+ "format": "uuid"
1918
+ }
1919
+ }
1920
+ },
1921
+ "design": {
1922
+ "type": "object",
1923
+ "additionalProperties": false,
1924
+ "properties": {
1925
+ "id": {
1926
+ "type": "string",
1927
+ "format": "uuid"
1928
+ },
1929
+ "last_modified_at": {
1930
+ "type": "string",
1931
+ "maxLength": 200
1932
+ },
1933
+ "style": {
1934
+ "type": "object",
1935
+ "additionalProperties": false,
1936
+ "properties": {
1937
+ "palette": {
1938
+ "type": "object",
1939
+ "additionalProperties": false,
1940
+ "properties": {
1941
+ "primary": {
1942
+ "type": "string",
1943
+ "maxLength": 200
1944
+ },
1945
+ "background": {
1946
+ "type": "string",
1947
+ "maxLength": 200
1948
+ }
1949
+ }
1950
+ },
1951
+ "typography": {
1952
+ "type": "object",
1953
+ "additionalProperties": false,
1954
+ "properties": {
1955
+ "font": {
1956
+ "type": "object",
1957
+ "additionalProperties": false,
1958
+ "properties": {
1959
+ "font_family": {
1960
+ "type": "string",
1961
+ "maxLength": 200
1962
+ }
1963
+ }
1964
+ }
1965
+ }
1966
+ },
1967
+ "shape": {
1968
+ "type": "object",
1969
+ "additionalProperties": false,
1970
+ "properties": {
1971
+ "border_radius": {
1972
+ "type": "number",
1973
+ "minimum": 0,
1974
+ "maximum": 100
1975
+ }
1976
+ }
1977
+ }
1978
+ }
1979
+ },
1980
+ "spark_theme": {
1981
+ "type": "object",
1982
+ "additionalProperties": false,
1983
+ "properties": {
1984
+ "accentColor": {
1985
+ "type": "string",
1986
+ "maxLength": 200
1987
+ },
1988
+ "backgroundColor": {
1989
+ "type": "string",
1990
+ "maxLength": 200
1991
+ },
1992
+ "fontBody": {
1993
+ "type": "string",
1994
+ "maxLength": 200
1995
+ },
1996
+ "fontHeading": {
1997
+ "type": "string",
1998
+ "maxLength": 200
1999
+ },
2000
+ "radius": {
2001
+ "type": "string",
2002
+ "maxLength": 200
2003
+ },
2004
+ "scaling": {
2005
+ "type": "string",
2006
+ "maxLength": 200
2007
+ },
2008
+ "spacing": {
2009
+ "type": "string",
2010
+ "maxLength": 200
2011
+ },
2012
+ "appearance": {
2013
+ "type": "string",
2014
+ "maxLength": 200
2015
+ },
2016
+ "neutralColor": {
2017
+ "type": "string",
2018
+ "maxLength": 200
2019
+ },
2020
+ "styleVariant": {
2021
+ "type": "string",
2022
+ "maxLength": 200
2023
+ },
2024
+ "labelPosition": {
2025
+ "type": "string",
2026
+ "maxLength": 200
2027
+ },
2028
+ "inputStyle": {
2029
+ "type": "string",
2030
+ "maxLength": 200
2031
+ },
2032
+ "inputColor": {
2033
+ "type": "string",
2034
+ "maxLength": 200
2035
+ },
2036
+ "cardVariant": {
2037
+ "type": "string",
2038
+ "maxLength": 200
2039
+ },
2040
+ "cardColor": {
2041
+ "type": "string",
2042
+ "maxLength": 200
2043
+ },
2044
+ "highContrast": {
2045
+ "type": "boolean"
2046
+ }
2047
+ }
2048
+ }
2049
+ },
2050
+ "required": [
2051
+ "id"
2052
+ ]
2053
+ },
2054
+ "locales": {
2055
+ "type": "array",
2056
+ "description": "Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.",
2057
+ "items": {
2058
+ "type": "string",
2059
+ "enum": [
2060
+ "en",
2061
+ "de"
2062
+ ]
2063
+ }
2064
+ }
2065
+ }
2066
+ }
2067
+ }
2068
+ }
2069
+ }
2070
+ }
2071
+ },
2072
+ "400": {
2073
+ "description": "Invalid preview request",
2074
+ "content": {
2075
+ "application/json": {
2076
+ "schema": {
2077
+ "type": "object",
2078
+ "properties": {
2079
+ "error": {
2080
+ "type": "string"
2081
+ },
2082
+ "message": {
2083
+ "type": "string"
2084
+ },
2085
+ "details": {
2086
+ "type": "object"
2087
+ }
2088
+ }
2089
+ }
2090
+ }
2091
+ }
2092
+ },
2093
+ "403": {
2094
+ "description": "Not called from the 360 portal",
2095
+ "content": {
2096
+ "application/json": {
2097
+ "schema": {
2098
+ "type": "object",
2099
+ "properties": {
2100
+ "error": {
2101
+ "type": "string"
2102
+ },
2103
+ "message": {
2104
+ "type": "string"
2105
+ },
2106
+ "details": {
2107
+ "type": "object"
2108
+ }
2109
+ }
2110
+ }
2111
+ }
2112
+ }
2113
+ },
2114
+ "404": {
2115
+ "description": "Website Chat not found in this organisation",
2116
+ "content": {
2117
+ "application/json": {
2118
+ "schema": {
2119
+ "type": "object",
2120
+ "properties": {
2121
+ "error": {
2122
+ "type": "string"
2123
+ },
2124
+ "message": {
2125
+ "type": "string"
2126
+ },
2127
+ "details": {
2128
+ "type": "object"
2129
+ }
2130
+ }
2131
+ }
2132
+ }
2133
+ }
2134
+ },
2135
+ "429": {
2136
+ "description": "Too many previews; try again later",
2137
+ "content": {
2138
+ "application/json": {
2139
+ "schema": {
2140
+ "type": "object",
2141
+ "properties": {
2142
+ "error": {
2143
+ "type": "string"
2144
+ },
2145
+ "message": {
2146
+ "type": "string"
2147
+ },
2148
+ "details": {
2149
+ "type": "object"
2150
+ }
2151
+ }
2152
+ }
2153
+ }
2154
+ }
2155
+ }
2156
+ }
2157
+ }
2158
+ },
1775
2159
  "/v1/website-chats/{website_chat_id}/configuration": {
1776
2160
  "get": {
1777
2161
  "operationId": "getPublicWebsiteChat",
@@ -1833,6 +2217,31 @@
1833
2217
  "description": "How a customer can log in or verify themselves in the chat."
1834
2218
  }
1835
2219
  },
2220
+ "starters": {
2221
+ "type": "object",
2222
+ "additionalProperties": false,
2223
+ "description": "Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.",
2224
+ "properties": {
2225
+ "de": {
2226
+ "type": "array",
2227
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
2228
+ "items": {
2229
+ "type": "string",
2230
+ "minLength": 1,
2231
+ "maxLength": 120
2232
+ }
2233
+ },
2234
+ "en": {
2235
+ "type": "array",
2236
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
2237
+ "items": {
2238
+ "type": "string",
2239
+ "minLength": 1,
2240
+ "maxLength": 120
2241
+ }
2242
+ }
2243
+ }
2244
+ },
1836
2245
  "actions": {
1837
2246
  "type": "object",
1838
2247
  "additionalProperties": false,
@@ -1982,6 +2391,7 @@
1982
2391
  },
1983
2392
  "locales": {
1984
2393
  "type": "array",
2394
+ "description": "Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.",
1985
2395
  "items": {
1986
2396
  "type": "string",
1987
2397
  "enum": [
@@ -2250,6 +2660,31 @@
2250
2660
  "description": "How a customer can log in or verify themselves in the chat."
2251
2661
  }
2252
2662
  },
2663
+ "starters": {
2664
+ "type": "object",
2665
+ "additionalProperties": false,
2666
+ "description": "Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.",
2667
+ "properties": {
2668
+ "de": {
2669
+ "type": "array",
2670
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
2671
+ "items": {
2672
+ "type": "string",
2673
+ "minLength": 1,
2674
+ "maxLength": 120
2675
+ }
2676
+ },
2677
+ "en": {
2678
+ "type": "array",
2679
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
2680
+ "items": {
2681
+ "type": "string",
2682
+ "minLength": 1,
2683
+ "maxLength": 120
2684
+ }
2685
+ }
2686
+ }
2687
+ },
2253
2688
  "actions": {
2254
2689
  "type": "object",
2255
2690
  "additionalProperties": false,
@@ -2399,6 +2834,7 @@
2399
2834
  },
2400
2835
  "locales": {
2401
2836
  "type": "array",
2837
+ "description": "Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.",
2402
2838
  "items": {
2403
2839
  "type": "string",
2404
2840
  "enum": [
@@ -2408,6 +2844,10 @@
2408
2844
  }
2409
2845
  }
2410
2846
  }
2847
+ },
2848
+ "preview": {
2849
+ "type": "boolean",
2850
+ "description": "Agent Builder preview session; the frame only runs it inside the 360 portal."
2411
2851
  }
2412
2852
  }
2413
2853
  }
@@ -3405,6 +3845,96 @@
3405
3845
  }
3406
3846
  }
3407
3847
  },
3848
+ "/v1/login/portal/journey-token": {
3849
+ "get": {
3850
+ "operationId": "getChatPortalJourneyToken",
3851
+ "security": [
3852
+ {
3853
+ "AnonymousSession": []
3854
+ }
3855
+ ],
3856
+ "description": "Prototype. The portal ID token of this session's portal login, for an embedded Journey running in the Journey app's parent-auth mode, so the customer does not log in twice. Only for a valid portal login; the frame keeps it in memory and posts it only to the Journey origin.",
3857
+ "responses": {
3858
+ "200": {
3859
+ "description": "Portal ID token",
3860
+ "content": {
3861
+ "application/json": {
3862
+ "schema": {
3863
+ "type": "object",
3864
+ "additionalProperties": false,
3865
+ "required": [
3866
+ "id_token",
3867
+ "expires_at"
3868
+ ],
3869
+ "properties": {
3870
+ "id_token": {
3871
+ "type": "string"
3872
+ },
3873
+ "expires_at": {
3874
+ "type": "integer",
3875
+ "description": "Unix seconds"
3876
+ }
3877
+ }
3878
+ }
3879
+ }
3880
+ }
3881
+ },
3882
+ "default": {
3883
+ "description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
3884
+ "content": {
3885
+ "application/json": {
3886
+ "schema": {
3887
+ "type": "object",
3888
+ "required": [
3889
+ "code"
3890
+ ],
3891
+ "properties": {
3892
+ "code": {
3893
+ "type": "string",
3894
+ "enum": [
3895
+ "INVALID_VERIFICATION_CODE",
3896
+ "VERIFICATION_EXPIRED",
3897
+ "VERIFICATION_CONFLICT",
3898
+ "VERIFICATION_DISABLED",
3899
+ "VERIFICATION_UNAVAILABLE",
3900
+ "IDENTITY_CHANGED",
3901
+ "INVALID_REQUEST",
3902
+ "ORIGIN_DENIED",
3903
+ "NOT_FOUND",
3904
+ "INVALID_GRANT",
3905
+ "SESSION_EXPIRED",
3906
+ "RATE_LIMITED",
3907
+ "SESSION_LIMIT",
3908
+ "USAGE_LIMIT",
3909
+ "REQUEST_CONFLICT",
3910
+ "IN_PROGRESS",
3911
+ "UNAVAILABLE",
3912
+ "TEMPORARILY_UNAVAILABLE",
3913
+ "IDENTITY_REQUIRED",
3914
+ "ACTION_UNAVAILABLE",
3915
+ "ACTION_CONFLICT",
3916
+ "ACTION_TARGET_DENIED",
3917
+ "INVALID_LOGIN_CODE",
3918
+ "LOGIN_EXPIRED",
3919
+ "LOGIN_DISABLED",
3920
+ "LOGIN_UNAVAILABLE",
3921
+ "LOGIN_CONFLICT",
3922
+ "LOGIN_REJECTED"
3923
+ ]
3924
+ },
3925
+ "attempts_left": {
3926
+ "type": "integer",
3927
+ "minimum": 0,
3928
+ "description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
3929
+ }
3930
+ }
3931
+ }
3932
+ }
3933
+ }
3934
+ }
3935
+ }
3936
+ }
3937
+ },
3408
3938
  "/v1/login/portal/start": {
3409
3939
  "post": {
3410
3940
  "operationId": "startChatPortalLogin",
@@ -4462,6 +4992,103 @@
4462
4992
  }
4463
4993
  }
4464
4994
  },
4995
+ "/v1/actions/events": {
4996
+ "post": {
4997
+ "operationId": "reportChatActionEvent",
4998
+ "security": [
4999
+ {
5000
+ "AnonymousSession": []
5001
+ }
5002
+ ],
5003
+ "description": "Report what an embedded journey did, so the assistant can refer to it. Accepted only for a journey action this Website Chat offers. Browser input: the assistant is told it is not confirmed.",
5004
+ "requestBody": {
5005
+ "required": true,
5006
+ "content": {
5007
+ "application/json": {
5008
+ "schema": {
5009
+ "type": "object",
5010
+ "additionalProperties": false,
5011
+ "required": [
5012
+ "action",
5013
+ "event"
5014
+ ],
5015
+ "properties": {
5016
+ "action": {
5017
+ "type": "string",
5018
+ "pattern": "^[a-z][a-z_]{0,59}$"
5019
+ },
5020
+ "event": {
5021
+ "type": "string",
5022
+ "enum": [
5023
+ "journey_submitted",
5024
+ "journey_closed"
5025
+ ]
5026
+ }
5027
+ }
5028
+ }
5029
+ }
5030
+ }
5031
+ },
5032
+ "responses": {
5033
+ "204": {
5034
+ "description": "Recorded"
5035
+ },
5036
+ "default": {
5037
+ "description": "400 invalid input, 401 expired capability, 403 origin denied, 404 unpublished Website Chat, 409 conflict, 413 too large, 429 rate limit, or 503 unavailable.",
5038
+ "content": {
5039
+ "application/json": {
5040
+ "schema": {
5041
+ "type": "object",
5042
+ "required": [
5043
+ "code"
5044
+ ],
5045
+ "properties": {
5046
+ "code": {
5047
+ "type": "string",
5048
+ "enum": [
5049
+ "INVALID_VERIFICATION_CODE",
5050
+ "VERIFICATION_EXPIRED",
5051
+ "VERIFICATION_CONFLICT",
5052
+ "VERIFICATION_DISABLED",
5053
+ "VERIFICATION_UNAVAILABLE",
5054
+ "IDENTITY_CHANGED",
5055
+ "INVALID_REQUEST",
5056
+ "ORIGIN_DENIED",
5057
+ "NOT_FOUND",
5058
+ "INVALID_GRANT",
5059
+ "SESSION_EXPIRED",
5060
+ "RATE_LIMITED",
5061
+ "SESSION_LIMIT",
5062
+ "USAGE_LIMIT",
5063
+ "REQUEST_CONFLICT",
5064
+ "IN_PROGRESS",
5065
+ "UNAVAILABLE",
5066
+ "TEMPORARILY_UNAVAILABLE",
5067
+ "IDENTITY_REQUIRED",
5068
+ "ACTION_UNAVAILABLE",
5069
+ "ACTION_CONFLICT",
5070
+ "ACTION_TARGET_DENIED",
5071
+ "INVALID_LOGIN_CODE",
5072
+ "LOGIN_EXPIRED",
5073
+ "LOGIN_DISABLED",
5074
+ "LOGIN_UNAVAILABLE",
5075
+ "LOGIN_CONFLICT",
5076
+ "LOGIN_REJECTED"
5077
+ ]
5078
+ },
5079
+ "attempts_left": {
5080
+ "type": "integer",
5081
+ "minimum": 0,
5082
+ "description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
5083
+ }
5084
+ }
5085
+ }
5086
+ }
5087
+ }
5088
+ }
5089
+ }
5090
+ }
5091
+ },
4465
5092
  "/v1/actions/{action_id}/submit": {
4466
5093
  "post": {
4467
5094
  "operationId": "submitChatAction",
@@ -5984,6 +6611,265 @@
5984
6611
  }
5985
6612
  }
5986
6613
  },
6614
+ "WebsiteChatPreviewGrantRequest": {
6615
+ "type": "object",
6616
+ "additionalProperties": false,
6617
+ "properties": {
6618
+ "design_id": {
6619
+ "type": "string",
6620
+ "format": "uuid",
6621
+ "nullable": true,
6622
+ "description": "Unsaved design to preview. Omit to keep the saved design; null previews the default design."
6623
+ }
6624
+ }
6625
+ },
6626
+ "WebsiteChatPreviewGrant": {
6627
+ "type": "object",
6628
+ "required": [
6629
+ "grant",
6630
+ "expires_in",
6631
+ "frame_origin",
6632
+ "website_chat"
6633
+ ],
6634
+ "properties": {
6635
+ "grant": {
6636
+ "type": "string",
6637
+ "description": "Single-use grant for POST /v1/sessions."
6638
+ },
6639
+ "expires_in": {
6640
+ "type": "integer",
6641
+ "description": "Seconds until the grant expires."
6642
+ },
6643
+ "frame_origin": {
6644
+ "type": "string",
6645
+ "format": "uri"
6646
+ },
6647
+ "website_chat": {
6648
+ "type": "object",
6649
+ "required": [
6650
+ "key",
6651
+ "organisationName",
6652
+ "assistantName",
6653
+ "defaultLocale",
6654
+ "locales",
6655
+ "login_methods"
6656
+ ],
6657
+ "properties": {
6658
+ "key": {
6659
+ "type": "string"
6660
+ },
6661
+ "organisationName": {
6662
+ "type": "string"
6663
+ },
6664
+ "assistantName": {
6665
+ "type": "string"
6666
+ },
6667
+ "defaultLocale": {
6668
+ "type": "string",
6669
+ "enum": [
6670
+ "en",
6671
+ "de"
6672
+ ]
6673
+ },
6674
+ "login_methods": {
6675
+ "type": "array",
6676
+ "description": "Login methods currently available to the customer.",
6677
+ "items": {
6678
+ "type": "string",
6679
+ "enum": [
6680
+ "email_code",
6681
+ "portal_login"
6682
+ ],
6683
+ "description": "How a customer can log in or verify themselves in the chat."
6684
+ }
6685
+ },
6686
+ "starters": {
6687
+ "type": "object",
6688
+ "additionalProperties": false,
6689
+ "description": "Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.",
6690
+ "properties": {
6691
+ "de": {
6692
+ "type": "array",
6693
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
6694
+ "items": {
6695
+ "type": "string",
6696
+ "minLength": 1,
6697
+ "maxLength": 120
6698
+ }
6699
+ },
6700
+ "en": {
6701
+ "type": "array",
6702
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
6703
+ "items": {
6704
+ "type": "string",
6705
+ "minLength": 1,
6706
+ "maxLength": 120
6707
+ }
6708
+ }
6709
+ }
6710
+ },
6711
+ "actions": {
6712
+ "type": "object",
6713
+ "additionalProperties": false,
6714
+ "description": "Prototype Guided Actions offered by this Website Chat.",
6715
+ "properties": {
6716
+ "meter_reading": {
6717
+ "type": "boolean"
6718
+ },
6719
+ "meter_reading_journey_id": {
6720
+ "type": "string",
6721
+ "format": "uuid"
6722
+ }
6723
+ }
6724
+ },
6725
+ "design": {
6726
+ "type": "object",
6727
+ "additionalProperties": false,
6728
+ "properties": {
6729
+ "id": {
6730
+ "type": "string",
6731
+ "format": "uuid"
6732
+ },
6733
+ "last_modified_at": {
6734
+ "type": "string",
6735
+ "maxLength": 200
6736
+ },
6737
+ "style": {
6738
+ "type": "object",
6739
+ "additionalProperties": false,
6740
+ "properties": {
6741
+ "palette": {
6742
+ "type": "object",
6743
+ "additionalProperties": false,
6744
+ "properties": {
6745
+ "primary": {
6746
+ "type": "string",
6747
+ "maxLength": 200
6748
+ },
6749
+ "background": {
6750
+ "type": "string",
6751
+ "maxLength": 200
6752
+ }
6753
+ }
6754
+ },
6755
+ "typography": {
6756
+ "type": "object",
6757
+ "additionalProperties": false,
6758
+ "properties": {
6759
+ "font": {
6760
+ "type": "object",
6761
+ "additionalProperties": false,
6762
+ "properties": {
6763
+ "font_family": {
6764
+ "type": "string",
6765
+ "maxLength": 200
6766
+ }
6767
+ }
6768
+ }
6769
+ }
6770
+ },
6771
+ "shape": {
6772
+ "type": "object",
6773
+ "additionalProperties": false,
6774
+ "properties": {
6775
+ "border_radius": {
6776
+ "type": "number",
6777
+ "minimum": 0,
6778
+ "maximum": 100
6779
+ }
6780
+ }
6781
+ }
6782
+ }
6783
+ },
6784
+ "spark_theme": {
6785
+ "type": "object",
6786
+ "additionalProperties": false,
6787
+ "properties": {
6788
+ "accentColor": {
6789
+ "type": "string",
6790
+ "maxLength": 200
6791
+ },
6792
+ "backgroundColor": {
6793
+ "type": "string",
6794
+ "maxLength": 200
6795
+ },
6796
+ "fontBody": {
6797
+ "type": "string",
6798
+ "maxLength": 200
6799
+ },
6800
+ "fontHeading": {
6801
+ "type": "string",
6802
+ "maxLength": 200
6803
+ },
6804
+ "radius": {
6805
+ "type": "string",
6806
+ "maxLength": 200
6807
+ },
6808
+ "scaling": {
6809
+ "type": "string",
6810
+ "maxLength": 200
6811
+ },
6812
+ "spacing": {
6813
+ "type": "string",
6814
+ "maxLength": 200
6815
+ },
6816
+ "appearance": {
6817
+ "type": "string",
6818
+ "maxLength": 200
6819
+ },
6820
+ "neutralColor": {
6821
+ "type": "string",
6822
+ "maxLength": 200
6823
+ },
6824
+ "styleVariant": {
6825
+ "type": "string",
6826
+ "maxLength": 200
6827
+ },
6828
+ "labelPosition": {
6829
+ "type": "string",
6830
+ "maxLength": 200
6831
+ },
6832
+ "inputStyle": {
6833
+ "type": "string",
6834
+ "maxLength": 200
6835
+ },
6836
+ "inputColor": {
6837
+ "type": "string",
6838
+ "maxLength": 200
6839
+ },
6840
+ "cardVariant": {
6841
+ "type": "string",
6842
+ "maxLength": 200
6843
+ },
6844
+ "cardColor": {
6845
+ "type": "string",
6846
+ "maxLength": 200
6847
+ },
6848
+ "highContrast": {
6849
+ "type": "boolean"
6850
+ }
6851
+ }
6852
+ }
6853
+ },
6854
+ "required": [
6855
+ "id"
6856
+ ]
6857
+ },
6858
+ "locales": {
6859
+ "type": "array",
6860
+ "description": "Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.",
6861
+ "items": {
6862
+ "type": "string",
6863
+ "enum": [
6864
+ "en",
6865
+ "de"
6866
+ ]
6867
+ }
6868
+ }
6869
+ }
6870
+ }
6871
+ }
6872
+ },
5987
6873
  "Error": {
5988
6874
  "type": "object",
5989
6875
  "properties": {
@@ -6695,6 +7581,15 @@
6695
7581
  }
6696
7582
  }
6697
7583
  },
7584
+ "StarterQuestions": {
7585
+ "type": "array",
7586
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
7587
+ "items": {
7588
+ "type": "string",
7589
+ "minLength": 1,
7590
+ "maxLength": 120
7591
+ }
7592
+ },
6698
7593
  "PublicWebsiteChat": {
6699
7594
  "type": "object",
6700
7595
  "required": [
@@ -6734,6 +7629,31 @@
6734
7629
  "description": "How a customer can log in or verify themselves in the chat."
6735
7630
  }
6736
7631
  },
7632
+ "starters": {
7633
+ "type": "object",
7634
+ "additionalProperties": false,
7635
+ "description": "Starter questions of the assigned Agent Builder website agent, by locale. Absent when the agent has none; clients then show their own defaults.",
7636
+ "properties": {
7637
+ "de": {
7638
+ "type": "array",
7639
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
7640
+ "items": {
7641
+ "type": "string",
7642
+ "minLength": 1,
7643
+ "maxLength": 120
7644
+ }
7645
+ },
7646
+ "en": {
7647
+ "type": "array",
7648
+ "description": "At most six. (No maxItems, which generated clients turn into fixed-length tuples.)",
7649
+ "items": {
7650
+ "type": "string",
7651
+ "minLength": 1,
7652
+ "maxLength": 120
7653
+ }
7654
+ }
7655
+ }
7656
+ },
6737
7657
  "actions": {
6738
7658
  "type": "object",
6739
7659
  "additionalProperties": false,
@@ -6883,6 +7803,7 @@
6883
7803
  },
6884
7804
  "locales": {
6885
7805
  "type": "array",
7806
+ "description": "Languages the chat offers, default first: the assigned Agent Builder website agent's languages, or both for a legacy agent. Hide the language choice when there is one.",
6886
7807
  "items": {
6887
7808
  "type": "string",
6888
7809
  "enum": [