freeclimb 3.0.1 → 4.0.0

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