@emilgroup/setting-sdk 0.3.1-beta.25 → 0.3.1-beta.26

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.
@@ -194,7 +194,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
194
194
  * @param {string} code
195
195
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
196
196
  * @param {number} [version] Specific value version. Defaults to latest.
197
- * @param {string} [expand] Optional expand (definition only).
197
+ * @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/> <i>Allowed values: definition, values<i>
198
198
  * @param {*} [options] Override http request option.
199
199
  * @throws {RequiredError}
200
200
  */
@@ -250,7 +250,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
250
250
  * @param {string} slug
251
251
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
252
252
  * @param {number} [version] Specific value version. Defaults to latest.
253
- * @param {string} [expand] Optional expand (definition only).
253
+ * @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/> <i>Allowed values: definition, values<i>
254
254
  * @param {*} [options] Override http request option.
255
255
  * @throws {RequiredError}
256
256
  */
@@ -301,16 +301,16 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
301
301
  });
302
302
  },
303
303
  /**
304
- * 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\"
304
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
305
305
  * @summary List setting keys
306
306
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
307
307
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
308
308
  * @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.
309
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
309
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
310
310
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
311
- * @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.
312
- * @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/>
313
- * @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.
311
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
312
+ * @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/> <i>Allowed values: definition, values<i>
313
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
314
314
  * @param {*} [options] Override http request option.
315
315
  * @throws {RequiredError}
316
316
  */
@@ -488,7 +488,7 @@ var SettingKeysApiFp = function (configuration) {
488
488
  * @param {string} code
489
489
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
490
490
  * @param {number} [version] Specific value version. Defaults to latest.
491
- * @param {string} [expand] Optional expand (definition only).
491
+ * @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/> <i>Allowed values: definition, values<i>
492
492
  * @param {*} [options] Override http request option.
493
493
  * @throws {RequiredError}
494
494
  */
@@ -511,7 +511,7 @@ var SettingKeysApiFp = function (configuration) {
511
511
  * @param {string} slug
512
512
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
513
513
  * @param {number} [version] Specific value version. Defaults to latest.
514
- * @param {string} [expand] Optional expand (definition only).
514
+ * @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/> <i>Allowed values: definition, values<i>
515
515
  * @param {*} [options] Override http request option.
516
516
  * @throws {RequiredError}
517
517
  */
@@ -529,16 +529,16 @@ var SettingKeysApiFp = function (configuration) {
529
529
  });
530
530
  },
531
531
  /**
532
- * 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\"
532
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
533
533
  * @summary List setting keys
534
534
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
535
535
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
536
536
  * @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.
537
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
537
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
538
538
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
539
- * @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.
540
- * @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/>
541
- * @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.
539
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
540
+ * @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/> <i>Allowed values: definition, values<i>
541
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
542
542
  * @param {*} [options] Override http request option.
543
543
  * @throws {RequiredError}
544
544
  */
@@ -615,7 +615,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
615
615
  * @param {string} code
616
616
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
617
617
  * @param {number} [version] Specific value version. Defaults to latest.
618
- * @param {string} [expand] Optional expand (definition only).
618
+ * @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/> <i>Allowed values: definition, values<i>
619
619
  * @param {*} [options] Override http request option.
620
620
  * @throws {RequiredError}
621
621
  */
@@ -628,7 +628,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
628
628
  * @param {string} slug
629
629
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
630
630
  * @param {number} [version] Specific value version. Defaults to latest.
631
- * @param {string} [expand] Optional expand (definition only).
631
+ * @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/> <i>Allowed values: definition, values<i>
632
632
  * @param {*} [options] Override http request option.
633
633
  * @throws {RequiredError}
634
634
  */
@@ -636,16 +636,16 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
636
636
  return localVarFp.getSettingKeyBySlug(slug, authorization, version, expand, options).then(function (request) { return request(axios, basePath); });
637
637
  },
638
638
  /**
639
- * 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\"
639
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
640
640
  * @summary List setting keys
641
641
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
642
642
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
643
643
  * @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.
644
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
644
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
645
645
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
646
- * @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.
647
- * @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/>
648
- * @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.
646
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt</i>
647
+ * @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/> <i>Allowed values: definition, values<i>
648
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, definitionCode, definitionKey, isSecured, createdAt, updatedAt, definitionVersionCode</i>
649
649
  * @param {*} [options] Override http request option.
650
650
  * @throws {RequiredError}
651
651
  */
