/*
* 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.429.1
* Contact: support@zernio.com
* Generated by: https://openapi-generator.tech
*/
use crate::models;
use serde::{Deserialize, Serialize};
/// WebhookPayloadAdRuleTriggered : Webhook payload for the `ad_rule.triggered` event. Fires when a scheduled run of a rule with a `notify` action finds campaigns, ad sets or ads that meet every condition of the rule. Each object is announced at most once per rule cooldown, so `objects` lists only the objects the run acted on, never the ones still in cooldown. A run where every matching object is still in cooldown sends nothing. An object whose action failed gets no cooldown: the next run retries it and reports it again.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct WebhookPayloadAdRuleTriggered {
/// Stable webhook event ID: the dedupe key, also sent as the X-Zernio-Event-Id header and identical on every retry and redelivery.
#[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). Use it to route the event to your tenant without storing Zernio profile ids. Present on every event tied to a profile, absent on events that belong to none. Events spanning several profiles (a post published to accounts of different profiles) list each once.
#[serde(rename = "profiles", skip_serializing_if = "Option::is_none")]
pub profiles: Option<Vec<models::WebhookProfilesInner>>,
/// 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>,
#[serde(rename = "event")]
pub event: Event,
#[serde(rename = "account")]
pub account: Box<models::WebhookAdsAccount>,
#[serde(rename = "rule")]
pub rule: Box<models::WebhookPayloadAdRuleTriggeredRule>,
#[serde(rename = "run")]
pub run: Box<models::WebhookPayloadAdRuleTriggeredRun>,
/// The campaigns, ad sets or ads this run acted on, at the rule's `level`, including those whose action failed. Objects still in cooldown are left out.
#[serde(rename = "objects")]
pub objects: Vec<models::WebhookPayloadAdRuleTriggeredObjectsInner>,
/// UTC time at which Zernio generated this event.
#[serde(rename = "timestamp")]
pub timestamp: String,
}
impl WebhookPayloadAdRuleTriggered {
/// Webhook payload for the `ad_rule.triggered` event. Fires when a scheduled run of a rule with a `notify` action finds campaigns, ad sets or ads that meet every condition of the rule. Each object is announced at most once per rule cooldown, so `objects` lists only the objects the run acted on, never the ones still in cooldown. A run where every matching object is still in cooldown sends nothing. An object whose action failed gets no cooldown: the next run retries it and reports it again.
pub fn new(
id: String,
event: Event,
account: models::WebhookAdsAccount,
rule: models::WebhookPayloadAdRuleTriggeredRule,
run: models::WebhookPayloadAdRuleTriggeredRun,
objects: Vec<models::WebhookPayloadAdRuleTriggeredObjectsInner>,
timestamp: String,
) -> WebhookPayloadAdRuleTriggered {
WebhookPayloadAdRuleTriggered {
id,
profiles: None,
test: None,
event,
account: Box::new(account),
rule: Box::new(rule),
run: Box::new(run),
objects,
timestamp,
}
}
}
///
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Event {
#[serde(rename = "ad_rule.triggered")]
AdRuleTriggered,
}
impl Default for Event {
fn default() -> Event {
Self::AdRuleTriggered
}
}