@vertexvis/api-client-node 0.17.2 → 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api.d.ts +83 -17
- package/dist/cjs/api.js +26 -14
- package/dist/cjs/client/helpers/parts.d.ts +2 -2
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +83 -17
- package/dist/esm/api.js +26 -14
- package/dist/esm/client/helpers/parts.d.ts +2 -2
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/package.json +2 -2
package/dist/cjs/api.d.ts
CHANGED
|
@@ -871,6 +871,12 @@ export interface CreateExportRequestDataAttributes {
|
|
|
871
871
|
* @memberof CreateExportRequestDataAttributes
|
|
872
872
|
*/
|
|
873
873
|
config: CADExportConfig;
|
|
874
|
+
/**
|
|
875
|
+
* Optional file name to use for the resulting export
|
|
876
|
+
* @type {string}
|
|
877
|
+
* @memberof CreateExportRequestDataAttributes
|
|
878
|
+
*/
|
|
879
|
+
fileName?: string;
|
|
874
880
|
}
|
|
875
881
|
/**
|
|
876
882
|
*
|
|
@@ -1080,7 +1086,7 @@ export interface CreatePartRequestData {
|
|
|
1080
1086
|
* @type {CreateGeometrySetRequestDataRelationships}
|
|
1081
1087
|
* @memberof CreatePartRequestData
|
|
1082
1088
|
*/
|
|
1083
|
-
relationships
|
|
1089
|
+
relationships?: CreateGeometrySetRequestDataRelationships;
|
|
1084
1090
|
}
|
|
1085
1091
|
/**
|
|
1086
1092
|
*
|
|
@@ -1095,7 +1101,7 @@ export interface CreatePartRequestDataAttributes {
|
|
|
1095
1101
|
*/
|
|
1096
1102
|
suppliedId?: string;
|
|
1097
1103
|
/**
|
|
1098
|
-
* ID provided for correlation. For example, an existing ID from a PLM system.
|
|
1104
|
+
* ID provided for correlation. For example, an existing ID from a PLM system. Sending a new suppliedRevisionId combined with an existing suppliedId will create a new part revision for an existing part.
|
|
1099
1105
|
* @type {string}
|
|
1100
1106
|
* @memberof CreatePartRequestDataAttributes
|
|
1101
1107
|
*/
|
|
@@ -4284,6 +4290,12 @@ export interface SceneViewStateDataAttributes {
|
|
|
4284
4290
|
* @memberof SceneViewStateDataAttributes
|
|
4285
4291
|
*/
|
|
4286
4292
|
featureLines?: FeatureLines;
|
|
4293
|
+
/**
|
|
4294
|
+
*
|
|
4295
|
+
* @type {boolean}
|
|
4296
|
+
* @memberof SceneViewStateDataAttributes
|
|
4297
|
+
*/
|
|
4298
|
+
noDefaultLights?: boolean;
|
|
4287
4299
|
}
|
|
4288
4300
|
/**
|
|
4289
4301
|
*
|
|
@@ -4688,7 +4700,7 @@ export interface UpdatePartRevisionRequest {
|
|
|
4688
4700
|
data: UpdatePartRevisionRequestData;
|
|
4689
4701
|
}
|
|
4690
4702
|
/**
|
|
4691
|
-
*
|
|
4703
|
+
* Modify existing part revisions using this endpoint. When specifying a `relationship`, the generated output from that relationship will be used to replace any relationship that is present on the revision prior to the update. For example, sending a file relationship that has geometry will replace the existing geometry on the revision with the new geometry in the given file.
|
|
4692
4704
|
* @export
|
|
4693
4705
|
* @interface UpdatePartRevisionRequestData
|
|
4694
4706
|
*/
|
|
@@ -4711,6 +4723,12 @@ export interface UpdatePartRevisionRequestData {
|
|
|
4711
4723
|
* @memberof UpdatePartRevisionRequestData
|
|
4712
4724
|
*/
|
|
4713
4725
|
attributes: UpdatePartRevisionRequestDataAttributes;
|
|
4726
|
+
/**
|
|
4727
|
+
*
|
|
4728
|
+
* @type {CreateGeometrySetRequestDataRelationships}
|
|
4729
|
+
* @memberof UpdatePartRevisionRequestData
|
|
4730
|
+
*/
|
|
4731
|
+
relationships?: CreateGeometrySetRequestDataRelationships;
|
|
4714
4732
|
}
|
|
4715
4733
|
/**
|
|
4716
4734
|
*
|
|
@@ -4726,6 +4744,36 @@ export interface UpdatePartRevisionRequestDataAttributes {
|
|
|
4726
4744
|
metadata?: {
|
|
4727
4745
|
[key: string]: MetadataValue;
|
|
4728
4746
|
};
|
|
4747
|
+
/**
|
|
4748
|
+
* Whether or not to index metadata in the part file when sending a file relationship - not used otherwise.
|
|
4749
|
+
* @type {boolean}
|
|
4750
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4751
|
+
*/
|
|
4752
|
+
indexMetadata?: boolean;
|
|
4753
|
+
/**
|
|
4754
|
+
* Name to be used for the root part. This will be used when given a file relationship - not used otherwise.
|
|
4755
|
+
* @type {string}
|
|
4756
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4757
|
+
*/
|
|
4758
|
+
name?: string;
|
|
4759
|
+
/**
|
|
4760
|
+
* Metadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
|
|
4761
|
+
* @type {string}
|
|
4762
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4763
|
+
*/
|
|
4764
|
+
suppliedIdKey?: string;
|
|
4765
|
+
/**
|
|
4766
|
+
* Metadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
|
|
4767
|
+
* @type {string}
|
|
4768
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4769
|
+
*/
|
|
4770
|
+
suppliedRevisionIdKey?: string;
|
|
4771
|
+
/**
|
|
4772
|
+
* Metadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
|
|
4773
|
+
* @type {string}
|
|
4774
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4775
|
+
*/
|
|
4776
|
+
suppliedInstanceIdKey?: string;
|
|
4729
4777
|
}
|
|
4730
4778
|
/**
|
|
4731
4779
|
*
|
|
@@ -7165,7 +7213,7 @@ export declare const PartRevisionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
7165
7213
|
*/
|
|
7166
7214
|
renderPartRevision: (id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7167
7215
|
/**
|
|
7168
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
7216
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
7169
7217
|
* @param {string} id The `part-revision` ID.
|
|
7170
7218
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
7171
7219
|
* @param {*} [options] Override http request option.
|
|
@@ -7230,7 +7278,7 @@ export declare const PartRevisionsApiFp: (configuration?: Configuration | undefi
|
|
|
7230
7278
|
*/
|
|
7231
7279
|
renderPartRevision(id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<any>>;
|
|
7232
7280
|
/**
|
|
7233
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
7281
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
7234
7282
|
* @param {string} id The `part-revision` ID.
|
|
7235
7283
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
7236
7284
|
* @param {*} [options] Override http request option.
|
|
@@ -7295,7 +7343,7 @@ export declare const PartRevisionsApiFactory: (configuration?: Configuration | u
|
|
|
7295
7343
|
*/
|
|
7296
7344
|
renderPartRevision(id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: any): AxiosPromise<any>;
|
|
7297
7345
|
/**
|
|
7298
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
7346
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
7299
7347
|
* @param {string} id The `part-revision` ID.
|
|
7300
7348
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
7301
7349
|
* @param {*} [options] Override http request option.
|
|
@@ -7531,7 +7579,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
7531
7579
|
*/
|
|
7532
7580
|
renderPartRevision(requestParameters: PartRevisionsApiRenderPartRevisionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
7533
7581
|
/**
|
|
7534
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
7582
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
7535
7583
|
* @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
|
|
7536
7584
|
* @param {*} [options] Override http request option.
|
|
7537
7585
|
* @throws {RequiredError}
|
|
@@ -7545,7 +7593,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
7545
7593
|
*/
|
|
7546
7594
|
export declare const PartsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
7547
7595
|
/**
|
|
7548
|
-
* Create a `part`.
|
|
7596
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
7549
7597
|
* @param {CreatePartRequest} createPartRequest
|
|
7550
7598
|
* @param {*} [options] Override http request option.
|
|
7551
7599
|
* @throws {RequiredError}
|
|
@@ -7589,12 +7637,12 @@ export declare const PartsApiAxiosParamCreator: (configuration?: Configuration |
|
|
|
7589
7637
|
*/
|
|
7590
7638
|
export declare const PartsApiFp: (configuration?: Configuration | undefined) => {
|
|
7591
7639
|
/**
|
|
7592
|
-
* Create a `part`.
|
|
7640
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
7593
7641
|
* @param {CreatePartRequest} createPartRequest
|
|
7594
7642
|
* @param {*} [options] Override http request option.
|
|
7595
7643
|
* @throws {RequiredError}
|
|
7596
7644
|
*/
|
|
7597
|
-
createPart(createPartRequest: CreatePartRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<
|
|
7645
|
+
createPart(createPartRequest: CreatePartRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Part>>;
|
|
7598
7646
|
/**
|
|
7599
7647
|
* Delete a `part`.
|
|
7600
7648
|
* @param {string} id The `part` ID.
|
|
@@ -7633,12 +7681,12 @@ export declare const PartsApiFp: (configuration?: Configuration | undefined) =>
|
|
|
7633
7681
|
*/
|
|
7634
7682
|
export declare const PartsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
7635
7683
|
/**
|
|
7636
|
-
* Create a `part`.
|
|
7684
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
7637
7685
|
* @param {CreatePartRequest} createPartRequest
|
|
7638
7686
|
* @param {*} [options] Override http request option.
|
|
7639
7687
|
* @throws {RequiredError}
|
|
7640
7688
|
*/
|
|
7641
|
-
createPart(createPartRequest: CreatePartRequest, options?: any): AxiosPromise<
|
|
7689
|
+
createPart(createPartRequest: CreatePartRequest, options?: any): AxiosPromise<Part>;
|
|
7642
7690
|
/**
|
|
7643
7691
|
* Delete a `part`.
|
|
7644
7692
|
* @param {string} id The `part` ID.
|
|
@@ -7762,13 +7810,13 @@ export interface PartsApiGetQueuedPartDeletionRequest {
|
|
|
7762
7810
|
*/
|
|
7763
7811
|
export declare class PartsApi extends BaseAPI {
|
|
7764
7812
|
/**
|
|
7765
|
-
* Create a `part`.
|
|
7813
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
7766
7814
|
* @param {PartsApiCreatePartRequest} requestParameters Request parameters.
|
|
7767
7815
|
* @param {*} [options] Override http request option.
|
|
7768
7816
|
* @throws {RequiredError}
|
|
7769
7817
|
* @memberof PartsApi
|
|
7770
7818
|
*/
|
|
7771
|
-
createPart(requestParameters: PartsApiCreatePartRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
7819
|
+
createPart(requestParameters: PartsApiCreatePartRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Part, any>>;
|
|
7772
7820
|
/**
|
|
7773
7821
|
* Delete a `part`.
|
|
7774
7822
|
* @param {PartsApiDeletePartRequest} requestParameters Request parameters.
|
|
@@ -8028,10 +8076,12 @@ export declare const SceneItemOverridesApiAxiosParamCreator: (configuration?: Co
|
|
|
8028
8076
|
/**
|
|
8029
8077
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
8030
8078
|
* @param {string} id The `scene-view` ID.
|
|
8079
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
8080
|
+
* @param {number} [pageSize] The number of items to return.
|
|
8031
8081
|
* @param {*} [options] Override http request option.
|
|
8032
8082
|
* @throws {RequiredError}
|
|
8033
8083
|
*/
|
|
8034
|
-
getSceneItemOverrides: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8084
|
+
getSceneItemOverrides: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8035
8085
|
/**
|
|
8036
8086
|
* Update a `scene-item-override`.
|
|
8037
8087
|
* @param {string} id The `scene-item-override` ID.
|
|
@@ -8064,10 +8114,12 @@ export declare const SceneItemOverridesApiFp: (configuration?: Configuration | u
|
|
|
8064
8114
|
/**
|
|
8065
8115
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
8066
8116
|
* @param {string} id The `scene-view` ID.
|
|
8117
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
8118
|
+
* @param {number} [pageSize] The number of items to return.
|
|
8067
8119
|
* @param {*} [options] Override http request option.
|
|
8068
8120
|
* @throws {RequiredError}
|
|
8069
8121
|
*/
|
|
8070
|
-
getSceneItemOverrides(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneItemOverrideList>>;
|
|
8122
|
+
getSceneItemOverrides(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneItemOverrideList>>;
|
|
8071
8123
|
/**
|
|
8072
8124
|
* Update a `scene-item-override`.
|
|
8073
8125
|
* @param {string} id The `scene-item-override` ID.
|
|
@@ -8100,10 +8152,12 @@ export declare const SceneItemOverridesApiFactory: (configuration?: Configuratio
|
|
|
8100
8152
|
/**
|
|
8101
8153
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
8102
8154
|
* @param {string} id The `scene-view` ID.
|
|
8155
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
8156
|
+
* @param {number} [pageSize] The number of items to return.
|
|
8103
8157
|
* @param {*} [options] Override http request option.
|
|
8104
8158
|
* @throws {RequiredError}
|
|
8105
8159
|
*/
|
|
8106
|
-
getSceneItemOverrides(id: string, options?: any): AxiosPromise<SceneItemOverrideList>;
|
|
8160
|
+
getSceneItemOverrides(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<SceneItemOverrideList>;
|
|
8107
8161
|
/**
|
|
8108
8162
|
* Update a `scene-item-override`.
|
|
8109
8163
|
* @param {string} id The `scene-item-override` ID.
|
|
@@ -8157,6 +8211,18 @@ export interface SceneItemOverridesApiGetSceneItemOverridesRequest {
|
|
|
8157
8211
|
* @memberof SceneItemOverridesApiGetSceneItemOverrides
|
|
8158
8212
|
*/
|
|
8159
8213
|
readonly id: string;
|
|
8214
|
+
/**
|
|
8215
|
+
* The cursor for the next page of items.
|
|
8216
|
+
* @type {string}
|
|
8217
|
+
* @memberof SceneItemOverridesApiGetSceneItemOverrides
|
|
8218
|
+
*/
|
|
8219
|
+
readonly pageCursor?: string;
|
|
8220
|
+
/**
|
|
8221
|
+
* The number of items to return.
|
|
8222
|
+
* @type {number}
|
|
8223
|
+
* @memberof SceneItemOverridesApiGetSceneItemOverrides
|
|
8224
|
+
*/
|
|
8225
|
+
readonly pageSize?: number;
|
|
8160
8226
|
}
|
|
8161
8227
|
/**
|
|
8162
8228
|
* Request parameters for updateSceneItemOverride operation in SceneItemOverridesApi.
|
package/dist/cjs/api.js
CHANGED
|
@@ -2780,7 +2780,7 @@ const PartRevisionsApiAxiosParamCreator = function (configuration) {
|
|
|
2780
2780
|
};
|
|
2781
2781
|
}),
|
|
2782
2782
|
/**
|
|
2783
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
2783
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
2784
2784
|
* @param {string} id The `part-revision` ID.
|
|
2785
2785
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
2786
2786
|
* @param {*} [options] Override http request option.
|
|
@@ -2901,7 +2901,7 @@ const PartRevisionsApiFp = function (configuration) {
|
|
|
2901
2901
|
});
|
|
2902
2902
|
},
|
|
2903
2903
|
/**
|
|
2904
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
2904
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
2905
2905
|
* @param {string} id The `part-revision` ID.
|
|
2906
2906
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
2907
2907
|
* @param {*} [options] Override http request option.
|
|
@@ -2995,7 +2995,7 @@ const PartRevisionsApiFactory = function (configuration, basePath, axios) {
|
|
|
2995
2995
|
.then((request) => request(axios, basePath));
|
|
2996
2996
|
},
|
|
2997
2997
|
/**
|
|
2998
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
2998
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
2999
2999
|
* @param {string} id The `part-revision` ID.
|
|
3000
3000
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
3001
3001
|
* @param {*} [options] Override http request option.
|
|
@@ -3077,7 +3077,7 @@ class PartRevisionsApi extends base_1.BaseAPI {
|
|
|
3077
3077
|
.then((request) => request(this.axios, this.basePath));
|
|
3078
3078
|
}
|
|
3079
3079
|
/**
|
|
3080
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
3080
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
3081
3081
|
* @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
|
|
3082
3082
|
* @param {*} [options] Override http request option.
|
|
3083
3083
|
* @throws {RequiredError}
|
|
@@ -3097,7 +3097,7 @@ exports.PartRevisionsApi = PartRevisionsApi;
|
|
|
3097
3097
|
const PartsApiAxiosParamCreator = function (configuration) {
|
|
3098
3098
|
return {
|
|
3099
3099
|
/**
|
|
3100
|
-
* Create a `part`.
|
|
3100
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
3101
3101
|
* @param {CreatePartRequest} createPartRequest
|
|
3102
3102
|
* @param {*} [options] Override http request option.
|
|
3103
3103
|
* @throws {RequiredError}
|
|
@@ -3272,7 +3272,7 @@ const PartsApiFp = function (configuration) {
|
|
|
3272
3272
|
const localVarAxiosParamCreator = (0, exports.PartsApiAxiosParamCreator)(configuration);
|
|
3273
3273
|
return {
|
|
3274
3274
|
/**
|
|
3275
|
-
* Create a `part`.
|
|
3275
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
3276
3276
|
* @param {CreatePartRequest} createPartRequest
|
|
3277
3277
|
* @param {*} [options] Override http request option.
|
|
3278
3278
|
* @throws {RequiredError}
|
|
@@ -3345,7 +3345,7 @@ const PartsApiFactory = function (configuration, basePath, axios) {
|
|
|
3345
3345
|
const localVarFp = (0, exports.PartsApiFp)(configuration);
|
|
3346
3346
|
return {
|
|
3347
3347
|
/**
|
|
3348
|
-
* Create a `part`.
|
|
3348
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
3349
3349
|
* @param {CreatePartRequest} createPartRequest
|
|
3350
3350
|
* @param {*} [options] Override http request option.
|
|
3351
3351
|
* @throws {RequiredError}
|
|
@@ -3413,7 +3413,7 @@ exports.PartsApiFactory = PartsApiFactory;
|
|
|
3413
3413
|
*/
|
|
3414
3414
|
class PartsApi extends base_1.BaseAPI {
|
|
3415
3415
|
/**
|
|
3416
|
-
* Create a `part`.
|
|
3416
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
3417
3417
|
* @param {PartsApiCreatePartRequest} requestParameters Request parameters.
|
|
3418
3418
|
* @param {*} [options] Override http request option.
|
|
3419
3419
|
* @throws {RequiredError}
|
|
@@ -3853,10 +3853,12 @@ const SceneItemOverridesApiAxiosParamCreator = function (configuration) {
|
|
|
3853
3853
|
/**
|
|
3854
3854
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
3855
3855
|
* @param {string} id The `scene-view` ID.
|
|
3856
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3857
|
+
* @param {number} [pageSize] The number of items to return.
|
|
3856
3858
|
* @param {*} [options] Override http request option.
|
|
3857
3859
|
* @throws {RequiredError}
|
|
3858
3860
|
*/
|
|
3859
|
-
getSceneItemOverrides: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
3861
|
+
getSceneItemOverrides: (id, pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
3860
3862
|
// verify required parameter 'id' is not null or undefined
|
|
3861
3863
|
(0, common_1.assertParamExists)('getSceneItemOverrides', 'id', id);
|
|
3862
3864
|
const localVarPath = `/scene-views/{id}/scene-item-overrides`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
@@ -3872,6 +3874,12 @@ const SceneItemOverridesApiAxiosParamCreator = function (configuration) {
|
|
|
3872
3874
|
// authentication OAuth2 required
|
|
3873
3875
|
// oauth required
|
|
3874
3876
|
yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
3877
|
+
if (pageCursor !== undefined) {
|
|
3878
|
+
localVarQueryParameter['page[cursor]'] = pageCursor;
|
|
3879
|
+
}
|
|
3880
|
+
if (pageSize !== undefined) {
|
|
3881
|
+
localVarQueryParameter['page[size]'] = pageSize;
|
|
3882
|
+
}
|
|
3875
3883
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
3876
3884
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3877
3885
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -3953,12 +3961,14 @@ const SceneItemOverridesApiFp = function (configuration) {
|
|
|
3953
3961
|
/**
|
|
3954
3962
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
3955
3963
|
* @param {string} id The `scene-view` ID.
|
|
3964
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3965
|
+
* @param {number} [pageSize] The number of items to return.
|
|
3956
3966
|
* @param {*} [options] Override http request option.
|
|
3957
3967
|
* @throws {RequiredError}
|
|
3958
3968
|
*/
|
|
3959
|
-
getSceneItemOverrides(id, options) {
|
|
3969
|
+
getSceneItemOverrides(id, pageCursor, pageSize, options) {
|
|
3960
3970
|
return __awaiter(this, void 0, void 0, function* () {
|
|
3961
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneItemOverrides(id, options);
|
|
3971
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneItemOverrides(id, pageCursor, pageSize, options);
|
|
3962
3972
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
3963
3973
|
});
|
|
3964
3974
|
},
|
|
@@ -4011,12 +4021,14 @@ const SceneItemOverridesApiFactory = function (configuration, basePath, axios) {
|
|
|
4011
4021
|
/**
|
|
4012
4022
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
4013
4023
|
* @param {string} id The `scene-view` ID.
|
|
4024
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
4025
|
+
* @param {number} [pageSize] The number of items to return.
|
|
4014
4026
|
* @param {*} [options] Override http request option.
|
|
4015
4027
|
* @throws {RequiredError}
|
|
4016
4028
|
*/
|
|
4017
|
-
getSceneItemOverrides(id, options) {
|
|
4029
|
+
getSceneItemOverrides(id, pageCursor, pageSize, options) {
|
|
4018
4030
|
return localVarFp
|
|
4019
|
-
.getSceneItemOverrides(id, options)
|
|
4031
|
+
.getSceneItemOverrides(id, pageCursor, pageSize, options)
|
|
4020
4032
|
.then((request) => request(axios, basePath));
|
|
4021
4033
|
},
|
|
4022
4034
|
/**
|
|
@@ -4074,7 +4086,7 @@ class SceneItemOverridesApi extends base_1.BaseAPI {
|
|
|
4074
4086
|
*/
|
|
4075
4087
|
getSceneItemOverrides(requestParameters, options) {
|
|
4076
4088
|
return (0, exports.SceneItemOverridesApiFp)(this.configuration)
|
|
4077
|
-
.getSceneItemOverrides(requestParameters.id, options)
|
|
4089
|
+
.getSceneItemOverrides(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, options)
|
|
4078
4090
|
.then((request) => request(this.axios, this.basePath));
|
|
4079
4091
|
}
|
|
4080
4092
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
2
|
import { AxiosResponse } from 'axios';
|
|
3
|
-
import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, PartData, PartRevisionData, QueuedJob } from '../../index';
|
|
3
|
+
import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, Part, PartData, PartRevisionData, QueuedJob } from '../../index';
|
|
4
4
|
import { BaseReq, DeleteReq, Polling, RenderImageReq } from '../index';
|
|
5
5
|
/** Create parts from file arguments. */
|
|
6
6
|
export interface CreatePartFromFileReq extends BaseReq {
|
|
@@ -24,7 +24,7 @@ export interface CreatePartFromFileRes {
|
|
|
24
24
|
}
|
|
25
25
|
export interface QueuedTranslation {
|
|
26
26
|
readonly req: CreatePartRequest | CreateGeometrySetRequest;
|
|
27
|
-
readonly res?: Failure | QueuedJob;
|
|
27
|
+
readonly res?: Failure | QueuedJob | Part;
|
|
28
28
|
}
|
|
29
29
|
/** Get part revision by supplied ID arguments. */
|
|
30
30
|
export interface GetPartRevisionBySuppliedIdReq extends BaseReq {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.20.0";
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -871,6 +871,12 @@ export interface CreateExportRequestDataAttributes {
|
|
|
871
871
|
* @memberof CreateExportRequestDataAttributes
|
|
872
872
|
*/
|
|
873
873
|
config: CADExportConfig;
|
|
874
|
+
/**
|
|
875
|
+
* Optional file name to use for the resulting export
|
|
876
|
+
* @type {string}
|
|
877
|
+
* @memberof CreateExportRequestDataAttributes
|
|
878
|
+
*/
|
|
879
|
+
fileName?: string;
|
|
874
880
|
}
|
|
875
881
|
/**
|
|
876
882
|
*
|
|
@@ -1080,7 +1086,7 @@ export interface CreatePartRequestData {
|
|
|
1080
1086
|
* @type {CreateGeometrySetRequestDataRelationships}
|
|
1081
1087
|
* @memberof CreatePartRequestData
|
|
1082
1088
|
*/
|
|
1083
|
-
relationships
|
|
1089
|
+
relationships?: CreateGeometrySetRequestDataRelationships;
|
|
1084
1090
|
}
|
|
1085
1091
|
/**
|
|
1086
1092
|
*
|
|
@@ -1095,7 +1101,7 @@ export interface CreatePartRequestDataAttributes {
|
|
|
1095
1101
|
*/
|
|
1096
1102
|
suppliedId?: string;
|
|
1097
1103
|
/**
|
|
1098
|
-
* ID provided for correlation. For example, an existing ID from a PLM system.
|
|
1104
|
+
* ID provided for correlation. For example, an existing ID from a PLM system. Sending a new suppliedRevisionId combined with an existing suppliedId will create a new part revision for an existing part.
|
|
1099
1105
|
* @type {string}
|
|
1100
1106
|
* @memberof CreatePartRequestDataAttributes
|
|
1101
1107
|
*/
|
|
@@ -4284,6 +4290,12 @@ export interface SceneViewStateDataAttributes {
|
|
|
4284
4290
|
* @memberof SceneViewStateDataAttributes
|
|
4285
4291
|
*/
|
|
4286
4292
|
featureLines?: FeatureLines;
|
|
4293
|
+
/**
|
|
4294
|
+
*
|
|
4295
|
+
* @type {boolean}
|
|
4296
|
+
* @memberof SceneViewStateDataAttributes
|
|
4297
|
+
*/
|
|
4298
|
+
noDefaultLights?: boolean;
|
|
4287
4299
|
}
|
|
4288
4300
|
/**
|
|
4289
4301
|
*
|
|
@@ -4688,7 +4700,7 @@ export interface UpdatePartRevisionRequest {
|
|
|
4688
4700
|
data: UpdatePartRevisionRequestData;
|
|
4689
4701
|
}
|
|
4690
4702
|
/**
|
|
4691
|
-
*
|
|
4703
|
+
* Modify existing part revisions using this endpoint. When specifying a `relationship`, the generated output from that relationship will be used to replace any relationship that is present on the revision prior to the update. For example, sending a file relationship that has geometry will replace the existing geometry on the revision with the new geometry in the given file.
|
|
4692
4704
|
* @export
|
|
4693
4705
|
* @interface UpdatePartRevisionRequestData
|
|
4694
4706
|
*/
|
|
@@ -4711,6 +4723,12 @@ export interface UpdatePartRevisionRequestData {
|
|
|
4711
4723
|
* @memberof UpdatePartRevisionRequestData
|
|
4712
4724
|
*/
|
|
4713
4725
|
attributes: UpdatePartRevisionRequestDataAttributes;
|
|
4726
|
+
/**
|
|
4727
|
+
*
|
|
4728
|
+
* @type {CreateGeometrySetRequestDataRelationships}
|
|
4729
|
+
* @memberof UpdatePartRevisionRequestData
|
|
4730
|
+
*/
|
|
4731
|
+
relationships?: CreateGeometrySetRequestDataRelationships;
|
|
4714
4732
|
}
|
|
4715
4733
|
/**
|
|
4716
4734
|
*
|
|
@@ -4726,6 +4744,36 @@ export interface UpdatePartRevisionRequestDataAttributes {
|
|
|
4726
4744
|
metadata?: {
|
|
4727
4745
|
[key: string]: MetadataValue;
|
|
4728
4746
|
};
|
|
4747
|
+
/**
|
|
4748
|
+
* Whether or not to index metadata in the part file when sending a file relationship - not used otherwise.
|
|
4749
|
+
* @type {boolean}
|
|
4750
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4751
|
+
*/
|
|
4752
|
+
indexMetadata?: boolean;
|
|
4753
|
+
/**
|
|
4754
|
+
* Name to be used for the root part. This will be used when given a file relationship - not used otherwise.
|
|
4755
|
+
* @type {string}
|
|
4756
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4757
|
+
*/
|
|
4758
|
+
name?: string;
|
|
4759
|
+
/**
|
|
4760
|
+
* Metadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
|
|
4761
|
+
* @type {string}
|
|
4762
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4763
|
+
*/
|
|
4764
|
+
suppliedIdKey?: string;
|
|
4765
|
+
/**
|
|
4766
|
+
* Metadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
|
|
4767
|
+
* @type {string}
|
|
4768
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4769
|
+
*/
|
|
4770
|
+
suppliedRevisionIdKey?: string;
|
|
4771
|
+
/**
|
|
4772
|
+
* Metadata key used to extract an ID used for correlation. This will be used when given a file relationship - not used otherwise.
|
|
4773
|
+
* @type {string}
|
|
4774
|
+
* @memberof UpdatePartRevisionRequestDataAttributes
|
|
4775
|
+
*/
|
|
4776
|
+
suppliedInstanceIdKey?: string;
|
|
4729
4777
|
}
|
|
4730
4778
|
/**
|
|
4731
4779
|
*
|
|
@@ -7165,7 +7213,7 @@ export declare const PartRevisionsApiAxiosParamCreator: (configuration?: Configu
|
|
|
7165
7213
|
*/
|
|
7166
7214
|
renderPartRevision: (id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
7167
7215
|
/**
|
|
7168
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
7216
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
7169
7217
|
* @param {string} id The `part-revision` ID.
|
|
7170
7218
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
7171
7219
|
* @param {*} [options] Override http request option.
|
|
@@ -7230,7 +7278,7 @@ export declare const PartRevisionsApiFp: (configuration?: Configuration | undefi
|
|
|
7230
7278
|
*/
|
|
7231
7279
|
renderPartRevision(id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<any>>;
|
|
7232
7280
|
/**
|
|
7233
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
7281
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
7234
7282
|
* @param {string} id The `part-revision` ID.
|
|
7235
7283
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
7236
7284
|
* @param {*} [options] Override http request option.
|
|
@@ -7295,7 +7343,7 @@ export declare const PartRevisionsApiFactory: (configuration?: Configuration | u
|
|
|
7295
7343
|
*/
|
|
7296
7344
|
renderPartRevision(id: string, height?: number | undefined, width?: number | undefined, cameraPosition?: Vector3 | undefined, cameraUp?: Vector3 | undefined, cameraLookAt?: Vector3 | undefined, cameraPerspectivePosition?: Vector3 | undefined, cameraPerspectiveLookAt?: Vector3 | undefined, cameraPerspectiveUp?: Vector3 | undefined, cameraOrthographicViewVector?: Vector3 | undefined, cameraOrthographicLookAt?: Vector3 | undefined, cameraOrthographicUp?: Vector3 | undefined, cameraOrthographicFovHeight?: number | undefined, options?: any): AxiosPromise<any>;
|
|
7297
7345
|
/**
|
|
7298
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
7346
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
7299
7347
|
* @param {string} id The `part-revision` ID.
|
|
7300
7348
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
7301
7349
|
* @param {*} [options] Override http request option.
|
|
@@ -7531,7 +7579,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
7531
7579
|
*/
|
|
7532
7580
|
renderPartRevision(requestParameters: PartRevisionsApiRenderPartRevisionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<any, any>>;
|
|
7533
7581
|
/**
|
|
7534
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
7582
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
7535
7583
|
* @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
|
|
7536
7584
|
* @param {*} [options] Override http request option.
|
|
7537
7585
|
* @throws {RequiredError}
|
|
@@ -7545,7 +7593,7 @@ export declare class PartRevisionsApi extends BaseAPI {
|
|
|
7545
7593
|
*/
|
|
7546
7594
|
export declare const PartsApiAxiosParamCreator: (configuration?: Configuration | undefined) => {
|
|
7547
7595
|
/**
|
|
7548
|
-
* Create a `part`.
|
|
7596
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
7549
7597
|
* @param {CreatePartRequest} createPartRequest
|
|
7550
7598
|
* @param {*} [options] Override http request option.
|
|
7551
7599
|
* @throws {RequiredError}
|
|
@@ -7589,12 +7637,12 @@ export declare const PartsApiAxiosParamCreator: (configuration?: Configuration |
|
|
|
7589
7637
|
*/
|
|
7590
7638
|
export declare const PartsApiFp: (configuration?: Configuration | undefined) => {
|
|
7591
7639
|
/**
|
|
7592
|
-
* Create a `part`.
|
|
7640
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
7593
7641
|
* @param {CreatePartRequest} createPartRequest
|
|
7594
7642
|
* @param {*} [options] Override http request option.
|
|
7595
7643
|
* @throws {RequiredError}
|
|
7596
7644
|
*/
|
|
7597
|
-
createPart(createPartRequest: CreatePartRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<
|
|
7645
|
+
createPart(createPartRequest: CreatePartRequest, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<Part>>;
|
|
7598
7646
|
/**
|
|
7599
7647
|
* Delete a `part`.
|
|
7600
7648
|
* @param {string} id The `part` ID.
|
|
@@ -7633,12 +7681,12 @@ export declare const PartsApiFp: (configuration?: Configuration | undefined) =>
|
|
|
7633
7681
|
*/
|
|
7634
7682
|
export declare const PartsApiFactory: (configuration?: Configuration | undefined, basePath?: string | undefined, axios?: AxiosInstance | undefined) => {
|
|
7635
7683
|
/**
|
|
7636
|
-
* Create a `part`.
|
|
7684
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
7637
7685
|
* @param {CreatePartRequest} createPartRequest
|
|
7638
7686
|
* @param {*} [options] Override http request option.
|
|
7639
7687
|
* @throws {RequiredError}
|
|
7640
7688
|
*/
|
|
7641
|
-
createPart(createPartRequest: CreatePartRequest, options?: any): AxiosPromise<
|
|
7689
|
+
createPart(createPartRequest: CreatePartRequest, options?: any): AxiosPromise<Part>;
|
|
7642
7690
|
/**
|
|
7643
7691
|
* Delete a `part`.
|
|
7644
7692
|
* @param {string} id The `part` ID.
|
|
@@ -7762,13 +7810,13 @@ export interface PartsApiGetQueuedPartDeletionRequest {
|
|
|
7762
7810
|
*/
|
|
7763
7811
|
export declare class PartsApi extends BaseAPI {
|
|
7764
7812
|
/**
|
|
7765
|
-
* Create a `part`.
|
|
7813
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
7766
7814
|
* @param {PartsApiCreatePartRequest} requestParameters Request parameters.
|
|
7767
7815
|
* @param {*} [options] Override http request option.
|
|
7768
7816
|
* @throws {RequiredError}
|
|
7769
7817
|
* @memberof PartsApi
|
|
7770
7818
|
*/
|
|
7771
|
-
createPart(requestParameters: PartsApiCreatePartRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
7819
|
+
createPart(requestParameters: PartsApiCreatePartRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Part, any>>;
|
|
7772
7820
|
/**
|
|
7773
7821
|
* Delete a `part`.
|
|
7774
7822
|
* @param {PartsApiDeletePartRequest} requestParameters Request parameters.
|
|
@@ -8028,10 +8076,12 @@ export declare const SceneItemOverridesApiAxiosParamCreator: (configuration?: Co
|
|
|
8028
8076
|
/**
|
|
8029
8077
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
8030
8078
|
* @param {string} id The `scene-view` ID.
|
|
8079
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
8080
|
+
* @param {number} [pageSize] The number of items to return.
|
|
8031
8081
|
* @param {*} [options] Override http request option.
|
|
8032
8082
|
* @throws {RequiredError}
|
|
8033
8083
|
*/
|
|
8034
|
-
getSceneItemOverrides: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8084
|
+
getSceneItemOverrides: (id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
8035
8085
|
/**
|
|
8036
8086
|
* Update a `scene-item-override`.
|
|
8037
8087
|
* @param {string} id The `scene-item-override` ID.
|
|
@@ -8064,10 +8114,12 @@ export declare const SceneItemOverridesApiFp: (configuration?: Configuration | u
|
|
|
8064
8114
|
/**
|
|
8065
8115
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
8066
8116
|
* @param {string} id The `scene-view` ID.
|
|
8117
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
8118
|
+
* @param {number} [pageSize] The number of items to return.
|
|
8067
8119
|
* @param {*} [options] Override http request option.
|
|
8068
8120
|
* @throws {RequiredError}
|
|
8069
8121
|
*/
|
|
8070
|
-
getSceneItemOverrides(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneItemOverrideList>>;
|
|
8122
|
+
getSceneItemOverrides(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneItemOverrideList>>;
|
|
8071
8123
|
/**
|
|
8072
8124
|
* Update a `scene-item-override`.
|
|
8073
8125
|
* @param {string} id The `scene-item-override` ID.
|
|
@@ -8100,10 +8152,12 @@ export declare const SceneItemOverridesApiFactory: (configuration?: Configuratio
|
|
|
8100
8152
|
/**
|
|
8101
8153
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
8102
8154
|
* @param {string} id The `scene-view` ID.
|
|
8155
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
8156
|
+
* @param {number} [pageSize] The number of items to return.
|
|
8103
8157
|
* @param {*} [options] Override http request option.
|
|
8104
8158
|
* @throws {RequiredError}
|
|
8105
8159
|
*/
|
|
8106
|
-
getSceneItemOverrides(id: string, options?: any): AxiosPromise<SceneItemOverrideList>;
|
|
8160
|
+
getSceneItemOverrides(id: string, pageCursor?: string | undefined, pageSize?: number | undefined, options?: any): AxiosPromise<SceneItemOverrideList>;
|
|
8107
8161
|
/**
|
|
8108
8162
|
* Update a `scene-item-override`.
|
|
8109
8163
|
* @param {string} id The `scene-item-override` ID.
|
|
@@ -8157,6 +8211,18 @@ export interface SceneItemOverridesApiGetSceneItemOverridesRequest {
|
|
|
8157
8211
|
* @memberof SceneItemOverridesApiGetSceneItemOverrides
|
|
8158
8212
|
*/
|
|
8159
8213
|
readonly id: string;
|
|
8214
|
+
/**
|
|
8215
|
+
* The cursor for the next page of items.
|
|
8216
|
+
* @type {string}
|
|
8217
|
+
* @memberof SceneItemOverridesApiGetSceneItemOverrides
|
|
8218
|
+
*/
|
|
8219
|
+
readonly pageCursor?: string;
|
|
8220
|
+
/**
|
|
8221
|
+
* The number of items to return.
|
|
8222
|
+
* @type {number}
|
|
8223
|
+
* @memberof SceneItemOverridesApiGetSceneItemOverrides
|
|
8224
|
+
*/
|
|
8225
|
+
readonly pageSize?: number;
|
|
8160
8226
|
}
|
|
8161
8227
|
/**
|
|
8162
8228
|
* Request parameters for updateSceneItemOverride operation in SceneItemOverridesApi.
|
package/dist/esm/api.js
CHANGED
|
@@ -2740,7 +2740,7 @@ export const PartRevisionsApiAxiosParamCreator = function (configuration) {
|
|
|
2740
2740
|
};
|
|
2741
2741
|
}),
|
|
2742
2742
|
/**
|
|
2743
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
2743
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
2744
2744
|
* @param {string} id The `part-revision` ID.
|
|
2745
2745
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
2746
2746
|
* @param {*} [options] Override http request option.
|
|
@@ -2860,7 +2860,7 @@ export const PartRevisionsApiFp = function (configuration) {
|
|
|
2860
2860
|
});
|
|
2861
2861
|
},
|
|
2862
2862
|
/**
|
|
2863
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
2863
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
2864
2864
|
* @param {string} id The `part-revision` ID.
|
|
2865
2865
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
2866
2866
|
* @param {*} [options] Override http request option.
|
|
@@ -2953,7 +2953,7 @@ export const PartRevisionsApiFactory = function (configuration, basePath, axios)
|
|
|
2953
2953
|
.then((request) => request(axios, basePath));
|
|
2954
2954
|
},
|
|
2955
2955
|
/**
|
|
2956
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
2956
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
2957
2957
|
* @param {string} id The `part-revision` ID.
|
|
2958
2958
|
* @param {UpdatePartRevisionRequest} updatePartRevisionRequest
|
|
2959
2959
|
* @param {*} [options] Override http request option.
|
|
@@ -3034,7 +3034,7 @@ export class PartRevisionsApi extends BaseAPI {
|
|
|
3034
3034
|
.then((request) => request(this.axios, this.basePath));
|
|
3035
3035
|
}
|
|
3036
3036
|
/**
|
|
3037
|
-
* Update a `part-revision`. Note that metadata updates are eventually consistent.
|
|
3037
|
+
* Update a `part-revision`. When given a `file` relationship as a payload, this will invoke a translation job, similar to the POST /parts endpoint. The response code will be a 202 and will respond with an async workflow, and return an Accepted[QueuedJob]. The geometry of the part and all of its children will be replaced with the geometry specified within the translated file given from this relationship. Some of the properties given here are only used for the translation of the file. Namely, `indexMetadata`, `name`, `suppliedIdKey`, `suppliedRevisionIdKey`, and `suppliedInstanceIdKey`. Note that geometry updates are eventually consistent and will not update existing scenes. For updates to the revision when the file relationship is not present will respond with a standard 200 ok code when successful. Note that metadata updates are eventually consistent and will not update existing scenes. To view updated metadata within a scene, a new scene must be created or the updated part-revision must be removed and re-added to an existing scene.
|
|
3038
3038
|
* @param {PartRevisionsApiUpdatePartRevisionRequest} requestParameters Request parameters.
|
|
3039
3039
|
* @param {*} [options] Override http request option.
|
|
3040
3040
|
* @throws {RequiredError}
|
|
@@ -3053,7 +3053,7 @@ export class PartRevisionsApi extends BaseAPI {
|
|
|
3053
3053
|
export const PartsApiAxiosParamCreator = function (configuration) {
|
|
3054
3054
|
return {
|
|
3055
3055
|
/**
|
|
3056
|
-
* Create a `part`.
|
|
3056
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
3057
3057
|
* @param {CreatePartRequest} createPartRequest
|
|
3058
3058
|
* @param {*} [options] Override http request option.
|
|
3059
3059
|
* @throws {RequiredError}
|
|
@@ -3227,7 +3227,7 @@ export const PartsApiFp = function (configuration) {
|
|
|
3227
3227
|
const localVarAxiosParamCreator = PartsApiAxiosParamCreator(configuration);
|
|
3228
3228
|
return {
|
|
3229
3229
|
/**
|
|
3230
|
-
* Create a `part`.
|
|
3230
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
3231
3231
|
* @param {CreatePartRequest} createPartRequest
|
|
3232
3232
|
* @param {*} [options] Override http request option.
|
|
3233
3233
|
* @throws {RequiredError}
|
|
@@ -3299,7 +3299,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
|
|
|
3299
3299
|
const localVarFp = PartsApiFp(configuration);
|
|
3300
3300
|
return {
|
|
3301
3301
|
/**
|
|
3302
|
-
* Create a `part`.
|
|
3302
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
3303
3303
|
* @param {CreatePartRequest} createPartRequest
|
|
3304
3304
|
* @param {*} [options] Override http request option.
|
|
3305
3305
|
* @throws {RequiredError}
|
|
@@ -3366,7 +3366,7 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
|
|
|
3366
3366
|
*/
|
|
3367
3367
|
export class PartsApi extends BaseAPI {
|
|
3368
3368
|
/**
|
|
3369
|
-
* Create a `part`.
|
|
3369
|
+
* Create a `part`. This endpoint includes multiple successful response codes: [`201`, `202`]. When not given a relationship, this endpoint will create a part with an empty part revision and return a `201` status code of the part. When given a relationship to translate, this endpoint will return a `202` status code with the location of a `queued-translation`. The status of the translation can be queried via `getQueuedTranslation`. After the translation is complete, a `part` and `part-revision` that references the translated geometry. A unique suppliedId/suppliedRevisionId combination will create a new part and new part revision. For instance, sending my-part-id/my-revision-id will create a new part and new revision with those corresponding supplied ids. To create a new revision for `my-part-id`, likewise you can invoke this endpoint with a new revision id: `my-part-id/my-new-revision-id` and a new revision will be created for the existing part. See our [Import Data](https://developer.vertexvis.com/docs/guides/import-data-with-api) guides for more information.
|
|
3370
3370
|
* @param {PartsApiCreatePartRequest} requestParameters Request parameters.
|
|
3371
3371
|
* @param {*} [options] Override http request option.
|
|
3372
3372
|
* @throws {RequiredError}
|
|
@@ -3801,10 +3801,12 @@ export const SceneItemOverridesApiAxiosParamCreator = function (configuration) {
|
|
|
3801
3801
|
/**
|
|
3802
3802
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
3803
3803
|
* @param {string} id The `scene-view` ID.
|
|
3804
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3805
|
+
* @param {number} [pageSize] The number of items to return.
|
|
3804
3806
|
* @param {*} [options] Override http request option.
|
|
3805
3807
|
* @throws {RequiredError}
|
|
3806
3808
|
*/
|
|
3807
|
-
getSceneItemOverrides: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
3809
|
+
getSceneItemOverrides: (id, pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
3808
3810
|
// verify required parameter 'id' is not null or undefined
|
|
3809
3811
|
assertParamExists('getSceneItemOverrides', 'id', id);
|
|
3810
3812
|
const localVarPath = `/scene-views/{id}/scene-item-overrides`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
@@ -3820,6 +3822,12 @@ export const SceneItemOverridesApiAxiosParamCreator = function (configuration) {
|
|
|
3820
3822
|
// authentication OAuth2 required
|
|
3821
3823
|
// oauth required
|
|
3822
3824
|
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
3825
|
+
if (pageCursor !== undefined) {
|
|
3826
|
+
localVarQueryParameter['page[cursor]'] = pageCursor;
|
|
3827
|
+
}
|
|
3828
|
+
if (pageSize !== undefined) {
|
|
3829
|
+
localVarQueryParameter['page[size]'] = pageSize;
|
|
3830
|
+
}
|
|
3823
3831
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3824
3832
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3825
3833
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -3900,12 +3908,14 @@ export const SceneItemOverridesApiFp = function (configuration) {
|
|
|
3900
3908
|
/**
|
|
3901
3909
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
3902
3910
|
* @param {string} id The `scene-view` ID.
|
|
3911
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3912
|
+
* @param {number} [pageSize] The number of items to return.
|
|
3903
3913
|
* @param {*} [options] Override http request option.
|
|
3904
3914
|
* @throws {RequiredError}
|
|
3905
3915
|
*/
|
|
3906
|
-
getSceneItemOverrides(id, options) {
|
|
3916
|
+
getSceneItemOverrides(id, pageCursor, pageSize, options) {
|
|
3907
3917
|
return __awaiter(this, void 0, void 0, function* () {
|
|
3908
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneItemOverrides(id, options);
|
|
3918
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneItemOverrides(id, pageCursor, pageSize, options);
|
|
3909
3919
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
3910
3920
|
});
|
|
3911
3921
|
},
|
|
@@ -3957,12 +3967,14 @@ export const SceneItemOverridesApiFactory = function (configuration, basePath, a
|
|
|
3957
3967
|
/**
|
|
3958
3968
|
* Get `scene-item-overrides` for a `scene-view`.
|
|
3959
3969
|
* @param {string} id The `scene-view` ID.
|
|
3970
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
3971
|
+
* @param {number} [pageSize] The number of items to return.
|
|
3960
3972
|
* @param {*} [options] Override http request option.
|
|
3961
3973
|
* @throws {RequiredError}
|
|
3962
3974
|
*/
|
|
3963
|
-
getSceneItemOverrides(id, options) {
|
|
3975
|
+
getSceneItemOverrides(id, pageCursor, pageSize, options) {
|
|
3964
3976
|
return localVarFp
|
|
3965
|
-
.getSceneItemOverrides(id, options)
|
|
3977
|
+
.getSceneItemOverrides(id, pageCursor, pageSize, options)
|
|
3966
3978
|
.then((request) => request(axios, basePath));
|
|
3967
3979
|
},
|
|
3968
3980
|
/**
|
|
@@ -4019,7 +4031,7 @@ export class SceneItemOverridesApi extends BaseAPI {
|
|
|
4019
4031
|
*/
|
|
4020
4032
|
getSceneItemOverrides(requestParameters, options) {
|
|
4021
4033
|
return SceneItemOverridesApiFp(this.configuration)
|
|
4022
|
-
.getSceneItemOverrides(requestParameters.id, options)
|
|
4034
|
+
.getSceneItemOverrides(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, options)
|
|
4023
4035
|
.then((request) => request(this.axios, this.basePath));
|
|
4024
4036
|
}
|
|
4025
4037
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/// <reference types="node" />
|
|
2
2
|
import { AxiosResponse } from 'axios';
|
|
3
|
-
import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, PartData, PartRevisionData, QueuedJob } from '../../index';
|
|
3
|
+
import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, Part, PartData, PartRevisionData, QueuedJob } from '../../index';
|
|
4
4
|
import { BaseReq, DeleteReq, Polling, RenderImageReq } from '../index';
|
|
5
5
|
/** Create parts from file arguments. */
|
|
6
6
|
export interface CreatePartFromFileReq extends BaseReq {
|
|
@@ -24,7 +24,7 @@ export interface CreatePartFromFileRes {
|
|
|
24
24
|
}
|
|
25
25
|
export interface QueuedTranslation {
|
|
26
26
|
readonly req: CreatePartRequest | CreateGeometrySetRequest;
|
|
27
|
-
readonly res?: Failure | QueuedJob;
|
|
27
|
+
readonly res?: Failure | QueuedJob | Part;
|
|
28
28
|
}
|
|
29
29
|
/** Get part revision by supplied ID arguments. */
|
|
30
30
|
export interface GetPartRevisionBySuppliedIdReq extends BaseReq {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.
|
|
1
|
+
export declare const version = "0.20.0";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export const version = '0.
|
|
1
|
+
export const version = '0.20.0';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vertexvis/api-client-node",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.20.0",
|
|
4
4
|
"description": "The Vertex REST API client for Node.js.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"typescript"
|
|
34
34
|
],
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"axios": "^0.
|
|
36
|
+
"axios": "^0.27.2",
|
|
37
37
|
"p-limit": "^3"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|