-
-
Notifications
You must be signed in to change notification settings - Fork 16
/
DocCommentsService.ts
169 lines (162 loc) · 3.07 KB
/
DocCommentsService.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
/* generated using openapi-typescript-codegen -- do no edit */
/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import type { DocComment } from "../models/DocComment";
import type { BaseHttpRequest } from "../core/BaseHttpRequest";
import type { CancelablePromise } from "../core/CancelablePromise";
export class DocCommentsService {
constructor(
public readonly httpRequest: BaseHttpRequest,
) {}
/**
* Create a comment on a doc
* @returns any Success
* @throws ApiError
*/
public docCommentCreate({
channelId,
docId,
requestBody,
}: {
channelId: string;
docId: number;
requestBody: {
/**
* The content of the doc comment
*/
content: string;
};
}): CancelablePromise<{
docComment: DocComment;
}> {
return this.httpRequest.request(
{
method: "POST",
url: "/channels/{channelId}/docs/{docId}/comments",
path: {
channelId: channelId,
docId: docId,
},
body: requestBody,
mediaType: "application/json",
},
);
}
/**
* Get a doc's comments
* @returns any Success
* @throws ApiError
*/
public docCommentReadMany({
channelId,
docId,
}: {
channelId: string;
docId: number;
}): CancelablePromise<{
docComments: Array<DocComment>;
}> {
return this.httpRequest.request(
{
method: "GET",
url: "/channels/{channelId}/docs/{docId}/comments",
path: {
channelId: channelId,
docId: docId,
},
},
);
}
/**
* Get a comment on a doc
* @returns any Success
* @throws ApiError
*/
public docCommentRead({
channelId,
docId,
docCommentId,
}: {
channelId: string;
docId: number;
docCommentId: number;
}): CancelablePromise<{
docComment: DocComment;
}> {
return this.httpRequest.request(
{
method: "GET",
url: "/channels/{channelId}/docs/{docId}/comments/{docCommentId}",
path: {
channelId: channelId,
docId: docId,
docCommentId: docCommentId,
},
},
);
}
/**
* Update a doc comment
* @returns any Success
* @throws ApiError
*/
public docCommentUpdate({
channelId,
docId,
docCommentId,
requestBody,
}: {
channelId: string;
docId: number;
docCommentId: number;
requestBody: {
/**
* The content of the doc comment
*/
content: string;
};
}): CancelablePromise<{
docComment: DocComment;
}> {
return this.httpRequest.request(
{
method: "PATCH",
url: "/channels/{channelId}/docs/{docId}/comments/{docCommentId}",
path: {
channelId: channelId,
docId: docId,
docCommentId: docCommentId,
},
body: requestBody,
mediaType: "application/json",
},
);
}
/**
* Delete a doc comment
* @returns void
* @throws ApiError
*/
public docCommentDelete({
channelId,
docId,
docCommentId,
}: {
channelId: string;
docId: number;
docCommentId: number;
}): CancelablePromise<void> {
return this.httpRequest.request(
{
method: "DELETE",
url: "/channels/{channelId}/docs/{docId}/comments/{docCommentId}",
path: {
channelId: channelId,
docId: docId,
docCommentId: docCommentId,
},
},
);
}
}