freeclimb 3.0.2 → 4.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (336) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/Gemfile +4 -1
  4. data/Gemfile.lock +33 -19
  5. data/README.md +40 -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 +19 -14
  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 -42
  23. data/docs/CallResultAllOf.md +35 -34
  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 +1625 -647
  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 +35 -30
  51. data/docs/IncomingNumberResultAllOf.md +27 -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/Park.md +22 -0
  67. data/docs/ParkAllOf.md +22 -0
  68. data/docs/Pause.md +7 -6
  69. data/docs/PauseAllOf.md +7 -6
  70. data/docs/PerclCommand.md +7 -6
  71. data/docs/PerclScript.md +7 -6
  72. data/docs/Play.md +13 -12
  73. data/docs/PlayAllOf.md +13 -12
  74. data/docs/PlayEarlyMedia.md +7 -6
  75. data/docs/PlayEarlyMediaAllOf.md +7 -6
  76. data/docs/QueueList.md +21 -20
  77. data/docs/QueueListAllOf.md +7 -6
  78. data/docs/QueueMember.md +15 -14
  79. data/docs/QueueMemberList.md +21 -20
  80. data/docs/QueueMemberListAllOf.md +7 -6
  81. data/docs/QueueRequest.md +9 -8
  82. data/docs/QueueResult.md +27 -26
  83. data/docs/QueueResultAllOf.md +19 -18
  84. data/docs/RecordUtterance.md +19 -18
  85. data/docs/RecordUtteranceAllOf.md +19 -18
  86. data/docs/RecordingList.md +21 -20
  87. data/docs/RecordingListAllOf.md +7 -6
  88. data/docs/RecordingResult.md +23 -22
  89. data/docs/RecordingResultAllOf.md +15 -14
  90. data/docs/Redirect.md +7 -6
  91. data/docs/RedirectAllOf.md +7 -6
  92. data/docs/Reject.md +7 -6
  93. data/docs/RejectAllOf.md +7 -6
  94. data/docs/RemoveFromConference.md +7 -6
  95. data/docs/RemoveFromConferenceAllOf.md +7 -6
  96. data/docs/Say.md +15 -14
  97. data/docs/SayAllOf.md +15 -14
  98. data/docs/SendDigits.md +11 -10
  99. data/docs/SendDigitsAllOf.md +11 -10
  100. data/docs/SetListen.md +9 -8
  101. data/docs/SetListenAllOf.md +9 -8
  102. data/docs/SetTalk.md +9 -8
  103. data/docs/SetTalkAllOf.md +9 -8
  104. data/docs/Sms.md +13 -12
  105. data/docs/SmsAllOf.md +13 -12
  106. data/docs/StartRecordCall.md +3 -4
  107. data/docs/TerminateConference.md +7 -6
  108. data/docs/TerminateConferenceAllOf.md +7 -6
  109. data/docs/Unpark.md +15 -0
  110. data/docs/UpdateCallRequest.md +7 -6
  111. data/docs/UpdateConferenceParticipantRequest.md +9 -8
  112. data/docs/UpdateConferenceRequest.md +11 -10
  113. data/freeclimb.gemspec +3 -4
  114. data/lib/freeclimb/api/default_api.rb +434 -278
  115. data/lib/freeclimb/api_client.rb +55 -51
  116. data/lib/freeclimb/api_error.rb +2 -2
  117. data/lib/freeclimb/configuration.rb +41 -11
  118. data/lib/freeclimb/models/account_request.rb +20 -8
  119. data/lib/freeclimb/models/account_result.rb +39 -8
  120. data/lib/freeclimb/models/account_result_all_of.rb +39 -8
  121. data/lib/freeclimb/models/add_to_conference.rb +21 -8
  122. data/lib/freeclimb/models/add_to_conference_all_of.rb +20 -8
  123. data/lib/freeclimb/models/application_list.rb +28 -8
  124. data/lib/freeclimb/models/application_list_all_of.rb +21 -8
  125. data/lib/freeclimb/models/application_request.rb +20 -8
  126. data/lib/freeclimb/models/application_result.rb +29 -8
  127. data/lib/freeclimb/models/application_result_all_of.rb +29 -8
  128. data/lib/freeclimb/models/available_number.rb +46 -9
  129. data/lib/freeclimb/models/available_number_list.rb +28 -8
  130. data/lib/freeclimb/models/available_number_list_all_of.rb +21 -8
  131. data/lib/freeclimb/models/buy_incoming_number_request.rb +20 -8
  132. data/lib/freeclimb/models/call_list.rb +28 -8
  133. data/lib/freeclimb/models/call_list_all_of.rb +21 -8
  134. data/lib/freeclimb/models/call_result.rb +35 -8
  135. data/lib/freeclimb/models/call_result_all_of.rb +35 -8
  136. data/lib/freeclimb/models/capabilities.rb +265 -0
  137. data/lib/freeclimb/models/conference_list.rb +28 -8
  138. data/lib/freeclimb/models/conference_list_all_of.rb +21 -8
  139. data/lib/freeclimb/models/conference_participant_list.rb +28 -8
  140. data/lib/freeclimb/models/conference_participant_list_all_of.rb +21 -8
  141. data/lib/freeclimb/models/conference_participant_result.rb +26 -8
  142. data/lib/freeclimb/models/conference_participant_result_all_of.rb +26 -8
  143. data/lib/freeclimb/models/conference_result.rb +30 -8
  144. data/lib/freeclimb/models/conference_result_all_of.rb +30 -8
  145. data/lib/freeclimb/models/create_conference.rb +21 -8
  146. data/lib/freeclimb/models/create_conference_all_of.rb +20 -8
  147. data/lib/freeclimb/models/create_conference_request.rb +20 -8
  148. data/lib/freeclimb/models/dequeue.rb +21 -8
  149. data/lib/freeclimb/models/enqueue.rb +21 -8
  150. data/lib/freeclimb/models/enqueue_all_of.rb +20 -8
  151. data/lib/freeclimb/models/filter_logs_request.rb +20 -8
  152. data/lib/freeclimb/models/get_digits.rb +21 -8
  153. data/lib/freeclimb/models/get_digits_all_of.rb +20 -8
  154. data/lib/freeclimb/models/get_speech.rb +21 -8
  155. data/lib/freeclimb/models/get_speech_all_of.rb +20 -8
  156. data/lib/freeclimb/models/hangup.rb +21 -8
  157. data/lib/freeclimb/models/hangup_all_of.rb +20 -8
  158. data/lib/freeclimb/models/incoming_number_list.rb +28 -8
  159. data/lib/freeclimb/models/incoming_number_list_all_of.rb +21 -8
  160. data/lib/freeclimb/models/incoming_number_request.rb +20 -8
  161. data/lib/freeclimb/models/incoming_number_result.rb +50 -9
  162. data/lib/freeclimb/models/incoming_number_result_all_of.rb +50 -9
  163. data/lib/freeclimb/models/log_list.rb +28 -8
  164. data/lib/freeclimb/models/log_list_all_of.rb +21 -8
  165. data/lib/freeclimb/models/log_result.rb +27 -8
  166. data/lib/freeclimb/models/make_call_request.rb +22 -8
  167. data/lib/freeclimb/models/message_request.rb +20 -8
  168. data/lib/freeclimb/models/message_request_all_of.rb +20 -8
  169. data/lib/freeclimb/models/message_result.rb +28 -8
  170. data/lib/freeclimb/models/message_result_all_of.rb +28 -8
  171. data/lib/freeclimb/models/messages_list.rb +28 -8
  172. data/lib/freeclimb/models/messages_list_all_of.rb +21 -8
  173. data/lib/freeclimb/models/mutable_resource_model.rb +20 -8
  174. data/lib/freeclimb/models/out_dial.rb +21 -8
  175. data/lib/freeclimb/models/out_dial_all_of.rb +20 -8
  176. data/lib/freeclimb/models/pagination_model.rb +27 -8
  177. data/lib/freeclimb/models/park.rb +263 -0
  178. data/lib/freeclimb/models/park_all_of.rb +249 -0
  179. data/lib/freeclimb/models/pause.rb +21 -8
  180. data/lib/freeclimb/models/pause_all_of.rb +20 -8
  181. data/lib/freeclimb/models/percl_command.rb +38 -8
  182. data/lib/freeclimb/models/percl_script.rb +24 -8
  183. data/lib/freeclimb/models/play.rb +21 -8
  184. data/lib/freeclimb/models/play_all_of.rb +20 -8
  185. data/lib/freeclimb/models/play_early_media.rb +21 -8
  186. data/lib/freeclimb/models/play_early_media_all_of.rb +20 -8
  187. data/lib/freeclimb/models/queue_list.rb +28 -8
  188. data/lib/freeclimb/models/queue_list_all_of.rb +21 -8
  189. data/lib/freeclimb/models/queue_member.rb +25 -8
  190. data/lib/freeclimb/models/queue_member_list.rb +28 -8
  191. data/lib/freeclimb/models/queue_member_list_all_of.rb +21 -8
  192. data/lib/freeclimb/models/queue_request.rb +22 -8
  193. data/lib/freeclimb/models/queue_result.rb +27 -8
  194. data/lib/freeclimb/models/queue_result_all_of.rb +27 -8
  195. data/lib/freeclimb/models/record_utterance.rb +21 -8
  196. data/lib/freeclimb/models/record_utterance_all_of.rb +20 -8
  197. data/lib/freeclimb/models/recording_list.rb +28 -8
  198. data/lib/freeclimb/models/recording_list_all_of.rb +21 -8
  199. data/lib/freeclimb/models/recording_result.rb +25 -8
  200. data/lib/freeclimb/models/recording_result_all_of.rb +25 -8
  201. data/lib/freeclimb/models/redirect.rb +21 -8
  202. data/lib/freeclimb/models/redirect_all_of.rb +20 -8
  203. data/lib/freeclimb/models/reject.rb +21 -8
  204. data/lib/freeclimb/models/reject_all_of.rb +20 -8
  205. data/lib/freeclimb/models/remove_from_conference.rb +21 -8
  206. data/lib/freeclimb/models/remove_from_conference_all_of.rb +20 -8
  207. data/lib/freeclimb/models/say.rb +23 -8
  208. data/lib/freeclimb/models/say_all_of.rb +22 -8
  209. data/lib/freeclimb/models/send_digits.rb +21 -8
  210. data/lib/freeclimb/models/send_digits_all_of.rb +20 -8
  211. data/lib/freeclimb/models/set_listen.rb +21 -8
  212. data/lib/freeclimb/models/set_listen_all_of.rb +20 -8
  213. data/lib/freeclimb/models/set_talk.rb +21 -8
  214. data/lib/freeclimb/models/set_talk_all_of.rb +20 -8
  215. data/lib/freeclimb/models/sms.rb +21 -8
  216. data/lib/freeclimb/models/sms_all_of.rb +20 -8
  217. data/lib/freeclimb/models/start_record_call.rb +21 -8
  218. data/lib/freeclimb/models/terminate_conference.rb +21 -8
  219. data/lib/freeclimb/models/terminate_conference_all_of.rb +20 -8
  220. data/lib/freeclimb/models/unpark.rb +222 -0
  221. data/lib/freeclimb/models/update_call_request.rb +20 -8
  222. data/lib/freeclimb/models/update_conference_participant_request.rb +20 -8
  223. data/lib/freeclimb/models/update_conference_request.rb +20 -8
  224. data/lib/freeclimb/version.rb +3 -3
  225. data/lib/freeclimb.rb +28 -52
  226. data/spec/api/default_api_spec.rb +1004 -21
  227. data/spec/api_client_spec.rb +5 -5
  228. data/spec/configuration_spec.rb +10 -10
  229. data/spec/factories.rb +80 -0
  230. data/spec/models/account_request_spec.rb +5 -12
  231. data/spec/models/account_result_spec.rb +10 -13
  232. data/spec/models/add_to_conference_spec.rb +5 -12
  233. data/spec/models/application_list_spec.rb +5 -12
  234. data/spec/models/application_request_spec.rb +5 -12
  235. data/spec/models/application_result_spec.rb +5 -12
  236. data/spec/models/available_number_list_spec.rb +5 -12
  237. data/spec/models/available_number_spec.rb +11 -12
  238. data/spec/models/buy_incoming_number_request_spec.rb +5 -12
  239. data/spec/models/call_list_spec.rb +5 -12
  240. data/spec/models/call_result_spec.rb +6 -13
  241. data/spec/models/{say_all_of_spec.rb → capabilities_spec.rb} +13 -20
  242. data/spec/models/conference_list_spec.rb +5 -12
  243. data/spec/models/conference_participant_list_spec.rb +5 -12
  244. data/spec/models/conference_participant_result_spec.rb +5 -12
  245. data/spec/models/conference_result_spec.rb +7 -14
  246. data/spec/models/create_conference_request_spec.rb +6 -13
  247. data/spec/models/create_conference_spec.rb +5 -12
  248. data/spec/models/dequeue_spec.rb +5 -12
  249. data/spec/models/enqueue_spec.rb +5 -12
  250. data/spec/models/filter_logs_request_spec.rb +5 -12
  251. data/spec/models/get_digits_spec.rb +5 -12
  252. data/spec/models/get_speech_spec.rb +5 -12
  253. data/spec/models/hangup_spec.rb +5 -12
  254. data/spec/models/incoming_number_list_spec.rb +5 -12
  255. data/spec/models/incoming_number_request_spec.rb +5 -12
  256. data/spec/models/incoming_number_result_spec.rb +11 -12
  257. data/spec/models/log_list_spec.rb +5 -12
  258. data/spec/models/log_result_spec.rb +6 -13
  259. data/spec/models/make_call_request_spec.rb +5 -12
  260. data/spec/models/message_request_spec.rb +5 -12
  261. data/spec/models/message_result_spec.rb +6 -13
  262. data/spec/models/messages_list_spec.rb +5 -12
  263. data/spec/models/mutable_resource_model_spec.rb +5 -12
  264. data/spec/models/out_dial_spec.rb +5 -12
  265. data/spec/models/pagination_model_spec.rb +5 -12
  266. data/spec/models/{enqueue_all_of_spec.rb → park_spec.rb} +11 -24
  267. data/spec/models/pause_spec.rb +5 -12
  268. data/spec/models/percl_command_spec.rb +5 -12
  269. data/spec/models/percl_script_spec.rb +5 -12
  270. data/spec/models/play_early_media_spec.rb +5 -12
  271. data/spec/models/play_spec.rb +5 -12
  272. data/spec/models/queue_list_spec.rb +5 -12
  273. data/spec/models/queue_member_list_spec.rb +5 -12
  274. data/spec/models/queue_member_spec.rb +5 -12
  275. data/spec/models/queue_request_spec.rb +5 -12
  276. data/spec/models/queue_result_spec.rb +5 -12
  277. data/spec/models/record_utterance_spec.rb +5 -12
  278. data/spec/models/recording_list_spec.rb +5 -12
  279. data/spec/models/recording_result_spec.rb +5 -12
  280. data/spec/models/redirect_spec.rb +5 -12
  281. data/spec/models/reject_spec.rb +5 -12
  282. data/spec/models/remove_from_conference_spec.rb +5 -12
  283. data/spec/models/say_spec.rb +5 -12
  284. data/spec/models/send_digits_spec.rb +5 -12
  285. data/spec/models/set_listen_spec.rb +5 -12
  286. data/spec/models/set_talk_spec.rb +5 -12
  287. data/spec/models/sms_spec.rb +5 -12
  288. data/spec/models/start_record_call_spec.rb +5 -12
  289. data/spec/models/terminate_conference_spec.rb +5 -12
  290. data/spec/models/{pause_all_of_spec.rb → unpark_spec.rb} +8 -21
  291. data/spec/models/update_call_request_spec.rb +6 -13
  292. data/spec/models/update_conference_participant_request_spec.rb +5 -12
  293. data/spec/models/update_conference_request_spec.rb +6 -13
  294. data/spec/quickstart_spec.rb +10 -0
  295. data/spec/spec_helper.rb +61 -2
  296. metadata +75 -162
  297. data/lib/freeclimb/utils.rb +0 -34
  298. data/spec/api/web_mocks.rb +0 -473
  299. data/spec/models/account_result_all_of_spec.rb +0 -81
  300. data/spec/models/add_to_conference_all_of_spec.rb +0 -95
  301. data/spec/models/application_list_all_of_spec.rb +0 -41
  302. data/spec/models/application_result_all_of_spec.rb +0 -89
  303. data/spec/models/available_number_list_all_of_spec.rb +0 -41
  304. data/spec/models/call_list_all_of_spec.rb +0 -41
  305. data/spec/models/call_result_all_of_spec.rb +0 -129
  306. data/spec/models/conference_list_all_of_spec.rb +0 -41
  307. data/spec/models/conference_participant_list_all_of_spec.rb +0 -41
  308. data/spec/models/conference_participant_result_all_of_spec.rb +0 -71
  309. data/spec/models/conference_result_all_of_spec.rb +0 -103
  310. data/spec/models/create_conference_all_of_spec.rb +0 -71
  311. data/spec/models/get_digits_all_of_spec.rb +0 -89
  312. data/spec/models/get_speech_all_of_spec.rb +0 -113
  313. data/spec/models/hangup_all_of_spec.rb +0 -41
  314. data/spec/models/incoming_number_list_all_of_spec.rb +0 -41
  315. data/spec/models/incoming_number_result_all_of_spec.rb +0 -89
  316. data/spec/models/log_list_all_of_spec.rb +0 -41
  317. data/spec/models/message_request_all_of_spec.rb +0 -65
  318. data/spec/models/message_result_all_of_spec.rb +0 -87
  319. data/spec/models/messages_list_all_of_spec.rb +0 -41
  320. data/spec/models/out_dial_all_of_spec.rb +0 -95
  321. data/spec/models/play_all_of_spec.rb +0 -59
  322. data/spec/models/play_early_media_all_of_spec.rb +0 -41
  323. data/spec/models/queue_list_all_of_spec.rb +0 -41
  324. data/spec/models/queue_member_list_all_of_spec.rb +0 -41
  325. data/spec/models/queue_result_all_of_spec.rb +0 -77
  326. data/spec/models/record_utterance_all_of_spec.rb +0 -77
  327. data/spec/models/recording_list_all_of_spec.rb +0 -41
  328. data/spec/models/recording_result_all_of_spec.rb +0 -65
  329. data/spec/models/redirect_all_of_spec.rb +0 -41
  330. data/spec/models/reject_all_of_spec.rb +0 -41
  331. data/spec/models/remove_from_conference_all_of_spec.rb +0 -41
  332. data/spec/models/send_digits_all_of_spec.rb +0 -53
  333. data/spec/models/set_listen_all_of_spec.rb +0 -47
  334. data/spec/models/set_talk_all_of_spec.rb +0 -47
  335. data/spec/models/sms_all_of_spec.rb +0 -59
  336. data/spec/models/terminate_conference_all_of_spec.rb +0 -41
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: '069c922f287aeabc9c072a2c22db8c7ca517795a364ac0d568b190eb39ac1694'
4
- data.tar.gz: 4b1e0e739ea1863ce89aaa4561b01d664dba6a30116eeac6aef1a9c078cd60d6
3
+ metadata.gz: 1495ef3c51f08e4470314209c5c0c8ac10c90c0e326e699b9d1271607b9e4367
4
+ data.tar.gz: b87a439d07bd1a8ca9c6aca4a32ccd346f95aaa86841ed10b14ad2189d1fe5ae
5
5
  SHA512:
