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# Remove all pages, beware there is no coming back!
288#
289# Arguments
290# filter: [Not documented]
291# sync: Set to true if you want it to run synchronously
292admin_pages_delete_all(
293filter: PageFilterInput!,
294sync: Boolean
295): ObjectCount!
 
296# Creates property
297#
298# Arguments
299# property: [Not documented]
300admin_property_create(
301property: StandalonePropertyInputType!
302): Property
 
303# Creates property
304#
305# Arguments
306# id: [Not documented]
307admin_property_delete(id: ID!): Property
 
308# Creates property
309#
310# Arguments
311# id: [Not documented]
312# property: [Not documented]
313admin_property_update(
314id: ID!,
315property: UpdateStandalonePropertyInputType!
316): Property
 
317# Creates sms_notification schema
318#
319# Arguments
320# sms_notification: [Not documented]
321admin_sms_notification_create(
322sms_notification: SmsNotificationInputType!
323): SmsNotification
 
324# Deletes sms_notification schema
325#
326# Arguments
327# id: [Not documented]
328# physical_file_path: [Not documented]
329admin_sms_notification_delete(
330id: ID,
331physical_file_path: String
332): SmsNotification
 
333# Updates sms_notification schema
334#
335# Arguments
336# id: [Not documented]
337# physical_file_path: [Not documented]
338# sms_notification: [Not documented]
339admin_sms_notification_update(
340id: ID,
341physical_file_path: String,
342sms_notification: UpdateSmsNotificationInputType!
343): SmsNotification
 
344# Creates table
345#
346# Arguments
347# table: [Not documented]
348admin_table_create(table: TableInputType!): Table
 
349# Deletes table
350#
351# Arguments
352# physical_file_path: [Not documented]
353admin_table_delete(physical_file_path: String!): Table
 
354# Updates table
355#
356# Arguments
357# physical_file_path: [Not documented]
358# table: [Not documented]
359admin_table_update(
360physical_file_path: String!,
361table: UpdateTableInputType!
362): Table
 
363# Creates transactable schema
364#
365# Arguments
366# transactable_schema: [Not documented]
367admin_transactable_schema_create(
368transactable_schema: TransactableSchemaInputType!
369): TransactableSchema
 
370# Deletes transactable schema
371#
372# Arguments
373# id: [Not documented]
374admin_transactable_schema_delete(id: ID!): TransactableSchema
 
375# Updates transactable schema
376#
377# Arguments
378# id: [Not documented]
379# transactable_schema: [Not documented]
380admin_transactable_schema_update(
381id: ID!,
382transactable_schema: UpdateTransactableSchemaInputType!
383): TransactableSchema
 
384# Creates user_profile schema
385#
386# Arguments
387# user_profile_schema: [Not documented]
388admin_user_profile_schema_create(
389user_profile_schema: UserProfileSchemaInputType!
390): UserProfileSchema
 
391# Deletes user_profile schema
392#
393# Arguments
394# id: deprecated, please use physical_file_path
395# physical_file_path: [Not documented]
396admin_user_profile_schema_delete(
397id: ID,
398physical_file_path: String
399): UserProfileSchema
 
400# Updates user_profile schema
401#
402# Arguments
403# id: deprecated, please use physical_file_path
404# physical_file_path: [Not documented]
405# user_profile_schema: [Not documented]
406admin_user_profile_schema_update(
407id: ID,
408physical_file_path: String,
409user_profile_schema: UpdateUserProfileSchemaInputType!
410): UserProfileSchema
 
411# Arguments
412# data: Variables that will be accesible in liquid
413# template: Template defined in app/api_calls
414api_call_send(data: HashObject, template: NotificationTemplateInput): ApiCallSendPayload
 
415# Arguments
416# name: Name of the constant you want to set
417# value: Value of the constant, which will be securely store
418constant_set(name: String!, value: String!): EncryptedConstant!
 
419# Arguments
420# name: Name of the constant you want to unset
421constant_unset(name: String!): EncryptedConstant
 
