freeclimb 4.6.0 → 4.6.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (149) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/Gemfile.lock +2 -2
  4. data/README.md +6 -5
  5. data/docs/DefaultApi.md +7 -8
  6. data/docs/TranscribeUtterance.md +1 -1
  7. data/docs/TranscribeUtteranceAllOf.md +28 -0
  8. data/docs/TranscribeUtteranceAllOfRecord.md +22 -0
  9. data/lib/freeclimb/api/default_api.rb +11 -9
  10. data/lib/freeclimb/models/account_request.rb +0 -2
  11. data/lib/freeclimb/models/account_result.rb +0 -6
  12. data/lib/freeclimb/models/add_to_conference.rb +0 -16
  13. data/lib/freeclimb/models/add_to_conference_all_of.rb +0 -16
  14. data/lib/freeclimb/models/application_result.rb +0 -6
  15. data/lib/freeclimb/models/buy_incoming_number_request.rb +0 -4
  16. data/lib/freeclimb/models/call_result.rb +0 -6
  17. data/lib/freeclimb/models/conference_participant_result.rb +0 -6
  18. data/lib/freeclimb/models/conference_result.rb +0 -6
  19. data/lib/freeclimb/models/create_conference.rb +0 -8
  20. data/lib/freeclimb/models/create_conference_all_of.rb +0 -8
  21. data/lib/freeclimb/models/create_conference_request.rb +0 -6
  22. data/lib/freeclimb/models/create_web_rtc_token.rb +0 -4
  23. data/lib/freeclimb/models/dequeue.rb +1 -0
  24. data/lib/freeclimb/models/enqueue.rb +0 -6
  25. data/lib/freeclimb/models/enqueue_all_of.rb +0 -6
  26. data/lib/freeclimb/models/get_digits.rb +0 -16
  27. data/lib/freeclimb/models/get_digits_all_of.rb +0 -16
  28. data/lib/freeclimb/models/get_speech.rb +0 -22
  29. data/lib/freeclimb/models/get_speech_all_of.rb +0 -22
  30. data/lib/freeclimb/models/incoming_number_request.rb +0 -2
  31. data/lib/freeclimb/models/incoming_number_result.rb +0 -10
  32. data/lib/freeclimb/models/incoming_number_result_all_of.rb +0 -2
  33. data/lib/freeclimb/models/make_call_request.rb +0 -18
  34. data/lib/freeclimb/models/message_request.rb +0 -16
  35. data/lib/freeclimb/models/message_request_all_of.rb +0 -8
  36. data/lib/freeclimb/models/message_result.rb +0 -8
  37. data/lib/freeclimb/models/message_result_all_of.rb +0 -2
  38. data/lib/freeclimb/models/mutable_resource_model.rb +0 -6
  39. data/lib/freeclimb/models/out_dial.rb +0 -18
  40. data/lib/freeclimb/models/out_dial_all_of.rb +0 -18
  41. data/lib/freeclimb/models/park.rb +0 -4
  42. data/lib/freeclimb/models/park_all_of.rb +0 -4
  43. data/lib/freeclimb/models/play.rb +0 -4
  44. data/lib/freeclimb/models/play_all_of.rb +0 -4
  45. data/lib/freeclimb/models/queue_request.rb +0 -2
  46. data/lib/freeclimb/models/queue_result.rb +0 -6
  47. data/lib/freeclimb/models/record_utterance.rb +0 -12
  48. data/lib/freeclimb/models/record_utterance_all_of.rb +0 -12
  49. data/lib/freeclimb/models/recording_result.rb +0 -6
  50. data/lib/freeclimb/models/remove_from_conference.rb +1 -0
  51. data/lib/freeclimb/models/say.rb +0 -6
  52. data/lib/freeclimb/models/say_all_of.rb +0 -6
  53. data/lib/freeclimb/models/send_digits.rb +0 -4
  54. data/lib/freeclimb/models/send_digits_all_of.rb +0 -4
  55. data/lib/freeclimb/models/sms.rb +0 -6
  56. data/lib/freeclimb/models/sms_all_of.rb +0 -6
  57. data/lib/freeclimb/models/sms_ten_dlc_brand.rb +0 -60
  58. data/lib/freeclimb/models/sms_ten_dlc_campaign.rb +0 -50
  59. data/lib/freeclimb/models/sms_ten_dlc_partner_campaign.rb +0 -44
  60. data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_brand.rb +0 -20
  61. data/lib/freeclimb/models/sms_toll_free_campaign.rb +0 -12
  62. data/lib/freeclimb/models/start_record_call.rb +1 -0
  63. data/lib/freeclimb/models/terminate_conference.rb +1 -0
  64. data/lib/freeclimb/models/transcribe_utterance.rb +11 -16
  65. data/lib/freeclimb/models/{terminate_conference_all_of.rb → transcribe_utterance_all_of.rb} +67 -14
  66. data/lib/freeclimb/models/{transcribe_utterance_record.rb → transcribe_utterance_all_of_record.rb} +3 -7
  67. data/lib/freeclimb/models/unpark.rb +1 -0
  68. data/lib/freeclimb/models/update_conference_participant_request.rb +0 -2
  69. data/lib/freeclimb/models/update_conference_request.rb +0 -2
  70. data/lib/freeclimb/version.rb +1 -1
  71. data/lib/freeclimb.rb +3 -2
  72. data/openapi.json +276 -319
  73. data/spec/api/default_api_spec.rb +120 -62
  74. data/spec/models/account_request_spec.rb +8 -6
  75. data/spec/models/account_result_spec.rb +28 -9
  76. data/spec/models/add_to_conference_spec.rb +21 -7
  77. data/spec/models/application_list_spec.rb +46 -22
  78. data/spec/models/application_request_spec.rb +13 -6
  79. data/spec/models/application_result_spec.rb +24 -9
  80. data/spec/models/available_number_list_spec.rb +46 -22
  81. data/spec/models/available_number_spec.rb +23 -10
  82. data/spec/models/buy_incoming_number_request_spec.rb +11 -7
  83. data/spec/models/call_list_spec.rb +46 -22
  84. data/spec/models/call_result_spec.rb +49 -15
  85. data/spec/models/capabilities_spec.rb +26 -11
  86. data/spec/models/conference_list_spec.rb +46 -22
  87. data/spec/models/conference_participant_list_spec.rb +46 -22
  88. data/spec/models/conference_participant_result_spec.rb +24 -9
  89. data/spec/models/conference_result_spec.rb +32 -9
  90. data/spec/models/create_conference_request_spec.rb +15 -6
  91. data/spec/models/create_conference_spec.rb +19 -7
  92. data/spec/models/create_web_rtc_token_spec.rb +18 -12
  93. data/spec/models/enqueue_spec.rb +16 -9
  94. data/spec/models/filter_logs_request_spec.rb +9 -7
  95. data/spec/models/get_digits_spec.rb +43 -19
  96. data/spec/models/get_speech_spec.rb +60 -24
  97. data/spec/models/hangup_spec.rb +7 -6
  98. data/spec/models/incoming_number_list_spec.rb +46 -22
  99. data/spec/models/incoming_number_request_spec.rb +9 -6
  100. data/spec/models/incoming_number_result_spec.rb +47 -17
  101. data/spec/models/log_list_spec.rb +46 -22
  102. data/spec/models/log_result_spec.rb +21 -9
  103. data/spec/models/make_call_request_spec.rb +26 -11
  104. data/spec/models/message_request_spec.rb +26 -12
  105. data/spec/models/message_result_spec.rb +34 -11
  106. data/spec/models/messages_list_spec.rb +46 -22
  107. data/spec/models/mutable_resource_model_spec.rb +15 -9
  108. data/spec/models/out_dial_spec.rb +33 -13
  109. data/spec/models/pagination_model_spec.rb +40 -21
  110. data/spec/models/park_spec.rb +13 -8
  111. data/spec/models/pause_spec.rb +14 -10
  112. data/spec/models/percl_command_spec.rb +6 -6
  113. data/spec/models/percl_script_spec.rb +11 -6
  114. data/spec/models/play_early_media_spec.rb +9 -7
  115. data/spec/models/play_spec.rb +17 -10
  116. data/spec/models/queue_list_spec.rb +46 -22
  117. data/spec/models/queue_member_list_spec.rb +46 -22
  118. data/spec/models/queue_member_spec.rb +21 -12
  119. data/spec/models/queue_request_spec.rb +13 -9
  120. data/spec/models/queue_result_spec.rb +37 -18
  121. data/spec/models/record_utterance_spec.rb +28 -13
  122. data/spec/models/recording_list_spec.rb +46 -22
  123. data/spec/models/recording_result_spec.rb +25 -12
  124. data/spec/models/redirect_spec.rb +9 -7
  125. data/spec/models/reject_spec.rb +7 -6
  126. data/spec/models/remove_from_conference_spec.rb +0 -67
  127. data/spec/models/say_spec.rb +18 -10
  128. data/spec/models/send_digits_spec.rb +17 -10
  129. data/spec/models/set_listen_spec.rb +8 -6
  130. data/spec/models/set_talk_spec.rb +8 -6
  131. data/spec/models/sms_spec.rb +16 -9
  132. data/spec/models/sms_ten_dlc_brand_spec.rb +38 -4
  133. data/spec/models/sms_ten_dlc_brands_list_result_spec.rb +46 -22
  134. data/spec/models/sms_ten_dlc_campaign_spec.rb +63 -4
  135. data/spec/models/sms_ten_dlc_campaigns_list_result_spec.rb +46 -22
  136. data/spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb +25 -7
  137. data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +56 -8
  138. data/spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb +46 -22
  139. data/spec/models/sms_toll_free_campaign_spec.rb +29 -15
  140. data/spec/models/sms_toll_free_campaigns_list_result_spec.rb +46 -22
  141. data/spec/models/terminate_conference_spec.rb +0 -67
  142. data/spec/models/tfn_spec.rb +9 -7
  143. data/spec/models/{transcribe_utterance_record_spec.rb → transcribe_utterance_all_of_record_spec.rb} +78 -67
  144. data/spec/models/transcribe_utterance_spec.rb +37 -96
  145. data/spec/models/update_call_request_spec.rb +12 -7
  146. data/spec/models/update_conference_participant_request_spec.rb +10 -6
  147. data/spec/models/update_conference_request_spec.rb +15 -6
  148. metadata +89 -88
  149. data/lib/freeclimb/models/remove_from_conference_all_of.rb +0 -228
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
  },