6
- metadata.gz: 0f22afadb1f796a173e2d7baaf9a8f1053e9e7b293b62408a9300540f3fec4f1cf974ea5c539dc77d43db6b1a825fb69b71cfabebacc53ef972821794834c930
7
- data.tar.gz: 7577278b4e7529626b58ff49605af8428ab61ae5f595a203667233365ddfd75efde5297aeed67877cf3196c7fbd0a7d1bf019f1680c2757fd9695b92e85a4831
6
+ metadata.gz: 7f2dde5bb6b2374b279a73e8a342d7304079c143a2f7dd03bf5b4500159efef46b69873d5ff6dcb791d79ad60789f0fd84cafeeab2876d56d60518aca97a9808
7
+ data.tar.gz: d967c644a7ffcb02b12e737f69e1b5fa95a3db6cf4aef3acaaa6b9c9c8b817c87486b7eee5f66a8aa32bdcb729449b1bbd44221f4d67cc9409b3d6bfe706b8d4
data/CHANGELOG.md CHANGED
@@ -7,6 +7,28 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
7
7
  ## [Unreleased]
8
8
  None
9
9
 
10
+ <a name="4.0.1"></a>
11
+ ## [4.0.1] - 2022-07-20
12
+ ### Added
13
+ - Add `Park` PerCL command
14
+ - Add `Unpark` PerCL command
15
+ ### Changed
16
+ - Default loop value for Say command is set to `1`
17
+
18
+ <a name="4.0.0"></a>
19
+ ## [4.0.0] - 2022-03-03
20
+ ### Changed
21
+ - Prefer keyword argument initialization for all models
22
+ - Rename api->list_an_application to list->list_applications
23
+ - Use new openapi-generator version (5.4.0)
24
+ - Remove floating `Freeclimb::percl_to_json` and added it to `PerclScript` as `to_json` method
25
+
26
+ <a name="3.0.3"></a>
27
+ ## [3.0.3] - 2022-02-08
28
+ ### Added
29
+ - Add capabilities query functionality for searching AvailableNumbers and IncomingNumbers
30
+ - Enable unit testing
31
+
10
32
  <a name="3.0.2"></a>
