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
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

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

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

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

    /// Filters messages sent with this event type (optional).
    pub event_type: Option<String>,

    /// Filters messages sent with this channel (optional).
    pub channel: Option<String>,

    pub after: Option<String>,
}

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

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

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

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

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

    /// Reads the stream of created messages for an application, filtered on the
    /// Sink's event types and Channels.
    pub async fn poll(
        &self,
        app_id: String,
        sink_id: String,
        options: Option<MessagePollerPollOptions>,
    ) -> Result<PollingEndpointOut> {
        let MessagePollerPollOptions {
            limit,
            iterator,
            event_type,
            channel,
            after,
        } = options.unwrap_or_default();

        crate::request::Request::new(http1::Method::GET, "/api/v1/app/{app_id}/poller/{sink_id}")
            .with_path_param("app_id", app_id)
            .with_path_param("sink_id", sink_id)
            .with_optional_query_param("limit", limit)
            .with_optional_query_param("iterator", iterator)
            .with_optional_query_param("event_type", event_type)
            .with_optional_query_param("channel", channel)
            .with_optional_query_param("after", after)
            .execute(self.cfg)
            .await
    }

    /// Reads the stream of created messages for an application, filtered on the
    /// Sink's event types and Channels, using server-managed iterator
    /// tracking.
    pub async fn consumer_poll(
        &self,
        app_id: String,
        sink_id: String,
        consumer_id: String,
        options: Option<MessagePollerConsumerPollOptions>,
    ) -> Result<PollingEndpointOut> {
        let MessagePollerConsumerPollOptions { limit, iterator } = options.unwrap_or_default();

        crate::request::Request::new(
            http1::Method::GET,
            "/api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}",
        )
        .with_path_param("app_id", app_id)
        .with_path_param("sink_id", sink_id)
        .with_path_param("consumer_id", consumer_id)
        .with_optional_query_param("limit", limit)
        .with_optional_query_param("iterator", iterator)
        .execute(self.cfg)
        .await
    }

    /// Sets the starting offset for the consumer of a polling endpoint.
    pub async fn consumer_seek(
        &self,
        app_id: String,
        sink_id: String,
        consumer_id: String,
        polling_endpoint_consumer_seek_in: PollingEndpointConsumerSeekIn,
        options: Option<MessagePollerConsumerSeekOptions>,
    ) -> Result<PollingEndpointConsumerSeekOut> {
        let MessagePollerConsumerSeekOptions { idempotency_key } = options.unwrap_or_default();

        crate::request::Request::new(
            http1::Method::POST,
            "/api/v1/app/{app_id}/poller/{sink_id}/consumer/{consumer_id}/seek",
        )
        .with_path_param("app_id", app_id)
        .with_path_param("sink_id", sink_id)
        .with_path_param("consumer_id", consumer_id)
        .with_optional_header_param("idempotency-key", idempotency_key)
        .with_body_param(polling_endpoint_consumer_seek_in)
        .execute(self.cfg)
        .await
    }
}