@coscine/api-client 3.4.3 → 3.6.0
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/dist/index.js +2523 -2215
- package/dist/types/Coscine.Api/@coscine/api/admin-api.d.ts +136 -24
- package/dist/types/Coscine.Api/@coscine/api/application-profile-api.d.ts +16 -16
- package/dist/types/Coscine.Api/@coscine/api/blob-api.d.ts +16 -16
- package/dist/types/Coscine.Api/@coscine/api/discipline-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/handle-api.d.ts +187 -0
- package/dist/types/Coscine.Api/@coscine/api/language-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/license-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/maintenance-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/organization-api.d.ts +18 -10
- package/dist/types/Coscine.Api/@coscine/api/pid-api.d.ts +142 -55
- package/dist/types/Coscine.Api/@coscine/api/project-api.d.ts +20 -20
- package/dist/types/Coscine.Api/@coscine/api/project-invitation-api.d.ts +16 -16
- package/dist/types/Coscine.Api/@coscine/api/project-member-api.d.ts +20 -20
- package/dist/types/Coscine.Api/@coscine/api/project-publication-request-api.d.ts +142 -0
- package/dist/types/Coscine.Api/@coscine/api/project-quota-api.d.ts +12 -12
- package/dist/types/Coscine.Api/@coscine/api/project-resource-api.d.ts +20 -20
- package/dist/types/Coscine.Api/@coscine/api/project-resource-quota-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/project-resource-type-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/resource-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/resource-type-api.d.ts +20 -20
- package/dist/types/Coscine.Api/@coscine/api/role-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/search-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/self-api-token-api.d.ts +16 -16
- package/dist/types/Coscine.Api/@coscine/api/self-api.d.ts +24 -24
- package/dist/types/Coscine.Api/@coscine/api/title-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/tos-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/tree-api.d.ts +108 -14
- package/dist/types/Coscine.Api/@coscine/api/user-api.d.ts +4 -4
- package/dist/types/Coscine.Api/@coscine/api/visibility-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/api/vocabulary-api.d.ts +8 -8
- package/dist/types/Coscine.Api/@coscine/model/{language-dto-paged-response.d.ts → activity-log-dto-paged-response.d.ts} +10 -10
- package/dist/types/Coscine.Api/@coscine/model/activity-log-dto.d.ts +60 -0
- package/dist/types/Coscine.Api/@coscine/model/coscine-http-method.d.ts +24 -0
- package/dist/types/Coscine.Api/@coscine/model/file-tree-dto.d.ts +6 -0
- package/dist/types/Coscine.Api/@coscine/model/{pid-validation-dto-response.d.ts → handle-dto-response.d.ts} +9 -9
- package/dist/types/Coscine.Api/@coscine/model/{pid-validation-dto.d.ts → handle-dto.d.ts} +12 -11
- package/dist/types/Coscine.Api/@coscine/model/handle-for-update-dto.d.ts +25 -0
- package/dist/types/Coscine.Api/@coscine/model/handle-value-dto.d.ts +72 -0
- package/dist/types/Coscine.Api/@coscine/model/handle-value-for-update-dto.d.ts +36 -0
- package/dist/types/Coscine.Api/@coscine/model/index.d.ts +15 -2
- package/dist/types/Coscine.Api/@coscine/model/license-dto.d.ts +6 -0
- package/dist/types/Coscine.Api/@coscine/model/metadata-tree-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/@coscine/model/metadata-tree-extracted-dto.d.ts +50 -0
- package/dist/types/Coscine.Api/@coscine/model/organization-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/@coscine/model/{title-dto-paged-response.d.ts → pid-dto-paged-response.d.ts} +10 -10
- package/dist/types/Coscine.Api/@coscine/model/{user-dto-ienumerable-paged-response.d.ts → pid-dto-response.d.ts} +9 -16
- package/dist/types/Coscine.Api/@coscine/model/pid-dto.d.ts +49 -0
- package/dist/types/Coscine.Api/@coscine/model/project-admin-dto.d.ts +1 -1
- package/dist/types/Coscine.Api/@coscine/model/publication-advisory-service-dto.d.ts +30 -0
- package/dist/types/Coscine.Api/@coscine/model/publication-request-for-creation-dto-response.d.ts +43 -0
- package/dist/types/Coscine.Api/@coscine/model/publication-request-for-creation-dto.d.ts +36 -0
- package/dist/types/Coscine.Api/@coscine/model/terms-of-service-dto.d.ts +6 -0
- package/dist/types/Coscine.Api/@coscine/model/user-institute-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/@coscine/model/user-organization-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/api.d.ts +2 -0
- package/dist/types/apis.d.ts +9 -1
- package/dist/types/index.d.ts +18 -2
- package/package.json +2 -2
- package/dist/types/Coscine.Api/@coscine/model/project-admin-dto-ienumerable-paged-response.d.ts +0 -50
- package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto-ienumerable-paged-response.d.ts +0 -50
|
@@ -27,7 +27,7 @@ export declare const DisciplineApiAxiosParamCreator: (configuration?: Configurat
|
|
|
27
27
|
*/
|
|
28
28
|
apiV2DisciplinesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
31
31
|
* @summary Retrieves a discipline with the specified ID.
|
|
32
32
|
* @param {string} disciplineId The ID of the discipline.
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
@@ -35,7 +35,7 @@ export declare const DisciplineApiAxiosParamCreator: (configuration?: Configurat
|
|
|
35
35
|
*/
|
|
36
36
|
getDiscipline: (disciplineId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
39
39
|
* @summary Retrieves all disciplines.
|
|
40
40
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
41
41
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -58,7 +58,7 @@ export declare const DisciplineApiFp: (configuration?: Configuration) => {
|
|
|
58
58
|
*/
|
|
59
59
|
apiV2DisciplinesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
62
62
|
* @summary Retrieves a discipline with the specified ID.
|
|
63
63
|
* @param {string} disciplineId The ID of the discipline.
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export declare const DisciplineApiFp: (configuration?: Configuration) => {
|
|
|
66
66
|
*/
|
|
67
67
|
getDiscipline(disciplineId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisciplineDtoResponse>>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
70
70
|
* @summary Retrieves all disciplines.
|
|
71
71
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
72
72
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -89,7 +89,7 @@ export declare const DisciplineApiFactory: (configuration?: Configuration, baseP
|
|
|
89
89
|
*/
|
|
90
90
|
apiV2DisciplinesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
93
93
|
* @summary Retrieves a discipline with the specified ID.
|
|
94
94
|
* @param {DisciplineApiGetDisciplineRequest} requestParameters Request parameters.
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ export declare const DisciplineApiFactory: (configuration?: Configuration, baseP
|
|
|
97
97
|
*/
|
|
98
98
|
getDiscipline(requestParameters: DisciplineApiGetDisciplineRequest, options?: AxiosRequestConfig): AxiosPromise<DisciplineDtoResponse>;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
101
101
|
* @summary Retrieves all disciplines.
|
|
102
102
|
* @param {DisciplineApiGetDisciplinesRequest} requestParameters Request parameters.
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
@@ -159,7 +159,7 @@ export declare class DisciplineApi extends BaseAPI {
|
|
|
159
159
|
*/
|
|
160
160
|
apiV2DisciplinesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
161
161
|
/**
|
|
162
|
-
*
|
|
162
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
163
163
|
* @summary Retrieves a discipline with the specified ID.
|
|
164
164
|
* @param {DisciplineApiGetDisciplineRequest} requestParameters Request parameters.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
@@ -168,7 +168,7 @@ export declare class DisciplineApi extends BaseAPI {
|
|
|
168
168
|
*/
|
|
169
169
|
getDiscipline(requestParameters: DisciplineApiGetDisciplineRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DisciplineDtoResponse, any>>;
|
|
170
170
|
/**
|
|
171
|
-
*
|
|
171
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
172
172
|
* @summary Retrieves all disciplines.
|
|
173
173
|
* @param {DisciplineApiGetDisciplinesRequest} requestParameters Request parameters.
|
|
174
174
|
* @param {*} [options] Override http request option.
|
|
@@ -0,0 +1,187 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Coscine Web API
|
|
3
|
+
* Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0
|
|
6
|
+
* Contact: servicedesk@itc.rwth-aachen.de
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
|
+
import { RequestArgs, BaseAPI } from '../../base';
|
|
15
|
+
import { HandleDtoResponse } from '../../@coscine/model';
|
|
16
|
+
import { HandleForUpdateDto } from '../../@coscine/model';
|
|
17
|
+
/**
|
|
18
|
+
* HandleApi - axios parameter creator
|
|
19
|
+
* @export
|
|
20
|
+
*/
|
|
21
|
+
export declare const HandleApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
*
|
|
24
|
+
* @summary Responds with the HTTP methods allowed for the endpoint.
|
|
25
|
+
* @param {*} [options] Override http request option.
|
|
26
|
+
* @throws {RequiredError}
|
|
27
|
+
*/
|
|
28
|
+
apiV2HandlesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
|
+
/**
|
|
30
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
31
|
+
* @summary Retrieves all values of a handle by its PID.
|
|
32
|
+
* @param {string} prefix The prefix of the PID
|
|
33
|
+
* @param {string} suffix The suffix of the PID
|
|
34
|
+
* @param {*} [options] Override http request option.
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
getHandle: (prefix: string, suffix: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
|
+
/**
|
|
39
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
40
|
+
* @summary Updates a handle.
|
|
41
|
+
* @param {string} prefix The prefix of the PID
|
|
42
|
+
* @param {string} suffix The suffix of the PID
|
|
43
|
+
* @param {HandleForUpdateDto} [handleForUpdateDto] The handle for updating.
|
|
44
|
+
* @param {*} [options] Override http request option.
|
|
45
|
+
* @throws {RequiredError}
|
|
46
|
+
*/
|
|
47
|
+
updateHandle: (prefix: string, suffix: string, handleForUpdateDto?: HandleForUpdateDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* HandleApi - functional programming interface
|
|
51
|
+
* @export
|
|
52
|
+
*/
|
|
53
|
+
export declare const HandleApiFp: (configuration?: Configuration) => {
|
|
54
|
+
/**
|
|
55
|
+
*
|
|
56
|
+
* @summary Responds with the HTTP methods allowed for the endpoint.
|
|
57
|
+
* @param {*} [options] Override http request option.
|
|
58
|
+
* @throws {RequiredError}
|
|
59
|
+
*/
|
|
60
|
+
apiV2HandlesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
61
|
+
/**
|
|
62
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
63
|
+
* @summary Retrieves all values of a handle by its PID.
|
|
64
|
+
* @param {string} prefix The prefix of the PID
|
|
65
|
+
* @param {string} suffix The suffix of the PID
|
|
66
|
+
* @param {*} [options] Override http request option.
|
|
67
|
+
* @throws {RequiredError}
|
|
68
|
+
*/
|
|
69
|
+
getHandle(prefix: string, suffix: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<HandleDtoResponse>>;
|
|
70
|
+
/**
|
|
71
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
72
|
+
* @summary Updates a handle.
|
|
73
|
+
* @param {string} prefix The prefix of the PID
|
|
74
|
+
* @param {string} suffix The suffix of the PID
|
|
75
|
+
* @param {HandleForUpdateDto} [handleForUpdateDto] The handle for updating.
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
updateHandle(prefix: string, suffix: string, handleForUpdateDto?: HandleForUpdateDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
80
|
+
};
|
|
81
|
+
/**
|
|
82
|
+
* HandleApi - factory interface
|
|
83
|
+
* @export
|
|
84
|
+
*/
|
|
85
|
+
export declare const HandleApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
86
|
+
/**
|
|
87
|
+
*
|
|
88
|
+
* @summary Responds with the HTTP methods allowed for the endpoint.
|
|
89
|
+
* @param {*} [options] Override http request option.
|
|
90
|
+
* @throws {RequiredError}
|
|
91
|
+
*/
|
|
92
|
+
apiV2HandlesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
93
|
+
/**
|
|
94
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
95
|
+
* @summary Retrieves all values of a handle by its PID.
|
|
96
|
+
* @param {HandleApiGetHandleRequest} requestParameters Request parameters.
|
|
97
|
+
* @param {*} [options] Override http request option.
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
getHandle(requestParameters: HandleApiGetHandleRequest, options?: AxiosRequestConfig): AxiosPromise<HandleDtoResponse>;
|
|
101
|
+
/**
|
|
102
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
103
|
+
* @summary Updates a handle.
|
|
104
|
+
* @param {HandleApiUpdateHandleRequest} requestParameters Request parameters.
|
|
105
|
+
* @param {*} [options] Override http request option.
|
|
106
|
+
* @throws {RequiredError}
|
|
107
|
+
*/
|
|
108
|
+
updateHandle(requestParameters: HandleApiUpdateHandleRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
109
|
+
};
|
|
110
|
+
/**
|
|
111
|
+
* Request parameters for getHandle operation in HandleApi.
|
|
112
|
+
* @export
|
|
113
|
+
* @interface HandleApiGetHandleRequest
|
|
114
|
+
*/
|
|
115
|
+
export interface HandleApiGetHandleRequest {
|
|
116
|
+
/**
|
|
117
|
+
* The prefix of the PID
|
|
118
|
+
* @type {string}
|
|
119
|
+
* @memberof HandleApiGetHandle
|
|
120
|
+
*/
|
|
121
|
+
readonly prefix: string;
|
|
122
|
+
/**
|
|
123
|
+
* The suffix of the PID
|
|
124
|
+
* @type {string}
|
|
125
|
+
* @memberof HandleApiGetHandle
|
|
126
|
+
*/
|
|
127
|
+
readonly suffix: string;
|
|
128
|
+
}
|
|
129
|
+
/**
|
|
130
|
+
* Request parameters for updateHandle operation in HandleApi.
|
|
131
|
+
* @export
|
|
132
|
+
* @interface HandleApiUpdateHandleRequest
|
|
133
|
+
*/
|
|
134
|
+
export interface HandleApiUpdateHandleRequest {
|
|
135
|
+
/**
|
|
136
|
+
* The prefix of the PID
|
|
137
|
+
* @type {string}
|
|
138
|
+
* @memberof HandleApiUpdateHandle
|
|
139
|
+
*/
|
|
140
|
+
readonly prefix: string;
|
|
141
|
+
/**
|
|
142
|
+
* The suffix of the PID
|
|
143
|
+
* @type {string}
|
|
144
|
+
* @memberof HandleApiUpdateHandle
|
|
145
|
+
*/
|
|
146
|
+
readonly suffix: string;
|
|
147
|
+
/**
|
|
148
|
+
* The handle for updating.
|
|
149
|
+
* @type {HandleForUpdateDto}
|
|
150
|
+
* @memberof HandleApiUpdateHandle
|
|
151
|
+
*/
|
|
152
|
+
readonly handleForUpdateDto?: HandleForUpdateDto;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* HandleApi - object-oriented interface
|
|
156
|
+
* @export
|
|
157
|
+
* @class HandleApi
|
|
158
|
+
* @extends {BaseAPI}
|
|
159
|
+
*/
|
|
160
|
+
export declare class HandleApi extends BaseAPI {
|
|
161
|
+
/**
|
|
162
|
+
*
|
|
163
|
+
* @summary Responds with the HTTP methods allowed for the endpoint.
|
|
164
|
+
* @param {*} [options] Override http request option.
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
* @memberof HandleApi
|
|
167
|
+
*/
|
|
168
|
+
apiV2HandlesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
169
|
+
/**
|
|
170
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
171
|
+
* @summary Retrieves all values of a handle by its PID.
|
|
172
|
+
* @param {HandleApiGetHandleRequest} requestParameters Request parameters.
|
|
173
|
+
* @param {*} [options] Override http request option.
|
|
174
|
+
* @throws {RequiredError}
|
|
175
|
+
* @memberof HandleApi
|
|
176
|
+
*/
|
|
177
|
+
getHandle(requestParameters: HandleApiGetHandleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<HandleDtoResponse, any>>;
|
|
178
|
+
/**
|
|
179
|
+
* <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
|
|
180
|
+
* @summary Updates a handle.
|
|
181
|
+
* @param {HandleApiUpdateHandleRequest} requestParameters Request parameters.
|
|
182
|
+
* @param {*} [options] Override http request option.
|
|
183
|
+
* @throws {RequiredError}
|
|
184
|
+
* @memberof HandleApi
|
|
185
|
+
*/
|
|
186
|
+
updateHandle(requestParameters: HandleApiUpdateHandleRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
187
|
+
}
|
|
@@ -27,7 +27,7 @@ export declare const LanguageApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
27
27
|
*/
|
|
28
28
|
apiV2LanguagesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
31
31
|
* @summary Retrieves a language by ID.
|
|
32
32
|
* @param {string} languageId The ID of the language.
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
@@ -35,7 +35,7 @@ export declare const LanguageApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
35
35
|
*/
|
|
36
36
|
getLanguage: (languageId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
39
39
|
* @summary Retrieves all languages.
|
|
40
40
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
41
41
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -58,7 +58,7 @@ export declare const LanguageApiFp: (configuration?: Configuration) => {
|
|
|
58
58
|
*/
|
|
59
59
|
apiV2LanguagesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
62
62
|
* @summary Retrieves a language by ID.
|
|
63
63
|
* @param {string} languageId The ID of the language.
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export declare const LanguageApiFp: (configuration?: Configuration) => {
|
|
|
66
66
|
*/
|
|
67
67
|
getLanguage(languageId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LanguageDtoResponse>>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
70
70
|
* @summary Retrieves all languages.
|
|
71
71
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
72
72
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -89,7 +89,7 @@ export declare const LanguageApiFactory: (configuration?: Configuration, basePat
|
|
|
89
89
|
*/
|
|
90
90
|
apiV2LanguagesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
93
93
|
* @summary Retrieves a language by ID.
|
|
94
94
|
* @param {LanguageApiGetLanguageRequest} requestParameters Request parameters.
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ export declare const LanguageApiFactory: (configuration?: Configuration, basePat
|
|
|
97
97
|
*/
|
|
98
98
|
getLanguage(requestParameters: LanguageApiGetLanguageRequest, options?: AxiosRequestConfig): AxiosPromise<LanguageDtoResponse>;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
101
101
|
* @summary Retrieves all languages.
|
|
102
102
|
* @param {LanguageApiGetLanguagesRequest} requestParameters Request parameters.
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
@@ -159,7 +159,7 @@ export declare class LanguageApi extends BaseAPI {
|
|
|
159
159
|
*/
|
|
160
160
|
apiV2LanguagesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
161
161
|
/**
|
|
162
|
-
*
|
|
162
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
163
163
|
* @summary Retrieves a language by ID.
|
|
164
164
|
* @param {LanguageApiGetLanguageRequest} requestParameters Request parameters.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
@@ -168,7 +168,7 @@ export declare class LanguageApi extends BaseAPI {
|
|
|
168
168
|
*/
|
|
169
169
|
getLanguage(requestParameters: LanguageApiGetLanguageRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LanguageDtoResponse, any>>;
|
|
170
170
|
/**
|
|
171
|
-
*
|
|
171
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
172
172
|
* @summary Retrieves all languages.
|
|
173
173
|
* @param {LanguageApiGetLanguagesRequest} requestParameters Request parameters.
|
|
174
174
|
* @param {*} [options] Override http request option.
|
|
@@ -27,7 +27,7 @@ export declare const LicenseApiAxiosParamCreator: (configuration?: Configuration
|
|
|
27
27
|
*/
|
|
28
28
|
apiV2LicensesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
31
31
|
* @summary Retrieves a license with the specified ID.
|
|
32
32
|
* @param {string} licenseId The ID of the license.
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
@@ -35,7 +35,7 @@ export declare const LicenseApiAxiosParamCreator: (configuration?: Configuration
|
|
|
35
35
|
*/
|
|
36
36
|
getLicense: (licenseId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
39
39
|
* @summary Retrieves all licenses.
|
|
40
40
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
41
41
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -58,7 +58,7 @@ export declare const LicenseApiFp: (configuration?: Configuration) => {
|
|
|
58
58
|
*/
|
|
59
59
|
apiV2LicensesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
62
62
|
* @summary Retrieves a license with the specified ID.
|
|
63
63
|
* @param {string} licenseId The ID of the license.
|
|
64
64
|
* @param {*} [options] Override http request option.
|
|
@@ -66,7 +66,7 @@ export declare const LicenseApiFp: (configuration?: Configuration) => {
|
|
|
66
66
|
*/
|
|
67
67
|
getLicense(licenseId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LicenseDtoResponse>>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
70
70
|
* @summary Retrieves all licenses.
|
|
71
71
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
72
72
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
@@ -89,7 +89,7 @@ export declare const LicenseApiFactory: (configuration?: Configuration, basePath
|
|
|
89
89
|
*/
|
|
90
90
|
apiV2LicensesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
93
93
|
* @summary Retrieves a license with the specified ID.
|
|
94
94
|
* @param {LicenseApiGetLicenseRequest} requestParameters Request parameters.
|
|
95
95
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ export declare const LicenseApiFactory: (configuration?: Configuration, basePath
|
|
|
97
97
|
*/
|
|
98
98
|
getLicense(requestParameters: LicenseApiGetLicenseRequest, options?: AxiosRequestConfig): AxiosPromise<LicenseDtoResponse>;
|
|
99
99
|
/**
|
|
100
|
-
*
|
|
100
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
101
101
|
* @summary Retrieves all licenses.
|
|
102
102
|
* @param {LicenseApiGetLicensesRequest} requestParameters Request parameters.
|
|
103
103
|
* @param {*} [options] Override http request option.
|
|
@@ -159,7 +159,7 @@ export declare class LicenseApi extends BaseAPI {
|
|
|
159
159
|
*/
|
|
160
160
|
apiV2LicensesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
161
161
|
/**
|
|
162
|
-
*
|
|
162
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
163
163
|
* @summary Retrieves a license with the specified ID.
|
|
164
164
|
* @param {LicenseApiGetLicenseRequest} requestParameters Request parameters.
|
|
165
165
|
* @param {*} [options] Override http request option.
|
|
@@ -168,7 +168,7 @@ export declare class LicenseApi extends BaseAPI {
|
|
|
168
168
|
*/
|
|
169
169
|
getLicense(requestParameters: LicenseApiGetLicenseRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LicenseDtoResponse, any>>;
|
|
170
170
|
/**
|
|
171
|
-
*
|
|
171
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
172
172
|
* @summary Retrieves all licenses.
|
|
173
173
|
* @param {LicenseApiGetLicensesRequest} requestParameters Request parameters.
|
|
174
174
|
* @param {*} [options] Override http request option.
|
|
@@ -26,7 +26,7 @@ export declare const MaintenanceApiAxiosParamCreator: (configuration?: Configura
|
|
|
26
26
|
*/
|
|
27
27
|
apiV2MaintenancesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28
28
|
/**
|
|
29
|
-
*
|
|
29
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
30
30
|
* @summary Retrieves the current maintenance messages.
|
|
31
31
|
* @param {*} [options] Override http request option.
|
|
32
32
|
* @throws {RequiredError}
|
|
@@ -46,7 +46,7 @@ export declare const MaintenanceApiFp: (configuration?: Configuration) => {
|
|
|
46
46
|
*/
|
|
47
47
|
apiV2MaintenancesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
48
48
|
/**
|
|
49
|
-
*
|
|
49
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
50
50
|
* @summary Retrieves the current maintenance messages.
|
|
51
51
|
* @param {*} [options] Override http request option.
|
|
52
52
|
* @throws {RequiredError}
|
|
@@ -66,7 +66,7 @@ export declare const MaintenanceApiFactory: (configuration?: Configuration, base
|
|
|
66
66
|
*/
|
|
67
67
|
apiV2MaintenancesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
68
68
|
/**
|
|
69
|
-
*
|
|
69
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
70
70
|
* @summary Retrieves the current maintenance messages.
|
|
71
71
|
* @param {*} [options] Override http request option.
|
|
72
72
|
* @throws {RequiredError}
|
|
@@ -89,7 +89,7 @@ export declare class MaintenanceApi extends BaseAPI {
|
|
|
89
89
|
*/
|
|
90
90
|
apiV2MaintenancesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
91
91
|
/**
|
|
92
|
-
*
|
|
92
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
93
93
|
* @summary Retrieves the current maintenance messages.
|
|
94
94
|
* @param {*} [options] Override http request option.
|
|
95
95
|
* @throws {RequiredError}
|
|
@@ -27,7 +27,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
27
27
|
*/
|
|
28
28
|
apiV2OrganizationsOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
31
31
|
* @summary Retrieves an organization.
|
|
32
32
|
* @param {string} organizationRorUri The parameters for organization filtering and pagination.
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
@@ -35,16 +35,17 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
|
|
|
35
35
|
*/
|
|
36
36
|
getOrganization: (organizationRorUri: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
38
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
39
39
|
* @summary Retrieves all organizations.
|
|
40
40
|
* @param {string} [searchTerm] Gets or sets the search term used to filter organizations.
|
|
41
|
+
* @param {boolean} [filterByPublicationService] Gets or sets the option to find only organizations having the publication service set.
|
|
41
42
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
42
43
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
43
44
|
* @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
|
|
44
45
|
* @param {*} [options] Override http request option.
|
|
45
46
|
* @throws {RequiredError}
|
|
46
47
|
*/
|
|
47
|
-
getOrganizations: (searchTerm?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
|
+
getOrganizations: (searchTerm?: string, filterByPublicationService?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
49
|
};
|
|
49
50
|
/**
|
|
50
51
|
* OrganizationApi - functional programming interface
|
|
@@ -59,7 +60,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
59
60
|
*/
|
|
60
61
|
apiV2OrganizationsOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
61
62
|
/**
|
|
62
|
-
*
|
|
63
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
63
64
|
* @summary Retrieves an organization.
|
|
64
65
|
* @param {string} organizationRorUri The parameters for organization filtering and pagination.
|
|
65
66
|
* @param {*} [options] Override http request option.
|
|
@@ -67,16 +68,17 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
|
|
|
67
68
|
*/
|
|
68
69
|
getOrganization(organizationRorUri: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationDtoResponse>>;
|
|
69
70
|
/**
|
|
70
|
-
*
|
|
71
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
71
72
|
* @summary Retrieves all organizations.
|
|
72
73
|
* @param {string} [searchTerm] Gets or sets the search term used to filter organizations.
|
|
74
|
+
* @param {boolean} [filterByPublicationService] Gets or sets the option to find only organizations having the publication service set.
|
|
73
75
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
74
76
|
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
75
77
|
* @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by a order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
|
|
76
78
|
* @param {*} [options] Override http request option.
|
|
77
79
|
* @throws {RequiredError}
|
|
78
80
|
*/
|
|
79
|
-
getOrganizations(searchTerm?: string, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationDtoPagedResponse>>;
|
|
81
|
+
getOrganizations(searchTerm?: string, filterByPublicationService?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrganizationDtoPagedResponse>>;
|
|
80
82
|
};
|
|
81
83
|
/**
|
|
82
84
|
* OrganizationApi - factory interface
|
|
@@ -91,7 +93,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
91
93
|
*/
|
|
92
94
|
apiV2OrganizationsOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
93
95
|
/**
|
|
94
|
-
*
|
|
96
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
95
97
|
* @summary Retrieves an organization.
|
|
96
98
|
* @param {OrganizationApiGetOrganizationRequest} requestParameters Request parameters.
|
|
97
99
|
* @param {*} [options] Override http request option.
|
|
@@ -99,7 +101,7 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
|
|
|
99
101
|
*/
|
|
100
102
|
getOrganization(requestParameters: OrganizationApiGetOrganizationRequest, options?: AxiosRequestConfig): AxiosPromise<OrganizationDtoResponse>;
|
|
101
103
|
/**
|
|
102
|
-
*
|
|
104
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
103
105
|
* @summary Retrieves all organizations.
|
|
104
106
|
* @param {OrganizationApiGetOrganizationsRequest} requestParameters Request parameters.
|
|
105
107
|
* @param {*} [options] Override http request option.
|
|
@@ -132,6 +134,12 @@ export interface OrganizationApiGetOrganizationsRequest {
|
|
|
132
134
|
* @memberof OrganizationApiGetOrganizations
|
|
133
135
|
*/
|
|
134
136
|
readonly searchTerm?: string;
|
|
137
|
+
/**
|
|
138
|
+
* Gets or sets the option to find only organizations having the publication service set.
|
|
139
|
+
* @type {boolean}
|
|
140
|
+
* @memberof OrganizationApiGetOrganizations
|
|
141
|
+
*/
|
|
142
|
+
readonly filterByPublicationService?: boolean;
|
|
135
143
|
/**
|
|
136
144
|
* The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
137
145
|
* @type {number}
|
|
@@ -167,7 +175,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
167
175
|
*/
|
|
168
176
|
apiV2OrganizationsOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
169
177
|
/**
|
|
170
|
-
*
|
|
178
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
171
179
|
* @summary Retrieves an organization.
|
|
172
180
|
* @param {OrganizationApiGetOrganizationRequest} requestParameters Request parameters.
|
|
173
181
|
* @param {*} [options] Override http request option.
|
|
@@ -176,7 +184,7 @@ export declare class OrganizationApi extends BaseAPI {
|
|
|
176
184
|
*/
|
|
177
185
|
getOrganization(requestParameters: OrganizationApiGetOrganizationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationDtoResponse, any>>;
|
|
178
186
|
/**
|
|
179
|
-
*
|
|
187
|
+
* <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
|
|
180
188
|
* @summary Retrieves all organizations.
|
|
181
189
|
* @param {OrganizationApiGetOrganizationsRequest} requestParameters Request parameters.
|
|
182
190
|
* @param {*} [options] Override http request option.
|