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
use anyhow::Result;
use crate::Client;
pub struct SegmentingContacts {
pub client: Client,
}
impl SegmentingContacts {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
SegmentingContacts { client }
}
/**
* Get List of Segments.
*
* This function performs a `GET` to the `/marketing/segments` endpoint.
*
* **This endpoint allows you to retrieve a list of segments.**
*
* 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 of list ids to be used when searching for segments with the specified parent_list_id, no more than 50 is allowed.
* * `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_marketing_segments(
&self,
parent_list_ids: &str,
no_parent_list_id: bool,
) -> Result<crate::types::GetMarketingSegmentsResponse> {
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?{}", query_);
self.client.get(&url, None).await
}
/**
* Create Segment.
*
* This function performs a `POST` to the `/marketing/segments` endpoint.
*
* **This endpoint allows you to create a segment.**
*/
pub async fn post_marketing_segment(
&self,
body: &crate::types::PostMarketingSegmentsRequestAllOf,
) -> Result<crate::types::FullSegmentAllOf> {
let url = "/marketing/segments".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/{segment_id}` endpoint.
*
* **This endpoint allows you to retrieve a single segment by ID.**
*
* **Parameters:**
*
* * `query_json: bool` -- Defaults to `false`. Set to `true` to return the parsed SQL AST as a JSON object in the field `query_json`.
*/
pub async fn get_marketing_segments_segment(
&self,
segment_id: &str,
query_json: bool,
) -> Result<crate::types::FullSegmentAllOf> {
let mut query_args: Vec<(String, String)> = Default::default();
if query_json {
query_args.push(("query_json".to_string(), query_json.to_string()));
}
let query_ = serde_urlencoded::to_string(&query_args).unwrap();
let url = format!(
"/marketing/segments/{}?{}",
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/{segment_id}` endpoint.
*
* **This endpoint allows you to delete a segment by `segment_id`.**
*
* Note that deleting a segment does not delete the contacts associated with the segment by default. Contacts associated with a deleted segment will remain in your list of all contacts and any other segments they belong to.
*/
pub async fn delete_marketing_segments_segment(
&self,
segment_id: &str,
) -> Result<crate::types::Help> {
let url = format!(
"/marketing/segments/{}",
crate::progenitor_support::encode_path(segment_id),
);
self.client.delete(&url, None).await
}
/**
* Update Segment.
*
* This function performs a `PATCH` to the `/marketing/segments/{segment_id}` endpoint.
*
* **This endpoint allows you to update a segment.**
*
* Segment `name` needs to be unique. A user can not update a segment name to an existing one.
*/
pub async fn patch_marketing_segments_segment(
&self,
segment_id: &str,
body: &crate::types::SegmentWriteV2,
) -> Result<crate::types::FullSegmentAllOf> {
let url = format!(
"/marketing/segments/{}",
crate::progenitor_support::encode_path(segment_id),
);
self.client
.patch(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
/**
* Bulk Delete Segments.
*
* This function performs a `POST` to the `/marketing/segments/delete` endpoint.
*
* This endpoint allows you to delete segments in bulk.
*
* If the segments are used by automations or the segments do not exist in the database, the segment IDs that could not be deleted along with automation IDs that are associated to those segments will be returned.
*/
pub async fn post_marketing_segments_delete(
&self,
body: &crate::types::PostMarketingSegmentsDeleteRequest,
) -> Result<crate::types::PostMarketingSegmentsDeleteResponse> {
let url = "/marketing/segments/delete".to_string();
self.client
.post(&url, Some(reqwest::Body::from(serde_json::to_vec(body)?)))
.await
}
}