OBJECT

RootMutation

# GraphQL Schema definition

1type RootMutation {
 
2# Creates an Activity
3#
4# Arguments
5# payload: [Not documented]
6activity_create(payload: ActivityStreamsPayload!): ActivityStreamsActivity
 
7# Delete all activities and clean up ALL feeds
8#
9# Arguments
10# confirm: [Not documented]
11activity_delete_all(confirm: Boolean): [ID]
 
12# add activity to feeds
13#
14# Arguments
15# feed_type: e.i. User, UserPrivate, AuditLog, Images, Posts
16# ids: [Not documented]
17# uuid: [Not documented]
18activity_publish(feed_type: String!, ids: [ID]!, uuid: ID!): JSONDate
 
19# Clean up feeds from selected activities
20#
21# Arguments
22# related_to_object: search for activities related to the Object
23# and then cleanup all feeds from found activities
24# uuid: remove from feeds activity with UUID
25activity_unpublish(
26related_to_object: ActiveRecordReference,
27uuid: ID
28): [ID]
 
29# Clean up ALL feeds
30#
31# Arguments
32# confirm: [Not documented]
33activity_unpublish_all(confirm: Boolean): [ID]
 
34# Creates api call notification
35#
36# Arguments
37# api_call_notification: [Not documented]
38admin_api_call_notification_create(
39api_call_notification: ApiCallNotificationInputType!
40): ApiCallNotification
 
41# Deletes api call notification
42#
43# Arguments
44# id: deprecated, please use physical_file_path
45# physical_file_path: [Not documented]
46admin_api_call_notification_delete(
47id: ID,
48physical_file_path: String
49): ApiCallNotification
 
50# Updates api call notification
51#
52# Arguments
53# api_call_notification: [Not documented]
54# id: deprecated, please use physical_file_path
55# physical_file_path: [Not documented]
56admin_api_call_notification_update(
57api_call_notification: UpdateApiCallNotificationInputType!,
58id: ID,
59physical_file_path: String
60): ApiCallNotification
 
61# Creates asset
62#
63# Arguments
64# assets: [Not documented]
65admin_assets_create(assets: [AssetInput!]!): AssetsCreateMutationPayload
 
66# Presign assets urls for given path
67#
68# Arguments
69# paths: [Not documented]
70admin_assets_presign_urls(
71paths: [AssetPresignInput!]!
72): AssetsPresignUrlsMutationPayload
 
73# Creates authorization policy
74#
75# Arguments
76# authorization_policy: [Not documented]
77admin_authorization_policy_create(
78authorization_policy: AuthorizationPolicyInputType!
79): AuthorizationPolicy
 
80# Delete authorization policy
81#
82# Arguments
83# id: deprecated, please use physical_file_path
84# physical_file_path: [Not documented]
85admin_authorization_policy_delete(
86id: ID,
87physical_file_path: String
88): AuthorizationPolicy
 
89# Update authorization policy
90#
91# Arguments
92# authorization_policy: [Not documented]
93# id: deprecated, please use physical_file_path
94# physical_file_path: [Not documented]
95admin_authorization_policy_update(
96authorization_policy: UpdateAuthorizationPolicyInputType!,
97id: ID,
98physical_file_path: String
99): AuthorizationPolicy
 
100# Creates email_notification schema
101#
102# Arguments
103# email_notification: [Not documented]
104admin_email_notification_create(
105email_notification: EmailNotificationInputType!
106): EmailNotification
 
107# Creates email_notification schema
108#
109# Arguments
110# id: deprecated, please use physical_file_path
111# physical_file_path: [Not documented]
112admin_email_notification_delete(
113id: ID,
114physical_file_path: String
115): EmailNotification
 
116# Creates email_notification schema
117#
118# Arguments
119# email_notification: [Not documented]
120# id: deprecated, please use physical_file_path
121# physical_file_path: [Not documented]
122admin_email_notification_update(
123email_notification: UpdateEmailNotificationInputType!,
124id: ID,
125physical_file_path: String
126): EmailNotification
 
127# Creates form
128#
129# Arguments
130# form: [Not documented]
131admin_form_create(form: FormInput!): Form
 
132# Delete form
133#
134# Arguments
135# id: deprecated, please use physical_file_path
136# physical_file_path: [Not documented]
137admin_form_delete(id: ID, physical_file_path: String): Form
 
138# Update form
139#
140# Arguments
141# form: [Not documented]
142# id: deprecated, please use physical_file_path
143# physical_file_path: [Not documented]
144admin_form_update(
145form: UpdateFormInput!,
146id: ID,
147physical_file_path: String
148): Form
 
149# Creates liquid layout
150#
151# Arguments
152# liquid_layout: [Not documented]
153admin_liquid_layout_create(
154liquid_layout: LiquidLayoutInputType!
155): LiquidLayout
 
156# Deletes liquid layout
157#
158# Arguments
159# id: deprecated, please use physical_file_path
160# physical_file_path: [Not documented]
161admin_liquid_layout_delete(
162id: ID,
163physical_file_path: String
164): LiquidLayout
 
165# Updates liquid layout
166#
167# Arguments
168# id: deprecated, please use physical_file_path
169# liquid_layout: [Not documented]
170# physical_file_path: [Not documented]
171admin_liquid_layout_update(
172id: ID,
173liquid_layout: UpdateLiquidLayoutInputType!,
174physical_file_path: String
175): LiquidLayout
 
176# Creates liquid partial
177#
178# Arguments
179# liquid_partial: [Not documented]
180admin_liquid_partial_create(
181liquid_partial: LiquidPartialInputType!
182): LiquidPartial
 
183# Deletes liquid partial
184#
185# Arguments
186# id: deprecated, please use physical_file_path
187# physical_file_path: [Not documented]
188admin_liquid_partial_delete(
189id: ID,
190physical_file_path: String
191): LiquidPartial
 
192# Updates liquid partial
193#
194# Arguments
195# id: deprecated, please use physical_file_path
196# liquid_partial: [Not documented]
197# physical_file_path: [Not documented]
198admin_liquid_partial_update(
199id: ID,
200liquid_partial: UpdateLiquidPartialInputType!,
201physical_file_path: String
202): LiquidPartial
 
203# Creates model schema
204#
205# Arguments
206# model_schema: [Not documented]
207admin_model_schema_create(
208model_schema: ModelSchemaInputType!
209): ModelSchema
 
210# Deletes model schema
211#
212# Arguments
213# id: deprecated, please use physical_file_path
214# physical_file_path: [Not documented]
215admin_model_schema_delete(
216id: ID,
217physical_file_path: String
218): ModelSchema
 
219# Updates model schema
220#
221# Arguments
222# id: deprecated, please use physical_file_path
223# model_schema: [Not documented]
224# physical_file_path: [Not documented]
225admin_model_schema_update(
226id: ID,
227model_schema: UpdateModelSchemaInputType!,
228physical_file_path: String
229): ModelSchema
 
230# Creates page
231#
232# Arguments
233# page: [Not documented]
234admin_page_create(page: PageInputType!): Page
 
235# Deletes page
236#
237# Arguments
238# id: deprecated, please use physical_file_path
239# physical_file_path: [Not documented]
240admin_page_delete(id: ID, physical_file_path: String): Page
 
241# Updates page
242#
243# Arguments
244# id: deprecated, please use physical_file_path
245# page: [Not documented]
246# physical_file_path: [Not documented]
247admin_page_update(
248id: ID,
249page: UpdatePageInputType!,
250physical_file_path: String
251): Page
 
252# Creates property
253#
254# Arguments
255# property: [Not documented]
256admin_property_create(
257property: StandalonePropertyInputType!
258): Property
 
259# Creates property
260#
261# Arguments
262# id: [Not documented]
263admin_property_delete(id: ID!): Property
 
264# Creates property
265#
266# Arguments
267# id: [Not documented]
268# property: [Not documented]
269admin_property_update(
270id: ID!,
271property: UpdateStandalonePropertyInputType!
272): Property
 
273# Creates sms_notification schema
274#
275# Arguments
276# sms_notification: [Not documented]
277admin_sms_notification_create(
278sms_notification: SmsNotificationInputType!
279): SmsNotification
 
280# Deletes sms_notification schema
281#
282# Arguments
283# id: [Not documented]
284# physical_file_path: [Not documented]
285admin_sms_notification_delete(
286id: ID,
287physical_file_path: String
288): SmsNotification
 
289# Updates sms_notification schema
290#
291# Arguments
292# id: [Not documented]
293# physical_file_path: [Not documented]
294# sms_notification: [Not documented]
295admin_sms_notification_update(
296id: ID,
297physical_file_path: String,
298sms_notification: UpdateSmsNotificationInputType!
299): SmsNotification
 
300# Creates transactable schema
301#
302# Arguments
303# transactable_schema: [Not documented]
304admin_transactable_schema_create(
305transactable_schema: TransactableSchemaInputType!
306): TransactableSchema
 
307# Deletes transactable schema
308#
309# Arguments
310# id: [Not documented]
311admin_transactable_schema_delete(id: ID!): TransactableSchema
 
312# Updates transactable schema
313#
314# Arguments
315# id: [Not documented]
316# transactable_schema: [Not documented]
317admin_transactable_schema_update(
318id: ID!,
319transactable_schema: UpdateTransactableSchemaInputType!
320): TransactableSchema
 
321# Creates user_profile schema
322#
323# Arguments
324# user_profile_schema: [Not documented]
325admin_user_profile_schema_create(
326user_profile_schema: UserProfileSchemaInputType!
327): UserProfileSchema
 
328# Deletes user_profile schema
329#
330# Arguments
331# id: deprecated, please use physical_file_path
332# physical_file_path: [Not documented]
333admin_user_profile_schema_delete(
334id: ID,
335physical_file_path: String
336): UserProfileSchema
 
337# Updates user_profile schema
338#
339# Arguments
340# id: deprecated, please use physical_file_path
341# physical_file_path: [Not documented]
342# user_profile_schema: [Not documented]
343admin_user_profile_schema_update(
344id: ID,
345physical_file_path: String,
346user_profile_schema: UpdateUserProfileSchemaInputType!
347): UserProfileSchema
 
348# Arguments
349# data: Variables that will be accesible in liquid
350# template: Template defined in app/api_calls
351api_call_send(data: HashObject, template: NotificationTemplateInput): ApiCallSendPayload
 
352# Arguments
353# name: Name of the constant you want to set
354# value: Value of the constant, which will be securely store
355constant_set(name: String!, value: String!): EncryptedConstant!
 
356# Arguments
357# name: Name of the constant you want to unset
358constant_unset(name: String!): EncryptedConstant
 
359# Arguments
360# customization: [Not documented]
361# form_configuration_name: deprecated, use form_name
362# form_name: name of the form which whitelist attributes which
363# can be saved. All notifications and callbacks associated with the form will be
364# triggered. if left blank, all attributes will be allowed
365# model: [Not documented]
366customization_create(
367customization: CustomizationInputType,
368form_configuration_name: String,
369form_name: String,
370model: CustomizationInputType
371): Customization!
 
372# Updates a customization
373#
374# Arguments
375# customization: [Not documented]
376# form_configuration_name: deprecated, use form_name
377# form_name: name of the form which whitelist attributes which
378# can be saved. All notifications and callbacks associated with the form will be
379# triggered. if left blank, all attributes will be allowed
380# id: [Not documented]
381# model: [Not documented]
382customization_update(
383customization: CustomizationInputType,
384form_configuration_name: String,
385form_name: String,
386id: ID!,
387model: CustomizationInputType
388): Customization!
 
389# Email will be queued to send
390#
391# Arguments
392# data: Variables that will be accesible in liquild
393# template: Template defined in app/emails
394email_send(data: HashObject, template: NotificationTemplateInput): NotificationSendEmailPayload
 
395# Arguments
396# fields: Values for fields defined in associated form. Might
397# include "id" key which will identify the resource in case id argument is blank.
398# form_name: Name of the form which should be submitted
399# id: id of a resource to be updated; can also be provided as
400# "id" key in "fields" hash (if both are present, this argument takes precedence).
401form_submit(fields: HashObject!, form_name: String!, id: ID): FormSubmitPayload
 
402# Arguments
403# _id_remap: Remap ids, when disabled all ids needs to be an
404# Integer
405# _index_rebuild: Rebuilds index for full text search queries
406# models: [Not documented]
407import_models(
408_id_remap: Boolean,
409_index_rebuild: Boolean,
410models: [CustomizationImport!]!
411): ImportCustomizationsMutationPayload
 
412# Arguments
413# _id_remap: Remap ids, when disabled all ids needs to be an
414# Integer
415# _index_rebuild: Rebuilds index for full text search queries
416# users: [Not documented]
417import_users(
418_id_remap: Boolean,
419_index_rebuild: Boolean,
420users: [UserImport!]!
421): ImportUsersMutationPayload
 
422# Check JWT token and Sign In User
423#
424# Arguments
425# jwt_algorithm: [Not documented]
426# jwt_token: [Not documented]
427jwt_decode_and_set_session(
428jwt_algorithm: JwtAlgorithm,
429jwt_token: String!
430): User
 
431# Creates a MarketplaceLogEntryMutation
432#
433# Arguments
434# message: [Not documented]
435# type: [Not documented]
436log(message: Any!, type: LogEntryType!): LogEntry
 
437# Arguments
438# customization: [Not documented]
439# form_configuration_name: deprecated, use form_name
440# form_name: name of the form which whitelist attributes which
441# can be saved. All notifications and callbacks associated with the form will be
442# triggered. if left blank, all attributes will be allowed
443# model: [Not documented]
444model_create(
445customization: CustomizationInputType,
446form_configuration_name: String,
447form_name: String,
448model: CustomizationInputType
449): Model!
 
450# Remove a customization
451#
452# Arguments
453# form_configuration_name: deprecated, use form_name
454# form_name: name of the form which whitelist attributes which
455# can be saved. All notifications and callbacks associated with the form will be
456# triggered. if left blank, all attributes will be allowed
457# id: [Not documented]
458model_delete(
459form_configuration_name: String,
460form_name: String,
461id: ID!
462): Model!
 
463# Updates a customization
464#
465# Arguments
466# customization: [Not documented]
467# form_configuration_name: deprecated, use form_name
468# form_name: name of the form which whitelist attributes which
469# can be saved. All notifications and callbacks associated with the form will be
470# triggered. if left blank, all attributes will be allowed
471# id: [Not documented]
472# model: [Not documented]
473model_update(
474customization: CustomizationInputType,
475form_configuration_name: String,
476form_name: String,
477id: ID!,
478model: CustomizationInputType
479): Model!
 
480# Remove all models, beware there is no coming back!
481#
482# Arguments
483# all_custom_model_types: Deprecated, use all_model_schemas
484# all_model_schemas: Mark this if you really want to remove all
485# models
486# custom_model_type_name: Deprecated, use model_schema_name
487# filter: [Not documented]
488# model_schema_name: [Not documented]
489models_delete_all(
490all_custom_model_types: Boolean,
491all_model_schemas: Boolean,
492custom_model_type_name: String,
493filter: ModelsFilterInput,
494model_schema_name: String
495): ObjectCount!
 
496# Update all models matching filter conditions; use only for small result set, for
497# larger amount of results use import feature
498#
499# Arguments
500# filter: [Not documented]
501# model: [Not documented]
502# model_schema_name: [Not documented]
503models_update_all(
504filter: ModelsFilterInput,
505model: CustomizationInputType!,
506model_schema_name: String!
507): ObjectCount!
 
508# Generate presigned url where you can upload image. Include image processing.
509#
510# Arguments
511# model_schema_name: Name of the model schema to which the
512# property belomgs. Must be blank if property is defined directly in user.yml
513# property_name: name of the property of type upload
514# user: Must be set to true if property is defined directly in
515# user.yml and not in a Model Schema
516property_upload_presigned_url(
517model_schema_name: String,
518property_name: String!,
519user: Boolean
520): PropertyUploadPresignedUrl!
 
521# Adds a field to session
522#
523# Arguments
524# name: [Not documented]
525# value: [Not documented]
526session_create_field(name: String!, value: Any!): HashObject
 
527# Adds a field to session
528#
529# Arguments
530# name: [Not documented]
531session_delete_field(name: String!): HashObject
 
532# Sms will be queued to send
533#
534# Arguments
535# data: Variables that will be accesible in liquid
536# template: Template defined in app/api_calls
537sms_send(data: HashObject, template: NotificationTemplateInput): SmsSendPayload
 
538# Arguments
539# models: [Not documented]
540update_models(models: [ModelUpdate!]!): UpdateCustomizationsMutationPayload
 
541# Arguments
542# users: [Not documented]
543update_users(users: [UserUpdate!]!): UpdateUsersMutationPayload
 
544# Creates user
545#
546# Arguments
547# form_configuration_name: deprecated, use form_name
548# form_name: name of the form which whitelist attributes which
549# can be saved. All notifications and callbacks associated with the form will be
550# triggered. if left blank, all attributes will be allowed
551# id: [Not documented]
552# user: [Not documented]
553user_create(
554form_configuration_name: String,
555form_name: String,
556id: ID,
557user: UserInputType!
558): User
 
559# Deletes a user
560#
561# Arguments
562# form_configuration_name: deprecated, use form_name
563# form_name: name of the form which whitelist attributes which
564# can be saved. All notifications and callbacks associated with the form will be
565# triggered. if left blank, all attributes will be allowed
566# id: [Not documented]
567user_delete(form_configuration_name: String, form_name: String, id: ID!): User
 
568# Arguments
569# form_configuration_name: deprecated, use form_name
570# form_name: name of the form which whitelist attributes which
571# can be saved. All notifications and callbacks associated with the form will be
572# triggered. if left blank, all attributes will be allowed
573# profile_type: [Not documented]
574# user_id: [Not documented]
575user_profile_delete(
576form_configuration_name: String,
577form_name: String,
578profile_type: String!,
579user_id: ID!
580): Profile!
 
581# Remove all user profiles, beware there is no coming back!
582#
583# Arguments
584# all_user_profile_types: Mark this if you really want to remove
585# all user_profiles
586# user_profile_type_name: [Not documented]
587user_profiles_delete_all(
588all_user_profile_types: Boolean,
589user_profile_type_name: String
590): ObjectCount!
 
591# Sign In User
592#
593# Arguments
594# email: [Not documented]
595# form_configuration_name: deprecated, use form_name
596# form_name: name of the form which whitelist attributes which
597# can be saved. All notifications and callbacks associated with the form will be
598# triggered. if left blank, all attributes will be allowed
599# password: [Not documented]
600# remember_me: [Not documented]
601user_session_create(
602email: String,
603form_configuration_name: String,
604form_name: String,
605password: String!,
606remember_me: String
607): User
 
608# Sign Out User
609#
610# Arguments
611# form_configuration_name: deprecated, use form_name
612# form_name: name of the form which whitelist attributes which
613# can be saved. All notifications and callbacks associated with the form will be
614# triggered. if left blank, all attributes will be allowed
615user_session_destroy(
616form_configuration_name: String,
617form_name: String
618): HashObject
 
619# Updates current_user
620#
621# Arguments
622# form_configuration_name: deprecated, use form_name
623# form_name: name of the form which whitelist attributes which
624# can be saved. All notifications and callbacks associated with the form will be
625# triggered. if left blank, all attributes will be allowed
626# id: when not provided we try to use current_user
627# user: [Not documented]
628user_update(
629form_configuration_name: String,
630form_name: String,
631id: ID,
632user: UserInputType!
633): User
 
634# Remove all users, beware there is no coming back!
635#
636# Arguments
637# all_users: If filter options are not specified, this must be
638# checked
639# filter: [Not documented]
640users_delete_all(all_users: Boolean, filter: UsersFilterInput): ObjectCount!
 
641# Update all users matching filter conditions; use only for small result set, for
642# larger amount of results use import feature
643#
644# Arguments
645# all_users: If filter options are not specified, this must be
646# checked
647# filter: [Not documented]
648# user: [Not documented]
649users_update_all(
650all_users: Boolean,
651filter: UsersFilterInput,
652user: UserInputType!
653): ObjectCount!
 
654}

# Required by

{% include "alert/note", content: "This element is not required by anyone" %}