linkbreakers 1.87.5

Official Rust SDK for the Linkbreakers API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136

/*
 * Linkbreakers API
 *
 * This is a documentation of all the APIs of Linkbreakers
 *
 * The version of the OpenAPI document: 1.87.5
 * 
 * Generated by: https://openapi-generator.tech
 */

use crate::models;
use serde::{Deserialize, Serialize};

/// WorkflowStep : Models a node in the Linkbreakers workflow canvas, defining what should occur after a scan (redirects, gates, forms) and how it connects to other steps in the visitor journey.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct WorkflowStep {
    #[serde(rename = "canvasPosition", skip_serializing_if = "Option::is_none")]
    pub canvas_position: Option<Box<models::CanvasPosition>>,
    #[serde(rename = "childStepIds", skip_serializing_if = "Option::is_none")]
    pub child_step_ids: Option<Vec<String>>,
    #[serde(rename = "createdAt", skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
    /// - EVENT_ACTION_UNSPECIFIED: Event action not specified  - EVENT_ACTION_CLIENT_REDIRECT: Redirect visitors to a destination URL  - EVENT_ACTION_LINK_VISIT: Entry step triggered when the link is visited.  - EVENT_ACTION_PASSWORD_VERIFY: Require visitors to enter a password before proceeding  - EVENT_ACTION_FORM_SUBMIT: Present a data collection form to visitors  - EVENT_ACTION_CONTACT_CARD: Generate a vCard (VCF) response with contact information  - EVENT_ACTION_MULTI_LINK: Present a multi-link page with multiple buttons for different destinations  - EVENT_ACTION_VISIT_TYPE_CONDITION: Route visitors based on whether it's a first or returning visit  - EVENT_ACTION_COUNTRY_CONDITION: Route visitors based on their country location  - EVENT_ACTION_DAY_OF_WEEK_CONDITION: Route visitors based on day of week  - EVENT_ACTION_TIME_OF_DAY_CONDITION: Route visitors based on time of day  - EVENT_ACTION_DAY_OF_MONTH_CONDITION: Route visitors based on day of month  - EVENT_ACTION_SPECIFIC_DATE_CONDITION: Route visitors based on specific calendar dates  - EVENT_ACTION_SOCIAL_LINKS_PAGE: Display a social links page (like Linktree)  - EVENT_ACTION_DEVICE_TYPE_CONDITION: Route visitors based on device type (e.g. MOBILE, DESKTOP, TABLET)  - EVENT_ACTION_DEVICE_PLATFORM_CONDITION: Route visitors based on device platform / operating system (e.g. iOS, Android, macOS)  - EVENT_ACTION_DEVICE_BROWSER_CONDITION: Route visitors based on browser family (e.g. Chrome, Safari, Firefox)  - EVENT_ACTION_DEVICE_BRAND_CONDITION: Route visitors based on hardware brand (e.g. Apple, Samsung, Google)  - EVENT_ACTION_DEVICE_ACTOR_CONDITION: Route visitors based on actor classification (e.g. HUMAN, BOT, AGENT)  - EVENT_ACTION_VISITOR_DATA_CONDITION: Route visitors based on their profile data or custom attributes  - EVENT_ACTION_THANK_YOU_PAGE: Display a final thank you / completion message (exit step)  - EVENT_ACTION_MESSAGE_PAGE: Display an informational message with navigation (button or timer) to the next step
    #[serde(rename = "eventAction", skip_serializing_if = "Option::is_none")]
    pub event_action: Option<EventAction>,
    #[serde(rename = "id", skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// - KIND_UNSPECIFIED: Workflow step kind not specified  - KIND_ENTRY: Entry steps are automatically triggered when a visitor reaches the workflow  - KIND_EXIT: Exit steps finalize the workflow (commonly a redirect)  - KIND_INTERACTION: Interaction steps require visitor input (forms, passwords, etc.)  - KIND_CONDITION: Condition steps evaluate logic and route to different next steps
    #[serde(rename = "kind", skip_serializing_if = "Option::is_none")]
    pub kind: Option<Kind>,
    #[serde(rename = "linkId", skip_serializing_if = "Option::is_none")]
    pub link_id: Option<String>,
    /// This field determines connection behavior: - COMPOSITE nodes (forms, multi-links, conditions): Cannot have direct child connections.   They manage routing through their payload structure instead. - ATOMIC nodes (redirects, passwords, etc.): Can have direct child connections.  See WorkflowStepNodeType enum for detailed documentation.
    #[serde(rename = "nodeType", skip_serializing_if = "Option::is_none")]
    pub node_type: Option<models::WorkflowStepNodeType>,
    #[serde(rename = "parentStepIds", skip_serializing_if = "Option::is_none")]
    pub parent_step_ids: Option<Vec<String>>,
    #[serde(rename = "payload", skip_serializing_if = "Option::is_none")]
    pub payload: Option<Box<models::WorkflowStepPayload>>,
    #[serde(rename = "updatedAt", skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<String>,
}

