@coscine/api-client 3.20.0 → 3.22.0

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

@@ -12,7 +12,14 @@
 import type { FileActionDto } from './file-action-dto';
 /**
  * Represents a Data Transfer Object (DTO) for a collection of file actions, including download action details.
+ * @export
+ * @interface FileActionsDto
  */
 export interface FileActionsDto {
+    /**
+     *
+     * @type {FileActionDto}
+     * @memberof FileActionsDto
+     */
     'download'?: FileActionDto;
 }

package/dist/types/Coscine.Api/@coscine/model/file-system-storage-options-dto.d.ts

@@ -11,10 +11,14 @@
  */
 /**
  * Represents the data transfer object (DTO) for FileSystemStorage options.
+ * @export
+ * @interface FileSystemStorageOptionsDto
  */
 export interface FileSystemStorageOptionsDto {
     /**
      * The directory where the files are stored.
+     * @type {string}
+     * @memberof FileSystemStorageOptionsDto
      */
     'directory': string;
 }

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

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

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

@@ -13,40 +13,68 @@ import type { FileActionsDto } from './file-actions-dto';
 import type { TreeDataType } from './tree-data-type';
 /**
  * Represents a Data Transfer Object (DTO) for a file within a tree structure, extending the base TreeDto.
+ * @export
+ * @interface FileTreeDto
  */
 export interface FileTreeDto {
     /**
      * The path of the tree item.
+     * @type {string}
+     * @memberof FileTreeDto
      */
     'path'?: string;
+    /**
+     *
+     * @type {TreeDataType}
+     * @memberof FileTreeDto
+     */
     'type'?: TreeDataType;
     /**
      * Gets or sets the directory of the file.
+     * @type {string}
+     * @memberof FileTreeDto
      */
     'directory'?: string;
     /**
      * Gets or sets the name of the file.
+     * @type {string}
+     * @memberof FileTreeDto
      */
     'name'?: string;
     /**
      * Gets or sets the extension of the file.
+     * @type {string}
+     * @memberof FileTreeDto
      */
     'extension'?: string;
     /**
      * Gets or sets the size of the file in bytes.
+     * @type {number}
+     * @memberof FileTreeDto
      */
     'size'?: number;
     /**
      * Gets or sets the creation date of the file.
+     * @type {string}
+     * @memberof FileTreeDto
      */
     'creationDate'?: string | null;
     /**
      * Gets or sets the last change date of the file.
+     * @type {string}
+     * @memberof FileTreeDto
      */
     'changeDate'?: string | null;
+    /**
+     *
+     * @type {FileActionsDto}
+     * @memberof FileTreeDto
+     */
     'actions'?: FileActionsDto;
     /**
      * Determines if the specific tree entry is hidden.
+     * @type {boolean}
+     * @memberof FileTreeDto
      */
     'hidden'?: boolean;
 }

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

@@ -11,22 +11,32 @@
  */
 /**
  * Data transfer object (DTO) representing the manipulation of a fixed value associated with a resource.
+ * @export
+ * @interface FixedValueForResourceManipulationDto
  */
 export interface FixedValueForResourceManipulationDto {
     /**
      * Gets or initializes the value of the fixed resource value.
+     * @type {string}
+     * @memberof FixedValueForResourceManipulationDto
      */
     'value'?: string | null;
     /**
      * Gets or initializes the type of the fixed resource value.
+     * @type {string}
+     * @memberof FixedValueForResourceManipulationDto
      */
     'type'?: string | null;
     /**
      * Gets or initializes the data type URI of the fixed resource value.
+     * @type {string}
+     * @memberof FixedValueForResourceManipulationDto
      */
     'datatype'?: string | null;
     /**
      * The target class of the provided value (e.g., \"https://purl.org/coscine/ap/base/\")
+     * @type {string}
+     * @memberof FixedValueForResourceManipulationDto
      */
     'targetClass'?: string | null;
 }

package/dist/types/Coscine.Api/@coscine/model/git-lab-options-dto.d.ts

