@se-uulm/snowballr-api-client 0.2.0 → 0.2.1-alpha.07afd14
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.
- package/README.md +102 -28
- package/dist/apis/ProjectsControllerApi.d.ts +54 -1
- package/dist/apis/ProjectsControllerApi.js +60 -23
- package/dist/esm/apis/ProjectsControllerApi.d.ts +54 -1
- package/dist/esm/apis/ProjectsControllerApi.js +56 -19
- package/dist/esm/models/CreateProjectRequest.d.ts +0 -2
- package/dist/esm/models/DecisionMatrixPattern.d.ts +0 -4
- package/dist/esm/models/DecisionMatrixPattern.js +1 -1
- package/dist/esm/models/DecisionMatrixPatternEntry.d.ts +0 -4
- package/dist/esm/models/DecisionMatrixPatternEntry.js +1 -1
- package/dist/esm/models/Project.d.ts +3 -54
- package/dist/esm/models/Project.js +7 -22
- package/dist/esm/models/ProjectSettings.d.ts +60 -0
- package/dist/esm/models/ProjectSettings.js +58 -0
- package/dist/esm/models/ReviewDecisionMatrix.d.ts +0 -4
- package/dist/esm/models/index.d.ts +1 -0
- package/dist/esm/models/index.js +1 -0
- package/dist/esm/runtime.d.ts +34 -1
- package/dist/esm/runtime.js +130 -4
- package/dist/models/CreateProjectRequest.d.ts +0 -2
- package/dist/models/DecisionMatrixPattern.d.ts +0 -4
- package/dist/models/DecisionMatrixPattern.js +1 -1
- package/dist/models/DecisionMatrixPatternEntry.d.ts +0 -4
- package/dist/models/DecisionMatrixPatternEntry.js +1 -1
- package/dist/models/Project.d.ts +3 -54
- package/dist/models/Project.js +8 -23
- package/dist/models/ProjectSettings.d.ts +60 -0
- package/dist/models/ProjectSettings.js +66 -0
- package/dist/models/ReviewDecisionMatrix.d.ts +0 -4
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/runtime.d.ts +34 -1
- package/dist/runtime.js +136 -4
- package/package.json +11 -5
- package/.openapi-generator/FILES +0 -17
- package/.openapi-generator/VERSION +0 -1
- package/.openapi-generator-ignore +0 -23
- package/src/apis/ProjectsControllerApi.ts +0 -238
- package/src/apis/index.ts +0 -3
- package/src/index.ts +0 -5
- package/src/models/CreateProjectRequest.ts +0 -65
- package/src/models/DecisionMatrixPattern.ts +0 -94
- package/src/models/DecisionMatrixPatternEntry.ts +0 -85
- package/src/models/Project.ts +0 -177
- package/src/models/ReviewDecisionMatrix.ts +0 -81
- package/src/models/index.ts +0 -7
- package/src/runtime.ts +0 -432
- package/tsconfig.esm.json +0 -7
- package/tsconfig.json +0 -16
package/README.md
CHANGED
|
@@ -1,46 +1,120 @@
|
|
|
1
|
-
|
|
1
|
+
# @se-uulm/snowballr-api-client@0.2.1-alpha.07afd14
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A TypeScript SDK client for the localhost API.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
* Node.js
|
|
7
|
-
* Webpack
|
|
8
|
-
* Browserify
|
|
5
|
+
## Usage
|
|
9
6
|
|
|
10
|
-
|
|
11
|
-
* ES5 - you must have a Promises/A+ library installed
|
|
12
|
-
* ES6
|
|
7
|
+
First, install the SDK from npm.
|
|
13
8
|
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
9
|
+
```bash
|
|
10
|
+
npm install @se-uulm/snowballr-api-client --save
|
|
11
|
+
```
|
|
17
12
|
|
|
18
|
-
|
|
13
|
+
Next, try it out.
|
|
19
14
|
|
|
20
|
-
### Building
|
|
21
15
|
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
16
|
+
```ts
|
|
17
|
+
import {
|
|
18
|
+
Configuration,
|
|
19
|
+
ProjectsControllerApi,
|
|
20
|
+
} from '@se-uulm/snowballr-api-client';
|
|
21
|
+
import type { CreateProjectOperationRequest } 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 ProjectsControllerApi();
|
|
26
|
+
|
|
27
|
+
const body = {
|
|
28
|
+
// CreateProjectRequest
|
|
29
|
+
createProjectRequest: ...,
|
|
30
|
+
} satisfies CreateProjectOperationRequest;
|
|
31
|
+
|
|
32
|
+
try {
|
|
33
|
+
const data = await api.createProject(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
|
-
|
|
45
|
+
## Documentation
|
|
31
46
|
|
|
32
|
-
###
|
|
47
|
+
### API Endpoints
|
|
33
48
|
|
|
34
|
-
|
|
49
|
+
All URIs are relative to *http://localhost*
|
|
35
50
|
|
|
36
|
-
|
|
51
|
+
| Class | Method | HTTP request | Description
|
|
52
|
+
| ----- | ------ | ------------ | -------------
|
|
53
|
+
*ProjectsControllerApi* | [**createProject**](docs/ProjectsControllerApi.md#createprojectoperation) | **POST** /api/v1/projects |
|
|
54
|
+
*ProjectsControllerApi* | [**deleteProject**](docs/ProjectsControllerApi.md#deleteproject) | **DELETE** /api/v1/projects/{id} |
|
|
55
|
+
*ProjectsControllerApi* | [**getAllProjects**](docs/ProjectsControllerApi.md#getallprojects) | **GET** /api/v1/projects |
|
|
56
|
+
*ProjectsControllerApi* | [**getProject**](docs/ProjectsControllerApi.md#getproject) | **GET** /api/v1/projects/{id} |
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### Models
|
|
60
|
+
|
|
61
|
+
- [CreateProjectRequest](docs/CreateProjectRequest.md)
|
|
62
|
+
- [DecisionMatrixPattern](docs/DecisionMatrixPattern.md)
|
|
63
|
+
- [DecisionMatrixPatternEntry](docs/DecisionMatrixPatternEntry.md)
|
|
64
|
+
- [Project](docs/Project.md)
|
|
65
|
+
- [ProjectSettings](docs/ProjectSettings.md)
|
|
66
|
+
- [ReviewDecisionMatrix](docs/ReviewDecisionMatrix.md)
|
|
67
|
+
|
|
68
|
+
### Authorization
|
|
69
|
+
|
|
70
|
+
Endpoints do not require authorization.
|
|
37
71
|
|
|
38
|
-
```
|
|
39
|
-
npm install @se-uulm/snowballr-api-client@0.2.0 --save
|
|
40
|
-
```
|
|
41
72
|
|
|
42
|
-
|
|
73
|
+
## About
|
|
43
74
|
|
|
75
|
+
This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
|
|
76
|
+
and is automatically generated by the
|
|
77
|
+
[OpenAPI Generator](https://openapi-generator.tech) project:
|
|
78
|
+
|
|
79
|
+
- API version: `v1`
|
|
80
|
+
- Package version: `0.2.1-alpha.07afd14`
|
|
81
|
+
- Generator version: `7.26.0`
|
|
82
|
+
- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
|
|
83
|
+
|
|
84
|
+
The generated npm module supports the following:
|
|
85
|
+
|
|
86
|
+
- Environments
|
|
87
|
+
* Node.js
|
|
88
|
+
* Webpack
|
|
89
|
+
* Browserify
|
|
90
|
+
- Language levels
|
|
91
|
+
* ES5 - you must have a Promises/A+ library installed
|
|
92
|
+
* ES6
|
|
93
|
+
- Module systems
|
|
94
|
+
* CommonJS
|
|
95
|
+
* ES6 module system
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
## Development
|
|
99
|
+
|
|
100
|
+
### Building
|
|
101
|
+
|
|
102
|
+
To build the TypeScript source code, you need to have Node.js and npm installed.
|
|
103
|
+
After cloning the repository, navigate to the project directory and run:
|
|
104
|
+
|
|
105
|
+
```bash
|
|
106
|
+
npm install
|
|
107
|
+
npm run build
|
|
44
108
|
```
|
|
45
|
-
|
|
109
|
+
|
|
110
|
+
### Publishing
|
|
111
|
+
|
|
112
|
+
Once you've built the package, you can publish it to npm:
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
npm publish
|
|
46
116
|
```
|
|
117
|
+
|
|
118
|
+
## License
|
|
119
|
+
|
|
120
|
+
[]()
|
|
@@ -10,14 +10,24 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type
|
|
13
|
+
import { type CreateProjectRequest } from '../models/CreateProjectRequest';
|
|
14
|
+
import { type Project } from '../models/Project';
|
|
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<Project>;
|
|
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<Project>>;
|
|
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<Project>>;
|
|
81
122
|
/**
|
|
82
123
|
*/
|
|
83
124
|
createProject(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
|
|
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<Project>>>;
|
|
93
142
|
/**
|
|
94
143
|
*/
|
|
95
144
|
getAllProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
|
|
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<Project>>;
|
|
@@ -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.ProjectsControllerApi = void 0;
|
|
26
26
|
const runtime = require("../runtime");
|
|
27
|
-
const
|
|
27
|
+
const CreateProjectRequest_1 = require("../models/CreateProjectRequest");
|
|
28
|
+
const Project_1 = require("../models/Project");
|
|
28
29
|
/**
|
|
29
30
|
*
|
|
30
31
|
*/
|
|
31
32
|
class ProjectsControllerApi extends runtime.BaseAPI {
|
|
32
33
|
/**
|
|
34
|
+
* Creates request options for createProject without sending the request
|
|
33
35
|
*/
|
|
34
|
-
|
|
36
|
+
createProjectRequestOpts(requestParameters) {
|
|
35
37
|
return __awaiter(this, void 0, void 0, function* () {
|
|
36
38
|
if (requestParameters['createProjectRequest'] == null) {
|
|
37
39
|
throw new runtime.RequiredError('createProjectRequest', 'Required parameter "createProjectRequest" was null or undefined when calling createProject().');
|
|
@@ -39,15 +41,23 @@ class ProjectsControllerApi extends runtime.BaseAPI {
|
|
|
39
41
|
const queryParameters = {};
|
|
40
42
|
const headerParameters = {};
|
|
41
43
|
headerParameters['Content-Type'] = 'application/json';
|
|
42
|
-
let urlPath = `/projects`;
|
|
43
|
-
|
|
44
|
+
let urlPath = `/api/v1/projects`;
|
|
45
|
+
return {
|
|
44
46
|
path: urlPath,
|
|
45
47
|
method: 'POST',
|
|
46
48
|
headers: headerParameters,
|
|
47
49
|
query: queryParameters,
|
|
48
|
-
body: (0,
|
|
49
|
-
}
|
|
50
|
-
|
|
50
|
+
body: (0, CreateProjectRequest_1.CreateProjectRequestToJSON)(requestParameters['createProjectRequest']),
|
|
51
|
+
};
|
|
52
|
+
});
|
|
53
|
+
}
|
|
54
|
+
/**
|
|
55
|
+
*/
|
|
56
|
+
createProjectRaw(requestParameters, initOverrides) {
|
|
57
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
58
|
+
const requestOptions = yield this.createProjectRequestOpts(requestParameters);
|
|
59
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
60
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, Project_1.ProjectFromJSON)(jsonValue));
|
|
51
61
|
});
|
|
52
62
|
}
|
|
53
63
|
/**
|
|
@@ -59,22 +69,31 @@ class ProjectsControllerApi extends runtime.BaseAPI {
|
|
|
59
69
|
});
|
|
60
70
|
}
|
|
61
71
|
/**
|
|
72
|
+
* Creates request options for deleteProject without sending the request
|
|
62
73
|
*/
|
|
63
|
-
|
|
74
|
+
deleteProjectRequestOpts(requestParameters) {
|
|
64
75
|
return __awaiter(this, void 0, void 0, function* () {
|
|
65
76
|
if (requestParameters['id'] == null) {
|
|
66
77
|
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling deleteProject().');
|
|
67
78
|
}
|
|
68
79
|
const queryParameters = {};
|
|
69
80
|
const headerParameters = {};
|
|
70
|
-
let urlPath = `/projects/{id}`;
|
|
71
|
-
urlPath = urlPath.replace(
|
|
72
|
-
|
|
81
|
+
let urlPath = `/api/v1/projects/{id}`;
|
|
82
|
+
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
|
|
83
|
+
return {
|
|
73
84
|
path: urlPath,
|
|
74
85
|
method: 'DELETE',
|
|
75
86
|
headers: headerParameters,
|
|
76
87
|
query: queryParameters,
|
|
77
|
-
}
|
|
88
|
+
};
|
|
89
|
+
});
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
*/
|
|
93
|
+
deleteProjectRaw(requestParameters, initOverrides) {
|
|
94
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
95
|
+
const requestOptions = yield this.deleteProjectRequestOpts(requestParameters);
|
|
96
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
78
97
|
return new runtime.VoidApiResponse(response);
|
|
79
98
|
});
|
|
80
99
|
}
|
|
@@ -86,19 +105,28 @@ class ProjectsControllerApi extends runtime.BaseAPI {
|
|
|
86
105
|
});
|
|
87
106
|
}
|
|
88
107
|
/**
|
|
108
|
+
* Creates request options for getAllProjects without sending the request
|
|
89
109
|
*/
|
|
90
|
-
|
|
110
|
+
getAllProjectsRequestOpts() {
|
|
91
111
|
return __awaiter(this, void 0, void 0, function* () {
|
|
92
112
|
const queryParameters = {};
|
|
93
113
|
const headerParameters = {};
|
|
94
|
-
let urlPath = `/projects`;
|
|
95
|
-
|
|
114
|
+
let urlPath = `/api/v1/projects`;
|
|
115
|
+
return {
|
|
96
116
|
path: urlPath,
|
|
97
117
|
method: 'GET',
|
|
98
118
|
headers: headerParameters,
|
|
99
119
|
query: queryParameters,
|
|
100
|
-
}
|
|
101
|
-
|
|
120
|
+
};
|
|
121
|
+
});
|
|
122
|
+
}
|
|
123
|
+
/**
|
|
124
|
+
*/
|
|
125
|
+
getAllProjectsRaw(initOverrides) {
|
|
126
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
127
|
+
const requestOptions = yield this.getAllProjectsRequestOpts();
|
|
128
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
129
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(Project_1.ProjectFromJSON));
|
|
102
130
|
});
|
|
103
131
|
}
|
|
104
132
|
/**
|
|
@@ -110,23 +138,32 @@ class ProjectsControllerApi extends runtime.BaseAPI {
|
|
|
110
138
|
});
|
|
111
139
|
}
|
|
112
140
|
/**
|
|
141
|
+
* Creates request options for getProject without sending the request
|
|
113
142
|
*/
|
|
114
|
-
|
|
143
|
+
getProjectRequestOpts(requestParameters) {
|
|
115
144
|
return __awaiter(this, void 0, void 0, function* () {
|
|
116
145
|
if (requestParameters['id'] == null) {
|
|
117
146
|
throw new runtime.RequiredError('id', 'Required parameter "id" was null or undefined when calling getProject().');
|
|
118
147
|
}
|
|
119
148
|
const queryParameters = {};
|
|
120
149
|
const headerParameters = {};
|
|
121
|
-
let urlPath = `/projects/{id}`;
|
|
122
|
-
urlPath = urlPath.replace(
|
|
123
|
-
|
|
150
|
+
let urlPath = `/api/v1/projects/{id}`;
|
|
151
|
+
urlPath = urlPath.replace('{id}', encodeURIComponent(String(requestParameters['id'])));
|
|
152
|
+
return {
|
|
124
153
|
path: urlPath,
|
|
125
154
|
method: 'GET',
|
|
126
155
|
headers: headerParameters,
|
|
127
156
|
query: queryParameters,
|
|
128
|
-
}
|
|
129
|
-
|
|
157
|
+
};
|
|
158
|
+
});
|
|
159
|
+
}
|
|
160
|
+
/**
|
|
161
|
+
*/
|
|
162
|
+
getProjectRaw(requestParameters, initOverrides) {
|
|
163
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
164
|
+
const requestOptions = yield this.getProjectRequestOpts(requestParameters);
|
|
165
|
+
const response = yield this.request(requestOptions, initOverrides);
|
|
166
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => (0, Project_1.ProjectFromJSON)(jsonValue));
|
|
130
167
|
});
|
|
131
168
|
}
|
|
132
169
|
/**
|
|
@@ -10,14 +10,24 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import type
|
|
13
|
+
import { type CreateProjectRequest } from '../models/CreateProjectRequest';
|
|
14
|
+
import { type Project } from '../models/Project';
|
|
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<Project>;
|
|
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<Project>>;
|
|
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<Project>>;
|
|
81
122
|
/**
|
|
82
123
|
*/
|
|
83
124
|
createProject(requestParameters: CreateProjectOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Project>;
|
|
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<Project>>>;
|
|
93
142
|
/**
|
|
94
143
|
*/
|
|
95
144
|
getAllProjects(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Project>>;
|
|
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<Project>>;
|