@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.
@@ -14,7 +14,9 @@ import { DisciplineDto } from './discipline-dto';
14
14
  import { FixedValueForResourceManipulationDto } from './fixed-value-for-resource-manipulation-dto';
15
15
  import { LicenseDto } from './license-dto';
16
16
  import { ProjectResourceMinimalDto } from './project-resource-minimal-dto';
17
+ import { ResourceQuotaDto } from './resource-quota-dto';
17
18
  import { ResourceTypeDto } from './resource-type-dto';
19
+ import { UserMinimalDto } from './user-minimal-dto';
18
20
  import { VisibilityDto } from './visibility-dto';
19
21
  /**
20
22
  * Represents a Data Transfer Object (DTO) for administrative purposes with additional resource details.
@@ -76,6 +78,12 @@ export interface ResourceAdminDto {
76
78
  * @memberof ResourceAdminDto
77
79
  */
78
80
  'usageRights'?: string | null;
81
+ /**
82
+ * Setting for creating a local copy of the metadata.
83
+ * @type {boolean}
84
+ * @memberof ResourceAdminDto
85
+ */
86
+ 'metadataLocalCopy'?: boolean;
79
87
  /**
80
88
  *
81
89
  * @type {ApplicationProfileMinimalDto}
@@ -111,11 +119,11 @@ export interface ResourceAdminDto {
111
119
  */
112
120
  'dateCreated'?: string | null;
113
121
  /**
114
- * Identifier of the creator of the resource.
115
- * @type {string}
122
+ *
123
+ * @type {UserMinimalDto}
116
124
  * @memberof ResourceAdminDto
117
125
  */
118
- 'creator'?: string | null;
126
+ 'creator'?: UserMinimalDto;
119
127
  /**
120
128
  * Indicates whether the resource is archived.
121
129
  * @type {boolean}
@@ -134,4 +142,10 @@ export interface ResourceAdminDto {
134
142
  * @memberof ResourceAdminDto
135
143
  */
136
144
  'projectResources'?: Array<ProjectResourceMinimalDto>;
145
+ /**
146
+ *
147
+ * @type {ResourceQuotaDto}
148
+ * @memberof ResourceAdminDto
149
+ */
150
+ 'resourceQuota'?: ResourceQuotaDto;
137
151
  }
@@ -14,6 +14,7 @@ import { DisciplineDto } from './discipline-dto';
14
14
  import { FixedValueForResourceManipulationDto } from './fixed-value-for-resource-manipulation-dto';
15
15
  import { LicenseDto } from './license-dto';
16
16
  import { ResourceTypeDto } from './resource-type-dto';
17
+ import { UserMinimalDto } from './user-minimal-dto';
17
18
  import { VisibilityDto } from './visibility-dto';
18
19
  /**
19
20
  * Represents a Data Transfer Object (DTO) for resource details.
@@ -75,6 +76,12 @@ export interface ResourceDto {
75
76
  * @memberof ResourceDto
76
77
  */
77
78
  'usageRights'?: string | null;
79
+ /**
80
+ * Setting for creating a local copy of the metadata.
81
+ * @type {boolean}
82
+ * @memberof ResourceDto
83
+ */
84
+ 'metadataLocalCopy'?: boolean;
78
85
  /**
79
86
  *
80
87
  * @type {ApplicationProfileMinimalDto}
@@ -110,11 +117,11 @@ export interface ResourceDto {
110
117
  */
111
118
  'dateCreated'?: string | null;
112
119
  /**
113
- * Identifier of the creator of the resource.
114
- * @type {string}
120
+ *
121
+ * @type {UserMinimalDto}
115
122
  * @memberof ResourceDto
116
123
  */
117
- 'creator'?: string | null;
124
+ 'creator'?: UserMinimalDto;
118
125
  /**
119
126
  * Indicates whether the resource is archived.
120
127
  * @type {boolean}
@@ -62,11 +62,17 @@ export interface ResourceForCreationDto {
62
62
  */
63
63
  'license'?: LicenseForResourceManipulationDto;
64
64
  /**
65
- * Notes about the usage of the resource.
65
+ * The usage rights description of the resource.
66
66
  * @type {string}
67
67
  * @memberof ResourceForCreationDto
68
68
  */
