kick-api 0.1.9

Rust client for the Kick.com 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

use serde::{Deserialize, Serialize};

/// Channel information
///
/// Returned when fetching channel data via the `/channels` endpoint
///
/// # Example Response
/// ```json
/// {
///   "broadcaster_user_id": 123456,
///   "slug": "xqc",
///   "stream_title": "LIVE NOW",
///   "channel_description": "Welcome to my channel!"
/// }
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Channel {
    /// Number of active subscribers
    pub active_subscribers_count: u32,

    /// Banner picture URL
    #[serde(skip_serializing_if = "Option::is_none")]
    pub banner_picture: Option<String>,

    /// Unique broadcaster user identifier
    pub broadcaster_user_id: u32,

    /// Number of canceled subscribers
    pub canceled_subscribers_count: u32,

    /// Current stream category
    #[serde(skip_serializing_if = "Option::is_none")]
    pub category: Option<Category>,

    /// Channel description text
    #[serde(skip_serializing_if = "Option::is_none")]
    pub channel_description: Option<String>,

    /// Channel URL slug (unique username)
    pub slug: String,

    /// Current stream information (if live)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub stream: Option<Stream>,

    /// Current stream title
    #[serde(skip_serializing_if = "Option::is_none")]
    pub stream_title: Option<String>,
}

/// Stream category information
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Category {
    /// Unique category identifier
    pub id: u32,

    /// Category name (e.g., "Just Chatting", "Fortnite")
    pub name: String,

    /// Category thumbnail URL
    #[serde(skip_serializing_if = "Option::is_none")]
    pub thumbnail: Option<String>,
}

/// Request body for updating channel/livestream metadata
///
/// At least one field must be specified. Requires `channel:write` scope.
///
/// # Example
/// ```
/// let update = kick_api::UpdateChannelRequest {
///     category_id: None,
///     stream_title: Some("New stream title!".to_string()),
///     custom_tags: Some(vec!["rust".to_string(), "coding".to_string()]),
/// };
/// ```
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct UpdateChannelRequest {
    /// Category ID to set for the stream (minimum 1)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub category_id: Option<u32>,

    /// Stream title (minimum 1 character)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub stream_title: Option<String>,

    /// Custom tags for the stream (maximum 10)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub custom_tags: Option<Vec<String>>,
}

/// Live stream information
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Stream {
    /// Custom tags set by the streamer
    #[serde(default)]
    pub custom_tags: Vec<String>,

    /// Whether the stream is currently live
    pub is_live: bool,

    /// Whether the stream is marked as mature content
    pub is_mature: bool,

    /// Stream key identifier
    pub key: String,

    /// Stream language code (e.g., "en")
    pub language: String,

    /// When the stream started (ISO 8601)
    pub start_time: String,

    /// Stream thumbnail URL
    #[serde(skip_serializing_if = "Option::is_none")]
    pub thumbnail: Option<String>,

    /// Stream URL
    pub url: String,

    /// Current viewer count
    pub viewer_count: u32,
}