freeclimb 4.5.0 → 4.5.2

Sign up to get free protection for your applications and to get access to all the features.
data/openapi.json CHANGED
@@ -83,16 +83,8 @@
83
83
  "schemas": {
84
84
  "AccountStatus": {
85
85
  "type": "string",
86
- "enum": [
87
- "closed",
88
- "suspended",
89
- "active"
90
- ],
91
- "x-enum-varnames": [
92
- "CLOSED",
93
- "SUSPENDED",
94
- "ACTIVE"
95
- ],
86
+ "enum": ["closed", "suspended", "active"],
87
+ "x-enum-varnames": ["CLOSED", "SUSPENDED", "ACTIVE"],
96
88
  "x-enum": true,
97
89
  "description": "The status of this account. It is one of: active, suspended, or closed.",
98
90
  "nullable": true
@@ -100,44 +92,24 @@
100
92
  "AccountType": {
101
93
  "type": "string",
102
94
  "description": "The type of this account. It is one of: trial or full.",
103
- "enum": [
104
- "trial",
105
- "full"
106
- ],
95
+ "enum": ["trial", "full"],
107
96
  "x-enum": true,
108
- "x-enum-varnames": [
109
- "TRIAL",
110
- "FULL"
111
- ],
97
+ "x-enum-varnames": ["TRIAL", "FULL"],
112
98
  "nullable": true
113
99
  },
114
100
  "AnsweredBy": {
115
101
  "type": "string",
116
102
  "nullable": true,
117
- "enum": [
118
- "human",
119
- "machine"
120
- ],
121
- "x-enum-varnames": [
122
- "HUMAN",
123
- "MACHINE"
124
- ],
103
+ "enum": ["human", "machine"],
104
+ "x-enum-varnames": ["HUMAN", "MACHINE"],
125
105
  "x-enum": true,
126
106
  "description": "If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise."
127
107
  },
128
108
  "CallDirection": {
129
109
  "type": "string",
130
110
  "nullable": true,
131
- "enum": [
132
- "inbound",
133
- "outboundAPI",
134
- "outboundDial"
135
- ],
136
- "x-enum-varnames": [
137
- "INBOUND",
138
- "OUTBOUND_API",
139
- "OUTBOUND_DIAL"
140
- ],
111
+ "enum": ["inbound", "outboundAPI", "outboundDial"],
112
+ "x-enum-varnames": ["INBOUND", "OUTBOUND_API", "OUTBOUND_DIAL"],
141
113
  "x-enum": true,
142
114
  "description": "Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API, `outboundDial` for Calls initiated by the `OutDial` PerCL command."
143
115
  },
@@ -170,18 +142,8 @@
170
142
  "ConferenceStatus": {
171
143
  "type": "string",
172
144
  "nullable": true,
173
- "enum": [
174
- "empty",
175
- "populated",
176
- "inProgress",
177
- "terminated"
178
- ],
179
- "x-enum-varnames": [
180
- "EMPTY",
181
- "POPULATED",
182
- "IN_PROGRESS",
183
- "TERMINATED"
184
- ],
145
+ "enum": ["empty", "populated", "inProgress", "terminated"],
146
+ "x-enum-varnames": ["EMPTY", "POPULATED", "IN_PROGRESS", "TERMINATED"],
185
147
  "x-enum": true,
186
148
  "description": "The status of the Conference. One of: creating, empty, populated, inProgress, or terminated."
187
149
  },
@@ -245,28 +207,16 @@
245
207
  },
246
208
  "GrammarType": {
247
209
  "type": "string",
248
- "enum": [
249
- "URL",
250
- "BUILTIN"
251
- ],
210
+ "enum": ["URL", "BUILTIN"],
252
211
  "nullable": true,
253
- "x-enum-varnames": [
254
- "URL",
255
- "BUILT_IN"
256
- ],
212
+ "x-enum-varnames": ["URL", "BUILT_IN"],
257
213
  "x-enum": true,
258
214
  "description": "The grammar file type to use for speech recognition. A value of 'URL' indicates the grammarFile attribute specifies a URL that points to the grammar file. A value of `BUILTIN` indicates the grammarFile attribute specifies the name of one of the platform built-in grammar files."
259
215
  },
260
216
  "IfMachine": {
261
217
  "type": "string",
262
- "enum": [
263
- "redirect",
264
- "hangup"
265
- ],
266
- "x-enum-varnames": [
267
- "REDIRECT",
268
- "HANGUP"
269
- ],
218
+ "enum": ["redirect", "hangup"],
219
+ "x-enum-varnames": ["REDIRECT", "HANGUP"],
270
220
  "x-enum": true,
271
221
  "description": "Specifies how FreeClimb should handle this OutDial if an answering machine answers the Call. Valid values: `redirect` invokes the ifMachineUrl for instructions. `hangup` hangs up the Call. The ifMachineUrl will not be invoked."
272
222
  },
@@ -332,42 +282,22 @@
332
282
  },
