Struct square_api_client::models::RetrieveCatalogObjectParameters

pub struct RetrieveCatalogObjectParameters {
    pub include_related_objects: Option<bool>,
    pub catalog_version: Option<i64>,
}

This is a model struct for RetrieveCatalogObjectParameters (query parameters)

Fields

include_related_objects: Option<bool>

If true, the response will include additional objects that are related to the requested objects. Related objects are defined as any objects referenced by ID by the results in the objects field of the response. These objects are put in the related_objects field. Setting this to true is helpful when the objects are needed for immediate display to a user. This process only goes one level deep. Objects referenced by the related objects will not be included. For example,

if the objects field of the response contains a CatalogItem, its associated CatalogCategory objects, CatalogTax objects, CatalogImage objects and CatalogModifierLists will be returned in the related_objects field of the response. If the objects field of the response contains a CatalogItemVariation, its parent CatalogItem will be returned in the related_objects field of the response.

Default value: false

catalog_version: Option<i64>

Requests objects as of a specific version of the catalog. This allows you to retrieve historical versions of objects. The value to retrieve a specific version of an object can be found in the version field of [CatalogObject]s. If not included, results will be from the current version of the catalog.

Implementations

impl RetrieveCatalogObjectParameters

pub fn to_query_string(&self) -> String

Trait Implementations

impl Clone for RetrieveCatalogObjectParameters

fn clone(&self) -> RetrieveCatalogObjectParameters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RetrieveCatalogObjectParameters

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

Formats the value using the given formatter.

impl Default for RetrieveCatalogObjectParameters

fn default() -> RetrieveCatalogObjectParameters

Returns the “default value” for a type.

impl From<RetrieveCatalogObjectParameters> for String

fn from(
    retrieve_catalog_object_parameters: RetrieveCatalogObjectParameters
) -> Self

Converts to this type from the input type.

impl ToString for RetrieveCatalogObjectParameters

fn to_string(&self) -> String

Converts the given value to a String.