freeclimb 2.2.0 → 3.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (293) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +29 -1
  3. data/Gemfile +4 -2
  4. data/Gemfile.lock +41 -20
  5. data/README.md +35 -33
  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 -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 +1672 -580
  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 +2 -3
  111. data/lib/freeclimb/api/default_api.rb +439 -257
  112. data/lib/freeclimb/api_client.rb +54 -50
  113. data/lib/freeclimb/api_error.rb +1 -1
  114. data/lib/freeclimb/configuration.rb +40 -10
  115. data/lib/freeclimb/models/account_request.rb +19 -7
  116. data/lib/freeclimb/models/account_result.rb +20 -8
  117. data/lib/freeclimb/models/account_result_all_of.rb +20 -8
  118. data/lib/freeclimb/models/add_to_conference.rb +19 -12
  119. data/lib/freeclimb/models/add_to_conference_all_of.rb +19 -12
  120. data/lib/freeclimb/models/application_list.rb +19 -7
  121. data/lib/freeclimb/models/application_list_all_of.rb +19 -7
  122. data/lib/freeclimb/models/application_request.rb +19 -7
  123. data/lib/freeclimb/models/application_result.rb +19 -7
  124. data/lib/freeclimb/models/application_result_all_of.rb +19 -7
  125. data/lib/freeclimb/models/available_number.rb +29 -18
  126. data/lib/freeclimb/models/available_number_list.rb +19 -7
  127. data/lib/freeclimb/models/available_number_list_all_of.rb +19 -7
  128. data/lib/freeclimb/models/buy_incoming_number_request.rb +19 -7
  129. data/lib/freeclimb/models/call_list.rb +19 -7
  130. data/lib/freeclimb/models/call_list_all_of.rb +19 -7
  131. data/lib/freeclimb/models/call_result.rb +19 -7
  132. data/lib/freeclimb/models/call_result_all_of.rb +19 -7
  133. data/lib/freeclimb/models/capabilities.rb +285 -0
  134. data/lib/freeclimb/models/conference_list.rb +19 -7
  135. data/lib/freeclimb/models/conference_list_all_of.rb +19 -7
  136. data/lib/freeclimb/models/conference_participant_list.rb +19 -7
  137. data/lib/freeclimb/models/conference_participant_list_all_of.rb +19 -7
  138. data/lib/freeclimb/models/conference_participant_result.rb +19 -7
  139. data/lib/freeclimb/models/conference_participant_result_all_of.rb +19 -7
  140. data/lib/freeclimb/models/conference_result.rb +19 -7
  141. data/lib/freeclimb/models/conference_result_all_of.rb +19 -7
  142. data/lib/freeclimb/models/create_conference.rb +19 -7
  143. data/lib/freeclimb/models/create_conference_all_of.rb +19 -7
  144. data/lib/freeclimb/models/create_conference_request.rb +19 -7
  145. data/lib/freeclimb/models/dequeue.rb +19 -7
  146. data/lib/freeclimb/models/enqueue.rb +19 -7
  147. data/lib/freeclimb/models/enqueue_all_of.rb +19 -7
  148. data/lib/freeclimb/models/filter_logs_request.rb +19 -7
  149. data/lib/freeclimb/models/get_digits.rb +19 -7
  150. data/lib/freeclimb/models/get_digits_all_of.rb +19 -7
  151. data/lib/freeclimb/models/get_speech.rb +19 -7
  152. data/lib/freeclimb/models/get_speech_all_of.rb +19 -7
  153. data/lib/freeclimb/models/hangup.rb +19 -7
  154. data/lib/freeclimb/models/hangup_all_of.rb +19 -7
  155. data/lib/freeclimb/models/incoming_number_list.rb +19 -7
  156. data/lib/freeclimb/models/incoming_number_list_all_of.rb +19 -7
  157. data/lib/freeclimb/models/incoming_number_request.rb +19 -7
  158. data/lib/freeclimb/models/incoming_number_result.rb +29 -8
  159. data/lib/freeclimb/models/incoming_number_result_all_of.rb +29 -8
  160. data/lib/freeclimb/models/log_list.rb +19 -7
  161. data/lib/freeclimb/models/log_list_all_of.rb +19 -7
  162. data/lib/freeclimb/models/log_result.rb +19 -7
  163. data/lib/freeclimb/models/make_call_request.rb +19 -7
  164. data/lib/freeclimb/models/message_request.rb +19 -7
  165. data/lib/freeclimb/models/message_request_all_of.rb +19 -7
  166. data/lib/freeclimb/models/message_result.rb +19 -7
  167. data/lib/freeclimb/models/message_result_all_of.rb +19 -7
  168. data/lib/freeclimb/models/messages_list.rb +19 -7
  169. data/lib/freeclimb/models/messages_list_all_of.rb +19 -7
  170. data/lib/freeclimb/models/mutable_resource_model.rb +19 -7
  171. data/lib/freeclimb/models/out_dial.rb +19 -7
  172. data/lib/freeclimb/models/out_dial_all_of.rb +19 -7
  173. data/lib/freeclimb/models/pagination_model.rb +19 -7
  174. data/lib/freeclimb/models/pause.rb +19 -7
  175. data/lib/freeclimb/models/pause_all_of.rb +19 -7
  176. data/lib/freeclimb/models/percl_command.rb +20 -7
  177. data/lib/freeclimb/models/percl_script.rb +19 -7
  178. data/lib/freeclimb/models/play.rb +19 -7
  179. data/lib/freeclimb/models/play_all_of.rb +19 -7
  180. data/lib/freeclimb/models/play_early_media.rb +19 -7
  181. data/lib/freeclimb/models/play_early_media_all_of.rb +19 -7
  182. data/lib/freeclimb/models/queue_list.rb +19 -7
  183. data/lib/freeclimb/models/queue_list_all_of.rb +19 -7
  184. data/lib/freeclimb/models/queue_member.rb +19 -7
  185. data/lib/freeclimb/models/queue_member_list.rb +19 -7
  186. data/lib/freeclimb/models/queue_member_list_all_of.rb +19 -7
  187. data/lib/freeclimb/models/queue_request.rb +19 -7
  188. data/lib/freeclimb/models/queue_result.rb +19 -7
  189. data/lib/freeclimb/models/queue_result_all_of.rb +19 -7
  190. data/lib/freeclimb/models/record_utterance.rb +19 -7
  191. data/lib/freeclimb/models/record_utterance_all_of.rb +19 -7
  192. data/lib/freeclimb/models/recording_list.rb +19 -7
  193. data/lib/freeclimb/models/recording_list_all_of.rb +19 -7
  194. data/lib/freeclimb/models/recording_result.rb +19 -7
  195. data/lib/freeclimb/models/recording_result_all_of.rb +19 -7
  196. data/lib/freeclimb/models/redirect.rb +19 -7
  197. data/lib/freeclimb/models/redirect_all_of.rb +19 -7
  198. data/lib/freeclimb/models/reject.rb +19 -7
  199. data/lib/freeclimb/models/reject_all_of.rb +19 -7
  200. data/lib/freeclimb/models/remove_from_conference.rb +19 -7
  201. data/lib/freeclimb/models/remove_from_conference_all_of.rb +19 -7
  202. data/lib/freeclimb/models/say.rb +19 -7
  203. data/lib/freeclimb/models/say_all_of.rb +19 -7
  204. data/lib/freeclimb/models/send_digits.rb +19 -7
  205. data/lib/freeclimb/models/send_digits_all_of.rb +19 -7
  206. data/lib/freeclimb/models/set_listen.rb +19 -7
  207. data/lib/freeclimb/models/set_listen_all_of.rb +19 -7
  208. data/lib/freeclimb/models/set_talk.rb +19 -7
  209. data/lib/freeclimb/models/set_talk_all_of.rb +19 -7
  210. data/lib/freeclimb/models/sms.rb +19 -7
  211. data/lib/freeclimb/models/sms_all_of.rb +19 -7
  212. data/lib/freeclimb/models/start_record_call.rb +19 -7
  213. data/lib/freeclimb/models/terminate_conference.rb +19 -7
  214. data/lib/freeclimb/models/terminate_conference_all_of.rb +19 -7
  215. data/lib/freeclimb/models/update_call_request.rb +19 -7
  216. data/lib/freeclimb/models/update_conference_participant_request.rb +19 -7
  217. data/lib/freeclimb/models/update_conference_request.rb +19 -7
  218. data/lib/freeclimb/version.rb +2 -2
  219. data/lib/freeclimb.rb +46 -46
  220. data/spec/api/default_api_spec.rb +1092 -665
  221. data/spec/api_client_spec.rb +6 -6
  222. data/spec/configuration_spec.rb +12 -4
  223. data/spec/factories.rb +80 -0
  224. data/spec/models/account_request_spec.rb +19 -12
  225. data/spec/models/account_result_spec.rb +76 -11
  226. data/spec/models/add_to_conference_spec.rb +6 -13
  227. data/spec/models/application_list_spec.rb +54 -11
  228. data/spec/models/application_request_spec.rb +48 -11
  229. data/spec/models/application_result_spec.rb +84 -11
  230. data/spec/models/available_number_list_spec.rb +54 -12
  231. data/spec/models/available_number_spec.rb +42 -11
  232. data/spec/models/buy_incoming_number_request_spec.rb +24 -11
  233. data/spec/models/call_list_spec.rb +54 -12
  234. data/spec/models/call_result_spec.rb +123 -11
  235. data/spec/models/capabilities_spec.rb +58 -0
  236. data/spec/models/conference_list_spec.rb +54 -11
  237. data/spec/models/conference_participant_list_spec.rb +54 -11
  238. data/spec/models/conference_participant_result_spec.rb +66 -11
  239. data/spec/models/conference_result_spec.rb +98 -12
  240. data/spec/models/create_conference_request_spec.rb +40 -12
  241. data/spec/models/create_conference_spec.rb +6 -13
  242. data/spec/models/dequeue_spec.rb +6 -13
  243. data/spec/models/enqueue_spec.rb +6 -13
  244. data/spec/models/filter_logs_request_spec.rb +14 -13
  245. data/spec/models/get_digits_spec.rb +12 -13
  246. data/spec/models/get_speech_spec.rb +7 -14
  247. data/spec/models/hangup_spec.rb +4 -11
  248. data/spec/models/incoming_number_list_spec.rb +54 -12
  249. data/spec/models/incoming_number_request_spec.rb +19 -12
  250. data/spec/models/incoming_number_result_spec.rb +90 -12
  251. data/spec/models/log_list_spec.rb +54 -11
  252. data/spec/models/log_result_spec.rb +52 -11
  253. data/spec/models/make_call_request_spec.rb +66 -11
  254. data/spec/models/message_request_spec.rb +60 -12
  255. data/spec/models/message_result_spec.rb +82 -11
  256. data/spec/models/messages_list_spec.rb +54 -11
  257. data/spec/models/mutable_resource_model_spec.rb +30 -12
  258. data/spec/models/out_dial_spec.rb +12 -13
  259. data/spec/models/pagination_model_spec.rb +48 -11
  260. data/spec/models/pause_spec.rb +6 -13
  261. data/spec/models/percl_command_spec.rb +6 -13
  262. data/spec/models/percl_script_spec.rb +6 -13
  263. data/spec/models/play_early_media_spec.rb +6 -13
  264. data/spec/models/play_spec.rb +12 -13
  265. data/spec/models/queue_list_spec.rb +53 -11
  266. data/spec/models/queue_member_list_spec.rb +54 -11
  267. data/spec/models/queue_member_spec.rb +36 -12
  268. data/spec/models/queue_request_spec.rb +19 -13
  269. data/spec/models/queue_result_spec.rb +72 -11
  270. data/spec/models/record_utterance_spec.rb +12 -13
  271. data/spec/models/recording_list_spec.rb +54 -11
  272. data/spec/models/recording_result_spec.rb +60 -11
  273. data/spec/models/redirect_spec.rb +6 -13
  274. data/spec/models/reject_spec.rb +4 -11
  275. data/spec/models/remove_from_conference_spec.rb +6 -13
  276. data/spec/models/say_spec.rb +7 -14
  277. data/spec/models/send_digits_spec.rb +12 -13
  278. data/spec/models/set_listen_spec.rb +6 -13
  279. data/spec/models/set_talk_spec.rb +6 -13
  280. data/spec/models/sms_spec.rb +6 -13
  281. data/spec/models/start_record_call_spec.rb +6 -13
  282. data/spec/models/terminate_conference_spec.rb +6 -13
  283. data/spec/models/update_call_request_spec.rb +18 -13
  284. data/spec/models/update_conference_participant_request_spec.rb +19 -12
  285. data/spec/models/update_conference_request_spec.rb +28 -11
  286. data/spec/quickstart_spec.rb +10 -0
  287. data/spec/spec_helper.rb +57 -6
  288. metadata +20 -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/spec/api/web_mocks.rb +0 -473
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3329b44735fb00cbe89d1f64b29bcd20746822b7976acd11e046f0e04553b78c
4
- data.tar.gz: 0c10c93eb8bf849cf7e376d111e2e1332470a27a45b67e56a5d7fcbce3e03cce
3
+ metadata.gz: 9967659c853a49c4e241ce3ba03139e590b52966839fc322965c71246490601b
4
+ data.tar.gz: 5f4627c4f1d99ca1fea23bae65beae37d5060f668acad0e138d28fe31a53a1b2
5
5
  SHA512:
