@vertexvis/api-client-node 0.20.6 → 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 +178 -8
- package/dist/cjs/api.js +71 -6
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +178 -8
- package/dist/esm/api.js +71 -6
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/package.json +1 -1
package/dist/cjs/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}
|
|
@@ -3113,6 +3119,12 @@ export interface PartRevisionDataAttributes {
|
|
|
3113
3119
|
* @memberof PartRevisionDataAttributes
|
|
3114
3120
|
*/
|
|
3115
3121
|
suppliedId?: string;
|
|
3122
|
+
/**
|
|
3123
|
+
*
|
|
3124
|
+
* @type {string}
|
|
3125
|
+
* @memberof PartRevisionDataAttributes
|
|
3126
|
+
*/
|
|
3127
|
+
name?: string;
|
|
3116
3128
|
}
|
|
3117
3129
|
/**
|
|
3118
3130
|
*
|
|
@@ -3502,6 +3514,122 @@ export interface QueuedJobList {
|
|
|
3502
3514
|
[key: string]: Link;
|
|
3503
3515
|
};
|
|
3504
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
|
+
}
|
|
3505
3633
|
/**
|
|
3506
3634
|
*
|
|
3507
3635
|
* @export
|
|
@@ -8526,7 +8654,7 @@ export declare const SceneItemsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8526
8654
|
/**
|
|
8527
8655
|
* Get a `scene-item` by ID.
|
|
8528
8656
|
* @param {string} id The `scene-item` ID.
|
|
8529
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
8530
8658
|
* @param {*} [options] Override http request option.
|
|
8531
8659
|
* @throws {RequiredError}
|
|
8532
8660
|
*/
|
|
@@ -8589,7 +8717,7 @@ export declare const SceneItemsApiFp: (configuration?: Configuration | undefined
|
|
|
8589
8717
|
/**
|
|
8590
8718
|
* Get a `scene-item` by ID.
|
|
8591
8719
|
* @param {string} id The `scene-item` ID.
|
|
8592
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
8593
8721
|
* @param {*} [options] Override http request option.
|
|
8594
8722
|
* @throws {RequiredError}
|
|
8595
8723
|
*/
|
|
@@ -8652,7 +8780,7 @@ export declare const SceneItemsApiFactory: (configuration?: Configuration | unde
|
|
|
8652
8780
|
/**
|
|
8653
8781
|
* Get a `scene-item` by ID.
|
|
8654
8782
|
* @param {string} id The `scene-item` ID.
|
|
8655
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
8656
8784
|
* @param {*} [options] Override http request option.
|
|
8657
8785
|
* @throws {RequiredError}
|
|
8658
8786
|
*/
|
|
@@ -8749,7 +8877,7 @@ export interface SceneItemsApiGetSceneItemRequest {
|
|
|
8749
8877
|
*/
|
|
8750
8878
|
readonly id: string;
|
|
8751
8879
|
/**
|
|
8752
|
-
* Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
|
|
8880
|
+
* Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
8753
8881
|
* @type {string}
|
|
8754
8882
|
* @memberof SceneItemsApiGetSceneItem
|
|
8755
8883
|
*/
|
|
@@ -9229,7 +9357,7 @@ export declare const SceneViewsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
9229
9357
|
* Get a `scene-item` within a view by ID.
|
|
9230
9358
|
* @param {string} id The `scene-view` ID.
|
|
9231
9359
|
* @param {string} itemId The `scene-item` ID.
|
|
9232
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
9233
9361
|
* @param {string} [include] Comma-separated list of relationships to include in response.
|
|
9234
9362
|
* @param {*} [options] Override http request option.
|
|
9235
9363
|
* @throws {RequiredError}
|
|
@@ -9293,7 +9421,7 @@ export declare const SceneViewsApiFp: (configuration?: Configuration | undefined
|
|
|
9293
9421
|
* Get a `scene-item` within a view by ID.
|
|
9294
9422
|
* @param {string} id The `scene-view` ID.
|
|
9295
9423
|
* @param {string} itemId The `scene-item` ID.
|
|
9296
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
9297
9425
|
* @param {string} [include] Comma-separated list of relationships to include in response.
|
|
9298
9426
|
* @param {*} [options] Override http request option.
|
|
9299
9427
|
* @throws {RequiredError}
|
|
@@ -9357,7 +9485,7 @@ export declare const SceneViewsApiFactory: (configuration?: Configuration | unde
|
|
|
9357
9485
|
* Get a `scene-item` within a view by ID.
|
|
9358
9486
|
* @param {string} id The `scene-view` ID.
|
|
9359
9487
|
* @param {string} itemId The `scene-item` ID.
|
|
9360
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
9361
9489
|
* @param {string} [include] Comma-separated list of relationships to include in response.
|
|
9362
9490
|
* @param {*} [options] Override http request option.
|
|
9363
9491
|
* @throws {RequiredError}
|
|
@@ -9470,7 +9598,7 @@ export interface SceneViewsApiGetViewSceneItemRequest {
|
|
|
9470
9598
|
*/
|
|
9471
9599
|
readonly itemId: string;
|
|
9472
9600
|
/**
|
|
9473
|
-
* Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
|
|
9601
|
+
* Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
9474
9602
|
* @type {string}
|
|
9475
9603
|
* @memberof SceneViewsApiGetViewSceneItem
|
|
9476
9604
|
*/
|
|
@@ -10178,6 +10306,13 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
|
|
|
10178
10306
|
* @throws {RequiredError}
|
|
10179
10307
|
*/
|
|
10180
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 `queued-translation` ID.
|
|
10312
|
+
* @param {*} [options] Override http request option.
|
|
10313
|
+
* @throws {RequiredError}
|
|
10314
|
+
*/
|
|
10315
|
+
getQueuedTranslationJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10181
10316
|
/**
|
|
10182
10317
|
* Get `queued-translation`s.
|
|
10183
10318
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
@@ -10214,6 +10349,13 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
|
|
|
10214
10349
|
* @throws {RequiredError}
|
|
10215
10350
|
*/
|
|
10216
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 `queued-translation` 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>>;
|
|
10217
10359
|
/**
|
|
10218
10360
|
* Get `queued-translation`s.
|
|
10219
10361
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
@@ -10250,6 +10392,13 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
|
|
|
10250
10392
|
* @throws {RequiredError}
|
|
10251
10393
|
*/
|
|
10252
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 `queued-translation` ID.
|
|
10398
|
+
* @param {*} [options] Override http request option.
|
|
10399
|
+
* @throws {RequiredError}
|
|
10400
|
+
*/
|
|
10401
|
+
getQueuedTranslationJob(id: string, options?: any): AxiosPromise<QueuedTranslationJob>;
|
|
10253
10402
|
/**
|
|
10254
10403
|
* Get `queued-translation`s.
|
|
10255
10404
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
@@ -10299,6 +10448,19 @@ export interface TranslationInspectionsApiGetQueuedTranslationRequest {
|
|
|
10299
10448
|
*/
|
|
10300
10449
|
readonly id: string;
|
|
10301
10450
|
}
|
|
10451
|
+
/**
|
|
10452
|
+
* Request parameters for getQueuedTranslationJob operation in TranslationInspectionsApi.
|
|
10453
|
+
* @export
|
|
10454
|
+
* @interface TranslationInspectionsApiGetQueuedTranslationJobRequest
|
|
10455
|
+
*/
|
|
10456
|
+
export interface TranslationInspectionsApiGetQueuedTranslationJobRequest {
|
|
10457
|
+
/**
|
|
10458
|
+
* The `queued-translation` ID.
|
|
10459
|
+
* @type {string}
|
|
10460
|
+
* @memberof TranslationInspectionsApiGetQueuedTranslationJob
|
|
10461
|
+
*/
|
|
10462
|
+
readonly id: string;
|
|
10463
|
+
}
|
|
10302
10464
|
/**
|
|
10303
10465
|
* Request parameters for getQueuedTranslations operation in TranslationInspectionsApi.
|
|
10304
10466
|
* @export
|
|
@@ -10355,6 +10517,14 @@ export declare class TranslationInspectionsApi extends BaseAPI {
|
|
|
10355
10517
|
* @memberof TranslationInspectionsApi
|
|
10356
10518
|
*/
|
|
10357
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>>;
|
|
10358
10528
|
/**
|
|
10359
10529
|
* Get `queued-translation`s.
|
|
10360
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 `scene-item` ID.
|
|
4233
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-item` ID.
|
|
4411
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-item` ID.
|
|
4509
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-view` ID.
|
|
5199
5199
|
* @param {string} itemId The `scene-item` ID.
|
|
5200
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-view` ID.
|
|
5376
5376
|
* @param {string} itemId The `scene-item` ID.
|
|
5377
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-view` ID.
|
|
5475
5475
|
* @param {string} itemId The `scene-item` ID.
|
|
5476
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `queued-translation` 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 `queued-translation` 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 `queued-translation` 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.
|
|
1
|
+
export declare const version = "0.20.7";
|
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}
|
|
@@ -3113,6 +3119,12 @@ export interface PartRevisionDataAttributes {
|
|
|
3113
3119
|
* @memberof PartRevisionDataAttributes
|
|
3114
3120
|
*/
|
|
3115
3121
|
suppliedId?: string;
|
|
3122
|
+
/**
|
|
3123
|
+
*
|
|
3124
|
+
* @type {string}
|
|
3125
|
+
* @memberof PartRevisionDataAttributes
|
|
3126
|
+
*/
|
|
3127
|
+
name?: string;
|
|
3116
3128
|
}
|
|
3117
3129
|
/**
|
|
3118
3130
|
*
|
|
@@ -3502,6 +3514,122 @@ export interface QueuedJobList {
|
|
|
3502
3514
|
[key: string]: Link;
|
|
3503
3515
|
};
|
|
3504
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
|
+
}
|
|
3505
3633
|
/**
|
|
3506
3634
|
*
|
|
3507
3635
|
* @export
|
|
@@ -8526,7 +8654,7 @@ export declare const SceneItemsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
8526
8654
|
/**
|
|
8527
8655
|
* Get a `scene-item` by ID.
|
|
8528
8656
|
* @param {string} id The `scene-item` ID.
|
|
8529
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
8530
8658
|
* @param {*} [options] Override http request option.
|
|
8531
8659
|
* @throws {RequiredError}
|
|
8532
8660
|
*/
|
|
@@ -8589,7 +8717,7 @@ export declare const SceneItemsApiFp: (configuration?: Configuration | undefined
|
|
|
8589
8717
|
/**
|
|
8590
8718
|
* Get a `scene-item` by ID.
|
|
8591
8719
|
* @param {string} id The `scene-item` ID.
|
|
8592
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
8593
8721
|
* @param {*} [options] Override http request option.
|
|
8594
8722
|
* @throws {RequiredError}
|
|
8595
8723
|
*/
|
|
@@ -8652,7 +8780,7 @@ export declare const SceneItemsApiFactory: (configuration?: Configuration | unde
|
|
|
8652
8780
|
/**
|
|
8653
8781
|
* Get a `scene-item` by ID.
|
|
8654
8782
|
* @param {string} id The `scene-item` ID.
|
|
8655
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
8656
8784
|
* @param {*} [options] Override http request option.
|
|
8657
8785
|
* @throws {RequiredError}
|
|
8658
8786
|
*/
|
|
@@ -8749,7 +8877,7 @@ export interface SceneItemsApiGetSceneItemRequest {
|
|
|
8749
8877
|
*/
|
|
8750
8878
|
readonly id: string;
|
|
8751
8879
|
/**
|
|
8752
|
-
* Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
|
|
8880
|
+
* Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
8753
8881
|
* @type {string}
|
|
8754
8882
|
* @memberof SceneItemsApiGetSceneItem
|
|
8755
8883
|
*/
|
|
@@ -9229,7 +9357,7 @@ export declare const SceneViewsApiAxiosParamCreator: (configuration?: Configurat
|
|
|
9229
9357
|
* Get a `scene-item` within a view by ID.
|
|
9230
9358
|
* @param {string} id The `scene-view` ID.
|
|
9231
9359
|
* @param {string} itemId The `scene-item` ID.
|
|
9232
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
9233
9361
|
* @param {string} [include] Comma-separated list of relationships to include in response.
|
|
9234
9362
|
* @param {*} [options] Override http request option.
|
|
9235
9363
|
* @throws {RequiredError}
|
|
@@ -9293,7 +9421,7 @@ export declare const SceneViewsApiFp: (configuration?: Configuration | undefined
|
|
|
9293
9421
|
* Get a `scene-item` within a view by ID.
|
|
9294
9422
|
* @param {string} id The `scene-view` ID.
|
|
9295
9423
|
* @param {string} itemId The `scene-item` ID.
|
|
9296
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
9297
9425
|
* @param {string} [include] Comma-separated list of relationships to include in response.
|
|
9298
9426
|
* @param {*} [options] Override http request option.
|
|
9299
9427
|
* @throws {RequiredError}
|
|
@@ -9357,7 +9485,7 @@ export declare const SceneViewsApiFactory: (configuration?: Configuration | unde
|
|
|
9357
9485
|
* Get a `scene-item` within a view by ID.
|
|
9358
9486
|
* @param {string} id The `scene-view` ID.
|
|
9359
9487
|
* @param {string} itemId The `scene-item` ID.
|
|
9360
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
9361
9489
|
* @param {string} [include] Comma-separated list of relationships to include in response.
|
|
9362
9490
|
* @param {*} [options] Override http request option.
|
|
9363
9491
|
* @throws {RequiredError}
|
|
@@ -9470,7 +9598,7 @@ export interface SceneViewsApiGetViewSceneItemRequest {
|
|
|
9470
9598
|
*/
|
|
9471
9599
|
readonly itemId: string;
|
|
9472
9600
|
/**
|
|
9473
|
-
* Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` are only returned if explicitly requested.
|
|
9601
|
+
* Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox`, `worldTransform` and `metadata` are only returned if explicitly requested.
|
|
9474
9602
|
* @type {string}
|
|
9475
9603
|
* @memberof SceneViewsApiGetViewSceneItem
|
|
9476
9604
|
*/
|
|
@@ -10178,6 +10306,13 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
|
|
|
10178
10306
|
* @throws {RequiredError}
|
|
10179
10307
|
*/
|
|
10180
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 `queued-translation` ID.
|
|
10312
|
+
* @param {*} [options] Override http request option.
|
|
10313
|
+
* @throws {RequiredError}
|
|
10314
|
+
*/
|
|
10315
|
+
getQueuedTranslationJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
10181
10316
|
/**
|
|
10182
10317
|
* Get `queued-translation`s.
|
|
10183
10318
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
@@ -10214,6 +10349,13 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
|
|
|
10214
10349
|
* @throws {RequiredError}
|
|
10215
10350
|
*/
|
|
10216
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 `queued-translation` 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>>;
|
|
10217
10359
|
/**
|
|
10218
10360
|
* Get `queued-translation`s.
|
|
10219
10361
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
@@ -10250,6 +10392,13 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
|
|
|
10250
10392
|
* @throws {RequiredError}
|
|
10251
10393
|
*/
|
|
10252
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 `queued-translation` ID.
|
|
10398
|
+
* @param {*} [options] Override http request option.
|
|
10399
|
+
* @throws {RequiredError}
|
|
10400
|
+
*/
|
|
10401
|
+
getQueuedTranslationJob(id: string, options?: any): AxiosPromise<QueuedTranslationJob>;
|
|
10253
10402
|
/**
|
|
10254
10403
|
* Get `queued-translation`s.
|
|
10255
10404
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
@@ -10299,6 +10448,19 @@ export interface TranslationInspectionsApiGetQueuedTranslationRequest {
|
|
|
10299
10448
|
*/
|
|
10300
10449
|
readonly id: string;
|
|
10301
10450
|
}
|
|
10451
|
+
/**
|
|
10452
|
+
* Request parameters for getQueuedTranslationJob operation in TranslationInspectionsApi.
|
|
10453
|
+
* @export
|
|
10454
|
+
* @interface TranslationInspectionsApiGetQueuedTranslationJobRequest
|
|
10455
|
+
*/
|
|
10456
|
+
export interface TranslationInspectionsApiGetQueuedTranslationJobRequest {
|
|
10457
|
+
/**
|
|
10458
|
+
* The `queued-translation` ID.
|
|
10459
|
+
* @type {string}
|
|
10460
|
+
* @memberof TranslationInspectionsApiGetQueuedTranslationJob
|
|
10461
|
+
*/
|
|
10462
|
+
readonly id: string;
|
|
10463
|
+
}
|
|
10302
10464
|
/**
|
|
10303
10465
|
* Request parameters for getQueuedTranslations operation in TranslationInspectionsApi.
|
|
10304
10466
|
* @export
|
|
@@ -10355,6 +10517,14 @@ export declare class TranslationInspectionsApi extends BaseAPI {
|
|
|
10355
10517
|
* @memberof TranslationInspectionsApi
|
|
10356
10518
|
*/
|
|
10357
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>>;
|
|
10358
10528
|
/**
|
|
10359
10529
|
* Get `queued-translation`s.
|
|
10360
10530
|
* @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 `scene-item` ID.
|
|
4177
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-item` ID.
|
|
4354
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-item` ID.
|
|
4451
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-view` ID.
|
|
5135
5135
|
* @param {string} itemId The `scene-item` ID.
|
|
5136
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-view` ID.
|
|
5311
5311
|
* @param {string} itemId The `scene-item` ID.
|
|
5312
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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 `scene-view` ID.
|
|
5409
5409
|
* @param {string} itemId The `scene-item` ID.
|
|
5410
|
-
* @param {string} [fieldsSceneItem] Comma-separated list of fields to return in response. An empty value returns no fields. `boundingBox` and `metadata` 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. `boundingBox`, `worldTransform` and `metadata` 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}
|
|
@@ -6418,6 +6418,36 @@ export const TranslationInspectionsApiAxiosParamCreator = function (configuratio
|
|
|
6418
6418
|
options: localVarRequestOptions,
|
|
6419
6419
|
};
|
|
6420
6420
|
}),
|
|
6421
|
+
/**
|
|
6422
|
+
* 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.
|
|
6423
|
+
* @param {string} id The `queued-translation` ID.
|
|
6424
|
+
* @param {*} [options] Override http request option.
|
|
6425
|
+
* @throws {RequiredError}
|
|
6426
|
+
*/
|
|
6427
|
+
getQueuedTranslationJob: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
6428
|
+
// verify required parameter 'id' is not null or undefined
|
|
6429
|
+
assertParamExists('getQueuedTranslationJob', 'id', id);
|
|
6430
|
+
const localVarPath = `/queued-translation-jobs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
6431
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
6432
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
6433
|
+
let baseOptions;
|
|
6434
|
+
if (configuration) {
|
|
6435
|
+
baseOptions = configuration.baseOptions;
|
|
6436
|
+
}
|
|
6437
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
6438
|
+
const localVarHeaderParameter = {};
|
|
6439
|
+
const localVarQueryParameter = {};
|
|
6440
|
+
// authentication OAuth2 required
|
|
6441
|
+
// oauth required
|
|
6442
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
6443
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6444
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
6445
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
6446
|
+
return {
|
|
6447
|
+
url: toPathString(localVarUrlObj),
|
|
6448
|
+
options: localVarRequestOptions,
|
|
6449
|
+
};
|
|
6450
|
+
}),
|
|
6421
6451
|
/**
|
|
6422
6452
|
* Get `queued-translation`s.
|
|
6423
6453
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
@@ -6502,6 +6532,18 @@ export const TranslationInspectionsApiFp = function (configuration) {
|
|
|
6502
6532
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
6503
6533
|
});
|
|
6504
6534
|
},
|
|
6535
|
+
/**
|
|
6536
|
+
* 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.
|
|
6537
|
+
* @param {string} id The `queued-translation` ID.
|
|
6538
|
+
* @param {*} [options] Override http request option.
|
|
6539
|
+
* @throws {RequiredError}
|
|
6540
|
+
*/
|
|
6541
|
+
getQueuedTranslationJob(id, options) {
|
|
6542
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
6543
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedTranslationJob(id, options);
|
|
6544
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
6545
|
+
});
|
|
6546
|
+
},
|
|
6505
6547
|
/**
|
|
6506
6548
|
* Get `queued-translation`s.
|
|
6507
6549
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
@@ -6558,6 +6600,17 @@ export const TranslationInspectionsApiFactory = function (configuration, basePat
|
|
|
6558
6600
|
.getQueuedTranslation(id, options)
|
|
6559
6601
|
.then((request) => request(axios, basePath));
|
|
6560
6602
|
},
|
|
6603
|
+
/**
|
|
6604
|
+
* 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.
|
|
6605
|
+
* @param {string} id The `queued-translation` ID.
|
|
6606
|
+
* @param {*} [options] Override http request option.
|
|
6607
|
+
* @throws {RequiredError}
|
|
6608
|
+
*/
|
|
6609
|
+
getQueuedTranslationJob(id, options) {
|
|
6610
|
+
return localVarFp
|
|
6611
|
+
.getQueuedTranslationJob(id, options)
|
|
6612
|
+
.then((request) => request(axios, basePath));
|
|
6613
|
+
},
|
|
6561
6614
|
/**
|
|
6562
6615
|
* Get `queued-translation`s.
|
|
6563
6616
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
@@ -6616,6 +6669,18 @@ export class TranslationInspectionsApi extends BaseAPI {
|
|
|
6616
6669
|
.getQueuedTranslation(requestParameters.id, options)
|
|
6617
6670
|
.then((request) => request(this.axios, this.basePath));
|
|
6618
6671
|
}
|
|
6672
|
+
/**
|
|
6673
|
+
* 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.
|
|
6674
|
+
* @param {TranslationInspectionsApiGetQueuedTranslationJobRequest} requestParameters Request parameters.
|
|
6675
|
+
* @param {*} [options] Override http request option.
|
|
6676
|
+
* @throws {RequiredError}
|
|
6677
|
+
* @memberof TranslationInspectionsApi
|
|
6678
|
+
*/
|
|
6679
|
+
getQueuedTranslationJob(requestParameters, options) {
|
|
6680
|
+
return TranslationInspectionsApiFp(this.configuration)
|
|
6681
|
+
.getQueuedTranslationJob(requestParameters.id, options)
|
|
6682
|
+
.then((request) => request(this.axios, this.basePath));
|
|
6683
|
+
}
|
|
6619
6684
|
/**
|
|
6620
6685
|
* Get `queued-translation`s.
|
|
6621
6686
|
* @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.20.
|
|
1
|
+
export declare const version = "0.20.7";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export const version = '0.20.
|
|
1
|
+
export const version = '0.20.7';
|
package/package.json
CHANGED