@vertexvis/api-client-node 0.20.8 → 0.20.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/cjs/api.d.ts CHANGED
@@ -1277,6 +1277,12 @@ export interface CreateSceneItemOverrideRequestDataAttributes {
1277
1277
  * @memberof CreateSceneItemOverrideRequestDataAttributes
1278
1278
  */
1279
1279
  selected?: ColorMaterial;
1280
+ /**
1281
+ * Phantom state of the item.
1282
+ * @type {boolean}
1283
+ * @memberof CreateSceneItemOverrideRequestDataAttributes
1284
+ */
1285
+ phantom?: boolean;
1280
1286
  }
1281
1287
  /**
1282
1288
  *
@@ -1348,7 +1354,13 @@ export interface CreateSceneItemRequestDataAttributes {
1348
1354
  */
1349
1355
  name?: string;
1350
1356
  /**
1351
- * ID provided for correlation. For example, an existing ID from a PLM system.
1357
+ * A 0-based index used for defining a consistent ordering amongst sibling scene items.
1358
+ * @type {number}
1359
+ * @memberof CreateSceneItemRequestDataAttributes
1360
+ */
1361
+ ordinal?: number;
1362
+ /**
1363
+ * Optional ability to specify a parent scene item by scene item supplied ID. For example, an existing ID from a PLM system. This approach is an alternative to providing a specific scene item ID with the relationship parent property.
1352
1364
  * @type {string}
1353
1365
  * @memberof CreateSceneItemRequestDataAttributes
1354
1366
  */
@@ -1383,6 +1395,12 @@ export interface CreateSceneItemRequestDataAttributes {
1383
1395
  * @memberof CreateSceneItemRequestDataAttributes
1384
1396
  */
1385
1397
  visible?: boolean;
1398
+ /**
1399
+ * Phantom state of the item.
1400
+ * @type {boolean}
1401
+ * @memberof CreateSceneItemRequestDataAttributes
1402
+ */
1403
+ phantom?: boolean;
1386
1404
  /**
1387
1405
  * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
1388
1406
  * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
@@ -4030,6 +4048,12 @@ export interface SceneItemDataAttributes {
4030
4048
  * @memberof SceneItemDataAttributes
4031
4049
  */
4032
4050
  name?: string;
4051
+ /**
4052
+ *
4053
+ * @type {boolean}
4054
+ * @memberof SceneItemDataAttributes
4055
+ */
4056
+ phantom?: boolean;
4033
4057
  /**
4034
4058
  *
4035
4059
  * @type {string}
@@ -4191,6 +4215,12 @@ export interface SceneItemOverrideDataAttributes {
4191
4215
  * @memberof SceneItemOverrideDataAttributes
4192
4216
  */
4193
4217
  selected?: ColorMaterial;
4218
+ /**
4219
+ *
4220
+ * @type {boolean}
4221
+ * @memberof SceneItemOverrideDataAttributes
4222
+ */
4223
+ phantom?: boolean;
4194
4224
  }
4195
4225
  /**
4196
4226
  *
@@ -5179,6 +5209,12 @@ export interface UpdateSceneItemOverrideRequestDataAttributes {
5179
5209
  * @memberof UpdateSceneItemOverrideRequestDataAttributes
5180
5210
  */
5181
5211
  selected?: ColorMaterialNullable | null;
5212
+ /**
5213
+ *
5214
+ * @type {boolean}
5215
+ * @memberof UpdateSceneItemOverrideRequestDataAttributes
5216
+ */
5217
+ phantom?: boolean | null;
5182
5218
  }
5183
5219
  /**
5184
5220
  *
@@ -5262,6 +5298,12 @@ export interface UpdateSceneItemRequestDataAttributes {
5262
5298
  metadata?: {
5263
5299
  [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
5264
5300
  };
5301
+ /**
5302
+ * Phantom state of the item.
5303
+ * @type {boolean}
5304
+ * @memberof UpdateSceneItemRequestDataAttributes
5305
+ */
5306
+ phantom?: boolean;
5265
5307
  }
