@coscine/api-client 3.22.0 → 3.25.0

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>;
 }

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

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

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

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

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

@@ -16,117 +16,70 @@ import type { UserMinimalDto } from './user-minimal-dto';
 import type { VisibilityDto } from './visibility-dto';
 /**
  * Represents a data transfer object (DTO) for project information.
- * @export
- * @interface ProjectDto
  */
 export interface ProjectDto {
     /**
      * Unique identifier for the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'id': string;
     /**
      * Persistent identifier for the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'pid': string;
     /**
      * Name of the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'name': string;
     /**
      * Description of the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'description': string;
     /**
      * Start date of the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'startDate': string;
     /**
      * End date of the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'endDate': string;
     /**
      * Collection of keywords associated with the project.
-     * @type {Array<string>}
-     * @memberof ProjectDto
      */
     'keywords'?: Array<string> | null;
     /**
      * Display name of the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'displayName'?: string | null;
     /**
      * Principal investigators involved in the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'principleInvestigators'?: string | null;
     /**
      * Grant ID associated with the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'grantId'?: string | null;
-    /**
-     *
-     * @type {VisibilityDto}
-     * @memberof ProjectDto
-     */
     'visibility': VisibilityDto;
     /**
      * Disciplines related to the project.
-     * @type {Array<DisciplineDto>}
-     * @memberof ProjectDto
      */
     'disciplines': Array<DisciplineDto>;
     /**
      * Organizations associated with the project.
-     * @type {Array<ProjectOrganizationDto>}
-     * @memberof ProjectDto
      */
     'organizations': Array<ProjectOrganizationDto>;
     /**
      * Slug for the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'slug': string;
-    /**
-     *
-     * @type {UserMinimalDto}
-     * @memberof ProjectDto
-     */
     'creator'?: UserMinimalDto;
     /**
      * Date of creation of the project.
-     * @type {string}
-     * @memberof ProjectDto
      */
     'creationDate'?: string | null;
     /**
      * Collection of sub-projects associated with this project.
-     * @type {Array<ProjectDto>}
-     * @memberof ProjectDto
      * @deprecated
      */
     'subProjects'?: Array<ProjectDto> | null;
-    /**
-     *
-     * @type {ProjectMinimalDto}
-     * @memberof ProjectDto
-     */
     'parent'?: ProjectMinimalDto;
 }

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

@@ -14,86 +14,55 @@ import type { OrganizationForProjectManipulationDto } from './organization-for-p
 import type { VisibilityForProjectManipulationDto } from './visibility-for-project-manipulation-dto';
 /**
  * Data transfer object (DTO) representing the creation of a project.  Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ProjectForManipulationDto.
- * @export
- * @interface ProjectForCreationDto
  */
 export interface ProjectForCreationDto {
     /**
      * Gets or initializes the name of the project.
-     * @type {string}
-     * @memberof ProjectForCreationDto
      */
     'name': string;
     /**
      * Gets or initializes the description of the project.
-     * @type {string}
-     * @memberof ProjectForCreationDto
      */
     'description': string;
     /**
      * Gets or initializes the start date of the project.
-     * @type {string}
-     * @memberof ProjectForCreationDto
      */
     'startDate'?: string;
     /**
      * Gets or initializes the end date of the project.
-     * @type {string}
-     * @memberof ProjectForCreationDto
      */
     'endDate'?: string;
     /**
      * Gets or initializes the keywords associated with the project.
-     * @type {Array<string>}
-     * @memberof ProjectForCreationDto
      */
     'keywords'?: Array<string> | null;
     /**
      * Gets or initializes the display name of the project.
-     * @type {string}
-     * @memberof ProjectForCreationDto
      */
     'displayName'?: string | null;
     /**
      * Gets or initializes the principal investigators associated with the project.
-     * @type {string}
-     * @memberof ProjectForCreationDto
      */
     'principleInvestigators'?: string | null;
     /**
      * Gets or initializes the grant ID associated with the project.
-     * @type {string}
-     * @memberof ProjectForCreationDto
      */
     'grantId'?: string | null;
-    /**
-     *
-     * @type {VisibilityForProjectManipulationDto}
-     * @memberof ProjectForCreationDto
-     */
     'visibility': VisibilityForProjectManipulationDto;
     /**
      * Gets or initializes the disciplines associated with the project.
-     * @type {Array<DisciplineForProjectManipulationDto>}
-     * @memberof ProjectForCreationDto
      */
     'disciplines': Array<DisciplineForProjectManipulationDto>;
     /**
      * Gets or initializes the organizations associated with the project.
-     * @type {Array<OrganizationForProjectManipulationDto>}
-     * @memberof ProjectForCreationDto
      */
     'organizations': Array<OrganizationForProjectManipulationDto>;
     /**
      * Gets or initializes the identifier of the parent project.
-     * @type {string}
-     * @memberof ProjectForCreationDto
      */
     'parentId'?: string | null;
     /**
      * Gets or initializes if the owners of the parent project should be copied to the sub project.
-     * @type {boolean}
-     * @memberof ProjectForCreationDto
      */
     'copyOwnersFromParent'?: boolean | null;
 }

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

