Skip to main content

ArchiveClient

Struct ArchiveClient 

Source
pub struct ArchiveClient { /* private fields */ }
Expand description

Client for the Yuki Archive SOAP service.

Implementations§

Source§

impl ArchiveClient

Source

pub fn new() -> Self

Source

pub async fn authenticate(&mut self, api_key: &str) -> Result<String, YukiError>

Authenticate with the Yuki API and store the session ID.

Source

pub async fn documents_in_folder( &self, folder_id: i32, start_date: &str, end_date: &str, ) -> Result<Vec<ArchiveDocument>, YukiError>

List all documents in an archive folder by folder ID.

Source

pub async fn documents_by_type( &self, doc_type: i32, ) -> Result<String, YukiError>

List all documents of a given document type.

Source

pub async fn search_documents( &self, search_text: &str, start_date: &str, end_date: &str, ) -> Result<Vec<ArchiveDocument>, YukiError>

Search documents in the archive using a free-text query within a date range.

Pass an empty string for search_text to retrieve all documents in the period. Returns up to 500 results sorted by document date descending.

Source

pub async fn modified_documents_by_type( &self, doc_type: i32, modified_since: &str, ) -> Result<String, YukiError>

List documents of a given type that were modified since the specified date.

Source

pub async fn upload_document( &self, admin_id: &str, filename: &str, data_base64: &str, folder_id: i32, ) -> Result<String, YukiError>

Upload a document to the archive without additional metadata.

Returns the document ID assigned by Yuki.

Source

pub async fn upload_document_with_data( &self, admin_id: &str, filename: &str, data_base64: &str, folder_id: i32, currency: &str, amount: f64, cost_category: Option<&str>, payment_method: Option<&str>, project: Option<&str>, remarks: Option<&str>, ) -> Result<String, YukiError>

Upload a document to the archive with invoice metadata.

Returns the document ID assigned by Yuki.

Source

pub async fn cost_categories(&self) -> Result<Vec<CostCategory>, YukiError>

Retrieve all available cost categories.

Source

pub async fn payment_methods(&self) -> Result<Vec<PaymentMethod>, YukiError>

Retrieve all available payment methods.

Source

pub fn parse_archive_documents( xml: &str, ) -> Result<Vec<ArchiveDocument>, YukiError>

Parse a SearchDocuments or DocumentsInFolder SOAP response into a list of documents.

Each <Document ID="uuid"> element carries child elements for each field. The document ID is an XML attribute; all other fields are child text nodes.

Source

pub fn parse_cost_categories(xml: &str) -> Result<Vec<CostCategory>, YukiError>

Parse a CostCategories SOAP response.

Each CostCategory element carries an ID attribute and a Description child element: <CostCategory ID="45100"><Description>...</Description></CostCategory>

Source

pub fn parse_payment_methods(xml: &str) -> Result<Vec<PaymentMethod>, YukiError>

Parse a PaymentMethods SOAP response.

Each PaymentMethod element carries an ID attribute and a Description child element: <PaymentMethod ID="4"><Description>...</Description></PaymentMethod>

Trait Implementations§

Source§

impl Default for ArchiveClient

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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, 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<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