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
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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289

//! Connected social accounts, their health, and X communities.

use serde::{Deserialize, Serialize};

use super::common::{HealthStatus, Platform};

/// A connected account as the list endpoint returns it.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Account {
    pub id: String,
    #[serde(default)]
    pub workspace_id: Option<String>,
    pub platform: String,
    #[serde(default)]
    pub username: Option<String>,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub avatar: Option<String>,
    #[serde(default)]
    pub is_primary: Option<bool>,
    #[serde(default)]
    pub active: Option<bool>,
    #[serde(default)]
    pub health_status: Option<HealthStatus>,
    #[serde(default)]
    pub last_health_check: Option<String>,
}

/// The workspace an account belongs to, as `GET /accounts/{id}` reports it.
#[derive(Debug, Clone, Deserialize)]
pub struct AccountWorkspaceRef {
    pub id: String,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub slug: Option<String>,
    #[serde(rename = "type", default)]
    pub workspace_type: Option<String>,
}

/// One account in full, with the workspace it belongs to.
#[derive(Debug, Clone, Deserialize)]
pub struct AccountDetail {
    pub id: String,
    #[serde(default)]
    pub workspace_id: Option<String>,
    pub platform: String,
    #[serde(default)]
    pub username: Option<String>,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub avatar: Option<String>,
    #[serde(default)]
    pub workspace: Option<AccountWorkspaceRef>,
    #[serde(default)]
    pub created_at: Option<String>,
    #[serde(default)]
    pub updated_at: Option<String>,
}

/// A newly connected account.
#[derive(Debug, Clone, Deserialize)]
pub struct AccountCreated {
    pub id: String,
    #[serde(default)]
    pub workspace_id: Option<String>,
    pub platform: String,
    #[serde(default)]
    pub username: Option<String>,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub avatar: Option<String>,
    #[serde(default)]
    pub created_at: Option<String>,
    #[serde(default)]
    pub updated_at: Option<String>,
}

/// Whether one account's credentials still work.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AccountHealth {
    pub id: String,
    #[serde(default)]
    pub platform: Option<String>,
    #[serde(default)]
    pub username: Option<String>,
    #[serde(default)]
    pub active: Option<bool>,
    #[serde(default)]
    pub health_status: Option<HealthStatus>,
    #[serde(default)]
    pub last_health_check: Option<String>,
}

/// One row of the account health sweep.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AccountHealthRow {
    pub id: String,
    #[serde(default)]
    pub workspace_id: Option<String>,
    #[serde(default)]
    pub platform: Option<String>,
    #[serde(default)]
    pub username: Option<String>,
    #[serde(default)]
    pub health_status: Option<HealthStatus>,
    #[serde(default)]
    pub last_health_check: Option<String>,
}

/// How many accounts sit in each health state.
#[derive(Debug, Clone, Deserialize)]
pub struct AccountHealthCounts {
    #[serde(default)]
    pub total: u32,
    #[serde(default)]
    pub healthy: u32,
    #[serde(default)]
    pub degraded: u32,
    #[serde(default)]
    pub expired: u32,
    #[serde(default)]
    pub revoked: u32,
    #[serde(default)]
    pub unknown: u32,
}

/// The whole account health picture, per account and in total.
#[derive(Debug, Clone, Deserialize)]
pub struct AccountsHealthSummary {
    #[serde(default)]
    pub accounts: Vec<AccountHealthRow>,
    pub summary: AccountHealthCounts,
}

/// The result of toggling the primary flag.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PrimaryToggled {
    pub id: String,
    #[serde(default)]
    pub is_primary: bool,
}

/// The verdict of a credential check.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CredentialCheck {
    #[serde(default)]
    pub account_id: Option<String>,
    #[serde(default)]
    pub platform: Option<String>,
    #[serde(default)]
    pub valid: bool,
    #[serde(default)]
    pub health_status: Option<HealthStatus>,
}

/// The result of refreshing an OAuth token.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TokenRefreshed {
    #[serde(default)]
    pub message: Option<String>,
    #[serde(default)]
    pub expires_at: Option<String>,
}

/// One snapshot of an account's audience, oldest first.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AccountHistoryPoint {
    #[serde(default)]
    pub followers: Option<i64>,
    #[serde(default)]
    pub following: Option<i64>,
    #[serde(default)]
    pub total_posts: Option<i64>,
    #[serde(default)]
    pub reach: Option<i64>,
    #[serde(default)]
    pub profile_views: Option<i64>,
    #[serde(default)]
    pub fetched_at: Option<String>,
}

/// An account's audience over time.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AccountAnalyticsHistory {
    #[serde(default)]
    pub account_id: Option<String>,
    #[serde(default)]
    pub platform: Option<String>,
    #[serde(default)]
    pub username: Option<String>,
    #[serde(default)]
    pub history: Vec<AccountHistoryPoint>,
}

/// An X community an account can post into.
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Community {
    /// The row id, which is what removing one takes.
    pub id: i64,
    #[serde(default)]
    pub account_id: Option<String>,
    /// The id X itself uses.
    #[serde(default)]
    pub community_id: Option<String>,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub member_count: Option<i64>,
    #[serde(default)]
    pub description: Option<String>,
    #[serde(default)]
    pub image_url: Option<String>,
    #[serde(default)]
    pub last_synced_at: Option<String>,
    #[serde(default)]
    pub created_at: Option<String>,
}

/// A community search hit, straight from X.
#[derive(Debug, Clone, Deserialize)]
pub struct CommunitySearchResult {
    pub id: String,
    #[serde(default)]
    pub name: Option<String>,
    #[serde(default)]
    pub description: Option<String>,
    #[serde(default)]
    pub member_count: Option<i64>,
}

/// The body of `POST /accounts` — connecting an account with credentials you
/// already hold, instead of running the OAuth flow in the dashboard.
#[derive(Debug, Clone, Serialize)]
pub struct CreateAccount {
    #[serde(rename = "workspaceId")]
    pub workspace_id: String,
    pub platform: Platform,
    pub username: String,
    pub name: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub avatar: Option<String>,
    /// Platform credentials. What belongs here differs per platform.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub credentials: Option<std::collections::HashMap<String, serde_json::Value>>,
}

impl CreateAccount {
    pub fn new(
        workspace_id: impl Into<String>,
        platform: Platform,
        username: impl Into<String>,
        name: impl Into<String>,
    ) -> Self {
        Self {
            workspace_id: workspace_id.into(),
            platform,
            username: username.into(),
            name: name.into(),
            avatar: None,
            credentials: None,
        }
    }

    pub fn credentials(
        mut self,
        credentials: std::collections::HashMap<String, serde_json::Value>,
    ) -> Self {
        self.credentials = Some(credentials);
        self
    }

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