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