square_api_client/models/
search_subscriptions_request.rs

1//! Request body struct for the Search Subscriptions API
2
3use serde::Serialize;
4
5use super::SearchSubscriptionsQuery;
6
7/// This is a model struct for SearchSubscriptionsRequest type.
8#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize)]
9pub struct SearchSubscriptionsRequest {
10    /// When the total number of resulting subscriptions exceeds the limit of a paged response,
11    /// specify the cursor returned from a preceding response here to fetch the next set of results.
12    /// If the cursor is unset, the response contains the last page of the results.
13    ///
14    /// For more information, see
15    /// [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).
16    pub cursor: Option<String>,
17    /// The upper limit on the number of subscriptions to return in a paged response.
18    ///
19    /// Min: 1
20    pub limit: Option<i32>,
21    /// A subscription query consisting of specified filtering conditions.
22    ///
23    /// If this query field is unspecified, the `SearchSubscriptions` call will return all
24    /// subscriptions.
25    pub query: Option<SearchSubscriptionsQuery>,
26    /// An option to include related information in the response.
27    ///
28    /// The supported values are:
29    ///
30    /// * `actions`: to include scheduled actions on the targeted subscriptions.
31    pub include: Option<Vec<String>>,
32}