freeclimb 4.7.0 → 4.9.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 +18 -0
- data/Gemfile.lock +21 -21
- data/README.md +9 -4
- data/docs/AddToConference.md +3 -1
- data/docs/AddToConferenceAllOf.md +3 -1
- data/docs/CallResult.md +3 -1
- data/docs/CallResultAllOf.md +3 -1
- data/docs/CompletionRequest.md +18 -0
- data/docs/CompletionResult.md +20 -0
- data/docs/ConferenceParticipantResult.md +2 -0
- data/docs/ConferenceParticipantResultAllOf.md +2 -0
- data/docs/DefaultApi.md +79 -1
- data/docs/SMSTenDLCCampaign.md +1 -1
- data/docs/SetDTMFPassThrough.md +18 -0
- data/docs/SetDTMFPassThroughAllOf.md +18 -0
- data/docs/UpdateConferenceParticipantRequest.md +3 -1
- data/lib/freeclimb/api/default_api.rb +72 -0
- data/lib/freeclimb/models/add_to_conference.rb +14 -4
- data/lib/freeclimb/models/add_to_conference_all_of.rb +14 -4
- data/lib/freeclimb/models/call_result.rb +16 -5
- data/lib/freeclimb/models/call_result_all_of.rb +16 -5
- data/lib/freeclimb/models/completion_request.rb +246 -0
- data/lib/freeclimb/models/completion_result.rb +274 -0
- data/lib/freeclimb/models/conference_participant_result.rb +12 -1
- data/lib/freeclimb/models/conference_participant_result_all_of.rb +12 -1
- data/lib/freeclimb/models/message_request.rb +1 -0
- data/lib/freeclimb/models/message_request_all_of.rb +1 -0
- data/lib/freeclimb/models/message_result.rb +1 -0
- data/lib/freeclimb/models/message_result_all_of.rb +1 -0
- data/lib/freeclimb/models/set_dtmf_pass_through.rb +238 -0
- data/lib/freeclimb/models/set_dtmf_pass_through_all_of.rb +224 -0
- data/lib/freeclimb/models/set_listen.rb +1 -1
- data/lib/freeclimb/models/set_talk.rb +1 -1
- data/lib/freeclimb/models/update_conference_participant_request.rb +14 -4
- data/lib/freeclimb/version.rb +1 -1
- data/lib/freeclimb.rb +4 -0
- data/openapi.json +130 -10
- data/package.json +3 -1
- data/spec/api/default_api_spec.rb +29 -0
- data/spec/models/account_request_spec.rb +2 -1
- data/spec/models/account_result_spec.rb +2 -1
- data/spec/models/add_to_conference_spec.rb +2 -7
- data/spec/models/application_list_spec.rb +2 -1
- data/spec/models/application_request_spec.rb +2 -1
- data/spec/models/application_result_spec.rb +2 -1
- data/spec/models/available_number_list_spec.rb +2 -1
- data/spec/models/available_number_spec.rb +2 -3
- data/spec/models/buy_incoming_number_request_spec.rb +2 -3
- data/spec/models/call_list_spec.rb +2 -1
- data/spec/models/call_result_spec.rb +2 -1
- data/spec/models/capabilities_spec.rb +2 -16
- data/spec/models/completion_request_spec.rb +165 -0
- data/spec/models/completion_result_spec.rb +203 -0
- data/spec/models/conference_list_spec.rb +2 -1
- data/spec/models/conference_participant_list_spec.rb +2 -1
- data/spec/models/conference_participant_result_spec.rb +2 -4
- data/spec/models/conference_result_spec.rb +2 -2
- data/spec/models/create_conference_request_spec.rb +2 -2
- data/spec/models/create_conference_spec.rb +2 -5
- data/spec/models/create_web_rtc_token_spec.rb +2 -5
- data/spec/models/enqueue_spec.rb +2 -7
- data/spec/models/filter_logs_request_spec.rb +2 -3
- data/spec/models/get_digits_spec.rb +2 -5
- data/spec/models/get_speech_spec.rb +2 -7
- data/spec/models/hangup_spec.rb +2 -1
- data/spec/models/incoming_number_list_spec.rb +2 -1
- data/spec/models/incoming_number_request_spec.rb +2 -1
- data/spec/models/incoming_number_result_spec.rb +2 -4
- data/spec/models/log_list_spec.rb +2 -1
- data/spec/models/log_result_spec.rb +2 -1
- data/spec/models/make_call_request_spec.rb +2 -6
- data/spec/models/message_request_spec.rb +2 -7
- data/spec/models/message_result_spec.rb +2 -1
- data/spec/models/messages_list_spec.rb +2 -1
- data/spec/models/mutable_resource_model_spec.rb +2 -1
- data/spec/models/out_dial_spec.rb +2 -10
- data/spec/models/pagination_model_spec.rb +2 -1
- data/spec/models/park_spec.rb +2 -5
- data/spec/models/pause_spec.rb +2 -3
- data/spec/models/percl_command_spec.rb +2 -1
- data/spec/models/percl_script_spec.rb +2 -1
- data/spec/models/play_early_media_spec.rb +2 -3
- data/spec/models/play_spec.rb +2 -4
- data/spec/models/queue_list_spec.rb +2 -1
- data/spec/models/queue_member_list_spec.rb +2 -1
- data/spec/models/queue_member_spec.rb +2 -1
- data/spec/models/queue_request_spec.rb +2 -1
- data/spec/models/queue_result_spec.rb +2 -1
- data/spec/models/record_utterance_spec.rb +2 -6
- data/spec/models/recording_list_spec.rb +2 -1
- data/spec/models/recording_result_spec.rb +2 -1
- data/spec/models/redirect_spec.rb +2 -3
- data/spec/models/reject_spec.rb +2 -1
- data/spec/models/say_spec.rb +2 -4
- data/spec/models/send_digits_spec.rb +2 -4
- data/spec/models/set_dtmf_pass_through_spec.rb +163 -0
- data/spec/models/set_listen_spec.rb +2 -2
- data/spec/models/set_talk_spec.rb +2 -2
- data/spec/models/sms_spec.rb +2 -7
- data/spec/models/sms_ten_dlc_brand_spec.rb +132 -103
- data/spec/models/sms_ten_dlc_brands_list_result_spec.rb +2 -1
- data/spec/models/sms_ten_dlc_campaign_spec.rb +21 -53
- data/spec/models/sms_ten_dlc_campaigns_list_result_spec.rb +2 -1
- data/spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb +2 -8
- data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +21 -43
- data/spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb +2 -1
- data/spec/models/sms_toll_free_campaign_spec.rb +24 -29
- data/spec/models/sms_toll_free_campaigns_list_result_spec.rb +2 -1
- data/spec/models/tfn_spec.rb +2 -3
- data/spec/models/transcribe_utterance_all_of_record_spec.rb +2 -6
- data/spec/models/transcribe_utterance_spec.rb +2 -6
- data/spec/models/update_call_request_spec.rb +2 -3
- data/spec/models/update_conference_participant_request_spec.rb +2 -3
- data/spec/models/update_conference_request_spec.rb +2 -1
- data/yarn.lock +27 -8
- metadata +95 -81
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: ab5355064b8d4d3309319100785c04778f540343e48256068e9c7b47b1927865
|
|
4
|
+
data.tar.gz: 454959fb949b435bd189d280347c2e898100c8b0efa2b4c4c5cdb2f5b0f55f46
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 5b00fe3b725aefa869e8c1137d9e4810c7b94b88e992df67f32147d5c1c6f6244e986237ebd4dc279c7c51365a9fd1a4c3c28bc244eb33680575e9254159f4cc
|
|
7
|
+
data.tar.gz: 396a18c44f3489ef8af164b5469390d6c914ab929a8226bfaf8f9dd09d213612ee437251780e67f271e725099072cb971b6bd0de012d7b33c063bd9970d0e0e2
|
data/CHANGELOG.md
CHANGED
|
@@ -9,6 +9,24 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
|
|
|
9
9
|
|
|
10
10
|
None
|
|
11
11
|
|
|
12
|
+
<a name="4.9.0"></a>
|
|
13
|
+
|
|
14
|
+
## [4.9.0] - 2024-12-17
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
|
|
18
|
+
- Use latest spec updates
|
|
19
|
+
- mediaUrls are nullable
|
|
20
|
+
- Add SetDTMFPassThrough command
|
|
21
|
+
|
|
22
|
+
<a name="4.8.0"></a>
|
|
23
|
+
|
|
24
|
+
## [4.8.0] - 2024-10-08
|
|
25
|
+
|
|
26
|
+
### Added
|
|
27
|
+
|
|
28
|
+
- Add KnowledgeBase API to SDK
|
|
29
|
+
|
|
12
30
|
<a name="4.7.0"></a>
|
|
13
31
|
|
|
14
32
|
## [4.7.0] - 2024-09-12
|
data/Gemfile.lock
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
freeclimb (4.
|
|
4
|
+
freeclimb (4.9.0)
|
|
5
5
|
typhoeus (~> 1.0, >= 1.0.1)
|
|
6
6
|
|
|
7
7
|
GEM
|
|
8
8
|
remote: https://rubygems.org/
|
|
9
9
|
specs:
|
|
10
|
-
activesupport (7.1.
|
|
10
|
+
activesupport (7.1.4.1)
|
|
11
11
|
base64
|
|
12
12
|
bigdecimal
|
|
13
13
|
concurrent-ruby (~> 1.0, >= 1.0.2)
|
|
@@ -17,14 +17,14 @@ GEM
|
|
|
17
17
|
minitest (>= 5.1)
|
|
18
18
|
mutex_m
|
|
19
19
|
tzinfo (~> 2.0)
|
|
20
|
-
addressable (2.8.
|
|
21
|
-
public_suffix (>= 2.0.2, <
|
|
20
|
+
addressable (2.8.7)
|
|
21
|
+
public_suffix (>= 2.0.2, < 7.0)
|
|
22
22
|
ast (2.4.2)
|
|
23
23
|
base64 (0.2.0)
|
|
24
|
-
bigdecimal (3.1.
|
|
24
|
+
bigdecimal (3.1.8)
|
|
25
25
|
byebug (11.1.3)
|
|
26
26
|
coderay (1.1.3)
|
|
27
|
-
concurrent-ruby (1.
|
|
27
|
+
concurrent-ruby (1.3.4)
|
|
28
28
|
connection_pool (2.4.1)
|
|
29
29
|
crack (1.0.0)
|
|
30
30
|
bigdecimal
|
|
@@ -34,18 +34,18 @@ GEM
|
|
|
34
34
|
ethon (0.16.0)
|
|
35
35
|
ffi (>= 1.15.0)
|
|
36
36
|
facets (3.1.0)
|
|
37
|
-
factory_bot (6.
|
|
37
|
+
factory_bot (6.5.0)
|
|
38
38
|
activesupport (>= 5.0.0)
|
|
39
39
|
ffi (1.17.0)
|
|
40
|
-
hashdiff (1.1.
|
|
41
|
-
i18n (1.14.
|
|
40
|
+
hashdiff (1.1.1)
|
|
41
|
+
i18n (1.14.6)
|
|
42
42
|
concurrent-ruby (~> 1.0)
|
|
43
43
|
jaro_winkler (1.5.6)
|
|
44
|
-
method_source (1.
|
|
45
|
-
minitest (5.
|
|
44
|
+
method_source (1.1.0)
|
|
45
|
+
minitest (5.25.1)
|
|
46
46
|
mutex_m (0.2.0)
|
|
47
|
-
parallel (1.
|
|
48
|
-
parser (3.3.0
|
|
47
|
+
parallel (1.26.3)
|
|
48
|
+
parser (3.3.5.0)
|
|
49
49
|
ast (~> 2.4.1)
|
|
50
50
|
racc
|
|
51
51
|
pry (0.14.2)
|
|
@@ -56,21 +56,21 @@ GEM
|
|
|
56
56
|
pry (>= 0.13, < 0.15)
|
|
57
57
|
psych (5.1.2)
|
|
58
58
|
stringio
|
|
59
|
-
public_suffix (
|
|
60
|
-
racc (1.
|
|
59
|
+
public_suffix (6.0.1)
|
|
60
|
+
racc (1.8.1)
|
|
61
61
|
rainbow (3.1.1)
|
|
62
62
|
rake (13.0.6)
|
|
63
|
-
rexml (3.
|
|
63
|
+
rexml (3.3.8)
|
|
64
64
|
rspec (3.13.0)
|
|
65
65
|
rspec-core (~> 3.13.0)
|
|
66
66
|
rspec-expectations (~> 3.13.0)
|
|
67
67
|
rspec-mocks (~> 3.13.0)
|
|
68
|
-
rspec-core (3.13.
|
|
68
|
+
rspec-core (3.13.1)
|
|
69
69
|
rspec-support (~> 3.13.0)
|
|
70
|
-
rspec-expectations (3.13.
|
|
70
|
+
rspec-expectations (3.13.3)
|
|
71
71
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
72
72
|
rspec-support (~> 3.13.0)
|
|
73
|
-
rspec-mocks (3.13.
|
|
73
|
+
rspec-mocks (3.13.2)
|
|
74
74
|
diff-lcs (>= 1.2.0, < 2.0)
|
|
75
75
|
rspec-support (~> 3.13.0)
|
|
76
76
|
rspec-support (3.13.1)
|
|
@@ -83,13 +83,13 @@ GEM
|
|
|
83
83
|
ruby-progressbar (~> 1.7)
|
|
84
84
|
unicode-display_width (>= 1.4.0, < 1.6)
|
|
85
85
|
ruby-progressbar (1.13.0)
|
|
86
|
-
stringio (3.1.
|
|
86
|
+
stringio (3.1.1)
|
|
87
87
|
typhoeus (1.4.1)
|
|
88
88
|
ethon (>= 0.9.0)
|
|
89
89
|
tzinfo (2.0.6)
|
|
90
90
|
concurrent-ruby (~> 1.0)
|
|
91
91
|
unicode-display_width (1.5.0)
|
|
92
|
-
webmock (3.
|
|
92
|
+
webmock (3.24.0)
|
|
93
93
|
addressable (>= 2.8.0)
|
|
94
94
|
crack (>= 0.3.2)
|
|
95
95
|
hashdiff (>= 0.4.0, < 2.0.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.
|
|
10
|
+
- Package version: 4.9.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.
|
|
18
|
+
gem 'freeclimb', '~> 4.9.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.
|
|
47
|
+
gem install ./freeclimb-4.9.0.gem
|
|
48
48
|
```
|
|
49
|
-
(for development, run `gem install --dev ./freeclimb-4.
|
|
49
|
+
(for development, run `gem install --dev ./freeclimb-4.9.0.gem` to install the development dependencies)
|
|
50
50
|
|
|
51
51
|
## Getting Started
|
|
52
52
|
|
|
@@ -103,6 +103,7 @@ 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_knowledge_base_completion**](docs/DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base
|
|
106
107
|
*Freeclimb::DefaultApi* | [**delete_a_recording**](docs/DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
|
|
107
108
|
*Freeclimb::DefaultApi* | [**delete_an_application**](docs/DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
|
|
108
109
|
*Freeclimb::DefaultApi* | [**delete_an_incoming_number**](docs/DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
|
|
@@ -183,6 +184,8 @@ Class | Method | HTTP request | Description
|
|
|
183
184
|
- [Freeclimb::CallResultAllOf](docs/CallResultAllOf.md)
|
|
184
185
|
- [Freeclimb::CallStatus](docs/CallStatus.md)
|
|
185
186
|
- [Freeclimb::Capabilities](docs/Capabilities.md)
|
|
187
|
+
- [Freeclimb::CompletionRequest](docs/CompletionRequest.md)
|
|
188
|
+
- [Freeclimb::CompletionResult](docs/CompletionResult.md)
|
|
186
189
|
- [Freeclimb::ConferenceList](docs/ConferenceList.md)
|
|
187
190
|
- [Freeclimb::ConferenceListAllOf](docs/ConferenceListAllOf.md)
|
|
188
191
|
- [Freeclimb::ConferenceParticipantList](docs/ConferenceParticipantList.md)
|
|
@@ -284,6 +287,8 @@ Class | Method | HTTP request | Description
|
|
|
284
287
|
- [Freeclimb::SayAllOf](docs/SayAllOf.md)
|
|
285
288
|
- [Freeclimb::SendDigits](docs/SendDigits.md)
|
|
286
289
|
- [Freeclimb::SendDigitsAllOf](docs/SendDigitsAllOf.md)
|
|
290
|
+
- [Freeclimb::SetDTMFPassThrough](docs/SetDTMFPassThrough.md)
|
|
291
|
+
- [Freeclimb::SetDTMFPassThroughAllOf](docs/SetDTMFPassThroughAllOf.md)
|
|
287
292
|
- [Freeclimb::SetListen](docs/SetListen.md)
|
|
288
293
|
- [Freeclimb::SetListenAllOf](docs/SetListenAllOf.md)
|
|
289
294
|
- [Freeclimb::SetTalk](docs/SetTalk.md)
|
data/docs/AddToConference.md
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional] |
|
|
14
14
|
| **start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants. | [optional] |
|
|
15
15
|
| **talk** | **Boolean** | If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command. | [optional] |
|
|
16
|
+
| **dtmf_pass_through** | **Boolean** | If `true`, the Participant joins the Conference with dtmfPassThrough privileges. This may be modified later via the REST API or `SetDTMFPassThrough` PerCL command. | [optional] |
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -28,7 +29,8 @@ instance = Freeclimb::AddToConference.new(
|
|
|
28
29
|
listen: null,
|
|
29
30
|
notification_url: null,
|
|
30
31
|
start_conf_on_enter: null,
|
|
31
|
-
talk: null
|
|
32
|
+
talk: null,
|
|
33
|
+
dtmf_pass_through: null
|
|
32
34
|
)
|
|
33
35
|
```
|
|
34
36
|
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional] |
|
|
14
14
|
| **start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants. | [optional] |
|
|
15
15
|
| **talk** | **Boolean** | If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command. | [optional] |
|
|
16
|
+
| **dtmf_pass_through** | **Boolean** | If `true`, the Participant joins the Conference with dtmfPassThrough privileges. This may be modified later via the REST API or `SetDTMFPassThrough` PerCL command. | [optional] |
|
|
16
17
|
|
|
17
18
|
## Example
|
|
18
19
|
|
|
@@ -28,7 +29,8 @@ instance = Freeclimb::AddToConferenceAllOf.new(
|
|
|
28
29
|
listen: null,
|
|
29
30
|
notification_url: null,
|
|
30
31
|
start_conf_on_enter: null,
|
|
31
|
-
talk: null
|
|
32
|
+
talk: null,
|
|
33
|
+
dtmf_pass_through: null
|
|
32
34
|
)
|
|
33
35
|
```
|
|
34
36
|
|
data/docs/CallResult.md
CHANGED
|
@@ -23,6 +23,7 @@
|
|
|
23
23
|
| **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
|
|
24
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
|
+
| **application_id** | **String** | ApplicationId associated with the Call. | [optional] |
|
|
26
27
|
|
|
27
28
|
## Example
|
|
28
29
|
|
|
@@ -48,7 +49,8 @@ instance = Freeclimb::CallResult.new(
|
|
|
48
49
|
connect_duration: null,
|
|
49
50
|
direction: null,
|
|
50
51
|
answered_by: null,
|
|
51
|
-
subresource_uris: null
|
|
52
|
+
subresource_uris: null,
|
|
53
|
+
application_id: null
|
|
52
54
|
)
|
|
53
55
|
```
|
|
54
56
|
|
data/docs/CallResultAllOf.md
CHANGED
|
@@ -19,6 +19,7 @@
|
|
|
19
19
|
| **direction** | [**CallDirection**](CallDirection.md) | | [optional] |
|
|
20
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
|
+
| **application_id** | **String** | ApplicationId associated with the Call. | [optional] |
|
|
22
23
|
|
|
23
24
|
## Example
|
|
24
25
|
|
|
@@ -40,7 +41,8 @@ instance = Freeclimb::CallResultAllOf.new(
|
|
|
40
41
|
connect_duration: null,
|
|
41
42
|
direction: null,
|
|
42
43
|
answered_by: null,
|
|
43
|
-
subresource_uris: null
|
|
44
|
+
subresource_uris: null,
|
|
45
|
+
application_id: null
|
|
44
46
|
)
|
|
45
47
|
```
|
|
46
48
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Freeclimb::CompletionRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **query** | **String** | Question to ask the Knowledge Base | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'freeclimb'
|
|
13
|
+
|
|
14
|
+
instance = Freeclimb::CompletionRequest.new(
|
|
15
|
+
query: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# Freeclimb::CompletionResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **response** | **String** | The generative response from the KnowledgeBase | |
|
|
8
|
+
| **status** | **String** | Completion result status. Possible values: success, no_context | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'freeclimb'
|
|
14
|
+
|
|
15
|
+
instance = Freeclimb::CompletionResult.new(
|
|
16
|
+
response: null,
|
|
17
|
+
status: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
| **call_id** | **String** | ID of the Call associated with this Participant. | [optional] |
|
|
14
14
|
| **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional] |
|
|
15
15
|
| **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional] |
|
|
16
|
+
| **dtmf_pass_through** | **Boolean** | True if this Participant had dtmfPassThrough privileges in the Conference. False otherwise. | [optional] |
|
|
16
17
|
| **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional] |
|
|
17
18
|
|
|
18
19
|
## Example
|
|
@@ -30,6 +31,7 @@ instance = Freeclimb::ConferenceParticipantResult.new(
|
|
|
30
31
|
call_id: null,
|
|
31
32
|
talk: null,
|
|
32
33
|
listen: null,
|
|
34
|
+
dtmf_pass_through: null,
|
|
33
35
|
start_conf_on_enter: null
|
|
34
36
|
)
|
|
35
37
|
```
|
|
@@ -9,6 +9,7 @@
|
|
|
9
9
|
| **call_id** | **String** | ID of the Call associated with this Participant. | [optional] |
|
|
10
10
|
| **talk** | **Boolean** | True if this Participant has talk privileges in the Conference. False otherwise. | [optional] |
|
|
11
11
|
| **listen** | **Boolean** | True if this Participant has listen privileges in the Conference. False otherwise. | [optional] |
|
|
12
|
+
| **dtmf_pass_through** | **Boolean** | True if this Participant had dtmfPassThrough privileges in the Conference. False otherwise. | [optional] |
|
|
12
13
|
| **start_conf_on_enter** | **Boolean** | True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise. | [optional] |
|
|
13
14
|
|
|
14
15
|
## Example
|
|
@@ -22,6 +23,7 @@ instance = Freeclimb::ConferenceParticipantResultAllOf.new(
|
|
|
22
23
|
call_id: null,
|
|
23
24
|
talk: null,
|
|
24
25
|
listen: null,
|
|
26
|
+
dtmf_pass_through: null,
|
|
25
27
|
start_conf_on_enter: null
|
|
26
28
|
)
|
|
27
29
|
```
|
data/docs/DefaultApi.md
CHANGED
|
@@ -12,6 +12,8 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
|
|
|
12
12
|
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
|
13
13
|
| [**create_an_application**](DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application |
|
|
14
14
|
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
|
15
|
+
| [**create_knowledge_base_completion**](DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base |
|
|
16
|
+
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
|
15
17
|
| [**delete_a_recording**](DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording |
|
|
16
18
|
| [**get_next_page**](DefaultApi.md#get_next_page) | **GET** | Get next page of paginated resource |
|
|
17
19
|
| [**delete_an_application**](DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application |
|
|
@@ -401,6 +403,80 @@ end
|
|
|
401
403
|
- **Accept**: application/json
|
|
402
404
|
|
|
403
405
|
|
|
406
|
+
## create_knowledge_base_completion
|
|
407
|
+
|
|
408
|
+
Query the knowledge base
|
|
409
|
+
|
|
410
|
+
### Examples
|
|
411
|
+
|
|
412
|
+
```ruby
|
|
413
|
+
require 'time'
|
|
414
|
+
require 'freeclimb'
|
|
415
|
+
# setup authorization
|
|
416
|
+
Freeclimb.configure do |config|
|
|
417
|
+
# Configure HTTP basic authorization: fc
|
|
418
|
+
config.username = 'ACCOUNT_ID'
|
|
419
|
+
config.password = 'API_KEY'
|
|
420
|
+
end
|
|
421
|
+
|
|
422
|
+
api_instance = Freeclimb::DefaultApi.new
|
|
423
|
+
|
|
424
|
+
knowledge_base_id = 'knowledge_base_id_example' # String | A string that uniquely identifies the KnowledgeBase resource.
|
|
425
|
+
|
|
426
|
+
opts = {
|
|
427
|
+
completion_request: Freeclimb::CompletionRequest.new({query: 'query_example'}) # CompletionRequest | Completion request details
|
|
428
|
+
}
|
|
429
|
+
|
|
430
|
+
begin
|
|
431
|
+
|
|
432
|
+
# Query the knowledge base
|
|
433
|
+
result = api_instance.create_knowledge_base_completion(knowledge_base_id, opts)
|
|
434
|
+
p result
|
|
435
|
+
rescue Freeclimb::ApiError => e
|
|
436
|
+
puts "Error when calling DefaultApi->create_knowledge_base_completion: #{e}"
|
|
437
|
+
end
|
|
438
|
+
```
|
|
439
|
+
|
|
440
|
+
#### Using the create_knowledge_base_completion_with_http_info variant
|
|
441
|
+
|
|
442
|
+
This returns an Array which contains the response data, status code and headers.
|
|
443
|
+
|
|
444
|
+
> <Array(<CompletionResult>, Integer, Hash)> create_knowledge_base_completion_with_http_info(account_id, knowledge_base_id, opts)
|
|
445
|
+
|
|
446
|
+
```ruby
|
|
447
|
+
begin
|
|
448
|
+
# Query the knowledge base
|
|
449
|
+
data, status_code, headers = api_instance.create_knowledge_base_completion_with_http_info(knowledge_base_id, opts)
|
|
450
|
+
p status_code # => 2xx
|
|
451
|
+
p headers # => { ... }
|
|
452
|
+
p data # => <CompletionResult>
|
|
453
|
+
rescue Freeclimb::ApiError => e
|
|
454
|
+
puts "Error when calling DefaultApi->create_knowledge_base_completion_with_http_info: #{e}"
|
|
455
|
+
end
|
|
456
|
+
```
|
|
457
|
+
|
|
458
|
+
### Parameters
|
|
459
|
+
|
|
460
|
+
| Name | Type | Description | Notes |
|
|
461
|
+
| ---- | ---- | ----------- | ----- |
|
|
462
|
+
| **knowledge_base_id** | **String** | A string that uniquely identifies the KnowledgeBase resource. | |
|
|
463
|
+
| **completion_request** | [**CompletionRequest**](CompletionRequest.md) | Completion request details | [optional] |
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
### Return type
|
|
467
|
+
|
|
468
|
+
[**CompletionResult**](CompletionResult.md)
|
|
469
|
+
|
|
470
|
+
### Authorization
|
|
471
|
+
|
|
472
|
+
[fc](../README.md#fc)
|
|
473
|
+
|
|
474
|
+
### HTTP request headers
|
|
475
|
+
|
|
476
|
+
- **Content-Type**: application/json
|
|
477
|
+
- **Accept**: application/json
|
|
478
|
+
|
|
479
|
+
|
|
404
480
|
## delete_a_recording
|
|
405
481
|
|
|
406
482
|
Delete a Recording
|
|
@@ -3093,7 +3169,8 @@ conference_id = 'conference_id_example' # String | ID of the conference this par
|
|
|
3093
3169
|
|
|
3094
3170
|
opts = {
|
|
3095
3171
|
talk: true, # Boolean | Only show Participants with the talk privilege.
|
|
3096
|
-
listen: true # Boolean | Only show Participants with the listen privilege.
|
|
3172
|
+
listen: true, # Boolean | Only show Participants with the listen privilege.
|
|
3173
|
+
dtmf_pass_through: true # Boolean | Only show Participants with the dtmfPassThrough privilege.
|
|
3097
3174
|
}
|
|
3098
3175
|
|
|
3099
3176
|
begin
|
|
@@ -3131,6 +3208,7 @@ end
|
|
|
3131
3208
|
| **conference_id** | **String** | ID of the conference this participant is in. | |
|
|
3132
3209
|
| **talk** | **Boolean** | Only show Participants with the talk privilege. | [optional] |
|
|
3133
3210
|
| **listen** | **Boolean** | Only show Participants with the listen privilege. | [optional] |
|
|
3211
|
+
| **dtmf_pass_through** | **Boolean** | Only show Participants with the dtmfPassThrough privilege. | [optional] |
|
|
3134
3212
|
|
|
3135
3213
|
|
|
3136
3214
|
### Return type
|
data/docs/SMSTenDLCCampaign.md
CHANGED
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Freeclimb::SetDTMFPassThrough
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dtmf_pass_through** | **Boolean** | Specifying `false` mutes the Participant's dtmf audio. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'freeclimb'
|
|
13
|
+
|
|
14
|
+
instance = Freeclimb::SetDTMFPassThrough.new(
|
|
15
|
+
dtmf_pass_through: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# Freeclimb::SetDTMFPassThroughAllOf
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dtmf_pass_through** | **Boolean** | Specifying `false` mutes the Participant's dtmf audio. | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'freeclimb'
|
|
13
|
+
|
|
14
|
+
instance = Freeclimb::SetDTMFPassThroughAllOf.new(
|
|
15
|
+
dtmf_pass_through: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **talk** | **Boolean** | (Optional) Default is `true`. Setting to `false` mutes the Participant. FreeClimb returns an error and ignores any other value. | [optional] |
|
|
8
8
|
| **listen** | **Boolean** | (Optional) Default is `true`. Setting to `false` silences the Conference for this Participant. FreeClimb returns an error and ignores any other value. | [optional] |
|
|
9
|
+
| **dtmf_pass_through** | **Boolean** | (Optional) Default is `true`. Setting to `false` mutes dtmf audio for this Participant. FreeClimb returns an error and ignores any other value. | [optional] |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,7 +15,8 @@ require 'freeclimb'
|
|
|
14
15
|
|
|
15
16
|
instance = Freeclimb::UpdateConferenceParticipantRequest.new(
|
|
16
17
|
talk: null,
|
|
17
|
-
listen: null
|
|
18
|
+
listen: null,
|
|
19
|
+
dtmf_pass_through: null
|
|
18
20
|
)
|
|
19
21
|
```
|
|
20
22
|
|
|
@@ -277,6 +277,75 @@ module Freeclimb
|
|
|
277
277
|
return data, status_code, headers
|
|
278
278
|
end
|
|
279
279
|
|
|
280
|
+
# Query the knowledge base
|
|
281
|
+
# @param knowledge_base_id [String] A string that uniquely identifies the KnowledgeBase resource.
|
|
282
|
+
# @param [Hash] opts the optional parameters
|
|
283
|
+
# @option opts [CompletionRequest] :completion_request Completion request details
|
|
284
|
+
# @return [CompletionResult]
|
|
285
|
+
def create_knowledge_base_completion(knowledge_base_id, opts = {})
|
|
286
|
+
data, _status_code, _headers = create_knowledge_base_completion_with_http_info(knowledge_base_id, opts)
|
|
287
|
+
data
|
|
288
|
+
end
|
|
289
|
+
|
|
290
|
+
# Query the knowledge base
|
|
291
|
+
# @param knowledge_base_id [String] A string that uniquely identifies the KnowledgeBase resource.
|
|
292
|
+
# @param [Hash] opts the optional parameters
|
|
293
|
+
# @option opts [CompletionRequest] :completion_request Completion request details
|
|
294
|
+
# @return [Array<(CompletionResult, Integer, Hash)>] CompletionResult data, response status code and response headers
|
|
295
|
+
def create_knowledge_base_completion_with_http_info(knowledge_base_id, opts = {})
|
|
296
|
+
if @api_client.config.debugging
|
|
297
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.create_knowledge_base_completion ...'
|
|
298
|
+
end
|
|
299
|
+
|
|
300
|
+
# verify the required parameter 'knowledge_base_id' is set
|
|
301
|
+
if @api_client.config.client_side_validation && knowledge_base_id.nil?
|
|
302
|
+
fail ArgumentError, "Missing the required parameter 'knowledge_base_id' when calling DefaultApi.create_knowledge_base_completion"
|
|
303
|
+
end
|
|
304
|
+
# resource path
|
|
305
|
+
local_var_path = '/Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'knowledgeBaseId' + '}', CGI.escape(knowledge_base_id.to_s))
|
|
306
|
+
|
|
307
|
+
# query parameters
|
|
308
|
+
query_params = opts[:query_params] || {}
|
|
309
|
+
|
|
310
|
+
# header parameters
|
|
311
|
+
header_params = opts[:header_params] || {}
|
|
312
|
+
# HTTP header 'Accept' (if needed)
|
|
313
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
314
|
+
# HTTP header 'Content-Type'
|
|
315
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
316
|
+
if !content_type.nil?
|
|
317
|
+
header_params['Content-Type'] = content_type
|
|
318
|
+
end
|
|
319
|
+
|
|
320
|
+
# form parameters
|
|
321
|
+
form_params = opts[:form_params] || {}
|
|
322
|
+
|
|
323
|
+
# http body (model)
|
|
324
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'completion_request'])
|
|
325
|
+
|
|
326
|
+
# return_type
|
|
327
|
+
return_type = opts[:debug_return_type] || 'CompletionResult'
|
|
328
|
+
|
|
329
|
+
# auth_names
|
|
330
|
+
auth_names = opts[:debug_auth_names] || ['fc']
|
|
331
|
+
|
|
332
|
+
new_options = opts.merge(
|
|
333
|
+
:operation => :"DefaultApi.create_knowledge_base_completion",
|
|
334
|
+
:header_params => header_params,
|
|
335
|
+
:query_params => query_params,
|
|
336
|
+
:form_params => form_params,
|
|
337
|
+
:body => post_body,
|
|
338
|
+
:auth_names => auth_names,
|
|
339
|
+
:return_type => return_type
|
|
340
|
+
)
|
|
341
|
+
|
|
342
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
343
|
+
if @api_client.config.debugging
|
|
344
|
+
@api_client.config.logger.debug "API called: DefaultApi#create_knowledge_base_completion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
345
|
+
end
|
|
346
|
+
return data, status_code, headers
|
|
347
|
+
end
|
|
348
|
+
|
|
280
349
|
# Delete a Recording
|
|
281
350
|
# @param recording_id [String] String that uniquely identifies this recording resource.
|
|
282
351
|
# @param [Hash] opts the optional parameters
|
|
@@ -2651,6 +2720,7 @@ module Freeclimb
|
|
|
2651
2720
|
# @param [Hash] opts the optional parameters
|
|
2652
2721
|
# @option opts [Boolean] :talk Only show Participants with the talk privilege.
|
|
2653
2722
|
# @option opts [Boolean] :listen Only show Participants with the listen privilege.
|
|
2723
|
+
# @option opts [Boolean] :dtmf_pass_through Only show Participants with the dtmfPassThrough privilege.
|
|
2654
2724
|
# @return [ConferenceParticipantList]
|
|
2655
2725
|
def list_participants(conference_id, opts = {})
|
|
2656
2726
|
data, _status_code, _headers = list_participants_with_http_info(conference_id, opts)
|
|
@@ -2662,6 +2732,7 @@ module Freeclimb
|
|
|
2662
2732
|
# @param [Hash] opts the optional parameters
|
|
2663
2733
|
# @option opts [Boolean] :talk Only show Participants with the talk privilege.
|
|
2664
2734
|
# @option opts [Boolean] :listen Only show Participants with the listen privilege.
|
|
2735
|
+
# @option opts [Boolean] :dtmf_pass_through Only show Participants with the dtmfPassThrough privilege.
|
|
2665
2736
|
# @return [Array<(ConferenceParticipantList, Integer, Hash)>] ConferenceParticipantList data, response status code and response headers
|
|
2666
2737
|
def list_participants_with_http_info(conference_id, opts = {})
|
|
2667
2738
|
if @api_client.config.debugging
|
|
@@ -2679,6 +2750,7 @@ module Freeclimb
|
|
|
2679
2750
|
query_params = opts[:query_params] || {}
|
|
2680
2751
|
query_params[:'talk'] = opts[:'talk'] if !opts[:'talk'].nil?
|
|
2681
2752
|
query_params[:'listen'] = opts[:'listen'] if !opts[:'listen'].nil?
|
|
2753
|
+
query_params[:'dtmfPassThrough'] = opts[:'dtmf_pass_through'] if !opts[:'dtmf_pass_through'].nil?
|
|
2682
2754
|
|
|
2683
2755
|
# header parameters
|
|
2684
2756
|
header_params = opts[:header_params] || {}
|