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};

/// `AvailableShippingRate` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AvailableShippingRate {
    /// Name of the shipping zone
    /// Required by the API.
    pub name: String,
    /// Delivery description
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// The currency of the amount of the rate / handling fee
    /// Required by the API.
    pub currency: String,
    /// The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee
    /// if it is a carrier rate (it will add to the carrier rate).
    /// Required by the API.
    pub amount: f64,
    /// is this a carrier rate
    #[serde(
        rename = "isCarrierRate",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_carrier_rate: Option<bool>,
    /// Shipping carrier id
    /// Required by the API.
    #[serde(rename = "shippingCarrierId")]
    pub shipping_carrier_id: String,
    /// Percentage of rate fee if it is a carrier rate.
    #[serde(
        rename = "percentageOfRateFee",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub percentage_of_rate_fee: Option<f64>,
    /// An array of items
    #[serde(
        rename = "shippingCarrierServices",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub shipping_carrier_services: Vec<ShippingCarrierServiceDto>,
    /// The unique identifier for the product.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// The unique identifier for the shipping zone.
    /// Required by the API.
    #[serde(rename = "shippingZoneId")]
    pub shipping_zone_id: String,
}

/// `ContactAddress` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ContactAddress {
    /// Name of the customer
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Name of the Company
    #[serde(
        rename = "companyName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub company_name: Option<String>,
    /// Address line 1 of the customer
    #[serde(
        rename = "addressLine1",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub address_line1: Option<String>,
    /// Country code of the customer
    /// Allowed values: `US`, `CA`, `AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`.
    /// Required by the API.
    pub country: String,
    /// State code of the customer
    /// Allowed values: `AL`, `AK`, `AS`, `AZ`, `AR`, `AA`, `AE`, `AP`, `CA`, `CO`, `CT`, `DE`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// City of the customer
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub city: Option<String>,
    /// Zip code of the customer
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub zip: Option<String>,
    /// Phone number of the customer
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Email of the customer
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
}

/// `CreateShippingCarrierDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateShippingCarrierDto {
    /// Location Id or Agency Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Name of the shipping carrier
    /// Required by the API.
    pub name: String,
    /// The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL.
    /// Required by the API.
    #[serde(rename = "callbackUrl")]
    pub callback_url: String,
    /// An array of available shipping carrier services
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub services: Vec<ShippingCarrierServiceDto>,
    /// The seller can choose multiple services while creating shipping rates if this is true.
    #[serde(
        rename = "allowsMultipleServiceSelection",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub allows_multiple_service_selection: Option<bool>,
}

/// `CreateShippingCarrierResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateShippingCarrierResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping carrier data
    /// Required by the API.
    pub data: ShippingCarrierSchema,
}

/// `CreateShippingRateDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateShippingRateDto {
    /// Location Id or Agency Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Name of the shipping zone
    /// Required by the API.
    pub name: String,
    /// Delivery description
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// The currency of the amount of the rate / handling fee
    /// Required by the API.
    pub currency: String,
    /// The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee
    /// if it is a carrier rate (it will add to the carrier rate).
    /// Required by the API.
    pub amount: f64,
    /// Type of condition to provide the conditional pricing
    /// Allowed values: `none`, `price`, `weight`.
    /// Required by the API.
    #[serde(rename = "conditionType")]
    pub condition_type: String,
    /// Minimum condition for applying this price. set 0 or null if there is no minimum
    /// Required by the API.
    #[serde(rename = "minCondition")]
    pub min_condition: f64,
    /// Maximum condition for applying this price. set 0 or null if there is no maximum
    /// Required by the API.
    #[serde(rename = "maxCondition")]
    pub max_condition: f64,
    /// is this a carrier rate
    #[serde(
        rename = "isCarrierRate",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_carrier_rate: Option<bool>,
    /// Shipping carrier id
    /// Required by the API.
    #[serde(rename = "shippingCarrierId")]
    pub shipping_carrier_id: String,
    /// Percentage of rate fee if it is a carrier rate.
    #[serde(
        rename = "percentageOfRateFee",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub percentage_of_rate_fee: Option<f64>,
    /// An array of items
    #[serde(
        rename = "shippingCarrierServices",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub shipping_carrier_services: Vec<ShippingCarrierServiceDto>,
}

