@coscine/api-client 3.20.0 → 3.22.0

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

@@ -12,15 +12,26 @@
 import type { SearchCategoryType } from './search-category-type';
 /**
  * Represents a Data Transfer Object (DTO) for search results.
+ * @export
+ * @interface SearchResultDto
  */
 export interface SearchResultDto {
     /**
      * The URI associated with the search result.
+     * @type {string}
+     * @memberof SearchResultDto
      */
     'uri': string;
+    /**
+     *
+     * @type {SearchCategoryType}
+     * @memberof SearchResultDto
+     */
     'type': SearchCategoryType;
     /**
      * The dynamic source data for the search result.
+     * @type {any}
+     * @memberof SearchResultDto
      */
     'source': any;
 }

package/dist/types/Coscine.Api/@coscine/model/storage-data-hamster-kpi-dto-response.d.ts

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

package/dist/types/Coscine.Api/@coscine/model/storage-data-hamster-kpi-dto.d.ts

@@ -10,7 +10,22 @@
  * Do not edit the class manually.
  */
 import type { DataHamsterKpiDto } from './data-hamster-kpi-dto';
+/**
+ *
+ * @export
+ * @interface StorageDataHamsterKpiDto
+ */
 export interface StorageDataHamsterKpiDto {
+    /**
+     *
+     * @type {DataHamsterKpiDto}
+     * @memberof StorageDataHamsterKpiDto
+     */
     'reserved'?: DataHamsterKpiDto;
+    /**
+     *
+     * @type {DataHamsterKpiDto}
+     * @memberof StorageDataHamsterKpiDto
+     */
     'used'?: DataHamsterKpiDto;
 }

package/dist/types/Coscine.Api/@coscine/model/terms-of-service-dto-response.d.ts

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

package/dist/types/Coscine.Api/@coscine/model/terms-of-service-dto.d.ts

@@ -11,18 +11,26 @@
  */
 /**
  * Represents the Data Transfer Object (DTO) for terms of service information.
+ * @export
+ * @interface TermsOfServiceDto
  */
 export interface TermsOfServiceDto {
     /**
      * The version of the terms of service.
+     * @type {string}
+     * @memberof TermsOfServiceDto
      */
     'version': string;
     /**
      * The URI point to the content of ToS\' version
+     * @type {string}
+     * @memberof TermsOfServiceDto
      */
     'href': string;
     /**
      * Indicates whether these terms of service are current or not.
+     * @type {boolean}
+     * @memberof TermsOfServiceDto
      */
     'isCurrent': boolean;
 }

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

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

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

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

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

@@ -11,14 +11,20 @@
  */
 /**
  * Represents the Data Transfer Object (DTO) for title information.
+ * @export
+ * @interface TitleDto
  */
 export interface TitleDto {
     /**
      * The identifier for the title.
+     * @type {string}
+     * @memberof TitleDto
      */
     'id': string;
     /**
      * The displayed name of the title.
+     * @type {string}
+     * @memberof TitleDto
      */
     'displayName': string;
 }

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

@@ -11,10 +11,14 @@
  */
 /**
  * Represents the data transfer object (DTO) for manipulating a user\'s title.
+ * @export
+ * @interface TitleForUserManipulationDto
  */
 export interface TitleForUserManipulationDto {
     /**
      * The unique identifier of the title.
+     * @type {string}
+     * @memberof TitleForUserManipulationDto
      */
     'id': string;
 }

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

