uptrakit-openapi-client 0.0.4

Typed HTTP client for the Uptrakit web 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
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use crate::Result;
use crate::UptrakitClient;
use crate::types_impl::surfaces::{
    InvokeSurfaceInteractionRequest, SurfaceProviderInfo, SurfaceReadResponse, SurfaceResponse,
};

impl UptrakitClient {
    /// List registered surfaces. Optional `slot` and `page` filters map to query params.
    pub async fn list_surfaces(
        &self,
        slot: Option<&str>,
        page: Option<&str>,
    ) -> Result<Vec<SurfaceResponse>> {
        let url = format!("{}{}", self.base_url, crate::paths::surfaces::BASE);
        let mut req = self.http.get(&url).bearer_auth(self.token_or_err()?);
        let mut query_params: Vec<(&str, &str)> = Vec::new();
        if let Some(slot) = slot {
            query_params.push(("slot", slot));
        }
        if let Some(page) = page {
            query_params.push(("page", page));
        }
        if !query_params.is_empty() {
            req = req.query(&query_params);
        }
        let resp = self.send_with_retry(req).await?;
        self.handle_response(resp).await
    }

    /// List targeted providers for a surface.
    pub async fn list_surface_providers(
        &self,
        surface_id: &str,
    ) -> Result<Vec<SurfaceProviderInfo>> {
        self.get(&crate::paths::surfaces::providers(surface_id))
            .await
    }

    /// Read a single surface with its interactions and data sources.
    pub async fn read_surface(&self, surface_id: &str) -> Result<SurfaceReadResponse> {
        self.get(&crate::paths::surfaces::read(surface_id)).await
    }

    /// Read a surface interaction via `GET`. `query` pairs are forwarded verbatim
    /// as query-string parameters (reserved keys included).
    pub async fn read_surface_interaction(
        &self,
        surface_id: &str,
        interaction_id: &str,
        query: &[(&str, String)],
    ) -> Result<serde_json::Value> {
        self.get_with_query(
            &crate::paths::surfaces::interaction(surface_id, interaction_id),
            &query,
        )
        .await
    }

    /// Invoke a surface interaction.
    pub async fn invoke_surface_interaction(
        &self,
        surface_id: &str,
        interaction_id: &str,
        request: &InvokeSurfaceInteractionRequest,
    ) -> Result<serde_json::Value> {
        self.post_json(
            &crate::paths::surfaces::interaction(surface_id, interaction_id),
            request,
        )
        .await
    }

    /// Update a surface interaction via `PUT`.
    pub async fn update_surface_interaction(
        &self,
        surface_id: &str,
        interaction_id: &str,
        request: &InvokeSurfaceInteractionRequest,
    ) -> Result<serde_json::Value> {
        self.put_json(
            &crate::paths::surfaces::interaction(surface_id, interaction_id),
            request,
        )
        .await
    }

    /// Delete a surface interaction via `DELETE`.
    pub async fn delete_surface_interaction(
        &self,
        surface_id: &str,
        interaction_id: &str,
        request: &InvokeSurfaceInteractionRequest,
    ) -> Result<serde_json::Value> {
        self.delete_json_body(
            &crate::paths::surfaces::interaction(surface_id, interaction_id),
            request,
        )
        .await
    }

    /// Read a surface interaction targeting a specific item via `GET .../{item_id}`.
    pub async fn read_surface_interaction_item(
        &self,
        surface_id: &str,
        interaction_id: &str,
        item_id: &str,
        query: &[(&str, String)],
    ) -> Result<serde_json::Value> {
        self.get_with_query(
            &crate::paths::surfaces::interaction_item(surface_id, interaction_id, item_id),
            &query,
        )
        .await
    }

    /// Update a surface interaction targeting a specific item via `PUT .../{item_id}`.
    pub async fn update_surface_interaction_item(
        &self,
        surface_id: &str,
        interaction_id: &str,
        item_id: &str,
        request: &InvokeSurfaceInteractionRequest,
    ) -> Result<serde_json::Value> {
        self.put_json(
            &crate::paths::surfaces::interaction_item(surface_id, interaction_id, item_id),
            request,
        )
        .await
    }

    /// Delete a surface interaction targeting a specific item via `DELETE .../{item_id}`.
    pub async fn delete_surface_interaction_item(
        &self,
        surface_id: &str,
        interaction_id: &str,
        item_id: &str,
        request: &InvokeSurfaceInteractionRequest,
    ) -> Result<serde_json::Value> {
        self.delete_json_body(
            &crate::paths::surfaces::interaction_item(surface_id, interaction_id, item_id),
            request,
        )
        .await
    }
}