freeclimb 3.0.1 → 4.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (296) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/Gemfile +4 -2
  4. data/Gemfile.lock +38 -19
  5. data/README.md +37 -35
  6. data/docs/AccountRequest.md +9 -8
  7. data/docs/AccountResult.md +27 -26
  8. data/docs/AccountResultAllOf.md +19 -18
  9. data/docs/AddToConference.md +25 -24
  10. data/docs/AddToConferenceAllOf.md +25 -24
  11. data/docs/ApplicationList.md +21 -20
  12. data/docs/ApplicationListAllOf.md +7 -6
  13. data/docs/ApplicationRequest.md +19 -18
  14. data/docs/ApplicationResult.md +31 -30
  15. data/docs/ApplicationResultAllOf.md +23 -22
  16. data/docs/AvailableNumber.md +17 -16
  17. data/docs/AvailableNumberList.md +21 -20
  18. data/docs/AvailableNumberListAllOf.md +7 -6
  19. data/docs/BuyIncomingNumberRequest.md +11 -10
  20. data/docs/CallList.md +21 -20
  21. data/docs/CallListAllOf.md +7 -6
  22. data/docs/CallResult.md +43 -44
  23. data/docs/CallResultAllOf.md +35 -36
  24. data/docs/Capabilities.md +26 -0
  25. data/docs/ConferenceList.md +21 -20
  26. data/docs/ConferenceListAllOf.md +7 -6
  27. data/docs/ConferenceParticipantList.md +21 -20
  28. data/docs/ConferenceParticipantListAllOf.md +7 -6
  29. data/docs/ConferenceParticipantResult.md +25 -24
  30. data/docs/ConferenceParticipantResultAllOf.md +17 -16
  31. data/docs/ConferenceResult.md +33 -32
  32. data/docs/ConferenceResultAllOf.md +25 -24
  33. data/docs/CreateConference.md +17 -16
  34. data/docs/CreateConferenceAllOf.md +17 -16
  35. data/docs/CreateConferenceRequest.md +15 -14
  36. data/docs/DefaultApi.md +1629 -629
  37. data/docs/Dequeue.md +3 -4
  38. data/docs/Enqueue.md +13 -12
  39. data/docs/EnqueueAllOf.md +13 -12
  40. data/docs/FilterLogsRequest.md +7 -6
  41. data/docs/GetDigits.md +23 -22
  42. data/docs/GetDigitsAllOf.md +23 -22
  43. data/docs/GetSpeech.md +31 -30
  44. data/docs/GetSpeechAllOf.md +31 -30
  45. data/docs/Hangup.md +7 -6
  46. data/docs/HangupAllOf.md +7 -6
  47. data/docs/IncomingNumberList.md +21 -20
  48. data/docs/IncomingNumberListAllOf.md +7 -6
  49. data/docs/IncomingNumberRequest.md +9 -8
  50. data/docs/IncomingNumberResult.md +33 -30
  51. data/docs/IncomingNumberResultAllOf.md +25 -22
  52. data/docs/LogList.md +21 -20
  53. data/docs/LogListAllOf.md +7 -6
  54. data/docs/LogResult.md +19 -18
  55. data/docs/MakeCallRequest.md +25 -24
  56. data/docs/MessageRequest.md +23 -22
  57. data/docs/MessageRequestAllOf.md +15 -14
  58. data/docs/MessageResult.md +29 -28
  59. data/docs/MessageResultAllOf.md +21 -20
  60. data/docs/MessagesList.md +21 -20
  61. data/docs/MessagesListAllOf.md +7 -6
  62. data/docs/MutableResourceModel.md +13 -12
  63. data/docs/OutDial.md +25 -24
  64. data/docs/OutDialAllOf.md +25 -24
  65. data/docs/PaginationModel.md +19 -18
  66. data/docs/Pause.md +7 -6
  67. data/docs/PauseAllOf.md +7 -6
  68. data/docs/PerclCommand.md +7 -6
  69. data/docs/PerclScript.md +7 -6
  70. data/docs/Play.md +13 -12
  71. data/docs/PlayAllOf.md +13 -12
  72. data/docs/PlayEarlyMedia.md +7 -6
  73. data/docs/PlayEarlyMediaAllOf.md +7 -6
  74. data/docs/QueueList.md +21 -20
  75. data/docs/QueueListAllOf.md +7 -6
  76. data/docs/QueueMember.md +15 -14
  77. data/docs/QueueMemberList.md +21 -20
  78. data/docs/QueueMemberListAllOf.md +7 -6
  79. data/docs/QueueRequest.md +9 -8
  80. data/docs/QueueResult.md +27 -26
  81. data/docs/QueueResultAllOf.md +19 -18
  82. data/docs/RecordUtterance.md +19 -18
  83. data/docs/RecordUtteranceAllOf.md +19 -18
  84. data/docs/RecordingList.md +21 -20
  85. data/docs/RecordingListAllOf.md +7 -6
  86. data/docs/RecordingResult.md +23 -22
  87. data/docs/RecordingResultAllOf.md +15 -14
  88. data/docs/Redirect.md +7 -6
  89. data/docs/RedirectAllOf.md +7 -6
  90. data/docs/Reject.md +7 -6
  91. data/docs/RejectAllOf.md +7 -6
  92. data/docs/RemoveFromConference.md +7 -6
  93. data/docs/RemoveFromConferenceAllOf.md +7 -6
  94. data/docs/Say.md +15 -14
  95. data/docs/SayAllOf.md +15 -14
  96. data/docs/SendDigits.md +11 -10
  97. data/docs/SendDigitsAllOf.md +11 -10
  98. data/docs/SetListen.md +9 -8
  99. data/docs/SetListenAllOf.md +9 -8
  100. data/docs/SetTalk.md +9 -8
  101. data/docs/SetTalkAllOf.md +9 -8
  102. data/docs/Sms.md +13 -12
  103. data/docs/SmsAllOf.md +13 -12
  104. data/docs/StartRecordCall.md +3 -4
  105. data/docs/TerminateConference.md +7 -6
  106. data/docs/TerminateConferenceAllOf.md +7 -6
  107. data/docs/UpdateCallRequest.md +7 -6
  108. data/docs/UpdateConferenceParticipantRequest.md +9 -8
  109. data/docs/UpdateConferenceRequest.md +11 -10
  110. data/freeclimb.gemspec +3 -4
  111. data/lib/freeclimb/api/default_api.rb +449 -263
  112. data/lib/freeclimb/api_client.rb +55 -51
  113. data/lib/freeclimb/api_error.rb +2 -2
  114. data/lib/freeclimb/configuration.rb +41 -11
  115. data/lib/freeclimb/models/account_request.rb +20 -8
  116. data/lib/freeclimb/models/account_result.rb +39 -8
  117. data/lib/freeclimb/models/account_result_all_of.rb +39 -8
  118. data/lib/freeclimb/models/add_to_conference.rb +21 -8
  119. data/lib/freeclimb/models/add_to_conference_all_of.rb +20 -8
  120. data/lib/freeclimb/models/application_list.rb +28 -8
  121. data/lib/freeclimb/models/application_list_all_of.rb +21 -8
  122. data/lib/freeclimb/models/application_request.rb +20 -8
  123. data/lib/freeclimb/models/application_result.rb +29 -8
  124. data/lib/freeclimb/models/application_result_all_of.rb +29 -8
  125. data/lib/freeclimb/models/available_number.rb +35 -19
  126. data/lib/freeclimb/models/available_number_list.rb +28 -8
  127. data/lib/freeclimb/models/available_number_list_all_of.rb +21 -8
  128. data/lib/freeclimb/models/buy_incoming_number_request.rb +20 -8
  129. data/lib/freeclimb/models/call_list.rb +28 -8
  130. data/lib/freeclimb/models/call_list_all_of.rb +21 -8
  131. data/lib/freeclimb/models/call_result.rb +36 -21
  132. data/lib/freeclimb/models/call_result_all_of.rb +36 -21
  133. data/lib/freeclimb/models/capabilities.rb +265 -0
  134. data/lib/freeclimb/models/conference_list.rb +28 -8
  135. data/lib/freeclimb/models/conference_list_all_of.rb +21 -8
  136. data/lib/freeclimb/models/conference_participant_list.rb +28 -8
  137. data/lib/freeclimb/models/conference_participant_list_all_of.rb +21 -8
  138. data/lib/freeclimb/models/conference_participant_result.rb +26 -8
  139. data/lib/freeclimb/models/conference_participant_result_all_of.rb +26 -8
  140. data/lib/freeclimb/models/conference_result.rb +30 -8
  141. data/lib/freeclimb/models/conference_result_all_of.rb +30 -8
  142. data/lib/freeclimb/models/create_conference.rb +21 -8
  143. data/lib/freeclimb/models/create_conference_all_of.rb +20 -8
  144. data/lib/freeclimb/models/create_conference_request.rb +20 -8
  145. data/lib/freeclimb/models/dequeue.rb +21 -8
  146. data/lib/freeclimb/models/enqueue.rb +21 -8
  147. data/lib/freeclimb/models/enqueue_all_of.rb +20 -8
  148. data/lib/freeclimb/models/filter_logs_request.rb +20 -8
  149. data/lib/freeclimb/models/get_digits.rb +21 -8
  150. data/lib/freeclimb/models/get_digits_all_of.rb +20 -8
  151. data/lib/freeclimb/models/get_speech.rb +21 -8
  152. data/lib/freeclimb/models/get_speech_all_of.rb +20 -8
  153. data/lib/freeclimb/models/hangup.rb +21 -8
  154. data/lib/freeclimb/models/hangup_all_of.rb +20 -8
  155. data/lib/freeclimb/models/incoming_number_list.rb +28 -8
  156. data/lib/freeclimb/models/incoming_number_list_all_of.rb +21 -8
  157. data/lib/freeclimb/models/incoming_number_request.rb +20 -8
  158. data/lib/freeclimb/models/incoming_number_result.rb +39 -9
  159. data/lib/freeclimb/models/incoming_number_result_all_of.rb +39 -9
  160. data/lib/freeclimb/models/log_list.rb +28 -8
  161. data/lib/freeclimb/models/log_list_all_of.rb +21 -8
  162. data/lib/freeclimb/models/log_result.rb +27 -8
  163. data/lib/freeclimb/models/make_call_request.rb +22 -8
  164. data/lib/freeclimb/models/message_request.rb +20 -8
  165. data/lib/freeclimb/models/message_request_all_of.rb +20 -8
  166. data/lib/freeclimb/models/message_result.rb +28 -8
  167. data/lib/freeclimb/models/message_result_all_of.rb +28 -8
  168. data/lib/freeclimb/models/messages_list.rb +28 -8
  169. data/lib/freeclimb/models/messages_list_all_of.rb +21 -8
  170. data/lib/freeclimb/models/mutable_resource_model.rb +20 -8
  171. data/lib/freeclimb/models/out_dial.rb +21 -8
  172. data/lib/freeclimb/models/out_dial_all_of.rb +20 -8
  173. data/lib/freeclimb/models/pagination_model.rb +27 -8
  174. data/lib/freeclimb/models/pause.rb +21 -8
  175. data/lib/freeclimb/models/pause_all_of.rb +20 -8
  176. data/lib/freeclimb/models/percl_command.rb +39 -8
  177. data/lib/freeclimb/models/percl_script.rb +24 -8
  178. data/lib/freeclimb/models/play.rb +21 -8
  179. data/lib/freeclimb/models/play_all_of.rb +20 -8
  180. data/lib/freeclimb/models/play_early_media.rb +21 -8
  181. data/lib/freeclimb/models/play_early_media_all_of.rb +20 -8
  182. data/lib/freeclimb/models/queue_list.rb +28 -8
  183. data/lib/freeclimb/models/queue_list_all_of.rb +21 -8
  184. data/lib/freeclimb/models/queue_member.rb +25 -8
  185. data/lib/freeclimb/models/queue_member_list.rb +28 -8
  186. data/lib/freeclimb/models/queue_member_list_all_of.rb +21 -8
  187. data/lib/freeclimb/models/queue_request.rb +22 -8
  188. data/lib/freeclimb/models/queue_result.rb +27 -8
  189. data/lib/freeclimb/models/queue_result_all_of.rb +27 -8
  190. data/lib/freeclimb/models/record_utterance.rb +21 -8
  191. data/lib/freeclimb/models/record_utterance_all_of.rb +20 -8
  192. data/lib/freeclimb/models/recording_list.rb +28 -8
  193. data/lib/freeclimb/models/recording_list_all_of.rb +21 -8
  194. data/lib/freeclimb/models/recording_result.rb +25 -8
  195. data/lib/freeclimb/models/recording_result_all_of.rb +25 -8
  196. data/lib/freeclimb/models/redirect.rb +21 -8
  197. data/lib/freeclimb/models/redirect_all_of.rb +20 -8
  198. data/lib/freeclimb/models/reject.rb +21 -8
  199. data/lib/freeclimb/models/reject_all_of.rb +20 -8
  200. data/lib/freeclimb/models/remove_from_conference.rb +21 -8
  201. data/lib/freeclimb/models/remove_from_conference_all_of.rb +20 -8
  202. data/lib/freeclimb/models/say.rb +21 -8
  203. data/lib/freeclimb/models/say_all_of.rb +20 -8
  204. data/lib/freeclimb/models/send_digits.rb +21 -8
  205. data/lib/freeclimb/models/send_digits_all_of.rb +20 -8
  206. data/lib/freeclimb/models/set_listen.rb +21 -8
  207. data/lib/freeclimb/models/set_listen_all_of.rb +20 -8
  208. data/lib/freeclimb/models/set_talk.rb +21 -8
  209. data/lib/freeclimb/models/set_talk_all_of.rb +20 -8
  210. data/lib/freeclimb/models/sms.rb +21 -8
  211. data/lib/freeclimb/models/sms_all_of.rb +20 -8
  212. data/lib/freeclimb/models/start_record_call.rb +21 -8
  213. data/lib/freeclimb/models/terminate_conference.rb +21 -8
  214. data/lib/freeclimb/models/terminate_conference_all_of.rb +20 -8
  215. data/lib/freeclimb/models/update_call_request.rb +20 -8
  216. data/lib/freeclimb/models/update_conference_participant_request.rb +20 -8
  217. data/lib/freeclimb/models/update_conference_request.rb +20 -8
  218. data/lib/freeclimb/version.rb +3 -3
  219. data/lib/freeclimb.rb +25 -53
  220. data/spec/api/default_api_spec.rb +1095 -668
  221. data/spec/api_client_spec.rb +7 -7
  222. data/spec/configuration_spec.rb +13 -5
  223. data/spec/factories.rb +80 -0
  224. data/spec/models/account_request_spec.rb +20 -13
  225. data/spec/models/account_result_spec.rb +81 -12
  226. data/spec/models/add_to_conference_spec.rb +7 -14
  227. data/spec/models/application_list_spec.rb +55 -12
  228. data/spec/models/application_request_spec.rb +49 -12
  229. data/spec/models/application_result_spec.rb +85 -12
  230. data/spec/models/available_number_list_spec.rb +55 -13
  231. data/spec/models/available_number_spec.rb +43 -12
  232. data/spec/models/buy_incoming_number_request_spec.rb +25 -12
  233. data/spec/models/call_list_spec.rb +55 -13
  234. data/spec/models/call_result_spec.rb +124 -12
  235. data/spec/models/capabilities_spec.rb +58 -0
  236. data/spec/models/conference_list_spec.rb +55 -12
  237. data/spec/models/conference_participant_list_spec.rb +55 -12
  238. data/spec/models/conference_participant_result_spec.rb +67 -12
  239. data/spec/models/conference_result_spec.rb +99 -13
  240. data/spec/models/create_conference_request_spec.rb +41 -13
  241. data/spec/models/create_conference_spec.rb +7 -14
  242. data/spec/models/dequeue_spec.rb +7 -14
  243. data/spec/models/enqueue_spec.rb +7 -14
  244. data/spec/models/filter_logs_request_spec.rb +15 -14
  245. data/spec/models/get_digits_spec.rb +13 -14
  246. data/spec/models/get_speech_spec.rb +8 -15
  247. data/spec/models/hangup_spec.rb +5 -12
  248. data/spec/models/incoming_number_list_spec.rb +55 -13
  249. data/spec/models/incoming_number_request_spec.rb +20 -13
  250. data/spec/models/incoming_number_result_spec.rb +91 -13
  251. data/spec/models/log_list_spec.rb +55 -12
  252. data/spec/models/log_result_spec.rb +53 -12
  253. data/spec/models/make_call_request_spec.rb +67 -12
  254. data/spec/models/message_request_spec.rb +61 -13
  255. data/spec/models/message_result_spec.rb +83 -12
  256. data/spec/models/messages_list_spec.rb +55 -12
  257. data/spec/models/mutable_resource_model_spec.rb +31 -13
  258. data/spec/models/out_dial_spec.rb +13 -14
  259. data/spec/models/pagination_model_spec.rb +49 -12
  260. data/spec/models/pause_spec.rb +7 -14
  261. data/spec/models/percl_command_spec.rb +7 -14
  262. data/spec/models/percl_script_spec.rb +7 -14
  263. data/spec/models/play_early_media_spec.rb +7 -14
  264. data/spec/models/play_spec.rb +13 -14
  265. data/spec/models/queue_list_spec.rb +54 -12
  266. data/spec/models/queue_member_list_spec.rb +55 -12
  267. data/spec/models/queue_member_spec.rb +37 -13
  268. data/spec/models/queue_request_spec.rb +20 -14
  269. data/spec/models/queue_result_spec.rb +73 -12
  270. data/spec/models/record_utterance_spec.rb +13 -14
  271. data/spec/models/recording_list_spec.rb +55 -12
  272. data/spec/models/recording_result_spec.rb +61 -12
  273. data/spec/models/redirect_spec.rb +7 -14
  274. data/spec/models/reject_spec.rb +5 -12
  275. data/spec/models/remove_from_conference_spec.rb +7 -14
  276. data/spec/models/say_spec.rb +8 -15
  277. data/spec/models/send_digits_spec.rb +13 -14
  278. data/spec/models/set_listen_spec.rb +7 -14
  279. data/spec/models/set_talk_spec.rb +7 -14
  280. data/spec/models/sms_spec.rb +7 -14
  281. data/spec/models/start_record_call_spec.rb +7 -14
  282. data/spec/models/terminate_conference_spec.rb +7 -14
  283. data/spec/models/update_call_request_spec.rb +19 -14
  284. data/spec/models/update_conference_participant_request_spec.rb +20 -13
  285. data/spec/models/update_conference_request_spec.rb +29 -12
  286. data/spec/quickstart_spec.rb +10 -0
  287. data/spec/spec_helper.rb +62 -7
  288. metadata +17 -38
  289. data/freeclimb-2.0.3.gem +0 -0
  290. data/freeclimb-2.1.0.gem +0 -0
  291. data/freeclimb-2.1.1.gem +0 -0
  292. data/freeclimb-2.1.2.gem +0 -0
  293. data/freeclimb-2.2.0.gem +0 -0
  294. data/freeclimb-3.0.0.gem +0 -0
  295. data/lib/freeclimb/utils.rb +0 -34
  296. data/spec/api/web_mocks.rb +0 -473
