freeclimb 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (195) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +10 -0
  3. data/Gemfile.lock +82 -0
  4. data/README.md +238 -0
  5. data/Rakefile +10 -0
  6. data/docs/AccountRequest.md +21 -0
  7. data/docs/AccountResult.md +37 -0
  8. data/docs/AccountResultAllOf.md +29 -0
  9. data/docs/ApplicationList.md +31 -0
  10. data/docs/ApplicationListAllOf.md +17 -0
  11. data/docs/ApplicationRequest.md +31 -0
  12. data/docs/ApplicationResult.md +41 -0
  13. data/docs/ApplicationResultAllOf.md +33 -0
  14. data/docs/AvailableNumber.md +27 -0
  15. data/docs/AvailableNumberList.md +31 -0
  16. data/docs/AvailableNumberListAllOf.md +17 -0
  17. data/docs/BuyIncomingNumberRequest.md +23 -0
  18. data/docs/CallList.md +31 -0
  19. data/docs/CallListAllOf.md +17 -0
  20. data/docs/CallResult.md +53 -0
  21. data/docs/CallResultAllOf.md +45 -0
  22. data/docs/ConferenceList.md +31 -0
  23. data/docs/ConferenceListAllOf.md +17 -0
  24. data/docs/ConferenceParticipantList.md +31 -0
  25. data/docs/ConferenceParticipantListAllOf.md +17 -0
  26. data/docs/ConferenceParticipantResult.md +35 -0
  27. data/docs/ConferenceParticipantResultAllOf.md +27 -0
  28. data/docs/ConferenceResult.md +43 -0
  29. data/docs/ConferenceResultAllOf.md +35 -0
  30. data/docs/CreateConferenceRequest.md +27 -0
  31. data/docs/DefaultApi.md +2504 -0
  32. data/docs/DequeueMemberRequest.md +17 -0
  33. data/docs/FilterLogsRequest.md +19 -0
  34. data/docs/IncomingNumberList.md +31 -0
  35. data/docs/IncomingNumberListAllOf.md +17 -0
  36. data/docs/IncomingNumberRequest.md +21 -0
  37. data/docs/IncomingNumberResult.md +41 -0
  38. data/docs/IncomingNumberResultAllOf.md +33 -0
  39. data/docs/LogList.md +31 -0
  40. data/docs/LogListAllOf.md +17 -0
  41. data/docs/LogResult.md +29 -0
  42. data/docs/MakeCallRequest.md +33 -0
  43. data/docs/MessageRequest.md +35 -0
  44. data/docs/MessageRequestAllOf.md +27 -0
  45. data/docs/MessageResult.md +39 -0
  46. data/docs/MessageResultAllOf.md +31 -0
  47. data/docs/MessagesList.md +31 -0
  48. data/docs/MessagesListAllOf.md +17 -0
  49. data/docs/MutableResourceModel.md +23 -0
  50. data/docs/PaginationModel.md +29 -0
  51. data/docs/Percl.md +697 -0
  52. data/docs/QueueList.md +31 -0
  53. data/docs/QueueListAllOf.md +17 -0
  54. data/docs/QueueMember.md +25 -0
  55. data/docs/QueueMemberList.md +31 -0
  56. data/docs/QueueMemberListAllOf.md +17 -0
  57. data/docs/QueueRequest.md +21 -0
  58. data/docs/QueueResult.md +37 -0
  59. data/docs/QueueResultAllOf.md +29 -0
  60. data/docs/RecordingList.md +31 -0
  61. data/docs/RecordingListAllOf.md +17 -0
  62. data/docs/RecordingResult.md +33 -0
  63. data/docs/RecordingResultAllOf.md +25 -0
  64. data/docs/UpdateCallRequest.md +19 -0
  65. data/docs/UpdateConferenceParticipantRequest.md +21 -0
  66. data/docs/UpdateConferenceRequest.md +23 -0
  67. data/freeclimb.gemspec +39 -0
  68. data/git_push.sh +58 -0
  69. data/lib/freeclimb.rb +99 -0
  70. data/lib/freeclimb/api/default_api.rb +2845 -0
  71. data/lib/freeclimb/api_client.rb +386 -0
  72. data/lib/freeclimb/api_error.rb +57 -0
  73. data/lib/freeclimb/configuration.rb +248 -0
  74. data/lib/freeclimb/models/account_request.rb +227 -0
  75. data/lib/freeclimb/models/account_result.rb +349 -0
  76. data/lib/freeclimb/models/account_result_all_of.rb +301 -0
  77. data/lib/freeclimb/models/application_list.rb +286 -0
  78. data/lib/freeclimb/models/application_list_all_of.rb +208 -0
  79. data/lib/freeclimb/models/application_request.rb +277 -0
  80. data/lib/freeclimb/models/application_result.rb +335 -0
  81. data/lib/freeclimb/models/application_result_all_of.rb +287 -0
  82. data/lib/freeclimb/models/available_number.rb +257 -0
  83. data/lib/freeclimb/models/available_number_list.rb +286 -0
  84. data/lib/freeclimb/models/available_number_list_all_of.rb +208 -0
  85. data/lib/freeclimb/models/buy_incoming_number_request.rb +242 -0
  86. data/lib/freeclimb/models/call_list.rb +286 -0
  87. data/lib/freeclimb/models/call_list_all_of.rb +208 -0
  88. data/lib/freeclimb/models/call_result.rb +429 -0
  89. data/lib/freeclimb/models/call_result_all_of.rb +381 -0
  90. data/lib/freeclimb/models/conference_list.rb +286 -0
  91. data/lib/freeclimb/models/conference_list_all_of.rb +208 -0
  92. data/lib/freeclimb/models/conference_participant_list.rb +286 -0
  93. data/lib/freeclimb/models/conference_participant_list_all_of.rb +208 -0
  94. data/lib/freeclimb/models/conference_participant_result.rb +305 -0
  95. data/lib/freeclimb/models/conference_participant_result_all_of.rb +257 -0
  96. data/lib/freeclimb/models/conference_result.rb +391 -0
  97. data/lib/freeclimb/models/conference_result_all_of.rb +343 -0
  98. data/lib/freeclimb/models/create_conference_request.rb +293 -0
  99. data/lib/freeclimb/models/dequeue_member_request.rb +207 -0
  100. data/lib/freeclimb/models/filter_logs_request.rb +222 -0
  101. data/lib/freeclimb/models/incoming_number_list.rb +286 -0
  102. data/lib/freeclimb/models/incoming_number_list_all_of.rb +208 -0
  103. data/lib/freeclimb/models/incoming_number_request.rb +227 -0
  104. data/lib/freeclimb/models/incoming_number_result.rb +335 -0
  105. data/lib/freeclimb/models/incoming_number_result_all_of.rb +287 -0
  106. data/lib/freeclimb/models/log_list.rb +286 -0
  107. data/lib/freeclimb/models/log_list_all_of.rb +208 -0
  108. data/lib/freeclimb/models/log_result.rb +301 -0
  109. data/lib/freeclimb/models/make_call_request.rb +302 -0
  110. data/lib/freeclimb/models/message_request.rb +320 -0
  111. data/lib/freeclimb/models/message_request_all_of.rb +272 -0
  112. data/lib/freeclimb/models/message_result.rb +359 -0
  113. data/lib/freeclimb/models/message_result_all_of.rb +311 -0
  114. data/lib/freeclimb/models/messages_list.rb +287 -0
  115. data/lib/freeclimb/models/messages_list_all_of.rb +209 -0
  116. data/lib/freeclimb/models/mutable_resource_model.rb +237 -0
  117. data/lib/freeclimb/models/pagination_model.rb +267 -0
  118. data/lib/freeclimb/models/queue_list.rb +286 -0
  119. data/lib/freeclimb/models/queue_list_all_of.rb +208 -0
  120. data/lib/freeclimb/models/queue_member.rb +247 -0
  121. data/lib/freeclimb/models/queue_member_list.rb +286 -0
  122. data/lib/freeclimb/models/queue_member_list_all_of.rb +208 -0
  123. data/lib/freeclimb/models/queue_request.rb +227 -0
  124. data/lib/freeclimb/models/queue_result.rb +315 -0
  125. data/lib/freeclimb/models/queue_result_all_of.rb +267 -0
  126. data/lib/freeclimb/models/recording_list.rb +286 -0
  127. data/lib/freeclimb/models/recording_list_all_of.rb +208 -0
  128. data/lib/freeclimb/models/recording_result.rb +295 -0
  129. data/lib/freeclimb/models/recording_result_all_of.rb +247 -0
  130. data/lib/freeclimb/models/update_call_request.rb +256 -0
  131. data/lib/freeclimb/models/update_conference_participant_request.rb +227 -0
  132. data/lib/freeclimb/models/update_conference_request.rb +273 -0
  133. data/lib/freeclimb/version.rb +15 -0
  134. data/lib/percl/calls.rb +43 -0
  135. data/lib/percl/conference_participants.rb +40 -0
  136. data/lib/percl/conferences.rb +21 -0
  137. data/lib/percl/ivr.rb +63 -0
  138. data/lib/percl/jsonable.rb +23 -0
  139. data/lib/percl/percl.rb +29 -0
  140. data/lib/percl/queue_members.rb +15 -0
  141. data/lib/percl/recordings.rb +15 -0
  142. data/lib/percl/sms.rb +11 -0
  143. data/spec/api/default_api_spec.rb +1151 -0
  144. data/spec/api/web_mocks.rb +473 -0
  145. data/spec/api_client_spec.rb +226 -0
  146. data/spec/configuration_spec.rb +34 -0
  147. data/spec/models/account_request_spec.rb +33 -0
  148. data/spec/models/account_result_spec.rb +33 -0
  149. data/spec/models/application_list_spec.rb +33 -0
  150. data/spec/models/application_request_spec.rb +33 -0
  151. data/spec/models/application_result_spec.rb +33 -0
  152. data/spec/models/available_number_list_spec.rb +34 -0
  153. data/spec/models/available_number_spec.rb +33 -0
  154. data/spec/models/buy_incoming_number_request_spec.rb +33 -0
  155. data/spec/models/call_list_spec.rb +34 -0
  156. data/spec/models/call_result_spec.rb +34 -0
  157. data/spec/models/conference_list_spec.rb +33 -0
  158. data/spec/models/conference_participant_list_spec.rb +33 -0
  159. data/spec/models/conference_participant_result_spec.rb +33 -0
  160. data/spec/models/conference_result_spec.rb +34 -0
  161. data/spec/models/create_conference_request_spec.rb +34 -0
  162. data/spec/models/dequeue_member_request_spec.rb +34 -0
  163. data/spec/models/filter_logs_request_spec.rb +33 -0
  164. data/spec/models/incoming_number_list_spec.rb +34 -0
  165. data/spec/models/incoming_number_request_spec.rb +33 -0
  166. data/spec/models/incoming_number_result_spec.rb +34 -0
  167. data/spec/models/log_list_spec.rb +33 -0
  168. data/spec/models/log_result_spec.rb +33 -0
  169. data/spec/models/make_call_request_spec.rb +33 -0
  170. data/spec/models/message_request_spec.rb +34 -0
  171. data/spec/models/message_result_spec.rb +33 -0
  172. data/spec/models/messages_list_spec.rb +33 -0
  173. data/spec/models/mutable_resource_model_spec.rb +34 -0
  174. data/spec/models/pagination_model_spec.rb +33 -0
  175. data/spec/models/queue_list_spec.rb +34 -0
  176. data/spec/models/queue_member_list_spec.rb +33 -0
  177. data/spec/models/queue_member_spec.rb +34 -0
  178. data/spec/models/queue_request_spec.rb +34 -0
  179. data/spec/models/queue_result_spec.rb +33 -0
  180. data/spec/models/recording_list_spec.rb +33 -0
  181. data/spec/models/recording_result_spec.rb +33 -0
  182. data/spec/models/update_call_request_spec.rb +33 -0
  183. data/spec/models/update_conference_participant_request_spec.rb +33 -0
  184. data/spec/models/update_conference_request_spec.rb +33 -0
  185. data/spec/percl/calls_spec.rb +111 -0
  186. data/spec/percl/conference_participant_spec.rb +96 -0
  187. data/spec/percl/conference_spec.rb +46 -0
  188. data/spec/percl/ivr_spec.rb +155 -0
  189. data/spec/percl/jsonable_spec.rb +28 -0
  190. data/spec/percl/percl_spec.rb +31 -0
  191. data/spec/percl/queue_members_spec.rb +35 -0
  192. data/spec/percl/recordings_spec.rb +32 -0
  193. data/spec/percl/sms_spec.rb +29 -0
  194. data/spec/spec_helper.rb +114 -0
  195. metadata +355 -0