6
- metadata.gz: 0d7e751a6941e8e5962b73fad832ab0893d13d0e145e46e1458d5e49781a34b82f275057565b29056094a7ec76c0e579932a81afb8740570413a23e9797c8a50
7
- data.tar.gz: 2b96b3486f150332c36af12d84f870497ba8c300b804964d99f4fc1743ece7b33789f06872eaa0c6d63173768ec42e35837d3d8195be48c43a6cb45b7b0887ee
6
+ metadata.gz: 15843b21574c71c791bc3cd24328b2a0a50bfe31f1af033ebb9e39005063acaf370e1bc0573c25c6d731f45b9a92b39d2dc87d1cffa43b5aabc763e580d479ea
7
+ data.tar.gz: 8848a321f2988653f49156fc893c11eee785ea6c0e2d53f5dac233355c6fbf0ebcfac6cc30e595fb03db31dd8ff4abaf16dd0c274c51fde0bfafedcf9b97d6c9
data/CHANGELOG.md CHANGED
@@ -7,8 +7,36 @@ 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="3.0.3"></a>
11
+ ## [3.0.3] - 2022-02-08
12
+ ### Added
13
+ - Add capabilities query functionality for searching AvailableNumbers and IncomingNumbers
14
+ - Enable unit testing
15
+
16
+ <a name="3.0.2"></a>
17
+ ## [3.0.2] - 2021-12-06
18
+ ### Changed
19
+ -remove alias from accepted query parameters when listing AvailablePhoneNumbers
20
+ -Add country, region, smsEnabled, and voiceEnabled as accepted query parameters for AvailablePhoneNumbers
21
+ -Add smsEnabled to AvailablePhoneNumbers response schema
22
+ -Add applicationId, country, region, smsEnabled, voiceEnabled, and hasApplication as accepted query parameters for IncomingPhoneNumber.
23
+
24
+ <a name="3.0.1"></a>
25
+ ## [3.0.1] - 2021-11-02
26
+ ### Added
27
+ - Add `active` property to CallResult
28
+
29
+ ### Changed
30
+ - Small instances of `token` to `key`
31
+ - Call ID is not required to `AddToConference`
32
+
33
+ <a name="3.0.0"></a>
34
+ ## [3.0.0] - 2021-05-03
35
+ ### Added
36
+ - Add `verify_request` utility function
37
+
10
38
  <a name="2.2.0"></a>
