generated-types.ts 202 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603
  1. /* eslint-disable */
  2. export type Maybe<T> = T;
  3. export type InputMaybe<T> = T;
  4. export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
  5. export type MakeOptional<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]?: Maybe<T[SubKey]> };
  6. export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & { [SubKey in K]: Maybe<T[SubKey]> };
  7. export type MakeEmpty<T extends { [key: string]: unknown }, K extends keyof T> = { [_ in K]?: never };
  8. export type Incremental<T> = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never };
  9. /** All built-in and custom scalars, mapped to their actual values */
  10. export type Scalars = {
  11. ID: { input: string | number; output: string | number; }
  12. String: { input: string; output: string; }
  13. Boolean: { input: boolean; output: boolean; }
  14. Int: { input: number; output: number; }
  15. Float: { input: number; output: number; }
  16. DateTime: { input: any; output: any; }
  17. JSON: { input: any; output: any; }
  18. Money: { input: number; output: number; }
  19. Upload: { input: any; output: any; }
  20. };
  21. export type AddFulfillmentToOrderResult = CreateFulfillmentError | EmptyOrderLineSelectionError | Fulfillment | FulfillmentStateTransitionError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | ItemsAlreadyFulfilledError;
  22. export type AddItemInput = {
  23. productVariantId: Scalars['ID']['input'];
  24. quantity: Scalars['Int']['input'];
  25. };
  26. export type AddItemToDraftOrderInput = {
  27. productVariantId: Scalars['ID']['input'];
  28. quantity: Scalars['Int']['input'];
  29. };
  30. export type AddManualPaymentToOrderResult = ManualPaymentStateError | Order;
  31. export type AddNoteToCustomerInput = {
  32. id: Scalars['ID']['input'];
  33. isPublic: Scalars['Boolean']['input'];
  34. note: Scalars['String']['input'];
  35. };
  36. export type AddNoteToOrderInput = {
  37. id: Scalars['ID']['input'];
  38. isPublic: Scalars['Boolean']['input'];
  39. note: Scalars['String']['input'];
  40. };
  41. export type Address = Node & {
  42. __typename?: 'Address';
  43. city?: Maybe<Scalars['String']['output']>;
  44. company?: Maybe<Scalars['String']['output']>;
  45. country: Country;
  46. createdAt: Scalars['DateTime']['output'];
  47. customFields?: Maybe<Scalars['JSON']['output']>;
  48. defaultBillingAddress?: Maybe<Scalars['Boolean']['output']>;
  49. defaultShippingAddress?: Maybe<Scalars['Boolean']['output']>;
  50. fullName?: Maybe<Scalars['String']['output']>;
  51. id: Scalars['ID']['output'];
  52. phoneNumber?: Maybe<Scalars['String']['output']>;
  53. postalCode?: Maybe<Scalars['String']['output']>;
  54. province?: Maybe<Scalars['String']['output']>;
  55. streetLine1: Scalars['String']['output'];
  56. streetLine2?: Maybe<Scalars['String']['output']>;
  57. updatedAt: Scalars['DateTime']['output'];
  58. };
  59. export type AdjustDraftOrderLineInput = {
  60. orderLineId: Scalars['ID']['input'];
  61. quantity: Scalars['Int']['input'];
  62. };
  63. export type Adjustment = {
  64. __typename?: 'Adjustment';
  65. adjustmentSource: Scalars['String']['output'];
  66. amount: Scalars['Money']['output'];
  67. data?: Maybe<Scalars['JSON']['output']>;
  68. description: Scalars['String']['output'];
  69. type: AdjustmentType;
  70. };
  71. export enum AdjustmentType {
  72. DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION',
  73. OTHER = 'OTHER',
  74. PROMOTION = 'PROMOTION'
  75. }
  76. export type Administrator = Node & {
  77. __typename?: 'Administrator';
  78. createdAt: Scalars['DateTime']['output'];
  79. customFields?: Maybe<Scalars['JSON']['output']>;
  80. emailAddress: Scalars['String']['output'];
  81. firstName: Scalars['String']['output'];
  82. id: Scalars['ID']['output'];
  83. lastName: Scalars['String']['output'];
  84. updatedAt: Scalars['DateTime']['output'];
  85. user: User;
  86. };
  87. export type AdministratorFilterParameter = {
  88. _and?: InputMaybe<Array<AdministratorFilterParameter>>;
  89. _or?: InputMaybe<Array<AdministratorFilterParameter>>;
  90. createdAt?: InputMaybe<DateOperators>;
  91. emailAddress?: InputMaybe<StringOperators>;
  92. firstName?: InputMaybe<StringOperators>;
  93. id?: InputMaybe<IdOperators>;
  94. lastName?: InputMaybe<StringOperators>;
  95. updatedAt?: InputMaybe<DateOperators>;
  96. };
  97. export type AdministratorList = PaginatedList & {
  98. __typename?: 'AdministratorList';
  99. items: Array<Administrator>;
  100. totalItems: Scalars['Int']['output'];
  101. };
  102. export type AdministratorListOptions = {
  103. /** Allows the results to be filtered */
  104. filter?: InputMaybe<AdministratorFilterParameter>;
  105. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  106. filterOperator?: InputMaybe<LogicalOperator>;
  107. /** Skips the first n results, for use in pagination */
  108. skip?: InputMaybe<Scalars['Int']['input']>;
  109. /** Specifies which properties to sort the results by */
  110. sort?: InputMaybe<AdministratorSortParameter>;
  111. /** Takes n results, for use in pagination */
  112. take?: InputMaybe<Scalars['Int']['input']>;
  113. };
  114. export type AdministratorPaymentInput = {
  115. metadata?: InputMaybe<Scalars['JSON']['input']>;
  116. paymentMethod?: InputMaybe<Scalars['String']['input']>;
  117. };
  118. export type AdministratorRefundInput = {
  119. /**
  120. * The amount to be refunded to this particular Payment. This was introduced in
  121. * v2.2.0 as the preferred way to specify the refund amount. The `lines`, `shipping` and `adjustment`
  122. * fields will be removed in a future version.
  123. */
  124. amount?: InputMaybe<Scalars['Money']['input']>;
  125. paymentId: Scalars['ID']['input'];
  126. reason?: InputMaybe<Scalars['String']['input']>;
  127. };
  128. export type AdministratorSortParameter = {
  129. createdAt?: InputMaybe<SortOrder>;
  130. emailAddress?: InputMaybe<SortOrder>;
  131. firstName?: InputMaybe<SortOrder>;
  132. id?: InputMaybe<SortOrder>;
  133. lastName?: InputMaybe<SortOrder>;
  134. updatedAt?: InputMaybe<SortOrder>;
  135. };
  136. export type Allocation = Node & StockMovement & {
  137. __typename?: 'Allocation';
  138. createdAt: Scalars['DateTime']['output'];
  139. id: Scalars['ID']['output'];
  140. orderLine: OrderLine;
  141. productVariant: ProductVariant;
  142. quantity: Scalars['Int']['output'];
  143. type: StockMovementType;
  144. updatedAt: Scalars['DateTime']['output'];
  145. };
  146. /** Returned if an attempting to refund an OrderItem which has already been refunded */
  147. export type AlreadyRefundedError = ErrorResult & {
  148. __typename?: 'AlreadyRefundedError';
  149. errorCode: ErrorCode;
  150. message: Scalars['String']['output'];
  151. refundId: Scalars['ID']['output'];
  152. };
  153. export type ApplyCouponCodeResult = CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | Order;
  154. export type Asset = Node & {
  155. __typename?: 'Asset';
  156. createdAt: Scalars['DateTime']['output'];
  157. customFields?: Maybe<Scalars['JSON']['output']>;
  158. fileSize: Scalars['Int']['output'];
  159. focalPoint?: Maybe<Coordinate>;
  160. height: Scalars['Int']['output'];
  161. id: Scalars['ID']['output'];
  162. mimeType: Scalars['String']['output'];
  163. name: Scalars['String']['output'];
  164. preview: Scalars['String']['output'];
  165. source: Scalars['String']['output'];
  166. tags: Array<Tag>;
  167. type: AssetType;
  168. updatedAt: Scalars['DateTime']['output'];
  169. width: Scalars['Int']['output'];
  170. };
  171. export type AssetFilterParameter = {
  172. _and?: InputMaybe<Array<AssetFilterParameter>>;
  173. _or?: InputMaybe<Array<AssetFilterParameter>>;
  174. createdAt?: InputMaybe<DateOperators>;
  175. fileSize?: InputMaybe<NumberOperators>;
  176. height?: InputMaybe<NumberOperators>;
  177. id?: InputMaybe<IdOperators>;
  178. mimeType?: InputMaybe<StringOperators>;
  179. name?: InputMaybe<StringOperators>;
  180. preview?: InputMaybe<StringOperators>;
  181. source?: InputMaybe<StringOperators>;
  182. type?: InputMaybe<StringOperators>;
  183. updatedAt?: InputMaybe<DateOperators>;
  184. width?: InputMaybe<NumberOperators>;
  185. };
  186. export type AssetList = PaginatedList & {
  187. __typename?: 'AssetList';
  188. items: Array<Asset>;
  189. totalItems: Scalars['Int']['output'];
  190. };
  191. export type AssetListOptions = {
  192. /** Allows the results to be filtered */
  193. filter?: InputMaybe<AssetFilterParameter>;
  194. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  195. filterOperator?: InputMaybe<LogicalOperator>;
  196. /** Skips the first n results, for use in pagination */
  197. skip?: InputMaybe<Scalars['Int']['input']>;
  198. /** Specifies which properties to sort the results by */
  199. sort?: InputMaybe<AssetSortParameter>;
  200. tags?: InputMaybe<Array<Scalars['String']['input']>>;
  201. tagsOperator?: InputMaybe<LogicalOperator>;
  202. /** Takes n results, for use in pagination */
  203. take?: InputMaybe<Scalars['Int']['input']>;
  204. };
  205. export type AssetSortParameter = {
  206. createdAt?: InputMaybe<SortOrder>;
  207. fileSize?: InputMaybe<SortOrder>;
  208. height?: InputMaybe<SortOrder>;
  209. id?: InputMaybe<SortOrder>;
  210. mimeType?: InputMaybe<SortOrder>;
  211. name?: InputMaybe<SortOrder>;
  212. preview?: InputMaybe<SortOrder>;
  213. source?: InputMaybe<SortOrder>;
  214. updatedAt?: InputMaybe<SortOrder>;
  215. width?: InputMaybe<SortOrder>;
  216. };
  217. export enum AssetType {
  218. BINARY = 'BINARY',
  219. IMAGE = 'IMAGE',
  220. VIDEO = 'VIDEO'
  221. }
  222. export type AssignAssetsToChannelInput = {
  223. assetIds: Array<Scalars['ID']['input']>;
  224. channelId: Scalars['ID']['input'];
  225. };
  226. export type AssignCollectionsToChannelInput = {
  227. channelId: Scalars['ID']['input'];
  228. collectionIds: Array<Scalars['ID']['input']>;
  229. };
  230. export type AssignFacetsToChannelInput = {
  231. channelId: Scalars['ID']['input'];
  232. facetIds: Array<Scalars['ID']['input']>;
  233. };
  234. export type AssignPaymentMethodsToChannelInput = {
  235. channelId: Scalars['ID']['input'];
  236. paymentMethodIds: Array<Scalars['ID']['input']>;
  237. };
  238. export type AssignProductVariantsToChannelInput = {
  239. channelId: Scalars['ID']['input'];
  240. priceFactor?: InputMaybe<Scalars['Float']['input']>;
  241. productVariantIds: Array<Scalars['ID']['input']>;
  242. };
  243. export type AssignProductsToChannelInput = {
  244. channelId: Scalars['ID']['input'];
  245. priceFactor?: InputMaybe<Scalars['Float']['input']>;
  246. productIds: Array<Scalars['ID']['input']>;
  247. };
  248. export type AssignPromotionsToChannelInput = {
  249. channelId: Scalars['ID']['input'];
  250. promotionIds: Array<Scalars['ID']['input']>;
  251. };
  252. export type AssignShippingMethodsToChannelInput = {
  253. channelId: Scalars['ID']['input'];
  254. shippingMethodIds: Array<Scalars['ID']['input']>;
  255. };
  256. export type AssignStockLocationsToChannelInput = {
  257. channelId: Scalars['ID']['input'];
  258. stockLocationIds: Array<Scalars['ID']['input']>;
  259. };
  260. export type AuthenticationInput = {
  261. native?: InputMaybe<NativeAuthInput>;
  262. };
  263. export type AuthenticationMethod = Node & {
  264. __typename?: 'AuthenticationMethod';
  265. createdAt: Scalars['DateTime']['output'];
  266. id: Scalars['ID']['output'];
  267. strategy: Scalars['String']['output'];
  268. updatedAt: Scalars['DateTime']['output'];
  269. };
  270. export type AuthenticationResult = CurrentUser | InvalidCredentialsError;
  271. export type BooleanCustomFieldConfig = CustomField & {
  272. __typename?: 'BooleanCustomFieldConfig';
  273. description?: Maybe<Array<LocalizedString>>;
  274. internal?: Maybe<Scalars['Boolean']['output']>;
  275. label?: Maybe<Array<LocalizedString>>;
  276. list: Scalars['Boolean']['output'];
  277. name: Scalars['String']['output'];
  278. nullable?: Maybe<Scalars['Boolean']['output']>;
  279. readonly?: Maybe<Scalars['Boolean']['output']>;
  280. requiresPermission?: Maybe<Array<Permission>>;
  281. type: Scalars['String']['output'];
  282. ui?: Maybe<Scalars['JSON']['output']>;
  283. };
  284. /** Operators for filtering on a list of Boolean fields */
  285. export type BooleanListOperators = {
  286. inList: Scalars['Boolean']['input'];
  287. };
  288. /** Operators for filtering on a Boolean field */
  289. export type BooleanOperators = {
  290. eq?: InputMaybe<Scalars['Boolean']['input']>;
  291. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  292. };
  293. /** Returned if an attempting to cancel lines from an Order which is still active */
  294. export type CancelActiveOrderError = ErrorResult & {
  295. __typename?: 'CancelActiveOrderError';
  296. errorCode: ErrorCode;
  297. message: Scalars['String']['output'];
  298. orderState: Scalars['String']['output'];
  299. };
  300. export type CancelOrderInput = {
  301. /** Specify whether the shipping charges should also be cancelled. Defaults to false */
  302. cancelShipping?: InputMaybe<Scalars['Boolean']['input']>;
  303. /** Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled */
  304. lines?: InputMaybe<Array<OrderLineInput>>;
  305. /** The id of the order to be cancelled */
  306. orderId: Scalars['ID']['input'];
  307. reason?: InputMaybe<Scalars['String']['input']>;
  308. };
  309. export type CancelOrderResult = CancelActiveOrderError | EmptyOrderLineSelectionError | MultipleOrderError | Order | OrderStateTransitionError | QuantityTooGreatError;
  310. /** Returned if the Payment cancellation fails */
  311. export type CancelPaymentError = ErrorResult & {
  312. __typename?: 'CancelPaymentError';
  313. errorCode: ErrorCode;
  314. message: Scalars['String']['output'];
  315. paymentErrorMessage: Scalars['String']['output'];
  316. };
  317. export type CancelPaymentResult = CancelPaymentError | Payment | PaymentStateTransitionError;
  318. export type Cancellation = Node & StockMovement & {
  319. __typename?: 'Cancellation';
  320. createdAt: Scalars['DateTime']['output'];
  321. id: Scalars['ID']['output'];
  322. orderLine: OrderLine;
  323. productVariant: ProductVariant;
  324. quantity: Scalars['Int']['output'];
  325. type: StockMovementType;
  326. updatedAt: Scalars['DateTime']['output'];
  327. };
  328. export type Channel = Node & {
  329. __typename?: 'Channel';
  330. availableCurrencyCodes: Array<CurrencyCode>;
  331. availableLanguageCodes?: Maybe<Array<LanguageCode>>;
  332. code: Scalars['String']['output'];
  333. createdAt: Scalars['DateTime']['output'];
  334. /** @deprecated Use defaultCurrencyCode instead */
  335. currencyCode: CurrencyCode;
  336. customFields?: Maybe<Scalars['JSON']['output']>;
  337. defaultCurrencyCode: CurrencyCode;
  338. defaultLanguageCode: LanguageCode;
  339. defaultShippingZone?: Maybe<Zone>;
  340. defaultTaxZone?: Maybe<Zone>;
  341. id: Scalars['ID']['output'];
  342. /** Not yet used - will be implemented in a future release. */
  343. outOfStockThreshold?: Maybe<Scalars['Int']['output']>;
  344. pricesIncludeTax: Scalars['Boolean']['output'];
  345. seller?: Maybe<Seller>;
  346. token: Scalars['String']['output'];
  347. /** Not yet used - will be implemented in a future release. */
  348. trackInventory?: Maybe<Scalars['Boolean']['output']>;
  349. updatedAt: Scalars['DateTime']['output'];
  350. };
  351. /**
  352. * Returned when the default LanguageCode of a Channel is no longer found in the `availableLanguages`
  353. * of the GlobalSettings
  354. */
  355. export type ChannelDefaultLanguageError = ErrorResult & {
  356. __typename?: 'ChannelDefaultLanguageError';
  357. channelCode: Scalars['String']['output'];
  358. errorCode: ErrorCode;
  359. language: Scalars['String']['output'];
  360. message: Scalars['String']['output'];
  361. };
  362. export type ChannelFilterParameter = {
  363. _and?: InputMaybe<Array<ChannelFilterParameter>>;
  364. _or?: InputMaybe<Array<ChannelFilterParameter>>;
  365. code?: InputMaybe<StringOperators>;
  366. createdAt?: InputMaybe<DateOperators>;
  367. currencyCode?: InputMaybe<StringOperators>;
  368. defaultCurrencyCode?: InputMaybe<StringOperators>;
  369. defaultLanguageCode?: InputMaybe<StringOperators>;
  370. id?: InputMaybe<IdOperators>;
  371. outOfStockThreshold?: InputMaybe<NumberOperators>;
  372. pricesIncludeTax?: InputMaybe<BooleanOperators>;
  373. token?: InputMaybe<StringOperators>;
  374. trackInventory?: InputMaybe<BooleanOperators>;
  375. updatedAt?: InputMaybe<DateOperators>;
  376. };
  377. export type ChannelList = PaginatedList & {
  378. __typename?: 'ChannelList';
  379. items: Array<Channel>;
  380. totalItems: Scalars['Int']['output'];
  381. };
  382. export type ChannelListOptions = {
  383. /** Allows the results to be filtered */
  384. filter?: InputMaybe<ChannelFilterParameter>;
  385. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  386. filterOperator?: InputMaybe<LogicalOperator>;
  387. /** Skips the first n results, for use in pagination */
  388. skip?: InputMaybe<Scalars['Int']['input']>;
  389. /** Specifies which properties to sort the results by */
  390. sort?: InputMaybe<ChannelSortParameter>;
  391. /** Takes n results, for use in pagination */
  392. take?: InputMaybe<Scalars['Int']['input']>;
  393. };
  394. export type ChannelSortParameter = {
  395. code?: InputMaybe<SortOrder>;
  396. createdAt?: InputMaybe<SortOrder>;
  397. id?: InputMaybe<SortOrder>;
  398. outOfStockThreshold?: InputMaybe<SortOrder>;
  399. token?: InputMaybe<SortOrder>;
  400. updatedAt?: InputMaybe<SortOrder>;
  401. };
  402. export type Collection = Node & {
  403. __typename?: 'Collection';
  404. assets: Array<Asset>;
  405. breadcrumbs: Array<CollectionBreadcrumb>;
  406. children?: Maybe<Array<Collection>>;
  407. createdAt: Scalars['DateTime']['output'];
  408. customFields?: Maybe<Scalars['JSON']['output']>;
  409. description: Scalars['String']['output'];
  410. featuredAsset?: Maybe<Asset>;
  411. filters: Array<ConfigurableOperation>;
  412. id: Scalars['ID']['output'];
  413. inheritFilters: Scalars['Boolean']['output'];
  414. isPrivate: Scalars['Boolean']['output'];
  415. languageCode?: Maybe<LanguageCode>;
  416. name: Scalars['String']['output'];
  417. parent?: Maybe<Collection>;
  418. parentId: Scalars['ID']['output'];
  419. position: Scalars['Int']['output'];
  420. productVariants: ProductVariantList;
  421. slug: Scalars['String']['output'];
  422. translations: Array<CollectionTranslation>;
  423. updatedAt: Scalars['DateTime']['output'];
  424. };
  425. export type CollectionProductVariantsArgs = {
  426. options?: InputMaybe<ProductVariantListOptions>;
  427. };
  428. export type CollectionBreadcrumb = {
  429. __typename?: 'CollectionBreadcrumb';
  430. id: Scalars['ID']['output'];
  431. name: Scalars['String']['output'];
  432. slug: Scalars['String']['output'];
  433. };
  434. export type CollectionFilterParameter = {
  435. _and?: InputMaybe<Array<CollectionFilterParameter>>;
  436. _or?: InputMaybe<Array<CollectionFilterParameter>>;
  437. createdAt?: InputMaybe<DateOperators>;
  438. description?: InputMaybe<StringOperators>;
  439. id?: InputMaybe<IdOperators>;
  440. inheritFilters?: InputMaybe<BooleanOperators>;
  441. isPrivate?: InputMaybe<BooleanOperators>;
  442. languageCode?: InputMaybe<StringOperators>;
  443. name?: InputMaybe<StringOperators>;
  444. parentId?: InputMaybe<IdOperators>;
  445. position?: InputMaybe<NumberOperators>;
  446. slug?: InputMaybe<StringOperators>;
  447. updatedAt?: InputMaybe<DateOperators>;
  448. };
  449. export type CollectionList = PaginatedList & {
  450. __typename?: 'CollectionList';
  451. items: Array<Collection>;
  452. totalItems: Scalars['Int']['output'];
  453. };
  454. export type CollectionListOptions = {
  455. /** Allows the results to be filtered */
  456. filter?: InputMaybe<CollectionFilterParameter>;
  457. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  458. filterOperator?: InputMaybe<LogicalOperator>;
  459. /** Skips the first n results, for use in pagination */
  460. skip?: InputMaybe<Scalars['Int']['input']>;
  461. /** Specifies which properties to sort the results by */
  462. sort?: InputMaybe<CollectionSortParameter>;
  463. /** Takes n results, for use in pagination */
  464. take?: InputMaybe<Scalars['Int']['input']>;
  465. topLevelOnly?: InputMaybe<Scalars['Boolean']['input']>;
  466. };
  467. /**
  468. * Which Collections are present in the products returned
  469. * by the search, and in what quantity.
  470. */
  471. export type CollectionResult = {
  472. __typename?: 'CollectionResult';
  473. collection: Collection;
  474. count: Scalars['Int']['output'];
  475. };
  476. export type CollectionSortParameter = {
  477. createdAt?: InputMaybe<SortOrder>;
  478. description?: InputMaybe<SortOrder>;
  479. id?: InputMaybe<SortOrder>;
  480. name?: InputMaybe<SortOrder>;
  481. parentId?: InputMaybe<SortOrder>;
  482. position?: InputMaybe<SortOrder>;
  483. slug?: InputMaybe<SortOrder>;
  484. updatedAt?: InputMaybe<SortOrder>;
  485. };
  486. export type CollectionTranslation = {
  487. __typename?: 'CollectionTranslation';
  488. createdAt: Scalars['DateTime']['output'];
  489. description: Scalars['String']['output'];
  490. id: Scalars['ID']['output'];
  491. languageCode: LanguageCode;
  492. name: Scalars['String']['output'];
  493. slug: Scalars['String']['output'];
  494. updatedAt: Scalars['DateTime']['output'];
  495. };
  496. export type ConfigArg = {
  497. __typename?: 'ConfigArg';
  498. name: Scalars['String']['output'];
  499. value: Scalars['String']['output'];
  500. };
  501. export type ConfigArgDefinition = {
  502. __typename?: 'ConfigArgDefinition';
  503. defaultValue?: Maybe<Scalars['JSON']['output']>;
  504. description?: Maybe<Scalars['String']['output']>;
  505. label?: Maybe<Scalars['String']['output']>;
  506. list: Scalars['Boolean']['output'];
  507. name: Scalars['String']['output'];
  508. required: Scalars['Boolean']['output'];
  509. type: Scalars['String']['output'];
  510. ui?: Maybe<Scalars['JSON']['output']>;
  511. };
  512. export type ConfigArgInput = {
  513. name: Scalars['String']['input'];
  514. /** A JSON stringified representation of the actual value */
  515. value: Scalars['String']['input'];
  516. };
  517. export type ConfigurableOperation = {
  518. __typename?: 'ConfigurableOperation';
  519. args: Array<ConfigArg>;
  520. code: Scalars['String']['output'];
  521. };
  522. export type ConfigurableOperationDefinition = {
  523. __typename?: 'ConfigurableOperationDefinition';
  524. args: Array<ConfigArgDefinition>;
  525. code: Scalars['String']['output'];
  526. description: Scalars['String']['output'];
  527. };
  528. export type ConfigurableOperationInput = {
  529. arguments: Array<ConfigArgInput>;
  530. code: Scalars['String']['input'];
  531. };
  532. export type Coordinate = {
  533. __typename?: 'Coordinate';
  534. x: Scalars['Float']['output'];
  535. y: Scalars['Float']['output'];
  536. };
  537. export type CoordinateInput = {
  538. x: Scalars['Float']['input'];
  539. y: Scalars['Float']['input'];
  540. };
  541. /**
  542. * A Country of the world which your shop operates in.
  543. *
  544. * The `code` field is typically a 2-character ISO code such as "GB", "US", "DE" etc. This code is used in certain inputs such as
  545. * `UpdateAddressInput` and `CreateAddressInput` to specify the country.
  546. */
  547. export type Country = Node & Region & {
  548. __typename?: 'Country';
  549. code: Scalars['String']['output'];
  550. createdAt: Scalars['DateTime']['output'];
  551. customFields?: Maybe<Scalars['JSON']['output']>;
  552. enabled: Scalars['Boolean']['output'];
  553. id: Scalars['ID']['output'];
  554. languageCode: LanguageCode;
  555. name: Scalars['String']['output'];
  556. parent?: Maybe<Region>;
  557. parentId?: Maybe<Scalars['ID']['output']>;
  558. translations: Array<RegionTranslation>;
  559. type: Scalars['String']['output'];
  560. updatedAt: Scalars['DateTime']['output'];
  561. };
  562. export type CountryFilterParameter = {
  563. _and?: InputMaybe<Array<CountryFilterParameter>>;
  564. _or?: InputMaybe<Array<CountryFilterParameter>>;
  565. code?: InputMaybe<StringOperators>;
  566. createdAt?: InputMaybe<DateOperators>;
  567. enabled?: InputMaybe<BooleanOperators>;
  568. id?: InputMaybe<IdOperators>;
  569. languageCode?: InputMaybe<StringOperators>;
  570. name?: InputMaybe<StringOperators>;
  571. parentId?: InputMaybe<IdOperators>;
  572. type?: InputMaybe<StringOperators>;
  573. updatedAt?: InputMaybe<DateOperators>;
  574. };
  575. export type CountryList = PaginatedList & {
  576. __typename?: 'CountryList';
  577. items: Array<Country>;
  578. totalItems: Scalars['Int']['output'];
  579. };
  580. export type CountryListOptions = {
  581. /** Allows the results to be filtered */
  582. filter?: InputMaybe<CountryFilterParameter>;
  583. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  584. filterOperator?: InputMaybe<LogicalOperator>;
  585. /** Skips the first n results, for use in pagination */
  586. skip?: InputMaybe<Scalars['Int']['input']>;
  587. /** Specifies which properties to sort the results by */
  588. sort?: InputMaybe<CountrySortParameter>;
  589. /** Takes n results, for use in pagination */
  590. take?: InputMaybe<Scalars['Int']['input']>;
  591. };
  592. export type CountrySortParameter = {
  593. code?: InputMaybe<SortOrder>;
  594. createdAt?: InputMaybe<SortOrder>;
  595. id?: InputMaybe<SortOrder>;
  596. name?: InputMaybe<SortOrder>;
  597. parentId?: InputMaybe<SortOrder>;
  598. type?: InputMaybe<SortOrder>;
  599. updatedAt?: InputMaybe<SortOrder>;
  600. };
  601. export type CountryTranslationInput = {
  602. customFields?: InputMaybe<Scalars['JSON']['input']>;
  603. id?: InputMaybe<Scalars['ID']['input']>;
  604. languageCode: LanguageCode;
  605. name?: InputMaybe<Scalars['String']['input']>;
  606. };
  607. /** Returned if the provided coupon code is invalid */
  608. export type CouponCodeExpiredError = ErrorResult & {
  609. __typename?: 'CouponCodeExpiredError';
  610. couponCode: Scalars['String']['output'];
  611. errorCode: ErrorCode;
  612. message: Scalars['String']['output'];
  613. };
  614. /** Returned if the provided coupon code is invalid */
  615. export type CouponCodeInvalidError = ErrorResult & {
  616. __typename?: 'CouponCodeInvalidError';
  617. couponCode: Scalars['String']['output'];
  618. errorCode: ErrorCode;
  619. message: Scalars['String']['output'];
  620. };
  621. /** Returned if the provided coupon code is invalid */
  622. export type CouponCodeLimitError = ErrorResult & {
  623. __typename?: 'CouponCodeLimitError';
  624. couponCode: Scalars['String']['output'];
  625. errorCode: ErrorCode;
  626. limit: Scalars['Int']['output'];
  627. message: Scalars['String']['output'];
  628. };
  629. /**
  630. * Input used to create an Address.
  631. *
  632. * The countryCode must correspond to a `code` property of a Country that has been defined in the
  633. * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
  634. * If an invalid code is passed, the mutation will fail.
  635. */
  636. export type CreateAddressInput = {
  637. city?: InputMaybe<Scalars['String']['input']>;
  638. company?: InputMaybe<Scalars['String']['input']>;
  639. countryCode: Scalars['String']['input'];
  640. customFields?: InputMaybe<Scalars['JSON']['input']>;
  641. defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
  642. defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
  643. fullName?: InputMaybe<Scalars['String']['input']>;
  644. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  645. postalCode?: InputMaybe<Scalars['String']['input']>;
  646. province?: InputMaybe<Scalars['String']['input']>;
  647. streetLine1: Scalars['String']['input'];
  648. streetLine2?: InputMaybe<Scalars['String']['input']>;
  649. };
  650. export type CreateAdministratorInput = {
  651. customFields?: InputMaybe<Scalars['JSON']['input']>;
  652. emailAddress: Scalars['String']['input'];
  653. firstName: Scalars['String']['input'];
  654. lastName: Scalars['String']['input'];
  655. password: Scalars['String']['input'];
  656. roleIds: Array<Scalars['ID']['input']>;
  657. };
  658. export type CreateAssetInput = {
  659. customFields?: InputMaybe<Scalars['JSON']['input']>;
  660. file: Scalars['Upload']['input'];
  661. tags?: InputMaybe<Array<Scalars['String']['input']>>;
  662. };
  663. export type CreateAssetResult = Asset | MimeTypeError;
  664. export type CreateChannelInput = {
  665. availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
  666. availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
  667. code: Scalars['String']['input'];
  668. /** @deprecated Use defaultCurrencyCode instead */
  669. currencyCode?: InputMaybe<CurrencyCode>;
  670. customFields?: InputMaybe<Scalars['JSON']['input']>;
  671. defaultCurrencyCode?: InputMaybe<CurrencyCode>;
  672. defaultLanguageCode: LanguageCode;
  673. defaultShippingZoneId: Scalars['ID']['input'];
  674. defaultTaxZoneId: Scalars['ID']['input'];
  675. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  676. pricesIncludeTax: Scalars['Boolean']['input'];
  677. sellerId?: InputMaybe<Scalars['ID']['input']>;
  678. token: Scalars['String']['input'];
  679. trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
  680. };
  681. export type CreateChannelResult = Channel | LanguageNotAvailableError;
  682. export type CreateCollectionInput = {
  683. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  684. customFields?: InputMaybe<Scalars['JSON']['input']>;
  685. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  686. filters: Array<ConfigurableOperationInput>;
  687. inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
  688. isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
  689. parentId?: InputMaybe<Scalars['ID']['input']>;
  690. translations: Array<CreateCollectionTranslationInput>;
  691. };
  692. export type CreateCollectionTranslationInput = {
  693. customFields?: InputMaybe<Scalars['JSON']['input']>;
  694. description: Scalars['String']['input'];
  695. languageCode: LanguageCode;
  696. name: Scalars['String']['input'];
  697. slug: Scalars['String']['input'];
  698. };
  699. export type CreateCountryInput = {
  700. code: Scalars['String']['input'];
  701. customFields?: InputMaybe<Scalars['JSON']['input']>;
  702. enabled: Scalars['Boolean']['input'];
  703. translations: Array<CountryTranslationInput>;
  704. };
  705. export type CreateCustomerGroupInput = {
  706. customFields?: InputMaybe<Scalars['JSON']['input']>;
  707. customerIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  708. name: Scalars['String']['input'];
  709. };
  710. export type CreateCustomerInput = {
  711. customFields?: InputMaybe<Scalars['JSON']['input']>;
  712. emailAddress: Scalars['String']['input'];
  713. firstName: Scalars['String']['input'];
  714. lastName: Scalars['String']['input'];
  715. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  716. title?: InputMaybe<Scalars['String']['input']>;
  717. };
  718. export type CreateCustomerResult = Customer | EmailAddressConflictError;
  719. export type CreateFacetInput = {
  720. code: Scalars['String']['input'];
  721. customFields?: InputMaybe<Scalars['JSON']['input']>;
  722. isPrivate: Scalars['Boolean']['input'];
  723. translations: Array<FacetTranslationInput>;
  724. values?: InputMaybe<Array<CreateFacetValueWithFacetInput>>;
  725. };
  726. export type CreateFacetValueInput = {
  727. code: Scalars['String']['input'];
  728. customFields?: InputMaybe<Scalars['JSON']['input']>;
  729. facetId: Scalars['ID']['input'];
  730. translations: Array<FacetValueTranslationInput>;
  731. };
  732. export type CreateFacetValueWithFacetInput = {
  733. code: Scalars['String']['input'];
  734. translations: Array<FacetValueTranslationInput>;
  735. };
  736. /** Returned if an error is thrown in a FulfillmentHandler's createFulfillment method */
  737. export type CreateFulfillmentError = ErrorResult & {
  738. __typename?: 'CreateFulfillmentError';
  739. errorCode: ErrorCode;
  740. fulfillmentHandlerError: Scalars['String']['output'];
  741. message: Scalars['String']['output'];
  742. };
  743. export type CreateGroupOptionInput = {
  744. code: Scalars['String']['input'];
  745. translations: Array<ProductOptionGroupTranslationInput>;
  746. };
  747. export type CreatePaymentMethodInput = {
  748. checker?: InputMaybe<ConfigurableOperationInput>;
  749. code: Scalars['String']['input'];
  750. customFields?: InputMaybe<Scalars['JSON']['input']>;
  751. enabled: Scalars['Boolean']['input'];
  752. handler: ConfigurableOperationInput;
  753. translations: Array<PaymentMethodTranslationInput>;
  754. };
  755. export type CreateProductInput = {
  756. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  757. customFields?: InputMaybe<Scalars['JSON']['input']>;
  758. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  759. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  760. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  761. translations: Array<ProductTranslationInput>;
  762. };
  763. export type CreateProductOptionGroupInput = {
  764. code: Scalars['String']['input'];
  765. customFields?: InputMaybe<Scalars['JSON']['input']>;
  766. options: Array<CreateGroupOptionInput>;
  767. translations: Array<ProductOptionGroupTranslationInput>;
  768. };
  769. export type CreateProductOptionInput = {
  770. code: Scalars['String']['input'];
  771. customFields?: InputMaybe<Scalars['JSON']['input']>;
  772. productOptionGroupId: Scalars['ID']['input'];
  773. translations: Array<ProductOptionGroupTranslationInput>;
  774. };
  775. export type CreateProductVariantInput = {
  776. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  777. customFields?: InputMaybe<Scalars['JSON']['input']>;
  778. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  779. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  780. optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  781. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  782. price?: InputMaybe<Scalars['Money']['input']>;
  783. productId: Scalars['ID']['input'];
  784. sku: Scalars['String']['input'];
  785. stockLevels?: InputMaybe<Array<StockLevelInput>>;
  786. stockOnHand?: InputMaybe<Scalars['Int']['input']>;
  787. taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
  788. trackInventory?: InputMaybe<GlobalFlag>;
  789. translations: Array<ProductVariantTranslationInput>;
  790. useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
  791. };
  792. export type CreateProductVariantOptionInput = {
  793. code: Scalars['String']['input'];
  794. optionGroupId: Scalars['ID']['input'];
  795. translations: Array<ProductOptionTranslationInput>;
  796. };
  797. export type CreatePromotionInput = {
  798. actions: Array<ConfigurableOperationInput>;
  799. conditions: Array<ConfigurableOperationInput>;
  800. couponCode?: InputMaybe<Scalars['String']['input']>;
  801. customFields?: InputMaybe<Scalars['JSON']['input']>;
  802. enabled: Scalars['Boolean']['input'];
  803. endsAt?: InputMaybe<Scalars['DateTime']['input']>;
  804. perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
  805. startsAt?: InputMaybe<Scalars['DateTime']['input']>;
  806. translations: Array<PromotionTranslationInput>;
  807. usageLimit?: InputMaybe<Scalars['Int']['input']>;
  808. };
  809. export type CreatePromotionResult = MissingConditionsError | Promotion;
  810. export type CreateProvinceInput = {
  811. code: Scalars['String']['input'];
  812. customFields?: InputMaybe<Scalars['JSON']['input']>;
  813. enabled: Scalars['Boolean']['input'];
  814. translations: Array<ProvinceTranslationInput>;
  815. };
  816. export type CreateRoleInput = {
  817. channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  818. code: Scalars['String']['input'];
  819. description: Scalars['String']['input'];
  820. permissions: Array<Permission>;
  821. };
  822. export type CreateSellerInput = {
  823. customFields?: InputMaybe<Scalars['JSON']['input']>;
  824. name: Scalars['String']['input'];
  825. };
  826. export type CreateShippingMethodInput = {
  827. calculator: ConfigurableOperationInput;
  828. checker: ConfigurableOperationInput;
  829. code: Scalars['String']['input'];
  830. customFields?: InputMaybe<Scalars['JSON']['input']>;
  831. fulfillmentHandler: Scalars['String']['input'];
  832. translations: Array<ShippingMethodTranslationInput>;
  833. };
  834. export type CreateStockLocationInput = {
  835. customFields?: InputMaybe<Scalars['JSON']['input']>;
  836. description?: InputMaybe<Scalars['String']['input']>;
  837. name: Scalars['String']['input'];
  838. };
  839. export type CreateTagInput = {
  840. value: Scalars['String']['input'];
  841. };
  842. export type CreateTaxCategoryInput = {
  843. customFields?: InputMaybe<Scalars['JSON']['input']>;
  844. isDefault?: InputMaybe<Scalars['Boolean']['input']>;
  845. name: Scalars['String']['input'];
  846. };
  847. export type CreateTaxRateInput = {
  848. categoryId: Scalars['ID']['input'];
  849. customFields?: InputMaybe<Scalars['JSON']['input']>;
  850. customerGroupId?: InputMaybe<Scalars['ID']['input']>;
  851. enabled: Scalars['Boolean']['input'];
  852. name: Scalars['String']['input'];
  853. value: Scalars['Float']['input'];
  854. zoneId: Scalars['ID']['input'];
  855. };
  856. export type CreateZoneInput = {
  857. customFields?: InputMaybe<Scalars['JSON']['input']>;
  858. memberIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  859. name: Scalars['String']['input'];
  860. };
  861. /**
  862. * @description
  863. * ISO 4217 currency code
  864. *
  865. * @docsCategory common
  866. */
  867. export enum CurrencyCode {
  868. /** United Arab Emirates dirham */
  869. AED = 'AED',
  870. /** Afghan afghani */
  871. AFN = 'AFN',
  872. /** Albanian lek */
  873. ALL = 'ALL',
  874. /** Armenian dram */
  875. AMD = 'AMD',
  876. /** Netherlands Antillean guilder */
  877. ANG = 'ANG',
  878. /** Angolan kwanza */
  879. AOA = 'AOA',
  880. /** Argentine peso */
  881. ARS = 'ARS',
  882. /** Australian dollar */
  883. AUD = 'AUD',
  884. /** Aruban florin */
  885. AWG = 'AWG',
  886. /** Azerbaijani manat */
  887. AZN = 'AZN',
  888. /** Bosnia and Herzegovina convertible mark */
  889. BAM = 'BAM',
  890. /** Barbados dollar */
  891. BBD = 'BBD',
  892. /** Bangladeshi taka */
  893. BDT = 'BDT',
  894. /** Bulgarian lev */
  895. BGN = 'BGN',
  896. /** Bahraini dinar */
  897. BHD = 'BHD',
  898. /** Burundian franc */
  899. BIF = 'BIF',
  900. /** Bermudian dollar */
  901. BMD = 'BMD',
  902. /** Brunei dollar */
  903. BND = 'BND',
  904. /** Boliviano */
  905. BOB = 'BOB',
  906. /** Brazilian real */
  907. BRL = 'BRL',
  908. /** Bahamian dollar */
  909. BSD = 'BSD',
  910. /** Bhutanese ngultrum */
  911. BTN = 'BTN',
  912. /** Botswana pula */
  913. BWP = 'BWP',
  914. /** Belarusian ruble */
  915. BYN = 'BYN',
  916. /** Belize dollar */
  917. BZD = 'BZD',
  918. /** Canadian dollar */
  919. CAD = 'CAD',
  920. /** Congolese franc */
  921. CDF = 'CDF',
  922. /** Swiss franc */
  923. CHF = 'CHF',
  924. /** Chilean peso */
  925. CLP = 'CLP',
  926. /** Renminbi (Chinese) yuan */
  927. CNY = 'CNY',
  928. /** Colombian peso */
  929. COP = 'COP',
  930. /** Costa Rican colon */
  931. CRC = 'CRC',
  932. /** Cuban convertible peso */
  933. CUC = 'CUC',
  934. /** Cuban peso */
  935. CUP = 'CUP',
  936. /** Cape Verde escudo */
  937. CVE = 'CVE',
  938. /** Czech koruna */
  939. CZK = 'CZK',
  940. /** Djiboutian franc */
  941. DJF = 'DJF',
  942. /** Danish krone */
  943. DKK = 'DKK',
  944. /** Dominican peso */
  945. DOP = 'DOP',
  946. /** Algerian dinar */
  947. DZD = 'DZD',
  948. /** Egyptian pound */
  949. EGP = 'EGP',
  950. /** Eritrean nakfa */
  951. ERN = 'ERN',
  952. /** Ethiopian birr */
  953. ETB = 'ETB',
  954. /** Euro */
  955. EUR = 'EUR',
  956. /** Fiji dollar */
  957. FJD = 'FJD',
  958. /** Falkland Islands pound */
  959. FKP = 'FKP',
  960. /** Pound sterling */
  961. GBP = 'GBP',
  962. /** Georgian lari */
  963. GEL = 'GEL',
  964. /** Ghanaian cedi */
  965. GHS = 'GHS',
  966. /** Gibraltar pound */
  967. GIP = 'GIP',
  968. /** Gambian dalasi */
  969. GMD = 'GMD',
  970. /** Guinean franc */
  971. GNF = 'GNF',
  972. /** Guatemalan quetzal */
  973. GTQ = 'GTQ',
  974. /** Guyanese dollar */
  975. GYD = 'GYD',
  976. /** Hong Kong dollar */
  977. HKD = 'HKD',
  978. /** Honduran lempira */
  979. HNL = 'HNL',
  980. /** Croatian kuna */
  981. HRK = 'HRK',
  982. /** Haitian gourde */
  983. HTG = 'HTG',
  984. /** Hungarian forint */
  985. HUF = 'HUF',
  986. /** Indonesian rupiah */
  987. IDR = 'IDR',
  988. /** Israeli new shekel */
  989. ILS = 'ILS',
  990. /** Indian rupee */
  991. INR = 'INR',
  992. /** Iraqi dinar */
  993. IQD = 'IQD',
  994. /** Iranian rial */
  995. IRR = 'IRR',
  996. /** Icelandic króna */
  997. ISK = 'ISK',
  998. /** Jamaican dollar */
  999. JMD = 'JMD',
  1000. /** Jordanian dinar */
  1001. JOD = 'JOD',
  1002. /** Japanese yen */
  1003. JPY = 'JPY',
  1004. /** Kenyan shilling */
  1005. KES = 'KES',
  1006. /** Kyrgyzstani som */
  1007. KGS = 'KGS',
  1008. /** Cambodian riel */
  1009. KHR = 'KHR',
  1010. /** Comoro franc */
  1011. KMF = 'KMF',
  1012. /** North Korean won */
  1013. KPW = 'KPW',
  1014. /** South Korean won */
  1015. KRW = 'KRW',
  1016. /** Kuwaiti dinar */
  1017. KWD = 'KWD',
  1018. /** Cayman Islands dollar */
  1019. KYD = 'KYD',
  1020. /** Kazakhstani tenge */
  1021. KZT = 'KZT',
  1022. /** Lao kip */
  1023. LAK = 'LAK',
  1024. /** Lebanese pound */
  1025. LBP = 'LBP',
  1026. /** Sri Lankan rupee */
  1027. LKR = 'LKR',
  1028. /** Liberian dollar */
  1029. LRD = 'LRD',
  1030. /** Lesotho loti */
  1031. LSL = 'LSL',
  1032. /** Libyan dinar */
  1033. LYD = 'LYD',
  1034. /** Moroccan dirham */
  1035. MAD = 'MAD',
  1036. /** Moldovan leu */
  1037. MDL = 'MDL',
  1038. /** Malagasy ariary */
  1039. MGA = 'MGA',
  1040. /** Macedonian denar */
  1041. MKD = 'MKD',
  1042. /** Myanmar kyat */
  1043. MMK = 'MMK',
  1044. /** Mongolian tögrög */
  1045. MNT = 'MNT',
  1046. /** Macanese pataca */
  1047. MOP = 'MOP',
  1048. /** Mauritanian ouguiya */
  1049. MRU = 'MRU',
  1050. /** Mauritian rupee */
  1051. MUR = 'MUR',
  1052. /** Maldivian rufiyaa */
  1053. MVR = 'MVR',
  1054. /** Malawian kwacha */
  1055. MWK = 'MWK',
  1056. /** Mexican peso */
  1057. MXN = 'MXN',
  1058. /** Malaysian ringgit */
  1059. MYR = 'MYR',
  1060. /** Mozambican metical */
  1061. MZN = 'MZN',
  1062. /** Namibian dollar */
  1063. NAD = 'NAD',
  1064. /** Nigerian naira */
  1065. NGN = 'NGN',
  1066. /** Nicaraguan córdoba */
  1067. NIO = 'NIO',
  1068. /** Norwegian krone */
  1069. NOK = 'NOK',
  1070. /** Nepalese rupee */
  1071. NPR = 'NPR',
  1072. /** New Zealand dollar */
  1073. NZD = 'NZD',
  1074. /** Omani rial */
  1075. OMR = 'OMR',
  1076. /** Panamanian balboa */
  1077. PAB = 'PAB',
  1078. /** Peruvian sol */
  1079. PEN = 'PEN',
  1080. /** Papua New Guinean kina */
  1081. PGK = 'PGK',
  1082. /** Philippine peso */
  1083. PHP = 'PHP',
  1084. /** Pakistani rupee */
  1085. PKR = 'PKR',
  1086. /** Polish złoty */
  1087. PLN = 'PLN',
  1088. /** Paraguayan guaraní */
  1089. PYG = 'PYG',
  1090. /** Qatari riyal */
  1091. QAR = 'QAR',
  1092. /** Romanian leu */
  1093. RON = 'RON',
  1094. /** Serbian dinar */
  1095. RSD = 'RSD',
  1096. /** Russian ruble */
  1097. RUB = 'RUB',
  1098. /** Rwandan franc */
  1099. RWF = 'RWF',
  1100. /** Saudi riyal */
  1101. SAR = 'SAR',
  1102. /** Solomon Islands dollar */
  1103. SBD = 'SBD',
  1104. /** Seychelles rupee */
  1105. SCR = 'SCR',
  1106. /** Sudanese pound */
  1107. SDG = 'SDG',
  1108. /** Swedish krona/kronor */
  1109. SEK = 'SEK',
  1110. /** Singapore dollar */
  1111. SGD = 'SGD',
  1112. /** Saint Helena pound */
  1113. SHP = 'SHP',
  1114. /** Sierra Leonean leone */
  1115. SLL = 'SLL',
  1116. /** Somali shilling */
  1117. SOS = 'SOS',
  1118. /** Surinamese dollar */
  1119. SRD = 'SRD',
  1120. /** South Sudanese pound */
  1121. SSP = 'SSP',
  1122. /** São Tomé and Príncipe dobra */
  1123. STN = 'STN',
  1124. /** Salvadoran colón */
  1125. SVC = 'SVC',
  1126. /** Syrian pound */
  1127. SYP = 'SYP',
  1128. /** Swazi lilangeni */
  1129. SZL = 'SZL',
  1130. /** Thai baht */
  1131. THB = 'THB',
  1132. /** Tajikistani somoni */
  1133. TJS = 'TJS',
  1134. /** Turkmenistan manat */
  1135. TMT = 'TMT',
  1136. /** Tunisian dinar */
  1137. TND = 'TND',
  1138. /** Tongan paʻanga */
  1139. TOP = 'TOP',
  1140. /** Turkish lira */
  1141. TRY = 'TRY',
  1142. /** Trinidad and Tobago dollar */
  1143. TTD = 'TTD',
  1144. /** New Taiwan dollar */
  1145. TWD = 'TWD',
  1146. /** Tanzanian shilling */
  1147. TZS = 'TZS',
  1148. /** Ukrainian hryvnia */
  1149. UAH = 'UAH',
  1150. /** Ugandan shilling */
  1151. UGX = 'UGX',
  1152. /** United States dollar */
  1153. USD = 'USD',
  1154. /** Uruguayan peso */
  1155. UYU = 'UYU',
  1156. /** Uzbekistan som */
  1157. UZS = 'UZS',
  1158. /** Venezuelan bolívar soberano */
  1159. VES = 'VES',
  1160. /** Vietnamese đồng */
  1161. VND = 'VND',
  1162. /** Vanuatu vatu */
  1163. VUV = 'VUV',
  1164. /** Samoan tala */
  1165. WST = 'WST',
  1166. /** CFA franc BEAC */
  1167. XAF = 'XAF',
  1168. /** East Caribbean dollar */
  1169. XCD = 'XCD',
  1170. /** CFA franc BCEAO */
  1171. XOF = 'XOF',
  1172. /** CFP franc (franc Pacifique) */
  1173. XPF = 'XPF',
  1174. /** Yemeni rial */
  1175. YER = 'YER',
  1176. /** South African rand */
  1177. ZAR = 'ZAR',
  1178. /** Zambian kwacha */
  1179. ZMW = 'ZMW',
  1180. /** Zimbabwean dollar */
  1181. ZWL = 'ZWL'
  1182. }
  1183. export type CurrentUser = {
  1184. __typename?: 'CurrentUser';
  1185. channels: Array<CurrentUserChannel>;
  1186. id: Scalars['ID']['output'];
  1187. identifier: Scalars['String']['output'];
  1188. };
  1189. export type CurrentUserChannel = {
  1190. __typename?: 'CurrentUserChannel';
  1191. code: Scalars['String']['output'];
  1192. id: Scalars['ID']['output'];
  1193. permissions: Array<Permission>;
  1194. token: Scalars['String']['output'];
  1195. };
  1196. export type CustomField = {
  1197. description?: Maybe<Array<LocalizedString>>;
  1198. internal?: Maybe<Scalars['Boolean']['output']>;
  1199. label?: Maybe<Array<LocalizedString>>;
  1200. list: Scalars['Boolean']['output'];
  1201. name: Scalars['String']['output'];
  1202. nullable?: Maybe<Scalars['Boolean']['output']>;
  1203. readonly?: Maybe<Scalars['Boolean']['output']>;
  1204. requiresPermission?: Maybe<Array<Permission>>;
  1205. type: Scalars['String']['output'];
  1206. ui?: Maybe<Scalars['JSON']['output']>;
  1207. };
  1208. export type CustomFieldConfig = BooleanCustomFieldConfig | DateTimeCustomFieldConfig | FloatCustomFieldConfig | IntCustomFieldConfig | LocaleStringCustomFieldConfig | LocaleTextCustomFieldConfig | RelationCustomFieldConfig | StringCustomFieldConfig | TextCustomFieldConfig;
  1209. /**
  1210. * This type is deprecated in v2.2 in favor of the EntityCustomFields type,
  1211. * which allows custom fields to be defined on user-supplies entities.
  1212. */
  1213. export type CustomFields = {
  1214. __typename?: 'CustomFields';
  1215. Address: Array<CustomFieldConfig>;
  1216. Administrator: Array<CustomFieldConfig>;
  1217. Asset: Array<CustomFieldConfig>;
  1218. Channel: Array<CustomFieldConfig>;
  1219. Collection: Array<CustomFieldConfig>;
  1220. Customer: Array<CustomFieldConfig>;
  1221. CustomerGroup: Array<CustomFieldConfig>;
  1222. Facet: Array<CustomFieldConfig>;
  1223. FacetValue: Array<CustomFieldConfig>;
  1224. Fulfillment: Array<CustomFieldConfig>;
  1225. GlobalSettings: Array<CustomFieldConfig>;
  1226. Order: Array<CustomFieldConfig>;
  1227. OrderLine: Array<CustomFieldConfig>;
  1228. PaymentMethod: Array<CustomFieldConfig>;
  1229. Product: Array<CustomFieldConfig>;
  1230. ProductOption: Array<CustomFieldConfig>;
  1231. ProductOptionGroup: Array<CustomFieldConfig>;
  1232. ProductVariant: Array<CustomFieldConfig>;
  1233. ProductVariantPrice: Array<CustomFieldConfig>;
  1234. Promotion: Array<CustomFieldConfig>;
  1235. Region: Array<CustomFieldConfig>;
  1236. Seller: Array<CustomFieldConfig>;
  1237. ShippingMethod: Array<CustomFieldConfig>;
  1238. StockLocation: Array<CustomFieldConfig>;
  1239. TaxCategory: Array<CustomFieldConfig>;
  1240. TaxRate: Array<CustomFieldConfig>;
  1241. User: Array<CustomFieldConfig>;
  1242. Zone: Array<CustomFieldConfig>;
  1243. };
  1244. export type Customer = Node & {
  1245. __typename?: 'Customer';
  1246. addresses?: Maybe<Array<Address>>;
  1247. createdAt: Scalars['DateTime']['output'];
  1248. customFields?: Maybe<Scalars['JSON']['output']>;
  1249. emailAddress: Scalars['String']['output'];
  1250. firstName: Scalars['String']['output'];
  1251. groups: Array<CustomerGroup>;
  1252. history: HistoryEntryList;
  1253. id: Scalars['ID']['output'];
  1254. lastName: Scalars['String']['output'];
  1255. orders: OrderList;
  1256. phoneNumber?: Maybe<Scalars['String']['output']>;
  1257. title?: Maybe<Scalars['String']['output']>;
  1258. updatedAt: Scalars['DateTime']['output'];
  1259. user?: Maybe<User>;
  1260. };
  1261. export type CustomerHistoryArgs = {
  1262. options?: InputMaybe<HistoryEntryListOptions>;
  1263. };
  1264. export type CustomerOrdersArgs = {
  1265. options?: InputMaybe<OrderListOptions>;
  1266. };
  1267. export type CustomerFilterParameter = {
  1268. _and?: InputMaybe<Array<CustomerFilterParameter>>;
  1269. _or?: InputMaybe<Array<CustomerFilterParameter>>;
  1270. createdAt?: InputMaybe<DateOperators>;
  1271. emailAddress?: InputMaybe<StringOperators>;
  1272. firstName?: InputMaybe<StringOperators>;
  1273. id?: InputMaybe<IdOperators>;
  1274. lastName?: InputMaybe<StringOperators>;
  1275. phoneNumber?: InputMaybe<StringOperators>;
  1276. postalCode?: InputMaybe<StringOperators>;
  1277. title?: InputMaybe<StringOperators>;
  1278. updatedAt?: InputMaybe<DateOperators>;
  1279. };
  1280. export type CustomerGroup = Node & {
  1281. __typename?: 'CustomerGroup';
  1282. createdAt: Scalars['DateTime']['output'];
  1283. customFields?: Maybe<Scalars['JSON']['output']>;
  1284. customers: CustomerList;
  1285. id: Scalars['ID']['output'];
  1286. name: Scalars['String']['output'];
  1287. updatedAt: Scalars['DateTime']['output'];
  1288. };
  1289. export type CustomerGroupCustomersArgs = {
  1290. options?: InputMaybe<CustomerListOptions>;
  1291. };
  1292. export type CustomerGroupFilterParameter = {
  1293. _and?: InputMaybe<Array<CustomerGroupFilterParameter>>;
  1294. _or?: InputMaybe<Array<CustomerGroupFilterParameter>>;
  1295. createdAt?: InputMaybe<DateOperators>;
  1296. id?: InputMaybe<IdOperators>;
  1297. name?: InputMaybe<StringOperators>;
  1298. updatedAt?: InputMaybe<DateOperators>;
  1299. };
  1300. export type CustomerGroupList = PaginatedList & {
  1301. __typename?: 'CustomerGroupList';
  1302. items: Array<CustomerGroup>;
  1303. totalItems: Scalars['Int']['output'];
  1304. };
  1305. export type CustomerGroupListOptions = {
  1306. /** Allows the results to be filtered */
  1307. filter?: InputMaybe<CustomerGroupFilterParameter>;
  1308. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1309. filterOperator?: InputMaybe<LogicalOperator>;
  1310. /** Skips the first n results, for use in pagination */
  1311. skip?: InputMaybe<Scalars['Int']['input']>;
  1312. /** Specifies which properties to sort the results by */
  1313. sort?: InputMaybe<CustomerGroupSortParameter>;
  1314. /** Takes n results, for use in pagination */
  1315. take?: InputMaybe<Scalars['Int']['input']>;
  1316. };
  1317. export type CustomerGroupSortParameter = {
  1318. createdAt?: InputMaybe<SortOrder>;
  1319. id?: InputMaybe<SortOrder>;
  1320. name?: InputMaybe<SortOrder>;
  1321. updatedAt?: InputMaybe<SortOrder>;
  1322. };
  1323. export type CustomerList = PaginatedList & {
  1324. __typename?: 'CustomerList';
  1325. items: Array<Customer>;
  1326. totalItems: Scalars['Int']['output'];
  1327. };
  1328. export type CustomerListOptions = {
  1329. /** Allows the results to be filtered */
  1330. filter?: InputMaybe<CustomerFilterParameter>;
  1331. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1332. filterOperator?: InputMaybe<LogicalOperator>;
  1333. /** Skips the first n results, for use in pagination */
  1334. skip?: InputMaybe<Scalars['Int']['input']>;
  1335. /** Specifies which properties to sort the results by */
  1336. sort?: InputMaybe<CustomerSortParameter>;
  1337. /** Takes n results, for use in pagination */
  1338. take?: InputMaybe<Scalars['Int']['input']>;
  1339. };
  1340. export type CustomerSortParameter = {
  1341. createdAt?: InputMaybe<SortOrder>;
  1342. emailAddress?: InputMaybe<SortOrder>;
  1343. firstName?: InputMaybe<SortOrder>;
  1344. id?: InputMaybe<SortOrder>;
  1345. lastName?: InputMaybe<SortOrder>;
  1346. phoneNumber?: InputMaybe<SortOrder>;
  1347. title?: InputMaybe<SortOrder>;
  1348. updatedAt?: InputMaybe<SortOrder>;
  1349. };
  1350. /** Operators for filtering on a list of Date fields */
  1351. export type DateListOperators = {
  1352. inList: Scalars['DateTime']['input'];
  1353. };
  1354. /** Operators for filtering on a DateTime field */
  1355. export type DateOperators = {
  1356. after?: InputMaybe<Scalars['DateTime']['input']>;
  1357. before?: InputMaybe<Scalars['DateTime']['input']>;
  1358. between?: InputMaybe<DateRange>;
  1359. eq?: InputMaybe<Scalars['DateTime']['input']>;
  1360. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  1361. };
  1362. export type DateRange = {
  1363. end: Scalars['DateTime']['input'];
  1364. start: Scalars['DateTime']['input'];
  1365. };
  1366. /**
  1367. * Expects the same validation formats as the `<input type="datetime-local">` HTML element.
  1368. * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
  1369. */
  1370. export type DateTimeCustomFieldConfig = CustomField & {
  1371. __typename?: 'DateTimeCustomFieldConfig';
  1372. description?: Maybe<Array<LocalizedString>>;
  1373. internal?: Maybe<Scalars['Boolean']['output']>;
  1374. label?: Maybe<Array<LocalizedString>>;
  1375. list: Scalars['Boolean']['output'];
  1376. max?: Maybe<Scalars['String']['output']>;
  1377. min?: Maybe<Scalars['String']['output']>;
  1378. name: Scalars['String']['output'];
  1379. nullable?: Maybe<Scalars['Boolean']['output']>;
  1380. readonly?: Maybe<Scalars['Boolean']['output']>;
  1381. requiresPermission?: Maybe<Array<Permission>>;
  1382. step?: Maybe<Scalars['Int']['output']>;
  1383. type: Scalars['String']['output'];
  1384. ui?: Maybe<Scalars['JSON']['output']>;
  1385. };
  1386. export type DeleteAssetInput = {
  1387. assetId: Scalars['ID']['input'];
  1388. deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
  1389. force?: InputMaybe<Scalars['Boolean']['input']>;
  1390. };
  1391. export type DeleteAssetsInput = {
  1392. assetIds: Array<Scalars['ID']['input']>;
  1393. deleteFromAllChannels?: InputMaybe<Scalars['Boolean']['input']>;
  1394. force?: InputMaybe<Scalars['Boolean']['input']>;
  1395. };
  1396. export type DeleteStockLocationInput = {
  1397. id: Scalars['ID']['input'];
  1398. transferToLocationId?: InputMaybe<Scalars['ID']['input']>;
  1399. };
  1400. export type DeletionResponse = {
  1401. __typename?: 'DeletionResponse';
  1402. message?: Maybe<Scalars['String']['output']>;
  1403. result: DeletionResult;
  1404. };
  1405. export enum DeletionResult {
  1406. /** The entity was successfully deleted */
  1407. DELETED = 'DELETED',
  1408. /** Deletion did not take place, reason given in message */
  1409. NOT_DELETED = 'NOT_DELETED'
  1410. }
  1411. export type Discount = {
  1412. __typename?: 'Discount';
  1413. adjustmentSource: Scalars['String']['output'];
  1414. amount: Scalars['Money']['output'];
  1415. amountWithTax: Scalars['Money']['output'];
  1416. description: Scalars['String']['output'];
  1417. type: AdjustmentType;
  1418. };
  1419. export type DuplicateEntityError = ErrorResult & {
  1420. __typename?: 'DuplicateEntityError';
  1421. duplicationError: Scalars['String']['output'];
  1422. errorCode: ErrorCode;
  1423. message: Scalars['String']['output'];
  1424. };
  1425. export type DuplicateEntityInput = {
  1426. duplicatorInput: ConfigurableOperationInput;
  1427. entityId: Scalars['ID']['input'];
  1428. entityName: Scalars['String']['input'];
  1429. };
  1430. export type DuplicateEntityResult = DuplicateEntityError | DuplicateEntitySuccess;
  1431. export type DuplicateEntitySuccess = {
  1432. __typename?: 'DuplicateEntitySuccess';
  1433. newEntityId: Scalars['ID']['output'];
  1434. };
  1435. /** Returned when attempting to create a Customer with an email address already registered to an existing User. */
  1436. export type EmailAddressConflictError = ErrorResult & {
  1437. __typename?: 'EmailAddressConflictError';
  1438. errorCode: ErrorCode;
  1439. message: Scalars['String']['output'];
  1440. };
  1441. /** Returned if no OrderLines have been specified for the operation */
  1442. export type EmptyOrderLineSelectionError = ErrorResult & {
  1443. __typename?: 'EmptyOrderLineSelectionError';
  1444. errorCode: ErrorCode;
  1445. message: Scalars['String']['output'];
  1446. };
  1447. export type EntityCustomFields = {
  1448. __typename?: 'EntityCustomFields';
  1449. customFields: Array<CustomFieldConfig>;
  1450. entityName: Scalars['String']['output'];
  1451. };
  1452. export type EntityDuplicatorDefinition = {
  1453. __typename?: 'EntityDuplicatorDefinition';
  1454. args: Array<ConfigArgDefinition>;
  1455. code: Scalars['String']['output'];
  1456. description: Scalars['String']['output'];
  1457. forEntities: Array<Scalars['String']['output']>;
  1458. requiresPermission: Array<Permission>;
  1459. };
  1460. export enum ErrorCode {
  1461. ALREADY_REFUNDED_ERROR = 'ALREADY_REFUNDED_ERROR',
  1462. CANCEL_ACTIVE_ORDER_ERROR = 'CANCEL_ACTIVE_ORDER_ERROR',
  1463. CANCEL_PAYMENT_ERROR = 'CANCEL_PAYMENT_ERROR',
  1464. CHANNEL_DEFAULT_LANGUAGE_ERROR = 'CHANNEL_DEFAULT_LANGUAGE_ERROR',
  1465. COUPON_CODE_EXPIRED_ERROR = 'COUPON_CODE_EXPIRED_ERROR',
  1466. COUPON_CODE_INVALID_ERROR = 'COUPON_CODE_INVALID_ERROR',
  1467. COUPON_CODE_LIMIT_ERROR = 'COUPON_CODE_LIMIT_ERROR',
  1468. CREATE_FULFILLMENT_ERROR = 'CREATE_FULFILLMENT_ERROR',
  1469. DUPLICATE_ENTITY_ERROR = 'DUPLICATE_ENTITY_ERROR',
  1470. EMAIL_ADDRESS_CONFLICT_ERROR = 'EMAIL_ADDRESS_CONFLICT_ERROR',
  1471. EMPTY_ORDER_LINE_SELECTION_ERROR = 'EMPTY_ORDER_LINE_SELECTION_ERROR',
  1472. FACET_IN_USE_ERROR = 'FACET_IN_USE_ERROR',
  1473. FULFILLMENT_STATE_TRANSITION_ERROR = 'FULFILLMENT_STATE_TRANSITION_ERROR',
  1474. GUEST_CHECKOUT_ERROR = 'GUEST_CHECKOUT_ERROR',
  1475. INELIGIBLE_SHIPPING_METHOD_ERROR = 'INELIGIBLE_SHIPPING_METHOD_ERROR',
  1476. INSUFFICIENT_STOCK_ERROR = 'INSUFFICIENT_STOCK_ERROR',
  1477. INSUFFICIENT_STOCK_ON_HAND_ERROR = 'INSUFFICIENT_STOCK_ON_HAND_ERROR',
  1478. INVALID_CREDENTIALS_ERROR = 'INVALID_CREDENTIALS_ERROR',
  1479. INVALID_FULFILLMENT_HANDLER_ERROR = 'INVALID_FULFILLMENT_HANDLER_ERROR',
  1480. ITEMS_ALREADY_FULFILLED_ERROR = 'ITEMS_ALREADY_FULFILLED_ERROR',
  1481. LANGUAGE_NOT_AVAILABLE_ERROR = 'LANGUAGE_NOT_AVAILABLE_ERROR',
  1482. MANUAL_PAYMENT_STATE_ERROR = 'MANUAL_PAYMENT_STATE_ERROR',
  1483. MIME_TYPE_ERROR = 'MIME_TYPE_ERROR',
  1484. MISSING_CONDITIONS_ERROR = 'MISSING_CONDITIONS_ERROR',
  1485. MULTIPLE_ORDER_ERROR = 'MULTIPLE_ORDER_ERROR',
  1486. NATIVE_AUTH_STRATEGY_ERROR = 'NATIVE_AUTH_STRATEGY_ERROR',
  1487. NEGATIVE_QUANTITY_ERROR = 'NEGATIVE_QUANTITY_ERROR',
  1488. NOTHING_TO_REFUND_ERROR = 'NOTHING_TO_REFUND_ERROR',
  1489. NO_ACTIVE_ORDER_ERROR = 'NO_ACTIVE_ORDER_ERROR',
  1490. NO_CHANGES_SPECIFIED_ERROR = 'NO_CHANGES_SPECIFIED_ERROR',
  1491. ORDER_LIMIT_ERROR = 'ORDER_LIMIT_ERROR',
  1492. ORDER_MODIFICATION_ERROR = 'ORDER_MODIFICATION_ERROR',
  1493. ORDER_MODIFICATION_STATE_ERROR = 'ORDER_MODIFICATION_STATE_ERROR',
  1494. ORDER_STATE_TRANSITION_ERROR = 'ORDER_STATE_TRANSITION_ERROR',
  1495. PAYMENT_METHOD_MISSING_ERROR = 'PAYMENT_METHOD_MISSING_ERROR',
  1496. PAYMENT_ORDER_MISMATCH_ERROR = 'PAYMENT_ORDER_MISMATCH_ERROR',
  1497. PAYMENT_STATE_TRANSITION_ERROR = 'PAYMENT_STATE_TRANSITION_ERROR',
  1498. PRODUCT_OPTION_IN_USE_ERROR = 'PRODUCT_OPTION_IN_USE_ERROR',
  1499. QUANTITY_TOO_GREAT_ERROR = 'QUANTITY_TOO_GREAT_ERROR',
  1500. REFUND_AMOUNT_ERROR = 'REFUND_AMOUNT_ERROR',
  1501. REFUND_ORDER_STATE_ERROR = 'REFUND_ORDER_STATE_ERROR',
  1502. REFUND_PAYMENT_ID_MISSING_ERROR = 'REFUND_PAYMENT_ID_MISSING_ERROR',
  1503. REFUND_STATE_TRANSITION_ERROR = 'REFUND_STATE_TRANSITION_ERROR',
  1504. SETTLE_PAYMENT_ERROR = 'SETTLE_PAYMENT_ERROR',
  1505. UNKNOWN_ERROR = 'UNKNOWN_ERROR'
  1506. }
  1507. export type ErrorResult = {
  1508. errorCode: ErrorCode;
  1509. message: Scalars['String']['output'];
  1510. };
  1511. export type Facet = Node & {
  1512. __typename?: 'Facet';
  1513. code: Scalars['String']['output'];
  1514. createdAt: Scalars['DateTime']['output'];
  1515. customFields?: Maybe<Scalars['JSON']['output']>;
  1516. id: Scalars['ID']['output'];
  1517. isPrivate: Scalars['Boolean']['output'];
  1518. languageCode: LanguageCode;
  1519. name: Scalars['String']['output'];
  1520. translations: Array<FacetTranslation>;
  1521. updatedAt: Scalars['DateTime']['output'];
  1522. /** Returns a paginated, sortable, filterable list of the Facet's values. Added in v2.1.0. */
  1523. valueList: FacetValueList;
  1524. values: Array<FacetValue>;
  1525. };
  1526. export type FacetValueListArgs = {
  1527. options?: InputMaybe<FacetValueListOptions>;
  1528. };
  1529. export type FacetFilterParameter = {
  1530. _and?: InputMaybe<Array<FacetFilterParameter>>;
  1531. _or?: InputMaybe<Array<FacetFilterParameter>>;
  1532. code?: InputMaybe<StringOperators>;
  1533. createdAt?: InputMaybe<DateOperators>;
  1534. id?: InputMaybe<IdOperators>;
  1535. isPrivate?: InputMaybe<BooleanOperators>;
  1536. languageCode?: InputMaybe<StringOperators>;
  1537. name?: InputMaybe<StringOperators>;
  1538. updatedAt?: InputMaybe<DateOperators>;
  1539. };
  1540. export type FacetInUseError = ErrorResult & {
  1541. __typename?: 'FacetInUseError';
  1542. errorCode: ErrorCode;
  1543. facetCode: Scalars['String']['output'];
  1544. message: Scalars['String']['output'];
  1545. productCount: Scalars['Int']['output'];
  1546. variantCount: Scalars['Int']['output'];
  1547. };
  1548. export type FacetList = PaginatedList & {
  1549. __typename?: 'FacetList';
  1550. items: Array<Facet>;
  1551. totalItems: Scalars['Int']['output'];
  1552. };
  1553. export type FacetListOptions = {
  1554. /** Allows the results to be filtered */
  1555. filter?: InputMaybe<FacetFilterParameter>;
  1556. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1557. filterOperator?: InputMaybe<LogicalOperator>;
  1558. /** Skips the first n results, for use in pagination */
  1559. skip?: InputMaybe<Scalars['Int']['input']>;
  1560. /** Specifies which properties to sort the results by */
  1561. sort?: InputMaybe<FacetSortParameter>;
  1562. /** Takes n results, for use in pagination */
  1563. take?: InputMaybe<Scalars['Int']['input']>;
  1564. };
  1565. export type FacetSortParameter = {
  1566. code?: InputMaybe<SortOrder>;
  1567. createdAt?: InputMaybe<SortOrder>;
  1568. id?: InputMaybe<SortOrder>;
  1569. name?: InputMaybe<SortOrder>;
  1570. updatedAt?: InputMaybe<SortOrder>;
  1571. };
  1572. export type FacetTranslation = {
  1573. __typename?: 'FacetTranslation';
  1574. createdAt: Scalars['DateTime']['output'];
  1575. id: Scalars['ID']['output'];
  1576. languageCode: LanguageCode;
  1577. name: Scalars['String']['output'];
  1578. updatedAt: Scalars['DateTime']['output'];
  1579. };
  1580. export type FacetTranslationInput = {
  1581. customFields?: InputMaybe<Scalars['JSON']['input']>;
  1582. id?: InputMaybe<Scalars['ID']['input']>;
  1583. languageCode: LanguageCode;
  1584. name?: InputMaybe<Scalars['String']['input']>;
  1585. };
  1586. export type FacetValue = Node & {
  1587. __typename?: 'FacetValue';
  1588. code: Scalars['String']['output'];
  1589. createdAt: Scalars['DateTime']['output'];
  1590. customFields?: Maybe<Scalars['JSON']['output']>;
  1591. facet: Facet;
  1592. facetId: Scalars['ID']['output'];
  1593. id: Scalars['ID']['output'];
  1594. languageCode: LanguageCode;
  1595. name: Scalars['String']['output'];
  1596. translations: Array<FacetValueTranslation>;
  1597. updatedAt: Scalars['DateTime']['output'];
  1598. };
  1599. /**
  1600. * Used to construct boolean expressions for filtering search results
  1601. * by FacetValue ID. Examples:
  1602. *
  1603. * * ID=1 OR ID=2: `{ facetValueFilters: [{ or: [1,2] }] }`
  1604. * * ID=1 AND ID=2: `{ facetValueFilters: [{ and: 1 }, { and: 2 }] }`
  1605. * * ID=1 AND (ID=2 OR ID=3): `{ facetValueFilters: [{ and: 1 }, { or: [2,3] }] }`
  1606. */
  1607. export type FacetValueFilterInput = {
  1608. and?: InputMaybe<Scalars['ID']['input']>;
  1609. or?: InputMaybe<Array<Scalars['ID']['input']>>;
  1610. };
  1611. export type FacetValueFilterParameter = {
  1612. _and?: InputMaybe<Array<FacetValueFilterParameter>>;
  1613. _or?: InputMaybe<Array<FacetValueFilterParameter>>;
  1614. code?: InputMaybe<StringOperators>;
  1615. createdAt?: InputMaybe<DateOperators>;
  1616. facetId?: InputMaybe<IdOperators>;
  1617. id?: InputMaybe<IdOperators>;
  1618. languageCode?: InputMaybe<StringOperators>;
  1619. name?: InputMaybe<StringOperators>;
  1620. updatedAt?: InputMaybe<DateOperators>;
  1621. };
  1622. export type FacetValueList = PaginatedList & {
  1623. __typename?: 'FacetValueList';
  1624. items: Array<FacetValue>;
  1625. totalItems: Scalars['Int']['output'];
  1626. };
  1627. export type FacetValueListOptions = {
  1628. /** Allows the results to be filtered */
  1629. filter?: InputMaybe<FacetValueFilterParameter>;
  1630. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1631. filterOperator?: InputMaybe<LogicalOperator>;
  1632. /** Skips the first n results, for use in pagination */
  1633. skip?: InputMaybe<Scalars['Int']['input']>;
  1634. /** Specifies which properties to sort the results by */
  1635. sort?: InputMaybe<FacetValueSortParameter>;
  1636. /** Takes n results, for use in pagination */
  1637. take?: InputMaybe<Scalars['Int']['input']>;
  1638. };
  1639. /**
  1640. * Which FacetValues are present in the products returned
  1641. * by the search, and in what quantity.
  1642. */
  1643. export type FacetValueResult = {
  1644. __typename?: 'FacetValueResult';
  1645. count: Scalars['Int']['output'];
  1646. facetValue: FacetValue;
  1647. };
  1648. export type FacetValueSortParameter = {
  1649. code?: InputMaybe<SortOrder>;
  1650. createdAt?: InputMaybe<SortOrder>;
  1651. facetId?: InputMaybe<SortOrder>;
  1652. id?: InputMaybe<SortOrder>;
  1653. name?: InputMaybe<SortOrder>;
  1654. updatedAt?: InputMaybe<SortOrder>;
  1655. };
  1656. export type FacetValueTranslation = {
  1657. __typename?: 'FacetValueTranslation';
  1658. createdAt: Scalars['DateTime']['output'];
  1659. id: Scalars['ID']['output'];
  1660. languageCode: LanguageCode;
  1661. name: Scalars['String']['output'];
  1662. updatedAt: Scalars['DateTime']['output'];
  1663. };
  1664. export type FacetValueTranslationInput = {
  1665. customFields?: InputMaybe<Scalars['JSON']['input']>;
  1666. id?: InputMaybe<Scalars['ID']['input']>;
  1667. languageCode: LanguageCode;
  1668. name?: InputMaybe<Scalars['String']['input']>;
  1669. };
  1670. export type FloatCustomFieldConfig = CustomField & {
  1671. __typename?: 'FloatCustomFieldConfig';
  1672. description?: Maybe<Array<LocalizedString>>;
  1673. internal?: Maybe<Scalars['Boolean']['output']>;
  1674. label?: Maybe<Array<LocalizedString>>;
  1675. list: Scalars['Boolean']['output'];
  1676. max?: Maybe<Scalars['Float']['output']>;
  1677. min?: Maybe<Scalars['Float']['output']>;
  1678. name: Scalars['String']['output'];
  1679. nullable?: Maybe<Scalars['Boolean']['output']>;
  1680. readonly?: Maybe<Scalars['Boolean']['output']>;
  1681. requiresPermission?: Maybe<Array<Permission>>;
  1682. step?: Maybe<Scalars['Float']['output']>;
  1683. type: Scalars['String']['output'];
  1684. ui?: Maybe<Scalars['JSON']['output']>;
  1685. };
  1686. export type FulfillOrderInput = {
  1687. handler: ConfigurableOperationInput;
  1688. lines: Array<OrderLineInput>;
  1689. };
  1690. export type Fulfillment = Node & {
  1691. __typename?: 'Fulfillment';
  1692. createdAt: Scalars['DateTime']['output'];
  1693. customFields?: Maybe<Scalars['JSON']['output']>;
  1694. id: Scalars['ID']['output'];
  1695. lines: Array<FulfillmentLine>;
  1696. method: Scalars['String']['output'];
  1697. nextStates: Array<Scalars['String']['output']>;
  1698. state: Scalars['String']['output'];
  1699. /** @deprecated Use the `lines` field instead */
  1700. summary: Array<FulfillmentLine>;
  1701. trackingCode?: Maybe<Scalars['String']['output']>;
  1702. updatedAt: Scalars['DateTime']['output'];
  1703. };
  1704. export type FulfillmentLine = {
  1705. __typename?: 'FulfillmentLine';
  1706. fulfillment: Fulfillment;
  1707. fulfillmentId: Scalars['ID']['output'];
  1708. orderLine: OrderLine;
  1709. orderLineId: Scalars['ID']['output'];
  1710. quantity: Scalars['Int']['output'];
  1711. };
  1712. /** Returned when there is an error in transitioning the Fulfillment state */
  1713. export type FulfillmentStateTransitionError = ErrorResult & {
  1714. __typename?: 'FulfillmentStateTransitionError';
  1715. errorCode: ErrorCode;
  1716. fromState: Scalars['String']['output'];
  1717. message: Scalars['String']['output'];
  1718. toState: Scalars['String']['output'];
  1719. transitionError: Scalars['String']['output'];
  1720. };
  1721. export enum GlobalFlag {
  1722. FALSE = 'FALSE',
  1723. INHERIT = 'INHERIT',
  1724. TRUE = 'TRUE'
  1725. }
  1726. export type GlobalSettings = {
  1727. __typename?: 'GlobalSettings';
  1728. availableLanguages: Array<LanguageCode>;
  1729. createdAt: Scalars['DateTime']['output'];
  1730. customFields?: Maybe<Scalars['JSON']['output']>;
  1731. id: Scalars['ID']['output'];
  1732. outOfStockThreshold: Scalars['Int']['output'];
  1733. serverConfig: ServerConfig;
  1734. trackInventory: Scalars['Boolean']['output'];
  1735. updatedAt: Scalars['DateTime']['output'];
  1736. };
  1737. /** Returned when attempting to set the Customer on a guest checkout when the configured GuestCheckoutStrategy does not allow it. */
  1738. export type GuestCheckoutError = ErrorResult & {
  1739. __typename?: 'GuestCheckoutError';
  1740. errorCode: ErrorCode;
  1741. errorDetail: Scalars['String']['output'];
  1742. message: Scalars['String']['output'];
  1743. };
  1744. export type HistoryEntry = Node & {
  1745. __typename?: 'HistoryEntry';
  1746. administrator?: Maybe<Administrator>;
  1747. createdAt: Scalars['DateTime']['output'];
  1748. data: Scalars['JSON']['output'];
  1749. id: Scalars['ID']['output'];
  1750. isPublic: Scalars['Boolean']['output'];
  1751. type: HistoryEntryType;
  1752. updatedAt: Scalars['DateTime']['output'];
  1753. };
  1754. export type HistoryEntryFilterParameter = {
  1755. _and?: InputMaybe<Array<HistoryEntryFilterParameter>>;
  1756. _or?: InputMaybe<Array<HistoryEntryFilterParameter>>;
  1757. createdAt?: InputMaybe<DateOperators>;
  1758. id?: InputMaybe<IdOperators>;
  1759. isPublic?: InputMaybe<BooleanOperators>;
  1760. type?: InputMaybe<StringOperators>;
  1761. updatedAt?: InputMaybe<DateOperators>;
  1762. };
  1763. export type HistoryEntryList = PaginatedList & {
  1764. __typename?: 'HistoryEntryList';
  1765. items: Array<HistoryEntry>;
  1766. totalItems: Scalars['Int']['output'];
  1767. };
  1768. export type HistoryEntryListOptions = {
  1769. /** Allows the results to be filtered */
  1770. filter?: InputMaybe<HistoryEntryFilterParameter>;
  1771. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1772. filterOperator?: InputMaybe<LogicalOperator>;
  1773. /** Skips the first n results, for use in pagination */
  1774. skip?: InputMaybe<Scalars['Int']['input']>;
  1775. /** Specifies which properties to sort the results by */
  1776. sort?: InputMaybe<HistoryEntrySortParameter>;
  1777. /** Takes n results, for use in pagination */
  1778. take?: InputMaybe<Scalars['Int']['input']>;
  1779. };
  1780. export type HistoryEntrySortParameter = {
  1781. createdAt?: InputMaybe<SortOrder>;
  1782. id?: InputMaybe<SortOrder>;
  1783. updatedAt?: InputMaybe<SortOrder>;
  1784. };
  1785. export enum HistoryEntryType {
  1786. CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP',
  1787. CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED',
  1788. CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED',
  1789. CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED',
  1790. CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED',
  1791. CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED',
  1792. CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED',
  1793. CUSTOMER_NOTE = 'CUSTOMER_NOTE',
  1794. CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED',
  1795. CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED',
  1796. CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED',
  1797. CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED',
  1798. CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP',
  1799. CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED',
  1800. ORDER_CANCELLATION = 'ORDER_CANCELLATION',
  1801. ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED',
  1802. ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED',
  1803. ORDER_CUSTOMER_UPDATED = 'ORDER_CUSTOMER_UPDATED',
  1804. ORDER_FULFILLMENT = 'ORDER_FULFILLMENT',
  1805. ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION',
  1806. ORDER_MODIFIED = 'ORDER_MODIFIED',
  1807. ORDER_NOTE = 'ORDER_NOTE',
  1808. ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION',
  1809. ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION',
  1810. ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION'
  1811. }
  1812. /** Operators for filtering on a list of ID fields */
  1813. export type IdListOperators = {
  1814. inList: Scalars['ID']['input'];
  1815. };
  1816. /** Operators for filtering on an ID field */
  1817. export type IdOperators = {
  1818. eq?: InputMaybe<Scalars['String']['input']>;
  1819. in?: InputMaybe<Array<Scalars['String']['input']>>;
  1820. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  1821. notEq?: InputMaybe<Scalars['String']['input']>;
  1822. notIn?: InputMaybe<Array<Scalars['String']['input']>>;
  1823. };
  1824. export type ImportInfo = {
  1825. __typename?: 'ImportInfo';
  1826. errors?: Maybe<Array<Scalars['String']['output']>>;
  1827. imported: Scalars['Int']['output'];
  1828. processed: Scalars['Int']['output'];
  1829. };
  1830. /** Returned when attempting to set a ShippingMethod for which the Order is not eligible */
  1831. export type IneligibleShippingMethodError = ErrorResult & {
  1832. __typename?: 'IneligibleShippingMethodError';
  1833. errorCode: ErrorCode;
  1834. message: Scalars['String']['output'];
  1835. };
  1836. /** Returned when attempting to add more items to the Order than are available */
  1837. export type InsufficientStockError = ErrorResult & {
  1838. __typename?: 'InsufficientStockError';
  1839. errorCode: ErrorCode;
  1840. message: Scalars['String']['output'];
  1841. order: Order;
  1842. quantityAvailable: Scalars['Int']['output'];
  1843. };
  1844. /**
  1845. * Returned if attempting to create a Fulfillment when there is insufficient
  1846. * stockOnHand of a ProductVariant to satisfy the requested quantity.
  1847. */
  1848. export type InsufficientStockOnHandError = ErrorResult & {
  1849. __typename?: 'InsufficientStockOnHandError';
  1850. errorCode: ErrorCode;
  1851. message: Scalars['String']['output'];
  1852. productVariantId: Scalars['ID']['output'];
  1853. productVariantName: Scalars['String']['output'];
  1854. stockOnHand: Scalars['Int']['output'];
  1855. };
  1856. export type IntCustomFieldConfig = CustomField & {
  1857. __typename?: 'IntCustomFieldConfig';
  1858. description?: Maybe<Array<LocalizedString>>;
  1859. internal?: Maybe<Scalars['Boolean']['output']>;
  1860. label?: Maybe<Array<LocalizedString>>;
  1861. list: Scalars['Boolean']['output'];
  1862. max?: Maybe<Scalars['Int']['output']>;
  1863. min?: Maybe<Scalars['Int']['output']>;
  1864. name: Scalars['String']['output'];
  1865. nullable?: Maybe<Scalars['Boolean']['output']>;
  1866. readonly?: Maybe<Scalars['Boolean']['output']>;
  1867. requiresPermission?: Maybe<Array<Permission>>;
  1868. step?: Maybe<Scalars['Int']['output']>;
  1869. type: Scalars['String']['output'];
  1870. ui?: Maybe<Scalars['JSON']['output']>;
  1871. };
  1872. /** Returned if the user authentication credentials are not valid */
  1873. export type InvalidCredentialsError = ErrorResult & {
  1874. __typename?: 'InvalidCredentialsError';
  1875. authenticationError: Scalars['String']['output'];
  1876. errorCode: ErrorCode;
  1877. message: Scalars['String']['output'];
  1878. };
  1879. /** Returned if the specified FulfillmentHandler code is not valid */
  1880. export type InvalidFulfillmentHandlerError = ErrorResult & {
  1881. __typename?: 'InvalidFulfillmentHandlerError';
  1882. errorCode: ErrorCode;
  1883. message: Scalars['String']['output'];
  1884. };
  1885. /** Returned if the specified items are already part of a Fulfillment */
  1886. export type ItemsAlreadyFulfilledError = ErrorResult & {
  1887. __typename?: 'ItemsAlreadyFulfilledError';
  1888. errorCode: ErrorCode;
  1889. message: Scalars['String']['output'];
  1890. };
  1891. export type Job = Node & {
  1892. __typename?: 'Job';
  1893. attempts: Scalars['Int']['output'];
  1894. createdAt: Scalars['DateTime']['output'];
  1895. data?: Maybe<Scalars['JSON']['output']>;
  1896. duration: Scalars['Int']['output'];
  1897. error?: Maybe<Scalars['JSON']['output']>;
  1898. id: Scalars['ID']['output'];
  1899. isSettled: Scalars['Boolean']['output'];
  1900. progress: Scalars['Float']['output'];
  1901. queueName: Scalars['String']['output'];
  1902. result?: Maybe<Scalars['JSON']['output']>;
  1903. retries: Scalars['Int']['output'];
  1904. settledAt?: Maybe<Scalars['DateTime']['output']>;
  1905. startedAt?: Maybe<Scalars['DateTime']['output']>;
  1906. state: JobState;
  1907. };
  1908. export type JobBufferSize = {
  1909. __typename?: 'JobBufferSize';
  1910. bufferId: Scalars['String']['output'];
  1911. size: Scalars['Int']['output'];
  1912. };
  1913. export type JobFilterParameter = {
  1914. _and?: InputMaybe<Array<JobFilterParameter>>;
  1915. _or?: InputMaybe<Array<JobFilterParameter>>;
  1916. attempts?: InputMaybe<NumberOperators>;
  1917. createdAt?: InputMaybe<DateOperators>;
  1918. duration?: InputMaybe<NumberOperators>;
  1919. id?: InputMaybe<IdOperators>;
  1920. isSettled?: InputMaybe<BooleanOperators>;
  1921. progress?: InputMaybe<NumberOperators>;
  1922. queueName?: InputMaybe<StringOperators>;
  1923. retries?: InputMaybe<NumberOperators>;
  1924. settledAt?: InputMaybe<DateOperators>;
  1925. startedAt?: InputMaybe<DateOperators>;
  1926. state?: InputMaybe<StringOperators>;
  1927. };
  1928. export type JobList = PaginatedList & {
  1929. __typename?: 'JobList';
  1930. items: Array<Job>;
  1931. totalItems: Scalars['Int']['output'];
  1932. };
  1933. export type JobListOptions = {
  1934. /** Allows the results to be filtered */
  1935. filter?: InputMaybe<JobFilterParameter>;
  1936. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  1937. filterOperator?: InputMaybe<LogicalOperator>;
  1938. /** Skips the first n results, for use in pagination */
  1939. skip?: InputMaybe<Scalars['Int']['input']>;
  1940. /** Specifies which properties to sort the results by */
  1941. sort?: InputMaybe<JobSortParameter>;
  1942. /** Takes n results, for use in pagination */
  1943. take?: InputMaybe<Scalars['Int']['input']>;
  1944. };
  1945. export type JobQueue = {
  1946. __typename?: 'JobQueue';
  1947. name: Scalars['String']['output'];
  1948. running: Scalars['Boolean']['output'];
  1949. };
  1950. export type JobSortParameter = {
  1951. attempts?: InputMaybe<SortOrder>;
  1952. createdAt?: InputMaybe<SortOrder>;
  1953. duration?: InputMaybe<SortOrder>;
  1954. id?: InputMaybe<SortOrder>;
  1955. progress?: InputMaybe<SortOrder>;
  1956. queueName?: InputMaybe<SortOrder>;
  1957. retries?: InputMaybe<SortOrder>;
  1958. settledAt?: InputMaybe<SortOrder>;
  1959. startedAt?: InputMaybe<SortOrder>;
  1960. };
  1961. /**
  1962. * @description
  1963. * The state of a Job in the JobQueue
  1964. *
  1965. * @docsCategory common
  1966. */
  1967. export enum JobState {
  1968. CANCELLED = 'CANCELLED',
  1969. COMPLETED = 'COMPLETED',
  1970. FAILED = 'FAILED',
  1971. PENDING = 'PENDING',
  1972. RETRYING = 'RETRYING',
  1973. RUNNING = 'RUNNING'
  1974. }
  1975. /**
  1976. * @description
  1977. * Languages in the form of a ISO 639-1 language code with optional
  1978. * region or script modifier (e.g. de_AT). The selection available is based
  1979. * on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
  1980. * and includes the major spoken languages of the world and any widely-used variants.
  1981. *
  1982. * @docsCategory common
  1983. */
  1984. export enum LanguageCode {
  1985. /** Afrikaans */
  1986. af = 'af',
  1987. /** Akan */
  1988. ak = 'ak',
  1989. /** Amharic */
  1990. am = 'am',
  1991. /** Arabic */
  1992. ar = 'ar',
  1993. /** Assamese */
  1994. as = 'as',
  1995. /** Azerbaijani */
  1996. az = 'az',
  1997. /** Belarusian */
  1998. be = 'be',
  1999. /** Bulgarian */
  2000. bg = 'bg',
  2001. /** Bambara */
  2002. bm = 'bm',
  2003. /** Bangla */
  2004. bn = 'bn',
  2005. /** Tibetan */
  2006. bo = 'bo',
  2007. /** Breton */
  2008. br = 'br',
  2009. /** Bosnian */
  2010. bs = 'bs',
  2011. /** Catalan */
  2012. ca = 'ca',
  2013. /** Chechen */
  2014. ce = 'ce',
  2015. /** Corsican */
  2016. co = 'co',
  2017. /** Czech */
  2018. cs = 'cs',
  2019. /** Church Slavic */
  2020. cu = 'cu',
  2021. /** Welsh */
  2022. cy = 'cy',
  2023. /** Danish */
  2024. da = 'da',
  2025. /** German */
  2026. de = 'de',
  2027. /** Austrian German */
  2028. de_AT = 'de_AT',
  2029. /** Swiss High German */
  2030. de_CH = 'de_CH',
  2031. /** Dzongkha */
  2032. dz = 'dz',
  2033. /** Ewe */
  2034. ee = 'ee',
  2035. /** Greek */
  2036. el = 'el',
  2037. /** English */
  2038. en = 'en',
  2039. /** Australian English */
  2040. en_AU = 'en_AU',
  2041. /** Canadian English */
  2042. en_CA = 'en_CA',
  2043. /** British English */
  2044. en_GB = 'en_GB',
  2045. /** American English */
  2046. en_US = 'en_US',
  2047. /** Esperanto */
  2048. eo = 'eo',
  2049. /** Spanish */
  2050. es = 'es',
  2051. /** European Spanish */
  2052. es_ES = 'es_ES',
  2053. /** Mexican Spanish */
  2054. es_MX = 'es_MX',
  2055. /** Estonian */
  2056. et = 'et',
  2057. /** Basque */
  2058. eu = 'eu',
  2059. /** Persian */
  2060. fa = 'fa',
  2061. /** Dari */
  2062. fa_AF = 'fa_AF',
  2063. /** Fulah */
  2064. ff = 'ff',
  2065. /** Finnish */
  2066. fi = 'fi',
  2067. /** Faroese */
  2068. fo = 'fo',
  2069. /** French */
  2070. fr = 'fr',
  2071. /** Canadian French */
  2072. fr_CA = 'fr_CA',
  2073. /** Swiss French */
  2074. fr_CH = 'fr_CH',
  2075. /** Western Frisian */
  2076. fy = 'fy',
  2077. /** Irish */
  2078. ga = 'ga',
  2079. /** Scottish Gaelic */
  2080. gd = 'gd',
  2081. /** Galician */
  2082. gl = 'gl',
  2083. /** Gujarati */
  2084. gu = 'gu',
  2085. /** Manx */
  2086. gv = 'gv',
  2087. /** Hausa */
  2088. ha = 'ha',
  2089. /** Hebrew */
  2090. he = 'he',
  2091. /** Hindi */
  2092. hi = 'hi',
  2093. /** Croatian */
  2094. hr = 'hr',
  2095. /** Haitian Creole */
  2096. ht = 'ht',
  2097. /** Hungarian */
  2098. hu = 'hu',
  2099. /** Armenian */
  2100. hy = 'hy',
  2101. /** Interlingua */
  2102. ia = 'ia',
  2103. /** Indonesian */
  2104. id = 'id',
  2105. /** Igbo */
  2106. ig = 'ig',
  2107. /** Sichuan Yi */
  2108. ii = 'ii',
  2109. /** Icelandic */
  2110. is = 'is',
  2111. /** Italian */
  2112. it = 'it',
  2113. /** Japanese */
  2114. ja = 'ja',
  2115. /** Javanese */
  2116. jv = 'jv',
  2117. /** Georgian */
  2118. ka = 'ka',
  2119. /** Kikuyu */
  2120. ki = 'ki',
  2121. /** Kazakh */
  2122. kk = 'kk',
  2123. /** Kalaallisut */
  2124. kl = 'kl',
  2125. /** Khmer */
  2126. km = 'km',
  2127. /** Kannada */
  2128. kn = 'kn',
  2129. /** Korean */
  2130. ko = 'ko',
  2131. /** Kashmiri */
  2132. ks = 'ks',
  2133. /** Kurdish */
  2134. ku = 'ku',
  2135. /** Cornish */
  2136. kw = 'kw',
  2137. /** Kyrgyz */
  2138. ky = 'ky',
  2139. /** Latin */
  2140. la = 'la',
  2141. /** Luxembourgish */
  2142. lb = 'lb',
  2143. /** Ganda */
  2144. lg = 'lg',
  2145. /** Lingala */
  2146. ln = 'ln',
  2147. /** Lao */
  2148. lo = 'lo',
  2149. /** Lithuanian */
  2150. lt = 'lt',
  2151. /** Luba-Katanga */
  2152. lu = 'lu',
  2153. /** Latvian */
  2154. lv = 'lv',
  2155. /** Malagasy */
  2156. mg = 'mg',
  2157. /** Maori */
  2158. mi = 'mi',
  2159. /** Macedonian */
  2160. mk = 'mk',
  2161. /** Malayalam */
  2162. ml = 'ml',
  2163. /** Mongolian */
  2164. mn = 'mn',
  2165. /** Marathi */
  2166. mr = 'mr',
  2167. /** Malay */
  2168. ms = 'ms',
  2169. /** Maltese */
  2170. mt = 'mt',
  2171. /** Burmese */
  2172. my = 'my',
  2173. /** Norwegian Bokmål */
  2174. nb = 'nb',
  2175. /** North Ndebele */
  2176. nd = 'nd',
  2177. /** Nepali */
  2178. ne = 'ne',
  2179. /** Dutch */
  2180. nl = 'nl',
  2181. /** Flemish */
  2182. nl_BE = 'nl_BE',
  2183. /** Norwegian Nynorsk */
  2184. nn = 'nn',
  2185. /** Nyanja */
  2186. ny = 'ny',
  2187. /** Oromo */
  2188. om = 'om',
  2189. /** Odia */
  2190. or = 'or',
  2191. /** Ossetic */
  2192. os = 'os',
  2193. /** Punjabi */
  2194. pa = 'pa',
  2195. /** Polish */
  2196. pl = 'pl',
  2197. /** Pashto */
  2198. ps = 'ps',
  2199. /** Portuguese */
  2200. pt = 'pt',
  2201. /** Brazilian Portuguese */
  2202. pt_BR = 'pt_BR',
  2203. /** European Portuguese */
  2204. pt_PT = 'pt_PT',
  2205. /** Quechua */
  2206. qu = 'qu',
  2207. /** Romansh */
  2208. rm = 'rm',
  2209. /** Rundi */
  2210. rn = 'rn',
  2211. /** Romanian */
  2212. ro = 'ro',
  2213. /** Moldavian */
  2214. ro_MD = 'ro_MD',
  2215. /** Russian */
  2216. ru = 'ru',
  2217. /** Kinyarwanda */
  2218. rw = 'rw',
  2219. /** Sanskrit */
  2220. sa = 'sa',
  2221. /** Sindhi */
  2222. sd = 'sd',
  2223. /** Northern Sami */
  2224. se = 'se',
  2225. /** Sango */
  2226. sg = 'sg',
  2227. /** Sinhala */
  2228. si = 'si',
  2229. /** Slovak */
  2230. sk = 'sk',
  2231. /** Slovenian */
  2232. sl = 'sl',
  2233. /** Samoan */
  2234. sm = 'sm',
  2235. /** Shona */
  2236. sn = 'sn',
  2237. /** Somali */
  2238. so = 'so',
  2239. /** Albanian */
  2240. sq = 'sq',
  2241. /** Serbian */
  2242. sr = 'sr',
  2243. /** Southern Sotho */
  2244. st = 'st',
  2245. /** Sundanese */
  2246. su = 'su',
  2247. /** Swedish */
  2248. sv = 'sv',
  2249. /** Swahili */
  2250. sw = 'sw',
  2251. /** Congo Swahili */
  2252. sw_CD = 'sw_CD',
  2253. /** Tamil */
  2254. ta = 'ta',
  2255. /** Telugu */
  2256. te = 'te',
  2257. /** Tajik */
  2258. tg = 'tg',
  2259. /** Thai */
  2260. th = 'th',
  2261. /** Tigrinya */
  2262. ti = 'ti',
  2263. /** Turkmen */
  2264. tk = 'tk',
  2265. /** Tongan */
  2266. to = 'to',
  2267. /** Turkish */
  2268. tr = 'tr',
  2269. /** Tatar */
  2270. tt = 'tt',
  2271. /** Uyghur */
  2272. ug = 'ug',
  2273. /** Ukrainian */
  2274. uk = 'uk',
  2275. /** Urdu */
  2276. ur = 'ur',
  2277. /** Uzbek */
  2278. uz = 'uz',
  2279. /** Vietnamese */
  2280. vi = 'vi',
  2281. /** Volapük */
  2282. vo = 'vo',
  2283. /** Wolof */
  2284. wo = 'wo',
  2285. /** Xhosa */
  2286. xh = 'xh',
  2287. /** Yiddish */
  2288. yi = 'yi',
  2289. /** Yoruba */
  2290. yo = 'yo',
  2291. /** Chinese */
  2292. zh = 'zh',
  2293. /** Simplified Chinese */
  2294. zh_Hans = 'zh_Hans',
  2295. /** Traditional Chinese */
  2296. zh_Hant = 'zh_Hant',
  2297. /** Zulu */
  2298. zu = 'zu'
  2299. }
  2300. /** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */
  2301. export type LanguageNotAvailableError = ErrorResult & {
  2302. __typename?: 'LanguageNotAvailableError';
  2303. errorCode: ErrorCode;
  2304. languageCode: Scalars['String']['output'];
  2305. message: Scalars['String']['output'];
  2306. };
  2307. export type LocaleStringCustomFieldConfig = CustomField & {
  2308. __typename?: 'LocaleStringCustomFieldConfig';
  2309. description?: Maybe<Array<LocalizedString>>;
  2310. internal?: Maybe<Scalars['Boolean']['output']>;
  2311. label?: Maybe<Array<LocalizedString>>;
  2312. length?: Maybe<Scalars['Int']['output']>;
  2313. list: Scalars['Boolean']['output'];
  2314. name: Scalars['String']['output'];
  2315. nullable?: Maybe<Scalars['Boolean']['output']>;
  2316. pattern?: Maybe<Scalars['String']['output']>;
  2317. readonly?: Maybe<Scalars['Boolean']['output']>;
  2318. requiresPermission?: Maybe<Array<Permission>>;
  2319. type: Scalars['String']['output'];
  2320. ui?: Maybe<Scalars['JSON']['output']>;
  2321. };
  2322. export type LocaleTextCustomFieldConfig = CustomField & {
  2323. __typename?: 'LocaleTextCustomFieldConfig';
  2324. description?: Maybe<Array<LocalizedString>>;
  2325. internal?: Maybe<Scalars['Boolean']['output']>;
  2326. label?: Maybe<Array<LocalizedString>>;
  2327. list: Scalars['Boolean']['output'];
  2328. name: Scalars['String']['output'];
  2329. nullable?: Maybe<Scalars['Boolean']['output']>;
  2330. readonly?: Maybe<Scalars['Boolean']['output']>;
  2331. requiresPermission?: Maybe<Array<Permission>>;
  2332. type: Scalars['String']['output'];
  2333. ui?: Maybe<Scalars['JSON']['output']>;
  2334. };
  2335. export type LocalizedString = {
  2336. __typename?: 'LocalizedString';
  2337. languageCode: LanguageCode;
  2338. value: Scalars['String']['output'];
  2339. };
  2340. export enum LogicalOperator {
  2341. AND = 'AND',
  2342. OR = 'OR'
  2343. }
  2344. export type ManualPaymentInput = {
  2345. metadata?: InputMaybe<Scalars['JSON']['input']>;
  2346. method: Scalars['String']['input'];
  2347. orderId: Scalars['ID']['input'];
  2348. transactionId?: InputMaybe<Scalars['String']['input']>;
  2349. };
  2350. /**
  2351. * Returned when a call to addManualPaymentToOrder is made but the Order
  2352. * is not in the required state.
  2353. */
  2354. export type ManualPaymentStateError = ErrorResult & {
  2355. __typename?: 'ManualPaymentStateError';
  2356. errorCode: ErrorCode;
  2357. message: Scalars['String']['output'];
  2358. };
  2359. export enum MetricInterval {
  2360. Daily = 'Daily'
  2361. }
  2362. export type MetricSummary = {
  2363. __typename?: 'MetricSummary';
  2364. entries: Array<MetricSummaryEntry>;
  2365. interval: MetricInterval;
  2366. title: Scalars['String']['output'];
  2367. type: MetricType;
  2368. };
  2369. export type MetricSummaryEntry = {
  2370. __typename?: 'MetricSummaryEntry';
  2371. label: Scalars['String']['output'];
  2372. value: Scalars['Float']['output'];
  2373. };
  2374. export type MetricSummaryInput = {
  2375. interval: MetricInterval;
  2376. refresh?: InputMaybe<Scalars['Boolean']['input']>;
  2377. types: Array<MetricType>;
  2378. };
  2379. export enum MetricType {
  2380. AverageOrderValue = 'AverageOrderValue',
  2381. OrderCount = 'OrderCount',
  2382. OrderTotal = 'OrderTotal'
  2383. }
  2384. export type MimeTypeError = ErrorResult & {
  2385. __typename?: 'MimeTypeError';
  2386. errorCode: ErrorCode;
  2387. fileName: Scalars['String']['output'];
  2388. message: Scalars['String']['output'];
  2389. mimeType: Scalars['String']['output'];
  2390. };
  2391. /** Returned if a PromotionCondition has neither a couponCode nor any conditions set */
  2392. export type MissingConditionsError = ErrorResult & {
  2393. __typename?: 'MissingConditionsError';
  2394. errorCode: ErrorCode;
  2395. message: Scalars['String']['output'];
  2396. };
  2397. export type ModifyOrderInput = {
  2398. addItems?: InputMaybe<Array<AddItemInput>>;
  2399. adjustOrderLines?: InputMaybe<Array<OrderLineInput>>;
  2400. couponCodes?: InputMaybe<Array<Scalars['String']['input']>>;
  2401. dryRun: Scalars['Boolean']['input'];
  2402. note?: InputMaybe<Scalars['String']['input']>;
  2403. options?: InputMaybe<ModifyOrderOptions>;
  2404. orderId: Scalars['ID']['input'];
  2405. /**
  2406. * Deprecated in v2.2.0. Use `refunds` instead to allow multiple refunds to be
  2407. * applied in the case that multiple payment methods have been used on the order.
  2408. */
  2409. refund?: InputMaybe<AdministratorRefundInput>;
  2410. refunds?: InputMaybe<Array<AdministratorRefundInput>>;
  2411. /** Added in v2.2 */
  2412. shippingMethodIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  2413. surcharges?: InputMaybe<Array<SurchargeInput>>;
  2414. updateBillingAddress?: InputMaybe<UpdateOrderAddressInput>;
  2415. updateShippingAddress?: InputMaybe<UpdateOrderAddressInput>;
  2416. };
  2417. export type ModifyOrderOptions = {
  2418. freezePromotions?: InputMaybe<Scalars['Boolean']['input']>;
  2419. recalculateShipping?: InputMaybe<Scalars['Boolean']['input']>;
  2420. };
  2421. export type ModifyOrderResult = CouponCodeExpiredError | CouponCodeInvalidError | CouponCodeLimitError | IneligibleShippingMethodError | InsufficientStockError | NegativeQuantityError | NoChangesSpecifiedError | Order | OrderLimitError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError;
  2422. export type MoveCollectionInput = {
  2423. collectionId: Scalars['ID']['input'];
  2424. index: Scalars['Int']['input'];
  2425. parentId: Scalars['ID']['input'];
  2426. };
  2427. /** Returned if an operation has specified OrderLines from multiple Orders */
  2428. export type MultipleOrderError = ErrorResult & {
  2429. __typename?: 'MultipleOrderError';
  2430. errorCode: ErrorCode;
  2431. message: Scalars['String']['output'];
  2432. };
  2433. export type Mutation = {
  2434. __typename?: 'Mutation';
  2435. /** Add Customers to a CustomerGroup */
  2436. addCustomersToGroup: CustomerGroup;
  2437. addFulfillmentToOrder: AddFulfillmentToOrderResult;
  2438. /** Adds an item to the draft Order. */
  2439. addItemToDraftOrder: UpdateOrderItemsResult;
  2440. /**
  2441. * Used to manually create a new Payment against an Order.
  2442. * This can be used by an Administrator when an Order is in the ArrangingPayment state.
  2443. *
  2444. * It is also used when a completed Order
  2445. * has been modified (using `modifyOrder`) and the price has increased. The extra payment
  2446. * can then be manually arranged by the administrator, and the details used to create a new
  2447. * Payment.
  2448. */
  2449. addManualPaymentToOrder: AddManualPaymentToOrderResult;
  2450. /** Add members to a Zone */
  2451. addMembersToZone: Zone;
  2452. addNoteToCustomer: Customer;
  2453. addNoteToOrder: Order;
  2454. /** Add an OptionGroup to a Product */
  2455. addOptionGroupToProduct: Product;
  2456. /** Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type `OrderLineCustomFieldsInput` will be available. */
  2457. adjustDraftOrderLine: UpdateOrderItemsResult;
  2458. /** Applies the given coupon code to the draft Order */
  2459. applyCouponCodeToDraftOrder: ApplyCouponCodeResult;
  2460. /** Assign assets to channel */
  2461. assignAssetsToChannel: Array<Asset>;
  2462. /** Assigns Collections to the specified Channel */
  2463. assignCollectionsToChannel: Array<Collection>;
  2464. /** Assigns Facets to the specified Channel */
  2465. assignFacetsToChannel: Array<Facet>;
  2466. /** Assigns PaymentMethods to the specified Channel */
  2467. assignPaymentMethodsToChannel: Array<PaymentMethod>;
  2468. /** Assigns ProductVariants to the specified Channel */
  2469. assignProductVariantsToChannel: Array<ProductVariant>;
  2470. /** Assigns all ProductVariants of Product to the specified Channel */
  2471. assignProductsToChannel: Array<Product>;
  2472. /** Assigns Promotions to the specified Channel */
  2473. assignPromotionsToChannel: Array<Promotion>;
  2474. /** Assign a Role to an Administrator */
  2475. assignRoleToAdministrator: Administrator;
  2476. /** Assigns ShippingMethods to the specified Channel */
  2477. assignShippingMethodsToChannel: Array<ShippingMethod>;
  2478. /** Assigns StockLocations to the specified Channel */
  2479. assignStockLocationsToChannel: Array<StockLocation>;
  2480. /** Authenticates the user using a named authentication strategy */
  2481. authenticate: AuthenticationResult;
  2482. cancelJob: Job;
  2483. cancelOrder: CancelOrderResult;
  2484. cancelPayment: CancelPaymentResult;
  2485. /** Create a new Administrator */
  2486. createAdministrator: Administrator;
  2487. /** Create a new Asset */
  2488. createAssets: Array<CreateAssetResult>;
  2489. /** Create a new Channel */
  2490. createChannel: CreateChannelResult;
  2491. /** Create a new Collection */
  2492. createCollection: Collection;
  2493. /** Create a new Country */
  2494. createCountry: Country;
  2495. /** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */
  2496. createCustomer: CreateCustomerResult;
  2497. /** Create a new Address and associate it with the Customer specified by customerId */
  2498. createCustomerAddress: Address;
  2499. /** Create a new CustomerGroup */
  2500. createCustomerGroup: CustomerGroup;
  2501. /** Creates a draft Order */
  2502. createDraftOrder: Order;
  2503. /** Create a new Facet */
  2504. createFacet: Facet;
  2505. /** Create one or more FacetValues */
  2506. createFacetValues: Array<FacetValue>;
  2507. /** Create existing PaymentMethod */
  2508. createPaymentMethod: PaymentMethod;
  2509. /** Create a new Product */
  2510. createProduct: Product;
  2511. /** Create a new ProductOption within a ProductOptionGroup */
  2512. createProductOption: ProductOption;
  2513. /** Create a new ProductOptionGroup */
  2514. createProductOptionGroup: ProductOptionGroup;
  2515. /** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */
  2516. createProductVariants: Array<Maybe<ProductVariant>>;
  2517. createPromotion: CreatePromotionResult;
  2518. /** Create a new Province */
  2519. createProvince: Province;
  2520. /** Create a new Role */
  2521. createRole: Role;
  2522. /** Create a new Seller */
  2523. createSeller: Seller;
  2524. /** Create a new ShippingMethod */
  2525. createShippingMethod: ShippingMethod;
  2526. createStockLocation: StockLocation;
  2527. /** Create a new Tag */
  2528. createTag: Tag;
  2529. /** Create a new TaxCategory */
  2530. createTaxCategory: TaxCategory;
  2531. /** Create a new TaxRate */
  2532. createTaxRate: TaxRate;
  2533. /** Create a new Zone */
  2534. createZone: Zone;
  2535. /** Delete an Administrator */
  2536. deleteAdministrator: DeletionResponse;
  2537. /** Delete multiple Administrators */
  2538. deleteAdministrators: Array<DeletionResponse>;
  2539. /** Delete an Asset */
  2540. deleteAsset: DeletionResponse;
  2541. /** Delete multiple Assets */
  2542. deleteAssets: DeletionResponse;
  2543. /** Delete a Channel */
  2544. deleteChannel: DeletionResponse;
  2545. /** Delete multiple Channels */
  2546. deleteChannels: Array<DeletionResponse>;
  2547. /** Delete a Collection and all of its descendants */
  2548. deleteCollection: DeletionResponse;
  2549. /** Delete multiple Collections and all of their descendants */
  2550. deleteCollections: Array<DeletionResponse>;
  2551. /** Delete multiple Countries */
  2552. deleteCountries: Array<DeletionResponse>;
  2553. /** Delete a Country */
  2554. deleteCountry: DeletionResponse;
  2555. /** Delete a Customer */
  2556. deleteCustomer: DeletionResponse;
  2557. /** Update an existing Address */
  2558. deleteCustomerAddress: Success;
  2559. /** Delete a CustomerGroup */
  2560. deleteCustomerGroup: DeletionResponse;
  2561. /** Delete multiple CustomerGroups */
  2562. deleteCustomerGroups: Array<DeletionResponse>;
  2563. deleteCustomerNote: DeletionResponse;
  2564. /** Deletes Customers */
  2565. deleteCustomers: Array<DeletionResponse>;
  2566. /** Deletes a draft Order */
  2567. deleteDraftOrder: DeletionResponse;
  2568. /** Delete an existing Facet */
  2569. deleteFacet: DeletionResponse;
  2570. /** Delete one or more FacetValues */
  2571. deleteFacetValues: Array<DeletionResponse>;
  2572. /** Delete multiple existing Facets */
  2573. deleteFacets: Array<DeletionResponse>;
  2574. deleteOrderNote: DeletionResponse;
  2575. /** Delete a PaymentMethod */
  2576. deletePaymentMethod: DeletionResponse;
  2577. /** Delete multiple PaymentMethods */
  2578. deletePaymentMethods: Array<DeletionResponse>;
  2579. /** Delete a Product */
  2580. deleteProduct: DeletionResponse;
  2581. /** Delete a ProductOption */
  2582. deleteProductOption: DeletionResponse;
  2583. /** Delete a ProductVariant */
  2584. deleteProductVariant: DeletionResponse;
  2585. /** Delete multiple ProductVariants */
  2586. deleteProductVariants: Array<DeletionResponse>;
  2587. /** Delete multiple Products */
  2588. deleteProducts: Array<DeletionResponse>;
  2589. deletePromotion: DeletionResponse;
  2590. deletePromotions: Array<DeletionResponse>;
  2591. /** Delete a Province */
  2592. deleteProvince: DeletionResponse;
  2593. /** Delete an existing Role */
  2594. deleteRole: DeletionResponse;
  2595. /** Delete multiple Roles */
  2596. deleteRoles: Array<DeletionResponse>;
  2597. /** Delete a Seller */
  2598. deleteSeller: DeletionResponse;
  2599. /** Delete multiple Sellers */
  2600. deleteSellers: Array<DeletionResponse>;
  2601. /** Delete a ShippingMethod */
  2602. deleteShippingMethod: DeletionResponse;
  2603. /** Delete multiple ShippingMethods */
  2604. deleteShippingMethods: Array<DeletionResponse>;
  2605. deleteStockLocation: DeletionResponse;
  2606. deleteStockLocations: Array<DeletionResponse>;
  2607. /** Delete an existing Tag */
  2608. deleteTag: DeletionResponse;
  2609. /** Deletes multiple TaxCategories */
  2610. deleteTaxCategories: Array<DeletionResponse>;
  2611. /** Deletes a TaxCategory */
  2612. deleteTaxCategory: DeletionResponse;
  2613. /** Delete a TaxRate */
  2614. deleteTaxRate: DeletionResponse;
  2615. /** Delete multiple TaxRates */
  2616. deleteTaxRates: Array<DeletionResponse>;
  2617. /** Delete a Zone */
  2618. deleteZone: DeletionResponse;
  2619. /** Delete a Zone */
  2620. deleteZones: Array<DeletionResponse>;
  2621. duplicateEntity: DuplicateEntityResult;
  2622. flushBufferedJobs: Success;
  2623. importProducts?: Maybe<ImportInfo>;
  2624. /** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */
  2625. login: NativeAuthenticationResult;
  2626. logout: Success;
  2627. /**
  2628. * Allows an Order to be modified after it has been completed by the Customer. The Order must first
  2629. * be in the `Modifying` state.
  2630. */
  2631. modifyOrder: ModifyOrderResult;
  2632. /** Move a Collection to a different parent or index */
  2633. moveCollection: Collection;
  2634. refundOrder: RefundOrderResult;
  2635. reindex: Job;
  2636. /** Removes Collections from the specified Channel */
  2637. removeCollectionsFromChannel: Array<Collection>;
  2638. /** Removes the given coupon code from the draft Order */
  2639. removeCouponCodeFromDraftOrder?: Maybe<Order>;
  2640. /** Remove Customers from a CustomerGroup */
  2641. removeCustomersFromGroup: CustomerGroup;
  2642. /** Remove an OrderLine from the draft Order */
  2643. removeDraftOrderLine: RemoveOrderItemsResult;
  2644. /** Removes Facets from the specified Channel */
  2645. removeFacetsFromChannel: Array<RemoveFacetFromChannelResult>;
  2646. /** Remove members from a Zone */
  2647. removeMembersFromZone: Zone;
  2648. /**
  2649. * Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants
  2650. * the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed.
  2651. * Setting the `force` argument to `true` will override this and remove the OptionGroup anyway,
  2652. * as well as removing any of the group's options from the Product's ProductVariants.
  2653. */
  2654. removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult;
  2655. /** Removes PaymentMethods from the specified Channel */
  2656. removePaymentMethodsFromChannel: Array<PaymentMethod>;
  2657. /** Removes ProductVariants from the specified Channel */
  2658. removeProductVariantsFromChannel: Array<ProductVariant>;
  2659. /** Removes all ProductVariants of Product from the specified Channel */
  2660. removeProductsFromChannel: Array<Product>;
  2661. /** Removes Promotions from the specified Channel */
  2662. removePromotionsFromChannel: Array<Promotion>;
  2663. /** Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted. */
  2664. removeSettledJobs: Scalars['Int']['output'];
  2665. /** Removes ShippingMethods from the specified Channel */
  2666. removeShippingMethodsFromChannel: Array<ShippingMethod>;
  2667. /** Removes StockLocations from the specified Channel */
  2668. removeStockLocationsFromChannel: Array<StockLocation>;
  2669. runPendingSearchIndexUpdates: Success;
  2670. setCustomerForDraftOrder: SetCustomerForDraftOrderResult;
  2671. /** Sets the billing address for a draft Order */
  2672. setDraftOrderBillingAddress: Order;
  2673. /** Allows any custom fields to be set for the active order */
  2674. setDraftOrderCustomFields: Order;
  2675. /** Sets the shipping address for a draft Order */
  2676. setDraftOrderShippingAddress: Order;
  2677. /** Sets the shipping method by id, which can be obtained with the `eligibleShippingMethodsForDraftOrder` query */
  2678. setDraftOrderShippingMethod: SetOrderShippingMethodResult;
  2679. setOrderCustomFields?: Maybe<Order>;
  2680. /** Allows a different Customer to be assigned to an Order. Added in v2.2.0. */
  2681. setOrderCustomer?: Maybe<Order>;
  2682. settlePayment: SettlePaymentResult;
  2683. settleRefund: SettleRefundResult;
  2684. transitionFulfillmentToState: TransitionFulfillmentToStateResult;
  2685. transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
  2686. transitionPaymentToState: TransitionPaymentToStateResult;
  2687. /** Update the active (currently logged-in) Administrator */
  2688. updateActiveAdministrator: Administrator;
  2689. /** Update an existing Administrator */
  2690. updateAdministrator: Administrator;
  2691. /** Update an existing Asset */
  2692. updateAsset: Asset;
  2693. /** Update an existing Channel */
  2694. updateChannel: UpdateChannelResult;
  2695. /** Update an existing Collection */
  2696. updateCollection: Collection;
  2697. /** Update an existing Country */
  2698. updateCountry: Country;
  2699. /** Update an existing Customer */
  2700. updateCustomer: UpdateCustomerResult;
  2701. /** Update an existing Address */
  2702. updateCustomerAddress: Address;
  2703. /** Update an existing CustomerGroup */
  2704. updateCustomerGroup: CustomerGroup;
  2705. updateCustomerNote: HistoryEntry;
  2706. /** Update an existing Facet */
  2707. updateFacet: Facet;
  2708. /** Update one or more FacetValues */
  2709. updateFacetValues: Array<FacetValue>;
  2710. updateGlobalSettings: UpdateGlobalSettingsResult;
  2711. updateOrderNote: HistoryEntry;
  2712. /** Update an existing PaymentMethod */
  2713. updatePaymentMethod: PaymentMethod;
  2714. /** Update an existing Product */
  2715. updateProduct: Product;
  2716. /** Create a new ProductOption within a ProductOptionGroup */
  2717. updateProductOption: ProductOption;
  2718. /** Update an existing ProductOptionGroup */
  2719. updateProductOptionGroup: ProductOptionGroup;
  2720. /** Update existing ProductVariants */
  2721. updateProductVariants: Array<Maybe<ProductVariant>>;
  2722. /** Update multiple existing Products */
  2723. updateProducts: Array<Product>;
  2724. updatePromotion: UpdatePromotionResult;
  2725. /** Update an existing Province */
  2726. updateProvince: Province;
  2727. /** Update an existing Role */
  2728. updateRole: Role;
  2729. /** Update an existing Seller */
  2730. updateSeller: Seller;
  2731. /** Update an existing ShippingMethod */
  2732. updateShippingMethod: ShippingMethod;
  2733. updateStockLocation: StockLocation;
  2734. /** Update an existing Tag */
  2735. updateTag: Tag;
  2736. /** Update an existing TaxCategory */
  2737. updateTaxCategory: TaxCategory;
  2738. /** Update an existing TaxRate */
  2739. updateTaxRate: TaxRate;
  2740. /** Update an existing Zone */
  2741. updateZone: Zone;
  2742. };
  2743. export type MutationAddCustomersToGroupArgs = {
  2744. customerGroupId: Scalars['ID']['input'];
  2745. customerIds: Array<Scalars['ID']['input']>;
  2746. };
  2747. export type MutationAddFulfillmentToOrderArgs = {
  2748. input: FulfillOrderInput;
  2749. };
  2750. export type MutationAddItemToDraftOrderArgs = {
  2751. input: AddItemToDraftOrderInput;
  2752. orderId: Scalars['ID']['input'];
  2753. };
  2754. export type MutationAddManualPaymentToOrderArgs = {
  2755. input: ManualPaymentInput;
  2756. };
  2757. export type MutationAddMembersToZoneArgs = {
  2758. memberIds: Array<Scalars['ID']['input']>;
  2759. zoneId: Scalars['ID']['input'];
  2760. };
  2761. export type MutationAddNoteToCustomerArgs = {
  2762. input: AddNoteToCustomerInput;
  2763. };
  2764. export type MutationAddNoteToOrderArgs = {
  2765. input: AddNoteToOrderInput;
  2766. };
  2767. export type MutationAddOptionGroupToProductArgs = {
  2768. optionGroupId: Scalars['ID']['input'];
  2769. productId: Scalars['ID']['input'];
  2770. };
  2771. export type MutationAdjustDraftOrderLineArgs = {
  2772. input: AdjustDraftOrderLineInput;
  2773. orderId: Scalars['ID']['input'];
  2774. };
  2775. export type MutationApplyCouponCodeToDraftOrderArgs = {
  2776. couponCode: Scalars['String']['input'];
  2777. orderId: Scalars['ID']['input'];
  2778. };
  2779. export type MutationAssignAssetsToChannelArgs = {
  2780. input: AssignAssetsToChannelInput;
  2781. };
  2782. export type MutationAssignCollectionsToChannelArgs = {
  2783. input: AssignCollectionsToChannelInput;
  2784. };
  2785. export type MutationAssignFacetsToChannelArgs = {
  2786. input: AssignFacetsToChannelInput;
  2787. };
  2788. export type MutationAssignPaymentMethodsToChannelArgs = {
  2789. input: AssignPaymentMethodsToChannelInput;
  2790. };
  2791. export type MutationAssignProductVariantsToChannelArgs = {
  2792. input: AssignProductVariantsToChannelInput;
  2793. };
  2794. export type MutationAssignProductsToChannelArgs = {
  2795. input: AssignProductsToChannelInput;
  2796. };
  2797. export type MutationAssignPromotionsToChannelArgs = {
  2798. input: AssignPromotionsToChannelInput;
  2799. };
  2800. export type MutationAssignRoleToAdministratorArgs = {
  2801. administratorId: Scalars['ID']['input'];
  2802. roleId: Scalars['ID']['input'];
  2803. };
  2804. export type MutationAssignShippingMethodsToChannelArgs = {
  2805. input: AssignShippingMethodsToChannelInput;
  2806. };
  2807. export type MutationAssignStockLocationsToChannelArgs = {
  2808. input: AssignStockLocationsToChannelInput;
  2809. };
  2810. export type MutationAuthenticateArgs = {
  2811. input: AuthenticationInput;
  2812. rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
  2813. };
  2814. export type MutationCancelJobArgs = {
  2815. jobId: Scalars['ID']['input'];
  2816. };
  2817. export type MutationCancelOrderArgs = {
  2818. input: CancelOrderInput;
  2819. };
  2820. export type MutationCancelPaymentArgs = {
  2821. id: Scalars['ID']['input'];
  2822. };
  2823. export type MutationCreateAdministratorArgs = {
  2824. input: CreateAdministratorInput;
  2825. };
  2826. export type MutationCreateAssetsArgs = {
  2827. input: Array<CreateAssetInput>;
  2828. };
  2829. export type MutationCreateChannelArgs = {
  2830. input: CreateChannelInput;
  2831. };
  2832. export type MutationCreateCollectionArgs = {
  2833. input: CreateCollectionInput;
  2834. };
  2835. export type MutationCreateCountryArgs = {
  2836. input: CreateCountryInput;
  2837. };
  2838. export type MutationCreateCustomerArgs = {
  2839. input: CreateCustomerInput;
  2840. password?: InputMaybe<Scalars['String']['input']>;
  2841. };
  2842. export type MutationCreateCustomerAddressArgs = {
  2843. customerId: Scalars['ID']['input'];
  2844. input: CreateAddressInput;
  2845. };
  2846. export type MutationCreateCustomerGroupArgs = {
  2847. input: CreateCustomerGroupInput;
  2848. };
  2849. export type MutationCreateFacetArgs = {
  2850. input: CreateFacetInput;
  2851. };
  2852. export type MutationCreateFacetValuesArgs = {
  2853. input: Array<CreateFacetValueInput>;
  2854. };
  2855. export type MutationCreatePaymentMethodArgs = {
  2856. input: CreatePaymentMethodInput;
  2857. };
  2858. export type MutationCreateProductArgs = {
  2859. input: CreateProductInput;
  2860. };
  2861. export type MutationCreateProductOptionArgs = {
  2862. input: CreateProductOptionInput;
  2863. };
  2864. export type MutationCreateProductOptionGroupArgs = {
  2865. input: CreateProductOptionGroupInput;
  2866. };
  2867. export type MutationCreateProductVariantsArgs = {
  2868. input: Array<CreateProductVariantInput>;
  2869. };
  2870. export type MutationCreatePromotionArgs = {
  2871. input: CreatePromotionInput;
  2872. };
  2873. export type MutationCreateProvinceArgs = {
  2874. input: CreateProvinceInput;
  2875. };
  2876. export type MutationCreateRoleArgs = {
  2877. input: CreateRoleInput;
  2878. };
  2879. export type MutationCreateSellerArgs = {
  2880. input: CreateSellerInput;
  2881. };
  2882. export type MutationCreateShippingMethodArgs = {
  2883. input: CreateShippingMethodInput;
  2884. };
  2885. export type MutationCreateStockLocationArgs = {
  2886. input: CreateStockLocationInput;
  2887. };
  2888. export type MutationCreateTagArgs = {
  2889. input: CreateTagInput;
  2890. };
  2891. export type MutationCreateTaxCategoryArgs = {
  2892. input: CreateTaxCategoryInput;
  2893. };
  2894. export type MutationCreateTaxRateArgs = {
  2895. input: CreateTaxRateInput;
  2896. };
  2897. export type MutationCreateZoneArgs = {
  2898. input: CreateZoneInput;
  2899. };
  2900. export type MutationDeleteAdministratorArgs = {
  2901. id: Scalars['ID']['input'];
  2902. };
  2903. export type MutationDeleteAdministratorsArgs = {
  2904. ids: Array<Scalars['ID']['input']>;
  2905. };
  2906. export type MutationDeleteAssetArgs = {
  2907. input: DeleteAssetInput;
  2908. };
  2909. export type MutationDeleteAssetsArgs = {
  2910. input: DeleteAssetsInput;
  2911. };
  2912. export type MutationDeleteChannelArgs = {
  2913. id: Scalars['ID']['input'];
  2914. };
  2915. export type MutationDeleteChannelsArgs = {
  2916. ids: Array<Scalars['ID']['input']>;
  2917. };
  2918. export type MutationDeleteCollectionArgs = {
  2919. id: Scalars['ID']['input'];
  2920. };
  2921. export type MutationDeleteCollectionsArgs = {
  2922. ids: Array<Scalars['ID']['input']>;
  2923. };
  2924. export type MutationDeleteCountriesArgs = {
  2925. ids: Array<Scalars['ID']['input']>;
  2926. };
  2927. export type MutationDeleteCountryArgs = {
  2928. id: Scalars['ID']['input'];
  2929. };
  2930. export type MutationDeleteCustomerArgs = {
  2931. id: Scalars['ID']['input'];
  2932. };
  2933. export type MutationDeleteCustomerAddressArgs = {
  2934. id: Scalars['ID']['input'];
  2935. };
  2936. export type MutationDeleteCustomerGroupArgs = {
  2937. id: Scalars['ID']['input'];
  2938. };
  2939. export type MutationDeleteCustomerGroupsArgs = {
  2940. ids: Array<Scalars['ID']['input']>;
  2941. };
  2942. export type MutationDeleteCustomerNoteArgs = {
  2943. id: Scalars['ID']['input'];
  2944. };
  2945. export type MutationDeleteCustomersArgs = {
  2946. ids: Array<Scalars['ID']['input']>;
  2947. };
  2948. export type MutationDeleteDraftOrderArgs = {
  2949. orderId: Scalars['ID']['input'];
  2950. };
  2951. export type MutationDeleteFacetArgs = {
  2952. force?: InputMaybe<Scalars['Boolean']['input']>;
  2953. id: Scalars['ID']['input'];
  2954. };
  2955. export type MutationDeleteFacetValuesArgs = {
  2956. force?: InputMaybe<Scalars['Boolean']['input']>;
  2957. ids: Array<Scalars['ID']['input']>;
  2958. };
  2959. export type MutationDeleteFacetsArgs = {
  2960. force?: InputMaybe<Scalars['Boolean']['input']>;
  2961. ids: Array<Scalars['ID']['input']>;
  2962. };
  2963. export type MutationDeleteOrderNoteArgs = {
  2964. id: Scalars['ID']['input'];
  2965. };
  2966. export type MutationDeletePaymentMethodArgs = {
  2967. force?: InputMaybe<Scalars['Boolean']['input']>;
  2968. id: Scalars['ID']['input'];
  2969. };
  2970. export type MutationDeletePaymentMethodsArgs = {
  2971. force?: InputMaybe<Scalars['Boolean']['input']>;
  2972. ids: Array<Scalars['ID']['input']>;
  2973. };
  2974. export type MutationDeleteProductArgs = {
  2975. id: Scalars['ID']['input'];
  2976. };
  2977. export type MutationDeleteProductOptionArgs = {
  2978. id: Scalars['ID']['input'];
  2979. };
  2980. export type MutationDeleteProductVariantArgs = {
  2981. id: Scalars['ID']['input'];
  2982. };
  2983. export type MutationDeleteProductVariantsArgs = {
  2984. ids: Array<Scalars['ID']['input']>;
  2985. };
  2986. export type MutationDeleteProductsArgs = {
  2987. ids: Array<Scalars['ID']['input']>;
  2988. };
  2989. export type MutationDeletePromotionArgs = {
  2990. id: Scalars['ID']['input'];
  2991. };
  2992. export type MutationDeletePromotionsArgs = {
  2993. ids: Array<Scalars['ID']['input']>;
  2994. };
  2995. export type MutationDeleteProvinceArgs = {
  2996. id: Scalars['ID']['input'];
  2997. };
  2998. export type MutationDeleteRoleArgs = {
  2999. id: Scalars['ID']['input'];
  3000. };
  3001. export type MutationDeleteRolesArgs = {
  3002. ids: Array<Scalars['ID']['input']>;
  3003. };
  3004. export type MutationDeleteSellerArgs = {
  3005. id: Scalars['ID']['input'];
  3006. };
  3007. export type MutationDeleteSellersArgs = {
  3008. ids: Array<Scalars['ID']['input']>;
  3009. };
  3010. export type MutationDeleteShippingMethodArgs = {
  3011. id: Scalars['ID']['input'];
  3012. };
  3013. export type MutationDeleteShippingMethodsArgs = {
  3014. ids: Array<Scalars['ID']['input']>;
  3015. };
  3016. export type MutationDeleteStockLocationArgs = {
  3017. input: DeleteStockLocationInput;
  3018. };
  3019. export type MutationDeleteStockLocationsArgs = {
  3020. input: Array<DeleteStockLocationInput>;
  3021. };
  3022. export type MutationDeleteTagArgs = {
  3023. id: Scalars['ID']['input'];
  3024. };
  3025. export type MutationDeleteTaxCategoriesArgs = {
  3026. ids: Array<Scalars['ID']['input']>;
  3027. };
  3028. export type MutationDeleteTaxCategoryArgs = {
  3029. id: Scalars['ID']['input'];
  3030. };
  3031. export type MutationDeleteTaxRateArgs = {
  3032. id: Scalars['ID']['input'];
  3033. };
  3034. export type MutationDeleteTaxRatesArgs = {
  3035. ids: Array<Scalars['ID']['input']>;
  3036. };
  3037. export type MutationDeleteZoneArgs = {
  3038. id: Scalars['ID']['input'];
  3039. };
  3040. export type MutationDeleteZonesArgs = {
  3041. ids: Array<Scalars['ID']['input']>;
  3042. };
  3043. export type MutationDuplicateEntityArgs = {
  3044. input: DuplicateEntityInput;
  3045. };
  3046. export type MutationFlushBufferedJobsArgs = {
  3047. bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
  3048. };
  3049. export type MutationImportProductsArgs = {
  3050. csvFile: Scalars['Upload']['input'];
  3051. };
  3052. export type MutationLoginArgs = {
  3053. password: Scalars['String']['input'];
  3054. rememberMe?: InputMaybe<Scalars['Boolean']['input']>;
  3055. username: Scalars['String']['input'];
  3056. };
  3057. export type MutationModifyOrderArgs = {
  3058. input: ModifyOrderInput;
  3059. };
  3060. export type MutationMoveCollectionArgs = {
  3061. input: MoveCollectionInput;
  3062. };
  3063. export type MutationRefundOrderArgs = {
  3064. input: RefundOrderInput;
  3065. };
  3066. export type MutationRemoveCollectionsFromChannelArgs = {
  3067. input: RemoveCollectionsFromChannelInput;
  3068. };
  3069. export type MutationRemoveCouponCodeFromDraftOrderArgs = {
  3070. couponCode: Scalars['String']['input'];
  3071. orderId: Scalars['ID']['input'];
  3072. };
  3073. export type MutationRemoveCustomersFromGroupArgs = {
  3074. customerGroupId: Scalars['ID']['input'];
  3075. customerIds: Array<Scalars['ID']['input']>;
  3076. };
  3077. export type MutationRemoveDraftOrderLineArgs = {
  3078. orderId: Scalars['ID']['input'];
  3079. orderLineId: Scalars['ID']['input'];
  3080. };
  3081. export type MutationRemoveFacetsFromChannelArgs = {
  3082. input: RemoveFacetsFromChannelInput;
  3083. };
  3084. export type MutationRemoveMembersFromZoneArgs = {
  3085. memberIds: Array<Scalars['ID']['input']>;
  3086. zoneId: Scalars['ID']['input'];
  3087. };
  3088. export type MutationRemoveOptionGroupFromProductArgs = {
  3089. force?: InputMaybe<Scalars['Boolean']['input']>;
  3090. optionGroupId: Scalars['ID']['input'];
  3091. productId: Scalars['ID']['input'];
  3092. };
  3093. export type MutationRemovePaymentMethodsFromChannelArgs = {
  3094. input: RemovePaymentMethodsFromChannelInput;
  3095. };
  3096. export type MutationRemoveProductVariantsFromChannelArgs = {
  3097. input: RemoveProductVariantsFromChannelInput;
  3098. };
  3099. export type MutationRemoveProductsFromChannelArgs = {
  3100. input: RemoveProductsFromChannelInput;
  3101. };
  3102. export type MutationRemovePromotionsFromChannelArgs = {
  3103. input: RemovePromotionsFromChannelInput;
  3104. };
  3105. export type MutationRemoveSettledJobsArgs = {
  3106. olderThan?: InputMaybe<Scalars['DateTime']['input']>;
  3107. queueNames?: InputMaybe<Array<Scalars['String']['input']>>;
  3108. };
  3109. export type MutationRemoveShippingMethodsFromChannelArgs = {
  3110. input: RemoveShippingMethodsFromChannelInput;
  3111. };
  3112. export type MutationRemoveStockLocationsFromChannelArgs = {
  3113. input: RemoveStockLocationsFromChannelInput;
  3114. };
  3115. export type MutationSetCustomerForDraftOrderArgs = {
  3116. customerId?: InputMaybe<Scalars['ID']['input']>;
  3117. input?: InputMaybe<CreateCustomerInput>;
  3118. orderId: Scalars['ID']['input'];
  3119. };
  3120. export type MutationSetDraftOrderBillingAddressArgs = {
  3121. input: CreateAddressInput;
  3122. orderId: Scalars['ID']['input'];
  3123. };
  3124. export type MutationSetDraftOrderCustomFieldsArgs = {
  3125. input: UpdateOrderInput;
  3126. orderId: Scalars['ID']['input'];
  3127. };
  3128. export type MutationSetDraftOrderShippingAddressArgs = {
  3129. input: CreateAddressInput;
  3130. orderId: Scalars['ID']['input'];
  3131. };
  3132. export type MutationSetDraftOrderShippingMethodArgs = {
  3133. orderId: Scalars['ID']['input'];
  3134. shippingMethodId: Scalars['ID']['input'];
  3135. };
  3136. export type MutationSetOrderCustomFieldsArgs = {
  3137. input: UpdateOrderInput;
  3138. };
  3139. export type MutationSetOrderCustomerArgs = {
  3140. input: SetOrderCustomerInput;
  3141. };
  3142. export type MutationSettlePaymentArgs = {
  3143. id: Scalars['ID']['input'];
  3144. };
  3145. export type MutationSettleRefundArgs = {
  3146. input: SettleRefundInput;
  3147. };
  3148. export type MutationTransitionFulfillmentToStateArgs = {
  3149. id: Scalars['ID']['input'];
  3150. state: Scalars['String']['input'];
  3151. };
  3152. export type MutationTransitionOrderToStateArgs = {
  3153. id: Scalars['ID']['input'];
  3154. state: Scalars['String']['input'];
  3155. };
  3156. export type MutationTransitionPaymentToStateArgs = {
  3157. id: Scalars['ID']['input'];
  3158. state: Scalars['String']['input'];
  3159. };
  3160. export type MutationUpdateActiveAdministratorArgs = {
  3161. input: UpdateActiveAdministratorInput;
  3162. };
  3163. export type MutationUpdateAdministratorArgs = {
  3164. input: UpdateAdministratorInput;
  3165. };
  3166. export type MutationUpdateAssetArgs = {
  3167. input: UpdateAssetInput;
  3168. };
  3169. export type MutationUpdateChannelArgs = {
  3170. input: UpdateChannelInput;
  3171. };
  3172. export type MutationUpdateCollectionArgs = {
  3173. input: UpdateCollectionInput;
  3174. };
  3175. export type MutationUpdateCountryArgs = {
  3176. input: UpdateCountryInput;
  3177. };
  3178. export type MutationUpdateCustomerArgs = {
  3179. input: UpdateCustomerInput;
  3180. };
  3181. export type MutationUpdateCustomerAddressArgs = {
  3182. input: UpdateAddressInput;
  3183. };
  3184. export type MutationUpdateCustomerGroupArgs = {
  3185. input: UpdateCustomerGroupInput;
  3186. };
  3187. export type MutationUpdateCustomerNoteArgs = {
  3188. input: UpdateCustomerNoteInput;
  3189. };
  3190. export type MutationUpdateFacetArgs = {
  3191. input: UpdateFacetInput;
  3192. };
  3193. export type MutationUpdateFacetValuesArgs = {
  3194. input: Array<UpdateFacetValueInput>;
  3195. };
  3196. export type MutationUpdateGlobalSettingsArgs = {
  3197. input: UpdateGlobalSettingsInput;
  3198. };
  3199. export type MutationUpdateOrderNoteArgs = {
  3200. input: UpdateOrderNoteInput;
  3201. };
  3202. export type MutationUpdatePaymentMethodArgs = {
  3203. input: UpdatePaymentMethodInput;
  3204. };
  3205. export type MutationUpdateProductArgs = {
  3206. input: UpdateProductInput;
  3207. };
  3208. export type MutationUpdateProductOptionArgs = {
  3209. input: UpdateProductOptionInput;
  3210. };
  3211. export type MutationUpdateProductOptionGroupArgs = {
  3212. input: UpdateProductOptionGroupInput;
  3213. };
  3214. export type MutationUpdateProductVariantsArgs = {
  3215. input: Array<UpdateProductVariantInput>;
  3216. };
  3217. export type MutationUpdateProductsArgs = {
  3218. input: Array<UpdateProductInput>;
  3219. };
  3220. export type MutationUpdatePromotionArgs = {
  3221. input: UpdatePromotionInput;
  3222. };
  3223. export type MutationUpdateProvinceArgs = {
  3224. input: UpdateProvinceInput;
  3225. };
  3226. export type MutationUpdateRoleArgs = {
  3227. input: UpdateRoleInput;
  3228. };
  3229. export type MutationUpdateSellerArgs = {
  3230. input: UpdateSellerInput;
  3231. };
  3232. export type MutationUpdateShippingMethodArgs = {
  3233. input: UpdateShippingMethodInput;
  3234. };
  3235. export type MutationUpdateStockLocationArgs = {
  3236. input: UpdateStockLocationInput;
  3237. };
  3238. export type MutationUpdateTagArgs = {
  3239. input: UpdateTagInput;
  3240. };
  3241. export type MutationUpdateTaxCategoryArgs = {
  3242. input: UpdateTaxCategoryInput;
  3243. };
  3244. export type MutationUpdateTaxRateArgs = {
  3245. input: UpdateTaxRateInput;
  3246. };
  3247. export type MutationUpdateZoneArgs = {
  3248. input: UpdateZoneInput;
  3249. };
  3250. export type NativeAuthInput = {
  3251. password: Scalars['String']['input'];
  3252. username: Scalars['String']['input'];
  3253. };
  3254. /** Returned when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
  3255. export type NativeAuthStrategyError = ErrorResult & {
  3256. __typename?: 'NativeAuthStrategyError';
  3257. errorCode: ErrorCode;
  3258. message: Scalars['String']['output'];
  3259. };
  3260. export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
  3261. /** Returned when attempting to set a negative OrderLine quantity. */
  3262. export type NegativeQuantityError = ErrorResult & {
  3263. __typename?: 'NegativeQuantityError';
  3264. errorCode: ErrorCode;
  3265. message: Scalars['String']['output'];
  3266. };
  3267. /**
  3268. * Returned when invoking a mutation which depends on there being an active Order on the
  3269. * current session.
  3270. */
  3271. export type NoActiveOrderError = ErrorResult & {
  3272. __typename?: 'NoActiveOrderError';
  3273. errorCode: ErrorCode;
  3274. message: Scalars['String']['output'];
  3275. };
  3276. /** Returned when a call to modifyOrder fails to specify any changes */
  3277. export type NoChangesSpecifiedError = ErrorResult & {
  3278. __typename?: 'NoChangesSpecifiedError';
  3279. errorCode: ErrorCode;
  3280. message: Scalars['String']['output'];
  3281. };
  3282. export type Node = {
  3283. id: Scalars['ID']['output'];
  3284. };
  3285. /** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */
  3286. export type NothingToRefundError = ErrorResult & {
  3287. __typename?: 'NothingToRefundError';
  3288. errorCode: ErrorCode;
  3289. message: Scalars['String']['output'];
  3290. };
  3291. /** Operators for filtering on a list of Number fields */
  3292. export type NumberListOperators = {
  3293. inList: Scalars['Float']['input'];
  3294. };
  3295. /** Operators for filtering on a Int or Float field */
  3296. export type NumberOperators = {
  3297. between?: InputMaybe<NumberRange>;
  3298. eq?: InputMaybe<Scalars['Float']['input']>;
  3299. gt?: InputMaybe<Scalars['Float']['input']>;
  3300. gte?: InputMaybe<Scalars['Float']['input']>;
  3301. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  3302. lt?: InputMaybe<Scalars['Float']['input']>;
  3303. lte?: InputMaybe<Scalars['Float']['input']>;
  3304. };
  3305. export type NumberRange = {
  3306. end: Scalars['Float']['input'];
  3307. start: Scalars['Float']['input'];
  3308. };
  3309. export type Order = Node & {
  3310. __typename?: 'Order';
  3311. /** An order is active as long as the payment process has not been completed */
  3312. active: Scalars['Boolean']['output'];
  3313. aggregateOrder?: Maybe<Order>;
  3314. aggregateOrderId?: Maybe<Scalars['ID']['output']>;
  3315. billingAddress?: Maybe<OrderAddress>;
  3316. channels: Array<Channel>;
  3317. /** A unique code for the Order */
  3318. code: Scalars['String']['output'];
  3319. /** An array of all coupon codes applied to the Order */
  3320. couponCodes: Array<Scalars['String']['output']>;
  3321. createdAt: Scalars['DateTime']['output'];
  3322. currencyCode: CurrencyCode;
  3323. customFields?: Maybe<Scalars['JSON']['output']>;
  3324. customer?: Maybe<Customer>;
  3325. discounts: Array<Discount>;
  3326. fulfillments?: Maybe<Array<Fulfillment>>;
  3327. history: HistoryEntryList;
  3328. id: Scalars['ID']['output'];
  3329. lines: Array<OrderLine>;
  3330. modifications: Array<OrderModification>;
  3331. nextStates: Array<Scalars['String']['output']>;
  3332. /**
  3333. * The date & time that the Order was placed, i.e. the Customer
  3334. * completed the checkout and the Order is no longer "active"
  3335. */
  3336. orderPlacedAt?: Maybe<Scalars['DateTime']['output']>;
  3337. payments?: Maybe<Array<Payment>>;
  3338. /** Promotions applied to the order. Only gets populated after the payment process has completed. */
  3339. promotions: Array<Promotion>;
  3340. sellerOrders?: Maybe<Array<Order>>;
  3341. shipping: Scalars['Money']['output'];
  3342. shippingAddress?: Maybe<OrderAddress>;
  3343. shippingLines: Array<ShippingLine>;
  3344. shippingWithTax: Scalars['Money']['output'];
  3345. state: Scalars['String']['output'];
  3346. /**
  3347. * The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
  3348. * discounts which have been prorated (proportionally distributed) amongst the items of each OrderLine.
  3349. * To get a total of all OrderLines which does not account for prorated discounts, use the
  3350. * sum of `OrderLine.discountedLinePrice` values.
  3351. */
  3352. subTotal: Scalars['Money']['output'];
  3353. /** Same as subTotal, but inclusive of tax */
  3354. subTotalWithTax: Scalars['Money']['output'];
  3355. /**
  3356. * Surcharges are arbitrary modifications to the Order total which are neither
  3357. * ProductVariants nor discounts resulting from applied Promotions. For example,
  3358. * one-off discounts based on customer interaction, or surcharges based on payment
  3359. * methods.
  3360. */
  3361. surcharges: Array<Surcharge>;
  3362. /** A summary of the taxes being applied to this Order */
  3363. taxSummary: Array<OrderTaxSummary>;
  3364. /** Equal to subTotal plus shipping */
  3365. total: Scalars['Money']['output'];
  3366. totalQuantity: Scalars['Int']['output'];
  3367. /** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
  3368. totalWithTax: Scalars['Money']['output'];
  3369. type: OrderType;
  3370. updatedAt: Scalars['DateTime']['output'];
  3371. };
  3372. export type OrderHistoryArgs = {
  3373. options?: InputMaybe<HistoryEntryListOptions>;
  3374. };
  3375. export type OrderAddress = {
  3376. __typename?: 'OrderAddress';
  3377. city?: Maybe<Scalars['String']['output']>;
  3378. company?: Maybe<Scalars['String']['output']>;
  3379. country?: Maybe<Scalars['String']['output']>;
  3380. countryCode?: Maybe<Scalars['String']['output']>;
  3381. customFields?: Maybe<Scalars['JSON']['output']>;
  3382. fullName?: Maybe<Scalars['String']['output']>;
  3383. phoneNumber?: Maybe<Scalars['String']['output']>;
  3384. postalCode?: Maybe<Scalars['String']['output']>;
  3385. province?: Maybe<Scalars['String']['output']>;
  3386. streetLine1?: Maybe<Scalars['String']['output']>;
  3387. streetLine2?: Maybe<Scalars['String']['output']>;
  3388. };
  3389. export type OrderFilterParameter = {
  3390. _and?: InputMaybe<Array<OrderFilterParameter>>;
  3391. _or?: InputMaybe<Array<OrderFilterParameter>>;
  3392. active?: InputMaybe<BooleanOperators>;
  3393. aggregateOrderId?: InputMaybe<IdOperators>;
  3394. code?: InputMaybe<StringOperators>;
  3395. createdAt?: InputMaybe<DateOperators>;
  3396. currencyCode?: InputMaybe<StringOperators>;
  3397. customerLastName?: InputMaybe<StringOperators>;
  3398. id?: InputMaybe<IdOperators>;
  3399. orderPlacedAt?: InputMaybe<DateOperators>;
  3400. shipping?: InputMaybe<NumberOperators>;
  3401. shippingWithTax?: InputMaybe<NumberOperators>;
  3402. state?: InputMaybe<StringOperators>;
  3403. subTotal?: InputMaybe<NumberOperators>;
  3404. subTotalWithTax?: InputMaybe<NumberOperators>;
  3405. total?: InputMaybe<NumberOperators>;
  3406. totalQuantity?: InputMaybe<NumberOperators>;
  3407. totalWithTax?: InputMaybe<NumberOperators>;
  3408. transactionId?: InputMaybe<StringOperators>;
  3409. type?: InputMaybe<StringOperators>;
  3410. updatedAt?: InputMaybe<DateOperators>;
  3411. };
  3412. /** Returned when the maximum order size limit has been reached. */
  3413. export type OrderLimitError = ErrorResult & {
  3414. __typename?: 'OrderLimitError';
  3415. errorCode: ErrorCode;
  3416. maxItems: Scalars['Int']['output'];
  3417. message: Scalars['String']['output'];
  3418. };
  3419. export type OrderLine = Node & {
  3420. __typename?: 'OrderLine';
  3421. createdAt: Scalars['DateTime']['output'];
  3422. customFields?: Maybe<Scalars['JSON']['output']>;
  3423. /** The price of the line including discounts, excluding tax */
  3424. discountedLinePrice: Scalars['Money']['output'];
  3425. /** The price of the line including discounts and tax */
  3426. discountedLinePriceWithTax: Scalars['Money']['output'];
  3427. /**
  3428. * The price of a single unit including discounts, excluding tax.
  3429. *
  3430. * If Order-level discounts have been applied, this will not be the
  3431. * actual taxable unit price (see `proratedUnitPrice`), but is generally the
  3432. * correct price to display to customers to avoid confusion
  3433. * about the internal handling of distributed Order-level discounts.
  3434. */
  3435. discountedUnitPrice: Scalars['Money']['output'];
  3436. /** The price of a single unit including discounts and tax */
  3437. discountedUnitPriceWithTax: Scalars['Money']['output'];
  3438. discounts: Array<Discount>;
  3439. featuredAsset?: Maybe<Asset>;
  3440. fulfillmentLines?: Maybe<Array<FulfillmentLine>>;
  3441. id: Scalars['ID']['output'];
  3442. /** The total price of the line excluding tax and discounts. */
  3443. linePrice: Scalars['Money']['output'];
  3444. /** The total price of the line including tax but excluding discounts. */
  3445. linePriceWithTax: Scalars['Money']['output'];
  3446. /** The total tax on this line */
  3447. lineTax: Scalars['Money']['output'];
  3448. order: Order;
  3449. /** The quantity at the time the Order was placed */
  3450. orderPlacedQuantity: Scalars['Int']['output'];
  3451. productVariant: ProductVariant;
  3452. /**
  3453. * The actual line price, taking into account both item discounts _and_ prorated (proportionally-distributed)
  3454. * Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
  3455. * and refund calculations.
  3456. */
  3457. proratedLinePrice: Scalars['Money']['output'];
  3458. /** The proratedLinePrice including tax */
  3459. proratedLinePriceWithTax: Scalars['Money']['output'];
  3460. /**
  3461. * The actual unit price, taking into account both item discounts _and_ prorated (proportionally-distributed)
  3462. * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
  3463. * and refund calculations.
  3464. */
  3465. proratedUnitPrice: Scalars['Money']['output'];
  3466. /** The proratedUnitPrice including tax */
  3467. proratedUnitPriceWithTax: Scalars['Money']['output'];
  3468. /** The quantity of items purchased */
  3469. quantity: Scalars['Int']['output'];
  3470. taxLines: Array<TaxLine>;
  3471. taxRate: Scalars['Float']['output'];
  3472. /** The price of a single unit, excluding tax and discounts */
  3473. unitPrice: Scalars['Money']['output'];
  3474. /** Non-zero if the unitPrice has changed since it was initially added to Order */
  3475. unitPriceChangeSinceAdded: Scalars['Money']['output'];
  3476. /** The price of a single unit, including tax but excluding discounts */
  3477. unitPriceWithTax: Scalars['Money']['output'];
  3478. /** Non-zero if the unitPriceWithTax has changed since it was initially added to Order */
  3479. unitPriceWithTaxChangeSinceAdded: Scalars['Money']['output'];
  3480. updatedAt: Scalars['DateTime']['output'];
  3481. };
  3482. export type OrderLineInput = {
  3483. orderLineId: Scalars['ID']['input'];
  3484. quantity: Scalars['Int']['input'];
  3485. };
  3486. export type OrderList = PaginatedList & {
  3487. __typename?: 'OrderList';
  3488. items: Array<Order>;
  3489. totalItems: Scalars['Int']['output'];
  3490. };
  3491. export type OrderListOptions = {
  3492. /** Allows the results to be filtered */
  3493. filter?: InputMaybe<OrderFilterParameter>;
  3494. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  3495. filterOperator?: InputMaybe<LogicalOperator>;
  3496. /** Skips the first n results, for use in pagination */
  3497. skip?: InputMaybe<Scalars['Int']['input']>;
  3498. /** Specifies which properties to sort the results by */
  3499. sort?: InputMaybe<OrderSortParameter>;
  3500. /** Takes n results, for use in pagination */
  3501. take?: InputMaybe<Scalars['Int']['input']>;
  3502. };
  3503. export type OrderModification = Node & {
  3504. __typename?: 'OrderModification';
  3505. createdAt: Scalars['DateTime']['output'];
  3506. id: Scalars['ID']['output'];
  3507. isSettled: Scalars['Boolean']['output'];
  3508. lines: Array<OrderModificationLine>;
  3509. note: Scalars['String']['output'];
  3510. payment?: Maybe<Payment>;
  3511. priceChange: Scalars['Money']['output'];
  3512. refund?: Maybe<Refund>;
  3513. surcharges?: Maybe<Array<Surcharge>>;
  3514. updatedAt: Scalars['DateTime']['output'];
  3515. };
  3516. /** Returned when attempting to modify the contents of an Order that is not in the `AddingItems` state. */
  3517. export type OrderModificationError = ErrorResult & {
  3518. __typename?: 'OrderModificationError';
  3519. errorCode: ErrorCode;
  3520. message: Scalars['String']['output'];
  3521. };
  3522. export type OrderModificationLine = {
  3523. __typename?: 'OrderModificationLine';
  3524. modification: OrderModification;
  3525. modificationId: Scalars['ID']['output'];
  3526. orderLine: OrderLine;
  3527. orderLineId: Scalars['ID']['output'];
  3528. quantity: Scalars['Int']['output'];
  3529. };
  3530. /** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */
  3531. export type OrderModificationStateError = ErrorResult & {
  3532. __typename?: 'OrderModificationStateError';
  3533. errorCode: ErrorCode;
  3534. message: Scalars['String']['output'];
  3535. };
  3536. export type OrderProcessState = {
  3537. __typename?: 'OrderProcessState';
  3538. name: Scalars['String']['output'];
  3539. to: Array<Scalars['String']['output']>;
  3540. };
  3541. export type OrderSortParameter = {
  3542. aggregateOrderId?: InputMaybe<SortOrder>;
  3543. code?: InputMaybe<SortOrder>;
  3544. createdAt?: InputMaybe<SortOrder>;
  3545. customerLastName?: InputMaybe<SortOrder>;
  3546. id?: InputMaybe<SortOrder>;
  3547. orderPlacedAt?: InputMaybe<SortOrder>;
  3548. shipping?: InputMaybe<SortOrder>;
  3549. shippingWithTax?: InputMaybe<SortOrder>;
  3550. state?: InputMaybe<SortOrder>;
  3551. subTotal?: InputMaybe<SortOrder>;
  3552. subTotalWithTax?: InputMaybe<SortOrder>;
  3553. total?: InputMaybe<SortOrder>;
  3554. totalQuantity?: InputMaybe<SortOrder>;
  3555. totalWithTax?: InputMaybe<SortOrder>;
  3556. transactionId?: InputMaybe<SortOrder>;
  3557. updatedAt?: InputMaybe<SortOrder>;
  3558. };
  3559. /** Returned if there is an error in transitioning the Order state */
  3560. export type OrderStateTransitionError = ErrorResult & {
  3561. __typename?: 'OrderStateTransitionError';
  3562. errorCode: ErrorCode;
  3563. fromState: Scalars['String']['output'];
  3564. message: Scalars['String']['output'];
  3565. toState: Scalars['String']['output'];
  3566. transitionError: Scalars['String']['output'];
  3567. };
  3568. /**
  3569. * A summary of the taxes being applied to this order, grouped
  3570. * by taxRate.
  3571. */
  3572. export type OrderTaxSummary = {
  3573. __typename?: 'OrderTaxSummary';
  3574. /** A description of this tax */
  3575. description: Scalars['String']['output'];
  3576. /** The total net price of OrderLines to which this taxRate applies */
  3577. taxBase: Scalars['Money']['output'];
  3578. /** The taxRate as a percentage */
  3579. taxRate: Scalars['Float']['output'];
  3580. /** The total tax being applied to the Order at this taxRate */
  3581. taxTotal: Scalars['Money']['output'];
  3582. };
  3583. export enum OrderType {
  3584. Aggregate = 'Aggregate',
  3585. Regular = 'Regular',
  3586. Seller = 'Seller'
  3587. }
  3588. export type PaginatedList = {
  3589. items: Array<Node>;
  3590. totalItems: Scalars['Int']['output'];
  3591. };
  3592. export type Payment = Node & {
  3593. __typename?: 'Payment';
  3594. amount: Scalars['Money']['output'];
  3595. createdAt: Scalars['DateTime']['output'];
  3596. errorMessage?: Maybe<Scalars['String']['output']>;
  3597. id: Scalars['ID']['output'];
  3598. metadata?: Maybe<Scalars['JSON']['output']>;
  3599. method: Scalars['String']['output'];
  3600. nextStates: Array<Scalars['String']['output']>;
  3601. refunds: Array<Refund>;
  3602. state: Scalars['String']['output'];
  3603. transactionId?: Maybe<Scalars['String']['output']>;
  3604. updatedAt: Scalars['DateTime']['output'];
  3605. };
  3606. export type PaymentMethod = Node & {
  3607. __typename?: 'PaymentMethod';
  3608. checker?: Maybe<ConfigurableOperation>;
  3609. code: Scalars['String']['output'];
  3610. createdAt: Scalars['DateTime']['output'];
  3611. customFields?: Maybe<Scalars['JSON']['output']>;
  3612. description: Scalars['String']['output'];
  3613. enabled: Scalars['Boolean']['output'];
  3614. handler: ConfigurableOperation;
  3615. id: Scalars['ID']['output'];
  3616. name: Scalars['String']['output'];
  3617. translations: Array<PaymentMethodTranslation>;
  3618. updatedAt: Scalars['DateTime']['output'];
  3619. };
  3620. export type PaymentMethodFilterParameter = {
  3621. _and?: InputMaybe<Array<PaymentMethodFilterParameter>>;
  3622. _or?: InputMaybe<Array<PaymentMethodFilterParameter>>;
  3623. code?: InputMaybe<StringOperators>;
  3624. createdAt?: InputMaybe<DateOperators>;
  3625. description?: InputMaybe<StringOperators>;
  3626. enabled?: InputMaybe<BooleanOperators>;
  3627. id?: InputMaybe<IdOperators>;
  3628. name?: InputMaybe<StringOperators>;
  3629. updatedAt?: InputMaybe<DateOperators>;
  3630. };
  3631. export type PaymentMethodList = PaginatedList & {
  3632. __typename?: 'PaymentMethodList';
  3633. items: Array<PaymentMethod>;
  3634. totalItems: Scalars['Int']['output'];
  3635. };
  3636. export type PaymentMethodListOptions = {
  3637. /** Allows the results to be filtered */
  3638. filter?: InputMaybe<PaymentMethodFilterParameter>;
  3639. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  3640. filterOperator?: InputMaybe<LogicalOperator>;
  3641. /** Skips the first n results, for use in pagination */
  3642. skip?: InputMaybe<Scalars['Int']['input']>;
  3643. /** Specifies which properties to sort the results by */
  3644. sort?: InputMaybe<PaymentMethodSortParameter>;
  3645. /** Takes n results, for use in pagination */
  3646. take?: InputMaybe<Scalars['Int']['input']>;
  3647. };
  3648. /**
  3649. * Returned when a call to modifyOrder fails to include a paymentMethod even
  3650. * though the price has increased as a result of the changes.
  3651. */
  3652. export type PaymentMethodMissingError = ErrorResult & {
  3653. __typename?: 'PaymentMethodMissingError';
  3654. errorCode: ErrorCode;
  3655. message: Scalars['String']['output'];
  3656. };
  3657. export type PaymentMethodQuote = {
  3658. __typename?: 'PaymentMethodQuote';
  3659. code: Scalars['String']['output'];
  3660. customFields?: Maybe<Scalars['JSON']['output']>;
  3661. description: Scalars['String']['output'];
  3662. eligibilityMessage?: Maybe<Scalars['String']['output']>;
  3663. id: Scalars['ID']['output'];
  3664. isEligible: Scalars['Boolean']['output'];
  3665. name: Scalars['String']['output'];
  3666. };
  3667. export type PaymentMethodSortParameter = {
  3668. code?: InputMaybe<SortOrder>;
  3669. createdAt?: InputMaybe<SortOrder>;
  3670. description?: InputMaybe<SortOrder>;
  3671. id?: InputMaybe<SortOrder>;
  3672. name?: InputMaybe<SortOrder>;
  3673. updatedAt?: InputMaybe<SortOrder>;
  3674. };
  3675. export type PaymentMethodTranslation = {
  3676. __typename?: 'PaymentMethodTranslation';
  3677. createdAt: Scalars['DateTime']['output'];
  3678. description: Scalars['String']['output'];
  3679. id: Scalars['ID']['output'];
  3680. languageCode: LanguageCode;
  3681. name: Scalars['String']['output'];
  3682. updatedAt: Scalars['DateTime']['output'];
  3683. };
  3684. export type PaymentMethodTranslationInput = {
  3685. customFields?: InputMaybe<Scalars['JSON']['input']>;
  3686. description?: InputMaybe<Scalars['String']['input']>;
  3687. id?: InputMaybe<Scalars['ID']['input']>;
  3688. languageCode: LanguageCode;
  3689. name?: InputMaybe<Scalars['String']['input']>;
  3690. };
  3691. /** Returned if an attempting to refund a Payment against OrderLines from a different Order */
  3692. export type PaymentOrderMismatchError = ErrorResult & {
  3693. __typename?: 'PaymentOrderMismatchError';
  3694. errorCode: ErrorCode;
  3695. message: Scalars['String']['output'];
  3696. };
  3697. /** Returned when there is an error in transitioning the Payment state */
  3698. export type PaymentStateTransitionError = ErrorResult & {
  3699. __typename?: 'PaymentStateTransitionError';
  3700. errorCode: ErrorCode;
  3701. fromState: Scalars['String']['output'];
  3702. message: Scalars['String']['output'];
  3703. toState: Scalars['String']['output'];
  3704. transitionError: Scalars['String']['output'];
  3705. };
  3706. /**
  3707. * @description
  3708. * Permissions for administrators and customers. Used to control access to
  3709. * GraphQL resolvers via the {@link Allow} decorator.
  3710. *
  3711. * ## Understanding Permission.Owner
  3712. *
  3713. * `Permission.Owner` is a special permission which is used in some Vendure resolvers to indicate that that resolver should only
  3714. * be accessible to the "owner" of that resource.
  3715. *
  3716. * For example, the Shop API `activeCustomer` query resolver should only return the Customer object for the "owner" of that Customer, i.e.
  3717. * based on the activeUserId of the current session. As a result, the resolver code looks like this:
  3718. *
  3719. * @example
  3720. * ```TypeScript
  3721. * \@Query()
  3722. * \@Allow(Permission.Owner)
  3723. * async activeCustomer(\@Ctx() ctx: RequestContext): Promise<Customer | undefined> {
  3724. * const userId = ctx.activeUserId;
  3725. * if (userId) {
  3726. * return this.customerService.findOneByUserId(ctx, userId);
  3727. * }
  3728. * }
  3729. * ```
  3730. *
  3731. * Here we can see that the "ownership" must be enforced by custom logic inside the resolver. Since "ownership" cannot be defined generally
  3732. * nor statically encoded at build-time, any resolvers using `Permission.Owner` **must** include logic to enforce that only the owner
  3733. * of the resource has access. If not, then it is the equivalent of using `Permission.Public`.
  3734. *
  3735. *
  3736. * @docsCategory common
  3737. */
  3738. export enum Permission {
  3739. /** Authenticated means simply that the user is logged in */
  3740. Authenticated = 'Authenticated',
  3741. /** Grants permission to create Administrator */
  3742. CreateAdministrator = 'CreateAdministrator',
  3743. /** Grants permission to create Asset */
  3744. CreateAsset = 'CreateAsset',
  3745. /** Grants permission to create Products, Facets, Assets, Collections */
  3746. CreateCatalog = 'CreateCatalog',
  3747. /** Grants permission to create Channel */
  3748. CreateChannel = 'CreateChannel',
  3749. /** Grants permission to create Collection */
  3750. CreateCollection = 'CreateCollection',
  3751. /** Grants permission to create Country */
  3752. CreateCountry = 'CreateCountry',
  3753. /** Grants permission to create Customer */
  3754. CreateCustomer = 'CreateCustomer',
  3755. /** Grants permission to create CustomerGroup */
  3756. CreateCustomerGroup = 'CreateCustomerGroup',
  3757. /** Grants permission to create Facet */
  3758. CreateFacet = 'CreateFacet',
  3759. /** Grants permission to create Order */
  3760. CreateOrder = 'CreateOrder',
  3761. /** Grants permission to create PaymentMethod */
  3762. CreatePaymentMethod = 'CreatePaymentMethod',
  3763. /** Grants permission to create Product */
  3764. CreateProduct = 'CreateProduct',
  3765. /** Grants permission to create Promotion */
  3766. CreatePromotion = 'CreatePromotion',
  3767. /** Grants permission to create Seller */
  3768. CreateSeller = 'CreateSeller',
  3769. /** Grants permission to create PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3770. CreateSettings = 'CreateSettings',
  3771. /** Grants permission to create ShippingMethod */
  3772. CreateShippingMethod = 'CreateShippingMethod',
  3773. /** Grants permission to create StockLocation */
  3774. CreateStockLocation = 'CreateStockLocation',
  3775. /** Grants permission to create System */
  3776. CreateSystem = 'CreateSystem',
  3777. /** Grants permission to create Tag */
  3778. CreateTag = 'CreateTag',
  3779. /** Grants permission to create TaxCategory */
  3780. CreateTaxCategory = 'CreateTaxCategory',
  3781. /** Grants permission to create TaxRate */
  3782. CreateTaxRate = 'CreateTaxRate',
  3783. /** Grants permission to create Zone */
  3784. CreateZone = 'CreateZone',
  3785. /** Grants permission to delete Administrator */
  3786. DeleteAdministrator = 'DeleteAdministrator',
  3787. /** Grants permission to delete Asset */
  3788. DeleteAsset = 'DeleteAsset',
  3789. /** Grants permission to delete Products, Facets, Assets, Collections */
  3790. DeleteCatalog = 'DeleteCatalog',
  3791. /** Grants permission to delete Channel */
  3792. DeleteChannel = 'DeleteChannel',
  3793. /** Grants permission to delete Collection */
  3794. DeleteCollection = 'DeleteCollection',
  3795. /** Grants permission to delete Country */
  3796. DeleteCountry = 'DeleteCountry',
  3797. /** Grants permission to delete Customer */
  3798. DeleteCustomer = 'DeleteCustomer',
  3799. /** Grants permission to delete CustomerGroup */
  3800. DeleteCustomerGroup = 'DeleteCustomerGroup',
  3801. /** Grants permission to delete Facet */
  3802. DeleteFacet = 'DeleteFacet',
  3803. /** Grants permission to delete Order */
  3804. DeleteOrder = 'DeleteOrder',
  3805. /** Grants permission to delete PaymentMethod */
  3806. DeletePaymentMethod = 'DeletePaymentMethod',
  3807. /** Grants permission to delete Product */
  3808. DeleteProduct = 'DeleteProduct',
  3809. /** Grants permission to delete Promotion */
  3810. DeletePromotion = 'DeletePromotion',
  3811. /** Grants permission to delete Seller */
  3812. DeleteSeller = 'DeleteSeller',
  3813. /** Grants permission to delete PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3814. DeleteSettings = 'DeleteSettings',
  3815. /** Grants permission to delete ShippingMethod */
  3816. DeleteShippingMethod = 'DeleteShippingMethod',
  3817. /** Grants permission to delete StockLocation */
  3818. DeleteStockLocation = 'DeleteStockLocation',
  3819. /** Grants permission to delete System */
  3820. DeleteSystem = 'DeleteSystem',
  3821. /** Grants permission to delete Tag */
  3822. DeleteTag = 'DeleteTag',
  3823. /** Grants permission to delete TaxCategory */
  3824. DeleteTaxCategory = 'DeleteTaxCategory',
  3825. /** Grants permission to delete TaxRate */
  3826. DeleteTaxRate = 'DeleteTaxRate',
  3827. /** Grants permission to delete Zone */
  3828. DeleteZone = 'DeleteZone',
  3829. /** Owner means the user owns this entity, e.g. a Customer's own Order */
  3830. Owner = 'Owner',
  3831. /** Public means any unauthenticated user may perform the operation */
  3832. Public = 'Public',
  3833. /** Grants permission to read Administrator */
  3834. ReadAdministrator = 'ReadAdministrator',
  3835. /** Grants permission to read Asset */
  3836. ReadAsset = 'ReadAsset',
  3837. /** Grants permission to read Products, Facets, Assets, Collections */
  3838. ReadCatalog = 'ReadCatalog',
  3839. /** Grants permission to read Channel */
  3840. ReadChannel = 'ReadChannel',
  3841. /** Grants permission to read Collection */
  3842. ReadCollection = 'ReadCollection',
  3843. /** Grants permission to read Country */
  3844. ReadCountry = 'ReadCountry',
  3845. /** Grants permission to read Customer */
  3846. ReadCustomer = 'ReadCustomer',
  3847. /** Grants permission to read CustomerGroup */
  3848. ReadCustomerGroup = 'ReadCustomerGroup',
  3849. /** Grants permission to read Facet */
  3850. ReadFacet = 'ReadFacet',
  3851. /** Grants permission to read Order */
  3852. ReadOrder = 'ReadOrder',
  3853. /** Grants permission to read PaymentMethod */
  3854. ReadPaymentMethod = 'ReadPaymentMethod',
  3855. /** Grants permission to read Product */
  3856. ReadProduct = 'ReadProduct',
  3857. /** Grants permission to read Promotion */
  3858. ReadPromotion = 'ReadPromotion',
  3859. /** Grants permission to read Seller */
  3860. ReadSeller = 'ReadSeller',
  3861. /** Grants permission to read PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3862. ReadSettings = 'ReadSettings',
  3863. /** Grants permission to read ShippingMethod */
  3864. ReadShippingMethod = 'ReadShippingMethod',
  3865. /** Grants permission to read StockLocation */
  3866. ReadStockLocation = 'ReadStockLocation',
  3867. /** Grants permission to read System */
  3868. ReadSystem = 'ReadSystem',
  3869. /** Grants permission to read Tag */
  3870. ReadTag = 'ReadTag',
  3871. /** Grants permission to read TaxCategory */
  3872. ReadTaxCategory = 'ReadTaxCategory',
  3873. /** Grants permission to read TaxRate */
  3874. ReadTaxRate = 'ReadTaxRate',
  3875. /** Grants permission to read Zone */
  3876. ReadZone = 'ReadZone',
  3877. /** SuperAdmin has unrestricted access to all operations */
  3878. SuperAdmin = 'SuperAdmin',
  3879. /** Grants permission to update Administrator */
  3880. UpdateAdministrator = 'UpdateAdministrator',
  3881. /** Grants permission to update Asset */
  3882. UpdateAsset = 'UpdateAsset',
  3883. /** Grants permission to update Products, Facets, Assets, Collections */
  3884. UpdateCatalog = 'UpdateCatalog',
  3885. /** Grants permission to update Channel */
  3886. UpdateChannel = 'UpdateChannel',
  3887. /** Grants permission to update Collection */
  3888. UpdateCollection = 'UpdateCollection',
  3889. /** Grants permission to update Country */
  3890. UpdateCountry = 'UpdateCountry',
  3891. /** Grants permission to update Customer */
  3892. UpdateCustomer = 'UpdateCustomer',
  3893. /** Grants permission to update CustomerGroup */
  3894. UpdateCustomerGroup = 'UpdateCustomerGroup',
  3895. /** Grants permission to update Facet */
  3896. UpdateFacet = 'UpdateFacet',
  3897. /** Grants permission to update GlobalSettings */
  3898. UpdateGlobalSettings = 'UpdateGlobalSettings',
  3899. /** Grants permission to update Order */
  3900. UpdateOrder = 'UpdateOrder',
  3901. /** Grants permission to update PaymentMethod */
  3902. UpdatePaymentMethod = 'UpdatePaymentMethod',
  3903. /** Grants permission to update Product */
  3904. UpdateProduct = 'UpdateProduct',
  3905. /** Grants permission to update Promotion */
  3906. UpdatePromotion = 'UpdatePromotion',
  3907. /** Grants permission to update Seller */
  3908. UpdateSeller = 'UpdateSeller',
  3909. /** Grants permission to update PaymentMethods, ShippingMethods, TaxCategories, TaxRates, Zones, Countries, System & GlobalSettings */
  3910. UpdateSettings = 'UpdateSettings',
  3911. /** Grants permission to update ShippingMethod */
  3912. UpdateShippingMethod = 'UpdateShippingMethod',
  3913. /** Grants permission to update StockLocation */
  3914. UpdateStockLocation = 'UpdateStockLocation',
  3915. /** Grants permission to update System */
  3916. UpdateSystem = 'UpdateSystem',
  3917. /** Grants permission to update Tag */
  3918. UpdateTag = 'UpdateTag',
  3919. /** Grants permission to update TaxCategory */
  3920. UpdateTaxCategory = 'UpdateTaxCategory',
  3921. /** Grants permission to update TaxRate */
  3922. UpdateTaxRate = 'UpdateTaxRate',
  3923. /** Grants permission to update Zone */
  3924. UpdateZone = 'UpdateZone'
  3925. }
  3926. export type PermissionDefinition = {
  3927. __typename?: 'PermissionDefinition';
  3928. assignable: Scalars['Boolean']['output'];
  3929. description: Scalars['String']['output'];
  3930. name: Scalars['String']['output'];
  3931. };
  3932. export type PreviewCollectionVariantsInput = {
  3933. filters: Array<ConfigurableOperationInput>;
  3934. inheritFilters: Scalars['Boolean']['input'];
  3935. parentId?: InputMaybe<Scalars['ID']['input']>;
  3936. };
  3937. /** The price range where the result has more than one price */
  3938. export type PriceRange = {
  3939. __typename?: 'PriceRange';
  3940. max: Scalars['Money']['output'];
  3941. min: Scalars['Money']['output'];
  3942. };
  3943. export type Product = Node & {
  3944. __typename?: 'Product';
  3945. assets: Array<Asset>;
  3946. channels: Array<Channel>;
  3947. collections: Array<Collection>;
  3948. createdAt: Scalars['DateTime']['output'];
  3949. customFields?: Maybe<Scalars['JSON']['output']>;
  3950. description: Scalars['String']['output'];
  3951. enabled: Scalars['Boolean']['output'];
  3952. facetValues: Array<FacetValue>;
  3953. featuredAsset?: Maybe<Asset>;
  3954. id: Scalars['ID']['output'];
  3955. languageCode: LanguageCode;
  3956. name: Scalars['String']['output'];
  3957. optionGroups: Array<ProductOptionGroup>;
  3958. slug: Scalars['String']['output'];
  3959. translations: Array<ProductTranslation>;
  3960. updatedAt: Scalars['DateTime']['output'];
  3961. /** Returns a paginated, sortable, filterable list of ProductVariants */
  3962. variantList: ProductVariantList;
  3963. /** Returns all ProductVariants */
  3964. variants: Array<ProductVariant>;
  3965. };
  3966. export type ProductVariantListArgs = {
  3967. options?: InputMaybe<ProductVariantListOptions>;
  3968. };
  3969. export type ProductFilterParameter = {
  3970. _and?: InputMaybe<Array<ProductFilterParameter>>;
  3971. _or?: InputMaybe<Array<ProductFilterParameter>>;
  3972. createdAt?: InputMaybe<DateOperators>;
  3973. description?: InputMaybe<StringOperators>;
  3974. enabled?: InputMaybe<BooleanOperators>;
  3975. facetValueId?: InputMaybe<IdOperators>;
  3976. id?: InputMaybe<IdOperators>;
  3977. languageCode?: InputMaybe<StringOperators>;
  3978. name?: InputMaybe<StringOperators>;
  3979. sku?: InputMaybe<StringOperators>;
  3980. slug?: InputMaybe<StringOperators>;
  3981. updatedAt?: InputMaybe<DateOperators>;
  3982. };
  3983. export type ProductList = PaginatedList & {
  3984. __typename?: 'ProductList';
  3985. items: Array<Product>;
  3986. totalItems: Scalars['Int']['output'];
  3987. };
  3988. export type ProductListOptions = {
  3989. /** Allows the results to be filtered */
  3990. filter?: InputMaybe<ProductFilterParameter>;
  3991. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  3992. filterOperator?: InputMaybe<LogicalOperator>;
  3993. /** Skips the first n results, for use in pagination */
  3994. skip?: InputMaybe<Scalars['Int']['input']>;
  3995. /** Specifies which properties to sort the results by */
  3996. sort?: InputMaybe<ProductSortParameter>;
  3997. /** Takes n results, for use in pagination */
  3998. take?: InputMaybe<Scalars['Int']['input']>;
  3999. };
  4000. export type ProductOption = Node & {
  4001. __typename?: 'ProductOption';
  4002. code: Scalars['String']['output'];
  4003. createdAt: Scalars['DateTime']['output'];
  4004. customFields?: Maybe<Scalars['JSON']['output']>;
  4005. group: ProductOptionGroup;
  4006. groupId: Scalars['ID']['output'];
  4007. id: Scalars['ID']['output'];
  4008. languageCode: LanguageCode;
  4009. name: Scalars['String']['output'];
  4010. translations: Array<ProductOptionTranslation>;
  4011. updatedAt: Scalars['DateTime']['output'];
  4012. };
  4013. export type ProductOptionGroup = Node & {
  4014. __typename?: 'ProductOptionGroup';
  4015. code: Scalars['String']['output'];
  4016. createdAt: Scalars['DateTime']['output'];
  4017. customFields?: Maybe<Scalars['JSON']['output']>;
  4018. id: Scalars['ID']['output'];
  4019. languageCode: LanguageCode;
  4020. name: Scalars['String']['output'];
  4021. options: Array<ProductOption>;
  4022. translations: Array<ProductOptionGroupTranslation>;
  4023. updatedAt: Scalars['DateTime']['output'];
  4024. };
  4025. export type ProductOptionGroupTranslation = {
  4026. __typename?: 'ProductOptionGroupTranslation';
  4027. createdAt: Scalars['DateTime']['output'];
  4028. id: Scalars['ID']['output'];
  4029. languageCode: LanguageCode;
  4030. name: Scalars['String']['output'];
  4031. updatedAt: Scalars['DateTime']['output'];
  4032. };
  4033. export type ProductOptionGroupTranslationInput = {
  4034. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4035. id?: InputMaybe<Scalars['ID']['input']>;
  4036. languageCode: LanguageCode;
  4037. name?: InputMaybe<Scalars['String']['input']>;
  4038. };
  4039. export type ProductOptionInUseError = ErrorResult & {
  4040. __typename?: 'ProductOptionInUseError';
  4041. errorCode: ErrorCode;
  4042. message: Scalars['String']['output'];
  4043. optionGroupCode: Scalars['String']['output'];
  4044. productVariantCount: Scalars['Int']['output'];
  4045. };
  4046. export type ProductOptionTranslation = {
  4047. __typename?: 'ProductOptionTranslation';
  4048. createdAt: Scalars['DateTime']['output'];
  4049. id: Scalars['ID']['output'];
  4050. languageCode: LanguageCode;
  4051. name: Scalars['String']['output'];
  4052. updatedAt: Scalars['DateTime']['output'];
  4053. };
  4054. export type ProductOptionTranslationInput = {
  4055. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4056. id?: InputMaybe<Scalars['ID']['input']>;
  4057. languageCode: LanguageCode;
  4058. name?: InputMaybe<Scalars['String']['input']>;
  4059. };
  4060. export type ProductSortParameter = {
  4061. createdAt?: InputMaybe<SortOrder>;
  4062. description?: InputMaybe<SortOrder>;
  4063. id?: InputMaybe<SortOrder>;
  4064. name?: InputMaybe<SortOrder>;
  4065. slug?: InputMaybe<SortOrder>;
  4066. updatedAt?: InputMaybe<SortOrder>;
  4067. };
  4068. export type ProductTranslation = {
  4069. __typename?: 'ProductTranslation';
  4070. createdAt: Scalars['DateTime']['output'];
  4071. description: Scalars['String']['output'];
  4072. id: Scalars['ID']['output'];
  4073. languageCode: LanguageCode;
  4074. name: Scalars['String']['output'];
  4075. slug: Scalars['String']['output'];
  4076. updatedAt: Scalars['DateTime']['output'];
  4077. };
  4078. export type ProductTranslationInput = {
  4079. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4080. description?: InputMaybe<Scalars['String']['input']>;
  4081. id?: InputMaybe<Scalars['ID']['input']>;
  4082. languageCode: LanguageCode;
  4083. name?: InputMaybe<Scalars['String']['input']>;
  4084. slug?: InputMaybe<Scalars['String']['input']>;
  4085. };
  4086. export type ProductVariant = Node & {
  4087. __typename?: 'ProductVariant';
  4088. assets: Array<Asset>;
  4089. channels: Array<Channel>;
  4090. createdAt: Scalars['DateTime']['output'];
  4091. currencyCode: CurrencyCode;
  4092. customFields?: Maybe<Scalars['JSON']['output']>;
  4093. enabled: Scalars['Boolean']['output'];
  4094. facetValues: Array<FacetValue>;
  4095. featuredAsset?: Maybe<Asset>;
  4096. id: Scalars['ID']['output'];
  4097. languageCode: LanguageCode;
  4098. name: Scalars['String']['output'];
  4099. options: Array<ProductOption>;
  4100. outOfStockThreshold: Scalars['Int']['output'];
  4101. price: Scalars['Money']['output'];
  4102. priceWithTax: Scalars['Money']['output'];
  4103. prices: Array<ProductVariantPrice>;
  4104. product: Product;
  4105. productId: Scalars['ID']['output'];
  4106. sku: Scalars['String']['output'];
  4107. /** @deprecated use stockLevels */
  4108. stockAllocated: Scalars['Int']['output'];
  4109. stockLevel: Scalars['String']['output'];
  4110. stockLevels: Array<StockLevel>;
  4111. stockMovements: StockMovementList;
  4112. /** @deprecated use stockLevels */
  4113. stockOnHand: Scalars['Int']['output'];
  4114. taxCategory: TaxCategory;
  4115. taxRateApplied: TaxRate;
  4116. trackInventory: GlobalFlag;
  4117. translations: Array<ProductVariantTranslation>;
  4118. updatedAt: Scalars['DateTime']['output'];
  4119. useGlobalOutOfStockThreshold: Scalars['Boolean']['output'];
  4120. };
  4121. export type ProductVariantStockMovementsArgs = {
  4122. options?: InputMaybe<StockMovementListOptions>;
  4123. };
  4124. export type ProductVariantFilterParameter = {
  4125. _and?: InputMaybe<Array<ProductVariantFilterParameter>>;
  4126. _or?: InputMaybe<Array<ProductVariantFilterParameter>>;
  4127. createdAt?: InputMaybe<DateOperators>;
  4128. currencyCode?: InputMaybe<StringOperators>;
  4129. enabled?: InputMaybe<BooleanOperators>;
  4130. facetValueId?: InputMaybe<IdOperators>;
  4131. id?: InputMaybe<IdOperators>;
  4132. languageCode?: InputMaybe<StringOperators>;
  4133. name?: InputMaybe<StringOperators>;
  4134. outOfStockThreshold?: InputMaybe<NumberOperators>;
  4135. price?: InputMaybe<NumberOperators>;
  4136. priceWithTax?: InputMaybe<NumberOperators>;
  4137. productId?: InputMaybe<IdOperators>;
  4138. sku?: InputMaybe<StringOperators>;
  4139. stockAllocated?: InputMaybe<NumberOperators>;
  4140. stockLevel?: InputMaybe<StringOperators>;
  4141. stockOnHand?: InputMaybe<NumberOperators>;
  4142. trackInventory?: InputMaybe<StringOperators>;
  4143. updatedAt?: InputMaybe<DateOperators>;
  4144. useGlobalOutOfStockThreshold?: InputMaybe<BooleanOperators>;
  4145. };
  4146. export type ProductVariantList = PaginatedList & {
  4147. __typename?: 'ProductVariantList';
  4148. items: Array<ProductVariant>;
  4149. totalItems: Scalars['Int']['output'];
  4150. };
  4151. export type ProductVariantListOptions = {
  4152. /** Allows the results to be filtered */
  4153. filter?: InputMaybe<ProductVariantFilterParameter>;
  4154. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4155. filterOperator?: InputMaybe<LogicalOperator>;
  4156. /** Skips the first n results, for use in pagination */
  4157. skip?: InputMaybe<Scalars['Int']['input']>;
  4158. /** Specifies which properties to sort the results by */
  4159. sort?: InputMaybe<ProductVariantSortParameter>;
  4160. /** Takes n results, for use in pagination */
  4161. take?: InputMaybe<Scalars['Int']['input']>;
  4162. };
  4163. export type ProductVariantPrice = {
  4164. __typename?: 'ProductVariantPrice';
  4165. currencyCode: CurrencyCode;
  4166. customFields?: Maybe<Scalars['JSON']['output']>;
  4167. price: Scalars['Money']['output'];
  4168. };
  4169. /**
  4170. * Used to set up update the price of a ProductVariant in a particular Channel.
  4171. * If the `delete` flag is `true`, the price will be deleted for the given Channel.
  4172. */
  4173. export type ProductVariantPriceInput = {
  4174. currencyCode: CurrencyCode;
  4175. delete?: InputMaybe<Scalars['Boolean']['input']>;
  4176. price: Scalars['Money']['input'];
  4177. };
  4178. export type ProductVariantSortParameter = {
  4179. createdAt?: InputMaybe<SortOrder>;
  4180. id?: InputMaybe<SortOrder>;
  4181. name?: InputMaybe<SortOrder>;
  4182. outOfStockThreshold?: InputMaybe<SortOrder>;
  4183. price?: InputMaybe<SortOrder>;
  4184. priceWithTax?: InputMaybe<SortOrder>;
  4185. productId?: InputMaybe<SortOrder>;
  4186. sku?: InputMaybe<SortOrder>;
  4187. stockAllocated?: InputMaybe<SortOrder>;
  4188. stockLevel?: InputMaybe<SortOrder>;
  4189. stockOnHand?: InputMaybe<SortOrder>;
  4190. updatedAt?: InputMaybe<SortOrder>;
  4191. };
  4192. export type ProductVariantTranslation = {
  4193. __typename?: 'ProductVariantTranslation';
  4194. createdAt: Scalars['DateTime']['output'];
  4195. id: Scalars['ID']['output'];
  4196. languageCode: LanguageCode;
  4197. name: Scalars['String']['output'];
  4198. updatedAt: Scalars['DateTime']['output'];
  4199. };
  4200. export type ProductVariantTranslationInput = {
  4201. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4202. id?: InputMaybe<Scalars['ID']['input']>;
  4203. languageCode: LanguageCode;
  4204. name?: InputMaybe<Scalars['String']['input']>;
  4205. };
  4206. export type Promotion = Node & {
  4207. __typename?: 'Promotion';
  4208. actions: Array<ConfigurableOperation>;
  4209. conditions: Array<ConfigurableOperation>;
  4210. couponCode?: Maybe<Scalars['String']['output']>;
  4211. createdAt: Scalars['DateTime']['output'];
  4212. customFields?: Maybe<Scalars['JSON']['output']>;
  4213. description: Scalars['String']['output'];
  4214. enabled: Scalars['Boolean']['output'];
  4215. endsAt?: Maybe<Scalars['DateTime']['output']>;
  4216. id: Scalars['ID']['output'];
  4217. name: Scalars['String']['output'];
  4218. perCustomerUsageLimit?: Maybe<Scalars['Int']['output']>;
  4219. startsAt?: Maybe<Scalars['DateTime']['output']>;
  4220. translations: Array<PromotionTranslation>;
  4221. updatedAt: Scalars['DateTime']['output'];
  4222. usageLimit?: Maybe<Scalars['Int']['output']>;
  4223. };
  4224. export type PromotionFilterParameter = {
  4225. _and?: InputMaybe<Array<PromotionFilterParameter>>;
  4226. _or?: InputMaybe<Array<PromotionFilterParameter>>;
  4227. couponCode?: InputMaybe<StringOperators>;
  4228. createdAt?: InputMaybe<DateOperators>;
  4229. description?: InputMaybe<StringOperators>;
  4230. enabled?: InputMaybe<BooleanOperators>;
  4231. endsAt?: InputMaybe<DateOperators>;
  4232. id?: InputMaybe<IdOperators>;
  4233. name?: InputMaybe<StringOperators>;
  4234. perCustomerUsageLimit?: InputMaybe<NumberOperators>;
  4235. startsAt?: InputMaybe<DateOperators>;
  4236. updatedAt?: InputMaybe<DateOperators>;
  4237. usageLimit?: InputMaybe<NumberOperators>;
  4238. };
  4239. export type PromotionList = PaginatedList & {
  4240. __typename?: 'PromotionList';
  4241. items: Array<Promotion>;
  4242. totalItems: Scalars['Int']['output'];
  4243. };
  4244. export type PromotionListOptions = {
  4245. /** Allows the results to be filtered */
  4246. filter?: InputMaybe<PromotionFilterParameter>;
  4247. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4248. filterOperator?: InputMaybe<LogicalOperator>;
  4249. /** Skips the first n results, for use in pagination */
  4250. skip?: InputMaybe<Scalars['Int']['input']>;
  4251. /** Specifies which properties to sort the results by */
  4252. sort?: InputMaybe<PromotionSortParameter>;
  4253. /** Takes n results, for use in pagination */
  4254. take?: InputMaybe<Scalars['Int']['input']>;
  4255. };
  4256. export type PromotionSortParameter = {
  4257. couponCode?: InputMaybe<SortOrder>;
  4258. createdAt?: InputMaybe<SortOrder>;
  4259. description?: InputMaybe<SortOrder>;
  4260. endsAt?: InputMaybe<SortOrder>;
  4261. id?: InputMaybe<SortOrder>;
  4262. name?: InputMaybe<SortOrder>;
  4263. perCustomerUsageLimit?: InputMaybe<SortOrder>;
  4264. startsAt?: InputMaybe<SortOrder>;
  4265. updatedAt?: InputMaybe<SortOrder>;
  4266. usageLimit?: InputMaybe<SortOrder>;
  4267. };
  4268. export type PromotionTranslation = {
  4269. __typename?: 'PromotionTranslation';
  4270. createdAt: Scalars['DateTime']['output'];
  4271. description: Scalars['String']['output'];
  4272. id: Scalars['ID']['output'];
  4273. languageCode: LanguageCode;
  4274. name: Scalars['String']['output'];
  4275. updatedAt: Scalars['DateTime']['output'];
  4276. };
  4277. export type PromotionTranslationInput = {
  4278. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4279. description?: InputMaybe<Scalars['String']['input']>;
  4280. id?: InputMaybe<Scalars['ID']['input']>;
  4281. languageCode: LanguageCode;
  4282. name?: InputMaybe<Scalars['String']['input']>;
  4283. };
  4284. export type Province = Node & Region & {
  4285. __typename?: 'Province';
  4286. code: Scalars['String']['output'];
  4287. createdAt: Scalars['DateTime']['output'];
  4288. customFields?: Maybe<Scalars['JSON']['output']>;
  4289. enabled: Scalars['Boolean']['output'];
  4290. id: Scalars['ID']['output'];
  4291. languageCode: LanguageCode;
  4292. name: Scalars['String']['output'];
  4293. parent?: Maybe<Region>;
  4294. parentId?: Maybe<Scalars['ID']['output']>;
  4295. translations: Array<RegionTranslation>;
  4296. type: Scalars['String']['output'];
  4297. updatedAt: Scalars['DateTime']['output'];
  4298. };
  4299. export type ProvinceFilterParameter = {
  4300. _and?: InputMaybe<Array<ProvinceFilterParameter>>;
  4301. _or?: InputMaybe<Array<ProvinceFilterParameter>>;
  4302. code?: InputMaybe<StringOperators>;
  4303. createdAt?: InputMaybe<DateOperators>;
  4304. enabled?: InputMaybe<BooleanOperators>;
  4305. id?: InputMaybe<IdOperators>;
  4306. languageCode?: InputMaybe<StringOperators>;
  4307. name?: InputMaybe<StringOperators>;
  4308. parentId?: InputMaybe<IdOperators>;
  4309. type?: InputMaybe<StringOperators>;
  4310. updatedAt?: InputMaybe<DateOperators>;
  4311. };
  4312. export type ProvinceList = PaginatedList & {
  4313. __typename?: 'ProvinceList';
  4314. items: Array<Province>;
  4315. totalItems: Scalars['Int']['output'];
  4316. };
  4317. export type ProvinceListOptions = {
  4318. /** Allows the results to be filtered */
  4319. filter?: InputMaybe<ProvinceFilterParameter>;
  4320. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4321. filterOperator?: InputMaybe<LogicalOperator>;
  4322. /** Skips the first n results, for use in pagination */
  4323. skip?: InputMaybe<Scalars['Int']['input']>;
  4324. /** Specifies which properties to sort the results by */
  4325. sort?: InputMaybe<ProvinceSortParameter>;
  4326. /** Takes n results, for use in pagination */
  4327. take?: InputMaybe<Scalars['Int']['input']>;
  4328. };
  4329. export type ProvinceSortParameter = {
  4330. code?: InputMaybe<SortOrder>;
  4331. createdAt?: InputMaybe<SortOrder>;
  4332. id?: InputMaybe<SortOrder>;
  4333. name?: InputMaybe<SortOrder>;
  4334. parentId?: InputMaybe<SortOrder>;
  4335. type?: InputMaybe<SortOrder>;
  4336. updatedAt?: InputMaybe<SortOrder>;
  4337. };
  4338. export type ProvinceTranslationInput = {
  4339. customFields?: InputMaybe<Scalars['JSON']['input']>;
  4340. id?: InputMaybe<Scalars['ID']['input']>;
  4341. languageCode: LanguageCode;
  4342. name?: InputMaybe<Scalars['String']['input']>;
  4343. };
  4344. /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
  4345. export type QuantityTooGreatError = ErrorResult & {
  4346. __typename?: 'QuantityTooGreatError';
  4347. errorCode: ErrorCode;
  4348. message: Scalars['String']['output'];
  4349. };
  4350. export type Query = {
  4351. __typename?: 'Query';
  4352. activeAdministrator?: Maybe<Administrator>;
  4353. activeChannel: Channel;
  4354. administrator?: Maybe<Administrator>;
  4355. administrators: AdministratorList;
  4356. /** Get a single Asset by id */
  4357. asset?: Maybe<Asset>;
  4358. /** Get a list of Assets */
  4359. assets: AssetList;
  4360. channel?: Maybe<Channel>;
  4361. channels: ChannelList;
  4362. /** Get a Collection either by id or slug. If neither id nor slug is specified, an error will result. */
  4363. collection?: Maybe<Collection>;
  4364. collectionFilters: Array<ConfigurableOperationDefinition>;
  4365. collections: CollectionList;
  4366. countries: CountryList;
  4367. country?: Maybe<Country>;
  4368. customer?: Maybe<Customer>;
  4369. customerGroup?: Maybe<CustomerGroup>;
  4370. customerGroups: CustomerGroupList;
  4371. customers: CustomerList;
  4372. /** Returns a list of eligible shipping methods for the draft Order */
  4373. eligibleShippingMethodsForDraftOrder: Array<ShippingMethodQuote>;
  4374. entityDuplicators: Array<EntityDuplicatorDefinition>;
  4375. facet?: Maybe<Facet>;
  4376. facetValues: FacetValueList;
  4377. facets: FacetList;
  4378. fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
  4379. globalSettings: GlobalSettings;
  4380. job?: Maybe<Job>;
  4381. jobBufferSize: Array<JobBufferSize>;
  4382. jobQueues: Array<JobQueue>;
  4383. jobs: JobList;
  4384. jobsById: Array<Job>;
  4385. me?: Maybe<CurrentUser>;
  4386. /** Get metrics for the given interval and metric types. */
  4387. metricSummary: Array<MetricSummary>;
  4388. order?: Maybe<Order>;
  4389. orders: OrderList;
  4390. paymentMethod?: Maybe<PaymentMethod>;
  4391. paymentMethodEligibilityCheckers: Array<ConfigurableOperationDefinition>;
  4392. paymentMethodHandlers: Array<ConfigurableOperationDefinition>;
  4393. paymentMethods: PaymentMethodList;
  4394. pendingSearchIndexUpdates: Scalars['Int']['output'];
  4395. /** Used for real-time previews of the contents of a Collection */
  4396. previewCollectionVariants: ProductVariantList;
  4397. /** Get a Product either by id or slug. If neither id nor slug is specified, an error will result. */
  4398. product?: Maybe<Product>;
  4399. productOptionGroup?: Maybe<ProductOptionGroup>;
  4400. productOptionGroups: Array<ProductOptionGroup>;
  4401. /** Get a ProductVariant by id */
  4402. productVariant?: Maybe<ProductVariant>;
  4403. /** List ProductVariants either all or for the specific product. */
  4404. productVariants: ProductVariantList;
  4405. /** List Products */
  4406. products: ProductList;
  4407. promotion?: Maybe<Promotion>;
  4408. promotionActions: Array<ConfigurableOperationDefinition>;
  4409. promotionConditions: Array<ConfigurableOperationDefinition>;
  4410. promotions: PromotionList;
  4411. province?: Maybe<Province>;
  4412. provinces: ProvinceList;
  4413. role?: Maybe<Role>;
  4414. roles: RoleList;
  4415. search: SearchResponse;
  4416. seller?: Maybe<Seller>;
  4417. sellers: SellerList;
  4418. shippingCalculators: Array<ConfigurableOperationDefinition>;
  4419. shippingEligibilityCheckers: Array<ConfigurableOperationDefinition>;
  4420. shippingMethod?: Maybe<ShippingMethod>;
  4421. shippingMethods: ShippingMethodList;
  4422. stockLocation?: Maybe<StockLocation>;
  4423. stockLocations: StockLocationList;
  4424. tag: Tag;
  4425. tags: TagList;
  4426. taxCategories: TaxCategoryList;
  4427. taxCategory?: Maybe<TaxCategory>;
  4428. taxRate?: Maybe<TaxRate>;
  4429. taxRates: TaxRateList;
  4430. testEligibleShippingMethods: Array<ShippingMethodQuote>;
  4431. testShippingMethod: TestShippingMethodResult;
  4432. zone?: Maybe<Zone>;
  4433. zones: ZoneList;
  4434. };
  4435. export type QueryAdministratorArgs = {
  4436. id: Scalars['ID']['input'];
  4437. };
  4438. export type QueryAdministratorsArgs = {
  4439. options?: InputMaybe<AdministratorListOptions>;
  4440. };
  4441. export type QueryAssetArgs = {
  4442. id: Scalars['ID']['input'];
  4443. };
  4444. export type QueryAssetsArgs = {
  4445. options?: InputMaybe<AssetListOptions>;
  4446. };
  4447. export type QueryChannelArgs = {
  4448. id: Scalars['ID']['input'];
  4449. };
  4450. export type QueryChannelsArgs = {
  4451. options?: InputMaybe<ChannelListOptions>;
  4452. };
  4453. export type QueryCollectionArgs = {
  4454. id?: InputMaybe<Scalars['ID']['input']>;
  4455. slug?: InputMaybe<Scalars['String']['input']>;
  4456. };
  4457. export type QueryCollectionsArgs = {
  4458. options?: InputMaybe<CollectionListOptions>;
  4459. };
  4460. export type QueryCountriesArgs = {
  4461. options?: InputMaybe<CountryListOptions>;
  4462. };
  4463. export type QueryCountryArgs = {
  4464. id: Scalars['ID']['input'];
  4465. };
  4466. export type QueryCustomerArgs = {
  4467. id: Scalars['ID']['input'];
  4468. };
  4469. export type QueryCustomerGroupArgs = {
  4470. id: Scalars['ID']['input'];
  4471. };
  4472. export type QueryCustomerGroupsArgs = {
  4473. options?: InputMaybe<CustomerGroupListOptions>;
  4474. };
  4475. export type QueryCustomersArgs = {
  4476. options?: InputMaybe<CustomerListOptions>;
  4477. };
  4478. export type QueryEligibleShippingMethodsForDraftOrderArgs = {
  4479. orderId: Scalars['ID']['input'];
  4480. };
  4481. export type QueryFacetArgs = {
  4482. id: Scalars['ID']['input'];
  4483. };
  4484. export type QueryFacetValuesArgs = {
  4485. options?: InputMaybe<FacetValueListOptions>;
  4486. };
  4487. export type QueryFacetsArgs = {
  4488. options?: InputMaybe<FacetListOptions>;
  4489. };
  4490. export type QueryJobArgs = {
  4491. jobId: Scalars['ID']['input'];
  4492. };
  4493. export type QueryJobBufferSizeArgs = {
  4494. bufferIds?: InputMaybe<Array<Scalars['String']['input']>>;
  4495. };
  4496. export type QueryJobsArgs = {
  4497. options?: InputMaybe<JobListOptions>;
  4498. };
  4499. export type QueryJobsByIdArgs = {
  4500. jobIds: Array<Scalars['ID']['input']>;
  4501. };
  4502. export type QueryMetricSummaryArgs = {
  4503. input?: InputMaybe<MetricSummaryInput>;
  4504. };
  4505. export type QueryOrderArgs = {
  4506. id: Scalars['ID']['input'];
  4507. };
  4508. export type QueryOrdersArgs = {
  4509. options?: InputMaybe<OrderListOptions>;
  4510. };
  4511. export type QueryPaymentMethodArgs = {
  4512. id: Scalars['ID']['input'];
  4513. };
  4514. export type QueryPaymentMethodsArgs = {
  4515. options?: InputMaybe<PaymentMethodListOptions>;
  4516. };
  4517. export type QueryPreviewCollectionVariantsArgs = {
  4518. input: PreviewCollectionVariantsInput;
  4519. options?: InputMaybe<ProductVariantListOptions>;
  4520. };
  4521. export type QueryProductArgs = {
  4522. id?: InputMaybe<Scalars['ID']['input']>;
  4523. slug?: InputMaybe<Scalars['String']['input']>;
  4524. };
  4525. export type QueryProductOptionGroupArgs = {
  4526. id: Scalars['ID']['input'];
  4527. };
  4528. export type QueryProductOptionGroupsArgs = {
  4529. filterTerm?: InputMaybe<Scalars['String']['input']>;
  4530. };
  4531. export type QueryProductVariantArgs = {
  4532. id: Scalars['ID']['input'];
  4533. };
  4534. export type QueryProductVariantsArgs = {
  4535. options?: InputMaybe<ProductVariantListOptions>;
  4536. productId?: InputMaybe<Scalars['ID']['input']>;
  4537. };
  4538. export type QueryProductsArgs = {
  4539. options?: InputMaybe<ProductListOptions>;
  4540. };
  4541. export type QueryPromotionArgs = {
  4542. id: Scalars['ID']['input'];
  4543. };
  4544. export type QueryPromotionsArgs = {
  4545. options?: InputMaybe<PromotionListOptions>;
  4546. };
  4547. export type QueryProvinceArgs = {
  4548. id: Scalars['ID']['input'];
  4549. };
  4550. export type QueryProvincesArgs = {
  4551. options?: InputMaybe<ProvinceListOptions>;
  4552. };
  4553. export type QueryRoleArgs = {
  4554. id: Scalars['ID']['input'];
  4555. };
  4556. export type QueryRolesArgs = {
  4557. options?: InputMaybe<RoleListOptions>;
  4558. };
  4559. export type QuerySearchArgs = {
  4560. input: SearchInput;
  4561. };
  4562. export type QuerySellerArgs = {
  4563. id: Scalars['ID']['input'];
  4564. };
  4565. export type QuerySellersArgs = {
  4566. options?: InputMaybe<SellerListOptions>;
  4567. };
  4568. export type QueryShippingMethodArgs = {
  4569. id: Scalars['ID']['input'];
  4570. };
  4571. export type QueryShippingMethodsArgs = {
  4572. options?: InputMaybe<ShippingMethodListOptions>;
  4573. };
  4574. export type QueryStockLocationArgs = {
  4575. id: Scalars['ID']['input'];
  4576. };
  4577. export type QueryStockLocationsArgs = {
  4578. options?: InputMaybe<StockLocationListOptions>;
  4579. };
  4580. export type QueryTagArgs = {
  4581. id: Scalars['ID']['input'];
  4582. };
  4583. export type QueryTagsArgs = {
  4584. options?: InputMaybe<TagListOptions>;
  4585. };
  4586. export type QueryTaxCategoriesArgs = {
  4587. options?: InputMaybe<TaxCategoryListOptions>;
  4588. };
  4589. export type QueryTaxCategoryArgs = {
  4590. id: Scalars['ID']['input'];
  4591. };
  4592. export type QueryTaxRateArgs = {
  4593. id: Scalars['ID']['input'];
  4594. };
  4595. export type QueryTaxRatesArgs = {
  4596. options?: InputMaybe<TaxRateListOptions>;
  4597. };
  4598. export type QueryTestEligibleShippingMethodsArgs = {
  4599. input: TestEligibleShippingMethodsInput;
  4600. };
  4601. export type QueryTestShippingMethodArgs = {
  4602. input: TestShippingMethodInput;
  4603. };
  4604. export type QueryZoneArgs = {
  4605. id: Scalars['ID']['input'];
  4606. };
  4607. export type QueryZonesArgs = {
  4608. options?: InputMaybe<ZoneListOptions>;
  4609. };
  4610. export type Refund = Node & {
  4611. __typename?: 'Refund';
  4612. adjustment: Scalars['Money']['output'];
  4613. createdAt: Scalars['DateTime']['output'];
  4614. id: Scalars['ID']['output'];
  4615. items: Scalars['Money']['output'];
  4616. lines: Array<RefundLine>;
  4617. metadata?: Maybe<Scalars['JSON']['output']>;
  4618. method?: Maybe<Scalars['String']['output']>;
  4619. paymentId: Scalars['ID']['output'];
  4620. reason?: Maybe<Scalars['String']['output']>;
  4621. shipping: Scalars['Money']['output'];
  4622. state: Scalars['String']['output'];
  4623. total: Scalars['Money']['output'];
  4624. transactionId?: Maybe<Scalars['String']['output']>;
  4625. updatedAt: Scalars['DateTime']['output'];
  4626. };
  4627. /** Returned if `amount` is greater than the maximum un-refunded amount of the Payment */
  4628. export type RefundAmountError = ErrorResult & {
  4629. __typename?: 'RefundAmountError';
  4630. errorCode: ErrorCode;
  4631. maximumRefundable: Scalars['Int']['output'];
  4632. message: Scalars['String']['output'];
  4633. };
  4634. export type RefundLine = {
  4635. __typename?: 'RefundLine';
  4636. orderLine: OrderLine;
  4637. orderLineId: Scalars['ID']['output'];
  4638. quantity: Scalars['Int']['output'];
  4639. refund: Refund;
  4640. refundId: Scalars['ID']['output'];
  4641. };
  4642. export type RefundOrderInput = {
  4643. adjustment: Scalars['Money']['input'];
  4644. /**
  4645. * If an amount is specified, this value will be used to create a Refund rather than calculating the
  4646. * amount automatically. This was added in v2.2 and will be the preferred way to specify the refund
  4647. * amount in the future. The `lines`, `shipping` and `adjustment` fields will likely be removed in a future
  4648. * version.
  4649. */
  4650. amount?: InputMaybe<Scalars['Money']['input']>;
  4651. lines: Array<OrderLineInput>;
  4652. paymentId: Scalars['ID']['input'];
  4653. reason?: InputMaybe<Scalars['String']['input']>;
  4654. shipping: Scalars['Money']['input'];
  4655. };
  4656. export type RefundOrderResult = AlreadyRefundedError | MultipleOrderError | NothingToRefundError | OrderStateTransitionError | PaymentOrderMismatchError | QuantityTooGreatError | Refund | RefundAmountError | RefundOrderStateError | RefundStateTransitionError;
  4657. /** Returned if an attempting to refund an Order which is not in the expected state */
  4658. export type RefundOrderStateError = ErrorResult & {
  4659. __typename?: 'RefundOrderStateError';
  4660. errorCode: ErrorCode;
  4661. message: Scalars['String']['output'];
  4662. orderState: Scalars['String']['output'];
  4663. };
  4664. /**
  4665. * Returned when a call to modifyOrder fails to include a refundPaymentId even
  4666. * though the price has decreased as a result of the changes.
  4667. */
  4668. export type RefundPaymentIdMissingError = ErrorResult & {
  4669. __typename?: 'RefundPaymentIdMissingError';
  4670. errorCode: ErrorCode;
  4671. message: Scalars['String']['output'];
  4672. };
  4673. /** Returned when there is an error in transitioning the Refund state */
  4674. export type RefundStateTransitionError = ErrorResult & {
  4675. __typename?: 'RefundStateTransitionError';
  4676. errorCode: ErrorCode;
  4677. fromState: Scalars['String']['output'];
  4678. message: Scalars['String']['output'];
  4679. toState: Scalars['String']['output'];
  4680. transitionError: Scalars['String']['output'];
  4681. };
  4682. export type Region = {
  4683. code: Scalars['String']['output'];
  4684. createdAt: Scalars['DateTime']['output'];
  4685. enabled: Scalars['Boolean']['output'];
  4686. id: Scalars['ID']['output'];
  4687. languageCode: LanguageCode;
  4688. name: Scalars['String']['output'];
  4689. parent?: Maybe<Region>;
  4690. parentId?: Maybe<Scalars['ID']['output']>;
  4691. translations: Array<RegionTranslation>;
  4692. type: Scalars['String']['output'];
  4693. updatedAt: Scalars['DateTime']['output'];
  4694. };
  4695. export type RegionTranslation = {
  4696. __typename?: 'RegionTranslation';
  4697. createdAt: Scalars['DateTime']['output'];
  4698. id: Scalars['ID']['output'];
  4699. languageCode: LanguageCode;
  4700. name: Scalars['String']['output'];
  4701. updatedAt: Scalars['DateTime']['output'];
  4702. };
  4703. export type RelationCustomFieldConfig = CustomField & {
  4704. __typename?: 'RelationCustomFieldConfig';
  4705. description?: Maybe<Array<LocalizedString>>;
  4706. entity: Scalars['String']['output'];
  4707. internal?: Maybe<Scalars['Boolean']['output']>;
  4708. label?: Maybe<Array<LocalizedString>>;
  4709. list: Scalars['Boolean']['output'];
  4710. name: Scalars['String']['output'];
  4711. nullable?: Maybe<Scalars['Boolean']['output']>;
  4712. readonly?: Maybe<Scalars['Boolean']['output']>;
  4713. requiresPermission?: Maybe<Array<Permission>>;
  4714. scalarFields: Array<Scalars['String']['output']>;
  4715. type: Scalars['String']['output'];
  4716. ui?: Maybe<Scalars['JSON']['output']>;
  4717. };
  4718. export type Release = Node & StockMovement & {
  4719. __typename?: 'Release';
  4720. createdAt: Scalars['DateTime']['output'];
  4721. id: Scalars['ID']['output'];
  4722. productVariant: ProductVariant;
  4723. quantity: Scalars['Int']['output'];
  4724. type: StockMovementType;
  4725. updatedAt: Scalars['DateTime']['output'];
  4726. };
  4727. export type RemoveCollectionsFromChannelInput = {
  4728. channelId: Scalars['ID']['input'];
  4729. collectionIds: Array<Scalars['ID']['input']>;
  4730. };
  4731. export type RemoveFacetFromChannelResult = Facet | FacetInUseError;
  4732. export type RemoveFacetsFromChannelInput = {
  4733. channelId: Scalars['ID']['input'];
  4734. facetIds: Array<Scalars['ID']['input']>;
  4735. force?: InputMaybe<Scalars['Boolean']['input']>;
  4736. };
  4737. export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
  4738. export type RemoveOrderItemsResult = Order | OrderModificationError;
  4739. export type RemovePaymentMethodsFromChannelInput = {
  4740. channelId: Scalars['ID']['input'];
  4741. paymentMethodIds: Array<Scalars['ID']['input']>;
  4742. };
  4743. export type RemoveProductVariantsFromChannelInput = {
  4744. channelId: Scalars['ID']['input'];
  4745. productVariantIds: Array<Scalars['ID']['input']>;
  4746. };
  4747. export type RemoveProductsFromChannelInput = {
  4748. channelId: Scalars['ID']['input'];
  4749. productIds: Array<Scalars['ID']['input']>;
  4750. };
  4751. export type RemovePromotionsFromChannelInput = {
  4752. channelId: Scalars['ID']['input'];
  4753. promotionIds: Array<Scalars['ID']['input']>;
  4754. };
  4755. export type RemoveShippingMethodsFromChannelInput = {
  4756. channelId: Scalars['ID']['input'];
  4757. shippingMethodIds: Array<Scalars['ID']['input']>;
  4758. };
  4759. export type RemoveStockLocationsFromChannelInput = {
  4760. channelId: Scalars['ID']['input'];
  4761. stockLocationIds: Array<Scalars['ID']['input']>;
  4762. };
  4763. export type Return = Node & StockMovement & {
  4764. __typename?: 'Return';
  4765. createdAt: Scalars['DateTime']['output'];
  4766. id: Scalars['ID']['output'];
  4767. productVariant: ProductVariant;
  4768. quantity: Scalars['Int']['output'];
  4769. type: StockMovementType;
  4770. updatedAt: Scalars['DateTime']['output'];
  4771. };
  4772. export type Role = Node & {
  4773. __typename?: 'Role';
  4774. channels: Array<Channel>;
  4775. code: Scalars['String']['output'];
  4776. createdAt: Scalars['DateTime']['output'];
  4777. description: Scalars['String']['output'];
  4778. id: Scalars['ID']['output'];
  4779. permissions: Array<Permission>;
  4780. updatedAt: Scalars['DateTime']['output'];
  4781. };
  4782. export type RoleFilterParameter = {
  4783. _and?: InputMaybe<Array<RoleFilterParameter>>;
  4784. _or?: InputMaybe<Array<RoleFilterParameter>>;
  4785. code?: InputMaybe<StringOperators>;
  4786. createdAt?: InputMaybe<DateOperators>;
  4787. description?: InputMaybe<StringOperators>;
  4788. id?: InputMaybe<IdOperators>;
  4789. updatedAt?: InputMaybe<DateOperators>;
  4790. };
  4791. export type RoleList = PaginatedList & {
  4792. __typename?: 'RoleList';
  4793. items: Array<Role>;
  4794. totalItems: Scalars['Int']['output'];
  4795. };
  4796. export type RoleListOptions = {
  4797. /** Allows the results to be filtered */
  4798. filter?: InputMaybe<RoleFilterParameter>;
  4799. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4800. filterOperator?: InputMaybe<LogicalOperator>;
  4801. /** Skips the first n results, for use in pagination */
  4802. skip?: InputMaybe<Scalars['Int']['input']>;
  4803. /** Specifies which properties to sort the results by */
  4804. sort?: InputMaybe<RoleSortParameter>;
  4805. /** Takes n results, for use in pagination */
  4806. take?: InputMaybe<Scalars['Int']['input']>;
  4807. };
  4808. export type RoleSortParameter = {
  4809. code?: InputMaybe<SortOrder>;
  4810. createdAt?: InputMaybe<SortOrder>;
  4811. description?: InputMaybe<SortOrder>;
  4812. id?: InputMaybe<SortOrder>;
  4813. updatedAt?: InputMaybe<SortOrder>;
  4814. };
  4815. export type Sale = Node & StockMovement & {
  4816. __typename?: 'Sale';
  4817. createdAt: Scalars['DateTime']['output'];
  4818. id: Scalars['ID']['output'];
  4819. productVariant: ProductVariant;
  4820. quantity: Scalars['Int']['output'];
  4821. type: StockMovementType;
  4822. updatedAt: Scalars['DateTime']['output'];
  4823. };
  4824. export type SearchInput = {
  4825. collectionId?: InputMaybe<Scalars['ID']['input']>;
  4826. collectionSlug?: InputMaybe<Scalars['String']['input']>;
  4827. facetValueFilters?: InputMaybe<Array<FacetValueFilterInput>>;
  4828. /** @deprecated Use `facetValueFilters` instead */
  4829. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  4830. /** @deprecated Use `facetValueFilters` instead */
  4831. facetValueOperator?: InputMaybe<LogicalOperator>;
  4832. groupByProduct?: InputMaybe<Scalars['Boolean']['input']>;
  4833. skip?: InputMaybe<Scalars['Int']['input']>;
  4834. sort?: InputMaybe<SearchResultSortParameter>;
  4835. take?: InputMaybe<Scalars['Int']['input']>;
  4836. term?: InputMaybe<Scalars['String']['input']>;
  4837. };
  4838. export type SearchReindexResponse = {
  4839. __typename?: 'SearchReindexResponse';
  4840. success: Scalars['Boolean']['output'];
  4841. };
  4842. export type SearchResponse = {
  4843. __typename?: 'SearchResponse';
  4844. collections: Array<CollectionResult>;
  4845. facetValues: Array<FacetValueResult>;
  4846. items: Array<SearchResult>;
  4847. totalItems: Scalars['Int']['output'];
  4848. };
  4849. export type SearchResult = {
  4850. __typename?: 'SearchResult';
  4851. /** An array of ids of the Channels in which this result appears */
  4852. channelIds: Array<Scalars['ID']['output']>;
  4853. /** An array of ids of the Collections in which this result appears */
  4854. collectionIds: Array<Scalars['ID']['output']>;
  4855. currencyCode: CurrencyCode;
  4856. description: Scalars['String']['output'];
  4857. enabled: Scalars['Boolean']['output'];
  4858. facetIds: Array<Scalars['ID']['output']>;
  4859. facetValueIds: Array<Scalars['ID']['output']>;
  4860. price: SearchResultPrice;
  4861. priceWithTax: SearchResultPrice;
  4862. productAsset?: Maybe<SearchResultAsset>;
  4863. productId: Scalars['ID']['output'];
  4864. productName: Scalars['String']['output'];
  4865. productVariantAsset?: Maybe<SearchResultAsset>;
  4866. productVariantId: Scalars['ID']['output'];
  4867. productVariantName: Scalars['String']['output'];
  4868. /** A relevance score for the result. Differs between database implementations */
  4869. score: Scalars['Float']['output'];
  4870. sku: Scalars['String']['output'];
  4871. slug: Scalars['String']['output'];
  4872. };
  4873. export type SearchResultAsset = {
  4874. __typename?: 'SearchResultAsset';
  4875. focalPoint?: Maybe<Coordinate>;
  4876. id: Scalars['ID']['output'];
  4877. preview: Scalars['String']['output'];
  4878. };
  4879. /** The price of a search result product, either as a range or as a single price */
  4880. export type SearchResultPrice = PriceRange | SinglePrice;
  4881. export type SearchResultSortParameter = {
  4882. name?: InputMaybe<SortOrder>;
  4883. price?: InputMaybe<SortOrder>;
  4884. };
  4885. export type Seller = Node & {
  4886. __typename?: 'Seller';
  4887. createdAt: Scalars['DateTime']['output'];
  4888. customFields?: Maybe<Scalars['JSON']['output']>;
  4889. id: Scalars['ID']['output'];
  4890. name: Scalars['String']['output'];
  4891. updatedAt: Scalars['DateTime']['output'];
  4892. };
  4893. export type SellerFilterParameter = {
  4894. _and?: InputMaybe<Array<SellerFilterParameter>>;
  4895. _or?: InputMaybe<Array<SellerFilterParameter>>;
  4896. createdAt?: InputMaybe<DateOperators>;
  4897. id?: InputMaybe<IdOperators>;
  4898. name?: InputMaybe<StringOperators>;
  4899. updatedAt?: InputMaybe<DateOperators>;
  4900. };
  4901. export type SellerList = PaginatedList & {
  4902. __typename?: 'SellerList';
  4903. items: Array<Seller>;
  4904. totalItems: Scalars['Int']['output'];
  4905. };
  4906. export type SellerListOptions = {
  4907. /** Allows the results to be filtered */
  4908. filter?: InputMaybe<SellerFilterParameter>;
  4909. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  4910. filterOperator?: InputMaybe<LogicalOperator>;
  4911. /** Skips the first n results, for use in pagination */
  4912. skip?: InputMaybe<Scalars['Int']['input']>;
  4913. /** Specifies which properties to sort the results by */
  4914. sort?: InputMaybe<SellerSortParameter>;
  4915. /** Takes n results, for use in pagination */
  4916. take?: InputMaybe<Scalars['Int']['input']>;
  4917. };
  4918. export type SellerSortParameter = {
  4919. createdAt?: InputMaybe<SortOrder>;
  4920. id?: InputMaybe<SortOrder>;
  4921. name?: InputMaybe<SortOrder>;
  4922. updatedAt?: InputMaybe<SortOrder>;
  4923. };
  4924. export type ServerConfig = {
  4925. __typename?: 'ServerConfig';
  4926. /**
  4927. * This field is deprecated in v2.2 in favor of the entityCustomFields field,
  4928. * which allows custom fields to be defined on user-supplies entities.
  4929. */
  4930. customFieldConfig: CustomFields;
  4931. entityCustomFields: Array<EntityCustomFields>;
  4932. moneyStrategyPrecision: Scalars['Int']['output'];
  4933. orderProcess: Array<OrderProcessState>;
  4934. permissions: Array<PermissionDefinition>;
  4935. permittedAssetTypes: Array<Scalars['String']['output']>;
  4936. };
  4937. export type SetCustomerForDraftOrderResult = EmailAddressConflictError | Order;
  4938. export type SetOrderCustomerInput = {
  4939. customerId: Scalars['ID']['input'];
  4940. note?: InputMaybe<Scalars['String']['input']>;
  4941. orderId: Scalars['ID']['input'];
  4942. };
  4943. export type SetOrderShippingMethodResult = IneligibleShippingMethodError | NoActiveOrderError | Order | OrderModificationError;
  4944. /** Returned if the Payment settlement fails */
  4945. export type SettlePaymentError = ErrorResult & {
  4946. __typename?: 'SettlePaymentError';
  4947. errorCode: ErrorCode;
  4948. message: Scalars['String']['output'];
  4949. paymentErrorMessage: Scalars['String']['output'];
  4950. };
  4951. export type SettlePaymentResult = OrderStateTransitionError | Payment | PaymentStateTransitionError | SettlePaymentError;
  4952. export type SettleRefundInput = {
  4953. id: Scalars['ID']['input'];
  4954. transactionId: Scalars['String']['input'];
  4955. };
  4956. export type SettleRefundResult = Refund | RefundStateTransitionError;
  4957. export type ShippingLine = {
  4958. __typename?: 'ShippingLine';
  4959. discountedPrice: Scalars['Money']['output'];
  4960. discountedPriceWithTax: Scalars['Money']['output'];
  4961. discounts: Array<Discount>;
  4962. id: Scalars['ID']['output'];
  4963. price: Scalars['Money']['output'];
  4964. priceWithTax: Scalars['Money']['output'];
  4965. shippingMethod: ShippingMethod;
  4966. };
  4967. export type ShippingMethod = Node & {
  4968. __typename?: 'ShippingMethod';
  4969. calculator: ConfigurableOperation;
  4970. checker: ConfigurableOperation;
  4971. code: Scalars['String']['output'];
  4972. createdAt: Scalars['DateTime']['output'];
  4973. customFields?: Maybe<Scalars['JSON']['output']>;
  4974. description: Scalars['String']['output'];
  4975. fulfillmentHandlerCode: Scalars['String']['output'];
  4976. id: Scalars['ID']['output'];
  4977. languageCode: LanguageCode;
  4978. name: Scalars['String']['output'];
  4979. translations: Array<ShippingMethodTranslation>;
  4980. updatedAt: Scalars['DateTime']['output'];
  4981. };
  4982. export type ShippingMethodFilterParameter = {
  4983. _and?: InputMaybe<Array<ShippingMethodFilterParameter>>;
  4984. _or?: InputMaybe<Array<ShippingMethodFilterParameter>>;
  4985. code?: InputMaybe<StringOperators>;
  4986. createdAt?: InputMaybe<DateOperators>;
  4987. description?: InputMaybe<StringOperators>;
  4988. fulfillmentHandlerCode?: InputMaybe<StringOperators>;
  4989. id?: InputMaybe<IdOperators>;
  4990. languageCode?: InputMaybe<StringOperators>;
  4991. name?: InputMaybe<StringOperators>;
  4992. updatedAt?: InputMaybe<DateOperators>;
  4993. };
  4994. export type ShippingMethodList = PaginatedList & {
  4995. __typename?: 'ShippingMethodList';
  4996. items: Array<ShippingMethod>;
  4997. totalItems: Scalars['Int']['output'];
  4998. };
  4999. export type ShippingMethodListOptions = {
  5000. /** Allows the results to be filtered */
  5001. filter?: InputMaybe<ShippingMethodFilterParameter>;
  5002. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5003. filterOperator?: InputMaybe<LogicalOperator>;
  5004. /** Skips the first n results, for use in pagination */
  5005. skip?: InputMaybe<Scalars['Int']['input']>;
  5006. /** Specifies which properties to sort the results by */
  5007. sort?: InputMaybe<ShippingMethodSortParameter>;
  5008. /** Takes n results, for use in pagination */
  5009. take?: InputMaybe<Scalars['Int']['input']>;
  5010. };
  5011. export type ShippingMethodQuote = {
  5012. __typename?: 'ShippingMethodQuote';
  5013. code: Scalars['String']['output'];
  5014. customFields?: Maybe<Scalars['JSON']['output']>;
  5015. description: Scalars['String']['output'];
  5016. id: Scalars['ID']['output'];
  5017. /** Any optional metadata returned by the ShippingCalculator in the ShippingCalculationResult */
  5018. metadata?: Maybe<Scalars['JSON']['output']>;
  5019. name: Scalars['String']['output'];
  5020. price: Scalars['Money']['output'];
  5021. priceWithTax: Scalars['Money']['output'];
  5022. };
  5023. export type ShippingMethodSortParameter = {
  5024. code?: InputMaybe<SortOrder>;
  5025. createdAt?: InputMaybe<SortOrder>;
  5026. description?: InputMaybe<SortOrder>;
  5027. fulfillmentHandlerCode?: InputMaybe<SortOrder>;
  5028. id?: InputMaybe<SortOrder>;
  5029. name?: InputMaybe<SortOrder>;
  5030. updatedAt?: InputMaybe<SortOrder>;
  5031. };
  5032. export type ShippingMethodTranslation = {
  5033. __typename?: 'ShippingMethodTranslation';
  5034. createdAt: Scalars['DateTime']['output'];
  5035. description: Scalars['String']['output'];
  5036. id: Scalars['ID']['output'];
  5037. languageCode: LanguageCode;
  5038. name: Scalars['String']['output'];
  5039. updatedAt: Scalars['DateTime']['output'];
  5040. };
  5041. export type ShippingMethodTranslationInput = {
  5042. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5043. description?: InputMaybe<Scalars['String']['input']>;
  5044. id?: InputMaybe<Scalars['ID']['input']>;
  5045. languageCode: LanguageCode;
  5046. name?: InputMaybe<Scalars['String']['input']>;
  5047. };
  5048. /** The price value where the result has a single price */
  5049. export type SinglePrice = {
  5050. __typename?: 'SinglePrice';
  5051. value: Scalars['Money']['output'];
  5052. };
  5053. export enum SortOrder {
  5054. ASC = 'ASC',
  5055. DESC = 'DESC'
  5056. }
  5057. export type StockAdjustment = Node & StockMovement & {
  5058. __typename?: 'StockAdjustment';
  5059. createdAt: Scalars['DateTime']['output'];
  5060. id: Scalars['ID']['output'];
  5061. productVariant: ProductVariant;
  5062. quantity: Scalars['Int']['output'];
  5063. type: StockMovementType;
  5064. updatedAt: Scalars['DateTime']['output'];
  5065. };
  5066. export type StockLevel = Node & {
  5067. __typename?: 'StockLevel';
  5068. createdAt: Scalars['DateTime']['output'];
  5069. id: Scalars['ID']['output'];
  5070. stockAllocated: Scalars['Int']['output'];
  5071. stockLocation: StockLocation;
  5072. stockLocationId: Scalars['ID']['output'];
  5073. stockOnHand: Scalars['Int']['output'];
  5074. updatedAt: Scalars['DateTime']['output'];
  5075. };
  5076. export type StockLevelInput = {
  5077. stockLocationId: Scalars['ID']['input'];
  5078. stockOnHand: Scalars['Int']['input'];
  5079. };
  5080. export type StockLocation = Node & {
  5081. __typename?: 'StockLocation';
  5082. createdAt: Scalars['DateTime']['output'];
  5083. customFields?: Maybe<Scalars['JSON']['output']>;
  5084. description: Scalars['String']['output'];
  5085. id: Scalars['ID']['output'];
  5086. name: Scalars['String']['output'];
  5087. updatedAt: Scalars['DateTime']['output'];
  5088. };
  5089. export type StockLocationFilterParameter = {
  5090. _and?: InputMaybe<Array<StockLocationFilterParameter>>;
  5091. _or?: InputMaybe<Array<StockLocationFilterParameter>>;
  5092. createdAt?: InputMaybe<DateOperators>;
  5093. description?: InputMaybe<StringOperators>;
  5094. id?: InputMaybe<IdOperators>;
  5095. name?: InputMaybe<StringOperators>;
  5096. updatedAt?: InputMaybe<DateOperators>;
  5097. };
  5098. export type StockLocationList = PaginatedList & {
  5099. __typename?: 'StockLocationList';
  5100. items: Array<StockLocation>;
  5101. totalItems: Scalars['Int']['output'];
  5102. };
  5103. export type StockLocationListOptions = {
  5104. /** Allows the results to be filtered */
  5105. filter?: InputMaybe<StockLocationFilterParameter>;
  5106. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5107. filterOperator?: InputMaybe<LogicalOperator>;
  5108. /** Skips the first n results, for use in pagination */
  5109. skip?: InputMaybe<Scalars['Int']['input']>;
  5110. /** Specifies which properties to sort the results by */
  5111. sort?: InputMaybe<StockLocationSortParameter>;
  5112. /** Takes n results, for use in pagination */
  5113. take?: InputMaybe<Scalars['Int']['input']>;
  5114. };
  5115. export type StockLocationSortParameter = {
  5116. createdAt?: InputMaybe<SortOrder>;
  5117. description?: InputMaybe<SortOrder>;
  5118. id?: InputMaybe<SortOrder>;
  5119. name?: InputMaybe<SortOrder>;
  5120. updatedAt?: InputMaybe<SortOrder>;
  5121. };
  5122. export type StockMovement = {
  5123. createdAt: Scalars['DateTime']['output'];
  5124. id: Scalars['ID']['output'];
  5125. productVariant: ProductVariant;
  5126. quantity: Scalars['Int']['output'];
  5127. type: StockMovementType;
  5128. updatedAt: Scalars['DateTime']['output'];
  5129. };
  5130. export type StockMovementItem = Allocation | Cancellation | Release | Return | Sale | StockAdjustment;
  5131. export type StockMovementList = {
  5132. __typename?: 'StockMovementList';
  5133. items: Array<StockMovementItem>;
  5134. totalItems: Scalars['Int']['output'];
  5135. };
  5136. export type StockMovementListOptions = {
  5137. skip?: InputMaybe<Scalars['Int']['input']>;
  5138. take?: InputMaybe<Scalars['Int']['input']>;
  5139. type?: InputMaybe<StockMovementType>;
  5140. };
  5141. export enum StockMovementType {
  5142. ADJUSTMENT = 'ADJUSTMENT',
  5143. ALLOCATION = 'ALLOCATION',
  5144. CANCELLATION = 'CANCELLATION',
  5145. RELEASE = 'RELEASE',
  5146. RETURN = 'RETURN',
  5147. SALE = 'SALE'
  5148. }
  5149. export type StringCustomFieldConfig = CustomField & {
  5150. __typename?: 'StringCustomFieldConfig';
  5151. description?: Maybe<Array<LocalizedString>>;
  5152. internal?: Maybe<Scalars['Boolean']['output']>;
  5153. label?: Maybe<Array<LocalizedString>>;
  5154. length?: Maybe<Scalars['Int']['output']>;
  5155. list: Scalars['Boolean']['output'];
  5156. name: Scalars['String']['output'];
  5157. nullable?: Maybe<Scalars['Boolean']['output']>;
  5158. options?: Maybe<Array<StringFieldOption>>;
  5159. pattern?: Maybe<Scalars['String']['output']>;
  5160. readonly?: Maybe<Scalars['Boolean']['output']>;
  5161. requiresPermission?: Maybe<Array<Permission>>;
  5162. type: Scalars['String']['output'];
  5163. ui?: Maybe<Scalars['JSON']['output']>;
  5164. };
  5165. export type StringFieldOption = {
  5166. __typename?: 'StringFieldOption';
  5167. label?: Maybe<Array<LocalizedString>>;
  5168. value: Scalars['String']['output'];
  5169. };
  5170. /** Operators for filtering on a list of String fields */
  5171. export type StringListOperators = {
  5172. inList: Scalars['String']['input'];
  5173. };
  5174. /** Operators for filtering on a String field */
  5175. export type StringOperators = {
  5176. contains?: InputMaybe<Scalars['String']['input']>;
  5177. eq?: InputMaybe<Scalars['String']['input']>;
  5178. in?: InputMaybe<Array<Scalars['String']['input']>>;
  5179. isNull?: InputMaybe<Scalars['Boolean']['input']>;
  5180. notContains?: InputMaybe<Scalars['String']['input']>;
  5181. notEq?: InputMaybe<Scalars['String']['input']>;
  5182. notIn?: InputMaybe<Array<Scalars['String']['input']>>;
  5183. regex?: InputMaybe<Scalars['String']['input']>;
  5184. };
  5185. /** Indicates that an operation succeeded, where we do not want to return any more specific information. */
  5186. export type Success = {
  5187. __typename?: 'Success';
  5188. success: Scalars['Boolean']['output'];
  5189. };
  5190. export type Surcharge = Node & {
  5191. __typename?: 'Surcharge';
  5192. createdAt: Scalars['DateTime']['output'];
  5193. description: Scalars['String']['output'];
  5194. id: Scalars['ID']['output'];
  5195. price: Scalars['Money']['output'];
  5196. priceWithTax: Scalars['Money']['output'];
  5197. sku?: Maybe<Scalars['String']['output']>;
  5198. taxLines: Array<TaxLine>;
  5199. taxRate: Scalars['Float']['output'];
  5200. updatedAt: Scalars['DateTime']['output'];
  5201. };
  5202. export type SurchargeInput = {
  5203. description: Scalars['String']['input'];
  5204. price: Scalars['Money']['input'];
  5205. priceIncludesTax: Scalars['Boolean']['input'];
  5206. sku?: InputMaybe<Scalars['String']['input']>;
  5207. taxDescription?: InputMaybe<Scalars['String']['input']>;
  5208. taxRate?: InputMaybe<Scalars['Float']['input']>;
  5209. };
  5210. export type Tag = Node & {
  5211. __typename?: 'Tag';
  5212. createdAt: Scalars['DateTime']['output'];
  5213. id: Scalars['ID']['output'];
  5214. updatedAt: Scalars['DateTime']['output'];
  5215. value: Scalars['String']['output'];
  5216. };
  5217. export type TagFilterParameter = {
  5218. _and?: InputMaybe<Array<TagFilterParameter>>;
  5219. _or?: InputMaybe<Array<TagFilterParameter>>;
  5220. createdAt?: InputMaybe<DateOperators>;
  5221. id?: InputMaybe<IdOperators>;
  5222. updatedAt?: InputMaybe<DateOperators>;
  5223. value?: InputMaybe<StringOperators>;
  5224. };
  5225. export type TagList = PaginatedList & {
  5226. __typename?: 'TagList';
  5227. items: Array<Tag>;
  5228. totalItems: Scalars['Int']['output'];
  5229. };
  5230. export type TagListOptions = {
  5231. /** Allows the results to be filtered */
  5232. filter?: InputMaybe<TagFilterParameter>;
  5233. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5234. filterOperator?: InputMaybe<LogicalOperator>;
  5235. /** Skips the first n results, for use in pagination */
  5236. skip?: InputMaybe<Scalars['Int']['input']>;
  5237. /** Specifies which properties to sort the results by */
  5238. sort?: InputMaybe<TagSortParameter>;
  5239. /** Takes n results, for use in pagination */
  5240. take?: InputMaybe<Scalars['Int']['input']>;
  5241. };
  5242. export type TagSortParameter = {
  5243. createdAt?: InputMaybe<SortOrder>;
  5244. id?: InputMaybe<SortOrder>;
  5245. updatedAt?: InputMaybe<SortOrder>;
  5246. value?: InputMaybe<SortOrder>;
  5247. };
  5248. export type TaxCategory = Node & {
  5249. __typename?: 'TaxCategory';
  5250. createdAt: Scalars['DateTime']['output'];
  5251. customFields?: Maybe<Scalars['JSON']['output']>;
  5252. id: Scalars['ID']['output'];
  5253. isDefault: Scalars['Boolean']['output'];
  5254. name: Scalars['String']['output'];
  5255. updatedAt: Scalars['DateTime']['output'];
  5256. };
  5257. export type TaxCategoryFilterParameter = {
  5258. _and?: InputMaybe<Array<TaxCategoryFilterParameter>>;
  5259. _or?: InputMaybe<Array<TaxCategoryFilterParameter>>;
  5260. createdAt?: InputMaybe<DateOperators>;
  5261. id?: InputMaybe<IdOperators>;
  5262. isDefault?: InputMaybe<BooleanOperators>;
  5263. name?: InputMaybe<StringOperators>;
  5264. updatedAt?: InputMaybe<DateOperators>;
  5265. };
  5266. export type TaxCategoryList = PaginatedList & {
  5267. __typename?: 'TaxCategoryList';
  5268. items: Array<TaxCategory>;
  5269. totalItems: Scalars['Int']['output'];
  5270. };
  5271. export type TaxCategoryListOptions = {
  5272. /** Allows the results to be filtered */
  5273. filter?: InputMaybe<TaxCategoryFilterParameter>;
  5274. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5275. filterOperator?: InputMaybe<LogicalOperator>;
  5276. /** Skips the first n results, for use in pagination */
  5277. skip?: InputMaybe<Scalars['Int']['input']>;
  5278. /** Specifies which properties to sort the results by */
  5279. sort?: InputMaybe<TaxCategorySortParameter>;
  5280. /** Takes n results, for use in pagination */
  5281. take?: InputMaybe<Scalars['Int']['input']>;
  5282. };
  5283. export type TaxCategorySortParameter = {
  5284. createdAt?: InputMaybe<SortOrder>;
  5285. id?: InputMaybe<SortOrder>;
  5286. name?: InputMaybe<SortOrder>;
  5287. updatedAt?: InputMaybe<SortOrder>;
  5288. };
  5289. export type TaxLine = {
  5290. __typename?: 'TaxLine';
  5291. description: Scalars['String']['output'];
  5292. taxRate: Scalars['Float']['output'];
  5293. };
  5294. export type TaxRate = Node & {
  5295. __typename?: 'TaxRate';
  5296. category: TaxCategory;
  5297. createdAt: Scalars['DateTime']['output'];
  5298. customFields?: Maybe<Scalars['JSON']['output']>;
  5299. customerGroup?: Maybe<CustomerGroup>;
  5300. enabled: Scalars['Boolean']['output'];
  5301. id: Scalars['ID']['output'];
  5302. name: Scalars['String']['output'];
  5303. updatedAt: Scalars['DateTime']['output'];
  5304. value: Scalars['Float']['output'];
  5305. zone: Zone;
  5306. };
  5307. export type TaxRateFilterParameter = {
  5308. _and?: InputMaybe<Array<TaxRateFilterParameter>>;
  5309. _or?: InputMaybe<Array<TaxRateFilterParameter>>;
  5310. createdAt?: InputMaybe<DateOperators>;
  5311. enabled?: InputMaybe<BooleanOperators>;
  5312. id?: InputMaybe<IdOperators>;
  5313. name?: InputMaybe<StringOperators>;
  5314. updatedAt?: InputMaybe<DateOperators>;
  5315. value?: InputMaybe<NumberOperators>;
  5316. };
  5317. export type TaxRateList = PaginatedList & {
  5318. __typename?: 'TaxRateList';
  5319. items: Array<TaxRate>;
  5320. totalItems: Scalars['Int']['output'];
  5321. };
  5322. export type TaxRateListOptions = {
  5323. /** Allows the results to be filtered */
  5324. filter?: InputMaybe<TaxRateFilterParameter>;
  5325. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5326. filterOperator?: InputMaybe<LogicalOperator>;
  5327. /** Skips the first n results, for use in pagination */
  5328. skip?: InputMaybe<Scalars['Int']['input']>;
  5329. /** Specifies which properties to sort the results by */
  5330. sort?: InputMaybe<TaxRateSortParameter>;
  5331. /** Takes n results, for use in pagination */
  5332. take?: InputMaybe<Scalars['Int']['input']>;
  5333. };
  5334. export type TaxRateSortParameter = {
  5335. createdAt?: InputMaybe<SortOrder>;
  5336. id?: InputMaybe<SortOrder>;
  5337. name?: InputMaybe<SortOrder>;
  5338. updatedAt?: InputMaybe<SortOrder>;
  5339. value?: InputMaybe<SortOrder>;
  5340. };
  5341. export type TestEligibleShippingMethodsInput = {
  5342. lines: Array<TestShippingMethodOrderLineInput>;
  5343. shippingAddress: CreateAddressInput;
  5344. };
  5345. export type TestShippingMethodInput = {
  5346. calculator: ConfigurableOperationInput;
  5347. checker: ConfigurableOperationInput;
  5348. lines: Array<TestShippingMethodOrderLineInput>;
  5349. shippingAddress: CreateAddressInput;
  5350. };
  5351. export type TestShippingMethodOrderLineInput = {
  5352. productVariantId: Scalars['ID']['input'];
  5353. quantity: Scalars['Int']['input'];
  5354. };
  5355. export type TestShippingMethodQuote = {
  5356. __typename?: 'TestShippingMethodQuote';
  5357. metadata?: Maybe<Scalars['JSON']['output']>;
  5358. price: Scalars['Money']['output'];
  5359. priceWithTax: Scalars['Money']['output'];
  5360. };
  5361. export type TestShippingMethodResult = {
  5362. __typename?: 'TestShippingMethodResult';
  5363. eligible: Scalars['Boolean']['output'];
  5364. quote?: Maybe<TestShippingMethodQuote>;
  5365. };
  5366. export type TextCustomFieldConfig = CustomField & {
  5367. __typename?: 'TextCustomFieldConfig';
  5368. description?: Maybe<Array<LocalizedString>>;
  5369. internal?: Maybe<Scalars['Boolean']['output']>;
  5370. label?: Maybe<Array<LocalizedString>>;
  5371. list: Scalars['Boolean']['output'];
  5372. name: Scalars['String']['output'];
  5373. nullable?: Maybe<Scalars['Boolean']['output']>;
  5374. readonly?: Maybe<Scalars['Boolean']['output']>;
  5375. requiresPermission?: Maybe<Array<Permission>>;
  5376. type: Scalars['String']['output'];
  5377. ui?: Maybe<Scalars['JSON']['output']>;
  5378. };
  5379. export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
  5380. export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
  5381. export type TransitionPaymentToStateResult = Payment | PaymentStateTransitionError;
  5382. export type UpdateActiveAdministratorInput = {
  5383. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5384. emailAddress?: InputMaybe<Scalars['String']['input']>;
  5385. firstName?: InputMaybe<Scalars['String']['input']>;
  5386. lastName?: InputMaybe<Scalars['String']['input']>;
  5387. password?: InputMaybe<Scalars['String']['input']>;
  5388. };
  5389. /**
  5390. * Input used to update an Address.
  5391. *
  5392. * The countryCode must correspond to a `code` property of a Country that has been defined in the
  5393. * Vendure server. The `code` property is typically a 2-character ISO code such as "GB", "US", "DE" etc.
  5394. * If an invalid code is passed, the mutation will fail.
  5395. */
  5396. export type UpdateAddressInput = {
  5397. city?: InputMaybe<Scalars['String']['input']>;
  5398. company?: InputMaybe<Scalars['String']['input']>;
  5399. countryCode?: InputMaybe<Scalars['String']['input']>;
  5400. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5401. defaultBillingAddress?: InputMaybe<Scalars['Boolean']['input']>;
  5402. defaultShippingAddress?: InputMaybe<Scalars['Boolean']['input']>;
  5403. fullName?: InputMaybe<Scalars['String']['input']>;
  5404. id: Scalars['ID']['input'];
  5405. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  5406. postalCode?: InputMaybe<Scalars['String']['input']>;
  5407. province?: InputMaybe<Scalars['String']['input']>;
  5408. streetLine1?: InputMaybe<Scalars['String']['input']>;
  5409. streetLine2?: InputMaybe<Scalars['String']['input']>;
  5410. };
  5411. export type UpdateAdministratorInput = {
  5412. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5413. emailAddress?: InputMaybe<Scalars['String']['input']>;
  5414. firstName?: InputMaybe<Scalars['String']['input']>;
  5415. id: Scalars['ID']['input'];
  5416. lastName?: InputMaybe<Scalars['String']['input']>;
  5417. password?: InputMaybe<Scalars['String']['input']>;
  5418. roleIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5419. };
  5420. export type UpdateAssetInput = {
  5421. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5422. focalPoint?: InputMaybe<CoordinateInput>;
  5423. id: Scalars['ID']['input'];
  5424. name?: InputMaybe<Scalars['String']['input']>;
  5425. tags?: InputMaybe<Array<Scalars['String']['input']>>;
  5426. };
  5427. export type UpdateChannelInput = {
  5428. availableCurrencyCodes?: InputMaybe<Array<CurrencyCode>>;
  5429. availableLanguageCodes?: InputMaybe<Array<LanguageCode>>;
  5430. code?: InputMaybe<Scalars['String']['input']>;
  5431. /** @deprecated Use defaultCurrencyCode instead */
  5432. currencyCode?: InputMaybe<CurrencyCode>;
  5433. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5434. defaultCurrencyCode?: InputMaybe<CurrencyCode>;
  5435. defaultLanguageCode?: InputMaybe<LanguageCode>;
  5436. defaultShippingZoneId?: InputMaybe<Scalars['ID']['input']>;
  5437. defaultTaxZoneId?: InputMaybe<Scalars['ID']['input']>;
  5438. id: Scalars['ID']['input'];
  5439. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  5440. pricesIncludeTax?: InputMaybe<Scalars['Boolean']['input']>;
  5441. sellerId?: InputMaybe<Scalars['ID']['input']>;
  5442. token?: InputMaybe<Scalars['String']['input']>;
  5443. trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
  5444. };
  5445. export type UpdateChannelResult = Channel | LanguageNotAvailableError;
  5446. export type UpdateCollectionInput = {
  5447. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5448. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5449. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  5450. filters?: InputMaybe<Array<ConfigurableOperationInput>>;
  5451. id: Scalars['ID']['input'];
  5452. inheritFilters?: InputMaybe<Scalars['Boolean']['input']>;
  5453. isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
  5454. parentId?: InputMaybe<Scalars['ID']['input']>;
  5455. translations?: InputMaybe<Array<UpdateCollectionTranslationInput>>;
  5456. };
  5457. export type UpdateCollectionTranslationInput = {
  5458. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5459. description?: InputMaybe<Scalars['String']['input']>;
  5460. id?: InputMaybe<Scalars['ID']['input']>;
  5461. languageCode: LanguageCode;
  5462. name?: InputMaybe<Scalars['String']['input']>;
  5463. slug?: InputMaybe<Scalars['String']['input']>;
  5464. };
  5465. export type UpdateCountryInput = {
  5466. code?: InputMaybe<Scalars['String']['input']>;
  5467. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5468. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5469. id: Scalars['ID']['input'];
  5470. translations?: InputMaybe<Array<CountryTranslationInput>>;
  5471. };
  5472. export type UpdateCustomerGroupInput = {
  5473. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5474. id: Scalars['ID']['input'];
  5475. name?: InputMaybe<Scalars['String']['input']>;
  5476. };
  5477. export type UpdateCustomerInput = {
  5478. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5479. emailAddress?: InputMaybe<Scalars['String']['input']>;
  5480. firstName?: InputMaybe<Scalars['String']['input']>;
  5481. id: Scalars['ID']['input'];
  5482. lastName?: InputMaybe<Scalars['String']['input']>;
  5483. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  5484. title?: InputMaybe<Scalars['String']['input']>;
  5485. };
  5486. export type UpdateCustomerNoteInput = {
  5487. note: Scalars['String']['input'];
  5488. noteId: Scalars['ID']['input'];
  5489. };
  5490. export type UpdateCustomerResult = Customer | EmailAddressConflictError;
  5491. export type UpdateFacetInput = {
  5492. code?: InputMaybe<Scalars['String']['input']>;
  5493. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5494. id: Scalars['ID']['input'];
  5495. isPrivate?: InputMaybe<Scalars['Boolean']['input']>;
  5496. translations?: InputMaybe<Array<FacetTranslationInput>>;
  5497. };
  5498. export type UpdateFacetValueInput = {
  5499. code?: InputMaybe<Scalars['String']['input']>;
  5500. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5501. id: Scalars['ID']['input'];
  5502. translations?: InputMaybe<Array<FacetValueTranslationInput>>;
  5503. };
  5504. export type UpdateGlobalSettingsInput = {
  5505. availableLanguages?: InputMaybe<Array<LanguageCode>>;
  5506. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5507. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  5508. trackInventory?: InputMaybe<Scalars['Boolean']['input']>;
  5509. };
  5510. export type UpdateGlobalSettingsResult = ChannelDefaultLanguageError | GlobalSettings;
  5511. export type UpdateOrderAddressInput = {
  5512. city?: InputMaybe<Scalars['String']['input']>;
  5513. company?: InputMaybe<Scalars['String']['input']>;
  5514. countryCode?: InputMaybe<Scalars['String']['input']>;
  5515. fullName?: InputMaybe<Scalars['String']['input']>;
  5516. phoneNumber?: InputMaybe<Scalars['String']['input']>;
  5517. postalCode?: InputMaybe<Scalars['String']['input']>;
  5518. province?: InputMaybe<Scalars['String']['input']>;
  5519. streetLine1?: InputMaybe<Scalars['String']['input']>;
  5520. streetLine2?: InputMaybe<Scalars['String']['input']>;
  5521. };
  5522. export type UpdateOrderInput = {
  5523. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5524. id: Scalars['ID']['input'];
  5525. };
  5526. export type UpdateOrderItemsResult = InsufficientStockError | NegativeQuantityError | Order | OrderLimitError | OrderModificationError;
  5527. export type UpdateOrderNoteInput = {
  5528. isPublic?: InputMaybe<Scalars['Boolean']['input']>;
  5529. note?: InputMaybe<Scalars['String']['input']>;
  5530. noteId: Scalars['ID']['input'];
  5531. };
  5532. export type UpdatePaymentMethodInput = {
  5533. checker?: InputMaybe<ConfigurableOperationInput>;
  5534. code?: InputMaybe<Scalars['String']['input']>;
  5535. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5536. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5537. handler?: InputMaybe<ConfigurableOperationInput>;
  5538. id: Scalars['ID']['input'];
  5539. translations?: InputMaybe<Array<PaymentMethodTranslationInput>>;
  5540. };
  5541. export type UpdateProductInput = {
  5542. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5543. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5544. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5545. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5546. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  5547. id: Scalars['ID']['input'];
  5548. translations?: InputMaybe<Array<ProductTranslationInput>>;
  5549. };
  5550. export type UpdateProductOptionGroupInput = {
  5551. code?: InputMaybe<Scalars['String']['input']>;
  5552. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5553. id: Scalars['ID']['input'];
  5554. translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
  5555. };
  5556. export type UpdateProductOptionInput = {
  5557. code?: InputMaybe<Scalars['String']['input']>;
  5558. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5559. id: Scalars['ID']['input'];
  5560. translations?: InputMaybe<Array<ProductOptionGroupTranslationInput>>;
  5561. };
  5562. export type UpdateProductVariantInput = {
  5563. assetIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5564. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5565. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5566. facetValueIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5567. featuredAssetId?: InputMaybe<Scalars['ID']['input']>;
  5568. id: Scalars['ID']['input'];
  5569. optionIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5570. outOfStockThreshold?: InputMaybe<Scalars['Int']['input']>;
  5571. /** Sets the price for the ProductVariant in the Channel's default currency */
  5572. price?: InputMaybe<Scalars['Money']['input']>;
  5573. /** Allows multiple prices to be set for the ProductVariant in different currencies. */
  5574. prices?: InputMaybe<Array<ProductVariantPriceInput>>;
  5575. sku?: InputMaybe<Scalars['String']['input']>;
  5576. stockLevels?: InputMaybe<Array<StockLevelInput>>;
  5577. stockOnHand?: InputMaybe<Scalars['Int']['input']>;
  5578. taxCategoryId?: InputMaybe<Scalars['ID']['input']>;
  5579. trackInventory?: InputMaybe<GlobalFlag>;
  5580. translations?: InputMaybe<Array<ProductVariantTranslationInput>>;
  5581. useGlobalOutOfStockThreshold?: InputMaybe<Scalars['Boolean']['input']>;
  5582. };
  5583. export type UpdatePromotionInput = {
  5584. actions?: InputMaybe<Array<ConfigurableOperationInput>>;
  5585. conditions?: InputMaybe<Array<ConfigurableOperationInput>>;
  5586. couponCode?: InputMaybe<Scalars['String']['input']>;
  5587. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5588. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5589. endsAt?: InputMaybe<Scalars['DateTime']['input']>;
  5590. id: Scalars['ID']['input'];
  5591. perCustomerUsageLimit?: InputMaybe<Scalars['Int']['input']>;
  5592. startsAt?: InputMaybe<Scalars['DateTime']['input']>;
  5593. translations?: InputMaybe<Array<PromotionTranslationInput>>;
  5594. usageLimit?: InputMaybe<Scalars['Int']['input']>;
  5595. };
  5596. export type UpdatePromotionResult = MissingConditionsError | Promotion;
  5597. export type UpdateProvinceInput = {
  5598. code?: InputMaybe<Scalars['String']['input']>;
  5599. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5600. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5601. id: Scalars['ID']['input'];
  5602. translations?: InputMaybe<Array<ProvinceTranslationInput>>;
  5603. };
  5604. export type UpdateRoleInput = {
  5605. channelIds?: InputMaybe<Array<Scalars['ID']['input']>>;
  5606. code?: InputMaybe<Scalars['String']['input']>;
  5607. description?: InputMaybe<Scalars['String']['input']>;
  5608. id: Scalars['ID']['input'];
  5609. permissions?: InputMaybe<Array<Permission>>;
  5610. };
  5611. export type UpdateSellerInput = {
  5612. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5613. id: Scalars['ID']['input'];
  5614. name?: InputMaybe<Scalars['String']['input']>;
  5615. };
  5616. export type UpdateShippingMethodInput = {
  5617. calculator?: InputMaybe<ConfigurableOperationInput>;
  5618. checker?: InputMaybe<ConfigurableOperationInput>;
  5619. code?: InputMaybe<Scalars['String']['input']>;
  5620. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5621. fulfillmentHandler?: InputMaybe<Scalars['String']['input']>;
  5622. id: Scalars['ID']['input'];
  5623. translations: Array<ShippingMethodTranslationInput>;
  5624. };
  5625. export type UpdateStockLocationInput = {
  5626. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5627. description?: InputMaybe<Scalars['String']['input']>;
  5628. id: Scalars['ID']['input'];
  5629. name?: InputMaybe<Scalars['String']['input']>;
  5630. };
  5631. export type UpdateTagInput = {
  5632. id: Scalars['ID']['input'];
  5633. value?: InputMaybe<Scalars['String']['input']>;
  5634. };
  5635. export type UpdateTaxCategoryInput = {
  5636. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5637. id: Scalars['ID']['input'];
  5638. isDefault?: InputMaybe<Scalars['Boolean']['input']>;
  5639. name?: InputMaybe<Scalars['String']['input']>;
  5640. };
  5641. export type UpdateTaxRateInput = {
  5642. categoryId?: InputMaybe<Scalars['ID']['input']>;
  5643. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5644. customerGroupId?: InputMaybe<Scalars['ID']['input']>;
  5645. enabled?: InputMaybe<Scalars['Boolean']['input']>;
  5646. id: Scalars['ID']['input'];
  5647. name?: InputMaybe<Scalars['String']['input']>;
  5648. value?: InputMaybe<Scalars['Float']['input']>;
  5649. zoneId?: InputMaybe<Scalars['ID']['input']>;
  5650. };
  5651. export type UpdateZoneInput = {
  5652. customFields?: InputMaybe<Scalars['JSON']['input']>;
  5653. id: Scalars['ID']['input'];
  5654. name?: InputMaybe<Scalars['String']['input']>;
  5655. };
  5656. export type User = Node & {
  5657. __typename?: 'User';
  5658. authenticationMethods: Array<AuthenticationMethod>;
  5659. createdAt: Scalars['DateTime']['output'];
  5660. customFields?: Maybe<Scalars['JSON']['output']>;
  5661. id: Scalars['ID']['output'];
  5662. identifier: Scalars['String']['output'];
  5663. lastLogin?: Maybe<Scalars['DateTime']['output']>;
  5664. roles: Array<Role>;
  5665. updatedAt: Scalars['DateTime']['output'];
  5666. verified: Scalars['Boolean']['output'];
  5667. };
  5668. export type Zone = Node & {
  5669. __typename?: 'Zone';
  5670. createdAt: Scalars['DateTime']['output'];
  5671. customFields?: Maybe<Scalars['JSON']['output']>;
  5672. id: Scalars['ID']['output'];
  5673. members: Array<Region>;
  5674. name: Scalars['String']['output'];
  5675. updatedAt: Scalars['DateTime']['output'];
  5676. };
  5677. export type ZoneFilterParameter = {
  5678. _and?: InputMaybe<Array<ZoneFilterParameter>>;
  5679. _or?: InputMaybe<Array<ZoneFilterParameter>>;
  5680. createdAt?: InputMaybe<DateOperators>;
  5681. id?: InputMaybe<IdOperators>;
  5682. name?: InputMaybe<StringOperators>;
  5683. updatedAt?: InputMaybe<DateOperators>;
  5684. };
  5685. export type ZoneList = PaginatedList & {
  5686. __typename?: 'ZoneList';
  5687. items: Array<Zone>;
  5688. totalItems: Scalars['Int']['output'];
  5689. };
  5690. export type ZoneListOptions = {
  5691. /** Allows the results to be filtered */
  5692. filter?: InputMaybe<ZoneFilterParameter>;
  5693. /** Specifies whether multiple top-level "filter" fields should be combined with a logical AND or OR operation. Defaults to AND. */
  5694. filterOperator?: InputMaybe<LogicalOperator>;
  5695. /** Skips the first n results, for use in pagination */
  5696. skip?: InputMaybe<Scalars['Int']['input']>;
  5697. /** Specifies which properties to sort the results by */
  5698. sort?: InputMaybe<ZoneSortParameter>;
  5699. /** Takes n results, for use in pagination */
  5700. take?: InputMaybe<Scalars['Int']['input']>;
  5701. };
  5702. export type ZoneSortParameter = {
  5703. createdAt?: InputMaybe<SortOrder>;
  5704. id?: InputMaybe<SortOrder>;
  5705. name?: InputMaybe<SortOrder>;
  5706. updatedAt?: InputMaybe<SortOrder>;
  5707. };