[PLAT-8772] Including updated filter expressions for scenes

api.ts

@@ -33849,8 +33849,8 @@ export const ScenesApiAxiosParamCreator = function (
      * Get `scenes`.
      * @param {string} [pageCursor] The cursor for the next page of items.
      * @param {number} [pageSize] The number of items to return.
-     * @param {string} [filterName] Comma-separated list of names to filter on.
-     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
+     * @param {FilterExpression} [filterName] A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.
+     * @param {FilterExpression} [filterSuppliedId] A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.
      * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
      * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
      * @param {string} [filterSceneItemsSourcePartRevision] Comma-separated list of scene-item source part revision IDs to filter on.
@@ -33862,8 +33862,8 @@ export const ScenesApiAxiosParamCreator = function (
     getScenes: async (
       pageCursor?: string,
       pageSize?: number,
-      filterName?: string,
-      filterSuppliedId?: string,
+      filterName?: FilterExpression,
+      filterSuppliedId?: FilterExpression,
       fieldsScene?: string,
       filterMetadata?: { [key: string]: string },
       filterSceneItemsSourcePartRevision?: string,
@@ -34190,8 +34190,8 @@ export const ScenesApiFp = function (configuration?: Configuration) {
      * Get `scenes`.
      * @param {string} [pageCursor] The cursor for the next page of items.
      * @param {number} [pageSize] The number of items to return.
-     * @param {string} [filterName] Comma-separated list of names to filter on.
-     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
+     * @param {FilterExpression} [filterName] A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.
+     * @param {FilterExpression} [filterSuppliedId] A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.
      * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
      * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
      * @param {string} [filterSceneItemsSourcePartRevision] Comma-separated list of scene-item source part revision IDs to filter on.
@@ -34203,8 +34203,8 @@ export const ScenesApiFp = function (configuration?: Configuration) {
     async getScenes(
       pageCursor?: string,
       pageSize?: number,
-      filterName?: string,
-      filterSuppliedId?: string,
+      filterName?: FilterExpression,
+      filterSuppliedId?: FilterExpression,
       fieldsScene?: string,
       filterMetadata?: { [key: string]: string },
       filterSceneItemsSourcePartRevision?: string,
@@ -34358,8 +34358,8 @@ export const ScenesApiFactory = function (
      * Get `scenes`.
      * @param {string} [pageCursor] The cursor for the next page of items.
      * @param {number} [pageSize] The number of items to return.
-     * @param {string} [filterName] Comma-separated list of names to filter on.
-     * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
+     * @param {FilterExpression} [filterName] A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.
+     * @param {FilterExpression} [filterSuppliedId] A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.
      * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
      * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
      * @param {string} [filterSceneItemsSourcePartRevision] Comma-separated list of scene-item source part revision IDs to filter on.
@@ -34371,8 +34371,8 @@ export const ScenesApiFactory = function (
     getScenes(
       pageCursor?: string,
       pageSize?: number,
-      filterName?: string,
-      filterSuppliedId?: string,
+      filterName?: FilterExpression,
+      filterSuppliedId?: FilterExpression,
       fieldsScene?: string,
       filterMetadata?: { [key: string]: string },
       filterSceneItemsSourcePartRevision?: string,
@@ -34516,18 +34516,18 @@ export interface ScenesApiGetScenesRequest {
   readonly pageSize?: number;
 
   /**
-   * Comma-separated list of names to filter on.
-   * @type {string}
+   * A filter for the `name`. The canonical form is a filter expression such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2` exact-match CSV form is also accepted for backwards compatibility.
+   * @type {FilterExpression}
    * @memberof ScenesApiGetScenes
    */
-  readonly filterName?: string;
+  readonly filterName?: FilterExpression;
 
   /**
-   * Comma-separated list of supplied IDs to filter on.
-   * @type {string}
+   * A filter for the `suppliedId`. The canonical form is a filter expression such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for backwards compatibility.
+   * @type {FilterExpression}
    * @memberof ScenesApiGetScenes
    */
-  readonly filterSuppliedId?: string;
+  readonly filterSuppliedId?: FilterExpression;
 
   /**
    * Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.

client/version.ts

@@ -1 +1 @@
-export const version = '0.43.0';
+export const version = '0.44.0';

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.43.0",
+  "version": "0.44.0",
   "description": "The Vertex REST API client for Node.js.",
   "license": "MIT",
   "author": "Vertex Developers <support@vertex3d.com> (https://developer.vertex3d.com)",

spec.yml

@@ -8089,25 +8089,28 @@ paths:
             minimum: 1
             type: integer
           style: form
-        - description: Comma-separated list of names to filter on.
+        - description:
+            A filter for the `name`. The canonical form is a filter expression
+            such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2`
+            exact-match CSV form is also accepted for backwards compatibility.
           explode: true
           in: query
           name: filter[name]
           required: false
           schema:
-            example: some-name-1,some-name-2
-            maxLength: 1024
-            type: string
+            $ref: '#/components/schemas/FilterExpression'
           style: form
-        - description: Comma-separated list of supplied IDs to filter on.
+        - description:
+            A filter for the `suppliedId`. The canonical form is a filter
+            expression such as `filter[suppliedId][contains]=...`. The deprecated legacy
+            `filter[suppliedId]=id-1,id-2` exact-match CSV form is also accepted for
+            backwards compatibility.
           explode: true
           in: query
           name: filter[suppliedId]
           required: false
           schema:
-            example: some-id-1,some-id-2
-            maxLength: 1024
-            type: string
+            $ref: '#/components/schemas/FilterExpression'
           style: form
         - description:
             Comma-separated list of fields to return in response. An empty
@@ -12323,6 +12326,18 @@ components:
       schema:
         $ref: '#/components/schemas/FilterExpression'
       style: form
+    SceneNameFilterExpression:
+      description:
+        A filter for the `name`. The canonical form is a filter expression
+        such as `filter[name][contains]=...`. The deprecated legacy `filter[name]=name-1,name-2`
+        exact-match CSV form is also accepted for backwards compatibility.
+      explode: true
+      in: query
+      name: filter[name]
+      required: false
+      schema:
+        $ref: '#/components/schemas/FilterExpression'
+      style: form
     FileIdFilterExpression:
       description: A filter expression for the `fileId` to filter on.
       explode: true
@@ -12332,6 +12347,18 @@ components:
       schema:
         $ref: '#/components/schemas/FilterExpression'
       style: form
+    SceneSuppliedIdFilterExpression:
+      description:
+        A filter for the `suppliedId`. The canonical form is a filter expression
+        such as `filter[suppliedId][contains]=...`. The deprecated legacy `filter[suppliedId]=id-1,id-2`
+        exact-match CSV form is also accepted for backwards compatibility.
+      explode: true
+      in: query
+      name: filter[suppliedId]
+      required: false
+      schema:
+        $ref: '#/components/schemas/FilterExpression'
+      style: form
     FileSuppliedIdFilterExpression:
       description:
         A filter for the `suppliedId`. The canonical form is a filter expression