bigrag 0.1.1

Rust client for bigRAG — a self-hostable RAG platform
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

use crate::client::BigRag;
use crate::core::urlencode;
use crate::error::BigRagError;
use crate::types::common::{PaginationOptions, StatusResponse};
use crate::types::webhooks::{
    CreateWebhookBody, CreateWebhookResponse, UpdateWebhookBody, Webhook,
    WebhookDeliveryListResponse, WebhookListResponse, WebhookTestResponse,
};

/// Webhooks resource — manage webhook subscriptions.
pub struct Webhooks<'a> {
    pub(crate) client: &'a BigRag,
}

impl Webhooks<'_> {
    /// Create a new webhook.
    pub async fn create(
        &self,
        body: CreateWebhookBody,
    ) -> Result<CreateWebhookResponse, BigRagError> {
        self.client
            .transport
            .post("/v1/admin/webhooks", &body)
            .await
    }

    /// List all webhooks.
    pub async fn list(&self) -> Result<WebhookListResponse, BigRagError> {
        self.client
            .transport
            .get("/v1/admin/webhooks", vec![])
            .await
    }

    /// Get a webhook by ID.
    pub async fn get(&self, id: &str) -> Result<Webhook, BigRagError> {
        let path = format!("/v1/admin/webhooks/{}", urlencode(id));
        self.client.transport.get(&path, vec![]).await
    }

    /// Update a webhook.
    pub async fn update(
        &self,
        id: &str,
        body: UpdateWebhookBody,
    ) -> Result<Webhook, BigRagError> {
        let path = format!("/v1/admin/webhooks/{}", urlencode(id));
        self.client.transport.put(&path, &body).await
    }

    /// Delete a webhook.
    pub async fn delete(&self, id: &str) -> Result<StatusResponse, BigRagError> {
        let path = format!("/v1/admin/webhooks/{}", urlencode(id));
        self.client.transport.delete(&path).await
    }

    /// List delivery attempts for a webhook.
    pub async fn list_deliveries(
        &self,
        id: &str,
        options: Option<PaginationOptions>,
    ) -> Result<WebhookDeliveryListResponse, BigRagError> {
        let mut query = Vec::new();
        if let Some(opts) = options {
            if let Some(limit) = opts.limit {
                query.push(("limit".into(), limit.to_string()));
            }
            if let Some(offset) = opts.offset {
                query.push(("offset".into(), offset.to_string()));
            }
        }
        let path = format!("/v1/admin/webhooks/{}/deliveries", urlencode(id));
        self.client.transport.get(&path, query).await
    }

    /// Send a test delivery to a webhook.
    pub async fn test(&self, id: &str) -> Result<WebhookTestResponse, BigRagError> {
        let path = format!("/v1/admin/webhooks/{}/test", urlencode(id));
        self.client
            .transport
            .post(&path, &serde_json::Value::Null)
            .await
    }
}