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

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

#[derive(Default)]
pub struct BackgroundTaskListOptions {
    /// Filter the response based on the status.
    pub status: Option<BackgroundTaskStatus>,

    /// Filter the response based on the type.
    pub task: Option<BackgroundTaskType>,

    /// 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>,
}

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

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

    /// List background tasks executed in the past 90 days.
    pub async fn list(
        &self,
        options: Option<BackgroundTaskListOptions>,
    ) -> Result<ListResponseBackgroundTaskOut> {
        let BackgroundTaskListOptions {
            status,
            task,
            limit,
            iterator,
            order,
        } = options.unwrap_or_default();

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

    /// Get a background task by ID.
    pub async fn get(&self, task_id: String) -> Result<BackgroundTaskOut> {
        crate::request::Request::new(http1::Method::GET, "/api/v1/background-task/{task_id}")
            .with_path_param("task_id", task_id)
            .execute(self.cfg)
            .await
    }
}