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

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

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

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

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

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

    /// Download a JSON file containing all org-settings and event types.
    ///
    /// Note that the schema for [`EnvironmentOut`] is subject to change. The
    /// fields herein are provided for convenience but should be treated as
    /// JSON blobs.
    pub async fn export(
        &self,
        options: Option<EnvironmentExportOptions>,
    ) -> Result<EnvironmentOut> {
        let EnvironmentExportOptions { idempotency_key } = options.unwrap_or_default();

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

    /// Import a configuration into the active organization.
    ///
    /// It doesn't delete anything, only adds / updates what was passed to it.
    ///
    /// Note that the schema for [`EnvironmentIn`] is subject to change. The
    /// fields herein are provided for convenience but should be treated as
    /// JSON blobs.
    pub async fn import(
        &self,
        environment_in: EnvironmentIn,
        options: Option<EnvironmentImportOptions>,
    ) -> Result<()> {
        let EnvironmentImportOptions { idempotency_key } = options.unwrap_or_default();

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