@vertexvis/api-client-node 0.22.1 → 0.22.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.js CHANGED
@@ -25,9 +25,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
25
25
  return (mod && mod.__esModule) ? mod : { "default": mod };
26
26
  };
27
27
  Object.defineProperty(exports, "__esModule", { value: true });
28
- exports.BatchesApiFactory = exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.ViewRepByPredefinedIdOpIdEnum = exports.ViewRepByPredefinedIdOpTypeEnum = exports.ViewRepByIdOpTypeEnum = exports.ViewRenBySuppliedIdOpTypeEnum = exports.ViewRenByIdOpTypeEnum = exports.ViewDefaultRenOpTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOpTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PartRenditionRelationshipDataTypeEnum = exports.PartRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.ClearTransformOpTypeEnum = exports.ClearRepOpTypeEnum = exports.ClearRenOpTypeEnum = exports.ClearMaterialOpTypeEnum = exports.ChangeVisibilityOpTypeEnum = exports.ChangeTransformOpTypeEnum = exports.ChangeMaterialOpTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
29
- exports.SceneViewsApiAxiosParamCreator = exports.SceneViewStatesApi = exports.SceneViewStatesApiFactory = exports.SceneViewStatesApiFp = exports.SceneViewStatesApiAxiosParamCreator = exports.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.PartRenditionsApi = exports.PartRenditionsApiFactory = exports.PartRenditionsApiFp = exports.PartRenditionsApiAxiosParamCreator = exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = void 0;
30
- exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = exports.TranslationInspectionsApiFp = exports.TranslationInspectionsApiAxiosParamCreator = exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = exports.SceneViewsApiFactory = exports.SceneViewsApiFp = void 0;
28
+ exports.BatchesApiFp = exports.BatchesApiAxiosParamCreator = exports.ApplicationsApi = exports.ApplicationsApiFactory = exports.ApplicationsApiFp = exports.ApplicationsApiAxiosParamCreator = exports.AccountsApi = exports.AccountsApiFactory = exports.AccountsApiFp = exports.AccountsApiAxiosParamCreator = exports.WebhookSubscriptionDataAttributesStatusEnum = exports.WebhookEventDataRelationshipsOwnerDataTypeEnum = exports.ViewRepByPredefinedIdOpIdEnum = exports.ViewRepByPredefinedIdOpTypeEnum = exports.ViewRepByIdOpTypeEnum = exports.ViewRenBySuppliedIdOpTypeEnum = exports.ViewRenByIdOpTypeEnum = exports.ViewDefaultRenOpTypeEnum = exports.UpdateWebhookSubscriptionRequestDataAttributesStatusEnum = exports.UpdateSceneRequestDataAttributesStateEnum = exports.UpdateItemToDefaultRenditionOperationTypeEnum = exports.UpdateAccountRequestDataAttributesStatusEnum = exports.SelectOpTypeEnum = exports.SceneViewStateRelationshipDataTypeEnum = exports.SceneViewRelationshipDataTypeEnum = exports.SceneRelationshipDataTypeEnum = exports.SceneItemRelationshipDataTypeEnum = exports.QueryByIdDataAttributesTypeEnum = exports.QueryByIdDataTypeEnum = exports.QueryByCollectionDataAttributesTypeEnum = exports.QueryByCollectionDataTypeEnum = exports.QueryAll = exports.PartRenditionRelationshipDataTypeEnum = exports.PartRelationshipDataTypeEnum = exports.PartDataRelationshipsPartRevisionsTypeEnum = exports.GeometrySetRelationshipDataTypeEnum = exports.FileRelationshipDataTypeEnum = exports.ExportStateRelationshipDataTypeEnum = exports.ExportRelationshipDataTypeEnum = exports.DeselectOperationTypeEnum = exports.ClearTransformOpTypeEnum = exports.ClearRepOpTypeEnum = exports.ClearRenOpTypeEnum = exports.ClearMaterialOpTypeEnum = exports.ChangeVisibilityOpTypeEnum = exports.ChangeTransformOpTypeEnum = exports.ChangeMaterialOpTypeEnum = exports.CameraFitTypeEnum = exports.BatchOperationRefTypeEnum = exports.BatchOperationOpEnum = void 0;
29
+ exports.SceneSynchronizationsApi = exports.SceneSynchronizationsApiFactory = exports.SceneSynchronizationsApiFp = exports.SceneSynchronizationsApiAxiosParamCreator = exports.SceneItemsApi = exports.SceneItemsApiFactory = exports.SceneItemsApiFp = exports.SceneItemsApiAxiosParamCreator = exports.SceneItemOverridesApi = exports.SceneItemOverridesApiFactory = exports.SceneItemOverridesApiFp = exports.SceneItemOverridesApiAxiosParamCreator = exports.SceneAlterationsApi = exports.SceneAlterationsApiFactory = exports.SceneAlterationsApiFp = exports.SceneAlterationsApiAxiosParamCreator = exports.PartsApi = exports.PartsApiFactory = exports.PartsApiFp = exports.PartsApiAxiosParamCreator = exports.PartRevisionsApi = exports.PartRevisionsApiFactory = exports.PartRevisionsApiFp = exports.PartRevisionsApiAxiosParamCreator = exports.PartRenditionsApi = exports.PartRenditionsApiFactory = exports.PartRenditionsApiFp = exports.PartRenditionsApiAxiosParamCreator = exports.Oauth2Api = exports.Oauth2ApiFactory = exports.Oauth2ApiFp = exports.Oauth2ApiAxiosParamCreator = exports.HitsApi = exports.HitsApiFactory = exports.HitsApiFp = exports.HitsApiAxiosParamCreator = exports.GeometrySetsApi = exports.GeometrySetsApiFactory = exports.GeometrySetsApiFp = exports.GeometrySetsApiAxiosParamCreator = exports.FilesApi = exports.FilesApiFactory = exports.FilesApiFp = exports.FilesApiAxiosParamCreator = exports.ExportsApi = exports.ExportsApiFactory = exports.ExportsApiFp = exports.ExportsApiAxiosParamCreator = exports.BatchesApi = exports.BatchesApiFactory = void 0;
30
+ exports.WebhookSubscriptionsApi = exports.WebhookSubscriptionsApiFactory = exports.WebhookSubscriptionsApiFp = exports.WebhookSubscriptionsApiAxiosParamCreator = exports.TranslationInspectionsApi = exports.TranslationInspectionsApiFactory = exports.TranslationInspectionsApiFp = exports.TranslationInspectionsApiAxiosParamCreator = exports.StreamKeysApi = exports.StreamKeysApiFactory = exports.StreamKeysApiFp = exports.StreamKeysApiAxiosParamCreator = exports.ScenesApi = exports.ScenesApiFactory = exports.ScenesApiFp = exports.ScenesApiAxiosParamCreator = exports.SceneViewsApi = exports.SceneViewsApiFactory = exports.SceneViewsApiFp = exports.SceneViewsApiAxiosParamCreator = exports.SceneViewStatesApi = exports.SceneViewStatesApiFactory = exports.SceneViewStatesApiFp = exports.SceneViewStatesApiAxiosParamCreator = void 0;
31
31
  const axios_1 = __importDefault(require("axios"));
