forked from saleor/saleor-dashboard
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schema.graphql
29021 lines (22287 loc) · 669 KB
/
schema.graphql
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Groups fields and operations into named groups."""
directive @doc(
"""Name of the grouping category"""
category: String!
) on ENUM | FIELD | FIELD_DEFINITION | INPUT_OBJECT | OBJECT
"""
Create a new address for the customer.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountAddressCreate {
"""A user instance for which the address was created."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Delete an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.
"""
type AccountAddressDelete {
"""A user instance for which the address was deleted."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Updates an address of the logged-in user. Requires one of the following permissions: MANAGE_USERS, IS_OWNER.
"""
type AccountAddressUpdate {
"""A user object for which the address was edited."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Remove user account.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountDelete {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
"""Represents errors in account mutations."""
type AccountError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: AccountErrorCode!
"""A type of address that causes the error."""
addressType: AddressTypeEnum
}
"""An enumeration."""
enum AccountErrorCode {
ACTIVATE_OWN_ACCOUNT
ACTIVATE_SUPERUSER_ACCOUNT
DUPLICATED_INPUT_ITEM
DEACTIVATE_OWN_ACCOUNT
DEACTIVATE_SUPERUSER_ACCOUNT
DELETE_NON_STAFF_USER
DELETE_OWN_ACCOUNT
DELETE_STAFF_ACCOUNT
DELETE_SUPERUSER_ACCOUNT
GRAPHQL_ERROR
INACTIVE
INVALID
INVALID_PASSWORD
LEFT_NOT_MANAGEABLE_PERMISSION
INVALID_CREDENTIALS
NOT_FOUND
OUT_OF_SCOPE_USER
OUT_OF_SCOPE_GROUP
OUT_OF_SCOPE_PERMISSION
PASSWORD_ENTIRELY_NUMERIC
PASSWORD_TOO_COMMON
PASSWORD_TOO_SHORT
PASSWORD_TOO_SIMILAR
PASSWORD_RESET_ALREADY_REQUESTED
REQUIRED
UNIQUE
JWT_SIGNATURE_EXPIRED
JWT_INVALID_TOKEN
JWT_DECODE_ERROR
JWT_MISSING_TOKEN
JWT_INVALID_CSRF_TOKEN
CHANNEL_INACTIVE
MISSING_CHANNEL_SLUG
ACCOUNT_NOT_CONFIRMED
}
"""Fields required to update the user."""
input AccountInput {
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""User language code."""
languageCode: LanguageCodeEnum
"""Billing address of the customer."""
defaultBillingAddress: AddressInput
"""Shipping address of the customer."""
defaultShippingAddress: AddressInput
}
"""Register a new user."""
type AccountRegister {
"""Informs whether users need to confirm their email address."""
requiresConfirmation: Boolean
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
"""Fields required to create a user."""
input AccountRegisterInput {
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""User language code."""
languageCode: LanguageCodeEnum
"""The email address of the user."""
email: String!
"""Password."""
password: String!
"""Base of frontend URL that will be needed to create confirmation URL."""
redirectUrl: String
"""User public metadata."""
metadata: [MetadataInput!]
"""
Slug of a channel which will be used to notify users. Optional when only one channel exists.
"""
channel: String
}
"""
Sends an email with the account removal link for the logged-in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountRequestDeletion {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
Sets a default address for the authenticated user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountSetDefaultAddress {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""
Updates the account of the logged-in user.
Requires one of the following permissions: AUTHENTICATED_USER.
"""
type AccountUpdate {
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
user: User
}
"""Represents user address data."""
type Address implements Node & ObjectWithMetadata {
id: ID!
"""
List of private metadata items. Requires staff permissions to access.
Added in Saleor 3.10.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.10.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.10.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""
List of public metadata items. Can be accessed without permissions.
Added in Saleor 3.10.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.10.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.10.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
firstName: String!
lastName: String!
companyName: String!
streetAddress1: String!
streetAddress2: String!
city: String!
cityArea: String!
postalCode: String!
"""Shop's default country."""
country: CountryDisplay!
countryArea: String!
phone: String
"""Address is user's default shipping address."""
isDefaultShippingAddress: Boolean
"""Address is user's default billing address."""
isDefaultBillingAddress: Boolean
}
"""
Creates user address.
Requires one of the following permissions: MANAGE_USERS.
"""
type AddressCreate {
"""A user instance for which the address was created."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Event sent when new address is created.
Added in Saleor 3.5.
"""
type AddressCreated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The address the event relates to."""
address: Address
}
"""
Deletes an address.
Requires one of the following permissions: MANAGE_USERS.
"""
type AddressDelete {
"""A user instance for which the address was deleted."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Event sent when address is deleted.
Added in Saleor 3.5.
"""
type AddressDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The address the event relates to."""
address: Address
}
input AddressInput {
"""Given name."""
firstName: String
"""Family name."""
lastName: String
"""Company or organization."""
companyName: String
"""Address."""
streetAddress1: String
"""Address."""
streetAddress2: String
"""City."""
city: String
"""District."""
cityArea: String
"""Postal code."""
postalCode: String
"""Country."""
country: CountryCode
"""State or province."""
countryArea: String
"""Phone number."""
phone: String
}
"""
Sets a default address for the given user.
Requires one of the following permissions: MANAGE_USERS.
"""
type AddressSetDefault {
"""An updated user instance."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
}
"""An enumeration."""
enum AddressTypeEnum {
BILLING
SHIPPING
}
"""
Updates an address.
Requires one of the following permissions: MANAGE_USERS.
"""
type AddressUpdate {
"""A user object for which the address was edited."""
user: User
accountErrors: [AccountError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AccountError!]!
address: Address
}
"""
Event sent when address is updated.
Added in Saleor 3.5.
"""
type AddressUpdated implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The address the event relates to."""
address: Address
}
"""Represents address validation rules for a country."""
type AddressValidationData {
countryCode: String!
countryName: String!
addressFormat: String!
addressLatinFormat: String!
allowedFields: [String!]!
requiredFields: [String!]!
upperFields: [String!]!
countryAreaType: String!
countryAreaChoices: [ChoiceValue!]!
cityType: String!
cityChoices: [ChoiceValue!]!
cityAreaType: String!
cityAreaChoices: [ChoiceValue!]!
postalCodeType: String!
postalCodeMatchers: [String!]!
postalCodeExamples: [String!]!
postalCodePrefix: String!
}
"""Represents allocation."""
type Allocation implements Node {
id: ID!
"""
Quantity allocated for orders.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
quantity: Int!
"""
The warehouse were items were allocated.
Requires one of the following permissions: MANAGE_PRODUCTS, MANAGE_ORDERS.
"""
warehouse: Warehouse!
}
"""
Determine the allocation strategy for the channel.
PRIORITIZE_SORTING_ORDER - allocate stocks according to the warehouses' order
within the channel
PRIORITIZE_HIGH_STOCK - allocate stock in a warehouse with the most stock
"""
enum AllocationStrategyEnum {
PRIORITIZE_SORTING_ORDER
PRIORITIZE_HIGH_STOCK
}
"""Represents app data."""
type App implements Node & ObjectWithMetadata {
id: ID!
"""List of private metadata items. Requires staff permissions to access."""
privateMetadata: [MetadataItem!]!
"""
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafield(key: String!): String
"""
Private metadata. Requires staff permissions to access. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
privateMetafields(keys: [String!]): Metadata
"""List of public metadata items. Can be accessed without permissions."""
metadata: [MetadataItem!]!
"""
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafield(key: String!): String
"""
Public metadata. Use `keys` to control which fields you want to include. The default is to include everything.
Added in Saleor 3.3.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
metafields(keys: [String!]): Metadata
"""List of the app's permissions."""
permissions: [Permission!]
"""The date and time when the app was created."""
created: DateTime
"""Determine if app will be set active or not."""
isActive: Boolean
"""Name of the app."""
name: String
"""Type of the app."""
type: AppTypeEnum
"""
Last 4 characters of the tokens.
Requires one of the following permissions: MANAGE_APPS, OWNER.
"""
tokens: [AppToken!]
"""
List of webhooks assigned to this app.
Requires one of the following permissions: MANAGE_APPS, OWNER.
"""
webhooks: [Webhook!]
"""Description of this app."""
aboutApp: String
"""Description of the data privacy defined for this app."""
dataPrivacy: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `dataPrivacyUrl` instead.")
"""URL to details about the privacy policy on the app owner page."""
dataPrivacyUrl: String
"""Homepage of the app."""
homepageUrl: String
"""Support page for the app."""
supportUrl: String
"""URL to iframe with the configuration for the app."""
configurationUrl: String @deprecated(reason: "This field will be removed in Saleor 4.0. Use `appUrl` instead.")
"""URL to iframe with the app."""
appUrl: String
"""
URL to manifest used during app's installation.
Added in Saleor 3.5.
"""
manifestUrl: String
"""Version number of the app."""
version: String
"""JWT token used to authenticate by thridparty app."""
accessToken: String
"""
The App's author name.
Added in Saleor 3.13.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
author: String
"""
App's dashboard extensions.
Added in Saleor 3.1.
"""
extensions: [AppExtension!]!
}
"""
Activate the app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppActivate {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
app: App
}
type AppCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [AppCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type AppCountableEdge {
"""The item at the end of the edge."""
node: App!
"""A cursor for use in pagination."""
cursor: String!
}
"""
Creates a new app. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.
"""
type AppCreate {
"""The newly created authentication token."""
authToken: String
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
app: App
}
"""
Deactivate the app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppDeactivate {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
app: App
}
"""
Deletes an app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppDelete {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
app: App
}
"""
Delete failed installation.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppDeleteFailedInstallation {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
appInstallation: AppInstallation
}
"""
Event sent when app is deleted.
Added in Saleor 3.4.
"""
type AppDeleted implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The application the event relates to."""
app: App
}
type AppError {
"""
Name of a field that caused the error. A value of `null` indicates that the error isn't associated with a particular field.
"""
field: String
"""The error message."""
message: String
"""The error code."""
code: AppErrorCode!
"""List of permissions which causes the error."""
permissions: [PermissionEnum!]
}
"""An enumeration."""
enum AppErrorCode {
FORBIDDEN
GRAPHQL_ERROR
INVALID
INVALID_STATUS
INVALID_PERMISSION
INVALID_URL_FORMAT
INVALID_MANIFEST_FORMAT
INVALID_CUSTOM_HEADERS
MANIFEST_URL_CANT_CONNECT
NOT_FOUND
REQUIRED
UNIQUE
OUT_OF_SCOPE_APP
OUT_OF_SCOPE_PERMISSION
UNSUPPORTED_SALEOR_VERSION
}
"""Represents app data."""
type AppExtension implements Node {
id: ID!
"""List of the app extension's permissions."""
permissions: [Permission!]!
"""Label of the extension to show in the dashboard."""
label: String!
"""URL of a view where extension's iframe is placed."""
url: String!
"""Place where given extension will be mounted."""
mount: AppExtensionMountEnum!
"""Type of way how app extension will be opened."""
target: AppExtensionTargetEnum!
app: App!
"""JWT token used to authenticate by thridparty app extension."""
accessToken: String
}
type AppExtensionCountableConnection {
"""Pagination data for this connection."""
pageInfo: PageInfo!
edges: [AppExtensionCountableEdge!]!
"""A total count of items in the collection."""
totalCount: Int
}
type AppExtensionCountableEdge {
"""The item at the end of the edge."""
node: AppExtension!
"""A cursor for use in pagination."""
cursor: String!
}
input AppExtensionFilterInput {
mount: [AppExtensionMountEnum!]
target: AppExtensionTargetEnum
}
"""All places where app extension can be mounted."""
enum AppExtensionMountEnum {
CUSTOMER_OVERVIEW_CREATE
CUSTOMER_OVERVIEW_MORE_ACTIONS
CUSTOMER_DETAILS_MORE_ACTIONS
PRODUCT_OVERVIEW_CREATE
PRODUCT_OVERVIEW_MORE_ACTIONS
PRODUCT_DETAILS_MORE_ACTIONS
NAVIGATION_CATALOG
NAVIGATION_ORDERS
NAVIGATION_CUSTOMERS
NAVIGATION_DISCOUNTS
NAVIGATION_TRANSLATIONS
NAVIGATION_PAGES
ORDER_DETAILS_MORE_ACTIONS
ORDER_OVERVIEW_CREATE
ORDER_OVERVIEW_MORE_ACTIONS
}
"""
All available ways of opening an app extension.
POPUP - app's extension will be mounted as a popup window
APP_PAGE - redirect to app's page
"""
enum AppExtensionTargetEnum {
POPUP
APP_PAGE
}
"""
Fetch and validate manifest.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppFetchManifest {
manifest: Manifest
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
}
input AppFilterInput {
search: String
isActive: Boolean
type: AppTypeEnum
}
input AppInput {
"""Name of the app."""
name: String
"""List of permission code names to assign to this app."""
permissions: [PermissionEnum!]
}
"""
Install new app by using app manifest. Requires the following permissions: AUTHENTICATED_STAFF_USER and MANAGE_APPS.
"""
type AppInstall {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
appInstallation: AppInstallation
}
input AppInstallInput {
"""Name of the app to install."""
appName: String
"""Url to app's manifest in JSON format."""
manifestUrl: String
"""Determine if app will be set active or not."""
activateAfterInstallation: Boolean = true
"""List of permission code names to assign to this app."""
permissions: [PermissionEnum!]
}
"""Represents ongoing installation of app."""
type AppInstallation implements Node & Job {
id: ID!
"""Job status."""
status: JobStatusEnum!
"""Created date time of job in ISO 8601 format."""
createdAt: DateTime!
"""Date time of job last update in ISO 8601 format."""
updatedAt: DateTime!
"""Job message."""
message: String
appName: String!
manifestUrl: String!
}
"""
Event sent when new app is installed.
Added in Saleor 3.4.
"""
type AppInstalled implements Event {
"""Time of the event."""
issuedAt: DateTime
"""Saleor version that triggered the event."""
version: String
"""The user or application that triggered the event."""
issuingPrincipal: IssuingPrincipal
"""The application receiving the webhook."""
recipient: App
"""The application the event relates to."""
app: App
}
type AppManifestExtension {
"""List of the app extension's permissions."""
permissions: [Permission!]!
"""Label of the extension to show in the dashboard."""
label: String!
"""URL of a view where extension's iframe is placed."""
url: String!
"""Place where given extension will be mounted."""
mount: AppExtensionMountEnum!
"""Type of way how app extension will be opened."""
target: AppExtensionTargetEnum!
}
type AppManifestRequiredSaleorVersion {
"""
Required Saleor version as semver range.
Added in Saleor 3.13.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
constraint: String!
"""
Informs if the Saleor version matches the required one.
Added in Saleor 3.13.
Note: this API is currently in Feature Preview and can be subject to changes at later point.
"""
satisfied: Boolean!
}
type AppManifestWebhook {
"""The name of the webhook."""
name: String!
"""The asynchronous events that webhook wants to subscribe."""
asyncEvents: [WebhookEventTypeAsyncEnum!]
"""The synchronous events that webhook wants to subscribe."""
syncEvents: [WebhookEventTypeSyncEnum!]
"""Subscription query of a webhook"""
query: String!
"""The url to receive the payload."""
targetUrl: String!
}
"""
Retry failed installation of new app.
Requires one of the following permissions: MANAGE_APPS.
"""
type AppRetryInstall {
appErrors: [AppError!]! @deprecated(reason: "This field will be removed in Saleor 4.0. Use `errors` field instead.")
errors: [AppError!]!
appInstallation: AppInstallation
}
enum AppSortField {
"""Sort apps by name."""
NAME
"""Sort apps by creation date."""
CREATION_DATE
}
input AppSortingInput {
"""Specifies the direction in which to sort apps."""
direction: OrderDirection!
"""Sort apps by the selected field."""
field: AppSortField!
}
"""
Event sent when app status has changed.
Added in Saleor 3.4.