Skip to main content

ResourcesResource

Struct ResourcesResource 

Source
pub struct ResourcesResource<'a> { /* private fields */ }
Expand description

client.resources()

Implementations§

Source§

impl<'a> ResourcesResource<'a>

Source

pub fn create(&self, body: &ResourceCreate) -> Result<Resource>

Create a resource

POST /resources

Creates an individual bookable resource. Returns 402 when the licensed resource limit is reached.

§Example
let body = models::ResourceCreate {
    name: "Main Hall".into(),
    resource_type_id: 2,
    sort_key: 1,
    ..Default::default()
};
let result = client.resources().create(&body)?;
println!("{}", result.name);
Source

pub fn delete(&self, resource_id: impl Display) -> Result<()>

Delete a resource

DELETE /resources/{resourceId}

Deletes the resource.

§Example
client.resources().delete(7)?;
Source

pub fn get(&self, resource_id: impl Display) -> Result<Resource>

Get a resource

GET /resources/{resourceId}

Returns one resource and its booking settings. A resource is visible when the user has permission to view it or administer its bookings, or is listed in its adminIds. Use include[] to resolve administrators.

Use Self::get_with to pass query parameters.

§Example
let resource = client.resources().get(7)?;
println!("{}", resource.name);
Source

pub fn get_with( &self, resource_id: impl Display, query: &GetResourcesResourceIdQuery, ) -> Result<Resource>

Get a resource

Like Self::get, with query parameters.

GET /resources/{resourceId}

Returns one resource and its booking settings. A resource is visible when the user has permission to view it or administer its bookings, or is listed in its adminIds. Use include[] to resolve administrators.

Source

pub fn get_statistics( &self, resource_id: impl Display, ) -> Result<ResourceStatistics>

Count pending booking occurrences

GET /resources/{resourceId}/statistics

Returns the number of pending booking occurrences from now onward for this resource. Recurring bookings can contribute more than one occurrence. Candidate series are selected using a ten-year lookahead window, then expanded from now without an upper date limit. A resource is visible when the user has permission to view it or administer its bookings, or is listed in its adminIds.

§Example
let statistic = client.resources().get_statistics(7)?;
println!("{}", statistic.num_requested_bookings_in_future);
Source

pub fn list(&self) -> Result<Vec<Resource>>

List visible resources

GET /resources

Returns all resources visible to the current user. A resource is visible when the user has permission to view it or administer its bookings, or is listed in its adminIds. Use include[] to resolve administrators.

Use Self::list_with to pass query parameters.

§Example
for resource in client.resources().list()? {
    println!("{}", resource.name);
}
Source

pub fn list_with(&self, query: &GetResourcesQuery) -> Result<Vec<Resource>>

List visible resources

Like Self::list, with query parameters.

GET /resources

Returns all resources visible to the current user. A resource is visible when the user has permission to view it or administer its bookings, or is listed in its adminIds. Use include[] to resolve administrators.

Source

pub fn update( &self, resource_id: impl Display, body: &ResourceUpdate, ) -> Result<Resource>

Update a resource

PUT /resources/{resourceId}

Replaces the resource configuration.

§Example
let body = models::ResourceUpdate {
    name: "Main Hall".into(),
    resource_type_id: 2,
    sort_key: 1,
    ..Default::default()
};
let result = client.resources().update(7, &body)?;
println!("{}", result.name);

Trait Implementations§

Source§

impl<'a> Clone for ResourcesResource<'a>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a> Copy for ResourcesResource<'a>

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for ResourcesResource<'a>

§

impl<'a> !UnwindSafe for ResourcesResource<'a>

§

impl<'a> Freeze for ResourcesResource<'a>

§

impl<'a> Send for ResourcesResource<'a>

§

impl<'a> Sync for ResourcesResource<'a>

§

impl<'a> Unpin for ResourcesResource<'a>

§

impl<'a> UnsafeUnpin for ResourcesResource<'a>

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> 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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<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