twilio_rust_openapi/apis/
api20100401_payload_api.rs

1/*
2 * Twilio - Api
3 *
4 * This is the public Twilio REST API.
5 *
6 * The version of the OpenAPI document: 1.0.0
7 * Contact: support@twilio.com
8 * Generated by: https://openapi-generator.tech
9 */
10
11
12use reqwest;
13use serde::{Deserialize, Serialize};
14use crate::{apis::ResponseContent, models};
15use super::{Error, configuration};
16
17/// struct for passing parameters to the method [`delete_recording_add_on_result_payload`]
18#[derive(Clone, Debug)]
19pub struct DeleteRecordingAddOnResultPayloadParams {
20    /// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to delete.
21    pub account_sid: String,
22    /// The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs.
23    pub reference_sid: String,
24    /// The SID of the AddOnResult to which the payloads to delete belongs.
25    pub add_on_result_sid: String,
26    /// The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to delete.
27    pub sid: String
28}
29
30/// struct for passing parameters to the method [`fetch_recording_add_on_result_payload`]
31#[derive(Clone, Debug)]
32pub struct FetchRecordingAddOnResultPayloadParams {
33    /// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resource to fetch.
34    pub account_sid: String,
35    /// The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs.
36    pub reference_sid: String,
37    /// The SID of the AddOnResult to which the payload to fetch belongs.
38    pub add_on_result_sid: String,
39    /// The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch.
40    pub sid: String
41}
42
43/// struct for passing parameters to the method [`list_recording_add_on_result_payload`]
44#[derive(Clone, Debug)]
45pub struct ListRecordingAddOnResultPayloadParams {
46    /// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to read.
47    pub account_sid: String,
48    /// The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs.
49    pub reference_sid: String,
50    /// The SID of the AddOnResult to which the payloads to read belongs.
51    pub add_on_result_sid: String,
52    /// How many resources to return in each list page. The default is 50, and the maximum is 1000.
53    pub page_size: Option<i32>,
54    /// The page index. This value is simply for client state.
55    pub page: Option<i32>,
56    /// The page token. This is provided by the API.
57    pub page_token: Option<String>
58}
59
60
61/// struct for typed errors of method [`delete_recording_add_on_result_payload`]
62#[derive(Debug, Clone, Serialize, Deserialize)]
63#[serde(untagged)]
64pub enum DeleteRecordingAddOnResultPayloadError {
65    UnknownValue(serde_json::Value),
66}
67
68/// struct for typed errors of method [`fetch_recording_add_on_result_payload`]
69#[derive(Debug, Clone, Serialize, Deserialize)]
70#[serde(untagged)]
71pub enum FetchRecordingAddOnResultPayloadError {
72    UnknownValue(serde_json::Value),
73}
74
75/// struct for typed errors of method [`list_recording_add_on_result_payload`]
76#[derive(Debug, Clone, Serialize, Deserialize)]
77#[serde(untagged)]
78pub enum ListRecordingAddOnResultPayloadError {
79    UnknownValue(serde_json::Value),
80}
81
82
83/// Delete a payload from the result along with all associated Data
84pub async fn delete_recording_add_on_result_payload(configuration: &configuration::Configuration, params: DeleteRecordingAddOnResultPayloadParams) -> Result<(), Error<DeleteRecordingAddOnResultPayloadError>> {
85    let local_var_configuration = configuration;
86
87    // unbox the parameters
88    let account_sid = params.account_sid;
89    let reference_sid = params.reference_sid;
90    let add_on_result_sid = params.add_on_result_sid;
91    let sid = params.sid;
92
93
94    let local_var_client = &local_var_configuration.client;
95
96    let local_var_uri_str = format!("{}/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json", local_var_configuration.base_path, AccountSid=crate::apis::urlencode(account_sid), ReferenceSid=crate::apis::urlencode(reference_sid), AddOnResultSid=crate::apis::urlencode(add_on_result_sid), Sid=crate::apis::urlencode(sid));
97    let mut local_var_req_builder = local_var_client.request(reqwest::Method::DELETE, local_var_uri_str.as_str());
98
99    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
100        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
101    }
102    if let Some(ref local_var_auth_conf) = local_var_configuration.basic_auth {
103        local_var_req_builder = local_var_req_builder.basic_auth(local_var_auth_conf.0.to_owned(), local_var_auth_conf.1.to_owned());
104    };
105
106    let local_var_req = local_var_req_builder.build()?;
107    let local_var_resp = local_var_client.execute(local_var_req).await?;
108
109    let local_var_status = local_var_resp.status();
110    let local_var_content = local_var_resp.text().await?;
111
112    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
113        Ok(())
114    } else {
115        let local_var_entity: Option<DeleteRecordingAddOnResultPayloadError> = serde_json::from_str(&local_var_content).ok();
116        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
117        Err(Error::ResponseError(local_var_error))
118    }
119}
120
121/// Fetch an instance of a result payload
122pub async fn fetch_recording_add_on_result_payload(configuration: &configuration::Configuration, params: FetchRecordingAddOnResultPayloadParams) -> Result<models::ApiPeriodV2010PeriodAccountPeriodRecordingPeriodRecordingAddOnResultPeriodRecordingAddOnResultPayload, Error<FetchRecordingAddOnResultPayloadError>> {
123    let local_var_configuration = configuration;
124
125    // unbox the parameters
126    let account_sid = params.account_sid;
127    let reference_sid = params.reference_sid;
128    let add_on_result_sid = params.add_on_result_sid;
129    let sid = params.sid;
130
131
132    let local_var_client = &local_var_configuration.client;
133
134    let local_var_uri_str = format!("{}/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json", local_var_configuration.base_path, AccountSid=crate::apis::urlencode(account_sid), ReferenceSid=crate::apis::urlencode(reference_sid), AddOnResultSid=crate::apis::urlencode(add_on_result_sid), Sid=crate::apis::urlencode(sid));
135    let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
136
137    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
138        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
139    }
140    if let Some(ref local_var_auth_conf) = local_var_configuration.basic_auth {
141        local_var_req_builder = local_var_req_builder.basic_auth(local_var_auth_conf.0.to_owned(), local_var_auth_conf.1.to_owned());
142    };
143
144    let local_var_req = local_var_req_builder.build()?;
145    let local_var_resp = local_var_client.execute(local_var_req).await?;
146
147    let local_var_status = local_var_resp.status();
148    let local_var_content = local_var_resp.text().await?;
149
150    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
151        serde_json::from_str(&local_var_content).map_err(Error::from)
152    } else {
153        let local_var_entity: Option<FetchRecordingAddOnResultPayloadError> = serde_json::from_str(&local_var_content).ok();
154        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
155        Err(Error::ResponseError(local_var_error))
156    }
157}
158
159/// Retrieve a list of payloads belonging to the AddOnResult
160pub async fn list_recording_add_on_result_payload(configuration: &configuration::Configuration, params: ListRecordingAddOnResultPayloadParams) -> Result<models::ListRecordingAddOnResultPayloadResponse, Error<ListRecordingAddOnResultPayloadError>> {
161    let local_var_configuration = configuration;
162
163    // unbox the parameters
164    let account_sid = params.account_sid;
165    let reference_sid = params.reference_sid;
166    let add_on_result_sid = params.add_on_result_sid;
167    let page_size = params.page_size;
168    let page = params.page;
169    let page_token = params.page_token;
170
171
172    let local_var_client = &local_var_configuration.client;
173
174    let local_var_uri_str = format!("{}/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json", local_var_configuration.base_path, AccountSid=crate::apis::urlencode(account_sid), ReferenceSid=crate::apis::urlencode(reference_sid), AddOnResultSid=crate::apis::urlencode(add_on_result_sid));
175    let mut local_var_req_builder = local_var_client.request(reqwest::Method::GET, local_var_uri_str.as_str());
176
177    if let Some(ref local_var_str) = page_size {
178        local_var_req_builder = local_var_req_builder.query(&[("PageSize", &local_var_str.to_string())]);
179    }
180    if let Some(ref local_var_str) = page {
181        local_var_req_builder = local_var_req_builder.query(&[("Page", &local_var_str.to_string())]);
182    }
183    if let Some(ref local_var_str) = page_token {
184        local_var_req_builder = local_var_req_builder.query(&[("PageToken", &local_var_str.to_string())]);
185    }
186    if let Some(ref local_var_user_agent) = local_var_configuration.user_agent {
187        local_var_req_builder = local_var_req_builder.header(reqwest::header::USER_AGENT, local_var_user_agent.clone());
188    }
189    if let Some(ref local_var_auth_conf) = local_var_configuration.basic_auth {
190        local_var_req_builder = local_var_req_builder.basic_auth(local_var_auth_conf.0.to_owned(), local_var_auth_conf.1.to_owned());
191    };
192
193    let local_var_req = local_var_req_builder.build()?;
194    let local_var_resp = local_var_client.execute(local_var_req).await?;
195
196    let local_var_status = local_var_resp.status();
197    let local_var_content = local_var_resp.text().await?;
198
199    if !local_var_status.is_client_error() && !local_var_status.is_server_error() {
200        serde_json::from_str(&local_var_content).map_err(Error::from)
201    } else {
202        let local_var_entity: Option<ListRecordingAddOnResultPayloadError> = serde_json::from_str(&local_var_content).ok();
203        let local_var_error = ResponseContent { status: local_var_status, content: local_var_content, entity: local_var_entity };
204        Err(Error::ResponseError(local_var_error))
205    }
206}
207