69
- 'usageNote'?: string | null;
69
+ 'usageRights'?: string | null;
70
+ /**
71
+ * If a local copy for the metadata should be created.
72
+ * @type {boolean}
73
+ * @memberof ResourceForCreationDto
74
+ */
75
+ 'metadataLocalCopy'?: boolean | null;
70
76
  /**
71
77
  *
72
78
  * @type {VisibilityForResourceManipulationDto}
@@ -61,11 +61,17 @@ export interface ResourceForUpdateDto {
61
61
  */
62
62
  'license'?: LicenseForResourceManipulationDto;
63
63
  /**
64
- * Notes about the usage of the resource.
64
+ * The usage rights description of the resource.
65
65
  * @type {string}
66
66
  * @memberof ResourceForUpdateDto
67
67
  */
68
- 'usageNote'?: string | null;
68
+ 'usageRights'?: string | null;
69
+ /**
70
+ * If a local copy for the metadata should be created.
71
+ * @type {boolean}
72
+ * @memberof ResourceForUpdateDto
73
+ */
74
+ 'metadataLocalCopy'?: boolean | null;
69
75
  /**
70
76
  *
71
77
  * @type {VisibilityForResourceManipulationDto}
@@ -96,6 +96,12 @@ export interface ResourceTypeInformationDto {
96
96
  * @memberof ResourceTypeInformationDto
97
97
  */
98
98
  'canCreateLinks'?: boolean;
