squareup 2.13.0

Rust SDK for the Square Developer API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

//! Model struct for CustomAttribute type

use super::{CustomAttributeDefinition, DateTime};
use crate::models::enums::CustomAttributeDefinitionVisibility;
use serde::{Deserialize, Serialize};

/// Represents a custom attribute value.
///
/// Each custom attribute value has a corresponding `CustomAttributeDefinition` object.
#[derive(Clone, Debug, Serialize, Deserialize, Eq, PartialEq)]
pub struct CustomAttribute {
    /// The identifier of the custom attribute definition and its corresponding custom attributes.
    /// This value can be a simple key or a qualified key. The qualified key consists of the application ID
    /// of the custom attribute definition owner followed by the simple key.
    /// Example format: `application_id:simple_key`.
    /// The value for a simple key can contain up to 60 alphanumeric characters, periods (.), underscores (_),
    /// and hyphens (-).
    pub key: String,
    /// The value assigned to the custom attribute. It is validated against the custom attribute definition's schema
    /// on write operations.
    pub value: Option<serde_json::Value>,
    /// **Read only**. The current version of the custom attribute. This field is incremented when the custom attribute
    /// is changed. When updating an existing custom attribute value, you can provide this field and specify the current
    /// version of the custom attribute to enable optimistic concurrency.
    pub version: Option<i32>,
    /// **Read only**. A copy of the visibility field value for the associated custom attribute definition.
    pub visibility: Option<CustomAttributeDefinitionVisibility>,
    /// **Read only**. A copy of the associated custom attribute definition object. This field is only set
    /// when the optional field is specified on the request.
    pub definition: Option<CustomAttributeDefinition>,
    /// **Read only**. The timestamp that indicates when the custom attribute was created or most recently updated,
    /// in RFC 3339 format.
    pub updated_at: Option<DateTime>,
    /// **Read only**. The timestamp that indicates when the custom attribute was created, in RFC 3339 format.
    pub created_at: Option<DateTime>,
}