freeclimb 4.0.3 → 4.1.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 +94 -6
- data/Gemfile.lock +2 -2
- data/README.md +25 -4
- data/docs/AccountResult.md +2 -2
- data/docs/AccountResultAllOf.md +2 -2
- data/docs/AccountStatus.md +18 -0
- data/docs/AccountType.md +17 -0
- data/docs/AnsweredBy.md +17 -0
- data/docs/CallDirection.md +18 -0
- data/docs/CallResult.md +3 -3
- data/docs/CallResultAllOf.md +3 -3
- data/docs/CallStatus.md +23 -0
- data/docs/ConferenceResult.md +2 -2
- data/docs/ConferenceResultAllOf.md +2 -2
- data/docs/ConferenceStatus.md +19 -0
- data/docs/CreateConference.md +2 -2
- data/docs/CreateConferenceAllOf.md +2 -2
- data/docs/CreateConferenceRequest.md +1 -1
- data/docs/DefaultApi.md +5 -5
- data/docs/Dequeue.md +1 -1
- data/docs/GetSpeech.md +3 -3
- data/docs/GetSpeechAllOf.md +3 -3
- data/docs/GetSpeechReason.md +21 -0
- data/docs/GrammarFileBuiltIn.md +30 -0
- data/docs/GrammarType.md +17 -0
- data/docs/IfMachine.md +17 -0
- data/docs/Language.md +41 -0
- data/docs/LogLevel.md +18 -0
- data/docs/LogResult.md +1 -1
- data/docs/MachineType.md +17 -0
- data/docs/MessageDirection.md +17 -0
- data/docs/MessageResult.md +1 -1
- data/docs/MessageResultAllOf.md +1 -1
- data/docs/MessageStatus.md +26 -0
- data/docs/OutDial.md +1 -1
- data/docs/OutDialAllOf.md +1 -1
- data/docs/PlayBeep.md +19 -0
- data/docs/QueueResult.md +3 -3
- data/docs/QueueResultAllOf.md +3 -3
- data/docs/QueueResultStatus.md +19 -0
- data/docs/RecordUtteranceTermReason.md +19 -0
- data/docs/RequestType.md +38 -0
- data/docs/StartRecordCall.md +1 -1
- data/docs/Unpark.md +1 -1
- data/docs/UpdateCallRequest.md +1 -1
- data/docs/UpdateCallRequestStatus.md +17 -0
- data/docs/UpdateConferenceRequest.md +2 -2
- data/docs/UpdateConferenceRequestStatus.md +17 -0
- data/lib/freeclimb/api/default_api.rb +4 -8
- data/lib/freeclimb/models/account_result.rb +2 -52
- data/lib/freeclimb/models/account_result_all_of.rb +2 -52
- data/lib/freeclimb/models/account_status.rb +38 -0
- data/lib/freeclimb/models/account_type.rb +37 -0
- data/lib/freeclimb/models/answered_by.rb +37 -0
- data/lib/freeclimb/models/call_direction.rb +38 -0
- data/lib/freeclimb/models/call_result.rb +3 -43
- data/lib/freeclimb/models/call_result_all_of.rb +3 -43
- data/lib/freeclimb/models/call_status.rb +43 -0
- data/lib/freeclimb/models/conference_result.rb +4 -52
- data/lib/freeclimb/models/conference_result_all_of.rb +4 -52
- data/lib/freeclimb/models/conference_status.rb +39 -0
- data/lib/freeclimb/models/create_conference.rb +4 -3
- data/lib/freeclimb/models/create_conference_all_of.rb +4 -3
- data/lib/freeclimb/models/create_conference_request.rb +1 -36
- data/lib/freeclimb/models/get_speech.rb +3 -4
- data/lib/freeclimb/models/get_speech_all_of.rb +3 -4
- data/lib/freeclimb/models/get_speech_reason.rb +41 -0
- data/lib/freeclimb/models/grammar_file_built_in.rb +50 -0
- data/lib/freeclimb/models/grammar_type.rb +37 -0
- data/lib/freeclimb/models/if_machine.rb +37 -0
- data/lib/freeclimb/models/language.rb +61 -0
- data/lib/freeclimb/models/log_level.rb +38 -0
- data/lib/freeclimb/models/log_result.rb +1 -37
- data/lib/freeclimb/models/machine_type.rb +37 -0
- data/lib/freeclimb/models/message_direction.rb +37 -0
- data/lib/freeclimb/models/message_result.rb +1 -37
- data/lib/freeclimb/models/message_result_all_of.rb +1 -37
- data/lib/freeclimb/models/message_status.rb +46 -0
- data/lib/freeclimb/models/out_dial.rb +1 -2
- data/lib/freeclimb/models/out_dial_all_of.rb +1 -2
- data/lib/freeclimb/models/play_beep.rb +39 -0
- data/lib/freeclimb/models/queue_result.rb +10 -10
- data/lib/freeclimb/models/queue_result_all_of.rb +10 -10
- data/lib/freeclimb/models/queue_result_status.rb +39 -0
- data/lib/freeclimb/models/record_utterance_term_reason.rb +39 -0
- data/lib/freeclimb/models/request_type.rb +58 -0
- data/lib/freeclimb/models/update_call_request.rb +1 -36
- data/lib/freeclimb/models/update_call_request_status.rb +37 -0
- data/lib/freeclimb/models/update_conference_request.rb +2 -50
- data/lib/freeclimb/models/update_conference_request_status.rb +37 -0
- data/lib/freeclimb/version.rb +1 -1
- data/lib/freeclimb.rb +21 -0
- data/openapi.json +4220 -0
- data/spec/api/default_api_spec.rb +532 -700
- data/spec/configuration_spec.rb +2 -1
- data/spec/models/account_result_spec.rb +0 -8
- data/spec/models/account_status_spec.rb +43 -0
- data/spec/models/account_type_spec.rb +38 -0
- data/spec/models/answered_by_spec.rb +38 -0
- data/spec/models/available_number_spec.rb +6 -0
- data/spec/models/call_direction_spec.rb +43 -0
- data/spec/models/call_result_spec.rb +0 -4
- data/spec/models/call_status_spec.rb +68 -0
- data/spec/models/conference_result_spec.rb +0 -8
- data/spec/models/conference_status_spec.rb +48 -0
- data/spec/models/create_conference_request_spec.rb +0 -4
- data/spec/models/get_speech_reason_spec.rb +58 -0
- data/spec/models/grammar_file_built_in_spec.rb +103 -0
- data/spec/models/grammar_type_spec.rb +38 -0
- data/spec/models/if_machine_spec.rb +38 -0
- data/spec/models/incoming_number_result_spec.rb +12 -0
- data/spec/models/language_spec.rb +158 -0
- data/spec/models/log_level_spec.rb +43 -0
- data/spec/models/log_result_spec.rb +0 -4
- data/spec/models/machine_type_spec.rb +38 -0
- data/spec/models/message_direction_spec.rb +38 -0
- data/spec/models/message_result_spec.rb +0 -4
- data/spec/models/message_status_spec.rb +83 -0
- data/spec/models/play_beep_spec.rb +48 -0
- data/spec/models/queue_result_spec.rb +1 -1
- data/spec/models/queue_result_status_spec.rb +48 -0
- data/spec/models/record_utterance_term_reason_spec.rb +48 -0
- data/spec/models/request_type_spec.rb +143 -0
- data/spec/models/update_call_request_spec.rb +0 -4
- data/spec/models/update_call_request_status_spec.rb +38 -0
- data/spec/models/update_conference_request_spec.rb +0 -4
- data/spec/models/update_conference_request_status_spec.rb +38 -0
- metadata +138 -53
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c1fb413c451669f8f0721697635266eb86655d7d7f3468438518b12ff5c95afc
|
4
|
+
data.tar.gz: 3bb2b159457826efb1161c6ae58e5f0634de30d9ad69ccdf18ac09565b7312df
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ecee8172b3a4059d3d0916d2836a34cf96812ec3a3f953fb3c574875a232c7d853c8cbbcea604aca0d9582e178878baee109e58242589ac49ee6955d6e8261ba
|
7
|
+
data.tar.gz: 63c2fc84b50563c3ca793338a9b8c2cb29efa6f3e8d2095c637cfa8700ad1a7ffb88d8e2058aadb167db9d5097a85a4c2398cf4b68ba1b0d1be7a7accd522d7c
|
data/CHANGELOG.md
CHANGED
@@ -1,160 +1,248 @@
|
|
1
1
|
# Ruby SDK Changelog
|
2
|
+
|
2
3
|
All notable changes to this project will be documented in this file.
|
3
4
|
|
4
5
|
The format of this changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
|
5
6
|
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
6
7
|
|
7
8
|
## [Unreleased]
|
9
|
+
|
8
10
|
None
|
11
|
+
|
12
|
+
<a name="4.1.0"></a>
|
13
|
+
|
14
|
+
## [4.1.0] - 2023-01-06
|
15
|
+
|
16
|
+
### Changed
|
17
|
+
|
18
|
+
- Enums have been implemented in the ruby sdk
|
19
|
+
- Updated README for enum implementation and testing
|
20
|
+
|
21
|
+
<a name="4.0.4"></a>
|
22
|
+
|
23
|
+
## [4.0.4] - 2022-12-01
|
24
|
+
|
25
|
+
### Changed
|
26
|
+
|
27
|
+
- Changed `QueueResult` property `current_size` from string to int
|
28
|
+
- Renamed `QueueResult` property `average_wait_time` to `average_queue_removal_time`
|
29
|
+
|
9
30
|
<a name="4.0.3"></a>
|
10
31
|
|
11
32
|
## [4.0.3] - 2022-11-01
|
33
|
+
|
12
34
|
### Added
|
35
|
+
|
13
36
|
- Add `offnet` property in IncomingNumber resource
|
14
37
|
- Add `offnet` query parameter for listIncomingNumbers
|
15
38
|
|
16
39
|
<a name="4.0.2"></a>
|
40
|
+
|
17
41
|
## [4.0.2] - 2022-10-07
|
42
|
+
|
18
43
|
### Added
|
44
|
+
|
19
45
|
- Add `playBeep` enum to `update_conference_request`
|
20
46
|
|
21
47
|
<a name="4.0.1"></a>
|
48
|
+
|
22
49
|
## [4.0.1] - 2022-07-20
|
50
|
+
|
23
51
|
### Added
|
52
|
+
|
24
53
|
- Add `Park` PerCL command
|
25
54
|
- Add `Unpark` PerCL command
|
55
|
+
|
26
56
|
### Changed
|
57
|
+
|
27
58
|
- Default loop value for Say command is set to `1`
|
28
59
|
|
29
60
|
<a name="4.0.0"></a>
|
61
|
+
|
30
62
|
## [4.0.0] - 2022-03-03
|
63
|
+
|
31
64
|
### Changed
|
65
|
+
|
32
66
|
- Prefer keyword argument initialization for all models
|
33
67
|
- Rename api->list_an_application to list->list_applications
|
34
68
|
- Use new openapi-generator version (5.4.0)
|
35
69
|
- Remove floating `Freeclimb::percl_to_json` and added it to `PerclScript` as `to_json` method
|
36
70
|
|
37
71
|
<a name="3.0.3"></a>
|
72
|
+
|
38
73
|
## [3.0.3] - 2022-02-08
|
74
|
+
|
39
75
|
### Added
|
76
|
+
|
40
77
|
- Add capabilities query functionality for searching AvailableNumbers and IncomingNumbers
|
41
78
|
- Enable unit testing
|
42
79
|
|
43
80
|
<a name="3.0.2"></a>
|
81
|
+
|
44
82
|
## [3.0.2] - 2021-12-06
|
83
|
+
|
45
84
|
### Changed
|
85
|
+
|
46
86
|
-remove alias from accepted query parameters when listing AvailablePhoneNumbers
|
47
87
|
-Add country, region, smsEnabled, and voiceEnabled as accepted query parameters for AvailablePhoneNumbers
|
48
88
|
-Add smsEnabled to AvailablePhoneNumbers response schema
|
49
89
|
-Add applicationId, country, region, smsEnabled, voiceEnabled, and hasApplication as accepted query parameters for IncomingPhoneNumber.
|
50
90
|
|
51
91
|
<a name="3.0.1"></a>
|
92
|
+
|
52
93
|
## [3.0.1] - 2021-11-02
|
94
|
+
|
53
95
|
### Added
|
96
|
+
|
54
97
|
- Add `active` property to CallResult
|
55
98
|
|
56
99
|
### Changed
|
100
|
+
|
57
101
|
- Small instances of `token` to `key`
|
58
102
|
- Call ID is not required to `AddToConference`
|
59
103
|
|
60
104
|
<a name="3.0.0"></a>
|
105
|
+
|
61
106
|
## [3.0.0] - 2021-05-03
|
107
|
+
|
62
108
|
### Added
|
109
|
+
|
63
110
|
- Add `verify_request` utility function
|
64
111
|
|
65
112
|
<a name="2.2.0"></a>
|
113
|
+
|
66
114
|
## [2.2.0] - 2021-04-12
|
115
|
+
|
67
116
|
### Changed
|
117
|
+
|
68
118
|
- Replace any language instance of `auth_token` or similar speech to `api_key`
|
69
119
|
|
70
120
|
<a name="2.1.2"></a>
|
121
|
+
|
71
122
|
## [2.1.2] - 2021-03-10
|
123
|
+
|
72
124
|
### Added
|
73
|
-
- Add `callConnectUrl` option to MakeACall Request
|
74
125
|
|
126
|
+
- Add `callConnectUrl` option to MakeACall Request
|
75
127
|
|
76
128
|
<a name="2.1.1"></a>
|
129
|
+
|
77
130
|
## [2.1.1] - 2020-12-16
|
131
|
+
|
78
132
|
### Added
|
133
|
+
|
79
134
|
- Add `privacyMode` option to RecordUtterance PerCL command
|
80
135
|
|
81
136
|
<a name="2.1.0"></a>
|
137
|
+
|
82
138
|
## [2.1.0] - 2020-12-16
|
139
|
+
|
83
140
|
### Added
|
141
|
+
|
84
142
|
- Add `Reject` PerCL command
|
85
143
|
- Add `Hangup` PerCL command
|
86
144
|
|
87
145
|
### Fixed
|
146
|
+
|
88
147
|
- Updated description and requirement of `action_url` attribute of `Redirect` PerCL command
|
89
148
|
|
90
149
|
<a name="2.0.3"></a>
|
150
|
+
|
91
151
|
## [2.0.3] - 2020-12-16
|
152
|
+
|
92
153
|
### Added
|
154
|
+
|
93
155
|
- Additional message statuses for TFN functionality
|
94
156
|
|
95
157
|
<a name="2.0.2"></a>
|
158
|
+
|
96
159
|
## [2.0.2] - 2020-08-13
|
160
|
+
|
97
161
|
### Added
|
162
|
+
|
98
163
|
- Add `privacyMode` option
|
99
164
|
|
100
165
|
<a name="1.2.1"></a>
|
166
|
+
|
101
167
|
## [1.2.1] - 2020-10-14
|
168
|
+
|
102
169
|
### Changed
|
170
|
+
|
103
171
|
- Rename `setPersyUrl` to `setUrl`
|
104
172
|
|
105
173
|
### Fixed
|
174
|
+
|
106
175
|
- Properly handle empty response bodies
|
107
176
|
- Other Minor bug fixes
|
108
177
|
|
109
178
|
<a name="1.2"></a>
|
179
|
+
|
110
180
|
## [1.2] - 2019-10-16
|
181
|
+
|
111
182
|
### Changed
|
183
|
+
|
112
184
|
- Persephony is now FreeClimb
|
113
185
|
- Code cleanup
|
114
186
|
- Documentation Updates
|
115
187
|
- Test Update
|
116
188
|
|
117
189
|
### Fixed
|
190
|
+
|
118
191
|
- Update common response handler to not use bodu twice
|
119
192
|
|
120
193
|
<a name="1.1.1"></a>
|
194
|
+
|
121
195
|
## [1.1.1] - 2019-06-27
|
196
|
+
|
122
197
|
### Changed
|
123
|
-
- Minor updates to docs and code cleanup
|
124
198
|
|
199
|
+
- Minor updates to docs and code cleanup
|
125
200
|
|
126
201
|
<a name="1.1.0"></a>
|
202
|
+
|
127
203
|
## [1.1.0] - 2019-06-07
|
204
|
+
|
128
205
|
### Pull Requests
|
129
|
-
- Merge pull request [#22](https://gitlab.vailsys.com/vail-cloud-services/fc-boilerplates/javascript-sdk/issues/22) from PersephonyAPI/maintenance
|
130
206
|
|
207
|
+
- Merge pull request [#22](https://gitlab.vailsys.com/vail-cloud-services/fc-boilerplates/javascript-sdk/issues/22) from PersephonyAPI/maintenance
|
131
208
|
|
132
209
|
<a name="1.0.0"></a>
|
210
|
+
|
133
211
|
## [1.0.0] - 2019-06-04
|
212
|
+
|
134
213
|
### Changed
|
135
|
-
- Change default api target
|
136
214
|
|
215
|
+
- Change default api target
|
137
216
|
|
138
217
|
<a name="0.1.0"></a>
|
218
|
+
|
139
219
|
## [0.1.0] - 2019-05-30
|
220
|
+
|
140
221
|
### Added
|
222
|
+
|
141
223
|
- `PlayEarlyMedia` PerCL Command
|
142
224
|
|
143
225
|
<a name="0.0.2"></a>
|
226
|
+
|
144
227
|
## [0.0.2] - 2018-11-29
|
228
|
+
|
145
229
|
### Remove
|
230
|
+
|
146
231
|
- Remove `callConnectUrl` and `statusCallbackUrl` from api.calls#create
|
147
232
|
|
148
233
|
<a name="0.0.1"></a>
|
234
|
+
|
149
235
|
## [0.0.1] - 2018-11-13
|
236
|
+
|
150
237
|
### Added
|
238
|
+
|
151
239
|
- PerCL Support
|
152
240
|
- FreeClimb API Support
|
153
241
|
- README, LICENSE
|
154
242
|
- docs
|
155
243
|
|
156
244
|
### Changed
|
157
|
-
- Initial Release
|
158
245
|
|
246
|
+
- Initial Release
|
159
247
|
|
160
|
-
[
|
248
|
+
[unreleased]: https://github.com/FreeClimbAPI/ruby-sdk/compare/v1.0.1...HEAD
|
data/Gemfile.lock
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
PATH
|
2
2
|
remote: .
|
3
3
|
specs:
|
4
|
-
freeclimb (4.0
|
4
|
+
freeclimb (4.1.0)
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
6
6
|
|
7
7
|
GEM
|
@@ -21,7 +21,7 @@ GEM
|
|
21
21
|
crack (0.4.5)
|
22
22
|
rexml
|
23
23
|
diff-lcs (1.3)
|
24
|
-
ethon (0.
|
24
|
+
ethon (0.16.0)
|
25
25
|
ffi (>= 1.15.0)
|
26
26
|
facets (3.1.0)
|
27
27
|
factory_bot (6.2.0)
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0.0
|
10
|
-
- Package version: 4.0
|
10
|
+
- Package version: 4.1.0
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
|
13
13
|
|
@@ -15,7 +15,7 @@ For more information, please visit [https://www.freeclimb.com/support/](https://
|
|
15
15
|
|
16
16
|
Add this to the Gemfile:
|
17
17
|
|
18
|
-
gem 'freeclimb', '~> 4.0
|
18
|
+
gem 'freeclimb', '~> 4.1.0'
|
19
19
|
|
20
20
|
and run from your terminal
|
21
21
|
|
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
|
|
44
44
|
Then either install the gem locally:
|
45
45
|
|
46
46
|
```shell
|
47
|
-
gem install ./freeclimb-4.0.
|
47
|
+
gem install ./freeclimb-4.1.0.gem
|
48
48
|
```
|
49
|
-
(for development, run `gem install --dev ./freeclimb-4.0.
|
49
|
+
(for development, run `gem install --dev ./freeclimb-4.1.0.gem` to install the development dependencies)
|
50
50
|
|
51
51
|
## Getting Started
|
52
52
|
|
@@ -152,8 +152,11 @@ Class | Method | HTTP request | Description
|
|
152
152
|
- [Freeclimb::AccountRequest](docs/AccountRequest.md)
|
153
153
|
- [Freeclimb::AccountResult](docs/AccountResult.md)
|
154
154
|
- [Freeclimb::AccountResultAllOf](docs/AccountResultAllOf.md)
|
155
|
+
- [Freeclimb::AccountStatus](docs/AccountStatus.md)
|
156
|
+
- [Freeclimb::AccountType](docs/AccountType.md)
|
155
157
|
- [Freeclimb::AddToConference](docs/AddToConference.md)
|
156
158
|
- [Freeclimb::AddToConferenceAllOf](docs/AddToConferenceAllOf.md)
|
159
|
+
- [Freeclimb::AnsweredBy](docs/AnsweredBy.md)
|
157
160
|
- [Freeclimb::ApplicationList](docs/ApplicationList.md)
|
158
161
|
- [Freeclimb::ApplicationListAllOf](docs/ApplicationListAllOf.md)
|
159
162
|
- [Freeclimb::ApplicationRequest](docs/ApplicationRequest.md)
|
@@ -163,10 +166,12 @@ Class | Method | HTTP request | Description
|
|
163
166
|
- [Freeclimb::AvailableNumberList](docs/AvailableNumberList.md)
|
164
167
|
- [Freeclimb::AvailableNumberListAllOf](docs/AvailableNumberListAllOf.md)
|
165
168
|
- [Freeclimb::BuyIncomingNumberRequest](docs/BuyIncomingNumberRequest.md)
|
169
|
+
- [Freeclimb::CallDirection](docs/CallDirection.md)
|
166
170
|
- [Freeclimb::CallList](docs/CallList.md)
|
167
171
|
- [Freeclimb::CallListAllOf](docs/CallListAllOf.md)
|
168
172
|
- [Freeclimb::CallResult](docs/CallResult.md)
|
169
173
|
- [Freeclimb::CallResultAllOf](docs/CallResultAllOf.md)
|
174
|
+
- [Freeclimb::CallStatus](docs/CallStatus.md)
|
170
175
|
- [Freeclimb::Capabilities](docs/Capabilities.md)
|
171
176
|
- [Freeclimb::ConferenceList](docs/ConferenceList.md)
|
172
177
|
- [Freeclimb::ConferenceListAllOf](docs/ConferenceListAllOf.md)
|
@@ -176,6 +181,7 @@ Class | Method | HTTP request | Description
|
|
176
181
|
- [Freeclimb::ConferenceParticipantResultAllOf](docs/ConferenceParticipantResultAllOf.md)
|
177
182
|
- [Freeclimb::ConferenceResult](docs/ConferenceResult.md)
|
178
183
|
- [Freeclimb::ConferenceResultAllOf](docs/ConferenceResultAllOf.md)
|
184
|
+
- [Freeclimb::ConferenceStatus](docs/ConferenceStatus.md)
|
179
185
|
- [Freeclimb::CreateConference](docs/CreateConference.md)
|
180
186
|
- [Freeclimb::CreateConferenceAllOf](docs/CreateConferenceAllOf.md)
|
181
187
|
- [Freeclimb::CreateConferenceRequest](docs/CreateConferenceRequest.md)
|
@@ -187,21 +193,30 @@ Class | Method | HTTP request | Description
|
|
187
193
|
- [Freeclimb::GetDigitsAllOf](docs/GetDigitsAllOf.md)
|
188
194
|
- [Freeclimb::GetSpeech](docs/GetSpeech.md)
|
189
195
|
- [Freeclimb::GetSpeechAllOf](docs/GetSpeechAllOf.md)
|
196
|
+
- [Freeclimb::GetSpeechReason](docs/GetSpeechReason.md)
|
197
|
+
- [Freeclimb::GrammarFileBuiltIn](docs/GrammarFileBuiltIn.md)
|
198
|
+
- [Freeclimb::GrammarType](docs/GrammarType.md)
|
190
199
|
- [Freeclimb::Hangup](docs/Hangup.md)
|
191
200
|
- [Freeclimb::HangupAllOf](docs/HangupAllOf.md)
|
201
|
+
- [Freeclimb::IfMachine](docs/IfMachine.md)
|
192
202
|
- [Freeclimb::IncomingNumberList](docs/IncomingNumberList.md)
|
193
203
|
- [Freeclimb::IncomingNumberListAllOf](docs/IncomingNumberListAllOf.md)
|
194
204
|
- [Freeclimb::IncomingNumberRequest](docs/IncomingNumberRequest.md)
|
195
205
|
- [Freeclimb::IncomingNumberResult](docs/IncomingNumberResult.md)
|
196
206
|
- [Freeclimb::IncomingNumberResultAllOf](docs/IncomingNumberResultAllOf.md)
|
207
|
+
- [Freeclimb::Language](docs/Language.md)
|
208
|
+
- [Freeclimb::LogLevel](docs/LogLevel.md)
|
197
209
|
- [Freeclimb::LogList](docs/LogList.md)
|
198
210
|
- [Freeclimb::LogListAllOf](docs/LogListAllOf.md)
|
199
211
|
- [Freeclimb::LogResult](docs/LogResult.md)
|
212
|
+
- [Freeclimb::MachineType](docs/MachineType.md)
|
200
213
|
- [Freeclimb::MakeCallRequest](docs/MakeCallRequest.md)
|
214
|
+
- [Freeclimb::MessageDirection](docs/MessageDirection.md)
|
201
215
|
- [Freeclimb::MessageRequest](docs/MessageRequest.md)
|
202
216
|
- [Freeclimb::MessageRequestAllOf](docs/MessageRequestAllOf.md)
|
203
217
|
- [Freeclimb::MessageResult](docs/MessageResult.md)
|
204
218
|
- [Freeclimb::MessageResultAllOf](docs/MessageResultAllOf.md)
|
219
|
+
- [Freeclimb::MessageStatus](docs/MessageStatus.md)
|
205
220
|
- [Freeclimb::MessagesList](docs/MessagesList.md)
|
206
221
|
- [Freeclimb::MessagesListAllOf](docs/MessagesListAllOf.md)
|
207
222
|
- [Freeclimb::MutableResourceModel](docs/MutableResourceModel.md)
|
@@ -216,6 +231,7 @@ Class | Method | HTTP request | Description
|
|
216
231
|
- [Freeclimb::PerclScript](docs/PerclScript.md)
|
217
232
|
- [Freeclimb::Play](docs/Play.md)
|
218
233
|
- [Freeclimb::PlayAllOf](docs/PlayAllOf.md)
|
234
|
+
- [Freeclimb::PlayBeep](docs/PlayBeep.md)
|
219
235
|
- [Freeclimb::PlayEarlyMedia](docs/PlayEarlyMedia.md)
|
220
236
|
- [Freeclimb::PlayEarlyMediaAllOf](docs/PlayEarlyMediaAllOf.md)
|
221
237
|
- [Freeclimb::QueueList](docs/QueueList.md)
|
@@ -226,8 +242,10 @@ Class | Method | HTTP request | Description
|
|
226
242
|
- [Freeclimb::QueueRequest](docs/QueueRequest.md)
|
227
243
|
- [Freeclimb::QueueResult](docs/QueueResult.md)
|
228
244
|
- [Freeclimb::QueueResultAllOf](docs/QueueResultAllOf.md)
|
245
|
+
- [Freeclimb::QueueResultStatus](docs/QueueResultStatus.md)
|
229
246
|
- [Freeclimb::RecordUtterance](docs/RecordUtterance.md)
|
230
247
|
- [Freeclimb::RecordUtteranceAllOf](docs/RecordUtteranceAllOf.md)
|
248
|
+
- [Freeclimb::RecordUtteranceTermReason](docs/RecordUtteranceTermReason.md)
|
231
249
|
- [Freeclimb::RecordingList](docs/RecordingList.md)
|
232
250
|
- [Freeclimb::RecordingListAllOf](docs/RecordingListAllOf.md)
|
233
251
|
- [Freeclimb::RecordingResult](docs/RecordingResult.md)
|
@@ -238,6 +256,7 @@ Class | Method | HTTP request | Description
|
|
238
256
|
- [Freeclimb::RejectAllOf](docs/RejectAllOf.md)
|
239
257
|
- [Freeclimb::RemoveFromConference](docs/RemoveFromConference.md)
|
240
258
|
- [Freeclimb::RemoveFromConferenceAllOf](docs/RemoveFromConferenceAllOf.md)
|
259
|
+
- [Freeclimb::RequestType](docs/RequestType.md)
|
241
260
|
- [Freeclimb::Say](docs/Say.md)
|
242
261
|
- [Freeclimb::SayAllOf](docs/SayAllOf.md)
|
243
262
|
- [Freeclimb::SendDigits](docs/SendDigits.md)
|
@@ -253,8 +272,10 @@ Class | Method | HTTP request | Description
|
|
253
272
|
- [Freeclimb::TerminateConferenceAllOf](docs/TerminateConferenceAllOf.md)
|
254
273
|
- [Freeclimb::Unpark](docs/Unpark.md)
|
255
274
|
- [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)
|
275
|
+
- [Freeclimb::UpdateCallRequestStatus](docs/UpdateCallRequestStatus.md)
|
256
276
|
- [Freeclimb::UpdateConferenceParticipantRequest](docs/UpdateConferenceParticipantRequest.md)
|
257
277
|
- [Freeclimb::UpdateConferenceRequest](docs/UpdateConferenceRequest.md)
|
278
|
+
- [Freeclimb::UpdateConferenceRequestStatus](docs/UpdateConferenceRequestStatus.md)
|
258
279
|
|
259
280
|
|
260
281
|
## Documentation for Authorization
|
data/docs/AccountResult.md
CHANGED
@@ -12,8 +12,8 @@
|
|
12
12
|
| **api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional] |
|
13
13
|
| **_alias** | **String** | A description for this account. | [optional] |
|
14
14
|
| **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional] |
|
15
|
-
| **type** | **
|
16
|
-
| **status** | **
|
15
|
+
| **type** | [**AccountType**](AccountType.md) | | [optional] |
|
16
|
+
| **status** | [**AccountStatus**](AccountStatus.md) | | [optional] |
|
17
17
|
| **subresource_uris** | **Object** | The list of subresources for this account. | [optional] |
|
18
18
|
|
19
19
|
## Example
|
data/docs/AccountResultAllOf.md
CHANGED
@@ -8,8 +8,8 @@
|
|
8
8
|
| **api_key** | **String** | The API key assigned to this account. This key must be kept a secret by the customer. | [optional] |
|
9
9
|
| **_alias** | **String** | A description for this account. | [optional] |
|
10
10
|
| **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional] |
|
11
|
-
| **type** | **
|
12
|
-
| **status** | **
|
11
|
+
| **type** | [**AccountType**](AccountType.md) | | [optional] |
|
12
|
+
| **status** | [**AccountStatus**](AccountStatus.md) | | [optional] |
|
13
13
|
| **subresource_uris** | **Object** | The list of subresources for this account. | [optional] |
|
14
14
|
|
15
15
|
## Example
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Freeclimb::AccountStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **CLOSED** | **AccountStatus** | | Represented in Ruby as "closed" |
|
8
|
+
| **SUSPENDED** | **AccountStatus** | | Represented in Ruby as "suspended" |
|
9
|
+
| **ACTIVE** | **AccountStatus** | | Represented in Ruby as "active" |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'freeclimb'
|
15
|
+
|
16
|
+
instance = Freeclimb::AccountStatus::[NAME OF ENUM]
|
17
|
+
```
|
18
|
+
|
data/docs/AccountType.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::AccountType
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **TRIAL** | **AccountType** | | Represented in Ruby as "trial" |
|
8
|
+
| **FULL** | **AccountType** | | Represented in Ruby as "full" |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'freeclimb'
|
14
|
+
|
15
|
+
instance = Freeclimb::AccountType::[NAME OF ENUM]
|
16
|
+
```
|
17
|
+
|
data/docs/AnsweredBy.md
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
# Freeclimb::AnsweredBy
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **HUMAN** | **AnsweredBy** | | Represented in Ruby as "human" |
|
8
|
+
| **MACHINE** | **AnsweredBy** | | Represented in Ruby as "machine" |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'freeclimb'
|
14
|
+
|
15
|
+
instance = Freeclimb::AnsweredBy::[NAME OF ENUM]
|
16
|
+
```
|
17
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Freeclimb::CallDirection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **INBOUND** | **CallDirection** | | Represented in Ruby as "inbound" |
|
8
|
+
| **OUTBOUND_API** | **CallDirection** | | Represented in Ruby as "outboundAPI" |
|
9
|
+
| **OUTBOUND_DIAL** | **CallDirection** | | Represented in Ruby as "outboundDial" |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'freeclimb'
|
15
|
+
|
16
|
+
instance = Freeclimb::CallDirection::[NAME OF ENUM]
|
17
|
+
```
|
18
|
+
|
data/docs/CallResult.md
CHANGED
@@ -14,14 +14,14 @@
|
|
14
14
|
| **from** | **String** | Phone number that initiated this Call. | [optional] |
|
15
15
|
| **to** | **String** | Phone number that received this Call. | [optional] |
|
16
16
|
| **phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional] |
|
17
|
-
| **status** | **
|
17
|
+
| **status** | [**CallStatus**](CallStatus.md) | | [optional] |
|
18
18
|
| **start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
|
19
19
|
| **connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
|
20
20
|
| **end_time** | **String** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional] |
|
21
21
|
| **duration** | **Integer** | Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
|
22
22
|
| **connect_duration** | **Integer** | Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
|
23
|
-
| **direction** | **
|
24
|
-
| **answered_by** | **
|
23
|
+
| **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
|
24
|
+
| **answered_by** | [**AnsweredBy**](AnsweredBy.md) | | [optional] |
|
25
25
|
| **subresource_uris** | **Object** | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional] |
|
26
26
|
|
27
27
|
## Example
|
data/docs/CallResultAllOf.md
CHANGED
@@ -10,14 +10,14 @@
|
|
10
10
|
| **from** | **String** | Phone number that initiated this Call. | [optional] |
|
11
11
|
| **to** | **String** | Phone number that received this Call. | [optional] |
|
12
12
|
| **phone_number_id** | **String** | If the Call was inbound, this is the ID of the IncomingPhoneNumber that received the Call (DNIS). If the Call was outbound, this is the ID of the phone number from which the Call was placed (ANI). | [optional] |
|
13
|
-
| **status** | **
|
13
|
+
| **status** | [**CallStatus**](CallStatus.md) | | [optional] |
|
14
14
|
| **start_time** | **String** | Start time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
|
15
15
|
| **connect_time** | **String** | Time the Call was answered (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call has not yet been dialed. | [optional] |
|
16
16
|
| **end_time** | **String** | End time of the Call (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). Empty if the Call did not complete successfully. | [optional] |
|
17
17
|
| **duration** | **Integer** | Total length of the Call in seconds. Measures time between startTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
|
18
18
|
| **connect_duration** | **Integer** | Length of time that the Call was connected in seconds. Measures time between connectTime and endTime. This value is empty for busy, failed, unanswered or ongoing Calls. | [optional] |
|
19
|
-
| **direction** | **
|
20
|
-
| **answered_by** | **
|
19
|
+
| **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
|
20
|
+
| **answered_by** | [**AnsweredBy**](AnsweredBy.md) | | [optional] |
|
21
21
|
| **subresource_uris** | **Object** | The list of subresources for this Call. These include things like logs and recordings associated with the Call. | [optional] |
|
22
22
|
|
23
23
|
## Example
|
data/docs/CallStatus.md
ADDED
@@ -0,0 +1,23 @@
|
|
1
|
+
# Freeclimb::CallStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **QUEUED** | **CallStatus** | | Represented in Ruby as "queued" |
|
8
|
+
| **RINGING** | **CallStatus** | | Represented in Ruby as "ringing" |
|
9
|
+
| **IN_PROGRESS** | **CallStatus** | | Represented in Ruby as "inProgress" |
|
10
|
+
| **CANCELED** | **CallStatus** | | Represented in Ruby as "canceled" |
|
11
|
+
| **COMPLETED** | **CallStatus** | | Represented in Ruby as "completed" |
|
12
|
+
| **FAILED** | **CallStatus** | | Represented in Ruby as "failed" |
|
13
|
+
| **BUSY** | **CallStatus** | | Represented in Ruby as "busy" |
|
14
|
+
| **NO_ANSWER** | **CallStatus** | | Represented in Ruby as "noAnswer" |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'freeclimb'
|
20
|
+
|
21
|
+
instance = Freeclimb::CallStatus::[NAME OF ENUM]
|
22
|
+
```
|
23
|
+
|
data/docs/ConferenceResult.md
CHANGED
@@ -11,9 +11,9 @@
|
|
11
11
|
| **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional] |
|
12
12
|
| **account_id** | **String** | ID of the account that created this Conference. | [optional] |
|
13
13
|
| **_alias** | **String** | A description for this Conference. | [optional] |
|
14
|
-
| **play_beep** | **
|
14
|
+
| **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional][default to 'always'] |
|
15
15
|
| **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional] |
|
16
|
-
| **status** | **
|
16
|
+
| **status** | [**ConferenceStatus**](ConferenceStatus.md) | | [optional] |
|
17
17
|
| **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional] |
|
18
18
|
| **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional] |
|
19
19
|
| **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional] |
|
@@ -7,9 +7,9 @@
|
|
7
7
|
| **conference_id** | **String** | A string that uniquely identifies this Conference resource. | [optional] |
|
8
8
|
| **account_id** | **String** | ID of the account that created this Conference. | [optional] |
|
9
9
|
| **_alias** | **String** | A description for this Conference. | [optional] |
|
10
|
-
| **play_beep** | **
|
10
|
+
| **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional][default to 'always'] |
|
11
11
|
| **record** | **Boolean** | Flag indicating whether recording is enabled for this Conference. | [optional] |
|
12
|
-
| **status** | **
|
12
|
+
| **status** | [**ConferenceStatus**](ConferenceStatus.md) | | [optional] |
|
13
13
|
| **wait_url** | **String** | URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state. | [optional] |
|
14
14
|
| **action_url** | **String** | URL invoked once the Conference is successfully created. | [optional] |
|
15
15
|
| **status_callback_url** | **String** | URL to inform that the Conference status has changed. | [optional] |
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# Freeclimb::ConferenceStatus
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **EMPTY** | **ConferenceStatus** | | Represented in Ruby as "empty" |
|
8
|
+
| **POPULATED** | **ConferenceStatus** | | Represented in Ruby as "populated" |
|
9
|
+
| **IN_PROGRESS** | **ConferenceStatus** | | Represented in Ruby as "inProgress" |
|
10
|
+
| **TERMINATED** | **ConferenceStatus** | | Represented in Ruby as "terminated" |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'freeclimb'
|
16
|
+
|
17
|
+
instance = Freeclimb::ConferenceStatus::[NAME OF ENUM]
|
18
|
+
```
|
19
|
+
|
data/docs/CreateConference.md
CHANGED
@@ -6,9 +6,9 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. | |
|
8
8
|
| **_alias** | **Boolean** | Descriptive name for the Conference. | [optional] |
|
9
|
-
| **play_beep** | **
|
9
|
+
| **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional][default to 'always'] |
|
10
10
|
| **record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional] |
|
11
|
-
| **status_callback_url** | **
|
11
|
+
| **status_callback_url** | **String** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional] |
|
12
12
|
| **wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional] |
|
13
13
|
|
14
14
|
## Example
|
@@ -6,9 +6,9 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **action_url** | **String** | This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. | |
|
8
8
|
| **_alias** | **Boolean** | Descriptive name for the Conference. | [optional] |
|
9
|
-
| **play_beep** | **
|
9
|
+
| **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional][default to 'always'] |
|
10
10
|
| **record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional] |
|
11
|
-
| **status_callback_url** | **
|
11
|
+
| **status_callback_url** | **String** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional] |
|
12
12
|
| **wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional] |
|
13
13
|
|
14
14
|
## Example
|