square_api_client/models/catalog_id_mapping.rs
1//! Model struct for CatalogIdMapping type.
2
3use serde::Deserialize;
4
5/// A mapping between a temporary client-supplied ID and a permanent server-generated ID.
6///
7/// When calling UpsertCatalogObject or BatchUpsertCatalogObjects to create a [CatalogObject]
8/// instance, you can supply a temporary ID for the to-be-created object, especially when the object
9/// is to be referenced elsewhere in the same request body. This temporary ID can be any string
10/// unique within the call, but must be prefixed by "#".
11///
12/// After the request is submitted and the object created, a permanent server-generated ID is
13/// assigned to the new object. The permanent ID is unique across the Square catalog.
14#[derive(Clone, Debug, Deserialize, Eq, PartialEq)]
15pub struct CatalogIdMapping {
16 /// The client-supplied temporary `#`-prefixed ID for a new `CatalogObject`.
17 pub client_object_id: String,
18 /// The permanent ID for the CatalogObject created by the server.
19 pub object_id: String,
20}