Customization

Model (formerly customization). Deprecated, use Record instead

type Customization implements LegacyCustomAttributeInterface, ListingsMetadata, PropertiesInterface, RelationOnDemandInterface, RemoteModelInterface {
  address(name: String!): CustomAddrress
  addresses(name: String): [CustomAddrress!]
  attachment(name: String!): PrivateFile
  attachments(name: String): [PrivateFile!]
  created_at: JSONDate
  custom_address(name: String!): CustomAddrress
  custom_addresses(name: String): [CustomAddrress!]
  custom_attachment(name: String!): PrivateFile
  custom_attachments(name: String): [PrivateFile!]
  custom_image(name: String!): Image
  custom_images(name: String): [Image!]
  customizable: Customizable
  customizable_id: ID
  customizable_type: String
  deleted_at: JSONDate
  external_id: ID
  human_name: String
  id: ID
  image(name: String!): Image
  images(name: String): [Image!]
  model(
    foreign_property: String = "id"
    join_on_property: String
    model_name: String
  ): ListingsCustomization
  models(
    foreign_property: String!
    join_on_property: String!
    model_name: [String]
  ): [ListingsCustomization!]
  name: String
  properties(select: [PropertiesFieldInput!]): HashObject
  property(name: String!): String
  property_array(name: String!): [String!]
  property_boolean(name: String!): Boolean
  property_float(name: String!): Float
  property_int(name: String!): Int
  property_json(name: String!): JSONPayload
  property_object(name: String!): HashObject
  property_upload(expires_in: Int, name: String!): PropertyUpload
  related_model(
    foreign_property: String = "id"
    join_on_property: String
    model_schema_name: String
  ): ListingsCustomization
  related_models(
    foreign_property: String!
    join_on_property: String!
    model_schema_name: [String]
  ): [ListingsCustomization!]
  related_user(
    foreign_property: String = "id"
    join_on_property: String = "user_id"
  ): User
  remote_model(endpoint: Endpoint!, join_on_property: String!): Customization
  sort_score: [Int]
  updated_at: JSONDate
  user(
    foreign_property: String = "id"
    join_on_property: String = "user_id"
  ): User
  user_id: ID
}

Fields

address (CustomAddrress)

Returns the legacy address property with the given name. Deprecated, store addresses in your own table

• name (String)

Name of the address property

addresses (CustomAddrress)

Returns legacy address properties, optionally only those with the given name.
Deprecated, store addresses in your own table

• name (String)

Name of the address property; all when omitted

attachment (PrivateFile)

Returns the legacy attachment property with the given name. Deprecated, use property_upload

• name (String)

Name of the attachment property

attachments (PrivateFile)

Returns legacy attachment properties, optionally only those with the given name. Deprecated, use property_upload

• name (String)

Name of the attachment property; all when omitted

created_at (JSONDate)

Timestamp of when the object was created, set automatically by the system

custom_address (CustomAddrress)

Returns the legacy address property with the given name. Deprecated, store addresses in your own table

• name (String)

Name of the property

custom_addresses (CustomAddrress)

Returns legacy address properties. Deprecated, store addresses in your own table

• name (String)

Name of the property; all when omitted

custom_attachment (PrivateFile)

Returns the legacy attachment property with the given name. Deprecated, use property_upload

• name (String)

Name of the property

custom_attachments (PrivateFile)

Returns legacy attachment properties. Deprecated, use property_upload

• name (String)

Name of the property; all when omitted

custom_image (Image)

Returns the legacy image property with the given name. Deprecated, use property_upload

• name (String)

Name of the property

custom_images (Image)

Returns legacy image properties. Deprecated, use property_upload

• name (String)

Name of the property; all when omitted

customizable (Customizable)

Object the customization is attached to

customizable_id (ID)

Id of the object the customization is attached to

customizable_type (String)

Type of the object the customization is attached to: Customization, User, UserProfile or Transactable

deleted_at (JSONDate)

Timestamp of when the object was soft deleted, populated by the delete action.
It is also possible to set it manually via update. To undelete, change it back
to an empty value; note that associated objects need to be undeleted manually as well.

external_id (ID)

Identifier of the object in an external system. Used mainly for import/export,
when a third party service is the source of truth

human_name (String)

Human readable name of the model schema

id (ID)

Unique identifier of the object

image (Image)

Returns the legacy image property with the given name. Deprecated, use property_upload

