ghl-models 0.4.1

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

/// `BusinessSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct BusinessSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    #[serde(rename = "logoUrl", default, skip_serializing_if = "Option::is_none")]
    pub logo_url: Option<String>,
}

/// `CreateCustomFieldsDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateCustomFieldsDTO {
    /// Required by the API.
    pub name: String,
    /// Required by the API.
    #[serde(rename = "dataType")]
    pub data_type: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub placeholder: Option<String>,
    #[serde(
        rename = "acceptedFormat",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub accepted_format: Vec<String>,
    #[serde(
        rename = "isMultipleFile",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_multiple_file: Option<bool>,
    #[serde(
        rename = "maxNumberOfFiles",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub max_number_of_files: Option<f64>,
    /// Multiple possible shapes in the spec; raw JSON.
    #[serde(
        rename = "textBoxListOptions",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub text_box_list_options: Vec<serde_json::Value>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub position: Option<f64>,
    /// Model of the custom field you want to create
    /// Allowed values: `contact`, `opportunity`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub model: Option<String>,
}

/// `CreateLocationDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateLocationDto {
    /// The name for the sub-account/location
    /// Required by the API.
    pub name: String,
    /// The phone number of the business for which sub-account is created with the appropriate
    /// country-code
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Company/Agency Id
    /// Required by the API.
    #[serde(rename = "companyId")]
    pub company_id: String,
    /// The address of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    /// The city where the business is located for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    /// The state in which the business operates for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// The 2 letter country-code in which the business is present for which sub-account is
    /// created
    /// Allowed values: `AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// The postal code of the business for which sub-account is created
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    /// The website of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    /// The timezone of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    #[serde(
        rename = "prospectInfo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub prospect_info: Option<ProspectInfoDto>,
    /// The default settings for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub settings: Option<SettingsSchema>,
    /// The social media links for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub social: Option<SocialSchema>,
    /// The twilio credentials for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub twilio: Option<TwilioSchema>,
    /// The mailgun credentials for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mailgun: Option<MailgunSchema>,
    /// The snapshot ID to be loaded into the location.
    #[serde(
        rename = "snapshotId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub snapshot_id: Option<String>,
}

/// `CreateLocationSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateLocationSuccessfulResponseDto {
    /// Location Id
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Company/Agency Id
    #[serde(rename = "companyId", default, skip_serializing_if = "Option::is_none")]
    pub company_id: Option<String>,
    /// The name for the sub-account/location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The phone number of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// The email for the sub-account/location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// The address of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    /// The city where the business is located for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    /// The state in which the business operates for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub domain: Option<String>,
    /// The country in which the business is present for which sub-account is created
    /// Allowed values: `AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// The postal code of the business for which sub-account is created
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    /// The website of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    /// The timezone of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    /// The default settings for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub settings: Option<SettingsSchema>,
    /// The social media links for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub social: Option<SocialSchema>,
}

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

/// `CustomFieldSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomFieldSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(rename = "fieldKey", default, skip_serializing_if = "Option::is_none")]
    pub field_key: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub placeholder: Option<String>,
    #[serde(rename = "dataType", default, skip_serializing_if = "Option::is_none")]
    pub data_type: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub position: Option<f64>,
    #[serde(
        rename = "picklistOptions",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub picklist_options: Vec<String>,
    #[serde(
        rename = "picklistImageOptions",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub picklist_image_options: Vec<String>,
    #[serde(
        rename = "isAllowedCustomOption",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_allowed_custom_option: Option<bool>,
    #[serde(
        rename = "isMultiFileAllowed",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_multi_file_allowed: Option<bool>,
    #[serde(
        rename = "maxFileLimit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub max_file_limit: Option<f64>,
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
    /// Model of the custom field
    /// Allowed values: `contact`, `opportunity`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub model: Option<String>,
}

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

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

