ghl-models 0.3.1

//! `proposals` data models for GoHighLevel API V2 (21 types).
//!
//! Generated from HighLevel's official OpenAPI spec for the
//! **Proposals** module. Every endpoint that uses these types, with its
//! parameters, required scopes and enum values, is documented in the
//! [`proposals` API reference](https://github.com/Shahroz/ghl-rs/blob/main/docs/api/proposals.md).
//!
//! Enable with `features = ["proposals"]`.
// @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};

/// `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>,
}

/// `CCRecipientItem` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CCRecipientItem {
    /// Email
    /// Required by the API.
    pub email: String,
    /// Contact ID
    /// Required by the API.
    pub id: String,
    /// Contact Image URL
    /// Required by the API.
    #[serde(rename = "imageUrl")]
    pub image_url: String,
    /// Contact Name
    /// Required by the API.
    #[serde(rename = "contactName")]
    pub contact_name: String,
    /// First Name
    /// Required by the API.
    #[serde(rename = "firstName")]
    pub first_name: String,
    /// Last Name
    /// Required by the API.
    #[serde(rename = "lastName")]
    pub last_name: String,
}

/// `DiscountDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DiscountDto {
    /// Unique identifier for the discount
    /// Required by the API.
    pub id: String,
    /// Discount value (either a percentage or custom amount)
    /// Required by the API.
    pub value: f64,
    /// Type of discount
    /// Allowed values: `percentage`, `custom_amount`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
}

/// `DocumentDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DocumentDto {
    /// Location Id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Document Id
    /// Required by the API.
    #[serde(rename = "documentId")]
    pub document_id: String,
    /// Unique identifier
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Name of the document
    /// Required by the API.
    pub name: String,
    /// Type of the document
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Whether the document is deleted
    /// Required by the API.
    pub deleted: bool,
    /// Whether the document is expired
    /// Required by the API.
    #[serde(rename = "isExpired")]
    pub is_expired: bool,
    /// Number of times document is moved to draft state
    /// Required by the API.
    #[serde(rename = "documentRevision")]
    pub document_revision: f64,
    /// Fillable fields
    /// Required by the API.
    #[serde(
        rename = "fillableFields",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub fillable_fields: Vec<FillableFieldsDTO>,
    /// Grand total object of the document
    /// Required by the API.
    #[serde(rename = "grandTotal")]
    pub grand_total: GrandTotalDto,
    /// Locale of the location
    /// Required by the API.
    pub locale: String,
    /// Document status
    /// Allowed values: `draft`, `sent`, `viewed`, `completed`, `accepted`.
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub status: Vec<String>,
    /// Payment status
    /// Allowed values: `waiting_for_payment`, `paid`, `no_payment`.
    /// Required by the API.
    #[serde(
        rename = "paymentStatus",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub payment_status: Vec<String>,
    /// Recipients
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub recipients: Vec<RecipientItem>,
    /// Links for the document if its sent
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub links: Vec<ProposalEstimateLinksDto>,
    /// Date start from (ISO 8601)
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Date to (ISO 8601)
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
}

/// `DocumentListResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DocumentListResponseDto {
    /// List of documents
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub documents: Vec<DocumentDto>,
    /// Total records available
    /// Required by the API.
    pub total: f64,
    /// WhiteLabel url for document
    #[serde(
        rename = "whiteLabelBaseUrl",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub white_label_base_url: Option<f64>,
    /// WhiteLabel url for invoice
    #[serde(
        rename = "whiteLabelBaseUrlForInvoice",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub white_label_base_url_for_invoice: Option<f64>,
}

/// Element type
/// Allowed values: `Page`, `Text`, `Image`, `Video`, `Table`, `ProductList`, `PageBreak`,
/// `Signature`, `PaymentDetails`, `TextField`, `DateField`, `InitialsField`, `Checkbox`,
/// `Row`, `Column`.
/// Kept as `String` so new upstream values don't break deserialization.
pub type ELEMENTSLOOKUP = String;

/// Entity type
/// Allowed values: `contacts`, `users`.
/// Kept as `String` so new upstream values don't break deserialization.
pub type EntityReference = String;

