@se-uulm/snowballr-api-client 0.2.1-alpha.5864cf1 → 0.2.1-alpha.5bdf774

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 (48) hide show
  1. package/README.md +111 -28
  2. package/dist/apis/AuthControllerApi.d.ts +64 -1
  3. package/dist/apis/AuthControllerApi.js +64 -18
  4. package/dist/apis/ProjectsControllerApi.d.ts +54 -1
  5. package/dist/apis/ProjectsControllerApi.js +56 -19
  6. package/dist/apis/UsersControllerApi.d.ts +15 -1
  7. package/dist/apis/UsersControllerApi.js +14 -5
  8. package/dist/esm/apis/AuthControllerApi.d.ts +64 -1
  9. package/dist/esm/apis/AuthControllerApi.js +62 -16
  10. package/dist/esm/apis/ProjectsControllerApi.d.ts +54 -1
  11. package/dist/esm/apis/ProjectsControllerApi.js +52 -15
  12. package/dist/esm/apis/UsersControllerApi.d.ts +15 -1
  13. package/dist/esm/apis/UsersControllerApi.js +13 -4
  14. package/dist/esm/models/ChangePasswordRequest.d.ts +0 -4
  15. package/dist/esm/models/CreateProjectRequest.d.ts +0 -2
  16. package/dist/esm/models/DecisionMatrixPattern.d.ts +0 -4
  17. package/dist/esm/models/DecisionMatrixPattern.js +1 -1
  18. package/dist/esm/models/DecisionMatrixPatternEntry.d.ts +0 -4
  19. package/dist/esm/models/DecisionMatrixPatternEntry.js +1 -1
  20. package/dist/esm/models/LoginRequest.d.ts +0 -4
  21. package/dist/esm/models/ProjectResponse.d.ts +2 -53
  22. package/dist/esm/models/ProjectResponse.js +7 -22
  23. package/dist/esm/models/ProjectSettings.d.ts +60 -0
  24. package/dist/esm/models/ProjectSettings.js +58 -0
  25. package/dist/esm/models/RegisterRequest.d.ts +0 -8
  26. package/dist/esm/models/ReviewDecisionMatrix.d.ts +0 -4
  27. package/dist/esm/models/index.d.ts +1 -0
  28. package/dist/esm/models/index.js +1 -0
  29. package/dist/esm/runtime.d.ts +34 -1
  30. package/dist/esm/runtime.js +130 -4
  31. package/dist/models/ChangePasswordRequest.d.ts +0 -4
  32. package/dist/models/CreateProjectRequest.d.ts +0 -2
  33. package/dist/models/DecisionMatrixPattern.d.ts +0 -4
  34. package/dist/models/DecisionMatrixPattern.js +1 -1
  35. package/dist/models/DecisionMatrixPatternEntry.d.ts +0 -4
  36. package/dist/models/DecisionMatrixPatternEntry.js +1 -1
  37. package/dist/models/LoginRequest.d.ts +0 -4
  38. package/dist/models/ProjectResponse.d.ts +2 -53
  39. package/dist/models/ProjectResponse.js +8 -23
  40. package/dist/models/ProjectSettings.d.ts +60 -0
  41. package/dist/models/ProjectSettings.js +66 -0
  42. package/dist/models/RegisterRequest.d.ts +0 -8
  43. package/dist/models/ReviewDecisionMatrix.d.ts +0 -4
  44. package/dist/models/index.d.ts +1 -0
  45. package/dist/models/index.js +1 -0
  46. package/dist/runtime.d.ts +34 -1
  47. package/dist/runtime.js +136 -4
  48. package/package.json +2 -2
package/README.md CHANGED
@@ -1,46 +1,129 @@
1
- ## @se-uulm/snowballr-api-client@0.2.1-alpha.5864cf1
1
+ # @se-uulm/snowballr-api-client@0.2.1-alpha.5bdf774
2
2
 
