jacquard-api 0.11.0

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

// @generated by jacquard-lexicon. DO NOT EDIT.
//
// Lexicon: app.rocksky.song.createSong
//
// 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;

#[allow(unused_imports)]
use core::marker::PhantomData;
use jacquard_common::CowStr;
use jacquard_common::types::string::UriValue;
use jacquard_derive::{IntoStatic, lexicon};
use serde::{Serialize, Deserialize};
use crate::app_rocksky::song::SongViewDetailed;

#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic, Default)]
#[serde(rename_all = "camelCase")]
pub struct CreateSong<'a> {
    ///The album of the song, if applicable
    #[serde(borrow)]
    pub album: CowStr<'a>,
    ///The URL of the album art for the song
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub album_art: Option<UriValue<'a>>,
    ///The album artist of the song, if different from the main artist
    #[serde(borrow)]
    pub album_artist: CowStr<'a>,
    ///The artist of the song
    #[serde(borrow)]
    pub artist: CowStr<'a>,
    ///The disc number of the song in the album, if applicable
    #[serde(skip_serializing_if = "Option::is_none")]
    pub disc_number: Option<i64>,
    ///The duration of the song in seconds
    #[serde(skip_serializing_if = "Option::is_none")]
    pub duration: Option<i64>,
    ///The lyrics of the song, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub lyrics: Option<CowStr<'a>>,
    ///The MusicBrainz ID of the song, if available
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub mb_id: Option<CowStr<'a>>,
    ///The release date of the song, formatted as YYYY-MM-DD
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(borrow)]
    pub release_date: Option<CowStr<'a>>,
    ///The title of the song
    #[serde(borrow)]
    pub title: CowStr<'a>,
    ///The track number of the song in the album, if applicable
    #[serde(skip_serializing_if = "Option::is_none")]
    pub track_number: Option<i64>,
    ///The year the song was released
    #[serde(skip_serializing_if = "Option::is_none")]
    pub year: Option<i64>,
}


#[lexicon]
#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq, IntoStatic)]
#[serde(rename_all = "camelCase")]
pub struct CreateSongOutput<'a> {
    #[serde(flatten)]
    #[serde(borrow)]
    pub value: SongViewDetailed<'a>,
}

/// Response type for app.rocksky.song.createSong
pub struct CreateSongResponse;
impl jacquard_common::xrpc::XrpcResp for CreateSongResponse {
    const NSID: &'static str = "app.rocksky.song.createSong";
    const ENCODING: &'static str = "application/json";
    type Output<'de> = CreateSongOutput<'de>;
    type Err<'de> = jacquard_common::xrpc::GenericError<'de>;
}

impl<'a> jacquard_common::xrpc::XrpcRequest for CreateSong<'a> {
    const NSID: &'static str = "app.rocksky.song.createSong";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Response = CreateSongResponse;
}

/// Endpoint type for app.rocksky.song.createSong
pub struct CreateSongRequest;
impl jacquard_common::xrpc::XrpcEndpoint for CreateSongRequest {
    const PATH: &'static str = "/xrpc/app.rocksky.song.createSong";
    const METHOD: jacquard_common::xrpc::XrpcMethod = jacquard_common::xrpc::XrpcMethod::Procedure(
        "application/json",
    );
    type Request<'de> = CreateSong<'de>;
    type Response = CreateSongResponse;
}