@coscine/api-client 3.4.1 → 3.4.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +227 -177
- package/dist/types/Coscine.Api/@coscine/api/admin-api.d.ts +125 -46
- package/dist/types/Coscine.Api/@coscine/model/index.d.ts +6 -3
- package/dist/types/Coscine.Api/@coscine/model/metadata-update-admin-parameters.d.ts +0 -6
- package/dist/types/Coscine.Api/@coscine/model/project-admin-dto-paged-response.d.ts +50 -0
- package/dist/types/Coscine.Api/@coscine/model/project-admin-dto.d.ts +7 -0
- package/dist/types/Coscine.Api/@coscine/model/rdf-patch-document-dto.d.ts +25 -0
- package/dist/types/Coscine.Api/@coscine/model/rdf-patch-operation-dto.d.ts +32 -0
- package/dist/types/Coscine.Api/@coscine/model/rdf-patch-operation-type.d.ts +21 -0
- package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto-paged-response.d.ts +50 -0
- package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto.d.ts +17 -3
- package/dist/types/Coscine.Api/@coscine/model/resource-dto.d.ts +10 -3
- package/dist/types/Coscine.Api/@coscine/model/resource-for-creation-dto.d.ts +8 -2
- package/dist/types/Coscine.Api/@coscine/model/resource-for-update-dto.d.ts +8 -2
- package/dist/types/Coscine.Api/@coscine/model/resource-type-information-dto.d.ts +6 -0
- package/dist/types/Coscine.Api/@coscine/model/user-dto-paged-response.d.ts +50 -0
- package/dist/types/Coscine.Api/@coscine/model/user-dto.d.ts +6 -0
- package/dist/types/apis.d.ts +5 -4
- package/dist/types/index.d.ts +10 -8
- package/package.json +1 -1
|
@@ -13,11 +13,12 @@ import type { Configuration } from '../../configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../../base';
|
|
15
15
|
import { MetadataUpdateAdminParameters } from '../../@coscine/model';
|
|
16
|
-
import {
|
|
16
|
+
import { ProjectAdminDtoPagedResponse } from '../../@coscine/model';
|
|
17
17
|
import { RdfDefinitionDtoResponse } from '../../@coscine/model';
|
|
18
18
|
import { RdfFormat } from '../../@coscine/model';
|
|
19
|
-
import {
|
|
20
|
-
import {
|
|
19
|
+
import { RdfPatchDocumentDto } from '../../@coscine/model';
|
|
20
|
+
import { ResourceAdminDtoPagedResponse } from '../../@coscine/model';
|
|
21
|
+
import { UserDtoPagedResponse } from '../../@coscine/model';
|
|
21
22
|
/**
|
|
22
23
|
* AdminApi - axios parameter creator
|
|
23
24
|
* @export
|
|
@@ -35,52 +36,64 @@ export declare const AdminApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
35
36
|
* @summary Retrieves all projects.
|
|
36
37
|
* @param {boolean} [topLevel] Gets or sets a value indicating whether to filter top-level projects.
|
|
37
38
|
* @param {boolean} [includeDeleted] Gets or sets a value indicating whether to include deleted projects in the results.
|
|
39
|
+
* @param {boolean} [includeQuotas] Gets or sets a value indicating whether to include quotas in the results.
|
|
40
|
+
* @param {number} [pageSize] Number of items per page. The maximum number of items per page is `250`.
|
|
38
41
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
39
|
-
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
40
42
|
* @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.
|
|
41
43
|
* @param {*} [options] Override http request option.
|
|
42
44
|
* @throws {RequiredError}
|
|
43
45
|
*/
|
|
44
|
-
getAllProjects: (topLevel?: boolean, includeDeleted?: boolean,
|
|
46
|
+
getAllProjects: (topLevel?: boolean, includeDeleted?: boolean, includeQuotas?: boolean, pageSize?: number, pageNumber?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
47
|
/**
|
|
46
48
|
*
|
|
47
49
|
* @summary Retrieves all resources.
|
|
48
|
-
* @param {boolean} [includeDeleted]
|
|
50
|
+
* @param {boolean} [includeDeleted] Value indicating whether to include deleted resources.
|
|
51
|
+
* @param {boolean} [includeQuotas] Value indicating whether to include individual resource quotas.
|
|
52
|
+
* @param {number} [pageSize] Number of items per page. The maximum number of items per page is `250`.
|
|
49
53
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
50
|
-
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
51
54
|
* @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.
|
|
52
55
|
* @param {*} [options] Override http request option.
|
|
53
56
|
* @throws {RequiredError}
|
|
54
57
|
*/
|
|
55
|
-
getAllResources: (includeDeleted?: boolean,
|
|
58
|
+
getAllResources: (includeDeleted?: boolean, includeQuotas?: boolean, pageSize?: number, pageNumber?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56
59
|
/**
|
|
57
60
|
*
|
|
58
61
|
* @summary Retrieves all users.
|
|
59
62
|
* @param {boolean} [tosAccepted] Gets or sets a value indicating whether the terms of service have been accepted by the user.
|
|
63
|
+
* @param {number} [pageSize] Number of items per page. The maximum number of items per page is `250`.
|
|
60
64
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
61
|
-
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
62
65
|
* @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.
|
|
63
66
|
* @param {*} [options] Override http request option.
|
|
64
67
|
* @throws {RequiredError}
|
|
65
68
|
*/
|
|
66
|
-
getAllUsers: (tosAccepted?: boolean,
|
|
69
|
+
getAllUsers: (tosAccepted?: boolean, pageSize?: number, pageNumber?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
70
|
/**
|
|
68
71
|
*
|
|
69
72
|
* @summary Gets a metadata graph.
|
|
70
|
-
* @param {string}
|
|
73
|
+
* @param {string} graph The absolute URI of the graph to get.
|
|
71
74
|
* @param {RdfFormat} [format] Gets or sets the RDF format.
|
|
72
75
|
* @param {*} [options] Override http request option.
|
|
73
76
|
* @throws {RequiredError}
|
|
74
77
|
*/
|
|
75
|
-
getMetadataGraph: (
|
|
78
|
+
getMetadataGraph: (graph: string, format?: RdfFormat, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
79
|
+
/**
|
|
80
|
+
*
|
|
81
|
+
* @summary Patches a metadata graph.
|
|
82
|
+
* @param {string} graph The absolute URI of the graph to patch.
|
|
83
|
+
* @param {RdfPatchDocumentDto} [rdfPatchDocumentDto] The well-formed RDF patch document containing the changes as operations to be applied to the graph.
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
patchMetadata: (graph: string, rdfPatchDocumentDto?: RdfPatchDocumentDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
76
88
|
/**
|
|
77
89
|
*
|
|
78
90
|
* @summary Updates a metadata graph.
|
|
91
|
+
* @param {string} graph The absolute URI of the graph to update.
|
|
79
92
|
* @param {MetadataUpdateAdminParameters} [metadataUpdateAdminParameters] The metadata update admin parameters.
|
|
80
93
|
* @param {*} [options] Override http request option.
|
|
81
94
|
* @throws {RequiredError}
|
|
82
95
|
*/
|
|
83
|
-
updateMetadataGraph: (metadataUpdateAdminParameters?: MetadataUpdateAdminParameters, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
96
|
+
updateMetadataGraph: (graph: string, metadataUpdateAdminParameters?: MetadataUpdateAdminParameters, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
84
97
|
};
|
|
85
98
|
/**
|
|
86
99
|
* AdminApi - functional programming interface
|
|
@@ -99,52 +112,64 @@ export declare const AdminApiFp: (configuration?: Configuration) => {
|
|
|
99
112
|
* @summary Retrieves all projects.
|
|
100
113
|
* @param {boolean} [topLevel] Gets or sets a value indicating whether to filter top-level projects.
|
|
101
114
|
* @param {boolean} [includeDeleted] Gets or sets a value indicating whether to include deleted projects in the results.
|
|
115
|
+
* @param {boolean} [includeQuotas] Gets or sets a value indicating whether to include quotas in the results.
|
|
116
|
+
* @param {number} [pageSize] Number of items per page. The maximum number of items per page is `250`.
|
|
102
117
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
103
|
-
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
104
118
|
* @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.
|
|
105
119
|
* @param {*} [options] Override http request option.
|
|
106
120
|
* @throws {RequiredError}
|
|
107
121
|
*/
|
|
108
|
-
getAllProjects(topLevel?: boolean, includeDeleted?: boolean,
|
|
122
|
+
getAllProjects(topLevel?: boolean, includeDeleted?: boolean, includeQuotas?: boolean, pageSize?: number, pageNumber?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectAdminDtoPagedResponse>>;
|
|
109
123
|
/**
|
|
110
124
|
*
|
|
111
125
|
* @summary Retrieves all resources.
|
|
112
|
-
* @param {boolean} [includeDeleted]
|
|
126
|
+
* @param {boolean} [includeDeleted] Value indicating whether to include deleted resources.
|
|
127
|
+
* @param {boolean} [includeQuotas] Value indicating whether to include individual resource quotas.
|
|
128
|
+
* @param {number} [pageSize] Number of items per page. The maximum number of items per page is `250`.
|
|
113
129
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
114
|
-
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
115
130
|
* @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.
|
|
116
131
|
* @param {*} [options] Override http request option.
|
|
117
132
|
* @throws {RequiredError}
|
|
118
133
|
*/
|
|
119
|
-
getAllResources(includeDeleted?: boolean,
|
|
134
|
+
getAllResources(includeDeleted?: boolean, includeQuotas?: boolean, pageSize?: number, pageNumber?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResourceAdminDtoPagedResponse>>;
|
|
120
135
|
/**
|
|
121
136
|
*
|
|
122
137
|
* @summary Retrieves all users.
|
|
123
138
|
* @param {boolean} [tosAccepted] Gets or sets a value indicating whether the terms of service have been accepted by the user.
|
|
139
|
+
* @param {number} [pageSize] Number of items per page. The maximum number of items per page is `250`.
|
|
124
140
|
* @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
125
|
-
* @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
|
|
126
141
|
* @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.
|
|
127
142
|
* @param {*} [options] Override http request option.
|
|
128
143
|
* @throws {RequiredError}
|
|
129
144
|
*/
|
|
130
|
-
getAllUsers(tosAccepted?: boolean,
|
|
145
|
+
getAllUsers(tosAccepted?: boolean, pageSize?: number, pageNumber?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDtoPagedResponse>>;
|
|
131
146
|
/**
|
|
132
147
|
*
|
|
133
148
|
* @summary Gets a metadata graph.
|
|
134
|
-
* @param {string}
|
|
149
|
+
* @param {string} graph The absolute URI of the graph to get.
|
|
135
150
|
* @param {RdfFormat} [format] Gets or sets the RDF format.
|
|
136
151
|
* @param {*} [options] Override http request option.
|
|
137
152
|
* @throws {RequiredError}
|
|
138
153
|
*/
|
|
139
|
-
getMetadataGraph(
|
|
154
|
+
getMetadataGraph(graph: string, format?: RdfFormat, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RdfDefinitionDtoResponse>>;
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @summary Patches a metadata graph.
|
|
158
|
+
* @param {string} graph The absolute URI of the graph to patch.
|
|
159
|
+
* @param {RdfPatchDocumentDto} [rdfPatchDocumentDto] The well-formed RDF patch document containing the changes as operations to be applied to the graph.
|
|
160
|
+
* @param {*} [options] Override http request option.
|
|
161
|
+
* @throws {RequiredError}
|
|
162
|
+
*/
|
|
163
|
+
patchMetadata(graph: string, rdfPatchDocumentDto?: RdfPatchDocumentDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
140
164
|
/**
|
|
141
165
|
*
|
|
142
166
|
* @summary Updates a metadata graph.
|
|
167
|
+
* @param {string} graph The absolute URI of the graph to update.
|
|
143
168
|
* @param {MetadataUpdateAdminParameters} [metadataUpdateAdminParameters] The metadata update admin parameters.
|
|
144
169
|
* @param {*} [options] Override http request option.
|
|
145
170
|
* @throws {RequiredError}
|
|
146
171
|
*/
|
|
147
|
-
updateMetadataGraph(metadataUpdateAdminParameters?: MetadataUpdateAdminParameters, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
172
|
+
updateMetadataGraph(graph: string, metadataUpdateAdminParameters?: MetadataUpdateAdminParameters, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
148
173
|
};
|
|
149
174
|
/**
|
|
150
175
|
* AdminApi - factory interface
|
|
@@ -165,7 +190,7 @@ export declare const AdminApiFactory: (configuration?: Configuration, basePath?:
|
|
|
165
190
|
* @param {*} [options] Override http request option.
|
|
166
191
|
* @throws {RequiredError}
|
|
167
192
|
*/
|
|
168
|
-
getAllProjects(requestParameters?: AdminApiGetAllProjectsRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
193
|
+
getAllProjects(requestParameters?: AdminApiGetAllProjectsRequest, options?: AxiosRequestConfig): AxiosPromise<ProjectAdminDtoPagedResponse>;
|
|
169
194
|
/**
|
|
170
195
|
*
|
|
171
196
|
* @summary Retrieves all resources.
|
|
@@ -173,7 +198,7 @@ export declare const AdminApiFactory: (configuration?: Configuration, basePath?:
|
|
|
173
198
|
* @param {*} [options] Override http request option.
|
|
174
199
|
* @throws {RequiredError}
|
|
175
200
|
*/
|
|
176
|
-
getAllResources(requestParameters?: AdminApiGetAllResourcesRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
201
|
+
getAllResources(requestParameters?: AdminApiGetAllResourcesRequest, options?: AxiosRequestConfig): AxiosPromise<ResourceAdminDtoPagedResponse>;
|
|
177
202
|
/**
|
|
178
203
|
*
|
|
179
204
|
* @summary Retrieves all users.
|
|
@@ -181,7 +206,7 @@ export declare const AdminApiFactory: (configuration?: Configuration, basePath?:
|
|
|
181
206
|
* @param {*} [options] Override http request option.
|
|
182
207
|
* @throws {RequiredError}
|
|
183
208
|
*/
|
|
184
|
-
getAllUsers(requestParameters?: AdminApiGetAllUsersRequest, options?: AxiosRequestConfig): AxiosPromise<
|
|
209
|
+
getAllUsers(requestParameters?: AdminApiGetAllUsersRequest, options?: AxiosRequestConfig): AxiosPromise<UserDtoPagedResponse>;
|
|
185
210
|
/**
|
|
186
211
|
*
|
|
187
212
|
* @summary Gets a metadata graph.
|
|
@@ -190,6 +215,14 @@ export declare const AdminApiFactory: (configuration?: Configuration, basePath?:
|
|
|
190
215
|
* @throws {RequiredError}
|
|
191
216
|
*/
|
|
192
217
|
getMetadataGraph(requestParameters: AdminApiGetMetadataGraphRequest, options?: AxiosRequestConfig): AxiosPromise<RdfDefinitionDtoResponse>;
|
|
218
|
+
/**
|
|
219
|
+
*
|
|
220
|
+
* @summary Patches a metadata graph.
|
|
221
|
+
* @param {AdminApiPatchMetadataRequest} requestParameters Request parameters.
|
|
222
|
+
* @param {*} [options] Override http request option.
|
|
223
|
+
* @throws {RequiredError}
|
|
224
|
+
*/
|
|
225
|
+
patchMetadata(requestParameters: AdminApiPatchMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
193
226
|
/**
|
|
194
227
|
*
|
|
195
228
|
* @summary Updates a metadata graph.
|
|
@@ -197,7 +230,7 @@ export declare const AdminApiFactory: (configuration?: Configuration, basePath?:
|
|
|
197
230
|
* @param {*} [options] Override http request option.
|
|
198
231
|
* @throws {RequiredError}
|
|
199
232
|
*/
|
|
200
|
-
updateMetadataGraph(requestParameters
|
|
233
|
+
updateMetadataGraph(requestParameters: AdminApiUpdateMetadataGraphRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
201
234
|
};
|
|
202
235
|
/**
|
|
203
236
|
* Request parameters for getAllProjects operation in AdminApi.
|
|
@@ -218,17 +251,23 @@ export interface AdminApiGetAllProjectsRequest {
|
|
|
218
251
|
*/
|
|
219
252
|
readonly includeDeleted?: boolean;
|
|
220
253
|
/**
|
|
221
|
-
*
|
|
222
|
-
* @type {
|
|
254
|
+
* Gets or sets a value indicating whether to include quotas in the results.
|
|
255
|
+
* @type {boolean}
|
|
223
256
|
* @memberof AdminApiGetAllProjects
|
|
224
257
|
*/
|
|
225
|
-
readonly
|
|
258
|
+
readonly includeQuotas?: boolean;
|
|
226
259
|
/**
|
|
227
|
-
*
|
|
260
|
+
* Number of items per page. The maximum number of items per page is `250`.
|
|
228
261
|
* @type {number}
|
|
229
262
|
* @memberof AdminApiGetAllProjects
|
|
230
263
|
*/
|
|
231
264
|
readonly pageSize?: number;
|
|
265
|
+
/**
|
|
266
|
+
* The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
267
|
+
* @type {number}
|
|
268
|
+
* @memberof AdminApiGetAllProjects
|
|
269
|
+
*/
|
|
270
|
+
readonly pageNumber?: number;
|
|
232
271
|
/**
|
|
233
272
|
* 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.
|
|
234
273
|
* @type {string}
|
|
@@ -243,23 +282,29 @@ export interface AdminApiGetAllProjectsRequest {
|
|
|
243
282
|
*/
|
|
244
283
|
export interface AdminApiGetAllResourcesRequest {
|
|
245
284
|
/**
|
|
246
|
-
*
|
|
285
|
+
* Value indicating whether to include deleted resources.
|
|
247
286
|
* @type {boolean}
|
|
248
287
|
* @memberof AdminApiGetAllResources
|
|
249
288
|
*/
|
|
250
289
|
readonly includeDeleted?: boolean;
|
|
251
290
|
/**
|
|
252
|
-
*
|
|
253
|
-
* @type {
|
|
291
|
+
* Value indicating whether to include individual resource quotas.
|
|
292
|
+
* @type {boolean}
|
|
254
293
|
* @memberof AdminApiGetAllResources
|
|
255
294
|
*/
|
|
256
|
-
readonly
|
|
295
|
+
readonly includeQuotas?: boolean;
|
|
257
296
|
/**
|
|
258
|
-
*
|
|
297
|
+
* Number of items per page. The maximum number of items per page is `250`.
|
|
259
298
|
* @type {number}
|
|
260
299
|
* @memberof AdminApiGetAllResources
|
|
261
300
|
*/
|
|
262
301
|
readonly pageSize?: number;
|
|
302
|
+
/**
|
|
303
|
+
* The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
304
|
+
* @type {number}
|
|
305
|
+
* @memberof AdminApiGetAllResources
|
|
306
|
+
*/
|
|
307
|
+
readonly pageNumber?: number;
|
|
263
308
|
/**
|
|
264
309
|
* 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.
|
|
265
310
|
* @type {string}
|
|
@@ -280,17 +325,17 @@ export interface AdminApiGetAllUsersRequest {
|
|
|
280
325
|
*/
|
|
281
326
|
readonly tosAccepted?: boolean;
|
|
282
327
|
/**
|
|
283
|
-
*
|
|
328
|
+
* Number of items per page. The maximum number of items per page is `250`.
|
|
284
329
|
* @type {number}
|
|
285
330
|
* @memberof AdminApiGetAllUsers
|
|
286
331
|
*/
|
|
287
|
-
readonly
|
|
332
|
+
readonly pageSize?: number;
|
|
288
333
|
/**
|
|
289
|
-
* The desired page
|
|
334
|
+
* The desired page number. Should be greater than or equal to 1. Default is 1.
|
|
290
335
|
* @type {number}
|
|
291
336
|
* @memberof AdminApiGetAllUsers
|
|
292
337
|
*/
|
|
293
|
-
readonly
|
|
338
|
+
readonly pageNumber?: number;
|
|
294
339
|
/**
|
|
295
340
|
* 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.
|
|
296
341
|
* @type {string}
|
|
@@ -305,11 +350,11 @@ export interface AdminApiGetAllUsersRequest {
|
|
|
305
350
|
*/
|
|
306
351
|
export interface AdminApiGetMetadataGraphRequest {
|
|
307
352
|
/**
|
|
308
|
-
*
|
|
353
|
+
* The absolute URI of the graph to get.
|
|
309
354
|
* @type {string}
|
|
310
355
|
* @memberof AdminApiGetMetadataGraph
|
|
311
356
|
*/
|
|
312
|
-
readonly
|
|
357
|
+
readonly graph: string;
|
|
313
358
|
/**
|
|
314
359
|
* Gets or sets the RDF format.
|
|
315
360
|
* @type {RdfFormat}
|
|
@@ -317,12 +362,37 @@ export interface AdminApiGetMetadataGraphRequest {
|
|
|
317
362
|
*/
|
|
318
363
|
readonly format?: RdfFormat;
|
|
319
364
|
}
|
|
365
|
+
/**
|
|
366
|
+
* Request parameters for patchMetadata operation in AdminApi.
|
|
367
|
+
* @export
|
|
368
|
+
* @interface AdminApiPatchMetadataRequest
|
|
369
|
+
*/
|
|
370
|
+
export interface AdminApiPatchMetadataRequest {
|
|
371
|
+
/**
|
|
372
|
+
* The absolute URI of the graph to patch.
|
|
373
|
+
* @type {string}
|
|
374
|
+
* @memberof AdminApiPatchMetadata
|
|
375
|
+
*/
|
|
376
|
+
readonly graph: string;
|
|
377
|
+
/**
|
|
378
|
+
* The well-formed RDF patch document containing the changes as operations to be applied to the graph.
|
|
379
|
+
* @type {RdfPatchDocumentDto}
|
|
380
|
+
* @memberof AdminApiPatchMetadata
|
|
381
|
+
*/
|
|
382
|
+
readonly rdfPatchDocumentDto?: RdfPatchDocumentDto;
|
|
383
|
+
}
|
|
320
384
|
/**
|
|
321
385
|
* Request parameters for updateMetadataGraph operation in AdminApi.
|
|
322
386
|
* @export
|
|
323
387
|
* @interface AdminApiUpdateMetadataGraphRequest
|
|
324
388
|
*/
|
|
325
389
|
export interface AdminApiUpdateMetadataGraphRequest {
|
|
390
|
+
/**
|
|
391
|
+
* The absolute URI of the graph to update.
|
|
392
|
+
* @type {string}
|
|
393
|
+
* @memberof AdminApiUpdateMetadataGraph
|
|
394
|
+
*/
|
|
395
|
+
readonly graph: string;
|
|
326
396
|
/**
|
|
327
397
|
* The metadata update admin parameters.
|
|
328
398
|
* @type {MetadataUpdateAdminParameters}
|
|
@@ -353,7 +423,7 @@ export declare class AdminApi extends BaseAPI {
|
|
|
353
423
|
* @throws {RequiredError}
|
|
354
424
|
* @memberof AdminApi
|
|
355
425
|
*/
|
|
356
|
-
getAllProjects(requestParameters?: AdminApiGetAllProjectsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
426
|
+
getAllProjects(requestParameters?: AdminApiGetAllProjectsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectAdminDtoPagedResponse, any>>;
|
|
357
427
|
/**
|
|
358
428
|
*
|
|
359
429
|
* @summary Retrieves all resources.
|
|
@@ -362,7 +432,7 @@ export declare class AdminApi extends BaseAPI {
|
|
|
362
432
|
* @throws {RequiredError}
|
|
363
433
|
* @memberof AdminApi
|
|
364
434
|
*/
|
|
365
|
-
getAllResources(requestParameters?: AdminApiGetAllResourcesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
435
|
+
getAllResources(requestParameters?: AdminApiGetAllResourcesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResourceAdminDtoPagedResponse, any>>;
|
|
366
436
|
/**
|
|
367
437
|
*
|
|
368
438
|
* @summary Retrieves all users.
|
|
@@ -371,7 +441,7 @@ export declare class AdminApi extends BaseAPI {
|
|
|
371
441
|
* @throws {RequiredError}
|
|
372
442
|
* @memberof AdminApi
|
|
373
443
|
*/
|
|
374
|
-
getAllUsers(requestParameters?: AdminApiGetAllUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
444
|
+
getAllUsers(requestParameters?: AdminApiGetAllUsersRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDtoPagedResponse, any>>;
|
|
375
445
|
/**
|
|
376
446
|
*
|
|
377
447
|
* @summary Gets a metadata graph.
|
|
@@ -381,6 +451,15 @@ export declare class AdminApi extends BaseAPI {
|
|
|
381
451
|
* @memberof AdminApi
|
|
382
452
|
*/
|
|
383
453
|
getMetadataGraph(requestParameters: AdminApiGetMetadataGraphRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RdfDefinitionDtoResponse, any>>;
|
|
454
|
+
/**
|
|
455
|
+
*
|
|
456
|
+
* @summary Patches a metadata graph.
|
|
457
|
+
* @param {AdminApiPatchMetadataRequest} requestParameters Request parameters.
|
|
458
|
+
* @param {*} [options] Override http request option.
|
|
459
|
+
* @throws {RequiredError}
|
|
460
|
+
* @memberof AdminApi
|
|
461
|
+
*/
|
|
462
|
+
patchMetadata(requestParameters: AdminApiPatchMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
384
463
|
/**
|
|
385
464
|
*
|
|
386
465
|
* @summary Updates a metadata graph.
|
|
@@ -389,5 +468,5 @@ export declare class AdminApi extends BaseAPI {
|
|
|
389
468
|
* @throws {RequiredError}
|
|
390
469
|
* @memberof AdminApi
|
|
391
470
|
*/
|
|
392
|
-
updateMetadataGraph(requestParameters
|
|
471
|
+
updateMetadataGraph(requestParameters: AdminApiUpdateMetadataGraphRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
393
472
|
}
|
|
@@ -58,7 +58,7 @@ export * from './pid-type';
|
|
|
58
58
|
export * from './pid-validation-dto';
|
|
59
59
|
export * from './pid-validation-dto-response';
|
|
60
60
|
export * from './project-admin-dto';
|
|
61
|
-
export * from './project-admin-dto-
|
|
61
|
+
export * from './project-admin-dto-paged-response';
|
|
62
62
|
export * from './project-dto';
|
|
63
63
|
export * from './project-dto-paged-response';
|
|
64
64
|
export * from './project-dto-response';
|
|
@@ -90,6 +90,9 @@ export * from './rdf-definition-dto';
|
|
|
90
90
|
export * from './rdf-definition-dto-response';
|
|
91
91
|
export * from './rdf-definition-for-manipulation-dto';
|
|
92
92
|
export * from './rdf-format';
|
|
93
|
+
export * from './rdf-patch-document-dto';
|
|
94
|
+
export * from './rdf-patch-operation-dto';
|
|
95
|
+
export * from './rdf-patch-operation-type';
|
|
93
96
|
export * from './rds-options-dto';
|
|
94
97
|
export * from './rds-resource-type-options-for-manipulation-dto';
|
|
95
98
|
export * from './rds-s3-options-dto';
|
|
@@ -97,7 +100,7 @@ export * from './rds-s3-resource-type-options-for-manipulation-dto';
|
|
|
97
100
|
export * from './rds-s3-worm-options-dto';
|
|
98
101
|
export * from './rds-s3-worm-resource-type-options-for-manipulation-dto';
|
|
99
102
|
export * from './resource-admin-dto';
|
|
100
|
-
export * from './resource-admin-dto-
|
|
103
|
+
export * from './resource-admin-dto-paged-response';
|
|
101
104
|
export * from './resource-content-page-columns-dto';
|
|
102
105
|
export * from './resource-content-page-dto';
|
|
103
106
|
export * from './resource-content-page-entries-view-dto';
|
|
@@ -136,7 +139,7 @@ export * from './title-dto-response';
|
|
|
136
139
|
export * from './title-for-user-manipulation-dto';
|
|
137
140
|
export * from './tree-data-type';
|
|
138
141
|
export * from './user-dto';
|
|
139
|
-
export * from './user-dto-
|
|
142
|
+
export * from './user-dto-paged-response';
|
|
140
143
|
export * from './user-dto-response';
|
|
141
144
|
export * from './user-email-dto';
|
|
142
145
|
export * from './user-for-update-dto';
|
|
@@ -16,12 +16,6 @@ import { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulati
|
|
|
16
16
|
* @interface MetadataUpdateAdminParameters
|
|
17
17
|
*/
|
|
18
18
|
export interface MetadataUpdateAdminParameters {
|
|
19
|
-
/**
|
|
20
|
-
* Gets or sets the URI of the graph related to the metadata.
|
|
21
|
-
* @type {string}
|
|
22
|
-
* @memberof MetadataUpdateAdminParameters
|
|
23
|
-
*/
|
|
24
|
-
'graphUri': string;
|
|
25
19
|
/**
|
|
26
20
|
*
|
|
27
21
|
* @type {RdfDefinitionForManipulationDto}
|
|
@@ -0,0 +1,50 @@
|
|
|
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 { Pagination } from './pagination';
|
|
13
|
+
import { ProjectAdminDto } from './project-admin-dto';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ProjectAdminDtoPagedResponse
|
|
18
|
+
*/
|
|
19
|
+
export interface ProjectAdminDtoPagedResponse {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {Array<ProjectAdminDto>}
|
|
23
|
+
* @memberof ProjectAdminDtoPagedResponse
|
|
24
|
+
*/
|
|
25
|
+
'data'?: Array<ProjectAdminDto> | null;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {boolean}
|
|
29
|
+
* @memberof ProjectAdminDtoPagedResponse
|
|
30
|
+
*/
|
|
31
|
+
'isSuccess'?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {number}
|
|
35
|
+
* @memberof ProjectAdminDtoPagedResponse
|
|
36
|
+
*/
|
|
37
|
+
'statusCode'?: number | null;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof ProjectAdminDtoPagedResponse
|
|
42
|
+
*/
|
|
43
|
+
'traceId'?: string | null;
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @type {Pagination}
|
|
47
|
+
* @memberof ProjectAdminDtoPagedResponse
|
|
48
|
+
*/
|
|
49
|
+
'pagination'?: Pagination;
|
|
50
|
+
}
|
|
@@ -13,6 +13,7 @@ import { DisciplineDto } from './discipline-dto';
|
|
|
13
13
|
import { OrganizationDto } from './organization-dto';
|
|
14
14
|
import { ProjectDto } from './project-dto';
|
|
15
15
|
import { ProjectMinimalDto } from './project-minimal-dto';
|
|
16
|
+
import { ProjectQuotaDto } from './project-quota-dto';
|
|
16
17
|
import { ProjectResourceMinimalDto } from './project-resource-minimal-dto';
|
|
17
18
|
import { ProjectRoleMinimalDto } from './project-role-minimal-dto';
|
|
18
19
|
import { UserMinimalDto } from './user-minimal-dto';
|
|
@@ -149,4 +150,10 @@ export interface ProjectAdminDto {
|
|
|
149
150
|
* @memberof ProjectAdminDto
|
|
150
151
|
*/
|
|
151
152
|
'projectRoles'?: Array<ProjectRoleMinimalDto>;
|
|
153
|
+
/**
|
|
154
|
+
*
|
|
155
|
+
* @type {Array<ProjectQuotaDto>}
|
|
156
|
+
* @memberof ProjectAdminDto
|
|
157
|
+
*/
|
|
158
|
+
'projectQuota'?: Array<ProjectQuotaDto>;
|
|
152
159
|
}
|
|
@@ -0,0 +1,25 @@
|
|
|
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 { RdfPatchOperationDto } from './rdf-patch-operation-dto';
|
|
13
|
+
/**
|
|
14
|
+
* Represents an RDF Patch document containing a series of operations.
|
|
15
|
+
* @export
|
|
16
|
+
* @interface RdfPatchDocumentDto
|
|
17
|
+
*/
|
|
18
|
+
export interface RdfPatchDocumentDto {
|
|
19
|
+
/**
|
|
20
|
+
* The list of operations in the RDF Patch document.
|
|
21
|
+
* @type {Array<RdfPatchOperationDto>}
|
|
22
|
+
* @memberof RdfPatchDocumentDto
|
|
23
|
+
*/
|
|
24
|
+
'operations'?: Array<RdfPatchOperationDto>;
|
|
25
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
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 { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto';
|
|
13
|
+
import { RdfPatchOperationType } from './rdf-patch-operation-type';
|
|
14
|
+
/**
|
|
15
|
+
* Represents a single operation in an RDF Patch document.
|
|
16
|
+
* @export
|
|
17
|
+
* @interface RdfPatchOperationDto
|
|
18
|
+
*/
|
|
19
|
+
export interface RdfPatchOperationDto {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {RdfPatchOperationType}
|
|
23
|
+
* @memberof RdfPatchOperationDto
|
|
24
|
+
*/
|
|
25
|
+
'operationType'?: RdfPatchOperationType;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {RdfDefinitionForManipulationDto}
|
|
29
|
+
* @memberof RdfPatchOperationDto
|
|
30
|
+
*/
|
|
31
|
+
'changes'?: RdfDefinitionForManipulationDto;
|
|
32
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
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
|
+
/**
|
|
13
|
+
* Represents the types of operations that can be performed in an RDF Patch document.
|
|
14
|
+
* @export
|
|
15
|
+
* @enum {string}
|
|
16
|
+
*/
|
|
17
|
+
export declare const RdfPatchOperationType: {
|
|
18
|
+
readonly A: "A";
|
|
19
|
+
readonly D: "D";
|
|
20
|
+
};
|
|
21
|
+
export type RdfPatchOperationType = typeof RdfPatchOperationType[keyof typeof RdfPatchOperationType];
|
|
@@ -0,0 +1,50 @@
|
|
|
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 { Pagination } from './pagination';
|
|
13
|
+
import { ResourceAdminDto } from './resource-admin-dto';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface ResourceAdminDtoPagedResponse
|
|
18
|
+
*/
|
|
19
|
+
export interface ResourceAdminDtoPagedResponse {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {Array<ResourceAdminDto>}
|
|
23
|
+
* @memberof ResourceAdminDtoPagedResponse
|
|
24
|
+
*/
|
|
25
|
+
'data'?: Array<ResourceAdminDto> | null;
|
|
26
|
+
/**
|
|
27
|
+
*
|
|
28
|
+
* @type {boolean}
|
|
29
|
+
* @memberof ResourceAdminDtoPagedResponse
|
|
30
|
+
*/
|
|
31
|
+
'isSuccess'?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @type {number}
|
|
35
|
+
* @memberof ResourceAdminDtoPagedResponse
|
|
36
|
+
*/
|
|
37
|
+
'statusCode'?: number | null;
|
|
38
|
+
/**
|
|
39
|
+
*
|
|
40
|
+
* @type {string}
|
|
41
|
+
* @memberof ResourceAdminDtoPagedResponse
|
|
42
|
+
*/
|
|
43
|
+
'traceId'?: string | null;
|
|
44
|
+
/**
|
|
45
|
+
*
|
|
46
|
+
* @type {Pagination}
|
|
47
|
+
* @memberof ResourceAdminDtoPagedResponse
|
|
48
|
+
*/
|
|
49
|
+
'pagination'?: Pagination;
|
|
50
|
+
}
|