Customization
No description
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: 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)
Fetch address by name; ex: address: address(name: "office_address")
-
name(String)
addresses (CustomAddrress)
Fetch all addresses, optionally you can filter results by name; ex: home_address: addresses(name: "home")
-
name(String)
attachment (PrivateFile)
Fetch attachment by name; ex: sales_report: attachment(name: "sales_report")
-
name(String)
attachments (PrivateFile)
Fetch all attachments, optionally you can filter results by name; ex: sales_reports: attachments(name: "sales_report")
-
name(String)
created_at (JSONDate)
timestamp of when the record was created, automatically generated by the system
custom_address (CustomAddrress)
Fetch address by name; ex: address: custom_address(name: "office_address")
-
name(String)
custom_addresses (CustomAddrress)
Fetch all addresses, optionaly you can filter results by name; ex: home: custom_addresses(name: "home")
-
name(String)
custom_attachment (PrivateFile)
Fetch attachment by name; ex: sales_report: custom_attachment(name: "sales_report")
-
name(String)
custom_attachments (PrivateFile)
Fetch all attachments, optionally you can filter results by name; ex:
sales_reports: custom_attachments(name: "sales_report")
-
name(String)
custom_image (Image)
Fetch image by name; ex: header: custom_image(name: "header")
-
name(String)
custom_images (Image)
Fetch all images, optionaly you can filter results by name; ex: cat_images: custom_images(name: "cat")
-
name(String)
customizable (Customizable)
customizable_id (ID)
id of a parent, which can other customization, user profile or user
customizable_type (String)
class of a parent - Customization, User or UserProfile
deleted_at (JSONDate)
timestamp of when the record was soft delete, populated by delete action. It
is also possible to manually set it via update. To undelete change it back to
empty value, but please note that associated records would need to be manually
undeleted as well.
external_id (ID)
Used mainly for import/export, if you want to use third party service as a source of truth
human_name (String)
id (ID)
image (Image)
Fetch image by name; ex: header: image(name: "header")
-
name(String)
images (Image)
Fetch all images, optionally you can filter results by name; ex: cat_images: images(name: "cat")
-
name(String)
model (ListingsCustomization)
Defines belongs-to relation with other model; ex: parent: model(model_name:
"parent", join_on_property: "parent_id") { id }
-
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load remote resource with id == join_on_property
-
model_name(String)
Joins model [formaly customization] with custom-model-type-name == model_name
models (ListingsCustomization)
Defines has-many relation with other model; ex: children: models(model_name:
"child", join_on_property: "parent_id", foreign_property: "parent_id") { id }
-
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
-
model_name(String)
Joins model [formaly customization] with custom-model-type-name == model_name
name (String)
properties (HashObject)
List of all properties assigned to the object.
property (String)
Fetch any property by name and return value as a String; ex: hair_color: property(name: "hair_color")
-
name(String)
property_array (String)
Fetch any property by name and return value as an Array of Strings. ex: todo_list: property_array(name: "todo_list")
-
name(String)
property_boolean (Boolean)
Fetch any property by name and return value as a Boolean; ex: price: property_boolean(name: "enabled")
-
name(String)
property_float (Float)
Fetch any property by name and return value as a Float; ex: price: property_float(name: "price")
-
name(String)
property_int (Int)
Fetch any property by name and return value as an Integer; ex: age: property_int(name: "age")
-
name(String)
property_json (JSONPayload)
Fetch any property by name and return value as a JSON string.
-
name(String)
property_object (HashObject)
Fetch any property by name, parse it as a JSON and return object
-
name(String)
property_upload (PropertyUpload)
Fetch any property by name and returns upload details
-
expires_in(Int)
Defines the number of seconds for which the generated url will be accessible. Must be set if acl was set to private
-
name(String)
related_model (ListingsCustomization)
Defines belongs-to relation with other model; ex: parent: model(model_name:
"parent", join_on_property: "parent_id") { id }
-
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load remote resource with id == join_on_property
-
model_schema_name(String)
Joins model [formaly customization] with custom-model-type-name == model_name
related_models (ListingsCustomization)
Defines has-many relation with other model, returns maximum of 10000 records
at once; ex: children: models(model_name: "child", join_on_property:
"parent_id", foreign_property: "parent_id") { id }
-
foreign_property(String)
Load resources with foreign_property == join_on_property
-
join_on_property(String)
Load resources with foreign_property == join_on_property
-
model_schema_name(String)
Joins model [formaly customization] with custom-model-type-name == model_name
related_user (User)
Defines relation with other user, returns maximum of 10000 records at once;
ex: invited_by: user(join_on_property: "invited_by_id") { id }
remote_model (Customization)
Defines relation object accessible over HTTP in JSON collection identified by it's ID.
-
endpoint(Endpoint)
Endpoint that will return resources for given ids in json format
-
join_on_property(String)
Load remote resource with id == join_on_property
sort_score (Int)
when sorting by distance - field contains distance to target location
updated_at (JSONDate)
timestamp of when the record was updated, automatically generated by the system
user (User)
Defines relation with other user; ex: invited_by: user(join_on_property: "invited_by_id") { id }