@coscine/api-client 3.3.1 → 3.4.0

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

@@ -0,0 +1,137 @@
+/**
+ * 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 { ApplicationProfileMinimalDto } from './application-profile-minimal-dto';
+import { DisciplineDto } from './discipline-dto';
+import { FixedValueForResourceManipulationDto } from './fixed-value-for-resource-manipulation-dto';
+import { LicenseDto } from './license-dto';
+import { ProjectResourceMinimalDto } from './project-resource-minimal-dto';
+import { ResourceTypeDto } from './resource-type-dto';
+import { VisibilityDto } from './visibility-dto';
+/**
+ * Represents a Data Transfer Object (DTO) for administrative purposes with additional resource details.
+ * @export
+ * @interface ResourceAdminDto
+ */
+export interface ResourceAdminDto {
+    /**
+     * Unique identifier for the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
+     */
+    'id'?: string;
+    /**
+     * Persistent identifier for the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
+     */
+    'pid'?: string;
+    /**
+     *
+     * @type {ResourceTypeDto}
+     * @memberof ResourceAdminDto
+     */
+    'type'?: ResourceTypeDto;
+    /**
+     * Name of the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
+     */
+    'name'?: string;
+    /**
+     * Display name of the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
+     */
+    'displayName'?: string;
+    /**
+     * Description of the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
+     */
+    'description'?: string;
+    /**
+     * Keywords associated with the resource.
+     * @type {Array<string>}
+     * @memberof ResourceAdminDto
+     */
+    'keywords'?: Array<string> | null;
+    /**
+     *
+     * @type {LicenseDto}
+     * @memberof ResourceAdminDto
+     */
+    'license'?: LicenseDto;
+    /**
+     * Usage rights associated with the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
+     */
+    'usageRights'?: string | null;
+    /**
+     *
+     * @type {ApplicationProfileMinimalDto}
+     * @memberof ResourceAdminDto
+     */
+    'applicationProfile'?: ApplicationProfileMinimalDto;
+    /**
+     * Fixed values associated with resource manipulation.  This dictionary may contain multiple levels and is structured as follows:  Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto.
+     * @type {{ [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; }}
+     * @memberof ResourceAdminDto
+     */
+    'fixedValues'?: {
+        [key: string]: {
+            [key: string]: Array<FixedValueForResourceManipulationDto>;
+        };
+    };
+    /**
+     * Disciplines associated with the resource.
+     * @type {Array<DisciplineDto>}
+     * @memberof ResourceAdminDto
+     */
+    'disciplines'?: Array<DisciplineDto>;
+    /**
+     *
+     * @type {VisibilityDto}
+     * @memberof ResourceAdminDto
+     */
+    'visibility'?: VisibilityDto;
+    /**
+     * Date when the resource was created.
+     * @type {string}
+     * @memberof ResourceAdminDto
+     */
+    'dateCreated'?: string | null;
+    /**
+     * Identifier of the creator of the resource.
+     * @type {string}
+     * @memberof ResourceAdminDto
+     */
+    'creator'?: string | null;
+    /**
+     * Indicates whether the resource is archived.
+     * @type {boolean}
+     * @memberof ResourceAdminDto
+     */
+    'archived'?: boolean;
+    /**
+     * Indicates whether the resource is deleted.
+     * @type {boolean}
+     * @memberof ResourceAdminDto
+     */
+    'deleted'?: boolean;
+    /**
+     * Collection of minimal project resource details associated with this resource.
+     * @type {Array<ProjectResourceMinimalDto>}
+     * @memberof ResourceAdminDto
+     */
+    'projectResources'?: Array<ProjectResourceMinimalDto>;
+}

package/dist/types/Coscine.Api/@coscine/model/resource-content-page-columns-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 set of columns to be displayed in the content view.
+ * @export
+ * @interface ResourceContentPageColumnsDto
+ */
+export interface ResourceContentPageColumnsDto {
+    /**
+     * Set of columns that should always be displayed in the content view.
+     * @type {Set<string>}
+     * @memberof ResourceContentPageColumnsDto
+     */
+    'always'?: Set<string>;
+}

