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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. package/.openapi-generator/FILES +19 -0
  2. package/README.md +2 -2
  3. package/api/setting-definitions-api.ts +460 -0
  4. package/api/setting-keys-api.ts +868 -0
  5. package/api/setting-values-api.ts +250 -0
  6. package/api.ts +6 -0
  7. package/base.ts +1 -0
  8. package/dist/api/setting-definitions-api.d.ts +263 -0
  9. package/dist/api/setting-definitions-api.js +449 -0
  10. package/dist/api/setting-keys-api.d.ts +490 -0
  11. package/dist/api/setting-keys-api.js +768 -0
  12. package/dist/api/setting-values-api.d.ts +150 -0
  13. package/dist/api/setting-values-api.js +264 -0
  14. package/dist/api.d.ts +3 -0
  15. package/dist/api.js +3 -0
  16. package/dist/base.d.ts +2 -1
  17. package/dist/base.js +1 -0
  18. package/dist/models/create-setting-definition-request-dto.d.ts +93 -0
  19. package/dist/models/create-setting-definition-request-dto.js +53 -0
  20. package/dist/models/create-setting-definition-response-class.d.ts +25 -0
  21. package/dist/models/create-setting-definition-response-class.js +15 -0
  22. package/dist/models/create-setting-key-request-dto.d.ts +36 -0
  23. package/dist/models/create-setting-key-request-dto.js +15 -0
  24. package/dist/models/create-setting-key-response-class.d.ts +25 -0
  25. package/dist/models/create-setting-key-response-class.js +15 -0
  26. package/dist/models/delete-setting-key-response-class.d.ts +24 -0
  27. package/dist/models/delete-setting-key-response-class.js +15 -0
  28. package/dist/models/get-setting-definition-response-class.d.ts +25 -0
  29. package/dist/models/get-setting-definition-response-class.js +15 -0
  30. package/dist/models/get-setting-key-response-class.d.ts +25 -0
  31. package/dist/models/get-setting-key-response-class.js +15 -0
  32. package/dist/models/index.d.ts +16 -0
  33. package/dist/models/index.js +16 -0
  34. package/dist/models/list-public-keys-response-class.d.ts +10 -10
  35. package/dist/models/list-setting-definitions-response-class.d.ts +43 -0
  36. package/dist/models/list-setting-definitions-response-class.js +15 -0
  37. package/dist/models/list-setting-keys-response-class.d.ts +43 -0
  38. package/dist/models/list-setting-keys-response-class.js +15 -0
  39. package/dist/models/list-setting-values-response-class.d.ts +43 -0
  40. package/dist/models/list-setting-values-response-class.js +15 -0
  41. package/dist/models/setting-definition-class.d.ts +124 -0
  42. package/dist/models/setting-definition-class.js +53 -0
  43. package/dist/models/setting-definition-version-class.d.ts +72 -0
  44. package/dist/models/setting-definition-version-class.js +15 -0
  45. package/dist/models/setting-key-class.d.ts +85 -0
  46. package/dist/models/setting-key-class.js +15 -0
  47. package/dist/models/setting-value-class.d.ts +72 -0
  48. package/dist/models/setting-value-class.js +15 -0
  49. package/dist/models/update-setting-key-request-rest-dto.d.ts +30 -0
  50. package/dist/models/update-setting-key-request-rest-dto.js +15 -0
  51. package/dist/models/update-setting-key-response-class.d.ts +25 -0
  52. package/dist/models/update-setting-key-response-class.js +15 -0
  53. package/models/create-setting-definition-request-dto.ts +103 -0
  54. package/models/create-setting-definition-response-class.ts +31 -0
  55. package/models/create-setting-key-request-dto.ts +42 -0
  56. package/models/create-setting-key-response-class.ts +31 -0
  57. package/models/delete-setting-key-response-class.ts +30 -0
  58. package/models/get-setting-definition-response-class.ts +31 -0
  59. package/models/get-setting-key-response-class.ts +31 -0
  60. package/models/index.ts +16 -0
  61. package/models/list-public-keys-response-class.ts +10 -10
  62. package/models/list-setting-definitions-response-class.ts +49 -0
  63. package/models/list-setting-keys-response-class.ts +49 -0
  64. package/models/list-setting-values-response-class.ts +49 -0
  65. package/models/setting-definition-class.ts +134 -0
  66. package/models/setting-definition-version-class.ts +78 -0
  67. package/models/setting-key-class.ts +91 -0
  68. package/models/setting-value-class.ts +78 -0
  69. package/models/update-setting-key-request-rest-dto.ts +36 -0
  70. package/models/update-setting-key-response-class.ts +31 -0
  71. package/package.json +2 -2
