@emilgroup/changelog-sdk 1.0.1-beta.12 → 1.0.1-beta.14
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.
- package/README.md +2 -2
- package/api/changelog-configurations-api.ts +24 -24
- package/api/changelog-events-api.ts +28 -28
- package/dist/api/changelog-configurations-api.d.ts +24 -24
- package/dist/api/changelog-configurations-api.js +22 -22
- package/dist/api/changelog-events-api.d.ts +28 -28
- package/dist/api/changelog-events-api.js +24 -24
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/changelog-sdk@1.0.1-beta.
|
|
20
|
+
npm install @emilgroup/changelog-sdk@1.0.1-beta.14 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/changelog-sdk@1.0.1-beta.
|
|
24
|
+
yarn add @emilgroup/changelog-sdk@1.0.1-beta.14
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -35,7 +35,7 @@ import { UpdateChangelogConfigurationDto } from '../models';
|
|
|
35
35
|
export const ChangelogConfigurationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
36
|
return {
|
|
37
37
|
/**
|
|
38
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
38
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** \"changelog-management.changelog-configurations.create\"
|
|
39
39
|
* @summary Create the changelog configuration
|
|
40
40
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
41
41
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -82,7 +82,7 @@ export const ChangelogConfigurationsApiAxiosParamCreator = function (configurati
|
|
|
82
82
|
};
|
|
83
83
|
},
|
|
84
84
|
/**
|
|
85
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
85
|
+
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
86
86
|
* @summary Retrieve the changelog configuration
|
|
87
87
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
88
88
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -127,16 +127,16 @@ export const ChangelogConfigurationsApiAxiosParamCreator = function (configurati
|
|
|
127
127
|
};
|
|
128
128
|
},
|
|
129
129
|
/**
|
|
130
|
-
* Returns a list of changelog configurations you have previously created.
|
|
130
|
+
* 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** \"changelog-management.changelog-configurations.view\"
|
|
131
131
|
* @summary List changelog configurations
|
|
132
132
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
133
133
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
134
134
|
* @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.
|
|
135
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
135
|
+
* @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>
|
|
136
136
|
* @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>
|
|
137
137
|
* @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>
|
|
138
138
|
* @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/>
|
|
139
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
139
|
+
* @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>
|
|
140
140
|
* @param {*} [options] Override http request option.
|
|
141
141
|
* @throws {RequiredError}
|
|
142
142
|
*/
|
|
@@ -203,7 +203,7 @@ export const ChangelogConfigurationsApiAxiosParamCreator = function (configurati
|
|
|
203
203
|
};
|
|
204
204
|
},
|
|
205
205
|
/**
|
|
206
|
-
* Updates an existing changelog configuration **Required Permissions**
|
|
206
|
+
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
207
207
|
* @summary Update the changelog configuration
|
|
208
208
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
209
209
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -264,7 +264,7 @@ export const ChangelogConfigurationsApiFp = function(configuration?: Configurati
|
|
|
264
264
|
const localVarAxiosParamCreator = ChangelogConfigurationsApiAxiosParamCreator(configuration)
|
|
265
265
|
return {
|
|
266
266
|
/**
|
|
267
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
267
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** \"changelog-management.changelog-configurations.create\"
|
|
268
268
|
* @summary Create the changelog configuration
|
|
269
269
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
270
270
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -276,7 +276,7 @@ export const ChangelogConfigurationsApiFp = function(configuration?: Configurati
|
|
|
276
276
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
277
277
|
},
|
|
278
278
|
/**
|
|
279
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
279
|
+
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
280
280
|
* @summary Retrieve the changelog configuration
|
|
281
281
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
282
282
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -288,16 +288,16 @@ export const ChangelogConfigurationsApiFp = function(configuration?: Configurati
|
|
|
288
288
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
289
289
|
},
|
|
290
290
|
/**
|
|
291
|
-
* Returns a list of changelog configurations you have previously created.
|
|
291
|
+
* 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** \"changelog-management.changelog-configurations.view\"
|
|
292
292
|
* @summary List changelog configurations
|
|
293
293
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
294
294
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
295
295
|
* @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.
|
|
296
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
296
|
+
* @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>
|
|
297
297
|
* @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>
|
|
298
298
|
* @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>
|
|
299
299
|
* @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/>
|
|
300
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
300
|
+
* @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>
|
|
301
301
|
* @param {*} [options] Override http request option.
|
|
302
302
|
* @throws {RequiredError}
|
|
303
303
|
*/
|
|
@@ -306,7 +306,7 @@ export const ChangelogConfigurationsApiFp = function(configuration?: Configurati
|
|
|
306
306
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
307
307
|
},
|
|
308
308
|
/**
|
|
309
|
-
* Updates an existing changelog configuration **Required Permissions**
|
|
309
|
+
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
310
310
|
* @summary Update the changelog configuration
|
|
311
311
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
312
312
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -329,7 +329,7 @@ export const ChangelogConfigurationsApiFactory = function (configuration?: Confi
|
|
|
329
329
|
const localVarFp = ChangelogConfigurationsApiFp(configuration)
|
|
330
330
|
return {
|
|
331
331
|
/**
|
|
332
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
332
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** \"changelog-management.changelog-configurations.create\"
|
|
333
333
|
* @summary Create the changelog configuration
|
|
334
334
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
335
335
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -340,7 +340,7 @@ export const ChangelogConfigurationsApiFactory = function (configuration?: Confi
|
|
|
340
340
|
return localVarFp.createChangelogConfiguration(createChangelogConfigurationDto, authorization, options).then((request) => request(axios, basePath));
|
|
341
341
|
},
|
|
342
342
|
/**
|
|
343
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
343
|
+
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
344
344
|
* @summary Retrieve the changelog configuration
|
|
345
345
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
346
346
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -351,16 +351,16 @@ export const ChangelogConfigurationsApiFactory = function (configuration?: Confi
|
|
|
351
351
|
return localVarFp.getChangelogConfiguration(code, authorization, options).then((request) => request(axios, basePath));
|
|
352
352
|
},
|
|
353
353
|
/**
|
|
354
|
-
* Returns a list of changelog configurations you have previously created.
|
|
354
|
+
* 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** \"changelog-management.changelog-configurations.view\"
|
|
355
355
|
* @summary List changelog configurations
|
|
356
356
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
357
357
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
358
358
|
* @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.
|
|
359
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
359
|
+
* @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>
|
|
360
360
|
* @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>
|
|
361
361
|
* @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>
|
|
362
362
|
* @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/>
|
|
363
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
363
|
+
* @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>
|
|
364
364
|
* @param {*} [options] Override http request option.
|
|
365
365
|
* @throws {RequiredError}
|
|
366
366
|
*/
|
|
@@ -368,7 +368,7 @@ export const ChangelogConfigurationsApiFactory = function (configuration?: Confi
|
|
|
368
368
|
return localVarFp.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
369
369
|
},
|
|
370
370
|
/**
|
|
371
|
-
* Updates an existing changelog configuration **Required Permissions**
|
|
371
|
+
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
372
372
|
* @summary Update the changelog configuration
|
|
373
373
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
374
374
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -452,7 +452,7 @@ export interface ChangelogConfigurationsApiListChangelogConfigurationsRequest {
|
|
|
452
452
|
readonly pageToken?: string
|
|
453
453
|
|
|
454
454
|
/**
|
|
455
|
-
* Filter the response by one or multiple fields.
|
|
455
|
+
* 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>
|
|
456
456
|
* @type {string}
|
|
457
457
|
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
458
458
|
*/
|
|
@@ -480,7 +480,7 @@ export interface ChangelogConfigurationsApiListChangelogConfigurationsRequest {
|
|
|
480
480
|
readonly expand?: string
|
|
481
481
|
|
|
482
482
|
/**
|
|
483
|
-
* Filters the response by one or multiple fields.
|
|
483
|
+
* 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>
|
|
484
484
|
* @type {string}
|
|
485
485
|
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
486
486
|
*/
|
|
@@ -523,7 +523,7 @@ export interface ChangelogConfigurationsApiUpdateChangelogConfigurationRequest {
|
|
|
523
523
|
*/
|
|
524
524
|
export class ChangelogConfigurationsApi extends BaseAPI {
|
|
525
525
|
/**
|
|
526
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
526
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** \"changelog-management.changelog-configurations.create\"
|
|
527
527
|
* @summary Create the changelog configuration
|
|
528
528
|
* @param {ChangelogConfigurationsApiCreateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
529
529
|
* @param {*} [options] Override http request option.
|
|
@@ -535,7 +535,7 @@ export class ChangelogConfigurationsApi extends BaseAPI {
|
|
|
535
535
|
}
|
|
536
536
|
|
|
537
537
|
/**
|
|
538
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
538
|
+
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
539
539
|
* @summary Retrieve the changelog configuration
|
|
540
540
|
* @param {ChangelogConfigurationsApiGetChangelogConfigurationRequest} requestParameters Request parameters.
|
|
541
541
|
* @param {*} [options] Override http request option.
|
|
@@ -547,7 +547,7 @@ export class ChangelogConfigurationsApi extends BaseAPI {
|
|
|
547
547
|
}
|
|
548
548
|
|
|
549
549
|
/**
|
|
550
|
-
* Returns a list of changelog configurations you have previously created.
|
|
550
|
+
* 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** \"changelog-management.changelog-configurations.view\"
|
|
551
551
|
* @summary List changelog configurations
|
|
552
552
|
* @param {ChangelogConfigurationsApiListChangelogConfigurationsRequest} requestParameters Request parameters.
|
|
553
553
|
* @param {*} [options] Override http request option.
|
|
@@ -559,7 +559,7 @@ export class ChangelogConfigurationsApi extends BaseAPI {
|
|
|
559
559
|
}
|
|
560
560
|
|
|
561
561
|
/**
|
|
562
|
-
* Updates an existing changelog configuration **Required Permissions**
|
|
562
|
+
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
563
563
|
* @summary Update the changelog configuration
|
|
564
564
|
* @param {ChangelogConfigurationsApiUpdateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
565
565
|
* @param {*} [options] Override http request option.
|
|
@@ -33,7 +33,7 @@ import { ListFormattedChangelogEventsResponseClass } from '../models';
|
|
|
33
33
|
export const ChangelogEventsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
34
|
return {
|
|
35
35
|
/**
|
|
36
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
36
|
+
* Retrieves a changelog event by its code **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
37
37
|
* @summary Retrieve the changelog event
|
|
38
38
|
* @param {string} code Unique identifier code for the changelog event
|
|
39
39
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -78,16 +78,16 @@ export const ChangelogEventsApiAxiosParamCreator = function (configuration?: Con
|
|
|
78
78
|
};
|
|
79
79
|
},
|
|
80
80
|
/**
|
|
81
|
-
* Returns a list of changelog events you have previously created.
|
|
81
|
+
* Returns a list of changelog events you have previously created. The changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
82
82
|
* @summary List changelog events
|
|
83
83
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
84
84
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
85
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.
|
|
86
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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>
|
|
87
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>
|
|
88
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>
|
|
89
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/>
|
|
90
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
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>
|
|
91
91
|
* @param {*} [options] Override http request option.
|
|
92
92
|
* @throws {RequiredError}
|
|
93
93
|
*/
|
|
@@ -154,17 +154,17 @@ export const ChangelogEventsApiAxiosParamCreator = function (configuration?: Con
|
|
|
154
154
|
};
|
|
155
155
|
},
|
|
156
156
|
/**
|
|
157
|
-
* Returns a list of formatted changelog events you have previously created.
|
|
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** \"changelog-management.changelog-events.view\"
|
|
158
158
|
* @summary List formatted changelog events
|
|
159
159
|
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
160
160
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
161
161
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
162
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.
|
|
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
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
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
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.
|
|
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
168
|
* @param {*} [options] Override http request option.
|
|
169
169
|
* @throws {RequiredError}
|
|
170
170
|
*/
|
|
@@ -244,7 +244,7 @@ export const ChangelogEventsApiFp = function(configuration?: Configuration) {
|
|
|
244
244
|
const localVarAxiosParamCreator = ChangelogEventsApiAxiosParamCreator(configuration)
|
|
245
245
|
return {
|
|
246
246
|
/**
|
|
247
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
247
|
+
* Retrieves a changelog event by its code **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
248
248
|
* @summary Retrieve the changelog event
|
|
249
249
|
* @param {string} code Unique identifier code for the changelog event
|
|
250
250
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -256,16 +256,16 @@ export const ChangelogEventsApiFp = function(configuration?: Configuration) {
|
|
|
256
256
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
257
257
|
},
|
|
258
258
|
/**
|
|
259
|
-
* Returns a list of changelog events you have previously created.
|
|
259
|
+
* Returns a list of changelog events you have previously created. The changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
260
260
|
* @summary List changelog events
|
|
261
261
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
262
262
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
263
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
264
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
264
|
+
* @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>
|
|
265
265
|
* @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>
|
|
266
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.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
267
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.<br/> <br/>
|
|
268
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
268
|
+
* @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>
|
|
269
269
|
* @param {*} [options] Override http request option.
|
|
270
270
|
* @throws {RequiredError}
|
|
271
271
|
*/
|
|
@@ -274,17 +274,17 @@ export const ChangelogEventsApiFp = function(configuration?: Configuration) {
|
|
|
274
274
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
275
275
|
},
|
|
276
276
|
/**
|
|
277
|
-
* Returns a list of formatted changelog events you have previously created.
|
|
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** \"changelog-management.changelog-events.view\"
|
|
278
278
|
* @summary List formatted changelog events
|
|
279
279
|
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
280
280
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
281
281
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
282
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
283
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
283
|
+
* @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>
|
|
284
284
|
* @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>
|
|
285
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.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
286
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.<br/> <br/>
|
|
287
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
287
|
+
* @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>
|
|
288
288
|
* @param {*} [options] Override http request option.
|
|
289
289
|
* @throws {RequiredError}
|
|
290
290
|
*/
|
|
@@ -303,7 +303,7 @@ export const ChangelogEventsApiFactory = function (configuration?: Configuration
|
|
|
303
303
|
const localVarFp = ChangelogEventsApiFp(configuration)
|
|
304
304
|
return {
|
|
305
305
|
/**
|
|
306
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
306
|
+
* Retrieves a changelog event by its code **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
307
307
|
* @summary Retrieve the changelog event
|
|
308
308
|
* @param {string} code Unique identifier code for the changelog event
|
|
309
309
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -314,16 +314,16 @@ export const ChangelogEventsApiFactory = function (configuration?: Configuration
|
|
|
314
314
|
return localVarFp.getChangelogEvent(code, authorization, options).then((request) => request(axios, basePath));
|
|
315
315
|
},
|
|
316
316
|
/**
|
|
317
|
-
* Returns a list of changelog events you have previously created.
|
|
317
|
+
* Returns a list of changelog events you have previously created. The changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
318
318
|
* @summary List changelog events
|
|
319
319
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
320
320
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
321
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
322
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
322
|
+
* @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>
|
|
323
323
|
* @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>
|
|
324
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.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
325
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.<br/> <br/>
|
|
326
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
326
|
+
* @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>
|
|
327
327
|
* @param {*} [options] Override http request option.
|
|
328
328
|
* @throws {RequiredError}
|
|
329
329
|
*/
|
|
@@ -331,17 +331,17 @@ export const ChangelogEventsApiFactory = function (configuration?: Configuration
|
|
|
331
331
|
return localVarFp.listChangelogEvents(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
332
332
|
},
|
|
333
333
|
/**
|
|
334
|
-
* Returns a list of formatted changelog events you have previously created.
|
|
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** \"changelog-management.changelog-events.view\"
|
|
335
335
|
* @summary List formatted changelog events
|
|
336
336
|
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
337
337
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
338
338
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
339
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
340
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
340
|
+
* @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>
|
|
341
341
|
* @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>
|
|
342
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.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
343
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.<br/> <br/>
|
|
344
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
344
|
+
* @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>
|
|
345
345
|
* @param {*} [options] Override http request option.
|
|
346
346
|
* @throws {RequiredError}
|
|
347
347
|
*/
|
|
@@ -400,7 +400,7 @@ export interface ChangelogEventsApiListChangelogEventsRequest {
|
|
|
400
400
|
readonly pageToken?: string
|
|
401
401
|
|
|
402
402
|
/**
|
|
403
|
-
* Filter the response by one or multiple fields.
|
|
403
|
+
* 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>
|
|
404
404
|
* @type {string}
|
|
405
405
|
* @memberof ChangelogEventsApiListChangelogEvents
|
|
406
406
|
*/
|
|
@@ -428,7 +428,7 @@ export interface ChangelogEventsApiListChangelogEventsRequest {
|
|
|
428
428
|
readonly expand?: string
|
|
429
429
|
|
|
430
430
|
/**
|
|
431
|
-
* Filters the response by one or multiple fields.
|
|
431
|
+
* 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>
|
|
432
432
|
* @type {string}
|
|
433
433
|
* @memberof ChangelogEventsApiListChangelogEvents
|
|
434
434
|
*/
|
|
@@ -470,7 +470,7 @@ export interface ChangelogEventsApiListFormattedChangelogEventsRequest {
|
|
|
470
470
|
readonly pageToken?: string
|
|
471
471
|
|
|
472
472
|
/**
|
|
473
|
-
* Filter the response by one or multiple fields.
|
|
473
|
+
* 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>
|
|
474
474
|
* @type {string}
|
|
475
475
|
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
476
476
|
*/
|
|
@@ -498,7 +498,7 @@ export interface ChangelogEventsApiListFormattedChangelogEventsRequest {
|
|
|
498
498
|
readonly expand?: string
|
|
499
499
|
|
|
500
500
|
/**
|
|
501
|
-
* Filters the response by one or multiple fields.
|
|
501
|
+
* 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>
|
|
502
502
|
* @type {string}
|
|
503
503
|
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
504
504
|
*/
|
|
@@ -513,7 +513,7 @@ export interface ChangelogEventsApiListFormattedChangelogEventsRequest {
|
|
|
513
513
|
*/
|
|
514
514
|
export class ChangelogEventsApi extends BaseAPI {
|
|
515
515
|
/**
|
|
516
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
516
|
+
* Retrieves a changelog event by its code **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
517
517
|
* @summary Retrieve the changelog event
|
|
518
518
|
* @param {ChangelogEventsApiGetChangelogEventRequest} requestParameters Request parameters.
|
|
519
519
|
* @param {*} [options] Override http request option.
|
|
@@ -525,7 +525,7 @@ export class ChangelogEventsApi extends BaseAPI {
|
|
|
525
525
|
}
|
|
526
526
|
|
|
527
527
|
/**
|
|
528
|
-
* Returns a list of changelog events you have previously created.
|
|
528
|
+
* Returns a list of changelog events you have previously created. The changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
529
529
|
* @summary List changelog events
|
|
530
530
|
* @param {ChangelogEventsApiListChangelogEventsRequest} requestParameters Request parameters.
|
|
531
531
|
* @param {*} [options] Override http request option.
|
|
@@ -537,7 +537,7 @@ export class ChangelogEventsApi extends BaseAPI {
|
|
|
537
537
|
}
|
|
538
538
|
|
|
539
539
|
/**
|
|
540
|
-
* Returns a list of formatted changelog events you have previously created.
|
|
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** \"changelog-management.changelog-events.view\"
|
|
541
541
|
* @summary List formatted changelog events
|
|
542
542
|
* @param {ChangelogEventsApiListFormattedChangelogEventsRequest} requestParameters Request parameters.
|
|
543
543
|
* @param {*} [options] Override http request option.
|