@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
|
@@ -24,8 +24,6 @@ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } fr
|
|
|
24
24
|
import { GetChangelogEventResponseClass } from '../models';
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { ListChangelogEventsResponseClass } from '../models';
|
|
27
|
-
// @ts-ignore
|
|
28
|
-
import { ListFormattedChangelogEventsResponseClass } from '../models';
|
|
29
27
|
/**
|
|
30
28
|
* ChangelogEventsApi - axios parameter creator
|
|
31
29
|
* @export
|
|
@@ -33,7 +31,7 @@ import { ListFormattedChangelogEventsResponseClass } from '../models';
|
|
|
33
31
|
export const ChangelogEventsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
32
|
return {
|
|
35
33
|
/**
|
|
36
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
34
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
37
35
|
* @summary Retrieve the changelog event
|
|
38
36
|
* @param {string} code Unique identifier code for the changelog event
|
|
39
37
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -78,16 +76,16 @@ export const ChangelogEventsApiAxiosParamCreator = function (configuration?: Con
|
|
|
78
76
|
};
|
|
79
77
|
},
|
|
80
78
|
/**
|
|
81
|
-
* Returns a list of changelog events you have previously created.
|
|
79
|
+
* 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
|
|
82
80
|
* @summary List changelog events
|
|
83
81
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
84
82
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
85
83
|
* @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.
|
|
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>
|
|
84
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
85
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, entityCode, actorName, sourceService</i>
|
|
88
86
|
* @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
87
|
* @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.
|
|
88
|
+
* @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
89
|
* @param {*} [options] Override http request option.
|
|
92
90
|
* @throws {RequiredError}
|
|
93
91
|
*/
|
|
@@ -144,86 +142,6 @@ export const ChangelogEventsApiAxiosParamCreator = function (configuration?: Con
|
|
|
144
142
|
|
|
145
143
|
|
|
146
144
|
|
|
147
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
148
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
149
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
150
|
-
|
|
151
|
-
return {
|
|
152
|
-
url: toPathString(localVarUrlObj),
|
|
153
|
-
options: localVarRequestOptions,
|
|
154
|
-
};
|
|
155
|
-
},
|
|
156
|
-
/**
|
|
157
|
-
* Returns a list of formatted changelog events you have previously created. The formatted changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
158
|
-
* @summary List formatted changelog events
|
|
159
|
-
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
160
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
161
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
162
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
163
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
164
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, actorName</i>
|
|
165
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
166
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
167
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
168
|
-
* @param {*} [options] Override http request option.
|
|
169
|
-
* @throws {RequiredError}
|
|
170
|
-
*/
|
|
171
|
-
listFormattedChangelogEvents: async (configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
172
|
-
// verify required parameter 'configSlug' is not null or undefined
|
|
173
|
-
assertParamExists('listFormattedChangelogEvents', 'configSlug', configSlug)
|
|
174
|
-
const localVarPath = `/changelogservice/v1/changelog-events/formatted/{configSlug}`
|
|
175
|
-
.replace(`{${"configSlug"}}`, encodeURIComponent(String(configSlug)));
|
|
176
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
177
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
178
|
-
let baseOptions;
|
|
179
|
-
let baseAccessToken;
|
|
180
|
-
if (configuration) {
|
|
181
|
-
baseOptions = configuration.baseOptions;
|
|
182
|
-
baseAccessToken = configuration.accessToken;
|
|
183
|
-
}
|
|
184
|
-
|
|
185
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
186
|
-
const localVarHeaderParameter = {} as any;
|
|
187
|
-
const localVarQueryParameter = {} as any;
|
|
188
|
-
|
|
189
|
-
// authentication bearer required
|
|
190
|
-
// http bearer authentication required
|
|
191
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
192
|
-
|
|
193
|
-
if (pageSize !== undefined) {
|
|
194
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
if (pageToken !== undefined) {
|
|
198
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
199
|
-
}
|
|
200
|
-
|
|
201
|
-
if (filter !== undefined) {
|
|
202
|
-
localVarQueryParameter['filter'] = filter;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
if (search !== undefined) {
|
|
206
|
-
localVarQueryParameter['search'] = search;
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
if (order !== undefined) {
|
|
210
|
-
localVarQueryParameter['order'] = order;
|
|
211
|
-
}
|
|
212
|
-
|
|
213
|
-
if (expand !== undefined) {
|
|
214
|
-
localVarQueryParameter['expand'] = expand;
|
|
215
|
-
}
|
|
216
|
-
|
|
217
|
-
if (filters !== undefined) {
|
|
218
|
-
localVarQueryParameter['filters'] = filters;
|
|
219
|
-
}
|
|
220
|
-
|
|
221
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
222
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
223
|
-
}
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
145
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
228
146
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
229
147
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -244,7 +162,7 @@ export const ChangelogEventsApiFp = function(configuration?: Configuration) {
|
|
|
244
162
|
const localVarAxiosParamCreator = ChangelogEventsApiAxiosParamCreator(configuration)
|
|
245
163
|
return {
|
|
246
164
|
/**
|
|
247
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
165
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
248
166
|
* @summary Retrieve the changelog event
|
|
249
167
|
* @param {string} code Unique identifier code for the changelog event
|
|
250
168
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -256,16 +174,16 @@ export const ChangelogEventsApiFp = function(configuration?: Configuration) {
|
|
|
256
174
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
257
175
|
},
|
|
258
176
|
/**
|
|
259
|
-
* Returns a list of changelog events you have previously created.
|
|
177
|
+
* 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
|
|
260
178
|
* @summary List changelog events
|
|
261
179
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
262
180
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
263
181
|
* @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.
|
|
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>
|
|
182
|
+
* @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>
|
|
183
|
+
* @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>
|
|
266
184
|
* @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
185
|
* @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.
|
|
186
|
+
* @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
187
|
* @param {*} [options] Override http request option.
|
|
270
188
|
* @throws {RequiredError}
|
|
271
189
|
*/
|
|
@@ -273,25 +191,6 @@ export const ChangelogEventsApiFp = function(configuration?: Configuration) {
|
|
|
273
191
|
const localVarAxiosArgs = await localVarAxiosParamCreator.listChangelogEvents(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
274
192
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
275
193
|
},
|
|
276
|
-
/**
|
|
277
|
-
* Returns a list of formatted changelog events you have previously created. The formatted changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
278
|
-
* @summary List formatted changelog events
|
|
279
|
-
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
280
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
281
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
282
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=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. 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
|
-
* @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
|
-
* @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
|
-
* @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. 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
|
-
* @param {*} [options] Override http request option.
|
|
289
|
-
* @throws {RequiredError}
|
|
290
|
-
*/
|
|
291
|
-
async listFormattedChangelogEvents(configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListFormattedChangelogEventsResponseClass>> {
|
|
292
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listFormattedChangelogEvents(configSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
293
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
294
|
-
},
|
|
295
194
|
}
|
|
296
195
|
};
|
|
297
196
|
|
|
@@ -303,7 +202,7 @@ export const ChangelogEventsApiFactory = function (configuration?: Configuration
|
|
|
303
202
|
const localVarFp = ChangelogEventsApiFp(configuration)
|
|
304
203
|
return {
|
|
305
204
|
/**
|
|
306
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
205
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
307
206
|
* @summary Retrieve the changelog event
|
|
308
207
|
* @param {string} code Unique identifier code for the changelog event
|
|
309
208
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -314,40 +213,22 @@ export const ChangelogEventsApiFactory = function (configuration?: Configuration
|
|
|
314
213
|
return localVarFp.getChangelogEvent(code, authorization, options).then((request) => request(axios, basePath));
|
|
315
214
|
},
|
|
316
215
|
/**
|
|
317
|
-
* Returns a list of changelog events you have previously created.
|
|
216
|
+
* 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
|
|
318
217
|
* @summary List changelog events
|
|
319
218
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
320
219
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
321
220
|
* @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.
|
|
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>
|
|
221
|
+
* @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>
|
|
222
|
+
* @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>
|
|
324
223
|
* @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
224
|
* @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.
|
|
225
|
+
* @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
226
|
* @param {*} [options] Override http request option.
|
|
328
227
|
* @throws {RequiredError}
|
|
329
228
|
*/
|
|
330
229
|
listChangelogEvents(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogEventsResponseClass> {
|
|
331
230
|
return localVarFp.listChangelogEvents(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
332
231
|
},
|
|
333
|
-
/**
|
|
334
|
-
* Returns a list of formatted changelog events you have previously created. The formatted changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
335
|
-
* @summary List formatted changelog events
|
|
336
|
-
* @param {string} configSlug Slug of the changelog configuration to apply
|
|
337
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
338
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
339
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=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. 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
|
-
* @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
|
-
* @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
|
-
* @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. 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
|
-
* @param {*} [options] Override http request option.
|
|
346
|
-
* @throws {RequiredError}
|
|
347
|
-
*/
|
|
348
|
-
listFormattedChangelogEvents(configSlug: string, authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListFormattedChangelogEventsResponseClass> {
|
|
349
|
-
return localVarFp.listFormattedChangelogEvents(configSlug, authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
350
|
-
},
|
|
351
232
|
};
|
|
352
233
|
};
|
|
353
234
|
|
|
@@ -400,14 +281,14 @@ export interface ChangelogEventsApiListChangelogEventsRequest {
|
|
|
400
281
|
readonly pageToken?: string
|
|
401
282
|
|
|
402
283
|
/**
|
|
403
|
-
* Filter the response by one or multiple fields.
|
|
284
|
+
* 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
285
|
* @type {string}
|
|
405
286
|
* @memberof ChangelogEventsApiListChangelogEvents
|
|
406
287
|
*/
|
|
407
288
|
readonly filter?: string
|
|
408
289
|
|
|
409
290
|
/**
|
|
410
|
-
* 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>
|
|
291
|
+
* 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>
|
|
411
292
|
* @type {string}
|
|
412
293
|
* @memberof ChangelogEventsApiListChangelogEvents
|
|
413
294
|
*/
|
|
@@ -428,83 +309,13 @@ export interface ChangelogEventsApiListChangelogEventsRequest {
|
|
|
428
309
|
readonly expand?: string
|
|
429
310
|
|
|
430
311
|
/**
|
|
431
|
-
* Filters the response by one or multiple fields.
|
|
312
|
+
* 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
313
|
* @type {string}
|
|
433
314
|
* @memberof ChangelogEventsApiListChangelogEvents
|
|
434
315
|
*/
|
|
435
316
|
readonly filters?: string
|
|
436
317
|
}
|
|
437
318
|
|
|
438
|
-
/**
|
|
439
|
-
* Request parameters for listFormattedChangelogEvents operation in ChangelogEventsApi.
|
|
440
|
-
* @export
|
|
441
|
-
* @interface ChangelogEventsApiListFormattedChangelogEventsRequest
|
|
442
|
-
*/
|
|
443
|
-
export interface ChangelogEventsApiListFormattedChangelogEventsRequest {
|
|
444
|
-
/**
|
|
445
|
-
* Slug of the changelog configuration to apply
|
|
446
|
-
* @type {string}
|
|
447
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
448
|
-
*/
|
|
449
|
-
readonly configSlug: string
|
|
450
|
-
|
|
451
|
-
/**
|
|
452
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
453
|
-
* @type {string}
|
|
454
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
455
|
-
*/
|
|
456
|
-
readonly authorization?: string
|
|
457
|
-
|
|
458
|
-
/**
|
|
459
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
460
|
-
* @type {number}
|
|
461
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
462
|
-
*/
|
|
463
|
-
readonly pageSize?: number
|
|
464
|
-
|
|
465
|
-
/**
|
|
466
|
-
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
467
|
-
* @type {string}
|
|
468
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
469
|
-
*/
|
|
470
|
-
readonly pageToken?: string
|
|
471
|
-
|
|
472
|
-
/**
|
|
473
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
474
|
-
* @type {string}
|
|
475
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
476
|
-
*/
|
|
477
|
-
readonly filter?: string
|
|
478
|
-
|
|
479
|
-
/**
|
|
480
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, actorName</i>
|
|
481
|
-
* @type {string}
|
|
482
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
483
|
-
*/
|
|
484
|
-
readonly search?: string
|
|
485
|
-
|
|
486
|
-
/**
|
|
487
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
488
|
-
* @type {string}
|
|
489
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
490
|
-
*/
|
|
491
|
-
readonly order?: string
|
|
492
|
-
|
|
493
|
-
/**
|
|
494
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
495
|
-
* @type {string}
|
|
496
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
497
|
-
*/
|
|
498
|
-
readonly expand?: string
|
|
499
|
-
|
|
500
|
-
/**
|
|
501
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
502
|
-
* @type {string}
|
|
503
|
-
* @memberof ChangelogEventsApiListFormattedChangelogEvents
|
|
504
|
-
*/
|
|
505
|
-
readonly filters?: string
|
|
506
|
-
}
|
|
507
|
-
|
|
508
319
|
/**
|
|
509
320
|
* ChangelogEventsApi - object-oriented interface
|
|
510
321
|
* @export
|
|
@@ -513,7 +324,7 @@ export interface ChangelogEventsApiListFormattedChangelogEventsRequest {
|
|
|
513
324
|
*/
|
|
514
325
|
export class ChangelogEventsApi extends BaseAPI {
|
|
515
326
|
/**
|
|
516
|
-
* Retrieves a changelog event by its code **Required Permissions**
|
|
327
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
517
328
|
* @summary Retrieve the changelog event
|
|
518
329
|
* @param {ChangelogEventsApiGetChangelogEventRequest} requestParameters Request parameters.
|
|
519
330
|
* @param {*} [options] Override http request option.
|
|
@@ -525,7 +336,7 @@ export class ChangelogEventsApi extends BaseAPI {
|
|
|
525
336
|
}
|
|
526
337
|
|
|
527
338
|
/**
|
|
528
|
-
* Returns a list of changelog events you have previously created.
|
|
339
|
+
* 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
|
|
529
340
|
* @summary List changelog events
|
|
530
341
|
* @param {ChangelogEventsApiListChangelogEventsRequest} requestParameters Request parameters.
|
|
531
342
|
* @param {*} [options] Override http request option.
|
|
@@ -535,16 +346,4 @@ export class ChangelogEventsApi extends BaseAPI {
|
|
|
535
346
|
public listChangelogEvents(requestParameters: ChangelogEventsApiListChangelogEventsRequest = {}, options?: AxiosRequestConfig) {
|
|
536
347
|
return ChangelogEventsApiFp(this.configuration).listChangelogEvents(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
537
348
|
}
|
|
538
|
-
|
|
539
|
-
/**
|
|
540
|
-
* Returns a list of formatted changelog events you have previously created. The formatted changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"changelog-management.changelog-events.view\"
|
|
541
|
-
* @summary List formatted changelog events
|
|
542
|
-
* @param {ChangelogEventsApiListFormattedChangelogEventsRequest} requestParameters Request parameters.
|
|
543
|
-
* @param {*} [options] Override http request option.
|
|
544
|
-
* @throws {RequiredError}
|
|
545
|
-
* @memberof ChangelogEventsApi
|
|
546
|
-
*/
|
|
547
|
-
public listFormattedChangelogEvents(requestParameters: ChangelogEventsApiListFormattedChangelogEventsRequest, options?: AxiosRequestConfig) {
|
|
548
|
-
return ChangelogEventsApiFp(this.configuration).listFormattedChangelogEvents(requestParameters.configSlug, requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
549
|
-
}
|
|
550
349
|
}
|