@coscine/api-client 3.18.0 → 3.20.0

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

@@ -11,26 +11,18 @@
  */
 /**
  * Data transfer object (DTO) for deleting a specific version of metadata.
- * @export
- * @interface MetadataTreeForDeletionDto
  */
 export interface MetadataTreeForDeletionDto {
     /**
      * Gets or initializes the path of the metadata tree.
-     * @type {string}
-     * @memberof MetadataTreeForDeletionDto
      */
     'path': string;
     /**
      * Gets or initializes the version of the metadata tree to be deleted.
-     * @type {number}
-     * @memberof MetadataTreeForDeletionDto
      */
     'version': number;
     /**
      * Gets or initializes the invalidation entity.
-     * @type {string}
-     * @memberof MetadataTreeForDeletionDto
      */
     'invalidatedBy': string;
 }

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

@@ -12,20 +12,11 @@
 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 MetadataTreeForUpdateDto
  */
 export interface MetadataTreeForUpdateDto {
     /**
      * Gets or initializes the path of the metadata tree.
-     * @type {string}
-     * @memberof MetadataTreeForUpdateDto
      */
     'path': string;
-    /**
-     *
-     * @type {RdfDefinitionForManipulationDto}
-     * @memberof MetadataTreeForUpdateDto
-     */
     'definition': RdfDefinitionForManipulationDto;
 }

package/dist/types/Coscine.Api/@coscine/model/metadata-update-admin-parameters.d.ts

