@coscine/api-client 3.20.0 → 3.22.0

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

@@ -11,14 +11,20 @@
  */
 /**
  * Data transfer object (DTO) representing Hash Parameters in a request.
+ * @export
+ * @interface HashParametersDto
  */
 export interface HashParametersDto {
     /**
      * Gets or initializes the hash algorithm name.
+     * @type {string}
+     * @memberof HashParametersDto
      */
     'algorithmName': string;
     /**
      * Gets or initializes the hash value.
+     * @type {string}
+     * @memberof HashParametersDto
      */
     'value': string;
 }

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

@@ -11,14 +11,20 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) for an identity provider.
+ * @export
+ * @interface IdentityProviderDto
  */
 export interface IdentityProviderDto {
     /**
      * Gets or sets the unique identifier for the identity provider.
+     * @type {string}
+     * @memberof IdentityProviderDto
      */
     'id': string;
     /**
      * Gets or sets the display name of the identity provider.
+     * @type {string}
+     * @memberof IdentityProviderDto
      */
     'displayName': string;
 }

package/dist/types/Coscine.Api/@coscine/model/identity-providers.d.ts

@@ -11,6 +11,8 @@
  */
 /**
  * Specifies the supported external authentication services.
+ * @export
+ * @enum {string}
  */
 export declare const IdentityProviders: {
     readonly Shibboleth: "Shibboleth";

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

@@ -33,6 +33,7 @@ export * from './discipline-dto-response';
 export * from './discipline-for-project-manipulation-dto';
 export * from './discipline-for-resource-manipulation-dto';
 export * from './discipline-for-user-manipulation-dto';
+export * from './ds-nrw-replication-group';
 export * from './ds-nrw-replication-group-dto';
 export * from './extracted-metadata-tree-for-creation-dto';
 export * from './extracted-metadata-tree-for-update-dto';
@@ -128,6 +129,7 @@ export * from './provenance-parameters-dto';
 export * from './public-user-dto';
 export * from './public-user-dto-ienumerable-response';
 export * from './publication-advisory-service-dto';
+export * from './publication-advisory-service-dto-paged-response';
 export * from './publication-request-for-creation-dto';
 export * from './quota-dto';
 export * from './quota-for-manipulation-dto';

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

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

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

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

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

@@ -11,18 +11,26 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) for language details.
+ * @export
+ * @interface LanguageDto
  */
 export interface LanguageDto {
     /**
      * Gets or sets the unique identifier for the language.
+     * @type {string}
+     * @memberof LanguageDto
      */
     'id': string;
     /**
      * Gets or sets the display name of the language.
+     * @type {string}
+     * @memberof LanguageDto
      */
     'displayName': string;
     /**
      * Gets or sets the abbreviation for the language.
+     * @type {string}
+     * @memberof LanguageDto
      */
     'abbreviation': string;
 }

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

@@ -11,10 +11,14 @@
  */
 /**
  * Data transfer object (DTO) representing a language for user manipulation.
+ * @export
+ * @interface LanguageForUserManipulationDto
  */
 export interface LanguageForUserManipulationDto {
     /**
      * Gets or initializes the identifier of the language.
+     * @type {string}
+     * @memberof LanguageForUserManipulationDto
      */
     'id': string;
 }

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

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

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

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

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

@@ -11,18 +11,26 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) for license details.
+ * @export
+ * @interface LicenseDto
  */
 export interface LicenseDto {
     /**
      * Gets or sets the unique identifier for the license.
+     * @type {string}
+     * @memberof LicenseDto
      */
     'id'?: string;
     /**
      * Gets or sets the display name of the license.
+     * @type {string}
+     * @memberof LicenseDto
      */
     'displayName'?: string;
     /**
      * Gets or sets the Uri of the license.
+     * @type {string}
+     * @memberof LicenseDto
      */
     'url'?: string;
 }

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

@@ -11,10 +11,14 @@
  */
 /**
  * Data transfer object (DTO) representing a license for resource manipulation.
+ * @export
+ * @interface LicenseForResourceManipulationDto
  */
 export interface LicenseForResourceManipulationDto {
     /**
      * Gets or initializes the identifier of the license.
+     * @type {string}
+     * @memberof LicenseForResourceManipulationDto
      */
     'id': string;
 }

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

@@ -11,14 +11,20 @@
  */
 /**
  * Represents the data transfer object (DTO) for manipulating lifecycle options on an S3 bucket.
+ * @export
+ * @interface LifecycleOptionsForManipulationDto
  */
 export interface LifecycleOptionsForManipulationDto {
     /**
      * Gets the number of days after which incomplete multipart uploads are automatically aborted.  A value of `null` means no rule is applied.
+     * @type {number}
+     * @memberof LifecycleOptionsForManipulationDto
      */
     'abortIncompleteMultipartAfterDays'?: number | null;
     /**
      * Gets the number of days after which noncurrent (previous) object versions expire.  A value of `null` means no rule is applied.
+     * @type {number}
+     * @memberof LifecycleOptionsForManipulationDto
      */
     'noncurrentVersionExpireAfterDays'?: number | null;
 }

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

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

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

