@emilgroup/changelog-sdk 1.0.1-beta.14 → 1.0.1-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +0 -9
- package/README.md +2 -2
- package/api/changelog-configurations-api.ts +12 -200
- package/api/changelog-events-api.ts +20 -221
- package/dist/api/changelog-configurations-api.d.ts +12 -122
- package/dist/api/changelog-configurations-api.js +12 -141
- package/dist/api/changelog-events-api.d.ts +20 -139
- package/dist/api/changelog-events-api.js +17 -151
- package/dist/models/changelog-config-field-class.d.ts +0 -36
- package/dist/models/changelog-config-field-class.js +0 -6
- package/dist/models/changelog-configuration-class.d.ts +0 -12
- package/dist/models/create-changelog-configuration-dto.d.ts +3 -9
- package/dist/models/index.d.ts +0 -9
- package/dist/models/index.js +0 -9
- package/dist/models/update-changelog-configuration-dto.d.ts +3 -3
- package/models/changelog-config-field-class.ts +0 -39
- package/models/changelog-configuration-class.ts +0 -12
- package/models/create-changelog-configuration-dto.ts +3 -9
- package/models/index.ts +0 -9
- package/models/update-changelog-configuration-dto.ts +3 -3
- package/package.json +1 -1
- package/dist/models/changelog-config-field-dto.d.ts +0 -74
- package/dist/models/changelog-config-field-dto.js +0 -21
- package/dist/models/changelog-config-section-dto.d.ts +0 -43
- package/dist/models/changelog-config-section-dto.js +0 -15
- package/dist/models/composite-source-dto.d.ts +0 -30
- package/dist/models/composite-source-dto.js +0 -15
- package/dist/models/formatted-changelog-event.d.ts +0 -67
- package/dist/models/formatted-changelog-event.js +0 -15
- package/dist/models/formatted-field-entry.d.ts +0 -48
- package/dist/models/formatted-field-entry.js +0 -15
- package/dist/models/formatted-section.d.ts +0 -43
- package/dist/models/formatted-section.js +0 -15
- package/dist/models/json-sub-field-dto.d.ts +0 -36
- package/dist/models/json-sub-field-dto.js +0 -15
- package/dist/models/list-changelog-configurations-response-class.d.ts +0 -43
- package/dist/models/list-changelog-configurations-response-class.js +0 -15
- package/dist/models/list-formatted-changelog-events-response-class.d.ts +0 -43
- package/dist/models/list-formatted-changelog-events-response-class.js +0 -15
- package/models/changelog-config-field-dto.ts +0 -83
- package/models/changelog-config-section-dto.ts +0 -49
- package/models/composite-source-dto.ts +0 -36
- package/models/formatted-changelog-event.ts +0 -73
- package/models/formatted-field-entry.ts +0 -54
- package/models/formatted-section.ts +0 -49
- package/models/json-sub-field-dto.ts +0 -42
- package/models/list-changelog-configurations-response-class.ts +0 -49
- package/models/list-formatted-changelog-events-response-class.ts +0 -49
|
@@ -14,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,7 +30,7 @@ export declare const ChangelogConfigurationsApiAxiosParamCreator: (configuration
|
|
|
31
30
|
*/
|
|
32
31
|
createChangelogConfiguration: (createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33
32
|
/**
|
|
34
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
33
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
35
34
|
* @summary Retrieve the changelog configuration
|
|
36
35
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
37
36
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -40,22 +39,7 @@ export declare const ChangelogConfigurationsApiAxiosParamCreator: (configuration
|
|
|
40
39
|
*/
|
|
41
40
|
getChangelogConfiguration: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42
41
|
/**
|
|
43
|
-
*
|
|
44
|
-
* @summary List changelog configurations
|
|
45
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
46
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
47
|
-
* @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.
|
|
48
|
-
* @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>
|
|
49
|
-
* @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>
|
|
50
|
-
* @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>
|
|
51
|
-
* @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/>
|
|
52
|
-
* @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>
|
|
53
|
-
* @param {*} [options] Override http request option.
|
|
54
|
-
* @throws {RequiredError}
|
|
55
|
-
*/
|
|
56
|
-
listChangelogConfigurations: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57
|
-
/**
|
|
58
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
42
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
59
43
|
* @summary Update the changelog configuration
|
|
60
44
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
61
45
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -71,7 +55,7 @@ export declare const ChangelogConfigurationsApiAxiosParamCreator: (configuration
|
|
|
71
55
|
*/
|
|
72
56
|
export declare const ChangelogConfigurationsApiFp: (configuration?: Configuration) => {
|
|
73
57
|
/**
|
|
74
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
58
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
75
59
|
* @summary Create the changelog configuration
|
|
76
60
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
77
61
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -80,7 +64,7 @@ export declare const ChangelogConfigurationsApiFp: (configuration?: Configuratio
|
|
|
80
64
|
*/
|
|
81
65
|
createChangelogConfiguration(createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>>;
|
|
82
66
|
/**
|
|
83
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
67
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
84
68
|
* @summary Retrieve the changelog configuration
|
|
85
69
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
86
70
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -89,22 +73,7 @@ export declare const ChangelogConfigurationsApiFp: (configuration?: Configuratio
|
|
|
89
73
|
*/
|
|
90
74
|
getChangelogConfiguration(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogConfigurationResponseClass>>;
|
|
91
75
|
/**
|
|
92
|
-
*
|
|
93
|
-
* @summary List changelog configurations
|
|
94
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
95
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
96
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
97
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
98
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, slug, entityType</i>
|
|
99
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
100
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
101
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
102
|
-
* @param {*} [options] Override http request option.
|
|
103
|
-
* @throws {RequiredError}
|
|
104
|
-
*/
|
|
105
|
-
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>>;
|
|
106
|
-
/**
|
|
107
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
76
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
108
77
|
* @summary Update the changelog configuration
|
|
109
78
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
110
79
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -120,7 +89,7 @@ export declare const ChangelogConfigurationsApiFp: (configuration?: Configuratio
|
|
|
120
89
|
*/
|
|
121
90
|
export declare const ChangelogConfigurationsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
122
91
|
/**
|
|
123
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
92
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
124
93
|
* @summary Create the changelog configuration
|
|
125
94
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
126
95
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -129,7 +98,7 @@ export declare const ChangelogConfigurationsApiFactory: (configuration?: Configu
|
|
|
129
98
|
*/
|
|
130
99
|
createChangelogConfiguration(createChangelogConfigurationDto: CreateChangelogConfigurationDto, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass>;
|
|
131
100
|
/**
|
|
132
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
101
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
133
102
|
* @summary Retrieve the changelog configuration
|
|
134
103
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
135
104
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -138,22 +107,7 @@ export declare const ChangelogConfigurationsApiFactory: (configuration?: Configu
|
|
|
138
107
|
*/
|
|
139
108
|
getChangelogConfiguration(code: string, authorization?: string, options?: any): AxiosPromise<GetChangelogConfigurationResponseClass>;
|
|
140
109
|
/**
|
|
141
|
-
*
|
|
142
|
-
* @summary List changelog configurations
|
|
143
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
144
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
145
|
-
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
146
|
-
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
147
|
-
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, slug, entityType</i>
|
|
148
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
149
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
150
|
-
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, slug, entityType, createdAt, updatedAt</i>
|
|
151
|
-
* @param {*} [options] Override http request option.
|
|
152
|
-
* @throws {RequiredError}
|
|
153
|
-
*/
|
|
154
|
-
listChangelogConfigurations(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogConfigurationsResponseClass>;
|
|
155
|
-
/**
|
|
156
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
110
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
157
111
|
* @summary Update the changelog configuration
|
|
158
112
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
159
113
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -201,61 +155,6 @@ export interface ChangelogConfigurationsApiGetChangelogConfigurationRequest {
|
|
|
201
155
|
*/
|
|
202
156
|
readonly authorization?: string;
|
|
203
157
|
}
|
|
204
|
-
/**
|
|
205
|
-
* Request parameters for listChangelogConfigurations operation in ChangelogConfigurationsApi.
|
|
206
|
-
* @export
|
|
207
|
-
* @interface ChangelogConfigurationsApiListChangelogConfigurationsRequest
|
|
208
|
-
*/
|
|
209
|
-
export interface ChangelogConfigurationsApiListChangelogConfigurationsRequest {
|
|
210
|
-
/**
|
|
211
|
-
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
212
|
-
* @type {string}
|
|
213
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
214
|
-
*/
|
|
215
|
-
readonly authorization?: string;
|
|
216
|
-
/**
|
|
217
|
-
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
218
|
-
* @type {number}
|
|
219
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
220
|
-
*/
|
|
221
|
-
readonly pageSize?: number;
|
|
222
|
-
/**
|
|
223
|
-
* 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.
|
|
224
|
-
* @type {string}
|
|
225
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
226
|
-
*/
|
|
227
|
-
readonly pageToken?: string;
|
|
228
|
-
/**
|
|
229
|
-
* 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>
|
|
230
|
-
* @type {string}
|
|
231
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
232
|
-
*/
|
|
233
|
-
readonly filter?: string;
|
|
234
|
-
/**
|
|
235
|
-
* 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>
|
|
236
|
-
* @type {string}
|
|
237
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
238
|
-
*/
|
|
239
|
-
readonly search?: string;
|
|
240
|
-
/**
|
|
241
|
-
* 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>
|
|
242
|
-
* @type {string}
|
|
243
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
244
|
-
*/
|
|
245
|
-
readonly order?: string;
|
|
246
|
-
/**
|
|
247
|
-
* 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/>
|
|
248
|
-
* @type {string}
|
|
249
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
250
|
-
*/
|
|
251
|
-
readonly expand?: string;
|
|
252
|
-
/**
|
|
253
|
-
* 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>
|
|
254
|
-
* @type {string}
|
|
255
|
-
* @memberof ChangelogConfigurationsApiListChangelogConfigurations
|
|
256
|
-
*/
|
|
257
|
-
readonly filters?: string;
|
|
258
|
-
}
|
|
259
158
|
/**
|
|
260
159
|
* Request parameters for updateChangelogConfiguration operation in ChangelogConfigurationsApi.
|
|
261
160
|
* @export
|
|
@@ -289,7 +188,7 @@ export interface ChangelogConfigurationsApiUpdateChangelogConfigurationRequest {
|
|
|
289
188
|
*/
|
|
290
189
|
export declare class ChangelogConfigurationsApi extends BaseAPI {
|
|
291
190
|
/**
|
|
292
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
191
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
293
192
|
* @summary Create the changelog configuration
|
|
294
193
|
* @param {ChangelogConfigurationsApiCreateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
295
194
|
* @param {*} [options] Override http request option.
|
|
@@ -298,7 +197,7 @@ export declare class ChangelogConfigurationsApi extends BaseAPI {
|
|
|
298
197
|
*/
|
|
299
198
|
createChangelogConfiguration(requestParameters: ChangelogConfigurationsApiCreateChangelogConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangelogConfigurationResponseClass, any, {}>>;
|
|
300
199
|
/**
|
|
301
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
200
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
302
201
|
* @summary Retrieve the changelog configuration
|
|
303
202
|
* @param {ChangelogConfigurationsApiGetChangelogConfigurationRequest} requestParameters Request parameters.
|
|
304
203
|
* @param {*} [options] Override http request option.
|
|
@@ -307,16 +206,7 @@ export declare class ChangelogConfigurationsApi extends BaseAPI {
|
|
|
307
206
|
*/
|
|
308
207
|
getChangelogConfiguration(requestParameters: ChangelogConfigurationsApiGetChangelogConfigurationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetChangelogConfigurationResponseClass, any, {}>>;
|
|
309
208
|
/**
|
|
310
|
-
*
|
|
311
|
-
* @summary List changelog configurations
|
|
312
|
-
* @param {ChangelogConfigurationsApiListChangelogConfigurationsRequest} requestParameters Request parameters.
|
|
313
|
-
* @param {*} [options] Override http request option.
|
|
314
|
-
* @throws {RequiredError}
|
|
315
|
-
* @memberof ChangelogConfigurationsApi
|
|
316
|
-
*/
|
|
317
|
-
listChangelogConfigurations(requestParameters?: ChangelogConfigurationsApiListChangelogConfigurationsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListChangelogConfigurationsResponseClass, any, {}>>;
|
|
318
|
-
/**
|
|
319
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
209
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
320
210
|
* @summary Update the changelog configuration
|
|
321
211
|
* @param {ChangelogConfigurationsApiUpdateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
322
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,7 +142,7 @@ var ChangelogConfigurationsApiAxiosParamCreator = function (configuration) {
|
|
|
142
142
|
});
|
|
143
143
|
},
|
|
144
144
|
/**
|
|
145
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
145
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
146
146
|
* @summary Retrieve the changelog configuration
|
|
147
147
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
148
148
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -190,79 +190,7 @@ var ChangelogConfigurationsApiAxiosParamCreator = function (configuration) {
|
|
|
190
190
|
});
|
|
191
191
|
},
|
|
192
192
|
/**
|
|
193
|
-
*
|
|
194
|
-
* @summary List changelog configurations
|
|
195
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
196
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
197
|
-
* @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.
|
|
198
|
-
* @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>
|
|
199
|
-
* @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>
|
|
200
|
-
* @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>
|
|
201
|
-
* @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/>
|
|
202
|
-
* @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>
|
|
203
|
-
* @param {*} [options] Override http request option.
|
|
204
|
-
* @throws {RequiredError}
|
|
205
|
-
*/
|
|
206
|
-
listChangelogConfigurations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
207
|
-
if (options === void 0) { options = {}; }
|
|
208
|
-
return __awaiter(_this, void 0, void 0, function () {
|
|
209
|
-
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
210
|
-
return __generator(this, function (_a) {
|
|
211
|
-
switch (_a.label) {
|
|
212
|
-
case 0:
|
|
213
|
-
localVarPath = "/changelogservice/v1/changelog-configurations";
|
|
214
|
-
localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
215
|
-
if (configuration) {
|
|
216
|
-
baseOptions = configuration.baseOptions;
|
|
217
|
-
baseAccessToken = configuration.accessToken;
|
|
218
|
-
}
|
|
219
|
-
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
|
|
220
|
-
localVarHeaderParameter = {};
|
|
221
|
-
localVarQueryParameter = {};
|
|
222
|
-
// authentication bearer required
|
|
223
|
-
// http bearer authentication required
|
|
224
|
-
return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
|
|
225
|
-
case 1:
|
|
226
|
-
// authentication bearer required
|
|
227
|
-
// http bearer authentication required
|
|
228
|
-
_a.sent();
|
|
229
|
-
if (pageSize !== undefined) {
|
|
230
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
231
|
-
}
|
|
232
|
-
if (pageToken !== undefined) {
|
|
233
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
234
|
-
}
|
|
235
|
-
if (filter !== undefined) {
|
|
236
|
-
localVarQueryParameter['filter'] = filter;
|
|
237
|
-
}
|
|
238
|
-
if (search !== undefined) {
|
|
239
|
-
localVarQueryParameter['search'] = search;
|
|
240
|
-
}
|
|
241
|
-
if (order !== undefined) {
|
|
242
|
-
localVarQueryParameter['order'] = order;
|
|
243
|
-
}
|
|
244
|
-
if (expand !== undefined) {
|
|
245
|
-
localVarQueryParameter['expand'] = expand;
|
|
246
|
-
}
|
|
247
|
-
if (filters !== undefined) {
|
|
248
|
-
localVarQueryParameter['filters'] = filters;
|
|
249
|
-
}
|
|
250
|
-
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
251
|
-
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
252
|
-
}
|
|
253
|
-
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
254
|
-
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
255
|
-
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
256
|
-
return [2 /*return*/, {
|
|
257
|
-
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
258
|
-
options: localVarRequestOptions,
|
|
259
|
-
}];
|
|
260
|
-
}
|
|
261
|
-
});
|
|
262
|
-
});
|
|
263
|
-
},
|
|
264
|
-
/**
|
|
265
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
193
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
266
194
|
* @summary Update the changelog configuration
|
|
267
195
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
268
196
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -325,7 +253,7 @@ var ChangelogConfigurationsApiFp = function (configuration) {
|
|
|
325
253
|
var localVarAxiosParamCreator = (0, exports.ChangelogConfigurationsApiAxiosParamCreator)(configuration);
|
|
326
254
|
return {
|
|
327
255
|
/**
|
|
328
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
256
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
329
257
|
* @summary Create the changelog configuration
|
|
330
258
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
331
259
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -346,7 +274,7 @@ var ChangelogConfigurationsApiFp = function (configuration) {
|
|
|
346
274
|
});
|
|
347
275
|
},
|
|
348
276
|
/**
|
|
349
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
277
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
350
278
|
* @summary Retrieve the changelog configuration
|
|
351
279
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
352
280
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -367,34 +295,7 @@ var ChangelogConfigurationsApiFp = function (configuration) {
|
|
|
367
295
|
});
|
|
368
296
|
},
|
|
369
297
|
/**
|
|
370
|
-
*
|
|
371
|
-
* @summary List changelog configurations
|
|
372
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
373
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
374
|
-
* @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.
|
|
375
|
-
* @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>
|
|
376
|
-
* @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>
|
|
377
|
-
* @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>
|
|
378
|
-
* @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/>
|
|
379
|
-
* @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>
|
|
380
|
-
* @param {*} [options] Override http request option.
|
|
381
|
-
* @throws {RequiredError}
|
|
382
|
-
*/
|
|
383
|
-
listChangelogConfigurations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
384
|
-
return __awaiter(this, void 0, void 0, function () {
|
|
385
|
-
var localVarAxiosArgs;
|
|
386
|
-
return __generator(this, function (_a) {
|
|
387
|
-
switch (_a.label) {
|
|
388
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
389
|
-
case 1:
|
|
390
|
-
localVarAxiosArgs = _a.sent();
|
|
391
|
-
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
392
|
-
}
|
|
393
|
-
});
|
|
394
|
-
});
|
|
395
|
-
},
|
|
396
|
-
/**
|
|
397
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
298
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
398
299
|
* @summary Update the changelog configuration
|
|
399
300
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
400
301
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -426,7 +327,7 @@ var ChangelogConfigurationsApiFactory = function (configuration, basePath, axios
|
|
|
426
327
|
var localVarFp = (0, exports.ChangelogConfigurationsApiFp)(configuration);
|
|
427
328
|
return {
|
|
428
329
|
/**
|
|
429
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
330
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
430
331
|
* @summary Create the changelog configuration
|
|
431
332
|
* @param {CreateChangelogConfigurationDto} createChangelogConfigurationDto
|
|
432
333
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -437,7 +338,7 @@ var ChangelogConfigurationsApiFactory = function (configuration, basePath, axios
|
|
|
437
338
|
return localVarFp.createChangelogConfiguration(createChangelogConfigurationDto, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
438
339
|
},
|
|
439
340
|
/**
|
|
440
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
341
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
441
342
|
* @summary Retrieve the changelog configuration
|
|
442
343
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
443
344
|
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
@@ -448,24 +349,7 @@ var ChangelogConfigurationsApiFactory = function (configuration, basePath, axios
|
|
|
448
349
|
return localVarFp.getChangelogConfiguration(code, authorization, options).then(function (request) { return request(axios, basePath); });
|
|
449
350
|
},
|
|
450
351
|
/**
|
|
451
|
-
*
|
|
452
|
-
* @summary List changelog configurations
|
|
453
|
-
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
454
|
-
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
455
|
-
* @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.
|
|
456
|
-
* @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>
|
|
457
|
-
* @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>
|
|
458
|
-
* @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>
|
|
459
|
-
* @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/>
|
|
460
|
-
* @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>
|
|
461
|
-
* @param {*} [options] Override http request option.
|
|
462
|
-
* @throws {RequiredError}
|
|
463
|
-
*/
|
|
464
|
-
listChangelogConfigurations: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
465
|
-
return localVarFp.listChangelogConfigurations(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
466
|
-
},
|
|
467
|
-
/**
|
|
468
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
352
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
469
353
|
* @summary Update the changelog configuration
|
|
470
354
|
* @param {string} code Unique identifier code for the changelog configuration
|
|
471
355
|
* @param {UpdateChangelogConfigurationDto} updateChangelogConfigurationDto
|
|
@@ -491,7 +375,7 @@ var ChangelogConfigurationsApi = /** @class */ (function (_super) {
|
|
|
491
375
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
492
376
|
}
|
|
493
377
|
/**
|
|
494
|
-
* Creates a new changelog configuration for an entity type **Required Permissions**
|
|
378
|
+
* Creates a new changelog configuration for an entity type **Required Permissions** none
|
|
495
379
|
* @summary Create the changelog configuration
|
|
496
380
|
* @param {ChangelogConfigurationsApiCreateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
497
381
|
* @param {*} [options] Override http request option.
|
|
@@ -503,7 +387,7 @@ var ChangelogConfigurationsApi = /** @class */ (function (_super) {
|
|
|
503
387
|
return (0, exports.ChangelogConfigurationsApiFp)(this.configuration).createChangelogConfiguration(requestParameters.createChangelogConfigurationDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
504
388
|
};
|
|
505
389
|
/**
|
|
506
|
-
* Retrieves a changelog configuration by its code **Required Permissions**
|
|
390
|
+
* Retrieves a changelog configuration by its code **Required Permissions** none
|
|
507
391
|
* @summary Retrieve the changelog configuration
|
|
508
392
|
* @param {ChangelogConfigurationsApiGetChangelogConfigurationRequest} requestParameters Request parameters.
|
|
509
393
|
* @param {*} [options] Override http request option.
|
|
@@ -515,20 +399,7 @@ var ChangelogConfigurationsApi = /** @class */ (function (_super) {
|
|
|
515
399
|
return (0, exports.ChangelogConfigurationsApiFp)(this.configuration).getChangelogConfiguration(requestParameters.code, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
516
400
|
};
|
|
517
401
|
/**
|
|
518
|
-
*
|
|
519
|
-
* @summary List changelog configurations
|
|
520
|
-
* @param {ChangelogConfigurationsApiListChangelogConfigurationsRequest} requestParameters Request parameters.
|
|
521
|
-
* @param {*} [options] Override http request option.
|
|
522
|
-
* @throws {RequiredError}
|
|
523
|
-
* @memberof ChangelogConfigurationsApi
|
|
524
|
-
*/
|
|
525
|
-
ChangelogConfigurationsApi.prototype.listChangelogConfigurations = function (requestParameters, options) {
|
|
526
|
-
var _this = this;
|
|
527
|
-
if (requestParameters === void 0) { requestParameters = {}; }
|
|
528
|
-
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); });
|
|
529
|
-
};
|
|
530
|
-
/**
|
|
531
|
-
* Updates an existing changelog configuration **Required Permissions** \"changelog-management.changelog-configurations.update\"
|
|
402
|
+
* Updates an existing changelog configuration **Required Permissions** none
|
|
532
403
|
* @summary Update the changelog configuration
|
|
533
404
|
* @param {ChangelogConfigurationsApiUpdateChangelogConfigurationRequest} requestParameters Request parameters.
|
|
534
405
|
* @param {*} [options] Override http request option.
|