OBJECT

Listing

# GraphQL Schema definition

1type Listing implements ListingCustomAttributeInterface, ListingsMetadata, RemoteModelInterface, RelationOnDemandInterface {
 
2created_at: JSONDate
 
3# Remember to set `listing: { has_creator: true }` in query arguments
4creator: UserListing
 
5creator_id: ID
 
6# Fetch address by name; ex: address: custom_address(name: "office_address")
7#
8# Arguments
9# name: [Not documented]
10custom_address(name: String!): ListingAddress
 
11# Fetch all addresses, optionaly you can filter results by name; ex: home:
12# custom_addresses(name: "home")
13#
14# Arguments
15# name: [Not documented]
16custom_addresses(name: String): [ListingAddress!]
 
17# Fetch attachment by name; ex: sales_report: custom_attachment(name:
18# "sales_report")
19#
20# Arguments
21# name: [Not documented]
22custom_attachment(name: String!): ListingsPrivateFile
 
23# Arguments
24# name: [Not documented]
25custom_attachments(name: String): [ListingsPrivateFile!]
 
26# Fetch image by name; ex: header: custom_image(name: "header")
27#
28# Arguments
29# name: [Not documented]
30custom_image(name: String!): ListingImage
 
31# Fetch all images, optionaly you can filter results by name; ex: cat_images:
32# custom_images(name: "cat")
33#
34# Arguments
35# name: [Not documented]
36custom_images(name: String): [ListingImage!]
 
37# Arguments
38# name: [Not documented]
39# properties: [Not documented]
40# user_id: [Not documented]
41customizations(
42name: String,
43properties: [QueryCustomAttribute],
44user_id: ID
45): [ListingsCustomization!]
 
46deleted_at: JSONDate
 
47external_id: ID
 
48id: ID!
 
49name: String
 
50# List of all properties assigned to the object.
51properties: HashObject
 
52# Fetch any custom attribute by name; ex: hair_color: property(name: "hair_color")
53#
54# Arguments
55# name: [Not documented]
56property(name: String!): String
 
57# Fetch any property of Array type by name, it returns Array in contrast to
58# "property" which returns String; ex: todo_list: property_array(name:
59# "todo_list")
60#
61# Arguments
62# name: [Not documented]
63property_array(name: String!): [String!]
 
64# Fetch any property of JSON type by name, it returns JSON in contrast to
65# "property" which returns String; ex: todo_list: property_json(name: "todo_list")
66#
67# Arguments
68# name: [Not documented]
69property_json(name: String!): JSONPayload
 
70# Defines belongs-to relation with other model; ex: parent: model(model_name:
71# "parent", join_on_property: "parent_id") { id }
72#
73# Arguments
74# foreign_property: Load resources with foreign_property ==
75# join_on_property
76# join_on_property: Load remote resource with id ==
77# join_on_property
78# model_schema_name: Joins model [formaly customization] with
79# custom-model-type-name == model_name
80related_model(
81foreign_property: String,
82join_on_property: String,
83model_schema_name: String
84): ListingsCustomization
 
85# Defines has-many relation with other model, returns maximum of 10000 records at
86# once; ex: children: models(model_name: "child", join_on_property: "parent_id",
87# foreign_property: "parent_id") { id }
88#
89# Arguments
90# foreign_property: Load resources with foreign_property ==
91# join_on_property
92# join_on_property: Load resources with foreign_property ==
93# join_on_property
94# model_schema_name: Joins model [formaly customization] with
95# custom-model-type-name == model_name
96related_models(
97foreign_property: String!,
98join_on_property: String!,
99model_schema_name: [String]
100): [ListingsCustomization!]
 
101# Defines relation with other user, returns maximum of 10000 records at once; ex:
102# invited_by: user(join_on_property: "invited_by_id") { id }
103#
104# Arguments
105# foreign_property: [Not documented]
106# join_on_property: [Not documented]
107related_user(foreign_property: String, join_on_property: String): User
 
108# Defines relation object accessible over HTTP in JSON collection identified by
109# it's ID.
110#
111# Arguments
112# endpoint: Endpoint that will return resources for given ids in
113# json format
114# join_on_property: Load remote resource with id ==
115# join_on_property
116remote_model(endpoint: Endpoint!, join_on_property: String!): Customization
 
117slug: String!
 
118type: String
 
119updated_at: JSONDate
 
120}

# Required by