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# Remove an asset including the physical file. There is no way to revert this
62# operation, use with caution.
63#
64# Arguments
65# physical_file_path: [Not documented]
66admin_asset_delete(physical_file_path: String!): Asset
 
67# Updates asset and physically move the file to the new location
68#
69# Arguments
70# asset: [Not documented]
71# physical_file_path: Identifier of a file which you want to
72# update
73admin_asset_update(
74asset: AssetUpdateInput!,
75physical_file_path: String!
76): Asset
 
77# Creates asset
78#
79# Arguments
80# assets: [Not documented]
81admin_assets_create(assets: [AssetInput!]!): AssetsCreateMutationPayload
 
82# Presign assets urls for given path
83#
84# Arguments
85# paths: [Not documented]
86admin_assets_presign_urls(
87paths: [AssetPresignInput!]!
88): AssetsPresignUrlsMutationPayload
 
89# Creates authorization policy
90#
91# Arguments
92# authorization_policy: [Not documented]
93admin_authorization_policy_create(
94authorization_policy: AuthorizationPolicyInputType!
95): AuthorizationPolicy
 
96# Delete authorization policy
97#
98# Arguments
99# id: deprecated, please use physical_file_path
100# physical_file_path: [Not documented]
101admin_authorization_policy_delete(
102id: ID,
103physical_file_path: String
104): AuthorizationPolicy
 
105# Update authorization policy
106#
107# Arguments
108# authorization_policy: [Not documented]
109# id: deprecated, please use physical_file_path
110# physical_file_path: [Not documented]
111admin_authorization_policy_update(
112authorization_policy: UpdateAuthorizationPolicyInputType!,
113id: ID,
114physical_file_path: String
115): AuthorizationPolicy
 
116# Creates email_notification schema
117#
118# Arguments
119# email_notification: [Not documented]
120admin_email_notification_create(
121email_notification: EmailNotificationInputType!
122): EmailNotification
 
123# Creates email_notification schema
124#
125# Arguments
126# id: deprecated, please use physical_file_path
127# physical_file_path: [Not documented]
128admin_email_notification_delete(
129id: ID,
130physical_file_path: String
131): EmailNotification
 
132# Creates email_notification schema
133#
134# Arguments
135# email_notification: [Not documented]
136# id: deprecated, please use physical_file_path
137# physical_file_path: [Not documented]
138admin_email_notification_update(
139email_notification: UpdateEmailNotificationInputType!,
140id: ID,
141physical_file_path: String
142): EmailNotification
 
143# Creates form
144#
145# Arguments
146# form: [Not documented]
147admin_form_create(form: FormInput!): Form
 
148# Delete form
149#
150# Arguments
151# id: deprecated, please use physical_file_path
152# physical_file_path: [Not documented]
153admin_form_delete(id: ID, physical_file_path: String): Form
 
154# Update form
155#
156# Arguments
157# form: [Not documented]
158# id: deprecated, please use physical_file_path
159# physical_file_path: [Not documented]
160admin_form_update(
161form: UpdateFormInput!,
162id: ID,
163physical_file_path: String
164): Form
 
165# Creates graphql
166#
167# Arguments
168# graphql: [Not documented]
169admin_graphql_create(graphql: GraphqlInputType!): Graphql
 
170# Deletes graphql
171#
172# Arguments
173# physical_file_path: [Not documented]
174admin_graphql_delete(physical_file_path: String!): Graphql
 
175# Updates graphql
176#
177# Arguments
178# graphql: [Not documented]
179# physical_file_path: [Not documented]
180admin_graphql_update(
181graphql: UpdateGraphqlInputType!,
182physical_file_path: String!
183): Graphql
 
184# Creates liquid layout
185#
186# Arguments
187# liquid_layout: [Not documented]
188admin_liquid_layout_create(
189liquid_layout: LiquidLayoutInputType!
190): LiquidLayout
 
191# Deletes liquid layout
192#
193# Arguments
194# id: deprecated, please use physical_file_path
195# physical_file_path: [Not documented]
196admin_liquid_layout_delete(
197id: ID,
198physical_file_path: String
199): LiquidLayout
 