5266
5308
  /**
5267
5309
  *
@@ -9783,10 +9825,13 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
9783
9825
  * @param {string} [filterName] Comma-separated list of names to filter on.
9784
9826
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9785
9827
  * @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.
9828
+ * @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`.
9786
9829
  * @param {*} [options] Override http request option.
9787
9830
  * @throws {RequiredError}
9788
9831
  */
9789
- getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9832
+ getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
9833
+ [key: string]: string;
9834
+ } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9790
9835
  /**
9791
9836
  * 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.
9792
9837
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9846,10 +9891,13 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9846
9891
  * @param {string} [filterName] Comma-separated list of names to filter on.
9847
9892
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9848
9893
  * @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.
9894
+ * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
9849
9895
  * @param {*} [options] Override http request option.
9850
9896
  * @throws {RequiredError}
9851
9897
  */
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>>;
9898
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
9899
+ [key: string]: string;
9900
+ } | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
9853
9901
  /**
9854
9902
  * 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.
9855
9903
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9909,10 +9957,13 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9909
9957
  * @param {string} [filterName] Comma-separated list of names to filter on.
9910
9958
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9911
9959
  * @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.
9960
+ * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
9912
9961
  * @param {*} [options] Override http request option.
9913
9962
  * @throws {RequiredError}
9914
9963
  */
9915
- getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: any): AxiosPromise<SceneList>;
9964
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
9965
+ [key: string]: string;
9966
+ } | undefined, options?: any): AxiosPromise<SceneList>;
9916
9967
  /**
9917
9968
  * 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.
9918
9969
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -10025,6 +10076,14 @@ export interface ScenesApiGetScenesRequest {
10025
10076
  * @memberof ScenesApiGetScenes
10026
10077
  */
10027
10078
  readonly fieldsScene?: string;
10079
+ /**
10080
+ * Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
10081
+ * @type {{ [key: string]: string; }}
10082
+ * @memberof ScenesApiGetScenes
10083
+ */
10084
+ readonly filterMetadata?: {
10085
+ [key: string]: string;
10086
+ };
10028
10087
  }
10029
10088
  /**
10030
10089
  * Request parameters for renderScene operation in ScenesApi.
package/dist/cjs/api.js CHANGED
@@ -5743,10 +5743,11 @@ const ScenesApiAxiosParamCreator = function (configuration) {
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
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.
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: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
5746
5747
  * @param {*} [options] Override http request option.
5747
5748
  * @throws {RequiredError}
5748
5749
  */
5749
- getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options = {}) => __awaiter(this, void 0, void 0, function* () {
5750
+ getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options = {}) => __awaiter(this, void 0, void 0, function* () {
5750
5751
  const localVarPath = `/scenes`;
5751
5752
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5752
5753
  const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -5775,6 +5776,9 @@ const ScenesApiAxiosParamCreator = function (configuration) {
5775
5776
  if (fieldsScene !== undefined) {
5776
5777
  localVarQueryParameter['fields[scene]'] = fieldsScene;
5777
5778
  }
5779
+ if (filterMetadata !== undefined) {
5780
+ localVarQueryParameter['filter[metadata]'] = filterMetadata;
5781
+ }
5778
5782
  (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
5779
5783
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5780
5784
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -5922,12 +5926,13 @@ const ScenesApiFp = function (configuration) {
5922
5926
  * @param {string} [filterName] Comma-separated list of names to filter on.
5923
5927
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5924
5928
  * @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.
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: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
5925
5930
  * @param {*} [options] Override http request option.
5926
5931
  * @throws {RequiredError}
5927
5932
  */
5928
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
5933
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
5929
5934
  return __awaiter(this, void 0, void 0, function* () {
5930
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options);
5935
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options);
5931
5936
  return (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
5932
5937
  });
5933
5938
  },
@@ -6020,12 +6025,13 @@ const ScenesApiFactory = function (configuration, basePath, axios) {
6020
6025
  * @param {string} [filterName] Comma-separated list of names to filter on.
6021
6026
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
6022
6027
  * @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.
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: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
6023
6029
  * @param {*} [options] Override http request option.
6024
6030
  * @throws {RequiredError}
6025
6031
  */
6026
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
6032
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
6027
6033
  return localVarFp
6028
- .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options)
6034
+ .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options)
6029
6035
  .then((request) => request(axios, basePath));
6030
6036
  },
6031
6037
  /**
@@ -6120,7 +6126,7 @@ class ScenesApi extends base_1.BaseAPI {
6120
6126
  */
6121
6127
  getScenes(requestParameters = {}, options) {
6122
6128
  return (0, exports.ScenesApiFp)(this.configuration)
6123
- .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, options)
6129
+ .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, requestParameters.filterMetadata, options)
6124
6130
  .then((request) => request(this.axios, this.basePath));
6125
6131
  }
