Struct SquareClient 

pub struct SquareClient { /* private fields */ }

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

const ACCESS_TOKEN:&str = "your_square_access_token";
use square_ox::client::SquareClient;

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

const ACCESS_TOKEN:&str = "your_square_access_token";

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

pub async fn request<T>( &self, verb: Verb, endpoint: SquareAPI, json: Option<&T>, parameters: Option<Vec<(String, String)>>, ) -> Result<SquareResponse, SquareError>

where T: Serialize + ?Sized,

Sends a request to a given SquareAPI

Arguments

• api - The SquareAPI 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:

use env_logger::Builder;
 async {
    use square_ox::{
        api::{
            Verb, SquareAPI, payment::PaymentRequest
        },
        client,
        builder::Builder
    };
    const ACCESS_TOKEN:&str = "your_square_access_token";
    let payment = Builder::from(PaymentRequest::default()).build().await;

    let client = client::SquareClient::new(ACCESS_TOKEN);
    client.request( Verb::POST, SquareAPI::Payments("".to_string()), Some(&payment), None).await.expect("");
};

impl SquareClient

pub fn payments(&self) -> Payments<'_>

impl SquareClient

pub fn bookings(&self) -> Bookings<'_>

impl SquareClient

pub fn locations(&self) -> Locations<'_>

impl SquareClient

pub fn catalog(&self) -> Catalog<'_>

impl SquareClient

pub fn customers(&self) -> Customers<'_>

impl SquareClient

pub fn cards(&self) -> Cards<'_>

impl SquareClient

pub fn checkout(&self) -> Checkout<'_>

impl SquareClient

pub fn inventory(&self) -> Inventory<'_>

Returns an Inventory object through which you can make calls specifically to the Inventory endpoint of the Square API.

Example: Using the inventory endpoint to make a retrieve_count request.

use square_ox::{
        response::{SquareResponse, ResponseError},
        client::SquareClient,
        api::inventory::Inventory,
    };

async {
    let count = SquareClient::new("some_token")
        .inventory()
        .retrieve_count(
            "some_obj_id".to_string(),
            Some("some_loc_id".to_string())
        )
        .await;
    };

impl SquareClient

pub fn sites(&self) -> Sites<'_>

impl SquareClient

pub fn terminal(&self) -> Terminal<'_>

impl SquareClient

pub fn orders(&self) -> Orders<'_>

impl SquareClient

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

Trait Implementations

impl Clone for SquareClient

fn clone(&self) -> SquareClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.