/*
* Zernio API
*
* API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal. Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema). Request ids: responses carry an X-Request-Id header with the id we log the request under. Quote it when reporting a problem. A valid x-request-id you send is reused as that id.
*
* The version of the OpenAPI document: 1.350.0
* Contact: support@zernio.com
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct WebhookPayloadSequenceEnrollment {
/// Always true when present: only a sample sent by POST /v1/webhooks/test with an event carries it. Real deliveries never do.
#[serde(rename = "test", skip_serializing_if = "Option::is_none")]
pub test: Option<bool>,
/// Event id, the dedupe key.
#[serde(rename = "id")]
pub id: String,
/// The profiles this event belongs to, each with the externalId you set on it (null when none is set). Present on every event tied to a profile and absent on events that belong to none. Events spanning several profiles (a post published to accounts of different profiles) list each once. Use it to route the event to your tenant without storing Zernio profile ids.
#[serde(rename = "profiles", skip_serializing_if = "Option::is_none")]
pub profiles: Option<Vec<models::WebhookProfilesInner>>,
#[serde(rename = "event")]
pub event: Event,
#[serde(rename = "timestamp")]
pub timestamp: String,
#[serde(rename = "sequence")]
pub sequence: Box<models::UpdateFacebookPage200ResponseSelectedPage>,
#[serde(rename = "contact")]
pub contact: Box<models::WebhookPayloadContactTagContact>,
#[serde(rename = "enrollment")]
pub enrollment: Box<models::CreateTestLead200ResponseTestLead>,
/// sequence.exited only. completed: the last step was sent; replied: the contact replied and the sequence exits on reply; manual: unenrolled through the API; failed: the step kept failing to send; unsubscribed: the contact opted out.
#[serde(rename = "exitReason", skip_serializing_if = "Option::is_none")]
pub exit_reason: Option<ExitReason>,
}
impl WebhookPayloadSequenceEnrollment {
pub fn new(
id: String,
event: Event,
timestamp: String,
sequence: models::UpdateFacebookPage200ResponseSelectedPage,
contact: models::WebhookPayloadContactTagContact,
enrollment: models::CreateTestLead200ResponseTestLead,
) -> WebhookPayloadSequenceEnrollment {
WebhookPayloadSequenceEnrollment {
test: None,
id,
profiles: None,
event,
timestamp,
sequence: Box::new(sequence),
contact: Box::new(contact),
enrollment: Box::new(enrollment),
exit_reason: None,
}
}
}
///
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Event {
#[serde(rename = "sequence.enrolled")]
SequenceEnrolled,
#[serde(rename = "sequence.exited")]
SequenceExited,
}
impl Default for Event {
fn default() -> Event {
Self::SequenceEnrolled
}
}
/// sequence.exited only. completed: the last step was sent; replied: the contact replied and the sequence exits on reply; manual: unenrolled through the API; failed: the step kept failing to send; unsubscribed: the contact opted out.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum ExitReason {
#[serde(rename = "completed")]
Completed,
#[serde(rename = "replied")]
Replied,
#[serde(rename = "manual")]
Manual,
#[serde(rename = "failed")]
Failed,
#[serde(rename = "unsubscribed")]
Unsubscribed,
}
impl Default for ExitReason {
fn default() -> ExitReason {
Self::Completed
}
}