@coscine/api-client 3.18.0 → 3.20.0

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

@@ -17,7 +17,6 @@ import type { PidDtoResponse } from '../../@coscine/model';
 import type { PidRequestDto } from '../../@coscine/model';
 /**
  * PidApi - axios parameter creator
- * @export
  */
 export declare const PidApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -62,7 +61,6 @@ export declare const PidApiAxiosParamCreator: (configuration?: Configuration) =>
 };
 /**
  * PidApi - functional programming interface
- * @export
  */
 export declare const PidApiFp: (configuration?: Configuration) => {
     /**
@@ -107,7 +105,6 @@ export declare const PidApiFp: (configuration?: Configuration) => {
 };
 /**
  * PidApi - factory interface
- * @export
  */
 export declare const PidApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -144,96 +141,65 @@ 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 {
     /**
@@ -241,7 +207,6 @@ 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>>;
     /**
@@ -250,7 +215,6 @@ 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>>;
     /**
@@ -259,7 +223,6 @@ 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>>;
     /**
@@ -268,7 +231,6 @@ 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>>;
 }

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

@@ -18,7 +18,6 @@ import type { ProjectForCreationDto } from '../../@coscine/model';
 import type { ProjectForUpdateDto } from '../../@coscine/model';
 /**
  * ProjectApi - axios parameter creator
- * @export
  */
 export declare const ProjectApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -77,7 +76,6 @@ export declare const ProjectApiAxiosParamCreator: (configuration?: Configuration
 };
 /**
  * ProjectApi - functional programming interface
- * @export
  */
 export declare const ProjectApiFp: (configuration?: Configuration) => {
     /**
@@ -136,7 +134,6 @@ export declare const ProjectApiFp: (configuration?: Configuration) => {
 };
 /**
  * ProjectApi - factory interface
- * @export
  */
 export declare const ProjectApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -189,110 +186,75 @@ export declare const ProjectApiFactory: (configuration?: Configuration, basePath
 };
 /**
  * Request parameters for createProject operation in ProjectApi.
- * @export
- * @interface ProjectApiCreateProjectRequest
  */
 export interface ProjectApiCreateProjectRequest {
     /**
      * The project data for creation.
-     * @type {ProjectForCreationDto}
-     * @memberof ProjectApiCreateProject
      */
     readonly projectForCreationDto?: ProjectForCreationDto;
 }
 /**
  * Request parameters for deleteProject operation in ProjectApi.
- * @export
- * @interface ProjectApiDeleteProjectRequest
  */
 export interface ProjectApiDeleteProjectRequest {
     /**
      * The ID of the project.
-     * @type {string}
-     * @memberof ProjectApiDeleteProject
      */
     readonly projectId: string;
 }
 /**
  * Request parameters for getProject operation in ProjectApi.
- * @export
- * @interface ProjectApiGetProjectRequest
  */
 export interface ProjectApiGetProjectRequest {
     /**
      * The ID of the project.
-     * @type {string}
-     * @memberof ProjectApiGetProject
      */
     readonly projectId: string;
     /**
      * Gets or sets a value indicating whether to include sub-projects in the retrieval.
-     * @type {boolean}
-     * @memberof ProjectApiGetProject
      */
     readonly includeSubProjects?: boolean;
 }
 /**
  * Request parameters for getProjects operation in ProjectApi.
- * @export
- * @interface ProjectApiGetProjectsRequest
  */
 export interface ProjectApiGetProjectsRequest {
     /**
      * Gets or sets a value indicating whether to retrieve the organizations.
-     * @type {boolean}
-     * @memberof ProjectApiGetProjects
      */
     readonly includeOrganizations?: boolean;
     /**
      * Gets or sets a value indicating whether to retrieve only top-level projects.
-     * @type {boolean}
-     * @memberof ProjectApiGetProjects
      */
     readonly topLevel?: boolean;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
-     * @type {number}
-     * @memberof ProjectApiGetProjects
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
-     * @type {number}
-     * @memberof ProjectApiGetProjects
      */
     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 ProjectApiGetProjects
      */
     readonly orderBy?: string;
 }
 /**
  * Request parameters for updateProject operation in ProjectApi.
- * @export
- * @interface ProjectApiUpdateProjectRequest
  */
 export interface ProjectApiUpdateProjectRequest {
     /**
      * The ID of the project.
-     * @type {string}
-     * @memberof ProjectApiUpdateProject
      */
     readonly projectId: string;
     /**
      * The updated project data.
-     * @type {ProjectForUpdateDto}
-     * @memberof ProjectApiUpdateProject
      */
     readonly projectForUpdateDto?: ProjectForUpdateDto;
 }
 /**
  * ProjectApi - object-oriented interface
- * @export
- * @class ProjectApi
- * @extends {BaseAPI}
  */
 export declare class ProjectApi extends BaseAPI {
     /**
@@ -300,7 +262,6 @@ export declare class ProjectApi extends BaseAPI {
      * @summary Responds with the HTTP methods allowed for the endpoint.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectApi
      */
     apiV2ProjectsOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -309,7 +270,6 @@ export declare class ProjectApi extends BaseAPI {
      * @param {ProjectApiCreateProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectApi
      */
     createProject(requestParameters?: ProjectApiCreateProjectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectDtoResponse, any>>;
     /**
@@ -318,7 +278,6 @@ export declare class ProjectApi extends BaseAPI {
      * @param {ProjectApiDeleteProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectApi
      */
     deleteProject(requestParameters: ProjectApiDeleteProjectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -327,7 +286,6 @@ export declare class ProjectApi extends BaseAPI {
      * @param {ProjectApiGetProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectApi
      */
     getProject(requestParameters: ProjectApiGetProjectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectDtoResponse, any>>;
     /**
@@ -336,7 +294,6 @@ export declare class ProjectApi extends BaseAPI {
      * @param {ProjectApiGetProjectsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectApi
      */
     getProjects(requestParameters?: ProjectApiGetProjectsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectDtoPagedResponse, any>>;
     /**
@@ -345,7 +302,6 @@ export declare class ProjectApi extends BaseAPI {
      * @param {ProjectApiUpdateProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectApi
      */
     updateProject(requestParameters: ProjectApiUpdateProjectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }

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

@@ -17,7 +17,6 @@ import type { ProjectInvitationDtoResponse } from '../../@coscine/model';
 import type { ProjectInvitationForProjectManipulationDto } from '../../@coscine/model';
 /**
  * ProjectInvitationApi - axios parameter creator
- * @export
  */
 export declare const ProjectInvitationApiAxiosParamCreator: (configuration?: Configuration) => {
     /**
@@ -69,7 +68,6 @@ export declare const ProjectInvitationApiAxiosParamCreator: (configuration?: Con
 };
 /**
  * ProjectInvitationApi - functional programming interface
- * @export
  */
 export declare const ProjectInvitationApiFp: (configuration?: Configuration) => {
     /**
@@ -121,7 +119,6 @@ export declare const ProjectInvitationApiFp: (configuration?: Configuration) =>
 };
 /**
  * ProjectInvitationApi - factory interface
- * @export
  */
 export declare const ProjectInvitationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
     /**
@@ -167,110 +164,72 @@ export declare const ProjectInvitationApiFactory: (configuration?: Configuration
 };
 /**
  * Request parameters for apiV2ProjectsProjectIdInvitationsOptions operation in ProjectInvitationApi.
- * @export
- * @interface ProjectInvitationApiApiV2ProjectsProjectIdInvitationsOptionsRequest
  */
 export interface ProjectInvitationApiApiV2ProjectsProjectIdInvitationsOptionsRequest {
-    /**
-     *
-     * @type {string}
-     * @memberof ProjectInvitationApiApiV2ProjectsProjectIdInvitationsOptions
-     */
     readonly projectId: string;
 }
 /**
  * Request parameters for createProjectInvitation operation in ProjectInvitationApi.
- * @export
- * @interface ProjectInvitationApiCreateProjectInvitationRequest
  */
 export interface ProjectInvitationApiCreateProjectInvitationRequest {
     /**
      * The Id or slug of the project.
-     * @type {string}
-     * @memberof ProjectInvitationApiCreateProjectInvitation
      */
     readonly projectId: string;
     /**
      * The project invitation data for creation.
-     * @type {ProjectInvitationForProjectManipulationDto}
-     * @memberof ProjectInvitationApiCreateProjectInvitation
      */
     readonly projectInvitationForProjectManipulationDto?: ProjectInvitationForProjectManipulationDto;
 }
 /**
  * Request parameters for deleteProjectInvitation operation in ProjectInvitationApi.
- * @export
- * @interface ProjectInvitationApiDeleteProjectInvitationRequest
  */
 export interface ProjectInvitationApiDeleteProjectInvitationRequest {
     /**
      * The Id or slug of the project.
-     * @type {string}
-     * @memberof ProjectInvitationApiDeleteProjectInvitation
      */
     readonly projectId: string;
     /**
      * The ID of the project invitation to delete.
-     * @type {string}
-     * @memberof ProjectInvitationApiDeleteProjectInvitation
      */
     readonly projectInvitationId: string;
 }
 /**
  * Request parameters for getProjectInvitation operation in ProjectInvitationApi.
- * @export
- * @interface ProjectInvitationApiGetProjectInvitationRequest
  */
 export interface ProjectInvitationApiGetProjectInvitationRequest {
     /**
      * The Id or slug of the project.
-     * @type {string}
-     * @memberof ProjectInvitationApiGetProjectInvitation
      */
     readonly projectId: string;
     /**
      * The ID of the project invitation to retrieve.
-     * @type {string}
-     * @memberof ProjectInvitationApiGetProjectInvitation
      */
     readonly projectInvitationId: string;
 }
 /**
  * Request parameters for getProjectInvitations operation in ProjectInvitationApi.
- * @export
- * @interface ProjectInvitationApiGetProjectInvitationsRequest
  */
 export interface ProjectInvitationApiGetProjectInvitationsRequest {
     /**
      * The Id or slug of the project.
-     * @type {string}
-     * @memberof ProjectInvitationApiGetProjectInvitations
      */
     readonly projectId: string;
     /**
      * The desired page number. Should be greater than or equal to 1. Default is 1.
-     * @type {number}
-     * @memberof ProjectInvitationApiGetProjectInvitations
      */
     readonly pageNumber?: number;
     /**
      * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
-     * @type {number}
-     * @memberof ProjectInvitationApiGetProjectInvitations
      */
     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 ProjectInvitationApiGetProjectInvitations
      */
     readonly orderBy?: string;
 }
 /**
  * ProjectInvitationApi - object-oriented interface
- * @export
- * @class ProjectInvitationApi
- * @extends {BaseAPI}
  */
 export declare class ProjectInvitationApi extends BaseAPI {
     /**
@@ -279,7 +238,6 @@ export declare class ProjectInvitationApi extends BaseAPI {
      * @param {ProjectInvitationApiApiV2ProjectsProjectIdInvitationsOptionsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectInvitationApi
      */
     apiV2ProjectsProjectIdInvitationsOptions(requestParameters: ProjectInvitationApiApiV2ProjectsProjectIdInvitationsOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -288,7 +246,6 @@ export declare class ProjectInvitationApi extends BaseAPI {
      * @param {ProjectInvitationApiCreateProjectInvitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectInvitationApi
      */
     createProjectInvitation(requestParameters: ProjectInvitationApiCreateProjectInvitationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectInvitationDtoResponse, any>>;
     /**
@@ -297,7 +254,6 @@ export declare class ProjectInvitationApi extends BaseAPI {
      * @param {ProjectInvitationApiDeleteProjectInvitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectInvitationApi
      */
     deleteProjectInvitation(requestParameters: ProjectInvitationApiDeleteProjectInvitationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
@@ -306,7 +262,6 @@ export declare class ProjectInvitationApi extends BaseAPI {
      * @param {ProjectInvitationApiGetProjectInvitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectInvitationApi
      */
     getProjectInvitation(requestParameters: ProjectInvitationApiGetProjectInvitationRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectInvitationDtoResponse, any>>;
     /**
@@ -315,7 +270,6 @@ export declare class ProjectInvitationApi extends BaseAPI {
      * @param {ProjectInvitationApiGetProjectInvitationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
-     * @memberof ProjectInvitationApi
      */
     getProjectInvitations(requestParameters: ProjectInvitationApiGetProjectInvitationsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectInvitationDtoPagedResponse, any>>;
 }