422# Arguments
423# customization: [Not documented]
424# form_configuration_name: deprecated, use form_name
425# form_name: name of the form which whitelist attributes which
426# can be saved. All notifications and callbacks associated with the form will be
427# triggered. if left blank, all attributes will be allowed
428# model: [Not documented]
429customization_create(
430customization: CustomizationInputType,
431form_configuration_name: String,
432form_name: String,
433model: CustomizationInputType
434): Customization!
 
435# Updates a customization
436#
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# id: [Not documented]
444# model: [Not documented]
445customization_update(
446customization: CustomizationInputType,
447form_configuration_name: String,
448form_name: String,
449id: ID!,
450model: CustomizationInputType
451): Customization!
 
452# Schedules data export of either models, users or both, similarly to pos-cli,
453# with the difference it is capable of additional filtering and sorting. Returns
454# ID of an export task, which can be queries same way as pos-cli does its check.
455# Generated CSVs are compatible with pos-cli data import.
456#
457# Arguments
458# models: provide at least empty hash if you want models to be
459# exported
460# users: provide at least empty hash if you want users to be
461# exported
462data_export(
463models: DataExportModelsInput,
464users: DataExportUsersInput
465): DataExport!
 
466# Email will be queued to send
467#
468# Arguments
469# data: Variables that will be accesible in liquild
470# template: Template defined in app/emails
471email_send(data: HashObject, template: NotificationTemplateInput): NotificationSendEmailPayload
 
472# Arguments
473# fields: Values for fields defined in associated form. Might
474# include "id" key which will identify the resource in case id argument is blank.
475# form_name: Name of the form which should be submitted
476# id: id of a resource to be updated; can also be provided as
477# "id" key in "fields" hash (if both are present, this argument takes precedence).
478form_submit(fields: HashObject!, form_name: String!, id: ID): FormSubmitPayload
 
479# Arguments
480# _id_remap: Remap ids, when disabled all ids needs to be an
481# Integer
482# _index_rebuild: Rebuilds index for full text search queries
483# models: [Not documented]
484import_models(
485_id_remap: Boolean,
486_index_rebuild: Boolean,
487models: [CustomizationImport!]!
488): ImportCustomizationsMutationPayload
 
489# Arguments
490# _id_remap: Remap ids, when disabled all ids needs to be an
491# Integer
492# _index_rebuild: Rebuilds index for full text search queries
493# users: [Not documented]
494import_users(
495_id_remap: Boolean,
496_index_rebuild: Boolean,
497users: [UserImport!]!
498): ImportUsersMutationPayload
 
499# Check JWT token and Sign In User
500#
501# Arguments
502# jwt_algorithm: [Not documented]
503# jwt_token: [Not documented]
504jwt_decode_and_set_session(
505jwt_algorithm: JwtAlgorithm,
506jwt_token: String!
507): User
 
508# Creates a MarketplaceLogEntryMutation
509#
510# Arguments
511# message: [Not documented]
512# type: [Not documented]
513log(message: Any!, type: LogEntryType!): LogEntry
 
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# model: [Not documented]
521model_create(
522customization: CustomizationInputType,
523form_configuration_name: String,
524form_name: String,
525model: CustomizationInputType
526): Model!
 
527# Remove a customization
528#
529# Arguments
530# form_configuration_name: deprecated, use form_name
531# form_name: name of the form which whitelist attributes which
532# can be saved. All notifications and callbacks associated with the form will be
533# triggered. if left blank, all attributes will be allowed
534# id: [Not documented]
535model_delete(
536form_configuration_name: String,
537form_name: String,
538id: ID!
539): Model!
 
540# Updates a customization
541#
542# Arguments
543# customization: [Not documented]
544# form_configuration_name: deprecated, use form_name
545# form_name: name of the form which whitelist attributes which
546# can be saved. All notifications and callbacks associated with the form will be
547# triggered. if left blank, all attributes will be allowed
548# id: [Not documented]
549# model: [Not documented]
550model_update(
551customization: CustomizationInputType,
552form_configuration_name: String,
553form_name: String,
554id: ID!,
555model: CustomizationInputType
556): Model!
 
