freeclimb 3.0.1 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (296) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/Gemfile +4 -2
  4. data/Gemfile.lock +38 -19
  5. data/README.md +37 -35
  6. data/docs/AccountRequest.md +9 -8
  7. data/docs/AccountResult.md +27 -26
  8. data/docs/AccountResultAllOf.md +19 -18
  9. data/docs/AddToConference.md +25 -24
  10. data/docs/AddToConferenceAllOf.md +25 -24
  11. data/docs/ApplicationList.md +21 -20
  12. data/docs/ApplicationListAllOf.md +7 -6
  13. data/docs/ApplicationRequest.md +19 -18
  14. data/docs/ApplicationResult.md +31 -30
  15. data/docs/ApplicationResultAllOf.md +23 -22
  16. data/docs/AvailableNumber.md +17 -16
  17. data/docs/AvailableNumberList.md +21 -20
  18. data/docs/AvailableNumberListAllOf.md +7 -6
  19. data/docs/BuyIncomingNumberRequest.md +11 -10
  20. data/docs/CallList.md +21 -20
  21. data/docs/CallListAllOf.md +7 -6
  22. data/docs/CallResult.md +43 -44
  23. data/docs/CallResultAllOf.md +35 -36
  24. data/docs/Capabilities.md +26 -0
  25. data/docs/ConferenceList.md +21 -20
  26. data/docs/ConferenceListAllOf.md +7 -6
  27. data/docs/ConferenceParticipantList.md +21 -20
  28. data/docs/ConferenceParticipantListAllOf.md +7 -6
  29. data/docs/ConferenceParticipantResult.md +25 -24
  30. data/docs/ConferenceParticipantResultAllOf.md +17 -16
  31. data/docs/ConferenceResult.md +33 -32
  32. data/docs/ConferenceResultAllOf.md +25 -24
  33. data/docs/CreateConference.md +17 -16
  34. data/docs/CreateConferenceAllOf.md +17 -16
  35. data/docs/CreateConferenceRequest.md +15 -14
  36. data/docs/DefaultApi.md +1629 -629
  37. data/docs/Dequeue.md +3 -4
  38. data/docs/Enqueue.md +13 -12
  39. data/docs/EnqueueAllOf.md +13 -12
  40. data/docs/FilterLogsRequest.md +7 -6
  41. data/docs/GetDigits.md +23 -22
  42. data/docs/GetDigitsAllOf.md +23 -22
  43. data/docs/GetSpeech.md +31 -30
  44. data/docs/GetSpeechAllOf.md +31 -30
  45. data/docs/Hangup.md +7 -6
  46. data/docs/HangupAllOf.md +7 -6
  47. data/docs/IncomingNumberList.md +21 -20
  48. data/docs/IncomingNumberListAllOf.md +7 -6
  49. data/docs/IncomingNumberRequest.md +9 -8
  50. data/docs/IncomingNumberResult.md +33 -30
  51. data/docs/IncomingNumberResultAllOf.md +25 -22
  52. data/docs/LogList.md +21 -20
  53. data/docs/LogListAllOf.md +7 -6
  54. data/docs/LogResult.md +19 -18
  55. data/docs/MakeCallRequest.md +25 -24
  56. data/docs/MessageRequest.md +23 -22
  57. data/docs/MessageRequestAllOf.md +15 -14
  58. data/docs/MessageResult.md +29 -28
  59. data/docs/MessageResultAllOf.md +21 -20
  60. data/docs/MessagesList.md +21 -20
  61. data/docs/MessagesListAllOf.md +7 -6
  62. data/docs/MutableResourceModel.md +13 -12
  63. data/docs/OutDial.md +25 -24
  64. data/docs/OutDialAllOf.md +25 -24
  65. data/docs/PaginationModel.md +19 -18
  66. data/docs/Pause.md +7 -6
  67. data/docs/PauseAllOf.md +7 -6
  68. data/docs/PerclCommand.md +7 -6
  69. data/docs/PerclScript.md +7 -6
  70. data/docs/Play.md +13 -12
  71. data/docs/PlayAllOf.md +13 -12
  72. data/docs/PlayEarlyMedia.md +7 -6
  73. data/docs/PlayEarlyMediaAllOf.md +7 -6
  74. data/docs/QueueList.md +21 -20
  75. data/docs/QueueListAllOf.md +7 -6
  76. data/docs/QueueMember.md +15 -14
  77. data/docs/QueueMemberList.md +21 -20
  78. data/docs/QueueMemberListAllOf.md +7 -6
  79. data/docs/QueueRequest.md +9 -8
  80. data/docs/QueueResult.md +27 -26
  81. data/docs/QueueResultAllOf.md +19 -18
  82. data/docs/RecordUtterance.md +19 -18
  83. data/docs/RecordUtteranceAllOf.md +19 -18
  84. data/docs/RecordingList.md +21 -20
  85. data/docs/RecordingListAllOf.md +7 -6
  86. data/docs/RecordingResult.md +23 -22
  87. data/docs/RecordingResultAllOf.md +15 -14
  88. data/docs/Redirect.md +7 -6
  89. data/docs/RedirectAllOf.md +7 -6
  90. data/docs/Reject.md +7 -6
  91. data/docs/RejectAllOf.md +7 -6
  92. data/docs/RemoveFromConference.md +7 -6
  93. data/docs/RemoveFromConferenceAllOf.md +7 -6
  94. data/docs/Say.md +15 -14
  95. data/docs/SayAllOf.md +15 -14
  96. data/docs/SendDigits.md +11 -10
  97. data/docs/SendDigitsAllOf.md +11 -10
  98. data/docs/SetListen.md +9 -8
  99. data/docs/SetListenAllOf.md +9 -8
  100. data/docs/SetTalk.md +9 -8
  101. data/docs/SetTalkAllOf.md +9 -8
  102. data/docs/Sms.md +13 -12
  103. data/docs/SmsAllOf.md +13 -12
  104. data/docs/StartRecordCall.md +3 -4
  105. data/docs/TerminateConference.md +7 -6
  106. data/docs/TerminateConferenceAllOf.md +7 -6
  107. data/docs/UpdateCallRequest.md +7 -6
  108. data/docs/UpdateConferenceParticipantRequest.md +9 -8
  109. data/docs/UpdateConferenceRequest.md +11 -10
  110. data/freeclimb.gemspec +3 -4
  111. data/lib/freeclimb/api/default_api.rb +449 -263
  112. data/lib/freeclimb/api_client.rb +55 -51
  113. data/lib/freeclimb/api_error.rb +2 -2
  114. data/lib/freeclimb/configuration.rb +41 -11
  115. data/lib/freeclimb/models/account_request.rb +20 -8
  116. data/lib/freeclimb/models/account_result.rb +39 -8
  117. data/lib/freeclimb/models/account_result_all_of.rb +39 -8
  118. data/lib/freeclimb/models/add_to_conference.rb +21 -8
  119. data/lib/freeclimb/models/add_to_conference_all_of.rb +20 -8
  120. data/lib/freeclimb/models/application_list.rb +28 -8
  121. data/lib/freeclimb/models/application_list_all_of.rb +21 -8
  122. data/lib/freeclimb/models/application_request.rb +20 -8
  123. data/lib/freeclimb/models/application_result.rb +29 -8
  124. data/lib/freeclimb/models/application_result_all_of.rb +29 -8
  125. data/lib/freeclimb/models/available_number.rb +35 -19
  126. data/lib/freeclimb/models/available_number_list.rb +28 -8
  127. data/lib/freeclimb/models/available_number_list_all_of.rb +21 -8
  128. data/lib/freeclimb/models/buy_incoming_number_request.rb +20 -8
  129. data/lib/freeclimb/models/call_list.rb +28 -8
  130. data/lib/freeclimb/models/call_list_all_of.rb +21 -8
  131. data/lib/freeclimb/models/call_result.rb +36 -21
  132. data/lib/freeclimb/models/call_result_all_of.rb +36 -21
  133. data/lib/freeclimb/models/capabilities.rb +265 -0
  134. data/lib/freeclimb/models/conference_list.rb +28 -8
  135. data/lib/freeclimb/models/conference_list_all_of.rb +21 -8
  136. data/lib/freeclimb/models/conference_participant_list.rb +28 -8
  137. data/lib/freeclimb/models/conference_participant_list_all_of.rb +21 -8
  138. data/lib/freeclimb/models/conference_participant_result.rb +26 -8
  139. data/lib/freeclimb/models/conference_participant_result_all_of.rb +26 -8
  140. data/lib/freeclimb/models/conference_result.rb +30 -8
  141. data/lib/freeclimb/models/conference_result_all_of.rb +30 -8
  142. data/lib/freeclimb/models/create_conference.rb +21 -8
  143. data/lib/freeclimb/models/create_conference_all_of.rb +20 -8
  144. data/lib/freeclimb/models/create_conference_request.rb +20 -8
  145. data/lib/freeclimb/models/dequeue.rb +21 -8
  146. data/lib/freeclimb/models/enqueue.rb +21 -8
  147. data/lib/freeclimb/models/enqueue_all_of.rb +20 -8
  148. data/lib/freeclimb/models/filter_logs_request.rb +20 -8
  149. data/lib/freeclimb/models/get_digits.rb +21 -8
  150. data/lib/freeclimb/models/get_digits_all_of.rb +20 -8
  151. data/lib/freeclimb/models/get_speech.rb +21 -8
  152. data/lib/freeclimb/models/get_speech_all_of.rb +20 -8
  153. data/lib/freeclimb/models/hangup.rb +21 -8
  154. data/lib/freeclimb/models/hangup_all_of.rb +20 -8
  155. data/lib/freeclimb/models/incoming_number_list.rb +28 -8
  156. data/lib/freeclimb/models/incoming_number_list_all_of.rb +21 -8
  157. data/lib/freeclimb/models/incoming_number_request.rb +20 -8
  158. data/lib/freeclimb/models/incoming_number_result.rb +39 -9
  159. data/lib/freeclimb/models/incoming_number_result_all_of.rb +39 -9
  160. data/lib/freeclimb/models/log_list.rb +28 -8
  161. data/lib/freeclimb/models/log_list_all_of.rb +21 -8
  162. data/lib/freeclimb/models/log_result.rb +27 -8
  163. data/lib/freeclimb/models/make_call_request.rb +22 -8
  164. data/lib/freeclimb/models/message_request.rb +20 -8
  165. data/lib/freeclimb/models/message_request_all_of.rb +20 -8
  166. data/lib/freeclimb/models/message_result.rb +28 -8
  167. data/lib/freeclimb/models/message_result_all_of.rb +28 -8
  168. data/lib/freeclimb/models/messages_list.rb +28 -8
  169. data/lib/freeclimb/models/messages_list_all_of.rb +21 -8
  170. data/lib/freeclimb/models/mutable_resource_model.rb +20 -8
  171. data/lib/freeclimb/models/out_dial.rb +21 -8
  172. data/lib/freeclimb/models/out_dial_all_of.rb +20 -8
  173. data/lib/freeclimb/models/pagination_model.rb +27 -8
  174. data/lib/freeclimb/models/pause.rb +21 -8
  175. data/lib/freeclimb/models/pause_all_of.rb +20 -8
  176. data/lib/freeclimb/models/percl_command.rb +39 -8
  177. data/lib/freeclimb/models/percl_script.rb +24 -8
  178. data/lib/freeclimb/models/play.rb +21 -8
  179. data/lib/freeclimb/models/play_all_of.rb +20 -8
  180. data/lib/freeclimb/models/play_early_media.rb +21 -8
  181. data/lib/freeclimb/models/play_early_media_all_of.rb +20 -8
  182. data/lib/freeclimb/models/queue_list.rb +28 -8
  183. data/lib/freeclimb/models/queue_list_all_of.rb +21 -8
  184. data/lib/freeclimb/models/queue_member.rb +25 -8
  185. data/lib/freeclimb/models/queue_member_list.rb +28 -8
  186. data/lib/freeclimb/models/queue_member_list_all_of.rb +21 -8
  187. data/lib/freeclimb/models/queue_request.rb +22 -8
  188. data/lib/freeclimb/models/queue_result.rb +27 -8
  189. data/lib/freeclimb/models/queue_result_all_of.rb +27 -8
  190. data/lib/freeclimb/models/record_utterance.rb +21 -8
  191. data/lib/freeclimb/models/record_utterance_all_of.rb +20 -8
  192. data/lib/freeclimb/models/recording_list.rb +28 -8
  193. data/lib/freeclimb/models/recording_list_all_of.rb +21 -8
  194. data/lib/freeclimb/models/recording_result.rb +25 -8
  195. data/lib/freeclimb/models/recording_result_all_of.rb +25 -8
  196. data/lib/freeclimb/models/redirect.rb +21 -8
  197. data/lib/freeclimb/models/redirect_all_of.rb +20 -8
  198. data/lib/freeclimb/models/reject.rb +21 -8
  199. data/lib/freeclimb/models/reject_all_of.rb +20 -8
  200. data/lib/freeclimb/models/remove_from_conference.rb +21 -8
  201. data/lib/freeclimb/models/remove_from_conference_all_of.rb +20 -8
  202. data/lib/freeclimb/models/say.rb +21 -8
  203. data/lib/freeclimb/models/say_all_of.rb +20 -8
  204. data/lib/freeclimb/models/send_digits.rb +21 -8
  205. data/lib/freeclimb/models/send_digits_all_of.rb +20 -8
  206. data/lib/freeclimb/models/set_listen.rb +21 -8
  207. data/lib/freeclimb/models/set_listen_all_of.rb +20 -8
  208. data/lib/freeclimb/models/set_talk.rb +21 -8
  209. data/lib/freeclimb/models/set_talk_all_of.rb +20 -8
  210. data/lib/freeclimb/models/sms.rb +21 -8
  211. data/lib/freeclimb/models/sms_all_of.rb +20 -8
  212. data/lib/freeclimb/models/start_record_call.rb +21 -8
  213. data/lib/freeclimb/models/terminate_conference.rb +21 -8
  214. data/lib/freeclimb/models/terminate_conference_all_of.rb +20 -8
  215. data/lib/freeclimb/models/update_call_request.rb +20 -8
  216. data/lib/freeclimb/models/update_conference_participant_request.rb +20 -8
  217. data/lib/freeclimb/models/update_conference_request.rb +20 -8
  218. data/lib/freeclimb/version.rb +3 -3
  219. data/lib/freeclimb.rb +25 -53
  220. data/spec/api/default_api_spec.rb +1095 -668
  221. data/spec/api_client_spec.rb +7 -7
  222. data/spec/configuration_spec.rb +13 -5
  223. data/spec/factories.rb +80 -0
  224. data/spec/models/account_request_spec.rb +20 -13
  225. data/spec/models/account_result_spec.rb +81 -12
  226. data/spec/models/add_to_conference_spec.rb +7 -14
  227. data/spec/models/application_list_spec.rb +55 -12
  228. data/spec/models/application_request_spec.rb +49 -12
  229. data/spec/models/application_result_spec.rb +85 -12
  230. data/spec/models/available_number_list_spec.rb +55 -13
  231. data/spec/models/available_number_spec.rb +43 -12
  232. data/spec/models/buy_incoming_number_request_spec.rb +25 -12
  233. data/spec/models/call_list_spec.rb +55 -13
  234. data/spec/models/call_result_spec.rb +124 -12
  235. data/spec/models/capabilities_spec.rb +58 -0
  236. data/spec/models/conference_list_spec.rb +55 -12
  237. data/spec/models/conference_participant_list_spec.rb +55 -12
  238. data/spec/models/conference_participant_result_spec.rb +67 -12
  239. data/spec/models/conference_result_spec.rb +99 -13
  240. data/spec/models/create_conference_request_spec.rb +41 -13
  241. data/spec/models/create_conference_spec.rb +7 -14
  242. data/spec/models/dequeue_spec.rb +7 -14
  243. data/spec/models/enqueue_spec.rb +7 -14
  244. data/spec/models/filter_logs_request_spec.rb +15 -14
  245. data/spec/models/get_digits_spec.rb +13 -14
  246. data/spec/models/get_speech_spec.rb +8 -15
  247. data/spec/models/hangup_spec.rb +5 -12
  248. data/spec/models/incoming_number_list_spec.rb +55 -13
  249. data/spec/models/incoming_number_request_spec.rb +20 -13
  250. data/spec/models/incoming_number_result_spec.rb +91 -13
  251. data/spec/models/log_list_spec.rb +55 -12
  252. data/spec/models/log_result_spec.rb +53 -12
  253. data/spec/models/make_call_request_spec.rb +67 -12
  254. data/spec/models/message_request_spec.rb +61 -13
  255. data/spec/models/message_result_spec.rb +83 -12
  256. data/spec/models/messages_list_spec.rb +55 -12
  257. data/spec/models/mutable_resource_model_spec.rb +31 -13
  258. data/spec/models/out_dial_spec.rb +13 -14
  259. data/spec/models/pagination_model_spec.rb +49 -12
  260. data/spec/models/pause_spec.rb +7 -14
  261. data/spec/models/percl_command_spec.rb +7 -14
  262. data/spec/models/percl_script_spec.rb +7 -14
  263. data/spec/models/play_early_media_spec.rb +7 -14
  264. data/spec/models/play_spec.rb +13 -14
  265. data/spec/models/queue_list_spec.rb +54 -12
  266. data/spec/models/queue_member_list_spec.rb +55 -12
  267. data/spec/models/queue_member_spec.rb +37 -13
  268. data/spec/models/queue_request_spec.rb +20 -14
  269. data/spec/models/queue_result_spec.rb +73 -12
  270. data/spec/models/record_utterance_spec.rb +13 -14
  271. data/spec/models/recording_list_spec.rb +55 -12
  272. data/spec/models/recording_result_spec.rb +61 -12
  273. data/spec/models/redirect_spec.rb +7 -14
  274. data/spec/models/reject_spec.rb +5 -12
  275. data/spec/models/remove_from_conference_spec.rb +7 -14
  276. data/spec/models/say_spec.rb +8 -15
  277. data/spec/models/send_digits_spec.rb +13 -14
  278. data/spec/models/set_listen_spec.rb +7 -14
  279. data/spec/models/set_talk_spec.rb +7 -14
  280. data/spec/models/sms_spec.rb +7 -14
  281. data/spec/models/start_record_call_spec.rb +7 -14
  282. data/spec/models/terminate_conference_spec.rb +7 -14
  283. data/spec/models/update_call_request_spec.rb +19 -14
  284. data/spec/models/update_conference_participant_request_spec.rb +20 -13
  285. data/spec/models/update_conference_request_spec.rb +29 -12
  286. data/spec/quickstart_spec.rb +10 -0
  287. data/spec/spec_helper.rb +62 -7
  288. metadata +17 -38
  289. data/freeclimb-2.0.3.gem +0 -0
  290. data/freeclimb-2.1.0.gem +0 -0
  291. data/freeclimb-2.1.1.gem +0 -0
  292. data/freeclimb-2.1.2.gem +0 -0
  293. data/freeclimb-2.2.0.gem +0 -0
  294. data/freeclimb-3.0.0.gem +0 -0
  295. data/lib/freeclimb/utils.rb +0 -34
  296. data/spec/api/web_mocks.rb +0 -473
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **queue_members** | [**Array<QueueMember>**](QueueMember.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **queue_members** | [**Array<QueueMember>**](QueueMember.md) | | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::QueueMemberListAllOf.new(queue_members: nil)
14
+ instance = Freeclimb::QueueMemberListAllOf.new(
15
+ queue_members: null
16
+ )
15
17
  ```
16
18
 
17
-
data/docs/QueueRequest.md CHANGED
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **_alias** | **String** | Description for this Queue. Max length is 64 characters. | [optional]
8
- **max_size** | **Integer** | Maximum number of calls this queue can hold. Default is 100. Maximum is 1000. **Note:** Reducing the maxSize of a Queue causes the Queue to reject incoming requests until it shrinks below the new value of maxSize. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_alias** | **String** | Description for this Queue. Max length is 64 characters. | [optional] |
8
+ | **max_size** | **Integer** | Maximum number of calls this queue can hold. Default is 100. Maximum is 1000. **Note:** Reducing the maxSize of a Queue causes the Queue to reject incoming requests until it shrinks below the new value of maxSize. | [optional][default to 100] |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
13
  require 'freeclimb'
14
14
 
15
- instance = Freeclimb::QueueRequest.new(_alias: nil,
16
- max_size: nil)
15
+ instance = Freeclimb::QueueRequest.new(
16
+ _alias: null,
17
+ max_size: null
18
+ )
17
19
  ```
18
20
 
19
-
data/docs/QueueResult.md CHANGED
@@ -2,36 +2,37 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
8
- **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
9
- **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
- **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
- **account_id** | **String** | ID of the account that created this Queue. | [optional]
12
- **queue_id** | **String** | A string that uniquely identifies this Queue resource. | [optional]
13
- **_alias** | **String** | A description for this Queue. | [optional]
14
- **max_size** | **Integer** | The maximum number of Calls permitted in the Queue. Default is 100. Maximum is 1000. | [optional]
15
- **current_size** | **String** | Count of Calls currently in the Queue. | [optional]
16
- **average_wait_time** | **String** | Average wait time (in seconds) of all Calls in the Queue. | [optional]
17
- **subresource_uris** | [**Object**](.md) | List of subresources for this Queue (which includes Queue members). | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] |
8
+ | **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
9
+ | **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
10
+ | **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
11
+ | **account_id** | **String** | ID of the account that created this Queue. | [optional] |
12
+ | **queue_id** | **String** | A string that uniquely identifies this Queue resource. | [optional] |
13
+ | **_alias** | **String** | A description for this Queue. | [optional] |
14
+ | **max_size** | **Integer** | The maximum number of Calls permitted in the Queue. Default is 100. Maximum is 1000. | [optional] |
15
+ | **current_size** | **String** | Count of Calls currently in the Queue. | [optional] |
16
+ | **average_wait_time** | **String** | Average wait time (in seconds) of all Calls in the Queue. | [optional] |
17
+ | **subresource_uris** | **Object** | List of subresources for this Queue (which includes Queue members). | [optional] |
18
18
 