@@ -727,7 +727,7 @@ var SettingKeysApi = /** @class */ (function (_super) {
727
727
  return (0, exports.SettingKeysApiFp)(this.configuration).getSettingKeyBySlug(requestParameters.slug, requestParameters.authorization, requestParameters.version, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
728
728
  };
729
729
  /**
730
- * 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\"
730
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
731
731
  * @summary List setting keys
732
732
  * @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
733
733
  * @param {*} [options] Override http request option.
package/dist/api.d.ts CHANGED
@@ -13,4 +13,3 @@ export * from './api/health-api';
13
13
  export * from './api/public-keys-api';
14
14
  export * from './api/setting-definitions-api';
15
15
  export * from './api/setting-keys-api';
16
- export * from './api/setting-values-api';
package/dist/api.js CHANGED
@@ -31,4 +31,3 @@ __exportStar(require("./api/health-api"), exports);
31
31
  __exportStar(require("./api/public-keys-api"), exports);
32
32
  __exportStar(require("./api/setting-definitions-api"), exports);
33
33
  __exportStar(require("./api/setting-keys-api"), exports);
34
- __exportStar(require("./api/setting-values-api"), exports);
@@ -14,7 +14,6 @@ export * from './inline-response503';
14
14
  export * from './list-public-keys-response-class';
15
15
  export * from './list-setting-definitions-response-class';
16
16
  export * from './list-setting-keys-response-class';
17
- export * from './list-setting-values-response-class';
18
17
  export * from './public-key-class';
19
18
  export * from './rotate-public-key-response-class';
20
19
  export * from './setting-definition-class';
@@ -30,7 +30,6 @@ __exportStar(require("./inline-response503"), exports);
30
30
  __exportStar(require("./list-public-keys-response-class"), exports);
31
31
  __exportStar(require("./list-setting-definitions-response-class"), exports);
32
32
  __exportStar(require("./list-setting-keys-response-class"), exports);
33
- __exportStar(require("./list-setting-values-response-class"), exports);
34
33
  __exportStar(require("./public-key-class"), exports);
35
34
  __exportStar(require("./rotate-public-key-response-class"), exports);
36
35
  __exportStar(require("./setting-definition-class"), exports);
@@ -77,7 +77,7 @@ export interface SettingKeyClass {
77
77
  */
78
78
  'updatedBy': string;
79
79
  /**
80
- * Value versions with payload and etag. Populated on create, update, and get responses. Use the values list endpoint for full version history.
80
+ * Setting values with payload and etag. Populated on create, update, and get responses. On list, included when expand=values is requested.
81
81
  * @type {Array<SettingValueClass>}
82
82
  * @memberof SettingKeyClass
83
83
  */
package/models/index.ts CHANGED
@@ -14,7 +14,6 @@ export * from './inline-response503';
14
14
  export * from './list-public-keys-response-class';
15
15
  export * from './list-setting-definitions-response-class';
16
16
  export * from './list-setting-keys-response-class';
17
- export * from './list-setting-values-response-class';
18
17
  export * from './public-key-class';
19
18
  export * from './rotate-public-key-response-class';
20
19
  export * from './setting-definition-class';
@@ -82,7 +82,7 @@ export interface SettingKeyClass {
82
82
  */
83
83
  'updatedBy': string;
84
84
  /**
85
- * Value versions with payload and etag. Populated on create, update, and get responses. Use the values list endpoint for full version history.
85
+ * Setting values with payload and etag. Populated on create, update, and get responses. On list, included when expand=values is requested.
86
86
  * @type {Array<SettingValueClass>}
87
87
  * @memberof SettingKeyClass
88
88
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/setting-sdk",
3
- "version": "0.3.1-beta.25",
3
+ "version": "0.3.1-beta.26",
4
4
  "description": "OpenAPI client for @emilgroup/setting-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -1,246 +0,0 @@
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
- /**
26
- * SettingValuesApi - axios parameter creator
27
- * @export
28
- */
29
- export const SettingValuesApiAxiosParamCreator = function (configuration?: Configuration) {
30
- return {
31
- /**
32
- * 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\"
33
- * @summary List setting values
34
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
35
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
36
- * @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.
37
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
38
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
39
- * @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.
40
- * @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;
41
- * @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.
42
- * @param {*} [options] Override http request option.
43
- * @throws {RequiredError}
44
- */
45
- listSettingValues: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
46
- const localVarPath = `/settingservice/v2/setting-values`;
47
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
48
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
49
- let baseOptions;
50
- let baseAccessToken;
51
- if (configuration) {
52
- baseOptions = configuration.baseOptions;
53
- baseAccessToken = configuration.accessToken;
54
- }
55
-
56
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
57
- const localVarHeaderParameter = {} as any;
58
- const localVarQueryParameter = {} as any;
59
-
60
- // authentication bearer required
61
- // http bearer authentication required
62
- await setBearerAuthToObject(localVarHeaderParameter, configuration)
63
-
64
- if (pageSize !== undefined) {
65
- localVarQueryParameter['pageSize'] = pageSize;
66
- }
67
-
68
- if (pageToken !== undefined) {
69
- localVarQueryParameter['pageToken'] = pageToken;
70
- }
71
-
72
- if (filter !== undefined) {
73
- localVarQueryParameter['filter'] = filter;
74
- }
75
-
76
- if (search !== undefined) {
77
- localVarQueryParameter['search'] = search;
78
- }
79
-
80
- if (order !== undefined) {
81
- localVarQueryParameter['order'] = order;
82
- }
83
-
84
- if (expand !== undefined) {
85
- localVarQueryParameter['expand'] = expand;
86
- }
87
-
88
- if (filters !== undefined) {
89
- localVarQueryParameter['filters'] = filters;
90
- }
91
-
92
- if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
93
- localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
94
- }
95
-
96
-
97
-
98
- setSearchParams(localVarUrlObj, localVarQueryParameter);
99
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
100
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
101
-
102
- return {
103
- url: toPathString(localVarUrlObj),
104
- options: localVarRequestOptions,
105
- };
106
- },
107
- }
108
- };
109
-
110
- /**
111
- * SettingValuesApi - functional programming interface
112
- * @export
113
- */
114
- export const SettingValuesApiFp = function(configuration?: Configuration) {
115
- const localVarAxiosParamCreator = SettingValuesApiAxiosParamCreator(configuration)
116
- return {
117
- /**
118
- * 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\"
119
- * @summary List setting values
120
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
121
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
122
- * @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.
123
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
124
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
125
- * @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.
126
- * @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;
127
- * @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.
128
- * @param {*} [options] Override http request option.
129
- * @throws {RequiredError}
130
- */
131
- 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>> {
132
- const localVarAxiosArgs = await localVarAxiosParamCreator.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
133
- return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
134
- },
135
- }
136
- };
137
-
138
- /**
139
- * SettingValuesApi - factory interface
140
- * @export
141
- */
142
- export const SettingValuesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
143
- const localVarFp = SettingValuesApiFp(configuration)
144
- return {
145
- /**
146
- * 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\"
147
- * @summary List setting values
148
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
149
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
150
- * @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.
151
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
152
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
153
- * @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.
154
- * @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;
155
- * @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.
156
- * @param {*} [options] Override http request option.
157
- * @throws {RequiredError}
158
- */
159
- listSettingValues(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingValuesResponseClass> {
160
- return localVarFp.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
161
- },
162
- };
163
- };
164
-
165
- /**
166
- * Request parameters for listSettingValues operation in SettingValuesApi.
167
- * @export
168
- * @interface SettingValuesApiListSettingValuesRequest
169
- */
170
- export interface SettingValuesApiListSettingValuesRequest {
171
- /**
172
- * Bearer Token: provided by the login endpoint under the name accessToken.
173
- * @type {string}
174
- * @memberof SettingValuesApiListSettingValues
175
- */
176
- readonly authorization?: string
177
-
178
- /**
179
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
180
- * @type {number}
181
- * @memberof SettingValuesApiListSettingValues
182
- */
183
- readonly pageSize?: number
184
-
185
- /**
186
- * 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.
187
- * @type {string}
188
- * @memberof SettingValuesApiListSettingValues
189
- */
190
- readonly pageToken?: string
191
-
192
- /**
193
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
194
- * @type {string}
195
- * @memberof SettingValuesApiListSettingValues
196
- */
197
- readonly filter?: string
198
-
199
- /**
200
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
201
- * @type {string}
202
- * @memberof SettingValuesApiListSettingValues
203
- */
204
- readonly search?: string
205
-
206
- /**
207
- * 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.
208
- * @type {string}
209
- * @memberof SettingValuesApiListSettingValues
210
- */
211
- readonly order?: string
212
-
213
- /**
214
- * 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;
215
- * @type {string}
216
- * @memberof SettingValuesApiListSettingValues
217
- */
218
- readonly expand?: string
219
-
220
- /**
221
- * 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
- * @type {string}
223
- * @memberof SettingValuesApiListSettingValues
224
- */
225
- readonly filters?: string
226
- }
227
-
228
- /**
229
- * SettingValuesApi - object-oriented interface
230
- * @export
231
- * @class SettingValuesApi
232
- * @extends {BaseAPI}
233
- */
234
- export class SettingValuesApi extends BaseAPI {
235
- /**
236
- * 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\"
237
- * @summary List setting values
238
- * @param {SettingValuesApiListSettingValuesRequest} requestParameters Request parameters.
239
- * @param {*} [options] Override http request option.
240
- * @throws {RequiredError}
241
- * @memberof SettingValuesApi
242
- */
243
- public listSettingValues(requestParameters: SettingValuesApiListSettingValuesRequest = {}, options?: AxiosRequestConfig) {
244
- 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));
245
- }
246
- }
@@ -1,150 +0,0 @@
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 { ListSettingValuesResponseClass } from '../models';
16
- /**
17
- * SettingValuesApi - axios parameter creator
18
- * @export
19
- */
20
- export declare const SettingValuesApiAxiosParamCreator: (configuration?: Configuration) => {
21
- /**
22
- * 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\"
23
- * @summary List setting values
24
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
25
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
26
- * @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.
27
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
28
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
29
- * @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.
30
- * @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;
31
- * @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.
32
- * @param {*} [options] Override http request option.
33
- * @throws {RequiredError}
34
- */
35
- listSettingValues: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
36
- };
37
- /**
38
- * SettingValuesApi - functional programming interface
39
- * @export
40
- */
41
- export declare const SettingValuesApiFp: (configuration?: Configuration) => {
42
- /**
43
- * 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\"
44
- * @summary List setting values
45
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
46
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
47
- * @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.
48
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
49
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
50
- * @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.
51
- * @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;
52
- * @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.
53
- * @param {*} [options] Override http request option.
54
- * @throws {RequiredError}
55
- */
56
- 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>>;
57
- };
58
- /**
59
- * SettingValuesApi - factory interface
60
- * @export
61
- */
62
- export declare const SettingValuesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
63
- /**
64
- * 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\"
65
- * @summary List setting values
66
- * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
67
- * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
68
- * @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.
69
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
70
- * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
71
- * @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.
72
- * @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;
73
- * @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.
74
- * @param {*} [options] Override http request option.
75
- * @throws {RequiredError}
76
- */
77
- listSettingValues(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingValuesResponseClass>;
78
- };
79
- /**
80
- * Request parameters for listSettingValues operation in SettingValuesApi.
81
- * @export
82
- * @interface SettingValuesApiListSettingValuesRequest
83
- */
84
- export interface SettingValuesApiListSettingValuesRequest {
85
- /**
86
- * Bearer Token: provided by the login endpoint under the name accessToken.
87
- * @type {string}
88
- * @memberof SettingValuesApiListSettingValues
89
- */
90
- readonly authorization?: string;
91
- /**
92
- * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
93
- * @type {number}
94
- * @memberof SettingValuesApiListSettingValues
95
- */
96
- readonly pageSize?: number;
97
- /**
98
- * 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.
99
- * @type {string}
100
- * @memberof SettingValuesApiListSettingValues
101
- */
102
- readonly pageToken?: string;
103
- /**
104
- * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
105
- * @type {string}
106
- * @memberof SettingValuesApiListSettingValues
107
- */
108
- readonly filter?: string;
109
- /**
110
- * To search the list by any field, pass search&#x3D;xxx to fetch the result.
111
- * @type {string}
112
- * @memberof SettingValuesApiListSettingValues
113
- */
114
- readonly search?: string;
115
- /**
116
- * 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.
117
- * @type {string}
118
- * @memberof SettingValuesApiListSettingValues
119
- */
120
- readonly order?: string;
121
- /**
122
- * 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;
123
- * @type {string}
124
- * @memberof SettingValuesApiListSettingValues
125
- */
126
- readonly expand?: string;
127
- /**
128
- * 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.
129
- * @type {string}
130
- * @memberof SettingValuesApiListSettingValues
131
- */
132
- readonly filters?: string;
133
- }
134
- /**
135
- * SettingValuesApi - object-oriented interface
136
- * @export
137
- * @class SettingValuesApi
138
- * @extends {BaseAPI}
139
- */
140
- export declare class SettingValuesApi extends BaseAPI {
141
- /**
142
- * 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\"
143
- * @summary List setting values
144
- * @param {SettingValuesApiListSettingValuesRequest} requestParameters Request parameters.
145
- * @param {*} [options] Override http request option.
146
- * @throws {RequiredError}
147
- * @memberof SettingValuesApi
148
- */
149
- listSettingValues(requestParameters?: SettingValuesApiListSettingValuesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListSettingValuesResponseClass, any, {}>>;
150
- }