Struct CatalogCustomAttributeDefinition

pub struct CatalogCustomAttributeDefinition {
    pub type: CatalogCustomAttributeDefinitionType,
    pub name: String,
    pub description: Option<String>,
    pub source_application: Option<SourceApplication>,
    pub allowed_object_types: Vec<CatalogObjectType>,
    pub seller_visibility: Option<CatalogCustomAttributeDefinitionSellerVisibility>,
    pub app_visibility: Option<CatalogCustomAttributeDefinitionAppVisibility>,
    pub string_config: Option<CatalogCustomAttributeDefinitionStringConfig>,
    pub number_config: Option<CatalogCustomAttributeDefinitionNumberConfig>,
    pub selection_config: Option<CatalogCustomAttributeDefinitionSelectionConfig>,
    pub custom_attribute_usage_count: Option<i32>,
    pub key: Option<String>,
}

Contains information defining a custom attribute.

Custom attributes are intended to store additional information about a catalog object or to associate a catalog object with an entity in another system. Do not use custom attributes to store any sensitive information (personally identifiable information, card details, etc.). Read more about custom attributes

Fields

type: CatalogCustomAttributeDefinitionType

The type of this custom attribute. Cannot be modified after creation. Required.

name: String

The name of this definition for API and seller-facing UI purposes. The name must be unique within the (merchant, application) pair. Required. May not be empty and may not exceed 255 characters. Can be modified after creation.

description: Option<String>

Seller-oriented description of the meaning of this Custom Attribute, any constraints that the seller should observe, etc. May be displayed as a tooltip in Square UIs.

source_application: Option<SourceApplication>

Read only. Contains information about the application that created this custom attribute definition.

allowed_object_types: Vec<CatalogObjectType>

The set of Catalog Object Types that this Custom Attribute may be applied to. Currently, only ITEM and ITEM_VARIATION are allowed. At least one type must be included.

seller_visibility: Option<CatalogCustomAttributeDefinitionSellerVisibility>

The visibility of a custom attribute in seller-facing UIs (including Square Point of Sale applications and Square Dashboard). May be modified.

app_visibility: Option<CatalogCustomAttributeDefinitionAppVisibility>

The visibility of a custom attribute to applications other than the application that created the attribute.

string_config: Option<CatalogCustomAttributeDefinitionStringConfig>

Optionally, populated when type = STRING, unset otherwise.

number_config: Option<CatalogCustomAttributeDefinitionNumberConfig>

Optionally, populated when type = NUMBER, unset otherwise.

selection_config: Option<CatalogCustomAttributeDefinitionSelectionConfig>

Populated when type is set to SELECTION, unset otherwise.

custom_attribute_usage_count: Option<i32>

Read-only. The number of custom attributes that reference this custom attribute definition. Set by the server in response to a ListCatalog request with include_counts set to true. If the actual count is greater than 100, custom_attribute_usage_count will be set to 100.

key: Option<String>

The name of the desired custom attribute key that can be used to access the custom attribute value on catalog objects. Cannot be modified after the custom attribute definition has been created. Must be between 1 and 60 characters, and may only contain the characters [a-zA-Z0-9_-].

Trait Implementations

impl Clone for CatalogCustomAttributeDefinition

fn clone(&self) -> CatalogCustomAttributeDefinition

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CatalogCustomAttributeDefinition

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CatalogCustomAttributeDefinition

fn default() -> CatalogCustomAttributeDefinition

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatalogCustomAttributeDefinition

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CatalogCustomAttributeDefinition

fn eq(&self, other: &CatalogCustomAttributeDefinition) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CatalogCustomAttributeDefinition

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for CatalogCustomAttributeDefinition

impl StructuralPartialEq for CatalogCustomAttributeDefinition