11
33
  ## [3.0.2] - 2021-12-06
12
34
  ### Changed
data/Gemfile CHANGED
@@ -3,7 +3,10 @@ source 'https://rubygems.org'
3
3
  gemspec
4
4
 
5
5
  group :development, :test do
6
- gem 'rake', '~> 12.0.0'
6
+ gem 'rake', '~> 13.0.6'
7
7
  gem 'pry-byebug'
8
8
  gem 'rubocop', '~> 0.66.0'
9
+ gem "webmock", "~> 3.14"
10
+ gem "factory_bot", "~> 6.2"
11
+ gem "facets", "~> 3.1"
9
12
  end
data/Gemfile.lock CHANGED
@@ -1,28 +1,38 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- freeclimb (2.0.0)
5
- json (~> 2.1, >= 2.1.0)
4
+ freeclimb (4.0.1)
6
5
  typhoeus (~> 1.0, >= 1.0.1)
7
6
 
8
7
  GEM
9
8
  remote: https://rubygems.org/
10
9
  specs:
11
- addressable (2.7.0)
10
+ activesupport (7.0.1)
11
+ concurrent-ruby (~> 1.0, >= 1.0.2)
12
+ i18n (>= 1.6, < 2)
13
+ minitest (>= 5.1)
14
+ tzinfo (~> 2.0)
15
+ addressable (2.8.0)
12
16
  public_suffix (>= 2.0.2, < 5.0)