/// `CreateShippingRateResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateShippingRateResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping zone data
    /// Required by the API.
    pub data: ShippingRateSchema,
}

/// `CreateShippingZoneDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateShippingZoneDto {
    /// Location Id or Agency Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Name of the shipping zone
    /// Required by the API.
    pub name: String,
    /// List of countries that are available
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub countries: Vec<ShippingZoneCountryDto>,
}

/// `CreateShippingZoneResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateShippingZoneResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping zone data
    /// Required by the API.
    pub data: ShippingZoneSchema,
}

/// `CreateStoreSettingDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateStoreSettingDto {
    /// Location Id or Agency Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Shipping origin address
    /// Required by the API.
    #[serde(rename = "shippingOrigin")]
    pub shipping_origin: StoreShippingOriginDto,
    /// Store order notification email
    #[serde(
        rename = "storeOrderNotification",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub store_order_notification: Option<StoreOrderNotificationDto>,
    /// Store order fulfillment notification email
    #[serde(
        rename = "storeOrderFulfillmentNotification",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub store_order_fulfillment_notification: Option<StoreOrderFulfillmentNotificationDto>,
}

/// `CreateStoreSettingResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateStoreSettingResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping carrier data
    /// Required by the API.
    pub data: StoreSettingSchema,
}

/// `DeleteShippingCarrierResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteShippingCarrierResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

/// `DeleteShippingRateResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteShippingRateResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

/// `DeleteShippingZoneResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteShippingZoneResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
}

/// `GetAvailableShippingRates` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetAvailableShippingRates {
    /// Location Id or Agency Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Country code of the customer
    /// Allowed values: `US`, `CA`, `AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`.
    /// Required by the API.
    pub country: String,
    /// Address of the customer
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub address: Option<ContactAddress>,
    /// it will not calculate the order amount form backend if it is true
    /// Allowed values: `AF`, `AX`, `AL`, `DZ`, `AS`, `AD`, `AO`, `AI`, `AQ`, `AG`, `AR`, `AM`.
    #[serde(
        rename = "amountAvailable",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub amount_available: Option<String>,
    /// The amount of the price. ( min: 0.01 )
    /// Required by the API.
    #[serde(rename = "totalOrderAmount")]
    pub total_order_amount: f64,
    /// Flag to pass when the weight is already calculated and should not calculate again
    #[serde(
        rename = "weightAvailable",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub weight_available: Option<bool>,
    /// Estimated weight of the order calculated from the order creation side in kg(s)
    /// Required by the API.
    #[serde(rename = "totalOrderWeight")]
    pub total_order_weight: f64,
    /// Source of the order
    /// Required by the API.
    pub source: OrderSource,
    /// An array of price IDs and quantity
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub products: Vec<ProductItem>,
    /// Coupon code
    #[serde(
        rename = "couponCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub coupon_code: Option<String>,
}

/// `GetAvailableShippingRatesResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetAvailableShippingRatesResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping rate data
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<AvailableShippingRate>,
}

/// `GetShippingCarrierResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetShippingCarrierResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping carrier data
    /// Required by the API.
    pub data: ShippingCarrierSchema,
}

/// `GetShippingRateResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetShippingRateResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping zone data
    /// Required by the API.
    pub data: ShippingRateSchema,
}

/// `GetShippingZoneResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetShippingZoneResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping zone data
    /// Required by the API.
    pub data: ShippingZoneSchema,
}

/// `GetStoreSettingResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetStoreSettingResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping carrier data
    /// Required by the API.
    pub data: StoreSettingSchema,
}

/// `ListShippingCarrierResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListShippingCarrierResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// An array of items
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<ShippingCarrierSchema>,
}

