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
use crate::Client;
use crate::ClientResult;
pub struct CustomFields {
pub client: Client,
}
impl CustomFields {
#[doc(hidden)]
pub fn new(client: Client) -> Self {
CustomFields { client }
}
/**
* Get All Field Definitions.
*
* This function performs a `GET` to the `/marketing/field_definitions` endpoint.
*
* **This endpoint retrieves all defined Custom Fields and Reserved Fields.**
*/
pub async fn get_mc_field_definitions(
&self,
) -> ClientResult<crate::Response<crate::types::GetMcFieldDefinitionsResponse>> {
let url = self.client.url("/marketing/field_definitions", None);
self.client
.get(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Create Custom Field Definition.
*
* This function performs a `POST` to the `/marketing/field_definitions` endpoint.
*
* **This endpoint creates a new custom field definition.**
*
* Custom field definitions are created with the given `name` and `field_type`. Although field names are stored in a case-sensitive manner, all field names must be case-insensitively unique. This means you may create a field named `CamelCase` or `camelcase`, but not both. Additionally, a Custom Field name cannot collide with any Reserved Field names. You should save the returned `id` value in order to update or delete the field at a later date. You can have up to 120 custom fields.
*
* The custom field name should be created using only alphanumeric characters (A-Z and 0-9) and underscores (\_). Custom fields can only begin with letters A-Z or underscores (_). The field type can be date, text, or number fields. The field type is important for creating segments from your contact database.
*
* **Note: Creating a custom field that begins with a number will cause issues with sending in Marketing Campaigns.**
*/
pub async fn post_mc_field_definition(
&self,
body: &crate::types::PostMcFieldDefinitionsRequest,
) -> ClientResult<crate::Response<crate::types::PostMcFieldDefinitionsResponseAllOf>> {
let url = self.client.url("/marketing/field_definitions", None);
self.client
.post(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
/**
* Delete Custom Field Definition.
*
* This function performs a `DELETE` to the `/marketing/field_definitions/{custom_field_id}` endpoint.
*
* **This endpoint deletes a defined Custom Field.**
*
* You cand delete only Custom Fields; Reserved Fields cannot be deleted.
*/
pub async fn delete_mc_field_definitions_custom(
&self,
custom_field_id: &str,
) -> ClientResult<crate::Response<()>> {
let url = self.client.url(
&format!(
"/marketing/field_definitions/{}",
crate::progenitor_support::encode_path(custom_field_id),
),
None,
);
self.client
.delete(
&url,
crate::Message {
body: None,
content_type: None,
},
)
.await
}
/**
* Update Custom Field Definition.
*
* This function performs a `PATCH` to the `/marketing/field_definitions/{custom_field_id}` endpoint.
*
* **This endopoint allows you to update a defined Custom Field.**
*
* Only your Custom fields can be modified; Reserved Fields cannot be updated.
*/
pub async fn patch_mc_field_definitions_custom(
&self,
custom_field_id: &str,
body: &crate::types::IpPool,
) -> ClientResult<crate::Response<crate::types::PostMcFieldDefinitionsResponseAllOf>> {
let url = self.client.url(
&format!(
"/marketing/field_definitions/{}",
crate::progenitor_support::encode_path(custom_field_id),
),
None,
);
self.client
.patch(
&url,
crate::Message {
body: Some(reqwest::Body::from(serde_json::to_vec(body)?)),
content_type: Some("application/json".to_string()),
},
)
.await
}
}