@emilgroup/setting-sdk-node 0.3.1-beta.24 → 0.3.1-beta.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -2
- package/README.md +2 -2
- package/api/setting-definitions-api.ts +40 -26
- package/api/setting-keys-api.ts +28 -28
- package/api.ts +0 -2
- package/dist/api/setting-definitions-api.d.ts +32 -23
- package/dist/api/setting-definitions-api.js +28 -22
- package/dist/api/setting-keys-api.d.ts +28 -28
- package/dist/api/setting-keys-api.js +22 -22
- package/dist/api.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/models/setting-key-class.d.ts +1 -1
- package/models/index.ts +0 -1
- package/models/setting-key-class.ts +1 -1
- package/package.json +1 -1
- package/api/setting-values-api.ts +0 -250
- package/dist/api/setting-values-api.d.ts +0 -150
- package/dist/api/setting-values-api.js +0 -264
- package/dist/models/list-setting-values-response-class.d.ts +0 -43
- package/dist/models/list-setting-values-response-class.js +0 -15
- package/models/list-setting-values-response-class.ts +0 -49
package/.openapi-generator/FILES
CHANGED
|
@@ -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-node@0.3.1-beta.
|
|
20
|
+
npm install @emilgroup/setting-sdk-node@0.3.1-beta.25 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/setting-sdk-node@0.3.1-beta.
|
|
24
|
+
yarn add @emilgroup/setting-sdk-node@0.3.1-beta.25
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -137,10 +137,11 @@ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?:
|
|
|
137
137
|
* @summary Retrieve the setting definition
|
|
138
138
|
* @param {string} code
|
|
139
139
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
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.<br/> <br/> <i>Allowed values: versions<i>
|
|
140
141
|
* @param {*} [options] Override http request option.
|
|
141
142
|
* @throws {RequiredError}
|
|
142
143
|
*/
|
|
143
|
-
getSettingDefinition: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
144
|
+
getSettingDefinition: async (code: string, authorization?: string, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
144
145
|
// verify required parameter 'code' is not null or undefined
|
|
145
146
|
assertParamExists('getSettingDefinition', 'code', code)
|
|
146
147
|
const localVarPath = `/settingservice/v1/settings/definitions/{code}`
|
|
@@ -162,6 +163,10 @@ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?:
|
|
|
162
163
|
// http bearer authentication required
|
|
163
164
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
164
165
|
|
|
166
|
+
if (expand !== undefined) {
|
|
167
|
+
localVarQueryParameter['expand'] = expand;
|
|
168
|
+
}
|
|
169
|
+
|
|
165
170
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
166
171
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
167
172
|
}
|
|
@@ -178,16 +183,16 @@ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?:
|
|
|
178
183
|
};
|
|
179
184
|
},
|
|
180
185
|
/**
|
|
181
|
-
*
|
|
186
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
182
187
|
* @summary List setting definitions
|
|
183
188
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
184
189
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
185
190
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
186
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
191
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
187
192
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
188
|
-
* @param {string} [order]
|
|
189
|
-
* @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/>
|
|
190
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
193
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
|
|
194
|
+
* @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>
|
|
195
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
191
196
|
* @param {*} [options] Override http request option.
|
|
192
197
|
* @throws {RequiredError}
|
|
193
198
|
*/
|
|
@@ -292,24 +297,25 @@ export const SettingDefinitionsApiFp = function(configuration?: Configuration) {
|
|
|
292
297
|
* @summary Retrieve the setting definition
|
|
293
298
|
* @param {string} code
|
|
294
299
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
300
|
+
* @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>
|
|
295
301
|
* @param {*} [options] Override http request option.
|
|
296
302
|
* @throws {RequiredError}
|
|
297
303
|
*/
|
|
298
|
-
async getSettingDefinition(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>> {
|
|
299
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingDefinition(code, authorization, options);
|
|
304
|
+
async getSettingDefinition(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>> {
|
|
305
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingDefinition(code, authorization, expand, options);
|
|
300
306
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
301
307
|
},
|
|
302
308
|
/**
|
|
303
|
-
*
|
|
309
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
304
310
|
* @summary List setting definitions
|
|
305
311
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
306
312
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
307
313
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
308
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
314
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
309
315
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
310
|
-
* @param {string} [order]
|
|
311
|
-
* @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/>
|
|
312
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
316
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
|
|
317
|
+
* @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>
|
|
318
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
313
319
|
* @param {*} [options] Override http request option.
|
|
314
320
|
* @throws {RequiredError}
|
|
315
321
|
*/
|
|
@@ -354,23 +360,24 @@ export const SettingDefinitionsApiFactory = function (configuration?: Configurat
|
|
|
354
360
|
* @summary Retrieve the setting definition
|
|
355
361
|
* @param {string} code
|
|
356
362
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
363
|
+
* @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>
|
|
357
364
|
* @param {*} [options] Override http request option.
|
|
358
365
|
* @throws {RequiredError}
|
|
359
366
|
*/
|
|
360
|
-
getSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass> {
|
|
361
|
-
return localVarFp.getSettingDefinition(code, authorization, options).then((request) => request(axios, basePath));
|
|
367
|
+
getSettingDefinition(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass> {
|
|
368
|
+
return localVarFp.getSettingDefinition(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
362
369
|
},
|
|
363
370
|
/**
|
|
364
|
-
*
|
|
371
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
365
372
|
* @summary List setting definitions
|
|
366
373
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
367
374
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
368
375
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
369
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
376
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
370
377
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
371
|
-
* @param {string} [order]
|
|
372
|
-
* @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/>
|
|
373
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
378
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
|
|
379
|
+
* @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>
|
|
380
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
374
381
|
* @param {*} [options] Override http request option.
|
|
375
382
|
* @throws {RequiredError}
|
|
376
383
|
*/
|
|
@@ -441,6 +448,13 @@ export interface SettingDefinitionsApiGetSettingDefinitionRequest {
|
|
|
441
448
|
* @memberof SettingDefinitionsApiGetSettingDefinition
|
|
442
449
|
*/
|
|
443
450
|
readonly authorization?: string
|
|
451
|
+
|
|
452
|
+
/**
|
|
453
|
+
* 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>
|
|
454
|
+
* @type {string}
|
|
455
|
+
* @memberof SettingDefinitionsApiGetSettingDefinition
|
|
456
|
+
*/
|
|
457
|
+
readonly expand?: string
|
|
444
458
|
}
|
|
445
459
|
|
|
446
460
|
/**
|
|
@@ -471,7 +485,7 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
|
|
|
471
485
|
readonly pageToken?: string
|
|
472
486
|
|
|
473
487
|
/**
|
|
474
|
-
* Filter the response by one or multiple fields.
|
|
488
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
475
489
|
* @type {string}
|
|
476
490
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
477
491
|
*/
|
|
@@ -485,21 +499,21 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
|
|
|
485
499
|
readonly search?: string
|
|
486
500
|
|
|
487
501
|
/**
|
|
488
|
-
*
|
|
502
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
|
|
489
503
|
* @type {string}
|
|
490
504
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
491
505
|
*/
|
|
492
506
|
readonly order?: string
|
|
493
507
|
|
|
494
508
|
/**
|
|
495
|
-
* 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/>
|
|
509
|
+
* 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>
|
|
496
510
|
* @type {string}
|
|
497
511
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
498
512
|
*/
|
|
499
513
|
readonly expand?: string
|
|
500
514
|
|
|
501
515
|
/**
|
|
502
|
-
* Filters the response by one or multiple fields.
|
|
516
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
503
517
|
* @type {string}
|
|
504
518
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
505
519
|
*/
|
|
@@ -546,11 +560,11 @@ export class SettingDefinitionsApi extends BaseAPI {
|
|
|
546
560
|
* @memberof SettingDefinitionsApi
|
|
547
561
|
*/
|
|
548
562
|
public getSettingDefinition(requestParameters: SettingDefinitionsApiGetSettingDefinitionRequest, options?: AxiosRequestConfig) {
|
|
549
|
-
return SettingDefinitionsApiFp(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
563
|
+
return SettingDefinitionsApiFp(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
|
|
550
564
|
}
|
|
551
565
|
|
|
552
566
|
/**
|
|
553
|
-
*
|
|
567
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
554
568
|
* @summary List setting definitions
|
|
555
569
|
* @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
|
|
556
570
|
* @param {*} [options] Override http request option.
|
package/api/setting-keys-api.ts
CHANGED
|
@@ -141,7 +141,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
141
141
|
* @param {string} code
|
|
142
142
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
143
143
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
144
|
-
* @param {string} [expand]
|
|
144
|
+
* @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: definition, values<i>
|
|
145
145
|
* @param {*} [options] Override http request option.
|
|
146
146
|
* @throws {RequiredError}
|
|
147
147
|
*/
|
|
@@ -196,7 +196,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
196
196
|
* @param {string} slug
|
|
197
197
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
198
198
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
199
|
-
* @param {string} [expand]
|
|
199
|
+
* @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: definition, values<i>
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
202
202
|
*/
|
|
@@ -246,16 +246,16 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
246
246
|
};
|
|
247
247
|
},
|
|
248
248
|
/**
|
|
249
|
-
*
|
|
249
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
250
250
|
* @summary List setting keys
|
|
251
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
252
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
253
253
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
254
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
254
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
255
255
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
256
|
-
* @param {string} [order]
|
|
257
|
-
* @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/>
|
|
258
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
256
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
257
|
+
* @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: definition, values<i>
|
|
258
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
@@ -418,7 +418,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
418
418
|
* @param {string} code
|
|
419
419
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
420
420
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
421
|
-
* @param {string} [expand]
|
|
421
|
+
* @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: definition, values<i>
|
|
422
422
|
* @param {*} [options] Override http request option.
|
|
423
423
|
* @throws {RequiredError}
|
|
424
424
|
*/
|
|
@@ -432,7 +432,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
432
432
|
* @param {string} slug
|
|
433
433
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
434
434
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
435
|
-
* @param {string} [expand]
|
|
435
|
+
* @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: definition, values<i>
|
|
436
436
|
* @param {*} [options] Override http request option.
|
|
437
437
|
* @throws {RequiredError}
|
|
438
438
|
*/
|
|
@@ -441,16 +441,16 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
441
441
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
442
442
|
},
|
|
443
443
|
/**
|
|
444
|
-
*
|
|
444
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
445
445
|
* @summary List setting keys
|
|
446
446
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
447
447
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
448
448
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
449
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
449
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
450
450
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
451
|
-
* @param {string} [order]
|
|
452
|
-
* @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/>
|
|
453
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
451
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
452
|
+
* @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: definition, values<i>
|
|
453
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
454
454
|
* @param {*} [options] Override http request option.
|
|
455
455
|
* @throws {RequiredError}
|
|
456
456
|
*/
|
|
@@ -509,7 +509,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
509
509
|
* @param {string} code
|
|
510
510
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
511
511
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
512
|
-
* @param {string} [expand]
|
|
512
|
+
* @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: definition, values<i>
|
|
513
513
|
* @param {*} [options] Override http request option.
|
|
514
514
|
* @throws {RequiredError}
|
|
515
515
|
*/
|
|
@@ -522,7 +522,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
522
522
|
* @param {string} slug
|
|
523
523
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
524
524
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
525
|
-
* @param {string} [expand]
|
|
525
|
+
* @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: definition, values<i>
|
|
526
526
|
* @param {*} [options] Override http request option.
|
|
527
527
|
* @throws {RequiredError}
|
|
528
528
|
*/
|
|
@@ -530,16 +530,16 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
530
530
|
return localVarFp.getSettingKeyBySlug(slug, authorization, version, expand, options).then((request) => request(axios, basePath));
|
|
531
531
|
},
|
|
532
532
|
/**
|
|
533
|
-
*
|
|
533
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
534
534
|
* @summary List setting keys
|
|
535
535
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
536
536
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
537
537
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
538
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
538
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
539
539
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
540
|
-
* @param {string} [order]
|
|
541
|
-
* @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/>
|
|
542
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
540
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
541
|
+
* @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: definition, values<i>
|
|
542
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
543
543
|
* @param {*} [options] Override http request option.
|
|
544
544
|
* @throws {RequiredError}
|
|
545
545
|
*/
|
|
@@ -632,7 +632,7 @@ export interface SettingKeysApiGetSettingKeyRequest {
|
|
|
632
632
|
readonly version?: number
|
|
633
633
|
|
|
634
634
|
/**
|
|
635
|
-
*
|
|
635
|
+
* 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: definition, values<i>
|
|
636
636
|
* @type {string}
|
|
637
637
|
* @memberof SettingKeysApiGetSettingKey
|
|
638
638
|
*/
|
|
@@ -667,7 +667,7 @@ export interface SettingKeysApiGetSettingKeyBySlugRequest {
|
|
|
667
667
|
readonly version?: number
|
|
668
668
|
|
|
669
669
|
/**
|
|
670
|
-
*
|
|
670
|
+
* 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: definition, values<i>
|
|
671
671
|
* @type {string}
|
|
672
672
|
* @memberof SettingKeysApiGetSettingKeyBySlug
|
|
673
673
|
*/
|
|
@@ -702,7 +702,7 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
702
702
|
readonly pageToken?: string
|
|
703
703
|
|
|
704
704
|
/**
|
|
705
|
-
* Filter the response by one or multiple fields.
|
|
705
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
706
706
|
* @type {string}
|
|
707
707
|
* @memberof SettingKeysApiListSettingKeys
|
|
708
708
|
*/
|
|
@@ -716,21 +716,21 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
716
716
|
readonly search?: string
|
|
717
717
|
|
|
718
718
|
/**
|
|
719
|
-
*
|
|
719
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
720
720
|
* @type {string}
|
|
721
721
|
* @memberof SettingKeysApiListSettingKeys
|
|
722
722
|
*/
|
|
723
723
|
readonly order?: string
|
|
724
724
|
|
|
725
725
|
/**
|
|
726
|
-
* 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/>
|
|
726
|
+
* 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: definition, values<i>
|
|
727
727
|
* @type {string}
|
|
728
728
|
* @memberof SettingKeysApiListSettingKeys
|
|
729
729
|
*/
|
|
730
730
|
readonly expand?: string
|
|
731
731
|
|
|
732
732
|
/**
|
|
733
|
-
* Filters the response by one or multiple fields.
|
|
733
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
734
734
|
* @type {string}
|
|
735
735
|
* @memberof SettingKeysApiListSettingKeys
|
|
736
736
|
*/
|
|
@@ -827,7 +827,7 @@ export class SettingKeysApi extends BaseAPI {
|
|
|
827
827
|
}
|
|
828
828
|
|
|
829
829
|
/**
|
|
830
|
-
*
|
|
830
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
831
831
|
* @summary List setting keys
|
|
832
832
|
* @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
|
|
833
833
|
* @param {*} [options] Override http request option.
|
package/api.ts
CHANGED
|
@@ -28,12 +28,10 @@ import { HealthApi } from './api';
|
|
|
28
28
|
import { PublicKeysApi } from './api';
|
|
29
29
|
import { SettingDefinitionsApi } from './api';
|
|
30
30
|
import { SettingKeysApi } from './api';
|
|
31
|
-
import { SettingValuesApi } from './api';
|
|
32
31
|
|
|
33
32
|
|
|
34
33
|
export * from './api/health-api';
|
|
35
34
|
export * from './api/public-keys-api';
|
|
36
35
|
export * from './api/setting-definitions-api';
|
|
37
36
|
export * from './api/setting-keys-api';
|
|
38
|
-
export * from './api/setting-values-api';
|
|
39
37
|
|