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
// @generated by xtask/generate_services.py — do not edit by hand.
//! `surveys` — typed methods for all 2 API v3 operations
//! in this module.
//!
//! Access via [`Ghl::v3`](crate::Ghl::v3)`().surveys()`. These endpoints send `Version: v3`.
//!
//! Request and response types come from [`ghl_models::v3::surveys`](https://docs.rs/ghl-models/latest/ghl_models/v3/surveys/); every endpoint is also documented in the
//! [`surveys` API reference](https://github.com/Shahroz/ghl-rs/blob/main/docs/api/surveys.md).
//!
//! Enable with `features = ["surveys"]`.
#![allow(clippy::too_many_arguments)]
use crate::client::Ghl;
use crate::error::Result;
use ghl_models::v3::surveys as models;
/// Typed access to the `surveys` API v3 surface (2 operations). Obtained via
/// [`Ghl::v3`](crate::Ghl::v3)`().surveys()`.
#[derive(Debug, Clone)]
pub struct SurveysService {
pub(crate) client: Ghl,
}
impl SurveysService {
pub(crate) fn new(client: Ghl) -> Self {
Self { client }
}
}
/// Query parameters for [`SurveysService::get_surveys`].
#[derive(Debug, Clone, Default)]
pub struct GetSurveysParams {
/// `locationId` query parameter.
/// Required by the API.
pub location_id: String,
/// `skip` query parameter.
pub skip: Option<f64>,
/// Limit Per Page records count. will allow maximum up to 50 and default will be 10
pub limit: Option<f64>,
/// `type` query parameter.
pub type_: Option<String>,
}
impl GetSurveysParams {
/// Start from the parameters the API requires.
pub fn new(location_id: impl Into<String>) -> Self {
Self {
location_id: location_id.into(),
..Default::default()
}
}
/// Set the `skip` query parameter.
pub fn skip(mut self, v: f64) -> Self {
self.skip = Some(v);
self
}
/// Limit Per Page records count. will allow maximum up to 50 and default will be 10
pub fn limit(mut self, v: f64) -> Self {
self.limit = Some(v);
self
}
/// Set the `type` query parameter.
pub fn type_(mut self, v: impl Into<String>) -> Self {
self.type_ = Some(v.into());
self
}
fn to_query(&self) -> Vec<(String, String)> {
let mut q: Vec<(String, String)> = vec![("locationId".into(), self.location_id.clone())];
if let Some(v) = &self.skip {
q.push(("skip".into(), v.to_string()));
}
if let Some(v) = &self.limit {
q.push(("limit".into(), v.to_string()));
}
if let Some(v) = &self.type_ {
q.push(("type".into(), v.to_string()));
}
q
}
}
/// Query parameters for [`SurveysService::get_surveys_submissions`].
#[derive(Debug, Clone, Default)]
pub struct GetSurveysSubmissionsParams {
/// `locationId` query parameter.
/// Required by the API.
pub location_id: String,
/// Page No. By default it will be 1
pub page: Option<f64>,
/// Limit Per Page records count. will allow maximum up to 100 and default will be 20
pub limit: Option<f64>,
/// Filter submission by survey id
pub survey_id: Option<String>,
/// Filter by contactId, name, email or phone no.
pub q: Option<String>,
/// Get submission by starting of this date. By default it will be same date of last
/// month(YYYY-MM-DD).
pub start_at: Option<String>,
/// Get submission by ending of this date. By default it will be current
/// date(YYYY-MM-DD).
pub end_at: Option<String>,
}
impl GetSurveysSubmissionsParams {
/// Start from the parameters the API requires.
pub fn new(location_id: impl Into<String>) -> Self {
Self {
location_id: location_id.into(),
..Default::default()
}
}
/// Page No. By default it will be 1
pub fn page(mut self, v: f64) -> Self {
self.page = Some(v);
self
}
/// Limit Per Page records count. will allow maximum up to 100 and default will be 20
pub fn limit(mut self, v: f64) -> Self {
self.limit = Some(v);
self
}
/// Filter submission by survey id
pub fn survey_id(mut self, v: impl Into<String>) -> Self {
self.survey_id = Some(v.into());
self
}
/// Filter by contactId, name, email or phone no.
pub fn q(mut self, v: impl Into<String>) -> Self {
self.q = Some(v.into());
self
}
/// Get submission by starting of this date. By default it will be same date of last
/// month(YYYY-MM-DD).
pub fn start_at(mut self, v: impl Into<String>) -> Self {
self.start_at = Some(v.into());
self
}
/// Get submission by ending of this date. By default it will be current
/// date(YYYY-MM-DD).
pub fn end_at(mut self, v: impl Into<String>) -> Self {
self.end_at = Some(v.into());
self
}
fn to_query(&self) -> Vec<(String, String)> {
let mut q: Vec<(String, String)> = vec![("locationId".into(), self.location_id.clone())];
if let Some(v) = &self.page {
q.push(("page".into(), v.to_string()));
}
if let Some(v) = &self.limit {
q.push(("limit".into(), v.to_string()));
}
if let Some(v) = &self.survey_id {
q.push(("surveyId".into(), v.to_string()));
}
if let Some(v) = &self.q {
q.push(("q".into(), v.to_string()));
}
if let Some(v) = &self.start_at {
q.push(("startAt".into(), v.to_string()));
}
if let Some(v) = &self.end_at {
q.push(("endAt".into(), v.to_string()));
}
q
}
}
impl SurveysService {
/// Get Surveys
///
/// `GET /surveys/`
///
/// Requires scope: `surveys.readonly`.
pub async fn get_surveys(
&self,
params: &GetSurveysParams,
) -> Result<models::GetSurveysSuccessfulResponseDto> {
let query = params.to_query();
self.client
.send_versioned(
reqwest::Method::GET,
"/surveys/",
&query,
None::<&()>,
Some("v3"),
)
.await
}
/// Get Surveys Submissions
///
/// `GET /surveys/submissions`
///
/// Requires scope: `surveys.readonly`.
pub async fn get_surveys_submissions(
&self,
params: &GetSurveysSubmissionsParams,
) -> Result<models::GetSurveysSubmissionSuccessfulResponseDto> {
let query = params.to_query();
self.client
.send_versioned(
reqwest::Method::GET,
"/surveys/submissions",
&query,
None::<&()>,
Some("v3"),
)
.await
}
}