svix 1.94.0

Svix webhooks API client and webhook verification library
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

// this file is @generated
use crate::{error::Result, models::*, Configuration};

#[derive(Default)]
pub struct StreamingStreamListOptions {
    /// Limit the number of returned items
    pub limit: Option<i32>,

    /// The iterator returned from a prior invocation
    pub iterator: Option<String>,

    /// The sorting order of the returned items
    pub order: Option<Ordering>,
}

#[derive(Default)]
pub struct StreamingStreamCreateOptions {
    pub idempotency_key: Option<String>,
}

pub struct StreamingStream<'a> {
    cfg: &'a Configuration,
}

impl<'a> StreamingStream<'a> {
    pub(super) fn new(cfg: &'a Configuration) -> Self {
        Self { cfg }
    }

    /// List of all the organization's streams.
    pub async fn list(
        &self,
        options: Option<StreamingStreamListOptions>,
    ) -> Result<ListResponseStreamOut> {
        let StreamingStreamListOptions {
            limit,
            iterator,
            order,
        } = options.unwrap_or_default();

        crate::request::Request::new(http1::Method::GET, "/api/v1/stream")
            .with_optional_query_param("limit", limit)
            .with_optional_query_param("iterator", iterator)
            .with_optional_query_param("order", order)
            .execute(self.cfg)
            .await
    }

    /// Creates a new stream.
    pub async fn create(
        &self,
        stream_in: StreamIn,
        options: Option<StreamingStreamCreateOptions>,
    ) -> Result<StreamOut> {
        let StreamingStreamCreateOptions { idempotency_key } = options.unwrap_or_default();

        crate::request::Request::new(http1::Method::POST, "/api/v1/stream")
            .with_optional_header_param("idempotency-key", idempotency_key)
            .with_body_param(stream_in)
            .execute(self.cfg)
            .await
    }

    /// Get a stream by id or uid.
    pub async fn get(&self, stream_id: String) -> Result<StreamOut> {
        crate::request::Request::new(http1::Method::GET, "/api/v1/stream/{stream_id}")
            .with_path_param("stream_id", stream_id)
            .execute(self.cfg)
            .await
    }

    /// Update a stream.
    pub async fn update(&self, stream_id: String, stream_in: StreamIn) -> Result<StreamOut> {
        crate::request::Request::new(http1::Method::PUT, "/api/v1/stream/{stream_id}")
            .with_path_param("stream_id", stream_id)
            .with_body_param(stream_in)
            .execute(self.cfg)
            .await
    }

    /// Delete a stream.
    pub async fn delete(&self, stream_id: String) -> Result<()> {
        crate::request::Request::new(http1::Method::DELETE, "/api/v1/stream/{stream_id}")
            .with_path_param("stream_id", stream_id)
            .returns_nothing()
            .execute(self.cfg)
            .await
    }

    /// Partially update a stream.
    pub async fn patch(&self, stream_id: String, stream_patch: StreamPatch) -> Result<StreamOut> {
        crate::request::Request::new(http1::Method::PATCH, "/api/v1/stream/{stream_id}")
            .with_path_param("stream_id", stream_id)
            .with_body_param(stream_patch)
            .execute(self.cfg)
            .await
    }
}