200# Updates liquid layout
201#
202# Arguments
203# id: deprecated, please use physical_file_path
204# liquid_layout: [Not documented]
205# physical_file_path: [Not documented]
206admin_liquid_layout_update(
207id: ID,
208liquid_layout: UpdateLiquidLayoutInputType!,
209physical_file_path: String
210): LiquidLayout
 
211# Creates liquid partial
212#
213# Arguments
214# liquid_partial: [Not documented]
215admin_liquid_partial_create(
216liquid_partial: LiquidPartialInputType!
217): LiquidPartial
 
218# Deletes liquid partial
219#
220# Arguments
221# id: deprecated, please use physical_file_path
222# physical_file_path: [Not documented]
223admin_liquid_partial_delete(
224id: ID,
225physical_file_path: String
226): LiquidPartial
 
227# Updates liquid partial
228#
229# Arguments
230# id: deprecated, please use physical_file_path
231# liquid_partial: [Not documented]
232# physical_file_path: [Not documented]
233admin_liquid_partial_update(
234id: ID,
235liquid_partial: UpdateLiquidPartialInputType!,
236physical_file_path: String
237): LiquidPartial
 
238# Creates model schema
239#
240# Arguments
241# model_schema: [Not documented]
242admin_model_schema_create(
243model_schema: ModelSchemaInputType!
244): ModelSchema
 
245# Deletes model schema
246#
247# Arguments
248# id: deprecated, please use physical_file_path
249# physical_file_path: [Not documented]
250admin_model_schema_delete(
251id: ID,
252physical_file_path: String
253): ModelSchema
 
254# Updates model schema
255#
256# Arguments
257# id: deprecated, please use physical_file_path
258# model_schema: [Not documented]
259# physical_file_path: [Not documented]
260admin_model_schema_update(
261id: ID,
262model_schema: UpdateModelSchemaInputType!,
263physical_file_path: String
264): ModelSchema
 
265# Creates page
266#
267# Arguments
268# page: [Not documented]
269admin_page_create(page: PageInputType!): Page
 
270# Deletes page
271#
272# Arguments
273# id: deprecated, please use physical_file_path
274# physical_file_path: [Not documented]
275admin_page_delete(id: ID, physical_file_path: String): Page
 
276# Updates page
277#
278# Arguments
279# id: deprecated, please use physical_file_path
280# page: [Not documented]
281# physical_file_path: [Not documented]
282admin_page_update(
283id: ID,
284page: UpdatePageInputType!,
285physical_file_path: String
286): Page
 
287# Creates property
288#
289# Arguments
290# property: [Not documented]
291admin_property_create(
292property: StandalonePropertyInputType!
293): Property
 
294# Creates property
295#
296# Arguments
297# id: [Not documented]
298admin_property_delete(id: ID!): Property
 
299# Creates property
300#
301# Arguments
302# id: [Not documented]
303# property: [Not documented]
304admin_property_update(
305id: ID!,
306property: UpdateStandalonePropertyInputType!
307): Property
 
308# Creates sms_notification schema
309#
310# Arguments
311# sms_notification: [Not documented]
312admin_sms_notification_create(
313sms_notification: SmsNotificationInputType!
314): SmsNotification
 
315# Deletes sms_notification schema
316#
317# Arguments
318# id: [Not documented]
319# physical_file_path: [Not documented]
320admin_sms_notification_delete(
321id: ID,
322physical_file_path: String
323): SmsNotification
 
324# Updates sms_notification schema
325#
326# Arguments
327# id: [Not documented]
328# physical_file_path: [Not documented]
329# sms_notification: [Not documented]
330admin_sms_notification_update(
331id: ID,
332physical_file_path: String,
333sms_notification: UpdateSmsNotificationInputType!
334): SmsNotification
 
335# Creates transactable schema
336#
337# Arguments
338# transactable_schema: [Not documented]
339admin_transactable_schema_create(
340transactable_schema: TransactableSchemaInputType!
341): TransactableSchema
 
342# Deletes transactable schema
343#
344# Arguments
345# id: [Not documented]
346admin_transactable_schema_delete(id: ID!): TransactableSchema
 
