@emilgroup/setting-sdk-node 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 +40 -26
- package/api/setting-keys-api.ts +28 -28
- package/api.ts +0 -2
- package/dist/api/setting-definitions-api.d.ts +32 -23
- package/dist/api/setting-definitions-api.js +28 -22
- package/dist/api/setting-keys-api.d.ts +28 -28
- package/dist/api/setting-keys-api.js +22 -22
- package/dist/api.d.ts +0 -1
- package/dist/api.js +0 -1
- package/dist/models/index.d.ts +0 -1
- package/dist/models/index.js +0 -1
- package/dist/models/setting-key-class.d.ts +1 -1
- package/models/index.ts +0 -1
- package/models/setting-key-class.ts +1 -1
- package/package.json +1 -1
- package/api/setting-values-api.ts +0 -250
- package/dist/api/setting-values-api.d.ts +0 -150
- package/dist/api/setting-values-api.js +0 -264
- package/dist/models/list-setting-values-response-class.d.ts +0 -43
- package/dist/models/list-setting-values-response-class.js +0 -15
- package/models/list-setting-values-response-class.ts +0 -49
|
@@ -45,21 +45,22 @@ export declare const SettingDefinitionsApiAxiosParamCreator: (configuration?: Co
|
|
|
45
45
|
* @summary Retrieve the setting definition
|
|
46
46
|
* @param {string} code
|
|
47
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>
|
|
48
49
|
* @param {*} [options] Override http request option.
|
|
49
50
|
* @throws {RequiredError}
|
|
50
51
|
*/
|
|
51
|
-
getSettingDefinition: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
|
+
getSettingDefinition: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52
53
|
/**
|
|
53
|
-
*
|
|
54
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
54
55
|
* @summary List setting definitions
|
|
55
56
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
56
57
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
57
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.
|
|
58
|
-
* @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>
|
|
59
60
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
60
|
-
* @param {string} [order]
|
|
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/>
|
|
62
|
-
* @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>
|
|
63
64
|
* @param {*} [options] Override http request option.
|
|
64
65
|
* @throws {RequiredError}
|
|
65
66
|
*/
|
|
@@ -93,21 +94,22 @@ export declare const SettingDefinitionsApiFp: (configuration?: Configuration) =>
|
|
|
93
94
|
* @summary Retrieve the setting definition
|
|
94
95
|
* @param {string} code
|
|
95
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>
|
|
96
98
|
* @param {*} [options] Override http request option.
|
|
97
99
|
* @throws {RequiredError}
|
|
98
100
|
*/
|
|
99
|
-
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>>;
|
|
100
102
|
/**
|
|
101
|
-
*
|
|
103
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
102
104
|
* @summary List setting definitions
|
|
103
105
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
104
106
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
105
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.
|
|
106
|
-
* @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>
|
|
107
109
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
108
|
-
* @param {string} [order]
|
|
109
|
-
* @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/>
|
|
110
|
-
* @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>
|
|
111
113
|
* @param {*} [options] Override http request option.
|
|
112
114
|
* @throws {RequiredError}
|
|
113
115
|
*/
|
|
@@ -141,21 +143,22 @@ export declare const SettingDefinitionsApiFactory: (configuration?: Configuratio
|
|
|
141
143
|
* @summary Retrieve the setting definition
|
|
142
144
|
* @param {string} code
|
|
143
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>
|
|
144
147
|
* @param {*} [options] Override http request option.
|
|
145
148
|
* @throws {RequiredError}
|
|
146
149
|
*/
|
|
147
|
-
getSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
|
|
150
|
+
getSettingDefinition(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
|
|
148
151
|
/**
|
|
149
|
-
*
|
|
152
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
150
153
|
* @summary List setting definitions
|
|
151
154
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
152
155
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
153
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.
|
|
154
|
-
* @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>
|
|
155
158
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
156
|
-
* @param {string} [order]
|
|
157
|
-
* @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/>
|
|
158
|
-
* @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>
|
|
159
162
|
* @param {*} [options] Override http request option.
|
|
160
163
|
* @throws {RequiredError}
|
|
161
164
|
*/
|
|
@@ -217,6 +220,12 @@ export interface SettingDefinitionsApiGetSettingDefinitionRequest {
|
|
|
217
220
|
* @memberof SettingDefinitionsApiGetSettingDefinition
|
|
218
221
|
*/
|
|
219
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;
|
|
220
229
|
}
|
|
221
230
|
/**
|
|
222
231
|
* Request parameters for listSettingDefinitions operation in SettingDefinitionsApi.
|
|
@@ -243,7 +252,7 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
|
|
|
243
252
|
*/
|
|
244
253
|
readonly pageToken?: string;
|
|
245
254
|
/**
|
|
246
|
-
* 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>
|
|
247
256
|
* @type {string}
|
|
248
257
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
249
258
|
*/
|
|
@@ -255,19 +264,19 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
|
|
|
255
264
|
*/
|
|
256
265
|
readonly search?: string;
|
|
257
266
|
/**
|
|
258
|
-
*
|
|
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>
|
|
259
268
|
* @type {string}
|
|
260
269
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
261
270
|
*/
|
|
262
271
|
readonly order?: string;
|
|
263
272
|
/**
|
|
264
|
-
* 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>
|
|
265
274
|
* @type {string}
|
|
266
275
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
267
276
|
*/
|
|
268
277
|
readonly expand?: string;
|
|
269
278
|
/**
|
|
270
|
-
* 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>
|
|
271
280
|
* @type {string}
|
|
272
281
|
* @memberof SettingDefinitionsApiListSettingDefinitions
|
|
273
282
|
*/
|
|
@@ -308,7 +317,7 @@ export declare class SettingDefinitionsApi extends BaseAPI {
|
|
|
308
317
|
*/
|
|
309
318
|
getSettingDefinition(requestParameters: SettingDefinitionsApiGetSettingDefinitionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettingDefinitionResponseClass, any, {}>>;
|
|
310
319
|
/**
|
|
311
|
-
*
|
|
320
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
312
321
|
* @summary List setting definitions
|
|
313
322
|
* @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
|
|
314
323
|
* @param {*} [options] Override http request option.
|
|
@@ -198,10 +198,11 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
198
198
|
* @summary Retrieve the setting definition
|
|
199
199
|
* @param {string} code
|
|
200
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>
|
|
201
202
|
* @param {*} [options] Override http request option.
|
|
202
203
|
* @throws {RequiredError}
|
|
203
204
|
*/
|
|
204
|
-
getSettingDefinition: function (code, authorization, options) {
|
|
205
|
+
getSettingDefinition: function (code, authorization, expand, options) {
|
|
205
206
|
if (options === void 0) { options = {}; }
|
|
206
207
|
return __awaiter(_this, void 0, void 0, function () {
|
|
207
208
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -227,6 +228,9 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
227
228
|
// authentication bearer required
|
|
228
229
|
// http bearer authentication required
|
|
229
230
|
_a.sent();
|
|
231
|
+
if (expand !== undefined) {
|
|
232
|
+
localVarQueryParameter['expand'] = expand;
|
|
233
|
+
}
|
|
230
234
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
231
235
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
232
236
|
}
|
|
@@ -242,16 +246,16 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
|
242
246
|
});
|
|
243
247
|
},
|
|
244
248
|
/**
|
|
245
|
-
*
|
|
249
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
246
250
|
* @summary List setting definitions
|
|
247
251
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
248
252
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
249
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.
|
|
250
|
-
* @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>
|
|
251
255
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
252
|
-
* @param {string} [order]
|
|
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/>
|
|
254
|
-
* @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>
|
|
255
259
|
* @param {*} [options] Override http request option.
|
|
256
260
|
* @throws {RequiredError}
|
|
257
261
|
*/
|
|
@@ -370,15 +374,16 @@ var SettingDefinitionsApiFp = function (configuration) {
|
|
|
370
374
|
* @summary Retrieve the setting definition
|
|
371
375
|
* @param {string} code
|
|
372
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>
|
|
373
378
|
* @param {*} [options] Override http request option.
|
|
374
379
|
* @throws {RequiredError}
|
|
375
380
|
*/
|
|
376
|
-
getSettingDefinition: function (code, authorization, options) {
|
|
381
|
+
getSettingDefinition: function (code, authorization, expand, options) {
|
|
377
382
|
return __awaiter(this, void 0, void 0, function () {
|
|
378
383
|
var localVarAxiosArgs;
|
|
379
384
|
return __generator(this, function (_a) {
|
|
380
385
|
switch (_a.label) {
|
|
381
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, options)];
|
|
386
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, expand, options)];
|
|
382
387
|
case 1:
|
|
383
388
|
localVarAxiosArgs = _a.sent();
|
|
384
389
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -387,16 +392,16 @@ var SettingDefinitionsApiFp = function (configuration) {
|
|
|
387
392
|
});
|
|
388
393
|
},
|
|
389
394
|
/**
|
|
390
|
-
*
|
|
395
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
391
396
|
* @summary List setting definitions
|
|
392
397
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
393
398
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
394
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.
|
|
395
|
-
* @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>
|
|
396
401
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
397
|
-
* @param {string} [order]
|
|
398
|
-
* @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/>
|
|
399
|
-
* @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>
|
|
400
405
|
* @param {*} [options] Override http request option.
|
|
401
406
|
* @throws {RequiredError}
|
|
402
407
|
*/
|
|
@@ -450,23 +455,24 @@ var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
|
|
|
450
455
|
* @summary Retrieve the setting definition
|
|
451
456
|
* @param {string} code
|
|
452
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>
|
|
453
459
|
* @param {*} [options] Override http request option.
|
|
454
460
|
* @throws {RequiredError}
|
|
455
461
|
*/
|
|
456
|
-
getSettingDefinition: function (code, authorization, options) {
|
|
457
|
-
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); });
|
|
458
464
|
},
|
|
459
465
|
/**
|
|
460
|
-
*
|
|
466
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
461
467
|
* @summary List setting definitions
|
|
462
468
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
463
469
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
464
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.
|
|
465
|
-
* @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>
|
|
466
472
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
467
|
-
* @param {string} [order]
|
|
468
|
-
* @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/>
|
|
469
|
-
* @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>
|
|
470
476
|
* @param {*} [options] Override http request option.
|
|
471
477
|
* @throws {RequiredError}
|
|
472
478
|
*/
|
|
@@ -521,10 +527,10 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
|
|
|
521
527
|
*/
|
|
522
528
|
SettingDefinitionsApi.prototype.getSettingDefinition = function (requestParameters, options) {
|
|
523
529
|
var _this = this;
|
|
524
|
-
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); });
|
|
525
531
|
};
|
|
526
532
|
/**
|
|
527
|
-
*
|
|
533
|
+
* List setting definitions with optional filters, sorting, and pagination. Use expand=versions to include schema version history. **Required Permissions** \"tenant-management.settings.view\"
|
|
528
534
|
* @summary List setting definitions
|
|
529
535
|
* @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
|
|
530
536
|
* @param {*} [options] Override http request option.
|
|
@@ -47,7 +47,7 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
|
|
|
47
47
|
* @param {string} code
|
|
48
48
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
49
49
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
50
|
-
* @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>
|
|
51
51
|
* @param {*} [options] Override http request option.
|
|
52
52
|
* @throws {RequiredError}
|
|
53
53
|
*/
|
|
@@ -58,22 +58,22 @@ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configura
|
|
|
58
58
|
* @param {string} slug
|
|
59
59
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
60
60
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
61
|
-
* @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>
|
|
62
62
|
* @param {*} [options] Override http request option.
|
|
63
63
|
* @throws {RequiredError}
|
|
64
64
|
*/
|
|
65
65
|
getSettingKeyBySlug: (slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
66
|
/**
|
|
67
|
-
*
|
|
67
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
68
68
|
* @summary List setting keys
|
|
69
69
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
70
70
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
71
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.
|
|
72
|
-
* @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>
|
|
73
73
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
74
|
-
* @param {string} [order]
|
|
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/>
|
|
76
|
-
* @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>
|
|
77
77
|
* @param {*} [options] Override http request option.
|
|
78
78
|
* @throws {RequiredError}
|
|
79
79
|
*/
|
|
@@ -118,7 +118,7 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
|
|
|
118
118
|
* @param {string} code
|
|
119
119
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
120
120
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
121
|
-
* @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>
|
|
122
122
|
* @param {*} [options] Override http request option.
|
|
123
123
|
* @throws {RequiredError}
|
|
124
124
|
*/
|
|
@@ -129,22 +129,22 @@ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
|
|
|
129
129
|
* @param {string} slug
|
|
130
130
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
131
131
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
132
|
-
* @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>
|
|
133
133
|
* @param {*} [options] Override http request option.
|
|
134
134
|
* @throws {RequiredError}
|
|
135
135
|
*/
|
|
136
136
|
getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingKeyResponseClass>>;
|
|
137
137
|
/**
|
|
138
|
-
*
|
|
138
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
139
139
|
* @summary List setting keys
|
|
140
140
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
141
141
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
142
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.
|
|
143
|
-
* @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>
|
|
144
144
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
145
|
-
* @param {string} [order]
|
|
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/>
|
|
147
|
-
* @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>
|
|
148
148
|
* @param {*} [options] Override http request option.
|
|
149
149
|
* @throws {RequiredError}
|
|
150
150
|
*/
|
|
@@ -189,7 +189,7 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
|
|
|
189
189
|
* @param {string} code
|
|
190
190
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
191
191
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
192
|
-
* @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>
|
|
193
193
|
* @param {*} [options] Override http request option.
|
|
194
194
|
* @throws {RequiredError}
|
|
195
195
|
*/
|
|
@@ -200,22 +200,22 @@ export declare const SettingKeysApiFactory: (configuration?: Configuration, base
|
|
|
200
200
|
* @param {string} slug
|
|
201
201
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
202
202
|
* @param {number} [version] Specific value version. Defaults to latest.
|
|
203
|
-
* @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>
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
206
206
|
*/
|
|
207
207
|
getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: any): AxiosPromise<GetSettingKeyResponseClass>;
|
|
208
208
|
/**
|
|
209
|
-
*
|
|
209
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
210
210
|
* @summary List setting keys
|
|
211
211
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
212
212
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
213
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.
|
|
214
|
-
* @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>
|
|
215
215
|
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
216
|
-
* @param {string} [order]
|
|
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/>
|
|
218
|
-
* @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>
|
|
219
219
|
* @param {*} [options] Override http request option.
|
|
220
220
|
* @throws {RequiredError}
|
|
221
221
|
*/
|
|
@@ -295,7 +295,7 @@ export interface SettingKeysApiGetSettingKeyRequest {
|
|
|
295
295
|
*/
|
|
296
296
|
readonly version?: number;
|
|
297
297
|
/**
|
|
298
|
-
*
|
|
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>
|
|
299
299
|
* @type {string}
|
|
300
300
|
* @memberof SettingKeysApiGetSettingKey
|
|
301
301
|
*/
|
|
@@ -326,7 +326,7 @@ export interface SettingKeysApiGetSettingKeyBySlugRequest {
|
|
|
326
326
|
*/
|
|
327
327
|
readonly version?: number;
|
|
328
328
|
/**
|
|
329
|
-
*
|
|
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>
|
|
330
330
|
* @type {string}
|
|
331
331
|
* @memberof SettingKeysApiGetSettingKeyBySlug
|
|
332
332
|
*/
|
|
@@ -357,7 +357,7 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
357
357
|
*/
|
|
358
358
|
readonly pageToken?: string;
|
|
359
359
|
/**
|
|
360
|
-
* 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>
|
|
361
361
|
* @type {string}
|
|
362
362
|
* @memberof SettingKeysApiListSettingKeys
|
|
363
363
|
*/
|
|
@@ -369,19 +369,19 @@ export interface SettingKeysApiListSettingKeysRequest {
|
|
|
369
369
|
*/
|
|
370
370
|
readonly search?: string;
|
|
371
371
|
/**
|
|
372
|
-
*
|
|
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>
|
|
373
373
|
* @type {string}
|
|
374
374
|
* @memberof SettingKeysApiListSettingKeys
|
|
375
375
|
*/
|
|
376
376
|
readonly order?: string;
|
|
377
377
|
/**
|
|
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/>
|
|
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>
|
|
379
379
|
* @type {string}
|
|
380
380
|
* @memberof SettingKeysApiListSettingKeys
|
|
381
381
|
*/
|
|
382
382
|
readonly expand?: string;
|
|
383
383
|
/**
|
|
384
|
-
* 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>
|
|
385
385
|
* @type {string}
|
|
386
386
|
* @memberof SettingKeysApiListSettingKeys
|
|
387
387
|
*/
|
|
@@ -461,7 +461,7 @@ export declare class SettingKeysApi extends BaseAPI {
|
|
|
461
461
|
*/
|
|
462
462
|
getSettingKeyBySlug(requestParameters: SettingKeysApiGetSettingKeyBySlugRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettingKeyResponseClass, any, {}>>;
|
|
463
463
|
/**
|
|
464
|
-
*
|
|
464
|
+
* List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
|
|
465
465
|
* @summary List setting keys
|
|
466
466
|
* @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
|
|
467
467
|
* @param {*} [options] Override http request option.
|