//!
//! AUTO-GENERATED CODE - DO NOT EDIT!
//!
//! Loops OpenAPI Spec
//! Source: target/openapi.normalized.json
//! Version: 1.22.1
//! Generated by `oas3-gen v0.28.0`
//!
//! This is the OpenAPI Spec for the [Loops API](https://loops.so/docs/api).
use super::types::*;
use anyhow::Context;
use reqwest::{Client, Url};
use validator::Validate;
pub const BASE_URL: &str = "https://app.loops.so/api";
#[derive(Debug, Clone)]
pub struct LoopsOpenApiSpecClient {
pub client: Client,
pub base_url: Url,
}
impl Default for LoopsOpenApiSpecClient {
fn default() -> Self {
Self::new()
}
}
impl LoopsOpenApiSpecClient {
/// Create a client using the OpenAPI `servers[0]` URL.
#[must_use]
#[track_caller]
pub fn new() -> Self {
Self {
client: Client::builder().build().expect("client"),
base_url: Url::parse(BASE_URL).expect("valid base url"),
}
}
/// Create a client with a custom base URL.
pub fn with_base_url(base_url: impl AsRef<str>) -> anyhow::Result<Self> {
Ok(Self {
client: Client::builder()
.build()
.context("building reqwest client")?,
base_url: Url::parse(base_url.as_ref()).context("parsing base url")?,
})
}
/// Create a client from an existing `reqwest::Client`.
pub fn with_client(base_url: impl AsRef<str>, client: Client) -> anyhow::Result<Self> {
let url = Url::parse(base_url.as_ref()).context("parsing base url")?;
Ok(Self {
client,
base_url: url,
})
}
/// API key
///
/// Test your API key and get team context.
///
/// * Path: `GET /v1/api-key`
pub async fn test_api_key(
&self,
request: TestApiKeyRequest,
) -> anyhow::Result<TestApiKeyResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("api-key");
let response = self.client.get(url).send().await?;
Ok(TestApiKeyRequest::parse_response(response).await?)
}
/// Get an audience segment
///
/// Retrieve a single audience segment by ID.
///
/// * Path: `GET /v1/audience-segments/{audienceSegmentId}`
pub async fn get_audience_segment(
&self,
request: GetAudienceSegmentRequest,
) -> anyhow::Result<GetAudienceSegmentResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("audience-segments")
.push(&request.path.audience_segment_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetAudienceSegmentRequest::parse_response(response).await?)
}
/// List audience segments
///
/// Retrieve a paginated list of audience segments, most recently created first.
///
/// * Path: `GET /v1/audience-segments`
pub async fn list_audience_segments(
&self,
request: ListAudienceSegmentsRequest,
) -> anyhow::Result<ListAudienceSegmentsResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("audience-segments");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListAudienceSegmentsRequest::parse_response(response).await?)
}
/// Create an audience segment
///
/// Create a new audience segment.
///
/// * Path: `POST /v1/audience-segments`
pub async fn create_audience_segment(
&self,
request: CreateAudienceSegmentRequestParams,
) -> anyhow::Result<GetAudienceSegmentResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("audience-segments");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateAudienceSegmentRequestParams::parse_response(response).await?)
}
/// List campaigns
///
/// Retrieve a paginated list of campaigns.
///
/// * Path: `GET /v1/campaigns`
pub async fn list_campaigns(
&self,
request: ListCampaignsRequest,
) -> anyhow::Result<ListCampaignsResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("campaigns");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListCampaignsRequest::parse_response(response).await?)
}
/// Create a campaign
///
/// Create a new draft campaign. An empty email message is created automatically and its `emailMessageId` is returned. Use the `/email-messages/{emailMessageId}` endpoint to set subject, sender, preview text, and LMX content. The audience (mailing list, segment, or filter), group, and scheduling can be set on create or later via update.
///
/// * Path: `POST /v1/campaigns`
pub async fn create_campaign(
&self,
request: CreateCampaignRequestParams,
) -> anyhow::Result<CreateCampaignResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("campaigns");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateCampaignRequestParams::parse_response(response).await?)
}
/// Get a campaign
///
/// Retrieve a single campaign by ID.
///
/// * Path: `GET /v1/campaigns/{campaignId}`
pub async fn get_campaign(
&self,
request: GetCampaignRequest,
) -> anyhow::Result<GetCampaignResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("campaigns")
.push(&request.path.campaign_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetCampaignRequest::parse_response(response).await?)
}
/// Update a campaign
///
/// Update a draft campaign's name, group, audience (mailing list, segment, or filter), or scheduling. At least one field must be provided. Once a campaign has been sent, only its `name` and `campaignGroupId` can be updated.
///
/// * Path: `POST /v1/campaigns/{campaignId}`
pub async fn update_campaign(
&self,
request: UpdateCampaignRequestParams,
) -> anyhow::Result<UpdateCampaignResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("campaigns")
.push(&request.path.campaign_id.to_string());
let response = self.client.post(url).json(&request.body).send().await?;
Ok(UpdateCampaignRequestParams::parse_response(response).await?)
}
/// Get campaign metrics
///
/// Retrieve all-time email engagement metrics for a campaign.
///
/// * Path: `GET /v1/campaigns/{campaignId}/metrics`
pub async fn get_campaign_metrics(
&self,
request: GetCampaignMetricsRequest,
) -> anyhow::Result<GetCampaignMetricsResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("campaigns")
.push(&request.path.campaign_id.to_string())
.push("metrics");
let response = self.client.get(url).send().await?;
Ok(GetCampaignMetricsRequest::parse_response(response).await?)
}
/// List campaign groups
///
/// Retrieve a paginated list of campaign groups, most recently created first.
///
/// * Path: `GET /v1/campaign-groups`
pub async fn list_campaign_groups(
&self,
request: ListCampaignGroupsRequest,
) -> anyhow::Result<ListCampaignGroupsResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("campaign-groups");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListCampaignGroupsRequest::parse_response(response).await?)
}
/// Create a campaign group
///
/// Create a new campaign group.
///
/// * Path: `POST /v1/campaign-groups`
pub async fn create_campaign_group(
&self,
request: CreateCampaignGroupRequest,
) -> anyhow::Result<CreateCampaignGroupResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("campaign-groups");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateCampaignGroupRequest::parse_response(response).await?)
}
/// Get a campaign group
///
/// Retrieve a single campaign group by ID.
///
/// * Path: `GET /v1/campaign-groups/{campaignGroupId}`
pub async fn get_campaign_group(
&self,
request: GetCampaignGroupRequest,
) -> anyhow::Result<GetCampaignGroupResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("campaign-groups")
.push(&request.path.campaign_group_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetCampaignGroupRequest::parse_response(response).await?)
}
/// Update a campaign group
///
/// Update a campaign group's name or description. At least one field must be provided. The reserved "Unsorted" group cannot be edited.
///
/// * Path: `POST /v1/campaign-groups/{campaignGroupId}`
pub async fn update_campaign_group(
&self,
request: UpdateCampaignGroupRequest,
) -> anyhow::Result<GetCampaignGroupResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("campaign-groups")
.push(&request.path.campaign_group_id.to_string());
let response = self.client.post(url).json(&request.body).send().await?;
Ok(UpdateCampaignGroupRequest::parse_response(response).await?)
}
/// List dedicated sending IP addresses
///
/// Retrieve a list of Loops' dedicated sending IP addresses.
///
/// This endpoint is provided for the rare instances where you may need to whitelist our sending IPs. Please note that this list is subject to change and will not include shared IPs used for sending mail.
///
/// Unless you are sure you need this and are comfortable watching for changes, we strongly recommend you _do not_ whitelist these IPs.
///
/// * Path: `GET /v1/dedicated-sending-ips`
pub async fn list_dedicated_sending_ips(
&self,
request: ListDedicatedSendingIpsRequest,
) -> anyhow::Result<ListDedicatedSendingIpsResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("dedicated-sending-ips");
let response = self.client.get(url).send().await?;
Ok(ListDedicatedSendingIpsRequest::parse_response(response).await?)
}
/// Create a contact
///
/// Add a contact to your audience.
///
/// * Path: `POST /v1/contacts/create`
pub async fn create_contact(
&self,
request: CreateContactRequest,
) -> anyhow::Result<CreateContactResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("contacts")
.push("create");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateContactRequest::parse_response(response).await?)
}
/// Update a contact
///
/// Update a contact by `email` or `userId`. You must provide one of these parameters.
///
/// If you want to update a contact's email address, the contact will first need a `userId` value. You can then make a request containing the `userId` field along with an updated email address.
///
/// This endpoint will create a contact if a matching contact does not already exist in your audience.
///
/// Provide either `email` or `userId` to identify the contact you want to update. If both are provided, the system will look for a contact with either a matching `email` or `userId` value. If a contact is found for one of the values (e.g. `email`), the other value (e.g. `userId`) will be updated. If a contact is not found, a new contact will be created using both `email` and `userId` values.
///
/// * Path: `PUT /v1/contacts/update`
pub async fn update_contact(
&self,
request: UpdateContactRequest,
) -> anyhow::Result<UpdateContactResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("contacts")
.push("update");
let response = self.client.put(url).json(&request.body).send().await?;
Ok(UpdateContactRequest::parse_response(response).await?)
}
/// Find a contact
///
/// Search for a contact by `email` or `userId`. Only one parameter is allowed.
///
/// * Path: `GET /v1/contacts/find`
pub async fn find_contact(
&self,
request: FindContactRequest,
) -> anyhow::Result<FindContactResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("contacts")
.push("find");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(FindContactRequest::parse_response(response).await?)
}
/// Delete a contact
///
/// Delete a contact by `email` or `userId`.
///
/// * Path: `POST /v1/contacts/delete`
pub async fn delete_contact(
&self,
request: DeleteContactRequest,
) -> anyhow::Result<DeleteContactResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("contacts")
.push("delete");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(DeleteContactRequest::parse_response(response).await?)
}
/// Get suppression status for a contact
///
/// Retrieve suppression status and removal quota for a contact by `email` or `userId`. Include only one query parameter.
///
/// * Path: `GET /v1/contacts/suppression`
pub async fn get_contact_suppression(
&self,
request: GetContactSuppressionRequest,
) -> anyhow::Result<GetContactSuppressionResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("contacts")
.push("suppression");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(GetContactSuppressionRequest::parse_response(response).await?)
}
/// Remove a contact from suppression list
///
/// Remove a suppressed contact from the suppression list by `email` or `userId`. Include only one query parameter.
///
/// * Path: `DELETE /v1/contacts/suppression`
pub async fn remove_contact_suppression(
&self,
request: RemoveContactSuppressionRequest,
) -> anyhow::Result<RemoveContactSuppressionResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("contacts")
.push("suppression");
let response = self.client.delete(url).query(&request.query).send().await?;
Ok(RemoveContactSuppressionRequest::parse_response(response).await?)
}
/// List contact properties
///
/// Retrieve a list of your account's contact properties.<br>Use the `list` parameter to query "all" or "custom" properties.
///
/// * Path: `GET /v1/contacts/properties`
pub async fn list_contact_properties(
&self,
request: ListContactPropertiesRequest,
) -> anyhow::Result<ListContactPropertiesResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("contacts")
.push("properties");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListContactPropertiesRequest::parse_response(response).await?)
}
/// Create a contact property
///
/// Create a custom contact property.
///
/// * Path: `POST /v1/contacts/properties`
pub async fn create_contact_property(
&self,
request: CreateContactPropertyRequest,
) -> anyhow::Result<CreateContactPropertyResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("contacts")
.push("properties");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateContactPropertyRequest::parse_response(response).await?)
}
/// Get a component
///
/// Retrieve a single component by ID.
///
/// * Path: `GET /v1/components/{componentId}`
pub async fn get_component(
&self,
request: GetComponentRequest,
) -> anyhow::Result<GetComponentResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("components")
.push(&request.path.component_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetComponentRequest::parse_response(response).await?)
}
/// Update a component
///
/// Update a component's name and/or body. When the `lmx` body changes, the update cascades to every email using this component, and `affectedEmailCount` reports how many were affected. A change that would introduce a dynamic variable an email using the component cannot use is rejected.
///
/// * Path: `POST /v1/components/{componentId}`
pub async fn update_component(
&self,
request: UpdateComponentRequest,
) -> anyhow::Result<UpdateComponentResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("components")
.push(&request.path.component_id.to_string());
let response = self.client.post(url).json(&request.body).send().await?;
Ok(UpdateComponentRequest::parse_response(response).await?)
}
/// List components
///
/// Retrieve a paginated list of email components.
///
/// * Path: `GET /v1/components`
pub async fn list_components(
&self,
request: ListComponentsRequest,
) -> anyhow::Result<ListComponentsResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("components");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListComponentsRequest::parse_response(response).await?)
}
/// Create a component
///
/// Create a new email component from an LMX body.
///
/// * Path: `POST /v1/components`
pub async fn create_component(
&self,
request: CreateComponentRequest,
) -> anyhow::Result<CreateComponentResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("components");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateComponentRequest::parse_response(response).await?)
}
/// Get an email message
///
/// Retrieve an email message, including its compiled LMX content.
///
/// * Path: `GET /v1/email-messages/{emailMessageId}`
pub async fn get_email_message(
&self,
request: GetEmailMessageRequest,
) -> anyhow::Result<GetEmailMessageResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("email-messages")
.push(&request.path.email_message_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetEmailMessageRequest::parse_response(response).await?)
}
/// Update an email message
///
/// Update fields on an email message (subject, preview text, sender, LMX content). The campaign must be in draft status. Supply `expectedRevisionId` matching the current `contentRevisionId` — the server rejects mismatched revisions with 409.
///
/// * Path: `POST /v1/email-messages/{emailMessageId}`
pub async fn update_email_message(
&self,
request: UpdateEmailMessageRequestParams,
) -> anyhow::Result<UpdateEmailMessageResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("email-messages")
.push(&request.path.email_message_id.to_string());
let response = self.client.post(url).json(&request.body).send().await?;
Ok(UpdateEmailMessageRequestParams::parse_response(response).await?)
}
/// Send a preview of an email message
///
/// Send a test preview of an email message to one or more addresses. The accepted variable fields depend on the parent's type - campaign previews accept `contactProperties`, workflow previews accept `contactProperties` and `eventProperties`, and transactional previews accept `dataVariables`. Supplying a field the parent cannot reference is rejected with 400.
///
/// * Path: `POST /v1/email-messages/{emailMessageId}/preview`
pub async fn preview_email_message(
&self,
request: PreviewEmailMessageRequest,
) -> anyhow::Result<PreviewEmailMessageResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("email-messages")
.push(&request.path.email_message_id.to_string())
.push("preview");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(PreviewEmailMessageRequest::parse_response(response).await?)
}
/// Run Guardian checks on an email message
///
/// Validate an email message's content against Guardian rules and return any errors and warnings. Errors must be resolved before the email can be published, warnings are advisory.
///
/// * Path: `GET /v1/email-messages/{emailMessageId}/guardian`
pub async fn get_email_message_guardian(
&self,
request: GetEmailMessageGuardianRequest,
) -> anyhow::Result<GetEmailMessageGuardianResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("email-messages")
.push(&request.path.email_message_id.to_string())
.push("guardian");
let response = self.client.get(url).send().await?;
Ok(GetEmailMessageGuardianRequest::parse_response(response).await?)
}
/// Send an event
///
/// Send events to trigger workflows.
///
/// * Path: `POST /v1/events/send`
pub async fn send_event(&self, request: SendEventRequest) -> anyhow::Result<SendEventResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("events")
.push("send");
let response = self
.client
.post(url)
.headers(
http::HeaderMap::try_from(&request.header).context("building request headers")?,
)
.json(&request.body)
.send()
.await?;
Ok(SendEventRequest::parse_response(response).await?)
}
/// List event patterns
///
/// Retrieve a paginated list of event patterns available to workflow event trigger nodes.
///
/// * Path: `GET /v1/event-patterns`
pub async fn list_event_patterns(
&self,
request: ListEventPatternsRequest,
) -> anyhow::Result<ListEventPatternsResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("event-patterns");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListEventPatternsRequest::parse_response(response).await?)
}
/// Get an event pattern by name
///
/// Retrieve event pattern details by event name for a workflow event trigger. Event names are case-sensitive, so `PaymentReceived` and `paymentReceived` are different events.
///
/// * Path: `GET /v1/event-patterns/by-name/{eventName}`
pub async fn get_event_pattern_by_name(
&self,
request: GetEventPatternByNameRequest,
) -> anyhow::Result<GetEventPatternResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("event-patterns")
.push("by-name")
.push(&request.path.event_name.to_string());
let response = self.client.get(url).send().await?;
Ok(GetEventPatternByNameRequest::parse_response(response).await?)
}
/// Get an event pattern by ID
///
/// Retrieve event pattern details for a workflow event trigger.
///
/// * Path: `GET /v1/event-patterns/{eventPatternId}`
pub async fn get_event_pattern(
&self,
request: GetEventPatternRequest,
) -> anyhow::Result<GetEventPatternResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("event-patterns")
.push(&request.path.event_pattern_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetEventPatternRequest::parse_response(response).await?)
}
/// List mailing lists
///
/// Retrieve a list of your account's mailing lists.
///
/// * Path: `GET /v1/lists`
pub async fn list_mailing_lists(
&self,
request: ListMailingListsRequest,
) -> anyhow::Result<ListMailingListsResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("lists");
let response = self.client.get(url).send().await?;
Ok(ListMailingListsRequest::parse_response(response).await?)
}
/// Get a theme
///
/// Retrieve a single theme by ID.
///
/// * Path: `GET /v1/themes/{themeId}`
pub async fn get_theme(&self, request: GetThemeRequest) -> anyhow::Result<GetThemeResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("themes")
.push(&request.path.theme_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetThemeRequest::parse_response(response).await?)
}
/// Update a theme
///
/// Update a theme's name and/or styles. When `styles` change, the update cascades to every email using this theme, and `affectedEmailCount` in the response reports how many emails were affected. Manual style edits made on individual emails are preserved: the cascade only changes properties an email has not overridden. A per-email override is removed only when it becomes identical to the theme's new value, after which that email follows the theme for that property.
///
/// * Path: `POST /v1/themes/{themeId}`
pub async fn update_theme(
&self,
request: UpdateThemeRequest,
) -> anyhow::Result<UpdateThemeResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("themes")
.push(&request.path.theme_id.to_string());
let response = self.client.post(url).json(&request.body).send().await?;
Ok(UpdateThemeRequest::parse_response(response).await?)
}
/// List themes
///
/// Retrieve a paginated list of email themes, most recently created first.
///
/// * Path: `GET /v1/themes`
pub async fn list_themes(
&self,
request: ListThemesRequest,
) -> anyhow::Result<ListThemesResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("themes");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListThemesRequest::parse_response(response).await?)
}
/// Create a theme
///
/// Create a new email theme for use across Loops emails.
///
/// * Path: `POST /v1/themes`
pub async fn create_theme(
&self,
request: CreateThemeRequest,
) -> anyhow::Result<CreateThemeResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("themes");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateThemeRequest::parse_response(response).await?)
}
/// List transactional emails (legacy)
///
/// Get a list of published transactional emails.
///
/// * Path: `GET /v1/transactional`
pub async fn list_published_transactional_emails(
&self,
request: ListPublishedTransactionalEmailsRequest,
) -> anyhow::Result<ListPublishedTransactionalEmailsResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListPublishedTransactionalEmailsRequest::parse_response(response).await?)
}
/// Send a transactional email
///
/// Send a transactional email to a contact.<br>Please [email us](mailto:help@loops.so) to enable attachments on your account before using them with the API.
///
/// To set dynamic Subject, From, Reply to, CC, BCC email header fields, add data variables to those fields in the editor, then include data for each variable in the API request. Read our transactional email guide for more details.
///
/// * Path: `POST /v1/transactional`
pub async fn send_transactional_email(
&self,
request: SendTransactionalEmailRequest,
) -> anyhow::Result<SendTransactionalEmailResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional");
let response = self
.client
.post(url)
.headers(
http::HeaderMap::try_from(&request.header).context("building request headers")?,
)
.json(&request.body)
.send()
.await?;
Ok(SendTransactionalEmailRequest::parse_response(response).await?)
}
/// List transactional emails
///
/// Retrieve a paginated list of transactional emails, most recently created first.
///
/// * Path: `GET /v1/transactional-emails`
pub async fn list_transactional_emails(
&self,
request: ListTransactionalEmailsRequest,
) -> anyhow::Result<ListTransactionalEmailsResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-emails");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListTransactionalEmailsRequest::parse_response(response).await?)
}
/// Create a transactional email
///
/// Create a new transactional email. An empty draft email message is created automatically and its `draftEmailMessageId` is returned. Use the `POST /v1/email-messages/{emailMessageId}` endpoint along with the returned `draftEmailMessageContentRevisionId` to set subject, sender, preview text, and LMX content, then call `POST /v1/transactional-emails/{transactionalId}/publish` to publish the draft.
///
/// * Path: `POST /v1/transactional-emails`
pub async fn create_transactional_email(
&self,
request: CreateTransactionalEmailRequest,
) -> anyhow::Result<CreateTransactionalEmailResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-emails");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateTransactionalEmailRequest::parse_response(response).await?)
}
/// Get a transactional email
///
/// Retrieve a single transactional email by ID.
///
/// * Path: `GET /v1/transactional-emails/{transactionalId}`
pub async fn get_transactional_email(
&self,
request: GetTransactionalEmailRequest,
) -> anyhow::Result<GetTransactionalEmailResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-emails")
.push(&request.path.transactional_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetTransactionalEmailRequest::parse_response(response).await?)
}
/// Update a transactional email
///
/// Update a transactional email by ID.
///
/// * Path: `POST /v1/transactional-emails/{transactionalId}`
pub async fn update_transactional_email(
&self,
request: UpdateTransactionalEmailRequest,
) -> anyhow::Result<GetTransactionalEmailResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-emails")
.push(&request.path.transactional_id.to_string());
let response = self.client.post(url).json(&request.body).send().await?;
Ok(UpdateTransactionalEmailRequest::parse_response(response).await?)
}
/// Get transactional email metrics
///
/// Retrieve all-time delivery metrics for a transactional email, totalled across every published version.
///
/// * Path: `GET /v1/transactional-emails/{transactionalId}/metrics`
pub async fn get_transactional_email_metrics(
&self,
request: GetTransactionalEmailMetricsRequest,
) -> anyhow::Result<GetTransactionalEmailMetricsResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-emails")
.push(&request.path.transactional_id.to_string())
.push("metrics");
let response = self.client.get(url).send().await?;
Ok(GetTransactionalEmailMetricsRequest::parse_response(response).await?)
}
/// Ensure a draft email message
///
/// Ensure the transactional email has a draft email message. If a draft already exists it is returned unchanged; otherwise a new empty draft is created (seeded from the most recent published version when present). Use `POST /v1/email-messages/{emailMessageId}` to edit the draft's content.
///
/// * Path: `POST /v1/transactional-emails/{transactionalId}/draft`
pub async fn ensure_transactional_draft(
&self,
request: EnsureTransactionalDraftRequest,
) -> anyhow::Result<EnsureTransactionalDraftResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-emails")
.push(&request.path.transactional_id.to_string())
.push("draft");
let response = self.client.post(url).send().await?;
Ok(EnsureTransactionalDraftRequest::parse_response(response).await?)
}
/// Publish a transactional email draft
///
/// Publish the transactional email's current draft email message. The draft becomes the published version and the draft is cleared.
///
/// * Path: `POST /v1/transactional-emails/{transactionalId}/publish`
pub async fn publish_transactional_email(
&self,
request: PublishTransactionalEmailRequest,
) -> anyhow::Result<PublishTransactionalEmailResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-emails")
.push(&request.path.transactional_id.to_string())
.push("publish");
let response = self.client.post(url).send().await?;
Ok(PublishTransactionalEmailRequest::parse_response(response).await?)
}
/// List transactional groups
///
/// Retrieve a paginated list of transactional groups, most recently created first.
///
/// * Path: `GET /v1/transactional-groups`
pub async fn list_transactional_groups(
&self,
request: ListTransactionalGroupsRequest,
) -> anyhow::Result<ListCampaignGroupsResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-groups");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListTransactionalGroupsRequest::parse_response(response).await?)
}
/// Create a transactional group
///
/// Create a new transactional group.
///
/// * Path: `POST /v1/transactional-groups`
pub async fn create_transactional_group(
&self,
request: CreateTransactionalGroupRequest,
) -> anyhow::Result<CreateCampaignGroupResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-groups");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateTransactionalGroupRequest::parse_response(response).await?)
}
/// Get a transactional group
///
/// Retrieve a single transactional group by ID.
///
/// * Path: `GET /v1/transactional-groups/{transactionalGroupId}`
pub async fn get_transactional_group(
&self,
request: GetTransactionalGroupRequest,
) -> anyhow::Result<GetCampaignGroupResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-groups")
.push(&request.path.transactional_group_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetTransactionalGroupRequest::parse_response(response).await?)
}
/// Update a transactional group
///
/// Update a transactional group's name or description. At least one field must be provided. The reserved "Unsorted" group cannot be edited.
///
/// * Path: `POST /v1/transactional-groups/{transactionalGroupId}`
pub async fn update_transactional_group(
&self,
request: UpdateTransactionalGroupRequest,
) -> anyhow::Result<GetCampaignGroupResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("transactional-groups")
.push(&request.path.transactional_group_id.to_string());
let response = self.client.post(url).json(&request.body).send().await?;
Ok(UpdateTransactionalGroupRequest::parse_response(response).await?)
}
/// Create an upload
///
/// Request a pre-signed URL to upload an image asset. Upload the file with an HTTP `PUT` to the returned `presignedUrl` (sending the same `Content-Type` and `Content-Length`), then call `/uploads/{emailAssetId}/complete` to finalize the asset.
///
/// * Path: `POST /v1/uploads`
pub async fn create_upload(
&self,
request: CreateUploadRequestParams,
) -> anyhow::Result<CreateUploadResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("uploads");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateUploadRequestParams::parse_response(response).await?)
}
/// Complete an upload
///
/// Finalize an image upload after the file has been uploaded to the pre-signed URL. Returns the public URL of the uploaded image asset.
///
/// * Path: `POST /v1/uploads/{emailAssetId}/complete`
pub async fn complete_upload(
&self,
request: CompleteUploadRequest,
) -> anyhow::Result<CompleteUploadResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("uploads")
.push(&request.path.email_asset_id.to_string())
.push("complete");
let response = self.client.post(url).send().await?;
Ok(CompleteUploadRequest::parse_response(response).await?)
}
/// List workflows
///
/// Retrieve a paginated list of workflows.
///
/// * Path: `GET /v1/workflows`
pub async fn list_workflows(
&self,
request: ListWorkflowsRequest,
) -> anyhow::Result<ListWorkflowsResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows");
let response = self.client.get(url).query(&request.query).send().await?;
Ok(ListWorkflowsRequest::parse_response(response).await?)
}
/// Create a workflow
///
/// Create a draft workflow with a blank trigger and exit node.
///
/// * Path: `POST /v1/workflows`
pub async fn create_workflow(
&self,
request: CreateWorkflowRequestParams,
) -> anyhow::Result<CreateWorkflowResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateWorkflowRequestParams::parse_response(response).await?)
}
/// Get a workflow
///
/// Retrieve a workflow graph with node type names, connections, and selected display fields.
///
/// * Path: `GET /v1/workflows/{workflowId}`
pub async fn get_workflow(
&self,
request: GetWorkflowRequest,
) -> anyhow::Result<GetWorkflowResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetWorkflowRequest::parse_response(response).await?)
}
/// Update a workflow
///
/// Update a workflow's display properties. At least one property must be provided. To change the workflow's mailing list, use the `POST /v1/workflows/{workflowId}/mailing-list` endpoint instead.
///
/// * Path: `POST /v1/workflows/{workflowId}`
pub async fn update_workflow_properties(
&self,
request: UpdateWorkflowPropertiesRequestParams,
) -> anyhow::Result<UpdateWorkflowPropertiesResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string());
let response = self.client.post(url).json(&request.body).send().await?;
Ok(UpdateWorkflowPropertiesRequestParams::parse_response(response).await?)
}
/// Delete a workflow
///
/// Delete a workflow. Successful deletion returns `204 No Content`. If the workflow is currently sending or has queued contacts, Loops returns `409 Conflict` with a message instead of deleting. Retry with `confirmDelete: true` to delete the workflow, stop sending, and cancel queued contacts.
///
/// * Path: `DELETE /v1/workflows/{workflowId}`
pub async fn delete_workflow(
&self,
request: DeleteWorkflowRequestParams,
) -> anyhow::Result<DeleteWorkflowResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string());
let response = self.client.delete(url).json(&request.body).send().await?;
Ok(DeleteWorkflowRequestParams::parse_response(response).await?)
}
/// Change workflow mailing list
///
/// Dry run or apply a workflow mailing list change. If queued contacts would be removed from the workflow due to the change of mailing list, Loops returns with `"status": "queuedContactsFound"` instead of applying the change. Retry with `queuedContactPolicy: "discard"` to apply the change and discard those contacts. Confirmed update responses include the simplified workflow after the mailing list changes.
///
/// * Path: `POST /v1/workflows/{workflowId}/mailing-list`
pub async fn change_workflow_mailing_list(
&self,
request: ChangeWorkflowMailingListRequestParams,
) -> anyhow::Result<ChangeWorkflowMailingListResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string())
.push("mailing-list");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(ChangeWorkflowMailingListRequestParams::parse_response(response).await?)
}
/// Create a workflow node
///
/// Create a new default workflow node and return it with the latest workflow.
///
/// Choose where the node goes with `insertMode`: `between` places it between an existing `fromNodeId` -> `toNodeId` connection, `before` places it before `toNodeId`, and `after` places it after `fromNodeId` when that node has exactly one outgoing connection. `after` is a convenience for simple linear paths, so callers do not need to fetch and pass the current child node ID. It is invalid when `fromNodeId` has no outgoing nodes, multiple outgoing nodes, or is an exit node. When the source has multiple outgoing nodes, use `between` with the exact `toNodeId` instead. For `before`, deprecated `beforeNodeId` requests are still accepted for compatibility, but new callers should use `toNodeId`.
///
/// New nodes start with default settings; update the node after creation to configure it. Branch nodes create their default paths too: `BranchNode` creates two `AudienceFilter` children, and `ExperimentBranchNode` creates two regular `VariantNode` children plus one control `VariantNode`. Public workflows can have up to 400 nodes. Generated children count toward that limit, so a normal create adds 1 node, `BranchNode` adds 3, and `ExperimentBranchNode` adds 4. To add a sibling child path to a branch or experiment branch, use the `POST /v1/workflows/{workflowId}/nodes/{nodeId}/add-branch` endpoint. Branch paths can be edited with create-node, but a workflow cannot be started unless each direct `BranchNode` child is an `AudienceFilter`. For experiments, use create-node only to insert a missing `VariantNode` before non-variant content; use add-branch for another variant path.
///
/// * Path: `POST /v1/workflows/{workflowId}/nodes`
pub async fn create_workflow_node(
&self,
request: CreateWorkflowNodeRequestParams,
) -> anyhow::Result<CreateWorkflowNodeResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string())
.push("nodes");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(CreateWorkflowNodeRequestParams::parse_response(response).await?)
}
/// Add a branch
///
/// Add a branch and a child node under an existing Branch or Experiment node. Returns the created child node plus the latest workflow.
///
/// - Adding a branch to a `BranchNode` creates one `AudienceFilter` child node.
/// - Adding a branch to an `ExperimentBranchNode` creates one `VariantNode` child node.
///
/// This endpoint does not accept node configuration fields; update the child node with `POST /v1/workflows/{workflowId}/nodes/{nodeId}` after creation. Public workflows are limited to 400 nodes, and this endpoint adds 1 node.
///
/// * Path: `POST /v1/workflows/{workflowId}/nodes/{nodeId}/add-branch`
pub async fn add_workflow_branch(
&self,
request: AddWorkflowBranchRequestParams,
) -> anyhow::Result<AddWorkflowBranchResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string())
.push("nodes")
.push(&request.path.node_id.to_string())
.push("add-branch");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(AddWorkflowBranchRequestParams::parse_response(response).await?)
}
/// Get a workflow node
///
/// Retrieve detailed data for a single workflow node.
///
/// * Path: `GET /v1/workflows/{workflowId}/nodes/{nodeId}`
pub async fn get_workflow_node(
&self,
request: GetWorkflowNodeRequest,
) -> anyhow::Result<GetWorkflowNodeResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string())
.push("nodes")
.push(&request.path.node_id.to_string());
let response = self.client.get(url).send().await?;
Ok(GetWorkflowNodeRequest::parse_response(response).await?)
}
/// Update a workflow node
///
/// Update workflow-node-owned fields for a single node. Shared resources such as email messages and audience segments should be updated through their own APIs.
///
/// * Path: `POST /v1/workflows/{workflowId}/nodes/{nodeId}`
pub async fn update_workflow_node(
&self,
request: UpdateWorkflowNodeRequestParams,
) -> anyhow::Result<UpdateWorkflowNodeResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string())
.push("nodes")
.push(&request.path.node_id.to_string());
let response = self.client.post(url).json(&request.body).send().await?;
Ok(UpdateWorkflowNodeRequestParams::parse_response(response).await?)
}
/// Delete a workflow node
///
/// Delete a single workflow node. If contacts are queued at the node, Loops returns with `"status": "queuedContactsFound"` instead of deleting. Retry with `queuedContactPolicy: "discard"` to delete the node and discard those queued contacts. Confirmed deletion responses include the simplified workflow after the node is removed.
///
/// * Path: `DELETE /v1/workflows/{workflowId}/nodes/{nodeId}`
pub async fn delete_workflow_node(
&self,
request: DeleteWorkflowNodeRequestParams,
) -> anyhow::Result<DeleteWorkflowNodeResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string())
.push("nodes")
.push(&request.path.node_id.to_string());
let response = self.client.delete(url).json(&request.body).send().await?;
Ok(DeleteWorkflowNodeRequestParams::parse_response(response).await?)
}
/// Get workflow node metrics
///
/// Retrieve all-time email engagement metrics for a workflow `SendEmailAction` node. Nodes of any other type return a `400` response. A `SendEmailAction` node with an email that has not sent anything yet reports every counter as `0`.
///
/// * Path: `GET /v1/workflows/{workflowId}/nodes/{nodeId}/metrics`
pub async fn get_workflow_node_metrics(
&self,
request: GetWorkflowNodeMetricsRequest,
) -> anyhow::Result<GetWorkflowNodeMetricsResponse> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string())
.push("nodes")
.push(&request.path.node_id.to_string())
.push("metrics");
let response = self.client.get(url).send().await?;
Ok(GetWorkflowNodeMetricsRequest::parse_response(response).await?)
}
/// Reroute a node connection
///
/// Reroute the source node's existing connection to another valid target node. Returns the updated source node and the latest workflow.
///
/// * Path: `POST /v1/workflows/{workflowId}/nodes/{nodeId}/reroute`
pub async fn reroute_node_connection(
&self,
request: RerouteNodeConnectionRequestParams,
) -> anyhow::Result<RerouteNodeConnectionResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string())
.push("nodes")
.push(&request.path.node_id.to_string())
.push("reroute");
let response = self.client.post(url).json(&request.body).send().await?;
Ok(RerouteNodeConnectionRequestParams::parse_response(response).await?)
}
/// Delete workflow nodes recursively
///
/// Delete a node and its downstream subtree. If contacts are queued at any node that would be deleted, Loops returns with `"status": "queuedContactsFound"` instead of deleting. Retry with `queuedContactPolicy: "discard"` to delete the nodes and discard those queued contacts. Confirmed deletion responses include the simplified workflow after the nodes are removed.
///
/// * Path: `DELETE /v1/workflows/{workflowId}/nodes/{nodeId}/recursive`
pub async fn delete_workflow_node_recursively(
&self,
request: DeleteWorkflowNodeRecursivelyRequest,
) -> anyhow::Result<DeleteWorkflowNodeResponseEnum> {
request.validate().context("parameter validation")?;
let mut url = self.base_url.clone();
url.path_segments_mut()
.map_err(|()| anyhow::anyhow!("URL cannot be a base"))?
.push("v1")
.push("workflows")
.push(&request.path.workflow_id.to_string())
.push("nodes")
.push(&request.path.node_id.to_string())
.push("recursive");
let response = self.client.delete(url).json(&request.body).send().await?;
Ok(DeleteWorkflowNodeRecursivelyRequest::parse_response(response).await?)
}
}