@coscine/api-client 3.3.1 → 3.4.0

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

@@ -0,0 +1,57 @@
+/**
+ * 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 { ProjectMinimalDto } from './project-minimal-dto';
+import { PublicUserDto } from './public-user-dto';
+import { RoleMinimalDto } from './role-minimal-dto';
+/**
+ * Represents a data transfer object (DTO) for project invitations.
+ * @export
+ * @interface ProjectInvitationDto
+ */
+export interface ProjectInvitationDto {
+    /**
+     * Unique identifier for the invitation.
+     * @type {string}
+     * @memberof ProjectInvitationDto
+     */
+    'id'?: string;
+    /**
+     * Expiration date of the invitation.
+     * @type {string}
+     * @memberof ProjectInvitationDto
+     */
+    'expirationDate'?: string;
+    /**
+     * Email associated with the invitation.
+     * @type {string}
+     * @memberof ProjectInvitationDto
+     */
+    'email'?: string;
+    /**
+     *
+     * @type {PublicUserDto}
+     * @memberof ProjectInvitationDto
+     */
+    'issuer'?: PublicUserDto;
+    /**
+     *
+     * @type {ProjectMinimalDto}
+     * @memberof ProjectInvitationDto
+     */
+    'project'?: ProjectMinimalDto;
+    /**
+     *
+     * @type {RoleMinimalDto}
+     * @memberof ProjectInvitationDto
+     */
+    'role'?: RoleMinimalDto;
+}

package/dist/types/Coscine.Api/@coscine/model/project-invitation-for-project-manipulation-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.
+ */
+/**
+ * Data transfer object (DTO) representing an invitation for project manipulation.
+ * @export
+ * @interface ProjectInvitationForProjectManipulationDto
+ */
+export interface ProjectInvitationForProjectManipulationDto {
+    /**
+     * Gets or initializes the identifier of the role associated with the invitation.
+     * @type {string}
+     * @memberof ProjectInvitationForProjectManipulationDto
+     */
+    'roleId': string;
+    /**
+     * Gets or initializes the email address of the invited user.
+     * @type {string}
+     * @memberof ProjectInvitationForProjectManipulationDto
+     */
+    'email': string;
+}

package/dist/types/Coscine.Api/@coscine/model/project-invitation-resolve-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) for resolving a project invitation.
+ * @export
+ * @interface ProjectInvitationResolveDto
+ */
+export interface ProjectInvitationResolveDto {
+    /**
+     * Gets or initializes the token associated with resolving the project invitation.
+     * @type {string}
+     * @memberof ProjectInvitationResolveDto
+     */
+    'token': string;
+}

package/dist/types/Coscine.Api/@coscine/model/project-minimal-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.
+ */
+/**
+ * Represents a minimal data transfer object (DTO) for a project.
+ * @export
+ * @interface ProjectMinimalDto
+ */
+export interface ProjectMinimalDto {
+    /**
+     * Unique identifier for the project.
+     * @type {string}
+     * @memberof ProjectMinimalDto
+     */
+    'id'?: string;
+}

package/dist/types/Coscine.Api/@coscine/model/project-quota-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 { Pagination } from './pagination';
+import { ProjectQuotaDto } from './project-quota-dto';
+/**
+ *
+ * @export
+ * @interface ProjectQuotaDtoPagedResponse
+ */
+export interface ProjectQuotaDtoPagedResponse {
+    /**
+     *
+     * @type {Array<ProjectQuotaDto>}
+     * @memberof ProjectQuotaDtoPagedResponse
+     */
+    'data'?: Array<ProjectQuotaDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectQuotaDtoPagedResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof ProjectQuotaDtoPagedResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectQuotaDtoPagedResponse
+     */
+    'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof ProjectQuotaDtoPagedResponse
+     */
+    'pagination'?: Pagination;
+}

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

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

@@ -0,0 +1,63 @@
+/**
+ * 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 { QuotaDto } from './quota-dto';
+import { ResourceQuotaDto } from './resource-quota-dto';
+import { ResourceTypeMinimalDto } from './resource-type-minimal-dto';
+/**
+ * Represents a data transfer object (DTO) containing quota information for a project.
+ * @export
+ * @interface ProjectQuotaDto
+ */
+export interface ProjectQuotaDto {
+    /**
+     * Identifier of the project.
+     * @type {string}
+     * @memberof ProjectQuotaDto
+     */
+    'projectId'?: string;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ProjectQuotaDto
+     */
+    'totalUsed'?: QuotaDto;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ProjectQuotaDto
+     */
+    'totalReserved'?: QuotaDto;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ProjectQuotaDto
+     */
+    'allocated'?: QuotaDto;
+    /**
+     *
+     * @type {QuotaDto}
+     * @memberof ProjectQuotaDto
+     */
+    'maximum'?: QuotaDto;
+    /**
+     *
+     * @type {ResourceTypeMinimalDto}
+     * @memberof ProjectQuotaDto
+     */
+    'resourceType'?: ResourceTypeMinimalDto;
+    /**
+     * Quota information for individual resources of the selected project\'s resource type.
+     * @type {Array<ResourceQuotaDto>}
+     * @memberof ProjectQuotaDto
+     */
+    'resourceQuotas'?: Array<ResourceQuotaDto> | null;
+}

