@coscine/api-client 3.20.0 → 3.22.0

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

@@ -13,13 +13,32 @@ import type { QuotaDto } from './quota-dto';
 import type { ResourceMinimalDto } from './resource-minimal-dto';
 /**
  * Represents a Data Transfer Object (DTO) containing quota information for a resource.
+ * @export
+ * @interface ResourceQuotaDto
  */
 export interface ResourceQuotaDto {
+    /**
+     *
+     * @type {ResourceMinimalDto}
+     * @memberof ResourceQuotaDto
+     */
     'resource': ResourceMinimalDto;
     /**
      * The percentage of quota used by the resource.
+     * @type {number}
+     * @memberof ResourceQuotaDto
      */
     'usedPercentage'?: number | null;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ResourceQuotaDto
+     */
     'used'?: QuotaDto;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ResourceQuotaDto
+     */
     'reserved'?: QuotaDto;
 }

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

@@ -12,19 +12,32 @@
 import type { ResourceTypeOptionsDto } from './resource-type-options-dto';
 /**
  * Represents a resource type.
+ * @export
+ * @interface ResourceTypeDto
  */
 export interface ResourceTypeDto {
     /**
      * The unique identifier of the resource type.
+     * @type {string}
+     * @memberof ResourceTypeDto
      */
     'id'?: string;
     /**
      * The general type of the resource.
+     * @type {string}
+     * @memberof ResourceTypeDto
      */
     'generalType': string;
     /**
      * The specific type of the resource.
+     * @type {string}
+     * @memberof ResourceTypeDto
      */
     'specificType': string;
+    /**
+     *
+     * @type {ResourceTypeOptionsDto}
+     * @memberof ResourceTypeDto
+     */
     'options'?: ResourceTypeOptionsDto;
 }

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

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

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

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

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

@@ -14,77 +14,128 @@ import type { ResourceCreationPageDto } from './resource-creation-page-dto';
 import type { ResourceTypeStatus } from './resource-type-status';
 /**
  * Represents information about a resource type.
+ * @export
+ * @interface ResourceTypeInformationDto
  */
 export interface ResourceTypeInformationDto {
     /**
      * The unique identifier of the resource type.
+     * @type {string}
+     * @memberof ResourceTypeInformationDto
      */
     'id'?: string;
     /**
      * The general type of the resource.
+     * @type {string}
+     * @memberof ResourceTypeInformationDto
      */
     'generalType'?: string | null;
     /**
      * The specific type of the resource.
+     * @type {string}
+     * @memberof ResourceTypeInformationDto
      */
     'specificType'?: string | null;
+    /**
+     *
+     * @type {ResourceTypeStatus}
+     * @memberof ResourceTypeInformationDto
+     */
     'status'?: ResourceTypeStatus;
     /**
      * Indicates if the resource type supports creation.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canCreate'?: boolean;
     /**
      * Indicates if the resource type supports reading.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canRead'?: boolean;
     /**
      * Indicates if the resource type supports read-only.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canSetResourceReadonly'?: boolean;
     /**
      * Indicates if the resource type supports updating.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canUpdate'?: boolean;
     /**
      * Indicates if the resource type supports updating (not an Object).
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canUpdateResource'?: boolean;
     /**
      * Indicates if the resource type supports deletion.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canDelete'?: boolean;
     /**
      * Indicates if the resource type supports deletion (not an Object).
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canDeleteResource'?: boolean;
     /**
      * Indicates if the resource type supports listing.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canList'?: boolean;
     /**
      * Indicates if the resource type supports linking.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canCreateLinks'?: boolean;
     /**
      * Indicates whether local backup of metadata is supported.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'canCopyLocalMetadata'?: boolean;
     /**
      * Indicates if the resource type is archived.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'isArchived'?: boolean;
     /**
      * Indicates if the resource type supports quota.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'isQuotaAvailable'?: boolean;
     /**
      * Indicates if the resource type quota can be changed.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'isQuotaAdjustable'?: boolean;
     /**
      * Indicates if the resource type is enabled.
+     * @type {boolean}
+     * @memberof ResourceTypeInformationDto
      */
     'isEnabled'?: boolean;
+    /**
+     *
+     * @type {ResourceCreationPageDto}
+     * @memberof ResourceTypeInformationDto
+     */
     'resourceCreation'?: ResourceCreationPageDto;
+    /**
+     *
+     * @type {ResourceContentPageDto}
+     * @memberof ResourceTypeInformationDto
+     */
     'resourceContent'?: ResourceContentPageDto;
 }

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

