@emilgroup/setting-sdk 0.3.1-beta.24 → 0.3.1-beta.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 -246
- package/dist/api/setting-values-api.d.ts +0 -150
- package/dist/api/setting-values-api.js +0 -260
- 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
|
@@ -90,16 +90,13 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
90
90
|
/**
|
|
91
91
|
* undefined **Required Permissions** \"tenant-management.settings.delete\"
|
|
92
92
|
* @param {string} code
|
|
93
|
-
* @param {string} ifMatch
|
|
94
93
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
95
94
|
* @param {*} [options] Override http request option.
|
|
96
95
|
* @throws {RequiredError}
|
|
97
96
|
*/
|
|
98
|
-
deleteSettingKey: async (code: string,
|
|
97
|
+
deleteSettingKey: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
99
98
|
// verify required parameter 'code' is not null or undefined
|
|
100
99
|
assertParamExists('deleteSettingKey', 'code', code)
|
|
101
|
-
// verify required parameter 'ifMatch' is not null or undefined
|
|
102
|
-
assertParamExists('deleteSettingKey', 'ifMatch', ifMatch)
|
|
103
100
|
const localVarPath = `/settingservice/v1/setting-keys/{code}`
|
|
104
101
|
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
105
102
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -123,10 +120,6 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
123
120
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
124
121
|
}
|
|
125
122
|
|
|
126
|
-
if (ifMatch !== undefined && ifMatch !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
127
|
-
localVarHeaderParameter['if-match'] = String(ifMatch ? ifMatch : baseAccessToken);
|
|
128
|
-
}
|
|
129
|
-
|
|
130
123
|
|
|
131
124
|
|
|
132
125
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -144,7 +137,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
144
137
|
* @param {string} code
|
|
145
138
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
146
139
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
147
|
-
* @param {string} [expand]
|
|
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: definition, values<i>
|
|
148
141
|
* @param {*} [options] Override http request option.
|
|
149
142
|
* @throws {RequiredError}
|
|
150
143
|
*/
|
|
@@ -199,7 +192,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
199
192
|
* @param {string} slug
|
|
200
193
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
201
194
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
202
|
-
* @param {string} [expand]
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
203
196
|
* @param {*} [options] Override http request option.
|
|
204
197
|
* @throws {RequiredError}
|
|
205
198
|
*/
|
|
@@ -249,16 +242,16 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
249
242
|
};
|
|
250
243
|
},
|
|
251
244
|
/**
|
|
252
|
-
*
|
|
245
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
253
246
|
* @summary List setting keys
|
|
254
247
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
255
248
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
256
249
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
257
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
250
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
258
251
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
259
|
-
* @param {string} [order]
|
|
260
|
-
* @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/>
|
|
261
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
252
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
253
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
254
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
|
|
262
255
|
* @param {*} [options] Override http request option.
|
|
263
256
|
* @throws {RequiredError}
|
|
264
257
|
*/
|
|
@@ -328,7 +321,7 @@ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configu
|
|
|
328
321
|
* 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\"
|
|
329
322
|
* @summary Update the setting key
|
|
330
323
|
* @param {string} code
|
|
331
|
-
* @param {string} ifMatch
|
|
324
|
+
* @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
|
|
332
325
|
* @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
|
|
333
326
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
334
327
|
* @param {*} [options] Override http request option.
|
|
@@ -407,13 +400,12 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
407
400
|
/**
|
|
408
401
|
* undefined **Required Permissions** \"tenant-management.settings.delete\"
|
|
409
402
|
* @param {string} code
|
|
410
|
-
* @param {string} ifMatch
|
|
411
403
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
412
404
|
* @param {*} [options] Override http request option.
|
|
413
405
|
* @throws {RequiredError}
|
|
414
406
|
*/
|
|
415
|
-
async deleteSettingKey(code: string,
|
|
416
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettingKey(code,
|
|
407
|
+
async deleteSettingKey(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>> {
|
|
408
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettingKey(code, authorization, options);
|
|
417
409
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
418
410
|
},
|
|
419
411
|
/**
|
|
@@ -422,7 +414,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
422
414
|
* @param {string} code
|
|
423
415
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
424
416
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
425
|
-
* @param {string} [expand]
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
426
418
|
* @param {*} [options] Override http request option.
|
|
427
419
|
* @throws {RequiredError}
|
|
428
420
|
*/
|
|
@@ -436,7 +428,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
436
428
|
* @param {string} slug
|
|
437
429
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
438
430
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
439
|
-
* @param {string} [expand]
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
440
432
|
* @param {*} [options] Override http request option.
|
|
441
433
|
* @throws {RequiredError}
|
|
442
434
|
*/
|
|
@@ -445,16 +437,16 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
445
437
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
446
438
|
},
|
|
447
439
|
/**
|
|
448
|
-
*
|
|
440
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
449
441
|
* @summary List setting keys
|
|
450
442
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
451
443
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
452
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
453
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
445
|
+
* @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>
|
|
454
446
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
455
|
-
* @param {string} [order]
|
|
456
|
-
* @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/>
|
|
457
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
449
|
+
* @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>
|
|
458
450
|
* @param {*} [options] Override http request option.
|
|
459
451
|
* @throws {RequiredError}
|
|
460
452
|
*/
|
|
@@ -466,7 +458,7 @@ export const SettingKeysApiFp = function(configuration?: Configuration) {
|
|
|
466
458
|
* 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\"
|
|
467
459
|
* @summary Update the setting key
|
|
468
460
|
* @param {string} code
|
|
469
|
-
* @param {string} ifMatch
|
|
461
|
+
* @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
|
|
470
462
|
* @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
|
|
471
463
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
472
464
|
* @param {*} [options] Override http request option.
|
|
@@ -500,13 +492,12 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
500
492
|
/**
|
|
501
493
|
* undefined **Required Permissions** \"tenant-management.settings.delete\"
|
|
502
494
|
* @param {string} code
|
|
503
|
-
* @param {string} ifMatch
|
|
504
495
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
505
496
|
* @param {*} [options] Override http request option.
|
|
506
497
|
* @throws {RequiredError}
|
|
507
498
|
*/
|
|
508
|
-
deleteSettingKey(code: string,
|
|
509
|
-
return localVarFp.deleteSettingKey(code,
|
|
499
|
+
deleteSettingKey(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass> {
|
|
500
|
+
return localVarFp.deleteSettingKey(code, authorization, options).then((request) => request(axios, basePath));
|
|
510
501
|
},
|
|
511
502
|
/**
|
|
512
503
|
* 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\"
|
|
@@ -514,7 +505,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
514
505
|
* @param {string} code
|
|
515
506
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
516
507
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
517
|
-
* @param {string} [expand]
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
518
509
|
* @param {*} [options] Override http request option.
|
|
519
510
|
* @throws {RequiredError}
|
|
520
511
|
*/
|
|
@@ -527,7 +518,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
527
518
|
* @param {string} slug
|
|
528
519
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
529
520
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
530
|
-
* @param {string} [expand]
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
531
522
|
* @param {*} [options] Override http request option.
|
|
532
523
|
* @throws {RequiredError}
|
|
533
524
|
*/
|
|
@@ -535,16 +526,16 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
535
526
|
return localVarFp.getSettingKeyBySlug(slug, authorization, version, expand, options).then((request) => request(axios, basePath));
|
|
536
527
|
},
|
|
537
528
|
/**
|
|
538
|
-
*
|
|
529
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
539
530
|
* @summary List setting keys
|
|
540
531
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
541
532
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
542
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
543
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
534
|
+
* @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>
|
|
544
535
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
545
|
-
* @param {string} [order]
|
|
546
|
-
* @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/>
|
|
547
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
538
|
+
* @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>
|
|
548
539
|
* @param {*} [options] Override http request option.
|
|
549
540
|
* @throws {RequiredError}
|
|
550
541
|
*/
|
|
@@ -555,7 +546,7 @@ export const SettingKeysApiFactory = function (configuration?: Configuration, ba
|
|
|
555
546
|
* 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\"
|
|
556
547
|
* @summary Update the setting key
|
|
557
548
|
* @param {string} code
|
|
558
|
-
* @param {string} ifMatch
|
|
549
|
+
* @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
|
|
559
550
|
* @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
|
|
560
551
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
561
552
|
* @param {*} [options] Override http request option.
|
|
@@ -601,13 +592,6 @@ export interface SettingKeysApiDeleteSettingKeyRequest {
|
|
|
601
592
|
*/
|
|
602
593
|
readonly code: string
|
|
603
594
|
|
|
604
|
-
/**
|
|
605
|
-
*
|
|
606
|
-
* @type {string}
|
|
607
|
-
* @memberof SettingKeysApiDeleteSettingKey
|
|
608
|
-
*/
|
|
609
|
-
readonly ifMatch: string
|
|
610
|
-
|
|
611
595
|
/**
|
|
612
596
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
613
597
|
* @type {string}
|
|
@@ -644,7 +628,7 @@ export interface SettingKeysApiGetSettingKeyRequest {
|
|
|
644
628
|
readonly version?: number
|
|
645
629
|
|
|
646
630
|
/**
|
|
647
|
-
*
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
648
632
|
* @type {string}
|
|
649
633
|
* @memberof SettingKeysApiGetSettingKey
|
|
650
634
|
*/
|
|
@@ -679,7 +663,7 @@ export interface SettingKeysApiGetSettingKeyBySlugRequest {
|
|
|
679
663
|
readonly version?: number
|
|
680
664
|
|
|
681
665
|
/**
|
|
682
|
-
*
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
683
667
|
* @type {string}
|
|
684
668
|
* @memberof SettingKeysApiGetSettingKeyBySlug
|
|
685
669
|
*/
|
|
@@ -714,7 +698,7 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
714
698
|
readonly pageToken?: string
|
|
715
699
|
|
|
716
700
|
/**
|
|
717
|
-
* Filter the response by one or multiple fields.
|
|
701
|
+
* 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>
|
|
718
702
|
* @type {string}
|
|
719
703
|
* @memberof SettingKeysApiListSettingKeys
|
|
720
704
|
*/
|
|
@@ -728,21 +712,21 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
728
712
|
readonly search?: string
|
|
729
713
|
|
|
730
714
|
/**
|
|
731
|
-
*
|
|
715
|
+
* 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>
|
|
732
716
|
* @type {string}
|
|
733
717
|
* @memberof SettingKeysApiListSettingKeys
|
|
734
718
|
*/
|
|
735
719
|
readonly order?: string
|
|
736
720
|
|
|
737
721
|
/**
|
|
738
|
-
* 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/>
|
|
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.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
739
723
|
* @type {string}
|
|
740
724
|
* @memberof SettingKeysApiListSettingKeys
|
|
741
725
|
*/
|
|
742
726
|
readonly expand?: string
|
|
743
727
|
|
|
744
728
|
/**
|
|
745
|
-
* Filters the response by one or multiple fields.
|
|
729
|
+
* 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>
|
|
746
730
|
* @type {string}
|
|
747
731
|
* @memberof SettingKeysApiListSettingKeys
|
|
748
732
|
*/
|
|
@@ -763,7 +747,7 @@ export interface SettingKeysApiUpdateSettingKeyRequest {
|
|
|
763
747
|
readonly code: string
|
|
764
748
|
|
|
765
749
|
/**
|
|
766
|
-
*
|
|
750
|
+
* ETag of the latest setting value. Required to prevent lost updates.
|
|
767
751
|
* @type {string}
|
|
768
752
|
* @memberof SettingKeysApiUpdateSettingKey
|
|
769
753
|
*/
|
|
@@ -811,7 +795,7 @@ export class SettingKeysApi extends BaseAPI {
|
|
|
811
795
|
* @memberof SettingKeysApi
|
|
812
796
|
*/
|
|
813
797
|
public deleteSettingKey(requestParameters: SettingKeysApiDeleteSettingKeyRequest, options?: AxiosRequestConfig) {
|
|
814
|
-
return SettingKeysApiFp(this.configuration).deleteSettingKey(requestParameters.code, requestParameters.
|
|
798
|
+
return SettingKeysApiFp(this.configuration).deleteSettingKey(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
815
799
|
}
|
|
816
800
|
|
|
817
801
|
/**
|
|
@@ -839,7 +823,7 @@ export class SettingKeysApi extends BaseAPI {
|
|
|
839
823
|
}
|
|
840
824
|
|
|
841
825
|
/**
|
|
842
|
-
*
|
|
826
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
843
827
|
* @summary List setting keys
|
|
844
828
|
* @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
|
|
845
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
|
|
|
@@ -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.
|