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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (60) hide show
  1. package/.openapi-generator/FILES +16 -0
  2. package/README.md +2 -2
  3. package/api/changelog-configurations-api.ts +572 -0
  4. package/api/changelog-events-api.ts +205 -4
  5. package/api.ts +2 -0
  6. package/dist/api/changelog-configurations-api.d.ts +327 -0
  7. package/dist/api/changelog-configurations-api.js +544 -0
  8. package/dist/api/changelog-events-api.d.ts +123 -4
  9. package/dist/api/changelog-events-api.js +137 -3
  10. package/dist/api.d.ts +1 -0
  11. package/dist/api.js +1 -0
  12. package/dist/models/changelog-config-field-class.d.ts +72 -0
  13. package/dist/models/changelog-config-field-class.js +21 -0
  14. package/dist/models/changelog-config-field-dto.d.ts +74 -0
  15. package/dist/models/changelog-config-field-dto.js +21 -0
  16. package/dist/models/changelog-config-section-class.d.ts +43 -0
  17. package/dist/models/changelog-config-section-class.js +15 -0
  18. package/dist/models/changelog-config-section-dto.d.ts +43 -0
  19. package/dist/models/changelog-config-section-dto.js +15 -0
  20. package/dist/models/changelog-configuration-class.d.ts +67 -0
  21. package/dist/models/changelog-configuration-class.js +15 -0
  22. package/dist/models/composite-source-dto.d.ts +30 -0
  23. package/dist/models/composite-source-dto.js +15 -0
  24. package/dist/models/create-changelog-configuration-dto.d.ts +37 -0
  25. package/dist/models/create-changelog-configuration-dto.js +15 -0
  26. package/dist/models/formatted-changelog-event.d.ts +67 -0
  27. package/dist/models/formatted-changelog-event.js +15 -0
  28. package/dist/models/formatted-field-entry.d.ts +48 -0
  29. package/dist/models/formatted-field-entry.js +15 -0
  30. package/dist/models/formatted-section.d.ts +43 -0
  31. package/dist/models/formatted-section.js +15 -0
  32. package/dist/models/get-changelog-configuration-response-class.d.ts +25 -0
  33. package/dist/models/get-changelog-configuration-response-class.js +15 -0
  34. package/dist/models/index.d.ts +15 -0
  35. package/dist/models/index.js +15 -0
  36. package/dist/models/json-sub-field-dto.d.ts +36 -0
  37. package/dist/models/json-sub-field-dto.js +15 -0
  38. package/dist/models/list-changelog-configurations-response-class.d.ts +43 -0
  39. package/dist/models/list-changelog-configurations-response-class.js +15 -0
  40. package/dist/models/list-formatted-changelog-events-response-class.d.ts +43 -0
  41. package/dist/models/list-formatted-changelog-events-response-class.js +15 -0
  42. package/dist/models/update-changelog-configuration-dto.d.ts +25 -0
  43. package/dist/models/update-changelog-configuration-dto.js +15 -0
  44. package/models/changelog-config-field-class.ts +81 -0
  45. package/models/changelog-config-field-dto.ts +83 -0
  46. package/models/changelog-config-section-class.ts +49 -0
  47. package/models/changelog-config-section-dto.ts +49 -0
  48. package/models/changelog-configuration-class.ts +73 -0
  49. package/models/composite-source-dto.ts +36 -0
  50. package/models/create-changelog-configuration-dto.ts +43 -0
  51. package/models/formatted-changelog-event.ts +73 -0
  52. package/models/formatted-field-entry.ts +54 -0
  53. package/models/formatted-section.ts +49 -0
  54. package/models/get-changelog-configuration-response-class.ts +31 -0
  55. package/models/index.ts +15 -0
  56. package/models/json-sub-field-dto.ts +42 -0
  57. package/models/list-changelog-configurations-response-class.ts +49 -0
  58. package/models/list-formatted-changelog-events-response-class.ts +49 -0
  59. package/models/update-changelog-configuration-dto.ts +31 -0
  60. package/package.json +1 -1
