@vertexvis/api-client-node 0.23.2 → 0.24.0

package/dist/esm/api.js

@@ -75,12 +75,30 @@ export const GeometrySetRelationshipDataTypeEnum = {
 export const PartDataRelationshipsPartRevisionsTypeEnum = {
     PartRevision: 'part-revision',
 };
+export const PartInstanceRelationshipDataTypeEnum = {
+    PartInstance: 'part-instance',
+};
 export const PartRelationshipDataTypeEnum = {
     Part: 'part',
 };
 export const PartRenditionRelationshipDataTypeEnum = {
     PartRendition: 'part-rendition',
 };
+export const PropertyDateTypeTypeEnum = {
+    Date: 'date',
+};
+export const PropertyDoubleTypeTypeEnum = {
+    Double: 'double',
+};
+export const PropertyLongTypeTypeEnum = {
+    Long: 'long',
+};
+export const PropertySetRelationshipDataTypeEnum = {
+    PropertySet: 'property-set',
+};
+export const PropertyStringTypeTypeEnum = {
+    String: 'string',
+};
 /**
  * Resource object type.
  * @export
@@ -3172,6 +3190,119 @@ export class PartRenditionsApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * PartRevisionInstancesApi - axios parameter creator
+ * @export
+ */
+export const PartRevisionInstancesApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal  used for ordering and the transform matrix for each occurrence.
+         * @param {string} [filterParent] Parent ID to filter on.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPartRevisionInstanceList: (filterParent, pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const localVarPath = `/part-revision-instances`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            if (filterParent !== undefined) {
+                localVarQueryParameter['filter[parent]'] = filterParent;
+            }
+            if (pageCursor !== undefined) {
+                localVarQueryParameter['page[cursor]'] = pageCursor;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['page[size]'] = pageSize;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * PartRevisionInstancesApi - functional programming interface
+ * @export
+ */
+export const PartRevisionInstancesApiFp = function (configuration) {
+    const localVarAxiosParamCreator = PartRevisionInstancesApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal  used for ordering and the transform matrix for each occurrence.
+         * @param {string} [filterParent] Parent ID to filter on.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPartRevisionInstanceList(filterParent, pageCursor, pageSize, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPartRevisionInstanceList(filterParent, pageCursor, pageSize, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * PartRevisionInstancesApi - factory interface
+ * @export
+ */
+export const PartRevisionInstancesApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = PartRevisionInstancesApiFp(configuration);
+    return {
+        /**
+         * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal  used for ordering and the transform matrix for each occurrence.
+         * @param {string} [filterParent] Parent ID to filter on.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPartRevisionInstanceList(filterParent, pageCursor, pageSize, options) {
+            return localVarFp
+                .getPartRevisionInstanceList(filterParent, pageCursor, pageSize, options)
+                .then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * PartRevisionInstancesApi - object-oriented interface
+ * @export
+ * @class PartRevisionInstancesApi
+ * @extends {BaseAPI}
+ */
+export class PartRevisionInstancesApi extends BaseAPI {
+    /**
+     * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal  used for ordering and the transform matrix for each occurrence.
+     * @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PartRevisionInstancesApi
+     */
+    getPartRevisionInstanceList(requestParameters = {}, options) {
+        return PartRevisionInstancesApiFp(this.configuration)
+            .getPartRevisionInstanceList(requestParameters.filterParent, requestParameters.pageCursor, requestParameters.pageSize, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * PartRevisionsApi - axios parameter creator
  * @export
@@ -4209,6 +4340,193 @@ export class PmiApi extends BaseAPI {
             .then((request) => request(this.axios, this.basePath));
     }
 }
+/**
+ * PropertyEntriesApi - axios parameter creator
+ * @export
+ */
+export const PropertyEntriesApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
+         * @param {string} [filterResourceId] A resource ID to filter on
+         * @param {string} [filterResourceType] The provided type for the resource ids
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPropertyEntries: (pageCursor, pageSize, filterResourceId, filterResourceType, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const localVarPath = `/property-entries`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            if (pageCursor !== undefined) {
+                localVarQueryParameter['page[cursor]'] = pageCursor;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['page[size]'] = pageSize;
+            }
+            if (filterResourceId !== undefined) {
+                localVarQueryParameter['filter[resourceId]'] = filterResourceId;
+            }
+            if (filterResourceType !== undefined) {
+                localVarQueryParameter['filter[resourceType]'] = filterResourceType;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+        /**
+         * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
+         * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upsertPropertyEntries: (upsertPropertyEntriesRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
+            var _b;
+            // verify required parameter 'upsertPropertyEntriesRequest' is not null or undefined
+            assertParamExists('upsertPropertyEntries', 'upsertPropertyEntriesRequest', upsertPropertyEntriesRequest);
+            const localVarPath = `/property-entries`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'PATCH' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication OAuth2 required
+            // oauth required
+            yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
+            localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            localVarRequestOptions.data = serializeDataIfNeeded(upsertPropertyEntriesRequest, localVarRequestOptions, configuration);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * PropertyEntriesApi - functional programming interface
+ * @export
+ */
+export const PropertyEntriesApiFp = function (configuration) {
+    const localVarAxiosParamCreator = PropertyEntriesApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
+         * @param {string} [filterResourceId] A resource ID to filter on
+         * @param {string} [filterResourceType] The provided type for the resource ids
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPropertyEntries(pageCursor, pageSize, filterResourceId, filterResourceType, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.getPropertyEntries(pageCursor, pageSize, filterResourceId, filterResourceType, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+        /**
+         * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
+         * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upsertPropertyEntries(upsertPropertyEntriesRequest, options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.upsertPropertyEntries(upsertPropertyEntriesRequest, options);
+                return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+            });
+        },
+    };
+};
+/**
+ * PropertyEntriesApi - factory interface
+ * @export
+ */
+export const PropertyEntriesApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = PropertyEntriesApiFp(configuration);
+    return {
+        /**
+         * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
+         * @param {string} [pageCursor] The cursor for the next page of items.
+         * @param {number} [pageSize] The number of items to return.
+         * @param {string} [filterResourceId] A resource ID to filter on
+         * @param {string} [filterResourceType] The provided type for the resource ids
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getPropertyEntries(pageCursor, pageSize, filterResourceId, filterResourceType, options) {
+            return localVarFp
+                .getPropertyEntries(pageCursor, pageSize, filterResourceId, filterResourceType, options)
+                .then((request) => request(axios, basePath));
+        },
+        /**
+         * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
+         * @param {UpsertPropertyEntriesRequest} upsertPropertyEntriesRequest
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        upsertPropertyEntries(upsertPropertyEntriesRequest, options) {
+            return localVarFp
+                .upsertPropertyEntries(upsertPropertyEntriesRequest, options)
+                .then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * PropertyEntriesApi - object-oriented interface
+ * @export
+ * @class PropertyEntriesApi
+ * @extends {BaseAPI}
+ */
+export class PropertyEntriesApi extends BaseAPI {
+    /**
+     * Get `property-entries` by a resource ID **Preview:** This is a preview API and is subject to change.
+     * @param {PropertyEntriesApiGetPropertyEntriesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PropertyEntriesApi
+     */
+    getPropertyEntries(requestParameters = {}, options) {
+        return PropertyEntriesApiFp(this.configuration)
+            .getPropertyEntries(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterResourceId, requestParameters.filterResourceType, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+    /**
+     * Upsert property-entries for a provided resource. **Preview:** This is a preview API and is subject to change.
+     * @param {PropertyEntriesApiUpsertPropertyEntriesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PropertyEntriesApi
+     */
+    upsertPropertyEntries(requestParameters, options) {
+        return PropertyEntriesApiFp(this.configuration)
+            .upsertPropertyEntries(requestParameters.upsertPropertyEntriesRequest, options)
+            .then((request) => request(this.axios, this.basePath));
+    }
+}
 /**
  * SceneAlterationsApi - axios parameter creator
  * @export

package/dist/esm/client/helpers/parts.d.ts

@@ -33,6 +33,8 @@ export interface GetPartRevisionBySuppliedIdReq extends BaseReq {
     readonly suppliedPartId: string;
     /** A supplied part revision ID. */
     readonly suppliedRevisionId: string;
+    /** An optional supplied part revision iteration ID. */
+    readonly suppliedIterationId?: string;
 }
 /**
  * Create part and file resources if they don't already exist.
@@ -59,7 +61,7 @@ export declare function deleteAllParts({ client, pageSize, exceptions, }: Delete
  *
  * @param args - The {@link GetPartRevisionBySuppliedIdReq}.
  */
-export declare function getPartRevisionBySuppliedId({ client, suppliedPartId, suppliedRevisionId, }: GetPartRevisionBySuppliedIdReq): Promise<PartRevisionData | undefined>;
+export declare function getPartRevisionBySuppliedId({ client, suppliedPartId, suppliedRevisionId, suppliedIterationId, }: GetPartRevisionBySuppliedIdReq): Promise<PartRevisionData | undefined>;
 /**
  * Render a part revision.
  *

package/dist/esm/client/helpers/parts.js

@@ -33,18 +33,27 @@ export function createPartFromFile(_a) {
         const createPartRequest = createPartReq(file.id);
         const suppliedPartId = createPartRequest.data.attributes.suppliedId;
         const suppliedRevisionId = createPartRequest.data.attributes.suppliedRevisionId;
+        const suppliedIterationId = createPartRequest.data.attributes.suppliedIterationId;
         if (suppliedPartId && suppliedRevisionId) {
             const existingPartRev = yield getPartRevisionBySuppliedId({
                 client,
                 suppliedPartId,
                 suppliedRevisionId,
+                suppliedIterationId,
                 verbose,
                 onMsg,
             });
             if (existingPartRev) {
                 if (verbose) {
-                    onMsg(`part-revision with suppliedId '${suppliedPartId}' and suppliedRevisionId ` +
-                        `'${suppliedRevisionId}' already exists, using it, ${existingPartRev.id}`);
+                    if (suppliedIterationId) {
+                        onMsg(`part-revision with suppliedId '${suppliedPartId}', suppliedRevisionId ` +
+                            `'${suppliedRevisionId}' and suppliedIterationId ` +
+                            `'${suppliedIterationId}' already exists, using it, ${existingPartRev.id}`);
+                    }
+                    else {
+                        onMsg(`part-revision with suppliedId '${suppliedPartId}' and suppliedRevisionId ` +
+                            `'${suppliedRevisionId}' already exists, using it, ${existingPartRev.id}`);
+                    }
                 }
                 return {
                     partRevision: existingPartRev,
@@ -115,7 +124,7 @@ export function deleteAllParts({ client, pageSize = 100, exceptions = new Set(),
  *
  * @param args - The {@link GetPartRevisionBySuppliedIdReq}.
  */
-export function getPartRevisionBySuppliedId({ client, suppliedPartId, suppliedRevisionId, }) {
+export function getPartRevisionBySuppliedId({ client, suppliedPartId, suppliedRevisionId, suppliedIterationId, }) {
     return __awaiter(this, void 0, void 0, function* () {
         const existingPart = yield getBySuppliedId(() => client.parts.getParts({
             pageSize: 1,
@@ -126,7 +135,7 @@ export function getPartRevisionBySuppliedId({ client, suppliedPartId, suppliedRe
                 id: existingPart.id,
                 pageSize: 1,
                 filterSuppliedId: encodeIfNotEncoded(suppliedRevisionId),
-            }), suppliedRevisionId);
+            }), suppliedRevisionId, suppliedIterationId);
             if (existingPartRev)
                 return existingPartRev;
         }

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

@@ -75,10 +75,11 @@ export declare function envVar(key: string): string;
 export declare function getBySuppliedId<T extends {
     attributes: {
         suppliedId?: string;
+        suppliedIterationId?: string;
     };
 }, TRes extends {
     data: T[];
-}>(getter: () => Promise<AxiosResponse<TRes>>, suppliedId?: string): Promise<T | undefined>;
+}>(getter: () => Promise<AxiosResponse<TRes>>, suppliedId?: string, suppliedIterationId?: string): Promise<T | undefined>;
 /**
  * Get an Error message produced by {@link VertexClient}.
  *

package/dist/esm/client/utils.js

@@ -92,15 +92,17 @@ export function envVar(key) {
  * @param suppliedId - ID to match.
  * @returns Item if and only if it matches ID.
  */
-export function getBySuppliedId(getter, suppliedId) {
+export function getBySuppliedId(getter, suppliedId, suppliedIterationId) {
     return __awaiter(this, void 0, void 0, function* () {
         if (!suppliedId)
             return undefined;
         const res = yield getter();
         if (res.data.data.length > 0) {
             const item = head(res.data.data);
-            if (item.attributes.suppliedId === suppliedId)
+            if (item.attributes.suppliedId === suppliedId &&
+                item.attributes.suppliedIterationId === suppliedIterationId) {
                 return item;
+            }
         }
         return undefined;
     });

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

@@ -1 +1 @@
-export declare const version = "0.23.2";
+export declare const version = "0.24.0";

package/dist/esm/client/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vertexvis/api-client-node",
-  "version": "0.23.2",
+  "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)",