@coscine/api-client 3.20.0 → 3.22.0

package/dist/types/Coscine.Api/@coscine/model/user-notification-opt-out-dto.d.ts

@@ -11,18 +11,26 @@
  */
 /**
  * Represents a minimal data transfer object (DTO) for a user notification.
+ * @export
+ * @interface UserNotificationOptOutDto
  */
 export interface UserNotificationOptOutDto {
     /**
      * Unique identifier for the user notification.
+     * @type {string}
+     * @memberof UserNotificationOptOutDto
      */
     'id': string;
     /**
      * Unique identifier of the user.
+     * @type {string}
+     * @memberof UserNotificationOptOutDto
      */
     'userId': string;
     /**
      * Unique identifier of the notification.
+     * @type {string}
+     * @memberof UserNotificationOptOutDto
      */
     'notificationId': string;
 }

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

@@ -11,22 +11,32 @@
  */
 /**
  * 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 | null;
     /**
      * 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

@@ -11,10 +11,14 @@
  */
 /**
  * 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/variant-dto.d.ts

@@ -11,14 +11,20 @@
  */
 /**
  * Represents the variants of this specific metadata tree.
+ * @export
+ * @interface VariantDto
  */
 export interface VariantDto {
     /**
      * Name of the graph.
+     * @type {string}
+     * @memberof VariantDto
      */
     'graphName'?: string;
     /**
      * Similarity value 0-1
+     * @type {number}
+     * @memberof VariantDto
      */
     'similarity'?: number;
 }

package/dist/types/Coscine.Api/@coscine/model/visibility-dto-paged-response.d.ts