package/dist/types/Coscine.Api/@coscine/model/project-quota-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 { QuotaForManipulationDto } from './quota-for-manipulation-dto';
+/**
+ * Data transfer object (DTO) representing the update of project quotas.
+ * @export
+ * @interface ProjectQuotaForUpdateDto
+ */
+export interface ProjectQuotaForUpdateDto {
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof ProjectQuotaForUpdateDto
+     */
+    'allocated': QuotaForManipulationDto;
+    /**
+     *
+     * @type {QuotaForManipulationDto}
+     * @memberof ProjectQuotaForUpdateDto
+     */
+    'maximum'?: QuotaForManipulationDto;
+}

package/dist/types/Coscine.Api/@coscine/model/project-resource-minimal-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 minimal data transfer object (DTO) for a project resource.
+ * @export
+ * @interface ProjectResourceMinimalDto
+ */
+export interface ProjectResourceMinimalDto {
+    /**
+     * Identifier of the resource.
+     * @type {string}
+     * @memberof ProjectResourceMinimalDto
+     */
+    'resourceId'?: string;
+    /**
+     * Identifier of the project associated with the resource.
+     * @type {string}
+     * @memberof ProjectResourceMinimalDto
+     */
+    'projectId'?: string;
+}

package/dist/types/Coscine.Api/@coscine/model/project-role-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 { Pagination } from './pagination';
+import { ProjectRoleDto } from './project-role-dto';
+/**
+ *
+ * @export
+ * @interface ProjectRoleDtoPagedResponse
+ */
+export interface ProjectRoleDtoPagedResponse {
+    /**
+     *
+     * @type {Array<ProjectRoleDto>}
+     * @memberof ProjectRoleDtoPagedResponse
+     */
+    'data'?: Array<ProjectRoleDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ProjectRoleDtoPagedResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof ProjectRoleDtoPagedResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectRoleDtoPagedResponse
+     */
+    'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof ProjectRoleDtoPagedResponse
+     */
+    'pagination'?: Pagination;
+}

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

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

@@ -0,0 +1,45 @@
+/**
+ * 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 { ProjectMinimalDto } from './project-minimal-dto';
+import { PublicUserDto } from './public-user-dto';
+import { RoleDto } from './role-dto';
+/**
+ * Represents a data transfer object (DTO) for a project role.
+ * @export
+ * @interface ProjectRoleDto
+ */
+export interface ProjectRoleDto {
+    /**
+     * Identifier of the project role.
+     * @type {string}
+     * @memberof ProjectRoleDto
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {ProjectMinimalDto}
+     * @memberof ProjectRoleDto
+     */
+    'project'?: ProjectMinimalDto;
+    /**
+     *
+     * @type {RoleDto}
+     * @memberof ProjectRoleDto
+     */
+    'role'?: RoleDto;
+    /**
+     *
+     * @type {PublicUserDto}
+     * @memberof ProjectRoleDto
+     */
+    'user'?: PublicUserDto;
+}

package/dist/types/Coscine.Api/@coscine/model/project-role-for-project-creation-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.
+ */
+/**
+ * Data transfer object (DTO) representing the creation of a project role within a project.  Inherits from the base class Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ProjectRoleForProjectManipulationDto.
+ * @export
+ * @interface ProjectRoleForProjectCreationDto
+ */
+export interface ProjectRoleForProjectCreationDto {
+    /**
+     * Gets or initializes the identifier of the role associated with the project manipulation.
+     * @type {string}
+     * @memberof ProjectRoleForProjectCreationDto
+     */
+    'roleId': string;
+    /**
+     * Gets or initializes the identifier of the user associated with the project role creation.
+     * @type {string}
+     * @memberof ProjectRoleForProjectCreationDto
+     */
+    'userId': string;
+}

package/dist/types/Coscine.Api/@coscine/model/project-role-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 a project role for manipulation within a project.
+ * @export
+ * @interface ProjectRoleForProjectManipulationDto
+ */
+export interface ProjectRoleForProjectManipulationDto {
+    /**
+     * Gets or initializes the identifier of the role associated with the project manipulation.
+     * @type {string}
+     * @memberof ProjectRoleForProjectManipulationDto
+     */
+    'roleId': string;
+}

package/dist/types/Coscine.Api/@coscine/model/project-role-minimal-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 minimal data transfer object (DTO) for a project role.
+ * @export
+ * @interface ProjectRoleMinimalDto
+ */
+export interface ProjectRoleMinimalDto {
+    /**
+     * Identifier of the project associated with the role.
+     * @type {string}
+     * @memberof ProjectRoleMinimalDto
+     */
+    'projectId'?: string;
+    /**
+     * Identifier of the user associated with the role.
+     * @type {string}
+     * @memberof ProjectRoleMinimalDto
+     */
+    'userId'?: string;
+    /**
+     * Identifier of the role.
+     * @type {string}
+     * @memberof ProjectRoleMinimalDto
+     */
+    'roleId'?: string;
+}

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