@coscine/api-client 3.20.0 → 3.22.0

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

@@ -21,49 +21,86 @@ import type { UserMinimalDto } from './user-minimal-dto';
 import type { VisibilityDto } from './visibility-dto';
 /**
  * Represents a Data Transfer Object (DTO) for administrative purposes with additional resource details.
+ * @export
+ * @interface ResourceAdminDto
  */
 export interface ResourceAdminDto {
     /**
      * Unique identifier for the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
      */
     'id'?: string;
     /**
      * Persistent identifier for the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
      */
     'pid': string;
+    /**
+     *
+     * @type {ResourceTypeDto}
+     * @memberof ResourceAdminDto
+     */
     'type': ResourceTypeDto;
     /**
      * Name of the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
      */
     'name': string;
     /**
      * Display name of the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
      */
     'displayName': string;
     /**
      * Description of the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
      */
     'description': string;
     /**
      * Keywords associated with the resource.
+     * @type {Array<string>}
+     * @memberof ResourceAdminDto
      */
     'keywords'?: Array<string> | null;
+    /**
+     *
+     * @type {LicenseDto}
+     * @memberof ResourceAdminDto
+     */
     'license'?: LicenseDto;
     /**
      * Usage rights associated with the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
      */
     'usageRights'?: string | null;
     /**
      * Indicates whether a local copy of the metadata is available for the resource.
+     * @type {boolean}
+     * @memberof ResourceAdminDto
      */
     'metadataLocalCopy'?: boolean;
     /**
      * Indicates whether metadata extraction is enabled for the resource.
+     * @type {boolean}
+     * @memberof ResourceAdminDto
      */
     'metadataExtraction'?: boolean;
+    /**
+     *
+     * @type {ApplicationProfileMinimalDto}
+     * @memberof ResourceAdminDto
+     */
     'applicationProfile': ApplicationProfileMinimalDto;
     /**
      * Fixed values associated with resource manipulation.  This dictionary may contain multiple levels and is structured as follows:  Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto.
+     * @type {{ [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; }}
+     * @memberof ResourceAdminDto
      */
     'fixedValues': {
         [key: string]: {
@@ -72,33 +109,62 @@ export interface ResourceAdminDto {
     };
     /**
      * Disciplines associated with the resource.
+     * @type {Array<DisciplineDto>}
+     * @memberof ResourceAdminDto
      */
     'disciplines': Array<DisciplineDto>;
+    /**
+     *
+     * @type {VisibilityDto}
+     * @memberof ResourceAdminDto
+     */
     'visibility': VisibilityDto;
     /**
      * Date when the resource was created.
+     * @type {string}
+     * @memberof ResourceAdminDto
      */
     'dateCreated'?: string | null;
+    /**
+     *
+     * @type {UserMinimalDto}
+     * @memberof ResourceAdminDto
+     */
     'creator'?: UserMinimalDto;
     /**
      * Indicates whether the resource is archived.
+     * @type {boolean}
+     * @memberof ResourceAdminDto
      */
     'archived'?: boolean;
     /**
      * Indicates whether the resource is in maintenance mode.
+     * @type {boolean}
+     * @memberof ResourceAdminDto
      */
     'maintenanceMode'?: boolean;
     /**
      * The projects associated with the resource.
+     * @type {Array<ProjectMinimalDto>}
+     * @memberof ResourceAdminDto
      */
     'projects'?: Array<ProjectMinimalDto> | null;
     /**
      * Indicates whether the resource is deleted.
+     * @type {boolean}
+     * @memberof ResourceAdminDto
      */
     'deleted': boolean;
     /**
      * Collection of minimal project resource details associated with this resource.
+     * @type {Array<ProjectResourceMinimalDto>}
+     * @memberof ResourceAdminDto
      */
     'projectResources': Array<ProjectResourceMinimalDto>;
+    /**
+     *
+     * @type {ResourceQuotaDto}
+     * @memberof ResourceAdminDto
+     */
     'resourceQuota'?: ResourceQuotaDto;
 }

package/dist/types/Coscine.Api/@coscine/model/resource-content-page-columns-dto.d.ts

@@ -11,10 +11,14 @@
  */
 /**
  * Represents a set of columns to be displayed in the content view.
+ * @export
+ * @interface ResourceContentPageColumnsDto
  */
 export interface ResourceContentPageColumnsDto {
     /**
      * Set of columns that should always be displayed in the content view.
+     * @type {Set<string>}
+     * @memberof ResourceContentPageColumnsDto
      */
     'always'?: Set<string>;
 }

package/dist/types/Coscine.Api/@coscine/model/resource-content-page-dto.d.ts

@@ -13,12 +13,26 @@ import type { ResourceContentPageEntriesViewDto } from './resource-content-page-
 import type { ResourceContentPageMetadataViewDto } from './resource-content-page-metadata-view-dto';
 /**
  * Represents the content page details for a resource.
+ * @export
+ * @interface ResourceContentPageDto
  */
 export interface ResourceContentPageDto {
     /**
      * Indicates whether the resource is read-only.
+     * @type {boolean}
+     * @memberof ResourceContentPageDto
      */
     'readOnly'?: boolean;
+    /**
+     *
+     * @type {ResourceContentPageMetadataViewDto}
+     * @memberof ResourceContentPageDto
+     */
     'metadataView'?: ResourceContentPageMetadataViewDto;
+    /**
+     *
+     * @type {ResourceContentPageEntriesViewDto}
+     * @memberof ResourceContentPageDto
+     */
     'entriesView'?: ResourceContentPageEntriesViewDto;
 }

package/dist/types/Coscine.Api/@coscine/model/resource-content-page-entries-view-dto.d.ts

@@ -12,7 +12,14 @@
 import type { ResourceContentPageColumnsDto } from './resource-content-page-columns-dto';
 /**
  * Represents information about the resource type for the columns within the entries view Vue component.
+ * @export
+ * @interface ResourceContentPageEntriesViewDto
  */
 export interface ResourceContentPageEntriesViewDto {
+    /**
+     *
+     * @type {ResourceContentPageColumnsDto}
+     * @memberof ResourceContentPageEntriesViewDto
+     */
     'columns'?: ResourceContentPageColumnsDto;
 }

package/dist/types/Coscine.Api/@coscine/model/resource-content-page-metadata-view-dto.d.ts

@@ -11,14 +11,20 @@
  */
 /**
  * Represents the metadata view for a resource\'s content page.
+ * @export
+ * @interface ResourceContentPageMetadataViewDto
  */
 export interface ResourceContentPageMetadataViewDto {
     /**
      * Indicates if a data URL can be provided and is editable.
+     * @type {boolean}
+     * @memberof ResourceContentPageMetadataViewDto
      */
     'editableDataUrl'?: boolean;
     /**
      * Indicates if a key can be provided and is editable.
+     * @type {boolean}
+     * @memberof ResourceContentPageMetadataViewDto
      */
     'editableKey'?: boolean;
 }

package/dist/types/Coscine.Api/@coscine/model/resource-creation-page-dto.d.ts

@@ -11,10 +11,14 @@
  */
 /**
  * Represents the structure of resource type-specific components for steps in the resource creation page.
+ * @export
+ * @interface ResourceCreationPageDto
  */
 export interface ResourceCreationPageDto {
     /**
      * List of Lists containing all the resource type specific components for the steps in the resource creation page.
+     * @type {Array<Array<string>>}
+     * @memberof ResourceCreationPageDto
      */
     'components'?: Array<Array<string>>;
 }

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

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

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

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

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

@@ -19,49 +19,86 @@ import type { UserMinimalDto } from './user-minimal-dto';
 import type { VisibilityDto } from './visibility-dto';
 /**
  * Represents a Data Transfer Object (DTO) for resource details.
+ * @export
+ * @interface ResourceDto
  */
 export interface ResourceDto {
     /**
      * Unique identifier for the resource.
+     * @type {string}
+     * @memberof ResourceDto
      */
     'id'?: string;
     /**
      * Persistent identifier for the resource.
+     * @type {string}
+     * @memberof ResourceDto
      */
     'pid': string;
+    /**
+     *
+     * @type {ResourceTypeDto}
+     * @memberof ResourceDto
+     */
     'type': ResourceTypeDto;
     /**
      * Name of the resource.
+     * @type {string}
+     * @memberof ResourceDto
      */
     'name': string;
     /**
      * Display name of the resource.
+     * @type {string}
+     * @memberof ResourceDto
      */
     'displayName': string;
     /**
      * Description of the resource.
+     * @type {string}
+     * @memberof ResourceDto
      */
     'description': string;
     /**
      * Keywords associated with the resource.
+     * @type {Array<string>}
+     * @memberof ResourceDto
      */
     'keywords'?: Array<string> | null;
+    /**
+     *
+     * @type {LicenseDto}
+     * @memberof ResourceDto
+     */
     'license'?: LicenseDto;
     /**
      * Usage rights associated with the resource.
+     * @type {string}
+     * @memberof ResourceDto
      */
     'usageRights'?: string | null;
     /**
      * Indicates whether a local copy of the metadata is available for the resource.
+     * @type {boolean}
+     * @memberof ResourceDto
      */
     'metadataLocalCopy'?: boolean;
     /**
      * Indicates whether metadata extraction is enabled for the resource.
+     * @type {boolean}
+     * @memberof ResourceDto
      */
     'metadataExtraction'?: boolean;
+    /**
+     *
+     * @type {ApplicationProfileMinimalDto}
+     * @memberof ResourceDto
+     */
     'applicationProfile': ApplicationProfileMinimalDto;
     /**
      * Fixed values associated with resource manipulation.  This dictionary may contain multiple levels and is structured as follows:  Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto.
+     * @type {{ [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; }}
+     * @memberof ResourceDto
      */
     'fixedValues': {
         [key: string]: {
@@ -70,24 +107,44 @@ export interface ResourceDto {
     };
     /**
      * Disciplines associated with the resource.
+     * @type {Array<DisciplineDto>}
+     * @memberof ResourceDto
      */
     'disciplines': Array<DisciplineDto>;
+    /**
+     *
+     * @type {VisibilityDto}
+     * @memberof ResourceDto
+     */
     'visibility': VisibilityDto;
     /**
      * Date when the resource was created.
+     * @type {string}
+     * @memberof ResourceDto
      */
     'dateCreated'?: string | null;
+    /**
+     *
+     * @type {UserMinimalDto}
+     * @memberof ResourceDto
+     */
     'creator'?: UserMinimalDto;
     /**
      * Indicates whether the resource is archived.
+     * @type {boolean}
+     * @memberof ResourceDto
      */
     'archived'?: boolean;
     /**
      * Indicates whether the resource is in maintenance mode.
+     * @type {boolean}
+     * @memberof ResourceDto
      */
     'maintenanceMode'?: boolean;
     /**
      * The projects associated with the resource.
+     * @type {Array<ProjectMinimalDto>}
+     * @memberof ResourceDto
      */
     'projects'?: Array<ProjectMinimalDto> | null;
 }

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

@@ -17,50 +17,90 @@ import type { ResourceTypeOptionsForCreationDto } from './resource-type-options-
 import type { VisibilityForResourceManipulationDto } from './visibility-for-resource-manipulation-dto';
 /**
  * Represents the data transfer object (DTO) used for creating a resource.  Inherits properties from Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ResourceForManipulationDto.
+ * @export
+ * @interface ResourceForCreationDto
  */
 export interface ResourceForCreationDto {
     /**
      * The name of the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
      */
     'name': string;
     /**
      * The display name of the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
      */
     'displayName'?: string | null;
     /**
      * The description of the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
      */
     'description': string;
     /**
      * The keywords associated with the resource.
+     * @type {Array<string>}
+     * @memberof ResourceForCreationDto
      */
     'keywords'?: Array<string> | null;
     /**
      * Fixed values associated with the resource.
+     * @type {{ [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; }}
+     * @memberof ResourceForCreationDto
      */
     'fixedValues'?: {
         [key: string]: {
             [key: string]: Array<FixedValueForResourceManipulationDto>;
         };
     } | null;
+    /**
+     *
+     * @type {LicenseForResourceManipulationDto}
+     * @memberof ResourceForCreationDto
+     */
     'license'?: LicenseForResourceManipulationDto;
     /**
      * The usage rights description of the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
      */
     'usageRights'?: string | null;
     /**
      * If a local copy for the metadata should be created.
+     * @type {boolean}
+     * @memberof ResourceForCreationDto
      */
     'metadataLocalCopy'?: boolean | null;
+    /**
+     *
+     * @type {VisibilityForResourceManipulationDto}
+     * @memberof ResourceForCreationDto
+     */
     'visibility': VisibilityForResourceManipulationDto;
     /**
      * The disciplines associated with the resource.
+     * @type {Array<DisciplineForResourceManipulationDto>}
+     * @memberof ResourceForCreationDto
      */
     'disciplines': Array<DisciplineForResourceManipulationDto>;
     /**
      * The identifier of the resource type associated with the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
      */
     'resourceTypeId': string;
+    /**
+     *
+     * @type {ApplicationProfileForResourceCreationDto}
+     * @memberof ResourceForCreationDto
+     */
     'applicationProfile': ApplicationProfileForResourceCreationDto;
+    /**
+     *
+     * @type {ResourceTypeOptionsForCreationDto}
+     * @memberof ResourceForCreationDto
+     */
     'resourceTypeOptions': ResourceTypeOptionsForCreationDto;
 }

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

@@ -16,53 +16,90 @@ import type { ResourceTypeOptionsForUpdateDto } from './resource-type-options-fo
 import type { VisibilityForResourceManipulationDto } from './visibility-for-resource-manipulation-dto';
 /**
  * Represents the data transfer object (DTO) used for updating a resource.  Inherits properties from Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ResourceForManipulationDto.
+ * @export
+ * @interface ResourceForUpdateDto
  */
 export interface ResourceForUpdateDto {
     /**
      * The name of the resource.
+     * @type {string}
+     * @memberof ResourceForUpdateDto
      */
     'name': string;
     /**
      * The display name of the resource.
+     * @type {string}
+     * @memberof ResourceForUpdateDto
      */
     'displayName'?: string | null;
     /**
      * The description of the resource.
+     * @type {string}
+     * @memberof ResourceForUpdateDto
      */
     'description': string;
     /**
      * The keywords associated with the resource.
+     * @type {Array<string>}
+     * @memberof ResourceForUpdateDto
      */
     'keywords'?: Array<string> | null;
     /**
      * Fixed values associated with the resource.
+     * @type {{ [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; }}
+     * @memberof ResourceForUpdateDto
      */
     'fixedValues'?: {
         [key: string]: {
             [key: string]: Array<FixedValueForResourceManipulationDto>;
         };
     } | null;
+    /**
+     *
+     * @type {LicenseForResourceManipulationDto}
+     * @memberof ResourceForUpdateDto
+     */
     'license'?: LicenseForResourceManipulationDto;
     /**
      * The usage rights description of the resource.
+     * @type {string}
+     * @memberof ResourceForUpdateDto
      */
     'usageRights'?: string | null;
     /**
      * If a local copy for the metadata should be created.
+     * @type {boolean}
+     * @memberof ResourceForUpdateDto
      */
     'metadataLocalCopy'?: boolean | null;
+    /**
+     *
+     * @type {VisibilityForResourceManipulationDto}
+     * @memberof ResourceForUpdateDto
+     */
     'visibility': VisibilityForResourceManipulationDto;
     /**
      * The disciplines associated with the resource.
+     * @type {Array<DisciplineForResourceManipulationDto>}
+     * @memberof ResourceForUpdateDto
      */
     'disciplines': Array<DisciplineForResourceManipulationDto>;
     /**
      * Indicates whether the resource is archived.
+     * @type {boolean}
+     * @memberof ResourceForUpdateDto
      */
     'archived': boolean;
+    /**
+     *
+     * @type {ResourceTypeOptionsForUpdateDto}
+     * @memberof ResourceForUpdateDto
+     */
     'resourceTypeOptions'?: ResourceTypeOptionsForUpdateDto;
     /**
      * Indicates whether the resource is in maintenance mode.
+     * @type {boolean}
+     * @memberof ResourceForUpdateDto
      */
     'maintenanceMode'?: boolean | null;
 }

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

@@ -11,10 +11,14 @@
  */
 /**
  * Represents a minimal Data Transfer Object (DTO) for a resource, containing essential identifiers.
+ * @export
+ * @interface ResourceMinimalDto
  */
 export interface ResourceMinimalDto {
     /**
      * Unique identifier for the resource.
+     * @type {string}
+     * @memberof ResourceMinimalDto
      */
     'id': string;
 }

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

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