@emilgroup/changelog-sdk 1.0.1-beta.1
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 +21 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +23 -0
- package/README.md +51 -0
- package/api/changelog-events-api.ts +349 -0
- package/api/health-checks-api.ts +150 -0
- package/api.ts +29 -0
- package/base.ts +331 -0
- package/common.ts +198 -0
- package/configuration.ts +110 -0
- package/dist/api/changelog-events-api.d.ts +206 -0
- package/dist/api/changelog-events-api.js +352 -0
- package/dist/api/health-checks-api.d.ts +87 -0
- package/dist/api/health-checks-api.js +218 -0
- package/dist/api.d.ts +13 -0
- package/dist/api.js +31 -0
- package/dist/base.d.ts +86 -0
- package/dist/base.js +367 -0
- package/dist/common.d.ts +91 -0
- package/dist/common.js +276 -0
- package/dist/configuration.d.ts +89 -0
- package/dist/configuration.js +52 -0
- package/dist/index.d.ts +15 -0
- package/dist/index.js +36 -0
- package/dist/models/changelog-event-class-changes.d.ts +36 -0
- package/dist/models/changelog-event-class-changes.js +15 -0
- package/dist/models/changelog-event-class.d.ts +151 -0
- package/dist/models/changelog-event-class.js +15 -0
- package/dist/models/get-changelog-event-response-class.d.ts +25 -0
- package/dist/models/get-changelog-event-response-class.js +15 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +22 -0
- package/dist/models/inline-response200.d.ts +54 -0
- package/dist/models/inline-response200.js +15 -0
- package/dist/models/inline-response503.d.ts +54 -0
- package/dist/models/inline-response503.js +15 -0
- package/dist/models/list-changelog-events-response-class.d.ts +43 -0
- package/dist/models/list-changelog-events-response-class.js +15 -0
- package/git_push.sh +57 -0
- package/index.ts +19 -0
- package/models/changelog-event-class-changes.ts +42 -0
- package/models/changelog-event-class.ts +157 -0
- package/models/get-changelog-event-response-class.ts +31 -0
- package/models/index.ts +6 -0
- package/models/inline-response200.ts +48 -0
- package/models/inline-response503.ts +48 -0
- package/models/list-changelog-events-response-class.ts +49 -0
- package/package.json +27 -0
- package/tsconfig.json +23 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
.gitignore
|
|
2
|
+
.npmignore
|
|
3
|
+
.openapi-generator-ignore
|
|
4
|
+
README.md
|
|
5
|
+
api.ts
|
|
6
|
+
api/changelog-events-api.ts
|
|
7
|
+
api/health-checks-api.ts
|
|
8
|
+
base.ts
|
|
9
|
+
common.ts
|
|
10
|
+
configuration.ts
|
|
11
|
+
git_push.sh
|
|
12
|
+
index.ts
|
|
13
|
+
models/changelog-event-class-changes.ts
|
|
14
|
+
models/changelog-event-class.ts
|
|
15
|
+
models/get-changelog-event-response-class.ts
|
|
16
|
+
models/index.ts
|
|
17
|
+
models/inline-response200.ts
|
|
18
|
+
models/inline-response503.ts
|
|
19
|
+
models/list-changelog-events-response-class.ts
|
|
20
|
+
package.json
|
|
21
|
+
tsconfig.json
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
5.4.0
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# OpenAPI Generator Ignore
|
|
2
|
+
# Generated by openapi-generator https://github.com/openapitools/openapi-generator
|
|
3
|
+
|
|
4
|
+
# Use this file to prevent files from being overwritten by the generator.
|
|
5
|
+
# The patterns follow closely to .gitignore or .dockerignore.
|
|
6
|
+
|
|
7
|
+
# As an example, the C# client generator defines ApiClient.cs.
|
|
8
|
+
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
|
|
9
|
+
#ApiClient.cs
|
|
10
|
+
|
|
11
|
+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
|
|
12
|
+
#foo/*/qux
|
|
13
|
+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
|
|
14
|
+
|
|
15
|
+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
|
|
16
|
+
#foo/**/qux
|
|
17
|
+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
|
|
18
|
+
|
|
19
|
+
# You can also negate patterns with an exclamation (!).
|
|
20
|
+
# For example, you can ignore all files in a docs folder with the file extension .md:
|
|
21
|
+
#docs/*.md
|
|
22
|
+
# Then explicitly reverse the ignore rule for a single file:
|
|
23
|
+
#!docs/README.md
|
package/README.md
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# Emil Changelog SDK
|
|
2
|
+
|
|
3
|
+
This TypeScript/JavaScript client utilizes [axios](https://github.com/axios/axios). The generated module can be used with client-based applications (i.e. React).
|
|
4
|
+
|
|
5
|
+
Language level
|
|
6
|
+
* ES5 - you must have a Promises/A+ library installed
|
|
7
|
+
* ES6
|
|
8
|
+
|
|
9
|
+
Module system
|
|
10
|
+
* CommonJS
|
|
11
|
+
* ES6 module system
|
|
12
|
+
|
|
13
|
+
Although this package can be used in both TypeScript and JavaScript, it is intended to be used with TypeScript. The definition should be automatically resolved via `package.json`. ([Reference](http://www.typescriptlang.org/docs/handbook/typings-for-npm-packages.html)). For more information, you can go to [Emil Api documentation](https://emil.stoplight.io/docs/emil-api/).
|
|
14
|
+
|
|
15
|
+
## Consuming
|
|
16
|
+
|
|
17
|
+
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
|
+
|
|
19
|
+
```
|
|
20
|
+
npm install @emilgroup/changelog-sdk@1.0.1-beta.1 --save
|
|
21
|
+
```
|
|
22
|
+
or
|
|
23
|
+
```
|
|
24
|
+
yarn add @emilgroup/changelog-sdk@1.0.1-beta.1
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
And then you can import ``.
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import { } from '@emilgroup/changelog-sdk'
|
|
31
|
+
|
|
32
|
+
const = new ();
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
To use authentication protected endpoints, you have to first authorize. To do so, use the `authorize` function in ``:
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
async function (): Promise<Void> {
|
|
39
|
+
try {
|
|
40
|
+
const = new ();
|
|
41
|
+
|
|
42
|
+
await .authorize('username', 'password');
|
|
43
|
+
|
|
44
|
+
const { data: { items } } = await .();
|
|
45
|
+
|
|
46
|
+
console.log(items);
|
|
47
|
+
} catch(error) {
|
|
48
|
+
// process error
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
```
|
|
@@ -0,0 +1,349 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL Changelogservice
|
|
5
|
+
* The EMIL Changelog Service API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { GetChangelogEventResponseClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { ListChangelogEventsResponseClass } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* ChangelogEventsApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export const ChangelogEventsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
|
+
return {
|
|
33
|
+
/**
|
|
34
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
35
|
+
* @summary Retrieve the changelog event
|
|
36
|
+
* @param {string} code Unique identifier code for the changelog event
|
|
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
|
+
getChangelogEvent: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
42
|
+
// verify required parameter 'code' is not null or undefined
|
|
43
|
+
assertParamExists('getChangelogEvent', 'code', code)
|
|
44
|
+
const localVarPath = `/changelogservice/v1/changelog-events/{code}`
|
|
45
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
46
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
48
|
+
let baseOptions;
|
|
49
|
+
let baseAccessToken;
|
|
50
|
+
if (configuration) {
|
|
51
|
+
baseOptions = configuration.baseOptions;
|
|
52
|
+
baseAccessToken = configuration.accessToken;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
56
|
+
const localVarHeaderParameter = {} as any;
|
|
57
|
+
const localVarQueryParameter = {} as any;
|
|
58
|
+
|
|
59
|
+
// authentication bearer required
|
|
60
|
+
// http bearer authentication required
|
|
61
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
62
|
+
|
|
63
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
64
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
70
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
72
|
+
|
|
73
|
+
return {
|
|
74
|
+
url: toPathString(localVarUrlObj),
|
|
75
|
+
options: localVarRequestOptions,
|
|
76
|
+
};
|
|
77
|
+
},
|
|
78
|
+
/**
|
|
79
|
+
* Returns a list of changelog events you have previously created. The changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** none
|
|
80
|
+
* @summary List changelog events
|
|
81
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
82
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
83
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
84
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
85
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, entityCode, actorName, sourceService</i>
|
|
86
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
87
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
88
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
listChangelogEvents: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
93
|
+
const localVarPath = `/changelogservice/v1/changelog-events`;
|
|
94
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
95
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
96
|
+
let baseOptions;
|
|
97
|
+
let baseAccessToken;
|
|
98
|
+
if (configuration) {
|
|
99
|
+
baseOptions = configuration.baseOptions;
|
|
100
|
+
baseAccessToken = configuration.accessToken;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
104
|
+
const localVarHeaderParameter = {} as any;
|
|
105
|
+
const localVarQueryParameter = {} as any;
|
|
106
|
+
|
|
107
|
+
// authentication bearer required
|
|
108
|
+
// http bearer authentication required
|
|
109
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
110
|
+
|
|
111
|
+
if (pageSize !== undefined) {
|
|
112
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
if (pageToken !== undefined) {
|
|
116
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
if (filter !== undefined) {
|
|
120
|
+
localVarQueryParameter['filter'] = filter;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
if (search !== undefined) {
|
|
124
|
+
localVarQueryParameter['search'] = search;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
if (order !== undefined) {
|
|
128
|
+
localVarQueryParameter['order'] = order;
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
if (expand !== undefined) {
|
|
132
|
+
localVarQueryParameter['expand'] = expand;
|
|
133
|
+
}
|
|
134
|
+
|
|
135
|
+
if (filters !== undefined) {
|
|
136
|
+
localVarQueryParameter['filters'] = filters;
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
140
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
146
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
147
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
148
|
+
|
|
149
|
+
return {
|
|
150
|
+
url: toPathString(localVarUrlObj),
|
|
151
|
+
options: localVarRequestOptions,
|
|
152
|
+
};
|
|
153
|
+
},
|
|
154
|
+
}
|
|
155
|
+
};
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* ChangelogEventsApi - functional programming interface
|
|
159
|
+
* @export
|
|
160
|
+
*/
|
|
161
|
+
export const ChangelogEventsApiFp = function(configuration?: Configuration) {
|
|
162
|
+
const localVarAxiosParamCreator = ChangelogEventsApiAxiosParamCreator(configuration)
|
|
163
|
+
return {
|
|
164
|
+
/**
|
|
165
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
166
|
+
* @summary Retrieve the changelog event
|
|
167
|
+
* @param {string} code Unique identifier code for the changelog event
|
|
168
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
169
|
+
* @param {*} [options] Override http request option.
|
|
170
|
+
* @throws {RequiredError}
|
|
171
|
+
*/
|
|
172
|
+
async getChangelogEvent(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChangelogEventResponseClass>> {
|
|
173
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getChangelogEvent(code, authorization, options);
|
|
174
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
175
|
+
},
|
|
176
|
+
/**
|
|
177
|
+
* Returns a list of changelog events you have previously created. The changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** none
|
|
178
|
+
* @summary List changelog events
|
|
179
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
180
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
181
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
182
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
183
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, entityCode, actorName, sourceService</i>
|
|
184
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
185
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
186
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
async listChangelogEvents(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListChangelogEventsResponseClass>> {
|
|
191
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listChangelogEvents(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
|
|
192
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
193
|
+
},
|
|
194
|
+
}
|
|
195
|
+
};
|
|
196
|
+
|
|
197
|
+
/**
|
|
198
|
+
* ChangelogEventsApi - factory interface
|
|
199
|
+
* @export
|
|
200
|
+
*/
|
|
201
|
+
export const ChangelogEventsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
202
|
+
const localVarFp = ChangelogEventsApiFp(configuration)
|
|
203
|
+
return {
|
|
204
|
+
/**
|
|
205
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
206
|
+
* @summary Retrieve the changelog event
|
|
207
|
+
* @param {string} code Unique identifier code for the changelog event
|
|
208
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
209
|
+
* @param {*} [options] Override http request option.
|
|
210
|
+
* @throws {RequiredError}
|
|
211
|
+
*/
|
|
212
|
+
getChangelogEvent(code: string, authorization?: string, options?: any): AxiosPromise<GetChangelogEventResponseClass> {
|
|
213
|
+
return localVarFp.getChangelogEvent(code, authorization, options).then((request) => request(axios, basePath));
|
|
214
|
+
},
|
|
215
|
+
/**
|
|
216
|
+
* Returns a list of changelog events you have previously created. The changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** none
|
|
217
|
+
* @summary List changelog events
|
|
218
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
219
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
220
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
221
|
+
* @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
222
|
+
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, entityCode, actorName, sourceService</i>
|
|
223
|
+
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
224
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/>
|
|
225
|
+
* @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
226
|
+
* @param {*} [options] Override http request option.
|
|
227
|
+
* @throws {RequiredError}
|
|
228
|
+
*/
|
|
229
|
+
listChangelogEvents(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListChangelogEventsResponseClass> {
|
|
230
|
+
return localVarFp.listChangelogEvents(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
231
|
+
},
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
|
|
235
|
+
/**
|
|
236
|
+
* Request parameters for getChangelogEvent operation in ChangelogEventsApi.
|
|
237
|
+
* @export
|
|
238
|
+
* @interface ChangelogEventsApiGetChangelogEventRequest
|
|
239
|
+
*/
|
|
240
|
+
export interface ChangelogEventsApiGetChangelogEventRequest {
|
|
241
|
+
/**
|
|
242
|
+
* Unique identifier code for the changelog event
|
|
243
|
+
* @type {string}
|
|
244
|
+
* @memberof ChangelogEventsApiGetChangelogEvent
|
|
245
|
+
*/
|
|
246
|
+
readonly code: string
|
|
247
|
+
|
|
248
|
+
/**
|
|
249
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
250
|
+
* @type {string}
|
|
251
|
+
* @memberof ChangelogEventsApiGetChangelogEvent
|
|
252
|
+
*/
|
|
253
|
+
readonly authorization?: string
|
|
254
|
+
}
|
|
255
|
+
|
|
256
|
+
/**
|
|
257
|
+
* Request parameters for listChangelogEvents operation in ChangelogEventsApi.
|
|
258
|
+
* @export
|
|
259
|
+
* @interface ChangelogEventsApiListChangelogEventsRequest
|
|
260
|
+
*/
|
|
261
|
+
export interface ChangelogEventsApiListChangelogEventsRequest {
|
|
262
|
+
/**
|
|
263
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
264
|
+
* @type {string}
|
|
265
|
+
* @memberof ChangelogEventsApiListChangelogEvents
|
|
266
|
+
*/
|
|
267
|
+
readonly authorization?: string
|
|
268
|
+
|
|
269
|
+
/**
|
|
270
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
271
|
+
* @type {number}
|
|
272
|
+
* @memberof ChangelogEventsApiListChangelogEvents
|
|
273
|
+
*/
|
|
274
|
+
readonly pageSize?: number
|
|
275
|
+
|
|
276
|
+
/**
|
|
277
|
+
* 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.
|
|
278
|
+
* @type {string}
|
|
279
|
+
* @memberof ChangelogEventsApiListChangelogEvents
|
|
280
|
+
*/
|
|
281
|
+
readonly pageToken?: string
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
285
|
+
* @type {string}
|
|
286
|
+
* @memberof ChangelogEventsApiListChangelogEvents
|
|
287
|
+
*/
|
|
288
|
+
readonly filter?: string
|
|
289
|
+
|
|
290
|
+
/**
|
|
291
|
+
* Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: code, entityCode, actorName, sourceService</i>
|
|
292
|
+
* @type {string}
|
|
293
|
+
* @memberof ChangelogEventsApiListChangelogEvents
|
|
294
|
+
*/
|
|
295
|
+
readonly search?: string
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, code, occurredAt, createdAt, entityType, action</i>
|
|
299
|
+
* @type {string}
|
|
300
|
+
* @memberof ChangelogEventsApiListChangelogEvents
|
|
301
|
+
*/
|
|
302
|
+
readonly order?: string
|
|
303
|
+
|
|
304
|
+
/**
|
|
305
|
+
* 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/>
|
|
306
|
+
* @type {string}
|
|
307
|
+
* @memberof ChangelogEventsApiListChangelogEvents
|
|
308
|
+
*/
|
|
309
|
+
readonly expand?: string
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.<br/> <br/> <i>Allowed values: id, code, entityType, entityCode, action, actorSub, actorType, sourceService, accountCode, partnerCode, policyCode, claimCode, parentType, parentCode, occurredAt, createdAt</i>
|
|
313
|
+
* @type {string}
|
|
314
|
+
* @memberof ChangelogEventsApiListChangelogEvents
|
|
315
|
+
*/
|
|
316
|
+
readonly filters?: string
|
|
317
|
+
}
|
|
318
|
+
|
|
319
|
+
/**
|
|
320
|
+
* ChangelogEventsApi - object-oriented interface
|
|
321
|
+
* @export
|
|
322
|
+
* @class ChangelogEventsApi
|
|
323
|
+
* @extends {BaseAPI}
|
|
324
|
+
*/
|
|
325
|
+
export class ChangelogEventsApi extends BaseAPI {
|
|
326
|
+
/**
|
|
327
|
+
* Retrieves a changelog event by its code **Required Permissions** none
|
|
328
|
+
* @summary Retrieve the changelog event
|
|
329
|
+
* @param {ChangelogEventsApiGetChangelogEventRequest} requestParameters Request parameters.
|
|
330
|
+
* @param {*} [options] Override http request option.
|
|
331
|
+
* @throws {RequiredError}
|
|
332
|
+
* @memberof ChangelogEventsApi
|
|
333
|
+
*/
|
|
334
|
+
public getChangelogEvent(requestParameters: ChangelogEventsApiGetChangelogEventRequest, options?: AxiosRequestConfig) {
|
|
335
|
+
return ChangelogEventsApiFp(this.configuration).getChangelogEvent(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* Returns a list of changelog events you have previously created. The changelog events are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** none
|
|
340
|
+
* @summary List changelog events
|
|
341
|
+
* @param {ChangelogEventsApiListChangelogEventsRequest} requestParameters Request parameters.
|
|
342
|
+
* @param {*} [options] Override http request option.
|
|
343
|
+
* @throws {RequiredError}
|
|
344
|
+
* @memberof ChangelogEventsApi
|
|
345
|
+
*/
|
|
346
|
+
public listChangelogEvents(requestParameters: ChangelogEventsApiListChangelogEventsRequest = {}, options?: AxiosRequestConfig) {
|
|
347
|
+
return ChangelogEventsApiFp(this.configuration).listChangelogEvents(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
|
|
348
|
+
}
|
|
349
|
+
}
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL Changelogservice
|
|
5
|
+
* The EMIL Changelog Service API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
17
|
+
import { Configuration } from '../configuration';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
|
+
// @ts-ignore
|
|
24
|
+
import { InlineResponse200 } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
26
|
+
import { InlineResponse503 } from '../models';
|
|
27
|
+
/**
|
|
28
|
+
* HealthChecksApi - axios parameter creator
|
|
29
|
+
* @export
|
|
30
|
+
*/
|
|
31
|
+
export const HealthChecksApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
32
|
+
return {
|
|
33
|
+
/**
|
|
34
|
+
* Returns the health status of the changelog service. This endpoint is used to monitor the operational status of the changelog service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
35
|
+
* @summary Health Check
|
|
36
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
37
|
+
* @param {*} [options] Override http request option.
|
|
38
|
+
* @throws {RequiredError}
|
|
39
|
+
*/
|
|
40
|
+
check: async (authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
41
|
+
const localVarPath = `/changelogservice/health`;
|
|
42
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
43
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
44
|
+
let baseOptions;
|
|
45
|
+
let baseAccessToken;
|
|
46
|
+
if (configuration) {
|
|
47
|
+
baseOptions = configuration.baseOptions;
|
|
48
|
+
baseAccessToken = configuration.accessToken;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
52
|
+
const localVarHeaderParameter = {} as any;
|
|
53
|
+
const localVarQueryParameter = {} as any;
|
|
54
|
+
|
|
55
|
+
// authentication bearer required
|
|
56
|
+
// http bearer authentication required
|
|
57
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
58
|
+
|
|
59
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
60
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
66
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
67
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
68
|
+
|
|
69
|
+
return {
|
|
70
|
+
url: toPathString(localVarUrlObj),
|
|
71
|
+
options: localVarRequestOptions,
|
|
72
|
+
};
|
|
73
|
+
},
|
|
74
|
+
}
|
|
75
|
+
};
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* HealthChecksApi - functional programming interface
|
|
79
|
+
* @export
|
|
80
|
+
*/
|
|
81
|
+
export const HealthChecksApiFp = function(configuration?: Configuration) {
|
|
82
|
+
const localVarAxiosParamCreator = HealthChecksApiAxiosParamCreator(configuration)
|
|
83
|
+
return {
|
|
84
|
+
/**
|
|
85
|
+
* Returns the health status of the changelog service. This endpoint is used to monitor the operational status of the changelog service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
86
|
+
* @summary Health Check
|
|
87
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
88
|
+
* @param {*} [options] Override http request option.
|
|
89
|
+
* @throws {RequiredError}
|
|
90
|
+
*/
|
|
91
|
+
async check(authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineResponse200>> {
|
|
92
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.check(authorization, options);
|
|
93
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
94
|
+
},
|
|
95
|
+
}
|
|
96
|
+
};
|
|
97
|
+
|
|
98
|
+
/**
|
|
99
|
+
* HealthChecksApi - factory interface
|
|
100
|
+
* @export
|
|
101
|
+
*/
|
|
102
|
+
export const HealthChecksApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
103
|
+
const localVarFp = HealthChecksApiFp(configuration)
|
|
104
|
+
return {
|
|
105
|
+
/**
|
|
106
|
+
* Returns the health status of the changelog service. This endpoint is used to monitor the operational status of the changelog service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
107
|
+
* @summary Health Check
|
|
108
|
+
* @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
|
|
109
|
+
* @param {*} [options] Override http request option.
|
|
110
|
+
* @throws {RequiredError}
|
|
111
|
+
*/
|
|
112
|
+
check(authorization?: string, options?: any): AxiosPromise<InlineResponse200> {
|
|
113
|
+
return localVarFp.check(authorization, options).then((request) => request(axios, basePath));
|
|
114
|
+
},
|
|
115
|
+
};
|
|
116
|
+
};
|
|
117
|
+
|
|
118
|
+
/**
|
|
119
|
+
* Request parameters for check operation in HealthChecksApi.
|
|
120
|
+
* @export
|
|
121
|
+
* @interface HealthChecksApiCheckRequest
|
|
122
|
+
*/
|
|
123
|
+
export interface HealthChecksApiCheckRequest {
|
|
124
|
+
/**
|
|
125
|
+
* Bearer Token: provided by the login endpoint under the name accessToken.
|
|
126
|
+
* @type {string}
|
|
127
|
+
* @memberof HealthChecksApiCheck
|
|
128
|
+
*/
|
|
129
|
+
readonly authorization?: string
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
/**
|
|
133
|
+
* HealthChecksApi - object-oriented interface
|
|
134
|
+
* @export
|
|
135
|
+
* @class HealthChecksApi
|
|
136
|
+
* @extends {BaseAPI}
|
|
137
|
+
*/
|
|
138
|
+
export class HealthChecksApi extends BaseAPI {
|
|
139
|
+
/**
|
|
140
|
+
* Returns the health status of the changelog service. This endpoint is used to monitor the operational status of the changelog service. It typically returns a simple status indicator, such as \'UP\' or \'OK\', confirming that the service is operational and available.
|
|
141
|
+
* @summary Health Check
|
|
142
|
+
* @param {HealthChecksApiCheckRequest} requestParameters Request parameters.
|
|
143
|
+
* @param {*} [options] Override http request option.
|
|
144
|
+
* @throws {RequiredError}
|
|
145
|
+
* @memberof HealthChecksApi
|
|
146
|
+
*/
|
|
147
|
+
public check(requestParameters: HealthChecksApiCheckRequest = {}, options?: AxiosRequestConfig) {
|
|
148
|
+
return HealthChecksApiFp(this.configuration).check(requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
149
|
+
}
|
|
150
|
+
}
|
package/api.ts
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* EMIL Changelogservice
|
|
5
|
+
* The EMIL Changelog Service API description
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0
|
|
8
|
+
* Contact: kontakt@emil.de
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import { Configuration } from './configuration';
|
|
17
|
+
import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
|
|
18
|
+
// Some imports not used depending on template conditions
|
|
19
|
+
// @ts-ignore
|
|
20
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from './common';
|
|
21
|
+
// @ts-ignore
|
|
22
|
+
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base';
|
|
23
|
+
import { ChangelogEventsApi } from './api';
|
|
24
|
+
import { HealthChecksApi } from './api';
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
export * from './api/changelog-events-api';
|
|
28
|
+
export * from './api/health-checks-api';
|
|
29
|
+
|