@coscine/api-client 3.21.0 → 3.22.0

package/dist/types/Coscine.Api/@coscine/model/data-hamster-kpi-dto-ienumerable-response.d.ts

@@ -10,9 +10,34 @@
  * Do not edit the class manually.
  */
 import type { DataHamsterKpiDto } from './data-hamster-kpi-dto';
+/**
+ *
+ * @export
+ * @interface DataHamsterKpiDtoIEnumerableResponse
+ */
 export interface DataHamsterKpiDtoIEnumerableResponse {
+    /**
+     *
+     * @type {Array<DataHamsterKpiDto>}
+     * @memberof DataHamsterKpiDtoIEnumerableResponse
+     */
     'data'?: Array<DataHamsterKpiDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DataHamsterKpiDtoIEnumerableResponse
+     */
     'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof DataHamsterKpiDtoIEnumerableResponse
+     */
     'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DataHamsterKpiDtoIEnumerableResponse
+     */
     'traceId'?: string | null;
 }

package/dist/types/Coscine.Api/@coscine/model/data-hamster-kpi-dto-response.d.ts

@@ -10,9 +10,34 @@
  * Do not edit the class manually.
  */
 import type { DataHamsterKpiDto } from './data-hamster-kpi-dto';
+/**
+ *
+ * @export
+ * @interface DataHamsterKpiDtoResponse
+ */
 export interface DataHamsterKpiDtoResponse {
+    /**
+     *
+     * @type {DataHamsterKpiDto}
+     * @memberof DataHamsterKpiDtoResponse
+     */
     'data'?: DataHamsterKpiDto;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DataHamsterKpiDtoResponse
+     */
     'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof DataHamsterKpiDtoResponse
+     */
     'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DataHamsterKpiDtoResponse
+     */
     'traceId'?: string | null;
 }

package/dist/types/Coscine.Api/@coscine/model/data-hamster-kpi-dto.d.ts

@@ -9,13 +9,48 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ *
+ * @export
+ * @interface DataHamsterKpiDto
+ */
 export interface DataHamsterKpiDto {
+    /**
+     *
+     * @type {number}
+     * @memberof DataHamsterKpiDto
+     */
     'measurementId'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DataHamsterKpiDto
+     */
     'value'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DataHamsterKpiDto
+     */
     'start'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DataHamsterKpiDto
+     */
     'end'?: string | null;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof DataHamsterKpiDto
+     */
     'additionalInfo'?: {
         [key: string]: string;
     };
+    /**
+     *
+     * @type {string}
+     * @memberof DataHamsterKpiDto
+     */
     'query'?: string;
 }

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

@@ -12,31 +12,50 @@
 import type { QuotaDto } from './quota-dto';
 /**
  * Represents the data transfer object (DTO) for DataStorage.nrw S3 options.
+ * @export
+ * @interface DataStorageNrwS3OptionsDto
  */
 export interface DataStorageNrwS3OptionsDto {
     /**
      * The name of the bucket associated with DataStorage.nrw S3.
+     * @type {string}
+     * @memberof DataStorageNrwS3OptionsDto
      */
     'bucketName': string;
     /**
      * The access key for reading from the DataStorage.nrw S3 bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3OptionsDto
      */
     'accessKeyRead': string;
     /**
      * The secret key for reading from the DataStorage.nrw S3 bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3OptionsDto
      */
     'secretKeyRead': string;
     /**
      * The access key for writing to the DataStorage.nrw S3 bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3OptionsDto
      */
     'accessKeyWrite': string;
     /**
      * The secret key for writing to the DataStorage.nrw S3 bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3OptionsDto
      */
     'secretKeyWrite': string;
     /**
      * The endpoint for the DataStorage.nrw S3 bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3OptionsDto
      */
     'endpoint': string;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof DataStorageNrwS3OptionsDto
+     */
     'size'?: QuotaDto;
 }

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

@@ -14,9 +14,26 @@ import type { LifecycleOptionsForManipulationDto } from './lifecycle-options-for
 import type { QuotaForManipulationDto } from './quota-for-manipulation-dto';
 /**
  * Represents the data transfer object (DTO) for manipulating DataStorage.nrw S3 resource type options.
+ * @export
+ * @interface DataStorageNrwS3ResourceTypeOptionsForManipulationDto
  */
 export interface DataStorageNrwS3ResourceTypeOptionsForManipulationDto {
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof DataStorageNrwS3ResourceTypeOptionsForManipulationDto
+     */
     'quota': QuotaForManipulationDto;
+    /**
+     *
+     * @type {LifecycleOptionsForManipulationDto}
+     * @memberof DataStorageNrwS3ResourceTypeOptionsForManipulationDto
+     */
     'lifecycleOptions'?: LifecycleOptionsForManipulationDto;
+    /**
+     *
+     * @type {DsNrwReplicationGroupDto}
+     * @memberof DataStorageNrwS3ResourceTypeOptionsForManipulationDto
+     */
     'replicationGroup'?: DsNrwReplicationGroupDto;
 }

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