99
+ /**
100
+ * Indicates whether local backup of metadata is supported.
101
+ * @type {boolean}
102
+ * @memberof ResourceTypeInformationDto
103
+ */
104
+ 'canCopyLocalMetadata'?: boolean;
99
105
  /**
100
106
  * Indicates if the resource type is archived.
101
107
  * @type {boolean}
@@ -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 { UserDto } from './user-dto';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface UserDtoPagedResponse
18
+ */
19
+ export interface UserDtoPagedResponse {
20
+ /**
21
+ *
22
+ * @type {Array<UserDto>}
23
+ * @memberof UserDtoPagedResponse
24
+ */
25
+ 'data'?: Array<UserDto> | null;
26
+ /**
27
+ *
28
+ * @type {boolean}
29
+ * @memberof UserDtoPagedResponse
30
+ */
31
+ 'isSuccess'?: boolean;
32
+ /**
33
+ *
34
+ * @type {number}
35
+ * @memberof UserDtoPagedResponse
36
+ */
37
+ 'statusCode'?: number | null;
38
+ /**
39
+ *
40
+ * @type {string}
41
+ * @memberof UserDtoPagedResponse
42
+ */
43
+ 'traceId'?: string | null;
44
+ /**
45
+ *
46
+ * @type {Pagination}
47
+ * @memberof UserDtoPagedResponse
48
+ */
49
+ 'pagination'?: Pagination;
50
+ }
@@ -70,6 +70,12 @@ export interface UserDto {
70
70
  * @memberof UserDto
71
71
  */
72
72
  'areToSAccepted'?: boolean;
73
+ /**
74
+ * The date and time of the latest activity of the user.
75
+ * @type {string}
76
+ * @memberof UserDto
77
+ */
78
+ 'latestActivity'?: string | null;
73
79
  /**
74
80
  * The disciplines associated with the user.
75
81
  * @type {Array<DisciplineDto>}
@@ -6,11 +6,12 @@ declare function implementations(axios?: AxiosInstance): {
6
6
  };
7
7
  AdminApi: {
8
8
  apiV2AdminOptions(options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
9
- getAllProjects(requestParameters?: import("./Coscine.Api/api").AdminApiGetAllProjectsRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectAdminDtoIEnumerablePagedResponse>;
10
- getAllResources(requestParameters?: import("./Coscine.Api/api").AdminApiGetAllResourcesRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceAdminDtoIEnumerablePagedResponse>;
11
- getAllUsers(requestParameters?: import("./Coscine.Api/api").AdminApiGetAllUsersRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").UserDtoIEnumerablePagedResponse>;
9
+ getAllProjects(requestParameters?: import("./Coscine.Api/api").AdminApiGetAllProjectsRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectAdminDtoPagedResponse>;
10
+ getAllResources(requestParameters?: import("./Coscine.Api/api").AdminApiGetAllResourcesRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceAdminDtoPagedResponse>;
11
+ getAllUsers(requestParameters?: import("./Coscine.Api/api").AdminApiGetAllUsersRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").UserDtoPagedResponse>;
12
12
  getMetadataGraph(requestParameters: import("./Coscine.Api/api").AdminApiGetMetadataGraphRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").RdfDefinitionDtoResponse>;
13
- updateMetadataGraph(requestParameters?: import("./Coscine.Api/api").AdminApiUpdateMetadataGraphRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
13
+ patchMetadata(requestParameters: import("./Coscine.Api/api").AdminApiPatchMetadataRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
14
+ updateMetadataGraph(requestParameters: import("./Coscine.Api/api").AdminApiUpdateMetadataGraphRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
14
15
  };
15
16
  ApplicationProfileApi: {
16
17
  apiV2ApplicationProfilesOptions(options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
@@ -5,11 +5,12 @@ declare const apis: {
5
5
  };
6
6
  AdminApi: {
7
7
  apiV2AdminOptions(options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
8
- getAllProjects(requestParameters?: import("./Coscine.Api").AdminApiGetAllProjectsRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectAdminDtoIEnumerablePagedResponse>;
9
- getAllResources(requestParameters?: import("./Coscine.Api").AdminApiGetAllResourcesRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceAdminDtoIEnumerablePagedResponse>;
10
- getAllUsers(requestParameters?: import("./Coscine.Api").AdminApiGetAllUsersRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").UserDtoIEnumerablePagedResponse>;
8
+ getAllProjects(requestParameters?: import("./Coscine.Api").AdminApiGetAllProjectsRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectAdminDtoPagedResponse>;
9
+ getAllResources(requestParameters?: import("./Coscine.Api").AdminApiGetAllResourcesRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceAdminDtoPagedResponse>;
10
+ getAllUsers(requestParameters?: import("./Coscine.Api").AdminApiGetAllUsersRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").UserDtoPagedResponse>;
11
11
  getMetadataGraph(requestParameters: import("./Coscine.Api").AdminApiGetMetadataGraphRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").RdfDefinitionDtoResponse>;
12
- updateMetadataGraph(requestParameters?: import("./Coscine.Api").AdminApiUpdateMetadataGraphRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
12
+ patchMetadata(requestParameters: import("./Coscine.Api").AdminApiPatchMetadataRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
13
+ updateMetadataGraph(requestParameters: import("./Coscine.Api").AdminApiUpdateMetadataGraphRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
13
14
  };
14
15
  ApplicationProfileApi: {
15
16
  apiV2ApplicationProfilesOptions(options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
@@ -189,11 +190,12 @@ export declare const AccountApi: {
189
190
  };
190
191
  export declare const AdminApi: {
191
192
  apiV2AdminOptions(options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
192
- getAllProjects(requestParameters?: import("./Coscine.Api").AdminApiGetAllProjectsRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectAdminDtoIEnumerablePagedResponse>;
193
- getAllResources(requestParameters?: import("./Coscine.Api").AdminApiGetAllResourcesRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceAdminDtoIEnumerablePagedResponse>;
194
- getAllUsers(requestParameters?: import("./Coscine.Api").AdminApiGetAllUsersRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").UserDtoIEnumerablePagedResponse>;
193
+ getAllProjects(requestParameters?: import("./Coscine.Api").AdminApiGetAllProjectsRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectAdminDtoPagedResponse>;
194
+ getAllResources(requestParameters?: import("./Coscine.Api").AdminApiGetAllResourcesRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceAdminDtoPagedResponse>;
195
+ getAllUsers(requestParameters?: import("./Coscine.Api").AdminApiGetAllUsersRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").UserDtoPagedResponse>;
195
196
  getMetadataGraph(requestParameters: import("./Coscine.Api").AdminApiGetMetadataGraphRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<import("./Coscine.Api").RdfDefinitionDtoResponse>;
196
- updateMetadataGraph(requestParameters?: import("./Coscine.Api").AdminApiUpdateMetadataGraphRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
197
+ patchMetadata(requestParameters: import("./Coscine.Api").AdminApiPatchMetadataRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
198
+ updateMetadataGraph(requestParameters: import("./Coscine.Api").AdminApiUpdateMetadataGraphRequest, options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
197
199
  };
198
200
  export declare const ApplicationProfileApi: {
199
201
  apiV2ApplicationProfilesOptions(options?: import("axios").AxiosRequestConfig<any> | undefined): import("axios").AxiosPromise<void>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@coscine/api-client",
3
3
  "type": "module",
4
- "version": "3.4.1",
4
+ "version": "3.4.3",
5
5
  "description": "This project contains the generated api client classes.",
6
6
  "keywords": [
7
7
  "coscine",