557# Remove all models, beware there is no coming back!
558#
559# Arguments
560# all_custom_model_types: Deprecated, use all_model_schemas
561# all_model_schemas: Mark this if you really want to remove all
562# models
563# custom_model_type_name: Deprecated, use model_schema_name
564# filter: [Not documented]
565# model_schema_name: [Not documented]
566# sync: Set to true if you want it to run synchronously
567models_delete_all(
568all_custom_model_types: Boolean,
569all_model_schemas: Boolean,
570custom_model_type_name: String,
571filter: ModelsFilterInput,
572model_schema_name: String,
573sync: Boolean
574): ObjectCount!
 
575# Update all models matching filter conditions; use only for small result set, for
576# larger amount of results use import feature
577#
578# Arguments
579# filter: [Not documented]
580# model: [Not documented]
581# model_schema_name: [Not documented]
582# sync: Set to true if you want it to run synchronously
583models_update_all(
584filter: ModelsFilterInput,
585model: CustomizationInputType!,
586model_schema_name: String!,
587sync: Boolean
588): ObjectCount!
 
589# Generate presigned url where you can upload image. Include image processing.
590#
591# Arguments
592# include_content_type: Set to true if you want to include a
593# content type in the POST request to S3. Useful in some cases where the default
594# provided by S3 will not do, like for example for SVG files
595# model_schema_name: deprecated, use table
596# property_name: name of the property of type upload
597# table: Name of the Table schema to which the property belomgs.
598# Must be blank if property is defined directly in user.yml
599# user: Must be set to true if property is defined directly in
600# user.yml and not in a Model Schema
601property_upload_presigned_url(
602include_content_type: Boolean,
603model_schema_name: String,
604property_name: String!,
605table: String,
606user: Boolean
607): PropertyUploadPresignedUrl!
 
608# Creates a record
609#
610# Arguments
611# form_name: name of the form which whitelist attributes which
612# can be saved. All notifications and callbacks associated with the form will be
613# triggered. if left blank, all attributes will be allowed
614# record: [Not documented]
615record_create(form_name: String, record: RecordInputType!): Record!
 
616# Remove a record
617#
618# Arguments
619# form_name: name of the form which whitelist attributes which
620# can be saved. All notifications and callbacks associated with the form will be
621# triggered. if left blank, all attributes will be allowed
622# id: [Not documented]
623record_delete(form_name: String, id: ID!): Model!
 
624# Updates a record
625#
626# Arguments
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# id: [Not documented]
631# record: [Not documented]
632record_update(form_name: String, id: ID!, record: RecordInputType!): Record!
 
633# Remove all records, beware there is no coming back!
634#
635# Arguments
636# any_table: Mark this if you really want to remove records
637# across all tables
638# filter: [Not documented]
639# sync: Set to true if you want it to run synchronously
640# table: [Not documented]
641records_delete_all(
642any_table: Boolean,
643filter: RecordsFilterInput,
644sync: Boolean,
645table: String
646): ObjectCount!
 
647# Update all records matching filter conditions; use only for small result set,
648# for larger amount of results use import feature
649#
650# Arguments
651# filter: [Not documented]
652# record: [Not documented]
653# sync: Set to true if you want it to run synchronously
654# table: [Not documented]
655records_update_all(
656filter: RecordsFilterInput,
657record: RecordInputType!,
658sync: Boolean,
659table: String!
660): ObjectCount!
 
661# Adds a field to session
662#
663# Arguments
664# name: [Not documented]
665# value: [Not documented]
666session_create_field(name: String!, value: Any!): HashObject
 
667# Adds a field to session
668#
669# Arguments
670# name: [Not documented]
671session_delete_field(name: String!): HashObject
 
672# Sms will be queued to send
673#
674# Arguments
675# data: Variables that will be accesible in liquid
676# template: Template defined in app/api_calls
677sms_send(data: HashObject, template: NotificationTemplateInput): SmsSendPayload
 
