Resolve VCSWP-23198 (#54)

* Add new KnowledgeBase api code to SDK * Add changelog entry * Resolve dependabot alerts * Regenerate SDK after version and openapi spec file updates * Changes made to openapi spec * Comment out invalid method tests on all model test files * Update openapi spec in sdk * Resolve diff issues with commented out test * Skip invalid properties test
FreeClimbAPI · Oct 22, 2024 · de7d77c · de7d77c
1 parent 46eddb9
commit de7d77c
Show file tree

Hide file tree

Showing 92 changed files with 1,686 additions and 473 deletions.
diff --git a/.gitignore b/.gitignore
@@ -40,3 +40,4 @@ build/
 
 .DS_Store
 git_push.sh
+/node_modules
diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES
@@ -27,6 +27,8 @@ docs/CallResult.md
 docs/CallResultAllOf.md
 docs/CallStatus.md
 docs/Capabilities.md
+docs/CompletionRequest.md
+docs/CompletionResult.md
 docs/ConferenceList.md
 docs/ConferenceListAllOf.md
 docs/ConferenceParticipantList.md
@@ -177,6 +179,8 @@ lib/freeclimb/models/call_result.rb
 lib/freeclimb/models/call_result_all_of.rb
 lib/freeclimb/models/call_status.rb
 lib/freeclimb/models/capabilities.rb
+lib/freeclimb/models/completion_request.rb
+lib/freeclimb/models/completion_result.rb
 lib/freeclimb/models/conference_list.rb
 lib/freeclimb/models/conference_list_all_of.rb
 lib/freeclimb/models/conference_participant_list.rb
@@ -299,4 +303,104 @@ lib/freeclimb/models/update_conference_request_status.rb
 lib/freeclimb/version.rb
 spec/api_client_spec.rb
 spec/configuration_spec.rb
+spec/models/account_request_spec.rb
+spec/models/account_result_spec.rb
+spec/models/account_status_spec.rb
+spec/models/account_type_spec.rb
+spec/models/add_to_conference_spec.rb
+spec/models/answered_by_spec.rb
+spec/models/application_list_spec.rb
+spec/models/application_request_spec.rb
+spec/models/application_result_spec.rb
+spec/models/available_number_list_spec.rb
+spec/models/available_number_spec.rb
+spec/models/buy_incoming_number_request_spec.rb
+spec/models/call_direction_spec.rb
+spec/models/call_list_spec.rb
+spec/models/call_result_spec.rb
+spec/models/call_status_spec.rb
+spec/models/capabilities_spec.rb
+spec/models/completion_request_spec.rb
+spec/models/completion_result_spec.rb
+spec/models/conference_list_spec.rb
+spec/models/conference_participant_list_spec.rb
+spec/models/conference_participant_result_spec.rb
+spec/models/conference_result_spec.rb
+spec/models/conference_status_spec.rb
+spec/models/create_conference_request_spec.rb
+spec/models/create_conference_spec.rb
+spec/models/create_web_rtc_token_spec.rb
+spec/models/dequeue_spec.rb
+spec/models/enqueue_spec.rb
+spec/models/filter_logs_request_spec.rb
+spec/models/get_digits_spec.rb
+spec/models/get_speech_reason_spec.rb
+spec/models/get_speech_spec.rb
+spec/models/grammar_file_built_in_spec.rb
+spec/models/grammar_type_spec.rb
+spec/models/hangup_spec.rb
+spec/models/if_machine_spec.rb
+spec/models/incoming_number_list_spec.rb
+spec/models/incoming_number_request_spec.rb
+spec/models/incoming_number_result_spec.rb
+spec/models/language_spec.rb
+spec/models/log_level_spec.rb
+spec/models/log_list_spec.rb
+spec/models/log_result_spec.rb
+spec/models/machine_type_spec.rb
+spec/models/make_call_request_spec.rb
+spec/models/message_direction_spec.rb
+spec/models/message_request_spec.rb
+spec/models/message_result_spec.rb
+spec/models/message_status_spec.rb
+spec/models/messages_list_spec.rb
+spec/models/mutable_resource_model_spec.rb
+spec/models/out_dial_spec.rb
+spec/models/pagination_model_spec.rb
+spec/models/park_spec.rb
+spec/models/pause_spec.rb
+spec/models/percl_command_spec.rb
+spec/models/percl_script_spec.rb
+spec/models/play_beep_spec.rb
+spec/models/play_early_media_spec.rb
+spec/models/play_spec.rb
+spec/models/queue_list_spec.rb
+spec/models/queue_member_list_spec.rb
+spec/models/queue_member_spec.rb
+spec/models/queue_request_spec.rb
+spec/models/queue_result_spec.rb
+spec/models/queue_result_status_spec.rb
+spec/models/record_utterance_spec.rb
+spec/models/record_utterance_term_reason_spec.rb
+spec/models/recording_list_spec.rb
+spec/models/recording_result_spec.rb
+spec/models/redirect_spec.rb
+spec/models/reject_spec.rb
+spec/models/remove_from_conference_spec.rb
+spec/models/request_type_spec.rb
+spec/models/say_spec.rb
+spec/models/send_digits_spec.rb
+spec/models/set_listen_spec.rb
+spec/models/set_talk_spec.rb
+spec/models/sms_spec.rb
+spec/models/sms_ten_dlc_brand_spec.rb
+spec/models/sms_ten_dlc_brands_list_result_spec.rb
+spec/models/sms_ten_dlc_campaign_spec.rb
+spec/models/sms_ten_dlc_campaigns_list_result_spec.rb
+spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb
+spec/models/sms_ten_dlc_partner_campaign_spec.rb
+spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb
+spec/models/sms_toll_free_campaign_spec.rb
+spec/models/sms_toll_free_campaigns_list_result_spec.rb
+spec/models/start_record_call_spec.rb
+spec/models/terminate_conference_spec.rb
+spec/models/tfn_spec.rb
+spec/models/transcribe_utterance_all_of_record_spec.rb
+spec/models/transcribe_utterance_spec.rb
+spec/models/unpark_spec.rb
+spec/models/update_call_request_spec.rb
+spec/models/update_call_request_status_spec.rb
+spec/models/update_conference_participant_request_spec.rb
+spec/models/update_conference_request_spec.rb
+spec/models/update_conference_request_status_spec.rb
 spec/spec_helper.rb
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+<a name="4.8.0"></a>
+
+## [4.8.0] - 2024-10-08
+
+### Added
+
+- Add KnowledgeBase API to SDK
+
 <a name="4.7.0"></a>
 
 ## [4.7.0] - 2024-09-12

diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    freeclimb (4.6.1)
+    freeclimb (4.8.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.2)
+    activesupport (7.1.4.1)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -17,14 +17,14 @@ GEM
       minitest (>= 5.1)
       mutex_m
       tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.7)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crack (1.0.0)
       bigdecimal
