freeclimb 3.0.2 → 3.0.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +6 -0
- data/Gemfile +4 -1
- data/Gemfile.lock +41 -20
- data/README.md +34 -33
- data/docs/AccountRequest.md +9 -8
- data/docs/AccountResult.md +27 -26
- data/docs/AccountResultAllOf.md +19 -18
- data/docs/AddToConference.md +25 -24
- data/docs/AddToConferenceAllOf.md +25 -24
- data/docs/ApplicationList.md +21 -20
- data/docs/ApplicationListAllOf.md +7 -6
- data/docs/ApplicationRequest.md +19 -18
- data/docs/ApplicationResult.md +31 -30
- data/docs/ApplicationResultAllOf.md +23 -22
- data/docs/AvailableNumber.md +17 -14
- data/docs/AvailableNumberList.md +21 -20
- data/docs/AvailableNumberListAllOf.md +7 -6
- data/docs/BuyIncomingNumberRequest.md +11 -10
- data/docs/CallList.md +21 -20
- data/docs/CallListAllOf.md +7 -6
- data/docs/CallResult.md +43 -42
- data/docs/CallResultAllOf.md +35 -34
- data/docs/Capabilities.md +26 -0
- data/docs/ConferenceList.md +21 -20
- data/docs/ConferenceListAllOf.md +7 -6
- data/docs/ConferenceParticipantList.md +21 -20
- data/docs/ConferenceParticipantListAllOf.md +7 -6
- data/docs/ConferenceParticipantResult.md +25 -24
- data/docs/ConferenceParticipantResultAllOf.md +17 -16
- data/docs/ConferenceResult.md +33 -32
- data/docs/ConferenceResultAllOf.md +25 -24
- data/docs/CreateConference.md +17 -16
- data/docs/CreateConferenceAllOf.md +17 -16
- data/docs/CreateConferenceRequest.md +15 -14
- data/docs/DefaultApi.md +1670 -600
- data/docs/Dequeue.md +3 -4
- data/docs/Enqueue.md +13 -12
- data/docs/EnqueueAllOf.md +13 -12
- data/docs/FilterLogsRequest.md +7 -6
- data/docs/GetDigits.md +23 -22
- data/docs/GetDigitsAllOf.md +23 -22
- data/docs/GetSpeech.md +31 -30
- data/docs/GetSpeechAllOf.md +31 -30
- data/docs/Hangup.md +7 -6
- data/docs/HangupAllOf.md +7 -6
- data/docs/IncomingNumberList.md +21 -20
- data/docs/IncomingNumberListAllOf.md +7 -6
- data/docs/IncomingNumberRequest.md +9 -8
- data/docs/IncomingNumberResult.md +33 -30
- data/docs/IncomingNumberResultAllOf.md +25 -22
- data/docs/LogList.md +21 -20
- data/docs/LogListAllOf.md +7 -6
- data/docs/LogResult.md +19 -18
- data/docs/MakeCallRequest.md +25 -24
- data/docs/MessageRequest.md +23 -22
- data/docs/MessageRequestAllOf.md +15 -14
- data/docs/MessageResult.md +29 -28
- data/docs/MessageResultAllOf.md +21 -20
- data/docs/MessagesList.md +21 -20
- data/docs/MessagesListAllOf.md +7 -6
- data/docs/MutableResourceModel.md +13 -12
- data/docs/OutDial.md +25 -24
- data/docs/OutDialAllOf.md +25 -24
- data/docs/PaginationModel.md +19 -18
- data/docs/Pause.md +7 -6
- data/docs/PauseAllOf.md +7 -6
- data/docs/PerclCommand.md +7 -6
- data/docs/PerclScript.md +7 -6
- data/docs/Play.md +13 -12
- data/docs/PlayAllOf.md +13 -12
- data/docs/PlayEarlyMedia.md +7 -6
- data/docs/PlayEarlyMediaAllOf.md +7 -6
- data/docs/QueueList.md +21 -20
- data/docs/QueueListAllOf.md +7 -6
- data/docs/QueueMember.md +15 -14
- data/docs/QueueMemberList.md +21 -20
- data/docs/QueueMemberListAllOf.md +7 -6
- data/docs/QueueRequest.md +9 -8
- data/docs/QueueResult.md +27 -26
- data/docs/QueueResultAllOf.md +19 -18
- data/docs/RecordUtterance.md +19 -18
- data/docs/RecordUtteranceAllOf.md +19 -18
- data/docs/RecordingList.md +21 -20
- data/docs/RecordingListAllOf.md +7 -6
- data/docs/RecordingResult.md +23 -22
- data/docs/RecordingResultAllOf.md +15 -14
- data/docs/Redirect.md +7 -6
- data/docs/RedirectAllOf.md +7 -6
- data/docs/Reject.md +7 -6
- data/docs/RejectAllOf.md +7 -6
- data/docs/RemoveFromConference.md +7 -6
- data/docs/RemoveFromConferenceAllOf.md +7 -6
- data/docs/Say.md +15 -14
- data/docs/SayAllOf.md +15 -14
- data/docs/SendDigits.md +11 -10
- data/docs/SendDigitsAllOf.md +11 -10
- data/docs/SetListen.md +9 -8
- data/docs/SetListenAllOf.md +9 -8
- data/docs/SetTalk.md +9 -8
- data/docs/SetTalkAllOf.md +9 -8
- data/docs/Sms.md +13 -12
- data/docs/SmsAllOf.md +13 -12
- data/docs/StartRecordCall.md +3 -4
- data/docs/TerminateConference.md +7 -6
- data/docs/TerminateConferenceAllOf.md +7 -6
- data/docs/UpdateCallRequest.md +7 -6
- data/docs/UpdateConferenceParticipantRequest.md +9 -8
- data/docs/UpdateConferenceRequest.md +11 -10
- data/freeclimb.gemspec +2 -3
- data/lib/freeclimb/api/default_api.rb +424 -272
- data/lib/freeclimb/api_client.rb +54 -50
- data/lib/freeclimb/api_error.rb +1 -1
- data/lib/freeclimb/configuration.rb +40 -10
- data/lib/freeclimb/models/account_request.rb +19 -7
- data/lib/freeclimb/models/account_result.rb +19 -7
- data/lib/freeclimb/models/account_result_all_of.rb +19 -7
- data/lib/freeclimb/models/add_to_conference.rb +19 -7
- data/lib/freeclimb/models/add_to_conference_all_of.rb +19 -7
- data/lib/freeclimb/models/application_list.rb +19 -7
- data/lib/freeclimb/models/application_list_all_of.rb +19 -7
- data/lib/freeclimb/models/application_request.rb +19 -7
- data/lib/freeclimb/models/application_result.rb +19 -7
- data/lib/freeclimb/models/application_result_all_of.rb +19 -7
- data/lib/freeclimb/models/available_number.rb +29 -8
- data/lib/freeclimb/models/available_number_list.rb +19 -7
- data/lib/freeclimb/models/available_number_list_all_of.rb +19 -7
- data/lib/freeclimb/models/buy_incoming_number_request.rb +19 -7
- data/lib/freeclimb/models/call_list.rb +19 -7
- data/lib/freeclimb/models/call_list_all_of.rb +19 -7
- data/lib/freeclimb/models/call_result.rb +19 -7
- data/lib/freeclimb/models/call_result_all_of.rb +19 -7
- data/lib/freeclimb/models/capabilities.rb +285 -0
- data/lib/freeclimb/models/conference_list.rb +19 -7
- data/lib/freeclimb/models/conference_list_all_of.rb +19 -7
- data/lib/freeclimb/models/conference_participant_list.rb +19 -7
- data/lib/freeclimb/models/conference_participant_list_all_of.rb +19 -7
- data/lib/freeclimb/models/conference_participant_result.rb +19 -7
- data/lib/freeclimb/models/conference_participant_result_all_of.rb +19 -7
- data/lib/freeclimb/models/conference_result.rb +19 -7
- data/lib/freeclimb/models/conference_result_all_of.rb +19 -7
- data/lib/freeclimb/models/create_conference.rb +19 -7
- data/lib/freeclimb/models/create_conference_all_of.rb +19 -7
- data/lib/freeclimb/models/create_conference_request.rb +19 -7
- data/lib/freeclimb/models/dequeue.rb +19 -7
- data/lib/freeclimb/models/enqueue.rb +19 -7
- data/lib/freeclimb/models/enqueue_all_of.rb +19 -7
- data/lib/freeclimb/models/filter_logs_request.rb +19 -7
- data/lib/freeclimb/models/get_digits.rb +19 -7
- data/lib/freeclimb/models/get_digits_all_of.rb +19 -7
- data/lib/freeclimb/models/get_speech.rb +19 -7
- data/lib/freeclimb/models/get_speech_all_of.rb +19 -7
- data/lib/freeclimb/models/hangup.rb +19 -7
- data/lib/freeclimb/models/hangup_all_of.rb +19 -7
- data/lib/freeclimb/models/incoming_number_list.rb +19 -7
- data/lib/freeclimb/models/incoming_number_list_all_of.rb +19 -7
- data/lib/freeclimb/models/incoming_number_request.rb +19 -7
- data/lib/freeclimb/models/incoming_number_result.rb +29 -8
- data/lib/freeclimb/models/incoming_number_result_all_of.rb +29 -8
- data/lib/freeclimb/models/log_list.rb +19 -7
- data/lib/freeclimb/models/log_list_all_of.rb +19 -7
- data/lib/freeclimb/models/log_result.rb +19 -7
- data/lib/freeclimb/models/make_call_request.rb +19 -7
- data/lib/freeclimb/models/message_request.rb +19 -7
- data/lib/freeclimb/models/message_request_all_of.rb +19 -7
- data/lib/freeclimb/models/message_result.rb +19 -7
- data/lib/freeclimb/models/message_result_all_of.rb +19 -7
- data/lib/freeclimb/models/messages_list.rb +19 -7
- data/lib/freeclimb/models/messages_list_all_of.rb +19 -7
- data/lib/freeclimb/models/mutable_resource_model.rb +19 -7
- data/lib/freeclimb/models/out_dial.rb +19 -7
- data/lib/freeclimb/models/out_dial_all_of.rb +19 -7
- data/lib/freeclimb/models/pagination_model.rb +19 -7
- data/lib/freeclimb/models/pause.rb +19 -7
- data/lib/freeclimb/models/pause_all_of.rb +19 -7
- data/lib/freeclimb/models/percl_command.rb +19 -7
- data/lib/freeclimb/models/percl_script.rb +19 -7
- data/lib/freeclimb/models/play.rb +19 -7
- data/lib/freeclimb/models/play_all_of.rb +19 -7
- data/lib/freeclimb/models/play_early_media.rb +19 -7
- data/lib/freeclimb/models/play_early_media_all_of.rb +19 -7
- data/lib/freeclimb/models/queue_list.rb +19 -7
- data/lib/freeclimb/models/queue_list_all_of.rb +19 -7
- data/lib/freeclimb/models/queue_member.rb +19 -7
- data/lib/freeclimb/models/queue_member_list.rb +19 -7
- data/lib/freeclimb/models/queue_member_list_all_of.rb +19 -7
- data/lib/freeclimb/models/queue_request.rb +19 -7
- data/lib/freeclimb/models/queue_result.rb +19 -7
- data/lib/freeclimb/models/queue_result_all_of.rb +19 -7
- data/lib/freeclimb/models/record_utterance.rb +19 -7
- data/lib/freeclimb/models/record_utterance_all_of.rb +19 -7
- data/lib/freeclimb/models/recording_list.rb +19 -7
- data/lib/freeclimb/models/recording_list_all_of.rb +19 -7
- data/lib/freeclimb/models/recording_result.rb +19 -7
- data/lib/freeclimb/models/recording_result_all_of.rb +19 -7
- data/lib/freeclimb/models/redirect.rb +19 -7
- data/lib/freeclimb/models/redirect_all_of.rb +19 -7
- data/lib/freeclimb/models/reject.rb +19 -7
- data/lib/freeclimb/models/reject_all_of.rb +19 -7
- data/lib/freeclimb/models/remove_from_conference.rb +19 -7
- data/lib/freeclimb/models/remove_from_conference_all_of.rb +19 -7
- data/lib/freeclimb/models/say.rb +19 -7
- data/lib/freeclimb/models/say_all_of.rb +19 -7
- data/lib/freeclimb/models/send_digits.rb +19 -7
- data/lib/freeclimb/models/send_digits_all_of.rb +19 -7
- data/lib/freeclimb/models/set_listen.rb +19 -7
- data/lib/freeclimb/models/set_listen_all_of.rb +19 -7
- data/lib/freeclimb/models/set_talk.rb +19 -7
- data/lib/freeclimb/models/set_talk_all_of.rb +19 -7
- data/lib/freeclimb/models/sms.rb +19 -7
- data/lib/freeclimb/models/sms_all_of.rb +19 -7
- data/lib/freeclimb/models/start_record_call.rb +19 -7
- data/lib/freeclimb/models/terminate_conference.rb +19 -7
- data/lib/freeclimb/models/terminate_conference_all_of.rb +19 -7
- data/lib/freeclimb/models/update_call_request.rb +19 -7
- data/lib/freeclimb/models/update_conference_participant_request.rb +19 -7
- data/lib/freeclimb/models/update_conference_request.rb +19 -7
- data/lib/freeclimb/version.rb +2 -2
- data/lib/freeclimb.rb +46 -46
- data/spec/api/default_api_spec.rb +1001 -18
- data/spec/api_client_spec.rb +4 -4
- data/spec/configuration_spec.rb +9 -9
- data/spec/factories.rb +80 -0
- data/spec/models/account_request_spec.rb +4 -11
- data/spec/models/account_result_spec.rb +5 -12
- data/spec/models/add_to_conference_spec.rb +4 -11
- data/spec/models/application_list_spec.rb +4 -11
- data/spec/models/application_request_spec.rb +4 -11
- data/spec/models/application_result_spec.rb +4 -11
- data/spec/models/available_number_list_spec.rb +4 -11
- data/spec/models/available_number_spec.rb +10 -11
- data/spec/models/buy_incoming_number_request_spec.rb +4 -11
- data/spec/models/call_list_spec.rb +4 -11
- data/spec/models/call_result_spec.rb +5 -12
- data/spec/models/{say_all_of_spec.rb → capabilities_spec.rb} +12 -19
- data/spec/models/conference_list_spec.rb +4 -11
- data/spec/models/conference_participant_list_spec.rb +4 -11
- data/spec/models/conference_participant_result_spec.rb +4 -11
- data/spec/models/conference_result_spec.rb +6 -13
- data/spec/models/create_conference_request_spec.rb +5 -12
- data/spec/models/create_conference_spec.rb +4 -11
- data/spec/models/dequeue_spec.rb +4 -11
- data/spec/models/enqueue_spec.rb +4 -11
- data/spec/models/filter_logs_request_spec.rb +4 -11
- data/spec/models/get_digits_spec.rb +4 -11
- data/spec/models/get_speech_spec.rb +4 -11
- data/spec/models/hangup_spec.rb +4 -11
- data/spec/models/incoming_number_list_spec.rb +4 -11
- data/spec/models/incoming_number_request_spec.rb +4 -11
- data/spec/models/incoming_number_result_spec.rb +10 -11
- data/spec/models/log_list_spec.rb +4 -11
- data/spec/models/log_result_spec.rb +5 -12
- data/spec/models/make_call_request_spec.rb +4 -11
- data/spec/models/message_request_spec.rb +4 -11
- data/spec/models/message_result_spec.rb +5 -12
- data/spec/models/messages_list_spec.rb +4 -11
- data/spec/models/mutable_resource_model_spec.rb +4 -11
- data/spec/models/out_dial_spec.rb +4 -11
- data/spec/models/pagination_model_spec.rb +4 -11
- data/spec/models/pause_spec.rb +4 -11
- data/spec/models/percl_command_spec.rb +4 -11
- data/spec/models/percl_script_spec.rb +4 -11
- data/spec/models/play_early_media_spec.rb +4 -11
- data/spec/models/play_spec.rb +4 -11
- data/spec/models/queue_list_spec.rb +4 -11
- data/spec/models/queue_member_list_spec.rb +4 -11
- data/spec/models/queue_member_spec.rb +4 -11
- data/spec/models/queue_request_spec.rb +4 -11
- data/spec/models/queue_result_spec.rb +4 -11
- data/spec/models/record_utterance_spec.rb +4 -11
- data/spec/models/recording_list_spec.rb +4 -11
- data/spec/models/recording_result_spec.rb +4 -11
- data/spec/models/redirect_spec.rb +4 -11
- data/spec/models/reject_spec.rb +4 -11
- data/spec/models/remove_from_conference_spec.rb +4 -11
- data/spec/models/say_spec.rb +4 -11
- data/spec/models/send_digits_spec.rb +4 -11
- data/spec/models/set_listen_spec.rb +4 -11
- data/spec/models/set_talk_spec.rb +4 -11
- data/spec/models/sms_spec.rb +4 -11
- data/spec/models/start_record_call_spec.rb +4 -11
- data/spec/models/terminate_conference_spec.rb +4 -11
- data/spec/models/update_call_request_spec.rb +5 -12
- data/spec/models/update_conference_participant_request_spec.rb +4 -11
- data/spec/models/update_conference_request_spec.rb +5 -12
- data/spec/quickstart_spec.rb +10 -0
- data/spec/spec_helper.rb +55 -1
- metadata +20 -117
- data/lib/freeclimb/utils.rb +0 -34
- data/spec/api/web_mocks.rb +0 -473
- data/spec/models/account_result_all_of_spec.rb +0 -81
- data/spec/models/add_to_conference_all_of_spec.rb +0 -95
- data/spec/models/application_list_all_of_spec.rb +0 -41
- data/spec/models/application_result_all_of_spec.rb +0 -89
- data/spec/models/available_number_list_all_of_spec.rb +0 -41
- data/spec/models/call_list_all_of_spec.rb +0 -41
- data/spec/models/call_result_all_of_spec.rb +0 -129
- data/spec/models/conference_list_all_of_spec.rb +0 -41
- data/spec/models/conference_participant_list_all_of_spec.rb +0 -41
- data/spec/models/conference_participant_result_all_of_spec.rb +0 -71
- data/spec/models/conference_result_all_of_spec.rb +0 -103
- data/spec/models/create_conference_all_of_spec.rb +0 -71
- data/spec/models/enqueue_all_of_spec.rb +0 -59
- data/spec/models/get_digits_all_of_spec.rb +0 -89
- data/spec/models/get_speech_all_of_spec.rb +0 -113
- data/spec/models/hangup_all_of_spec.rb +0 -41
- data/spec/models/incoming_number_list_all_of_spec.rb +0 -41
- data/spec/models/incoming_number_result_all_of_spec.rb +0 -89
- data/spec/models/log_list_all_of_spec.rb +0 -41
- data/spec/models/message_request_all_of_spec.rb +0 -65
- data/spec/models/message_result_all_of_spec.rb +0 -87
- data/spec/models/messages_list_all_of_spec.rb +0 -41
- data/spec/models/out_dial_all_of_spec.rb +0 -95
- data/spec/models/pause_all_of_spec.rb +0 -41
- data/spec/models/play_all_of_spec.rb +0 -59
- data/spec/models/play_early_media_all_of_spec.rb +0 -41
- data/spec/models/queue_list_all_of_spec.rb +0 -41
- data/spec/models/queue_member_list_all_of_spec.rb +0 -41
- data/spec/models/queue_result_all_of_spec.rb +0 -77
- data/spec/models/record_utterance_all_of_spec.rb +0 -77
- data/spec/models/recording_list_all_of_spec.rb +0 -41
- data/spec/models/recording_result_all_of_spec.rb +0 -65
- data/spec/models/redirect_all_of_spec.rb +0 -41
- data/spec/models/reject_all_of_spec.rb +0 -41
- data/spec/models/remove_from_conference_all_of_spec.rb +0 -41
- data/spec/models/send_digits_all_of_spec.rb +0 -53
- data/spec/models/set_listen_all_of_spec.rb +0 -47
- data/spec/models/set_talk_all_of_spec.rb +0 -47
- data/spec/models/sms_all_of_spec.rb +0 -59
- data/spec/models/terminate_conference_all_of_spec.rb +0 -41
@@ -0,0 +1,26 @@
|
|
1
|
+
# Freeclimb::Capabilities
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **voice** | **Boolean** | Indicates whether a number can be used for voice calls. Replaces voiceEnabled. | |
|
8
|
+
| **sms** | **Boolean** | Indicates whether a number can be used SMS messaging. Replaces smsEnabled. | |
|
9
|
+
| **toll_free** | **Boolean** | Indicates that a number is toll-free and will make toll-free calls, and when enabled, toll-free messages. | |
|
10
|
+
| **ten_dlc** | **Boolean** | Indicates that a number, if sms is true, will be used for 10DLC messaging | |
|
11
|
+
| **short_code** | **Boolean** | Indicates that a number is a short code and can be used for short code messaging | |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'freeclimb'
|
17
|
+
|
18
|
+
instance = Freeclimb::Capabilities.new(
|
19
|
+
voice: null,
|
20
|
+
sms: null,
|
21
|
+
toll_free: null,
|
22
|
+
ten_dlc: null,
|
23
|
+
short_code: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/ConferenceList.md
CHANGED
@@ -2,30 +2,31 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**total** | **Integer** | Total amount of requested resource. | [optional]
|
8
|
-
**start** | **Integer** | Resource index at start of current page | [optional]
|
9
|
-
**_end** | **Integer** | Resource index at end of current page | [optional]
|
10
|
-
**page** | **Integer** | Current page | [optional]
|
11
|
-
**num_pages** | **Integer** | Total number of pages | [optional]
|
12
|
-
**page_size** | **Integer** | Number of items per page | [optional]
|
13
|
-
**next_page_uri** | **String** | Uri to retrieve the next page of items | [optional]
|
14
|
-
**conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) | | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **total** | **Integer** | Total amount of requested resource. | [optional] |
|
8
|
+
| **start** | **Integer** | Resource index at start of current page | [optional] |
|
9
|
+
| **_end** | **Integer** | Resource index at end of current page | [optional] |
|
10
|
+
| **page** | **Integer** | Current page | [optional] |
|
11
|
+
| **num_pages** | **Integer** | Total number of pages | [optional] |
|
12
|
+
| **page_size** | **Integer** | Number of items per page | [optional] |
|
13
|
+
| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
|
14
|
+
| **conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) | | [optional] |
|
15
15
|
|
16
|
-
##
|
16
|
+
## Example
|
17
17
|
|
18
18
|
```ruby
|
19
19
|
require 'freeclimb'
|
20
20
|
|
21
|
-
instance = Freeclimb::ConferenceList.new(
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
21
|
+
instance = Freeclimb::ConferenceList.new(
|
22
|
+
total: null,
|
23
|
+
start: null,
|
24
|
+
_end: null,
|
25
|
+
page: null,
|
26
|
+
num_pages: null,
|
27
|
+
page_size: null,
|
28
|
+
next_page_uri: null,
|
29
|
+
conferences: null
|
30
|
+
)
|
29
31
|
```
|
30
32
|
|
31
|
-
|
data/docs/ConferenceListAllOf.md
CHANGED
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) | | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conferences** | [**Array<ConferenceResult>**](ConferenceResult.md) | | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
12
|
require 'freeclimb'
|
13
13
|
|
14
|
-
instance = Freeclimb::ConferenceListAllOf.new(
|
14
|
+
instance = Freeclimb::ConferenceListAllOf.new(
|
15
|
+
conferences: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
@@ -2,30 +2,31 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**total** | **Integer** | Total amount of requested resource. | [optional]
|
8
|
-
**start** | **Integer** | Resource index at start of current page | [optional]
|
9
|
-
**_end** | **Integer** | Resource index at end of current page | [optional]
|
10
|
-
**page** | **Integer** | Current page | [optional]
|
11
|
-
**num_pages** | **Integer** | Total number of pages | [optional]
|
12
|
-
**page_size** | **Integer** | Number of items per page | [optional]
|
13
|
-
**next_page_uri** | **String** | Uri to retrieve the next page of items | [optional]
|
14
|
-
**participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) | | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **total** | **Integer** | Total amount of requested resource. | [optional] |
|
8
|
+
| **start** | **Integer** | Resource index at start of current page | [optional] |
|
9
|
+
| **_end** | **Integer** | Resource index at end of current page | [optional] |
|
10
|
+
| **page** | **Integer** | Current page | [optional] |
|
11
|
+
| **num_pages** | **Integer** | Total number of pages | [optional] |
|
12
|
+
| **page_size** | **Integer** | Number of items per page | [optional] |
|
13
|
+
| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
|
14
|
+
| **participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) | | [optional] |
|
15
15
|
|
16
|
-
##
|
16
|
+
## Example
|
17
17
|
|
18
18
|
```ruby
|
19
19
|
require 'freeclimb'
|
20
20
|
|
21
|
-
instance = Freeclimb::ConferenceParticipantList.new(
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
21
|
+
instance = Freeclimb::ConferenceParticipantList.new(
|
22
|
+
total: null,
|
23
|
+
start: null,
|
24
|
+
_end: null,
|
25
|
+
page: null,
|
26
|
+
num_pages: null,
|
27
|
+
page_size: null,
|
28
|
+
next_page_uri: null,
|
29
|
+
participants: null
|
30
|
+
)
|
29
31
|
```
|
30
32
|
|
31
|
-
|
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) | | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **participants** | [**Array<ConferenceParticipantResult>**](ConferenceParticipantResult.md) | | [optional] |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
12
|
require 'freeclimb'
|
13
13
|
|
14
|
-
instance = Freeclimb::ConferenceParticipantListAllOf.new(
|
14
|
+
instance = Freeclimb::ConferenceParticipantListAllOf.new(
|
15
|
+
participants: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
@@ -2,34 +2,35 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
|
8
|
-
**date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
|
9
|
-
**date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
|
10
|
-
**revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
|
11
|
-
**account_id** | **String** | ID of the account that created this participant. | [optional]
|
12
|
-
**conference_id** | **String** | ID of the conference this participant is in. | [optional]
|
13
|
-
**call_id** | **String** | ID of the Call associated with this Participant. | [optional]
|
14
|
-
**talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional]
|
15
|
-
**listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional]
|
16
|
-
**start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] |
|
8
|
+
| **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
|
9
|
+
| **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
|
10
|
+
| **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
|
11
|
+
| **account_id** | **String** | ID of the account that created this participant. | [optional] |
|
12
|
+
| **conference_id** | **String** | ID of the conference this participant is in. | [optional] |
|
13
|
+
| **call_id** | **String** | ID of the Call associated with this Participant. | [optional] |
|
14
|
+
| **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional] |
|
15
|
+
| **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional] |
|
16
|
+
| **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional] |
|
17
17
|
|
18
|
-
##
|
18
|
+
## Example
|
19
19
|
|
20
20
|
```ruby
|
21
21
|
require 'freeclimb'
|
22
22
|
|
23
|
-
instance = Freeclimb::ConferenceParticipantResult.new(
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
23
|
+
instance = Freeclimb::ConferenceParticipantResult.new(
|
24
|
+
uri: null,
|
25
|
+
date_created: null,
|
26
|
+
date_updated: null,
|
27
|
+
revision: null,
|
28
|
+
account_id: null,
|
29
|
+
conference_id: null,
|
30
|
+
call_id: null,
|
31
|
+
talk: null,
|
32
|
+
listen: null,
|
33
|
+
start_conf_on_enter: null
|
34
|
+
)
|
33
35
|
```
|
34
36
|
|
35
|
-
|
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**account_id** | **String** | ID of the account that created this participant. | [optional]
|
8
|
-
**conference_id** | **String** | ID of the conference this participant is in. | [optional]
|
9
|
-
**call_id** | **String** | ID of the Call associated with this Participant. | [optional]
|
10
|
-
**talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional]
|
11
|
-
**listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional]
|
12
|
-
**start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **account_id** | **String** | ID of the account that created this participant. | [optional] |
|
8
|
+
| **conference_id** | **String** | ID of the conference this participant is in. | [optional] |
|
9
|
+
| **call_id** | **String** | ID of the Call associated with this Participant. | [optional] |
|
10
|
+
| **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional] |
|
11
|
+
| **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional] |
|
12
|
+
| **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional] |
|
13
13
|
|
14
|
-
##
|
14
|
+
## Example
|
15
15
|
|
16
16
|
```ruby
|
17
17
|
require 'freeclimb'
|
18
18
|
|
19
|
-
instance = Freeclimb::ConferenceParticipantResultAllOf.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
19
|
+
instance = Freeclimb::ConferenceParticipantResultAllOf.new(
|
20
|
+
account_id: null,
|
21
|
+
conference_id: null,
|
22
|
+
call_id: null,
|
23
|
+
talk: null,
|
24
|
+
listen: null,
|
25
|
+
start_conf_on_enter: null
|
26
|
+
)
|
25
27
|
```
|
26
28
|
|
27
|
-
|
data/docs/ConferenceResult.md
CHANGED
@@ -2,42 +2,43 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
|
8
|
-
**date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
|
9
|
-
**date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
|
10
|
-
**revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
|
11
|
-
**conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional]
|
12
|
-
**account_id** | **String** | ID of the account that created this Conference. | [optional]
|
13
|
-
**_alias** | **String** | A description for this Conference. | [optional]
|
14
|
-
**play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional]
|
15
|
-
**record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional]
|
16
|
-
**status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional]
|
17
|
-
**wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional]
|
18
|
-
**action_url** | **String** | URL invoked once the Conference is successfully created. | [optional]
|
19
|
-
**status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional]
|
20
|
-
**subresource_uris** |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional] |
|
8
|
+
| **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
|
9
|
+
| **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
|
10
|
+
| **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
|
11
|
+
| **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional] |
|
12
|
+
| **account_id** | **String** | ID of the account that created this Conference. | [optional] |
|
13
|
+
| **_alias** | **String** | A description for this Conference. | [optional] |
|
14
|
+
| **play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional] |
|
15
|
+
| **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional] |
|
16
|
+
| **status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional] |
|
17
|
+
| **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional] |
|
18
|
+
| **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional] |
|
19
|
+
| **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional] |
|
20
|
+
| **subresource_uris** | **Object** | The list of subresources for this Conference. This includes participants and/or recordings. | [optional] |
|
21
21
|
|
22
|
-
##
|
22
|
+
## Example
|
23
23
|
|
24
24
|
```ruby
|
25
25
|
require 'freeclimb'
|
26
26
|
|
27
|
-
instance = Freeclimb::ConferenceResult.new(
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
|
39
|
-
|
40
|
-
|
27
|
+
instance = Freeclimb::ConferenceResult.new(
|
28
|
+
uri: null,
|
29
|
+
date_created: null,
|
30
|
+
date_updated: null,
|
31
|
+
revision: null,
|
32
|
+
conference_id: null,
|
33
|
+
account_id: null,
|
34
|
+
_alias: null,
|
35
|
+
play_beep: null,
|
36
|
+
record: null,
|
37
|
+
status: null,
|
38
|
+
wait_url: null,
|
39
|
+
action_url: null,
|
40
|
+
status_callback_url: null,
|
41
|
+
subresource_uris: null
|
42
|
+
)
|
41
43
|
```
|
42
44
|
|
43
|
-
|
@@ -2,34 +2,35 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional]
|
8
|
-
**account_id** | **String** | ID of the account that created this Conference. | [optional]
|
9
|
-
**_alias** | **String** | A description for this Conference. | [optional]
|
10
|
-
**play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional]
|
11
|
-
**record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional]
|
12
|
-
**status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional]
|
13
|
-
**wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional]
|
14
|
-
**action_url** | **String** | URL invoked once the Conference is successfully created. | [optional]
|
15
|
-
**status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional]
|
16
|
-
**subresource_uris** |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional] |
|
8
|
+
| **account_id** | **String** | ID of the account that created this Conference. | [optional] |
|
9
|
+
| **_alias** | **String** | A description for this Conference. | [optional] |
|
10
|
+
| **play_beep** | **String** | Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always. | [optional] |
|
11
|
+
| **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional] |
|
12
|
+
| **status** | **String** | The status of the Conference. One of: creating, empty, populated, inProgress, or terminated. | [optional] |
|
13
|
+
| **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional] |
|
14
|
+
| **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional] |
|
15
|
+
| **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional] |
|
16
|
+
| **subresource_uris** | **Object** | The list of subresources for this Conference. This includes participants and/or recordings. | [optional] |
|
17
17
|
|
18
|
-
##
|
18
|
+
## Example
|
19
19
|
|
20
20
|
```ruby
|
21
21
|
require 'freeclimb'
|
22
22
|
|
23
|
-
instance = Freeclimb::ConferenceResultAllOf.new(
|
24
|
-
|
25
|
-
|
26
|
-
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
|
23
|
+
instance = Freeclimb::ConferenceResultAllOf.new(
|
24
|
+
conference_id: null,
|
25
|
+
account_id: null,
|
26
|
+
_alias: null,
|
27
|
+
play_beep: null,
|
28
|
+
record: null,
|
29
|
+
status: null,
|
30
|
+
wait_url: null,
|
31
|
+
action_url: null,
|
32
|
+
status_callback_url: null,
|
33
|
+
subresource_uris: null
|
34
|
+
)
|
33
35
|
```
|
34
36
|
|
35
|
-
|
data/docs/CreateConference.md
CHANGED
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. |
|
8
|
-
**_alias** | **Boolean** | Descriptive name for the Conference. | [optional]
|
9
|
-
**play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional]
|
10
|
-
**record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional]
|
11
|
-
**status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional]
|
12
|
-
**wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. | |
|
8
|
+
| **_alias** | **Boolean** | Descriptive name for the Conference. | [optional] |
|
9
|
+
| **play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional] |
|
10
|
+
| **record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional] |
|
11
|
+
| **status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional] |
|
12
|
+
| **wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional] |
|
13
13
|
|
14
|
-
##
|
14
|
+
## Example
|
15
15
|
|
16
16
|
```ruby
|
17
17
|
require 'freeclimb'
|
18
18
|
|
19
|
-
instance = Freeclimb::CreateConference.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
19
|
+
instance = Freeclimb::CreateConference.new(
|
20
|
+
action_url: null,
|
21
|
+
_alias: null,
|
22
|
+
play_beep: null,
|
23
|
+
record: null,
|
24
|
+
status_callback_url: null,
|
25
|
+
wait_url: null
|
26
|
+
)
|
25
27
|
```
|
26
28
|
|
27
|
-
|
@@ -2,26 +2,27 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. |
|
8
|
-
**_alias** | **Boolean** | Descriptive name for the Conference. | [optional]
|
9
|
-
**play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional]
|
10
|
-
**record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional]
|
11
|
-
**status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional]
|
12
|
-
**wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. | |
|
8
|
+
| **_alias** | **Boolean** | Descriptive name for the Conference. | [optional] |
|
9
|
+
| **play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` | [optional] |
|
10
|
+
| **record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional] |
|
11
|
+
| **status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional] |
|
12
|
+
| **wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional] |
|
13
13
|
|
14
|
-
##
|
14
|
+
## Example
|
15
15
|
|
16
16
|
```ruby
|
17
17
|
require 'freeclimb'
|
18
18
|
|
19
|
-
instance = Freeclimb::CreateConferenceAllOf.new(
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
19
|
+
instance = Freeclimb::CreateConferenceAllOf.new(
|
20
|
+
action_url: null,
|
21
|
+
_alias: null,
|
22
|
+
play_beep: null,
|
23
|
+
record: null,
|
24
|
+
status_callback_url: null,
|
25
|
+
wait_url: null
|
26
|
+
)
|
25
27
|
```
|
26
28
|
|
27
|
-
|
@@ -2,24 +2,25 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
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]
|
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 &mdash; 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]
|
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 &mdash; 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
12
|
|
13
|
-
##
|
13
|
+
## Example
|
14
14
|
|
15
15
|
```ruby
|
16
16
|
require 'freeclimb'
|
17
17
|
|
18
|
-
instance = Freeclimb::CreateConferenceRequest.new(
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
18
|
+
instance = Freeclimb::CreateConferenceRequest.new(
|
19
|
+
_alias: null,
|
20
|
+
play_beep: null,
|
21
|
+
record: null,
|
22
|
+
wait_url: null,
|
23
|
+
status_callback_url: null
|
24
|
+
)
|
23
25
|
```
|
24
26
|
|
25
|
-
|