svix 1.96.1

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
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

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

#[derive(Default)]
pub struct IntegrationListOptions {
    /// 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 IntegrationCreateOptions {
    pub idempotency_key: Option<String>,
}

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

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

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

    /// List the application's integrations.
    pub async fn list(
        &self,
        app_id: String,
        options: Option<IntegrationListOptions>,
    ) -> Result<ListResponseIntegrationOut> {
        let IntegrationListOptions {
            limit,
            iterator,
            order,
        } = options.unwrap_or_default();

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

    /// Create an integration.
    pub async fn create(
        &self,
        app_id: String,
        integration_in: IntegrationIn,
        options: Option<IntegrationCreateOptions>,
    ) -> Result<IntegrationOut> {
        let IntegrationCreateOptions { idempotency_key } = options.unwrap_or_default();

        crate::request::Request::new(http1::Method::POST, "/api/v1/app/{app_id}/integration")
            .with_path_param("app_id", app_id)
            .with_optional_header_param("idempotency-key", idempotency_key)
            .with_body_param(integration_in)
            .execute(self.cfg)
            .await
    }

    /// Get an integration.
    pub async fn get(&self, app_id: String, integ_id: String) -> Result<IntegrationOut> {
        crate::request::Request::new(
            http1::Method::GET,
            "/api/v1/app/{app_id}/integration/{integ_id}",
        )
        .with_path_param("app_id", app_id)
        .with_path_param("integ_id", integ_id)
        .execute(self.cfg)
        .await
    }

    /// Update an integration.
    pub async fn update(
        &self,
        app_id: String,
        integ_id: String,
        integration_update: IntegrationUpdate,
    ) -> Result<IntegrationOut> {
        crate::request::Request::new(
            http1::Method::PUT,
            "/api/v1/app/{app_id}/integration/{integ_id}",
        )
        .with_path_param("app_id", app_id)
        .with_path_param("integ_id", integ_id)
        .with_body_param(integration_update)
        .execute(self.cfg)
        .await
    }

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

    /// Get an integration's key.
    #[deprecated]
    pub async fn get_key(&self, app_id: String, integ_id: String) -> Result<IntegrationKeyOut> {
        crate::request::Request::new(
            http1::Method::GET,
            "/api/v1/app/{app_id}/integration/{integ_id}/key",
        )
        .with_path_param("app_id", app_id)
        .with_path_param("integ_id", integ_id)
        .execute(self.cfg)
        .await
    }

    /// Rotate the integration's key. The previous key will be immediately
    /// revoked.
    pub async fn rotate_key(
        &self,
        app_id: String,
        integ_id: String,
        options: Option<IntegrationRotateKeyOptions>,
    ) -> Result<IntegrationKeyOut> {
        let IntegrationRotateKeyOptions { idempotency_key } = options.unwrap_or_default();

        crate::request::Request::new(
            http1::Method::POST,
            "/api/v1/app/{app_id}/integration/{integ_id}/key/rotate",
        )
        .with_path_param("app_id", app_id)
        .with_path_param("integ_id", integ_id)
        .with_optional_header_param("idempotency-key", idempotency_key)
        .execute(self.cfg)
        .await
    }
}