@coscine/api-client 3.17.0 → 3.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. package/dist/index.js +779 -676
  2. package/dist/types/Coscine.Api/@coscine/api/admin-api.d.ts +2 -11
  3. package/dist/types/Coscine.Api/@coscine/api/data-hamster-report-api.d.ts +263 -0
  4. package/dist/types/Coscine.Api/@coscine/api/project-sub-projects-api.d.ts +165 -0
  5. package/dist/types/Coscine.Api/@coscine/api/report-api.d.ts +272 -0
  6. package/dist/types/Coscine.Api/@coscine/model/data-hamster-kpi-dto-ienumerable-response.d.ts +43 -0
  7. package/dist/types/Coscine.Api/@coscine/model/data-hamster-kpi-dto-response.d.ts +43 -0
  8. package/dist/types/Coscine.Api/@coscine/model/data-hamster-kpi-dto.d.ts +56 -0
  9. package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-s3-resource-type-options-for-manipulation-dto.d.ts +7 -0
  10. package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-s3-worm-resource-type-options-for-manipulation-dto.d.ts +7 -0
  11. package/dist/types/Coscine.Api/@coscine/model/data-storage-nrw-web-resource-type-options-for-manipulation-dto.d.ts +7 -0
  12. package/dist/types/Coscine.Api/@coscine/model/index.d.ts +6 -0
  13. package/dist/types/Coscine.Api/@coscine/model/lifecycle-options-for-manipulation-dto.d.ts +30 -0
  14. package/dist/types/Coscine.Api/@coscine/model/project-admin-dto.d.ts +1 -0
  15. package/dist/types/Coscine.Api/@coscine/model/project-dto.d.ts +1 -0
  16. package/dist/types/Coscine.Api/@coscine/model/public-user-dto.d.ts +8 -8
  17. package/dist/types/Coscine.Api/@coscine/model/storage-data-hamster-kpi-dto-response.d.ts +43 -0
  18. package/dist/types/Coscine.Api/@coscine/model/storage-data-hamster-kpi-dto.d.ts +31 -0
  19. package/dist/types/Coscine.Api/@coscine/model/user-organization-dto.d.ts +6 -0
  20. package/dist/types/Coscine.Api/api.d.ts +3 -0
  21. package/dist/types/apis.d.ts +4 -0
  22. package/dist/types/index.d.ts +8 -0
  23. package/package.json +1 -1
@@ -16,7 +16,6 @@ import type { ActivityLogDtoPagedResponse } from '../../@coscine/model';
16
16
  import type { CoscineHttpMethod } from '../../@coscine/model';
17
17
  import type { CreateDatasourceDtoResponse } from '../../@coscine/model';
18
18
  import type { DeployedGraphDtoPagedResponse } from '../../@coscine/model';
19
- import type { DsNrwReplicationGroupDto } from '../../@coscine/model';
20
19
  import type { MetadataUpdateAdminParameters } from '../../@coscine/model';
21
20
  import type { ProjectAdminDtoPagedResponse } from '../../@coscine/model';
22
21
  import type { RdfDefinitionDtoResponse } from '../../@coscine/model';
@@ -42,11 +41,10 @@ export declare const AdminApiAxiosParamCreator: (configuration?: Configuration)
42
41
  * @param {string} resourceId The unique identifier of the resource.
43
42
  * @param {string} typeId The unique identifier of the datasource type.
44
43
  * @param {number} [quota] The allocated quota for the datasource.
45
- * @param {DsNrwReplicationGroupDto} [replicationGroup] The replication group for the bucket.
46
44
  * @param {*} [options] Override http request option.
47
45
  * @throws {RequiredError}
48
46
  */
