Skip to content

Latest commit

 

History

History
509 lines (350 loc) · 21 KB

customer-custom-attributes.md

File metadata and controls

509 lines (350 loc) · 21 KB
Raw

Customer Custom Attributes

customer_custom_attributes_api = client.customer_custom_attributes

Class Name

CustomerCustomAttributesApi

Methods

List Customer Custom Attribute Definitions

Lists the customer-related custom attribute definitions 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.

def list_customer_custom_attribute_definitions(limit: nil,
                                               cursor: nil)

Parameters

Parameter Type Tags Description
limit Integer Query, Optional The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see Pagination.
cursor String Query, Optional The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request.
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 Custom Attribute Definitions Response Hash.

Example Usage

result = customer_custom_attributes_api.list_customer_custom_attribute_definitions

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

Create Customer Custom Attribute Definition

Creates a customer-related custom attribute definition 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 or 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.

def create_customer_custom_attribute_definition(body:)

Parameters

Parameter Type Tags Description
body Create Customer Custom Attribute Definition 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 Custom Attribute Definition Response Hash.

Example Usage

body = {
  :custom_attribute_definition => {
    :key => 'favoritemovie',
    :name => 'Favorite Movie',
    :description => 'The favorite movie of the customer.',
    :visibility => 'VISIBILITY_HIDDEN'
  }
}


result = customer_custom_attributes_api.create_customer_custom_attribute_definition(body: body)

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

Delete Customer Custom Attribute Definition

Deletes a customer-related custom attribute definition 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.

def delete_customer_custom_attribute_definition(key:)

Parameters

Parameter Type Tags Description
key String Template, Required The key of the custom attribute definition 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 Custom Attribute Definition Response Hash.

Example Usage

key = 'key0'


result = customer_custom_attributes_api.delete_customer_custom_attribute_definition(key: key)

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

Retrieve Customer Custom Attribute Definition

Retrieves a customer-related custom attribute definition 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.

def retrieve_customer_custom_attribute_definition(key:,
                                                  version: nil)

Parameters

Parameter Type Tags Description
key String Template, Required The key of the custom attribute definition to retrieve. If the requesting application
is not the definition owner, you must use the qualified key.
version Integer Query, Optional The current version of the custom attribute definition, which is used for strongly consistent
reads to guarantee that you receive the most up-to-date data. When included in the request,
Square returns the specified version or a higher version if one exists. If the specified version
is higher than the current version, Square returns a BAD_REQUEST error.

Response Type

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

Example Usage

key = 'key0'


result = customer_custom_attributes_api.retrieve_customer_custom_attribute_definition(key: key)

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

Update Customer Custom Attribute Definition

Updates a customer-related custom attribute definition 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.

def update_customer_custom_attribute_definition(key:,
                                                body:)

Parameters

Parameter Type Tags Description
key String Template, Required The key of the custom attribute definition to update.
body Update Customer Custom Attribute Definition 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 Custom Attribute Definition Response Hash.

Example Usage

key = 'key0'

body = {
  :custom_attribute_definition => {
    :description => 'Update the description as desired.',
    :visibility => 'VISIBILITY_READ_ONLY'
  }
}


result = customer_custom_attributes_api.update_customer_custom_attribute_definition(
  key: key,
  body: body
)

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

Bulk Upsert Customer Custom Attributes

Creates or updates custom attributes 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 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.

def bulk_upsert_customer_custom_attributes(body:)

Parameters

Parameter Type Tags Description
body Bulk Upsert Customer Custom Attributes 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 Bulk Upsert Customer Custom Attributes Response Hash.

Example Usage

body = {
  :values => {
    'key0': {
      :customer_id => 'customer_id8',
      :custom_attribute => {}
    },
    'key1': {
      :customer_id => 'customer_id8',
      :custom_attribute => {}
    }
  }
}


result = customer_custom_attributes_api.bulk_upsert_customer_custom_attributes(body: body)

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

List Customer Custom Attributes

Lists the custom attributes associated with a customer profile.

You can use the with_definitions query parameter to also retrieve custom attribute definitions in the same call.

