@vertexvis/api-client-node 0.20.6 → 0.20.8

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/esm/api.d.ts CHANGED
@@ -1126,6 +1126,12 @@ export interface CreatePartRequestDataAttributes {
1126
1126
  * @memberof CreatePartRequestDataAttributes
1127
1127
  */
1128
1128
  name?: string;
1129
+ /**
1130
+ * Optional name to be used for the part revision.
1131
+ * @type {string}
1132
+ * @memberof CreatePartRequestDataAttributes
1133
+ */
1134
+ revisionName?: string;
1129
1135
  /**
1130
1136
  * Metadata key used to extract an ID used for correlation.
1131
1137
  * @type {string}
@@ -1485,6 +1491,14 @@ export interface CreateSceneRequestDataAttributes {
1485
1491
  * @memberof CreateSceneRequestDataAttributes
1486
1492
  */
1487
1493
  worldOrientation?: Orientation;
1494
+ /**
1495
+ *
1496
+ * @type {{ [key: string]: string; }}
1497
+ * @memberof CreateSceneRequestDataAttributes
1498
+ */
1499
+ metadata?: {
1500
+ [key: string]: string;
1501
+ };
1488
1502
  }
1489
1503
  /**
1490
1504
  *
@@ -3113,6 +3127,12 @@ export interface PartRevisionDataAttributes {
3113
3127
  * @memberof PartRevisionDataAttributes
3114
3128
  */
3115
3129
  suppliedId?: string;
3130
+ /**
3131
+ *
3132
+ * @type {string}
3133
+ * @memberof PartRevisionDataAttributes
3134
+ */
3135
+ name?: string;
3116
3136
  }
3117
3137
  /**
3118
3138
  *
@@ -3502,6 +3522,122 @@ export interface QueuedJobList {
3502
3522
  [key: string]: Link;
3503
3523
  };
3504
3524
  }
3525
+ /**
3526
+ *
3527
+ * @export
3528
+ * @interface QueuedTranslationJob
3529
+ */
3530
+ export interface QueuedTranslationJob {
3531
+ /**
3532
+ *
3533
+ * @type {QueuedTranslationJobData}
3534
+ * @memberof QueuedTranslationJob
3535
+ */
3536
+ data: QueuedTranslationJobData;
3537
+ /**
3538
+ *
3539
+ * @type {Array<GeometrySetData | PartRevisionData>}
3540
+ * @memberof QueuedTranslationJob
3541
+ */
3542
+ included?: Array<GeometrySetData | PartRevisionData>;
3543
+ /**
3544
+ *
3545
+ * @type {{ [key: string]: Link; }}
3546
+ * @memberof QueuedTranslationJob
3547
+ */
3548
+ links?: {
3549
+ [key: string]: Link;
3550
+ };
3551
+ }
3552
+ /**
3553
+ *
3554
+ * @export
3555
+ * @interface QueuedTranslationJobData
3556
+ */
3557
+ export interface QueuedTranslationJobData {
3558
+ /**
3559
+ *
3560
+ * @type {string}
3561
+ * @memberof QueuedTranslationJobData
3562
+ */
3563
+ type: string;
3564
+ /**
3565
+ * ID of the resource.
3566
+ * @type {string}
3567
+ * @memberof QueuedTranslationJobData
3568
+ */
3569
+ id: string;
3570
+ /**
3571
+ *
3572
+ * @type {QueuedTranslationJobDataAttributes}
3573
+ * @memberof QueuedTranslationJobData
3574
+ */
3575
+ attributes: QueuedTranslationJobDataAttributes;
3576
+ /**
3577
+ *
3578
+ * @type {QueuedTranslationJobDataRelationships}
3579
+ * @memberof QueuedTranslationJobData
3580
+ */
3581
+ relationships?: QueuedTranslationJobDataRelationships;
3582
+ /**
3583
+ *
3584
+ * @type {{ [key: string]: Link; }}
3585
+ * @memberof QueuedTranslationJobData
3586
+ */
3587
+ links?: {
3588
+ [key: string]: Link;
3589
+ };
3590
+ }
3591
+ /**
3592
+ *
3593
+ * @export
3594
+ * @interface QueuedTranslationJobDataAttributes
3595
+ */
3596
+ export interface QueuedTranslationJobDataAttributes {
3597
+ /**
3598
+ *
3599
+ * @type {string}
3600
+ * @memberof QueuedTranslationJobDataAttributes
3601
+ */
3602
+ status: string;
3603
+ /**
3604
+ *
3605
+ * @type {string}
3606
+ * @memberof QueuedTranslationJobDataAttributes
3607
+ */
3608
+ created: string;
3609
+ /**
3610
+ *
3611
+ * @type {string}
3612
+ * @memberof QueuedTranslationJobDataAttributes
3613
+ */
3614
+ completed?: string;
3615
+ /**
3616
+ *
3617
+ * @type {Set<ApiError>}
3618
+ * @memberof QueuedTranslationJobDataAttributes
3619
+ */
3620
+ errors?: Set<ApiError>;
3621
+ }
3622
+ /**
3623
+ *
3624
+ * @export
3625
+ * @interface QueuedTranslationJobDataRelationships
3626
+ */
3627
+ export interface QueuedTranslationJobDataRelationships {
3628
+ /**
3629
+ *
3630
+ * @type {GeometrySetRelationship}
3631
+ * @memberof QueuedTranslationJobDataRelationships
3632
+ */
3633
+ geometrySet?: GeometrySetRelationship;
3634
+ /**
3635
+ *
3636
+ * @type {PartRevisionRelationship}
3637
+ * @memberof QueuedTranslationJobDataRelationships
3638
+ */
3639
+ partRevision?: PartRevisionRelationship;
3640
+ }
3505
3641
  /**
3506
3642
  *
3507
3643
  * @export
@@ -3787,6 +3923,14 @@ export interface SceneDataAttributes {
3787
3923
  * @memberof SceneDataAttributes
3788
3924
  */