@@ -2,46 +2,45 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **call_id** | **String** | String that uniquely identifies this Call resource. | [optional]
8
- **parent_call_id** | **String** | ID of the Call that created this leg (child Call). | [optional]
9
- **account_id** | **String** | ID of the account that owns this Call. | [optional]
10
- **from** | **String** | Phone number that initiated this Call. | [optional]
11
- **to** | **String** | Phone number that received this Call. | [optional]
12
- **phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional]
13
- **active** | **Boolean** | Whether the call is currently active or has concluded. | [optional] [default to false]
14
- **status** | **String** | * `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered. | [optional]
15
- **start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional]
16
- **connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional]
17
- **end_time** | **String** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional]
18
- **duration** | **Integer** | Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional]
19
- **connect_duration** | **Integer** | Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional]
20
- **direction** | **String** | Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API, `outboundDial` for Calls initiated by the `OutDial` PerCL command. | [optional]
21
- **answered_by** | **String** | If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise. | [optional]
22
- **subresource_uris** | [**Object**](.md) | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **call_id** | **String** | String that uniquely identifies this Call resource. | [optional] |
8
+ | **parent_call_id** | **String** | ID of the Call that created this leg (child Call). | [optional] |
9
+ | **account_id** | **String** | ID of the account that owns this Call. | [optional] |
10
+ | **from** | **String** | Phone number that initiated this Call. | [optional] |
11
+ | **to** | **String** | Phone number that received this Call. | [optional] |
12
+ | **phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional] |
13
+ | **status** | **String** | * `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered. | [optional] |
14
+ | **start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
15
+ | **connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
16
+ | **end_time** | **String** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional] |
17
+ | **duration** | **Integer** | Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
18
+ | **connect_duration** | **Integer** | Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
19
+ | **direction** | **String** | Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API, `outboundDial` for Calls initiated by the `OutDial` PerCL command. | [optional] |
20
+ | **answered_by** | **String** | If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise. | [optional] |
21
+ | **subresource_uris** | **Object** | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional] |
23
22
 