19
- ## Code Sample
19
+ ## Example
20
20
 
21
21
  ```ruby
22
22
  require 'freeclimb'
23
23
 
24
- instance = Freeclimb::QueueResult.new(uri: nil,
25
- date_created: nil,
26
- date_updated: nil,
27
- revision: nil,
28
- account_id: nil,
29
- queue_id: nil,
30
- _alias: nil,
31
- max_size: nil,
32
- current_size: nil,
33
- average_wait_time: nil,
34
- subresource_uris: nil)
24
+ instance = Freeclimb::QueueResult.new(
25
+ uri: null,
26
+ date_created: null,
27
+ date_updated: null,
28
+ revision: null,
29
+ account_id: null,
30
+ queue_id: null,
31
+ _alias: null,
32
+ max_size: null,
33
+ current_size: null,
34
+ average_wait_time: null,
35
+ subresource_uris: null
36
+ )
35
37
  ```
36
38
 
37
-
@@ -2,28 +2,29 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **account_id** | **String** | ID of the account that created this Queue. | [optional]
8
- **queue_id** | **String** | A string that uniquely identifies this Queue resource. | [optional]
9
- **_alias** | **String** | A description for this Queue. | [optional]
10
- **max_size** | **Integer** | The maximum number of Calls permitted in the Queue. Default is 100. Maximum is 1000. | [optional]
11
- **current_size** | **String** | Count of Calls currently in the Queue. | [optional]
12
- **average_wait_time** | **String** | Average wait time (in seconds) of all Calls in the Queue. | [optional]
13
- **subresource_uris** | [**Object**](.md) | List of subresources for this Queue (which includes Queue members). | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_id** | **String** | ID of the account that created this Queue. | [optional] |
8
+ | **queue_id** | **String** | A string that uniquely identifies this Queue resource. | [optional] |
9
+ | **_alias** | **String** | A description for this Queue. | [optional] |
10
+ | **max_size** | **Integer** | The maximum number of Calls permitted in the Queue. Default is 100. Maximum is 1000. | [optional] |
11
+ | **current_size** | **String** | Count of Calls currently in the Queue. | [optional] |
12
+ | **average_wait_time** | **String** | Average wait time (in seconds) of all Calls in the Queue. | [optional] |
13
+ | **subresource_uris** | **Object** | List of subresources for this Queue (which includes Queue members). | [optional] |
14
14
 
