@emilgroup/setting-sdk-node 0.3.1-beta.2 → 0.3.1-beta.20

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.
Files changed (71) hide show
  1. package/.openapi-generator/FILES +19 -0
  2. package/README.md +2 -2
  3. package/api/setting-definitions-api.ts +460 -0
  4. package/api/setting-keys-api.ts +868 -0
  5. package/api/setting-values-api.ts +250 -0
  6. package/api.ts +6 -0
  7. package/base.ts +1 -0
  8. package/dist/api/setting-definitions-api.d.ts +263 -0
  9. package/dist/api/setting-definitions-api.js +449 -0
  10. package/dist/api/setting-keys-api.d.ts +490 -0
  11. package/dist/api/setting-keys-api.js +768 -0
  12. package/dist/api/setting-values-api.d.ts +150 -0
  13. package/dist/api/setting-values-api.js +264 -0
  14. package/dist/api.d.ts +3 -0
  15. package/dist/api.js +3 -0
  16. package/dist/base.d.ts +2 -1
  17. package/dist/base.js +1 -0
  18. package/dist/models/create-setting-definition-request-dto.d.ts +93 -0
  19. package/dist/models/create-setting-definition-request-dto.js +53 -0
  20. package/dist/models/create-setting-definition-response-class.d.ts +25 -0
  21. package/dist/models/create-setting-definition-response-class.js +15 -0
  22. package/dist/models/create-setting-key-request-dto.d.ts +36 -0
  23. package/dist/models/create-setting-key-request-dto.js +15 -0
  24. package/dist/models/create-setting-key-response-class.d.ts +25 -0
  25. package/dist/models/create-setting-key-response-class.js +15 -0
  26. package/dist/models/delete-setting-key-response-class.d.ts +24 -0
  27. package/dist/models/delete-setting-key-response-class.js +15 -0
  28. package/dist/models/get-setting-definition-response-class.d.ts +25 -0
  29. package/dist/models/get-setting-definition-response-class.js +15 -0
  30. package/dist/models/get-setting-key-response-class.d.ts +25 -0
  31. package/dist/models/get-setting-key-response-class.js +15 -0
  32. package/dist/models/index.d.ts +16 -0
  33. package/dist/models/index.js +16 -0
  34. package/dist/models/list-public-keys-response-class.d.ts +10 -10
  35. package/dist/models/list-setting-definitions-response-class.d.ts +43 -0
  36. package/dist/models/list-setting-definitions-response-class.js +15 -0
  37. package/dist/models/list-setting-keys-response-class.d.ts +43 -0
  38. package/dist/models/list-setting-keys-response-class.js +15 -0
  39. package/dist/models/list-setting-values-response-class.d.ts +43 -0
  40. package/dist/models/list-setting-values-response-class.js +15 -0
  41. package/dist/models/setting-definition-class.d.ts +124 -0
  42. package/dist/models/setting-definition-class.js +53 -0
  43. package/dist/models/setting-definition-version-class.d.ts +72 -0
  44. package/dist/models/setting-definition-version-class.js +15 -0
  45. package/dist/models/setting-key-class.d.ts +85 -0
  46. package/dist/models/setting-key-class.js +15 -0
  47. package/dist/models/setting-value-class.d.ts +72 -0
  48. package/dist/models/setting-value-class.js +15 -0
  49. package/dist/models/update-setting-key-request-rest-dto.d.ts +30 -0
  50. package/dist/models/update-setting-key-request-rest-dto.js +15 -0
  51. package/dist/models/update-setting-key-response-class.d.ts +25 -0
  52. package/dist/models/update-setting-key-response-class.js +15 -0
  53. package/models/create-setting-definition-request-dto.ts +103 -0
  54. package/models/create-setting-definition-response-class.ts +31 -0
  55. package/models/create-setting-key-request-dto.ts +42 -0
  56. package/models/create-setting-key-response-class.ts +31 -0
  57. package/models/delete-setting-key-response-class.ts +30 -0
  58. package/models/get-setting-definition-response-class.ts +31 -0
  59. package/models/get-setting-key-response-class.ts +31 -0
  60. package/models/index.ts +16 -0
  61. package/models/list-public-keys-response-class.ts +10 -10
  62. package/models/list-setting-definitions-response-class.ts +49 -0
  63. package/models/list-setting-keys-response-class.ts +49 -0
  64. package/models/list-setting-values-response-class.ts +49 -0
  65. package/models/setting-definition-class.ts +134 -0
  66. package/models/setting-definition-version-class.ts +78 -0
  67. package/models/setting-key-class.ts +91 -0
  68. package/models/setting-value-class.ts +78 -0
  69. package/models/update-setting-key-request-rest-dto.ts +36 -0
  70. package/models/update-setting-key-response-class.ts +31 -0
  71. package/package.json +2 -2
