@coscine/api-client 3.21.0 → 3.22.0

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

@@ -12,23 +12,38 @@
 import type { PublicationAdvisoryServiceDto } from './publication-advisory-service-dto';
 /**
  * Represents a data transfer object (DTO) for an organization in the context of a project.
+ * @export
+ * @interface ProjectOrganizationDto
  */
 export interface ProjectOrganizationDto {
     /**
      * The ROR (Research Organization Registry) ID of the organization.
+     * @type {string}
+     * @memberof ProjectOrganizationDto
      */
     'uri': string;
     /**
      * The display name of the organization.
+     * @type {string}
+     * @memberof ProjectOrganizationDto
      */
     'displayName': string;
     /**
      * The email address of the organization.
+     * @type {string}
+     * @memberof ProjectOrganizationDto
      */
     'email'?: string | null;
+    /**
+     *
+     * @type {PublicationAdvisoryServiceDto}
+     * @memberof ProjectOrganizationDto
+     */
     'publicationAdvisoryService'?: PublicationAdvisoryServiceDto;
     /**
      * Determines if the organization is Responsible for a given project.
+     * @type {boolean}
+     * @memberof ProjectOrganizationDto
      */
     'responsible': boolean;
 }

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

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

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

@@ -14,28 +14,50 @@ import type { ResourceMinimalDto } from './resource-minimal-dto';
 import type { UserMinimalDto } from './user-minimal-dto';
 /**
  * Represents a data transfer object (DTO) for a project publication request.
+ * @export
+ * @interface ProjectPublicationRequestDto
  */
 export interface ProjectPublicationRequestDto {
     /**
      * Unique identifier for the project publication request.
+     * @type {string}
+     * @memberof ProjectPublicationRequestDto
      */
     'id'?: string;
+    /**
+     *
+     * @type {ProjectMinimalDto}
+     * @memberof ProjectPublicationRequestDto
+     */
     'project'?: ProjectMinimalDto;
     /**
      * Identifier for the publication service used for this request.
+     * @type {string}
+     * @memberof ProjectPublicationRequestDto
      */
     'publicationServiceRorId'?: string;
+    /**
+     *
+     * @type {UserMinimalDto}
+     * @memberof ProjectPublicationRequestDto
+     */
     'creator'?: UserMinimalDto;
     /**
      * The date and time when the request was created.
+     * @type {string}
+     * @memberof ProjectPublicationRequestDto
      */
     'dateCreated'?: string;
     /**
      * Optional message associated with the publication request.
+     * @type {string}
+     * @memberof ProjectPublicationRequestDto
      */
     'message'?: string | null;
     /**
      * Collection of the resources involved in the publication request.
+     * @type {Array<ResourceMinimalDto>}
+     * @memberof ProjectPublicationRequestDto
      */
     'resources'?: Array<ResourceMinimalDto>;
 }

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

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

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

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

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

@@ -14,19 +14,50 @@ import type { ResourceQuotaDto } from './resource-quota-dto';
 import type { ResourceTypeMinimalDto } from './resource-type-minimal-dto';
 /**
  * Represents a data transfer object (DTO) containing quota information for a project.
+ * @export
+ * @interface ProjectQuotaDto
  */
 export interface ProjectQuotaDto {
     /**
      * Identifier of the project.
+     * @type {string}
+     * @memberof ProjectQuotaDto
      */
     'projectId'?: string;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ProjectQuotaDto
+     */
     'totalUsed'?: QuotaDto;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ProjectQuotaDto
+     */
     'totalReserved'?: QuotaDto;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ProjectQuotaDto
+     */
     'allocated'?: QuotaDto;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ProjectQuotaDto
+     */
     'maximum'?: QuotaDto;
+    /**
+     *
+     * @type {ResourceTypeMinimalDto}
+     * @memberof ProjectQuotaDto
+     */
     'resourceType'?: ResourceTypeMinimalDto;
     /**
      * Quota information for individual resources of the selected project\'s resource type.
+     * @type {Array<ResourceQuotaDto>}
+     * @memberof ProjectQuotaDto
      */
     'resourceQuotas'?: Array<ResourceQuotaDto> | null;
 }

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

