ghl-models 0.4.1

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

/// `CreateCustomObjectRecordDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateCustomObjectRecordDto {
    /// The spec defines no fields for this schema.
    #[serde(flatten)]
    pub extra: serde_json::Map<String, serde_json::Value>,
}

/// `CreateCustomObjectSchemaDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateCustomObjectSchemaDTO {
    /// This is what your custom object will be called. These labels will be used to display
    /// your custom object on the UI
    /// Required by the API.
    pub labels: CustomObjectLabelDto,
    /// key that would be used to refer the Custom Object internally (lowercase +
    /// underscore_separated). 'custom_objects.' would be added as prefix by default
    /// Required by the API.
    pub key: String,
    /// Pet Object`s description
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Location Id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Primary property which will be displayed on the record page
    /// Required by the API.
    #[serde(rename = "primaryDisplayPropertyDetails")]
    pub primary_display_property_details: CustomObjectDisplayPropertyDetails,
}

/// `CreatedByResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreatedByResponseDTO {
    /// Creation Channel
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub channel: Option<String>,
    /// Created At
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "createdAt", default, skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
    /// From where the record was created
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<String>,
    /// User/Resource Id
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "sourceId", default, skip_serializing_if = "Option::is_none")]
    pub source_id: Option<String>,
}

/// `CustomObjectByIdResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomObjectByIdResponseDTO {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub object: Option<ICustomObjectSchema>,
    /// Is the response served from cache
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub cache: Option<bool>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub fields: Vec<ICustomField>,
}

/// `CustomObjectDisplayPropertyDetails` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomObjectDisplayPropertyDetails {
    /// key that would be used to refer the custom field internally (lowercase +
    /// underscore_separated). 'custom_objects.{{objectKey}}' would be added as prefix by
    /// default is not passed
    /// Required by the API.
    pub key: String,
    /// Name of the Primary property name which will be displayed on the record page
    /// Required by the API.
    pub name: String,
    /// Primary property data Type (it can either be TEXT or NUMERICAL type)
    /// Required by the API.
    #[serde(rename = "dataType")]
    pub data_type: String,
}

/// `CustomObjectLabelDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomObjectLabelDto {
    /// Singular name of the custom object
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub singular: Option<String>,
    /// Plural name of the custom object
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub plural: Option<String>,
}

/// `CustomObjectLabelUpdateDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomObjectLabelUpdateDto {
    /// Singular name of the custom object
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub singular: Option<String>,
    /// Plural name of the custom object
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub plural: Option<String>,
}

/// `CustomObjectListResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomObjectListResponseDTO {
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub objects: Vec<ICustomObjectSchema>,
}

/// `CustomObjectResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomObjectResponseDTO {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub object: Option<ICustomObjectSchema>,
}

/// `ICustomField` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ICustomField {
    /// Location Id
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
    /// Field name
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Description of the field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Placeholder text for the field
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub placeholder: Option<String>,
    /// Whether the field should be shown in forms
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "showInForms",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub show_in_forms: Option<bool>,
    /// Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO,
    /// CHECKBOX, TEXTBOX_LIST type)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub options: Vec<OptionDTO>,
    /// Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png,
    /// .gif, .csv, .xlsx, .xls, all
    /// Allowed values: `.pdf`, `.docx`, `.doc`, `.jpg`, `.jpeg`, `.png`, `.gif`, `.csv`,
    /// `.xlsx`, `.xls`, `all`.
    #[serde(
        rename = "acceptedFormats",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub accepted_formats: Option<String>,
    /// Unique identifier of the object
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// The key for your custom / standard object. This key uniquely identifies the custom
    /// object. Example: "custom_object.pet" for a custom object related to pets.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "objectKey", default, skip_serializing_if = "Option::is_none")]
    pub object_key: Option<String>,
    /// Type of field that you are trying to create
    /// Allowed values: `TEXT`, `LARGE_TEXT`, `NUMERICAL`, `PHONE`, `MONETORY`, `CHECKBOX`,
    /// `SINGLE_OPTIONS`, `MULTIPLE_OPTIONS`, `DATE`, `TEXTBOX_LIST`, `FILE_UPLOAD`, `RADIO`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "dataType", default, skip_serializing_if = "Option::is_none")]
    pub data_type: Option<String>,
    /// ID of the parent folder
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "parentId", default, skip_serializing_if = "Option::is_none")]
    pub parent_id: Option<String>,
    /// Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}".
    /// "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and
    /// "{fieldName}" is the unique field name within that object. Example:
    /// "custom_object.pet.name" for a "name" field in a "pet" custom object.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "fieldKey", default, skip_serializing_if = "Option::is_none")]
    pub field_key: Option<String>,
    /// Determines if users can add a custom option value different from the predefined options
    /// in records for RADIO type fields. A custom value added in one record does not
    /// automatically become an option and will not appear as an option for other records.
    #[serde(
        rename = "allowCustomOption",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub allow_custom_option: Option<bool>,
    /// Maximum file limit for uploads
    #[serde(
        rename = "maxFileLimit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub max_file_limit: Option<f64>,
    /// Date and time when the object was added
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    /// Date and time when the object was last updated
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "dateUpdated",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub date_updated: Option<String>,
}

