@emilgroup/changelog-sdk 1.0.1-beta.14 → 1.0.1-beta.2
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/.openapi-generator/FILES +0 -9
- package/README.md +2 -2
- package/api/changelog-configurations-api.ts +12 -200
- package/api/changelog-events-api.ts +20 -221
- package/dist/api/changelog-configurations-api.d.ts +12 -122
- package/dist/api/changelog-configurations-api.js +12 -141
- package/dist/api/changelog-events-api.d.ts +20 -139
- package/dist/api/changelog-events-api.js +17 -151
- package/dist/models/changelog-config-field-class.d.ts +0 -36
- package/dist/models/changelog-config-field-class.js +0 -6
- package/dist/models/changelog-configuration-class.d.ts +0 -12
- package/dist/models/create-changelog-configuration-dto.d.ts +3 -9
- package/dist/models/index.d.ts +0 -9
- package/dist/models/index.js +0 -9
- package/dist/models/update-changelog-configuration-dto.d.ts +3 -3
- package/models/changelog-config-field-class.ts +0 -39
- package/models/changelog-configuration-class.ts +0 -12
- package/models/create-changelog-configuration-dto.ts +3 -9
- package/models/index.ts +0 -9
- package/models/update-changelog-configuration-dto.ts +3 -3
- package/package.json +1 -1
- package/dist/models/changelog-config-field-dto.d.ts +0 -74
- package/dist/models/changelog-config-field-dto.js +0 -21
- package/dist/models/changelog-config-section-dto.d.ts +0 -43
- package/dist/models/changelog-config-section-dto.js +0 -15
- package/dist/models/composite-source-dto.d.ts +0 -30
- package/dist/models/composite-source-dto.js +0 -15
- package/dist/models/formatted-changelog-event.d.ts +0 -67
- package/dist/models/formatted-changelog-event.js +0 -15
- package/dist/models/formatted-field-entry.d.ts +0 -48
- package/dist/models/formatted-field-entry.js +0 -15
- package/dist/models/formatted-section.d.ts +0 -43
- package/dist/models/formatted-section.js +0 -15
- package/dist/models/json-sub-field-dto.d.ts +0 -36
- package/dist/models/json-sub-field-dto.js +0 -15
- package/dist/models/list-changelog-configurations-response-class.d.ts +0 -43
- package/dist/models/list-changelog-configurations-response-class.js +0 -15
- package/dist/models/list-formatted-changelog-events-response-class.d.ts +0 -43
- package/dist/models/list-formatted-changelog-events-response-class.js +0 -15
- package/models/changelog-config-field-dto.ts +0 -83
- package/models/changelog-config-section-dto.ts +0 -49
- package/models/composite-source-dto.ts +0 -36
- package/models/formatted-changelog-event.ts +0 -73
- package/models/formatted-field-entry.ts +0 -54
- package/models/formatted-section.ts +0 -49
- package/models/json-sub-field-dto.ts +0 -42
- package/models/list-changelog-configurations-response-class.ts +0 -49
- package/models/list-formatted-changelog-events-response-class.ts +0 -49
|
@@ -14,14 +14,13 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { GetChangelogEventResponseClass } from '../models';
|
|
16
16
|
import { ListChangelogEventsResponseClass } from '../models';
|
|
17
|
-
import { ListFormattedChangelogEventsResponseClass } from '../models';
|
|
18
17
|
/**
|
|
19
18
|
* ChangelogEventsApi - axios parameter creator
|
|
20
19
|
* @export
|
|
21
20
|
*/
|
|
22
21
|
export declare const ChangelogEventsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
22
|
/**
|
|
24
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
23
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
25
24
|
* @summary Retrieve the changelog event
|
|
26
25
|
* @param {string} code Unique identifier code for the changelog event
|
|
27
26
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -30,36 +29,20 @@ export declare const ChangelogEventsApiAxiosParamCreator: (configuration?: Confi
|
|
|
30
29
|
*/
|
|
31
30
|
getChangelogEvent: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
31
|
/**
|
|
33
|
-
* Returns a list of changelog events you have previously created.
|
|
32
|
+
* 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** none
|
|
34
33
|
* @summary List changelog events
|
|
35
34
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
36
35
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
37
36
|
* @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.
|
|
38
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
39
|
-
* @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>
|
|
37
|
+
* @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>
|
|
38
|
+
* @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>
|
|
40
39
|
* @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>
|
|
41
40
|
* @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/>
|
|
42
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
41
|
+
* @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>
|
|
43
42
|
* @param {*} [options] Override http request option.
|
|
44
43
|
* @throws {RequiredError}
|
|
45
44
|
*/
|
|
46
45
|
listChangelogEvents: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
|
-
/**
|
|
48
|
-
* 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\"
|
|
49
|
-
* @summary List formatted changelog events
|
|
50
|
-
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
51
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
52
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
53
|
-
* @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.
|
|
54
|
-
* @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>
|
|
55
|
-
* @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>
|
|
56
|
-
* @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>
|
|
57
|
-
* @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/>
|
|
58
|
-
* @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>
|
|
59
|
-
* @param {*} [options] Override http request option.
|
|
60
|
-
* @throws {RequiredError}
|
|
61
|
-
*/
|
|
62
|
-
listFormattedChangelogEvents: (configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
63
46
|
};
|
|
64
47
|
/**
|
|
65
48
|
* ChangelogEventsApi - functional programming interface
|
|
@@ -67,7 +50,7 @@ export declare const ChangelogEventsApiAxiosParamCreator: (configuration?: Confi
|
|
|
67
50
|
*/
|
|
68
51
|
export declare const ChangelogEventsApiFp: (configuration?: Configuration) => {
|
|
69
52
|
/**
|
|
70
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
53
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
71
54
|
* @summary Retrieve the changelog event
|
|
72
55
|
* @param {string} code Unique identifier code for the changelog event
|
|
73
56
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -76,36 +59,20 @@ export declare const ChangelogEventsApiFp: (configuration?: Configuration) => {
|
|
|
76
59
|
*/
|
|
77
60
|
getChangelogEvent(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogEventResponseClass>>;
|
|
78
61
|
/**
|
|
79
|
-
* Returns a list of changelog events you have previously created.
|
|
62
|
+
* 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** none
|
|
80
63
|
* @summary List changelog events
|
|
81
64
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
65
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
83
66
|
* @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
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
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, actorName</i>
|
|
67
|
+
* @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>
|
|
68
|
+
* @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>
|
|
86
69
|
* @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
70
|
* @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
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
71
|
+
* @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>
|
|
89
72
|
* @param {*} [options] Override http request option.
|
|
90
73
|
* @throws {RequiredError}
|
|
91
74
|
*/
|
|
92
75
|
listChangelogEvents(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListChangelogEventsResponseClass>>;
|
|
93
|
-
/**
|
|
94
|
-
* 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\"
|
|
95
|
-
* @summary List formatted changelog events
|
|
96
|
-
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
97
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
98
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
99
|
-
* @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.
|
|
100
|
-
* @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>
|
|
101
|
-
* @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>
|
|
102
|
-
* @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>
|
|
103
|
-
* @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/>
|
|
104
|
-
* @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>
|
|
105
|
-
* @param {*} [options] Override http request option.
|
|
106
|
-
* @throws {RequiredError}
|
|
107
|
-
*/
|
|
108
|
-
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>>;
|
|
109
76
|
};
|
|
110
77
|
/**
|
|
111
78
|
* ChangelogEventsApi - factory interface
|
|
@@ -113,7 +80,7 @@ export declare const ChangelogEventsApiFp: (configuration?: Configuration) => {
|
|
|
113
80
|
*/
|
|
114
81
|
export declare const ChangelogEventsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
115
82
|
/**
|
|
116
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
83
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
117
84
|
* @summary Retrieve the changelog event
|
|
118
85
|
* @param {string} code Unique identifier code for the changelog event
|
|
119
86
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -122,36 +89,20 @@ export declare const ChangelogEventsApiFactory: (configuration?: Configuration,
|
|
|
122
89
|
*/
|
|
123
90
|
getChangelogEvent(code: string, authorization?: string, options?: any): AxiosPromise<GetChangelogEventResponseClass>;
|
|
124
91
|
/**
|
|
125
|
-
* Returns a list of changelog events you have previously created.
|
|
92
|
+
* 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** none
|
|
126
93
|
* @summary List changelog events
|
|
127
94
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
128
95
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
129
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=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
130
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
131
|
-
* @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>
|
|
97
|
+
* @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>
|
|
98
|
+
* @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>
|
|
132
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.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
133
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.<br/> <br/>
|
|
134
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
101
|
+
* @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>
|
|
135
102
|
* @param {*} [options] Override http request option.
|
|
136
103
|
* @throws {RequiredError}
|
|
137
104
|
*/
|
|
138
105
|
listChangelogEvents(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogEventsResponseClass>;
|
|
139
|
-
/**
|
|
140
|
-
* 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\"
|
|
141
|
-
* @summary List formatted changelog events
|
|
142
|
-
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
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=1, your subsequent call can include pageToken=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.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
147
|
-
* @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>
|
|
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.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
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.<br/> <br/>
|
|
150
|
-
* @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>
|
|
151
|
-
* @param {*} [options] Override http request option.
|
|
152
|
-
* @throws {RequiredError}
|
|
153
|
-
*/
|
|
154
|
-
listFormattedChangelogEvents(configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFormattedChangelogEventsResponseClass>;
|
|
155
106
|
};
|
|
156
107
|
/**
|
|
157
108
|
* Request parameters for getChangelogEvent operation in ChangelogEventsApi.
|
|
@@ -197,13 +148,13 @@ export interface ChangelogEventsApiListChangelogEventsRequest {
|
|
|
197
148
|
*/
|
|
198
149
|
readonly pageToken?: string;
|
|
199
150
|
/**
|
|
200
|
-
* Filter the response by one or multiple fields.
|
|
151
|
+
* 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>
|
|
201
152
|
* @type {string}
|
|
202
153
|
* @memberof ChangelogEventsApiListChangelogEvents
|
|
203
154
|
*/
|
|
204
155
|
readonly filter?: string;
|
|
205
156
|
/**
|
|
206
|
-
* 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>
|
|
157
|
+
* 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>
|
|
207
158
|
* @type {string}
|
|
208
159
|
* @memberof ChangelogEventsApiListChangelogEvents
|
|
209
160
|
*/
|
|
@@ -221,73 +172,12 @@ export interface ChangelogEventsApiListChangelogEventsRequest {
|
|
|
221
172
|
*/
|
|
222
173
|
readonly expand?: string;
|
|
223
174
|
/**
|
|
224
|
-
* Filters the response by one or multiple fields.
|
|
175
|
+
* 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>
|
|
225
176
|
* @type {string}
|
|
226
177
|
* @memberof ChangelogEventsApiListChangelogEvents
|
|
227
178
|
*/
|
|
228
179
|
readonly filters?: string;
|
|
229
180
|
}
|
|
230
|
-
/**
|
|
231
|
-
* Request parameters for listFormattedChangelogEvents operation in ChangelogEventsApi.
|
|
232
|
-
* @export
|
|
233
|
-
* @interface ChangelogEventsApiListFormattedChangelogEventsRequest
|
|
234
|
-
*/
|
|
235
|
-
export interface ChangelogEventsApiListFormattedChangelogEventsRequest {
|
|
236
|
-
/**
|
|
237
|
-
* Slug of the changelog configuration to apply
|
|
238
|
-
* @type {string}
|
|
239
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
240
|
-
*/
|
|
241
|
-
readonly configSlug: string;
|
|
242
|
-
/**
|
|
243
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
|
-
* @type {string}
|
|
245
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
246
|
-
*/
|
|
247
|
-
readonly authorization?: string;
|
|
248
|
-
/**
|
|
249
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
250
|
-
* @type {number}
|
|
251
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
252
|
-
*/
|
|
253
|
-
readonly pageSize?: number;
|
|
254
|
-
/**
|
|
255
|
-
* 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.
|
|
256
|
-
* @type {string}
|
|
257
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
258
|
-
*/
|
|
259
|
-
readonly pageToken?: string;
|
|
260
|
-
/**
|
|
261
|
-
* 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>
|
|
262
|
-
* @type {string}
|
|
263
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
264
|
-
*/
|
|
265
|
-
readonly filter?: string;
|
|
266
|
-
/**
|
|
267
|
-
* 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>
|
|
268
|
-
* @type {string}
|
|
269
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
270
|
-
*/
|
|
271
|
-
readonly search?: string;
|
|
272
|
-
/**
|
|
273
|
-
* 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>
|
|
274
|
-
* @type {string}
|
|
275
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
276
|
-
*/
|
|
277
|
-
readonly order?: string;
|
|
278
|
-
/**
|
|
279
|
-
* 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/>
|
|
280
|
-
* @type {string}
|
|
281
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
282
|
-
*/
|
|
283
|
-
readonly expand?: string;
|
|
284
|
-
/**
|
|
285
|
-
* 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>
|
|
286
|
-
* @type {string}
|
|
287
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
288
|
-
*/
|
|
289
|
-
readonly filters?: string;
|
|
290
|
-
}
|
|
291
181
|
/**
|
|
292
182
|
* ChangelogEventsApi - object-oriented interface
|
|
293
183
|
* @export
|
|
@@ -296,7 +186,7 @@ export interface ChangelogEventsApiListFormattedChangelogEventsRequest {
|
|
|
296
186
|
*/
|
|
297
187
|
export declare class ChangelogEventsApi extends BaseAPI {
|
|
298
188
|
/**
|
|
299
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
189
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
300
190
|
* @summary Retrieve the changelog event
|
|
301
191
|
* @param {ChangelogEventsApiGetChangelogEventRequest} requestParameters Request parameters.
|
|
302
192
|
* @param {*} [options] Override http request option.
|
|
@@ -305,7 +195,7 @@ export declare class ChangelogEventsApi extends BaseAPI {
|
|
|
305
195
|
*/
|
|
306
196
|
getChangelogEvent(requestParameters: ChangelogEventsApiGetChangelogEventRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangelogEventResponseClass, any, {}>>;
|
|
307
197
|
/**
|
|
308
|
-
* Returns a list of changelog events you have previously created.
|
|
198
|
+
* 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** none
|
|
309
199
|
* @summary List changelog events
|
|
310
200
|
* @param {ChangelogEventsApiListChangelogEventsRequest} requestParameters Request parameters.
|
|
311
201
|
* @param {*} [options] Override http request option.
|
|
@@ -313,13 +203,4 @@ export declare class ChangelogEventsApi extends BaseAPI {
|
|
|
313
203
|
* @memberof ChangelogEventsApi
|
|
314
204
|
*/
|
|
315
205
|
listChangelogEvents(requestParameters?: ChangelogEventsApiListChangelogEventsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListChangelogEventsResponseClass, any, {}>>;
|
|
316
|
-
/**
|
|
317
|
-
* 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\"
|
|
318
|
-
* @summary List formatted changelog events
|
|
319
|
-
* @param {ChangelogEventsApiListFormattedChangelogEventsRequest} requestParameters Request parameters.
|
|
320
|
-
* @param {*} [options] Override http request option.
|
|
321
|
-
* @throws {RequiredError}
|
|
322
|
-
* @memberof ChangelogEventsApi
|
|
323
|
-
*/
|
|
324
|
-
listFormattedChangelogEvents(requestParameters: ChangelogEventsApiListFormattedChangelogEventsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListFormattedChangelogEventsResponseClass, any, {}>>;
|
|
325
206
|
}
|
|
@@ -93,7 +93,7 @@ var ChangelogEventsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
96
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
97
97
|
* @summary Retrieve the changelog event
|
|
98
98
|
* @param {string} code Unique identifier code for the changelog event
|
|
99
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -141,16 +141,16 @@ var ChangelogEventsApiAxiosParamCreator = function (configuration) {
|
|
|
141
141
|
});
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
|
-
* Returns a list of changelog events you have previously created.
|
|
144
|
+
* 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** none
|
|
145
145
|
* @summary List changelog events
|
|
146
146
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
147
147
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
148
148
|
* @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.
|
|
149
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
150
|
-
* @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>
|
|
149
|
+
* @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>
|
|
150
|
+
* @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>
|
|
151
151
|
* @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>
|
|
152
152
|
* @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/>
|
|
153
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
153
|
+
* @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>
|
|
154
154
|
* @param {*} [options] Override http request option.
|
|
155
155
|
* @throws {RequiredError}
|
|
156
156
|
*/
|
|
@@ -212,82 +212,6 @@ var ChangelogEventsApiAxiosParamCreator = function (configuration) {
|
|
|
212
212
|
});
|
|
213
213
|
});
|
|
214
214
|
},
|
|
215
|
-
/**
|
|
216
|
-
* 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\"
|
|
217
|
-
* @summary List formatted changelog events
|
|
218
|
-
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
219
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
220
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
221
|
-
* @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.
|
|
222
|
-
* @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>
|
|
223
|
-
* @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>
|
|
224
|
-
* @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>
|
|
225
|
-
* @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/>
|
|
226
|
-
* @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>
|
|
227
|
-
* @param {*} [options] Override http request option.
|
|
228
|
-
* @throws {RequiredError}
|
|
229
|
-
*/
|
|
230
|
-
listFormattedChangelogEvents: function (configSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
231
|
-
if (options === void 0) { options = {}; }
|
|
232
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
233
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
234
|
-
return __generator(this, function (_a) {
|
|
235
|
-
switch (_a.label) {
|
|
236
|
-
case 0:
|
|
237
|
-
// verify required parameter 'configSlug' is not null or undefined
|
|
238
|
-
(0, common_1.assertParamExists)('listFormattedChangelogEvents', 'configSlug', configSlug);
|
|
239
|
-
localVarPath = "/changelogservice/v1/changelog-events/formatted/{configSlug}"
|
|
240
|
-
.replace("{".concat("configSlug", "}"), encodeURIComponent(String(configSlug)));
|
|
241
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
242
|
-
if (configuration) {
|
|
243
|
-
baseOptions = configuration.baseOptions;
|
|
244
|
-
baseAccessToken = configuration.accessToken;
|
|
245
|
-
}
|
|
246
|
-
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
247
|
-
localVarHeaderParameter = {};
|
|
248
|
-
localVarQueryParameter = {};
|
|
249
|
-
// authentication bearer required
|
|
250
|
-
// http bearer authentication required
|
|
251
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
252
|
-
case 1:
|
|
253
|
-
// authentication bearer required
|
|
254
|
-
// http bearer authentication required
|
|
255
|
-
_a.sent();
|
|
256
|
-
if (pageSize !== undefined) {
|
|
257
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
258
|
-
}
|
|
259
|
-
if (pageToken !== undefined) {
|
|
260
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
261
|
-
}
|
|
262
|
-
if (filter !== undefined) {
|
|
263
|
-
localVarQueryParameter['filter'] = filter;
|
|
264
|
-
}
|
|
265
|
-
if (search !== undefined) {
|
|
266
|
-
localVarQueryParameter['search'] = search;
|
|
267
|
-
}
|
|
268
|
-
if (order !== undefined) {
|
|
269
|
-
localVarQueryParameter['order'] = order;
|
|
270
|
-
}
|
|
271
|
-
if (expand !== undefined) {
|
|
272
|
-
localVarQueryParameter['expand'] = expand;
|
|
273
|
-
}
|
|
274
|
-
if (filters !== undefined) {
|
|
275
|
-
localVarQueryParameter['filters'] = filters;
|
|
276
|
-
}
|
|
277
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
278
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
279
|
-
}
|
|
280
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
281
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
282
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
283
|
-
return [2 /*return*/, {
|
|
284
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
285
|
-
options: localVarRequestOptions,
|
|
286
|
-
}];
|
|
287
|
-
}
|
|
288
|
-
});
|
|
289
|
-
});
|
|
290
|
-
},
|
|
291
215
|
};
|
|
292
216
|
};
|
|
293
217
|
exports.ChangelogEventsApiAxiosParamCreator = ChangelogEventsApiAxiosParamCreator;
|
|
@@ -299,7 +223,7 @@ var ChangelogEventsApiFp = function (configuration) {
|
|
|
299
223
|
var localVarAxiosParamCreator = (0, exports.ChangelogEventsApiAxiosParamCreator)(configuration);
|
|
300
224
|
return {
|
|
301
225
|
/**
|
|
302
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
226
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
303
227
|
* @summary Retrieve the changelog event
|
|
304
228
|
* @param {string} code Unique identifier code for the changelog event
|
|
305
229
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -320,16 +244,16 @@ var ChangelogEventsApiFp = function (configuration) {
|
|
|
320
244
|
});
|
|
321
245
|
},
|
|
322
246
|
/**
|
|
323
|
-
* Returns a list of changelog events you have previously created.
|
|
247
|
+
* 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** none
|
|
324
248
|
* @summary List changelog events
|
|
325
249
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
326
250
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
327
251
|
* @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.
|
|
328
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
329
|
-
* @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>
|
|
252
|
+
* @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>
|
|
253
|
+
* @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>
|
|
330
254
|
* @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>
|
|
331
255
|
* @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/>
|
|
332
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
256
|
+
* @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>
|
|
333
257
|
* @param {*} [options] Override http request option.
|
|
334
258
|
* @throws {RequiredError}
|
|
335
259
|
*/
|
|
@@ -346,34 +270,6 @@ var ChangelogEventsApiFp = function (configuration) {
|
|
|
346
270
|
});
|
|
347
271
|
});
|
|
348
272
|
},
|
|
349
|
-
/**
|
|
350
|
-
* 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\"
|
|
351
|
-
* @summary List formatted changelog events
|
|
352
|
-
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
353
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
354
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
355
|
-
* @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.
|
|
356
|
-
* @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>
|
|
357
|
-
* @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>
|
|
358
|
-
* @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>
|
|
359
|
-
* @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/>
|
|
360
|
-
* @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>
|
|
361
|
-
* @param {*} [options] Override http request option.
|
|
362
|
-
* @throws {RequiredError}
|
|
363
|
-
*/
|
|
364
|
-
listFormattedChangelogEvents: function (configSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
365
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
366
|
-
var localVarAxiosArgs;
|
|
367
|
-
return __generator(this, function (_a) {
|
|
368
|
-
switch (_a.label) {
|
|
369
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listFormattedChangelogEvents(configSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
370
|
-
case 1:
|
|
371
|
-
localVarAxiosArgs = _a.sent();
|
|
372
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
373
|
-
}
|
|
374
|
-
});
|
|
375
|
-
});
|
|
376
|
-
},
|
|
377
273
|
};
|
|
378
274
|
};
|
|
379
275
|
exports.ChangelogEventsApiFp = ChangelogEventsApiFp;
|
|
@@ -385,7 +281,7 @@ var ChangelogEventsApiFactory = function (configuration, basePath, axios) {
|
|
|
385
281
|
var localVarFp = (0, exports.ChangelogEventsApiFp)(configuration);
|
|
386
282
|
return {
|
|
387
283
|
/**
|
|
388
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
284
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
389
285
|
* @summary Retrieve the changelog event
|
|
390
286
|
* @param {string} code Unique identifier code for the changelog event
|
|
391
287
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -396,40 +292,22 @@ var ChangelogEventsApiFactory = function (configuration, basePath, axios) {
|
|
|
396
292
|
return localVarFp.getChangelogEvent(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
397
293
|
},
|
|
398
294
|
/**
|
|
399
|
-
* Returns a list of changelog events you have previously created.
|
|
295
|
+
* 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** none
|
|
400
296
|
* @summary List changelog events
|
|
401
297
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
402
298
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
403
299
|
* @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.
|
|
404
|
-
* @param {string} [filter] Filter the response by one or multiple fields.
|
|
405
|
-
* @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>
|
|
300
|
+
* @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>
|
|
301
|
+
* @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>
|
|
406
302
|
* @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>
|
|
407
303
|
* @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/>
|
|
408
|
-
* @param {string} [filters] Filters the response by one or multiple fields.
|
|
304
|
+
* @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>
|
|
409
305
|
* @param {*} [options] Override http request option.
|
|
410
306
|
* @throws {RequiredError}
|
|
411
307
|
*/
|
|
412
308
|
listChangelogEvents: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
413
309
|
return localVarFp.listChangelogEvents(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
414
310
|
},
|
|
415
|
-
/**
|
|
416
|
-
* 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\"
|
|
417
|
-
* @summary List formatted changelog events
|
|
418
|
-
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
419
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
420
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
421
|
-
* @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.
|
|
422
|
-
* @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>
|
|
423
|
-
* @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>
|
|
424
|
-
* @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>
|
|
425
|
-
* @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/>
|
|
426
|
-
* @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>
|
|
427
|
-
* @param {*} [options] Override http request option.
|
|
428
|
-
* @throws {RequiredError}
|
|
429
|
-
*/
|
|
430
|
-
listFormattedChangelogEvents: function (configSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
431
|
-
return localVarFp.listFormattedChangelogEvents(configSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
432
|
-
},
|
|
433
311
|
};
|
|
434
312
|
};
|
|
435
313
|
exports.ChangelogEventsApiFactory = ChangelogEventsApiFactory;
|
|
@@ -445,7 +323,7 @@ var ChangelogEventsApi = /** @class */ (function (_super) {
|
|
|
445
323
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
446
324
|
}
|
|
447
325
|
/**
|
|
448
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
326
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
449
327
|
* @summary Retrieve the changelog event
|
|
450
328
|
* @param {ChangelogEventsApiGetChangelogEventRequest} requestParameters Request parameters.
|
|
451
329
|
* @param {*} [options] Override http request option.
|
|
@@ -457,7 +335,7 @@ var ChangelogEventsApi = /** @class */ (function (_super) {
|
|
|
457
335
|
return (0, exports.ChangelogEventsApiFp)(this.configuration).getChangelogEvent(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
458
336
|
};
|
|
459
337
|
/**
|
|
460
|
-
* Returns a list of changelog events you have previously created.
|
|
338
|
+
* 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** none
|
|
461
339
|
* @summary List changelog events
|
|
462
340
|
* @param {ChangelogEventsApiListChangelogEventsRequest} requestParameters Request parameters.
|
|
463
341
|
* @param {*} [options] Override http request option.
|
|
@@ -469,18 +347,6 @@ var ChangelogEventsApi = /** @class */ (function (_super) {
|
|
|
469
347
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
470
348
|
return (0, exports.ChangelogEventsApiFp)(this.configuration).listChangelogEvents(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
471
349
|
};
|
|
472
|
-
/**
|
|
473
|
-
* 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\"
|
|
474
|
-
* @summary List formatted changelog events
|
|
475
|
-
* @param {ChangelogEventsApiListFormattedChangelogEventsRequest} requestParameters Request parameters.
|
|
476
|
-
* @param {*} [options] Override http request option.
|
|
477
|
-
* @throws {RequiredError}
|
|
478
|
-
* @memberof ChangelogEventsApi
|
|
479
|
-
*/
|
|
480
|
-
ChangelogEventsApi.prototype.listFormattedChangelogEvents = function (requestParameters, options) {
|
|
481
|
-
var _this = this;
|
|
482
|
-
return (0, exports.ChangelogEventsApiFp)(this.configuration).listFormattedChangelogEvents(requestParameters.configSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
483
|
-
};
|
|
484
350
|
return ChangelogEventsApi;
|
|
485
351
|
}(base_1.BaseAPI));
|
|
486
352
|
exports.ChangelogEventsApi = ChangelogEventsApi;
|