/// `ListShippingRateResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListShippingRateResponseDto {
    /// Total number of items
    /// Required by the API.
    pub total: f64,
    /// An array of items
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<ShippingRateSchema>,
}

/// `ListShippingZoneResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListShippingZoneResponseDto {
    /// Total number of items
    /// Required by the API.
    pub total: f64,
    /// An array of items
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<ShippingZoneSchema>,
}

/// `OrderSource` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct OrderSource {
    /// Source of order
    /// Allowed values: `funnel`, `website`, `invoice`, `calendar`, `text2Pay`,
    /// `document_contracts`, `membership`, `mobile_app`, `communities`, `point_of_sale`,
    /// `manual`, `form`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Source subtype of order
    /// Allowed values: `one_step_order_form`, `two_step_order_form`, `upsell`, `tap_to_pay`,
    /// `card_payment`, `store`, `contact_view`, `email_campaign`, `payments_dashboard`,
    /// `shopify`, `subscription_view`, `store_upsell`.
    #[serde(rename = "subType", default, skip_serializing_if = "Option::is_none")]
    pub sub_type: Option<String>,
}

/// `ProductItem` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProductItem {
    /// id of product
    /// Required by the API.
    pub id: String,
    /// No of quantities
    /// Required by the API.
    pub qty: f64,
}

/// `ShippingCarrierSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ShippingCarrierSchema {
    /// Location Id or Agency Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Name of the shipping carrier
    /// Required by the API.
    pub name: String,
    /// The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL.
    /// Required by the API.
    #[serde(rename = "callbackUrl")]
    pub callback_url: String,
    /// An array of available shipping carrier services
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub services: Vec<ShippingCarrierServiceDto>,
    /// The seller can choose multiple services while creating shipping rates if this is true.
    #[serde(
        rename = "allowsMultipleServiceSelection",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub allows_multiple_service_selection: Option<bool>,
    /// The unique identifier for the product.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// The unique identifier for the marketplace app.
    /// Required by the API.
    #[serde(rename = "marketplaceAppId")]
    pub marketplace_app_id: String,
    /// created at
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// updated at
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

/// `ShippingCarrierServiceDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ShippingCarrierServiceDto {
    /// Name of the shipping carrier service
    /// Required by the API.
    pub name: String,
    /// Value of the shipping carrier service
    /// Required by the API.
    pub value: String,
}

/// `ShippingRateSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ShippingRateSchema {
    /// Location Id or Agency Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Name of the shipping zone
    /// Required by the API.
    pub name: String,
    /// Delivery description
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// The currency of the amount of the rate / handling fee
    /// Required by the API.
    pub currency: String,
    /// The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee
    /// if it is a carrier rate (it will add to the carrier rate).
    /// Required by the API.
    pub amount: f64,
    /// Type of condition to provide the conditional pricing
    /// Allowed values: `none`, `price`, `weight`.
    /// Required by the API.
    #[serde(rename = "conditionType")]
    pub condition_type: String,
    /// Minimum condition for applying this price. set 0 or null if there is no minimum
    /// Required by the API.
    #[serde(rename = "minCondition")]
    pub min_condition: f64,
    /// Maximum condition for applying this price. set 0 or null if there is no maximum
    /// Required by the API.
    #[serde(rename = "maxCondition")]
    pub max_condition: f64,
    /// is this a carrier rate
    #[serde(
        rename = "isCarrierRate",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_carrier_rate: Option<bool>,
    /// Shipping carrier id
    /// Required by the API.
    #[serde(rename = "shippingCarrierId")]
    pub shipping_carrier_id: String,
    /// Percentage of rate fee if it is a carrier rate.
    #[serde(
        rename = "percentageOfRateFee",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub percentage_of_rate_fee: Option<f64>,
    /// An array of items
    #[serde(
        rename = "shippingCarrierServices",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub shipping_carrier_services: Vec<ShippingCarrierServiceDto>,
    /// The unique identifier for the product.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// The unique identifier for the shipping zone.
    /// Required by the API.
    #[serde(rename = "shippingZoneId")]
    pub shipping_zone_id: String,
    /// created at
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// updated at
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

