ghl_models/v2/

payments.rs

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

/// `AmountSummary` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct AmountSummary {
    /// Order sub-total value.
    /// Required by the API.
    pub subtotal: f64,
    /// Discount value on order.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub discount: Option<f64>,
}

/// `ApplyToFuturePaymentsConfig` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ApplyToFuturePaymentsConfig {
    /// Type of the config
    /// Allowed values: `forever`, `fixed`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Duration the coupon to be applied in a subscription
    /// Required by the API.
    pub duration: f64,
    /// Type of the duration
    /// Allowed values: `months`.
    /// Required by the API.
    #[serde(rename = "durationType")]
    pub duration_type: String,
}

/// `ApplyToFuturePaymentsConfigDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ApplyToFuturePaymentsConfigDto {
    /// Type of future payments configuration
    /// Allowed values: `forever`, `fixed`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Duration value for fixed type configurations
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub duration: Option<f64>,
    /// Duration type for fixed configurations (e.g. months)
    #[serde(
        rename = "durationType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub duration_type: Option<String>,
}

/// `CardDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CardDto {
    /// Allowed values: `visa`, `mastercard`, `other`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// Last 4 digit of the card
    /// Required by the API.
    pub last4: String,
}

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

/// `ConnectCustomProvidersConfigDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ConnectCustomProvidersConfigDto {
    /// Live config containing api-key and publishable key for live payments
    /// Required by the API.
    pub live: CustomProviderKeys,
    /// Test config containing api-key and publishable-key for test payments
    /// Required by the API.
    pub test: CustomProviderKeys,
}

/// `ConnectCustomProvidersResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ConnectCustomProvidersResponseSchema {
    /// The name of the custom provider
    /// Required by the API.
    pub name: String,
    /// Description of payment gateway. Shown on the payments integrations page as subtext
    /// Required by the API.
    pub description: String,
    /// This url will be loaded in iFrame to start a payment session.
    /// Required by the API.
    #[serde(rename = "paymentsUrl")]
    pub payments_url: String,
    /// The url used for querying payments related events. Ex. verify, refund, subscription etc.
    /// Required by the API.
    #[serde(rename = "queryUrl")]
    pub query_url: String,
    /// Public image url for logo of the payment gateway displayed on the payments integrations
    /// page.
    /// Required by the API.
    #[serde(rename = "imageUrl")]
    pub image_url: String,
    /// The unique identifier for the custom provider.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Location id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// The application id of marketplace
    /// Required by the API.
    #[serde(rename = "marketplaceAppId")]
    pub marketplace_app_id: String,
    /// Payment provider details.
    #[serde(
        rename = "paymentProvider",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_provider: Option<serde_json::Value>,
    /// Whether the config is deleted or not. true represents config is deleted
    /// Required by the API.
    pub deleted: bool,
    /// The creation timestamp of the custom provider.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The last update timestamp of the custom provider.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Trace id of the custom provider.
    #[serde(rename = "traceId", default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
}

/// `CouponDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CouponDto {
    /// Unique MongoDB identifier for the coupon
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Number of times the coupon has been used
    /// Required by the API.
    #[serde(rename = "usageCount")]
    pub usage_count: f64,
    /// Maximum number of times a customer can use this coupon (0 for unlimited)
    /// Required by the API.
    #[serde(rename = "limitPerCustomer")]
    pub limit_per_customer: f64,
    /// Location Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Type of entity
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Display name of the coupon
    /// Required by the API.
    pub name: String,
    /// Redemption code for the coupon
    /// Required by the API.
    pub code: String,
    /// Type of discount (percentage or amount)
    /// Allowed values: `percentage`, `amount`.
    /// Required by the API.
    #[serde(rename = "discountType")]
    pub discount_type: String,
    /// Value of the discount (percentage or fixed amount)
    /// Required by the API.
    #[serde(rename = "discountValue")]
    pub discount_value: f64,
    /// Current status of the coupon
    /// Allowed values: `scheduled`, `active`, `expired`.
    /// Required by the API.
    pub status: String,
    /// Date when the coupon becomes active
    /// Required by the API.
    #[serde(rename = "startDate")]
    pub start_date: String,
    /// End date when the coupon expires
    #[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
    pub end_date: Option<String>,
    /// Indicates if the coupon applies to future recurring payments
    /// Required by the API.
    #[serde(rename = "applyToFuturePayments")]
    pub apply_to_future_payments: bool,
    /// Configuration for how the coupon applies to future payments
    /// Required by the API.
    #[serde(rename = "applyToFuturePaymentsConfig")]
    pub apply_to_future_payments_config: ApplyToFuturePaymentsConfigDto,
    /// User ID associated with the coupon (if applicable)
    #[serde(rename = "userId", default, skip_serializing_if = "Option::is_none")]
    pub user_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,
}

/// `CreateCouponParams` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateCouponParams {
    /// Location Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Alt Type
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Coupon Name
    /// Required by the API.
    pub name: String,
    /// Coupon Code
    /// Required by the API.
    pub code: String,
    /// Discount Type
    /// Allowed values: `percentage`, `amount`.
    /// Required by the API.
    #[serde(rename = "discountType")]
    pub discount_type: String,
    /// Discount Value
    /// Required by the API.
    #[serde(rename = "discountValue")]
    pub discount_value: f64,
    /// Start date in YYYY-MM-DDTHH:mm:ssZ format
    /// Required by the API.
    #[serde(rename = "startDate")]
    pub start_date: String,
    /// End date in YYYY-MM-DDTHH:mm:ssZ format
    #[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
    pub end_date: Option<String>,
    /// Max number of times coupon can be used
    #[serde(
        rename = "usageLimit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub usage_limit: Option<f64>,
    /// Product Ids
    #[serde(rename = "productIds", default, skip_serializing_if = "Vec::is_empty")]
    pub product_ids: Vec<String>,
    /// Is Coupon applicable on upcoming subscription transactions
    #[serde(
        rename = "applyToFuturePayments",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub apply_to_future_payments: Option<bool>,
    /// If coupon is applicable on upcoming subscription transactions, how many months should it
    /// be applicable for a subscription
    #[serde(
        rename = "applyToFuturePaymentsConfig",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub apply_to_future_payments_config: Option<ApplyToFuturePaymentsConfig>,
    /// Limits whether a coupon can be redeemed only once per customer.
    #[serde(
        rename = "limitPerCustomer",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub limit_per_customer: Option<bool>,
}

