Skip to content

Latest commit

 

History

History
204 lines (133 loc) · 5.48 KB

customer-groups.md

File metadata and controls

204 lines (133 loc) · 5.48 KB
Raw

Customer Groups

customer_groups_api = client.customer_groups

Class Name

CustomerGroupsApi

Methods

List Customer Groups

Retrieves the list of customer groups of a business.

def list_customer_groups(cursor: nil,
                         limit: nil)

Parameters

Parameter Type Tags Description
cursor String Query, Optional A pagination cursor returned by a previous call to this endpoint.
Provide this cursor to retrieve the next set of results for your original query.

For more information, see Pagination.
limit Integer Query, Optional The maximum number of results to return in a single page. This limit is advisory. The response might contain more or fewer results.
If the limit is less than 1 or greater than 50, Square returns a 400 VALUE_TOO_LOW or 400 VALUE_TOO_HIGH error. The default value is 50.

For more information, see Pagination.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type List Customer Groups Response Hash.

Example Usage

result = customer_groups_api.list_customer_groups

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Create Customer Group

Creates a new customer group for a business.

The request must include the name value of the group.

def create_customer_group(body:)

Parameters

Parameter Type Tags Description
body Create Customer Group Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Create Customer Group Response Hash.

Example Usage

body = {
  :group => {
    :name => 'Loyal Customers'
  }
}


result = customer_groups_api.create_customer_group(body: body)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Delete Customer Group

Deletes a customer group as identified by the group_id value.

def delete_customer_group(group_id:)

Parameters

Parameter Type Tags Description
group_id String Template, Required The ID of the customer group to delete.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Delete Customer Group Response Hash.

Example Usage

group_id = 'group_id0'


result = customer_groups_api.delete_customer_group(group_id: group_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Retrieve Customer Group

Retrieves a specific customer group as identified by the group_id value.

def retrieve_customer_group(group_id:)

Parameters

Parameter Type Tags Description
group_id String Template, Required The ID of the customer group to retrieve.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Retrieve Customer Group Response Hash.

Example Usage

group_id = 'group_id0'


result = customer_groups_api.retrieve_customer_group(group_id: group_id)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end

Update Customer Group

Updates a customer group as identified by the group_id value.

def update_customer_group(group_id:,
                          body:)

Parameters

Parameter Type Tags Description
group_id String Template, Required The ID of the customer group to update.
body Update Customer Group Request Hash Body, Required An object containing the fields to POST for the request.

See the corresponding object definition for field details.

Response Type

This method returns a ApiResponse instance. The data property in this instance returns the response data which is of type Update Customer Group Response Hash.

Example Usage

group_id = 'group_id0'

body = {
  :group => {
    :name => 'Loyal Customers'
  }
}


result = customer_groups_api.update_customer_group(
  group_id: group_id,
  body: body
)

if result.success?
  puts result.data
elsif result.error?
  warn result.errors
end