ghl-models 0.3.0

// @generated by xtask/generate_models.py — do not edit by hand.
// Source: https://github.com/GoHighLevel/highlevel-api-docs
// Doc comments are HighLevel's own field descriptions, reflowed verbatim, so
// they aren't held to rustdoc's markdown conventions.
#![allow(
    missing_docs,
    clippy::doc_lazy_continuation,
    clippy::doc_overindented_list_items
)]

use serde::{Deserialize, Serialize};

/// `AddFaqDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AddFaqDTO {
    /// location ID as string
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// faq question as a string
    /// Required by the API.
    pub question: String,
    /// faq answer as a string
    /// Required by the API.
    pub answer: String,
    /// knowledge base ID as string
    /// Required by the API.
    #[serde(rename = "knowledgeBaseId")]
    pub knowledge_base_id: String,
}

/// `BadRequestDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct BadRequestDTO {
    #[serde(
        rename = "statusCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub status_code: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

/// `CrawledUrlDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CrawledUrlDTO {
    /// Unique identifier for the URL
    /// Required by the API.
    pub id: String,
    /// The actual URL that was crawled
    /// Required by the API.
    pub url: String,
    /// Title of the webpage
    /// Required by the API.
    pub title: String,
    /// Current processing status of the URL
    /// Allowed values: `Pending`, `Processing`, `Successful`, `Failed`, `Existing`,
    /// `Restricted`, `Cancelled`, `Aborted`, `Training`.
    /// Required by the API.
    pub status: String,
    /// Location ID associated with this URL
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Knowledge base ID this URL belongs to
    /// Required by the API.
    #[serde(rename = "knowledgeBaseId")]
    pub knowledge_base_id: String,
    /// URL to the stored content file
    /// Required by the API.
    pub content: String,
    /// Whether the content was edited by user
    /// Required by the API.
    #[serde(rename = "contentEditedByUser")]
    pub content_edited_by_user: bool,
    /// Last updated timestamp
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

/// `CrawlingAggregateDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CrawlingAggregateDTO {
    /// Status grouping identifier
    /// Allowed values: `Pending`, `Processing`, `Successful`, `Failed`, `Existing`,
    /// `Restricted`, `Cancelled`, `Aborted`, `Training`.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Array of records for this status
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub records: Vec<CrawlingRecordDTO>,
}

/// `CrawlingRecordDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CrawlingRecordDTO {
    /// URL being crawled
    /// Required by the API.
    pub url: String,
    /// Unique record identifier
    /// Required by the API.
    pub id: String,
    /// Page title (for successful/pending records)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Error details (for failed records)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<ErrorDetailsDTO>,
}

/// `CrawlingStatusDataDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CrawlingStatusDataDTO {
    /// Aggregated crawling results by status
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub aggregate: Vec<CrawlingAggregateDTO>,
    /// Detailed operation information
    /// Required by the API.
    #[serde(rename = "operationDetails")]
    pub operation_details: OperationDetailsDTO,
}

/// `CrawlingStatusResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CrawlingStatusResponseDTO {
    /// Indicates if the operation was successful
    /// Required by the API.
    pub success: bool,
    /// Detailed crawling status data
    /// Required by the API.
    pub data: CrawlingStatusDataDTO,
}

/// `CreateFaqResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateFaqResponseDTO {
    /// Success status of the operation
    /// Required by the API.
    pub success: bool,
    /// Created FAQ details
    /// Required by the API.
    pub faq: FaqResponseDTO,
}

/// `CreateKnowledgeBaseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateKnowledgeBaseDTO {
    /// Required by the API.
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
}

/// `CreateKnowledgeBaseResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateKnowledgeBaseResponseDTO {
    /// Success status of the operation
    /// Required by the API.
    pub success: bool,
    /// Created knowledge base details
    /// Required by the API.
    pub data: KnowledgeBaseDataDTO,
}