/// `CreateCouponResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateCouponResponseDto {
    /// Unique MongoDB identifier for the coupon
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Number of times the coupon has been used
    /// Required by the API.
    #[serde(rename = "usageCount")]
    pub usage_count: f64,
    /// Maximum number of times a customer can use this coupon (0 for unlimited)
    /// Required by the API.
    #[serde(rename = "limitPerCustomer")]
    pub limit_per_customer: f64,
    /// Location Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Type of entity
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Display name of the coupon
    /// Required by the API.
    pub name: String,
    /// Redemption code for the coupon
    /// Required by the API.
    pub code: String,
    /// Type of discount (percentage or amount)
    /// Allowed values: `percentage`, `amount`.
    /// Required by the API.
    #[serde(rename = "discountType")]
    pub discount_type: String,
    /// Value of the discount (percentage or fixed amount)
    /// Required by the API.
    #[serde(rename = "discountValue")]
    pub discount_value: f64,
    /// Current status of the coupon
    /// Allowed values: `scheduled`, `active`, `expired`.
    /// Required by the API.
    pub status: String,
    /// Date when the coupon becomes active
    /// Required by the API.
    #[serde(rename = "startDate")]
    pub start_date: String,
    /// End date when the coupon expires
    #[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
    pub end_date: Option<String>,
    /// Indicates if the coupon applies to future recurring payments
    /// Required by the API.
    #[serde(rename = "applyToFuturePayments")]
    pub apply_to_future_payments: bool,
    /// Configuration for how the coupon applies to future payments
    /// Required by the API.
    #[serde(rename = "applyToFuturePaymentsConfig")]
    pub apply_to_future_payments_config: ApplyToFuturePaymentsConfigDto,
    /// User ID associated with the coupon (if applicable)
    #[serde(rename = "userId", default, skip_serializing_if = "Option::is_none")]
    pub user_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,
    /// Unique identifier for tracing this API request
    /// Required by the API.
    #[serde(rename = "traceId")]
    pub trace_id: String,
}

/// `CreateCustomProvidersDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateCustomProvidersDto {
    /// The name of the custom provider
    /// Required by the API.
    pub name: String,
    /// Description of payment gateway. Shown on the payments integrations page as subtext
    /// Required by the API.
    pub description: String,
    /// This url will be loaded in iFrame to start a payment session.
    /// Required by the API.
    #[serde(rename = "paymentsUrl")]
    pub payments_url: String,
    /// The url used for querying payments related events. Ex. verify, refund, subscription etc.
    /// Required by the API.
    #[serde(rename = "queryUrl")]
    pub query_url: String,
    /// Public image url for logo of the payment gateway displayed on the payments integrations
    /// page.
    /// Required by the API.
    #[serde(rename = "imageUrl")]
    pub image_url: String,
    /// Whether the config supports subscription schedule or not. true represents config
    /// supports subscription schedule
    /// Required by the API.
    #[serde(rename = "supportsSubscriptionSchedule")]
    pub supports_subscription_schedule: bool,
}

/// `CreateCustomProvidersResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateCustomProvidersResponseSchema {
    /// The name of the custom provider
    /// Required by the API.
    pub name: String,
    /// Description of payment gateway. Shown on the payments integrations page as subtext
    /// Required by the API.
    pub description: String,
    /// This url will be loaded in iFrame to start a payment session.
    /// Required by the API.
    #[serde(rename = "paymentsUrl")]
    pub payments_url: String,
    /// The url used for querying payments related events. Ex. verify, refund, subscription etc.
    /// Required by the API.
    #[serde(rename = "queryUrl")]
    pub query_url: String,
    /// Public image url for logo of the payment gateway displayed on the payments integrations
    /// page.
    /// Required by the API.
    #[serde(rename = "imageUrl")]
    pub image_url: String,
    /// The unique identifier for the custom provider.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Location id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// The application id of marketplace
    /// Required by the API.
    #[serde(rename = "marketplaceAppId")]
    pub marketplace_app_id: String,
    /// Payment provider details.
    #[serde(
        rename = "paymentProvider",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_provider: Option<serde_json::Value>,
    /// Whether the config is deleted or not. true represents config is deleted
    /// Required by the API.
    pub deleted: bool,
    /// The creation timestamp of the custom provider.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The last update timestamp of the custom provider.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Trace id of the custom provider.
    #[serde(rename = "traceId", default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
}

/// `CreateFulfillmentDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateFulfillmentDto {
    /// 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,
    /// Fulfillment tracking information
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub trackings: Vec<FulfillmentTracking>,
    /// Fulfilled items
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub items: Vec<FulfillmentItems>,
    /// Need to send a notification to customer
    /// Required by the API.
    #[serde(rename = "notifyCustomer")]
    pub notify_customer: bool,
}

/// `CreateFulfillmentResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateFulfillmentResponseDto {
    /// Status of api action
    /// Required by the API.
    pub status: bool,
    /// fulfillment data
    /// Required by the API.
    pub data: FulfillmentSchema,
}

/// `CreateWhiteLabelIntegrationProviderDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateWhiteLabelIntegrationProviderDto {
    /// location Id / company Id based on altType
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Alt Type
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// A unique name given to the integration provider, uniqueName must start and end with a
    /// character. Only lowercase characters and hyphens (-) are supported
    /// Required by the API.
    #[serde(rename = "uniqueName")]
    pub unique_name: String,
    /// The title or name of the integration provider.
    /// Required by the API.
    pub title: String,
    /// The type of payment provider associated with the integration provider.
    /// Allowed values: `authorize-net`, `nmi`.
    /// Required by the API.
    pub provider: String,
    /// A brief description providing additional information about the integration provider.
    /// Required by the API.
    pub description: String,
    /// The URL to an image representing the integration provider. The imageUrl should start
    /// with "https://" and ensure that this URL is publicly accessible.
    /// Required by the API.
    #[serde(rename = "imageUrl")]
    pub image_url: String,
}

/// `CreateWhitelabelIntegrationResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CreateWhitelabelIntegrationResponseDto {
    /// The unique identifier of the integration provider.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// The altId / locationId of the integration provider.
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// The altType of the integration provider.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// The title or name of the integration provider.
    /// Required by the API.
    pub title: String,
    /// The route name associated with the integration provider.
    /// Required by the API.
    pub route: String,
    /// The payment provider associated with the integration provider.
    /// Required by the API.
    pub provider: String,
    /// A brief description providing additional information about the integration provider.
    /// Required by the API.
    pub description: String,
    /// The URL to an image representing the integration provider.
    /// Required by the API.
    #[serde(rename = "imageUrl")]
    pub image_url: String,
    /// The timestamp when the integration provider was created.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The timestamp when the integration provider was last updated.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

/// `CustomProviderKeys` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomProviderKeys {
    /// Api-key for custom payment provider config
    /// Required by the API.
    #[serde(rename = "apiKey")]
    pub api_key: String,
    /// Publishable-key for custom payment provider config
    /// Required by the API.
    #[serde(rename = "publishableKey")]
    pub publishable_key: String,
}

/// `CustomRRuleOptionsDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct CustomRRuleOptionsDto {
    /// Allowed values: `yearly`, `monthly`, `weekly`, `daily`, `hourly`, `minutely`,
    /// `secondly`.
    /// Required by the API.
    #[serde(rename = "intervalType")]
    pub interval_type: String,
    /// Required by the API.
    pub interval: f64,
    /// Start date in YYYY-MM-DD format
    /// Required by the API.
    #[serde(rename = "startDate")]
    pub start_date: String,
    /// Start time in HH:mm:ss format
    #[serde(rename = "startTime", default, skip_serializing_if = "Option::is_none")]
    pub start_time: Option<String>,
    /// End date in YYYY-MM-DD format
    #[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
    pub end_date: Option<String>,
    /// End time in HH:mm:ss format
    #[serde(rename = "endTime", default, skip_serializing_if = "Option::is_none")]
    pub end_time: Option<String>,
    /// -1, 1, 2, 3, ..., 27, 28
    #[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, 1, 2, 3, 4
    #[serde(rename = "numOfWeek", default, skip_serializing_if = "Option::is_none")]
    pub num_of_week: Option<f64>,
    /// Allowed values: `jan`, `feb`, `mar`, `apr`, `may`, `jun`, `jul`, `aug`, `sep`, `oct`,
    /// `nov`, `dec`.
    #[serde(
        rename = "monthOfYear",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub month_of_year: Option<String>,
    /// Max number of task executions
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub count: Option<f64>,
    /// Execute task number of days before
    #[serde(
        rename = "daysBefore",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub days_before: Option<f64>,
}

/// `DefaultPriceResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DefaultPriceResponseDto {
    /// The unique identifier for the price.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// An array of membership offers associated with the price.
    #[serde(
        rename = "membershipOffers",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub membership_offers: Vec<MembershipOfferDto>,
    /// An array of variant option IDs associated with the price.
    #[serde(
        rename = "variantOptionIds",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub variant_option_ids: Vec<String>,
    /// The unique identifier for the location.
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
    /// The unique identifier for the associated product.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub product: Option<String>,
    /// The unique identifier for the user.
    #[serde(rename = "userId", default, skip_serializing_if = "Option::is_none")]
    pub user_id: Option<String>,
    /// The name of the price.
    /// Required by the API.
    pub name: String,
    /// The type of the price (e.g., one_time).
    /// Allowed values: `one_time`, `recurring`.
    /// Required by the API.
    #[serde(rename = "type")]
    pub type_: String,
    /// The currency code for the price.
    /// Required by the API.
    pub currency: String,
    /// The amount of the price.
    /// Required by the API.
    pub amount: f64,
    /// The recurring details of the price (if type is recurring).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub recurring: Option<RecurringDto>,
    /// The creation timestamp of the price.
    /// Format: date-time (ISO-8601 string).
    #[serde(rename = "createdAt", default, skip_serializing_if = "Option::is_none")]
    pub created_at: Option<String>,
    /// The last update timestamp of the price.
    /// Format: date-time (ISO-8601 string).
    #[serde(rename = "updatedAt", default, skip_serializing_if = "Option::is_none")]
    pub updated_at: Option<String>,
    /// The compare-at price for comparison purposes.
    #[serde(
        rename = "compareAtPrice",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub compare_at_price: Option<f64>,
    /// Indicates whether inventory tracking is enabled.
    #[serde(
        rename = "trackInventory",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub track_inventory: Option<bool>,
    /// Available inventory stock quantity
    #[serde(
        rename = "availableQuantity",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub available_quantity: Option<f64>,
    /// Continue selling when out of stock
    #[serde(
        rename = "allowOutOfStockPurchases",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub allow_out_of_stock_purchases: Option<bool>,
}

/// `DefaultProductResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DefaultProductResponseDto {
    /// The unique identifier for the product.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// product description
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub description: Option<String>,
    /// An array of variants for the product.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub variants: Vec<ProductVariantDto>,
    /// The unique identifier for the location.
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// The name of the product.
    /// Required by the API.
    pub name: String,
    /// The type of the product (e.g., PHYSICAL).
    /// Required by the API.
    #[serde(rename = "productType")]
    pub product_type: String,
    /// Indicates whether the product is available in-store.
    #[serde(
        rename = "availableInStore",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub available_in_store: Option<bool>,
    /// The creation timestamp of the product.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The last update timestamp of the product.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// The statement descriptor for the product.
    #[serde(
        rename = "statementDescriptor",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub statement_descriptor: Option<String>,
    /// The URL for the product image.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub image: Option<String>,
    /// An array of category Ids for the product
    #[serde(
        rename = "collectionIds",
        default,
        skip_serializing_if = "Vec::is_empty"
    )]
    pub collection_ids: Vec<String>,
    /// The field indicates whether taxes are enabled for the product or not.
    #[serde(
        rename = "isTaxesEnabled",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_taxes_enabled: Option<bool>,
    /// An array of ids of Taxes attached to the Product. If the expand query includes tax, the
    /// taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for
    /// additional details.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub taxes: Vec<String>,
    /// Tax category ID for Automatic taxes calculation.
    #[serde(
        rename = "automaticTaxCategoryId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub automatic_tax_category_id: Option<String>,
    /// The Product label details
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub label: Option<ProductLabelDto>,
    /// The slug of the product by which the product will be navigated
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub slug: Option<String>,
}