@@ -11,22 +11,32 @@
  */
 /**
  * Represents the data transfer object (DTO) for GitLab options.
+ * @export
+ * @interface GitLabOptionsDto
  */
 export interface GitLabOptionsDto {
     /**
      * The project ID associated with GitLab.
+     * @type {number}
+     * @memberof GitLabOptionsDto
      */
     'projectId'?: number;
     /**
      * The repository URL for GitLab.
+     * @type {string}
+     * @memberof GitLabOptionsDto
      */
     'repoUrl'?: string | null;
     /**
      * The access token for GitLab.
+     * @type {string}
+     * @memberof GitLabOptionsDto
      */
     'accessToken'?: string | null;
     /**
      * The branch for GitLab.
+     * @type {string}
+     * @memberof GitLabOptionsDto
      */
     'branch'?: string | null;
 }

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

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

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

@@ -11,34 +11,50 @@
  */
 /**
  * Represents a GitLab branch data transfer object (DTO).
+ * @export
+ * @interface GitlabBranchDto
  */
 export interface GitlabBranchDto {
     /**
      * The name of the GitLab branch.
+     * @type {string}
+     * @memberof GitlabBranchDto
      */
     'name': string;
     /**
      * Indicates if the branch is merged.
+     * @type {boolean}
+     * @memberof GitlabBranchDto
      */
     'merged': boolean;
     /**
      * Indicates if the branch is protected.
+     * @type {boolean}
+     * @memberof GitlabBranchDto
      */
     'protected': boolean;
     /**
      * Indicates if the branch is set as default.
+     * @type {boolean}
+     * @memberof GitlabBranchDto
      */
     'default': boolean;
     /**
      * Indicates if developers can push changes to the branch.
+     * @type {boolean}
+     * @memberof GitlabBranchDto
      */
     'developersCanPush': boolean;
     /**
      * Indicates if developers can merge changes into the branch.
+     * @type {boolean}
+     * @memberof GitlabBranchDto
      */
     'developersCanMerge': boolean;
     /**
      * Indicates if the user can push changes to the branch.
+     * @type {boolean}
+     * @memberof GitlabBranchDto
      */
     'canPush': boolean;
 }

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

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

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

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

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

@@ -11,58 +11,86 @@
  */
 /**
  * Represents a GitLab project data transfer object (DTO).
+ * @export
+ * @interface GitlabProjectDto
  */
 export interface GitlabProjectDto {
     /**
      * The unique identifier for the GitLab project.
+     * @type {number}
+     * @memberof GitlabProjectDto
      */
     'id': number;
     /**
      * Indicates if the GitLab project is archived.
+     * @type {boolean}
+     * @memberof GitlabProjectDto
      */
     'archived': boolean;
     /**
      * The name of the GitLab project.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'name': string;
     /**
      * The full name of the GitLab project including namespace.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'nameWithNamespace': string;
     /**
      * A brief description of the GitLab project.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'description': string;
     /**
      * The default branch of the GitLab project.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'defaultBranch': string;
     /**
      * The path of the GitLab project.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'path': string;
     /**
      * The path of the GitLab project including namespace.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'pathWithNamespace': string;
     /**
      * The timestamp of the last activity related to the GitLab project.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'lastActivityAt': string;
     /**
      * The creation timestamp of the GitLab project.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'createdAt': string;
     /**
      * The URL to view the GitLab project in a web browser.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'webUrl': string;
     /**
      * The HTTP URL to access the GitLab project repository.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'httpUrlToRepo': string;
     /**
      * The SSH URL to access the GitLab project repository.
+     * @type {string}
+     * @memberof GitlabProjectDto
      */
     'sshUrlToRepo': string;
 }

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

