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
// @generated by xtask/generate_services.py — do not edit by hand.
//! `brand-boards` — typed methods for all 5 API v2 operations
//! in this module.
//!
//! Access via [`Ghl::brand_boards`](crate::Ghl::brand_boards).
//!
//! Request and response types come from [`ghl_models::v2::brand_boards`](https://docs.rs/ghl-models/latest/ghl_models/v2/brand_boards/); every endpoint is also documented in the
//! [`brand-boards` API reference](https://github.com/Shahroz/ghl-rs/blob/main/docs/api/brand-boards.md).
//!
//! Enable with `features = ["brand-boards"]`.
#![allow(clippy::too_many_arguments)]
use crate::client::Ghl;
use crate::error::Result;
use ghl_models::v2::brand_boards as models;
/// Typed access to the `brand-boards` API v2 surface (5 operations). Obtained via
/// [`Ghl::brand_boards`](crate::Ghl::brand_boards).
#[derive(Debug, Clone)]
pub struct BrandBoardsService {
pub(crate) client: Ghl,
}
impl BrandBoardsService {
pub(crate) fn new(client: Ghl) -> Self {
Self { client }
}
}
/// Query parameters for [`BrandBoardsService::get_brand_boards`].
#[derive(Debug, Clone, Default)]
pub struct GetBrandBoardsParams {
/// Maximum number of brand boards to return
pub limit: Option<f64>,
/// Number of brand boards to skip for pagination
pub offset: Option<f64>,
/// Search term to filter brand boards by name
pub search: Option<String>,
/// Include deleted brand boards in results
pub deleted: Option<bool>,
}
impl GetBrandBoardsParams {
/// Start from the parameters the API requires.
pub fn new() -> Self {
Self {
..Default::default()
}
}
/// Maximum number of brand boards to return
pub fn limit(mut self, v: f64) -> Self {
self.limit = Some(v);
self
}
/// Number of brand boards to skip for pagination
pub fn offset(mut self, v: f64) -> Self {
self.offset = Some(v);
self
}
/// Search term to filter brand boards by name
pub fn search(mut self, v: impl Into<String>) -> Self {
self.search = Some(v.into());
self
}
/// Include deleted brand boards in results
pub fn deleted(mut self, v: bool) -> Self {
self.deleted = Some(v);
self
}
fn to_query(&self) -> Vec<(String, String)> {
let mut q: Vec<(String, String)> = Vec::new();
if let Some(v) = &self.limit {
q.push(("limit".into(), v.to_string()));
}
if let Some(v) = &self.offset {
q.push(("offset".into(), v.to_string()));
}
if let Some(v) = &self.search {
q.push(("search".into(), v.to_string()));
}
if let Some(v) = &self.deleted {
q.push(("deleted".into(), v.to_string()));
}
q
}
}
impl BrandBoardsService {
/// Create a new brand board
///
/// Creates a new brand board with logos, colors, and fonts
///
/// `POST /brand-boards/`
///
/// Requires scope: `brand-boards/design-kit.write`.
pub async fn create_a_new_brand_board(
&self,
body: &models::CreateBrandBoardParam,
) -> Result<models::GetBrandBoardSuccessDTO> {
let query = Vec::new();
self.client
.send_versioned(
reqwest::Method::POST,
"/brand-boards/",
&query,
Some(body),
Some("2021-07-28"),
)
.await
}
/// Get Brand Boards
///
/// Retrieves all Brand Boards for a specific location
///
/// `GET /brand-boards/{locationId}`
///
/// Requires scope: `brand-boards/design-kit.readonly`.
pub async fn get_brand_boards(
&self,
location_id: &str,
params: &GetBrandBoardsParams,
) -> Result<models::GetBrandBoardsByLocationSuccessDTO> {
let path = format!("/brand-boards/{}", crate::services::encode(location_id));
let query = params.to_query();
self.client
.send_versioned(
reqwest::Method::GET,
&path,
&query,
None::<&()>,
Some("2021-07-28"),
)
.await
}
/// Delete a Brand Board
///
/// Deletes a Brand Board
///
/// `DELETE /brand-boards/{locationId}/{id}`
///
/// Requires scope: `brand-boards/design-kit.write`.
pub async fn delete_a_brand_board(
&self,
location_id: &str,
id: &str,
) -> Result<models::GetBrandBoardSuccessDTO> {
let path = format!(
"/brand-boards/{}/{}",
crate::services::encode(location_id),
crate::services::encode(id)
);
let query = Vec::new();
self.client
.send_versioned(
reqwest::Method::DELETE,
&path,
&query,
None::<&()>,
Some("2021-07-28"),
)
.await
}
/// Get Brand Board
///
/// Retrieves a specific Brand Board by its ID
///
/// `GET /brand-boards/{locationId}/{id}`
///
/// Requires scope: `brand-boards/design-kit.readonly`.
pub async fn get_brand_board(
&self,
location_id: &str,
id: &str,
) -> Result<models::GetBrandBoardSuccessDTO> {
let path = format!(
"/brand-boards/{}/{}",
crate::services::encode(location_id),
crate::services::encode(id)
);
let query = Vec::new();
self.client
.send_versioned(
reqwest::Method::GET,
&path,
&query,
None::<&()>,
Some("2021-07-28"),
)
.await
}
/// Update a Brand Board
///
/// Updates an existing Brand Board
///
/// `PATCH /brand-boards/{locationId}/{id}`
///
/// Requires scope: `brand-boards/design-kit.write`.
pub async fn update_a_brand_board(
&self,
location_id: &str,
id: &str,
body: &models::UpdateBrandBoardBody,
) -> Result<models::GetBrandBoardSuccessDTO> {
let path = format!(
"/brand-boards/{}/{}",
crate::services::encode(location_id),
crate::services::encode(id)
);
let query = Vec::new();
self.client
.send_versioned(
reqwest::Method::PATCH,
&path,
&query,
Some(body),
Some("2021-07-28"),
)
.await
}
}