347# Updates transactable schema
348#
349# Arguments
350# id: [Not documented]
351# transactable_schema: [Not documented]
352admin_transactable_schema_update(
353id: ID!,
354transactable_schema: UpdateTransactableSchemaInputType!
355): TransactableSchema
 
356# Creates user_profile schema
357#
358# Arguments
359# user_profile_schema: [Not documented]
360admin_user_profile_schema_create(
361user_profile_schema: UserProfileSchemaInputType!
362): UserProfileSchema
 
363# Deletes user_profile schema
364#
365# Arguments
366# id: deprecated, please use physical_file_path
367# physical_file_path: [Not documented]
368admin_user_profile_schema_delete(
369id: ID,
370physical_file_path: String
371): UserProfileSchema
 
372# Updates user_profile schema
373#
374# Arguments
375# id: deprecated, please use physical_file_path
376# physical_file_path: [Not documented]
377# user_profile_schema: [Not documented]
378admin_user_profile_schema_update(
379id: ID,
380physical_file_path: String,
381user_profile_schema: UpdateUserProfileSchemaInputType!
382): UserProfileSchema
 
383# Arguments
384# data: Variables that will be accesible in liquid
385# template: Template defined in app/api_calls
386api_call_send(data: HashObject, template: NotificationTemplateInput): ApiCallSendPayload
 
387# Arguments
388# name: Name of the constant you want to set
389# value: Value of the constant, which will be securely store
390constant_set(name: String!, value: String!): EncryptedConstant!
 
391# Arguments
392# name: Name of the constant you want to unset
393constant_unset(name: String!): EncryptedConstant
 
394# Arguments
395# customization: [Not documented]
396# form_configuration_name: deprecated, use form_name
397# form_name: name of the form which whitelist attributes which
398# can be saved. All notifications and callbacks associated with the form will be
399# triggered. if left blank, all attributes will be allowed
400# model: [Not documented]
401customization_create(
402customization: CustomizationInputType,
403form_configuration_name: String,
404form_name: String,
405model: CustomizationInputType
406): Customization!
 
407# Updates a customization
408#
409# Arguments
410# customization: [Not documented]
411# form_configuration_name: deprecated, use form_name
412# form_name: name of the form which whitelist attributes which
413# can be saved. All notifications and callbacks associated with the form will be
414# triggered. if left blank, all attributes will be allowed
415# id: [Not documented]
416# model: [Not documented]
417customization_update(
418customization: CustomizationInputType,
419form_configuration_name: String,
420form_name: String,
421id: ID!,
422model: CustomizationInputType
423): Customization!
 
424# Schedules data export of either models, users or both, similarly to pos-cli,
425# with the difference it is capable of additional filtering and sorting. Returns
426# ID of an export task, which can be queries same way as pos-cli does its check.
427# Generated CSVs are compatible with pos-cli data import.
428#
429# Arguments
430# models: provide at least empty hash if you want models to be
431# exported
432# users: provide at least empty hash if you want users to be
433# exported
434data_export(
435models: DataExportModelsInput,
436users: DataExportUsersInput
437): DataExport!
 
438# Email will be queued to send
439#
440# Arguments
441# data: Variables that will be accesible in liquild
442# template: Template defined in app/emails
443email_send(data: HashObject, template: NotificationTemplateInput): NotificationSendEmailPayload
 
444# Arguments
445# fields: Values for fields defined in associated form. Might
446# include "id" key which will identify the resource in case id argument is blank.
447# form_name: Name of the form which should be submitted
448# id: id of a resource to be updated; can also be provided as
449# "id" key in "fields" hash (if both are present, this argument takes precedence).
450form_submit(fields: HashObject!, form_name: String!, id: ID): FormSubmitPayload
 
451# Arguments
452# _id_remap: Remap ids, when disabled all ids needs to be an
453# Integer
454# _index_rebuild: Rebuilds index for full text search queries
455# models: [Not documented]
456import_models(
457_id_remap: Boolean,
458_index_rebuild: Boolean,
459models: [CustomizationImport!]!
460): ImportCustomizationsMutationPayload
 
