freeclimb 3.0.2 → 3.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (330) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +6 -0
  3. data/Gemfile +4 -1
  4. data/Gemfile.lock +41 -20
  5. data/README.md +34 -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 -14
  17. data/docs/AvailableNumberList.md +21 -20
  18. data/docs/AvailableNumberListAllOf.md +7 -6
  19. data/docs/BuyIncomingNumberRequest.md +11 -10
  20. data/docs/CallList.md +21 -20
  21. data/docs/CallListAllOf.md +7 -6
  22. data/docs/CallResult.md +43 -42
  23. data/docs/CallResultAllOf.md +35 -34
  24. data/docs/Capabilities.md +26 -0
  25. data/docs/ConferenceList.md +21 -20
  26. data/docs/ConferenceListAllOf.md +7 -6
  27. data/docs/ConferenceParticipantList.md +21 -20
  28. data/docs/ConferenceParticipantListAllOf.md +7 -6
  29. data/docs/ConferenceParticipantResult.md +25 -24
  30. data/docs/ConferenceParticipantResultAllOf.md +17 -16
  31. data/docs/ConferenceResult.md +33 -32
  32. data/docs/ConferenceResultAllOf.md +25 -24
  33. data/docs/CreateConference.md +17 -16
  34. data/docs/CreateConferenceAllOf.md +17 -16
  35. data/docs/CreateConferenceRequest.md +15 -14
  36. data/docs/DefaultApi.md +1670 -600
  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 +424 -272
  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 +19 -7
  117. data/lib/freeclimb/models/account_result_all_of.rb +19 -7
  118. data/lib/freeclimb/models/add_to_conference.rb +19 -7
  119. data/lib/freeclimb/models/add_to_conference_all_of.rb +19 -7
  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 -8
  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 +19 -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 +1001 -18
  221. data/spec/api_client_spec.rb +4 -4
  222. data/spec/configuration_spec.rb +9 -9
  223. data/spec/factories.rb +80 -0
  224. data/spec/models/account_request_spec.rb +4 -11
  225. data/spec/models/account_result_spec.rb +5 -12
  226. data/spec/models/add_to_conference_spec.rb +4 -11
  227. data/spec/models/application_list_spec.rb +4 -11
  228. data/spec/models/application_request_spec.rb +4 -11
  229. data/spec/models/application_result_spec.rb +4 -11
  230. data/spec/models/available_number_list_spec.rb +4 -11
  231. data/spec/models/available_number_spec.rb +10 -11
  232. data/spec/models/buy_incoming_number_request_spec.rb +4 -11
  233. data/spec/models/call_list_spec.rb +4 -11
  234. data/spec/models/call_result_spec.rb +5 -12
  235. data/spec/models/{say_all_of_spec.rb → capabilities_spec.rb} +12 -19
  236. data/spec/models/conference_list_spec.rb +4 -11
  237. data/spec/models/conference_participant_list_spec.rb +4 -11
  238. data/spec/models/conference_participant_result_spec.rb +4 -11
  239. data/spec/models/conference_result_spec.rb +6 -13
  240. data/spec/models/create_conference_request_spec.rb +5 -12
  241. data/spec/models/create_conference_spec.rb +4 -11
  242. data/spec/models/dequeue_spec.rb +4 -11
  243. data/spec/models/enqueue_spec.rb +4 -11
  244. data/spec/models/filter_logs_request_spec.rb +4 -11
  245. data/spec/models/get_digits_spec.rb +4 -11
  246. data/spec/models/get_speech_spec.rb +4 -11
  247. data/spec/models/hangup_spec.rb +4 -11
  248. data/spec/models/incoming_number_list_spec.rb +4 -11
  249. data/spec/models/incoming_number_request_spec.rb +4 -11
  250. data/spec/models/incoming_number_result_spec.rb +10 -11
  251. data/spec/models/log_list_spec.rb +4 -11
  252. data/spec/models/log_result_spec.rb +5 -12
  253. data/spec/models/make_call_request_spec.rb +4 -11
  254. data/spec/models/message_request_spec.rb +4 -11
  255. data/spec/models/message_result_spec.rb +5 -12
  256. data/spec/models/messages_list_spec.rb +4 -11
  257. data/spec/models/mutable_resource_model_spec.rb +4 -11
  258. data/spec/models/out_dial_spec.rb +4 -11
  259. data/spec/models/pagination_model_spec.rb +4 -11
  260. data/spec/models/pause_spec.rb +4 -11
  261. data/spec/models/percl_command_spec.rb +4 -11
  262. data/spec/models/percl_script_spec.rb +4 -11
  263. data/spec/models/play_early_media_spec.rb +4 -11
  264. data/spec/models/play_spec.rb +4 -11
  265. data/spec/models/queue_list_spec.rb +4 -11
  266. data/spec/models/queue_member_list_spec.rb +4 -11
  267. data/spec/models/queue_member_spec.rb +4 -11
  268. data/spec/models/queue_request_spec.rb +4 -11
  269. data/spec/models/queue_result_spec.rb +4 -11
  270. data/spec/models/record_utterance_spec.rb +4 -11
  271. data/spec/models/recording_list_spec.rb +4 -11
  272. data/spec/models/recording_result_spec.rb +4 -11
  273. data/spec/models/redirect_spec.rb +4 -11
  274. data/spec/models/reject_spec.rb +4 -11
  275. data/spec/models/remove_from_conference_spec.rb +4 -11
  276. data/spec/models/say_spec.rb +4 -11
  277. data/spec/models/send_digits_spec.rb +4 -11
  278. data/spec/models/set_listen_spec.rb +4 -11
  279. data/spec/models/set_talk_spec.rb +4 -11
  280. data/spec/models/sms_spec.rb +4 -11
  281. data/spec/models/start_record_call_spec.rb +4 -11
  282. data/spec/models/terminate_conference_spec.rb +4 -11
  283. data/spec/models/update_call_request_spec.rb +5 -12
  284. data/spec/models/update_conference_participant_request_spec.rb +4 -11
  285. data/spec/models/update_conference_request_spec.rb +5 -12
  286. data/spec/quickstart_spec.rb +10 -0
  287. data/spec/spec_helper.rb +55 -1
  288. metadata +20 -117
  289. data/lib/freeclimb/utils.rb +0 -34
  290. data/spec/api/web_mocks.rb +0 -473
  291. data/spec/models/account_result_all_of_spec.rb +0 -81
  292. data/spec/models/add_to_conference_all_of_spec.rb +0 -95
  293. data/spec/models/application_list_all_of_spec.rb +0 -41
  294. data/spec/models/application_result_all_of_spec.rb +0 -89
  295. data/spec/models/available_number_list_all_of_spec.rb +0 -41
  296. data/spec/models/call_list_all_of_spec.rb +0 -41
  297. data/spec/models/call_result_all_of_spec.rb +0 -129
  298. data/spec/models/conference_list_all_of_spec.rb +0 -41
  299. data/spec/models/conference_participant_list_all_of_spec.rb +0 -41
  300. data/spec/models/conference_participant_result_all_of_spec.rb +0 -71
  301. data/spec/models/conference_result_all_of_spec.rb +0 -103
  302. data/spec/models/create_conference_all_of_spec.rb +0 -71
  303. data/spec/models/enqueue_all_of_spec.rb +0 -59
  304. data/spec/models/get_digits_all_of_spec.rb +0 -89
  305. data/spec/models/get_speech_all_of_spec.rb +0 -113
  306. data/spec/models/hangup_all_of_spec.rb +0 -41
  307. data/spec/models/incoming_number_list_all_of_spec.rb +0 -41
  308. data/spec/models/incoming_number_result_all_of_spec.rb +0 -89
  309. data/spec/models/log_list_all_of_spec.rb +0 -41
  310. data/spec/models/message_request_all_of_spec.rb +0 -65
  311. data/spec/models/message_result_all_of_spec.rb +0 -87
  312. data/spec/models/messages_list_all_of_spec.rb +0 -41
  313. data/spec/models/out_dial_all_of_spec.rb +0 -95
  314. data/spec/models/pause_all_of_spec.rb +0 -41
  315. data/spec/models/play_all_of_spec.rb +0 -59
  316. data/spec/models/play_early_media_all_of_spec.rb +0 -41
  317. data/spec/models/queue_list_all_of_spec.rb +0 -41
  318. data/spec/models/queue_member_list_all_of_spec.rb +0 -41
  319. data/spec/models/queue_result_all_of_spec.rb +0 -77
  320. data/spec/models/record_utterance_all_of_spec.rb +0 -77
  321. data/spec/models/recording_list_all_of_spec.rb +0 -41
  322. data/spec/models/recording_result_all_of_spec.rb +0 -65
  323. data/spec/models/redirect_all_of_spec.rb +0 -41
  324. data/spec/models/reject_all_of_spec.rb +0 -41
  325. data/spec/models/remove_from_conference_all_of_spec.rb +0 -41
  326. data/spec/models/send_digits_all_of_spec.rb +0 -53
  327. data/spec/models/set_listen_all_of_spec.rb +0 -47
  328. data/spec/models/set_talk_all_of_spec.rb +0 -47
  329. data/spec/models/sms_all_of_spec.rb +0 -59
  330. data/spec/models/terminate_conference_all_of_spec.rb +0 -41
data/docs/DefaultApi.md CHANGED
@@ -2,140 +2,114 @@
2
2
 
3
3
  All URIs are relative to *https://www.freeclimb.com/apiserver*
