freeclimb 2.0.1 → 2.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +100 -0
- data/README.md +11 -4
- data/docs/GetDigits.md +3 -1
- data/docs/GetDigitsAllOf.md +3 -1
- data/docs/GetSpeech.md +2 -2
- data/docs/GetSpeechAllOf.md +2 -2
- data/docs/Hangup.md +17 -0
- data/docs/HangupAllOf.md +17 -0
- data/docs/MakeCallRequest.md +7 -3
- data/docs/MessageResult.md +1 -1
- data/docs/MessageResultAllOf.md +1 -1
- data/docs/OutDial.md +3 -1
- data/docs/OutDialAllOf.md +3 -1
- data/docs/Play.md +3 -1
- data/docs/PlayAllOf.md +3 -1
- data/docs/RecordUtterance.md +3 -1
- data/docs/RecordUtteranceAllOf.md +3 -1
- data/docs/Redirect.md +1 -1
- data/docs/RedirectAllOf.md +1 -1
- data/docs/Reject.md +17 -0
- data/docs/RejectAllOf.md +17 -0
- data/docs/Say.md +2 -2
- data/docs/SayAllOf.md +2 -2
- data/docs/SendDigits.md +3 -1
- data/docs/SendDigitsAllOf.md +3 -1
- 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/lib/freeclimb.rb +4 -0
- data/lib/freeclimb/api_client.rb +1 -1
- data/lib/freeclimb/models/get_digits.rb +14 -4
- data/lib/freeclimb/models/get_digits_all_of.rb +14 -4
- data/lib/freeclimb/models/get_speech.rb +8 -8
- data/lib/freeclimb/models/get_speech_all_of.rb +8 -8
- data/lib/freeclimb/models/hangup.rb +220 -0
- data/lib/freeclimb/models/hangup_all_of.rb +207 -0
- data/lib/freeclimb/models/make_call_request.rb +26 -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 +14 -4
- data/lib/freeclimb/models/out_dial_all_of.rb +14 -4
- data/lib/freeclimb/models/play.rb +14 -4
- data/lib/freeclimb/models/play_all_of.rb +14 -4
- data/lib/freeclimb/models/record_utterance.rb +14 -4
- data/lib/freeclimb/models/record_utterance_all_of.rb +14 -4
- data/lib/freeclimb/models/redirect.rb +7 -2
- data/lib/freeclimb/models/redirect_all_of.rb +6 -1
- data/lib/freeclimb/models/reject.rb +220 -0
- data/lib/freeclimb/models/reject_all_of.rb +207 -0
- data/lib/freeclimb/models/say.rb +8 -8
- data/lib/freeclimb/models/say_all_of.rb +8 -8
- data/lib/freeclimb/models/send_digits.rb +14 -4
- data/lib/freeclimb/models/send_digits_all_of.rb +14 -4
- data/lib/freeclimb/version.rb +1 -1
- data/spec/models/hangup_spec.rb +41 -0
- data/spec/models/reject_spec.rb +41 -0
- metadata +18 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 74fbd3e95a615cbce3500873c8a4327c1c7d75196ff38ce887bdd10186973ab6
|
4
|
+
data.tar.gz: dc982f026dee3aacb7ef6a36ef73ac6b8957cffc40e111e3a546345ee6f4a8ee
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6beb69d6d9abfe2a17ebf688f64b218655b6bdb2bc30bcc532374d9bd7a619265689f95194dc108009db41d1011b450cc7abb192be8e0ea81dbcb15740fca82e
|
7
|
+
data.tar.gz: 3ea6744cbcca10ed7a9f48a6762f371351f453543b05aeba154e41c31cc4254af850872ff9b1583e97324c6d611f254c5a131c4b5efb31cea576e2dd2b1a15b1
|
data/CHANGELOG.md
ADDED
@@ -0,0 +1,100 @@
|
|
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.1.2"></a>
|
11
|
+
## [2.1.2] - 2021-03-10
|
12
|
+
### Added
|
13
|
+
- Add `callConnectUrl` option to MakeACall Request
|
14
|
+
|
15
|
+
|
16
|
+
<a name="2.1.1"></a>
|
17
|
+
## [2.1.1] - 2020-12-16
|
18
|
+
### Added
|
19
|
+
- Add `privacyMode` option to RecordUtterance PerCL command
|
20
|
+
|
21
|
+
<a name="2.1.0"></a>
|
22
|
+
## [2.1.0] - 2020-12-16
|
23
|
+
### Added
|
24
|
+
- Add `Reject` PerCL command
|
25
|
+
- Add `Hangup` PerCL command
|
26
|
+
|
27
|
+
### Fixed
|
28
|
+
- Updated description and requirement of `action_url` attribute of `Redirect` PerCL command
|
29
|
+
|
30
|
+
<a name="2.0.3"></a>
|
31
|
+
## [2.0.3] - 2020-12-16
|
32
|
+
### Added
|
33
|
+
- Additional message statuses for TFN functionality
|
34
|
+
|
35
|
+
<a name="2.0.2"></a>
|
36
|
+
## [2.0.2] - 2020-08-13
|
37
|
+
### Added
|
38
|
+
- Add `privacyMode` option
|
39
|
+
|
40
|
+
<a name="1.2.1"></a>
|
41
|
+
## [1.2.1] - 2020-10-14
|
42
|
+
### Changed
|
43
|
+
- Rename `setPersyUrl` to `setUrl`
|
44
|
+
|
45
|
+
### Fixed
|
46
|
+
- Properly handle empty response bodies
|
47
|
+
- Other Minor bug fixes
|
48
|
+
|
49
|
+
<a name="1.2"></a>
|
50
|
+
## [1.2] - 2019-10-16
|
51
|
+
### Changed
|
52
|
+
- Persephony is now FreeClimb
|
53
|
+
- Code cleanup
|
54
|
+
- Documentation Updates
|
55
|
+
- Test Update
|
56
|
+
|
57
|
+
### Fixed
|
58
|
+
- Update common response handler to not use bodu twice
|
59
|
+
|
60
|
+
<a name="1.1.1"></a>
|
61
|
+
## [1.1.1] - 2019-06-27
|
62
|
+
### Changed
|
63
|
+
- Minor updates to docs and code cleanup
|
64
|
+
|
65
|
+
|
66
|
+
<a name="1.1.0"></a>
|
67
|
+
## [1.1.0] - 2019-06-07
|
68
|
+
### Pull Requests
|
69
|
+
- Merge pull request [#22](https://gitlab.vailsys.com/vail-cloud-services/fc-boilerplates/javascript-sdk/issues/22) from PersephonyAPI/maintenance
|
70
|
+
|
71
|
+
|
72
|
+
<a name="1.0.0"></a>
|
73
|
+
## [1.0.0] - 2019-06-04
|
74
|
+
### Changed
|
75
|
+
- Change default api target
|
76
|
+
|
77
|
+
|
78
|
+
<a name="0.1.0"></a>
|
79
|
+
## [0.1.0] - 2019-05-30
|
80
|
+
### Added
|
81
|
+
- `PlayEarlyMedia` PerCL Command
|
82
|
+
|
83
|
+
<a name="0.0.2"></a>
|
84
|
+
## [0.0.2] - 2018-11-29
|
85
|
+
### Remove
|
86
|
+
- Remove `callConnectUrl` and `statusCallbackUrl` from api.calls#create
|
87
|
+
|
88
|
+
<a name="0.0.1"></a>
|
89
|
+
## [0.0.1] - 2018-11-13
|
90
|
+
### Added
|
91
|
+
- PerCL Support
|
92
|
+
- FreeClimb API Support
|
93
|
+
- README, LICENSE
|
94
|
+
- docs
|
95
|
+
|
96
|
+
### Changed
|
97
|
+
- Initial Release
|
98
|
+
|
99
|
+
|
100
|
+
[Unreleased]: https://github.com/FreeClimbAPI/ruby-sdk/compare/v1.0.1...HEAD
|
data/README.md
CHANGED
@@ -5,7 +5,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
|
|
5
5
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
6
6
|
|
7
7
|
- API version: 1.0.0
|
8
|
-
- Package version: 2.
|
8
|
+
- Package version: 2.1.2
|
9
9
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
10
10
|
|
11
11
|
## Installation
|
@@ -21,16 +21,16 @@ gem build freeclimb.gemspec
|
|
21
21
|
Then either install the gem locally:
|
22
22
|
|
23
23
|
```shell
|
24
|
-
gem install ./freeclimb-2.
|
24
|
+
gem install ./freeclimb-2.1.2.gem
|
25
25
|
```
|
26
26
|
|
27
|
-
(for development, run `gem install --dev ./freeclimb-2.
|
27
|
+
(for development, run `gem install --dev ./freeclimb-2.1.2.gem` to install the development dependencies)
|
28
28
|
|
29
29
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
30
30
|
|
31
31
|
Finally add this to the Gemfile:
|
32
32
|
|
33
|
-
gem 'freeclimb', '~> 2.
|
33
|
+
gem 'freeclimb', '~> 2.1.2'
|
34
34
|
|
35
35
|
### Install from Ruby gems
|
36
36
|
```shell
|
@@ -185,6 +185,8 @@ Class | Method | HTTP request | Description
|
|
185
185
|
- [Freeclimb::GetDigitsAllOf](docs/GetDigitsAllOf.md)
|
186
186
|
- [Freeclimb::GetSpeech](docs/GetSpeech.md)
|
187
187
|
- [Freeclimb::GetSpeechAllOf](docs/GetSpeechAllOf.md)
|
188
|
+
- [Freeclimb::Hangup](docs/Hangup.md)
|
189
|
+
- [Freeclimb::HangupAllOf](docs/HangupAllOf.md)
|
188
190
|
- [Freeclimb::IncomingNumberList](docs/IncomingNumberList.md)
|
189
191
|
- [Freeclimb::IncomingNumberListAllOf](docs/IncomingNumberListAllOf.md)
|
190
192
|
- [Freeclimb::IncomingNumberRequest](docs/IncomingNumberRequest.md)
|
@@ -228,6 +230,8 @@ Class | Method | HTTP request | Description
|
|
228
230
|
- [Freeclimb::RecordingResultAllOf](docs/RecordingResultAllOf.md)
|
229
231
|
- [Freeclimb::Redirect](docs/Redirect.md)
|
230
232
|
- [Freeclimb::RedirectAllOf](docs/RedirectAllOf.md)
|
233
|
+
- [Freeclimb::Reject](docs/Reject.md)
|
234
|
+
- [Freeclimb::RejectAllOf](docs/RejectAllOf.md)
|
231
235
|
- [Freeclimb::RemoveFromConference](docs/RemoveFromConference.md)
|
232
236
|
- [Freeclimb::RemoveFromConferenceAllOf](docs/RemoveFromConferenceAllOf.md)
|
233
237
|
- [Freeclimb::Say](docs/Say.md)
|
@@ -255,3 +259,6 @@ Class | Method | HTTP request | Description
|
|
255
259
|
|
256
260
|
- **Type**: HTTP basic authentication
|
257
261
|
|
262
|
+
## Getting Help
|
263
|
+
|
264
|
+
If you are experiencing difficulties, [contact support](https://freeclimb.com/support).
|
data/docs/GetDigits.md
CHANGED
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**max_digits** | **Integer** | Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`. | [optional]
|
13
13
|
**min_digits** | **Integer** | Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits. | [optional]
|
14
14
|
**prompts** | [**Array<PerclCommand>**](PerclCommand.md) | JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller. | [optional]
|
15
|
+
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
15
16
|
|
16
17
|
## Code Sample
|
17
18
|
|
@@ -25,7 +26,8 @@ instance = Freeclimb::GetDigits.new(action_url: nil,
|
|
25
26
|
initial_timeout_ms: nil,
|
26
27
|
max_digits: nil,
|
27
28
|
min_digits: nil,
|
28
|
-
prompts: nil
|
29
|
+
prompts: nil,
|
30
|
+
privacy_mode: nil)
|
29
31
|
```
|
30
32
|
|
31
33
|
|
data/docs/GetDigitsAllOf.md
CHANGED
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**max_digits** | **Integer** | Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`. | [optional]
|
13
13
|
**min_digits** | **Integer** | Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits. | [optional]
|
14
14
|
**prompts** | [**Array<PerclCommand>**](PerclCommand.md) | JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller. | [optional]
|
15
|
+
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
15
16
|
|
16
17
|
## Code Sample
|
17
18
|
|
@@ -25,7 +26,8 @@ instance = Freeclimb::GetDigitsAllOf.new(action_url: nil,
|
|
25
26
|
initial_timeout_ms: nil,
|
26
27
|
max_digits: nil,
|
27
28
|
min_digits: nil,
|
28
|
-
prompts: nil
|
29
|
+
prompts: nil,
|
30
|
+
privacy_mode: nil)
|
29
31
|
```
|
30
32
|
|
31
33
|
|
data/docs/GetSpeech.md
CHANGED
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
16
16
|
**sensitivity_level** | **Float** | The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0 | [optional]
|
17
17
|
**speech_complete_timeout_ms** | **Integer** | Parameter `speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds. | [optional]
|
18
18
|
**speech_incomplete_timeout_ms** | **Integer** | Parameter `speechIncompleteTimeoutMs` specifies the length of silence following user speech after which a recognizer finalizes a result. This timeout applies when the speech prior to the silence is an incomplete match of all active grammars. Timeout `speechIncompleteTimeoutMs` is usually longer than `speechCompleteTimeoutMs` to allow users to pause mid-utterance. | [optional]
|
19
|
-
**
|
19
|
+
**privacy_mode** | **Boolean** | Parameter privacyMode will not log the `text` as required by PCI compliance. | [optional]
|
20
20
|
|
21
21
|
## Code Sample
|
22
22
|
|
@@ -35,7 +35,7 @@ instance = Freeclimb::GetSpeech.new(action_url: nil,
|
|
35
35
|
sensitivity_level: nil,
|
36
36
|
speech_complete_timeout_ms: nil,
|
37
37
|
speech_incomplete_timeout_ms: nil,
|
38
|
-
|
38
|
+
privacy_mode: nil)
|
39
39
|
```
|
40
40
|
|
41
41
|
|
data/docs/GetSpeechAllOf.md
CHANGED
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
16
16
|
**sensitivity_level** | **Float** | The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0 | [optional]
|
17
17
|
**speech_complete_timeout_ms** | **Integer** | Parameter `speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds. | [optional]
|
18
18
|
**speech_incomplete_timeout_ms** | **Integer** | Parameter `speechIncompleteTimeoutMs` specifies the length of silence following user speech after which a recognizer finalizes a result. This timeout applies when the speech prior to the silence is an incomplete match of all active grammars. Timeout `speechIncompleteTimeoutMs` is usually longer than `speechCompleteTimeoutMs` to allow users to pause mid-utterance. | [optional]
|
19
|
-
**
|
19
|
+
**privacy_mode** | **Boolean** | Parameter privacyMode will not log the `text` as required by PCI compliance. | [optional]
|
20
20
|
|
21
21
|
## Code Sample
|
22
22
|
|
@@ -35,7 +35,7 @@ instance = Freeclimb::GetSpeechAllOf.new(action_url: nil,
|
|
35
35
|
sensitivity_level: nil,
|
36
36
|
speech_complete_timeout_ms: nil,
|
37
37
|
speech_incomplete_timeout_ms: nil,
|
38
|
-
|
38
|
+
privacy_mode: nil)
|
39
39
|
```
|
40
40
|
|
41
41
|
|
data/docs/Hangup.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::Hangup
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**reason** | **String** | The user defined reason for the hangup. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the Call flows for the given application. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'freeclimb'
|
13
|
+
|
14
|
+
instance = Freeclimb::Hangup.new(reason: nil)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/HangupAllOf.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::HangupAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**reason** | **String** | The user defined reason for the hangup. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the Call flows for the given application. | [optional]
|
8
|
+
|
9
|
+
## Code Sample
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'freeclimb'
|
13
|
+
|
14
|
+
instance = Freeclimb::HangupAllOf.new(reason: nil)
|
15
|
+
```
|
16
|
+
|
17
|
+
|
data/docs/MakeCallRequest.md
CHANGED
@@ -6,12 +6,14 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**from** | **String** | Phone number to use as the caller ID. This can be: (a) The To or From number provided in FreeClimb's initial request to your app or (b) Any incoming phone number you have purchased from FreeClimb. |
|
8
8
|
**to** | **String** | Phone number to place the Call to. |
|
9
|
-
**application_id** | **String** | ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the `callConnectUrl` and `statusCallbackUrl` set on the application.
|
9
|
+
**application_id** | **String** | Required if no `parentCallId` or `callConnectUrl` has been provided. ID of the application FreeClimb should use to handle this phone call. FreeClimb will use the `callConnectUrl` and `statusCallbackUrl` set on the application unless the `callConnectUrl` attribute is also provided with the request. In this case, the URL specified in that `callConnectUrl` attribute will be used as a replacement of the `callConnectUrl` originally assigned in the application. If the `callConnectUrl` is not set as either an attribute of the request or as part of the specified application, an error will be provided. The application’s voiceUrl parameter is not used for outbound calls. | [optional]
|
10
10
|
**send_digits** | **String** | String of digits to dial after connecting to the number. It can include digits `0-9`, `*`, and `#`, and allows embedding a pause between the output of individual digits. The default pause is 500 milliseconds. So, a string such as *1234#* will be played in 2 seconds because of the 4 standard pauses implied within the string. A custom pause is specified by including a positive integer wrapped in curly braces: {n}. For more information, see **sendDigits examples** below. | [optional]
|
11
11
|
**if_machine** | **String** | Specifies how FreeClimb should handle this Call if an answering machine answers it. | [optional]
|
12
12
|
**if_machine_url** | **String** | This attribute specifies a URL to which FreeClimb will make a POST request when an answering machine or a fax machine is detected. This URL is required if the ifMachine flag is set to redirect. When ifMachine is set to hangup, ifMachineUrl must not be included in the request. For more information, see **ifMachineUrl example** below. | [optional]
|
13
13
|
**timeout** | **Integer** | Number of seconds that FreeClimb should allow the phone to ring before assuming there is no answer. Default is 30 seconds. Maximum allowed ring-time is determined by the target phone's provider. Note that most providers limit ring-time to 120 seconds. | [optional]
|
14
|
-
**parent_call_id** | **String** | The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing.
|
14
|
+
**parent_call_id** | **String** | Required if no `applicationId` or `callConnectUrl` has been provided. The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing. An outbound call is considered to be in progress once the `outdialConnect` or `outdialApiConnect` webhook is invoked. An inbound call is ringing when the inbound webhook is invoked. If a `callConnectUrl` attribute is also included with the `parentCallId` in the request, this URL will be used as a replacement of the `callConnectUrl` originally assigned in the parent call. | [optional]
|
15
|
+
**privacy_mode** | **Boolean** | Activate privacy mode in order to obscure log data that can potentially expose private information. | [optional]
|
16
|
+
**call_connect_url** | **String** | The URL that FreeClimb should use to handle this phone call. If an applicationId or parentCallId have already been provided, this callConnectUrl attribute will be used as a replacement of the callConnectUrl originally assigned in the application or parent call. | [optional]
|
15
17
|
|
16
18
|
## Code Sample
|
17
19
|
|
@@ -25,7 +27,9 @@ instance = Freeclimb::MakeCallRequest.new(from: nil,
|
|
25
27
|
if_machine: nil,
|
26
28
|
if_machine_url: nil,
|
27
29
|
timeout: nil,
|
28
|
-
parent_call_id: nil
|
30
|
+
parent_call_id: nil,
|
31
|
+
privacy_mode: nil,
|
32
|
+
call_connect_url: nil)
|
29
33
|
```
|
30
34
|
|
31
35
|
|
data/docs/MessageResult.md
CHANGED
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
|
|
10
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
11
|
**account_id** | **String** | String that uniquely identifies this account resource. | [optional]
|
12
12
|
**message_id** | **String** | String that uniquely identifies this message resource | [optional]
|
13
|
-
**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received | [optional]
|
13
|
+
**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional]
|
14
14
|
**from** | **String** | Phone number in E.164 format that sent the message. | [optional]
|
15
15
|
**to** | **String** | Phone number in E.164 format that received the message. | [optional]
|
16
16
|
**text** | **String** | Message contents | [optional]
|
data/docs/MessageResultAllOf.md
CHANGED
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
7
|
**account_id** | **String** | String that uniquely identifies this account resource. | [optional]
|
8
8
|
**message_id** | **String** | String that uniquely identifies this message resource | [optional]
|
9
|
-
**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received | [optional]
|
9
|
+
**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional]
|
10
10
|
**from** | **String** | Phone number in E.164 format that sent the message. | [optional]
|
11
11
|
**to** | **String** | Phone number in E.164 format that received the message. | [optional]
|
12
12
|
**text** | **String** | Message contents | [optional]
|
data/docs/OutDial.md
CHANGED
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
**send_digits** | **String** | DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension. | [optional]
|
14
14
|
**status_callback_url** | **String** | When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored. | [optional]
|
15
15
|
**timeout** | **Integer** | Maximum time in seconds the `OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`. | [optional]
|
16
|
+
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
16
17
|
|
17
18
|
## Code Sample
|
18
19
|
|
@@ -27,7 +28,8 @@ instance = Freeclimb::OutDial.new(action_url: nil,
|
|
27
28
|
if_machine_url: nil,
|
28
29
|
send_digits: nil,
|
29
30
|
status_callback_url: nil,
|
30
|
-
timeout: nil
|
31
|
+
timeout: nil,
|
32
|
+
privacy_mode: nil)
|
31
33
|
```
|
32
34
|
|
33
35
|
|
data/docs/OutDialAllOf.md
CHANGED
@@ -13,6 +13,7 @@ Name | Type | Description | Notes
|
|
13
13
|
**send_digits** | **String** | DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension. | [optional]
|
14
14
|
**status_callback_url** | **String** | When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored. | [optional]
|
15
15
|
**timeout** | **Integer** | Maximum time in seconds the `OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`. | [optional]
|
16
|
+
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
16
17
|
|
17
18
|
## Code Sample
|
18
19
|
|
@@ -27,7 +28,8 @@ instance = Freeclimb::OutDialAllOf.new(action_url: nil,
|
|
27
28
|
if_machine_url: nil,
|
28
29
|
send_digits: nil,
|
29
30
|
status_callback_url: nil,
|
30
|
-
timeout: nil
|
31
|
+
timeout: nil,
|
32
|
+
privacy_mode: nil)
|
31
33
|
```
|
32
34
|
|
33
35
|
|
data/docs/Play.md
CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands. |
|
8
8
|
**loop** | **Integer** | Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up. | [optional]
|
9
9
|
**conference_id** | **String** | ID of the Conference the audio should be rendered to. If this is not specified, the audio 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]
|
10
|
+
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
10
11
|
|
11
12
|
## Code Sample
|
12
13
|
|
@@ -15,7 +16,8 @@ require 'freeclimb'
|
|
15
16
|
|
16
17
|
instance = Freeclimb::Play.new(file: nil,
|
17
18
|
loop: nil,
|
18
|
-
conference_id: nil
|
19
|
+
conference_id: nil,
|
20
|
+
privacy_mode: nil)
|
19
21
|
```
|
20
22
|
|
21
23
|
|
data/docs/PlayAllOf.md
CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands. |
|
8
8
|
**loop** | **Integer** | Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up. | [optional]
|
9
9
|
**conference_id** | **String** | ID of the Conference the audio should be rendered to. If this is not specified, the audio 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]
|
10
|
+
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
10
11
|
|
11
12
|
## Code Sample
|
12
13
|
|
@@ -15,7 +16,8 @@ require 'freeclimb'
|
|
15
16
|
|
16
17
|
instance = Freeclimb::PlayAllOf.new(file: nil,
|
17
18
|
loop: nil,
|
18
|
-
conference_id: nil
|
19
|
+
conference_id: nil,
|
20
|
+
privacy_mode: nil)
|
19
21
|
```
|
20
22
|
|
21
23
|
|
data/docs/RecordUtterance.md
CHANGED
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional]
|
11
11
|
**play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional]
|
12
12
|
**auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional]
|
13
|
+
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
13
14
|
|
14
15
|
## Code Sample
|
15
16
|
|
@@ -21,7 +22,8 @@ instance = Freeclimb::RecordUtterance.new(action_url: nil,
|
|
21
22
|
finish_on_key: nil,
|
22
23
|
max_length_sec: nil,
|
23
24
|
play_beep: nil,
|
24
|
-
auto_start: nil
|
25
|
+
auto_start: nil,
|
26
|
+
privacy_mode: nil)
|
25
27
|
```
|
26
28
|
|
27
29
|
|
@@ -10,6 +10,7 @@ Name | Type | Description | Notes
|
|
10
10
|
**max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional]
|
11
11
|
**play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional]
|
12
12
|
**auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional]
|
13
|
+
**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional]
|
13
14
|
|
14
15
|
## Code Sample
|
15
16
|
|
@@ -21,7 +22,8 @@ instance = Freeclimb::RecordUtteranceAllOf.new(action_url: nil,
|
|
21
22
|
finish_on_key: nil,
|
22
23
|
max_length_sec: nil,
|
23
24
|
play_beep: nil,
|
24
|
-
auto_start: nil
|
25
|
+
auto_start: nil,
|
26
|
+
privacy_mode: nil)
|
25
27
|
```
|
26
28
|
|
27
29
|
|
data/docs/Redirect.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
Name | Type | Description | Notes
|
6
6
|
------------ | ------------- | ------------- | -------------
|
7
|
-
**action_url** | **String** |
|
7
|
+
**action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. |
|
8
8
|
|
9
9
|
## Code Sample
|
10
10
|
|