/// `DeleteCouponParams` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteCouponParams {
    /// Location Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Alt Type
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Coupon Id
    /// Required by the API.
    pub id: String,
}

/// `DeleteCouponResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteCouponResponseDto {
    /// Indicates whether the delete was successful
    /// Required by the API.
    pub success: bool,
    /// Unique identifier for tracing this API request
    /// Required by the API.
    #[serde(rename = "traceId")]
    pub trace_id: String,
}

/// `DeleteCustomProvidersConfigDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteCustomProvidersConfigDto {
    /// Whether the config is for test mode or live mode. true represents config is for live
    /// payments
    /// Required by the API.
    #[serde(rename = "liveMode")]
    pub live_mode: bool,
}

/// `DeleteCustomProvidersResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DeleteCustomProvidersResponseSchema {
    /// Whether the custom provider config is disconnect or not. true represents config is
    /// disconnect
    /// Required by the API.
    pub success: bool,
}

/// `DisconnectCustomProvidersResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct DisconnectCustomProvidersResponseSchema {
    /// Whether the custom provider config is disconnect or not. true represents config is
    /// disconnect
    /// Required by the API.
    pub success: bool,
}

/// `FulfilledItem` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FulfilledItem {
    /// The id of product price
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Name
    /// Required by the API.
    pub name: String,
    /// Product details
    /// Required by the API.
    pub product: DefaultProductResponseDto,
    /// Price details
    /// Required by the API.
    pub price: DefaultPriceResponseDto,
    /// The no of quantity of the current fulfilled item
    /// Required by the API.
    pub qty: f64,
}

/// `FulfillmentItems` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FulfillmentItems {
    /// The id of product price
    /// Required by the API.
    #[serde(rename = "priceId")]
    pub price_id: String,
    /// The no of quantity of the item
    /// Required by the API.
    pub qty: f64,
}

/// `FulfillmentSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FulfillmentSchema {
    /// 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,
    /// Fulfillment tracking information
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub trackings: Vec<FulfillmentTracking>,
    /// The unique identifier for the fulfillment item.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Fulfilled items
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub items: Vec<FulfilledItem>,
    /// 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,
}

/// `FulfillmentTracking` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct FulfillmentTracking {
    /// Tracking number provided by the shipping carrier
    #[serde(
        rename = "trackingNumber",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub tracking_number: Option<String>,
    /// Shipping carrier name
    #[serde(
        rename = "shippingCarrier",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub shipping_carrier: Option<String>,
    /// Tracking URL
    #[serde(
        rename = "trackingUrl",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub tracking_url: Option<String>,
}

/// `GetCustomProvidersResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetCustomProvidersResponseSchema {
    /// The name of the custom provider
    /// Required by the API.
    pub name: String,
    /// Description of payment gateway. Shown on the payments integrations page as subtext
    /// Required by the API.
    pub description: String,
    /// This url will be loaded in iFrame to start a payment session.
    /// Required by the API.
    #[serde(rename = "paymentsUrl")]
    pub payments_url: String,
    /// The url used for querying payments related events. Ex. verify, refund, subscription etc.
    /// Required by the API.
    #[serde(rename = "queryUrl")]
    pub query_url: String,
    /// Public image url for logo of the payment gateway displayed on the payments integrations
    /// page.
    /// Required by the API.
    #[serde(rename = "imageUrl")]
    pub image_url: String,
    /// The unique identifier for the custom provider.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// Location id
    /// Required by the API.
    #[serde(rename = "locationId")]
    pub location_id: String,
    /// The application id of marketplace
    /// Required by the API.
    #[serde(rename = "marketplaceAppId")]
    pub marketplace_app_id: String,
    /// Payment provider details.
    #[serde(
        rename = "paymentProvider",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_provider: Option<serde_json::Value>,
    /// Whether the config is deleted or not. true represents config is deleted
    /// Required by the API.
    pub deleted: bool,
    /// The creation timestamp of the custom provider.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The last update timestamp of the custom provider.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Trace id of the custom provider.
    #[serde(rename = "traceId", default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
}

/// `GetOrderResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetOrderResponseSchema {
    /// The unique identifier for the order.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// AltId is the unique identifier eg: location id.
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// AltType is the type of identifier.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Contact id corresponding to the order.
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// Currency in which order was created.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    /// Order value.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    /// The status of the order (e.g., completed).
    /// Required by the API.
    pub status: String,
    /// Order is in live / test mode.
    #[serde(rename = "liveMode", default, skip_serializing_if = "Option::is_none")]
    pub live_mode: Option<bool>,
    /// The creation timestamp of the order.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The last update timestamp of the order.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Fulfillment status of the order.
    #[serde(
        rename = "fulfillmentStatus",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub fulfillment_status: Option<String>,
    /// Contact details of the order.
    #[serde(
        rename = "contactSnapshot",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_snapshot: Option<serde_json::Value>,
    /// Amount details of the order.
    #[serde(
        rename = "amountSummary",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub amount_summary: Option<AmountSummary>,
    /// Source details of the order.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub source: Option<OrderSource>,
    /// Item details of the order.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub items: Vec<String>,
    /// Coupon details of the order.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub coupon: Option<serde_json::Value>,
    /// Tracking id of the order.
    #[serde(
        rename = "trackingId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub tracking_id: Option<String>,
    /// Fingerprint id of the order.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub fingerprint: Option<String>,
    /// Meta details of the order.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub meta: Option<serde_json::Value>,
    /// Is test order.
    #[serde(
        rename = "markAsTest",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub mark_as_test: Option<bool>,
    /// Trace id of the order.
    #[serde(rename = "traceId", default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
    /// Automatic taxes applied for the Order
    #[serde(
        rename = "automaticTaxesCalculated",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub automatic_taxes_calculated: Option<bool>,
    /// Provider name for automatic tax calculation
    #[serde(
        rename = "taxCalculationProvider",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub tax_calculation_provider: Option<serde_json::Value>,
    /// User ID who created the order.
    #[serde(rename = "createdBy", default, skip_serializing_if = "Option::is_none")]
    pub created_by: Option<String>,
}