333
283
  "LogLevel": {
334
284
  "type": "string",
335
- "enum": [
336
- "info",
337
- "warning",
338
- "error"
339
- ],
285
+ "enum": ["info", "warning", "error"],
340
286
  "nullable": true,
341
- "x-enum-varnames": [
342
- "INFO",
343
- "WARNING",
344
- "ERROR"
345
- ],
287
+ "x-enum-varnames": ["INFO", "WARNING", "ERROR"],
346
288
  "x-enum": true,
347
289
  "description": "Level of the log. Possible values are info, warning, and error."
348
290
  },
349
291
  "MachineType": {
350
292
  "type": "string",
351
- "enum": [
352
- "answeringMachine",
353
- "faxMachine"
354
- ],
355
- "x-enum-varnames": [
356
- "ANSWERING_MACHINE",
357
- "FAX_MACHINE"
358
- ],
293
+ "enum": ["answeringMachine", "faxMachine"],
294
+ "x-enum-varnames": ["ANSWERING_MACHINE", "FAX_MACHINE"],
359
295
  "x-enum": true
360
296
  },
361
297
  "MessageDirection": {
362
298
  "type": "string",
363
- "enum": [
364
- "inbound",
365
- "outbound"
366
- ],
367
- "x-enum-varnames": [
368
- "INBOUND",
369
- "OUTBOUND"
370
- ],
299
+ "enum": ["inbound", "outbound"],
300
+ "x-enum-varnames": ["INBOUND", "OUTBOUND"],
371
301
  "x-enum": true
372
302
  },
