Struct Shifts

Source
pub struct Shifts {
    pub client: Client,
}

Fields§

§client: Client

Implementations§

Source§

impl Shifts

Source

pub async fn list<'a>(&'a self) -> Result<ListShiftsResponse, Error>

List Shifts

List the shifts.

async fn example_shifts_list() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListShiftsResponse = client.shifts().list().await?;
    println!("{:?}", result);
    Ok(())
}
Source

pub async fn create<'a>( &'a self, body: &CreateShift, ) -> Result<ShiftResponse, Error>

Create shift

Create a shift.

async fn example_shifts_create() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ShiftResponse = client
        .shifts()
        .create(&serde_json::Value::String("some-string".to_string()))
        .await?;
    println!("{:?}", result);
    Ok(())
}
Source

pub async fn list_team<'a>( &'a self, team_id: &'a str, ) -> Result<ListTeamShiftsResponse, Error>

List team Shifts

List the shifts for a team.

Parameters:

  • team_id: &'astr: The team ID (required)
async fn example_shifts_list_team() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListTeamShiftsResponse =
        client.shifts().list_team("some-string").await?;
    println!("{:?}", result);
    Ok(())
}
Source

pub async fn create_team<'a>( &'a self, team_id: &'a str, body: &CreateShift, ) -> Result<ShiftResponse, Error>

Create team shift

Create a shift for a team.

Parameters:

  • team_id: &'astr: The Team ID (required)
async fn example_shifts_create_team() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ShiftResponse = client
        .shifts()
        .create_team(
            "some-string",
            &serde_json::Value::String("some-string".to_string()),
        )
        .await?;
    println!("{:?}", result);
    Ok(())
}
Source

pub async fn list_teammate<'a>( &'a self, teammate_id: &'a str, ) -> Result<ListTeammateShiftsResponse, Error>

List Teammate Shifts

Lists all the shifts for the teammate.

Parameters:

  • teammate_id: &'astr: The teammate ID (required)
async fn example_shifts_list_teammate() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListTeammateShiftsResponse =
        client.shifts().list_teammate("some-string").await?;
    println!("{:?}", result);
    Ok(())
}
Source

pub async fn get<'a>( &'a self, shift_id: &'a str, ) -> Result<ShiftResponse, Error>

Get shift

Fetch a shift.

Parameters:

  • shift_id: &'astr: The Shift ID (required)
async fn example_shifts_get() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ShiftResponse = client.shifts().get("some-string").await?;
    println!("{:?}", result);
    Ok(())
}
Source

pub async fn list_teammates<'a>( &'a self, shift_id: &'a str, ) -> Result<ListShiftTeammatesResponse, Error>

List shift’s teammates

List the teammates assigned to a shift.

Parameters:

  • shift_id: &'astr: The Shift ID (required)
async fn example_shifts_list_teammates() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    let result: front_api::types::ListShiftTeammatesResponse =
        client.shifts().list_teammates("some-string").await?;
    println!("{:?}", result);
    Ok(())
}
Source

pub async fn add_teammates_to<'a>( &'a self, shift_id: &'a str, body: &TeammateIds, ) -> Result<(), Error>

Add teammates to shift

Add teammates to a shift. The selected teammates must be in the team that owns the shift.

Parameters:

  • shift_id: &'astr: The Shift ID (required)
async fn example_shifts_add_teammates_to() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client
        .shifts()
        .add_teammates_to(
            "some-string",
            &front_api::types::TeammateIds {
                teammate_ids: vec!["some-string".to_string()],
            },
        )
        .await?;
    Ok(())
}
Source

pub async fn remove_teammates_from<'a>( &'a self, shift_id: &'a str, body: &TeammateIds, ) -> Result<(), Error>

Remove teammates from shift

Remove teammates from a shift.

Parameters:

  • shift_id: &'astr: The Shift ID (required)
async fn example_shifts_remove_teammates_from() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client
        .shifts()
        .remove_teammates_from(
            "some-string",
            &front_api::types::TeammateIds {
                teammate_ids: vec!["some-string".to_string()],
            },
        )
        .await?;
    Ok(())
}
Source

pub async fn update<'a>( &'a self, shift_id: &'a str, body: &UpdateShift, ) -> Result<(), Error>

Update shift

Update a shift.

Parameters:

  • shift_id: &'astr: The Shift ID (required)
async fn example_shifts_update() -> anyhow::Result<()> {
    let client = front_api::Client::new_from_env();
    client
        .shifts()
        .update(
            "some-string",
            &front_api::types::UpdateShift {
                name: Some("some-string".to_string()),
                color: Some(front_api::types::Color::Red),
                timezone: Some("some-string".to_string()),
                times: Some(front_api::types::ShiftIntervals {
                    mon: Some(front_api::types::ShiftInterval {
                        start: "some-string".to_string(),
                        end: "some-string".to_string(),
                    }),
                    tue: Some(front_api::types::ShiftInterval {
                        start: "some-string".to_string(),
                        end: "some-string".to_string(),
                    }),
                    wed: Some(front_api::types::ShiftInterval {
                        start: "some-string".to_string(),
                        end: "some-string".to_string(),
                    }),
                    thu: Some(front_api::types::ShiftInterval {
                        start: "some-string".to_string(),
                        end: "some-string".to_string(),
                    }),
                    fri: Some(front_api::types::ShiftInterval {
                        start: "some-string".to_string(),
                        end: "some-string".to_string(),
                    }),
                    sat: Some(front_api::types::ShiftInterval {
                        start: "some-string".to_string(),
                        end: "some-string".to_string(),
                    }),
                    sun: Some(front_api::types::ShiftInterval {
                        start: "some-string".to_string(),
                        end: "some-string".to_string(),
                    }),
                }),
                teammate_ids: Some(vec!["some-string".to_string()]),
            },
        )
        .await?;
    Ok(())
}

Trait Implementations§

Source§

impl Clone for Shifts

Source§

fn clone(&self) -> Shifts

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Shifts

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for Shifts

§

impl !RefUnwindSafe for Shifts

§

impl Send for Shifts

§

impl Sync for Shifts

§

impl Unpin for Shifts

§

impl !UnwindSafe for Shifts

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoResult<T> for T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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