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