[PLAT-5961] Include new flag to create stream key with search session (#153)

* Update client with search session flag

* v0.24.0

Author: danschultz

api.ts

@@ -2030,11 +2030,29 @@ export interface CreateStreamKeyRequestDataAttributes {
    */
   expiry?: number;
   /**
-   * Whether to exclude non-visible items in the view
+   * Whether to exclude non-visible items in the view.
    * @type {boolean}
    * @memberof CreateStreamKeyRequestDataAttributes
    */
   excludePrunedItems?: boolean;
+  /**
+   * An optional supplied ID specifying the `scene-view-state` to initialize `scene-view`s created using this `stream-key` to. Mutually exclusive with `sceneViewStateId`.
+   * @type {string}
+   * @memberof CreateStreamKeyRequestDataAttributes
+   */
+  sceneViewStateSuppliedId?: string;
+  /**
+   * An optional ID specifying the `scene-view-state` to initialize `scene-view`s created using this `stream-key` to. Mutually exclusive with `sceneViewStateSuppliedId`.
+   * @type {string}
+   * @memberof CreateStreamKeyRequestDataAttributes
+   */
+  sceneViewStateId?: string;
+  /**
+   * Optionally enables or disables the creation of a search session for the view.
+   * @type {boolean}
+   * @memberof CreateStreamKeyRequestDataAttributes
+   */
+  withSearchSession?: boolean;
 }
 /**
  *
@@ -4236,29 +4254,13 @@ export interface PropertyEntryList {
  * @interface PropertyKeyType
  */
 export interface PropertyKeyType {
-  /**
-   * The key category
-   * @type {string}
-   * @memberof PropertyKeyType
-   */
-  category: PropertyKeyTypeCategoryEnum;
   /**
    *
    * @type {string}
    * @memberof PropertyKeyType
    */
   name: string;
 }
-
-export const PropertyKeyTypeCategoryEnum = {
-  Vendor: 'vendor',
-  Vertex: 'vertex',
-  User: 'user',
-} as const;
-
-export type PropertyKeyTypeCategoryEnum =
-  (typeof PropertyKeyTypeCategoryEnum)[keyof typeof PropertyKeyTypeCategoryEnum];
-
 /**
  *
  * @export
@@ -6341,6 +6343,18 @@ export interface StreamKeyDataAttributes {
    * @memberof StreamKeyDataAttributes
    */
   excludePrunedItems?: boolean;
+  /**
+   *
+   * @type {string}
+   * @memberof StreamKeyDataAttributes
+   */
+  sceneViewStateSuppliedId?: string;
+  /**
+   * ID of the resource.
+   * @type {string}
+   * @memberof StreamKeyDataAttributes
+   */
+  sceneViewStateId?: string;
 }
 /**
  *

client/version.ts

@@ -1 +1 @@
-export const version = '0.23.4';
+export const version = '0.24.0';

package.json

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

spec.yml

@@ -8311,20 +8311,6 @@ components:
         maxLength: 36
         type: string
       style: form
-    PropertyEntriesCategoryFilter:
-      description: The key categories to filter by
-      explode: true
-      in: query
-      name: filter[key.category]
-      required: false
-      schema:
-        description: The key category
-        enum:
-          - vendor
-          - vertex
-          - user
-        type: string
-      style: form
     SuppliedIdFilter:
       description: Comma-separated list of supplied IDs to filter on.
       explode: true
@@ -11314,13 +11300,6 @@ components:
       type: object
     PropertyKeyType:
       properties:
-        category:
-          description: The key category
-          enum:
-            - vendor
-            - vertex
-            - user
-          type: string
         name:
           example: some-string
           maxLength: 1024
@@ -12962,7 +12941,31 @@ components:
           minimum: 1
           type: integer
         excludePrunedItems:
-          description: Whether to exclude non-visible items in the view
+          description: Whether to exclude non-visible items in the view.
+          example: true
+          type: boolean
+        sceneViewStateSuppliedId:
+          description:
+            An optional supplied ID specifying the `scene-view-state` to
+            initialize `scene-view`s created using this `stream-key` to. Mutually
+            exclusive with `sceneViewStateId`.
+          example: some-string
+          maxLength: 1024
+          minLength: 1
+          type: string
+        sceneViewStateId:
+          description:
+            An optional ID specifying the `scene-view-state` to initialize
+            `scene-view`s created using this `stream-key` to. Mutually exclusive with
+            `sceneViewStateSuppliedId`.
+          example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3
+          format: uuid
+          maxLength: 36
+          type: string
+        withSearchSession:
+          description:
+            Optionally enables or disables the creation of a search session
+            for the view.
           example: true
           type: boolean
       type: object
@@ -13971,6 +13974,17 @@ components:
         excludePrunedItems:
           example: true
           type: boolean
+        sceneViewStateSuppliedId:
+          example: some-string
+          maxLength: 1024
+          minLength: 1
+          type: string
+        sceneViewStateId:
+          description: ID of the resource.
+          example: f79d4760-0b71-44e4-ad0b-22743fdd4ca3
+          format: uuid
+          maxLength: 36
+          type: string
       required:
         - created
         - expiry