customattributedefinitions

Documentation

Index

• type Client
  • func NewClient(opts ...option.RequestOption) *Client
  • func (c *Client) BatchUpsert(ctx context.Context, ...) (*squaregosdk.BatchUpsertCustomerCustomAttributesResponse, error)
  • func (c *Client) Create(ctx context.Context, ...) (*squaregosdk.CreateCustomerCustomAttributeDefinitionResponse, error)
  • func (c *Client) Delete(ctx context.Context, ...) (*squaregosdk.DeleteCustomerCustomAttributeDefinitionResponse, error)
  • func (c *Client) Get(ctx context.Context, request *customers.CustomAttributeDefinitionsGetRequest, ...) (*squaregosdk.GetCustomerCustomAttributeDefinitionResponse, error)
  • func (c *Client) List(ctx context.Context, request *customers.CustomAttributeDefinitionsListRequest, ...) (*core.Page[*squaregosdk.CustomAttributeDefinition], error)
  • func (c *Client) Update(ctx context.Context, ...) (*squaregosdk.UpdateCustomerCustomAttributeDefinitionResponse, error)

Types

type Client

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

func NewClient

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

func (*Client) BatchUpsert

func (c *Client) BatchUpsert(
	ctx context.Context,
	request *customers.BatchUpsertCustomerCustomAttributesRequest,
	opts ...option.RequestOption,
) (*squaregosdk.BatchUpsertCustomerCustomAttributesResponse, error)

Creates or updates [custom attributes](entity:CustomAttribute) for customer profiles as a bulk operation.

Use this endpoint to set the value of one or more custom attributes for one or more customer profiles. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the [CreateCustomerCustomAttributeDefinition](api-endpoint:CustomerCustomAttributes-CreateCustomerCustomAttributeDefinition) endpoint.

This `BulkUpsertCustomerCustomAttributes` endpoint accepts a map of 1 to 25 individual upsert requests and returns a map of individual upsert responses. Each upsert request has a unique ID and provides a customer ID and custom attribute. Each upsert response is returned with the ID of the corresponding request.

To create or update a custom attribute owned by another application, the `visibility` setting must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

func (*Client) Create

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

Creates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account. Use this endpoint to define a custom attribute that can be associated with customer profiles.

A custom attribute definition specifies the `key`, `visibility`, `schema`, and other properties for a custom attribute. After the definition is created, you can call [UpsertCustomerCustomAttribute](api-endpoint:CustomerCustomAttributes-UpsertCustomerCustomAttribute) or [BulkUpsertCustomerCustomAttributes](api-endpoint:CustomerCustomAttributes-BulkUpsertCustomerCustomAttributes) to set the custom attribute for customer profiles in the seller's Customer Directory.

Sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.

func (*Client) Delete

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

Deletes a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.

Deleting a custom attribute definition also deletes the corresponding custom attribute from all customer profiles in the seller's Customer Directory.

Only the definition owner can delete a custom attribute definition.

func (*Client) Get

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

Retrieves a customer-related [custom attribute definition](entity:CustomAttributeDefinition) from a Square seller account.

To retrieve a custom attribute definition created by another application, the `visibility` setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

func (*Client) List

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

Lists the customer-related [custom attribute definitions](entity:CustomAttributeDefinition) that belong to a Square seller account.

When all response pages are retrieved, the results include all custom attribute definitions that are visible to the requesting application, including those that are created by other applications and set to `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes (also known as custom fields) are always set to `VISIBILITY_READ_WRITE_VALUES`.

func (*Client) Update

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

Updates a customer-related [custom attribute definition](entity:CustomAttributeDefinition) for a Square seller account.

Use this endpoint to update the following fields: `name`, `description`, `visibility`, or the `schema` for a `Selection` data type.

Only the definition owner can update a custom attribute definition. Note that sellers can view all custom attributes in exported customer data, including those set to `VISIBILITY_HIDDEN`.