squareup 2.13.0

Rust SDK for the Square Developer API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

//! Model struct for SearchOrdersSort type

use serde::Serialize;

use super::enums::{SearchOrdersSortField, SortOrder};

/// Sorting criteria for a `SearchOrders` request.
///
/// Results can only be sorted by a timestamp field.
#[derive(Clone, Debug, Eq, PartialEq, Serialize)]
pub struct SearchOrdersSort {
    /// The field to sort by.
    ///
    /// **Important:** When using a [DateTimeFilter](SearchOrdersDateTimeFilter), `sort_field` must
    /// match the timestamp field that the `DateTimeFilter` uses to filter. For example, if you set
    /// your `sort_field` to `CLOSED_AT` and you use a `DateTimeFilter`, your `DateTimeFilter` must
    /// filter for orders by their `CLOSED_AT` date. If this field does not match the timestamp
    /// field in `DateTimeFilter`, `SearchOrders` returns an error.
    ///
    /// Default: `CreatedAt`.
    pub sort_field: SearchOrdersSortField,
    /// The chronological order in which results are returned. Defaults to DESC.
    pub sort_order: Option<SortOrder>,
}