Struct square_api_client::models::SearchCatalogObjectsRequest

pub struct SearchCatalogObjectsRequest {
    pub cursor: Option<String>,
    pub object_types: Option<Vec<CatalogObjectType>>,
    pub include_deleted_objects: Option<bool>,
    pub include_related_objects: Option<bool>,
    pub begin_time: Option<DateTime>,
    pub query: Option<CatalogQuery>,
    pub limit: Option<i32>,
}

This is a model struct for SearchCatalogObjectsRequest type.

Fields

cursor: Option<String>

The pagination cursor returned in the previous response. Leave unset for an initial request. See Pagination for more information.

object_types: Option<Vec<CatalogObjectType>>

The desired set of object types to appear in the search results.

If this is unspecified, the operation returns objects of all the top level types at the version of the Square API used to make the request. Object types that are nested onto other object types are not included in the defaults.

At the current API version the default object types are: ITEM, CATEGORY, TAX, DISCOUNT, MODIFIER_LIST, DINING_OPTION, TAX_EXEMPTION, SERVICE_CHARGE, PRICING_RULE, PRODUCT_SET, TIME_PERIOD, MEASUREMENT_UNIT, SUBSCRIPTION_PLAN, ITEM_OPTION, CUSTOM_ATTRIBUTE_DEFINITION, QUICK_AMOUNT_SETTINGS.

include_deleted_objects: Option<bool>

If true, deleted objects will be included in the results. Deleted objects will have their is_deleted field set to true.

include_related_objects: Option<bool>

If true, the response will include additional objects that are related to the requested objects. Related objects are objects that are referenced by object ID by the objects in the response. This is helpful if the objects are being fetched 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

begin_time: Option<DateTime>

Return objects modified after this timestamp. The timestamp is exclusive - objects with a timestamp equal to begin_time will not be included in the response.

query: Option<CatalogQuery>

A query to be used to filter or sort the results. If no query is specified, the entire catalog will be returned.

limit: Option<i32>

A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.

Trait Implementations

impl Clone for SearchCatalogObjectsRequest

fn clone(&self) -> SearchCatalogObjectsRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchCatalogObjectsRequest

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

Formats the value using the given formatter.

impl Default for SearchCatalogObjectsRequest

fn default() -> SearchCatalogObjectsRequest

Returns the “default value” for a type.

impl PartialEq<SearchCatalogObjectsRequest> for SearchCatalogObjectsRequest

fn eq(&self, other: &SearchCatalogObjectsRequest) -> 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 SearchCatalogObjectsRequest

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 SearchCatalogObjectsRequest

impl StructuralEq for SearchCatalogObjectsRequest

impl StructuralPartialEq for SearchCatalogObjectsRequest