373
303
  "MessageStatus": {
@@ -405,18 +335,8 @@
405
335
  "PlayBeep": {
406
336
  "type": "string",
407
337
  "nullable": true,
408
- "enum": [
409
- "always",
410
- "never",
411
- "entryOnly",
412
- "exitOnly"
413
- ],
414
- "x-enum-varnames": [
415
- "ALWAYS",
416
- "NEVER",
417
- "ENTRY_ONLY",
418
- "EXIT_ONLY"
419
- ],
338
+ "enum": ["always", "never", "entryOnly", "exitOnly"],
339
+ "x-enum-varnames": ["ALWAYS", "NEVER", "ENTRY_ONLY", "EXIT_ONLY"],
420
340
  "x-enum": true,
421
341
  "description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` ",
422
342
  "default": "always",
@@ -424,34 +344,14 @@
424
344
  },
425
345
  "QueueResultStatus": {
426
346
  "type": "string",
427
- "enum": [
428
- "queueFull",
429
- "dequeued",
430
- "hangup",
431
- "systemError"
432
- ],
433
- "x-enum-varnames": [
434
- "QUEUE_FULL",
435
- "DEQUEUED",
436
- "HANGUP",
437
- "SYSTEM_ERROR"
438
- ],
347
+ "enum": ["queueFull", "dequeued", "hangup", "systemError"],
348
+ "x-enum-varnames": ["QUEUE_FULL", "DEQUEUED", "HANGUP", "SYSTEM_ERROR"],
439
349
  "x-enum": true
440
350
  },
441
351
  "RecordUtteranceTermReason": {
442
352
  "type": "string",
443
- "enum": [
444
- "finishKey",
445
- "timeout",
446
- "hangup",
447
- "maxLength"
448
- ],
449
- "x-enum-varnames": [
450
- "FINISH_KEY",
451
- "TIMEOUT",
452
- "HANGUP",
453
- "MAX_LENGTH"
454
- ],
353
+ "enum": ["finishKey", "timeout", "hangup", "maxLength"],
354
+ "x-enum-varnames": ["FINISH_KEY", "TIMEOUT", "HANGUP", "MAX_LENGTH"],
455
355
  "x-enum": true
456
356
  },
457
357
  "RequestType": {
@@ -510,27 +410,15 @@
510
410
  },
511
411
  "UpdateCallRequestStatus": {
512
412
  "type": "string",
513
- "enum": [
514
- "canceled",
515
- "completed"
516
- ],
517
- "x-enum-varnames": [
518
- "CANCELED",
519
- "COMPLETED"
520
- ],
413
+ "enum": ["canceled", "completed"],
414
+ "x-enum-varnames": ["CANCELED", "COMPLETED"],
521
415
  "x-enum": true,
522
416
  "description": "Either `canceled` or `completed`. Specifying `canceled` attempts to hang up calls that are queued without affecting calls already in progress. Specifying `completed` attempts to hang up a call already in progress."
523
417
  },
524
418
  "UpdateConferenceRequestStatus": {
525
419
  "type": "string",
526
- "enum": [
527
- "empty",
528
- "terminated"
529
- ],
530
- "x-enum-varnames": [
531
- "EMPTY",
532
- "TERMINATED"
533
- ],
420
+ "enum": ["empty", "terminated"],
421
+ "x-enum-varnames": ["EMPTY", "TERMINATED"],
534
422
  "x-enum": true,
535
423
  "description": "New status of the conference. Valid values: `empty` or `terminated`. For more information, see **Status Parameter** below.**"
536
424
  },
@@ -579,6 +467,7 @@
579
467
  "Sms": "#/components/schemas/Sms",
580
468
  "StartRecordCall": "#/components/schemas/StartRecordCall",
581
469
  "TerminateConference": "#/components/schemas/TerminateConference",
470
+ "TranscribeUtterance": "#/components/schemas/TranscribeUtterance",
582
471
  "Unpark": "#/components/schemas/Unpark"
583
472
  }
584
473
  },
@@ -598,9 +487,7 @@
598
487
  },
