Resolve VCSWP-23198 (#57)

* Add new KnowledgeBase api code to SDK

* Update openapi spec

* Add changelog entry

* Resolve dependabot alerts

* Regenerate SDK after version and openapi spec file updates

* Changes made to openapi spec

* Update openapi spec in sdk

* Add edits to api doc

Author: amahadaya

.openapi-generator/FILES

@@ -28,6 +28,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
@@ -185,6 +187,8 @@ src/main/java/com/github/freeclimbapi/CallResult.java
 src/main/java/com/github/freeclimbapi/CallResultAllOf.java
 src/main/java/com/github/freeclimbapi/CallStatus.java
 src/main/java/com/github/freeclimbapi/Capabilities.java
+src/main/java/com/github/freeclimbapi/CompletionRequest.java
+src/main/java/com/github/freeclimbapi/CompletionResult.java
 src/main/java/com/github/freeclimbapi/ConferenceList.java
 src/main/java/com/github/freeclimbapi/ConferenceListAllOf.java
 src/main/java/com/github/freeclimbapi/ConferenceParticipantList.java

CHANGELOG.md

@@ -9,6 +9,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+<a name="5.8.0"></a>
+
+## [5.8.0] - 2024-10-08
+
+### Added
+
+- Add KnowledgeBase API to SDK
+
 <a name="5.7.0"></a>
 
 ## [5.7.0] - 2024-09-03

README.md

@@ -40,7 +40,7 @@ Add this dependency to your project's POM:
 <dependency>
   <groupId>com.github.freeclimbapi</groupId>
   <artifactId>freeclimb-java-client</artifactId>
-  <version>5.7.0</version>
+  <version>5.8.0</version>
   <scope>compile</scope>
 </dependency>
 ```
@@ -56,7 +56,7 @@ Add this dependency to your project's build file:
   }
 
   dependencies {
-     implementation "com.github.freeclimbapi:freeclimb-java-client:5.7.0"
+     implementation "com.github.freeclimbapi:freeclimb-java-client:5.8.0"
      implementation("com.squareup.okhttp3:okhttp:4.9.3")
      implementation("com.squareup.okhttp3:logging-interceptor:4.9.3")
   }
@@ -72,7 +72,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/freeclimb-java-client-5.7.0.jar`
+* `target/freeclimb-java-client-5.8.0.jar`
 * `target/lib/*.jar`
 
 ## Getting Started
@@ -147,6 +147,7 @@ Class | Method | HTTP request | Description
 *DefaultApi* | [**createAConference**](docs/DefaultApi.md#createAConference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
 *DefaultApi* | [**createAQueue**](docs/DefaultApi.md#createAQueue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
 *DefaultApi* | [**createAnApplication**](docs/DefaultApi.md#createAnApplication) | **POST** /Accounts/{accountId}/Applications | Create an application
+*DefaultApi* | [**createKnowledgeBaseCompletion**](docs/DefaultApi.md#createKnowledgeBaseCompletion) | **POST** /Accounts/{accountId}/KnowledgeBases/{knowledgeBaseId}/Completion | Query the knowledge base
 *DefaultApi* | [**deleteARecording**](docs/DefaultApi.md#deleteARecording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
 *DefaultApi* | [**deleteAnApplication**](docs/DefaultApi.md#deleteAnApplication) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
 *DefaultApi* | [**deleteAnIncomingNumber**](docs/DefaultApi.md#deleteAnIncomingNumber) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
@@ -227,6 +228,8 @@ Class | Method | HTTP request | Description
  - [CallResultAllOf](docs/CallResultAllOf.md)
  - [CallStatus](docs/CallStatus.md)
  - [Capabilities](docs/Capabilities.md)
+ - [CompletionRequest](docs/CompletionRequest.md)
+ - [CompletionResult](docs/CompletionResult.md)
  - [ConferenceList](docs/ConferenceList.md)
  - [ConferenceListAllOf](docs/ConferenceListAllOf.md)
  - [ConferenceParticipantList](docs/ConferenceParticipantList.md)

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'com.github.freeclimbapi'
-version = '5.7.0'
+version = '5.8.0'
 
 buildscript {
     repositories {

build.sbt

@@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
   settings(
     organization := "com.github.freeclimbapi",
     name := "freeclimb-java-client",
-    version := "5.7.0",
+    version := "5.8.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/CompletionRequest.md

@@ -0,0 +1,13 @@
+
+
+# CompletionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**query** | **String** | Question to ask the Knowledge Base | 
+
+
+

docs/CompletionResult.md

@@ -0,0 +1,23 @@
+
+
+# CompletionResult
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**response** | **String** | The generative response from the KnowledgeBase | 
+**status** | [**StatusEnum**](#StatusEnum) | Completion result status. Possible values: success, no_context | 
+
+
+
+## Enum: StatusEnum
+
+Name | Value
+---- | -----
+SUCCESS | "success"
+NO_CONTEXT | "no_context"
+
+
+