ghl-models 0.3.1

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

/// `AgencyPlanResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AgencyPlanResponseDto {
    /// Unique identifier for the plan
    /// Required by the API.
    #[serde(rename = "planId")]
    pub plan_id: String,
    /// Title of the plan
    /// Required by the API.
    pub title: String,
    /// Description of the plan
    /// Required by the API.
    pub description: String,
    /// Array of SaaS products included in the plan
    /// Required by the API.
    #[serde(
        rename = "saasProducts",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub saas_products: Vec<String>,
    /// Array of add-ons included in the plan
    #[serde(rename = "addOns", default, skip_serializing_if = "Vec::is_empty")]
    pub add_ons: Vec<String>,
    /// Level of the plan (0-4)
    /// Required by the API.
    #[serde(rename = "planLevel")]
    pub plan_level: f64,
    /// Trial period in days
    /// Required by the API.
    #[serde(rename = "trialPeriod")]
    pub trial_period: f64,
    /// User limit for the plan
    #[serde(rename = "userLimit", default, skip_serializing_if = "Option::is_none")]
    pub user_limit: Option<f64>,
    /// Contact limit for the plan
    #[serde(
        rename = "contactLimit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_limit: Option<f64>,
    /// Pricing information for the plan
    /// Nested object; raw JSON (see the API docs for its fields).
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub prices: Vec<serde_json::Value>,
    /// Category ID for the plan
    #[serde(
        rename = "categoryId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub category_id: Option<String>,
    /// Snapshot ID for the plan
    #[serde(
        rename = "snapshotId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub snapshot_id: Option<String>,
    /// Product ID for the plan
    #[serde(rename = "productId", default, skip_serializing_if = "Option::is_none")]
    pub product_id: Option<String>,
    /// Indicates if this is a SaaS V2 plan
    /// Required by the API.
    #[serde(rename = "isSaaSV2")]
    pub is_saa_sv2: bool,
    /// Provider location ID
    #[serde(
        rename = "providerLocationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub provider_location_id: Option<String>,
    /// Creation timestamp
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// Last update timestamp
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

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

/// `BulkDisableSaasDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct BulkDisableSaasDto {
    /// Location IDs
    /// Required by the API.
    #[serde(rename = "locationIds", default, skip_serializing_if = "Vec::is_empty")]
    pub location_ids: Vec<String>,
}

/// `BulkDisableSaasResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct BulkDisableSaasResponseDto {
    /// Response data from the bulk disable SaaS operation
    /// Required by the API.
    pub data: serde_json::Value,
}

/// `BulkEnableSaasActionPayloadDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct BulkEnableSaasActionPayloadDto {
    /// Price ID for the SaaS plan
    #[serde(rename = "priceId", default, skip_serializing_if = "Option::is_none")]
    pub price_id: Option<String>,
    /// Stripe account ID
    #[serde(
        rename = "stripeAccountId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub stripe_account_id: Option<String>,
    /// SaaS plan ID
    /// Required by the API.
    #[serde(rename = "saasPlanId")]
    pub saas_plan_id: String,
    /// Provider location ID
    #[serde(
        rename = "providerLocationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub provider_location_id: Option<String>,
}

/// `BulkEnableSaasRequestDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct BulkEnableSaasRequestDto {
    /// Array of location IDs to enable SaaS for
    /// Required by the API.
    #[serde(rename = "locationIds", default, skip_serializing_if = "Vec::is_empty")]
    pub location_ids: Vec<String>,
    /// Indicates if the SaaS is V2
    /// Required by the API.
    #[serde(rename = "isSaaSV2")]
    pub is_saa_sv2: bool,
    /// Action payload for the bulk enable SaaS operation
    /// Required by the API.
    #[serde(rename = "actionPayload")]
    pub action_payload: BulkEnableSaasActionPayloadDto,
}

/// `BulkEnableSaasResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct BulkEnableSaasResponseDto {
    /// Indicates if the bulk enable SaaS operation was successful
    /// Required by the API.
    pub success: bool,
    /// Message indicating the bulk enable SaaS operation
    /// Required by the API.
    pub message: String,
    /// URL for the bulk enable SaaS operation
    #[serde(
        rename = "bulkActionUrl",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub bulk_action_url: Option<String>,
}

