@vertexvis/api-client-node 0.20.5 → 0.20.7

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 CHANGED
@@ -1114,11 +1114,11 @@ export interface CreatePartRequestDataAttributes {
1114
1114
  indexMetadata?: boolean;
1115
1115
  /**
1116
1116
  * Additional metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
1117
- * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
1117
+ * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
1118
1118
  * @memberof CreatePartRequestDataAttributes
1119
1119
  */
1120
1120
  metadata?: {
1121
- [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
1121
+ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
1122
1122
  };
1123
1123
  /**
1124
1124
  * Name to be used for the root part.
@@ -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}
@@ -1379,11 +1385,11 @@ export interface CreateSceneItemRequestDataAttributes {
1379
1385
  visible?: boolean;
1380
1386
  /**
1381
1387
  * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
1382
- * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
1388
+ * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
1383
1389
  * @memberof CreateSceneItemRequestDataAttributes
1384
1390
  */
1385
1391
  metadata?: {
1386
- [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
1392
+ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
1387
1393
  };
1388
1394
  }
1389
1395
  /**
@@ -1555,6 +1561,12 @@ export interface CreateSceneViewRequestDataAttributes {
1555
1561
  * @memberof CreateSceneViewRequestDataAttributes
1556
1562
  */
1557
1563
  crossSectioning?: CrossSectioning | null;
1564
+ /**
1565
+ * Whether to exclude non-visible items in the view
1566
+ * @type {boolean}
1567
+ * @memberof CreateSceneViewRequestDataAttributes
1568
+ */
1569
+ excludePrunedItems?: boolean;
1558
1570
  }
1559
1571
  /**
1560
1572
  *
@@ -1683,6 +1695,12 @@ export interface CreateStreamKeyRequestDataAttributes {
1683
1695
  * @memberof CreateStreamKeyRequestDataAttributes
1684
1696
  */
1685
1697
  expiry?: number;
1698
+ /**
1699
+ * Whether to exclude non-visible items in the view
1700
+ * @type {boolean}
1701
+ * @memberof CreateStreamKeyRequestDataAttributes
1702
+ */
1703
+ excludePrunedItems?: boolean;
1686
1704
  }
1687
1705
  /**
1688
1706
  *
@@ -2609,6 +2627,25 @@ export interface Matrix4Nullable {
2609
2627
  */
2610
2628
  r3: Vector4;
2611
2629
  }
2630
+ /**
2631
+ *
2632
+ * @export
2633
+ * @interface MetadataDateType
2634
+ */
2635
+ export interface MetadataDateType {
2636
+ /**
2637
+ * Type of metadata value.
2638
+ * @type {string}
2639
+ * @memberof MetadataDateType
2640
+ */
2641
+ type: string;
2642
+ /**
2643
+ * A date value.
2644
+ * @type {string}
2645
+ * @memberof MetadataDateType
2646
+ */
2647
+ value: string;
2648
+ }
2612
2649
  /**
2613
2650
  *
2614
2651
  * @export
@@ -2628,6 +2665,25 @@ export interface MetadataFloatType {
2628
2665
  */
2629
2666
  value: number;
2630
2667
  }
2668
+ /**
2669
+ *
2670
+ * @export
2671
+ * @interface MetadataLongType
2672
+ */
2673
+ export interface MetadataLongType {
2674
+ /**
2675
+ * Type of metadata value.
2676
+ * @type {string}
2677
+ * @memberof MetadataLongType
2678
+ */
2679
+ type: string;
2680
+ /**
2681
+ * A numerical long value.
2682
+ * @type {number}
2683
+ * @memberof MetadataLongType
2684
+ */
2685
+ value: number;
2686
+ }
2631
2687
  /**
2632
2688
  *
2633
2689
  * @export
@@ -2826,11 +2882,11 @@ export interface PartAssemblyRelationshipData {
2826
2882
  children: Array<PartRevisionInstance>;
2827
2883
  /**
2828
2884
  * Additional metadata about the `part` and/or `part-revision`.
2829
- * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
2885
+ * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
2830
2886
  * @memberof PartAssemblyRelationshipData
2831
2887
  */