@@ -11,10 +11,40 @@
  */
 import type { Pagination } from './pagination';
 import type { 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

@@ -10,9 +10,34 @@
  * Do not edit the class manually.
  */
 import type { 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

@@ -11,14 +11,20 @@
  */
 /**
  * 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

@@ -11,10 +11,14 @@
  */
 /**
  * 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

@@ -11,10 +11,14 @@
  */
 /**
  * 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

@@ -11,10 +11,40 @@
  */
 import type { Pagination } from './pagination';
 import type { 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;
 }

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

@@ -11,22 +11,32 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) for vocabulary details.
+ * @export
+ * @interface VocabularyDto
  */
 export interface VocabularyDto {
     /**
      * The URI of the graph containing the vocabulary.
+     * @type {string}
+     * @memberof VocabularyDto
      */
     'graphUri': string;
     /**
      * The URI of the top-level parent class in the vocabulary.
+     * @type {string}
+     * @memberof VocabularyDto
      */
     'classUri': string;
     /**
      * The display name of the vocabulary.
+     * @type {string}
+     * @memberof VocabularyDto
      */
     'displayName'?: string | null;
     /**
      * The description of the vocabulary.
+     * @type {string}
+     * @memberof VocabularyDto
      */
     'description'?: string | null;
 }

package/dist/types/Coscine.Api/@coscine/model/vocabulary-instance-dto-paged-response.d.ts

@@ -11,10 +11,40 @@
  */
 import type { Pagination } from './pagination';
 import type { VocabularyInstanceDto } from './vocabulary-instance-dto';
+/**
+ *
+ * @export
+ * @interface VocabularyInstanceDtoPagedResponse
+ */
 export interface VocabularyInstanceDtoPagedResponse {
+    /**
+     *
+     * @type {Array<VocabularyInstanceDto>}
+     * @memberof VocabularyInstanceDtoPagedResponse
+     */
     'data'?: Array<VocabularyInstanceDto> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VocabularyInstanceDtoPagedResponse
+     */
     'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof VocabularyInstanceDtoPagedResponse
+     */
     'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof VocabularyInstanceDtoPagedResponse
+     */
     'traceId'?: string | null;
+    /**
+     *
+     * @type {Pagination}
+     * @memberof VocabularyInstanceDtoPagedResponse
+     */
     'pagination'?: Pagination;
 }

package/dist/types/Coscine.Api/@coscine/model/vocabulary-instance-dto-response.d.ts

@@ -10,9 +10,34 @@
  * Do not edit the class manually.
  */
 import type { VocabularyInstanceDto } from './vocabulary-instance-dto';
+/**
+ *
+ * @export
+ * @interface VocabularyInstanceDtoResponse
+ */
 export interface VocabularyInstanceDtoResponse {
+    /**
+     *
+     * @type {VocabularyInstanceDto}
+     * @memberof VocabularyInstanceDtoResponse
+     */
     'data'?: VocabularyInstanceDto;
+    /**
+     *
+     * @type {boolean}
+     * @memberof VocabularyInstanceDtoResponse
+     */
     'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof VocabularyInstanceDtoResponse
+     */
     'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof VocabularyInstanceDtoResponse
+     */
     'traceId'?: string | null;
 }

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

@@ -11,30 +11,44 @@
  */
 /**
  * Represents a Data Transfer Object (DTO) for vocabulary instance details.
+ * @export
+ * @interface VocabularyInstanceDto
  */
 export interface VocabularyInstanceDto {
     /**
      * The URI of the graph containing the vocabulary.
+     * @type {string}
+     * @memberof VocabularyInstanceDto
      */
     'graphUri': string;
     /**
      * The URI of the instance.
+     * @type {string}
+     * @memberof VocabularyInstanceDto
      */
     'instanceUri'?: string;
     /**
      * The URI representing the type of the instance.
+     * @type {string}
+     * @memberof VocabularyInstanceDto
      */
     'typeUri'?: string | null;
     /**
      * The URI of the direct parent class.
+     * @type {string}
+     * @memberof VocabularyInstanceDto
      */
     'subClassOfUri'?: string | null;
     /**
      * The display name of the vocabulary instance.
+     * @type {string}
+     * @memberof VocabularyInstanceDto
      */
     'displayName'?: string | null;
     /**
      * The description of the vocabulary instance.
+     * @type {string}
+     * @memberof VocabularyInstanceDto
      */
     'description'?: string | null;
 }

package/dist/types/Coscine.Api/api.d.ts

@@ -31,6 +31,7 @@ export * from './@coscine/api/project-resource-quota-api';
 export * from './@coscine/api/project-resource-type-api';
 export * from './@coscine/api/project-sub-projects-api';
 export * from './@coscine/api/provenance-api';
+export * from './@coscine/api/publication-advisory-service-api';
 export * from './@coscine/api/report-api';
 export * from './@coscine/api/resource-api';
 export * from './@coscine/api/resource-type-api';

package/dist/types/Coscine.Api/base.d.ts

@@ -12,22 +12,42 @@
 import type { Configuration } from './configuration';
 import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
 export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
 export declare const COLLECTION_FORMATS: {
     csv: string;
     ssv: string;
     tsv: string;
     pipes: string;
 };
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
 export interface RequestArgs {
     url: string;
     options: RawAxiosRequestConfig;
 }
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
 export declare class BaseAPI {
     protected basePath: string;
     protected axios: AxiosInstance;
     protected configuration: Configuration | undefined;
     constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
 }
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
 export declare class RequiredError extends Error {
     field: string;
     constructor(field: string, msg?: string);
@@ -38,5 +58,9 @@ interface ServerMap {
         description: string;
     }[];
 }
+/**
+ *
+ * @export
+ */
 export declare const operationServerMap: ServerMap;
 export {};

package/dist/types/Coscine.Api/common.d.ts

@@ -12,17 +12,54 @@
 import type { Configuration } from "./configuration";
 import type { RequestArgs } from "./base";
 import type { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
 export declare const DUMMY_BASE_URL = "https://example.com";
 /**
  *
  * @throws {RequiredError}
+ * @export
  */
 export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
 export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
 export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
 export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
 export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
 export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
 export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
 export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
 export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/types/Coscine.Api/configuration.d.ts

@@ -9,11 +9,23 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+interface AWSv4Configuration {
+    options?: {
+        region?: string;
+        service?: string;
+    };
+    credentials?: {
+        accessKeyId?: string;
+        secretAccessKey?: string;
+        sessionToken?: string;
+    };
+}
 export interface ConfigurationParameters {
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     username?: string;
     password?: string;
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    awsv4?: AWSv4Configuration;
     basePath?: string;
     serverIndex?: number;
     baseOptions?: any;
@@ -23,32 +35,60 @@ export declare class Configuration {
     /**
      * parameter for apiKey security
      * @param name security name
+     * @memberof Configuration
      */
     apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
     /**
      * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
      */
     username?: string;
     /**
      * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
      */
     password?: string;
     /**
      * parameter for oauth2 security
      * @param name security name
      * @param scopes oauth2 scope
+     * @memberof Configuration
      */
     accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * parameter for aws4 signature security
+     * @param {Object} AWS4Signature - AWS4 Signature security
+     * @param {string} options.region - aws region
+     * @param {string} options.service - name of the service.
+     * @param {string} credentials.accessKeyId - aws access key id
+     * @param {string} credentials.secretAccessKey - aws access key
+     * @param {string} credentials.sessionToken - aws session token
+     * @memberof Configuration
+     */
+    awsv4?: AWSv4Configuration;
     /**
      * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
      */
     basePath?: string;
     /**
      * override server index
+     *
+     * @type {number}
+     * @memberof Configuration
      */
     serverIndex?: number;
     /**
      * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
      */
     baseOptions?: any;
     /**
@@ -72,3 +112,4 @@ export declare class Configuration {
      */
     isJsonMime(mime: string): boolean;
 }
+export {};