Type Definition lexoffice::request::Request [−][src]
type Request<T> = RequestWithState<T, ()>;
Represents a request to the lexoffice API. Please note that in order to
create a working Request
the Type variable T
must allow requests to be
made.
Implementations
impl Request<Country>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Country; let client = Client::new(ApiKey::try_default().await?); let countries = client.request::<Country>().get().await?; println!("{:#?}", countries); Ok(())
impl Request<File>
[src]
pub fn by_id_url<I>(&self, uuid: I) -> Result<Url> where
I: Into<Uuid> + Send + Sync,
[src]
I: Into<Uuid> + Send + Sync,
This method creates an Url
that is used to address the object
identified by uuid
.
pub async fn by_id_str(self, uuid: &str) -> Result<Response>
[src]
This method requests an object identified by uuid
.
pub async fn by_id<I>(self, uuid: I) -> Result<Response> where
I: Into<Uuid> + Send + Sync,
[src]
I: Into<Uuid> + Send + Sync,
This method requests an object identified by uuid
.
pub async fn upload<P>(self, file_part: P) -> Result<Uuid> where
P: Into<Part> + Send + Sync,
[src]
P: Into<Part> + Send + Sync,
Uploads a file to lexoffice
pub async fn upload_bytes<B>(
self,
mime: &'static Mime,
bytes: B
) -> Result<Uuid> where
B: Into<Cow<'static, [u8]>>,
[src]
self,
mime: &'static Mime,
bytes: B
) -> Result<Uuid> where
B: Into<Cow<'static, [u8]>>,
Uploads arbitrary data as file to lexoffice
pub async fn upload_path<P>(self, path: P) -> Result<Uuid> where
P: AsRef<Path> + Send + Sync,
[src]
P: AsRef<Path> + Send + Sync,
Uploads a file from a path to lexoffice
impl Request<PostingCategory>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::PostingCategory; let client = Client::new(ApiKey::try_default().await?); let posting_categories = client.request::<PostingCategory>().get().await?; println!("{:#?}", posting_categories); Ok(())
pub async fn get(self) -> Result<Vec<PostingCategory>>
[src]
executes the request
impl Request<Profile>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Profile; let client = Client::new(ApiKey::try_default().await?); let profile = client.request::<Profile>().get().await?; println!("{:#?}", profile); Ok(())
Trait Implementations
impl ById for Request<Contact>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Contact; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("f4add52b-44e3-474a-b718-890885094d9a")?; let contacts = client.request::<Contact>().by_id(uuid).await?; println!("{:#?}", contacts);
impl ById for Request<CreditNote>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::CreditNote; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("f4add52b-44e3-474a-b718-890885094d9a")?; let contacts = client.request::<CreditNote>().by_id(uuid).await?; println!("{:#?}", contacts);
impl ById for Request<DownPaymentInvoice>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::DownPaymentInvoice; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("f4add52b-44e3-474a-b718-890885094d9a")?; let invoices = client.request::<DownPaymentInvoice>().by_id(uuid).await?; println!("{:#?}", invoices);
impl ById for Request<EventSubscription>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::EventSubscription; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("f4add52b-44e3-474a-b718-890885094d9a")?; let event_subscriptions = client.request::<EventSubscription>().by_id(uuid).await?; println!("{:#?}", event_subscriptions);
impl ById for Request<Invoice>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Invoice; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("f4add52b-44e3-474a-b718-890885094d9a")?; let invoices = client.request::<Invoice>().by_id(uuid).await?; println!("{:#?}", invoices);
impl ById for Request<OrderConfirmation>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::OrderConfirmation; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("f4add52b-44e3-474a-b718-890885094d9a")?; let order_confirmations = client.request::<OrderConfirmation>().by_id(uuid).await?; println!("{:#?}", order_confirmations);
impl ById for Request<Payment>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Payment; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("a886c776-c1b2-427d-999e-a687f688da08")?; let payment = client.request::<Payment>().by_id(uuid).await?; println!("{:#?}", payment);
impl ById for Request<Quotation>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Quotation; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("f4add52b-44e3-474a-b718-890885094d9a")?; let quotations = client.request::<Quotation>().by_id(uuid).await?; println!("{:#?}", quotations);
impl ById for Request<Voucherlist>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Voucherlist; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("f4add52b-44e3-474a-b718-890885094d9a")?; let invoices = client.request::<Voucherlist>().by_id(uuid).await?; println!("{:#?}", invoices);
impl ById for Request<Voucher>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Voucher; let client = Client::new(ApiKey::try_default().await?); let uuid = uuid::Uuid::parse_str("f4add52b-44e3-474a-b718-890885094d9a")?; let invoices = client.request::<Voucher>().by_id(uuid).await?; println!("{:#?}", invoices);
impl Deletable for Request<EventSubscription>
[src]
TODO
impl Endpoint for Request<Contact>
[src]
impl Endpoint for Request<Country>
[src]
impl Endpoint for Request<Profile>
[src]
impl Endpoint for Request<Quotation>
[src]
impl Endpoint for Request<Voucher>
[src]
impl Endpoint for Request<CreditNote>
[src]
impl Endpoint for Request<DownPaymentInvoice>
[src]
impl Endpoint for Request<EventSubscription>
[src]
impl Endpoint for Request<File>
[src]
impl Endpoint for Request<Invoice>
[src]
impl Endpoint for Request<OrderConfirmation>
[src]
impl Endpoint for Request<Payment>
[src]
impl Endpoint for Request<PostingCategory>
[src]
impl Paginated for Request<Contact>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Contact; let client = Client::new(ApiKey::try_default().await?); let contacts = client.request::<Contact>().page(0).await?; println!("{:#?}", contacts);
impl Paginated for Request<EventSubscription>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::EventSubscription; let client = Client::new(ApiKey::try_default().await?); let event_subscriptions = client.request::<EventSubscription>().page(0).await?; println!("{:#?}", event_subscriptions);
impl Paginated for Request<Quotation>
[src]
Examples
use lexoffice::{ApiKey, Client}; use lexoffice::model::Quotation; let client = Client::new(ApiKey::try_default().await?); let quotations = client.request::<Quotation>().page(0).await?; println!("{:#?}", quotations);
impl Storable for Request<Contact>
[src]
TODO doc
impl Storable for Request<EventSubscription>
[src]
TODO
impl Updatable for Request<Contact>
[src]
TODO doc
impl Updatable for Request<EventSubscription>
[src]
TODO