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

use crate::client::OkxClient;
use crate::error::Error;
use crate::model::EmptyRequest;
use crate::transport::Transport;

use super::endpoints::*;
use super::requests::*;
use super::responses::*;

/// Accessor for the public support and announcement endpoints.
///
/// Obtain one via [`OkxClient::support`](crate::OkxClient::support).
pub struct Support<'a, T> {
    client: &'a OkxClient<T>,
}

impl<'a, T: Transport> Support<'a, T> {
    pub(crate) fn new(client: &'a OkxClient<T>) -> Self {
        Self { client }
    }

    /// Retrieve paginated announcements.
    ///
    /// `GET /api/v5/support/announcements`. Public (unauthenticated). The
    /// returned `Vec` always contains one [`AnnouncementsPage`]; the actual
    /// announcement list is in `[0].details`.
    ///
    /// # Errors
    ///
    /// Returns [`RestError::Okx`](crate::RestError::Okx) on a non-zero OKX code, or
    /// [`RestError::Transport`](crate::RestError::Transport)/[`RestError::Decode`](crate::RestError::Decode) on transport/parsing failure.
    pub async fn get_announcements(
        &self,
        request: &AnnouncementsRequest<'_>,
    ) -> Result<Vec<AnnouncementsPage>, Error> {
        self.client.get(ANNOUNCEMENTS, request, false).await
    }

    /// Retrieve all available announcement types.
    ///
    /// `GET /api/v5/support/announcement-types`. Public (unauthenticated). Use
    /// the returned `ann_type` values to filter
    /// [`get_announcements`](Self::get_announcements).
    ///
    /// # Errors
    ///
    /// See [`get_announcements`](Self::get_announcements).
    pub async fn get_announcement_types(&self) -> Result<Vec<AnnouncementType>, Error> {
        self.client
            .get(ANNOUNCEMENT_TYPES, &EmptyRequest {}, false)
            .await
    }
}