@@ -12,31 +12,50 @@
 import type { QuotaDto } from './quota-dto';
 /**
  * Represents the data transfer object (DTO) for DataStorage.nrw S3 WORM options.
+ * @export
+ * @interface DataStorageNrwS3WormOptionsDto
  */
 export interface DataStorageNrwS3WormOptionsDto {
     /**
      * The name of the bucket associated with DataStorage.nrw S3 WORM.
+     * @type {string}
+     * @memberof DataStorageNrwS3WormOptionsDto
      */
     'bucketName': string;
     /**
      * The access key for reading from the DataStorage.nrw S3 WORM bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3WormOptionsDto
      */
     'accessKeyRead': string;
     /**
      * The secret key for reading from the DataStorage.nrw S3 WORM bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3WormOptionsDto
      */
     'secretKeyRead': string;
     /**
      * The access key for writing to the DataStorage.nrw S3 WORM bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3WormOptionsDto
      */
     'accessKeyWrite': string;
     /**
      * The secret key for writing to the DataStorage.nrw S3 WORM bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3WormOptionsDto
      */
     'secretKeyWrite': string;
     /**
      * The endpoint for the RDS DataStorage.nrw WORM bucket.
+     * @type {string}
+     * @memberof DataStorageNrwS3WormOptionsDto
      */
     'endpoint': string;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof DataStorageNrwS3WormOptionsDto
+     */
     'size'?: QuotaDto;
 }

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

@@ -14,9 +14,26 @@ import type { LifecycleOptionsForManipulationDto } from './lifecycle-options-for
 import type { QuotaForManipulationDto } from './quota-for-manipulation-dto';
 /**
  * Represents the data transfer object (DTO) for manipulating DataStorage.nrw S3 WORM resource type options.
+ * @export
+ * @interface DataStorageNrwS3WormResourceTypeOptionsForManipulationDto
  */
 export interface DataStorageNrwS3WormResourceTypeOptionsForManipulationDto {
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof DataStorageNrwS3WormResourceTypeOptionsForManipulationDto
+     */
     'quota': QuotaForManipulationDto;
+    /**
+     *
+     * @type {LifecycleOptionsForManipulationDto}
+     * @memberof DataStorageNrwS3WormResourceTypeOptionsForManipulationDto
+     */
     'lifecycleOptions'?: LifecycleOptionsForManipulationDto;
+    /**
+     *
+     * @type {DsNrwReplicationGroupDto}
+     * @memberof DataStorageNrwS3WormResourceTypeOptionsForManipulationDto
+     */
     'replicationGroup'?: DsNrwReplicationGroupDto;
 }

package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-web-options-dto.d.ts

@@ -12,11 +12,20 @@
 import type { QuotaDto } from './quota-dto';
 /**
  * Represents the data transfer object (DTO) for DataStorage.nrw Web options.
+ * @export
+ * @interface DataStorageNrwWebOptionsDto
  */
 export interface DataStorageNrwWebOptionsDto {
     /**
      * The name of the bucket associated with DataStorage.nrw Web.
+     * @type {string}
+     * @memberof DataStorageNrwWebOptionsDto
      */
     'bucketName': string;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof DataStorageNrwWebOptionsDto
+     */
     'size'?: QuotaDto;
 }

package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-web-resource-type-options-for-manipulation-dto.d.ts

@@ -14,9 +14,26 @@ import type { LifecycleOptionsForManipulationDto } from './lifecycle-options-for
 import type { QuotaForManipulationDto } from './quota-for-manipulation-dto';
 /**
  * Represents the data transfer object (DTO) for manipulating DataStorage.nrw Web resource type options.
+ * @export
+ * @interface DataStorageNrwWebResourceTypeOptionsForManipulationDto
  */
 export interface DataStorageNrwWebResourceTypeOptionsForManipulationDto {
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof DataStorageNrwWebResourceTypeOptionsForManipulationDto
+     */
     'quota': QuotaForManipulationDto;
+    /**
+     *
+     * @type {LifecycleOptionsForManipulationDto}
+     * @memberof DataStorageNrwWebResourceTypeOptionsForManipulationDto
+     */
     'lifecycleOptions'?: LifecycleOptionsForManipulationDto;
+    /**
+     *
+     * @type {DsNrwReplicationGroupDto}
+     * @memberof DataStorageNrwWebResourceTypeOptionsForManipulationDto
+     */
     'replicationGroup'?: DsNrwReplicationGroupDto;
 }