/// `FillableFieldsDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FillableFieldsDTO {
    /// Field Id
    /// Required by the API.
    #[serde(rename = "fieldId")]
    pub field_id: String,
    /// Is the field required
    /// Required by the API.
    #[serde(rename = "isRequired")]
    pub is_required: bool,
    /// Has the field been completed
    /// Required by the API.
    #[serde(rename = "hasCompleted")]
    pub has_completed: bool,
    /// Recipient
    /// Required by the API.
    pub recipient: String,
    /// Required by the API.
    #[serde(rename = "entityType")]
    pub entity_type: EntityReference,
    /// Id
    /// Required by the API.
    pub id: String,
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: ELEMENTSLOOKUP,
    /// Value of the field
    /// Required by the API.
    pub value: String,
}

/// `GrandTotalDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GrandTotalDto {
    /// Total amount before discounts
    /// Required by the API.
    pub amount: f64,
    /// Currency of the total amount
    /// Required by the API.
    pub currency: String,
    /// Total discount percentage applied
    /// Required by the API.
    #[serde(rename = "discountPercentage")]
    pub discount_percentage: f64,
    /// List of applied discounts
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub discounts: Vec<DiscountDto>,
}

/// `NotificationSendSettingDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct NotificationSendSettingDto {
    /// Required by the API.
    #[serde(rename = "templateId")]
    pub template_id: String,
    /// Required by the API.
    pub subject: String,
}

/// `NotificationSenderSettingDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct NotificationSenderSettingDto {
    /// Required by the API.
    #[serde(rename = "fromEmail")]
    pub from_email: String,
    /// Required by the API.
    #[serde(rename = "fromName")]
    pub from_name: String,
}

/// `NotificationSettingsDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct NotificationSettingsDto {
    /// Required by the API.
    pub receive: NotificationSendSettingDto,
    /// Required by the API.
    pub sender: NotificationSenderSettingDto,
}

/// `ProposalEstimateLinksDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProposalEstimateLinksDto {
    /// Reference ID
    /// Required by the API.
    #[serde(rename = "referenceId")]
    pub reference_id: String,
    /// Document ID
    /// Required by the API.
    #[serde(rename = "documentId")]
    pub document_id: String,
    /// Recipient ID
    /// Required by the API.
    #[serde(rename = "recipientId")]
    pub recipient_id: String,
    /// Entity name that the recipient belongs to
    /// Allowed values: `contacts`, `users`.
    /// Required by the API.
    #[serde(rename = "entityName")]
    pub entity_name: String,
    /// Recipient category (recipient, cc, or bcc)
    /// Allowed values: `recipient`, `cc`, `bcc`.
    /// Required by the API.
    #[serde(rename = "recipientCategory")]
    pub recipient_category: String,
    /// Document revision number
    /// Required by the API.
    #[serde(rename = "documentRevision")]
    pub document_revision: f64,
    /// Created by user ID
    /// Required by the API.
    #[serde(rename = "createdBy")]
    pub created_by: String,
    /// Whether the document is deleted
    /// Required by the API.
    pub deleted: bool,
}

/// `RecipientItem` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RecipientItem {
    /// Recipient Id
    /// Required by the API.
    pub id: String,
    /// Recipient First Name
    #[serde(rename = "firstName", default, skip_serializing_if = "Option::is_none")]
    pub first_name: Option<String>,
    /// Recipient Last Name
    #[serde(rename = "lastName", default, skip_serializing_if = "Option::is_none")]
    pub last_name: Option<String>,
    /// Recipient Email
    /// Required by the API.
    pub email: String,
    /// Recipient Phone Number
    #[serde(
        rename = "phoneNumber",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub phone_number: Option<String>,
    /// Recipient Phone
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Recipient has completed the document
    /// Required by the API.
    #[serde(rename = "hasCompleted")]
    pub has_completed: bool,
    /// Recipient role
    /// Allowed values: `user`, `signer`.
    /// Required by the API.
    pub role: String,
    /// Recipient is primary
    /// Required by the API.
    #[serde(rename = "isPrimary")]
    pub is_primary: bool,
    /// Recipient signing order
    /// Required by the API.
    #[serde(rename = "signingOrder")]
    pub signing_order: f64,
    /// Recipient image url
    #[serde(rename = "imgUrl", default, skip_serializing_if = "Option::is_none")]
    pub img_url: Option<String>,
    /// Recipient ip
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub ip: Option<String>,
    /// Recipient user agent
    #[serde(rename = "userAgent", default, skip_serializing_if = "Option::is_none")]
    pub user_agent: Option<String>,
    /// Recipient signed date
    #[serde(
        rename = "signedDate",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub signed_date: Option<String>,
    /// Recipient contact name
    #[serde(
        rename = "contactName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_name: Option<String>,
    /// Recipient country
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// Recipient entity name
    #[serde(
        rename = "entityName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_name: Option<String>,
    /// Recipient initials image url
    #[serde(
        rename = "initialsImgUrl",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub initials_img_url: Option<String>,
    /// Recipient last viewed date
    #[serde(
        rename = "lastViewedAt",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub last_viewed_at: Option<String>,
    /// Share link
    #[serde(rename = "shareLink", default, skip_serializing_if = "Option::is_none")]
    pub share_link: Option<String>,
}

