@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,490 @@
1
+ /**
2
+ * EMIL SettingService
3
+ * The EMIL SettingService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateSettingKeyRequestDto } from '../models';
16
+ import { CreateSettingKeyResponseClass } from '../models';
17
+ import { DeleteSettingKeyResponseClass } from '../models';
18
+ import { GetSettingKeyResponseClass } from '../models';
19
+ import { ListSettingKeysResponseClass } from '../models';
20
+ import { UpdateSettingKeyRequestRestDto } from '../models';
21
+ import { UpdateSettingKeyResponseClass } from '../models';
22
+ /**
23
+ * SettingKeysApi - axios parameter creator
24
+ * @export
25
+ */
26
+ export declare const SettingKeysApiAxiosParamCreator: (configuration?: Configuration) => {
27
+ /**
28
+ * Create a new setting key with an initial value **Required Permissions** \"tenant-management.settings.create\"
29
+ * @summary Create the setting key
30
+ * @param {CreateSettingKeyRequestDto} createSettingKeyRequestDto
31
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
32
+ * @param {*} [options] Override http request option.
33
+ * @throws {RequiredError}
34
+ */
35
+ createSettingKey: (createSettingKeyRequestDto: CreateSettingKeyRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
+ /**
37
+ * undefined **Required Permissions** \"tenant-management.settings.delete\"
38
+ * @param {string} code
39
+ * @param {string} ifMatch
40
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
41
+ * @param {*} [options] Override http request option.
42
+ * @throws {RequiredError}
43
+ */
44
+ deleteSettingKey: (code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
+ /**
46
+ * 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\"
47
+ * @summary Retrieve the setting key
48
+ * @param {string} code
49
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
50
+ * @param {number} [version] Specific value version. Defaults to latest.
51
+ * @param {string} [expand] Optional expand (definition only).
52
+ * @param {*} [options] Override http request option.
53
+ * @throws {RequiredError}
54
+ */
55
+ getSettingKey: (code: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56
+ /**
57
+ * 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\"
58
+ * @summary Retrieve the setting key by slug
59
+ * @param {string} slug
60
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
61
+ * @param {number} [version] Specific value version. Defaults to latest.
62
+ * @param {string} [expand] Optional expand (definition only).
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ */
66
+ getSettingKeyBySlug: (slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
67
+ /**
68
+ * 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\"
69
+ * @summary List setting keys
70
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
71
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
72
+ * @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.
73
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
74
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
75
+ * @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.
76
+ * @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;
77
+ * @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.
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ listSettingKeys: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
82
+ /**
83
+ * 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\"
84
+ * @summary Update the setting key
85
+ * @param {string} code
86
+ * @param {string} ifMatch
87
+ * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
88
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ updateSettingKey: (code: string, ifMatch: string, updateSettingKeyRequestRestDto: UpdateSettingKeyRequestRestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
93
+ };
94
+ /**
95
+ * SettingKeysApi - functional programming interface
96
+ * @export
97
+ */
98
+ export declare const SettingKeysApiFp: (configuration?: Configuration) => {
99
+ /**
100
+ * Create a new setting key with an initial value **Required Permissions** \"tenant-management.settings.create\"
101
+ * @summary Create the setting key
102
+ * @param {CreateSettingKeyRequestDto} createSettingKeyRequestDto
103
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
104
+ * @param {*} [options] Override http request option.
105
+ * @throws {RequiredError}
106
+ */
107
+ createSettingKey(createSettingKeyRequestDto: CreateSettingKeyRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettingKeyResponseClass>>;
108
+ /**
109
+ * undefined **Required Permissions** \"tenant-management.settings.delete\"
110
+ * @param {string} code
111
+ * @param {string} ifMatch
112
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
113
+ * @param {*} [options] Override http request option.
114
+ * @throws {RequiredError}
115
+ */
116
+ deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteSettingKeyResponseClass>>;
117
+ /**
118
+ * 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\"
119
+ * @summary Retrieve the setting key
120
+ * @param {string} code
121
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
122
+ * @param {number} [version] Specific value version. Defaults to latest.
123
+ * @param {string} [expand] Optional expand (definition only).
124
+ * @param {*} [options] Override http request option.
125
+ * @throws {RequiredError}
126
+ */
127
+ getSettingKey(code: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingKeyResponseClass>>;
128
+ /**
129
+ * 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\"
130
+ * @summary Retrieve the setting key by slug
131
+ * @param {string} slug
132
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
+ * @param {number} [version] Specific value version. Defaults to latest.
134
+ * @param {string} [expand] Optional expand (definition only).
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ */
138
+ getSettingKeyBySlug(slug: string, authorization?: string, version?: number, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingKeyResponseClass>>;
139
+ /**
140
+ * 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\"
141
+ * @summary List setting keys
142
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
143
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
144
+ * @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.
145
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
146
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
147
+ * @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.
148
+ * @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;
149
+ * @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.
150
+ * @param {*} [options] Override http request option.
151
+ * @throws {RequiredError}
152
+ */
153
+ 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>>;
154
+ /**
155
+ * 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\"
156
+ * @summary Update the setting key
157
+ * @param {string} code
158
+ * @param {string} ifMatch
159
+ * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
160
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ */
164
+ updateSettingKey(code: string, ifMatch: string, updateSettingKeyRequestRestDto: UpdateSettingKeyRequestRestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateSettingKeyResponseClass>>;
165
+ };
166
+ /**
167
+ * SettingKeysApi - factory interface
168
+ * @export
169
+ */
170
+ export declare const SettingKeysApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
171
+ /**
172
+ * Create a new setting key with an initial value **Required Permissions** \"tenant-management.settings.create\"
173
+ * @summary Create the setting key
174
+ * @param {CreateSettingKeyRequestDto} createSettingKeyRequestDto
175
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
176
+ * @param {*} [options] Override http request option.
177
+ * @throws {RequiredError}
178
+ */
179
+ createSettingKey(createSettingKeyRequestDto: CreateSettingKeyRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettingKeyResponseClass>;
180
+ /**
181
+ * undefined **Required Permissions** \"tenant-management.settings.delete\"
182
+ * @param {string} code
183
+ * @param {string} ifMatch
184
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
185
+ * @param {*} [options] Override http request option.
186
+ * @throws {RequiredError}
187
+ */
188
+ deleteSettingKey(code: string, ifMatch: string, authorization?: string, options?: any): AxiosPromise<DeleteSettingKeyResponseClass>;
189
+ /**
190
+ * 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\"
191
+ * @summary Retrieve the setting key
192
+ * @param {string} code
193
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
194
+ * @param {number} [version] Specific value version. Defaults to latest.
195
+ * @param {string} [expand] Optional expand (definition only).
196
+ * @param {*} [options] Override http request option.
197
+ * @throws {RequiredError}
198
+ */
199
+ getSettingKey(code: string, authorization?: string, version?: number, expand?: string, options?: any): AxiosPromise<GetSettingKeyResponseClass>;
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(slug: string, authorization?: string, version?: number, expand?: string, options?: any): AxiosPromise<GetSettingKeyResponseClass>;
211
+ /**
212
+ * 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\"
213
+ * @summary List setting keys
214
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
215
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
216
+ * @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.
217
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
218
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
219
+ * @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.
220
+ * @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;
221
+ * @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.
222
+ * @param {*} [options] Override http request option.
223
+ * @throws {RequiredError}
224
+ */
225
+ listSettingKeys(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingKeysResponseClass>;
226
+ /**
227
+ * 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\"
228
+ * @summary Update the setting key
229
+ * @param {string} code
230
+ * @param {string} ifMatch
231
+ * @param {UpdateSettingKeyRequestRestDto} updateSettingKeyRequestRestDto
232
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
233
+ * @param {*} [options] Override http request option.
234
+ * @throws {RequiredError}
235
+ */
236
+ updateSettingKey(code: string, ifMatch: string, updateSettingKeyRequestRestDto: UpdateSettingKeyRequestRestDto, authorization?: string, options?: any): AxiosPromise<UpdateSettingKeyResponseClass>;
237
+ };
238
+ /**
239
+ * Request parameters for createSettingKey operation in SettingKeysApi.
240
+ * @export
241
+ * @interface SettingKeysApiCreateSettingKeyRequest
242
+ */
243
+ export interface SettingKeysApiCreateSettingKeyRequest {
244
+ /**
245
+ *
246
+ * @type {CreateSettingKeyRequestDto}
247
+ * @memberof SettingKeysApiCreateSettingKey
248
+ */
249
+ readonly createSettingKeyRequestDto: CreateSettingKeyRequestDto;
250
+ /**
251
+ * Bearer Token: provided by the login endpoint under the name accessToken.
252
+ * @type {string}
253
+ * @memberof SettingKeysApiCreateSettingKey
254
+ */
255
+ readonly authorization?: string;
256
+ }
257
+ /**
258
+ * Request parameters for deleteSettingKey operation in SettingKeysApi.
259
+ * @export
260
+ * @interface SettingKeysApiDeleteSettingKeyRequest
261
+ */
262
+ export interface SettingKeysApiDeleteSettingKeyRequest {
263
+ /**
264
+ *
265
+ * @type {string}
266
+ * @memberof SettingKeysApiDeleteSettingKey
267
+ */
268
+ readonly code: string;
269
+ /**
270
+ *
271
+ * @type {string}
272
+ * @memberof SettingKeysApiDeleteSettingKey
273
+ */
274
+ readonly ifMatch: string;
275
+ /**
276
+ * Bearer Token: provided by the login endpoint under the name accessToken.
277
+ * @type {string}
278
+ * @memberof SettingKeysApiDeleteSettingKey
279
+ */
280
+ readonly authorization?: string;
281
+ }
282
+ /**
283
+ * Request parameters for getSettingKey operation in SettingKeysApi.
284
+ * @export
285
+ * @interface SettingKeysApiGetSettingKeyRequest
286
+ */
287
+ export interface SettingKeysApiGetSettingKeyRequest {
288
+ /**
289
+ *
290
+ * @type {string}
291
+ * @memberof SettingKeysApiGetSettingKey
292
+ */
293
+ readonly code: string;
294
+ /**
295
+ * Bearer Token: provided by the login endpoint under the name accessToken.
296
+ * @type {string}
297
+ * @memberof SettingKeysApiGetSettingKey
298
+ */
299
+ readonly authorization?: string;
300
+ /**
301
+ * Specific value version. Defaults to latest.
302
+ * @type {number}
303
+ * @memberof SettingKeysApiGetSettingKey
304
+ */
305
+ readonly version?: number;
306
+ /**
307
+ * Optional expand (definition only).
308
+ * @type {string}
309
+ * @memberof SettingKeysApiGetSettingKey
310
+ */
311
+ readonly expand?: string;
312
+ }
313
+ /**
314
+ * Request parameters for getSettingKeyBySlug operation in SettingKeysApi.
315
+ * @export
316
+ * @interface SettingKeysApiGetSettingKeyBySlugRequest
317
+ */
318
+ export interface SettingKeysApiGetSettingKeyBySlugRequest {
319
+ /**
320
+ *
321
+ * @type {string}
322
+ * @memberof SettingKeysApiGetSettingKeyBySlug
323
+ */
324
+ readonly slug: string;
325
+ /**
326
+ * Bearer Token: provided by the login endpoint under the name accessToken.
327
+ * @type {string}
328
+ * @memberof SettingKeysApiGetSettingKeyBySlug
329
+ */
330
+ readonly authorization?: string;
331
+ /**
332
+ * Specific value version. Defaults to latest.
333
+ * @type {number}
334
+ * @memberof SettingKeysApiGetSettingKeyBySlug
335
+ */
336
+ readonly version?: number;
337
+ /**
338
+ * Optional expand (definition only).
339
+ * @type {string}
340
+ * @memberof SettingKeysApiGetSettingKeyBySlug
341
+ */
342
+ readonly expand?: string;
343
+ }
344
+ /**
345
+ * Request parameters for listSettingKeys operation in SettingKeysApi.
346
+ * @export
347
+ * @interface SettingKeysApiListSettingKeysRequest
348
+ */
349
+ export interface SettingKeysApiListSettingKeysRequest {
350
+ /**
351
+ * Bearer Token: provided by the login endpoint under the name accessToken.
352
+ * @type {string}
353
+ * @memberof SettingKeysApiListSettingKeys
354
+ */
355
+ readonly authorization?: string;
356
+ /**
357
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
358
+ * @type {number}
359
+ * @memberof SettingKeysApiListSettingKeys
360
+ */
361
+ readonly pageSize?: number;
362
+ /**
363
+ * 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.
364
+ * @type {string}
365
+ * @memberof SettingKeysApiListSettingKeys
366
+ */
367
+ readonly pageToken?: string;
368
+ /**
369
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
370
+ * @type {string}
371
+ * @memberof SettingKeysApiListSettingKeys
372
+ */
373
+ readonly filter?: string;
374
+ /**
375
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
376
+ * @type {string}
377
+ * @memberof SettingKeysApiListSettingKeys
378
+ */
379
+ readonly search?: string;
380
+ /**
381
+ * 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.
382
+ * @type {string}
383
+ * @memberof SettingKeysApiListSettingKeys
384
+ */
385
+ readonly order?: string;
386
+ /**
387
+ * 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;
388
+ * @type {string}
389
+ * @memberof SettingKeysApiListSettingKeys
390
+ */
391
+ readonly expand?: string;
392
+ /**
393
+ * 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.
394
+ * @type {string}
395
+ * @memberof SettingKeysApiListSettingKeys
396
+ */
397
+ readonly filters?: string;
398
+ }
399
+ /**
400
+ * Request parameters for updateSettingKey operation in SettingKeysApi.
401
+ * @export
402
+ * @interface SettingKeysApiUpdateSettingKeyRequest
403
+ */
404
+ export interface SettingKeysApiUpdateSettingKeyRequest {
405
+ /**
406
+ *
407
+ * @type {string}
408
+ * @memberof SettingKeysApiUpdateSettingKey
409
+ */
410
+ readonly code: string;
411
+ /**
412
+ *
413
+ * @type {string}
414
+ * @memberof SettingKeysApiUpdateSettingKey
415
+ */
416
+ readonly ifMatch: string;
417
+ /**
418
+ *
419
+ * @type {UpdateSettingKeyRequestRestDto}
420
+ * @memberof SettingKeysApiUpdateSettingKey
421
+ */
422
+ readonly updateSettingKeyRequestRestDto: UpdateSettingKeyRequestRestDto;
423
+ /**
424
+ * Bearer Token: provided by the login endpoint under the name accessToken.
425
+ * @type {string}
426
+ * @memberof SettingKeysApiUpdateSettingKey
427
+ */
428
+ readonly authorization?: string;
429
+ }
430
+ /**
431
+ * SettingKeysApi - object-oriented interface
432
+ * @export
433
+ * @class SettingKeysApi
434
+ * @extends {BaseAPI}
435
+ */
436
+ export declare class SettingKeysApi extends BaseAPI {
437
+ /**
438
+ * Create a new setting key with an initial value **Required Permissions** \"tenant-management.settings.create\"
439
+ * @summary Create the setting key
440
+ * @param {SettingKeysApiCreateSettingKeyRequest} requestParameters Request parameters.
441
+ * @param {*} [options] Override http request option.
442
+ * @throws {RequiredError}
443
+ * @memberof SettingKeysApi
444
+ */
445
+ createSettingKey(requestParameters: SettingKeysApiCreateSettingKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSettingKeyResponseClass, any, {}>>;
446
+ /**
447
+ * undefined **Required Permissions** \"tenant-management.settings.delete\"
448
+ * @param {SettingKeysApiDeleteSettingKeyRequest} requestParameters Request parameters.
449
+ * @param {*} [options] Override http request option.
450
+ * @throws {RequiredError}
451
+ * @memberof SettingKeysApi
452
+ */
453
+ deleteSettingKey(requestParameters: SettingKeysApiDeleteSettingKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteSettingKeyResponseClass, any, {}>>;
454
+ /**
455
+ * 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\"
456
+ * @summary Retrieve the setting key
457
+ * @param {SettingKeysApiGetSettingKeyRequest} requestParameters Request parameters.
458
+ * @param {*} [options] Override http request option.
459
+ * @throws {RequiredError}
460
+ * @memberof SettingKeysApi
461
+ */
462
+ getSettingKey(requestParameters: SettingKeysApiGetSettingKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettingKeyResponseClass, any, {}>>;
463
+ /**
464
+ * 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\"
465
+ * @summary Retrieve the setting key by slug
466
+ * @param {SettingKeysApiGetSettingKeyBySlugRequest} requestParameters Request parameters.
467
+ * @param {*} [options] Override http request option.
468
+ * @throws {RequiredError}
469
+ * @memberof SettingKeysApi
470
+ */
471
+ getSettingKeyBySlug(requestParameters: SettingKeysApiGetSettingKeyBySlugRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSettingKeyResponseClass, any, {}>>;
472
+ /**
473
+ * 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\"
474
+ * @summary List setting keys
475
+ * @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
476
+ * @param {*} [options] Override http request option.
477
+ * @throws {RequiredError}
478
+ * @memberof SettingKeysApi
479
+ */
480
+ listSettingKeys(requestParameters?: SettingKeysApiListSettingKeysRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListSettingKeysResponseClass, any, {}>>;
481
+ /**
482
+ * 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\"
483
+ * @summary Update the setting key
484
+ * @param {SettingKeysApiUpdateSettingKeyRequest} requestParameters Request parameters.
485
+ * @param {*} [options] Override http request option.
486
+ * @throws {RequiredError}
487
+ * @memberof SettingKeysApi
488
+ */
489
+ updateSettingKey(requestParameters: SettingKeysApiUpdateSettingKeyRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateSettingKeyResponseClass, any, {}>>;
490
+ }