jacquard-api 0.12.0-beta.2

Generated AT Protocol API bindings for Jacquard
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

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: app.rocksky.scrobble.createScrobble
//
// This file was automatically generated from Lexicon schemas.
// Any manual changes will be overwritten on the next regeneration.

#[allow(unused_imports)]
use alloc::collections::BTreeMap;

use crate::app_rocksky::scrobble::ScrobbleViewBasic;
#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::deps::smol_str::SmolStr;
use jacquard_common::types::string::UriValue;
use jacquard_common::types::value::Data;
use jacquard_common::{BosStr, CowStr, DefaultStr, FromStaticStr};
use jacquard_derive::IntoStatic;
use serde::{Deserialize, Serialize};

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct CreateScrobble<S: BosStr = DefaultStr> {
    ///The album of the track being scrobbled
    #[serde(skip_serializing_if = "Option::is_none")]
    pub album: Option<S>,
    ///The URL of the album art for the track
    #[serde(skip_serializing_if = "Option::is_none")]
    pub album_art: Option<UriValue<S>>,
    ///The Apple Music link for the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub apple_music_link: Option<UriValue<S>>,
    ///The artist of the track being scrobbled
    pub artist: S,
    ///The URL of the artist's picture, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub artist_picture: Option<UriValue<S>>,
    ///The composer of the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub composer: Option<S>,
    ///The copyright message for the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub copyright_message: Option<S>,
    ///The Deezer link for the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub deezer_link: Option<UriValue<S>>,
    ///The disc number of the track in the album, if applicable
    #[serde(skip_serializing_if = "Option::is_none")]
    pub disc_number: Option<i64>,
    ///The duration of the track in seconds
    #[serde(skip_serializing_if = "Option::is_none")]
    pub duration: Option<i64>,
    ///The record label of the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub label: Option<S>,
    ///The Last.fm link for the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lastfm_link: Option<UriValue<S>>,
    ///The lyrics of the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub lyrics: Option<S>,
    ///The MusicBrainz ID of the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub mb_id: Option<S>,
    ///The release date of the track, formatted as YYYY-MM-DD
    #[serde(skip_serializing_if = "Option::is_none")]
    pub release_date: Option<S>,
    ///The Spotify link for the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub spotify_link: Option<UriValue<S>>,
    ///The Tidal link for the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub tidal_link: Option<UriValue<S>>,
    ///The timestamp of the scrobble in milliseconds since epoch
    #[serde(skip_serializing_if = "Option::is_none")]
    pub timestamp: Option<i64>,
    ///The title of the track being scrobbled
    pub title: S,
    ///The track number of the track in the album
    #[serde(skip_serializing_if = "Option::is_none")]
    pub track_number: Option<i64>,
    ///The year the track was released
    #[serde(skip_serializing_if = "Option::is_none")]
    pub year: Option<i64>,
    ///The Youtube link for the track, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    pub youtube_link: Option<UriValue<S>>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(
    rename_all = "camelCase",
    bound(deserialize = "S: Deserialize<'de> + BosStr")
)]
pub struct CreateScrobbleOutput<S: BosStr = DefaultStr> {
    #[serde(flatten)]
    pub value: ScrobbleViewBasic<S>,
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_data: Option<BTreeMap<SmolStr, Data<S>>>,
}

/// Response type for app.rocksky.scrobble.createScrobble
pub struct CreateScrobbleResponse;
impl jacquard_common::xrpc::XrpcResp for CreateScrobbleResponse {
    const NSID: &'static str = "app.rocksky.scrobble.createScrobble";
    const ENCODING: &'static str = "application/json";
    type Output<S: BosStr> = CreateScrobbleOutput<S>;
    type Err = jacquard_common::xrpc::GenericError;
}

impl<S: BosStr> jacquard_common::xrpc::XrpcRequest for CreateScrobble<S> {
    const NSID: &'static str = "app.rocksky.scrobble.createScrobble";
    const METHOD: jacquard_common::xrpc::XrpcMethod =
        jacquard_common::xrpc::XrpcMethod::Procedure("application/json");
    type Response = CreateScrobbleResponse;
}

/// Endpoint type for app.rocksky.scrobble.createScrobble
pub struct CreateScrobbleRequest;
impl jacquard_common::xrpc::XrpcEndpoint for CreateScrobbleRequest {
    const PATH: &'static str = "/xrpc/app.rocksky.scrobble.createScrobble";
    const METHOD: jacquard_common::xrpc::XrpcMethod =
        jacquard_common::xrpc::XrpcMethod::Procedure("application/json");
    type Request<S: BosStr> = CreateScrobble<S>;
    type Response = CreateScrobbleResponse;
}