package/dist/types/Coscine.Api/@coscine/model/deployed-graph-dto-paged-response.d.ts

@@ -11,10 +11,40 @@
  */
 import type { DeployedGraphDto } from './deployed-graph-dto';
 import type { Pagination } from './pagination';
+/**
+ *
+ * @export
+ * @interface DeployedGraphDtoPagedResponse
+ */
 export interface DeployedGraphDtoPagedResponse {
+    /**
+     *
+     * @type {Array<DeployedGraphDto>}
+     * @memberof DeployedGraphDtoPagedResponse
+     */
     'data'?: Array<DeployedGraphDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DeployedGraphDtoPagedResponse
+     */
     'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof DeployedGraphDtoPagedResponse
+     */
     'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DeployedGraphDtoPagedResponse
+     */
     'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof DeployedGraphDtoPagedResponse
+     */
     'pagination'?: Pagination;
 }

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

@@ -11,14 +11,20 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) for deployed graph details.
+ * @export
+ * @interface DeployedGraphDto
  */
 export interface DeployedGraphDto {
     /**
      * Graph URI and identifier.
+     * @type {string}
+     * @memberof DeployedGraphDto
      */
     'uri'?: string;
     /**
      * Collection of file hashes associated with the graph.
+     * @type {Array<string>}
+     * @memberof DeployedGraphDto
      */
     'fileHashes'?: Array<string>;
 }

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

@@ -11,10 +11,40 @@
  */
 import type { DisciplineDto } from './discipline-dto';
 import type { Pagination } from './pagination';
+/**
+ *
+ * @export
+ * @interface DisciplineDtoPagedResponse
+ */
 export interface DisciplineDtoPagedResponse {
+    /**
+     *
+     * @type {Array<DisciplineDto>}
+     * @memberof DisciplineDtoPagedResponse
+     */
     'data'?: Array<DisciplineDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DisciplineDtoPagedResponse
+     */
     'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof DisciplineDtoPagedResponse
+     */
     'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DisciplineDtoPagedResponse
+     */
     'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof DisciplineDtoPagedResponse
+     */
     'pagination'?: Pagination;
 }

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

@@ -10,9 +10,34 @@
  * Do not edit the class manually.
  */
 import type { DisciplineDto } from './discipline-dto';
+/**
+ *
+ * @export
+ * @interface DisciplineDtoResponse
+ */
 export interface DisciplineDtoResponse {
+    /**
+     *
+     * @type {DisciplineDto}
+     * @memberof DisciplineDtoResponse
+     */
     'data'?: DisciplineDto;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DisciplineDtoResponse
+     */
     'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof DisciplineDtoResponse
+     */
     'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof DisciplineDtoResponse
+     */
     'traceId'?: string | null;
 }

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

@@ -11,22 +11,32 @@
  */
 /**
  * Represents the data transfer object for a discipline.
+ * @export
+ * @interface DisciplineDto
  */
 export interface DisciplineDto {
     /**
      * The unique identifier for the discipline.
+     * @type {string}
+     * @memberof DisciplineDto
      */
     'id'?: string;
     /**
      * The URI associated with the discipline.
+     * @type {string}
+     * @memberof DisciplineDto
      */
     'uri'?: string;
     /**
      * The display name of the discipline in German.
+     * @type {string}
+     * @memberof DisciplineDto
      */
     'displayNameDe'?: string;
     /**
      * The display name of the discipline in English.
+     * @type {string}
+     * @memberof DisciplineDto
      */
     'displayNameEn'?: string;
 }

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

@@ -11,10 +11,14 @@
  */
 /**
  * Data transfer object (DTO) representing a discipline for project manipulation.
+ * @export
+ * @interface DisciplineForProjectManipulationDto
  */
 export interface DisciplineForProjectManipulationDto {
     /**
      * Gets or initializes the identifier of the discipline.
+     * @type {string}
+     * @memberof DisciplineForProjectManipulationDto
      */
     'id': string;
 }

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

@@ -11,10 +11,14 @@
  */
 /**
  * Data transfer object (DTO) representing a discipline for resource manipulation.
+ * @export
+ * @interface DisciplineForResourceManipulationDto
  */
 export interface DisciplineForResourceManipulationDto {
     /**
      * Gets or initializes the identifier of the discipline.
+     * @type {string}
+     * @memberof DisciplineForResourceManipulationDto
      */
     'id': string;
 }

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

@@ -11,10 +11,14 @@
  */
 /**
  * Data transfer object (DTO) representing a discipline for user manipulation.
+ * @export
+ * @interface DisciplineForUserManipulationDto
  */
 export interface DisciplineForUserManipulationDto {
     /**
      * Gets or initializes the identifier of the discipline.
+     * @type {string}
+     * @memberof DisciplineForUserManipulationDto
      */
     'id': string;
 }