13
17
  ast (2.4.0)
14
18
  byebug (11.1.1)
15
19
  coderay (1.1.2)
16
- crack (0.4.3)
17
- safe_yaml (~> 1.0.0)
20
+ concurrent-ruby (1.1.9)
21
+ crack (0.4.5)
22
+ rexml
18
23
  diff-lcs (1.3)
19
- ethon (0.12.0)
20
- ffi (>= 1.3.0)
21
- ffi (1.12.1)
22
- hashdiff (1.0.0)
24
+ ethon (0.15.0)
25
+ ffi (>= 1.15.0)
26
+ facets (3.1.0)
27
+ factory_bot (6.2.0)
28
+ activesupport (>= 5.0.0)
29
+ ffi (1.15.5)
30
+ hashdiff (1.0.1)
31
+ i18n (1.9.1)
32
+ concurrent-ruby (~> 1.0)
23
33
  jaro_winkler (1.5.4)
24
- json (2.3.0)
25
34
  method_source (0.9.2)
35
+ minitest (5.15.0)
26
36
  parallel (1.19.1)
27
37
  parser (2.7.0.2)
28
38
  ast (~> 2.4.0)
@@ -33,9 +43,10 @@ GEM
33
43
  byebug (~> 11.0)
34
44
  pry (~> 0.10)