/// `GetSubscriptionResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetSubscriptionResponseSchema {
    /// The unique identifier for the subscription.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// AltType is the type of identifier.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: serde_json::Value,
    /// AltId is the unique identifier eg: location id.
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Contact id corresponding to the subscription.
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// Contact details of the subscriber.
    #[serde(
        rename = "contactSnapshot",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_snapshot: Option<serde_json::Value>,
    /// Coupon details of the subscription.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub coupon: Option<serde_json::Value>,
    /// Currency in which subscription was made.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    /// Subscription value.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    /// Subscription status.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<serde_json::Value>,
    /// Subscription is in live / test mode.
    #[serde(rename = "liveMode", default, skip_serializing_if = "Option::is_none")]
    pub live_mode: Option<bool>,
    /// Entity type of subscription (eg: order).
    #[serde(
        rename = "entityType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_type: Option<String>,
    /// Entity id for the subscription. e.g: order id
    #[serde(rename = "entityId", default, skip_serializing_if = "Option::is_none")]
    pub entity_id: Option<String>,
    /// Entity source details for the subscription.
    #[serde(
        rename = "entitySource",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_source: Option<OrderSource>,
    /// Subscription id for subscription.
    #[serde(
        rename = "subscriptionId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub subscription_id: Option<String>,
    /// Snapshot of subscription.
    #[serde(
        rename = "subscriptionSnapshot",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub subscription_snapshot: Option<serde_json::Value>,
    /// Payment provider details for the subscription.
    #[serde(
        rename = "paymentProvider",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_provider: Option<serde_json::Value>,
    /// Ip address from where subscription was initiated.
    #[serde(rename = "ipAddress", default, skip_serializing_if = "Option::is_none")]
    pub ip_address: Option<String>,
    /// The creation timestamp of the subscription.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The last update timestamp of the subscription.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Meta details of the subscription.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub meta: Option<serde_json::Value>,
    /// Is test subscription.
    #[serde(
        rename = "markAsTest",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub mark_as_test: Option<bool>,
    /// Scedule details for the subscription.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub schedule: Option<ScheduleOptionsDto>,
    /// Auto payment details of the subscription.
    #[serde(
        rename = "autoPayment",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub auto_payment: Option<serde_json::Value>,
    /// Recurring product details of the subscription.
    #[serde(
        rename = "recurringProduct",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub recurring_product: Option<serde_json::Value>,
    /// Cancellation timestamp of the subscription.
    /// Format: date-time (ISO-8601 string).
    #[serde(
        rename = "canceledAt",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub canceled_at: Option<String>,
    /// User id who cancelled the subscription.
    #[serde(
        rename = "canceledBy",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub canceled_by: Option<String>,
    /// Trace id of the subscription.
    #[serde(rename = "traceId", default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
    /// User ID who created the subscription.
    #[serde(rename = "createdBy", default, skip_serializing_if = "Option::is_none")]
    pub created_by: Option<String>,
}

/// `GetTxnResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct GetTxnResponseSchema {
    /// The unique identifier for the transaction.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// AltType is the type of identifier.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// AltId is the unique identifier eg: location id.
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Contact id corresponding to the transaction.
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// Contact details of the transaction.
    #[serde(
        rename = "contactSnapshot",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_snapshot: Option<serde_json::Value>,
    /// Currency in which transaction was made.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    /// Transaction value.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    /// Transaction status.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub status: Option<serde_json::Value>,
    /// Transaction is in live / test mode.
    #[serde(rename = "liveMode", default, skip_serializing_if = "Option::is_none")]
    pub live_mode: Option<bool>,
    /// The creation timestamp of the transaction.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The last update timestamp of the transaction.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Entity type of transaction (eg: order).
    #[serde(
        rename = "entityType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_type: Option<String>,
    /// Entity id for the transaction. e.g: order id
    #[serde(rename = "entityId", default, skip_serializing_if = "Option::is_none")]
    pub entity_id: Option<String>,
    /// Entity source details for the transaction.
    #[serde(
        rename = "entitySource",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_source: Option<OrderSource>,
    /// Charge id for transaction.
    #[serde(rename = "chargeId", default, skip_serializing_if = "Option::is_none")]
    pub charge_id: Option<String>,
    /// Charge snapshot of transaction.
    #[serde(
        rename = "chargeSnapshot",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub charge_snapshot: Option<serde_json::Value>,
    /// Invoice id for the transaction.
    #[serde(rename = "invoiceId", default, skip_serializing_if = "Option::is_none")]
    pub invoice_id: Option<String>,
    /// Subscription id for transaction.
    #[serde(
        rename = "subscriptionId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub subscription_id: Option<String>,
    /// Payment provider details of the transaction.
    #[serde(
        rename = "paymentProvider",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_provider: Option<serde_json::Value>,
    /// Ip address from where transaction was initiated.
    #[serde(rename = "ipAddress", default, skip_serializing_if = "Option::is_none")]
    pub ip_address: Option<String>,
    /// Meta details of the transaction.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub meta: Option<serde_json::Value>,
    /// Is test transaction.
    #[serde(
        rename = "markAsTest",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub mark_as_test: Option<bool>,
    /// Is parent transaction.
    #[serde(rename = "isParent", default, skip_serializing_if = "Option::is_none")]
    pub is_parent: Option<bool>,
    /// Transaction amount refunded.
    #[serde(
        rename = "amountRefunded",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub amount_refunded: Option<f64>,
    /// Receipt id for transaction.
    #[serde(rename = "receiptId", default, skip_serializing_if = "Option::is_none")]
    pub receipt_id: Option<String>,
    /// Is transaction qbo synced.
    #[serde(rename = "qboSynced", default, skip_serializing_if = "Option::is_none")]
    pub qbo_synced: Option<bool>,
    /// Qbo details of the transaction.
    #[serde(
        rename = "qboResponse",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub qbo_response: Option<serde_json::Value>,
    /// Trace id of the transaction.
    #[serde(rename = "traceId", default, skip_serializing_if = "Option::is_none")]
    pub trace_id: Option<String>,
    /// ID of the contact that was merged from.
    #[serde(
        rename = "mergedFromContactId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub merged_from_contact_id: Option<String>,
    /// User ID who created the transaction.
    #[serde(rename = "createdBy", default, skip_serializing_if = "Option::is_none")]
    pub created_by: Option<String>,
}

