ghl-sdk 0.5.0

Unofficial async Rust SDK for the GoHighLevel (HighLevel) API 2.0 — OAuth 2.0, Private Integration Tokens, rate-limit-aware retries, paginated streams
Documentation
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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
// @generated by xtask/generate_services.py — do not edit by hand.
//! `affiliate-manager` — typed methods for all 4 API v3 operations
//! in this module.
//!
//! Access via [`Ghl::v3`](crate::Ghl::v3)`().affiliate_manager()`. These endpoints send `Version: v3`.
//!
//! Request and response types come from [`ghl_models::v3::affiliate_manager`](https://docs.rs/ghl-models/latest/ghl_models/v3/affiliate_manager/); every endpoint is also documented in the
//! [`affiliate-manager` API reference](https://github.com/Shahroz/ghl-rs/blob/main/docs/api/affiliate-manager.md).
//!
//! Enable with `features = ["affiliate-manager"]`.

#![allow(clippy::too_many_arguments)]

use crate::client::Ghl;
use crate::error::Result;
use ghl_models::v3::affiliate_manager as models;

/// Typed access to the `affiliate-manager` API v3 surface (4 operations). Obtained via
/// [`Ghl::v3`](crate::Ghl::v3)`().affiliate_manager()`.
#[derive(Debug, Clone)]
pub struct AffiliateManagerService {
    pub(crate) client: Ghl,
}

impl AffiliateManagerService {
    pub(crate) fn new(client: Ghl) -> Self {
        Self { client }
    }
}

/// Query parameters for [`AffiliateManagerService::list_affiliates`].
#[derive(Debug, Clone, Default)]
pub struct ListAffiliatesParams {
    /// `query` query parameter.
    pub query: Option<String>,
    /// `active` query parameter.
    pub active: Option<String>,
    /// `campaignId` query parameter.
    pub campaign_id: Option<String>,
    /// `skip` query parameter.
    pub skip: Option<f64>,
    /// Maximum number of records to return. Maximum allowed value is 100.
    pub limit: Option<f64>,
    /// `fromDate` query parameter.
    pub from_date: Option<String>,
    /// `toDate` query parameter.
    pub to_date: Option<String>,
}

impl ListAffiliatesParams {
    /// Start from the parameters the API requires.
    pub fn new() -> Self {
        Self {
            ..Default::default()
        }
    }

    /// Set the `query` query parameter.
    pub fn query(mut self, v: impl Into<String>) -> Self {
        self.query = Some(v.into());
        self
    }

    /// Set the `active` query parameter.
    pub fn active(mut self, v: impl Into<String>) -> Self {
        self.active = Some(v.into());
        self
    }

    /// Set the `campaignId` query parameter.
    pub fn campaign_id(mut self, v: impl Into<String>) -> Self {
        self.campaign_id = Some(v.into());
        self
    }

    /// Set the `skip` query parameter.
    pub fn skip(mut self, v: f64) -> Self {
        self.skip = Some(v);
        self
    }

    /// Maximum number of records to return. Maximum allowed value is 100.
    pub fn limit(mut self, v: f64) -> Self {
        self.limit = Some(v);
        self
    }

    /// Set the `fromDate` query parameter.
    pub fn from_date(mut self, v: impl Into<String>) -> Self {
        self.from_date = Some(v.into());
        self
    }

    /// Set the `toDate` query parameter.
    pub fn to_date(mut self, v: impl Into<String>) -> Self {
        self.to_date = Some(v.into());
        self
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let mut q: Vec<(String, String)> = Vec::new();
        if let Some(v) = &self.query {
            q.push(("query".into(), v.to_string()));
        }
        if let Some(v) = &self.active {
            q.push(("active".into(), v.to_string()));
        }
        if let Some(v) = &self.campaign_id {
            q.push(("campaignId".into(), v.to_string()));
        }
        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.from_date {
            q.push(("fromDate".into(), v.to_string()));
        }
        if let Some(v) = &self.to_date {
            q.push(("toDate".into(), v.to_string()));
        }
        q
    }
}

