Struct square_api_client::models::CatalogImage
source · [−]pub struct CatalogImage {
pub name: Option<String>,
pub url: Option<String>,
pub caption: Option<String>,
pub photo_studio_order_id: Option<String>,
}
Expand description
An image file to use in Square catalogs.
It can be associated with CatalogItem
, CatalogItemVariation
, CatalogCategory
, and
CatalogModifierList
objects. Only the images on items and item variations are exposed in
Dashboard. Only the first image on an item is displayed in Square Point of Sale (SPOS). Images
on items and variations are displayed through Square Online Store. Images on other object types
are for use by 3rd party application developers.
Fields
name: Option<String>
The internal name to identify this image in calls to the Square API. This is a searchable attribute for use in applicable query filters using the SearchCatalogObjects. It is not unique and should not be shown in a buyer facing context.
url: Option<String>
The URL of this image, generated by Square after an image is uploaded using the CreateCatalogImage endpoint. To modify the image, use the UpdateCatalogImage endpoint. Do not change the URL field.
caption: Option<String>
A caption that describes what is shown in the image. Displayed in the Square Online Store. This is a searchable attribute for use in applicable query filters using the SearchCatalogObjects.
photo_studio_order_id: Option<String>
The immutable order ID for this image object created by the Photo Studio service in Square Online Store.
Trait Implementations
sourceimpl Clone for CatalogImage
impl Clone for CatalogImage
sourcefn clone(&self) -> CatalogImage
fn clone(&self) -> CatalogImage
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresourceimpl Debug for CatalogImage
impl Debug for CatalogImage
sourceimpl Default for CatalogImage
impl Default for CatalogImage
sourcefn default() -> CatalogImage
fn default() -> CatalogImage
sourceimpl<'de> Deserialize<'de> for CatalogImage
impl<'de> Deserialize<'de> for CatalogImage
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
sourceimpl PartialEq<CatalogImage> for CatalogImage
impl PartialEq<CatalogImage> for CatalogImage
sourcefn eq(&self, other: &CatalogImage) -> bool
fn eq(&self, other: &CatalogImage) -> bool
sourceimpl Serialize for CatalogImage
impl Serialize for CatalogImage
impl Eq for CatalogImage
impl StructuralEq for CatalogImage
impl StructuralPartialEq for CatalogImage
Auto Trait Implementations
impl RefUnwindSafe for CatalogImage
impl Send for CatalogImage
impl Sync for CatalogImage
impl Unpin for CatalogImage
impl UnwindSafe for CatalogImage
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
sourceimpl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcefn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.