@emilgroup/setting-sdk 0.3.1-beta.24 → 0.3.1-beta.26

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.
@@ -144,13 +144,12 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
144
144
  /**
145
145
  * Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
146
146
  * @summary Delete the setting definition
147
- * @param {string} code
148
- * @param {any} settingDefinition Unique identifier for the object.
147
+ * @param {string} code Unique identifier for the object.
149
148
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
149
  * @param {*} [options] Override http request option.
151
150
  * @throws {RequiredError}
152
151
  */
153
- deleteSettingDefinition: function (code, settingDefinition, authorization, options) {
152
+ deleteSettingDefinition: function (code, authorization, options) {
154
153
  if (options === void 0) { options = {}; }
155
154
  return __awaiter(_this, void 0, void 0, function () {
156
155
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -159,11 +158,8 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
159
158
  case 0:
160
159
  // verify required parameter 'code' is not null or undefined
161
160
  (0, common_1.assertParamExists)('deleteSettingDefinition', 'code', code);
162
- // verify required parameter 'settingDefinition' is not null or undefined
163
- (0, common_1.assertParamExists)('deleteSettingDefinition', 'settingDefinition', settingDefinition);
164
161
  localVarPath = "/settingservice/v1/settings/definitions/{code}"
165
- .replace("{".concat("code", "}"), encodeURIComponent(String(code)))
166
- .replace("{".concat("setting definition", "}"), encodeURIComponent(String(settingDefinition)));
162
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
167
163
  localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
168
164
  if (configuration) {
169
165
  baseOptions = configuration.baseOptions;
@@ -198,10 +194,11 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
198
194
  * @summary Retrieve the setting definition
199
195
  * @param {string} code
200
196
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
197
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions<i>
201
198
  * @param {*} [options] Override http request option.
202
199
  * @throws {RequiredError}
203
200
  */
204
- getSettingDefinition: function (code, authorization, options) {
201
+ getSettingDefinition: function (code, authorization, expand, options) {
205
202
  if (options === void 0) { options = {}; }
206
203
  return __awaiter(_this, void 0, void 0, function () {
207
204
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -227,6 +224,9 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
227
224
  // authentication bearer required
228
225
  // http bearer authentication required
229
226
  _a.sent();
227
+ if (expand !== undefined) {
228
+ localVarQueryParameter['expand'] = expand;
229
+ }
230
230
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
231
231
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
232
232
  }
@@ -242,16 +242,16 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
242
242
  });
243
243
  },
244
244
  /**
245
- * Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
245
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
246
246
  * @summary List setting definitions
247
247
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
248
248
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
249
249
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
250
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
250
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
251
251
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
252
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
253
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
254
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
252
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
253
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions<i>
254
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
255
255
  * @param {*} [options] Override http request option.
256
256
  * @throws {RequiredError}
257
257
  */
@@ -347,18 +347,17 @@ var SettingDefinitionsApiFp = function (configuration) {
347
347
  /**
348
348
  * Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
349
349
  * @summary Delete the setting definition
350
- * @param {string} code
351
- * @param {any} settingDefinition Unique identifier for the object.
350
+ * @param {string} code Unique identifier for the object.
352
351
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
353
352
  * @param {*} [options] Override http request option.
354
353
  * @throws {RequiredError}
355
354
  */
356
- deleteSettingDefinition: function (code, settingDefinition, authorization, options) {
355
+ deleteSettingDefinition: function (code, authorization, options) {
357
356
  return __awaiter(this, void 0, void 0, function () {
358
357
  var localVarAxiosArgs;
359
358
  return __generator(this, function (_a) {
360
359
  switch (_a.label) {
361
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingDefinition(code, settingDefinition, authorization, options)];
360
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingDefinition(code, authorization, options)];
362
361
  case 1:
363
362
  localVarAxiosArgs = _a.sent();
364
363
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -371,15 +370,16 @@ var SettingDefinitionsApiFp = function (configuration) {
371
370
  * @summary Retrieve the setting definition
372
371
  * @param {string} code
373
372
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
373
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions<i>
374
374
  * @param {*} [options] Override http request option.
375
375
  * @throws {RequiredError}
376
376
  */
377
- getSettingDefinition: function (code, authorization, options) {
377
+ getSettingDefinition: function (code, authorization, expand, options) {
378
378
  return __awaiter(this, void 0, void 0, function () {
379
379
  var localVarAxiosArgs;
380
380
  return __generator(this, function (_a) {
381
381
  switch (_a.label) {
382
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, options)];
382
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, expand, options)];
383
383
  case 1:
384
384
  localVarAxiosArgs = _a.sent();
385
385
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -388,16 +388,16 @@ var SettingDefinitionsApiFp = function (configuration) {
388
388
  });
389
389
  },
390
390
  /**
391
- * Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
391
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
392
392
  * @summary List setting definitions
393
393
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
394
394
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
395
395
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
396
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
396
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
397
397
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
398
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
399
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
400
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
398
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
399
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions<i>
400
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
401
401
  * @param {*} [options] Override http request option.
402
402
  * @throws {RequiredError}
403
403
  */
@@ -438,37 +438,37 @@ var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
438
438
  /**
439
439
  * Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
440
440
  * @summary Delete the setting definition
441
- * @param {string} code
442
- * @param {any} settingDefinition Unique identifier for the object.
441
+ * @param {string} code Unique identifier for the object.
443
442
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
444
443
  * @param {*} [options] Override http request option.
445
444
  * @throws {RequiredError}
446
445
  */
447
- deleteSettingDefinition: function (code, settingDefinition, authorization, options) {
448
- return localVarFp.deleteSettingDefinition(code, settingDefinition, authorization, options).then(function (request) { return request(axios, basePath); });
446
+ deleteSettingDefinition: function (code, authorization, options) {
447
+ return localVarFp.deleteSettingDefinition(code, authorization, options).then(function (request) { return request(axios, basePath); });
449
448
  },
450
449
  /**
451
450
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
452
451
  * @summary Retrieve the setting definition
453
452
  * @param {string} code
454
453
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
454
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions<i>
455
455
  * @param {*} [options] Override http request option.
456
456
  * @throws {RequiredError}
457
457
  */
458
- getSettingDefinition: function (code, authorization, options) {
459
- return localVarFp.getSettingDefinition(code, authorization, options).then(function (request) { return request(axios, basePath); });
458
+ getSettingDefinition: function (code, authorization, expand, options) {
459
+ return localVarFp.getSettingDefinition(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
460
460
  },
461
461
  /**
462
- * Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
462
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
463
463
  * @summary List setting definitions
464
464
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
465
465
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
466
466
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
467
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
467
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
468
468
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
469
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
470
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
471
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
469
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
470
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: versions<i>
471
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
472
472
  * @param {*} [options] Override http request option.
473
473
  * @throws {RequiredError}
474
474
  */
@@ -511,7 +511,7 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
511
511
  */
512
512
  SettingDefinitionsApi.prototype.deleteSettingDefinition = function (requestParameters, options) {
513
513
  var _this = this;
514
- return (0, exports.SettingDefinitionsApiFp)(this.configuration).deleteSettingDefinition(requestParameters.code, requestParameters.settingDefinition, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
514
+ return (0, exports.SettingDefinitionsApiFp)(this.configuration).deleteSettingDefinition(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
515
515
  };
516
516
  /**
517
517
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
@@ -523,10 +523,10 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
523
523
  */
524
524
  SettingDefinitionsApi.prototype.getSettingDefinition = function (requestParameters, options) {
525
525
  var _this = this;
526
- return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
526
+ return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
527
527
  };
528
528
  /**
529
- * Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
529
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
530
530
  * @summary List setting definitions
531
531
  * @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
532
532
  * @param {*} [options] Override http request option.
@@ -36,19 +36,18 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
36
36
  /**
37
37
  * undefined **Required Permissions** \"tenant-management.settings.delete\"
38
38
  * @param {string} code
39
- * @param {string} ifMatch
40
39
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
41
40
  * @param {*} [options] Override http request option.
42
41
  * @throws {RequiredError}
43
42
  */
44
- deleteSettingKey: (code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43
+ deleteSettingKey: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
44
  /**
46
45
  * Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
47
46
  * @summary Retrieve the setting key
48
47
  * @param {string} code
49
48
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
50
49
  * @param {number} [version] Specific value version. Defaults to latest.
51
- * @param {string} [expand] Optional expand (definition only).
50
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
52
51
  * @param {*} [options] Override http request option.
53
52
  * @throws {RequiredError}
54
53
  */
@@ -59,22 +58,22 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
59
58
  * @param {string} slug
60
59
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
61
60
  * @param {number} [version] Specific value version. Defaults to latest.
62
- * @param {string} [expand] Optional expand (definition only).
61
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
63
62
  * @param {*} [options] Override http request option.
64
63
  * @throws {RequiredError}
65
64
  */
66
65
  getSettingKeyBySlug: (slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
67
66
  /**
68
- * Returns a list of setting keys you have previously created. The setting keys are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
67
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
69
68
  * @summary List setting keys
70
69
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
71
70
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
72
71
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
73
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
72
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
74
73
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
75
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
76
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
77
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
74
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt&lt;/i&gt;
75
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
76
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
78
77
  * @param {*} [options] Override http request option.
79
78
  * @throws {RequiredError}
80
79
  */
@@ -83,7 +82,7 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
83
82
  * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
84
83
  * @summary Update the setting key
85
84
  * @param {string} code
86
- * @param {string} ifMatch
85
+ * @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
87
86
  * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
88
87
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
88
  * @param {*} [options] Override http request option.
@@ -108,19 +107,18 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
108
107
  /**
109
108
  * undefined **Required Permissions** \"tenant-management.settings.delete\"
110
109
  * @param {string} code
111
- * @param {string} ifMatch
112
110
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
113
111
  * @param {*} [options] Override http request option.
114
112
  * @throws {RequiredError}
115
113
  */
116
- deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
114
+ deleteSettingKey(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
117
115
  /**
118
116
  * Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
119
117
  * @summary Retrieve the setting key
120
118
  * @param {string} code
121
119
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
122
120
  * @param {number} [version] Specific value version. Defaults to latest.
123
- * @param {string} [expand] Optional expand (definition only).
121
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
124
122
  * @param {*} [options] Override http request option.
125
123
  * @throws {RequiredError}
126
124
  */
@@ -131,22 +129,22 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
131
129
  * @param {string} slug
132
130
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
131
  * @param {number} [version] Specific value version. Defaults to latest.
134
- * @param {string} [expand] Optional expand (definition only).
132
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
135
133
  * @param {*} [options] Override http request option.
136
134
  * @throws {RequiredError}
137
135
  */
138
136
  getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingKeyResponseClass>>;
139
137
  /**
140
- * Returns a list of setting keys you have previously created. The setting keys are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
138
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
141
139
  * @summary List setting keys
142
140
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
143
141
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
144
142
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
145
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
143
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
146
144
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
147
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
148
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
149
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
145
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt&lt;/i&gt;
146
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
147
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
150
148
  * @param {*} [options] Override http request option.
151
149
  * @throws {RequiredError}
152
150
  */
@@ -155,7 +153,7 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
155
153
  * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
156
154
  * @summary Update the setting key
157
155
  * @param {string} code
158
- * @param {string} ifMatch
156
+ * @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
159
157
  * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
160
158
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
161
159
  * @param {*} [options] Override http request option.
@@ -180,19 +178,18 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
180
178
  /**
181
179
  * undefined **Required Permissions** \"tenant-management.settings.delete\"
182
180
  * @param {string} code
183
- * @param {string} ifMatch
184
181
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
185
182
  * @param {*} [options] Override http request option.
186
183
  * @throws {RequiredError}
187
184
  */
188
- deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
185
+ deleteSettingKey(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
189
186
  /**
190
187
  * Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
191
188
  * @summary Retrieve the setting key
192
189
  * @param {string} code
193
190
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
194
191
  * @param {number} [version] Specific value version. Defaults to latest.
195
- * @param {string} [expand] Optional expand (definition only).
192
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
196
193
  * @param {*} [options] Override http request option.
197
194
  * @throws {RequiredError}
198
195
  */
@@ -203,22 +200,22 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
203
200
  * @param {string} slug
204
201
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
205
202
  * @param {number} [version] Specific value version. Defaults to latest.
206
- * @param {string} [expand] Optional expand (definition only).
203
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
207
204
  * @param {*} [options] Override http request option.
208
205
  * @throws {RequiredError}
209
206
  */
210
207
  getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: any): AxiosPromise<GetSettingKeyResponseClass>;
211
208
  /**
212
- * Returns a list of setting keys you have previously created. The setting keys are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
209
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
213
210
  * @summary List setting keys
214
211
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
215
212
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
216
213
  * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
217
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
214
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
218
215
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
219
- * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
220
- * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
221
- * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
216
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt&lt;/i&gt;
217
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
218
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
222
219
  * @param {*} [options] Override http request option.
223
220
  * @throws {RequiredError}
224
221
  */
@@ -227,7 +224,7 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
227
224
  * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
228
225
  * @summary Update the setting key
229
226
  * @param {string} code
230
- * @param {string} ifMatch
227
+ * @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
231
228
  * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
232
229
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
233
230
  * @param {*} [options] Override http request option.
@@ -266,12 +263,6 @@ export interface SettingKeysApiDeleteSettingKeyRequest {
266
263
  * @memberof SettingKeysApiDeleteSettingKey
267
264
  */
268
265
  readonly code: string;
269
- /**
270
- *
271
- * @type {string}
272
- * @memberof SettingKeysApiDeleteSettingKey
273
- */
274
- readonly ifMatch: string;
275
266
  /**
276
267
  * Bearer Token: provided by the login endpoint under the name accessToken.
277
268
  * @type {string}
@@ -304,7 +295,7 @@ export interface SettingKeysApiGetSettingKeyRequest {
304
295
  */
305
296
  readonly version?: number;
306
297
  /**
307
- * Optional expand (definition only).
298
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
308
299
  * @type {string}
309
300
  * @memberof SettingKeysApiGetSettingKey
310
301
  */
@@ -335,7 +326,7 @@ export interface SettingKeysApiGetSettingKeyBySlugRequest {
335
326
  */
336
327
  readonly version?: number;
337
328
  /**
338
- * Optional expand (definition only).
329
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
339
330
  * @type {string}
340
331
  * @memberof SettingKeysApiGetSettingKeyBySlug
341
332
  */
@@ -366,7 +357,7 @@ export interface SettingKeysApiListSettingKeysRequest {
366
357
  */
367
358
  readonly pageToken?: string;
368
359
  /**
369
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
360
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
370
361
  * @type {string}
371
362
  * @memberof SettingKeysApiListSettingKeys
372
363
  */
@@ -378,19 +369,19 @@ export interface SettingKeysApiListSettingKeysRequest {
378
369
  */
379
370
  readonly search?: string;
380
371
  /**
381
- * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
372
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt&lt;/i&gt;
382
373
  * @type {string}
383
374
  * @memberof SettingKeysApiListSettingKeys
384
375
  */
385
376
  readonly order?: string;
386
377
  /**
387
- * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
378
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: definition, values&lt;i&gt;
388
379
  * @type {string}
389
380
  * @memberof SettingKeysApiListSettingKeys
390
381
  */
391
382
  readonly expand?: string;
392
383
  /**
393
- * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
384
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
394
385
  * @type {string}
395
386
  * @memberof SettingKeysApiListSettingKeys
396
387
  */
@@ -409,7 +400,7 @@ export interface SettingKeysApiUpdateSettingKeyRequest {
409
400
  */
410
401
  readonly code: string;
411
402
  /**
412
- *
403
+ * ETag of the latest setting value. Required to prevent lost updates.
413
404
  * @type {string}
414
405
  * @memberof SettingKeysApiUpdateSettingKey
415
406
  */
@@ -470,7 +461,7 @@ export declare class SettingKeysApi extends BaseAPI {
470
461
  */
471
462
  getSettingKeyBySlug(requestParameters: SettingKeysApiGetSettingKeyBySlugRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettingKeyResponseClass, any, {}>>;
472
463
  /**
473
- * Returns a list of setting keys you have previously created. The setting keys are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
464
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
474
465
  * @summary List setting keys
475
466
  * @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
476
467
  * @param {*} [options] Override http request option.