@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.
@@ -7,7 +7,6 @@ api/health-api.ts
7
7
  api/public-keys-api.ts
8
8
  api/setting-definitions-api.ts
9
9
  api/setting-keys-api.ts
10
- api/setting-values-api.ts
11
10
  base.ts
12
11
  common.ts
13
12
  configuration.ts
@@ -30,7 +29,6 @@ models/inline-response503.ts
30
29
  models/list-public-keys-response-class.ts
31
30
  models/list-setting-definitions-response-class.ts
32
31
  models/list-setting-keys-response-class.ts
33
- models/list-setting-values-response-class.ts
34
32
  models/public-key-class.ts
35
33
  models/rotate-public-key-response-class.ts
36
34
  models/setting-definition-class.ts
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/setting-sdk@0.3.1-beta.25 --save
20
+ npm install @emilgroup/setting-sdk@0.3.1-beta.26 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/setting-sdk@0.3.1-beta.25
24
+ yarn add @emilgroup/setting-sdk@0.3.1-beta.26
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -133,10 +133,11 @@ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?:
133
133
  * @summary Retrieve the setting definition
134
134
  * @param {string} code
135
135
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
136
+ * @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>
136
137
  * @param {*} [options] Override http request option.
137
138
  * @throws {RequiredError}
138
139
  */
139
- getSettingDefinition: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
140
+ getSettingDefinition: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
140
141
  // verify required parameter 'code' is not null or undefined
141
142
  assertParamExists('getSettingDefinition', 'code', code)
142
143
  const localVarPath = `/settingservice/v1/settings/definitions/{code}`
@@ -158,6 +159,10 @@ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?:
158
159
  // http bearer authentication required
159
160
  await setBearerAuthToObject(localVarHeaderParameter, configuration)
160
161
 
162
+ if (expand !== undefined) {
163
+ localVarQueryParameter['expand'] = expand;
164
+ }
165
+
161
166
  if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
162
167
  localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
163
168
  }
@@ -174,16 +179,16 @@ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?:
174
179
  };
175
180
  },
176
181
  /**
177
- * 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\"
182
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
178
183
  * @summary List setting definitions
179
184
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
180
185
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
181
186
  * @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.
182
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
187
+ * @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;
183
188
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
184
- * @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.
185
- * @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;
186
- * @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.
189
+ * @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;
190
+ * @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;
191
+ * @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;
187
192
  * @param {*} [options] Override http request option.
188
193
  * @throws {RequiredError}
189
194
  */