@@ -11,30 +11,44 @@
  */
 /**
  * This class represents a maintenance with its significant properties, which is returned from the API.
+ * @export
+ * @interface MaintenanceDto
  */
 export interface MaintenanceDto {
     /**
      * Gets or sets the maintenance title.
+     * @type {string}
+     * @memberof MaintenanceDto
      */
     'displayName'?: string;
     /**
      * Gets or sets the URL related to the maintenance.
+     * @type {string}
+     * @memberof MaintenanceDto
      */
     'href'?: string;
     /**
      * Gets or sets the type of maintenance.
+     * @type {string}
+     * @memberof MaintenanceDto
      */
     'type'?: string;
     /**
      * Gets or sets the description of the maintenance.
+     * @type {string}
+     * @memberof MaintenanceDto
      */
     'body'?: string;
     /**
      * Gets or sets the start date of the maintenance, if available.
+     * @type {string}
+     * @memberof MaintenanceDto
      */
     'startsDate'?: string | null;
     /**
      * Gets or sets the end date of the maintenance, if available.
+     * @type {string}
+     * @memberof MaintenanceDto
      */
     'endsDate'?: string | null;
 }

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

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

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

@@ -10,32 +10,54 @@
  * Do not edit the class manually.
  */
 import type { MessageType } from './message-type';
+/**
+ *
+ * @export
+ * @interface MessageDto
+ */
 export interface MessageDto {
     /**
      * ID of the message.
+     * @type {string}
+     * @memberof MessageDto
      */
     'id': string;
     /**
      * Message body in multiple languages as key-value pairs.   The key is the ISO 639-1 Alpha-2 two-letter language code, and the value is the message in that language.
+     * @type {{ [key: string]: string; }}
+     * @memberof MessageDto
      */
     'body'?: {
         [key: string]: string;
     } | null;
+    /**
+     *
+     * @type {MessageType}
+     * @memberof MessageDto
+     */
     'type'?: MessageType;
     /**
      * Title of the message.
+     * @type {string}
+     * @memberof MessageDto
      */
     'title'?: string | null;
     /**
      * URL related to the message.
+     * @type {string}
+     * @memberof MessageDto
      */
     'href'?: string | null;
     /**
      * Start date of the message (UTC).
+     * @type {string}
+     * @memberof MessageDto
      */
     'startDate'?: string | null;
     /**
      * End date of the message (UTC).
+     * @type {string}
+     * @memberof MessageDto
      */
     'endDate'?: string | null;
 }

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

@@ -11,6 +11,8 @@
  */
 /**
  * Defines the various types of messages.
+ * @export
+ * @enum {string}
  */
 export declare const MessageType: {
     readonly Disturbance: "Disturbance";

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

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

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

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

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

@@ -15,26 +15,56 @@ import type { RdfDefinitionDto } from './rdf-definition-dto';
 import type { TreeDataType } from './tree-data-type';
 /**
  * Represents a data transfer object (DTO) for metadata within a tree structure, extending the base TreeDto.
+ * @export
+ * @interface MetadataTreeDto
  */
 export interface MetadataTreeDto {
     /**
      * The path of the tree item.
+     * @type {string}
+     * @memberof MetadataTreeDto
      */
     'path'?: string;
+    /**
+     *
+     * @type {TreeDataType}
+     * @memberof MetadataTreeDto
+     */
     'type'?: TreeDataType;
     /**
      * Gets or sets the id of the specific metadata tree.
+     * @type {string}
+     * @memberof MetadataTreeDto
      */
     'id'?: string;
     /**
      * Gets or sets the version associated with the metadata.
+     * @type {string}
+     * @memberof MetadataTreeDto
      */
     'version'?: string;
     /**
      * Gets or sets the collection of available versions related to the metadata.
+     * @type {Array<string>}
+     * @memberof MetadataTreeDto
      */
     'availableVersions'?: Array<string>;
+    /**
+     *
+     * @type {RdfDefinitionDto}
+     * @memberof MetadataTreeDto
+     */
     'definition'?: RdfDefinitionDto;
+    /**
+     *
+     * @type {MetadataTreeExtractedDto}
+     * @memberof MetadataTreeDto
+     */
     'extracted'?: MetadataTreeExtractedDto;
+    /**
+     *
+     * @type {ProvenanceDto}
+     * @memberof MetadataTreeDto
+     */
     'provenance'?: ProvenanceDto;
 }

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

@@ -13,20 +13,38 @@ import type { RdfDefinitionDto } from './rdf-definition-dto';
 import type { TreeDataType } from './tree-data-type';
 /**
  * Represents a data transfer object (DTO) for extracted metadata within a tree structure, extending the base TreeDto.
+ * @export
+ * @interface MetadataTreeExtractedDto
  */
 export interface MetadataTreeExtractedDto {
     /**
      * The path of the tree item.
+     * @type {string}
+     * @memberof MetadataTreeExtractedDto
      */
     'path'?: string;
+    /**
+     *
+     * @type {TreeDataType}
+     * @memberof MetadataTreeExtractedDto
+     */
     'type'?: TreeDataType;
     /**
      * Gets the identifier of the metadata extraction graph.
+     * @type {string}
+     * @memberof MetadataTreeExtractedDto
      */
     'metadataId'?: string;
     /**
      * Gets the identifier of the raw data extraction graph.
+     * @type {string}
+     * @memberof MetadataTreeExtractedDto
      */
     'rawDataId'?: string | null;
+    /**
+     *
+     * @type {RdfDefinitionDto}
+     * @memberof MetadataTreeExtractedDto
+     */
     'definition'?: RdfDefinitionDto;
 }