Struct mailchimp_api::conversations::Conversations
source · pub struct Conversations {
pub client: Client,
}Fields
client: ClientImplementations
sourceimpl Conversations
impl Conversations
sourcepub async fn get(
&self,
fields: &[String],
exclude_fields: &[String],
count: i64,
offset: i64,
has_unread_messages: IsRead,
list_id: &str,
campaign_id: &str
) -> Result<TrackedConversations>
pub async fn get(
&self,
fields: &[String],
exclude_fields: &[String],
count: i64,
offset: i64,
has_unread_messages: IsRead,
list_id: &str,
campaign_id: &str
) -> Result<TrackedConversations>
List conversations.
This function performs a GET to the /conversations endpoint.
Get a list of conversations for the account. Conversations has been deprecated in favor of Inbox and these endpoints don’t include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.
Parameters:
fields: &[String]– A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.exclude_fields: &[String]– A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.count: i64– The number of records to return. Default value is 10. Maximum value is 1000.offset: i64– Used for pagination, this it the number of records from a collection to skip. Default value is 0.has_unread_messages: crate::types::IsRead– Whether a conversation message has been marked as read.list_id: &str– The unique id for the list.campaign_id: &str– The unique id for the campaign.
sourcepub async fn get_conversations(
&self,
fields: &[String],
exclude_fields: &[String],
conversation_id: &str
) -> Result<Conversation>
pub async fn get_conversations(
&self,
fields: &[String],
exclude_fields: &[String],
conversation_id: &str
) -> Result<Conversation>
Get conversation.
This function performs a GET to the /conversations/{conversation_id} endpoint.
Get details about an individual conversation. Conversations has been deprecated in favor of Inbox and these endpoints don’t include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.
Parameters:
fields: &[String]– A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.exclude_fields: &[String]– A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.conversation_id: &str– The unique id for the conversation.
sourcepub async fn get_message(
&self,
fields: &[String],
exclude_fields: &[String],
conversation_id: &str,
is_read: IsRead,
before_timestamp: Option<DateTime<Utc>>,
since_timestamp: Option<DateTime<Utc>>
) -> Result<CollectionOfConversationMessages>
pub async fn get_message(
&self,
fields: &[String],
exclude_fields: &[String],
conversation_id: &str,
is_read: IsRead,
before_timestamp: Option<DateTime<Utc>>,
since_timestamp: Option<DateTime<Utc>>
) -> Result<CollectionOfConversationMessages>
List messages.
This function performs a GET to the /conversations/{conversation_id}/messages endpoint.
Get messages from a specific conversation. Conversations has been deprecated in favor of Inbox and these endpoints don’t include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.
Parameters:
fields: &[String]– A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.exclude_fields: &[String]– A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.conversation_id: &str– The unique id for the conversation.is_read: crate::types::IsRead– Whether a conversation message has been marked as read.before_timestamp: chrono::DateTime<chrono::Utc>– Restrict the response to messages created before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.since_timestamp: chrono::DateTime<chrono::Utc>– Restrict the response to messages created after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
sourcepub async fn get_message_conversations(
&self,
fields: &[String],
exclude_fields: &[String],
conversation_id: &str,
message_id: &str
) -> Result<ConversationMessage>
pub async fn get_message_conversations(
&self,
fields: &[String],
exclude_fields: &[String],
conversation_id: &str,
message_id: &str
) -> Result<ConversationMessage>
Get message.
This function performs a GET to the /conversations/{conversation_id}/messages/{message_id} endpoint.
Get an individual message in a conversation. Conversations has been deprecated in favor of Inbox and these endpoints don’t include Inbox data. Past Conversations are still available via this endpoint, but new campaign replies and other Inbox messages aren’t available using this endpoint.
Parameters:
fields: &[String]– A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.exclude_fields: &[String]– A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.conversation_id: &str– The unique id for the conversation.message_id: &str– The unique id for the conversation message.