square_api_client/models/search_customers_request.rs
1//! Model struct for SearchCustomersRequest type
2
3use serde::Serialize;
4
5use super::SearchCustomersQuery;
6
7/// This is a model struct for SearchCustomersRequest type.
8#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize)]
9pub struct SearchCustomersRequest {
10 /// A pagination cursor returned by a previous call to this endpoint. Provide this cursor to
11 /// retrieve the next set of results for your original query. For more information, see
12 /// [Pagination](https://developer.squareup.com/docs/basics/api101/pagination).
13 pub cursor: Option<String>,
14 /// Query conditions used to filter or sort the results. Note that when retrieving additional
15 /// pages using a cursor, you must use the original query.
16 pub query: Option<SearchCustomersQuery>,
17 /// The maximum number of results to be returned in a single page. It is possible to receive
18 /// fewer results than the specified limit on a given page.
19 ///
20 /// Default: 500
21 pub limit: Option<i32>,
22}