Resolve VCSWP-19258 (Introduce application ID filtering on list call method for java sdk) (#35)

* Introduce application ID filtering on list call method for java sdk

* Edit README file so that git diff is not too large

* Edit changelog entry for correct date

* Remove hasApplication boolean value from listCalls

Author: amahadaya

.openapi-generator/FILES

@@ -286,3 +286,4 @@ src/main/java/com/github/freeclimbapi/auth/ApiKeyAuth.java
 src/main/java/com/github/freeclimbapi/auth/Authentication.java
 src/main/java/com/github/freeclimbapi/auth/HttpBasicAuth.java
 src/main/java/com/github/freeclimbapi/auth/HttpBearerAuth.java
+src/test/java/com/github/freeclimbapi/DefaultApiTest.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.3.0"></a>
+
+## [5.3.0] 2023-04-27
+
+### Changed
+
+- Introduce application ID filtering for list calls method
+
 <a name="5.2.0"></a>
 
 ## [5.2.0] 2023-04-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.2.0</version>
+  <version>5.3.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.2.0"
+     implementation "com.github.freeclimbapi:freeclimb-java-client:5.3.0"
   }
 ```
 
@@ -70,7 +70,7 @@ mvn clean package
 
 Then manually install the following JARs:
 
-* `target/freeclimb-java-client-5.2.0.jar`
+* `target/freeclimb-java-client-5.3.0.jar`
 * `target/lib/*.jar`
 
 ## Getting Started
@@ -328,6 +328,7 @@ Authentication schemes defined for the API:
 
 - **Type**: HTTP basic authentication
 
+
 <a name="documentation-for-verify-request-signature"></a>
 
 ## Documentation for verifying request signature
@@ -359,11 +360,12 @@ Authentication schemes defined for the API:
         }
      }
   ```
-
+  
 ## Recommendation
 
 It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.
 
 ## Author
 
 [email protected]
+

build.gradle

@@ -4,7 +4,7 @@ apply plugin: 'java'
 apply plugin: 'com.diffplug.spotless'
 
 group = 'com.github.freeclimbapi'
-version = '5.2.0'
+version = '5.3.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.2.0",
+    version := "5.3.0",
     scalaVersion := "2.11.4",
     scalacOptions ++= Seq("-feature"),
     javacOptions in compile ++= Seq("-Xlint:deprecation"),

docs/DefaultApi.md

@@ -2012,7 +2012,7 @@ Name | Type | Description  | Notes
 
 <a name="listCalls"></a>
 # **listCalls**
-> CallList listCalls(active, to, from, status, startTime, endTime, parentCallId)
+> CallList listCalls(active, to, from, status, startTime, endTime, parentCallId, applicationId)
 
 List Calls
 
@@ -2052,8 +2052,10 @@ public class Example {
 
     String parentCallId = "parentCallId_example"; // String | Only show Calls spawned by the call with this ID.
 
+    List<String> applicationId = Arrays.asList(); // List<String> | Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.
+    
     try {
-      CallList result = apiInstance.listCalls(active, to, from, status, startTime, endTime, parentCallId);
+      CallList result = apiInstance.listCalls(active, to, from, status, startTime, endTime, parentCallId, applicationId);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling DefaultApi#listCalls");
@@ -2077,6 +2079,7 @@ Name | Type | Description  | Notes
  **startTime** | **String**| Only show Calls that started at or after this time, given as YYYY-MM-DD hh:mm:ss. | [optional]
  **endTime** | **String**| Only show Calls that ended at or before this time, given as YYYY-MM- DD hh:mm:ss. | [optional]
  **parentCallId** | **String**| Only show Calls spawned by the call with this ID. | [optional]
+ **applicationId** | [**List&lt;String&gt;**](String.md)| Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications. | [optional]
 
 
 ### Return type

openapi.json

@@ -85,28 +85,33 @@
         "type": "string",
         "enum": ["closed", "suspended", "active"],
         "x-enum-varnames": ["CLOSED", "SUSPENDED", "ACTIVE"],
-        "description": "The status of this account. It is one of: active, suspended, or closed."
+        "description": "The status of this account. It is one of: active, suspended, or closed.",
+        "nullable": true
       },
       "AccountType": {
         "type": "string",
         "description": "The type of this account. It is one of: trial or full.",
         "enum": ["trial", "full"],
-        "x-enum-varnames": ["TRIAL", "FULL"]
+        "x-enum-varnames": ["TRIAL", "FULL"],
+        "nullable": true
       },
       "AnsweredBy": {
         "type": "string",
+        "nullable": true,
         "enum": ["human", "machine"],
         "x-enum-varnames": ["HUMAN", "MACHINE"],
         "description": "If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise."
       },
       "CallDirection": {
         "type": "string",
+        "nullable": true,
         "enum": ["inbound", "outboundAPI", "outboundDial"],
         "x-enum-varnames": ["INBOUND", "OUTBOUND_API", "OUTBOUND_DIAL"],
         "description": "Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API,  `outboundDial` for Calls initiated by the `OutDial` PerCL command."
       },
       "CallStatus": {
         "type": "string",
+        "nullable": true,
         "enum": [
           "queued",
           "ringing",
@@ -131,6 +136,7 @@
       },
       "ConferenceStatus": {
         "type": "string",
+        "nullable": true,
         "enum": ["empty", "populated", "inProgress", "terminated"],
         "x-enum-varnames": ["EMPTY", "POPULATED", "IN_PROGRESS", "TERMINATED"],
         "description": "The status of the Conference. One of: creating, empty, populated, inProgress, or terminated."
@@ -194,6 +200,7 @@
       "GrammarType": {
         "type": "string",
         "enum": ["URL", "BUILTIN"],
+        "nullable": true,
         "x-enum-varnames": ["URL", "BUILT_IN"],
         "description": "The grammar file type to use for speech recognition. A value of 'URL' indicates the grammarFile attribute specifies a URL that points to the grammar file. A value of `BUILTIN` indicates the grammarFile attribute specifies the name of one of the platform built-in grammar files."
       },
@@ -265,6 +272,7 @@
       "LogLevel": {
         "type": "string",
         "enum": ["info", "warning", "error"],
+        "nullable": true,
         "x-enum-varnames": ["INFO", "WARNING", "ERROR"],
         "description": "Level of the log. Possible values are info, warning, and error."
       },
@@ -280,6 +288,7 @@
       },
       "MessageStatus": {
         "type": "string",
+        "nullable": true,
         "description": "Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown",
         "enum": [
           "new",
@@ -310,9 +319,10 @@
       },
       "PlayBeep": {
         "type": "string",
+        "nullable": true,
         "enum": ["always", "never", "entryOnly", "exitOnly"],
         "x-enum-varnames": ["ALWAYS", "NEVER", "ENTRY_ONLY", "EXIT_ONLY"],
-        "description": "Controls when a beep is played. Valid values: `always`, `never`, `entryOnly`, `exitOnly`.",
+        "description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` ",
         "default": "always",
         "x-enum-default-attr": "ALWAYS"
       },
@@ -520,7 +530,6 @@
                 "type": "boolean"
               },
               "playBeep": {
-                "description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` ",
                 "$ref": "#/components/schemas/PlayBeep"
               },
               "record": {
@@ -653,8 +662,7 @@
                 "format": "uri"
               },
               "grammarType": {
-                "$ref": "#/components/schemas/GrammarType",
-                "nullable": true
+                "$ref": "#/components/schemas/GrammarType"
               },
               "grammarFile": {
                 "description": "The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL.",
@@ -1297,12 +1305,10 @@
                 "nullable": true
               },
               "type": {
-                "$ref": "#/components/schemas/AccountType",
-                "nullable": true
+                "$ref": "#/components/schemas/AccountType"
               },
               "status": {
-                "$ref": "#/components/schemas/AccountStatus",
-                "nullable": true
+                "$ref": "#/components/schemas/AccountStatus"
               },
               "subresourceUris": {
                 "type": "object",
@@ -1648,8 +1654,7 @@
                 "nullable": true
               },
               "callStatus": {
-                "$ref": "#/components/schemas/CallStatus",
-                "nullable": true
+                "$ref": "#/components/schemas/CallStatus"
               },
               "startTime": {
                 "type": "string",
@@ -1677,12 +1682,10 @@
                 "nullable": true
               },
               "direction": {
-                "$ref": "#/components/schemas/CallDirection",
-                "nullable": true
+                "$ref": "#/components/schemas/CallDirection"
               },
               "answeredBy": {
-                "$ref": "#/components/schemas/AnsweredBy",
-                "nullable": true
+                "$ref": "#/components/schemas/AnsweredBy"
               },
               "subresourceUris": {
                 "type": "object",
@@ -1834,9 +1837,7 @@
             "nullable": true
           },
           "level": {
-            "$ref": "#/components/schemas/LogLevel",
-
-            "nullable": true
+            "$ref": "#/components/schemas/LogLevel"
           },
           "requestId": {
             "type": "string",
@@ -1909,17 +1910,15 @@
               },
               "playBeep": {
                 "$ref": "#/components/schemas/PlayBeep",
-                "description": "Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always.",
-                "nullable": true
+                "description": "Setting that controls when a beep is played. One of: always, never, entryOnly, exitOnly. Defaults to always."
               },
               "record": {
                 "type": "boolean",
                 "description": "Flag indicating whether recording is enabled for this Conference.",
                 "nullable": true
               },
               "status": {
-                "$ref": "#/components/schemas/ConferenceStatus",
-                "nullable": true
+                "$ref": "#/components/schemas/ConferenceStatus"
               },
               "waitUrl": {
                 "type": "string",
@@ -2036,8 +2035,7 @@
                 "nullable": true
               },
               "status": {
-                "$ref": "#/components/schemas/MessageStatus",
-                "nullable": true
+                "$ref": "#/components/schemas/MessageStatus"
               },
               "from": {
                 "type": "string",
@@ -3066,6 +3064,21 @@
               "type": "string"
             }
           },
+          {
+            "name": "applicationId",
+            "in": "query",
+            "description": "Only show calls belonging to the given applicationId. This parameter can be repeated to return calls from multiple Applications.",
+            "explode": true,
+            "required": false,
+            "schema": {
+              "type": "array",
+              "maxItems": 16,
+              "items": {
+                "type": "string",
+                "pattern": "^AP[0-9a-fA-F]{40}$"
+              }
+            }
+          },
           {
             "$ref": "#/components/parameters/AccountId"
           }

pom.xml

@@ -5,7 +5,7 @@
     <artifactId>freeclimb-java-client</artifactId>
     <packaging>jar</packaging>
     <name>freeclimb-java-client</name>
-    <version>5.2.0</version>
+    <version>5.3.0</version>
     <url>https://github.com/freeclimbapi/java-sdk</url>
     <description>FreeClimb Java Client</description>
     <scm>

src/main/java/com/github/freeclimbapi/ApiClient.java

@@ -131,7 +131,7 @@ private void init() {
         json = new JSON();
 
         // Set default User-Agent.
-        setUserAgent("OpenAPI-Generator/5.2.0/java");
+        setUserAgent("OpenAPI-Generator/5.3.0/java");
 
         authentications = new HashMap<String, Authentication>();
     }