@vertexvis/api-client-node 0.20.7 → 0.20.8

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 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` is only returned if explicitly requested.
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,11 @@ 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.
9761
9786
  * @param {*} [options] Override http request option.
9762
9787
  * @throws {RequiredError}
9763
9788
  */
9764
- getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9789
+ getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9765
9790
  /**
9766
9791
  * 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
9792
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9809,7 +9834,7 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9809
9834
  /**
9810
9835
  * Get a `scene` by ID.
9811
9836
  * @param {string} id The &#x60;scene&#x60; ID.
9812
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9837
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9813
9838
  * @param {*} [options] Override http request option.
9814
9839
  * @throws {RequiredError}
9815
9840
  */
@@ -9820,10 +9845,11 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9820
9845
  * @param {number} [pageSize] The number of items to return.
9821
9846
  * @param {string} [filterName] Comma-separated list of names to filter on.
9822
9847
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9848
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9823
9849
  * @param {*} [options] Override http request option.
9824
9850
  * @throws {RequiredError}
9825
9851
  */
9826
- getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
9852
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
9827
9853
  /**
9828
9854
  * 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
9855
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9871,7 +9897,7 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9871
9897
  /**
9872
9898
  * Get a `scene` by ID.
9873
9899
  * @param {string} id The &#x60;scene&#x60; ID.
9874
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9900
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9875
9901
  * @param {*} [options] Override http request option.
9876
9902
  * @throws {RequiredError}
9877
9903
  */
@@ -9882,10 +9908,11 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9882
9908
  * @param {number} [pageSize] The number of items to return.
9883
9909
  * @param {string} [filterName] Comma-separated list of names to filter on.
9884
9910
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9911
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9885
9912
  * @param {*} [options] Override http request option.
9886
9913
  * @throws {RequiredError}
9887
9914
  */
9888
- getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<SceneList>;
9915
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: any): AxiosPromise<SceneList>;
9889
9916
  /**
9890
9917
  * 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
9918
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9956,7 +9983,7 @@ export interface ScenesApiGetSceneRequest {
9956
9983
  */
9957
9984
  readonly id: string;
9958
9985
  /**
9959
- * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9986
+ * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9960
9987
  * @type {string}
9961
9988
  * @memberof ScenesApiGetScene
9962
9989
  */
@@ -9992,6 +10019,12 @@ export interface ScenesApiGetScenesRequest {
9992
10019
  * @memberof ScenesApiGetScenes
9993
10020
  */
9994
10021
  readonly filterSuppliedId?: string;
10022
+ /**
10023
+ * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
10024
+ * @type {string}
10025
+ * @memberof ScenesApiGetScenes
10026
+ */
10027
+ readonly fieldsScene?: string;
9995
10028
  }
9996
10029
  /**
9997
10030
  * 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 &#x60;scene&#x60; ID.
5708
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
5708
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5709
5709
  * @param {*} [options] Override http request option.
5710
5710
  * @throws {RequiredError}
5711
5711
  */
@@ -5742,10 +5742,11 @@ 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. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5745
5746
  * @param {*} [options] Override http request option.
5746
5747
  * @throws {RequiredError}
5747
5748
  */
5748
- getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
5749
+ getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options = {}) => __awaiter(this, void 0, void 0, function* () {
5749
5750
  const localVarPath = `/scenes`;
5750
5751
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5751
5752
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -5771,6 +5772,9 @@ const ScenesApiAxiosParamCreator = function (configuration) {
5771
5772
  if (filterSuppliedId !== undefined) {
5772
5773
  localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
5773
5774
  }
5775
+ if (fieldsScene !== undefined) {
5776
+ localVarQueryParameter['fields[scene]'] = fieldsScene;
5777
+ }
5774
5778
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
5775
5779
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5776
5780
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -5901,7 +5905,7 @@ const ScenesApiFp = function (configuration) {
5901
5905
  /**
5902
5906
  * Get a `scene` by ID.
5903
5907
  * @param {string} id The &#x60;scene&#x60; ID.
5904
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
5908
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5905
5909
  * @param {*} [options] Override http request option.
5906
5910
  * @throws {RequiredError}
5907
5911
  */
@@ -5917,12 +5921,13 @@ const ScenesApiFp = function (configuration) {
5917
5921
  * @param {number} [pageSize] The number of items to return.
5918
5922
  * @param {string} [filterName] Comma-separated list of names to filter on.
5919
5923
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5924
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5920
5925
  * @param {*} [options] Override http request option.
5921
5926
  * @throws {RequiredError}
5922
5927
  */
5923
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
5928
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
5924
5929
  return __awaiter(this, void 0, void 0, function* () {
5925
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options);
5930
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options);
5926
5931
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
5927
5932
  });
5928
5933
  },
@@ -5999,7 +6004,7 @@ const ScenesApiFactory = function (configuration, basePath, axios) {
5999
6004
  /**
6000
6005
  * Get a `scene` by ID.
6001
6006
  * @param {string} id The &#x60;scene&#x60; ID.
6002
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
6007
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
6003
6008
  * @param {*} [options] Override http request option.
6004
6009
  * @throws {RequiredError}
6005
6010
  */
@@ -6014,12 +6019,13 @@ const ScenesApiFactory = function (configuration, basePath, axios) {
6014
6019
  * @param {number} [pageSize] The number of items to return.
6015
6020
  * @param {string} [filterName] Comma-separated list of names to filter on.
6016
6021
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
6022
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
6017
6023
  * @param {*} [options] Override http request option.
6018
6024
  * @throws {RequiredError}
6019
6025
  */
6020
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
6026
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
6021
6027
  return localVarFp
6022
- .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options)
6028
+ .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options)
6023
6029
  .then((request) => request(axios, basePath));
6024
6030
  },
6025
6031
  /**
@@ -6114,7 +6120,7 @@ class ScenesApi extends base_1.BaseAPI {
6114
6120
  */
6115
6121
  getScenes(requestParameters = {}, options) {
6116
6122
  return (0, exports.ScenesApiFp)(this.configuration)
6117
- .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, options)
6123
+ .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, options)
6118
6124
  .then((request) => request(this.axios, this.basePath));
6119
6125
  }
6120
6126
  /**
@@ -1 +1 @@
1
- export declare const version = "0.20.7";
1
+ export declare const version = "0.20.8";
@@ -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.20.7';
4
+ exports.version = '0.20.8';
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 &#x60;scene&#x60; ID.
9750
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9774
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9751
9775
  * @param {*} [options] Override http request option.
9752
9776
  * @throws {RequiredError}
9753
9777
  */
@@ -9758,10 +9782,11 @@ 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. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9761
9786
  * @param {*} [options] Override http request option.
9762
9787
  * @throws {RequiredError}
9763
9788
  */
9764
- getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9789
+ getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9765
9790
  /**
9766
9791
  * 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
9792
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9809,7 +9834,7 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9809
9834
  /**
9810
9835
  * Get a `scene` by ID.
9811
9836
  * @param {string} id The &#x60;scene&#x60; ID.
9812
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9837
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9813
9838
  * @param {*} [options] Override http request option.
9814
9839
  * @throws {RequiredError}
9815
9840
  */
@@ -9820,10 +9845,11 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9820
9845
  * @param {number} [pageSize] The number of items to return.
9821
9846
  * @param {string} [filterName] Comma-separated list of names to filter on.
9822
9847
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9848
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9823
9849
  * @param {*} [options] Override http request option.
9824
9850
  * @throws {RequiredError}
9825
9851
  */
9826
- getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
9852
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
9827
9853
  /**
9828
9854
  * 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
9855
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9871,7 +9897,7 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9871
9897
  /**
9872
9898
  * Get a `scene` by ID.
9873
9899
  * @param {string} id The &#x60;scene&#x60; ID.
9874
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9900
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9875
9901
  * @param {*} [options] Override http request option.
9876
9902
  * @throws {RequiredError}
9877
9903
  */
@@ -9882,10 +9908,11 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9882
9908
  * @param {number} [pageSize] The number of items to return.
9883
9909
  * @param {string} [filterName] Comma-separated list of names to filter on.
9884
9910
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9911
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9885
9912
  * @param {*} [options] Override http request option.
9886
9913
  * @throws {RequiredError}
9887
9914
  */
9888
- getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, options?: any): AxiosPromise<SceneList>;
9915
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: any): AxiosPromise<SceneList>;
9889
9916
  /**
9890
9917
  * 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
9918
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9956,7 +9983,7 @@ export interface ScenesApiGetSceneRequest {
9956
9983
  */
9957
9984
  readonly id: string;
9958
9985
  /**
9959
- * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
9986
+ * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
9960
9987
  * @type {string}
9961
9988
  * @memberof ScenesApiGetScene
9962
9989
  */
@@ -9992,6 +10019,12 @@ export interface ScenesApiGetScenesRequest {
9992
10019
  * @memberof ScenesApiGetScenes
9993
10020
  */
9994
10021
  readonly filterSuppliedId?: string;
10022
+ /**
10023
+ * Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
10024
+ * @type {string}
10025
+ * @memberof ScenesApiGetScenes
10026
+ */
10027
+ readonly fieldsScene?: string;
9995
10028
  }
9996
10029
  /**
9997
10030
  * 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 &#x60;scene&#x60; ID.
5640
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
5640
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5641
5641
  * @param {*} [options] Override http request option.
5642
5642
  * @throws {RequiredError}
5643
5643
  */
@@ -5674,10 +5674,11 @@ 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. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5677
5678
  * @param {*} [options] Override http request option.
5678
5679
  * @throws {RequiredError}
5679
5680
  */
5680
- getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
5681
+ getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options = {}) => __awaiter(this, void 0, void 0, function* () {
5681
5682
  const localVarPath = `/scenes`;
5682
5683
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5683
5684
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5703,6 +5704,9 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
5703
5704
  if (filterSuppliedId !== undefined) {
5704
5705
  localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
5705
5706
  }
5707
+ if (fieldsScene !== undefined) {
5708
+ localVarQueryParameter['fields[scene]'] = fieldsScene;
5709
+ }
5706
5710
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5707
5711
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5708
5712
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -5832,7 +5836,7 @@ export const ScenesApiFp = function (configuration) {
5832
5836
  /**
5833
5837
  * Get a `scene` by ID.
5834
5838
  * @param {string} id The &#x60;scene&#x60; ID.
5835
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
5839
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5836
5840
  * @param {*} [options] Override http request option.
5837
5841
  * @throws {RequiredError}
5838
5842
  */
@@ -5848,12 +5852,13 @@ export const ScenesApiFp = function (configuration) {
5848
5852
  * @param {number} [pageSize] The number of items to return.
5849
5853
  * @param {string} [filterName] Comma-separated list of names to filter on.
5850
5854
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5855
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5851
5856
  * @param {*} [options] Override http request option.
5852
5857
  * @throws {RequiredError}
5853
5858
  */
5854
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
5859
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
5855
5860
  return __awaiter(this, void 0, void 0, function* () {
5856
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options);
5861
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options);
5857
5862
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
5858
5863
  });
5859
5864
  },
@@ -5929,7 +5934,7 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
5929
5934
  /**
5930
5935
  * Get a `scene` by ID.
5931
5936
  * @param {string} id The &#x60;scene&#x60; ID.
5932
- * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; is only returned if explicitly requested.
5937
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5933
5938
  * @param {*} [options] Override http request option.
5934
5939
  * @throws {RequiredError}
5935
5940
  */
@@ -5944,12 +5949,13 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
5944
5949
  * @param {number} [pageSize] The number of items to return.
5945
5950
  * @param {string} [filterName] Comma-separated list of names to filter on.
5946
5951
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5952
+ * @param {string} [fieldsScene] Comma-separated list of fields to return in response. An empty value returns no fields. &#x60;sceneItemCount&#x60; and &#x60;metadata&#x60; are only returned if explicitly requested.
5947
5953
  * @param {*} [options] Override http request option.
5948
5954
  * @throws {RequiredError}
5949
5955
  */
5950
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options) {
5956
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
5951
5957
  return localVarFp
5952
- .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, options)
5958
+ .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options)
5953
5959
  .then((request) => request(axios, basePath));
5954
5960
  },
5955
5961
  /**
@@ -6043,7 +6049,7 @@ export class ScenesApi extends BaseAPI {
6043
6049
  */
6044
6050
  getScenes(requestParameters = {}, options) {
6045
6051
  return ScenesApiFp(this.configuration)
6046
- .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, options)
6052
+ .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, options)
6047
6053
  .then((request) => request(this.axios, this.basePath));
6048
6054
  }
6049
6055
  /**
@@ -1 +1 @@
1
- export declare const version = "0.20.7";
1
+ export declare const version = "0.20.8";
@@ -1 +1 @@
1
- export const version = '0.20.7';
1
+ export const version = '0.20.8';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertexvis/api-client-node",
3
- "version": "0.20.7",
3
+ "version": "0.20.8",
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)",