3
- This generator creates TypeScript/JavaScript client that utilizes [Fetch API](https://fetch.spec.whatwg.org/). The generated Node module can be used in the following environments:
3
+ A TypeScript SDK client for the localhost API.
4
4
 
5
- Environment
6
- * Node.js
7
- * Webpack
8
- * Browserify
5
+ ## Usage
9
6
 
10
- Language level
11
- * ES5 - you must have a Promises/A+ library installed
12
- * ES6
7
+ First, install the SDK from npm.
13
8
 
14
- Module system
15
- * CommonJS
16
- * ES6 module system
9
+ ```bash
10
+ npm install @se-uulm/snowballr-api-client --save
11
+ ```
17
12
 
18
- It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via `package.json`. ([Reference](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html))
13
+ Next, try it out.
19
14
 
20
- ### Building
21
15
 
22
- To build and compile the typescript sources to javascript use:
23
- ```
24
- npm install
25
- npm run build
16
+ ```ts
17
+ import {
18
+ Configuration,
19
+ AuthControllerApi,
20
+ } from '@se-uulm/snowballr-api-client';
21
+ import type { ChangePasswordOperationRequest } from '@se-uulm/snowballr-api-client';
22
+
23
+ async function example() {
24
+ console.log("🚀 Testing @se-uulm/snowballr-api-client SDK...");
25
+ const api = new AuthControllerApi();
26
+
27
+ const body = {
28
+ // ChangePasswordRequest
29
+ changePasswordRequest: ...,
30
+ } satisfies ChangePasswordOperationRequest;
31
+
32
+ try {
33
+ const data = await api.changePassword(body);
34
+ console.log(data);
35
+ } catch (error) {
36
+ console.error(error);
37
+ }
38
+ }
39
+
40
+ // Run the test
41
+ example().catch(console.error);
26
42
  ```
27
43
 
28
- ### Publishing
29
44
 
30
- First build the package then run `npm publish`
45
+ ## Documentation
31
46
 
32
- ### Consuming
47
+ ### API Endpoints
33
48
 
34
- navigate to the folder of your consuming project and run one of the following commands.
49
+ All URIs are relative to *http://localhost*
35
50
 
36
- _published:_
51
+ | Class | Method | HTTP request | Description
52
+ | ----- | ------ | ------------ | -------------
53
+ *AuthControllerApi* | [**changePassword**](docs/AuthControllerApi.md#changepasswordoperation) | **POST** /api/v1/auth/change-password |
54
+ *AuthControllerApi* | [**getAuthStatus**](docs/AuthControllerApi.md#getauthstatus) | **GET** /api/v1/auth/status |
55
+ *AuthControllerApi* | [**login**](docs/AuthControllerApi.md#loginoperation) | **POST** /api/v1/auth/login |
56
+ *AuthControllerApi* | [**logout**](docs/AuthControllerApi.md#logout) | **POST** /api/v1/auth/logout |
57
+ *AuthControllerApi* | [**verifyEmail**](docs/AuthControllerApi.md#verifyemail) | **POST** /api/v1/auth/verify-email |
58
+ *ProjectsControllerApi* | [**createProject**](docs/ProjectsControllerApi.md#createprojectoperation) | **POST** /api/v1/projects |
59
+ *ProjectsControllerApi* | [**deleteProject**](docs/ProjectsControllerApi.md#deleteproject) | **DELETE** /api/v1/projects/{id} |
60
+ *ProjectsControllerApi* | [**getAllProjects**](docs/ProjectsControllerApi.md#getallprojects) | **GET** /api/v1/projects |
61
+ *ProjectsControllerApi* | [**getProject**](docs/ProjectsControllerApi.md#getproject) | **GET** /api/v1/projects/{id} |
62
+ *UsersControllerApi* | [**register**](docs/UsersControllerApi.md#registeroperation) | **POST** /api/v1/users |
63
+
64
+
65
+ ### Models
66
+
67
+ - [ChangePasswordRequest](docs/ChangePasswordRequest.md)
68
+ - [CreateProjectRequest](docs/CreateProjectRequest.md)
69
+ - [DecisionMatrixPattern](docs/DecisionMatrixPattern.md)
70
+ - [DecisionMatrixPatternEntry](docs/DecisionMatrixPatternEntry.md)
71
+ - [LoginRequest](docs/LoginRequest.md)
72
+ - [ProjectResponse](docs/ProjectResponse.md)
73
+ - [ProjectSettings](docs/ProjectSettings.md)
74
+ - [RegisterRequest](docs/RegisterRequest.md)
75
+ - [ReviewDecisionMatrix](docs/ReviewDecisionMatrix.md)
76
+
77
+ ### Authorization
78
+
79
+ Endpoints do not require authorization.
37
80
 
38
- ```
39
- npm install @se-uulm/snowballr-api-client@0.2.1-alpha.5864cf1 --save
40
- ```
41
81
 
42
- _unPublished (not recommended):_
82
+ ## About
43
83
 
84
+ This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
85
+ and is automatically generated by the
86
+ [OpenAPI Generator](https://openapi-generator.tech) project:
87
+
88
+ - API version: `v1`
89
+ - Package version: `0.2.1-alpha.5bdf774`
90
+ - Generator version: `7.26.0`
91
+ - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
92
+
93
+ The generated npm module supports the following:
94
+
95
+ - Environments
96
+ * Node.js
97
+ * Webpack
98
+ * Browserify
99
+ - Language levels
100
+ * ES5 - you must have a Promises/A+ library installed
101
+ * ES6
102
+ - Module systems
103
+ * CommonJS
104
+ * ES6 module system
105
+
106
+
107
+ ## Development
108
+
109
+ ### Building
110
+
111
+ To build the TypeScript source code, you need to have Node.js and npm installed.
112
+ After cloning the repository, navigate to the project directory and run:
113
+
114
+ ```bash
115
+ npm install
116
+ npm run build
44
117
  ```
45
- npm install PATH_TO_GENERATED_PACKAGE --save
118
+
119
+ ### Publishing
120
+
121
+ Once you've built the package, you can publish it to npm:
122
+
123
+ ```bash
124
+ npm publish
46
125
  ```
126
+
127
+ ## License
128
+
129
+ []()
@@ -10,14 +10,24 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { ChangePasswordRequest, LoginRequest } from '../models/index';
13
+ import { type ChangePasswordRequest } from '../models/ChangePasswordRequest';
14
+ import { type LoginRequest } from '../models/LoginRequest';
14
15
  export interface ChangePasswordOperationRequest {
16
+ /**
17
+ *
18
+ */
15
19
  changePasswordRequest: ChangePasswordRequest;
16
20
  }
17
21
  export interface LoginOperationRequest {
22
+ /**
23
+ *
24
+ */
18
25
  loginRequest: LoginRequest;
19
26
  }
20
27
  export interface VerifyEmailRequest {
28
+ /**
29
+ *
30
+ */
21
31
  token: string;
22
32
  }
23
33
  /**
@@ -27,6 +37,13 @@ export interface VerifyEmailRequest {
27
37
  * @interface AuthControllerApiInterface
28
38
  */
29
39
  export interface AuthControllerApiInterface {
40
+ /**
41
+ * Creates request options for changePassword without sending the request
42
+ * @param {ChangePasswordRequest} changePasswordRequest
43
+ * @throws {RequiredError}
44
+ * @memberof AuthControllerApiInterface
45
+ */
46
+ changePasswordRequestOpts(requestParameters: ChangePasswordOperationRequest): Promise<runtime.RequestOpts>;
30
47
  /**
31
48
  *
32
49
  * @param {ChangePasswordRequest} changePasswordRequest
@@ -38,6 +55,12 @@ export interface AuthControllerApiInterface {
38
55
  /**
39
56
  */
40
57
  changePassword(requestParameters: ChangePasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
58
+ /**
59
+ * Creates request options for getAuthStatus without sending the request
60
+ * @throws {RequiredError}
61
+ * @memberof AuthControllerApiInterface
62
+ */
63
+ getAuthStatusRequestOpts(): Promise<runtime.RequestOpts>;
41
64
  /**
42
65
  *
43
66
  * @param {*} [options] Override http request option.
@@ -48,6 +71,13 @@ export interface AuthControllerApiInterface {
48
71
  /**
49
72
  */
50
73
  getAuthStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
74
+ /**
75
+ * Creates request options for login without sending the request
76
+ * @param {LoginRequest} loginRequest
77
+ * @throws {RequiredError}
78
+ * @memberof AuthControllerApiInterface
79
+ */
80
+ loginRequestOpts(requestParameters: LoginOperationRequest): Promise<runtime.RequestOpts>;
51
81
  /**
52
82
  *
53
83
  * @param {LoginRequest} loginRequest
@@ -59,6 +89,12 @@ export interface AuthControllerApiInterface {
59
89
  /**
60
90
  */
61
91
  login(requestParameters: LoginOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
92
+ /**
93
+ * Creates request options for logout without sending the request
94
+ * @throws {RequiredError}
95
+ * @memberof AuthControllerApiInterface
96
+ */
97
+ logoutRequestOpts(): Promise<runtime.RequestOpts>;
62
98
  /**
63
99
  *
64
100
  * @param {*} [options] Override http request option.
@@ -69,6 +105,13 @@ export interface AuthControllerApiInterface {
69
105
  /**
70
106
  */
71
107
  logout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
108
+ /**
109
+ * Creates request options for verifyEmail without sending the request
110
+ * @param {string} token
111
+ * @throws {RequiredError}
112
+ * @memberof AuthControllerApiInterface
113
+ */
114
+ verifyEmailRequestOpts(requestParameters: VerifyEmailRequest): Promise<runtime.RequestOpts>;
72
115
  /**
73
116
  *
74
117
  * @param {string} token
@@ -85,30 +128,50 @@ export interface AuthControllerApiInterface {
85
128
  *
86
129
  */
87
130
  export declare class AuthControllerApi extends runtime.BaseAPI implements AuthControllerApiInterface {
131
+ /**
132
+ * Creates request options for changePassword without sending the request
133
+ */
134
+ changePasswordRequestOpts(requestParameters: ChangePasswordOperationRequest): Promise<runtime.RequestOpts>;
88
135
  /**
89
136
  */
90
137
  changePasswordRaw(requestParameters: ChangePasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
91
138
  /**
92
139
  */
93
140
  changePassword(requestParameters: ChangePasswordOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
141
+ /**
142
+ * Creates request options for getAuthStatus without sending the request
143
+ */
144
+ getAuthStatusRequestOpts(): Promise<runtime.RequestOpts>;
94
145
  /**
95
146
  */
96
147
  getAuthStatusRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
97
148
  /**
98
149
  */
99
150
  getAuthStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
151
+ /**
152
+ * Creates request options for login without sending the request
153
+ */
154
+ loginRequestOpts(requestParameters: LoginOperationRequest): Promise<runtime.RequestOpts>;
100
155
  /**
101
156
  */
102
157
  loginRaw(requestParameters: LoginOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
103
158
  /**
104
159
  */
105
160
  login(requestParameters: LoginOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
161
+ /**
162
+ * Creates request options for logout without sending the request
163
+ */
164
+ logoutRequestOpts(): Promise<runtime.RequestOpts>;
106
165
  /**
107
166
  */
108
167
  logoutRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
109
168
  /**
110
169
  */
111
170
  logout(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
171
+ /**
172
+ * Creates request options for verifyEmail without sending the request
173
+ */
174
+ verifyEmailRequestOpts(requestParameters: VerifyEmailRequest): Promise<runtime.RequestOpts>;
112
175
  /**
113
176
  */
114
177
  verifyEmailRaw(requestParameters: VerifyEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
@@ -24,14 +24,16 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
25
  exports.AuthControllerApi = void 0;
26
26
  const runtime = require("../runtime");
27
- const index_1 = require("../models/index");
27
+ const ChangePasswordRequest_1 = require("../models/ChangePasswordRequest");
28
+ const LoginRequest_1 = require("../models/LoginRequest");
28
29
  /**
29
30
  *
30
31
  */
31
32
  class AuthControllerApi extends runtime.BaseAPI {
32
33
  /**
34
+ * Creates request options for changePassword without sending the request
33
35
  */
34
- changePasswordRaw(requestParameters, initOverrides) {
36
+ changePasswordRequestOpts(requestParameters) {
35
37
  return __awaiter(this, void 0, void 0, function* () {
36
38
  if (requestParameters['changePasswordRequest'] == null) {
37
39
  throw new runtime.RequiredError('changePasswordRequest', 'Required parameter "changePasswordRequest" was null or undefined when calling changePassword().');
@@ -40,13 +42,21 @@ class AuthControllerApi extends runtime.BaseAPI {
40
42
  const headerParameters = {};
41
43
  headerParameters['Content-Type'] = 'application/json';
42
44
  let urlPath = `/api/v1/auth/change-password`;
43
- const response = yield this.request({
45
+ return {
44
46
  path: urlPath,
45
47
  method: 'POST',
46
48
  headers: headerParameters,
47
49
  query: queryParameters,
48
- body: (0, index_1.ChangePasswordRequestToJSON)(requestParameters['changePasswordRequest']),
49
- }, initOverrides);
50
+ body: (0, ChangePasswordRequest_1.ChangePasswordRequestToJSON)(requestParameters['changePasswordRequest']),
51
+ };
52
+ });
53
+ }
54
+ /**
55
+ */
56
+ changePasswordRaw(requestParameters, initOverrides) {
57
+ return __awaiter(this, void 0, void 0, function* () {
58
+ const requestOptions = yield this.changePasswordRequestOpts(requestParameters);
59
+ const response = yield this.request(requestOptions, initOverrides);
50
60
  return new runtime.VoidApiResponse(response);
51
61
  });
52
62
  }
@@ -58,18 +68,27 @@ class AuthControllerApi extends runtime.BaseAPI {
58
68
  });
59
69
  }
60
70
  /**
71
+ * Creates request options for getAuthStatus without sending the request
61
72
  */
62
- getAuthStatusRaw(initOverrides) {
73
+ getAuthStatusRequestOpts() {
63
74
  return __awaiter(this, void 0, void 0, function* () {
64
75
  const queryParameters = {};
65
76
  const headerParameters = {};
66
77
  let urlPath = `/api/v1/auth/status`;
67
- const response = yield this.request({
78
+ return {
68
79
  path: urlPath,
69
80
  method: 'GET',
70
81
  headers: headerParameters,
71
82
  query: queryParameters,
72
- }, initOverrides);
83
+ };
84
+ });
85
+ }
86
+ /**
87
+ */
88
+ getAuthStatusRaw(initOverrides) {
89
+ return __awaiter(this, void 0, void 0, function* () {
90
+ const requestOptions = yield this.getAuthStatusRequestOpts();
91
+ const response = yield this.request(requestOptions, initOverrides);
73
92
  if (this.isJsonMime(response.headers.get('content-type'))) {
74
93
  return new runtime.JSONApiResponse(response);
75
94
  }
@@ -87,8 +106,9 @@ class AuthControllerApi extends runtime.BaseAPI {
87
106
  });
88
107
  }
89
108
  /**
109
+ * Creates request options for login without sending the request
90
110
  */
91
- loginRaw(requestParameters, initOverrides) {
111
+ loginRequestOpts(requestParameters) {
92
112
  return __awaiter(this, void 0, void 0, function* () {
93
113
  if (requestParameters['loginRequest'] == null) {
94
114
  throw new runtime.RequiredError('loginRequest', 'Required parameter "loginRequest" was null or undefined when calling login().');
@@ -97,13 +117,21 @@ class AuthControllerApi extends runtime.BaseAPI {
97
117
  const headerParameters = {};
98
118
  headerParameters['Content-Type'] = 'application/json';
99
119
  let urlPath = `/api/v1/auth/login`;
100
- const response = yield this.request({
120
+ return {
101
121
  path: urlPath,
102
122
  method: 'POST',
103
123
  headers: headerParameters,
104
124
  query: queryParameters,
105
- body: (0, index_1.LoginRequestToJSON)(requestParameters['loginRequest']),
106
- }, initOverrides);
125
+ body: (0, LoginRequest_1.LoginRequestToJSON)(requestParameters['loginRequest']),
126
+ };
127
+ });
128
+ }
129
+ /**
130
+ */
131
+ loginRaw(requestParameters, initOverrides) {
132
+ return __awaiter(this, void 0, void 0, function* () {
133
+ const requestOptions = yield this.loginRequestOpts(requestParameters);
134
+ const response = yield this.request(requestOptions, initOverrides);
107
135
  return new runtime.VoidApiResponse(response);
108
136
  });
109
137
  }
@@ -115,18 +143,27 @@ class AuthControllerApi extends runtime.BaseAPI {
115
143
  });
116
144
  }
117
145
  /**
146
+ * Creates request options for logout without sending the request
118
147
  */
119
- logoutRaw(initOverrides) {
148
+ logoutRequestOpts() {
120
149
  return __awaiter(this, void 0, void 0, function* () {
121
150
  const queryParameters = {};
122
151
  const headerParameters = {};
123
152
  let urlPath = `/api/v1/auth/logout`;
124
- const response = yield this.request({
153
+ return {
125
154
  path: urlPath,
126
155
  method: 'POST',
127
156
  headers: headerParameters,
128
157
  query: queryParameters,
129
- }, initOverrides);
158
+ };
159
+ });
160
+ }
161
+ /**
162
+ */
163
+ logoutRaw(initOverrides) {
164
+ return __awaiter(this, void 0, void 0, function* () {
165
+ const requestOptions = yield this.logoutRequestOpts();
166
+ const response = yield this.request(requestOptions, initOverrides);
130
167
  return new runtime.VoidApiResponse(response);
131
168
  });
132
169
  }
@@ -138,8 +175,9 @@ class AuthControllerApi extends runtime.BaseAPI {
138
175
  });
139
176
  }
140
177
  /**
178
+ * Creates request options for verifyEmail without sending the request
141
179
  */
142
- verifyEmailRaw(requestParameters, initOverrides) {
180
+ verifyEmailRequestOpts(requestParameters) {
143
181
  return __awaiter(this, void 0, void 0, function* () {
144
182
  if (requestParameters['token'] == null) {
145
183
  throw new runtime.RequiredError('token', 'Required parameter "token" was null or undefined when calling verifyEmail().');
@@ -150,12 +188,20 @@ class AuthControllerApi extends runtime.BaseAPI {
150
188
  }
151
189
  const headerParameters = {};
152
190
  let urlPath = `/api/v1/auth/verify-email`;
153
- const response = yield this.request({
191
+ return {
154
192
  path: urlPath,
155
193
  method: 'POST',
156
194
  headers: headerParameters,
157
195
  query: queryParameters,
158
- }, initOverrides);
196
+ };
197
+ });
198
+ }
199
+ /**
200
+ */
201
+ verifyEmailRaw(requestParameters, initOverrides) {
202
+ return __awaiter(this, void 0, void 0, function* () {
203
+ const requestOptions = yield this.verifyEmailRequestOpts(requestParameters);
204
+ const response = yield this.request(requestOptions, initOverrides);
159
205
  return new runtime.VoidApiResponse(response);
160
206
  });
161
207
  }
@@ -10,14 +10,24 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import type { CreateProjectRequest, ProjectResponse } from '../models/index';
13
+ import { type CreateProjectRequest } from '../models/CreateProjectRequest';
14
+ import { type ProjectResponse } from '../models/ProjectResponse';
14
15
  export interface CreateProjectOperationRequest {
16
+ /**
17
+ *
18
+ */
15
19
  createProjectRequest: CreateProjectRequest;
16
20
  }
17
21
  export interface DeleteProjectRequest {
22
+ /**
23
+ *
24
+ */
18
25
  id: string;
19
26
  }
20
27
  export interface GetProjectRequest {
28
+ /**
29
+ *
30
+ */
21
31
  id: string;
22
32
  }
23
33
  /**
@@ -27,6 +37,13 @@ export interface GetProjectRequest {
27
37
  * @interface ProjectsControllerApiInterface
28
38
  */
29
39
  export interface ProjectsControllerApiInterface {
40
+ /**
41
+ * Creates request options for createProject without sending the request
42
+ * @param {CreateProjectRequest} createProjectRequest
43
+ * @throws {RequiredError}
44
+ * @memberof ProjectsControllerApiInterface
45
+ */
46
+ createProjectRequestOpts(requestParameters: CreateProjectOperationRequest): Promise<runtime.RequestOpts>;
30
47
  /**
31
48
  *
32
49
  * @param {CreateProjectRequest} createProjectRequest
@@ -38,6 +55,13 @@ export interface ProjectsControllerApiInterface {
38
55
  /**
39
56
  */
40
57
  createProject(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectResponse>;
58
+ /**
59
+ * Creates request options for deleteProject without sending the request
60
+ * @param {string} id
61
+ * @throws {RequiredError}
62
+ * @memberof ProjectsControllerApiInterface
63
+ */
64
+ deleteProjectRequestOpts(requestParameters: DeleteProjectRequest): Promise<runtime.RequestOpts>;
41
65
  /**
42
66
  *
43
67
  * @param {string} id
@@ -49,6 +73,12 @@ export interface ProjectsControllerApiInterface {
49
73
  /**
50
74
  */
51
75
  deleteProject(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
76
+ /**
77
+ * Creates request options for getAllProjects without sending the request
78
+ * @throws {RequiredError}
79
+ * @memberof ProjectsControllerApiInterface
80
+ */
81
+ getAllProjectsRequestOpts(): Promise<runtime.RequestOpts>;
52
82
  /**
53
83
  *
54
84
  * @param {*} [options] Override http request option.
@@ -59,6 +89,13 @@ export interface ProjectsControllerApiInterface {
59
89
  /**
60
90
  */
61
91
  getAllProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectResponse>>;
92
+ /**
93
+ * Creates request options for getProject without sending the request
94
+ * @param {string} id
95
+ * @throws {RequiredError}
96
+ * @memberof ProjectsControllerApiInterface
97
+ */
98
+ getProjectRequestOpts(requestParameters: GetProjectRequest): Promise<runtime.RequestOpts>;
62
99
  /**
63
100
  *
64
101
  * @param {string} id
@@ -75,24 +112,40 @@ export interface ProjectsControllerApiInterface {
75
112
  *
76
113
  */
77
114
  export declare class ProjectsControllerApi extends runtime.BaseAPI implements ProjectsControllerApiInterface {
115
+ /**
116
+ * Creates request options for createProject without sending the request
117
+ */
118
+ createProjectRequestOpts(requestParameters: CreateProjectOperationRequest): Promise<runtime.RequestOpts>;
78
119
  /**
79
120
  */
80
121
  createProjectRaw(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectResponse>>;
81
122
  /**
82
123
  */
83
124
  createProject(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ProjectResponse>;
125
+ /**
126
+ * Creates request options for deleteProject without sending the request
127
+ */
128
+ deleteProjectRequestOpts(requestParameters: DeleteProjectRequest): Promise<runtime.RequestOpts>;
84
129
  /**
85
130
  */
86
131
  deleteProjectRaw(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
87
132
  /**
88
133
  */
89
134
  deleteProject(requestParameters: DeleteProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
135
+ /**
136
+ * Creates request options for getAllProjects without sending the request
137
+ */
138
+ getAllProjectsRequestOpts(): Promise<runtime.RequestOpts>;
90
139
  /**
91
140
  */
92
141
  getAllProjectsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ProjectResponse>>>;
93
142
  /**
94
143
  */
95
144
  getAllProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ProjectResponse>>;
145
+ /**
146
+ * Creates request options for getProject without sending the request
147
+ */
148
+ getProjectRequestOpts(requestParameters: GetProjectRequest): Promise<runtime.RequestOpts>;
96
149
  /**
97
150
  */
98
151
  getProjectRaw(requestParameters: GetProjectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ProjectResponse>>;