@coscine/api-client 3.3.1 → 3.4.0

package/dist/types/Coscine.Api/@coscine/model/public-user-dto.d.ts

@@ -0,0 +1,55 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { TitleDto } from './title-dto';
+/**
+ * Represents a public user data transfer object (DTO).
+ * @export
+ * @interface PublicUserDto
+ */
+export interface PublicUserDto {
+    /**
+     * Unique identifier of the user.
+     * @type {string}
+     * @memberof PublicUserDto
+     */
+    'id'?: string;
+    /**
+     * Display name of the user.
+     * @type {string}
+     * @memberof PublicUserDto
+     */
+    'displayName'?: string;
+    /**
+     * Given name of the user.
+     * @type {string}
+     * @memberof PublicUserDto
+     */
+    'givenName'?: string;
+    /**
+     * Family name of the user.
+     * @type {string}
+     * @memberof PublicUserDto
+     */
+    'familyName'?: string;
+    /**
+     * Email address of the user.
+     * @type {string}
+     * @memberof PublicUserDto
+     */
+    'email'?: string;
+    /**
+     *
+     * @type {TitleDto}
+     * @memberof PublicUserDto
+     */
+    'title'?: TitleDto;
+}

package/dist/types/Coscine.Api/@coscine/model/quota-dto.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { QuotaUnit } from './quota-unit';
+/**
+ * Represents a Data Transfer Object (DTO) for quota values.
+ * @export
+ * @interface QuotaDto
+ */
+export interface QuotaDto {
+    /**
+     * The value of the quota.
+     * @type {number}
+     * @memberof QuotaDto
+     */
+    'value': number;
+    /**
+     *
+     * @type {QuotaUnit}
+     * @memberof QuotaDto
+     */
+    'unit': QuotaUnit;
+}

package/dist/types/Coscine.Api/@coscine/model/quota-for-manipulation-dto.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { QuotaUnit } from './quota-unit';
+/**
+ * Represents a data transfer object (DTO) used for manipulating quota values.
+ * @export
+ * @interface QuotaForManipulationDto
+ */
+export interface QuotaForManipulationDto {
+    /**
+     * The numerical value of the quota. Must be a positive System.Int64.
+     * @type {number}
+     * @memberof QuotaForManipulationDto
+     */
+    'value': number;
+    /**
+     *
+     * @type {QuotaUnit}
+     * @memberof QuotaForManipulationDto
+     */
+    'unit': QuotaUnit;
+}

package/dist/types/Coscine.Api/@coscine/model/quota-unit.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Specifies the unit of quota.
+ * @export
+ * @enum {string}
+ */
+export declare const QuotaUnit: {
+    readonly Byte: "https://qudt.org/vocab/unit/BYTE";
+    readonly KibiByte: "https://qudt.org/vocab/unit/KibiBYTE";
+    readonly MebiByte: "https://qudt.org/vocab/unit/MebiBYTE";
+    readonly GibiByte: "https://qudt.org/vocab/unit/GibiBYTE";
+    readonly TebiByte: "https://qudt.org/vocab/unit/TebiBYTE";
+    readonly PebiByte: "https://qudt.org/vocab/unit/PebiBYTE";
+};
+export type QuotaUnit = typeof QuotaUnit[keyof typeof QuotaUnit];

package/dist/types/Coscine.Api/@coscine/model/rdf-definition-dto-response.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { RdfDefinitionDto } from './rdf-definition-dto';
+/**
+ *
+ * @export
+ * @interface RdfDefinitionDtoResponse
+ */
+export interface RdfDefinitionDtoResponse {
+    /**
+     *
+     * @type {RdfDefinitionDto}
+     * @memberof RdfDefinitionDtoResponse
+     */
+    'data'?: RdfDefinitionDto;
+    /**
+     *
+     * @type {boolean}
+     * @memberof RdfDefinitionDtoResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof RdfDefinitionDtoResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof RdfDefinitionDtoResponse
+     */
+    'traceId'?: string | null;
+}