@@ -14,80 +14,51 @@ import type { OrganizationForProjectManipulationDto } from './organization-for-p
 import type { VisibilityForProjectManipulationDto } from './visibility-for-project-manipulation-dto';
 /**
  * Data transfer object (DTO) representing the update of a project.  Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ProjectForManipulationDto.
- * @export
- * @interface ProjectForUpdateDto
  */
 export interface ProjectForUpdateDto {
     /**
      * Gets or initializes the name of the project.
-     * @type {string}
-     * @memberof ProjectForUpdateDto
      */
     'name': string;
     /**
      * Gets or initializes the description of the project.
-     * @type {string}
-     * @memberof ProjectForUpdateDto
      */
     'description': string;
     /**
      * Gets or initializes the start date of the project.
-     * @type {string}
-     * @memberof ProjectForUpdateDto
      */
     'startDate'?: string;
     /**
      * Gets or initializes the end date of the project.
-     * @type {string}
-     * @memberof ProjectForUpdateDto
      */
     'endDate'?: string;
     /**
      * Gets or initializes the keywords associated with the project.
-     * @type {Array<string>}
-     * @memberof ProjectForUpdateDto
      */
     'keywords'?: Array<string> | null;
     /**
      * Gets or initializes the display name of the project.
-     * @type {string}
-     * @memberof ProjectForUpdateDto
      */
     'displayName'?: string | null;
     /**
      * Gets or initializes the principal investigators associated with the project.
-     * @type {string}
-     * @memberof ProjectForUpdateDto
      */
     'principleInvestigators'?: string | null;
     /**
      * Gets or initializes the grant ID associated with the project.
-     * @type {string}
-     * @memberof ProjectForUpdateDto
      */
     'grantId'?: string | null;
-    /**
-     *
-     * @type {VisibilityForProjectManipulationDto}
-     * @memberof ProjectForUpdateDto
-     */
     'visibility': VisibilityForProjectManipulationDto;
     /**
      * Gets or initializes the disciplines associated with the project.
-     * @type {Array<DisciplineForProjectManipulationDto>}
-     * @memberof ProjectForUpdateDto
      */
     'disciplines': Array<DisciplineForProjectManipulationDto>;
     /**
      * Gets or initializes the organizations associated with the project.
-     * @type {Array<OrganizationForProjectManipulationDto>}
-     * @memberof ProjectForUpdateDto
      */
     'organizations': Array<OrganizationForProjectManipulationDto>;
     /**
      * Gets or initializes the slug associated with the project for identification purposes.
-     * @type {string}
-     * @memberof ProjectForUpdateDto
      */
     'slug': string;
 }

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

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