@coscine/api-client 3.3.1 → 3.4.0

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

@@ -0,0 +1,97 @@
+/**
+ * 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 { DisciplineDto } from './discipline-dto';
+import { IdentityProviderDto } from './identity-provider-dto';
+import { LanguageDto } from './language-dto';
+import { TitleDto } from './title-dto';
+import { UserEmailDto } from './user-email-dto';
+import { UserInstituteDto } from './user-institute-dto';
+import { 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;
+    /**
+     * The family name of the user.
+     * @type {string}
+     * @memberof UserDto
+     */
+    'familyName'?: string;
+    /**
+     * 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 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 institutes associated with the user.
+     * @type {Array<UserInstituteDto>}
+     * @memberof UserDto
+     */
+    'institutes'?: Array<UserInstituteDto>;
+    /**
+     * The identity providers associated with the user.
+     * @type {Array<IdentityProviderDto>}
+     * @memberof UserDto
+     */
+    'identities'?: Array<IdentityProviderDto>;
+}

package/dist/types/Coscine.Api/@coscine/model/user-email-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 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

@@ -0,0 +1,69 @@
+/**
+ * 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 { DisciplineForUserManipulationDto } from './discipline-for-user-manipulation-dto';
+import { LanguageForUserManipulationDto } from './language-for-user-manipulation-dto';
+import { 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 user\'s institute.
+     * @type {string}
+     * @memberof UserForUpdateDto
+     */
+    'institute'?: 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-institute-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 a Data Transfer Object (DTO) for user institute information, extending the OrganizationDto.
+ * @export
+ * @interface UserInstituteDto
+ */
+export interface UserInstituteDto {
+    /**
+     * The ROR (Research Organization Registry) ID of the organization.
+     * @type {string}
+     * @memberof UserInstituteDto
+     */
+    'uri'?: string;
+    /**
+     * The display name of the organization.
+     * @type {string}
+     * @memberof UserInstituteDto
+     */
+    'displayName'?: string;
+    /**
+     * The email address of the organization.
+     * @type {string}
+     * @memberof UserInstituteDto
+     */
+    'email'?: string | null;
+    /**
+     * Determines if the organization\'s details can be modified. Defaults to `true`; manually set to `false`.
+     * @type {boolean}
+     * @memberof UserInstituteDto
+     */
+    'readOnly'?: boolean;
+}

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

@@ -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 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

@@ -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 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-organization-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 a Data Transfer Object (DTO) for user-related organization information, inheriting from OrganizationDto.
+ * @export
+ * @interface UserOrganizationDto
+ */
+export interface UserOrganizationDto {
+    /**
+     * The ROR (Research Organization Registry) ID of the organization.
+     * @type {string}
+     * @memberof UserOrganizationDto
+     */
+    'uri'?: string;
+    /**
+     * The display name of the organization.
+     * @type {string}
+     * @memberof UserOrganizationDto
+     */
+    'displayName'?: string;
+    /**
+     * The email address of the organization.
+     * @type {string}
+     * @memberof UserOrganizationDto
+     */
+    'email'?: string | null;
+    /**
+     * Determines if the organization\'s details can be modified.
+     * @type {boolean}
+     * @memberof UserOrganizationDto
+     */
+    'readOnly'?: boolean;
+}

package/dist/types/Coscine.Api/@coscine/model/user-terms-of-service-accept-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 the data transfer object (DTO) for accepting the terms of service by a user.
+ * @export
+ * @interface UserTermsOfServiceAcceptDto
+ */
+export interface UserTermsOfServiceAcceptDto {
+    /**
+     * The version of the terms of service being accepted.
+     * @type {string}
+     * @memberof UserTermsOfServiceAcceptDto
+     */
+    'version': string;
+}

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

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

package/dist/types/Coscine.Api/@coscine/model/visibility-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 visibility settings.
+ * @export
+ * @interface VisibilityDto
+ */
+export interface VisibilityDto {
+    /**
+     * The identifier for the visibility setting.
+     * @type {string}
+     * @memberof VisibilityDto
+     */
+    'id'?: string;
+    /**
+     * The display name for the visibility setting.
+     * @type {string}
+     * @memberof VisibilityDto
+     */
+    'displayName'?: string;
+}

package/dist/types/Coscine.Api/@coscine/model/visibility-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.
+ */
+/**
+ * Represents the data transfer object (DTO) for manipulating the visibility of a project.
+ * @export
+ * @interface VisibilityForProjectManipulationDto
+ */
+export interface VisibilityForProjectManipulationDto {
+    /**
+     * The unique identifier of the visibility setting.
+     * @type {string}
+     * @memberof VisibilityForProjectManipulationDto
+     */
+    'id': string;
+}

package/dist/types/Coscine.Api/@coscine/model/visibility-for-resource-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.
+ */
+/**
+ * Represents the data transfer object (DTO) for manipulating the visibility of a resource.
+ * @export
+ * @interface VisibilityForResourceManipulationDto
+ */
+export interface VisibilityForResourceManipulationDto {
+    /**
+     * The unique identifier of the visibility setting.
+     * @type {string}
+     * @memberof VisibilityForResourceManipulationDto
+     */
+    'id': string;
+}

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