/// `CustomRRulesOptions` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomRRulesOptions {
    /// Allowed values: `yearly`, `monthly`, `weekly`, `daily`, `hourly`.
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "intervalType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub interval_type: Option<String>,
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub interval: Option<f64>,
    /// Start Date
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(rename = "startDate", default, skip_serializing_if = "Option::is_none")]
    pub start_date: Option<String>,
    /// End Date
    #[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
    pub end_date: Option<String>,
    /// 1, 2, 3, ..., 27, 31
    #[serde(
        rename = "dayOfMonth",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub day_of_month: Option<f64>,
    /// Allowed values: `MO`, `TU`, `WE`, `TH`, `FR`, `SA`, `SU`.
    #[serde(rename = "dayOfWeek", default, skip_serializing_if = "Option::is_none")]
    pub day_of_week: Option<String>,
    /// 1, 2, ....., 11, 12
    #[serde(
        rename = "monthOfYear",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub month_of_year: Option<f64>,
    /// Max number of task executions
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub count: Option<f64>,
    /// Create Task If Over Due
    #[serde(
        rename = "createTaskIfOverDue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub create_task_if_over_due: Option<bool>,
    /// Due after seconds
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "dueAfterSeconds",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub due_after_seconds: Option<f64>,
}

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

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

/// `CustomValueSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomValueSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(rename = "fieldKey", default, skip_serializing_if = "Option::is_none")]
    pub field_key: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub value: Option<String>,
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
}

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

/// `DeleteRecurringTaskResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteRecurringTaskResponseDTO {
    /// Recurring Task Id
    /// 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>,
    /// Success
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
}

/// `EmailTemplateSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct EmailTemplateSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subject: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<Vec<serde_json::Value>>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub html: Option<String>,
}

/// `FileUploadBody` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FileUploadBody {
    /// Id(Contact Id/Opportunity Id/Custom Field Id)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// Max number of files
    #[serde(rename = "maxFiles", default, skip_serializing_if = "Option::is_none")]
    pub max_files: Option<String>,
}

/// `FileUploadResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FileUploadResponseDto {
    /// Uploaded files
    #[serde(
        rename = "uploadedFiles",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub uploaded_files: Option<serde_json::Value>,
    /// Meta data of uploaded files
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub meta: Vec<String>,
}

/// `GetEmailTemplateResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetEmailTemplateResponseSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(rename = "type", default, skip_serializing_if = "Option::is_none")]
    pub type_: Option<String>,
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub template: Option<EmailTemplateSchema>,
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
}

/// `GetLocationByIdSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetLocationByIdSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(rename = "companyId", default, skip_serializing_if = "Option::is_none")]
    pub company_id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub domain: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    #[serde(rename = "logoUrl", default, skip_serializing_if = "Option::is_none")]
    pub logo_url: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    #[serde(rename = "firstName", default, skip_serializing_if = "Option::is_none")]
    pub first_name: Option<String>,
    #[serde(rename = "lastName", default, skip_serializing_if = "Option::is_none")]
    pub last_name: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub business: Option<BusinessSchema>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub social: Option<SocialSchema>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub settings: Option<SettingsSchema>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub reseller: Option<serde_json::Value>,
}

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

/// `GetLocationSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetLocationSchema {
    /// Location Id
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    /// The name for the sub-account/location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The phone number of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// The email for the sub-account/location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// The address of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    /// The city where the business is located for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    /// The state in which the business operates for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// The country in which the business is present for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// The postal code of the business for which sub-account is created
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    /// The website of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    /// The timezone of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    /// The default settings for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub settings: Option<SettingsSchema>,
    /// The social media links for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub social: Option<SocialSchema>,
}

/// `GetSmsTemplateResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetSmsTemplateResponseSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub id: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(rename = "type", default, skip_serializing_if = "Option::is_none")]
    pub type_: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub template: Option<SmsTemplateSchema>,
    #[serde(rename = "dateAdded", default, skip_serializing_if = "Option::is_none")]
    pub date_added: Option<String>,
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
    #[serde(
        rename = "urlAttachments",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub url_attachments: Vec<String>,
}

/// `GetTemplatesSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetTemplatesSuccessfulResponseDto {
    /// Multiple possible shapes in the spec; raw JSON.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub templates: Vec<serde_json::Value>,
    #[serde(
        rename = "totalCount",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub total_count: Option<f64>,
}

/// `LocationDeletedSuccessfulResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct LocationDeletedSuccessfulResponseDto {
    /// Success status of the API
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub success: Option<bool>,
    /// Success message of the API
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

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

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

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

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

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