6126
6132
  /**
@@ -1 +1 @@
1
- export declare const version = "0.20.8";
1
+ export declare const version = "0.20.10";
@@ -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.8';
4
+ exports.version = '0.20.10';
package/dist/esm/api.d.ts CHANGED
@@ -1277,6 +1277,12 @@ export interface CreateSceneItemOverrideRequestDataAttributes {
1277
1277
  * @memberof CreateSceneItemOverrideRequestDataAttributes
1278
1278
  */
1279
1279
  selected?: ColorMaterial;
1280
+ /**
1281
+ * Phantom state of the item.
1282
+ * @type {boolean}
1283
+ * @memberof CreateSceneItemOverrideRequestDataAttributes
1284
+ */
1285
+ phantom?: boolean;
1280
1286
  }
1281
1287
  /**
1282
1288
  *
@@ -1348,7 +1354,13 @@ export interface CreateSceneItemRequestDataAttributes {
1348
1354
  */
1349
1355
  name?: string;
1350
1356
  /**
1351
- * ID provided for correlation. For example, an existing ID from a PLM system.
1357
+ * A 0-based index used for defining a consistent ordering amongst sibling scene items.
1358
+ * @type {number}
1359
+ * @memberof CreateSceneItemRequestDataAttributes
1360
+ */
1361
+ ordinal?: number;
1362
+ /**
1363
+ * Optional ability to specify a parent scene item by scene item supplied ID. For example, an existing ID from a PLM system. This approach is an alternative to providing a specific scene item ID with the relationship parent property.
1352
1364
  * @type {string}
1353
1365
  * @memberof CreateSceneItemRequestDataAttributes
1354
1366
  */
@@ -1383,6 +1395,12 @@ export interface CreateSceneItemRequestDataAttributes {
1383
1395
  * @memberof CreateSceneItemRequestDataAttributes
1384
1396
  */
1385
1397
  visible?: boolean;
1398
+ /**
1399
+ * Phantom state of the item.
1400
+ * @type {boolean}
1401
+ * @memberof CreateSceneItemRequestDataAttributes
1402
+ */
1403
+ phantom?: boolean;
1386
1404
  /**
1387
1405
  * Additional metadata for the scene-item. This metadata will take precedence over any metadata that belongs to the part file.
1388
1406
  * @type {{ [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType; }}
@@ -4030,6 +4048,12 @@ export interface SceneItemDataAttributes {
4030
4048
  * @memberof SceneItemDataAttributes
4031
4049
  */
4032
4050
  name?: string;
4051
+ /**
4052
+ *
4053
+ * @type {boolean}
4054
+ * @memberof SceneItemDataAttributes
4055
+ */
4056
+ phantom?: boolean;
4033
4057
  /**
4034
4058
  *
4035
4059
  * @type {string}
@@ -4191,6 +4215,12 @@ export interface SceneItemOverrideDataAttributes {
4191
4215
  * @memberof SceneItemOverrideDataAttributes
4192
4216
  */
4193
4217
  selected?: ColorMaterial;
4218
+ /**
4219
+ *
4220
+ * @type {boolean}
4221
+ * @memberof SceneItemOverrideDataAttributes
4222
+ */
4223
+ phantom?: boolean;
4194
4224
  }
