@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.d.ts +666 -13
- package/dist/cjs/api.js +372 -15
- package/dist/cjs/client/helpers/parts.js +1 -1
- package/dist/cjs/client/helpers/queued-jobs.d.ts +1 -1
- package/dist/cjs/client/helpers/queued-jobs.js +6 -2
- package/dist/cjs/client/index.d.ts +5 -0
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +666 -13
- package/dist/esm/api.js +365 -12
- package/dist/esm/client/helpers/parts.js +1 -1
- package/dist/esm/client/helpers/queued-jobs.d.ts +1 -1
- package/dist/esm/client/helpers/queued-jobs.js +6 -2
- package/dist/esm/client/index.d.ts +5 -0
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/package.json +2 -2
package/dist/esm/api.js
CHANGED
|
@@ -122,6 +122,9 @@ export const UpdateAccountRequestDataAttributesStatusEnum = {
|
|
|
122
122
|
Active: 'active',
|
|
123
123
|
Disabled: 'disabled',
|
|
124
124
|
};
|
|
125
|
+
export const UpdateItemToDefaultRenditionOperationTypeEnum = {
|
|
126
|
+
UpdateToDefaultRendition: 'update-to-default-rendition',
|
|
127
|
+
};
|
|
125
128
|
export const UpdateSceneRequestDataAttributesStateEnum = {
|
|
126
129
|
Draft: 'draft',
|
|
127
130
|
Commit: 'commit',
|
|
@@ -641,10 +644,11 @@ export const ApplicationsApiAxiosParamCreator = function (configuration) {
|
|
|
641
644
|
* Get `applications`.
|
|
642
645
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
643
646
|
* @param {number} [pageSize] The number of items to return.
|
|
647
|
+
* @param {string} [filterClientId] Comma-separated list of client IDs to filter on.
|
|
644
648
|
* @param {*} [options] Override http request option.
|
|
645
649
|
* @throws {RequiredError}
|
|
646
650
|
*/
|
|
647
|
-
getApplications: (pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
651
|
+
getApplications: (pageCursor, pageSize, filterClientId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
648
652
|
var _d;
|
|
649
653
|
const localVarPath = `/applications`;
|
|
650
654
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -665,6 +669,9 @@ export const ApplicationsApiAxiosParamCreator = function (configuration) {
|
|
|
665
669
|
if (pageSize !== undefined) {
|
|
666
670
|
localVarQueryParameter['page[size]'] = pageSize;
|
|
667
671
|
}
|
|
672
|
+
if (filterClientId !== undefined) {
|
|
673
|
+
localVarQueryParameter['filter[clientId]'] = filterClientId;
|
|
674
|
+
}
|
|
668
675
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
669
676
|
let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
|
|
670
677
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -758,12 +765,13 @@ export const ApplicationsApiFp = function (configuration) {
|
|
|
758
765
|
* Get `applications`.
|
|
759
766
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
760
767
|
* @param {number} [pageSize] The number of items to return.
|
|
768
|
+
* @param {string} [filterClientId] Comma-separated list of client IDs to filter on.
|
|
761
769
|
* @param {*} [options] Override http request option.
|
|
762
770
|
* @throws {RequiredError}
|
|
763
771
|
*/
|
|
764
|
-
getApplications(pageCursor, pageSize, options) {
|
|
772
|
+
getApplications(pageCursor, pageSize, filterClientId, options) {
|
|
765
773
|
return __awaiter(this, void 0, void 0, function* () {
|
|
766
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getApplications(pageCursor, pageSize, options);
|
|
774
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getApplications(pageCursor, pageSize, filterClientId, options);
|
|
767
775
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
768
776
|
});
|
|
769
777
|
},
|
|
@@ -826,12 +834,13 @@ export const ApplicationsApiFactory = function (configuration, basePath, axios)
|
|
|
826
834
|
* Get `applications`.
|
|
827
835
|
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
828
836
|
* @param {number} [pageSize] The number of items to return.
|
|
837
|
+
* @param {string} [filterClientId] Comma-separated list of client IDs to filter on.
|
|
829
838
|
* @param {*} [options] Override http request option.
|
|
830
839
|
* @throws {RequiredError}
|
|
831
840
|
*/
|
|
832
|
-
getApplications(pageCursor, pageSize, options) {
|
|
841
|
+
getApplications(pageCursor, pageSize, filterClientId, options) {
|
|
833
842
|
return localVarFp
|
|
834
|
-
.getApplications(pageCursor, pageSize, options)
|
|
843
|
+
.getApplications(pageCursor, pageSize, filterClientId, options)
|
|
835
844
|
.then((request) => request(axios, basePath));
|
|
836
845
|
},
|
|
837
846
|
/**
|
|
@@ -900,7 +909,7 @@ export class ApplicationsApi extends BaseAPI {
|
|
|
900
909
|
*/
|
|
901
910
|
getApplications(requestParameters = {}, options) {
|
|
902
911
|
return ApplicationsApiFp(this.configuration)
|
|
903
|
-
.getApplications(requestParameters.pageCursor, requestParameters.pageSize, options)
|
|
912
|
+
.getApplications(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterClientId, options)
|
|
904
913
|
.then((request) => request(this.axios, this.basePath));
|
|
905
914
|
}
|
|
906
915
|
/**
|
|
@@ -4921,6 +4930,329 @@ export class SceneItemsApi extends BaseAPI {
|
|
|
4921
4930
|
.then((request) => request(this.axios, this.basePath));
|
|
4922
4931
|
}
|
|
4923
4932
|
}
|
|
4933
|
+
/**
|
|
4934
|
+
* SceneSynchronizationsApi - axios parameter creator
|
|
4935
|
+
* @export
|
|
4936
|
+
*/
|
|
4937
|
+
export const SceneSynchronizationsApiAxiosParamCreator = function (configuration) {
|
|
4938
|
+
return {
|
|
4939
|
+
/**
|
|
4940
|
+
* Create a scene item update job.
|
|
4941
|
+
* @param {string} id The `scene` ID.
|
|
4942
|
+
* @param {CreateSceneSyncRequest} createSceneSyncRequest
|
|
4943
|
+
* @param {*} [options] Override http request option.
|
|
4944
|
+
* @throws {RequiredError}
|
|
4945
|
+
*/
|
|
4946
|
+
createSceneSync: (id, createSceneSyncRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4947
|
+
var _a;
|
|
4948
|
+
// verify required parameter 'id' is not null or undefined
|
|
4949
|
+
assertParamExists('createSceneSync', 'id', id);
|
|
4950
|
+
// verify required parameter 'createSceneSyncRequest' is not null or undefined
|
|
4951
|
+
assertParamExists('createSceneSync', 'createSceneSyncRequest', createSceneSyncRequest);
|
|
4952
|
+
const localVarPath = `/scenes/{id}/scene-syncs`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
4953
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4954
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4955
|
+
let baseOptions;
|
|
4956
|
+
if (configuration) {
|
|
4957
|
+
baseOptions = configuration.baseOptions;
|
|
4958
|
+
}
|
|
4959
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
4960
|
+
const localVarHeaderParameter = {};
|
|
4961
|
+
const localVarQueryParameter = {};
|
|
4962
|
+
// authentication OAuth2 required
|
|
4963
|
+
// oauth required
|
|
4964
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
4965
|
+
localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
|
|
4966
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4967
|
+
let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
|
|
4968
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
4969
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createSceneSyncRequest, localVarRequestOptions, configuration);
|
|
4970
|
+
return {
|
|
4971
|
+
url: toPathString(localVarUrlObj),
|
|
4972
|
+
options: localVarRequestOptions,
|
|
4973
|
+
};
|
|
4974
|
+
}),
|
|
4975
|
+
/**
|
|
4976
|
+
* Get a `queued-scene-sync-job`.
|
|
4977
|
+
* @param {string} id The `queued-scene-sync` ID.
|
|
4978
|
+
* @param {*} [options] Override http request option.
|
|
4979
|
+
* @throws {RequiredError}
|
|
4980
|
+
*/
|
|
4981
|
+
getQueuedSceneSync: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
4982
|
+
var _b;
|
|
4983
|
+
// verify required parameter 'id' is not null or undefined
|
|
4984
|
+
assertParamExists('getQueuedSceneSync', 'id', id);
|
|
4985
|
+
const localVarPath = `/queued-scene-syncs/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
4986
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
4987
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
4988
|
+
let baseOptions;
|
|
4989
|
+
if (configuration) {
|
|
4990
|
+
baseOptions = configuration.baseOptions;
|
|
4991
|
+
}
|
|
4992
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
4993
|
+
const localVarHeaderParameter = {};
|
|
4994
|
+
const localVarQueryParameter = {};
|
|
4995
|
+
// authentication OAuth2 required
|
|
4996
|
+
// oauth required
|
|
4997
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
4998
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
4999
|
+
let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
|
|
5000
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5001
|
+
return {
|
|
5002
|
+
url: toPathString(localVarUrlObj),
|
|
5003
|
+
options: localVarRequestOptions,
|
|
5004
|
+
};
|
|
5005
|
+
}),
|
|
5006
|
+
/**
|
|
5007
|
+
* Get a `scene-sync`.
|
|
5008
|
+
* @param {string} id The `scene-sync` ID.
|
|
5009
|
+
* @param {*} [options] Override http request option.
|
|
5010
|
+
* @throws {RequiredError}
|
|
5011
|
+
*/
|
|
5012
|
+
getSceneSync: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
5013
|
+
var _c;
|
|
5014
|
+
// verify required parameter 'id' is not null or undefined
|
|
5015
|
+
assertParamExists('getSceneSync', 'id', id);
|
|
5016
|
+
const localVarPath = `/scene-syncs/{id}`.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, DUMMY_BASE_URL);
|
|
5019
|
+
let baseOptions;
|
|
5020
|
+
if (configuration) {
|
|
5021
|
+
baseOptions = configuration.baseOptions;
|
|
5022
|
+
}
|
|
5023
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
5024
|
+
const localVarHeaderParameter = {};
|
|
5025
|
+
const localVarQueryParameter = {};
|
|
5026
|
+
// authentication OAuth2 required
|
|
5027
|
+
// oauth required
|
|
5028
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
5029
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5030
|
+
let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
|
|
5031
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5032
|
+
return {
|
|
5033
|
+
url: toPathString(localVarUrlObj),
|
|
5034
|
+
options: localVarRequestOptions,
|
|
5035
|
+
};
|
|
5036
|
+
}),
|
|
5037
|
+
/**
|
|
5038
|
+
* Get the results of a scene synchronization.
|
|
5039
|
+
* @param {string} id The `scene-sync` ID.
|
|
5040
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
5041
|
+
* @param {number} [pageSize] The number of items to return.
|
|
5042
|
+
* @param {string} [filterSceneItemId] List of scene item IDs to filter on.
|
|
5043
|
+
* @param {*} [options] Override http request option.
|
|
5044
|
+
* @throws {RequiredError}
|
|
5045
|
+
*/
|
|
5046
|
+
getSceneSyncItemResults: (id, pageCursor, pageSize, filterSceneItemId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
5047
|
+
var _d;
|
|
5048
|
+
// verify required parameter 'id' is not null or undefined
|
|
5049
|
+
assertParamExists('getSceneSyncItemResults', 'id', id);
|
|
5050
|
+
const localVarPath = `/scene-syncs/{id}/item-results`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
|
|
5051
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5052
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
5053
|
+
let baseOptions;
|
|
5054
|
+
if (configuration) {
|
|
5055
|
+
baseOptions = configuration.baseOptions;
|
|
5056
|
+
}
|
|
5057
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
5058
|
+
const localVarHeaderParameter = {};
|
|
5059
|
+
const localVarQueryParameter = {};
|
|
5060
|
+
// authentication OAuth2 required
|
|
5061
|
+
// oauth required
|
|
5062
|
+
yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
|
|
5063
|
+
if (pageCursor !== undefined) {
|
|
5064
|
+
localVarQueryParameter['page[cursor]'] = pageCursor;
|
|
5065
|
+
}
|
|
5066
|
+
if (pageSize !== undefined) {
|
|
5067
|
+
localVarQueryParameter['page[size]'] = pageSize;
|
|
5068
|
+
}
|
|
5069
|
+
if (filterSceneItemId !== undefined) {
|
|
5070
|
+
localVarQueryParameter['filter[sceneItemId]'] = filterSceneItemId;
|
|
5071
|
+
}
|
|
5072
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5073
|
+
let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
|
|
5074
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
5075
|
+
return {
|
|
5076
|
+
url: toPathString(localVarUrlObj),
|
|
5077
|
+
options: localVarRequestOptions,
|
|
5078
|
+
};
|
|
5079
|
+
}),
|
|
5080
|
+
};
|
|
5081
|
+
};
|
|
5082
|
+
/**
|
|
5083
|
+
* SceneSynchronizationsApi - functional programming interface
|
|
5084
|
+
* @export
|
|
5085
|
+
*/
|
|
5086
|
+
export const SceneSynchronizationsApiFp = function (configuration) {
|
|
5087
|
+
const localVarAxiosParamCreator = SceneSynchronizationsApiAxiosParamCreator(configuration);
|
|
5088
|
+
return {
|
|
5089
|
+
/**
|
|
5090
|
+
* Create a scene item update job.
|
|
5091
|
+
* @param {string} id The `scene` ID.
|
|
5092
|
+
* @param {CreateSceneSyncRequest} createSceneSyncRequest
|
|
5093
|
+
* @param {*} [options] Override http request option.
|
|
5094
|
+
* @throws {RequiredError}
|
|
5095
|
+
*/
|
|
5096
|
+
createSceneSync(id, createSceneSyncRequest, options) {
|
|
5097
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5098
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.createSceneSync(id, createSceneSyncRequest, options);
|
|
5099
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5100
|
+
});
|
|
5101
|
+
},
|
|
5102
|
+
/**
|
|
5103
|
+
* Get a `queued-scene-sync-job`.
|
|
5104
|
+
* @param {string} id The `queued-scene-sync` ID.
|
|
5105
|
+
* @param {*} [options] Override http request option.
|
|
5106
|
+
* @throws {RequiredError}
|
|
5107
|
+
*/
|
|
5108
|
+
getQueuedSceneSync(id, options) {
|
|
5109
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5110
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getQueuedSceneSync(id, options);
|
|
5111
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5112
|
+
});
|
|
5113
|
+
},
|
|
5114
|
+
/**
|
|
5115
|
+
* Get a `scene-sync`.
|
|
5116
|
+
* @param {string} id The `scene-sync` ID.
|
|
5117
|
+
* @param {*} [options] Override http request option.
|
|
5118
|
+
* @throws {RequiredError}
|
|
5119
|
+
*/
|
|
5120
|
+
getSceneSync(id, options) {
|
|
5121
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5122
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneSync(id, options);
|
|
5123
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5124
|
+
});
|
|
5125
|
+
},
|
|
5126
|
+
/**
|
|
5127
|
+
* Get the results of a scene synchronization.
|
|
5128
|
+
* @param {string} id The `scene-sync` ID.
|
|
5129
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
5130
|
+
* @param {number} [pageSize] The number of items to return.
|
|
5131
|
+
* @param {string} [filterSceneItemId] List of scene item IDs to filter on.
|
|
5132
|
+
* @param {*} [options] Override http request option.
|
|
5133
|
+
* @throws {RequiredError}
|
|
5134
|
+
*/
|
|
5135
|
+
getSceneSyncItemResults(id, pageCursor, pageSize, filterSceneItemId, options) {
|
|
5136
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
5137
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getSceneSyncItemResults(id, pageCursor, pageSize, filterSceneItemId, options);
|
|
5138
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5139
|
+
});
|
|
5140
|
+
},
|
|
5141
|
+
};
|
|
5142
|
+
};
|
|
5143
|
+
/**
|
|
5144
|
+
* SceneSynchronizationsApi - factory interface
|
|
5145
|
+
* @export
|
|
5146
|
+
*/
|
|
5147
|
+
export const SceneSynchronizationsApiFactory = function (configuration, basePath, axios) {
|
|
5148
|
+
const localVarFp = SceneSynchronizationsApiFp(configuration);
|
|
5149
|
+
return {
|
|
5150
|
+
/**
|
|
5151
|
+
* Create a scene item update job.
|
|
5152
|
+
* @param {string} id The `scene` ID.
|
|
5153
|
+
* @param {CreateSceneSyncRequest} createSceneSyncRequest
|
|
5154
|
+
* @param {*} [options] Override http request option.
|
|
5155
|
+
* @throws {RequiredError}
|
|
5156
|
+
*/
|
|
5157
|
+
createSceneSync(id, createSceneSyncRequest, options) {
|
|
5158
|
+
return localVarFp
|
|
5159
|
+
.createSceneSync(id, createSceneSyncRequest, options)
|
|
5160
|
+
.then((request) => request(axios, basePath));
|
|
5161
|
+
},
|
|
5162
|
+
/**
|
|
5163
|
+
* Get a `queued-scene-sync-job`.
|
|
5164
|
+
* @param {string} id The `queued-scene-sync` ID.
|
|
5165
|
+
* @param {*} [options] Override http request option.
|
|
5166
|
+
* @throws {RequiredError}
|
|
5167
|
+
*/
|
|
5168
|
+
getQueuedSceneSync(id, options) {
|
|
5169
|
+
return localVarFp
|
|
5170
|
+
.getQueuedSceneSync(id, options)
|
|
5171
|
+
.then((request) => request(axios, basePath));
|
|
5172
|
+
},
|
|
5173
|
+
/**
|
|
5174
|
+
* Get a `scene-sync`.
|
|
5175
|
+
* @param {string} id The `scene-sync` ID.
|
|
5176
|
+
* @param {*} [options] Override http request option.
|
|
5177
|
+
* @throws {RequiredError}
|
|
5178
|
+
*/
|
|
5179
|
+
getSceneSync(id, options) {
|
|
5180
|
+
return localVarFp
|
|
5181
|
+
.getSceneSync(id, options)
|
|
5182
|
+
.then((request) => request(axios, basePath));
|
|
5183
|
+
},
|
|
5184
|
+
/**
|
|
5185
|
+
* Get the results of a scene synchronization.
|
|
5186
|
+
* @param {string} id The `scene-sync` ID.
|
|
5187
|
+
* @param {string} [pageCursor] The cursor for the next page of items.
|
|
5188
|
+
* @param {number} [pageSize] The number of items to return.
|
|
5189
|
+
* @param {string} [filterSceneItemId] List of scene item IDs to filter on.
|
|
5190
|
+
* @param {*} [options] Override http request option.
|
|
5191
|
+
* @throws {RequiredError}
|
|
5192
|
+
*/
|
|
5193
|
+
getSceneSyncItemResults(id, pageCursor, pageSize, filterSceneItemId, options) {
|
|
5194
|
+
return localVarFp
|
|
5195
|
+
.getSceneSyncItemResults(id, pageCursor, pageSize, filterSceneItemId, options)
|
|
5196
|
+
.then((request) => request(axios, basePath));
|
|
5197
|
+
},
|
|
5198
|
+
};
|
|
5199
|
+
};
|
|
5200
|
+
/**
|
|
5201
|
+
* SceneSynchronizationsApi - object-oriented interface
|
|
5202
|
+
* @export
|
|
5203
|
+
* @class SceneSynchronizationsApi
|
|
5204
|
+
* @extends {BaseAPI}
|
|
5205
|
+
*/
|
|
5206
|
+
export class SceneSynchronizationsApi extends BaseAPI {
|
|
5207
|
+
/**
|
|
5208
|
+
* Create a scene item update job.
|
|
5209
|
+
* @param {SceneSynchronizationsApiCreateSceneSyncRequest} requestParameters Request parameters.
|
|
5210
|
+
* @param {*} [options] Override http request option.
|
|
5211
|
+
* @throws {RequiredError}
|
|
5212
|
+
* @memberof SceneSynchronizationsApi
|
|
5213
|
+
*/
|
|
5214
|
+
createSceneSync(requestParameters, options) {
|
|
5215
|
+
return SceneSynchronizationsApiFp(this.configuration)
|
|
5216
|
+
.createSceneSync(requestParameters.id, requestParameters.createSceneSyncRequest, options)
|
|
5217
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5218
|
+
}
|
|
5219
|
+
/**
|
|
5220
|
+
* Get a `queued-scene-sync-job`.
|
|
5221
|
+
* @param {SceneSynchronizationsApiGetQueuedSceneSyncRequest} requestParameters Request parameters.
|
|
5222
|
+
* @param {*} [options] Override http request option.
|
|
5223
|
+
* @throws {RequiredError}
|
|
5224
|
+
* @memberof SceneSynchronizationsApi
|
|
5225
|
+
*/
|
|
5226
|
+
getQueuedSceneSync(requestParameters, options) {
|
|
5227
|
+
return SceneSynchronizationsApiFp(this.configuration)
|
|
5228
|
+
.getQueuedSceneSync(requestParameters.id, options)
|
|
5229
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5230
|
+
}
|
|
5231
|
+
/**
|
|
5232
|
+
* Get a `scene-sync`.
|
|
5233
|
+
* @param {SceneSynchronizationsApiGetSceneSyncRequest} requestParameters Request parameters.
|
|
5234
|
+
* @param {*} [options] Override http request option.
|
|
5235
|
+
* @throws {RequiredError}
|
|
5236
|
+
* @memberof SceneSynchronizationsApi
|
|
5237
|
+
*/
|
|
5238
|
+
getSceneSync(requestParameters, options) {
|
|
5239
|
+
return SceneSynchronizationsApiFp(this.configuration)
|
|
5240
|
+
.getSceneSync(requestParameters.id, options)
|
|
5241
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5242
|
+
}
|
|
5243
|
+
/**
|
|
5244
|
+
* Get the results of a scene synchronization.
|
|
5245
|
+
* @param {SceneSynchronizationsApiGetSceneSyncItemResultsRequest} requestParameters Request parameters.
|
|
5246
|
+
* @param {*} [options] Override http request option.
|
|
5247
|
+
* @throws {RequiredError}
|
|
5248
|
+
* @memberof SceneSynchronizationsApi
|
|
5249
|
+
*/
|
|
5250
|
+
getSceneSyncItemResults(requestParameters, options) {
|
|
5251
|
+
return SceneSynchronizationsApiFp(this.configuration)
|
|
5252
|
+
.getSceneSyncItemResults(requestParameters.id, requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSceneItemId, options)
|
|
5253
|
+
.then((request) => request(this.axios, this.basePath));
|
|
5254
|
+
}
|
|
5255
|
+
}
|
|
4924
5256
|
/**
|
|
4925
5257
|
* SceneViewStatesApi - axios parameter creator
|
|
4926
5258
|
* @export
|
|
@@ -6034,10 +6366,13 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
|
|
|
6034
6366
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
6035
6367
|
* @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.
|
|
6036
6368
|
* @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`.
|
|
6369
|
+
* @param {string} [filterSceneItemsSourcePartRevision] Comma-separated list of scene-item source part revision IDs to filter on.
|
|
6370
|
+
* @param {string} [filterSceneItemsSourceGeometrySet] Comma-separated list of scene-item source geometry set IDs to filter on.
|
|
6371
|
+
* @param {string} [filterSceneItemsSourceScene] Comma-separated list of scene-item source scene IDs to filter on.
|
|
6037
6372
|
* @param {*} [options] Override http request option.
|
|
6038
6373
|
* @throws {RequiredError}
|
|
6039
6374
|
*/
|
|
6040
|
-
getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
6375
|
+
getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
6041
6376
|
var _e;
|
|
6042
6377
|
const localVarPath = `/scenes`;
|
|
6043
6378
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -6070,6 +6405,18 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
|
|
|
6070
6405
|
if (filterMetadata !== undefined) {
|
|
6071
6406
|
localVarQueryParameter['filter[metadata]'] = filterMetadata;
|
|
6072
6407
|
}
|
|
6408
|
+
if (filterSceneItemsSourcePartRevision !== undefined) {
|
|
6409
|
+
localVarQueryParameter['filter[sceneItems.source.partRevision]'] =
|
|
6410
|
+
filterSceneItemsSourcePartRevision;
|
|
6411
|
+
}
|
|
6412
|
+
if (filterSceneItemsSourceGeometrySet !== undefined) {
|
|
6413
|
+
localVarQueryParameter['filter[sceneItems.source.geometrySet]'] =
|
|
6414
|
+
filterSceneItemsSourceGeometrySet;
|
|
6415
|
+
}
|
|
6416
|
+
if (filterSceneItemsSourceScene !== undefined) {
|
|
6417
|
+
localVarQueryParameter['filter[sceneItems.source.scene]'] =
|
|
6418
|
+
filterSceneItemsSourceScene;
|
|
6419
|
+
}
|
|
6073
6420
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
6074
6421
|
let headersFromBaseOptions = (_e = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _e !== void 0 ? _e : {};
|
|
6075
6422
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -6219,12 +6566,15 @@ export const ScenesApiFp = function (configuration) {
|
|
|
6219
6566
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
6220
6567
|
* @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.
|
|
6221
6568
|
* @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`.
|
|
6569
|
+
* @param {string} [filterSceneItemsSourcePartRevision] Comma-separated list of scene-item source part revision IDs to filter on.
|
|
6570
|
+
* @param {string} [filterSceneItemsSourceGeometrySet] Comma-separated list of scene-item source geometry set IDs to filter on.
|
|
6571
|
+
* @param {string} [filterSceneItemsSourceScene] Comma-separated list of scene-item source scene IDs to filter on.
|
|
6222
6572
|
* @param {*} [options] Override http request option.
|
|
6223
6573
|
* @throws {RequiredError}
|
|
6224
6574
|
*/
|
|
6225
|
-
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
|
|
6575
|
+
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options) {
|
|
6226
6576
|
return __awaiter(this, void 0, void 0, function* () {
|
|
6227
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options);
|
|
6577
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options);
|
|
6228
6578
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
6229
6579
|
});
|
|
6230
6580
|
},
|
|
@@ -6317,12 +6667,15 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
|
|
|
6317
6667
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
6318
6668
|
* @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.
|
|
6319
6669
|
* @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`.
|
|
6670
|
+
* @param {string} [filterSceneItemsSourcePartRevision] Comma-separated list of scene-item source part revision IDs to filter on.
|
|
6671
|
+
* @param {string} [filterSceneItemsSourceGeometrySet] Comma-separated list of scene-item source geometry set IDs to filter on.
|
|
6672
|
+
* @param {string} [filterSceneItemsSourceScene] Comma-separated list of scene-item source scene IDs to filter on.
|
|
6320
6673
|
* @param {*} [options] Override http request option.
|
|
6321
6674
|
* @throws {RequiredError}
|
|
6322
6675
|
*/
|
|
6323
|
-
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
|
|
6676
|
+
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options) {
|
|
6324
6677
|
return localVarFp
|
|
6325
|
-
.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options)
|
|
6678
|
+
.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, filterSceneItemsSourcePartRevision, filterSceneItemsSourceGeometrySet, filterSceneItemsSourceScene, options)
|
|
6326
6679
|
.then((request) => request(axios, basePath));
|
|
6327
6680
|
},
|
|
6328
6681
|
/**
|
|
@@ -6416,7 +6769,7 @@ export class ScenesApi extends BaseAPI {
|
|
|
6416
6769
|
*/
|
|
6417
6770
|
getScenes(requestParameters = {}, options) {
|
|
6418
6771
|
return ScenesApiFp(this.configuration)
|
|
6419
|
-
.getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, requestParameters.filterMetadata, options)
|
|
6772
|
+
.getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, requestParameters.filterMetadata, requestParameters.filterSceneItemsSourcePartRevision, requestParameters.filterSceneItemsSourceGeometrySet, requestParameters.filterSceneItemsSourceScene, options)
|
|
6420
6773
|
.then((request) => request(this.axios, this.basePath));
|
|
6421
6774
|
}
|
|
6422
6775
|
/**
|
|
@@ -61,7 +61,7 @@ export function createPartFromFile(_a) {
|
|
|
61
61
|
: undefined;
|
|
62
62
|
const pollRes = yield pollQueuedJob({
|
|
63
63
|
id: queuedId,
|
|
64
|
-
getQueuedJob: (id) => client.translationInspections.
|
|
64
|
+
getQueuedJob: (id) => client.translationInspections.getQueuedTranslationJob({ id }),
|
|
65
65
|
polling,
|
|
66
66
|
});
|
|
67
67
|
if (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;
|
|
@@ -23,7 +23,8 @@ const Debug = false;
|
|
|
23
23
|
* @param req - {@link PollQueuedJobReq}.
|
|
24
24
|
* @returns {@link PollQueuedJobRes}.
|
|
25
25
|
*/
|
|
26
|
-
export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { intervalMs, maxAttempts }, }) {
|
|
26
|
+
export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polling: { intervalMs, maxAttempts, backoff }, }) {
|
|
27
|
+
var _a, _b;
|
|
27
28
|
return __awaiter(this, void 0, void 0, function* () {
|
|
28
29
|
function poll(attempt) {
|
|
29
30
|
var _a, _b;
|
|
@@ -66,6 +67,8 @@ export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polli
|
|
|
66
67
|
});
|
|
67
68
|
}
|
|
68
69
|
let attempts = 1;
|
|
70
|
+
let backoffMs = (_a = backoff === null || backoff === void 0 ? void 0 : backoff[attempts]) !== null && _a !== void 0 ? _a : 0;
|
|
71
|
+
// eslint-disable-next-line prefer-const
|
|
69
72
|
let pollRes = yield poll(attempts);
|
|
70
73
|
/* eslint-disable no-await-in-loop */
|
|
71
74
|
while (!completeJob(pollRes.res) &&
|
|
@@ -74,7 +77,8 @@ export function pollQueuedJob({ id, getQueuedJob, allow404 = false, limit, polli
|
|
|
74
77
|
isClientError(pollRes.res)) &&
|
|
75
78
|
attempts <= maxAttempts) {
|
|
76
79
|
attempts += 1;
|
|
77
|
-
|
|
80
|
+
backoffMs = (_b = backoff === null || backoff === void 0 ? void 0 : backoff[attempts]) !== null && _b !== void 0 ? _b : backoffMs;
|
|
81
|
+
yield delay(intervalMs + backoffMs);
|
|
78
82
|
pollRes = yield poll(attempts);
|
|
79
83
|
}
|
|
80
84
|
/* 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
|
+
export declare const version = "0.22.3";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export const version = '0.22.
|
|
1
|
+
export const version = '0.22.3';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vertexvis/api-client-node",
|
|
3
|
-
"version": "0.22.
|
|
3
|
+
"version": "0.22.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)",
|
|
@@ -33,7 +33,7 @@
|
|
|
33
33
|
"typescript"
|
|
34
34
|
],
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"axios": "^1.6.
|
|
36
|
+
"axios": "^1.6.4",
|
|
37
37
|
"p-limit": "^3"
|
|
38
38
|
},
|
|
39
39
|
"devDependencies": {
|