@emilgroup/setting-sdk-node 0.3.1-beta.17 → 0.3.1-beta.19

package/.openapi-generator/FILES

@@ -6,6 +6,8 @@ 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
@@ -13,18 +15,31 @@ git_push.sh
 index.ts
 models/create-public-key-request-dto.ts
 models/create-public-key-response-class.ts
+models/create-setting-definition-request-dto.ts
+models/create-setting-definition-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.17 --save
+npm install @emilgroup/setting-sdk-node@0.3.1-beta.19 --save
 ```
 or 
 ```
-yarn add @emilgroup/setting-sdk-node@0.3.1-beta.17
+yarn add @emilgroup/setting-sdk-node@0.3.1-beta.19
 ```
 
 And then you can import ``.

package/api/setting-definitions-api.ts

@@ -21,6 +21,10 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
 // @ts-ignore
 import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
 // @ts-ignore
+import { CreateSettingDefinitionRequestDto } from '../models';
+// @ts-ignore
+import { CreateSettingDefinitionResponseClass } from '../models';
+// @ts-ignore
 import { GetSettingDefinitionResponseClass } from '../models';
 // @ts-ignore
 import { ListSettingDefinitionsResponseClass } from '../models';
@@ -34,19 +38,66 @@ const FormData = require('form-data');
  */
 export const SettingDefinitionsApiAxiosParamCreator = function (configuration?: Configuration) {
     return {
+        /**
+         * Create a tenant setting definition  **Required Permissions**  \"tenant-management.settings.create\"
+         * @summary Create the setting definition
+         * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSettingDefinition: async (createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createSettingDefinitionRequestDto' is not null or undefined
+            assertParamExists('createSettingDefinition', 'createSettingDefinitionRequestDto', createSettingDefinitionRequestDto)
+            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: 'POST', ...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);
+            }
+
+
+    
+            localVarHeaderParameter['Content-Type'] = 'application/json';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+            localVarRequestOptions.data = serializeDataIfNeeded(createSettingDefinitionRequestDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
         /**
          * 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: async (key: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
-            // verify required parameter 'key' is not null or undefined
-            assertParamExists('getSettingDefinition', 'key', key)
-            const localVarPath = `/settingservice/v1/settings/definitions/{key}`
-                .replace(`{${"key"}}`, encodeURIComponent(String(key)));
+        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;
@@ -165,16 +216,28 @@ export const SettingDefinitionsApiAxiosParamCreator = function (configuration?:
 export const SettingDefinitionsApiFp = function(configuration?: Configuration) {
     const localVarAxiosParamCreator = SettingDefinitionsApiAxiosParamCreator(configuration)
     return {
+        /**
+         * Create a tenant setting definition  **Required Permissions**  \"tenant-management.settings.create\"
+         * @summary Create the setting definition
+         * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateSettingDefinitionResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, 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}
          */
-        async getSettingDefinition(key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSettingDefinitionResponseClass>> {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.getSettingDefinition(key, authorization, options);
+        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);
         },
         /**
@@ -205,16 +268,27 @@ export const SettingDefinitionsApiFp = function(configuration?: Configuration) {
 export const SettingDefinitionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
     const localVarFp = SettingDefinitionsApiFp(configuration)
     return {
+        /**
+         * Create a tenant setting definition  **Required Permissions**  \"tenant-management.settings.create\"
+         * @summary Create the setting definition
+         * @param {CreateSettingDefinitionRequestDto} createSettingDefinitionRequestDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createSettingDefinition(createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto, authorization?: string, options?: any): AxiosPromise<CreateSettingDefinitionResponseClass> {
+            return localVarFp.createSettingDefinition(createSettingDefinitionRequestDto, authorization, options).then((request) => request(axios, basePath));
+        },
         /**
          * 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> {
-            return localVarFp.getSettingDefinition(key, authorization, options).then((request) => request(axios, basePath));
+        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\"
@@ -236,6 +310,27 @@ export const SettingDefinitionsApiFactory = function (configuration?: Configurat
     };
 };
 
+/**
+ * Request parameters for createSettingDefinition operation in SettingDefinitionsApi.
+ * @export
+ * @interface SettingDefinitionsApiCreateSettingDefinitionRequest
+ */
+export interface SettingDefinitionsApiCreateSettingDefinitionRequest {
+    /**
+     * 
+     * @type {CreateSettingDefinitionRequestDto}
+     * @memberof SettingDefinitionsApiCreateSettingDefinition
+     */
+    readonly createSettingDefinitionRequestDto: CreateSettingDefinitionRequestDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof SettingDefinitionsApiCreateSettingDefinition
+     */
+    readonly authorization?: string
+}
+
 /**
  * Request parameters for getSettingDefinition operation in SettingDefinitionsApi.
  * @export
@@ -247,7 +342,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.
@@ -327,6 +422,18 @@ export interface SettingDefinitionsApiListSettingDefinitionsRequest {
  * @extends {BaseAPI}
  */
 export class SettingDefinitionsApi extends BaseAPI {
+    /**
+     * Create a tenant setting definition  **Required Permissions**  \"tenant-management.settings.create\"
+     * @summary Create the setting definition
+     * @param {SettingDefinitionsApiCreateSettingDefinitionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SettingDefinitionsApi
+     */
+    public createSettingDefinition(requestParameters: SettingDefinitionsApiCreateSettingDefinitionRequest, options?: AxiosRequestConfig) {
+        return SettingDefinitionsApiFp(this.configuration).createSettingDefinition(requestParameters.createSettingDefinitionRequestDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
     /**
      * 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
@@ -336,7 +443,7 @@ export class SettingDefinitionsApi extends BaseAPI {
      * @memberof SettingDefinitionsApi
      */
     public getSettingDefinition(requestParameters: SettingDefinitionsApiGetSettingDefinitionRequest, options?: AxiosRequestConfig) {
-        return SettingDefinitionsApiFp(this.configuration).getSettingDefinition(requestParameters.key, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+        return SettingDefinitionsApiFp(this.configuration).getSettingDefinition(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
     }
 
     /**