11
- ## [2.1.2] - 2021-04-12
39
+ ## [2.2.0] - 2021-04-12
12
40
  ### Changed
13
41
  - Replace any language instance of `auth_token` or similar speech to `api_key`
14
42
 
data/Gemfile CHANGED
@@ -3,8 +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
- gem "webmock", "~> 3.8"
9
8
  gem 'rubocop', '~> 0.66.0'
9
+ gem "webmock", "~> 3.14"
10
+ gem "factory_bot", "~> 6.2"
11
+ gem 'rusty_camel', "~> 1.0.4"
10
12
  end
data/Gemfile.lock CHANGED
@@ -1,28 +1,40 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- freeclimb (2.0.0)
5
- json (~> 2.1, >= 2.1.0)
4
+ freeclimb (3.0.3)
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
+ factory_bot (6.2.0)
27
+ activesupport (>= 5.0.0)
28
+ ffi (1.15.5)
29
+ hashdiff (1.0.1)
30
+ helix_runtime (0.5.0)
31
+ rake (>= 10.0)
32
+ thor (~> 0.19.4)
33
+ i18n (1.9.1)
34
+ concurrent-ruby (~> 1.0)
23
35
  jaro_winkler (1.5.4)
24
- json (2.3.0)
25
36
  method_source (0.9.2)
