dune-api 0.1.0

Unofficial Rust client for the Dune Analytics 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
146
147
148
149
150
151
152
153
154
155
156

//! Queries API implementation

use super::types::*;
use crate::client::Client;
use crate::error::{self, Error, Result};

/// Queries API
pub struct QueriesApi<'a> {
    client: &'a Client,
}

impl<'a> QueriesApi<'a> {
    pub(crate) fn new(client: &'a Client) -> Self {
        Self { client }
    }

    /// Create a new query
    pub async fn create(&self, request: &CreateQueryRequest) -> Result<CreateQueryResponse> {
        let url = format!("{}/v1/query", self.client.base_url());
        let response = self.client.http().post(&url).json(request).send().await?;

        if response.status().is_success() {
            Ok(response.json().await?)
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    /// Get a query by ID
    pub async fn get(&self, query_id: i64) -> Result<Query> {
        let url = format!("{}/v1/query/{}", self.client.base_url(), query_id);
        let response = self.client.http().get(&url).send().await?;

        if response.status().is_success() {
            Ok(response.json().await?)
        } else if response.status() == 404 {
            Err(error::not_found(format!("Query {}", query_id)))
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    /// Update a query
    pub async fn update(
        &self,
        query_id: i64,
        request: &UpdateQueryRequest,
    ) -> Result<UpdateQueryResponse> {
        let url = format!("{}/v1/query/{}", self.client.base_url(), query_id);
        let response = self.client.http().patch(&url).json(request).send().await?;

        if response.status().is_success() {
            Ok(response.json().await?)
        } else if response.status() == 404 {
            Err(error::not_found(format!("Query {}", query_id)))
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    /// List queries
    pub async fn list(&self) -> Result<ListQueriesResponse> {
        self.list_with_options(&ListQueriesOptions::default()).await
    }

    /// List queries with options
    pub async fn list_with_options(
        &self,
        options: &ListQueriesOptions,
    ) -> Result<ListQueriesResponse> {
        let url = format!(
            "{}/v1/queries{}",
            self.client.base_url(),
            options.to_query_string()
        );
        let response = self.client.http().get(&url).send().await?;

        if response.status().is_success() {
            Ok(response.json().await?)
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    /// Archive a query
    pub async fn archive(&self, query_id: i64) -> Result<()> {
        let url = format!("{}/v1/query/{}/archive", self.client.base_url(), query_id);
        let response = self.client.http().post(&url).send().await?;

        if response.status().is_success() {
            Ok(())
        } else if response.status() == 404 {
            Err(error::not_found(format!("Query {}", query_id)))
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    /// Unarchive a query
    pub async fn unarchive(&self, query_id: i64) -> Result<()> {
        let url = format!("{}/v1/query/{}/unarchive", self.client.base_url(), query_id);
        let response = self.client.http().post(&url).send().await?;

        if response.status().is_success() {
            Ok(())
        } else if response.status() == 404 {
            Err(error::not_found(format!("Query {}", query_id)))
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    /// Make a query private
    pub async fn make_private(&self, query_id: i64) -> Result<()> {
        let url = format!("{}/v1/query/{}/private", self.client.base_url(), query_id);
        let response = self.client.http().post(&url).send().await?;

        if response.status().is_success() {
            Ok(())
        } else if response.status() == 404 {
            Err(error::not_found(format!("Query {}", query_id)))
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    /// Make a query public (unprivate)
    pub async fn make_public(&self, query_id: i64) -> Result<()> {
        let url = format!("{}/v1/query/{}/unprivate", self.client.base_url(), query_id);
        let response = self.client.http().post(&url).send().await?;

        if response.status().is_success() {
            Ok(())
        } else if response.status() == 404 {
            Err(error::not_found(format!("Query {}", query_id)))
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }
}