@vertexvis/api-client-node 0.20.4 → 0.20.6

package/dist/cjs/api.d.ts

@@ -1083,10 +1083,10 @@ export interface CreatePartRequestData {
     attributes: CreatePartRequestDataAttributes;
     /**
      *
-     * @type {CreateGeometrySetRequestDataRelationships}
+     * @type {CreatePartRequestDataRelationships}
      * @memberof CreatePartRequestData
      */
-    relationships?: CreateGeometrySetRequestDataRelationships;
+    relationships?: CreatePartRequestDataRelationships;
 }
 /**
  *
@@ -1114,11 +1114,11 @@ export interface CreatePartRequestDataAttributes {
     indexMetadata?: boolean;
     /**
      * Additional metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof CreatePartRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
     /**
      * Name to be used for the root part.
@@ -1145,6 +1145,19 @@ export interface CreatePartRequestDataAttributes {
      */
     suppliedInstanceIdKey?: string;
 }
+/**
+ *
+ * @export
+ * @interface CreatePartRequestDataRelationships
+ */
+export interface CreatePartRequestDataRelationships {
+    /**
+     *
+     * @type {FileRelationship | PartAssemblyRelationship}
+     * @memberof CreatePartRequestDataRelationships
+     */
+    source: FileRelationship | PartAssemblyRelationship;
+}
 /**
  *
  * @export
@@ -1366,11 +1379,11 @@ export interface CreateSceneItemRequestDataAttributes {
     visible?: boolean;
     /**
      * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof CreateSceneItemRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
 }
 /**
@@ -1542,6 +1555,12 @@ export interface CreateSceneViewRequestDataAttributes {
      * @memberof CreateSceneViewRequestDataAttributes
      */
     crossSectioning?: CrossSectioning | null;
+    /**
+     * Whether to exclude non-visible items in the view
+     * @type {boolean}
+     * @memberof CreateSceneViewRequestDataAttributes
+     */
+    excludePrunedItems?: boolean;
 }
 /**
  *
@@ -1670,6 +1689,12 @@ export interface CreateStreamKeyRequestDataAttributes {
      * @memberof CreateStreamKeyRequestDataAttributes
      */
     expiry?: number;
+    /**
+     * Whether to exclude non-visible items in the view
+     * @type {boolean}
+     * @memberof CreateStreamKeyRequestDataAttributes
+     */
+    excludePrunedItems?: boolean;
 }
 /**
  *
@@ -2596,6 +2621,25 @@ export interface Matrix4Nullable {
      */
     r3: Vector4;
 }
+/**
+ *
+ * @export
+ * @interface MetadataDateType
+ */
+export interface MetadataDateType {
+    /**
+     * Type of metadata value.
+     * @type {string}
+     * @memberof MetadataDateType
+     */
+    type: string;
+    /**
+     * A date value.
+     * @type {string}
+     * @memberof MetadataDateType
+     */
+    value: string;
+}
 /**
  *
  * @export
@@ -2615,6 +2659,25 @@ export interface MetadataFloatType {
      */
     value: number;
 }
+/**
+ *
+ * @export
+ * @interface MetadataLongType
+ */
+export interface MetadataLongType {
+    /**
+     * Type of metadata value.
+     * @type {string}
+     * @memberof MetadataLongType
+     */
+    type: string;
+    /**
+     * A numerical long value.
+     * @type {number}
+     * @memberof MetadataLongType
+     */
+    value: number;
+}
 /**
  *
  * @export
@@ -2786,6 +2849,40 @@ export interface Part {
         [key: string]: Link;
     };
 }
+/**
+ * Create Part Assembly
+ * @export
+ * @interface PartAssemblyRelationship
+ */
+export interface PartAssemblyRelationship {
+    /**
+     *
+     * @type {PartAssemblyRelationshipData}
+     * @memberof PartAssemblyRelationship
+     */
+    data: PartAssemblyRelationshipData;
+}
+/**
+ *
+ * @export
+ * @interface PartAssemblyRelationshipData
+ */
+export interface PartAssemblyRelationshipData {
+    /**
+     *
+     * @type {Array<PartRevisionInstance>}
+     * @memberof PartAssemblyRelationshipData
+     */
+    children: Array<PartRevisionInstance>;
+    /**
+     * Additional metadata about the `part` and/or `part-revision`.
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
+     * @memberof PartAssemblyRelationshipData
+     */
+    metadata?: {
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
+    };
+}
 /**
  *
  * @export
@@ -3004,11 +3101,11 @@ export interface PartRevisionDataAttributes {
     created?: string;
     /**
      *
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof PartRevisionDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
     /**
      *
@@ -3036,6 +3133,37 @@ export interface PartRevisionDataRelationships {
      */
     part?: PartRelationshipData;
 }