24
- ## Code Sample
23
+ ## Example
25
24
 
26
25
  ```ruby
27
26
  require 'freeclimb'
28
27
 
29
- instance = Freeclimb::CallResultAllOf.new(call_id: nil,
30
- parent_call_id: nil,
31
- account_id: nil,
32
- from: nil,
33
- to: nil,
34
- phone_number_id: nil,
35
- active: nil,
36
- status: nil,
37
- start_time: nil,
38
- connect_time: nil,
39
- end_time: nil,
40
- duration: nil,
41
- connect_duration: nil,
42
- direction: nil,
43
- answered_by: nil,
44
- subresource_uris: nil)
28
+ instance = Freeclimb::CallResultAllOf.new(
29
+ call_id: null,
30
+ parent_call_id: null,
31
+ account_id: null,
32
+ from: null,
33
+ to: null,
34
+ phone_number_id: null,
35
+ status: null,
36
+ start_time: null,
37
+ connect_time: null,
38
+ end_time: null,
39
+ duration: null,
40
+ connect_duration: null,
41
+ direction: null,
42
+ answered_by: null,
43
+ subresource_uris: null
44
+ )
45
45
  ```
46
46
 
47
-
@@ -0,0 +1,26 @@
1
+ # Freeclimb::Capabilities
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **voice** | **Boolean** | Indicates whether a number can be used for voice calls. Replaces voiceEnabled. | |
8
+ | **sms** | **Boolean** | Indicates whether a number can be used SMS messaging. Replaces smsEnabled. | |
9
+ | **toll_free** | **Boolean** | Indicates that a number is toll-free and will make toll-free calls, and when enabled, toll-free messages. | |
10
+ | **ten_dlc** | **Boolean** | Indicates that a number, if sms is true, will be used for 10DLC messaging | |
11
+ | **short_code** | **Boolean** | Indicates that a number is a short code and can be used for short code messaging | |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'freeclimb'
17
+
18
+ instance = Freeclimb::Capabilities.new(
19
+ voice: null,
20
+ sms: null,
21
+ toll_free: null,
22
+ ten_dlc: null,
23
+ short_code: null
24
+ )
25
+ ```
26
+
@@ -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
- **conferences** | [**Array<ConferenceResult>**](ConferenceResult.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
+ | **conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) | | [optional] |
15
15
 
16
- ## Code Sample
16
+ ## Example
17
17
 
18
18
  ```ruby