37
+ minitest (5.15.0)
26
38
  parallel (1.19.1)
27
39
  parser (2.7.0.2)
28
40
  ast (~> 2.4.0)
@@ -33,9 +45,10 @@ GEM
33
45
  byebug (~> 11.0)
34
46
  pry (~> 0.10)
35
47
  psych (3.1.0)
36
- public_suffix (4.0.3)
48
+ public_suffix (4.0.6)
37
49
  rainbow (3.0.0)
38
- rake (12.0.0)
50
+ rake (13.0.6)
51
+ rexml (3.2.5)
39
52
  rspec (3.9.0)
40
53
  rspec-core (~> 3.9.0)
41
54
  rspec-expectations (~> 3.9.0)
@@ -58,25 +71,33 @@ GEM
58
71
  ruby-progressbar (~> 1.7)
59
72
  unicode-display_width (>= 1.4.0, < 1.6)
60
73
  ruby-progressbar (1.10.1)
61
- safe_yaml (1.0.5)
62
- typhoeus (1.3.1)
74
+ rusty_camel (1.0.4)
75
+ helix_runtime (~> 0.5.0)
76
+ thor (0.19.4)
77
+ typhoeus (1.4.0)
63
78
  ethon (>= 0.9.0)
64
- unicode-display_width (1.5.0)
65
- webmock (3.8.0)
66
- addressable (>= 2.3.6)
79
+ tzinfo (2.0.4)
80
+ concurrent-ruby (~> 1.0)
81
+
82
+ webmock (3.14.0)
83
+ addressable (>= 2.8.0)
67
84
  crack (>= 0.3.2)
