@vertexvis/api-client-node 0.30.0 → 0.30.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/api.js CHANGED
@@ -26,6 +26,9 @@ import globalAxios from 'axios';
26
26
  import { DUMMY_BASE_URL, assertParamExists, setBasicAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, } from './common';
27
27
  // @ts-ignore
28
28
  import { BASE_PATH, BaseAPI } from './base';
29
+ export const AccountRelationshipDataTypeEnum = {
30
+ Account: 'account',
31
+ };
29
32
  export const BatchOperationOpEnum = {
30
33
  Add: 'add',
31
34
  };
@@ -63,11 +66,23 @@ export const CreateFileCollectionRequestDataTypeEnum = {
63
66
  export const CreateFileJobRequestDataTypeEnum = {
64
67
  FileJob: 'file-job',
65
68
  };
69
+ export const CreatePermissionGrantDataTypeEnum = {
70
+ PermissionGrant: 'permission-grant',
71
+ };
72
+ export const CreatePermissionGrantDataAttributesCapabilityEnum = {
73
+ Read: 'read',
74
+ };
75
+ export const CreateSceneExpressionAlterationRequestDataTypeEnum = {
76
+ SceneAlterationExpression: 'scene-alteration-expression',
77
+ };
66
78
  export const CreateSceneItemRequestDataAttributesResolutionRuleEnum = {
67
79
  AsSpecified: 'as-specified',
68
80
  LatestIteration: 'latest-iteration',
69
81
  LatestRevision: 'latest-revision',
70
82
  };
83
+ export const CreateSearchSessionRequestDataTypeEnum = {
84
+ SearchSession: 'search-session',
85
+ };
71
86
  export const DeselectOperationTypeEnum = {
72
87
  Deselect: 'deselect',
73
88
  };
@@ -89,6 +104,9 @@ export const FileRelationshipDataTypeEnum = {
89
104
  export const GeometrySetRelationshipDataTypeEnum = {
90
105
  GeometrySet: 'geometry-set',
91
106
  };
107
+ export const GranteeAccountTypeEnum = {
108
+ Account: 'account',
109
+ };
92
110
  export const PartDataRelationshipsPartRevisionsTypeEnum = {
93
111
  PartRevision: 'part-revision',
94
112
  };
@@ -101,6 +119,12 @@ export const PartRelationshipDataTypeEnum = {
101
119
  export const PartRenditionRelationshipDataTypeEnum = {
102
120
  PartRendition: 'part-rendition',
103
121
  };
122
+ export const PartsDomainSubjectDomainEnum = {
123
+ Parts: 'parts',
124
+ };
125
+ export const PermissionGrantDataTypeEnum = {
126
+ PermissionGrant: 'permission-grant',
127
+ };
104
128
  export const PropertyDateTypeTypeEnum = {
105
129
  Date: 'date',
106
130
  };
@@ -110,6 +134,9 @@ export const PropertyDoubleTypeTypeEnum = {
110
134
  export const PropertyLongTypeTypeEnum = {
111
135
  Long: 'long',
112
136
  };
137
+ export const PropertySetDomainSubjectDomainEnum = {
138
+ PropertySets: 'property-sets',
139
+ };
113
140
  export const PropertySetRelationshipDataTypeEnum = {
114
141
  PropertySet: 'property-set',
115
142
  };
@@ -141,6 +168,28 @@ export const QueryByIdDataAttributesTypeEnum = {
141
168
  export const QueryByMetadataDataTypeEnum = {
142
169
  QueryByMetadata: 'query-by-metadata',
143
170
  };
171
+ export const QueryByRootTypeEnum = {
172
+ QueryByRoot: 'query-by-root',
173
+ };
174
+ export const QueryBySceneItemIdTypeEnum = {
175
+ Id: 'query-by-id',
176
+ SuppliedId: 'query-by-supplied-id',
177
+ };
178
+ export const QueryBySceneItemIdsTypeEnum = {
179
+ QueryByCollection: 'query-by-collection',
180
+ };
181
+ export const QueryBySceneItemMetadataTypeEnum = {
182
+ QueryByMetadata: 'query-by-metadata',
183
+ };
184
+ export const SceneItemAndExpressionTypeEnum = {
185
+ And: 'and',
186
+ };
187
+ export const SceneItemOrExpressionTypeEnum = {
188
+ Or: 'or',
189
+ };
190
+ export const SceneItemQueryOperandTypeEnum = {
191
+ QueryOperand: 'query-operand',
192
+ };
144
193
  export const SceneItemRelationshipDataTypeEnum = {
145
194
  SceneItem: 'scene-item',
146
195
  };
@@ -4076,7 +4125,7 @@ export class PartRenditionsApi extends BaseAPI {
4076
4125
  export const PartRevisionInstancesApiAxiosParamCreator = function (configuration) {
4077
4126
  return {
4078
4127
  /**
4079
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4128
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4080
4129
  * @param {string} [filterParent] Parent ID to filter on.
4081
4130
  * @param {string} [pageCursor] The cursor for the next page of items.
4082
4131
  * @param {number} [pageSize] The number of items to return.
@@ -4125,7 +4174,7 @@ export const PartRevisionInstancesApiFp = function (configuration) {
4125
4174
  const localVarAxiosParamCreator = PartRevisionInstancesApiAxiosParamCreator(configuration);
4126
4175
  return {
4127
4176
  /**
4128
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4177
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4129
4178
  * @param {string} [filterParent] Parent ID to filter on.
4130
4179
  * @param {string} [pageCursor] The cursor for the next page of items.
4131
4180
  * @param {number} [pageSize] The number of items to return.
@@ -4148,7 +4197,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
4148
4197
  const localVarFp = PartRevisionInstancesApiFp(configuration);
4149
4198
  return {
4150
4199
  /**
4151
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4200
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4152
4201
  * @param {string} [filterParent] Parent ID to filter on.
4153
4202
  * @param {string} [pageCursor] The cursor for the next page of items.
4154
4203
  * @param {number} [pageSize] The number of items to return.
@@ -4170,7 +4219,7 @@ export const PartRevisionInstancesApiFactory = function (configuration, basePath
4170
4219
  */
4171
4220
  export class PartRevisionInstancesApi extends BaseAPI {
4172
4221
  /**
4173
- * Gets a page of \'part-revision\' instances. An instance is an occurence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4222
+ * Gets a page of \'part-revision\' instances. An instance is an occurrence of a revision that is a child of a parent revision. The returned data will have the ordinal used for ordering and the transform matrix for each occurrence.
4174
4223
  * @param {PartRevisionInstancesApiGetPartRevisionInstanceListRequest} requestParameters Request parameters.
4175
4224
  * @param {*} [options] Override http request option.
4176
4225
  * @throws {RequiredError}
@@ -4831,10 +4880,11 @@ export const PartsApiAxiosParamCreator = function (configuration) {
4831
4880
  * @param {string} [pageCursor] The cursor for the next page of items.
4832
4881
  * @param {number} [pageSize] The number of items to return.
4833
4882
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
4883
+ * @param {string} [filterOwnerId] Owner ID to filter on.
4834
4884
  * @param {*} [options] Override http request option.
4835
4885
  * @throws {RequiredError}
4836
4886
  */
4837
- getParts: (pageCursor, pageSize, filterSuppliedId, options = {}) => __awaiter(this, void 0, void 0, function* () {
4887
+ getParts: (pageCursor, pageSize, filterSuppliedId, filterOwnerId, options = {}) => __awaiter(this, void 0, void 0, function* () {
4838
4888
  var _d;
4839
4889
  const localVarPath = `/parts`;
4840
4890
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
@@ -4858,6 +4908,9 @@ export const PartsApiAxiosParamCreator = function (configuration) {
4858
4908
  if (filterSuppliedId !== undefined) {
4859
4909
  localVarQueryParameter['filter[suppliedId]'] = filterSuppliedId;
4860
4910
  }
4911
+ if (filterOwnerId !== undefined) {
4912
+ localVarQueryParameter['filter[ownerId]'] = filterOwnerId;
4913
+ }
4861
4914
  setSearchParams(localVarUrlObj, localVarQueryParameter);
4862
4915
  let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
4863
4916
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
@@ -4948,12 +5001,13 @@ export const PartsApiFp = function (configuration) {
4948
5001
  * @param {string} [pageCursor] The cursor for the next page of items.
4949
5002
  * @param {number} [pageSize] The number of items to return.
4950
5003
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5004
+ * @param {string} [filterOwnerId] Owner ID to filter on.
4951
5005
  * @param {*} [options] Override http request option.
4952
5006
  * @throws {RequiredError}
4953
5007
  */
4954
- getParts(pageCursor, pageSize, filterSuppliedId, options) {
5008
+ getParts(pageCursor, pageSize, filterSuppliedId, filterOwnerId, options) {
4955
5009
  return __awaiter(this, void 0, void 0, function* () {
4956
- const localVarAxiosArgs = yield localVarAxiosParamCreator.getParts(pageCursor, pageSize, filterSuppliedId, options);
5010
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getParts(pageCursor, pageSize, filterSuppliedId, filterOwnerId, options);
4957
5011
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
4958
5012
  });
4959
5013
  },
@@ -5017,12 +5071,13 @@ export const PartsApiFactory = function (configuration, basePath, axios) {
5017
5071
  * @param {string} [pageCursor] The cursor for the next page of items.
5018
5072
  * @param {number} [pageSize] The number of items to return.
5019
5073
  * @param {string} [filterSuppliedId] Comma-separated list of supplied IDs to filter on.
5074
+ * @param {string} [filterOwnerId] Owner ID to filter on.
5020
5075
  * @param {*} [options] Override http request option.
5021
5076
  * @throws {RequiredError}
5022
5077
  */
5023
- getParts(pageCursor, pageSize, filterSuppliedId, options) {
5078
+ getParts(pageCursor, pageSize, filterSuppliedId, filterOwnerId, options) {
5024
5079
  return localVarFp
5025
- .getParts(pageCursor, pageSize, filterSuppliedId, options)
5080
+ .getParts(pageCursor, pageSize, filterSuppliedId, filterOwnerId, options)
5026
5081
  .then((request) => request(axios, basePath));
5027
5082
  },
5028
5083
  /**
@@ -5090,7 +5145,7 @@ export class PartsApi extends BaseAPI {
5090
5145
  */
5091
5146
  getParts(requestParameters = {}, options) {
5092
5147
  return PartsApiFp(this.configuration)
5093
- .getParts(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSuppliedId, options)
5148
+ .getParts(requestParameters.pageCursor, requestParameters.pageSize, requestParameters.filterSuppliedId, requestParameters.filterOwnerId, options)
5094
5149
  .then((request) => request(this.axios, this.basePath));
5095
5150
  }
5096
5151
  /**
@@ -5106,6 +5161,329 @@ export class PartsApi extends BaseAPI {
5106
5161
  .then((request) => request(this.axios, this.basePath));
5107
5162
  }
5108
5163
  }
5164
+ /**
5165
+ * PermissionGrantsApi - axios parameter creator
5166
+ * @export
5167
+ */
5168
+ export const PermissionGrantsApiAxiosParamCreator = function (configuration) {
5169
+ return {
5170
+ /**
5171
+ * Create a permission grant for a grantee to a subject resource
5172
+ * @summary Create a permission grant for a grantee to a subject resource
5173
+ * @param {CreatePermissionGrant} createPermissionGrant
5174
+ * @param {*} [options] Override http request option.
5175
+ * @throws {RequiredError}
5176
+ */
5177
+ createPermissionGrant: (createPermissionGrant, options = {}) => __awaiter(this, void 0, void 0, function* () {
5178
+ var _a;
5179
+ // verify required parameter 'createPermissionGrant' is not null or undefined
5180
+ assertParamExists('createPermissionGrant', 'createPermissionGrant', createPermissionGrant);
5181
+ const localVarPath = `/permission-grants`;
5182
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5183
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5184
+ let baseOptions;
5185
+ if (configuration) {
5186
+ baseOptions = configuration.baseOptions;
5187
+ }
5188
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
5189
+ const localVarHeaderParameter = {};
5190
+ const localVarQueryParameter = {};
5191
+ // authentication OAuth2 required
5192
+ // oauth required
5193
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
5194
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
5195
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5196
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
5197
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
5198
+ localVarRequestOptions.data = serializeDataIfNeeded(createPermissionGrant, localVarRequestOptions, configuration);
5199
+ return {
5200
+ url: toPathString(localVarUrlObj),
5201
+ options: localVarRequestOptions,
5202
+ };
5203
+ }),
5204
+ /**
5205
+ * Get a permission grant by ID
5206
+ * @summary Get a permission grant by ID
5207
+ * @param {string} id The permission grant ID.
5208
+ * @param {*} [options] Override http request option.
5209
+ * @throws {RequiredError}
5210
+ */
5211
+ getPermissionGrant: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
5212
+ var _b;
5213
+ // verify required parameter 'id' is not null or undefined
5214
+ assertParamExists('getPermissionGrant', 'id', id);
5215
+ const localVarPath = `/permission-grants/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
5216
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5217
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5218
+ let baseOptions;
5219
+ if (configuration) {
5220
+ baseOptions = configuration.baseOptions;
5221
+ }
5222
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
5223
+ const localVarHeaderParameter = {};
5224
+ const localVarQueryParameter = {};
5225
+ // authentication OAuth2 required
5226
+ // oauth required
5227
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
5228
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5229
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
5230
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
5231
+ return {
5232
+ url: toPathString(localVarUrlObj),
5233
+ options: localVarRequestOptions,
5234
+ };
5235
+ }),
5236
+ /**
5237
+ * List all permission grants
5238
+ * @summary List all permission grants
5239
+ * @param {string} [pageCursor] The cursor for the next page of items.
5240
+ * @param {number} [pageSize] The number of items to return.
5241
+ * @param {*} [options] Override http request option.
5242
+ * @throws {RequiredError}
5243
+ */
5244
+ listPermissionGrants: (pageCursor, pageSize, options = {}) => __awaiter(this, void 0, void 0, function* () {
5245
+ var _c;
5246
+ const localVarPath = `/permission-grants`;
5247
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5248
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5249
+ let baseOptions;
5250
+ if (configuration) {
5251
+ baseOptions = configuration.baseOptions;
5252
+ }
5253
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
5254
+ const localVarHeaderParameter = {};
5255
+ const localVarQueryParameter = {};
5256
+ // authentication OAuth2 required
5257
+ // oauth required
5258
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
5259
+ if (pageCursor !== undefined) {
5260
+ localVarQueryParameter['page[cursor]'] = pageCursor;
5261
+ }
5262
+ if (pageSize !== undefined) {
5263
+ localVarQueryParameter['page[size]'] = pageSize;
5264
+ }
5265
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5266
+ let headersFromBaseOptions = (_c = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _c !== void 0 ? _c : {};
5267
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
5268
+ return {
5269
+ url: toPathString(localVarUrlObj),
5270
+ options: localVarRequestOptions,
5271
+ };
5272
+ }),
5273
+ /**
5274
+ * Remove a permission grant by ID
5275
+ * @summary Remove a permission grant by ID
5276
+ * @param {string} id The permission grant ID.
5277
+ * @param {*} [options] Override http request option.
5278
+ * @throws {RequiredError}
5279
+ */
5280
+ removePermissionGrant: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
5281
+ var _d;
5282
+ // verify required parameter 'id' is not null or undefined
5283
+ assertParamExists('removePermissionGrant', 'id', id);
5284
+ const localVarPath = `/permission-grants/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
5285
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
5286
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
5287
+ let baseOptions;
5288
+ if (configuration) {
5289
+ baseOptions = configuration.baseOptions;
5290
+ }
5291
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'DELETE' }, baseOptions), options);
5292
+ const localVarHeaderParameter = {};
5293
+ const localVarQueryParameter = {};
5294
+ // authentication OAuth2 required
5295
+ // oauth required
5296
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
5297
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
5298
+ let headersFromBaseOptions = (_d = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _d !== void 0 ? _d : {};
5299
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
5300
+ return {
5301
+ url: toPathString(localVarUrlObj),
5302
+ options: localVarRequestOptions,
5303
+ };
5304
+ }),
5305
+ };
5306
+ };
5307
+ /**
5308
+ * PermissionGrantsApi - functional programming interface
5309
+ * @export
5310
+ */
5311
+ export const PermissionGrantsApiFp = function (configuration) {
5312
+ const localVarAxiosParamCreator = PermissionGrantsApiAxiosParamCreator(configuration);
5313
+ return {
5314
+ /**
5315
+ * Create a permission grant for a grantee to a subject resource
5316
+ * @summary Create a permission grant for a grantee to a subject resource
5317
+ * @param {CreatePermissionGrant} createPermissionGrant
5318
+ * @param {*} [options] Override http request option.
5319
+ * @throws {RequiredError}
5320
+ */
5321
+ createPermissionGrant(createPermissionGrant, options) {
5322
+ return __awaiter(this, void 0, void 0, function* () {
5323
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createPermissionGrant(createPermissionGrant, options);
5324
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
5325
+ });
5326
+ },
5327
+ /**
5328
+ * Get a permission grant by ID
5329
+ * @summary Get a permission grant by ID
5330
+ * @param {string} id The permission grant ID.
5331
+ * @param {*} [options] Override http request option.
5332
+ * @throws {RequiredError}
5333
+ */
5334
+ getPermissionGrant(id, options) {
5335
+ return __awaiter(this, void 0, void 0, function* () {
5336
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getPermissionGrant(id, options);
5337
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
5338
+ });
5339
+ },
5340
+ /**
5341
+ * List all permission grants
5342
+ * @summary List all permission grants
5343
+ * @param {string} [pageCursor] The cursor for the next page of items.
5344
+ * @param {number} [pageSize] The number of items to return.
5345
+ * @param {*} [options] Override http request option.
5346
+ * @throws {RequiredError}
5347
+ */
5348
+ listPermissionGrants(pageCursor, pageSize, options) {
5349
+ return __awaiter(this, void 0, void 0, function* () {
5350
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listPermissionGrants(pageCursor, pageSize, options);
5351
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
5352
+ });
5353
+ },
5354
+ /**
5355
+ * Remove a permission grant by ID
5356
+ * @summary Remove a permission grant by ID
5357
+ * @param {string} id The permission grant ID.
5358
+ * @param {*} [options] Override http request option.
5359
+ * @throws {RequiredError}
5360
+ */
5361
+ removePermissionGrant(id, options) {
5362
+ return __awaiter(this, void 0, void 0, function* () {
5363
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.removePermissionGrant(id, options);
5364
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
5365
+ });
5366
+ },
5367
+ };
5368
+ };
5369
+ /**
5370
+ * PermissionGrantsApi - factory interface
5371
+ * @export
5372
+ */
5373
+ export const PermissionGrantsApiFactory = function (configuration, basePath, axios) {
5374
+ const localVarFp = PermissionGrantsApiFp(configuration);
5375
+ return {
5376
+ /**
5377
+ * Create a permission grant for a grantee to a subject resource
5378
+ * @summary Create a permission grant for a grantee to a subject resource
5379
+ * @param {CreatePermissionGrant} createPermissionGrant
5380
+ * @param {*} [options] Override http request option.
5381
+ * @throws {RequiredError}
5382
+ */
5383
+ createPermissionGrant(createPermissionGrant, options) {
5384
+ return localVarFp
5385
+ .createPermissionGrant(createPermissionGrant, options)
5386
+ .then((request) => request(axios, basePath));
5387
+ },
5388
+ /**
5389
+ * Get a permission grant by ID
5390
+ * @summary Get a permission grant by ID
5391
+ * @param {string} id The permission grant ID.
5392
+ * @param {*} [options] Override http request option.
5393
+ * @throws {RequiredError}
5394
+ */
5395
+ getPermissionGrant(id, options) {
5396
+ return localVarFp
5397
+ .getPermissionGrant(id, options)
5398
+ .then((request) => request(axios, basePath));
5399
+ },
5400
+ /**
5401
+ * List all permission grants
5402
+ * @summary List all permission grants
5403
+ * @param {string} [pageCursor] The cursor for the next page of items.
5404
+ * @param {number} [pageSize] The number of items to return.
5405
+ * @param {*} [options] Override http request option.
5406
+ * @throws {RequiredError}
5407
+ */
5408
+ listPermissionGrants(pageCursor, pageSize, options) {
5409
+ return localVarFp
5410
+ .listPermissionGrants(pageCursor, pageSize, options)
5411
+ .then((request) => request(axios, basePath));
5412
+ },
5413
+ /**
5414
+ * Remove a permission grant by ID
5415
+ * @summary Remove a permission grant by ID
5416
+ * @param {string} id The permission grant ID.
5417
+ * @param {*} [options] Override http request option.
5418
+ * @throws {RequiredError}
5419
+ */
5420
+ removePermissionGrant(id, options) {
5421
+ return localVarFp
5422
+ .removePermissionGrant(id, options)
5423
+ .then((request) => request(axios, basePath));
5424
+ },
5425
+ };
5426
+ };
5427
+ /**
5428
+ * PermissionGrantsApi - object-oriented interface
5429
+ * @export
5430
+ * @class PermissionGrantsApi
5431
+ * @extends {BaseAPI}
5432
+ */
5433
+ export class PermissionGrantsApi extends BaseAPI {
5434
+ /**
5435
+ * Create a permission grant for a grantee to a subject resource
5436
+ * @summary Create a permission grant for a grantee to a subject resource
5437
+ * @param {PermissionGrantsApiCreatePermissionGrantRequest} requestParameters Request parameters.
5438
+ * @param {*} [options] Override http request option.
5439
+ * @throws {RequiredError}
5440
+ * @memberof PermissionGrantsApi
5441
+ */
5442
+ createPermissionGrant(requestParameters, options) {
5443
+ return PermissionGrantsApiFp(this.configuration)
5444
+ .createPermissionGrant(requestParameters.createPermissionGrant, options)
5445
+ .then((request) => request(this.axios, this.basePath));
5446
+ }
5447
+ /**
5448
+ * Get a permission grant by ID
5449
+ * @summary Get a permission grant by ID
5450
+ * @param {PermissionGrantsApiGetPermissionGrantRequest} requestParameters Request parameters.
5451
+ * @param {*} [options] Override http request option.
5452
+ * @throws {RequiredError}
5453
+ * @memberof PermissionGrantsApi
5454
+ */
5455
+ getPermissionGrant(requestParameters, options) {
5456
+ return PermissionGrantsApiFp(this.configuration)
5457
+ .getPermissionGrant(requestParameters.id, options)
5458
+ .then((request) => request(this.axios, this.basePath));
5459
+ }
5460
+ /**
5461
+ * List all permission grants
5462
+ * @summary List all permission grants
5463
+ * @param {PermissionGrantsApiListPermissionGrantsRequest} requestParameters Request parameters.
5464
+ * @param {*} [options] Override http request option.
5465
+ * @throws {RequiredError}
5466
+ * @memberof PermissionGrantsApi
5467
+ */
5468
+ listPermissionGrants(requestParameters = {}, options) {
5469
+ return PermissionGrantsApiFp(this.configuration)
5470
+ .listPermissionGrants(requestParameters.pageCursor, requestParameters.pageSize, options)
5471
+ .then((request) => request(this.axios, this.basePath));
5472
+ }
5473
+ /**
5474
+ * Remove a permission grant by ID
5475
+ * @summary Remove a permission grant by ID
5476
+ * @param {PermissionGrantsApiRemovePermissionGrantRequest} requestParameters Request parameters.
5477
+ * @param {*} [options] Override http request option.
5478
+ * @throws {RequiredError}
5479
+ * @memberof PermissionGrantsApi
5480
+ */
5481
+ removePermissionGrant(requestParameters, options) {
5482
+ return PermissionGrantsApiFp(this.configuration)
5483
+ .removePermissionGrant(requestParameters.id, options)
5484
+ .then((request) => request(this.axios, this.basePath));
5485
+ }
5486
+ }
5109
5487
  /**
5110
5488
  * PmiApi - axios parameter creator
5111
5489
  * @export
@@ -5415,16 +5793,16 @@ export const SceneAlterationsApiAxiosParamCreator = function (configuration) {
5415
5793
  /**
5416
5794
  * Create a `scene-alteration` for a `scene-view`.
5417
5795
  * @param {string} id The `scene-view` ID.
5418
- * @param {CreateSceneAlterationRequest} createSceneAlterationRequest
5796
+ * @param {CreateSceneAlterationRequest | CreateSceneExpressionAlterationRequest} createSceneAlterationRequestCreateSceneExpressionAlterationRequest
5419
5797
  * @param {*} [options] Override http request option.
5420
5798
  * @throws {RequiredError}
5421
5799
  */
5422
- createSceneAlteration: (id, createSceneAlterationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
5800
+ createSceneAlteration: (id, createSceneAlterationRequestCreateSceneExpressionAlterationRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
5423
5801
  var _a;
5424
5802
  // verify required parameter 'id' is not null or undefined
5425
5803
  assertParamExists('createSceneAlteration', 'id', id);
5426
- // verify required parameter 'createSceneAlterationRequest' is not null or undefined
5427
- assertParamExists('createSceneAlteration', 'createSceneAlterationRequest', createSceneAlterationRequest);
5804
+ // verify required parameter 'createSceneAlterationRequestCreateSceneExpressionAlterationRequest' is not null or undefined
5805
+ assertParamExists('createSceneAlteration', 'createSceneAlterationRequestCreateSceneExpressionAlterationRequest', createSceneAlterationRequestCreateSceneExpressionAlterationRequest);
5428
5806
  const localVarPath = `/scene-views/{id}/scene-alterations`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
5429
5807
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
5430
5808
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
@@ -5442,7 +5820,7 @@ export const SceneAlterationsApiAxiosParamCreator = function (configuration) {
5442
5820
  setSearchParams(localVarUrlObj, localVarQueryParameter);
5443
5821
  let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
5444
5822
  localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
5445
- localVarRequestOptions.data = serializeDataIfNeeded(createSceneAlterationRequest, localVarRequestOptions, configuration);
5823
+ localVarRequestOptions.data = serializeDataIfNeeded(createSceneAlterationRequestCreateSceneExpressionAlterationRequest, localVarRequestOptions, configuration);
5446
5824
  return {
5447
5825
  url: toPathString(localVarUrlObj),
5448
5826
  options: localVarRequestOptions,
@@ -5553,13 +5931,13 @@ export const SceneAlterationsApiFp = function (configuration) {
5553
5931
  /**
5554
5932
  * Create a `scene-alteration` for a `scene-view`.
5555
5933
  * @param {string} id The `scene-view` ID.
5556
- * @param {CreateSceneAlterationRequest} createSceneAlterationRequest
5934
+ * @param {CreateSceneAlterationRequest | CreateSceneExpressionAlterationRequest} createSceneAlterationRequestCreateSceneExpressionAlterationRequest
5557
5935
  * @param {*} [options] Override http request option.
5558
5936
  * @throws {RequiredError}
5559
5937
  */
5560
- createSceneAlteration(id, createSceneAlterationRequest, options) {
5938
+ createSceneAlteration(id, createSceneAlterationRequestCreateSceneExpressionAlterationRequest, options) {
5561
5939
  return __awaiter(this, void 0, void 0, function* () {
5562
- const localVarAxiosArgs = yield localVarAxiosParamCreator.createSceneAlteration(id, createSceneAlterationRequest, options);
5940
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createSceneAlteration(id, createSceneAlterationRequestCreateSceneExpressionAlterationRequest, options);
5563
5941
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
5564
5942
  });
5565
5943
  },
@@ -5611,13 +5989,13 @@ export const SceneAlterationsApiFactory = function (configuration, basePath, axi
5611
5989
  /**
5612
5990
  * Create a `scene-alteration` for a `scene-view`.
5613
5991
  * @param {string} id The `scene-view` ID.
5614
- * @param {CreateSceneAlterationRequest} createSceneAlterationRequest
5992
+ * @param {CreateSceneAlterationRequest | CreateSceneExpressionAlterationRequest} createSceneAlterationRequestCreateSceneExpressionAlterationRequest
5615
5993
  * @param {*} [options] Override http request option.
5616
5994
  * @throws {RequiredError}
5617
5995
  */
5618
- createSceneAlteration(id, createSceneAlterationRequest, options) {
5996
+ createSceneAlteration(id, createSceneAlterationRequestCreateSceneExpressionAlterationRequest, options) {
5619
5997
  return localVarFp
5620
- .createSceneAlteration(id, createSceneAlterationRequest, options)
5998
+ .createSceneAlteration(id, createSceneAlterationRequestCreateSceneExpressionAlterationRequest, options)
5621
5999
  .then((request) => request(axios, basePath));
5622
6000
  },
5623
6001
  /**
@@ -5671,7 +6049,7 @@ export class SceneAlterationsApi extends BaseAPI {
5671
6049
  */
5672
6050
  createSceneAlteration(requestParameters, options) {
5673
6051
  return SceneAlterationsApiFp(this.configuration)
5674
- .createSceneAlteration(requestParameters.id, requestParameters.createSceneAlterationRequest, options)
6052
+ .createSceneAlteration(requestParameters.id, requestParameters.createSceneAlterationRequestCreateSceneExpressionAlterationRequest, options)
5675
6053
  .then((request) => request(this.axios, this.basePath));
5676
6054
  }
5677
6055
  /**
@@ -8857,6 +9235,174 @@ export class ScenesApi extends BaseAPI {
8857
9235
  .then((request) => request(this.axios, this.basePath));
8858
9236
  }
8859
9237
  }
9238
+ /**
9239
+ * SearchSessionsApi - axios parameter creator
9240
+ * @export
9241
+ */
9242
+ export const SearchSessionsApiAxiosParamCreator = function (configuration) {
9243
+ return {
9244
+ /**
9245
+ * Create a `search-session`.
9246
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
9247
+ * @param {*} [options] Override http request option.
9248
+ * @throws {RequiredError}
9249
+ */
9250
+ createSearchSession: (createSearchSessionRequest, options = {}) => __awaiter(this, void 0, void 0, function* () {
9251
+ var _a;
9252
+ // verify required parameter 'createSearchSessionRequest' is not null or undefined
9253
+ assertParamExists('createSearchSession', 'createSearchSessionRequest', createSearchSessionRequest);
9254
+ const localVarPath = `/search-sessions`;
9255
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9256
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9257
+ let baseOptions;
9258
+ if (configuration) {
9259
+ baseOptions = configuration.baseOptions;
9260
+ }
9261
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
9262
+ const localVarHeaderParameter = {};
9263
+ const localVarQueryParameter = {};
9264
+ // authentication OAuth2 required
9265
+ // oauth required
9266
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
9267
+ localVarHeaderParameter['Content-Type'] = 'application/vnd.api+json';
9268
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9269
+ let headersFromBaseOptions = (_a = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _a !== void 0 ? _a : {};
9270
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9271
+ localVarRequestOptions.data = serializeDataIfNeeded(createSearchSessionRequest, localVarRequestOptions, configuration);
9272
+ return {
9273
+ url: toPathString(localVarUrlObj),
9274
+ options: localVarRequestOptions,
9275
+ };
9276
+ }),
9277
+ /**
9278
+ * Get a `search-session`.
9279
+ * @param {string} id The `search-session` ID.
9280
+ * @param {*} [options] Override http request option.
9281
+ * @throws {RequiredError}
9282
+ */
9283
+ getSearchSession: (id, options = {}) => __awaiter(this, void 0, void 0, function* () {
9284
+ var _b;
9285
+ // verify required parameter 'id' is not null or undefined
9286
+ assertParamExists('getSearchSession', 'id', id);
9287
+ const localVarPath = `/search-sessions/{id}`.replace(`{${'id'}}`, encodeURIComponent(String(id)));
9288
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
9289
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
9290
+ let baseOptions;
9291
+ if (configuration) {
9292
+ baseOptions = configuration.baseOptions;
9293
+ }
9294
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
9295
+ const localVarHeaderParameter = {};
9296
+ const localVarQueryParameter = {};
9297
+ // authentication OAuth2 required
9298
+ // oauth required
9299
+ yield setOAuthToObject(localVarHeaderParameter, 'OAuth2', [], configuration);
9300
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
9301
+ let headersFromBaseOptions = (_b = baseOptions === null || baseOptions === void 0 ? void 0 : baseOptions.headers) !== null && _b !== void 0 ? _b : {};
9302
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
9303
+ return {
9304
+ url: toPathString(localVarUrlObj),
9305
+ options: localVarRequestOptions,
9306
+ };
9307
+ }),
9308
+ };
9309
+ };
9310
+ /**
9311
+ * SearchSessionsApi - functional programming interface
9312
+ * @export
9313
+ */
9314
+ export const SearchSessionsApiFp = function (configuration) {
9315
+ const localVarAxiosParamCreator = SearchSessionsApiAxiosParamCreator(configuration);
9316
+ return {
9317
+ /**
9318
+ * Create a `search-session`.
9319
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
9320
+ * @param {*} [options] Override http request option.
9321
+ * @throws {RequiredError}
9322
+ */
9323
+ createSearchSession(createSearchSessionRequest, options) {
9324
+ return __awaiter(this, void 0, void 0, function* () {
9325
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.createSearchSession(createSearchSessionRequest, options);
9326
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
9327
+ });
9328
+ },
9329
+ /**
9330
+ * Get a `search-session`.
9331
+ * @param {string} id The `search-session` ID.
9332
+ * @param {*} [options] Override http request option.
9333
+ * @throws {RequiredError}
9334
+ */
9335
+ getSearchSession(id, options) {
9336
+ return __awaiter(this, void 0, void 0, function* () {
9337
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getSearchSession(id, options);
9338
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
9339
+ });
9340
+ },
9341
+ };
9342
+ };
9343
+ /**
9344
+ * SearchSessionsApi - factory interface
9345
+ * @export
9346
+ */
9347
+ export const SearchSessionsApiFactory = function (configuration, basePath, axios) {
9348
+ const localVarFp = SearchSessionsApiFp(configuration);
9349
+ return {
9350
+ /**
9351
+ * Create a `search-session`.
9352
+ * @param {CreateSearchSessionRequest} createSearchSessionRequest
9353
+ * @param {*} [options] Override http request option.
9354
+ * @throws {RequiredError}
9355
+ */
9356
+ createSearchSession(createSearchSessionRequest, options) {
9357
+ return localVarFp
9358
+ .createSearchSession(createSearchSessionRequest, options)
9359
+ .then((request) => request(axios, basePath));
9360
+ },
9361
+ /**
9362
+ * Get a `search-session`.
9363
+ * @param {string} id The `search-session` ID.
9364
+ * @param {*} [options] Override http request option.
9365
+ * @throws {RequiredError}
9366
+ */
9367
+ getSearchSession(id, options) {
9368
+ return localVarFp
9369
+ .getSearchSession(id, options)
9370
+ .then((request) => request(axios, basePath));
9371
+ },
9372
+ };
9373
+ };
9374
+ /**
9375
+ * SearchSessionsApi - object-oriented interface
9376
+ * @export
9377
+ * @class SearchSessionsApi
9378
+ * @extends {BaseAPI}
9379
+ */
9380
+ export class SearchSessionsApi extends BaseAPI {
9381
+ /**
9382
+ * Create a `search-session`.
9383
+ * @param {SearchSessionsApiCreateSearchSessionRequest} requestParameters Request parameters.
9384
+ * @param {*} [options] Override http request option.
9385
+ * @throws {RequiredError}
9386
+ * @memberof SearchSessionsApi
9387
+ */
9388
+ createSearchSession(requestParameters, options) {
9389
+ return SearchSessionsApiFp(this.configuration)
9390
+ .createSearchSession(requestParameters.createSearchSessionRequest, options)
9391
+ .then((request) => request(this.axios, this.basePath));
9392
+ }
9393
+ /**
9394
+ * Get a `search-session`.
9395
+ * @param {SearchSessionsApiGetSearchSessionRequest} requestParameters Request parameters.
9396
+ * @param {*} [options] Override http request option.
9397
+ * @throws {RequiredError}
9398
+ * @memberof SearchSessionsApi
9399
+ */
9400
+ getSearchSession(requestParameters, options) {
9401
+ return SearchSessionsApiFp(this.configuration)
9402
+ .getSearchSession(requestParameters.id, options)
9403
+ .then((request) => request(this.axios, this.basePath));
9404
+ }
9405
+ }
8860
9406
  /**
8861
9407
  * StreamKeysApi - axios parameter creator
8862
9408
  * @export