@@ -11,6 +11,8 @@
  */
 /**
  * Represents the types of nodes within a hierarchical tree structure.
+ * @export
+ * @enum {string}
  */
 export declare const TreeDataType: {
     readonly Tree: "Tree";

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

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

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

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

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

@@ -18,52 +18,90 @@ import type { UserEmailDto } from './user-email-dto';
 import type { UserOrganizationDto } from './user-organization-dto';
 /**
  * Represents a Data Transfer Object (DTO) for user-related information.
+ * @export
+ * @interface UserDto
  */
 export interface UserDto {
     /**
      * The unique identifier of the user.
+     * @type {string}
+     * @memberof UserDto
      */
     'id': string;
     /**
      * The display name of the user.
+     * @type {string}
+     * @memberof UserDto
      */
     'displayName': string;
     /**
      * The given name of the user.
+     * @type {string}
+     * @memberof UserDto
      */
     'givenName'?: string | null;
     /**
      * The family name of the user.
+     * @type {string}
+     * @memberof UserDto
      */
     'familyName'?: string | null;
     /**
      * The email addresses associated with the user.
+     * @type {Array<UserEmailDto>}
+     * @memberof UserDto
      */
     'emails': Array<UserEmailDto>;
+    /**
+     *
+     * @type {TitleDto}
+     * @memberof UserDto
+     */
     'title'?: TitleDto;
+    /**
+     *
+     * @type {LanguageDto}
+     * @memberof UserDto
+     */
     'language'?: LanguageDto;
     /**
      * Indicates if the terms of service are accepted by the user.
+     * @type {boolean}
+     * @memberof UserDto
      */
     'areToSAccepted': boolean;
     /**
      * The date and time of the latest activity of the user.
+     * @type {string}
+     * @memberof UserDto
      */
     'latestActivity'?: string | null;
     /**
      * The disciplines associated with the user.
+     * @type {Array<DisciplineDto>}
+     * @memberof UserDto
      */
     'disciplines': Array<DisciplineDto>;
     /**
      * The organizations associated with the user.
+     * @type {Array<UserOrganizationDto>}
+     * @memberof UserDto
      */
     'organizations': Array<UserOrganizationDto>;
     /**
      * The identity providers associated with the user.
+     * @type {Array<IdentityProviderDto>}
+     * @memberof UserDto
      */
     'identities': Array<IdentityProviderDto>;
     /**
      * The coscine roles associated with the user.
+     * @type {Array<CoscineRoleDto>}
+     * @memberof UserDto
      */
     'roles'?: Array<CoscineRoleDto>;
+    /**
+     * The date and time when the user give consent to the proccessing of data.
+     */
+    'dataProcessingConsentAt'?: string | null;
 }

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

@@ -11,18 +11,26 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) for user email information.
+ * @export
+ * @interface UserEmailDto
  */
 export interface UserEmailDto {
     /**
      * The email address of the user.
+     * @type {string}
+     * @memberof UserEmailDto
      */
     'email'?: string | null;
     /**
      * Indicates whether the email address is confirmed.
+     * @type {boolean}
+     * @memberof UserEmailDto
      */
     'isConfirmed'?: boolean;
     /**
      * Indicates whether the email address is the primary one for the user.
+     * @type {boolean}
+     * @memberof UserEmailDto
      */
     'isPrimary'?: boolean;
 }

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

@@ -14,28 +14,50 @@ import type { LanguageForUserManipulationDto } from './language-for-user-manipul
 import type { TitleForUserManipulationDto } from './title-for-user-manipulation-dto';
 /**
  * Represents the data transfer object (DTO) for updating user details.
+ * @export
+ * @interface UserForUpdateDto
  */
 export interface UserForUpdateDto {
     /**
      * The user\'s given name.
+     * @type {string}
+     * @memberof UserForUpdateDto
      */
     'givenName': string;
     /**
      * The user\'s family name.
+     * @type {string}
+     * @memberof UserForUpdateDto
      */
     'familyName': string;
     /**
      * The user\'s email address.
+     * @type {string}
+     * @memberof UserForUpdateDto
      */
     'email': string;
+    /**
+     *
+     * @type {TitleForUserManipulationDto}
+     * @memberof UserForUpdateDto
+     */
     'title'?: TitleForUserManipulationDto;
+    /**
+     *
+     * @type {LanguageForUserManipulationDto}
+     * @memberof UserForUpdateDto
+     */
     'language': LanguageForUserManipulationDto;
     /**
      * The user\'s organization.
+     * @type {string}
+     * @memberof UserForUpdateDto
      */
     'organization'?: string | null;
     /**
      * The disciplines associated with the user for manipulation.
+     * @type {Array<DisciplineForUserManipulationDto>}
+     * @memberof UserForUpdateDto
      */
     'disciplines': Array<DisciplineForUserManipulationDto>;
 }

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

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

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

@@ -11,10 +11,14 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) for merging user accounts.
+ * @export
+ * @interface UserMergeDto
  */
 export interface UserMergeDto {
     /**
      * The token required for merging user accounts.
+     * @type {string}
+     * @memberof UserMergeDto
      */
     'token': string;
 }

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

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

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

@@ -11,10 +11,14 @@
  */
 /**
  * Data transfer object (DTO) representing the creation of a user notification.
+ * @export
+ * @interface UserNotificationForCreationDto
  */
 export interface UserNotificationForCreationDto {
     /**
      * The id of the notification.
+     * @type {string}
+     * @memberof UserNotificationForCreationDto
      */
     'notificationId': string;
 }

package/dist/types/Coscine.Api/@coscine/model/user-notification-opt-out-dto-paged-response.d.ts

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

package/dist/types/Coscine.Api/@coscine/model/user-notification-opt-out-dto-response.d.ts

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