Struct Client

pub struct Client {
    pub default_headers: HttpRequestHeaders,
    pub auth_data: Arc<RwLock<AuthData>>,
    /* private fields */
}

Fields

default_headers: HttpRequestHeaders

auth_data: Arc<RwLock<AuthData>>

Implementations

impl Client

pub fn new( username: String, client_secret: String, environment: Environment, ) -> Result<Self, Box<PayPalError>>

Initialize a new PayPal client. To authenticate, use the authenticate method.

Errors

Errors if the environment URL cannot be parsed. This should never happen, if it does, please open an issue.

pub fn compose_url(&self, request_path: &str) -> Url

Composes an URL from the base URL and the provided path.

Arguments

• request_path - The path to append to the base URL.

pub fn compose_url_with_query( &self, request_path: &str, query: &QueryParams, ) -> Result<Url, Error>

Composes an URL with query parameters.

Arguments

• request_path - The path to append to the base URL.
• query - The query parameters to append to the URL.

Errors

Errors if the query parameters cannot be serialized. This should never happen, if it does, please open an issue.

pub fn with_app_info(self, app_info: &AppInfo) -> Self

pub async fn get<T: Endpoint>( &self, endpoint: &T, ) -> Result<T::ResponseBody, PayPalError>

Performs a GET request.

Arguments

• endpoint - The endpoint to call.

Returns

The response body serialized into the provided type.

Errors

Errors if the request fails or the response body cannot be deserialized.

pub async fn post<T: Endpoint>( &self, endpoint: &T, ) -> Result<T::ResponseBody, PayPalError>

Performs a POST request.

Arguments

• endpoint - The endpoint to call.

Returns

The response body serialized into the provided type.

Errors

Errors if the request fails or the response body cannot be deserialized.

pub async fn patch<T: Endpoint>(&self, endpoint: &T) -> Result<(), PayPalError>

Performs a PATCH request.

Arguments

• endpoint - The endpoint to call.

Returns

The response body serialized into the provided type.

Errors

Errors if the request fails or the response body cannot be deserialized.

pub fn set_request_headers( &self, request_builder: RequestBuilder, headers: &HttpRequestHeaders, ) -> RequestBuilder

Sets the request headers for a request.

Arguments

• request_builder - The request builder to set the headers on.
• headers - The headers to set.

Returns

The request builder with the headers set.

pub async fn authenticate(&self) -> Result<(), PayPalError>

Authenticates the client with PayPal. This gets called automatically when the auth strategy is set to TokenRefresh and the access token is about to expire.

It’s recommended to call this method manually when initializing the client.

Errors

Errors if the request fails or the response body cannot be deserialized.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.