35
45
  psych (3.1.0)
36
- public_suffix (4.0.3)
46
+ public_suffix (4.0.6)
37
47
  rainbow (3.0.0)
38
- rake (12.0.0)
48
+ rake (13.0.6)
49
+ rexml (3.2.5)
39
50
  rspec (3.9.0)
40
51
  rspec-core (~> 3.9.0)
41
52
  rspec-expectations (~> 3.9.0)
@@ -58,12 +69,13 @@ GEM
58
69
  ruby-progressbar (~> 1.7)
59
70
  unicode-display_width (>= 1.4.0, < 1.6)
60
71
  ruby-progressbar (1.10.1)
61
- safe_yaml (1.0.5)
62
- typhoeus (1.3.1)
72
+ typhoeus (1.4.0)
63
73
  ethon (>= 0.9.0)
74
+ tzinfo (2.0.4)
75
+ concurrent-ruby (~> 1.0)
64
76
  unicode-display_width (1.5.0)
65
- webmock (3.8.0)
66
- addressable (>= 2.3.6)
77
+ webmock (3.14.0)
78
+ addressable (>= 2.8.0)
67
79
  crack (>= 0.3.2)
68
80
  hashdiff (>= 0.4.0, < 2.0.0)
69
81
 
@@ -71,12 +83,14 @@ PLATFORMS
71
83
  ruby
72
84
 
73
85
  DEPENDENCIES
86
+ facets (~> 3.1)
87
+ factory_bot (~> 6.2)
74
88
  freeclimb!
75
89
  pry-byebug
76
- rake (~> 12.0.0)
90
+ rake (~> 13.0.6)
77
91
  rspec (~> 3.6, >= 3.6.0)
78
92
  rubocop (~> 0.66.0)
79
- webmock (~> 3.8)
93
+ webmock (~> 3.14)
80
94
 
81
95
  BUNDLED WITH
82
- 1.17.2
96
+ 2.3.6
data/README.md CHANGED
@@ -1,57 +1,54 @@
1
- # FreeClimb
1
+ # freeclimb
2
+
3
+ Freeclimb - the Ruby gem for the FreeClimb API
2
4
 
3
5
  FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
4
6
 
5
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
6
8
 
7
9
  - API version: 1.0.0
8
- - Package version: 3.0.2
10
+ - Package version: 4.0.1
9
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
+ For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
10
13
 
11
14
  ## Installation
12
15
 
13
- ### Build a gem
16
+ Add this to the Gemfile:
14
17
 
15
- To build the Ruby code into a gem:
18
+ gem 'freeclimb', '~> 4.0.1'
16
19
 
17
- ```shell
18
- gem build freeclimb.gemspec
19
- ```
20
+ and run from your terminal
20
21
 
21
- Then either install the gem locally:
22
+ bundle install
22
23
 
23
- ```shell
24
- gem install ./freeclimb-3.0.2.gem
25
- ```
24
+ ### Install from Git
26
25
 
27
- (for development, run `gem install --dev ./freeclimb-3.0.2.gem` to install the development dependencies)
26
+ If the Ruby gem is hosted at a git repository: e.g. https://https://github.com/freeclimbapi/ruby-sdk, then add the following in the Gemfile:
28
27
 
