@emilgroup/changelog-sdk 1.0.1-beta.15 → 1.0.1-beta.3
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 -301
- package/api/changelog-events-api.ts +20 -221
- package/dist/api/changelog-configurations-api.d.ts +12 -177
- package/dist/api/changelog-configurations-api.js +12 -233
- 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
package/.openapi-generator/FILES
CHANGED
|
@@ -12,26 +12,17 @@ configuration.ts
|
|
|
12
12
|
git_push.sh
|
|
13
13
|
index.ts
|
|
14
14
|
models/changelog-config-field-class.ts
|
|
15
|
-
models/changelog-config-field-dto.ts
|
|
16
15
|
models/changelog-config-section-class.ts
|
|
17
|
-
models/changelog-config-section-dto.ts
|
|
18
16
|
models/changelog-configuration-class.ts
|
|
19
17
|
models/changelog-event-class-changes.ts
|
|
20
18
|
models/changelog-event-class.ts
|
|
21
|
-
models/composite-source-dto.ts
|
|
22
19
|
models/create-changelog-configuration-dto.ts
|
|
23
|
-
models/formatted-changelog-event.ts
|
|
24
|
-
models/formatted-field-entry.ts
|
|
25
|
-
models/formatted-section.ts
|
|
26
20
|
models/get-changelog-configuration-response-class.ts
|
|
27
21
|
models/get-changelog-event-response-class.ts
|
|
28
22
|
models/index.ts
|
|
29
23
|
models/inline-response200.ts
|
|
30
24
|
models/inline-response503.ts
|
|
31
|
-
models/json-sub-field-dto.ts
|
|
32
|
-
models/list-changelog-configurations-response-class.ts
|
|
33
25
|
models/list-changelog-events-response-class.ts
|
|
34
|
-
models/list-formatted-changelog-events-response-class.ts
|
|
35
26
|
models/update-changelog-configuration-dto.ts
|
|
36
27
|
package.json
|
|
37
28
|
tsconfig.json
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/changelog-sdk@1.0.1-beta.
|
|
20
|
+
npm install @emilgroup/changelog-sdk@1.0.1-beta.3 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/changelog-sdk@1.0.1-beta.
|
|
24
|
+
yarn add @emilgroup/changelog-sdk@1.0.1-beta.3
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import ``.
|
|
@@ -25,8 +25,6 @@ import { CreateChangelogConfigurationDto } from '../models';
|
|
|
25
25
|
// @ts-ignore
|
|
26
26
|
import { GetChangelogConfigurationResponseClass } from '../models';
|
|
27
27
|
// @ts-ignore
|
|
28
|
-
import { ListChangelogConfigurationsResponseClass } from '../models';
|
|
29
|
-
// @ts-ignore
|
|
30
28
|
import { UpdateChangelogConfigurationDto } from '../models';
|
|
31
29
|
/**
|
|
32
30
|
* ChangelogConfigurationsApi - axios parameter creator
|
|
@@ -35,7 +33,7 @@ import { UpdateChangelogConfigurationDto } from '../models';
|
|
|
35
33
|
export const ChangelogConfigurationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
36
34
|
return {
|
|
37
35
|
/**
|
|
38
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
36
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
39
37
|
* @summary Create the changelog configuration
|
|
40
38
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
41
39
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -82,52 +80,7 @@ export const ChangelogConfigurationsApiAxiosParamCreator = function (configurati
|
|
|
82
80
|
};
|
|
83
81
|
},
|
|
84
82
|
/**
|
|
85
|
-
*
|
|
86
|
-
* @summary Delete the changelog configuration
|
|
87
|
-
* @param {string} code Unique identifier code for the changelog configuration
|
|
88
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
89
|
-
* @param {*} [options] Override http request option.
|
|
90
|
-
* @throws {RequiredError}
|
|
91
|
-
*/
|
|
92
|
-
deleteChangelogConfiguration: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
|
-
// verify required parameter 'code' is not null or undefined
|
|
94
|
-
assertParamExists('deleteChangelogConfiguration', 'code', code)
|
|
95
|
-
const localVarPath = `/changelogservice/v1/changelog-configurations/{code}`
|
|
96
|
-
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
97
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
98
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
99
|
-
let baseOptions;
|
|
100
|
-
let baseAccessToken;
|
|
101
|
-
if (configuration) {
|
|
102
|
-
baseOptions = configuration.baseOptions;
|
|
103
|
-
baseAccessToken = configuration.accessToken;
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
107
|
-
const localVarHeaderParameter = {} as any;
|
|
108
|
-
const localVarQueryParameter = {} as any;
|
|
109
|
-
|
|
110
|
-
// authentication bearer required
|
|
111
|
-
// http bearer authentication required
|
|
112
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
113
|
-
|
|
114
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
115
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
116
|
-
}
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
121
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
122
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
123
|
-
|
|
124
|
-
return {
|
|
125
|
-
url: toPathString(localVarUrlObj),
|
|
126
|
-
options: localVarRequestOptions,
|
|
127
|
-
};
|
|
128
|
-
},
|
|
129
|
-
/**
|
|
130
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
83
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
131
84
|
* @summary Retrieve the changelog configuration
|
|
132
85
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
133
86
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -172,83 +125,7 @@ export const ChangelogConfigurationsApiAxiosParamCreator = function (configurati
|
|
|
172
125
|
};
|
|
173
126
|
},
|
|
174
127
|
/**
|
|
175
|
-
*
|
|
176
|
-
* @summary List changelog configurations
|
|
177
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
178
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
179
|
-
* @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.
|
|
180
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
181
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, slug, entityType</i>
|
|
182
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
183
|
-
* @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/>
|
|
184
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
185
|
-
* @param {*} [options] Override http request option.
|
|
186
|
-
* @throws {RequiredError}
|
|
187
|
-
*/
|
|
188
|
-
listChangelogConfigurations: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
189
|
-
const localVarPath = `/changelogservice/v1/changelog-configurations`;
|
|
190
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
191
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
192
|
-
let baseOptions;
|
|
193
|
-
let baseAccessToken;
|
|
194
|
-
if (configuration) {
|
|
195
|
-
baseOptions = configuration.baseOptions;
|
|
196
|
-
baseAccessToken = configuration.accessToken;
|
|
197
|
-
}
|
|
198
|
-
|
|
199
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
200
|
-
const localVarHeaderParameter = {} as any;
|
|
201
|
-
const localVarQueryParameter = {} as any;
|
|
202
|
-
|
|
203
|
-
// authentication bearer required
|
|
204
|
-
// http bearer authentication required
|
|
205
|
-
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
206
|
-
|
|
207
|
-
if (pageSize !== undefined) {
|
|
208
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
209
|
-
}
|
|
210
|
-
|
|
211
|
-
if (pageToken !== undefined) {
|
|
212
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
213
|
-
}
|
|
214
|
-
|
|
215
|
-
if (filter !== undefined) {
|
|
216
|
-
localVarQueryParameter['filter'] = filter;
|
|
217
|
-
}
|
|
218
|
-
|
|
219
|
-
if (search !== undefined) {
|
|
220
|
-
localVarQueryParameter['search'] = search;
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
if (order !== undefined) {
|
|
224
|
-
localVarQueryParameter['order'] = order;
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
if (expand !== undefined) {
|
|
228
|
-
localVarQueryParameter['expand'] = expand;
|
|
229
|
-
}
|
|
230
|
-
|
|
231
|
-
if (filters !== undefined) {
|
|
232
|
-
localVarQueryParameter['filters'] = filters;
|
|
233
|
-
}
|
|
234
|
-
|
|
235
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
236
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
237
|
-
}
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
242
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
243
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
244
|
-
|
|
245
|
-
return {
|
|
246
|
-
url: toPathString(localVarUrlObj),
|
|
247
|
-
options: localVarRequestOptions,
|
|
248
|
-
};
|
|
249
|
-
},
|
|
250
|
-
/**
|
|
251
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
128
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
252
129
|
* @summary Update the changelog configuration
|
|
253
130
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
254
131
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -309,7 +186,7 @@ export const ChangelogConfigurationsApiFp = function(configuration?: Configurati
|
|
|
309
186
|
const localVarAxiosParamCreator = ChangelogConfigurationsApiAxiosParamCreator(configuration)
|
|
310
187
|
return {
|
|
311
188
|
/**
|
|
312
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
189
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
313
190
|
* @summary Create the changelog configuration
|
|
314
191
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
315
192
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -321,19 +198,7 @@ export const ChangelogConfigurationsApiFp = function(configuration?: Configurati
|
|
|
321
198
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
322
199
|
},
|
|
323
200
|
/**
|
|
324
|
-
*
|
|
325
|
-
* @summary Delete the changelog configuration
|
|
326
|
-
* @param {string} code Unique identifier code for the changelog configuration
|
|
327
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
328
|
-
* @param {*} [options] Override http request option.
|
|
329
|
-
* @throws {RequiredError}
|
|
330
|
-
*/
|
|
331
|
-
async deleteChangelogConfiguration(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
332
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.deleteChangelogConfiguration(code, authorization, options);
|
|
333
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
334
|
-
},
|
|
335
|
-
/**
|
|
336
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
201
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
337
202
|
* @summary Retrieve the changelog configuration
|
|
338
203
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
339
204
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -345,25 +210,7 @@ export const ChangelogConfigurationsApiFp = function(configuration?: Configurati
|
|
|
345
210
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
346
211
|
},
|
|
347
212
|
/**
|
|
348
|
-
*
|
|
349
|
-
* @summary List changelog configurations
|
|
350
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
351
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
352
|
-
* @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.
|
|
353
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
354
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, slug, entityType</i>
|
|
355
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
356
|
-
* @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/>
|
|
357
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
358
|
-
* @param {*} [options] Override http request option.
|
|
359
|
-
* @throws {RequiredError}
|
|
360
|
-
*/
|
|
361
|
-
async listChangelogConfigurations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListChangelogConfigurationsResponseClass>> {
|
|
362
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
363
|
-
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
364
|
-
},
|
|
365
|
-
/**
|
|
366
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
213
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
367
214
|
* @summary Update the changelog configuration
|
|
368
215
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
369
216
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -386,7 +233,7 @@ export const ChangelogConfigurationsApiFactory = function (configuration?: Confi
|
|
|
386
233
|
const localVarFp = ChangelogConfigurationsApiFp(configuration)
|
|
387
234
|
return {
|
|
388
235
|
/**
|
|
389
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
236
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
390
237
|
* @summary Create the changelog configuration
|
|
391
238
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
392
239
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -397,18 +244,7 @@ export const ChangelogConfigurationsApiFactory = function (configuration?: Confi
|
|
|
397
244
|
return localVarFp.createChangelogConfiguration(createChangelogConfigurationDto, authorization, options).then((request) => request(axios, basePath));
|
|
398
245
|
},
|
|
399
246
|
/**
|
|
400
|
-
*
|
|
401
|
-
* @summary Delete the changelog configuration
|
|
402
|
-
* @param {string} code Unique identifier code for the changelog configuration
|
|
403
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
404
|
-
* @param {*} [options] Override http request option.
|
|
405
|
-
* @throws {RequiredError}
|
|
406
|
-
*/
|
|
407
|
-
deleteChangelogConfiguration(code: string, authorization?: string, options?: any): AxiosPromise<void> {
|
|
408
|
-
return localVarFp.deleteChangelogConfiguration(code, authorization, options).then((request) => request(axios, basePath));
|
|
409
|
-
},
|
|
410
|
-
/**
|
|
411
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
247
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
412
248
|
* @summary Retrieve the changelog configuration
|
|
413
249
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
414
250
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -419,24 +255,7 @@ export const ChangelogConfigurationsApiFactory = function (configuration?: Confi
|
|
|
419
255
|
return localVarFp.getChangelogConfiguration(code, authorization, options).then((request) => request(axios, basePath));
|
|
420
256
|
},
|
|
421
257
|
/**
|
|
422
|
-
*
|
|
423
|
-
* @summary List changelog configurations
|
|
424
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
425
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
426
|
-
* @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.
|
|
427
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
428
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, slug, entityType</i>
|
|
429
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
430
|
-
* @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/>
|
|
431
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
432
|
-
* @param {*} [options] Override http request option.
|
|
433
|
-
* @throws {RequiredError}
|
|
434
|
-
*/
|
|
435
|
-
listChangelogConfigurations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogConfigurationsResponseClass> {
|
|
436
|
-
return localVarFp.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
437
|
-
},
|
|
438
|
-
/**
|
|
439
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
258
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
440
259
|
* @summary Update the changelog configuration
|
|
441
260
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
442
261
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -471,27 +290,6 @@ export interface ChangelogConfigurationsApiCreateChangelogConfigurationRequest {
|
|
|
471
290
|
readonly authorization?: string
|
|
472
291
|
}
|
|
473
292
|
|
|
474
|
-
/**
|
|
475
|
-
* Request parameters for deleteChangelogConfiguration operation in ChangelogConfigurationsApi.
|
|
476
|
-
* @export
|
|
477
|
-
* @interface ChangelogConfigurationsApiDeleteChangelogConfigurationRequest
|
|
478
|
-
*/
|
|
479
|
-
export interface ChangelogConfigurationsApiDeleteChangelogConfigurationRequest {
|
|
480
|
-
/**
|
|
481
|
-
* Unique identifier code for the changelog configuration
|
|
482
|
-
* @type {string}
|
|
483
|
-
* @memberof ChangelogConfigurationsApiDeleteChangelogConfiguration
|
|
484
|
-
*/
|
|
485
|
-
readonly code: string
|
|
486
|
-
|
|
487
|
-
/**
|
|
488
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
489
|
-
* @type {string}
|
|
490
|
-
* @memberof ChangelogConfigurationsApiDeleteChangelogConfiguration
|
|
491
|
-
*/
|
|
492
|
-
readonly authorization?: string
|
|
493
|
-
}
|
|
494
|
-
|
|
495
293
|
/**
|
|
496
294
|
* Request parameters for getChangelogConfiguration operation in ChangelogConfigurationsApi.
|
|
497
295
|
* @export
|
|
@@ -513,69 +311,6 @@ export interface ChangelogConfigurationsApiGetChangelogConfigurationRequest {
|
|
|
513
311
|
readonly authorization?: string
|
|
514
312
|
}
|
|
515
313
|
|
|
516
|
-
/**
|
|
517
|
-
* Request parameters for listChangelogConfigurations operation in ChangelogConfigurationsApi.
|
|
518
|
-
* @export
|
|
519
|
-
* @interface ChangelogConfigurationsApiListChangelogConfigurationsRequest
|
|
520
|
-
*/
|
|
521
|
-
export interface ChangelogConfigurationsApiListChangelogConfigurationsRequest {
|
|
522
|
-
/**
|
|
523
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
524
|
-
* @type {string}
|
|
525
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
526
|
-
*/
|
|
527
|
-
readonly authorization?: string
|
|
528
|
-
|
|
529
|
-
/**
|
|
530
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
531
|
-
* @type {number}
|
|
532
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
533
|
-
*/
|
|
534
|
-
readonly pageSize?: number
|
|
535
|
-
|
|
536
|
-
/**
|
|
537
|
-
* 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.
|
|
538
|
-
* @type {string}
|
|
539
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
540
|
-
*/
|
|
541
|
-
readonly pageToken?: string
|
|
542
|
-
|
|
543
|
-
/**
|
|
544
|
-
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
545
|
-
* @type {string}
|
|
546
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
547
|
-
*/
|
|
548
|
-
readonly filter?: string
|
|
549
|
-
|
|
550
|
-
/**
|
|
551
|
-
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, slug, entityType</i>
|
|
552
|
-
* @type {string}
|
|
553
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
554
|
-
*/
|
|
555
|
-
readonly search?: string
|
|
556
|
-
|
|
557
|
-
/**
|
|
558
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
559
|
-
* @type {string}
|
|
560
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
561
|
-
*/
|
|
562
|
-
readonly order?: string
|
|
563
|
-
|
|
564
|
-
/**
|
|
565
|
-
* 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/>
|
|
566
|
-
* @type {string}
|
|
567
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
568
|
-
*/
|
|
569
|
-
readonly expand?: string
|
|
570
|
-
|
|
571
|
-
/**
|
|
572
|
-
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
573
|
-
* @type {string}
|
|
574
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
575
|
-
*/
|
|
576
|
-
readonly filters?: string
|
|
577
|
-
}
|
|
578
|
-
|
|
579
314
|
/**
|
|
580
315
|
* Request parameters for updateChangelogConfiguration operation in ChangelogConfigurationsApi.
|
|
581
316
|
* @export
|
|
@@ -612,7 +347,7 @@ export interface ChangelogConfigurationsApiUpdateChangelogConfigurationRequest {
|
|
|
612
347
|
*/
|
|
613
348
|
export class ChangelogConfigurationsApi extends BaseAPI {
|
|
614
349
|
/**
|
|
615
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
350
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
616
351
|
* @summary Create the changelog configuration
|
|
617
352
|
* @param {ChangelogConfigurationsApiCreateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
618
353
|
* @param {*} [options] Override http request option.
|
|
@@ -624,19 +359,7 @@ export class ChangelogConfigurationsApi extends BaseAPI {
|
|
|
624
359
|
}
|
|
625
360
|
|
|
626
361
|
/**
|
|
627
|
-
*
|
|
628
|
-
* @summary Delete the changelog configuration
|
|
629
|
-
* @param {ChangelogConfigurationsApiDeleteChangelogConfigurationRequest} requestParameters Request parameters.
|
|
630
|
-
* @param {*} [options] Override http request option.
|
|
631
|
-
* @throws {RequiredError}
|
|
632
|
-
* @memberof ChangelogConfigurationsApi
|
|
633
|
-
*/
|
|
634
|
-
public deleteChangelogConfiguration(requestParameters: ChangelogConfigurationsApiDeleteChangelogConfigurationRequest, options?: AxiosRequestConfig) {
|
|
635
|
-
return ChangelogConfigurationsApiFp(this.configuration).deleteChangelogConfiguration(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
636
|
-
}
|
|
637
|
-
|
|
638
|
-
/**
|
|
639
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
362
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
640
363
|
* @summary Retrieve the changelog configuration
|
|
641
364
|
* @param {ChangelogConfigurationsApiGetChangelogConfigurationRequest} requestParameters Request parameters.
|
|
642
365
|
* @param {*} [options] Override http request option.
|
|
@@ -648,19 +371,7 @@ export class ChangelogConfigurationsApi extends BaseAPI {
|
|
|
648
371
|
}
|
|
649
372
|
|
|
650
373
|
/**
|
|
651
|
-
*
|
|
652
|
-
* @summary List changelog configurations
|
|
653
|
-
* @param {ChangelogConfigurationsApiListChangelogConfigurationsRequest} requestParameters Request parameters.
|
|
654
|
-
* @param {*} [options] Override http request option.
|
|
655
|
-
* @throws {RequiredError}
|
|
656
|
-
* @memberof ChangelogConfigurationsApi
|
|
657
|
-
*/
|
|
658
|
-
public listChangelogConfigurations(requestParameters: ChangelogConfigurationsApiListChangelogConfigurationsRequest = {}, options?: AxiosRequestConfig) {
|
|
659
|
-
return ChangelogConfigurationsApiFp(this.configuration).listChangelogConfigurations(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
660
|
-
}
|
|
661
|
-
|
|
662
|
-
/**
|
|
663
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
374
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
664
375
|
* @summary Update the changelog configuration
|
|
665
376
|
* @param {ChangelogConfigurationsApiUpdateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
666
377
|
* @param {*} [options] Override http request option.
|