Skip to main content

Client

Struct Client 

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

The main SumUp API client.

Use this client to access different API endpoints organized by tags.

Implementations§

Source§

impl Client

Source

pub fn new() -> Self

Creates a new SumUp API client with the default base URL. Tries to read the authorization token from the SUMUP_API_KEY environment variable. Default timeout is 10 seconds.

Source

pub fn with_client(self, http_client: Client) -> Self

Overrides the underlying HTTP client used for requests. Returns a new client with the provided reqwest::Client.

Source

pub fn with_base_url(self, base_url: impl Into<String>) -> Self

Sets the base URL for API requests. Returns a new client with the updated base URL.

Source

pub fn with_authorization(self, auth: Authorization) -> Self

Sets the authorization token for API requests. Returns a new client with the updated token.

Source

pub fn with_timeout(self, timeout: Duration) -> Self

Sets the request timeout for API requests. Returns a new client with the updated timeout.

Source

pub fn base_url(&self) -> &str

Returns the base URL for the API.

Source

pub fn authorization(&self) -> Option<&str>

Returns the authorization token if set.

Source

pub fn timeout(&self) -> Duration

Returns the request timeout.

Source

pub fn checkouts(&self) -> CheckoutsClient<'_>

Source

pub fn customers(&self) -> CustomersClient<'_>

Source

pub fn members(&self) -> MembersClient<'_>

Source

pub fn memberships(&self) -> MembershipsClient<'_>

Source

pub fn merchants(&self) -> MerchantsClient<'_>

Source

pub fn payouts(&self) -> PayoutsClient<'_>

Source

pub fn readers(&self) -> ReadersClient<'_>

Source

pub fn receipts(&self) -> ReceiptsClient<'_>

Source

pub fn roles(&self) -> RolesClient<'_>

Source

pub fn subaccounts(&self) -> SubaccountsClient<'_>

👎Deprecated:

Subaccounts API is deprecated, please use Members API instead to manage your account members.

Source

pub fn transactions(&self) -> TransactionsClient<'_>

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

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 Debug for Client

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Client

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