+/**
+ * A reference to an existing PartRevision. Specify one and only one of referenceId or suppliedReferenceId to refer to a revision.
+ * @export
+ * @interface PartRevisionInstance
+ */
+export interface PartRevisionInstance {
+    /**
+     * A 0-based index used for defining a consistent ordering for children of an assembly
+     * @type {number}
+     * @memberof PartRevisionInstance
+     */
+    ordinal: number;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof PartRevisionInstance
+     */
+    revisionId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartRevisionInstance
+     */
+    suppliedRevisionId?: string;
+    /**
+     *
+     * @type {Matrix4}
+     * @memberof PartRevisionInstance
+     */
+    transform?: Matrix4;
+}
 /**
  *
  * @export
@@ -3119,6 +3247,12 @@ export interface PerspectiveCamera {
      * @memberof PerspectiveCamera
      */
     up: Vector3;
+    /**
+     * A numerical floating-point value representing the field of view
+     * @type {number}
+     * @memberof PerspectiveCamera
+     */
+    fovY?: number;
 }
 /**
  * 2D point.
@@ -3740,11 +3874,11 @@ export interface SceneItemDataAttributes {
     materialOverride?: ColorMaterial;
     /**
      *
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof SceneItemDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
     /**
      *
@@ -4148,6 +4282,12 @@ export interface SceneViewDataAttributes {
      * @memberof SceneViewDataAttributes
      */
     worldOrientation?: Orientation;
+    /**
+     * Whether to exclude non-visible items in the view
+     * @type {boolean}
+     * @memberof SceneViewDataAttributes
+     */
+    excludePrunedItems?: boolean;
 }
 /**
  *
@@ -4437,12 +4577,6 @@ export interface SelectOperation {
      * @memberof SelectOperation
      */
     type: SelectOperationTypeEnum;
-    /**
-     *
-     * @type {ColorMaterial}
-     * @memberof SelectOperation
-     */
-    material: ColorMaterial;
 }
 export declare const SelectOperationTypeEnum: {
     readonly Select: "select";
@@ -4532,6 +4666,12 @@ export interface StreamKeyDataAttributes {
      * @memberof StreamKeyDataAttributes
      */
     created: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof StreamKeyDataAttributes
+     */
+    excludePrunedItems?: boolean;
 }
 /**
  *
@@ -4790,11 +4930,11 @@ export interface UpdatePartRevisionRequestData {
 export interface UpdatePartRevisionRequestDataAttributes {
     /**
      * Metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof UpdatePartRevisionRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
     /**
      * Whether or not to index metadata in the part file when sending a file relationship - not used otherwise. To ignore metadata from the part file and add your own, pass `false` for `indexMetadata` and supply custom metadata using the `metadata` field.
@@ -4972,11 +5112,11 @@ export interface UpdateSceneItemRequestDataAttributes {
     suppliedId?: string;
     /**
      * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof UpdateSceneItemRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
 }
 /**
@@ -5122,6 +5262,12 @@ export interface UpdateSceneViewRequestDataAttributes {
      * @memberof UpdateSceneViewRequestDataAttributes
      */
     crossSectioning?: CrossSectioning | null;
+    /**
+     * Whether or not to turn off default lighting
+     * @type {boolean}
+     * @memberof UpdateSceneViewRequestDataAttributes
+     */
+    noDefaultLights?: boolean;
 }
 /**
  *

package/dist/cjs/client/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.20.4";
+export declare const version = "0.20.6";

package/dist/cjs/client/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.version = void 0;
-exports.version = '0.20.4';
+exports.version = '0.20.6';

package/dist/esm/api.d.ts

@@ -1083,10 +1083,10 @@ export interface CreatePartRequestData {
     attributes: CreatePartRequestDataAttributes;
     /**
      *
-     * @type {CreateGeometrySetRequestDataRelationships}
+     * @type {CreatePartRequestDataRelationships}
      * @memberof CreatePartRequestData
      */
