Struct sendgrid_api::contacts_api_segments::ContactsApiSegments

pub struct ContactsApiSegments {
    pub client: Client,
}

Fields

client: Client

Implementations

impl ContactsApiSegments

pub async fn get_contactdb_segments(&self) -> Result<ListAllSegmentsResponse>

Retrieve all segments.

This function performs a GET to the /contactdb/segments endpoint.

This endpoint allows you to retrieve all of your segments.

Parameters:

• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn post_contactdb_segment(
    &self,
    body: &ContactdbSegments
) -> Result<ContactdbSegmentsWithAllOf>

Create a Segment.

This function performs a POST to the /contactdb/segments endpoint.

This endpoint allows you to create a new segment.

Valid operators for create and update depend on the type of the field for which you are searching.

Dates

• “eq”, “ne”, “lt” (before), “gt” (after)
  • You may use MM/DD/YYYY for day granularity or an epoch for second granularity.
• “empty”, “not_empty”
• “is within”
  • You may use an ISO 8601 date format or the # of days.

Text

• “contains”
• “eq” (is/equals - matches the full field)
• “ne” (is not/not equals - matches any field where the entire field is not the condition value)
• “empty”
• “not_empty”

Numbers

• “eq” (is/equals)
• “lt” (is less than)
• “gt” (is greater than)
• “empty”
• “not_empty”

Email Clicks and Opens

• “eq” (opened)
• “ne” (not opened)

All field values must be a string.

Conditions using “eq” or “ne” for email clicks and opens should provide a “field” of either clicks.campaign_identifier or opens.campaign_identifier. The condition value should be a string containing the id of a completed campaign.

The conditions list may contain multiple conditions, joined by an “and” or “or” in the “and_or” field.

The first condition in the conditions list must have an empty “and_or”, and subsequent conditions must all specify an “and_or”.

Parameters:

• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get_contactdb_segments_segment(
    &self,
    segment_id: &str
) -> Result<ContactdbSegments>

Retrieve a segment.

This function performs a GET to the /contactdb/segments/{segment_id} endpoint.

This endpoint allows you to retrieve a single segment with the given ID.

Parameters:

• segment_id: i64 – The ID of the segment you want to request.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn delete_contactdb_segments_segment(
    &self,
    segment_id: &str,
    delete_contacts: bool,
    body: &Value
) -> Result<()>

Delete a segment.

This function performs a DELETE to the /contactdb/segments/{segment_id} endpoint.

This endpoint allows you to delete a segment from your recipients database.

You also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment.

Parameters:

• delete_contacts: bool – True to delete all contacts matching the segment in addition to deleting the segment.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn patch_contactdb_segments_segment(
    &self,
    segment_id: &str,
    body: &PatchContactdbSegmentsSegmentRequest
) -> Result<ContactdbSegments>

Update a segment.

This function performs a PATCH to the /contactdb/segments/{segment_id} endpoint.

This endpoint allows you to update a segment.

Parameters:

• segment_id: &str – The license key provided with your New Relic account.
• on_behalf_of: &str – The license key provided with your New Relic account.

pub async fn get_contactdb_segments_segment_recipients(
    &self,
    segment_id: i64,
    page: i64,
    page_size: i64
) -> Result<ListRecipientsOnASegmentResponse>

Retrieve recipients on a segment.

This function performs a GET to the /contactdb/segments/{segment_id}/recipients endpoint.

This endpoint allows you to retrieve all of the recipients in a segment with the given ID.

Parameters:

• page: i64
• page_size: i64
• on_behalf_of: &str – The license key provided with your New Relic account.