@coscine/api-client 3.21.0 → 3.22.0

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

@@ -12,27 +12,44 @@
 import type { TitleDto } from './title-dto';
 /**
  * Represents a public user data transfer object (DTO).
+ * @export
+ * @interface PublicUserDto
  */
 export interface PublicUserDto {
     /**
      * Gets the unique identifier of the user.
+     * @type {string}
+     * @memberof PublicUserDto
      */
     'id': string;
     /**
      * Gets the display name of the user.
+     * @type {string}
+     * @memberof PublicUserDto
      */
     'displayName': string;
     /**
      * Gets the given name of the user.
+     * @type {string}
+     * @memberof PublicUserDto
      */
     'givenName'?: string | null;
     /**
      * Gets the family name of the user.
+     * @type {string}
+     * @memberof PublicUserDto
      */
     'familyName'?: string | null;
     /**
      * Gets the email address of the user.
+     * @type {string}
+     * @memberof PublicUserDto
      */
     'email'?: string | null;
+    /**
+     *
+     * @type {TitleDto}
+     * @memberof PublicUserDto
+     */
     'title'?: TitleDto;
 }

package/dist/types/Coscine.Api/@coscine/model/publication-advisory-service-dto-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@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 type { Pagination } from './pagination';
+import type { PublicationAdvisoryServiceDto } from './publication-advisory-service-dto';
+/**
+ *
+ * @export
+ * @interface PublicationAdvisoryServiceDtoPagedResponse
+ */
+export interface PublicationAdvisoryServiceDtoPagedResponse {
+    /**
+     *
+     * @type {Array<PublicationAdvisoryServiceDto>}
+     * @memberof PublicationAdvisoryServiceDtoPagedResponse
+     */
+    'data'?: Array<PublicationAdvisoryServiceDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PublicationAdvisoryServiceDtoPagedResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PublicationAdvisoryServiceDtoPagedResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PublicationAdvisoryServiceDtoPagedResponse
+     */
+    'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof PublicationAdvisoryServiceDtoPagedResponse
+     */
+    'pagination'?: Pagination;
+}

package/dist/types/Coscine.Api/@coscine/model/publication-advisory-service-dto.d.ts

@@ -11,18 +11,32 @@
  */
 /**
  * Data transfer object (DTO) representing the publication advisory service of an organization.
+ * @export
+ * @interface PublicationAdvisoryServiceDto
  */
 export interface PublicationAdvisoryServiceDto {
     /**
-     * The data publication service\'s display name.
+     * Gets the data publication service\'s display name.
+     * @type {string}
+     * @memberof PublicationAdvisoryServiceDto
      */
     'displayName': string;
     /**
-     * The data publication service\'s email address.
+     * Gets the data publication service\'s email address.
+     * @type {string}
+     * @memberof PublicationAdvisoryServiceDto
      */
     'email': string;
     /**
-     * The data publication service\'s description.
+     * Gets the data publication service\'s description.
+     * @type {string}
+     * @memberof PublicationAdvisoryServiceDto
      */
     'description'?: string | null;
+    /**
+     * Gets the ROR of the organization that provides this publication service.
+     * @type {string}
+     * @memberof PublicationAdvisoryServiceDto
+     */
+    'organizationRor'?: string | null;
 }

package/dist/types/Coscine.Api/@coscine/model/publication-request-for-creation-dto.d.ts

@@ -11,18 +11,26 @@
  */
 /**
  * Data transfer object (DTO) representing the creation of a publication request.
+ * @export
+ * @interface PublicationRequestForCreationDto
  */
 export interface PublicationRequestForCreationDto {
     /**
      * The data publication service\'s ror id.
+     * @type {string}
+     * @memberof PublicationRequestForCreationDto
      */
     'publicationServiceRorId': string;
     /**
      * The resource guids.
+     * @type {Array<string>}
+     * @memberof PublicationRequestForCreationDto
      */
     'resourceIds': Array<string>;
     /**
      * A message of the requester.
+     * @type {string}
+     * @memberof PublicationRequestForCreationDto
      */
     'message'?: string | null;
 }

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

@@ -12,11 +12,20 @@
 import type { 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

@@ -12,11 +12,20 @@
 import type { 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

@@ -11,6 +11,8 @@
  */
 /**
  * Specifies the unit of quota.
+ * @export
+ * @enum {string}
  */
 export declare const QuotaUnit: {
     readonly https___qudt_org_vocab_unit_BYTE: "https://qudt.org/vocab/unit/BYTE";

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

@@ -10,9 +10,34 @@
  * Do not edit the class manually.
  */
 import type { 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

@@ -11,14 +11,20 @@
  */
 /**
  * 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

@@ -12,11 +12,20 @@
 import type { 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

@@ -11,6 +11,8 @@
  */
 /**
  * Specifies the RDF <i>(Resource Description Framework)</i> format.
+ * @export
+ * @enum {string}
  */
 export declare const RdfFormat: {
     readonly text_turtle: "text/turtle";

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

@@ -12,10 +12,14 @@
 import type { RdfPatchOperationDto } from './rdf-patch-operation-dto';
 /**
  * Represents an RDF Patch document containing a series of operations.
+ * @export
+ * @interface RdfPatchDocumentDto
  */
 export interface RdfPatchDocumentDto {
     /**
      * The list of operations in the RDF Patch document.
+     * @type {Array<RdfPatchOperationDto>}
+     * @memberof RdfPatchDocumentDto
      */
     'operations'?: Array<RdfPatchOperationDto>;
 }

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

@@ -13,8 +13,20 @@ import type { RdfDefinitionForManipulationDto } from './rdf-definition-for-manip
 import type { RdfPatchOperationType } from './rdf-patch-operation-type';
 /**
  * Represents a single operation in an RDF Patch document.
+ * @export
+ * @interface RdfPatchOperationDto
  */
 export interface RdfPatchOperationDto {
+    /**
+     *
+     * @type {RdfPatchOperationType}
+     * @memberof RdfPatchOperationDto
+     */
     'operationType'?: RdfPatchOperationType;
+    /**
+     *
+     * @type {RdfDefinitionForManipulationDto}
+     * @memberof RdfPatchOperationDto
+     */
     'changes'?: RdfDefinitionForManipulationDto;
 }

package/dist/types/Coscine.Api/@coscine/model/rdf-patch-operation-type.d.ts

@@ -11,6 +11,8 @@
  */
 /**
  * Represents the types of operations that can be performed in an RDF Patch document.
+ * @export
+ * @enum {string}
  */
 export declare const RdfPatchOperationType: {
     readonly A: "A";

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

@@ -12,11 +12,20 @@
 import type { 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

@@ -12,7 +12,14 @@
 import type { 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

@@ -12,31 +12,50 @@
 import type { 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

@@ -12,7 +12,14 @@
 import type { 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

@@ -12,31 +12,50 @@
 import type { 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

@@ -12,7 +12,14 @@
 import type { 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-paged-response.d.ts

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