49
- createDatasource: (resourceId: string, typeId: string, quota?: number, replicationGroup?: DsNrwReplicationGroupDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
47
+ createDatasource: (resourceId: string, typeId: string, quota?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50
48
  /**
51
49
  * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
52
50
  * @summary Retrieves all activity logs.
@@ -166,11 +164,10 @@ export declare const AdminApiFp: (configuration?: Configuration) => {
166
164
  * @param {string} resourceId The unique identifier of the resource.
167
165
  * @param {string} typeId The unique identifier of the datasource type.
168
166
  * @param {number} [quota] The allocated quota for the datasource.
169
- * @param {DsNrwReplicationGroupDto} [replicationGroup] The replication group for the bucket.
170
167
  * @param {*} [options] Override http request option.
171
168
  * @throws {RequiredError}
172
169
  */
173
- createDatasource(resourceId: string, typeId: string, quota?: number, replicationGroup?: DsNrwReplicationGroupDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDatasourceDtoResponse>>;
170
+ createDatasource(resourceId: string, typeId: string, quota?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDatasourceDtoResponse>>;
174
171
  /**
175
172
  * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
176
173
  * @summary Retrieves all activity logs.
@@ -389,12 +386,6 @@ export interface AdminApiCreateDatasourceRequest {
389
386
  * @memberof AdminApiCreateDatasource
390
387
  */
391
388
  readonly quota?: number;
392
- /**
393
- * The replication group for the bucket.
394
- * @type {DsNrwReplicationGroupDto}
395
- * @memberof AdminApiCreateDatasource
396
- */
397
- readonly replicationGroup?: DsNrwReplicationGroupDto;
398
389
  }
399
390
  /**
400
391
  * Request parameters for getAllActivityLogs operation in AdminApi.
@@ -0,0 +1,263 @@
1
+ /**
2
+ * Coscine Web API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2.0
6
+ * Contact: servicedesk@rwth-aachen.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../../base';
15
+ import type { DataHamsterKpiDtoIEnumerableResponse } from '../../@coscine/model';
16
+ import type { DataHamsterKpiDtoResponse } from '../../@coscine/model';
17
+ import type { StorageDataHamsterKpiDtoResponse } from '../../@coscine/model';
18
+ /**
19
+ * DataHamsterReportApi - axios parameter creator
20
+ * @export
21
+ */
22
+ export declare const DataHamsterReportApiAxiosParamCreator: (configuration?: Configuration) => {
23
+ /**
24
+ *
25
+ * @summary Responds with the HTTP methods allowed for the endpoint.
26
+ * @param {*} [options] Override http request option.
27
+ * @throws {RequiredError}
28
+ */
29
+ apiV2ReportsDataHamsterOptions: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
30
+ /**
31
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
32
+ * @summary Get the number of archived resources KPI report.
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ getNumberOfArchivedResourcesKpi: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
39
+ * @summary Get the number of created projects KPI report.
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ getNumberOfCreatedProjectsKpi: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
44
+ /**
45
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
46
+ * @summary Get the number of created resources KPI report.
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ getNumberOfCreatedResourcesKpi: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
51
+ /**
52
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
53
+ * @summary Get the number of users per day KPI report.
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ */
57
+ getNumberOfUsersPerDayKpi: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58
+ /**
59
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
60
+ * @summary Get the storage usage per resource type report.
61
+ * @param {string} typeId The id of the resource type.
62
+ * @param {*} [options] Override http request option.
63
+ * @throws {RequiredError}
64
+ */
65
+ getStorageByResourceTypeKpi: (typeId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
66
+ /**
67
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
68
+ * @summary Get the number of users per ror report.
69
+ * @param {*} [options] Override http request option.
70
+ * @throws {RequiredError}
71
+ */
72
+ getUsersPerRorKpi: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
73
+ };
74
+ /**
75
+ * DataHamsterReportApi - functional programming interface
76
+ * @export
77
+ */
78
+ export declare const DataHamsterReportApiFp: (configuration?: Configuration) => {
79
+ /**
80
+ *
81
+ * @summary Responds with the HTTP methods allowed for the endpoint.
82
+ * @param {*} [options] Override http request option.
83
+ * @throws {RequiredError}
84
+ */
85
+ apiV2ReportsDataHamsterOptions(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
86
+ /**
87
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
88
+ * @summary Get the number of archived resources KPI report.
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ getNumberOfArchivedResourcesKpi(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataHamsterKpiDtoResponse>>;
93
+ /**
94
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
95
+ * @summary Get the number of created projects KPI report.
96
+ * @param {*} [options] Override http request option.
97
+ * @throws {RequiredError}
98
+ */
99
+ getNumberOfCreatedProjectsKpi(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataHamsterKpiDtoResponse>>;
100
+ /**
101
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
102
+ * @summary Get the number of created resources KPI report.
103
+ * @param {*} [options] Override http request option.
104
+ * @throws {RequiredError}
105
+ */
106
+ getNumberOfCreatedResourcesKpi(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataHamsterKpiDtoResponse>>;
107
+ /**
108
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
109
+ * @summary Get the number of users per day KPI report.
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ getNumberOfUsersPerDayKpi(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataHamsterKpiDtoResponse>>;
114
+ /**
115
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
116
+ * @summary Get the storage usage per resource type report.
117
+ * @param {string} typeId The id of the resource type.
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ getStorageByResourceTypeKpi(typeId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StorageDataHamsterKpiDtoResponse>>;
122
+ /**
123
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
124
+ * @summary Get the number of users per ror report.
125
+ * @param {*} [options] Override http request option.
126
+ * @throws {RequiredError}
127
+ */
128
+ getUsersPerRorKpi(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DataHamsterKpiDtoIEnumerableResponse>>;
129
+ };
130
+ /**
131
+ * DataHamsterReportApi - factory interface
132
+ * @export
133
+ */
134
+ export declare const DataHamsterReportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
135
+ /**
136
+ *
137
+ * @summary Responds with the HTTP methods allowed for the endpoint.
138
+ * @param {*} [options] Override http request option.
139
+ * @throws {RequiredError}
140
+ */
141
+ apiV2ReportsDataHamsterOptions(options?: RawAxiosRequestConfig): AxiosPromise<void>;
142
+ /**
143
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
144
+ * @summary Get the number of archived resources KPI report.
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ getNumberOfArchivedResourcesKpi(options?: RawAxiosRequestConfig): AxiosPromise<DataHamsterKpiDtoResponse>;
149
+ /**
150
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
151
+ * @summary Get the number of created projects KPI report.
152
+ * @param {*} [options] Override http request option.
153
+ * @throws {RequiredError}
154
+ */
155
+ getNumberOfCreatedProjectsKpi(options?: RawAxiosRequestConfig): AxiosPromise<DataHamsterKpiDtoResponse>;
156
+ /**
157
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
158
+ * @summary Get the number of created resources KPI report.
159
+ * @param {*} [options] Override http request option.
160
+ * @throws {RequiredError}
161
+ */
162
+ getNumberOfCreatedResourcesKpi(options?: RawAxiosRequestConfig): AxiosPromise<DataHamsterKpiDtoResponse>;
163
+ /**
164
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
165
+ * @summary Get the number of users per day KPI report.
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ getNumberOfUsersPerDayKpi(options?: RawAxiosRequestConfig): AxiosPromise<DataHamsterKpiDtoResponse>;
170
+ /**
171
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
172
+ * @summary Get the storage usage per resource type report.
173
+ * @param {DataHamsterReportApiGetStorageByResourceTypeKpiRequest} requestParameters Request parameters.
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ */
177
+ getStorageByResourceTypeKpi(requestParameters: DataHamsterReportApiGetStorageByResourceTypeKpiRequest, options?: RawAxiosRequestConfig): AxiosPromise<StorageDataHamsterKpiDtoResponse>;
178
+ /**
179
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
180
+ * @summary Get the number of users per ror report.
181
+ * @param {*} [options] Override http request option.
182
+ * @throws {RequiredError}
183
+ */
184
+ getUsersPerRorKpi(options?: RawAxiosRequestConfig): AxiosPromise<DataHamsterKpiDtoIEnumerableResponse>;
185
+ };
186
+ /**
187
+ * Request parameters for getStorageByResourceTypeKpi operation in DataHamsterReportApi.
188
+ * @export
189
+ * @interface DataHamsterReportApiGetStorageByResourceTypeKpiRequest
190
+ */
191
+ export interface DataHamsterReportApiGetStorageByResourceTypeKpiRequest {
192
+ /**
193
+ * The id of the resource type.
194
+ * @type {string}
195
+ * @memberof DataHamsterReportApiGetStorageByResourceTypeKpi
196
+ */
197
+ readonly typeId: string;
198
+ }
199
+ /**
200
+ * DataHamsterReportApi - object-oriented interface
201
+ * @export
202
+ * @class DataHamsterReportApi
203
+ * @extends {BaseAPI}
204
+ */
205
+ export declare class DataHamsterReportApi extends BaseAPI {
206
+ /**
207
+ *
208
+ * @summary Responds with the HTTP methods allowed for the endpoint.
209
+ * @param {*} [options] Override http request option.
210
+ * @throws {RequiredError}
211
+ * @memberof DataHamsterReportApi
212
+ */
213
+ apiV2ReportsDataHamsterOptions(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
214
+ /**
215
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
216
+ * @summary Get the number of archived resources KPI report.
217
+ * @param {*} [options] Override http request option.
218
+ * @throws {RequiredError}
219
+ * @memberof DataHamsterReportApi
220
+ */
221
+ getNumberOfArchivedResourcesKpi(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataHamsterKpiDtoResponse, any>>;
222
+ /**
223
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
224
+ * @summary Get the number of created projects KPI report.
225
+ * @param {*} [options] Override http request option.
226
+ * @throws {RequiredError}
227
+ * @memberof DataHamsterReportApi
228
+ */
229
+ getNumberOfCreatedProjectsKpi(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataHamsterKpiDtoResponse, any>>;
230
+ /**
231
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
232
+ * @summary Get the number of created resources KPI report.
233
+ * @param {*} [options] Override http request option.
234
+ * @throws {RequiredError}
235
+ * @memberof DataHamsterReportApi
236
+ */
237
+ getNumberOfCreatedResourcesKpi(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataHamsterKpiDtoResponse, any>>;
238
+ /**
239
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
240
+ * @summary Get the number of users per day KPI report.
241
+ * @param {*} [options] Override http request option.
242
+ * @throws {RequiredError}
243
+ * @memberof DataHamsterReportApi
244
+ */
245
+ getNumberOfUsersPerDayKpi(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataHamsterKpiDtoResponse, any>>;
246
+ /**
247
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
248
+ * @summary Get the storage usage per resource type report.
249
+ * @param {DataHamsterReportApiGetStorageByResourceTypeKpiRequest} requestParameters Request parameters.
250
+ * @param {*} [options] Override http request option.
251
+ * @throws {RequiredError}
252
+ * @memberof DataHamsterReportApi
253
+ */
254
+ getStorageByResourceTypeKpi(requestParameters: DataHamsterReportApiGetStorageByResourceTypeKpiRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<StorageDataHamsterKpiDtoResponse, any>>;
255
+ /**
256
+ * <p><strong>Required JWT roles for access:</strong> <code>administrator</code>.</p>
257
+ * @summary Get the number of users per ror report.
258
+ * @param {*} [options] Override http request option.
259
+ * @throws {RequiredError}
260
+ * @memberof DataHamsterReportApi
261
+ */
262
+ getUsersPerRorKpi(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DataHamsterKpiDtoIEnumerableResponse, any>>;
263
+ }
@@ -0,0 +1,165 @@
1
+ /**
2
+ * Coscine Web API
3
+ * 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.
4
+ *
5
+ * The version of the OpenAPI document: 2.0
6
+ * Contact: servicedesk@rwth-aachen.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../../base';
15
+ import type { ProjectDtoPagedResponse } from '../../@coscine/model';
16
+ /**
17
+ * ProjectSubProjectsApi - axios parameter creator
18
+ * @export
19
+ */
20
+ export declare const ProjectSubProjectsApiAxiosParamCreator: (configuration?: Configuration) => {
21
+ /**
22
+ *
23
+ * @summary Responds with the HTTP methods allowed for the endpoint.
24
+ * @param {string} projectId
25
+ * @param {*} [options] Override http request option.
26
+ * @throws {RequiredError}
27
+ */
28
+ apiV2ProjectsProjectIdSubprojectsOptions: (projectId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
29
+ /**
30
+ *
31
+ * @summary Retrieves all subprojects for a specified project.
32
+ * @param {string} projectId The Id or slug of the project.
33
+ * @param {boolean} [includeOrganizations] Gets or sets a value indicating whether to retrieve the organizations.
34
+ * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
35
+ * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
36
+ * @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.
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ getSubProjectsForProject: (projectId: string, includeOrganizations?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
41
+ };
42
+ /**
43
+ * ProjectSubProjectsApi - functional programming interface
44
+ * @export
45
+ */
46
+ export declare const ProjectSubProjectsApiFp: (configuration?: Configuration) => {
47
+ /**
48
+ *
49
+ * @summary Responds with the HTTP methods allowed for the endpoint.
50
+ * @param {string} projectId
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ */
54
+ apiV2ProjectsProjectIdSubprojectsOptions(projectId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
55
+ /**
56
+ *
57
+ * @summary Retrieves all subprojects for a specified project.
58
+ * @param {string} projectId The Id or slug of the project.
59
+ * @param {boolean} [includeOrganizations] Gets or sets a value indicating whether to retrieve the organizations.
60
+ * @param {number} [pageNumber] The desired page number. Should be greater than or equal to 1. Default is 1.
61
+ * @param {number} [pageSize] The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
62
+ * @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.
63
+ * @param {*} [options] Override http request option.
64
+ * @throws {RequiredError}
65
+ */
66
+ getSubProjectsForProject(projectId: string, includeOrganizations?: boolean, pageNumber?: number, pageSize?: number, orderBy?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectDtoPagedResponse>>;
67
+ };
68
+ /**
69
+ * ProjectSubProjectsApi - factory interface
70
+ * @export
71
+ */
72
+ export declare const ProjectSubProjectsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
73
+ /**
74
+ *
75
+ * @summary Responds with the HTTP methods allowed for the endpoint.
76
+ * @param {ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest} requestParameters Request parameters.
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ apiV2ProjectsProjectIdSubprojectsOptions(requestParameters: ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
81
+ /**
82
+ *
83
+ * @summary Retrieves all subprojects for a specified project.
84
+ * @param {ProjectSubProjectsApiGetSubProjectsForProjectRequest} requestParameters Request parameters.
85
+ * @param {*} [options] Override http request option.
86
+ * @throws {RequiredError}
87
+ */
88
+ getSubProjectsForProject(requestParameters: ProjectSubProjectsApiGetSubProjectsForProjectRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectDtoPagedResponse>;
89
+ };
90
+ /**
91
+ * Request parameters for apiV2ProjectsProjectIdSubprojectsOptions operation in ProjectSubProjectsApi.
92
+ * @export
93
+ * @interface ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest
94
+ */
95
+ export interface ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest {
96
+ /**
97
+ *
98
+ * @type {string}
99
+ * @memberof ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptions
100
+ */
101
+ readonly projectId: string;
102
+ }
103
+ /**
104
+ * Request parameters for getSubProjectsForProject operation in ProjectSubProjectsApi.
105
+ * @export
106
+ * @interface ProjectSubProjectsApiGetSubProjectsForProjectRequest
107
+ */
108
+ export interface ProjectSubProjectsApiGetSubProjectsForProjectRequest {
109
+ /**
110
+ * The Id or slug of the project.
111
+ * @type {string}
112
+ * @memberof ProjectSubProjectsApiGetSubProjectsForProject
113
+ */
114
+ readonly projectId: string;
115
+ /**
116
+ * Gets or sets a value indicating whether to retrieve the organizations.
117
+ * @type {boolean}
118
+ * @memberof ProjectSubProjectsApiGetSubProjectsForProject
119
+ */
120
+ readonly includeOrganizations?: boolean;
121
+ /**
122
+ * The desired page number. Should be greater than or equal to 1. Default is 1.
123
+ * @type {number}
124
+ * @memberof ProjectSubProjectsApiGetSubProjectsForProject
125
+ */
126
+ readonly pageNumber?: number;
127
+ /**
128
+ * The desired page size. Should be between 1 and the maximum allowed page size (50). Default is 10.
129
+ * @type {number}
130
+ * @memberof ProjectSubProjectsApiGetSubProjectsForProject
131
+ */
132
+ readonly pageSize?: number;
133
+ /**
134
+ * 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.
135
+ * @type {string}
136
+ * @memberof ProjectSubProjectsApiGetSubProjectsForProject
137
+ */
138
+ readonly orderBy?: string;
139
+ }
140
+ /**
141
+ * ProjectSubProjectsApi - object-oriented interface
142
+ * @export
143
+ * @class ProjectSubProjectsApi
144
+ * @extends {BaseAPI}
145
+ */
146
+ export declare class ProjectSubProjectsApi extends BaseAPI {
147
+ /**
148
+ *
149
+ * @summary Responds with the HTTP methods allowed for the endpoint.
150
+ * @param {ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest} requestParameters Request parameters.
151
+ * @param {*} [options] Override http request option.
152
+ * @throws {RequiredError}
153
+ * @memberof ProjectSubProjectsApi
154
+ */
155
+ apiV2ProjectsProjectIdSubprojectsOptions(requestParameters: ProjectSubProjectsApiApiV2ProjectsProjectIdSubprojectsOptionsRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
156
+ /**
157
+ *
158
+ * @summary Retrieves all subprojects for a specified project.
159
+ * @param {ProjectSubProjectsApiGetSubProjectsForProjectRequest} requestParameters Request parameters.
160
+ * @param {*} [options] Override http request option.
161
+ * @throws {RequiredError}
162
+ * @memberof ProjectSubProjectsApi
163
+ */
164
+ getSubProjectsForProject(requestParameters: ProjectSubProjectsApiGetSubProjectsForProjectRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectDtoPagedResponse, any>>;
165
+ }