2832
2888
  metadata?: {
2833
- [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
2889
+ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
2834
2890
  };
2835
2891
  }
2836
2892
  /**
@@ -3051,11 +3107,11 @@ export interface PartRevisionDataAttributes {
3051
3107
  created?: string;
3052
3108
  /**
3053
3109
  *
3054
- * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
3110
+ * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
3055
3111
  * @memberof PartRevisionDataAttributes
3056
3112
  */
3057
3113
  metadata?: {
3058
- [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
3114
+ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
3059
3115
  };
3060
3116
  /**
3061
3117
  *
@@ -3063,6 +3119,12 @@ export interface PartRevisionDataAttributes {
3063
3119
  * @memberof PartRevisionDataAttributes
3064
3120
  */
3065
3121
  suppliedId?: string;
3122
+ /**
3123
+ *
3124
+ * @type {string}
3125
+ * @memberof PartRevisionDataAttributes
3126
+ */
3127
+ name?: string;
3066
3128
  }
3067
3129
  /**
3068
3130
  *
@@ -3452,6 +3514,122 @@ export interface QueuedJobList {
3452
3514
  [key: string]: Link;
3453
3515
  };
3454
3516
  }
3517
+ /**
3518
+ *
3519
+ * @export
3520
+ * @interface QueuedTranslationJob
3521
+ */
3522
+ export interface QueuedTranslationJob {
3523
+ /**
3524
+ *
3525
+ * @type {QueuedTranslationJobData}
3526
+ * @memberof QueuedTranslationJob
3527
+ */
3528
+ data: QueuedTranslationJobData;
3529
+ /**
3530
+ *
3531
+ * @type {Array<GeometrySetData | PartRevisionData>}
3532
+ * @memberof QueuedTranslationJob
3533
+ */
3534
+ included?: Array<GeometrySetData | PartRevisionData>;
3535
+ /**
3536
+ *
3537
+ * @type {{ [key: string]: Link; }}
3538
+ * @memberof QueuedTranslationJob
3539
+ */
3540
+ links?: {
3541
+ [key: string]: Link;
3542
+ };
3543
+ }
3544
+ /**
3545
+ *
3546
+ * @export
3547
+ * @interface QueuedTranslationJobData
3548
+ */
3549
+ export interface QueuedTranslationJobData {
3550
+ /**
3551
+ *
3552
+ * @type {string}
3553
+ * @memberof QueuedTranslationJobData
3554
+ */
3555
+ type: string;
3556
+ /**
3557
+ * ID of the resource.
3558
+ * @type {string}
3559
+ * @memberof QueuedTranslationJobData
3560
+ */
3561
+ id: string;
3562
+ /**
3563
+ *
3564
+ * @type {QueuedTranslationJobDataAttributes}
3565
+ * @memberof QueuedTranslationJobData
3566
+ */
3567
+ attributes: QueuedTranslationJobDataAttributes;
3568
+ /**
3569
+ *
3570
+ * @type {QueuedTranslationJobDataRelationships}
3571
+ * @memberof QueuedTranslationJobData
3572
+ */
3573
+ relationships?: QueuedTranslationJobDataRelationships;
3574
+ /**
3575
+ *
3576
+ * @type {{ [key: string]: Link; }}
3577
+ * @memberof QueuedTranslationJobData
3578
+ */
3579
+ links?: {
3580
+ [key: string]: Link;
3581
+ };
3582
+ }
3583
+ /**
3584
+ *
3585
+ * @export
3586
+ * @interface QueuedTranslationJobDataAttributes
3587
+ */
3588
+ export interface QueuedTranslationJobDataAttributes {
3589
+ /**
3590
+ *
3591
+ * @type {string}
3592
+ * @memberof QueuedTranslationJobDataAttributes
3593
+ */
3594
+ status: string;
3595
+ /**
3596
+ *
3597
+ * @type {string}
3598
+ * @memberof QueuedTranslationJobDataAttributes
3599
+ */
3600
+ created: string;
3601
+ /**
3602
+ *
3603
+ * @type {string}
3604
+ * @memberof QueuedTranslationJobDataAttributes
3605
+ */
3606
+ completed?: string;
3607
+ /**
3608
+ *
3609
+ * @type {Set<ApiError>}
3610
+ * @memberof QueuedTranslationJobDataAttributes
3611
+ */
3612
+ errors?: Set<ApiError>;
3613
+ }
3614
+ /**
3615
+ *
3616
+ * @export
3617
+ * @interface QueuedTranslationJobDataRelationships
3618
+ */
3619
+ export interface QueuedTranslationJobDataRelationships {
3620
+ /**
3621
+ *
3622
+ * @type {GeometrySetRelationship}
3623
+ * @memberof QueuedTranslationJobDataRelationships
3624
+ */
3625
+ geometrySet?: GeometrySetRelationship;
3626
+ /**
3627
+ *
3628
+ * @type {PartRevisionRelationship}
3629
+ * @memberof QueuedTranslationJobDataRelationships
3630
+ */
3631
+ partRevision?: PartRevisionRelationship;
3632
+ }
3455
3633
  /**
3456
3634
  *
3457
3635
  * @export
@@ -3824,11 +4002,11 @@ export interface SceneItemDataAttributes {
3824
4002
  materialOverride?: ColorMaterial;
3825
4003
  /**
3826
4004
  *
3827
- * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
4005
+ * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
3828
4006
  * @memberof SceneItemDataAttributes
3829
4007
  */
