@coscine/api-client 3.20.0 → 3.22.0

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

@@ -18,6 +18,7 @@ import type { VocabularyInstanceDtoPagedResponse } from '../../@coscine/model';
 import type { VocabularyInstanceDtoResponse } from '../../@coscine/model';
 /**
  * VocabularyApi - axios parameter creator
+ * @export
  */
 export declare const VocabularyApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -64,6 +65,7 @@ export declare const VocabularyApiAxiosParamCreator: (configuration?: Configurat
 };
 /**
  * VocabularyApi - functional programming interface
+ * @export
  */
 export declare const VocabularyApiFp: (configuration?: Configuration) => {
     /**
@@ -110,6 +112,7 @@ export declare const VocabularyApiFp: (configuration?: Configuration) => {
 };
 /**
  * VocabularyApi - factory interface
+ * @export
  */
 export declare const VocabularyApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -146,73 +149,108 @@ export declare const VocabularyApiFactory: (configuration?: Configuration, baseP
 };
 /**
  * Request parameters for getVocabularies operation in VocabularyApi.
+ * @export
+ * @interface VocabularyApiGetVocabulariesRequest
  */
 export interface VocabularyApiGetVocabulariesRequest {
     /**
      * Gets or sets the search term used to filter vocabularies.
+     * @type {string}
+     * @memberof VocabularyApiGetVocabularies
      */
     readonly searchTerm?: string;
     /**
      * Gets or sets the language for which the vocabularies are requested.
+     * @type {AcceptedLanguage}
+     * @memberof VocabularyApiGetVocabularies
      */
     readonly language?: AcceptedLanguage;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof VocabularyApiGetVocabularies
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof VocabularyApiGetVocabularies
      */
     readonly pageSize?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof VocabularyApiGetVocabularies
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for getVocabularyInstance operation in VocabularyApi.
+ * @export
+ * @interface VocabularyApiGetVocabularyInstanceRequest
  */
 export interface VocabularyApiGetVocabularyInstanceRequest {
     /**
      * The URI of the vocabulary instance to retrieve.
+     * @type {string}
+     * @memberof VocabularyApiGetVocabularyInstance
      */
     readonly instance: string;
     /**
      * The preferred language for the instance data.
+     * @type {AcceptedLanguage}
+     * @memberof VocabularyApiGetVocabularyInstance
      */
     readonly acceptLanguage?: AcceptedLanguage;
 }
 /**
  * Request parameters for getVocabularyInstances operation in VocabularyApi.
+ * @export
+ * @interface VocabularyApiGetVocabularyInstancesRequest
  */
 export interface VocabularyApiGetVocabularyInstancesRequest {
     /**
      * Gets or sets the URI class, which is a required field.
+     * @type {string}
+     * @memberof VocabularyApiGetVocabularyInstances
      */
     readonly _class: string;
     /**
      * Gets or sets the search term used to filter vocabulary instances.
+     * @type {string}
+     * @memberof VocabularyApiGetVocabularyInstances
      */
     readonly searchTerm?: string;
     /**
      * Gets or sets the language for which the vocabulary instances are requested.
+     * @type {AcceptedLanguage}
+     * @memberof VocabularyApiGetVocabularyInstances
      */
     readonly language?: AcceptedLanguage;
     /**
      * Number of items per page. The maximum number of items per page is `150`.
+     * @type {number}
+     * @memberof VocabularyApiGetVocabularyInstances
      */
     readonly pageSize?: number;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof VocabularyApiGetVocabularyInstances
      */
     readonly pageNumber?: number;
     /**
      * Gets or sets the field name used for ordering the results.  The order is constructed by an order string.  Use the property followed by \"asc\" or \"desc\" and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof VocabularyApiGetVocabularyInstances
      */
     readonly orderBy?: string;
 }
 /**
  * VocabularyApi - object-oriented interface
+ * @export
+ * @class VocabularyApi
+ * @extends {BaseAPI}
  */
 export declare class VocabularyApi extends BaseAPI {
     /**
@@ -220,6 +258,7 @@ export declare class VocabularyApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VocabularyApi
      */
     apiV2VocabulariesOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -228,6 +267,7 @@ export declare class VocabularyApi extends BaseAPI {
      * @param {VocabularyApiGetVocabulariesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VocabularyApi
      */
     getVocabularies(requestParameters?: VocabularyApiGetVocabulariesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VocabularyDtoPagedResponse, any>>;
     /**
@@ -236,6 +276,7 @@ export declare class VocabularyApi extends BaseAPI {
      * @param {VocabularyApiGetVocabularyInstanceRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VocabularyApi
      */
     getVocabularyInstance(requestParameters: VocabularyApiGetVocabularyInstanceRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VocabularyInstanceDtoResponse, any>>;
     /**
@@ -244,6 +285,7 @@ export declare class VocabularyApi extends BaseAPI {
      * @param {VocabularyApiGetVocabularyInstancesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof VocabularyApi
      */
     getVocabularyInstances(requestParameters: VocabularyApiGetVocabularyInstancesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<VocabularyInstanceDtoPagedResponse, any>>;
 }

package/dist/types/Coscine.Api/@coscine/model/accepted-language.d.ts

@@ -11,6 +11,8 @@
  */
 /**
  * Accepted languages by the API.
+ * @export
+ * @enum {string}
  */
 export declare const AcceptedLanguage: {
     readonly de: "de";

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

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

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

@@ -11,13 +11,50 @@
  */
 /**
  * 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/api-token-dto-paged-response.d.ts

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

package/dist/types/Coscine.Api/@coscine/model/api-token-dto-response.d.ts

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

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

@@ -12,27 +12,44 @@
 import type { UserMinimalDto } from './user-minimal-dto';
 /**
  * Represents an API token used for authentication.
+ * @export
+ * @interface ApiTokenDto
  */
 export interface ApiTokenDto {
     /**
      * The unique identifier of the API token.
+     * @type {string}
+     * @memberof ApiTokenDto
      */
     'id'?: string;
     /**
      * The name associated with the API token.
+     * @type {string}
+     * @memberof ApiTokenDto
      */
     'name'?: string;
     /**
      * The date when the API token was created.
+     * @type {string}
+     * @memberof ApiTokenDto
      */
     'creationDate'?: string;
     /**
      * The expiry date of the API token.
+     * @type {string}
+     * @memberof ApiTokenDto
      */
     'expiryDate'?: string;
     /**
      * The actual token used for authentication.
+     * @type {string}
+     * @memberof ApiTokenDto
      */
     'token'?: string | null;
+    /**
+     *
+     * @type {UserMinimalDto}
+     * @memberof ApiTokenDto
+     */
     'owner'?: UserMinimalDto;
 }

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

@@ -11,14 +11,20 @@
  */
 /**
  * Data transfer object (DTO) representing the creation of an API token.
+ * @export
+ * @interface ApiTokenForCreationDto
  */
 export interface ApiTokenForCreationDto {
     /**
      * Gets or sets the name of the API token.
+     * @type {string}
+     * @memberof ApiTokenForCreationDto
      */
     'name': string;
     /**
      * Gets or sets the expiration duration of the token in days.
+     * @type {number}
+     * @memberof ApiTokenForCreationDto
      */
     'expiresInDays': number;
 }

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

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

package/dist/types/Coscine.Api/@coscine/model/application-profile-dto-response.d.ts

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

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

@@ -12,19 +12,32 @@
 import type { RdfDefinitionDto } from './rdf-definition-dto';
 /**
  * Represents an application profile data transfer object.
+ * @export
+ * @interface ApplicationProfileDto
  */
 export interface ApplicationProfileDto {
     /**
      * The URI associated with the application profile.
+     * @type {string}
+     * @memberof ApplicationProfileDto
      */
     'uri': string;
     /**
      * The display name for the application profile.
+     * @type {string}
+     * @memberof ApplicationProfileDto
      */
     'displayName'?: string | null;
     /**
      * The description of the application profile.
+     * @type {string}
+     * @memberof ApplicationProfileDto
      */
     'description'?: string | null;
+    /**
+     *
+     * @type {RdfDefinitionDto}
+     * @memberof ApplicationProfileDto
+     */
     'definition'?: RdfDefinitionDto;
 }

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

@@ -10,9 +10,34 @@
  * Do not edit the class manually.
  */
 import type { ApplicationProfileForCreationDto } from './application-profile-for-creation-dto';
+/**
+ *
+ * @export
+ * @interface ApplicationProfileForCreationDtoResponse
+ */
 export interface ApplicationProfileForCreationDtoResponse {
+    /**
+     *
+     * @type {ApplicationProfileForCreationDto}
+     * @memberof ApplicationProfileForCreationDtoResponse
+     */
     'data'?: ApplicationProfileForCreationDto;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ApplicationProfileForCreationDtoResponse
+     */
     'isSuccess'?: boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof ApplicationProfileForCreationDtoResponse
+     */
     'statusCode'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ApplicationProfileForCreationDtoResponse
+     */
     'traceId'?: string | null;
 }

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

@@ -12,15 +12,26 @@
 import type { RdfDefinitionForManipulationDto } from './rdf-definition-for-manipulation-dto';
 /**
  * Data transfer object (DTO) representing the creation of an application profile.
+ * @export
+ * @interface ApplicationProfileForCreationDto
  */
 export interface ApplicationProfileForCreationDto {
     /**
      * Gets or initializes the name of the application profile.
+     * @type {string}
+     * @memberof ApplicationProfileForCreationDto
      */
     'name': string;
     /**
      * Gets or initializes the URI of the application profile.
+     * @type {string}
+     * @memberof ApplicationProfileForCreationDto
      */
     'uri': string;
+    /**
+     *
+     * @type {RdfDefinitionForManipulationDto}
+     * @memberof ApplicationProfileForCreationDto
+     */
     'definition': RdfDefinitionForManipulationDto;
 }

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

@@ -11,10 +11,14 @@
  */
 /**
  * Data transfer object (DTO) representing the creation of an application profile for a resource.
+ * @export
+ * @interface ApplicationProfileForResourceCreationDto
  */
 export interface ApplicationProfileForResourceCreationDto {
     /**
      * Gets or initializes the URI of the resource for the application profile.
+     * @type {string}
+     * @memberof ApplicationProfileForResourceCreationDto
      */
     'uri': string;
 }

package/dist/types/Coscine.Api/@coscine/model/application-profile-minimal-dto.d.ts

@@ -11,10 +11,14 @@
  */
 /**
  * Represents a minimalistic application profile data transfer object.
+ * @export
+ * @interface ApplicationProfileMinimalDto
  */
 export interface ApplicationProfileMinimalDto {
     /**
      * The URI associated with the application profile.
+     * @type {string}
+     * @memberof ApplicationProfileMinimalDto
      */
     'uri': string;
 }

package/dist/types/Coscine.Api/@coscine/model/coscine-http-method.d.ts

@@ -11,6 +11,8 @@
  */
 /**
  * An enumeration representing the supported HTTP verbs.
+ * @export
+ * @enum {string}
  */
 export declare const CoscineHttpMethod: {
     readonly GET: "GET";

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

@@ -11,10 +11,14 @@
  */
 /**
  * Data Transfer Object (DTO) that represents a user role within Coscine.///
+ * @export
+ * @interface CoscineRoleDto
  */
 export interface CoscineRoleDto {
     /**
      * Gets or sets the name of the role (e.g. \"User\", \"QuotaAdmin\").
+     * @type {string}
+     * @memberof CoscineRoleDto
      */
     'name': string;
 }

package/dist/types/Coscine.Api/@coscine/model/create-datasource-dto-response.d.ts

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

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

@@ -11,10 +11,14 @@
  */
 /**
  * Represents the data transfer object for creating a datasource.
+ * @export
+ * @interface CreateDatasourceDto
  */
 export interface CreateDatasourceDto {
     /**
      * Gets or initializes the unique identifier of the resource type option.
+     * @type {string}
+     * @memberof CreateDatasourceDto
      */
     'resourceTypeOptionId'?: string | null;
 }