Struct square_rs::client::SquareClient

pub struct SquareClient { /* fields omitted */ }

The SquareClient contains many useful methods allowing for convenient use of the Square API.

Implementations

impl SquareClient

pub fn new(access_token: &str) -> Self

Create a new SquareClient

Arguments

• access_token - The access token for the Square App you want to use the client with is required.

Example: Create a new client

let client = SquareClient::new(ACCESS_TOKEN);

pub fn production(self) -> Self

Set the client to Production Mode

Arguments

This method takes no arguments, as by default the client will use SandBox Mode.

Example

let client = SquareClient::new(ACCESS_TOKEN).production();

pub async fn request<T: ?Sized>(
    &self,
    endpoint: SquareEndpoint,
    json: &T
) -> Result<SquareResponse, SquareError> where
    T: Serialize, 

Sends a request to a given SquareEndpoint

Arguments

• endpoint - The SquareEndpoint to send the request to
• body - The json that will be included in the request. All types that meet the conditions to be deserialized to JSON are accepted.

Example:

self.request(SquareEndpoint::Payments, &payment).await

impl SquareClient

pub fn endpoint(&self, end_point: SquareEndpoint) -> String

impl SquareClient

pub async fn create_payment(
    &self,
    payment: Payment
) -> Result<SquareResponse, SquareError>

Create a payment with the given Payment to the Square API and get the response back

Arguments

• payment - A Payment created from the PaymentBuilder

Trait Implementations

impl Clone for SquareClient

fn clone(&self) -> SquareClient

Returns a copy of the value.

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

Performs copy-assignment from source.