octocrab 0.54.2

A modern, extensible GitHub API client.
Documentation 
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

//! GitHub Activity Events API

use crate::api::events::EventsBuilder;
use crate::Octocrab;

/// Handler for GitHub's activity events API.
///
/// Created with [`ActivityHandler::events`].
///
/// [`ActivityHandler::events`]: ../struct.ActivityHandler.html#method.events
pub struct ActivityEventsHandler<'octo> {
    crab: &'octo Octocrab,
}

impl<'octo> ActivityEventsHandler<'octo> {
    pub(crate) fn new(crab: &'octo Octocrab) -> Self {
        Self { crab }
    }

    /// List public events for a network of repositories.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/events?apiVersion=2022-11-28#list-public-events-for-a-network-of-repositories)
    pub fn network_events(
        &self,
        owner: impl Into<String>,
        repo: impl Into<String>,
    ) -> EventsBuilder<'octo> {
        let route = format!("/networks/{}/{}/events", owner.into(), repo.into());
        EventsBuilder::with_route(self.crab, route)
    }

    /// List events for the authenticated user.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/events?apiVersion=2022-11-28#list-events-for-the-authenticated-user)
    pub fn user_events(&self, username: impl Into<String>) -> EventsBuilder<'octo> {
        let route = format!("/users/{}/events", username.into());
        EventsBuilder::with_route(self.crab, route)
    }

    /// List public events for a user.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/events?apiVersion=2022-11-28#list-public-events-for-a-user)
    pub fn public_user_events(&self, username: impl Into<String>) -> EventsBuilder<'octo> {
        let route = format!("/users/{}/events/public", username.into());
        EventsBuilder::with_route(self.crab, route)
    }

    /// List events received by the authenticated user.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/events?apiVersion=2022-11-28#list-events-received-by-the-authenticated-user)
    pub fn received_events(&self, username: impl Into<String>) -> EventsBuilder<'octo> {
        let route = format!("/users/{}/received_events", username.into());
        EventsBuilder::with_route(self.crab, route)
    }

    /// List public events received by a user.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/events?apiVersion=2022-11-28#list-public-events-received-by-a-user)
    pub fn public_received_events(&self, username: impl Into<String>) -> EventsBuilder<'octo> {
        let route = format!("/users/{}/received_events/public", username.into());
        EventsBuilder::with_route(self.crab, route)
    }

    /// List organization events for the authenticated user.
    ///
    /// [See the GitHub API documentation](https://docs.github.com/en/rest/activity/events?apiVersion=2022-11-28#list-organization-events-for-the-authenticated-user)
    pub fn user_org_events(
        &self,
        username: impl Into<String>,
        org: impl Into<String>,
    ) -> EventsBuilder<'octo> {
        let route = format!("/users/{}/events/orgs/{}", username.into(), org.into());
        EventsBuilder::with_route(self.crab, route)
    }
}