fyers-rs 0.0.1

Idiomatic async Rust client for the Fyers API v3 broker 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
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Price alerts API service.

use crate::client::FyersClient;
use crate::error::Result;
use crate::models::alerts::{
    CreatePriceAlertRequest, DeletePriceAlertRequest, ModifyPriceAlertRequest,
    PriceAlertActionResponse, PriceAlertQuery, PriceAlertsResponse, TogglePriceAlertRequest,
};
use crate::transport::{
    delete_authenticated_json, get_authenticated_url_json, join_base_path, post_authenticated_json,
    put_authenticated_json,
};

/// Accessor for Fyers price alert APIs.
#[derive(Debug, Clone, Copy)]
pub struct AlertsService<'a> {
    client: &'a FyersClient,
}

impl<'a> AlertsService<'a> {
    /// Create a new alerts service accessor.
    pub(crate) const fn new(client: &'a FyersClient) -> Self {
        Self { client }
    }

    /// Access the underlying client.
    pub const fn client(&self) -> &'a FyersClient {
        self.client
    }

    pub async fn create(
        &self,
        request: &CreatePriceAlertRequest,
    ) -> Result<PriceAlertActionResponse> {
        post_authenticated_json(
            self.client.http(),
            self.client.config(),
            "price-alert",
            request,
        )
        .await
    }

    pub async fn list(&self, query: &PriceAlertQuery) -> Result<PriceAlertsResponse> {
        let mut url = join_base_path(self.client.config().api_base_url(), "price-alert");
        {
            let mut pairs = url.query_pairs_mut();
            if let Some(name) = &query.name {
                pairs.append_pair("name", name);
            }
            if let Some(alert_id) = &query.alert_id {
                pairs.append_pair("alertId", alert_id);
            }
        }

        get_authenticated_url_json(self.client.http(), self.client.config(), url).await
    }

    pub async fn modify(
        &self,
        request: &ModifyPriceAlertRequest,
    ) -> Result<PriceAlertActionResponse> {
        put_authenticated_json(
            self.client.http(),
            self.client.config(),
            "price-alert",
            request,
        )
        .await
    }

    pub async fn delete(
        &self,
        request: &DeletePriceAlertRequest,
    ) -> Result<PriceAlertActionResponse> {
        delete_authenticated_json(
            self.client.http(),
            self.client.config(),
            "price-alert",
            request,
        )
        .await
    }

    pub async fn toggle(
        &self,
        request: &TogglePriceAlertRequest,
    ) -> Result<PriceAlertActionResponse> {
        put_authenticated_json(
            self.client.http(),
            self.client.config(),
            "toggle-alert",
            request,
        )
        .await
    }
}