19
19
  require 'freeclimb'
20
20
 
21
- instance = Freeclimb::ConferenceList.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
- conferences: nil)
21
+ instance = Freeclimb::ConferenceList.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
+ conferences: null
30
+ )
29
31
  ```
30
32
 
31
-
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) | | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::ConferenceListAllOf.new(conferences: nil)
14
+ instance = Freeclimb::ConferenceListAllOf.new(
15
+ conferences: null
16
+ )
15
17
  ```
16
18
 
17
-
@@ -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
- **participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.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
+ | **participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) | | [optional] |
15
15
 
16
- ## Code Sample
16
+ ## Example
17
17
 
18
18
  ```ruby
19
19
  require 'freeclimb'
20
20
 
21
- instance = Freeclimb::ConferenceParticipantList.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
- participants: nil)
21
+ instance = Freeclimb::ConferenceParticipantList.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
+ participants: null
30
+ )
29
31
  ```
30
32
 
31
-
@@ -2,16 +2,17 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) | | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) | | [optional] |
8
8
 
9
- ## Code Sample
9
+ ## Example
10
10
 
11
11
  ```ruby
12
12
  require 'freeclimb'
13
13
 
14
- instance = Freeclimb::ConferenceParticipantListAllOf.new(participants: nil)
14
+ instance = Freeclimb::ConferenceParticipantListAllOf.new(
15
+ participants: null
16
+ )
15
17
  ```
