Struct square_api_client::models::CreateCatalogImageRequest

pub struct CreateCatalogImageRequest {
    pub idempotency_key: String,
    pub object_id: Option<String>,
    pub image: CatalogObject,
    pub is_primary: Option<bool>,
}

This is a model class for CreateCatalogImageRequest type.

Fields

idempotency_key: String

A unique string that identifies this CreateCatalogImage request. Keys can be any valid string but must be unique for every CreateCatalogImage request.

See Idempotency keys for more information.

object_id: Option<String>

Unique ID of the CatalogObject to attach this CatalogImage object to. Leave this field empty to create unattached images, for example if you are building an integration where an image can be attached to catalog items at a later time.

image: CatalogObject

The new CatalogObject of the IMAGE type, namely, a CatalogImage object, to encapsulate the specified image file.

is_primary: Option<bool>

If this is set to true, the image created will be the primary, or first image of the object referenced by object_id. If the CatalogObject already has a primary CatalogImage, setting this field to true will replace the primary image. If this is set to false and you use the Square API version 2021-12-15 or later, the image id will be appended to the list of image_ids on the object.

With Square API version 2021-12-15 or later, the default value is false. Otherwise, the effective default value is true.

Trait Implementations

impl Clone for CreateCatalogImageRequest

fn clone(&self) -> CreateCatalogImageRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CreateCatalogImageRequest

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

Formats the value using the given formatter.

impl Default for CreateCatalogImageRequest

fn default() -> CreateCatalogImageRequest

Returns the “default value” for a type.

impl PartialEq<CreateCatalogImageRequest> for CreateCatalogImageRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for CreateCatalogImageRequest

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 CreateCatalogImageRequest

impl StructuralEq for CreateCatalogImageRequest

impl StructuralPartialEq for CreateCatalogImageRequest