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
//! The Teams API mod children; mod create; mod edit; mod list; mod team_repos; pub use self::{ children::ListChildTeamsBuilder, create::CreateTeamBuilder, edit::EditTeamBuilder, list::ListTeamsBuilder, team_repos::TeamRepoHandler, }; use crate::{models, Octocrab, Result}; /// Handler for GitHub's teams API. /// /// Created with [`Octocrab::teams`]. /// /// [`Octocrab::teams`]: ../struct.Octocrab.html#method.teams pub struct TeamHandler<'octo> { crab: &'octo Octocrab, owner: String, } impl<'octo> TeamHandler<'octo> { pub(crate) fn new(crab: &'octo Octocrab, owner: String) -> Self { Self { crab, owner } } /// Lists teams in the organization. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let teams = octocrab::instance() /// .teams("owner") /// .list() /// .per_page(10) /// .page(1u8) /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn list(&self) -> ListTeamsBuilder<'_, '_> { ListTeamsBuilder::new(self) } /// Gets a team from its slug. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// let team = octocrab::instance() /// .teams("owner") /// .get("team") /// .await?; /// # Ok(()) /// # } /// ``` pub async fn get(&self, team_slug: impl Into<String>) -> Result<models::teams::Team> { let url = format!( "/orgs/{org}/teams/{team}", org = self.owner, team = team_slug.into(), ); self.crab.get(url, None::<&()>).await } /// Creates a new team in the organization. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// use octocrab::params; /// /// octocrab::instance() /// .teams("owner") /// .create("new-team") /// .description("My team created from Octocrab!") /// .maintainers(&vec![String::from("ferris")]) /// .repo_names(&vec![String::from("crab-stuff")]) /// .privacy(params::teams::Privacy::Closed) /// .parent_team_id(1u64) /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn create(&self, name: impl Into<String>) -> CreateTeamBuilder { CreateTeamBuilder::new(self, name.into()) } /// Creates a new team in the organization. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// use octocrab::params; /// /// octocrab::instance() /// .teams("owner") /// .edit("some-team", "Some Team") /// .description("I edited from Octocrab!") /// .privacy(params::teams::Privacy::Secret) /// .parent_team_id(2u64) /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn edit(&self, team_slug: impl Into<String>, name: impl Into<String>) -> EditTeamBuilder { EditTeamBuilder::new(self, team_slug.into(), name.into()) } /// Deletes a team from the organization. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// octocrab::instance().teams("owner").delete("some-team").await?; /// # Ok(()) /// # } /// ``` pub async fn delete(&self, team_slug: impl Into<String>) -> Result<()> { let url = format!( "/orgs/{org}/teams/{team}", org = self.owner, team = team_slug.into(), ); crate::map_github_error(self.crab._delete(&url, None::<&()>).await?) .await .map(drop) } /// List the child teams of a team in the organization. /// ```no_run /// # async fn run() -> octocrab::Result<()> { /// # let octocrab = octocrab::Octocrab::default(); /// octocrab::instance() /// .teams("owner") /// .list_children("parent-team") /// .per_page(5) /// .page(1u8) /// .send() /// .await?; /// # Ok(()) /// # } /// ``` pub fn list_children(&self, team_slug: impl Into<String>) -> ListChildTeamsBuilder { ListChildTeamsBuilder::new(self, team_slug.into()) } /// Creates a new `TeamRepoHandler` for the specified team, /// that allows you to manage this team's repositories. pub fn repos(&self, team_slug: impl Into<String>) -> TeamRepoHandler { TeamRepoHandler::new(self.crab, self.owner.clone(), team_slug.into()) } }