Struct TeamApi

Source
pub struct TeamApi { /* private fields */ }

Implementations§

Source§

impl TeamApi

Source

pub fn new(config: Configuration, client: HttpClient) -> Self

Instantiates a new TeamApi

Source

pub async fn create_team_member( &self, body: &CreateTeamMemberRequest, ) -> Result<CreateTeamMemberResponse, ApiError>

Creates a single TeamMember object.

The TeamMember object is returned on successful creates. You must provide the following values in your request to this endpoint:

  • given_name
  • family_name

Learn about Troubleshooting the Team API.

Source

pub async fn bulk_create_team_members( &self, body: &BulkCreateTeamMembersRequest, ) -> Result<BulkCreateTeamMembersResponse, ApiError>

Creates multiple TeamMember objects.

The created TeamMember objects are returned on successful creates. This process is non- transactional and processes as much of the request as possible. If one of the creates in the request cannot be successfully processed, the request is not marked as failed, but the body of the response contains explicit error information for the failed create.

Learn about Troubleshooting the Team API.

Source

pub async fn bulk_update_team_members( &self, body: &BulkUpdateTeamMembersRequest, ) -> Result<BulkUpdateTeamMembersResponse, ApiError>

Updates multiple TeamMember objects.

The updated TeamMember objects are returned on successful updates. This process is non- transactional and processes as much of the request as possible. If one of the updates in the request cannot be successfully processed, the request is not marked as failed, but the body of the response contains explicit error information for the failed update.

Learn about Troubleshooting the Team API.

Source

pub async fn search_team_members( &self, body: &SearchTeamMembersRequest, ) -> Result<SearchTeamMembersResponse, ApiError>

Returns a paginated list of TeamMember objects for a business.

The list can be filtered by the following:

  • location IDs
  • status
Source

pub async fn retrieve_team_member( &self, team_member_id: &str, ) -> Result<RetrieveTeamMemberResponse, ApiError>

Retrieves a TeamMember object for the given TeamMember.id.

Learn about Troubleshooting the Team API.

Source

pub async fn update_team_member( &self, team_member_id: &str, body: &UpdateTeamMemberRequest, ) -> Result<UpdateTeamMemberResponse, ApiError>

Updates a single TeamMember object.

The TeamMember object is returned on successful updates.

Learn about Troubleshooting the Team API.

Source

pub async fn retrieve_wage_setting( &self, team_member_id: &str, ) -> Result<RetrieveWageSettingResponse, ApiError>

Retrieves a WageSetting object for a team member specified by TeamMember.id.

Learn about Troubleshooting the Team API.

Source

pub async fn update_wage_setting( &self, team_member_id: &str, body: &UpdateWageSettingRequest, ) -> Result<UpdateWageSettingResponse, ApiError>

Creates or updates a WageSetting object.

The object is created if a WageSetting with the specified team_member_id does not exist. Otherwise, it fully replaces the WageSetting object for the team member. The WageSetting is returned on a successful update.

Learn about Troubleshooting the Team API.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,