4
4
 
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**get_an_account**](DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
8
- [**buy_a_phone_number**](DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
9
- [**create_a_conference**](DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
10
- [**create_a_queue**](DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
11
- [**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application
12
- [**delete_a_recording**](DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
13
- [**delete_an_application**](DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
14
- [**delete_an_incoming_number**](DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
15
- [**dequeue_a_member**](DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member
16
- [**dequeue_head_member**](DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member
17
- [**download_a_recording_file**](DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File
18
- [**filter_logs**](DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs
19
- [**get_a_call**](DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call
20
- [**get_a_conference**](DefaultApi.md#get_a_conference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference
21
- [**get_a_member**](DefaultApi.md#get_a_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Get a Member
22
- [**get_a_participant**](DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
23
- [**get_a_queue**](DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
24
- [**get_a_recording**](DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
25
- [**get_an_application**](DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
26
- [**get_an_incoming_number**](DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
27
- [**get_an_sms_message**](DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
28
- [**get_head_member**](DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member
29
- [**list_active_queues**](DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues
30
- [**list_all_account_logs**](DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs
31
- [**list_an_application**](DefaultApi.md#list_an_application) | **GET** /Accounts/{accountId}/Applications | List applications
32
- [**list_available_numbers**](DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers
33
- [**list_call_logs**](DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs
34
- [**list_call_recordings**](DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings
35
- [**list_calls**](DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls
36
- [**list_conferences**](DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences
37
- [**list_incoming_numbers**](DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers
38
- [**list_members**](DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members
39
- [**list_participants**](DefaultApi.md#list_participants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants
40
- [**list_recordings**](DefaultApi.md#list_recordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings
41
- [**list_sms_messages**](DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages
42
- [**make_a_call**](DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call
43
- [**remove_a_participant**](DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant
44
- [**send_an_sms_message**](DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message
45
- [**stream_a_recording_file**](DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File
46
- [**update_a_conference**](DefaultApi.md#update_a_conference) | **POST** /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference
47
- [**update_a_live_call**](DefaultApi.md#update_a_live_call) | **POST** /Accounts/{accountId}/Calls/{callId} | Update a Live Call
48
- [**update_a_participant**](DefaultApi.md#update_a_participant) | **POST** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Update a Participant
49
- [**update_a_queue**](DefaultApi.md#update_a_queue) | **POST** /Accounts/{accountId}/Queues/{queueId} | Update a Queue
50
- [**update_an_account**](DefaultApi.md#update_an_account) | **POST** /Accounts/{accountId} | Manage an account
51
- [**update_an_application**](DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
52
- [**update_an_incoming_number**](DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**buy_a_phone_number**](DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number |
8
+ | [**create_a_conference**](DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference |
9
+ | [**create_a_queue**](DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue |
10
+ | [**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application |
11
+ | [**delete_a_recording**](DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording |
12
+ | [**delete_an_application**](DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application |
13
+ | [**delete_an_incoming_number**](DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number |
14
+ | [**dequeue_a_member**](DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member |
15
+ | [**dequeue_head_member**](DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member |
16
+ | [**download_a_recording_file**](DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File |
17
+ | [**filter_logs**](DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs |
18
+ | [**get_a_call**](DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call |
19
+ | [**get_a_conference**](DefaultApi.md#get_a_conference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference |
20
+ | [**get_a_member**](DefaultApi.md#get_a_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Get a Member |
21
+ | [**get_a_participant**](DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant |
22
+ | [**get_a_queue**](DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue |
23
+ | [**get_a_recording**](DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording |
24
+ | [**get_an_account**](DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account |
25
+ | [**get_an_application**](DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application |
26
+ | [**get_an_incoming_number**](DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number |
27
+ | [**get_an_sms_message**](DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message |
28
+ | [**get_head_member**](DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member |
29
+ | [**list_active_queues**](DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues |
30
+ | [**list_all_account_logs**](DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs |
31
+ | [**list_an_application**](DefaultApi.md#list_an_application) | **GET** /Accounts/{accountId}/Applications | List applications |
32
+ | [**list_available_numbers**](DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers |
33
+ | [**list_call_logs**](DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs |
34
+ | [**list_call_recordings**](DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings |
35
+ | [**list_calls**](DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls |
36
+ | [**list_conferences**](DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences |
37
+ | [**list_incoming_numbers**](DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers |
38
+ | [**list_members**](DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members |
39
+ | [**list_participants**](DefaultApi.md#list_participants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants |
40
+ | [**list_recordings**](DefaultApi.md#list_recordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings |
41
+ | [**list_sms_messages**](DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages |
42
+ | [**make_a_call**](DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call |
43
+ | [**remove_a_participant**](DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant |
44
+ | [**send_an_sms_message**](DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message |
45
+ | [**stream_a_recording_file**](DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File |
46
+ | [**update_a_conference**](DefaultApi.md#update_a_conference) | **POST** /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference |
47
+ | [**update_a_live_call**](DefaultApi.md#update_a_live_call) | **POST** /Accounts/{accountId}/Calls/{callId} | Update a Live Call |
48
+ | [**update_a_participant**](DefaultApi.md#update_a_participant) | **POST** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Update a Participant |
49
+ | [**update_a_queue**](DefaultApi.md#update_a_queue) | **POST** /Accounts/{accountId}/Queues/{queueId} | Update a Queue |
50
+ | [**update_an_account**](DefaultApi.md#update_an_account) | **POST** /Accounts/{accountId} | Manage an account |
51
+ | [**update_an_application**](DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application |
52
+ | [**update_an_incoming_number**](DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number |
53
53
 
54
54
 
55
+ ## buy_a_phone_number
55
56
 
56
- ## get_an_account
57
-
58
- > AccountResult get_an_account
57
+ > <IncomingNumberResult> buy_a_phone_number(account_id, buy_incoming_number_request)
59
58
 
60
- Get an Account
59
+ Buy a Phone Number
61
60
 
62
- ### Example
61
+ ### Examples
63
62
 
64
63
  ```ruby
65
- # load the gem
64
+ require 'time'
66
65
  require 'freeclimb'
67
66
  # setup authorization
68
67
  Freeclimb.configure do |config|
69
68
  # Configure HTTP basic authorization: fc
70
- config.username = 'ACCOUNT ID'
71
- config.password = 'API KEY'
69
+ config.username = 'ACCOUNT_ID'
70
+ config.password = 'API_KEY'
72
71
  end
73
72
 
74
73
  api_instance = Freeclimb::DefaultApi.new
75
74
 
75
+ buy_incoming_number_request = Freeclimb::BuyIncomingNumberRequest.new({phone_number: 'phone_number_example'}) # BuyIncomingNumberRequest | Incoming Number transaction details
76
+
77
+
76
78
  begin
77
- #Get an Account
78
- result = api_instance.get_an_account
79
+
80
+ # Buy a Phone Number
81
+ result = api_instance.buy_a_phone_number(buy_incoming_number_request)
79
82
  p result
80
83
  rescue Freeclimb::ApiError => e
81
- puts "Exception when calling DefaultApi->get_an_account: #{e}"
84
+ puts "Error when calling DefaultApi->buy_a_phone_number: #{e}"
82
85
  end
83
86
  ```
84
87
 
85
- ### Parameters
86
-
87
- This endpoint does not need any parameter.
88
-
89
- ### Return type
90
-
91
- [**AccountResult**](AccountResult.md)
88
+ #### Using the buy_a_phone_number_with_http_info variant
92
89
 
93
- ### Authorization
94
-
95
- [fc](../README.md#fc)
96
-
97
- ### HTTP request headers
98
-
99
- - **Content-Type**: Not defined
100
- - **Accept**: application/json
101
-
102
-
103
- ## buy_a_phone_number
104
-
105
- > IncomingNumberResult buy_a_phone_number(buy_incoming_number_request)
106
-
107
- Buy a Phone Number
90
+ This returns an Array which contains the response data, status code and headers.
108
91
 
109
- ### Example
92
+ > <Array(<IncomingNumberResult>, Integer, Hash)> buy_a_phone_number_with_http_info(account_id, buy_incoming_number_request)
110
93
 
111
94
  ```ruby
112
- # load the gem
113
- require 'freeclimb'
114
- # setup authorization
115
- Freeclimb.configure do |config|
116
- # Configure HTTP basic authorization: fc
117
- config.username = 'ACCOUNT ID'
118
- config.password = 'API KEY'
119
- end
120
-
121
- api_instance = Freeclimb::DefaultApi.new
122
- buy_incoming_number_request = Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
123
-
124
95
  begin
125
- #Buy a Phone Number
126
- result = api_instance.buy_a_phone_number(buy_incoming_number_request)
127
- p result
96
+ # Buy a Phone Number
97
+ data, status_code, headers = api_instance.buy_a_phone_number_with_http_info(buy_incoming_number_request)
98
+ p status_code # => 2xx
99
+ p headers # => { ... }
100
+ p data # => <IncomingNumberResult>
128
101
  rescue Freeclimb::ApiError => e
129
- puts "Exception when calling DefaultApi->buy_a_phone_number: #{e}"
102
+ puts "Error when calling DefaultApi->buy_a_phone_number_with_http_info: #{e}"
130
103
  end
131
104
  ```
132
105
 
133
106
  ### Parameters
134
107
 
108
+ | Name | Type | Description | Notes |
109
+ | ---- | ---- | ----------- | ----- |
110
+
111
+ | **buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md) | Incoming Number transaction details | |
135
112
 
136
- Name | Type | Description | Notes
137
- ------------- | ------------- | ------------- | -------------
138
- **buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md)| Incoming Number transaction details |
139
113
 
140
114
  ### Return type
141
115
 
@@ -153,42 +127,63 @@ Name | Type | Description | Notes
153
127
 
154
128
  ## create_a_conference
155
129
 
156
- > ConferenceResult create_a_conference(opts)
130
+ > <ConferenceResult> create_a_conference(account_id, opts)
157
131
 
158
132
  Create a Conference
159
133
 
160
- ### Example
134
+ ### Examples
161
135
 
162
136
  ```ruby
163
- # load the gem
137
+ require 'time'
164
138
  require 'freeclimb'
165
139
  # setup authorization
166
140
  Freeclimb.configure do |config|
167
141
  # Configure HTTP basic authorization: fc
168
- config.username = 'ACCOUNT ID'
169
- config.password = 'API KEY'
142
+ config.username = 'ACCOUNT_ID'
143
+ config.password = 'API_KEY'
170
144
  end
171
145
 
172
146
  api_instance = Freeclimb::DefaultApi.new
147
+
173
148
  opts = {
174
149
  create_conference_request: Freeclimb::CreateConferenceRequest.new # CreateConferenceRequest | Conference to create
175
150
  }
176
151
 
177
152
  begin
178
- #Create a Conference
153
+
154
+ # Create a Conference
179
155
  result = api_instance.create_a_conference(opts)
180
156
  p result
181
157
  rescue Freeclimb::ApiError => e
182
- puts "Exception when calling DefaultApi->create_a_conference: #{e}"
158
+ puts "Error when calling DefaultApi->create_a_conference: #{e}"
159
+ end
160
+ ```
161
+
162
+ #### Using the create_a_conference_with_http_info variant
163
+
164
+ This returns an Array which contains the response data, status code and headers.
165
+
166
+ > <Array(<ConferenceResult>, Integer, Hash)> create_a_conference_with_http_info(account_id, opts)
167
+
168
+ ```ruby
169
+ begin
170
+ # Create a Conference
171
+ data, status_code, headers = api_instance.create_a_conference_with_http_info(opts)
172
+ p status_code # => 2xx
173
+ p headers # => { ... }
174
+ p data # => <ConferenceResult>
175
+ rescue Freeclimb::ApiError => e
176
+ puts "Error when calling DefaultApi->create_a_conference_with_http_info: #{e}"
183
177
  end
184
178
  ```
185
179
 
186
180
  ### Parameters
187
181
 
182
+ | Name | Type | Description | Notes |
183
+ | ---- | ---- | ----------- | ----- |
184
+
185
+ | **create_conference_request** | [**CreateConferenceRequest**](CreateConferenceRequest.md) | Conference to create | [optional] |
188
186
 
189
- Name | Type | Description | Notes
190
- ------------- | ------------- | ------------- | -------------
191
- **create_conference_request** | [**CreateConferenceRequest**](CreateConferenceRequest.md)| Conference to create | [optional]
192
187
 
193
188
  ### Return type
194
189
 
@@ -206,42 +201,63 @@ Name | Type | Description | Notes
206
201
 
207
202
  ## create_a_queue
208
203
 
209
- > QueueResult create_a_queue(opts)
204
+ > <QueueResult> create_a_queue(account_id, opts)
210
205
 
211
206
  Create a Queue
212
207
 
213
- ### Example
208
+ ### Examples
214
209
 
215
210
  ```ruby
216
- # load the gem
211
+ require 'time'
217
212
  require 'freeclimb'
218
213
  # setup authorization
219
214
  Freeclimb.configure do |config|
220
215
  # Configure HTTP basic authorization: fc
221
- config.username = 'ACCOUNT ID'
222
- config.password = 'API KEY'
216
+ config.username = 'ACCOUNT_ID'
217
+ config.password = 'API_KEY'
223
218
  end
224
219
 
225
220
  api_instance = Freeclimb::DefaultApi.new
221
+
226
222
  opts = {
227
223
  queue_request: Freeclimb::QueueRequest.new # QueueRequest | Queue details used to create a queue
228
224
  }
229
225
 
230
226
  begin
231
- #Create a Queue
227
+
228
+ # Create a Queue
232
229
  result = api_instance.create_a_queue(opts)
233
230
  p result
234
231
  rescue Freeclimb::ApiError => e
235
- puts "Exception when calling DefaultApi->create_a_queue: #{e}"
232
+ puts "Error when calling DefaultApi->create_a_queue: #{e}"
233
+ end
234
+ ```
235
+
236
+ #### Using the create_a_queue_with_http_info variant
237
+
238
+ This returns an Array which contains the response data, status code and headers.
239
+
240
+ > <Array(<QueueResult>, Integer, Hash)> create_a_queue_with_http_info(account_id, opts)
241
+
242
+ ```ruby
243
+ begin
244
+ # Create a Queue
245
+ data, status_code, headers = api_instance.create_a_queue_with_http_info(opts)
246
+ p status_code # => 2xx
247
+ p headers # => { ... }
248
+ p data # => <QueueResult>
249
+ rescue Freeclimb::ApiError => e
250
+ puts "Error when calling DefaultApi->create_a_queue_with_http_info: #{e}"
236
251
  end
237
252
  ```
238
253
 
239
254
  ### Parameters
240
255
 
256
+ | Name | Type | Description | Notes |
257
+ | ---- | ---- | ----------- | ----- |
258
+
259
+ | **queue_request** | [**QueueRequest**](QueueRequest.md) | Queue details used to create a queue | [optional] |
241
260
 
242
- Name | Type | Description | Notes
243
- ------------- | ------------- | ------------- | -------------
244
- **queue_request** | [**QueueRequest**](QueueRequest.md)| Queue details used to create a queue | [optional]
245
261
 
246
262
  ### Return type
247
263
 
@@ -259,42 +275,63 @@ Name | Type | Description | Notes
259
275
 
260
276
  ## create_an_application
261
277
 
262
- > ApplicationResult create_an_application(opts)
278
+ > <ApplicationResult> create_an_application(account_id, opts)
263
279
 
264
280
  Create an application
265
281
 
266
- ### Example
282
+ ### Examples
267
283
 
268
284
  ```ruby
269
- # load the gem
285
+ require 'time'
270
286
  require 'freeclimb'
271
287
  # setup authorization
272
288
  Freeclimb.configure do |config|
273
289
  # Configure HTTP basic authorization: fc
274
- config.username = 'ACCOUNT ID'
275
- config.password = 'API KEY'
290
+ config.username = 'ACCOUNT_ID'
291
+ config.password = 'API_KEY'
276
292
  end
277
293
 
278
294
  api_instance = Freeclimb::DefaultApi.new
295
+
279
296
  opts = {
280
297
  application_request: Freeclimb::ApplicationRequest.new # ApplicationRequest | Application Details
281
298
  }
282
299
 
283
300
  begin
284
- #Create an application
301
+
302
+ # Create an application
285
303
  result = api_instance.create_an_application(opts)
286
304
  p result
287
305
  rescue Freeclimb::ApiError => e
288
- puts "Exception when calling DefaultApi->create_an_application: #{e}"
306
+ puts "Error when calling DefaultApi->create_an_application: #{e}"
307
+ end
308
+ ```
309
+
310
+ #### Using the create_an_application_with_http_info variant
311
+
312
+ This returns an Array which contains the response data, status code and headers.
313
+
314
+ > <Array(<ApplicationResult>, Integer, Hash)> create_an_application_with_http_info(account_id, opts)
315
+
316
+ ```ruby
317
+ begin
318
+ # Create an application
319
+ data, status_code, headers = api_instance.create_an_application_with_http_info(opts)
320
+ p status_code # => 2xx
321
+ p headers # => { ... }
322
+ p data # => <ApplicationResult>
323
+ rescue Freeclimb::ApiError => e
324
+ puts "Error when calling DefaultApi->create_an_application_with_http_info: #{e}"
289
325
  end
290
326
  ```
291
327
 
292
328
  ### Parameters
293
329
 
330
+ | Name | Type | Description | Notes |
331
+ | ---- | ---- | ----------- | ----- |
332
+
333
+ | **application_request** | [**ApplicationRequest**](ApplicationRequest.md) | Application Details | [optional] |
294
334
 
295
- Name | Type | Description | Notes
296
- ------------- | ------------- | ------------- | -------------
297
- **application_request** | [**ApplicationRequest**](ApplicationRequest.md)| Application Details | [optional]
298
335
 
299
336
  ### Return type
300
337
 
@@ -312,39 +349,61 @@ Name | Type | Description | Notes
312
349
 
313
350
  ## delete_a_recording
314
351
 
315
- > delete_a_recording(recording_id)
352
+ > delete_a_recording(account_id, recording_id)
316
353
 
317
354
  Delete a Recording
318
355
 
319
- ### Example
356
+ ### Examples
320
357
 
321
358
  ```ruby
322
- # load the gem
359
+ require 'time'
323
360
  require 'freeclimb'
324
361
  # setup authorization
325
362
  Freeclimb.configure do |config|
326
363
  # Configure HTTP basic authorization: fc
327
- config.username = 'ACCOUNT ID'
328
- config.password = 'API KEY'
364
+ config.username = 'ACCOUNT_ID'
365
+ config.password = 'API_KEY'
329
366
  end
330
367
 
331
368
  api_instance = Freeclimb::DefaultApi.new
369
+
332
370
  recording_id = 'recording_id_example' # String | String that uniquely identifies this recording resource.
333
371
 
372
+
334
373
  begin
335
- #Delete a Recording
374
+
375
+ # Delete a Recording
336
376
  api_instance.delete_a_recording(recording_id)
337
377
  rescue Freeclimb::ApiError => e
338
- puts "Exception when calling DefaultApi->delete_a_recording: #{e}"
378
+ puts "Error when calling DefaultApi->delete_a_recording: #{e}"
379
+ end
380
+ ```
381
+
382
+ #### Using the delete_a_recording_with_http_info variant
383
+
384
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
385
+
386
+ > <Array(nil, Integer, Hash)> delete_a_recording_with_http_info(account_id, recording_id)
387
+
388
+ ```ruby
389
+ begin
390
+ # Delete a Recording
391
+ data, status_code, headers = api_instance.delete_a_recording_with_http_info(recording_id)
392
+ p status_code # => 2xx
393
+ p headers # => { ... }
394
+ p data # => nil
395
+ rescue Freeclimb::ApiError => e
396
+ puts "Error when calling DefaultApi->delete_a_recording_with_http_info: #{e}"
339
397
  end
340
398
  ```
341
399
 
342
400
  ### Parameters
343
401
 
402
+ | Name | Type | Description | Notes |
403
+ | ---- | ---- | ----------- | ----- |
404
+
405
+ | **recording_id** | **String** | String that uniquely identifies this recording resource. | |
344
406
 
345
- Name | Type | Description | Notes
346
- ------------- | ------------- | ------------- | -------------
347
- **recording_id** | **String**| String that uniquely identifies this recording resource. |
348
407
 
349
408
  ### Return type
350
409
 
@@ -362,39 +421,61 @@ nil (empty response body)
362
421
 
363
422
  ## delete_an_application
364
423
 
365
- > delete_an_application(application_id)
424
+ > delete_an_application(account_id, application_id)
366
425
 
367
426
  Delete an application
368
427
 
369
- ### Example
428
+ ### Examples
370
429
 
371
430
  ```ruby
372
- # load the gem
431
+ require 'time'
373
432
  require 'freeclimb'
374
433
  # setup authorization
375
434
  Freeclimb.configure do |config|
376
435
  # Configure HTTP basic authorization: fc
377
- config.username = 'ACCOUNT ID'
378
- config.password = 'API KEY'
436
+ config.username = 'ACCOUNT_ID'
437
+ config.password = 'API_KEY'
379
438
  end
380
439
 
381
440
  api_instance = Freeclimb::DefaultApi.new
441
+
382
442
  application_id = 'application_id_example' # String | String that uniquely identifies this application resource.
383
443
 
444
+
384
445
  begin
385
- #Delete an application
446
+
447
+ # Delete an application
386
448
  api_instance.delete_an_application(application_id)
387
449
  rescue Freeclimb::ApiError => e
388
- puts "Exception when calling DefaultApi->delete_an_application: #{e}"
450
+ puts "Error when calling DefaultApi->delete_an_application: #{e}"
451
+ end
452
+ ```
453
+
454
+ #### Using the delete_an_application_with_http_info variant
455
+
456
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
457
+
458
+ > <Array(nil, Integer, Hash)> delete_an_application_with_http_info(account_id, application_id)
459
+
460
+ ```ruby
461
+ begin
462
+ # Delete an application
463
+ data, status_code, headers = api_instance.delete_an_application_with_http_info(application_id)
464
+ p status_code # => 2xx
465
+ p headers # => { ... }
466
+ p data # => nil
467
+ rescue Freeclimb::ApiError => e
468
+ puts "Error when calling DefaultApi->delete_an_application_with_http_info: #{e}"
389
469
  end
390
470
  ```
391
471
 
392
472
  ### Parameters
393
473
 
474
+ | Name | Type | Description | Notes |
475
+ | ---- | ---- | ----------- | ----- |
476
+
477
+ | **application_id** | **String** | String that uniquely identifies this application resource. | |
394
478
 
395
- Name | Type | Description | Notes
396
- ------------- | ------------- | ------------- | -------------
397
- **application_id** | **String**| String that uniquely identifies this application resource. |
398
479
 
399
480
  ### Return type
400
481
 
@@ -412,39 +493,61 @@ nil (empty response body)
412
493
 
413
494
  ## delete_an_incoming_number
414
495
 
415
- > delete_an_incoming_number(phone_number_id)
496
+ > delete_an_incoming_number(account_id, phone_number_id)
416
497
 
417
498
  Delete an Incoming Number
418
499
 
419
- ### Example
500
+ ### Examples
420
501
 
421
502
  ```ruby
422
- # load the gem
503
+ require 'time'
423
504
  require 'freeclimb'
424
505
  # setup authorization
425
506
  Freeclimb.configure do |config|
426
507
  # Configure HTTP basic authorization: fc
427
- config.username = 'ACCOUNT ID'
428
- config.password = 'API KEY'
508
+ config.username = 'ACCOUNT_ID'
509
+ config.password = 'API_KEY'
429
510
  end
430
511
 
431
512
  api_instance = Freeclimb::DefaultApi.new
513
+
432
514
  phone_number_id = 'phone_number_id_example' # String | String that uniquely identifies this phone number resource.
433
515
 
516
+
434
517
  begin
435
- #Delete an Incoming Number
518
+
519
+ # Delete an Incoming Number
436
520
  api_instance.delete_an_incoming_number(phone_number_id)
437
521
  rescue Freeclimb::ApiError => e
438
- puts "Exception when calling DefaultApi->delete_an_incoming_number: #{e}"
522
+ puts "Error when calling DefaultApi->delete_an_incoming_number: #{e}"
523
+ end
524
+ ```
525
+
526
+ #### Using the delete_an_incoming_number_with_http_info variant
527
+
528
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
529
+
530
+ > <Array(nil, Integer, Hash)> delete_an_incoming_number_with_http_info(account_id, phone_number_id)
531
+
532
+ ```ruby
533
+ begin
534
+ # Delete an Incoming Number
535
+ data, status_code, headers = api_instance.delete_an_incoming_number_with_http_info(phone_number_id)
536
+ p status_code # => 2xx
537
+ p headers # => { ... }
538
+ p data # => nil
539
+ rescue Freeclimb::ApiError => e
540
+ puts "Error when calling DefaultApi->delete_an_incoming_number_with_http_info: #{e}"
439
541
  end
440
542
  ```
441
543
 
442
544
  ### Parameters
443
545
 
546
+ | Name | Type | Description | Notes |
547
+ | ---- | ---- | ----------- | ----- |
548
+
549
+ | **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | |
444
550
 
445
- Name | Type | Description | Notes
446
- ------------- | ------------- | ------------- | -------------
447
- **phone_number_id** | **String**| String that uniquely identifies this phone number resource. |
448
551
 
449
552
  ### Return type
450
553
 
@@ -462,42 +565,66 @@ nil (empty response body)
462
565
 
463
566
  ## dequeue_a_member
464
567
 
465
- > QueueMember dequeue_a_member(queue_id, call_id)
568
+ > <QueueMember> dequeue_a_member(account_id, queue_id, call_id)
466
569
 
467
570
  Dequeue a Member
468
571
 
469
- ### Example
572
+ ### Examples
470
573
 
471
574
  ```ruby
472
- # load the gem
575
+ require 'time'
473
576
  require 'freeclimb'
474
577
  # setup authorization
475
578
  Freeclimb.configure do |config|
476
579
  # Configure HTTP basic authorization: fc
477
- config.username = 'ACCOUNT ID'
478
- config.password = 'API KEY'
580
+ config.username = 'ACCOUNT_ID'
581
+ config.password = 'API_KEY'
479
582
  end
480
583
 
481
584
  api_instance = Freeclimb::DefaultApi.new
585
+
482
586
  queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
587
+
483
588
  call_id = 'call_id_example' # String | ID if the Call that the Member belongs to
484
589
 
590
+
485
591
  begin
486
- #Dequeue a Member
592
+
593
+ # Dequeue a Member
487
594
  result = api_instance.dequeue_a_member(queue_id, call_id)
488
595
  p result
489
596
  rescue Freeclimb::ApiError => e
490
- puts "Exception when calling DefaultApi->dequeue_a_member: #{e}"
597
+ puts "Error when calling DefaultApi->dequeue_a_member: #{e}"
598
+ end
599
+ ```
600
+
601
+ #### Using the dequeue_a_member_with_http_info variant
602
+
603
+ This returns an Array which contains the response data, status code and headers.
604
+
605
+ > <Array(<QueueMember>, Integer, Hash)> dequeue_a_member_with_http_info(account_id, queue_id, call_id)
606
+
607
+ ```ruby
608
+ begin
609
+ # Dequeue a Member
610
+ data, status_code, headers = api_instance.dequeue_a_member_with_http_info(queue_id, call_id)
611
+ p status_code # => 2xx
612
+ p headers # => { ... }
613
+ p data # => <QueueMember>
614
+ rescue Freeclimb::ApiError => e
615
+ puts "Error when calling DefaultApi->dequeue_a_member_with_http_info: #{e}"
491
616
  end
492
617
  ```
493
618
 
494
619
  ### Parameters
495
620
 
621
+ | Name | Type | Description | Notes |
622
+ | ---- | ---- | ----------- | ----- |
623
+
624
+ | **queue_id** | **String** | String that uniquely identifies the Queue that the Member belongs to. | |
625
+
626
+ | **call_id** | **String** | ID if the Call that the Member belongs to | |
496
627
 
497
- Name | Type | Description | Notes
498
- ------------- | ------------- | ------------- | -------------
499
- **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. |
500
- **call_id** | **String**| ID if the Call that the Member belongs to |
501
628
 
502
629
  ### Return type
503
630
 
@@ -515,40 +642,62 @@ Name | Type | Description | Notes
515
642
 
516
643
  ## dequeue_head_member
517
644
 
518
- > QueueMember dequeue_head_member(queue_id)
645
+ > <QueueMember> dequeue_head_member(account_id, queue_id)
519
646
 
520
647
  Dequeue Head Member
521
648
 
522
- ### Example
649
+ ### Examples
523
650
 
524
651
  ```ruby
525
- # load the gem
652
+ require 'time'
526
653
  require 'freeclimb'
527
654
  # setup authorization
528
655
  Freeclimb.configure do |config|
529
656
  # Configure HTTP basic authorization: fc
530
- config.username = 'ACCOUNT ID'
531
- config.password = 'API KEY'
657
+ config.username = 'ACCOUNT_ID'
658
+ config.password = 'API_KEY'
532
659
  end
533
660
 
534
661
  api_instance = Freeclimb::DefaultApi.new
662
+
535
663
  queue_id = 'queue_id_example' # String | String that uniquely identifies this queue resource.
536
664
 
665
+
537
666
  begin
538
- #Dequeue Head Member
667
+
668
+ # Dequeue Head Member
539
669
  result = api_instance.dequeue_head_member(queue_id)
540
670
  p result
541
671
  rescue Freeclimb::ApiError => e
542
- puts "Exception when calling DefaultApi->dequeue_head_member: #{e}"
672
+ puts "Error when calling DefaultApi->dequeue_head_member: #{e}"
673
+ end
674
+ ```
675
+
676
+ #### Using the dequeue_head_member_with_http_info variant
677
+
678
+ This returns an Array which contains the response data, status code and headers.
679
+
680
+ > <Array(<QueueMember>, Integer, Hash)> dequeue_head_member_with_http_info(account_id, queue_id)
681
+
682
+ ```ruby
683
+ begin
684
+ # Dequeue Head Member
685
+ data, status_code, headers = api_instance.dequeue_head_member_with_http_info(queue_id)
686
+ p status_code # => 2xx
687
+ p headers # => { ... }
688
+ p data # => <QueueMember>
689
+ rescue Freeclimb::ApiError => e
690
+ puts "Error when calling DefaultApi->dequeue_head_member_with_http_info: #{e}"
543
691
  end
544
692
  ```
545
693
 
546
694
  ### Parameters
547
695
 
696
+ | Name | Type | Description | Notes |
697
+ | ---- | ---- | ----------- | ----- |
698
+
699
+ | **queue_id** | **String** | String that uniquely identifies this queue resource. | |
548
700
 
549
- Name | Type | Description | Notes
550
- ------------- | ------------- | ------------- | -------------
551
- **queue_id** | **String**| String that uniquely identifies this queue resource. |
552
701
 
553
702
  ### Return type
554
703
 
@@ -566,40 +715,62 @@ Name | Type | Description | Notes
566
715
 
567
716
  ## download_a_recording_file
568
717
 
569
- > File download_a_recording_file(recording_id)
718
+ > File download_a_recording_file(account_id, recording_id)
570
719
 
571
720
  Download a Recording File
572
721
 
573
- ### Example
722
+ ### Examples
574
723
 
575
724
  ```ruby
576
- # load the gem
725
+ require 'time'
577
726
  require 'freeclimb'
578
727
  # setup authorization
579
728
  Freeclimb.configure do |config|
580
729
  # Configure HTTP basic authorization: fc
581
- config.username = 'ACCOUNT ID'
582
- config.password = 'API KEY'
730
+ config.username = 'ACCOUNT_ID'
731
+ config.password = 'API_KEY'
583
732
  end
584
733
 
585
734
  api_instance = Freeclimb::DefaultApi.new
735
+
586
736
  recording_id = 'recording_id_example' # String | String that uniquely identifies this recording resource.
587
737
 
738
+
588
739
  begin
589
- #Download a Recording File
740
+
741
+ # Download a Recording File
590
742
  result = api_instance.download_a_recording_file(recording_id)
591
743
  p result
592
744
  rescue Freeclimb::ApiError => e
593
- puts "Exception when calling DefaultApi->download_a_recording_file: #{e}"
745
+ puts "Error when calling DefaultApi->download_a_recording_file: #{e}"
746
+ end
747
+ ```
748
+
749
+ #### Using the download_a_recording_file_with_http_info variant
750
+
751
+ This returns an Array which contains the response data, status code and headers.
752
+
753
+ > <Array(File, Integer, Hash)> download_a_recording_file_with_http_info(account_id, recording_id)
754
+
755
+ ```ruby
756
+ begin
757
+ # Download a Recording File
758
+ data, status_code, headers = api_instance.download_a_recording_file_with_http_info(recording_id)
759
+ p status_code # => 2xx
760
+ p headers # => { ... }
761
+ p data # => File
762
+ rescue Freeclimb::ApiError => e
763
+ puts "Error when calling DefaultApi->download_a_recording_file_with_http_info: #{e}"
594
764
  end
595
765
  ```
596
766
 
597
767
  ### Parameters
598
768
 
769
+ | Name | Type | Description | Notes |
770
+ | ---- | ---- | ----------- | ----- |
771
+
772
+ | **recording_id** | **String** | String that uniquely identifies this recording resource. | |
599
773
 
600
- Name | Type | Description | Notes
601
- ------------- | ------------- | ------------- | -------------
602
- **recording_id** | **String**| String that uniquely identifies this recording resource. |
603
774
 
604
775
  ### Return type
605
776
 
@@ -617,40 +788,62 @@ Name | Type | Description | Notes
617
788
 
618
789
  ## filter_logs
619
790
 
620
- > LogList filter_logs(filter_logs_request)
791
+ > <LogList> filter_logs(account_id, filter_logs_request)
621
792
 
622
793
  Filter Logs
623
794
 
624
- ### Example
795
+ ### Examples
625
796
 
626
797
  ```ruby
627
- # load the gem
798
+ require 'time'
628
799
  require 'freeclimb'
629
800
  # setup authorization
630
801
  Freeclimb.configure do |config|
631
802
  # Configure HTTP basic authorization: fc
632
- config.username = 'ACCOUNT ID'
633
- config.password = 'API KEY'
803
+ config.username = 'ACCOUNT_ID'
804
+ config.password = 'API_KEY'
634
805
  end
635
806
 
636
807
  api_instance = Freeclimb::DefaultApi.new
637
- filter_logs_request = Freeclimb::FilterLogsRequest.new # FilterLogsRequest | Filter logs request paramters
808
+
809
+ filter_logs_request = Freeclimb::FilterLogsRequest.new({pql: 'pql_example'}) # FilterLogsRequest | Filter logs request paramters
810
+
638
811
 
639
812
  begin
640
- #Filter Logs
813
+
814
+ # Filter Logs
641
815
  result = api_instance.filter_logs(filter_logs_request)
642
816
  p result
643
817
  rescue Freeclimb::ApiError => e
644
- puts "Exception when calling DefaultApi->filter_logs: #{e}"
818
+ puts "Error when calling DefaultApi->filter_logs: #{e}"
819
+ end
820
+ ```
821
+
822
+ #### Using the filter_logs_with_http_info variant
823
+
824
+ This returns an Array which contains the response data, status code and headers.
825
+
826
+ > <Array(<LogList>, Integer, Hash)> filter_logs_with_http_info(account_id, filter_logs_request)
827
+
828
+ ```ruby
829
+ begin
830
+ # Filter Logs
831
+ data, status_code, headers = api_instance.filter_logs_with_http_info(filter_logs_request)
832
+ p status_code # => 2xx
833
+ p headers # => { ... }
834
+ p data # => <LogList>
835
+ rescue Freeclimb::ApiError => e
836
+ puts "Error when calling DefaultApi->filter_logs_with_http_info: #{e}"
645
837
  end
646
838
  ```
647
839
 
648
840
  ### Parameters
649
841
 
842
+ | Name | Type | Description | Notes |
843
+ | ---- | ---- | ----------- | ----- |
844
+
845
+ | **filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md) | Filter logs request paramters | |
650
846
 
651
- Name | Type | Description | Notes
652
- ------------- | ------------- | ------------- | -------------
653
- **filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md)| Filter logs request paramters |
654
847
 
655
848
  ### Return type
656
849
 
@@ -668,40 +861,62 @@ Name | Type | Description | Notes
668
861
 
669
862
  ## get_a_call
670
863
 
671
- > CallResult get_a_call(call_id)
864
+ > <CallResult> get_a_call(account_id, call_id)
672
865
 
673
866
  Get a Call
674
867
 
675
- ### Example
868
+ ### Examples
676
869
 
677
870
  ```ruby
678
- # load the gem
871
+ require 'time'
679
872
  require 'freeclimb'
680
873
  # setup authorization
681
874
  Freeclimb.configure do |config|
682
875
  # Configure HTTP basic authorization: fc
683
- config.username = 'ACCOUNT ID'
684
- config.password = 'API KEY'
876
+ config.username = 'ACCOUNT_ID'
877
+ config.password = 'API_KEY'
685
878
  end
686
879
 
687
880
  api_instance = Freeclimb::DefaultApi.new
881
+
688
882
  call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
689
883
 
884
+
690
885
  begin
691
- #Get a Call
886
+
887
+ # Get a Call
692
888
  result = api_instance.get_a_call(call_id)
693
889
  p result
694
890
  rescue Freeclimb::ApiError => e
695
- puts "Exception when calling DefaultApi->get_a_call: #{e}"
891
+ puts "Error when calling DefaultApi->get_a_call: #{e}"
892
+ end
893
+ ```
894
+
895
+ #### Using the get_a_call_with_http_info variant
896
+
897
+ This returns an Array which contains the response data, status code and headers.
898
+
899
+ > <Array(<CallResult>, Integer, Hash)> get_a_call_with_http_info(account_id, call_id)
900
+
901
+ ```ruby
902
+ begin
903
+ # Get a Call
904
+ data, status_code, headers = api_instance.get_a_call_with_http_info(call_id)
905
+ p status_code # => 2xx
906
+ p headers # => { ... }
907
+ p data # => <CallResult>
908
+ rescue Freeclimb::ApiError => e
909
+ puts "Error when calling DefaultApi->get_a_call_with_http_info: #{e}"
696
910
  end
697
911
  ```
698
912
 
699
913
  ### Parameters
700
914
 
915
+ | Name | Type | Description | Notes |
916
+ | ---- | ---- | ----------- | ----- |
917
+
918
+ | **call_id** | **String** | String that uniquely identifies this call resource. | |
701
919
 
702
- Name | Type | Description | Notes
703
- ------------- | ------------- | ------------- | -------------
704
- **call_id** | **String**| String that uniquely identifies this call resource. |
705
920
 
706
921
  ### Return type
707
922
 
@@ -719,40 +934,62 @@ Name | Type | Description | Notes
719
934
 
720
935
  ## get_a_conference
721
936
 
722
- > ConferenceResult get_a_conference(conference_id)
937
+ > <ConferenceResult> get_a_conference(account_id, conference_id)
723
938
 
724
939
  Get a Conference
725
940
 
726
- ### Example
941
+ ### Examples
727
942
 
728
943
  ```ruby
729
- # load the gem
944
+ require 'time'
730
945
  require 'freeclimb'
731
946
  # setup authorization
732
947
  Freeclimb.configure do |config|
733
948
  # Configure HTTP basic authorization: fc
734
- config.username = 'ACCOUNT ID'
735
- config.password = 'API KEY'
949
+ config.username = 'ACCOUNT_ID'
950
+ config.password = 'API_KEY'
736
951
  end
737
952
 
738
953
  api_instance = Freeclimb::DefaultApi.new
954
+
739
955
  conference_id = 'conference_id_example' # String | A string that uniquely identifies this conference resource.
740
956
 
957
+
741
958
  begin
742
- #Get a Conference
959
+
960
+ # Get a Conference
743
961
  result = api_instance.get_a_conference(conference_id)
744
962
  p result
745
963
  rescue Freeclimb::ApiError => e
746
- puts "Exception when calling DefaultApi->get_a_conference: #{e}"
964
+ puts "Error when calling DefaultApi->get_a_conference: #{e}"
965
+ end
966
+ ```
967
+
968
+ #### Using the get_a_conference_with_http_info variant
969
+
970
+ This returns an Array which contains the response data, status code and headers.
971
+
972
+ > <Array(<ConferenceResult>, Integer, Hash)> get_a_conference_with_http_info(account_id, conference_id)
973
+
974
+ ```ruby
975
+ begin
976
+ # Get a Conference
977
+ data, status_code, headers = api_instance.get_a_conference_with_http_info(conference_id)
978
+ p status_code # => 2xx
979
+ p headers # => { ... }
980
+ p data # => <ConferenceResult>
981
+ rescue Freeclimb::ApiError => e
982
+ puts "Error when calling DefaultApi->get_a_conference_with_http_info: #{e}"
747
983
  end
748
984
  ```
749
985
 
750
986
  ### Parameters
751
987
 
988
+ | Name | Type | Description | Notes |
989
+ | ---- | ---- | ----------- | ----- |
990
+
991
+ | **conference_id** | **String** | A string that uniquely identifies this conference resource. | |
752
992
 
753
- Name | Type | Description | Notes
754
- ------------- | ------------- | ------------- | -------------
755
- **conference_id** | **String**| A string that uniquely identifies this conference resource. |
756
993
 
757
994
  ### Return type
758
995
 
@@ -770,42 +1007,66 @@ Name | Type | Description | Notes
770
1007
 
771
1008
  ## get_a_member
772
1009
 
773
- > QueueMember get_a_member(queue_id, call_id)
1010
+ > <QueueMember> get_a_member(account_id, queue_id, call_id)
774
1011
 
775
1012
  Get a Member
776
1013
 
777
- ### Example
1014
+ ### Examples
778
1015
 
779
1016
  ```ruby
780
- # load the gem
1017
+ require 'time'
781
1018
  require 'freeclimb'
782
1019
  # setup authorization
783
1020
  Freeclimb.configure do |config|
784
1021
  # Configure HTTP basic authorization: fc
785
- config.username = 'ACCOUNT ID'
786
- config.password = 'API KEY'
1022
+ config.username = 'ACCOUNT_ID'
1023
+ config.password = 'API_KEY'
787
1024
  end
788
1025
 
789
1026
  api_instance = Freeclimb::DefaultApi.new
1027
+
790
1028
  queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
1029
+
791
1030
  call_id = 'call_id_example' # String | ID of the Call that the Member belongs to
792
1031
 
1032
+
793
1033
  begin
794
- #Get a Member
1034
+
1035
+ # Get a Member
795
1036
  result = api_instance.get_a_member(queue_id, call_id)
796
1037
  p result
797
1038
  rescue Freeclimb::ApiError => e
798
- puts "Exception when calling DefaultApi->get_a_member: #{e}"
1039
+ puts "Error when calling DefaultApi->get_a_member: #{e}"
1040
+ end
1041
+ ```
1042
+
1043
+ #### Using the get_a_member_with_http_info variant
1044
+
1045
+ This returns an Array which contains the response data, status code and headers.
1046
+
1047
+ > <Array(<QueueMember>, Integer, Hash)> get_a_member_with_http_info(account_id, queue_id, call_id)
1048
+
1049
+ ```ruby
1050
+ begin
1051
+ # Get a Member
1052
+ data, status_code, headers = api_instance.get_a_member_with_http_info(queue_id, call_id)
1053
+ p status_code # => 2xx
1054
+ p headers # => { ... }
1055
+ p data # => <QueueMember>
1056
+ rescue Freeclimb::ApiError => e
1057
+ puts "Error when calling DefaultApi->get_a_member_with_http_info: #{e}"
799
1058
  end
800
1059
  ```
801
1060
 
802
1061
  ### Parameters
803
1062
 
1063
+ | Name | Type | Description | Notes |
1064
+ | ---- | ---- | ----------- | ----- |
1065
+
1066
+ | **queue_id** | **String** | String that uniquely identifies the Queue that the Member belongs to. | |
1067
+
1068
+ | **call_id** | **String** | ID of the Call that the Member belongs to | |
804
1069
 
805
- Name | Type | Description | Notes
806
- ------------- | ------------- | ------------- | -------------
807
- **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. |
808
- **call_id** | **String**| ID of the Call that the Member belongs to |
809
1070
 
810
1071
  ### Return type
811
1072
 
@@ -823,42 +1084,66 @@ Name | Type | Description | Notes
823
1084
 
824
1085
  ## get_a_participant
825
1086
 
826
- > ConferenceParticipantResult get_a_participant(conference_id, call_id)
1087
+ > <ConferenceParticipantResult> get_a_participant(account_id, conference_id, call_id)
827
1088
 
828
1089
  Get a Participant
829
1090
 
830
- ### Example
1091
+ ### Examples
831
1092
 
832
1093
  ```ruby
833
- # load the gem
1094
+ require 'time'
834
1095
  require 'freeclimb'
835
1096
  # setup authorization
836
1097
  Freeclimb.configure do |config|
837
1098
  # Configure HTTP basic authorization: fc
838
- config.username = 'ACCOUNT ID'
839
- config.password = 'API KEY'
1099
+ config.username = 'ACCOUNT_ID'
1100
+ config.password = 'API_KEY'
840
1101
  end
841
1102
 
842
1103
  api_instance = Freeclimb::DefaultApi.new
1104
+
843
1105
  conference_id = 'conference_id_example' # String | ID of the conference this participant is in.
1106
+
844
1107
  call_id = 'call_id_example' # String | ID of the Call associated with this participant.
845
1108
 
1109
+
846
1110
  begin
847
- #Get a Participant
1111
+
1112
+ # Get a Participant
848
1113
  result = api_instance.get_a_participant(conference_id, call_id)
849
1114
  p result
850
1115
  rescue Freeclimb::ApiError => e
851
- puts "Exception when calling DefaultApi->get_a_participant: #{e}"
1116
+ puts "Error when calling DefaultApi->get_a_participant: #{e}"
1117
+ end
1118
+ ```
1119
+
1120
+ #### Using the get_a_participant_with_http_info variant
1121
+
1122
+ This returns an Array which contains the response data, status code and headers.
1123
+
1124
+ > <Array(<ConferenceParticipantResult>, Integer, Hash)> get_a_participant_with_http_info(account_id, conference_id, call_id)
1125
+
1126
+ ```ruby
1127
+ begin
1128
+ # Get a Participant
1129
+ data, status_code, headers = api_instance.get_a_participant_with_http_info(conference_id, call_id)
1130
+ p status_code # => 2xx
1131
+ p headers # => { ... }
1132
+ p data # => <ConferenceParticipantResult>
1133
+ rescue Freeclimb::ApiError => e
1134
+ puts "Error when calling DefaultApi->get_a_participant_with_http_info: #{e}"
852
1135
  end
853
1136
  ```
854
1137
 
855
1138
  ### Parameters
856
1139
 
1140
+ | Name | Type | Description | Notes |
1141
+ | ---- | ---- | ----------- | ----- |
1142
+
1143
+ | **conference_id** | **String** | ID of the conference this participant is in. | |
1144
+
1145
+ | **call_id** | **String** | ID of the Call associated with this participant. | |
857
1146
 
858
- Name | Type | Description | Notes
859
- ------------- | ------------- | ------------- | -------------
860
- **conference_id** | **String**| ID of the conference this participant is in. |
861
- **call_id** | **String**| ID of the Call associated with this participant. |
862
1147
 
863
1148
  ### Return type
864
1149
 
@@ -876,40 +1161,62 @@ Name | Type | Description | Notes
876
1161
 
877
1162
  ## get_a_queue
878
1163
 
879
- > QueueResult get_a_queue(queue_id)
1164
+ > <QueueResult> get_a_queue(account_id, queue_id)
880
1165
 
881
1166
  Get a Queue
882
1167
 
883
- ### Example
1168
+ ### Examples
884
1169
 
885
1170
  ```ruby
886
- # load the gem
1171
+ require 'time'
887
1172
  require 'freeclimb'
888
1173
  # setup authorization
889
1174
  Freeclimb.configure do |config|
890
1175
  # Configure HTTP basic authorization: fc
891
- config.username = 'ACCOUNT ID'
892
- config.password = 'API KEY'
1176
+ config.username = 'ACCOUNT_ID'
1177
+ config.password = 'API_KEY'
893
1178
  end
894
1179
 
895
1180
  api_instance = Freeclimb::DefaultApi.new
1181
+
896
1182
  queue_id = 'queue_id_example' # String | A string that uniquely identifies this queue resource.
897
1183
 
1184
+
898
1185
  begin
899
- #Get a Queue
1186
+
1187
+ # Get a Queue
900
1188
  result = api_instance.get_a_queue(queue_id)
901
1189
  p result
902
1190
  rescue Freeclimb::ApiError => e
903
- puts "Exception when calling DefaultApi->get_a_queue: #{e}"
1191
+ puts "Error when calling DefaultApi->get_a_queue: #{e}"
1192
+ end
1193
+ ```
1194
+
1195
+ #### Using the get_a_queue_with_http_info variant
1196
+
1197
+ This returns an Array which contains the response data, status code and headers.
1198
+
1199
+ > <Array(<QueueResult>, Integer, Hash)> get_a_queue_with_http_info(account_id, queue_id)
1200
+
1201
+ ```ruby
1202
+ begin
1203
+ # Get a Queue
1204
+ data, status_code, headers = api_instance.get_a_queue_with_http_info(queue_id)
1205
+ p status_code # => 2xx
1206
+ p headers # => { ... }
1207
+ p data # => <QueueResult>
1208
+ rescue Freeclimb::ApiError => e
1209
+ puts "Error when calling DefaultApi->get_a_queue_with_http_info: #{e}"
904
1210
  end
905
1211
  ```
906
1212
 
907
1213
  ### Parameters
908
1214
 
1215
+ | Name | Type | Description | Notes |
1216
+ | ---- | ---- | ----------- | ----- |
1217
+
1218
+ | **queue_id** | **String** | A string that uniquely identifies this queue resource. | |
909
1219
 
910
- Name | Type | Description | Notes
911
- ------------- | ------------- | ------------- | -------------
912
- **queue_id** | **String**| A string that uniquely identifies this queue resource. |
913
1220
 
914
1221
  ### Return type
915
1222
 
@@ -927,40 +1234,62 @@ Name | Type | Description | Notes
927
1234
 
928
1235
  ## get_a_recording
929
1236
 
930
- > RecordingResult get_a_recording(recording_id)
1237
+ > <RecordingResult> get_a_recording(account_id, recording_id)
931
1238
 
932
1239
  Get a Recording
933
1240
 
934
- ### Example
1241
+ ### Examples
935
1242
 
936
1243
  ```ruby
937
- # load the gem
1244
+ require 'time'
938
1245
  require 'freeclimb'
939
1246
  # setup authorization
940
1247
  Freeclimb.configure do |config|
941
1248
  # Configure HTTP basic authorization: fc
942
- config.username = 'ACCOUNT ID'
943
- config.password = 'API KEY'
1249
+ config.username = 'ACCOUNT_ID'
1250
+ config.password = 'API_KEY'
944
1251
  end
945
1252
 
946
1253
  api_instance = Freeclimb::DefaultApi.new
1254
+
947
1255
  recording_id = 'recording_id_example' # String | String that uniquely identifies this recording resource.
948
1256
 
1257
+
949
1258
  begin
950
- #Get a Recording
1259
+
1260
+ # Get a Recording
951
1261
  result = api_instance.get_a_recording(recording_id)
952
1262
  p result
953
1263
  rescue Freeclimb::ApiError => e
954
- puts "Exception when calling DefaultApi->get_a_recording: #{e}"
1264
+ puts "Error when calling DefaultApi->get_a_recording: #{e}"
1265
+ end
1266
+ ```
1267
+
1268
+ #### Using the get_a_recording_with_http_info variant
1269
+
1270
+ This returns an Array which contains the response data, status code and headers.
1271
+
1272
+ > <Array(<RecordingResult>, Integer, Hash)> get_a_recording_with_http_info(account_id, recording_id)
1273
+
1274
+ ```ruby
1275
+ begin
1276
+ # Get a Recording
1277
+ data, status_code, headers = api_instance.get_a_recording_with_http_info(recording_id)
1278
+ p status_code # => 2xx
1279
+ p headers # => { ... }
1280
+ p data # => <RecordingResult>
1281
+ rescue Freeclimb::ApiError => e
1282
+ puts "Error when calling DefaultApi->get_a_recording_with_http_info: #{e}"
955
1283
  end
956
1284
  ```
957
1285
 
958
1286
  ### Parameters
959
1287
 
1288
+ | Name | Type | Description | Notes |
1289
+ | ---- | ---- | ----------- | ----- |
1290
+
1291
+ | **recording_id** | **String** | String that uniquely identifies this recording resource. | |
960
1292
 
961
- Name | Type | Description | Notes
962
- ------------- | ------------- | ------------- | -------------
963
- **recording_id** | **String**| String that uniquely identifies this recording resource. |
964
1293
 
965
1294
  ### Return type
966
1295
 
@@ -976,42 +1305,133 @@ Name | Type | Description | Notes
976
1305
  - **Accept**: application/json
977
1306
 
978
1307
 
1308
+ ## get_an_account
1309
+
1310
+ > <AccountResult> get_an_account(account_id)
1311
+
1312
+ Get an Account
1313
+
1314
+ ### Examples
1315
+
1316
+ ```ruby
1317
+ require 'time'
1318
+ require 'freeclimb'
1319
+ # setup authorization
1320
+ Freeclimb.configure do |config|
1321
+ # Configure HTTP basic authorization: fc
1322
+ config.username = 'ACCOUNT_ID'
1323
+ config.password = 'API_KEY'
1324
+ end
1325
+
1326
+ api_instance = Freeclimb::DefaultApi.new
1327
+
1328
+
1329
+ begin
1330
+
1331
+ # Get an Account
1332
+ result = api_instance.get_an_account()
1333
+ p result
1334
+ rescue Freeclimb::ApiError => e
1335
+ puts "Error when calling DefaultApi->get_an_account: #{e}"
1336
+ end
1337
+ ```
1338
+
1339
+ #### Using the get_an_account_with_http_info variant
1340
+
1341
+ This returns an Array which contains the response data, status code and headers.
1342
+
1343
+ > <Array(<AccountResult>, Integer, Hash)> get_an_account_with_http_info(account_id)
1344
+
1345
+ ```ruby
1346
+ begin
1347
+ # Get an Account
1348
+ data, status_code, headers = api_instance.get_an_account_with_http_info()
1349
+ p status_code # => 2xx
1350
+ p headers # => { ... }
1351
+ p data # => <AccountResult>
1352
+ rescue Freeclimb::ApiError => e
1353
+ puts "Error when calling DefaultApi->get_an_account_with_http_info: #{e}"
1354
+ end
1355
+ ```
1356
+
1357
+ ### Parameters
1358
+
1359
+ | Name | Type | Description | Notes |
1360
+ | ---- | ---- | ----------- | ----- |
1361
+
1362
+
1363
+ ### Return type
1364
+
1365
+ [**AccountResult**](AccountResult.md)
1366
+
1367
+ ### Authorization
1368
+
1369
+ [fc](../README.md#fc)
1370
+
1371
+ ### HTTP request headers
1372
+
1373
+ - **Content-Type**: Not defined
1374
+ - **Accept**: application/json
1375
+
1376
+
979
1377
  ## get_an_application
980
1378
 
981
- > ApplicationResult get_an_application(application_id)
1379
+ > <ApplicationResult> get_an_application(account_id, application_id)
982
1380
 
983
1381
  Get an Application
984
1382
 
985
- ### Example
1383
+ ### Examples
986
1384
 
987
1385
  ```ruby
988
- # load the gem
1386
+ require 'time'
989
1387
  require 'freeclimb'
990
1388
  # setup authorization
991
1389
  Freeclimb.configure do |config|
992
1390
  # Configure HTTP basic authorization: fc
993
- config.username = 'ACCOUNT ID'
994
- config.password = 'API KEY'
1391
+ config.username = 'ACCOUNT_ID'
1392
+ config.password = 'API_KEY'
995
1393
  end
996
1394
 
997
1395
  api_instance = Freeclimb::DefaultApi.new
1396
+
998
1397
  application_id = 'application_id_example' # String | A string that uniquely identifies this application resource.
999
1398
 
1399
+
1000
1400
  begin
1001
- #Get an Application
1401
+
1402
+ # Get an Application
1002
1403
  result = api_instance.get_an_application(application_id)
1003
1404
  p result
1004
1405
  rescue Freeclimb::ApiError => e
1005
- puts "Exception when calling DefaultApi->get_an_application: #{e}"
1406
+ puts "Error when calling DefaultApi->get_an_application: #{e}"
1407
+ end
1408
+ ```
1409
+
1410
+ #### Using the get_an_application_with_http_info variant
1411
+
1412
+ This returns an Array which contains the response data, status code and headers.
1413
+
1414
+ > <Array(<ApplicationResult>, Integer, Hash)> get_an_application_with_http_info(account_id, application_id)
1415
+
1416
+ ```ruby
1417
+ begin
1418
+ # Get an Application
1419
+ data, status_code, headers = api_instance.get_an_application_with_http_info(application_id)
1420
+ p status_code # => 2xx
1421
+ p headers # => { ... }
1422
+ p data # => <ApplicationResult>
1423
+ rescue Freeclimb::ApiError => e
1424
+ puts "Error when calling DefaultApi->get_an_application_with_http_info: #{e}"
1006
1425
  end
1007
1426
  ```
1008
1427
 
1009
1428
  ### Parameters
1010
1429
 
1430
+ | Name | Type | Description | Notes |
1431
+ | ---- | ---- | ----------- | ----- |
1432
+
1433
+ | **application_id** | **String** | A string that uniquely identifies this application resource. | |
1011
1434
 
1012
- Name | Type | Description | Notes
1013
- ------------- | ------------- | ------------- | -------------
1014
- **application_id** | **String**| A string that uniquely identifies this application resource. |
1015
1435
 
1016
1436
  ### Return type
1017
1437
 
@@ -1029,54 +1449,62 @@ Name | Type | Description | Notes
1029
1449
 
1030
1450
  ## get_an_incoming_number
1031
1451
 
1032
- > IncomingNumberResult get_an_incoming_number(phone_number_id, opts)
1452
+ > <IncomingNumberResult> get_an_incoming_number(account_id, phone_number_id)
1033
1453
 
1034
1454
  Get an Incoming Number
1035
1455
 
1036
- ### Example
1456
+ ### Examples
1037
1457
 
1038
1458
  ```ruby
1039
- # load the gem
1459
+ require 'time'
1040
1460
  require 'freeclimb'
1041
1461
  # setup authorization
1042
1462
  Freeclimb.configure do |config|
1043
1463
  # Configure HTTP basic authorization: fc
1044
- config.username = 'ACCOUNT ID'
1045
- config.password = 'API KEY'
1464
+ config.username = 'ACCOUNT_ID'
1465
+ config.password = 'API_KEY'
1046
1466
  end
1047
1467
 
1048
1468
  api_instance = Freeclimb::DefaultApi.new
1469
+
1049
1470
  phone_number_id = 'phone_number_id_example' # String | String that uniquely identifies this phone number resource.
1050
- opts = {
1051
- region: 'region_example', # String | State or province of this phone number.
1052
- country: 'country_example', # String | Country of this phone number.
1053
- voice_enabled: true, # Boolean | Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
1054
- sms_enabled: true, # Boolean | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
1055
- application_id: 'application_id_example', # String | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.
1056
- has_application: false # Boolean | Indication of whether the phone number has an application linked to it.
1057
- }
1471
+
1058
1472
 
1059
1473
  begin
1060
- #Get an Incoming Number
1061
- result = api_instance.get_an_incoming_number(phone_number_id, opts)
1474
+
1475
+ # Get an Incoming Number
1476
+ result = api_instance.get_an_incoming_number(phone_number_id)
1062
1477
  p result
1063
1478
  rescue Freeclimb::ApiError => e
1064
- puts "Exception when calling DefaultApi->get_an_incoming_number: #{e}"
1479
+ puts "Error when calling DefaultApi->get_an_incoming_number: #{e}"
1480
+ end
1481
+ ```
1482
+
1483
+ #### Using the get_an_incoming_number_with_http_info variant
1484
+
1485
+ This returns an Array which contains the response data, status code and headers.
1486
+
1487
+ > <Array(<IncomingNumberResult>, Integer, Hash)> get_an_incoming_number_with_http_info(account_id, phone_number_id)
1488
+
1489
+ ```ruby
1490
+ begin
1491
+ # Get an Incoming Number
1492
+ data, status_code, headers = api_instance.get_an_incoming_number_with_http_info(phone_number_id)
1493
+ p status_code # => 2xx
1494
+ p headers # => { ... }
1495
+ p data # => <IncomingNumberResult>
1496
+ rescue Freeclimb::ApiError => e
1497
+ puts "Error when calling DefaultApi->get_an_incoming_number_with_http_info: #{e}"
1065
1498
  end
1066
1499
  ```
1067
1500
 
1068
1501
  ### Parameters
1069
1502
 
1503
+ | Name | Type | Description | Notes |
1504
+ | ---- | ---- | ----------- | ----- |
1505
+
1506
+ | **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | |
1070
1507
 
1071
- Name | Type | Description | Notes
1072
- ------------- | ------------- | ------------- | -------------
1073
- **phone_number_id** | **String**| String that uniquely identifies this phone number resource. |
1074
- **region** | **String**| State or province of this phone number. | [optional]
1075
- **country** | **String**| Country of this phone number. | [optional]
1076
- **voice_enabled** | **Boolean**| Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] [default to true]
1077
- **sms_enabled** | **Boolean**| Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] [default to true]
1078
- **application_id** | **String**| ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. | [optional]
1079
- **has_application** | **Boolean**| Indication of whether the phone number has an application linked to it. | [optional] [default to false]
1080
1508
 
1081
1509
  ### Return type
1082
1510
 
@@ -1094,40 +1522,62 @@ Name | Type | Description | Notes
1094
1522
 
1095
1523
  ## get_an_sms_message
1096
1524
 
1097
- > MessageResult get_an_sms_message(message_id)
1525
+ > <MessageResult> get_an_sms_message(account_id, message_id)
1098
1526
 
1099
1527
  Get an SMS Message
1100
1528
 
1101
- ### Example
1529
+ ### Examples
1102
1530
 
1103
1531
  ```ruby
1104
- # load the gem
1532
+ require 'time'
1105
1533
  require 'freeclimb'
1106
1534
  # setup authorization
1107
1535
  Freeclimb.configure do |config|
1108
1536
  # Configure HTTP basic authorization: fc
1109
- config.username = 'ACCOUNT ID'
1110
- config.password = 'API KEY'
1537
+ config.username = 'ACCOUNT_ID'
1538
+ config.password = 'API_KEY'
1111
1539
  end
1112
1540
 
1113
1541
  api_instance = Freeclimb::DefaultApi.new
1542
+
1114
1543
  message_id = 'message_id_example' # String | String that uniquely identifies this Message resource.
1115
1544
 
1545
+
1116
1546
  begin
1117
- #Get an SMS Message
1547
+
1548
+ # Get an SMS Message
1118
1549
  result = api_instance.get_an_sms_message(message_id)
1119
1550
  p result
1120
1551
  rescue Freeclimb::ApiError => e
1121
- puts "Exception when calling DefaultApi->get_an_sms_message: #{e}"
1552
+ puts "Error when calling DefaultApi->get_an_sms_message: #{e}"
1553
+ end
1554
+ ```
1555
+
1556
+ #### Using the get_an_sms_message_with_http_info variant
1557
+
1558
+ This returns an Array which contains the response data, status code and headers.
1559
+
1560
+ > <Array(<MessageResult>, Integer, Hash)> get_an_sms_message_with_http_info(account_id, message_id)
1561
+
1562
+ ```ruby
1563
+ begin
1564
+ # Get an SMS Message
1565
+ data, status_code, headers = api_instance.get_an_sms_message_with_http_info(message_id)
1566
+ p status_code # => 2xx
1567
+ p headers # => { ... }
1568
+ p data # => <MessageResult>
1569
+ rescue Freeclimb::ApiError => e
1570
+ puts "Error when calling DefaultApi->get_an_sms_message_with_http_info: #{e}"
1122
1571
  end
1123
1572
  ```
1124
1573
 
1125
1574
  ### Parameters
1126
1575
 
1576
+ | Name | Type | Description | Notes |
1577
+ | ---- | ---- | ----------- | ----- |
1578
+
1579
+ | **message_id** | **String** | String that uniquely identifies this Message resource. | |
1127
1580
 
1128
- Name | Type | Description | Notes
1129
- ------------- | ------------- | ------------- | -------------
1130
- **message_id** | **String**| String that uniquely identifies this Message resource. |
1131
1581
 
1132
1582
  ### Return type
1133
1583
 
@@ -1145,40 +1595,62 @@ Name | Type | Description | Notes
1145
1595
 
1146
1596
  ## get_head_member
1147
1597
 
1148
- > QueueMember get_head_member(queue_id)
1598
+ > <QueueMember> get_head_member(account_id, queue_id)
1149
1599
 
1150
1600
  Get Head Member
1151
1601
 
1152
- ### Example
1602
+ ### Examples
1153
1603
 
1154
1604
  ```ruby
1155
- # load the gem
1605
+ require 'time'
1156
1606
  require 'freeclimb'
1157
1607
  # setup authorization
1158
1608
  Freeclimb.configure do |config|
1159
1609
  # Configure HTTP basic authorization: fc
1160
- config.username = 'ACCOUNT ID'
1161
- config.password = 'API KEY'
1610
+ config.username = 'ACCOUNT_ID'
1611
+ config.password = 'API_KEY'
1162
1612
  end
1163
1613
 
1164
1614
  api_instance = Freeclimb::DefaultApi.new
1615
+
1165
1616
  queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
1166
1617
 
1618
+
1167
1619
  begin
1168
- #Get Head Member
1620
+
1621
+ # Get Head Member
1169
1622
  result = api_instance.get_head_member(queue_id)
1170
1623
  p result
1171
1624
  rescue Freeclimb::ApiError => e
1172
- puts "Exception when calling DefaultApi->get_head_member: #{e}"
1625
+ puts "Error when calling DefaultApi->get_head_member: #{e}"
1626
+ end
1627
+ ```
1628
+
1629
+ #### Using the get_head_member_with_http_info variant
1630
+
1631
+ This returns an Array which contains the response data, status code and headers.
1632
+
1633
+ > <Array(<QueueMember>, Integer, Hash)> get_head_member_with_http_info(account_id, queue_id)
1634
+
1635
+ ```ruby
1636
+ begin
1637
+ # Get Head Member
1638
+ data, status_code, headers = api_instance.get_head_member_with_http_info(queue_id)
1639
+ p status_code # => 2xx
1640
+ p headers # => { ... }
1641
+ p data # => <QueueMember>
1642
+ rescue Freeclimb::ApiError => e
1643
+ puts "Error when calling DefaultApi->get_head_member_with_http_info: #{e}"
1173
1644
  end
1174
1645
  ```
1175
1646
 
1176
1647
  ### Parameters
1177
1648
 
1649
+ | Name | Type | Description | Notes |
1650
+ | ---- | ---- | ----------- | ----- |
1651
+
1652
+ | **queue_id** | **String** | String that uniquely identifies the Queue that the Member belongs to. | |
1178
1653
 
1179
- Name | Type | Description | Notes
1180
- ------------- | ------------- | ------------- | -------------
1181
- **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. |
1182
1654
 
1183
1655
  ### Return type
1184
1656
 
@@ -1196,42 +1668,63 @@ Name | Type | Description | Notes
1196
1668
 
1197
1669
  ## list_active_queues
1198
1670
 
1199
- > QueueList list_active_queues(opts)
1671
+ > <QueueList> list_active_queues(account_id, opts)
1200
1672
 
1201
1673
  List Active Queues
1202
1674
 
1203
- ### Example
1675
+ ### Examples
1204
1676
 
1205
1677
  ```ruby
1206
- # load the gem
1678
+ require 'time'
1207
1679
  require 'freeclimb'
1208
1680
  # setup authorization
1209
1681
  Freeclimb.configure do |config|
1210
1682
  # Configure HTTP basic authorization: fc
1211
- config.username = 'ACCOUNT ID'
1212
- config.password = 'API KEY'
1683
+ config.username = 'ACCOUNT_ID'
1684
+ config.password = 'API_KEY'
1213
1685
  end
1214
1686
 
1215
1687
  api_instance = Freeclimb::DefaultApi.new
1688
+
1216
1689
  opts = {
1217
1690
  _alias: '_alias_example' # String | Return only the Queue resources with aliases that exactly match this name.
1218
1691
  }
1219
1692
 
1220
1693
  begin
1221
- #List Active Queues
1694
+
1695
+ # List Active Queues
1222
1696
  result = api_instance.list_active_queues(opts)
1223
1697
  p result
1224
1698
  rescue Freeclimb::ApiError => e
1225
- puts "Exception when calling DefaultApi->list_active_queues: #{e}"
1699
+ puts "Error when calling DefaultApi->list_active_queues: #{e}"
1700
+ end
1701
+ ```
1702
+
1703
+ #### Using the list_active_queues_with_http_info variant
1704
+
1705
+ This returns an Array which contains the response data, status code and headers.
1706
+
1707
+ > <Array(<QueueList>, Integer, Hash)> list_active_queues_with_http_info(account_id, opts)
1708
+
1709
+ ```ruby
1710
+ begin
1711
+ # List Active Queues
1712
+ data, status_code, headers = api_instance.list_active_queues_with_http_info(opts)
1713
+ p status_code # => 2xx
1714
+ p headers # => { ... }
1715
+ p data # => <QueueList>
1716
+ rescue Freeclimb::ApiError => e
1717
+ puts "Error when calling DefaultApi->list_active_queues_with_http_info: #{e}"
1226
1718
  end
1227
1719
  ```
1228
1720
 
1229
1721
  ### Parameters
1230
1722
 
1723
+ | Name | Type | Description | Notes |
1724
+ | ---- | ---- | ----------- | ----- |
1725
+
1726
+ | **_alias** | **String** | Return only the Queue resources with aliases that exactly match this name. | [optional] |
1231
1727
 
1232
- Name | Type | Description | Notes
1233
- ------------- | ------------- | ------------- | -------------
1234
- **_alias** | **String**| Return only the Queue resources with aliases that exactly match this name. | [optional]
1235
1728
 
1236
1729
  ### Return type
1237
1730
 
@@ -1249,36 +1742,58 @@ Name | Type | Description | Notes
1249
1742
 
1250
1743
  ## list_all_account_logs
1251
1744
 
1252
- > LogList list_all_account_logs
1745
+ > <LogList> list_all_account_logs(account_id)
1253
1746
 
1254
1747
  List All Account Logs
1255
1748
 
1256
- ### Example
1749
+ ### Examples
1257
1750
 
1258
1751
  ```ruby
1259
- # load the gem
1752
+ require 'time'
1260
1753
  require 'freeclimb'
1261
1754
  # setup authorization
1262
1755
  Freeclimb.configure do |config|
1263
1756
  # Configure HTTP basic authorization: fc
1264
- config.username = 'ACCOUNT ID'
1265
- config.password = 'API KEY'
1757
+ config.username = 'ACCOUNT_ID'
1758
+ config.password = 'API_KEY'
1266
1759
  end
1267
1760
 
1268
1761
  api_instance = Freeclimb::DefaultApi.new
1269
1762
 
1763
+
1270
1764
  begin
1271
- #List All Account Logs
1272
- result = api_instance.list_all_account_logs
1765
+
1766
+ # List All Account Logs
1767
+ result = api_instance.list_all_account_logs()
1273
1768
  p result
1274
1769
  rescue Freeclimb::ApiError => e
1275
- puts "Exception when calling DefaultApi->list_all_account_logs: #{e}"
1770
+ puts "Error when calling DefaultApi->list_all_account_logs: #{e}"
1771
+ end
1772
+ ```
1773
+
1774
+ #### Using the list_all_account_logs_with_http_info variant
1775
+
1776
+ This returns an Array which contains the response data, status code and headers.
1777
+
1778
+ > <Array(<LogList>, Integer, Hash)> list_all_account_logs_with_http_info(account_id)
1779
+
1780
+ ```ruby
1781
+ begin
1782
+ # List All Account Logs
1783
+ data, status_code, headers = api_instance.list_all_account_logs_with_http_info()
1784
+ p status_code # => 2xx
1785
+ p headers # => { ... }
1786
+ p data # => <LogList>
1787
+ rescue Freeclimb::ApiError => e
1788
+ puts "Error when calling DefaultApi->list_all_account_logs_with_http_info: #{e}"
1276
1789
  end
1277
1790
  ```
1278
1791
 
1279
1792
  ### Parameters
1280
1793
 
1281
- This endpoint does not need any parameter.
1794
+ | Name | Type | Description | Notes |
1795
+ | ---- | ---- | ----------- | ----- |
1796
+
1282
1797
 
1283
1798
  ### Return type
1284
1799
 
@@ -1296,42 +1811,63 @@ This endpoint does not need any parameter.
1296
1811
 
1297
1812
  ## list_an_application
1298
1813
 
1299
- > ApplicationList list_an_application(opts)
1814
+ > <ApplicationList> list_an_application(account_id, opts)
1300
1815
 
1301
1816
  List applications
1302
1817
 
1303
- ### Example
1818
+ ### Examples
1304
1819
 
1305
1820
  ```ruby
1306
- # load the gem
1821
+ require 'time'
1307
1822
  require 'freeclimb'
1308
1823
  # setup authorization
1309
1824
  Freeclimb.configure do |config|
1310
1825
  # Configure HTTP basic authorization: fc
1311
- config.username = 'ACCOUNT ID'
1312
- config.password = 'API KEY'
1826
+ config.username = 'ACCOUNT_ID'
1827
+ config.password = 'API_KEY'
1313
1828
  end
1314
1829
 
1315
1830
  api_instance = Freeclimb::DefaultApi.new
1831
+
1316
1832
  opts = {
1317
1833
  _alias: '_alias_example' # String | Return only applications with aliases that exactly match this value.
1318
1834
  }
1319
1835
 
1320
1836
  begin
1321
- #List applications
1837
+
1838
+ # List applications
1322
1839
  result = api_instance.list_an_application(opts)
1323
1840
  p result
1324
1841
  rescue Freeclimb::ApiError => e
1325
- puts "Exception when calling DefaultApi->list_an_application: #{e}"
1842
+ puts "Error when calling DefaultApi->list_an_application: #{e}"
1843
+ end
1844
+ ```
1845
+
1846
+ #### Using the list_an_application_with_http_info variant
1847
+
1848
+ This returns an Array which contains the response data, status code and headers.
1849
+
1850
+ > <Array(<ApplicationList>, Integer, Hash)> list_an_application_with_http_info(account_id, opts)
1851
+
1852
+ ```ruby
1853
+ begin
1854
+ # List applications
1855
+ data, status_code, headers = api_instance.list_an_application_with_http_info(opts)
1856
+ p status_code # => 2xx
1857
+ p headers # => { ... }
1858
+ p data # => <ApplicationList>
1859
+ rescue Freeclimb::ApiError => e
1860
+ puts "Error when calling DefaultApi->list_an_application_with_http_info: #{e}"
1326
1861
  end
1327
1862
  ```
1328
1863
 
1329
1864
  ### Parameters
1330
1865
 
1866
+ | Name | Type | Description | Notes |
1867
+ | ---- | ---- | ----------- | ----- |
1868
+
1869
+ | **_alias** | **String** | Return only applications with aliases that exactly match this value. | [optional] |
1331
1870
 
1332
- Name | Type | Description | Notes
1333
- ------------- | ------------- | ------------- | -------------
1334
- **_alias** | **String**| Return only applications with aliases that exactly match this value. | [optional]
1335
1871
 
1336
1872
  ### Return type
1337
1873
 
@@ -1349,50 +1885,90 @@ Name | Type | Description | Notes
1349
1885
 
1350
1886
  ## list_available_numbers
1351
1887
 
1352
- > AvailableNumberList list_available_numbers(opts)
1888
+ > <AvailableNumberList> list_available_numbers(opts)
1353
1889
 
1354
1890
  List available numbers
1355
1891
 
1356
- ### Example
1892
+ ### Examples
1357
1893
 
1358
1894
  ```ruby
1359
- # load the gem
1895
+ require 'time'
1360
1896
  require 'freeclimb'
1361
1897
  # setup authorization
1362
1898
  Freeclimb.configure do |config|
1363
1899
  # Configure HTTP basic authorization: fc
1364
- config.username = 'ACCOUNT ID'
1365
- config.password = 'API KEY'
1900
+ config.username = 'ACCOUNT_ID'
1901
+ config.password = 'API_KEY'
1366
1902
  end
1367
1903
 
1368
1904
  api_instance = Freeclimb::DefaultApi.new
1905
+
1369
1906
  opts = {
1370
1907
  phone_number: 'phone_number_example', # String | PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format.
1371
1908
  region: 'region_example', # String | State or province of this phone number.
1372
1909
  country: 'country_example', # String | Country of this phone number.
1373
1910
  voice_enabled: true, # Boolean | Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
1374
- sms_enabled: true # Boolean | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
1911
+ sms_enabled: true, # Boolean | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
1912
+ capabilities_voice: true, # Boolean |
1913
+ capabilities_sms: true, # Boolean |
1914
+ capabilities_toll_free: true, # Boolean |
1915
+ capabilities_ten_dlc: true, # Boolean |
1916
+ capabilities_short_code: true # Boolean |
1375
1917
  }
1376
1918
 
1377
1919
  begin
1378
- #List available numbers
1920
+
1921
+ # List available numbers
1379
1922
  result = api_instance.list_available_numbers(opts)
1380
1923
  p result
1381
1924
  rescue Freeclimb::ApiError => e
1382
- puts "Exception when calling DefaultApi->list_available_numbers: #{e}"
1925
+ puts "Error when calling DefaultApi->list_available_numbers: #{e}"
1926
+ end
1927
+ ```
1928
+
1929
+ #### Using the list_available_numbers_with_http_info variant
1930
+
1931
+ This returns an Array which contains the response data, status code and headers.
1932
+
1933
+ > <Array(<AvailableNumberList>, Integer, Hash)> list_available_numbers_with_http_info(opts)
1934
+
1935
+ ```ruby
1936
+ begin
1937
+ # List available numbers
1938
+ data, status_code, headers = api_instance.list_available_numbers_with_http_info(opts)
1939
+ p status_code # => 2xx
1940
+ p headers # => { ... }
1941
+ p data # => <AvailableNumberList>
1942
+ rescue Freeclimb::ApiError => e
1943
+ puts "Error when calling DefaultApi->list_available_numbers_with_http_info: #{e}"
1383
1944
  end
1384
1945
  ```
1385
1946
 
1386
1947
  ### Parameters
1387
1948
 
1949
+ | Name | Type | Description | Notes |
1950
+ | ---- | ---- | ----------- | ----- |
1951
+
1952
+ | **phone_number** | **String** | PCRE-compatible regular expression to filter against &#x60;phoneNumber&#x60; field, which is in E.164 format. | [optional] |
1953
+
1954
+ | **region** | **String** | State or province of this phone number. | [optional] |
1955
+
1956
+ | **country** | **String** | Country of this phone number. | [optional] |
1957
+
1958
+ | **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional][default to true] |
1959
+
1960
+ | **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional][default to true] |
1961
+
1962
+ | **capabilities_voice** | **Boolean** | | [optional] |
1963
+
1964
+ | **capabilities_sms** | **Boolean** | | [optional] |
1965
+
1966
+ | **capabilities_toll_free** | **Boolean** | | [optional] |
1967
+
1968
+ | **capabilities_ten_dlc** | **Boolean** | | [optional] |
1969
+
1970
+ | **capabilities_short_code** | **Boolean** | | [optional] |
1388
1971
 
1389
- Name | Type | Description | Notes
1390
- ------------- | ------------- | ------------- | -------------
1391
- **phone_number** | **String**| PCRE-compatible regular expression to filter against &#x60;phoneNumber&#x60; field, which is in E.164 format. | [optional]
1392
- **region** | **String**| State or province of this phone number. | [optional]
1393
- **country** | **String**| Country of this phone number. | [optional]
1394
- **voice_enabled** | **Boolean**| Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional] [default to true]
1395
- **sms_enabled** | **Boolean**| Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional] [default to true]
1396
1972
 
1397
1973
  ### Return type
1398
1974
 
@@ -1410,40 +1986,62 @@ Name | Type | Description | Notes
1410
1986
 
1411
1987
  ## list_call_logs
1412
1988
 
1413
- > LogList list_call_logs(call_id)
1989
+ > <LogList> list_call_logs(account_id, call_id)
1414
1990
 
1415
1991
  List Call Logs
1416
1992
 
1417
- ### Example
1993
+ ### Examples
1418
1994
 
1419
1995
  ```ruby
1420
- # load the gem
1996
+ require 'time'
1421
1997
  require 'freeclimb'
1422
1998
  # setup authorization
1423
1999
  Freeclimb.configure do |config|
1424
2000
  # Configure HTTP basic authorization: fc
1425
- config.username = 'ACCOUNT ID'
1426
- config.password = 'API KEY'
2001
+ config.username = 'ACCOUNT_ID'
2002
+ config.password = 'API_KEY'
1427
2003
  end
1428
2004
 
1429
2005
  api_instance = Freeclimb::DefaultApi.new
2006
+
1430
2007
  call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
1431
2008
 
2009
+
1432
2010
  begin
1433
- #List Call Logs
2011
+
2012
+ # List Call Logs
1434
2013
  result = api_instance.list_call_logs(call_id)
1435
2014
  p result
1436
2015
  rescue Freeclimb::ApiError => e
1437
- puts "Exception when calling DefaultApi->list_call_logs: #{e}"
2016
+ puts "Error when calling DefaultApi->list_call_logs: #{e}"
2017
+ end
2018
+ ```
2019
+
2020
+ #### Using the list_call_logs_with_http_info variant
2021
+
2022
+ This returns an Array which contains the response data, status code and headers.
2023
+
2024
+ > <Array(<LogList>, Integer, Hash)> list_call_logs_with_http_info(account_id, call_id)
2025
+
2026
+ ```ruby
2027
+ begin
2028
+ # List Call Logs
2029
+ data, status_code, headers = api_instance.list_call_logs_with_http_info(call_id)
2030
+ p status_code # => 2xx
2031
+ p headers # => { ... }
2032
+ p data # => <LogList>
2033
+ rescue Freeclimb::ApiError => e
2034
+ puts "Error when calling DefaultApi->list_call_logs_with_http_info: #{e}"
1438
2035
  end
1439
2036
  ```
1440
2037
 
1441
2038
  ### Parameters
1442
2039
 
2040
+ | Name | Type | Description | Notes |
2041
+ | ---- | ---- | ----------- | ----- |
2042
+
2043
+ | **call_id** | **String** | String that uniquely identifies this call resource. | |
1443
2044
 
1444
- Name | Type | Description | Notes
1445
- ------------- | ------------- | ------------- | -------------
1446
- **call_id** | **String**| String that uniquely identifies this call resource. |
1447
2045
 
1448
2046
  ### Return type
1449
2047
 
@@ -1461,44 +2059,67 @@ Name | Type | Description | Notes
1461
2059
 
1462
2060
  ## list_call_recordings
1463
2061
 
1464
- > RecordingList list_call_recordings(call_id, opts)
2062
+ > <RecordingList> list_call_recordings(account_id, call_id, opts)
1465
2063
 
1466
2064
  List Call Recordings
1467
2065
 
1468
- ### Example
2066
+ ### Examples
1469
2067
 
1470
2068
  ```ruby
1471
- # load the gem
2069
+ require 'time'
1472
2070
  require 'freeclimb'
1473
2071
  # setup authorization
1474
2072
  Freeclimb.configure do |config|
1475
2073
  # Configure HTTP basic authorization: fc
1476
- config.username = 'ACCOUNT ID'
1477
- config.password = 'API KEY'
2074
+ config.username = 'ACCOUNT_ID'
2075
+ config.password = 'API_KEY'
1478
2076
  end
1479
2077
 
1480
2078
  api_instance = Freeclimb::DefaultApi.new
2079
+
1481
2080
  call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
2081
+
1482
2082
  opts = {
1483
2083
  date_created: 'date_created_example' # String | Only show recordings created on the specified date, in the form *YYYY-MM-DD*.
1484
2084
  }
1485
2085
 
1486
2086
  begin
1487
- #List Call Recordings
2087
+
2088
+ # List Call Recordings
1488
2089
  result = api_instance.list_call_recordings(call_id, opts)
1489
2090
  p result
1490
2091
  rescue Freeclimb::ApiError => e
1491
- puts "Exception when calling DefaultApi->list_call_recordings: #{e}"
2092
+ puts "Error when calling DefaultApi->list_call_recordings: #{e}"
2093
+ end
2094
+ ```
2095
+
2096
+ #### Using the list_call_recordings_with_http_info variant
2097
+
2098
+ This returns an Array which contains the response data, status code and headers.
2099
+
2100
+ > <Array(<RecordingList>, Integer, Hash)> list_call_recordings_with_http_info(account_id, call_id, opts)
2101
+
2102
+ ```ruby
2103
+ begin
2104
+ # List Call Recordings
2105
+ data, status_code, headers = api_instance.list_call_recordings_with_http_info(call_id, opts)
2106
+ p status_code # => 2xx
2107
+ p headers # => { ... }
2108
+ p data # => <RecordingList>
2109
+ rescue Freeclimb::ApiError => e
2110
+ puts "Error when calling DefaultApi->list_call_recordings_with_http_info: #{e}"
1492
2111
  end
1493
2112
  ```
1494
2113
 
1495
2114
  ### Parameters
1496
2115
 
2116
+ | Name | Type | Description | Notes |
2117
+ | ---- | ---- | ----------- | ----- |
2118
+
2119
+ | **call_id** | **String** | String that uniquely identifies this call resource. | |
2120
+
2121
+ | **date_created** | **String** | Only show recordings created on the specified date, in the form *YYYY-MM-DD*. | [optional] |
1497
2122
 
1498
- Name | Type | Description | Notes
1499
- ------------- | ------------- | ------------- | -------------
1500
- **call_id** | **String**| String that uniquely identifies this call resource. |
1501
- **date_created** | **String**| Only show recordings created on the specified date, in the form *YYYY-MM-DD*. | [optional]
1502
2123
 
1503
2124
  ### Return type
1504
2125
 
@@ -1516,25 +2137,26 @@ Name | Type | Description | Notes
1516
2137
 
1517
2138
  ## list_calls
1518
2139
 
1519
- > CallList list_calls(opts)
2140
+ > <CallList> list_calls(account_id, opts)
1520
2141
 
1521
2142
  List Calls
1522
2143
 
1523
- ### Example
2144
+ ### Examples
1524
2145
 
1525
2146
  ```ruby
1526
- # load the gem
2147
+ require 'time'
1527
2148
  require 'freeclimb'
1528
2149
  # setup authorization
1529
2150
  Freeclimb.configure do |config|
1530
2151
  # Configure HTTP basic authorization: fc
1531
- config.username = 'ACCOUNT ID'
1532
- config.password = 'API KEY'
2152
+ config.username = 'ACCOUNT_ID'
2153
+ config.password = 'API_KEY'
1533
2154
  end
1534
2155
 
1535
2156
  api_instance = Freeclimb::DefaultApi.new
2157
+
1536
2158
  opts = {
1537
- active: false, # Boolean | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.
2159
+ active: true, # Boolean | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query.
1538
2160
  to: 'to_example', # String | Only show Calls to this phone number.
1539
2161
  from: 'from_example', # String | Only show Calls from this phone number.
1540
2162
  status: 'status_example', # String | Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`.
@@ -1544,26 +2166,52 @@ opts = {
1544
2166
  }
1545
2167
 
1546
2168
  begin
1547
- #List Calls
2169
+
2170
+ # List Calls
1548
2171
  result = api_instance.list_calls(opts)
1549
2172
  p result
1550
2173
  rescue Freeclimb::ApiError => e
1551
- puts "Exception when calling DefaultApi->list_calls: #{e}"
2174
+ puts "Error when calling DefaultApi->list_calls: #{e}"
2175
+ end
2176
+ ```
2177
+
2178
+ #### Using the list_calls_with_http_info variant
2179
+
2180
+ This returns an Array which contains the response data, status code and headers.
2181
+
2182
+ > <Array(<CallList>, Integer, Hash)> list_calls_with_http_info(account_id, opts)
2183
+
2184
+ ```ruby
2185
+ begin
2186
+ # List Calls
2187
+ data, status_code, headers = api_instance.list_calls_with_http_info(opts)
2188
+ p status_code # => 2xx
2189
+ p headers # => { ... }
2190
+ p data # => <CallList>
2191
+ rescue Freeclimb::ApiError => e
2192
+ puts "Error when calling DefaultApi->list_calls_with_http_info: #{e}"
1552
2193
  end
1553
2194
  ```
1554
2195
 
1555
- ### Parameters
2196
+ ### Parameters
2197
+
2198
+ | Name | Type | Description | Notes |
2199
+ | ---- | ---- | ----------- | ----- |
2200
+
2201
+ | **active** | **Boolean** | If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. | [optional][default to false] |
2202
+
2203
+ | **to** | **String** | Only show Calls to this phone number. | [optional] |
2204
+
2205
+ | **from** | **String** | Only show Calls from this phone number. | [optional] |
2206
+
2207
+ | **status** | **String** | Only show Calls currently in this status. May be &#x60;queued&#x60;, &#x60;ringing&#x60;, &#x60;inProgress&#x60;, &#x60;canceled&#x60;, &#x60;completed&#x60;, &#x60;failed&#x60;, &#x60;busy&#x60;, or &#x60;noAnswer&#x60;. | [optional] |
2208
+
2209
+ | **start_time** | **String** | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional] |
2210
+
2211
+ | **end_time** | **String** | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional] |
1556
2212
 
2213
+ | **parent_call_id** | **String** | Only show Calls spawned by the call with this ID. | [optional] |
1557
2214
 
1558
- Name | Type | Description | Notes
1559
- ------------- | ------------- | ------------- | -------------
1560
- **active** | **Boolean**| If active is set to true then all calls of the nature queued, ringing, inProgress are returned in the query. | [optional] [default to false]
1561
- **to** | **String**| Only show Calls to this phone number. | [optional]
1562
- **from** | **String**| Only show Calls from this phone number. | [optional]
1563
- **status** | **String**| Only show Calls currently in this status. May be &#x60;queued&#x60;, &#x60;ringing&#x60;, &#x60;inProgress&#x60;, &#x60;canceled&#x60;, &#x60;completed&#x60;, &#x60;failed&#x60;, &#x60;busy&#x60;, or &#x60;noAnswer&#x60;. | [optional]
1564
- **start_time** | **String**| Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional]
1565
- **end_time** | **String**| Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional]
1566
- **parent_call_id** | **String**| Only show Calls spawned by the call with this ID. | [optional]
1567
2215
 
1568
2216
  ### Return type
1569
2217
 
@@ -1581,23 +2229,24 @@ Name | Type | Description | Notes
1581
2229
 
1582
2230
  ## list_conferences
1583
2231
 
1584
- > ConferenceList list_conferences(opts)
2232
+ > <ConferenceList> list_conferences(account_id, opts)
1585
2233
 
1586
2234
  List Conferences
1587
2235
 
1588
- ### Example
2236
+ ### Examples
1589
2237
 
1590
2238
  ```ruby
1591
- # load the gem
2239
+ require 'time'
1592
2240
  require 'freeclimb'
1593
2241
  # setup authorization
1594
2242
  Freeclimb.configure do |config|
1595
2243
  # Configure HTTP basic authorization: fc
1596
- config.username = 'ACCOUNT ID'
1597
- config.password = 'API KEY'
2244
+ config.username = 'ACCOUNT_ID'
2245
+ config.password = 'API_KEY'
1598
2246
  end
1599
2247
 
1600
2248
  api_instance = Freeclimb::DefaultApi.new
2249
+
1601
2250
  opts = {
1602
2251
  status: 'status_example', # String | Only show conferences that currently have the specified status. Valid values: `empty`, `populated`, `inProgress`, or `terminated`.
1603
2252
  _alias: '_alias_example', # String | List Conferences whose alias exactly matches this string.
@@ -1606,23 +2255,46 @@ opts = {
1606
2255
  }
1607
2256
 
1608
2257
  begin
1609
- #List Conferences
2258
+
2259
+ # List Conferences
1610
2260
  result = api_instance.list_conferences(opts)
1611
2261
  p result
1612
2262
  rescue Freeclimb::ApiError => e
1613
- puts "Exception when calling DefaultApi->list_conferences: #{e}"
2263
+ puts "Error when calling DefaultApi->list_conferences: #{e}"
2264
+ end
2265
+ ```
2266
+
2267
+ #### Using the list_conferences_with_http_info variant
2268
+
2269
+ This returns an Array which contains the response data, status code and headers.
2270
+
2271
+ > <Array(<ConferenceList>, Integer, Hash)> list_conferences_with_http_info(account_id, opts)
2272
+
2273
+ ```ruby
2274
+ begin
2275
+ # List Conferences
2276
+ data, status_code, headers = api_instance.list_conferences_with_http_info(opts)
2277
+ p status_code # => 2xx
2278
+ p headers # => { ... }
2279
+ p data # => <ConferenceList>
2280
+ rescue Freeclimb::ApiError => e
2281
+ puts "Error when calling DefaultApi->list_conferences_with_http_info: #{e}"
1614
2282
  end
1615
2283
  ```
1616
2284
 
1617
2285
  ### Parameters
1618
2286
 
2287
+ | Name | Type | Description | Notes |
2288
+ | ---- | ---- | ----------- | ----- |
2289
+
2290
+ | **status** | **String** | Only show conferences that currently have the specified status. Valid values: &#x60;empty&#x60;, &#x60;populated&#x60;, &#x60;inProgress&#x60;, or &#x60;terminated&#x60;. | [optional] |
2291
+
2292
+ | **_alias** | **String** | List Conferences whose alias exactly matches this string. | [optional] |
2293
+
2294
+ | **date_created** | **String** | Only show Conferences that were created on the specified date, in the form *YYYY-MM-DD*. | [optional] |
2295
+
2296
+ | **date_updated** | **String** | Only show Conferences that were last updated on the specified date, in the form *YYYY-MM-DD*. | [optional] |
1619
2297
 
1620
- Name | Type | Description | Notes
1621
- ------------- | ------------- | ------------- | -------------
1622
- **status** | **String**| Only show conferences that currently have the specified status. Valid values: &#x60;empty&#x60;, &#x60;populated&#x60;, &#x60;inProgress&#x60;, or &#x60;terminated&#x60;. | [optional]
1623
- **_alias** | **String**| List Conferences whose alias exactly matches this string. | [optional]
1624
- **date_created** | **String**| Only show Conferences that were created on the specified date, in the form *YYYY-MM-DD*. | [optional]
1625
- **date_updated** | **String**| Only show Conferences that were last updated on the specified date, in the form *YYYY-MM-DD*. | [optional]
1626
2298
 
1627
2299
  ### Return type
1628
2300
 
@@ -1640,44 +2312,99 @@ Name | Type | Description | Notes
1640
2312
 
1641
2313
  ## list_incoming_numbers
1642
2314
 
1643
- > IncomingNumberList list_incoming_numbers(opts)
2315
+ > <IncomingNumberList> list_incoming_numbers(account_id, opts)
1644
2316
 
1645
2317
  List Incoming Numbers
1646
2318
 
1647
- ### Example
2319
+ ### Examples
1648
2320
 
1649
2321
  ```ruby
1650
- # load the gem
2322
+ require 'time'
1651
2323
  require 'freeclimb'
1652
2324
  # setup authorization
1653
2325
  Freeclimb.configure do |config|
1654
2326
  # Configure HTTP basic authorization: fc
1655
- config.username = 'ACCOUNT ID'
1656
- config.password = 'API KEY'
2327
+ config.username = 'ACCOUNT_ID'
2328
+ config.password = 'API_KEY'
1657
2329
  end
1658
2330
 
1659
2331
  api_instance = Freeclimb::DefaultApi.new
2332
+
1660
2333
  opts = {
1661
2334
  phone_number: 'phone_number_example', # String | Only show incoming phone number resources that match this PCRE-compatible regular expression.
1662
- _alias: '_alias_example' # String | Only show incoming phone numbers with aliases that exactly match this value.
2335
+ _alias: '_alias_example', # String | Only show incoming phone numbers with aliases that exactly match this value.
2336
+ region: 'region_example', # String | State or province of this phone number.
2337
+ country: 'country_example', # String | Country of this phone number.
2338
+ application_id: 'application_id_example', # String | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId.
2339
+ has_application: true, # Boolean | Indication of whether the phone number has an application linked to it.
2340
+ voice_enabled: true, # Boolean | Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
2341
+ sms_enabled: true, # Boolean | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
2342
+ capabilities_voice: true, # Boolean |
2343
+ capabilities_sms: true, # Boolean |
2344
+ capabilities_toll_free: true, # Boolean |
2345
+ capabilities_ten_dlc: true, # Boolean |
2346
+ capabilities_short_code: true # Boolean |
1663
2347
  }
1664
2348
 
1665
2349
  begin
1666
- #List Incoming Numbers
2350
+
2351
+ # List Incoming Numbers
1667
2352
  result = api_instance.list_incoming_numbers(opts)
1668
2353
  p result
1669
2354
  rescue Freeclimb::ApiError => e
1670
- puts "Exception when calling DefaultApi->list_incoming_numbers: #{e}"
2355
+ puts "Error when calling DefaultApi->list_incoming_numbers: #{e}"
2356
+ end
2357
+ ```
2358
+
2359
+ #### Using the list_incoming_numbers_with_http_info variant
2360
+
2361
+ This returns an Array which contains the response data, status code and headers.
2362
+
2363
+ > <Array(<IncomingNumberList>, Integer, Hash)> list_incoming_numbers_with_http_info(account_id, opts)
2364
+
2365
+ ```ruby
2366
+ begin
2367
+ # List Incoming Numbers
2368
+ data, status_code, headers = api_instance.list_incoming_numbers_with_http_info(opts)
2369
+ p status_code # => 2xx
2370
+ p headers # => { ... }
2371
+ p data # => <IncomingNumberList>
2372
+ rescue Freeclimb::ApiError => e
2373
+ puts "Error when calling DefaultApi->list_incoming_numbers_with_http_info: #{e}"
1671
2374
  end
1672
2375
  ```
1673
2376
 
1674
2377
  ### Parameters
1675
2378
 
2379
+ | Name | Type | Description | Notes |
2380
+ | ---- | ---- | ----------- | ----- |
2381
+
2382
+ | **phone_number** | **String** | Only show incoming phone number resources that match this PCRE-compatible regular expression. | [optional] |
2383
+
2384
+ | **_alias** | **String** | Only show incoming phone numbers with aliases that exactly match this value. | [optional] |
2385
+
2386
+ | **region** | **String** | State or province of this phone number. | [optional] |
2387
+
2388
+ | **country** | **String** | Country of this phone number. | [optional] |
2389
+
2390
+ | **application_id** | **String** | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. | [optional] |
2391
+
2392
+ | **has_application** | **Boolean** | Indication of whether the phone number has an application linked to it. | [optional][default to false] |
2393
+
2394
+ | **voice_enabled** | **Boolean** | Indicates whether the phone number can handle Calls. Typically set to true for all numbers. | [optional][default to true] |
2395
+
2396
+ | **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional][default to true] |
2397
+
2398
+ | **capabilities_voice** | **Boolean** | | [optional] |
2399
+
2400
+ | **capabilities_sms** | **Boolean** | | [optional] |
2401
+
2402
+ | **capabilities_toll_free** | **Boolean** | | [optional] |
2403
+
2404
+ | **capabilities_ten_dlc** | **Boolean** | | [optional] |
2405
+
2406
+ | **capabilities_short_code** | **Boolean** | | [optional] |
1676
2407
 
1677
- Name | Type | Description | Notes
1678
- ------------- | ------------- | ------------- | -------------
1679
- **phone_number** | **String**| Only show incoming phone number resources that match this PCRE-compatible regular expression. | [optional]
1680
- **_alias** | **String**| Only show incoming phone numbers with aliases that exactly match this value. | [optional]
1681
2408
 
1682
2409
  ### Return type
1683
2410
 
@@ -1695,40 +2422,62 @@ Name | Type | Description | Notes
1695
2422
 
1696
2423
  ## list_members
1697
2424
 
1698
- > QueueMemberList list_members(queue_id)
2425
+ > <QueueMemberList> list_members(account_id, queue_id)
1699
2426
 
1700
2427
  List Members
1701
2428
 
1702
- ### Example
2429
+ ### Examples
1703
2430
 
1704
2431
  ```ruby
1705
- # load the gem
2432
+ require 'time'
1706
2433
  require 'freeclimb'
1707
2434
  # setup authorization
1708
2435
  Freeclimb.configure do |config|
1709
2436
  # Configure HTTP basic authorization: fc
1710
- config.username = 'ACCOUNT ID'
1711
- config.password = 'API KEY'
2437
+ config.username = 'ACCOUNT_ID'
2438
+ config.password = 'API_KEY'
1712
2439
  end
1713
2440
 
1714
2441
  api_instance = Freeclimb::DefaultApi.new
2442
+
1715
2443
  queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
1716
2444
 
2445
+
1717
2446
  begin
1718
- #List Members
2447
+
2448
+ # List Members
1719
2449
  result = api_instance.list_members(queue_id)
1720
2450
  p result
1721
2451
  rescue Freeclimb::ApiError => e
1722
- puts "Exception when calling DefaultApi->list_members: #{e}"
2452
+ puts "Error when calling DefaultApi->list_members: #{e}"
2453
+ end
2454
+ ```
2455
+
2456
+ #### Using the list_members_with_http_info variant
2457
+
2458
+ This returns an Array which contains the response data, status code and headers.
2459
+
2460
+ > <Array(<QueueMemberList>, Integer, Hash)> list_members_with_http_info(account_id, queue_id)
2461
+
2462
+ ```ruby
2463
+ begin
2464
+ # List Members
2465
+ data, status_code, headers = api_instance.list_members_with_http_info(queue_id)
2466
+ p status_code # => 2xx
2467
+ p headers # => { ... }
2468
+ p data # => <QueueMemberList>
2469
+ rescue Freeclimb::ApiError => e
2470
+ puts "Error when calling DefaultApi->list_members_with_http_info: #{e}"
1723
2471
  end
1724
2472
  ```
1725
2473
 
1726
2474
  ### Parameters
1727
2475
 
2476
+ | Name | Type | Description | Notes |
2477
+ | ---- | ---- | ----------- | ----- |
2478
+
2479
+ | **queue_id** | **String** | String that uniquely identifies the Queue that the Member belongs to. | |
1728
2480
 
1729
- Name | Type | Description | Notes
1730
- ------------- | ------------- | ------------- | -------------
1731
- **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. |
1732
2481
 
1733
2482
  ### Return type
1734
2483
 
@@ -1746,46 +2495,70 @@ Name | Type | Description | Notes
1746
2495
 
1747
2496
  ## list_participants
1748
2497
 
1749
- > ConferenceParticipantList list_participants(conference_id, opts)
2498
+ > <ConferenceParticipantList> list_participants(account_id, conference_id, opts)
1750
2499
 
1751
2500
  List Participants
1752
2501
 
1753
- ### Example
2502
+ ### Examples
1754
2503
 
1755
2504
  ```ruby
1756
- # load the gem
2505
+ require 'time'
1757
2506
  require 'freeclimb'
1758
2507
  # setup authorization
1759
2508
  Freeclimb.configure do |config|
1760
2509
  # Configure HTTP basic authorization: fc
1761
- config.username = 'ACCOUNT ID'
1762
- config.password = 'API KEY'
2510
+ config.username = 'ACCOUNT_ID'
2511
+ config.password = 'API_KEY'
1763
2512
  end
1764
2513
 
1765
2514
  api_instance = Freeclimb::DefaultApi.new
2515
+
1766
2516
  conference_id = 'conference_id_example' # String | ID of the conference this participant is in.
2517
+
1767
2518
  opts = {
1768
2519
  talk: true, # Boolean | Only show Participants with the talk privilege.
1769
2520
  listen: true # Boolean | Only show Participants with the listen privilege.
1770
2521
  }
1771
2522
 
1772
2523
  begin
1773
- #List Participants
2524
+
2525
+ # List Participants
1774
2526
  result = api_instance.list_participants(conference_id, opts)
1775
2527
  p result
1776
2528
  rescue Freeclimb::ApiError => e
1777
- puts "Exception when calling DefaultApi->list_participants: #{e}"
2529
+ puts "Error when calling DefaultApi->list_participants: #{e}"
2530
+ end
2531
+ ```
2532
+
2533
+ #### Using the list_participants_with_http_info variant
2534
+
2535
+ This returns an Array which contains the response data, status code and headers.
2536
+
2537
+ > <Array(<ConferenceParticipantList>, Integer, Hash)> list_participants_with_http_info(account_id, conference_id, opts)
2538
+
2539
+ ```ruby
2540
+ begin
2541
+ # List Participants
2542
+ data, status_code, headers = api_instance.list_participants_with_http_info(conference_id, opts)
2543
+ p status_code # => 2xx
2544
+ p headers # => { ... }
2545
+ p data # => <ConferenceParticipantList>
2546
+ rescue Freeclimb::ApiError => e
2547
+ puts "Error when calling DefaultApi->list_participants_with_http_info: #{e}"
1778
2548
  end
1779
2549
  ```
1780
2550
 
1781
2551
  ### Parameters
1782
2552
 
2553
+ | Name | Type | Description | Notes |
2554
+ | ---- | ---- | ----------- | ----- |
2555
+
2556
+ | **conference_id** | **String** | ID of the conference this participant is in. | |
2557
+
2558
+ | **talk** | **Boolean** | Only show Participants with the talk privilege. | [optional] |
2559
+
2560
+ | **listen** | **Boolean** | Only show Participants with the listen privilege. | [optional] |
1783
2561
 
1784
- Name | Type | Description | Notes
1785
- ------------- | ------------- | ------------- | -------------
1786
- **conference_id** | **String**| ID of the conference this participant is in. |
1787
- **talk** | **Boolean**| Only show Participants with the talk privilege. | [optional]
1788
- **listen** | **Boolean**| Only show Participants with the listen privilege. | [optional]
1789
2562
 
1790
2563
  ### Return type
1791
2564
 
@@ -1803,23 +2576,24 @@ Name | Type | Description | Notes
1803
2576
 
1804
2577
  ## list_recordings
1805
2578
 
1806
- > RecordingList list_recordings(opts)
2579
+ > <RecordingList> list_recordings(account_id, opts)
1807
2580
 
1808
2581
  List Recordings
1809
2582
 
1810
- ### Example
2583
+ ### Examples
1811
2584
 
1812
2585
  ```ruby
1813
- # load the gem
2586
+ require 'time'
1814
2587
  require 'freeclimb'
1815
2588
  # setup authorization
1816
2589
  Freeclimb.configure do |config|
1817
2590
  # Configure HTTP basic authorization: fc
1818
- config.username = 'ACCOUNT ID'
1819
- config.password = 'API KEY'
2591
+ config.username = 'ACCOUNT_ID'
2592
+ config.password = 'API_KEY'
1820
2593
  end
1821
2594
 
1822
2595
  api_instance = Freeclimb::DefaultApi.new
2596
+
1823
2597
  opts = {
1824
2598
  call_id: 'call_id_example', # String | Show only Recordings made during the Call with this ID.
1825
2599
  conference_id: 'conference_id_example', # String | Show only Recordings made during the conference with this ID.
@@ -1827,22 +2601,44 @@ opts = {
1827
2601
  }
1828
2602
 
1829
2603
  begin
1830
- #List Recordings
2604
+
2605
+ # List Recordings
1831
2606
  result = api_instance.list_recordings(opts)
1832
2607
  p result
1833
2608
  rescue Freeclimb::ApiError => e
1834
- puts "Exception when calling DefaultApi->list_recordings: #{e}"
2609
+ puts "Error when calling DefaultApi->list_recordings: #{e}"
2610
+ end
2611
+ ```
2612
+
2613
+ #### Using the list_recordings_with_http_info variant
2614
+
2615
+ This returns an Array which contains the response data, status code and headers.
2616
+
2617
+ > <Array(<RecordingList>, Integer, Hash)> list_recordings_with_http_info(account_id, opts)
2618
+
2619
+ ```ruby
2620
+ begin
2621
+ # List Recordings
2622
+ data, status_code, headers = api_instance.list_recordings_with_http_info(opts)
2623
+ p status_code # => 2xx
2624
+ p headers # => { ... }
2625
+ p data # => <RecordingList>
2626
+ rescue Freeclimb::ApiError => e
2627
+ puts "Error when calling DefaultApi->list_recordings_with_http_info: #{e}"
1835
2628
  end
1836
2629
  ```
1837
2630
 
1838
2631
  ### Parameters
1839
2632
 
2633
+ | Name | Type | Description | Notes |
2634
+ | ---- | ---- | ----------- | ----- |
2635
+
2636
+ | **call_id** | **String** | Show only Recordings made during the Call with this ID. | [optional] |
2637
+
2638
+ | **conference_id** | **String** | Show only Recordings made during the conference with this ID. | [optional] |
2639
+
2640
+ | **date_created** | **String** | Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional] |
1840
2641
 
1841
- Name | Type | Description | Notes
1842
- ------------- | ------------- | ------------- | -------------
1843
- **call_id** | **String**| Show only Recordings made during the Call with this ID. | [optional]
1844
- **conference_id** | **String**| Show only Recordings made during the conference with this ID. | [optional]
1845
- **date_created** | **String**| Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional]
1846
2642
 
1847
2643
  ### Return type
1848
2644
 
@@ -1860,52 +2656,75 @@ Name | Type | Description | Notes
1860
2656
 
1861
2657
  ## list_sms_messages
1862
2658
 
1863
- > MessagesList list_sms_messages(opts)
2659
+ > <MessagesList> list_sms_messages(account_id, opts)
1864
2660
 
1865
2661
  List SMS Messages
1866
2662
 
1867
- ### Example
2663
+ ### Examples
1868
2664
 
1869
2665
  ```ruby
1870
- # load the gem
2666
+ require 'time'
1871
2667
  require 'freeclimb'
1872
2668
  # setup authorization
1873
2669
  Freeclimb.configure do |config|
1874
2670
  # Configure HTTP basic authorization: fc
1875
- config.username = 'ACCOUNT ID'
1876
- config.password = 'API KEY'
2671
+ config.username = 'ACCOUNT_ID'
2672
+ config.password = 'API_KEY'
1877
2673
  end
1878
2674
 
1879
2675
  api_instance = Freeclimb::DefaultApi.new
2676
+
1880
2677
  opts = {
1881
2678
  to: 'to_example', # String | Only show Messages to this phone number.
1882
2679
  from: 'from_example', # String | Only show Messages from this phone number.
1883
2680
  begin_time: 'begin_time_example', # String | Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*.
1884
2681
  end_time: 'end_time_example', # String | Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*..
1885
- direction: 'direction_example', # String | Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb.
1886
- account_id: 'account_id_example' # String | String that uniquely identifies this account resource.
2682
+ direction: 'direction_example' # String | Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb.
1887
2683
  }
1888
2684
 
1889
2685
  begin
1890
- #List SMS Messages
2686
+
2687
+ # List SMS Messages
1891
2688
  result = api_instance.list_sms_messages(opts)
1892
2689
  p result
1893
2690
  rescue Freeclimb::ApiError => e
1894
- puts "Exception when calling DefaultApi->list_sms_messages: #{e}"
2691
+ puts "Error when calling DefaultApi->list_sms_messages: #{e}"
2692
+ end
2693
+ ```
2694
+
2695
+ #### Using the list_sms_messages_with_http_info variant
2696
+
2697
+ This returns an Array which contains the response data, status code and headers.
2698
+
2699
+ > <Array(<MessagesList>, Integer, Hash)> list_sms_messages_with_http_info(account_id, opts)
2700
+
2701
+ ```ruby
2702
+ begin
2703
+ # List SMS Messages
2704
+ data, status_code, headers = api_instance.list_sms_messages_with_http_info(opts)
2705
+ p status_code # => 2xx
2706
+ p headers # => { ... }
2707
+ p data # => <MessagesList>
2708
+ rescue Freeclimb::ApiError => e
2709
+ puts "Error when calling DefaultApi->list_sms_messages_with_http_info: #{e}"
1895
2710
  end
1896
2711
  ```
1897
2712
 
1898
2713
  ### Parameters
1899
2714
 
2715
+ | Name | Type | Description | Notes |
2716
+ | ---- | ---- | ----------- | ----- |
2717
+
2718
+ | **to** | **String** | Only show Messages to this phone number. | [optional] |
2719
+
2720
+ | **from** | **String** | Only show Messages from this phone number. | [optional] |
2721
+
2722
+ | **begin_time** | **String** | Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*. | [optional] |
2723
+
2724
+ | **end_time** | **String** | Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*.. | [optional] |
2725
+
2726
+ | **direction** | **String** | Either &#x60;inbound&#x60; or &#x60;outbound&#x60;. Only show Messages that were either *sent from* or *received by* FreeClimb. | [optional] |
1900
2727
 
1901
- Name | Type | Description | Notes
1902
- ------------- | ------------- | ------------- | -------------
1903
- **to** | **String**| Only show Messages to this phone number. | [optional]
1904
- **from** | **String**| Only show Messages from this phone number. | [optional]
1905
- **begin_time** | **String**| Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*. | [optional]
1906
- **end_time** | **String**| Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*.. | [optional]
1907
- **direction** | **String**| Either &#x60;inbound&#x60; or &#x60;outbound&#x60;. Only show Messages that were either *sent from* or *received by* FreeClimb. | [optional]
1908
- **account_id** | **String**| String that uniquely identifies this account resource. | [optional]
1909
2728
 
1910
2729
  ### Return type
1911
2730
 
@@ -1923,42 +2742,63 @@ Name | Type | Description | Notes
1923
2742
 
1924
2743
  ## make_a_call
1925
2744
 
1926
- > CallResult make_a_call(opts)
2745
+ > <CallResult> make_a_call(account_id, opts)
1927
2746
 
1928
2747
  Make a Call
1929
2748
 
1930
- ### Example
2749
+ ### Examples
1931
2750
 
1932
2751
  ```ruby
1933
- # load the gem
2752
+ require 'time'
1934
2753
  require 'freeclimb'
1935
2754
  # setup authorization
1936
2755
  Freeclimb.configure do |config|
1937
2756
  # Configure HTTP basic authorization: fc
1938
- config.username = 'ACCOUNT ID'
1939
- config.password = 'API KEY'
2757
+ config.username = 'ACCOUNT_ID'
2758
+ config.password = 'API_KEY'
1940
2759
  end
1941
2760
 
1942
2761
  api_instance = Freeclimb::DefaultApi.new
2762
+
1943
2763
  opts = {
1944
- make_call_request: Freeclimb::MakeCallRequest.new # MakeCallRequest | Call details for making a call
2764
+ make_call_request: Freeclimb::MakeCallRequest.new({from: 'from_example', to: 'to_example'}) # MakeCallRequest | Call details for making a call
1945
2765
  }
1946
2766
 
1947
2767
  begin
1948
- #Make a Call
2768
+
2769
+ # Make a Call
1949
2770
  result = api_instance.make_a_call(opts)
1950
2771
  p result
1951
2772
  rescue Freeclimb::ApiError => e
1952
- puts "Exception when calling DefaultApi->make_a_call: #{e}"
2773
+ puts "Error when calling DefaultApi->make_a_call: #{e}"
2774
+ end
2775
+ ```
2776
+
2777
+ #### Using the make_a_call_with_http_info variant
2778
+
2779
+ This returns an Array which contains the response data, status code and headers.
2780
+
2781
+ > <Array(<CallResult>, Integer, Hash)> make_a_call_with_http_info(account_id, opts)
2782
+
2783
+ ```ruby
2784
+ begin
2785
+ # Make a Call
2786
+ data, status_code, headers = api_instance.make_a_call_with_http_info(opts)
2787
+ p status_code # => 2xx
2788
+ p headers # => { ... }
2789
+ p data # => <CallResult>
2790
+ rescue Freeclimb::ApiError => e
2791
+ puts "Error when calling DefaultApi->make_a_call_with_http_info: #{e}"
1953
2792
  end
1954
2793
  ```
1955
2794
 
1956
2795
  ### Parameters
1957
2796
 
2797
+ | Name | Type | Description | Notes |
2798
+ | ---- | ---- | ----------- | ----- |
2799
+
2800
+ | **make_call_request** | [**MakeCallRequest**](MakeCallRequest.md) | Call details for making a call | [optional] |
1958
2801
 
1959
- Name | Type | Description | Notes
1960
- ------------- | ------------- | ------------- | -------------
1961
- **make_call_request** | [**MakeCallRequest**](MakeCallRequest.md)| Call details for making a call | [optional]
1962
2802
 
1963
2803
  ### Return type
1964
2804
 
@@ -1976,41 +2816,65 @@ Name | Type | Description | Notes
1976
2816
 
1977
2817
  ## remove_a_participant
1978
2818
 
1979
- > remove_a_participant(conference_id, call_id)
2819
+ > remove_a_participant(account_id, conference_id, call_id)
1980
2820
 
1981
2821
  Remove a Participant
1982
2822
 
1983
- ### Example
2823
+ ### Examples
1984
2824
 
1985
2825
  ```ruby
1986
- # load the gem
2826
+ require 'time'
1987
2827
  require 'freeclimb'
1988
2828
  # setup authorization
1989
2829
  Freeclimb.configure do |config|
1990
2830
  # Configure HTTP basic authorization: fc
1991
- config.username = 'ACCOUNT ID'
1992
- config.password = 'API KEY'
2831
+ config.username = 'ACCOUNT_ID'
2832
+ config.password = 'API_KEY'
1993
2833
  end
1994
2834
 
1995
2835
  api_instance = Freeclimb::DefaultApi.new
2836
+
1996
2837
  conference_id = 'conference_id_example' # String | ID of the conference this participant is in.
2838
+
1997
2839
  call_id = 'call_id_example' # String | ID of the Call associated with this participant.
1998
2840
 
2841
+
1999
2842
  begin
2000
- #Remove a Participant
2843
+
2844
+ # Remove a Participant
2001
2845
  api_instance.remove_a_participant(conference_id, call_id)
2002
2846
  rescue Freeclimb::ApiError => e
2003
- puts "Exception when calling DefaultApi->remove_a_participant: #{e}"
2847
+ puts "Error when calling DefaultApi->remove_a_participant: #{e}"
2848
+ end
2849
+ ```
2850
+
2851
+ #### Using the remove_a_participant_with_http_info variant
2852
+
2853
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
2854
+
2855
+ > <Array(nil, Integer, Hash)> remove_a_participant_with_http_info(account_id, conference_id, call_id)
2856
+
2857
+ ```ruby
2858
+ begin
2859
+ # Remove a Participant
2860
+ data, status_code, headers = api_instance.remove_a_participant_with_http_info(conference_id, call_id)
2861
+ p status_code # => 2xx
2862
+ p headers # => { ... }
2863
+ p data # => nil
2864
+ rescue Freeclimb::ApiError => e
2865
+ puts "Error when calling DefaultApi->remove_a_participant_with_http_info: #{e}"
2004
2866
  end
2005
2867
  ```
2006
2868
 
2007
2869
  ### Parameters
2008
2870
 
2871
+ | Name | Type | Description | Notes |
2872
+ | ---- | ---- | ----------- | ----- |
2873
+
2874
+ | **conference_id** | **String** | ID of the conference this participant is in. | |
2875
+
2876
+ | **call_id** | **String** | ID of the Call associated with this participant. | |
2009
2877
 
2010
- Name | Type | Description | Notes
2011
- ------------- | ------------- | ------------- | -------------
2012
- **conference_id** | **String**| ID of the conference this participant is in. |
2013
- **call_id** | **String**| ID of the Call associated with this participant. |
2014
2878
 
2015
2879
  ### Return type
2016
2880
 
@@ -2028,40 +2892,62 @@ nil (empty response body)
2028
2892
 
2029
2893
  ## send_an_sms_message
2030
2894
 
2031
- > MessageResult send_an_sms_message(message_request)
2895
+ > <MessageResult> send_an_sms_message(account_id, message_request)
2032
2896
 
2033
2897
  Send an SMS Message
2034
2898
 
2035
- ### Example
2899
+ ### Examples
2036
2900
 
2037
2901
  ```ruby
2038
- # load the gem
2902
+ require 'time'
2039
2903
  require 'freeclimb'
2040
2904
  # setup authorization
2041
2905
  Freeclimb.configure do |config|
2042
2906
  # Configure HTTP basic authorization: fc
2043
- config.username = 'ACCOUNT ID'
2044
- config.password = 'API KEY'
2907
+ config.username = 'ACCOUNT_ID'
2908
+ config.password = 'API_KEY'
2045
2909
  end
2046
2910
 
2047
2911
  api_instance = Freeclimb::DefaultApi.new
2048
- message_request = Freeclimb::MessageRequest.new # MessageRequest | Details to create a message
2912
+
2913
+ message_request = Freeclimb::MessageRequest.new({from: 'from_example', to: 'to_example', text: 'text_example'}) # MessageRequest | Details to create a message
2914
+
2049
2915
 
2050
2916
  begin
2051
- #Send an SMS Message
2917
+
2918
+ # Send an SMS Message
2052
2919
  result = api_instance.send_an_sms_message(message_request)
2053
2920
  p result
2054
2921
  rescue Freeclimb::ApiError => e
2055
- puts "Exception when calling DefaultApi->send_an_sms_message: #{e}"
2922
+ puts "Error when calling DefaultApi->send_an_sms_message: #{e}"
2923
+ end
2924
+ ```
2925
+
2926
+ #### Using the send_an_sms_message_with_http_info variant
2927
+
2928
+ This returns an Array which contains the response data, status code and headers.
2929
+
2930
+ > <Array(<MessageResult>, Integer, Hash)> send_an_sms_message_with_http_info(account_id, message_request)
2931
+
2932
+ ```ruby
2933
+ begin
2934
+ # Send an SMS Message
2935
+ data, status_code, headers = api_instance.send_an_sms_message_with_http_info(message_request)
2936
+ p status_code # => 2xx
2937
+ p headers # => { ... }
2938
+ p data # => <MessageResult>
2939
+ rescue Freeclimb::ApiError => e
2940
+ puts "Error when calling DefaultApi->send_an_sms_message_with_http_info: #{e}"
2056
2941
  end
2057
2942
  ```
2058
2943
 
2059
2944
  ### Parameters
2060
2945
 
2946
+ | Name | Type | Description | Notes |
2947
+ | ---- | ---- | ----------- | ----- |
2948
+
2949
+ | **message_request** | [**MessageRequest**](MessageRequest.md) | Details to create a message | |
2061
2950
 
2062
- Name | Type | Description | Notes
2063
- ------------- | ------------- | ------------- | -------------
2064
- **message_request** | [**MessageRequest**](MessageRequest.md)| Details to create a message |
2065
2951
 
2066
2952
  ### Return type
2067
2953
 
@@ -2079,40 +2965,62 @@ Name | Type | Description | Notes
2079
2965
 
2080
2966
  ## stream_a_recording_file
2081
2967
 
2082
- > File stream_a_recording_file(recording_id)
2968
+ > File stream_a_recording_file(account_id, recording_id)
2083
2969
 
2084
2970
  Stream a Recording File
2085
2971
 
2086
- ### Example
2972
+ ### Examples
2087
2973
 
2088
2974
  ```ruby
2089
- # load the gem
2975
+ require 'time'
2090
2976
  require 'freeclimb'
2091
2977
  # setup authorization
2092
2978
  Freeclimb.configure do |config|
2093
2979
  # Configure HTTP basic authorization: fc
2094
- config.username = 'ACCOUNT ID'
2095
- config.password = 'API KEY'
2980
+ config.username = 'ACCOUNT_ID'
2981
+ config.password = 'API_KEY'
2096
2982
  end
2097
2983
 
2098
2984
  api_instance = Freeclimb::DefaultApi.new
2985
+
2099
2986
  recording_id = 'recording_id_example' # String | String that uniquely identifies this recording resource.
2100
2987
 
2988
+
2101
2989
  begin
2102
- #Stream a Recording File
2990
+
2991
+ # Stream a Recording File
2103
2992
  result = api_instance.stream_a_recording_file(recording_id)
2104
2993
  p result
2105
2994
  rescue Freeclimb::ApiError => e
2106
- puts "Exception when calling DefaultApi->stream_a_recording_file: #{e}"
2995
+ puts "Error when calling DefaultApi->stream_a_recording_file: #{e}"
2996
+ end
2997
+ ```
2998
+
2999
+ #### Using the stream_a_recording_file_with_http_info variant
3000
+
3001
+ This returns an Array which contains the response data, status code and headers.
3002
+
3003
+ > <Array(File, Integer, Hash)> stream_a_recording_file_with_http_info(account_id, recording_id)
3004
+
3005
+ ```ruby
3006
+ begin
3007
+ # Stream a Recording File
3008
+ data, status_code, headers = api_instance.stream_a_recording_file_with_http_info(recording_id)
3009
+ p status_code # => 2xx
3010
+ p headers # => { ... }
3011
+ p data # => File
3012
+ rescue Freeclimb::ApiError => e
3013
+ puts "Error when calling DefaultApi->stream_a_recording_file_with_http_info: #{e}"
2107
3014
  end
2108
3015
  ```
2109
3016
 
2110
3017
  ### Parameters
2111
3018
 
3019
+ | Name | Type | Description | Notes |
3020
+ | ---- | ---- | ----------- | ----- |
3021
+
3022
+ | **recording_id** | **String** | String that uniquely identifies this recording resource. | |
2112
3023
 
2113
- Name | Type | Description | Notes
2114
- ------------- | ------------- | ------------- | -------------
2115
- **recording_id** | **String**| String that uniquely identifies this recording resource. |
2116
3024
 
2117
3025
  ### Return type
2118
3026
 
@@ -2130,44 +3038,67 @@ Name | Type | Description | Notes
2130
3038
 
2131
3039
  ## update_a_conference
2132
3040
 
2133
- > ConferenceResult update_a_conference(conference_id, opts)
3041
+ > <ConferenceResult> update_a_conference(account_id, conference_id, opts)
2134
3042
 
2135
3043
  Update a Conference
2136
3044
 
2137
- ### Example
3045
+ ### Examples
2138
3046
 
2139
3047
  ```ruby
2140
- # load the gem
3048
+ require 'time'
2141
3049
  require 'freeclimb'
2142
3050
  # setup authorization
2143
3051
  Freeclimb.configure do |config|
2144
3052
  # Configure HTTP basic authorization: fc
2145
- config.username = 'ACCOUNT ID'
2146
- config.password = 'API KEY'
3053
+ config.username = 'ACCOUNT_ID'
3054
+ config.password = 'API_KEY'
2147
3055
  end
2148
3056
 
2149
3057
  api_instance = Freeclimb::DefaultApi.new
3058
+
2150
3059
  conference_id = 'conference_id_example' # String | String that uniquely identifies this conference resource.
3060
+
2151
3061
  opts = {
2152
3062
  update_conference_request: Freeclimb::UpdateConferenceRequest.new # UpdateConferenceRequest | Conference Details to update
2153
3063
  }
2154
3064
 
2155
3065
  begin
2156
- #Update a Conference
3066
+
3067
+ # Update a Conference
2157
3068
  result = api_instance.update_a_conference(conference_id, opts)
2158
3069
  p result
2159
3070
  rescue Freeclimb::ApiError => e
2160
- puts "Exception when calling DefaultApi->update_a_conference: #{e}"
3071
+ puts "Error when calling DefaultApi->update_a_conference: #{e}"
3072
+ end
3073
+ ```
3074
+
3075
+ #### Using the update_a_conference_with_http_info variant
3076
+
3077
+ This returns an Array which contains the response data, status code and headers.
3078
+
3079
+ > <Array(<ConferenceResult>, Integer, Hash)> update_a_conference_with_http_info(account_id, conference_id, opts)
3080
+
3081
+ ```ruby
3082
+ begin
3083
+ # Update a Conference
3084
+ data, status_code, headers = api_instance.update_a_conference_with_http_info(conference_id, opts)
3085
+ p status_code # => 2xx
3086
+ p headers # => { ... }
3087
+ p data # => <ConferenceResult>
3088
+ rescue Freeclimb::ApiError => e
3089
+ puts "Error when calling DefaultApi->update_a_conference_with_http_info: #{e}"
2161
3090
  end
2162
3091
  ```
2163
3092
 
2164
3093
  ### Parameters
2165
3094
 
3095
+ | Name | Type | Description | Notes |
3096
+ | ---- | ---- | ----------- | ----- |
3097
+
3098
+ | **conference_id** | **String** | String that uniquely identifies this conference resource. | |
3099
+
3100
+ | **update_conference_request** | [**UpdateConferenceRequest**](UpdateConferenceRequest.md) | Conference Details to update | [optional] |
2166
3101
 
2167
- Name | Type | Description | Notes
2168
- ------------- | ------------- | ------------- | -------------
2169
- **conference_id** | **String**| String that uniquely identifies this conference resource. |
2170
- **update_conference_request** | [**UpdateConferenceRequest**](UpdateConferenceRequest.md)| Conference Details to update | [optional]
2171
3102
 
2172
3103
  ### Return type
2173
3104
 
@@ -2185,41 +3116,65 @@ Name | Type | Description | Notes
2185
3116
 
2186
3117
  ## update_a_live_call
2187
3118
 
2188
- > update_a_live_call(call_id, update_call_request)
3119
+ > update_a_live_call(account_id, call_id, update_call_request)
2189
3120
 
2190
3121
  Update a Live Call
2191
3122
 
2192
- ### Example
3123
+ ### Examples
2193
3124
 
2194
3125
  ```ruby
2195
- # load the gem
3126
+ require 'time'
2196
3127
  require 'freeclimb'
2197
3128
  # setup authorization
2198
3129
  Freeclimb.configure do |config|
2199
3130
  # Configure HTTP basic authorization: fc
2200
- config.username = 'ACCOUNT ID'
2201
- config.password = 'API KEY'
3131
+ config.username = 'ACCOUNT_ID'
3132
+ config.password = 'API_KEY'
2202
3133
  end
2203
3134
 
2204
3135
  api_instance = Freeclimb::DefaultApi.new
3136
+
2205
3137
  call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
2206
- update_call_request = Freeclimb::UpdateCallRequest.new # UpdateCallRequest | Call details to update
3138
+
3139
+ update_call_request = Freeclimb::UpdateCallRequest.new({status: 'canceled'}) # UpdateCallRequest | Call details to update
3140
+
2207
3141
 
2208
3142
  begin
2209
- #Update a Live Call
3143
+
3144
+ # Update a Live Call
2210
3145
  api_instance.update_a_live_call(call_id, update_call_request)
2211
3146
  rescue Freeclimb::ApiError => e
2212
- puts "Exception when calling DefaultApi->update_a_live_call: #{e}"
3147
+ puts "Error when calling DefaultApi->update_a_live_call: #{e}"
3148
+ end
3149
+ ```
3150
+
3151
+ #### Using the update_a_live_call_with_http_info variant
3152
+
3153
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
3154
+
3155
+ > <Array(nil, Integer, Hash)> update_a_live_call_with_http_info(account_id, call_id, update_call_request)
3156
+
3157
+ ```ruby
3158
+ begin
3159
+ # Update a Live Call
3160
+ data, status_code, headers = api_instance.update_a_live_call_with_http_info(call_id, update_call_request)
3161
+ p status_code # => 2xx
3162
+ p headers # => { ... }
3163
+ p data # => nil
3164
+ rescue Freeclimb::ApiError => e
3165
+ puts "Error when calling DefaultApi->update_a_live_call_with_http_info: #{e}"
2213
3166
  end
2214
3167
  ```
2215
3168
 
2216
3169
  ### Parameters
2217
3170
 
3171
+ | Name | Type | Description | Notes |
3172
+ | ---- | ---- | ----------- | ----- |
3173
+
3174
+ | **call_id** | **String** | String that uniquely identifies this call resource. | |
3175
+
3176
+ | **update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md) | Call details to update | |
2218
3177
 
2219
- Name | Type | Description | Notes
2220
- ------------- | ------------- | ------------- | -------------
2221
- **call_id** | **String**| String that uniquely identifies this call resource. |
2222
- **update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md)| Call details to update |
2223
3178
 
2224
3179
  ### Return type
2225
3180
 
@@ -2237,46 +3192,71 @@ nil (empty response body)
2237
3192
 
2238
3193
  ## update_a_participant
2239
3194
 
2240
- > ConferenceParticipantResult update_a_participant(conference_id, call_id, opts)
3195
+ > <ConferenceParticipantResult> update_a_participant(account_id, conference_id, call_id, opts)
2241
3196
 
2242
3197
  Update a Participant
2243
3198
 
2244
- ### Example
3199
+ ### Examples
2245
3200
 
2246
3201
  ```ruby
2247
- # load the gem
3202
+ require 'time'
2248
3203
  require 'freeclimb'
2249
3204
  # setup authorization
2250
3205
  Freeclimb.configure do |config|
2251
3206
  # Configure HTTP basic authorization: fc
2252
- config.username = 'ACCOUNT ID'
2253
- config.password = 'API KEY'
3207
+ config.username = 'ACCOUNT_ID'
3208
+ config.password = 'API_KEY'
2254
3209
  end
2255
3210
 
2256
3211
  api_instance = Freeclimb::DefaultApi.new
3212
+
2257
3213
  conference_id = 'conference_id_example' # String | ID of the conference this participant is in.
3214
+
2258
3215
  call_id = 'call_id_example' # String | ID of the Call associated with this participant.
3216
+
2259
3217
  opts = {
2260
3218
  update_conference_participant_request: Freeclimb::UpdateConferenceParticipantRequest.new # UpdateConferenceParticipantRequest | Conference participant details to update
2261
3219
  }
2262
3220
 
2263
3221
  begin
2264
- #Update a Participant
3222
+
3223
+ # Update a Participant
2265
3224
  result = api_instance.update_a_participant(conference_id, call_id, opts)
2266
3225
  p result
2267
3226
  rescue Freeclimb::ApiError => e
2268
- puts "Exception when calling DefaultApi->update_a_participant: #{e}"
3227
+ puts "Error when calling DefaultApi->update_a_participant: #{e}"
3228
+ end
3229
+ ```
3230
+
3231
+ #### Using the update_a_participant_with_http_info variant
3232
+
3233
+ This returns an Array which contains the response data, status code and headers.
3234
+
3235
+ > <Array(<ConferenceParticipantResult>, Integer, Hash)> update_a_participant_with_http_info(account_id, conference_id, call_id, opts)
3236
+
3237
+ ```ruby
3238
+ begin
3239
+ # Update a Participant
3240
+ data, status_code, headers = api_instance.update_a_participant_with_http_info(conference_id, call_id, opts)
3241
+ p status_code # => 2xx
3242
+ p headers # => { ... }
3243
+ p data # => <ConferenceParticipantResult>
3244
+ rescue Freeclimb::ApiError => e
3245
+ puts "Error when calling DefaultApi->update_a_participant_with_http_info: #{e}"
2269
3246
  end
2270
3247
  ```
2271
3248
 
2272
3249
  ### Parameters
2273
3250
 
3251
+ | Name | Type | Description | Notes |
3252
+ | ---- | ---- | ----------- | ----- |
3253
+
3254
+ | **conference_id** | **String** | ID of the conference this participant is in. | |
3255
+
3256
+ | **call_id** | **String** | ID of the Call associated with this participant. | |
3257
+
3258
+ | **update_conference_participant_request** | [**UpdateConferenceParticipantRequest**](UpdateConferenceParticipantRequest.md) | Conference participant details to update | [optional] |
2274
3259
 
2275
- Name | Type | Description | Notes
2276
- ------------- | ------------- | ------------- | -------------
2277
- **conference_id** | **String**| ID of the conference this participant is in. |
2278
- **call_id** | **String**| ID of the Call associated with this participant. |
2279
- **update_conference_participant_request** | [**UpdateConferenceParticipantRequest**](UpdateConferenceParticipantRequest.md)| Conference participant details to update | [optional]
2280
3260
 
2281
3261
  ### Return type
2282
3262
 
@@ -2294,44 +3274,67 @@ Name | Type | Description | Notes
2294
3274
 
2295
3275
  ## update_a_queue
2296
3276
 
2297
- > QueueResult update_a_queue(queue_id, opts)
3277
+ > <QueueResult> update_a_queue(account_id, queue_id, opts)
2298
3278
 
2299
3279
  Update a Queue
2300
3280
 
2301
- ### Example
3281
+ ### Examples
2302
3282
 
2303
3283
  ```ruby
2304
- # load the gem
3284
+ require 'time'
2305
3285
  require 'freeclimb'
2306
3286
  # setup authorization
2307
3287
  Freeclimb.configure do |config|
2308
3288
  # Configure HTTP basic authorization: fc
2309
- config.username = 'ACCOUNT ID'
2310
- config.password = 'API KEY'
3289
+ config.username = 'ACCOUNT_ID'
3290
+ config.password = 'API_KEY'
2311
3291
  end
2312
3292
 
2313
3293
  api_instance = Freeclimb::DefaultApi.new
3294
+
2314
3295
  queue_id = 'queue_id_example' # String | A string that uniquely identifies this Queue resource.
3296
+
2315
3297
  opts = {
2316
3298
  queue_request: Freeclimb::QueueRequest.new # QueueRequest | Queue Details to update
2317
3299
  }
2318
3300
 
2319
3301
  begin
2320
- #Update a Queue
3302
+
3303
+ # Update a Queue
2321
3304
  result = api_instance.update_a_queue(queue_id, opts)
2322
3305
  p result
2323
3306
  rescue Freeclimb::ApiError => e
2324
- puts "Exception when calling DefaultApi->update_a_queue: #{e}"
3307
+ puts "Error when calling DefaultApi->update_a_queue: #{e}"
3308
+ end
3309
+ ```
3310
+
3311
+ #### Using the update_a_queue_with_http_info variant
3312
+
3313
+ This returns an Array which contains the response data, status code and headers.
3314
+
3315
+ > <Array(<QueueResult>, Integer, Hash)> update_a_queue_with_http_info(account_id, queue_id, opts)
3316
+
3317
+ ```ruby
3318
+ begin
3319
+ # Update a Queue
3320
+ data, status_code, headers = api_instance.update_a_queue_with_http_info(queue_id, opts)
3321
+ p status_code # => 2xx
3322
+ p headers # => { ... }
3323
+ p data # => <QueueResult>
3324
+ rescue Freeclimb::ApiError => e
3325
+ puts "Error when calling DefaultApi->update_a_queue_with_http_info: #{e}"
2325
3326
  end
2326
3327
  ```
2327
3328
 
2328
3329
  ### Parameters
2329
3330
 
3331
+ | Name | Type | Description | Notes |
3332
+ | ---- | ---- | ----------- | ----- |
3333
+
3334
+ | **queue_id** | **String** | A string that uniquely identifies this Queue resource. | |
3335
+
3336
+ | **queue_request** | [**QueueRequest**](QueueRequest.md) | Queue Details to update | [optional] |
2330
3337
 
2331
- Name | Type | Description | Notes
2332
- ------------- | ------------- | ------------- | -------------
2333
- **queue_id** | **String**| A string that uniquely identifies this Queue resource. |
2334
- **queue_request** | [**QueueRequest**](QueueRequest.md)| Queue Details to update | [optional]
2335
3338
 
2336
3339
  ### Return type
2337
3340
 
@@ -2349,41 +3352,62 @@ Name | Type | Description | Notes
2349
3352
 
2350
3353
  ## update_an_account
2351
3354
 
2352
- > update_an_account(opts)
3355
+ > update_an_account(account_id, opts)
2353
3356
 
2354
3357
  Manage an account
2355
3358
 
2356
- ### Example
3359
+ ### Examples
2357
3360
 
2358
3361
  ```ruby
2359
- # load the gem
3362
+ require 'time'
2360
3363
  require 'freeclimb'
2361
3364
  # setup authorization
2362
3365
  Freeclimb.configure do |config|
2363
3366
  # Configure HTTP basic authorization: fc
2364
- config.username = 'ACCOUNT ID'
2365
- config.password = 'API KEY'
3367
+ config.username = 'ACCOUNT_ID'
3368
+ config.password = 'API_KEY'
2366
3369
  end
2367
3370
 
2368
3371
  api_instance = Freeclimb::DefaultApi.new
3372
+
2369
3373
  opts = {
2370
3374
  account_request: Freeclimb::AccountRequest.new # AccountRequest | Account details to update
2371
3375
  }
2372
3376
 
2373
3377
  begin
2374
- #Manage an account
3378
+
3379
+ # Manage an account
2375
3380
  api_instance.update_an_account(opts)
2376
3381
  rescue Freeclimb::ApiError => e
2377
- puts "Exception when calling DefaultApi->update_an_account: #{e}"
3382
+ puts "Error when calling DefaultApi->update_an_account: #{e}"
3383
+ end
3384
+ ```
3385
+
3386
+ #### Using the update_an_account_with_http_info variant
3387
+
3388
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
3389
+
3390
+ > <Array(nil, Integer, Hash)> update_an_account_with_http_info(account_id, opts)
3391
+
3392
+ ```ruby
3393
+ begin
3394
+ # Manage an account
3395
+ data, status_code, headers = api_instance.update_an_account_with_http_info(opts)
3396
+ p status_code # => 2xx
3397
+ p headers # => { ... }
3398
+ p data # => nil
3399
+ rescue Freeclimb::ApiError => e
3400
+ puts "Error when calling DefaultApi->update_an_account_with_http_info: #{e}"
2378
3401
  end
2379
3402
  ```
2380
3403
 
2381
3404
  ### Parameters
2382
3405
 
3406
+ | Name | Type | Description | Notes |
3407
+ | ---- | ---- | ----------- | ----- |
3408
+
3409
+ | **account_request** | [**AccountRequest**](AccountRequest.md) | Account details to update | [optional] |
2383
3410
 
2384
- Name | Type | Description | Notes
2385
- ------------- | ------------- | ------------- | -------------
2386
- **account_request** | [**AccountRequest**](AccountRequest.md)| Account details to update | [optional]
2387
3411
 
2388
3412
  ### Return type
2389
3413
 
@@ -2401,44 +3425,67 @@ nil (empty response body)
2401
3425
 
2402
3426
  ## update_an_application
2403
3427
 
2404
- > ApplicationResult update_an_application(application_id, opts)
3428
+ > <ApplicationResult> update_an_application(account_id, application_id, opts)
2405
3429
 
2406
3430
  Update an application
2407
3431
 
2408
- ### Example
3432
+ ### Examples
2409
3433
 
2410
3434
  ```ruby
2411
- # load the gem
3435
+ require 'time'
2412
3436
  require 'freeclimb'
2413
3437
  # setup authorization
2414
3438
  Freeclimb.configure do |config|
2415
3439
  # Configure HTTP basic authorization: fc
2416
- config.username = 'ACCOUNT ID'
2417
- config.password = 'API KEY'
3440
+ config.username = 'ACCOUNT_ID'
3441
+ config.password = 'API_KEY'
2418
3442
  end
2419
3443
 
2420
3444
  api_instance = Freeclimb::DefaultApi.new
3445
+
2421
3446
  application_id = 'application_id_example' # String | A string that uniquely identifies this application resource.
3447
+
2422
3448
  opts = {
2423
3449
  application_request: Freeclimb::ApplicationRequest.new # ApplicationRequest | Application details to update.
2424
3450
  }
2425
3451
 
2426
3452
  begin
2427
- #Update an application
3453
+
3454
+ # Update an application
2428
3455
  result = api_instance.update_an_application(application_id, opts)
2429
3456
  p result
2430
3457
  rescue Freeclimb::ApiError => e
2431
- puts "Exception when calling DefaultApi->update_an_application: #{e}"
3458
+ puts "Error when calling DefaultApi->update_an_application: #{e}"
3459
+ end
3460
+ ```
3461
+
3462
+ #### Using the update_an_application_with_http_info variant
3463
+
3464
+ This returns an Array which contains the response data, status code and headers.
3465
+
3466
+ > <Array(<ApplicationResult>, Integer, Hash)> update_an_application_with_http_info(account_id, application_id, opts)
3467
+
3468
+ ```ruby
3469
+ begin
3470
+ # Update an application
3471
+ data, status_code, headers = api_instance.update_an_application_with_http_info(application_id, opts)
3472
+ p status_code # => 2xx
3473
+ p headers # => { ... }
3474
+ p data # => <ApplicationResult>
3475
+ rescue Freeclimb::ApiError => e
3476
+ puts "Error when calling DefaultApi->update_an_application_with_http_info: #{e}"
2432
3477
  end
2433
3478
  ```
2434
3479
 
2435
3480
  ### Parameters
2436
3481
 
3482
+ | Name | Type | Description | Notes |
3483
+ | ---- | ---- | ----------- | ----- |
3484
+
3485
+ | **application_id** | **String** | A string that uniquely identifies this application resource. | |
3486
+
3487
+ | **application_request** | [**ApplicationRequest**](ApplicationRequest.md) | Application details to update. | [optional] |
2437
3488
 
2438
- Name | Type | Description | Notes
2439
- ------------- | ------------- | ------------- | -------------
2440
- **application_id** | **String**| A string that uniquely identifies this application resource. |
2441
- **application_request** | [**ApplicationRequest**](ApplicationRequest.md)| Application details to update. | [optional]
2442
3489
 
2443
3490
  ### Return type
2444
3491
 
@@ -2456,44 +3503,67 @@ Name | Type | Description | Notes
2456
3503
 
2457
3504
  ## update_an_incoming_number
2458
3505
 
2459
- > IncomingNumberResult update_an_incoming_number(phone_number_id, opts)
3506
+ > <IncomingNumberResult> update_an_incoming_number(account_id, phone_number_id, opts)
2460
3507
 
2461
3508
  Update an Incoming Number
2462
3509
 
2463
- ### Example
3510
+ ### Examples
2464
3511
 
2465
3512
  ```ruby
2466
- # load the gem
3513
+ require 'time'
2467
3514
  require 'freeclimb'
2468
3515
  # setup authorization
2469
3516
  Freeclimb.configure do |config|
2470
3517
  # Configure HTTP basic authorization: fc
2471
- config.username = 'ACCOUNT ID'
2472
- config.password = 'API KEY'
3518
+ config.username = 'ACCOUNT_ID'
3519
+ config.password = 'API_KEY'
2473
3520
  end
2474
3521
 
2475
3522
  api_instance = Freeclimb::DefaultApi.new
3523
+
2476
3524
  phone_number_id = 'phone_number_id_example' # String | String that uniquely identifies this phone number resource.
3525
+
2477
3526
  opts = {
2478
3527
  incoming_number_request: Freeclimb::IncomingNumberRequest.new # IncomingNumberRequest | Incoming Number details to update
2479
3528
  }
2480
3529
 
2481
3530
  begin
2482
- #Update an Incoming Number
3531
+
3532
+ # Update an Incoming Number
2483
3533
  result = api_instance.update_an_incoming_number(phone_number_id, opts)
2484
3534
  p result
2485
3535
  rescue Freeclimb::ApiError => e
2486
- puts "Exception when calling DefaultApi->update_an_incoming_number: #{e}"
3536
+ puts "Error when calling DefaultApi->update_an_incoming_number: #{e}"
3537
+ end
3538
+ ```
3539
+
3540
+ #### Using the update_an_incoming_number_with_http_info variant
3541
+
3542
+ This returns an Array which contains the response data, status code and headers.
3543
+
3544
+ > <Array(<IncomingNumberResult>, Integer, Hash)> update_an_incoming_number_with_http_info(account_id, phone_number_id, opts)
3545
+
3546
+ ```ruby
3547
+ begin
3548
+ # Update an Incoming Number
3549
+ data, status_code, headers = api_instance.update_an_incoming_number_with_http_info(phone_number_id, opts)
3550
+ p status_code # => 2xx
3551
+ p headers # => { ... }
3552
+ p data # => <IncomingNumberResult>
3553
+ rescue Freeclimb::ApiError => e
3554
+ puts "Error when calling DefaultApi->update_an_incoming_number_with_http_info: #{e}"
2487
3555
  end
2488
3556
  ```
2489
3557
 
2490
3558
  ### Parameters
2491
3559
 
3560
+ | Name | Type | Description | Notes |
3561
+ | ---- | ---- | ----------- | ----- |
3562
+
3563
+ | **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | |
3564
+
3565
+ | **incoming_number_request** | [**IncomingNumberRequest**](IncomingNumberRequest.md) | Incoming Number details to update | [optional] |
2492
3566
 
2493
- Name | Type | Description | Notes
2494
- ------------- | ------------- | ------------- | -------------
2495
- **phone_number_id** | **String**| String that uniquely identifies this phone number resource. |
2496
- **incoming_number_request** | [**IncomingNumberRequest**](IncomingNumberRequest.md)| Incoming Number details to update | [optional]
2497
3567
 
2498
3568
  ### Return type
2499
3569