@coscine/api-client 3.5.0 → 3.7.0

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

@@ -12,8 +12,9 @@
 import type { Configuration } from '../../configuration';
 import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
 import { RequestArgs, BaseAPI } from '../../base';
+import { PidDtoPagedResponse } from '../../@coscine/model';
+import { PidDtoResponse } from '../../@coscine/model';
 import { PidRequestDto } from '../../@coscine/model';
-import { PidValidationDtoResponse } from '../../@coscine/model';
 /**
  * PidApi - axios parameter creator
  * @export
@@ -27,24 +28,37 @@ export declare const PidApiAxiosParamCreator: (configuration?: Configuration) =>
      */
     apiV2PidsOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary Sends an inquiry to the owner of the given PID.
-     * @param {string} prefix The PID prefix of a project or a resource to validate
-     * @param {string} id The PID body of a project or a resource to validate
-     * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details.
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
+     * @summary Retrieves the Persistent Identifier (PID) for a given prefix and suffix.
+     * @param {string} prefix The PID prefix. Limited to the values provided by the API.
+     * @param {string} suffix The PID suffix of a project or a resource, represented as a GUID.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    sendRequestToOwner: (prefix: string, id: string, pidRequestDto?: PidRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getPid: (prefix: string, suffix: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
-     * @summary Validates the given PID.
+     * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
+     * @summary Retrieves all PIDs.
+     * @param {boolean} [includeProjects] Gets or sets a value indicating whether to include projects when retrieving pid information.
+     * @param {boolean} [includeResources] Gets or sets a value indicating whether to include resources when retrieving pid information.
+     * @param {boolean} [includeDeleted] Gets or sets a value indicating whether to include deleted pid information.
+     * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPids: (includeProjects?: boolean, includeResources?: boolean, includeDeleted?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
+     * @summary Sends an inquiry to the owner of the given PID.
      * @param {string} prefix The PID prefix of a project or a resource to validate
-     * @param {string} id The PID body of a project or a resource to validate
+     * @param {string} suffix The PID body of a project or a resource to validate
+     * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    validatePid: (prefix: string, id: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    sendRequestToOwner: (prefix: string, suffix: string, pidRequestDto?: PidRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
 };
 /**
  * PidApi - functional programming interface
@@ -59,24 +73,37 @@ export declare const PidApiFp: (configuration?: Configuration) => {
      */
     apiV2PidsOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
-     * @summary Sends an inquiry to the owner of the given PID.
-     * @param {string} prefix The PID prefix of a project or a resource to validate
-     * @param {string} id The PID body of a project or a resource to validate
-     * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details.
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
+     * @summary Retrieves the Persistent Identifier (PID) for a given prefix and suffix.
+     * @param {string} prefix The PID prefix. Limited to the values provided by the API.
+     * @param {string} suffix The PID suffix of a project or a resource, represented as a GUID.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    sendRequestToOwner(prefix: string, id: string, pidRequestDto?: PidRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    getPid(prefix: string, suffix: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PidDtoResponse>>;
     /**
-     *
-     * @summary Validates the given PID.
+     * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
+     * @summary Retrieves all PIDs.
+     * @param {boolean} [includeProjects] Gets or sets a value indicating whether to include projects when retrieving pid information.
+     * @param {boolean} [includeResources] Gets or sets a value indicating whether to include resources when retrieving pid information.
+     * @param {boolean} [includeDeleted] Gets or sets a value indicating whether to include deleted pid information.
+     * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @param {string} [orderBy] Gets or sets the field name used for ordering the results.  The order is constructed by a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getPids(includeProjects?: boolean, includeResources?: boolean, includeDeleted?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PidDtoPagedResponse>>;
+    /**
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
+     * @summary Sends an inquiry to the owner of the given PID.
      * @param {string} prefix The PID prefix of a project or a resource to validate
-     * @param {string} id The PID body of a project or a resource to validate
+     * @param {string} suffix The PID body of a project or a resource to validate
+     * @param {PidRequestDto} [pidRequestDto] The data transfer object containing the inquiry details.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    validatePid(prefix: string, id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PidValidationDtoResponse>>;
+    sendRequestToOwner(prefix: string, suffix: string, pidRequestDto?: PidRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
 };
 /**
  * PidApi - factory interface
@@ -91,65 +118,116 @@ export declare const PidApiFactory: (configuration?: Configuration, basePath?: s
      */
     apiV2PidsOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
-     * @summary Sends an inquiry to the owner of the given PID.
-     * @param {PidApiSendRequestToOwnerRequest} requestParameters Request parameters.
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
+     * @summary Retrieves the Persistent Identifier (PID) for a given prefix and suffix.
+     * @param {PidApiGetPidRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    sendRequestToOwner(requestParameters: PidApiSendRequestToOwnerRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    getPid(requestParameters: PidApiGetPidRequest, options?: AxiosRequestConfig): AxiosPromise<PidDtoResponse>;
     /**
-     *
-     * @summary Validates the given PID.
-     * @param {PidApiValidatePidRequest} requestParameters Request parameters.
+     * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
+     * @summary Retrieves all PIDs.
+     * @param {PidApiGetPidsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    validatePid(requestParameters: PidApiValidatePidRequest, options?: AxiosRequestConfig): AxiosPromise<PidValidationDtoResponse>;
+    getPids(requestParameters?: PidApiGetPidsRequest, options?: AxiosRequestConfig): AxiosPromise<PidDtoPagedResponse>;
+    /**
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
+     * @summary Sends an inquiry to the owner of the given PID.
+     * @param {PidApiSendRequestToOwnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    sendRequestToOwner(requestParameters: PidApiSendRequestToOwnerRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
 };
 /**
- * Request parameters for sendRequestToOwner operation in PidApi.
+ * Request parameters for getPid operation in PidApi.
  * @export
- * @interface PidApiSendRequestToOwnerRequest
+ * @interface PidApiGetPidRequest
  */
-export interface PidApiSendRequestToOwnerRequest {
+export interface PidApiGetPidRequest {
     /**
-     * The PID prefix of a project or a resource to validate
+     * The PID prefix. Limited to the values provided by the API.
      * @type {string}
-     * @memberof PidApiSendRequestToOwner
+     * @memberof PidApiGetPid
      */
     readonly prefix: string;
     /**
-     * The PID body of a project or a resource to validate
+     * The PID suffix of a project or a resource, represented as a GUID.
      * @type {string}
-     * @memberof PidApiSendRequestToOwner
+     * @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 id: string;
+    readonly includeProjects?: boolean;
     /**
-     * The data transfer object containing the inquiry details.
-     * @type {PidRequestDto}
-     * @memberof PidApiSendRequestToOwner
+     * Gets or sets a value indicating whether to include resources when retrieving pid information.
+     * @type {boolean}
+     * @memberof PidApiGetPids
      */
-    readonly pidRequestDto?: PidRequestDto;
+    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 a order string.  Use the property followed by \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof PidApiGetPids
+     */
+    readonly orderBy?: string;
 }
 /**
- * Request parameters for validatePid operation in PidApi.
+ * Request parameters for sendRequestToOwner operation in PidApi.
  * @export
- * @interface PidApiValidatePidRequest
+ * @interface PidApiSendRequestToOwnerRequest
  */
-export interface PidApiValidatePidRequest {
+export interface PidApiSendRequestToOwnerRequest {
     /**
      * The PID prefix of a project or a resource to validate
      * @type {string}
-     * @memberof PidApiValidatePid
+     * @memberof PidApiSendRequestToOwner
      */
     readonly prefix: string;
     /**
      * The PID body of a project or a resource to validate
      * @type {string}
-     * @memberof PidApiValidatePid
+     * @memberof PidApiSendRequestToOwner
      */
-    readonly id: string;
+    readonly suffix: string;
+    /**
+     * The data transfer object containing the inquiry details.
+     * @type {PidRequestDto}
+     * @memberof PidApiSendRequestToOwner
+     */
+    readonly pidRequestDto?: PidRequestDto;
 }
 /**
  * PidApi - object-oriented interface
@@ -167,21 +245,30 @@ export declare class PidApi extends BaseAPI {
      */
     apiV2PidsOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     *
-     * @summary Sends an inquiry to the owner of the given PID.
-     * @param {PidApiSendRequestToOwnerRequest} requestParameters Request parameters.
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
+     * @summary Retrieves the Persistent Identifier (PID) for a given prefix and suffix.
+     * @param {PidApiGetPidRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PidApi
      */
-    sendRequestToOwner(requestParameters: PidApiSendRequestToOwnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    getPid(requestParameters: PidApiGetPidRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PidDtoResponse, any>>;
     /**
-     *
-     * @summary Validates the given PID.
-     * @param {PidApiValidatePidRequest} requestParameters Request parameters.
+     * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
+     * @summary Retrieves all PIDs.
+     * @param {PidApiGetPidsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof PidApi
+     */
+    getPids(requestParameters?: PidApiGetPidsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PidDtoPagedResponse, any>>;
+    /**
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
+     * @summary Sends an inquiry to the owner of the given PID.
+     * @param {PidApiSendRequestToOwnerRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof PidApi
      */
-    validatePid(requestParameters: PidApiValidatePidRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PidValidationDtoResponse, any>>;
+    sendRequestToOwner(requestParameters: PidApiSendRequestToOwnerRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
 }

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

@@ -29,7 +29,7 @@ export declare const ProjectApiAxiosParamCreator: (configuration?: Configuration
      */
     apiV2ProjectsOptions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Creates a new project.
      * @param {ProjectForCreationDto} [projectForCreationDto] The project data for creation.
      * @param {*} [options] Override http request option.
@@ -37,7 +37,7 @@ export declare const ProjectApiAxiosParamCreator: (configuration?: Configuration
      */
     createProject: (projectForCreationDto?: ProjectForCreationDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Deletes a project.
      * @param {string} projectId The ID of the project.
      * @param {*} [options] Override http request option.
@@ -45,7 +45,7 @@ export declare const ProjectApiAxiosParamCreator: (configuration?: Configuration
      */
     deleteProject: (projectId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves a project.
      * @param {string} projectId The ID of the project.
      * @param {boolean} [includeSubProjects] Gets or sets a value indicating whether to include sub-projects in the retrieval.
@@ -54,8 +54,9 @@ export declare const ProjectApiAxiosParamCreator: (configuration?: Configuration
      */
     getProject: (projectId: string, includeSubProjects?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves all projects.
+     * @param {boolean} [includeOrganizations] Gets or sets a value indicating whether to retrieve the organizations.
      * @param {boolean} [topLevel] Gets or sets a value indicating whether to retrieve only top-level projects.
      * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
      * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
@@ -63,9 +64,9 @@ export declare const ProjectApiAxiosParamCreator: (configuration?: Configuration
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getProjects: (topLevel?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    getProjects: (includeOrganizations?: boolean, topLevel?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Updates a project.
      * @param {string} projectId The ID of the project.
      * @param {ProjectForUpdateDto} [projectForUpdateDto] The updated project data.
@@ -87,7 +88,7 @@ export declare const ProjectApiFp: (configuration?: Configuration) => {
      */
     apiV2ProjectsOptions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Creates a new project.
      * @param {ProjectForCreationDto} [projectForCreationDto] The project data for creation.
      * @param {*} [options] Override http request option.
@@ -95,7 +96,7 @@ export declare const ProjectApiFp: (configuration?: Configuration) => {
      */
     createProject(projectForCreationDto?: ProjectForCreationDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectDtoResponse>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Deletes a project.
      * @param {string} projectId The ID of the project.
      * @param {*} [options] Override http request option.
@@ -103,7 +104,7 @@ export declare const ProjectApiFp: (configuration?: Configuration) => {
      */
     deleteProject(projectId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves a project.
      * @param {string} projectId The ID of the project.
      * @param {boolean} [includeSubProjects] Gets or sets a value indicating whether to include sub-projects in the retrieval.
@@ -112,8 +113,9 @@ export declare const ProjectApiFp: (configuration?: Configuration) => {
      */
     getProject(projectId: string, includeSubProjects?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectDtoResponse>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves all projects.
+     * @param {boolean} [includeOrganizations] Gets or sets a value indicating whether to retrieve the organizations.
      * @param {boolean} [topLevel] Gets or sets a value indicating whether to retrieve only top-level projects.
      * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
      * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
@@ -121,9 +123,9 @@ export declare const ProjectApiFp: (configuration?: Configuration) => {
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
-    getProjects(topLevel?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectDtoPagedResponse>>;
+    getProjects(includeOrganizations?: boolean, topLevel?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectDtoPagedResponse>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Updates a project.
      * @param {string} projectId The ID of the project.
      * @param {ProjectForUpdateDto} [projectForUpdateDto] The updated project data.
@@ -145,7 +147,7 @@ export declare const ProjectApiFactory: (configuration?: Configuration, basePath
      */
     apiV2ProjectsOptions(options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Creates a new project.
      * @param {ProjectApiCreateProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -153,7 +155,7 @@ export declare const ProjectApiFactory: (configuration?: Configuration, basePath
      */
     createProject(requestParameters?: ProjectApiCreateProjectRequest, options?: AxiosRequestConfig): AxiosPromise<ProjectDtoResponse>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Deletes a project.
      * @param {ProjectApiDeleteProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -161,7 +163,7 @@ export declare const ProjectApiFactory: (configuration?: Configuration, basePath
      */
     deleteProject(requestParameters: ProjectApiDeleteProjectRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves a project.
      * @param {ProjectApiGetProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -169,7 +171,7 @@ export declare const ProjectApiFactory: (configuration?: Configuration, basePath
      */
     getProject(requestParameters: ProjectApiGetProjectRequest, options?: AxiosRequestConfig): AxiosPromise<ProjectDtoResponse>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves all projects.
      * @param {ProjectApiGetProjectsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -177,7 +179,7 @@ export declare const ProjectApiFactory: (configuration?: Configuration, basePath
      */
     getProjects(requestParameters?: ProjectApiGetProjectsRequest, options?: AxiosRequestConfig): AxiosPromise<ProjectDtoPagedResponse>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Updates a project.
      * @param {ProjectApiUpdateProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -236,6 +238,12 @@ export interface ProjectApiGetProjectRequest {
  * @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}
@@ -296,7 +304,7 @@ export declare class ProjectApi extends BaseAPI {
      */
     apiV2ProjectsOptions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Creates a new project.
      * @param {ProjectApiCreateProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -305,7 +313,7 @@ export declare class ProjectApi extends BaseAPI {
      */
     createProject(requestParameters?: ProjectApiCreateProjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectDtoResponse, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Deletes a project.
      * @param {ProjectApiDeleteProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -314,7 +322,7 @@ export declare class ProjectApi extends BaseAPI {
      */
     deleteProject(requestParameters: ProjectApiDeleteProjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves a project.
      * @param {ProjectApiGetProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -323,7 +331,7 @@ export declare class ProjectApi extends BaseAPI {
      */
     getProject(requestParameters: ProjectApiGetProjectRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectDtoResponse, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves all projects.
      * @param {ProjectApiGetProjectsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -332,7 +340,7 @@ export declare class ProjectApi extends BaseAPI {
      */
     getProjects(requestParameters?: ProjectApiGetProjectsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectDtoPagedResponse, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Updates a project.
      * @param {ProjectApiUpdateProjectRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.

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

@@ -29,7 +29,7 @@ export declare const ProjectInvitationApiAxiosParamCreator: (configuration?: Con
      */
     apiV2ProjectsProjectIdInvitationsOptions: (projectId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Creates a project invitation for a specified project.
      * @param {string} projectId The Id or slug of the project.
      * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] The project invitation data for creation.
@@ -38,7 +38,7 @@ export declare const ProjectInvitationApiAxiosParamCreator: (configuration?: Con
      */
     createProjectInvitation: (projectId: string, projectInvitationForProjectManipulationDto?: ProjectInvitationForProjectManipulationDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Deletes a project invitation for a specified project.
      * @param {string} projectId The Id or slug of the project.
      * @param {string} projectInvitationId The ID of the project invitation to delete.
@@ -47,7 +47,7 @@ export declare const ProjectInvitationApiAxiosParamCreator: (configuration?: Con
      */
     deleteProjectInvitation: (projectId: string, projectInvitationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves a project invitation for a specified project.
      * @param {string} projectId The Id or slug of the project.
      * @param {string} projectInvitationId The ID of the project invitation to retrieve.
@@ -56,7 +56,7 @@ export declare const ProjectInvitationApiAxiosParamCreator: (configuration?: Con
      */
     getProjectInvitation: (projectId: string, projectInvitationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves all project invitations for a specified project.
      * @param {string} projectId The Id or slug of the project.
      * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
@@ -81,7 +81,7 @@ export declare const ProjectInvitationApiFp: (configuration?: Configuration) =>
      */
     apiV2ProjectsProjectIdInvitationsOptions(projectId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Creates a project invitation for a specified project.
      * @param {string} projectId The Id or slug of the project.
      * @param {ProjectInvitationForProjectManipulationDto} [projectInvitationForProjectManipulationDto] The project invitation data for creation.
@@ -90,7 +90,7 @@ export declare const ProjectInvitationApiFp: (configuration?: Configuration) =>
      */
     createProjectInvitation(projectId: string, projectInvitationForProjectManipulationDto?: ProjectInvitationForProjectManipulationDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectInvitationDtoResponse>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Deletes a project invitation for a specified project.
      * @param {string} projectId The Id or slug of the project.
      * @param {string} projectInvitationId The ID of the project invitation to delete.
@@ -99,7 +99,7 @@ export declare const ProjectInvitationApiFp: (configuration?: Configuration) =>
      */
     deleteProjectInvitation(projectId: string, projectInvitationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves a project invitation for a specified project.
      * @param {string} projectId The Id or slug of the project.
      * @param {string} projectInvitationId The ID of the project invitation to retrieve.
@@ -108,7 +108,7 @@ export declare const ProjectInvitationApiFp: (configuration?: Configuration) =>
      */
     getProjectInvitation(projectId: string, projectInvitationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectInvitationDtoResponse>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves all project invitations for a specified project.
      * @param {string} projectId The Id or slug of the project.
      * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
@@ -133,7 +133,7 @@ export declare const ProjectInvitationApiFactory: (configuration?: Configuration
      */
     apiV2ProjectsProjectIdInvitationsOptions(requestParameters: ProjectInvitationApiApiV2ProjectsProjectIdInvitationsOptionsRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Creates a project invitation for a specified project.
      * @param {ProjectInvitationApiCreateProjectInvitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -141,7 +141,7 @@ export declare const ProjectInvitationApiFactory: (configuration?: Configuration
      */
     createProjectInvitation(requestParameters: ProjectInvitationApiCreateProjectInvitationRequest, options?: AxiosRequestConfig): AxiosPromise<ProjectInvitationDtoResponse>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Deletes a project invitation for a specified project.
      * @param {ProjectInvitationApiDeleteProjectInvitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -149,7 +149,7 @@ export declare const ProjectInvitationApiFactory: (configuration?: Configuration
      */
     deleteProjectInvitation(requestParameters: ProjectInvitationApiDeleteProjectInvitationRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves a project invitation for a specified project.
      * @param {ProjectInvitationApiGetProjectInvitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -157,7 +157,7 @@ export declare const ProjectInvitationApiFactory: (configuration?: Configuration
      */
     getProjectInvitation(requestParameters: ProjectInvitationApiGetProjectInvitationRequest, options?: AxiosRequestConfig): AxiosPromise<ProjectInvitationDtoResponse>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves all project invitations for a specified project.
      * @param {ProjectInvitationApiGetProjectInvitationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -283,7 +283,7 @@ export declare class ProjectInvitationApi extends BaseAPI {
      */
     apiV2ProjectsProjectIdInvitationsOptions(requestParameters: ProjectInvitationApiApiV2ProjectsProjectIdInvitationsOptionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Creates a project invitation for a specified project.
      * @param {ProjectInvitationApiCreateProjectInvitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -292,7 +292,7 @@ export declare class ProjectInvitationApi extends BaseAPI {
      */
     createProjectInvitation(requestParameters: ProjectInvitationApiCreateProjectInvitationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectInvitationDtoResponse, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Deletes a project invitation for a specified project.
      * @param {ProjectInvitationApiDeleteProjectInvitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -301,7 +301,7 @@ export declare class ProjectInvitationApi extends BaseAPI {
      */
     deleteProjectInvitation(requestParameters: ProjectInvitationApiDeleteProjectInvitationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves a project invitation for a specified project.
      * @param {ProjectInvitationApiGetProjectInvitationRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -310,7 +310,7 @@ export declare class ProjectInvitationApi extends BaseAPI {
      */
     getProjectInvitation(requestParameters: ProjectInvitationApiGetProjectInvitationRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectInvitationDtoResponse, any>>;
     /**
-     *
+     * <p><strong>Required JWT roles for access:</strong> <code></code>.</p>
      * @summary Retrieves all project invitations for a specified project.
      * @param {ProjectInvitationApiGetProjectInvitationsRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.