backlog-js 0.12.3 → 0.12.6
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/CHANGELOG.md +21 -0
- package/dist/backlog.js +628 -139
- package/dist/backlog.min.js +1 -1
- package/dist/types/backlog.d.ts +628 -0
- package/dist/types/entity.d.ts +23 -0
- package/dist/types/error.d.ts +37 -0
- package/dist/types/index.d.ts +6 -0
- package/dist/types/oauth2.d.ts +21 -0
- package/dist/types/option.d.ts +455 -0
- package/dist/types/request.d.ts +27 -0
- package/package.json +25 -23
- package/dist/backlog.d.ts +0 -750
|
@@ -0,0 +1,628 @@
|
|
|
1
|
+
import * as Option from './option';
|
|
2
|
+
import * as Entity from './entity';
|
|
3
|
+
import Request from './request';
|
|
4
|
+
export default class Backlog extends Request {
|
|
5
|
+
constructor(configure: {
|
|
6
|
+
host: string;
|
|
7
|
+
apiKey?: string;
|
|
8
|
+
accessToken?: string;
|
|
9
|
+
timeout?: number;
|
|
10
|
+
});
|
|
11
|
+
/**
|
|
12
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-space/
|
|
13
|
+
*/
|
|
14
|
+
getSpace(): Promise<any>;
|
|
15
|
+
/**
|
|
16
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-recent-updates/
|
|
17
|
+
*/
|
|
18
|
+
getSpaceActivities(params: Option.Space.GetActivitiesParams): Promise<any>;
|
|
19
|
+
/**
|
|
20
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-space-logo/
|
|
21
|
+
*/
|
|
22
|
+
getSpaceIcon(): Promise<Entity.File.FileData>;
|
|
23
|
+
/**
|
|
24
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-space-notification/
|
|
25
|
+
*/
|
|
26
|
+
getSpaceNotification(): Promise<any>;
|
|
27
|
+
/**
|
|
28
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-space-notification/
|
|
29
|
+
*/
|
|
30
|
+
putSpaceNotification(params: Option.Space.PutSpaceNotificationParams): Promise<any>;
|
|
31
|
+
/**
|
|
32
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-space-disk-usage/
|
|
33
|
+
*/
|
|
34
|
+
getSpaceDiskUsage(): Promise<any>;
|
|
35
|
+
/**
|
|
36
|
+
* https://developer.nulab.com/docs/backlog/api/2/post-attachment-file/
|
|
37
|
+
*/
|
|
38
|
+
postSpaceAttachment(form: FormData): Promise<any>;
|
|
39
|
+
/**
|
|
40
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-user-list/
|
|
41
|
+
*/
|
|
42
|
+
getUsers(): Promise<any>;
|
|
43
|
+
/**
|
|
44
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-user/
|
|
45
|
+
*/
|
|
46
|
+
getUser(userId: number): Promise<any>;
|
|
47
|
+
/**
|
|
48
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-user/
|
|
49
|
+
*/
|
|
50
|
+
postUser(params: Option.User.PostUserParams): Promise<any>;
|
|
51
|
+
/**
|
|
52
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-user/
|
|
53
|
+
*/
|
|
54
|
+
patchUser(userId: number, params: Option.User.PatchUserParams): Promise<any>;
|
|
55
|
+
/**
|
|
56
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-user/
|
|
57
|
+
*/
|
|
58
|
+
deleteUser(userId: number): Promise<any>;
|
|
59
|
+
/**
|
|
60
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-own-user/
|
|
61
|
+
*/
|
|
62
|
+
getMyself(): Promise<any>;
|
|
63
|
+
/**
|
|
64
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-user-icon/
|
|
65
|
+
*/
|
|
66
|
+
getUserIcon(userId: number): Promise<Entity.File.FileData>;
|
|
67
|
+
/**
|
|
68
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-user-recent-updates/
|
|
69
|
+
*/
|
|
70
|
+
getUserActivities(userId: number, params: Option.User.GetUserActivitiesParams): Promise<any>;
|
|
71
|
+
/**
|
|
72
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-received-star-list/
|
|
73
|
+
*/
|
|
74
|
+
getUserStars(userId: number, params: Option.User.GetUserStarsParams): Promise<any>;
|
|
75
|
+
/**
|
|
76
|
+
* https://developer.nulab.com/docs/backlog/api/2/count-user-received-stars/
|
|
77
|
+
*/
|
|
78
|
+
getUserStarsCount(userId: number, params: Option.User.GetUserStarsCountParams): Promise<any>;
|
|
79
|
+
/**
|
|
80
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-recently-viewed-issues/
|
|
81
|
+
*/
|
|
82
|
+
getRecentlyViewedIssues(params: Option.User.GetRecentlyViewedParams): Promise<any>;
|
|
83
|
+
/**
|
|
84
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-recently-viewed-projects/
|
|
85
|
+
*/
|
|
86
|
+
getRecentlyViewedProjects(params: Option.User.GetRecentlyViewedParams): Promise<any>;
|
|
87
|
+
/**
|
|
88
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-recently-viewed-wikis/
|
|
89
|
+
*/
|
|
90
|
+
getRecentlyViewedWikis(params: Option.User.GetRecentlyViewedParams): Promise<any>;
|
|
91
|
+
/**
|
|
92
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-groups/
|
|
93
|
+
* @deprecated
|
|
94
|
+
*/
|
|
95
|
+
getGroups(params: Option.Group.GetGroupsParams): Promise<any>;
|
|
96
|
+
/**
|
|
97
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-group/
|
|
98
|
+
* @deprecated
|
|
99
|
+
*/
|
|
100
|
+
postGroups(params: Option.Group.PostGroupsParams): Promise<any>;
|
|
101
|
+
/**
|
|
102
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-group/
|
|
103
|
+
* @deprecated
|
|
104
|
+
*/
|
|
105
|
+
getGroup(groupId: number): Promise<any>;
|
|
106
|
+
/**
|
|
107
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-group/
|
|
108
|
+
* @deprecated
|
|
109
|
+
*/
|
|
110
|
+
patchGroup(groupId: number, params: Option.Group.PatchGroupParams): Promise<any>;
|
|
111
|
+
/**
|
|
112
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-group/
|
|
113
|
+
* @deprecated
|
|
114
|
+
*/
|
|
115
|
+
deleteGroup(groupId: number): Promise<any>;
|
|
116
|
+
/**
|
|
117
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-status-list/
|
|
118
|
+
* @deprecated
|
|
119
|
+
*/
|
|
120
|
+
getStatuses(): Promise<any>;
|
|
121
|
+
/**
|
|
122
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-status-list-of-project/
|
|
123
|
+
*/
|
|
124
|
+
getProjectStatuses(projectIdOrKey: string | number): Promise<any>;
|
|
125
|
+
/**
|
|
126
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-resolution-list/
|
|
127
|
+
*/
|
|
128
|
+
getResolutions(): Promise<any>;
|
|
129
|
+
/**
|
|
130
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-priority-list/
|
|
131
|
+
*/
|
|
132
|
+
getPriorities(): Promise<any>;
|
|
133
|
+
/**
|
|
134
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-project-list/
|
|
135
|
+
*/
|
|
136
|
+
getProjects(params?: Option.Project.GetProjectsParams): Promise<any>;
|
|
137
|
+
/**
|
|
138
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-project/
|
|
139
|
+
*/
|
|
140
|
+
postProject(params: Option.Project.PostProjectParams): Promise<any>;
|
|
141
|
+
/**
|
|
142
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-project/
|
|
143
|
+
*/
|
|
144
|
+
getProject(projectIdOrKey: string | number): Promise<any>;
|
|
145
|
+
/**
|
|
146
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-project/
|
|
147
|
+
*/
|
|
148
|
+
patchProject(projectIdOrKey: string | number, params: Option.Project.PatchProjectParams): Promise<any>;
|
|
149
|
+
/**
|
|
150
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-project/
|
|
151
|
+
*/
|
|
152
|
+
deleteProject(projectIdOrKey: string | number): Promise<any>;
|
|
153
|
+
/**
|
|
154
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-project-icon/
|
|
155
|
+
*/
|
|
156
|
+
getProjectIcon(projectIdOrKey: string | number): Promise<Entity.File.FileData>;
|
|
157
|
+
/**
|
|
158
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-project-recent-updates/
|
|
159
|
+
*/
|
|
160
|
+
getProjectActivities(projectIdOrKey: string | number, params: Option.Space.GetActivitiesParams): Promise<any>;
|
|
161
|
+
/**
|
|
162
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-project-user/
|
|
163
|
+
*/
|
|
164
|
+
postProjectUser(projectIdOrKey: string | number, userId: string): Promise<any>;
|
|
165
|
+
/**
|
|
166
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-project-user-list/
|
|
167
|
+
*/
|
|
168
|
+
getProjectUsers(projectIdOrKey: string | number): Promise<any>;
|
|
169
|
+
/**
|
|
170
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-project-user/
|
|
171
|
+
*/
|
|
172
|
+
deleteProjectUsers(projectIdOrKey: string | number, params: Option.Project.DeleteProjectUsersParams): Promise<any>;
|
|
173
|
+
/**
|
|
174
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-project-administrator/
|
|
175
|
+
*/
|
|
176
|
+
postProjectAdministrators(projectIdOrKey: string | number, params: Option.Project.PostProjectAdministrators): Promise<any>;
|
|
177
|
+
/**
|
|
178
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-project-administrators/
|
|
179
|
+
*/
|
|
180
|
+
getProjectAdministrators(projectIdOrKey: string | number): Promise<any>;
|
|
181
|
+
/**
|
|
182
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-project-administrator/
|
|
183
|
+
*/
|
|
184
|
+
deleteProjectAdministrators(projectIdOrKey: string | number, params: Option.Project.DeleteProjectAdministrators): Promise<any>;
|
|
185
|
+
/**
|
|
186
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-status/
|
|
187
|
+
*/
|
|
188
|
+
postProjectStatus(projectIdOrKey: string | number, params: Option.Project.PostStatusParams): Promise<any>;
|
|
189
|
+
/**
|
|
190
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-status/
|
|
191
|
+
*/
|
|
192
|
+
patchProjectStatus(projectIdOrKey: string | number, id: number, params: Option.Project.PatchStatusParams): Promise<any>;
|
|
193
|
+
/**
|
|
194
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-status/
|
|
195
|
+
*/
|
|
196
|
+
deleteProjectStatus(projectIdOrKey: string | number, id: number, substituteStatusId: number): Promise<any>;
|
|
197
|
+
/**
|
|
198
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-order-of-status/
|
|
199
|
+
*/
|
|
200
|
+
patchProjectStatusOrder(projectIdOrKey: string | number, statusId: number[]): Promise<any>;
|
|
201
|
+
/**
|
|
202
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-issue-type-list/
|
|
203
|
+
*/
|
|
204
|
+
getIssueTypes(projectIdOrKey: string | number): Promise<any>;
|
|
205
|
+
/**
|
|
206
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-issue-type/
|
|
207
|
+
*/
|
|
208
|
+
postIssueType(projectIdOrKey: string | number, params: Option.Project.PostIssueTypeParams): Promise<any>;
|
|
209
|
+
/**
|
|
210
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-issue-type/
|
|
211
|
+
*/
|
|
212
|
+
patchIssueType(projectIdOrKey: string | number, id: number, params: Option.Project.PatchIssueTypeParams): Promise<any>;
|
|
213
|
+
/**
|
|
214
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-issue-type/
|
|
215
|
+
*/
|
|
216
|
+
deleteIssueType(projectIdOrKey: string | number, id: number, params: Option.Project.DeleteIssueTypeParams): Promise<any>;
|
|
217
|
+
/**
|
|
218
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-category-list/
|
|
219
|
+
*/
|
|
220
|
+
getCategories(projectIdOrKey: string | number): Promise<any>;
|
|
221
|
+
/**
|
|
222
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-category/
|
|
223
|
+
*/
|
|
224
|
+
postCategories(projectIdOrKey: string | number, params: Option.Project.PostCategoriesParams): Promise<any>;
|
|
225
|
+
/**
|
|
226
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-category/
|
|
227
|
+
*/
|
|
228
|
+
patchCategories(projectIdOrKey: string | number, id: number, params: Option.Project.PatchCategoriesParams): Promise<any>;
|
|
229
|
+
/**
|
|
230
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-category/
|
|
231
|
+
*/
|
|
232
|
+
deleteCategories(projectIdOrKey: string | number, id: number): Promise<any>;
|
|
233
|
+
/**
|
|
234
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-version-milestone-list/
|
|
235
|
+
*/
|
|
236
|
+
getVersions(projectIdOrKey: string | number): Promise<any>;
|
|
237
|
+
/**
|
|
238
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-version-milestone/
|
|
239
|
+
*/
|
|
240
|
+
postVersions(projectIdOrKey: string | number, params: Option.Project.PostVersionsParams): Promise<any>;
|
|
241
|
+
/**
|
|
242
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-version-milestone/
|
|
243
|
+
*/
|
|
244
|
+
patchVersions(projectIdOrKey: string | number, id: number, params: Option.Project.PatchVersionsParams): Promise<any>;
|
|
245
|
+
/**
|
|
246
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-version/
|
|
247
|
+
*/
|
|
248
|
+
deleteVersions(projectIdOrKey: string | number, id: number): Promise<any>;
|
|
249
|
+
/**
|
|
250
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-custom-field-list/
|
|
251
|
+
*/
|
|
252
|
+
getCustomFields(projectIdOrKey: string | number): Promise<any>;
|
|
253
|
+
/**
|
|
254
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-custom-field/
|
|
255
|
+
*/
|
|
256
|
+
postCustomField(projectIdOrKey: string | number, params: Option.Project.PostCustomFieldParams | Option.Project.PostCustomFieldWithNumericParams | Option.Project.PostCustomFieldWithDateParams | Option.Project.PostCustomFieldWithListParams): Promise<any>;
|
|
257
|
+
/**
|
|
258
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-custom-field/
|
|
259
|
+
*/
|
|
260
|
+
patchCustomField(projectIdOrKey: string | number, id: number, params: Option.Project.PatchCustomFieldParams | Option.Project.PatchCustomFieldWithNumericParams | Option.Project.PatchCustomFieldWithDateParams | Option.Project.PatchCustomFieldWithListParams): Promise<any>;
|
|
261
|
+
/**
|
|
262
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-custom-field/
|
|
263
|
+
*/
|
|
264
|
+
deleteCustomField(projectIdOrKey: string | number, id: number): Promise<any>;
|
|
265
|
+
/**
|
|
266
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-list-item-for-list-type-custom-field/
|
|
267
|
+
*/
|
|
268
|
+
postCustomFieldItem(projectIdOrKey: string | number, id: number, params: Option.Project.PostCustomFieldItemParams): Promise<any>;
|
|
269
|
+
/**
|
|
270
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-list-item-for-list-type-custom-field/
|
|
271
|
+
*/
|
|
272
|
+
patchCustomFieldItem(projectIdOrKey: string | number, id: number, itemId: number, params: Option.Project.PatchCustomFieldItemParams): Promise<any>;
|
|
273
|
+
/**
|
|
274
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-list-item-for-list-type-custom-field/
|
|
275
|
+
*/
|
|
276
|
+
deleteCustomFieldItem(projectIdOrKey: string | number, id: number, itemId: number): Promise<any>;
|
|
277
|
+
/**
|
|
278
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-shared-files/
|
|
279
|
+
*/
|
|
280
|
+
getSharedFiles(projectIdOrKey: string | number, path: string, params: Option.Project.GetSharedFilesParams): Promise<any>;
|
|
281
|
+
/**
|
|
282
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-file/
|
|
283
|
+
*/
|
|
284
|
+
getSharedFile(projectIdOrKey: string | number, sharedFileId: number): Promise<Entity.File.FileData>;
|
|
285
|
+
/**
|
|
286
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-project-disk-usage/
|
|
287
|
+
*/
|
|
288
|
+
getProjectsDiskUsage(projectIdOrKey: string | number): Promise<any>;
|
|
289
|
+
/**
|
|
290
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-webhooks/
|
|
291
|
+
*/
|
|
292
|
+
getWebhooks(projectIdOrKey: string | number): Promise<any>;
|
|
293
|
+
/**
|
|
294
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-webhook/
|
|
295
|
+
*/
|
|
296
|
+
postWebhook(projectIdOrKey: string | number, params: Option.Project.PostWebhookParams): Promise<any>;
|
|
297
|
+
/**
|
|
298
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-webhook/
|
|
299
|
+
*/
|
|
300
|
+
getWebhook(projectIdOrKey: string | number, webhookId: string): Promise<any>;
|
|
301
|
+
/**
|
|
302
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-webhook/
|
|
303
|
+
*/
|
|
304
|
+
patchWebhook(projectIdOrKey: string | number, webhookId: string, params: Option.Project.PatchWebhookParams): Promise<any>;
|
|
305
|
+
/**
|
|
306
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-webhook/
|
|
307
|
+
*/
|
|
308
|
+
deleteWebhook(projectIdOrKey: string | number, webhookId: string): Promise<any>;
|
|
309
|
+
/**
|
|
310
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-issue-list/
|
|
311
|
+
*/
|
|
312
|
+
getIssues(params?: Option.Issue.GetIssuesParams): Promise<any>;
|
|
313
|
+
/**
|
|
314
|
+
* https://developer.nulab.com/docs/backlog/api/2/count-issue/
|
|
315
|
+
*/
|
|
316
|
+
getIssuesCount(params?: Option.Issue.GetIssuesParams): Promise<any>;
|
|
317
|
+
/**
|
|
318
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-issue/
|
|
319
|
+
*/
|
|
320
|
+
postIssue(params: Option.Issue.PostIssueParams): Promise<any>;
|
|
321
|
+
/**
|
|
322
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-issue/
|
|
323
|
+
*/
|
|
324
|
+
patchIssue(issueIdOrKey: string | number, params: Option.Issue.PatchIssueParams): Promise<any>;
|
|
325
|
+
/**
|
|
326
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-issue/
|
|
327
|
+
*/
|
|
328
|
+
getIssue(issueIdOrKey: string | number): Promise<any>;
|
|
329
|
+
/**
|
|
330
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-issue/
|
|
331
|
+
*/
|
|
332
|
+
deleteIssuesCount(issueIdOrKey: string | number): Promise<any>;
|
|
333
|
+
/**
|
|
334
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-comment-list/
|
|
335
|
+
*/
|
|
336
|
+
getIssueComments(issueIdOrKey: string | number, params: Option.Issue.GetIssueCommentsParams): Promise<any>;
|
|
337
|
+
/**
|
|
338
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-comment/
|
|
339
|
+
*/
|
|
340
|
+
postIssueComments(issueIdOrKey: string | number, params: Option.Issue.PostIssueCommentsParams): Promise<any>;
|
|
341
|
+
/**
|
|
342
|
+
* https://developer.nulab.com/docs/backlog/api/2/count-comment/
|
|
343
|
+
*/
|
|
344
|
+
getIssueCommentsCount(issueIdOrKey: string | number): Promise<any>;
|
|
345
|
+
/**
|
|
346
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-comment/
|
|
347
|
+
*/
|
|
348
|
+
getIssueComment(issueIdOrKey: string | number, commentId: number): Promise<any>;
|
|
349
|
+
/**
|
|
350
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-comment/
|
|
351
|
+
*/
|
|
352
|
+
deleteIssueComment(issueIdOrKey: string | number, commentId: number): Promise<any>;
|
|
353
|
+
/**
|
|
354
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-comment/
|
|
355
|
+
*/
|
|
356
|
+
patchIssueComment(issueIdOrKey: string | number, commentId: number, params: Option.Issue.PatchIssueCommentParams): Promise<any>;
|
|
357
|
+
/**
|
|
358
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-comment-notifications/
|
|
359
|
+
*/
|
|
360
|
+
getIssueCommentNotifications(issueIdOrKey: string | number, commentId: number): Promise<any>;
|
|
361
|
+
/**
|
|
362
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-comment-notification/
|
|
363
|
+
*/
|
|
364
|
+
postIssueCommentNotifications(issueIdOrKey: string | number, commentId: number, prams: Option.Issue.IssueCommentNotifications): Promise<any>;
|
|
365
|
+
/**
|
|
366
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-issue-attachments/
|
|
367
|
+
*/
|
|
368
|
+
getIssueAttachments(issueIdOrKey: string | number): Promise<any>;
|
|
369
|
+
/**
|
|
370
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-issue-attachment/
|
|
371
|
+
*/
|
|
372
|
+
getIssueAttachment(issueIdOrKey: string | number, attachmentId: number): Promise<Entity.File.FileData>;
|
|
373
|
+
/**
|
|
374
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-issue-attachment/
|
|
375
|
+
*/
|
|
376
|
+
deleteIssueAttachment(issueIdOrKey: string | number, attachmentId: string): Promise<any>;
|
|
377
|
+
/**
|
|
378
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-issue-participant-list/
|
|
379
|
+
*/
|
|
380
|
+
getIssueParticipants(issueIdOrKey: string | number): Promise<any>;
|
|
381
|
+
/**
|
|
382
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-linked-shared-files/
|
|
383
|
+
*/
|
|
384
|
+
getIssueSharedFiles(issueIdOrKey: string | number): Promise<any>;
|
|
385
|
+
/**
|
|
386
|
+
* https://developer.nulab.com/docs/backlog/api/2/link-shared-files-to-issue/
|
|
387
|
+
*/
|
|
388
|
+
linkIssueSharedFiles(issueIdOrKey: string | number, params: Option.Issue.LinkIssueSharedFilesParams): Promise<any>;
|
|
389
|
+
/**
|
|
390
|
+
* https://developer.nulab.com/docs/backlog/api/2/remove-link-to-shared-file-from-issue/
|
|
391
|
+
*/
|
|
392
|
+
unlinkIssueSharedFile(issueIdOrKey: string | number, id: number): Promise<any>;
|
|
393
|
+
/**
|
|
394
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-list/
|
|
395
|
+
*/
|
|
396
|
+
getWikis(params: Option.Wiki.GetWikiParams): Promise<any>;
|
|
397
|
+
/**
|
|
398
|
+
* https://developer.nulab.com/docs/backlog/api/2/count-wiki-page/
|
|
399
|
+
*/
|
|
400
|
+
getWikisCount(projectIdOrKey: string | number): Promise<any>;
|
|
401
|
+
/**
|
|
402
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-tag-list/
|
|
403
|
+
*/
|
|
404
|
+
getWikisTags(projectIdOrKey: string | number): Promise<any>;
|
|
405
|
+
/**
|
|
406
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-wiki-page/
|
|
407
|
+
*/
|
|
408
|
+
postWiki(params: Option.Wiki.PostWikiParams): Promise<any>;
|
|
409
|
+
/**
|
|
410
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-wiki-page/
|
|
411
|
+
*/
|
|
412
|
+
getWiki(wikiId: number): Promise<any>;
|
|
413
|
+
/**
|
|
414
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-wiki-page/
|
|
415
|
+
*/
|
|
416
|
+
patchWiki(wikiId: number, params: Option.Wiki.PatchWikiParams): Promise<any>;
|
|
417
|
+
/**
|
|
418
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-wiki-page/
|
|
419
|
+
*/
|
|
420
|
+
deleteWiki(wikiId: number, mailNotify: boolean): Promise<any>;
|
|
421
|
+
/**
|
|
422
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-wiki-attachments/
|
|
423
|
+
*/
|
|
424
|
+
getWikisAttachments(wikiId: number): Promise<any>;
|
|
425
|
+
/**
|
|
426
|
+
* https://developer.nulab.com/docs/backlog/api/2/attach-file-to-wiki/
|
|
427
|
+
*/
|
|
428
|
+
postWikisAttachments(wikiId: number, attachmentId: number[]): Promise<any>;
|
|
429
|
+
/**
|
|
430
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-attachment/
|
|
431
|
+
*/
|
|
432
|
+
getWikiAttachment(wikiId: number, attachmentId: number): Promise<Entity.File.FileData>;
|
|
433
|
+
/**
|
|
434
|
+
* https://developer.nulab.com/docs/backlog/api/2/remove-wiki-attachment/
|
|
435
|
+
*/
|
|
436
|
+
deleteWikisAttachments(wikiId: number, attachmentId: number): Promise<any>;
|
|
437
|
+
/**
|
|
438
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-shared-files-on-wiki/
|
|
439
|
+
*/
|
|
440
|
+
getWikisSharedFiles(wikiId: number): Promise<any>;
|
|
441
|
+
/**
|
|
442
|
+
* https://developer.nulab.com/docs/backlog/api/2/link-shared-files-to-wiki/
|
|
443
|
+
*/
|
|
444
|
+
linkWikisSharedFiles(wikiId: number, fileId: number[]): Promise<any>;
|
|
445
|
+
/**
|
|
446
|
+
* https://developer.nulab.com/docs/backlog/api/2/remove-link-to-shared-file-from-wiki/
|
|
447
|
+
*/
|
|
448
|
+
unlinkWikisSharedFiles(wikiId: number, id: number): Promise<any>;
|
|
449
|
+
/**
|
|
450
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-history/
|
|
451
|
+
*/
|
|
452
|
+
getWikisHistory(wikiId: number, params: Option.Wiki.GetWikisHistoryParams): Promise<any>;
|
|
453
|
+
/**
|
|
454
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-wiki-page-star/
|
|
455
|
+
*/
|
|
456
|
+
getWikisStars(wikiId: number): Promise<any>;
|
|
457
|
+
/**
|
|
458
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-star/
|
|
459
|
+
*/
|
|
460
|
+
postStar(params: Option.Project.PostStarParams): Promise<any>;
|
|
461
|
+
/**
|
|
462
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-notification/
|
|
463
|
+
*/
|
|
464
|
+
getNotifications(params: Option.Notification.GetNotificationsParams): Promise<any>;
|
|
465
|
+
/**
|
|
466
|
+
* https://developer.nulab.com/docs/backlog/api/2/count-notification/
|
|
467
|
+
*/
|
|
468
|
+
getNotificationsCount(params: Option.Notification.GetNotificationsCountParams): Promise<any>;
|
|
469
|
+
/**
|
|
470
|
+
* https://developer.nulab.com/docs/backlog/api/2/reset-unread-notification-count/
|
|
471
|
+
*/
|
|
472
|
+
resetNotificationsMarkAsRead(): Promise<any>;
|
|
473
|
+
/**
|
|
474
|
+
* https://developer.nulab.com/docs/backlog/api/2/read-notification/
|
|
475
|
+
*/
|
|
476
|
+
markAsReadNotification(id: number): Promise<any>;
|
|
477
|
+
/**
|
|
478
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-git-repositories/
|
|
479
|
+
*/
|
|
480
|
+
getGitRepositories(projectIdOrKey: string | number): Promise<any>;
|
|
481
|
+
/**
|
|
482
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-git-repository/
|
|
483
|
+
*/
|
|
484
|
+
getGitRepository(projectIdOrKey: string | number, repoIdOrName: string): Promise<any>;
|
|
485
|
+
/**
|
|
486
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-pull-request-list/
|
|
487
|
+
*/
|
|
488
|
+
getPullRequests(projectIdOrKey: string | number, repoIdOrName: string, params: Option.PullRequest.GetPullRequestsParams): Promise<any>;
|
|
489
|
+
/**
|
|
490
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-number-of-pull-requests/
|
|
491
|
+
*/
|
|
492
|
+
getPullRequestsCount(projectIdOrKey: string | number, repoIdOrName: string, params: Option.PullRequest.GetPullRequestsParams): Promise<any>;
|
|
493
|
+
/**
|
|
494
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-pull-request/
|
|
495
|
+
*/
|
|
496
|
+
postPullRequest(projectIdOrKey: string | number, repoIdOrName: string, params: Option.PullRequest.PostPullRequestParams): Promise<any>;
|
|
497
|
+
/**
|
|
498
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-pull-request/
|
|
499
|
+
*/
|
|
500
|
+
getPullRequest(projectIdOrKey: string | number, repoIdOrName: string, number: number): Promise<any>;
|
|
501
|
+
/**
|
|
502
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-pull-request/
|
|
503
|
+
*/
|
|
504
|
+
patchPullRequest(projectIdOrKey: string | number, repoIdOrName: string, number: number, params: Option.PullRequest.PatchPullRequestParams): Promise<any>;
|
|
505
|
+
/**
|
|
506
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-pull-request-comment/
|
|
507
|
+
*/
|
|
508
|
+
getPullRequestComments(projectIdOrKey: string | number, repoIdOrName: string, number: number, params: Option.PullRequest.GetPullRequestCommentsParams): Promise<any>;
|
|
509
|
+
/**
|
|
510
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-pull-request-comment/
|
|
511
|
+
*/
|
|
512
|
+
postPullRequestComments(projectIdOrKey: string | number, repoIdOrName: string, number: number, params: Option.PullRequest.PostPullRequestCommentsParams): Promise<any>;
|
|
513
|
+
/**
|
|
514
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-number-of-pull-request-comments/
|
|
515
|
+
*/
|
|
516
|
+
getPullRequestCommentsCount(projectIdOrKey: string | number, repoIdOrName: string, number: number): Promise<any>;
|
|
517
|
+
/**
|
|
518
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-pull-request-comment-information/
|
|
519
|
+
*/
|
|
520
|
+
patchPullRequestComments(projectIdOrKey: string | number, repoIdOrName: string, number: number, commentId: number, params: Option.PullRequest.PatchPullRequestCommentsParams): Promise<any>;
|
|
521
|
+
/**
|
|
522
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-pull-request-attachment/
|
|
523
|
+
*/
|
|
524
|
+
getPullRequestAttachments(projectIdOrKey: string | number, repoIdOrName: string, number: number): Promise<any>;
|
|
525
|
+
/**
|
|
526
|
+
* https://developer.nulab.com/docs/backlog/api/2/download-pull-request-attachment/
|
|
527
|
+
*/
|
|
528
|
+
getPullRequestAttachment(projectIdOrKey: string | number, repoIdOrName: string, number: number, attachmentId: number): Promise<Entity.File.FileData>;
|
|
529
|
+
/**
|
|
530
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-pull-request-attachments/
|
|
531
|
+
*/
|
|
532
|
+
deletePullRequestAttachment(projectIdOrKey: string | number, repoIdOrName: string, number: number, attachmentId: number): Promise<any>;
|
|
533
|
+
/**
|
|
534
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-watching-list
|
|
535
|
+
*/
|
|
536
|
+
getWatchingListItems(userId: number): Promise<any>;
|
|
537
|
+
/**
|
|
538
|
+
* https://developer.nulab.com/docs/backlog/api/2/count-watching
|
|
539
|
+
*/
|
|
540
|
+
getWatchingListCount(userId: number): Promise<any>;
|
|
541
|
+
/**
|
|
542
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-watching
|
|
543
|
+
*/
|
|
544
|
+
getWatchingListItem(watchId: number): Promise<any>;
|
|
545
|
+
/**
|
|
546
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-watching
|
|
547
|
+
*/
|
|
548
|
+
postWatchingListItem(params: any): Promise<any>;
|
|
549
|
+
/**
|
|
550
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-watching
|
|
551
|
+
*/
|
|
552
|
+
patchWatchingListItem(watchId: number, note: string): Promise<any>;
|
|
553
|
+
/**
|
|
554
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-watching
|
|
555
|
+
*/
|
|
556
|
+
deletehWatchingListItem(watchId: number): Promise<any>;
|
|
557
|
+
/**
|
|
558
|
+
* https://developer.nulab.com/docs/backlog/api/2/mark-watching-as-read
|
|
559
|
+
*/
|
|
560
|
+
resetWatchingListItemAsRead(watchId: number): Promise<undefined>;
|
|
561
|
+
/**
|
|
562
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-project-group-list
|
|
563
|
+
* @deprecated
|
|
564
|
+
*/
|
|
565
|
+
getProjectGroupList(projectIdOrKey: string | number): Promise<any>;
|
|
566
|
+
/**
|
|
567
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-project-group
|
|
568
|
+
* @deprecated
|
|
569
|
+
*/
|
|
570
|
+
postProjectGroup(projectIdOrKey: string | number, params: any): Promise<any>;
|
|
571
|
+
/**
|
|
572
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-project-group
|
|
573
|
+
* @deprecated
|
|
574
|
+
*/
|
|
575
|
+
deleteProjectGroup(projectIdOrKey: string | number): Promise<any>;
|
|
576
|
+
/**
|
|
577
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-group-icon
|
|
578
|
+
* @deprecated
|
|
579
|
+
*/
|
|
580
|
+
getGroupIcon(groupId: string): Promise<any>;
|
|
581
|
+
/**
|
|
582
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-licence
|
|
583
|
+
*/
|
|
584
|
+
getLicence(): Promise<any>;
|
|
585
|
+
/**
|
|
586
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-list-of-teams/
|
|
587
|
+
*/
|
|
588
|
+
getTeams(params?: Option.Team.GetTeamsParams): Promise<any>;
|
|
589
|
+
/**
|
|
590
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-team/
|
|
591
|
+
*/
|
|
592
|
+
postTeam(members: number[]): Promise<any>;
|
|
593
|
+
/**
|
|
594
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-team/
|
|
595
|
+
*/
|
|
596
|
+
getTeam(teamId: number): Promise<any>;
|
|
597
|
+
/**
|
|
598
|
+
* https://developer.nulab.com/docs/backlog/api/2/update-team/
|
|
599
|
+
*/
|
|
600
|
+
patchTeam(teamId: number, params: Option.Team.PatchTeamParams): Promise<any>;
|
|
601
|
+
/**
|
|
602
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-team/
|
|
603
|
+
*/
|
|
604
|
+
deleteTeam(teamId: number): Promise<any>;
|
|
605
|
+
/**
|
|
606
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-team-icon/
|
|
607
|
+
*/
|
|
608
|
+
getTeamIcon(teamId: number): Promise<Entity.File.FileData>;
|
|
609
|
+
/**
|
|
610
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-project-team-list/
|
|
611
|
+
*/
|
|
612
|
+
getProjectTeams(projectIdOrKey: string | number): Promise<any>;
|
|
613
|
+
/**
|
|
614
|
+
* https://developer.nulab.com/docs/backlog/api/2/add-project-team/
|
|
615
|
+
*/
|
|
616
|
+
postProjectTeam(projectIdOrKey: string | number, teamId: number): Promise<any>;
|
|
617
|
+
/**
|
|
618
|
+
* https://developer.nulab.com/docs/backlog/api/2/delete-project-team/
|
|
619
|
+
*/
|
|
620
|
+
deleteProjectTeam(projectIdOrKey: string | number, teamId: number): Promise<any>;
|
|
621
|
+
/**
|
|
622
|
+
* https://developer.nulab.com/docs/backlog/api/2/get-rate-limit/
|
|
623
|
+
*/
|
|
624
|
+
getRateLimit(): Promise<any>;
|
|
625
|
+
private download;
|
|
626
|
+
private upload;
|
|
627
|
+
private parseFileData;
|
|
628
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
/// <reference types="node" />
|
|
2
|
+
import { PassThrough } from 'stream';
|
|
3
|
+
export declare namespace File {
|
|
4
|
+
type FileData = NodeFileData | BrowserFileData;
|
|
5
|
+
interface NodeFileData {
|
|
6
|
+
body: PassThrough;
|
|
7
|
+
url: string;
|
|
8
|
+
filename: string;
|
|
9
|
+
}
|
|
10
|
+
interface BrowserFileData {
|
|
11
|
+
body: any;
|
|
12
|
+
url: string;
|
|
13
|
+
blob?: () => Promise<Blob>;
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
export declare namespace OAuth2 {
|
|
17
|
+
interface AccessToken {
|
|
18
|
+
access_token: string;
|
|
19
|
+
token_type: string;
|
|
20
|
+
expires_in: number;
|
|
21
|
+
refresh_token: string;
|
|
22
|
+
}
|
|
23
|
+
}
|