TerminalEndpoints

paystack::endpoints::terminal

Struct TerminalEndpoints 

Source 
pub struct TerminalEndpoints<T: HttpClient + Default> { /* private fields */ }
Expand description

A struct to hold all the functions of the terminal API endpoint

Implementations§

Source§

impl<T: HttpClient + Default> TerminalEndpoints<T>

Source

pub fn new(key: Arc<String>, http: Arc<T>) -> TerminalEndpoints<T>

Creates a new TerminalEndpoints instance

§Arguments
  • key - The Paystack API key
  • http - The HTTP client implementation to use for API requests
§Returns

A new TerminalEndpoints instance

Source

pub async fn send_event( &self, terminal_id: String, event_request: EventRequest, ) -> PaystackResult<SendEventResponseData>

Send an event from your application to the Paystack Terminal

§Arguments
  • terminal_id - The ID of the Terminal the event should be sent to
  • event_request - Struct containing the information of the event to send to the terminal. Created with EventRequestBuilder
§Returns

A Result containing the send event response data or an error

Source

pub async fn fetch_event_status( &self, terminal_id: String, event_id: String, ) -> PaystackResult<FetchEventStatusResponseData>

Check the status of an event sent to the Paystack Terminal

§Arguments
  • terminal_id - The ID of the Terminal the event was sent to
  • event_id - The ID of the event that was sent to the Terminal
§Returns

A Result containing the event status response data or an error

Source

pub async fn fetch_terminal_status( &self, terminal_id: String, ) -> PaystackResult<FetchTerminalStatusResponseData>

Check the availiability of a Terminal before sending an event to it

§Arguments
  • terminal_id - The ID of the Terminal to check
§Returns

A Result containing the terminal status response data or an error

Source

pub async fn list_terminals( &self, per_page: Option<i32>, ) -> PaystackResult<Vec<TerminalData>>

List the Terminals available on your integration

§Arguments
  • per_page - Optional number of records to retrieve. Defaults to 50
§Returns

A Result containing a vector of terminal data or an error

Source

pub async fn fetch_terminal( &self, terminal_id: String, ) -> PaystackResult<TerminalData>

Get the details of a Terminal

§Arguments
  • terminal_id - The ID of the Terminal to fetch
§Returns

A Result containing the terminal data or an error

Source

pub async fn update_terminal( &self, terminal_id: String, update_request: UpdateTerminalRequest, ) -> PaystackResult<PhantomData<String>>

Update the details of a Terminal

§Arguments
  • terminal_id - The ID of the Terminal to update
  • update_request - The request data to update the terminal. Created with UpdateTerminalRequestBuilder
§Returns

A Result containing the response or an error. The generic String type is ignored since response has no data field

Source

pub async fn commission_terminal( &self, serial_number: String, ) -> PaystackResult<PhantomData<String>>

Activate your debug device by linking it to your integration

§Arguments
  • serial_number - The device serial number to commission
§Returns

A Result containing the response or an error. The generic String type is ignored since response has no data field

Source

pub async fn decommission_terminal( &self, serial_number: String, ) -> PaystackResult<PhantomData<String>>

Unlink your debug device from your integration

§Arguments
  • serial_number - The device serial number to decommission
§Returns

A Result containing the response or an error. The generic String type is ignored since response has no data field

Trait Implementations§

Source§

impl<T: Clone + HttpClient + Default> Clone for TerminalEndpoints<T>

Source§

fn clone(&self) -> TerminalEndpoints<T>

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<T: Debug + HttpClient + Default> Debug for TerminalEndpoints<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<T> Freeze for TerminalEndpoints<T>

§

impl<T> RefUnwindSafe for TerminalEndpoints<T>
where T: RefUnwindSafe,

§

impl<T> Send for TerminalEndpoints<T>
where T: Sync,

§

impl<T> Sync for TerminalEndpoints<T>
where T: Sync,

§

impl<T> Unpin for TerminalEndpoints<T>

§

impl<T> UnwindSafe for TerminalEndpoints<T>
where T: RefUnwindSafe,

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: 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> 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<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
Source§

impl<T> ErasedDestructor for T
where T: 'static,