@coscine/api-client 3.20.0 → 3.22.0

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

@@ -16,6 +16,7 @@ import type { LanguageDtoIEnumerableResponse } from '../../@coscine/model';
 import type { LanguageDtoResponse } from '../../@coscine/model';
 /**
  * LanguageApi - axios parameter creator
+ * @export
  */
 export declare const LanguageApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -46,6 +47,7 @@ export declare const LanguageApiAxiosParamCreator: (configuration?: Configuratio
 };
 /**
  * LanguageApi - functional programming interface
+ * @export
  */
 export declare const LanguageApiFp: (configuration?: Configuration) => {
     /**
@@ -76,6 +78,7 @@ export declare const LanguageApiFp: (configuration?: Configuration) => {
 };
 /**
  * LanguageApi - factory interface
+ * @export
  */
 export declare const LanguageApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -104,32 +107,47 @@ export declare const LanguageApiFactory: (configuration?: Configuration, basePat
 };
 /**
  * Request parameters for getLanguage operation in LanguageApi.
+ * @export
+ * @interface LanguageApiGetLanguageRequest
  */
 export interface LanguageApiGetLanguageRequest {
     /**
      * The ID of the language.
+     * @type {string}
+     * @memberof LanguageApiGetLanguage
      */
     readonly languageId: string;
 }
 /**
  * Request parameters for getLanguages operation in LanguageApi.
+ * @export
+ * @interface LanguageApiGetLanguagesRequest
  */
 export interface LanguageApiGetLanguagesRequest {
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof LanguageApiGetLanguages
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof LanguageApiGetLanguages
      */
     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 LanguageApiGetLanguages
      */
     readonly orderBy?: string;
 }
 /**
  * LanguageApi - object-oriented interface
+ * @export
+ * @class LanguageApi
+ * @extends {BaseAPI}
  */
 export declare class LanguageApi extends BaseAPI {
     /**
@@ -137,6 +155,7 @@ export declare class LanguageApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof LanguageApi
      */
     apiV2LanguagesOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -145,6 +164,7 @@ export declare class LanguageApi extends BaseAPI {
      * @param {LanguageApiGetLanguageRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof LanguageApi
      */
     getLanguage(requestParameters: LanguageApiGetLanguageRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LanguageDtoResponse, any>>;
     /**
@@ -153,6 +173,7 @@ export declare class LanguageApi extends BaseAPI {
      * @param {LanguageApiGetLanguagesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof LanguageApi
      */
     getLanguages(requestParameters?: LanguageApiGetLanguagesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LanguageDtoIEnumerableResponse, any>>;
 }

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

@@ -16,6 +16,7 @@ import type { LicenseDtoPagedResponse } from '../../@coscine/model';
 import type { LicenseDtoResponse } from '../../@coscine/model';
 /**
  * LicenseApi - axios parameter creator
+ * @export
  */
 export declare const LicenseApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -46,6 +47,7 @@ export declare const LicenseApiAxiosParamCreator: (configuration?: Configuration
 };
 /**
  * LicenseApi - functional programming interface
+ * @export
  */
 export declare const LicenseApiFp: (configuration?: Configuration) => {
     /**
@@ -76,6 +78,7 @@ export declare const LicenseApiFp: (configuration?: Configuration) => {
 };
 /**
  * LicenseApi - factory interface
+ * @export
  */
 export declare const LicenseApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -104,32 +107,47 @@ export declare const LicenseApiFactory: (configuration?: Configuration, basePath
 };
 /**
  * Request parameters for getLicense operation in LicenseApi.
+ * @export
+ * @interface LicenseApiGetLicenseRequest
  */
 export interface LicenseApiGetLicenseRequest {
     /**
      * The ID of the license.
+     * @type {string}
+     * @memberof LicenseApiGetLicense
      */
     readonly licenseId: string;
 }
 /**
  * Request parameters for getLicenses operation in LicenseApi.
+ * @export
+ * @interface LicenseApiGetLicensesRequest
  */
 export interface LicenseApiGetLicensesRequest {
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof LicenseApiGetLicenses
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof LicenseApiGetLicenses
      */
     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 LicenseApiGetLicenses
      */
     readonly orderBy?: string;
 }
 /**
  * LicenseApi - object-oriented interface
+ * @export
+ * @class LicenseApi
+ * @extends {BaseAPI}
  */
 export declare class LicenseApi extends BaseAPI {
     /**
@@ -137,6 +155,7 @@ export declare class LicenseApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof LicenseApi
      */
     apiV2LicensesOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -145,6 +164,7 @@ export declare class LicenseApi extends BaseAPI {
      * @param {LicenseApiGetLicenseRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof LicenseApi
      */
     getLicense(requestParameters: LicenseApiGetLicenseRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LicenseDtoResponse, any>>;
     /**
@@ -153,6 +173,7 @@ export declare class LicenseApi extends BaseAPI {
      * @param {LicenseApiGetLicensesRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof LicenseApi
      */
     getLicenses(requestParameters?: LicenseApiGetLicensesRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<LicenseDtoPagedResponse, any>>;
 }

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

@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../../base';
 import type { MaintenanceDtoPagedResponse } from '../../@coscine/model';
 /**
  * MaintenanceApi - axios parameter creator
+ * @export
  */
 export declare const MaintenanceApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -35,6 +36,7 @@ export declare const MaintenanceApiAxiosParamCreator: (configuration?: Configura
 };
 /**
  * MaintenanceApi - functional programming interface
+ * @export
  */
 export declare const MaintenanceApiFp: (configuration?: Configuration) => {
     /**
@@ -55,6 +57,7 @@ export declare const MaintenanceApiFp: (configuration?: Configuration) => {
 };
 /**
  * MaintenanceApi - factory interface
+ * @export
  */
 export declare const MaintenanceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -75,6 +78,9 @@ export declare const MaintenanceApiFactory: (configuration?: Configuration, base
 };
 /**
  * MaintenanceApi - object-oriented interface
+ * @export
+ * @class MaintenanceApi
+ * @extends {BaseAPI}
  */
 export declare class MaintenanceApi extends BaseAPI {
     /**
@@ -82,6 +88,7 @@ export declare class MaintenanceApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof MaintenanceApi
      */
     apiV2MaintenancesOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -90,6 +97,7 @@ export declare class MaintenanceApi extends BaseAPI {
      * @param {*} [options] Override http request option.
      * @deprecated
      * @throws {RequiredError}
+     * @memberof MaintenanceApi
      */
     getCurrentMaintenances(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MaintenanceDtoPagedResponse, any>>;
 }

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

@@ -16,6 +16,7 @@ import type { NotificationDtoPagedResponse } from '../../@coscine/model';
 import type { NotificationDtoResponse } from '../../@coscine/model';
 /**
  * NotificationApi - axios parameter creator
+ * @export
  */
 export declare const NotificationApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -46,6 +47,7 @@ export declare const NotificationApiAxiosParamCreator: (configuration?: Configur
 };
 /**
  * NotificationApi - functional programming interface
+ * @export
  */
 export declare const NotificationApiFp: (configuration?: Configuration) => {
     /**
@@ -76,6 +78,7 @@ export declare const NotificationApiFp: (configuration?: Configuration) => {
 };
 /**
  * NotificationApi - factory interface
+ * @export
  */
 export declare const NotificationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -104,32 +107,47 @@ export declare const NotificationApiFactory: (configuration?: Configuration, bas
 };
 /**
  * Request parameters for getNotification operation in NotificationApi.
+ * @export
+ * @interface NotificationApiGetNotificationRequest
  */
 export interface NotificationApiGetNotificationRequest {
     /**
      * The ID of the notification.
+     * @type {string}
+     * @memberof NotificationApiGetNotification
      */
     readonly notificationId: string;
 }
 /**
  * Request parameters for getNotifications operation in NotificationApi.
+ * @export
+ * @interface NotificationApiGetNotificationsRequest
  */
 export interface NotificationApiGetNotificationsRequest {
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof NotificationApiGetNotifications
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof NotificationApiGetNotifications
      */
     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 NotificationApiGetNotifications
      */
     readonly orderBy?: string;
 }
 /**
  * NotificationApi - object-oriented interface
+ * @export
+ * @class NotificationApi
+ * @extends {BaseAPI}
  */
 export declare class NotificationApi extends BaseAPI {
     /**
@@ -137,6 +155,7 @@ export declare class NotificationApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof NotificationApi
      */
     apiV2NotificationsOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -145,6 +164,7 @@ export declare class NotificationApi extends BaseAPI {
      * @param {NotificationApiGetNotificationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof NotificationApi
      */
     getNotification(requestParameters: NotificationApiGetNotificationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NotificationDtoResponse, any>>;
     /**
@@ -153,6 +173,7 @@ export declare class NotificationApi extends BaseAPI {
      * @param {NotificationApiGetNotificationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof NotificationApi
      */
     getNotifications(requestParameters?: NotificationApiGetNotificationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<NotificationDtoPagedResponse, any>>;
 }

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

@@ -17,6 +17,7 @@ import type { OrganizationDtoPagedResponse } from '../../@coscine/model';
 import type { OrganizationDtoResponse } from '../../@coscine/model';
 /**
  * OrganizationApi - axios parameter creator
+ * @export
  */
 export declare const OrganizationApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -50,6 +51,7 @@ export declare const OrganizationApiAxiosParamCreator: (configuration?: Configur
 };
 /**
  * OrganizationApi - functional programming interface
+ * @export
  */
 export declare const OrganizationApiFp: (configuration?: Configuration) => {
     /**
@@ -83,6 +85,7 @@ export declare const OrganizationApiFp: (configuration?: Configuration) => {
 };
 /**
  * OrganizationApi - factory interface
+ * @export
  */
 export declare const OrganizationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -111,44 +114,65 @@ export declare const OrganizationApiFactory: (configuration?: Configuration, bas
 };
 /**
  * Request parameters for getOrganization operation in OrganizationApi.
+ * @export
+ * @interface OrganizationApiGetOrganizationRequest
  */
 export interface OrganizationApiGetOrganizationRequest {
     /**
      * The parameters for organization filtering and pagination.
+     * @type {string}
+     * @memberof OrganizationApiGetOrganization
      */
     readonly organizationRorUri: string;
 }
 /**
  * Request parameters for getOrganizations operation in OrganizationApi.
+ * @export
+ * @interface OrganizationApiGetOrganizationsRequest
  */
 export interface OrganizationApiGetOrganizationsRequest {
     /**
      * Gets or sets the search term used to filter organizations.
+     * @type {string}
+     * @memberof OrganizationApiGetOrganizations
      */
     readonly searchTerm?: string;
     /**
      * Language of name or text (dataPublicationService)
+     * @type {AcceptedLanguage}
+     * @memberof OrganizationApiGetOrganizations
      */
     readonly language?: AcceptedLanguage;
     /**
      * Gets or sets the option to find only organizations having the publication service set.
+     * @type {boolean}
+     * @memberof OrganizationApiGetOrganizations
      */
     readonly filterByPublicationService?: boolean;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof OrganizationApiGetOrganizations
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof OrganizationApiGetOrganizations
      */
     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 OrganizationApiGetOrganizations
      */
     readonly orderBy?: string;
 }
 /**
  * OrganizationApi - object-oriented interface
+ * @export
+ * @class OrganizationApi
+ * @extends {BaseAPI}
  */
 export declare class OrganizationApi extends BaseAPI {
     /**
@@ -156,6 +180,7 @@ export declare class OrganizationApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof OrganizationApi
      */
     apiV2OrganizationsOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -164,6 +189,7 @@ export declare class OrganizationApi extends BaseAPI {
      * @param {OrganizationApiGetOrganizationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof OrganizationApi
      */
     getOrganization(requestParameters: OrganizationApiGetOrganizationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationDtoResponse, any>>;
     /**
@@ -172,6 +198,7 @@ export declare class OrganizationApi extends BaseAPI {
      * @param {OrganizationApiGetOrganizationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof OrganizationApi
      */
     getOrganizations(requestParameters?: OrganizationApiGetOrganizationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrganizationDtoPagedResponse, any>>;
 }

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

@@ -17,6 +17,7 @@ import type { PidDtoResponse } from '../../@coscine/model';
 import type { PidRequestDto } from '../../@coscine/model';
 /**
  * PidApi - axios parameter creator
+ * @export
  */
 export declare const PidApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -61,6 +62,7 @@ export declare const PidApiAxiosParamCreator: (configuration?: Configuration) =>
 };
 /**
  * PidApi - functional programming interface
+ * @export
  */
 export declare const PidApiFp: (configuration?: Configuration) => {
     /**
@@ -105,6 +107,7 @@ export declare const PidApiFp: (configuration?: Configuration) => {
 };
 /**
  * PidApi - factory interface
+ * @export
  */
 export declare const PidApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -141,65 +144,96 @@ export declare const PidApiFactory: (configuration?: Configuration, basePath?: s
 };
 /**
  * Request parameters for getPid operation in PidApi.
+ * @export
+ * @interface PidApiGetPidRequest
  */
 export interface PidApiGetPidRequest {
     /**
      * The PID prefix. Limited to the values provided by the API.
+     * @type {string}
+     * @memberof PidApiGetPid
      */
     readonly prefix: string;
     /**
      * The PID suffix of a project or a resource, represented as a GUID.
+     * @type {string}
+     * @memberof PidApiGetPid
      */
     readonly suffix: string;
 }
 /**
  * Request parameters for getPids operation in PidApi.
+ * @export
+ * @interface PidApiGetPidsRequest
  */
 export interface PidApiGetPidsRequest {
     /**
      * Gets or sets a value indicating whether to include projects when retrieving pid information.
+     * @type {boolean}
+     * @memberof PidApiGetPids
      */
     readonly includeProjects?: boolean;
     /**
      * Gets or sets a value indicating whether to include resources when retrieving pid information.
+     * @type {boolean}
+     * @memberof PidApiGetPids
      */
     readonly includeResources?: boolean;
     /**
      * Gets or sets a value indicating whether to include deleted pid information.
+     * @type {boolean}
+     * @memberof PidApiGetPids
      */
     readonly includeDeleted?: boolean;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof PidApiGetPids
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof PidApiGetPids
      */
     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 PidApiGetPids
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for sendRequestToOwner operation in PidApi.
+ * @export
+ * @interface PidApiSendRequestToOwnerRequest
  */
 export interface PidApiSendRequestToOwnerRequest {
     /**
      * The PID prefix of a project or a resource to validate
+     * @type {string}
+     * @memberof PidApiSendRequestToOwner
      */
     readonly prefix: string;
     /**
      * The PID body of a project or a resource to validate
+     * @type {string}
+     * @memberof PidApiSendRequestToOwner
      */
     readonly suffix: string;
     /**
      * The data transfer object containing the inquiry details.
+     * @type {PidRequestDto}
+     * @memberof PidApiSendRequestToOwner
      */
     readonly pidRequestDto?: PidRequestDto;
 }
 /**
  * PidApi - object-oriented interface
+ * @export
+ * @class PidApi
+ * @extends {BaseAPI}
  */
 export declare class PidApi extends BaseAPI {
     /**
@@ -207,6 +241,7 @@ export declare class PidApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof PidApi
      */
     apiV2PidsOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -215,6 +250,7 @@ export declare class PidApi extends BaseAPI {
      * @param {PidApiGetPidRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof PidApi
      */
     getPid(requestParameters: PidApiGetPidRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PidDtoResponse, any>>;
     /**
@@ -223,6 +259,7 @@ export declare class PidApi extends BaseAPI {
      * @param {PidApiGetPidsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof PidApi
      */
     getPids(requestParameters?: PidApiGetPidsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PidDtoPagedResponse, any>>;
     /**
@@ -231,6 +268,7 @@ export declare class PidApi extends BaseAPI {
      * @param {PidApiSendRequestToOwnerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
+     * @memberof PidApi
      */
     sendRequestToOwner(requestParameters: PidApiSendRequestToOwnerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }