@emilgroup/setting-sdk-node 0.3.1-beta.15 → 0.3.1-beta.17
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 +4 -0
- package/README.md +2 -2
- package/api/setting-definitions-api.ts +353 -0
- package/api.ts +2 -0
- package/dist/api/setting-definitions-api.d.ts +206 -0
- package/dist/api/setting-definitions-api.js +356 -0
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/models/get-setting-definition-response-class.d.ts +25 -0
- package/dist/models/get-setting-definition-response-class.js +15 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/list-setting-definitions-response-class.d.ts +43 -0
- package/dist/models/list-setting-definitions-response-class.js +15 -0
- package/dist/models/setting-definition-class.d.ts +135 -0
- package/dist/models/setting-definition-class.js +53 -0
- package/models/get-setting-definition-response-class.ts +31 -0
- package/models/index.ts +3 -0
- package/models/list-setting-definitions-response-class.ts +49 -0
- package/models/setting-definition-class.ts +145 -0
- package/package.json +1 -1
|
@@ -0,0 +1,356 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL SettingService
|
|
6
|
+
* The EMIL SettingService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __extends = (this && this.__extends) || (function () {
|
|
16
|
+
var extendStatics = function (d, b) {
|
|
17
|
+
extendStatics = Object.setPrototypeOf ||
|
|
18
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
19
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
20
|
+
return extendStatics(d, b);
|
|
21
|
+
};
|
|
22
|
+
return function (d, b) {
|
|
23
|
+
if (typeof b !== "function" && b !== null)
|
|
24
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
25
|
+
extendStatics(d, b);
|
|
26
|
+
function __() { this.constructor = d; }
|
|
27
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
28
|
+
};
|
|
29
|
+
})();
|
|
30
|
+
var __assign = (this && this.__assign) || function () {
|
|
31
|
+
__assign = Object.assign || function(t) {
|
|
32
|
+
for (var s, i = 1, n = arguments.length; i < n; i++) {
|
|
33
|
+
s = arguments[i];
|
|
34
|
+
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
|
|
35
|
+
t[p] = s[p];
|
|
36
|
+
}
|
|
37
|
+
return t;
|
|
38
|
+
};
|
|
39
|
+
return __assign.apply(this, arguments);
|
|
40
|
+
};
|
|
41
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
42
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
43
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
44
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
45
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
46
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
47
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
48
|
+
});
|
|
49
|
+
};
|
|
50
|
+
var __generator = (this && this.__generator) || function (thisArg, body) {
|
|
51
|
+
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
|
|
52
|
+
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
|
|
53
|
+
function verb(n) { return function (v) { return step([n, v]); }; }
|
|
54
|
+
function step(op) {
|
|
55
|
+
if (f) throw new TypeError("Generator is already executing.");
|
|
56
|
+
while (g && (g = 0, op[0] && (_ = 0)), _) try {
|
|
57
|
+
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
|
|
58
|
+
if (y = 0, t) op = [op[0] & 2, t.value];
|
|
59
|
+
switch (op[0]) {
|
|
60
|
+
case 0: case 1: t = op; break;
|
|
61
|
+
case 4: _.label++; return { value: op[1], done: false };
|
|
62
|
+
case 5: _.label++; y = op[1]; op = [0]; continue;
|
|
63
|
+
case 7: op = _.ops.pop(); _.trys.pop(); continue;
|
|
64
|
+
default:
|
|
65
|
+
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
|
|
66
|
+
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
|
|
67
|
+
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
|
|
68
|
+
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
|
|
69
|
+
if (t[2]) _.ops.pop();
|
|
70
|
+
_.trys.pop(); continue;
|
|
71
|
+
}
|
|
72
|
+
op = body.call(thisArg, _);
|
|
73
|
+
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
|
|
74
|
+
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
|
|
75
|
+
}
|
|
76
|
+
};
|
|
77
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
78
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
79
|
+
};
|
|
80
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
81
|
+
exports.SettingDefinitionsApi = exports.SettingDefinitionsApiFactory = exports.SettingDefinitionsApiFp = exports.SettingDefinitionsApiAxiosParamCreator = void 0;
|
|
82
|
+
var axios_1 = __importDefault(require("axios"));
|
|
83
|
+
// Some imports not used depending on template conditions
|
|
84
|
+
// @ts-ignore
|
|
85
|
+
var common_1 = require("../common");
|
|
86
|
+
// @ts-ignore
|
|
87
|
+
var base_1 = require("../base");
|
|
88
|
+
// URLSearchParams not necessarily used
|
|
89
|
+
// @ts-ignore
|
|
90
|
+
var url_1 = require("url");
|
|
91
|
+
var FormData = require('form-data');
|
|
92
|
+
/**
|
|
93
|
+
* SettingDefinitionsApi - axios parameter creator
|
|
94
|
+
* @export
|
|
95
|
+
*/
|
|
96
|
+
var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
|
|
97
|
+
var _this = this;
|
|
98
|
+
return {
|
|
99
|
+
/**
|
|
100
|
+
* 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\"
|
|
101
|
+
* @summary Retrieve the setting definition
|
|
102
|
+
* @param {string} key
|
|
103
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
104
|
+
* @param {*} [options] Override http request option.
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
*/
|
|
107
|
+
getSettingDefinition: function (key, authorization, options) {
|
|
108
|
+
if (options === void 0) { options = {}; }
|
|
109
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
110
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
111
|
+
return __generator(this, function (_a) {
|
|
112
|
+
switch (_a.label) {
|
|
113
|
+
case 0:
|
|
114
|
+
// verify required parameter 'key' is not null or undefined
|
|
115
|
+
(0, common_1.assertParamExists)('getSettingDefinition', 'key', key);
|
|
116
|
+
localVarPath = "/settingservice/v1/settings/definitions/{key}"
|
|
117
|
+
.replace("{".concat("key", "}"), encodeURIComponent(String(key)));
|
|
118
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
119
|
+
if (configuration) {
|
|
120
|
+
baseOptions = configuration.baseOptions;
|
|
121
|
+
baseAccessToken = configuration.accessToken;
|
|
122
|
+
}
|
|
123
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
124
|
+
localVarHeaderParameter = {};
|
|
125
|
+
localVarQueryParameter = {};
|
|
126
|
+
// authentication bearer required
|
|
127
|
+
// http bearer authentication required
|
|
128
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
129
|
+
case 1:
|
|
130
|
+
// authentication bearer required
|
|
131
|
+
// http bearer authentication required
|
|
132
|
+
_a.sent();
|
|
133
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
134
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
135
|
+
}
|
|
136
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
137
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
138
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
139
|
+
return [2 /*return*/, {
|
|
140
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
141
|
+
options: localVarRequestOptions,
|
|
142
|
+
}];
|
|
143
|
+
}
|
|
144
|
+
});
|
|
145
|
+
});
|
|
146
|
+
},
|
|
147
|
+
/**
|
|
148
|
+
* Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
|
|
149
|
+
* @summary List setting definitions
|
|
150
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
151
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
152
|
+
* @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.
|
|
153
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
154
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
155
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
156
|
+
* @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/>
|
|
157
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
158
|
+
* @param {*} [options] Override http request option.
|
|
159
|
+
* @throws {RequiredError}
|
|
160
|
+
*/
|
|
161
|
+
listSettingDefinitions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
162
|
+
if (options === void 0) { options = {}; }
|
|
163
|
+
return __awaiter(_this, void 0, void 0, function () {
|
|
164
|
+
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
165
|
+
return __generator(this, function (_a) {
|
|
166
|
+
switch (_a.label) {
|
|
167
|
+
case 0:
|
|
168
|
+
localVarPath = "/settingservice/v1/settings/definitions";
|
|
169
|
+
localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
170
|
+
if (configuration) {
|
|
171
|
+
baseOptions = configuration.baseOptions;
|
|
172
|
+
baseAccessToken = configuration.accessToken;
|
|
173
|
+
}
|
|
174
|
+
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
175
|
+
localVarHeaderParameter = {};
|
|
176
|
+
localVarQueryParameter = {};
|
|
177
|
+
// authentication bearer required
|
|
178
|
+
// http bearer authentication required
|
|
179
|
+
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
180
|
+
case 1:
|
|
181
|
+
// authentication bearer required
|
|
182
|
+
// http bearer authentication required
|
|
183
|
+
_a.sent();
|
|
184
|
+
if (pageSize !== undefined) {
|
|
185
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
186
|
+
}
|
|
187
|
+
if (pageToken !== undefined) {
|
|
188
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
189
|
+
}
|
|
190
|
+
if (filter !== undefined) {
|
|
191
|
+
localVarQueryParameter['filter'] = filter;
|
|
192
|
+
}
|
|
193
|
+
if (search !== undefined) {
|
|
194
|
+
localVarQueryParameter['search'] = search;
|
|
195
|
+
}
|
|
196
|
+
if (order !== undefined) {
|
|
197
|
+
localVarQueryParameter['order'] = order;
|
|
198
|
+
}
|
|
199
|
+
if (expand !== undefined) {
|
|
200
|
+
localVarQueryParameter['expand'] = expand;
|
|
201
|
+
}
|
|
202
|
+
if (filters !== undefined) {
|
|
203
|
+
localVarQueryParameter['filters'] = filters;
|
|
204
|
+
}
|
|
205
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
206
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
207
|
+
}
|
|
208
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
209
|
+
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
210
|
+
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
211
|
+
return [2 /*return*/, {
|
|
212
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
213
|
+
options: localVarRequestOptions,
|
|
214
|
+
}];
|
|
215
|
+
}
|
|
216
|
+
});
|
|
217
|
+
});
|
|
218
|
+
},
|
|
219
|
+
};
|
|
220
|
+
};
|
|
221
|
+
exports.SettingDefinitionsApiAxiosParamCreator = SettingDefinitionsApiAxiosParamCreator;
|
|
222
|
+
/**
|
|
223
|
+
* SettingDefinitionsApi - functional programming interface
|
|
224
|
+
* @export
|
|
225
|
+
*/
|
|
226
|
+
var SettingDefinitionsApiFp = function (configuration) {
|
|
227
|
+
var localVarAxiosParamCreator = (0, exports.SettingDefinitionsApiAxiosParamCreator)(configuration);
|
|
228
|
+
return {
|
|
229
|
+
/**
|
|
230
|
+
* 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\"
|
|
231
|
+
* @summary Retrieve the setting definition
|
|
232
|
+
* @param {string} key
|
|
233
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
234
|
+
* @param {*} [options] Override http request option.
|
|
235
|
+
* @throws {RequiredError}
|
|
236
|
+
*/
|
|
237
|
+
getSettingDefinition: function (key, authorization, options) {
|
|
238
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
239
|
+
var localVarAxiosArgs;
|
|
240
|
+
return __generator(this, function (_a) {
|
|
241
|
+
switch (_a.label) {
|
|
242
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(key, authorization, options)];
|
|
243
|
+
case 1:
|
|
244
|
+
localVarAxiosArgs = _a.sent();
|
|
245
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
246
|
+
}
|
|
247
|
+
});
|
|
248
|
+
});
|
|
249
|
+
},
|
|
250
|
+
/**
|
|
251
|
+
* Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
|
|
252
|
+
* @summary List setting definitions
|
|
253
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
254
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
255
|
+
* @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.
|
|
256
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
257
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
258
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
259
|
+
* @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/>
|
|
260
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
261
|
+
* @param {*} [options] Override http request option.
|
|
262
|
+
* @throws {RequiredError}
|
|
263
|
+
*/
|
|
264
|
+
listSettingDefinitions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
265
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
266
|
+
var localVarAxiosArgs;
|
|
267
|
+
return __generator(this, function (_a) {
|
|
268
|
+
switch (_a.label) {
|
|
269
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listSettingDefinitions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
270
|
+
case 1:
|
|
271
|
+
localVarAxiosArgs = _a.sent();
|
|
272
|
+
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
273
|
+
}
|
|
274
|
+
});
|
|
275
|
+
});
|
|
276
|
+
},
|
|
277
|
+
};
|
|
278
|
+
};
|
|
279
|
+
exports.SettingDefinitionsApiFp = SettingDefinitionsApiFp;
|
|
280
|
+
/**
|
|
281
|
+
* SettingDefinitionsApi - factory interface
|
|
282
|
+
* @export
|
|
283
|
+
*/
|
|
284
|
+
var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
|
|
285
|
+
var localVarFp = (0, exports.SettingDefinitionsApiFp)(configuration);
|
|
286
|
+
return {
|
|
287
|
+
/**
|
|
288
|
+
* 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\"
|
|
289
|
+
* @summary Retrieve the setting definition
|
|
290
|
+
* @param {string} key
|
|
291
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
292
|
+
* @param {*} [options] Override http request option.
|
|
293
|
+
* @throws {RequiredError}
|
|
294
|
+
*/
|
|
295
|
+
getSettingDefinition: function (key, authorization, options) {
|
|
296
|
+
return localVarFp.getSettingDefinition(key, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
297
|
+
},
|
|
298
|
+
/**
|
|
299
|
+
* Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
|
|
300
|
+
* @summary List setting definitions
|
|
301
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
302
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
303
|
+
* @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.
|
|
304
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
|
|
305
|
+
* @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
|
|
306
|
+
* @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
|
|
307
|
+
* @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/>
|
|
308
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
|
|
309
|
+
* @param {*} [options] Override http request option.
|
|
310
|
+
* @throws {RequiredError}
|
|
311
|
+
*/
|
|
312
|
+
listSettingDefinitions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
313
|
+
return localVarFp.listSettingDefinitions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
314
|
+
},
|
|
315
|
+
};
|
|
316
|
+
};
|
|
317
|
+
exports.SettingDefinitionsApiFactory = SettingDefinitionsApiFactory;
|
|
318
|
+
/**
|
|
319
|
+
* SettingDefinitionsApi - object-oriented interface
|
|
320
|
+
* @export
|
|
321
|
+
* @class SettingDefinitionsApi
|
|
322
|
+
* @extends {BaseAPI}
|
|
323
|
+
*/
|
|
324
|
+
var SettingDefinitionsApi = /** @class */ (function (_super) {
|
|
325
|
+
__extends(SettingDefinitionsApi, _super);
|
|
326
|
+
function SettingDefinitionsApi() {
|
|
327
|
+
return _super !== null && _super.apply(this, arguments) || this;
|
|
328
|
+
}
|
|
329
|
+
/**
|
|
330
|
+
* 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\"
|
|
331
|
+
* @summary Retrieve the setting definition
|
|
332
|
+
* @param {SettingDefinitionsApiGetSettingDefinitionRequest} requestParameters Request parameters.
|
|
333
|
+
* @param {*} [options] Override http request option.
|
|
334
|
+
* @throws {RequiredError}
|
|
335
|
+
* @memberof SettingDefinitionsApi
|
|
336
|
+
*/
|
|
337
|
+
SettingDefinitionsApi.prototype.getSettingDefinition = function (requestParameters, options) {
|
|
338
|
+
var _this = this;
|
|
339
|
+
return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.key, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
|
|
343
|
+
* @summary List setting definitions
|
|
344
|
+
* @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
|
|
345
|
+
* @param {*} [options] Override http request option.
|
|
346
|
+
* @throws {RequiredError}
|
|
347
|
+
* @memberof SettingDefinitionsApi
|
|
348
|
+
*/
|
|
349
|
+
SettingDefinitionsApi.prototype.listSettingDefinitions = function (requestParameters, options) {
|
|
350
|
+
var _this = this;
|
|
351
|
+
if (requestParameters === void 0) { requestParameters = {}; }
|
|
352
|
+
return (0, exports.SettingDefinitionsApiFp)(this.configuration).listSettingDefinitions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
353
|
+
};
|
|
354
|
+
return SettingDefinitionsApi;
|
|
355
|
+
}(base_1.BaseAPI));
|
|
356
|
+
exports.SettingDefinitionsApi = SettingDefinitionsApi;
|
package/dist/api.d.ts
CHANGED
package/dist/api.js
CHANGED
|
@@ -29,3 +29,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
29
29
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
30
30
|
__exportStar(require("./api/health-api"), exports);
|
|
31
31
|
__exportStar(require("./api/public-keys-api"), exports);
|
|
32
|
+
__exportStar(require("./api/setting-definitions-api"), exports);
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL SettingService
|
|
3
|
+
* The EMIL SettingService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { SettingDefinitionClass } from './setting-definition-class';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface GetSettingDefinitionResponseClass
|
|
17
|
+
*/
|
|
18
|
+
export interface GetSettingDefinitionResponseClass {
|
|
19
|
+
/**
|
|
20
|
+
*
|
|
21
|
+
* @type {SettingDefinitionClass}
|
|
22
|
+
* @memberof GetSettingDefinitionResponseClass
|
|
23
|
+
*/
|
|
24
|
+
'definition': SettingDefinitionClass;
|
|
25
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL SettingService
|
|
6
|
+
* The EMIL SettingService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
package/dist/models/index.d.ts
CHANGED
|
@@ -2,10 +2,13 @@ export * from './create-public-key-request-dto';
|
|
|
2
2
|
export * from './create-public-key-response-class';
|
|
3
3
|
export * from './delete-public-key-request-dto';
|
|
4
4
|
export * from './get-public-key-response-class';
|
|
5
|
+
export * from './get-setting-definition-response-class';
|
|
5
6
|
export * from './inline-response200';
|
|
6
7
|
export * from './inline-response503';
|
|
7
8
|
export * from './list-public-keys-response-class';
|
|
9
|
+
export * from './list-setting-definitions-response-class';
|
|
8
10
|
export * from './public-key-class';
|
|
9
11
|
export * from './rotate-public-key-response-class';
|
|
12
|
+
export * from './setting-definition-class';
|
|
10
13
|
export * from './update-public-key-request-dto';
|
|
11
14
|
export * from './update-public-key-response-class';
|
package/dist/models/index.js
CHANGED
|
@@ -18,10 +18,13 @@ __exportStar(require("./create-public-key-request-dto"), exports);
|
|
|
18
18
|
__exportStar(require("./create-public-key-response-class"), exports);
|
|
19
19
|
__exportStar(require("./delete-public-key-request-dto"), exports);
|
|
20
20
|
__exportStar(require("./get-public-key-response-class"), exports);
|
|
21
|
+
__exportStar(require("./get-setting-definition-response-class"), exports);
|
|
21
22
|
__exportStar(require("./inline-response200"), exports);
|
|
22
23
|
__exportStar(require("./inline-response503"), exports);
|
|
23
24
|
__exportStar(require("./list-public-keys-response-class"), exports);
|
|
25
|
+
__exportStar(require("./list-setting-definitions-response-class"), exports);
|
|
24
26
|
__exportStar(require("./public-key-class"), exports);
|
|
25
27
|
__exportStar(require("./rotate-public-key-response-class"), exports);
|
|
28
|
+
__exportStar(require("./setting-definition-class"), exports);
|
|
26
29
|
__exportStar(require("./update-public-key-request-dto"), exports);
|
|
27
30
|
__exportStar(require("./update-public-key-response-class"), exports);
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL SettingService
|
|
3
|
+
* The EMIL SettingService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { SettingDefinitionClass } from './setting-definition-class';
|
|
13
|
+
/**
|
|
14
|
+
*
|
|
15
|
+
* @export
|
|
16
|
+
* @interface ListSettingDefinitionsResponseClass
|
|
17
|
+
*/
|
|
18
|
+
export interface ListSettingDefinitionsResponseClass {
|
|
19
|
+
/**
|
|
20
|
+
* Next page token.
|
|
21
|
+
* @type {string}
|
|
22
|
+
* @memberof ListSettingDefinitionsResponseClass
|
|
23
|
+
*/
|
|
24
|
+
'nextPageToken': string;
|
|
25
|
+
/**
|
|
26
|
+
* Total amount of items.
|
|
27
|
+
* @type {number}
|
|
28
|
+
* @memberof ListSettingDefinitionsResponseClass
|
|
29
|
+
*/
|
|
30
|
+
'totalItems': number;
|
|
31
|
+
/**
|
|
32
|
+
* Items per page.
|
|
33
|
+
* @type {number}
|
|
34
|
+
* @memberof ListSettingDefinitionsResponseClass
|
|
35
|
+
*/
|
|
36
|
+
'itemsPerPage': number;
|
|
37
|
+
/**
|
|
38
|
+
* An array of setting definition entities containing all definition details including code, key, and audit information
|
|
39
|
+
* @type {Array<SettingDefinitionClass>}
|
|
40
|
+
* @memberof ListSettingDefinitionsResponseClass
|
|
41
|
+
*/
|
|
42
|
+
'items': Array<SettingDefinitionClass>;
|
|
43
|
+
}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* EMIL SettingService
|
|
6
|
+
* The EMIL SettingService API description
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0
|
|
9
|
+
* Contact: kontakt@emil.de
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* EMIL SettingService
|
|
3
|
+
* The EMIL SettingService API description
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0
|
|
6
|
+
* Contact: kontakt@emil.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SettingDefinitionClass
|
|
16
|
+
*/
|
|
17
|
+
export interface SettingDefinitionClass {
|
|
18
|
+
/**
|
|
19
|
+
*
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof SettingDefinitionClass
|
|
22
|
+
*/
|
|
23
|
+
'id': number;
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SettingDefinitionClass
|
|
28
|
+
*/
|
|
29
|
+
'code': string;
|
|
30
|
+
/**
|
|
31
|
+
* Global: {service}.global.{name}. Tenant: slug (e.g. tax_config).
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof SettingDefinitionClass
|
|
34
|
+
*/
|
|
35
|
+
'definitionKey': string;
|
|
36
|
+
/**
|
|
37
|
+
* Backend service for global definitions; omitted for tenant definitions.
|
|
38
|
+
* @type {string}
|
|
39
|
+
* @memberof SettingDefinitionClass
|
|
40
|
+
*/
|
|
41
|
+
'ownerService'?: SettingDefinitionClassOwnerServiceEnum;
|
|
42
|
+
/**
|
|
43
|
+
*
|
|
44
|
+
* @type {string}
|
|
45
|
+
* @memberof SettingDefinitionClass
|
|
46
|
+
*/
|
|
47
|
+
'scope': SettingDefinitionClassScopeEnum;
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @type {object}
|
|
51
|
+
* @memberof SettingDefinitionClass
|
|
52
|
+
*/
|
|
53
|
+
'uiHints': object;
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @type {boolean}
|
|
57
|
+
* @memberof SettingDefinitionClass
|
|
58
|
+
*/
|
|
59
|
+
'isSecured': boolean;
|
|
60
|
+
/**
|
|
61
|
+
* Monotonic schema version. Incremented on each definition write that changes the schema snapshot.
|
|
62
|
+
* @type {number}
|
|
63
|
+
* @memberof SettingDefinitionClass
|
|
64
|
+
*/
|
|
65
|
+
'version': number;
|
|
66
|
+
/**
|
|
67
|
+
*
|
|
68
|
+
* @type {string}
|
|
69
|
+
* @memberof SettingDefinitionClass
|
|
70
|
+
*/
|
|
71
|
+
'schemaHash': string;
|
|
72
|
+
/**
|
|
73
|
+
* Time at which the object was created.
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @memberof SettingDefinitionClass
|
|
76
|
+
*/
|
|
77
|
+
'createdAt': string;
|
|
78
|
+
/**
|
|
79
|
+
* Time at which the object was updated.
|
|
80
|
+
* @type {string}
|
|
81
|
+
* @memberof SettingDefinitionClass
|
|
82
|
+
*/
|
|
83
|
+
'updatedAt': string;
|
|
84
|
+
/**
|
|
85
|
+
* Identifier of the user who created the record.
|
|
86
|
+
* @type {string}
|
|
87
|
+
* @memberof SettingDefinitionClass
|
|
88
|
+
*/
|
|
89
|
+
'createdBy': string;
|
|
90
|
+
/**
|
|
91
|
+
* Identifier of the user who last updated the record.
|
|
92
|
+
* @type {string}
|
|
93
|
+
* @memberof SettingDefinitionClass
|
|
94
|
+
*/
|
|
95
|
+
'updatedBy': string;
|
|
96
|
+
}
|
|
97
|
+
export declare const SettingDefinitionClassOwnerServiceEnum: {
|
|
98
|
+
readonly Insuranceservice: "insuranceservice";
|
|
99
|
+
readonly Accountservice: "accountservice";
|
|
100
|
+
readonly Partnerservice: "partnerservice";
|
|
101
|
+
readonly Partnerportalservice: "partnerportalservice";
|
|
102
|
+
readonly Claimservice: "claimservice";
|
|
103
|
+
readonly Customerservice: "customerservice";
|
|
104
|
+
readonly Gdvservice: "gdvservice";
|
|
105
|
+
readonly Productsyncservice: "productsyncservice";
|
|
106
|
+
readonly Riskzoneservice: "riskzoneservice";
|
|
107
|
+
readonly Discountservice: "discountservice";
|
|
108
|
+
readonly Premiumcalculationservice: "premiumcalculationservice";
|
|
109
|
+
readonly Commissionservice: "commissionservice";
|
|
110
|
+
readonly Accountingservice: "accountingservice";
|
|
111
|
+
readonly Billingservice: "billingservice";
|
|
112
|
+
readonly Paymentservice: "paymentservice";
|
|
113
|
+
readonly Dunningservice: "dunningservice";
|
|
114
|
+
readonly Authservice: "authservice";
|
|
115
|
+
readonly Notificationservice: "notificationservice";
|
|
116
|
+
readonly Numbergenerator: "numbergenerator";
|
|
117
|
+
readonly Policyadministrationservice: "policyadministrationservice";
|
|
118
|
+
readonly Policydecisionservice: "policydecisionservice";
|
|
119
|
+
readonly Processmanagerservice: "processmanagerservice";
|
|
120
|
+
readonly Tenantservice: "tenantservice";
|
|
121
|
+
readonly Documentservice: "documentservice";
|
|
122
|
+
readonly Commentingservice: "commentingservice";
|
|
123
|
+
readonly Taskservice: "taskservice";
|
|
124
|
+
readonly Actionservice: "actionservice";
|
|
125
|
+
readonly Webhookservice: "webhookservice";
|
|
126
|
+
readonly Changelogservice: "changelogservice";
|
|
127
|
+
readonly Validationrulesservice: "validationrulesservice";
|
|
128
|
+
};
|
|
129
|
+
export type SettingDefinitionClassOwnerServiceEnum = typeof SettingDefinitionClassOwnerServiceEnum[keyof typeof SettingDefinitionClassOwnerServiceEnum];
|
|
130
|
+
export declare const SettingDefinitionClassScopeEnum: {
|
|
131
|
+
readonly Product: "product";
|
|
132
|
+
readonly Infrastructure: "infrastructure";
|
|
133
|
+
readonly Finance: "finance";
|
|
134
|
+
};
|
|
135
|
+
export type SettingDefinitionClassScopeEnum = typeof SettingDefinitionClassScopeEnum[keyof typeof SettingDefinitionClassScopeEnum];
|