@coscine/api-client 3.14.0 → 3.16.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.
Files changed (50) hide show
  1. package/dist/index.js +452 -395
  2. package/dist/types/Coscine.Api/@coscine/api/admin-api.d.ts +15 -15
  3. package/dist/types/Coscine.Api/@coscine/api/application-profile-api.d.ts +3 -3
  4. package/dist/types/Coscine.Api/@coscine/api/discipline-api.d.ts +3 -3
  5. package/dist/types/Coscine.Api/@coscine/api/language-api.d.ts +3 -3
  6. package/dist/types/Coscine.Api/@coscine/api/license-api.d.ts +3 -3
  7. package/dist/types/Coscine.Api/@coscine/api/organization-api.d.ts +3 -3
  8. package/dist/types/Coscine.Api/@coscine/api/pid-api.d.ts +3 -3
  9. package/dist/types/Coscine.Api/@coscine/api/project-api.d.ts +3 -3
  10. package/dist/types/Coscine.Api/@coscine/api/project-invitation-api.d.ts +3 -3
  11. package/dist/types/Coscine.Api/@coscine/api/project-member-api.d.ts +3 -3
  12. package/dist/types/Coscine.Api/@coscine/api/project-quota-api.d.ts +3 -3
  13. package/dist/types/Coscine.Api/@coscine/api/project-resource-api.d.ts +3 -3
  14. package/dist/types/Coscine.Api/@coscine/api/resource-type-api.d.ts +0 -181
  15. package/dist/types/Coscine.Api/@coscine/api/resource-type-git-lab-api.d.ts +250 -0
  16. package/dist/types/Coscine.Api/@coscine/api/role-api.d.ts +3 -3
  17. package/dist/types/Coscine.Api/@coscine/api/search-api.d.ts +3 -3
  18. package/dist/types/Coscine.Api/@coscine/api/self-api-token-api.d.ts +3 -3
  19. package/dist/types/Coscine.Api/@coscine/api/system-status-api.d.ts +6 -6
  20. package/dist/types/Coscine.Api/@coscine/api/title-api.d.ts +3 -3
  21. package/dist/types/Coscine.Api/@coscine/api/tree-api.d.ts +6 -6
  22. package/dist/types/Coscine.Api/@coscine/api/visibility-api.d.ts +3 -3
  23. package/dist/types/Coscine.Api/@coscine/api/vocabulary-api.d.ts +6 -6
  24. package/dist/types/Coscine.Api/@coscine/model/accepted-language.d.ts +2 -2
  25. package/dist/types/Coscine.Api/@coscine/model/coscine-http-method.d.ts +5 -5
  26. package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-s3-options-dto.d.ts +61 -0
  27. package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-s3-resource-type-options-for-manipulation-dto.d.ts +25 -0
  28. package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-s3-worm-options-dto.d.ts +61 -0
  29. package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-s3-worm-resource-type-options-for-manipulation-dto.d.ts +25 -0
  30. package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-web-options-dto.d.ts +31 -0
  31. package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-web-resource-type-options-for-manipulation-dto.d.ts +25 -0
  32. package/dist/types/Coscine.Api/@coscine/model/file-action-http-method.d.ts +4 -4
  33. package/dist/types/Coscine.Api/@coscine/model/file-system-storage-options-dto.d.ts +24 -0
  34. package/dist/types/Coscine.Api/@coscine/model/identity-providers.d.ts +1 -1
  35. package/dist/types/Coscine.Api/@coscine/model/index.d.ts +7 -0
  36. package/dist/types/Coscine.Api/@coscine/model/pid-type.d.ts +2 -2
  37. package/dist/types/Coscine.Api/@coscine/model/quota-unit.d.ts +6 -6
  38. package/dist/types/Coscine.Api/@coscine/model/rdf-format.d.ts +3 -3
  39. package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto.d.ts +8 -2
  40. package/dist/types/Coscine.Api/@coscine/model/resource-dto.d.ts +8 -2
  41. package/dist/types/Coscine.Api/@coscine/model/resource-for-update-dto.d.ts +6 -0
  42. package/dist/types/Coscine.Api/@coscine/model/resource-type-options-dto.d.ts +28 -0
  43. package/dist/types/Coscine.Api/@coscine/model/resource-type-options-for-creation-dto.d.ts +21 -0
  44. package/dist/types/Coscine.Api/@coscine/model/resource-type-options-for-update-dto.d.ts +21 -0
  45. package/dist/types/Coscine.Api/@coscine/model/resource-type-status.d.ts +2 -2
  46. package/dist/types/Coscine.Api/@coscine/model/search-category-type.d.ts +3 -3
  47. package/dist/types/Coscine.Api/api.d.ts +1 -0
  48. package/dist/types/apis.d.ts +6 -3
  49. package/dist/types/index.d.ts +12 -6
  50. package/package.json +1 -1
