trading-ig 0.1.1

Async Rust client for the IG Markets REST and Lightstreamer streaming APIs
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

//! Operations API endpoints — manage API application keys.

use http::Method;
use tracing::instrument;

use crate::Result;
use crate::client::IgClient;

use super::models::{Application, UpdateApplicationRequest};

/// Typed accessor for the `/operations/application` endpoints.
///
/// Obtain via [`IgClient::operations`].
#[derive(Debug)]
pub struct OperationsApi<'a> {
    pub(crate) client: &'a IgClient,
}

impl OperationsApi<'_> {
    /// List all API application keys associated with the current account.
    ///
    /// # Errors
    ///
    /// Returns [`crate::Error::Api`] with
    /// `error.public-api.failure.not.an.administrator` if the account does
    /// not have administrator privileges.
    #[instrument(skip(self))]
    pub async fn applications(&self) -> Result<Vec<Application>> {
        self.client
            .transport
            .request(
                Method::GET,
                "operations/application",
                Some(1),
                None::<&()>,
                &self.client.session,
            )
            .await
    }

    /// Update allowances or status for an API application key.
    ///
    /// # Errors
    ///
    /// Returns [`crate::Error::Api`] with
    /// `error.public-api.failure.not.an.administrator` if the account does
    /// not have administrator privileges.
    #[instrument(skip(self, req), fields(api_key = %req.api_key))]
    pub async fn update_application(&self, req: UpdateApplicationRequest) -> Result<Application> {
        self.client
            .transport
            .request(
                Method::PUT,
                "operations/application",
                Some(1),
                Some(&req),
                &self.client.session,
            )
            .await
    }

    /// Disable the API key currently in use.
    ///
    /// Re-enabling the key requires the IG web UI. Use with care.
    ///
    /// # Errors
    ///
    /// Returns [`crate::Error::Api`] with
    /// `error.public-api.failure.not.an.administrator` if the account does
    /// not have administrator privileges.
    #[instrument(skip(self))]
    pub async fn disable_current_key(&self) -> Result<Application> {
        self.client
            .transport
            .request(
                Method::PUT,
                "operations/application/disable",
                Some(1),
                None::<&()>,
                &self.client.session,
            )
            .await
    }
}