@vertexvis/api-client-node 0.21.2 → 0.21.3

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
@@ -9860,7 +9860,7 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
9860
9860
  * @param {number} [pageSize] The number of items to return.
9861
9861
  * @param {string} [filterName] Comma-separated list of names to filter on.
9862
9862
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9863
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
9863
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
9864
9864
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
9865
9865
  * @param {*} [options] Override http request option.
9866
9866
  * @throws {RequiredError}
@@ -9926,7 +9926,7 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9926
9926
  * @param {number} [pageSize] The number of items to return.
9927
9927
  * @param {string} [filterName] Comma-separated list of names to filter on.
9928
9928
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9929
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
9929
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
9930
9930
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
9931
9931
  * @param {*} [options] Override http request option.
9932
9932
  * @throws {RequiredError}
@@ -9992,7 +9992,7 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9992
9992
  * @param {number} [pageSize] The number of items to return.
9993
9993
  * @param {string} [filterName] Comma-separated list of names to filter on.
9994
9994
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9995
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
9995
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
9996
9996
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: `filter[metadata][key1]=value1&filter[metadata][key]=value2`.
9997
9997
  * @param {*} [options] Override http request option.
9998
9998
  * @throws {RequiredError}
@@ -10107,7 +10107,7 @@ export interface ScenesApiGetScenesRequest {
10107
10107
  */
10108
10108
  readonly filterSuppliedId?: string;
10109
10109
  /**
10110
- * Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
10110
+ * Comma-separated list of fields to return in response. An empty value returns no fields. `metadata` is only returned if explicitly requested.
10111
10111
  * @type {string}
10112
10112
  * @memberof ScenesApiGetScenes
10113
10113
  */
@@ -10428,9 +10428,10 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
10428
10428
  */
10429
10429
  getInspectionJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10430
10430
  /**
10431
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10431
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10432
10432
  * @param {string} id The &#x60;queued-translation&#x60; ID.
10433
10433
  * @param {*} [options] Override http request option.
10434
+ * @deprecated
10434
10435
  * @throws {RequiredError}
10435
10436
  */
10436
10437
  getQueuedTranslation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -10442,13 +10443,23 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
10442
10443
  */
10443
10444
  getQueuedTranslationJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10444
10445
  /**
10445
- * Get `queued-translation`s.
10446
+ * Get all current translation jobs in progress.
10446
10447
  * @param {string} [pageCursor] The cursor for the next page of items.
10447
10448
  * @param {number} [pageSize] The number of items to return.
10448
10449
  * @param {string} [filterStatus] Status to filter on.
10449
10450
  * @param {*} [options] Override http request option.
10450
10451
  * @throws {RequiredError}
10451
10452
  */
10453
+ getQueuedTranslationJobs: (pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10454
+ /**
10455
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
10456
+ * @param {string} [pageCursor] The cursor for the next page of items.
10457
+ * @param {number} [pageSize] The number of items to return.
10458
+ * @param {string} [filterStatus] Status to filter on.
10459
+ * @param {*} [options] Override http request option.
10460
+ * @deprecated
10461
+ * @throws {RequiredError}
10462
+ */
10452
10463
  getQueuedTranslations: (pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10453
10464
  };
10454
10465
  /**
@@ -10471,9 +10482,10 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
10471
10482
  */
10472
10483
  getInspectionJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<TranslationInspectionJob>>;
10473
10484
  /**
10474
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10485
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10475
10486
  * @param {string} id The &#x60;queued-translation&#x60; ID.
10476
10487
  * @param {*} [options] Override http request option.
10488
+ * @deprecated
10477
10489
  * @throws {RequiredError}
10478
10490
  */
10479
10491
  getQueuedTranslation(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
@@ -10485,13 +10497,23 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
10485
10497
  */
10486
10498
  getQueuedTranslationJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedTranslationJob>>;
10487
10499
  /**
10488
- * Get `queued-translation`s.
10500
+ * Get all current translation jobs in progress.
10489
10501
  * @param {string} [pageCursor] The cursor for the next page of items.
10490
10502
  * @param {number} [pageSize] The number of items to return.
10491
10503
  * @param {string} [filterStatus] Status to filter on.
10492
10504
  * @param {*} [options] Override http request option.
10493
10505
  * @throws {RequiredError}
10494
10506
  */
10507
+ getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJobList>>;
10508
+ /**
10509
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
10510
+ * @param {string} [pageCursor] The cursor for the next page of items.
10511
+ * @param {number} [pageSize] The number of items to return.
10512
+ * @param {string} [filterStatus] Status to filter on.
10513
+ * @param {*} [options] Override http request option.
10514
+ * @deprecated
10515
+ * @throws {RequiredError}
10516
+ */
10495
10517
  getQueuedTranslations(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJobList>>;
10496
10518
  };
10497
10519
  /**
@@ -10514,9 +10536,10 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
10514
10536
  */
10515
10537
  getInspectionJob(id: string, options?: any): AxiosPromise<TranslationInspectionJob>;
10516
10538
  /**
10517
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10539
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10518
10540
  * @param {string} id The &#x60;queued-translation&#x60; ID.
10519
10541
  * @param {*} [options] Override http request option.
10542
+ * @deprecated
10520
10543
  * @throws {RequiredError}
10521
10544
  */
10522
10545
  getQueuedTranslation(id: string, options?: any): AxiosPromise<QueuedJob>;
@@ -10528,11 +10551,21 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
10528
10551
  */
10529
10552
  getQueuedTranslationJob(id: string, options?: any): AxiosPromise<QueuedTranslationJob>;
10530
10553
  /**
10531
- * Get `queued-translation`s.
10554
+ * Get all current translation jobs in progress.
10555
+ * @param {string} [pageCursor] The cursor for the next page of items.
10556
+ * @param {number} [pageSize] The number of items to return.
10557
+ * @param {string} [filterStatus] Status to filter on.
10558
+ * @param {*} [options] Override http request option.
10559
+ * @throws {RequiredError}
10560
+ */
10561
+ getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: any): AxiosPromise<QueuedJobList>;
10562
+ /**
10563
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
10532
10564
  * @param {string} [pageCursor] The cursor for the next page of items.
10533
10565
  * @param {number} [pageSize] The number of items to return.
10534
10566
  * @param {string} [filterStatus] Status to filter on.
10535
10567
  * @param {*} [options] Override http request option.
10568
+ * @deprecated
10536
10569
  * @throws {RequiredError}
10537
10570
  */
10538
10571
  getQueuedTranslations(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: any): AxiosPromise<QueuedJobList>;
@@ -10589,6 +10622,31 @@ export interface TranslationInspectionsApiGetQueuedTranslationJobRequest {
10589
10622
  */
10590
10623
  readonly id: string;
10591
10624
  }
10625
+ /**
10626
+ * Request parameters for getQueuedTranslationJobs operation in TranslationInspectionsApi.
10627
+ * @export
10628
+ * @interface TranslationInspectionsApiGetQueuedTranslationJobsRequest
10629
+ */
10630
+ export interface TranslationInspectionsApiGetQueuedTranslationJobsRequest {
10631
+ /**
10632
+ * The cursor for the next page of items.
10633
+ * @type {string}
10634
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
10635
+ */
10636
+ readonly pageCursor?: string;
10637
+ /**
10638
+ * The number of items to return.
10639
+ * @type {number}
10640
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
10641
+ */
10642
+ readonly pageSize?: number;
10643
+ /**
10644
+ * Status to filter on.
10645
+ * @type {string}
10646
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
10647
+ */
10648
+ readonly filterStatus?: string;
10649
+ }
10592
10650
  /**
10593
10651
  * Request parameters for getQueuedTranslations operation in TranslationInspectionsApi.
10594
10652
  * @export
@@ -10638,9 +10696,10 @@ export declare class TranslationInspectionsApi extends BaseAPI {
10638
10696
  */
10639
10697
  getInspectionJob(requestParameters: TranslationInspectionsApiGetInspectionJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TranslationInspectionJob, any>>;
10640
10698
  /**
10641
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10699
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10642
10700
  * @param {TranslationInspectionsApiGetQueuedTranslationRequest} requestParameters Request parameters.
10643
10701
  * @param {*} [options] Override http request option.
10702
+ * @deprecated
10644
10703
  * @throws {RequiredError}
10645
10704
  * @memberof TranslationInspectionsApi
10646
10705
  */
@@ -10654,9 +10713,18 @@ export declare class TranslationInspectionsApi extends BaseAPI {
10654
10713
  */
10655
10714
  getQueuedTranslationJob(requestParameters: TranslationInspectionsApiGetQueuedTranslationJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedTranslationJob, any>>;
10656
10715
  /**
10657
- * Get `queued-translation`s.
10716
+ * Get all current translation jobs in progress.
10717
+ * @param {TranslationInspectionsApiGetQueuedTranslationJobsRequest} requestParameters Request parameters.
10718
+ * @param {*} [options] Override http request option.
10719
+ * @throws {RequiredError}
10720
+ * @memberof TranslationInspectionsApi
10721
+ */
10722
+ getQueuedTranslationJobs(requestParameters?: TranslationInspectionsApiGetQueuedTranslationJobsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJobList, any>>;
10723
+ /**
10724
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
10658
10725
  * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
10659
10726
  * @param {*} [options] Override http request option.
10727
+ * @deprecated
10660
10728
  * @throws {RequiredError}
10661
10729
  * @memberof TranslationInspectionsApi
10662
10730
  */
package/dist/cjs/api.js CHANGED
@@ -5814,7 +5814,7 @@ const ScenesApiAxiosParamCreator = function (configuration) {
5814
5814
  * @param {number} [pageSize] The number of items to return.
5815
5815
  * @param {string} [filterName] Comma-separated list of names to filter on.
5816
5816
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5817
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5817
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
5818
5818
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
5819
5819
  * @param {*} [options] Override http request option.
5820
5820
  * @throws {RequiredError}
@@ -6000,7 +6000,7 @@ const ScenesApiFp = function (configuration) {
6000
6000
  * @param {number} [pageSize] The number of items to return.
6001
6001
  * @param {string} [filterName] Comma-separated list of names to filter on.
6002
6002
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
6003
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
6003
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
6004
6004
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
6005
6005
  * @param {*} [options] Override http request option.
6006
6006
  * @throws {RequiredError}
@@ -6099,7 +6099,7 @@ const ScenesApiFactory = function (configuration, basePath, axios) {
6099
6099
  * @param {number} [pageSize] The number of items to return.
6100
6100
  * @param {string} [filterName] Comma-separated list of names to filter on.
6101
6101
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
6102
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
6102
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
6103
6103
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
6104
6104
  * @param {*} [options] Override http request option.
6105
6105
  * @throws {RequiredError}
@@ -6557,9 +6557,10 @@ const TranslationInspectionsApiAxiosParamCreator = function (configuration) {
6557
6557
  };
6558
6558
  }),
6559
6559
  /**
6560
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6560
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6561
6561
  * @param {string} id The &#x60;queued-translation&#x60; ID.
6562
6562
  * @param {*} [options] Override http request option.
6563
+ * @deprecated
6563
6564
  * @throws {RequiredError}
6564
6565
  */
6565
6566
  getQueuedTranslation: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
@@ -6619,16 +6620,16 @@ const TranslationInspectionsApiAxiosParamCreator = function (configuration) {
6619
6620
  };
6620
6621
  }),
6621
6622
  /**
6622
- * Get `queued-translation`s.
6623
+ * Get all current translation jobs in progress.
6623
6624
  * @param {string} [pageCursor] The cursor for the next page of items.
6624
6625
  * @param {number} [pageSize] The number of items to return.
6625
6626
  * @param {string} [filterStatus] Status to filter on.
6626
6627
  * @param {*} [options] Override http request option.
6627
6628
  * @throws {RequiredError}
6628
6629
  */
6629
- getQueuedTranslations: (pageCursor, pageSize, filterStatus, options = {}) => __awaiter(this, void 0, void 0, function* () {
6630
+ getQueuedTranslationJobs: (pageCursor, pageSize, filterStatus, options = {}) => __awaiter(this, void 0, void 0, function* () {
6630
6631
  var _e;
6631
- const localVarPath = `/queued-translations`;
6632
+ const localVarPath = `/queued-translation-jobs`;
6632
6633
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6633
6634
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
6634
6635
  let baseOptions;
@@ -6658,6 +6659,47 @@ const TranslationInspectionsApiAxiosParamCreator = function (configuration) {
6658
6659
  options: localVarRequestOptions,
6659
6660
  };
6660
6661
  }),
6662
+ /**
6663
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
6664
+ * @param {string} [pageCursor] The cursor for the next page of items.
6665
+ * @param {number} [pageSize] The number of items to return.
6666
+ * @param {string} [filterStatus] Status to filter on.
6667
+ * @param {*} [options] Override http request option.
6668
+ * @deprecated
6669
+ * @throws {RequiredError}
6670
+ */
6671
+ getQueuedTranslations: (pageCursor, pageSize, filterStatus, options = {}) => __awaiter(this, void 0, void 0, function* () {
6672
+ var _f;
6673
+ const localVarPath = `/queued-translations`;
6674
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6675
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
6676
+ let baseOptions;
6677
+ if (configuration) {
6678
+ baseOptions = configuration.baseOptions;
6679
+ }
6680
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
6681
+ const localVarHeaderParameter = {};
6682
+ const localVarQueryParameter = {};
6683
+ // authentication OAuth2 required
6684
+ // oauth required
6685
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
6686
+ if (pageCursor !== undefined) {
6687
+ localVarQueryParameter['page[cursor]'] = pageCursor;
6688
+ }
6689
+ if (pageSize !== undefined) {
6690
+ localVarQueryParameter['page[size]'] = pageSize;
6691
+ }
6692
+ if (filterStatus !== undefined) {
6693
+ localVarQueryParameter['filter[status]'] = filterStatus;
6694
+ }
6695
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
6696
+ let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
6697
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
6698
+ return {
6699
+ url: (0, common_1.toPathString)(localVarUrlObj),
6700
+ options: localVarRequestOptions,
6701
+ };
6702
+ }),
6661
6703
  };
6662
6704
  };
6663
6705
  exports.TranslationInspectionsApiAxiosParamCreator = TranslationInspectionsApiAxiosParamCreator;
@@ -6693,9 +6735,10 @@ const TranslationInspectionsApiFp = function (configuration) {
6693
6735
  });
6694
6736
  },
6695
6737
  /**
6696
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6738
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6697
6739
  * @param {string} id The &#x60;queued-translation&#x60; ID.
6698
6740
  * @param {*} [options] Override http request option.
6741
+ * @deprecated
6699
6742
  * @throws {RequiredError}
6700
6743
  */
6701
6744
  getQueuedTranslation(id, options) {
@@ -6717,11 +6760,26 @@ const TranslationInspectionsApiFp = function (configuration) {
6717
6760
  });
6718
6761
  },
6719
6762
  /**
6720
- * Get `queued-translation`s.
6763
+ * Get all current translation jobs in progress.
6764
+ * @param {string} [pageCursor] The cursor for the next page of items.
6765
+ * @param {number} [pageSize] The number of items to return.
6766
+ * @param {string} [filterStatus] Status to filter on.
6767
+ * @param {*} [options] Override http request option.
6768
+ * @throws {RequiredError}
6769
+ */
6770
+ getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options) {
6771
+ return __awaiter(this, void 0, void 0, function* () {
6772
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options);
6773
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
6774
+ });
6775
+ },
6776
+ /**
6777
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
6721
6778
  * @param {string} [pageCursor] The cursor for the next page of items.
6722
6779
  * @param {number} [pageSize] The number of items to return.
6723
6780
  * @param {string} [filterStatus] Status to filter on.
6724
6781
  * @param {*} [options] Override http request option.
6782
+ * @deprecated
6725
6783
  * @throws {RequiredError}
6726
6784
  */