32
32
  // Some imports not used depending on template conditions
33
33
  // @ts-ignore
@@ -130,6 +130,9 @@ exports.UpdateAccountRequestDataAttributesStatusEnum = {
130
130
  Active: 'active',
131
131
  Disabled: 'disabled',
132
132
  };
133
+ exports.UpdateItemToDefaultRenditionOperationTypeEnum = {
134
+ UpdateToDefaultRendition: 'update-to-default-rendition',
135
+ };
133
136
  exports.UpdateSceneRequestDataAttributesStateEnum = {
134
137
  Draft: 'draft',
135
138
  Commit: 'commit',
@@ -653,10 +656,11 @@ const ApplicationsApiAxiosParamCreator = function (configuration) {
653
656
  * Get `applications`.
654
657
  * @param {string} [pageCursor] The cursor for the next page of items.
655
658
  * @param {number} [pageSize] The number of items to return.
659
+ * @param {string} [filterClientId] Comma-separated list of client IDs to filter on.
656
660
  * @param {*} [options] Override http request option.
657
661
  * @throws {RequiredError}
658
662
  */
659
- getApplications: (pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
663
+ getApplications: (pageCursor, pageSize, filterClientId, options = {}) => __awaiter(this, void 0, void 0, function* () {
660
664
  var _d;
661
665
  const localVarPath = `/applications`;
662
666
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -677,6 +681,9 @@ const ApplicationsApiAxiosParamCreator = function (configuration) {
677
681
  if (pageSize !== undefined) {
678
682
  localVarQueryParameter['page[size]'] = pageSize;
679
683
  }
684
+ if (filterClientId !== undefined) {
685
+ localVarQueryParameter['filter[clientId]'] = filterClientId;
686
+ }
680
687
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
681
688
  let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
682
689
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -771,12 +778,13 @@ const ApplicationsApiFp = function (configuration) {
771
778
  * Get `applications`.
772
779
  * @param {string} [pageCursor] The cursor for the next page of items.
773
780
  * @param {number} [pageSize] The number of items to return.
781
+ * @param {string} [filterClientId] Comma-separated list of client IDs to filter on.
774
782
  * @param {*} [options] Override http request option.
775
783
  * @throws {RequiredError}
776
784
  */
777
- getApplications(pageCursor, pageSize, options) {
785
+ getApplications(pageCursor, pageSize, filterClientId, options) {
778
786
  return __awaiter(this, void 0, void 0, function* () {
779
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getApplications(pageCursor, pageSize, options);
787
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getApplications(pageCursor, pageSize, filterClientId, options);
780
788
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
781
789
  });
782
790
  },
@@ -840,12 +848,13 @@ const ApplicationsApiFactory = function (configuration, basePath, axios) {
840
848
  * Get `applications`.
841
849
  * @param {string} [pageCursor] The cursor for the next page of items.
842
850
  * @param {number} [pageSize] The number of items to return.
851
+ * @param {string} [filterClientId] Comma-separated list of client IDs to filter on.
843
852
  * @param {*} [options] Override http request option.
844
853
  * @throws {RequiredError}
845
854
  */
846
- getApplications(pageCursor, pageSize, options) {
855
+ getApplications(pageCursor, pageSize, filterClientId, options) {
847
856
  return localVarFp
848
- .getApplications(pageCursor, pageSize, options)
857
+ .getApplications(pageCursor, pageSize, filterClientId, options)
849
858
  .then((request) => request(axios, basePath));
850
859
  },
851
860
  /**
@@ -915,7 +924,7 @@ class ApplicationsApi extends base_1.BaseAPI {
915
924
  */
916
925
  getApplications(requestParameters = {}, options) {
917
926
  return (0, exports.ApplicationsApiFp)(this.configuration)
918
- .getApplications(requestParameters.pageCursor, requestParameters.pageSize, options)
927
+ .getApplications(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterClientId, options)
919
928
  .then((request) => request(this.axios, this.basePath));
920
929
  }
921
930
  /**
@@ -4985,6 +4994,333 @@ class SceneItemsApi extends base_1.BaseAPI {
4985
4994
  }
4986
4995
  }
4987
4996
  exports.SceneItemsApi = SceneItemsApi;
4997
+ /**
4998
+ * SceneSynchronizationsApi - axios parameter creator
4999
+ * @export
5000
+ */
5001
+ const SceneSynchronizationsApiAxiosParamCreator = function (configuration) {
5002
+ return {
5003
+ /**
5004
+ * Create a scene item update job.
5005
+ * @param {string} id The `scene` ID.
5006
+ * @param {CreateSceneSyncRequest} createSceneSyncRequest
5007
+ * @param {*} [options] Override http request option.
5008
+ * @throws {RequiredError}
5009
+ */
5010
+ createSceneSync: (id, createSceneSyncRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
5011
+ var _a;
5012
+ // verify required parameter 'id' is not null or undefined
5013
+ (0, common_1.assertParamExists)('createSceneSync', 'id', id);
5014
+ // verify required parameter 'createSceneSyncRequest' is not null or undefined
5015
+ (0, common_1.assertParamExists)('createSceneSync', 'createSceneSyncRequest', createSceneSyncRequest);
5016
+ const localVarPath = `/scenes/{id}/scene-syncs`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
5017
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5018
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
5019
+ let baseOptions;
5020
+ if (configuration) {
5021
+ baseOptions = configuration.baseOptions;
5022
+ }
5023
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
5024
+ const localVarHeaderParameter = {};
5025
+ const localVarQueryParameter = {};
5026
+ // authentication OAuth2 required
5027
+ // oauth required
5028
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
5029
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
5030
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
5031
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
5032
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
5033
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createSceneSyncRequest, localVarRequestOptions, configuration);
5034
+ return {
5035
+ url: (0, common_1.toPathString)(localVarUrlObj),
5036
+ options: localVarRequestOptions,
5037
+ };
5038
+ }),
5039
+ /**
5040
+ * Get a `queued-scene-sync-job`.
5041
+ * @param {string} id The `queued-scene-sync` ID.
5042
+ * @param {*} [options] Override http request option.
5043
+ * @throws {RequiredError}
5044
+ */
5045
+ getQueuedSceneSync: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
5046
+ var _b;
5047
+ // verify required parameter 'id' is not null or undefined
5048
+ (0, common_1.assertParamExists)('getQueuedSceneSync', 'id', id);
5049
+ const localVarPath = `/queued-scene-syncs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
5050
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5051
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
5052
+ let baseOptions;
5053
+ if (configuration) {
5054
+ baseOptions = configuration.baseOptions;
5055
+ }
5056
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
5057
+ const localVarHeaderParameter = {};
5058
+ const localVarQueryParameter = {};
5059
+ // authentication OAuth2 required
5060
+ // oauth required
5061
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
5062
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
5063
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
5064
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
5065
+ return {
5066
+ url: (0, common_1.toPathString)(localVarUrlObj),
5067
+ options: localVarRequestOptions,
5068
+ };
5069
+ }),
5070
+ /**
5071
+ * Get a `scene-sync`.
5072
+ * @param {string} id The `scene-sync` ID.
5073
+ * @param {*} [options] Override http request option.
5074
+ * @throws {RequiredError}
5075
+ */
5076
+ getSceneSync: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
5077
+ var _c;
5078
+ // verify required parameter 'id' is not null or undefined
5079
+ (0, common_1.assertParamExists)('getSceneSync', 'id', id);
5080
+ const localVarPath = `/scene-syncs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
5081
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5082
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
5083
+ let baseOptions;
5084
+ if (configuration) {
5085
+ baseOptions = configuration.baseOptions;
5086
+ }
5087
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
5088
+ const localVarHeaderParameter = {};
5089
+ const localVarQueryParameter = {};
5090
+ // authentication OAuth2 required
5091
+ // oauth required
5092
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
5093
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
5094
+ let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
5095
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
5096
+ return {
5097
+ url: (0, common_1.toPathString)(localVarUrlObj),
5098
+ options: localVarRequestOptions,
5099
+ };
5100
+ }),
5101
+ /**
5102
+ * Get the results of a scene synchronization.
5103
+ * @param {string} id The `scene-sync` ID.
5104
+ * @param {string} [pageCursor] The cursor for the next page of items.
5105
+ * @param {number} [pageSize] The number of items to return.
5106
+ * @param {string} [filterSceneItemId] List of scene item IDs to filter on.
5107
+ * @param {*} [options] Override http request option.
5108
+ * @throws {RequiredError}
5109
+ */
5110
+ getSceneSyncItemResults: (id, pageCursor, pageSize, filterSceneItemId, options = {}) => __awaiter(this, void 0, void 0, function* () {
5111
+ var _d;
5112
+ // verify required parameter 'id' is not null or undefined
5113
+ (0, common_1.assertParamExists)('getSceneSyncItemResults', 'id', id);
5114
+ const localVarPath = `/scene-syncs/{id}/item-results`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
5115
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5116
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
5117
+ let baseOptions;
5118
+ if (configuration) {
5119
+ baseOptions = configuration.baseOptions;
5120
+ }
5121
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
5122
+ const localVarHeaderParameter = {};
5123
+ const localVarQueryParameter = {};
5124
+ // authentication OAuth2 required
5125
+ // oauth required
5126
+ yield (0, common_1.setOAuthToObject)(localVarHeaderParameter, 'OAuth2', [], configuration);
5127
+ if (pageCursor !== undefined) {
5128
+ localVarQueryParameter['page[cursor]'] = pageCursor;
5129
+ }
5130
+ if (pageSize !== undefined) {
5131
+ localVarQueryParameter['page[size]'] = pageSize;
5132
+ }
5133
+ if (filterSceneItemId !== undefined) {
5134
+ localVarQueryParameter['filter[sceneItemId]'] = filterSceneItemId;
5135
+ }
5136
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
5137
+ let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
5138
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
5139
+ return {
5140
+ url: (0, common_1.toPathString)(localVarUrlObj),
5141
+ options: localVarRequestOptions,
5142
+ };
5143
+ }),
5144
+ };
5145
+ };
5146
+ exports.SceneSynchronizationsApiAxiosParamCreator = SceneSynchronizationsApiAxiosParamCreator;
5147
+ /**
5148
+ * SceneSynchronizationsApi - functional programming interface
5149
+ * @export
5150
+ */
5151
+ const SceneSynchronizationsApiFp = function (configuration) {
5152
+ const localVarAxiosParamCreator = (0, exports.SceneSynchronizationsApiAxiosParamCreator)(configuration);
5153
+ return {
5154
+ /**
5155
+ * Create a scene item update job.
5156
+ * @param {string} id The `scene` ID.
5157
+ * @param {CreateSceneSyncRequest} createSceneSyncRequest
5158
+ * @param {*} [options] Override http request option.
5159
+ * @throws {RequiredError}
5160
+ */
5161
+ createSceneSync(id, createSceneSyncRequest, options) {
5162
+ return __awaiter(this, void 0, void 0, function* () {
5163
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createSceneSync(id, createSceneSyncRequest, options);
5164
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
5165
+ });
5166
+ },
5167
+ /**
5168
+ * Get a `queued-scene-sync-job`.
5169
+ * @param {string} id The `queued-scene-sync` ID.
5170
+ * @param {*} [options] Override http request option.
5171
+ * @throws {RequiredError}
5172
+ */
5173
+ getQueuedSceneSync(id, options) {
5174
+ return __awaiter(this, void 0, void 0, function* () {
5175
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedSceneSync(id, options);
5176
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
5177
+ });
5178
+ },
5179
+ /**
5180
+ * Get a `scene-sync`.
5181
+ * @param {string} id The `scene-sync` ID.
5182
+ * @param {*} [options] Override http request option.
5183
+ * @throws {RequiredError}
5184
+ */
5185
+ getSceneSync(id, options) {
5186
+ return __awaiter(this, void 0, void 0, function* () {
5187
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneSync(id, options);
5188
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
5189
+ });
5190
+ },
5191
+ /**
5192
+ * Get the results of a scene synchronization.
5193
+ * @param {string} id The `scene-sync` ID.
5194
+ * @param {string} [pageCursor] The cursor for the next page of items.
5195
+ * @param {number} [pageSize] The number of items to return.
5196
+ * @param {string} [filterSceneItemId] List of scene item IDs to filter on.
5197
+ * @param {*} [options] Override http request option.
5198
+ * @throws {RequiredError}
5199
+ */
5200
+ getSceneSyncItemResults(id, pageCursor, pageSize, filterSceneItemId, options) {
5201
+ return __awaiter(this, void 0, void 0, function* () {
5202
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneSyncItemResults(id, pageCursor, pageSize, filterSceneItemId, options);
5203
+ return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
5204
+ });
5205
+ },
5206
+ };
5207
+ };
5208
+ exports.SceneSynchronizationsApiFp = SceneSynchronizationsApiFp;
5209
+ /**
5210
+ * SceneSynchronizationsApi - factory interface
5211
+ * @export
5212
+ */
5213
+ const SceneSynchronizationsApiFactory = function (configuration, basePath, axios) {
5214
+ const localVarFp = (0, exports.SceneSynchronizationsApiFp)(configuration);
5215
+ return {
5216
+ /**
5217
+ * Create a scene item update job.
5218
+ * @param {string} id The `scene` ID.
5219
+ * @param {CreateSceneSyncRequest} createSceneSyncRequest
5220
+ * @param {*} [options] Override http request option.
5221
+ * @throws {RequiredError}
5222
+ */
5223
+ createSceneSync(id, createSceneSyncRequest, options) {
5224
+ return localVarFp
5225
+ .createSceneSync(id, createSceneSyncRequest, options)
5226
+ .then((request) => request(axios, basePath));
5227
+ },
5228
+ /**
5229
+ * Get a `queued-scene-sync-job`.
5230
+ * @param {string} id The `queued-scene-sync` ID.
5231
+ * @param {*} [options] Override http request option.
5232
+ * @throws {RequiredError}
5233
+ */
5234
+ getQueuedSceneSync(id, options) {
5235
+ return localVarFp
5236
+ .getQueuedSceneSync(id, options)
5237
+ .then((request) => request(axios, basePath));
5238
+ },
5239
+ /**
5240
+ * Get a `scene-sync`.
5241
+ * @param {string} id The `scene-sync` ID.
5242
+ * @param {*} [options] Override http request option.
5243
+ * @throws {RequiredError}
5244
+ */
5245
+ getSceneSync(id, options) {
5246
+ return localVarFp
5247
+ .getSceneSync(id, options)
5248
+ .then((request) => request(axios, basePath));
5249
+ },
5250
+ /**
5251
+ * Get the results of a scene synchronization.
5252
+ * @param {string} id The `scene-sync` ID.
5253
+ * @param {string} [pageCursor] The cursor for the next page of items.
5254
+ * @param {number} [pageSize] The number of items to return.
5255
+ * @param {string} [filterSceneItemId] List of scene item IDs to filter on.
5256
+ * @param {*} [options] Override http request option.
5257
+ * @throws {RequiredError}
5258
+ */
5259
+ getSceneSyncItemResults(id, pageCursor, pageSize, filterSceneItemId, options) {
5260
+ return localVarFp
5261
+ .getSceneSyncItemResults(id, pageCursor, pageSize, filterSceneItemId, options)
5262
+ .then((request) => request(axios, basePath));
5263
+ },
5264
+ };
5265
+ };
5266
+ exports.SceneSynchronizationsApiFactory = SceneSynchronizationsApiFactory;
5267
+ /**
5268
+ * SceneSynchronizationsApi - object-oriented interface
5269
+ * @export
5270
+ * @class SceneSynchronizationsApi
5271
+ * @extends {BaseAPI}
5272
+ */
5273
+ class SceneSynchronizationsApi extends base_1.BaseAPI {
5274
+ /**
5275
+ * Create a scene item update job.
5276
+ * @param {SceneSynchronizationsApiCreateSceneSyncRequest} requestParameters Request parameters.
5277
+ * @param {*} [options] Override http request option.
5278
+ * @throws {RequiredError}
5279
+ * @memberof SceneSynchronizationsApi
5280
+ */
5281
+ createSceneSync(requestParameters, options) {
5282
+ return (0, exports.SceneSynchronizationsApiFp)(this.configuration)
5283
+ .createSceneSync(requestParameters.id, requestParameters.createSceneSyncRequest, options)
5284
+ .then((request) => request(this.axios, this.basePath));
5285
+ }
5286
+ /**
5287
+ * Get a `queued-scene-sync-job`.
5288
+ * @param {SceneSynchronizationsApiGetQueuedSceneSyncRequest} requestParameters Request parameters.
5289
+ * @param {*} [options] Override http request option.
5290
+ * @throws {RequiredError}
5291
+ * @memberof SceneSynchronizationsApi
5292
+ */
5293
+ getQueuedSceneSync(requestParameters, options) {
5294
+ return (0, exports.SceneSynchronizationsApiFp)(this.configuration)
5295
+ .getQueuedSceneSync(requestParameters.id, options)
5296
+ .then((request) => request(this.axios, this.basePath));
5297
+ }
5298
+ /**
5299
+ * Get a `scene-sync`.
5300
+ * @param {SceneSynchronizationsApiGetSceneSyncRequest} requestParameters Request parameters.
5301
+ * @param {*} [options] Override http request option.
5302
+ * @throws {RequiredError}
5303
+ * @memberof SceneSynchronizationsApi
5304
+ */
5305
+ getSceneSync(requestParameters, options) {
5306
+ return (0, exports.SceneSynchronizationsApiFp)(this.configuration)
5307
+ .getSceneSync(requestParameters.id, options)
5308
+ .then((request) => request(this.axios, this.basePath));
5309
+ }
5310
+ /**
5311
+ * Get the results of a scene synchronization.
5312
+ * @param {SceneSynchronizationsApiGetSceneSyncItemResultsRequest} requestParameters Request parameters.
5313
+ * @param {*} [options] Override http request option.
5314
+ * @throws {RequiredError}
5315
+ * @memberof SceneSynchronizationsApi
5316
+ */
5317
+ getSceneSyncItemResults(requestParameters, options) {
5318
+ return (0, exports.SceneSynchronizationsApiFp)(this.configuration)
5319
+ .getSceneSyncItemResults(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSceneItemId, options)
5320
+ .then((request) => request(this.axios, this.basePath));
5321
+ }
5322
+ }
5323
+ exports.SceneSynchronizationsApi = SceneSynchronizationsApi;
4988
5324
  /**
4989
5325
  * SceneViewStatesApi - axios parameter creator
4990
5326
  * @export
@@ -6106,10 +6442,13 @@ const ScenesApiAxiosParamCreator = function (configuration) {
6106
6442
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
6107
6443
  * @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.
6108
6444
  * @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`.
6445
+ * @param {string} [filterSceneItemsSourcePartRevision] Comma-separated list of scene-item source part revision IDs to filter on.
6446
+ * @param {string} [filterSceneItemsSourceGeometrySet] Comma-separated list of scene-item source geometry set IDs to filter on.
6447
+ * @param {string} [filterSceneItemsSourceScene] Comma-separated list of scene-item source scene IDs to filter on.
6109
6448
  * @param {*} [options] Override http request option.
6110
6449
  * @throws {RequiredError}
6111
6450
  */
6112
- getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options = {}) => __awaiter(this, void 0, void 0, function* () {
6451
+ getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options = {}) => __awaiter(this, void 0, void 0, function* () {
6113
6452
  var _e;
6114
6453
  const localVarPath = `/scenes`;
6115
6454
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -6142,6 +6481,18 @@ const ScenesApiAxiosParamCreator = function (configuration) {
6142
6481
  if (filterMetadata !== undefined) {
6143
6482
  localVarQueryParameter['filter[metadata]'] = filterMetadata;
6144
6483
  }
6484
+ if (filterSceneItemsSourcePartRevision !== undefined) {
6485
+ localVarQueryParameter['filter[sceneItems.source.partRevision]'] =
6486
+ filterSceneItemsSourcePartRevision;
6487
+ }
6488
+ if (filterSceneItemsSourceGeometrySet !== undefined) {
6489
+ localVarQueryParameter['filter[sceneItems.source.geometrySet]'] =
6490
+ filterSceneItemsSourceGeometrySet;
6491
+ }
6492
+ if (filterSceneItemsSourceScene !== undefined) {
6493
+ localVarQueryParameter['filter[sceneItems.source.scene]'] =
6494
+ filterSceneItemsSourceScene;
6495
+ }
6145
6496
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
6146
6497
  let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
6147
6498
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -6292,12 +6643,15 @@ const ScenesApiFp = function (configuration) {
6292
6643
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
6293
6644
  * @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.
6294
6645
  * @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`.
6646
+ * @param {string} [filterSceneItemsSourcePartRevision] Comma-separated list of scene-item source part revision IDs to filter on.
6647
+ * @param {string} [filterSceneItemsSourceGeometrySet] Comma-separated list of scene-item source geometry set IDs to filter on.
6648
+ * @param {string} [filterSceneItemsSourceScene] Comma-separated list of scene-item source scene IDs to filter on.
6295
6649
  * @param {*} [options] Override http request option.
6296
6650
  * @throws {RequiredError}
6297
6651
  */
6298
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
6652
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options) {
6299
6653
  return __awaiter(this, void 0, void 0, function* () {
6300
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options);
6654
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options);
6301
6655
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
6302
6656
  });
6303
6657
  },
@@ -6391,12 +6745,15 @@ const ScenesApiFactory = function (configuration, basePath, axios) {
6391
6745
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
6392
6746
  * @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.
6393
6747
  * @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`.
6748
+ * @param {string} [filterSceneItemsSourcePartRevision] Comma-separated list of scene-item source part revision IDs to filter on.
6749
+ * @param {string} [filterSceneItemsSourceGeometrySet] Comma-separated list of scene-item source geometry set IDs to filter on.
6750
+ * @param {string} [filterSceneItemsSourceScene] Comma-separated list of scene-item source scene IDs to filter on.
6394
6751
  * @param {*} [options] Override http request option.
6395
6752
  * @throws {RequiredError}
6396
6753
  */
6397
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
6754
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options) {
6398
6755
  return localVarFp
6399
- .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options)
6756
+ .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options)
6400
6757
  .then((request) => request(axios, basePath));
6401
6758
  },
6402
6759
  /**
@@ -6491,7 +6848,7 @@ class ScenesApi extends base_1.BaseAPI {
6491
6848
  */
6492
6849
  getScenes(requestParameters = {}, options) {
6493
6850
  return (0, exports.ScenesApiFp)(this.configuration)
6494
- .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, requestParameters.filterMetadata, options)
6851
+ .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, requestParameters.filterMetadata, requestParameters.filterSceneItemsSourcePartRevision, requestParameters.filterSceneItemsSourceGeometrySet, requestParameters.filterSceneItemsSourceScene, options)
6495
6852
  .then((request) => request(this.axios, this.basePath));
6496
6853
  }
6497
6854
  /**
@@ -64,7 +64,7 @@ function createPartFromFile(_a) {
64
64
  : undefined;
65
65
  const pollRes = yield (0, queued_jobs_1.pollQueuedJob)({
66
66
  id: queuedId,
67
- getQueuedJob: (id) => client.translationInspections.getQueuedTranslation({ id }),
67
+ getQueuedJob: (id) => client.translationInspections.getQueuedTranslationJob({ id }),
68
68
  polling,
69
69
  });
70
70
  if ((0, queued_jobs_1.isPollError)(pollRes.res))
@@ -32,7 +32,7 @@ interface PollJobRes<T> {
32
32
  * @param req - {@link PollQueuedJobReq}.
33
33
  * @returns {@link PollQueuedJobRes}.
34
34
  */
35
- export declare function pollQueuedJob<T>({ id, getQueuedJob, allow404, limit, polling: { intervalMs, maxAttempts }, }: PollQueuedJobReq): Promise<PollQueuedJobRes<T>>;
35
+ export declare function pollQueuedJob<T>({ id, getQueuedJob, allow404, limit, polling: { intervalMs, maxAttempts, backoff }, }: PollQueuedJobReq): Promise<PollQueuedJobRes<T>>;
36
36
  export declare function isPollError<T>(r: PollRes<T>): r is QueuedJob | Failure;
37
37
  export declare function isBatch(obj: PollRes<Batch>): obj is Batch;
38
38
  export declare function throwOnError<T>(r: PollQueuedJobRes<T>): never;
@@ -29,7 +29,8 @@ const Debug = false;
29
29
  * @param req - {@link PollQueuedJobReq}.
30
30
  * @returns {@link PollQueuedJobRes}.
31
31
  */
32
- function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { intervalMs, maxAttempts }, }) {
32
+ function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { intervalMs, maxAttempts, backoff }, }) {
33
+ var _a, _b;
33
34
  return __awaiter(this, void 0, void 0, function* () {
34
35
  function poll(attempt) {
35
36
  var _a, _b;
@@ -72,6 +73,8 @@ function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { i
72
73
  });
73
74
  }
74
75
  let attempts = 1;
76
+ let backoffMs = (_a = backoff === null || backoff === void 0 ? void 0 : backoff[attempts]) !== null && _a !== void 0 ? _a : 0;
77
+ // eslint-disable-next-line prefer-const
75
78
  let pollRes = yield poll(attempts);
76
79
  /* eslint-disable no-await-in-loop */
77
80
  while (!completeJob(pollRes.res) &&
@@ -80,7 +83,8 @@ function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { i
80
83
  isClientError(pollRes.res)) &&
81
84
  attempts <= maxAttempts) {
82
85
  attempts += 1;
83
- yield (0, utils_1.delay)(intervalMs);
86
+ backoffMs = (_b = backoff === null || backoff === void 0 ? void 0 : backoff[attempts]) !== null && _b !== void 0 ? _b : backoffMs;
87
+ yield (0, utils_1.delay)(intervalMs + backoffMs);
84
88
  pollRes = yield poll(attempts);
85
89
  }
86
90
  /* eslint-enable no-await-in-loop */
@@ -26,6 +26,11 @@ export interface Polling {
26
26
  readonly intervalMs: number;
27
27
  /** Maximum number of polling attempts. */
28
28
  readonly maxAttempts: number;
29
+ /**
30
+ * A map of polling attempt numbers to a delay in milliseconds.
31
+ * Once the attempts are reach, the backoff will be added to `intervalMs`.
32
+ */
33
+ readonly backoff?: Record<number, number | undefined>;
29
34
  }
30
35
  /**
31
36
  * Render image arguments. Render functions return Streams. Here's an
@@ -1 +1 @@
1
- export declare const version = "0.22.1";
1
+ export declare const version = "0.22.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.22.1';
4
+ exports.version = '0.22.3';