68
85
  hashdiff (>= 0.4.0, < 2.0.0)
69
86
 
87
+
70
88
  PLATFORMS
71
89
  ruby
72
90
 
73
91
  DEPENDENCIES
92
+ factory_bot (~> 6.2)
74
93
  freeclimb!
75
94
  pry-byebug
76
- rake (~> 12.0.0)
95
+ rake (~> 13.0.6)
77
96
  rspec (~> 3.6, >= 3.6.0)
78
97
  rubocop (~> 0.66.0)
79
- webmock (~> 3.8)
98
+ rusty_camel (~> 1.0.4)
99
+ webmock (~> 3.14)
100
+
80
101
 
81
102
  BUNDLED WITH
82
- 1.17.2
103
+ 2.3.6
data/README.md CHANGED
@@ -1,57 +1,53 @@
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: 2.2.0
10
+ - Package version: 3.0.3
9
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
10
12
 
11
13
  ## Installation
12
14
 
13
- ### Build a gem
14
-
15
- To build the Ruby code into a gem:
15
+ Add this to the Gemfile:
16
16
 
17
- ```shell
18
- gem build freeclimb.gemspec
19
- ```
17
+ gem 'freeclimb', '~> 3.0.3'
20
18
 
21
- Then either install the gem locally:
19
+ and run from your terminal
22
20
 
23
- ```shell
24
- gem install ./freeclimb-2.2.0.gem
25
- ```
21
+ bundle install
26
22
 
27
- (for development, run `gem install --dev ./freeclimb-2.2.0.gem` to install the development dependencies)
23
+ ### Install from Git
28
24
 
29
- or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
25
+ 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:
30
26
 
31
- Finally add this to the Gemfile:
27
+ gem 'freeclimb', :git => 'https://https://github.com/freeclimbapi/ruby-sdk.git'
32
28
 
33
- gem 'freeclimb', '~> 2.2.0'
34
-
35
- ### Install from Ruby gems
36
- ```shell
37
- gem install freeclimb
38
- ```
29
+ ### Install from RubyGems
39
30
 
40
- ### Install from Git
31
+ gem install freeclimb
32
+ or
41
33
 
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:
34
+ bundle add freeclimb
43
35
 
44
- gem 'freeclimb', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
36
+ ### Install/Build locally
37
+ To build the Ruby code into a gem:
45
38
 