6727
6785
  getQueuedTranslations(pageCursor, pageSize, filterStatus, options) {
@@ -6763,9 +6821,10 @@ const TranslationInspectionsApiFactory = function (configuration, basePath, axio
6763
6821
  .then((request) => request(axios, basePath));
6764
6822
  },
6765
6823
  /**
6766
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6824
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6767
6825
  * @param {string} id The &#x60;queued-translation&#x60; ID.
6768
6826
  * @param {*} [options] Override http request option.
6827
+ * @deprecated
6769
6828
  * @throws {RequiredError}
6770
6829
  */
6771
6830
  getQueuedTranslation(id, options) {
@@ -6785,13 +6844,27 @@ const TranslationInspectionsApiFactory = function (configuration, basePath, axio
6785
6844
  .then((request) => request(axios, basePath));
6786
6845
  },
6787
6846
  /**
6788
- * Get `queued-translation`s.
6847
+ * Get all current translation jobs in progress.
6789
6848
  * @param {string} [pageCursor] The cursor for the next page of items.
6790
6849
  * @param {number} [pageSize] The number of items to return.
6791
6850
  * @param {string} [filterStatus] Status to filter on.
6792
6851
  * @param {*} [options] Override http request option.
6793
6852
  * @throws {RequiredError}
6794
6853
  */
6854
+ getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options) {
6855
+ return localVarFp
6856
+ .getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options)
6857
+ .then((request) => request(axios, basePath));
6858
+ },
6859
+ /**
6860
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
6861
+ * @param {string} [pageCursor] The cursor for the next page of items.
6862
+ * @param {number} [pageSize] The number of items to return.
6863
+ * @param {string} [filterStatus] Status to filter on.
6864
+ * @param {*} [options] Override http request option.
6865
+ * @deprecated
6866
+ * @throws {RequiredError}
6867
+ */
6795
6868
  getQueuedTranslations(pageCursor, pageSize, filterStatus, options) {
6796
6869
  return localVarFp
6797
6870
  .getQueuedTranslations(pageCursor, pageSize, filterStatus, options)
@@ -6832,9 +6905,10 @@ class TranslationInspectionsApi extends base_1.BaseAPI {
6832
6905
  .then((request) => request(this.axios, this.basePath));
6833
6906
  }
6834
6907
  /**
6835
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6908
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6836
6909
  * @param {TranslationInspectionsApiGetQueuedTranslationRequest} requestParameters Request parameters.
6837
6910
  * @param {*} [options] Override http request option.
6911
+ * @deprecated
6838
6912
  * @throws {RequiredError}
6839
6913
  * @memberof TranslationInspectionsApi
6840
6914
  */
@@ -6856,9 +6930,22 @@ class TranslationInspectionsApi extends base_1.BaseAPI {
6856
6930
  .then((request) => request(this.axios, this.basePath));
6857
6931
  }
6858
6932
  /**
6859
- * Get `queued-translation`s.
6933
+ * Get all current translation jobs in progress.
6934
+ * @param {TranslationInspectionsApiGetQueuedTranslationJobsRequest} requestParameters Request parameters.
6935
+ * @param {*} [options] Override http request option.
6936
+ * @throws {RequiredError}
6937
+ * @memberof TranslationInspectionsApi
6938
+ */
6939
+ getQueuedTranslationJobs(requestParameters = {}, options) {
6940
+ return (0, exports.TranslationInspectionsApiFp)(this.configuration)
6941
+ .getQueuedTranslationJobs(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterStatus, options)
6942
+ .then((request) => request(this.axios, this.basePath));
6943
+ }
6944
+ /**
6945
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
6860
6946
  * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
6861
6947
  * @param {*} [options] Override http request option.
6948
+ * @deprecated
6862
6949
  * @throws {RequiredError}
6863
6950
  * @memberof TranslationInspectionsApi
6864
6951
  */
@@ -1,4 +1,5 @@
1
1
  /// <reference types="node" />
2
+ import { ReadStream } from 'fs';
2
3
  import { BaseReq, DeleteReq } from '../../client/index';
3
4
  import { CreateFileRequest, FileMetadataData } from '../../index';
4
5
  /** Upload file arguments. */
@@ -6,7 +7,7 @@ export interface UploadFileReq extends BaseReq {
6
7
  /** A {@link CreateFileRequest}. */
7
8
  readonly createFileReq: CreateFileRequest;
8
9
  /** File data. */
9
- readonly fileData: Buffer;
10
+ readonly fileData: Buffer | ReadStream;
10
11
  }
11
12
  /**
12
13
  * Delete all files.
@@ -1,5 +1,6 @@
1
1
  /// <reference types="node" />
2
2
  import { AxiosResponse } from 'axios';
3
+ import { ReadStream } from 'fs';
3
4
  import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, Part, PartData, PartRevisionData, QueuedJob } from '../../index';
4
5
  import { BaseReq, DeleteReq, Polling, RenderImageReq } from '../index';
5
6
  /** Create parts from file arguments. */
@@ -9,7 +10,7 @@ export interface CreatePartFromFileReq extends BaseReq {
9
10
  /** Function returning a {@link CreatePartRequest}. */
10
11
  readonly createPartReq: (fileId: string) => CreatePartRequest;
11
12
  /** File data. */
12
- readonly fileData: Buffer;
13
+ readonly fileData: Buffer | ReadStream;
13
14
  /** {@link Polling} */
14
15
  readonly polling?: Polling;
15
16
  /** Whether or not to return queued translation. */
@@ -1 +1 @@
1
- export declare const version = "0.21.2";
1
+ export declare const version = "0.21.3";
@@ -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.21.2';
4
+ exports.version = '0.21.3';
package/dist/esm/api.d.ts CHANGED
@@ -9860,7 +9860,7 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
9860
9860
  * @param {number} [pageSize] The number of items to return.
9861
9861
  * @param {string} [filterName] Comma-separated list of names to filter on.
9862
9862
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9863
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9863
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
9864
9864
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
9865
9865
  * @param {*} [options] Override http request option.
9866
9866
  * @throws {RequiredError}
@@ -9926,7 +9926,7 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9926
9926
  * @param {number} [pageSize] The number of items to return.
9927
9927
  * @param {string} [filterName] Comma-separated list of names to filter on.
9928
9928
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9929
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9929
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
9930
9930
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
9931
9931
  * @param {*} [options] Override http request option.
9932
9932
  * @throws {RequiredError}
@@ -9992,7 +9992,7 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9992
9992
  * @param {number} [pageSize] The number of items to return.
9993
9993
  * @param {string} [filterName] Comma-separated list of names to filter on.
9994
9994
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9995
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9995
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
9996
9996
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
9997
9997
  * @param {*} [options] Override http request option.
9998
9998
  * @throws {RequiredError}
@@ -10107,7 +10107,7 @@ export interface ScenesApiGetScenesRequest {
10107
10107
  */
10108
10108
  readonly filterSuppliedId?: string;
10109
10109
  /**
10110
- * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
10110
+ * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
10111
10111
  * @type {string}
10112
10112
  * @memberof ScenesApiGetScenes
10113
10113
  */
@@ -10428,9 +10428,10 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
10428
10428
  */
10429
10429
  getInspectionJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10430
10430
  /**
10431
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10431
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10432
10432
  * @param {string} id The &#x60;queued-translation&#x60; ID.
10433
10433
  * @param {*} [options] Override http request option.
10434
+ * @deprecated
10434
10435
  * @throws {RequiredError}
10435
10436
  */
10436
10437
  getQueuedTranslation: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
@@ -10442,13 +10443,23 @@ export declare const TranslationInspectionsApiAxiosParamCreator: (configuration?
10442
10443
  */
10443
10444
  getQueuedTranslationJob: (id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10444
10445
  /**
10445
- * Get `queued-translation`s.
10446
+ * Get all current translation jobs in progress.
10446
10447
  * @param {string} [pageCursor] The cursor for the next page of items.
10447
10448
  * @param {number} [pageSize] The number of items to return.
10448
10449
  * @param {string} [filterStatus] Status to filter on.
10449
10450
  * @param {*} [options] Override http request option.
10450
10451
  * @throws {RequiredError}
10451
10452
  */
10453
+ getQueuedTranslationJobs: (pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10454
+ /**
10455
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
10456
+ * @param {string} [pageCursor] The cursor for the next page of items.
10457
+ * @param {number} [pageSize] The number of items to return.
10458
+ * @param {string} [filterStatus] Status to filter on.
10459
+ * @param {*} [options] Override http request option.
10460
+ * @deprecated
10461
+ * @throws {RequiredError}
10462
+ */
10452
10463
  getQueuedTranslations: (pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
10453
10464
  };
10454
10465
  /**
@@ -10471,9 +10482,10 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
10471
10482
  */
10472
10483
  getInspectionJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<TranslationInspectionJob>>;
10473
10484
  /**
10474
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10485
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10475
10486
  * @param {string} id The &#x60;queued-translation&#x60; ID.
10476
10487
  * @param {*} [options] Override http request option.
10488
+ * @deprecated
10477
10489
  * @throws {RequiredError}
10478
10490
  */
10479
10491
  getQueuedTranslation(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJob>>;
@@ -10485,13 +10497,23 @@ export declare const TranslationInspectionsApiFp: (configuration?: Configuration
10485
10497
  */
10486
10498
  getQueuedTranslationJob(id: string, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedTranslationJob>>;
10487
10499
  /**
10488
- * Get `queued-translation`s.
10500
+ * Get all current translation jobs in progress.
10489
10501
  * @param {string} [pageCursor] The cursor for the next page of items.
10490
10502
  * @param {number} [pageSize] The number of items to return.
10491
10503
  * @param {string} [filterStatus] Status to filter on.
10492
10504
  * @param {*} [options] Override http request option.
10493
10505
  * @throws {RequiredError}
10494
10506
  */
10507
+ getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJobList>>;
10508
+ /**
10509
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
10510
+ * @param {string} [pageCursor] The cursor for the next page of items.
10511
+ * @param {number} [pageSize] The number of items to return.
10512
+ * @param {string} [filterStatus] Status to filter on.
10513
+ * @param {*} [options] Override http request option.
10514
+ * @deprecated
10515
+ * @throws {RequiredError}
10516
+ */
10495
10517
  getQueuedTranslations(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<QueuedJobList>>;
10496
10518
  };
10497
10519
  /**
@@ -10514,9 +10536,10 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
10514
10536
  */
10515
10537
  getInspectionJob(id: string, options?: any): AxiosPromise<TranslationInspectionJob>;
10516
10538
  /**
10517
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10539
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10518
10540
  * @param {string} id The &#x60;queued-translation&#x60; ID.
10519
10541
  * @param {*} [options] Override http request option.
10542
+ * @deprecated
10520
10543
  * @throws {RequiredError}
10521
10544
  */
10522
10545
  getQueuedTranslation(id: string, options?: any): AxiosPromise<QueuedJob>;
@@ -10528,11 +10551,21 @@ export declare const TranslationInspectionsApiFactory: (configuration?: Configur
10528
10551
  */
10529
10552
  getQueuedTranslationJob(id: string, options?: any): AxiosPromise<QueuedTranslationJob>;
10530
10553
  /**
10531
- * Get `queued-translation`s.
10554
+ * Get all current translation jobs in progress.
10555
+ * @param {string} [pageCursor] The cursor for the next page of items.
10556
+ * @param {number} [pageSize] The number of items to return.
10557
+ * @param {string} [filterStatus] Status to filter on.
10558
+ * @param {*} [options] Override http request option.
10559
+ * @throws {RequiredError}
10560
+ */
10561
+ getQueuedTranslationJobs(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: any): AxiosPromise<QueuedJobList>;
10562
+ /**
10563
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
10532
10564
  * @param {string} [pageCursor] The cursor for the next page of items.
10533
10565
  * @param {number} [pageSize] The number of items to return.
10534
10566
  * @param {string} [filterStatus] Status to filter on.
10535
10567
  * @param {*} [options] Override http request option.
10568
+ * @deprecated
10536
10569
  * @throws {RequiredError}
10537
10570
  */
10538
10571
  getQueuedTranslations(pageCursor?: string | undefined, pageSize?: number | undefined, filterStatus?: string | undefined, options?: any): AxiosPromise<QueuedJobList>;
@@ -10589,6 +10622,31 @@ export interface TranslationInspectionsApiGetQueuedTranslationJobRequest {
10589
10622
  */
10590
10623
  readonly id: string;
10591
10624
  }
10625
+ /**
10626
+ * Request parameters for getQueuedTranslationJobs operation in TranslationInspectionsApi.
10627
+ * @export
10628
+ * @interface TranslationInspectionsApiGetQueuedTranslationJobsRequest
10629
+ */
10630
+ export interface TranslationInspectionsApiGetQueuedTranslationJobsRequest {
10631
+ /**
10632
+ * The cursor for the next page of items.
10633
+ * @type {string}
10634
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
10635
+ */
10636
+ readonly pageCursor?: string;
10637
+ /**
10638
+ * The number of items to return.
10639
+ * @type {number}
10640
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
10641
+ */
10642
+ readonly pageSize?: number;
10643
+ /**
10644
+ * Status to filter on.
10645
+ * @type {string}
10646
+ * @memberof TranslationInspectionsApiGetQueuedTranslationJobs
10647
+ */
10648
+ readonly filterStatus?: string;
10649
+ }
10592
10650
  /**
10593
10651
  * Request parameters for getQueuedTranslations operation in TranslationInspectionsApi.
10594
10652
  * @export
@@ -10638,9 +10696,10 @@ export declare class TranslationInspectionsApi extends BaseAPI {
10638
10696
  */
10639
10697
  getInspectionJob(requestParameters: TranslationInspectionsApiGetInspectionJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TranslationInspectionJob, any>>;
10640
10698
  /**
10641
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10699
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
10642
10700
  * @param {TranslationInspectionsApiGetQueuedTranslationRequest} requestParameters Request parameters.
10643
10701
  * @param {*} [options] Override http request option.
10702
+ * @deprecated
10644
10703
  * @throws {RequiredError}
10645
10704
  * @memberof TranslationInspectionsApi
10646
10705
  */
@@ -10654,9 +10713,18 @@ export declare class TranslationInspectionsApi extends BaseAPI {
10654
10713
  */
10655
10714
  getQueuedTranslationJob(requestParameters: TranslationInspectionsApiGetQueuedTranslationJobRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedTranslationJob, any>>;
10656
10715
  /**
10657
- * Get `queued-translation`s.
10716
+ * Get all current translation jobs in progress.
10717
+ * @param {TranslationInspectionsApiGetQueuedTranslationJobsRequest} requestParameters Request parameters.
10718
+ * @param {*} [options] Override http request option.
10719
+ * @throws {RequiredError}
10720
+ * @memberof TranslationInspectionsApi
10721
+ */
10722
+ getQueuedTranslationJobs(requestParameters?: TranslationInspectionsApiGetQueuedTranslationJobsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<QueuedJobList, any>>;
10723
+ /**
10724
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
10658
10725
  * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
10659
10726
  * @param {*} [options] Override http request option.
10727
+ * @deprecated
10660
10728
  * @throws {RequiredError}
10661
10729
  * @memberof TranslationInspectionsApi
10662
10730
  */
package/dist/esm/api.js CHANGED
@@ -5746,7 +5746,7 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
5746
5746
  * @param {number} [pageSize] The number of items to return.
5747
5747
  * @param {string} [filterName] Comma-separated list of names to filter on.
5748
5748
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5749
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5749
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
5750
5750
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
5751
5751
  * @param {*} [options] Override http request option.
5752
5752
  * @throws {RequiredError}
@@ -5931,7 +5931,7 @@ export const ScenesApiFp = function (configuration) {
5931
5931
  * @param {number} [pageSize] The number of items to return.
5932
5932
  * @param {string} [filterName] Comma-separated list of names to filter on.
5933
5933
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5934
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5934
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
5935
5935
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
5936
5936
  * @param {*} [options] Override http request option.
5937
5937
  * @throws {RequiredError}
@@ -6029,7 +6029,7 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
6029
6029
  * @param {number} [pageSize] The number of items to return.
6030
6030
  * @param {string} [filterName] Comma-separated list of names to filter on.
6031
6031
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
6032
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
6032
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;metadata&#x60; is only returned if explicitly requested.
6033
6033
  * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
6034
6034
  * @param {*} [options] Override http request option.
6035
6035
  * @throws {RequiredError}
@@ -6481,9 +6481,10 @@ export const TranslationInspectionsApiAxiosParamCreator = function (configuratio
6481
6481
  };
6482
6482
  }),
6483
6483
  /**
6484
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6484
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6485
6485
  * @param {string} id The &#x60;queued-translation&#x60; ID.
6486
6486
  * @param {*} [options] Override http request option.
6487
+ * @deprecated
6487
6488
  * @throws {RequiredError}
6488
6489
  */
6489
6490
  getQueuedTranslation: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
@@ -6543,16 +6544,16 @@ export const TranslationInspectionsApiAxiosParamCreator = function (configuratio
6543
6544
  };
6544
6545
  }),
6545
6546
  /**
6546
- * Get `queued-translation`s.
6547
+ * Get all current translation jobs in progress.
6547
6548
  * @param {string} [pageCursor] The cursor for the next page of items.
6548
6549
  * @param {number} [pageSize] The number of items to return.
6549
6550
  * @param {string} [filterStatus] Status to filter on.
6550
6551
  * @param {*} [options] Override http request option.
6551
6552
  * @throws {RequiredError}
6552
6553
  */
6553
- getQueuedTranslations: (pageCursor, pageSize, filterStatus, options = {}) => __awaiter(this, void 0, void 0, function* () {
6554
+ getQueuedTranslationJobs: (pageCursor, pageSize, filterStatus, options = {}) => __awaiter(this, void 0, void 0, function* () {
6554
6555
  var _e;
6555
- const localVarPath = `/queued-translations`;
6556
+ const localVarPath = `/queued-translation-jobs`;
6556
6557
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
6557
6558
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6558
6559
  let baseOptions;
@@ -6582,6 +6583,47 @@ export const TranslationInspectionsApiAxiosParamCreator = function (configuratio
6582
6583
  options: localVarRequestOptions,
6583
6584
  };
6584
6585
  }),
6586
+ /**
6587
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
6588
+ * @param {string} [pageCursor] The cursor for the next page of items.
6589
+ * @param {number} [pageSize] The number of items to return.
6590
+ * @param {string} [filterStatus] Status to filter on.
6591
+ * @param {*} [options] Override http request option.
6592
+ * @deprecated
6593
+ * @throws {RequiredError}
6594
+ */
6595
+ getQueuedTranslations: (pageCursor, pageSize, filterStatus, options = {}) => __awaiter(this, void 0, void 0, function* () {
6596
+ var _f;
6597
+ const localVarPath = `/queued-translations`;
6598
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
6599
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
6600
+ let baseOptions;
6601
+ if (configuration) {
6602
+ baseOptions = configuration.baseOptions;
6603
+ }
6604
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
6605
+ const localVarHeaderParameter = {};
6606
+ const localVarQueryParameter = {};
6607
+ // authentication OAuth2 required
6608
+ // oauth required
6609
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
6610
+ if (pageCursor !== undefined) {
6611
+ localVarQueryParameter['page[cursor]'] = pageCursor;
6612
+ }
6613
+ if (pageSize !== undefined) {
6614
+ localVarQueryParameter['page[size]'] = pageSize;
6615
+ }
6616
+ if (filterStatus !== undefined) {
6617
+ localVarQueryParameter['filter[status]'] = filterStatus;
6618
+ }
6619
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
6620
+ let headersFromBaseOptions = (_f = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _f !== void 0 ? _f : {};
6621
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
6622
+ return {
6623
+ url: toPathString(localVarUrlObj),
6624
+ options: localVarRequestOptions,
6625
+ };
6626
+ }),
6585
6627
  };
6586
6628
  };
6587
6629
  /**
@@ -6616,9 +6658,10 @@ export const TranslationInspectionsApiFp = function (configuration) {
6616
6658
  });
6617
6659
  },
6618
6660
  /**
6619
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6661
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6620
6662
  * @param {string} id The &#x60;queued-translation&#x60; ID.
6621
6663
  * @param {*} [options] Override http request option.
6664
+ * @deprecated
6622
6665
  * @throws {RequiredError}
6623
6666
  */
6624
6667
  getQueuedTranslation(id, options) {
@@ -6640,11 +6683,26 @@ export const TranslationInspectionsApiFp = function (configuration) {
6640
6683
  });
6641
6684
  },
6642
6685
  /**
6643
- * Get `queued-translation`s.
6686
+ * Get all current translation jobs in progress.
6687
+ * @param {string} [pageCursor] The cursor for the next page of items.
6688
+ * @param {number} [pageSize] The number of items to return.
6689
+ * @param {string} [filterStatus] Status to filter on.
6690
+ * @param {*} [options] Override http request option.
6691
+ * @throws {RequiredError}
6692
+ */
6693
+ getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options) {
6694
+ return __awaiter(this, void 0, void 0, function* () {
6695
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options);
6696
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
6697
+ });
6698
+ },
6699
+ /**
6700
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
6644
6701
  * @param {string} [pageCursor] The cursor for the next page of items.
6645
6702
  * @param {number} [pageSize] The number of items to return.
6646
6703
  * @param {string} [filterStatus] Status to filter on.
6647
6704
  * @param {*} [options] Override http request option.
6705
+ * @deprecated
6648
6706
  * @throws {RequiredError}
6649
6707
  */
6650
6708
  getQueuedTranslations(pageCursor, pageSize, filterStatus, options) {
@@ -6685,9 +6743,10 @@ export const TranslationInspectionsApiFactory = function (configuration, basePat
6685
6743
  .then((request) => request(axios, basePath));
6686
6744
  },
6687
6745
  /**
6688
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6746
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6689
6747
  * @param {string} id The &#x60;queued-translation&#x60; ID.
6690
6748
  * @param {*} [options] Override http request option.
6749
+ * @deprecated
6691
6750
  * @throws {RequiredError}
6692
6751
  */
6693
6752
  getQueuedTranslation(id, options) {
@@ -6707,13 +6766,27 @@ export const TranslationInspectionsApiFactory = function (configuration, basePat
6707
6766
  .then((request) => request(axios, basePath));
6708
6767
  },
6709
6768
  /**
6710
- * Get `queued-translation`s.
6769
+ * Get all current translation jobs in progress.
6711
6770
  * @param {string} [pageCursor] The cursor for the next page of items.
6712
6771
  * @param {number} [pageSize] The number of items to return.
6713
6772
  * @param {string} [filterStatus] Status to filter on.
6714
6773
  * @param {*} [options] Override http request option.
6715
6774
  * @throws {RequiredError}
6716
6775
  */
6776
+ getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options) {
6777
+ return localVarFp
6778
+ .getQueuedTranslationJobs(pageCursor, pageSize, filterStatus, options)
6779
+ .then((request) => request(axios, basePath));
6780
+ },
6781
+ /**
6782
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
6783
+ * @param {string} [pageCursor] The cursor for the next page of items.
6784
+ * @param {number} [pageSize] The number of items to return.
6785
+ * @param {string} [filterStatus] Status to filter on.
6786
+ * @param {*} [options] Override http request option.
6787
+ * @deprecated
6788
+ * @throws {RequiredError}
6789
+ */
6717
6790
  getQueuedTranslations(pageCursor, pageSize, filterStatus, options) {
6718
6791
  return localVarFp
6719
6792
  .getQueuedTranslations(pageCursor, pageSize, filterStatus, options)
@@ -6753,9 +6826,10 @@ export class TranslationInspectionsApi extends BaseAPI {
6753
6826
  .then((request) => request(this.axios, this.basePath));
6754
6827
  }
6755
6828
  /**
6756
- * Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6829
+ * This has been deprecated and replaced by **queued-translation-jobs/{id}** - Get a `queued-translation`. The response is either the status if `running` or `error` or, upon completion, redirects to the created `part-revision`. 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.
6757
6830
  * @param {TranslationInspectionsApiGetQueuedTranslationRequest} requestParameters Request parameters.
6758
6831
  * @param {*} [options] Override http request option.
6832
+ * @deprecated
6759
6833
  * @throws {RequiredError}
6760
6834
  * @memberof TranslationInspectionsApi
6761
6835
  */
@@ -6777,9 +6851,22 @@ export class TranslationInspectionsApi extends BaseAPI {
6777
6851
  .then((request) => request(this.axios, this.basePath));
6778
6852
  }
6779
6853
  /**
6780
- * Get `queued-translation`s.
6854
+ * Get all current translation jobs in progress.
6855
+ * @param {TranslationInspectionsApiGetQueuedTranslationJobsRequest} requestParameters Request parameters.
6856
+ * @param {*} [options] Override http request option.
6857
+ * @throws {RequiredError}
6858
+ * @memberof TranslationInspectionsApi
6859
+ */
6860
+ getQueuedTranslationJobs(requestParameters = {}, options) {
6861
+ return TranslationInspectionsApiFp(this.configuration)
6862
+ .getQueuedTranslationJobs(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterStatus, options)
6863
+ .then((request) => request(this.axios, this.basePath));
6864
+ }
6865
+ /**
6866
+ * This has been deprecated and replaced by **queued-translation-jobs** - Get `queued-translation`s.
6781
6867
  * @param {TranslationInspectionsApiGetQueuedTranslationsRequest} requestParameters Request parameters.
6782
6868
  * @param {*} [options] Override http request option.
6869
+ * @deprecated
6783
6870
  * @throws {RequiredError}
6784
6871
  * @memberof TranslationInspectionsApi
6785
6872
  */
@@ -1,4 +1,5 @@
1
1
  /// <reference types="node" />
2
+ import { ReadStream } from 'fs';
2
3
  import { BaseReq, DeleteReq } from '../../client/index';
3
4
  import { CreateFileRequest, FileMetadataData } from '../../index';
4
5
  /** Upload file arguments. */
@@ -6,7 +7,7 @@ export interface UploadFileReq extends BaseReq {
6
7
  /** A {@link CreateFileRequest}. */
7
8
  readonly createFileReq: CreateFileRequest;
8
9
  /** File data. */
9
- readonly fileData: Buffer;
10
+ readonly fileData: Buffer | ReadStream;
10
11
  }
11
12
  /**
12
13
  * Delete all files.
@@ -1,5 +1,6 @@
1
1
  /// <reference types="node" />
2
2
  import { AxiosResponse } from 'axios';
3
+ import { ReadStream } from 'fs';
3
4
  import { CreateFileRequest, CreateGeometrySetRequest, CreatePartRequest, Failure, Part, PartData, PartRevisionData, QueuedJob } from '../../index';
4
5
  import { BaseReq, DeleteReq, Polling, RenderImageReq } from '../index';
5
6
  /** Create parts from file arguments. */
@@ -9,7 +10,7 @@ export interface CreatePartFromFileReq extends BaseReq {
9
10
  /** Function returning a {@link CreatePartRequest}. */
10
11
  readonly createPartReq: (fileId: string) => CreatePartRequest;
11
12
  /** File data. */
12
- readonly fileData: Buffer;
13
+ readonly fileData: Buffer | ReadStream;
13
14
  /** {@link Polling} */
14
15
  readonly polling?: Polling;
15
16
  /** Whether or not to return queued translation. */
@@ -1 +1 @@
1
- export declare const version = "0.21.2";
1
+ export declare const version = "0.21.3";
@@ -1 +1 @@
1
- export const version = '0.21.2';
1
+ export const version = '0.21.3';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertexvis/api-client-node",
3
- "version": "0.21.2",
3
+ "version": "0.21.3",
4
4
  "description": "The Vertex REST API client for Node.js.",
5
5
  "license": "MIT",
6
6
  "author": "Vertex Developers <support@vertexvis.com> (https://developer.vertexvis.com)",