/// `ShippingZoneCountryDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ShippingZoneCountryDto {
    /// Country code
    /// Allowed values: `['US', 'CA', 'AF', 'AX', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ',
    /// 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ',
    /// 'BJ', 'BM', 'BT', 'BO', 'BA', 'BW', 'BV', 'BR', 'IO', 'BN', 'BG', 'BF', 'BI', 'KH',
    /// 'CM', 'CV', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC', 'CO', 'KM', 'CG', 'CD', 'CK',
    /// 'CR', 'CI', 'HR', 'CU', 'CY', 'CZ', 'DK', 'DJ', 'DM', 'DO', 'EC', 'EG', 'SV', 'GQ',
    /// 'ER', 'EE', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'TF', 'GA', 'GM', 'GE',
    /// 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT',
    /// 'HM', 'VA', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM', 'IL', 'IT',
    /// 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KP', 'XK', 'KW', 'KG', 'LA', 'LV', 'LB',
    /// 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MK', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT',
    /// 'MH', 'MQ', 'MR', 'MU', 'YT', 'MX', 'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ',
    /// 'MM', 'NA', 'NR', 'NP', 'NL', 'AN', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'NF', 'MP',
    /// 'NO', 'OM', 'PK', 'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR',
    /// 'QA', 'RE', 'RO', 'RU', 'RW', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC', 'WS', 'SM', 'ST',
    /// 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SX', 'SK', 'SI', 'SB', 'SO', 'ZA', 'GS', 'KR',
    /// 'ES', 'LK', 'SD', 'SR', 'SJ', 'SZ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TL',
    /// 'TG', 'TK', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'UG', 'UA', 'AE', 'GB', 'UM',
    /// 'UY', 'UZ', 'VU', 'VE', 'VN', 'VG', 'VI', 'WF', 'EH', 'YE', 'ZM', 'ZW']`.
    /// Required by the API.
    pub code: String,
    /// List of states that are available. If states is empty, then all states are available
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub states: Vec<ShippingZoneCountryStateDto>,
}

/// `ShippingZoneCountryStateDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ShippingZoneCountryStateDto {
    /// State code
    /// Allowed values: `AL`, `AK`, `AS`, `AZ`, `AR`, `AA`, `AE`, `AP`, `CA`, `CO`, `CT`, `DE`.
    /// Required by the API.
    pub code: String,
}

/// `ShippingZoneSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ShippingZoneSchema {
    /// Location Id or Agency Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Name of the shipping zone
    /// Required by the API.
    pub name: String,
    /// List of countries that are available
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub countries: Vec<ShippingZoneCountryDto>,
    /// The unique identifier for the product.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Array of shipping rates under this shipping zone
    #[serde(
        rename = "shippingRates",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub shipping_rates: Vec<ShippingRateSchema>,
    /// created at
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// updated at
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

/// `StoreOrderFulfillmentNotificationDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StoreOrderFulfillmentNotificationDto {
    /// Store order fulfillment notification enabled
    /// Required by the API.
    pub enabled: bool,
    /// Store order fulfillment email subject
    /// Required by the API.
    pub subject: String,
    /// Email Template Id
    /// Required by the API.
    #[serde(rename = "emailTemplateId")]
    pub email_template_id: String,
    /// Default Email Template Id
    /// Required by the API.
    #[serde(rename = "defaultEmailTemplateId")]
    pub default_email_template_id: String,
}

/// `StoreOrderNotificationDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StoreOrderNotificationDto {
    /// Store order notification enabled
    /// Required by the API.
    pub enabled: bool,
    /// Store order email subject
    /// Required by the API.
    pub subject: String,
    /// Email Template Id
    /// Required by the API.
    #[serde(rename = "emailTemplateId")]
    pub email_template_id: String,
    /// Default Email Template Id
    /// Required by the API.
    #[serde(rename = "defaultEmailTemplateId")]
    pub default_email_template_id: String,
}

