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
use anyhow::Result;
use crate::Client;
pub struct SegmentingContactsBeta {
pub client: Client,
}
impl SegmentingContactsBeta {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
SegmentingContactsBeta { client }
}
/**
* Get List of Segments.
*
* This function performs a `GET` to the `/marketing/segments/2.0` endpoint.
*
* **The Segmentation V2 API is currently in private beta. If you'd like to be added to the beta, please fill out this [form](https://docs.google.com/forms/d/e/1FAIpQLSd5zwC9dRk8lAp1oTWjdGc-aSY69flW_7wnutvKBhpUluSnfQ/viewform)**
*
* The query param `parent_list_ids` is treated as a filter. Any match will be returned. 0 matches will return a response code of 200 with an empty `results` array.
*
* `parent_list_ids` | `no_parent_list_id` | `result`
* -----------------:|:--------------------:|:-------------
* empty | false | all segments
* values | false | segments filtered by list_ids
* values | true | segments filtered by list_ids and segments with no parent list_ids
* empty | true | segments with no parent list_ids
*
* **Parameters:**
*
* * `parent_list_ids: &str` -- A comma separated list up to 50 in size, to filter segments on. Only segments that have any of these list ids as the parent list will be retrieved. This is different from the parameter of the same name used when creating a segment.
* * `no_parent_list_id: bool` -- If set to `true` segments with an empty value of `parent_list_id` will be returned in the filter. If the value is not present it defaults to 'false'.
*/
pub async fn get_segments(
&self,
parent_list_ids: &str,
no_parent_list_id: bool,
) -> Result<crate::types::AllSegmentsResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if no_parent_list_id {
query_args.push((
"no_parent_list_id".to_string(),
no_parent_list_id.to_string(),
));
}
if !parent_list_ids.is_empty() {
query_args.push(("parent_list_ids".to_string(), parent_list_ids.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!("/marketing/segments/2.0?{}", query_);
self.client.get(&url, None).await
}
/**
* Create Segment.
*
* This function performs a `POST` to the `/marketing/segments/2.0` endpoint.
*
* **The Segmentation V2 API is currently in private beta. If you'd like to be added to the beta, please fill out this [form](https://docs.google.com/forms/d/e/1FAIpQLSd5zwC9dRk8lAp1oTWjdGc-aSY69flW_7wnutvKBhpUluSnfQ/viewform)**
*
* Segment `name` has to be unique. A user can not create a new segment with an existing segment name.
*/
pub async fn post_segment(
&self,
body: &crate::types::SegmentWriteV2,
) -> Result<crate::types::SegmentResponse> {
let url = "/marketing/segments/2.0".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Get Segment by ID.
*
* This function performs a `GET` to the `/marketing/segments/2.0/{segment_id}` endpoint.
*
* **The Segmentation V2 API is currently in private beta. If you'd like to be added to the beta, please fill out this [form](https://docs.google.com/forms/d/e/1FAIpQLSd5zwC9dRk8lAp1oTWjdGc-aSY69flW_7wnutvKBhpUluSnfQ/viewform)**
*
* **Parameters:**
*
* * `contacts_sample: bool` -- Defaults to `true`. Set to `false` to exclude the contacts_sample in the response.
*/
pub async fn get_segments_segment(
&self,
segment_id: &str,
contacts_sample: bool,
) -> Result<crate::types::SegmentResponse> {
let mut query_args: Vec<(String, String)> = Default::default();
if contacts_sample {
query_args.push(("contacts_sample".to_string(), contacts_sample.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/marketing/segments/2.0/{}?{}",
crate::progenitor_support::encode_path(segment_id),
query_
);
self.client.get(&url, None).await
}
/**
* Delete segment.
*
* This function performs a `DELETE` to the `/marketing/segments/2.0/{segment_id}` endpoint.
*
* **The Segmentation V2 API is currently in private beta. If you'd like to be added to the beta, please fill out this [form](https://docs.google.com/forms/d/e/1FAIpQLSd5zwC9dRk8lAp1oTWjdGc-aSY69flW_7wnutvKBhpUluSnfQ/viewform)**
*/
pub async fn delete_segments_segment(&self, segment_id: &str) -> Result<()> {
let url = format!(
"/marketing/segments/2.0/{}",
crate::progenitor_support::encode_path(segment_id),
);
self.client.delete(&url, None).await
}
/**
* Update Segment.
*
* This function performs a `PATCH` to the `/marketing/segments/2.0/{segment_id}` endpoint.
*
* **The Segmentation V2 API is currently in private beta. If you'd like to be added to the beta, please fill out this [form](https://docs.google.com/forms/d/e/1FAIpQLSd5zwC9dRk8lAp1oTWjdGc-aSY69flW_7wnutvKBhpUluSnfQ/viewform)**
*
* Segment `name` has to be unique. A user can not create a new segment with an existing segment name.
*/
pub async fn patch_segments_segment(
&self,
segment_id: &str,
body: &crate::types::SegmentUpdate,
) -> Result<crate::types::SegmentResponse> {
let url = format!(
"/marketing/segments/2.0/{}",
crate::progenitor_support::encode_path(segment_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
}