@coscine/api-client 3.3.1 → 3.4.0

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

@@ -0,0 +1,74 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { FileActionsDto } from './file-actions-dto';
+import { 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;
+}

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

@@ -0,0 +1,42 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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

@@ -0,0 +1,42 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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

@@ -0,0 +1,43 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { 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

@@ -0,0 +1,60 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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

@@ -0,0 +1,43 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { 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

@@ -0,0 +1,43 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { 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

@@ -0,0 +1,96 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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

@@ -0,0 +1,48 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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

@@ -0,0 +1,30 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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/identity-provider-dto.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * 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

@@ -0,0 +1,21 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@itc.rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Specifies the supported external authentication services.
+ * @export
+ * @enum {string}
+ */
+export declare const IdentityProviders: {
+    readonly Shibboleth: "Shibboleth";
+    readonly OrciD: "ORCiD";
+};
+export type IdentityProviders = typeof IdentityProviders[keyof typeof IdentityProviders];