@@ -11,14 +11,20 @@
  */
 /**
  * Represents a minimal Data Transfer Object (DTO) for a resource type.
+ * @export
+ * @interface ResourceTypeMinimalDto
  */
 export interface ResourceTypeMinimalDto {
     /**
      * The unique identifier of the resource type.
+     * @type {string}
+     * @memberof ResourceTypeMinimalDto
      */
     'id': string;
     /**
      * The specific type of the resource.
+     * @type {string}
+     * @memberof ResourceTypeMinimalDto
      */
     'specificType': string;
 }

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

@@ -19,18 +19,62 @@ import type { RdsS3OptionsDto } from './rds-s3-options-dto';
 import type { RdsS3WormOptionsDto } from './rds-s3-worm-options-dto';
 /**
  * Represents the options available for different resource types.
+ * @export
+ * @interface ResourceTypeOptionsDto
  */
 export interface ResourceTypeOptionsDto {
     /**
      * Represents the data transfer object (DTO) for Linked Data options.
+     * @type {object}
+     * @memberof ResourceTypeOptionsDto
      */
     'linkedData'?: object;
+    /**
+     *
+     * @type {GitLabOptionsDto}
+     * @memberof ResourceTypeOptionsDto
+     */
     'gitLab'?: GitLabOptionsDto;
+    /**
+     *
+     * @type {RdsOptionsDto}
+     * @memberof ResourceTypeOptionsDto
+     */
     'rds'?: RdsOptionsDto;
+    /**
+     *
+     * @type {RdsS3OptionsDto}
+     * @memberof ResourceTypeOptionsDto
+     */
     'rdsS3'?: RdsS3OptionsDto;
+    /**
+     *
+     * @type {RdsS3WormOptionsDto}
+     * @memberof ResourceTypeOptionsDto
+     */
     'rdsS3Worm'?: RdsS3WormOptionsDto;
+    /**
+     *
+     * @type {FileSystemStorageOptionsDto}
+     * @memberof ResourceTypeOptionsDto
+     */
     'fileSystemStorage'?: FileSystemStorageOptionsDto;
+    /**
+     *
+     * @type {DataStorageNrwWebOptionsDto}
+     * @memberof ResourceTypeOptionsDto
+     */
     'dataStorageNrwWeb'?: DataStorageNrwWebOptionsDto;
+    /**
+     *
+     * @type {DataStorageNrwS3OptionsDto}
+     * @memberof ResourceTypeOptionsDto
+     */
     'dataStorageNrwS3'?: DataStorageNrwS3OptionsDto;
+    /**
+     *
+     * @type {DataStorageNrwS3WormOptionsDto}
+     * @memberof ResourceTypeOptionsDto
+     */
     'dataStorageNrwS3Worm'?: DataStorageNrwS3WormOptionsDto;
 }

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