16
18
 
17
-
@@ -2,34 +2,35 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
8
- **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
9
- **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
- **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
- **account_id** | **String** | ID of the account that created this participant. | [optional]
12
- **conference_id** | **String** | ID of the conference this participant is in. | [optional]
13
- **call_id** | **String** | ID of the Call associated with this Participant. | [optional]
14
- **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional]
15
- **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional]
16
- **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] |
8
+ | **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
9
+ | **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
10
+ | **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
11
+ | **account_id** | **String** | ID of the account that created this participant. | [optional] |
12
+ | **conference_id** | **String** | ID of the conference this participant is in. | [optional] |
13
+ | **call_id** | **String** | ID of the Call associated with this Participant. | [optional] |
14
+ | **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional] |
15
+ | **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional] |
16
+ | **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional] |
17
17
 
18
- ## Code Sample
18
+ ## Example
19
19
 
20
20
  ```ruby
21
21
  require 'freeclimb'
22
22
 
23
- instance = Freeclimb::ConferenceParticipantResult.new(uri: nil,
24
- date_created: nil,
25
- date_updated: nil,
26
- revision: nil,
27
- account_id: nil,
28
- conference_id: nil,
29
- call_id: nil,
30
- talk: nil,
31
- listen: nil,
32
- start_conf_on_enter: nil)
23
+ instance = Freeclimb::ConferenceParticipantResult.new(
24
+ uri: null,
25
+ date_created: null,
26
+ date_updated: null,
27
+ revision: null,
28
+ account_id: null,
29
+ conference_id: null,
30
+ call_id: null,
31
+ talk: null,
32
+ listen: null,
33
+ start_conf_on_enter: null
34
+ )
33
35
  ```