@@ -11,26 +11,38 @@
  */
 /**
  * Represents the data transfer object (DTO) for creating GitLab resource type options.
+ * @export
+ * @interface GitlabResourceTypeOptionsForCreationDto
  */
 export interface GitlabResourceTypeOptionsForCreationDto {
     /**
      * The branch associated with the GitLab resource.
+     * @type {string}
+     * @memberof GitlabResourceTypeOptionsForCreationDto
      */
     'branch': string;
     /**
      * The access token for authentication with GitLab.
+     * @type {string}
+     * @memberof GitlabResourceTypeOptionsForCreationDto
      */
     'accessToken': string;
     /**
      * The repository URL for the GitLab resource.
+     * @type {string}
+     * @memberof GitlabResourceTypeOptionsForCreationDto
      */
     'repoUrl': string;
     /**
      * The project ID associated with the GitLab resource.
+     * @type {number}
+     * @memberof GitlabResourceTypeOptionsForCreationDto
      */
     'projectId': number;
     /**
      * Indicates whether the terms of service for the GitLab resource are accepted.
+     * @type {boolean}
+     * @memberof GitlabResourceTypeOptionsForCreationDto
      */
     'tosAccepted': boolean;
 }

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

@@ -11,14 +11,20 @@
  */
 /**
  * Represents the data transfer object (DTO) for updating GitLab resource type options.
+ * @export
+ * @interface GitlabResourceTypeOptionsForUpdateDto
  */
 export interface GitlabResourceTypeOptionsForUpdateDto {
     /**
      * The branch associated with the GitLab resource.
+     * @type {string}
+     * @memberof GitlabResourceTypeOptionsForUpdateDto
      */
     'branch': string;
     /**
      * The access token for authentication with GitLab.
+     * @type {string}
+     * @memberof GitlabResourceTypeOptionsForUpdateDto
      */
     'accessToken': string;
 }

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

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

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

@@ -11,7 +11,22 @@
  */
 import type { HandleValueDto } from './handle-value-dto';
 import type { PidDto } from './pid-dto';
+/**
+ *
+ * @export
+ * @interface HandleDto
+ */
 export interface HandleDto {
+    /**
+     *
+     * @type {PidDto}
+     * @memberof HandleDto
+     */
     'pid'?: PidDto;
+    /**
+     *
+     * @type {Array<HandleValueDto>}
+     * @memberof HandleDto
+     */
     'values'?: Array<HandleValueDto>;
 }

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

@@ -10,6 +10,16 @@
  * Do not edit the class manually.
  */
 import type { HandleValueForUpdateDto } from './handle-value-for-update-dto';
+/**
+ *
+ * @export
+ * @interface HandleForUpdateDto
+ */
 export interface HandleForUpdateDto {
+    /**
+     *
+     * @type {Array<HandleValueForUpdateDto>}
+     * @memberof HandleForUpdateDto
+     */
     'values': Array<HandleValueForUpdateDto>;
 }

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

@@ -9,14 +9,64 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+/**
+ *
+ * @export
+ * @interface HandleValueDto
+ */
 export interface HandleValueDto {
+    /**
+     *
+     * @type {number}
+     * @memberof HandleValueDto
+     */
     'idx'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof HandleValueDto
+     */
     'type'?: string;
+    /**
+     *
+     * @type {any}
+     * @memberof HandleValueDto
+     */
     'parsed_data'?: any;
+    /**
+     *
+     * @type {string}
+     * @memberof HandleValueDto
+     */
     'data'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HandleValueDto
+     */
     'timestamp'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof HandleValueDto
+     */
     'ttl_type'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof HandleValueDto
+     */
     'ttl'?: number;
+    /**
+     *
+     * @type {Array<any>}
+     * @memberof HandleValueDto
+     */
     'refs'?: Array<any>;
+    /**
+     *
+     * @type {string}
+     * @memberof HandleValueDto
+     */
     'privs'?: string;
 }

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

@@ -11,18 +11,26 @@
  */
 /**
  * Data transfer object (DTO) representing updating a handle.
+ * @export
+ * @interface HandleValueForUpdateDto
  */
 export interface HandleValueForUpdateDto {
     /**
      * The data type of the handle.
+     * @type {string}
+     * @memberof HandleValueForUpdateDto
      */
     'type': string;
     /**
      * The parsed data of the handle.
+     * @type {any}
+     * @memberof HandleValueForUpdateDto
      */
     'parsed_data': any;
     /**
      * The id of the handle.
+     * @type {number}
+     * @memberof HandleValueForUpdateDto
      */
     'idx'?: number;
 }