Struct UsersApi 

pub struct UsersApi<'a> { /* private fields */ }

User endpoints.

Implementations

impl<'a> UsersApi<'a>

pub async fn me(&self) -> Result<User>

GET /api/v1/users/me - the user the access token belongs to.

pub async fn get(&self, id: u64) -> Result<User>

GET /api/v1/users/:id.

pub fn list(&self) -> ListUsers<'a>

GET /api/v1/users - paginated list.

pub fn search(&self, query: impl Into<String>) -> SearchUsers<'a>

GET /api/v1/users/search?query=….

pub async fn create(&self, user: &NewUser) -> Result<User>

POST /api/v1/users - create a user from a NewUser payload.

pub async fn update<P: Serialize + ?Sized>( &self, id: u64, patch: &P, ) -> Result<User>

PUT /api/v1/users/:id - accepts any Serialize patch.

pub async fn set_field( &self, id: u64, field: &str, value: impl Into<Value>, ) -> Result<User>

Set a single field (typically a custom field) and verify the value was persisted server-side. See crate::api::TicketsApi::set_field for the rationale.

pub async fn delete(&self, id: u64) -> Result<()>

DELETE /api/v1/users/:id.

Trait Implementations

impl<'a> Debug for UsersApi<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.