@@ -288,24 +293,25 @@ export const SettingDefinitionsApiFp = function(configuration?: Configuration) {
288
293
  * @summary Retrieve the setting definition
289
294
  * @param {string} code
290
295
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
296
+ * @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;
291
297
  * @param {*} [options] Override http request option.
292
298
  * @throws {RequiredError}
293
299
  */
294
- async getSettingDefinition(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>> {
295
- const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingDefinition(code, authorization, options);
300
+ async getSettingDefinition(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>> {
301
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingDefinition(code, authorization, expand, options);
296
302
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
297
303
  },
298
304
  /**
299
- * 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\"
305
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
300
306
  * @summary List setting definitions
301
307
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
302
308
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
303
309
  * @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.
304
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
310
+ * @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;
305
311
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
306
- * @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.
307
- * @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;
308
- * @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.
312
+ * @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;
313
+ * @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;
314
+ * @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;
309
315
  * @param {*} [options] Override http request option.
310
316
  * @throws {RequiredError}
311
317
  */
@@ -350,23 +356,24 @@ export const SettingDefinitionsApiFactory = function (configuration?: Configurat
350
356
  * @summary Retrieve the setting definition
351
357
  * @param {string} code
352
358
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
359
+ * @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;
353
360
  * @param {*} [options] Override http request option.
354
361
  * @throws {RequiredError}
355
362
  */
356
- getSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass> {
357
- return localVarFp.getSettingDefinition(code, authorization, options).then((request) => request(axios, basePath));
363
+ getSettingDefinition(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass> {
364
+ return localVarFp.getSettingDefinition(code, authorization, expand, options).then((request) => request(axios, basePath));
358
365
  },
359
366
  /**
360
- * 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\"
367
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
361
368
  * @summary List setting definitions
362
369
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
363
370
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
364
371
  * @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.
365
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
372
+ * @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;
366
373
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
367
- * @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.
368
- * @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;
369
- * @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.
374
+ * @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;
375
+ * @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;
376
+ * @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;
370
377
  * @param {*} [options] Override http request option.
371
378
  * @throws {RequiredError}
372
379
  */
@@ -437,6 +444,13 @@ export interface SettingDefinitionsApiGetSettingDefinitionRequest {
437
444
  * @memberof SettingDefinitionsApiGetSettingDefinition
438
445
  */
439
446
  readonly authorization?: string
447
+
448
+ /**
449
+ * 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;
450
+ * @type {string}
451
+ * @memberof SettingDefinitionsApiGetSettingDefinition
452
+ */
453
+ readonly expand?: string
440
454
  }
441
455
 
442
456
  /**
@@ -467,7 +481,7 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
467
481
  readonly pageToken?: string
468
482
 
469
483
  /**
470
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
484
+ * 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;
471
485
  * @type {string}
472
486
  * @memberof SettingDefinitionsApiListSettingDefinitions
473
487
  */
@@ -481,21 +495,21 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
481
495
  readonly search?: string
482
496
 
483
497
  /**
484
- * 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.
498
+ * 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;
485
499
  * @type {string}
486
500
  * @memberof SettingDefinitionsApiListSettingDefinitions
487
501
  */
488
502
  readonly order?: string
489
503
 
490
504
  /**
491
- * 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;
505
+ * 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;
492
506
  * @type {string}
493
507
  * @memberof SettingDefinitionsApiListSettingDefinitions
494
508
  */
495
509
  readonly expand?: string
496
510
 
497
511
  /**
498
- * 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.
512
+ * 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;
499
513
  * @type {string}
500
514
  * @memberof SettingDefinitionsApiListSettingDefinitions
501
515
  */
@@ -542,11 +556,11 @@ export class SettingDefinitionsApi extends BaseAPI {
542
556
  * @memberof SettingDefinitionsApi
543
557
  */
544
558
  public getSettingDefinition(requestParameters: SettingDefinitionsApiGetSettingDefinitionRequest, options?: AxiosRequestConfig) {
545
- return SettingDefinitionsApiFp(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
559
+ return SettingDefinitionsApiFp(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
546
560
  }
547
561
 
548
562
  /**
549
- * 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\"
563
+ * List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
550
564
  * @summary List setting definitions
551
565
  * @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
552
566
  * @param {*} [options] Override http request option.
@@ -137,7 +137,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
137
137
  * @param {string} code
138
138
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
139
139
  * @param {number} [version] Specific value version. Defaults to latest.
140
- * @param {string} [expand] Optional expand (definition only).
140
+ * @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;
141
141
  * @param {*} [options] Override http request option.
142
142
  * @throws {RequiredError}
143
143
  */
@@ -192,7 +192,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
192
192
  * @param {string} slug
193
193
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
194
194
  * @param {number} [version] Specific value version. Defaults to latest.
195
- * @param {string} [expand] Optional expand (definition only).
195
+ * @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
196
  * @param {*} [options] Override http request option.
197
197
  * @throws {RequiredError}
198
198
  */
@@ -242,16 +242,16 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
242
242
  };
243
243
  },
244
244
  /**
245
- * 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\"
245
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
246
246
  * @summary List setting keys
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&#x3D;1, your subsequent call can include pageToken&#x3D;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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
251
251
  * @param {string} [search] To search the list by any field, pass search&#x3D;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.&lt;br/&gt; &lt;br/&gt;
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.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, 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: definition, values&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, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode&lt;/i&gt;
255
255
  * @param {*} [options] Override http request option.
256
256
  * @throws {RequiredError}
257
257
  */
@@ -414,7 +414,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
414
414
  * @param {string} code
415
415
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
416
416
  * @param {number} [version] Specific value version. Defaults to latest.
417
- * @param {string} [expand] Optional expand (definition only).
417
+ * @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;
418
418
  * @param {*} [options] Override http request option.
419
419
  * @throws {RequiredError}
420
420
  */
@@ -428,7 +428,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
428
428
  * @param {string} slug
429
429
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
430
430
  * @param {number} [version] Specific value version. Defaults to latest.
431
- * @param {string} [expand] Optional expand (definition only).
431
+ * @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;
432
432
  * @param {*} [options] Override http request option.
433
433
  * @throws {RequiredError}
434
434
  */
@@ -437,16 +437,16 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
437
437
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
438
438
  },
439
439
  /**
440
- * 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\"
440
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
441
441
  * @summary List setting keys
442
442
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
443
443
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
444
444
  * @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.
445
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
445
+ * @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;
446
446
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
447
- * @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.
448
- * @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;
449
- * @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.
447
+ * @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;
448
+ * @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;
449
+ * @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;
450
450
  * @param {*} [options] Override http request option.
451
451
  * @throws {RequiredError}
452
452
  */
@@ -505,7 +505,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
505
505
  * @param {string} code
506
506
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
507
507
  * @param {number} [version] Specific value version. Defaults to latest.
508
- * @param {string} [expand] Optional expand (definition only).
508
+ * @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;
509
509
  * @param {*} [options] Override http request option.
510
510
  * @throws {RequiredError}
511
511
  */
@@ -518,7 +518,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
518
518
  * @param {string} slug
519
519
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
520
520
  * @param {number} [version] Specific value version. Defaults to latest.
521
- * @param {string} [expand] Optional expand (definition only).
521
+ * @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;
522
522
  * @param {*} [options] Override http request option.
523
523
  * @throws {RequiredError}
524
524
  */
@@ -526,16 +526,16 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
526
526
  return localVarFp.getSettingKeyBySlug(slug, authorization, version, expand, options).then((request) => request(axios, basePath));
527
527
  },
528
528
  /**
529
- * 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\"
529
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
530
530
  * @summary List setting keys
531
531
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
532
532
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
533
533
  * @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.
534
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
534
+ * @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;
535
535
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
536
- * @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.
537
- * @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;
538
- * @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.
536
+ * @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;
537
+ * @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;
538
+ * @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;
539
539
  * @param {*} [options] Override http request option.
540
540
  * @throws {RequiredError}
541
541
  */
@@ -628,7 +628,7 @@ export interface SettingKeysApiGetSettingKeyRequest {
628
628
  readonly version?: number
629
629
 
630
630
  /**
631
- * Optional expand (definition only).
631
+ * 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;
632
632
  * @type {string}
633
633
  * @memberof SettingKeysApiGetSettingKey
634
634
  */
@@ -663,7 +663,7 @@ export interface SettingKeysApiGetSettingKeyBySlugRequest {
663
663
  readonly version?: number
664
664
 
665
665
  /**
666
- * Optional expand (definition only).
666
+ * 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;
667
667
  * @type {string}
668
668
  * @memberof SettingKeysApiGetSettingKeyBySlug
669
669
  */
@@ -698,7 +698,7 @@ export interface SettingKeysApiListSettingKeysRequest {
698
698
  readonly pageToken?: string
699
699
 
700
700
  /**
701
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
701
+ * 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;
702
702
  * @type {string}
703
703
  * @memberof SettingKeysApiListSettingKeys
704
704
  */
@@ -712,21 +712,21 @@ export interface SettingKeysApiListSettingKeysRequest {
712
712
  readonly search?: string
713
713
 
714
714
  /**
715
- * 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.
715
+ * 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;
716
716
  * @type {string}
717
717
  * @memberof SettingKeysApiListSettingKeys
718
718
  */
719
719
  readonly order?: string
720
720
 
721
721
  /**
722
- * 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;
722
+ * 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;
723
723
  * @type {string}
724
724
  * @memberof SettingKeysApiListSettingKeys
725
725
  */
726
726
  readonly expand?: string
727
727
 
728
728
  /**
729
- * 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.
729
+ * 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;
730
730
  * @type {string}
731
731
  * @memberof SettingKeysApiListSettingKeys
732
732
  */
@@ -823,7 +823,7 @@ export class SettingKeysApi extends BaseAPI {
823
823
  }
824
824
 
825
825
  /**
826
- * 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\"
826
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
827
827
  * @summary List setting keys
828
828
  * @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
829
829
  * @param {*} [options] Override http request option.
package/api.ts CHANGED
@@ -24,12 +24,10 @@ import { HealthApi } from './api';
24
24
  import { PublicKeysApi } from './api';
25
25
  import { SettingDefinitionsApi } from './api';
26
26
  import { SettingKeysApi } from './api';
27
- import { SettingValuesApi } from './api';
28
27
 
29
28
 
30
29
  export * from './api/health-api';
31
30
  export * from './api/public-keys-api';
32
31
  export * from './api/setting-definitions-api';
33
32
  export * from './api/setting-keys-api';
34
- export * from './api/setting-values-api';
35
33