freeclimb 3.0.1 → 4.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -0
- data/Gemfile +4 -2
- data/Gemfile.lock +38 -19
- data/README.md +37 -35
- 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 -16
- 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 -44
- data/docs/CallResultAllOf.md +35 -36
- 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 +1629 -629
- 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 +3 -4
- data/lib/freeclimb/api/default_api.rb +449 -263
- data/lib/freeclimb/api_client.rb +55 -51
- data/lib/freeclimb/api_error.rb +2 -2
- data/lib/freeclimb/configuration.rb +41 -11
- data/lib/freeclimb/models/account_request.rb +20 -8
- data/lib/freeclimb/models/account_result.rb +39 -8
- data/lib/freeclimb/models/account_result_all_of.rb +39 -8
- data/lib/freeclimb/models/add_to_conference.rb +21 -8
- data/lib/freeclimb/models/add_to_conference_all_of.rb +20 -8
- data/lib/freeclimb/models/application_list.rb +28 -8
- data/lib/freeclimb/models/application_list_all_of.rb +21 -8
- data/lib/freeclimb/models/application_request.rb +20 -8
- data/lib/freeclimb/models/application_result.rb +29 -8
- data/lib/freeclimb/models/application_result_all_of.rb +29 -8
- data/lib/freeclimb/models/available_number.rb +35 -19
- data/lib/freeclimb/models/available_number_list.rb +28 -8
- data/lib/freeclimb/models/available_number_list_all_of.rb +21 -8
- data/lib/freeclimb/models/buy_incoming_number_request.rb +20 -8
- data/lib/freeclimb/models/call_list.rb +28 -8
- data/lib/freeclimb/models/call_list_all_of.rb +21 -8
- data/lib/freeclimb/models/call_result.rb +36 -21
- data/lib/freeclimb/models/call_result_all_of.rb +36 -21
- data/lib/freeclimb/models/capabilities.rb +265 -0
- data/lib/freeclimb/models/conference_list.rb +28 -8
- data/lib/freeclimb/models/conference_list_all_of.rb +21 -8
- data/lib/freeclimb/models/conference_participant_list.rb +28 -8
- data/lib/freeclimb/models/conference_participant_list_all_of.rb +21 -8
- data/lib/freeclimb/models/conference_participant_result.rb +26 -8
- data/lib/freeclimb/models/conference_participant_result_all_of.rb +26 -8
- data/lib/freeclimb/models/conference_result.rb +30 -8
- data/lib/freeclimb/models/conference_result_all_of.rb +30 -8
- data/lib/freeclimb/models/create_conference.rb +21 -8
- data/lib/freeclimb/models/create_conference_all_of.rb +20 -8
- data/lib/freeclimb/models/create_conference_request.rb +20 -8
- data/lib/freeclimb/models/dequeue.rb +21 -8
- data/lib/freeclimb/models/enqueue.rb +21 -8
- data/lib/freeclimb/models/enqueue_all_of.rb +20 -8
- data/lib/freeclimb/models/filter_logs_request.rb +20 -8
- data/lib/freeclimb/models/get_digits.rb +21 -8
- data/lib/freeclimb/models/get_digits_all_of.rb +20 -8
- data/lib/freeclimb/models/get_speech.rb +21 -8
- data/lib/freeclimb/models/get_speech_all_of.rb +20 -8
- data/lib/freeclimb/models/hangup.rb +21 -8
- data/lib/freeclimb/models/hangup_all_of.rb +20 -8
- data/lib/freeclimb/models/incoming_number_list.rb +28 -8
- data/lib/freeclimb/models/incoming_number_list_all_of.rb +21 -8
- data/lib/freeclimb/models/incoming_number_request.rb +20 -8
- data/lib/freeclimb/models/incoming_number_result.rb +39 -9
- data/lib/freeclimb/models/incoming_number_result_all_of.rb +39 -9
- data/lib/freeclimb/models/log_list.rb +28 -8
- data/lib/freeclimb/models/log_list_all_of.rb +21 -8
- data/lib/freeclimb/models/log_result.rb +27 -8
- data/lib/freeclimb/models/make_call_request.rb +22 -8
- data/lib/freeclimb/models/message_request.rb +20 -8
- data/lib/freeclimb/models/message_request_all_of.rb +20 -8
- data/lib/freeclimb/models/message_result.rb +28 -8
- data/lib/freeclimb/models/message_result_all_of.rb +28 -8
- data/lib/freeclimb/models/messages_list.rb +28 -8
- data/lib/freeclimb/models/messages_list_all_of.rb +21 -8
- data/lib/freeclimb/models/mutable_resource_model.rb +20 -8
- data/lib/freeclimb/models/out_dial.rb +21 -8
- data/lib/freeclimb/models/out_dial_all_of.rb +20 -8
- data/lib/freeclimb/models/pagination_model.rb +27 -8
- data/lib/freeclimb/models/pause.rb +21 -8
- data/lib/freeclimb/models/pause_all_of.rb +20 -8
- data/lib/freeclimb/models/percl_command.rb +39 -8
- data/lib/freeclimb/models/percl_script.rb +24 -8
- data/lib/freeclimb/models/play.rb +21 -8
- data/lib/freeclimb/models/play_all_of.rb +20 -8
- data/lib/freeclimb/models/play_early_media.rb +21 -8
- data/lib/freeclimb/models/play_early_media_all_of.rb +20 -8
- data/lib/freeclimb/models/queue_list.rb +28 -8
- data/lib/freeclimb/models/queue_list_all_of.rb +21 -8
- data/lib/freeclimb/models/queue_member.rb +25 -8
- data/lib/freeclimb/models/queue_member_list.rb +28 -8
- data/lib/freeclimb/models/queue_member_list_all_of.rb +21 -8
- data/lib/freeclimb/models/queue_request.rb +22 -8
- data/lib/freeclimb/models/queue_result.rb +27 -8
- data/lib/freeclimb/models/queue_result_all_of.rb +27 -8
- data/lib/freeclimb/models/record_utterance.rb +21 -8
- data/lib/freeclimb/models/record_utterance_all_of.rb +20 -8
- data/lib/freeclimb/models/recording_list.rb +28 -8
- data/lib/freeclimb/models/recording_list_all_of.rb +21 -8
- data/lib/freeclimb/models/recording_result.rb +25 -8
- data/lib/freeclimb/models/recording_result_all_of.rb +25 -8
- data/lib/freeclimb/models/redirect.rb +21 -8
- data/lib/freeclimb/models/redirect_all_of.rb +20 -8
- data/lib/freeclimb/models/reject.rb +21 -8
- data/lib/freeclimb/models/reject_all_of.rb +20 -8
- data/lib/freeclimb/models/remove_from_conference.rb +21 -8
- data/lib/freeclimb/models/remove_from_conference_all_of.rb +20 -8
- data/lib/freeclimb/models/say.rb +21 -8
- data/lib/freeclimb/models/say_all_of.rb +20 -8
- data/lib/freeclimb/models/send_digits.rb +21 -8
- data/lib/freeclimb/models/send_digits_all_of.rb +20 -8
- data/lib/freeclimb/models/set_listen.rb +21 -8
- data/lib/freeclimb/models/set_listen_all_of.rb +20 -8
- data/lib/freeclimb/models/set_talk.rb +21 -8
- data/lib/freeclimb/models/set_talk_all_of.rb +20 -8
- data/lib/freeclimb/models/sms.rb +21 -8
- data/lib/freeclimb/models/sms_all_of.rb +20 -8
- data/lib/freeclimb/models/start_record_call.rb +21 -8
- data/lib/freeclimb/models/terminate_conference.rb +21 -8
- data/lib/freeclimb/models/terminate_conference_all_of.rb +20 -8
- data/lib/freeclimb/models/update_call_request.rb +20 -8
- data/lib/freeclimb/models/update_conference_participant_request.rb +20 -8
- data/lib/freeclimb/models/update_conference_request.rb +20 -8
- data/lib/freeclimb/version.rb +3 -3
- data/lib/freeclimb.rb +25 -53
- data/spec/api/default_api_spec.rb +1095 -668
- data/spec/api_client_spec.rb +7 -7
- data/spec/configuration_spec.rb +13 -5
- data/spec/factories.rb +80 -0
- data/spec/models/account_request_spec.rb +20 -13
- data/spec/models/account_result_spec.rb +81 -12
- data/spec/models/add_to_conference_spec.rb +7 -14
- data/spec/models/application_list_spec.rb +55 -12
- data/spec/models/application_request_spec.rb +49 -12
- data/spec/models/application_result_spec.rb +85 -12
- data/spec/models/available_number_list_spec.rb +55 -13
- data/spec/models/available_number_spec.rb +43 -12
- data/spec/models/buy_incoming_number_request_spec.rb +25 -12
- data/spec/models/call_list_spec.rb +55 -13
- data/spec/models/call_result_spec.rb +124 -12
- data/spec/models/capabilities_spec.rb +58 -0
- data/spec/models/conference_list_spec.rb +55 -12
- data/spec/models/conference_participant_list_spec.rb +55 -12
- data/spec/models/conference_participant_result_spec.rb +67 -12
- data/spec/models/conference_result_spec.rb +99 -13
- data/spec/models/create_conference_request_spec.rb +41 -13
- data/spec/models/create_conference_spec.rb +7 -14
- data/spec/models/dequeue_spec.rb +7 -14
- data/spec/models/enqueue_spec.rb +7 -14
- data/spec/models/filter_logs_request_spec.rb +15 -14
- data/spec/models/get_digits_spec.rb +13 -14
- data/spec/models/get_speech_spec.rb +8 -15
- data/spec/models/hangup_spec.rb +5 -12
- data/spec/models/incoming_number_list_spec.rb +55 -13
- data/spec/models/incoming_number_request_spec.rb +20 -13
- data/spec/models/incoming_number_result_spec.rb +91 -13
- data/spec/models/log_list_spec.rb +55 -12
- data/spec/models/log_result_spec.rb +53 -12
- data/spec/models/make_call_request_spec.rb +67 -12
- data/spec/models/message_request_spec.rb +61 -13
- data/spec/models/message_result_spec.rb +83 -12
- data/spec/models/messages_list_spec.rb +55 -12
- data/spec/models/mutable_resource_model_spec.rb +31 -13
- data/spec/models/out_dial_spec.rb +13 -14
- data/spec/models/pagination_model_spec.rb +49 -12
- data/spec/models/pause_spec.rb +7 -14
- data/spec/models/percl_command_spec.rb +7 -14
- data/spec/models/percl_script_spec.rb +7 -14
- data/spec/models/play_early_media_spec.rb +7 -14
- data/spec/models/play_spec.rb +13 -14
- data/spec/models/queue_list_spec.rb +54 -12
- data/spec/models/queue_member_list_spec.rb +55 -12
- data/spec/models/queue_member_spec.rb +37 -13
- data/spec/models/queue_request_spec.rb +20 -14
- data/spec/models/queue_result_spec.rb +73 -12
- data/spec/models/record_utterance_spec.rb +13 -14
- data/spec/models/recording_list_spec.rb +55 -12
- data/spec/models/recording_result_spec.rb +61 -12
- data/spec/models/redirect_spec.rb +7 -14
- data/spec/models/reject_spec.rb +5 -12
- data/spec/models/remove_from_conference_spec.rb +7 -14
- data/spec/models/say_spec.rb +8 -15
- data/spec/models/send_digits_spec.rb +13 -14
- data/spec/models/set_listen_spec.rb +7 -14
- data/spec/models/set_talk_spec.rb +7 -14
- data/spec/models/sms_spec.rb +7 -14
- data/spec/models/start_record_call_spec.rb +7 -14
- data/spec/models/terminate_conference_spec.rb +7 -14
- data/spec/models/update_call_request_spec.rb +19 -14
- data/spec/models/update_conference_participant_request_spec.rb +20 -13
- data/spec/models/update_conference_request_spec.rb +29 -12
- data/spec/quickstart_spec.rb +10 -0
- data/spec/spec_helper.rb +62 -7
- metadata +17 -38
- data/freeclimb-2.0.3.gem +0 -0
- data/freeclimb-2.1.0.gem +0 -0
- data/freeclimb-2.1.1.gem +0 -0
- data/freeclimb-2.1.2.gem +0 -0
- data/freeclimb-2.2.0.gem +0 -0
- data/freeclimb-3.0.0.gem +0 -0
- data/lib/freeclimb/utils.rb +0 -34
- data/spec/api/web_mocks.rb +0 -473
data/docs/SayAllOf.md
CHANGED
@@ -2,24 +2,25 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**text** | **String** | The message to be played to the caller using TTS. The size of the string is limited to 4 KB (or 4,096 bytes). An empty string will cause the command to be skipped. |
|
8
|
-
**language** | **String** | Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below. | [optional]
|
9
|
-
**loop** | **Integer** | Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up. | [optional]
|
10
|
-
**conference_id** | **String** | D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional]
|
11
|
-
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **text** | **String** | The message to be played to the caller using TTS. The size of the string is limited to 4 KB (or 4,096 bytes). An empty string will cause the command to be skipped. | |
|
8
|
+
| **language** | **String** | Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below. | [optional] |
|
9
|
+
| **loop** | **Integer** | Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up. | [optional] |
|
10
|
+
| **conference_id** | **String** | D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional] |
|
11
|
+
| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
|
12
12
|
|
13
|
-
##
|
13
|
+
## Example
|
14
14
|
|
15
15
|
```ruby
|
16
16
|
require 'freeclimb'
|
17
17
|
|
18
|
-
instance = Freeclimb::SayAllOf.new(
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
18
|
+
instance = Freeclimb::SayAllOf.new(
|
19
|
+
text: null,
|
20
|
+
language: null,
|
21
|
+
loop: null,
|
22
|
+
conference_id: null,
|
23
|
+
privacy_mode: null
|
24
|
+
)
|
23
25
|
```
|
24
26
|
|
25
|
-
|
data/docs/SendDigits.md
CHANGED
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**digits** | **String** | String containing the digits to be played. The string cannot be empty and can include any digit, plus `#`, or `*`, and allows embedding specification for delay or pause between the output of individual digits. |
|
8
|
-
**pause_ms** | **Integer** | Pause between digits in milliseconds. Valid values are 100-1000 milliseconds and will be adjusted by FreeClimb to satisfy the constraint. | [optional]
|
9
|
-
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **digits** | **String** | String containing the digits to be played. The string cannot be empty and can include any digit, plus `#`, or `*`, and allows embedding specification for delay or pause between the output of individual digits. | |
|
8
|
+
| **pause_ms** | **Integer** | Pause between digits in milliseconds. Valid values are 100-1000 milliseconds and will be adjusted by FreeClimb to satisfy the constraint. | [optional] |
|
9
|
+
| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
|
10
10
|
|
11
|
-
##
|
11
|
+
## Example
|
12
12
|
|
13
13
|
```ruby
|
14
14
|
require 'freeclimb'
|
15
15
|
|
16
|
-
instance = Freeclimb::SendDigits.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = Freeclimb::SendDigits.new(
|
17
|
+
digits: null,
|
18
|
+
pause_ms: null,
|
19
|
+
privacy_mode: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|
data/docs/SendDigitsAllOf.md
CHANGED
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**digits** | **String** | String containing the digits to be played. The string cannot be empty and can include any digit, plus `#`, or `*`, and allows embedding specification for delay or pause between the output of individual digits. |
|
8
|
-
**pause_ms** | **Integer** | Pause between digits in milliseconds. Valid values are 100-1000 milliseconds and will be adjusted by FreeClimb to satisfy the constraint. | [optional]
|
9
|
-
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **digits** | **String** | String containing the digits to be played. The string cannot be empty and can include any digit, plus `#`, or `*`, and allows embedding specification for delay or pause between the output of individual digits. | |
|
8
|
+
| **pause_ms** | **Integer** | Pause between digits in milliseconds. Valid values are 100-1000 milliseconds and will be adjusted by FreeClimb to satisfy the constraint. | [optional] |
|
9
|
+
| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
|
10
10
|
|
11
|
-
##
|
11
|
+
## Example
|
12
12
|
|
13
13
|
```ruby
|
14
14
|
require 'freeclimb'
|
15
15
|
|
16
|
-
instance = Freeclimb::SendDigitsAllOf.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = Freeclimb::SendDigitsAllOf.new(
|
17
|
+
digits: null,
|
18
|
+
pause_ms: null,
|
19
|
+
privacy_mode: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|
data/docs/SetListen.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**call_id** | **String** | ID of the call leg that is to be assigned the listen privilege. The Call must be in a Conference or an error will be triggered. |
|
8
|
-
**listen** | **Boolean** | Specifying `false` will silence the Conference for this Participant. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **call_id** | **String** | ID of the call leg that is to be assigned the listen privilege. The Call must be in a Conference or an error will be triggered. | |
|
8
|
+
| **listen** | **Boolean** | Specifying `false` will silence the Conference for this Participant. | [optional] |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
13
|
require 'freeclimb'
|
14
14
|
|
15
|
-
instance = Freeclimb::SetListen.new(
|
16
|
-
|
15
|
+
instance = Freeclimb::SetListen.new(
|
16
|
+
call_id: null,
|
17
|
+
listen: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
data/docs/SetListenAllOf.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**call_id** | **String** | ID of the call leg that is to be assigned the listen privilege. The Call must be in a Conference or an error will be triggered. |
|
8
|
-
**listen** | **Boolean** | Specifying `false` will silence the Conference for this Participant. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **call_id** | **String** | ID of the call leg that is to be assigned the listen privilege. The Call must be in a Conference or an error will be triggered. | |
|
8
|
+
| **listen** | **Boolean** | Specifying `false` will silence the Conference for this Participant. | [optional] |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
13
|
require 'freeclimb'
|
14
14
|
|
15
|
-
instance = Freeclimb::SetListenAllOf.new(
|
16
|
-
|
15
|
+
instance = Freeclimb::SetListenAllOf.new(
|
16
|
+
call_id: null,
|
17
|
+
listen: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
data/docs/SetTalk.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**call_id** | **String** | ID of the call leg that is to be muted or unmuted. The Call must be in a Conference or an error will be triggered. |
|
8
|
-
**talk** | **Boolean** | Specifying `false` mutes the Participant. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **call_id** | **String** | ID of the call leg that is to be muted or unmuted. The Call must be in a Conference or an error will be triggered. | |
|
8
|
+
| **talk** | **Boolean** | Specifying `false` mutes the Participant. | [optional] |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
13
|
require 'freeclimb'
|
14
14
|
|
15
|
-
instance = Freeclimb::SetTalk.new(
|
16
|
-
|
15
|
+
instance = Freeclimb::SetTalk.new(
|
16
|
+
call_id: null,
|
17
|
+
talk: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
data/docs/SetTalkAllOf.md
CHANGED
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**call_id** | **String** | ID of the call leg that is to be muted or unmuted. The Call must be in a Conference or an error will be triggered. |
|
8
|
-
**talk** | **Boolean** | Specifying `false` mutes the Participant. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **call_id** | **String** | ID of the call leg that is to be muted or unmuted. The Call must be in a Conference or an error will be triggered. | |
|
8
|
+
| **talk** | **Boolean** | Specifying `false` mutes the Participant. | [optional] |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
13
|
require 'freeclimb'
|
14
14
|
|
15
|
-
instance = Freeclimb::SetTalkAllOf.new(
|
16
|
-
|
15
|
+
instance = Freeclimb::SetTalkAllOf.new(
|
16
|
+
call_id: null,
|
17
|
+
talk: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
data/docs/Sms.md
CHANGED
@@ -2,22 +2,23 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**to** | **String** | E.164 representation of the phone number to which the message will be sent. Must be within FreeClimb's service area and E.164 formatting (e.g., +18003608245). |
|
8
|
-
**from** | **String** | E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb. |
|
9
|
-
**text** | **String** | Text contained in the message (maximum 160 characters). |
|
10
|
-
**notification_url** | **String** | When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters. This is a notification only; any PerCL returned will be ignored. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **to** | **String** | E.164 representation of the phone number to which the message will be sent. Must be within FreeClimb's service area and E.164 formatting (e.g., +18003608245). | |
|
8
|
+
| **from** | **String** | E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb. | |
|
9
|
+
| **text** | **String** | Text contained in the message (maximum 160 characters). | |
|
10
|
+
| **notification_url** | **String** | When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters. This is a notification only; any PerCL returned will be ignored. | [optional] |
|
11
11
|
|
12
|
-
##
|
12
|
+
## Example
|
13
13
|
|
14
14
|
```ruby
|
15
15
|
require 'freeclimb'
|
16
16
|
|
17
|
-
instance = Freeclimb::Sms.new(
|
18
|
-
|
19
|
-
|
20
|
-
|
17
|
+
instance = Freeclimb::Sms.new(
|
18
|
+
to: null,
|
19
|
+
from: null,
|
20
|
+
text: null,
|
21
|
+
notification_url: null
|
22
|
+
)
|
21
23
|
```
|
22
24
|
|
23
|
-
|
data/docs/SmsAllOf.md
CHANGED
@@ -2,22 +2,23 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**to** | **String** | E.164 representation of the phone number to which the message will be sent. Must be within FreeClimb's service area and E.164 formatting (e.g., +18003608245). |
|
8
|
-
**from** | **String** | E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb. |
|
9
|
-
**text** | **String** | Text contained in the message (maximum 160 characters). |
|
10
|
-
**notification_url** | **String** | When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters. This is a notification only; any PerCL returned will be ignored. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **to** | **String** | E.164 representation of the phone number to which the message will be sent. Must be within FreeClimb's service area and E.164 formatting (e.g., +18003608245). | |
|
8
|
+
| **from** | **String** | E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb. | |
|
9
|
+
| **text** | **String** | Text contained in the message (maximum 160 characters). | |
|
10
|
+
| **notification_url** | **String** | When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters. This is a notification only; any PerCL returned will be ignored. | [optional] |
|
11
11
|
|
12
|
-
##
|
12
|
+
## Example
|
13
13
|
|
14
14
|
```ruby
|
15
15
|
require 'freeclimb'
|
16
16
|
|
17
|
-
instance = Freeclimb::SmsAllOf.new(
|
18
|
-
|
19
|
-
|
20
|
-
|
17
|
+
instance = Freeclimb::SmsAllOf.new(
|
18
|
+
to: null,
|
19
|
+
from: null,
|
20
|
+
text: null,
|
21
|
+
notification_url: null
|
22
|
+
)
|
21
23
|
```
|
22
24
|
|
23
|
-
|
data/docs/StartRecordCall.md
CHANGED
@@ -2,10 +2,10 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
7
|
|
8
|
-
##
|
8
|
+
## Example
|
9
9
|
|
10
10
|
```ruby
|
11
11
|
require 'freeclimb'
|
@@ -13,4 +13,3 @@ require 'freeclimb'
|
|
13
13
|
instance = Freeclimb::StartRecordCall.new()
|
14
14
|
```
|
15
15
|
|
16
|
-
|
data/docs/TerminateConference.md
CHANGED
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**conference_id** | **String** | ID of the conference to terminate. |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conference_id** | **String** | ID of the conference to terminate. | |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
12
|
require 'freeclimb'
|
13
13
|
|
14
|
-
instance = Freeclimb::TerminateConference.new(
|
14
|
+
instance = Freeclimb::TerminateConference.new(
|
15
|
+
conference_id: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**conference_id** | **String** | ID of the conference to terminate. |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **conference_id** | **String** | ID of the conference to terminate. | |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
12
|
require 'freeclimb'
|
13
13
|
|
14
|
-
instance = Freeclimb::TerminateConferenceAllOf.new(
|
14
|
+
instance = Freeclimb::TerminateConferenceAllOf.new(
|
15
|
+
conference_id: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
data/docs/UpdateCallRequest.md
CHANGED
@@ -2,16 +2,17 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**status** | **String** | Either `canceled` or `completed`. Specifying `canceled` attempts to hang up calls that are queued without affecting calls already in progress. Specifying `completed` attempts to hang up a call already in progress. |
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | Either `canceled` or `completed`. Specifying `canceled` attempts to hang up calls that are queued without affecting calls already in progress. Specifying `completed` attempts to hang up a call already in progress. | |
|
8
8
|
|
9
|
-
##
|
9
|
+
## Example
|
10
10
|
|
11
11
|
```ruby
|
12
12
|
require 'freeclimb'
|
13
13
|
|
14
|
-
instance = Freeclimb::UpdateCallRequest.new(
|
14
|
+
instance = Freeclimb::UpdateCallRequest.new(
|
15
|
+
status: null
|
16
|
+
)
|
15
17
|
```
|
16
18
|
|
17
|
-
|
@@ -2,18 +2,19 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**talk** | **Boolean** | (Optional) Default is `true`. Setting to `false` mutes the Participant. FreeClimb returns an error and ignores any other value. | [optional]
|
8
|
-
**listen** | **Boolean** | (Optional) Default is `true`. Setting to `false` silences the Conference for this Participant. FreeClimb returns an error and ignores any other value. | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **talk** | **Boolean** | (Optional) Default is `true`. Setting to `false` mutes the Participant. FreeClimb returns an error and ignores any other value. | [optional] |
|
8
|
+
| **listen** | **Boolean** | (Optional) Default is `true`. Setting to `false` silences the Conference for this Participant. FreeClimb returns an error and ignores any other value. | [optional] |
|
9
9
|
|
10
|
-
##
|
10
|
+
## Example
|
11
11
|
|
12
12
|
```ruby
|
13
13
|
require 'freeclimb'
|
14
14
|
|
15
|
-
instance = Freeclimb::UpdateConferenceParticipantRequest.new(
|
16
|
-
|
15
|
+
instance = Freeclimb::UpdateConferenceParticipantRequest.new(
|
16
|
+
talk: null,
|
17
|
+
listen: null
|
18
|
+
)
|
17
19
|
```
|
18
20
|
|
19
|
-
|
@@ -2,20 +2,21 @@
|
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
|
5
|
-
Name | Type | Description | Notes
|
6
|
-
|
7
|
-
**_alias** | **String** | 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
|
-
**status** | **String** | New status of the conference. Valid values: `empty` or `terminated`. For more information, see **Status Parameter** below.** | [optional]
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **_alias** | **String** | 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
|
+
| **status** | **String** | New status of the conference. Valid values: `empty` or `terminated`. For more information, see **Status Parameter** below.** | [optional] |
|
10
10
|
|
11
|
-
##
|
11
|
+
## Example
|
12
12
|
|
13
13
|
```ruby
|
14
14
|
require 'freeclimb'
|
15
15
|
|
16
|
-
instance = Freeclimb::UpdateConferenceRequest.new(
|
17
|
-
|
18
|
-
|
16
|
+
instance = Freeclimb::UpdateConferenceRequest.new(
|
17
|
+
_alias: null,
|
18
|
+
play_beep: null,
|
19
|
+
status: null
|
20
|
+
)
|
19
21
|
```
|
20
22
|
|
21
|
-
|
data/freeclimb.gemspec
CHANGED
@@ -6,9 +6,9 @@
|
|
6
6
|
#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
|
7
7
|
|
8
8
|
The version of the OpenAPI document: 1.0.0
|
9
|
-
|
9
|
+
Contact: support@freeclimb.com
|
10
10
|
Generated by: https://openapi-generator.tech
|
11
|
-
OpenAPI Generator version: 4.
|
11
|
+
OpenAPI Generator version: 5.4.0
|
12
12
|
|
13
13
|
=end
|
14
14
|
|
@@ -25,10 +25,9 @@ Gem::Specification.new do |s|
|
|
25
25
|
s.summary = "FreeClimb API Ruby Gem"
|
26
26
|
s.description = "FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request."
|
27
27
|
s.license = "Unlicense"
|
28
|
-
s.required_ruby_version = ">=
|
28
|
+
s.required_ruby_version = ">= 2.4"
|
29
29
|
|
30
30
|
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
-
s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
|
32
31
|
|
33
32
|
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
34
33
|
|