CustomersEndpoints

paystack::endpoints::customers

Struct CustomersEndpoints

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

Expand description

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

Implementations§

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

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

Creates a new CustomersEndpoints instance

§Arguments

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

§Returns

A new CustomersEndpoints instance

pub async fn create_customer( &self, create_customer_request: CreateCustomerRequest, ) -> PaystackResult<CustomerResponseData>

Create customer on your integration

§Arguments

create_customer_request - Contains the information about the customer to be created. It should be built with CreateCustomerRequestBuilder.

§Returns

A Result containing the customer response data or an error

pub async fn list_customers( &self, per_page: Option<u8>, page: Option<u8>, ) -> PaystackResult<Vec<CustomerResponseData>>

Lists customers available on your integration

§Arguments

per_page - Optional number of records to retrieve per page. Default is 50
page - Optional page number to retrieve. Default is 1

§Returns

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

pub async fn fetch_customer( &self, email_or_code: String, ) -> PaystackResult<CustomerResponseData>

Gets details of a customer on your integration

§Arguments

email_or_code - Email or customer code for the customer to fetch

§Returns

A Result containing the customer response data or an error

pub async fn update_customer( &self, customer_code: String, update_customer_request: UpdateCustomerRequest, ) -> PaystackResult<CustomerResponseData>

Updates a customer’s details on your integration

§Arguments

customer_code - The customer’s code
update_customer_request - The data to update the customer with. Should be created with the UpdateCustomerRequestBuilder struct

§Returns

A Result containing the updated customer response data or an error

pub async fn validate_customer( &self, customer_code: String, customer_validation_request: ValidateCustomerRequest, ) -> PaystackResult<PhantomData<String>>

Validates a customer’s identity

§Arguments

customer_code - Email or customer code of customer to be identified
customer_validation_request - The data to validate the customer with. Should be created with the ValidateCustomerRequestBuilder struct

§Returns

A Result containing the validation response or an error

pub async fn whitelist_or_blacklist_customer( &self, customer_code: String, risk_action: RiskAction, ) -> PaystackResult<CustomerResponseData>

Whitelists or blacklists a customer on your integration

§Arguments

customer_code - Customer’s code or email address
risk_action - The risk action to apply to the customer

§Returns

A Result containing the updated customer response data or an error

pub async fn deactivate_authorization( &self, authorization_code: String, ) -> PaystackResult<PhantomData<String>>

Deactivates an authorization when the card needs to be forgotten

§Arguments

authorization_code - Authorization code to be deactivated

§Returns

A Result containing the deactivation response or an error

Trait Implementations§

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

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

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T> Freeze for CustomersEndpoints<T>

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

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

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

impl<T> Unpin for CustomersEndpoints<T>

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