/// `MailgunSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct MailgunSchema {
    /// API key provided by Mailgun
    /// Required by the API.
    #[serde(rename = "apiKey")]
    pub api_key: String,
    /// Domain connected with Mailgun
    /// Required by the API.
    pub domain: String,
}

/// `ProspectInfoDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProspectInfoDto {
    /// First name of the prospect
    /// Required by the API.
    #[serde(rename = "firstName")]
    pub first_name: String,
    /// Last name of the prospect
    /// Required by the API.
    #[serde(rename = "lastName")]
    pub last_name: String,
    /// Email of the prospect
    /// Required by the API.
    pub email: String,
}

/// `RecurringTaskCreateDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RecurringTaskCreateDTO {
    /// Name of the task
    /// Required by the API.
    pub title: String,
    /// Description of the task
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Contact Id
    #[serde(rename = "contactIds", default, skip_serializing_if = "Vec::is_empty")]
    pub contact_ids: Vec<String>,
    /// Assigned To
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub owners: Vec<String>,
    /// Recurring rules
    /// Required by the API.
    #[serde(rename = "rruleOptions")]
    pub rrule_options: CustomRRulesOptions,
    /// Create initial task or not
    #[serde(
        rename = "ignoreTaskCreation",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub ignore_task_creation: Option<bool>,
}

/// `RecurringTaskResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RecurringTaskResponseDTO {
    /// Recurring Task Id
    /// 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>,
    /// Name of the task
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Description of the task
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: 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>,
    /// Updated At
    /// 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>,
    /// 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>,
    /// Recurring rules
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "rruleOptions",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub rrule_options: Option<CustomRRulesOptions>,
    /// Total Occurrence
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "totalOccurrence",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub total_occurrence: Option<f64>,
    /// Deleted
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub deleted: Option<bool>,
    /// Assigned To
    #[serde(
        rename = "assignedTo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub assigned_to: Option<String>,
    /// Contact Id
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
}

/// `RecurringTaskSingleResponseDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RecurringTaskSingleResponseDTO {
    /// Recurring Tasks
    /// Required by the API.
    /// (Optional here so responses that omit it still parse.)
    #[serde(
        rename = "recurringTask",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub recurring_task: Option<RecurringTaskResponseDTO>,
}

/// `RecurringTaskUpdateDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RecurringTaskUpdateDTO {
    /// Name of the task
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub title: Option<String>,
    /// Description of the task
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Contact Id
    #[serde(rename = "contactIds", default, skip_serializing_if = "Vec::is_empty")]
    pub contact_ids: Vec<String>,
    /// Assigned To
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub owners: Vec<String>,
    /// Recurring rules
    #[serde(
        rename = "rruleOptions",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub rrule_options: Option<CustomRRulesOptions>,
    /// Create initial task or not
    #[serde(
        rename = "ignoreTaskCreation",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub ignore_task_creation: Option<bool>,
}

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

/// `SettingsSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SettingsSchema {
    #[serde(
        rename = "allowDuplicateContact",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub allow_duplicate_contact: Option<bool>,
    #[serde(
        rename = "allowDuplicateOpportunity",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub allow_duplicate_opportunity: Option<bool>,
    #[serde(
        rename = "allowFacebookNameMerge",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub allow_facebook_name_merge: Option<bool>,
    #[serde(
        rename = "disableContactTimezone",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub disable_contact_timezone: Option<bool>,
}

/// `SmsTemplateSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SmsTemplateSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub body: Option<String>,
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub attachments: Vec<Vec<serde_json::Value>>,
}

/// `SnapshotPutSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SnapshotPutSchema {
    /// Snaptshot ID
    /// Required by the API.
    pub id: String,
    /// If you want override all conflicted assets then pass true. Default value is false.
    #[serde(rename = "override", default, skip_serializing_if = "Option::is_none")]
    pub override_: Option<bool>,
}

