@vendure/docs 0.0.0-202601211343 → 0.0.0-202601211406

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,1063 @@
1
+ ---
2
+ title: "Enums"
3
+ generated: true
4
+ ---
5
+
6
+
7
+
8
+ ## AdjustmentType {#adjustmenttype}
9
+
10
+ <GraphQLDoc
11
+ type="enum"
12
+ typeName="AdjustmentType"
13
+ typeLinks={{}}
14
+ >
15
+ {`enum AdjustmentType {
16
+ PROMOTION
17
+ DISTRIBUTED_ORDER_PROMOTION
18
+ OTHER
19
+ }`}
20
+ </GraphQLDoc>
21
+
22
+ ## AssetType {#assettype}
23
+
24
+ <GraphQLDoc
25
+ type="enum"
26
+ typeName="AssetType"
27
+ typeLinks={{}}
28
+ >
29
+ {`enum AssetType {
30
+ IMAGE
31
+ VIDEO
32
+ BINARY
33
+ }`}
34
+ </GraphQLDoc>
35
+
36
+ ## CurrencyCode {#currencycode}
37
+
38
+ <GraphQLDoc
39
+ type="enum"
40
+ typeName="CurrencyCode"
41
+ typeLinks={{}}
42
+ >
43
+ {`"""ISO 4217 currency code"""
44
+ enum CurrencyCode {
45
+ """United Arab Emirates dirham"""
46
+ AED
47
+ """Afghan afghani"""
48
+ AFN
49
+ """Albanian lek"""
50
+ ALL
51
+ """Armenian dram"""
52
+ AMD
53
+ """Netherlands Antillean guilder"""
54
+ ANG
55
+ """Angolan kwanza"""
56
+ AOA
57
+ """Argentine peso"""
58
+ ARS
59
+ """Australian dollar"""
60
+ AUD
61
+ """Aruban florin"""
62
+ AWG
63
+ """Azerbaijani manat"""
64
+ AZN
65
+ """Bosnia and Herzegovina convertible mark"""
66
+ BAM
67
+ """Barbados dollar"""
68
+ BBD
69
+ """Bangladeshi taka"""
70
+ BDT
71
+ """Bulgarian lev"""
72
+ BGN
73
+ """Bahraini dinar"""
74
+ BHD
75
+ """Burundian franc"""
76
+ BIF
77
+ """Bermudian dollar"""
78
+ BMD
79
+ """Brunei dollar"""
80
+ BND
81
+ """Boliviano"""
82
+ BOB
83
+ """Brazilian real"""
84
+ BRL
85
+ """Bahamian dollar"""
86
+ BSD
87
+ """Bhutanese ngultrum"""
88
+ BTN
89
+ """Botswana pula"""
90
+ BWP
91
+ """Belarusian ruble"""
92
+ BYN
93
+ """Belize dollar"""
94
+ BZD
95
+ """Canadian dollar"""
96
+ CAD
97
+ """Congolese franc"""
98
+ CDF
99
+ """Swiss franc"""
100
+ CHF
101
+ """Chilean peso"""
102
+ CLP
103
+ """Renminbi (Chinese) yuan"""
104
+ CNY
105
+ """Colombian peso"""
106
+ COP
107
+ """Costa Rican colon"""
108
+ CRC
109
+ """Cuban convertible peso"""
110
+ CUC
111
+ """Cuban peso"""
112
+ CUP
113
+ """Cape Verde escudo"""
114
+ CVE
115
+ """Czech koruna"""
116
+ CZK
117
+ """Djiboutian franc"""
118
+ DJF
119
+ """Danish krone"""
120
+ DKK
121
+ """Dominican peso"""
122
+ DOP
123
+ """Algerian dinar"""
124
+ DZD
125
+ """Egyptian pound"""
126
+ EGP
127
+ """Eritrean nakfa"""
128
+ ERN
129
+ """Ethiopian birr"""
130
+ ETB
131
+ """Euro"""
132
+ EUR
133
+ """Fiji dollar"""
134
+ FJD
135
+ """Falkland Islands pound"""
136
+ FKP
137
+ """Pound sterling"""
138
+ GBP
139
+ """Georgian lari"""
140
+ GEL
141
+ """Ghanaian cedi"""
142
+ GHS
143
+ """Gibraltar pound"""
144
+ GIP
145
+ """Gambian dalasi"""
146
+ GMD
147
+ """Guinean franc"""
148
+ GNF
149
+ """Guatemalan quetzal"""
150
+ GTQ
151
+ """Guyanese dollar"""
152
+ GYD
153
+ """Hong Kong dollar"""
154
+ HKD
155
+ """Honduran lempira"""
156
+ HNL
157
+ """Croatian kuna"""
158
+ HRK
159
+ """Haitian gourde"""
160
+ HTG
161
+ """Hungarian forint"""
162
+ HUF
163
+ """Indonesian rupiah"""
164
+ IDR
165
+ """Israeli new shekel"""
166
+ ILS
167
+ """Indian rupee"""
168
+ INR
169
+ """Iraqi dinar"""
170
+ IQD
171
+ """Iranian rial"""
172
+ IRR
173
+ """Icelandic kr\u00F3na"""
174
+ ISK
175
+ """Jamaican dollar"""
176
+ JMD
177
+ """Jordanian dinar"""
178
+ JOD
179
+ """Japanese yen"""
180
+ JPY
181
+ """Kenyan shilling"""
182
+ KES
183
+ """Kyrgyzstani som"""
184
+ KGS
185
+ """Cambodian riel"""
186
+ KHR
187
+ """Comoro franc"""
188
+ KMF
189
+ """North Korean won"""
190
+ KPW
191
+ """South Korean won"""
192
+ KRW
193
+ """Kuwaiti dinar"""
194
+ KWD
195
+ """Cayman Islands dollar"""
196
+ KYD
197
+ """Kazakhstani tenge"""
198
+ KZT
199
+ """Lao kip"""
200
+ LAK
201
+ """Lebanese pound"""
202
+ LBP
203
+ """Sri Lankan rupee"""
204
+ LKR
205
+ """Liberian dollar"""
206
+ LRD
207
+ """Lesotho loti"""
208
+ LSL
209
+ """Libyan dinar"""
210
+ LYD
211
+ """Moroccan dirham"""
212
+ MAD
213
+ """Moldovan leu"""
214
+ MDL
215
+ """Malagasy ariary"""
216
+ MGA
217
+ """Macedonian denar"""
218
+ MKD
219
+ """Myanmar kyat"""
220
+ MMK
221
+ """Mongolian t\u00F6gr\u00F6g"""
222
+ MNT
223
+ """Macanese pataca"""
224
+ MOP
225
+ """Mauritanian ouguiya"""
226
+ MRU
227
+ """Mauritian rupee"""
228
+ MUR
229
+ """Maldivian rufiyaa"""
230
+ MVR
231
+ """Malawian kwacha"""
232
+ MWK
233
+ """Mexican peso"""
234
+ MXN
235
+ """Malaysian ringgit"""
236
+ MYR
237
+ """Mozambican metical"""
238
+ MZN
239
+ """Namibian dollar"""
240
+ NAD
241
+ """Nigerian naira"""
242
+ NGN
243
+ """Nicaraguan c\u00F3rdoba"""
244
+ NIO
245
+ """Norwegian krone"""
246
+ NOK
247
+ """Nepalese rupee"""
248
+ NPR
249
+ """New Zealand dollar"""
250
+ NZD
251
+ """Omani rial"""
252
+ OMR
253
+ """Panamanian balboa"""
254
+ PAB
255
+ """Peruvian sol"""
256
+ PEN
257
+ """Papua New Guinean kina"""
258
+ PGK
259
+ """Philippine peso"""
260
+ PHP
261
+ """Pakistani rupee"""
262
+ PKR
263
+ """Polish z\u0142oty"""
264
+ PLN
265
+ """Paraguayan guaran\u00ED"""
266
+ PYG
267
+ """Qatari riyal"""
268
+ QAR
269
+ """Romanian leu"""
270
+ RON
271
+ """Serbian dinar"""
272
+ RSD
273
+ """Russian ruble"""
274
+ RUB
275
+ """Rwandan franc"""
276
+ RWF
277
+ """Saudi riyal"""
278
+ SAR
279
+ """Solomon Islands dollar"""
280
+ SBD
281
+ """Seychelles rupee"""
282
+ SCR
283
+ """Sudanese pound"""
284
+ SDG
285
+ """Swedish krona/kronor"""
286
+ SEK
287
+ """Singapore dollar"""
288
+ SGD
289
+ """Saint Helena pound"""
290
+ SHP
291
+ """Sierra Leonean leone"""
292
+ SLL
293
+ """Somali shilling"""
294
+ SOS
295
+ """Surinamese dollar"""
296
+ SRD
297
+ """South Sudanese pound"""
298
+ SSP
299
+ """S\u00E3o Tom\u00E9 and Pr\u00EDncipe dobra"""
300
+ STN
301
+ """Salvadoran col\u00F3n"""
302
+ SVC
303
+ """Syrian pound"""
304
+ SYP
305
+ """Swazi lilangeni"""
306
+ SZL
307
+ """Thai baht"""
308
+ THB
309
+ """Tajikistani somoni"""
310
+ TJS
311
+ """Turkmenistan manat"""
312
+ TMT
313
+ """Tunisian dinar"""
314
+ TND
315
+ """Tongan pa\u02BBanga"""
316
+ TOP
317
+ """Turkish lira"""
318
+ TRY
319
+ """Trinidad and Tobago dollar"""
320
+ TTD
321
+ """New Taiwan dollar"""
322
+ TWD
323
+ """Tanzanian shilling"""
324
+ TZS
325
+ """Ukrainian hryvnia"""
326
+ UAH
327
+ """Ugandan shilling"""
328
+ UGX
329
+ """United States dollar"""
330
+ USD
331
+ """Uruguayan peso"""
332
+ UYU
333
+ """Uzbekistan som"""
334
+ UZS
335
+ """Venezuelan bol\u00EDvar soberano"""
336
+ VES
337
+ """Vietnamese \u0111\u1ED3ng"""
338
+ VND
339
+ """Vanuatu vatu"""
340
+ VUV
341
+ """Samoan tala"""
342
+ WST
343
+ """CFA franc BEAC"""
344
+ XAF
345
+ """East Caribbean dollar"""
346
+ XCD
347
+ """CFA franc BCEAO"""
348
+ XOF
349
+ """CFP franc (franc Pacifique)"""
350
+ XPF
351
+ """Yemeni rial"""
352
+ YER
353
+ """South African rand"""
354
+ ZAR
355
+ """Zambian kwacha"""
356
+ ZMW
357
+ """Zimbabwean dollar"""
358
+ ZWL
359
+ }`}
360
+ </GraphQLDoc>
361
+
362
+ ## DeletionResult {#deletionresult}
363
+
364
+ <GraphQLDoc
365
+ type="enum"
366
+ typeName="DeletionResult"
367
+ typeLinks={{}}
368
+ >
369
+ {`enum DeletionResult {
370
+ """The entity was successfully deleted"""
371
+ DELETED
372
+ """Deletion did not take place, reason given in message"""
373
+ NOT_DELETED
374
+ }`}
375
+ </GraphQLDoc>
376
+
377
+ ## ErrorCode {#errorcode}
378
+
379
+ <GraphQLDoc
380
+ type="enum"
381
+ typeName="ErrorCode"
382
+ typeLinks={{}}
383
+ >
384
+ {`enum ErrorCode {
385
+ UNKNOWN_ERROR
386
+ NATIVE_AUTH_STRATEGY_ERROR
387
+ INVALID_CREDENTIALS_ERROR
388
+ ORDER_STATE_TRANSITION_ERROR
389
+ EMAIL_ADDRESS_CONFLICT_ERROR
390
+ GUEST_CHECKOUT_ERROR
391
+ ORDER_LIMIT_ERROR
392
+ NEGATIVE_QUANTITY_ERROR
393
+ INSUFFICIENT_STOCK_ERROR
394
+ COUPON_CODE_INVALID_ERROR
395
+ COUPON_CODE_EXPIRED_ERROR
396
+ COUPON_CODE_LIMIT_ERROR
397
+ ORDER_MODIFICATION_ERROR
398
+ INELIGIBLE_SHIPPING_METHOD_ERROR
399
+ NO_ACTIVE_ORDER_ERROR
400
+ ORDER_INTERCEPTOR_ERROR
401
+ ORDER_PAYMENT_STATE_ERROR
402
+ INELIGIBLE_PAYMENT_METHOD_ERROR
403
+ PAYMENT_FAILED_ERROR
404
+ PAYMENT_DECLINED_ERROR
405
+ ALREADY_LOGGED_IN_ERROR
406
+ MISSING_PASSWORD_ERROR
407
+ PASSWORD_VALIDATION_ERROR
408
+ PASSWORD_ALREADY_SET_ERROR
409
+ VERIFICATION_TOKEN_INVALID_ERROR
410
+ VERIFICATION_TOKEN_EXPIRED_ERROR
411
+ IDENTIFIER_CHANGE_TOKEN_INVALID_ERROR
412
+ IDENTIFIER_CHANGE_TOKEN_EXPIRED_ERROR
413
+ PASSWORD_RESET_TOKEN_INVALID_ERROR
414
+ PASSWORD_RESET_TOKEN_EXPIRED_ERROR
415
+ NOT_VERIFIED_ERROR
416
+ }`}
417
+ </GraphQLDoc>
418
+
419
+ ## GlobalFlag {#globalflag}
420
+
421
+ <GraphQLDoc
422
+ type="enum"
423
+ typeName="GlobalFlag"
424
+ typeLinks={{}}
425
+ >
426
+ {`enum GlobalFlag {
427
+ TRUE
428
+ FALSE
429
+ INHERIT
430
+ }`}
431
+ </GraphQLDoc>
432
+
433
+ ## HistoryEntryType {#historyentrytype}
434
+
435
+ <GraphQLDoc
436
+ type="enum"
437
+ typeName="HistoryEntryType"
438
+ typeLinks={{}}
439
+ >
440
+ {`enum HistoryEntryType {
441
+ CUSTOMER_REGISTERED
442
+ CUSTOMER_VERIFIED
443
+ CUSTOMER_DETAIL_UPDATED
444
+ CUSTOMER_ADDED_TO_GROUP
445
+ CUSTOMER_REMOVED_FROM_GROUP
446
+ CUSTOMER_ADDRESS_CREATED
447
+ CUSTOMER_ADDRESS_UPDATED
448
+ CUSTOMER_ADDRESS_DELETED
449
+ CUSTOMER_PASSWORD_UPDATED
450
+ CUSTOMER_PASSWORD_RESET_REQUESTED
451
+ CUSTOMER_PASSWORD_RESET_VERIFIED
452
+ CUSTOMER_EMAIL_UPDATE_REQUESTED
453
+ CUSTOMER_EMAIL_UPDATE_VERIFIED
454
+ CUSTOMER_NOTE
455
+ ORDER_STATE_TRANSITION
456
+ ORDER_PAYMENT_TRANSITION
457
+ ORDER_FULFILLMENT
458
+ ORDER_CANCELLATION
459
+ ORDER_REFUND_TRANSITION
460
+ ORDER_FULFILLMENT_TRANSITION
461
+ ORDER_NOTE
462
+ ORDER_COUPON_APPLIED
463
+ ORDER_COUPON_REMOVED
464
+ ORDER_MODIFIED
465
+ ORDER_CUSTOMER_UPDATED
466
+ }`}
467
+ </GraphQLDoc>
468
+
469
+ ## LanguageCode {#languagecode}
470
+
471
+ <GraphQLDoc
472
+ type="enum"
473
+ typeName="LanguageCode"
474
+ typeLinks={{}}
475
+ >
476
+ {`"""
477
+ Languages in the form of a ISO 639-1 language code with optional
478
+ region or script modifier (e.g. de_AT). The selection available is based
479
+ on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
480
+ and includes the major spoken languages of the world and any widely-used variants.
481
+ """
482
+ enum LanguageCode {
483
+ """Afrikaans"""
484
+ af
485
+ """Akan"""
486
+ ak
487
+ """Albanian"""
488
+ sq
489
+ """Amharic"""
490
+ am
491
+ """Arabic"""
492
+ ar
493
+ """Armenian"""
494
+ hy
495
+ """Assamese"""
496
+ as
497
+ """Azerbaijani"""
498
+ az
499
+ """Bambara"""
500
+ bm
501
+ """Bangla"""
502
+ bn
503
+ """Basque"""
504
+ eu
505
+ """Belarusian"""
506
+ be
507
+ """Bosnian"""
508
+ bs
509
+ """Breton"""
510
+ br
511
+ """Bulgarian"""
512
+ bg
513
+ """Burmese"""
514
+ my
515
+ """Catalan"""
516
+ ca
517
+ """Chechen"""
518
+ ce
519
+ """Chinese"""
520
+ zh
521
+ """Simplified Chinese"""
522
+ zh_Hans
523
+ """Traditional Chinese"""
524
+ zh_Hant
525
+ """Church Slavic"""
526
+ cu
527
+ """Cornish"""
528
+ kw
529
+ """Corsican"""
530
+ co
531
+ """Croatian"""
532
+ hr
533
+ """Czech"""
534
+ cs
535
+ """Danish"""
536
+ da
537
+ """Dutch"""
538
+ nl
539
+ """Flemish"""
540
+ nl_BE
541
+ """Dzongkha"""
542
+ dz
543
+ """English"""
544
+ en
545
+ """Australian English"""
546
+ en_AU
547
+ """Canadian English"""
548
+ en_CA
549
+ """British English"""
550
+ en_GB
551
+ """American English"""
552
+ en_US
553
+ """Esperanto"""
554
+ eo
555
+ """Estonian"""
556
+ et
557
+ """Ewe"""
558
+ ee
559
+ """Faroese"""
560
+ fo
561
+ """Finnish"""
562
+ fi
563
+ """French"""
564
+ fr
565
+ """Canadian French"""
566
+ fr_CA
567
+ """Swiss French"""
568
+ fr_CH
569
+ """Fulah"""
570
+ ff
571
+ """Galician"""
572
+ gl
573
+ """Ganda"""
574
+ lg
575
+ """Georgian"""
576
+ ka
577
+ """German"""
578
+ de
579
+ """Austrian German"""
580
+ de_AT
581
+ """Swiss High German"""
582
+ de_CH
583
+ """Greek"""
584
+ el
585
+ """Gujarati"""
586
+ gu
587
+ """Haitian Creole"""
588
+ ht
589
+ """Hausa"""
590
+ ha
591
+ """Hebrew"""
592
+ he
593
+ """Hindi"""
594
+ hi
595
+ """Hungarian"""
596
+ hu
597
+ """Icelandic"""
598
+ is
599
+ """Igbo"""
600
+ ig
601
+ """Indonesian"""
602
+ id
603
+ """Interlingua"""
604
+ ia
605
+ """Irish"""
606
+ ga
607
+ """Italian"""
608
+ it
609
+ """Japanese"""
610
+ ja
611
+ """Javanese"""
612
+ jv
613
+ """Kalaallisut"""
614
+ kl
615
+ """Kannada"""
616
+ kn
617
+ """Kashmiri"""
618
+ ks
619
+ """Kazakh"""
620
+ kk
621
+ """Khmer"""
622
+ km
623
+ """Kikuyu"""
624
+ ki
625
+ """Kinyarwanda"""
626
+ rw
627
+ """Korean"""
628
+ ko
629
+ """Kurdish"""
630
+ ku
631
+ """Kyrgyz"""
632
+ ky
633
+ """Lao"""
634
+ lo
635
+ """Latin"""
636
+ la
637
+ """Latvian"""
638
+ lv
639
+ """Lingala"""
640
+ ln
641
+ """Lithuanian"""
642
+ lt
643
+ """Luba-Katanga"""
644
+ lu
645
+ """Luxembourgish"""
646
+ lb
647
+ """Macedonian"""
648
+ mk
649
+ """Malagasy"""
650
+ mg
651
+ """Malay"""
652
+ ms
653
+ """Malayalam"""
654
+ ml
655
+ """Maltese"""
656
+ mt
657
+ """Manx"""
658
+ gv
659
+ """Maori"""
660
+ mi
661
+ """Marathi"""
662
+ mr
663
+ """Mongolian"""
664
+ mn
665
+ """Nepali"""
666
+ ne
667
+ """North Ndebele"""
668
+ nd
669
+ """Northern Sami"""
670
+ se
671
+ """Norwegian Bokm\u00E5l"""
672
+ nb
673
+ """Norwegian Nynorsk"""
674
+ nn
675
+ """Nyanja"""
676
+ ny
677
+ """Odia"""
678
+ or
679
+ """Oromo"""
680
+ om
681
+ """Ossetic"""
682
+ os
683
+ """Pashto"""
684
+ ps
685
+ """Persian"""
686
+ fa
687
+ """Dari"""
688
+ fa_AF
689
+ """Polish"""
690
+ pl
691
+ """Portuguese"""
692
+ pt
693
+ """Brazilian Portuguese"""
694
+ pt_BR
695
+ """European Portuguese"""
696
+ pt_PT
697
+ """Punjabi"""
698
+ pa
699
+ """Quechua"""
700
+ qu
701
+ """Romanian"""
702
+ ro
703
+ """Moldavian"""
704
+ ro_MD
705
+ """Romansh"""
706
+ rm
707
+ """Rundi"""
708
+ rn
709
+ """Russian"""
710
+ ru
711
+ """Samoan"""
712
+ sm
713
+ """Sango"""
714
+ sg
715
+ """Sanskrit"""
716
+ sa
717
+ """Scottish Gaelic"""
718
+ gd
719
+ """Serbian"""
720
+ sr
721
+ """Shona"""
722
+ sn
723
+ """Sichuan Yi"""
724
+ ii
725
+ """Sindhi"""
726
+ sd
727
+ """Sinhala"""
728
+ si
729
+ """Slovak"""
730
+ sk
731
+ """Slovenian"""
732
+ sl
733
+ """Somali"""
734
+ so
735
+ """Southern Sotho"""
736
+ st
737
+ """Spanish"""
738
+ es
739
+ """European Spanish"""
740
+ es_ES
741
+ """Mexican Spanish"""
742
+ es_MX
743
+ """Sundanese"""
744
+ su
745
+ """Swahili"""
746
+ sw
747
+ """Congo Swahili"""
748
+ sw_CD
749
+ """Swedish"""
750
+ sv
751
+ """Tajik"""
752
+ tg
753
+ """Tamil"""
754
+ ta
755
+ """Tatar"""
756
+ tt
757
+ """Telugu"""
758
+ te
759
+ """Thai"""
760
+ th
761
+ """Tibetan"""
762
+ bo
763
+ """Tigrinya"""
764
+ ti
765
+ """Tongan"""
766
+ to
767
+ """Turkish"""
768
+ tr
769
+ """Turkmen"""
770
+ tk
771
+ """Ukrainian"""
772
+ uk
773
+ """Urdu"""
774
+ ur
775
+ """Uyghur"""
776
+ ug
777
+ """Uzbek"""
778
+ uz
779
+ """Vietnamese"""
780
+ vi
781
+ """Volap\u00FCk"""
782
+ vo
783
+ """Welsh"""
784
+ cy
785
+ """Western Frisian"""
786
+ fy
787
+ """Wolof"""
788
+ wo
789
+ """Xhosa"""
790
+ xh
791
+ """Yiddish"""
792
+ yi
793
+ """Yoruba"""
794
+ yo
795
+ """Zulu"""
796
+ zu
797
+ }`}
798
+ </GraphQLDoc>
799
+
800
+ ## LogicalOperator {#logicaloperator}
801
+
802
+ <GraphQLDoc
803
+ type="enum"
804
+ typeName="LogicalOperator"
805
+ typeLinks={{}}
806
+ >
807
+ {`enum LogicalOperator {
808
+ AND
809
+ OR
810
+ }`}
811
+ </GraphQLDoc>
812
+
813
+ ## OrderType {#ordertype}
814
+
815
+ <GraphQLDoc
816
+ type="enum"
817
+ typeName="OrderType"
818
+ typeLinks={{}}
819
+ >
820
+ {`enum OrderType {
821
+ Regular
822
+ Seller
823
+ Aggregate
824
+ }`}
825
+ </GraphQLDoc>
826
+
827
+ ## Permission {#permission}
828
+
829
+ <GraphQLDoc
830
+ type="enum"
831
+ typeName="Permission"
832
+ typeLinks={{}}
833
+ >
834
+ {`"""
835
+ Permissions for administrators and customers. Used to control access to
836
+ GraphQL resolvers via the {@link Allow} decorator.
837
+
838
+ ## Understanding Permission.Owner
839
+
840
+ \`Permission.Owner\` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only
841
+ be accessible to the "owner" of that resource.
842
+
843
+ For example, the Shop API \`activeCustomer\` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
844
+ based on the activeUserId of the current session. As a result, the resolver code looks like this:
845
+
846
+ @example
847
+ \`\`\`TypeScript
848
+ \@Query()
849
+ \@Allow(Permission.Owner)
850
+ async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
851
+ const userId = ctx.activeUserId;
852
+ if (userId) {
853
+ return this.customerService.findOneByUserId(ctx, userId);
854
+ }
855
+ }
856
+ \`\`\`
857
+
858
+ Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
859
+ nor statically encoded at build-time, any resolvers using \`Permission.Owner\` **must** include logic to enforce that only the owner
860
+ of the resource has access. If not, then it is the equivalent of using \`Permission.Public\`.
861
+ """
862
+ enum Permission {
863
+ """Authenticated means simply that the user is logged in"""
864
+ Authenticated
865
+ """SuperAdmin has unrestricted access to all operations"""
866
+ SuperAdmin
867
+ """Owner means the user owns this entity, e.g. a Customer's own Order"""
868
+ Owner
869
+ """Public means any unauthenticated user may perform the operation"""
870
+ Public
871
+ """Grants permission to update GlobalSettings"""
872
+ UpdateGlobalSettings
873
+ """Grants permission to create Products, Facets, Assets, Collections"""
874
+ CreateCatalog
875
+ """Grants permission to read Products, Facets, Assets, Collections"""
876
+ ReadCatalog
877
+ """Grants permission to update Products, Facets, Assets, Collections"""
878
+ UpdateCatalog
879
+ """Grants permission to delete Products, Facets, Assets, Collections"""
880
+ DeleteCatalog
881
+ """Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""
882
+ CreateSettings
883
+ """Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""
884
+ ReadSettings
885
+ """Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""
886
+ UpdateSettings
887
+ """Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings"""
888
+ DeleteSettings
889
+ """Grants permission to create Administrator"""
890
+ CreateAdministrator
891
+ """Grants permission to read Administrator"""
892
+ ReadAdministrator
893
+ """Grants permission to update Administrator"""
894
+ UpdateAdministrator
895
+ """Grants permission to delete Administrator"""
896
+ DeleteAdministrator
897
+ """Grants permission to create Asset"""
898
+ CreateAsset
899
+ """Grants permission to read Asset"""
900
+ ReadAsset
901
+ """Grants permission to update Asset"""
902
+ UpdateAsset
903
+ """Grants permission to delete Asset"""
904
+ DeleteAsset
905
+ """Grants permission to create Channel"""
906
+ CreateChannel
907
+ """Grants permission to read Channel"""
908
+ ReadChannel
909
+ """Grants permission to update Channel"""
910
+ UpdateChannel
911
+ """Grants permission to delete Channel"""
912
+ DeleteChannel
913
+ """Grants permission to create Collection"""
914
+ CreateCollection
915
+ """Grants permission to read Collection"""
916
+ ReadCollection
917
+ """Grants permission to update Collection"""
918
+ UpdateCollection
919
+ """Grants permission to delete Collection"""
920
+ DeleteCollection
921
+ """Grants permission to create Country"""
922
+ CreateCountry
923
+ """Grants permission to read Country"""
924
+ ReadCountry
925
+ """Grants permission to update Country"""
926
+ UpdateCountry
927
+ """Grants permission to delete Country"""
928
+ DeleteCountry
929
+ """Grants permission to create Customer"""
930
+ CreateCustomer
931
+ """Grants permission to read Customer"""
932
+ ReadCustomer
933
+ """Grants permission to update Customer"""
934
+ UpdateCustomer
935
+ """Grants permission to delete Customer"""
936
+ DeleteCustomer
937
+ """Grants permission to create CustomerGroup"""
938
+ CreateCustomerGroup
939
+ """Grants permission to read CustomerGroup"""
940
+ ReadCustomerGroup
941
+ """Grants permission to update CustomerGroup"""
942
+ UpdateCustomerGroup
943
+ """Grants permission to delete CustomerGroup"""
944
+ DeleteCustomerGroup
945
+ """Grants permission to create Facet"""
946
+ CreateFacet
947
+ """Grants permission to read Facet"""
948
+ ReadFacet
949
+ """Grants permission to update Facet"""
950
+ UpdateFacet
951
+ """Grants permission to delete Facet"""
952
+ DeleteFacet
953
+ """Grants permission to create Order"""
954
+ CreateOrder
955
+ """Grants permission to read Order"""
956
+ ReadOrder
957
+ """Grants permission to update Order"""
958
+ UpdateOrder
959
+ """Grants permission to delete Order"""
960
+ DeleteOrder
961
+ """Grants permission to create PaymentMethod"""
962
+ CreatePaymentMethod
963
+ """Grants permission to read PaymentMethod"""
964
+ ReadPaymentMethod
965
+ """Grants permission to update PaymentMethod"""
966
+ UpdatePaymentMethod
967
+ """Grants permission to delete PaymentMethod"""
968
+ DeletePaymentMethod
969
+ """Grants permission to create Product"""
970
+ CreateProduct
971
+ """Grants permission to read Product"""
972
+ ReadProduct
973
+ """Grants permission to update Product"""
974
+ UpdateProduct
975
+ """Grants permission to delete Product"""
976
+ DeleteProduct
977
+ """Grants permission to create Promotion"""
978
+ CreatePromotion
979
+ """Grants permission to read Promotion"""
980
+ ReadPromotion
981
+ """Grants permission to update Promotion"""
982
+ UpdatePromotion
983
+ """Grants permission to delete Promotion"""
984
+ DeletePromotion
985
+ """Grants permission to create ShippingMethod"""
986
+ CreateShippingMethod
987
+ """Grants permission to read ShippingMethod"""
988
+ ReadShippingMethod
989
+ """Grants permission to update ShippingMethod"""
990
+ UpdateShippingMethod
991
+ """Grants permission to delete ShippingMethod"""
992
+ DeleteShippingMethod
993
+ """Grants permission to create Tag"""
994
+ CreateTag
995
+ """Grants permission to read Tag"""
996
+ ReadTag
997
+ """Grants permission to update Tag"""
998
+ UpdateTag
999
+ """Grants permission to delete Tag"""
1000
+ DeleteTag
1001
+ """Grants permission to create TaxCategory"""
1002
+ CreateTaxCategory
1003
+ """Grants permission to read TaxCategory"""
1004
+ ReadTaxCategory
1005
+ """Grants permission to update TaxCategory"""
1006
+ UpdateTaxCategory
1007
+ """Grants permission to delete TaxCategory"""
1008
+ DeleteTaxCategory
1009
+ """Grants permission to create TaxRate"""
1010
+ CreateTaxRate
1011
+ """Grants permission to read TaxRate"""
1012
+ ReadTaxRate
1013
+ """Grants permission to update TaxRate"""
1014
+ UpdateTaxRate
1015
+ """Grants permission to delete TaxRate"""
1016
+ DeleteTaxRate
1017
+ """Grants permission to create Seller"""
1018
+ CreateSeller
1019
+ """Grants permission to read Seller"""
1020
+ ReadSeller
1021
+ """Grants permission to update Seller"""
1022
+ UpdateSeller
1023
+ """Grants permission to delete Seller"""
1024
+ DeleteSeller
1025
+ """Grants permission to create StockLocation"""
1026
+ CreateStockLocation
1027
+ """Grants permission to read StockLocation"""
1028
+ ReadStockLocation
1029
+ """Grants permission to update StockLocation"""
1030
+ UpdateStockLocation
1031
+ """Grants permission to delete StockLocation"""
1032
+ DeleteStockLocation
1033
+ """Grants permission to create System"""
1034
+ CreateSystem
1035
+ """Grants permission to read System"""
1036
+ ReadSystem
1037
+ """Grants permission to update System"""
1038
+ UpdateSystem
1039
+ """Grants permission to delete System"""
1040
+ DeleteSystem
1041
+ """Grants permission to create Zone"""
1042
+ CreateZone
1043
+ """Grants permission to read Zone"""
1044
+ ReadZone
1045
+ """Grants permission to update Zone"""
1046
+ UpdateZone
1047
+ """Grants permission to delete Zone"""
1048
+ DeleteZone
1049
+ }`}
1050
+ </GraphQLDoc>
1051
+
1052
+ ## SortOrder {#sortorder}
1053
+
1054
+ <GraphQLDoc
1055
+ type="enum"
1056
+ typeName="SortOrder"
1057
+ typeLinks={{}}
1058
+ >
1059
+ {`enum SortOrder {
1060
+ ASC
1061
+ DESC
1062
+ }`}
1063
+ </GraphQLDoc>