@@ -39,7 +39,7 @@ export declare const TitleApiAxiosParamCreator: (configuration?: Configuration)
39
39
  * @summary Retrieves all titles.
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.
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.
42
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
43
43
  * @param {*} [options] Override http request option.
44
44
  * @throws {RequiredError}
45
45
  */
@@ -70,7 +70,7 @@ export declare const TitleApiFp: (configuration?: Configuration) => {
70
70
  * @summary Retrieves all titles.
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.
73
- * @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.
73
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
74
74
  * @param {*} [options] Override http request option.
75
75
  * @throws {RequiredError}
76
76
  */
@@ -137,7 +137,7 @@ export interface TitleApiGetTitlesRequest {
137
137
  */
138
138
  readonly pageSize?: number;
139
139
  /**
140
- * 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.
140
+ * Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
141
141
  * @type {string}
142
142
  * @memberof TitleApiGetTitles
143
143
  */
@@ -73,7 +73,7 @@ export declare const TreeApiAxiosParamCreator: (configuration?: Configuration) =
73
73
  * @param {string} [path] Gets or sets the path of the file tree.
74
74
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
75
75
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
76
- * @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
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
77
77
  * @param {*} [options] Override http request option.
78
78
  * @throws {RequiredError}
79
79
  */
@@ -89,7 +89,7 @@ export declare const TreeApiAxiosParamCreator: (configuration?: Configuration) =
89
89
  * @param {boolean} [includeProvenance] Gets or sets if provenance metadata should be included.
90
90
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
91
91
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
92
- * @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.
92
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
93
93
  * @param {*} [options] Override http request option.
94
94
  * @throws {RequiredError}
95
95
  */
@@ -181,7 +181,7 @@ export declare const TreeApiFp: (configuration?: Configuration) => {
181
181
  * @param {string} [path] Gets or sets the path of the file tree.
182
182
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
183
183
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
184
- * @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.
184
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
185
185
  * @param {*} [options] Override http request option.
186
186
  * @throws {RequiredError}
187
187
  */
@@ -197,7 +197,7 @@ export declare const TreeApiFp: (configuration?: Configuration) => {
197
197
  * @param {boolean} [includeProvenance] Gets or sets if provenance metadata should be included.
198
198
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
199
199
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
200
- * @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.
200
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
201
201
  * @param {*} [options] Override http request option.
202
202
  * @throws {RequiredError}
203
203
  */
@@ -446,7 +446,7 @@ export interface TreeApiGetFileTreeRequest {
446
446
  */
447
447
  readonly pageSize?: number;
448
448
  /**
449
- * 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.
449
+ * Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
450
450
  * @type {string}
451
451
  * @memberof TreeApiGetFileTree
452
452
  */
@@ -507,7 +507,7 @@ export interface TreeApiGetMetadataTreeRequest {
507
507
  */
508
508
  readonly pageSize?: number;
509
509
  /**
510
- * 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.
510
+ * Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
511
511
  * @type {string}
512
512
  * @memberof TreeApiGetMetadataTree
513
513
  */
@@ -31,7 +31,7 @@ export declare const VisibilityApiAxiosParamCreator: (configuration?: Configurat
31
31
  * @summary Retrieves all visibilities.
32
32
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
33
33
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
34
- * @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.
34
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
35
35
  * @param {*} [options] Override http request option.
36
36
  * @throws {RequiredError}
37
37
  */
@@ -62,7 +62,7 @@ export declare const VisibilityApiFp: (configuration?: Configuration) => {
62
62
  * @summary Retrieves all visibilities.
63
63
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
64
64
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
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.
65
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
66
66
  * @param {*} [options] Override http request option.
67
67
  * @throws {RequiredError}
68
68
  */
@@ -124,7 +124,7 @@ export interface VisibilityApiGetVisibilitiesRequest {
124
124
  */
125
125
  readonly pageSize?: number;
126
126
  /**
127
- * 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
+ * Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
128
128
  * @type {string}
129
129
  * @memberof VisibilityApiGetVisibilities
130
130
  */
@@ -35,7 +35,7 @@ export declare const VocabularyApiAxiosParamCreator: (configuration?: Configurat
35
35
  * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabularies are requested.
36
36
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
37
37
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
38
- * @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.
38
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
39
39
  * @param {*} [options] Override http request option.
40
40
  * @throws {RequiredError}
41
41
  */
@@ -57,7 +57,7 @@ export declare const VocabularyApiAxiosParamCreator: (configuration?: Configurat
57
57
  * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabulary instances are requested.
58
58
  * @param {number} [pageSize] Number of items per page. The maximum number of items per page is `150`.
59
59
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
60
- * @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.
60
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
61
61
  * @param {*} [options] Override http request option.
62
62
  * @throws {RequiredError}
63
63
  */
@@ -82,7 +82,7 @@ export declare const VocabularyApiFp: (configuration?: Configuration) => {
82
82
  * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabularies are requested.
83
83
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
84
84
  * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
85
- * @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.
85
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
86
86
  * @param {*} [options] Override http request option.
87
87
  * @throws {RequiredError}
88
88
  */
@@ -104,7 +104,7 @@ export declare const VocabularyApiFp: (configuration?: Configuration) => {
104
104
  * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabulary instances are requested.
105
105
  * @param {number} [pageSize] Number of items per page. The maximum number of items per page is `150`.
106
106
  * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
107
- * @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.
107
+ * @param {string} [orderBy] Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
108
108
  * @param {*} [options] Override http request option.
109
109
  * @throws {RequiredError}
110
110
  */
@@ -178,7 +178,7 @@ export interface VocabularyApiGetVocabulariesRequest {
178
178
  */
179
179
  readonly pageSize?: number;
180
180
  /**
181
- * 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.
181
+ * Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
182
182
  * @type {string}
183
183
  * @memberof VocabularyApiGetVocabularies
184
184
  */
@@ -240,7 +240,7 @@ export interface VocabularyApiGetVocabularyInstancesRequest {
240
240
  */
241
241
  readonly pageNumber?: number;
242
242
  /**
243
- * 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.
243
+ * Gets or sets the field name used for ordering the results. The order is constructed by an order string. Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
244
244
  * @type {string}
245
245
  * @memberof VocabularyApiGetVocabularyInstances
246
246
  */
@@ -15,7 +15,7 @@
15
15
  * @enum {string}
16
16
  */
17
17
  export declare const AcceptedLanguage: {
18
- readonly De: "de";
19
- readonly En: "en";
18
+ readonly de: "de";
19
+ readonly en: "en";
20
20
  };
21
21
  export type AcceptedLanguage = typeof AcceptedLanguage[keyof typeof AcceptedLanguage];
@@ -15,10 +15,10 @@
15
15
  * @enum {string}
16
16
  */
17
17
  export declare const CoscineHttpMethod: {
18
- readonly Get: "GET";
19
- readonly Head: "HEAD";
20
- readonly Post: "POST";
21
- readonly Put: "PUT";
22
- readonly Delete: "DELETE";
18
+ readonly GET: "GET";
19
+ readonly HEAD: "HEAD";
20
+ readonly POST: "POST";
21
+ readonly PUT: "PUT";
22
+ readonly DELETE: "DELETE";
23
23
  };
24
24
  export type CoscineHttpMethod = typeof CoscineHttpMethod[keyof typeof CoscineHttpMethod];
@@ -0,0 +1,61 @@
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 { QuotaDto } from './quota-dto';
13
+ /**
14
+ * Represents the data transfer object (DTO) for DataStorage.nrw S3 options.
15
+ * @export
16
+ * @interface DataStorageNrwS3OptionsDto
17
+ */
18
+ export interface DataStorageNrwS3OptionsDto {
19
+ /**
20
+ * The name of the bucket associated with DataStorage.nrw S3.
21
+ * @type {string}
22
+ * @memberof DataStorageNrwS3OptionsDto
23
+ */
24
+ 'bucketName': string;
25
+ /**
26
+ * The access key for reading from the DataStorage.nrw S3 bucket.
27
+ * @type {string}
28
+ * @memberof DataStorageNrwS3OptionsDto
29
+ */
30
+ 'accessKeyRead': string;
31
+ /**
32
+ * The secret key for reading from the DataStorage.nrw S3 bucket.
33
+ * @type {string}
34
+ * @memberof DataStorageNrwS3OptionsDto
35
+ */
36
+ 'secretKeyRead': string;
37
+ /**
38
+ * The access key for writing to the DataStorage.nrw S3 bucket.
39
+ * @type {string}
40
+ * @memberof DataStorageNrwS3OptionsDto
41
+ */
42
+ 'accessKeyWrite': string;
43
+ /**
44
+ * The secret key for writing to the DataStorage.nrw S3 bucket.
45
+ * @type {string}
46
+ * @memberof DataStorageNrwS3OptionsDto
47
+ */
48
+ 'secretKeyWrite': string;
49
+ /**
50
+ * The endpoint for the DataStorage.nrw S3 bucket.
51
+ * @type {string}
52
+ * @memberof DataStorageNrwS3OptionsDto
53
+ */
54
+ 'endpoint': string;
55
+ /**
56
+ *
57
+ * @type {QuotaDto}
58
+ * @memberof DataStorageNrwS3OptionsDto
59
+ */
60
+ 'size'?: QuotaDto;
61
+ }
@@ -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 type { QuotaForManipulationDto } from './quota-for-manipulation-dto';
13
+ /**
14
+ * Represents the data transfer object (DTO) for manipulating DataStorage.nrw S3 resource type options.
15
+ * @export
16
+ * @interface DataStorageNrwS3ResourceTypeOptionsForManipulationDto
17
+ */
18
+ export interface DataStorageNrwS3ResourceTypeOptionsForManipulationDto {
19
+ /**
20
+ *
21
+ * @type {QuotaForManipulationDto}
22
+ * @memberof DataStorageNrwS3ResourceTypeOptionsForManipulationDto
23
+ */
24
+ 'quota': QuotaForManipulationDto;
25
+ }
@@ -0,0 +1,61 @@
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 { QuotaDto } from './quota-dto';
13
+ /**
14
+ * Represents the data transfer object (DTO) for DataStorage.nrw S3 WORM options.
15
+ * @export
16
+ * @interface DataStorageNrwS3WormOptionsDto
17
+ */
18
+ export interface DataStorageNrwS3WormOptionsDto {
19
+ /**
20
+ * The name of the bucket associated with DataStorage.nrw S3 WORM.
21
+ * @type {string}
22
+ * @memberof DataStorageNrwS3WormOptionsDto
23
+ */
24
+ 'bucketName': string;
25
+ /**
26
+ * The access key for reading from the DataStorage.nrw S3 WORM bucket.
27
+ * @type {string}
28
+ * @memberof DataStorageNrwS3WormOptionsDto
29
+ */
30
+ 'accessKeyRead': string;
31
+ /**
32
+ * The secret key for reading from the DataStorage.nrw S3 WORM bucket.
33
+ * @type {string}
34
+ * @memberof DataStorageNrwS3WormOptionsDto
35
+ */
36
+ 'secretKeyRead': string;
37
+ /**
38
+ * The access key for writing to the DataStorage.nrw S3 WORM bucket.
39
+ * @type {string}
40
+ * @memberof DataStorageNrwS3WormOptionsDto
41
+ */
42
+ 'accessKeyWrite': string;
43
+ /**
44
+ * The secret key for writing to the DataStorage.nrw S3 WORM bucket.
45
+ * @type {string}
46
+ * @memberof DataStorageNrwS3WormOptionsDto
47
+ */
48
+ 'secretKeyWrite': string;
49
+ /**
50
+ * The endpoint for the RDS DataStorage.nrw WORM bucket.
51
+ * @type {string}
52
+ * @memberof DataStorageNrwS3WormOptionsDto
53
+ */
54
+ 'endpoint': string;
55
+ /**
56
+ *
57
+ * @type {QuotaDto}
58
+ * @memberof DataStorageNrwS3WormOptionsDto
59
+ */
60
+ 'size'?: QuotaDto;
61
+ }
@@ -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 type { QuotaForManipulationDto } from './quota-for-manipulation-dto';
13
+ /**
14
+ * Represents the data transfer object (DTO) for manipulating DataStorage.nrw S3 WORM resource type options.
15
+ * @export
16
+ * @interface DataStorageNrwS3WormResourceTypeOptionsForManipulationDto
17
+ */
18
+ export interface DataStorageNrwS3WormResourceTypeOptionsForManipulationDto {
19
+ /**
20
+ *
21
+ * @type {QuotaForManipulationDto}
22
+ * @memberof DataStorageNrwS3WormResourceTypeOptionsForManipulationDto
23
+ */
24
+ 'quota': QuotaForManipulationDto;
25
+ }
@@ -0,0 +1,31 @@
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 { QuotaDto } from './quota-dto';
13
+ /**
14
+ * Represents the data transfer object (DTO) for DataStorage.nrw Web options.
15
+ * @export
16
+ * @interface DataStorageNrwWebOptionsDto
17
+ */
18
+ export interface DataStorageNrwWebOptionsDto {
19
+ /**
20
+ * The name of the bucket associated with DataStorage.nrw Web.
21
+ * @type {string}
22
+ * @memberof DataStorageNrwWebOptionsDto
23
+ */
24
+ 'bucketName': string;
25
+ /**
26
+ *
27
+ * @type {QuotaDto}
28
+ * @memberof DataStorageNrwWebOptionsDto
29
+ */
30
+ 'size'?: QuotaDto;
31
+ }
@@ -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 type { QuotaForManipulationDto } from './quota-for-manipulation-dto';
13
+ /**
14
+ * Represents the data transfer object (DTO) for manipulating DataStorage.nrw Web resource type options.
15
+ * @export
16
+ * @interface DataStorageNrwWebResourceTypeOptionsForManipulationDto
17
+ */
18
+ export interface DataStorageNrwWebResourceTypeOptionsForManipulationDto {
19
+ /**
20
+ *
21
+ * @type {QuotaForManipulationDto}
22
+ * @memberof DataStorageNrwWebResourceTypeOptionsForManipulationDto
23
+ */
24
+ 'quota': QuotaForManipulationDto;
25
+ }
@@ -15,9 +15,9 @@
15
15
  * @enum {string}
16
16
  */
17
17
  export declare const FileActionHttpMethod: {
18
- readonly Get: "GET";
19
- readonly Post: "POST";
20
- readonly Put: "PUT";
21
- readonly Delete: "DELETE";
18
+ readonly GET: "GET";
19
+ readonly POST: "POST";
20
+ readonly PUT: "PUT";
21
+ readonly DELETE: "DELETE";
22
22
  };
23
23
  export type FileActionHttpMethod = typeof FileActionHttpMethod[keyof typeof FileActionHttpMethod];
@@ -0,0 +1,24 @@
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 data transfer object (DTO) for FileSystemStorage options.
14
+ * @export
15
+ * @interface FileSystemStorageOptionsDto
16
+ */
17
+ export interface FileSystemStorageOptionsDto {
18
+ /**
19
+ * The directory where the files are stored.
20
+ * @type {string}
21
+ * @memberof FileSystemStorageOptionsDto
22
+ */
23
+ 'directory': string;
24
+ }
@@ -16,6 +16,6 @@
16
16
  */
17
17
  export declare const IdentityProviders: {
18
18
  readonly Shibboleth: "Shibboleth";
19
- readonly OrciD: "ORCiD";
19
+ readonly ORCiD: "ORCiD";
20
20
  };
21
21
  export type IdentityProviders = typeof IdentityProviders[keyof typeof IdentityProviders];
@@ -13,6 +13,12 @@ export * from './application-profile-for-creation-dto-response';
13
13
  export * from './application-profile-for-resource-creation-dto';
14
14
  export * from './application-profile-minimal-dto';
15
15
  export * from './coscine-http-method';
16
+ export * from './data-storage-nrw-s3-options-dto';
17
+ export * from './data-storage-nrw-s3-resource-type-options-for-manipulation-dto';
18
+ export * from './data-storage-nrw-s3-worm-options-dto';
19
+ export * from './data-storage-nrw-s3-worm-resource-type-options-for-manipulation-dto';
20
+ export * from './data-storage-nrw-web-options-dto';
21
+ export * from './data-storage-nrw-web-resource-type-options-for-manipulation-dto';
16
22
  export * from './deployed-graph-dto';
17
23
  export * from './deployed-graph-dto-paged-response';
18
24
  export * from './discipline-dto';
@@ -26,6 +32,7 @@ export * from './extracted-metadata-tree-for-update-dto';
26
32
  export * from './file-action-dto';
27
33
  export * from './file-action-http-method';
28
34
  export * from './file-actions-dto';
35
+ export * from './file-system-storage-options-dto';
29
36
  export * from './file-tree-dto';
30
37
  export * from './file-tree-dto-paged-response';
31
38
  export * from './fixed-value-for-resource-manipulation-dto';
@@ -15,7 +15,7 @@
15
15
  * @enum {string}
16
16
  */
17
17
  export declare const PidType: {
18
- readonly Project: "project";
19
- readonly Resource: "resource";
18
+ readonly project: "project";
19
+ readonly resource: "resource";
20
20
  };
21
21
  export type PidType = typeof PidType[keyof typeof PidType];
@@ -15,11 +15,11 @@
15
15
  * @enum {string}
16
16
  */
17
17
  export declare const QuotaUnit: {
18
- readonly Byte: "https://qudt.org/vocab/unit/BYTE";
19
- readonly KibiByte: "https://qudt.org/vocab/unit/KibiBYTE";
20
- readonly MebiByte: "https://qudt.org/vocab/unit/MebiBYTE";
21
- readonly GibiByte: "https://qudt.org/vocab/unit/GibiBYTE";
22
- readonly TebiByte: "https://qudt.org/vocab/unit/TebiBYTE";
23
- readonly PebiByte: "https://qudt.org/vocab/unit/PebiBYTE";
18
+ readonly https___qudt_org_vocab_unit_BYTE: "https://qudt.org/vocab/unit/BYTE";
19
+ readonly https___qudt_org_vocab_unit_KibiBYTE: "https://qudt.org/vocab/unit/KibiBYTE";
20
+ readonly https___qudt_org_vocab_unit_MebiBYTE: "https://qudt.org/vocab/unit/MebiBYTE";
21
+ readonly https___qudt_org_vocab_unit_GibiBYTE: "https://qudt.org/vocab/unit/GibiBYTE";
22
+ readonly https___qudt_org_vocab_unit_TebiBYTE: "https://qudt.org/vocab/unit/TebiBYTE";
23
+ readonly https___qudt_org_vocab_unit_PebiBYTE: "https://qudt.org/vocab/unit/PebiBYTE";
24
24
  };
25
25
  export type QuotaUnit = typeof QuotaUnit[keyof typeof QuotaUnit];
@@ -15,8 +15,8 @@
15
15
  * @enum {string}
16
16
  */
17
17
  export declare const RdfFormat: {
18
- readonly TextTurtle: "text/turtle";
19
- readonly ApplicationLdjson: "application/ld+json";
20
- readonly ApplicationXTrig: "application/x-trig";
18
+ readonly text_turtle: "text/turtle";
19
+ readonly application_ldjson: "application/ld+json";
20
+ readonly application_x_trig: "application/x-trig";
21
21
  };
22
22
  export type RdfFormat = typeof RdfFormat[keyof typeof RdfFormat];
@@ -80,13 +80,13 @@ export interface ResourceAdminDto {
80
80
  */
81
81
  'usageRights'?: string | null;
82
82
  /**
83
- * Setting for creating a local copy of the metadata.
83
+ * Indicates whether a local copy of the metadata is available for the resource.
84
84
  * @type {boolean}
85
85
  * @memberof ResourceAdminDto
86
86
  */
87
87
  'metadataLocalCopy'?: boolean;
88
88
  /**
89
- * Setting for metadata extraction.
89
+ * Indicates whether metadata extraction is enabled for the resource.
90
90
  * @type {boolean}
91
91
  * @memberof ResourceAdminDto
92
92
  */
@@ -137,6 +137,12 @@ export interface ResourceAdminDto {
137
137
  * @memberof ResourceAdminDto
138
138
  */
139
139
  'archived'?: boolean;
140
+ /**
141
+ * Indicates whether the resource is in maintenance mode.
142
+ * @type {boolean}
143
+ * @memberof ResourceAdminDto
144
+ */
145
+ 'maintenanceMode'?: boolean;
140
146
  /**
141
147
  * The projects associated with the resource.
142
148
  * @type {Array<ProjectMinimalDto>}
@@ -78,13 +78,13 @@ export interface ResourceDto {
78
78
  */
79
79
  'usageRights'?: string | null;
80
80
  /**
81
- * Setting for creating a local copy of the metadata.
81
+ * Indicates whether a local copy of the metadata is available for the resource.
82
82
  * @type {boolean}
83
83
  * @memberof ResourceDto
84
84
  */
85
85
  'metadataLocalCopy'?: boolean;
86
86
  /**
87
- * Setting for metadata extraction.
87
+ * Indicates whether metadata extraction is enabled for the resource.
88
88
  * @type {boolean}
89
89
  * @memberof ResourceDto
90
90
  */
@@ -135,6 +135,12 @@ export interface ResourceDto {
135
135
  * @memberof ResourceDto
136
136
  */
137
137
  'archived'?: boolean;
138
+ /**
139
+ * Indicates whether the resource is in maintenance mode.
140
+ * @type {boolean}
141
+ * @memberof ResourceDto
142
+ */
143
+ 'maintenanceMode'?: boolean;
138
144
  /**
139
145
  * The projects associated with the resource.
140
146
  * @type {Array<ProjectMinimalDto>}
@@ -96,4 +96,10 @@ export interface ResourceForUpdateDto {
96
96
  * @memberof ResourceForUpdateDto
97
97
  */
98
98
  'resourceTypeOptions'?: ResourceTypeOptionsForUpdateDto;
99
+ /**
100
+ * Indicates whether the resource is in maintenance mode.
101
+ * @type {boolean}
102
+ * @memberof ResourceForUpdateDto
103
+ */
104
+ 'maintenanceMode'?: boolean | null;
99
105
  }