@@ -585,6 +473,7 @@
585
473
  },
586
474
  "properties": {
587
475
  "command": {
476
+ "x-is-no-property": true,
588
477
  "type": "string",
589
478
  "description": "Name of PerCL Command (this is automatically derived from mapping configuration and should not be manually supplied in any arguments)"
590
479
  }
@@ -593,15 +482,24 @@
593
482
  "AddToConference": {
594
483
  "description": "The `AddToConference` command adds a Participant to a Conference. If this Participant currently is in another Conference, the Participant is first removed from that Conference. Two Call legs can be bridged together by creating a Conference and adding both Call legs to it via `AddToConference`.",
595
484
  "x-percl-command": true,
485
+ "x-ref-properties": [
486
+ "false",
487
+ "\"TEST_STRING\"",
488
+ "\"TEST_STRING\"",
489
+ "\"TEST_STRING\"",
490
+ "\"TEST_STRING\"",
491
+ "false",
492
+ "\"TEST_STRING\"",
493
+ "false",
494
+ "false"
495
+ ],
596
496
  "allOf": [
597
497
  {
598
498
  "$ref": "#/components/schemas/PerclCommand"
599
499
  },
600
500
  {
601
501
  "type": "object",
602
- "required": [
603
- "conferenceId"
604
- ],
502
+ "required": ["conferenceId"],
605
503
  "properties": {
606
504
  "allowCallControl": {
607
505
  "description": "If `true`, Call control will be enabled for this Participant's Call leg.",
@@ -646,16 +544,22 @@
646
544
  "CreateConference": {
647
545
  "description": "The `CreateConference` command does exactly what its name implies — it creates an unpopulated Conference (one without any Participants). Once created, a Conference remains in FreeClimb until explicitly terminated by a customer. Once a Conference has been terminated, it can no longer be used.",
648
546
  "x-percl-command": true,
547
+ "x-ref-properties": [
548
+ "\"TEST_STRING\"",
549
+ "false",
550
+ "PlayBeep.ALWAYS",
551
+ "false",
552
+ "\"https://a.com\"",
553
+ "\"https://a.com\"",
554
+ "\"TEST_STRING\""
555
+ ],
649
556
  "allOf": [
650
557
  {
651
- "$ref": "#/components/schemas/PerclCommand",
652
- "x-is-uri": true
558
+ "$ref": "#/components/schemas/PerclCommand"
653
559
  },
654
560
  {
655
561
  "type": "object",
656
- "required": [
657
- "actionUrl"
658
- ],
562
+ "required": ["actionUrl"],
659
563
  "properties": {
660
564
  "actionUrl": {
661
565
  "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. ",
@@ -701,6 +605,13 @@
701
605
  "Enqueue": {
702
606
  "description": "The `Enqueue` command adds the current Call to a call Queue. If the specified Queue does not exist, it is created and then the Call is added to it. The default maximum length of the queue is 100. This can be modified using the REST API.",
703
607
  "x-percl-command": true,
608
+ "x-ref-properties": [
609
+ "\"TEST_STRING\"",
610
+ "\"TEST_STRING\"",
611
+ "\"TEST_STRING\"",
612
+ "\"TEST_STRING\"",
613
+ "\"TEST_STRING\""
614
+ ],
704
615
  "allOf": [
705
616
  {
706
617
  "$ref": "#/components/schemas/PerclCommand",
@@ -708,11 +619,7 @@
708
619
  },
709
620
  {
710
621
  "type": "object",
711
- "required": [
712
- "queueId",
713
- "waitUrl",
714
- "actionUrl"
715
- ],
622
+ "required": ["queueId", "waitUrl", "actionUrl"],
716
623
  "properties": {
717
624
  "actionUrl": {
718
625
  "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.",
@@ -739,6 +646,18 @@
739
646
  "GetDigits": {
740
647
  "description": "The `GetDigits` command collects DTMF inputs from the caller. It is only supported only when there is a single party on the Call. `GetDigits` is a Terminal Command — any actions following it are never executed. When the Caller is done entering the digits, FreeClimb submits that data to the provided `actionUrl` using an HTTP POST request. Your server will be required to respond to the FreeClimb Webhook with PerCL to continue handling the call.",
741
648
  "x-percl-command": true,
649
+ "x-ref-properties": [
650
+ "\"https://a.com\"",
651
+ "1",
652
+ "\"TEST_STRING\"",
653
+ "false",
654
+ "300",
655
+ "1",
656
+ "1",
657
+ "new List<PerclCommand>()",
658
+ "false",
659
+ "\"TEST_STRING\""
660
+ ],
742
661
  "allOf": [
743
662
  {
744
663
  "$ref": "#/components/schemas/PerclCommand",
@@ -746,9 +665,7 @@
746
665
  },
747
666
  {
748
667
  "type": "object",
749
- "required": [
750
- "actionUrl"
751
- ],
668
+ "required": ["actionUrl"],
752
669
  "properties": {
753
670
  "actionUrl": {
754
671
  "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.",
@@ -798,22 +715,36 @@
798
715
  "GetSpeech": {
799
716
  "description": "The `GetSpeech` command enables the Caller to respond to the application using a supported language. Unlike DTMF entry, which implicitly restricts the user to using the available buttons on the phone key pad, speech input allows for flexible audio inputs based on grammar. FreeClimb supports grammars written using GRXML compatible with the Microsoft Speech Platform. `GetSpeech` is only supported on a single call leg. It is not supported when there are two or more call legs connected (as in within a Conference).",
800
717
  "x-percl-command": true,
718
+ "x-ref-properties": [
719
+ "\"https://a.com\"",
720
+ "GrammarType.URL",
721
+ "\"TEST_STRING\"",
722
+ "\"TEST_STRING\"",
723
+ "false",
724
+ "new List<PerclCommand>()",
725
+ "1",
726
+ "1",
727
+ "1",
728
+ "1",
729
+ "1",
730
+ "1",
731
+ "false",
732
+ "\"TEST_STRING\""
733
+ ],
801
734
  "allOf": [
802
735
  {
803
736
  "$ref": "#/components/schemas/PerclCommand"
804
737
  },
805
738
  {
806
739
  "type": "object",
807
- "required": [
808
- "actionUrl",
809
- "grammarFile"
810
- ],
740
+ "required": ["actionUrl", "grammarFile"],
811
741
  "properties": {
812
742
  "actionUrl": {
813
743
  "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.",
814
744
  "type": "string",
815
745
  "format": "uri",
816
- "x-is-uri": true
746
+ "x-is-uri": true,
747
+ "x-is-url": true
817
748
  },
818
749
  "grammarType": {
819
750
  "$ref": "#/components/schemas/GrammarType"
@@ -891,6 +822,19 @@
891
822
  "OutDial": {
892
823
  "description": "The OutDial command is used to call a phone number",
893
824
  "x-percl-command": true,
825
+ "x-ref-properties": [
826
+ "\"https://a.com\"",
827
+ "\"https://a.com\"",
828
+ "\"TEST_STRING\"",
829
+ "\"TEST_STRING\"",
830
+ "IfMachine.REDIRECT",
831
+ "\"https://a.com\"",
832
+ "\"TEST_STRING\"",
833
+ "\"TEST_STRING\"",
834
+ "1",
835
+ "false",
836
+ "\"TEST_STRING\""
837
+ ],
894
838
  "allOf": [
895
839
  {
896
840
  "$ref": "#/components/schemas/PerclCommand",
@@ -953,6 +897,12 @@
953
897
  "Park": {
954
898
  "description": "The `Park` command allows a caller to be put on hold. You can provide hold music,messages,etc until ready to resume the call. Park is a terminal command. Actions performed on the Call while on hold are provided in a PerCL script in response to the waitUrl property. Actions performed on the Call after it has been unparked (resumed) will be provided in a PerCL script in response to the actionUrl provided. A Call can be resumed in two ways -- REST API invocation or the Unpark percl command. No actions can be nested within Park and Park cannot be nested in any other actions. ",
955
899
  "x-percl-command": true,
900
+ "x-ref-properties": [
901
+ "\"https://a.com\"",
902
+ "\"https://a.com\"",
903
+ "\"TEST_STRING\"",
904
+ "\"TEST_STRING\""
905
+ ],
956
906
  "allOf": [
957
907
  {
958
908
  "$ref": "#/components/schemas/PerclCommand",
@@ -960,10 +910,7 @@
960
910
  },
961
911
  {
962
912
  "type": "object",
963
- "required": [
964
- "waitUrl",
965
- "actionUrl"
966
- ],
913
+ "required": ["waitUrl", "actionUrl"],
967
914
  "properties": {
968
915
  "waitUrl": {
969
916
  "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.",
@@ -986,15 +933,14 @@
986
933
  "Pause": {
987
934
  "description": "The `Pause` command halts execution of the current PerCL script for a specified number of milliseconds. If `Pause` is the first command in a PerCL document, FreeClimb will wait for the specified time to elapse before picking up the call.",
988
935
  "x-percl-command": true,
936
+ "x-ref-properties": ["1"],
989
937
  "allOf": [
990
938
  {
991
939
  "$ref": "#/components/schemas/PerclCommand"
992
940
  },
993
941
  {
994
942
  "type": "object",
995
- "required": [
996
- "length"
997
- ],
943
+ "required": ["length"],
998
944
  "properties": {
999
945
  "length": {
1000
946
  "description": "Length in milliseconds. FreeClimb will wait silently before continuing on.",
@@ -1007,14 +953,13 @@
1007
953
  "Play": {
1008
954
  "description": "The `Play` command plays an audio file back to the caller. The audio file may be located at any location accessible via a URL. `Play` can exist as a stand-alone command or as a nested command. It does not allow barge-in unless nested within a `GetSpeech` command. The file will always be played to completion unless nested.",
1009
955
  "x-percl-command": true,
956
+ "x-ref-properties": ["\"TEST_STRING\"", "1", "false"],
1010
957
  "allOf": [
1011
958
  {
1012
959
  "$ref": "#/components/schemas/PerclCommand"
1013
960
  },
1014
961
  {
1015
- "required": [
1016
- "file"
1017
- ],
962
+ "required": ["file"],
1018
963
  "type": "object",
1019
964
  "properties": {
1020
965
  "file": {
@@ -1036,14 +981,13 @@
1036
981
  "PlayEarlyMedia": {
1037
982
  "description": "`PlayEarlyMedia` is relevant only when present as the very first command in the PerCL script returned for an incoming Call. In such cases, the command is executed before FreeClimb attempts to connect the call. The audio file it uses can be stored in any location that is accessible via URL.",
1038
983
  "x-percl-command": true,
984
+ "x-ref-properties": ["\"TEST_STRING\""],
1039
985
  "allOf": [
1040
986
  {
1041
987
  "$ref": "#/components/schemas/PerclCommand"
1042
988
  },
1043
989
  {
1044
- "required": [
1045
- "file"
1046
- ],
990
+ "required": ["file"],
1047
991
  "type": "object",
1048
992
  "properties": {
1049
993
  "file": {
@@ -1057,15 +1001,22 @@
1057
1001
  "RecordUtterance": {
1058
1002
  "description": "The `RecordUtterance` command records the caller's voice and returns the URL of a file containing the audio recording. `RecordUtterance` 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 to the `actionUrl`. Recording information is returned in the `actionUrl` request.",
1059
1003
  "x-percl-command": true,
1004
+ "x-ref-properties": [
1005
+ "\"https://a.com\"",
1006
+ "1",
1007
+ "\"TEST_STRING\"",
1008
+ "1",
1009
+ "false",
1010
+ "false",
1011
+ "false"
1012
+ ],
1060
1013
  "allOf": [
1061
1014
  {
1062
1015
  "$ref": "#/components/schemas/PerclCommand",
1063
1016
  "x-is-uri": true
1064
1017
  },
1065
1018
  {
1066
- "required": [
1067
- "actionUrl"
1068
- ],
1019
+ "required": ["actionUrl"],
1069
1020
  "type": "object",
1070
1021
  "properties": {
1071
1022
  "actionUrl": {
@@ -1104,15 +1055,14 @@
1104
1055
  "Redirect": {
1105
1056
  "description": "The `Redirect` command transfers control of a Call to the PerCL at a different URL. `Redirect` is a terminal command, so any actions following it are never executed. The maximum number of redirections allowed during the life time of a Call is 256. This is intended to prevent a Call from possibly looping infinitely due to errors in PerCL being generated.",
1106
1057
  "x-percl-command": true,
1058
+ "x-ref-properties": ["\"https://a.com\""],
1107
1059
  "allOf": [
1108
1060
  {
1109
1061
  "$ref": "#/components/schemas/PerclCommand",
1110
1062
  "x-is-uri": true
1111
1063
  },
1112
1064
  {
1113
- "required": [
1114
- "actionUrl"
1115
- ],
1065
+ "required": ["actionUrl"],
1116
1066
  "type": "object",
1117
1067
  "properties": {
1118
1068
  "actionUrl": {
@@ -1127,6 +1077,7 @@
1127
1077
  "Reject": {
1128
1078
  "description": "The `Reject` command blocks an incoming Call. Using `Reject` is the only way to prevent FreeClimb from answering a Call. Any other response will result in an answered Call and your account will be billed.",
1129
1079
  "x-percl-command": true,
1080
+ "x-ref-properties": ["\"TEST_STRING\""],
1130
1081
  "allOf": [
1131
1082
  {
1132
1083
  "$ref": "#/components/schemas/PerclCommand"
@@ -1145,6 +1096,7 @@
1145
1096
  "RemoveFromConference": {
1146
1097
  "description": "The `RemoveFromConference` command removes a Participant from a Conference but does not hang up. Instead, the Call is simply unbridged and what happens next with the Call is determined by the PerCL returned in response to the `leaveConferenceUrl` attribute.",
1147
1098
  "x-percl-command": true,
1099
+ "x-no-properties": true,
1148
1100
  "allOf": [
1149
1101
  {
1150
1102
  "$ref": "#/components/schemas/PerclCommand"
@@ -1159,14 +1111,18 @@
1159
1111
  "Say": {
1160
1112
  "description": "The `Say` command provides Text-To-Speech (TTS) support. It converts text to speech and then renders it in a female voice back to the caller. `Say` is useful in cases where it's difficult to pre-record a prompt for any reason. `Say` does not allow barge-in unless nested within a `GetSpeech` command. The file will always be played to completion unless nested.",
1161
1113
  "x-percl-command": true,
1114
+ "x-ref-properties": [
1115
+ "\"TEST_STRING\"",
1116
+ "\"TEST_STRING\"",
1117
+ "1",
1118
+ "false"
1119
+ ],
1162
1120
  "allOf": [
1163
1121
  {
1164
1122
  "$ref": "#/components/schemas/PerclCommand"
1165
1123
  },
1166
1124
  {
1167
- "required": [
1168
- "text"
1169
- ],
1125
+ "required": ["text"],
1170
1126
  "type": "object",
1171
1127
  "properties": {
1172
1128
  "text": {
@@ -1193,14 +1149,13 @@
1193
1149
  "SendDigits": {
1194
1150
  "description": "The `SendDigits` command plays DTMF tones on a live Call. This is useful for navigating through IVR menus or dialing extensions.",
1195
1151
  "x-percl-command": true,
1152
+ "x-ref-properties": ["\"TEST_STRING\"", "1", "false"],
1196
1153
  "allOf": [
1197
1154
  {
1198
1155
  "$ref": "#/components/schemas/PerclCommand"
1199
1156
  },
1200
1157
  {
1201
- "required": [
1202
- "digits"
1203
- ],
1158
+ "required": ["digits"],
1204
1159
  "type": "object",
1205
1160
  "properties": {
1206
1161
  "digits": {
@@ -1222,6 +1177,7 @@
1222
1177
  "SetListen": {
1223
1178
  "description": "The `SetListen` command enables or disables the listen privilege for a Conference Participant provided both calls are in the same conference. The Participant can hear what the other participants are saying only if this privilege is enabled.",
1224
1179
  "x-percl-command": true,
1180
+ "x-ref-properties": ["false"],
1225
1181
  "allOf": [
1226
1182
  {
1227
1183
  "$ref": "#/components/schemas/PerclCommand"
@@ -1241,6 +1197,7 @@
1241
1197
  "SetTalk": {
1242
1198
  "description": "The `SetTalk` command enables or disables the talk privilege for a Participant in a Conference provided both calls are in the same conference. If 'true', no audio from that Participant is shared with the other Participants of the Conference.",
1243
1199
  "x-percl-command": true,
1200
+ "x-ref-properties": ["false"],
1244
1201
  "allOf": [
1245
1202
  {
1246
1203
  "$ref": "#/components/schemas/PerclCommand"
@@ -1260,16 +1217,17 @@
1260
1217
  "Sms": {
1261
1218
  "description": "The `Sms` command can be used to send an SMS message to a phone number during a phone call. International SMS is disabled by default.",
1262
1219
  "x-percl-command": true,
1220
+ "x-ref-properties": [
1221
+ "\"TEST_STRING\"",
1222
+ "\"TEST_STRING\"",
1223
+ "\"TEST_STRING\""
1224
+ ],
1263
1225
  "allOf": [
1264
1226
  {
1265
1227
  "$ref": "#/components/schemas/PerclCommand"
1266
1228
  },
1267
1229
  {
1268
- "required": [
1269
- "to",
1270
- "from",
1271
- "text"
1272
- ],
1230
+ "required": ["to", "from", "text"],
1273
1231
  "type": "object",
1274
1232
  "properties": {
1275
1233
  "to": {
@@ -1277,6 +1235,7 @@
1277
1235
  "type": "string"
1278
1236
  },
1279
1237
  "from": {
1238
+ "x-is-private-property": true,
1280
1239
  "description": "E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb.",
1281
1240
  "type": "string"
1282
1241
  },
@@ -1308,6 +1267,7 @@
1308
1267
  "TerminateConference": {
1309
1268
  "description": "The `TerminateConference` command terminates an existing Conference. Any active participants are hung up on by FreeClimb. If this is not the desired behavior, use the `RemoveFromConference` command to unbridge Calls that should not be hung up. Note: The Call requesting TerminateConference must be on the same Conference for this command to execute.",
1310
1269
  "x-percl-command": true,
1270
+ "x-no-properties": true,
1311
1271
  "allOf": [
1312
1272
  {
1313
1273
  "$ref": "#/components/schemas/PerclCommand"
@@ -1396,14 +1356,9 @@
1396
1356
  "Capabilities": {
1397
1357
  "description": "Details for which features this number may be used.",
1398
1358
  "type": "object",
1399
- "required": [
1400
- "voice",
1401
- "sms",
1402
- "tollFree",
1403
- "tenDLC",
1404
- "shortCode"
1405
- ],
1359
+ "required": ["voice", "sms", "tollFree", "tenDLC", "shortCode"],
1406
1360
  "x-is-object": true,
1361
+ "x-ref-properties": [false, false, false, false, false],
1407
1362
  "properties": {
1408
1363
  "voice": {
1409
1364
  "description": "Indicates whether a number can be used for voice calls. Replaces voiceEnabled.",
@@ -1435,10 +1390,9 @@
1435
1390
  "TFN": {
1436
1391
  "description": "TollFree Campaign details for this number",
1437
1392
  "type": "object",
1438
- "required": [
1439
- "campaignId"
1440
- ],
1393
+ "required": ["campaignId"],
1441
1394
  "x-is-object": true,
1395
+ "x-ref-properties": ["\"TEST_STRING\""],
1442
1396
  "properties": {
1443
1397
  "campaignId": {
1444
1398
  "description": "alphanumeric identifier for the TollFree campaign associated with this number",
@@ -1794,9 +1748,7 @@
1794
1748
  },
1795
1749
  "BuyIncomingNumberRequest": {
1796
1750
  "type": "object",
1797
- "required": [
1798
- "phoneNumber"
1799
- ],
1751
+ "required": ["phoneNumber"],
1800
1752
  "properties": {
1801
1753
  "phoneNumber": {
1802
1754
  "type": "string",
@@ -1836,6 +1788,7 @@
1836
1788
  "nullable": true
1837
1789
  },
1838
1790
  "from": {
1791
+ "x-is-private-property": true,
1839
1792
  "type": "string",
1840
1793
  "description": "Phone number that initiated this Call.",
1841
1794
  "nullable": true
@@ -1895,9 +1848,7 @@
1895
1848
  },
1896
1849
  "UpdateCallRequest": {
1897
1850
  "type": "object",
1898
- "required": [
1899
- "status"
1900
- ],
1851
+ "required": ["status"],
1901
1852
  "properties": {
1902
1853
  "status": {
1903
1854
  "$ref": "#/components/schemas/UpdateCallRequestStatus"
@@ -1906,12 +1857,10 @@
1906
1857
  },
1907
1858
  "MakeCallRequest": {
1908
1859
  "type": "object",
1909
- "required": [
1910
- "from",
1911
- "to"
1912
- ],
1860
+ "required": ["from", "to"],
1913
1861
  "properties": {
1914
1862
  "from": {
1863
+ "x-is-private-property": true,
1915
1864
  "type": "string",
1916
1865
  "description": "Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb's initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb."
1917
1866
  },
@@ -2177,13 +2126,10 @@
2177
2126
  },
2178
2127
  {
2179
2128
  "type": "object",
2180
- "required": [
2181
- "from",
2182
- "to",
2183
- "text"
2184
- ],
2129
+ "required": ["from", "to", "text"],
2185
2130
  "properties": {
2186
2131
  "from": {
2132
+ "x-is-private-property": true,
2187
2133
  "type": "string",
2188
2134
  "description": "Phone number to use as the sender. This must be an incoming phone number that you have purchased from FreeClimb."
2189
2135
  },
@@ -2202,6 +2148,7 @@
2202
2148
  "mediaUrls": {
2203
2149
  "type": "array",
2204
2150
  "description": "an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile.",
2151
+ "x-is-list": true,
2205
2152
  "items": {
2206
2153
  "type": "string",
2207
2154
  "format": "uri"
@@ -2253,6 +2200,7 @@
2253
2200
  "$ref": "#/components/schemas/MessageStatus"
2254
2201
  },
2255
2202
  "from": {
2203
+ "x-is-private-property": true,
2256
2204
  "type": "string",
2257
2205
  "description": "Phone number in E.164 format that sent the message.",
2258
2206
  "nullable": true
@@ -2295,6 +2243,7 @@
2295
2243
  "mediaUrls": {
2296
2244
  "type": "array",
2297
2245
  "description": "an array of HTTP URLs which were attached this this message",
2246
+ "x-is-list": true,
2298
2247
  "items": {
2299
2248
  "type": "string",
2300
2249
  "format": "uri"
@@ -2552,9 +2501,7 @@
2552
2501
  },
2553
2502
  "FilterLogsRequest": {
2554
2503
  "type": "object",
2555
- "required": [
2556
- "pql"
2557
- ],
2504
+ "required": ["pql"],
2558
2505
  "properties": {
2559
2506
  "pql": {
2560
2507
  "type": "string",
@@ -2617,14 +2564,10 @@
2617
2564
  "type": "string",
2618
2565
  "x-has-writer": true,
2619
2566
  "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
2620
- "enum": [
2621
- "ACTIVE",
2622
- "EXPIRED"
2623
- ],
2624
- "x-enum-varnames": [
2625
- "ACTIVE",
2626
- "EXPIRED"
2627
- ]
2567
+ "x-enum-type": "SMSTenDLCCampaignStatusEnum",
2568
+ "x-enum-type-c-sharp": "StatusEnum",
2569
+ "enum": ["ACTIVE", "EXPIRED"],
2570
+ "x-enum-varnames": ["ACTIVE", "EXPIRED"]
2628
2571
  },
2629
2572
  "createDate": {
2630
2573
  "type": "string",
@@ -2849,12 +2792,7 @@
2849
2792
  ]
2850
2793
  },
2851
2794
  "SMSTenDLCPartnerCampaign": {
2852
- "required": [
2853
- "brandId",
2854
- "campaignId",
2855
- "description",
2856
- "usecase"
2857
- ],
2795
+ "required": ["brandId", "campaignId", "description", "usecase"],
2858
2796
  "type": "object",
2859
2797
  "properties": {
2860
2798
  "accountId": {
@@ -2870,14 +2808,10 @@
2870
2808
  "type": "string",
2871
2809
  "x-has-writer": true,
2872
2810
  "description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
2873
- "enum": [
2874
- "ACTIVE",
2875
- "EXPIRED"
2876
- ],
2877
- "x-enum-varnames": [
2878
- "ACTIVE",
2879
- "EXPIRED"
2880
- ]
2811
+ "x-enum-type": "SMSTenDLCPartnerCampaignStatusEnum",
2812
+ "x-enum-type-c-sharp": "StatusEnum",
2813
+ "enum": ["ACTIVE", "EXPIRED"],
2814
+ "x-enum-varnames": ["ACTIVE", "EXPIRED"]
2881
2815
  },
2882
2816
  "createDate": {
2883
2817
  "type": "string",
@@ -3056,12 +2990,22 @@
3056
2990
  }
3057
2991
  },
3058
2992
  "SMSTenDLCPartnerCampaignBrand": {
3059
- "required": [
3060
- "email",
3061
- "phone"
3062
- ],
2993
+ "required": ["email", "phone"],
3063
2994
  "type": "object",
3064
2995
  "x-is-object": true,
2996
+ "x-sms-ten-dlc-partner-campaign-brand": true,
2997
+ "x-ref-properties": [
2998
+ "\"TEST_STRING\"",
2999
+ "\"TEST_STRING\"",
3000
+ "\"TEST_STRING\"",
3001
+ "\"TEST_STRING\"",
3002
+ "\"TEST_STRING\"",
3003
+ "\"TEST_STRING\"",
3004
+ "\"TEST_STRING\"",
3005
+ "\"TEST_STRING\"",
3006
+ "new Dictionary<string, object>()",
3007
+ "1"
3008
+ ],
3065
3009
  "properties": {
3066
3010
  "accountId": {
3067
3011
  "type": "string",
@@ -3163,6 +3107,7 @@
3163
3107
  "vertical"
3164
3108
  ],
3165
3109
  "type": "object",
3110
+ "x-sms-ten-dlc-brand": true,
3166
3111
  "properties": {
3167
3112
  "accountId": {
3168
3113
  "type": "string",
@@ -3174,6 +3119,8 @@
3174
3119
  "type": "string",
3175
3120
  "x-has-writer": true,
3176
3121
  "description": "Entity type behind the brand. This is the form of business establishment.",
3122
+ "x-enum-type": "SMSTenDLCBrandEntityTypeEnum",
3123
+ "x-enum-type-c-sharp": "EntityTypeEnum",
3177
3124
  "enum": [
3178
3125
  "PRIVATE_PROFIT",
3179
3126
  "PUBLIC_PROFIT",
@@ -3287,6 +3234,8 @@
3287
3234
  "x-has-writer": true,
3288
3235
  "description": "(Required for public company) stock exchange.",
3289
3236
  "example": "NASDAQ",
3237
+ "x-enum-type": "SMSTenDLCBrandStockExchangeEnum",
3238
+ "x-enum-type-c-sharp": "StockExchangeEnum",
3290
3239
  "enum": [
3291
3240
  "NONE",
3292
3241
  "NASDAQ",
@@ -3361,6 +3310,8 @@
3361
3310
  "type": "string",
3362
3311
  "x-has-writer": true,
3363
3312
  "description": "Brand relationship to the CSP",
3313
+ "x-enum-type": "SMSTenDLCBrandBrandRelationshipEnum",
3314
+ "x-enum-type-c-sharp": "BrandRelationshipEnum",
3364
3315
  "enum": [
3365
3316
  "BASIC_ACCOUNT",
3366
3317
  "SMALL_ACCOUNT",
@@ -3389,18 +3340,10 @@
3389
3340
  "altBusinessIdType": {
3390
3341
  "type": "string",
3391
3342
  "x-has-writer": true,
3392
- "enum": [
3393
- "NONE",
3394
- "DUNS",
3395
- "GIIN",
3396
- "LEI"
3397
- ],
3398
- "x-enum-varnames": [
3399
- "NONE",
3400
- "DUNS",
3401
- "GIIN",
3402
- "LEI"
3403
- ],
3343
+ "x-enum-type": "SMSTenDLCBrandAltBusinessIdTypeEnum",
3344
+ "x-enum-type-c-sharp": "AltBusinessIdTypeEnum",
3345
+ "enum": ["NONE", "DUNS", "GIIN", "LEI"],
3346
+ "x-enum-varnames": ["NONE", "DUNS", "GIIN", "LEI"],
3404
3347
  "description": "The type of the Alternative business identifier"
3405
3348
  },
3406
3349
  "universalEin": {
@@ -3431,6 +3374,8 @@
3431
3374
  "type": "string",
3432
3375
  "x-has-writer": true,
3433
3376
  "description": "TCR assessment of the brand identification status.",
3377
+ "x-enum-type": "SMSTenDLCBrandIdentityStatusEnum",
3378
+ "x-enum-type-c-sharp": "IdentityStatusEnum",
3434
3379
  "enum": [
3435
3380
  "SELF_DECLARED",
3436
3381
  "UNVERIFIED",
@@ -3515,6 +3460,7 @@
3515
3460
  "dateUpdated",
3516
3461
  "revision"
3517
3462
  ],
3463
+ "x-sms-toll-free-campaign": true,
3518
3464
  "properties": {
3519
3465
  "accountId": {
3520
3466
  "type": "string",
@@ -3532,6 +3478,8 @@
3532
3478
  "type": "string",
3533
3479
  "x-has-writer": true,
3534
3480
  "description": "Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status. ",
3481
+ "x-enum-type": "SMSTollFreeCampaignRegistrationStatusEnum",
3482
+ "x-enum-type-c-sharp": "RegistrationStatusEnum",
3535
3483
  "enum": [
3536
3484
  "UNREGISTERED",
3537
3485
  "INITIATED",
@@ -3563,58 +3511,75 @@
3563
3511
  "x-stoplight": {
3564
3512
  "id": "u509r3zqc38ze"
3565
3513
  },
3566
- "x-percl-command": true,
3567
- "type": "object",
3568
3514
  "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.",
3569
- "properties": {
3570
- "actionUrl": {
3571
- "type": "string"
3572
- },
3573
- "playBeep": {
3574
- "type": "boolean",
3575
- "default": false
3515
+ "x-percl-command": true,
3516
+ "x-ref-properties": [
3517
+ "\"TEST_STRING\"",
3518
+ "false",
3519
+ "new TranscribeUtteranceAllOfRecord()",
3520
+ "false",
3521
+ "false",
3522
+ "new List<Object>()",
3523
+ "\"TEST_STRING\""
3524
+ ],
3525
+ "allOf": [
3526
+ {
3527
+ "$ref": "#/components/schemas/PerclCommand"
3576
3528
  },
3577
- "record": {
3529
+ {
3530
+ "required": ["actionUrl"],
3578
3531
  "type": "object",
3532
+ "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.",
3579
3533
  "properties": {
3580
- "saveRecording": {
3534
+ "actionUrl": {
3535
+ "type": "string"
3536
+ },
3537
+ "playBeep": {
3581
3538
  "type": "boolean",
3582
3539
  "default": false
3583
3540
  },
3584
- "maxLengthSec": {
3585
- "type": "integer",
3586
- "minimum": 1,
3587
- "maximum": 60,
3588
- "default": 60
3541
+ "record": {
3542
+ "type": "object",
3543
+ "x-is-object": true,
3544
+ "properties": {
3545
+ "saveRecording": {
3546
+ "type": "boolean",
3547
+ "default": false
3548
+ },
3549
+ "maxLengthSec": {
3550
+ "type": "integer",
3551
+ "minimum": 1,
3552
+ "maximum": 60,
3553
+ "default": 60
3554
+ },
3555
+ "rcrdTerminationSilenceTimeMs": {
3556
+ "type": "integer",
3557
+ "exclusiveMinimum": true,
3558
+ "minimum": 0,
3559
+ "maximum": 3000
3560
+ }
3561
+ }
3589
3562
  },
3590
- "rcrdTerminationSilenceTimeMs": {
3591
- "type": "integer",
3592
- "exclusiveMinimum": true,
3593
- "minimum": 0,
3594
- "maximum": 3000
3563
+ "privacyForLogging": {
3564
+ "type": "boolean",
3565
+ "default": false
3566
+ },
3567
+ "privacyForRecording": {
3568
+ "type": "boolean",
3569
+ "default": false
3570
+ },
3571
+ "prompts": {
3572
+ "type": "array",
3573
+ "x-is-list": true,
3574
+ "items": {}
3595
3575
  }
3596
3576
  }
3597
- },
3598
- "privacyForLogging": {
3599
- "type": "boolean",
3600
- "default": false
3601
- },
3602
- "privacyForRecording": {
3603
- "type": "boolean",
3604
- "default": false
3605
- },
3606
- "prompts": {
3607
- "type": "array",
3608
- "items": {}
3609
3577
  }
3610
- },
3611
- "required": [
3612
- "actionUrl"
3613
3578
  ],
3614
3579
  "x-examples": {
3615
3580
  "Example 1": {
3616
3581
  "TranscribeUtterance": {
3617
- "actionUrl": "http://foo.vail/handleTranscription",
3582
+ "actionUrl": "http://yoursite.com/handleTranscription",
3618
3583
  "record": {
3619
3584
  "maxLengthSec": 60,
3620
3585
  "saveRecording": true,
@@ -3634,11 +3599,8 @@
3634
3599
  },
3635
3600
  "CreateWebRTCToken": {
3636
3601
  "type": "object",
3637
- "required": [
3638
- "to",
3639
- "from",
3640
- "uses"
3641
- ],
3602
+ "required": ["to", "from", "uses"],
3603
+ "x-web-rtc": true,
3642
3604
  "additionalProperties": false,
3643
3605
  "properties": {
3644
3606
  "to": {
@@ -3646,6 +3608,7 @@
3646
3608
  "description": "E.164 formatted phone number to which calls using this token will be made."
3647
3609
  },
3648
3610
  "from": {
3611
+ "x-is-private-property": true,
3649
3612
  "type": "string",
3650
3613
  "description": "E.164 formatted phone number owned by the reqeusting account from which calls using this token will be made."
3651
3614
  },
@@ -4532,8 +4495,8 @@
4532
4495
  "/Accounts/{accountId}/Calls/WebRTC/Token": {
4533
4496
  "post": {
4534
4497
  "summary": "Make a JWT for WebRTC calling",
4535
- "description": "Make a JWT for WebRTC calling",
4536
4498
  "operationId": "make-a-webrtc-jwt",
4499
+ "x-web-rtc": true,
4537
4500
  "parameters": [
4538
4501
  {
4539
4502
  "$ref": "#/components/parameters/AccountId"
@@ -4923,15 +4886,6 @@
4923
4886
  "type": "string"
4924
4887
  }
4925
4888
  },
4926
- {
4927
- "name": "conferenceId",
4928
- "in": "query",
4929
- "description": "Show only Recordings made during the conference with this ID.",
4930
- "required": false,
4931
- "schema": {
4932
- "type": "string"
4933
- }
4934
- },
4935
4889
  {
4936
4890
  "name": "dateCreated",
4937
4891
  "in": "query",
@@ -4943,6 +4897,15 @@
4943
4897
  },
4944
4898
  {
4945
4899
  "$ref": "#/components/parameters/AccountId"
4900
+ },
4901
+ {
4902
+ "name": "conferenceId",
4903
+ "in": "path",
4904
+ "description": "Show only Recordings made during the conference with this ID.",
4905
+ "required": true,
4906
+ "schema": {
4907
+ "type": "string"
4908
+ }
4946
4909
  }
4947
4910
  ],
4948
4911
  "responses": {
@@ -6110,11 +6073,5 @@
6110
6073
  "x-explorer-enabled": true,
6111
6074
  "x-proxy-enabled": true,
6112
6075
  "x-samples-enabled": false,
6113
- "x-samples-languages": [
6114
- "curl",
6115
- "node",
6116
- "ruby",
6117
- "javascript",
6118
- "python"
6119
- ]
6120
- }
6076
+ "x-samples-languages": ["curl", "node", "ruby", "javascript", "python"]
6077
+ }