PlansEndpoints

paystack::endpoints::plans

Struct PlansEndpoints

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

Implementations§

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

Create a new PlansEndpoints<T> instance

§Arguments

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

§Returns

A new PlansEndpoints instance

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

pub async fn create_plan( &self, plan_request: PlanRequest, ) -> PaystackResult<PlanResponseData>

Create a plan on your integration

§Arguments

plan_request - The request data to create the plan. Should be created with a PlanRequestBuilder struct.

§Returns

A Result containing the plan response data or an error

pub async fn list_plans( &self, per_page: Option<u8>, page: Option<u8>, status: Option<PlanStatus>, interval: Option<Interval>, amount: Option<u32>, ) -> PaystackResult<Vec<PlanResponseData>>

Lists plans available in your integration

§Arguments

per_page - specify how many records you want to retrieve per page. Defaults to 50 if None
page - specify exactly what page you want to retrieve. Defaults to 1 if None
status - Optional parameter to filter list by plans with specified status
interval - Optional parameter to filter list by plans with specified interval
amount- Optional parameter to filter list by plans with specified amount using the supported currency

§Returns

A Result containing a vector of plan response data or an error

pub async fn fetch_plan( &self, id_or_code: String, ) -> PaystackResult<PlanResponseData>

Get details of a plan on your integration

§Arguments

id_or_code - the plan ID or code you want to fetch

§Returns

A Result containing the plan response data or an error

pub async fn update_plan( &self, id_or_code: String, plan_update_request: PlanUpdateRequest, ) -> PaystackResult<PhantomData<String>>

Update a plan details on your integration

§Arguments

id_or_code - the plan ID or code you want to update
plan_update_request - The request data to update the plan with. Should be created with a PlanUpdateRequestBuilder struct.

§Returns

A Result containing a success message if the plan has been updated

Auto Trait Implementations§

impl<T> Freeze for PlansEndpoints<T>

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

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

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

impl<T> Unpin for PlansEndpoints<T>

impl<T> UnwindSafe for PlansEndpoints<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> 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, 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,