/// `SocialSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SocialSchema {
    /// Facebook URL
    #[serde(
        rename = "facebookUrl",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub facebook_url: Option<String>,
    /// Googleplus URL
    #[serde(
        rename = "googlePlus",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub google_plus: Option<String>,
    /// LinkedIn URL
    #[serde(rename = "linkedIn", default, skip_serializing_if = "Option::is_none")]
    pub linked_in: Option<String>,
    /// Foursquare URL
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub foursquare: Option<String>,
    /// Twitter URL
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub twitter: Option<String>,
    /// Yelp URL
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub yelp: Option<String>,
    /// Instagram URL
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub instagram: Option<String>,
    /// Instagram URL
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub youtube: Option<String>,
    /// Instagram URL
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub pinterest: Option<String>,
    /// Instagram URL
    #[serde(rename = "blogRss", default, skip_serializing_if = "Option::is_none")]
    pub blog_rss: Option<String>,
    /// Google Business Places ID
    #[serde(
        rename = "googlePlacesId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub google_places_id: Option<String>,
}

/// `TaskSearchParamsDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TaskSearchParamsDto {
    /// Contact Ids
    #[serde(rename = "contactId", default, skip_serializing_if = "Vec::is_empty")]
    pub contact_id: Vec<String>,
    /// Task Completed Or Pending
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub completed: Option<bool>,
    /// Assigned User Ids
    #[serde(rename = "assignedTo", default, skip_serializing_if = "Vec::is_empty")]
    pub assigned_to: Vec<String>,
    /// Search Value
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub query: Option<String>,
    /// Limit To Api
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub limit: Option<f64>,
    /// Number Of Tasks To Skip
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub skip: Option<f64>,
    /// Bussiness Id
    #[serde(
        rename = "businessId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub business_id: Option<String>,
}

/// `TwilioSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TwilioSchema {
    /// SID provided by Twilio
    /// Required by the API.
    pub sid: String,
    /// Auth token provided by Twilio
    /// Required by the API.
    #[serde(rename = "authToken")]
    pub auth_token: String,
}

/// `UpdateCustomFieldsDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateCustomFieldsDTO {
    /// Required by the API.
    pub name: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub placeholder: Option<String>,
    #[serde(
        rename = "acceptedFormat",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub accepted_format: Vec<String>,
    #[serde(
        rename = "isMultipleFile",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_multiple_file: Option<bool>,
    #[serde(
        rename = "maxNumberOfFiles",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub max_number_of_files: Option<f64>,
    /// Multiple possible shapes in the spec; raw JSON.
    #[serde(
        rename = "textBoxListOptions",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub text_box_list_options: Vec<serde_json::Value>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub position: Option<f64>,
    /// Model of the custom field you want to update
    /// Allowed values: `contact`, `opportunity`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub model: Option<String>,
}

/// `UpdateLocationDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateLocationDto {
    /// The name for the sub-account/location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The phone number of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Company/Agency Id
    /// Required by the API.
    #[serde(rename = "companyId")]
    pub company_id: String,
    /// The address of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address: Option<String>,
    /// The city where the business is located for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    /// The state in which the business operates for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// The country in which the business is present for which sub-account is created
    /// Allowed values: `AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub country: Option<String>,
    /// The postal code of the business for which sub-account is created
    #[serde(
        rename = "postalCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub postal_code: Option<String>,
    /// The website of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub website: Option<String>,
    /// The timezone of the business for which sub-account is created
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub timezone: Option<String>,
    #[serde(
        rename = "prospectInfo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub prospect_info: Option<ProspectInfoDto>,
    /// The default settings for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub settings: Option<SettingsSchema>,
    /// The social media links for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub social: Option<SocialSchema>,
    /// The twilio credentials for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub twilio: Option<TwilioSchema>,
    /// The mailgun credentials for location
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub mailgun: Option<MailgunSchema>,
    /// The snapshot to be updated in the location.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub snapshot: Option<SnapshotPutSchema>,
}

/// `customValuesDTO` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomValuesDTO {
    /// Required by the API.
    pub name: String,
    /// Required by the API.
    pub value: String,
}

/// `tagBody` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TagBody {
    /// Tag name
    /// Required by the API.
    pub name: String,
}

/// `textBoxListOptionsSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TextBoxListOptionsSchema {
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub label: Option<String>,
    #[serde(
        rename = "prefillValue",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub prefill_value: Option<String>,
}