@emilgroup/setting-sdk-node 0.3.1-beta.24 → 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.
@@ -198,7 +198,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
198
198
  * @param {string} code
199
199
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
200
200
  * @param {number} [version] Specific value version. Defaults to latest.
201
- * @param {string} [expand] Optional expand (definition only).
201
+ * @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>
202
202
  * @param {*} [options] Override http request option.
203
203
  * @throws {RequiredError}
204
204
  */
@@ -254,7 +254,7 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
254
254
  * @param {string} slug
255
255
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
256
256
  * @param {number} [version] Specific value version. Defaults to latest.
257
- * @param {string} [expand] Optional expand (definition only).
257
+ * @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>
258
258
  * @param {*} [options] Override http request option.
259
259
  * @throws {RequiredError}
260
260
  */
@@ -305,16 +305,16 @@ var SettingKeysApiAxiosParamCreator = function (configuration) {
305
305
  });
306
306
  },
307
307
  /**
308
- * 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\"
308
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
309
309
  * @summary List setting keys
310
310
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
311
311
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
312
312
  * @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.
313
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
313
+ * @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>
314
314
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
315
- * @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.
316
- * @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/>
317
- * @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.
315
+ * @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>
316
+ * @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>
317
+ * @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>
318
318
  * @param {*} [options] Override http request option.
319
319
  * @throws {RequiredError}
320
320
  */
@@ -492,7 +492,7 @@ var SettingKeysApiFp = function (configuration) {
492
492
  * @param {string} code
493
493
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
494
494
  * @param {number} [version] Specific value version. Defaults to latest.
495
- * @param {string} [expand] Optional expand (definition only).
495
+ * @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>
496
496
  * @param {*} [options] Override http request option.
497
497
  * @throws {RequiredError}
498
498
  */
@@ -515,7 +515,7 @@ var SettingKeysApiFp = function (configuration) {
515
515
  * @param {string} slug
516
516
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
517
517
  * @param {number} [version] Specific value version. Defaults to latest.
518
- * @param {string} [expand] Optional expand (definition only).
518
+ * @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>
519
519
  * @param {*} [options] Override http request option.
520
520
  * @throws {RequiredError}
521
521
  */
@@ -533,16 +533,16 @@ var SettingKeysApiFp = function (configuration) {
533
533
  });
534
534
  },
535
535
  /**
536
- * 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\"
536
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
537
537
  * @summary List setting keys
538
538
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
539
539
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
540
540
  * @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.
541
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
541
+ * @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>
542
542
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
543
- * @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.
544
- * @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/>
545
- * @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.
543
+ * @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>
544
+ * @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>
545
+ * @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>
546
546
  * @param {*} [options] Override http request option.
547
547
  * @throws {RequiredError}
548
548
  */
@@ -619,7 +619,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
619
619
  * @param {string} code
620
620
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
621
621
  * @param {number} [version] Specific value version. Defaults to latest.
622
- * @param {string} [expand] Optional expand (definition only).
622
+ * @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>
623
623
  * @param {*} [options] Override http request option.
624
624
  * @throws {RequiredError}
625
625
  */
@@ -632,7 +632,7 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
632
632
  * @param {string} slug
633
633
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
634
634
  * @param {number} [version] Specific value version. Defaults to latest.
635
- * @param {string} [expand] Optional expand (definition only).
635
+ * @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>
636
636
  * @param {*} [options] Override http request option.
637
637
  * @throws {RequiredError}
638
638
  */
@@ -640,16 +640,16 @@ var SettingKeysApiFactory = function (configuration, basePath, axios) {
640
640
  return localVarFp.getSettingKeyBySlug(slug, authorization, version, expand, options).then(function (request) { return request(axios, basePath); });
641
641
  },
642
642
  /**
643
- * 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\"
643
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
644
644
  * @summary List setting keys
645
645
  * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
646
646
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
647
647
  * @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.
648
- * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
648
+ * @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>
649
649
  * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
650
- * @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.
651
- * @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/>
652
- * @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.
650
+ * @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>
651
+ * @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>
652
+ * @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>
653
653
  * @param {*} [options] Override http request option.
654
654
  * @throws {RequiredError}
655
655
  */
@@ -731,7 +731,7 @@ var SettingKeysApi = /** @class */ (function (_super) {
731
731
  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); });
732
732
  };
733
733
  /**
734
- * 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\"
734
+ * List setting keys with optional filters, sorting, and pagination. Use expand=values to include setting values. **Required Permissions** \"tenant-management.settings.view\"
735
735
  * @summary List setting keys
736
736
  * @param {SettingKeysApiListSettingKeysRequest} requestParameters Request parameters.
737
737
  * @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-node",
3
- "version": "0.3.1-beta.24",
3
+ "version": "0.3.1-beta.26",
4
4
  "description": "OpenAPI client for @emilgroup/setting-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [
@@ -1,250 +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
- // 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&#x3D;1, your subsequent call can include pageToken&#x3D;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&#x3D;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.&lt;br/&gt; &lt;br/&gt;
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
- }
@@ -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
- }