-    relationships?: CreateGeometrySetRequestDataRelationships;
+    relationships?: CreatePartRequestDataRelationships;
 }
 /**
  *
@@ -1114,11 +1114,11 @@ export interface CreatePartRequestDataAttributes {
     indexMetadata?: boolean;
     /**
      * Additional metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof CreatePartRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
     /**
      * Name to be used for the root part.
@@ -1145,6 +1145,19 @@ export interface CreatePartRequestDataAttributes {
      */
     suppliedInstanceIdKey?: string;
 }
+/**
+ *
+ * @export
+ * @interface CreatePartRequestDataRelationships
+ */
+export interface CreatePartRequestDataRelationships {
+    /**
+     *
+     * @type {FileRelationship | PartAssemblyRelationship}
+     * @memberof CreatePartRequestDataRelationships
+     */
+    source: FileRelationship | PartAssemblyRelationship;
+}
 /**
  *
  * @export
@@ -1366,11 +1379,11 @@ export interface CreateSceneItemRequestDataAttributes {
     visible?: boolean;
     /**
      * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof CreateSceneItemRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
 }
 /**
@@ -1542,6 +1555,12 @@ export interface CreateSceneViewRequestDataAttributes {
      * @memberof CreateSceneViewRequestDataAttributes
      */
     crossSectioning?: CrossSectioning | null;
+    /**
+     * Whether to exclude non-visible items in the view
+     * @type {boolean}
+     * @memberof CreateSceneViewRequestDataAttributes
+     */
+    excludePrunedItems?: boolean;
 }
 /**
  *
@@ -1670,6 +1689,12 @@ export interface CreateStreamKeyRequestDataAttributes {
      * @memberof CreateStreamKeyRequestDataAttributes
      */
     expiry?: number;
+    /**
+     * Whether to exclude non-visible items in the view
+     * @type {boolean}
+     * @memberof CreateStreamKeyRequestDataAttributes
+     */
+    excludePrunedItems?: boolean;
 }
 /**
  *
@@ -2596,6 +2621,25 @@ export interface Matrix4Nullable {
      */
     r3: Vector4;
 }
+/**
+ *
+ * @export
+ * @interface MetadataDateType
+ */
+export interface MetadataDateType {
+    /**
+     * Type of metadata value.
+     * @type {string}
+     * @memberof MetadataDateType
+     */
+    type: string;
+    /**
+     * A date value.
+     * @type {string}
+     * @memberof MetadataDateType
+     */
+    value: string;
+}
 /**
  *
  * @export
@@ -2615,6 +2659,25 @@ export interface MetadataFloatType {
      */
     value: number;
 }
+/**
+ *
+ * @export
+ * @interface MetadataLongType
+ */
+export interface MetadataLongType {
+    /**
+     * Type of metadata value.
+     * @type {string}
+     * @memberof MetadataLongType
+     */
+    type: string;
+    /**
+     * A numerical long value.
+     * @type {number}
+     * @memberof MetadataLongType
+     */
+    value: number;
+}
 /**
  *
  * @export
@@ -2786,6 +2849,40 @@ export interface Part {
         [key: string]: Link;
     };
 }
+/**
+ * Create Part Assembly
+ * @export
+ * @interface PartAssemblyRelationship
+ */
+export interface PartAssemblyRelationship {
+    /**
+     *
+     * @type {PartAssemblyRelationshipData}
+     * @memberof PartAssemblyRelationship
+     */
+    data: PartAssemblyRelationshipData;
+}
+/**
+ *
+ * @export
+ * @interface PartAssemblyRelationshipData
+ */
+export interface PartAssemblyRelationshipData {
+    /**
+     *
+     * @type {Array<PartRevisionInstance>}
+     * @memberof PartAssemblyRelationshipData
+     */
+    children: Array<PartRevisionInstance>;
+    /**
+     * Additional metadata about the `part` and/or `part-revision`.
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
+     * @memberof PartAssemblyRelationshipData
+     */
+    metadata?: {
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
+    };
+}
 /**
  *
  * @export
@@ -3004,11 +3101,11 @@ export interface PartRevisionDataAttributes {
     created?: string;
     /**
      *
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof PartRevisionDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
     /**
      *
@@ -3036,6 +3133,37 @@ export interface PartRevisionDataRelationships {
      */
     part?: PartRelationshipData;
 }