/// Query parameters for [`AffiliateManagerService::list_commissions`].
#[derive(Debug, Clone, Default)]
pub struct ListCommissionsParams {
    /// Campaign Id
    pub campaign_id: Option<String>,
    /// Affiliate Id
    pub affiliate_id: Option<String>,
    /// Status
    pub status: Option<String>,
    /// Query
    pub query: Option<String>,
    /// `skip` query parameter.
    pub skip: Option<f64>,
    /// Maximum number of records to return. Maximum allowed value is 100.
    pub limit: Option<f64>,
    /// `fromDate` query parameter.
    pub from_date: Option<String>,
    /// `toDate` query parameter.
    pub to_date: Option<String>,
}

impl ListCommissionsParams {
    /// Start from the parameters the API requires.
    pub fn new() -> Self {
        Self {
            ..Default::default()
        }
    }

    /// Campaign Id
    pub fn campaign_id(mut self, v: impl Into<String>) -> Self {
        self.campaign_id = Some(v.into());
        self
    }

    /// Affiliate Id
    pub fn affiliate_id(mut self, v: impl Into<String>) -> Self {
        self.affiliate_id = Some(v.into());
        self
    }

    /// Status
    pub fn status(mut self, v: impl Into<String>) -> Self {
        self.status = Some(v.into());
        self
    }

    /// Query
    pub fn query(mut self, v: impl Into<String>) -> Self {
        self.query = Some(v.into());
        self
    }

    /// Set the `skip` query parameter.
    pub fn skip(mut self, v: f64) -> Self {
        self.skip = Some(v);
        self
    }

    /// Maximum number of records to return. Maximum allowed value is 100.
    pub fn limit(mut self, v: f64) -> Self {
        self.limit = Some(v);
        self
    }

    /// Set the `fromDate` query parameter.
    pub fn from_date(mut self, v: impl Into<String>) -> Self {
        self.from_date = Some(v.into());
        self
    }

    /// Set the `toDate` query parameter.
    pub fn to_date(mut self, v: impl Into<String>) -> Self {
        self.to_date = Some(v.into());
        self
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let mut q: Vec<(String, String)> = Vec::new();
        if let Some(v) = &self.campaign_id {
            q.push(("campaignId".into(), v.to_string()));
        }
        if let Some(v) = &self.affiliate_id {
            q.push(("affiliateId".into(), v.to_string()));
        }
        if let Some(v) = &self.status {
            q.push(("status".into(), v.to_string()));
        }
        if let Some(v) = &self.query {
            q.push(("query".into(), v.to_string()));
        }
        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.from_date {
            q.push(("fromDate".into(), v.to_string()));
        }
        if let Some(v) = &self.to_date {
            q.push(("toDate".into(), v.to_string()));
        }
        q
    }
}

/// Query parameters for [`AffiliateManagerService::list_payouts`].
#[derive(Debug, Clone, Default)]
pub struct ListPayoutsParams {
    /// Payout status
    pub status: Option<String>,
    /// query
    pub query: Option<String>,
    /// Affiliate Id
    pub affiliate_id: Option<String>,
    /// Campaign Id
    pub campaign_id: Option<String>,
    /// `skip` query parameter.
    pub skip: Option<f64>,
    /// `limit` query parameter.
    pub limit: Option<f64>,
    /// `start` query parameter.
    pub start: Option<String>,
    /// `end` query parameter.
    pub end: Option<String>,
}

impl ListPayoutsParams {
    /// Start from the parameters the API requires.
    pub fn new() -> Self {
        Self {
            ..Default::default()
        }
    }

    /// Payout status
    pub fn status(mut self, v: impl Into<String>) -> Self {
        self.status = Some(v.into());
        self
    }

    /// query
    pub fn query(mut self, v: impl Into<String>) -> Self {
        self.query = Some(v.into());
        self
    }

    /// Affiliate Id
    pub fn affiliate_id(mut self, v: impl Into<String>) -> Self {
        self.affiliate_id = Some(v.into());
        self
    }

    /// Campaign Id
    pub fn campaign_id(mut self, v: impl Into<String>) -> Self {
        self.campaign_id = Some(v.into());
        self
    }

