@coscine/api-client 3.4.3 → 3.6.0

package/dist/types/Coscine.Api/@coscine/api/vocabulary-api.d.ts

@@ -29,7 +29,7 @@ export declare const VocabularyApiAxiosParamCreator: (configuration?: Configurat
      */
     apiV2VocabulariesOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves top-level instances from vocabularies.
      * @param {string} [searchTerm] Gets or sets the search term used to filter vocabularies.
      * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabularies are requested.
@@ -50,7 +50,7 @@ export declare const VocabularyApiAxiosParamCreator: (configuration?: Configurat
      */
     getVocabularyInstance: (instance: string, acceptLanguage?: AcceptedLanguage, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves vocabulary instances.
      * @param {string} _class Gets or sets the URI class, which is a required field.
      * @param {string} [searchTerm] Gets or sets the search term used to filter vocabulary instances.
@@ -76,7 +76,7 @@ export declare const VocabularyApiFp: (configuration?: Configuration) => {
      */
     apiV2VocabulariesOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves top-level instances from vocabularies.
      * @param {string} [searchTerm] Gets or sets the search term used to filter vocabularies.
      * @param {AcceptedLanguage} [language] Gets or sets the language for which the vocabularies are requested.
@@ -97,7 +97,7 @@ export declare const VocabularyApiFp: (configuration?: Configuration) => {
      */
     getVocabularyInstance(instance: string, acceptLanguage?: AcceptedLanguage, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VocabularyInstanceDtoResponse>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves vocabulary instances.
      * @param {string} _class Gets or sets the URI class, which is a required field.
      * @param {string} [searchTerm] Gets or sets the search term used to filter vocabulary instances.
@@ -123,7 +123,7 @@ export declare const VocabularyApiFactory: (configuration?: Configuration, baseP
      */
     apiV2VocabulariesOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves top-level instances from vocabularies.
      * @param {VocabularyApiGetVocabulariesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -139,7 +139,7 @@ export declare const VocabularyApiFactory: (configuration?: Configuration, baseP
      */
     getVocabularyInstance(requestParameters: VocabularyApiGetVocabularyInstanceRequest, options?: AxiosRequestConfig): AxiosPromise<VocabularyInstanceDtoResponse>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves vocabulary instances.
      * @param {VocabularyApiGetVocabularyInstancesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -262,7 +262,7 @@ export declare class VocabularyApi extends BaseAPI {
      */
     apiV2VocabulariesOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves top-level instances from vocabularies.
      * @param {VocabularyApiGetVocabulariesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -280,7 +280,7 @@ export declare class VocabularyApi extends BaseAPI {
      */
     getVocabularyInstance(requestParameters: VocabularyApiGetVocabularyInstanceRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VocabularyInstanceDtoResponse, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves vocabulary instances.
      * @param {VocabularyApiGetVocabularyInstancesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

package/dist/types/Coscine.Api/@coscine/model/{language-dto-paged-response.d.ts → activity-log-dto-paged-response.d.ts}

@@ -9,42 +9,42 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { LanguageDto } from './language-dto';
+import { ActivityLogDto } from './activity-log-dto';
 import { Pagination } from './pagination';
 /**
  *
  * @export
- * @interface LanguageDtoPagedResponse
+ * @interface ActivityLogDtoPagedResponse
  */
-export interface LanguageDtoPagedResponse {
+export interface ActivityLogDtoPagedResponse {
     /**
      *
-     * @type {Array<LanguageDto>}
-     * @memberof LanguageDtoPagedResponse
+     * @type {Array<ActivityLogDto>}
+     * @memberof ActivityLogDtoPagedResponse
      */
-    'data'?: Array<LanguageDto> | null;
+    'data'?: Array<ActivityLogDto> | null;
     /**
      *
      * @type {boolean}
-     * @memberof LanguageDtoPagedResponse
+     * @memberof ActivityLogDtoPagedResponse
      */
     'isSuccess'?: boolean;
     /**
      *
      * @type {number}
-     * @memberof LanguageDtoPagedResponse
+     * @memberof ActivityLogDtoPagedResponse
      */
     'statusCode'?: number | null;
     /**
      *
      * @type {string}
-     * @memberof LanguageDtoPagedResponse
+     * @memberof ActivityLogDtoPagedResponse
      */
     'traceId'?: string | null;
     /**
      *
      * @type {Pagination}
-     * @memberof LanguageDtoPagedResponse
+     * @memberof ActivityLogDtoPagedResponse
      */
     'pagination'?: Pagination;
 }

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

@@ -0,0 +1,60 @@
+/**
+ * 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 activity log.
+ * @export
+ * @interface ActivityLogDto
+ */
+export interface ActivityLogDto {
+    /**
+     *
+     * @type {string}
+     * @memberof ActivityLogDto
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ActivityLogDto
+     */
+    'apiPath'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ActivityLogDto
+     */
+    'httpAction'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ActivityLogDto
+     */
+    'controllerName'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ActivityLogDto
+     */
+    'actionName'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ActivityLogDto
+     */
+    'userId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ActivityLogDto
+     */
+    'activityTimestamp'?: string;
+}

package/dist/types/Coscine.Api/@coscine/model/coscine-http-method.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.
+ */
+/**
+ * An enumeration representing the supported HTTP verbs.
+ * @export
+ * @enum {string}
+ */
+export declare const CoscineHttpMethod: {
+    readonly Get: "GET";
+    readonly Head: "HEAD";
+    readonly Post: "POST";
+    readonly Put: "PUT";
+    readonly Delete: "DELETE";
+};
+export type CoscineHttpMethod = typeof CoscineHttpMethod[keyof typeof CoscineHttpMethod];

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

@@ -71,4 +71,10 @@ export interface FileTreeDto {
      * @memberof FileTreeDto
      */
     'actions'?: FileActionsDto;
+    /**
+     * Determines if the specific tree entry is hidden.
+     * @type {boolean}
+     * @memberof FileTreeDto
+     */
+    'hidden'?: boolean;
 }

package/dist/types/Coscine.Api/@coscine/model/{pid-validation-dto-response.d.ts → handle-dto-response.d.ts}

@@ -9,35 +9,35 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { PidValidationDto } from './pid-validation-dto';
+import { HandleDto } from './handle-dto';
 /**
  *
  * @export
- * @interface PidValidationDtoResponse
+ * @interface HandleDtoResponse
  */
-export interface PidValidationDtoResponse {
+export interface HandleDtoResponse {
     /**
      *
-     * @type {PidValidationDto}
-     * @memberof PidValidationDtoResponse
+     * @type {HandleDto}
+     * @memberof HandleDtoResponse
      */
-    'data'?: PidValidationDto;
+    'data'?: HandleDto;
     /**
      *
      * @type {boolean}
-     * @memberof PidValidationDtoResponse
+     * @memberof HandleDtoResponse
      */
     'isSuccess'?: boolean;
     /**
      *
      * @type {number}
-     * @memberof PidValidationDtoResponse
+     * @memberof HandleDtoResponse
      */
     'statusCode'?: number | null;
     /**
      *
      * @type {string}
-     * @memberof PidValidationDtoResponse
+     * @memberof HandleDtoResponse
      */
     'traceId'?: string | null;
 }

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

@@ -9,23 +9,24 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import { PidType } from './pid-type';
+import { HandleValueDto } from './handle-value-dto';
+import { PidDto } from './pid-dto';
 /**
- * Represents a data transfer object (DTO) for validating a PID (Persistent Identifier).
+ *
  * @export
- * @interface PidValidationDto
+ * @interface HandleDto
  */
-export interface PidValidationDto {
+export interface HandleDto {
     /**
-     * Indicates whether the provided PID is valid.
-     * @type {boolean}
-     * @memberof PidValidationDto
+     *
+     * @type {PidDto}
+     * @memberof HandleDto
      */
-    'isValid'?: boolean;
+    'pid'?: PidDto;
     /**
      *
-     * @type {PidType}
-     * @memberof PidValidationDto
+     * @type {Array<HandleValueDto>}
+     * @memberof HandleDto
      */
-    'type'?: PidType;
+    'values'?: Array<HandleValueDto>;
 }

package/dist/types/Coscine.Api/@coscine/model/handle-for-update-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 { HandleValueForUpdateDto } from './handle-value-for-update-dto';
+/**
+ *
+ * @export
+ * @interface HandleForUpdateDto
+ */
+export interface HandleForUpdateDto {
+    /**
+     *
+     * @type {Array<HandleValueForUpdateDto>}
+     * @memberof HandleForUpdateDto
+     */
+    'values'?: Array<HandleValueForUpdateDto>;
+}

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

@@ -0,0 +1,72 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface HandleValueDto
+ */
+export interface HandleValueDto {
+    /**
+     *
+     * @type {number}
+     * @memberof HandleValueDto
+     */
+    'idx'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof HandleValueDto
+     */
+    'type'?: string;
+    /**
+     *
+     * @type {any}
+     * @memberof HandleValueDto
+     */
+    'parsed_data'?: any;
+    /**
+     *
+     * @type {string}
+     * @memberof HandleValueDto
+     */
+    'data'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HandleValueDto
+     */
+    'timestamp'?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof HandleValueDto
+     */
+    'ttl_type'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof HandleValueDto
+     */
+    'ttl'?: number;
+    /**
+     *
+     * @type {Array<any>}
+     * @memberof HandleValueDto
+     */
+    'refs'?: Array<any>;
+    /**
+     *
+     * @type {string}
+     * @memberof HandleValueDto
+     */
+    'privs'?: string;
+}

package/dist/types/Coscine.Api/@coscine/model/handle-value-for-update-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.
+ */
+/**
+ * Data transfer object (DTO) representing updating a handle.
+ * @export
+ * @interface HandleValueForUpdateDto
+ */
+export interface HandleValueForUpdateDto {
+    /**
+     * The data type of the handle.
+     * @type {string}
+     * @memberof HandleValueForUpdateDto
+     */
+    'type'?: string;
+    /**
+     * The parsed data of the handle.
+     * @type {any}
+     * @memberof HandleValueForUpdateDto
+     */
+    'parsed_data'?: any;
+    /**
+     * The id of the handle.
+     * @type {number}
+     * @memberof HandleValueForUpdateDto
+     */
+    'idx'?: number;
+}

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

@@ -1,4 +1,6 @@
 export * from './accepted-language';
+export * from './activity-log-dto';
+export * from './activity-log-dto-paged-response';
 export * from './api-token-dto';
 export * from './api-token-dto-paged-response';
 export * from './api-token-dto-response';
@@ -10,6 +12,7 @@ export * from './application-profile-for-creation-dto';
 export * from './application-profile-for-creation-dto-response';
 export * from './application-profile-for-resource-creation-dto';
 export * from './application-profile-minimal-dto';
+export * from './coscine-http-method';
 export * from './discipline-dto';
 export * from './discipline-dto-paged-response';
 export * from './discipline-dto-response';
@@ -30,6 +33,11 @@ export * from './gitlab-project-dto-ienumerable-response';
 export * from './gitlab-project-dto-response';
 export * from './gitlab-resource-type-options-for-creation-dto';
 export * from './gitlab-resource-type-options-for-update-dto';
+export * from './handle-dto';
+export * from './handle-dto-response';
+export * from './handle-for-update-dto';
+export * from './handle-value-dto';
+export * from './handle-value-for-update-dto';
 export * from './identity-provider-dto';
 export * from './identity-providers';
 export * from './language-dto';
@@ -45,6 +53,7 @@ export * from './maintenance-dto-paged-response';
 export * from './metadata-tree-dto';
 export * from './metadata-tree-dto-paged-response';
 export * from './metadata-tree-dto-response';
+export * from './metadata-tree-extracted-dto';
 export * from './metadata-tree-for-creation-dto';
 export * from './metadata-tree-for-update-dto';
 export * from './metadata-update-admin-parameters';
@@ -53,10 +62,11 @@ export * from './organization-dto-paged-response';
 export * from './organization-dto-response';
 export * from './organization-for-project-manipulation-dto';
 export * from './pagination';
+export * from './pid-dto';
+export * from './pid-dto-paged-response';
+export * from './pid-dto-response';
 export * from './pid-request-dto';
 export * from './pid-type';
-export * from './pid-validation-dto';
-export * from './pid-validation-dto-response';
 export * from './project-admin-dto';
 export * from './project-admin-dto-paged-response';
 export * from './project-dto';
@@ -83,6 +93,9 @@ export * from './project-role-for-project-manipulation-dto';
 export * from './project-role-minimal-dto';
 export * from './public-user-dto';
 export * from './public-user-dto-ienumerable-response';
+export * from './publication-advisory-service-dto';
+export * from './publication-request-for-creation-dto';
+export * from './publication-request-for-creation-dto-response';
 export * from './quota-dto';
 export * from './quota-for-manipulation-dto';
 export * from './quota-unit';

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

@@ -27,4 +27,10 @@ export interface LicenseDto {
      * @memberof LicenseDto
      */
     'displayName'?: string;
+    /**
+     * Gets or sets the Uri of the license.
+     * @type {string}
+     * @memberof LicenseDto
+     */
+    'url'?: string;
 }

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { MetadataTreeExtractedDto } from './metadata-tree-extracted-dto';
 import { RdfDefinitionDto } from './rdf-definition-dto';
 import { TreeDataType } from './tree-data-type';
 /**
@@ -47,4 +48,10 @@ export interface MetadataTreeDto {
      * @memberof MetadataTreeDto
      */
     'definition'?: RdfDefinitionDto;
+    /**
+     *
+     * @type {MetadataTreeExtractedDto}
+     * @memberof MetadataTreeDto
+     */
+    'extracted'?: MetadataTreeExtractedDto;
 }

package/dist/types/Coscine.Api/@coscine/model/metadata-tree-extracted-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 extracted metadata within a tree structure, extending the base TreeDto.
+ * @export
+ * @interface MetadataTreeExtractedDto
+ */
+export interface MetadataTreeExtractedDto {
+    /**
+     * The path of the tree item.
+     * @type {string}
+     * @memberof MetadataTreeExtractedDto
+     */
+    'path'?: string;
+    /**
+     *
+     * @type {TreeDataType}
+     * @memberof MetadataTreeExtractedDto
+     */
+    'type'?: TreeDataType;
+    /**
+     * Gets the identifier of the metadata extraction graph.
+     * @type {string}
+     * @memberof MetadataTreeExtractedDto
+     */
+    'metadataId'?: string;
+    /**
+     * Gets the identifier of the raw data extraction graph.
+     * @type {string}
+     * @memberof MetadataTreeExtractedDto
+     */
+    'rawDataId'?: string | null;
+    /**
+     *
+     * @type {RdfDefinitionDto}
+     * @memberof MetadataTreeExtractedDto
+     */
+    'definition'?: RdfDefinitionDto;
+}

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

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { PublicationAdvisoryServiceDto } from './publication-advisory-service-dto';
 /**
  * Represents a data transfer object (DTO) for an organization, including its ROR (Research Organization Registry) ID, display name, and email address.
  * @export
@@ -33,4 +34,10 @@ export interface OrganizationDto {
      * @memberof OrganizationDto
      */
     'email'?: string | null;
+    /**
+     *
+     * @type {PublicationAdvisoryServiceDto}
+     * @memberof OrganizationDto
+     */
+    'publicationAdvisoryService'?: PublicationAdvisoryServiceDto;
 }

package/dist/types/Coscine.Api/@coscine/model/{title-dto-paged-response.d.ts → pid-dto-paged-response.d.ts}

@@ -10,41 +10,41 @@
  * Do not edit the class manually.
  */
 import { Pagination } from './pagination';
-import { TitleDto } from './title-dto';
+import { PidDto } from './pid-dto';
 /**
  *
  * @export
- * @interface TitleDtoPagedResponse
+ * @interface PidDtoPagedResponse
  */
-export interface TitleDtoPagedResponse {
+export interface PidDtoPagedResponse {
     /**
      *
-     * @type {Array<TitleDto>}
-     * @memberof TitleDtoPagedResponse
+     * @type {Array<PidDto>}
+     * @memberof PidDtoPagedResponse
      */
-    'data'?: Array<TitleDto> | null;
+    'data'?: Array<PidDto> | null;
     /**
      *
      * @type {boolean}
-     * @memberof TitleDtoPagedResponse
+     * @memberof PidDtoPagedResponse
      */
     'isSuccess'?: boolean;
     /**
      *
      * @type {number}
-     * @memberof TitleDtoPagedResponse
+     * @memberof PidDtoPagedResponse
      */
     'statusCode'?: number | null;
     /**
      *
      * @type {string}
-     * @memberof TitleDtoPagedResponse
+     * @memberof PidDtoPagedResponse
      */
     'traceId'?: string | null;
     /**
      *
      * @type {Pagination}
-     * @memberof TitleDtoPagedResponse
+     * @memberof PidDtoPagedResponse
      */
     'pagination'?: Pagination;
 }