599
488
  {
600
489
  "type": "object",
601
- "required": [
602
- "conferenceId"
603
- ],
490
+ "required": ["conferenceId"],
604
491
  "properties": {
605
492
  "allowCallControl": {
606
493
  "description": "If `true`, Call control will be enabled for this Participant's Call leg.",
@@ -656,9 +543,7 @@
656
543
  },
657
544
  {
658
545
  "type": "object",
659
- "required": [
660
- "actionUrl"
661
- ],
546
+ "required": ["actionUrl"],
662
547
  "properties": {
663
548
  "actionUrl": {
664
549
  "description": " This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. ",
@@ -711,11 +596,7 @@
711
596
  },
712
597
  {
713
598
  "type": "object",
714
- "required": [
715
- "queueId",
716
- "waitUrl",
717
- "actionUrl"
718
- ],
599
+ "required": ["queueId", "waitUrl", "actionUrl"],
719
600
  "properties": {
720
601
  "actionUrl": {
721
602
  "description": "A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up.",
@@ -749,9 +630,7 @@
749
630
  },
750
631
  {
751
632
  "type": "object",
752
- "required": [
753
- "actionUrl"
754
- ],
633
+ "required": ["actionUrl"],
755
634
  "properties": {
756
635
  "actionUrl": {
757
636
  "description": "When the Caller has finished entering digits, FreeClimb will make an HTTP POST request to this URL. A PerCL response is expected to continue handling the Call. Make sure to keep “http://“ in the URL.",
@@ -807,10 +686,7 @@
807
686
  },
808
687
  {
809
688
  "type": "object",
810
- "required": [
811
- "actionUrl",
812
- "grammarFile"
813
- ],
689
+ "required": ["actionUrl", "grammarFile"],
814
690
  "properties": {
815
691
  "actionUrl": {
816
692
  "description": "When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call.",
@@ -963,10 +839,7 @@
963
839
  },
964
840
  {
965
841
  "type": "object",
966
- "required": [
967
- "waitUrl",
968
- "actionUrl"
969
- ],
842
+ "required": ["waitUrl", "actionUrl"],
970
843
  "properties": {
971
844
  "waitUrl": {
972
845
  "description": "Specifies a URL pointing to a PerCL script containing actions to be executed while the caller is Parked. Once the script returned by the waitUrl runs out of commands to execute, FreeClimb will re-request the waitUrl and start over, essentially looping the script requests indefinitely.",
@@ -995,9 +868,7 @@
995
868
  },
996
869
  {
997
870
  "type": "object",
998
- "required": [
999
- "length"
1000
- ],
871
+ "required": ["length"],
1001
872
  "properties": {
1002
873
  "length": {
1003
874
  "description": "Length in milliseconds. FreeClimb will wait silently before continuing on.",
@@ -1015,9 +886,7 @@
1015
886
  "$ref": "#/components/schemas/PerclCommand"
1016
887
  },
1017
888
  {
1018
- "required": [
1019
- "file"
1020
- ],
889
+ "required": ["file"],
1021
890
  "type": "object",
1022
891
  "properties": {
1023
892
  "file": {
@@ -1048,9 +917,7 @@
1048
917
  "$ref": "#/components/schemas/PerclCommand"
1049
918
  },
1050
919
  {
1051
- "required": [
1052
- "file"
1053
- ],
920
+ "required": ["file"],
1054
921
  "type": "object",
1055
922
  "properties": {
1056
923
  "file": {
@@ -1070,9 +937,7 @@
1070
937
  "x-is-uri": true
1071
938
  },
1072
939
  {
1073
- "required": [
1074
- "actionUrl"
1075
- ],
940
+ "required": ["actionUrl"],
1076
941
  "type": "object",
1077
942
  "properties": {
1078
943
  "actionUrl": {
@@ -1117,9 +982,7 @@
1117
982
  "x-is-uri": true
1118
983
  },
1119
984
  {
1120
- "required": [
1121
- "actionUrl"
1122
- ],
985
+ "required": ["actionUrl"],
1123
986
  "type": "object",
1124
987
  "properties": {
1125
988
  "actionUrl": {
@@ -1157,9 +1020,7 @@
1157
1020
  "$ref": "#/components/schemas/PerclCommand"
1158
1021
  },
1159
1022
  {
1160
- "required": [
1161
- "callId"
1162
- ],
1023
+ "required": ["callId"],
1163
1024
  "type": "object",
1164
1025
  "properties": {
1165
1026
  "callId": {
@@ -1178,9 +1039,7 @@
1178
1039
  "$ref": "#/components/schemas/PerclCommand"
1179
1040
  },
1180
1041
  {
1181
- "required": [
1182
- "text"
1183
- ],
1042
+ "required": ["text"],
1184
1043
  "type": "object",
1185
1044
  "properties": {
1186
1045
  "text": {
@@ -1216,9 +1075,7 @@
1216
1075
  "$ref": "#/components/schemas/PerclCommand"
1217
1076
  },
1218
1077
  {
1219
- "required": [
1220
- "digits"
1221
- ],
1078
+ "required": ["digits"],
1222
1079
  "type": "object",
1223
1080
  "properties": {
1224
1081
  "digits": {
@@ -1245,9 +1102,7 @@
1245
1102
  "$ref": "#/components/schemas/PerclCommand"
1246
1103
  },
1247
1104
  {
1248
- "required": [
1249
- "callId"
1250
- ],
1105
+ "required": ["callId"],
1251
1106
  "type": "object",
1252
1107
  "properties": {
1253
1108
  "callId": {
@@ -1270,9 +1125,7 @@
1270
1125
  "$ref": "#/components/schemas/PerclCommand"
1271
1126
  },
1272
1127
  {
1273
- "required": [
1274
- "callId"
1275
- ],
1128
+ "required": ["callId"],
1276
1129
  "type": "object",
1277
1130
  "properties": {
1278
1131
  "callId": {
@@ -1295,11 +1148,7 @@
1295
1148
  "$ref": "#/components/schemas/PerclCommand"
1296
1149
  },
1297
1150
  {
1298
- "required": [
1299
- "to",
1300
- "from",
1301
- "text"
1302
- ],
1151
+ "required": ["to", "from", "text"],
1303
1152
  "type": "object",
1304
1153
  "properties": {
1305
1154
  "to": {
@@ -1343,9 +1192,7 @@
1343
1192
  "$ref": "#/components/schemas/PerclCommand"
1344
1193
  },
1345
1194
  {
1346
- "required": [
1347
- "conferenceId"
1348
- ],
1195
+ "required": ["conferenceId"],
1349
1196
  "type": "object",
1350
1197
  "properties": {
1351
1198
  "conferenceId": {
@@ -1433,13 +1280,7 @@
1433
1280
  "Capabilities": {
1434
1281
  "description": "Details for which features this number may be used.",
1435
1282
  "type": "object",
1436
- "required": [
1437
- "voice",
1438
- "sms",
1439
- "tollFree",
1440
- "tenDLC",
1441
- "shortCode"
1442
- ],
1283
+ "required": ["voice", "sms", "tollFree", "tenDLC", "shortCode"],
1443
1284
  "x-is-object": true,
1444
1285
  "properties": {
1445
1286
  "voice": {
@@ -1813,9 +1654,7 @@
1813
1654
  },
1814
1655
  "BuyIncomingNumberRequest": {
1815
1656
  "type": "object",
1816
- "required": [
1817
- "phoneNumber"
1818
- ],
1657
+ "required": ["phoneNumber"],
1819
1658
  "properties": {
1820
1659
  "phoneNumber": {
1821
1660
  "type": "string",
@@ -1914,9 +1753,7 @@
1914
1753
  },
1915
1754
  "UpdateCallRequest": {
1916
1755
  "type": "object",
1917
- "required": [
1918
- "status"
1919
- ],
1756
+ "required": ["status"],
1920
1757
  "properties": {
1921
1758
  "status": {
1922
1759
  "$ref": "#/components/schemas/UpdateCallRequestStatus"
@@ -1925,10 +1762,7 @@
1925
1762
  },
1926
1763
  "MakeCallRequest": {
1927
1764
  "type": "object",
1928
- "required": [
1929
- "from",
1930
- "to"
1931
- ],
1765
+ "required": ["from", "to"],
1932
1766
  "properties": {
1933
1767
  "from": {
1934
1768
  "type": "string",
@@ -2196,11 +2030,7 @@
2196
2030
  },
2197
2031
  {
2198
2032
  "type": "object",
2199
- "required": [
2200
- "from",
2201
- "to",
2202
- "text"
2203
- ],
2033
+ "required": ["from", "to", "text"],
2204
2034
  "properties": {
2205
2035
  "from": {
2206
2036
  "type": "string",
@@ -2559,9 +2389,7 @@
2559
2389
  },
2560
2390
  "FilterLogsRequest": {
2561
2391
  "type": "object",
2562
- "required": [
2563
- "pql"
2564
- ],
2392
+ "required": ["pql"],
2565
2393
  "properties": {
2566
2394
  "pql": {
2567
2395
  "type": "string",
@@ -2624,14 +2452,8 @@
2624
2452
  "type": "string",
2625
2453
  "x-has-writer": true,
2626
2454
  "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
2627
- "enum": [
2628
- "ACTIVE",
2629
- "EXPIRED"
2630
- ],
2631
- "x-enum-varnames": [
2632
- "ACTIVE",
2633
- "EXPIRED"
2634
- ]
2455
+ "enum": ["ACTIVE", "EXPIRED"],
2456
+ "x-enum-varnames": ["ACTIVE", "EXPIRED"]
2635
2457
  },
2636
2458
  "createDate": {
2637
2459
  "type": "string",
@@ -2831,12 +2653,7 @@
2831
2653
  ]
2832
2654
  },
2833
2655
  "SMSTenDLCPartnerCampaign": {
2834
- "required": [
2835
- "brandId",
2836
- "campaignId",
2837
- "description",
2838
- "usecase"
2839
- ],
2656
+ "required": ["brandId", "campaignId", "description", "usecase"],
2840
2657
  "type": "object",
2841
2658
  "properties": {
2842
2659
  "accountId": {
@@ -2852,14 +2669,8 @@
2852
2669
  "type": "string",
2853
2670
  "x-has-writer": true,
2854
2671
  "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
2855
- "enum": [
2856
- "ACTIVE",
2857
- "EXPIRED"
2858
- ],
2859
- "x-enum-varnames": [
2860
- "ACTIVE",
2861
- "EXPIRED"
2862
- ]
2672
+ "enum": ["ACTIVE", "EXPIRED"],
2673
+ "x-enum-varnames": ["ACTIVE", "EXPIRED"]
2863
2674
  },
2864
2675
  "createDate": {
2865
2676
  "type": "string",
@@ -3038,10 +2849,7 @@
3038
2849
  }
3039
2850
  },
3040
2851
  "SMSTenDLCPartnerCampaignBrand": {
3041
- "required": [
3042
- "email",
3043
- "phone"
3044
- ],
2852
+ "required": ["email", "phone"],
3045
2853
  "type": "object",
3046
2854
  "x-is-object": true,
3047
2855
  "properties": {
@@ -3371,18 +3179,8 @@
3371
3179
  "altBusinessIdType": {
3372
3180
  "type": "string",
3373
3181
  "x-has-writer": true,
3374
- "enum": [
3375
- "NONE",
3376
- "DUNS",
3377
- "GIIN",
3378
- "LEI"
3379
- ],
3380
- "x-enum-varnames": [
3381
- "NONE",
3382
- "DUNS",
3383
- "GIIN",
3384
- "LEI"
3385
- ],
3182
+ "enum": ["NONE", "DUNS", "GIIN", "LEI"],
3183
+ "x-enum-varnames": ["NONE", "DUNS", "GIIN", "LEI"],
3386
3184
  "description": "The type of the Alternative business identifier"
3387
3185
  },
3388
3186
  "universalEin": {
@@ -3471,6 +3269,7 @@
3471
3269
  "x-stoplight": {
3472
3270
  "id": "u509r3zqc38ze"
3473
3271
  },
3272
+ "x-percl-command": true,
3474
3273
  "type": "object",
3475
3274
  "description": "The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.\n\n`TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.",
3476
3275
  "properties": {
@@ -3515,9 +3314,7 @@
3515
3314
  "items": {}
3516
3315
  }
3517
3316
  },
3518
- "required": [
3519
- "actionUrl"
3520
- ],
3317
+ "required": ["actionUrl"],
3521
3318
  "x-examples": {
3522
3319
  "Example 1": {
3523
3320
  "TranscribeUtterance": {
@@ -3531,7 +3328,7 @@
3531
3328
  "prompts": [
3532
3329
  {
3533
3330
  "Play": {
3534
- "file": "http://dplutil01.vail/~user/prompts/please-record-greeting.wav"
3331
+ "file": "https://yoursite.com/path/to/please-record-greeting.wav"
3535
3332
  }
3536
3333
  }
3537
3334
  ]
@@ -5824,11 +5621,5 @@
5824
5621
  "x-explorer-enabled": true,
5825
5622
  "x-proxy-enabled": true,
5826
5623
  "x-samples-enabled": false,
5827
- "x-samples-languages": [
5828
- "curl",
5829
- "node",
5830
- "ruby",
5831
- "javascript",
5832
- "python"
5833
- ]
5834
- }
5624
+ "x-samples-languages": ["curl", "node", "ruby", "javascript", "python"]
5625
+ }