15
- ## Code Sample
15
+ ## Example
16
16
 
17
17
  ```ruby
18
18
  require 'freeclimb'
19
19
 
20
- instance = Freeclimb::QueueResultAllOf.new(account_id: nil,
21
- queue_id: nil,
22
- _alias: nil,
23
- max_size: nil,
24
- current_size: nil,
25
- average_wait_time: nil,
26
- subresource_uris: nil)
20
+ instance = Freeclimb::QueueResultAllOf.new(
21
+ account_id: null,
22
+ queue_id: null,
23
+ _alias: null,
24
+ max_size: null,
25
+ current_size: null,
26
+ average_wait_time: null,
27
+ subresource_uris: null
28
+ )
27
29
  ```
28
30
 
29
-
@@ -2,28 +2,29 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **action_url** | **String** | URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing. |
8
- **silence_timeout_ms** | **Integer** | Interval of silence that should elapse before ending the recording. | [optional]
9
- **finish_on_key** | **String** | Key that triggers the end of the recording. any digit, '#', or '*' | [optional]
10
- **max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional]
11
- **play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional]
12
- **auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional]
13
- **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **action_url** | **String** | URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing. | |
8
+ | **silence_timeout_ms** | **Integer** | Interval of silence that should elapse before ending the recording. | [optional] |
9
+ | **finish_on_key** | **String** | Key that triggers the end of the recording. any digit, '#', or '*' | [optional] |
10
+ | **max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional] |
11
+ | **play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional] |
12
+ | **auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional] |
13
+ | **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
14
14
 
