generated-types.ts 201 KB

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