/// `SendDocumentDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SendDocumentDto {
    /// Location Id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Document Id
    /// Required by the API.
    #[serde(rename = "documentId")]
    pub document_id: String,
    /// Document Name
    #[serde(
        rename = "documentName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub document_name: Option<String>,
    /// Medium to be used for sending the document
    /// Allowed values: `link`, `email`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub medium: Option<String>,
    /// CC Recipient
    #[serde(
        rename = "ccRecipients",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub cc_recipients: Vec<CCRecipientItem>,
    #[serde(
        rename = "notificationSettings",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub notification_settings: Option<NotificationSettingsDto>,
    /// Sent ByUser Id
    /// Required by the API.
    #[serde(rename = "sentBy")]
    pub sent_by: String,
}

/// `SendDocumentFromPublicApiBodyDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SendDocumentFromPublicApiBodyDto {
    /// Template Id
    /// Required by the API.
    #[serde(rename = "templateId")]
    pub template_id: String,
    /// User Id
    /// Required by the API.
    #[serde(rename = "userId")]
    pub user_id: String,
    /// Send Document
    #[serde(
        rename = "sendDocument",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub send_document: Option<bool>,
    /// Location Id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Contact Id
    /// Required by the API.
    #[serde(rename = "contactId")]
    pub contact_id: String,
    /// Opportunity Id
    #[serde(
        rename = "opportunityId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub opportunity_id: Option<String>,
}

/// `SendDocumentResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SendDocumentResponseDto {
    /// Success status
    /// Required by the API.
    pub success: bool,
    /// Links for all recipients
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub links: Vec<ProposalEstimateLinksDto>,
}

/// `SendTemplateResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SendTemplateResponseDto {
    /// Success status
    /// Required by the API.
    pub success: bool,
    /// Links for all recipients
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub links: Vec<ProposalEstimateLinksDto>,
}

/// `TemplateListPaginationResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TemplateListPaginationResponseDTO {
    /// Array of templates
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<TemplateListResponseDTO>,
    /// Total number of templates
    /// Required by the API.
    pub total: f64,
    /// Trace ID for request tracking
    #[serde(rename = "traceId", default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
}

/// `TemplateListResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TemplateListResponseDTO {
    /// Template ID
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Whether the template is deleted
    /// Required by the API.
    pub deleted: bool,
    /// Template version
    /// Required by the API.
    pub version: f64,
    /// Template name
    /// Required by the API.
    pub name: String,
    /// Location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Template type
    /// Allowed values: `proposal`, `estimate`, `contentLibrary`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// User ID who last updated the template
    /// Required by the API.
    #[serde(rename = "updatedBy")]
    pub updated_by: String,
    /// Whether the template is a public document
    /// Required by the API.
    #[serde(rename = "isPublicDocument")]
    pub is_public_document: bool,
    /// Template creation date
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// Template last update date
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Template ID (alias for _id)
    /// Required by the API.
    #[serde(rename = "id")]
    pub id_alt: String,
    /// Document count (only present when isPublicDocument is true)
    #[serde(
        rename = "documentCount",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub document_count: Option<f64>,
    /// Document form URL (only present when isPublicDocument is true)
    #[serde(
        rename = "docFormUrl",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub doc_form_url: Option<String>,
}

/// `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>,
}