29
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
28
+ gem 'freeclimb', :git => 'https://https://github.com/freeclimbapi/ruby-sdk.git'
30
29
 
31
- Finally add this to the Gemfile:
30
+ ### Install from RubyGems
32
31
 
33
- gem 'freeclimb', '~> 3.0.2'
34
-
35
- ### Install from Ruby gems
36
- ```shell
37
- gem install freeclimb
38
- ```
32
+ gem install freeclimb
33
+ or
39
34
 
40
- ### Install from Git
35
+ bundle add freeclimb
41
36
 
42
- If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
43
-
44
- gem 'freeclimb', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
37
+ ### Install/Build locally
38
+ To build the Ruby code into a gem:
45
39
 
46
- ### Include the Ruby code directly
40
+ ```shell
41
+ gem build freeclimb.gemspec
42
+ ```
47
43
 
48
- Include the Ruby code directly using `-I` as follows:
44
+ Then either install the gem locally:
49
45
 
50
46
  ```shell
51
- ruby -Ilib script.rb
47
+ gem install ./freeclimb-4.0.1.gem
52
48
  ```
49
+ (for development, run `gem install --dev ./freeclimb-4.0.1.gem` to install the development dependencies)
53
50
 
54
- ## Testing Your Installation
51
+ ## Getting Started
55
52
 