@@ -24,6 +24,8 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
24
24
  import { GetChangelogEventResponseClass } from '../models';
25
25
  // @ts-ignore
26
26
  import { ListChangelogEventsResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { ListFormattedChangelogEventsResponseClass } from '../models';
27
29
  /**
28
30
  * ChangelogEventsApi - axios parameter creator
29
31
  * @export
@@ -82,7 +84,7 @@ export const ChangelogEventsApiAxiosParamCreator = function (configuration?: Con
82
84
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
83
85
  * @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.
84
86
  * @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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
85
- * @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, entityCode, actorName, sourceService</i>
87
+ * @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, actorName</i>
86
88
  * @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, occurredAt, createdAt, entityType, action</i>
87
89
  * @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/>
88
90
  * @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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
@@ -142,6 +144,86 @@ export const ChangelogEventsApiAxiosParamCreator = function (configuration?: Con
142
144
 
143
145
 
144
146
 
147
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
148
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
149
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
150
+
151
+ return {
152
+ url: toPathString(localVarUrlObj),
153
+ options: localVarRequestOptions,
154
+ };
155
+ },
156
+ /**
157
+ * 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
158
+ * @summary List formatted changelog events
159
+ * @param {string} configSlug Slug of the changelog configuration to apply
160
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
161
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
162
+ * @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.
163
+ * @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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
164
+ * @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, actorName</i>
165
+ * @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, occurredAt, createdAt, entityType, action</i>
166
+ * @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/>
167
+ * @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, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
168
+ * @param {*} [options] Override http request option.
169
+ * @throws {RequiredError}
170
+ */
171
+ listFormattedChangelogEvents: async (configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
172
+ // verify required parameter 'configSlug' is not null or undefined
173
+ assertParamExists('listFormattedChangelogEvents', 'configSlug', configSlug)
174
+ const localVarPath = `/changelogservice/v1/changelog-events/formatted/{configSlug}`
175
+ .replace(`{${"configSlug"}}`, encodeURIComponent(String(configSlug)));
176
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
177
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
178
+ let baseOptions;
179
+ let baseAccessToken;
180
+ if (configuration) {
181
+ baseOptions = configuration.baseOptions;
182
+ baseAccessToken = configuration.accessToken;
183
+ }
184
+
185
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
186
+ const localVarHeaderParameter = {} as any;
187
+ const localVarQueryParameter = {} as any;
188
+
189
+ // authentication bearer required
190
+ // http bearer authentication required
191
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
192
+
193
+ if (pageSize !== undefined) {
194
+ localVarQueryParameter['pageSize'] = pageSize;
195
+ }
196
+
197
+ if (pageToken !== undefined) {
198
+ localVarQueryParameter['pageToken'] = pageToken;
199
+ }
200
+
201
+ if (filter !== undefined) {
202
+ localVarQueryParameter['filter'] = filter;
203
+ }
204
+
205
+ if (search !== undefined) {
206
+ localVarQueryParameter['search'] = search;
207
+ }
208
+
209
+ if (order !== undefined) {
210
+ localVarQueryParameter['order'] = order;
211
+ }
212
+
213
+ if (expand !== undefined) {
214
+ localVarQueryParameter['expand'] = expand;
215
+ }
216
+
217
+ if (filters !== undefined) {
218
+ localVarQueryParameter['filters'] = filters;
219
+ }
220
+
221
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
222
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
223
+ }
224
+
225
+
226
+
145
227
  setSearchParams(localVarUrlObj, localVarQueryParameter);
146
228
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
147
229
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -180,7 +262,7 @@ export const ChangelogEventsApiFp = function(configuration?: Configuration) {
180
262
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
181
263
  * @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.
182
264
  * @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;
183
- * @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;
265
+ * @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, actorName&lt;/i&gt;
184
266
  * @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;
185
267
  * @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;
186
268
  * @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;
@@ -191,6 +273,25 @@ export const ChangelogEventsApiFp = function(configuration?: Configuration) {
191
273
  const localVarAxiosArgs = await localVarAxiosParamCreator.listChangelogEvents(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
192
274
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
193
275
  },
276
+ /**
277
+ * 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
278
+ * @summary List formatted changelog events
279
+ * @param {string} configSlug Slug of the changelog configuration to apply
280
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
281
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
282
+ * @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.
283
+ * @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;
284
+ * @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, actorName&lt;/i&gt;
285
+ * @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;
286
+ * @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;
287
+ * @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;
288
+ * @param {*} [options] Override http request option.
289
+ * @throws {RequiredError}
290
+ */
291
+ async 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>> {
292
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listFormattedChangelogEvents(configSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
293
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
294
+ },
194
295
  }
195
296
  };
196
297
 
@@ -219,7 +320,7 @@ export const ChangelogEventsApiFactory = function (configuration?: Configuration
219
320
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
220
321
  * @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.
221
322
  * @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;
222
- * @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;
323
+ * @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, actorName&lt;/i&gt;
223
324
  * @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;
224
325
  * @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;
225
326
  * @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;
@@ -229,6 +330,24 @@ export const ChangelogEventsApiFactory = function (configuration?: Configuration
229
330
  listChangelogEvents(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogEventsResponseClass> {
230
331
  return localVarFp.listChangelogEvents(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
231
332
  },
333
+ /**
334
+ * 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
335
+ * @summary List formatted changelog events
336
+ * @param {string} configSlug Slug of the changelog configuration to apply
337
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
338
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
339
+ * @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.
340
+ * @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;
341
+ * @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, actorName&lt;/i&gt;
342
+ * @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;
343
+ * @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;
344
+ * @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;
345
+ * @param {*} [options] Override http request option.
346
+ * @throws {RequiredError}
347
+ */
348
+ listFormattedChangelogEvents(configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFormattedChangelogEventsResponseClass> {
349
+ return localVarFp.listFormattedChangelogEvents(configSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
350
+ },
232
351
  };
233
352
  };
234
353
 
@@ -288,7 +407,7 @@ export interface ChangelogEventsApiListChangelogEventsRequest {
288
407
  readonly filter?: string
289
408
 
290
409
  /**
291
- * 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;
410
+ * 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, actorName&lt;/i&gt;
292
411
  * @type {string}
293
412
  * @memberof ChangelogEventsApiListChangelogEvents
294
413
  */
@@ -316,6 +435,76 @@ export interface ChangelogEventsApiListChangelogEventsRequest {
316
435
  readonly filters?: string
317
436
  }
318
437
 
438
+ /**
439
+ * Request parameters for listFormattedChangelogEvents operation in ChangelogEventsApi.
440
+ * @export
441
+ * @interface ChangelogEventsApiListFormattedChangelogEventsRequest
442
+ */
443
+ export interface ChangelogEventsApiListFormattedChangelogEventsRequest {
444
+ /**
445
+ * Slug of the changelog configuration to apply
446
+ * @type {string}
447
+ * @memberof ChangelogEventsApiListFormattedChangelogEvents
448
+ */
449
+ readonly configSlug: string
450
+
451
+ /**
452
+ * Bearer Token: provided by the login endpoint under the name accessToken.
453
+ * @type {string}
454
+ * @memberof ChangelogEventsApiListFormattedChangelogEvents
455
+ */
456
+ readonly authorization?: string
457
+
458
+ /**
459
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
460
+ * @type {number}
461
+ * @memberof ChangelogEventsApiListFormattedChangelogEvents
462
+ */
463
+ readonly pageSize?: number
464
+
465
+ /**
466
+ * 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.
467
+ * @type {string}
468
+ * @memberof ChangelogEventsApiListFormattedChangelogEvents
469
+ */
470
+ readonly pageToken?: string
471
+
472
+ /**
473
+ * 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;
474
+ * @type {string}
475
+ * @memberof ChangelogEventsApiListFormattedChangelogEvents
476
+ */
477
+ readonly filter?: string
478
+
479
+ /**
480
+ * 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, actorName&lt;/i&gt;
481
+ * @type {string}
482
+ * @memberof ChangelogEventsApiListFormattedChangelogEvents
483
+ */
484
+ readonly search?: string
485
+
486
+ /**
487
+ * 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;
488
+ * @type {string}
489
+ * @memberof ChangelogEventsApiListFormattedChangelogEvents
490
+ */
491
+ readonly order?: string
492
+
493
+ /**
494
+ * 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;
495
+ * @type {string}
496
+ * @memberof ChangelogEventsApiListFormattedChangelogEvents
497
+ */
498
+ readonly expand?: string
499
+
500
+ /**
501
+ * 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;
502
+ * @type {string}
503
+ * @memberof ChangelogEventsApiListFormattedChangelogEvents
504
+ */
505
+ readonly filters?: string
506
+ }
507
+
319
508
  /**
320
509
  * ChangelogEventsApi - object-oriented interface
321
510
  * @export
@@ -346,4 +535,16 @@ export class ChangelogEventsApi extends BaseAPI {
346
535
  public listChangelogEvents(requestParameters: ChangelogEventsApiListChangelogEventsRequest = {}, options?: AxiosRequestConfig) {
347
536
  return ChangelogEventsApiFp(this.configuration).listChangelogEvents(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
348
537
  }
538
+
539
+ /**
540
+ * 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
541
+ * @summary List formatted changelog events
542
+ * @param {ChangelogEventsApiListFormattedChangelogEventsRequest} requestParameters Request parameters.
543
+ * @param {*} [options] Override http request option.
544
+ * @throws {RequiredError}
545
+ * @memberof ChangelogEventsApi
546
+ */
547
+ public listFormattedChangelogEvents(requestParameters: ChangelogEventsApiListFormattedChangelogEventsRequest, options?: AxiosRequestConfig) {
548
+ return ChangelogEventsApiFp(this.configuration).listFormattedChangelogEvents(requestParameters.configSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
549
+ }
349
550
  }
package/api.ts CHANGED
@@ -20,10 +20,12 @@ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResp
20
20
  import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
21
21
  // @ts-ignore
22
22
  import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
23
+ import { ChangelogConfigurationsApi } from './api';
23
24
  import { ChangelogEventsApi } from './api';
24
25
  import { HealthChecksApi } from './api';
25
26
 
26
27
 
28
+ export * from './api/changelog-configurations-api';
27
29
  export * from './api/changelog-events-api';
28
30
  export * from './api/health-checks-api';
29
31
 
@@ -0,0 +1,327 @@
1
+ /**
2
+ * EMIL Changelogservice
3
+ * The EMIL Changelog Service API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CreateChangelogConfigurationDto } from '../models';
16
+ import { GetChangelogConfigurationResponseClass } from '../models';
17
+ import { ListChangelogConfigurationsResponseClass } from '../models';
18
+ import { UpdateChangelogConfigurationDto } from '../models';
19
+ /**
20
+ * ChangelogConfigurationsApi - axios parameter creator
21
+ * @export
22
+ */
23
+ export declare const ChangelogConfigurationsApiAxiosParamCreator: (configuration?: Configuration) => {
24
+ /**
25
+ * Creates a new changelog configuration for an entity type **Required Permissions** none
26
+ * @summary Create the changelog configuration
27
+ * @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
28
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
29
+ * @param {*} [options] Override http request option.
30
+ * @throws {RequiredError}
31
+ */
32
+ createChangelogConfiguration: (createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
+ /**
34
+ * Retrieves a changelog configuration by its code **Required Permissions** none
35
+ * @summary Retrieve the changelog configuration
36
+ * @param {string} code Unique identifier code for the changelog configuration
37
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ getChangelogConfiguration: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42
+ /**
43
+ * 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
44
+ * @summary List changelog configurations
45
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
46
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
47
+ * @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.
48
+ * @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;
49
+ * @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;
50
+ * @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;
51
+ * @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;
52
+ * @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;
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ listChangelogConfigurations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
57
+ /**
58
+ * Updates an existing changelog configuration **Required Permissions** none
59
+ * @summary Update the changelog configuration
60
+ * @param {string} code Unique identifier code for the changelog configuration
61
+ * @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
62
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ */
66
+ updateChangelogConfiguration: (code: string, updateChangelogConfigurationDto: UpdateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
67
+ };
68
+ /**
69
+ * ChangelogConfigurationsApi - functional programming interface
70
+ * @export
71
+ */
72
+ export declare const ChangelogConfigurationsApiFp: (configuration?: Configuration) => {
73
+ /**
74
+ * Creates a new changelog configuration for an entity type **Required Permissions** none
75
+ * @summary Create the changelog configuration
76
+ * @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
77
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ createChangelogConfiguration(createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>>;
82
+ /**
83
+ * Retrieves a changelog configuration by its code **Required Permissions** none
84
+ * @summary Retrieve the changelog configuration
85
+ * @param {string} code Unique identifier code for the changelog configuration
86
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
87
+ * @param {*} [options] Override http request option.
88
+ * @throws {RequiredError}
89
+ */
90
+ getChangelogConfiguration(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>>;
91
+ /**
92
+ * 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
93
+ * @summary List changelog configurations
94
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
95
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
96
+ * @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.
97
+ * @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;
98
+ * @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;
99
+ * @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;
100
+ * @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;
101
+ * @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;
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ 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>>;
106
+ /**
107
+ * Updates an existing changelog configuration **Required Permissions** none
108
+ * @summary Update the changelog configuration
109
+ * @param {string} code Unique identifier code for the changelog configuration
110
+ * @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
111
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
112
+ * @param {*} [options] Override http request option.
113
+ * @throws {RequiredError}
114
+ */
115
+ updateChangelogConfiguration(code: string, updateChangelogConfigurationDto: UpdateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>>;
116
+ };
117
+ /**
118
+ * ChangelogConfigurationsApi - factory interface
119
+ * @export
120
+ */
121
+ export declare const ChangelogConfigurationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
122
+ /**
123
+ * Creates a new changelog configuration for an entity type **Required Permissions** none
124
+ * @summary Create the changelog configuration
125
+ * @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
126
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
127
+ * @param {*} [options] Override http request option.
128
+ * @throws {RequiredError}
129
+ */
130
+ createChangelogConfiguration(createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass>;
131
+ /**
132
+ * Retrieves a changelog configuration by its code **Required Permissions** none
133
+ * @summary Retrieve the changelog configuration
134
+ * @param {string} code Unique identifier code for the changelog configuration
135
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
136
+ * @param {*} [options] Override http request option.
137
+ * @throws {RequiredError}
138
+ */
139
+ getChangelogConfiguration(code: string, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass>;
140
+ /**
141
+ * 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
142
+ * @summary List changelog configurations
143
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
144
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
145
+ * @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.
146
+ * @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;
147
+ * @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;
148
+ * @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;
149
+ * @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;
150
+ * @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;
151
+ * @param {*} [options] Override http request option.
152
+ * @throws {RequiredError}
153
+ */
154
+ listChangelogConfigurations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogConfigurationsResponseClass>;
155
+ /**
156
+ * Updates an existing changelog configuration **Required Permissions** none
157
+ * @summary Update the changelog configuration
158
+ * @param {string} code Unique identifier code for the changelog configuration
159
+ * @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
160
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ */
164
+ updateChangelogConfiguration(code: string, updateChangelogConfigurationDto: UpdateChangelogConfigurationDto, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass>;
165
+ };
166
+ /**
167
+ * Request parameters for createChangelogConfiguration operation in ChangelogConfigurationsApi.
168
+ * @export
169
+ * @interface ChangelogConfigurationsApiCreateChangelogConfigurationRequest
170
+ */
171
+ export interface ChangelogConfigurationsApiCreateChangelogConfigurationRequest {
172
+ /**
173
+ *
174
+ * @type {CreateChangelogConfigurationDto}
175
+ * @memberof ChangelogConfigurationsApiCreateChangelogConfiguration
176
+ */
177
+ readonly createChangelogConfigurationDto: CreateChangelogConfigurationDto;
178
+ /**
179
+ * Bearer Token: provided by the login endpoint under the name accessToken.
180
+ * @type {string}
181
+ * @memberof ChangelogConfigurationsApiCreateChangelogConfiguration
182
+ */
183
+ readonly authorization?: string;
184
+ }
185
+ /**
186
+ * Request parameters for getChangelogConfiguration operation in ChangelogConfigurationsApi.
187
+ * @export
188
+ * @interface ChangelogConfigurationsApiGetChangelogConfigurationRequest
189
+ */
190
+ export interface ChangelogConfigurationsApiGetChangelogConfigurationRequest {
191
+ /**
192
+ * Unique identifier code for the changelog configuration
193
+ * @type {string}
194
+ * @memberof ChangelogConfigurationsApiGetChangelogConfiguration
195
+ */
196
+ readonly code: string;
197
+ /**
198
+ * Bearer Token: provided by the login endpoint under the name accessToken.
199
+ * @type {string}
200
+ * @memberof ChangelogConfigurationsApiGetChangelogConfiguration
201
+ */
202
+ readonly authorization?: string;
203
+ }
204
+ /**
205
+ * Request parameters for listChangelogConfigurations operation in ChangelogConfigurationsApi.
206
+ * @export
207
+ * @interface ChangelogConfigurationsApiListChangelogConfigurationsRequest
208
+ */
209
+ export interface ChangelogConfigurationsApiListChangelogConfigurationsRequest {
210
+ /**
211
+ * Bearer Token: provided by the login endpoint under the name accessToken.
212
+ * @type {string}
213
+ * @memberof ChangelogConfigurationsApiListChangelogConfigurations
214
+ */
215
+ readonly authorization?: string;
216
+ /**
217
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
218
+ * @type {number}
219
+ * @memberof ChangelogConfigurationsApiListChangelogConfigurations
220
+ */
221
+ readonly pageSize?: number;
222
+ /**
223
+ * 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.
224
+ * @type {string}
225
+ * @memberof ChangelogConfigurationsApiListChangelogConfigurations
226
+ */
227
+ readonly pageToken?: string;
228
+ /**
229
+ * 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;
230
+ * @type {string}
231
+ * @memberof ChangelogConfigurationsApiListChangelogConfigurations
232
+ */
233
+ readonly filter?: string;
234
+ /**
235
+ * 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;
236
+ * @type {string}
237
+ * @memberof ChangelogConfigurationsApiListChangelogConfigurations
238
+ */
239
+ readonly search?: string;
240
+ /**
241
+ * 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;
242
+ * @type {string}
243
+ * @memberof ChangelogConfigurationsApiListChangelogConfigurations
244
+ */
245
+ readonly order?: string;
246
+ /**
247
+ * 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;
248
+ * @type {string}
249
+ * @memberof ChangelogConfigurationsApiListChangelogConfigurations
250
+ */
251
+ readonly expand?: string;
252
+ /**
253
+ * 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;
254
+ * @type {string}
255
+ * @memberof ChangelogConfigurationsApiListChangelogConfigurations
256
+ */
257
+ readonly filters?: string;
258
+ }
259
+ /**
260
+ * Request parameters for updateChangelogConfiguration operation in ChangelogConfigurationsApi.
261
+ * @export
262
+ * @interface ChangelogConfigurationsApiUpdateChangelogConfigurationRequest
263
+ */
264
+ export interface ChangelogConfigurationsApiUpdateChangelogConfigurationRequest {
265
+ /**
266
+ * Unique identifier code for the changelog configuration
267
+ * @type {string}
268
+ * @memberof ChangelogConfigurationsApiUpdateChangelogConfiguration
269
+ */
270
+ readonly code: string;
271
+ /**
272
+ *
273
+ * @type {UpdateChangelogConfigurationDto}
274
+ * @memberof ChangelogConfigurationsApiUpdateChangelogConfiguration
275
+ */
276
+ readonly updateChangelogConfigurationDto: UpdateChangelogConfigurationDto;
277
+ /**
278
+ * Bearer Token: provided by the login endpoint under the name accessToken.
279
+ * @type {string}
280
+ * @memberof ChangelogConfigurationsApiUpdateChangelogConfiguration
281
+ */
282
+ readonly authorization?: string;
283
+ }
284
+ /**
285
+ * ChangelogConfigurationsApi - object-oriented interface
286
+ * @export
287
+ * @class ChangelogConfigurationsApi
288
+ * @extends {BaseAPI}
289
+ */
290
+ export declare class ChangelogConfigurationsApi extends BaseAPI {
291
+ /**
292
+ * Creates a new changelog configuration for an entity type **Required Permissions** none
293
+ * @summary Create the changelog configuration
294
+ * @param {ChangelogConfigurationsApiCreateChangelogConfigurationRequest} requestParameters Request parameters.
295
+ * @param {*} [options] Override http request option.
296
+ * @throws {RequiredError}
297
+ * @memberof ChangelogConfigurationsApi
298
+ */
299
+ createChangelogConfiguration(requestParameters: ChangelogConfigurationsApiCreateChangelogConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangelogConfigurationResponseClass, any, {}>>;
300
+ /**
301
+ * Retrieves a changelog configuration by its code **Required Permissions** none
302
+ * @summary Retrieve the changelog configuration
303
+ * @param {ChangelogConfigurationsApiGetChangelogConfigurationRequest} requestParameters Request parameters.
304
+ * @param {*} [options] Override http request option.
305
+ * @throws {RequiredError}
306
+ * @memberof ChangelogConfigurationsApi
307
+ */
308
+ getChangelogConfiguration(requestParameters: ChangelogConfigurationsApiGetChangelogConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangelogConfigurationResponseClass, any, {}>>;
309
+ /**
310
+ * 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
311
+ * @summary List changelog configurations
312
+ * @param {ChangelogConfigurationsApiListChangelogConfigurationsRequest} requestParameters Request parameters.
313
+ * @param {*} [options] Override http request option.
314
+ * @throws {RequiredError}
315
+ * @memberof ChangelogConfigurationsApi
316
+ */
317
+ listChangelogConfigurations(requestParameters?: ChangelogConfigurationsApiListChangelogConfigurationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListChangelogConfigurationsResponseClass, any, {}>>;
318
+ /**
319
+ * Updates an existing changelog configuration **Required Permissions** none
320
+ * @summary Update the changelog configuration
321
+ * @param {ChangelogConfigurationsApiUpdateChangelogConfigurationRequest} requestParameters Request parameters.
322
+ * @param {*} [options] Override http request option.
323
+ * @throws {RequiredError}
324
+ * @memberof ChangelogConfigurationsApi
325
+ */
326
+ updateChangelogConfiguration(requestParameters: ChangelogConfigurationsApiUpdateChangelogConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangelogConfigurationResponseClass, any, {}>>;
327
+ }