/// `DeleteFaqResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteFaqResponseDTO {
    /// Success status of the delete operation
    /// Required by the API.
    pub success: bool,
}

/// `DeleteKnowledgeBaseResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteKnowledgeBaseResponseDTO {
    /// Required by the API.
    pub success: bool,
}

/// `DeleteWebsiteUrlRequestDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteWebsiteUrlRequestDTO {
    /// knowledge base ID as string
    /// Required by the API.
    #[serde(rename = "knowledgeBaseId")]
    pub knowledge_base_id: String,
    /// location ID as string
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// List of trained urls ids ( fetched from the Get all trained page links by knowledge base
    /// endpoint)
    /// Required by the API.
    #[serde(rename = "urlIds", default, skip_serializing_if = "Vec::is_empty")]
    pub url_ids: Vec<String>,
}

/// `DeleteWebsiteUrlResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteWebsiteUrlResponseDTO {
    /// Indicates if the operation was successful
    /// Required by the API.
    pub success: bool,
}

/// `DiscoverWebsiteDataDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DiscoverWebsiteDataDTO {
    /// Operation ID for tracking the discovery process
    /// Required by the API.
    #[serde(rename = "operationId")]
    pub operation_id: String,
    /// Current status of the website discovery operation
    /// Allowed values: `Pending`, `Processing`, `Successful`, `Failed`, `Existing`,
    /// `Restricted`, `Cancelled`, `Aborted`, `Training`.
    /// Required by the API.
    pub status: String,
    /// The URL being discovered/crawled
    /// Required by the API.
    pub url: String,
}

/// `DiscoverWebsiteRequestDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DiscoverWebsiteRequestDTO {
    /// Location ID as string
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Website URL as string
    /// Required by the API.
    pub url: String,
    /// Mode as string
    /// Allowed values: `Exact`, `Path`, `Domain`.
    /// Required by the API.
    pub option: String,
    /// knowledge base ID as string
    /// Required by the API.
    #[serde(rename = "knowledgeBaseId")]
    pub knowledge_base_id: String,
}

/// `DiscoverWebsiteResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DiscoverWebsiteResponseDTO {
    /// Indicates if the operation was successful
    /// Required by the API.
    pub success: bool,
    /// Data containing operation details
    /// Required by the API.
    pub data: DiscoverWebsiteDataDTO,
}

/// `ErrorDetailsDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ErrorDetailsDTO {
    /// Error stack trace
    /// Required by the API.
    pub stack: String,
    /// Error response message
    /// Required by the API.
    pub response: String,
    /// HTTP status code
    /// Required by the API.
    pub status: f64,
    /// Additional options (nullable)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub options: Option<serde_json::Value>,
    /// Error message
    /// Required by the API.
    pub message: String,
    /// Error name/type
    /// Required by the API.
    pub name: String,
}

/// `FaqResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FaqResponseDTO {
    /// FAQ ID as string
    /// Required by the API.
    pub id: String,
    /// FAQ question
    /// Required by the API.
    pub question: String,
    /// FAQ question in lowercase
    /// Required by the API.
    #[serde(rename = "questionLowerCase")]
    pub question_lower_case: String,
    /// FAQ answer
    /// Required by the API.
    pub answer: String,
    /// Knowledge base ID
    /// Required by the API.
    #[serde(rename = "knowledgeBaseId")]
    pub knowledge_base_id: String,
    /// Location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Trained URL ID
    /// Required by the API.
    #[serde(rename = "trainedUrlId")]
    pub trained_url_id: String,
    /// Whether the FAQ is deleted
    /// Required by the API.
    pub deleted: bool,
    /// Date when FAQ was created
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// Date when FAQ was last updated
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