/// `StoreSettingSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StoreSettingSchema {
    /// Location Id or Agency Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Shipping origin address
    /// Required by the API.
    #[serde(rename = "shippingOrigin")]
    pub shipping_origin: StoreShippingOriginDto,
    /// Store order notification email
    #[serde(
        rename = "storeOrderNotification",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub store_order_notification: Option<StoreOrderNotificationDto>,
    /// Store order fulfillment notification email
    #[serde(
        rename = "storeOrderFulfillmentNotification",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub store_order_fulfillment_notification: Option<StoreOrderFulfillmentNotificationDto>,
    /// The unique identifier for the settings.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// created at
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// updated at
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

/// `StoreShippingOriginDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct StoreShippingOriginDto {
    /// Name of the store / company
    /// Required by the API.
    pub name: String,
    /// Country code
    /// Allowed values: `['US', 'CA', 'AF', 'AX', 'AL', 'DZ', 'AS', 'AD', 'AO', 'AI', 'AQ',
    /// 'AG', 'AR', 'AM', 'AW', 'AU', 'AT', 'AZ', 'BS', 'BH', 'BD', 'BB', 'BY', 'BE', 'BZ',
    /// 'BJ', 'BM', 'BT', 'BO', 'BA', 'BW', 'BV', 'BR', 'IO', 'BN', 'BG', 'BF', 'BI', 'KH',
    /// 'CM', 'CV', 'KY', 'CF', 'TD', 'CL', 'CN', 'CX', 'CC', 'CO', 'KM', 'CG', 'CD', 'CK',
    /// 'CR', 'CI', 'HR', 'CU', 'CY', 'CZ', 'DK', 'DJ', 'DM', 'DO', 'EC', 'EG', 'SV', 'GQ',
    /// 'ER', 'EE', 'ET', 'FK', 'FO', 'FJ', 'FI', 'FR', 'GF', 'PF', 'TF', 'GA', 'GM', 'GE',
    /// 'DE', 'GH', 'GI', 'GR', 'GL', 'GD', 'GP', 'GU', 'GT', 'GG', 'GN', 'GW', 'GY', 'HT',
    /// 'HM', 'VA', 'HN', 'HK', 'HU', 'IS', 'IN', 'ID', 'IR', 'IQ', 'IE', 'IM', 'IL', 'IT',
    /// 'JM', 'JP', 'JE', 'JO', 'KZ', 'KE', 'KI', 'KP', 'XK', 'KW', 'KG', 'LA', 'LV', 'LB',
    /// 'LS', 'LR', 'LY', 'LI', 'LT', 'LU', 'MO', 'MK', 'MG', 'MW', 'MY', 'MV', 'ML', 'MT',
    /// 'MH', 'MQ', 'MR', 'MU', 'YT', 'MX', 'FM', 'MD', 'MC', 'MN', 'ME', 'MS', 'MA', 'MZ',
    /// 'MM', 'NA', 'NR', 'NP', 'NL', 'AN', 'NC', 'NZ', 'NI', 'NE', 'NG', 'NU', 'NF', 'MP',
    /// 'NO', 'OM', 'PK', 'PW', 'PS', 'PA', 'PG', 'PY', 'PE', 'PH', 'PN', 'PL', 'PT', 'PR',
    /// 'QA', 'RE', 'RO', 'RU', 'RW', 'SH', 'KN', 'LC', 'MF', 'PM', 'VC', 'WS', 'SM', 'ST',
    /// 'SA', 'SN', 'RS', 'SC', 'SL', 'SG', 'SX', 'SK', 'SI', 'SB', 'SO', 'ZA', 'GS', 'KR',
    /// 'ES', 'LK', 'SD', 'SR', 'SJ', 'SZ', 'SE', 'CH', 'SY', 'TW', 'TJ', 'TZ', 'TH', 'TL',
    /// 'TG', 'TK', 'TO', 'TT', 'TN', 'TR', 'TM', 'TC', 'TV', 'UG', 'UA', 'AE', 'GB', 'UM',
    /// 'UY', 'UZ', 'VU', 'VE', 'VN', 'VG', 'VI', 'WF', 'EH', 'YE', 'ZM', 'ZW']`.
    /// Required by the API.
    pub country: String,
    /// State code
    /// Allowed values: `AL`, `AK`, `AS`, `AZ`, `AR`, `AA`, `AE`, `AP`, `CA`, `CO`, `CT`, `DE`.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub state: Option<String>,
    /// City name
    /// Required by the API.
    pub city: String,
    /// Street address line 1
    /// Required by the API.
    pub street1: String,
    /// Street address line 2
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub street2: Option<String>,
    /// Zip code
    /// Required by the API.
    pub zip: String,
    /// Business Phone Number
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub phone: Option<String>,
    /// Email
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
}