+/**
+ * A reference to an existing PartRevision. Specify one and only one of referenceId or suppliedReferenceId to refer to a revision.
+ * @export
+ * @interface PartRevisionInstance
+ */
+export interface PartRevisionInstance {
+    /**
+     * A 0-based index used for defining a consistent ordering for children of an assembly
+     * @type {number}
+     * @memberof PartRevisionInstance
+     */
+    ordinal: number;
+    /**
+     * ID of the resource.
+     * @type {string}
+     * @memberof PartRevisionInstance
+     */
+    revisionId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof PartRevisionInstance
+     */
+    suppliedRevisionId?: string;
+    /**
+     *
+     * @type {Matrix4}
+     * @memberof PartRevisionInstance
+     */
+    transform?: Matrix4;
+}
 /**
  *
  * @export
@@ -3119,6 +3247,12 @@ export interface PerspectiveCamera {
      * @memberof PerspectiveCamera
      */
     up: Vector3;
+    /**
+     * A numerical floating-point value representing the field of view
+     * @type {number}
+     * @memberof PerspectiveCamera
+     */
+    fovY?: number;
 }
 /**
  * 2D point.
@@ -3740,11 +3874,11 @@ export interface SceneItemDataAttributes {
     materialOverride?: ColorMaterial;
     /**
      *
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof SceneItemDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
     /**
      *
@@ -4148,6 +4282,12 @@ export interface SceneViewDataAttributes {
      * @memberof SceneViewDataAttributes
      */
     worldOrientation?: Orientation;
+    /**
+     * Whether to exclude non-visible items in the view
+     * @type {boolean}
+     * @memberof SceneViewDataAttributes
+     */
+    excludePrunedItems?: boolean;
 }
 /**
  *
@@ -4437,12 +4577,6 @@ export interface SelectOperation {
      * @memberof SelectOperation
      */
     type: SelectOperationTypeEnum;
-    /**
-     *
-     * @type {ColorMaterial}
-     * @memberof SelectOperation
-     */
-    material: ColorMaterial;
 }
 export declare const SelectOperationTypeEnum: {
     readonly Select: "select";
@@ -4532,6 +4666,12 @@ export interface StreamKeyDataAttributes {
      * @memberof StreamKeyDataAttributes
      */
     created: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof StreamKeyDataAttributes
+     */
+    excludePrunedItems?: boolean;
 }
 /**
  *
@@ -4790,11 +4930,11 @@ export interface UpdatePartRevisionRequestData {
 export interface UpdatePartRevisionRequestDataAttributes {
     /**
      * Metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof UpdatePartRevisionRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
     /**
      * Whether or not to index metadata in the part file when sending a file relationship - not used otherwise. To ignore metadata from the part file and add your own, pass `false` for `indexMetadata` and supply custom metadata using the `metadata` field.
@@ -4972,11 +5112,11 @@ export interface UpdateSceneItemRequestDataAttributes {
     suppliedId?: string;
     /**
      * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
-     * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
+     * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
      * @memberof UpdateSceneItemRequestDataAttributes
      */
     metadata?: {
-        [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
+        [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
     };
 }
 /**
@@ -5122,6 +5262,12 @@ export interface UpdateSceneViewRequestDataAttributes {
      * @memberof UpdateSceneViewRequestDataAttributes
      */
     crossSectioning?: CrossSectioning | null;
+    /**
+     * Whether or not to turn off default lighting
+     * @type {boolean}
+     * @memberof UpdateSceneViewRequestDataAttributes
+     */
+    noDefaultLights?: boolean;
 }
 /**
  *

package/dist/esm/client/version.d.ts

@@ -1 +1 @@
-export declare const version = "0.20.4";
+export declare const version = "0.20.6";

package/dist/esm/client/version.js

@@ -1 +1 @@
-export const version = '0.20.4';
+export const version = '0.20.6';

package/package.json

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