3789
3925
  sceneItemCount?: number;
3926
+ /**
3927
+ *
3928
+ * @type {{ [key: string]: string; }}
3929
+ * @memberof SceneDataAttributes
3930
+ */
3931
+ metadata?: {
3932
+ [key: string]: string;
3933
+ };
3790
3934
  }
3791
3935
  /**
3792
3936
  *
@@ -5206,6 +5350,14 @@ export interface UpdateSceneRequestDataAttributes {
5206
5350
  * @memberof UpdateSceneRequestDataAttributes
5207
5351
  */
5208
5352
  worldOrientation?: Orientation;
5353
+ /**
5354
+ *
5355
+ * @type {{ [key: string]: string; }}
5356
+ * @memberof UpdateSceneRequestDataAttributes
5357
+ */
5358
+ metadata?: {
5359
+ [key: string]: string;
5360
+ };
5209
5361
  }
5210
5362
  export declare const UpdateSceneRequestDataAttributesStateEnum: {
5211
5363
  readonly Draft: "draft";
@@ -8526,7 +8678,7 @@ export declare const SceneItemsApiAxiosParamCreator: (configuration?: Configurat
8526
8678
  /**
8527
8679
  * Get a `scene-item` by ID.
8528
8680
  * @param {string} id The &#x60;scene-item&#x60; ID.
8529
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
8681
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
8530
8682
  * @param {*} [options] Override http request option.
8531
8683
  * @throws {RequiredError}
8532
8684
  */
@@ -8589,7 +8741,7 @@ export declare const SceneItemsApiFp: (configuration?: Configuration | undefined
8589
8741
  /**
8590
8742
  * Get a `scene-item` by ID.
8591
8743
  * @param {string} id The &#x60;scene-item&#x60; ID.
8592
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
8744
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
8593
8745
  * @param {*} [options] Override http request option.
8594
8746
  * @throws {RequiredError}
8595
8747
  */
@@ -8652,7 +8804,7 @@ export declare const SceneItemsApiFactory: (configuration?: Configuration | unde
8652
8804
  /**
8653
8805
  * Get a `scene-item` by ID.
8654
8806
  * @param {string} id The &#x60;scene-item&#x60; ID.
8655
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
8807
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
8656
8808
  * @param {*} [options] Override http request option.
8657
8809
  * @throws {RequiredError}
8658
8810
  */
@@ -8749,7 +8901,7 @@ export interface SceneItemsApiGetSceneItemRequest {
8749
8901
  */
8750
8902
  readonly id: string;
8751
8903
  /**
8752
- * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
8904
+ * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
8753
8905
  * @type {string}
8754
8906
  * @memberof SceneItemsApiGetSceneItem
8755
8907
  */
@@ -9229,7 +9381,7 @@ export declare const SceneViewsApiAxiosParamCreator: (configuration?: Configurat
9229
9381
  * Get a `scene-item` within a view by ID.
9230
9382
  * @param {string} id The &#x60;scene-view&#x60; ID.
9231
9383
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
9232
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9384
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9233
9385
  * @param {string} [include] Comma-separated list of relationships to include in response.
9234
9386
  * @param {*} [options] Override http request option.
9235
9387
  * @throws {RequiredError}
@@ -9293,7 +9445,7 @@ export declare const SceneViewsApiFp: (configuration?: Configuration | undefined
9293
9445
  * Get a `scene-item` within a view by ID.
9294
9446
  * @param {string} id The &#x60;scene-view&#x60; ID.
9295
9447
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
9296
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9448
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9297
9449
  * @param {string} [include] Comma-separated list of relationships to include in response.
9298
9450
  * @param {*} [options] Override http request option.
9299
9451
  * @throws {RequiredError}
@@ -9357,7 +9509,7 @@ export declare const SceneViewsApiFactory: (configuration?: Configuration | unde
9357
9509
  * Get a `scene-item` within a view by ID.
9358
9510
  * @param {string} id The &#x60;scene-view&#x60; ID.
9359
9511
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
9360
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9512
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9361
9513
  * @param {string} [include] Comma-separated list of relationships to include in response.
9362
9514
  * @param {*} [options] Override http request option.
9363
9515
  * @throws {RequiredError}
@@ -9470,7 +9622,7 @@ export interface SceneViewsApiGetViewSceneItemRequest {
9470
9622
  */
9471
9623
  readonly itemId: string;
9472
9624
  /**
9473
- * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9625
+ * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9474
9626
  * @type {string}
9475
9627
  * @memberof SceneViewsApiGetViewSceneItem
9476
9628
  */
@@ -9619,7 +9771,7 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
9619
9771
  /**
9620
9772
  * Get a `scene` by ID.
9621
9773
  * @param {string} id The &#x60;scene&#x60; ID.
9622
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9774
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9623
9775
  * @param {*} [options] Override http request option.
9624
9776
  * @throws {RequiredError}
9625
9777
  */
@@ -9630,10 +9782,11 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
9630
9782
  * @param {number} [pageSize] The number of items to return.
9631
9783
  * @param {string} [filterName] Comma-separated list of names to filter on.
9632
9784
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9785
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9633
9786
  * @param {*} [options] Override http request option.
9634
9787
  * @throws {RequiredError}
9635
9788
  */
9636
- getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9789
+ getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9637
9790
  /**
9638
9791
  * Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
9639
9792
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9681,7 +9834,7 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9681
9834
  /**
9682
9835
  * Get a `scene` by ID.
9683
9836
  * @param {string} id The &#x60;scene&#x60; ID.
9684
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9837
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9685
9838
  * @param {*} [options] Override http request option.
9686
9839
  * @throws {RequiredError}
9687
9840
  */
@@ -9692,10 +9845,11 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9692
9845
  * @param {number} [pageSize] The number of items to return.
9693
9846
  * @param {string} [filterName] Comma-separated list of names to filter on.
9694
9847
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9848
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9695
9849
  * @param {*} [options] Override http request option.
9696
9850
  * @throws {RequiredError}
9697
9851
  */
9698
- getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
9852
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
9699
9853
  /**
9700
9854
  * Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
9701
9855
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9743,7 +9897,7 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9743
9897
  /**
9744
9898
  * Get a `scene` by ID.
9745
9899
  * @param {string} id The &#x60;scene&#x60; ID.
9746
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9900
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9747
9901
  * @param {*} [options] Override http request option.
9748
9902
  * @throws {RequiredError}
9749
9903
  */
@@ -9754,10 +9908,11 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9754
9908
  * @param {number} [pageSize] The number of items to return.
9755
9909
  * @param {string} [filterName] Comma-separated list of names to filter on.
9756
9910
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9911
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9757
9912
  * @param {*} [options] Override http request option.
9758
9913
  * @throws {RequiredError}
9759
9914
  */
9760
- getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<SceneList>;
9915
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: any): AxiosPromise<SceneList>;
9761
9916
  /**
9762
9917
  * Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
9763
9918
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9828,7 +9983,7 @@ export interface ScenesApiGetSceneRequest {
9828
9983
  */
9829
9984
  readonly id: string;
9830
9985
  /**
9831
- * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9986
+ * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9832
9987
  * @type {string}
9833
9988
  * @memberof ScenesApiGetScene
9834
9989
  */
@@ -9864,6 +10019,12 @@ export interface ScenesApiGetScenesRequest {
9864
10019
  * @memberof ScenesApiGetScenes
9865
10020
  */
9866
10021
  readonly filterSuppliedId?: string;
10022
+ /**
10023
+ * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
10024
+ * @type {string}
10025
+ * @memberof ScenesApiGetScenes
10026
+ */
10027
+ readonly fieldsScene?: string;
9867
10028
  }
9868
10029
  /**
9869
10030
  * Request parameters for renderScene operation in ScenesApi.
@@ -10178,6 +10339,13 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
10178
10339
  * @throws {RequiredError}
10179
10340
  */
10180
10341
  getQueuedTranslation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10342
+ /**
10343
+ * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
10344
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
10345
+ * @param {*} [options] Override http request option.
10346
+ * @throws {RequiredError}
10347
+ */
10348
+ getQueuedTranslationJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10181
10349
  /**
10182
10350
  * Get `queued-translation`s.
10183
10351
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -10214,6 +10382,13 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
10214
10382
  * @throws {RequiredError}
10215
10383
  */
10216
10384
  getQueuedTranslation(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
10385
+ /**
10386
+ * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
10387
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
10388
+ * @param {*} [options] Override http request option.
10389
+ * @throws {RequiredError}
10390
+ */
10391
+ getQueuedTranslationJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedTranslationJob>>;
10217
10392
  /**
10218
10393
  * Get `queued-translation`s.
10219
10394
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -10250,6 +10425,13 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
10250
10425
  * @throws {RequiredError}
10251
10426
  */
10252
10427
  getQueuedTranslation(id: string, options?: any): AxiosPromise<QueuedJob>;
10428
+ /**
10429
+ * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
10430
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
10431
+ * @param {*} [options] Override http request option.
10432
+ * @throws {RequiredError}
10433
+ */
10434
+ getQueuedTranslationJob(id: string, options?: any): AxiosPromise<QueuedTranslationJob>;
10253
10435
  /**
10254
10436
  * Get `queued-translation`s.
10255
10437
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -10299,6 +10481,19 @@ export interface TranslationInspectionsApiGetQueuedTranslationRequest {
10299
10481
  */
10300
10482
  readonly id: string;
10301
10483
  }
10484
+ /**
10485
+ * Request parameters for getQueuedTranslationJob operation in TranslationInspectionsApi.
10486
+ * @export
10487
+ * @interface TranslationInspectionsApiGetQueuedTranslationJobRequest
10488
+ */
10489
+ export interface TranslationInspectionsApiGetQueuedTranslationJobRequest {
10490
+ /**
10491
+ * The &#x60;queued-translation&#x60; ID.
10492
+ * @type {string}
10493
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJob
10494
+ */
10495
+ readonly id: string;
10496
+ }
10302
10497
  /**
10303
10498
  * Request parameters for getQueuedTranslations operation in TranslationInspectionsApi.
10304
10499
  * @export
@@ -10355,6 +10550,14 @@ export declare class TranslationInspectionsApi extends BaseAPI {
10355
10550
  * @memberof TranslationInspectionsApi
10356
10551
  */
10357
10552
  getQueuedTranslation(requestParameters: TranslationInspectionsApiGetQueuedTranslationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
10553
+ /**
10554
+ * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
10555
+ * @param {TranslationInspectionsApiGetQueuedTranslationJobRequest} requestParameters Request parameters.
10556
+ * @param {*} [options] Override http request option.
10557
+ * @throws {RequiredError}
10558
+ * @memberof TranslationInspectionsApi
10559
+ */
10560
+ getQueuedTranslationJob(requestParameters: TranslationInspectionsApiGetQueuedTranslationJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedTranslationJob, any>>;
10358
10561
  /**
10359
10562
  * Get `queued-translation`s.
10360
10563
  * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
package/dist/esm/api.js CHANGED
@@ -4174,7 +4174,7 @@ export const SceneItemsApiAxiosParamCreator = function (configuration) {
4174
4174
  /**
4175
4175
  * Get a `scene-item` by ID.
4176
4176
  * @param {string} id The &#x60;scene-item&#x60; ID.
4177
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
4177
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
4178
4178
  * @param {*} [options] Override http request option.
4179
4179
  * @throws {RequiredError}
4180
4180
  */
@@ -4351,7 +4351,7 @@ export const SceneItemsApiFp = function (configuration) {
4351
4351
  /**
4352
4352
  * Get a `scene-item` by ID.
4353
4353
  * @param {string} id The &#x60;scene-item&#x60; ID.
4354
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
4354
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
4355
4355
  * @param {*} [options] Override http request option.
4356
4356
  * @throws {RequiredError}
4357
4357
  */
@@ -4448,7 +4448,7 @@ export const SceneItemsApiFactory = function (configuration, basePath, axios) {
4448
4448
  /**
4449
4449
  * Get a `scene-item` by ID.
4450
4450
  * @param {string} id The &#x60;scene-item&#x60; ID.
4451
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
4451
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
4452
4452
  * @param {*} [options] Override http request option.
4453
4453
  * @throws {RequiredError}
4454
4454
  */
@@ -5133,7 +5133,7 @@ export const SceneViewsApiAxiosParamCreator = function (configuration) {
5133
5133
  * Get a `scene-item` within a view by ID.
5134
5134
  * @param {string} id The &#x60;scene-view&#x60; ID.
5135
5135
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
5136
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5136
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5137
5137
  * @param {string} [include] Comma-separated list of relationships to include in response.
5138
5138
  * @param {*} [options] Override http request option.
5139
5139
  * @throws {RequiredError}
@@ -5309,7 +5309,7 @@ export const SceneViewsApiFp = function (configuration) {
5309
5309
  * Get a `scene-item` within a view by ID.
5310
5310
  * @param {string} id The &#x60;scene-view&#x60; ID.
5311
5311
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
5312
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5312
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5313
5313
  * @param {string} [include] Comma-separated list of relationships to include in response.
5314
5314
  * @param {*} [options] Override http request option.
5315
5315
  * @throws {RequiredError}
@@ -5407,7 +5407,7 @@ export const SceneViewsApiFactory = function (configuration, basePath, axios) {
5407
5407
  * Get a `scene-item` within a view by ID.
5408
5408
  * @param {string} id The &#x60;scene-view&#x60; ID.
5409
5409
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
5410
- * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5410
+ * @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;boundingBox&#x60;, &#x60;worldTransform&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5411
5411
  * @param {string} [include] Comma-separated list of relationships to include in response.
5412
5412
  * @param {*} [options] Override http request option.
5413
5413
  * @throws {RequiredError}
@@ -5637,7 +5637,7 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
5637
5637
  /**
5638
5638
  * Get a `scene` by ID.
5639
5639
  * @param {string} id The &#x60;scene&#x60; ID.
5640
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
5640
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5641
5641
  * @param {*} [options] Override http request option.
5642
5642
  * @throws {RequiredError}
5643
5643
  */
@@ -5674,10 +5674,11 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
5674
5674
  * @param {number} [pageSize] The number of items to return.
5675
5675
  * @param {string} [filterName] Comma-separated list of names to filter on.
5676
5676
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5677
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5677
5678
  * @param {*} [options] Override http request option.
5678
5679
  * @throws {RequiredError}
5679
5680
  */
5680
- getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
5681
+ getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options = {}) => __awaiter(this, void 0, void 0, function* () {
5681
5682
  const localVarPath = `/scenes`;
5682
5683
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5683
5684
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5703,6 +5704,9 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
5703
5704
  if (filterSuppliedId !== undefined) {
5704
5705
  localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
5705
5706
  }
5707
+ if (fieldsScene !== undefined) {
5708
+ localVarQueryParameter['fields[scene]'] = fieldsScene;
5709
+ }
5706
5710
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5707
5711
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5708
5712
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -5832,7 +5836,7 @@ export const ScenesApiFp = function (configuration) {
5832
5836
  /**
5833
5837
  * Get a `scene` by ID.
5834
5838
  * @param {string} id The &#x60;scene&#x60; ID.
5835
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
5839
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5836
5840
  * @param {*} [options] Override http request option.
5837
5841
  * @throws {RequiredError}
5838
5842
  */
@@ -5848,12 +5852,13 @@ export const ScenesApiFp = function (configuration) {
5848
5852
  * @param {number} [pageSize] The number of items to return.
5849
5853
  * @param {string} [filterName] Comma-separated list of names to filter on.
5850
5854
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5855
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5851
5856
  * @param {*} [options] Override http request option.
5852
5857
  * @throws {RequiredError}
5853
5858
  */
5854
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
5859
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
5855
5860
  return __awaiter(this, void 0, void 0, function* () {
5856
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options);
5861
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options);
5857
5862
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
5858
5863
  });
5859
5864
  },
@@ -5929,7 +5934,7 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
5929
5934
  /**
5930
5935
  * Get a `scene` by ID.
5931
5936
  * @param {string} id The &#x60;scene&#x60; ID.
5932
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
5937
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5933
5938
  * @param {*} [options] Override http request option.
5934
5939
  * @throws {RequiredError}
5935
5940
  */
@@ -5944,12 +5949,13 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
5944
5949
  * @param {number} [pageSize] The number of items to return.
5945
5950
  * @param {string} [filterName] Comma-separated list of names to filter on.
5946
5951
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5952
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5947
5953
  * @param {*} [options] Override http request option.
5948
5954
  * @throws {RequiredError}
5949
5955
  */
5950
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
5956
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
5951
5957
  return localVarFp
5952
- .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options)
5958
+ .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options)
5953
5959
  .then((request) => request(axios, basePath));
5954
5960
  },
5955
5961
  /**
@@ -6043,7 +6049,7 @@ export class ScenesApi extends BaseAPI {
6043
6049
  */
6044
6050
  getScenes(requestParameters = {}, options) {
6045
6051
  return ScenesApiFp(this.configuration)
6046
- .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, options)
6052
+ .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, options)
6047
6053
  .then((request) => request(this.axios, this.basePath));
6048
6054
  }
6049
6055
  /**
@@ -6418,6 +6424,36 @@ export const TranslationInspectionsApiAxiosParamCreator = function (configuratio
6418
6424
  options: localVarRequestOptions,
6419
6425
  };
6420
6426
  }),
6427
+ /**
6428
+ * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
6429
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
6430
+ * @param {*} [options] Override http request option.
6431
+ * @throws {RequiredError}
6432
+ */
6433
+ getQueuedTranslationJob: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
6434
+ // verify required parameter 'id' is not null or undefined
6435
+ assertParamExists('getQueuedTranslationJob', 'id', id);
6436
+ const localVarPath = `/queued-translation-jobs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
6437
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6438
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6439
+ let baseOptions;
6440
+ if (configuration) {
6441
+ baseOptions = configuration.baseOptions;
6442
+ }
6443
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
6444
+ const localVarHeaderParameter = {};
6445
+ const localVarQueryParameter = {};
6446
+ // authentication OAuth2 required
6447
+ // oauth required
6448
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
6449
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6450
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6451
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
6452
+ return {
6453
+ url: toPathString(localVarUrlObj),
6454
+ options: localVarRequestOptions,
6455
+ };
6456
+ }),
6421
6457
  /**
6422
6458
  * Get `queued-translation`s.
6423
6459
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -6502,6 +6538,18 @@ export const TranslationInspectionsApiFp = function (configuration) {
6502
6538
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
6503
6539
  });
6504
6540
  },
6541
+ /**
6542
+ * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
6543
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
6544
+ * @param {*} [options] Override http request option.
6545
+ * @throws {RequiredError}
6546
+ */
6547
+ getQueuedTranslationJob(id, options) {
6548
+ return __awaiter(this, void 0, void 0, function* () {
6549
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedTranslationJob(id, options);
6550
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
6551
+ });
6552
+ },
6505
6553
  /**
6506
6554
  * Get `queued-translation`s.
6507
6555
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -6558,6 +6606,17 @@ export const TranslationInspectionsApiFactory = function (configuration, basePat
6558
6606
  .getQueuedTranslation(id, options)
6559
6607
  .then((request) => request(axios, basePath));
6560
6608
  },
6609
+ /**
6610
+ * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
6611
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
6612
+ * @param {*} [options] Override http request option.
6613
+ * @throws {RequiredError}
6614
+ */
6615
+ getQueuedTranslationJob(id, options) {
6616
+ return localVarFp
6617
+ .getQueuedTranslationJob(id, options)
6618
+ .then((request) => request(axios, basePath));
6619
+ },
6561
6620
  /**
6562
6621
  * Get `queued-translation`s.
6563
6622
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -6616,6 +6675,18 @@ export class TranslationInspectionsApi extends BaseAPI {
6616
6675
  .getQueuedTranslation(requestParameters.id, options)
6617
6676
  .then((request) => request(this.axios, this.basePath));
6618
6677
  }
6678
+ /**
6679
+ * Get a `queued-translation-job`. The response is either the status if `running` or `error` or, upon completion, the `part-revision` that was created. Once created, create scenes via the createScene API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
6680
+ * @param {TranslationInspectionsApiGetQueuedTranslationJobRequest} requestParameters Request parameters.
6681
+ * @param {*} [options] Override http request option.
6682
+ * @throws {RequiredError}
6683
+ * @memberof TranslationInspectionsApi
6684
+ */
6685
+ getQueuedTranslationJob(requestParameters, options) {
6686
+ return TranslationInspectionsApiFp(this.configuration)
6687
+ .getQueuedTranslationJob(requestParameters.id, options)
6688
+ .then((request) => request(this.axios, this.basePath));
6689
+ }
6619
6690
  /**
6620
6691
  * Get `queued-translation`s.
6621
6692
  * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.