@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
|
@@ -148,13 +148,12 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
148
148
|
/**
|
|
149
149
|
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
150
150
|
* @summary Delete the setting definition
|
|
151
|
-
* @param {string} code
|
|
152
|
-
* @param {any} settingDefinition Unique identifier for the object.
|
|
151
|
+
* @param {string} code Unique identifier for the object.
|
|
153
152
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
153
|
* @param {*} [options] Override http request option.
|
|
155
154
|
* @throws {RequiredError}
|
|
156
155
|
*/
|
|
157
|
-
deleteSettingDefinition: function (code,
|
|
156
|
+
deleteSettingDefinition: function (code, authorization, options) {
|
|
158
157
|
if (options === void 0) { options = {}; }
|
|
159
158
|
return __awaiter(_this, void 0, void 0, function () {
|
|
160
159
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -163,11 +162,8 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
163
162
|
case 0:
|
|
164
163
|
// verify required parameter 'code' is not null or undefined
|
|
165
164
|
(0, common_1.assertParamExists)('deleteSettingDefinition', 'code', code);
|
|
166
|
-
// verify required parameter 'settingDefinition' is not null or undefined
|
|
167
|
-
(0, common_1.assertParamExists)('deleteSettingDefinition', 'settingDefinition', settingDefinition);
|
|
168
165
|
localVarPath = "/settingservice/v1/settings/definitions/{code}"
|
|
169
|
-
.replace("{".concat("code", "}"), encodeURIComponent(String(code)))
|
|
170
|
-
.replace("{".concat("setting definition", "}"), encodeURIComponent(String(settingDefinition)));
|
|
166
|
+
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
171
167
|
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
172
168
|
if (configuration) {
|
|
173
169
|
baseOptions = configuration.baseOptions;
|
|
@@ -202,10 +198,11 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
202
198
|
* @summary Retrieve the setting definition
|
|
203
199
|
* @param {string} code
|
|
204
200
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
201
|
+
* @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>
|
|
205
202
|
* @param {*} [options] Override http request option.
|
|
206
203
|
* @throws {RequiredError}
|
|
207
204
|
*/
|
|
208
|
-
getSettingDefinition: function (code, authorization, options) {
|
|
205
|
+
getSettingDefinition: function (code, authorization, expand, options) {
|
|
209
206
|
if (options === void 0) { options = {}; }
|
|
210
207
|
return __awaiter(_this, void 0, void 0, function () {
|
|
211
208
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -231,6 +228,9 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
231
228
|
// authentication bearer required
|
|
232
229
|
// http bearer authentication required
|
|
233
230
|
_a.sent();
|
|
231
|
+
if (expand !== undefined) {
|
|
232
|
+
localVarQueryParameter['expand'] = expand;
|
|
233
|
+
}
|
|
234
234
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
235
235
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
236
236
|
}
|
|
@@ -246,16 +246,16 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
246
246
|
});
|
|
247
247
|
},
|
|
248
248
|
/**
|
|
249
|
-
*
|
|
249
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
250
250
|
* @summary List setting definitions
|
|
251
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
252
252
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
253
253
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
254
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
254
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
255
255
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
256
|
-
* @param {string} [order]
|
|
257
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
258
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
256
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, definitionKey, ownerService, scope, 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: versions<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, definitionKey, ownerService, scope, isSecured, createdAt, updatedAt</i>
|
|
259
259
|
* @param {*} [options] Override http request option.
|
|
260
260
|
* @throws {RequiredError}
|
|
261
261
|
*/
|
|
@@ -351,18 +351,17 @@ var SettingDefinitionsApiFp = function (configuration) {
|
|
|
351
351
|
/**
|
|
352
352
|
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
353
353
|
* @summary Delete the setting definition
|
|
354
|
-
* @param {string} code
|
|
355
|
-
* @param {any} settingDefinition Unique identifier for the object.
|
|
354
|
+
* @param {string} code Unique identifier for the object.
|
|
356
355
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
357
356
|
* @param {*} [options] Override http request option.
|
|
358
357
|
* @throws {RequiredError}
|
|
359
358
|
*/
|
|
360
|
-
deleteSettingDefinition: function (code,
|
|
359
|
+
deleteSettingDefinition: function (code, authorization, options) {
|
|
361
360
|
return __awaiter(this, void 0, void 0, function () {
|
|
362
361
|
var localVarAxiosArgs;
|
|
363
362
|
return __generator(this, function (_a) {
|
|
364
363
|
switch (_a.label) {
|
|
365
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingDefinition(code,
|
|
364
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteSettingDefinition(code, authorization, options)];
|
|
366
365
|
case 1:
|
|
367
366
|
localVarAxiosArgs = _a.sent();
|
|
368
367
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -375,15 +374,16 @@ var SettingDefinitionsApiFp = function (configuration) {
|
|
|
375
374
|
* @summary Retrieve the setting definition
|
|
376
375
|
* @param {string} code
|
|
377
376
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
377
|
+
* @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>
|
|
378
378
|
* @param {*} [options] Override http request option.
|
|
379
379
|
* @throws {RequiredError}
|
|
380
380
|
*/
|
|
381
|
-
getSettingDefinition: function (code, authorization, options) {
|
|
381
|
+
getSettingDefinition: function (code, authorization, expand, options) {
|
|
382
382
|
return __awaiter(this, void 0, void 0, function () {
|
|
383
383
|
var localVarAxiosArgs;
|
|
384
384
|
return __generator(this, function (_a) {
|
|
385
385
|
switch (_a.label) {
|
|
386
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, options)];
|
|
386
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, expand, options)];
|
|
387
387
|
case 1:
|
|
388
388
|
localVarAxiosArgs = _a.sent();
|
|
389
389
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -392,16 +392,16 @@ var SettingDefinitionsApiFp = function (configuration) {
|
|
|
392
392
|
});
|
|
393
393
|
},
|
|
394
394
|
/**
|
|
395
|
-
*
|
|
395
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
396
396
|
* @summary List setting definitions
|
|
397
397
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
398
398
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
399
399
|
* @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.
|
|
400
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
400
|
+
* @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>
|
|
401
401
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
402
|
-
* @param {string} [order]
|
|
403
|
-
* @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/>
|
|
404
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
402
|
+
* @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>
|
|
403
|
+
* @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>
|
|
404
|
+
* @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>
|
|
405
405
|
* @param {*} [options] Override http request option.
|
|
406
406
|
* @throws {RequiredError}
|
|
407
407
|
*/
|
|
@@ -442,37 +442,37 @@ var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
|
|
|
442
442
|
/**
|
|
443
443
|
* Delete a tenant setting definition and cascade soft-delete its versions, keys, and values. **Required Permissions** \"tenant-management.settings.delete\"
|
|
444
444
|
* @summary Delete the setting definition
|
|
445
|
-
* @param {string} code
|
|
446
|
-
* @param {any} settingDefinition Unique identifier for the object.
|
|
445
|
+
* @param {string} code Unique identifier for the object.
|
|
447
446
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
448
447
|
* @param {*} [options] Override http request option.
|
|
449
448
|
* @throws {RequiredError}
|
|
450
449
|
*/
|
|
451
|
-
deleteSettingDefinition: function (code,
|
|
452
|
-
return localVarFp.deleteSettingDefinition(code,
|
|
450
|
+
deleteSettingDefinition: function (code, authorization, options) {
|
|
451
|
+
return localVarFp.deleteSettingDefinition(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
453
452
|
},
|
|
454
453
|
/**
|
|
455
454
|
* 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\"
|
|
456
455
|
* @summary Retrieve the setting definition
|
|
457
456
|
* @param {string} code
|
|
458
457
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
458
|
+
* @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>
|
|
459
459
|
* @param {*} [options] Override http request option.
|
|
460
460
|
* @throws {RequiredError}
|
|
461
461
|
*/
|
|
462
|
-
getSettingDefinition: function (code, authorization, options) {
|
|
463
|
-
return localVarFp.getSettingDefinition(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
462
|
+
getSettingDefinition: function (code, authorization, expand, options) {
|
|
463
|
+
return localVarFp.getSettingDefinition(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
464
464
|
},
|
|
465
465
|
/**
|
|
466
|
-
*
|
|
466
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
467
467
|
* @summary List setting definitions
|
|
468
468
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
469
469
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
470
470
|
* @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.
|
|
471
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
471
|
+
* @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>
|
|
472
472
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
473
|
-
* @param {string} [order]
|
|
474
|
-
* @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/>
|
|
475
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
473
|
+
* @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>
|
|
474
|
+
* @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>
|
|
475
|
+
* @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>
|
|
476
476
|
* @param {*} [options] Override http request option.
|
|
477
477
|
* @throws {RequiredError}
|
|
478
478
|
*/
|
|
@@ -515,7 +515,7 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
|
|
|
515
515
|
*/
|
|
516
516
|
SettingDefinitionsApi.prototype.deleteSettingDefinition = function (requestParameters, options) {
|
|
517
517
|
var _this = this;
|
|
518
|
-
return (0, exports.SettingDefinitionsApiFp)(this.configuration).deleteSettingDefinition(requestParameters.code, requestParameters.
|
|
518
|
+
return (0, exports.SettingDefinitionsApiFp)(this.configuration).deleteSettingDefinition(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
519
519
|
};
|
|
520
520
|
/**
|
|
521
521
|
* 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\"
|
|
@@ -527,10 +527,10 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
|
|
|
527
527
|
*/
|
|
528
528
|
SettingDefinitionsApi.prototype.getSettingDefinition = function (requestParameters, options) {
|
|
529
529
|
var _this = this;
|
|
530
|
-
return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
530
|
+
return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
531
531
|
};
|
|
532
532
|
/**
|
|
533
|
-
*
|
|
533
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
534
534
|
* @summary List setting definitions
|
|
535
535
|
* @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
|
|
536
536
|
* @param {*} [options] Override http request option.
|
|
@@ -36,19 +36,18 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
|
|
|
36
36
|
/**
|
|
37
37
|
* undefined **Required Permissions** \"tenant-management.settings.delete\"
|
|
38
38
|
* @param {string} code
|
|
39
|
-
* @param {string} ifMatch
|
|
40
39
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
41
40
|
* @param {*} [options] Override http request option.
|
|
42
41
|
* @throws {RequiredError}
|
|
43
42
|
*/
|
|
44
|
-
deleteSettingKey: (code: string,
|
|
43
|
+
deleteSettingKey: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
44
|
/**
|
|
46
45
|
* 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\"
|
|
47
46
|
* @summary Retrieve the setting key
|
|
48
47
|
* @param {string} code
|
|
49
48
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
50
49
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
51
|
-
* @param {string} [expand]
|
|
50
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
52
51
|
* @param {*} [options] Override http request option.
|
|
53
52
|
* @throws {RequiredError}
|
|
54
53
|
*/
|
|
@@ -59,22 +58,22 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
|
|
|
59
58
|
* @param {string} slug
|
|
60
59
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
61
60
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
62
|
-
* @param {string} [expand]
|
|
61
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
63
62
|
* @param {*} [options] Override http request option.
|
|
64
63
|
* @throws {RequiredError}
|
|
65
64
|
*/
|
|
66
65
|
getSettingKeyBySlug: (slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
66
|
/**
|
|
68
|
-
*
|
|
67
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
69
68
|
* @summary List setting keys
|
|
70
69
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
71
70
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
72
71
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
73
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
72
|
+
* @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>
|
|
74
73
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
75
|
-
* @param {string} [order]
|
|
76
|
-
* @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/>
|
|
77
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
74
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
75
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
76
|
+
* @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>
|
|
78
77
|
* @param {*} [options] Override http request option.
|
|
79
78
|
* @throws {RequiredError}
|
|
80
79
|
*/
|
|
@@ -83,7 +82,7 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
|
|
|
83
82
|
* 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\"
|
|
84
83
|
* @summary Update the setting key
|
|
85
84
|
* @param {string} code
|
|
86
|
-
* @param {string} ifMatch
|
|
85
|
+
* @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
|
|
87
86
|
* @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
|
|
88
87
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
89
88
|
* @param {*} [options] Override http request option.
|
|
@@ -108,19 +107,18 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
|
|
|
108
107
|
/**
|
|
109
108
|
* undefined **Required Permissions** \"tenant-management.settings.delete\"
|
|
110
109
|
* @param {string} code
|
|
111
|
-
* @param {string} ifMatch
|
|
112
110
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
113
111
|
* @param {*} [options] Override http request option.
|
|
114
112
|
* @throws {RequiredError}
|
|
115
113
|
*/
|
|
116
|
-
deleteSettingKey(code: string,
|
|
114
|
+
deleteSettingKey(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteByCodeResponseClass>>;
|
|
117
115
|
/**
|
|
118
116
|
* 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\"
|
|
119
117
|
* @summary Retrieve the setting key
|
|
120
118
|
* @param {string} code
|
|
121
119
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
122
120
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
123
|
-
* @param {string} [expand]
|
|
121
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
124
122
|
* @param {*} [options] Override http request option.
|
|
125
123
|
* @throws {RequiredError}
|
|
126
124
|
*/
|
|
@@ -131,22 +129,22 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
|
|
|
131
129
|
* @param {string} slug
|
|
132
130
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
133
131
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
134
|
-
* @param {string} [expand]
|
|
132
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
135
133
|
* @param {*} [options] Override http request option.
|
|
136
134
|
* @throws {RequiredError}
|
|
137
135
|
*/
|
|
138
136
|
getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingKeyResponseClass>>;
|
|
139
137
|
/**
|
|
140
|
-
*
|
|
138
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
141
139
|
* @summary List setting keys
|
|
142
140
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
143
141
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
144
142
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
145
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
143
|
+
* @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>
|
|
146
144
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
147
|
-
* @param {string} [order]
|
|
148
|
-
* @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/>
|
|
149
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
145
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
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: definition, values<i>
|
|
147
|
+
* @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>
|
|
150
148
|
* @param {*} [options] Override http request option.
|
|
151
149
|
* @throws {RequiredError}
|
|
152
150
|
*/
|
|
@@ -155,7 +153,7 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
|
|
|
155
153
|
* 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\"
|
|
156
154
|
* @summary Update the setting key
|
|
157
155
|
* @param {string} code
|
|
158
|
-
* @param {string} ifMatch
|
|
156
|
+
* @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
|
|
159
157
|
* @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
|
|
160
158
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
161
159
|
* @param {*} [options] Override http request option.
|
|
@@ -180,19 +178,18 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
|
|
|
180
178
|
/**
|
|
181
179
|
* undefined **Required Permissions** \"tenant-management.settings.delete\"
|
|
182
180
|
* @param {string} code
|
|
183
|
-
* @param {string} ifMatch
|
|
184
181
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
185
182
|
* @param {*} [options] Override http request option.
|
|
186
183
|
* @throws {RequiredError}
|
|
187
184
|
*/
|
|
188
|
-
deleteSettingKey(code: string,
|
|
185
|
+
deleteSettingKey(code: string, authorization?: string, options?: any): AxiosPromise<DeleteByCodeResponseClass>;
|
|
189
186
|
/**
|
|
190
187
|
* 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\"
|
|
191
188
|
* @summary Retrieve the setting key
|
|
192
189
|
* @param {string} code
|
|
193
190
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
194
191
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
195
|
-
* @param {string} [expand]
|
|
192
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
196
193
|
* @param {*} [options] Override http request option.
|
|
197
194
|
* @throws {RequiredError}
|
|
198
195
|
*/
|
|
@@ -203,22 +200,22 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
|
|
|
203
200
|
* @param {string} slug
|
|
204
201
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
205
202
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
206
|
-
* @param {string} [expand]
|
|
203
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
207
204
|
* @param {*} [options] Override http request option.
|
|
208
205
|
* @throws {RequiredError}
|
|
209
206
|
*/
|
|
210
207
|
getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: any): AxiosPromise<GetSettingKeyResponseClass>;
|
|
211
208
|
/**
|
|
212
|
-
*
|
|
209
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
213
210
|
* @summary List setting keys
|
|
214
211
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
215
212
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
216
213
|
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
217
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
214
|
+
* @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>
|
|
218
215
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
219
|
-
* @param {string} [order]
|
|
220
|
-
* @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/>
|
|
221
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
216
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
|
|
217
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
218
|
+
* @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>
|
|
222
219
|
* @param {*} [options] Override http request option.
|
|
223
220
|
* @throws {RequiredError}
|
|
224
221
|
*/
|
|
@@ -227,7 +224,7 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
|
|
|
227
224
|
* 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\"
|
|
228
225
|
* @summary Update the setting key
|
|
229
226
|
* @param {string} code
|
|
230
|
-
* @param {string} ifMatch
|
|
227
|
+
* @param {string} ifMatch ETag of the latest setting value. Required to prevent lost updates.
|
|
231
228
|
* @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
|
|
232
229
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
233
230
|
* @param {*} [options] Override http request option.
|
|
@@ -266,12 +263,6 @@ export interface SettingKeysApiDeleteSettingKeyRequest {
|
|
|
266
263
|
* @memberof SettingKeysApiDeleteSettingKey
|
|
267
264
|
*/
|
|
268
265
|
readonly code: string;
|
|
269
|
-
/**
|
|
270
|
-
*
|
|
271
|
-
* @type {string}
|
|
272
|
-
* @memberof SettingKeysApiDeleteSettingKey
|
|
273
|
-
*/
|
|
274
|
-
readonly ifMatch: string;
|
|
275
266
|
/**
|
|
276
267
|
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
277
268
|
* @type {string}
|
|
@@ -304,7 +295,7 @@ export interface SettingKeysApiGetSettingKeyRequest {
|
|
|
304
295
|
*/
|
|
305
296
|
readonly version?: number;
|
|
306
297
|
/**
|
|
307
|
-
*
|
|
298
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
308
299
|
* @type {string}
|
|
309
300
|
* @memberof SettingKeysApiGetSettingKey
|
|
310
301
|
*/
|
|
@@ -335,7 +326,7 @@ export interface SettingKeysApiGetSettingKeyBySlugRequest {
|
|
|
335
326
|
*/
|
|
336
327
|
readonly version?: number;
|
|
337
328
|
/**
|
|
338
|
-
*
|
|
329
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
339
330
|
* @type {string}
|
|
340
331
|
* @memberof SettingKeysApiGetSettingKeyBySlug
|
|
341
332
|
*/
|
|
@@ -366,7 +357,7 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
366
357
|
*/
|
|
367
358
|
readonly pageToken?: string;
|
|
368
359
|
/**
|
|
369
|
-
* Filter the response by one or multiple fields.
|
|
360
|
+
* 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>
|
|
370
361
|
* @type {string}
|
|
371
362
|
* @memberof SettingKeysApiListSettingKeys
|
|
372
363
|
*/
|
|
@@ -378,19 +369,19 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
378
369
|
*/
|
|
379
370
|
readonly search?: string;
|
|
380
371
|
/**
|
|
381
|
-
*
|
|
372
|
+
* 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>
|
|
382
373
|
* @type {string}
|
|
383
374
|
* @memberof SettingKeysApiListSettingKeys
|
|
384
375
|
*/
|
|
385
376
|
readonly order?: string;
|
|
386
377
|
/**
|
|
387
|
-
* 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/>
|
|
378
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: definition, values<i>
|
|
388
379
|
* @type {string}
|
|
389
380
|
* @memberof SettingKeysApiListSettingKeys
|
|
390
381
|
*/
|
|
391
382
|
readonly expand?: string;
|
|
392
383
|
/**
|
|
393
|
-
* Filters the response by one or multiple fields.
|
|
384
|
+
* 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>
|
|
394
385
|
* @type {string}
|
|
395
386
|
* @memberof SettingKeysApiListSettingKeys
|
|
396
387
|
*/
|
|
@@ -409,7 +400,7 @@ export interface SettingKeysApiUpdateSettingKeyRequest {
|
|
|
409
400
|
*/
|
|
410
401
|
readonly code: string;
|
|
411
402
|
/**
|
|
412
|
-
*
|
|
403
|
+
* ETag of the latest setting value. Required to prevent lost updates.
|
|
413
404
|
* @type {string}
|
|
414
405
|
* @memberof SettingKeysApiUpdateSettingKey
|
|
415
406
|
*/
|
|
@@ -470,7 +461,7 @@ export declare class SettingKeysApi extends BaseAPI {
|
|
|
470
461
|
*/
|
|
471
462
|
getSettingKeyBySlug(requestParameters: SettingKeysApiGetSettingKeyBySlugRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettingKeyResponseClass, any, {}>>;
|
|
472
463
|
/**
|
|
473
|
-
*
|
|
464
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
474
465
|
* @summary List setting keys
|
|
475
466
|
* @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
|
|
476
467
|
* @param {*} [options] Override http request option.
|