461# Arguments
462# _id_remap: Remap ids, when disabled all ids needs to be an
463# Integer
464# _index_rebuild: Rebuilds index for full text search queries
465# users: [Not documented]
466import_users(
467_id_remap: Boolean,
468_index_rebuild: Boolean,
469users: [UserImport!]!
470): ImportUsersMutationPayload
 
471# Check JWT token and Sign In User
472#
473# Arguments
474# jwt_algorithm: [Not documented]
475# jwt_token: [Not documented]
476jwt_decode_and_set_session(
477jwt_algorithm: JwtAlgorithm,
478jwt_token: String!
479): User
 
480# Creates a MarketplaceLogEntryMutation
481#
482# Arguments
483# message: [Not documented]
484# type: [Not documented]
485log(message: Any!, type: LogEntryType!): LogEntry
 
486# Arguments
487# customization: [Not documented]
488# form_configuration_name: deprecated, use form_name
489# form_name: name of the form which whitelist attributes which
490# can be saved. All notifications and callbacks associated with the form will be
491# triggered. if left blank, all attributes will be allowed
492# model: [Not documented]
493model_create(
494customization: CustomizationInputType,
495form_configuration_name: String,
496form_name: String,
497model: CustomizationInputType
498): Model!
 
499# Remove a customization
500#
501# Arguments
502# form_configuration_name: deprecated, use form_name
503# form_name: name of the form which whitelist attributes which
504# can be saved. All notifications and callbacks associated with the form will be
505# triggered. if left blank, all attributes will be allowed
506# id: [Not documented]
507model_delete(
508form_configuration_name: String,
509form_name: String,
510id: ID!
511): Model!
 
512# Updates a customization
513#
514# Arguments
515# customization: [Not documented]
516# form_configuration_name: deprecated, use form_name
517# form_name: name of the form which whitelist attributes which
518# can be saved. All notifications and callbacks associated with the form will be
519# triggered. if left blank, all attributes will be allowed
520# id: [Not documented]
521# model: [Not documented]
522model_update(
523customization: CustomizationInputType,
524form_configuration_name: String,
525form_name: String,
526id: ID!,
527model: CustomizationInputType
528): Model!
 
529# Remove all models, beware there is no coming back!
530#
531# Arguments
532# all_custom_model_types: Deprecated, use all_model_schemas
533# all_model_schemas: Mark this if you really want to remove all
534# models
535# custom_model_type_name: Deprecated, use model_schema_name
536# filter: [Not documented]
537# model_schema_name: [Not documented]
538# sync: Set to true if you want it to run synchronously
539models_delete_all(
540all_custom_model_types: Boolean,
541all_model_schemas: Boolean,
542custom_model_type_name: String,
543filter: ModelsFilterInput,
544model_schema_name: String,
545sync: Boolean
546): ObjectCount!
 
547# Update all models matching filter conditions; use only for small result set, for
548# larger amount of results use import feature
549#
550# Arguments
551# filter: [Not documented]
552# model: [Not documented]
553# model_schema_name: [Not documented]
554# sync: Set to true if you want it to run synchronously
555models_update_all(
556filter: ModelsFilterInput,
557model: CustomizationInputType!,
558model_schema_name: String!,
559sync: Boolean
560): ObjectCount!
 
561# Generate presigned url where you can upload image. Include image processing.
562#
563# Arguments
564# include_content_type: Set to true if you want to include a
565# content type in the POST request to S3. Useful in some cases where the default
566# provided by S3 will not do, like for example for SVG files
567# model_schema_name: Name of the model schema to which the
568# property belomgs. Must be blank if property is defined directly in user.yml
569# property_name: name of the property of type upload
570# user: Must be set to true if property is defined directly in
571# user.yml and not in a Model Schema
572property_upload_presigned_url(
573include_content_type: Boolean,
574model_schema_name: String,
575property_name: String!,
576user: Boolean
577): PropertyUploadPresignedUrl!
 
578# Adds a field to session
579#
580# Arguments
581# name: [Not documented]
582# value: [Not documented]
583session_create_field(name: String!, value: Any!): HashObject
 
584# Adds a field to session
585#
586# Arguments
587# name: [Not documented]
588session_delete_field(name: String!): HashObject
 
