cognitum-one 0.2.1

Official Cognitum SDK for Rust
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

//! OTA resource — `/api/v1/ota/*`.

use crate::error::Error;
use crate::seed::client::SeedClient;
use crate::seed::config::CallOptions;
use crate::seed::models::{OtaCheckNowAck, OtaConfig};

/// OTA endpoints.
pub struct OtaResource<'c> {
    pub(crate) client: &'c SeedClient,
}

impl<'c> OtaResource<'c> {
    /// `GET /api/v1/ota/config` (allowlisted read).
    pub async fn config(&self) -> Result<OtaConfig, Error> {
        self.client.request_get("/ota/config").await
    }

    /// [`Self::config`] with per-call [`CallOptions`] overrides.
    pub async fn config_with(&self, opts: CallOptions) -> Result<OtaConfig, Error> {
        self.client.request_get_opts("/ota/config", &opts).await
    }

    /// `POST /api/v1/ota/check-now` — v0.20.0+. Requires pairing token
    /// (seed returns 403 otherwise). Not idempotent server-side but
    /// repeat-safe — the seed dedupes internally — so mark idempotent.
    pub async fn check_now(&self) -> Result<OtaCheckNowAck, Error> {
        self.client
            .request_post::<OtaCheckNowAck, _>("/ota/check-now", &serde_json::json!({}), true)
            .await
    }

    /// [`Self::check_now`] with per-call [`CallOptions`] overrides.
    pub async fn check_now_with(&self, opts: CallOptions) -> Result<OtaCheckNowAck, Error> {
        self.client
            .request_post_opts::<OtaCheckNowAck, _>(
                "/ota/check-now",
                &serde_json::json!({}),
                true,
                &opts,
            )
            .await
    }
}