@emilgroup/setting-sdk-node 0.3.1-beta.17 → 0.3.1-beta.19

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 (59) hide show
  1. package/.openapi-generator/FILES +15 -0
  2. package/README.md +2 -2
  3. package/api/setting-definitions-api.ts +121 -14
  4. package/api/setting-keys-api.ts +868 -0
  5. package/api/setting-values-api.ts +250 -0
  6. package/api.ts +4 -0
  7. package/dist/api/setting-definitions-api.d.ts +64 -7
  8. package/dist/api/setting-definitions-api.js +106 -13
  9. package/dist/api/setting-keys-api.d.ts +490 -0
  10. package/dist/api/setting-keys-api.js +768 -0
  11. package/dist/api/setting-values-api.d.ts +150 -0
  12. package/dist/api/setting-values-api.js +264 -0
  13. package/dist/api.d.ts +2 -0
  14. package/dist/api.js +2 -0
  15. package/dist/models/create-setting-definition-request-dto.d.ts +93 -0
  16. package/dist/models/create-setting-definition-request-dto.js +53 -0
  17. package/dist/models/create-setting-definition-response-class.d.ts +25 -0
  18. package/dist/models/create-setting-definition-response-class.js +15 -0
  19. package/dist/models/create-setting-key-request-dto.d.ts +36 -0
  20. package/dist/models/create-setting-key-request-dto.js +15 -0
  21. package/dist/models/create-setting-key-response-class.d.ts +25 -0
  22. package/dist/models/create-setting-key-response-class.js +15 -0
  23. package/dist/models/delete-setting-key-response-class.d.ts +24 -0
  24. package/dist/models/delete-setting-key-response-class.js +15 -0
  25. package/dist/models/get-setting-key-response-class.d.ts +25 -0
  26. package/dist/models/get-setting-key-response-class.js +15 -0
  27. package/dist/models/index.d.ts +13 -0
  28. package/dist/models/index.js +13 -0
  29. package/dist/models/list-setting-keys-response-class.d.ts +43 -0
  30. package/dist/models/list-setting-keys-response-class.js +15 -0
  31. package/dist/models/list-setting-values-response-class.d.ts +43 -0
  32. package/dist/models/list-setting-values-response-class.js +15 -0
  33. package/dist/models/setting-definition-class.d.ts +7 -18
  34. package/dist/models/setting-definition-version-class.d.ts +72 -0
  35. package/dist/models/setting-definition-version-class.js +15 -0
  36. package/dist/models/setting-key-class.d.ts +85 -0
  37. package/dist/models/setting-key-class.js +15 -0
  38. package/dist/models/setting-value-class.d.ts +72 -0
  39. package/dist/models/setting-value-class.js +15 -0
  40. package/dist/models/update-setting-key-request-rest-dto.d.ts +30 -0
  41. package/dist/models/update-setting-key-request-rest-dto.js +15 -0
  42. package/dist/models/update-setting-key-response-class.d.ts +25 -0
  43. package/dist/models/update-setting-key-response-class.js +15 -0
  44. package/models/create-setting-definition-request-dto.ts +103 -0
  45. package/models/create-setting-definition-response-class.ts +31 -0
  46. package/models/create-setting-key-request-dto.ts +42 -0
  47. package/models/create-setting-key-response-class.ts +31 -0
  48. package/models/delete-setting-key-response-class.ts +30 -0
  49. package/models/get-setting-key-response-class.ts +31 -0
  50. package/models/index.ts +13 -0
  51. package/models/list-setting-keys-response-class.ts +49 -0
  52. package/models/list-setting-values-response-class.ts +49 -0
  53. package/models/setting-definition-class.ts +7 -18
  54. package/models/setting-definition-version-class.ts +78 -0
  55. package/models/setting-key-class.ts +91 -0
  56. package/models/setting-value-class.ts +78 -0
  57. package/models/update-setting-key-request-rest-dto.ts +36 -0
  58. package/models/update-setting-key-response-class.ts +31 -0
  59. package/package.json +1 -1
