PaymentApi

Struct PaymentApi 

Source
pub struct PaymentApi { /* private fields */ }

Implementations§

Source§

impl PaymentApi

Source

pub fn new(client: &WebClient, config: ApiConfig) -> Self

Source

pub async fn get_requestor_accounts(&self) -> Result<Vec<Account>>

Source

pub async fn get_provider_accounts(&self) -> Result<Vec<Account>>

Source

pub async fn create_allocation( &self, allocation: &NewAllocation, ) -> Result<Allocation>

Source

pub async fn get_allocations<Tz>( &self, after_timestamp: Option<DateTime<Tz>>, max_items: Option<u32>, ) -> Result<Vec<Allocation>>
where Tz: TimeZone, Tz::Offset: Display,

Source

pub async fn get_allocation(&self, allocation_id: &str) -> Result<Allocation>

Source

pub async fn amend_allocation( &self, allocation_id: &str, allocation: &AllocationUpdate, ) -> Result<Allocation>

Source

pub async fn release_allocation(&self, allocation_id: &str) -> Result<()>

Source

pub async fn get_demand_decorations( &self, allocation_ids: Vec<String>, ) -> Result<MarketDecoration>

Source

pub async fn get_debit_notes<Tz>( &self, after_timestamp: Option<DateTime<Tz>>, max_items: Option<u32>, ) -> Result<Vec<DebitNote>>
where Tz: TimeZone, Tz::Offset: Display,

Source

pub async fn get_debit_note(&self, debit_note_id: &str) -> Result<DebitNote>

Source

pub async fn get_payments_for_debit_note<Tz>( &self, debit_note_id: &str, after_timestamp: Option<DateTime<Tz>>, max_items: Option<u32>, ) -> Result<Vec<Payment>>
where Tz: TimeZone, Tz::Offset: Display,

Source

pub fn events<Evtype: PaymentEvent>(&self) -> EventsBuilder<'_, Evtype>

§Example
use std::time::Duration;
use chrono::{DateTime, Utc};
use ya_client::payment::PaymentApi;
use ya_client_model::payment::{DebitNoteEvent, DebitNoteEventType, InvoiceEvent};

async fn my_get_events(payment_api : PaymentApi) -> anyhow::Result<Vec<DebitNoteEvent>> {
    let ts = Utc::now() - chrono::Duration::days(1);

    let events = payment_api.events()
        .after_timestamp(&ts)
        .timeout(Duration::from_secs(60))
        .max_events(100)
        .provider_events(&[
            DebitNoteEventType::DebitNoteReceivedEvent,
            DebitNoteEventType::DebitNoteAcceptedEvent,
            DebitNoteEventType::DebitNoteSettledEvent])
        .requestor_events(vec![
             DebitNoteEventType::DebitNoteReceivedEvent,
            DebitNoteEventType::DebitNoteAcceptedEvent,
            DebitNoteEventType::DebitNoteSettledEvent])
        .get().await?;
    Ok(events)
}

async fn my_last_invoice(payment_api : PaymentApi) {
    if let Some(invoiceEvent)  = payment_api.events::<InvoiceEvent>()
        .max_events(1)
        .get().await
        .unwrap().into_iter().next() {
        eprintln!("first invoice id: {}", invoiceEvent.invoice_id);
    }
}
Source

pub async fn get_debit_note_events<Tz>( &self, after_timestamp: Option<&DateTime<Tz>>, timeout: Option<Duration>, max_events: Option<u32>, app_session_id: Option<String>, ) -> Result<Vec<DebitNoteEvent>>
where Tz: TimeZone, Tz::Offset: Display,

Source

pub async fn issue_debit_note( &self, debit_note: &NewDebitNote, ) -> Result<DebitNote>

Source

pub async fn send_debit_note(&self, debit_note_id: &str) -> Result<()>

Source

pub async fn cancel_debit_note(&self, debit_note_id: &str) -> Result<()>

Source

pub async fn accept_debit_note( &self, debit_note_id: &str, acceptance: &Acceptance, ) -> Result<()>

Source

pub async fn reject_debit_note( &self, debit_note_id: &str, rejection: &Rejection, ) -> Result<()>

Source

pub async fn get_invoices<Tz>( &self, after_timestamp: Option<DateTime<Tz>>, max_items: Option<u32>, ) -> Result<Vec<Invoice>>
where Tz: TimeZone, Tz::Offset: Display,

Source

pub async fn get_invoice(&self, invoice_id: &str) -> Result<Invoice>

Source

pub async fn get_payments_for_invoice<Tz>( &self, invoice_id: &str, after_timestamp: Option<DateTime<Tz>>, max_items: Option<u32>, ) -> Result<Vec<Payment>>
where Tz: TimeZone, Tz::Offset: Display,

Source

pub async fn get_invoice_events<Tz>( &self, after_timestamp: Option<&DateTime<Tz>>, timeout: Option<Duration>, max_events: Option<u32>, app_session_id: Option<String>, ) -> Result<Vec<InvoiceEvent>>
where Tz: TimeZone, Tz::Offset: Display,

Source

pub async fn issue_invoice(&self, invoice: &NewInvoice) -> Result<Invoice>

Source

pub async fn send_invoice(&self, invoice_id: &str) -> Result<()>

Source

pub async fn cancel_invoice(&self, invoice_id: &str) -> Result<()>

Source

pub async fn accept_invoice( &self, invoice_id: &str, acceptance: &Acceptance, ) -> Result<()>

Source

pub async fn reject_invoice( &self, invoice_id: &str, rejection: &Rejection, ) -> Result<()>

Source

pub async fn get_payments<Tz>( &self, after_timestamp: Option<&DateTime<Tz>>, timeout: Option<Duration>, max_events: Option<u32>, app_session_id: Option<String>, ) -> Result<Vec<Payment>>
where Tz: TimeZone, Tz::Offset: Display,

Source

pub async fn get_signed_payments<Tz>( &self, after_timestamp: Option<&DateTime<Tz>>, timeout: Option<Duration>, max_events: Option<u32>, app_session_id: Option<String>, ) -> Result<Vec<Signed<Payment>>>
where Tz: TimeZone, Tz::Offset: Display,

Source

pub async fn get_payment(&self, payment_id: &str) -> Result<Payment>

Source

pub async fn driver_status( &self, driver: Option<String>, network: Option<String>, ) -> Result<Vec<DriverStatusProperty>>

Trait Implementations§

Source§

impl Clone for PaymentApi

Source§

fn clone(&self) -> PaymentApi

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 WebInterface for PaymentApi

Source§

const API_URL_ENV_VAR: &'static str = crate::payment::PAYMENT_URL_ENV_VAR

Source§

const API_SUFFIX: &'static str = ya_client_model::payment::PAYMENT_API_PATH

Source§

fn from_client(client: WebClient) -> Self

Source§

fn rebase_service_url(base_url: Rc<Url>) -> Result<Rc<Url>>

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> 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> Same for T

Source§

type Output = T

Should always be Self
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