3830
4008
  metadata?: {
3831
- [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
4009
+ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
3832
4010
  };
3833
4011
  /**
3834
4012
  *
@@ -4232,6 +4410,12 @@ export interface SceneViewDataAttributes {
4232
4410
  * @memberof SceneViewDataAttributes
4233
4411
  */
4234
4412
  worldOrientation?: Orientation;
4413
+ /**
4414
+ * Whether to exclude non-visible items in the view
4415
+ * @type {boolean}
4416
+ * @memberof SceneViewDataAttributes
4417
+ */
4418
+ excludePrunedItems?: boolean;
4235
4419
  }
4236
4420
  /**
4237
4421
  *
@@ -4521,12 +4705,6 @@ export interface SelectOperation {
4521
4705
  * @memberof SelectOperation
4522
4706
  */
4523
4707
  type: SelectOperationTypeEnum;
4524
- /**
4525
- *
4526
- * @type {ColorMaterial}
4527
- * @memberof SelectOperation
4528
- */
4529
- material: ColorMaterial;
4530
4708
  }
4531
4709
  export declare const SelectOperationTypeEnum: {
4532
4710
  readonly Select: "select";
@@ -4616,6 +4794,12 @@ export interface StreamKeyDataAttributes {
4616
4794
  * @memberof StreamKeyDataAttributes
4617
4795
  */
4618
4796
  created: string;
4797
+ /**
4798
+ *
4799
+ * @type {boolean}
4800
+ * @memberof StreamKeyDataAttributes
4801
+ */
4802
+ excludePrunedItems?: boolean;
4619
4803
  }
4620
4804
  /**
4621
4805
  *
@@ -4874,11 +5058,11 @@ export interface UpdatePartRevisionRequestData {
4874
5058
  export interface UpdatePartRevisionRequestDataAttributes {
4875
5059
  /**
4876
5060
  * Metadata about the `part` and/or `part-revision`. This metadata will take precedence over any metadata that belongs to the part file if `indexMetadata` is specified.
4877
- * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
5061
+ * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
4878
5062
  * @memberof UpdatePartRevisionRequestDataAttributes
4879
5063
  */
4880
5064
  metadata?: {
4881
- [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
5065
+ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
4882
5066
  };
4883
5067
  /**
4884
5068
  * Whether or not to index metadata in the part file when sending a file relationship - not used otherwise. To ignore metadata from the part file and add your own, pass `false` for `indexMetadata` and supply custom metadata using the `metadata` field.
@@ -5056,11 +5240,11 @@ export interface UpdateSceneItemRequestDataAttributes {
5056
5240
  suppliedId?: string;
5057
5241
  /**
5058
5242
  * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
5059
- * @type {{ [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType; }}
5243
+ * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
5060
5244
  * @memberof UpdateSceneItemRequestDataAttributes
5061
5245
  */
5062
5246
  metadata?: {
5063
- [key: string]: MetadataStringType | MetadataFloatType | MetadataNullType;
5247
+ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
5064
5248
  };
5065
5249
  }
5066
5250
  /**
@@ -5206,6 +5390,12 @@ export interface UpdateSceneViewRequestDataAttributes {
5206
5390
  * @memberof UpdateSceneViewRequestDataAttributes
5207
5391
  */
5208
5392
  crossSectioning?: CrossSectioning | null;
5393
+ /**
5394
+ * Whether or not to turn off default lighting
5395
+ * @type {boolean}
5396
+ * @memberof UpdateSceneViewRequestDataAttributes
5397
+ */
5398
+ noDefaultLights?: boolean;
5209
5399
  }
