@coscine/api-client 3.3.1 → 3.3.2-package.0

package/dist/types/Coscine.Api/@coscine/model/metadata-tree-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 { 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

@@ -0,0 +1,50 @@
+/**
+ * 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 { RdfDefinitionDto } from './rdf-definition-dto';
+import { 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 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;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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 { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto';
+/**
+ * Data transfer object (DTO) representing the creation of a metadata tree.  Extends the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.MetadataTreeForManipulationDto.
+ * @export
+ * @interface MetadataTreeForCreationDto
+ */
+export interface MetadataTreeForCreationDto {
+    /**
+     * Gets or initializes the path of the metadata tree.
+     * @type {string}
+     * @memberof MetadataTreeForCreationDto
+     */
+    'path': string;
+    /**
+     *
+     * @type {RdfDefinitionForManipulationDto}
+     * @memberof MetadataTreeForCreationDto
+     */
+    'definition': RdfDefinitionForManipulationDto;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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 { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto';
+/**
+ * Data transfer object (DTO) representing the update of a metadata tree.  Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.MetadataTreeForManipulationDto.
+ * @export
+ * @interface MetadataTreeForUpdateDto
+ */
+export interface MetadataTreeForUpdateDto {
+    /**
+     * Gets or initializes the path of the metadata tree.
+     * @type {string}
+     * @memberof MetadataTreeForUpdateDto
+     */
+    'path': string;
+    /**
+     *
+     * @type {RdfDefinitionForManipulationDto}
+     * @memberof MetadataTreeForUpdateDto
+     */
+    'definition': RdfDefinitionForManipulationDto;
+}

package/dist/types/Coscine.Api/@coscine/model/metadata-update-admin-parameters.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto';
+/**
+ * Represents parameters for updating metadata in an administrative context.
+ * @export
+ * @interface MetadataUpdateAdminParameters
+ */
+export interface MetadataUpdateAdminParameters {
+    /**
+     * Gets or sets the URI of the graph related to the metadata.
+     * @type {string}
+     * @memberof MetadataUpdateAdminParameters
+     */
+    'graphUri': string;
+    /**
+     *
+     * @type {RdfDefinitionForManipulationDto}
+     * @memberof MetadataUpdateAdminParameters
+     */
+    'definition': RdfDefinitionForManipulationDto;
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 { OrganizationDto } from './organization-dto';
+import { Pagination } from './pagination';
+/**
+ *
+ * @export
+ * @interface OrganizationDtoPagedResponse
+ */
+export interface OrganizationDtoPagedResponse {
+    /**
+     *
+     * @type {Array<OrganizationDto>}
+     * @memberof OrganizationDtoPagedResponse
+     */
+    'data'?: Array<OrganizationDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof OrganizationDtoPagedResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof OrganizationDtoPagedResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof OrganizationDtoPagedResponse
+     */
+    'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof OrganizationDtoPagedResponse
+     */
+    'pagination'?: Pagination;
+}

package/dist/types/Coscine.Api/@coscine/model/organization-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 { OrganizationDto } from './organization-dto';
+/**
+ *
+ * @export
+ * @interface OrganizationDtoResponse
+ */
+export interface OrganizationDtoResponse {
+    /**
+     *
+     * @type {OrganizationDto}
+     * @memberof OrganizationDtoResponse
+     */
+    'data'?: OrganizationDto;
+    /**
+     *
+     * @type {boolean}
+     * @memberof OrganizationDtoResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof OrganizationDtoResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof OrganizationDtoResponse
+     */
+    'traceId'?: string | null;
+}

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

@@ -0,0 +1,36 @@
+/**
+ * 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 organization, including its ROR (Research Organization Registry) ID, display name, and email address.
+ * @export
+ * @interface OrganizationDto
+ */
+export interface OrganizationDto {
+    /**
+     * The ROR (Research Organization Registry) ID of the organization.
+     * @type {string}
+     * @memberof OrganizationDto
+     */
+    'uri'?: string;
+    /**
+     * The display name of the organization.
+     * @type {string}
+     * @memberof OrganizationDto
+     */
+    'displayName'?: string;
+    /**
+     * The email address of the organization.
+     * @type {string}
+     * @memberof OrganizationDto
+     */
+    'email'?: string | null;
+}

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

@@ -0,0 +1,24 @@
+/**
+ * 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 an organization for project manipulation.
+ * @export
+ * @interface OrganizationForProjectManipulationDto
+ */
+export interface OrganizationForProjectManipulationDto {
+    /**
+     * Gets or initializes the URI of the organization.
+     * @type {string}
+     * @memberof OrganizationForProjectManipulationDto
+     */
+    'uri': string;
+}

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

@@ -0,0 +1,54 @@
+/**
+ * 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 pagination information for a collection of items.
+ * @export
+ * @interface Pagination
+ */
+export interface Pagination {
+    /**
+     * Gets or sets the current page number.
+     * @type {number}
+     * @memberof Pagination
+     */
+    'currentPage'?: number;
+    /**
+     * Gets or sets the total number of pages.
+     * @type {number}
+     * @memberof Pagination
+     */
+    'totalPages'?: number;
+    /**
+     * Gets or sets the number of items per page.
+     * @type {number}
+     * @memberof Pagination
+     */
+    'pageSize'?: number;
+    /**
+     * Gets or sets the total count of items across all pages.
+     * @type {number}
+     * @memberof Pagination
+     */
+    'totalCount'?: number;
+    /**
+     * Gets a value indicating whether there is a previous page.
+     * @type {boolean}
+     * @memberof Pagination
+     */
+    'hasPrevious'?: boolean;
+    /**
+     * Gets a value indicating whether there is a next page.
+     * @type {boolean}
+     * @memberof Pagination
+     */
+    'hasNext'?: boolean;
+}

package/dist/types/Coscine.Api/@coscine/model/pid-request-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 a PID request.
+ * @export
+ * @interface PidRequestDto
+ */
+export interface PidRequestDto {
+    /**
+     * Gets or initializes the name associated with the PID request.
+     * @type {string}
+     * @memberof PidRequestDto
+     */
+    'name': string;
+    /**
+     * Gets or initializes the email associated with the PID request.
+     * @type {string}
+     * @memberof PidRequestDto
+     */
+    'email': string;
+    /**
+     * Gets or initializes the message for the PID request.
+     * @type {string}
+     * @memberof PidRequestDto
+     */
+    'message': string;
+    /**
+     * Gets or initializes whether to send a confirmation email for the PID request.
+     * @type {boolean}
+     * @memberof PidRequestDto
+     */
+    'sendConfirmationEmail'?: boolean;
+}

package/dist/types/Coscine.Api/@coscine/model/pid-type.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 type of PID.
+ * @export
+ * @enum {string}
+ */
+export declare const PidType: {
+    readonly Project: "project";
+    readonly Resource: "resource";
+};
+export type PidType = typeof PidType[keyof typeof PidType];

package/dist/types/Coscine.Api/@coscine/model/pid-validation-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 { PidValidationDto } from './pid-validation-dto';
+/**
+ *
+ * @export
+ * @interface PidValidationDtoResponse
+ */
+export interface PidValidationDtoResponse {
+    /**
+     *
+     * @type {PidValidationDto}
+     * @memberof PidValidationDtoResponse
+     */
+    'data'?: PidValidationDto;
+    /**
+     *
+     * @type {boolean}
+     * @memberof PidValidationDtoResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof PidValidationDtoResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PidValidationDtoResponse
+     */
+    'traceId'?: string | null;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * 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 { PidType } from './pid-type';
+/**
+ * Represents a data transfer object (DTO) for validating a PID (Persistent Identifier).
+ * @export
+ * @interface PidValidationDto
+ */
+export interface PidValidationDto {
+    /**
+     * Indicates whether the provided PID is valid.
+     * @type {boolean}
+     * @memberof PidValidationDto
+     */
+    'isValid'?: boolean;
+    /**
+     *
+     * @type {PidType}
+     * @memberof PidValidationDto
+     */
+    'type'?: PidType;
+}

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

@@ -0,0 +1,50 @@
+/**
+ * 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 { Pagination } from './pagination';
+import { ProjectAdminDto } from './project-admin-dto';
+/**
+ *
+ * @export
+ * @interface ProjectAdminDtoIEnumerablePagedResponse
+ */
+export interface ProjectAdminDtoIEnumerablePagedResponse {
+    /**
+     *
+     * @type {Array<Array<ProjectAdminDto>>}
+     * @memberof ProjectAdminDtoIEnumerablePagedResponse
+     */
+    'data'?: Array<Array<ProjectAdminDto>> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectAdminDtoIEnumerablePagedResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof ProjectAdminDtoIEnumerablePagedResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectAdminDtoIEnumerablePagedResponse
+     */
+    'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof ProjectAdminDtoIEnumerablePagedResponse
+     */
+    'pagination'?: Pagination;
+}