rust-okx 0.6.4

Async Rust client for the OKX v5 REST 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

use serde::Deserialize;

use crate::model::NumberString;

/// A single announcement entry within [`AnnouncementsPage::details`].
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AnnouncementDetail {
    /// Announcement title.
    #[serde(default)]
    pub title: String,
    /// Announcement type identifier.
    #[serde(default)]
    pub ann_type: String,
    /// Announcement URL.
    #[serde(default)]
    pub url: String,
    /// Actual publish time (Unix milliseconds). May be delayed ~5 minutes.
    #[serde(default)]
    pub p_time: NumberString,
    /// Display time shown on the announcement page (Unix milliseconds).
    #[serde(default)]
    pub business_p_time: NumberString,
}

/// Top-level element returned by
/// [`get_announcements`](crate::api::support::Support::get_announcements).
///
/// The OKX `data` array always contains exactly one object of this type.
/// The announcement list itself is in [`details`](AnnouncementsPage::details).
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#rest-api-support-get-announcements>
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AnnouncementsPage {
    /// Total number of pages available.
    #[serde(default)]
    pub total_page: String,
    /// Announcement entries for the requested page.
    #[serde(default)]
    pub details: Vec<AnnouncementDetail>,
}

/// An announcement type returned by
/// [`get_announcement_types`](crate::api::support::Support::get_announcement_types).
///
/// OKX docs: <https://www.okx.com/docs-v5/en/#rest-api-support-get-announcement-types>
#[derive(Debug, Clone, Default, Deserialize)]
#[serde(rename_all = "camelCase")]
#[non_exhaustive]
pub struct AnnouncementType {
    /// Announcement type identifier (use as `ann_type` filter in
    /// [`AnnouncementsRequest`](crate::api::support::AnnouncementsRequest)).
    #[serde(default)]
    pub ann_type: String,
    /// Human-readable description of the announcement type.
    #[serde(default)]
    pub ann_type_desc: String,
}