package/dist/types/Coscine.Api/@coscine/model/resource-content-page-dto.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { ResourceContentPageEntriesViewDto } from './resource-content-page-entries-view-dto';
+import { ResourceContentPageMetadataViewDto } from './resource-content-page-metadata-view-dto';
+/**
+ * Represents the content page details for a resource.
+ * @export
+ * @interface ResourceContentPageDto
+ */
+export interface ResourceContentPageDto {
+    /**
+     * Indicates whether the resource is read-only.
+     * @type {boolean}
+     * @memberof ResourceContentPageDto
+     */
+    'readOnly'?: boolean;
+    /**
+     *
+     * @type {ResourceContentPageMetadataViewDto}
+     * @memberof ResourceContentPageDto
+     */
+    'metadataView'?: ResourceContentPageMetadataViewDto;
+    /**
+     *
+     * @type {ResourceContentPageEntriesViewDto}
+     * @memberof ResourceContentPageDto
+     */
+    'entriesView'?: ResourceContentPageEntriesViewDto;
+}

package/dist/types/Coscine.Api/@coscine/model/resource-content-page-entries-view-dto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 { ResourceContentPageColumnsDto } from './resource-content-page-columns-dto';
+/**
+ * Represents information about the resource type for the columns within the entries view Vue component.
+ * @export
+ * @interface ResourceContentPageEntriesViewDto
+ */
+export interface ResourceContentPageEntriesViewDto {
+    /**
+     *
+     * @type {ResourceContentPageColumnsDto}
+     * @memberof ResourceContentPageEntriesViewDto
+     */
+    'columns'?: ResourceContentPageColumnsDto;
+}

package/dist/types/Coscine.Api/@coscine/model/resource-content-page-metadata-view-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 metadata view for a resource\'s content page.
+ * @export
+ * @interface ResourceContentPageMetadataViewDto
+ */
+export interface ResourceContentPageMetadataViewDto {
+    /**
+     * Indicates if a data URL can be provided and is editable.
+     * @type {boolean}
+     * @memberof ResourceContentPageMetadataViewDto
+     */
+    'editableDataUrl'?: boolean;
+    /**
+     * Indicates if a key can be provided and is editable.
+     * @type {boolean}
+     * @memberof ResourceContentPageMetadataViewDto
+     */
+    'editableKey'?: boolean;
+}

package/dist/types/Coscine.Api/@coscine/model/resource-creation-page-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 structure of resource type-specific components for steps in the resource creation page.
+ * @export
+ * @interface ResourceCreationPageDto
+ */
+export interface ResourceCreationPageDto {
+    /**
+     * List of Lists containing all the resource type specific components for the steps in the resource creation page.
+     * @type {Array<Array<string>>}
+     * @memberof ResourceCreationPageDto
+     */
+    'components'?: Array<Array<string>>;
+}

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

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

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

@@ -0,0 +1,124 @@
+/**
+ * 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 { ApplicationProfileMinimalDto } from './application-profile-minimal-dto';
+import { DisciplineDto } from './discipline-dto';
+import { FixedValueForResourceManipulationDto } from './fixed-value-for-resource-manipulation-dto';
+import { LicenseDto } from './license-dto';
+import { ResourceTypeDto } from './resource-type-dto';
+import { VisibilityDto } from './visibility-dto';
+/**
+ * Represents a Data Transfer Object (DTO) for resource details.
+ * @export
+ * @interface ResourceDto
+ */
+export interface ResourceDto {
+    /**
+     * Unique identifier for the resource.
+     * @type {string}
+     * @memberof ResourceDto
+     */
+    'id'?: string;
+    /**
+     * Persistent identifier for the resource.
+     * @type {string}
+     * @memberof ResourceDto
+     */
+    'pid'?: string;
+    /**
+     *
+     * @type {ResourceTypeDto}
+     * @memberof ResourceDto
+     */
+    'type'?: ResourceTypeDto;
+    /**
+     * Name of the resource.
+     * @type {string}
+     * @memberof ResourceDto
+     */
+    'name'?: string;
+    /**
+     * Display name of the resource.
+     * @type {string}
+     * @memberof ResourceDto
+     */
+    'displayName'?: string;
+    /**
+     * Description of the resource.
+     * @type {string}
+     * @memberof ResourceDto
+     */
+    'description'?: string;
+    /**
+     * Keywords associated with the resource.
+     * @type {Array<string>}
+     * @memberof ResourceDto
+     */
+    'keywords'?: Array<string> | null;
+    /**
+     *
+     * @type {LicenseDto}
+     * @memberof ResourceDto
+     */
+    'license'?: LicenseDto;
+    /**
+     * Usage rights associated with the resource.
+     * @type {string}
+     * @memberof ResourceDto
+     */
+    'usageRights'?: string | null;
+    /**
+     *
+     * @type {ApplicationProfileMinimalDto}
+     * @memberof ResourceDto
+     */
+    'applicationProfile'?: ApplicationProfileMinimalDto;
+    /**
+     * Fixed values associated with resource manipulation.  This dictionary may contain multiple levels and is structured as follows:  Dictionary (Key: string) -> Dictionary (Key: string) -> List of FixedValueForResourceManipulationDto.
+     * @type {{ [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; }}
+     * @memberof ResourceDto
+     */
+    'fixedValues'?: {
+        [key: string]: {
+            [key: string]: Array<FixedValueForResourceManipulationDto>;
+        };
+    };
+    /**
+     * Disciplines associated with the resource.
+     * @type {Array<DisciplineDto>}
+     * @memberof ResourceDto
+     */
+    'disciplines'?: Array<DisciplineDto>;
+    /**
+     *
+     * @type {VisibilityDto}
+     * @memberof ResourceDto
+     */
+    'visibility'?: VisibilityDto;
+    /**
+     * Date when the resource was created.
+     * @type {string}
+     * @memberof ResourceDto
+     */
+    'dateCreated'?: string | null;
+    /**
+     * Identifier of the creator of the resource.
+     * @type {string}
+     * @memberof ResourceDto
+     */
+    'creator'?: string | null;
+    /**
+     * Indicates whether the resource is archived.
+     * @type {boolean}
+     * @memberof ResourceDto
+     */
+    'archived'?: boolean;
+}

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

