@emilgroup/changelog-sdk 1.0.1-beta.15 → 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 -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
|
@@ -14,7 +14,6 @@ import { Configuration } from '../configuration';
|
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
15
|
import { CreateChangelogConfigurationDto } from '../models';
|
|
16
16
|
import { GetChangelogConfigurationResponseClass } from '../models';
|
|
17
|
-
import { ListChangelogConfigurationsResponseClass } from '../models';
|
|
18
17
|
import { UpdateChangelogConfigurationDto } from '../models';
|
|
19
18
|
/**
|
|
20
19
|
* ChangelogConfigurationsApi - axios parameter creator
|
|
@@ -22,7 +21,7 @@ import { UpdateChangelogConfigurationDto } from '../models';
|
|
|
22
21
|
*/
|
|
23
22
|
export declare const ChangelogConfigurationsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24
23
|
/**
|
|
25
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
24
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
26
25
|
* @summary Create the changelog configuration
|
|
27
26
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
28
27
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -31,16 +30,7 @@ export declare const ChangelogConfigurationsApiAxiosParamCreator: (configuration
|
|
|
31
30
|
*/
|
|
32
31
|
createChangelogConfiguration: (createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
32
|
/**
|
|
34
|
-
*
|
|
35
|
-
* @summary Delete the changelog configuration
|
|
36
|
-
* @param {string} code Unique identifier code for the changelog configuration
|
|
37
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
38
|
-
* @param {*} [options] Override http request option.
|
|
39
|
-
* @throws {RequiredError}
|
|
40
|
-
*/
|
|
41
|
-
deleteChangelogConfiguration: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
|
-
/**
|
|
43
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
33
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
44
34
|
* @summary Retrieve the changelog configuration
|
|
45
35
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
46
36
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -49,22 +39,7 @@ export declare const ChangelogConfigurationsApiAxiosParamCreator: (configuration
|
|
|
49
39
|
*/
|
|
50
40
|
getChangelogConfiguration: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
51
41
|
/**
|
|
52
|
-
*
|
|
53
|
-
* @summary List changelog configurations
|
|
54
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
55
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
56
|
-
* @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.
|
|
57
|
-
* @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>
|
|
58
|
-
* @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>
|
|
59
|
-
* @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>
|
|
60
|
-
* @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/>
|
|
61
|
-
* @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>
|
|
62
|
-
* @param {*} [options] Override http request option.
|
|
63
|
-
* @throws {RequiredError}
|
|
64
|
-
*/
|
|
65
|
-
listChangelogConfigurations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
66
|
-
/**
|
|
67
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
42
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
68
43
|
* @summary Update the changelog configuration
|
|
69
44
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
70
45
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -80,7 +55,7 @@ export declare const ChangelogConfigurationsApiAxiosParamCreator: (configuration
|
|
|
80
55
|
*/
|
|
81
56
|
export declare const ChangelogConfigurationsApiFp: (configuration?: Configuration) => {
|
|
82
57
|
/**
|
|
83
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
58
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
84
59
|
* @summary Create the changelog configuration
|
|
85
60
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
86
61
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -89,16 +64,7 @@ export declare const ChangelogConfigurationsApiFp: (configuration?: Configuratio
|
|
|
89
64
|
*/
|
|
90
65
|
createChangelogConfiguration(createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>>;
|
|
91
66
|
/**
|
|
92
|
-
*
|
|
93
|
-
* @summary Delete the changelog configuration
|
|
94
|
-
* @param {string} code Unique identifier code for the changelog configuration
|
|
95
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
96
|
-
* @param {*} [options] Override http request option.
|
|
97
|
-
* @throws {RequiredError}
|
|
98
|
-
*/
|
|
99
|
-
deleteChangelogConfiguration(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
100
|
-
/**
|
|
101
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
67
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
102
68
|
* @summary Retrieve the changelog configuration
|
|
103
69
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
104
70
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -107,22 +73,7 @@ export declare const ChangelogConfigurationsApiFp: (configuration?: Configuratio
|
|
|
107
73
|
*/
|
|
108
74
|
getChangelogConfiguration(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>>;
|
|
109
75
|
/**
|
|
110
|
-
*
|
|
111
|
-
* @summary List changelog configurations
|
|
112
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
113
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
114
|
-
* @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.
|
|
115
|
-
* @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>
|
|
116
|
-
* @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>
|
|
117
|
-
* @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>
|
|
118
|
-
* @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/>
|
|
119
|
-
* @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>
|
|
120
|
-
* @param {*} [options] Override http request option.
|
|
121
|
-
* @throws {RequiredError}
|
|
122
|
-
*/
|
|
123
|
-
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>>;
|
|
124
|
-
/**
|
|
125
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
76
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
126
77
|
* @summary Update the changelog configuration
|
|
127
78
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
128
79
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -138,7 +89,7 @@ export declare const ChangelogConfigurationsApiFp: (configuration?: Configuratio
|
|
|
138
89
|
*/
|
|
139
90
|
export declare const ChangelogConfigurationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
140
91
|
/**
|
|
141
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
92
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
142
93
|
* @summary Create the changelog configuration
|
|
143
94
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
144
95
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -147,16 +98,7 @@ export declare const ChangelogConfigurationsApiFactory: (configuration?: Configu
|
|
|
147
98
|
*/
|
|
148
99
|
createChangelogConfiguration(createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass>;
|
|
149
100
|
/**
|
|
150
|
-
*
|
|
151
|
-
* @summary Delete the changelog configuration
|
|
152
|
-
* @param {string} code Unique identifier code for the changelog configuration
|
|
153
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
154
|
-
* @param {*} [options] Override http request option.
|
|
155
|
-
* @throws {RequiredError}
|
|
156
|
-
*/
|
|
157
|
-
deleteChangelogConfiguration(code: string, authorization?: string, options?: any): AxiosPromise<void>;
|
|
158
|
-
/**
|
|
159
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
101
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
160
102
|
* @summary Retrieve the changelog configuration
|
|
161
103
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
162
104
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -165,22 +107,7 @@ export declare const ChangelogConfigurationsApiFactory: (configuration?: Configu
|
|
|
165
107
|
*/
|
|
166
108
|
getChangelogConfiguration(code: string, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass>;
|
|
167
109
|
/**
|
|
168
|
-
*
|
|
169
|
-
* @summary List changelog configurations
|
|
170
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
171
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
172
|
-
* @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.
|
|
173
|
-
* @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>
|
|
174
|
-
* @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>
|
|
175
|
-
* @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>
|
|
176
|
-
* @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/>
|
|
177
|
-
* @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>
|
|
178
|
-
* @param {*} [options] Override http request option.
|
|
179
|
-
* @throws {RequiredError}
|
|
180
|
-
*/
|
|
181
|
-
listChangelogConfigurations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogConfigurationsResponseClass>;
|
|
182
|
-
/**
|
|
183
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
110
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
184
111
|
* @summary Update the changelog configuration
|
|
185
112
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
186
113
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -209,25 +136,6 @@ export interface ChangelogConfigurationsApiCreateChangelogConfigurationRequest {
|
|
|
209
136
|
*/
|
|
210
137
|
readonly authorization?: string;
|
|
211
138
|
}
|
|
212
|
-
/**
|
|
213
|
-
* Request parameters for deleteChangelogConfiguration operation in ChangelogConfigurationsApi.
|
|
214
|
-
* @export
|
|
215
|
-
* @interface ChangelogConfigurationsApiDeleteChangelogConfigurationRequest
|
|
216
|
-
*/
|
|
217
|
-
export interface ChangelogConfigurationsApiDeleteChangelogConfigurationRequest {
|
|
218
|
-
/**
|
|
219
|
-
* Unique identifier code for the changelog configuration
|
|
220
|
-
* @type {string}
|
|
221
|
-
* @memberof ChangelogConfigurationsApiDeleteChangelogConfiguration
|
|
222
|
-
*/
|
|
223
|
-
readonly code: string;
|
|
224
|
-
/**
|
|
225
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
226
|
-
* @type {string}
|
|
227
|
-
* @memberof ChangelogConfigurationsApiDeleteChangelogConfiguration
|
|
228
|
-
*/
|
|
229
|
-
readonly authorization?: string;
|
|
230
|
-
}
|
|
231
139
|
/**
|
|
232
140
|
* Request parameters for getChangelogConfiguration operation in ChangelogConfigurationsApi.
|
|
233
141
|
* @export
|
|
@@ -247,61 +155,6 @@ export interface ChangelogConfigurationsApiGetChangelogConfigurationRequest {
|
|
|
247
155
|
*/
|
|
248
156
|
readonly authorization?: string;
|
|
249
157
|
}
|
|
250
|
-
/**
|
|
251
|
-
* Request parameters for listChangelogConfigurations operation in ChangelogConfigurationsApi.
|
|
252
|
-
* @export
|
|
253
|
-
* @interface ChangelogConfigurationsApiListChangelogConfigurationsRequest
|
|
254
|
-
*/
|
|
255
|
-
export interface ChangelogConfigurationsApiListChangelogConfigurationsRequest {
|
|
256
|
-
/**
|
|
257
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
258
|
-
* @type {string}
|
|
259
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
260
|
-
*/
|
|
261
|
-
readonly authorization?: string;
|
|
262
|
-
/**
|
|
263
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
264
|
-
* @type {number}
|
|
265
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
266
|
-
*/
|
|
267
|
-
readonly pageSize?: number;
|
|
268
|
-
/**
|
|
269
|
-
* 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.
|
|
270
|
-
* @type {string}
|
|
271
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
272
|
-
*/
|
|
273
|
-
readonly pageToken?: string;
|
|
274
|
-
/**
|
|
275
|
-
* 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>
|
|
276
|
-
* @type {string}
|
|
277
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
278
|
-
*/
|
|
279
|
-
readonly filter?: string;
|
|
280
|
-
/**
|
|
281
|
-
* 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>
|
|
282
|
-
* @type {string}
|
|
283
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
284
|
-
*/
|
|
285
|
-
readonly search?: string;
|
|
286
|
-
/**
|
|
287
|
-
* 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>
|
|
288
|
-
* @type {string}
|
|
289
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
290
|
-
*/
|
|
291
|
-
readonly order?: string;
|
|
292
|
-
/**
|
|
293
|
-
* 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/>
|
|
294
|
-
* @type {string}
|
|
295
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
296
|
-
*/
|
|
297
|
-
readonly expand?: string;
|
|
298
|
-
/**
|
|
299
|
-
* 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>
|
|
300
|
-
* @type {string}
|
|
301
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
302
|
-
*/
|
|
303
|
-
readonly filters?: string;
|
|
304
|
-
}
|
|
305
158
|
/**
|
|
306
159
|
* Request parameters for updateChangelogConfiguration operation in ChangelogConfigurationsApi.
|
|
307
160
|
* @export
|
|
@@ -335,7 +188,7 @@ export interface ChangelogConfigurationsApiUpdateChangelogConfigurationRequest {
|
|
|
335
188
|
*/
|
|
336
189
|
export declare class ChangelogConfigurationsApi extends BaseAPI {
|
|
337
190
|
/**
|
|
338
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
191
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
339
192
|
* @summary Create the changelog configuration
|
|
340
193
|
* @param {ChangelogConfigurationsApiCreateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
341
194
|
* @param {*} [options] Override http request option.
|
|
@@ -344,16 +197,7 @@ export declare class ChangelogConfigurationsApi extends BaseAPI {
|
|
|
344
197
|
*/
|
|
345
198
|
createChangelogConfiguration(requestParameters: ChangelogConfigurationsApiCreateChangelogConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangelogConfigurationResponseClass, any, {}>>;
|
|
346
199
|
/**
|
|
347
|
-
*
|
|
348
|
-
* @summary Delete the changelog configuration
|
|
349
|
-
* @param {ChangelogConfigurationsApiDeleteChangelogConfigurationRequest} requestParameters Request parameters.
|
|
350
|
-
* @param {*} [options] Override http request option.
|
|
351
|
-
* @throws {RequiredError}
|
|
352
|
-
* @memberof ChangelogConfigurationsApi
|
|
353
|
-
*/
|
|
354
|
-
deleteChangelogConfiguration(requestParameters: ChangelogConfigurationsApiDeleteChangelogConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
355
|
-
/**
|
|
356
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
200
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
357
201
|
* @summary Retrieve the changelog configuration
|
|
358
202
|
* @param {ChangelogConfigurationsApiGetChangelogConfigurationRequest} requestParameters Request parameters.
|
|
359
203
|
* @param {*} [options] Override http request option.
|
|
@@ -362,16 +206,7 @@ export declare class ChangelogConfigurationsApi extends BaseAPI {
|
|
|
362
206
|
*/
|
|
363
207
|
getChangelogConfiguration(requestParameters: ChangelogConfigurationsApiGetChangelogConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangelogConfigurationResponseClass, any, {}>>;
|
|
364
208
|
/**
|
|
365
|
-
*
|
|
366
|
-
* @summary List changelog configurations
|
|
367
|
-
* @param {ChangelogConfigurationsApiListChangelogConfigurationsRequest} requestParameters Request parameters.
|
|
368
|
-
* @param {*} [options] Override http request option.
|
|
369
|
-
* @throws {RequiredError}
|
|
370
|
-
* @memberof ChangelogConfigurationsApi
|
|
371
|
-
*/
|
|
372
|
-
listChangelogConfigurations(requestParameters?: ChangelogConfigurationsApiListChangelogConfigurationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListChangelogConfigurationsResponseClass, any, {}>>;
|
|
373
|
-
/**
|
|
374
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
209
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
375
210
|
* @summary Update the changelog configuration
|
|
376
211
|
* @param {ChangelogConfigurationsApiUpdateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
377
212
|
* @param {*} [options] Override http request option.
|
|
@@ -93,7 +93,7 @@ var ChangelogConfigurationsApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
96
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
97
97
|
* @summary Create the changelog configuration
|
|
98
98
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
99
99
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -142,55 +142,7 @@ var ChangelogConfigurationsApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
*
|
|
146
|
-
* @summary Delete the changelog configuration
|
|
147
|
-
* @param {string} code Unique identifier code for the changelog configuration
|
|
148
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
149
|
-
* @param {*} [options] Override http request option.
|
|
150
|
-
* @throws {RequiredError}
|
|
151
|
-
*/
|
|
152
|
-
deleteChangelogConfiguration: function (code, authorization, options) {
|
|
153
|
-
if (options === void 0) { options = {}; }
|
|
154
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
155
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
156
|
-
return __generator(this, function (_a) {
|
|
157
|
-
switch (_a.label) {
|
|
158
|
-
case 0:
|
|
159
|
-
// verify required parameter 'code' is not null or undefined
|
|
160
|
-
(0, common_1.assertParamExists)('deleteChangelogConfiguration', 'code', code);
|
|
161
|
-
localVarPath = "/changelogservice/v1/changelog-configurations/{code}"
|
|
162
|
-
.replace("{".concat("code", "}"), encodeURIComponent(String(code)));
|
|
163
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
164
|
-
if (configuration) {
|
|
165
|
-
baseOptions = configuration.baseOptions;
|
|
166
|
-
baseAccessToken = configuration.accessToken;
|
|
167
|
-
}
|
|
168
|
-
localVarRequestOptions = __assign(__assign({ method: 'DELETE' }, baseOptions), options);
|
|
169
|
-
localVarHeaderParameter = {};
|
|
170
|
-
localVarQueryParameter = {};
|
|
171
|
-
// authentication bearer required
|
|
172
|
-
// http bearer authentication required
|
|
173
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
174
|
-
case 1:
|
|
175
|
-
// authentication bearer required
|
|
176
|
-
// http bearer authentication required
|
|
177
|
-
_a.sent();
|
|
178
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
179
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
180
|
-
}
|
|
181
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
182
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
183
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
184
|
-
return [2 /*return*/, {
|
|
185
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
186
|
-
options: localVarRequestOptions,
|
|
187
|
-
}];
|
|
188
|
-
}
|
|
189
|
-
});
|
|
190
|
-
});
|
|
191
|
-
},
|
|
192
|
-
/**
|
|
193
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
145
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
194
146
|
* @summary Retrieve the changelog configuration
|
|
195
147
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
196
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -238,79 +190,7 @@ var ChangelogConfigurationsApiAxiosParamCreator = function (configuration) {
|
|
|
238
190
|
});
|
|
239
191
|
},
|
|
240
192
|
/**
|
|
241
|
-
*
|
|
242
|
-
* @summary List changelog configurations
|
|
243
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
244
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
245
|
-
* @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.
|
|
246
|
-
* @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>
|
|
247
|
-
* @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>
|
|
248
|
-
* @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>
|
|
249
|
-
* @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/>
|
|
250
|
-
* @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>
|
|
251
|
-
* @param {*} [options] Override http request option.
|
|
252
|
-
* @throws {RequiredError}
|
|
253
|
-
*/
|
|
254
|
-
listChangelogConfigurations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
255
|
-
if (options === void 0) { options = {}; }
|
|
256
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
257
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
258
|
-
return __generator(this, function (_a) {
|
|
259
|
-
switch (_a.label) {
|
|
260
|
-
case 0:
|
|
261
|
-
localVarPath = "/changelogservice/v1/changelog-configurations";
|
|
262
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
263
|
-
if (configuration) {
|
|
264
|
-
baseOptions = configuration.baseOptions;
|
|
265
|
-
baseAccessToken = configuration.accessToken;
|
|
266
|
-
}
|
|
267
|
-
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
268
|
-
localVarHeaderParameter = {};
|
|
269
|
-
localVarQueryParameter = {};
|
|
270
|
-
// authentication bearer required
|
|
271
|
-
// http bearer authentication required
|
|
272
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
273
|
-
case 1:
|
|
274
|
-
// authentication bearer required
|
|
275
|
-
// http bearer authentication required
|
|
276
|
-
_a.sent();
|
|
277
|
-
if (pageSize !== undefined) {
|
|
278
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
279
|
-
}
|
|
280
|
-
if (pageToken !== undefined) {
|
|
281
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
282
|
-
}
|
|
283
|
-
if (filter !== undefined) {
|
|
284
|
-
localVarQueryParameter['filter'] = filter;
|
|
285
|
-
}
|
|
286
|
-
if (search !== undefined) {
|
|
287
|
-
localVarQueryParameter['search'] = search;
|
|
288
|
-
}
|
|
289
|
-
if (order !== undefined) {
|
|
290
|
-
localVarQueryParameter['order'] = order;
|
|
291
|
-
}
|
|
292
|
-
if (expand !== undefined) {
|
|
293
|
-
localVarQueryParameter['expand'] = expand;
|
|
294
|
-
}
|
|
295
|
-
if (filters !== undefined) {
|
|
296
|
-
localVarQueryParameter['filters'] = filters;
|
|
297
|
-
}
|
|
298
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
299
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
300
|
-
}
|
|
301
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
302
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
303
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
304
|
-
return [2 /*return*/, {
|
|
305
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
306
|
-
options: localVarRequestOptions,
|
|
307
|
-
}];
|
|
308
|
-
}
|
|
309
|
-
});
|
|
310
|
-
});
|
|
311
|
-
},
|
|
312
|
-
/**
|
|
313
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
193
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
314
194
|
* @summary Update the changelog configuration
|
|
315
195
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
316
196
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -373,7 +253,7 @@ var ChangelogConfigurationsApiFp = function (configuration) {
|
|
|
373
253
|
var localVarAxiosParamCreator = (0, exports.ChangelogConfigurationsApiAxiosParamCreator)(configuration);
|
|
374
254
|
return {
|
|
375
255
|
/**
|
|
376
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
256
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
377
257
|
* @summary Create the changelog configuration
|
|
378
258
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
379
259
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -394,28 +274,7 @@ var ChangelogConfigurationsApiFp = function (configuration) {
|
|
|
394
274
|
});
|
|
395
275
|
},
|
|
396
276
|
/**
|
|
397
|
-
*
|
|
398
|
-
* @summary Delete the changelog configuration
|
|
399
|
-
* @param {string} code Unique identifier code for the changelog configuration
|
|
400
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
401
|
-
* @param {*} [options] Override http request option.
|
|
402
|
-
* @throws {RequiredError}
|
|
403
|
-
*/
|
|
404
|
-
deleteChangelogConfiguration: function (code, authorization, options) {
|
|
405
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
406
|
-
var localVarAxiosArgs;
|
|
407
|
-
return __generator(this, function (_a) {
|
|
408
|
-
switch (_a.label) {
|
|
409
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.deleteChangelogConfiguration(code, authorization, options)];
|
|
410
|
-
case 1:
|
|
411
|
-
localVarAxiosArgs = _a.sent();
|
|
412
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
413
|
-
}
|
|
414
|
-
});
|
|
415
|
-
});
|
|
416
|
-
},
|
|
417
|
-
/**
|
|
418
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
277
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
419
278
|
* @summary Retrieve the changelog configuration
|
|
420
279
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
421
280
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -436,34 +295,7 @@ var ChangelogConfigurationsApiFp = function (configuration) {
|
|
|
436
295
|
});
|
|
437
296
|
},
|
|
438
297
|
/**
|
|
439
|
-
*
|
|
440
|
-
* @summary List changelog configurations
|
|
441
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
442
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
443
|
-
* @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.
|
|
444
|
-
* @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>
|
|
445
|
-
* @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>
|
|
446
|
-
* @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>
|
|
447
|
-
* @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/>
|
|
448
|
-
* @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>
|
|
449
|
-
* @param {*} [options] Override http request option.
|
|
450
|
-
* @throws {RequiredError}
|
|
451
|
-
*/
|
|
452
|
-
listChangelogConfigurations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
453
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
454
|
-
var localVarAxiosArgs;
|
|
455
|
-
return __generator(this, function (_a) {
|
|
456
|
-
switch (_a.label) {
|
|
457
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
458
|
-
case 1:
|
|
459
|
-
localVarAxiosArgs = _a.sent();
|
|
460
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
461
|
-
}
|
|
462
|
-
});
|
|
463
|
-
});
|
|
464
|
-
},
|
|
465
|
-
/**
|
|
466
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
298
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
467
299
|
* @summary Update the changelog configuration
|
|
468
300
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
469
301
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -495,7 +327,7 @@ var ChangelogConfigurationsApiFactory = function (configuration, basePath, axios
|
|
|
495
327
|
var localVarFp = (0, exports.ChangelogConfigurationsApiFp)(configuration);
|
|
496
328
|
return {
|
|
497
329
|
/**
|
|
498
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
330
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
499
331
|
* @summary Create the changelog configuration
|
|
500
332
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
501
333
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -506,18 +338,7 @@ var ChangelogConfigurationsApiFactory = function (configuration, basePath, axios
|
|
|
506
338
|
return localVarFp.createChangelogConfiguration(createChangelogConfigurationDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
507
339
|
},
|
|
508
340
|
/**
|
|
509
|
-
*
|
|
510
|
-
* @summary Delete the changelog configuration
|
|
511
|
-
* @param {string} code Unique identifier code for the changelog configuration
|
|
512
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
513
|
-
* @param {*} [options] Override http request option.
|
|
514
|
-
* @throws {RequiredError}
|
|
515
|
-
*/
|
|
516
|
-
deleteChangelogConfiguration: function (code, authorization, options) {
|
|
517
|
-
return localVarFp.deleteChangelogConfiguration(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
518
|
-
},
|
|
519
|
-
/**
|
|
520
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
341
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
521
342
|
* @summary Retrieve the changelog configuration
|
|
522
343
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
523
344
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -528,24 +349,7 @@ var ChangelogConfigurationsApiFactory = function (configuration, basePath, axios
|
|
|
528
349
|
return localVarFp.getChangelogConfiguration(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
529
350
|
},
|
|
530
351
|
/**
|
|
531
|
-
*
|
|
532
|
-
* @summary List changelog configurations
|
|
533
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
534
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
535
|
-
* @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.
|
|
536
|
-
* @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>
|
|
537
|
-
* @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>
|
|
538
|
-
* @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>
|
|
539
|
-
* @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/>
|
|
540
|
-
* @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>
|
|
541
|
-
* @param {*} [options] Override http request option.
|
|
542
|
-
* @throws {RequiredError}
|
|
543
|
-
*/
|
|
544
|
-
listChangelogConfigurations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
545
|
-
return localVarFp.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
546
|
-
},
|
|
547
|
-
/**
|
|
548
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
352
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
549
353
|
* @summary Update the changelog configuration
|
|
550
354
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
551
355
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -571,7 +375,7 @@ var ChangelogConfigurationsApi = /** @class */ (function (_super) {
|
|
|
571
375
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
572
376
|
}
|
|
573
377
|
/**
|
|
574
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
378
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
575
379
|
* @summary Create the changelog configuration
|
|
576
380
|
* @param {ChangelogConfigurationsApiCreateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
577
381
|
* @param {*} [options] Override http request option.
|
|
@@ -583,19 +387,7 @@ var ChangelogConfigurationsApi = /** @class */ (function (_super) {
|
|
|
583
387
|
return (0, exports.ChangelogConfigurationsApiFp)(this.configuration).createChangelogConfiguration(requestParameters.createChangelogConfigurationDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
584
388
|
};
|
|
585
389
|
/**
|
|
586
|
-
*
|
|
587
|
-
* @summary Delete the changelog configuration
|
|
588
|
-
* @param {ChangelogConfigurationsApiDeleteChangelogConfigurationRequest} requestParameters Request parameters.
|
|
589
|
-
* @param {*} [options] Override http request option.
|
|
590
|
-
* @throws {RequiredError}
|
|
591
|
-
* @memberof ChangelogConfigurationsApi
|
|
592
|
-
*/
|
|
593
|
-
ChangelogConfigurationsApi.prototype.deleteChangelogConfiguration = function (requestParameters, options) {
|
|
594
|
-
var _this = this;
|
|
595
|
-
return (0, exports.ChangelogConfigurationsApiFp)(this.configuration).deleteChangelogConfiguration(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
596
|
-
};
|
|
597
|
-
/**
|
|
598
|
-
* Retrieves a changelog configuration by its code **Required Permissions** \"changelog-management.changelog-configurations.view\"
|
|
390
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
599
391
|
* @summary Retrieve the changelog configuration
|
|
600
392
|
* @param {ChangelogConfigurationsApiGetChangelogConfigurationRequest} requestParameters Request parameters.
|
|
601
393
|
* @param {*} [options] Override http request option.
|
|
@@ -607,20 +399,7 @@ var ChangelogConfigurationsApi = /** @class */ (function (_super) {
|
|
|
607
399
|
return (0, exports.ChangelogConfigurationsApiFp)(this.configuration).getChangelogConfiguration(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
608
400
|
};
|
|
609
401
|
/**
|
|
610
|
-
*
|
|
611
|
-
* @summary List changelog configurations
|
|
612
|
-
* @param {ChangelogConfigurationsApiListChangelogConfigurationsRequest} requestParameters Request parameters.
|
|
613
|
-
* @param {*} [options] Override http request option.
|
|
614
|
-
* @throws {RequiredError}
|
|
615
|
-
* @memberof ChangelogConfigurationsApi
|
|
616
|
-
*/
|
|
617
|
-
ChangelogConfigurationsApi.prototype.listChangelogConfigurations = function (requestParameters, options) {
|
|
618
|
-
var _this = this;
|
|
619
|
-
if (requestParameters === void 0) { requestParameters = {}; }
|
|
620
|
-
return (0, exports.ChangelogConfigurationsApiFp)(this.configuration).listChangelogConfigurations(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); });
|
|
621
|
-
};
|
|
622
|
-
/**
|
|
623
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
402
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
624
403
|
* @summary Update the changelog configuration
|
|
625
404
|
* @param {ChangelogConfigurationsApiUpdateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
626
405
|
* @param {*} [options] Override http request option.
|