15
- ## Code Sample
15
+ ## Example
16
16
 
17
17
  ```ruby
18
18
  require 'freeclimb'
19
19
 
20
- instance = Freeclimb::RecordUtterance.new(action_url: nil,
21
- silence_timeout_ms: nil,
22
- finish_on_key: nil,
23
- max_length_sec: nil,
24
- play_beep: nil,
25
- auto_start: nil,
26
- privacy_mode: nil)
20
+ instance = Freeclimb::RecordUtterance.new(
21
+ action_url: null,
22
+ silence_timeout_ms: null,
23
+ finish_on_key: null,
24
+ max_length_sec: null,
25
+ play_beep: null,
26
+ auto_start: null,
27
+ privacy_mode: null
28
+ )
27
29
  ```
28
30
 
29
-
@@ -2,28 +2,29 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **action_url** | **String** | URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing. |
8
- **silence_timeout_ms** | **Integer** | Interval of silence that should elapse before ending the recording. | [optional]
9
- **finish_on_key** | **String** | Key that triggers the end of the recording. any digit, '#', or '*' | [optional]
10
- **max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional]
11
- **play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional]
12
- **auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional]
13
- **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **action_url** | **String** | URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing. | |
8
+ | **silence_timeout_ms** | **Integer** | Interval of silence that should elapse before ending the recording. | [optional] |
9
+ | **finish_on_key** | **String** | Key that triggers the end of the recording. any digit, '#', or '*' | [optional] |
10
+ | **max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional] |
11
+ | **play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional] |
12
+ | **auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional] |
13
+ | **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
14
14
 