@@ -0,0 +1,449 @@
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
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
101
+ * @summary Create the setting definition
102
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
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
+ createSettingDefinition: function (createSettingDefinitionRequestDto, 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 'createSettingDefinitionRequestDto' is not null or undefined
115
+ (0, common_1.assertParamExists)('createSettingDefinition', 'createSettingDefinitionRequestDto', createSettingDefinitionRequestDto);
116
+ localVarPath = "/settingservice/v1/settings/definitions";
117
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
118
+ if (configuration) {
119
+ baseOptions = configuration.baseOptions;
120
+ baseAccessToken = configuration.accessToken;
121
+ }
122
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
123
+ localVarHeaderParameter = {};
124
+ localVarQueryParameter = {};
125
+ // authentication bearer required
126
+ // http bearer authentication required
127
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
128
+ case 1:
129
+ // authentication bearer required
130
+ // http bearer authentication required
131
+ _a.sent();
132
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
133
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
134
+ }
135
+ localVarHeaderParameter['Content-Type'] = 'application/json';
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
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createSettingDefinitionRequestDto, localVarRequestOptions, configuration);
140
+ return [2 /*return*/, {
141
+ url: (0, common_1.toPathString)(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ }];
144
+ }
145
+ });
146
+ });
147
+ },
148
+ /**
149
+ * 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\"
150
+ * @summary Retrieve the setting definition
151
+ * @param {string} code
152
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
+ * @param {*} [options] Override http request option.
154
+ * @throws {RequiredError}
155
+ */
156
+ getSettingDefinition: function (code, authorization, options) {
157
+ if (options === void 0) { options = {}; }
158
+ return __awaiter(_this, void 0, void 0, function () {
159
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
160
+ return __generator(this, function (_a) {
161
+ switch (_a.label) {
162
+ case 0:
163
+ // verify required parameter 'code' is not null or undefined
164
+ (0, common_1.assertParamExists)('getSettingDefinition', 'code', code);
165
+ localVarPath = "/settingservice/v1/settings/definitions/{code}"
166
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
167
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
168
+ if (configuration) {
169
+ baseOptions = configuration.baseOptions;
170
+ baseAccessToken = configuration.accessToken;
171
+ }
172
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
173
+ localVarHeaderParameter = {};
174
+ localVarQueryParameter = {};
175
+ // authentication bearer required
176
+ // http bearer authentication required
177
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
178
+ case 1:
179
+ // authentication bearer required
180
+ // http bearer authentication required
181
+ _a.sent();
182
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
183
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
184
+ }
185
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
186
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
187
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
188
+ return [2 /*return*/, {
189
+ url: (0, common_1.toPathString)(localVarUrlObj),
190
+ options: localVarRequestOptions,
191
+ }];
192
+ }
193
+ });
194
+ });
195
+ },
196
+ /**
197
+ * 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\"
198
+ * @summary List setting definitions
199
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
200
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
201
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
202
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
203
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
204
+ * @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.
205
+ * @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.&lt;br/&gt; &lt;br/&gt;
206
+ * @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.
207
+ * @param {*} [options] Override http request option.
208
+ * @throws {RequiredError}
209
+ */
210
+ listSettingDefinitions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
211
+ if (options === void 0) { options = {}; }
212
+ return __awaiter(_this, void 0, void 0, function () {
213
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
214
+ return __generator(this, function (_a) {
215
+ switch (_a.label) {
216
+ case 0:
217
+ localVarPath = "/settingservice/v1/settings/definitions";
218
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
219
+ if (configuration) {
220
+ baseOptions = configuration.baseOptions;
221
+ baseAccessToken = configuration.accessToken;
222
+ }
223
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
224
+ localVarHeaderParameter = {};
225
+ localVarQueryParameter = {};
226
+ // authentication bearer required
227
+ // http bearer authentication required
228
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
229
+ case 1:
230
+ // authentication bearer required
231
+ // http bearer authentication required
232
+ _a.sent();
233
+ if (pageSize !== undefined) {
234
+ localVarQueryParameter['pageSize'] = pageSize;
235
+ }
236
+ if (pageToken !== undefined) {
237
+ localVarQueryParameter['pageToken'] = pageToken;
238
+ }
239
+ if (filter !== undefined) {
240
+ localVarQueryParameter['filter'] = filter;
241
+ }
242
+ if (search !== undefined) {
243
+ localVarQueryParameter['search'] = search;
244
+ }
245
+ if (order !== undefined) {
246
+ localVarQueryParameter['order'] = order;
247
+ }
248
+ if (expand !== undefined) {
249
+ localVarQueryParameter['expand'] = expand;
250
+ }
251
+ if (filters !== undefined) {
252
+ localVarQueryParameter['filters'] = filters;
253
+ }
254
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
255
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
256
+ }
257
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
258
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
259
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
260
+ return [2 /*return*/, {
261
+ url: (0, common_1.toPathString)(localVarUrlObj),
262
+ options: localVarRequestOptions,
263
+ }];
264
+ }
265
+ });
266
+ });
267
+ },
268
+ };
269
+ };
270
+ exports.SettingDefinitionsApiAxiosParamCreator = SettingDefinitionsApiAxiosParamCreator;
271
+ /**
272
+ * SettingDefinitionsApi - functional programming interface
273
+ * @export
274
+ */
275
+ var SettingDefinitionsApiFp = function (configuration) {
276
+ var localVarAxiosParamCreator = (0, exports.SettingDefinitionsApiAxiosParamCreator)(configuration);
277
+ return {
278
+ /**
279
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
280
+ * @summary Create the setting definition
281
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
282
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
283
+ * @param {*} [options] Override http request option.
284
+ * @throws {RequiredError}
285
+ */
286
+ createSettingDefinition: function (createSettingDefinitionRequestDto, authorization, options) {
287
+ return __awaiter(this, void 0, void 0, function () {
288
+ var localVarAxiosArgs;
289
+ return __generator(this, function (_a) {
290
+ switch (_a.label) {
291
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options)];
292
+ case 1:
293
+ localVarAxiosArgs = _a.sent();
294
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
295
+ }
296
+ });
297
+ });
298
+ },
299
+ /**
300
+ * 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\"
301
+ * @summary Retrieve the setting definition
302
+ * @param {string} code
303
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
304
+ * @param {*} [options] Override http request option.
305
+ * @throws {RequiredError}
306
+ */
307
+ getSettingDefinition: function (code, authorization, options) {
308
+ return __awaiter(this, void 0, void 0, function () {
309
+ var localVarAxiosArgs;
310
+ return __generator(this, function (_a) {
311
+ switch (_a.label) {
312
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, options)];
313
+ case 1:
314
+ localVarAxiosArgs = _a.sent();
315
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
316
+ }
317
+ });
318
+ });
319
+ },
320
+ /**
321
+ * 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\"
322
+ * @summary List setting definitions
323
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
324
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
325
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
326
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
327
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
328
+ * @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.
329
+ * @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.&lt;br/&gt; &lt;br/&gt;
330
+ * @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.
331
+ * @param {*} [options] Override http request option.
332
+ * @throws {RequiredError}
333
+ */
334
+ listSettingDefinitions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
335
+ return __awaiter(this, void 0, void 0, function () {
336
+ var localVarAxiosArgs;
337
+ return __generator(this, function (_a) {
338
+ switch (_a.label) {
339
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listSettingDefinitions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
340
+ case 1:
341
+ localVarAxiosArgs = _a.sent();
342
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
343
+ }
344
+ });
345
+ });
346
+ },
347
+ };
348
+ };
349
+ exports.SettingDefinitionsApiFp = SettingDefinitionsApiFp;
350
+ /**
351
+ * SettingDefinitionsApi - factory interface
352
+ * @export
353
+ */
354
+ var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
355
+ var localVarFp = (0, exports.SettingDefinitionsApiFp)(configuration);
356
+ return {
357
+ /**
358
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
359
+ * @summary Create the setting definition
360
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
361
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ */
365
+ createSettingDefinition: function (createSettingDefinitionRequestDto, authorization, options) {
366
+ return localVarFp.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
367
+ },
368
+ /**
369
+ * 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\"
370
+ * @summary Retrieve the setting definition
371
+ * @param {string} code
372
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
373
+ * @param {*} [options] Override http request option.
374
+ * @throws {RequiredError}
375
+ */
376
+ getSettingDefinition: function (code, authorization, options) {
377
+ return localVarFp.getSettingDefinition(code, authorization, options).then(function (request) { return request(axios, basePath); });
378
+ },
379
+ /**
380
+ * 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\"
381
+ * @summary List setting definitions
382
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
383
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
384
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
385
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
386
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
387
+ * @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.
388
+ * @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.&lt;br/&gt; &lt;br/&gt;
389
+ * @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.
390
+ * @param {*} [options] Override http request option.
391
+ * @throws {RequiredError}
392
+ */
393
+ listSettingDefinitions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
394
+ return localVarFp.listSettingDefinitions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
395
+ },
396
+ };
397
+ };
398
+ exports.SettingDefinitionsApiFactory = SettingDefinitionsApiFactory;
399
+ /**
400
+ * SettingDefinitionsApi - object-oriented interface
401
+ * @export
402
+ * @class SettingDefinitionsApi
403
+ * @extends {BaseAPI}
404
+ */
405
+ var SettingDefinitionsApi = /** @class */ (function (_super) {
406
+ __extends(SettingDefinitionsApi, _super);
407
+ function SettingDefinitionsApi() {
408
+ return _super !== null && _super.apply(this, arguments) || this;
409
+ }
410
+ /**
411
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
412
+ * @summary Create the setting definition
413
+ * @param {SettingDefinitionsApiCreateSettingDefinitionRequest} requestParameters Request parameters.
414
+ * @param {*} [options] Override http request option.
415
+ * @throws {RequiredError}
416
+ * @memberof SettingDefinitionsApi
417
+ */
418
+ SettingDefinitionsApi.prototype.createSettingDefinition = function (requestParameters, options) {
419
+ var _this = this;
420
+ return (0, exports.SettingDefinitionsApiFp)(this.configuration).createSettingDefinition(requestParameters.createSettingDefinitionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
421
+ };
422
+ /**
423
+ * 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\"
424
+ * @summary Retrieve the setting definition
425
+ * @param {SettingDefinitionsApiGetSettingDefinitionRequest} requestParameters Request parameters.
426
+ * @param {*} [options] Override http request option.
427
+ * @throws {RequiredError}
428
+ * @memberof SettingDefinitionsApi
429
+ */
430
+ SettingDefinitionsApi.prototype.getSettingDefinition = function (requestParameters, options) {
431
+ var _this = this;
432
+ return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
433
+ };
434
+ /**
435
+ * 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\"
436
+ * @summary List setting definitions
437
+ * @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
438
+ * @param {*} [options] Override http request option.
439
+ * @throws {RequiredError}
440
+ * @memberof SettingDefinitionsApi
441
+ */
442
+ SettingDefinitionsApi.prototype.listSettingDefinitions = function (requestParameters, options) {
443
+ var _this = this;
444
+ if (requestParameters === void 0) { requestParameters = {}; }
445
+ 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); });
446
+ };
447
+ return SettingDefinitionsApi;
448
+ }(base_1.BaseAPI));
449
+ exports.SettingDefinitionsApi = SettingDefinitionsApi;