34
36
 
35
-
@@ -2,26 +2,27 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **account_id** | **String** | ID of the account that created this participant. | [optional]
8
- **conference_id** | **String** | ID of the conference this participant is in. | [optional]
9
- **call_id** | **String** | ID of the Call associated with this Participant. | [optional]
10
- **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional]
11
- **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional]
12
- **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **account_id** | **String** | ID of the account that created this participant. | [optional] |
8
+ | **conference_id** | **String** | ID of the conference this participant is in. | [optional] |
9
+ | **call_id** | **String** | ID of the Call associated with this Participant. | [optional] |
10
+ | **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional] |
11
+ | **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional] |
12
+ | **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional] |
13
13
 
14
- ## Code Sample
14
+ ## Example
15
15
 
16
16
  ```ruby
17
17
  require 'freeclimb'
18
18
 
19
- instance = Freeclimb::ConferenceParticipantResultAllOf.new(account_id: nil,
20
- conference_id: nil,
21
- call_id: nil,
22
- talk: nil,
23
- listen: nil,
24
- start_conf_on_enter: nil)
19
+ instance = Freeclimb::ConferenceParticipantResultAllOf.new(
20
+ account_id: null,
21
+ conference_id: null,
22
+ call_id: null,
23
+ talk: null,
24
+ listen: null,
25
+ start_conf_on_enter: null
26
+ )
25
27
  ```