4195
4225
  /**
4196
4226
  *
@@ -5179,6 +5209,12 @@ export interface UpdateSceneItemOverrideRequestDataAttributes {
5179
5209
  * @memberof UpdateSceneItemOverrideRequestDataAttributes
5180
5210
  */
5181
5211
  selected?: ColorMaterialNullable | null;
5212
+ /**
5213
+ *
5214
+ * @type {boolean}
5215
+ * @memberof UpdateSceneItemOverrideRequestDataAttributes
5216
+ */
5217
+ phantom?: boolean | null;
5182
5218
  }
5183
5219
  /**
5184
5220
  *
@@ -5262,6 +5298,12 @@ export interface UpdateSceneItemRequestDataAttributes {
5262
5298
  metadata?: {
5263
5299
  [key: string]: MetadataLongType | MetadataFloatType | MetadataDateType | MetadataStringType | MetadataNullType;
5264
5300
  };
5301
+ /**
5302
+ * Phantom state of the item.
5303
+ * @type {boolean}
5304
+ * @memberof UpdateSceneItemRequestDataAttributes
5305
+ */
5306
+ phantom?: boolean;
5265
5307
  }
5266
5308
  /**
5267
5309
  *
@@ -9783,10 +9825,13 @@ export declare const ScenesApiAxiosParamCreator: (configuration?: Configuration
9783
9825
  * @param {string} [filterName] Comma-separated list of names to filter on.
9784
9826
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9785
9827
  * @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.
9828
+ * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
9786
9829
  * @param {*} [options] Override http request option.
9787
9830
  * @throws {RequiredError}
9788
9831
  */
9789
- getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9832
+ getScenes: (pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
9833
+ [key: string]: string;
9834
+ } | undefined, options?: AxiosRequestConfig) => Promise<RequestArgs>;
9790
9835
  /**
9791
9836
  * 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.
9792
9837
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9846,10 +9891,13 @@ export declare const ScenesApiFp: (configuration?: Configuration | undefined) =>
9846
9891
  * @param {string} [filterName] Comma-separated list of names to filter on.
9847
9892
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9848
9893
  * @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.
9894
+ * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
9849
9895
  * @param {*} [options] Override http request option.
9850
9896
  * @throws {RequiredError}
9851
9897
  */
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>>;
9898
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
9899
+ [key: string]: string;
9900
+ } | undefined, options?: AxiosRequestConfig<any> | undefined): Promise<(axios?: AxiosInstance | undefined, basePath?: string | undefined) => AxiosPromise<SceneList>>;
9853
9901
  /**
9854
9902
  * 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.
9855
9903
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -9909,10 +9957,13 @@ export declare const ScenesApiFactory: (configuration?: Configuration | undefine
9909
9957
  * @param {string} [filterName] Comma-separated list of names to filter on.
9910
9958
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
9911
9959
  * @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.
9960
+ * @param {{ [key: string]: string; }} [filterMetadata] Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
9912
9961
  * @param {*} [options] Override http request option.
9913
9962
  * @throws {RequiredError}
9914
9963
  */
9915
- getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, options?: any): AxiosPromise<SceneList>;
9964
+ getScenes(pageCursor?: string | undefined, pageSize?: number | undefined, filterName?: string | undefined, filterSuppliedId?: string | undefined, fieldsScene?: string | undefined, filterMetadata?: {
9965
+ [key: string]: string;
9966
+ } | undefined, options?: any): AxiosPromise<SceneList>;
9916
9967
  /**
9917
9968
  * 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.
9918
9969
  * @param {string} id The &#x60;scene&#x60; ID.
@@ -10025,6 +10076,14 @@ export interface ScenesApiGetScenesRequest {
10025
10076
  * @memberof ScenesApiGetScenes
10026
10077
  */
