linkbreakers 1.147.0

Official Rust SDK for the Linkbreakers API
Documentation
/*
 * Linkbreakers API
 *
 * This is a documentation of all the APIs of Linkbreakers
 *
 * The version of the OpenAPI document: 1.147.0
 * 
 * Generated by: https://openapi-generator.tech
 */

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

/// ListVisitorsRequest : ListVisitorsRequest controls pagination, search, and export format for visitor roster views.
#[derive(Clone, Default, Debug, PartialEq, Serialize, Deserialize)]
pub struct ListVisitorsRequest {
    /// Only return visitors matching every filter, for example budget >= 800000 and timeline = \"under_6_months\". At most 20. Over REST, use POST /v1/visitors/search: a query string cannot carry them.
    #[serde(rename = "attributeFilters", skip_serializing_if = "Option::is_none")]
    pub attribute_filters: Option<Vec<models::VisitorAttributeFilter>>,
    #[serde(rename = "email", skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    #[serde(rename = "include", skip_serializing_if = "Option::is_none")]
    pub include: Option<Vec<String>>,
    #[serde(rename = "linkId", skip_serializing_if = "Option::is_none")]
    pub link_id: Option<String>,
    #[serde(rename = "pageSize", skip_serializing_if = "Option::is_none")]
    pub page_size: Option<i64>,
    #[serde(rename = "pageToken", skip_serializing_if = "Option::is_none")]
    pub page_token: Option<String>,
    /// ResponseFormat defines the transport format the API should return for list-style endpoints.   - RESPONSE_FORMAT_UNSPECIFIED: Response format not specified  - RESPONSE_FORMAT_JSON: Response format JSON  - RESPONSE_FORMAT_CSV: Response format CSV
    #[serde(rename = "responseFormat", skip_serializing_if = "Option::is_none")]
    pub response_format: Option<ResponseFormat>,
    #[serde(rename = "search", skip_serializing_if = "Option::is_none")]
    pub search: Option<String>,
    /// SortDirection is the ordering applied to any sortable list endpoint. Shared across resources so a caller learns it once.   - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending)  - SORT_DIRECTION_ASC: Sort in ascending order  - SORT_DIRECTION_DESC: Sort in descending order
    #[serde(rename = "sortDirection", skip_serializing_if = "Option::is_none")]
    pub sort_direction: Option<SortDirection>,
    /// Field to sort by. Defaults to created_at (newest first).
    #[serde(rename = "sortField", skip_serializing_if = "Option::is_none")]
    pub sort_field: Option<models::VisitorSortField>,
}

impl ListVisitorsRequest {
    /// ListVisitorsRequest controls pagination, search, and export format for visitor roster views.
    pub fn new() -> ListVisitorsRequest {
        ListVisitorsRequest {
            attribute_filters: None,
            email: None,
            include: None,
            link_id: None,
            page_size: None,
            page_token: None,
            response_format: None,
            search: None,
            sort_direction: None,
            sort_field: None,
        }
    }
}
/// ResponseFormat defines the transport format the API should return for list-style endpoints.   - RESPONSE_FORMAT_UNSPECIFIED: Response format not specified  - RESPONSE_FORMAT_JSON: Response format JSON  - RESPONSE_FORMAT_CSV: Response format CSV
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum ResponseFormat {
    #[serde(rename = "RESPONSE_FORMAT_UNSPECIFIED")]
    ResponseFormatUnspecified,
    #[serde(rename = "RESPONSE_FORMAT_JSON")]
    ResponseFormatJson,
    #[serde(rename = "RESPONSE_FORMAT_CSV")]
    ResponseFormatCsv,
}

impl Default for ResponseFormat {
    fn default() -> ResponseFormat {
        Self::ResponseFormatUnspecified
    }
}
/// SortDirection is the ordering applied to any sortable list endpoint. Shared across resources so a caller learns it once.   - SORT_DIRECTION_UNSPECIFIED: Sort direction not specified (defaults to descending)  - SORT_DIRECTION_ASC: Sort in ascending order  - SORT_DIRECTION_DESC: Sort in descending order
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
pub enum SortDirection {
    #[serde(rename = "SORT_DIRECTION_UNSPECIFIED")]
    SortDirectionUnspecified,
    #[serde(rename = "SORT_DIRECTION_ASC")]
    SortDirectionAsc,
    #[serde(rename = "SORT_DIRECTION_DESC")]
    SortDirectionDesc,
}

impl Default for SortDirection {
    fn default() -> SortDirection {
        Self::SortDirectionUnspecified
    }
}