/// `UpdateShippingCarrierDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateShippingCarrierDto {
    /// Location Id or Agency Id
    #[serde(rename = "altId", default, skip_serializing_if = "Option::is_none")]
    pub alt_id: Option<String>,
    /// Allowed values: `location`.
    #[serde(rename = "altType", default, skip_serializing_if = "Option::is_none")]
    pub alt_type: Option<String>,
    /// Name of the shipping carrier
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// The URL endpoint that CRM needs to retrieve shipping rates. This must be a public URL.
    #[serde(
        rename = "callbackUrl",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub callback_url: Option<String>,
    /// An array of available shipping carrier services
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub services: Vec<ShippingCarrierServiceDto>,
    /// The seller can choose multiple services while creating shipping rates if this is true.
    #[serde(
        rename = "allowsMultipleServiceSelection",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub allows_multiple_service_selection: Option<bool>,
}

/// `UpdateShippingCarrierResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateShippingCarrierResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping carrier data
    /// Required by the API.
    pub data: ShippingCarrierSchema,
}

/// `UpdateShippingRateDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateShippingRateDto {
    /// Location Id or Agency Id
    #[serde(rename = "altId", default, skip_serializing_if = "Option::is_none")]
    pub alt_id: Option<String>,
    /// Allowed values: `location`.
    #[serde(rename = "altType", default, skip_serializing_if = "Option::is_none")]
    pub alt_type: Option<String>,
    /// Name of the shipping zone
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Delivery description
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// The currency of the amount of the rate / handling fee
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    /// The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee
    /// if it is a carrier rate (it will add to the carrier rate).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    /// Type of condition to provide the conditional pricing
    /// Allowed values: `none`, `price`, `weight`.
    #[serde(
        rename = "conditionType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub condition_type: Option<String>,
    /// Minimum condition for applying this price. set 0 or null if there is no minimum
    #[serde(
        rename = "minCondition",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub min_condition: Option<f64>,
    /// Maximum condition for applying this price. set 0 or null if there is no maximum
    #[serde(
        rename = "maxCondition",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub max_condition: Option<f64>,
    /// is this a carrier rate
    #[serde(
        rename = "isCarrierRate",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_carrier_rate: Option<bool>,
    /// Shipping carrier id
    #[serde(
        rename = "shippingCarrierId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub shipping_carrier_id: Option<String>,
    /// Percentage of rate fee if it is a carrier rate.
    #[serde(
        rename = "percentageOfRateFee",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub percentage_of_rate_fee: Option<f64>,
    /// An array of items
    #[serde(
        rename = "shippingCarrierServices",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub shipping_carrier_services: Vec<ShippingCarrierServiceDto>,
}

/// `UpdateShippingRateResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateShippingRateResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping zone data
    /// Required by the API.
    pub data: ShippingRateSchema,
}

/// `UpdateShippingZoneDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateShippingZoneDto {
    /// Location Id or Agency Id
    #[serde(rename = "altId", default, skip_serializing_if = "Option::is_none")]
    pub alt_id: Option<String>,
    /// Allowed values: `location`.
    #[serde(rename = "altType", default, skip_serializing_if = "Option::is_none")]
    pub alt_type: Option<String>,
    /// Name of the shipping zone
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// List of countries that are available
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub countries: Vec<ShippingZoneCountryDto>,
}

/// `UpdateShippingZoneResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateShippingZoneResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// Success message
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub message: Option<String>,
    /// Shipping zone data
    /// Required by the API.
    pub data: ShippingZoneSchema,
}