sq_search_customers: Search Customers

In StevenMMortimer/squareupr: An Implementation of 'Square' APIs

Description

Searches the customer profiles associated with a Square account. Calling SearchCustomers without an explicit query parameter returns all customer profiles ordered alphabetically based on given_name and family_name.

Usage

sq_search_customers(cursor = NULL, limit = NULL, query = NULL,
  verbose = FALSE)

Arguments

cursor	character; A pagination cursor returned by a previous call to this endpoint. Typically this is not needed because functions in the package will automatically paginate results.
limit	integer; A limit on the number of results to be returned in a single page. The limit is advisory - the implementation may return more or fewer results. If the supplied limit is negative, zero, or is higher than the maximum limit of 1,000, it will be ignored.
query	list; A list containing filter and sort elements. Calling SearchCustomers without an explicit query parameter will return all customers ordered alphabetically based on given_name and family_name.
verbose	logical; do you want informative messages?

Details

Required permissions: CUSTOMERS_READ

Value

tbl_df of customers

Examples

## Not run: 
my_customers <- sq_search_customers()

## End(Not run)

StevenMMortimer/squareupr documentation built on July 12, 2019, 1:45 a.m.