@@ -0,0 +1,100 @@
+/**
+ * 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 { ApplicationProfileForResourceCreationDto } from './application-profile-for-resource-creation-dto';
+import { DisciplineForResourceManipulationDto } from './discipline-for-resource-manipulation-dto';
+import { FixedValueForResourceManipulationDto } from './fixed-value-for-resource-manipulation-dto';
+import { LicenseForResourceManipulationDto } from './license-for-resource-manipulation-dto';
+import { ResourceTypeOptionsForCreationDto } from './resource-type-options-for-creation-dto';
+import { VisibilityForResourceManipulationDto } from './visibility-for-resource-manipulation-dto';
+/**
+ * Represents the data transfer object (DTO) used for creating a resource.  Inherits properties from Coscine.Api.Core.Shared.DataTransferObjects.ParameterObjects.ResourceForManipulationDto.
+ * @export
+ * @interface ResourceForCreationDto
+ */
+export interface ResourceForCreationDto {
+    /**
+     * The name of the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
+     */
+    'name': string;
+    /**
+     * The display name of the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
+     */
+    'displayName'?: string | null;
+    /**
+     * The description of the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
+     */
+    'description': string;
+    /**
+     * The keywords associated with the resource.
+     * @type {Array<string>}
+     * @memberof ResourceForCreationDto
+     */
+    'keywords'?: Array<string> | null;
+    /**
+     * Fixed values associated with the resource.
+     * @type {{ [key: string]: { [key: string]: Array<FixedValueForResourceManipulationDto>; }; }}
+     * @memberof ResourceForCreationDto
+     */
+    'fixedValues'?: {
+        [key: string]: {
+            [key: string]: Array<FixedValueForResourceManipulationDto>;
+        };
+    } | null;
+    /**
+     *
+     * @type {LicenseForResourceManipulationDto}
+     * @memberof ResourceForCreationDto
+     */
+    'license'?: LicenseForResourceManipulationDto;
+    /**
+     * Notes about the usage of the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
+     */
+    'usageNote'?: string | null;
+    /**
+     *
+     * @type {VisibilityForResourceManipulationDto}
+     * @memberof ResourceForCreationDto
+     */
+    'visibility': VisibilityForResourceManipulationDto;
+    /**
+     * The disciplines associated with the resource.
+     * @type {Array<DisciplineForResourceManipulationDto>}
+     * @memberof ResourceForCreationDto
+     */
+    'disciplines': Array<DisciplineForResourceManipulationDto>;
+    /**
+     * The identifier of the resource type associated with the resource.
+     * @type {string}
+     * @memberof ResourceForCreationDto
+     */
+    'resourceTypeId': string;
+    /**
+     *
+     * @type {ApplicationProfileForResourceCreationDto}
+     * @memberof ResourceForCreationDto
+     */
+    'applicationProfile': ApplicationProfileForResourceCreationDto;
+    /**
+     *
+     * @type {ResourceTypeOptionsForCreationDto}
+     * @memberof ResourceForCreationDto
+     */
+    'resourceTypeOptions': ResourceTypeOptionsForCreationDto;
+}