@@ -12,8 +12,20 @@
 import type { QuotaForManipulationDto } from './quota-for-manipulation-dto';
 /**
  * Data transfer object (DTO) representing the update of project quotas.
+ * @export
+ * @interface ProjectQuotaForUpdateDto
  */
 export interface ProjectQuotaForUpdateDto {
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof ProjectQuotaForUpdateDto
+     */
     'allocated': QuotaForManipulationDto;
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof ProjectQuotaForUpdateDto
+     */
     'maximum'?: QuotaForManipulationDto;
 }

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

@@ -11,14 +11,20 @@
  */
 /**
  * Represents a minimal data transfer object (DTO) for a project resource.
+ * @export
+ * @interface ProjectResourceMinimalDto
  */
 export interface ProjectResourceMinimalDto {
     /**
      * Identifier of the resource.
+     * @type {string}
+     * @memberof ProjectResourceMinimalDto
      */
     'resourceId'?: string;
     /**
      * Identifier of the project associated with the resource.
+     * @type {string}
+     * @memberof ProjectResourceMinimalDto
      */
     'projectId'?: string;
 }

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

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

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

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

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

@@ -14,13 +14,32 @@ import type { PublicUserDto } from './public-user-dto';
 import type { RoleDto } from './role-dto';
 /**
  * Represents a data transfer object (DTO) for a project role.
+ * @export
+ * @interface ProjectRoleDto
  */
 export interface ProjectRoleDto {
     /**
      * Identifier of the project role.
+     * @type {string}
+     * @memberof ProjectRoleDto
      */
     'id'?: string;
+    /**
+     *
+     * @type {ProjectMinimalDto}
+     * @memberof ProjectRoleDto
+     */
     'project'?: ProjectMinimalDto;
+    /**
+     *
+     * @type {RoleDto}
+     * @memberof ProjectRoleDto
+     */
     'role'?: RoleDto;
+    /**
+     *
+     * @type {PublicUserDto}
+     * @memberof ProjectRoleDto
+     */
     'user'?: PublicUserDto;
 }

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

@@ -11,14 +11,20 @@
  */
 /**
  * Data transfer object (DTO) representing the creation of a project role within a project.  Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ProjectRoleForProjectManipulationDto.
+ * @export
+ * @interface ProjectRoleForProjectCreationDto
  */
 export interface ProjectRoleForProjectCreationDto {
     /**
      * Gets or initializes the identifier of the role associated with the project manipulation.
+     * @type {string}
+     * @memberof ProjectRoleForProjectCreationDto
      */
     'roleId': string;
     /**
      * Gets or initializes the identifier of the user associated with the project role creation.
+     * @type {string}
+     * @memberof ProjectRoleForProjectCreationDto
      */
     'userId': string;
 }

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

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

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

@@ -11,18 +11,26 @@
  */
 /**
  * Represents a minimal data transfer object (DTO) for a project role.
+ * @export
+ * @interface ProjectRoleMinimalDto
  */
 export interface ProjectRoleMinimalDto {
     /**
      * Identifier of the project associated with the role.
+     * @type {string}
+     * @memberof ProjectRoleMinimalDto
      */
     'projectId'?: string;
     /**
      * Identifier of the user associated with the role.
+     * @type {string}
+     * @memberof ProjectRoleMinimalDto
      */
     'userId'?: string;
     /**
      * Identifier of the role.
+     * @type {string}
+     * @memberof ProjectRoleMinimalDto
      */
     'roleId'?: string;
 }

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

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

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

