squareup/models/search_team_members_filter.rs
1//! Model struct for SearchTeamMembersFilter type
2
3use serde::Serialize;
4
5use super::enums::TeamMemberStatus;
6
7/// Represents a filter used in a search for TeamMember objects.
8///
9/// `AND` logic is applied between the individual fields, and `OR` logic is applied within
10/// list-based fields. For example, setting this filter value:
11///
12/// ```
13/// use squareup::models::{enums::TeamMemberStatus, SearchTeamMembersFilter};
14///
15/// let filter = SearchTeamMembersFilter {
16/// location_ids: Some(vec![String::from("A"), String::from("B")]),
17/// status: Some(TeamMemberStatus::Active),
18/// ..Default::default()
19/// };
20/// ```
21/// returns only active team members assigned to either location "A" or "B".
22#[derive(Clone, Debug, Default, Eq, PartialEq, Serialize)]
23pub struct SearchTeamMembersFilter {
24 /// When present, filters by team members assigned to the specified locations. When empty,
25 /// includes team members assigned to any location.
26 pub location_ids: Option<Vec<String>>,
27 /// When present, filters by team members who match the given status. When empty, includes team
28 /// members of all statuses.
29 pub status: Option<TeamMemberStatus>,
30 /// When present and set to true, returns the team member who is the owner of the Square
31 /// account.
32 pub is_owner: Option<bool>,
33}