    /// Set the `skip` query parameter.
    pub fn skip(mut self, v: f64) -> Self {
        self.skip = Some(v);
        self
    }

    /// Set the `limit` query parameter.
    pub fn limit(mut self, v: f64) -> Self {
        self.limit = Some(v);
        self
    }

    /// Set the `start` query parameter.
    pub fn start(mut self, v: impl Into<String>) -> Self {
        self.start = Some(v.into());
        self
    }

    /// Set the `end` query parameter.
    pub fn end(mut self, v: impl Into<String>) -> Self {
        self.end = Some(v.into());
        self
    }

    fn to_query(&self) -> Vec<(String, String)> {
        let mut q: Vec<(String, String)> = Vec::new();
        if let Some(v) = &self.status {
            q.push(("status".into(), v.to_string()));
        }
        if let Some(v) = &self.query {
            q.push(("query".into(), v.to_string()));
        }
        if let Some(v) = &self.affiliate_id {
            q.push(("affiliateId".into(), v.to_string()));
        }
        if let Some(v) = &self.campaign_id {
            q.push(("campaignId".into(), v.to_string()));
        }
        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.start {
            q.push(("start".into(), v.to_string()));
        }
        if let Some(v) = &self.end {
            q.push(("end".into(), v.to_string()));
        }
        q
    }
}

impl AffiliateManagerService {
    /// List Affiliates
    ///
    /// Retrieve the list of affiliates for a location.
    ///
    /// `GET /affiliate-manager/{locationId}/affiliates`
    ///
    /// Requires scope: `affiliate-manager.readonly`.
    pub async fn list_affiliates(
        &self,
        location_id: &str,
        params: &ListAffiliatesParams,
    ) -> Result<models::ListAffiliatesResponseDto> {
        let path = format!(
            "/affiliate-manager/{}/affiliates",
            crate::services::encode(location_id)
        );
        let query = params.to_query();
        self.client
            .send_versioned(reqwest::Method::GET, &path, &query, None::<&()>, Some("v3"))
            .await
    }

    /// Get Affiliate
    ///
    /// Retrieve a single affiliate by id for a location.
    ///
    /// `GET /affiliate-manager/{locationId}/affiliates/{affiliateId}`
    ///
    /// Requires scope: `affiliate-manager.readonly`.
    pub async fn get_affiliate(
        &self,
        location_id: &str,
        affiliate_id: &str,
    ) -> Result<models::GetAffiliateResponseDto> {
        let path = format!(
            "/affiliate-manager/{}/affiliates/{}",
            crate::services::encode(location_id),
            crate::services::encode(affiliate_id)
        );
        let query = Vec::new();
        self.client
            .send_versioned(reqwest::Method::GET, &path, &query, None::<&()>, Some("v3"))
            .await
    }

    /// List Commissions
    ///
    /// Retrieve the list of commissions for a location.
    ///
    /// `GET /affiliate-manager/{locationId}/commissions`
    ///
    /// Requires scope: `affiliate-manager.readonly`.
    pub async fn list_commissions(
        &self,
        location_id: &str,
        params: &ListCommissionsParams,
    ) -> Result<models::GetCommissionListResponseDto> {
        let path = format!(
            "/affiliate-manager/{}/commissions",
            crate::services::encode(location_id)
        );
        let query = params.to_query();
        self.client
            .send_versioned(reqwest::Method::GET, &path, &query, None::<&()>, Some("v3"))
            .await
    }

    /// List Payouts
    ///
    /// Retrieve the list of payouts for a location.
    ///
    /// `GET /affiliate-manager/{locationId}/payouts`
    ///
    /// Requires scope: `affiliate-manager.readonly`.
    pub async fn list_payouts(
        &self,
        location_id: &str,
        params: &ListPayoutsParams,
    ) -> Result<models::GetPayoutListResponseDto> {
        let path = format!(
            "/affiliate-manager/{}/payouts",
            crate::services::encode(location_id)
        );
        let query = params.to_query();
        self.client
            .send_versioned(reqwest::Method::GET, &path, &query, None::<&()>, Some("v3"))
            .await
    }
}