groups

Documentation

Index

• type Client
  • func NewClient(opts ...option.RequestOption) *Client
  • func (c *Client) Add(ctx context.Context, request *customers.AddGroupsRequest, ...) (*squaregosdk.AddGroupToCustomerResponse, error)
  • func (c *Client) Create(ctx context.Context, request *customers.CreateCustomerGroupRequest, ...) (*squaregosdk.CreateCustomerGroupResponse, error)
  • func (c *Client) Delete(ctx context.Context, request *customers.DeleteGroupsRequest, ...) (*squaregosdk.DeleteCustomerGroupResponse, error)
  • func (c *Client) Get(ctx context.Context, request *customers.GetGroupsRequest, ...) (*squaregosdk.GetCustomerGroupResponse, error)
  • func (c *Client) List(ctx context.Context, request *customers.ListGroupsRequest, ...) (*core.Page[*squaregosdk.CustomerGroup], error)
  • func (c *Client) Remove(ctx context.Context, request *customers.RemoveGroupsRequest, ...) (*squaregosdk.RemoveGroupFromCustomerResponse, error)
  • func (c *Client) Update(ctx context.Context, request *customers.UpdateCustomerGroupRequest, ...) (*squaregosdk.UpdateCustomerGroupResponse, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(opts ...option.RequestOption) *Client

func (*Client) Add

func (c *Client) Add(
	ctx context.Context,
	request *customers.AddGroupsRequest,
	opts ...option.RequestOption,
) (*squaregosdk.AddGroupToCustomerResponse, error)

Adds a group membership to a customer.

The customer is identified by the `customer_id` value and the customer group is identified by the `group_id` value.

func (*Client) Create

func (c *Client) Create(
	ctx context.Context,
	request *customers.CreateCustomerGroupRequest,
	opts ...option.RequestOption,
) (*squaregosdk.CreateCustomerGroupResponse, error)

Creates a new customer group for a business.

The request must include the `name` value of the group.

func (*Client) Delete

func (c *Client) Delete(
	ctx context.Context,
	request *customers.DeleteGroupsRequest,
	opts ...option.RequestOption,
) (*squaregosdk.DeleteCustomerGroupResponse, error)

Deletes a customer group as identified by the `group_id` value.

func (*Client) Get

func (c *Client) Get(
	ctx context.Context,
	request *customers.GetGroupsRequest,
	opts ...option.RequestOption,
) (*squaregosdk.GetCustomerGroupResponse, error)

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

func (*Client) List

func (c *Client) List(
	ctx context.Context,
	request *customers.ListGroupsRequest,
	opts ...option.RequestOption,
) (*core.Page[*squaregosdk.CustomerGroup], error)

Retrieves the list of customer groups of a business.

func (*Client) Remove

func (c *Client) Remove(
	ctx context.Context,
	request *customers.RemoveGroupsRequest,
	opts ...option.RequestOption,
) (*squaregosdk.RemoveGroupFromCustomerResponse, error)

Removes a group membership from a customer.

The customer is identified by the `customer_id` value and the customer group is identified by the `group_id` value.

func (*Client) Update

func (c *Client) Update(
	ctx context.Context,
	request *customers.UpdateCustomerGroupRequest,
	opts ...option.RequestOption,
) (*squaregosdk.UpdateCustomerGroupResponse, error)

Updates a customer group as identified by the `group_id` value.