56
53
  Please follow the [installation](#installation) procedure and then run the following code:
57
54
 
@@ -68,15 +65,19 @@ end
68
65
 
69
66
  api_instance = Freeclimb::DefaultApi.new
70
67
 
68
+ buy_incoming_number_request = Freeclimb::BuyIncomingNumberRequest.new({phone_number: 'phone_number_example'}) # BuyIncomingNumberRequest | Incoming Number transaction details
69
+
70
+
71
71
  begin
72
- #Get an Account
73
- result = api_instance.get_an_account
72
+ #Buy a Phone Number
73
+ result = api_instance.buy_a_phone_number(buy_incoming_number_request)
74
74
  p result
75
75
  rescue Freeclimb::ApiError => e
76
- puts "Exception when calling DefaultApi->get_an_account: #{e}"
76
+ puts "Exception when calling DefaultApi->buy_a_phone_number: #{e}"
77
77
  end
78
78
 
79
79
  ```
80
+
80
81
  ## Documentation for PerCL
81
82
 
82
83
  The Performance Command Language (PerCL) defines a set of instructions, written in JSON format, that express telephony actions to be performed in response to an event on the FreeClimb platform. FreeClimb communicates with the application server when events associated with the application occur, so the webserver can instruct FreeClimb how to handle such events using PerCL scripts.
@@ -89,7 +90,7 @@ say = Freeclimb::Say.new(text: "Hello, World")
89
90
  play = Freeclimb::Play.new(file: "Example File")
90
91
  get_digits = Freeclimb::GetDigits.new(action_url: "Example Action URL", prompts: [say, play])
91
92
  percl_script = Freeclimb::PerclScript.new(commands: [get_digits])
92
- puts Freeclimb::percl_to_json(percl_script)
93
+ puts percl_script.to_json
93
94
  ```
94
95
 
95
96
  ## Documentation for API Endpoints
@@ -98,7 +99,6 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
98
99
 
99
100
  Class | Method | HTTP request | Description
100
101
  ------------ | ------------- | ------------- | -------------
101
- *Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
102
102
  *Freeclimb::DefaultApi* | [**buy_a_phone_number**](docs/DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
103
103
  *Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
104
104
  *Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
@@ -116,13 +116,14 @@ Class | Method | HTTP request | Description
116
116
  *Freeclimb::DefaultApi* | [**get_a_participant**](docs/DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
117
117
  *Freeclimb::DefaultApi* | [**get_a_queue**](docs/DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
118
118
  *Freeclimb::DefaultApi* | [**get_a_recording**](docs/DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
119
+ *Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
119
120
  *Freeclimb::DefaultApi* | [**get_an_application**](docs/DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
120
121
  *Freeclimb::DefaultApi* | [**get_an_incoming_number**](docs/DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
121
122
  *Freeclimb::DefaultApi* | [**get_an_sms_message**](docs/DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
122
123
  *Freeclimb::DefaultApi* | [**get_head_member**](docs/DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member
123
124
  *Freeclimb::DefaultApi* | [**list_active_queues**](docs/DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues
124
125
  *Freeclimb::DefaultApi* | [**list_all_account_logs**](docs/DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs
125
- *Freeclimb::DefaultApi* | [**list_an_application**](docs/DefaultApi.md#list_an_application) | **GET** /Accounts/{accountId}/Applications | List applications
126
+ *Freeclimb::DefaultApi* | [**list_applications**](docs/DefaultApi.md#list_applications) | **GET** /Accounts/{accountId}/Applications | List applications
126
127
  *Freeclimb::DefaultApi* | [**list_available_numbers**](docs/DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers
127
128
  *Freeclimb::DefaultApi* | [**list_call_logs**](docs/DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs
128
129
  *Freeclimb::DefaultApi* | [**list_call_recordings**](docs/DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings
@@ -166,6 +167,7 @@ Class | Method | HTTP request | Description
166
167
  - [Freeclimb::CallListAllOf](docs/CallListAllOf.md)
167
168
  - [Freeclimb::CallResult](docs/CallResult.md)
168
169
  - [Freeclimb::CallResultAllOf](docs/CallResultAllOf.md)
170
+ - [Freeclimb::Capabilities](docs/Capabilities.md)
169
171
  - [Freeclimb::ConferenceList](docs/ConferenceList.md)
170
172
  - [Freeclimb::ConferenceListAllOf](docs/ConferenceListAllOf.md)
171
173
  - [Freeclimb::ConferenceParticipantList](docs/ConferenceParticipantList.md)
@@ -206,6 +208,8 @@ Class | Method | HTTP request | Description
206
208
  - [Freeclimb::OutDial](docs/OutDial.md)
207
209
  - [Freeclimb::OutDialAllOf](docs/OutDialAllOf.md)
208
210
  - [Freeclimb::PaginationModel](docs/PaginationModel.md)
211
+ - [Freeclimb::Park](docs/Park.md)
212
+ - [Freeclimb::ParkAllOf](docs/ParkAllOf.md)
209
213
  - [Freeclimb::Pause](docs/Pause.md)
210
214
  - [Freeclimb::PauseAllOf](docs/PauseAllOf.md)
211
215
  - [Freeclimb::PerclCommand](docs/PerclCommand.md)
@@ -247,6 +251,7 @@ Class | Method | HTTP request | Description
247
251
  - [Freeclimb::StartRecordCall](docs/StartRecordCall.md)
248
252
  - [Freeclimb::TerminateConference](docs/TerminateConference.md)
249
253
  - [Freeclimb::TerminateConferenceAllOf](docs/TerminateConferenceAllOf.md)
254
+ - [Freeclimb::Unpark](docs/Unpark.md)
250
255
  - [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)
251
256
  - [Freeclimb::UpdateConferenceParticipantRequest](docs/UpdateConferenceParticipantRequest.md)
252
257
  - [Freeclimb::UpdateConferenceRequest](docs/UpdateConferenceRequest.md)
@@ -262,4 +267,4 @@ Class | Method | HTTP request | Description
262
267
 
263
268
  ## Getting Help
264
269
 
265
- If you are experiencing difficulties, [contact support](https://freeclimb.com/support).
270
+ If you are experiencing difficulties, [contact support](https://freeclimb.com/support).
@@ -2,18 +2,19 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **_alias** | **String** | Description for this account. | [optional]
8
- **label** | **String** | Group to which this account belongs. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_alias** | **String** | Description for this account. | [optional] |
8
+ | **label** | **String** | Group to which this account belongs. | [optional] |
9
9
 
10
- ## Code Sample
10
+ ## Example
11
11
 
12
12
  ```ruby
13
13
  require 'freeclimb'
14
14
 
15
- instance = Freeclimb::AccountRequest.new(_alias: nil,
16
- label: nil)
15
+ instance = Freeclimb::AccountRequest.new(
16
+ _alias: null,
17
+ label: null
18
+ )
17
19
  ```
18
20
 
19
-
@@ -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** | String that uniquely identifies this account resource. | [optional]
12
- **api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional]
13
- **_alias** | **String** | A description for this account. | [optional]
14
- **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional]
15
- **type** | **String** | The type of this account. It is one of: trial or full. | [optional]
16
- **status** | **String** | The status of this account. It is one of: active, suspended, or closed. | [optional]
17
- **subresource_uris** | [**Object**](.md) | The list of subresources for this account. | [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** | String that uniquely identifies this account resource. | [optional] |
12
+ | **api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional] |
13
+ | **_alias** | **String** | A description for this account. | [optional] |
14
+ | **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional] |
15
+ | **type** | **String** | The type of this account. It is one of: trial or full. | [optional] |
16
+ | **status** | **String** | The status of this account. It is one of: active, suspended, or closed. | [optional] |
17
+ | **subresource_uris** | **Object** | The list of subresources for this account. | [optional] |
18
18
 
19
- ## Code Sample
19
+ ## Example
20
20
 
21
21
  ```ruby
22
22
  require 'freeclimb'
23
23
 
24
- instance = Freeclimb::AccountResult.new(uri: nil,
25
- date_created: nil,
26
- date_updated: nil,
27
- revision: nil,
28
- account_id: nil,
29
- api_key: nil,
30
- _alias: nil,
31
- label: nil,
32
- type: nil,
33
- status: nil,
34
- subresource_uris: nil)
24
+ instance = Freeclimb::AccountResult.new(
25
+ uri: null,
26
+ date_created: null,
27
+ date_updated: null,
28
+ revision: null,
29
+ account_id: null,
30
+ api_key: null,
31
+ _alias: null,
32
+ label: null,
33
+ type: null,
34
+ status: 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** | String that uniquely identifies this account resource. | [optional]
8
- **api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional]
9
- **_alias** | **String** | A description for this account. | [optional]
10
- **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional]
11
- **type** | **String** | The type of this account. It is one of: trial or full. | [optional]
12
- **status** | **String** | The status of this account. It is one of: active, suspended, or closed. | [optional]
13
- **subresource_uris** | [**Object**](.md) | The list of subresources for this account. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
8
+ | **api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional] |
9
+ | **_alias** | **String** | A description for this account. | [optional] |
10
+ | **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional] |
11
+ | **type** | **String** | The type of this account. It is one of: trial or full. | [optional] |
12
+ | **status** | **String** | The status of this account. It is one of: active, suspended, or closed. | [optional] |
13
+ | **subresource_uris** | **Object** | The list of subresources for this account. | [optional] |
14
14
 
15
- ## Code Sample
15
+ ## Example
16
16
 
17
17
  ```ruby
18
18
  require 'freeclimb'
19
19
 
20
- instance = Freeclimb::AccountResultAllOf.new(account_id: nil,
21
- api_key: nil,
22
- _alias: nil,
23
- label: nil,
24
- type: nil,
25
- status: nil,
26
- subresource_uris: nil)
20
+ instance = Freeclimb::AccountResultAllOf.new(
21
+ account_id: null,
22
+ api_key: null,
23
+ _alias: null,
24
+ label: null,
25
+ type: null,
26
+ status: null,
27
+ subresource_uris: null
28
+ )
27
29
  ```
28
30
 
29
-
@@ -2,34 +2,35 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **allow_call_control** | **Boolean** | If &#x60;true&#x60;, Call control will be enabled for this Participant&#39;s Call leg. | [optional]
8
- **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the &#x60;callControlUrl&#x60;. Only digits plus &#39;*&#39;, and &#39;#&#39; may be used. | [optional]
9
- **call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the &#x60;callControlSequence&#x60; attribute. | [optional]
10
- **conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. |
11
- **call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. | [optional]
12
- **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
13
- **listen** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or &#x60;SetListen&#x60; PerCL command. | [optional]
14
- **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
15
- **start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to &#x60;true&#x60; for moderators and &#x60;false&#x60; for all other Participants. | [optional]
16
- **talk** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or &#x60;SetTalk&#x60; PerCL command. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allow_call_control** | **Boolean** | If &#x60;true&#x60;, Call control will be enabled for this Participant&#39;s Call leg. | [optional] |
8
+ | **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the &#x60;callControlUrl&#x60;. Only digits plus &#39;*&#39;, and &#39;#&#39; may be used. | [optional] |
9
+ | **call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the &#x60;callControlSequence&#x60; attribute. | [optional] |
10
+ | **conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. | |
11
+ | **call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. | [optional] |
12
+ | **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional] |
13
+ | **listen** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or &#x60;SetListen&#x60; PerCL command. | [optional] |
14
+ | **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional] |
15
+ | **start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to &#x60;true&#x60; for moderators and &#x60;false&#x60; for all other Participants. | [optional] |
16
+ | **talk** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or &#x60;SetTalk&#x60; PerCL command. | [optional] |
17
17
 
18
- ## Code Sample
18
+ ## Example
19
19
 
20
20
  ```ruby
21
21
  require 'freeclimb'
22
22
 
23
- instance = Freeclimb::AddToConference.new(allow_call_control: nil,
24
- call_control_sequence: nil,
25
- call_control_url: nil,
26
- conference_id: nil,
27
- call_id: nil,
28
- leave_conference_url: nil,
29
- listen: nil,
30
- notification_url: nil,
31
- start_conf_on_enter: nil,
32
- talk: nil)
23
+ instance = Freeclimb::AddToConference.new(
24
+ allow_call_control: null,
25
+ call_control_sequence: null,
26
+ call_control_url: null,
27
+ conference_id: null,
28
+ call_id: null,
29
+ leave_conference_url: null,
30
+ listen: null,
31
+ notification_url: null,
32
+ start_conf_on_enter: null,
33
+ talk: null
34
+ )
33
35
  ```
34
36
 
35
-
@@ -2,34 +2,35 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **allow_call_control** | **Boolean** | If &#x60;true&#x60;, Call control will be enabled for this Participant&#39;s Call leg. | [optional]
8
- **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the &#x60;callControlUrl&#x60;. Only digits plus &#39;*&#39;, and &#39;#&#39; may be used. | [optional]
9
- **call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the &#x60;callControlSequence&#x60; attribute. | [optional]
10
- **conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. |
11
- **call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. | [optional]
12
- **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
13
- **listen** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or &#x60;SetListen&#x60; PerCL command. | [optional]
14
- **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
15
- **start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to &#x60;true&#x60; for moderators and &#x60;false&#x60; for all other Participants. | [optional]
16
- **talk** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or &#x60;SetTalk&#x60; PerCL command. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **allow_call_control** | **Boolean** | If &#x60;true&#x60;, Call control will be enabled for this Participant&#39;s Call leg. | [optional] |
8
+ | **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the &#x60;callControlUrl&#x60;. Only digits plus &#39;*&#39;, and &#39;#&#39; may be used. | [optional] |
9
+ | **call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the &#x60;callControlSequence&#x60; attribute. | [optional] |
10
+ | **conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. | |
11
+ | **call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. | [optional] |
12
+ | **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional] |
13
+ | **listen** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or &#x60;SetListen&#x60; PerCL command. | [optional] |
14
+ | **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional] |
15
+ | **start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to &#x60;true&#x60; for moderators and &#x60;false&#x60; for all other Participants. | [optional] |
16
+ | **talk** | **Boolean** | If &#x60;true&#x60;, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or &#x60;SetTalk&#x60; PerCL command. | [optional] |
17
17
 
18
- ## Code Sample
18
+ ## Example
19
19
 
20
20
  ```ruby
21
21
  require 'freeclimb'
22
22
 
23
- instance = Freeclimb::AddToConferenceAllOf.new(allow_call_control: nil,
24
- call_control_sequence: nil,
25
- call_control_url: nil,
26
- conference_id: nil,
27
- call_id: nil,
28
- leave_conference_url: nil,
29
- listen: nil,
30
- notification_url: nil,
31
- start_conf_on_enter: nil,
32
- talk: nil)
23
+ instance = Freeclimb::AddToConferenceAllOf.new(
24
+ allow_call_control: null,
25
+ call_control_sequence: null,
26
+ call_control_url: null,
27
+ conference_id: null,
28
+ call_id: null,
29
+ leave_conference_url: null,
30
+ listen: null,
31
+ notification_url: null,
32
+ start_conf_on_enter: null,
33
+ talk: null
34
+ )
33
35
  ```
34
36
 
35
-