Enum plaid::api::client::payload::Payload

pub enum Payload<'a> {
    Authenticate(Client<'a>, Institution, Username, Password, Option<PIN>, Option<AuthenticateOptions>),
    Reauthenticate(Client<'a>, Institution, Username, Password, Option<PIN>, Option<AuthenticateOptions>),
    Upgrade(Client<'a>, User, Option<AuthenticateOptions>),
    RemoveUser(Client<'a>, User),
    StepMFA(Client<'a>, User, Response),
    FetchData(Client<'a>, User, Option<FetchDataOptions>),
}

Use this enum to tell the client what you want to do with the associated product.

Variants

Authenticate	Authenticate a user.
Reauthenticate	Re-euthenticate an existing user.
Upgrade	Upgrade the user for access to the given product.
RemoveUser	Delete a user from Plaid.
StepMFA	Send multifactor authentication response.
FetchData	Retrieve data from the product.

Methods

impl<'a> Payload<'a>

fn endpoint<P: Product>(&self, client: &'a Client<'a>, product: P) -> String

Returns the desired endpoint of the payload, given a Product

fn method(&self) -> Method

Returns the hyper::method::Method to be used for the request

Trait Implementations

impl<'a> Encodable for Payload<'a>

fn encode<S: Encoder>(&self, encoder: &mut S) -> Result<(), S::Error>