@coscine/api-client 3.17.0 → 3.18.0

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

@@ -0,0 +1,165 @@
+/**
+ * Coscine Web API
+ * Coscine (short for <b>CO</b>llaborative <b>SC</b>ientific <b>IN</b>tegration <b>E</b>nvironment) is the research data management platform for your research project.
+ *
+ * The version of the OpenAPI document: 2.0
+ * Contact: servicedesk@rwth-aachen.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from '../../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../../base';
+import type { ProjectDtoPagedResponse } from '../../@coscine/model';
+/**
+ * ProjectSubProjectsApi - axios parameter creator
+ * @export
+ */
+export declare const ProjectSubProjectsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {string} projectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ProjectsProjectIdSubprojectsOptions: (projectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Retrieves all subprojects for a specified project.
+     * @param {string} projectId The Id or slug of the project.
+     * @param {boolean} [includeOrganizations] Gets or sets a value indicating whether to retrieve the organizations.
+     * @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 an 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}
+     */
+    getSubProjectsForProject: (projectId: string, includeOrganizations?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ProjectSubProjectsApi - functional programming interface
+ * @export
+ */
+export declare const ProjectSubProjectsApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {string} projectId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ProjectsProjectIdSubprojectsOptions(projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Retrieves all subprojects for a specified project.
+     * @param {string} projectId The Id or slug of the project.
+     * @param {boolean} [includeOrganizations] Gets or sets a value indicating whether to retrieve the organizations.
+     * @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 an 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}
+     */
+    getSubProjectsForProject(projectId: string, includeOrganizations?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectDtoPagedResponse>>;
+};
+/**
+ * ProjectSubProjectsApi - factory interface
+ * @export
+ */
+export declare const ProjectSubProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    apiV2ProjectsProjectIdSubprojectsOptions(requestParameters: ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Retrieves all subprojects for a specified project.
+     * @param {ProjectSubProjectsApiGetSubProjectsForProjectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getSubProjectsForProject(requestParameters: ProjectSubProjectsApiGetSubProjectsForProjectRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectDtoPagedResponse>;
+};
+/**
+ * Request parameters for apiV2ProjectsProjectIdSubprojectsOptions operation in ProjectSubProjectsApi.
+ * @export
+ * @interface ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest
+ */
+export interface ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptions
+     */
+    readonly projectId: string;
+}
+/**
+ * Request parameters for getSubProjectsForProject operation in ProjectSubProjectsApi.
+ * @export
+ * @interface ProjectSubProjectsApiGetSubProjectsForProjectRequest
+ */
+export interface ProjectSubProjectsApiGetSubProjectsForProjectRequest {
+    /**
+     * The Id or slug of the project.
+     * @type {string}
+     * @memberof ProjectSubProjectsApiGetSubProjectsForProject
+     */
+    readonly projectId: string;
+    /**
+     * Gets or sets a value indicating whether to retrieve the organizations.
+     * @type {boolean}
+     * @memberof ProjectSubProjectsApiGetSubProjectsForProject
+     */
+    readonly includeOrganizations?: boolean;
+    /**
+     * The desired page number. Should be greater than or equal to 1. Default is 1.
+     * @type {number}
+     * @memberof ProjectSubProjectsApiGetSubProjectsForProject
+     */
+    readonly pageNumber?: number;
+    /**
+     * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
+     * @type {number}
+     * @memberof ProjectSubProjectsApiGetSubProjectsForProject
+     */
+    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 \&quot;asc\&quot; or \&quot;desc\&quot; and separate properties by commas. Default is asc.
+     * @type {string}
+     * @memberof ProjectSubProjectsApiGetSubProjectsForProject
+     */
+    readonly orderBy?: string;
+}
+/**
+ * ProjectSubProjectsApi - object-oriented interface
+ * @export
+ * @class ProjectSubProjectsApi
+ * @extends {BaseAPI}
+ */
+export declare class ProjectSubProjectsApi extends BaseAPI {
+    /**
+     *
+     * @summary Responds with the HTTP methods allowed for the endpoint.
+     * @param {ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectSubProjectsApi
+     */
+    apiV2ProjectsProjectIdSubprojectsOptions(requestParameters: ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Retrieves all subprojects for a specified project.
+     * @param {ProjectSubProjectsApiGetSubProjectsForProjectRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ProjectSubProjectsApi
+     */
+    getSubProjectsForProject(requestParameters: ProjectSubProjectsApiGetSubProjectsForProjectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectDtoPagedResponse, any>>;
+}

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

@@ -125,6 +125,7 @@ export interface ProjectAdminDto {
      * Collection of sub-projects associated with this project.
      * @type {Array<ProjectDto>}
      * @memberof ProjectAdminDto
+     * @deprecated
      */
     'subProjects'?: Array<ProjectDto> | null;
     /**

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

@@ -120,6 +120,7 @@ export interface ProjectDto {
      * Collection of sub-projects associated with this project.
      * @type {Array<ProjectDto>}
      * @memberof ProjectDto
+     * @deprecated
      */
     'subProjects'?: Array<ProjectDto> | null;
     /**

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

@@ -28,6 +28,7 @@ export * from './@coscine/api/project-quota-api';
 export * from './@coscine/api/project-resource-api';
 export * from './@coscine/api/project-resource-quota-api';
 export * from './@coscine/api/project-resource-type-api';
+export * from './@coscine/api/project-sub-projects-api';
 export * from './@coscine/api/provenance-api';
 export * from './@coscine/api/resource-api';
 export * from './@coscine/api/resource-type-api';

package/dist/types/apis.d.ts

@@ -132,6 +132,10 @@ declare function implementations(axios?: AxiosInstance): {
         apiV2ProjectsProjectIdResourceTypesOptions(requestParameters: import("./Coscine.Api/api").ProjectResourceTypeApiApiV2ProjectsProjectIdResourceTypesOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
         getAvailableResourceTypesInformationForProject(requestParameters: import("./Coscine.Api/api").ProjectResourceTypeApiGetAvailableResourceTypesInformationForProjectRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceTypeInformationDtoIEnumerableResponse>;
     };
+    ProjectSubProjectsApi: {
+        apiV2ProjectsProjectIdSubprojectsOptions(requestParameters: import("./Coscine.Api/api").ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
+        getSubProjectsForProject(requestParameters: import("./Coscine.Api/api").ProjectSubProjectsApiGetSubProjectsForProjectRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectDtoPagedResponse>;
+    };
     ResourceApi: {
         apiV2ResourcesOptions(options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
         getResource(requestParameters: import("./Coscine.Api/api").ResourceApiGetResourceRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceDtoResponse>;

package/dist/types/index.d.ts

@@ -131,6 +131,10 @@ declare const apis: {
         apiV2ProjectsProjectIdResourceTypesOptions(requestParameters: import("./Coscine.Api").ProjectResourceTypeApiApiV2ProjectsProjectIdResourceTypesOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
         getAvailableResourceTypesInformationForProject(requestParameters: import("./Coscine.Api").ProjectResourceTypeApiGetAvailableResourceTypesInformationForProjectRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceTypeInformationDtoIEnumerableResponse>;
     };
+    ProjectSubProjectsApi: {
+        apiV2ProjectsProjectIdSubprojectsOptions(requestParameters: import("./Coscine.Api").ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
+        getSubProjectsForProject(requestParameters: import("./Coscine.Api").ProjectSubProjectsApiGetSubProjectsForProjectRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectDtoPagedResponse>;
+    };
     ResourceApi: {
         apiV2ResourcesOptions(options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
         getResource(requestParameters: import("./Coscine.Api").ResourceApiGetResourceRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceDtoResponse>;
@@ -362,6 +366,10 @@ export declare const ProjectResourceTypeApi: {
     apiV2ProjectsProjectIdResourceTypesOptions(requestParameters: import("./Coscine.Api").ProjectResourceTypeApiApiV2ProjectsProjectIdResourceTypesOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
     getAvailableResourceTypesInformationForProject(requestParameters: import("./Coscine.Api").ProjectResourceTypeApiGetAvailableResourceTypesInformationForProjectRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceTypeInformationDtoIEnumerableResponse>;
 };
+export declare const ProjectSubProjectsApi: {
+    apiV2ProjectsProjectIdSubprojectsOptions(requestParameters: import("./Coscine.Api").ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
+    getSubProjectsForProject(requestParameters: import("./Coscine.Api").ProjectSubProjectsApiGetSubProjectsForProjectRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectDtoPagedResponse>;
+};
 export declare const ResourceApi: {
     apiV2ResourcesOptions(options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
     getResource(requestParameters: import("./Coscine.Api").ResourceApiGetResourceRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ResourceDtoResponse>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@coscine/api-client",
   "type": "module",
-  "version": "3.17.0",
+  "version": "3.18.0",
   "description": "This project contains the generated api client classes.",
   "keywords": [
     "coscine",