twitch_highway 0.2.1

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
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

use std::collections::HashMap;

use asknothingx2_util::serde::serialize_none_as_empty_string;
use chrono::{DateTime, FixedOffset};
use serde::{Deserialize, Serialize};

use crate::types::{Id, UserId};

#[derive(Debug, Serialize, Deserialize)]
pub struct User {
    pub id: Id,
    pub login: String,
    pub display_name: String,
    #[serde(rename = "type")]
    pub kind: UserType,
    pub broadcaster_type: BroadcasterType,
    pub description: String,
    pub profile_image_url: String,
    pub offline_image_url: String,
    /// NOTE: This field has been deprecated (see Get Users API endpoint – “view_count” deprecation).
    /// Any data in this field is not valid and should not be used.
    pub view_count: u64,
    /// if the user access token includes the user:read:email scope.
    #[serde(serialize_with = "serialize_none_as_empty_string")]
    pub email: Option<String>,
    pub created_at: DateTime<FixedOffset>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum UserType {
    Admin,
    GlobalMod,
    Staff,
    #[serde(rename(serialize = "", deserialize = ""))]
    Normal,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum BroadcasterType {
    Affiliate,
    Partner,
    #[serde(rename(serialize = "", deserialize = ""))]
    Normal,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct BlockUser {
    pub user_id: UserId,
    pub user_login: String,
    pub display_name: String,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct UserExtension {
    pub id: Id,
    pub version: String,
    pub name: String,
    pub can_activate: bool,
    #[serde(rename = "type")]
    pub kind: Vec<ExtensionType>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum ExtensionType {
    Component,
    Mobile,
    Overlay,
    Panel,
}

define_request!(
    #[derive(Debug, Serialize, Deserialize)]
    UserActiveExtensions {
        req: {
            panel: HashMap<String, Panel>,
            overlay: HashMap<String, Overlay>,
            component: HashMap<String, Component>,
        };
        into_json
    }
);

define_request!(
    #[derive(Debug, Serialize, Deserialize)]
    Panel {
        req: {
            active: bool,
        },
        opts: {
            #[serde(skip_serializing_if = "Option::is_none")]
            id: Id,
            #[serde(skip_serializing_if = "Option::is_none")]
            version: String | into,
            #[serde(skip_serializing_if = "Option::is_none")]
            name: String | into,
        }
    }
);

define_request!(
    #[derive(Debug, Serialize, Deserialize)]
    Overlay {
        req: {
            active: bool,
        },
        opts: {
            #[serde(skip_serializing_if = "Option::is_none")]
            id: Id,
            #[serde(skip_serializing_if = "Option::is_none")]
            version: String | into,
            #[serde(skip_serializing_if = "Option::is_none")]
            name: String | into,
        }
    }
);

define_request!(
    #[derive(Debug, Serialize, Deserialize)]
    Component {
        req: {
            active: bool
        },
        opts: {
            #[serde(skip_serializing_if = "Option::is_none")]
            id: Id,
            #[serde(skip_serializing_if = "Option::is_none")]
            version: String | into,
            #[serde(skip_serializing_if = "Option::is_none")]
            name: String | into,
            #[serde(skip_serializing_if = "Option::is_none")]
            x: u64,
            #[serde(skip_serializing_if = "Option::is_none")]
            y: u64
        }
    }
);