generated-types.ts 210 KB

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