@emilgroup/setting-sdk-node 0.3.1-beta.23 → 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 +51 -50
- package/api/setting-keys-api.ts +38 -54
- package/api.ts +0 -2
- package/dist/api/setting-definitions-api.d.ts +39 -39
- package/dist/api/setting-definitions-api.js +38 -38
- package/dist/api/setting-keys-api.d.ts +35 -44
- package/dist/api/setting-keys-api.js +31 -39
- 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/api/setting-keys-api.ts
CHANGED
|
@@ -94,16 +94,13 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
94
94
|
/**
|
|
95
95
|
* undefined **Required Permissions** \"tenant-management.settings.delete\"
|
|
96
96
|
* @param {string} code
|
|
97
|
-
* @param {string} ifMatch
|
|
98
97
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
99
98
|
* @param {*} [options] Override http request option.
|
|
100
99
|
* @throws {RequiredError}
|
|
101
100
|
*/
|
|
102
|
-
deleteSettingKey: async (code: string,
|
|
101
|
+
deleteSettingKey: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
103
102
|
// verify required parameter 'code' is not null or undefined
|
|
104
103
|
assertParamExists('deleteSettingKey', 'code', code)
|
|
105
|
-
// verify required parameter 'ifMatch' is not null or undefined
|
|
106
|
-
assertParamExists('deleteSettingKey', 'ifMatch', ifMatch)
|
|
107
104
|
const localVarPath = `/settingservice/v1/setting-keys/{code}`
|
|
108
105
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
109
106
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -127,10 +124,6 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
127
124
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
128
125
|
}
|
|
129
126
|
|
|
130
|
-
if (ifMatch !== undefined && ifMatch !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
131
|
-
localVarHeaderParameter['if-match'] = String(ifMatch ? ifMatch : baseAccessToken);
|
|
132
|
-
}
|
|
133
|
-
|
|
134
127
|
|
|
135
128
|
|
|
136
129
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -148,7 +141,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
148
141
|
* @param {string} code
|
|
149
142
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
150
143
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
151
|
-
* @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>
|
|
152
145
|
* @param {*} [options] Override http request option.
|
|
153
146
|
* @throws {RequiredError}
|
|
154
147
|
*/
|
|
@@ -203,7 +196,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
203
196
|
* @param {string} slug
|
|
204
197
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
205
198
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
206
|
-
* @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>
|
|
207
200
|
* @param {*} [options] Override http request option.
|
|
208
201
|
* @throws {RequiredError}
|
|
209
202
|
*/
|
|
@@ -253,16 +246,16 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
253
246
|
};
|
|
254
247
|
},
|
|
255
248
|
/**
|
|
256
|
-
*
|
|
249
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
257
250
|
* @summary List setting keys
|
|
258
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
259
252
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
260
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.
|
|
261
|
-
* @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>
|
|
262
255
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
263
|
-
* @param {string} [order]
|
|
264
|
-
* @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/>
|
|
265
|
-
* @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>
|
|
266
259
|
* @param {*} [options] Override http request option.
|
|
267
260
|
* @throws {RequiredError}
|
|
268
261
|
*/
|
|
@@ -332,7 +325,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
332
325
|
* Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
|
|
333
326
|
* @summary Update the setting key
|
|
334
327
|
* @param {string} code
|
|
335
|
-
* @param {string} ifMatch
|
|
328
|
+
* @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
|
|
336
329
|
* @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
|
|
337
330
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
338
331
|
* @param {*} [options] Override http request option.
|
|
@@ -411,13 +404,12 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
411
404
|
/**
|
|
412
405
|
* undefined **Required Permissions** \"tenant-management.settings.delete\"
|
|
413
406
|
* @param {string} code
|
|
414
|
-
* @param {string} ifMatch
|
|
415
407
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
416
408
|
* @param {*} [options] Override http request option.
|
|
417
409
|
* @throws {RequiredError}
|
|
418
410
|
*/
|
|
419
|
-
async deleteSettingKey(code: string,
|
|
420
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettingKey(code,
|
|
411
|
+
async deleteSettingKey(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>> {
|
|
412
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettingKey(code, authorization, options);
|
|
421
413
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
422
414
|
},
|
|
423
415
|
/**
|
|
@@ -426,7 +418,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
426
418
|
* @param {string} code
|
|
427
419
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
428
420
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
429
|
-
* @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>
|
|
430
422
|
* @param {*} [options] Override http request option.
|
|
431
423
|
* @throws {RequiredError}
|
|
432
424
|
*/
|
|
@@ -440,7 +432,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
440
432
|
* @param {string} slug
|
|
441
433
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
434
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
443
|
-
* @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>
|
|
444
436
|
* @param {*} [options] Override http request option.
|
|
445
437
|
* @throws {RequiredError}
|
|
446
438
|
*/
|
|
@@ -449,16 +441,16 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
449
441
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
450
442
|
},
|
|
451
443
|
/**
|
|
452
|
-
*
|
|
444
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
453
445
|
* @summary List setting keys
|
|
454
446
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
455
447
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
456
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.
|
|
457
|
-
* @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>
|
|
458
450
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
459
|
-
* @param {string} [order]
|
|
460
|
-
* @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/>
|
|
461
|
-
* @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>
|
|
462
454
|
* @param {*} [options] Override http request option.
|
|
463
455
|
* @throws {RequiredError}
|
|
464
456
|
*/
|
|
@@ -470,7 +462,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
470
462
|
* Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
|
|
471
463
|
* @summary Update the setting key
|
|
472
464
|
* @param {string} code
|
|
473
|
-
* @param {string} ifMatch
|
|
465
|
+
* @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
|
|
474
466
|
* @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
|
|
475
467
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
476
468
|
* @param {*} [options] Override http request option.
|
|
@@ -504,13 +496,12 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
504
496
|
/**
|
|
505
497
|
* undefined **Required Permissions** \"tenant-management.settings.delete\"
|
|
506
498
|
* @param {string} code
|
|
507
|
-
* @param {string} ifMatch
|
|
508
499
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
509
500
|
* @param {*} [options] Override http request option.
|
|
510
501
|
* @throws {RequiredError}
|
|
511
502
|
*/
|
|
512
|
-
deleteSettingKey(code: string,
|
|
513
|
-
return localVarFp.deleteSettingKey(code,
|
|
503
|
+
deleteSettingKey(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass> {
|
|
504
|
+
return localVarFp.deleteSettingKey(code, authorization, options).then((request) => request(axios, basePath));
|
|
514
505
|
},
|
|
515
506
|
/**
|
|
516
507
|
* Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
|
|
@@ -518,7 +509,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
518
509
|
* @param {string} code
|
|
519
510
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
520
511
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
521
|
-
* @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>
|
|
522
513
|
* @param {*} [options] Override http request option.
|
|
523
514
|
* @throws {RequiredError}
|
|
524
515
|
*/
|
|
@@ -531,7 +522,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
531
522
|
* @param {string} slug
|
|
532
523
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
533
524
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
534
|
-
* @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>
|
|
535
526
|
* @param {*} [options] Override http request option.
|
|
536
527
|
* @throws {RequiredError}
|
|
537
528
|
*/
|
|
@@ -539,16 +530,16 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
539
530
|
return localVarFp.getSettingKeyBySlug(slug, authorization, version, expand, options).then((request) => request(axios, basePath));
|
|
540
531
|
},
|
|
541
532
|
/**
|
|
542
|
-
*
|
|
533
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
543
534
|
* @summary List setting keys
|
|
544
535
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
545
536
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
546
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.
|
|
547
|
-
* @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>
|
|
548
539
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
549
|
-
* @param {string} [order]
|
|
550
|
-
* @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/>
|
|
551
|
-
* @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>
|
|
552
543
|
* @param {*} [options] Override http request option.
|
|
553
544
|
* @throws {RequiredError}
|
|
554
545
|
*/
|
|
@@ -559,7 +550,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
559
550
|
* Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
|
|
560
551
|
* @summary Update the setting key
|
|
561
552
|
* @param {string} code
|
|
562
|
-
* @param {string} ifMatch
|
|
553
|
+
* @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
|
|
563
554
|
* @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
|
|
564
555
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
565
556
|
* @param {*} [options] Override http request option.
|
|
@@ -605,13 +596,6 @@ export interface SettingKeysApiDeleteSettingKeyRequest {
|
|
|
605
596
|
*/
|
|
606
597
|
readonly code: string
|
|
607
598
|
|
|
608
|
-
/**
|
|
609
|
-
*
|
|
610
|
-
* @type {string}
|
|
611
|
-
* @memberof SettingKeysApiDeleteSettingKey
|
|
612
|
-
*/
|
|
613
|
-
readonly ifMatch: string
|
|
614
|
-
|
|
615
599
|
/**
|
|
616
600
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
617
601
|
* @type {string}
|
|
@@ -648,7 +632,7 @@ export interface SettingKeysApiGetSettingKeyRequest {
|
|
|
648
632
|
readonly version?: number
|
|
649
633
|
|
|
650
634
|
/**
|
|
651
|
-
*
|
|
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>
|
|
652
636
|
* @type {string}
|
|
653
637
|
* @memberof SettingKeysApiGetSettingKey
|
|
654
638
|
*/
|
|
@@ -683,7 +667,7 @@ export interface SettingKeysApiGetSettingKeyBySlugRequest {
|
|
|
683
667
|
readonly version?: number
|
|
684
668
|
|
|
685
669
|
/**
|
|
686
|
-
*
|
|
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>
|
|
687
671
|
* @type {string}
|
|
688
672
|
* @memberof SettingKeysApiGetSettingKeyBySlug
|
|
689
673
|
*/
|
|
@@ -718,7 +702,7 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
718
702
|
readonly pageToken?: string
|
|
719
703
|
|
|
720
704
|
/**
|
|
721
|
-
* 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>
|
|
722
706
|
* @type {string}
|
|
723
707
|
* @memberof SettingKeysApiListSettingKeys
|
|
724
708
|
*/
|
|
@@ -732,21 +716,21 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
732
716
|
readonly search?: string
|
|
733
717
|
|
|
734
718
|
/**
|
|
735
|
-
*
|
|
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>
|
|
736
720
|
* @type {string}
|
|
737
721
|
* @memberof SettingKeysApiListSettingKeys
|
|
738
722
|
*/
|
|
739
723
|
readonly order?: string
|
|
740
724
|
|
|
741
725
|
/**
|
|
742
|
-
* 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>
|
|
743
727
|
* @type {string}
|
|
744
728
|
* @memberof SettingKeysApiListSettingKeys
|
|
745
729
|
*/
|
|
746
730
|
readonly expand?: string
|
|
747
731
|
|
|
748
732
|
/**
|
|
749
|
-
* 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>
|
|
750
734
|
* @type {string}
|
|
751
735
|
* @memberof SettingKeysApiListSettingKeys
|
|
752
736
|
*/
|
|
@@ -767,7 +751,7 @@ export interface SettingKeysApiUpdateSettingKeyRequest {
|
|
|
767
751
|
readonly code: string
|
|
768
752
|
|
|
769
753
|
/**
|
|
770
|
-
*
|
|
754
|
+
* ETag of the latest setting value. Required to prevent lost updates.
|
|
771
755
|
* @type {string}
|
|
772
756
|
* @memberof SettingKeysApiUpdateSettingKey
|
|
773
757
|
*/
|
|
@@ -815,7 +799,7 @@ export class SettingKeysApi extends BaseAPI {
|
|
|
815
799
|
* @memberof SettingKeysApi
|
|
816
800
|
*/
|
|
817
801
|
public deleteSettingKey(requestParameters: SettingKeysApiDeleteSettingKeyRequest, options?: AxiosRequestConfig) {
|
|
818
|
-
return SettingKeysApiFp(this.configuration).deleteSettingKey(requestParameters.code, requestParameters.
|
|
802
|
+
return SettingKeysApiFp(this.configuration).deleteSettingKey(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
819
803
|
}
|
|
820
804
|
|
|
821
805
|
/**
|
|
@@ -843,7 +827,7 @@ export class SettingKeysApi extends BaseAPI {
|
|
|
843
827
|
}
|
|
844
828
|
|
|
845
829
|
/**
|
|
846
|
-
*
|
|
830
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
847
831
|
* @summary List setting keys
|
|
848
832
|
* @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
|
|
849
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
|
|
|
@@ -34,33 +34,33 @@ export declare const SettingDefinitionsApiAxiosParamCreator: (configuration?: Co
|
|
|
34
34
|
/**
|
|
35
35
|
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
36
36
|
* @summary Delete the setting definition
|
|
37
|
-
* @param {string} code
|
|
38
|
-
* @param {any} settingDefinition Unique identifier for the object.
|
|
37
|
+
* @param {string} code Unique identifier for the object.
|
|
39
38
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
40
39
|
* @param {*} [options] Override http request option.
|
|
41
40
|
* @throws {RequiredError}
|
|
42
41
|
*/
|
|
43
|
-
deleteSettingDefinition: (code: string,
|
|
42
|
+
deleteSettingDefinition: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44
43
|
/**
|
|
45
44
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
46
45
|
* @summary Retrieve the setting definition
|
|
47
46
|
* @param {string} code
|
|
48
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>
|
|
49
49
|
* @param {*} [options] Override http request option.
|
|
50
50
|
* @throws {RequiredError}
|
|
51
51
|
*/
|
|
52
|
-
getSettingDefinition: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
|
+
getSettingDefinition: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
53
|
/**
|
|
54
|
-
*
|
|
54
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
55
55
|
* @summary List setting definitions
|
|
56
56
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
57
57
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
58
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
59
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
59
|
+
* @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>
|
|
60
60
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
61
|
-
* @param {string} [order]
|
|
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.<br/> <br/>
|
|
63
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
|
|
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.<br/> <br/> <i>Allowed values: versions<i>
|
|
63
|
+
* @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>
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
65
65
|
* @throws {RequiredError}
|
|
66
66
|
*/
|
|
@@ -83,33 +83,33 @@ export declare const SettingDefinitionsApiFp: (configuration?: Configuration) =>
|
|
|
83
83
|
/**
|
|
84
84
|
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
85
85
|
* @summary Delete the setting definition
|
|
86
|
-
* @param {string} code
|
|
87
|
-
* @param {any} settingDefinition Unique identifier for the object.
|
|
86
|
+
* @param {string} code Unique identifier for the object.
|
|
88
87
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
89
88
|
* @param {*} [options] Override http request option.
|
|
90
89
|
* @throws {RequiredError}
|
|
91
90
|
*/
|
|
92
|
-
deleteSettingDefinition(code: string,
|
|
91
|
+
deleteSettingDefinition(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
|
|
93
92
|
/**
|
|
94
93
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
95
94
|
* @summary Retrieve the setting definition
|
|
96
95
|
* @param {string} code
|
|
97
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.<br/> <br/> <i>Allowed values: versions<i>
|
|
98
98
|
* @param {*} [options] Override http request option.
|
|
99
99
|
* @throws {RequiredError}
|
|
100
100
|
*/
|
|
101
|
-
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>>;
|
|
102
102
|
/**
|
|
103
|
-
*
|
|
103
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
104
104
|
* @summary List setting definitions
|
|
105
105
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
106
106
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
107
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
108
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
108
|
+
* @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>
|
|
109
109
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
110
|
-
* @param {string} [order]
|
|
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.<br/> <br/>
|
|
112
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
|
|
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.<br/> <br/> <i>Allowed values: versions<i>
|
|
112
|
+
* @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>
|
|
113
113
|
* @param {*} [options] Override http request option.
|
|
114
114
|
* @throws {RequiredError}
|
|
115
115
|
*/
|
|
@@ -132,33 +132,33 @@ export declare const SettingDefinitionsApiFactory: (configuration?: Configuratio
|
|
|
132
132
|
/**
|
|
133
133
|
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
134
134
|
* @summary Delete the setting definition
|
|
135
|
-
* @param {string} code
|
|
136
|
-
* @param {any} settingDefinition Unique identifier for the object.
|
|
135
|
+
* @param {string} code Unique identifier for the object.
|
|
137
136
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
138
137
|
* @param {*} [options] Override http request option.
|
|
139
138
|
* @throws {RequiredError}
|
|
140
139
|
*/
|
|
141
|
-
deleteSettingDefinition(code: string,
|
|
140
|
+
deleteSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
|
|
142
141
|
/**
|
|
143
142
|
* Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
|
|
144
143
|
* @summary Retrieve the setting definition
|
|
145
144
|
* @param {string} code
|
|
146
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.<br/> <br/> <i>Allowed values: versions<i>
|
|
147
147
|
* @param {*} [options] Override http request option.
|
|
148
148
|
* @throws {RequiredError}
|
|
149
149
|
*/
|
|
150
|
-
getSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
|
|
150
|
+
getSettingDefinition(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
|
|
151
151
|
/**
|
|
152
|
-
*
|
|
152
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
153
153
|
* @summary List setting definitions
|
|
154
154
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
155
155
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
156
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
157
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
157
|
+
* @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>
|
|
158
158
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
159
|
-
* @param {string} [order]
|
|
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.<br/> <br/>
|
|
161
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, createdAt, updatedAt</i>
|
|
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.<br/> <br/> <i>Allowed values: versions<i>
|
|
161
|
+
* @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>
|
|
162
162
|
* @param {*} [options] Override http request option.
|
|
163
163
|
* @throws {RequiredError}
|
|
164
164
|
*/
|
|
@@ -190,17 +190,11 @@ export interface SettingDefinitionsApiCreateSettingDefinitionRequest {
|
|
|
190
190
|
*/
|
|
191
191
|
export interface SettingDefinitionsApiDeleteSettingDefinitionRequest {
|
|
192
192
|
/**
|
|
193
|
-
*
|
|
193
|
+
* Unique identifier for the object.
|
|
194
194
|
* @type {string}
|
|
195
195
|
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
196
196
|
*/
|
|
197
197
|
readonly code: string;
|
|
198
|
-
/**
|
|
199
|
-
* Unique identifier for the object.
|
|
200
|
-
* @type {any}
|
|
201
|
-
* @memberof SettingDefinitionsApiDeleteSettingDefinition
|
|
202
|
-
*/
|
|
203
|
-
readonly settingDefinition: any;
|
|
204
198
|
/**
|
|
205
199
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
206
200
|
* @type {string}
|
|
@@ -226,6 +220,12 @@ export interface SettingDefinitionsApiGetSettingDefinitionRequest {
|
|
|
226
220
|
* @memberof SettingDefinitionsApiGetSettingDefinition
|
|
227
221
|
*/
|
|
228
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.<br/> <br/> <i>Allowed values: versions<i>
|
|
225
|
+
* @type {string}
|
|
226
|
+
* @memberof SettingDefinitionsApiGetSettingDefinition
|
|
227
|
+
*/
|
|
228
|
+
readonly expand?: string;
|
|
229
229
|
}
|
|
230
230
|
/**
|
|
231
231
|
* Request parameters for listSettingDefinitions operation in SettingDefinitionsApi.
|
|
@@ -252,7 +252,7 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
|
|
|
252
252
|
*/
|
|
253
253
|
readonly pageToken?: string;
|
|
254
254
|
/**
|
|
255
|
-
* Filter the response by one or multiple fields.
|
|
255
|
+
* 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>
|
|
256
256
|
* @type {string}
|
|
257
257
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
258
258
|
*/
|
|
@@ -264,19 +264,19 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
|
|
|
264
264
|
*/
|
|
265
265
|
readonly search?: string;
|
|
266
266
|
/**
|
|
267
|
-
*
|
|
267
|
+
* 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>
|
|
268
268
|
* @type {string}
|
|
269
269
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
270
270
|
*/
|
|
271
271
|
readonly order?: string;
|
|
272
272
|
/**
|
|
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.<br/> <br/>
|
|
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.<br/> <br/> <i>Allowed values: versions<i>
|
|
274
274
|
* @type {string}
|
|
275
275
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
276
276
|
*/
|
|
277
277
|
readonly expand?: string;
|
|
278
278
|
/**
|
|
279
|
-
* Filters the response by one or multiple fields.
|
|
279
|
+
* 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>
|
|
280
280
|
* @type {string}
|
|
281
281
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
282
282
|
*/
|
|
@@ -317,7 +317,7 @@ export declare class SettingDefinitionsApi extends BaseAPI {
|
|
|
317
317
|
*/
|
|
318
318
|
getSettingDefinition(requestParameters: SettingDefinitionsApiGetSettingDefinitionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettingDefinitionResponseClass, any, {}>>;
|
|
319
319
|
/**
|
|
320
|
-
*
|
|
320
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
321
321
|
* @summary List setting definitions
|
|
322
322
|
* @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
|
|
323
323
|
* @param {*} [options] Override http request option.
|