26
28
 
27
-
@@ -2,42 +2,43 @@
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
- **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional]
12
- **account_id** | **String** | ID of the account that created this Conference. | [optional]
13
- **_alias** | **String** | A description for this Conference. | [optional]
14
- **play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional]
15
- **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional]
16
- **status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional]
17
- **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional]
18
- **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional]
19
- **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional]
20
- **subresource_uris** | [**Object**](.md) | The list of subresources for this Conference. This includes participants and/or recordings. | [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
+ | **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional] |
12
+ | **account_id** | **String** | ID of the account that created this Conference. | [optional] |
13
+ | **_alias** | **String** | A description for this Conference. | [optional] |
14
+ | **play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional] |
15
+ | **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional] |
16
+ | **status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional] |
17
+ | **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional] |
18
+ | **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional] |
19
+ | **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional] |
20
+ | **subresource_uris** | **Object** | The list of subresources for this Conference. This includes participants and/or recordings. | [optional] |
21
21
 
22
- ## Code Sample
22
+ ## Example
23
23
 
24
24
  ```ruby
25
25
  require 'freeclimb'
26
26
 
27
- instance = Freeclimb::ConferenceResult.new(uri: nil,
28
- date_created: nil,
29
- date_updated: nil,
30
- revision: nil,
31
- conference_id: nil,
32
- account_id: nil,
33
- _alias: nil,
34
- play_beep: nil,
35
- record: nil,
36
- status: nil,
37
- wait_url: nil,
38
- action_url: nil,
39
- status_callback_url: nil,
40
- subresource_uris: nil)
27
+ instance = Freeclimb::ConferenceResult.new(
28
+ uri: null,
29
+ date_created: null,
30
+ date_updated: null,
31
+ revision: null,
32
+ conference_id: null,
33
+ account_id: null,
34
+ _alias: null,
35
+ play_beep: null,
36
+ record: null,
37
+ status: null,
38
+ wait_url: null,
39
+ action_url: null,
40
+ status_callback_url: null,
41
+ subresource_uris: null
42
+ )
41
43
  ```