package/dist/types/Coscine.Api/@coscine/model/rdf-definition-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Represents a Data Transfer Object (DTO) for RDF (Resource Description Framework) definition details.
+ * @export
+ * @interface RdfDefinitionDto
+ */
+export interface RdfDefinitionDto {
+    /**
+     * The content of the RDF definition.
+     * @type {string}
+     * @memberof RdfDefinitionDto
+     */
+    'content'?: string | null;
+    /**
+     * The type of the RDF definition.
+     * @type {string}
+     * @memberof RdfDefinitionDto
+     */
+    'type'?: string | null;
+}

package/dist/types/Coscine.Api/@coscine/model/rdf-definition-for-manipulation-dto.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { RdfFormat } from './rdf-format';
+/**
+ * Represents the data transfer object (DTO) used for manipulating RDF definitions.
+ * @export
+ * @interface RdfDefinitionForManipulationDto
+ */
+export interface RdfDefinitionForManipulationDto {
+    /**
+     * The content of the RDF definition.
+     * @type {string}
+     * @memberof RdfDefinitionForManipulationDto
+     */
+    'content': string;
+    /**
+     *
+     * @type {RdfFormat}
+     * @memberof RdfDefinitionForManipulationDto
+     */
+    'type': RdfFormat;
+}

package/dist/types/Coscine.Api/@coscine/model/rdf-format.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Specifies the RDF <i>(Resource Description Framework)</i> format.
+ * @export
+ * @enum {string}
+ */
+export declare const RdfFormat: {
+    readonly TextTurtle: "text/turtle";
+    readonly ApplicationLdjson: "application/ld+json";
+};
+export type RdfFormat = typeof RdfFormat[keyof typeof RdfFormat];

package/dist/types/Coscine.Api/@coscine/model/rds-options-dto.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { QuotaDto } from './quota-dto';
+/**
+ * Represents the data transfer object (DTO) for RDS options.
+ * @export
+ * @interface RdsOptionsDto
+ */
+export interface RdsOptionsDto {
+    /**
+     * The name of the bucket associated with RDS.
+     * @type {string}
+     * @memberof RdsOptionsDto
+     */
+    'bucketName'?: string;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof RdsOptionsDto
+     */
+    'size'?: QuotaDto;
+}

package/dist/types/Coscine.Api/@coscine/model/rds-resource-type-options-for-manipulation-dto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { QuotaForManipulationDto } from './quota-for-manipulation-dto';
+/**
+ * Represents the data transfer object (DTO) for manipulating RDS Web resource type options.
+ * @export
+ * @interface RdsResourceTypeOptionsForManipulationDto
+ */
+export interface RdsResourceTypeOptionsForManipulationDto {
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof RdsResourceTypeOptionsForManipulationDto
+     */
+    'quota'?: QuotaForManipulationDto;
+}

package/dist/types/Coscine.Api/@coscine/model/rds-s3-options-dto.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { QuotaDto } from './quota-dto';
+/**
+ * Represents the data transfer object (DTO) for RDS S3 options.
+ * @export
+ * @interface RdsS3OptionsDto
+ */
+export interface RdsS3OptionsDto {
+    /**
+     * The name of the bucket associated with RDS S3.
+     * @type {string}
+     * @memberof RdsS3OptionsDto
+     */
+    'bucketName'?: string;
+    /**
+     * The access key for reading from the RDS S3 bucket.
+     * @type {string}
+     * @memberof RdsS3OptionsDto
+     */
+    'accessKeyRead'?: string;
+    /**
+     * The secret key for reading from the RDS S3 bucket.
+     * @type {string}
+     * @memberof RdsS3OptionsDto
+     */
+    'secretKeyRead'?: string;
+    /**
+     * The access key for writing to the RDS S3 bucket.
+     * @type {string}
+     * @memberof RdsS3OptionsDto
+     */
+    'accessKeyWrite'?: string;
+    /**
+     * The secret key for writing to the RDS S3 bucket.
+     * @type {string}
+     * @memberof RdsS3OptionsDto
+     */
+    'secretKeyWrite'?: string;
+    /**
+     * The endpoint for the RDS S3 bucket.
+     * @type {string}
+     * @memberof RdsS3OptionsDto
+     */
+    'endpoint'?: string;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof RdsS3OptionsDto
+     */
+    'size'?: QuotaDto;
+}