/// `ICustomObjectSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ICustomObjectSchema {
    /// id of the custom / standard object schema
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// false in case of custom objects and true in case of standard objects like contacts and
    /// opportunities
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub standard: Option<bool>,
    /// key that would be used to refer the custom / standard Object internally (lowercase +
    /// underscore_separated). For custom objects, 'custom_objects.' would be added as prefix by
    /// default
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// This is what your custom / standard object will be called. These labels will be used to
    /// display your custom object on the UI
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub labels: Option<CustomObjectLabelDto>,
    /// Custom / Standard Object Descriptions for example , Pet Object`s description
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// location's id
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
    /// Primary property for the custom / standard Object. This would be used as primary data
    /// when rendering the UI. 'custom_objects.{{object_key}} or business.{{object_key}} (for
    /// company)' would be added as prefix by default for all the custom / standard objects
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "primaryDisplayProperty",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub primary_display_property: Option<String>,
    /// Date and time when the object was added
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    /// Date and time when the object was last updated
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "dateUpdated",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub date_updated: Option<String>,
    /// Object`s Type
    #[serde(rename = "type", default, skip_serializing_if = "Option::is_none")]
    pub type_: Option<serde_json::Value>,
}

/// `IRecordSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct IRecordSchema {
    /// id of the record
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Owner (User's id). Limited to 1 for now. Only Supported with custom objects
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub owner: Vec<String>,
    /// Follower (User's ids). Limited to 10 for now
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub followers: Vec<String>,
    /// Properties of the record
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub properties: Option<String>,
    /// Date and time when the object was added
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    /// Date and time when the object was last updated
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "dateUpdated",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub date_updated: Option<String>,
}

/// `ObjectRecordDeleteResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ObjectRecordDeleteResponseDTO {
    /// id of the deleted object
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// boolean that defines if the operation was a success or not
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
}

/// `OptionDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct OptionDTO {
    /// Key of the option (Included in Create and Response, excluded in Update)
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub key: Option<String>,
    /// Value of the option
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub label: Option<String>,
    /// URL associated with the option (Optional, valid only for RADIO type)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub url: Option<String>,
}

/// `RecordByIdResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RecordByIdResponseDTO {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub record: Option<IRecordSchema>,
}

/// `RecordResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RecordResponseDTO {
    /// id of the record
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Owner (User's id). Limited to 1 for now . Only supported for custom objects for now
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub owner: Vec<String>,
    /// Follower (User's ids). Limited to 10 and supported for custom objects for now
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub followers: Vec<String>,
    /// Properties of the record
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub properties: Option<String>,
    /// Date and time when the object was added
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "createdAt", default, skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
    /// Date and time when the object was last updated
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "updatedAt", default, skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<String>,
    /// Location Id
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
    /// ObjectId Id
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "objectId", default, skip_serializing_if = "Option::is_none")]
    pub object_id: Option<String>,
    /// ObjectId key
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "objectKey", default, skip_serializing_if = "Option::is_none")]
    pub object_key: Option<String>,
    /// Created By Meta
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "createdBy", default, skip_serializing_if = "Option::is_none")]
    pub created_by: Option<CreatedByResponseDTO>,
    /// Last Updated By Meta
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "lastUpdatedBy",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub last_updated_by: Option<CreatedByResponseDTO>,
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "searchAfter", default, skip_serializing_if = "Vec::is_empty")]
    pub search_after: Vec<f64>,
}

/// `SearchRecordResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SearchRecordResponseDTO {
    /// Records
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub records: Vec<RecordResponseDTO>,
    /// Total Number of records
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub total: Option<f64>,
}

/// `SearchRecordsBody` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SearchRecordsBody {
    /// Location Id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Page
    /// Required by the API.
    pub page: f64,
    /// Page Limit
    /// Required by the API.
    #[serde(rename = "pageLimit")]
    pub page_limit: f64,
    /// Pass this query parameter to search using your searchable properties. For example, if
    /// you have a custom object called “Pets” and have configured “name” as a searchable
    /// property, you can pass name:Buddy to search for pets with the name “Buddy.”
    /// Required by the API.
    pub query: String,
    /// Required by the API.
    #[serde(rename = "searchAfter", default, skip_serializing_if = "Vec::is_empty")]
    pub search_after: Vec<String>,
}

/// `UpdateCustomObjectRecordDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateCustomObjectRecordDto {
    /// The spec defines no fields for this schema.
    #[serde(flatten)]
    pub extra: serde_json::Map<String, serde_json::Value>,
}

/// `UpdateCustomObjectSchemaDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateCustomObjectSchemaDTO {
    /// This is how your custom object will be displayed
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub labels: Option<CustomObjectLabelUpdateDto>,
    /// Pet Object`s description
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// location id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Searchable Fields: Provide the field key of your object that you want to search on,
    /// using the format (custom_object. . ).
    /// Required by the API.
    #[serde(
        rename = "searchableProperties",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub searchable_properties: Vec<String>,
}