42
44
 
43
-
@@ -2,34 +2,35 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional]
8
- **account_id** | **String** | ID of the account that created this Conference. | [optional]
9
- **_alias** | **String** | A description for this Conference. | [optional]
10
- **play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional]
11
- **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional]
12
- **status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional]
13
- **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional]
14
- **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional]
15
- **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional]
16
- **subresource_uris** | [**Object**](.md) | The list of subresources for this Conference. This includes participants and/or recordings. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional] |
8
+ | **account_id** | **String** | ID of the account that created this Conference. | [optional] |
9
+ | **_alias** | **String** | A description for this Conference. | [optional] |
10
+ | **play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional] |
11
+ | **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional] |
12
+ | **status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional] |
13
+ | **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional] |
14
+ | **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional] |
15
+ | **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional] |
16
+ | **subresource_uris** | **Object** | The list of subresources for this Conference. This includes participants and/or recordings. | [optional] |
17
17
 
18
- ## Code Sample
18
+ ## Example
19
19
 
20
20
  ```ruby
21
21
  require 'freeclimb'
22
22
 
23
- instance = Freeclimb::ConferenceResultAllOf.new(conference_id: nil,
24
- account_id: nil,
25
- _alias: nil,
26
- play_beep: nil,
27
- record: nil,
28
- status: nil,
29
- wait_url: nil,
30
- action_url: nil,
31
- status_callback_url: nil,
32
- subresource_uris: nil)
23
+ instance = Freeclimb::ConferenceResultAllOf.new(
24
+ conference_id: null,
25
+ account_id: null,
26
+ _alias: null,
27
+ play_beep: null,
28
+ record: null,
29
+ status: null,
30
+ wait_url: null,
31
+ action_url: null,
32
+ status_callback_url: null,
33
+ subresource_uris: null
34
+ )
33
35
  ```
34
36
 
35
-
@@ -2,26 +2,27 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. |
8
- **_alias** | **Boolean** | Descriptive name for the Conference. | [optional]
9
- **play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional]
10
- **record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional]
11
- **status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional]
12
- **wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. | |
8
+ | **_alias** | **Boolean** | Descriptive name for the Conference. | [optional] |
9
+ | **play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional] |
10
+ | **record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional] |
11
+ | **status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional] |
12
+ | **wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional] |
13
13
 
14
- ## Code Sample
14
+ ## Example
15
15
 
16
16
  ```ruby
17
17
  require 'freeclimb'
18
18
 
19
- instance = Freeclimb::CreateConference.new(action_url: nil,
20
- _alias: nil,
21
- play_beep: nil,
22
- record: nil,
23
- status_callback_url: nil,
24
- wait_url: nil)
19
+ instance = Freeclimb::CreateConference.new(
20
+ action_url: null,
21
+ _alias: null,
22
+ play_beep: null,
23
+ record: null,
24
+ status_callback_url: null,
25
+ wait_url: null
26
+ )
25
27
  ```
26
28
 
27
-
@@ -2,26 +2,27 @@
2
2
 
3
3
  ## Properties
4
4
 
5
- Name | Type | Description | Notes
6
- ------------ | ------------- | ------------- | -------------
7
- **action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. |
8
- **_alias** | **Boolean** | Descriptive name for the Conference. | [optional]
9
- **play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional]
10
- **record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional]
11
- **status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional]
12
- **wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional]
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. | |
8
+ | **_alias** | **Boolean** | Descriptive name for the Conference. | [optional] |
9
+ | **play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional] |
10
+ | **record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional] |
11
+ | **status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional] |
12
+ | **wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional] |
13
13
 
14
- ## Code Sample
14
+ ## Example
15
15
 
16
16
  ```ruby
17
17
  require 'freeclimb'
18
18
 
19
- instance = Freeclimb::CreateConferenceAllOf.new(action_url: nil,
20
- _alias: nil,
21
- play_beep: nil,
22
- record: nil,
23
- status_callback_url: nil,
24
- wait_url: nil)
19
+ instance = Freeclimb::CreateConferenceAllOf.new(
20
+ action_url: null,
21
+ _alias: null,
22
+ play_beep: null,
23
+ record: null,
24
+ status_callback_url: null,
25
+ wait_url: null
26
+ )
25
27
  ```
26
28
 
27
-