When all response pages are retrieved, the results include all custom attributes that are visible to the requesting application, including those that are owned by other applications and set to VISIBILITY_READ_ONLY or VISIBILITY_READ_WRITE_VALUES.

def list_customer_custom_attributes(customer_id:,
                                    limit: nil,
                                    cursor: nil,
                                    with_definitions: false)

Parameters

Parameter Type Tags Description
customer_id String Template, Required The ID of the target customer profile.
limit Integer Query, Optional The maximum number of results to return in a single paged response. This limit is advisory.
The response might contain more or fewer results. The minimum value is 1 and the maximum value is 100.
The default value is 20. For more information, see Pagination.
cursor String Query, Optional The cursor returned in the paged response from the previous call to this endpoint.
Provide this cursor to retrieve the next page of results for your original request. For more
information, see Pagination.
with_definitions TrueClass | FalseClass Query, Optional Indicates whether to return the custom attribute definition in the definition field of each
custom attribute. Set this parameter to true to get the name and description of each custom
attribute, information about the data type, or other definition details. The default value is false.

Response Type

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

Example Usage

customer_id = 'customer_id8'

with_definitions = false


result = customer_custom_attributes_api.list_customer_custom_attributes(
  customer_id: customer_id,
  with_definitions: with_definitions
)

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

Delete Customer Custom Attribute

Deletes a custom attribute associated with a customer profile.

To delete 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.

def delete_customer_custom_attribute(customer_id:,
                                     key:)

Parameters

Parameter Type Tags Description
customer_id String Template, Required The ID of the target customer profile.
key String Template, Required The key of the custom attribute to delete. This key must match the key of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key.

Response Type

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

Example Usage

customer_id = 'customer_id8'

key = 'key0'


result = customer_custom_attributes_api.delete_customer_custom_attribute(
  customer_id: customer_id,
  key: key
)

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

Retrieve Customer Custom Attribute

Retrieves a custom attribute associated with a customer profile.

You can use the with_definition query parameter to also retrieve the custom attribute definition in the same call.

To retrieve a custom attribute owned 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.

def retrieve_customer_custom_attribute(customer_id:,
                                       key:,
                                       with_definition: false,
                                       version: nil)

Parameters

Parameter Type Tags Description
customer_id String Template, Required The ID of the target customer profile.
key String Template, Required The key of the custom attribute to retrieve. This key must match the key of a custom
attribute definition in the Square seller account. If the requesting application is not the
definition owner, you must use the qualified key.
with_definition TrueClass | FalseClass Query, Optional Indicates whether to return the custom attribute definition in the definition field of
the custom attribute. Set this parameter to true to get the name and description of the custom
attribute, information about the data type, or other definition details. The default value is false.
version Integer Query, Optional The current version of the custom attribute, which is used for strongly consistent reads to
guarantee that you receive the most up-to-date data. When included in the request, Square
returns the specified version or a higher version if one exists. If the specified version is
higher than the current version, Square returns a BAD_REQUEST error.

Response Type

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

Example Usage

customer_id = 'customer_id8'

key = 'key0'

with_definition = false


result = customer_custom_attributes_api.retrieve_customer_custom_attribute(
  customer_id: customer_id,
  key: key,
  with_definition: with_definition
)

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

Upsert Customer Custom Attribute

Creates or updates a custom attribute for a customer profile.

Use this endpoint to set the value of a custom attribute for a specified customer profile. A custom attribute is based on a custom attribute definition in a Square seller account, which is created using the CreateCustomerCustomAttributeDefinition endpoint.

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.

def upsert_customer_custom_attribute(customer_id:,
                                     key:,
                                     body:)

Parameters

Parameter Type Tags Description
customer_id String Template, Required The ID of the target customer profile.
key String Template, Required The key of the custom attribute to create or update. This key must match the key of a
custom attribute definition in the Square seller account. If the requesting application is not
the definition owner, you must use the qualified key.
body Upsert Customer Custom Attribute 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 Upsert Customer Custom Attribute Response Hash.

Example Usage

customer_id = 'customer_id8'

key = 'key0'

body = {
  :custom_attribute => {}
}


result = customer_custom_attributes_api.upsert_customer_custom_attribute(
  customer_id: customer_id,
  key: key,
  body: body
)

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