Type Definition lexoffice::request::Request

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>

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

pub async fn get(self) -> Result<Vec<Country>>

executes the request

impl Request<File>

pub fn by_id_url<I>(&self, uuid: I) -> Result<Url> where
    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>

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, 

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, 

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

Uploads arbitrary data as file to lexoffice

pub async fn upload_path<P>(self, path: P) -> Result<Uuid> where
    P: AsRef<Path> + Send + Sync, 

Uploads a file from a path to lexoffice

impl Request<PostingCategory>

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

executes the request

impl Request<Profile>

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

pub async fn get(self) -> Result<Profile>

executes the request

Trait Implementations

impl ById for Request<Contact>

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>

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>

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>

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>

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>

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>

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>

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>

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>

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>

TODO

impl Endpoint for Request<Contact>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<Country>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<Profile>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<Quotation>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<Voucher>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<CreditNote>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<DownPaymentInvoice>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<EventSubscription>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<File>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<Invoice>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<OrderConfirmation>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<Payment>

const ENDPOINT: &'static str

The endpoint of a request.

impl Endpoint for Request<PostingCategory>

const ENDPOINT: &'static str

The endpoint of a request.

impl Paginated for Request<Contact>

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>

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>

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>

TODO doc

impl Storable for Request<EventSubscription>

TODO

impl Updatable for Request<Contact>

TODO doc

impl Updatable for Request<EventSubscription>

TODO