square_api_client/models/
catalog_item_option_value.rs

1//! Model struct for CatalogItemOptionValue type.
2
3use serde::{Deserialize, Serialize};
4
5/// An enumerated value that can link a `CatalogItemVariation` to an item option as one of its item
6/// option values.
7#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
8pub struct CatalogItemOptionValue {
9    /// Unique ID of the associated item option.
10    pub item_option_id: Option<String>,
11    /// Name of this item option value. This is a searchable attribute for use in applicable query
12    /// filters.
13    pub name: Option<String>,
14    /// A human-readable description for the option value. This is a searchable attribute for use in
15    /// applicable query filters.
16    pub description: Option<String>,
17    /// The HTML-supported hex color for the item option (e.g., "#ff8d4e85"). Only displayed if
18    /// `show_colors` is enabled on the parent `ItemOption`. When left unset, `color` defaults to
19    /// white ("#ffffff") when `show_colors` is enabled on the parent `ItemOption`.
20    pub color: Option<String>,
21    /// Determines where this option value appears in a list of option values.
22    pub ordinal: Option<i32>,
23}