SubaccountEndpoints

paystack::endpoints::subaccount

Struct SubaccountEndpoints

pub struct SubaccountEndpoints<T: HttpClient + Default> { /* private fields */ }

Expand description

A struct to hold all functions in the subaccount API route

Implementations§

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

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

Creates a new SubaccountEndpoints instance

§Arguments

key - The Paystack API key
http - The HTTP client implementation to use for API requests

§Returns

A new SubaccountEndpoints instance

pub async fn create_subaccount( &self, subaccount_request: CreateSubaccountRequest, ) -> PaystackResult<SubaccountsResponseData>

Create a subaccount on your integration

§Arguments

subaccount_request - The request data to create the subaccount. It should be created with the CreateSubaccountRequestBuilder struct.

§Returns

A Result containing the subaccount response data or an error

pub async fn list_subaccounts( &self, per_page: Option<u32>, page: Option<u32>, ) -> PaystackResult<Vec<SubaccountsResponseData>>

List subaccounts available on your integration.

§Arguments

per_page - Optional number of subaccounts to return per page. Defaults to 50 if None.
page - Specify exactly what page you want to retrieve. Defaults to 1 if None.

§Returns

A Result containing a vector of subaccount data or an error.

pub async fn fetch_subaccount( &self, id_or_code: String, ) -> PaystackResult<SubaccountsResponseData>

Get the details of a subaccount on your integration

§Arguments

id_or_code - The subaccount ID or code you want to fetch

§Returns

A Result containing the details of the subaccount or an error.

pub async fn update_subaccount( &self, id_or_code: String, update_request: CreateSubaccountRequest, ) -> PaystackResult<SubaccountsResponseData>

Update a subaccount details in your integration

§Arguments

id_or_code - Subaccount’s ID or code
update_request - The request data to update the subaccount. It should be created with the CreateSubaccountRequestBuilder struct.

§Returns

A Result containing the updated subaccount response data or an error

Trait Implementations§

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

fn clone(&self) -> SubaccountEndpoints<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

impl<T: Debug + HttpClient + Default> Debug for SubaccountEndpoints<T>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T> Freeze for SubaccountEndpoints<T>

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

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

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

impl<T> Unpin for SubaccountEndpoints<T>

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

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> PolicyExt for T
where T: ?Sized,

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

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

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> WithSubscriber for T

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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