twitch_highway 0.3.0

Twitch API
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96

mod builder;
mod response;
mod types;

pub use builder::{GetDropsEntitlementsBuilder, UpdateDropsEntitlementsBuilder};
pub use response::{DropsEntitlementsResponse, UpdateDropEntitlementsResponse};
pub use types::{DropEntitlement, DropEntitlementStatus, FulfillmentStatus, UpdateDropEntitlement};

use crate::TwitchAPI;

pub trait EntitlementsAPI {
    /// Gets an organization’s list of entitlements that have been granted to a game, a user, or both
    ///
    /// # Returns
    ///
    /// Returns a [`DropsEntitlementsResponse`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     entitlements::{EntitlementsAPI, FulfillmentStatus},
    ///     types::{EntitlementId, UserId, GameId}
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .get_drops_entitlements()
    ///     .ids(&[EntitlementId::from("1234")])
    ///     .user_id(&UserId::from("5678"))
    ///     .game_id(&GameId::from("7890"))
    ///     .fulfillment_status(FulfillmentStatus::CLAIMED)
    ///     .first(5)
    ///     .after("eyJiI...")
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// No scope required
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#get-drops-entitlements>
    fn get_drops_entitlements<'a>(&'a self) -> GetDropsEntitlementsBuilder<'a>;

    /// Updates the Drop entitlement’s fulfillment status
    ///
    /// # Returns
    ///
    /// Returns a [`UpdateDropEntitlementsResponse`]
    ///
    /// # Example
    ///
    /// ```rust
    /// # use twitch_highway::TwitchAPI;
    /// use twitch_highway::{
    ///     entitlements::{EntitlementsAPI, FulfillmentStatus},
    ///     types::EntitlementId
    /// };
    ///
    /// # async fn example(api: TwitchAPI) -> Result<(), Box<dyn std::error::Error>> {
    /// let response = api
    ///     .update_drops_entitlements()
    ///     .entitlement_ids(&[EntitlementId::from("1234")])
    ///     .fulfillment_status(FulfillmentStatus::CLAIMED)
    ///     .json()
    ///     .await?;
    ///
    /// # Ok(())
    /// # }
    /// ```
    ///
    /// # Required Scope
    ///
    /// No scope required
    ///
    /// API Reference
    ///
    /// <https://dev.twitch.tv/docs/api/reference/#update-drops-entitlements>
    fn update_drops_entitlements<'a>(&'a self) -> UpdateDropsEntitlementsBuilder<'a>;
}

impl EntitlementsAPI for TwitchAPI {
    fn get_drops_entitlements<'a>(&'a self) -> GetDropsEntitlementsBuilder<'a> {
        GetDropsEntitlementsBuilder::new(self)
    }
    fn update_drops_entitlements<'a>(&'a self) -> UpdateDropsEntitlementsBuilder<'a> {
        UpdateDropsEntitlementsBuilder::new(self)
    }
}