@@ -13,31 +13,50 @@ import type { HashParametersDto } from './hash-parameters-dto';
 import type { VariantDto } from './variant-dto';
 /**
  * Represents a data transfer object (DTO) for provenance information.
+ * @export
+ * @interface ProvenanceDto
  */
 export interface ProvenanceDto {
     /**
      * Gets or sets the id of the current metadata graph.
+     * @type {string}
+     * @memberof ProvenanceDto
      */
     'id': string;
     /**
      * Gets or sets the date and time when the metadata was generated.
+     * @type {string}
+     * @memberof ProvenanceDto
      */
     'generatedAt'?: string | null;
     /**
      * Gets or sets the adapted versions from the specific metadata tree.
+     * @type {Array<string>}
+     * @memberof ProvenanceDto
      */
     'wasRevisionOf': Array<string>;
     /**
      * Gets or sets the variants of the specific metadata tree.
+     * @type {Array<VariantDto>}
+     * @memberof ProvenanceDto
      */
     'variants': Array<VariantDto>;
     /**
      * The similarity to the last version.
+     * @type {number}
+     * @memberof ProvenanceDto
      */
     'similarityToLastVersion'?: number | null;
     /**
      * Information if the specific metadata tree was invalidated by something.
+     * @type {string}
+     * @memberof ProvenanceDto
      */
     'wasInvalidatedBy'?: string | null;
+    /**
+     *
+     * @type {HashParametersDto}
+     * @memberof ProvenanceDto
+     */
     'hashParameters'?: HashParametersDto;
 }

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

@@ -13,31 +13,50 @@ import type { HashParametersDto } from './hash-parameters-dto';
 import type { VariantDto } from './variant-dto';
 /**
  * Data transfer object (DTO) representing the update of provenance  Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ProvenanceParametersDto.
+ * @export
+ * @interface ProvenanceForUpdateDto
  */
 export interface ProvenanceForUpdateDto {
     /**
      * Gets or sets the adapted versions from the specific metadata tree.
+     * @type {Array<string>}
+     * @memberof ProvenanceForUpdateDto
      */
     'wasRevisionOf'?: Array<string>;
     /**
      * Gets or sets the variants of the specific metadata tree.
+     * @type {Array<VariantDto>}
+     * @memberof ProvenanceForUpdateDto
      */
     'variants'?: Array<VariantDto>;
     /**
      * Information if the specific metadata tree was invalidated by something.
+     * @type {string}
+     * @memberof ProvenanceForUpdateDto
      */
     'wasInvalidatedBy'?: string | null;
     /**
      * The similarity to the last version.
+     * @type {number}
+     * @memberof ProvenanceForUpdateDto
      */
     'similarityToLastVersion'?: number | null;
     /**
      * Gets or initializes the version of the metadata extractor.
+     * @type {string}
+     * @memberof ProvenanceForUpdateDto
      */
     'metadataExtractorVersion'?: string | null;
+    /**
+     *
+     * @type {HashParametersDto}
+     * @memberof ProvenanceForUpdateDto
+     */
     'hashParameters'?: HashParametersDto;
     /**
      * Gets or sets the id of the specific metadata tree.
+     * @type {string}
+     * @memberof ProvenanceForUpdateDto
      */
     'id': string;
 }

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

@@ -13,27 +13,44 @@ import type { HashParametersDto } from './hash-parameters-dto';
 import type { VariantDto } from './variant-dto';
 /**
  * Data transfer object (DTO) representing Provenance Parameters in a request.
+ * @export
+ * @interface ProvenanceParametersDto
  */
 export interface ProvenanceParametersDto {
     /**
      * Gets or sets the adapted versions from the specific metadata tree.
+     * @type {Array<string>}
+     * @memberof ProvenanceParametersDto
      */
     'wasRevisionOf'?: Array<string>;
     /**
      * Gets or sets the variants of the specific metadata tree.
+     * @type {Array<VariantDto>}
+     * @memberof ProvenanceParametersDto
      */
     'variants'?: Array<VariantDto>;
     /**
      * Information if the specific metadata tree was invalidated by something.
+     * @type {string}
+     * @memberof ProvenanceParametersDto
      */
     'wasInvalidatedBy'?: string | null;
     /**
      * The similarity to the last version.
+     * @type {number}
+     * @memberof ProvenanceParametersDto
      */
     'similarityToLastVersion'?: number | null;
     /**
      * Gets or initializes the version of the metadata extractor.
+     * @type {string}
+     * @memberof ProvenanceParametersDto
      */
     'metadataExtractorVersion'?: string | null;
+    /**
+     *
+     * @type {HashParametersDto}
+     * @memberof ProvenanceParametersDto
+     */
     'hashParameters'?: HashParametersDto;
 }

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

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