10027
10078
  readonly fieldsScene?: string;
10079
+ /**
10080
+ * Filter scenes that contain all the given metadata key-value pairs. Should be specified in query parameter map notation: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
10081
+ * @type {{ [key: string]: string; }}
10082
+ * @memberof ScenesApiGetScenes
10083
+ */
10084
+ readonly filterMetadata?: {
10085
+ [key: string]: string;
10086
+ };
10028
10087
  }
10029
10088
  /**
10030
10089
  * Request parameters for renderScene operation in ScenesApi.
package/dist/esm/api.js CHANGED
@@ -5675,10 +5675,11 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
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
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.
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: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
5678
5679
  * @param {*} [options] Override http request option.
5679
5680
  * @throws {RequiredError}
5680
5681
  */
5681
- getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options = {}) => __awaiter(this, void 0, void 0, function* () {
5682
+ getScenes: (pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options = {}) => __awaiter(this, void 0, void 0, function* () {
5682
5683
  const localVarPath = `/scenes`;
5683
5684
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5684
5685
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5707,6 +5708,9 @@ export const ScenesApiAxiosParamCreator = function (configuration) {
5707
5708
  if (fieldsScene !== undefined) {
5708
5709
  localVarQueryParameter['fields[scene]'] = fieldsScene;
5709
5710
  }
5711
+ if (filterMetadata !== undefined) {
5712
+ localVarQueryParameter['filter[metadata]'] = filterMetadata;
5713
+ }
5710
5714
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5711
5715
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
5712
5716
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -5853,12 +5857,13 @@ export const ScenesApiFp = function (configuration) {
5853
5857
  * @param {string} [filterName] Comma-separated list of names to filter on.
5854
5858
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5855
5859
  * @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.
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: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
5856
5861
  * @param {*} [options] Override http request option.
5857
5862
  * @throws {RequiredError}
5858
5863
  */
5859
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
5864
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
5860
5865
  return __awaiter(this, void 0, void 0, function* () {
5861
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options);
5866
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options);
5862
5867
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
5863
5868
  });
5864
5869
  },
@@ -5950,12 +5955,13 @@ export const ScenesApiFactory = function (configuration, basePath, axios) {
5950
5955
  * @param {string} [filterName] Comma-separated list of names to filter on.
5951
5956
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5952
5957
  * @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.
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: &#x60;filter[metadata][key1]&#x3D;value1&amp;filter[metadata][key]&#x3D;value2&#x60;.
5953
5959
  * @param {*} [options] Override http request option.
5954
5960
  * @throws {RequiredError}
5955
5961
  */
5956
- getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options) {
5962
+ getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options) {
5957
5963
  return localVarFp
5958
- .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, options)
5964
+ .getScenes(pageCursor, pageSize, filterName, filterSuppliedId, fieldsScene, filterMetadata, options)
5959
5965
  .then((request) => request(axios, basePath));
5960
5966
  },
5961
5967
  /**
@@ -6049,7 +6055,7 @@ export class ScenesApi extends BaseAPI {
6049
6055
  */
6050
6056
  getScenes(requestParameters = {}, options) {
6051
6057
  return ScenesApiFp(this.configuration)
6052
- .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, options)
6058
+ .getScenes(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterName, requestParameters.filterSuppliedId, requestParameters.fieldsScene, requestParameters.filterMetadata, options)
6053
6059
  .then((request) => request(this.axios, this.basePath));
6054
6060
  }
6055
6061
  /**
@@ -1 +1 @@
1
- export declare const version = "0.20.8";
1
+ export declare const version = "0.20.10";
@@ -1 +1 @@
1
- export const version = '0.20.8';
1
+ export const version = '0.20.10';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@vertexvis/api-client-node",
3
- "version": "0.20.8",
3
+ "version": "0.20.10",
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)",