1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
use octocrate_core::*;
#[allow(unused_imports)]
use octocrate_types::*;
/// Interact with GitHub Projects.
pub struct GitHubProjectsAPI {
config: SharedAPIConfig,
}
impl GitHubProjectsAPI {
pub fn new(config: &SharedAPIConfig) -> Self {
Self {
config: config.clone(),
}
}
/// **List organization projects**
///
/// Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
///
/// *Documentation*: [https://docs.github.com/rest/projects/projects#list-organization-projects](https://docs.github.com/rest/projects/projects#list-organization-projects)
pub fn list_for_org(
&self,
org: impl Into<String>,
) -> Request<(), ProjectsListForOrgQuery, ProjectArray> {
let org = org.into();
let url = format!("/orgs/{org}/projects");
Request::<(), ProjectsListForOrgQuery, ProjectArray>::builder(&self.config)
.get(url)
.build()
}
/// **Create an organization project**
///
/// Creates an organization project board. Returns a `410 Gone` status if projects are disabled in the organization or if the organization does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
///
/// *Documentation*: [https://docs.github.com/rest/projects/projects#create-an-organization-project](https://docs.github.com/rest/projects/projects#create-an-organization-project)
pub fn create_for_org(
&self,
org: impl Into<String>,
) -> Request<ProjectsCreateForOrgRequest, (), Project> {
let org = org.into();
let url = format!("/orgs/{org}/projects");
Request::<ProjectsCreateForOrgRequest, (), Project>::builder(&self.config)
.post(url)
.build()
}
/// **Get a project card**
///
/// Gets information about a project card.
///
/// *Documentation*: [https://docs.github.com/rest/projects/cards#get-a-project-card](https://docs.github.com/rest/projects/cards#get-a-project-card)
pub fn get_card(&self, card_id: impl Into<i64>) -> Request<(), (), ProjectCard> {
let card_id = card_id.into();
let url = format!("/projects/columns/cards/{card_id}");
Request::<(), (), ProjectCard>::builder(&self.config)
.get(url)
.build()
}
/// **Update an existing project card**
///
///
/// *Documentation*: [https://docs.github.com/rest/projects/cards#update-an-existing-project-card](https://docs.github.com/rest/projects/cards#update-an-existing-project-card)
pub fn update_card(
&self,
card_id: impl Into<i64>,
) -> Request<ProjectsUpdateCardRequest, (), ProjectCard> {
let card_id = card_id.into();
let url = format!("/projects/columns/cards/{card_id}");
Request::<ProjectsUpdateCardRequest, (), ProjectCard>::builder(&self.config)
.patch(url)
.build()
}
/// **Delete a project card**
///
/// Deletes a project card
///
/// *Documentation*: [https://docs.github.com/rest/projects/cards#delete-a-project-card](https://docs.github.com/rest/projects/cards#delete-a-project-card)
pub fn delete_card(&self, card_id: impl Into<i64>) -> NoContentRequest<(), ()> {
let card_id = card_id.into();
let url = format!("/projects/columns/cards/{card_id}");
NoContentRequest::<(), ()>::builder(&self.config)
.delete(url)
.build()
}
/// **Move a project card**
///
///
/// *Documentation*: [https://docs.github.com/rest/projects/cards#move-a-project-card](https://docs.github.com/rest/projects/cards#move-a-project-card)
pub fn move_card(
&self,
card_id: impl Into<i64>,
) -> Request<ProjectsMoveCardRequest, (), ProjectsMoveCardResponse> {
let card_id = card_id.into();
let url = format!("/projects/columns/cards/{card_id}/moves");
Request::<ProjectsMoveCardRequest, (), ProjectsMoveCardResponse>::builder(&self.config)
.post(url)
.build()
}
/// **Get a project column**
///
/// Gets information about a project column.
///
/// *Documentation*: [https://docs.github.com/rest/projects/columns#get-a-project-column](https://docs.github.com/rest/projects/columns#get-a-project-column)
pub fn get_column(&self, column_id: impl Into<i64>) -> Request<(), (), ProjectColumn> {
let column_id = column_id.into();
let url = format!("/projects/columns/{column_id}");
Request::<(), (), ProjectColumn>::builder(&self.config)
.get(url)
.build()
}
/// **Update an existing project column**
///
///
/// *Documentation*: [https://docs.github.com/rest/projects/columns#update-an-existing-project-column](https://docs.github.com/rest/projects/columns#update-an-existing-project-column)
pub fn update_column(
&self,
column_id: impl Into<i64>,
) -> Request<ProjectsUpdateColumnRequest, (), ProjectColumn> {
let column_id = column_id.into();
let url = format!("/projects/columns/{column_id}");
Request::<ProjectsUpdateColumnRequest, (), ProjectColumn>::builder(&self.config)
.patch(url)
.build()
}
/// **Delete a project column**
///
/// Deletes a project column.
///
/// *Documentation*: [https://docs.github.com/rest/projects/columns#delete-a-project-column](https://docs.github.com/rest/projects/columns#delete-a-project-column)
pub fn delete_column(&self, column_id: impl Into<i64>) -> NoContentRequest<(), ()> {
let column_id = column_id.into();
let url = format!("/projects/columns/{column_id}");
NoContentRequest::<(), ()>::builder(&self.config)
.delete(url)
.build()
}
/// **List project cards**
///
/// Lists the project cards in a project.
///
/// *Documentation*: [https://docs.github.com/rest/projects/cards#list-project-cards](https://docs.github.com/rest/projects/cards#list-project-cards)
pub fn list_cards(
&self,
column_id: impl Into<i64>,
) -> Request<(), ProjectsListCardsQuery, ProjectCardArray> {
let column_id = column_id.into();
let url = format!("/projects/columns/{column_id}/cards");
Request::<(), ProjectsListCardsQuery, ProjectCardArray>::builder(&self.config)
.get(url)
.build()
}
/// **Create a project card**
///
///
/// *Documentation*: [https://docs.github.com/rest/projects/cards#create-a-project-card](https://docs.github.com/rest/projects/cards#create-a-project-card)
pub fn create_card(
&self,
column_id: impl Into<i64>,
) -> Request<ProjectsCreateCardRequest, (), ProjectCard> {
let column_id = column_id.into();
let url = format!("/projects/columns/{column_id}/cards");
Request::<ProjectsCreateCardRequest, (), ProjectCard>::builder(&self.config)
.post(url)
.build()
}
/// **Move a project column**
///
///
/// *Documentation*: [https://docs.github.com/rest/projects/columns#move-a-project-column](https://docs.github.com/rest/projects/columns#move-a-project-column)
pub fn move_column(
&self,
column_id: impl Into<i64>,
) -> Request<ProjectsMoveColumnRequest, (), ProjectsMoveColumnResponse> {
let column_id = column_id.into();
let url = format!("/projects/columns/{column_id}/moves");
Request::<ProjectsMoveColumnRequest, (), ProjectsMoveColumnResponse>::builder(&self.config)
.post(url)
.build()
}
/// **Get a project**
///
/// Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
///
/// *Documentation*: [https://docs.github.com/rest/projects/projects#get-a-project](https://docs.github.com/rest/projects/projects#get-a-project)
pub fn get(&self, project_id: impl Into<i64>) -> Request<(), (), Project> {
let project_id = project_id.into();
let url = format!("/projects/{project_id}");
Request::<(), (), Project>::builder(&self.config)
.get(url)
.build()
}
/// **Update a project**
///
/// Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
///
/// *Documentation*: [https://docs.github.com/rest/projects/projects#update-a-project](https://docs.github.com/rest/projects/projects#update-a-project)
pub fn update(&self, project_id: impl Into<i64>) -> Request<ProjectsUpdateRequest, (), Project> {
let project_id = project_id.into();
let url = format!("/projects/{project_id}");
Request::<ProjectsUpdateRequest, (), Project>::builder(&self.config)
.patch(url)
.build()
}
/// **Delete a project**
///
/// Deletes a project board. Returns a `404 Not Found` status if projects are disabled.
///
/// *Documentation*: [https://docs.github.com/rest/projects/projects#delete-a-project](https://docs.github.com/rest/projects/projects#delete-a-project)
pub fn delete(&self, project_id: impl Into<i64>) -> NoContentRequest<(), ()> {
let project_id = project_id.into();
let url = format!("/projects/{project_id}");
NoContentRequest::<(), ()>::builder(&self.config)
.delete(url)
.build()
}
/// **List project collaborators**
///
/// Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.
///
/// *Documentation*: [https://docs.github.com/rest/projects/collaborators#list-project-collaborators](https://docs.github.com/rest/projects/collaborators#list-project-collaborators)
pub fn list_collaborators(
&self,
project_id: impl Into<i64>,
) -> Request<(), ProjectsListCollaboratorsQuery, SimpleUserArray> {
let project_id = project_id.into();
let url = format!("/projects/{project_id}/collaborators");
Request::<(), ProjectsListCollaboratorsQuery, SimpleUserArray>::builder(&self.config)
.get(url)
.build()
}
/// **Add project collaborator**
///
/// Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.
///
/// *Documentation*: [https://docs.github.com/rest/projects/collaborators#add-project-collaborator](https://docs.github.com/rest/projects/collaborators#add-project-collaborator)
pub fn add_collaborator(
&self,
project_id: impl Into<i64>,
username: impl Into<String>,
) -> NoContentRequest<ProjectsAddCollaboratorRequest, ()> {
let project_id = project_id.into();
let username = username.into();
let url = format!("/projects/{project_id}/collaborators/{username}");
NoContentRequest::<ProjectsAddCollaboratorRequest, ()>::builder(&self.config)
.put(url)
.build()
}
/// **Remove user as a collaborator**
///
/// Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.
///
/// *Documentation*: [https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator](https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator)
pub fn remove_collaborator(
&self,
project_id: impl Into<i64>,
username: impl Into<String>,
) -> NoContentRequest<(), ()> {
let project_id = project_id.into();
let username = username.into();
let url = format!("/projects/{project_id}/collaborators/{username}");
NoContentRequest::<(), ()>::builder(&self.config)
.delete(url)
.build()
}
/// **Get project permission for a user**
///
/// Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.
///
/// *Documentation*: [https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user](https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user)
pub fn get_permission_for_user(
&self,
project_id: impl Into<i64>,
username: impl Into<String>,
) -> Request<(), (), ProjectCollaboratorPermission> {
let project_id = project_id.into();
let username = username.into();
let url = format!("/projects/{project_id}/collaborators/{username}/permission");
Request::<(), (), ProjectCollaboratorPermission>::builder(&self.config)
.get(url)
.build()
}
/// **List project columns**
///
/// Lists the project columns in a project.
///
/// *Documentation*: [https://docs.github.com/rest/projects/columns#list-project-columns](https://docs.github.com/rest/projects/columns#list-project-columns)
pub fn list_columns(
&self,
project_id: impl Into<i64>,
) -> Request<(), ProjectsListColumnsQuery, ProjectColumnArray> {
let project_id = project_id.into();
let url = format!("/projects/{project_id}/columns");
Request::<(), ProjectsListColumnsQuery, ProjectColumnArray>::builder(&self.config)
.get(url)
.build()
}
/// **Create a project column**
///
/// Creates a new project column.
///
/// *Documentation*: [https://docs.github.com/rest/projects/columns#create-a-project-column](https://docs.github.com/rest/projects/columns#create-a-project-column)
pub fn create_column(
&self,
project_id: impl Into<i64>,
) -> Request<ProjectsCreateColumnRequest, (), ProjectColumn> {
let project_id = project_id.into();
let url = format!("/projects/{project_id}/columns");
Request::<ProjectsCreateColumnRequest, (), ProjectColumn>::builder(&self.config)
.post(url)
.build()
}
/// **List repository projects**
///
/// Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
///
/// *Documentation*: [https://docs.github.com/rest/projects/projects#list-repository-projects](https://docs.github.com/rest/projects/projects#list-repository-projects)
pub fn list_for_repo(
&self,
owner: impl Into<String>,
repo: impl Into<String>,
) -> Request<(), ProjectsListForRepoQuery, ProjectArray> {
let owner = owner.into();
let repo = repo.into();
let url = format!("/repos/{owner}/{repo}/projects");
Request::<(), ProjectsListForRepoQuery, ProjectArray>::builder(&self.config)
.get(url)
.build()
}
/// **Create a repository project**
///
/// Creates a repository project board. Returns a `410 Gone` status if projects are disabled in the repository or if the repository does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
///
/// *Documentation*: [https://docs.github.com/rest/projects/projects#create-a-repository-project](https://docs.github.com/rest/projects/projects#create-a-repository-project)
pub fn create_for_repo(
&self,
owner: impl Into<String>,
repo: impl Into<String>,
) -> Request<ProjectsCreateForRepoRequest, (), Project> {
let owner = owner.into();
let repo = repo.into();
let url = format!("/repos/{owner}/{repo}/projects");
Request::<ProjectsCreateForRepoRequest, (), Project>::builder(&self.config)
.post(url)
.build()
}
/// **Create a user project**
///
/// Creates a user project board. Returns a `410 Gone` status if the user does not have existing classic projects. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.
///
/// *Documentation*: [https://docs.github.com/rest/projects/projects#create-a-user-project](https://docs.github.com/rest/projects/projects#create-a-user-project)
pub fn create_for_authenticated_user(
&self,
) -> Request<ProjectsCreateForAuthenticatedUserRequest, (), Project> {
let url = format!("/user/projects");
Request::<ProjectsCreateForAuthenticatedUserRequest, (), Project>::builder(&self.config)
.post(url)
.build()
}
/// **List user projects**
///
/// Lists projects for a user.
///
/// *Documentation*: [https://docs.github.com/rest/projects/projects#list-user-projects](https://docs.github.com/rest/projects/projects#list-user-projects)
pub fn list_for_user(
&self,
username: impl Into<String>,
) -> Request<(), ProjectsListForUserQuery, ProjectArray> {
let username = username.into();
let url = format!("/users/{username}/projects");
Request::<(), ProjectsListForUserQuery, ProjectArray>::builder(&self.config)
.get(url)
.build()
}
}