@emilgroup/setting-sdk 0.3.1-beta.18 → 0.3.1-beta.19

package/api/setting-values-api.ts

@@ -0,0 +1,246 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL SettingService
+ * The EMIL SettingService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { Configuration } from '../configuration';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
+// @ts-ignore
+import { ListSettingValuesResponseClass } from '../models';
+/**
+ * SettingValuesApi - axios parameter creator
+ * @export
+ */
+export const SettingValuesApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 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\"
+         * @summary List setting values
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @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.
+         * @param {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {string} [search] To search the list by any field, pass search=xxx to fetch the result.
+         * @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.
+         * @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/>       
+         * @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.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSettingValues: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/settingservice/v2/setting-values`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            let baseAccessToken;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+                baseAccessToken = configuration.accessToken;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication bearer required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            if (pageSize !== undefined) {
+                localVarQueryParameter['pageSize'] = pageSize;
+            }
+
+            if (pageToken !== undefined) {
+                localVarQueryParameter['pageToken'] = pageToken;
+            }
+
+            if (filter !== undefined) {
+                localVarQueryParameter['filter'] = filter;
+            }
+
+            if (search !== undefined) {
+                localVarQueryParameter['search'] = search;
+            }
+
+            if (order !== undefined) {
+                localVarQueryParameter['order'] = order;
+            }
+
+            if (expand !== undefined) {
+                localVarQueryParameter['expand'] = expand;
+            }
+
+            if (filters !== undefined) {
+                localVarQueryParameter['filters'] = filters;
+            }
+
+            if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
+                localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
+            }
+
+
+    
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * SettingValuesApi - functional programming interface
+ * @export
+ */
+export const SettingValuesApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SettingValuesApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 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\"
+         * @summary List setting values
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @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.
+         * @param {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+         * @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.
+         * @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;       
+         * @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.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        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>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * SettingValuesApi - factory interface
+ * @export
+ */
+export const SettingValuesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SettingValuesApiFp(configuration)
+    return {
+        /**
+         * 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\"
+         * @summary List setting values
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {number} [pageSize] A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+         * @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.
+         * @param {string} [filter] Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+         * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
+         * @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.
+         * @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;       
+         * @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.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listSettingValues(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingValuesResponseClass> {
+            return localVarFp.listSettingValues(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for listSettingValues operation in SettingValuesApi.
+ * @export
+ * @interface SettingValuesApiListSettingValuesRequest
+ */
+export interface SettingValuesApiListSettingValuesRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettingValuesApiListSettingValues
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof SettingValuesApiListSettingValues
+     */
+    readonly pageSize?: number
+
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SettingValuesApiListSettingValues
+     */
+    readonly pageToken?: string
+
+    /**
+     * Filter the response by one or multiple fields.     In general, fetching filtered responses will conserve bandwidth and reduce response time.
+     * @type {string}
+     * @memberof SettingValuesApiListSettingValues
+     */
+    readonly filter?: string
+
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof SettingValuesApiListSettingValues
+     */
+    readonly search?: string
+
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SettingValuesApiListSettingValues
+     */
+    readonly order?: string
+
+    /**
+     * 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;       
+     * @type {string}
+     * @memberof SettingValuesApiListSettingValues
+     */
+    readonly expand?: string
+
+    /**
+     * 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.
+     * @type {string}
+     * @memberof SettingValuesApiListSettingValues
+     */
+    readonly filters?: string
+}
+
+/**
+ * SettingValuesApi - object-oriented interface
+ * @export
+ * @class SettingValuesApi
+ * @extends {BaseAPI}
+ */
+export class SettingValuesApi extends BaseAPI {
+    /**
+     * 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\"
+     * @summary List setting values
+     * @param {SettingValuesApiListSettingValuesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SettingValuesApi
+     */
+    public listSettingValues(requestParameters: SettingValuesApiListSettingValuesRequest = {}, options?: AxiosRequestConfig) {
+        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));
+    }
+}

package/api.ts

@@ -23,9 +23,13 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
 import { HealthApi } from './api';
 import { PublicKeysApi } from './api';
 import { SettingDefinitionsApi } from './api';
+import { SettingKeysApi } from './api';
+import { SettingValuesApi } from './api';
 
 
 export * from './api/health-api';
 export * from './api/public-keys-api';
 export * from './api/setting-definitions-api';
+export * from './api/setting-keys-api';
+export * from './api/setting-values-api';
 

package/dist/api/setting-definitions-api.d.ts

@@ -22,12 +22,12 @@ export declare const SettingDefinitionsApiAxiosParamCreator: (configuration?: Co
     /**
      * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code      that was returned when you created it and Emil Api will return the corresponding setting definition information.  **Required Permissions**  \"tenant-management.settings.view\"
      * @summary Retrieve the setting definition
-     * @param {string} key
+     * @param {string} code
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSettingDefinition: (key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getSettingDefinition: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Returns a list of setting definitions you have previously created.         The setting definitions are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"tenant-management.settings.view\"
      * @summary List setting definitions
@@ -52,12 +52,12 @@ export declare const SettingDefinitionsApiFp: (configuration?: Configuration) =>
     /**
      * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code      that was returned when you created it and Emil Api will return the corresponding setting definition information.  **Required Permissions**  \"tenant-management.settings.view\"
      * @summary Retrieve the setting definition
-     * @param {string} key
+     * @param {string} code
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSettingDefinition(key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>>;
+    getSettingDefinition(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>>;
     /**
      * Returns a list of setting definitions you have previously created.         The setting definitions are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"tenant-management.settings.view\"
      * @summary List setting definitions
@@ -82,12 +82,12 @@ export declare const SettingDefinitionsApiFactory: (configuration?: Configuratio
     /**
      * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code      that was returned when you created it and Emil Api will return the corresponding setting definition information.  **Required Permissions**  \"tenant-management.settings.view\"
      * @summary Retrieve the setting definition
-     * @param {string} key
+     * @param {string} code
      * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getSettingDefinition(key: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
+    getSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass>;
     /**
      * Returns a list of setting definitions you have previously created.         The setting definitions are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"tenant-management.settings.view\"
      * @summary List setting definitions
@@ -115,7 +115,7 @@ export interface SettingDefinitionsApiGetSettingDefinitionRequest {
      * @type {string}
      * @memberof SettingDefinitionsApiGetSettingDefinition
      */
-    readonly key: string;
+    readonly code: string;
     /**
      * Bearer Token: provided by the login endpoint under the name accessToken.
      * @type {string}

package/dist/api/setting-definitions-api.js

@@ -95,22 +95,22 @@ var SettingDefinitionsApiAxiosParamCreator = function (configuration) {
         /**
          * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code      that was returned when you created it and Emil Api will return the corresponding setting definition information.  **Required Permissions**  \"tenant-management.settings.view\"
          * @summary Retrieve the setting definition
-         * @param {string} key
+         * @param {string} code
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSettingDefinition: function (key, authorization, options) {
+        getSettingDefinition: function (code, authorization, options) {
             if (options === void 0) { options = {}; }
             return __awaiter(_this, void 0, void 0, function () {
                 var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
                         case 0:
-                            // verify required parameter 'key' is not null or undefined
-                            (0, common_1.assertParamExists)('getSettingDefinition', 'key', key);
-                            localVarPath = "/settingservice/v1/settings/definitions/{key}"
-                                .replace("{".concat("key", "}"), encodeURIComponent(String(key)));
+                            // verify required parameter 'code' is not null or undefined
+                            (0, common_1.assertParamExists)('getSettingDefinition', 'code', code);
+                            localVarPath = "/settingservice/v1/settings/definitions/{code}"
+                                .replace("{".concat("code", "}"), encodeURIComponent(String(code)));
                             localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
                             if (configuration) {
                                 baseOptions = configuration.baseOptions;
@@ -225,17 +225,17 @@ var SettingDefinitionsApiFp = function (configuration) {
         /**
          * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code      that was returned when you created it and Emil Api will return the corresponding setting definition information.  **Required Permissions**  \"tenant-management.settings.view\"
          * @summary Retrieve the setting definition
-         * @param {string} key
+         * @param {string} code
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSettingDefinition: function (key, authorization, options) {
+        getSettingDefinition: function (code, authorization, options) {
             return __awaiter(this, void 0, void 0, function () {
                 var localVarAxiosArgs;
                 return __generator(this, function (_a) {
                     switch (_a.label) {
-                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(key, authorization, options)];
+                        case 0: return [4 /*yield*/, localVarAxiosParamCreator.getSettingDefinition(code, authorization, options)];
                         case 1:
                             localVarAxiosArgs = _a.sent();
                             return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -283,13 +283,13 @@ var SettingDefinitionsApiFactory = function (configuration, basePath, axios) {
         /**
          * Retrieves the details of the setting definition that was previously created. Supply the unique setting definition code      that was returned when you created it and Emil Api will return the corresponding setting definition information.  **Required Permissions**  \"tenant-management.settings.view\"
          * @summary Retrieve the setting definition
-         * @param {string} key
+         * @param {string} code
          * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        getSettingDefinition: function (key, authorization, options) {
-            return localVarFp.getSettingDefinition(key, authorization, options).then(function (request) { return request(axios, basePath); });
+        getSettingDefinition: function (code, authorization, options) {
+            return localVarFp.getSettingDefinition(code, authorization, options).then(function (request) { return request(axios, basePath); });
         },
         /**
          * Returns a list of setting definitions you have previously created.         The setting definitions are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"tenant-management.settings.view\"
@@ -332,7 +332,7 @@ var SettingDefinitionsApi = /** @class */ (function (_super) {
      */
     SettingDefinitionsApi.prototype.getSettingDefinition = function (requestParameters, options) {
         var _this = this;
-        return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.key, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
+        return (0, exports.SettingDefinitionsApiFp)(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
     };
     /**
      * Returns a list of setting definitions you have previously created.         The setting definitions are returned in sorted order, with the oldest one appearing first.         For more information about pagination, read the Pagination documentation.  **Required Permissions**  \"tenant-management.settings.view\"