package/dist/types/Coscine.Api/@coscine/model/ds-nrw-replication-group-dto.d.ts

@@ -11,6 +11,8 @@
  */
 /**
  * Possible replication groups for the DS NRW.
+ * @export
+ * @enum {string}
  */
 export declare const DsNrwReplicationGroupDto: {
     readonly RWTH_UDE: "RWTH-UDE";

package/dist/types/Coscine.Api/@coscine/model/ds-nrw-replication-group.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@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.
+ */
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const DsNrwReplicationGroup: {
+    readonly RWTH_UDE: "RWTH-UDE";
+    readonly UZK_UPB: "UZK-UPB";
+};
+export type DsNrwReplicationGroup = typeof DsNrwReplicationGroup[keyof typeof DsNrwReplicationGroup];

package/dist/types/Coscine.Api/@coscine/model/extracted-metadata-tree-for-creation-dto.d.ts

@@ -13,16 +13,32 @@ import type { ProvenanceParametersDto } from './provenance-parameters-dto';
 import type { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto';
 /**
  * Data transfer object (DTO) representing the creation of a metadata tree.  Extends the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.MetadataTreeForManipulationDto.
+ * @export
+ * @interface ExtractedMetadataTreeForCreationDto
  */
 export interface ExtractedMetadataTreeForCreationDto {
     /**
      * Gets or initializes the path of the metadata tree.
+     * @type {string}
+     * @memberof ExtractedMetadataTreeForCreationDto
      */
     'path': string;
     /**
      * Gets or sets the id of the new metadata tree.
+     * @type {string}
+     * @memberof ExtractedMetadataTreeForCreationDto
      */
     'id': string;
+    /**
+     *
+     * @type {RdfDefinitionForManipulationDto}
+     * @memberof ExtractedMetadataTreeForCreationDto
+     */
     'definition': RdfDefinitionForManipulationDto;
+    /**
+     *
+     * @type {ProvenanceParametersDto}
+     * @memberof ExtractedMetadataTreeForCreationDto
+     */
     'provenance': ProvenanceParametersDto;
 }

package/dist/types/Coscine.Api/@coscine/model/extracted-metadata-tree-for-update-dto.d.ts

@@ -13,20 +13,38 @@ import type { ProvenanceParametersDto } from './provenance-parameters-dto';
 import type { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto';
 /**
  * Data transfer object (DTO) representing the update of a metadata tree.  Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.MetadataTreeForManipulationDto.
+ * @export
+ * @interface ExtractedMetadataTreeForUpdateDto
  */
 export interface ExtractedMetadataTreeForUpdateDto {
     /**
      * Gets or initializes the path of the metadata tree.
+     * @type {string}
+     * @memberof ExtractedMetadataTreeForUpdateDto
      */
     'path': string;
     /**
      * Gets or sets the id of the to update metadata tree.
+     * @type {string}
+     * @memberof ExtractedMetadataTreeForUpdateDto
      */
     'id': string;
+    /**
+     *
+     * @type {RdfDefinitionForManipulationDto}
+     * @memberof ExtractedMetadataTreeForUpdateDto
+     */
     'definition': RdfDefinitionForManipulationDto;
+    /**
+     *
+     * @type {ProvenanceParametersDto}
+     * @memberof ExtractedMetadataTreeForUpdateDto
+     */
     'provenance': ProvenanceParametersDto;
     /**
      * Gets or initializes a flag for creating a new metadata version.
+     * @type {boolean}
+     * @memberof ExtractedMetadataTreeForUpdateDto
      */
     'forceNewMetadataVersion'?: boolean;
 }

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

@@ -12,11 +12,20 @@
 import type { FileActionHttpMethod } from './file-action-http-method';
 /**
  * Represents a Data Transfer Object (DTO) for file actions, including the URL and HTTP method.
+ * @export
+ * @interface FileActionDto
  */
 export interface FileActionDto {
     /**
      * Gets or sets the presigned URL associated with the file action.
+     * @type {string}
+     * @memberof FileActionDto
      */
     'url'?: string;
+    /**
+     *
+     * @type {FileActionHttpMethod}
+     * @memberof FileActionDto
+     */
     'method'?: FileActionHttpMethod;
 }

package/dist/types/Coscine.Api/@coscine/model/file-action-http-method.d.ts

@@ -11,6 +11,8 @@
  */
 /**
  * Represents the possible HTTP methods associated with file actions.
+ * @export
+ * @enum {string}
  */
 export declare const FileActionHttpMethod: {
     readonly GET: "GET";