/// `IntegrationProviderSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct IntegrationProviderSchema {
    /// The unique identifier of the integration provider.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// The altId / locationId of the integration provider.
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// The altType of the integration provider.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// The title or name of the integration provider.
    /// Required by the API.
    pub title: String,
    /// The route name associated with the integration provider.
    /// Required by the API.
    pub route: String,
    /// The payment provider associated with the integration provider.
    /// Required by the API.
    pub provider: String,
    /// A brief description providing additional information about the integration provider.
    /// Required by the API.
    pub description: String,
    /// The URL to an image representing the integration provider.
    /// Required by the API.
    #[serde(rename = "imageUrl")]
    pub image_url: String,
    /// The timestamp when the integration provider was created.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The timestamp when the integration provider was last updated.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
}

/// `ListCouponsResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListCouponsResponseDto {
    /// Array of coupon objects
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<CouponDto>,
    /// Total number of coupons matching the query criteria
    /// Required by the API.
    #[serde(rename = "totalCount")]
    pub total_count: f64,
    /// Unique identifier for tracing this API request
    /// Required by the API.
    #[serde(rename = "traceId")]
    pub trace_id: String,
}

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

/// `ListOrdersResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListOrdersResponseDto {
    /// An array of orders
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<OrderResponseSchema>,
    /// total orders count
    /// Required by the API.
    #[serde(rename = "totalCount")]
    pub total_count: f64,
}

/// `ListSubscriptionResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListSubscriptionResponseDto {
    /// An array of subscriptions
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<SubscriptionResponseSchema>,
    /// total subscriptions count
    /// Required by the API.
    #[serde(rename = "totalCount")]
    pub total_count: f64,
}

/// `ListTxnsResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListTxnsResponseDto {
    /// An array of transactions
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub data: Vec<TxnResponseSchema>,
    /// total transactions count
    /// Required by the API.
    #[serde(rename = "totalCount")]
    pub total_count: f64,
}

/// `ListWhitelabelIntegrationProviderResponseDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ListWhitelabelIntegrationProviderResponseDto {
    /// list of integration provider.
    /// Required by the API.
    pub providers: IntegrationProviderSchema,
}

/// `MembershipOfferDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct MembershipOfferDto {
    /// Membership offer label
    /// Required by the API.
    pub label: String,
    /// Membership offer label
    /// Required by the API.
    pub value: String,
    /// The unique identifier for the membership offer.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
}

/// `OrderResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct OrderResponseSchema {
    /// The unique identifier for the order.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// AltId is the unique identifier eg: location id.
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// AltType is the type of identifier.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Contact id corresponding to the order.
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// Contact name corresponding to the order.
    #[serde(
        rename = "contactName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_name: Option<String>,
    /// Contact email corresponding to the order.
    #[serde(
        rename = "contactEmail",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_email: Option<String>,
    /// Currency in which order was created.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    /// Order value.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    /// Order sub-total value.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub subtotal: Option<f64>,
    /// Discount value on order.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub discount: Option<f64>,
    /// The status of the order (e.g., completed).
    /// Required by the API.
    pub status: String,
    /// Order is in live / test mode.
    #[serde(rename = "liveMode", default, skip_serializing_if = "Option::is_none")]
    pub live_mode: Option<bool>,
    /// Total products in an order.
    #[serde(
        rename = "totalProducts",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub total_products: Option<f64>,
    /// Source type of order (eg: funnel).
    /// Required by the API.
    #[serde(rename = "sourceType")]
    pub source_type: String,
    /// Source name for the order.
    #[serde(
        rename = "sourceName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub source_name: Option<String>,
    /// Source id for the order.
    #[serde(rename = "sourceId", default, skip_serializing_if = "Option::is_none")]
    pub source_id: Option<String>,
    /// Meta content for the source of order.
    #[serde(
        rename = "sourceMeta",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub source_meta: Option<serde_json::Value>,
    /// Coupon code for the order.
    #[serde(
        rename = "couponCode",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub coupon_code: Option<String>,
    /// The creation timestamp of the order.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The last update timestamp of the order.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Source sub-type for the order.
    #[serde(
        rename = "sourceSubType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub source_sub_type: Option<String>,
    /// Fulfillment status of the order.
    #[serde(
        rename = "fulfillmentStatus",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub fulfillment_status: Option<String>,
    /// Total one time products in an order.
    #[serde(
        rename = "onetimeProducts",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub onetime_products: Option<f64>,
    /// Total recurring time products in an order.
    #[serde(
        rename = "recurringProducts",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub recurring_products: Option<f64>,
    /// User ID who created the order.
    #[serde(rename = "createdBy", default, skip_serializing_if = "Option::is_none")]
    pub created_by: Option<String>,
}

/// `OrderSource` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct OrderSource {
    /// 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,
    /// 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>,
    /// Required by the API.
    pub id: String,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub name: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub meta: Option<serde_json::Value>,
}