589# Sms will be queued to send
590#
591# Arguments
592# data: Variables that will be accesible in liquid
593# template: Template defined in app/api_calls
594sms_send(data: HashObject, template: NotificationTemplateInput): SmsSendPayload
 
595# Arguments
596# models: [Not documented]
597update_models(models: [ModelUpdate!]!): UpdateCustomizationsMutationPayload
 
598# Arguments
599# users: [Not documented]
600update_users(users: [UserUpdate!]!): UpdateUsersMutationPayload
 
601# Creates user
602#
603# Arguments
604# form_configuration_name: deprecated, use form_name
605# form_name: name of the form which whitelist attributes which
606# can be saved. All notifications and callbacks associated with the form will be
607# triggered. if left blank, all attributes will be allowed
608# id: [Not documented]
609# user: [Not documented]
610user_create(
611form_configuration_name: String,
612form_name: String,
613id: ID,
614user: UserInputType!
615): User
 
616# Deletes a user
617#
618# Arguments
619# form_configuration_name: deprecated, use form_name
620# form_name: name of the form which whitelist attributes which
621# can be saved. All notifications and callbacks associated with the form will be
622# triggered. if left blank, all attributes will be allowed
623# id: [Not documented]
624user_delete(form_configuration_name: String, form_name: String, id: ID!): User
 
625# Arguments
626# form_configuration_name: deprecated, use form_name
627# form_name: name of the form which whitelist attributes which
628# can be saved. All notifications and callbacks associated with the form will be
629# triggered. if left blank, all attributes will be allowed
630# profile_type: [Not documented]
631# user_id: [Not documented]
632user_profile_delete(
633form_configuration_name: String,
634form_name: String,
635profile_type: String!,
636user_id: ID!
637): Profile!
 
638# Remove all user profiles, beware there is no coming back!
639#
640# Arguments
641# all_user_profile_types: Mark this if you really want to remove
642# all user_profiles
643# user_profile_type_name: [Not documented]
644user_profiles_delete_all(
645all_user_profile_types: Boolean,
646user_profile_type_name: String
647): ObjectCount!
 
648# Sign In User
649#
650# Arguments
651# email: [Not documented]
652# form_configuration_name: deprecated, use form_name
653# form_name: name of the form which whitelist attributes which
654# can be saved. All notifications and callbacks associated with the form will be
655# triggered. if left blank, all attributes will be allowed
656# password: [Not documented]
657# remember_me: [Not documented]
658user_session_create(
659email: String,
660form_configuration_name: String,
661form_name: String,
662password: String!,
663remember_me: String
664): User
 
665# Sign Out User
666#
667# Arguments
668# form_configuration_name: deprecated, use form_name
669# form_name: name of the form which whitelist attributes which
670# can be saved. All notifications and callbacks associated with the form will be
671# triggered. if left blank, all attributes will be allowed
672user_session_destroy(
673form_configuration_name: String,
674form_name: String
675): HashObject
 
676# Updates current_user
677#
678# Arguments
679# form_configuration_name: deprecated, use form_name
680# form_name: name of the form which whitelist attributes which
681# can be saved. All notifications and callbacks associated with the form will be
682# triggered. if left blank, all attributes will be allowed
683# id: when not provided we try to use current_user
684# user: [Not documented]
685user_update(
686form_configuration_name: String,
687form_name: String,
688id: ID,
689user: UserInputType!
690): User
 
691# Remove all users, beware there is no coming back!
692#
693# Arguments
694# all_users: If filter options are not specified, this must be
695# checked
696# filter: [Not documented]
697# sync: Set to true if you want it to run synchronously
698users_delete_all(
699all_users: Boolean,
700filter: UsersFilterInput,
701sync: Boolean
702): ObjectCount!
 
703# Update all users matching filter conditions; use only for small result set, for
704# larger amount of results use import feature
705#
706# Arguments
707# all_users: If filter options are not specified, this must be
708# checked
709# filter: [Not documented]
710# sync: Set to true if you want it to run synchronously
711# user: [Not documented]
712users_update_all(
713all_users: Boolean,
714filter: UsersFilterInput,
715sync: Boolean,
716user: UserInputType!
717): ObjectCount!
 
718}

# Required by

Note

This element is not required by anyone