@@ -12,14 +12,7 @@
 import type { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto';
 /**
  * Represents parameters for updating metadata in an administrative context.
- * @export
- * @interface MetadataUpdateAdminParameters
  */
 export interface MetadataUpdateAdminParameters {
-    /**
-     *
-     * @type {RdfDefinitionForManipulationDto}
-     * @memberof MetadataUpdateAdminParameters
-     */
     'definition': RdfDefinitionForManipulationDto;
 }

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

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

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

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

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

@@ -11,26 +11,18 @@
  */
 /**
  * Represents a minimal data transfer object (DTO) for a notification.
- * @export
- * @interface NotificationDto
  */
 export interface NotificationDto {
     /**
      * Unique identifier for the project notification.
-     * @type {string}
-     * @memberof NotificationDto
      */
     'id': string;
     /**
      * Category of the notification.
-     * @type {string}
-     * @memberof NotificationDto
      */
     'category': string;
     /**
      * Field which clarifies if the notification is optional or not.
-     * @type {boolean}
-     * @memberof NotificationDto
      */
     'isOptional': boolean;
 }

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

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

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

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

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

@@ -12,32 +12,19 @@
 import type { PublicationAdvisoryServiceDto } from './publication-advisory-service-dto';
 /**
  * Represents a data transfer object (DTO) for an organization, including its ROR (Research Organization Registry) ID, display name, and email address.
- * @export
- * @interface OrganizationDto
  */
 export interface OrganizationDto {
     /**
      * The ROR (Research Organization Registry) ID of the organization.
-     * @type {string}
-     * @memberof OrganizationDto
      */
     'uri': string;
     /**
      * The display name of the organization.
-     * @type {string}
-     * @memberof OrganizationDto
      */
     'displayName': string;
     /**
      * The email address of the organization.
-     * @type {string}
-     * @memberof OrganizationDto
      */
     'email'?: string | null;
-    /**
-     *
-     * @type {PublicationAdvisoryServiceDto}
-     * @memberof OrganizationDto
-     */
     'publicationAdvisoryService'?: PublicationAdvisoryServiceDto;
 }

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

@@ -11,20 +11,14 @@
  */
 /**
  * Data transfer object (DTO) representing an organization for project manipulation.
- * @export
- * @interface OrganizationForProjectManipulationDto
  */
 export interface OrganizationForProjectManipulationDto {
     /**
      * Gets or initializes the URI of the organization.
-     * @type {string}
-     * @memberof OrganizationForProjectManipulationDto
      */
     'uri': string;
     /**
      * Gets or initializes if the organization is responsible.
-     * @type {boolean}
-     * @memberof OrganizationForProjectManipulationDto
      */
     'responsible': boolean;
 }

package/dist/types/Coscine.Api/@coscine/model/pagination.d.ts

@@ -11,44 +11,30 @@
  */
 /**
  * Represents pagination information for a collection of items.
- * @export
- * @interface Pagination
  */
 export interface Pagination {
     /**
      * Gets or sets the current page number.
-     * @type {number}
-     * @memberof Pagination
      */
     'currentPage'?: number;
     /**
      * Gets or sets the total number of pages.
-     * @type {number}
-     * @memberof Pagination
      */
     'totalPages'?: number;
     /**
      * Gets or sets the number of items per page.
-     * @type {number}
-     * @memberof Pagination
      */
     'pageSize'?: number;
     /**
      * Gets or sets the total count of items across all pages.
-     * @type {number}
-     * @memberof Pagination
      */
     'totalCount'?: number;
     /**
      * Gets a value indicating whether there is a previous page.
-     * @type {boolean}
-     * @memberof Pagination
      */
     'hasPrevious'?: boolean;
     /**
      * Gets a value indicating whether there is a next page.
-     * @type {boolean}
-     * @memberof Pagination
      */
     'hasNext'?: boolean;
 }

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

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

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

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

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

@@ -12,38 +12,23 @@
 import type { PidType } from './pid-type';
 /**
  * Represents a data transfer object (DTO) for a PID (Persistent Identifier).
- * @export
- * @interface PidDto
  */
 export interface PidDto {
     /**
      * Gets or sets the prefix of the PID.
-     * @type {string}
-     * @memberof PidDto
      */
     'prefix': string;
     /**
      * Gets or sets the suffix of the PID.
-     * @type {string}
-     * @memberof PidDto
      */
     'suffix': string;
     /**
      * Gets the constructed PID by combining the prefix and suffix (\"{Prefix}/{Suffix}\").
-     * @type {string}
-     * @memberof PidDto
      */
     'identifier'?: string;
-    /**
-     *
-     * @type {PidType}
-     * @memberof PidDto
-     */
     'type'?: PidType;
     /**
      * Gets or sets a value indicating whether the linked entity is considered valid.
-     * @type {boolean}
-     * @memberof PidDto
      */
     'isEntityValid'?: boolean;
 }

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

@@ -11,32 +11,22 @@
  */
 /**
  * Data transfer object (DTO) representing a PID request.
- * @export
- * @interface PidRequestDto
  */
 export interface PidRequestDto {
     /**
      * Gets or initializes the name associated with the PID request.
-     * @type {string}
-     * @memberof PidRequestDto
      */
     'name': string;
     /**
      * Gets or initializes the email associated with the PID request.
-     * @type {string}
-     * @memberof PidRequestDto
      */
     'email': string;
     /**
      * Gets or initializes the message for the PID request.
-     * @type {string}
-     * @memberof PidRequestDto
      */
     'message': string;
     /**
      * Gets or initializes whether to send a confirmation email for the PID request.
-     * @type {boolean}
-     * @memberof PidRequestDto
      */
     'sendConfirmationEmail'?: boolean;
 }

package/dist/types/Coscine.Api/@coscine/model/pid-type.d.ts

@@ -11,8 +11,6 @@
  */
 /**
  * Specifies the type of PID.
- * @export
- * @enum {string}
  */
 export declare const PidType: {
     readonly project: "project";

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

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

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

@@ -21,147 +21,90 @@ import type { UserMinimalDto } from './user-minimal-dto';
 import type { VisibilityDto } from './visibility-dto';
 /**
  * Represents a data transfer object (DTO) for an administrative view of a project.  Extends the base information in Coscine.Api.Core.Shared.DataTransferObjects.ReturnObjects.ProjectDto.
- * @export
- * @interface ProjectAdminDto
  */
 export interface ProjectAdminDto {
     /**
      * Unique identifier for the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'id': string;
     /**
      * Persistent identifier for the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'pid': string;
     /**
      * Name of the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'name': string;
     /**
      * Description of the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'description': string;
     /**
      * Start date of the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'startDate': string;
     /**
      * End date of the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'endDate': string;
     /**
      * Collection of keywords associated with the project.
-     * @type {Array<string>}
-     * @memberof ProjectAdminDto
      */
     'keywords'?: Array<string> | null;
     /**
      * Display name of the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'displayName'?: string | null;
     /**
      * Principal investigators involved in the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'principleInvestigators'?: string | null;
     /**
      * Grant ID associated with the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'grantId'?: string | null;
-    /**
-     *
-     * @type {VisibilityDto}
-     * @memberof ProjectAdminDto
-     */
     'visibility': VisibilityDto;
     /**
      * Disciplines related to the project.
-     * @type {Array<DisciplineDto>}
-     * @memberof ProjectAdminDto
      */
     'disciplines': Array<DisciplineDto>;
     /**
      * Organizations associated with the project.
-     * @type {Array<ProjectOrganizationDto>}
-     * @memberof ProjectAdminDto
      */
     'organizations': Array<ProjectOrganizationDto>;
     /**
      * Slug for the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'slug': string;
-    /**
-     *
-     * @type {UserMinimalDto}
-     * @memberof ProjectAdminDto
-     */
     'creator'?: UserMinimalDto;
     /**
      * Date of creation of the project.
-     * @type {string}
-     * @memberof ProjectAdminDto
      */
     'creationDate'?: string | null;
     /**
      * Collection of sub-projects associated with this project.
-     * @type {Array<ProjectDto>}
-     * @memberof ProjectAdminDto
      * @deprecated
      */
     'subProjects'?: Array<ProjectDto> | null;
-    /**
-     *
-     * @type {ProjectMinimalDto}
-     * @memberof ProjectAdminDto
-     */
     'parent'?: ProjectMinimalDto;
     /**
      * Indicates whether the project is marked as deleted.
-     * @type {boolean}
-     * @memberof ProjectAdminDto
      */
     'deleted'?: boolean;
     /**
      * Collection of minimal project resource details associated with the project.
-     * @type {Array<ProjectResourceMinimalDto>}
-     * @memberof ProjectAdminDto
      */
     'projectResources'?: Array<ProjectResourceMinimalDto>;
     /**
      * Collection of minimal project role details associated with the project.
-     * @type {Array<ProjectRoleMinimalDto>}
-     * @memberof ProjectAdminDto
      */
     'projectRoles'?: Array<ProjectRoleMinimalDto>;
     /**
      * Collection of project quotas associated with the project.
-     * @type {Array<ProjectQuotaDto>}
-     * @memberof ProjectAdminDto
      */
     'projectQuota'?: Array<ProjectQuotaDto>;
     /**
      * Collection of project publication requests associated with the project.
-     * @type {Array<ProjectPublicationRequestDto>}
-     * @memberof ProjectAdminDto
      */
     'publicationRequests'?: Array<ProjectPublicationRequestDto>;
 }