@epilot/cli 0.1.183 → 0.1.185
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.
- package/README.md +1 -1
- package/definitions/chat.json +2859 -150
- package/definitions/integration-toolkit.json +133 -1
- package/dist/{access-token-DP5W5QVI.js → access-token-GOV3SBN3.js} +2 -2
- package/dist/{add-component-FJVE3Q5I.js → add-component-D4RN5MUC.js} +2 -2
- package/dist/{add-function-JVSMO3GH.js → add-function-CIFXSUYM.js} +2 -2
- package/dist/{address-HCDPEULF.js → address-OP6NX4OR.js} +2 -2
- package/dist/{address-suggestions-DLX5EKKI.js → address-suggestions-IRAVVQ73.js} +2 -2
- package/dist/{ai-agents-7ZZGQ2LC.js → ai-agents-GAQZY65C.js} +2 -2
- package/dist/{api-OALML3AQ.js → api-DTIZ3EBN.js} +2 -2
- package/dist/app-GUJ3AGT7.js +26 -0
- package/dist/{audit-logs-SA6WYRVR.js → audit-logs-J6ZCNN5S.js} +2 -2
- package/dist/{automation-XUW5RREF.js → automation-PCR2QSAB.js} +2 -2
- package/dist/{billing-ZLZZE6MJ.js → billing-TD7U7AEV.js} +2 -2
- package/dist/bin/epilot.js +59 -59
- package/dist/{blueprint-manifest-2DBNY4B7.js → blueprint-manifest-UHI5J7XO.js} +2 -2
- package/dist/{calendar-LXKIS7MV.js → calendar-ZY6MT2UE.js} +2 -2
- package/dist/{chat-ARR4YMJZ.js → chat-NAPG5Y33.js} +2 -2
- package/dist/{chunk-EZZKQFSY.js → chunk-7PFIKD6A.js} +15 -3
- package/dist/{chunk-BHLOLZGA.js → chunk-BPNPJHWQ.js} +1 -1
- package/dist/{chunk-BQY47SM2.js → chunk-P2LZ5ZEP.js} +1 -1
- package/dist/{chunk-JGC4FN4M.js → chunk-PRAGBALR.js} +1 -1
- package/dist/{completion-577J2XAR.js → completion-66QFFIPF.js} +1 -1
- package/dist/{configuration-hub-E7575SMZ.js → configuration-hub-TNYRTW6R.js} +2 -2
- package/dist/{consent-5M4DA7UD.js → consent-DPUV36SF.js} +2 -2
- package/dist/{customer-portal-ZV5R7YU6.js → customer-portal-VDVYIFC2.js} +2 -2
- package/dist/{dashboard-5ZZPVETO.js → dashboard-YQJ224T7.js} +2 -2
- package/dist/{data-governance-THPB4IAA.js → data-governance-X3RSRRSD.js} +2 -2
- package/dist/{deduplication-AXM4FECB.js → deduplication-3ANMMA4D.js} +2 -2
- package/dist/{deploy-YYNZ2JZG.js → deploy-DVVDOPHO.js} +2 -2
- package/dist/{design-Z6JRZ3SN.js → design-Y2SXQNGT.js} +2 -2
- package/dist/{dev-HZBKRGG4.js → dev-ZOJN7PKB.js} +2 -2
- package/dist/{document-6JHXHOLU.js → document-Z3OTSIJ3.js} +2 -2
- package/dist/{email-settings-46DIUZGZ.js → email-settings-XRSPZS67.js} +2 -2
- package/dist/{email-template-BFHWZ433.js → email-template-FXFQZZHH.js} +2 -2
- package/dist/{entity-3277ZX6C.js → entity-YDSIT6CL.js} +2 -2
- package/dist/{entity-mapping-WF52CEE5.js → entity-mapping-K5WU6VG7.js} +2 -2
- package/dist/{environments-M6WQM4FO.js → environments-VQCWBB3X.js} +2 -2
- package/dist/{event-catalog-LWHCUZET.js → event-catalog-4LW2IT5S.js} +2 -2
- package/dist/{export-HPASXQ3L.js → export-UUAJKXVV.js} +2 -2
- package/dist/{file-B5RJFSZ6.js → file-MFFFQFKA.js} +2 -2
- package/dist/{iban-5BFG23S6.js → iban-5IWVZBVC.js} +2 -2
- package/dist/{identity-WQ655UAS.js → identity-J72M7G6H.js} +2 -2
- package/dist/{init-AYDSONSC.js → init-O2BJR6OK.js} +2 -2
- package/dist/{integration-toolkit-UCUFBPEK.js → integration-toolkit-KLVILNNV.js} +2 -2
- package/dist/{journey-77KRMWHD.js → journey-U6IIKSHH.js} +2 -2
- package/dist/{kanban-KTLTKRW3.js → kanban-QTHLHXWR.js} +2 -2
- package/dist/{message-BIHFDWCO.js → message-DDIZOIET.js} +2 -2
- package/dist/{metering-CJPFPJF2.js → metering-LLEOTBOP.js} +2 -2
- package/dist/{notes-PBMBEL5I.js → notes-7VR2ZBG4.js} +2 -2
- package/dist/{notification-YIJPTTKM.js → notification-YKGRSUWD.js} +2 -2
- package/dist/{organization-NK6MBKIL.js → organization-POFJAJFL.js} +2 -2
- package/dist/{partner-directory-NXHOXCUJ.js → partner-directory-5ENUSJ6A.js} +2 -2
- package/dist/{permissions-EQKPG3ZA.js → permissions-SPZPAJCL.js} +2 -2
- package/dist/{pricing-47HSWFI7.js → pricing-2BZ6QTJP.js} +2 -2
- package/dist/{pricing-tier-6ECZ2RY4.js → pricing-tier-3W3P7ECJ.js} +2 -2
- package/dist/{purpose-C2ONCHJI.js → purpose-74PORNKL.js} +2 -2
- package/dist/{query-BUVCHQP5.js → query-KVJKOWHA.js} +2 -2
- package/dist/{remove-component-IMQCXQUY.js → remove-component-TFEOEARR.js} +2 -2
- package/dist/{review-JYO5BWNL.js → review-EY6O3PMT.js} +2 -2
- package/dist/{sandbox-LKEMZIYL.js → sandbox-Z3ZXW7XP.js} +2 -2
- package/dist/{sharing-J7DCGVJ7.js → sharing-S4QBWCGU.js} +2 -2
- package/dist/{snapshot-SZXV2T7X.js → snapshot-JB2XO6PL.js} +2 -2
- package/dist/{submission-CKVIZQLO.js → submission-XUU6CP6W.js} +2 -2
- package/dist/{targeting-RO2N7PBX.js → targeting-JQSLSIUV.js} +2 -2
- package/dist/{template-variables-KJ4LNJR2.js → template-variables-34OKOWIM.js} +2 -2
- package/dist/{upgrade-LQCJUPFO.js → upgrade-CAEMIMAI.js} +1 -1
- package/dist/{user-35TYVMFW.js → user-SXN4ZJY3.js} +2 -2
- package/dist/{validate-MRNCEQRQ.js → validate-JC6GT56Y.js} +2 -2
- package/dist/{validation-rules-UVOBTG5U.js → validation-rules-DHWHZIY7.js} +2 -2
- package/dist/{versions-246EI4CV.js → versions-ARY5ZST7.js} +2 -2
- package/dist/{webhooks-SF67KSBM.js → webhooks-4ENMM4SZ.js} +2 -2
- package/dist/{workflow-EZCF6PIJ.js → workflow-D4ST2RJ4.js} +2 -2
- package/dist/{workflow-definition-J7YTSFFE.js → workflow-definition-WNMZAML7.js} +2 -2
- package/package.json +1 -1
- package/dist/app-VNFDTP3A.js +0 -26
package/definitions/chat.json
CHANGED
|
@@ -109,6 +109,8 @@
|
|
|
109
109
|
"email_code": {
|
|
110
110
|
"type": "object",
|
|
111
111
|
"additionalProperties": false,
|
|
112
|
+
"nullable": true,
|
|
113
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
112
114
|
"properties": {
|
|
113
115
|
"email_template_id": {
|
|
114
116
|
"type": "string",
|
|
@@ -116,13 +118,25 @@
|
|
|
116
118
|
"nullable": true
|
|
117
119
|
}
|
|
118
120
|
}
|
|
121
|
+
},
|
|
122
|
+
"portal": {
|
|
123
|
+
"type": "object",
|
|
124
|
+
"additionalProperties": false,
|
|
125
|
+
"nullable": true,
|
|
126
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
127
|
+
"required": [
|
|
128
|
+
"portal_id"
|
|
129
|
+
],
|
|
130
|
+
"properties": {
|
|
131
|
+
"portal_id": {
|
|
132
|
+
"type": "string",
|
|
133
|
+
"format": "uuid"
|
|
134
|
+
}
|
|
135
|
+
}
|
|
119
136
|
}
|
|
120
137
|
},
|
|
121
138
|
"nullable": true,
|
|
122
|
-
"description": "
|
|
123
|
-
"required": [
|
|
124
|
-
"email_code"
|
|
125
|
-
]
|
|
139
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
126
140
|
}
|
|
127
141
|
}
|
|
128
142
|
},
|
|
@@ -350,6 +364,8 @@
|
|
|
350
364
|
"email_code": {
|
|
351
365
|
"type": "object",
|
|
352
366
|
"additionalProperties": false,
|
|
367
|
+
"nullable": true,
|
|
368
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
353
369
|
"properties": {
|
|
354
370
|
"email_template_id": {
|
|
355
371
|
"type": "string",
|
|
@@ -357,13 +373,25 @@
|
|
|
357
373
|
"nullable": true
|
|
358
374
|
}
|
|
359
375
|
}
|
|
376
|
+
},
|
|
377
|
+
"portal": {
|
|
378
|
+
"type": "object",
|
|
379
|
+
"additionalProperties": false,
|
|
380
|
+
"nullable": true,
|
|
381
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
382
|
+
"required": [
|
|
383
|
+
"portal_id"
|
|
384
|
+
],
|
|
385
|
+
"properties": {
|
|
386
|
+
"portal_id": {
|
|
387
|
+
"type": "string",
|
|
388
|
+
"format": "uuid"
|
|
389
|
+
}
|
|
390
|
+
}
|
|
360
391
|
}
|
|
361
392
|
},
|
|
362
393
|
"nullable": true,
|
|
363
|
-
"description": "
|
|
364
|
-
"required": [
|
|
365
|
-
"email_code"
|
|
366
|
-
]
|
|
394
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
367
395
|
}
|
|
368
396
|
}
|
|
369
397
|
},
|
|
@@ -557,6 +585,8 @@
|
|
|
557
585
|
"email_code": {
|
|
558
586
|
"type": "object",
|
|
559
587
|
"additionalProperties": false,
|
|
588
|
+
"nullable": true,
|
|
589
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
560
590
|
"properties": {
|
|
561
591
|
"email_template_id": {
|
|
562
592
|
"type": "string",
|
|
@@ -564,13 +594,25 @@
|
|
|
564
594
|
"nullable": true
|
|
565
595
|
}
|
|
566
596
|
}
|
|
597
|
+
},
|
|
598
|
+
"portal": {
|
|
599
|
+
"type": "object",
|
|
600
|
+
"additionalProperties": false,
|
|
601
|
+
"nullable": true,
|
|
602
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
603
|
+
"required": [
|
|
604
|
+
"portal_id"
|
|
605
|
+
],
|
|
606
|
+
"properties": {
|
|
607
|
+
"portal_id": {
|
|
608
|
+
"type": "string",
|
|
609
|
+
"format": "uuid"
|
|
610
|
+
}
|
|
611
|
+
}
|
|
567
612
|
}
|
|
568
613
|
},
|
|
569
614
|
"nullable": true,
|
|
570
|
-
"description": "
|
|
571
|
-
"required": [
|
|
572
|
-
"email_code"
|
|
573
|
-
]
|
|
615
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
574
616
|
}
|
|
575
617
|
}
|
|
576
618
|
}
|
|
@@ -677,6 +719,8 @@
|
|
|
677
719
|
"email_code": {
|
|
678
720
|
"type": "object",
|
|
679
721
|
"additionalProperties": false,
|
|
722
|
+
"nullable": true,
|
|
723
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
680
724
|
"properties": {
|
|
681
725
|
"email_template_id": {
|
|
682
726
|
"type": "string",
|
|
@@ -684,13 +728,25 @@
|
|
|
684
728
|
"nullable": true
|
|
685
729
|
}
|
|
686
730
|
}
|
|
731
|
+
},
|
|
732
|
+
"portal": {
|
|
733
|
+
"type": "object",
|
|
734
|
+
"additionalProperties": false,
|
|
735
|
+
"nullable": true,
|
|
736
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
737
|
+
"required": [
|
|
738
|
+
"portal_id"
|
|
739
|
+
],
|
|
740
|
+
"properties": {
|
|
741
|
+
"portal_id": {
|
|
742
|
+
"type": "string",
|
|
743
|
+
"format": "uuid"
|
|
744
|
+
}
|
|
745
|
+
}
|
|
687
746
|
}
|
|
688
747
|
},
|
|
689
748
|
"nullable": true,
|
|
690
|
-
"description": "
|
|
691
|
-
"required": [
|
|
692
|
-
"email_code"
|
|
693
|
-
]
|
|
749
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
694
750
|
}
|
|
695
751
|
}
|
|
696
752
|
},
|
|
@@ -902,6 +958,8 @@
|
|
|
902
958
|
"email_code": {
|
|
903
959
|
"type": "object",
|
|
904
960
|
"additionalProperties": false,
|
|
961
|
+
"nullable": true,
|
|
962
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
905
963
|
"properties": {
|
|
906
964
|
"email_template_id": {
|
|
907
965
|
"type": "string",
|
|
@@ -909,13 +967,25 @@
|
|
|
909
967
|
"nullable": true
|
|
910
968
|
}
|
|
911
969
|
}
|
|
970
|
+
},
|
|
971
|
+
"portal": {
|
|
972
|
+
"type": "object",
|
|
973
|
+
"additionalProperties": false,
|
|
974
|
+
"nullable": true,
|
|
975
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
976
|
+
"required": [
|
|
977
|
+
"portal_id"
|
|
978
|
+
],
|
|
979
|
+
"properties": {
|
|
980
|
+
"portal_id": {
|
|
981
|
+
"type": "string",
|
|
982
|
+
"format": "uuid"
|
|
983
|
+
}
|
|
984
|
+
}
|
|
912
985
|
}
|
|
913
986
|
},
|
|
914
987
|
"nullable": true,
|
|
915
|
-
"description": "
|
|
916
|
-
"required": [
|
|
917
|
-
"email_code"
|
|
918
|
-
]
|
|
988
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
919
989
|
}
|
|
920
990
|
}
|
|
921
991
|
},
|
|
@@ -1107,6 +1177,8 @@
|
|
|
1107
1177
|
"email_code": {
|
|
1108
1178
|
"type": "object",
|
|
1109
1179
|
"additionalProperties": false,
|
|
1180
|
+
"nullable": true,
|
|
1181
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
1110
1182
|
"properties": {
|
|
1111
1183
|
"email_template_id": {
|
|
1112
1184
|
"type": "string",
|
|
@@ -1114,13 +1186,25 @@
|
|
|
1114
1186
|
"nullable": true
|
|
1115
1187
|
}
|
|
1116
1188
|
}
|
|
1189
|
+
},
|
|
1190
|
+
"portal": {
|
|
1191
|
+
"type": "object",
|
|
1192
|
+
"additionalProperties": false,
|
|
1193
|
+
"nullable": true,
|
|
1194
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
1195
|
+
"required": [
|
|
1196
|
+
"portal_id"
|
|
1197
|
+
],
|
|
1198
|
+
"properties": {
|
|
1199
|
+
"portal_id": {
|
|
1200
|
+
"type": "string",
|
|
1201
|
+
"format": "uuid"
|
|
1202
|
+
}
|
|
1203
|
+
}
|
|
1117
1204
|
}
|
|
1118
1205
|
},
|
|
1119
1206
|
"nullable": true,
|
|
1120
|
-
"description": "
|
|
1121
|
-
"required": [
|
|
1122
|
-
"email_code"
|
|
1123
|
-
]
|
|
1207
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
1124
1208
|
}
|
|
1125
1209
|
}
|
|
1126
1210
|
},
|
|
@@ -1255,7 +1339,8 @@
|
|
|
1255
1339
|
"organisationName",
|
|
1256
1340
|
"assistantName",
|
|
1257
1341
|
"defaultLocale",
|
|
1258
|
-
"locales"
|
|
1342
|
+
"locales",
|
|
1343
|
+
"login_methods"
|
|
1259
1344
|
],
|
|
1260
1345
|
"properties": {
|
|
1261
1346
|
"key": {
|
|
@@ -1274,15 +1359,29 @@
|
|
|
1274
1359
|
"de"
|
|
1275
1360
|
]
|
|
1276
1361
|
},
|
|
1277
|
-
"
|
|
1362
|
+
"login_methods": {
|
|
1363
|
+
"type": "array",
|
|
1364
|
+
"description": "Login methods currently available to the customer.",
|
|
1365
|
+
"items": {
|
|
1366
|
+
"type": "string",
|
|
1367
|
+
"enum": [
|
|
1368
|
+
"email_code",
|
|
1369
|
+
"portal_login"
|
|
1370
|
+
],
|
|
1371
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
1372
|
+
}
|
|
1373
|
+
},
|
|
1374
|
+
"actions": {
|
|
1278
1375
|
"type": "object",
|
|
1279
1376
|
"additionalProperties": false,
|
|
1280
|
-
"
|
|
1281
|
-
"email_code"
|
|
1282
|
-
],
|
|
1377
|
+
"description": "Prototype Guided Actions offered by this Website Chat.",
|
|
1283
1378
|
"properties": {
|
|
1284
|
-
"
|
|
1379
|
+
"meter_reading": {
|
|
1285
1380
|
"type": "boolean"
|
|
1381
|
+
},
|
|
1382
|
+
"meter_reading_journey_id": {
|
|
1383
|
+
"type": "string",
|
|
1384
|
+
"format": "uuid"
|
|
1286
1385
|
}
|
|
1287
1386
|
}
|
|
1288
1387
|
},
|
|
@@ -1464,8 +1563,23 @@
|
|
|
1464
1563
|
"REQUEST_CONFLICT",
|
|
1465
1564
|
"IN_PROGRESS",
|
|
1466
1565
|
"UNAVAILABLE",
|
|
1467
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
1566
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
1567
|
+
"IDENTITY_REQUIRED",
|
|
1568
|
+
"ACTION_UNAVAILABLE",
|
|
1569
|
+
"ACTION_CONFLICT",
|
|
1570
|
+
"ACTION_TARGET_DENIED",
|
|
1571
|
+
"INVALID_LOGIN_CODE",
|
|
1572
|
+
"LOGIN_EXPIRED",
|
|
1573
|
+
"LOGIN_DISABLED",
|
|
1574
|
+
"LOGIN_UNAVAILABLE",
|
|
1575
|
+
"LOGIN_CONFLICT",
|
|
1576
|
+
"LOGIN_REJECTED"
|
|
1468
1577
|
]
|
|
1578
|
+
},
|
|
1579
|
+
"attempts_left": {
|
|
1580
|
+
"type": "integer",
|
|
1581
|
+
"minimum": 0,
|
|
1582
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
1469
1583
|
}
|
|
1470
1584
|
}
|
|
1471
1585
|
}
|
|
@@ -1559,8 +1673,23 @@
|
|
|
1559
1673
|
"REQUEST_CONFLICT",
|
|
1560
1674
|
"IN_PROGRESS",
|
|
1561
1675
|
"UNAVAILABLE",
|
|
1562
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
1676
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
1677
|
+
"IDENTITY_REQUIRED",
|
|
1678
|
+
"ACTION_UNAVAILABLE",
|
|
1679
|
+
"ACTION_CONFLICT",
|
|
1680
|
+
"ACTION_TARGET_DENIED",
|
|
1681
|
+
"INVALID_LOGIN_CODE",
|
|
1682
|
+
"LOGIN_EXPIRED",
|
|
1683
|
+
"LOGIN_DISABLED",
|
|
1684
|
+
"LOGIN_UNAVAILABLE",
|
|
1685
|
+
"LOGIN_CONFLICT",
|
|
1686
|
+
"LOGIN_REJECTED"
|
|
1563
1687
|
]
|
|
1688
|
+
},
|
|
1689
|
+
"attempts_left": {
|
|
1690
|
+
"type": "integer",
|
|
1691
|
+
"minimum": 0,
|
|
1692
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
1564
1693
|
}
|
|
1565
1694
|
}
|
|
1566
1695
|
}
|
|
@@ -1627,7 +1756,8 @@
|
|
|
1627
1756
|
"organisationName",
|
|
1628
1757
|
"assistantName",
|
|
1629
1758
|
"defaultLocale",
|
|
1630
|
-
"locales"
|
|
1759
|
+
"locales",
|
|
1760
|
+
"login_methods"
|
|
1631
1761
|
],
|
|
1632
1762
|
"properties": {
|
|
1633
1763
|
"key": {
|
|
@@ -1646,15 +1776,29 @@
|
|
|
1646
1776
|
"de"
|
|
1647
1777
|
]
|
|
1648
1778
|
},
|
|
1649
|
-
"
|
|
1779
|
+
"login_methods": {
|
|
1780
|
+
"type": "array",
|
|
1781
|
+
"description": "Login methods currently available to the customer.",
|
|
1782
|
+
"items": {
|
|
1783
|
+
"type": "string",
|
|
1784
|
+
"enum": [
|
|
1785
|
+
"email_code",
|
|
1786
|
+
"portal_login"
|
|
1787
|
+
],
|
|
1788
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
1789
|
+
}
|
|
1790
|
+
},
|
|
1791
|
+
"actions": {
|
|
1650
1792
|
"type": "object",
|
|
1651
1793
|
"additionalProperties": false,
|
|
1652
|
-
"
|
|
1653
|
-
"email_code"
|
|
1654
|
-
],
|
|
1794
|
+
"description": "Prototype Guided Actions offered by this Website Chat.",
|
|
1655
1795
|
"properties": {
|
|
1656
|
-
"
|
|
1796
|
+
"meter_reading": {
|
|
1657
1797
|
"type": "boolean"
|
|
1798
|
+
},
|
|
1799
|
+
"meter_reading_journey_id": {
|
|
1800
|
+
"type": "string",
|
|
1801
|
+
"format": "uuid"
|
|
1658
1802
|
}
|
|
1659
1803
|
}
|
|
1660
1804
|
},
|
|
@@ -1838,8 +1982,23 @@
|
|
|
1838
1982
|
"REQUEST_CONFLICT",
|
|
1839
1983
|
"IN_PROGRESS",
|
|
1840
1984
|
"UNAVAILABLE",
|
|
1841
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
1985
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
1986
|
+
"IDENTITY_REQUIRED",
|
|
1987
|
+
"ACTION_UNAVAILABLE",
|
|
1988
|
+
"ACTION_CONFLICT",
|
|
1989
|
+
"ACTION_TARGET_DENIED",
|
|
1990
|
+
"INVALID_LOGIN_CODE",
|
|
1991
|
+
"LOGIN_EXPIRED",
|
|
1992
|
+
"LOGIN_DISABLED",
|
|
1993
|
+
"LOGIN_UNAVAILABLE",
|
|
1994
|
+
"LOGIN_CONFLICT",
|
|
1995
|
+
"LOGIN_REJECTED"
|
|
1842
1996
|
]
|
|
1997
|
+
},
|
|
1998
|
+
"attempts_left": {
|
|
1999
|
+
"type": "integer",
|
|
2000
|
+
"minimum": 0,
|
|
2001
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
1843
2002
|
}
|
|
1844
2003
|
}
|
|
1845
2004
|
}
|
|
@@ -1941,8 +2100,23 @@
|
|
|
1941
2100
|
"REQUEST_CONFLICT",
|
|
1942
2101
|
"IN_PROGRESS",
|
|
1943
2102
|
"UNAVAILABLE",
|
|
1944
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
2103
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
2104
|
+
"IDENTITY_REQUIRED",
|
|
2105
|
+
"ACTION_UNAVAILABLE",
|
|
2106
|
+
"ACTION_CONFLICT",
|
|
2107
|
+
"ACTION_TARGET_DENIED",
|
|
2108
|
+
"INVALID_LOGIN_CODE",
|
|
2109
|
+
"LOGIN_EXPIRED",
|
|
2110
|
+
"LOGIN_DISABLED",
|
|
2111
|
+
"LOGIN_UNAVAILABLE",
|
|
2112
|
+
"LOGIN_CONFLICT",
|
|
2113
|
+
"LOGIN_REJECTED"
|
|
1945
2114
|
]
|
|
2115
|
+
},
|
|
2116
|
+
"attempts_left": {
|
|
2117
|
+
"type": "integer",
|
|
2118
|
+
"minimum": 0,
|
|
2119
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
1946
2120
|
}
|
|
1947
2121
|
}
|
|
1948
2122
|
}
|
|
@@ -1972,7 +2146,8 @@
|
|
|
1972
2146
|
"required": [
|
|
1973
2147
|
"available",
|
|
1974
2148
|
"conversation_id",
|
|
1975
|
-
"status"
|
|
2149
|
+
"status",
|
|
2150
|
+
"access"
|
|
1976
2151
|
],
|
|
1977
2152
|
"properties": {
|
|
1978
2153
|
"available": {
|
|
@@ -2015,6 +2190,32 @@
|
|
|
2015
2190
|
"ambiguous",
|
|
2016
2191
|
"not_found"
|
|
2017
2192
|
]
|
|
2193
|
+
},
|
|
2194
|
+
"access": {
|
|
2195
|
+
"type": "object",
|
|
2196
|
+
"additionalProperties": false,
|
|
2197
|
+
"required": [
|
|
2198
|
+
"tier"
|
|
2199
|
+
],
|
|
2200
|
+
"properties": {
|
|
2201
|
+
"tier": {
|
|
2202
|
+
"type": "string",
|
|
2203
|
+
"enum": [
|
|
2204
|
+
"anonymous",
|
|
2205
|
+
"identified",
|
|
2206
|
+
"verified"
|
|
2207
|
+
],
|
|
2208
|
+
"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"
|
|
2209
|
+
},
|
|
2210
|
+
"method": {
|
|
2211
|
+
"type": "string",
|
|
2212
|
+
"enum": [
|
|
2213
|
+
"email_code",
|
|
2214
|
+
"portal_login"
|
|
2215
|
+
],
|
|
2216
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
2217
|
+
}
|
|
2218
|
+
}
|
|
2018
2219
|
}
|
|
2019
2220
|
}
|
|
2020
2221
|
}
|
|
@@ -2051,8 +2252,23 @@
|
|
|
2051
2252
|
"REQUEST_CONFLICT",
|
|
2052
2253
|
"IN_PROGRESS",
|
|
2053
2254
|
"UNAVAILABLE",
|
|
2054
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
2255
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
2256
|
+
"IDENTITY_REQUIRED",
|
|
2257
|
+
"ACTION_UNAVAILABLE",
|
|
2258
|
+
"ACTION_CONFLICT",
|
|
2259
|
+
"ACTION_TARGET_DENIED",
|
|
2260
|
+
"INVALID_LOGIN_CODE",
|
|
2261
|
+
"LOGIN_EXPIRED",
|
|
2262
|
+
"LOGIN_DISABLED",
|
|
2263
|
+
"LOGIN_UNAVAILABLE",
|
|
2264
|
+
"LOGIN_CONFLICT",
|
|
2265
|
+
"LOGIN_REJECTED"
|
|
2055
2266
|
]
|
|
2267
|
+
},
|
|
2268
|
+
"attempts_left": {
|
|
2269
|
+
"type": "integer",
|
|
2270
|
+
"minimum": 0,
|
|
2271
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
2056
2272
|
}
|
|
2057
2273
|
}
|
|
2058
2274
|
}
|
|
@@ -2116,7 +2332,8 @@
|
|
|
2116
2332
|
"required": [
|
|
2117
2333
|
"available",
|
|
2118
2334
|
"conversation_id",
|
|
2119
|
-
"status"
|
|
2335
|
+
"status",
|
|
2336
|
+
"access"
|
|
2120
2337
|
],
|
|
2121
2338
|
"properties": {
|
|
2122
2339
|
"available": {
|
|
@@ -2159,6 +2376,32 @@
|
|
|
2159
2376
|
"ambiguous",
|
|
2160
2377
|
"not_found"
|
|
2161
2378
|
]
|
|
2379
|
+
},
|
|
2380
|
+
"access": {
|
|
2381
|
+
"type": "object",
|
|
2382
|
+
"additionalProperties": false,
|
|
2383
|
+
"required": [
|
|
2384
|
+
"tier"
|
|
2385
|
+
],
|
|
2386
|
+
"properties": {
|
|
2387
|
+
"tier": {
|
|
2388
|
+
"type": "string",
|
|
2389
|
+
"enum": [
|
|
2390
|
+
"anonymous",
|
|
2391
|
+
"identified",
|
|
2392
|
+
"verified"
|
|
2393
|
+
],
|
|
2394
|
+
"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"
|
|
2395
|
+
},
|
|
2396
|
+
"method": {
|
|
2397
|
+
"type": "string",
|
|
2398
|
+
"enum": [
|
|
2399
|
+
"email_code",
|
|
2400
|
+
"portal_login"
|
|
2401
|
+
],
|
|
2402
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
2403
|
+
}
|
|
2404
|
+
}
|
|
2162
2405
|
}
|
|
2163
2406
|
}
|
|
2164
2407
|
}
|
|
@@ -2195,8 +2438,23 @@
|
|
|
2195
2438
|
"REQUEST_CONFLICT",
|
|
2196
2439
|
"IN_PROGRESS",
|
|
2197
2440
|
"UNAVAILABLE",
|
|
2198
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
2441
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
2442
|
+
"IDENTITY_REQUIRED",
|
|
2443
|
+
"ACTION_UNAVAILABLE",
|
|
2444
|
+
"ACTION_CONFLICT",
|
|
2445
|
+
"ACTION_TARGET_DENIED",
|
|
2446
|
+
"INVALID_LOGIN_CODE",
|
|
2447
|
+
"LOGIN_EXPIRED",
|
|
2448
|
+
"LOGIN_DISABLED",
|
|
2449
|
+
"LOGIN_UNAVAILABLE",
|
|
2450
|
+
"LOGIN_CONFLICT",
|
|
2451
|
+
"LOGIN_REJECTED"
|
|
2199
2452
|
]
|
|
2453
|
+
},
|
|
2454
|
+
"attempts_left": {
|
|
2455
|
+
"type": "integer",
|
|
2456
|
+
"minimum": 0,
|
|
2457
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
2200
2458
|
}
|
|
2201
2459
|
}
|
|
2202
2460
|
}
|
|
@@ -2251,7 +2509,8 @@
|
|
|
2251
2509
|
"required": [
|
|
2252
2510
|
"available",
|
|
2253
2511
|
"conversation_id",
|
|
2254
|
-
"status"
|
|
2512
|
+
"status",
|
|
2513
|
+
"access"
|
|
2255
2514
|
],
|
|
2256
2515
|
"properties": {
|
|
2257
2516
|
"available": {
|
|
@@ -2294,6 +2553,32 @@
|
|
|
2294
2553
|
"ambiguous",
|
|
2295
2554
|
"not_found"
|
|
2296
2555
|
]
|
|
2556
|
+
},
|
|
2557
|
+
"access": {
|
|
2558
|
+
"type": "object",
|
|
2559
|
+
"additionalProperties": false,
|
|
2560
|
+
"required": [
|
|
2561
|
+
"tier"
|
|
2562
|
+
],
|
|
2563
|
+
"properties": {
|
|
2564
|
+
"tier": {
|
|
2565
|
+
"type": "string",
|
|
2566
|
+
"enum": [
|
|
2567
|
+
"anonymous",
|
|
2568
|
+
"identified",
|
|
2569
|
+
"verified"
|
|
2570
|
+
],
|
|
2571
|
+
"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"
|
|
2572
|
+
},
|
|
2573
|
+
"method": {
|
|
2574
|
+
"type": "string",
|
|
2575
|
+
"enum": [
|
|
2576
|
+
"email_code",
|
|
2577
|
+
"portal_login"
|
|
2578
|
+
],
|
|
2579
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
2580
|
+
}
|
|
2581
|
+
}
|
|
2297
2582
|
}
|
|
2298
2583
|
}
|
|
2299
2584
|
}
|
|
@@ -2330,8 +2615,23 @@
|
|
|
2330
2615
|
"REQUEST_CONFLICT",
|
|
2331
2616
|
"IN_PROGRESS",
|
|
2332
2617
|
"UNAVAILABLE",
|
|
2333
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
2618
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
2619
|
+
"IDENTITY_REQUIRED",
|
|
2620
|
+
"ACTION_UNAVAILABLE",
|
|
2621
|
+
"ACTION_CONFLICT",
|
|
2622
|
+
"ACTION_TARGET_DENIED",
|
|
2623
|
+
"INVALID_LOGIN_CODE",
|
|
2624
|
+
"LOGIN_EXPIRED",
|
|
2625
|
+
"LOGIN_DISABLED",
|
|
2626
|
+
"LOGIN_UNAVAILABLE",
|
|
2627
|
+
"LOGIN_CONFLICT",
|
|
2628
|
+
"LOGIN_REJECTED"
|
|
2334
2629
|
]
|
|
2630
|
+
},
|
|
2631
|
+
"attempts_left": {
|
|
2632
|
+
"type": "integer",
|
|
2633
|
+
"minimum": 0,
|
|
2634
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
2335
2635
|
}
|
|
2336
2636
|
}
|
|
2337
2637
|
}
|
|
@@ -2361,7 +2661,8 @@
|
|
|
2361
2661
|
"required": [
|
|
2362
2662
|
"available",
|
|
2363
2663
|
"conversation_id",
|
|
2364
|
-
"status"
|
|
2664
|
+
"status",
|
|
2665
|
+
"access"
|
|
2365
2666
|
],
|
|
2366
2667
|
"properties": {
|
|
2367
2668
|
"available": {
|
|
@@ -2404,6 +2705,32 @@
|
|
|
2404
2705
|
"ambiguous",
|
|
2405
2706
|
"not_found"
|
|
2406
2707
|
]
|
|
2708
|
+
},
|
|
2709
|
+
"access": {
|
|
2710
|
+
"type": "object",
|
|
2711
|
+
"additionalProperties": false,
|
|
2712
|
+
"required": [
|
|
2713
|
+
"tier"
|
|
2714
|
+
],
|
|
2715
|
+
"properties": {
|
|
2716
|
+
"tier": {
|
|
2717
|
+
"type": "string",
|
|
2718
|
+
"enum": [
|
|
2719
|
+
"anonymous",
|
|
2720
|
+
"identified",
|
|
2721
|
+
"verified"
|
|
2722
|
+
],
|
|
2723
|
+
"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"
|
|
2724
|
+
},
|
|
2725
|
+
"method": {
|
|
2726
|
+
"type": "string",
|
|
2727
|
+
"enum": [
|
|
2728
|
+
"email_code",
|
|
2729
|
+
"portal_login"
|
|
2730
|
+
],
|
|
2731
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
2732
|
+
}
|
|
2733
|
+
}
|
|
2407
2734
|
}
|
|
2408
2735
|
}
|
|
2409
2736
|
}
|
|
@@ -2440,8 +2767,23 @@
|
|
|
2440
2767
|
"REQUEST_CONFLICT",
|
|
2441
2768
|
"IN_PROGRESS",
|
|
2442
2769
|
"UNAVAILABLE",
|
|
2443
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
2770
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
2771
|
+
"IDENTITY_REQUIRED",
|
|
2772
|
+
"ACTION_UNAVAILABLE",
|
|
2773
|
+
"ACTION_CONFLICT",
|
|
2774
|
+
"ACTION_TARGET_DENIED",
|
|
2775
|
+
"INVALID_LOGIN_CODE",
|
|
2776
|
+
"LOGIN_EXPIRED",
|
|
2777
|
+
"LOGIN_DISABLED",
|
|
2778
|
+
"LOGIN_UNAVAILABLE",
|
|
2779
|
+
"LOGIN_CONFLICT",
|
|
2780
|
+
"LOGIN_REJECTED"
|
|
2444
2781
|
]
|
|
2782
|
+
},
|
|
2783
|
+
"attempts_left": {
|
|
2784
|
+
"type": "integer",
|
|
2785
|
+
"minimum": 0,
|
|
2786
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
2445
2787
|
}
|
|
2446
2788
|
}
|
|
2447
2789
|
}
|
|
@@ -2450,112 +2792,2071 @@
|
|
|
2450
2792
|
}
|
|
2451
2793
|
}
|
|
2452
2794
|
}
|
|
2453
|
-
}
|
|
2454
|
-
},
|
|
2455
|
-
"components": {
|
|
2456
|
-
"securitySchemes": {
|
|
2457
|
-
"EpilotAuth": {
|
|
2458
|
-
"type": "http",
|
|
2459
|
-
"scheme": "bearer"
|
|
2460
|
-
},
|
|
2461
|
-
"AnonymousSession": {
|
|
2462
|
-
"type": "http",
|
|
2463
|
-
"scheme": "bearer",
|
|
2464
|
-
"description": "Opaque, expiring Chat session token; never an epilot user or Portal access token."
|
|
2465
|
-
}
|
|
2466
2795
|
},
|
|
2467
|
-
"
|
|
2468
|
-
"
|
|
2469
|
-
"
|
|
2470
|
-
"
|
|
2471
|
-
|
|
2796
|
+
"/v1/login/portal": {
|
|
2797
|
+
"get": {
|
|
2798
|
+
"operationId": "getChatPortalLogin",
|
|
2799
|
+
"security": [
|
|
2800
|
+
{
|
|
2801
|
+
"AnonymousSession": []
|
|
2802
|
+
}
|
|
2472
2803
|
],
|
|
2473
|
-
"
|
|
2474
|
-
|
|
2475
|
-
|
|
2476
|
-
"
|
|
2477
|
-
|
|
2478
|
-
"
|
|
2479
|
-
"
|
|
2480
|
-
"org_id",
|
|
2481
|
-
"agent_id",
|
|
2482
|
-
"binding_id",
|
|
2483
|
-
"version",
|
|
2484
|
-
"name",
|
|
2485
|
-
"settings",
|
|
2486
|
-
"embed",
|
|
2487
|
-
"created_at",
|
|
2488
|
-
"updated_at"
|
|
2489
|
-
],
|
|
2490
|
-
"properties": {
|
|
2491
|
-
"name": {
|
|
2492
|
-
"type": "string",
|
|
2493
|
-
"minLength": 1,
|
|
2494
|
-
"maxLength": 100
|
|
2495
|
-
},
|
|
2496
|
-
"agent_id": {
|
|
2497
|
-
"type": "string",
|
|
2498
|
-
"format": "uuid",
|
|
2499
|
-
"nullable": true
|
|
2500
|
-
},
|
|
2501
|
-
"settings": {
|
|
2804
|
+
"description": "Read this session's portal login state. Tokens never leave the server.",
|
|
2805
|
+
"responses": {
|
|
2806
|
+
"200": {
|
|
2807
|
+
"description": "Current portal login state",
|
|
2808
|
+
"content": {
|
|
2809
|
+
"application/json": {
|
|
2810
|
+
"schema": {
|
|
2502
2811
|
"type": "object",
|
|
2503
2812
|
"additionalProperties": false,
|
|
2504
2813
|
"required": [
|
|
2505
|
-
"
|
|
2506
|
-
"
|
|
2507
|
-
"
|
|
2814
|
+
"available",
|
|
2815
|
+
"conversation_id",
|
|
2816
|
+
"status",
|
|
2817
|
+
"access"
|
|
2508
2818
|
],
|
|
2509
2819
|
"properties": {
|
|
2510
|
-
"
|
|
2511
|
-
"type": "
|
|
2512
|
-
"maxItems": 50,
|
|
2513
|
-
"uniqueItems": true,
|
|
2514
|
-
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
2515
|
-
"items": {
|
|
2516
|
-
"type": "string",
|
|
2517
|
-
"maxLength": 2048
|
|
2518
|
-
}
|
|
2820
|
+
"available": {
|
|
2821
|
+
"type": "boolean"
|
|
2519
2822
|
},
|
|
2520
|
-
"
|
|
2823
|
+
"conversation_id": {
|
|
2521
2824
|
"type": "string",
|
|
2522
|
-
"
|
|
2523
|
-
"maxLength": 100
|
|
2825
|
+
"format": "uuid"
|
|
2524
2826
|
},
|
|
2525
|
-
"
|
|
2827
|
+
"status": {
|
|
2526
2828
|
"type": "string",
|
|
2527
2829
|
"enum": [
|
|
2528
|
-
"
|
|
2529
|
-
"
|
|
2830
|
+
"anonymous",
|
|
2831
|
+
"pending",
|
|
2832
|
+
"verified"
|
|
2530
2833
|
]
|
|
2531
2834
|
},
|
|
2532
|
-
"
|
|
2835
|
+
"challenge_id": {
|
|
2533
2836
|
"type": "string",
|
|
2534
|
-
"format": "uuid"
|
|
2535
|
-
"nullable": true,
|
|
2536
|
-
"description": "Design Builder configuration for the Website Chat only."
|
|
2837
|
+
"format": "uuid"
|
|
2537
2838
|
},
|
|
2538
|
-
"
|
|
2839
|
+
"code_expires_at": {
|
|
2840
|
+
"type": "integer",
|
|
2841
|
+
"description": "Unix seconds"
|
|
2842
|
+
},
|
|
2843
|
+
"attempts_left": {
|
|
2844
|
+
"type": "integer",
|
|
2845
|
+
"minimum": 0
|
|
2846
|
+
},
|
|
2847
|
+
"email": {
|
|
2848
|
+
"type": "string",
|
|
2849
|
+
"format": "email",
|
|
2850
|
+
"maxLength": 254
|
|
2851
|
+
},
|
|
2852
|
+
"contact_resolution": {
|
|
2853
|
+
"type": "string",
|
|
2854
|
+
"enum": [
|
|
2855
|
+
"matched",
|
|
2856
|
+
"not_found"
|
|
2857
|
+
]
|
|
2858
|
+
},
|
|
2859
|
+
"access": {
|
|
2860
|
+
"type": "object",
|
|
2861
|
+
"additionalProperties": false,
|
|
2862
|
+
"required": [
|
|
2863
|
+
"tier"
|
|
2864
|
+
],
|
|
2865
|
+
"properties": {
|
|
2866
|
+
"tier": {
|
|
2867
|
+
"type": "string",
|
|
2868
|
+
"enum": [
|
|
2869
|
+
"anonymous",
|
|
2870
|
+
"identified",
|
|
2871
|
+
"verified"
|
|
2872
|
+
],
|
|
2873
|
+
"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"
|
|
2874
|
+
},
|
|
2875
|
+
"method": {
|
|
2876
|
+
"type": "string",
|
|
2877
|
+
"enum": [
|
|
2878
|
+
"email_code",
|
|
2879
|
+
"portal_login"
|
|
2880
|
+
],
|
|
2881
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
2882
|
+
}
|
|
2883
|
+
}
|
|
2884
|
+
}
|
|
2885
|
+
}
|
|
2886
|
+
}
|
|
2887
|
+
}
|
|
2888
|
+
}
|
|
2889
|
+
},
|
|
2890
|
+
"default": {
|
|
2891
|
+
"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.",
|
|
2892
|
+
"content": {
|
|
2893
|
+
"application/json": {
|
|
2894
|
+
"schema": {
|
|
2895
|
+
"type": "object",
|
|
2896
|
+
"required": [
|
|
2897
|
+
"code"
|
|
2898
|
+
],
|
|
2899
|
+
"properties": {
|
|
2900
|
+
"code": {
|
|
2901
|
+
"type": "string",
|
|
2902
|
+
"enum": [
|
|
2903
|
+
"INVALID_VERIFICATION_CODE",
|
|
2904
|
+
"VERIFICATION_EXPIRED",
|
|
2905
|
+
"VERIFICATION_CONFLICT",
|
|
2906
|
+
"VERIFICATION_DISABLED",
|
|
2907
|
+
"VERIFICATION_UNAVAILABLE",
|
|
2908
|
+
"IDENTITY_CHANGED",
|
|
2909
|
+
"INVALID_REQUEST",
|
|
2910
|
+
"ORIGIN_DENIED",
|
|
2911
|
+
"NOT_FOUND",
|
|
2912
|
+
"INVALID_GRANT",
|
|
2913
|
+
"SESSION_EXPIRED",
|
|
2914
|
+
"RATE_LIMITED",
|
|
2915
|
+
"SESSION_LIMIT",
|
|
2916
|
+
"USAGE_LIMIT",
|
|
2917
|
+
"REQUEST_CONFLICT",
|
|
2918
|
+
"IN_PROGRESS",
|
|
2919
|
+
"UNAVAILABLE",
|
|
2920
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
2921
|
+
"IDENTITY_REQUIRED",
|
|
2922
|
+
"ACTION_UNAVAILABLE",
|
|
2923
|
+
"ACTION_CONFLICT",
|
|
2924
|
+
"ACTION_TARGET_DENIED",
|
|
2925
|
+
"INVALID_LOGIN_CODE",
|
|
2926
|
+
"LOGIN_EXPIRED",
|
|
2927
|
+
"LOGIN_DISABLED",
|
|
2928
|
+
"LOGIN_UNAVAILABLE",
|
|
2929
|
+
"LOGIN_CONFLICT",
|
|
2930
|
+
"LOGIN_REJECTED"
|
|
2931
|
+
]
|
|
2932
|
+
},
|
|
2933
|
+
"attempts_left": {
|
|
2934
|
+
"type": "integer",
|
|
2935
|
+
"minimum": 0,
|
|
2936
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
2937
|
+
}
|
|
2938
|
+
}
|
|
2939
|
+
}
|
|
2940
|
+
}
|
|
2941
|
+
}
|
|
2942
|
+
}
|
|
2943
|
+
}
|
|
2944
|
+
}
|
|
2945
|
+
},
|
|
2946
|
+
"/v1/login/portal/start": {
|
|
2947
|
+
"post": {
|
|
2948
|
+
"operationId": "startChatPortalLogin",
|
|
2949
|
+
"security": [
|
|
2950
|
+
{
|
|
2951
|
+
"AnonymousSession": []
|
|
2952
|
+
}
|
|
2953
|
+
],
|
|
2954
|
+
"description": "Send a one-time code for the customer portal account with this email, using the portal\nconfigured on this session's Website Chat. The response is pending whether or not an\naccount exists. Repeating the same request_id and email does not send another email.\n",
|
|
2955
|
+
"requestBody": {
|
|
2956
|
+
"required": true,
|
|
2957
|
+
"content": {
|
|
2958
|
+
"application/json": {
|
|
2959
|
+
"schema": {
|
|
2960
|
+
"type": "object",
|
|
2961
|
+
"additionalProperties": false,
|
|
2962
|
+
"required": [
|
|
2963
|
+
"request_id",
|
|
2964
|
+
"email"
|
|
2965
|
+
],
|
|
2966
|
+
"properties": {
|
|
2967
|
+
"request_id": {
|
|
2968
|
+
"type": "string",
|
|
2969
|
+
"format": "uuid"
|
|
2970
|
+
},
|
|
2971
|
+
"email": {
|
|
2972
|
+
"type": "string",
|
|
2973
|
+
"format": "email",
|
|
2974
|
+
"maxLength": 254
|
|
2975
|
+
}
|
|
2976
|
+
}
|
|
2977
|
+
}
|
|
2978
|
+
}
|
|
2979
|
+
}
|
|
2980
|
+
},
|
|
2981
|
+
"responses": {
|
|
2982
|
+
"200": {
|
|
2983
|
+
"description": "Pending portal login state; does not reveal whether an account exists",
|
|
2984
|
+
"content": {
|
|
2985
|
+
"application/json": {
|
|
2986
|
+
"schema": {
|
|
2987
|
+
"type": "object",
|
|
2988
|
+
"additionalProperties": false,
|
|
2989
|
+
"required": [
|
|
2990
|
+
"available",
|
|
2991
|
+
"conversation_id",
|
|
2992
|
+
"status",
|
|
2993
|
+
"access"
|
|
2994
|
+
],
|
|
2995
|
+
"properties": {
|
|
2996
|
+
"available": {
|
|
2997
|
+
"type": "boolean"
|
|
2998
|
+
},
|
|
2999
|
+
"conversation_id": {
|
|
3000
|
+
"type": "string",
|
|
3001
|
+
"format": "uuid"
|
|
3002
|
+
},
|
|
3003
|
+
"status": {
|
|
3004
|
+
"type": "string",
|
|
3005
|
+
"enum": [
|
|
3006
|
+
"anonymous",
|
|
3007
|
+
"pending",
|
|
3008
|
+
"verified"
|
|
3009
|
+
]
|
|
3010
|
+
},
|
|
3011
|
+
"challenge_id": {
|
|
3012
|
+
"type": "string",
|
|
3013
|
+
"format": "uuid"
|
|
3014
|
+
},
|
|
3015
|
+
"code_expires_at": {
|
|
3016
|
+
"type": "integer",
|
|
3017
|
+
"description": "Unix seconds"
|
|
3018
|
+
},
|
|
3019
|
+
"attempts_left": {
|
|
3020
|
+
"type": "integer",
|
|
3021
|
+
"minimum": 0
|
|
3022
|
+
},
|
|
3023
|
+
"email": {
|
|
3024
|
+
"type": "string",
|
|
3025
|
+
"format": "email",
|
|
3026
|
+
"maxLength": 254
|
|
3027
|
+
},
|
|
3028
|
+
"contact_resolution": {
|
|
3029
|
+
"type": "string",
|
|
3030
|
+
"enum": [
|
|
3031
|
+
"matched",
|
|
3032
|
+
"not_found"
|
|
3033
|
+
]
|
|
3034
|
+
},
|
|
3035
|
+
"access": {
|
|
3036
|
+
"type": "object",
|
|
3037
|
+
"additionalProperties": false,
|
|
3038
|
+
"required": [
|
|
3039
|
+
"tier"
|
|
3040
|
+
],
|
|
3041
|
+
"properties": {
|
|
3042
|
+
"tier": {
|
|
3043
|
+
"type": "string",
|
|
3044
|
+
"enum": [
|
|
3045
|
+
"anonymous",
|
|
3046
|
+
"identified",
|
|
3047
|
+
"verified"
|
|
3048
|
+
],
|
|
3049
|
+
"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"
|
|
3050
|
+
},
|
|
3051
|
+
"method": {
|
|
3052
|
+
"type": "string",
|
|
3053
|
+
"enum": [
|
|
3054
|
+
"email_code",
|
|
3055
|
+
"portal_login"
|
|
3056
|
+
],
|
|
3057
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
3058
|
+
}
|
|
3059
|
+
}
|
|
3060
|
+
}
|
|
3061
|
+
}
|
|
3062
|
+
}
|
|
3063
|
+
}
|
|
3064
|
+
}
|
|
3065
|
+
},
|
|
3066
|
+
"default": {
|
|
3067
|
+
"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.",
|
|
3068
|
+
"content": {
|
|
3069
|
+
"application/json": {
|
|
3070
|
+
"schema": {
|
|
3071
|
+
"type": "object",
|
|
3072
|
+
"required": [
|
|
3073
|
+
"code"
|
|
3074
|
+
],
|
|
3075
|
+
"properties": {
|
|
3076
|
+
"code": {
|
|
3077
|
+
"type": "string",
|
|
3078
|
+
"enum": [
|
|
3079
|
+
"INVALID_VERIFICATION_CODE",
|
|
3080
|
+
"VERIFICATION_EXPIRED",
|
|
3081
|
+
"VERIFICATION_CONFLICT",
|
|
3082
|
+
"VERIFICATION_DISABLED",
|
|
3083
|
+
"VERIFICATION_UNAVAILABLE",
|
|
3084
|
+
"IDENTITY_CHANGED",
|
|
3085
|
+
"INVALID_REQUEST",
|
|
3086
|
+
"ORIGIN_DENIED",
|
|
3087
|
+
"NOT_FOUND",
|
|
3088
|
+
"INVALID_GRANT",
|
|
3089
|
+
"SESSION_EXPIRED",
|
|
3090
|
+
"RATE_LIMITED",
|
|
3091
|
+
"SESSION_LIMIT",
|
|
3092
|
+
"USAGE_LIMIT",
|
|
3093
|
+
"REQUEST_CONFLICT",
|
|
3094
|
+
"IN_PROGRESS",
|
|
3095
|
+
"UNAVAILABLE",
|
|
3096
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
3097
|
+
"IDENTITY_REQUIRED",
|
|
3098
|
+
"ACTION_UNAVAILABLE",
|
|
3099
|
+
"ACTION_CONFLICT",
|
|
3100
|
+
"ACTION_TARGET_DENIED",
|
|
3101
|
+
"INVALID_LOGIN_CODE",
|
|
3102
|
+
"LOGIN_EXPIRED",
|
|
3103
|
+
"LOGIN_DISABLED",
|
|
3104
|
+
"LOGIN_UNAVAILABLE",
|
|
3105
|
+
"LOGIN_CONFLICT",
|
|
3106
|
+
"LOGIN_REJECTED"
|
|
3107
|
+
]
|
|
3108
|
+
},
|
|
3109
|
+
"attempts_left": {
|
|
3110
|
+
"type": "integer",
|
|
3111
|
+
"minimum": 0,
|
|
3112
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
3113
|
+
}
|
|
3114
|
+
}
|
|
3115
|
+
}
|
|
3116
|
+
}
|
|
3117
|
+
}
|
|
3118
|
+
}
|
|
3119
|
+
}
|
|
3120
|
+
}
|
|
3121
|
+
},
|
|
3122
|
+
"/v1/login/portal/verify": {
|
|
3123
|
+
"post": {
|
|
3124
|
+
"operationId": "verifyChatPortalLogin",
|
|
3125
|
+
"security": [
|
|
3126
|
+
{
|
|
3127
|
+
"AnonymousSession": []
|
|
3128
|
+
}
|
|
3129
|
+
],
|
|
3130
|
+
"description": "Answer the current portal login challenge. Success logs the customer in with their\nportal account and starts a new conversation. A wrong code returns 400\nINVALID_LOGIN_CODE with attempts_left (the Portal emails a new code while attempts\nremain); an expired or replaced challenge returns 409 LOGIN_EXPIRED.\n",
|
|
3131
|
+
"requestBody": {
|
|
3132
|
+
"required": true,
|
|
3133
|
+
"content": {
|
|
3134
|
+
"application/json": {
|
|
3135
|
+
"schema": {
|
|
3136
|
+
"type": "object",
|
|
3137
|
+
"additionalProperties": false,
|
|
3138
|
+
"required": [
|
|
3139
|
+
"challenge_id",
|
|
3140
|
+
"code"
|
|
3141
|
+
],
|
|
3142
|
+
"properties": {
|
|
3143
|
+
"challenge_id": {
|
|
3144
|
+
"type": "string",
|
|
3145
|
+
"format": "uuid"
|
|
3146
|
+
},
|
|
3147
|
+
"code": {
|
|
3148
|
+
"type": "string",
|
|
3149
|
+
"pattern": "^\\d{6}$"
|
|
3150
|
+
}
|
|
3151
|
+
}
|
|
3152
|
+
}
|
|
3153
|
+
}
|
|
3154
|
+
}
|
|
3155
|
+
},
|
|
3156
|
+
"responses": {
|
|
3157
|
+
"200": {
|
|
3158
|
+
"description": "Verified portal login state",
|
|
3159
|
+
"content": {
|
|
3160
|
+
"application/json": {
|
|
3161
|
+
"schema": {
|
|
3162
|
+
"type": "object",
|
|
3163
|
+
"additionalProperties": false,
|
|
3164
|
+
"required": [
|
|
3165
|
+
"available",
|
|
3166
|
+
"conversation_id",
|
|
3167
|
+
"status",
|
|
3168
|
+
"access"
|
|
3169
|
+
],
|
|
3170
|
+
"properties": {
|
|
3171
|
+
"available": {
|
|
3172
|
+
"type": "boolean"
|
|
3173
|
+
},
|
|
3174
|
+
"conversation_id": {
|
|
3175
|
+
"type": "string",
|
|
3176
|
+
"format": "uuid"
|
|
3177
|
+
},
|
|
3178
|
+
"status": {
|
|
3179
|
+
"type": "string",
|
|
3180
|
+
"enum": [
|
|
3181
|
+
"anonymous",
|
|
3182
|
+
"pending",
|
|
3183
|
+
"verified"
|
|
3184
|
+
]
|
|
3185
|
+
},
|
|
3186
|
+
"challenge_id": {
|
|
3187
|
+
"type": "string",
|
|
3188
|
+
"format": "uuid"
|
|
3189
|
+
},
|
|
3190
|
+
"code_expires_at": {
|
|
3191
|
+
"type": "integer",
|
|
3192
|
+
"description": "Unix seconds"
|
|
3193
|
+
},
|
|
3194
|
+
"attempts_left": {
|
|
3195
|
+
"type": "integer",
|
|
3196
|
+
"minimum": 0
|
|
3197
|
+
},
|
|
3198
|
+
"email": {
|
|
3199
|
+
"type": "string",
|
|
3200
|
+
"format": "email",
|
|
3201
|
+
"maxLength": 254
|
|
3202
|
+
},
|
|
3203
|
+
"contact_resolution": {
|
|
3204
|
+
"type": "string",
|
|
3205
|
+
"enum": [
|
|
3206
|
+
"matched",
|
|
3207
|
+
"not_found"
|
|
3208
|
+
]
|
|
3209
|
+
},
|
|
3210
|
+
"access": {
|
|
3211
|
+
"type": "object",
|
|
3212
|
+
"additionalProperties": false,
|
|
3213
|
+
"required": [
|
|
3214
|
+
"tier"
|
|
3215
|
+
],
|
|
3216
|
+
"properties": {
|
|
3217
|
+
"tier": {
|
|
3218
|
+
"type": "string",
|
|
3219
|
+
"enum": [
|
|
3220
|
+
"anonymous",
|
|
3221
|
+
"identified",
|
|
3222
|
+
"verified"
|
|
3223
|
+
],
|
|
3224
|
+
"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"
|
|
3225
|
+
},
|
|
3226
|
+
"method": {
|
|
3227
|
+
"type": "string",
|
|
3228
|
+
"enum": [
|
|
3229
|
+
"email_code",
|
|
3230
|
+
"portal_login"
|
|
3231
|
+
],
|
|
3232
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
3233
|
+
}
|
|
3234
|
+
}
|
|
3235
|
+
}
|
|
3236
|
+
}
|
|
3237
|
+
}
|
|
3238
|
+
}
|
|
3239
|
+
}
|
|
3240
|
+
},
|
|
3241
|
+
"default": {
|
|
3242
|
+
"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.",
|
|
3243
|
+
"content": {
|
|
3244
|
+
"application/json": {
|
|
3245
|
+
"schema": {
|
|
3246
|
+
"type": "object",
|
|
3247
|
+
"required": [
|
|
3248
|
+
"code"
|
|
3249
|
+
],
|
|
3250
|
+
"properties": {
|
|
3251
|
+
"code": {
|
|
3252
|
+
"type": "string",
|
|
3253
|
+
"enum": [
|
|
3254
|
+
"INVALID_VERIFICATION_CODE",
|
|
3255
|
+
"VERIFICATION_EXPIRED",
|
|
3256
|
+
"VERIFICATION_CONFLICT",
|
|
3257
|
+
"VERIFICATION_DISABLED",
|
|
3258
|
+
"VERIFICATION_UNAVAILABLE",
|
|
3259
|
+
"IDENTITY_CHANGED",
|
|
3260
|
+
"INVALID_REQUEST",
|
|
3261
|
+
"ORIGIN_DENIED",
|
|
3262
|
+
"NOT_FOUND",
|
|
3263
|
+
"INVALID_GRANT",
|
|
3264
|
+
"SESSION_EXPIRED",
|
|
3265
|
+
"RATE_LIMITED",
|
|
3266
|
+
"SESSION_LIMIT",
|
|
3267
|
+
"USAGE_LIMIT",
|
|
3268
|
+
"REQUEST_CONFLICT",
|
|
3269
|
+
"IN_PROGRESS",
|
|
3270
|
+
"UNAVAILABLE",
|
|
3271
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
3272
|
+
"IDENTITY_REQUIRED",
|
|
3273
|
+
"ACTION_UNAVAILABLE",
|
|
3274
|
+
"ACTION_CONFLICT",
|
|
3275
|
+
"ACTION_TARGET_DENIED",
|
|
3276
|
+
"INVALID_LOGIN_CODE",
|
|
3277
|
+
"LOGIN_EXPIRED",
|
|
3278
|
+
"LOGIN_DISABLED",
|
|
3279
|
+
"LOGIN_UNAVAILABLE",
|
|
3280
|
+
"LOGIN_CONFLICT",
|
|
3281
|
+
"LOGIN_REJECTED"
|
|
3282
|
+
]
|
|
3283
|
+
},
|
|
3284
|
+
"attempts_left": {
|
|
3285
|
+
"type": "integer",
|
|
3286
|
+
"minimum": 0,
|
|
3287
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
3288
|
+
}
|
|
3289
|
+
}
|
|
3290
|
+
}
|
|
3291
|
+
}
|
|
3292
|
+
}
|
|
3293
|
+
}
|
|
3294
|
+
}
|
|
3295
|
+
}
|
|
3296
|
+
},
|
|
3297
|
+
"/v1/login/portal/cancel": {
|
|
3298
|
+
"post": {
|
|
3299
|
+
"operationId": "cancelChatPortalLogin",
|
|
3300
|
+
"security": [
|
|
3301
|
+
{
|
|
3302
|
+
"AnonymousSession": []
|
|
3303
|
+
}
|
|
3304
|
+
],
|
|
3305
|
+
"description": "Cancel a pending portal login or end a portal login. Ending it starts a new anonymous conversation.",
|
|
3306
|
+
"responses": {
|
|
3307
|
+
"200": {
|
|
3308
|
+
"description": "Anonymous portal login state",
|
|
3309
|
+
"content": {
|
|
3310
|
+
"application/json": {
|
|
3311
|
+
"schema": {
|
|
3312
|
+
"type": "object",
|
|
3313
|
+
"additionalProperties": false,
|
|
3314
|
+
"required": [
|
|
3315
|
+
"available",
|
|
3316
|
+
"conversation_id",
|
|
3317
|
+
"status",
|
|
3318
|
+
"access"
|
|
3319
|
+
],
|
|
3320
|
+
"properties": {
|
|
3321
|
+
"available": {
|
|
3322
|
+
"type": "boolean"
|
|
3323
|
+
},
|
|
3324
|
+
"conversation_id": {
|
|
3325
|
+
"type": "string",
|
|
3326
|
+
"format": "uuid"
|
|
3327
|
+
},
|
|
3328
|
+
"status": {
|
|
3329
|
+
"type": "string",
|
|
3330
|
+
"enum": [
|
|
3331
|
+
"anonymous",
|
|
3332
|
+
"pending",
|
|
3333
|
+
"verified"
|
|
3334
|
+
]
|
|
3335
|
+
},
|
|
3336
|
+
"challenge_id": {
|
|
3337
|
+
"type": "string",
|
|
3338
|
+
"format": "uuid"
|
|
3339
|
+
},
|
|
3340
|
+
"code_expires_at": {
|
|
3341
|
+
"type": "integer",
|
|
3342
|
+
"description": "Unix seconds"
|
|
3343
|
+
},
|
|
3344
|
+
"attempts_left": {
|
|
3345
|
+
"type": "integer",
|
|
3346
|
+
"minimum": 0
|
|
3347
|
+
},
|
|
3348
|
+
"email": {
|
|
3349
|
+
"type": "string",
|
|
3350
|
+
"format": "email",
|
|
3351
|
+
"maxLength": 254
|
|
3352
|
+
},
|
|
3353
|
+
"contact_resolution": {
|
|
3354
|
+
"type": "string",
|
|
3355
|
+
"enum": [
|
|
3356
|
+
"matched",
|
|
3357
|
+
"not_found"
|
|
3358
|
+
]
|
|
3359
|
+
},
|
|
3360
|
+
"access": {
|
|
3361
|
+
"type": "object",
|
|
3362
|
+
"additionalProperties": false,
|
|
3363
|
+
"required": [
|
|
3364
|
+
"tier"
|
|
3365
|
+
],
|
|
3366
|
+
"properties": {
|
|
3367
|
+
"tier": {
|
|
3368
|
+
"type": "string",
|
|
3369
|
+
"enum": [
|
|
3370
|
+
"anonymous",
|
|
3371
|
+
"identified",
|
|
3372
|
+
"verified"
|
|
3373
|
+
],
|
|
3374
|
+
"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"
|
|
3375
|
+
},
|
|
3376
|
+
"method": {
|
|
3377
|
+
"type": "string",
|
|
3378
|
+
"enum": [
|
|
3379
|
+
"email_code",
|
|
3380
|
+
"portal_login"
|
|
3381
|
+
],
|
|
3382
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
3383
|
+
}
|
|
3384
|
+
}
|
|
3385
|
+
}
|
|
3386
|
+
}
|
|
3387
|
+
}
|
|
3388
|
+
}
|
|
3389
|
+
}
|
|
3390
|
+
},
|
|
3391
|
+
"default": {
|
|
3392
|
+
"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.",
|
|
3393
|
+
"content": {
|
|
3394
|
+
"application/json": {
|
|
3395
|
+
"schema": {
|
|
3396
|
+
"type": "object",
|
|
3397
|
+
"required": [
|
|
3398
|
+
"code"
|
|
3399
|
+
],
|
|
3400
|
+
"properties": {
|
|
3401
|
+
"code": {
|
|
3402
|
+
"type": "string",
|
|
3403
|
+
"enum": [
|
|
3404
|
+
"INVALID_VERIFICATION_CODE",
|
|
3405
|
+
"VERIFICATION_EXPIRED",
|
|
3406
|
+
"VERIFICATION_CONFLICT",
|
|
3407
|
+
"VERIFICATION_DISABLED",
|
|
3408
|
+
"VERIFICATION_UNAVAILABLE",
|
|
3409
|
+
"IDENTITY_CHANGED",
|
|
3410
|
+
"INVALID_REQUEST",
|
|
3411
|
+
"ORIGIN_DENIED",
|
|
3412
|
+
"NOT_FOUND",
|
|
3413
|
+
"INVALID_GRANT",
|
|
3414
|
+
"SESSION_EXPIRED",
|
|
3415
|
+
"RATE_LIMITED",
|
|
3416
|
+
"SESSION_LIMIT",
|
|
3417
|
+
"USAGE_LIMIT",
|
|
3418
|
+
"REQUEST_CONFLICT",
|
|
3419
|
+
"IN_PROGRESS",
|
|
3420
|
+
"UNAVAILABLE",
|
|
3421
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
3422
|
+
"IDENTITY_REQUIRED",
|
|
3423
|
+
"ACTION_UNAVAILABLE",
|
|
3424
|
+
"ACTION_CONFLICT",
|
|
3425
|
+
"ACTION_TARGET_DENIED",
|
|
3426
|
+
"INVALID_LOGIN_CODE",
|
|
3427
|
+
"LOGIN_EXPIRED",
|
|
3428
|
+
"LOGIN_DISABLED",
|
|
3429
|
+
"LOGIN_UNAVAILABLE",
|
|
3430
|
+
"LOGIN_CONFLICT",
|
|
3431
|
+
"LOGIN_REJECTED"
|
|
3432
|
+
]
|
|
3433
|
+
},
|
|
3434
|
+
"attempts_left": {
|
|
3435
|
+
"type": "integer",
|
|
3436
|
+
"minimum": 0,
|
|
3437
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
3438
|
+
}
|
|
3439
|
+
}
|
|
3440
|
+
}
|
|
3441
|
+
}
|
|
3442
|
+
}
|
|
3443
|
+
}
|
|
3444
|
+
}
|
|
3445
|
+
}
|
|
3446
|
+
},
|
|
3447
|
+
"/v1/login/sign-out": {
|
|
3448
|
+
"post": {
|
|
3449
|
+
"operationId": "signOutChatCustomer",
|
|
3450
|
+
"security": [
|
|
3451
|
+
{
|
|
3452
|
+
"AnonymousSession": []
|
|
3453
|
+
}
|
|
3454
|
+
],
|
|
3455
|
+
"description": "Clear the customer identity of any login method and pending challenges. Clearing an identity starts a new anonymous conversation.",
|
|
3456
|
+
"responses": {
|
|
3457
|
+
"200": {
|
|
3458
|
+
"description": "Anonymous access",
|
|
3459
|
+
"content": {
|
|
3460
|
+
"application/json": {
|
|
3461
|
+
"schema": {
|
|
3462
|
+
"type": "object",
|
|
3463
|
+
"additionalProperties": false,
|
|
3464
|
+
"required": [
|
|
3465
|
+
"conversation_id",
|
|
3466
|
+
"access"
|
|
3467
|
+
],
|
|
3468
|
+
"properties": {
|
|
3469
|
+
"conversation_id": {
|
|
3470
|
+
"type": "string",
|
|
3471
|
+
"format": "uuid"
|
|
3472
|
+
},
|
|
3473
|
+
"access": {
|
|
3474
|
+
"type": "object",
|
|
3475
|
+
"additionalProperties": false,
|
|
3476
|
+
"required": [
|
|
3477
|
+
"tier"
|
|
3478
|
+
],
|
|
3479
|
+
"properties": {
|
|
3480
|
+
"tier": {
|
|
3481
|
+
"type": "string",
|
|
3482
|
+
"enum": [
|
|
3483
|
+
"anonymous",
|
|
3484
|
+
"identified",
|
|
3485
|
+
"verified"
|
|
3486
|
+
],
|
|
3487
|
+
"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"
|
|
3488
|
+
},
|
|
3489
|
+
"method": {
|
|
3490
|
+
"type": "string",
|
|
3491
|
+
"enum": [
|
|
3492
|
+
"email_code",
|
|
3493
|
+
"portal_login"
|
|
3494
|
+
],
|
|
3495
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
3496
|
+
}
|
|
3497
|
+
}
|
|
3498
|
+
}
|
|
3499
|
+
}
|
|
3500
|
+
}
|
|
3501
|
+
}
|
|
3502
|
+
}
|
|
3503
|
+
},
|
|
3504
|
+
"default": {
|
|
3505
|
+
"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.",
|
|
3506
|
+
"content": {
|
|
3507
|
+
"application/json": {
|
|
3508
|
+
"schema": {
|
|
3509
|
+
"type": "object",
|
|
3510
|
+
"required": [
|
|
3511
|
+
"code"
|
|
3512
|
+
],
|
|
3513
|
+
"properties": {
|
|
3514
|
+
"code": {
|
|
3515
|
+
"type": "string",
|
|
3516
|
+
"enum": [
|
|
3517
|
+
"INVALID_VERIFICATION_CODE",
|
|
3518
|
+
"VERIFICATION_EXPIRED",
|
|
3519
|
+
"VERIFICATION_CONFLICT",
|
|
3520
|
+
"VERIFICATION_DISABLED",
|
|
3521
|
+
"VERIFICATION_UNAVAILABLE",
|
|
3522
|
+
"IDENTITY_CHANGED",
|
|
3523
|
+
"INVALID_REQUEST",
|
|
3524
|
+
"ORIGIN_DENIED",
|
|
3525
|
+
"NOT_FOUND",
|
|
3526
|
+
"INVALID_GRANT",
|
|
3527
|
+
"SESSION_EXPIRED",
|
|
3528
|
+
"RATE_LIMITED",
|
|
3529
|
+
"SESSION_LIMIT",
|
|
3530
|
+
"USAGE_LIMIT",
|
|
3531
|
+
"REQUEST_CONFLICT",
|
|
3532
|
+
"IN_PROGRESS",
|
|
3533
|
+
"UNAVAILABLE",
|
|
3534
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
3535
|
+
"IDENTITY_REQUIRED",
|
|
3536
|
+
"ACTION_UNAVAILABLE",
|
|
3537
|
+
"ACTION_CONFLICT",
|
|
3538
|
+
"ACTION_TARGET_DENIED",
|
|
3539
|
+
"INVALID_LOGIN_CODE",
|
|
3540
|
+
"LOGIN_EXPIRED",
|
|
3541
|
+
"LOGIN_DISABLED",
|
|
3542
|
+
"LOGIN_UNAVAILABLE",
|
|
3543
|
+
"LOGIN_CONFLICT",
|
|
3544
|
+
"LOGIN_REJECTED"
|
|
3545
|
+
]
|
|
3546
|
+
},
|
|
3547
|
+
"attempts_left": {
|
|
3548
|
+
"type": "integer",
|
|
3549
|
+
"minimum": 0,
|
|
3550
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
3551
|
+
}
|
|
3552
|
+
}
|
|
3553
|
+
}
|
|
3554
|
+
}
|
|
3555
|
+
}
|
|
3556
|
+
}
|
|
3557
|
+
}
|
|
3558
|
+
}
|
|
3559
|
+
},
|
|
3560
|
+
"/v1/actions": {
|
|
3561
|
+
"get": {
|
|
3562
|
+
"operationId": "getChatAction",
|
|
3563
|
+
"security": [
|
|
3564
|
+
{
|
|
3565
|
+
"AnonymousSession": []
|
|
3566
|
+
}
|
|
3567
|
+
],
|
|
3568
|
+
"description": "Prototype. Read this session's current Guided Action. Values never reach the AI or the host page.",
|
|
3569
|
+
"responses": {
|
|
3570
|
+
"200": {
|
|
3571
|
+
"description": "Current Guided Action state",
|
|
3572
|
+
"content": {
|
|
3573
|
+
"application/json": {
|
|
3574
|
+
"schema": {
|
|
3575
|
+
"type": "object",
|
|
3576
|
+
"additionalProperties": false,
|
|
3577
|
+
"required": [
|
|
3578
|
+
"conversation_id",
|
|
3579
|
+
"status"
|
|
3580
|
+
],
|
|
3581
|
+
"properties": {
|
|
3582
|
+
"conversation_id": {
|
|
3583
|
+
"type": "string",
|
|
3584
|
+
"format": "uuid"
|
|
3585
|
+
},
|
|
3586
|
+
"status": {
|
|
3587
|
+
"type": "string",
|
|
3588
|
+
"enum": [
|
|
3589
|
+
"none",
|
|
3590
|
+
"needs_input",
|
|
3591
|
+
"needs_confirmation",
|
|
3592
|
+
"executing",
|
|
3593
|
+
"completed",
|
|
3594
|
+
"pending",
|
|
3595
|
+
"rejected",
|
|
3596
|
+
"handoff"
|
|
3597
|
+
]
|
|
3598
|
+
},
|
|
3599
|
+
"action_id": {
|
|
3600
|
+
"type": "string",
|
|
3601
|
+
"format": "uuid"
|
|
3602
|
+
},
|
|
3603
|
+
"revision": {
|
|
3604
|
+
"type": "integer"
|
|
3605
|
+
},
|
|
3606
|
+
"options": {
|
|
3607
|
+
"type": "array",
|
|
3608
|
+
"maxItems": 50,
|
|
3609
|
+
"items": {
|
|
3610
|
+
"type": "object",
|
|
3611
|
+
"additionalProperties": false,
|
|
3612
|
+
"required": [
|
|
3613
|
+
"meter_id",
|
|
3614
|
+
"counter_id",
|
|
3615
|
+
"meter_number",
|
|
3616
|
+
"label",
|
|
3617
|
+
"unit"
|
|
3618
|
+
],
|
|
3619
|
+
"properties": {
|
|
3620
|
+
"meter_id": {
|
|
3621
|
+
"type": "string"
|
|
3622
|
+
},
|
|
3623
|
+
"counter_id": {
|
|
3624
|
+
"type": "string"
|
|
3625
|
+
},
|
|
3626
|
+
"meter_number": {
|
|
3627
|
+
"type": "string"
|
|
3628
|
+
},
|
|
3629
|
+
"label": {
|
|
3630
|
+
"type": "string"
|
|
3631
|
+
},
|
|
3632
|
+
"unit": {
|
|
3633
|
+
"type": "string"
|
|
3634
|
+
},
|
|
3635
|
+
"min_value": {
|
|
3636
|
+
"type": "number"
|
|
3637
|
+
},
|
|
3638
|
+
"max_value": {
|
|
3639
|
+
"type": "number"
|
|
3640
|
+
}
|
|
3641
|
+
}
|
|
3642
|
+
}
|
|
3643
|
+
},
|
|
3644
|
+
"values": {
|
|
3645
|
+
"type": "object",
|
|
3646
|
+
"additionalProperties": false,
|
|
3647
|
+
"required": [
|
|
3648
|
+
"meter_id",
|
|
3649
|
+
"counter_id",
|
|
3650
|
+
"value"
|
|
3651
|
+
],
|
|
3652
|
+
"properties": {
|
|
3653
|
+
"meter_id": {
|
|
3654
|
+
"type": "string"
|
|
3655
|
+
},
|
|
3656
|
+
"counter_id": {
|
|
3657
|
+
"type": "string"
|
|
3658
|
+
},
|
|
3659
|
+
"value": {
|
|
3660
|
+
"type": "number"
|
|
3661
|
+
}
|
|
3662
|
+
}
|
|
3663
|
+
},
|
|
3664
|
+
"field_error": {
|
|
3665
|
+
"type": "string",
|
|
3666
|
+
"enum": [
|
|
3667
|
+
"VALUE_INVALID",
|
|
3668
|
+
"VALUE_OUT_OF_RANGE",
|
|
3669
|
+
"TARGET_UNAVAILABLE"
|
|
3670
|
+
]
|
|
3671
|
+
},
|
|
3672
|
+
"receipt": {
|
|
3673
|
+
"type": "object",
|
|
3674
|
+
"additionalProperties": false,
|
|
3675
|
+
"required": [
|
|
3676
|
+
"reference",
|
|
3677
|
+
"meter_number",
|
|
3678
|
+
"value",
|
|
3679
|
+
"unit",
|
|
3680
|
+
"submitted_at"
|
|
3681
|
+
],
|
|
3682
|
+
"properties": {
|
|
3683
|
+
"reference": {
|
|
3684
|
+
"type": "string"
|
|
3685
|
+
},
|
|
3686
|
+
"meter_number": {
|
|
3687
|
+
"type": "string"
|
|
3688
|
+
},
|
|
3689
|
+
"value": {
|
|
3690
|
+
"type": "number"
|
|
3691
|
+
},
|
|
3692
|
+
"unit": {
|
|
3693
|
+
"type": "string"
|
|
3694
|
+
},
|
|
3695
|
+
"submitted_at": {
|
|
3696
|
+
"type": "string"
|
|
3697
|
+
}
|
|
3698
|
+
}
|
|
3699
|
+
},
|
|
3700
|
+
"reason": {
|
|
3701
|
+
"type": "string",
|
|
3702
|
+
"enum": [
|
|
3703
|
+
"NO_METERS",
|
|
3704
|
+
"SUBMISSION_REJECTED",
|
|
3705
|
+
"SUBMISSION_UNCERTAIN"
|
|
3706
|
+
]
|
|
3707
|
+
}
|
|
3708
|
+
}
|
|
3709
|
+
}
|
|
3710
|
+
}
|
|
3711
|
+
}
|
|
3712
|
+
},
|
|
3713
|
+
"default": {
|
|
3714
|
+
"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.",
|
|
3715
|
+
"content": {
|
|
3716
|
+
"application/json": {
|
|
3717
|
+
"schema": {
|
|
3718
|
+
"type": "object",
|
|
3719
|
+
"required": [
|
|
3720
|
+
"code"
|
|
3721
|
+
],
|
|
3722
|
+
"properties": {
|
|
3723
|
+
"code": {
|
|
3724
|
+
"type": "string",
|
|
3725
|
+
"enum": [
|
|
3726
|
+
"INVALID_VERIFICATION_CODE",
|
|
3727
|
+
"VERIFICATION_EXPIRED",
|
|
3728
|
+
"VERIFICATION_CONFLICT",
|
|
3729
|
+
"VERIFICATION_DISABLED",
|
|
3730
|
+
"VERIFICATION_UNAVAILABLE",
|
|
3731
|
+
"IDENTITY_CHANGED",
|
|
3732
|
+
"INVALID_REQUEST",
|
|
3733
|
+
"ORIGIN_DENIED",
|
|
3734
|
+
"NOT_FOUND",
|
|
3735
|
+
"INVALID_GRANT",
|
|
3736
|
+
"SESSION_EXPIRED",
|
|
3737
|
+
"RATE_LIMITED",
|
|
3738
|
+
"SESSION_LIMIT",
|
|
3739
|
+
"USAGE_LIMIT",
|
|
3740
|
+
"REQUEST_CONFLICT",
|
|
3741
|
+
"IN_PROGRESS",
|
|
3742
|
+
"UNAVAILABLE",
|
|
3743
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
3744
|
+
"IDENTITY_REQUIRED",
|
|
3745
|
+
"ACTION_UNAVAILABLE",
|
|
3746
|
+
"ACTION_CONFLICT",
|
|
3747
|
+
"ACTION_TARGET_DENIED",
|
|
3748
|
+
"INVALID_LOGIN_CODE",
|
|
3749
|
+
"LOGIN_EXPIRED",
|
|
3750
|
+
"LOGIN_DISABLED",
|
|
3751
|
+
"LOGIN_UNAVAILABLE",
|
|
3752
|
+
"LOGIN_CONFLICT",
|
|
3753
|
+
"LOGIN_REJECTED"
|
|
3754
|
+
]
|
|
3755
|
+
},
|
|
3756
|
+
"attempts_left": {
|
|
3757
|
+
"type": "integer",
|
|
3758
|
+
"minimum": 0,
|
|
3759
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
3760
|
+
}
|
|
3761
|
+
}
|
|
3762
|
+
}
|
|
3763
|
+
}
|
|
3764
|
+
}
|
|
3765
|
+
}
|
|
3766
|
+
}
|
|
3767
|
+
},
|
|
3768
|
+
"post": {
|
|
3769
|
+
"operationId": "startChatAction",
|
|
3770
|
+
"security": [
|
|
3771
|
+
{
|
|
3772
|
+
"AnonymousSession": []
|
|
3773
|
+
}
|
|
3774
|
+
],
|
|
3775
|
+
"description": "Prototype. Start a Guided Action for the verified Contact. The eligible targets are resolved on the server.",
|
|
3776
|
+
"requestBody": {
|
|
3777
|
+
"required": true,
|
|
3778
|
+
"content": {
|
|
3779
|
+
"application/json": {
|
|
3780
|
+
"schema": {
|
|
3781
|
+
"type": "object",
|
|
3782
|
+
"additionalProperties": false,
|
|
3783
|
+
"required": [
|
|
3784
|
+
"request_id",
|
|
3785
|
+
"action_type"
|
|
3786
|
+
],
|
|
3787
|
+
"properties": {
|
|
3788
|
+
"request_id": {
|
|
3789
|
+
"type": "string",
|
|
3790
|
+
"format": "uuid"
|
|
3791
|
+
},
|
|
3792
|
+
"action_type": {
|
|
3793
|
+
"type": "string",
|
|
3794
|
+
"enum": [
|
|
3795
|
+
"submit_meter_reading"
|
|
3796
|
+
]
|
|
3797
|
+
}
|
|
3798
|
+
}
|
|
3799
|
+
}
|
|
3800
|
+
}
|
|
3801
|
+
}
|
|
3802
|
+
},
|
|
3803
|
+
"responses": {
|
|
3804
|
+
"200": {
|
|
3805
|
+
"description": "The started action",
|
|
3806
|
+
"content": {
|
|
3807
|
+
"application/json": {
|
|
3808
|
+
"schema": {
|
|
3809
|
+
"type": "object",
|
|
3810
|
+
"additionalProperties": false,
|
|
3811
|
+
"required": [
|
|
3812
|
+
"conversation_id",
|
|
3813
|
+
"status"
|
|
3814
|
+
],
|
|
3815
|
+
"properties": {
|
|
3816
|
+
"conversation_id": {
|
|
3817
|
+
"type": "string",
|
|
3818
|
+
"format": "uuid"
|
|
3819
|
+
},
|
|
3820
|
+
"status": {
|
|
3821
|
+
"type": "string",
|
|
3822
|
+
"enum": [
|
|
3823
|
+
"none",
|
|
3824
|
+
"needs_input",
|
|
3825
|
+
"needs_confirmation",
|
|
3826
|
+
"executing",
|
|
3827
|
+
"completed",
|
|
3828
|
+
"pending",
|
|
3829
|
+
"rejected",
|
|
3830
|
+
"handoff"
|
|
3831
|
+
]
|
|
3832
|
+
},
|
|
3833
|
+
"action_id": {
|
|
3834
|
+
"type": "string",
|
|
3835
|
+
"format": "uuid"
|
|
3836
|
+
},
|
|
3837
|
+
"revision": {
|
|
3838
|
+
"type": "integer"
|
|
3839
|
+
},
|
|
3840
|
+
"options": {
|
|
3841
|
+
"type": "array",
|
|
3842
|
+
"maxItems": 50,
|
|
3843
|
+
"items": {
|
|
3844
|
+
"type": "object",
|
|
3845
|
+
"additionalProperties": false,
|
|
3846
|
+
"required": [
|
|
3847
|
+
"meter_id",
|
|
3848
|
+
"counter_id",
|
|
3849
|
+
"meter_number",
|
|
3850
|
+
"label",
|
|
3851
|
+
"unit"
|
|
3852
|
+
],
|
|
3853
|
+
"properties": {
|
|
3854
|
+
"meter_id": {
|
|
3855
|
+
"type": "string"
|
|
3856
|
+
},
|
|
3857
|
+
"counter_id": {
|
|
3858
|
+
"type": "string"
|
|
3859
|
+
},
|
|
3860
|
+
"meter_number": {
|
|
3861
|
+
"type": "string"
|
|
3862
|
+
},
|
|
3863
|
+
"label": {
|
|
3864
|
+
"type": "string"
|
|
3865
|
+
},
|
|
3866
|
+
"unit": {
|
|
3867
|
+
"type": "string"
|
|
3868
|
+
},
|
|
3869
|
+
"min_value": {
|
|
3870
|
+
"type": "number"
|
|
3871
|
+
},
|
|
3872
|
+
"max_value": {
|
|
3873
|
+
"type": "number"
|
|
3874
|
+
}
|
|
3875
|
+
}
|
|
3876
|
+
}
|
|
3877
|
+
},
|
|
3878
|
+
"values": {
|
|
3879
|
+
"type": "object",
|
|
3880
|
+
"additionalProperties": false,
|
|
3881
|
+
"required": [
|
|
3882
|
+
"meter_id",
|
|
3883
|
+
"counter_id",
|
|
3884
|
+
"value"
|
|
3885
|
+
],
|
|
3886
|
+
"properties": {
|
|
3887
|
+
"meter_id": {
|
|
3888
|
+
"type": "string"
|
|
3889
|
+
},
|
|
3890
|
+
"counter_id": {
|
|
3891
|
+
"type": "string"
|
|
3892
|
+
},
|
|
3893
|
+
"value": {
|
|
3894
|
+
"type": "number"
|
|
3895
|
+
}
|
|
3896
|
+
}
|
|
3897
|
+
},
|
|
3898
|
+
"field_error": {
|
|
3899
|
+
"type": "string",
|
|
3900
|
+
"enum": [
|
|
3901
|
+
"VALUE_INVALID",
|
|
3902
|
+
"VALUE_OUT_OF_RANGE",
|
|
3903
|
+
"TARGET_UNAVAILABLE"
|
|
3904
|
+
]
|
|
3905
|
+
},
|
|
3906
|
+
"receipt": {
|
|
3907
|
+
"type": "object",
|
|
3908
|
+
"additionalProperties": false,
|
|
3909
|
+
"required": [
|
|
3910
|
+
"reference",
|
|
3911
|
+
"meter_number",
|
|
3912
|
+
"value",
|
|
3913
|
+
"unit",
|
|
3914
|
+
"submitted_at"
|
|
3915
|
+
],
|
|
3916
|
+
"properties": {
|
|
3917
|
+
"reference": {
|
|
3918
|
+
"type": "string"
|
|
3919
|
+
},
|
|
3920
|
+
"meter_number": {
|
|
3921
|
+
"type": "string"
|
|
3922
|
+
},
|
|
3923
|
+
"value": {
|
|
3924
|
+
"type": "number"
|
|
3925
|
+
},
|
|
3926
|
+
"unit": {
|
|
3927
|
+
"type": "string"
|
|
3928
|
+
},
|
|
3929
|
+
"submitted_at": {
|
|
3930
|
+
"type": "string"
|
|
3931
|
+
}
|
|
3932
|
+
}
|
|
3933
|
+
},
|
|
3934
|
+
"reason": {
|
|
3935
|
+
"type": "string",
|
|
3936
|
+
"enum": [
|
|
3937
|
+
"NO_METERS",
|
|
3938
|
+
"SUBMISSION_REJECTED",
|
|
3939
|
+
"SUBMISSION_UNCERTAIN"
|
|
3940
|
+
]
|
|
3941
|
+
}
|
|
3942
|
+
}
|
|
3943
|
+
}
|
|
3944
|
+
}
|
|
3945
|
+
}
|
|
3946
|
+
},
|
|
3947
|
+
"default": {
|
|
3948
|
+
"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.",
|
|
3949
|
+
"content": {
|
|
3950
|
+
"application/json": {
|
|
3951
|
+
"schema": {
|
|
3952
|
+
"type": "object",
|
|
3953
|
+
"required": [
|
|
3954
|
+
"code"
|
|
3955
|
+
],
|
|
3956
|
+
"properties": {
|
|
3957
|
+
"code": {
|
|
3958
|
+
"type": "string",
|
|
3959
|
+
"enum": [
|
|
3960
|
+
"INVALID_VERIFICATION_CODE",
|
|
3961
|
+
"VERIFICATION_EXPIRED",
|
|
3962
|
+
"VERIFICATION_CONFLICT",
|
|
3963
|
+
"VERIFICATION_DISABLED",
|
|
3964
|
+
"VERIFICATION_UNAVAILABLE",
|
|
3965
|
+
"IDENTITY_CHANGED",
|
|
3966
|
+
"INVALID_REQUEST",
|
|
3967
|
+
"ORIGIN_DENIED",
|
|
3968
|
+
"NOT_FOUND",
|
|
3969
|
+
"INVALID_GRANT",
|
|
3970
|
+
"SESSION_EXPIRED",
|
|
3971
|
+
"RATE_LIMITED",
|
|
3972
|
+
"SESSION_LIMIT",
|
|
3973
|
+
"USAGE_LIMIT",
|
|
3974
|
+
"REQUEST_CONFLICT",
|
|
3975
|
+
"IN_PROGRESS",
|
|
3976
|
+
"UNAVAILABLE",
|
|
3977
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
3978
|
+
"IDENTITY_REQUIRED",
|
|
3979
|
+
"ACTION_UNAVAILABLE",
|
|
3980
|
+
"ACTION_CONFLICT",
|
|
3981
|
+
"ACTION_TARGET_DENIED",
|
|
3982
|
+
"INVALID_LOGIN_CODE",
|
|
3983
|
+
"LOGIN_EXPIRED",
|
|
3984
|
+
"LOGIN_DISABLED",
|
|
3985
|
+
"LOGIN_UNAVAILABLE",
|
|
3986
|
+
"LOGIN_CONFLICT",
|
|
3987
|
+
"LOGIN_REJECTED"
|
|
3988
|
+
]
|
|
3989
|
+
},
|
|
3990
|
+
"attempts_left": {
|
|
3991
|
+
"type": "integer",
|
|
3992
|
+
"minimum": 0,
|
|
3993
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
3994
|
+
}
|
|
3995
|
+
}
|
|
3996
|
+
}
|
|
3997
|
+
}
|
|
3998
|
+
}
|
|
3999
|
+
}
|
|
4000
|
+
}
|
|
4001
|
+
}
|
|
4002
|
+
},
|
|
4003
|
+
"/v1/actions/{action_id}/submit": {
|
|
4004
|
+
"post": {
|
|
4005
|
+
"operationId": "submitChatAction",
|
|
4006
|
+
"security": [
|
|
4007
|
+
{
|
|
4008
|
+
"AnonymousSession": []
|
|
4009
|
+
}
|
|
4010
|
+
],
|
|
4011
|
+
"description": "Prototype. Submit values for review. Targets must be one of the server-offered options; values are validated before confirmation.",
|
|
4012
|
+
"parameters": [
|
|
4013
|
+
{
|
|
4014
|
+
"in": "path",
|
|
4015
|
+
"name": "action_id",
|
|
4016
|
+
"required": true,
|
|
4017
|
+
"schema": {
|
|
4018
|
+
"type": "string",
|
|
4019
|
+
"format": "uuid"
|
|
4020
|
+
}
|
|
4021
|
+
}
|
|
4022
|
+
],
|
|
4023
|
+
"requestBody": {
|
|
4024
|
+
"required": true,
|
|
4025
|
+
"content": {
|
|
4026
|
+
"application/json": {
|
|
4027
|
+
"schema": {
|
|
4028
|
+
"type": "object",
|
|
4029
|
+
"additionalProperties": false,
|
|
4030
|
+
"required": [
|
|
4031
|
+
"expected_revision",
|
|
4032
|
+
"meter_id",
|
|
4033
|
+
"counter_id",
|
|
4034
|
+
"value"
|
|
4035
|
+
],
|
|
4036
|
+
"properties": {
|
|
4037
|
+
"expected_revision": {
|
|
4038
|
+
"type": "integer",
|
|
4039
|
+
"minimum": 1
|
|
4040
|
+
},
|
|
4041
|
+
"meter_id": {
|
|
4042
|
+
"type": "string",
|
|
4043
|
+
"minLength": 1,
|
|
4044
|
+
"maxLength": 100
|
|
4045
|
+
},
|
|
4046
|
+
"counter_id": {
|
|
4047
|
+
"type": "string",
|
|
4048
|
+
"minLength": 1,
|
|
4049
|
+
"maxLength": 100
|
|
4050
|
+
},
|
|
4051
|
+
"value": {
|
|
4052
|
+
"type": "number",
|
|
4053
|
+
"minimum": 0,
|
|
4054
|
+
"maximum": 1000000000000
|
|
4055
|
+
}
|
|
4056
|
+
}
|
|
4057
|
+
}
|
|
4058
|
+
}
|
|
4059
|
+
}
|
|
4060
|
+
},
|
|
4061
|
+
"responses": {
|
|
4062
|
+
"200": {
|
|
4063
|
+
"description": "Input errors or the values awaiting confirmation",
|
|
4064
|
+
"content": {
|
|
4065
|
+
"application/json": {
|
|
4066
|
+
"schema": {
|
|
4067
|
+
"type": "object",
|
|
4068
|
+
"additionalProperties": false,
|
|
4069
|
+
"required": [
|
|
4070
|
+
"conversation_id",
|
|
4071
|
+
"status"
|
|
4072
|
+
],
|
|
4073
|
+
"properties": {
|
|
4074
|
+
"conversation_id": {
|
|
4075
|
+
"type": "string",
|
|
4076
|
+
"format": "uuid"
|
|
4077
|
+
},
|
|
4078
|
+
"status": {
|
|
4079
|
+
"type": "string",
|
|
4080
|
+
"enum": [
|
|
4081
|
+
"none",
|
|
4082
|
+
"needs_input",
|
|
4083
|
+
"needs_confirmation",
|
|
4084
|
+
"executing",
|
|
4085
|
+
"completed",
|
|
4086
|
+
"pending",
|
|
4087
|
+
"rejected",
|
|
4088
|
+
"handoff"
|
|
4089
|
+
]
|
|
4090
|
+
},
|
|
4091
|
+
"action_id": {
|
|
4092
|
+
"type": "string",
|
|
4093
|
+
"format": "uuid"
|
|
4094
|
+
},
|
|
4095
|
+
"revision": {
|
|
4096
|
+
"type": "integer"
|
|
4097
|
+
},
|
|
4098
|
+
"options": {
|
|
4099
|
+
"type": "array",
|
|
4100
|
+
"maxItems": 50,
|
|
4101
|
+
"items": {
|
|
4102
|
+
"type": "object",
|
|
4103
|
+
"additionalProperties": false,
|
|
4104
|
+
"required": [
|
|
4105
|
+
"meter_id",
|
|
4106
|
+
"counter_id",
|
|
4107
|
+
"meter_number",
|
|
4108
|
+
"label",
|
|
4109
|
+
"unit"
|
|
4110
|
+
],
|
|
4111
|
+
"properties": {
|
|
4112
|
+
"meter_id": {
|
|
4113
|
+
"type": "string"
|
|
4114
|
+
},
|
|
4115
|
+
"counter_id": {
|
|
4116
|
+
"type": "string"
|
|
4117
|
+
},
|
|
4118
|
+
"meter_number": {
|
|
4119
|
+
"type": "string"
|
|
4120
|
+
},
|
|
4121
|
+
"label": {
|
|
4122
|
+
"type": "string"
|
|
4123
|
+
},
|
|
4124
|
+
"unit": {
|
|
4125
|
+
"type": "string"
|
|
4126
|
+
},
|
|
4127
|
+
"min_value": {
|
|
4128
|
+
"type": "number"
|
|
4129
|
+
},
|
|
4130
|
+
"max_value": {
|
|
4131
|
+
"type": "number"
|
|
4132
|
+
}
|
|
4133
|
+
}
|
|
4134
|
+
}
|
|
4135
|
+
},
|
|
4136
|
+
"values": {
|
|
4137
|
+
"type": "object",
|
|
4138
|
+
"additionalProperties": false,
|
|
4139
|
+
"required": [
|
|
4140
|
+
"meter_id",
|
|
4141
|
+
"counter_id",
|
|
4142
|
+
"value"
|
|
4143
|
+
],
|
|
4144
|
+
"properties": {
|
|
4145
|
+
"meter_id": {
|
|
4146
|
+
"type": "string"
|
|
4147
|
+
},
|
|
4148
|
+
"counter_id": {
|
|
4149
|
+
"type": "string"
|
|
4150
|
+
},
|
|
4151
|
+
"value": {
|
|
4152
|
+
"type": "number"
|
|
4153
|
+
}
|
|
4154
|
+
}
|
|
4155
|
+
},
|
|
4156
|
+
"field_error": {
|
|
4157
|
+
"type": "string",
|
|
4158
|
+
"enum": [
|
|
4159
|
+
"VALUE_INVALID",
|
|
4160
|
+
"VALUE_OUT_OF_RANGE",
|
|
4161
|
+
"TARGET_UNAVAILABLE"
|
|
4162
|
+
]
|
|
4163
|
+
},
|
|
4164
|
+
"receipt": {
|
|
4165
|
+
"type": "object",
|
|
4166
|
+
"additionalProperties": false,
|
|
4167
|
+
"required": [
|
|
4168
|
+
"reference",
|
|
4169
|
+
"meter_number",
|
|
4170
|
+
"value",
|
|
4171
|
+
"unit",
|
|
4172
|
+
"submitted_at"
|
|
4173
|
+
],
|
|
4174
|
+
"properties": {
|
|
4175
|
+
"reference": {
|
|
4176
|
+
"type": "string"
|
|
4177
|
+
},
|
|
4178
|
+
"meter_number": {
|
|
4179
|
+
"type": "string"
|
|
4180
|
+
},
|
|
4181
|
+
"value": {
|
|
4182
|
+
"type": "number"
|
|
4183
|
+
},
|
|
4184
|
+
"unit": {
|
|
4185
|
+
"type": "string"
|
|
4186
|
+
},
|
|
4187
|
+
"submitted_at": {
|
|
4188
|
+
"type": "string"
|
|
4189
|
+
}
|
|
4190
|
+
}
|
|
4191
|
+
},
|
|
4192
|
+
"reason": {
|
|
4193
|
+
"type": "string",
|
|
4194
|
+
"enum": [
|
|
4195
|
+
"NO_METERS",
|
|
4196
|
+
"SUBMISSION_REJECTED",
|
|
4197
|
+
"SUBMISSION_UNCERTAIN"
|
|
4198
|
+
]
|
|
4199
|
+
}
|
|
4200
|
+
}
|
|
4201
|
+
}
|
|
4202
|
+
}
|
|
4203
|
+
}
|
|
4204
|
+
},
|
|
4205
|
+
"default": {
|
|
4206
|
+
"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.",
|
|
4207
|
+
"content": {
|
|
4208
|
+
"application/json": {
|
|
4209
|
+
"schema": {
|
|
4210
|
+
"type": "object",
|
|
4211
|
+
"required": [
|
|
4212
|
+
"code"
|
|
4213
|
+
],
|
|
4214
|
+
"properties": {
|
|
4215
|
+
"code": {
|
|
4216
|
+
"type": "string",
|
|
4217
|
+
"enum": [
|
|
4218
|
+
"INVALID_VERIFICATION_CODE",
|
|
4219
|
+
"VERIFICATION_EXPIRED",
|
|
4220
|
+
"VERIFICATION_CONFLICT",
|
|
4221
|
+
"VERIFICATION_DISABLED",
|
|
4222
|
+
"VERIFICATION_UNAVAILABLE",
|
|
4223
|
+
"IDENTITY_CHANGED",
|
|
4224
|
+
"INVALID_REQUEST",
|
|
4225
|
+
"ORIGIN_DENIED",
|
|
4226
|
+
"NOT_FOUND",
|
|
4227
|
+
"INVALID_GRANT",
|
|
4228
|
+
"SESSION_EXPIRED",
|
|
4229
|
+
"RATE_LIMITED",
|
|
4230
|
+
"SESSION_LIMIT",
|
|
4231
|
+
"USAGE_LIMIT",
|
|
4232
|
+
"REQUEST_CONFLICT",
|
|
4233
|
+
"IN_PROGRESS",
|
|
4234
|
+
"UNAVAILABLE",
|
|
4235
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
4236
|
+
"IDENTITY_REQUIRED",
|
|
4237
|
+
"ACTION_UNAVAILABLE",
|
|
4238
|
+
"ACTION_CONFLICT",
|
|
4239
|
+
"ACTION_TARGET_DENIED",
|
|
4240
|
+
"INVALID_LOGIN_CODE",
|
|
4241
|
+
"LOGIN_EXPIRED",
|
|
4242
|
+
"LOGIN_DISABLED",
|
|
4243
|
+
"LOGIN_UNAVAILABLE",
|
|
4244
|
+
"LOGIN_CONFLICT",
|
|
4245
|
+
"LOGIN_REJECTED"
|
|
4246
|
+
]
|
|
4247
|
+
},
|
|
4248
|
+
"attempts_left": {
|
|
4249
|
+
"type": "integer",
|
|
4250
|
+
"minimum": 0,
|
|
4251
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
4252
|
+
}
|
|
4253
|
+
}
|
|
4254
|
+
}
|
|
4255
|
+
}
|
|
4256
|
+
}
|
|
4257
|
+
}
|
|
4258
|
+
}
|
|
4259
|
+
}
|
|
4260
|
+
},
|
|
4261
|
+
"/v1/actions/{action_id}/confirm": {
|
|
4262
|
+
"post": {
|
|
4263
|
+
"operationId": "confirmChatAction",
|
|
4264
|
+
"security": [
|
|
4265
|
+
{
|
|
4266
|
+
"AnonymousSession": []
|
|
4267
|
+
}
|
|
4268
|
+
],
|
|
4269
|
+
"description": "Prototype. Execute the confirmed values once. Ownership is checked again before the domain write. Repeating a completed confirmation returns the same receipt.",
|
|
4270
|
+
"parameters": [
|
|
4271
|
+
{
|
|
4272
|
+
"in": "path",
|
|
4273
|
+
"name": "action_id",
|
|
4274
|
+
"required": true,
|
|
4275
|
+
"schema": {
|
|
4276
|
+
"type": "string",
|
|
4277
|
+
"format": "uuid"
|
|
4278
|
+
}
|
|
4279
|
+
}
|
|
4280
|
+
],
|
|
4281
|
+
"requestBody": {
|
|
4282
|
+
"required": true,
|
|
4283
|
+
"content": {
|
|
4284
|
+
"application/json": {
|
|
4285
|
+
"schema": {
|
|
4286
|
+
"type": "object",
|
|
4287
|
+
"additionalProperties": false,
|
|
4288
|
+
"required": [
|
|
4289
|
+
"expected_revision"
|
|
4290
|
+
],
|
|
4291
|
+
"properties": {
|
|
4292
|
+
"expected_revision": {
|
|
4293
|
+
"type": "integer",
|
|
4294
|
+
"minimum": 1
|
|
4295
|
+
}
|
|
4296
|
+
}
|
|
4297
|
+
}
|
|
4298
|
+
}
|
|
4299
|
+
}
|
|
4300
|
+
},
|
|
4301
|
+
"responses": {
|
|
4302
|
+
"200": {
|
|
4303
|
+
"description": "Completed, pending or rejected action",
|
|
4304
|
+
"content": {
|
|
4305
|
+
"application/json": {
|
|
4306
|
+
"schema": {
|
|
4307
|
+
"type": "object",
|
|
4308
|
+
"additionalProperties": false,
|
|
4309
|
+
"required": [
|
|
4310
|
+
"conversation_id",
|
|
4311
|
+
"status"
|
|
4312
|
+
],
|
|
4313
|
+
"properties": {
|
|
4314
|
+
"conversation_id": {
|
|
4315
|
+
"type": "string",
|
|
4316
|
+
"format": "uuid"
|
|
4317
|
+
},
|
|
4318
|
+
"status": {
|
|
4319
|
+
"type": "string",
|
|
4320
|
+
"enum": [
|
|
4321
|
+
"none",
|
|
4322
|
+
"needs_input",
|
|
4323
|
+
"needs_confirmation",
|
|
4324
|
+
"executing",
|
|
4325
|
+
"completed",
|
|
4326
|
+
"pending",
|
|
4327
|
+
"rejected",
|
|
4328
|
+
"handoff"
|
|
4329
|
+
]
|
|
4330
|
+
},
|
|
4331
|
+
"action_id": {
|
|
4332
|
+
"type": "string",
|
|
4333
|
+
"format": "uuid"
|
|
4334
|
+
},
|
|
4335
|
+
"revision": {
|
|
4336
|
+
"type": "integer"
|
|
4337
|
+
},
|
|
4338
|
+
"options": {
|
|
4339
|
+
"type": "array",
|
|
4340
|
+
"maxItems": 50,
|
|
4341
|
+
"items": {
|
|
4342
|
+
"type": "object",
|
|
4343
|
+
"additionalProperties": false,
|
|
4344
|
+
"required": [
|
|
4345
|
+
"meter_id",
|
|
4346
|
+
"counter_id",
|
|
4347
|
+
"meter_number",
|
|
4348
|
+
"label",
|
|
4349
|
+
"unit"
|
|
4350
|
+
],
|
|
4351
|
+
"properties": {
|
|
4352
|
+
"meter_id": {
|
|
4353
|
+
"type": "string"
|
|
4354
|
+
},
|
|
4355
|
+
"counter_id": {
|
|
4356
|
+
"type": "string"
|
|
4357
|
+
},
|
|
4358
|
+
"meter_number": {
|
|
4359
|
+
"type": "string"
|
|
4360
|
+
},
|
|
4361
|
+
"label": {
|
|
4362
|
+
"type": "string"
|
|
4363
|
+
},
|
|
4364
|
+
"unit": {
|
|
4365
|
+
"type": "string"
|
|
4366
|
+
},
|
|
4367
|
+
"min_value": {
|
|
4368
|
+
"type": "number"
|
|
4369
|
+
},
|
|
4370
|
+
"max_value": {
|
|
4371
|
+
"type": "number"
|
|
4372
|
+
}
|
|
4373
|
+
}
|
|
4374
|
+
}
|
|
4375
|
+
},
|
|
4376
|
+
"values": {
|
|
4377
|
+
"type": "object",
|
|
4378
|
+
"additionalProperties": false,
|
|
4379
|
+
"required": [
|
|
4380
|
+
"meter_id",
|
|
4381
|
+
"counter_id",
|
|
4382
|
+
"value"
|
|
4383
|
+
],
|
|
4384
|
+
"properties": {
|
|
4385
|
+
"meter_id": {
|
|
4386
|
+
"type": "string"
|
|
4387
|
+
},
|
|
4388
|
+
"counter_id": {
|
|
4389
|
+
"type": "string"
|
|
4390
|
+
},
|
|
4391
|
+
"value": {
|
|
4392
|
+
"type": "number"
|
|
4393
|
+
}
|
|
4394
|
+
}
|
|
4395
|
+
},
|
|
4396
|
+
"field_error": {
|
|
4397
|
+
"type": "string",
|
|
4398
|
+
"enum": [
|
|
4399
|
+
"VALUE_INVALID",
|
|
4400
|
+
"VALUE_OUT_OF_RANGE",
|
|
4401
|
+
"TARGET_UNAVAILABLE"
|
|
4402
|
+
]
|
|
4403
|
+
},
|
|
4404
|
+
"receipt": {
|
|
4405
|
+
"type": "object",
|
|
4406
|
+
"additionalProperties": false,
|
|
4407
|
+
"required": [
|
|
4408
|
+
"reference",
|
|
4409
|
+
"meter_number",
|
|
4410
|
+
"value",
|
|
4411
|
+
"unit",
|
|
4412
|
+
"submitted_at"
|
|
4413
|
+
],
|
|
4414
|
+
"properties": {
|
|
4415
|
+
"reference": {
|
|
4416
|
+
"type": "string"
|
|
4417
|
+
},
|
|
4418
|
+
"meter_number": {
|
|
4419
|
+
"type": "string"
|
|
4420
|
+
},
|
|
4421
|
+
"value": {
|
|
4422
|
+
"type": "number"
|
|
4423
|
+
},
|
|
4424
|
+
"unit": {
|
|
4425
|
+
"type": "string"
|
|
4426
|
+
},
|
|
4427
|
+
"submitted_at": {
|
|
4428
|
+
"type": "string"
|
|
4429
|
+
}
|
|
4430
|
+
}
|
|
4431
|
+
},
|
|
4432
|
+
"reason": {
|
|
4433
|
+
"type": "string",
|
|
4434
|
+
"enum": [
|
|
4435
|
+
"NO_METERS",
|
|
4436
|
+
"SUBMISSION_REJECTED",
|
|
4437
|
+
"SUBMISSION_UNCERTAIN"
|
|
4438
|
+
]
|
|
4439
|
+
}
|
|
4440
|
+
}
|
|
4441
|
+
}
|
|
4442
|
+
}
|
|
4443
|
+
}
|
|
4444
|
+
},
|
|
4445
|
+
"default": {
|
|
4446
|
+
"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.",
|
|
4447
|
+
"content": {
|
|
4448
|
+
"application/json": {
|
|
4449
|
+
"schema": {
|
|
4450
|
+
"type": "object",
|
|
4451
|
+
"required": [
|
|
4452
|
+
"code"
|
|
4453
|
+
],
|
|
4454
|
+
"properties": {
|
|
4455
|
+
"code": {
|
|
4456
|
+
"type": "string",
|
|
4457
|
+
"enum": [
|
|
4458
|
+
"INVALID_VERIFICATION_CODE",
|
|
4459
|
+
"VERIFICATION_EXPIRED",
|
|
4460
|
+
"VERIFICATION_CONFLICT",
|
|
4461
|
+
"VERIFICATION_DISABLED",
|
|
4462
|
+
"VERIFICATION_UNAVAILABLE",
|
|
4463
|
+
"IDENTITY_CHANGED",
|
|
4464
|
+
"INVALID_REQUEST",
|
|
4465
|
+
"ORIGIN_DENIED",
|
|
4466
|
+
"NOT_FOUND",
|
|
4467
|
+
"INVALID_GRANT",
|
|
4468
|
+
"SESSION_EXPIRED",
|
|
4469
|
+
"RATE_LIMITED",
|
|
4470
|
+
"SESSION_LIMIT",
|
|
4471
|
+
"USAGE_LIMIT",
|
|
4472
|
+
"REQUEST_CONFLICT",
|
|
4473
|
+
"IN_PROGRESS",
|
|
4474
|
+
"UNAVAILABLE",
|
|
4475
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
4476
|
+
"IDENTITY_REQUIRED",
|
|
4477
|
+
"ACTION_UNAVAILABLE",
|
|
4478
|
+
"ACTION_CONFLICT",
|
|
4479
|
+
"ACTION_TARGET_DENIED",
|
|
4480
|
+
"INVALID_LOGIN_CODE",
|
|
4481
|
+
"LOGIN_EXPIRED",
|
|
4482
|
+
"LOGIN_DISABLED",
|
|
4483
|
+
"LOGIN_UNAVAILABLE",
|
|
4484
|
+
"LOGIN_CONFLICT",
|
|
4485
|
+
"LOGIN_REJECTED"
|
|
4486
|
+
]
|
|
4487
|
+
},
|
|
4488
|
+
"attempts_left": {
|
|
4489
|
+
"type": "integer",
|
|
4490
|
+
"minimum": 0,
|
|
4491
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
4492
|
+
}
|
|
4493
|
+
}
|
|
4494
|
+
}
|
|
4495
|
+
}
|
|
4496
|
+
}
|
|
4497
|
+
}
|
|
4498
|
+
}
|
|
4499
|
+
}
|
|
4500
|
+
},
|
|
4501
|
+
"/v1/actions/{action_id}/cancel": {
|
|
4502
|
+
"post": {
|
|
4503
|
+
"operationId": "cancelChatAction",
|
|
4504
|
+
"security": [
|
|
4505
|
+
{
|
|
4506
|
+
"AnonymousSession": []
|
|
4507
|
+
}
|
|
4508
|
+
],
|
|
4509
|
+
"description": "Prototype. Cancel an unfinished action.",
|
|
4510
|
+
"parameters": [
|
|
4511
|
+
{
|
|
4512
|
+
"in": "path",
|
|
4513
|
+
"name": "action_id",
|
|
4514
|
+
"required": true,
|
|
4515
|
+
"schema": {
|
|
4516
|
+
"type": "string",
|
|
4517
|
+
"format": "uuid"
|
|
4518
|
+
}
|
|
4519
|
+
}
|
|
4520
|
+
],
|
|
4521
|
+
"requestBody": {
|
|
4522
|
+
"required": true,
|
|
4523
|
+
"content": {
|
|
4524
|
+
"application/json": {
|
|
4525
|
+
"schema": {
|
|
4526
|
+
"type": "object",
|
|
4527
|
+
"additionalProperties": false,
|
|
4528
|
+
"required": [
|
|
4529
|
+
"expected_revision"
|
|
4530
|
+
],
|
|
4531
|
+
"properties": {
|
|
4532
|
+
"expected_revision": {
|
|
4533
|
+
"type": "integer",
|
|
4534
|
+
"minimum": 1
|
|
4535
|
+
}
|
|
4536
|
+
}
|
|
4537
|
+
}
|
|
4538
|
+
}
|
|
4539
|
+
}
|
|
4540
|
+
},
|
|
4541
|
+
"responses": {
|
|
4542
|
+
"200": {
|
|
4543
|
+
"description": "No current action",
|
|
4544
|
+
"content": {
|
|
4545
|
+
"application/json": {
|
|
4546
|
+
"schema": {
|
|
4547
|
+
"type": "object",
|
|
4548
|
+
"additionalProperties": false,
|
|
4549
|
+
"required": [
|
|
4550
|
+
"conversation_id",
|
|
4551
|
+
"status"
|
|
4552
|
+
],
|
|
4553
|
+
"properties": {
|
|
4554
|
+
"conversation_id": {
|
|
4555
|
+
"type": "string",
|
|
4556
|
+
"format": "uuid"
|
|
4557
|
+
},
|
|
4558
|
+
"status": {
|
|
4559
|
+
"type": "string",
|
|
4560
|
+
"enum": [
|
|
4561
|
+
"none",
|
|
4562
|
+
"needs_input",
|
|
4563
|
+
"needs_confirmation",
|
|
4564
|
+
"executing",
|
|
4565
|
+
"completed",
|
|
4566
|
+
"pending",
|
|
4567
|
+
"rejected",
|
|
4568
|
+
"handoff"
|
|
4569
|
+
]
|
|
4570
|
+
},
|
|
4571
|
+
"action_id": {
|
|
4572
|
+
"type": "string",
|
|
4573
|
+
"format": "uuid"
|
|
4574
|
+
},
|
|
4575
|
+
"revision": {
|
|
4576
|
+
"type": "integer"
|
|
4577
|
+
},
|
|
4578
|
+
"options": {
|
|
4579
|
+
"type": "array",
|
|
4580
|
+
"maxItems": 50,
|
|
4581
|
+
"items": {
|
|
4582
|
+
"type": "object",
|
|
4583
|
+
"additionalProperties": false,
|
|
4584
|
+
"required": [
|
|
4585
|
+
"meter_id",
|
|
4586
|
+
"counter_id",
|
|
4587
|
+
"meter_number",
|
|
4588
|
+
"label",
|
|
4589
|
+
"unit"
|
|
4590
|
+
],
|
|
4591
|
+
"properties": {
|
|
4592
|
+
"meter_id": {
|
|
4593
|
+
"type": "string"
|
|
4594
|
+
},
|
|
4595
|
+
"counter_id": {
|
|
4596
|
+
"type": "string"
|
|
4597
|
+
},
|
|
4598
|
+
"meter_number": {
|
|
4599
|
+
"type": "string"
|
|
4600
|
+
},
|
|
4601
|
+
"label": {
|
|
4602
|
+
"type": "string"
|
|
4603
|
+
},
|
|
4604
|
+
"unit": {
|
|
4605
|
+
"type": "string"
|
|
4606
|
+
},
|
|
4607
|
+
"min_value": {
|
|
4608
|
+
"type": "number"
|
|
4609
|
+
},
|
|
4610
|
+
"max_value": {
|
|
4611
|
+
"type": "number"
|
|
4612
|
+
}
|
|
4613
|
+
}
|
|
4614
|
+
}
|
|
4615
|
+
},
|
|
4616
|
+
"values": {
|
|
4617
|
+
"type": "object",
|
|
4618
|
+
"additionalProperties": false,
|
|
4619
|
+
"required": [
|
|
4620
|
+
"meter_id",
|
|
4621
|
+
"counter_id",
|
|
4622
|
+
"value"
|
|
4623
|
+
],
|
|
4624
|
+
"properties": {
|
|
4625
|
+
"meter_id": {
|
|
4626
|
+
"type": "string"
|
|
4627
|
+
},
|
|
4628
|
+
"counter_id": {
|
|
4629
|
+
"type": "string"
|
|
4630
|
+
},
|
|
4631
|
+
"value": {
|
|
4632
|
+
"type": "number"
|
|
4633
|
+
}
|
|
4634
|
+
}
|
|
4635
|
+
},
|
|
4636
|
+
"field_error": {
|
|
4637
|
+
"type": "string",
|
|
4638
|
+
"enum": [
|
|
4639
|
+
"VALUE_INVALID",
|
|
4640
|
+
"VALUE_OUT_OF_RANGE",
|
|
4641
|
+
"TARGET_UNAVAILABLE"
|
|
4642
|
+
]
|
|
4643
|
+
},
|
|
4644
|
+
"receipt": {
|
|
4645
|
+
"type": "object",
|
|
4646
|
+
"additionalProperties": false,
|
|
4647
|
+
"required": [
|
|
4648
|
+
"reference",
|
|
4649
|
+
"meter_number",
|
|
4650
|
+
"value",
|
|
4651
|
+
"unit",
|
|
4652
|
+
"submitted_at"
|
|
4653
|
+
],
|
|
4654
|
+
"properties": {
|
|
4655
|
+
"reference": {
|
|
4656
|
+
"type": "string"
|
|
4657
|
+
},
|
|
4658
|
+
"meter_number": {
|
|
4659
|
+
"type": "string"
|
|
4660
|
+
},
|
|
4661
|
+
"value": {
|
|
4662
|
+
"type": "number"
|
|
4663
|
+
},
|
|
4664
|
+
"unit": {
|
|
4665
|
+
"type": "string"
|
|
4666
|
+
},
|
|
4667
|
+
"submitted_at": {
|
|
4668
|
+
"type": "string"
|
|
4669
|
+
}
|
|
4670
|
+
}
|
|
4671
|
+
},
|
|
4672
|
+
"reason": {
|
|
4673
|
+
"type": "string",
|
|
4674
|
+
"enum": [
|
|
4675
|
+
"NO_METERS",
|
|
4676
|
+
"SUBMISSION_REJECTED",
|
|
4677
|
+
"SUBMISSION_UNCERTAIN"
|
|
4678
|
+
]
|
|
4679
|
+
}
|
|
4680
|
+
}
|
|
4681
|
+
}
|
|
4682
|
+
}
|
|
4683
|
+
}
|
|
4684
|
+
},
|
|
4685
|
+
"default": {
|
|
4686
|
+
"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.",
|
|
4687
|
+
"content": {
|
|
4688
|
+
"application/json": {
|
|
4689
|
+
"schema": {
|
|
4690
|
+
"type": "object",
|
|
4691
|
+
"required": [
|
|
4692
|
+
"code"
|
|
4693
|
+
],
|
|
4694
|
+
"properties": {
|
|
4695
|
+
"code": {
|
|
4696
|
+
"type": "string",
|
|
4697
|
+
"enum": [
|
|
4698
|
+
"INVALID_VERIFICATION_CODE",
|
|
4699
|
+
"VERIFICATION_EXPIRED",
|
|
4700
|
+
"VERIFICATION_CONFLICT",
|
|
4701
|
+
"VERIFICATION_DISABLED",
|
|
4702
|
+
"VERIFICATION_UNAVAILABLE",
|
|
4703
|
+
"IDENTITY_CHANGED",
|
|
4704
|
+
"INVALID_REQUEST",
|
|
4705
|
+
"ORIGIN_DENIED",
|
|
4706
|
+
"NOT_FOUND",
|
|
4707
|
+
"INVALID_GRANT",
|
|
4708
|
+
"SESSION_EXPIRED",
|
|
4709
|
+
"RATE_LIMITED",
|
|
4710
|
+
"SESSION_LIMIT",
|
|
4711
|
+
"USAGE_LIMIT",
|
|
4712
|
+
"REQUEST_CONFLICT",
|
|
4713
|
+
"IN_PROGRESS",
|
|
4714
|
+
"UNAVAILABLE",
|
|
4715
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
4716
|
+
"IDENTITY_REQUIRED",
|
|
4717
|
+
"ACTION_UNAVAILABLE",
|
|
4718
|
+
"ACTION_CONFLICT",
|
|
4719
|
+
"ACTION_TARGET_DENIED",
|
|
4720
|
+
"INVALID_LOGIN_CODE",
|
|
4721
|
+
"LOGIN_EXPIRED",
|
|
4722
|
+
"LOGIN_DISABLED",
|
|
4723
|
+
"LOGIN_UNAVAILABLE",
|
|
4724
|
+
"LOGIN_CONFLICT",
|
|
4725
|
+
"LOGIN_REJECTED"
|
|
4726
|
+
]
|
|
4727
|
+
},
|
|
4728
|
+
"attempts_left": {
|
|
4729
|
+
"type": "integer",
|
|
4730
|
+
"minimum": 0,
|
|
4731
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
4732
|
+
}
|
|
4733
|
+
}
|
|
4734
|
+
}
|
|
4735
|
+
}
|
|
4736
|
+
}
|
|
4737
|
+
}
|
|
4738
|
+
}
|
|
4739
|
+
}
|
|
4740
|
+
}
|
|
4741
|
+
},
|
|
4742
|
+
"components": {
|
|
4743
|
+
"securitySchemes": {
|
|
4744
|
+
"EpilotAuth": {
|
|
4745
|
+
"type": "http",
|
|
4746
|
+
"scheme": "bearer"
|
|
4747
|
+
},
|
|
4748
|
+
"AnonymousSession": {
|
|
4749
|
+
"type": "http",
|
|
4750
|
+
"scheme": "bearer",
|
|
4751
|
+
"description": "Opaque, expiring Chat session token; never an epilot user or Portal access token."
|
|
4752
|
+
}
|
|
4753
|
+
},
|
|
4754
|
+
"schemas": {
|
|
4755
|
+
"ListWebsiteChatsResponse": {
|
|
4756
|
+
"type": "object",
|
|
4757
|
+
"required": [
|
|
4758
|
+
"website_chats"
|
|
4759
|
+
],
|
|
4760
|
+
"properties": {
|
|
4761
|
+
"website_chats": {
|
|
4762
|
+
"type": "array",
|
|
4763
|
+
"items": {
|
|
4764
|
+
"type": "object",
|
|
4765
|
+
"required": [
|
|
4766
|
+
"website_chat_id",
|
|
4767
|
+
"org_id",
|
|
4768
|
+
"agent_id",
|
|
4769
|
+
"binding_id",
|
|
4770
|
+
"version",
|
|
4771
|
+
"name",
|
|
4772
|
+
"settings",
|
|
4773
|
+
"embed",
|
|
4774
|
+
"created_at",
|
|
4775
|
+
"updated_at"
|
|
4776
|
+
],
|
|
4777
|
+
"properties": {
|
|
4778
|
+
"name": {
|
|
4779
|
+
"type": "string",
|
|
4780
|
+
"minLength": 1,
|
|
4781
|
+
"maxLength": 100
|
|
4782
|
+
},
|
|
4783
|
+
"agent_id": {
|
|
4784
|
+
"type": "string",
|
|
4785
|
+
"format": "uuid",
|
|
4786
|
+
"nullable": true
|
|
4787
|
+
},
|
|
4788
|
+
"settings": {
|
|
4789
|
+
"type": "object",
|
|
4790
|
+
"additionalProperties": false,
|
|
4791
|
+
"required": [
|
|
4792
|
+
"allowed_origins",
|
|
4793
|
+
"organisation_name",
|
|
4794
|
+
"default_locale"
|
|
4795
|
+
],
|
|
4796
|
+
"properties": {
|
|
4797
|
+
"allowed_origins": {
|
|
4798
|
+
"type": "array",
|
|
4799
|
+
"maxItems": 50,
|
|
4800
|
+
"uniqueItems": true,
|
|
4801
|
+
"description": "Exact HTTPS origins. Empty means the Website Chat cannot start sessions.",
|
|
4802
|
+
"items": {
|
|
4803
|
+
"type": "string",
|
|
4804
|
+
"maxLength": 2048
|
|
4805
|
+
}
|
|
4806
|
+
},
|
|
4807
|
+
"organisation_name": {
|
|
4808
|
+
"type": "string",
|
|
4809
|
+
"minLength": 1,
|
|
4810
|
+
"maxLength": 100
|
|
4811
|
+
},
|
|
4812
|
+
"default_locale": {
|
|
4813
|
+
"type": "string",
|
|
4814
|
+
"enum": [
|
|
4815
|
+
"en",
|
|
4816
|
+
"de"
|
|
4817
|
+
]
|
|
4818
|
+
},
|
|
4819
|
+
"design_id": {
|
|
4820
|
+
"type": "string",
|
|
4821
|
+
"format": "uuid",
|
|
4822
|
+
"nullable": true,
|
|
4823
|
+
"description": "Design Builder configuration for the Website Chat only."
|
|
4824
|
+
},
|
|
4825
|
+
"authentication": {
|
|
2539
4826
|
"type": "object",
|
|
2540
4827
|
"additionalProperties": false,
|
|
2541
4828
|
"properties": {
|
|
2542
4829
|
"email_code": {
|
|
2543
4830
|
"type": "object",
|
|
2544
4831
|
"additionalProperties": false,
|
|
4832
|
+
"nullable": true,
|
|
4833
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
4834
|
+
"properties": {
|
|
4835
|
+
"email_template_id": {
|
|
4836
|
+
"type": "string",
|
|
4837
|
+
"format": "uuid",
|
|
4838
|
+
"nullable": true
|
|
4839
|
+
}
|
|
4840
|
+
}
|
|
4841
|
+
},
|
|
4842
|
+
"portal": {
|
|
4843
|
+
"type": "object",
|
|
4844
|
+
"additionalProperties": false,
|
|
4845
|
+
"nullable": true,
|
|
4846
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
4847
|
+
"required": [
|
|
4848
|
+
"portal_id"
|
|
4849
|
+
],
|
|
2545
4850
|
"properties": {
|
|
2546
|
-
"
|
|
4851
|
+
"portal_id": {
|
|
2547
4852
|
"type": "string",
|
|
2548
|
-
"format": "uuid"
|
|
2549
|
-
"nullable": true
|
|
4853
|
+
"format": "uuid"
|
|
2550
4854
|
}
|
|
2551
4855
|
}
|
|
2552
4856
|
}
|
|
2553
4857
|
},
|
|
2554
4858
|
"nullable": true,
|
|
2555
|
-
"description": "
|
|
2556
|
-
"required": [
|
|
2557
|
-
"email_code"
|
|
2558
|
-
]
|
|
4859
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
2559
4860
|
}
|
|
2560
4861
|
}
|
|
2561
4862
|
},
|
|
@@ -2690,6 +4991,8 @@
|
|
|
2690
4991
|
"email_code": {
|
|
2691
4992
|
"type": "object",
|
|
2692
4993
|
"additionalProperties": false,
|
|
4994
|
+
"nullable": true,
|
|
4995
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
2693
4996
|
"properties": {
|
|
2694
4997
|
"email_template_id": {
|
|
2695
4998
|
"type": "string",
|
|
@@ -2697,13 +5000,25 @@
|
|
|
2697
5000
|
"nullable": true
|
|
2698
5001
|
}
|
|
2699
5002
|
}
|
|
5003
|
+
},
|
|
5004
|
+
"portal": {
|
|
5005
|
+
"type": "object",
|
|
5006
|
+
"additionalProperties": false,
|
|
5007
|
+
"nullable": true,
|
|
5008
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
5009
|
+
"required": [
|
|
5010
|
+
"portal_id"
|
|
5011
|
+
],
|
|
5012
|
+
"properties": {
|
|
5013
|
+
"portal_id": {
|
|
5014
|
+
"type": "string",
|
|
5015
|
+
"format": "uuid"
|
|
5016
|
+
}
|
|
5017
|
+
}
|
|
2700
5018
|
}
|
|
2701
5019
|
},
|
|
2702
5020
|
"nullable": true,
|
|
2703
|
-
"description": "
|
|
2704
|
-
"required": [
|
|
2705
|
-
"email_code"
|
|
2706
|
-
]
|
|
5021
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
2707
5022
|
}
|
|
2708
5023
|
}
|
|
2709
5024
|
},
|
|
@@ -2807,6 +5122,8 @@
|
|
|
2807
5122
|
"email_code": {
|
|
2808
5123
|
"type": "object",
|
|
2809
5124
|
"additionalProperties": false,
|
|
5125
|
+
"nullable": true,
|
|
5126
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
2810
5127
|
"properties": {
|
|
2811
5128
|
"email_template_id": {
|
|
2812
5129
|
"type": "string",
|
|
@@ -2814,13 +5131,25 @@
|
|
|
2814
5131
|
"nullable": true
|
|
2815
5132
|
}
|
|
2816
5133
|
}
|
|
5134
|
+
},
|
|
5135
|
+
"portal": {
|
|
5136
|
+
"type": "object",
|
|
5137
|
+
"additionalProperties": false,
|
|
5138
|
+
"nullable": true,
|
|
5139
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
5140
|
+
"required": [
|
|
5141
|
+
"portal_id"
|
|
5142
|
+
],
|
|
5143
|
+
"properties": {
|
|
5144
|
+
"portal_id": {
|
|
5145
|
+
"type": "string",
|
|
5146
|
+
"format": "uuid"
|
|
5147
|
+
}
|
|
5148
|
+
}
|
|
2817
5149
|
}
|
|
2818
5150
|
},
|
|
2819
5151
|
"nullable": true,
|
|
2820
|
-
"description": "
|
|
2821
|
-
"required": [
|
|
2822
|
-
"email_code"
|
|
2823
|
-
]
|
|
5152
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
2824
5153
|
}
|
|
2825
5154
|
}
|
|
2826
5155
|
},
|
|
@@ -2901,6 +5230,8 @@
|
|
|
2901
5230
|
"email_code": {
|
|
2902
5231
|
"type": "object",
|
|
2903
5232
|
"additionalProperties": false,
|
|
5233
|
+
"nullable": true,
|
|
5234
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
2904
5235
|
"properties": {
|
|
2905
5236
|
"email_template_id": {
|
|
2906
5237
|
"type": "string",
|
|
@@ -2908,13 +5239,25 @@
|
|
|
2908
5239
|
"nullable": true
|
|
2909
5240
|
}
|
|
2910
5241
|
}
|
|
5242
|
+
},
|
|
5243
|
+
"portal": {
|
|
5244
|
+
"type": "object",
|
|
5245
|
+
"additionalProperties": false,
|
|
5246
|
+
"nullable": true,
|
|
5247
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
5248
|
+
"required": [
|
|
5249
|
+
"portal_id"
|
|
5250
|
+
],
|
|
5251
|
+
"properties": {
|
|
5252
|
+
"portal_id": {
|
|
5253
|
+
"type": "string",
|
|
5254
|
+
"format": "uuid"
|
|
5255
|
+
}
|
|
5256
|
+
}
|
|
2911
5257
|
}
|
|
2912
5258
|
},
|
|
2913
5259
|
"nullable": true,
|
|
2914
|
-
"description": "
|
|
2915
|
-
"required": [
|
|
2916
|
-
"email_code"
|
|
2917
|
-
]
|
|
5260
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
2918
5261
|
}
|
|
2919
5262
|
}
|
|
2920
5263
|
}
|
|
@@ -2981,6 +5324,8 @@
|
|
|
2981
5324
|
"email_code": {
|
|
2982
5325
|
"type": "object",
|
|
2983
5326
|
"additionalProperties": false,
|
|
5327
|
+
"nullable": true,
|
|
5328
|
+
"description": "Email code verification. On update, omit to keep the current setting or send null to remove it.",
|
|
2984
5329
|
"properties": {
|
|
2985
5330
|
"email_template_id": {
|
|
2986
5331
|
"type": "string",
|
|
@@ -2988,13 +5333,25 @@
|
|
|
2988
5333
|
"nullable": true
|
|
2989
5334
|
}
|
|
2990
5335
|
}
|
|
5336
|
+
},
|
|
5337
|
+
"portal": {
|
|
5338
|
+
"type": "object",
|
|
5339
|
+
"additionalProperties": false,
|
|
5340
|
+
"nullable": true,
|
|
5341
|
+
"description": "Optional portal login. Customers log in with their customer portal account (email one-time code); the portal must belong to this organisation. On update, omit to keep the current setting or send null to remove it.",
|
|
5342
|
+
"required": [
|
|
5343
|
+
"portal_id"
|
|
5344
|
+
],
|
|
5345
|
+
"properties": {
|
|
5346
|
+
"portal_id": {
|
|
5347
|
+
"type": "string",
|
|
5348
|
+
"format": "uuid"
|
|
5349
|
+
}
|
|
5350
|
+
}
|
|
2991
5351
|
}
|
|
2992
5352
|
},
|
|
2993
5353
|
"nullable": true,
|
|
2994
|
-
"description": "
|
|
2995
|
-
"required": [
|
|
2996
|
-
"email_code"
|
|
2997
|
-
]
|
|
5354
|
+
"description": "Customer login settings. The email template selection does not enable verification by itself. On update, each login method is merged separately; null removes all login settings."
|
|
2998
5355
|
}
|
|
2999
5356
|
}
|
|
3000
5357
|
},
|
|
@@ -3005,13 +5362,163 @@
|
|
|
3005
5362
|
}
|
|
3006
5363
|
}
|
|
3007
5364
|
},
|
|
5365
|
+
"ActionRevision": {
|
|
5366
|
+
"type": "object",
|
|
5367
|
+
"additionalProperties": false,
|
|
5368
|
+
"required": [
|
|
5369
|
+
"expected_revision"
|
|
5370
|
+
],
|
|
5371
|
+
"properties": {
|
|
5372
|
+
"expected_revision": {
|
|
5373
|
+
"type": "integer",
|
|
5374
|
+
"minimum": 1
|
|
5375
|
+
}
|
|
5376
|
+
}
|
|
5377
|
+
},
|
|
5378
|
+
"ActionState": {
|
|
5379
|
+
"type": "object",
|
|
5380
|
+
"additionalProperties": false,
|
|
5381
|
+
"required": [
|
|
5382
|
+
"conversation_id",
|
|
5383
|
+
"status"
|
|
5384
|
+
],
|
|
5385
|
+
"properties": {
|
|
5386
|
+
"conversation_id": {
|
|
5387
|
+
"type": "string",
|
|
5388
|
+
"format": "uuid"
|
|
5389
|
+
},
|
|
5390
|
+
"status": {
|
|
5391
|
+
"type": "string",
|
|
5392
|
+
"enum": [
|
|
5393
|
+
"none",
|
|
5394
|
+
"needs_input",
|
|
5395
|
+
"needs_confirmation",
|
|
5396
|
+
"executing",
|
|
5397
|
+
"completed",
|
|
5398
|
+
"pending",
|
|
5399
|
+
"rejected",
|
|
5400
|
+
"handoff"
|
|
5401
|
+
]
|
|
5402
|
+
},
|
|
5403
|
+
"action_id": {
|
|
5404
|
+
"type": "string",
|
|
5405
|
+
"format": "uuid"
|
|
5406
|
+
},
|
|
5407
|
+
"revision": {
|
|
5408
|
+
"type": "integer"
|
|
5409
|
+
},
|
|
5410
|
+
"options": {
|
|
5411
|
+
"type": "array",
|
|
5412
|
+
"maxItems": 50,
|
|
5413
|
+
"items": {
|
|
5414
|
+
"type": "object",
|
|
5415
|
+
"additionalProperties": false,
|
|
5416
|
+
"required": [
|
|
5417
|
+
"meter_id",
|
|
5418
|
+
"counter_id",
|
|
5419
|
+
"meter_number",
|
|
5420
|
+
"label",
|
|
5421
|
+
"unit"
|
|
5422
|
+
],
|
|
5423
|
+
"properties": {
|
|
5424
|
+
"meter_id": {
|
|
5425
|
+
"type": "string"
|
|
5426
|
+
},
|
|
5427
|
+
"counter_id": {
|
|
5428
|
+
"type": "string"
|
|
5429
|
+
},
|
|
5430
|
+
"meter_number": {
|
|
5431
|
+
"type": "string"
|
|
5432
|
+
},
|
|
5433
|
+
"label": {
|
|
5434
|
+
"type": "string"
|
|
5435
|
+
},
|
|
5436
|
+
"unit": {
|
|
5437
|
+
"type": "string"
|
|
5438
|
+
},
|
|
5439
|
+
"min_value": {
|
|
5440
|
+
"type": "number"
|
|
5441
|
+
},
|
|
5442
|
+
"max_value": {
|
|
5443
|
+
"type": "number"
|
|
5444
|
+
}
|
|
5445
|
+
}
|
|
5446
|
+
}
|
|
5447
|
+
},
|
|
5448
|
+
"values": {
|
|
5449
|
+
"type": "object",
|
|
5450
|
+
"additionalProperties": false,
|
|
5451
|
+
"required": [
|
|
5452
|
+
"meter_id",
|
|
5453
|
+
"counter_id",
|
|
5454
|
+
"value"
|
|
5455
|
+
],
|
|
5456
|
+
"properties": {
|
|
5457
|
+
"meter_id": {
|
|
5458
|
+
"type": "string"
|
|
5459
|
+
},
|
|
5460
|
+
"counter_id": {
|
|
5461
|
+
"type": "string"
|
|
5462
|
+
},
|
|
5463
|
+
"value": {
|
|
5464
|
+
"type": "number"
|
|
5465
|
+
}
|
|
5466
|
+
}
|
|
5467
|
+
},
|
|
5468
|
+
"field_error": {
|
|
5469
|
+
"type": "string",
|
|
5470
|
+
"enum": [
|
|
5471
|
+
"VALUE_INVALID",
|
|
5472
|
+
"VALUE_OUT_OF_RANGE",
|
|
5473
|
+
"TARGET_UNAVAILABLE"
|
|
5474
|
+
]
|
|
5475
|
+
},
|
|
5476
|
+
"receipt": {
|
|
5477
|
+
"type": "object",
|
|
5478
|
+
"additionalProperties": false,
|
|
5479
|
+
"required": [
|
|
5480
|
+
"reference",
|
|
5481
|
+
"meter_number",
|
|
5482
|
+
"value",
|
|
5483
|
+
"unit",
|
|
5484
|
+
"submitted_at"
|
|
5485
|
+
],
|
|
5486
|
+
"properties": {
|
|
5487
|
+
"reference": {
|
|
5488
|
+
"type": "string"
|
|
5489
|
+
},
|
|
5490
|
+
"meter_number": {
|
|
5491
|
+
"type": "string"
|
|
5492
|
+
},
|
|
5493
|
+
"value": {
|
|
5494
|
+
"type": "number"
|
|
5495
|
+
},
|
|
5496
|
+
"unit": {
|
|
5497
|
+
"type": "string"
|
|
5498
|
+
},
|
|
5499
|
+
"submitted_at": {
|
|
5500
|
+
"type": "string"
|
|
5501
|
+
}
|
|
5502
|
+
}
|
|
5503
|
+
},
|
|
5504
|
+
"reason": {
|
|
5505
|
+
"type": "string",
|
|
5506
|
+
"enum": [
|
|
5507
|
+
"NO_METERS",
|
|
5508
|
+
"SUBMISSION_REJECTED",
|
|
5509
|
+
"SUBMISSION_UNCERTAIN"
|
|
5510
|
+
]
|
|
5511
|
+
}
|
|
5512
|
+
}
|
|
5513
|
+
},
|
|
3008
5514
|
"VerificationState": {
|
|
3009
5515
|
"type": "object",
|
|
3010
5516
|
"additionalProperties": false,
|
|
3011
5517
|
"required": [
|
|
3012
5518
|
"available",
|
|
3013
5519
|
"conversation_id",
|
|
3014
|
-
"status"
|
|
5520
|
+
"status",
|
|
5521
|
+
"access"
|
|
3015
5522
|
],
|
|
3016
5523
|
"properties": {
|
|
3017
5524
|
"available": {
|
|
@@ -3054,6 +5561,152 @@
|
|
|
3054
5561
|
"ambiguous",
|
|
3055
5562
|
"not_found"
|
|
3056
5563
|
]
|
|
5564
|
+
},
|
|
5565
|
+
"access": {
|
|
5566
|
+
"type": "object",
|
|
5567
|
+
"additionalProperties": false,
|
|
5568
|
+
"required": [
|
|
5569
|
+
"tier"
|
|
5570
|
+
],
|
|
5571
|
+
"properties": {
|
|
5572
|
+
"tier": {
|
|
5573
|
+
"type": "string",
|
|
5574
|
+
"enum": [
|
|
5575
|
+
"anonymous",
|
|
5576
|
+
"identified",
|
|
5577
|
+
"verified"
|
|
5578
|
+
],
|
|
5579
|
+
"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"
|
|
5580
|
+
},
|
|
5581
|
+
"method": {
|
|
5582
|
+
"type": "string",
|
|
5583
|
+
"enum": [
|
|
5584
|
+
"email_code",
|
|
5585
|
+
"portal_login"
|
|
5586
|
+
],
|
|
5587
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
5588
|
+
}
|
|
5589
|
+
}
|
|
5590
|
+
}
|
|
5591
|
+
}
|
|
5592
|
+
},
|
|
5593
|
+
"PortalLoginState": {
|
|
5594
|
+
"type": "object",
|
|
5595
|
+
"additionalProperties": false,
|
|
5596
|
+
"required": [
|
|
5597
|
+
"available",
|
|
5598
|
+
"conversation_id",
|
|
5599
|
+
"status",
|
|
5600
|
+
"access"
|
|
5601
|
+
],
|
|
5602
|
+
"properties": {
|
|
5603
|
+
"available": {
|
|
5604
|
+
"type": "boolean"
|
|
5605
|
+
},
|
|
5606
|
+
"conversation_id": {
|
|
5607
|
+
"type": "string",
|
|
5608
|
+
"format": "uuid"
|
|
5609
|
+
},
|
|
5610
|
+
"status": {
|
|
5611
|
+
"type": "string",
|
|
5612
|
+
"enum": [
|
|
5613
|
+
"anonymous",
|
|
5614
|
+
"pending",
|
|
5615
|
+
"verified"
|
|
5616
|
+
]
|
|
5617
|
+
},
|
|
5618
|
+
"challenge_id": {
|
|
5619
|
+
"type": "string",
|
|
5620
|
+
"format": "uuid"
|
|
5621
|
+
},
|
|
5622
|
+
"code_expires_at": {
|
|
5623
|
+
"type": "integer",
|
|
5624
|
+
"description": "Unix seconds"
|
|
5625
|
+
},
|
|
5626
|
+
"attempts_left": {
|
|
5627
|
+
"type": "integer",
|
|
5628
|
+
"minimum": 0
|
|
5629
|
+
},
|
|
5630
|
+
"email": {
|
|
5631
|
+
"type": "string",
|
|
5632
|
+
"format": "email",
|
|
5633
|
+
"maxLength": 254
|
|
5634
|
+
},
|
|
5635
|
+
"contact_resolution": {
|
|
5636
|
+
"type": "string",
|
|
5637
|
+
"enum": [
|
|
5638
|
+
"matched",
|
|
5639
|
+
"not_found"
|
|
5640
|
+
]
|
|
5641
|
+
},
|
|
5642
|
+
"access": {
|
|
5643
|
+
"type": "object",
|
|
5644
|
+
"additionalProperties": false,
|
|
5645
|
+
"required": [
|
|
5646
|
+
"tier"
|
|
5647
|
+
],
|
|
5648
|
+
"properties": {
|
|
5649
|
+
"tier": {
|
|
5650
|
+
"type": "string",
|
|
5651
|
+
"enum": [
|
|
5652
|
+
"anonymous",
|
|
5653
|
+
"identified",
|
|
5654
|
+
"verified"
|
|
5655
|
+
],
|
|
5656
|
+
"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"
|
|
5657
|
+
},
|
|
5658
|
+
"method": {
|
|
5659
|
+
"type": "string",
|
|
5660
|
+
"enum": [
|
|
5661
|
+
"email_code",
|
|
5662
|
+
"portal_login"
|
|
5663
|
+
],
|
|
5664
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
5665
|
+
}
|
|
5666
|
+
}
|
|
5667
|
+
}
|
|
5668
|
+
}
|
|
5669
|
+
},
|
|
5670
|
+
"LoginMethod": {
|
|
5671
|
+
"type": "string",
|
|
5672
|
+
"enum": [
|
|
5673
|
+
"email_code",
|
|
5674
|
+
"portal_login"
|
|
5675
|
+
],
|
|
5676
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
5677
|
+
},
|
|
5678
|
+
"AccessTier": {
|
|
5679
|
+
"type": "string",
|
|
5680
|
+
"enum": [
|
|
5681
|
+
"anonymous",
|
|
5682
|
+
"identified",
|
|
5683
|
+
"verified"
|
|
5684
|
+
],
|
|
5685
|
+
"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"
|
|
5686
|
+
},
|
|
5687
|
+
"CustomerAccess": {
|
|
5688
|
+
"type": "object",
|
|
5689
|
+
"additionalProperties": false,
|
|
5690
|
+
"required": [
|
|
5691
|
+
"tier"
|
|
5692
|
+
],
|
|
5693
|
+
"properties": {
|
|
5694
|
+
"tier": {
|
|
5695
|
+
"type": "string",
|
|
5696
|
+
"enum": [
|
|
5697
|
+
"anonymous",
|
|
5698
|
+
"identified",
|
|
5699
|
+
"verified"
|
|
5700
|
+
],
|
|
5701
|
+
"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"
|
|
5702
|
+
},
|
|
5703
|
+
"method": {
|
|
5704
|
+
"type": "string",
|
|
5705
|
+
"enum": [
|
|
5706
|
+
"email_code",
|
|
5707
|
+
"portal_login"
|
|
5708
|
+
],
|
|
5709
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
3057
5710
|
}
|
|
3058
5711
|
}
|
|
3059
5712
|
},
|
|
@@ -3064,7 +5717,8 @@
|
|
|
3064
5717
|
"organisationName",
|
|
3065
5718
|
"assistantName",
|
|
3066
5719
|
"defaultLocale",
|
|
3067
|
-
"locales"
|
|
5720
|
+
"locales",
|
|
5721
|
+
"login_methods"
|
|
3068
5722
|
],
|
|
3069
5723
|
"properties": {
|
|
3070
5724
|
"key": {
|
|
@@ -3083,15 +5737,29 @@
|
|
|
3083
5737
|
"de"
|
|
3084
5738
|
]
|
|
3085
5739
|
},
|
|
3086
|
-
"
|
|
5740
|
+
"login_methods": {
|
|
5741
|
+
"type": "array",
|
|
5742
|
+
"description": "Login methods currently available to the customer.",
|
|
5743
|
+
"items": {
|
|
5744
|
+
"type": "string",
|
|
5745
|
+
"enum": [
|
|
5746
|
+
"email_code",
|
|
5747
|
+
"portal_login"
|
|
5748
|
+
],
|
|
5749
|
+
"description": "How a customer can log in or verify themselves in the chat."
|
|
5750
|
+
}
|
|
5751
|
+
},
|
|
5752
|
+
"actions": {
|
|
3087
5753
|
"type": "object",
|
|
3088
5754
|
"additionalProperties": false,
|
|
3089
|
-
"
|
|
3090
|
-
"email_code"
|
|
3091
|
-
],
|
|
5755
|
+
"description": "Prototype Guided Actions offered by this Website Chat.",
|
|
3092
5756
|
"properties": {
|
|
3093
|
-
"
|
|
5757
|
+
"meter_reading": {
|
|
3094
5758
|
"type": "boolean"
|
|
5759
|
+
},
|
|
5760
|
+
"meter_reading_journey_id": {
|
|
5761
|
+
"type": "string",
|
|
5762
|
+
"format": "uuid"
|
|
3095
5763
|
}
|
|
3096
5764
|
}
|
|
3097
5765
|
},
|
|
@@ -3482,12 +6150,38 @@
|
|
|
3482
6150
|
"REQUEST_CONFLICT",
|
|
3483
6151
|
"IN_PROGRESS",
|
|
3484
6152
|
"UNAVAILABLE",
|
|
3485
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
6153
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
6154
|
+
"IDENTITY_REQUIRED",
|
|
6155
|
+
"ACTION_UNAVAILABLE",
|
|
6156
|
+
"ACTION_CONFLICT",
|
|
6157
|
+
"ACTION_TARGET_DENIED",
|
|
6158
|
+
"INVALID_LOGIN_CODE",
|
|
6159
|
+
"LOGIN_EXPIRED",
|
|
6160
|
+
"LOGIN_DISABLED",
|
|
6161
|
+
"LOGIN_UNAVAILABLE",
|
|
6162
|
+
"LOGIN_CONFLICT",
|
|
6163
|
+
"LOGIN_REJECTED"
|
|
3486
6164
|
]
|
|
6165
|
+
},
|
|
6166
|
+
"attempts_left": {
|
|
6167
|
+
"type": "integer",
|
|
6168
|
+
"minimum": 0,
|
|
6169
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
3487
6170
|
}
|
|
3488
6171
|
}
|
|
3489
6172
|
}
|
|
3490
6173
|
},
|
|
6174
|
+
"parameters": {
|
|
6175
|
+
"ActionId": {
|
|
6176
|
+
"in": "path",
|
|
6177
|
+
"name": "action_id",
|
|
6178
|
+
"required": true,
|
|
6179
|
+
"schema": {
|
|
6180
|
+
"type": "string",
|
|
6181
|
+
"format": "uuid"
|
|
6182
|
+
}
|
|
6183
|
+
}
|
|
6184
|
+
},
|
|
3491
6185
|
"responses": {
|
|
3492
6186
|
"Error": {
|
|
3493
6187
|
"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.",
|
|
@@ -3519,8 +6213,23 @@
|
|
|
3519
6213
|
"REQUEST_CONFLICT",
|
|
3520
6214
|
"IN_PROGRESS",
|
|
3521
6215
|
"UNAVAILABLE",
|
|
3522
|
-
"TEMPORARILY_UNAVAILABLE"
|
|
6216
|
+
"TEMPORARILY_UNAVAILABLE",
|
|
6217
|
+
"IDENTITY_REQUIRED",
|
|
6218
|
+
"ACTION_UNAVAILABLE",
|
|
6219
|
+
"ACTION_CONFLICT",
|
|
6220
|
+
"ACTION_TARGET_DENIED",
|
|
6221
|
+
"INVALID_LOGIN_CODE",
|
|
6222
|
+
"LOGIN_EXPIRED",
|
|
6223
|
+
"LOGIN_DISABLED",
|
|
6224
|
+
"LOGIN_UNAVAILABLE",
|
|
6225
|
+
"LOGIN_CONFLICT",
|
|
6226
|
+
"LOGIN_REJECTED"
|
|
3523
6227
|
]
|
|
6228
|
+
},
|
|
6229
|
+
"attempts_left": {
|
|
6230
|
+
"type": "integer",
|
|
6231
|
+
"minimum": 0,
|
|
6232
|
+
"description": "Remaining code attempts; only with INVALID_LOGIN_CODE."
|
|
3524
6233
|
}
|
|
3525
6234
|
}
|
|
3526
6235
|
}
|