Struct CatalogCustomAttributeDefinition

Source
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>,
}
Expand description

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§

Source§

impl Clone for CatalogCustomAttributeDefinition

Source§

fn clone(&self) -> CatalogCustomAttributeDefinition

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CatalogCustomAttributeDefinition

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for CatalogCustomAttributeDefinition

Source§

fn default() -> CatalogCustomAttributeDefinition

Returns the “default value” for a type. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for CatalogCustomAttributeDefinition

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for CatalogCustomAttributeDefinition

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl Eq for CatalogCustomAttributeDefinition

Source§

impl StructuralPartialEq for CatalogCustomAttributeDefinition

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,