• name (String)

Name of the image property

images (Image)

Returns legacy image properties, optionally only those with the given name. Deprecated, use property_upload

• name (String)

Name of the image property; all when omitted

model (ListingsCustomization)

Returns the related model. Deprecated, use related_model

• foreign_property (String)

Name of the property of the related object that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object whose value is matched against foreign_property

• model_name (String)

Name of the model schema (table) of the related models

models (ListingsCustomization)

Returns related models. Deprecated, use related_models

• foreign_property (String)

Name of the property of the related object that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object whose value is matched against foreign_property

• model_name (String)

Name of the model schema (table) of the related models

name (String)

Name of the model schema

properties (HashObject)

All properties of the object as an object keyed by property name

• select (PropertiesFieldInput)

Properties to return, each converted to the given type (as by the matching
property_* field; other types become strings); all properties as stored when omitted

property (String)

Returns the value of the property with the given name as a string; ex: hair_color: property(name: "hair_color")

• name (String)

Name of the property

property_array (String)

Returns the value of the property with the given name as an array of strings;
a single value is wrapped in an array and no value gives an empty array; ex:
todo_list: property_array(name: "todo_list")

• name (String)

Name of the property

property_boolean (Boolean)

Returns the value of the property with the given name as a boolean. Accepts
true/false values and the strings "t"/"T" and "f"/"F"; any other value returns
an error; ex: enabled: property_boolean(name: "enabled")

• name (String)

Name of the property

property_float (Float)

Returns the value of the property with the given name as a float; returns an
error when the value is not a number; ex: price: property_float(name: "price")

• name (String)

Name of the property

property_int (Int)

Returns the value of the property with the given name as an integer; returns
an error when the value cannot be converted, e.g. "abc" or "1.5"; ex: age:
property_int(name: "age")

• name (String)

Name of the property

property_json (JSONPayload)

Returns the value of the property with the given name as stored, without conversion

• name (String)

Name of the property

property_object (HashObject)

Returns the value of the property with the given name parsed from JSON text
into an object; returns an error when the value is not valid JSON

• name (String)

Name of the property

property_upload (PropertyUpload)

Returns the file stored in the given upload property; ex: avatar: property_upload(name: "avatar") { url }

• expires_in (Int)

Number of seconds for which the returned URLs are valid. When given, signed
URLs are returned; required to access files uploaded with acl private

• name (String)

Name of the upload property

related_model (ListingsCustomization)

Returns the model whose foreign_property equals the value of join_on_property
of this object (belongs-to relation). Legacy relation, use related_record of Record instead

• foreign_property (String)

Name of the property of the related object that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object whose value is matched against foreign_property

• model_schema_name (String)

Name of the model schema (table) of the related models

related_models (ListingsCustomization)

Returns models whose foreign_property equals the value of join_on_property of
this object (has-many relation), at most 10000 at once. Legacy relation, use
related_records of Record instead

• foreign_property (String)

Name of the property of the related object that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object whose value is matched against foreign_property

• model_schema_name (String)

Name of the model schema (table) of the related models

related_user (User)

Returns the user whose foreign_property equals the value of join_on_property
of this object; by default the user whose id is in user_id

• foreign_property (String)

Name of the user attribute that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object holding the user id

remote_model (Customization)

Returns an object loaded from the remote endpoint by the id stored in join_on_property. Deprecated, use remote_records

• endpoint (Endpoint)

Remote endpoint returning the resources for the given ids as JSON

• join_on_property (String)

Name of the property of this object holding the id (or array of ids) to request

sort_score (Int)

When sorting by distance, the distance to the reference point. Deprecated

updated_at (JSONDate)

Timestamp of when the object was last updated, set automatically by the system

user (User)

Returns the related user. Deprecated, use related_user

• foreign_property (String)

Name of the user attribute that must equal the value of join_on_property

• join_on_property (String)

Name of the property of this object holding the user id

user_id (ID)

Id of the user who owns the customization

Interfaces

LegacyCustomAttributeInterface

Deprecated accessors of legacy attachment, image and address properties

ListingsMetadata

Search metadata of results returned by deprecated search queries. Deprecated

PropertiesInterface

Object with properties, including upload properties

RelationOnDemandInterface

Deprecated relations of legacy objects to models and users

RemoteModelInterface

Deprecated relation to an object loaded over HTTP from a remote endpoint