/// `EnableSaasDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct EnableSaasDto {
    /// Stripe account id(Required only for SaaS V1)
    #[serde(
        rename = "stripeAccountId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub stripe_account_id: Option<String>,
    /// Name of the stripe customer(Required only for SaaS V1)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Email of the stripe customer(Required only for SaaS V1)
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// Stripe customer id if exists(Required only for SaaS V1)
    #[serde(
        rename = "stripeCustomerId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub stripe_customer_id: Option<String>,
    /// Required by the API.
    #[serde(rename = "companyId")]
    pub company_id: String,
    /// Denotes if it is a saas v2 or v1 sub-account
    /// Required by the API.
    #[serde(rename = "isSaaSV2")]
    pub is_saa_sv2: bool,
    /// Agency subaccount used for payment provider integration(Required Only for SaaS V2)
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// Agency Subaccount ID
    #[serde(
        rename = "providerLocationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub provider_location_id: Option<String>,
    /// Description
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// Required only while pre-configuring saas subscription
    #[serde(
        rename = "saasPlanId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub saas_plan_id: Option<String>,
    /// Required only while pre-configuring saas subscription
    #[serde(rename = "priceId", default, skip_serializing_if = "Option::is_none")]
    pub price_id: Option<String>,
}

/// `EnableSaasResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct EnableSaasResponseDto {
    /// Response data from the enable SaaS operation
    /// Required by the API.
    pub data: serde_json::Value,
}

/// `GetSaasLocationsResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetSaasLocationsResponseDto {
    /// Array of SaaS locations
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub locations: Vec<SaasLocationDto>,
    /// Nested object; raw JSON (see the API docs for its fields).
    /// Required by the API.
    pub pagination: serde_json::Value,
}

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

/// `LocationSubscriptionResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct LocationSubscriptionResponseDto {
    /// Location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Indicates if the SaaS is V2
    /// Required by the API.
    #[serde(rename = "isSaaSV2")]
    pub is_saa_sv2: bool,
    /// Company ID
    /// Required by the API.
    #[serde(rename = "companyId")]
    pub company_id: String,
    /// SaaS mode
    #[serde(rename = "saasMode", default, skip_serializing_if = "Option::is_none")]
    pub saas_mode: Option<String>,
    /// Subscription ID
    #[serde(
        rename = "subscriptionId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub subscription_id: Option<String>,
    /// Customer ID
    #[serde(
        rename = "customerId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub customer_id: Option<String>,
    /// Product ID
    #[serde(rename = "productId", default, skip_serializing_if = "Option::is_none")]
    pub product_id: Option<String>,
    /// Price ID
    #[serde(rename = "priceId", default, skip_serializing_if = "Option::is_none")]
    pub price_id: Option<String>,
    /// SaaS plan ID
    #[serde(
        rename = "saasPlanId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub saas_plan_id: Option<String>,
    /// Subscription status
    #[serde(
        rename = "subscriptionStatus",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub subscription_status: Option<String>,
}

/// `PauseLocationDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct PauseLocationDto {
    /// Paused
    /// Required by the API.
    pub paused: bool,
    /// Company ID
    /// Required by the API.
    #[serde(rename = "companyId")]
    pub company_id: String,
}

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

/// `SaasLocationDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SaasLocationDto {
    /// Location ID
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// Company ID
    /// Required by the API.
    #[serde(rename = "companyId")]
    pub company_id: String,
    /// SaaS mode
    /// Required by the API.
    #[serde(rename = "saasMode")]
    pub saas_mode: String,
    /// Subscription ID
    /// Required by the API.
    #[serde(rename = "subscriptionId")]
    pub subscription_id: String,
    /// Customer ID
    #[serde(
        rename = "customerId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub customer_id: Option<String>,
    /// Name
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    /// Email
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// Provider location ID
    #[serde(
        rename = "providerLocationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub provider_location_id: Option<String>,
    /// Indicates if the SaaS is V2
    #[serde(rename = "isSaaSV2", default, skip_serializing_if = "Option::is_none")]
    pub is_saa_sv2: Option<bool>,
    /// Subscription information
    #[serde(
        rename = "subscriptionInfo",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub subscription_info: Option<serde_json::Value>,
}

