@emilgroup/changelog-sdk 1.0.1-beta.1 → 1.0.1-beta.11

package/.openapi-generator/FILES

@@ -3,6 +3,7 @@
 .openapi-generator-ignore
 README.md
 api.ts
+api/changelog-configurations-api.ts
 api/changelog-events-api.ts
 api/health-checks-api.ts
 base.ts
@@ -10,12 +11,27 @@ common.ts
 configuration.ts
 git_push.sh
 index.ts
+models/changelog-config-field-class.ts
+models/changelog-config-field-dto.ts
+models/changelog-config-section-class.ts
+models/changelog-config-section-dto.ts
+models/changelog-configuration-class.ts
 models/changelog-event-class-changes.ts
 models/changelog-event-class.ts
+models/composite-source-dto.ts
+models/create-changelog-configuration-dto.ts
+models/formatted-changelog-event.ts
+models/formatted-field-entry.ts
+models/formatted-section.ts
+models/get-changelog-configuration-response-class.ts
 models/get-changelog-event-response-class.ts
 models/index.ts
 models/inline-response200.ts
 models/inline-response503.ts
+models/json-sub-field-dto.ts
+models/list-changelog-configurations-response-class.ts
 models/list-changelog-events-response-class.ts
+models/list-formatted-changelog-events-response-class.ts
+models/update-changelog-configuration-dto.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/changelog-sdk@1.0.1-beta.1 --save
+npm install @emilgroup/changelog-sdk@1.0.1-beta.11 --save
 ```
 or 
 ```