/// `PostRecordOrderPaymentBody` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct PostRecordOrderPaymentBody {
    /// location Id / company Id based on altType
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Alt Type
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// manual payment method
    /// Allowed values: `cash`, `card`, `cheque`, `bank_transfer`, `other`.
    /// Required by the API.
    pub mode: String,
    /// Details of Card if used for payment
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub card: Option<CardDto>,
    /// Details of the Cheque if used for payment
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub cheque: Option<ChequeDto>,
    /// Any note to be recorded with the transaction
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub notes: Option<String>,
    /// Amount to be paid against the invoice.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    /// Meta data to be recorded with the transaction
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub meta: Option<serde_json::Value>,
    /// Indicates if the order is intended to be a partial payment.
    #[serde(
        rename = "isPartialPayment",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub is_partial_payment: Option<bool>,
}

/// `PostRecordOrderPaymentResponse` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct PostRecordOrderPaymentResponse {
    /// Success status of the request
    /// Required by the API.
    pub success: bool,
}

/// `ProductLabelDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProductLabelDto {
    /// The content for the product label.
    /// Required by the API.
    pub title: String,
    /// Start date in YYYY-MM-DDTHH:mm:ssZ format
    #[serde(rename = "startDate", default, skip_serializing_if = "Option::is_none")]
    pub start_date: Option<String>,
    /// Start date in YYYY-MM-DDTHH:mm:ssZ format
    #[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
    pub end_date: Option<String>,
}

/// `ProductVariantDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProductVariantDto {
    /// A unique identifier for the variant.
    /// Required by the API.
    pub id: String,
    /// The name of the variant.
    /// Required by the API.
    pub name: String,
    /// An array of options for the variant.
    /// Required by the API.
    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub options: Vec<ProductVariantOptionDto>,
}

/// `ProductVariantOptionDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ProductVariantOptionDto {
    /// The unique identifier for the option.
    /// Required by the API.
    pub id: String,
    /// The name of the option.
    /// Required by the API.
    pub name: String,
}

/// `RecurringDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct RecurringDto {
    /// The interval at which the recurring event occurs.
    /// Allowed values: `day`, `month`, `week`, `year`.
    /// Required by the API.
    pub interval: String,
    /// The number of intervals between each occurrence of the event.
    /// Required by the API.
    #[serde(rename = "intervalCount")]
    pub interval_count: f64,
}

/// `ScheduleOptionsDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct ScheduleOptionsDto {
    #[serde(rename = "executeAt", default, skip_serializing_if = "Option::is_none")]
    pub execute_at: Option<String>,
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub rrule: Option<CustomRRuleOptionsDto>,
}

/// `SubscriptionResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct SubscriptionResponseSchema {
    /// The unique identifier for the subscription.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// AltId is the unique identifier eg: location id.
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// AltType is the type of identifier.
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Contact id corresponding to the subscription.
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// Contact name corresponding to the subscription.
    #[serde(
        rename = "contactName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_name: Option<String>,
    /// Contact email corresponding to the subscription.
    #[serde(
        rename = "contactEmail",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_email: Option<String>,
    /// Currency in which subscription occurred.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    /// Subscription value.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    /// The status of the subscription (e.g., succeeded).
    /// Required by the API.
    pub status: serde_json::Value,
    /// Subscription is in live / test mode.
    #[serde(rename = "liveMode", default, skip_serializing_if = "Option::is_none")]
    pub live_mode: Option<bool>,
    /// Entity type of subscription (eg: order).
    #[serde(
        rename = "entityType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_type: Option<String>,
    /// Entity id for the subscription. e.g: order id
    #[serde(rename = "entityId", default, skip_serializing_if = "Option::is_none")]
    pub entity_id: Option<String>,
    /// Entity source type of subscription (eg: funnel).
    /// Required by the API.
    #[serde(rename = "entitySourceType")]
    pub entity_source_type: String,
    /// Entity source name for the subscription.
    #[serde(
        rename = "entitySourceName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_source_name: Option<String>,
    /// Entity source id for the subscription.
    #[serde(
        rename = "entitySourceId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_source_id: Option<String>,
    /// Meta content for the entity source of subscription.
    #[serde(
        rename = "entitySourceMeta",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_source_meta: Option<serde_json::Value>,
    /// Subscription id for subscription.
    #[serde(
        rename = "subscriptionId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub subscription_id: Option<String>,
    /// Snapshot of subscription.
    #[serde(
        rename = "subscriptionSnapshot",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub subscription_snapshot: Option<serde_json::Value>,
    /// Payment provider for subscription.
    #[serde(
        rename = "paymentProviderType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_provider_type: Option<String>,
    /// Payment provider connected account id for subscription.
    #[serde(
        rename = "paymentProviderConnectedAccount",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_provider_connected_account: Option<String>,
    /// Ip address from where subscription was initiated.
    #[serde(rename = "ipAddress", default, skip_serializing_if = "Option::is_none")]
    pub ip_address: Option<String>,
    /// The creation timestamp of the subscription.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The update timestamp of the subscription.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// User ID who created the subscription.
    #[serde(rename = "createdBy", default, skip_serializing_if = "Option::is_none")]
    pub created_by: Option<String>,
}