15
- ## Code Sample
15
+ ## Example
16
16
 
17
17
  ```ruby
18
18
  require 'freeclimb'
19
19
 
20
- instance = Freeclimb::RecordUtteranceAllOf.new(action_url: nil,
21
- silence_timeout_ms: nil,
22
- finish_on_key: nil,
23
- max_length_sec: nil,
24
- play_beep: nil,
25
- auto_start: nil,
26
- privacy_mode: nil)
20
+ instance = Freeclimb::RecordUtteranceAllOf.new(
21
+ action_url: null,
22
+ silence_timeout_ms: null,
23
+ finish_on_key: null,
24
+ max_length_sec: null,
25
+ play_beep: null,
26
+ auto_start: null,
27
+ privacy_mode: null
28
+ )
27
29
  ```
28
30
 
29
-
@@ -2,30 +2,31 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **total** | **Integer** | Total amount of requested resource. | [optional]
8
- **start** | **Integer** | Resource index at start of current page | [optional]
9
- **_end** | **Integer** | Resource index at end of current page | [optional]
10
- **page** | **Integer** | Current page | [optional]
11
- **num_pages** | **Integer** | Total number of pages | [optional]
12
- **page_size** | **Integer** | Number of items per page | [optional]
13
- **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional]
14
- **recordings** | [**Array<RecordingResult>**](RecordingResult.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **total** | **Integer** | Total amount of requested resource. | [optional] |
8
+ | **start** | **Integer** | Resource index at start of current page | [optional] |
9
+ | **_end** | **Integer** | Resource index at end of current page | [optional] |
10
+ | **page** | **Integer** | Current page | [optional] |
11
+ | **num_pages** | **Integer** | Total number of pages | [optional] |
12
+ | **page_size** | **Integer** | Number of items per page | [optional] |
13
+ | **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
14
+ | **recordings** | [**Array<RecordingResult>**](RecordingResult.md) | | [optional] |
15
15
 
16
- ## Code Sample
16
+ ## Example
17
17
 
18
18
  ```ruby
19
19
  require 'freeclimb'
20
20
 
21
- instance = Freeclimb::RecordingList.new(total: nil,
22
- start: nil,
23
- _end: nil,
24
- page: nil,
25
- num_pages: nil,
26
- page_size: nil,
27
- next_page_uri: nil,
28
- recordings: nil)
21
+ instance = Freeclimb::RecordingList.new(
22
+ total: null,
23
+ start: null,
24
+ _end: null,
25
+ page: null,
26
+ num_pages: null,
27
+ page_size: null,
28
+ next_page_uri: null,
29
+ recordings: null
30
+ )
29
31
  ```
30
32
 
31
-
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **recordings** | [**Array<RecordingResult>**](RecordingResult.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **recordings** | [**Array<RecordingResult>**](RecordingResult.md) | | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::RecordingListAllOf.new(recordings: nil)
14
+ instance = Freeclimb::RecordingListAllOf.new(
15
+ recordings: null
16
+ )
15
17
  ```
16
18
 
17
-
@@ -2,32 +2,33 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
8
- **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
9
- **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
- **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
- **recording_id** | **String** | String that uniquely identifies this recording resource. | [optional]
12
- **account_id** | **String** | ID of the account that created this recording. | [optional]
13
- **call_id** | **String** | ID of the Call that was recorded. If a Conference was recorded, this value is empty and the conferenceId property is populated. | [optional]
14
- **duration_sec** | **Integer** | Length of the recording in seconds. | [optional]
15
- **conference_id** | **String** | ID of the Conference that was recorded. If a Call was recorded, this value is empty and the callId property is populated. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] |
8
+ | **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
9
+ | **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
10
+ | **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
11
+ | **recording_id** | **String** | String that uniquely identifies this recording resource. | [optional] |
12
+ | **account_id** | **String** | ID of the account that created this recording. | [optional] |
13
+ | **call_id** | **String** | ID of the Call that was recorded. If a Conference was recorded, this value is empty and the conferenceId property is populated. | [optional] |
14
+ | **duration_sec** | **Integer** | Length of the recording in seconds. | [optional] |
15
+ | **conference_id** | **String** | ID of the Conference that was recorded. If a Call was recorded, this value is empty and the callId property is populated. | [optional] |
16
16
 
17
- ## Code Sample
17
+ ## Example
18
18
 
19
19
  ```ruby
20
20
  require 'freeclimb'
21
21
 
22
- instance = Freeclimb::RecordingResult.new(uri: nil,
23
- date_created: nil,
24
- date_updated: nil,
25
- revision: nil,
26
- recording_id: nil,
27
- account_id: nil,
28
- call_id: nil,
29
- duration_sec: nil,
30
- conference_id: nil)
22
+ instance = Freeclimb::RecordingResult.new(
23
+ uri: null,
24
+ date_created: null,
25
+ date_updated: null,
26
+ revision: null,
27
+ recording_id: null,
28
+ account_id: null,
29
+ call_id: null,
30
+ duration_sec: null,
31
+ conference_id: null
32
+ )
31
33
  ```
32
34
 
33
-
@@ -2,24 +2,25 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **recording_id** | **String** | String that uniquely identifies this recording resource. | [optional]
8
- **account_id** | **String** | ID of the account that created this recording. | [optional]
9
- **call_id** | **String** | ID of the Call that was recorded. If a Conference was recorded, this value is empty and the conferenceId property is populated. | [optional]
10
- **duration_sec** | **Integer** | Length of the recording in seconds. | [optional]
11
- **conference_id** | **String** | ID of the Conference that was recorded. If a Call was recorded, this value is empty and the callId property is populated. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **recording_id** | **String** | String that uniquely identifies this recording resource. | [optional] |
8
+ | **account_id** | **String** | ID of the account that created this recording. | [optional] |
9
+ | **call_id** | **String** | ID of the Call that was recorded. If a Conference was recorded, this value is empty and the conferenceId property is populated. | [optional] |
10
+ | **duration_sec** | **Integer** | Length of the recording in seconds. | [optional] |
11
+ | **conference_id** | **String** | ID of the Conference that was recorded. If a Call was recorded, this value is empty and the callId property is populated. | [optional] |
12
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
16
  require 'freeclimb'
17
17
 
18
- instance = Freeclimb::RecordingResultAllOf.new(recording_id: nil,
19
- account_id: nil,
20
- call_id: nil,
21
- duration_sec: nil,
22
- conference_id: nil)
18
+ instance = Freeclimb::RecordingResultAllOf.new(
19
+ recording_id: null,
20
+ account_id: null,
21
+ call_id: null,
22
+ duration_sec: null,
23
+ conference_id: null
24
+ )
23
25
  ```
24
26
 
25
-
data/docs/Redirect.md CHANGED
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. | |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::Redirect.new(action_url: nil)
14
+ instance = Freeclimb::Redirect.new(
15
+ action_url: null
16
+ )
15
17
  ```
16
18
 
17
-
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. | |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::RedirectAllOf.new(action_url: nil)
14
+ instance = Freeclimb::RedirectAllOf.new(
15
+ action_url: null
16
+ )
15
17
  ```
16
18
 
17
-
data/docs/Reject.md CHANGED
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **reason** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **reason** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::Reject.new(reason: nil)
14
+ instance = Freeclimb::Reject.new(
15
+ reason: null
16
+ )
15
17
  ```
16
18
 
17
-
data/docs/RejectAllOf.md CHANGED
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **reason** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **reason** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::RejectAllOf.new(reason: nil)
14
+ instance = Freeclimb::RejectAllOf.new(
15
+ reason: null
16
+ )
15
17
  ```
16
18
 
17
-
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **call_id** | **String** | ID of the Call leg to be removed from the Conference. The Call must be in a Conference or an error will be triggered. |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **call_id** | **String** | ID of the Call leg to be removed from the Conference. The Call must be in a Conference or an error will be triggered. | |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::RemoveFromConference.new(call_id: nil)
14
+ instance = Freeclimb::RemoveFromConference.new(
15
+ call_id: null
16
+ )
15
17
  ```
16
18
 
17
-
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **call_id** | **String** | ID of the Call leg to be removed from the Conference. The Call must be in a Conference or an error will be triggered. |
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **call_id** | **String** | ID of the Call leg to be removed from the Conference. The Call must be in a Conference or an error will be triggered. | |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::RemoveFromConferenceAllOf.new(call_id: nil)
14
+ instance = Freeclimb::RemoveFromConferenceAllOf.new(
15
+ call_id: null
16
+ )
15
17
  ```
16
18
 
17
-
data/docs/Say.md CHANGED
@@ -2,24 +2,25 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **text** | **String** | The message to be played to the caller using TTS. The size of the string is limited to 4 KB (or 4,096 bytes). An empty string will cause the command to be skipped. |
8
- **language** | **String** | Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below. | [optional]
9
- **loop** | **Integer** | Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up. | [optional]
10
- **conference_id** | **String** | D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional]
11
- **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **text** | **String** | The message to be played to the caller using TTS. The size of the string is limited to 4 KB (or 4,096 bytes). An empty string will cause the command to be skipped. | |
8
+ | **language** | **String** | Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below. | [optional] |
9
+ | **loop** | **Integer** | Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up. | [optional] |
10
+ | **conference_id** | **String** | D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional] |
11
+ | **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
12
12
 
13
- ## Code Sample
13
+ ## Example
14
14
 
15
15
  ```ruby
16
16
  require 'freeclimb'
17
17
 
18
- instance = Freeclimb::Say.new(text: nil,
19
- language: nil,
20
- loop: nil,
21
- conference_id: nil,
22
- privacy_mode: nil)
18
+ instance = Freeclimb::Say.new(
19
+ text: null,
20
+ language: null,
21
+ loop: null,
22
+ conference_id: null,
23
+ privacy_mode: null
24
+ )
23
25
  ```
24
26
 
25
-