@@ -34,18 +34,18 @@ GEM
     ethon (0.16.0)
       ffi (>= 1.15.0)
     facets (3.1.0)
-    factory_bot (6.4.6)
+    factory_bot (6.5.0)
       activesupport (>= 5.0.0)
-    ffi (1.16.3)
-    hashdiff (1.1.0)
-    i18n (1.14.4)
+    ffi (1.17.0-arm64-darwin)
+    hashdiff (1.1.1)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.6)
-    method_source (1.0.0)
-    minitest (5.22.3)
+    method_source (1.1.0)
+    minitest (5.25.1)
     mutex_m (0.2.0)
-    parallel (1.24.0)
-    parser (3.3.0.5)
+    parallel (1.26.3)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     pry (0.14.2)
@@ -56,21 +56,21 @@ GEM
       pry (>= 0.13, < 0.15)
     psych (5.1.2)
       stringio
-    public_suffix (5.0.5)
-    racc (1.7.3)
+    public_suffix (6.0.1)
+    racc (1.8.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    rexml (3.2.6)
+    rexml (3.3.8)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.1)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
@@ -83,13 +83,13 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.13.0)
-    stringio (3.1.0)
+    stringio (3.1.1)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (1.5.0)
-    webmock (3.23.0)
+    webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

diff --git a/README.md b/README.md
@@ -7,15 +7,15 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 4.7.0
+- Package version: 4.8.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
 
 ## Installation
 
 Add this to the Gemfile:
 
-    gem 'freeclimb', '~> 4.7.0'
+    gem 'freeclimb', '~> 4.8.0'
 
 and run from your terminal
 
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./freeclimb-4.7.0.gem
+gem install ./freeclimb-4.8.0.gem
 ```
-(for development, run `gem install --dev ./freeclimb-4.7.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./freeclimb-4.8.0.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -103,6 +103,7 @@ Class | Method | HTTP request | Description
 *Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
 *Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
 *Freeclimb::DefaultApi* | [**create_an_application**](docs/DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application
+*Freeclimb::DefaultApi* | [**create_knowledge_base_completion**](docs/DefaultApi.md#create_knowledge_base_completion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base
 *Freeclimb::DefaultApi* | [**delete_a_recording**](docs/DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
 *Freeclimb::DefaultApi* | [**delete_an_application**](docs/DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
 *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
  - [Freeclimb::CallResultAllOf](docs/CallResultAllOf.md)
  - [Freeclimb::CallStatus](docs/CallStatus.md)
  - [Freeclimb::Capabilities](docs/Capabilities.md)
+ - [Freeclimb::CompletionRequest](docs/CompletionRequest.md)
+ - [Freeclimb::CompletionResult](docs/CompletionResult.md)
  - [Freeclimb::ConferenceList](docs/ConferenceList.md)
  - [Freeclimb::ConferenceListAllOf](docs/ConferenceListAllOf.md)
  - [Freeclimb::ConferenceParticipantList](docs/ConferenceParticipantList.md)

diff --git a/docs/CompletionRequest.md b/docs/CompletionRequest.md
@@ -0,0 +1,18 @@
+# Freeclimb::CompletionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **query** | **String** | Question to ask the Knowledge Base |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::CompletionRequest.new(
+  query: null
+)
+```
+
diff --git a/docs/CompletionResult.md b/docs/CompletionResult.md
@@ -0,0 +1,20 @@
+# Freeclimb::CompletionResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response** | **String** | The generative response from the KnowledgeBase |  |
+| **status** | **String** | Completion result status. Possible values: success, no_context |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::CompletionResult.new(
+  response: null,
+  status: null
+)
+```
+
Original file line number	Diff line number	Diff line change
Expand Up		@@ -40,3 +40,4 @@ build/

		.DS_Store
		git_push.sh
		/node_modules