/// `TxnResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct TxnResponseSchema {
    /// The unique identifier for the transaction.
    /// Required by the API.
    #[serde(rename = "_id")]
    pub id: String,
    /// AltId is the unique identifier eg: location id.
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// AltType is the type of identifier.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Contact id corresponding to the transaction.
    #[serde(rename = "contactId", default, skip_serializing_if = "Option::is_none")]
    pub contact_id: Option<String>,
    /// ID of the contact that was merged from.
    #[serde(
        rename = "mergedFromContactId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub merged_from_contact_id: Option<String>,
    /// Contact name corresponding to the transaction.
    #[serde(
        rename = "contactName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_name: Option<String>,
    /// Contact email corresponding to the transaction.
    #[serde(
        rename = "contactEmail",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub contact_email: Option<String>,
    /// Currency in which transaction occurred.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub currency: Option<String>,
    /// Transaction value.
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub amount: Option<f64>,
    /// The status of the transaction (e.g., succeeded).
    /// Required by the API.
    pub status: serde_json::Value,
    /// Transaction is in live / test mode.
    #[serde(rename = "liveMode", default, skip_serializing_if = "Option::is_none")]
    pub live_mode: Option<bool>,
    /// Entity type of transaction (eg: order).
    #[serde(
        rename = "entityType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_type: Option<String>,
    /// Entity id for the transaction. e.g: order id
    #[serde(rename = "entityId", default, skip_serializing_if = "Option::is_none")]
    pub entity_id: Option<String>,
    /// Entity source type of transaction (eg: funnel).
    /// Required by the API.
    #[serde(rename = "entitySourceType")]
    pub entity_source_type: String,
    /// Entity source sub-type of the transactions.
    #[serde(
        rename = "entitySourceSubType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_source_sub_type: Option<String>,
    /// Entity source name for the transaction.
    #[serde(
        rename = "entitySourceName",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_source_name: Option<String>,
    /// Entity source id for the transaction.
    #[serde(
        rename = "entitySourceId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_source_id: Option<String>,
    /// Meta content for the entity source of transaction.
    #[serde(
        rename = "entitySourceMeta",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub entity_source_meta: Option<serde_json::Value>,
    /// Subscription id for transaction.
    #[serde(
        rename = "subscriptionId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub subscription_id: Option<String>,
    /// Charge id for transaction.
    #[serde(rename = "chargeId", default, skip_serializing_if = "Option::is_none")]
    pub charge_id: Option<String>,
    /// Charge snapshot of transaction.
    #[serde(
        rename = "chargeSnapshot",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub charge_snapshot: Option<serde_json::Value>,
    /// Payment provider for transaction.
    #[serde(
        rename = "paymentProviderType",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_provider_type: Option<String>,
    /// Payment provider account id for transaction.
    #[serde(
        rename = "paymentProviderConnectedAccount",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_provider_connected_account: Option<String>,
    /// Ip address from where transaction was initiated.
    #[serde(rename = "ipAddress", default, skip_serializing_if = "Option::is_none")]
    pub ip_address: Option<String>,
    /// The creation timestamp of the transaction.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "createdAt")]
    pub created_at: String,
    /// The update timestamp of the transaction.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "updatedAt")]
    pub updated_at: String,
    /// Transaction amount refunded.
    #[serde(
        rename = "amountRefunded",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub amount_refunded: Option<f64>,
    /// Transaction payment method details.
    #[serde(
        rename = "paymentMethod",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub payment_method: Option<serde_json::Value>,
    /// The charged timestamp of the transaction.
    /// Format: date-time (ISO-8601 string).
    /// Required by the API.
    #[serde(rename = "fulfilledAt")]
    pub fulfilled_at: String,
    /// User ID who created the transaction.
    #[serde(rename = "createdBy", default, skip_serializing_if = "Option::is_none")]
    pub created_by: Option<String>,
}

/// `UpdateCouponParams` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateCouponParams {
    /// Location Id
    /// Required by the API.
    #[serde(rename = "altId")]
    pub alt_id: String,
    /// Alt Type
    /// Allowed values: `location`.
    /// Required by the API.
    #[serde(rename = "altType")]
    pub alt_type: String,
    /// Coupon Name
    /// Required by the API.
    pub name: String,
    /// Coupon Code
    /// Required by the API.
    pub code: String,
    /// Discount Type
    /// Allowed values: `percentage`, `amount`.
    /// Required by the API.
    #[serde(rename = "discountType")]
    pub discount_type: String,
    /// Discount Value
    /// Required by the API.
    #[serde(rename = "discountValue")]
    pub discount_value: f64,
    /// Start date in YYYY-MM-DDTHH:mm:ssZ format
    /// Required by the API.
    #[serde(rename = "startDate")]
    pub start_date: String,
    /// End date in YYYY-MM-DDTHH:mm:ssZ format
    #[serde(rename = "endDate", default, skip_serializing_if = "Option::is_none")]
    pub end_date: Option<String>,
    /// Max number of times coupon can be used
    #[serde(
        rename = "usageLimit",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub usage_limit: Option<f64>,
    /// Product Ids
    #[serde(rename = "productIds", default, skip_serializing_if = "Vec::is_empty")]
    pub product_ids: Vec<String>,
    /// Is Coupon applicable on upcoming subscription transactions
    #[serde(
        rename = "applyToFuturePayments",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub apply_to_future_payments: Option<bool>,
    /// If coupon is applicable on upcoming subscription transactions, how many months should it
    /// be applicable for a subscription
    #[serde(
        rename = "applyToFuturePaymentsConfig",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub apply_to_future_payments_config: Option<ApplyToFuturePaymentsConfig>,
    /// Limits whether a coupon can be redeemed only once per customer.
    #[serde(
        rename = "limitPerCustomer",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub limit_per_customer: Option<bool>,
    /// Coupon Id
    /// Required by the API.
    pub id: String,
}

/// `UpdateCustomProviderCapabilitiesDto` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateCustomProviderCapabilitiesDto {
    /// Whether the marketplace app supports subscription schedules or not
    /// Required by the API.
    #[serde(rename = "supportsSubscriptionSchedules")]
    pub supports_subscription_schedules: bool,
    /// Company id. Mandatory if locationId is not provided
    #[serde(rename = "companyId", default, skip_serializing_if = "Option::is_none")]
    pub company_id: Option<String>,
    /// Location / Sub-account id. Mandatory if companyId is not provided
    #[serde(
        rename = "locationId",
        default,
        skip_serializing_if = "Option::is_none"
    )]
    pub location_id: Option<String>,
}

/// `UpdateCustomProviderCapabilitiesResponseSchema` from the GoHighLevel OpenAPI spec.
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct UpdateCustomProviderCapabilitiesResponseSchema {
    /// Whether the custom provider capabilities are updated or not. true represents
    /// capabilities are updated
    /// Required by the API.
    pub success: bool,
}