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>,
}
Expand description
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
.
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§
Source§impl Clone for SearchCatalogObjectsRequest
impl Clone for SearchCatalogObjectsRequest
Source§fn clone(&self) -> SearchCatalogObjectsRequest
fn clone(&self) -> SearchCatalogObjectsRequest
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for SearchCatalogObjectsRequest
impl Debug for SearchCatalogObjectsRequest
Source§impl Default for SearchCatalogObjectsRequest
impl Default for SearchCatalogObjectsRequest
Source§fn default() -> SearchCatalogObjectsRequest
fn default() -> SearchCatalogObjectsRequest
impl Eq for SearchCatalogObjectsRequest
impl StructuralPartialEq for SearchCatalogObjectsRequest
Auto Trait Implementations§
impl Freeze for SearchCatalogObjectsRequest
impl RefUnwindSafe for SearchCatalogObjectsRequest
impl Send for SearchCatalogObjectsRequest
impl Sync for SearchCatalogObjectsRequest
impl Unpin for SearchCatalogObjectsRequest
impl UnwindSafe for SearchCatalogObjectsRequest
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.