@@ -18,17 +18,56 @@ import type { RdsS3ResourceTypeOptionsForManipulationDto } from './rds-s3-resour
 import type { RdsS3WormResourceTypeOptionsForManipulationDto } from './rds-s3-worm-resource-type-options-for-manipulation-dto';
 /**
  * Represents the data transfer object (DTO) for creating options related to any resource type.
+ * @export
+ * @interface ResourceTypeOptionsForCreationDto
  */
 export interface ResourceTypeOptionsForCreationDto {
     /**
      * Represents the data transfer object (DTO) for manipulating linked data resource type options.
+     * @type {object}
+     * @memberof ResourceTypeOptionsForCreationDto
      */
     'linkedResourceTypeOptions'?: object;
+    /**
+     *
+     * @type {GitlabResourceTypeOptionsForCreationDto}
+     * @memberof ResourceTypeOptionsForCreationDto
+     */
     'gitlabResourceTypeOptions'?: GitlabResourceTypeOptionsForCreationDto;
+    /**
+     *
+     * @type {RdsResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForCreationDto
+     */
     'rdsResourceTypeOptions'?: RdsResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {RdsS3ResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForCreationDto
+     */
     'rdsS3ResourceTypeOptions'?: RdsS3ResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {RdsS3WormResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForCreationDto
+     */
     'rdsS3WormResourceTypeOptions'?: RdsS3WormResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {DataStorageNrwWebResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForCreationDto
+     */
     'dataStorageNrwWebResourceTypeOptions'?: DataStorageNrwWebResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {DataStorageNrwS3ResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForCreationDto
+     */
     'dataStorageNrwS3ResourceTypeOptions'?: DataStorageNrwS3ResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {DataStorageNrwS3WormResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForCreationDto
+     */
     'dataStorageNrwS3WormResourceTypeOptions'?: DataStorageNrwS3WormResourceTypeOptionsForManipulationDto;
 }

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

@@ -18,17 +18,56 @@ import type { RdsS3ResourceTypeOptionsForManipulationDto } from './rds-s3-resour
 import type { RdsS3WormResourceTypeOptionsForManipulationDto } from './rds-s3-worm-resource-type-options-for-manipulation-dto';
 /**
  * Represents the data transfer object (DTO) used for updating options related to any resource type.
+ * @export
+ * @interface ResourceTypeOptionsForUpdateDto
  */
 export interface ResourceTypeOptionsForUpdateDto {
     /**
      * Represents the data transfer object (DTO) for manipulating linked data resource type options.
+     * @type {object}
+     * @memberof ResourceTypeOptionsForUpdateDto
      */
     'linkedResourceTypeOptions'?: object;
+    /**
+     *
+     * @type {GitlabResourceTypeOptionsForUpdateDto}
+     * @memberof ResourceTypeOptionsForUpdateDto
+     */
     'gitlabResourceTypeOptions'?: GitlabResourceTypeOptionsForUpdateDto;
+    /**
+     *
+     * @type {RdsResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForUpdateDto
+     */
     'rdsResourceTypeOptions'?: RdsResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {RdsS3ResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForUpdateDto
+     */
     'rdsS3ResourceTypeOptions'?: RdsS3ResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {RdsS3WormResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForUpdateDto
+     */
     'rdsS3WormResourceTypeOptions'?: RdsS3WormResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {DataStorageNrwWebResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForUpdateDto
+     */
     'dataStorageNrwWebResourceTypeOptions'?: DataStorageNrwWebResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {DataStorageNrwS3ResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForUpdateDto
+     */
     'dataStorageNrwS3ResourceTypeOptions'?: DataStorageNrwS3ResourceTypeOptionsForManipulationDto;
+    /**
+     *
+     * @type {DataStorageNrwS3WormResourceTypeOptionsForManipulationDto}
+     * @memberof ResourceTypeOptionsForUpdateDto
+     */
     'dataStorageNrwS3WormResourceTypeOptions'?: DataStorageNrwS3WormResourceTypeOptionsForManipulationDto;
 }

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

@@ -11,6 +11,8 @@
  */
 /**
  * Specifies the status of a resource type.
+ * @export
+ * @enum {string}
  */
 export declare const ResourceTypeStatus: {
     readonly hidden: "hidden";

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

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

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

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

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

@@ -11,18 +11,26 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) for a role.
+ * @export
+ * @interface RoleDto
  */
 export interface RoleDto {
     /**
      * The unique identifier of the role.
+     * @type {string}
+     * @memberof RoleDto
      */
     'id': string;
     /**
      * The display name of the role.
+     * @type {string}
+     * @memberof RoleDto
      */
     'displayName': string;
     /**
      * The description of the role.
+     * @type {string}
+     * @memberof RoleDto
      */
     'description': string;
 }

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

@@ -11,10 +11,14 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) containing minimal information about a role.
+ * @export
+ * @interface RoleMinimalDto
  */
 export interface RoleMinimalDto {
     /**
      * The unique identifier of the role.
+     * @type {string}
+     * @memberof RoleMinimalDto
      */
     'id': string;
 }

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

@@ -11,6 +11,8 @@
  */
 /**
  * Specifies the search item type.
+ * @export
+ * @enum {string}
  */
 export declare const SearchCategoryType: {
     readonly None: "None";

package/dist/types/Coscine.Api/@coscine/model/search-category.d.ts

@@ -11,14 +11,20 @@
  */
 /**
  * Represents a search category with a name and count of occurrences.
+ * @export
+ * @interface SearchCategory
  */
 export interface SearchCategory {
     /**
      * The name of the search category.
+     * @type {string}
+     * @memberof SearchCategory
      */
     'name'?: string;
     /**
      * The count of occurrences for the search category.
+     * @type {number}
+     * @memberof SearchCategory
      */
     'count'?: number;
 }

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

@@ -12,11 +12,46 @@
 import type { Pagination } from './pagination';
 import type { SearchCategory } from './search-category';
 import type { SearchResultDto } from './search-result-dto';
+/**
+ *
+ * @export
+ * @interface SearchResultDtoPagedSearchResponse
+ */
 export interface SearchResultDtoPagedSearchResponse {
+    /**
+     *
+     * @type {Array<SearchResultDto>}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
     'data'?: Array<SearchResultDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
     'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
     'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
     'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
     'pagination'?: Pagination;
+    /**
+     *
+     * @type {Array<SearchCategory>}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
     'categories'?: Array<SearchCategory> | null;
 }