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