/// `GetAllKnowledgeBasesPaginatedDataDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetAllKnowledgeBasesPaginatedDataDTO {
    /// Array of knowledge bases
    /// Required by the API.
    #[serde(
        rename = "knowledgeBases",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub knowledge_bases: Vec<KnowledgeBaseListItemDTO>,
    /// Total count of all active knowledge bases
    /// Required by the API.
    #[serde(rename = "activeCount")]
    pub active_count: f64,
    /// Whether there are more knowledge bases available
    /// Required by the API.
    #[serde(rename = "hasMore")]
    pub has_more: bool,
    /// ID of the last knowledge base in this page (use for next page request)
    #[serde(
        rename = "lastKnowledgeBaseId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub last_knowledge_base_id: Option<String>,
}

/// `GetAllKnowledgeBasesPaginatedResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetAllKnowledgeBasesPaginatedResponseDTO {
    /// Success status of the operation
    /// Required by the API.
    pub success: bool,
    /// Paginated knowledge bases data
    /// Required by the API.
    pub data: GetAllKnowledgeBasesPaginatedDataDTO,
}

/// `GetAllUrlsByKnowledgeBaseResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetAllUrlsByKnowledgeBaseResponseDTO {
    /// Total count of URLs in the knowledge base
    /// Required by the API.
    pub count: f64,
    /// Array of crawled URLs with their details
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub urls: Vec<CrawledUrlDTO>,
}

/// `GetKnowledgeBaseByIdDataDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetKnowledgeBaseByIdDataDTO {
    /// Knowledge base ID
    /// Required by the API.
    pub id: String,
    /// Knowledge base name
    /// Required by the API.
    pub name: String,
    /// Knowledge base name in lowercase
    /// Required by the API.
    #[serde(rename = "nameLowerCase")]
    pub name_lower_case: String,
    /// Location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Whether the knowledge base is deleted
    /// Required by the API.
    pub deleted: bool,
    /// Date when knowledge base was created
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// Date when knowledge base was last updated
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Knowledge base metadata with content counts
    /// Required by the API.
    #[serde(rename = "kbMetadata")]
    pub kb_metadata: KnowledgeBaseMetadataDTO,
    /// Whether the knowledge base is default or not
    #[serde(rename = "isDefault", default, skip_serializing_if = "Option::is_none")]
    pub is_default: Option<bool>,
}

/// `GetKnowledgeBaseByIdResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetKnowledgeBaseByIdResponseDTO {
    /// Success status of the operation
    /// Required by the API.
    pub success: bool,
    /// Knowledge base details
    /// Required by the API.
    pub data: GetKnowledgeBaseByIdDataDTO,
}

/// `InternalServerErrorDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct InternalServerErrorDTO {
    #[serde(
        rename = "statusCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub status_code: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

/// `KnowledgeBaseDataDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct KnowledgeBaseDataDTO {
    /// Knowledge base ID
    /// Required by the API.
    pub id: String,
    /// Knowledge base name
    /// Required by the API.
    pub name: String,
    /// Knowledge base name in lowercase
    /// Required by the API.
    #[serde(rename = "nameLowerCase")]
    pub name_lower_case: String,
    /// Location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Knowledge base metadata
    /// Required by the API.
    #[serde(rename = "kbMetadata")]
    pub kb_metadata: serde_json::Value,
    /// Whether the knowledge base is deleted
    /// Required by the API.
    pub deleted: bool,
    /// Date when knowledge base was created
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// Date when knowledge base was last updated
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

/// `KnowledgeBaseListItemDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct KnowledgeBaseListItemDTO {
    /// Knowledge base ID
    /// Required by the API.
    pub id: String,
    /// Knowledge base name
    /// Required by the API.
    pub name: String,
    /// Date when knowledge base was created
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
}

/// `KnowledgeBaseMetadataDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct KnowledgeBaseMetadataDTO {
    /// Number of FAQs in the knowledge base
    /// Required by the API.
    pub faqs: f64,
    /// Number of URLs in the knowledge base
    /// Required by the API.
    pub urls: f64,
    /// Number of rich text documents in the knowledge base
    /// Required by the API.
    #[serde(rename = "richText")]
    pub rich_text: f64,
    /// Number of files in the knowledge base
    /// Required by the API.
    pub files: f64,
    /// Number of web searche configs in the knowledge base
    /// Required by the API.
    #[serde(rename = "webSearches")]
    pub web_searches: f64,
    /// Number of tables in the knowledge base
    /// Required by the API.
    pub tables: f64,
}

