@coscine/api-client 3.10.0 → 3.11.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.
@@ -12,8 +12,8 @@
12
12
  import type { Configuration } from '../../configuration';
13
13
  import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
14
  import { type RequestArgs, BaseAPI } from '../../base';
15
+ import type { ProjectPublicationRequestDtoResponse } from '../../@coscine/model';
15
16
  import type { PublicationRequestForCreationDto } from '../../@coscine/model';
16
- import type { PublicationRequestForCreationDtoResponse } from '../../@coscine/model';
17
17
  /**
18
18
  * ProjectPublicationRequestApi - axios parameter creator
19
19
  * @export
@@ -36,6 +36,15 @@ export declare const ProjectPublicationRequestApiAxiosParamCreator: (configurati
36
36
  * @throws {RequiredError}
37
37
  */
38
38
  createPublicationRequest: (projectId: string, publicationRequestForCreationDto?: PublicationRequestForCreationDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
39
+ /**
40
+ *
41
+ * @summary Retrieves a publication request.
42
+ * @param {string} projectId The ID of the project.
43
+ * @param {string} publicationRequestId The ID of the publication request.
44
+ * @param {*} [options] Override http request option.
45
+ * @throws {RequiredError}
46
+ */
47
+ getPublicationRequest: (projectId: string, publicationRequestId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
39
48
  };
40
49
  /**
41
50
  * ProjectPublicationRequestApi - functional programming interface
@@ -58,7 +67,16 @@ export declare const ProjectPublicationRequestApiFp: (configuration?: Configurat
58
67
  * @param {*} [options] Override http request option.
59
68
  * @throws {RequiredError}
60
69
  */
61
- createPublicationRequest(projectId: string, publicationRequestForCreationDto?: PublicationRequestForCreationDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicationRequestForCreationDtoResponse>>;
70
+ createPublicationRequest(projectId: string, publicationRequestForCreationDto?: PublicationRequestForCreationDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectPublicationRequestDtoResponse>>;
71
+ /**
72
+ *
73
+ * @summary Retrieves a publication request.
74
+ * @param {string} projectId The ID of the project.
75
+ * @param {string} publicationRequestId The ID of the publication request.
76
+ * @param {*} [options] Override http request option.
77
+ * @throws {RequiredError}
78
+ */
79
+ getPublicationRequest(projectId: string, publicationRequestId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ProjectPublicationRequestDtoResponse>>;
62
80
  };
63
81
  /**
64
82
  * ProjectPublicationRequestApi - factory interface
@@ -80,7 +98,15 @@ export declare const ProjectPublicationRequestApiFactory: (configuration?: Confi
80
98
  * @param {*} [options] Override http request option.
81
99
  * @throws {RequiredError}
82
100
  */
83
- createPublicationRequest(requestParameters: ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<PublicationRequestForCreationDtoResponse>;
101
+ createPublicationRequest(requestParameters: ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectPublicationRequestDtoResponse>;
102
+ /**
103
+ *
104
+ * @summary Retrieves a publication request.
105
+ * @param {ProjectPublicationRequestApiGetPublicationRequestRequest} requestParameters Request parameters.
106
+ * @param {*} [options] Override http request option.
107
+ * @throws {RequiredError}
108
+ */
109
+ getPublicationRequest(requestParameters: ProjectPublicationRequestApiGetPublicationRequestRequest, options?: RawAxiosRequestConfig): AxiosPromise<ProjectPublicationRequestDtoResponse>;
84
110
  };
85
111
  /**
86
112
  * Request parameters for apiV2ProjectsProjectIdPublicationsRequestsOptions operation in ProjectPublicationRequestApi.
@@ -114,6 +140,25 @@ export interface ProjectPublicationRequestApiCreatePublicationRequestRequest {
114
140
  */
115
141
  readonly publicationRequestForCreationDto?: PublicationRequestForCreationDto;
116
142
  }
143
+ /**
144
+ * Request parameters for getPublicationRequest operation in ProjectPublicationRequestApi.
145
+ * @export
146
+ * @interface ProjectPublicationRequestApiGetPublicationRequestRequest
147
+ */
148
+ export interface ProjectPublicationRequestApiGetPublicationRequestRequest {
149
+ /**
150
+ * The ID of the project.
151
+ * @type {string}
152
+ * @memberof ProjectPublicationRequestApiGetPublicationRequest
153
+ */
154
+ readonly projectId: string;
155
+ /**
156
+ * The ID of the publication request.
157
+ * @type {string}
158
+ * @memberof ProjectPublicationRequestApiGetPublicationRequest
159
+ */
160
+ readonly publicationRequestId: string;
161
+ }
117
162
  /**
118
163
  * ProjectPublicationRequestApi - object-oriented interface
119
164
  * @export
@@ -138,5 +183,14 @@ export declare class ProjectPublicationRequestApi extends BaseAPI {
138
183
  * @throws {RequiredError}
139
184
  * @memberof ProjectPublicationRequestApi
140
185
  */
141
- createPublicationRequest(requestParameters: ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicationRequestForCreationDtoResponse, any>>;
186
+ createPublicationRequest(requestParameters: ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectPublicationRequestDtoResponse, any>>;
187
+ /**
188
+ *
189
+ * @summary Retrieves a publication request.
190
+ * @param {ProjectPublicationRequestApiGetPublicationRequestRequest} requestParameters Request parameters.
191
+ * @param {*} [options] Override http request option.
192
+ * @throws {RequiredError}
193
+ * @memberof ProjectPublicationRequestApi
194
+ */
195
+ getPublicationRequest(requestParameters: ProjectPublicationRequestApiGetPublicationRequestRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ProjectPublicationRequestDtoResponse, any>>;
142
196
  }
@@ -86,6 +86,8 @@ export * from './project-invitation-dto-response';
86
86
  export * from './project-invitation-for-project-manipulation-dto';
87
87
  export * from './project-invitation-resolve-dto';
88
88
  export * from './project-minimal-dto';
89
+ export * from './project-publication-request-dto';
90
+ export * from './project-publication-request-dto-response';
89
91
  export * from './project-quota-dto';
90
92
  export * from './project-quota-dto-paged-response';
91
93
  export * from './project-quota-dto-response';
@@ -105,7 +107,6 @@ export * from './public-user-dto';
105
107
  export * from './public-user-dto-ienumerable-response';
106
108
  export * from './publication-advisory-service-dto';
107
109
  export * from './publication-request-for-creation-dto';
108
- export * from './publication-request-for-creation-dto-response';
109
110
  export * from './quota-dto';
110
111
  export * from './quota-for-manipulation-dto';
111
112
  export * from './quota-unit';
@@ -9,35 +9,35 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import type { PublicationRequestForCreationDto } from './publication-request-for-creation-dto';
12
+ import type { ProjectPublicationRequestDto } from './project-publication-request-dto';
13
13
  /**
14
14
  *
15
15
  * @export
16
- * @interface PublicationRequestForCreationDtoResponse
16
+ * @interface ProjectPublicationRequestDtoResponse
17
17
  */
18
- export interface PublicationRequestForCreationDtoResponse {
18
+ export interface ProjectPublicationRequestDtoResponse {
19
19
  /**
20
20
  *
21
- * @type {PublicationRequestForCreationDto}
22
- * @memberof PublicationRequestForCreationDtoResponse
21
+ * @type {ProjectPublicationRequestDto}
22
+ * @memberof ProjectPublicationRequestDtoResponse
23
23
  */
24
- 'data'?: PublicationRequestForCreationDto;
24
+ 'data'?: ProjectPublicationRequestDto;
25
25
  /**
26
26
  *
27
27
  * @type {boolean}
28
- * @memberof PublicationRequestForCreationDtoResponse
28
+ * @memberof ProjectPublicationRequestDtoResponse
29
29
  */
30
30
  'isSuccess'?: boolean;
31
31
  /**
32
32
  *
33
33
  * @type {number}
34
- * @memberof PublicationRequestForCreationDtoResponse
34
+ * @memberof ProjectPublicationRequestDtoResponse
35
35
  */
36
36
  'statusCode'?: number | null;
37
37
  /**
38
38
  *
39
39
  * @type {string}
40
- * @memberof PublicationRequestForCreationDtoResponse
40
+ * @memberof ProjectPublicationRequestDtoResponse
41
41
  */
42
42
  'traceId'?: string | null;
43
43
  }
@@ -0,0 +1,63 @@
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@itc.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 { ProjectMinimalDto } from './project-minimal-dto';
13
+ import type { ResourceMinimalDto } from './resource-minimal-dto';
14
+ import type { UserMinimalDto } from './user-minimal-dto';
15
+ /**
16
+ * Represents a data transfer object (DTO) for a project publication request.
17
+ * @export
18
+ * @interface ProjectPublicationRequestDto
19
+ */
20
+ export interface ProjectPublicationRequestDto {
21
+ /**
22
+ * Unique identifier for the project publication request.
23
+ * @type {string}
24
+ * @memberof ProjectPublicationRequestDto
25
+ */
26
+ 'id'?: string;
27
+ /**
28
+ *
29
+ * @type {ProjectMinimalDto}
30
+ * @memberof ProjectPublicationRequestDto
31
+ */
32
+ 'project'?: ProjectMinimalDto;
33
+ /**
34
+ * Identifier for the publication service used for this request.
35
+ * @type {string}
36
+ * @memberof ProjectPublicationRequestDto
37
+ */
38
+ 'publicationServiceRorId'?: string;
39
+ /**
40
+ *
41
+ * @type {UserMinimalDto}
42
+ * @memberof ProjectPublicationRequestDto
43
+ */
44
+ 'creator'?: UserMinimalDto;
45
+ /**
46
+ * The date and time when the request was created.
47
+ * @type {string}
48
+ * @memberof ProjectPublicationRequestDto
49
+ */
50
+ 'dateCreated'?: string;
51
+ /**
52
+ * Optional message associated with the publication request.
53
+ * @type {string}
54
+ * @memberof ProjectPublicationRequestDto
55
+ */
56
+ 'message'?: string | null;
57
+ /**
58
+ * Collection of the resources involved in the publication request.
59
+ * @type {Array<ResourceMinimalDto>}
60
+ * @memberof ProjectPublicationRequestDto
61
+ */
62
+ 'resources'?: Array<ResourceMinimalDto>;
63
+ }
@@ -28,9 +28,9 @@ export interface PublicationAdvisoryServiceDto {
28
28
  */
29
29
  'email': string;
30
30
  /**
31
- * The data publication service\'s info text.
31
+ * The data publication service\'s description.
32
32
  * @type {string}
33
33
  * @memberof PublicationAdvisoryServiceDto
34
34
  */
35
- 'text'?: string;
35
+ 'description'?: string | null;
36
36
  }
@@ -20,7 +20,7 @@ export interface PublicationRequestForCreationDto {
20
20
  * @type {string}
21
21
  * @memberof PublicationRequestForCreationDto
22
22
  */
23
- 'dataPublicationServiceRorId': string;
23
+ 'publicationServiceRorId': string;
24
24
  /**
25
25
  * The resource guids.
26
26
  * @type {Array<string>}
@@ -100,7 +100,8 @@ declare function implementations(axios?: AxiosInstance): {
100
100
  };
101
101
  ProjectPublicationRequestApi: {
102
102
  apiV2ProjectsProjectIdPublicationsRequestsOptions(requestParameters: import("./Coscine.Api/api").ProjectPublicationRequestApiApiV2ProjectsProjectIdPublicationsRequestsOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
103
- createPublicationRequest(requestParameters: import("./Coscine.Api/api").ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").PublicationRequestForCreationDtoResponse>;
103
+ createPublicationRequest(requestParameters: import("./Coscine.Api/api").ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectPublicationRequestDtoResponse>;
104
+ getPublicationRequest(requestParameters: import("./Coscine.Api/api").ProjectPublicationRequestApiGetPublicationRequestRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectPublicationRequestDtoResponse>;
104
105
  };
105
106
  ProjectQuotaApi: {
106
107
  apiV2ProjectsProjectIdQuotasOptions(requestParameters: import("./Coscine.Api/api").ProjectQuotaApiApiV2ProjectsProjectIdQuotasOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
@@ -99,7 +99,8 @@ declare const apis: {
99
99
  };
100
100
  ProjectPublicationRequestApi: {
101
101
  apiV2ProjectsProjectIdPublicationsRequestsOptions(requestParameters: import("./Coscine.Api").ProjectPublicationRequestApiApiV2ProjectsProjectIdPublicationsRequestsOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
102
- createPublicationRequest(requestParameters: import("./Coscine.Api").ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").PublicationRequestForCreationDtoResponse>;
102
+ createPublicationRequest(requestParameters: import("./Coscine.Api").ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectPublicationRequestDtoResponse>;
103
+ getPublicationRequest(requestParameters: import("./Coscine.Api").ProjectPublicationRequestApiGetPublicationRequestRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectPublicationRequestDtoResponse>;
103
104
  };
104
105
  ProjectQuotaApi: {
105
106
  apiV2ProjectsProjectIdQuotasOptions(requestParameters: import("./Coscine.Api").ProjectQuotaApiApiV2ProjectsProjectIdQuotasOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
@@ -307,7 +308,8 @@ export declare const ProjectMemberApi: {
307
308
  };
308
309
  export declare const ProjectPublicationRequestApi: {
309
310
  apiV2ProjectsProjectIdPublicationsRequestsOptions(requestParameters: import("./Coscine.Api").ProjectPublicationRequestApiApiV2ProjectsProjectIdPublicationsRequestsOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
310
- createPublicationRequest(requestParameters: import("./Coscine.Api").ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").PublicationRequestForCreationDtoResponse>;
311
+ createPublicationRequest(requestParameters: import("./Coscine.Api").ProjectPublicationRequestApiCreatePublicationRequestRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectPublicationRequestDtoResponse>;
312
+ getPublicationRequest(requestParameters: import("./Coscine.Api").ProjectPublicationRequestApiGetPublicationRequestRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<import("./Coscine.Api").ProjectPublicationRequestDtoResponse>;
311
313
  };
312
314
  export declare const ProjectQuotaApi: {
313
315
  apiV2ProjectsProjectIdQuotasOptions(requestParameters: import("./Coscine.Api").ProjectQuotaApiApiV2ProjectsProjectIdQuotasOptionsRequest, options?: import("axios").RawAxiosRequestConfig | undefined): import("axios").AxiosPromise<void>;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@coscine/api-client",
3
3
  "type": "module",
4
- "version": "3.10.0",
4
+ "version": "3.11.0",
5
5
  "description": "This project contains the generated api client classes.",
6
6
  "keywords": [
7
7
  "coscine",