freeclimb 5.2.0 → 5.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +22 -2
- data/Gemfile.lock +3 -3
- data/README.md +31 -4
- data/docs/AvailableNumber.md +0 -4
- data/docs/BlobListResponse.md +32 -0
- data/docs/BlobResult.md +32 -0
- data/docs/CallResult.md +2 -2
- data/docs/CreateBlobRequest.md +22 -0
- data/docs/CreateConference.md +4 -2
- data/docs/DefaultApi.md +835 -25
- data/docs/ExportList.md +32 -0
- data/docs/ExportOutputType.md +16 -0
- data/docs/ExportRequest.md +24 -0
- data/docs/ExportRequestOutput.md +18 -0
- data/docs/ExportResourceType.md +17 -0
- data/docs/ExportResult.md +40 -0
- data/docs/ExportResultOutput.md +18 -0
- data/docs/ExportStatus.md +21 -0
- data/docs/IncomingNumberResult.md +0 -4
- data/docs/ModifyBlobRequest.md +20 -0
- data/docs/PlatformError.md +24 -0
- data/docs/ReplaceBlobRequest.md +18 -0
- data/docs/Say.md +2 -0
- data/docs/TTSEngine.md +20 -0
- data/docs/TTSEngineName.md +18 -0
- data/lib/freeclimb/api/default_api.rb +1032 -12
- data/lib/freeclimb/models/available_number.rb +1 -23
- data/lib/freeclimb/models/blob_list_response.rb +303 -0
- data/lib/freeclimb/models/blob_result.rb +332 -0
- data/lib/freeclimb/models/call_result.rb +8 -8
- data/lib/freeclimb/models/create_blob_request.rb +255 -0
- data/lib/freeclimb/models/create_conference.rb +15 -5
- data/lib/freeclimb/models/export_list.rb +304 -0
- data/lib/freeclimb/models/export_output_type.rb +34 -0
- data/lib/freeclimb/models/export_request.rb +276 -0
- data/lib/freeclimb/models/export_request_output.rb +243 -0
- data/lib/freeclimb/models/export_resource_type.rb +35 -0
- data/lib/freeclimb/models/export_result.rb +405 -0
- data/lib/freeclimb/models/export_result_output.rb +243 -0
- data/lib/freeclimb/models/export_status.rb +39 -0
- data/lib/freeclimb/models/incoming_number_result.rb +1 -23
- data/lib/freeclimb/models/modify_blob_request.rb +245 -0
- data/lib/freeclimb/models/platform_error.rb +244 -0
- data/lib/freeclimb/models/replace_blob_request.rb +221 -0
- data/lib/freeclimb/models/say.rb +10 -1
- data/lib/freeclimb/models/tts_engine.rb +250 -0
- data/lib/freeclimb/models/tts_engine_name.rb +36 -0
- data/lib/freeclimb/version.rb +1 -1
- data/lib/freeclimb.rb +16 -0
- data/openapi.json +1245 -80
- data/spec/api/default_api_spec.rb +328 -33
- data/spec/models/account_result_spec.rb +3 -3
- data/spec/models/available_number_spec.rb +3 -98
- data/spec/models/blob_list_response_spec.rb +502 -0
- data/spec/models/blob_result_spec.rb +489 -0
- data/spec/models/call_result_spec.rb +39 -39
- data/spec/models/conference_result_spec.rb +3 -3
- data/spec/models/create_blob_request_spec.rb +273 -0
- data/spec/models/create_conference_spec.rb +83 -35
- data/spec/models/export_list_spec.rb +502 -0
- data/spec/models/export_output_type_spec.rb +43 -0
- data/spec/models/export_request_output_spec.rb +162 -0
- data/spec/models/export_request_spec.rb +320 -0
- data/spec/models/export_resource_type_spec.rb +59 -0
- data/spec/models/export_result_output_spec.rb +162 -0
- data/spec/models/export_result_spec.rb +718 -0
- data/spec/models/export_status_spec.rb +123 -0
- data/spec/models/incoming_number_result_spec.rb +6 -102
- data/spec/models/log_result_spec.rb +3 -3
- data/spec/models/message_result_spec.rb +3 -3
- data/spec/models/modify_blob_request_spec.rb +226 -0
- data/spec/models/platform_error_spec.rb +318 -0
- data/spec/models/queue_result_spec.rb +3 -3
- data/spec/models/replace_blob_request_spec.rb +176 -0
- data/spec/models/say_spec.rb +50 -0
- data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +3 -3
- data/spec/models/transcribe_utterance_spec.rb +3 -3
- data/spec/models/tts_engine_name_spec.rb +75 -0
- data/spec/models/tts_engine_spec.rb +183 -0
- data/spec/spec_helper.rb +1 -1
- data/yarn.lock +29 -29
- metadata +50 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 493077c655c7e9edf677bd1e6401b826f51a0af777e1074786dca2bbd7634524
|
|
4
|
+
data.tar.gz: 5900b3444f637a6a8e611aba7f64cc4932111e4f76c59654129965d41e3579f8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6ca548a7765af7814f03390567c3bfe844921a845160c9b856aa1085a2a7ef6bd95d252c719278721d1c135a159b1876b4c3e09da80eb837eb398a96077b8b81
|
|
7
|
+
data.tar.gz: ad65d42d7d44291b030550f40ccbd2ab504867dc3bc1d0713e1f5445bd1d6b2d0fb66d49aa94a3a1856c00a995c8d9ba252aac7742b05837b7b75a7d6dc5be45
|
data/CHANGELOG.md
CHANGED
|
@@ -7,9 +7,29 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
|
|
|
7
7
|
|
|
8
8
|
## [Unreleased]
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
<a name="5.4.0"></a>
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
## [5.4.0] - 2025-10-24
|
|
13
|
+
|
|
14
|
+
### Added
|
|
15
|
+
|
|
16
|
+
- Add models for new TTS models and engine setup
|
|
17
|
+
- Add models and default api methods for Blob API
|
|
18
|
+
|
|
19
|
+
<a name="5.3.0"></a>
|
|
20
|
+
|
|
21
|
+
## [5.3.0] - 2025-09-23
|
|
22
|
+
|
|
23
|
+
### Added
|
|
24
|
+
|
|
25
|
+
- Add models for ExportResult and ExportRequest
|
|
26
|
+
|
|
27
|
+
### Changed
|
|
28
|
+
|
|
29
|
+
- CallResult.callStatus -> CallResult.status
|
|
30
|
+
- CreateConference now includes parentCallId
|
|
31
|
+
|
|
32
|
+
<a name="5.2.0"></a>
|
|
13
33
|
|
|
14
34
|
## [5.2.0] - 2025-02-18
|
|
15
35
|
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
freeclimb (5.
|
|
4
|
+
freeclimb (5.4.0)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
@@ -39,7 +39,7 @@ GEM
|
|
|
39
39
|
facets (3.1.0)
|
|
40
40
|
factory_bot (6.5.0)
|
|
41
41
|
activesupport (>= 5.0.0)
|
|
42
|
-
ffi (1.17.
|
|
42
|
+
ffi (1.17.2)
|
|
43
43
|
hashdiff (1.1.2)
|
|
44
44
|
i18n (1.14.6)
|
|
45
45
|
concurrent-ruby (~> 1.0)
|
|
@@ -64,7 +64,7 @@ GEM
|
|
|
64
64
|
rainbow (3.1.1)
|
|
65
65
|
rake (13.0.6)
|
|
66
66
|
regexp_parser (2.10.0)
|
|
67
|
-
rexml (3.4.
|
|
67
|
+
rexml (3.4.4)
|
|
68
68
|
rspec (3.13.0)
|
|
69
69
|
rspec-core (~> 3.13.0)
|
|
70
70
|
rspec-expectations (~> 3.13.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: 5.
|
|
10
|
+
- Package version: 5.4.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', '~> 5.
|
|
18
|
+
gem 'freeclimb', '~> 5.4.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-5.
|
|
47
|
+
gem install ./freeclimb-5.4.0.gem
|
|
48
48
|
```
|
|
49
|
-
(for development, run `gem install --dev ./freeclimb-5.
|
|
49
|
+
(for development, run `gem install --dev ./freeclimb-5.4.0.gem` to install the development dependencies)
|
|
50
50
|
|
|
51
51
|
## Getting Started
|
|
52
52
|
|
|
@@ -103,13 +103,18 @@ Class | Method | HTTP request | Description
|
|
|
103
103
|
*Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
|
|
104
104
|
*Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
|
|
105
105
|
*Freeclimb::DefaultApi* | [**create_an_application**](docs/DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application
|
|
106
|
+
*Freeclimb::DefaultApi* | [**create_blob**](docs/DefaultApi.md#create_blob) | **POST** /Accounts/{accountId}/Blobs | Create a Blob
|
|
107
|
+
*Freeclimb::DefaultApi* | [**create_export**](docs/DefaultApi.md#create_export) | **POST** /Accounts/{accountId}/Exports | Create an Export
|
|
106
108
|
*Freeclimb::DefaultApi* | [**create_knowledge_base_completion**](docs/DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base
|
|
107
109
|
*Freeclimb::DefaultApi* | [**delete_a_recording**](docs/DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
|
|
108
110
|
*Freeclimb::DefaultApi* | [**delete_an_application**](docs/DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
|
|
111
|
+
*Freeclimb::DefaultApi* | [**delete_an_export**](docs/DefaultApi.md#delete_an_export) | **DELETE** /Accounts/{accountId}/Exports/{exportId} | Delete an Export
|
|
109
112
|
*Freeclimb::DefaultApi* | [**delete_an_incoming_number**](docs/DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
|
|
113
|
+
*Freeclimb::DefaultApi* | [**delete_blob**](docs/DefaultApi.md#delete_blob) | **DELETE** /Accounts/{accountId}/Blobs/{blobId} | Delete Blob
|
|
110
114
|
*Freeclimb::DefaultApi* | [**dequeue_a_member**](docs/DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member
|
|
111
115
|
*Freeclimb::DefaultApi* | [**dequeue_head_member**](docs/DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member
|
|
112
116
|
*Freeclimb::DefaultApi* | [**download_a_recording_file**](docs/DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File
|
|
117
|
+
*Freeclimb::DefaultApi* | [**download_an_export**](docs/DefaultApi.md#download_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId}/Download | Download an Export
|
|
113
118
|
*Freeclimb::DefaultApi* | [**filter_logs**](docs/DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs
|
|
114
119
|
*Freeclimb::DefaultApi* | [**get_a_call**](docs/DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call
|
|
115
120
|
*Freeclimb::DefaultApi* | [**get_a_conference**](docs/DefaultApi.md#get_a_conference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference
|
|
@@ -119,8 +124,10 @@ Class | Method | HTTP request | Description
|
|
|
119
124
|
*Freeclimb::DefaultApi* | [**get_a_recording**](docs/DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
|
|
120
125
|
*Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
|
|
121
126
|
*Freeclimb::DefaultApi* | [**get_an_application**](docs/DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
|
|
127
|
+
*Freeclimb::DefaultApi* | [**get_an_export**](docs/DefaultApi.md#get_an_export) | **GET** /Accounts/{accountId}/Exports/{exportId} | Get an Export
|
|
122
128
|
*Freeclimb::DefaultApi* | [**get_an_incoming_number**](docs/DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
|
|
123
129
|
*Freeclimb::DefaultApi* | [**get_an_sms_message**](docs/DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
|
|
130
|
+
*Freeclimb::DefaultApi* | [**get_blob**](docs/DefaultApi.md#get_blob) | **GET** /Accounts/{accountId}/Blobs/{blobId} | Get Blob
|
|
124
131
|
*Freeclimb::DefaultApi* | [**get_head_member**](docs/DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member
|
|
125
132
|
*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_brand**](docs/DefaultApi.md#get_ten_dlc_sms_brand) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands/{brandId} | Get a 10DLC SMS Brand
|
|
126
133
|
*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_brands**](docs/DefaultApi.md#get_ten_dlc_sms_brands) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands | Get list of SMS 10DLC Brands
|
|
@@ -134,11 +141,13 @@ Class | Method | HTTP request | Description
|
|
|
134
141
|
*Freeclimb::DefaultApi* | [**list_all_account_logs**](docs/DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs
|
|
135
142
|
*Freeclimb::DefaultApi* | [**list_applications**](docs/DefaultApi.md#list_applications) | **GET** /Accounts/{accountId}/Applications | List applications
|
|
136
143
|
*Freeclimb::DefaultApi* | [**list_available_numbers**](docs/DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers
|
|
144
|
+
*Freeclimb::DefaultApi* | [**list_blobs**](docs/DefaultApi.md#list_blobs) | **GET** /Accounts/{accountId}/Blobs | List Blobs belonging to an account.
|
|
137
145
|
*Freeclimb::DefaultApi* | [**list_call_logs**](docs/DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs
|
|
138
146
|
*Freeclimb::DefaultApi* | [**list_call_recordings**](docs/DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings
|
|
139
147
|
*Freeclimb::DefaultApi* | [**list_calls**](docs/DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls
|
|
140
148
|
*Freeclimb::DefaultApi* | [**list_conference_recordings**](docs/DefaultApi.md#list_conference_recordings) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Recordings | List Conference Recordings
|
|
141
149
|
*Freeclimb::DefaultApi* | [**list_conferences**](docs/DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences
|
|
150
|
+
*Freeclimb::DefaultApi* | [**list_exports**](docs/DefaultApi.md#list_exports) | **GET** /Accounts/{accountId}/Exports | List Exports
|
|
142
151
|
*Freeclimb::DefaultApi* | [**list_incoming_numbers**](docs/DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers
|
|
143
152
|
*Freeclimb::DefaultApi* | [**list_members**](docs/DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members
|
|
144
153
|
*Freeclimb::DefaultApi* | [**list_participants**](docs/DefaultApi.md#list_participants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants
|
|
@@ -146,7 +155,9 @@ Class | Method | HTTP request | Description
|
|
|
146
155
|
*Freeclimb::DefaultApi* | [**list_sms_messages**](docs/DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages
|
|
147
156
|
*Freeclimb::DefaultApi* | [**make_a_call**](docs/DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call
|
|
148
157
|
*Freeclimb::DefaultApi* | [**make_a_webrtc_jwt**](docs/DefaultApi.md#make_a_webrtc_jwt) | **POST** /Accounts/{accountId}/Calls/WebRTC/Token | Make a JWT for WebRTC calling
|
|
158
|
+
*Freeclimb::DefaultApi* | [**modify_blob**](docs/DefaultApi.md#modify_blob) | **PATCH** /Accounts/{accountId}/Blobs/{blobId} | Modify Blob
|
|
149
159
|
*Freeclimb::DefaultApi* | [**remove_a_participant**](docs/DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant
|
|
160
|
+
*Freeclimb::DefaultApi* | [**replace_blob**](docs/DefaultApi.md#replace_blob) | **PUT** /Accounts/{accountId}/Blobs/{blobId} | Replace Blob
|
|
150
161
|
*Freeclimb::DefaultApi* | [**send_an_sms_message**](docs/DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message
|
|
151
162
|
*Freeclimb::DefaultApi* | [**stream_a_recording_file**](docs/DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File
|
|
152
163
|
*Freeclimb::DefaultApi* | [**update_a_conference**](docs/DefaultApi.md#update_a_conference) | **POST** /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference
|
|
@@ -174,6 +185,8 @@ Class | Method | HTTP request | Description
|
|
|
174
185
|
- [Freeclimb::AvailableNumber](docs/AvailableNumber.md)
|
|
175
186
|
- [Freeclimb::AvailableNumberList](docs/AvailableNumberList.md)
|
|
176
187
|
- [Freeclimb::BargeInReason](docs/BargeInReason.md)
|
|
188
|
+
- [Freeclimb::BlobListResponse](docs/BlobListResponse.md)
|
|
189
|
+
- [Freeclimb::BlobResult](docs/BlobResult.md)
|
|
177
190
|
- [Freeclimb::BuyIncomingNumberRequest](docs/BuyIncomingNumberRequest.md)
|
|
178
191
|
- [Freeclimb::CallControlWebhook](docs/CallControlWebhook.md)
|
|
179
192
|
- [Freeclimb::CallDirection](docs/CallDirection.md)
|
|
@@ -193,6 +206,7 @@ Class | Method | HTTP request | Description
|
|
|
193
206
|
- [Freeclimb::ConferenceResult](docs/ConferenceResult.md)
|
|
194
207
|
- [Freeclimb::ConferenceStatus](docs/ConferenceStatus.md)
|
|
195
208
|
- [Freeclimb::ConferenceStatusWebhook](docs/ConferenceStatusWebhook.md)
|
|
209
|
+
- [Freeclimb::CreateBlobRequest](docs/CreateBlobRequest.md)
|
|
196
210
|
- [Freeclimb::CreateConference](docs/CreateConference.md)
|
|
197
211
|
- [Freeclimb::CreateConferenceRequest](docs/CreateConferenceRequest.md)
|
|
198
212
|
- [Freeclimb::CreateConferenceWebhook](docs/CreateConferenceWebhook.md)
|
|
@@ -200,6 +214,14 @@ Class | Method | HTTP request | Description
|
|
|
200
214
|
- [Freeclimb::Dequeue](docs/Dequeue.md)
|
|
201
215
|
- [Freeclimb::DequeueWebhook](docs/DequeueWebhook.md)
|
|
202
216
|
- [Freeclimb::Enqueue](docs/Enqueue.md)
|
|
217
|
+
- [Freeclimb::ExportList](docs/ExportList.md)
|
|
218
|
+
- [Freeclimb::ExportOutputType](docs/ExportOutputType.md)
|
|
219
|
+
- [Freeclimb::ExportRequest](docs/ExportRequest.md)
|
|
220
|
+
- [Freeclimb::ExportRequestOutput](docs/ExportRequestOutput.md)
|
|
221
|
+
- [Freeclimb::ExportResourceType](docs/ExportResourceType.md)
|
|
222
|
+
- [Freeclimb::ExportResult](docs/ExportResult.md)
|
|
223
|
+
- [Freeclimb::ExportResultOutput](docs/ExportResultOutput.md)
|
|
224
|
+
- [Freeclimb::ExportStatus](docs/ExportStatus.md)
|
|
203
225
|
- [Freeclimb::FilterLogsRequest](docs/FilterLogsRequest.md)
|
|
204
226
|
- [Freeclimb::GetDigits](docs/GetDigits.md)
|
|
205
227
|
- [Freeclimb::GetDigitsReason](docs/GetDigitsReason.md)
|
|
@@ -230,6 +252,7 @@ Class | Method | HTTP request | Description
|
|
|
230
252
|
- [Freeclimb::MessageStatus](docs/MessageStatus.md)
|
|
231
253
|
- [Freeclimb::MessageStatusWebhook](docs/MessageStatusWebhook.md)
|
|
232
254
|
- [Freeclimb::MessagesList](docs/MessagesList.md)
|
|
255
|
+
- [Freeclimb::ModifyBlobRequest](docs/ModifyBlobRequest.md)
|
|
233
256
|
- [Freeclimb::MutableResourceModel](docs/MutableResourceModel.md)
|
|
234
257
|
- [Freeclimb::OutDial](docs/OutDial.md)
|
|
235
258
|
- [Freeclimb::OutDialApiConnectWebhook](docs/OutDialApiConnectWebhook.md)
|
|
@@ -240,6 +263,7 @@ Class | Method | HTTP request | Description
|
|
|
240
263
|
- [Freeclimb::Pause](docs/Pause.md)
|
|
241
264
|
- [Freeclimb::PerclCommand](docs/PerclCommand.md)
|
|
242
265
|
- [Freeclimb::PerclScript](docs/PerclScript.md)
|
|
266
|
+
- [Freeclimb::PlatformError](docs/PlatformError.md)
|
|
243
267
|
- [Freeclimb::Play](docs/Play.md)
|
|
244
268
|
- [Freeclimb::PlayBeep](docs/PlayBeep.md)
|
|
245
269
|
- [Freeclimb::PlayEarlyMedia](docs/PlayEarlyMedia.md)
|
|
@@ -260,6 +284,7 @@ Class | Method | HTTP request | Description
|
|
|
260
284
|
- [Freeclimb::Reject](docs/Reject.md)
|
|
261
285
|
- [Freeclimb::RemoveFromConference](docs/RemoveFromConference.md)
|
|
262
286
|
- [Freeclimb::RemoveFromQueueNotificationWebhook](docs/RemoveFromQueueNotificationWebhook.md)
|
|
287
|
+
- [Freeclimb::ReplaceBlobRequest](docs/ReplaceBlobRequest.md)
|
|
263
288
|
- [Freeclimb::RequestType](docs/RequestType.md)
|
|
264
289
|
- [Freeclimb::SMSTenDLCBrand](docs/SMSTenDLCBrand.md)
|
|
265
290
|
- [Freeclimb::SMSTenDLCBrandAltBusinessIdType](docs/SMSTenDLCBrandAltBusinessIdType.md)
|
|
@@ -287,6 +312,8 @@ Class | Method | HTTP request | Description
|
|
|
287
312
|
- [Freeclimb::StartRecordCall](docs/StartRecordCall.md)
|
|
288
313
|
- [Freeclimb::TFN](docs/TFN.md)
|
|
289
314
|
- [Freeclimb::TFNCampaign](docs/TFNCampaign.md)
|
|
315
|
+
- [Freeclimb::TTSEngine](docs/TTSEngine.md)
|
|
316
|
+
- [Freeclimb::TTSEngineName](docs/TTSEngineName.md)
|
|
290
317
|
- [Freeclimb::TerminateConference](docs/TerminateConference.md)
|
|
291
318
|
- [Freeclimb::TranscribeReason](docs/TranscribeReason.md)
|
|
292
319
|
- [Freeclimb::TranscribeTermReason](docs/TranscribeTermReason.md)
|
data/docs/AvailableNumber.md
CHANGED
|
@@ -7,8 +7,6 @@
|
|
|
7
7
|
| **capabilities** | [**Capabilities**](Capabilities.md) | | [optional] |
|
|
8
8
|
| **campaign_id** | **String** | The campaign ID generated by the campaign registry | [optional] |
|
|
9
9
|
| **phone_number** | **String** | The phone number, in E.164 format (+ country code and phone number: +18003608245). | [optional] |
|
|
10
|
-
| **voice_enabled** | **Boolean** | Typically set to true for all numbers. | [optional] |
|
|
11
|
-
| **sms_enabled** | **Boolean** | Indicates whether the phone number can send and receive SMS messages. | [optional] |
|
|
12
10
|
| **region** | **String** | The state or province of this phone number. | [optional] |
|
|
13
11
|
| **country** | **String** | The country of this phone number. | [optional] |
|
|
14
12
|
|
|
@@ -21,8 +19,6 @@ instance = Freeclimb::AvailableNumber.new(
|
|
|
21
19
|
capabilities: null,
|
|
22
20
|
campaign_id: null,
|
|
23
21
|
phone_number: null,
|
|
24
|
-
voice_enabled: null,
|
|
25
|
-
sms_enabled: null,
|
|
26
22
|
region: null,
|
|
27
23
|
country: null
|
|
28
24
|
)
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Freeclimb::BlobListResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **total** | **Integer** | Total amount of requested resource. | [optional] |
|
|
8
|
+
| **start** | **Integer** | Resource index at start of current page | [optional] |
|
|
9
|
+
| **_end** | **Integer** | Resource index at end of current page | [optional] |
|
|
10
|
+
| **page** | **Integer** | Current page | [optional] |
|
|
11
|
+
| **num_pages** | **Integer** | Total number of pages | [optional] |
|
|
12
|
+
| **page_size** | **Integer** | Number of items per page | [optional] |
|
|
13
|
+
| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
|
|
14
|
+
| **blobs** | [**Array<BlobResult>**](BlobResult.md) | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'freeclimb'
|
|
20
|
+
|
|
21
|
+
instance = Freeclimb::BlobListResponse.new(
|
|
22
|
+
total: null,
|
|
23
|
+
start: null,
|
|
24
|
+
_end: null,
|
|
25
|
+
page: null,
|
|
26
|
+
num_pages: null,
|
|
27
|
+
page_size: null,
|
|
28
|
+
next_page_uri: null,
|
|
29
|
+
blobs: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
data/docs/BlobResult.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Freeclimb::BlobResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **blob_id** | **String** | Identifier which can be used to reference this blob in future interations. | [optional] |
|
|
8
|
+
| **account_id** | **String** | | [optional] |
|
|
9
|
+
| **_alias** | **String** | Custom identifier for this blob that is unique for the owning account. It will be set to the blobId by default if not provided in the creation request. | [optional] |
|
|
10
|
+
| **revision** | **Integer** | | [optional] |
|
|
11
|
+
| **date_created** | **Time** | An RFC3339 timestamp with millisecond resolution. It represents the time this blob was created. | [optional] |
|
|
12
|
+
| **date_updated** | **Time** | An RFC3339 timestamp with millisecond resolution. It represents the time this blob was last modified, which at creation will always equal dateCreated. | [optional] |
|
|
13
|
+
| **expires_at** | **Time** | An RFC3339 timestamp with millisecond resolution. It represents the time at which this blob will expire and self delete. | [optional] |
|
|
14
|
+
| **blob** | **Object** | Blob content | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'freeclimb'
|
|
20
|
+
|
|
21
|
+
instance = Freeclimb::BlobResult.new(
|
|
22
|
+
blob_id: BL88615a9b4ca7e9aad57d9057773fc74268b9caf7,
|
|
23
|
+
account_id: AC0534faec6b32da45f36166674d65b3903f784141,
|
|
24
|
+
_alias: null,
|
|
25
|
+
revision: null,
|
|
26
|
+
date_created: null,
|
|
27
|
+
date_updated: null,
|
|
28
|
+
expires_at: null,
|
|
29
|
+
blob: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
data/docs/CallResult.md
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
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
|
-
| **
|
|
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] |
|
|
@@ -41,7 +41,7 @@ instance = Freeclimb::CallResult.new(
|
|
|
41
41
|
from: null,
|
|
42
42
|
to: null,
|
|
43
43
|
phone_number_id: null,
|
|
44
|
-
|
|
44
|
+
status: null,
|
|
45
45
|
start_time: null,
|
|
46
46
|
connect_time: null,
|
|
47
47
|
end_time: null,
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Freeclimb::CreateBlobRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **_alias** | **String** | Custom identifier for this blob that is unique for the owning account. It will be set to the blobId by default if not provided. | [optional] |
|
|
8
|
+
| **expires_at** | **String** | An RFC3339 timestamp with millisecond resolution. This timestamp defines the time at which this blob will delete itself. It must not be more than 48 hours in the future and will default to 9 hours in the future if not provided. | [optional] |
|
|
9
|
+
| **blob** | **Object** | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'freeclimb'
|
|
15
|
+
|
|
16
|
+
instance = Freeclimb::CreateBlobRequest.new(
|
|
17
|
+
_alias: null,
|
|
18
|
+
expires_at: 2006-01-02T15:04:05.000Z,
|
|
19
|
+
blob: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
data/docs/CreateConference.md
CHANGED
|
@@ -5,11 +5,12 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
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
|
-
| **_alias** | **
|
|
8
|
+
| **_alias** | **String** | Descriptive name for the Conference. | [optional] |
|
|
9
9
|
| **play_beep** | [**PlayBeep**](PlayBeep.md) | | [optional] |
|
|
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
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
|
+
| **parent_call_id** | **String** | ID of the Call that created this leg (child call). | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
15
16
|
|
|
@@ -22,7 +23,8 @@ instance = Freeclimb::CreateConference.new(
|
|
|
22
23
|
play_beep: null,
|
|
23
24
|
record: null,
|
|
24
25
|
status_callback_url: null,
|
|
25
|
-
wait_url: null
|
|
26
|
+
wait_url: null,
|
|
27
|
+
parent_call_id: null
|
|
26
28
|
)
|
|
27
29
|
```
|
|
28
30
|
|