@emilgroup/changelog-sdk 1.0.1-beta.2 → 1.0.1-beta.4

package/dist/api/changelog-configurations-api.d.ts

@@ -14,6 +14,7 @@ import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
 import { CreateChangelogConfigurationDto } from '../models';
 import { GetChangelogConfigurationResponseClass } from '../models';
+import { ListChangelogConfigurationsResponseClass } from '../models';
 import { UpdateChangelogConfigurationDto } from '../models';
 /**
  * ChangelogConfigurationsApi - axios parameter creator
@@ -38,6 +39,21 @@ export declare const ChangelogConfigurationsApiAxiosParamCreator: (configuration
      * @throws {RequiredError}
      */
     getChangelogConfiguration: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * 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?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Updates an existing changelog configuration  **Required Permissions**  none
      * @summary Update the changelog configuration
@@ -72,6 +88,21 @@ export declare const ChangelogConfigurationsApiFp: (configuration?: Configuratio
      * @throws {RequiredError}
      */
     getChangelogConfiguration(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>>;
+    /**
+     * 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?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListChangelogConfigurationsResponseClass>>;
     /**
      * Updates an existing changelog configuration  **Required Permissions**  none
      * @summary Update the changelog configuration
@@ -106,6 +137,21 @@ export declare const ChangelogConfigurationsApiFactory: (configuration?: Configu
      * @throws {RequiredError}
      */
     getChangelogConfiguration(code: string, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass>;
+    /**
+     * 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>;
     /**
      * Updates an existing changelog configuration  **Required Permissions**  none
      * @summary Update the changelog configuration
@@ -155,6 +201,61 @@ export interface ChangelogConfigurationsApiGetChangelogConfigurationRequest {
      */
     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
@@ -205,6 +306,15 @@ export declare class ChangelogConfigurationsApi extends BaseAPI {
      * @memberof ChangelogConfigurationsApi
      */
     getChangelogConfiguration(requestParameters: ChangelogConfigurationsApiGetChangelogConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangelogConfigurationResponseClass, any, {}>>;
+    /**
+     * 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
+     */
+    listChangelogConfigurations(requestParameters?: ChangelogConfigurationsApiListChangelogConfigurationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListChangelogConfigurationsResponseClass, any, {}>>;
     /**
      * Updates an existing changelog configuration  **Required Permissions**  none
      * @summary Update the changelog configuration

package/dist/api/changelog-configurations-api.js

@@ -189,6 +189,78 @@ var ChangelogConfigurationsApiAxiosParamCreator = function (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=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.<br/>           <br/>           <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, slug, entityType</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
+         * @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.<br/>           <br/>           <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listChangelogConfigurations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, 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:
+                            localVarPath = "/changelogservice/v1/changelog-configurations";
+                            localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+                            if (configuration) {
+                                baseOptions = configuration.baseOptions;
+                                baseAccessToken = configuration.accessToken;
+                            }
+                            localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
+                            localVarHeaderParameter = {};
+                            localVarQueryParameter = {};
+                            // authentication bearer required
+                            // http bearer authentication required
+                            return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
+                        case 1:
+                            // authentication bearer required
+                            // http bearer authentication required
+                            _a.sent();
+                            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);
+                            }
+                            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+                            headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+                            localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+                            return [2 /*return*/, {
+                                    url: (0, common_1.toPathString)(localVarUrlObj),
+                                    options: localVarRequestOptions,
+                                }];
+                    }
+                });
+            });
+        },
         /**
          * Updates an existing changelog configuration  **Required Permissions**  none
          * @summary Update the changelog configuration
@@ -294,6 +366,33 @@ var ChangelogConfigurationsApiFp = function (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=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.<br/>           <br/>           <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, slug, entityType</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
+         * @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.<br/>           <br/>           <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listChangelogConfigurations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, 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.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
+                        case 1:
+                            localVarAxiosArgs = _a.sent();
+                            return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
+                    }
+                });
+            });
+        },
         /**
          * Updates an existing changelog configuration  **Required Permissions**  none
          * @summary Update the changelog configuration
@@ -348,6 +447,23 @@ var ChangelogConfigurationsApiFactory = function (configuration, basePath, axios
         getChangelogConfiguration: function (code, authorization, options) {
             return localVarFp.getChangelogConfiguration(code, authorization, options).then(function (request) { return 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=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.<br/>           <br/>           <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
+         * @param {string} [search] Search the response for matches in any searchable field.            Use filter instead where possible for improved performance.<br/>           <br/>           <i>Searchable fields: code, slug, entityType</i>
+         * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by           ascending (ASC) or descending (DESC) order.<br/>           <br/>           <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
+         * @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.<br/>           <br/>           <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listChangelogConfigurations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
+            return localVarFp.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
+        },
         /**
          * Updates an existing changelog configuration  **Required Permissions**  none
          * @summary Update the changelog configuration
@@ -398,6 +514,19 @@ var ChangelogConfigurationsApi = /** @class */ (function (_super) {
         var _this = this;
         return (0, exports.ChangelogConfigurationsApiFp)(this.configuration).getChangelogConfiguration(requestParameters.code, requestParameters.authorization, options).then(function (request) { return 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
+     */
+    ChangelogConfigurationsApi.prototype.listChangelogConfigurations = function (requestParameters, options) {
+        var _this = this;
+        if (requestParameters === void 0) { requestParameters = {}; }
+        return (0, exports.ChangelogConfigurationsApiFp)(this.configuration).listChangelogConfigurations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
+    };
     /**
      * Updates an existing changelog configuration  **Required Permissions**  none
      * @summary Update the changelog configuration

package/dist/api/changelog-events-api.d.ts

@@ -14,6 +14,7 @@ import { Configuration } from '../configuration';
 import { RequestArgs, BaseAPI } from '../base';
 import { GetChangelogEventResponseClass } from '../models';
 import { ListChangelogEventsResponseClass } from '../models';
+import { ListFormattedChangelogEventsResponseClass } from '../models';
 /**
  * ChangelogEventsApi - axios parameter creator
  * @export
@@ -43,6 +44,22 @@ export declare const ChangelogEventsApiAxiosParamCreator: (configuration?: Confi
      * @throws {RequiredError}
      */
     listChangelogEvents: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns a list of formatted changelog events you have previously created.          The formatted changelog events 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 formatted changelog events
+     * @param {string} configSlug Slug of the changelog configuration to apply
+     * @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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt&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, entityCode, actorName, sourceService&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, occurredAt, createdAt, entityType, action&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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFormattedChangelogEvents: (configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * ChangelogEventsApi - functional programming interface
@@ -73,6 +90,22 @@ export declare const ChangelogEventsApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     listChangelogEvents(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListChangelogEventsResponseClass>>;
+    /**
+     * Returns a list of formatted changelog events you have previously created.          The formatted changelog events 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 formatted changelog events
+     * @param {string} configSlug Slug of the changelog configuration to apply
+     * @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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt&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, entityCode, actorName, sourceService&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, occurredAt, createdAt, entityType, action&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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFormattedChangelogEvents(configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFormattedChangelogEventsResponseClass>>;
 };
 /**
  * ChangelogEventsApi - factory interface
@@ -103,6 +136,22 @@ export declare const ChangelogEventsApiFactory: (configuration?: Configuration,
      * @throws {RequiredError}
      */
     listChangelogEvents(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogEventsResponseClass>;
+    /**
+     * Returns a list of formatted changelog events you have previously created.          The formatted changelog events 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 formatted changelog events
+     * @param {string} configSlug Slug of the changelog configuration to apply
+     * @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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt&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, entityCode, actorName, sourceService&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, occurredAt, createdAt, entityType, action&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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt&lt;/i&gt;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listFormattedChangelogEvents(configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFormattedChangelogEventsResponseClass>;
 };
 /**
  * Request parameters for getChangelogEvent operation in ChangelogEventsApi.
@@ -178,6 +227,67 @@ export interface ChangelogEventsApiListChangelogEventsRequest {
      */
     readonly filters?: string;
 }
+/**
+ * Request parameters for listFormattedChangelogEvents operation in ChangelogEventsApi.
+ * @export
+ * @interface ChangelogEventsApiListFormattedChangelogEventsRequest
+ */
+export interface ChangelogEventsApiListFormattedChangelogEventsRequest {
+    /**
+     * Slug of the changelog configuration to apply
+     * @type {string}
+     * @memberof ChangelogEventsApiListFormattedChangelogEvents
+     */
+    readonly configSlug: string;
+    /**
+     * Bearer Token: provided by the login endpoint under the name accessToken.
+     * @type {string}
+     * @memberof ChangelogEventsApiListFormattedChangelogEvents
+     */
+    readonly authorization?: string;
+    /**
+     * A limit on the number of objects to be returned.     Limit ranges between 1 and 50. Default: 10.
+     * @type {number}
+     * @memberof ChangelogEventsApiListFormattedChangelogEvents
+     */
+    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 ChangelogEventsApiListFormattedChangelogEvents
+     */
+    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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof ChangelogEventsApiListFormattedChangelogEvents
+     */
+    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, entityCode, actorName, sourceService&lt;/i&gt;
+     * @type {string}
+     * @memberof ChangelogEventsApiListFormattedChangelogEvents
+     */
+    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, occurredAt, createdAt, entityType, action&lt;/i&gt;
+     * @type {string}
+     * @memberof ChangelogEventsApiListFormattedChangelogEvents
+     */
+    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 ChangelogEventsApiListFormattedChangelogEvents
+     */
+    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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt&lt;/i&gt;
+     * @type {string}
+     * @memberof ChangelogEventsApiListFormattedChangelogEvents
+     */
+    readonly filters?: string;
+}
 /**
  * ChangelogEventsApi - object-oriented interface
  * @export
@@ -203,4 +313,13 @@ export declare class ChangelogEventsApi extends BaseAPI {
      * @memberof ChangelogEventsApi
      */
     listChangelogEvents(requestParameters?: ChangelogEventsApiListChangelogEventsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListChangelogEventsResponseClass, any, {}>>;
+    /**
+     * Returns a list of formatted changelog events you have previously created.          The formatted changelog events 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 formatted changelog events
+     * @param {ChangelogEventsApiListFormattedChangelogEventsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChangelogEventsApi
+     */
+    listFormattedChangelogEvents(requestParameters: ChangelogEventsApiListFormattedChangelogEventsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFormattedChangelogEventsResponseClass, any, {}>>;
 }