@@ -5,6 +5,9 @@ README.md
5
5
  api.ts
6
6
  api/health-api.ts
7
7
  api/public-keys-api.ts
8
+ api/setting-definitions-api.ts
9
+ api/setting-keys-api.ts
10
+ api/setting-values-api.ts
8
11
  base.ts
9
12
  common.ts
10
13
  configuration.ts
@@ -12,15 +15,31 @@ git_push.sh
12
15
  index.ts
13
16
  models/create-public-key-request-dto.ts
14
17
  models/create-public-key-response-class.ts
18
+ models/create-setting-definition-request-dto.ts
19
+ models/create-setting-definition-response-class.ts
20
+ models/create-setting-key-request-dto.ts
21
+ models/create-setting-key-response-class.ts
15
22
  models/delete-public-key-request-dto.ts
23
+ models/delete-setting-key-response-class.ts
16
24
  models/get-public-key-response-class.ts
25
+ models/get-setting-definition-response-class.ts
26
+ models/get-setting-key-response-class.ts
17
27
  models/index.ts
18
28
  models/inline-response200.ts
19
29
  models/inline-response503.ts
20
30
  models/list-public-keys-response-class.ts
31
+ models/list-setting-definitions-response-class.ts
32
+ models/list-setting-keys-response-class.ts
33
+ models/list-setting-values-response-class.ts
21
34
  models/public-key-class.ts
22
35
  models/rotate-public-key-response-class.ts
36
+ models/setting-definition-class.ts
37
+ models/setting-definition-version-class.ts
38
+ models/setting-key-class.ts
39
+ models/setting-value-class.ts
23
40
  models/update-public-key-request-dto.ts
24
41
  models/update-public-key-response-class.ts
42
+ models/update-setting-key-request-rest-dto.ts
43
+ models/update-setting-key-response-class.ts
25
44
  package.json
26
45
  tsconfig.json
