freeclimb 1.0.1 → 2.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 +80 -0
- data/Gemfile.lock +1 -1
- data/README.md +67 -42
- data/docs/AccountRequest.md +3 -5
- data/docs/AccountResult.md +12 -12
- data/docs/AccountResultAllOf.md +8 -8
- data/docs/AddToConference.md +35 -0
- data/docs/AddToConferenceAllOf.md +35 -0
- data/docs/ApplicationList.md +9 -9
- data/docs/ApplicationListAllOf.md +2 -2
- data/docs/ApplicationRequest.md +8 -10
- data/docs/ApplicationResult.md +14 -14
- data/docs/ApplicationResultAllOf.md +10 -10
- data/docs/AvailableNumber.md +7 -7
- data/docs/AvailableNumberList.md +9 -9
- data/docs/AvailableNumberListAllOf.md +2 -2
- data/docs/BuyIncomingNumberRequest.md +4 -6
- data/docs/CallList.md +9 -9
- data/docs/CallListAllOf.md +2 -2
- data/docs/CallResult.md +20 -20
- data/docs/CallResultAllOf.md +16 -16
- data/docs/ConferenceList.md +9 -9
- data/docs/ConferenceListAllOf.md +2 -2
- data/docs/ConferenceParticipantList.md +9 -9
- data/docs/ConferenceParticipantListAllOf.md +2 -2
- data/docs/ConferenceParticipantResult.md +11 -11
- data/docs/ConferenceParticipantResultAllOf.md +7 -7
- data/docs/ConferenceResult.md +15 -15
- data/docs/ConferenceResultAllOf.md +11 -11
- data/docs/CreateConference.md +27 -0
- data/docs/CreateConferenceAllOf.md +27 -0
- data/docs/CreateConferenceRequest.md +6 -8
- data/docs/DefaultApi.md +22 -38
- data/docs/Dequeue.md +16 -0
- data/docs/Enqueue.md +23 -0
- data/docs/EnqueueAllOf.md +23 -0
- data/docs/FilterLogsRequest.md +2 -4
- data/docs/GetDigits.md +33 -0
- data/docs/GetDigitsAllOf.md +33 -0
- data/docs/GetSpeech.md +41 -0
- data/docs/GetSpeechAllOf.md +41 -0
- data/docs/IncomingNumberList.md +9 -9
- data/docs/IncomingNumberListAllOf.md +2 -2
- data/docs/IncomingNumberRequest.md +3 -5
- data/docs/IncomingNumberResult.md +14 -14
- data/docs/IncomingNumberResultAllOf.md +10 -10
- data/docs/LogList.md +9 -9
- data/docs/LogListAllOf.md +2 -2
- data/docs/LogResult.md +8 -8
- data/docs/MakeCallRequest.md +11 -11
- data/docs/MessageRequest.md +10 -12
- data/docs/MessageRequestAllOf.md +6 -8
- data/docs/MessageResult.md +14 -14
- data/docs/MessageResultAllOf.md +10 -10
- data/docs/MessagesList.md +9 -9
- data/docs/MessagesListAllOf.md +2 -2
- data/docs/MutableResourceModel.md +5 -5
- data/docs/OutDial.md +35 -0
- data/docs/OutDialAllOf.md +35 -0
- data/docs/PaginationModel.md +8 -8
- data/docs/Pause.md +17 -0
- data/docs/PauseAllOf.md +17 -0
- data/docs/PerclCommand.md +17 -0
- data/docs/PerclScript.md +17 -0
- data/docs/Play.md +23 -0
- data/docs/PlayAllOf.md +23 -0
- data/docs/PlayEarlyMedia.md +17 -0
- data/docs/PlayEarlyMediaAllOf.md +17 -0
- data/docs/QueueList.md +9 -9
- data/docs/QueueListAllOf.md +2 -2
- data/docs/QueueMember.md +6 -6
- data/docs/QueueMemberList.md +9 -9
- data/docs/QueueMemberListAllOf.md +2 -2
- data/docs/QueueRequest.md +3 -5
- data/docs/QueueResult.md +12 -12
- data/docs/QueueResultAllOf.md +8 -8
- data/docs/RecordUtterance.md +27 -0
- data/docs/RecordUtteranceAllOf.md +27 -0
- data/docs/RecordingList.md +9 -9
- data/docs/RecordingListAllOf.md +2 -2
- data/docs/RecordingResult.md +10 -10
- data/docs/RecordingResultAllOf.md +6 -6
- data/docs/Redirect.md +17 -0
- data/docs/RedirectAllOf.md +17 -0
- data/docs/RemoveFromConference.md +17 -0
- data/docs/RemoveFromConferenceAllOf.md +17 -0
- data/docs/Say.md +25 -0
- data/docs/SayAllOf.md +25 -0
- data/docs/SendDigits.md +21 -0
- data/docs/SendDigitsAllOf.md +21 -0
- data/docs/SetListen.md +19 -0
- data/docs/SetListenAllOf.md +19 -0
- data/docs/SetTalk.md +19 -0
- data/docs/SetTalkAllOf.md +19 -0
- data/docs/Sms.md +23 -0
- data/docs/SmsAllOf.md +23 -0
- data/docs/StartRecordCall.md +16 -0
- data/docs/TerminateConference.md +17 -0
- data/docs/TerminateConferenceAllOf.md +17 -0
- data/docs/UpdateCallRequest.md +2 -4
- data/docs/UpdateConferenceParticipantRequest.md +3 -5
- data/docs/UpdateConferenceRequest.md +4 -6
- data/freeclimb-2.1.0.gem +0 -0
- data/lib/freeclimb.rb +69 -2
- data/lib/freeclimb/api/default_api.rb +42 -34
- data/lib/freeclimb/api_client.rb +1 -1
- data/lib/freeclimb/models/account_request.rb +4 -14
- data/lib/freeclimb/models/add_to_conference.rb +320 -0
- data/lib/freeclimb/models/add_to_conference_all_of.rb +307 -0
- data/lib/freeclimb/models/application_request.rb +4 -14
- data/lib/freeclimb/models/buy_incoming_number_request.rb +4 -14
- data/lib/freeclimb/models/create_conference.rb +275 -0
- data/lib/freeclimb/models/create_conference_all_of.rb +262 -0
- data/lib/freeclimb/models/create_conference_request.rb +4 -14
- data/lib/freeclimb/models/dequeue.rb +209 -0
- data/lib/freeclimb/models/enqueue.rb +265 -0
- data/lib/freeclimb/models/enqueue_all_of.rb +252 -0
- data/lib/freeclimb/models/filter_logs_request.rb +4 -14
- data/lib/freeclimb/models/get_digits.rb +307 -0
- data/lib/freeclimb/models/get_digits_all_of.rb +294 -0
- data/lib/freeclimb/models/get_speech.rb +352 -0
- data/lib/freeclimb/models/get_speech_all_of.rb +339 -0
- data/lib/freeclimb/models/incoming_number_request.rb +4 -14
- data/lib/freeclimb/models/make_call_request.rb +14 -14
- data/lib/freeclimb/models/message_request.rb +1 -11
- data/lib/freeclimb/models/message_request_all_of.rb +1 -11
- data/lib/freeclimb/models/message_result.rb +3 -3
- data/lib/freeclimb/models/message_result_all_of.rb +3 -3
- data/lib/freeclimb/models/out_dial.rb +330 -0
- data/lib/freeclimb/models/out_dial_all_of.rb +317 -0
- data/lib/freeclimb/models/pause.rb +225 -0
- data/lib/freeclimb/models/{dequeue_member_request.rb → pause_all_of.rb} +16 -11
- data/lib/freeclimb/models/percl_command.rb +211 -0
- data/lib/freeclimb/models/percl_script.rb +210 -0
- data/lib/freeclimb/models/play.rb +255 -0
- data/lib/freeclimb/models/play_all_of.rb +242 -0
- data/lib/freeclimb/models/play_early_media.rb +225 -0
- data/lib/freeclimb/models/play_early_media_all_of.rb +212 -0
- data/lib/freeclimb/models/queue_request.rb +4 -14
- data/lib/freeclimb/models/record_utterance.rb +275 -0
- data/lib/freeclimb/models/record_utterance_all_of.rb +262 -0
- data/lib/freeclimb/models/redirect.rb +220 -0
- data/lib/freeclimb/models/redirect_all_of.rb +207 -0
- data/lib/freeclimb/models/remove_from_conference.rb +225 -0
- data/lib/freeclimb/models/remove_from_conference_all_of.rb +212 -0
- data/lib/freeclimb/models/say.rb +265 -0
- data/lib/freeclimb/models/say_all_of.rb +252 -0
- data/lib/freeclimb/models/send_digits.rb +245 -0
- data/lib/freeclimb/models/send_digits_all_of.rb +232 -0
- data/lib/freeclimb/models/set_listen.rb +235 -0
- data/lib/freeclimb/models/set_listen_all_of.rb +222 -0
- data/lib/freeclimb/models/set_talk.rb +235 -0
- data/lib/freeclimb/models/set_talk_all_of.rb +222 -0
- data/lib/freeclimb/models/sms.rb +265 -0
- data/lib/freeclimb/models/sms_all_of.rb +252 -0
- data/lib/freeclimb/models/start_record_call.rb +209 -0
- data/lib/freeclimb/models/terminate_conference.rb +225 -0
- data/lib/freeclimb/models/terminate_conference_all_of.rb +212 -0
- data/lib/freeclimb/models/update_call_request.rb +4 -14
- data/lib/freeclimb/models/update_conference_participant_request.rb +4 -14
- data/lib/freeclimb/models/update_conference_request.rb +4 -14
- data/lib/freeclimb/version.rb +1 -1
- data/spec/api/default_api_spec.rb +9 -24
- data/spec/models/add_to_conference_spec.rb +95 -0
- data/spec/models/create_conference_spec.rb +71 -0
- data/spec/models/{dequeue_member_request_spec.rb → dequeue_spec.rb} +8 -7
- data/spec/models/enqueue_spec.rb +59 -0
- data/spec/models/get_digits_spec.rb +83 -0
- data/spec/models/get_speech_spec.rb +113 -0
- data/spec/models/out_dial_spec.rb +89 -0
- data/spec/models/pause_spec.rb +41 -0
- data/spec/models/percl_command_spec.rb +41 -0
- data/spec/models/percl_script_spec.rb +41 -0
- data/spec/models/play_early_media_spec.rb +41 -0
- data/spec/models/play_spec.rb +53 -0
- data/spec/models/record_utterance_spec.rb +71 -0
- data/spec/models/redirect_spec.rb +41 -0
- data/spec/models/remove_from_conference_spec.rb +41 -0
- data/spec/models/say_spec.rb +65 -0
- data/spec/models/send_digits_spec.rb +47 -0
- data/spec/models/set_listen_spec.rb +47 -0
- data/spec/models/set_talk_spec.rb +47 -0
- data/spec/models/sms_spec.rb +59 -0
- data/spec/models/start_record_call_spec.rb +35 -0
- data/spec/models/terminate_conference_spec.rb +41 -0
- metadata +128 -34
- data/docs/DequeueMemberRequest.md +0 -17
- data/docs/Percl.md +0 -697
- data/lib/percl/calls.rb +0 -43
- data/lib/percl/conference_participants.rb +0 -40
- data/lib/percl/conferences.rb +0 -21
- data/lib/percl/ivr.rb +0 -63
- data/lib/percl/jsonable.rb +0 -23
- data/lib/percl/percl.rb +0 -29
- data/lib/percl/queue_members.rb +0 -15
- data/lib/percl/recordings.rb +0 -15
- data/lib/percl/sms.rb +0 -11
- data/spec/percl/calls_spec.rb +0 -111
- data/spec/percl/conference_participant_spec.rb +0 -96
- data/spec/percl/conference_spec.rb +0 -46
- data/spec/percl/ivr_spec.rb +0 -155
- data/spec/percl/jsonable_spec.rb +0 -28
- data/spec/percl/percl_spec.rb +0 -31
- data/spec/percl/queue_members_spec.rb +0 -35
- data/spec/percl/recordings_spec.rb +0 -32
- data/spec/percl/sms_spec.rb +0 -29
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 8441ccfb1a1178f33d75aeb019d1c354b3f0b99cb8592f6e8cbc5870068468d9
|
4
|
+
data.tar.gz: eaa2bee445a009ad9d30fe51a3e2bec902dc8457263f109d49c8c74806ca01f6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e6c82f19d1740723a8ce1358e565c206acb4981728317feefbe35d831d48cd121f9ba253d728c6be4357b08399d1ac23a8a443ed17f9274515c6361677077a3b
|
7
|
+
data.tar.gz: e61900739545766eaf9a0c3e7da2357a6bab19811004e4c8bb146514d72946c808015e1769add1d7309d48d5ec9f4218fd25d50876cdfdedfee59f4ff3671f2a
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,80 @@
|
|
1
|
+
# Ruby SDK Changelog
|
2
|
+
All notable changes to this project will be documented in this file.
|
3
|
+
|
4
|
+
The format of this changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
5
|
+
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
6
|
+
|
7
|
+
## [Unreleased]
|
8
|
+
None
|
9
|
+
|
10
|
+
<a name="2.0.3"></a>
|
11
|
+
## [2.0.3] - 2020-12-16
|
12
|
+
### Added
|
13
|
+
- Additional message statuses for TFN functionality
|
14
|
+
|
15
|
+
<a name="2.0.2"></a>
|
16
|
+
## [2.0.2] - 2020-08-13
|
17
|
+
### Added
|
18
|
+
- Add `privacyMode` option
|
19
|
+
|
20
|
+
<a name="1.2.1"></a>
|
21
|
+
## [1.2.1] - 2020-10-14
|
22
|
+
### Changed
|
23
|
+
- Rename `setPersyUrl` to `setUrl`
|
24
|
+
|
25
|
+
### Fixed
|
26
|
+
- Properly handle empty response bodies
|
27
|
+
- Other Minor bug fixes
|
28
|
+
|
29
|
+
<a name="1.2"></a>
|
30
|
+
## [1.2] - 2019-10-16
|
31
|
+
### Changed
|
32
|
+
- Persephony is now FreeClimb
|
33
|
+
- Code cleanup
|
34
|
+
- Documentation Updates
|
35
|
+
- Test Update
|
36
|
+
|
37
|
+
### Fixed
|
38
|
+
- Update common response handler to not use bodu twice
|
39
|
+
|
40
|
+
<a name="1.1.1"></a>
|
41
|
+
## [1.1.1] - 2019-06-27
|
42
|
+
### Changed
|
43
|
+
- Minor updates to docs and code cleanup
|
44
|
+
|
45
|
+
|
46
|
+
<a name="1.1.0"></a>
|
47
|
+
## [1.1.0] - 2019-06-07
|
48
|
+
### Pull Requests
|
49
|
+
- Merge pull request [#22](https://gitlab.vailsys.com/vail-cloud-services/fc-boilerplates/javascript-sdk/issues/22) from PersephonyAPI/maintenance
|
50
|
+
|
51
|
+
|
52
|
+
<a name="1.0.0"></a>
|
53
|
+
## [1.0.0] - 2019-06-04
|
54
|
+
### Changed
|
55
|
+
- Change default api target
|
56
|
+
|
57
|
+
|
58
|
+
<a name="0.1.0"></a>
|
59
|
+
## [0.1.0] - 2019-05-30
|
60
|
+
### Added
|
61
|
+
- `PlayEarlyMedia` PerCL Command
|
62
|
+
|
63
|
+
<a name="0.0.2"></a>
|
64
|
+
## [0.0.2] - 2018-11-29
|
65
|
+
### Remove
|
66
|
+
- Remove `callConnectUrl` and `statusCallbackUrl` from api.calls#create
|
67
|
+
|
68
|
+
<a name="0.0.1"></a>
|
69
|
+
## [0.0.1] - 2018-11-13
|
70
|
+
### Added
|
71
|
+
- PerCL Support
|
72
|
+
- FreeClimb API Support
|
73
|
+
- README, LICENSE
|
74
|
+
- docs
|
75
|
+
|
76
|
+
### Changed
|
77
|
+
- Initial Release
|
78
|
+
|
79
|
+
|
80
|
+
[Unreleased]: https://github.com/FreeClimbAPI/ruby-sdk/compare/v1.0.1...HEAD
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -1,13 +1,11 @@
|
|
1
|
-
#
|
2
|
-
|
3
|
-
Freeclimb - the Ruby gem for the FreeClimb API
|
1
|
+
# FreeClimb
|
4
2
|
|
5
3
|
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.
|
6
4
|
|
7
5
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
6
|
|
9
7
|
- API version: 1.0.0
|
10
|
-
- Package version:
|
8
|
+
- Package version: 2.0.3
|
11
9
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
10
|
|
13
11
|
## Installation
|
@@ -23,16 +21,21 @@ gem build freeclimb.gemspec
|
|
23
21
|
Then either install the gem locally:
|
24
22
|
|
25
23
|
```shell
|
26
|
-
gem install ./freeclimb-
|
24
|
+
gem install ./freeclimb-2.0.3.gem
|
27
25
|
```
|
28
26
|
|
29
|
-
(for development, run `gem install --dev ./freeclimb-
|
27
|
+
(for development, run `gem install --dev ./freeclimb-2.0.3.gem` to install the development dependencies)
|
30
28
|
|
31
29
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
30
|
|
33
31
|
Finally add this to the Gemfile:
|
34
32
|
|
35
|
-
gem 'freeclimb', '~>
|
33
|
+
gem 'freeclimb', '~> 2.0.3'
|
34
|
+
|
35
|
+
### Install from Ruby gems
|
36
|
+
```shell
|
37
|
+
gem install freeclimb
|
38
|
+
```
|
36
39
|
|
37
40
|
### Install from Git
|
38
41
|
|
@@ -73,6 +76,20 @@ rescue Freeclimb::ApiError => e
|
|
73
76
|
puts "Exception when calling DefaultApi->get_an_account: #{e}"
|
74
77
|
end
|
75
78
|
|
79
|
+
```
|
80
|
+
## Documentation for PerCL
|
81
|
+
|
82
|
+
The Performance Command Language (PerCL) defines a set of instructions, written in JSON format, that express telephony actions to be performed in response to an event on the FreeClimb platform. FreeClimb communicates with the application server when events associated with the application occur, so the webserver can instruct FreeClimb how to handle such events using PerCL scripts.
|
83
|
+
PerCL commands are a part of the model schema and can be serialized into JSON like so:
|
84
|
+
|
85
|
+
```ruby
|
86
|
+
require 'freeclimb'
|
87
|
+
|
88
|
+
say = Freeclimb::Say.new(text: "Hello, World")
|
89
|
+
play = Freeclimb::Play.new(file: "Example File")
|
90
|
+
get_digits = Freeclimb::GetDigits.new(action_url: "Example Action URL", prompts: [say, play])
|
91
|
+
percl_script = Freeclimb::PerclScript.new(commands: [get_digits])
|
92
|
+
puts Freeclimb::percl_to_json(percl_script)
|
76
93
|
```
|
77
94
|
|
78
95
|
## Documentation for API Endpoints
|
@@ -128,46 +145,14 @@ Class | Method | HTTP request | Description
|
|
128
145
|
*Freeclimb::DefaultApi* | [**update_an_application**](docs/DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
|
129
146
|
*Freeclimb::DefaultApi* | [**update_an_incoming_number**](docs/DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
|
130
147
|
|
131
|
-
## Documentation for PerCL Responses
|
132
|
-
The Performance Command Language (PerCL) defines a set of instructions, written in JSON format, that express telephony actions to be performed in response to an event on the FreeClimb platform. FreeClimb communicates with the application server when events associated with the application occur, so the webserver can instruct FreeClimb how to handle such events using PerCL scripts.
|
133
|
-
|
134
|
-
When creating a Percl object, required parameters must be used in the constructer while optional parameters must be set direclty on the given Percl object. Example:
|
135
|
-
```ruby
|
136
|
-
digits = '630'
|
137
|
-
send_digits = Percl::SendDigits.new(digits)
|
138
|
-
send_digits.pauseMs = '500'
|
139
|
-
```
|
140
|
-
|
141
|
-
Class | Description
|
142
|
-
------------ | -------------
|
143
|
-
[*Percl::OutDial*](percl.md#percl::outdial) | The `OutDial` command is used to call a phone number
|
144
|
-
[*Percl::Hangup*](percl.md#percl::hangup) | The `Hangup` command terminates a Call
|
145
|
-
[*Percl::Pause*](percl.md#percl::pause) | The `Pause` command halts execution of the current PerCL script for a specified number of millisecond
|
146
|
-
[*Percl::Redirect*](percl.md#percl::redirect) | The `Redirect` command transfers control of a Call to the PerCL at a different URL
|
147
|
-
[*Percl::SendDigits*](percl.md#percl::senddigits) | The `SendDigits` command plays DTMF tones on a live Call. This is useful for navigating through IVR menus or dialing extensions
|
148
|
-
[*Percl::Reject*](percl.md#percl::reject) | The `Reject` command blocks an incoming Call.
|
149
|
-
[*Percl::CreateConference*](percl.md#percl::createConference) | The `CreateConference` command does exactly what its name implies — it creates an unpopulated Conference (one without any Participants).
|
150
|
-
[*Percl::TerminateConference*](percl.md#percl::terminateConference) | The `TerminateConference` command terminates an existing Conference.
|
151
|
-
[*Percl::AddToConference*](percl.md#percl::addToConference) | The `AddToConference` command adds a Participant to a Conference.
|
152
|
-
[*Percl::RemoveFromConference*](percl.md#percl::removeFromConference) | The `RemoveFromConference` command removes a Participant from a Conference but does not hang up.
|
153
|
-
[*Percl::SetListen*](percl.md#percl::setListen) | The `SetListen` command enables or disables the listen privilege for a Conference Participant provided both calls are in the same conference.
|
154
|
-
[*Percl::SetTalk*](percl.md#percl::setTalk) | The `SetTalk` command enables or disables the talk privilege for a Participant in a Conference provided both calls are in the same conference.
|
155
|
-
[*Percl::Enqueue*](percl.md#percl::enqueue) | The `Enqueue` command adds the current Call to a call Queue.
|
156
|
-
[*Percl::Dequeue*](percl.md#percl::dequeue) | The `Dequeue` command transfers control of a Call that is in a Queue so that the waiting caller exits the Queue.
|
157
|
-
[*Percl::RecordUtterance*](percl.md#percl::recordUtterance) | The `RecordUtterance` command records the caller's voice and returns the URL of a file containing the audio recording.
|
158
|
-
[*Percl::StartRecordCall*](percl.md#percl::startRecordCall) | The `StartRecordCall` command records the current call and returns the URL of a file containing the audio recording when recording completes.
|
159
|
-
[*Percl::PlayEarlyMedia*](percl.md#percl::playEarlyMedia) | The `PlayEarlyMedia` command plays A media file before attempting to connect a call
|
160
|
-
[*Percl::Play*](percl.md#percl::play) | the `Play` command plays an audio file back to the caller.
|
161
|
-
[*Percl::Say*](percl.md#percl::say) | The `Say` command provides Text-To-Speech (TTS) support. It converts text to speech and then renders it in a female voice back to the caller.
|
162
|
-
[*Percl::GetDigits*](percl.md#percl::getDigits) | The `GetDigits` command collects DTMF inputs from the caller.
|
163
|
-
[*Percl::GetSpeech*](percl.md#percl::getSpeech) | The `GetSpeech` command enables the Caller to respond to the application using a supported language.
|
164
|
-
[*Percl::Sms*](percl.md#percl::Sms) | The `Sms` command can be used to send an SMS message to a phone number during a phone call.
|
165
148
|
|
166
149
|
## Documentation for Models
|
167
150
|
|
168
151
|
- [Freeclimb::AccountRequest](docs/AccountRequest.md)
|
169
152
|
- [Freeclimb::AccountResult](docs/AccountResult.md)
|
170
153
|
- [Freeclimb::AccountResultAllOf](docs/AccountResultAllOf.md)
|
154
|
+
- [Freeclimb::AddToConference](docs/AddToConference.md)
|
155
|
+
- [Freeclimb::AddToConferenceAllOf](docs/AddToConferenceAllOf.md)
|
171
156
|
- [Freeclimb::ApplicationList](docs/ApplicationList.md)
|
172
157
|
- [Freeclimb::ApplicationListAllOf](docs/ApplicationListAllOf.md)
|
173
158
|
- [Freeclimb::ApplicationRequest](docs/ApplicationRequest.md)
|
@@ -189,9 +174,17 @@ Class | Description
|
|
189
174
|
- [Freeclimb::ConferenceParticipantResultAllOf](docs/ConferenceParticipantResultAllOf.md)
|
190
175
|
- [Freeclimb::ConferenceResult](docs/ConferenceResult.md)
|
191
176
|
- [Freeclimb::ConferenceResultAllOf](docs/ConferenceResultAllOf.md)
|
177
|
+
- [Freeclimb::CreateConference](docs/CreateConference.md)
|
178
|
+
- [Freeclimb::CreateConferenceAllOf](docs/CreateConferenceAllOf.md)
|
192
179
|
- [Freeclimb::CreateConferenceRequest](docs/CreateConferenceRequest.md)
|
193
|
-
- [Freeclimb::
|
180
|
+
- [Freeclimb::Dequeue](docs/Dequeue.md)
|
181
|
+
- [Freeclimb::Enqueue](docs/Enqueue.md)
|
182
|
+
- [Freeclimb::EnqueueAllOf](docs/EnqueueAllOf.md)
|
194
183
|
- [Freeclimb::FilterLogsRequest](docs/FilterLogsRequest.md)
|
184
|
+
- [Freeclimb::GetDigits](docs/GetDigits.md)
|
185
|
+
- [Freeclimb::GetDigitsAllOf](docs/GetDigitsAllOf.md)
|
186
|
+
- [Freeclimb::GetSpeech](docs/GetSpeech.md)
|
187
|
+
- [Freeclimb::GetSpeechAllOf](docs/GetSpeechAllOf.md)
|
195
188
|
- [Freeclimb::IncomingNumberList](docs/IncomingNumberList.md)
|
196
189
|
- [Freeclimb::IncomingNumberListAllOf](docs/IncomingNumberListAllOf.md)
|
197
190
|
- [Freeclimb::IncomingNumberRequest](docs/IncomingNumberRequest.md)
|
@@ -208,7 +201,17 @@ Class | Description
|
|
208
201
|
- [Freeclimb::MessagesList](docs/MessagesList.md)
|
209
202
|
- [Freeclimb::MessagesListAllOf](docs/MessagesListAllOf.md)
|
210
203
|
- [Freeclimb::MutableResourceModel](docs/MutableResourceModel.md)
|
204
|
+
- [Freeclimb::OutDial](docs/OutDial.md)
|
205
|
+
- [Freeclimb::OutDialAllOf](docs/OutDialAllOf.md)
|
211
206
|
- [Freeclimb::PaginationModel](docs/PaginationModel.md)
|
207
|
+
- [Freeclimb::Pause](docs/Pause.md)
|
208
|
+
- [Freeclimb::PauseAllOf](docs/PauseAllOf.md)
|
209
|
+
- [Freeclimb::PerclCommand](docs/PerclCommand.md)
|
210
|
+
- [Freeclimb::PerclScript](docs/PerclScript.md)
|
211
|
+
- [Freeclimb::Play](docs/Play.md)
|
212
|
+
- [Freeclimb::PlayAllOf](docs/PlayAllOf.md)
|
213
|
+
- [Freeclimb::PlayEarlyMedia](docs/PlayEarlyMedia.md)
|
214
|
+
- [Freeclimb::PlayEarlyMediaAllOf](docs/PlayEarlyMediaAllOf.md)
|
212
215
|
- [Freeclimb::QueueList](docs/QueueList.md)
|
213
216
|
- [Freeclimb::QueueListAllOf](docs/QueueListAllOf.md)
|
214
217
|
- [Freeclimb::QueueMember](docs/QueueMember.md)
|
@@ -217,10 +220,29 @@ Class | Description
|
|
217
220
|
- [Freeclimb::QueueRequest](docs/QueueRequest.md)
|
218
221
|
- [Freeclimb::QueueResult](docs/QueueResult.md)
|
219
222
|
- [Freeclimb::QueueResultAllOf](docs/QueueResultAllOf.md)
|
223
|
+
- [Freeclimb::RecordUtterance](docs/RecordUtterance.md)
|
224
|
+
- [Freeclimb::RecordUtteranceAllOf](docs/RecordUtteranceAllOf.md)
|
220
225
|
- [Freeclimb::RecordingList](docs/RecordingList.md)
|
221
226
|
- [Freeclimb::RecordingListAllOf](docs/RecordingListAllOf.md)
|
222
227
|
- [Freeclimb::RecordingResult](docs/RecordingResult.md)
|
223
228
|
- [Freeclimb::RecordingResultAllOf](docs/RecordingResultAllOf.md)
|
229
|
+
- [Freeclimb::Redirect](docs/Redirect.md)
|
230
|
+
- [Freeclimb::RedirectAllOf](docs/RedirectAllOf.md)
|
231
|
+
- [Freeclimb::RemoveFromConference](docs/RemoveFromConference.md)
|
232
|
+
- [Freeclimb::RemoveFromConferenceAllOf](docs/RemoveFromConferenceAllOf.md)
|
233
|
+
- [Freeclimb::Say](docs/Say.md)
|
234
|
+
- [Freeclimb::SayAllOf](docs/SayAllOf.md)
|
235
|
+
- [Freeclimb::SendDigits](docs/SendDigits.md)
|
236
|
+
- [Freeclimb::SendDigitsAllOf](docs/SendDigitsAllOf.md)
|
237
|
+
- [Freeclimb::SetListen](docs/SetListen.md)
|
238
|
+
- [Freeclimb::SetListenAllOf](docs/SetListenAllOf.md)
|
239
|
+
- [Freeclimb::SetTalk](docs/SetTalk.md)
|
240
|
+
- [Freeclimb::SetTalkAllOf](docs/SetTalkAllOf.md)
|
241
|
+
- [Freeclimb::Sms](docs/Sms.md)
|
242
|
+
- [Freeclimb::SmsAllOf](docs/SmsAllOf.md)
|
243
|
+
- [Freeclimb::StartRecordCall](docs/StartRecordCall.md)
|
244
|
+
- [Freeclimb::TerminateConference](docs/TerminateConference.md)
|
245
|
+
- [Freeclimb::TerminateConferenceAllOf](docs/TerminateConferenceAllOf.md)
|
224
246
|
- [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)
|
225
247
|
- [Freeclimb::UpdateConferenceParticipantRequest](docs/UpdateConferenceParticipantRequest.md)
|
226
248
|
- [Freeclimb::UpdateConferenceRequest](docs/UpdateConferenceRequest.md)
|
@@ -233,3 +255,6 @@ Class | Description
|
|
233
255
|
|
234
256
|
- **Type**: HTTP basic authentication
|
235
257
|
|
258
|
+
## Getting Help
|
259
|
+
|
260
|
+
If you are experiencing difficulties, [contact support](https://freeclimb.com/support).
|
data/docs/AccountRequest.md
CHANGED
@@ -6,16 +6,14 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**_alias** | **String** | Description for this account. | [optional]
|
8
8
|
**label** | **String** | Group to which this account belongs. | [optional]
|
9
|
-
**request_id** | **String** | 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]
|
10
9
|
|
11
10
|
## Code Sample
|
12
11
|
|
13
12
|
```ruby
|
14
|
-
require '
|
13
|
+
require 'freeclimb'
|
15
14
|
|
16
|
-
instance = Freeclimb::AccountRequest.new(_alias:
|
17
|
-
label:
|
18
|
-
request_id: null)
|
15
|
+
instance = Freeclimb::AccountRequest.new(_alias: nil,
|
16
|
+
label: nil)
|
19
17
|
```
|
20
18
|
|
21
19
|
|
data/docs/AccountResult.md
CHANGED
@@ -19,19 +19,19 @@ Name | Type | Description | Notes
|
|
19
19
|
## Code Sample
|
20
20
|
|
21
21
|
```ruby
|
22
|
-
require '
|
22
|
+
require 'freeclimb'
|
23
23
|
|
24
|
-
instance = Freeclimb::AccountResult.new(uri:
|
25
|
-
date_created:
|
26
|
-
date_updated:
|
27
|
-
revision:
|
28
|
-
account_id:
|
29
|
-
auth_token:
|
30
|
-
_alias:
|
31
|
-
label:
|
32
|
-
type:
|
33
|
-
status:
|
34
|
-
subresource_uris:
|
24
|
+
instance = Freeclimb::AccountResult.new(uri: nil,
|
25
|
+
date_created: nil,
|
26
|
+
date_updated: nil,
|
27
|
+
revision: nil,
|
28
|
+
account_id: nil,
|
29
|
+
auth_token: nil,
|
30
|
+
_alias: nil,
|
31
|
+
label: nil,
|
32
|
+
type: nil,
|
33
|
+
status: nil,
|
34
|
+
subresource_uris: nil)
|
35
35
|
```
|
36
36
|
|
37
37
|
|
data/docs/AccountResultAllOf.md
CHANGED
@@ -15,15 +15,15 @@ Name | Type | Description | Notes
|
|
15
15
|
## Code Sample
|
16
16
|
|
17
17
|
```ruby
|
18
|
-
require '
|
18
|
+
require 'freeclimb'
|
19
19
|
|
20
|
-
instance = Freeclimb::AccountResultAllOf.new(account_id:
|
21
|
-
auth_token:
|
22
|
-
_alias:
|
23
|
-
label:
|
24
|
-
type:
|
25
|
-
status:
|
26
|
-
subresource_uris:
|
20
|
+
instance = Freeclimb::AccountResultAllOf.new(account_id: nil,
|
21
|
+
auth_token: nil,
|
22
|
+
_alias: nil,
|
23
|
+
label: nil,
|
24
|
+
type: nil,
|
25
|
+
status: nil,
|
26
|
+
subresource_uris: nil)
|
27
27
|
```
|
28
28
|
|
29
29
|
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# Freeclimb::AddToConference
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**allow_call_control** | **Boolean** | If `true`, Call control will be enabled for this Participant's Call leg. | [optional]
|
8
|
+
**call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the `callControlUrl`. Only digits plus '*', and '#' may be used. | [optional]
|
9
|
+
**call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute. | [optional]
|
10
|
+
**conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. |
|
11
|
+
**call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. |
|
12
|
+
**leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
|
13
|
+
**listen** | **Boolean** | If `true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command. | [optional]
|
14
|
+
**notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
|
15
|
+
**start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants. | [optional]
|
16
|
+
**talk** | **Boolean** | If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command. | [optional]
|
17
|
+
|
18
|
+
## Code Sample
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'freeclimb'
|
22
|
+
|
23
|
+
instance = Freeclimb::AddToConference.new(allow_call_control: nil,
|
24
|
+
call_control_sequence: nil,
|
25
|
+
call_control_url: nil,
|
26
|
+
conference_id: nil,
|
27
|
+
call_id: nil,
|
28
|
+
leave_conference_url: nil,
|
29
|
+
listen: nil,
|
30
|
+
notification_url: nil,
|
31
|
+
start_conf_on_enter: nil,
|
32
|
+
talk: nil)
|
33
|
+
```
|
34
|
+
|
35
|
+
|
@@ -0,0 +1,35 @@
|
|
1
|
+
# Freeclimb::AddToConferenceAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**allow_call_control** | **Boolean** | If `true`, Call control will be enabled for this Participant's Call leg. | [optional]
|
8
|
+
**call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the `callControlUrl`. Only digits plus '*', and '#' may be used. | [optional]
|
9
|
+
**call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute. | [optional]
|
10
|
+
**conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. |
|
11
|
+
**call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. |
|
12
|
+
**leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
|
13
|
+
**listen** | **Boolean** | If `true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command. | [optional]
|
14
|
+
**notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
|
15
|
+
**start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants. | [optional]
|
16
|
+
**talk** | **Boolean** | If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command. | [optional]
|
17
|
+
|
18
|
+
## Code Sample
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'freeclimb'
|
22
|
+
|
23
|
+
instance = Freeclimb::AddToConferenceAllOf.new(allow_call_control: nil,
|
24
|
+
call_control_sequence: nil,
|
25
|
+
call_control_url: nil,
|
26
|
+
conference_id: nil,
|
27
|
+
call_id: nil,
|
28
|
+
leave_conference_url: nil,
|
29
|
+
listen: nil,
|
30
|
+
notification_url: nil,
|
31
|
+
start_conf_on_enter: nil,
|
32
|
+
talk: nil)
|
33
|
+
```
|
34
|
+
|
35
|
+
|
data/docs/ApplicationList.md
CHANGED
@@ -16,16 +16,16 @@ Name | Type | Description | Notes
|
|
16
16
|
## Code Sample
|
17
17
|
|
18
18
|
```ruby
|
19
|
-
require '
|
19
|
+
require 'freeclimb'
|
20
20
|
|
21
|
-
instance = Freeclimb::ApplicationList.new(total:
|
22
|
-
start:
|
23
|
-
_end:
|
24
|
-
page:
|
25
|
-
num_pages:
|
26
|
-
page_size:
|
27
|
-
next_page_uri:
|
28
|
-
applications:
|
21
|
+
instance = Freeclimb::ApplicationList.new(total: nil,
|
22
|
+
start: nil,
|
23
|
+
_end: nil,
|
24
|
+
page: nil,
|
25
|
+
num_pages: nil,
|
26
|
+
page_size: nil,
|
27
|
+
next_page_uri: nil,
|
28
|
+
applications: nil)
|
29
29
|
```
|
30
30
|
|
31
31
|
|