@vertexvis/api-client-node 0.20.7 → 0.20.9
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/README.md +7 -0
- package/dist/cjs/api.d.ts +57 -7
- package/dist/cjs/api.js +21 -9
- package/dist/cjs/client/version.d.ts +1 -1
- package/dist/cjs/client/version.js +1 -1
- package/dist/esm/api.d.ts +57 -7
- package/dist/esm/api.js +21 -9
- package/dist/esm/client/version.d.ts +1 -1
- package/dist/esm/client/version.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -62,6 +62,13 @@ yarn build
|
|
|
62
62
|
|
|
63
63
|
# Format code
|
|
64
64
|
yarn format
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Publishing
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
# Generate latest
|
|
71
|
+
yarn generate
|
|
65
72
|
|
|
66
73
|
# Generate using latest OpenAPI spec, version, and open GitHub PR
|
|
67
74
|
yarn push:version [patch|minor|major (default: patch)]
|
package/dist/cjs/api.d.ts
CHANGED
|
@@ -1491,6 +1491,14 @@ export interface CreateSceneRequestDataAttributes {
|
|
|
1491
1491
|
* @memberof CreateSceneRequestDataAttributes
|
|
1492
1492
|
*/
|
|
1493
1493
|
worldOrientation?: Orientation;
|
|
1494
|
+
/**
|
|
1495
|
+
*
|
|
1496
|
+
* @type {{ [key: string]: string; }}
|
|
1497
|
+
* @memberof CreateSceneRequestDataAttributes
|
|
1498
|
+
*/
|
|
1499
|
+
metadata?: {
|
|
1500
|
+
[key: string]: string;
|
|
1501
|
+
};
|
|
1494
1502
|
}
|
|
1495
1503
|
/**
|
|
1496
1504
|
*
|
|
@@ -3915,6 +3923,14 @@ export interface SceneDataAttributes {
|
|
|
3915
3923
|
* @memberof SceneDataAttributes
|
|
3916
3924
|
*/
|
|
3917
3925
|
sceneItemCount?: number;
|
|
3926
|
+
/**
|
|
3927
|
+
*
|
|
3928
|
+
* @type {{ [key: string]: string; }}
|
|
3929
|
+
* @memberof SceneDataAttributes
|
|
3930
|
+
*/
|
|
3931
|
+
metadata?: {
|
|
3932
|
+
[key: string]: string;
|
|
3933
|
+
};
|
|
3918
3934
|
}
|
|
3919
3935
|
/**
|
|
3920
3936
|
*
|
|
@@ -5334,6 +5350,14 @@ export interface UpdateSceneRequestDataAttributes {
|
|
|
5334
5350
|
* @memberof UpdateSceneRequestDataAttributes
|
|
5335
5351
|
*/
|
|
5336
5352
|
worldOrientation?: Orientation;
|
|
5353
|
+
/**
|
|
5354
|
+
*
|
|
5355
|
+
* @type {{ [key: string]: string; }}
|
|
5356
|
+
* @memberof UpdateSceneRequestDataAttributes
|
|
5357
|
+
*/
|
|
5358
|
+
metadata?: {
|
|
5359
|
+
[key: string]: string;
|
|
5360
|
+
};
|
|
5337
5361
|
}
|
|
5338
5362
|
export declare const UpdateSceneRequestDataAttributesStateEnum: {
|
|
5339
5363
|
readonly Draft: "draft";
|
|
@@ -9747,7 +9771,7 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9747
9771
|
/**
|
|
9748
9772
|
* Get a `scene` by ID.
|
|
9749
9773
|
* @param {string} id The `scene` ID.
|
|
9750
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
9774
|
+
* @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.
|
|
9751
9775
|
* @param {*} [options] Override http request option.
|
|
9752
9776
|
* @throws {RequiredError}
|
|
9753
9777
|
*/
|
|
@@ -9758,10 +9782,14 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9758
9782
|
* @param {number} [pageSize] The number of items to return.
|
|
9759
9783
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
9760
9784
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9785
|
+
* @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.
|
|
9786
|
+
* @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`.
|
|
9761
9787
|
* @param {*} [options] Override http request option.
|
|
9762
9788
|
* @throws {RequiredError}
|
|
9763
9789
|
*/
|
|
9764
|
-
getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined,
|
|
9790
|
+
getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
|
|
9791
|
+
[key: string]: string;
|
|
9792
|
+
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9765
9793
|
/**
|
|
9766
9794
|
* Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
|
|
9767
9795
|
* @param {string} id The `scene` ID.
|
|
@@ -9809,7 +9837,7 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
|
|
|
9809
9837
|
/**
|
|
9810
9838
|
* Get a `scene` by ID.
|
|
9811
9839
|
* @param {string} id The `scene` ID.
|
|
9812
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
9840
|
+
* @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.
|
|
9813
9841
|
* @param {*} [options] Override http request option.
|
|
9814
9842
|
* @throws {RequiredError}
|
|
9815
9843
|
*/
|
|
@@ -9820,10 +9848,14 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
|
|
|
9820
9848
|
* @param {number} [pageSize] The number of items to return.
|
|
9821
9849
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
9822
9850
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9851
|
+
* @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.
|
|
9852
|
+
* @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`.
|
|
9823
9853
|
* @param {*} [options] Override http request option.
|
|
9824
9854
|
* @throws {RequiredError}
|
|
9825
9855
|
*/
|
|
9826
|
-
getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined,
|
|
9856
|
+
getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
|
|
9857
|
+
[key: string]: string;
|
|
9858
|
+
} | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
|
|
9827
9859
|
/**
|
|
9828
9860
|
* Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
|
|
9829
9861
|
* @param {string} id The `scene` ID.
|
|
@@ -9871,7 +9903,7 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
|
|
|
9871
9903
|
/**
|
|
9872
9904
|
* Get a `scene` by ID.
|
|
9873
9905
|
* @param {string} id The `scene` ID.
|
|
9874
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
9906
|
+
* @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.
|
|
9875
9907
|
* @param {*} [options] Override http request option.
|
|
9876
9908
|
* @throws {RequiredError}
|
|
9877
9909
|
*/
|
|
@@ -9882,10 +9914,14 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
|
|
|
9882
9914
|
* @param {number} [pageSize] The number of items to return.
|
|
9883
9915
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
9884
9916
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9917
|
+
* @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.
|
|
9918
|
+
* @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`.
|
|
9885
9919
|
* @param {*} [options] Override http request option.
|
|
9886
9920
|
* @throws {RequiredError}
|
|
9887
9921
|
*/
|
|
9888
|
-
getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined,
|
|
9922
|
+
getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
|
|
9923
|
+
[key: string]: string;
|
|
9924
|
+
} | undefined, options?: any): AxiosPromise<SceneList>;
|
|
9889
9925
|
/**
|
|
9890
9926
|
* Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
|
|
9891
9927
|
* @param {string} id The `scene` ID.
|
|
@@ -9956,7 +9992,7 @@ export interface ScenesApiGetSceneRequest {
|
|
|
9956
9992
|
*/
|
|
9957
9993
|
readonly id: string;
|
|
9958
9994
|
/**
|
|
9959
|
-
* Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
9995
|
+
* Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
|
|
9960
9996
|
* @type {string}
|
|
9961
9997
|
* @memberof ScenesApiGetScene
|
|
9962
9998
|
*/
|
|
@@ -9992,6 +10028,20 @@ export interface ScenesApiGetScenesRequest {
|
|
|
9992
10028
|
* @memberof ScenesApiGetScenes
|
|
9993
10029
|
*/
|
|
9994
10030
|
readonly filterSuppliedId?: string;
|
|
10031
|
+
/**
|
|
10032
|
+
* Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
|
|
10033
|
+
* @type {string}
|
|
10034
|
+
* @memberof ScenesApiGetScenes
|
|
10035
|
+
*/
|
|
10036
|
+
readonly fieldsScene?: string;
|
|
10037
|
+
/**
|
|
10038
|
+
* 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`.
|
|
10039
|
+
* @type {{ [key: string]: string; }}
|
|
10040
|
+
* @memberof ScenesApiGetScenes
|
|
10041
|
+
*/
|
|
10042
|
+
readonly filterMetadata?: {
|
|
10043
|
+
[key: string]: string;
|
|
10044
|
+
};
|
|
9995
10045
|
}
|
|
9996
10046
|
/**
|
|
9997
10047
|
* Request parameters for renderScene operation in ScenesApi.
|
package/dist/cjs/api.js
CHANGED
|
@@ -5705,7 +5705,7 @@ const ScenesApiAxiosParamCreator = function (configuration) {
|
|
|
5705
5705
|
/**
|
|
5706
5706
|
* Get a `scene` by ID.
|
|
5707
5707
|
* @param {string} id The `scene` ID.
|
|
5708
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
5708
|
+
* @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.
|
|
5709
5709
|
* @param {*} [options] Override http request option.
|
|
5710
5710
|
* @throws {RequiredError}
|
|
5711
5711
|
*/
|
|
@@ -5742,10 +5742,12 @@ const ScenesApiAxiosParamCreator = function (configuration) {
|
|
|
5742
5742
|
* @param {number} [pageSize] The number of items to return.
|
|
5743
5743
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
5744
5744
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
5745
|
+
* @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.
|
|
5746
|
+
* @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`.
|
|
5745
5747
|
* @param {*} [options] Override http request option.
|
|
5746
5748
|
* @throws {RequiredError}
|
|
5747
5749
|
*/
|
|
5748
|
-
getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
5750
|
+
getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
5749
5751
|
const localVarPath = `/scenes`;
|
|
5750
5752
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5751
5753
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -5771,6 +5773,12 @@ const ScenesApiAxiosParamCreator = function (configuration) {
|
|
|
5771
5773
|
if (filterSuppliedId !== undefined) {
|
|
5772
5774
|
localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
|
|
5773
5775
|
}
|
|
5776
|
+
if (fieldsScene !== undefined) {
|
|
5777
|
+
localVarQueryParameter['fields[scene]'] = fieldsScene;
|
|
5778
|
+
}
|
|
5779
|
+
if (filterMetadata !== undefined) {
|
|
5780
|
+
localVarQueryParameter['filter[metadata]'] = filterMetadata;
|
|
5781
|
+
}
|
|
5774
5782
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
5775
5783
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5776
5784
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -5901,7 +5909,7 @@ const ScenesApiFp = function (configuration) {
|
|
|
5901
5909
|
/**
|
|
5902
5910
|
* Get a `scene` by ID.
|
|
5903
5911
|
* @param {string} id The `scene` ID.
|
|
5904
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
5912
|
+
* @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.
|
|
5905
5913
|
* @param {*} [options] Override http request option.
|
|
5906
5914
|
* @throws {RequiredError}
|
|
5907
5915
|
*/
|
|
@@ -5917,12 +5925,14 @@ const ScenesApiFp = function (configuration) {
|
|
|
5917
5925
|
* @param {number} [pageSize] The number of items to return.
|
|
5918
5926
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
5919
5927
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
5928
|
+
* @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.
|
|
5929
|
+
* @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`.
|
|
5920
5930
|
* @param {*} [options] Override http request option.
|
|
5921
5931
|
* @throws {RequiredError}
|
|
5922
5932
|
*/
|
|
5923
|
-
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
|
|
5933
|
+
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
|
|
5924
5934
|
return __awaiter(this, void 0, void 0, function* () {
|
|
5925
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options);
|
|
5935
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options);
|
|
5926
5936
|
return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
|
|
5927
5937
|
});
|
|
5928
5938
|
},
|
|
@@ -5999,7 +6009,7 @@ const ScenesApiFactory = function (configuration, basePath, axios) {
|
|
|
5999
6009
|
/**
|
|
6000
6010
|
* Get a `scene` by ID.
|
|
6001
6011
|
* @param {string} id The `scene` ID.
|
|
6002
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
6012
|
+
* @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.
|
|
6003
6013
|
* @param {*} [options] Override http request option.
|
|
6004
6014
|
* @throws {RequiredError}
|
|
6005
6015
|
*/
|
|
@@ -6014,12 +6024,14 @@ const ScenesApiFactory = function (configuration, basePath, axios) {
|
|
|
6014
6024
|
* @param {number} [pageSize] The number of items to return.
|
|
6015
6025
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
6016
6026
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
6027
|
+
* @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.
|
|
6028
|
+
* @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`.
|
|
6017
6029
|
* @param {*} [options] Override http request option.
|
|
6018
6030
|
* @throws {RequiredError}
|
|
6019
6031
|
*/
|
|
6020
|
-
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
|
|
6032
|
+
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
|
|
6021
6033
|
return localVarFp
|
|
6022
|
-
.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options)
|
|
6034
|
+
.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options)
|
|
6023
6035
|
.then((request) => request(axios, basePath));
|
|
6024
6036
|
},
|
|
6025
6037
|
/**
|
|
@@ -6114,7 +6126,7 @@ class ScenesApi extends base_1.BaseAPI {
|
|
|
6114
6126
|
*/
|
|
6115
6127
|
getScenes(requestParameters = {}, options) {
|
|
6116
6128
|
return (0, exports.ScenesApiFp)(this.configuration)
|
|
6117
|
-
.getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, options)
|
|
6129
|
+
.getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, requestParameters.filterMetadata, options)
|
|
6118
6130
|
.then((request) => request(this.axios, this.basePath));
|
|
6119
6131
|
}
|
|
6120
6132
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.20.
|
|
1
|
+
export declare const version = "0.20.9";
|
package/dist/esm/api.d.ts
CHANGED
|
@@ -1491,6 +1491,14 @@ export interface CreateSceneRequestDataAttributes {
|
|
|
1491
1491
|
* @memberof CreateSceneRequestDataAttributes
|
|
1492
1492
|
*/
|
|
1493
1493
|
worldOrientation?: Orientation;
|
|
1494
|
+
/**
|
|
1495
|
+
*
|
|
1496
|
+
* @type {{ [key: string]: string; }}
|
|
1497
|
+
* @memberof CreateSceneRequestDataAttributes
|
|
1498
|
+
*/
|
|
1499
|
+
metadata?: {
|
|
1500
|
+
[key: string]: string;
|
|
1501
|
+
};
|
|
1494
1502
|
}
|
|
1495
1503
|
/**
|
|
1496
1504
|
*
|
|
@@ -3915,6 +3923,14 @@ export interface SceneDataAttributes {
|
|
|
3915
3923
|
* @memberof SceneDataAttributes
|
|
3916
3924
|
*/
|
|
3917
3925
|
sceneItemCount?: number;
|
|
3926
|
+
/**
|
|
3927
|
+
*
|
|
3928
|
+
* @type {{ [key: string]: string; }}
|
|
3929
|
+
* @memberof SceneDataAttributes
|
|
3930
|
+
*/
|
|
3931
|
+
metadata?: {
|
|
3932
|
+
[key: string]: string;
|
|
3933
|
+
};
|
|
3918
3934
|
}
|
|
3919
3935
|
/**
|
|
3920
3936
|
*
|
|
@@ -5334,6 +5350,14 @@ export interface UpdateSceneRequestDataAttributes {
|
|
|
5334
5350
|
* @memberof UpdateSceneRequestDataAttributes
|
|
5335
5351
|
*/
|
|
5336
5352
|
worldOrientation?: Orientation;
|
|
5353
|
+
/**
|
|
5354
|
+
*
|
|
5355
|
+
* @type {{ [key: string]: string; }}
|
|
5356
|
+
* @memberof UpdateSceneRequestDataAttributes
|
|
5357
|
+
*/
|
|
5358
|
+
metadata?: {
|
|
5359
|
+
[key: string]: string;
|
|
5360
|
+
};
|
|
5337
5361
|
}
|
|
5338
5362
|
export declare const UpdateSceneRequestDataAttributesStateEnum: {
|
|
5339
5363
|
readonly Draft: "draft";
|
|
@@ -9747,7 +9771,7 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9747
9771
|
/**
|
|
9748
9772
|
* Get a `scene` by ID.
|
|
9749
9773
|
* @param {string} id The `scene` ID.
|
|
9750
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
9774
|
+
* @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.
|
|
9751
9775
|
* @param {*} [options] Override http request option.
|
|
9752
9776
|
* @throws {RequiredError}
|
|
9753
9777
|
*/
|
|
@@ -9758,10 +9782,14 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
9758
9782
|
* @param {number} [pageSize] The number of items to return.
|
|
9759
9783
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
9760
9784
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9785
|
+
* @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.
|
|
9786
|
+
* @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`.
|
|
9761
9787
|
* @param {*} [options] Override http request option.
|
|
9762
9788
|
* @throws {RequiredError}
|
|
9763
9789
|
*/
|
|
9764
|
-
getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined,
|
|
9790
|
+
getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
|
|
9791
|
+
[key: string]: string;
|
|
9792
|
+
} | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
9765
9793
|
/**
|
|
9766
9794
|
* Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
|
|
9767
9795
|
* @param {string} id The `scene` ID.
|
|
@@ -9809,7 +9837,7 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
|
|
|
9809
9837
|
/**
|
|
9810
9838
|
* Get a `scene` by ID.
|
|
9811
9839
|
* @param {string} id The `scene` ID.
|
|
9812
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
9840
|
+
* @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.
|
|
9813
9841
|
* @param {*} [options] Override http request option.
|
|
9814
9842
|
* @throws {RequiredError}
|
|
9815
9843
|
*/
|
|
@@ -9820,10 +9848,14 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
|
|
|
9820
9848
|
* @param {number} [pageSize] The number of items to return.
|
|
9821
9849
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
9822
9850
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9851
|
+
* @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.
|
|
9852
|
+
* @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`.
|
|
9823
9853
|
* @param {*} [options] Override http request option.
|
|
9824
9854
|
* @throws {RequiredError}
|
|
9825
9855
|
*/
|
|
9826
|
-
getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined,
|
|
9856
|
+
getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
|
|
9857
|
+
[key: string]: string;
|
|
9858
|
+
} | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
|
|
9827
9859
|
/**
|
|
9828
9860
|
* Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
|
|
9829
9861
|
* @param {string} id The `scene` ID.
|
|
@@ -9871,7 +9903,7 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
|
|
|
9871
9903
|
/**
|
|
9872
9904
|
* Get a `scene` by ID.
|
|
9873
9905
|
* @param {string} id The `scene` ID.
|
|
9874
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
9906
|
+
* @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.
|
|
9875
9907
|
* @param {*} [options] Override http request option.
|
|
9876
9908
|
* @throws {RequiredError}
|
|
9877
9909
|
*/
|
|
@@ -9882,10 +9914,14 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
|
|
|
9882
9914
|
* @param {number} [pageSize] The number of items to return.
|
|
9883
9915
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
9884
9916
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
9917
|
+
* @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.
|
|
9918
|
+
* @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`.
|
|
9885
9919
|
* @param {*} [options] Override http request option.
|
|
9886
9920
|
* @throws {RequiredError}
|
|
9887
9921
|
*/
|
|
9888
|
-
getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined,
|
|
9922
|
+
getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
|
|
9923
|
+
[key: string]: string;
|
|
9924
|
+
} | undefined, options?: any): AxiosPromise<SceneList>;
|
|
9889
9925
|
/**
|
|
9890
9926
|
* Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
|
|
9891
9927
|
* @param {string} id The `scene` ID.
|
|
@@ -9956,7 +9992,7 @@ export interface ScenesApiGetSceneRequest {
|
|
|
9956
9992
|
*/
|
|
9957
9993
|
readonly id: string;
|
|
9958
9994
|
/**
|
|
9959
|
-
* Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
9995
|
+
* Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
|
|
9960
9996
|
* @type {string}
|
|
9961
9997
|
* @memberof ScenesApiGetScene
|
|
9962
9998
|
*/
|
|
@@ -9992,6 +10028,20 @@ export interface ScenesApiGetScenesRequest {
|
|
|
9992
10028
|
* @memberof ScenesApiGetScenes
|
|
9993
10029
|
*/
|
|
9994
10030
|
readonly filterSuppliedId?: string;
|
|
10031
|
+
/**
|
|
10032
|
+
* Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` and `metadata` are only returned if explicitly requested.
|
|
10033
|
+
* @type {string}
|
|
10034
|
+
* @memberof ScenesApiGetScenes
|
|
10035
|
+
*/
|
|
10036
|
+
readonly fieldsScene?: string;
|
|
10037
|
+
/**
|
|
10038
|
+
* 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`.
|
|
10039
|
+
* @type {{ [key: string]: string; }}
|
|
10040
|
+
* @memberof ScenesApiGetScenes
|
|
10041
|
+
*/
|
|
10042
|
+
readonly filterMetadata?: {
|
|
10043
|
+
[key: string]: string;
|
|
10044
|
+
};
|
|
9995
10045
|
}
|
|
9996
10046
|
/**
|
|
9997
10047
|
* Request parameters for renderScene operation in ScenesApi.
|
package/dist/esm/api.js
CHANGED
|
@@ -5637,7 +5637,7 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
|
|
|
5637
5637
|
/**
|
|
5638
5638
|
* Get a `scene` by ID.
|
|
5639
5639
|
* @param {string} id The `scene` ID.
|
|
5640
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
5640
|
+
* @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.
|
|
5641
5641
|
* @param {*} [options] Override http request option.
|
|
5642
5642
|
* @throws {RequiredError}
|
|
5643
5643
|
*/
|
|
@@ -5674,10 +5674,12 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
|
|
|
5674
5674
|
* @param {number} [pageSize] The number of items to return.
|
|
5675
5675
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
5676
5676
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
5677
|
+
* @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.
|
|
5678
|
+
* @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`.
|
|
5677
5679
|
* @param {*} [options] Override http request option.
|
|
5678
5680
|
* @throws {RequiredError}
|
|
5679
5681
|
*/
|
|
5680
|
-
getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
5682
|
+
getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options = {}) => __awaiter(this, void 0, void 0, function* () {
|
|
5681
5683
|
const localVarPath = `/scenes`;
|
|
5682
5684
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
5683
5685
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
@@ -5703,6 +5705,12 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
|
|
|
5703
5705
|
if (filterSuppliedId !== undefined) {
|
|
5704
5706
|
localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
|
|
5705
5707
|
}
|
|
5708
|
+
if (fieldsScene !== undefined) {
|
|
5709
|
+
localVarQueryParameter['fields[scene]'] = fieldsScene;
|
|
5710
|
+
}
|
|
5711
|
+
if (filterMetadata !== undefined) {
|
|
5712
|
+
localVarQueryParameter['filter[metadata]'] = filterMetadata;
|
|
5713
|
+
}
|
|
5706
5714
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
5707
5715
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
5708
5716
|
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
@@ -5832,7 +5840,7 @@ export const ScenesApiFp = function (configuration) {
|
|
|
5832
5840
|
/**
|
|
5833
5841
|
* Get a `scene` by ID.
|
|
5834
5842
|
* @param {string} id The `scene` ID.
|
|
5835
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
5843
|
+
* @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.
|
|
5836
5844
|
* @param {*} [options] Override http request option.
|
|
5837
5845
|
* @throws {RequiredError}
|
|
5838
5846
|
*/
|
|
@@ -5848,12 +5856,14 @@ export const ScenesApiFp = function (configuration) {
|
|
|
5848
5856
|
* @param {number} [pageSize] The number of items to return.
|
|
5849
5857
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
5850
5858
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
5859
|
+
* @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.
|
|
5860
|
+
* @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`.
|
|
5851
5861
|
* @param {*} [options] Override http request option.
|
|
5852
5862
|
* @throws {RequiredError}
|
|
5853
5863
|
*/
|
|
5854
|
-
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
|
|
5864
|
+
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
|
|
5855
5865
|
return __awaiter(this, void 0, void 0, function* () {
|
|
5856
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options);
|
|
5866
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options);
|
|
5857
5867
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
5858
5868
|
});
|
|
5859
5869
|
},
|
|
@@ -5929,7 +5939,7 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
|
|
|
5929
5939
|
/**
|
|
5930
5940
|
* Get a `scene` by ID.
|
|
5931
5941
|
* @param {string} id The `scene` ID.
|
|
5932
|
-
* @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount`
|
|
5942
|
+
* @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.
|
|
5933
5943
|
* @param {*} [options] Override http request option.
|
|
5934
5944
|
* @throws {RequiredError}
|
|
5935
5945
|
*/
|
|
@@ -5944,12 +5954,14 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
|
|
|
5944
5954
|
* @param {number} [pageSize] The number of items to return.
|
|
5945
5955
|
* @param {string} [filterName] Comma-separated list of names to filter on.
|
|
5946
5956
|
* @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
|
|
5957
|
+
* @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.
|
|
5958
|
+
* @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`.
|
|
5947
5959
|
* @param {*} [options] Override http request option.
|
|
5948
5960
|
* @throws {RequiredError}
|
|
5949
5961
|
*/
|
|
5950
|
-
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
|
|
5962
|
+
getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
|
|
5951
5963
|
return localVarFp
|
|
5952
|
-
.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options)
|
|
5964
|
+
.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options)
|
|
5953
5965
|
.then((request) => request(axios, basePath));
|
|
5954
5966
|
},
|
|
5955
5967
|
/**
|
|
@@ -6043,7 +6055,7 @@ export class ScenesApi extends BaseAPI {
|
|
|
6043
6055
|
*/
|
|
6044
6056
|
getScenes(requestParameters = {}, options) {
|
|
6045
6057
|
return ScenesApiFp(this.configuration)
|
|
6046
|
-
.getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, options)
|
|
6058
|
+
.getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, requestParameters.filterMetadata, options)
|
|
6047
6059
|
.then((request) => request(this.axios, this.basePath));
|
|
6048
6060
|
}
|
|
6049
6061
|
/**
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export declare const version = "0.20.
|
|
1
|
+
export declare const version = "0.20.9";
|
|
@@ -1 +1 @@
|
|
|
1
|
-
export const version = '0.20.
|
|
1
|
+
export const version = '0.20.9';
|
package/package.json
CHANGED