/// `SaasPlanResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SaasPlanResponseDto {
    /// Unique identifier for the SaaS plan
    /// Required by the API.
    #[serde(rename = "planId")]
    pub plan_id: String,
    /// Company ID associated with the SaaS plan
    /// Required by the API.
    #[serde(rename = "companyId")]
    pub company_id: String,
    /// Title of the SaaS plan
    /// Required by the API.
    pub title: String,
    /// Description of the SaaS plan
    /// Required by the API.
    pub description: String,
    /// Array of SaaS products included in the plan
    /// Required by the API.
    #[serde(
        rename = "saasProducts",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub saas_products: Vec<String>,
    /// Array of add-ons included in the plan
    #[serde(rename = "addOns", default, skip_serializing_if = "Vec::is_empty")]
    pub add_ons: Vec<String>,
    /// Level of the plan (0-4)
    /// Required by the API.
    #[serde(rename = "planLevel")]
    pub plan_level: f64,
    /// Trial period in days
    /// Required by the API.
    #[serde(rename = "trialPeriod")]
    pub trial_period: f64,
    /// Setup fee for the plan
    #[serde(rename = "setupFee", default, skip_serializing_if = "Option::is_none")]
    pub setup_fee: Option<f64>,
    /// User limit for the plan
    #[serde(rename = "userLimit", default, skip_serializing_if = "Option::is_none")]
    pub user_limit: Option<f64>,
    /// Contact limit for the plan
    #[serde(
        rename = "contactLimit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_limit: Option<f64>,
    /// Prices for the plan
    /// Nested object; raw JSON (see the API docs for its fields).
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub prices: Vec<serde_json::Value>,
    /// Category ID for the plan
    #[serde(
        rename = "categoryId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub category_id: Option<String>,
    /// Snapshot ID for the plan
    #[serde(
        rename = "snapshotId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub snapshot_id: Option<String>,
    /// Provider location ID
    #[serde(
        rename = "providerLocationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub provider_location_id: Option<String>,
    /// Product ID for the plan
    #[serde(rename = "productId", default, skip_serializing_if = "Option::is_none")]
    pub product_id: Option<String>,
    /// Indicates if this is a SaaS V2 plan
    /// Required by the API.
    #[serde(rename = "isSaaSV2")]
    pub is_saa_sv2: bool,
    /// Creation timestamp
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// Last update timestamp
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

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

/// `UpdateRebillingDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateRebillingDto {
    /// The product to update rebilling for
    /// Allowed values: `contentAI`, `workflow_premium_actions`, `workflow_ai`,
    /// `conversationAI`, `EmailNotification`, `whatsApp`, `reviewsAI`, `VERIFIED_CALLER_ID`,
    /// `WALLET_SALES_TAX`, `NOTIFICATION_SMS`, `EmailSmtp`, `EmailVerification`.
    /// Required by the API.
    pub product: String,
    /// Array of location IDs to update rebilling for
    /// Required by the API.
    #[serde(rename = "locationIds", default, skip_serializing_if = "Vec::is_empty")]
    pub location_ids: Vec<String>,
    /// Configuration for rebilling settings
    /// Nested object; raw JSON (see the API docs for its fields).
    /// Required by the API.
    pub config: serde_json::Value,
}

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

/// `UpdateSubscriptionDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateSubscriptionDto {
    /// Subscription ID
    /// Required by the API.
    #[serde(rename = "subscriptionId")]
    pub subscription_id: String,
    /// Customer ID
    /// Required by the API.
    #[serde(rename = "customerId")]
    pub customer_id: String,
    /// Company ID
    /// Required by the API.
    #[serde(rename = "companyId")]
    pub company_id: String,
}