fopost 0.1.0

Official Rust SDK for the FoPost API. Schedule and publish to +30 social platforms from your code.
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

//! Webhooks — the push side of the API.

use serde::{Deserialize, Serialize};

use super::common::string_enum;

string_enum! {
    /// What a webhook can subscribe to.
    pub enum WebhookEvent {
        PostPublished => "post.published",
        PostFailed => "post.failed",
        PostPartiallyFailed => "post.partially_failed",
        DeliveryPublished => "delivery.published",
        DeliveryFailed => "delivery.failed",
        DeliveryDelayed => "delivery.delayed",
        AccountHealthChanged => "account.health_changed",
    }
}

/// A registered webhook.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Webhook {
    pub id: String,
    #[serde(default)]
    pub workspace_id: Option<String>,
    pub url: String,
    #[serde(default)]
    pub events: Vec<WebhookEvent>,
    #[serde(default)]
    pub active: bool,
    #[serde(default)]
    pub last_triggered_at: Option<String>,
    /// Consecutive delivery failures. The API stops calling a dead endpoint.
    #[serde(default)]
    pub failure_count: u32,
    #[serde(default)]
    pub created_at: Option<String>,
}

/// A newly created webhook. `secret` is shown once — store it now, it signs
/// every delivery so you can verify the payload really came from FoPost.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct WebhookCreated {
    pub id: String,
    #[serde(default)]
    pub workspace_id: Option<String>,
    pub url: String,
    /// The signing secret, returned only at creation.
    pub secret: String,
    #[serde(default)]
    pub events: Vec<WebhookEvent>,
    #[serde(default)]
    pub active: bool,
    #[serde(default)]
    pub created_at: Option<String>,
}

/// The body of `POST /webhooks`.
#[derive(Debug, Clone, Serialize)]
pub struct CreateWebhook {
    #[serde(rename = "workspaceId")]
    pub workspace_id: String,
    pub url: String,
    pub events: Vec<WebhookEvent>,
}

impl CreateWebhook {
    pub fn new(
        workspace_id: impl Into<String>,
        url: impl Into<String>,
        events: impl IntoIterator<Item = WebhookEvent>,
    ) -> Self {
        Self {
            workspace_id: workspace_id.into(),
            url: url.into(),
            events: events.into_iter().collect(),
        }
    }
}

/// The body of `PUT /webhooks/{id}`. Only the fields you set are sent.
#[derive(Debug, Clone, Default, Serialize)]
pub struct UpdateWebhook {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub events: Option<Vec<WebhookEvent>>,
    /// Pause a webhook without deleting it.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub active: Option<bool>,
}

impl UpdateWebhook {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn url(mut self, url: impl Into<String>) -> Self {
        self.url = Some(url.into());
        self
    }

    pub fn events(mut self, events: impl IntoIterator<Item = WebhookEvent>) -> Self {
        self.events = Some(events.into_iter().collect());
        self
    }

    pub fn active(mut self, active: bool) -> Self {
        self.active = Some(active);
        self
    }
}