678# Arguments
679# models: [Not documented]
680update_models(models: [ModelUpdate!]!): UpdateCustomizationsMutationPayload
 
681# Arguments
682# users: [Not documented]
683update_users(users: [UserUpdate!]!): UpdateUsersMutationPayload
 
684# Creates user
685#
686# Arguments
687# form_configuration_name: deprecated, use form_name
688# form_name: name of the form which whitelist attributes which
689# can be saved. All notifications and callbacks associated with the form will be
690# triggered. if left blank, all attributes will be allowed
691# id: [Not documented]
692# user: [Not documented]
693user_create(
694form_configuration_name: String,
695form_name: String,
696id: ID,
697user: UserInputType!
698): User
 
699# Deletes a user
700#
701# Arguments
702# form_configuration_name: deprecated, use form_name
703# form_name: name of the form which whitelist attributes which
704# can be saved. All notifications and callbacks associated with the form will be
705# triggered. if left blank, all attributes will be allowed
706# id: [Not documented]
707user_delete(form_configuration_name: String, form_name: String, id: ID!): User
 
708# Arguments
709# form_configuration_name: deprecated, use form_name
710# form_name: name of the form which whitelist attributes which
711# can be saved. All notifications and callbacks associated with the form will be
712# triggered. if left blank, all attributes will be allowed
713# profile_type: [Not documented]
714# user_id: [Not documented]
715user_profile_delete(
716form_configuration_name: String,
717form_name: String,
718profile_type: String!,
719user_id: ID!
720): Profile!
 
721# Remove all user profiles, beware there is no coming back!
722#
723# Arguments
724# all_user_profile_types: Mark this if you really want to remove
725# all user_profiles
726# user_profile_type_name: [Not documented]
727user_profiles_delete_all(
728all_user_profile_types: Boolean,
729user_profile_type_name: String
730): ObjectCount!
 
731# Sign In User
732#
733# Arguments
734# email: [Not documented]
735# form_configuration_name: deprecated, use form_name
736# form_name: name of the form which whitelist attributes which
737# can be saved. All notifications and callbacks associated with the form will be
738# triggered. if left blank, all attributes will be allowed
739# password: [Not documented]
740# remember_me: [Not documented]
741user_session_create(
742email: String,
743form_configuration_name: String,
744form_name: String,
745password: String!,
746remember_me: String
747): User
 
748# Sign Out User
749#
750# Arguments
751# form_configuration_name: deprecated, use form_name
752# form_name: name of the form which whitelist attributes which
753# can be saved. All notifications and callbacks associated with the form will be
754# triggered. if left blank, all attributes will be allowed
755user_session_destroy(
756form_configuration_name: String,
757form_name: String
758): HashObject
 
759# Updates current_user
760#
761# Arguments
762# form_configuration_name: deprecated, use form_name
763# form_name: name of the form which whitelist attributes which
764# can be saved. All notifications and callbacks associated with the form will be
765# triggered. if left blank, all attributes will be allowed
766# id: when not provided we try to use current_user
767# user: [Not documented]
768user_update(
769form_configuration_name: String,
770form_name: String,
771id: ID,
772user: UserInputType!
773): User
 
774# Remove all users, beware there is no coming back!
775#
776# Arguments
777# all_users: If filter options are not specified, this must be
778# checked
779# filter: [Not documented]
780# sync: Set to true if you want it to run synchronously
781users_delete_all(
782all_users: Boolean,
783filter: UsersFilterInput,
784sync: Boolean
785): ObjectCount!
 
786# Update all users matching filter conditions; use only for small result set, for
787# larger amount of results use import feature
788#
789# Arguments
790# all_users: If filter options are not specified, this must be
791# checked
792# filter: [Not documented]
793# sync: Set to true if you want it to run synchronously
794# user: [Not documented]
795users_update_all(
796all_users: Boolean,
797filter: UsersFilterInput,
798sync: Boolean,
799user: UserInputType!
800): ObjectCount!
 
801}

# Required by

Note

This element is not required by anyone