package/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/setting-sdk-node@0.3.1-beta.2 --save
20
+ npm install @emilgroup/setting-sdk-node@0.3.1-beta.20 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/setting-sdk-node@0.3.1-beta.2
24
+ yarn add @emilgroup/setting-sdk-node@0.3.1-beta.20
25
25
  ```
26
26
 
27
27
  And then you can import ``.
@@ -0,0 +1,460 @@
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 { CreateSettingDefinitionRequestDto } from '../models';
25
+ // @ts-ignore
26
+ import { CreateSettingDefinitionResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { GetSettingDefinitionResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { ListSettingDefinitionsResponseClass } from '../models';
31
+ // URLSearchParams not necessarily used
32
+ // @ts-ignore
33
+ import { URL, URLSearchParams } from 'url';
34
+ const FormData = require('form-data');
35
+ /**
36
+ * SettingDefinitionsApi - axios parameter creator
37
+ * @export
38
+ */
39
+ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?: Configuration) {
40
+ return {
41
+ /**
42
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
43
+ * @summary Create the setting definition
44
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
45
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ createSettingDefinition: async (createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
50
+ // verify required parameter 'createSettingDefinitionRequestDto' is not null or undefined
51
+ assertParamExists('createSettingDefinition', 'createSettingDefinitionRequestDto', createSettingDefinitionRequestDto)
52
+ const localVarPath = `/settingservice/v1/settings/definitions`;
53
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
54
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
55
+ let baseOptions;
56
+ let baseAccessToken;
57
+ if (configuration) {
58
+ baseOptions = configuration.baseOptions;
59
+ baseAccessToken = configuration.accessToken;
60
+ }
61
+
62
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
63
+ const localVarHeaderParameter = {} as any;
64
+ const localVarQueryParameter = {} as any;
65
+
66
+ // authentication bearer required
67
+ // http bearer authentication required
68
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
69
+
70
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
71
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
72
+ }
73
+
74
+
75
+
76
+ localVarHeaderParameter['Content-Type'] = 'application/json';
77
+
78
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
79
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
80
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
81
+ localVarRequestOptions.data = serializeDataIfNeeded(createSettingDefinitionRequestDto, localVarRequestOptions, configuration)
82
+
83
+ return {
84
+ url: toPathString(localVarUrlObj),
85
+ options: localVarRequestOptions,
86
+ };
87
+ },
88
+ /**
89
+ * 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\"
90
+ * @summary Retrieve the setting definition
91
+ * @param {string} code
92
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
93
+ * @param {*} [options] Override http request option.
94
+ * @throws {RequiredError}
95
+ */
96
+ getSettingDefinition: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
97
+ // verify required parameter 'code' is not null or undefined
98
+ assertParamExists('getSettingDefinition', 'code', code)
99
+ const localVarPath = `/settingservice/v1/settings/definitions/{code}`
100
+ .replace(`{${"code"}}`, encodeURIComponent(String(code)));
101
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
102
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
103
+ let baseOptions;
104
+ let baseAccessToken;
105
+ if (configuration) {
106
+ baseOptions = configuration.baseOptions;
107
+ baseAccessToken = configuration.accessToken;
108
+ }
109
+
110
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
111
+ const localVarHeaderParameter = {} as any;
112
+ const localVarQueryParameter = {} as any;
113
+
114
+ // authentication bearer required
115
+ // http bearer authentication required
116
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
117
+
118
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
119
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
120
+ }
121
+
122
+
123
+
124
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
125
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
126
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
127
+
128
+ return {
129
+ url: toPathString(localVarUrlObj),
130
+ options: localVarRequestOptions,
131
+ };
132
+ },
133
+ /**
134
+ * 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\"
135
+ * @summary List setting definitions
136
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
137
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
138
+ * @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.
139
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
140
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
141
+ * @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.
142
+ * @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;
143
+ * @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.
144
+ * @param {*} [options] Override http request option.
145
+ * @throws {RequiredError}
146
+ */
147
+ listSettingDefinitions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
148
+ const localVarPath = `/settingservice/v1/settings/definitions`;
149
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
150
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
151
+ let baseOptions;
152
+ let baseAccessToken;
153
+ if (configuration) {
154
+ baseOptions = configuration.baseOptions;
155
+ baseAccessToken = configuration.accessToken;
156
+ }
157
+
158
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
159
+ const localVarHeaderParameter = {} as any;
160
+ const localVarQueryParameter = {} as any;
161
+
162
+ // authentication bearer required
163
+ // http bearer authentication required
164
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
165
+
166
+ if (pageSize !== undefined) {
167
+ localVarQueryParameter['pageSize'] = pageSize;
168
+ }
169
+
170
+ if (pageToken !== undefined) {
171
+ localVarQueryParameter['pageToken'] = pageToken;
172
+ }
173
+
174
+ if (filter !== undefined) {
175
+ localVarQueryParameter['filter'] = filter;
176
+ }
177
+
178
+ if (search !== undefined) {
179
+ localVarQueryParameter['search'] = search;
180
+ }
181
+
182
+ if (order !== undefined) {
183
+ localVarQueryParameter['order'] = order;
184
+ }
185
+
186
+ if (expand !== undefined) {
187
+ localVarQueryParameter['expand'] = expand;
188
+ }
189
+
190
+ if (filters !== undefined) {
191
+ localVarQueryParameter['filters'] = filters;
192
+ }
193
+
194
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
195
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
196
+ }
197
+
198
+
199
+
200
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
201
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
202
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
203
+
204
+ return {
205
+ url: toPathString(localVarUrlObj),
206
+ options: localVarRequestOptions,
207
+ };
208
+ },
209
+ }
210
+ };
211
+
212
+ /**
213
+ * SettingDefinitionsApi - functional programming interface
214
+ * @export
215
+ */
216
+ export const SettingDefinitionsApiFp = function(configuration?: Configuration) {
217
+ const localVarAxiosParamCreator = SettingDefinitionsApiAxiosParamCreator(configuration)
218
+ return {
219
+ /**
220
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
221
+ * @summary Create the setting definition
222
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
223
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
224
+ * @param {*} [options] Override http request option.
225
+ * @throws {RequiredError}
226
+ */
227
+ async createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettingDefinitionResponseClass>> {
228
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options);
229
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
230
+ },
231
+ /**
232
+ * 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\"
233
+ * @summary Retrieve the setting definition
234
+ * @param {string} code
235
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
236
+ * @param {*} [options] Override http request option.
237
+ * @throws {RequiredError}
238
+ */
239
+ async getSettingDefinition(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>> {
240
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingDefinition(code, authorization, options);
241
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
242
+ },
243
+ /**
244
+ * 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\"
245
+ * @summary List setting definitions
246
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
247
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
248
+ * @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.
249
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
250
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
251
+ * @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.
252
+ * @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;
253
+ * @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.
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ async listSettingDefinitions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettingDefinitionsResponseClass>> {
258
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listSettingDefinitions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
259
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
260
+ },
261
+ }
262
+ };
263
+
264
+ /**
265
+ * SettingDefinitionsApi - factory interface
266
+ * @export
267
+ */
268
+ export const SettingDefinitionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
269
+ const localVarFp = SettingDefinitionsApiFp(configuration)
270
+ return {
271
+ /**
272
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
273
+ * @summary Create the setting definition
274
+ * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto
275
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
276
+ * @param {*} [options] Override http request option.
277
+ * @throws {RequiredError}
278
+ */
279
+ createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettingDefinitionResponseClass> {
280
+ return localVarFp.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options).then((request) => request(axios, basePath));
281
+ },
282
+ /**
283
+ * 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\"
284
+ * @summary Retrieve the setting definition
285
+ * @param {string} code
286
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
287
+ * @param {*} [options] Override http request option.
288
+ * @throws {RequiredError}
289
+ */
290
+ getSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass> {
291
+ return localVarFp.getSettingDefinition(code, authorization, options).then((request) => request(axios, basePath));
292
+ },
293
+ /**
294
+ * 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\"
295
+ * @summary List setting definitions
296
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
297
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
298
+ * @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.
299
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
300
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
301
+ * @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.
302
+ * @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;
303
+ * @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.
304
+ * @param {*} [options] Override http request option.
305
+ * @throws {RequiredError}
306
+ */
307
+ listSettingDefinitions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingDefinitionsResponseClass> {
308
+ return localVarFp.listSettingDefinitions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
309
+ },
310
+ };
311
+ };
312
+
313
+ /**
314
+ * Request parameters for createSettingDefinition operation in SettingDefinitionsApi.
315
+ * @export
316
+ * @interface SettingDefinitionsApiCreateSettingDefinitionRequest
317
+ */
318
+ export interface SettingDefinitionsApiCreateSettingDefinitionRequest {
319
+ /**
320
+ *
321
+ * @type {CreateSettingDefinitionRequestDto}
322
+ * @memberof SettingDefinitionsApiCreateSettingDefinition
323
+ */
324
+ readonly createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto
325
+
326
+ /**
327
+ * Bearer Token: provided by the login endpoint under the name accessToken.
328
+ * @type {string}
329
+ * @memberof SettingDefinitionsApiCreateSettingDefinition
330
+ */
331
+ readonly authorization?: string
332
+ }
333
+
334
+ /**
335
+ * Request parameters for getSettingDefinition operation in SettingDefinitionsApi.
336
+ * @export
337
+ * @interface SettingDefinitionsApiGetSettingDefinitionRequest
338
+ */
339
+ export interface SettingDefinitionsApiGetSettingDefinitionRequest {
340
+ /**
341
+ *
342
+ * @type {string}
343
+ * @memberof SettingDefinitionsApiGetSettingDefinition
344
+ */
345
+ readonly code: string
346
+
347
+ /**
348
+ * Bearer Token: provided by the login endpoint under the name accessToken.
349
+ * @type {string}
350
+ * @memberof SettingDefinitionsApiGetSettingDefinition
351
+ */
352
+ readonly authorization?: string
353
+ }
354
+
355
+ /**
356
+ * Request parameters for listSettingDefinitions operation in SettingDefinitionsApi.
357
+ * @export
358
+ * @interface SettingDefinitionsApiListSettingDefinitionsRequest
359
+ */
360
+ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
361
+ /**
362
+ * Bearer Token: provided by the login endpoint under the name accessToken.
363
+ * @type {string}
364
+ * @memberof SettingDefinitionsApiListSettingDefinitions
365
+ */
366
+ readonly authorization?: string
367
+
368
+ /**
369
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
370
+ * @type {number}
371
+ * @memberof SettingDefinitionsApiListSettingDefinitions
372
+ */
373
+ readonly pageSize?: number
374
+
375
+ /**
376
+ * 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.
377
+ * @type {string}
378
+ * @memberof SettingDefinitionsApiListSettingDefinitions
379
+ */
380
+ readonly pageToken?: string
381
+
382
+ /**
383
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
384
+ * @type {string}
385
+ * @memberof SettingDefinitionsApiListSettingDefinitions
386
+ */
387
+ readonly filter?: string
388
+
389
+ /**
390
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
391
+ * @type {string}
392
+ * @memberof SettingDefinitionsApiListSettingDefinitions
393
+ */
394
+ readonly search?: string
395
+
396
+ /**
397
+ * 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.
398
+ * @type {string}
399
+ * @memberof SettingDefinitionsApiListSettingDefinitions
400
+ */
401
+ readonly order?: string
402
+
403
+ /**
404
+ * 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;
405
+ * @type {string}
406
+ * @memberof SettingDefinitionsApiListSettingDefinitions
407
+ */
408
+ readonly expand?: string
409
+
410
+ /**
411
+ * 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.
412
+ * @type {string}
413
+ * @memberof SettingDefinitionsApiListSettingDefinitions
414
+ */
415
+ readonly filters?: string
416
+ }
417
+
418
+ /**
419
+ * SettingDefinitionsApi - object-oriented interface
420
+ * @export
421
+ * @class SettingDefinitionsApi
422
+ * @extends {BaseAPI}
423
+ */
424
+ export class SettingDefinitionsApi extends BaseAPI {
425
+ /**
426
+ * Create a tenant setting definition **Required Permissions** \"tenant-management.settings.create\"
427
+ * @summary Create the setting definition
428
+ * @param {SettingDefinitionsApiCreateSettingDefinitionRequest} requestParameters Request parameters.
429
+ * @param {*} [options] Override http request option.
430
+ * @throws {RequiredError}
431
+ * @memberof SettingDefinitionsApi
432
+ */
433
+ public createSettingDefinition(requestParameters: SettingDefinitionsApiCreateSettingDefinitionRequest, options?: AxiosRequestConfig) {
434
+ return SettingDefinitionsApiFp(this.configuration).createSettingDefinition(requestParameters.createSettingDefinitionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
435
+ }
436
+
437
+ /**
438
+ * 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\"
439
+ * @summary Retrieve the setting definition
440
+ * @param {SettingDefinitionsApiGetSettingDefinitionRequest} requestParameters Request parameters.
441
+ * @param {*} [options] Override http request option.
442
+ * @throws {RequiredError}
443
+ * @memberof SettingDefinitionsApi
444
+ */
445
+ public getSettingDefinition(requestParameters: SettingDefinitionsApiGetSettingDefinitionRequest, options?: AxiosRequestConfig) {
446
+ return SettingDefinitionsApiFp(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
447
+ }
448
+
449
+ /**
450
+ * 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\"
451
+ * @summary List setting definitions
452
+ * @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
453
+ * @param {*} [options] Override http request option.
454
+ * @throws {RequiredError}
455
+ * @memberof SettingDefinitionsApi
456
+ */
457
+ public listSettingDefinitions(requestParameters: SettingDefinitionsApiListSettingDefinitionsRequest = {}, options?: AxiosRequestConfig) {
458
+ return SettingDefinitionsApiFp(this.configuration).listSettingDefinitions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
459
+ }
460
+ }