@emilgroup/setting-sdk 0.3.1-beta.25 → 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.
@@ -45,21 +45,22 @@ export declare const SettingDefinitionsApiAxiosParamCreator: (configuration?: Co
45
45
  * @summary Retrieve the setting definition
46
46
  * @param {string} code
47
47
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
48
+ * @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>
48
49
  * @param {*} [options] Override http request option.
49
50
  * @throws {RequiredError}
50
51
  */
51
- getSettingDefinition: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
+ getSettingDefinition: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
52
53
  /**
53
- * 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\"
54
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
54
55
  * @summary List setting definitions
55
56
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
56
57
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
57
58
  * @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.
58
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
59
+ * @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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
59
60
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
60
- * @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.
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;
62
- * @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.
61
+ * @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, definitionKey, ownerService, scope, createdAt, updatedAt&lt;/i&gt;
62
+ * @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: versions&lt;i&gt;
63
+ * @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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
63
64
  * @param {*} [options] Override http request option.
64
65
  * @throws {RequiredError}
65
66
  */
@@ -93,21 +94,22 @@ export declare const SettingDefinitionsApiFp: (configuration?: Configuration) =>
93
94
  * @summary Retrieve the setting definition
94
95
  * @param {string} code
95
96
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
97
+ * @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: versions&lt;i&gt;
96
98
  * @param {*} [options] Override http request option.
97
99
  * @throws {RequiredError}
98
100
  */
99
- getSettingDefinition(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>>;
101
+ getSettingDefinition(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>>;
100
102
  /**
101
- * 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\"
103
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
102
104
  * @summary List setting definitions
103
105
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
104
106
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
105
107
  * @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.
106
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
108
+ * @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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
107
109
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
108
- * @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.
109
- * @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;
110
- * @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.
110
+ * @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, definitionKey, ownerService, scope, createdAt, updatedAt&lt;/i&gt;
111
+ * @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: versions&lt;i&gt;
112
+ * @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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
111
113
  * @param {*} [options] Override http request option.
112
114
  * @throws {RequiredError}
113
115
  */
@@ -141,21 +143,22 @@ export declare const SettingDefinitionsApiFactory: (configuration?: Configuratio
141
143
  * @summary Retrieve the setting definition
142
144
  * @param {string} code
143
145
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
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: versions&lt;i&gt;
144
147
  * @param {*} [options] Override http request option.
145
148
  * @throws {RequiredError}
146
149
  */
147
- getSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
150
+ getSettingDefinition(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
148
151
  /**
149
- * 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\"
152
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
150
153
  * @summary List setting definitions
151
154
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
152
155
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
153
156
  * @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.
154
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
157
+ * @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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
155
158
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
156
- * @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.
157
- * @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;
158
- * @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.
159
+ * @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, definitionKey, ownerService, scope, createdAt, updatedAt&lt;/i&gt;
160
+ * @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: versions&lt;i&gt;
161
+ * @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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
159
162
  * @param {*} [options] Override http request option.
160
163
  * @throws {RequiredError}
161
164
  */
@@ -217,6 +220,12 @@ export interface SettingDefinitionsApiGetSettingDefinitionRequest {
217
220
  * @memberof SettingDefinitionsApiGetSettingDefinition
218
221
  */
219
222
  readonly authorization?: string;
223
+ /**
224
+ * 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: versions&lt;i&gt;
225
+ * @type {string}
226
+ * @memberof SettingDefinitionsApiGetSettingDefinition
227
+ */
228
+ readonly expand?: string;
220
229
  }
221
230
  /**
222
231
  * Request parameters for listSettingDefinitions operation in SettingDefinitionsApi.
@@ -243,7 +252,7 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
243
252
  */
244
253
  readonly pageToken?: string;
245
254
  /**
246
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
255
+ * 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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
247
256
  * @type {string}
248
257
  * @memberof SettingDefinitionsApiListSettingDefinitions
249
258
  */
@@ -255,19 +264,19 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
255
264
  */
256
265
  readonly search?: string;
257
266
  /**
258
- * 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.
267
+ * 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, definitionKey, ownerService, scope, createdAt, updatedAt&lt;/i&gt;
259
268
  * @type {string}
260
269
  * @memberof SettingDefinitionsApiListSettingDefinitions
261
270
  */
262
271
  readonly order?: string;
263
272
  /**
264
- * 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;
273
+ * 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: versions&lt;i&gt;
265
274
  * @type {string}
266
275
  * @memberof SettingDefinitionsApiListSettingDefinitions
267
276
  */
268
277
  readonly expand?: string;
269
278
  /**
270
- * 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.
279
+ * 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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
271
280
  * @type {string}
272
281
  * @memberof SettingDefinitionsApiListSettingDefinitions
273
282
  */
@@ -308,7 +317,7 @@ export declare class SettingDefinitionsApi extends BaseAPI {
308
317
  */
309
318
  getSettingDefinition(requestParameters: SettingDefinitionsApiGetSettingDefinitionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettingDefinitionResponseClass, any, {}>>;
310
319
  /**
311
- * 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\"
320
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
312
321
  * @summary List setting definitions
313
322
  * @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
314
323
  * @param {*} [options] Override http request option.
@@ -194,10 +194,11 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
194
194
  * @summary Retrieve the setting definition
195
195
  * @param {string} code
196
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
197
198
  * @param {*} [options] Override http request option.
198
199
  * @throws {RequiredError}
199
200
  */
200
- getSettingDefinition: function (code, authorization, options) {
201
+ getSettingDefinition: function (code, authorization, expand, options) {
201
202
  if (options === void 0) { options = {}; }
202
203
  return __awaiter(_this, void 0, void 0, function () {
203
204
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -223,6 +224,9 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
223
224
  // authentication bearer required
224
225
  // http bearer authentication required
225
226
  _a.sent();
227
+ if (expand !== undefined) {
228
+ localVarQueryParameter['expand'] = expand;
229
+ }
226
230
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
227
231
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
228
232
  }
@@ -238,16 +242,16 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
238
242
  });
239
243
  },
240
244
  /**
241
- * 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\"
242
246
  * @summary List setting definitions
243
247
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
244
248
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
245
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
246
- * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
247
251
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
248
- * @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.
249
- * @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;
250
- * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
254
+ * @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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
251
255
  * @param {*} [options] Override http request option.
252
256
  * @throws {RequiredError}
253
257
  */
@@ -366,15 +370,16 @@ var SettingDefinitionsApiFp = function (configuration) {
366
370
  * @summary Retrieve the setting definition
367
371
  * @param {string} code
368
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
369
374
  * @param {*} [options] Override http request option.
370
375
  * @throws {RequiredError}
371
376
  */
372
- getSettingDefinition: function (code, authorization, options) {
377
+ getSettingDefinition: function (code, authorization, expand, options) {
373
378
  return __awaiter(this, void 0, void 0, function () {
374
379
  var localVarAxiosArgs;
375
380
  return __generator(this, function (_a) {
376
381
  switch (_a.label) {
377
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, options)];
382
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, expand, options)];
378
383
  case 1:
379
384
  localVarAxiosArgs = _a.sent();
380
385
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -383,16 +388,16 @@ var SettingDefinitionsApiFp = function (configuration) {
383
388
  });
384
389
  },
385
390
  /**
386
- * 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\"
387
392
  * @summary List setting definitions
388
393
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
389
394
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
390
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
391
- * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
392
397
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
393
- * @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.
394
- * @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;
395
- * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
400
+ * @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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
396
401
  * @param {*} [options] Override http request option.
397
402
  * @throws {RequiredError}
398
403
  */
@@ -446,23 +451,24 @@ var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
446
451
  * @summary Retrieve the setting definition
447
452
  * @param {string} code
448
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
449
455
  * @param {*} [options] Override http request option.
450
456
  * @throws {RequiredError}
451
457
  */
452
- getSettingDefinition: function (code, authorization, options) {
453
- 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); });
454
460
  },
455
461
  /**
456
- * 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\"
457
463
  * @summary List setting definitions
458
464
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
459
465
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
460
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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
461
- * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
462
468
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
463
- * @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.
464
- * @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;
465
- * @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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt&lt;/i&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: versions&lt;i&gt;
471
+ * @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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt&lt;/i&gt;
466
472
  * @param {*} [options] Override http request option.
467
473
  * @throws {RequiredError}
468
474
  */
@@ -517,10 +523,10 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
517
523
  */
518
524
  SettingDefinitionsApi.prototype.getSettingDefinition = function (requestParameters, options) {
519
525
  var _this = this;
520
- 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); });
521
527
  };
522
528
  /**
523
- * 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\"
524
530
  * @summary List setting definitions
525
531
  * @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
526
532
  * @param {*} [options] Override http request option.
@@ -47,7 +47,7 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
47
47
  * @param {string} code
48
48
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
49
49
  * @param {number} [version] Specific value version. Defaults to latest.
50
- * @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;
51
51
  * @param {*} [options] Override http request option.
52
52
  * @throws {RequiredError}
53
53
  */
@@ -58,22 +58,22 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
58
58
  * @param {string} slug
59
59
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
60
60
  * @param {number} [version] Specific value version. Defaults to latest.
61
- * @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;
62
62
  * @param {*} [options] Override http request option.
63
63
  * @throws {RequiredError}
64
64
  */
65
65
  getSettingKeyBySlug: (slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
66
66
  /**
67
- * 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\"
68
68
  * @summary List setting keys
69
69
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
70
70
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
71
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.
72
- * @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;
73
73
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
74
- * @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.
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;
76
- * @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;
77
77
  * @param {*} [options] Override http request option.
78
78
  * @throws {RequiredError}
79
79
  */
@@ -118,7 +118,7 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
118
118
  * @param {string} code
119
119
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
120
120
  * @param {number} [version] Specific value version. Defaults to latest.
121
- * @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;
122
122
  * @param {*} [options] Override http request option.
123
123
  * @throws {RequiredError}
124
124
  */
@@ -129,22 +129,22 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
129
129
  * @param {string} slug
130
130
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
131
131
  * @param {number} [version] Specific value version. Defaults to latest.
132
- * @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;
133
133
  * @param {*} [options] Override http request option.
134
134
  * @throws {RequiredError}
135
135
  */
136
136
  getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingKeyResponseClass>>;
137
137
  /**
138
- * 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\"
139
139
  * @summary List setting keys
140
140
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
141
141
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
142
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.
143
- * @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;
144
144
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
145
- * @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.
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;
147
- * @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;
148
148
  * @param {*} [options] Override http request option.
149
149
  * @throws {RequiredError}
150
150
  */
@@ -189,7 +189,7 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
189
189
  * @param {string} code
190
190
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
191
191
  * @param {number} [version] Specific value version. Defaults to latest.
192
- * @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;
193
193
  * @param {*} [options] Override http request option.
194
194
  * @throws {RequiredError}
195
195
  */
@@ -200,22 +200,22 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
200
200
  * @param {string} slug
201
201
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
202
202
  * @param {number} [version] Specific value version. Defaults to latest.
203
- * @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;
204
204
  * @param {*} [options] Override http request option.
205
205
  * @throws {RequiredError}
206
206
  */
207
207
  getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: any): AxiosPromise<GetSettingKeyResponseClass>;
208
208
  /**
209
- * 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\"
210
210
  * @summary List setting keys
211
211
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
212
212
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
213
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.
214
- * @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;
215
215
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
216
- * @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.
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;
218
- * @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;
219
219
  * @param {*} [options] Override http request option.
220
220
  * @throws {RequiredError}
221
221
  */
@@ -295,7 +295,7 @@ export interface SettingKeysApiGetSettingKeyRequest {
295
295
  */
296
296
  readonly version?: number;
297
297
  /**
298
- * 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;
299
299
  * @type {string}
300
300
  * @memberof SettingKeysApiGetSettingKey
301
301
  */
@@ -326,7 +326,7 @@ export interface SettingKeysApiGetSettingKeyBySlugRequest {
326
326
  */
327
327
  readonly version?: number;
328
328
  /**
329
- * 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;
330
330
  * @type {string}
331
331
  * @memberof SettingKeysApiGetSettingKeyBySlug
332
332
  */
@@ -357,7 +357,7 @@ export interface SettingKeysApiListSettingKeysRequest {
357
357
  */
358
358
  readonly pageToken?: string;
359
359
  /**
360
- * 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;
361
361
  * @type {string}
362
362
  * @memberof SettingKeysApiListSettingKeys
363
363
  */
@@ -369,19 +369,19 @@ export interface SettingKeysApiListSettingKeysRequest {
369
369
  */
370
370
  readonly search?: string;
371
371
  /**
372
- * 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;
373
373
  * @type {string}
374
374
  * @memberof SettingKeysApiListSettingKeys
375
375
  */
376
376
  readonly order?: string;
377
377
  /**
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;
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;
379
379
  * @type {string}
380
380
  * @memberof SettingKeysApiListSettingKeys
381
381
  */
382
382
  readonly expand?: string;
383
383
  /**
384
- * 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;
385
385
  * @type {string}
386
386
  * @memberof SettingKeysApiListSettingKeys
387
387
  */
@@ -461,7 +461,7 @@ export declare class SettingKeysApi extends BaseAPI {
461
461
  */
462
462
  getSettingKeyBySlug(requestParameters: SettingKeysApiGetSettingKeyBySlugRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettingKeyResponseClass, any, {}>>;
463
463
  /**
464
- * 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\"
465
465
  * @summary List setting keys
466
466
  * @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
467
467
  * @param {*} [options] Override http request option.