@@ -0,0 +1,868 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL SettingService
5
+ * The EMIL SettingService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { CreateSettingKeyRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateSettingKeyResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { DeleteSettingKeyResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { GetSettingKeyResponseClass } from '../models';
31
+ // @ts-ignore
32
+ import { ListSettingKeysResponseClass } from '../models';
33
+ // @ts-ignore
34
+ import { UpdateSettingKeyRequestRestDto } from '../models';
35
+ // @ts-ignore
36
+ import { UpdateSettingKeyResponseClass } from '../models';
37
+ // URLSearchParams not necessarily used
38
+ // @ts-ignore
39
+ import { URL, URLSearchParams } from 'url';
40
+ const FormData = require('form-data');
41
+ /**
42
+ * SettingKeysApi - axios parameter creator
43
+ * @export
44
+ */
45
+ export const SettingKeysApiAxiosParamCreator = function (configuration?: Configuration) {
46
+ return {
47
+ /**
48
+ * Create a new setting key with an initial value **Required Permissions** \"tenant-management.settings.create\"
49
+ * @summary Create the setting key
50
+ * @param {CreateSettingKeyRequestDto} createSettingKeyRequestDto
51
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
52
+ * @param {*} [options] Override http request option.
53
+ * @throws {RequiredError}
54
+ */
55
+ createSettingKey: async (createSettingKeyRequestDto: CreateSettingKeyRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
56
+ // verify required parameter 'createSettingKeyRequestDto' is not null or undefined
57
+ assertParamExists('createSettingKey', 'createSettingKeyRequestDto', createSettingKeyRequestDto)
58
+ const localVarPath = `/settingservice/v2/setting-keys`;
59
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
60
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
61
+ let baseOptions;
62
+ let baseAccessToken;
63
+ if (configuration) {
64
+ baseOptions = configuration.baseOptions;
65
+ baseAccessToken = configuration.accessToken;
66
+ }
67
+
68
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
69
+ const localVarHeaderParameter = {} as any;
70
+ const localVarQueryParameter = {} as any;
71
+
72
+ // authentication bearer required
73
+ // http bearer authentication required
74
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
75
+
76
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
77
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
78
+ }
79
+
80
+
81
+
82
+ localVarHeaderParameter['Content-Type'] = 'application/json';
83
+
84
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
85
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
86
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
87
+ localVarRequestOptions.data = serializeDataIfNeeded(createSettingKeyRequestDto, localVarRequestOptions, configuration)
88
+
89
+ return {
90
+ url: toPathString(localVarUrlObj),
91
+ options: localVarRequestOptions,
92
+ };
93
+ },
94
+ /**
95
+ * undefined **Required Permissions** \"tenant-management.settings.delete\"
96
+ * @param {string} code
97
+ * @param {string} ifMatch
98
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
99
+ * @param {*} [options] Override http request option.
100
+ * @throws {RequiredError}
101
+ */
102
+ deleteSettingKey: async (code: string, ifMatch: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
103
+ // verify required parameter 'code' is not null or undefined
104
+ assertParamExists('deleteSettingKey', 'code', code)
105
+ // verify required parameter 'ifMatch' is not null or undefined
106
+ assertParamExists('deleteSettingKey', 'ifMatch', ifMatch)
107
+ const localVarPath = `/settingservice/v2/setting-keys/{code}`
108
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
109
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
110
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
111
+ let baseOptions;
112
+ let baseAccessToken;
113
+ if (configuration) {
114
+ baseOptions = configuration.baseOptions;
115
+ baseAccessToken = configuration.accessToken;
116
+ }
117
+
118
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
119
+ const localVarHeaderParameter = {} as any;
120
+ const localVarQueryParameter = {} as any;
121
+
122
+ // authentication bearer required
123
+ // http bearer authentication required
124
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
125
+
126
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
127
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
128
+ }
129
+
130
+ if (ifMatch !== undefined && ifMatch !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
131
+ localVarHeaderParameter['if-match'] = String(ifMatch ? ifMatch : baseAccessToken);
132
+ }
133
+
134
+
135
+
136
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
137
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
138
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
139
+
140
+ return {
141
+ url: toPathString(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ };
144
+ },
145
+ /**
146
+ * Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
147
+ * @summary Retrieve the setting key
148
+ * @param {string} code
149
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
150
+ * @param {number} [version] Specific value version. Defaults to latest.
151
+ * @param {string} [expand] Optional expand (definition only).
152
+ * @param {*} [options] Override http request option.
153
+ * @throws {RequiredError}
154
+ */
155
+ getSettingKey: async (code: string, authorization?: string, version?: number, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
156
+ // verify required parameter 'code' is not null or undefined
157
+ assertParamExists('getSettingKey', 'code', code)
158
+ const localVarPath = `/settingservice/v2/setting-keys/{code}`
159
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
160
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
161
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
162
+ let baseOptions;
163
+ let baseAccessToken;
164
+ if (configuration) {
165
+ baseOptions = configuration.baseOptions;
166
+ baseAccessToken = configuration.accessToken;
167
+ }
168
+
169
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
170
+ const localVarHeaderParameter = {} as any;
171
+ const localVarQueryParameter = {} as any;
172
+
173
+ // authentication bearer required
174
+ // http bearer authentication required
175
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
176
+
177
+ if (version !== undefined) {
178
+ localVarQueryParameter['version'] = version;
179
+ }
180
+
181
+ if (expand !== undefined) {
182
+ localVarQueryParameter['expand'] = expand;
183
+ }
184
+
185
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
186
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
187
+ }
188
+
189
+
190
+
191
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
192
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
193
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
194
+
195
+ return {
196
+ url: toPathString(localVarUrlObj),
197
+ options: localVarRequestOptions,
198
+ };
199
+ },
200
+ /**
201
+ * Retrieves the details of the setting key by slug that was previously created. Supply the unique setting key by slug code that was returned when you created it and Emil Api will return the corresponding setting key by slug information. **Required Permissions** \"tenant-management.settings.view\"
202
+ * @summary Retrieve the setting key by slug
203
+ * @param {string} slug
204
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
205
+ * @param {number} [version] Specific value version. Defaults to latest.
206
+ * @param {string} [expand] Optional expand (definition only).
207
+ * @param {*} [options] Override http request option.
208
+ * @throws {RequiredError}
209
+ */
210
+ getSettingKeyBySlug: async (slug: string, authorization?: string, version?: number, expand?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
211
+ // verify required parameter 'slug' is not null or undefined
212
+ assertParamExists('getSettingKeyBySlug', 'slug', slug)
213
+ const localVarPath = `/settingservice/v2/setting-keys/slugs/{slug}`
214
+ .replace(`{${"slug"}}`, encodeURIComponent(String(slug)));
215
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
216
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
217
+ let baseOptions;
218
+ let baseAccessToken;
219
+ if (configuration) {
220
+ baseOptions = configuration.baseOptions;
221
+ baseAccessToken = configuration.accessToken;
222
+ }
223
+
224
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
225
+ const localVarHeaderParameter = {} as any;
226
+ const localVarQueryParameter = {} as any;
227
+
228
+ // authentication bearer required
229
+ // http bearer authentication required
230
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
231
+
232
+ if (version !== undefined) {
233
+ localVarQueryParameter['version'] = version;
234
+ }
235
+
236
+ if (expand !== undefined) {
237
+ localVarQueryParameter['expand'] = expand;
238
+ }
239
+
240
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
241
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
242
+ }
243
+
244
+
245
+
246
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
247
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
248
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
249
+
250
+ return {
251
+ url: toPathString(localVarUrlObj),
252
+ options: localVarRequestOptions,
253
+ };
254
+ },
255
+ /**
256
+ * Returns a list of setting keys you have previously created. The setting keys 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\"
257
+ * @summary List setting keys
258
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
259
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
260
+ * @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.
261
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
262
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
263
+ * @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.
264
+ * @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;
265
+ * @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.
266
+ * @param {*} [options] Override http request option.
267
+ * @throws {RequiredError}
268
+ */
269
+ listSettingKeys: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
270
+ const localVarPath = `/settingservice/v2/setting-keys`;
271
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
272
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
273
+ let baseOptions;
274
+ let baseAccessToken;
275
+ if (configuration) {
276
+ baseOptions = configuration.baseOptions;
277
+ baseAccessToken = configuration.accessToken;
278
+ }
279
+
280
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
281
+ const localVarHeaderParameter = {} as any;
282
+ const localVarQueryParameter = {} as any;
283
+
284
+ // authentication bearer required
285
+ // http bearer authentication required
286
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
287
+
288
+ if (pageSize !== undefined) {
289
+ localVarQueryParameter['pageSize'] = pageSize;
290
+ }
291
+
292
+ if (pageToken !== undefined) {
293
+ localVarQueryParameter['pageToken'] = pageToken;
294
+ }
295
+
296
+ if (filter !== undefined) {
297
+ localVarQueryParameter['filter'] = filter;
298
+ }
299
+
300
+ if (search !== undefined) {
301
+ localVarQueryParameter['search'] = search;
302
+ }
303
+
304
+ if (order !== undefined) {
305
+ localVarQueryParameter['order'] = order;
306
+ }
307
+
308
+ if (expand !== undefined) {
309
+ localVarQueryParameter['expand'] = expand;
310
+ }
311
+
312
+ if (filters !== undefined) {
313
+ localVarQueryParameter['filters'] = filters;
314
+ }
315
+
316
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
317
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
318
+ }
319
+
320
+
321
+
322
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
323
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
324
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
325
+
326
+ return {
327
+ url: toPathString(localVarUrlObj),
328
+ options: localVarRequestOptions,
329
+ };
330
+ },
331
+ /**
332
+ * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
333
+ * @summary Update the setting key
334
+ * @param {string} code
335
+ * @param {string} ifMatch
336
+ * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
337
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
338
+ * @param {*} [options] Override http request option.
339
+ * @throws {RequiredError}
340
+ */
341
+ updateSettingKey: async (code: string, ifMatch: string, updateSettingKeyRequestRestDto: UpdateSettingKeyRequestRestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
342
+ // verify required parameter 'code' is not null or undefined
343
+ assertParamExists('updateSettingKey', 'code', code)
344
+ // verify required parameter 'ifMatch' is not null or undefined
345
+ assertParamExists('updateSettingKey', 'ifMatch', ifMatch)
346
+ // verify required parameter 'updateSettingKeyRequestRestDto' is not null or undefined
347
+ assertParamExists('updateSettingKey', 'updateSettingKeyRequestRestDto', updateSettingKeyRequestRestDto)
348
+ const localVarPath = `/settingservice/v2/setting-keys/{code}`
349
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
350
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
351
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
352
+ let baseOptions;
353
+ let baseAccessToken;
354
+ if (configuration) {
355
+ baseOptions = configuration.baseOptions;
356
+ baseAccessToken = configuration.accessToken;
357
+ }
358
+
359
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
360
+ const localVarHeaderParameter = {} as any;
361
+ const localVarQueryParameter = {} as any;
362
+
363
+ // authentication bearer required
364
+ // http bearer authentication required
365
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
366
+
367
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
368
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
369
+ }
370
+
371
+ if (ifMatch !== undefined && ifMatch !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
372
+ localVarHeaderParameter['if-match'] = String(ifMatch ? ifMatch : baseAccessToken);
373
+ }
374
+
375
+
376
+
377
+ localVarHeaderParameter['Content-Type'] = 'application/json';
378
+
379
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
380
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
381
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
382
+ localVarRequestOptions.data = serializeDataIfNeeded(updateSettingKeyRequestRestDto, localVarRequestOptions, configuration)
383
+
384
+ return {
385
+ url: toPathString(localVarUrlObj),
386
+ options: localVarRequestOptions,
387
+ };
388
+ },
389
+ }
390
+ };
391
+
392
+ /**
393
+ * SettingKeysApi - functional programming interface
394
+ * @export
395
+ */
396
+ export const SettingKeysApiFp = function(configuration?: Configuration) {
397
+ const localVarAxiosParamCreator = SettingKeysApiAxiosParamCreator(configuration)
398
+ return {
399
+ /**
400
+ * Create a new setting key with an initial value **Required Permissions** \"tenant-management.settings.create\"
401
+ * @summary Create the setting key
402
+ * @param {CreateSettingKeyRequestDto} createSettingKeyRequestDto
403
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
404
+ * @param {*} [options] Override http request option.
405
+ * @throws {RequiredError}
406
+ */
407
+ async createSettingKey(createSettingKeyRequestDto: CreateSettingKeyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettingKeyResponseClass>> {
408
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createSettingKey(createSettingKeyRequestDto, authorization, options);
409
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
410
+ },
411
+ /**
412
+ * undefined **Required Permissions** \"tenant-management.settings.delete\"
413
+ * @param {string} code
414
+ * @param {string} ifMatch
415
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
416
+ * @param {*} [options] Override http request option.
417
+ * @throws {RequiredError}
418
+ */
419
+ async deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteSettingKeyResponseClass>> {
420
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteSettingKey(code, ifMatch, authorization, options);
421
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
422
+ },
423
+ /**
424
+ * Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
425
+ * @summary Retrieve the setting key
426
+ * @param {string} code
427
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
428
+ * @param {number} [version] Specific value version. Defaults to latest.
429
+ * @param {string} [expand] Optional expand (definition only).
430
+ * @param {*} [options] Override http request option.
431
+ * @throws {RequiredError}
432
+ */
433
+ async getSettingKey(code: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingKeyResponseClass>> {
434
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingKey(code, authorization, version, expand, options);
435
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
436
+ },
437
+ /**
438
+ * Retrieves the details of the setting key by slug that was previously created. Supply the unique setting key by slug code that was returned when you created it and Emil Api will return the corresponding setting key by slug information. **Required Permissions** \"tenant-management.settings.view\"
439
+ * @summary Retrieve the setting key by slug
440
+ * @param {string} slug
441
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
442
+ * @param {number} [version] Specific value version. Defaults to latest.
443
+ * @param {string} [expand] Optional expand (definition only).
444
+ * @param {*} [options] Override http request option.
445
+ * @throws {RequiredError}
446
+ */
447
+ async getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingKeyResponseClass>> {
448
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingKeyBySlug(slug, authorization, version, expand, options);
449
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
450
+ },
451
+ /**
452
+ * Returns a list of setting keys you have previously created. The setting keys 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\"
453
+ * @summary List setting keys
454
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
455
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
456
+ * @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.
457
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
458
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
459
+ * @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.
460
+ * @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;
461
+ * @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.
462
+ * @param {*} [options] Override http request option.
463
+ * @throws {RequiredError}
464
+ */
465
+ async listSettingKeys(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettingKeysResponseClass>> {
466
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSettingKeys(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
467
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
468
+ },
469
+ /**
470
+ * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
471
+ * @summary Update the setting key
472
+ * @param {string} code
473
+ * @param {string} ifMatch
474
+ * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
475
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
476
+ * @param {*} [options] Override http request option.
477
+ * @throws {RequiredError}
478
+ */
479
+ async updateSettingKey(code: string, ifMatch: string, updateSettingKeyRequestRestDto: UpdateSettingKeyRequestRestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateSettingKeyResponseClass>> {
480
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateSettingKey(code, ifMatch, updateSettingKeyRequestRestDto, authorization, options);
481
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
482
+ },
483
+ }
484
+ };
485
+
486
+ /**
487
+ * SettingKeysApi - factory interface
488
+ * @export
489
+ */
490
+ export const SettingKeysApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
491
+ const localVarFp = SettingKeysApiFp(configuration)
492
+ return {
493
+ /**
494
+ * Create a new setting key with an initial value **Required Permissions** \"tenant-management.settings.create\"
495
+ * @summary Create the setting key
496
+ * @param {CreateSettingKeyRequestDto} createSettingKeyRequestDto
497
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
498
+ * @param {*} [options] Override http request option.
499
+ * @throws {RequiredError}
500
+ */
501
+ createSettingKey(createSettingKeyRequestDto: CreateSettingKeyRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettingKeyResponseClass> {
502
+ return localVarFp.createSettingKey(createSettingKeyRequestDto, authorization, options).then((request) => request(axios, basePath));
503
+ },
504
+ /**
505
+ * undefined **Required Permissions** \"tenant-management.settings.delete\"
506
+ * @param {string} code
507
+ * @param {string} ifMatch
508
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
509
+ * @param {*} [options] Override http request option.
510
+ * @throws {RequiredError}
511
+ */
512
+ deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: any): AxiosPromise<DeleteSettingKeyResponseClass> {
513
+ return localVarFp.deleteSettingKey(code, ifMatch, authorization, options).then((request) => request(axios, basePath));
514
+ },
515
+ /**
516
+ * Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
517
+ * @summary Retrieve the setting key
518
+ * @param {string} code
519
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
520
+ * @param {number} [version] Specific value version. Defaults to latest.
521
+ * @param {string} [expand] Optional expand (definition only).
522
+ * @param {*} [options] Override http request option.
523
+ * @throws {RequiredError}
524
+ */
525
+ getSettingKey(code: string, authorization?: string, version?: number, expand?: string, options?: any): AxiosPromise<GetSettingKeyResponseClass> {
526
+ return localVarFp.getSettingKey(code, authorization, version, expand, options).then((request) => request(axios, basePath));
527
+ },
528
+ /**
529
+ * Retrieves the details of the setting key by slug that was previously created. Supply the unique setting key by slug code that was returned when you created it and Emil Api will return the corresponding setting key by slug information. **Required Permissions** \"tenant-management.settings.view\"
530
+ * @summary Retrieve the setting key by slug
531
+ * @param {string} slug
532
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
533
+ * @param {number} [version] Specific value version. Defaults to latest.
534
+ * @param {string} [expand] Optional expand (definition only).
535
+ * @param {*} [options] Override http request option.
536
+ * @throws {RequiredError}
537
+ */
538
+ getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: any): AxiosPromise<GetSettingKeyResponseClass> {
539
+ return localVarFp.getSettingKeyBySlug(slug, authorization, version, expand, options).then((request) => request(axios, basePath));
540
+ },
541
+ /**
542
+ * Returns a list of setting keys you have previously created. The setting keys 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\"
543
+ * @summary List setting keys
544
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
545
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
546
+ * @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.
547
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
548
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
549
+ * @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.
550
+ * @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;
551
+ * @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.
552
+ * @param {*} [options] Override http request option.
553
+ * @throws {RequiredError}
554
+ */
555
+ listSettingKeys(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingKeysResponseClass> {
556
+ return localVarFp.listSettingKeys(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
557
+ },
558
+ /**
559
+ * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
560
+ * @summary Update the setting key
561
+ * @param {string} code
562
+ * @param {string} ifMatch
563
+ * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
564
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
565
+ * @param {*} [options] Override http request option.
566
+ * @throws {RequiredError}
567
+ */
568
+ updateSettingKey(code: string, ifMatch: string, updateSettingKeyRequestRestDto: UpdateSettingKeyRequestRestDto, authorization?: string, options?: any): AxiosPromise<UpdateSettingKeyResponseClass> {
569
+ return localVarFp.updateSettingKey(code, ifMatch, updateSettingKeyRequestRestDto, authorization, options).then((request) => request(axios, basePath));
570
+ },
571
+ };
572
+ };
573
+
574
+ /**
575
+ * Request parameters for createSettingKey operation in SettingKeysApi.
576
+ * @export
577
+ * @interface SettingKeysApiCreateSettingKeyRequest
578
+ */
579
+ export interface SettingKeysApiCreateSettingKeyRequest {
580
+ /**
581
+ *
582
+ * @type {CreateSettingKeyRequestDto}
583
+ * @memberof SettingKeysApiCreateSettingKey
584
+ */
585
+ readonly createSettingKeyRequestDto: CreateSettingKeyRequestDto
586
+
587
+ /**
588
+ * Bearer Token: provided by the login endpoint under the name accessToken.
589
+ * @type {string}
590
+ * @memberof SettingKeysApiCreateSettingKey
591
+ */
592
+ readonly authorization?: string
593
+ }
594
+
595
+ /**
596
+ * Request parameters for deleteSettingKey operation in SettingKeysApi.
597
+ * @export
598
+ * @interface SettingKeysApiDeleteSettingKeyRequest
599
+ */
600
+ export interface SettingKeysApiDeleteSettingKeyRequest {
601
+ /**
602
+ *
603
+ * @type {string}
604
+ * @memberof SettingKeysApiDeleteSettingKey
605
+ */
606
+ readonly code: string
607
+
608
+ /**
609
+ *
610
+ * @type {string}
611
+ * @memberof SettingKeysApiDeleteSettingKey
612
+ */
613
+ readonly ifMatch: string
614
+
615
+ /**
616
+ * Bearer Token: provided by the login endpoint under the name accessToken.
617
+ * @type {string}
618
+ * @memberof SettingKeysApiDeleteSettingKey
619
+ */
620
+ readonly authorization?: string
621
+ }
622
+
623
+ /**
624
+ * Request parameters for getSettingKey operation in SettingKeysApi.
625
+ * @export
626
+ * @interface SettingKeysApiGetSettingKeyRequest
627
+ */
628
+ export interface SettingKeysApiGetSettingKeyRequest {
629
+ /**
630
+ *
631
+ * @type {string}
632
+ * @memberof SettingKeysApiGetSettingKey
633
+ */
634
+ readonly code: string
635
+
636
+ /**
637
+ * Bearer Token: provided by the login endpoint under the name accessToken.
638
+ * @type {string}
639
+ * @memberof SettingKeysApiGetSettingKey
640
+ */
641
+ readonly authorization?: string
642
+
643
+ /**
644
+ * Specific value version. Defaults to latest.
645
+ * @type {number}
646
+ * @memberof SettingKeysApiGetSettingKey
647
+ */
648
+ readonly version?: number
649
+
650
+ /**
651
+ * Optional expand (definition only).
652
+ * @type {string}
653
+ * @memberof SettingKeysApiGetSettingKey
654
+ */
655
+ readonly expand?: string
656
+ }
657
+
658
+ /**
659
+ * Request parameters for getSettingKeyBySlug operation in SettingKeysApi.
660
+ * @export
661
+ * @interface SettingKeysApiGetSettingKeyBySlugRequest
662
+ */
663
+ export interface SettingKeysApiGetSettingKeyBySlugRequest {
664
+ /**
665
+ *
666
+ * @type {string}
667
+ * @memberof SettingKeysApiGetSettingKeyBySlug
668
+ */
669
+ readonly slug: string
670
+
671
+ /**
672
+ * Bearer Token: provided by the login endpoint under the name accessToken.
673
+ * @type {string}
674
+ * @memberof SettingKeysApiGetSettingKeyBySlug
675
+ */
676
+ readonly authorization?: string
677
+
678
+ /**
679
+ * Specific value version. Defaults to latest.
680
+ * @type {number}
681
+ * @memberof SettingKeysApiGetSettingKeyBySlug
682
+ */
683
+ readonly version?: number
684
+
685
+ /**
686
+ * Optional expand (definition only).
687
+ * @type {string}
688
+ * @memberof SettingKeysApiGetSettingKeyBySlug
689
+ */
690
+ readonly expand?: string
691
+ }
692
+
693
+ /**
694
+ * Request parameters for listSettingKeys operation in SettingKeysApi.
695
+ * @export
696
+ * @interface SettingKeysApiListSettingKeysRequest
697
+ */
698
+ export interface SettingKeysApiListSettingKeysRequest {
699
+ /**
700
+ * Bearer Token: provided by the login endpoint under the name accessToken.
701
+ * @type {string}
702
+ * @memberof SettingKeysApiListSettingKeys
703
+ */
704
+ readonly authorization?: string
705
+
706
+ /**
707
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
708
+ * @type {number}
709
+ * @memberof SettingKeysApiListSettingKeys
710
+ */
711
+ readonly pageSize?: number
712
+
713
+ /**
714
+ * 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.
715
+ * @type {string}
716
+ * @memberof SettingKeysApiListSettingKeys
717
+ */
718
+ readonly pageToken?: string
719
+
720
+ /**
721
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
722
+ * @type {string}
723
+ * @memberof SettingKeysApiListSettingKeys
724
+ */
725
+ readonly filter?: string
726
+
727
+ /**
728
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
729
+ * @type {string}
730
+ * @memberof SettingKeysApiListSettingKeys
731
+ */
732
+ readonly search?: string
733
+
734
+ /**
735
+ * 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.
736
+ * @type {string}
737
+ * @memberof SettingKeysApiListSettingKeys
738
+ */
739
+ readonly order?: string
740
+
741
+ /**
742
+ * 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;
743
+ * @type {string}
744
+ * @memberof SettingKeysApiListSettingKeys
745
+ */
746
+ readonly expand?: string
747
+
748
+ /**
749
+ * 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.
750
+ * @type {string}
751
+ * @memberof SettingKeysApiListSettingKeys
752
+ */
753
+ readonly filters?: string
754
+ }
755
+
756
+ /**
757
+ * Request parameters for updateSettingKey operation in SettingKeysApi.
758
+ * @export
759
+ * @interface SettingKeysApiUpdateSettingKeyRequest
760
+ */
761
+ export interface SettingKeysApiUpdateSettingKeyRequest {
762
+ /**
763
+ *
764
+ * @type {string}
765
+ * @memberof SettingKeysApiUpdateSettingKey
766
+ */
767
+ readonly code: string
768
+
769
+ /**
770
+ *
771
+ * @type {string}
772
+ * @memberof SettingKeysApiUpdateSettingKey
773
+ */
774
+ readonly ifMatch: string
775
+
776
+ /**
777
+ *
778
+ * @type {UpdateSettingKeyRequestRestDto}
779
+ * @memberof SettingKeysApiUpdateSettingKey
780
+ */
781
+ readonly updateSettingKeyRequestRestDto: UpdateSettingKeyRequestRestDto
782
+
783
+ /**
784
+ * Bearer Token: provided by the login endpoint under the name accessToken.
785
+ * @type {string}
786
+ * @memberof SettingKeysApiUpdateSettingKey
787
+ */
788
+ readonly authorization?: string
789
+ }
790
+
791
+ /**
792
+ * SettingKeysApi - object-oriented interface
793
+ * @export
794
+ * @class SettingKeysApi
795
+ * @extends {BaseAPI}
796
+ */
797
+ export class SettingKeysApi extends BaseAPI {
798
+ /**
799
+ * Create a new setting key with an initial value **Required Permissions** \"tenant-management.settings.create\"
800
+ * @summary Create the setting key
801
+ * @param {SettingKeysApiCreateSettingKeyRequest} requestParameters Request parameters.
802
+ * @param {*} [options] Override http request option.
803
+ * @throws {RequiredError}
804
+ * @memberof SettingKeysApi
805
+ */
806
+ public createSettingKey(requestParameters: SettingKeysApiCreateSettingKeyRequest, options?: AxiosRequestConfig) {
807
+ return SettingKeysApiFp(this.configuration).createSettingKey(requestParameters.createSettingKeyRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
808
+ }
809
+
810
+ /**
811
+ * undefined **Required Permissions** \"tenant-management.settings.delete\"
812
+ * @param {SettingKeysApiDeleteSettingKeyRequest} requestParameters Request parameters.
813
+ * @param {*} [options] Override http request option.
814
+ * @throws {RequiredError}
815
+ * @memberof SettingKeysApi
816
+ */
817
+ public deleteSettingKey(requestParameters: SettingKeysApiDeleteSettingKeyRequest, options?: AxiosRequestConfig) {
818
+ return SettingKeysApiFp(this.configuration).deleteSettingKey(requestParameters.code, requestParameters.ifMatch, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
819
+ }
820
+
821
+ /**
822
+ * Retrieves the details of the setting key that was previously created. Supply the unique setting key code that was returned when you created it and Emil Api will return the corresponding setting key information. **Required Permissions** \"tenant-management.settings.view\"
823
+ * @summary Retrieve the setting key
824
+ * @param {SettingKeysApiGetSettingKeyRequest} requestParameters Request parameters.
825
+ * @param {*} [options] Override http request option.
826
+ * @throws {RequiredError}
827
+ * @memberof SettingKeysApi
828
+ */
829
+ public getSettingKey(requestParameters: SettingKeysApiGetSettingKeyRequest, options?: AxiosRequestConfig) {
830
+ return SettingKeysApiFp(this.configuration).getSettingKey(requestParameters.code, requestParameters.authorization, requestParameters.version, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
831
+ }
832
+
833
+ /**
834
+ * Retrieves the details of the setting key by slug that was previously created. Supply the unique setting key by slug code that was returned when you created it and Emil Api will return the corresponding setting key by slug information. **Required Permissions** \"tenant-management.settings.view\"
835
+ * @summary Retrieve the setting key by slug
836
+ * @param {SettingKeysApiGetSettingKeyBySlugRequest} requestParameters Request parameters.
837
+ * @param {*} [options] Override http request option.
838
+ * @throws {RequiredError}
839
+ * @memberof SettingKeysApi
840
+ */
841
+ public getSettingKeyBySlug(requestParameters: SettingKeysApiGetSettingKeyBySlugRequest, options?: AxiosRequestConfig) {
842
+ return SettingKeysApiFp(this.configuration).getSettingKeyBySlug(requestParameters.slug, requestParameters.authorization, requestParameters.version, requestParameters.expand, options).then((request) => request(this.axios, this.basePath));
843
+ }
844
+
845
+ /**
846
+ * Returns a list of setting keys you have previously created. The setting keys 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\"
847
+ * @summary List setting keys
848
+ * @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
849
+ * @param {*} [options] Override http request option.
850
+ * @throws {RequiredError}
851
+ * @memberof SettingKeysApi
852
+ */
853
+ public listSettingKeys(requestParameters: SettingKeysApiListSettingKeysRequest = {}, options?: AxiosRequestConfig) {
854
+ return SettingKeysApiFp(this.configuration).listSettingKeys(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
855
+ }
856
+
857
+ /**
858
+ * Updates the specified setting key by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"tenant-management.settings.update\"
859
+ * @summary Update the setting key
860
+ * @param {SettingKeysApiUpdateSettingKeyRequest} requestParameters Request parameters.
861
+ * @param {*} [options] Override http request option.
862
+ * @throws {RequiredError}
863
+ * @memberof SettingKeysApi
864
+ */
865
+ public updateSettingKey(requestParameters: SettingKeysApiUpdateSettingKeyRequest, options?: AxiosRequestConfig) {
866
+ return SettingKeysApiFp(this.configuration).updateSettingKey(requestParameters.code, requestParameters.ifMatch, requestParameters.updateSettingKeyRequestRestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
867
+ }
868
+ }