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
//! The Projects API.
//!
//! # Notes
//! Users need an account with sufficient privileges to interact with projects.
mod projects;
use self::projects::{
CreateOrgProjectsBuilder, CreateRepositoryProjectsBuilder, CreateUserProjectBuilder,
DeleteProjectBuilder, GetProjectBuilder, ListOrgProjectsBuilder, ListRepositoryProjectsBuilder,
ListUserProjectsBuilder, NotNamed, UpdateProjectBuilder,
};
use crate::Octocrab;
use serde::Serialize;
/// A struct to access GitHub's projects API.
///
/// Created with [`Octocrab::projects`].
pub struct ProjectHandler<'octo> {
crab: &'octo Octocrab,
}
impl<'octo> ProjectHandler<'octo> {
pub(crate) fn new(crab: &'octo Octocrab) -> Self {
Self { crab }
}
/// Get a project by its id.
///
/// # Arguments
///
/// * `project_id` - id of the project to fetch
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let project_id: u32 = 1002604;
/// let project = octocrab::instance()
/// .projects()
/// .get_project(project_id)
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn get_project(&self, project_id: impl Into<u32>) -> GetProjectBuilder<'_, '_> {
GetProjectBuilder::new(self, project_id.into())
}
/// Updates a project given its project id.
///
/// # Arguments
///
/// * `project_id` - id of the project to update
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let body = serde_json::json!({ "name": "Week One Sprint", "state": "open" });
/// let project_id: u32 = 1002604;
/// let project = octocrab::instance()
/// .projects()
/// .update_project(project_id)
/// .body(&body)
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn update_project<B>(&self, project_id: impl Into<u32>) -> UpdateProjectBuilder<'_, '_, B>
where
B: Serialize + ?Sized,
{
UpdateProjectBuilder::new(self, project_id.into())
}
/// Deletes a project board.
///
/// # Arguments
///
/// * `project_id` - id of the project to delete
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let project_id: u32 = 1002604;
/// let project = octocrab::instance()
/// .projects()
/// .delete_project(project_id)
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn delete_project(&self, project_id: impl Into<u32>) -> DeleteProjectBuilder {
DeleteProjectBuilder::new(self, project_id.into())
}
/// Creates a user project board given its name.
///
/// # Arguments
///
/// * `username` - account username
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let username = "octocat";
/// let description = "Project Overview";
/// let project = octocrab::instance()
/// .projects()
/// .create_user_project(username)
/// .body(description)
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn create_user_project(&self, username: impl Into<String>) -> CreateUserProjectBuilder {
CreateUserProjectBuilder::new(self, username.into())
}
/// List a user's projects the username of the user
///
/// # Arguments
///
/// * `username` - account unsername
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let username = "octocat";
/// let project = octocrab::instance()
/// .projects()
/// .list_user_projects(username)
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn list_user_projects(&self, username: impl Into<String>) -> ListUserProjectsBuilder {
ListUserProjectsBuilder::new(self, username.into())
}
/// List the projects of an organization.
///
/// # Notes
/// Only users with sufficient privileges can list an organization's projects.
///
/// # Arguments
///
/// * `org` - name of the organization
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let org = "octocrab";
/// let projects = octocrab::instance()
/// .projects()
/// .list_organization_projects(org)
/// .state("all")
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn list_organization_projects(
&self,
org: impl Into<String>,
) -> ListOrgProjectsBuilder<'_, '_> {
ListOrgProjectsBuilder::new(self, org.into())
}
/// Create an organization project board.
///
/// # Arguments
///
/// * `org` - organization name.
/// * `name` - name of the project.
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let org = "octocrab";
/// let name = "Organization Roadmap";
/// let project = octocrab::instance()
/// .projects()
/// .create_organization_project(org, name)
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn create_organization_project(
&self,
org: impl Into<String>,
name: impl Into<String>,
) -> CreateOrgProjectsBuilder<'_, '_> {
CreateOrgProjectsBuilder::new(self, org.into(), name.into())
}
/// Creates a repository project board.
///
/// # Arguments
///
/// * `owner` - repository owner.
/// * `repo` - repository name.
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let owner = "octocat";
/// let repo = "octocrab";
/// let name = "My Project";
/// let description = "Project Overview";
/// let tags = octocrab::instance()
/// .projects()
/// .create_repository_project("owner", "repo")
/// .project_name(name)
/// .body(description)
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn create_repository_project(
&self,
owner: impl Into<String>,
repo: impl Into<String>,
) -> CreateRepositoryProjectsBuilder<'_, '_, NotNamed> {
CreateRepositoryProjectsBuilder::instantiate(self, owner.into(), repo.into())
}
/// Lists the projects in a repository.
///
/// # Arguments
///
/// * `owner` - repository owner.
/// * `repo` - repository name.
///
/// ```no_run
/// # async fn run() -> octocrab::Result<()> {
/// let owner = "octocat";
/// let repo = "octocrab";
/// let tags = octocrab::instance()
/// .projects()
/// .list_repository_projects("owner", "repo")
/// .send()
/// .await?;
/// # Ok(())
/// # }
/// ```
pub fn list_repository_projects(
&self,
owner: impl Into<String>,
repo: impl Into<String>,
) -> ListRepositoryProjectsBuilder<'_, '_> {
ListRepositoryProjectsBuilder::new(self, owner.into(), repo.into())
}
}