@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,250 @@
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 { ListSettingValuesResponseClass } from '../models';
25
+ // URLSearchParams not necessarily used
26
+ // @ts-ignore
27
+ import { URL, URLSearchParams } from 'url';
28
+ const FormData = require('form-data');
29
+ /**
30
+ * SettingValuesApi - axios parameter creator
31
+ * @export
32
+ */
33
+ export const SettingValuesApiAxiosParamCreator = function (configuration?: Configuration) {
34
+ return {
35
+ /**
36
+ * Returns a list of setting values you have previously created. The setting values 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\"
37
+ * @summary List setting values
38
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
39
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
40
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
41
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
42
+ * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
43
+ * @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.
44
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
45
+ * @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.
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ listSettingValues: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
50
+ const localVarPath = `/settingservice/v2/setting-values`;
51
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
52
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
53
+ let baseOptions;
54
+ let baseAccessToken;
55
+ if (configuration) {
56
+ baseOptions = configuration.baseOptions;
57
+ baseAccessToken = configuration.accessToken;
58
+ }
59
+
60
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
61
+ const localVarHeaderParameter = {} as any;
62
+ const localVarQueryParameter = {} as any;
63
+
64
+ // authentication bearer required
65
+ // http bearer authentication required
66
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
67
+
68
+ if (pageSize !== undefined) {
69
+ localVarQueryParameter['pageSize'] = pageSize;
70
+ }
71
+
72
+ if (pageToken !== undefined) {
73
+ localVarQueryParameter['pageToken'] = pageToken;
74
+ }
75
+
76
+ if (filter !== undefined) {
77
+ localVarQueryParameter['filter'] = filter;
78
+ }
79
+
80
+ if (search !== undefined) {
81
+ localVarQueryParameter['search'] = search;
82
+ }
83
+
84
+ if (order !== undefined) {
85
+ localVarQueryParameter['order'] = order;
86
+ }
87
+
88
+ if (expand !== undefined) {
89
+ localVarQueryParameter['expand'] = expand;
90
+ }
91
+
92
+ if (filters !== undefined) {
93
+ localVarQueryParameter['filters'] = filters;
94
+ }
95
+
96
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
97
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
98
+ }
99
+
100
+
101
+
102
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
103
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
104
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
105
+
106
+ return {
107
+ url: toPathString(localVarUrlObj),
108
+ options: localVarRequestOptions,
109
+ };
110
+ },
111
+ }
112
+ };
113
+
114
+ /**
115
+ * SettingValuesApi - functional programming interface
116
+ * @export
117
+ */
118
+ export const SettingValuesApiFp = function(configuration?: Configuration) {
119
+ const localVarAxiosParamCreator = SettingValuesApiAxiosParamCreator(configuration)
120
+ return {
121
+ /**
122
+ * Returns a list of setting values you have previously created. The setting values 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\"
123
+ * @summary List setting values
124
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
125
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
126
+ * @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.
127
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
128
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
129
+ * @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.
130
+ * @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;
131
+ * @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.
132
+ * @param {*} [options] Override http request option.
133
+ * @throws {RequiredError}
134
+ */
135
+ async listSettingValues(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettingValuesResponseClass>> {
136
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
137
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
138
+ },
139
+ }
140
+ };
141
+
142
+ /**
143
+ * SettingValuesApi - factory interface
144
+ * @export
145
+ */
146
+ export const SettingValuesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
147
+ const localVarFp = SettingValuesApiFp(configuration)
148
+ return {
149
+ /**
150
+ * Returns a list of setting values you have previously created. The setting values 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\"
151
+ * @summary List setting values
152
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
153
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
154
+ * @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.
155
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
156
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
157
+ * @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.
158
+ * @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;
159
+ * @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.
160
+ * @param {*} [options] Override http request option.
161
+ * @throws {RequiredError}
162
+ */
163
+ listSettingValues(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingValuesResponseClass> {
164
+ return localVarFp.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
165
+ },
166
+ };
167
+ };
168
+
169
+ /**
170
+ * Request parameters for listSettingValues operation in SettingValuesApi.
171
+ * @export
172
+ * @interface SettingValuesApiListSettingValuesRequest
173
+ */
174
+ export interface SettingValuesApiListSettingValuesRequest {
175
+ /**
176
+ * Bearer Token: provided by the login endpoint under the name accessToken.
177
+ * @type {string}
178
+ * @memberof SettingValuesApiListSettingValues
179
+ */
180
+ readonly authorization?: string
181
+
182
+ /**
183
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
184
+ * @type {number}
185
+ * @memberof SettingValuesApiListSettingValues
186
+ */
187
+ readonly pageSize?: number
188
+
189
+ /**
190
+ * 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.
191
+ * @type {string}
192
+ * @memberof SettingValuesApiListSettingValues
193
+ */
194
+ readonly pageToken?: string
195
+
196
+ /**
197
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
198
+ * @type {string}
199
+ * @memberof SettingValuesApiListSettingValues
200
+ */
201
+ readonly filter?: string
202
+
203
+ /**
204
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
205
+ * @type {string}
206
+ * @memberof SettingValuesApiListSettingValues
207
+ */
208
+ readonly search?: string
209
+
210
+ /**
211
+ * 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.
212
+ * @type {string}
213
+ * @memberof SettingValuesApiListSettingValues
214
+ */
215
+ readonly order?: string
216
+
217
+ /**
218
+ * 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;
219
+ * @type {string}
220
+ * @memberof SettingValuesApiListSettingValues
221
+ */
222
+ readonly expand?: string
223
+
224
+ /**
225
+ * 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.
226
+ * @type {string}
227
+ * @memberof SettingValuesApiListSettingValues
228
+ */
229
+ readonly filters?: string
230
+ }
231
+
232
+ /**
233
+ * SettingValuesApi - object-oriented interface
234
+ * @export
235
+ * @class SettingValuesApi
236
+ * @extends {BaseAPI}
237
+ */
238
+ export class SettingValuesApi extends BaseAPI {
239
+ /**
240
+ * Returns a list of setting values you have previously created. The setting values 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\"
241
+ * @summary List setting values
242
+ * @param {SettingValuesApiListSettingValuesRequest} requestParameters Request parameters.
243
+ * @param {*} [options] Override http request option.
244
+ * @throws {RequiredError}
245
+ * @memberof SettingValuesApi
246
+ */
247
+ public listSettingValues(requestParameters: SettingValuesApiListSettingValuesRequest = {}, options?: AxiosRequestConfig) {
248
+ return SettingValuesApiFp(this.configuration).listSettingValues(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
249
+ }
250
+ }
package/api.ts CHANGED
@@ -27,9 +27,13 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
27
27
  import { HealthApi } from './api';
28
28
  import { PublicKeysApi } from './api';
29
29
  import { SettingDefinitionsApi } from './api';
30
+ import { SettingKeysApi } from './api';
31
+ import { SettingValuesApi } from './api';
30
32
 
31
33
 
32
34
  export * from './api/health-api';
33
35
  export * from './api/public-keys-api';
34
36
  export * from './api/setting-definitions-api';
37
+ export * from './api/setting-keys-api';
38
+ export * from './api/setting-values-api';
35
39
 
@@ -12,6 +12,8 @@
12
12
  import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateSettingDefinitionRequestDto } from '../models';
16
+ import { CreateSettingDefinitionResponseClass } from '../models';
15
17
  import { GetSettingDefinitionResponseClass } from '../models';
16
18
  import { ListSettingDefinitionsResponseClass } from '../models';
17
19
  /**
@@ -19,15 +21,24 @@ import { ListSettingDefinitionsResponseClass } from '../models';
19
21
  * @export
20
22
  */
21
23
  export declare const SettingDefinitionsApiAxiosParamCreator: (configuration?: Configuration) => {
24
+ /**
25
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
26
+ * @summary Create the setting definition
27
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
28
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
29
+ * @param {*} [options] Override http request option.
30
+ * @throws {RequiredError}
31
+ */
32
+ createSettingDefinition: (createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
22
33
  /**
23
34
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
24
35
  * @summary Retrieve the setting definition
25
- * @param {string} key
36
+ * @param {string} code
26
37
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
27
38
  * @param {*} [options] Override http request option.
28
39
  * @throws {RequiredError}
29
40
  */
30
- getSettingDefinition: (key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
+ getSettingDefinition: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
31
42
  /**
32
43
  * Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
33
44
  * @summary List setting definitions
@@ -49,15 +60,24 @@ export declare const SettingDefinitionsApiAxiosParamCreator: (configuration?: Co
49
60
  * @export
50
61
  */
51
62
  export declare const SettingDefinitionsApiFp: (configuration?: Configuration) => {
63
+ /**
64
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
65
+ * @summary Create the setting definition
66
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
67
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
68
+ * @param {*} [options] Override http request option.
69
+ * @throws {RequiredError}
70
+ */
71
+ createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettingDefinitionResponseClass>>;
52
72
  /**
53
73
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
54
74
  * @summary Retrieve the setting definition
55
- * @param {string} key
75
+ * @param {string} code
56
76
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
57
77
  * @param {*} [options] Override http request option.
58
78
  * @throws {RequiredError}
59
79
  */
60
- getSettingDefinition(key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>>;
80
+ getSettingDefinition(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>>;
61
81
  /**
62
82
  * Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
63
83
  * @summary List setting definitions
@@ -79,15 +99,24 @@ export declare const SettingDefinitionsApiFp: (configuration?: Configuration) =>
79
99
  * @export
80
100
  */
81
101
  export declare const SettingDefinitionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
102
+ /**
103
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
104
+ * @summary Create the setting definition
105
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
106
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ */
110
+ createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettingDefinitionResponseClass>;
82
111
  /**
83
112
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
84
113
  * @summary Retrieve the setting definition
85
- * @param {string} key
114
+ * @param {string} code
86
115
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
87
116
  * @param {*} [options] Override http request option.
88
117
  * @throws {RequiredError}
89
118
  */
90
- getSettingDefinition(key: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
119
+ getSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
91
120
  /**
92
121
  * Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
93
122
  * @summary List setting definitions
@@ -104,6 +133,25 @@ export declare const SettingDefinitionsApiFactory: (configuration?: Configuratio
104
133
  */
105
134
  listSettingDefinitions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingDefinitionsResponseClass>;
106
135
  };
136
+ /**
137
+ * Request parameters for createSettingDefinition operation in SettingDefinitionsApi.
138
+ * @export
139
+ * @interface SettingDefinitionsApiCreateSettingDefinitionRequest
140
+ */
141
+ export interface SettingDefinitionsApiCreateSettingDefinitionRequest {
142
+ /**
143
+ *
144
+ * @type {CreateSettingDefinitionRequestDto}
145
+ * @memberof SettingDefinitionsApiCreateSettingDefinition
146
+ */
147
+ readonly createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto;
148
+ /**
149
+ * Bearer Token: provided by the login endpoint under the name accessToken.
150
+ * @type {string}
151
+ * @memberof SettingDefinitionsApiCreateSettingDefinition
152
+ */
153
+ readonly authorization?: string;
154
+ }
107
155
  /**
108
156
  * Request parameters for getSettingDefinition operation in SettingDefinitionsApi.
109
157
  * @export
@@ -115,7 +163,7 @@ export interface SettingDefinitionsApiGetSettingDefinitionRequest {
115
163
  * @type {string}
116
164
  * @memberof SettingDefinitionsApiGetSettingDefinition
117
165
  */
118
- readonly key: string;
166
+ readonly code: string;
119
167
  /**
120
168
  * Bearer Token: provided by the login endpoint under the name accessToken.
121
169
  * @type {string}
@@ -185,6 +233,15 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
185
233
  * @extends {BaseAPI}
186
234
  */
187
235
  export declare class SettingDefinitionsApi extends BaseAPI {
236
+ /**
237
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
238
+ * @summary Create the setting definition
239
+ * @param {SettingDefinitionsApiCreateSettingDefinitionRequest} requestParameters Request parameters.
240
+ * @param {*} [options] Override http request option.
241
+ * @throws {RequiredError}
242
+ * @memberof SettingDefinitionsApi
243
+ */
244
+ createSettingDefinition(requestParameters: SettingDefinitionsApiCreateSettingDefinitionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateSettingDefinitionResponseClass, any, {}>>;
188
245
  /**
189
246
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
190
247
  * @summary Retrieve the setting definition
@@ -96,25 +96,74 @@ var FormData = require('form-data');
96
96
  var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
+ /**
100
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
101
+ * @summary Create the setting definition
102
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
103
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
104
+ * @param {*} [options] Override http request option.
105
+ * @throws {RequiredError}
106
+ */
107
+ createSettingDefinition: function (createSettingDefinitionRequestDto, authorization, options) {
108
+ if (options === void 0) { options = {}; }
109
+ return __awaiter(_this, void 0, void 0, function () {
110
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
111
+ return __generator(this, function (_a) {
112
+ switch (_a.label) {
113
+ case 0:
114
+ // verify required parameter 'createSettingDefinitionRequestDto' is not null or undefined
115
+ (0, common_1.assertParamExists)('createSettingDefinition', 'createSettingDefinitionRequestDto', createSettingDefinitionRequestDto);
116
+ localVarPath = "/settingservice/v1/settings/definitions";
117
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
118
+ if (configuration) {
119
+ baseOptions = configuration.baseOptions;
120
+ baseAccessToken = configuration.accessToken;
121
+ }
122
+ localVarRequestOptions = __assign(__assign({ method: 'POST' }, baseOptions), options);
123
+ localVarHeaderParameter = {};
124
+ localVarQueryParameter = {};
125
+ // authentication bearer required
126
+ // http bearer authentication required
127
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
128
+ case 1:
129
+ // authentication bearer required
130
+ // http bearer authentication required
131
+ _a.sent();
132
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
133
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
134
+ }
135
+ localVarHeaderParameter['Content-Type'] = 'application/json';
136
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
137
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
138
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
139
+ localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createSettingDefinitionRequestDto, localVarRequestOptions, configuration);
140
+ return [2 /*return*/, {
141
+ url: (0, common_1.toPathString)(localVarUrlObj),
142
+ options: localVarRequestOptions,
143
+ }];
144
+ }
145
+ });
146
+ });
147
+ },
99
148
  /**
100
149
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
101
150
  * @summary Retrieve the setting definition
102
- * @param {string} key
151
+ * @param {string} code
103
152
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
104
153
  * @param {*} [options] Override http request option.
105
154
  * @throws {RequiredError}
106
155
  */
107
- getSettingDefinition: function (key, authorization, options) {
156
+ getSettingDefinition: function (code, authorization, options) {
108
157
  if (options === void 0) { options = {}; }
109
158
  return __awaiter(_this, void 0, void 0, function () {
110
159
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
111
160
  return __generator(this, function (_a) {
112
161
  switch (_a.label) {
113
162
  case 0:
114
- // verify required parameter 'key' is not null or undefined
115
- (0, common_1.assertParamExists)('getSettingDefinition', 'key', key);
116
- localVarPath = "/settingservice/v1/settings/definitions/{key}"
117
- .replace("{".concat("key", "}"), encodeURIComponent(String(key)));
163
+ // verify required parameter 'code' is not null or undefined
164
+ (0, common_1.assertParamExists)('getSettingDefinition', 'code', code);
165
+ localVarPath = "/settingservice/v1/settings/definitions/{code}"
166
+ .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
118
167
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
119
168
  if (configuration) {
120
169
  baseOptions = configuration.baseOptions;
@@ -226,20 +275,41 @@ exports.SettingDefinitionsApiAxiosParamCreator = SettingDefinitionsApiAxiosParam
226
275
  var SettingDefinitionsApiFp = function (configuration) {
227
276
  var localVarAxiosParamCreator = (0, exports.SettingDefinitionsApiAxiosParamCreator)(configuration);
228
277
  return {
278
+ /**
279
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
280
+ * @summary Create the setting definition
281
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
282
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
283
+ * @param {*} [options] Override http request option.
284
+ * @throws {RequiredError}
285
+ */
286
+ createSettingDefinition: function (createSettingDefinitionRequestDto, authorization, options) {
287
+ return __awaiter(this, void 0, void 0, function () {
288
+ var localVarAxiosArgs;
289
+ return __generator(this, function (_a) {
290
+ switch (_a.label) {
291
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options)];
292
+ case 1:
293
+ localVarAxiosArgs = _a.sent();
294
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
295
+ }
296
+ });
297
+ });
298
+ },
229
299
  /**
230
300
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
231
301
  * @summary Retrieve the setting definition
232
- * @param {string} key
302
+ * @param {string} code
233
303
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
234
304
  * @param {*} [options] Override http request option.
235
305
  * @throws {RequiredError}
236
306
  */
237
- getSettingDefinition: function (key, authorization, options) {
307
+ getSettingDefinition: function (code, authorization, options) {
238
308
  return __awaiter(this, void 0, void 0, function () {
239
309
  var localVarAxiosArgs;
240
310
  return __generator(this, function (_a) {
241
311
  switch (_a.label) {
242
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(key, authorization, options)];
312
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, options)];
243
313
  case 1:
244
314
  localVarAxiosArgs = _a.sent();
245
315
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -284,16 +354,27 @@ exports.SettingDefinitionsApiFp = SettingDefinitionsApiFp;
284
354
  var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
285
355
  var localVarFp = (0, exports.SettingDefinitionsApiFp)(configuration);
286
356
  return {
357
+ /**
358
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
359
+ * @summary Create the setting definition
360
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
361
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
362
+ * @param {*} [options] Override http request option.
363
+ * @throws {RequiredError}
364
+ */
365
+ createSettingDefinition: function (createSettingDefinitionRequestDto, authorization, options) {
366
+ return localVarFp.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
367
+ },
287
368
  /**
288
369
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
289
370
  * @summary Retrieve the setting definition
290
- * @param {string} key
371
+ * @param {string} code
291
372
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
292
373
  * @param {*} [options] Override http request option.
293
374
  * @throws {RequiredError}
294
375
  */
295
- getSettingDefinition: function (key, authorization, options) {
296
- return localVarFp.getSettingDefinition(key, authorization, options).then(function (request) { return request(axios, basePath); });
376
+ getSettingDefinition: function (code, authorization, options) {
377
+ return localVarFp.getSettingDefinition(code, authorization, options).then(function (request) { return request(axios, basePath); });
297
378
  },
298
379
  /**
299
380
  * Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"
@@ -326,6 +407,18 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
326
407
  function SettingDefinitionsApi() {
327
408
  return _super !== null && _super.apply(this, arguments) || this;
328
409
  }
410
+ /**
411
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
412
+ * @summary Create the setting definition
413
+ * @param {SettingDefinitionsApiCreateSettingDefinitionRequest} requestParameters Request parameters.
414
+ * @param {*} [options] Override http request option.
415
+ * @throws {RequiredError}
416
+ * @memberof SettingDefinitionsApi
417
+ */
418
+ SettingDefinitionsApi.prototype.createSettingDefinition = function (requestParameters, options) {
419
+ var _this = this;
420
+ return (0, exports.SettingDefinitionsApiFp)(this.configuration).createSettingDefinition(requestParameters.createSettingDefinitionRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
421
+ };
329
422
  /**
330
423
  * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code that was returned when you created it and Emil Api will return the corresponding setting definition information. **Required Permissions** \"tenant-management.settings.view\"
331
424
  * @summary Retrieve the setting definition
@@ -336,7 +429,7 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
336
429
  */
337
430
  SettingDefinitionsApi.prototype.getSettingDefinition = function (requestParameters, options) {
338
431
  var _this = this;
339
- return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.key, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
432
+ return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
340
433
  };
341
434
  /**
342
435
  * Returns a list of setting definitions you have previously created. The setting definitions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"tenant-management.settings.view\"