Skip to main content

loops_so/client/
campaigns.rs

1use super::{LoopsClient, Page, check};
2use crate::error::Result;
3use crate::generated::{
4    CampaignResponse, CreateCampaignRequest, CreateCampaignRequestParams, CreateCampaignResponse,
5    CreateCampaignResponseEnum, EmailMetricsResponse, GetCampaignMetricsRequest,
6    GetCampaignMetricsResponse, GetCampaignRequest, GetCampaignResponse, ListCampaignsRequest,
7    ListCampaignsRequestQuery, ListCampaignsResponse, ListCampaignsResponseEnum,
8    UpdateCampaignRequest, UpdateCampaignRequestParams, UpdateCampaignResponse,
9};
10use crate::routes::Route;
11
12impl LoopsClient {
13    /// List campaigns.
14    pub async fn list_campaigns(&self, page: Page) -> Result<ListCampaignsResponse> {
15        const ACTION: &str = "list campaigns";
16        let query = ListCampaignsRequestQuery {
17            per_page: page.per_page_param(),
18            cursor: page.cursor,
19        };
20        let raw = self
21            .send(Route::ListCampaigns, &[], |r| r.query(&query))
22            .await?;
23        match raw
24            .parse(ACTION, ListCampaignsRequest::parse_response)
25            .await?
26        {
27            ListCampaignsResponseEnum::Ok(campaigns) => Ok(campaigns),
28            _ => Err(raw.unexpected(ACTION)),
29        }
30    }
31
32    /// Get a campaign.
33    pub async fn get_campaign(&self, campaign_id: &str) -> Result<CampaignResponse> {
34        const ACTION: &str = "get campaign";
35        let raw = self.send(Route::GetCampaign, &[campaign_id], |r| r).await?;
36        match raw
37            .parse(ACTION, GetCampaignRequest::parse_response)
38            .await?
39        {
40            GetCampaignResponse::Ok(campaign) => Ok(campaign),
41            _ => Err(raw.unexpected(ACTION)),
42        }
43    }
44
45    /// Create a draft campaign, together with its email message.
46    pub async fn create_campaign(&self, name: &str) -> Result<CreateCampaignResponse> {
47        const ACTION: &str = "create campaign";
48        let body = CreateCampaignRequest {
49            name: name.to_owned(),
50            ..Default::default()
51        };
52        check(&body)?;
53        let raw = self
54            .send(Route::CreateCampaign, &[], |r| r.json(&body))
55            .await?;
56        match raw
57            .parse(ACTION, CreateCampaignRequestParams::parse_response)
58            .await?
59        {
60            CreateCampaignResponseEnum::Created(campaign) => Ok(campaign),
61            _ => Err(raw.unexpected(ACTION)),
62        }
63    }
64
65    /// Rename a campaign.
66    pub async fn update_campaign(&self, campaign_id: &str, name: &str) -> Result<CampaignResponse> {
67        const ACTION: &str = "update campaign";
68        let body = UpdateCampaignRequest {
69            name: Some(name.to_owned()),
70            ..Default::default()
71        };
72        let raw = self
73            .send(Route::UpdateCampaign, &[campaign_id], |r| r.json(&body))
74            .await?;
75        match raw
76            .parse(ACTION, UpdateCampaignRequestParams::parse_response)
77            .await?
78        {
79            UpdateCampaignResponse::Ok(campaign) => Ok(campaign),
80            _ => Err(raw.unexpected(ACTION)),
81        }
82    }
83
84    /// All-time engagement metrics of a sent campaign. Opens and clicks count
85    /// sends, not events: a send opened five times counts once.
86    ///
87    /// # Errors
88    ///
89    /// [`LoopsError::Api`](crate::LoopsError::Api) with status 400 when the
90    /// campaign has not been sent or has no email message.
91    pub async fn get_campaign_metrics(&self, campaign_id: &str) -> Result<EmailMetricsResponse> {
92        const ACTION: &str = "get campaign metrics";
93        let raw = self
94            .send(Route::GetCampaignMetrics, &[campaign_id], |r| r)
95            .await?;
96        match raw
97            .parse(ACTION, GetCampaignMetricsRequest::parse_response)
98            .await?
99        {
100            GetCampaignMetricsResponse::Ok(metrics) => Ok(metrics),
101            _ => Err(raw.unexpected(ACTION)),
102        }
103    }
104}