@emilgroup/setting-sdk-node 0.3.1-beta.16 → 0.3.1-beta.18

package/.openapi-generator/FILES

@@ -5,6 +5,9 @@ README.md
 api.ts
 api/health-api.ts
 api/public-keys-api.ts
+api/setting-definitions-api.ts
+api/setting-keys-api.ts
+api/setting-values-api.ts
 base.ts
 common.ts
 configuration.ts
@@ -12,15 +15,29 @@ git_push.sh
 index.ts
 models/create-public-key-request-dto.ts
 models/create-public-key-response-class.ts
+models/create-setting-key-request-dto.ts
+models/create-setting-key-response-class.ts
 models/delete-public-key-request-dto.ts
+models/delete-setting-key-response-class.ts
 models/get-public-key-response-class.ts
+models/get-setting-definition-response-class.ts
+models/get-setting-key-response-class.ts
 models/index.ts
 models/inline-response200.ts
 models/inline-response503.ts
 models/list-public-keys-response-class.ts
+models/list-setting-definitions-response-class.ts
+models/list-setting-keys-response-class.ts
+models/list-setting-values-response-class.ts
 models/public-key-class.ts
 models/rotate-public-key-response-class.ts
+models/setting-definition-class.ts
+models/setting-definition-version-class.ts
+models/setting-key-class.ts
+models/setting-value-class.ts
 models/update-public-key-request-dto.ts
 models/update-public-key-response-class.ts
+models/update-setting-key-request-rest-dto.ts
+models/update-setting-key-response-class.ts
 package.json
 tsconfig.json

package/README.md

@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
 Navigate to the folder of your consuming project and run one of the following commands:
 
 ```
-npm install @emilgroup/setting-sdk-node@0.3.1-beta.16 --save
+npm install @emilgroup/setting-sdk-node@0.3.1-beta.18 --save
 ```
 or 
 ```
-yarn add @emilgroup/setting-sdk-node@0.3.1-beta.16
+yarn add @emilgroup/setting-sdk-node@0.3.1-beta.18
 ```
 
 And then you can import ``.

package/api/setting-definitions-api.ts

@@ -0,0 +1,353 @@
+/* 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 { GetSettingDefinitionResponseClass } from '../models';
+// @ts-ignore
+import { ListSettingDefinitionsResponseClass } from '../models';
+// URLSearchParams not necessarily used
+// @ts-ignore
+import { URL, URLSearchParams } from 'url';
+const FormData = require('form-data');
+/**
+ * SettingDefinitionsApi - axios parameter creator
+ * @export
+ */
+export const SettingDefinitionsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * 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} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSettingDefinition: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getSettingDefinition', 'code', code)
+            const localVarPath = `/settingservice/v1/settings/definitions/{code}`
+                .replace(`{${"code"}}`, encodeURIComponent(String(code)));
+            // 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 (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,
+            };
+        },
+        /**
+         * 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
+         * @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}
+         */
+        listSettingDefinitions: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/settingservice/v1/settings/definitions`;
+            // 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,
+            };
+        },
+    }
+};
+
+/**
+ * SettingDefinitionsApi - functional programming interface
+ * @export
+ */
+export const SettingDefinitionsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = SettingDefinitionsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * 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} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getSettingDefinition(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingDefinition(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * 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
+         * @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 listSettingDefinitions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListSettingDefinitionsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listSettingDefinitions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * SettingDefinitionsApi - factory interface
+ * @export
+ */
+export const SettingDefinitionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = SettingDefinitionsApiFp(configuration)
+    return {
+        /**
+         * 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} code 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getSettingDefinition(code: string, authorization?: string, options?: any): AxiosPromise<GetSettingDefinitionResponseClass> {
+            return localVarFp.getSettingDefinition(code, authorization, options).then((request) => 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\"
+         * @summary List setting definitions
+         * @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}
+         */
+        listSettingDefinitions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListSettingDefinitionsResponseClass> {
+            return localVarFp.listSettingDefinitions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for getSettingDefinition operation in SettingDefinitionsApi.
+ * @export
+ * @interface SettingDefinitionsApiGetSettingDefinitionRequest
+ */
+export interface SettingDefinitionsApiGetSettingDefinitionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof SettingDefinitionsApiGetSettingDefinition
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettingDefinitionsApiGetSettingDefinition
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listSettingDefinitions operation in SettingDefinitionsApi.
+ * @export
+ * @interface SettingDefinitionsApiListSettingDefinitionsRequest
+ */
+export interface SettingDefinitionsApiListSettingDefinitionsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettingDefinitionsApiListSettingDefinitions
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof SettingDefinitionsApiListSettingDefinitions
+     */
+    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 SettingDefinitionsApiListSettingDefinitions
+     */
+    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 SettingDefinitionsApiListSettingDefinitions
+     */
+    readonly filter?: string
+
+    /**
+     * To search the list by any field, pass search&#x3D;xxx to fetch the result.
+     * @type {string}
+     * @memberof SettingDefinitionsApiListSettingDefinitions
+     */
+    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 SettingDefinitionsApiListSettingDefinitions
+     */
+    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 SettingDefinitionsApiListSettingDefinitions
+     */
+    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 SettingDefinitionsApiListSettingDefinitions
+     */
+    readonly filters?: string
+}
+
+/**
+ * SettingDefinitionsApi - object-oriented interface
+ * @export
+ * @class SettingDefinitionsApi
+ * @extends {BaseAPI}
+ */
+export class SettingDefinitionsApi extends BaseAPI {
+    /**
+     * 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 {SettingDefinitionsApiGetSettingDefinitionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SettingDefinitionsApi
+     */
+    public getSettingDefinition(requestParameters: SettingDefinitionsApiGetSettingDefinitionRequest, options?: AxiosRequestConfig) {
+        return SettingDefinitionsApiFp(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then((request) => 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\"
+     * @summary List setting definitions
+     * @param {SettingDefinitionsApiListSettingDefinitionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SettingDefinitionsApi
+     */
+    public listSettingDefinitions(requestParameters: SettingDefinitionsApiListSettingDefinitionsRequest = {}, options?: AxiosRequestConfig) {
+        return SettingDefinitionsApiFp(this.configuration).listSettingDefinitions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
+    }
+}