/// `ListFaqsResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListFaqsResponseDTO {
    /// Total count of all FAQs in the knowledge base
    /// Required by the API.
    pub count: f64,
    /// Array of FAQ objects
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub faqs: Vec<FaqResponseDTO>,
    /// Last FAQ ID for pagination (use as lastFaqId in next request)
    #[serde(rename = "lastFaqId", default, skip_serializing_if = "Option::is_none")]
    pub last_faq_id: Option<String>,
    /// Whether there are more FAQs available
    #[serde(rename = "hasMore", default, skip_serializing_if = "Option::is_none")]
    pub has_more: Option<bool>,
}

/// `OperationDetailsDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct OperationDetailsDTO {
    /// Number of URLs discovered
    /// Required by the API.
    #[serde(rename = "discoveredUrlsCount")]
    pub discovered_urls_count: f64,
    /// Number of URLs successfully trained
    /// Required by the API.
    #[serde(rename = "trainedUrlsCount")]
    pub trained_urls_count: f64,
    /// Operation unique identifier
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Associated location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Current operation status
    /// Allowed values: `Pending`, `Processing`, `Successful`, `Failed`, `Existing`,
    /// `Restricted`, `Cancelled`, `Aborted`, `Training`.
    /// Required by the API.
    pub status: String,
    /// Base URL being crawled
    /// Required by the API.
    pub url: String,
    /// Crawling mode used
    /// Allowed values: `Exact`, `Path`, `Domain`.
    /// Required by the API.
    pub mode: String,
    /// Knowledge base ID
    /// Required by the API.
    #[serde(rename = "knowledgeBaseId")]
    pub knowledge_base_id: String,
    /// Operation creation timestamp
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// Last update timestamp
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Version field
    /// Required by the API.
    #[serde(rename = "__v")]
    pub v: f64,
    /// Robots.txt file content
    #[serde(
        rename = "robotsFileData",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub robots_file_data: Option<String>,
}

/// `TrainDiscoveredUrlsDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TrainDiscoveredUrlsDTO {
    /// Location ID as string
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// List of Object ids of the discovered urls
    /// Required by the API.
    #[serde(rename = "urlIds", default, skip_serializing_if = "Vec::is_empty")]
    pub url_ids: Vec<String>,
    /// knowledge base id
    /// Required by the API.
    #[serde(rename = "knowledgeBaseId")]
    pub knowledge_base_id: String,
    /// operation id as string
    /// Required by the API.
    #[serde(rename = "operationId")]
    pub operation_id: String,
}

/// `TrainDiscoveredUrlsResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TrainDiscoveredUrlsResponseDTO {
    /// Indicates if the operation was successful
    /// Required by the API.
    pub success: bool,
}

/// `UnauthorizedDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UnauthorizedDTO {
    #[serde(
        rename = "statusCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub status_code: Option<f64>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

/// `UnprocessableDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UnprocessableDTO {
    #[serde(
        rename = "statusCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub status_code: Option<f64>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub message: Vec<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

/// `UpdateFaqBodyDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateFaqBodyDTO {
    /// faq question as a string
    /// Required by the API.
    pub question: String,
    /// faq answer as a string
    /// Required by the API.
    pub answer: String,
}

/// `UpdateFaqResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateFaqResponseDTO {
    /// Success status of the update operation
    /// Required by the API.
    pub success: bool,
}

/// `UpdateKnowledgeBaseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateKnowledgeBaseDTO {
    /// field to update the name of the knowledge base
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// field to update the description of the knowledge base
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
}

/// `UpdateKnowledgeBaseResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateKnowledgeBaseResponseDTO {
    /// Required by the API.
    pub success: bool,
}