46
- ### Include the Ruby code directly
39
+ ```shell
40
+ gem build freeclimb.gemspec
41
+ ```
47
42
 
48
- Include the Ruby code directly using `-I` as follows:
43
+ Then either install the gem locally:
49
44
 
50
45
  ```shell
51
- ruby -Ilib script.rb
46
+ gem install ./freeclimb-3.0.3.gem
52
47
  ```
48
+ (for development, run `gem install --dev ./freeclimb-3.0.3.gem` to install the development dependencies)
53
49
 
54
- ## Testing Your Installation
50
+ ## Getting Started
55
51
 
56
52
  Please follow the [installation](#installation) procedure and then run the following code:
57
53
 
@@ -68,15 +64,19 @@ end
68
64
 
69
65
  api_instance = Freeclimb::DefaultApi.new
70
66
 
67
+ buy_incoming_number_request = Freeclimb::BuyIncomingNumberRequest.new({phone_number: 'phone_number_example'}) # BuyIncomingNumberRequest | Incoming Number transaction details
68
+
69
+
71
70
  begin
72
- #Get an Account
73
- result = api_instance.get_an_account
71
+ #Buy a Phone Number
72
+ result = api_instance.buy_a_phone_number(buy_incoming_number_request)
74
73
  p result
75
74
  rescue Freeclimb::ApiError => e
76
- puts "Exception when calling DefaultApi->get_an_account: #{e}"
75
+ puts "Exception when calling DefaultApi->buy_a_phone_number: #{e}"
77
76
  end
78
77
 
79
78
  ```
79
+
80
80
  ## Documentation for PerCL
81
81
 
82
82
  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.
@@ -98,7 +98,6 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
98
98
 
99
99
  Class | Method | HTTP request | Description
100
100
  ------------ | ------------- | ------------- | -------------
101
- *Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
102
101
  *Freeclimb::DefaultApi* | [**buy_a_phone_number**](docs/DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
103
102
  *Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
104
103
  *Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
@@ -116,6 +115,7 @@ Class | Method | HTTP request | Description
116
115
  *Freeclimb::DefaultApi* | [**get_a_participant**](docs/DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
117
116
  *Freeclimb::DefaultApi* | [**get_a_queue**](docs/DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
118
117
  *Freeclimb::DefaultApi* | [**get_a_recording**](docs/DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
118
+ *Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
119
119
  *Freeclimb::DefaultApi* | [**get_an_application**](docs/DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
120
120
  *Freeclimb::DefaultApi* | [**get_an_incoming_number**](docs/DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
121
121
  *Freeclimb::DefaultApi* | [**get_an_sms_message**](docs/DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
@@ -166,6 +166,7 @@ Class | Method | HTTP request | Description
166
166
  - [Freeclimb::CallListAllOf](docs/CallListAllOf.md)
167
167
  - [Freeclimb::CallResult](docs/CallResult.md)
168
168
  - [Freeclimb::CallResultAllOf](docs/CallResultAllOf.md)
169
+ - [Freeclimb::Capabilities](docs/Capabilities.md)
169
170
  - [Freeclimb::ConferenceList](docs/ConferenceList.md)
170
171
  - [Freeclimb::ConferenceListAllOf](docs/ConferenceListAllOf.md)
171
172
  - [Freeclimb::ConferenceParticipantList](docs/ConferenceParticipantList.md)
@@ -259,6 +260,7 @@ Class | Method | HTTP request | Description
259
260
 
260
261
  - **Type**: HTTP basic authentication
261
262
 
263
+
262
264
  ## Getting Help
263
265
 
264
- If you are experiencing difficulties, [contact support](https://freeclimb.com/support).
266
+ 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 token 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 token 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. |
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. |
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
-
@@ -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
- **applications** | [**Array&lt;ApplicationResult&gt;**](ApplicationResult.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
+ | **applications** | [**Array&lt;ApplicationResult&gt;**](ApplicationResult.md) | | [optional] |
15
15
 
16
- ## Code Sample
16
+ ## Example
17
17
 
18
18
  ```ruby
19
19
  require 'freeclimb'
20
20
 
21
- instance = Freeclimb::ApplicationList.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
- applications: nil)
21
+ instance = Freeclimb::ApplicationList.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
+ applications: null
30
+ )
29
31
  ```
30
32
 
31
-