@@ -0,0 +1,17 @@
1
+ # Freeclimb::ConferenceParticipantListAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) | | [optional]
8
+
9
+ ## Code Sample
10
+
11
+ ```ruby
12
+ require 'Freeclimb'
13
+
14
+ instance = Freeclimb::ConferenceParticipantListAllOf.new(participants: null)
15
+ ```
16
+
17
+
@@ -0,0 +1,35 @@
1
+ # Freeclimb::ConferenceParticipantResult
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
8
+ **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
9
+ **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
+ **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
+ **account_id** | **String** | ID of the account that created this participant. | [optional]
12
+ **conference_id** | **String** | ID of the conference this participant is in. | [optional]
13
+ **call_id** | **String** | ID of the Call associated with this Participant. | [optional]
14
+ **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional]
15
+ **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional]
16
+ **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional]
17
+
18
+ ## Code Sample
19
+
20
+ ```ruby
21
+ require 'Freeclimb'
22
+
23
+ instance = Freeclimb::ConferenceParticipantResult.new(uri: null,
24
+ date_created: null,
25
+ date_updated: null,
26
+ revision: null,
27
+ account_id: null,
28
+ conference_id: null,
29
+ call_id: null,
30
+ talk: null,
31
+ listen: null,
32
+ start_conf_on_enter: null)
33
+ ```
34
+
35
+
@@ -0,0 +1,27 @@
1
+ # Freeclimb::ConferenceParticipantResultAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **account_id** | **String** | ID of the account that created this participant. | [optional]
8
+ **conference_id** | **String** | ID of the conference this participant is in. | [optional]
9
+ **call_id** | **String** | ID of the Call associated with this Participant. | [optional]
10
+ **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional]
11
+ **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional]
12
+ **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'Freeclimb'
18
+
19
+ instance = Freeclimb::ConferenceParticipantResultAllOf.new(account_id: null,
20
+ conference_id: null,
21
+ call_id: null,
22
+ talk: null,
23
+ listen: null,
24
+ start_conf_on_enter: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,43 @@
1
+ # Freeclimb::ConferenceResult
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
8
+ **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
9
+ **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
+ **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
+ **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional]
12
+ **account_id** | **String** | ID of the account that created this Conference. | [optional]
13
+ **_alias** | **String** | A description for this Conference. | [optional]
14
+ **play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional]
15
+ **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional]
16
+ **status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional]
17
+ **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional]
18
+ **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional]
19
+ **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional]
20
+ **subresource_uris** | [**Object**](.md) | The list of subresources for this Conference. This includes participants and/or recordings. | [optional]
21
+
22
+ ## Code Sample
23
+
24
+ ```ruby
25
+ require 'Freeclimb'
26
+
27
+ instance = Freeclimb::ConferenceResult.new(uri: null,
28
+ date_created: null,
29
+ date_updated: null,
30
+ revision: null,
31
+ conference_id: null,
32
+ account_id: null,
33
+ _alias: null,
34
+ play_beep: null,
35
+ record: null,
36
+ status: null,
37
+ wait_url: null,
38
+ action_url: null,
39
+ status_callback_url: null,
40
+ subresource_uris: null)
41
+ ```
42
+
43
+
@@ -0,0 +1,35 @@
1
+ # Freeclimb::ConferenceResultAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional]
8
+ **account_id** | **String** | ID of the account that created this Conference. | [optional]
9
+ **_alias** | **String** | A description for this Conference. | [optional]
10
+ **play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional]
11
+ **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional]
12
+ **status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional]
13
+ **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional]
14
+ **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional]
15
+ **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional]
16
+ **subresource_uris** | [**Object**](.md) | The list of subresources for this Conference. This includes participants and/or recordings. | [optional]
17
+
18
+ ## Code Sample
19
+
20
+ ```ruby
21
+ require 'Freeclimb'
22
+
23
+ instance = Freeclimb::ConferenceResultAllOf.new(conference_id: null,
24
+ account_id: null,
25
+ _alias: null,
26
+ play_beep: null,
27
+ record: null,
28
+ status: null,
29
+ wait_url: null,
30
+ action_url: null,
31
+ status_callback_url: null,
32
+ subresource_uris: null)
33
+ ```
34
+
35
+
@@ -0,0 +1,27 @@
1
+ # Freeclimb::CreateConferenceRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_alias** | **String** | A description for this Conference. Maximum 64 characters. | [optional]
8
+ **play_beep** | **String** | Controls when a beep is played. Valid values: `always`, `never`, `entryOnly`, `exitOnly`. | [optional] [default to 'always']
9
+ **record** | **Boolean** | Setting to `true` records the entire Conference. | [optional]
10
+ **wait_url** | **String** | If specified, a URL for the audio file that provides custom hold music for the Conference when it is in the populated state. Otherwise, FreeClimb uses a system default audio file. This is always fetched using HTTP GET and is fetched just once — when the Conference is created. | [optional]
11
+ **status_callback_url** | **String** | This URL is invoked when the status of the Conference changes. For more information, see **statusCallbackUrl** (below). | [optional]
12
+ **request_id** | **String** | The requestId for this request starting with prefix \"RQ\" followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>). | [optional]
13
+
14
+ ## Code Sample
15
+
16
+ ```ruby
17
+ require 'Freeclimb'
18
+
19
+ instance = Freeclimb::CreateConferenceRequest.new(_alias: null,
20
+ play_beep: null,
21
+ record: null,
22
+ wait_url: null,
23
+ status_callback_url: null,
24
+ request_id: null)
25
+ ```
26
+
27
+
@@ -0,0 +1,2504 @@
1
+ # Freeclimb::DefaultApi
2
+
3
+ All URIs are relative to *https://www.freeclimb.com/apiserver*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**buy_a_phone_number**](DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
8
+ [**create_a_conference**](DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
9
+ [**create_a_queue**](DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
10
+ [**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application
11
+ [**delete_a_recording**](DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
12
+ [**delete_an_application**](DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
13
+ [**delete_an_incoming_number**](DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
14
+ [**dequeue_a_member**](DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member
15
+ [**dequeue_head_member**](DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member
16
+ [**download_a_recording_file**](DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File
17
+ [**filter_logs**](DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs
18
+ [**get_a_call**](DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call
19
+ [**get_a_conference**](DefaultApi.md#get_a_conference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference
20
+ [**get_a_member**](DefaultApi.md#get_a_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Get a Member
21
+ [**get_a_participant**](DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
22
+ [**get_a_queue**](DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
23
+ [**get_a_recording**](DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
24
+ [**get_an_account**](DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
25
+ [**get_an_application**](DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
26
+ [**get_an_incoming_number**](DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
27
+ [**get_an_sms_message**](DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
28
+ [**get_head_member**](DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member
29
+ [**list_active_queues**](DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues
30
+ [**list_all_account_logs**](DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs
31
+ [**list_an_application**](DefaultApi.md#list_an_application) | **GET** /Accounts/{accountId}/Applications | List applications
32
+ [**list_available_numbers**](DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers
33
+ [**list_call_logs**](DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs
34
+ [**list_call_recordings**](DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings
35
+ [**list_calls**](DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls
36
+ [**list_conferences**](DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences
37
+ [**list_incoming_numbers**](DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers
38
+ [**list_members**](DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members
39
+ [**list_participants**](DefaultApi.md#list_participants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants
40
+ [**list_recordings**](DefaultApi.md#list_recordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings
41
+ [**list_sms_messages**](DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages
42
+ [**make_a_call**](DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call
43
+ [**remove_a_participant**](DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant
44
+ [**send_an_sms_message**](DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message
45
+ [**stream_a_recording_file**](DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File
46
+ [**update_a_conference**](DefaultApi.md#update_a_conference) | **POST** /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference
47
+ [**update_a_live_call**](DefaultApi.md#update_a_live_call) | **POST** /Accounts/{accountId}/Calls/{callId} | Update a Live Call
48
+ [**update_a_participant**](DefaultApi.md#update_a_participant) | **POST** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Update a Participant
49
+ [**update_a_queue**](DefaultApi.md#update_a_queue) | **POST** /Accounts/{accountId}/Queues/{queueId} | Update a Queue
50
+ [**update_an_account**](DefaultApi.md#update_an_account) | **POST** /Accounts/{accountId} | Manage an account
51
+ [**update_an_application**](DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
52
+ [**update_an_incoming_number**](DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
53
+
54
+
55
+
56
+ ## buy_a_phone_number
57
+
58
+ > IncomingNumberResult buy_a_phone_number(opts)
59
+
60
+ Buy a Phone Number
61
+
62
+ ### Example
63
+
64
+ ```ruby
65
+ # load the gem
66
+ require 'freeclimb'
67
+ # setup authorization
68
+ Freeclimb.configure do |config|
69
+ # Configure HTTP basic authorization: fc
70
+ config.username = 'ACCOUNT ID'
71
+ config.password = 'AUTH TOKEN'
72
+ end
73
+
74
+ api_instance = Freeclimb::DefaultApi.new
75
+ opts = {
76
+ buy_incoming_number_request: Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
77
+ }
78
+
79
+ begin
80
+ #Buy a Phone Number
81
+ result = api_instance.buy_a_phone_number(opts)
82
+ p result
83
+ rescue Freeclimb::ApiError => e
84
+ puts "Exception when calling DefaultApi->buy_a_phone_number: #{e}"
85
+ end
86
+ ```
87
+
88
+ ### Parameters
89
+
90
+
91
+ Name | Type | Description | Notes
92
+ ------------- | ------------- | ------------- | -------------
93
+ **buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md)| Incoming Number transaction details | [optional]
94
+
95
+ ### Return type
96
+
97
+ [**IncomingNumberResult**](IncomingNumberResult.md)
98
+
99
+ ### Authorization
100
+
101
+ [fc](../README.md#fc)
102
+
103
+ ### HTTP request headers
104
+
105
+ - **Content-Type**: application/json
106
+ - **Accept**: application/json
107
+
108
+
109
+ ## create_a_conference
110
+
111
+ > ConferenceResult create_a_conference(opts)
112
+
113
+ Create a Conference
114
+
115
+ ### Example
116
+
117
+ ```ruby
118
+ # load the gem
119
+ require 'freeclimb'
120
+ # setup authorization
121
+ Freeclimb.configure do |config|
122
+ # Configure HTTP basic authorization: fc
123
+ config.username = 'ACCOUNT ID'
124
+ config.password = 'AUTH TOKEN'
125
+ end
126
+
127
+ api_instance = Freeclimb::DefaultApi.new
128
+ opts = {
129
+ create_conference_request: Freeclimb::CreateConferenceRequest.new # CreateConferenceRequest | Conference to create
130
+ }
131
+
132
+ begin
133
+ #Create a Conference
134
+ result = api_instance.create_a_conference(opts)
135
+ p result
136
+ rescue Freeclimb::ApiError => e
137
+ puts "Exception when calling DefaultApi->create_a_conference: #{e}"
138
+ end
139
+ ```
140
+
141
+ ### Parameters
142
+
143
+
144
+ Name | Type | Description | Notes
145
+ ------------- | ------------- | ------------- | -------------
146
+ **create_conference_request** | [**CreateConferenceRequest**](CreateConferenceRequest.md)| Conference to create | [optional]
147
+
148
+ ### Return type
149
+
150
+ [**ConferenceResult**](ConferenceResult.md)
151
+
152
+ ### Authorization
153
+
154
+ [fc](../README.md#fc)
155
+
156
+ ### HTTP request headers
157
+
158
+ - **Content-Type**: application/json
159
+ - **Accept**: application/json
160
+
161
+
162
+ ## create_a_queue
163
+
164
+ > QueueResult create_a_queue(opts)
165
+
166
+ Create a Queue
167
+
168
+ ### Example
169
+
170
+ ```ruby
171
+ # load the gem
172
+ require 'freeclimb'
173
+ # setup authorization
174
+ Freeclimb.configure do |config|
175
+ # Configure HTTP basic authorization: fc
176
+ config.username = 'ACCOUNT ID'
177
+ config.password = 'AUTH TOKEN'
178
+ end
179
+
180
+ api_instance = Freeclimb::DefaultApi.new
181
+ opts = {
182
+ queue_request: Freeclimb::QueueRequest.new # QueueRequest | Queue details used to create a queue
183
+ }
184
+
185
+ begin
186
+ #Create a Queue
187
+ result = api_instance.create_a_queue(opts)
188
+ p result
189
+ rescue Freeclimb::ApiError => e
190
+ puts "Exception when calling DefaultApi->create_a_queue: #{e}"
191
+ end
192
+ ```
193
+
194
+ ### Parameters
195
+
196
+
197
+ Name | Type | Description | Notes
198
+ ------------- | ------------- | ------------- | -------------
199
+ **queue_request** | [**QueueRequest**](QueueRequest.md)| Queue details used to create a queue | [optional]
200
+
201
+ ### Return type
202
+
203
+ [**QueueResult**](QueueResult.md)
204
+
205
+ ### Authorization
206
+
207
+ [fc](../README.md#fc)
208
+
209
+ ### HTTP request headers
210
+
211
+ - **Content-Type**: application/json
212
+ - **Accept**: application/json
213
+
214
+
215
+ ## create_an_application
216
+
217
+ > ApplicationResult create_an_application(opts)
218
+
219
+ Create an application
220
+
221
+ ### Example
222
+
223
+ ```ruby
224
+ # load the gem
225
+ require 'freeclimb'
226
+ # setup authorization
227
+ Freeclimb.configure do |config|
228
+ # Configure HTTP basic authorization: fc
229
+ config.username = 'ACCOUNT ID'
230
+ config.password = 'AUTH TOKEN'
231
+ end
232
+
233
+ api_instance = Freeclimb::DefaultApi.new
234
+ opts = {
235
+ application_request: Freeclimb::ApplicationRequest.new # ApplicationRequest | Application Details
236
+ }
237
+
238
+ begin
239
+ #Create an application
240
+ result = api_instance.create_an_application(opts)
241
+ p result
242
+ rescue Freeclimb::ApiError => e
243
+ puts "Exception when calling DefaultApi->create_an_application: #{e}"
244
+ end
245
+ ```
246
+
247
+ ### Parameters
248
+
249
+
250
+ Name | Type | Description | Notes
251
+ ------------- | ------------- | ------------- | -------------
252
+ **application_request** | [**ApplicationRequest**](ApplicationRequest.md)| Application Details | [optional]
253
+
254
+ ### Return type
255
+
256
+ [**ApplicationResult**](ApplicationResult.md)
257
+
258
+ ### Authorization
259
+
260
+ [fc](../README.md#fc)
261
+
262
+ ### HTTP request headers
263
+
264
+ - **Content-Type**: application/json
265
+ - **Accept**: application/json
266
+
267
+
268
+ ## delete_a_recording
269
+
270
+ > delete_a_recording(recording_id)
271
+
272
+ Delete a Recording
273
+
274
+ ### Example
275
+
276
+ ```ruby
277
+ # load the gem
278
+ require 'freeclimb'
279
+ # setup authorization
280
+ Freeclimb.configure do |config|
281
+ # Configure HTTP basic authorization: fc
282
+ config.username = 'ACCOUNT ID'
283
+ config.password = 'AUTH TOKEN'
284
+ end
285
+
286
+ api_instance = Freeclimb::DefaultApi.new
287
+ recording_id = 'recording_id_example' # String | String that uniquely identifies this recording resource.
288
+
289
+ begin
290
+ #Delete a Recording
291
+ api_instance.delete_a_recording(recording_id)
292
+ rescue Freeclimb::ApiError => e
293
+ puts "Exception when calling DefaultApi->delete_a_recording: #{e}"
294
+ end
295
+ ```
296
+
297
+ ### Parameters
298
+
299
+
300
+ Name | Type | Description | Notes
301
+ ------------- | ------------- | ------------- | -------------
302
+ **recording_id** | **String**| String that uniquely identifies this recording resource. |
303
+
304
+ ### Return type
305
+
306
+ nil (empty response body)
307
+
308
+ ### Authorization
309
+
310
+ [fc](../README.md#fc)
311
+
312
+ ### HTTP request headers
313
+
314
+ - **Content-Type**: Not defined
315
+ - **Accept**: Not defined
316
+
317
+
318
+ ## delete_an_application
319
+
320
+ > delete_an_application(application_id)
321
+
322
+ Delete an application
323
+
324
+ ### Example
325
+
326
+ ```ruby
327
+ # load the gem
328
+ require 'freeclimb'
329
+ # setup authorization
330
+ Freeclimb.configure do |config|
331
+ # Configure HTTP basic authorization: fc
332
+ config.username = 'ACCOUNT ID'
333
+ config.password = 'AUTH TOKEN'
334
+ end
335
+
336
+ api_instance = Freeclimb::DefaultApi.new
337
+ application_id = 'application_id_example' # String | String that uniquely identifies this application resource.
338
+
339
+ begin
340
+ #Delete an application
341
+ api_instance.delete_an_application(application_id)
342
+ rescue Freeclimb::ApiError => e
343
+ puts "Exception when calling DefaultApi->delete_an_application: #{e}"
344
+ end
345
+ ```
346
+
347
+ ### Parameters
348
+
349
+
350
+ Name | Type | Description | Notes
351
+ ------------- | ------------- | ------------- | -------------
352
+ **application_id** | **String**| String that uniquely identifies this application resource. |
353
+
354
+ ### Return type
355
+
356
+ nil (empty response body)
357
+
358
+ ### Authorization
359
+
360
+ [fc](../README.md#fc)
361
+
362
+ ### HTTP request headers
363
+
364
+ - **Content-Type**: Not defined
365
+ - **Accept**: Not defined
366
+
367
+
368
+ ## delete_an_incoming_number
369
+
370
+ > delete_an_incoming_number(phone_number_id)
371
+
372
+ Delete an Incoming Number
373
+
374
+ ### Example
375
+
376
+ ```ruby
377
+ # load the gem
378
+ require 'freeclimb'
379
+ # setup authorization
380
+ Freeclimb.configure do |config|
381
+ # Configure HTTP basic authorization: fc
382
+ config.username = 'ACCOUNT ID'
383
+ config.password = 'AUTH TOKEN'
384
+ end
385
+
386
+ api_instance = Freeclimb::DefaultApi.new
387
+ phone_number_id = 'phone_number_id_example' # String | String that uniquely identifies this phone number resource.
388
+
389
+ begin
390
+ #Delete an Incoming Number
391
+ api_instance.delete_an_incoming_number(phone_number_id)
392
+ rescue Freeclimb::ApiError => e
393
+ puts "Exception when calling DefaultApi->delete_an_incoming_number: #{e}"
394
+ end
395
+ ```
396
+
397
+ ### Parameters
398
+
399
+
400
+ Name | Type | Description | Notes
401
+ ------------- | ------------- | ------------- | -------------
402
+ **phone_number_id** | **String**| String that uniquely identifies this phone number resource. |
403
+
404
+ ### Return type
405
+
406
+ nil (empty response body)
407
+
408
+ ### Authorization
409
+
410
+ [fc](../README.md#fc)
411
+
412
+ ### HTTP request headers
413
+
414
+ - **Content-Type**: Not defined
415
+ - **Accept**: Not defined
416
+
417
+
418
+ ## dequeue_a_member
419
+
420
+ > QueueMember dequeue_a_member(queue_id, call_id, opts)
421
+
422
+ Dequeue a Member
423
+
424
+ ### Example
425
+
426
+ ```ruby
427
+ # load the gem
428
+ require 'freeclimb'
429
+ # setup authorization
430
+ Freeclimb.configure do |config|
431
+ # Configure HTTP basic authorization: fc
432
+ config.username = 'ACCOUNT ID'
433
+ config.password = 'AUTH TOKEN'
434
+ end
435
+
436
+ api_instance = Freeclimb::DefaultApi.new
437
+ queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
438
+ call_id = 'call_id_example' # String | ID if the Call that the Member belongs to
439
+ opts = {
440
+ dequeue_member_request: Freeclimb::DequeueMemberRequest.new # DequeueMemberRequest | Dequeue member request details
441
+ }
442
+
443
+ begin
444
+ #Dequeue a Member
445
+ result = api_instance.dequeue_a_member(queue_id, call_id, opts)
446
+ p result
447
+ rescue Freeclimb::ApiError => e
448
+ puts "Exception when calling DefaultApi->dequeue_a_member: #{e}"
449
+ end
450
+ ```
451
+
452
+ ### Parameters
453
+
454
+
455
+ Name | Type | Description | Notes
456
+ ------------- | ------------- | ------------- | -------------
457
+ **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. |
458
+ **call_id** | **String**| ID if the Call that the Member belongs to |
459
+ **dequeue_member_request** | [**DequeueMemberRequest**](DequeueMemberRequest.md)| Dequeue member request details | [optional]
460
+
461
+ ### Return type
462
+
463
+ [**QueueMember**](QueueMember.md)
464
+
465
+ ### Authorization
466
+
467
+ [fc](../README.md#fc)
468
+
469
+ ### HTTP request headers
470
+
471
+ - **Content-Type**: application/json
472
+ - **Accept**: application/json
473
+
474
+
475
+ ## dequeue_head_member
476
+
477
+ > QueueMember dequeue_head_member(queue_id, opts)
478
+
479
+ Dequeue Head Member
480
+
481
+ ### Example
482
+
483
+ ```ruby
484
+ # load the gem
485
+ require 'freeclimb'
486
+ # setup authorization
487
+ Freeclimb.configure do |config|
488
+ # Configure HTTP basic authorization: fc
489
+ config.username = 'ACCOUNT ID'
490
+ config.password = 'AUTH TOKEN'
491
+ end
492
+
493
+ api_instance = Freeclimb::DefaultApi.new
494
+ queue_id = 'queue_id_example' # String | String that uniquely identifies this queue resource.
495
+ opts = {
496
+ dequeue_member_request: Freeclimb::DequeueMemberRequest.new # DequeueMemberRequest | Dequeue head member request details
497
+ }
498
+
499
+ begin
500
+ #Dequeue Head Member
501
+ result = api_instance.dequeue_head_member(queue_id, opts)
502
+ p result
503
+ rescue Freeclimb::ApiError => e
504
+ puts "Exception when calling DefaultApi->dequeue_head_member: #{e}"
505
+ end
506
+ ```
507
+
508
+ ### Parameters
509
+
510
+
511
+ Name | Type | Description | Notes
512
+ ------------- | ------------- | ------------- | -------------
513
+ **queue_id** | **String**| String that uniquely identifies this queue resource. |
514
+ **dequeue_member_request** | [**DequeueMemberRequest**](DequeueMemberRequest.md)| Dequeue head member request details | [optional]
515
+
516
+ ### Return type
517
+
518
+ [**QueueMember**](QueueMember.md)
519
+
520
+ ### Authorization
521
+
522
+ [fc](../README.md#fc)
523
+
524
+ ### HTTP request headers
525
+
526
+ - **Content-Type**: application/json
527
+ - **Accept**: application/json
528
+
529
+
530
+ ## download_a_recording_file
531
+
532
+ > File download_a_recording_file(recording_id)
533
+
534
+ Download a Recording File
535
+
536
+ ### Example
537
+
538
+ ```ruby
539
+ # load the gem
540
+ require 'freeclimb'
541
+ # setup authorization
542
+ Freeclimb.configure do |config|
543
+ # Configure HTTP basic authorization: fc
544
+ config.username = 'ACCOUNT ID'
545
+ config.password = 'AUTH TOKEN'
546
+ end
547
+
548
+ api_instance = Freeclimb::DefaultApi.new
549
+ recording_id = 'recording_id_example' # String | String that uniquely identifies this recording resource.
550
+
551
+ begin
552
+ #Download a Recording File
553
+ result = api_instance.download_a_recording_file(recording_id)
554
+ p result
555
+ rescue Freeclimb::ApiError => e
556
+ puts "Exception when calling DefaultApi->download_a_recording_file: #{e}"
557
+ end
558
+ ```
559
+
560
+ ### Parameters
561
+
562
+
563
+ Name | Type | Description | Notes
564
+ ------------- | ------------- | ------------- | -------------
565
+ **recording_id** | **String**| String that uniquely identifies this recording resource. |
566
+
567
+ ### Return type
568
+
569
+ **File**
570
+
571
+ ### Authorization
572
+
573
+ [fc](../README.md#fc)
574
+
575
+ ### HTTP request headers
576
+
577
+ - **Content-Type**: Not defined
578
+ - **Accept**: audio/x-wav
579
+
580
+
581
+ ## filter_logs
582
+
583
+ > LogList filter_logs(opts)
584
+
585
+ Filter Logs
586
+
587
+ ### Example
588
+
589
+ ```ruby
590
+ # load the gem
591
+ require 'freeclimb'
592
+ # setup authorization
593
+ Freeclimb.configure do |config|
594
+ # Configure HTTP basic authorization: fc
595
+ config.username = 'ACCOUNT ID'
596
+ config.password = 'AUTH TOKEN'
597
+ end
598
+
599
+ api_instance = Freeclimb::DefaultApi.new
600
+ opts = {
601
+ filter_logs_request: Freeclimb::FilterLogsRequest.new # FilterLogsRequest | Filter logs request paramters
602
+ }
603
+
604
+ begin
605
+ #Filter Logs
606
+ result = api_instance.filter_logs(opts)
607
+ p result
608
+ rescue Freeclimb::ApiError => e
609
+ puts "Exception when calling DefaultApi->filter_logs: #{e}"
610
+ end
611
+ ```
612
+
613
+ ### Parameters
614
+
615
+
616
+ Name | Type | Description | Notes
617
+ ------------- | ------------- | ------------- | -------------
618
+ **filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md)| Filter logs request paramters | [optional]
619
+
620
+ ### Return type
621
+
622
+ [**LogList**](LogList.md)
623
+
624
+ ### Authorization
625
+
626
+ [fc](../README.md#fc)
627
+
628
+ ### HTTP request headers
629
+
630
+ - **Content-Type**: application/json
631
+ - **Accept**: application/json
632
+
633
+
634
+ ## get_a_call
635
+
636
+ > CallResult get_a_call(call_id)
637
+
638
+ Get a Call
639
+
640
+ ### Example
641
+
642
+ ```ruby
643
+ # load the gem
644
+ require 'freeclimb'
645
+ # setup authorization
646
+ Freeclimb.configure do |config|
647
+ # Configure HTTP basic authorization: fc
648
+ config.username = 'ACCOUNT ID'
649
+ config.password = 'AUTH TOKEN'
650
+ end
651
+
652
+ api_instance = Freeclimb::DefaultApi.new
653
+ call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
654
+
655
+ begin
656
+ #Get a Call
657
+ result = api_instance.get_a_call(call_id)
658
+ p result
659
+ rescue Freeclimb::ApiError => e
660
+ puts "Exception when calling DefaultApi->get_a_call: #{e}"
661
+ end
662
+ ```
663
+
664
+ ### Parameters
665
+
666
+
667
+ Name | Type | Description | Notes
668
+ ------------- | ------------- | ------------- | -------------
669
+ **call_id** | **String**| String that uniquely identifies this call resource. |
670
+
671
+ ### Return type
672
+
673
+ [**CallResult**](CallResult.md)
674
+
675
+ ### Authorization
676
+
677
+ [fc](../README.md#fc)
678
+
679
+ ### HTTP request headers
680
+
681
+ - **Content-Type**: Not defined
682
+ - **Accept**: application/json
683
+
684
+
685
+ ## get_a_conference
686
+
687
+ > ConferenceResult get_a_conference(conference_id)
688
+
689
+ Get a Conference
690
+
691
+ ### Example
692
+
693
+ ```ruby
694
+ # load the gem
695
+ require 'freeclimb'
696
+ # setup authorization
697
+ Freeclimb.configure do |config|
698
+ # Configure HTTP basic authorization: fc
699
+ config.username = 'ACCOUNT ID'
700
+ config.password = 'AUTH TOKEN'
701
+ end
702
+
703
+ api_instance = Freeclimb::DefaultApi.new
704
+ conference_id = 'conference_id_example' # String | A string that uniquely identifies this conference resource.
705
+
706
+ begin
707
+ #Get a Conference
708
+ result = api_instance.get_a_conference(conference_id)
709
+ p result
710
+ rescue Freeclimb::ApiError => e
711
+ puts "Exception when calling DefaultApi->get_a_conference: #{e}"
712
+ end
713
+ ```
714
+
715
+ ### Parameters
716
+
717
+
718
+ Name | Type | Description | Notes
719
+ ------------- | ------------- | ------------- | -------------
720
+ **conference_id** | **String**| A string that uniquely identifies this conference resource. |
721
+
722
+ ### Return type
723
+
724
+ [**ConferenceResult**](ConferenceResult.md)
725
+
726
+ ### Authorization
727
+
728
+ [fc](../README.md#fc)
729
+
730
+ ### HTTP request headers
731
+
732
+ - **Content-Type**: Not defined
733
+ - **Accept**: application/json
734
+
735
+
736
+ ## get_a_member
737
+
738
+ > QueueMember get_a_member(queue_id, call_id)
739
+
740
+ Get a Member
741
+
742
+ ### Example
743
+
744
+ ```ruby
745
+ # load the gem
746
+ require 'freeclimb'
747
+ # setup authorization
748
+ Freeclimb.configure do |config|
749
+ # Configure HTTP basic authorization: fc
750
+ config.username = 'ACCOUNT ID'
751
+ config.password = 'AUTH TOKEN'
752
+ end
753
+
754
+ api_instance = Freeclimb::DefaultApi.new
755
+ queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
756
+ call_id = 'call_id_example' # String | ID of the Call that the Member belongs to
757
+
758
+ begin
759
+ #Get a Member
760
+ result = api_instance.get_a_member(queue_id, call_id)
761
+ p result
762
+ rescue Freeclimb::ApiError => e
763
+ puts "Exception when calling DefaultApi->get_a_member: #{e}"
764
+ end
765
+ ```
766
+
767
+ ### Parameters
768
+
769
+
770
+ Name | Type | Description | Notes
771
+ ------------- | ------------- | ------------- | -------------
772
+ **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. |
773
+ **call_id** | **String**| ID of the Call that the Member belongs to |
774
+
775
+ ### Return type
776
+
777
+ [**QueueMember**](QueueMember.md)
778
+
779
+ ### Authorization
780
+
781
+ [fc](../README.md#fc)
782
+
783
+ ### HTTP request headers
784
+
785
+ - **Content-Type**: Not defined
786
+ - **Accept**: application/json
787
+
788
+
789
+ ## get_a_participant
790
+
791
+ > ConferenceParticipantResult get_a_participant(conference_id, call_id)
792
+
793
+ Get a Participant
794
+
795
+ ### Example
796
+
797
+ ```ruby
798
+ # load the gem
799
+ require 'freeclimb'
800
+ # setup authorization
801
+ Freeclimb.configure do |config|
802
+ # Configure HTTP basic authorization: fc
803
+ config.username = 'ACCOUNT ID'
804
+ config.password = 'AUTH TOKEN'
805
+ end
806
+
807
+ api_instance = Freeclimb::DefaultApi.new
808
+ conference_id = 'conference_id_example' # String | ID of the conference this participant is in.
809
+ call_id = 'call_id_example' # String | ID of the Call associated with this participant.
810
+
811
+ begin
812
+ #Get a Participant
813
+ result = api_instance.get_a_participant(conference_id, call_id)
814
+ p result
815
+ rescue Freeclimb::ApiError => e
816
+ puts "Exception when calling DefaultApi->get_a_participant: #{e}"
817
+ end
818
+ ```
819
+
820
+ ### Parameters
821
+
822
+
823
+ Name | Type | Description | Notes
824
+ ------------- | ------------- | ------------- | -------------
825
+ **conference_id** | **String**| ID of the conference this participant is in. |
826
+ **call_id** | **String**| ID of the Call associated with this participant. |
827
+
828
+ ### Return type
829
+
830
+ [**ConferenceParticipantResult**](ConferenceParticipantResult.md)
831
+
832
+ ### Authorization
833
+
834
+ [fc](../README.md#fc)
835
+
836
+ ### HTTP request headers
837
+
838
+ - **Content-Type**: Not defined
839
+ - **Accept**: application/json
840
+
841
+
842
+ ## get_a_queue
843
+
844
+ > QueueResult get_a_queue(queue_id)
845
+
846
+ Get a Queue
847
+
848
+ ### Example
849
+
850
+ ```ruby
851
+ # load the gem
852
+ require 'freeclimb'
853
+ # setup authorization
854
+ Freeclimb.configure do |config|
855
+ # Configure HTTP basic authorization: fc
856
+ config.username = 'ACCOUNT ID'
857
+ config.password = 'AUTH TOKEN'
858
+ end
859
+
860
+ api_instance = Freeclimb::DefaultApi.new
861
+ queue_id = 'queue_id_example' # String | A string that uniquely identifies this queue resource.
862
+
863
+ begin
864
+ #Get a Queue
865
+ result = api_instance.get_a_queue(queue_id)
866
+ p result
867
+ rescue Freeclimb::ApiError => e
868
+ puts "Exception when calling DefaultApi->get_a_queue: #{e}"
869
+ end
870
+ ```
871
+
872
+ ### Parameters
873
+
874
+
875
+ Name | Type | Description | Notes
876
+ ------------- | ------------- | ------------- | -------------
877
+ **queue_id** | **String**| A string that uniquely identifies this queue resource. |
878
+
879
+ ### Return type
880
+
881
+ [**QueueResult**](QueueResult.md)
882
+
883
+ ### Authorization
884
+
885
+ [fc](../README.md#fc)
886
+
887
+ ### HTTP request headers
888
+
889
+ - **Content-Type**: Not defined
890
+ - **Accept**: application/json
891
+
892
+
893
+ ## get_a_recording
894
+
895
+ > RecordingResult get_a_recording(recording_id)
896
+
897
+ Get a Recording
898
+
899
+ ### Example
900
+
901
+ ```ruby
902
+ # load the gem
903
+ require 'freeclimb'
904
+ # setup authorization
905
+ Freeclimb.configure do |config|
906
+ # Configure HTTP basic authorization: fc
907
+ config.username = 'ACCOUNT ID'
908
+ config.password = 'AUTH TOKEN'
909
+ end
910
+
911
+ api_instance = Freeclimb::DefaultApi.new
912
+ recording_id = 'recording_id_example' # String | String that uniquely identifies this recording resource.
913
+
914
+ begin
915
+ #Get a Recording
916
+ result = api_instance.get_a_recording(recording_id)
917
+ p result
918
+ rescue Freeclimb::ApiError => e
919
+ puts "Exception when calling DefaultApi->get_a_recording: #{e}"
920
+ end
921
+ ```
922
+
923
+ ### Parameters
924
+
925
+
926
+ Name | Type | Description | Notes
927
+ ------------- | ------------- | ------------- | -------------
928
+ **recording_id** | **String**| String that uniquely identifies this recording resource. |
929
+
930
+ ### Return type
931
+
932
+ [**RecordingResult**](RecordingResult.md)
933
+
934
+ ### Authorization
935
+
936
+ [fc](../README.md#fc)
937
+
938
+ ### HTTP request headers
939
+
940
+ - **Content-Type**: Not defined
941
+ - **Accept**: application/json
942
+
943
+
944
+ ## get_an_account
945
+
946
+ > AccountResult get_an_account
947
+
948
+ Get an Account
949
+
950
+ ### Example
951
+
952
+ ```ruby
953
+ # load the gem
954
+ require 'freeclimb'
955
+ # setup authorization
956
+ Freeclimb.configure do |config|
957
+ # Configure HTTP basic authorization: fc
958
+ config.username = 'ACCOUNT ID'
959
+ config.password = 'AUTH TOKEN'
960
+ end
961
+
962
+ api_instance = Freeclimb::DefaultApi.new
963
+
964
+ begin
965
+ #Get an Account
966
+ result = api_instance.get_an_account
967
+ p result
968
+ rescue Freeclimb::ApiError => e
969
+ puts "Exception when calling DefaultApi->get_an_account: #{e}"
970
+ end
971
+ ```
972
+
973
+ ### Parameters
974
+
975
+ This endpoint does not need any parameter.
976
+
977
+ ### Return type
978
+
979
+ [**AccountResult**](AccountResult.md)
980
+
981
+ ### Authorization
982
+
983
+ [fc](../README.md#fc)
984
+
985
+ ### HTTP request headers
986
+
987
+ - **Content-Type**: Not defined
988
+ - **Accept**: application/json
989
+
990
+
991
+ ## get_an_application
992
+
993
+ > ApplicationResult get_an_application(application_id)
994
+
995
+ Get an Application
996
+
997
+ ### Example
998
+
999
+ ```ruby
1000
+ # load the gem
1001
+ require 'freeclimb'
1002
+ # setup authorization
1003
+ Freeclimb.configure do |config|
1004
+ # Configure HTTP basic authorization: fc
1005
+ config.username = 'ACCOUNT ID'
1006
+ config.password = 'AUTH TOKEN'
1007
+ end
1008
+
1009
+ api_instance = Freeclimb::DefaultApi.new
1010
+ application_id = 'application_id_example' # String | A string that uniquely identifies this application resource.
1011
+
1012
+ begin
1013
+ #Get an Application
1014
+ result = api_instance.get_an_application(application_id)
1015
+ p result
1016
+ rescue Freeclimb::ApiError => e
1017
+ puts "Exception when calling DefaultApi->get_an_application: #{e}"
1018
+ end
1019
+ ```
1020
+
1021
+ ### Parameters
1022
+
1023
+
1024
+ Name | Type | Description | Notes
1025
+ ------------- | ------------- | ------------- | -------------
1026
+ **application_id** | **String**| A string that uniquely identifies this application resource. |
1027
+
1028
+ ### Return type
1029
+
1030
+ [**ApplicationResult**](ApplicationResult.md)
1031
+
1032
+ ### Authorization
1033
+
1034
+ [fc](../README.md#fc)
1035
+
1036
+ ### HTTP request headers
1037
+
1038
+ - **Content-Type**: Not defined
1039
+ - **Accept**: application/json
1040
+
1041
+
1042
+ ## get_an_incoming_number
1043
+
1044
+ > IncomingNumberResult get_an_incoming_number(phone_number_id)
1045
+
1046
+ Get an Incoming Number
1047
+
1048
+ ### Example
1049
+
1050
+ ```ruby
1051
+ # load the gem
1052
+ require 'freeclimb'
1053
+ # setup authorization
1054
+ Freeclimb.configure do |config|
1055
+ # Configure HTTP basic authorization: fc
1056
+ config.username = 'ACCOUNT ID'
1057
+ config.password = 'AUTH TOKEN'
1058
+ end
1059
+
1060
+ api_instance = Freeclimb::DefaultApi.new
1061
+ phone_number_id = 'phone_number_id_example' # String | String that uniquely identifies this phone number resource.
1062
+
1063
+ begin
1064
+ #Get an Incoming Number
1065
+ result = api_instance.get_an_incoming_number(phone_number_id)
1066
+ p result
1067
+ rescue Freeclimb::ApiError => e
1068
+ puts "Exception when calling DefaultApi->get_an_incoming_number: #{e}"
1069
+ end
1070
+ ```
1071
+
1072
+ ### Parameters
1073
+
1074
+
1075
+ Name | Type | Description | Notes
1076
+ ------------- | ------------- | ------------- | -------------
1077
+ **phone_number_id** | **String**| String that uniquely identifies this phone number resource. |
1078
+
1079
+ ### Return type
1080
+
1081
+ [**IncomingNumberResult**](IncomingNumberResult.md)
1082
+
1083
+ ### Authorization
1084
+
1085
+ [fc](../README.md#fc)
1086
+
1087
+ ### HTTP request headers
1088
+
1089
+ - **Content-Type**: Not defined
1090
+ - **Accept**: application/json
1091
+
1092
+
1093
+ ## get_an_sms_message
1094
+
1095
+ > MessageResult get_an_sms_message(message_id)
1096
+
1097
+ Get an SMS Message
1098
+
1099
+ ### Example
1100
+
1101
+ ```ruby
1102
+ # load the gem
1103
+ require 'freeclimb'
1104
+ # setup authorization
1105
+ Freeclimb.configure do |config|
1106
+ # Configure HTTP basic authorization: fc
1107
+ config.username = 'ACCOUNT ID'
1108
+ config.password = 'AUTH TOKEN'
1109
+ end
1110
+
1111
+ api_instance = Freeclimb::DefaultApi.new
1112
+ message_id = 'message_id_example' # String | String that uniquely identifies this Message resource.
1113
+
1114
+ begin
1115
+ #Get an SMS Message
1116
+ result = api_instance.get_an_sms_message(message_id)
1117
+ p result
1118
+ rescue Freeclimb::ApiError => e
1119
+ puts "Exception when calling DefaultApi->get_an_sms_message: #{e}"
1120
+ end
1121
+ ```
1122
+
1123
+ ### Parameters
1124
+
1125
+
1126
+ Name | Type | Description | Notes
1127
+ ------------- | ------------- | ------------- | -------------
1128
+ **message_id** | **String**| String that uniquely identifies this Message resource. |
1129
+
1130
+ ### Return type
1131
+
1132
+ [**MessageResult**](MessageResult.md)
1133
+
1134
+ ### Authorization
1135
+
1136
+ [fc](../README.md#fc)
1137
+
1138
+ ### HTTP request headers
1139
+
1140
+ - **Content-Type**: Not defined
1141
+ - **Accept**: application/json
1142
+
1143
+
1144
+ ## get_head_member
1145
+
1146
+ > QueueMember get_head_member(queue_id)
1147
+
1148
+ Get Head Member
1149
+
1150
+ ### Example
1151
+
1152
+ ```ruby
1153
+ # load the gem
1154
+ require 'freeclimb'
1155
+ # setup authorization
1156
+ Freeclimb.configure do |config|
1157
+ # Configure HTTP basic authorization: fc
1158
+ config.username = 'ACCOUNT ID'
1159
+ config.password = 'AUTH TOKEN'
1160
+ end
1161
+
1162
+ api_instance = Freeclimb::DefaultApi.new
1163
+ queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
1164
+
1165
+ begin
1166
+ #Get Head Member
1167
+ result = api_instance.get_head_member(queue_id)
1168
+ p result
1169
+ rescue Freeclimb::ApiError => e
1170
+ puts "Exception when calling DefaultApi->get_head_member: #{e}"
1171
+ end
1172
+ ```
1173
+
1174
+ ### Parameters
1175
+
1176
+
1177
+ Name | Type | Description | Notes
1178
+ ------------- | ------------- | ------------- | -------------
1179
+ **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. |
1180
+
1181
+ ### Return type
1182
+
1183
+ [**QueueMember**](QueueMember.md)
1184
+
1185
+ ### Authorization
1186
+
1187
+ [fc](../README.md#fc)
1188
+
1189
+ ### HTTP request headers
1190
+
1191
+ - **Content-Type**: Not defined
1192
+ - **Accept**: application/json
1193
+
1194
+
1195
+ ## list_active_queues
1196
+
1197
+ > QueueList list_active_queues(opts)
1198
+
1199
+ List Active Queues
1200
+
1201
+ ### Example
1202
+
1203
+ ```ruby
1204
+ # load the gem
1205
+ require 'freeclimb'
1206
+ # setup authorization
1207
+ Freeclimb.configure do |config|
1208
+ # Configure HTTP basic authorization: fc
1209
+ config.username = 'ACCOUNT ID'
1210
+ config.password = 'AUTH TOKEN'
1211
+ end
1212
+
1213
+ api_instance = Freeclimb::DefaultApi.new
1214
+ opts = {
1215
+ _alias: '_alias_example' # String | Return only the Queue resources with aliases that exactly match this name.
1216
+ }
1217
+
1218
+ begin
1219
+ #List Active Queues
1220
+ result = api_instance.list_active_queues(opts)
1221
+ p result
1222
+ rescue Freeclimb::ApiError => e
1223
+ puts "Exception when calling DefaultApi->list_active_queues: #{e}"
1224
+ end
1225
+ ```
1226
+
1227
+ ### Parameters
1228
+
1229
+
1230
+ Name | Type | Description | Notes
1231
+ ------------- | ------------- | ------------- | -------------
1232
+ **_alias** | **String**| Return only the Queue resources with aliases that exactly match this name. | [optional]
1233
+
1234
+ ### Return type
1235
+
1236
+ [**QueueList**](QueueList.md)
1237
+
1238
+ ### Authorization
1239
+
1240
+ [fc](../README.md#fc)
1241
+
1242
+ ### HTTP request headers
1243
+
1244
+ - **Content-Type**: Not defined
1245
+ - **Accept**: application/json
1246
+
1247
+
1248
+ ## list_all_account_logs
1249
+
1250
+ > LogList list_all_account_logs
1251
+
1252
+ List All Account Logs
1253
+
1254
+ ### Example
1255
+
1256
+ ```ruby
1257
+ # load the gem
1258
+ require 'freeclimb'
1259
+ # setup authorization
1260
+ Freeclimb.configure do |config|
1261
+ # Configure HTTP basic authorization: fc
1262
+ config.username = 'ACCOUNT ID'
1263
+ config.password = 'AUTH TOKEN'
1264
+ end
1265
+
1266
+ api_instance = Freeclimb::DefaultApi.new
1267
+
1268
+ begin
1269
+ #List All Account Logs
1270
+ result = api_instance.list_all_account_logs
1271
+ p result
1272
+ rescue Freeclimb::ApiError => e
1273
+ puts "Exception when calling DefaultApi->list_all_account_logs: #{e}"
1274
+ end
1275
+ ```
1276
+
1277
+ ### Parameters
1278
+
1279
+ This endpoint does not need any parameter.
1280
+
1281
+ ### Return type
1282
+
1283
+ [**LogList**](LogList.md)
1284
+
1285
+ ### Authorization
1286
+
1287
+ [fc](../README.md#fc)
1288
+
1289
+ ### HTTP request headers
1290
+
1291
+ - **Content-Type**: Not defined
1292
+ - **Accept**: application/json
1293
+
1294
+
1295
+ ## list_an_application
1296
+
1297
+ > ApplicationList list_an_application(opts)
1298
+
1299
+ List applications
1300
+
1301
+ ### Example
1302
+
1303
+ ```ruby
1304
+ # load the gem
1305
+ require 'freeclimb'
1306
+ # setup authorization
1307
+ Freeclimb.configure do |config|
1308
+ # Configure HTTP basic authorization: fc
1309
+ config.username = 'ACCOUNT ID'
1310
+ config.password = 'AUTH TOKEN'
1311
+ end
1312
+
1313
+ api_instance = Freeclimb::DefaultApi.new
1314
+ opts = {
1315
+ _alias: '_alias_example' # String | Return only applications with aliases that exactly match this value.
1316
+ }
1317
+
1318
+ begin
1319
+ #List applications
1320
+ result = api_instance.list_an_application(opts)
1321
+ p result
1322
+ rescue Freeclimb::ApiError => e
1323
+ puts "Exception when calling DefaultApi->list_an_application: #{e}"
1324
+ end
1325
+ ```
1326
+
1327
+ ### Parameters
1328
+
1329
+
1330
+ Name | Type | Description | Notes
1331
+ ------------- | ------------- | ------------- | -------------
1332
+ **_alias** | **String**| Return only applications with aliases that exactly match this value. | [optional]
1333
+
1334
+ ### Return type
1335
+
1336
+ [**ApplicationList**](ApplicationList.md)
1337
+
1338
+ ### Authorization
1339
+
1340
+ [fc](../README.md#fc)
1341
+
1342
+ ### HTTP request headers
1343
+
1344
+ - **Content-Type**: Not defined
1345
+ - **Accept**: application/json
1346
+
1347
+
1348
+ ## list_available_numbers
1349
+
1350
+ > AvailableNumberList list_available_numbers(opts)
1351
+
1352
+ List available numbers
1353
+
1354
+ ### Example
1355
+
1356
+ ```ruby
1357
+ # load the gem
1358
+ require 'freeclimb'
1359
+ # setup authorization
1360
+ Freeclimb.configure do |config|
1361
+ # Configure HTTP basic authorization: fc
1362
+ config.username = 'ACCOUNT ID'
1363
+ config.password = 'AUTH TOKEN'
1364
+ end
1365
+
1366
+ api_instance = Freeclimb::DefaultApi.new
1367
+ opts = {
1368
+ _alias: '_alias_example', # String | Filter on numbers based on the formatted string of the phone number.
1369
+ phone_number: 'phone_number_example' # String | PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format.
1370
+ }
1371
+
1372
+ begin
1373
+ #List available numbers
1374
+ result = api_instance.list_available_numbers(opts)
1375
+ p result
1376
+ rescue Freeclimb::ApiError => e
1377
+ puts "Exception when calling DefaultApi->list_available_numbers: #{e}"
1378
+ end
1379
+ ```
1380
+
1381
+ ### Parameters
1382
+
1383
+
1384
+ Name | Type | Description | Notes
1385
+ ------------- | ------------- | ------------- | -------------
1386
+ **_alias** | **String**| Filter on numbers based on the formatted string of the phone number. | [optional]
1387
+ **phone_number** | **String**| PCRE-compatible regular expression to filter against `phoneNumber` field, which is in E.164 format. | [optional]
1388
+
1389
+ ### Return type
1390
+
1391
+ [**AvailableNumberList**](AvailableNumberList.md)
1392
+
1393
+ ### Authorization
1394
+
1395
+ [fc](../README.md#fc)
1396
+
1397
+ ### HTTP request headers
1398
+
1399
+ - **Content-Type**: Not defined
1400
+ - **Accept**: application/json
1401
+
1402
+
1403
+ ## list_call_logs
1404
+
1405
+ > LogList list_call_logs(call_id)
1406
+
1407
+ List Call Logs
1408
+
1409
+ ### Example
1410
+
1411
+ ```ruby
1412
+ # load the gem
1413
+ require 'freeclimb'
1414
+ # setup authorization
1415
+ Freeclimb.configure do |config|
1416
+ # Configure HTTP basic authorization: fc
1417
+ config.username = 'ACCOUNT ID'
1418
+ config.password = 'AUTH TOKEN'
1419
+ end
1420
+
1421
+ api_instance = Freeclimb::DefaultApi.new
1422
+ call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
1423
+
1424
+ begin
1425
+ #List Call Logs
1426
+ result = api_instance.list_call_logs(call_id)
1427
+ p result
1428
+ rescue Freeclimb::ApiError => e
1429
+ puts "Exception when calling DefaultApi->list_call_logs: #{e}"
1430
+ end
1431
+ ```
1432
+
1433
+ ### Parameters
1434
+
1435
+
1436
+ Name | Type | Description | Notes
1437
+ ------------- | ------------- | ------------- | -------------
1438
+ **call_id** | **String**| String that uniquely identifies this call resource. |
1439
+
1440
+ ### Return type
1441
+
1442
+ [**LogList**](LogList.md)
1443
+
1444
+ ### Authorization
1445
+
1446
+ [fc](../README.md#fc)
1447
+
1448
+ ### HTTP request headers
1449
+
1450
+ - **Content-Type**: Not defined
1451
+ - **Accept**: application/json
1452
+
1453
+
1454
+ ## list_call_recordings
1455
+
1456
+ > RecordingList list_call_recordings(call_id, opts)
1457
+
1458
+ List Call Recordings
1459
+
1460
+ ### Example
1461
+
1462
+ ```ruby
1463
+ # load the gem
1464
+ require 'freeclimb'
1465
+ # setup authorization
1466
+ Freeclimb.configure do |config|
1467
+ # Configure HTTP basic authorization: fc
1468
+ config.username = 'ACCOUNT ID'
1469
+ config.password = 'AUTH TOKEN'
1470
+ end
1471
+
1472
+ api_instance = Freeclimb::DefaultApi.new
1473
+ call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
1474
+ opts = {
1475
+ date_created: 'date_created_example' # String | Only show recordings created on the specified date, in the form *YYYY-MM-DD*.
1476
+ }
1477
+
1478
+ begin
1479
+ #List Call Recordings
1480
+ result = api_instance.list_call_recordings(call_id, opts)
1481
+ p result
1482
+ rescue Freeclimb::ApiError => e
1483
+ puts "Exception when calling DefaultApi->list_call_recordings: #{e}"
1484
+ end
1485
+ ```
1486
+
1487
+ ### Parameters
1488
+
1489
+
1490
+ Name | Type | Description | Notes
1491
+ ------------- | ------------- | ------------- | -------------
1492
+ **call_id** | **String**| String that uniquely identifies this call resource. |
1493
+ **date_created** | **String**| Only show recordings created on the specified date, in the form *YYYY-MM-DD*. | [optional]
1494
+
1495
+ ### Return type
1496
+
1497
+ [**RecordingList**](RecordingList.md)
1498
+
1499
+ ### Authorization
1500
+
1501
+ [fc](../README.md#fc)
1502
+
1503
+ ### HTTP request headers
1504
+
1505
+ - **Content-Type**: Not defined
1506
+ - **Accept**: application/json
1507
+
1508
+
1509
+ ## list_calls
1510
+
1511
+ > CallList list_calls(opts)
1512
+
1513
+ List Calls
1514
+
1515
+ ### Example
1516
+
1517
+ ```ruby
1518
+ # load the gem
1519
+ require 'freeclimb'
1520
+ # setup authorization
1521
+ Freeclimb.configure do |config|
1522
+ # Configure HTTP basic authorization: fc
1523
+ config.username = 'ACCOUNT ID'
1524
+ config.password = 'AUTH TOKEN'
1525
+ end
1526
+
1527
+ api_instance = Freeclimb::DefaultApi.new
1528
+ opts = {
1529
+ to: 'to_example', # String | Only show Calls to this phone number.
1530
+ from: 'from_example', # String | Only show Calls from this phone number.
1531
+ status: 'status_example', # String | Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`.
1532
+ start_time: 'start_time_example', # String | Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss.
1533
+ end_time: 'end_time_example', # String | Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss.
1534
+ parent_call_id: 'parent_call_id_example' # String | Only show Calls spawned by the call with this ID.
1535
+ }
1536
+
1537
+ begin
1538
+ #List Calls
1539
+ result = api_instance.list_calls(opts)
1540
+ p result
1541
+ rescue Freeclimb::ApiError => e
1542
+ puts "Exception when calling DefaultApi->list_calls: #{e}"
1543
+ end
1544
+ ```
1545
+
1546
+ ### Parameters
1547
+
1548
+
1549
+ Name | Type | Description | Notes
1550
+ ------------- | ------------- | ------------- | -------------
1551
+ **to** | **String**| Only show Calls to this phone number. | [optional]
1552
+ **from** | **String**| Only show Calls from this phone number. | [optional]
1553
+ **status** | **String**| Only show Calls currently in this status. May be `queued`, `ringing`, `inProgress`, `canceled`, `completed`, `failed`, `busy`, or `noAnswer`. | [optional]
1554
+ **start_time** | **String**| Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional]
1555
+ **end_time** | **String**| Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional]
1556
+ **parent_call_id** | **String**| Only show Calls spawned by the call with this ID. | [optional]
1557
+
1558
+ ### Return type
1559
+
1560
+ [**CallList**](CallList.md)
1561
+
1562
+ ### Authorization
1563
+
1564
+ [fc](../README.md#fc)
1565
+
1566
+ ### HTTP request headers
1567
+
1568
+ - **Content-Type**: Not defined
1569
+ - **Accept**: application/json
1570
+
1571
+
1572
+ ## list_conferences
1573
+
1574
+ > ConferenceList list_conferences(opts)
1575
+
1576
+ List Conferences
1577
+
1578
+ ### Example
1579
+
1580
+ ```ruby
1581
+ # load the gem
1582
+ require 'freeclimb'
1583
+ # setup authorization
1584
+ Freeclimb.configure do |config|
1585
+ # Configure HTTP basic authorization: fc
1586
+ config.username = 'ACCOUNT ID'
1587
+ config.password = 'AUTH TOKEN'
1588
+ end
1589
+
1590
+ api_instance = Freeclimb::DefaultApi.new
1591
+ opts = {
1592
+ status: 'status_example', # String | Only show conferences that currently have the specified status. Valid values: `empty`, `populated`, `inProgress`, or `terminated`.
1593
+ _alias: '_alias_example', # String | List Conferences whose alias exactly matches this string.
1594
+ date_created: 'date_created_example', # String | Only show Conferences that were created on the specified date, in the form *YYYY-MM-DD*.
1595
+ date_updated: 'date_updated_example' # String | Only show Conferences that were last updated on the specified date, in the form *YYYY-MM-DD*.
1596
+ }
1597
+
1598
+ begin
1599
+ #List Conferences
1600
+ result = api_instance.list_conferences(opts)
1601
+ p result
1602
+ rescue Freeclimb::ApiError => e
1603
+ puts "Exception when calling DefaultApi->list_conferences: #{e}"
1604
+ end
1605
+ ```
1606
+
1607
+ ### Parameters
1608
+
1609
+
1610
+ Name | Type | Description | Notes
1611
+ ------------- | ------------- | ------------- | -------------
1612
+ **status** | **String**| Only show conferences that currently have the specified status. Valid values: `empty`, `populated`, `inProgress`, or `terminated`. | [optional]
1613
+ **_alias** | **String**| List Conferences whose alias exactly matches this string. | [optional]
1614
+ **date_created** | **String**| Only show Conferences that were created on the specified date, in the form *YYYY-MM-DD*. | [optional]
1615
+ **date_updated** | **String**| Only show Conferences that were last updated on the specified date, in the form *YYYY-MM-DD*. | [optional]
1616
+
1617
+ ### Return type
1618
+
1619
+ [**ConferenceList**](ConferenceList.md)
1620
+
1621
+ ### Authorization
1622
+
1623
+ [fc](../README.md#fc)
1624
+
1625
+ ### HTTP request headers
1626
+
1627
+ - **Content-Type**: Not defined
1628
+ - **Accept**: application/json
1629
+
1630
+
1631
+ ## list_incoming_numbers
1632
+
1633
+ > IncomingNumberList list_incoming_numbers(opts)
1634
+
1635
+ List Incoming Numbers
1636
+
1637
+ ### Example
1638
+
1639
+ ```ruby
1640
+ # load the gem
1641
+ require 'freeclimb'
1642
+ # setup authorization
1643
+ Freeclimb.configure do |config|
1644
+ # Configure HTTP basic authorization: fc
1645
+ config.username = 'ACCOUNT ID'
1646
+ config.password = 'AUTH TOKEN'
1647
+ end
1648
+
1649
+ api_instance = Freeclimb::DefaultApi.new
1650
+ opts = {
1651
+ phone_number: 'phone_number_example', # String | Only show incoming phone number resources that match this PCRE-compatible regular expression.
1652
+ _alias: '_alias_example' # String | Only show incoming phone numbers with aliases that exactly match this value.
1653
+ }
1654
+
1655
+ begin
1656
+ #List Incoming Numbers
1657
+ result = api_instance.list_incoming_numbers(opts)
1658
+ p result
1659
+ rescue Freeclimb::ApiError => e
1660
+ puts "Exception when calling DefaultApi->list_incoming_numbers: #{e}"
1661
+ end
1662
+ ```
1663
+
1664
+ ### Parameters
1665
+
1666
+
1667
+ Name | Type | Description | Notes
1668
+ ------------- | ------------- | ------------- | -------------
1669
+ **phone_number** | **String**| Only show incoming phone number resources that match this PCRE-compatible regular expression. | [optional]
1670
+ **_alias** | **String**| Only show incoming phone numbers with aliases that exactly match this value. | [optional]
1671
+
1672
+ ### Return type
1673
+
1674
+ [**IncomingNumberList**](IncomingNumberList.md)
1675
+
1676
+ ### Authorization
1677
+
1678
+ [fc](../README.md#fc)
1679
+
1680
+ ### HTTP request headers
1681
+
1682
+ - **Content-Type**: Not defined
1683
+ - **Accept**: application/json
1684
+
1685
+
1686
+ ## list_members
1687
+
1688
+ > QueueMemberList list_members(queue_id)
1689
+
1690
+ List Members
1691
+
1692
+ ### Example
1693
+
1694
+ ```ruby
1695
+ # load the gem
1696
+ require 'freeclimb'
1697
+ # setup authorization
1698
+ Freeclimb.configure do |config|
1699
+ # Configure HTTP basic authorization: fc
1700
+ config.username = 'ACCOUNT ID'
1701
+ config.password = 'AUTH TOKEN'
1702
+ end
1703
+
1704
+ api_instance = Freeclimb::DefaultApi.new
1705
+ queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
1706
+
1707
+ begin
1708
+ #List Members
1709
+ result = api_instance.list_members(queue_id)
1710
+ p result
1711
+ rescue Freeclimb::ApiError => e
1712
+ puts "Exception when calling DefaultApi->list_members: #{e}"
1713
+ end
1714
+ ```
1715
+
1716
+ ### Parameters
1717
+
1718
+
1719
+ Name | Type | Description | Notes
1720
+ ------------- | ------------- | ------------- | -------------
1721
+ **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. |
1722
+
1723
+ ### Return type
1724
+
1725
+ [**QueueMemberList**](QueueMemberList.md)
1726
+
1727
+ ### Authorization
1728
+
1729
+ [fc](../README.md#fc)
1730
+
1731
+ ### HTTP request headers
1732
+
1733
+ - **Content-Type**: Not defined
1734
+ - **Accept**: application/json
1735
+
1736
+
1737
+ ## list_participants
1738
+
1739
+ > ConferenceParticipantList list_participants(conference_id, opts)
1740
+
1741
+ List Participants
1742
+
1743
+ ### Example
1744
+
1745
+ ```ruby
1746
+ # load the gem
1747
+ require 'freeclimb'
1748
+ # setup authorization
1749
+ Freeclimb.configure do |config|
1750
+ # Configure HTTP basic authorization: fc
1751
+ config.username = 'ACCOUNT ID'
1752
+ config.password = 'AUTH TOKEN'
1753
+ end
1754
+
1755
+ api_instance = Freeclimb::DefaultApi.new
1756
+ conference_id = 'conference_id_example' # String | ID of the conference this participant is in.
1757
+ opts = {
1758
+ talk: true, # Boolean | Only show Participants with the talk privilege.
1759
+ listen: true # Boolean | Only show Participants with the listen privilege.
1760
+ }
1761
+
1762
+ begin
1763
+ #List Participants
1764
+ result = api_instance.list_participants(conference_id, opts)
1765
+ p result
1766
+ rescue Freeclimb::ApiError => e
1767
+ puts "Exception when calling DefaultApi->list_participants: #{e}"
1768
+ end
1769
+ ```
1770
+
1771
+ ### Parameters
1772
+
1773
+
1774
+ Name | Type | Description | Notes
1775
+ ------------- | ------------- | ------------- | -------------
1776
+ **conference_id** | **String**| ID of the conference this participant is in. |
1777
+ **talk** | **Boolean**| Only show Participants with the talk privilege. | [optional]
1778
+ **listen** | **Boolean**| Only show Participants with the listen privilege. | [optional]
1779
+
1780
+ ### Return type
1781
+
1782
+ [**ConferenceParticipantList**](ConferenceParticipantList.md)
1783
+
1784
+ ### Authorization
1785
+
1786
+ [fc](../README.md#fc)
1787
+
1788
+ ### HTTP request headers
1789
+
1790
+ - **Content-Type**: Not defined
1791
+ - **Accept**: application/json
1792
+
1793
+
1794
+ ## list_recordings
1795
+
1796
+ > RecordingList list_recordings(opts)
1797
+
1798
+ List Recordings
1799
+
1800
+ ### Example
1801
+
1802
+ ```ruby
1803
+ # load the gem
1804
+ require 'freeclimb'
1805
+ # setup authorization
1806
+ Freeclimb.configure do |config|
1807
+ # Configure HTTP basic authorization: fc
1808
+ config.username = 'ACCOUNT ID'
1809
+ config.password = 'AUTH TOKEN'
1810
+ end
1811
+
1812
+ api_instance = Freeclimb::DefaultApi.new
1813
+ opts = {
1814
+ call_id: 'call_id_example', # String | Show only Recordings made during the Call with this ID.
1815
+ conference_id: 'conference_id_example', # String | Show only Recordings made during the conference with this ID.
1816
+ date_created: 'date_created_example' # String | Only show Recordings created on this date, formatted as *YYYY-MM-DD*.
1817
+ }
1818
+
1819
+ begin
1820
+ #List Recordings
1821
+ result = api_instance.list_recordings(opts)
1822
+ p result
1823
+ rescue Freeclimb::ApiError => e
1824
+ puts "Exception when calling DefaultApi->list_recordings: #{e}"
1825
+ end
1826
+ ```
1827
+
1828
+ ### Parameters
1829
+
1830
+
1831
+ Name | Type | Description | Notes
1832
+ ------------- | ------------- | ------------- | -------------
1833
+ **call_id** | **String**| Show only Recordings made during the Call with this ID. | [optional]
1834
+ **conference_id** | **String**| Show only Recordings made during the conference with this ID. | [optional]
1835
+ **date_created** | **String**| Only show Recordings created on this date, formatted as *YYYY-MM-DD*. | [optional]
1836
+
1837
+ ### Return type
1838
+
1839
+ [**RecordingList**](RecordingList.md)
1840
+
1841
+ ### Authorization
1842
+
1843
+ [fc](../README.md#fc)
1844
+
1845
+ ### HTTP request headers
1846
+
1847
+ - **Content-Type**: Not defined
1848
+ - **Accept**: application/json
1849
+
1850
+
1851
+ ## list_sms_messages
1852
+
1853
+ > MessagesList list_sms_messages(opts)
1854
+
1855
+ List SMS Messages
1856
+
1857
+ ### Example
1858
+
1859
+ ```ruby
1860
+ # load the gem
1861
+ require 'freeclimb'
1862
+ # setup authorization
1863
+ Freeclimb.configure do |config|
1864
+ # Configure HTTP basic authorization: fc
1865
+ config.username = 'ACCOUNT ID'
1866
+ config.password = 'AUTH TOKEN'
1867
+ end
1868
+
1869
+ api_instance = Freeclimb::DefaultApi.new
1870
+ opts = {
1871
+ to: 'to_example', # String | Only show Messages to this phone number.
1872
+ from: 'from_example', # String | Only show Messages from this phone number.
1873
+ begin_time: 'begin_time_example', # String | Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*.
1874
+ end_time: 'end_time_example', # String | Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*..
1875
+ direction: 'direction_example', # String | Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb.
1876
+ account_id: 'account_id_example' # String | String that uniquely identifies this account resource.
1877
+ }
1878
+
1879
+ begin
1880
+ #List SMS Messages
1881
+ result = api_instance.list_sms_messages(opts)
1882
+ p result
1883
+ rescue Freeclimb::ApiError => e
1884
+ puts "Exception when calling DefaultApi->list_sms_messages: #{e}"
1885
+ end
1886
+ ```
1887
+
1888
+ ### Parameters
1889
+
1890
+
1891
+ Name | Type | Description | Notes
1892
+ ------------- | ------------- | ------------- | -------------
1893
+ **to** | **String**| Only show Messages to this phone number. | [optional]
1894
+ **from** | **String**| Only show Messages from this phone number. | [optional]
1895
+ **begin_time** | **String**| Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*. | [optional]
1896
+ **end_time** | **String**| Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*.. | [optional]
1897
+ **direction** | **String**| Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb. | [optional]
1898
+ **account_id** | **String**| String that uniquely identifies this account resource. | [optional]
1899
+
1900
+ ### Return type
1901
+
1902
+ [**MessagesList**](MessagesList.md)
1903
+
1904
+ ### Authorization
1905
+
1906
+ [fc](../README.md#fc)
1907
+
1908
+ ### HTTP request headers
1909
+
1910
+ - **Content-Type**: Not defined
1911
+ - **Accept**: application/json
1912
+
1913
+
1914
+ ## make_a_call
1915
+
1916
+ > CallResult make_a_call(opts)
1917
+
1918
+ Make a Call
1919
+
1920
+ ### Example
1921
+
1922
+ ```ruby
1923
+ # load the gem
1924
+ require 'freeclimb'
1925
+ # setup authorization
1926
+ Freeclimb.configure do |config|
1927
+ # Configure HTTP basic authorization: fc
1928
+ config.username = 'ACCOUNT ID'
1929
+ config.password = 'AUTH TOKEN'
1930
+ end
1931
+
1932
+ api_instance = Freeclimb::DefaultApi.new
1933
+ opts = {
1934
+ make_call_request: Freeclimb::MakeCallRequest.new # MakeCallRequest | Call details for making a call
1935
+ }
1936
+
1937
+ begin
1938
+ #Make a Call
1939
+ result = api_instance.make_a_call(opts)
1940
+ p result
1941
+ rescue Freeclimb::ApiError => e
1942
+ puts "Exception when calling DefaultApi->make_a_call: #{e}"
1943
+ end
1944
+ ```
1945
+
1946
+ ### Parameters
1947
+
1948
+
1949
+ Name | Type | Description | Notes
1950
+ ------------- | ------------- | ------------- | -------------
1951
+ **make_call_request** | [**MakeCallRequest**](MakeCallRequest.md)| Call details for making a call | [optional]
1952
+
1953
+ ### Return type
1954
+
1955
+ [**CallResult**](CallResult.md)
1956
+
1957
+ ### Authorization
1958
+
1959
+ [fc](../README.md#fc)
1960
+
1961
+ ### HTTP request headers
1962
+
1963
+ - **Content-Type**: application/json
1964
+ - **Accept**: application/json
1965
+
1966
+
1967
+ ## remove_a_participant
1968
+
1969
+ > remove_a_participant(conference_id, call_id)
1970
+
1971
+ Remove a Participant
1972
+
1973
+ ### Example
1974
+
1975
+ ```ruby
1976
+ # load the gem
1977
+ require 'freeclimb'
1978
+ # setup authorization
1979
+ Freeclimb.configure do |config|
1980
+ # Configure HTTP basic authorization: fc
1981
+ config.username = 'ACCOUNT ID'
1982
+ config.password = 'AUTH TOKEN'
1983
+ end
1984
+
1985
+ api_instance = Freeclimb::DefaultApi.new
1986
+ conference_id = 'conference_id_example' # String | ID of the conference this participant is in.
1987
+ call_id = 'call_id_example' # String | ID of the Call associated with this participant.
1988
+
1989
+ begin
1990
+ #Remove a Participant
1991
+ api_instance.remove_a_participant(conference_id, call_id)
1992
+ rescue Freeclimb::ApiError => e
1993
+ puts "Exception when calling DefaultApi->remove_a_participant: #{e}"
1994
+ end
1995
+ ```
1996
+
1997
+ ### Parameters
1998
+
1999
+
2000
+ Name | Type | Description | Notes
2001
+ ------------- | ------------- | ------------- | -------------
2002
+ **conference_id** | **String**| ID of the conference this participant is in. |
2003
+ **call_id** | **String**| ID of the Call associated with this participant. |
2004
+
2005
+ ### Return type
2006
+
2007
+ nil (empty response body)
2008
+
2009
+ ### Authorization
2010
+
2011
+ [fc](../README.md#fc)
2012
+
2013
+ ### HTTP request headers
2014
+
2015
+ - **Content-Type**: Not defined
2016
+ - **Accept**: Not defined
2017
+
2018
+
2019
+ ## send_an_sms_message
2020
+
2021
+ > MessageResult send_an_sms_message(opts)
2022
+
2023
+ Send an SMS Message
2024
+
2025
+ ### Example
2026
+
2027
+ ```ruby
2028
+ # load the gem
2029
+ require 'freeclimb'
2030
+ # setup authorization
2031
+ Freeclimb.configure do |config|
2032
+ # Configure HTTP basic authorization: fc
2033
+ config.username = 'ACCOUNT ID'
2034
+ config.password = 'AUTH TOKEN'
2035
+ end
2036
+
2037
+ api_instance = Freeclimb::DefaultApi.new
2038
+ opts = {
2039
+ message_request: Freeclimb::MessageRequest.new # MessageRequest | Details to create a message
2040
+ }
2041
+
2042
+ begin
2043
+ #Send an SMS Message
2044
+ result = api_instance.send_an_sms_message(opts)
2045
+ p result
2046
+ rescue Freeclimb::ApiError => e
2047
+ puts "Exception when calling DefaultApi->send_an_sms_message: #{e}"
2048
+ end
2049
+ ```
2050
+
2051
+ ### Parameters
2052
+
2053
+
2054
+ Name | Type | Description | Notes
2055
+ ------------- | ------------- | ------------- | -------------
2056
+ **message_request** | [**MessageRequest**](MessageRequest.md)| Details to create a message | [optional]
2057
+
2058
+ ### Return type
2059
+
2060
+ [**MessageResult**](MessageResult.md)
2061
+
2062
+ ### Authorization
2063
+
2064
+ [fc](../README.md#fc)
2065
+
2066
+ ### HTTP request headers
2067
+
2068
+ - **Content-Type**: application/json
2069
+ - **Accept**: application/json
2070
+
2071
+
2072
+ ## stream_a_recording_file
2073
+
2074
+ > File stream_a_recording_file(recording_id)
2075
+
2076
+ Stream a Recording File
2077
+
2078
+ ### Example
2079
+
2080
+ ```ruby
2081
+ # load the gem
2082
+ require 'freeclimb'
2083
+ # setup authorization
2084
+ Freeclimb.configure do |config|
2085
+ # Configure HTTP basic authorization: fc
2086
+ config.username = 'ACCOUNT ID'
2087
+ config.password = 'AUTH TOKEN'
2088
+ end
2089
+
2090
+ api_instance = Freeclimb::DefaultApi.new
2091
+ recording_id = 'recording_id_example' # String | String that uniquely identifies this recording resource.
2092
+
2093
+ begin
2094
+ #Stream a Recording File
2095
+ result = api_instance.stream_a_recording_file(recording_id)
2096
+ p result
2097
+ rescue Freeclimb::ApiError => e
2098
+ puts "Exception when calling DefaultApi->stream_a_recording_file: #{e}"
2099
+ end
2100
+ ```
2101
+
2102
+ ### Parameters
2103
+
2104
+
2105
+ Name | Type | Description | Notes
2106
+ ------------- | ------------- | ------------- | -------------
2107
+ **recording_id** | **String**| String that uniquely identifies this recording resource. |
2108
+
2109
+ ### Return type
2110
+
2111
+ **File**
2112
+
2113
+ ### Authorization
2114
+
2115
+ [fc](../README.md#fc)
2116
+
2117
+ ### HTTP request headers
2118
+
2119
+ - **Content-Type**: Not defined
2120
+ - **Accept**: audio/x-wav
2121
+
2122
+
2123
+ ## update_a_conference
2124
+
2125
+ > ConferenceResult update_a_conference(conference_id, opts)
2126
+
2127
+ Update a Conference
2128
+
2129
+ ### Example
2130
+
2131
+ ```ruby
2132
+ # load the gem
2133
+ require 'freeclimb'
2134
+ # setup authorization
2135
+ Freeclimb.configure do |config|
2136
+ # Configure HTTP basic authorization: fc
2137
+ config.username = 'ACCOUNT ID'
2138
+ config.password = 'AUTH TOKEN'
2139
+ end
2140
+
2141
+ api_instance = Freeclimb::DefaultApi.new
2142
+ conference_id = 'conference_id_example' # String | String that uniquely identifies this conference resource.
2143
+ opts = {
2144
+ update_conference_request: Freeclimb::UpdateConferenceRequest.new # UpdateConferenceRequest | Conference Details to update
2145
+ }
2146
+
2147
+ begin
2148
+ #Update a Conference
2149
+ result = api_instance.update_a_conference(conference_id, opts)
2150
+ p result
2151
+ rescue Freeclimb::ApiError => e
2152
+ puts "Exception when calling DefaultApi->update_a_conference: #{e}"
2153
+ end
2154
+ ```
2155
+
2156
+ ### Parameters
2157
+
2158
+
2159
+ Name | Type | Description | Notes
2160
+ ------------- | ------------- | ------------- | -------------
2161
+ **conference_id** | **String**| String that uniquely identifies this conference resource. |
2162
+ **update_conference_request** | [**UpdateConferenceRequest**](UpdateConferenceRequest.md)| Conference Details to update | [optional]
2163
+
2164
+ ### Return type
2165
+
2166
+ [**ConferenceResult**](ConferenceResult.md)
2167
+
2168
+ ### Authorization
2169
+
2170
+ [fc](../README.md#fc)
2171
+
2172
+ ### HTTP request headers
2173
+
2174
+ - **Content-Type**: application/json
2175
+ - **Accept**: application/json
2176
+
2177
+
2178
+ ## update_a_live_call
2179
+
2180
+ > update_a_live_call(call_id, opts)
2181
+
2182
+ Update a Live Call
2183
+
2184
+ ### Example
2185
+
2186
+ ```ruby
2187
+ # load the gem
2188
+ require 'freeclimb'
2189
+ # setup authorization
2190
+ Freeclimb.configure do |config|
2191
+ # Configure HTTP basic authorization: fc
2192
+ config.username = 'ACCOUNT ID'
2193
+ config.password = 'AUTH TOKEN'
2194
+ end
2195
+
2196
+ api_instance = Freeclimb::DefaultApi.new
2197
+ call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
2198
+ opts = {
2199
+ update_call_request: Freeclimb::UpdateCallRequest.new # UpdateCallRequest | Call details to update
2200
+ }
2201
+
2202
+ begin
2203
+ #Update a Live Call
2204
+ api_instance.update_a_live_call(call_id, opts)
2205
+ rescue Freeclimb::ApiError => e
2206
+ puts "Exception when calling DefaultApi->update_a_live_call: #{e}"
2207
+ end
2208
+ ```
2209
+
2210
+ ### Parameters
2211
+
2212
+
2213
+ Name | Type | Description | Notes
2214
+ ------------- | ------------- | ------------- | -------------
2215
+ **call_id** | **String**| String that uniquely identifies this call resource. |
2216
+ **update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md)| Call details to update | [optional]
2217
+
2218
+ ### Return type
2219
+
2220
+ nil (empty response body)
2221
+
2222
+ ### Authorization
2223
+
2224
+ [fc](../README.md#fc)
2225
+
2226
+ ### HTTP request headers
2227
+
2228
+ - **Content-Type**: application/json
2229
+ - **Accept**: Not defined
2230
+
2231
+
2232
+ ## update_a_participant
2233
+
2234
+ > ConferenceParticipantResult update_a_participant(conference_id, call_id, opts)
2235
+
2236
+ Update a Participant
2237
+
2238
+ ### Example
2239
+
2240
+ ```ruby
2241
+ # load the gem
2242
+ require 'freeclimb'
2243
+ # setup authorization
2244
+ Freeclimb.configure do |config|
2245
+ # Configure HTTP basic authorization: fc
2246
+ config.username = 'ACCOUNT ID'
2247
+ config.password = 'AUTH TOKEN'
2248
+ end
2249
+
2250
+ api_instance = Freeclimb::DefaultApi.new
2251
+ conference_id = 'conference_id_example' # String | ID of the conference this participant is in.
2252
+ call_id = 'call_id_example' # String | ID of the Call associated with this participant.
2253
+ opts = {
2254
+ update_conference_participant_request: Freeclimb::UpdateConferenceParticipantRequest.new # UpdateConferenceParticipantRequest | Conference participant details to update
2255
+ }
2256
+
2257
+ begin
2258
+ #Update a Participant
2259
+ result = api_instance.update_a_participant(conference_id, call_id, opts)
2260
+ p result
2261
+ rescue Freeclimb::ApiError => e
2262
+ puts "Exception when calling DefaultApi->update_a_participant: #{e}"
2263
+ end
2264
+ ```
2265
+
2266
+ ### Parameters
2267
+
2268
+
2269
+ Name | Type | Description | Notes
2270
+ ------------- | ------------- | ------------- | -------------
2271
+ **conference_id** | **String**| ID of the conference this participant is in. |
2272
+ **call_id** | **String**| ID of the Call associated with this participant. |
2273
+ **update_conference_participant_request** | [**UpdateConferenceParticipantRequest**](UpdateConferenceParticipantRequest.md)| Conference participant details to update | [optional]
2274
+
2275
+ ### Return type
2276
+
2277
+ [**ConferenceParticipantResult**](ConferenceParticipantResult.md)
2278
+
2279
+ ### Authorization
2280
+
2281
+ [fc](../README.md#fc)
2282
+
2283
+ ### HTTP request headers
2284
+
2285
+ - **Content-Type**: application/json
2286
+ - **Accept**: application/json
2287
+
2288
+
2289
+ ## update_a_queue
2290
+
2291
+ > QueueResult update_a_queue(queue_id, opts)
2292
+
2293
+ Update a Queue
2294
+
2295
+ ### Example
2296
+
2297
+ ```ruby
2298
+ # load the gem
2299
+ require 'freeclimb'
2300
+ # setup authorization
2301
+ Freeclimb.configure do |config|
2302
+ # Configure HTTP basic authorization: fc
2303
+ config.username = 'ACCOUNT ID'
2304
+ config.password = 'AUTH TOKEN'
2305
+ end
2306
+
2307
+ api_instance = Freeclimb::DefaultApi.new
2308
+ queue_id = 'queue_id_example' # String | A string that uniquely identifies this Queue resource.
2309
+ opts = {
2310
+ queue_request: Freeclimb::QueueRequest.new # QueueRequest | Queue Details to update
2311
+ }
2312
+
2313
+ begin
2314
+ #Update a Queue
2315
+ result = api_instance.update_a_queue(queue_id, opts)
2316
+ p result
2317
+ rescue Freeclimb::ApiError => e
2318
+ puts "Exception when calling DefaultApi->update_a_queue: #{e}"
2319
+ end
2320
+ ```
2321
+
2322
+ ### Parameters
2323
+
2324
+
2325
+ Name | Type | Description | Notes
2326
+ ------------- | ------------- | ------------- | -------------
2327
+ **queue_id** | **String**| A string that uniquely identifies this Queue resource. |
2328
+ **queue_request** | [**QueueRequest**](QueueRequest.md)| Queue Details to update | [optional]
2329
+
2330
+ ### Return type
2331
+
2332
+ [**QueueResult**](QueueResult.md)
2333
+
2334
+ ### Authorization
2335
+
2336
+ [fc](../README.md#fc)
2337
+
2338
+ ### HTTP request headers
2339
+
2340
+ - **Content-Type**: application/json
2341
+ - **Accept**: application/json
2342
+
2343
+
2344
+ ## update_an_account
2345
+
2346
+ > update_an_account(opts)
2347
+
2348
+ Manage an account
2349
+
2350
+ ### Example
2351
+
2352
+ ```ruby
2353
+ # load the gem
2354
+ require 'freeclimb'
2355
+ # setup authorization
2356
+ Freeclimb.configure do |config|
2357
+ # Configure HTTP basic authorization: fc
2358
+ config.username = 'ACCOUNT ID'
2359
+ config.password = 'AUTH TOKEN'
2360
+ end
2361
+
2362
+ api_instance = Freeclimb::DefaultApi.new
2363
+ opts = {
2364
+ account_request: Freeclimb::AccountRequest.new # AccountRequest | Account details to update
2365
+ }
2366
+
2367
+ begin
2368
+ #Manage an account
2369
+ api_instance.update_an_account(opts)
2370
+ rescue Freeclimb::ApiError => e
2371
+ puts "Exception when calling DefaultApi->update_an_account: #{e}"
2372
+ end
2373
+ ```
2374
+
2375
+ ### Parameters
2376
+
2377
+
2378
+ Name | Type | Description | Notes
2379
+ ------------- | ------------- | ------------- | -------------
2380
+ **account_request** | [**AccountRequest**](AccountRequest.md)| Account details to update | [optional]
2381
+
2382
+ ### Return type
2383
+
2384
+ nil (empty response body)
2385
+
2386
+ ### Authorization
2387
+
2388
+ [fc](../README.md#fc)
2389
+
2390
+ ### HTTP request headers
2391
+
2392
+ - **Content-Type**: application/json
2393
+ - **Accept**: Not defined
2394
+
2395
+
2396
+ ## update_an_application
2397
+
2398
+ > ApplicationResult update_an_application(application_id, opts)
2399
+
2400
+ Update an application
2401
+
2402
+ ### Example
2403
+
2404
+ ```ruby
2405
+ # load the gem
2406
+ require 'freeclimb'
2407
+ # setup authorization
2408
+ Freeclimb.configure do |config|
2409
+ # Configure HTTP basic authorization: fc
2410
+ config.username = 'ACCOUNT ID'
2411
+ config.password = 'AUTH TOKEN'
2412
+ end
2413
+
2414
+ api_instance = Freeclimb::DefaultApi.new
2415
+ application_id = 'application_id_example' # String | A string that uniquely identifies this application resource.
2416
+ opts = {
2417
+ application_request: Freeclimb::ApplicationRequest.new # ApplicationRequest | Application details to update.
2418
+ }
2419
+
2420
+ begin
2421
+ #Update an application
2422
+ result = api_instance.update_an_application(application_id, opts)
2423
+ p result
2424
+ rescue Freeclimb::ApiError => e
2425
+ puts "Exception when calling DefaultApi->update_an_application: #{e}"
2426
+ end
2427
+ ```
2428
+
2429
+ ### Parameters
2430
+
2431
+
2432
+ Name | Type | Description | Notes
2433
+ ------------- | ------------- | ------------- | -------------
2434
+ **application_id** | **String**| A string that uniquely identifies this application resource. |
2435
+ **application_request** | [**ApplicationRequest**](ApplicationRequest.md)| Application details to update. | [optional]
2436
+
2437
+ ### Return type
2438
+
2439
+ [**ApplicationResult**](ApplicationResult.md)
2440
+
2441
+ ### Authorization
2442
+
2443
+ [fc](../README.md#fc)
2444
+
2445
+ ### HTTP request headers
2446
+
2447
+ - **Content-Type**: application/json
2448
+ - **Accept**: application/json
2449
+
2450
+
2451
+ ## update_an_incoming_number
2452
+
2453
+ > IncomingNumberResult update_an_incoming_number(phone_number_id, opts)
2454
+
2455
+ Update an Incoming Number
2456
+
2457
+ ### Example
2458
+
2459
+ ```ruby
2460
+ # load the gem
2461
+ require 'freeclimb'
2462
+ # setup authorization
2463
+ Freeclimb.configure do |config|
2464
+ # Configure HTTP basic authorization: fc
2465
+ config.username = 'ACCOUNT ID'
2466
+ config.password = 'AUTH TOKEN'
2467
+ end
2468
+
2469
+ api_instance = Freeclimb::DefaultApi.new
2470
+ phone_number_id = 'phone_number_id_example' # String | String that uniquely identifies this phone number resource.
2471
+ opts = {
2472
+ incoming_number_request: Freeclimb::IncomingNumberRequest.new # IncomingNumberRequest | Incoming Number details to update
2473
+ }
2474
+
2475
+ begin
2476
+ #Update an Incoming Number
2477
+ result = api_instance.update_an_incoming_number(phone_number_id, opts)
2478
+ p result
2479
+ rescue Freeclimb::ApiError => e
2480
+ puts "Exception when calling DefaultApi->update_an_incoming_number: #{e}"
2481
+ end
2482
+ ```
2483
+
2484
+ ### Parameters
2485
+
2486
+
2487
+ Name | Type | Description | Notes
2488
+ ------------- | ------------- | ------------- | -------------
2489
+ **phone_number_id** | **String**| String that uniquely identifies this phone number resource. |
2490
+ **incoming_number_request** | [**IncomingNumberRequest**](IncomingNumberRequest.md)| Incoming Number details to update | [optional]
2491
+
2492
+ ### Return type
2493
+
2494
+ [**IncomingNumberResult**](IncomingNumberResult.md)
2495
+
2496
+ ### Authorization
2497
+
2498
+ [fc](../README.md#fc)
2499
+
2500
+ ### HTTP request headers
2501
+
2502
+ - **Content-Type**: application/json
2503
+ - **Accept**: application/json
2504
+