@coscine/api-client 3.3.1 → 3.4.0

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

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

package/dist/types/Coscine.Api/@coscine/model/role-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 a role.
+ * @export
+ * @interface RoleDto
+ */
+export interface RoleDto {
+    /**
+     * The unique identifier of the role.
+     * @type {string}
+     * @memberof RoleDto
+     */
+    'id'?: string;
+    /**
+     * The display name of the role.
+     * @type {string}
+     * @memberof RoleDto
+     */
+    'displayName'?: string;
+    /**
+     * The description of the role.
+     * @type {string}
+     * @memberof RoleDto
+     */
+    'description'?: string;
+}

package/dist/types/Coscine.Api/@coscine/model/role-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 Data Transfer Object (DTO) containing minimal information about a role.
+ * @export
+ * @interface RoleMinimalDto
+ */
+export interface RoleMinimalDto {
+    /**
+     * The unique identifier of the role.
+     * @type {string}
+     * @memberof RoleMinimalDto
+     */
+    'id'?: string;
+}

package/dist/types/Coscine.Api/@coscine/model/search-category-type.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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 search item type.
+ * @export
+ * @enum {string}
+ */
+export declare const SearchCategoryType: {
+    readonly None: "None";
+    readonly HttpsPurlOrgCoscineTermsStructureMetadata: "https://purl.org/coscine/terms/structure#Metadata";
+    readonly HttpsPurlOrgCoscineTermsStructureProject: "https://purl.org/coscine/terms/structure#Project";
+    readonly HttpsPurlOrgCoscineTermsStructureResource: "https://purl.org/coscine/terms/structure#Resource";
+};
+export type SearchCategoryType = typeof SearchCategoryType[keyof typeof SearchCategoryType];

package/dist/types/Coscine.Api/@coscine/model/search-category.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 search category with a name and count of occurrences.
+ * @export
+ * @interface SearchCategory
+ */
+export interface SearchCategory {
+    /**
+     * The name of the search category.
+     * @type {string}
+     * @memberof SearchCategory
+     */
+    'name'?: string;
+    /**
+     * The count of occurrences for the search category.
+     * @type {number}
+     * @memberof SearchCategory
+     */
+    'count'?: number;
+}

package/dist/types/Coscine.Api/@coscine/model/search-result-dto-paged-search-response.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 { Pagination } from './pagination';
+import { SearchCategory } from './search-category';
+import { SearchResultDto } from './search-result-dto';
+/**
+ *
+ * @export
+ * @interface SearchResultDtoPagedSearchResponse
+ */
+export interface SearchResultDtoPagedSearchResponse {
+    /**
+     *
+     * @type {Array<SearchResultDto>}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
+    'data'?: Array<SearchResultDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
+    'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
+    'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
+    'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
+    'pagination'?: Pagination;
+    /**
+     *
+     * @type {Array<SearchCategory>}
+     * @memberof SearchResultDtoPagedSearchResponse
+     */
+    'categories'?: Array<SearchCategory> | null;
+}

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

@@ -0,0 +1,37 @@
+/**
+ * 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 { SearchCategoryType } from './search-category-type';
+/**
+ * Represents a Data Transfer Object (DTO) for search results.
+ * @export
+ * @interface SearchResultDto
+ */
+export interface SearchResultDto {
+    /**
+     * The URI associated with the search result.
+     * @type {string}
+     * @memberof SearchResultDto
+     */
+    'uri'?: string;
+    /**
+     *
+     * @type {SearchCategoryType}
+     * @memberof SearchResultDto
+     */
+    'type'?: SearchCategoryType;
+    /**
+     * The dynamic source data for the search result.
+     * @type {any}
+     * @memberof SearchResultDto
+     */
+    'source'?: any;
+}

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

package/dist/types/Coscine.Api/@coscine/model/terms-of-service-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 terms of service information.
+ * @export
+ * @interface TermsOfServiceDto
+ */
+export interface TermsOfServiceDto {
+    /**
+     * The version of the terms of service.
+     * @type {string}
+     * @memberof TermsOfServiceDto
+     */
+    'version'?: string;
+    /**
+     * Indicates whether these terms of service are current or not.
+     * @type {boolean}
+     * @memberof TermsOfServiceDto
+     */
+    'isCurrent'?: boolean;
+}

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

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

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

package/dist/types/Coscine.Api/@coscine/model/title-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 title information.
+ * @export
+ * @interface TitleDto
+ */
+export interface TitleDto {
+    /**
+     * The identifier for the title.
+     * @type {string}
+     * @memberof TitleDto
+     */
+    'id'?: string;
+    /**
+     * The displayed name of the title.
+     * @type {string}
+     * @memberof TitleDto
+     */
+    'displayName'?: string;
+}

package/dist/types/Coscine.Api/@coscine/model/title-for-user-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 a user\'s title.
+ * @export
+ * @interface TitleForUserManipulationDto
+ */
+export interface TitleForUserManipulationDto {
+    /**
+     * The unique identifier of the title.
+     * @type {string}
+     * @memberof TitleForUserManipulationDto
+     */
+    'id': string;
+}

package/dist/types/Coscine.Api/@coscine/model/tree-data-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.
+ */
+/**
+ * Represents the types of nodes within a hierarchical tree structure.
+ * @export
+ * @enum {string}
+ */
+export declare const TreeDataType: {
+    readonly Tree: "Tree";
+    readonly Leaf: "Leaf";
+};
+export type TreeDataType = typeof TreeDataType[keyof typeof TreeDataType];

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