impl WorkflowStep {
    /// Models a node in the Linkbreakers workflow canvas, defining what should occur after a scan (redirects, gates, forms) and how it connects to other steps in the visitor journey.
    pub fn new() -> WorkflowStep {
        WorkflowStep {
            canvas_position: None,
            child_step_ids: None,
            created_at: None,
            event_action: None,
            id: None,
            kind: None,
            link_id: None,
            node_type: None,
            parent_step_ids: None,
            payload: None,
            updated_at: None,
        }
    }
}
/// - EVENT_ACTION_UNSPECIFIED: Event action not specified  - EVENT_ACTION_CLIENT_REDIRECT: Redirect visitors to a destination URL  - EVENT_ACTION_LINK_VISIT: Entry step triggered when the link is visited.  - EVENT_ACTION_PASSWORD_VERIFY: Require visitors to enter a password before proceeding  - EVENT_ACTION_FORM_SUBMIT: Present a data collection form to visitors  - EVENT_ACTION_CONTACT_CARD: Generate a vCard (VCF) response with contact information  - EVENT_ACTION_MULTI_LINK: Present a multi-link page with multiple buttons for different destinations  - EVENT_ACTION_VISIT_TYPE_CONDITION: Route visitors based on whether it's a first or returning visit  - EVENT_ACTION_COUNTRY_CONDITION: Route visitors based on their country location  - EVENT_ACTION_DAY_OF_WEEK_CONDITION: Route visitors based on day of week  - EVENT_ACTION_TIME_OF_DAY_CONDITION: Route visitors based on time of day  - EVENT_ACTION_DAY_OF_MONTH_CONDITION: Route visitors based on day of month  - EVENT_ACTION_SPECIFIC_DATE_CONDITION: Route visitors based on specific calendar dates  - EVENT_ACTION_SOCIAL_LINKS_PAGE: Display a social links page (like Linktree)  - EVENT_ACTION_DEVICE_TYPE_CONDITION: Route visitors based on device type (e.g. MOBILE, DESKTOP, TABLET)  - EVENT_ACTION_DEVICE_PLATFORM_CONDITION: Route visitors based on device platform / operating system (e.g. iOS, Android, macOS)  - EVENT_ACTION_DEVICE_BROWSER_CONDITION: Route visitors based on browser family (e.g. Chrome, Safari, Firefox)  - EVENT_ACTION_DEVICE_BRAND_CONDITION: Route visitors based on hardware brand (e.g. Apple, Samsung, Google)  - EVENT_ACTION_DEVICE_ACTOR_CONDITION: Route visitors based on actor classification (e.g. HUMAN, BOT, AGENT)  - EVENT_ACTION_VISITOR_DATA_CONDITION: Route visitors based on their profile data or custom attributes  - EVENT_ACTION_THANK_YOU_PAGE: Display a final thank you / completion message (exit step)  - EVENT_ACTION_MESSAGE_PAGE: Display an informational message with navigation (button or timer) to the next step
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum EventAction {
    #[serde(rename = "EVENT_ACTION_UNSPECIFIED")]
    EventActionUnspecified,
    #[serde(rename = "EVENT_ACTION_CLIENT_REDIRECT")]
    EventActionClientRedirect,
    #[serde(rename = "EVENT_ACTION_LINK_VISIT")]
    EventActionLinkVisit,
    #[serde(rename = "EVENT_ACTION_PASSWORD_VERIFY")]
    EventActionPasswordVerify,
    #[serde(rename = "EVENT_ACTION_FORM_SUBMIT")]
    EventActionFormSubmit,
    #[serde(rename = "EVENT_ACTION_CONTACT_CARD")]
    EventActionContactCard,
    #[serde(rename = "EVENT_ACTION_MULTI_LINK")]
    EventActionMultiLink,
    #[serde(rename = "EVENT_ACTION_VISIT_TYPE_CONDITION")]
    EventActionVisitTypeCondition,
    #[serde(rename = "EVENT_ACTION_COUNTRY_CONDITION")]
    EventActionCountryCondition,
    #[serde(rename = "EVENT_ACTION_DAY_OF_WEEK_CONDITION")]
    EventActionDayOfWeekCondition,
    #[serde(rename = "EVENT_ACTION_TIME_OF_DAY_CONDITION")]
    EventActionTimeOfDayCondition,
    #[serde(rename = "EVENT_ACTION_DAY_OF_MONTH_CONDITION")]
    EventActionDayOfMonthCondition,
    #[serde(rename = "EVENT_ACTION_SPECIFIC_DATE_CONDITION")]
    EventActionSpecificDateCondition,
    #[serde(rename = "EVENT_ACTION_SOCIAL_LINKS_PAGE")]
    EventActionSocialLinksPage,
    #[serde(rename = "EVENT_ACTION_DEVICE_TYPE_CONDITION")]
    EventActionDeviceTypeCondition,
    #[serde(rename = "EVENT_ACTION_DEVICE_PLATFORM_CONDITION")]
    EventActionDevicePlatformCondition,
    #[serde(rename = "EVENT_ACTION_DEVICE_BROWSER_CONDITION")]
    EventActionDeviceBrowserCondition,
    #[serde(rename = "EVENT_ACTION_DEVICE_BRAND_CONDITION")]
    EventActionDeviceBrandCondition,
    #[serde(rename = "EVENT_ACTION_DEVICE_ACTOR_CONDITION")]
    EventActionDeviceActorCondition,
    #[serde(rename = "EVENT_ACTION_VISITOR_DATA_CONDITION")]
    EventActionVisitorDataCondition,
    #[serde(rename = "EVENT_ACTION_THANK_YOU_PAGE")]
    EventActionThankYouPage,
    #[serde(rename = "EVENT_ACTION_MESSAGE_PAGE")]
    EventActionMessagePage,
}

impl Default for EventAction {
    fn default() -> EventAction {
        Self::EventActionUnspecified
    }
}
/// - KIND_UNSPECIFIED: Workflow step kind not specified  - KIND_ENTRY: Entry steps are automatically triggered when a visitor reaches the workflow  - KIND_EXIT: Exit steps finalize the workflow (commonly a redirect)  - KIND_INTERACTION: Interaction steps require visitor input (forms, passwords, etc.)  - KIND_CONDITION: Condition steps evaluate logic and route to different next steps
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum Kind {
    #[serde(rename = "KIND_UNSPECIFIED")]
    KindUnspecified,
    #[serde(rename = "KIND_ENTRY")]
    KindEntry,
    #[serde(rename = "KIND_EXIT")]
    KindExit,
    #[serde(rename = "KIND_INTERACTION")]
    KindInteraction,
    #[serde(rename = "KIND_CONDITION")]
    KindCondition,
}

impl Default for Kind {
    fn default() -> Kind {
        Self::KindUnspecified
    }
}