termii_rust/async_impl/rest/switch/
campaign.rs

1//! Send and manage campaigns sent to your organization's phonebook.
2//!
3//! Create, view & manage phonebooks using these APIs.
4//!
5//! Each phonebook can be identified by a unique ID, which makes it easier to edit or delete a phonebook.
6
7use std::{collections::HashMap, sync::Arc};
8
9use async_trait::async_trait;
10
11use crate::{
12    async_impl::http::client,
13    common::{
14        errors, pagination,
15        switch::campaign::{
16            PhoneBookCreateUpdateDeleteResponse, PhoneBookCreateUpdateRequest, PhoneBookItem,
17            PhoneBookListResponse,
18        },
19    },
20};
21
22#[derive(Debug)]
23pub struct Campaign<'a> {
24    api_key: &'a str,
25    client: Arc<client::HttpClient>,
26}
27
28impl<'a> Campaign<'a> {
29    pub(crate) fn new(api_key: &'a str, client: Arc<client::HttpClient>) -> Campaign<'a> {
30        Campaign { api_key, client }
31    }
32
33    pub(crate) async fn _get(&self, page: &str) -> Result<Vec<PhoneBookItem>, errors::HttpError> {
34        let mut params = HashMap::new();
35        params.insert("api_key", self.api_key);
36        params.insert("page", page);
37
38        let response = self.client.get("phonebooks", Some(params), None).await?;
39
40        let campaign_item = response_or_error_text_async!(response, PhoneBookListResponse);
41
42        Ok(campaign_item.data)
43    }
44
45    /// Fetch Phonebooks.
46    ///
47    /// ## Examples
48    ///
49    /// ```rust
50    /// use termii_rust::{async_impl::rest::termii, common::switch::campaign::PhoneBookItem};
51    ///
52    /// let client = termii::Termii::new("Your API key");
53    ///
54    /// let phonebooks: Vec<PhoneBookItem> = client.switch.campaign.get(Some(1)).await.unwrap();
55    ///
56    /// println!("{:?}", phonebooks);
57    /// ```
58    /// ### The above code is limited by termii's pagination. You can get all your phonebooks with the **all** function like such
59    ///
60    /// ```rust
61    /// let phonebooks: Vec<PhoneBookItem> = client.switch.campaign.all().await.unwrap();
62    /// ```
63    pub async fn get(&self, page: Option<&str>) -> Result<Vec<PhoneBookItem>, errors::HttpError> {
64        let page = page.unwrap_or("1");
65        let campaign_items = self._get(page).await?;
66        Ok(campaign_items)
67    }
68
69    /// Fetch Phonebooks.
70    ///
71    /// ## Examples
72    ///
73    /// ```rust
74    /// use termii_rust::{
75    ///     async_impl::rest::termii,
76    ///     common::switch::campaign::{
77    ///         PhoneBookCreateUpdateDeleteResponse, PhoneBookCreateUpdateRequest,
78    ///     },
79    /// };
80    ///
81    /// let client = termii::Termii::new("Your API key");
82    ///
83    /// let phonebook_create_request = PhoneBookCreateUpdateRequest {
84    ///     phonebook_name: "My Phonebook".to_string(),
85    ///     description: "My Phonebook".to_string(),
86    /// };
87    ///
88    /// let phonebook_create_response: PhoneBookCreateUpdateDeleteResponse = client
89    ///     .switch
90    ///     .campaign
91    ///     .create(phonebook_create_request)
92    ///     .await
93    ///     .unwrap();
94    ///
95    /// println!("{:?}", phonebook_create_response);
96    /// ```
97    pub async fn create(
98        &self,
99        mut payload: PhoneBookCreateUpdateRequest,
100    ) -> Result<PhoneBookCreateUpdateDeleteResponse, errors::HttpError> {
101        payload.set_api_key(self.api_key);
102
103        let response = self
104            .client
105            .post("phonebooks", None, None, Some(payload))
106            .await?;
107
108        let campaign_create_response =
109            response_or_error_text_async!(response, PhoneBookCreateUpdateDeleteResponse);
110
111        Ok(campaign_create_response)
112    }
113
114    /// Update Phonebook.
115    ///
116    /// ## Examples
117    ///
118    /// ```rust
119    /// use termii_rust::{
120    ///     async_impl::rest::termii,
121    ///     common::switch::campaign::{
122    ///         PhoneBookCreateUpdateDeleteResponse, PhoneBookCreateUpdateRequest,
123    ///     },
124    /// };
125    ///
126    /// let client = termii::Termii::new("Your API key");
127    ///
128    /// let phonebook_update_request = PhoneBookCreateUpdateRequest {
129    ///     phonebook_name: "My Phonebook".to_string(),
130    ///     description: "My Phonebook".to_string(),
131    /// };
132    ///
133    /// let phonebook_update_response: PhoneBookCreateUpdateDeleteResponse = client
134    ///     .switch
135    ///     .campaign
136    ///     .update(
137    ///         "f9c28de9-ab5a-4513-9c9f-338be8e1c390",
138    ///         phonebook_update_request,
139    ///     )
140    ///     .await
141    ///     .unwrap();
142    ///
143    /// println!("{:?}", phonebook_update_response);
144    /// ```
145    pub async fn update(
146        &self,
147        phonebook_id: &str,
148        mut payload: PhoneBookCreateUpdateRequest,
149    ) -> Result<PhoneBookCreateUpdateDeleteResponse, errors::HttpError> {
150        payload.set_api_key(self.api_key);
151
152        let response = self
153            .client
154            .patch(
155                format!("phonebooks/{}", phonebook_id).as_str(),
156                None,
157                None,
158                Some(payload),
159            )
160            .await?;
161
162        let campaign_update_response =
163            response_or_error_text_async!(response, PhoneBookCreateUpdateDeleteResponse);
164
165        Ok(campaign_update_response)
166    }
167
168    /// Delete Phonebook.
169    ///
170    /// ## Examples
171    ///
172    /// ```rust
173    /// use termii_rust::{
174    ///     async_impl::rest::termii, common::switch::campaign::PhoneBookCreateUpdateDeleteResponse,
175    /// };
176    ///
177    /// let client = termii::Termii::new("Your API key");
178    ///
179    /// let phonebook_delete_response: PhoneBookCreateUpdateDeleteResponse = client
180    ///     .switch
181    ///     .campaign
182    ///     .delete("f9c28de9-ab5a-4513-9c9f-338be8e1c390")
183    ///     .await
184    ///     .unwrap();
185    ///
186    /// println!("{:?}", phonebook_delete_response);
187    /// ```
188    pub async fn delete(
189        &self,
190        phonebook_id: &str,
191    ) -> Result<PhoneBookCreateUpdateDeleteResponse, errors::HttpError> {
192        let response = self
193            .client
194            .delete(format!("phonebooks/{}", phonebook_id).as_str(), None, None)
195            .await?;
196
197        let campaign_delete_response =
198            response_or_error_text_async!(response, PhoneBookCreateUpdateDeleteResponse);
199
200        Ok(campaign_delete_response)
201    }
202}
203
204#[async_trait]
205impl pagination::PaginatedResourceAsync for Campaign<'_> {
206    type Item = PhoneBookItem;
207
208    async fn _get(&self, page: &str) -> Result<Vec<Self::Item>, errors::HttpError> {
209        Campaign::_get(self, page).await
210    }
211}
termii_rust/async_impl/rest/switch/campaign.rs

termii_rust/async_impl/rest/switch/
campaign.rs