-yarn add @emilgroup/changelog-sdk@1.0.1-beta.1
+yarn add @emilgroup/changelog-sdk@1.0.1-beta.11
 ```
 
 And then you can import ``.

package/api/changelog-configurations-api.ts

@@ -0,0 +1,572 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL Changelogservice
+ * The EMIL Changelog Service 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 { CreateChangelogConfigurationDto } from '../models';
+// @ts-ignore
+import { GetChangelogConfigurationResponseClass } from '../models';
+// @ts-ignore
+import { ListChangelogConfigurationsResponseClass } from '../models';
+// @ts-ignore
+import { UpdateChangelogConfigurationDto } from '../models';
+/**
+ * ChangelogConfigurationsApi - axios parameter creator
+ * @export
+ */
+export const ChangelogConfigurationsApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Creates a new changelog configuration for an entity type  **Required Permissions**  none
+         * @summary Create the changelog configuration
+         * @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createChangelogConfiguration: async (createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'createChangelogConfigurationDto' is not null or undefined
+            assertParamExists('createChangelogConfiguration', 'createChangelogConfigurationDto', createChangelogConfigurationDto)
+            const localVarPath = `/changelogservice/v1/changelog-configurations`;
+            // 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(createChangelogConfigurationDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+        /**
+         * Retrieves a changelog configuration by its code  **Required Permissions**  none
+         * @summary Retrieve the changelog configuration
+         * @param {string} code Unique identifier code for the changelog configuration
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getChangelogConfiguration: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('getChangelogConfiguration', 'code', code)
+            const localVarPath = `/changelogservice/v1/changelog-configurations/{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 changelog configurations you have previously created.          The changelog configurations are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  none
+         * @summary List changelog configurations
+         * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, slug, entityType&lt;/i&gt;
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+         * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listChangelogConfigurations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/changelogservice/v1/changelog-configurations`;
+            // 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,
+            };
+        },
+        /**
+         * Updates an existing changelog configuration  **Required Permissions**  none
+         * @summary Update the changelog configuration
+         * @param {string} code Unique identifier code for the changelog configuration
+         * @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateChangelogConfiguration: async (code: string, updateChangelogConfigurationDto: UpdateChangelogConfigurationDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
+            // verify required parameter 'code' is not null or undefined
+            assertParamExists('updateChangelogConfiguration', 'code', code)
+            // verify required parameter 'updateChangelogConfigurationDto' is not null or undefined
+            assertParamExists('updateChangelogConfiguration', 'updateChangelogConfigurationDto', updateChangelogConfigurationDto)
+            const localVarPath = `/changelogservice/v1/changelog-configurations/{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: 'PUT', ...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(updateChangelogConfigurationDto, localVarRequestOptions, configuration)
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * ChangelogConfigurationsApi - functional programming interface
+ * @export
+ */
+export const ChangelogConfigurationsApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = ChangelogConfigurationsApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Creates a new changelog configuration for an entity type  **Required Permissions**  none
+         * @summary Create the changelog configuration
+         * @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async createChangelogConfiguration(createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.createChangelogConfiguration(createChangelogConfigurationDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Retrieves a changelog configuration by its code  **Required Permissions**  none
+         * @summary Retrieve the changelog configuration
+         * @param {string} code Unique identifier code for the changelog configuration
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async getChangelogConfiguration(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.getChangelogConfiguration(code, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Returns a list of changelog configurations you have previously created.          The changelog configurations are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  none
+         * @summary List changelog configurations
+         * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, slug, entityType&lt;/i&gt;
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+         * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listChangelogConfigurations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListChangelogConfigurationsResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+        /**
+         * Updates an existing changelog configuration  **Required Permissions**  none
+         * @summary Update the changelog configuration
+         * @param {string} code Unique identifier code for the changelog configuration
+         * @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async updateChangelogConfiguration(code: string, updateChangelogConfigurationDto: UpdateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.updateChangelogConfiguration(code, updateChangelogConfigurationDto, authorization, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
+    }
+};
+
+/**
+ * ChangelogConfigurationsApi - factory interface
+ * @export
+ */
+export const ChangelogConfigurationsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = ChangelogConfigurationsApiFp(configuration)
+    return {
+        /**
+         * Creates a new changelog configuration for an entity type  **Required Permissions**  none
+         * @summary Create the changelog configuration
+         * @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        createChangelogConfiguration(createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass> {
+            return localVarFp.createChangelogConfiguration(createChangelogConfigurationDto, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Retrieves a changelog configuration by its code  **Required Permissions**  none
+         * @summary Retrieve the changelog configuration
+         * @param {string} code Unique identifier code for the changelog configuration
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        getChangelogConfiguration(code: string, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass> {
+            return localVarFp.getChangelogConfiguration(code, authorization, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Returns a list of changelog configurations you have previously created.          The changelog configurations are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  none
+         * @summary List changelog configurations
+         * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, slug, entityType&lt;/i&gt;
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+         * @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.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listChangelogConfigurations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogConfigurationsResponseClass> {
+            return localVarFp.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
+        },
+        /**
+         * Updates an existing changelog configuration  **Required Permissions**  none
+         * @summary Update the changelog configuration
+         * @param {string} code Unique identifier code for the changelog configuration
+         * @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto 
+         * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        updateChangelogConfiguration(code: string, updateChangelogConfigurationDto: UpdateChangelogConfigurationDto, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass> {
+            return localVarFp.updateChangelogConfiguration(code, updateChangelogConfigurationDto, authorization, options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * Request parameters for createChangelogConfiguration operation in ChangelogConfigurationsApi.
+ * @export
+ * @interface ChangelogConfigurationsApiCreateChangelogConfigurationRequest
+ */
+export interface ChangelogConfigurationsApiCreateChangelogConfigurationRequest {
+    /**
+     * 
+     * @type {CreateChangelogConfigurationDto}
+     * @memberof ChangelogConfigurationsApiCreateChangelogConfiguration
+     */
+    readonly createChangelogConfigurationDto: CreateChangelogConfigurationDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiCreateChangelogConfiguration
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for getChangelogConfiguration operation in ChangelogConfigurationsApi.
+ * @export
+ * @interface ChangelogConfigurationsApiGetChangelogConfigurationRequest
+ */
+export interface ChangelogConfigurationsApiGetChangelogConfigurationRequest {
+    /**
+     * Unique identifier code for the changelog configuration
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiGetChangelogConfiguration
+     */
+    readonly code: string
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiGetChangelogConfiguration
+     */
+    readonly authorization?: string
+}
+
+/**
+ * Request parameters for listChangelogConfigurations operation in ChangelogConfigurationsApi.
+ * @export
+ * @interface ChangelogConfigurationsApiListChangelogConfigurationsRequest
+ */
+export interface ChangelogConfigurationsApiListChangelogConfigurationsRequest {
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiListChangelogConfigurations
+     */
+    readonly authorization?: string
+
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof ChangelogConfigurationsApiListChangelogConfigurations
+     */
+    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 ChangelogConfigurationsApiListChangelogConfigurations
+     */
+    readonly pageToken?: string
+
+    /**
+     * Filter the response by one or multiple fields.            In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiListChangelogConfigurations
+     */
+    readonly filter?: string
+
+    /**
+     * Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Searchable fields: code, slug, entityType&lt;/i&gt;
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiListChangelogConfigurations
+     */
+    readonly search?: string
+
+    /**
+     * Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiListChangelogConfigurations
+     */
+    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 ChangelogConfigurationsApiListChangelogConfigurations
+     */
+    readonly expand?: string
+
+    /**
+     * Filters the response by one or multiple fields.            Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt;           &lt;br/&gt;           &lt;i&gt;Allowed values: id, code, slug, entityType, createdAt, updatedAt&lt;/i&gt;
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiListChangelogConfigurations
+     */
+    readonly filters?: string
+}
+
+/**
+ * Request parameters for updateChangelogConfiguration operation in ChangelogConfigurationsApi.
+ * @export
+ * @interface ChangelogConfigurationsApiUpdateChangelogConfigurationRequest
+ */
+export interface ChangelogConfigurationsApiUpdateChangelogConfigurationRequest {
+    /**
+     * Unique identifier code for the changelog configuration
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiUpdateChangelogConfiguration
+     */
+    readonly code: string
+
+    /**
+     * 
+     * @type {UpdateChangelogConfigurationDto}
+     * @memberof ChangelogConfigurationsApiUpdateChangelogConfiguration
+     */
+    readonly updateChangelogConfigurationDto: UpdateChangelogConfigurationDto
+
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ChangelogConfigurationsApiUpdateChangelogConfiguration
+     */
+    readonly authorization?: string
+}
+
+/**
+ * ChangelogConfigurationsApi - object-oriented interface
+ * @export
+ * @class ChangelogConfigurationsApi
+ * @extends {BaseAPI}
+ */
+export class ChangelogConfigurationsApi extends BaseAPI {
+    /**
+     * Creates a new changelog configuration for an entity type  **Required Permissions**  none
+     * @summary Create the changelog configuration
+     * @param {ChangelogConfigurationsApiCreateChangelogConfigurationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChangelogConfigurationsApi
+     */
+    public createChangelogConfiguration(requestParameters: ChangelogConfigurationsApiCreateChangelogConfigurationRequest, options?: AxiosRequestConfig) {
+        return ChangelogConfigurationsApiFp(this.configuration).createChangelogConfiguration(requestParameters.createChangelogConfigurationDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Retrieves a changelog configuration by its code  **Required Permissions**  none
+     * @summary Retrieve the changelog configuration
+     * @param {ChangelogConfigurationsApiGetChangelogConfigurationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChangelogConfigurationsApi
+     */
+    public getChangelogConfiguration(requestParameters: ChangelogConfigurationsApiGetChangelogConfigurationRequest, options?: AxiosRequestConfig) {
+        return ChangelogConfigurationsApiFp(this.configuration).getChangelogConfiguration(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Returns a list of changelog configurations you have previously created.          The changelog configurations are returned in sorted order, with the oldest one appearing first.          For more information about pagination, read the Pagination documentation.  **Required Permissions**  none
+     * @summary List changelog configurations
+     * @param {ChangelogConfigurationsApiListChangelogConfigurationsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChangelogConfigurationsApi
+     */
+    public listChangelogConfigurations(requestParameters: ChangelogConfigurationsApiListChangelogConfigurationsRequest = {}, options?: AxiosRequestConfig) {
+        return ChangelogConfigurationsApiFp(this.configuration).listChangelogConfigurations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
+    }
+
+    /**
+     * Updates an existing changelog configuration  **Required Permissions**  none
+     * @summary Update the changelog configuration
+     * @param {ChangelogConfigurationsApiUpdateChangelogConfigurationRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChangelogConfigurationsApi
+     */
+    public updateChangelogConfiguration(requestParameters: ChangelogConfigurationsApiUpdateChangelogConfigurationRequest, options?: AxiosRequestConfig) {
+        return ChangelogConfigurationsApiFp(this.configuration).updateChangelogConfiguration(requestParameters.code, requestParameters.updateChangelogConfigurationDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
+    }
+}