5210
5400
  /**
5211
5401
  *
@@ -8464,7 +8654,7 @@ export declare const SceneItemsApiAxiosParamCreator: (configuration?: Configurat
8464
8654
  /**
8465
8655
  * Get a `scene-item` by ID.
8466
8656
  * @param {string} id The &#x60;scene-item&#x60; ID.
8467
- * @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.
8657
+ * @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.
8468
8658
  * @param {*} [options] Override http request option.
8469
8659
  * @throws {RequiredError}
8470
8660
  */
@@ -8527,7 +8717,7 @@ export declare const SceneItemsApiFp: (configuration?: Configuration | undefined
8527
8717
  /**
8528
8718
  * Get a `scene-item` by ID.
8529
8719
  * @param {string} id The &#x60;scene-item&#x60; ID.
8530
- * @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.
8720
+ * @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.
8531
8721
  * @param {*} [options] Override http request option.
8532
8722
  * @throws {RequiredError}
8533
8723
  */
@@ -8590,7 +8780,7 @@ export declare const SceneItemsApiFactory: (configuration?: Configuration | unde
8590
8780
  /**
8591
8781
  * Get a `scene-item` by ID.
8592
8782
  * @param {string} id The &#x60;scene-item&#x60; ID.
8593
- * @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.
8783
+ * @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.
8594
8784
  * @param {*} [options] Override http request option.
8595
8785
  * @throws {RequiredError}
8596
8786
  */
@@ -8687,7 +8877,7 @@ export interface SceneItemsApiGetSceneItemRequest {
8687
8877
  */
8688
8878
  readonly id: string;
8689
8879
  /**
8690
- * 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.
8880
+ * 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.
8691
8881
  * @type {string}
8692
8882
  * @memberof SceneItemsApiGetSceneItem
8693
8883
  */
@@ -9167,7 +9357,7 @@ export declare const SceneViewsApiAxiosParamCreator: (configuration?: Configurat
9167
9357
  * Get a `scene-item` within a view by ID.
9168
9358
  * @param {string} id The &#x60;scene-view&#x60; ID.
9169
9359
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
9170
- * @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.
9360
+ * @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.
9171
9361
  * @param {string} [include] Comma-separated list of relationships to include in response.
9172
9362
  * @param {*} [options] Override http request option.
9173
9363
  * @throws {RequiredError}
@@ -9231,7 +9421,7 @@ export declare const SceneViewsApiFp: (configuration?: Configuration | undefined
9231
9421
  * Get a `scene-item` within a view by ID.
9232
9422
  * @param {string} id The &#x60;scene-view&#x60; ID.
9233
9423
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
9234
- * @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.
9424
+ * @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.
9235
9425
  * @param {string} [include] Comma-separated list of relationships to include in response.
9236
9426
  * @param {*} [options] Override http request option.
9237
9427
  * @throws {RequiredError}
@@ -9295,7 +9485,7 @@ export declare const SceneViewsApiFactory: (configuration?: Configuration | unde
9295
9485
  * Get a `scene-item` within a view by ID.
9296
9486
  * @param {string} id The &#x60;scene-view&#x60; ID.
9297
9487
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
9298
- * @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.
9488
+ * @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.
9299
9489
  * @param {string} [include] Comma-separated list of relationships to include in response.
9300
9490
  * @param {*} [options] Override http request option.
9301
9491
  * @throws {RequiredError}
@@ -9408,7 +9598,7 @@ export interface SceneViewsApiGetViewSceneItemRequest {
9408
9598
  */
9409
9599
  readonly itemId: string;
9410
9600
  /**
9411
- * 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.
9601
+ * 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.
9412
9602
  * @type {string}
9413
9603
  * @memberof SceneViewsApiGetViewSceneItem
9414
9604
  */
@@ -10116,6 +10306,13 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
10116
10306
  * @throws {RequiredError}
10117
10307
  */
10118
10308
  getQueuedTranslation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10309
+ /**
10310
+ * 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.
10311
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
10312
+ * @param {*} [options] Override http request option.
10313
+ * @throws {RequiredError}
10314
+ */
10315
+ getQueuedTranslationJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10119
10316
  /**
10120
10317
  * Get `queued-translation`s.
10121
10318
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -10152,6 +10349,13 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
10152
10349
  * @throws {RequiredError}
10153
10350
  */
10154
10351
  getQueuedTranslation(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
10352
+ /**
10353
+ * 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.
10354
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
10355
+ * @param {*} [options] Override http request option.
10356
+ * @throws {RequiredError}
10357
+ */
10358
+ getQueuedTranslationJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedTranslationJob>>;
10155
10359
  /**
10156
10360
  * Get `queued-translation`s.
10157
10361
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -10188,6 +10392,13 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
10188
10392
  * @throws {RequiredError}
10189
10393
  */
10190
10394
  getQueuedTranslation(id: string, options?: any): AxiosPromise<QueuedJob>;
10395
+ /**
10396
+ * 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.
10397
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
10398
+ * @param {*} [options] Override http request option.
10399
+ * @throws {RequiredError}
10400
+ */
10401
+ getQueuedTranslationJob(id: string, options?: any): AxiosPromise<QueuedTranslationJob>;
10191
10402
  /**
10192
10403
  * Get `queued-translation`s.
10193
10404
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -10237,6 +10448,19 @@ export interface TranslationInspectionsApiGetQueuedTranslationRequest {
10237
10448
  */
10238
10449
  readonly id: string;
10239
10450
  }
10451
+ /**
10452
+ * Request parameters for getQueuedTranslationJob operation in TranslationInspectionsApi.
10453
+ * @export
10454
+ * @interface TranslationInspectionsApiGetQueuedTranslationJobRequest
10455
+ */
10456
+ export interface TranslationInspectionsApiGetQueuedTranslationJobRequest {
10457
+ /**
10458
+ * The &#x60;queued-translation&#x60; ID.
10459
+ * @type {string}
10460
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJob
10461
+ */
10462
+ readonly id: string;
10463
+ }
10240
10464
  /**
10241
10465
  * Request parameters for getQueuedTranslations operation in TranslationInspectionsApi.
10242
10466
  * @export
@@ -10293,6 +10517,14 @@ export declare class TranslationInspectionsApi extends BaseAPI {
10293
10517
  * @memberof TranslationInspectionsApi
10294
10518
  */
10295
10519
  getQueuedTranslation(requestParameters: TranslationInspectionsApiGetQueuedTranslationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJob, any>>;
10520
+ /**
10521
+ * 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.
10522
+ * @param {TranslationInspectionsApiGetQueuedTranslationJobRequest} requestParameters Request parameters.
10523
+ * @param {*} [options] Override http request option.
10524
+ * @throws {RequiredError}
10525
+ * @memberof TranslationInspectionsApi
10526
+ */
10527
+ getQueuedTranslationJob(requestParameters: TranslationInspectionsApiGetQueuedTranslationJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedTranslationJob, any>>;
10296
10528
  /**
10297
10529
  * Get `queued-translation`s.
10298
10530
  * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
package/dist/cjs/api.js CHANGED
@@ -4230,7 +4230,7 @@ const SceneItemsApiAxiosParamCreator = function (configuration) {
4230
4230
  /**
4231
4231
  * Get a `scene-item` by ID.
4232
4232
  * @param {string} id The &#x60;scene-item&#x60; ID.
4233
- * @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.
4233
+ * @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.
4234
4234
  * @param {*} [options] Override http request option.
4235
4235
  * @throws {RequiredError}
4236
4236
  */
@@ -4408,7 +4408,7 @@ const SceneItemsApiFp = function (configuration) {
4408
4408
  /**
4409
4409
  * Get a `scene-item` by ID.
4410
4410
  * @param {string} id The &#x60;scene-item&#x60; ID.
4411
- * @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.
4411
+ * @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.
4412
4412
  * @param {*} [options] Override http request option.
4413
4413
  * @throws {RequiredError}
4414
4414
  */
@@ -4506,7 +4506,7 @@ const SceneItemsApiFactory = function (configuration, basePath, axios) {
4506
4506
  /**
4507
4507
  * Get a `scene-item` by ID.
4508
4508
  * @param {string} id The &#x60;scene-item&#x60; ID.
4509
- * @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.
4509
+ * @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.
4510
4510
  * @param {*} [options] Override http request option.
4511
4511
  * @throws {RequiredError}
4512
4512
  */
@@ -5197,7 +5197,7 @@ const SceneViewsApiAxiosParamCreator = function (configuration) {
5197
5197
  * Get a `scene-item` within a view by ID.
5198
5198
  * @param {string} id The &#x60;scene-view&#x60; ID.
5199
5199
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
5200
- * @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.
5200
+ * @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.
5201
5201
  * @param {string} [include] Comma-separated list of relationships to include in response.
5202
5202
  * @param {*} [options] Override http request option.
5203
5203
  * @throws {RequiredError}
@@ -5374,7 +5374,7 @@ const SceneViewsApiFp = function (configuration) {
5374
5374
  * Get a `scene-item` within a view by ID.
5375
5375
  * @param {string} id The &#x60;scene-view&#x60; ID.
5376
5376
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
5377
- * @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.
5377
+ * @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.
5378
5378
  * @param {string} [include] Comma-separated list of relationships to include in response.
5379
5379
  * @param {*} [options] Override http request option.
5380
5380
  * @throws {RequiredError}
@@ -5473,7 +5473,7 @@ const SceneViewsApiFactory = function (configuration, basePath, axios) {
5473
5473
  * Get a `scene-item` within a view by ID.
5474
5474
  * @param {string} id The &#x60;scene-view&#x60; ID.
5475
5475
  * @param {string} itemId The &#x60;scene-item&#x60; ID.
5476
- * @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.
5476
+ * @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.
5477
5477
  * @param {string} [include] Comma-separated list of relationships to include in response.
5478
5478
  * @param {*} [options] Override http request option.
5479
5479
  * @throws {RequiredError}
@@ -6494,6 +6494,36 @@ const TranslationInspectionsApiAxiosParamCreator = function (configuration) {
6494
6494
  options: localVarRequestOptions,
6495
6495
  };
6496
6496
  }),
6497
+ /**
6498
+ * 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.
6499
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
6500
+ * @param {*} [options] Override http request option.
6501
+ * @throws {RequiredError}
6502
+ */
6503
+ getQueuedTranslationJob: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
6504
+ // verify required parameter 'id' is not null or undefined
6505
+ (0, common_1.assertParamExists)('getQueuedTranslationJob', 'id', id);
6506
+ const localVarPath = `/queued-translation-jobs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
6507
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6508
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
6509
+ let baseOptions;
6510
+ if (configuration) {
6511
+ baseOptions = configuration.baseOptions;
6512
+ }
6513
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
6514
+ const localVarHeaderParameter = {};
6515
+ const localVarQueryParameter = {};
6516
+ // authentication OAuth2 required
6517
+ // oauth required
6518
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
6519
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
6520
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
6521
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
6522
+ return {
6523
+ url: (0, common_1.toPathString)(localVarUrlObj),
6524
+ options: localVarRequestOptions,
6525
+ };
6526
+ }),
6497
6527
  /**
6498
6528
  * Get `queued-translation`s.
6499
6529
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -6579,6 +6609,18 @@ const TranslationInspectionsApiFp = function (configuration) {
6579
6609
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
6580
6610
  });
6581
6611
  },
6612
+ /**
6613
+ * 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.
6614
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
6615
+ * @param {*} [options] Override http request option.
6616
+ * @throws {RequiredError}
6617
+ */
6618
+ getQueuedTranslationJob(id, options) {
6619
+ return __awaiter(this, void 0, void 0, function* () {
6620
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedTranslationJob(id, options);
6621
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
6622
+ });
6623
+ },
6582
6624
  /**
6583
6625
  * Get `queued-translation`s.
6584
6626
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -6636,6 +6678,17 @@ const TranslationInspectionsApiFactory = function (configuration, basePath, axio
6636
6678
  .getQueuedTranslation(id, options)
6637
6679
  .then((request) => request(axios, basePath));
6638
6680
  },
6681
+ /**
6682
+ * 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.
6683
+ * @param {string} id The &#x60;queued-translation&#x60; ID.
6684
+ * @param {*} [options] Override http request option.
6685
+ * @throws {RequiredError}
6686
+ */
6687
+ getQueuedTranslationJob(id, options) {
6688
+ return localVarFp
6689
+ .getQueuedTranslationJob(id, options)
6690
+ .then((request) => request(axios, basePath));
6691
+ },
6639
6692
  /**
6640
6693
  * Get `queued-translation`s.
6641
6694
  * @param {string} [pageCursor] The cursor for the next page of items.
@@ -6695,6 +6748,18 @@ class TranslationInspectionsApi extends base_1.BaseAPI {
6695
6748
  .getQueuedTranslation(requestParameters.id, options)
6696
6749
  .then((request) => request(this.axios, this.basePath));
6697
6750
  }
6751
+ /**
6752
+ * 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.
6753
+ * @param {TranslationInspectionsApiGetQueuedTranslationJobRequest} requestParameters Request parameters.
6754
+ * @param {*} [options] Override http request option.
6755
+ * @throws {RequiredError}
6756
+ * @memberof TranslationInspectionsApi
6757
+ */
6758
+ getQueuedTranslationJob(requestParameters, options) {
6759
+ return (0, exports.TranslationInspectionsApiFp)(this.configuration)
6760
+ .getQueuedTranslationJob(requestParameters.id, options)
6761
+ .then((request) => request(this.axios, this.basePath));
6762
+ }
6698
6763
  /**
6699
6764
  * Get `queued-translation`s.
6700
6765
  * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
@@ -1 +1 @@
1
- export declare const version = "0.20.5";
1
+ export declare const version = "0.20.7";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.version = void 0;
4
- exports.version = '0.20.5';
4
+ exports.version = '0.20.7';