package/dist/types/Coscine.Api/@coscine/model/rds-s3-resource-type-options-for-manipulation-dto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { QuotaForManipulationDto } from './quota-for-manipulation-dto';
+/**
+ * Represents the data transfer object (DTO) for manipulating RDS S3 resource type options.
+ * @export
+ * @interface RdsS3ResourceTypeOptionsForManipulationDto
+ */
+export interface RdsS3ResourceTypeOptionsForManipulationDto {
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof RdsS3ResourceTypeOptionsForManipulationDto
+     */
+    'quota'?: QuotaForManipulationDto;
+}

package/dist/types/Coscine.Api/@coscine/model/rds-s3-worm-options-dto.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { QuotaDto } from './quota-dto';
+/**
+ * Represents the data transfer object (DTO) for RDS S3 WORM options.
+ * @export
+ * @interface RdsS3WormOptionsDto
+ */
+export interface RdsS3WormOptionsDto {
+    /**
+     * The name of the bucket associated with RDS S3 WORM.
+     * @type {string}
+     * @memberof RdsS3WormOptionsDto
+     */
+    'bucketName'?: string;
+    /**
+     * The access key for reading from the RDS S3 WORM bucket.
+     * @type {string}
+     * @memberof RdsS3WormOptionsDto
+     */
+    'accessKeyRead'?: string;
+    /**
+     * The secret key for reading from the RDS S3 WORM bucket.
+     * @type {string}
+     * @memberof RdsS3WormOptionsDto
+     */
+    'secretKeyRead'?: string;
+    /**
+     * The access key for writing to the RDS S3 WORM bucket.
+     * @type {string}
+     * @memberof RdsS3WormOptionsDto
+     */
+    'accessKeyWrite'?: string;
+    /**
+     * The secret key for writing to the RDS S3 WORM bucket.
+     * @type {string}
+     * @memberof RdsS3WormOptionsDto
+     */
+    'secretKeyWrite'?: string;
+    /**
+     * The endpoint for the RDS S3 WORM bucket.
+     * @type {string}
+     * @memberof RdsS3WormOptionsDto
+     */
+    'endpoint'?: string;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof RdsS3WormOptionsDto
+     */
+    'size'?: QuotaDto;
+}

package/dist/types/Coscine.Api/@coscine/model/rds-s3-worm-resource-type-options-for-manipulation-dto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { QuotaForManipulationDto } from './quota-for-manipulation-dto';
+/**
+ * Represents the data transfer object (DTO) for manipulating RDS S3 WORM resource type options.
+ * @export
+ * @interface RdsS3WormResourceTypeOptionsForManipulationDto
+ */
+export interface RdsS3WormResourceTypeOptionsForManipulationDto {
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof RdsS3WormResourceTypeOptionsForManipulationDto
+     */
+    'quota'?: QuotaForManipulationDto;
+}

package/dist/types/Coscine.Api/@coscine/model/resource-admin-dto-ienumerable-paged-response.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Coscine Web API
+ * 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.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Pagination } from './pagination';
+import { ResourceAdminDto } from './resource-admin-dto';
+/**
+ *
+ * @export
+ * @interface ResourceAdminDtoIEnumerablePagedResponse
+ */
+export interface ResourceAdminDtoIEnumerablePagedResponse {
+    /**
+     *
+     * @type {Array<Array<ResourceAdminDto>>}
+     * @memberof ResourceAdminDtoIEnumerablePagedResponse
+     */
+    'data'?: Array<Array<ResourceAdminDto>> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ResourceAdminDtoIEnumerablePagedResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof ResourceAdminDtoIEnumerablePagedResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ResourceAdminDtoIEnumerablePagedResponse
+     */
+    'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof ResourceAdminDtoIEnumerablePagedResponse
+     */
+    'pagination'?: Pagination;
+}