generated-types.ts 121 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692
  1. // tslint:disable
  2. export type Maybe<T> = T;
  3. export type Exact<T extends { [key: string]: unknown }> = { [K in keyof T]: T[K] };
  4. /** All built-in and custom scalars, mapped to their actual values */
  5. export type Scalars = {
  6. ID: string | number;
  7. String: string;
  8. Boolean: boolean;
  9. Int: number;
  10. Float: number;
  11. /** The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf). */
  12. JSON: any;
  13. /** A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the `date-time` format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar. */
  14. DateTime: any;
  15. /** The `Upload` scalar type represents a file upload. */
  16. Upload: any;
  17. };
  18. export type Query = {
  19. __typename?: 'Query';
  20. administrators: AdministratorList;
  21. administrator?: Maybe<Administrator>;
  22. activeAdministrator?: Maybe<Administrator>;
  23. /** Get a list of Assets */
  24. assets: AssetList;
  25. /** Get a single Asset by id */
  26. asset?: Maybe<Asset>;
  27. me?: Maybe<CurrentUser>;
  28. channels: Array<Channel>;
  29. channel?: Maybe<Channel>;
  30. activeChannel: Channel;
  31. collections: CollectionList;
  32. /** Get a Collection either by id or slug. If neither id nor slug is speicified, an error will result. */
  33. collection?: Maybe<Collection>;
  34. collectionFilters: Array<ConfigurableOperationDefinition>;
  35. countries: CountryList;
  36. country?: Maybe<Country>;
  37. customerGroups: CustomerGroupList;
  38. customerGroup?: Maybe<CustomerGroup>;
  39. customers: CustomerList;
  40. customer?: Maybe<Customer>;
  41. facets: FacetList;
  42. facet?: Maybe<Facet>;
  43. globalSettings: GlobalSettings;
  44. job?: Maybe<Job>;
  45. jobs: JobList;
  46. jobsById: Array<Job>;
  47. jobQueues: Array<JobQueue>;
  48. order?: Maybe<Order>;
  49. orders: OrderList;
  50. paymentMethods: PaymentMethodList;
  51. paymentMethod?: Maybe<PaymentMethod>;
  52. productOptionGroups: Array<ProductOptionGroup>;
  53. productOptionGroup?: Maybe<ProductOptionGroup>;
  54. search: SearchResponse;
  55. /** List Products */
  56. products: ProductList;
  57. /** Get a Product either by id or slug. If neither id nor slug is speicified, an error will result. */
  58. product?: Maybe<Product>;
  59. /** List ProductVariants */
  60. productVariants: ProductVariantList;
  61. /** Get a ProductVariant by id */
  62. productVariant?: Maybe<ProductVariant>;
  63. promotion?: Maybe<Promotion>;
  64. promotions: PromotionList;
  65. promotionConditions: Array<ConfigurableOperationDefinition>;
  66. promotionActions: Array<ConfigurableOperationDefinition>;
  67. roles: RoleList;
  68. role?: Maybe<Role>;
  69. shippingMethods: ShippingMethodList;
  70. shippingMethod?: Maybe<ShippingMethod>;
  71. shippingEligibilityCheckers: Array<ConfigurableOperationDefinition>;
  72. shippingCalculators: Array<ConfigurableOperationDefinition>;
  73. fulfillmentHandlers: Array<ConfigurableOperationDefinition>;
  74. testShippingMethod: TestShippingMethodResult;
  75. testEligibleShippingMethods: Array<ShippingMethodQuote>;
  76. tag: Tag;
  77. tags: TagList;
  78. taxCategories: Array<TaxCategory>;
  79. taxCategory?: Maybe<TaxCategory>;
  80. taxRates: TaxRateList;
  81. taxRate?: Maybe<TaxRate>;
  82. zones: Array<Zone>;
  83. zone?: Maybe<Zone>;
  84. };
  85. export type QueryAdministratorsArgs = {
  86. options?: Maybe<AdministratorListOptions>;
  87. };
  88. export type QueryAdministratorArgs = {
  89. id: Scalars['ID'];
  90. };
  91. export type QueryAssetsArgs = {
  92. options?: Maybe<AssetListOptions>;
  93. };
  94. export type QueryAssetArgs = {
  95. id: Scalars['ID'];
  96. };
  97. export type QueryChannelArgs = {
  98. id: Scalars['ID'];
  99. };
  100. export type QueryCollectionsArgs = {
  101. options?: Maybe<CollectionListOptions>;
  102. };
  103. export type QueryCollectionArgs = {
  104. id?: Maybe<Scalars['ID']>;
  105. slug?: Maybe<Scalars['String']>;
  106. };
  107. export type QueryCountriesArgs = {
  108. options?: Maybe<CountryListOptions>;
  109. };
  110. export type QueryCountryArgs = {
  111. id: Scalars['ID'];
  112. };
  113. export type QueryCustomerGroupsArgs = {
  114. options?: Maybe<CustomerGroupListOptions>;
  115. };
  116. export type QueryCustomerGroupArgs = {
  117. id: Scalars['ID'];
  118. };
  119. export type QueryCustomersArgs = {
  120. options?: Maybe<CustomerListOptions>;
  121. };
  122. export type QueryCustomerArgs = {
  123. id: Scalars['ID'];
  124. };
  125. export type QueryFacetsArgs = {
  126. options?: Maybe<FacetListOptions>;
  127. };
  128. export type QueryFacetArgs = {
  129. id: Scalars['ID'];
  130. };
  131. export type QueryJobArgs = {
  132. jobId: Scalars['ID'];
  133. };
  134. export type QueryJobsArgs = {
  135. options?: Maybe<JobListOptions>;
  136. };
  137. export type QueryJobsByIdArgs = {
  138. jobIds: Array<Scalars['ID']>;
  139. };
  140. export type QueryOrderArgs = {
  141. id: Scalars['ID'];
  142. };
  143. export type QueryOrdersArgs = {
  144. options?: Maybe<OrderListOptions>;
  145. };
  146. export type QueryPaymentMethodsArgs = {
  147. options?: Maybe<PaymentMethodListOptions>;
  148. };
  149. export type QueryPaymentMethodArgs = {
  150. id: Scalars['ID'];
  151. };
  152. export type QueryProductOptionGroupsArgs = {
  153. filterTerm?: Maybe<Scalars['String']>;
  154. };
  155. export type QueryProductOptionGroupArgs = {
  156. id: Scalars['ID'];
  157. };
  158. export type QuerySearchArgs = {
  159. input: SearchInput;
  160. };
  161. export type QueryProductsArgs = {
  162. options?: Maybe<ProductListOptions>;
  163. };
  164. export type QueryProductArgs = {
  165. id?: Maybe<Scalars['ID']>;
  166. slug?: Maybe<Scalars['String']>;
  167. };
  168. export type QueryProductVariantsArgs = {
  169. options?: Maybe<ProductVariantListOptions>;
  170. };
  171. export type QueryProductVariantArgs = {
  172. id: Scalars['ID'];
  173. };
  174. export type QueryPromotionArgs = {
  175. id: Scalars['ID'];
  176. };
  177. export type QueryPromotionsArgs = {
  178. options?: Maybe<PromotionListOptions>;
  179. };
  180. export type QueryRolesArgs = {
  181. options?: Maybe<RoleListOptions>;
  182. };
  183. export type QueryRoleArgs = {
  184. id: Scalars['ID'];
  185. };
  186. export type QueryShippingMethodsArgs = {
  187. options?: Maybe<ShippingMethodListOptions>;
  188. };
  189. export type QueryShippingMethodArgs = {
  190. id: Scalars['ID'];
  191. };
  192. export type QueryTestShippingMethodArgs = {
  193. input: TestShippingMethodInput;
  194. };
  195. export type QueryTestEligibleShippingMethodsArgs = {
  196. input: TestEligibleShippingMethodsInput;
  197. };
  198. export type QueryTagArgs = {
  199. id: Scalars['ID'];
  200. };
  201. export type QueryTagsArgs = {
  202. options?: Maybe<TagListOptions>;
  203. };
  204. export type QueryTaxCategoryArgs = {
  205. id: Scalars['ID'];
  206. };
  207. export type QueryTaxRatesArgs = {
  208. options?: Maybe<TaxRateListOptions>;
  209. };
  210. export type QueryTaxRateArgs = {
  211. id: Scalars['ID'];
  212. };
  213. export type QueryZoneArgs = {
  214. id: Scalars['ID'];
  215. };
  216. export type Mutation = {
  217. __typename?: 'Mutation';
  218. /** Create a new Administrator */
  219. createAdministrator: Administrator;
  220. /** Update an existing Administrator */
  221. updateAdministrator: Administrator;
  222. /** Update the active (currently logged-in) Administrator */
  223. updateActiveAdministrator: Administrator;
  224. /** Delete an Administrator */
  225. deleteAdministrator: DeletionResponse;
  226. /** Assign a Role to an Administrator */
  227. assignRoleToAdministrator: Administrator;
  228. /** Create a new Asset */
  229. createAssets: Array<CreateAssetResult>;
  230. /** Update an existing Asset */
  231. updateAsset: Asset;
  232. /** Delete an Asset */
  233. deleteAsset: DeletionResponse;
  234. /** Delete multiple Assets */
  235. deleteAssets: DeletionResponse;
  236. /** Authenticates the user using the native authentication strategy. This mutation is an alias for `authenticate({ native: { ... }})` */
  237. login: NativeAuthenticationResult;
  238. /** Authenticates the user using a named authentication strategy */
  239. authenticate: AuthenticationResult;
  240. logout: Success;
  241. /** Create a new Channel */
  242. createChannel: CreateChannelResult;
  243. /** Update an existing Channel */
  244. updateChannel: UpdateChannelResult;
  245. /** Delete a Channel */
  246. deleteChannel: DeletionResponse;
  247. /** Create a new Collection */
  248. createCollection: Collection;
  249. /** Update an existing Collection */
  250. updateCollection: Collection;
  251. /** Delete a Collection and all of its descendants */
  252. deleteCollection: DeletionResponse;
  253. /** Move a Collection to a different parent or index */
  254. moveCollection: Collection;
  255. /** Create a new Country */
  256. createCountry: Country;
  257. /** Update an existing Country */
  258. updateCountry: Country;
  259. /** Delete a Country */
  260. deleteCountry: DeletionResponse;
  261. /** Create a new CustomerGroup */
  262. createCustomerGroup: CustomerGroup;
  263. /** Update an existing CustomerGroup */
  264. updateCustomerGroup: CustomerGroup;
  265. /** Delete a CustomerGroup */
  266. deleteCustomerGroup: DeletionResponse;
  267. /** Add Customers to a CustomerGroup */
  268. addCustomersToGroup: CustomerGroup;
  269. /** Remove Customers from a CustomerGroup */
  270. removeCustomersFromGroup: CustomerGroup;
  271. /** Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer. */
  272. createCustomer: CreateCustomerResult;
  273. /** Update an existing Customer */
  274. updateCustomer: UpdateCustomerResult;
  275. /** Delete a Customer */
  276. deleteCustomer: DeletionResponse;
  277. /** Create a new Address and associate it with the Customer specified by customerId */
  278. createCustomerAddress: Address;
  279. /** Update an existing Address */
  280. updateCustomerAddress: Address;
  281. /** Update an existing Address */
  282. deleteCustomerAddress: Success;
  283. addNoteToCustomer: Customer;
  284. updateCustomerNote: HistoryEntry;
  285. deleteCustomerNote: DeletionResponse;
  286. /** Create a new Facet */
  287. createFacet: Facet;
  288. /** Update an existing Facet */
  289. updateFacet: Facet;
  290. /** Delete an existing Facet */
  291. deleteFacet: DeletionResponse;
  292. /** Create one or more FacetValues */
  293. createFacetValues: Array<FacetValue>;
  294. /** Update one or more FacetValues */
  295. updateFacetValues: Array<FacetValue>;
  296. /** Delete one or more FacetValues */
  297. deleteFacetValues: Array<DeletionResponse>;
  298. updateGlobalSettings: UpdateGlobalSettingsResult;
  299. importProducts?: Maybe<ImportInfo>;
  300. /** Remove all settled jobs in the given queues olfer than the given date. Returns the number of jobs deleted. */
  301. removeSettledJobs: Scalars['Int'];
  302. cancelJob: Job;
  303. settlePayment: SettlePaymentResult;
  304. addFulfillmentToOrder: AddFulfillmentToOrderResult;
  305. cancelOrder: CancelOrderResult;
  306. refundOrder: RefundOrderResult;
  307. settleRefund: SettleRefundResult;
  308. addNoteToOrder: Order;
  309. updateOrderNote: HistoryEntry;
  310. deleteOrderNote: DeletionResponse;
  311. transitionOrderToState?: Maybe<TransitionOrderToStateResult>;
  312. transitionFulfillmentToState: TransitionFulfillmentToStateResult;
  313. setOrderCustomFields?: Maybe<Order>;
  314. /**
  315. * Allows an Order to be modified after it has been completed by the Customer. The Order must first
  316. * be in the `Modifying` state.
  317. */
  318. modifyOrder: ModifyOrderResult;
  319. /**
  320. * Used to manually create a new Payment against an Order. This is used when a completed Order
  321. * has been modified (using `modifyOrder`) and the price has increased. The extra payment
  322. * can then be manually arranged by the administrator, and the details used to create a new
  323. * Payment.
  324. */
  325. addManualPaymentToOrder: AddManualPaymentToOrderResult;
  326. /** Update an existing PaymentMethod */
  327. updatePaymentMethod: PaymentMethod;
  328. /** Create a new ProductOptionGroup */
  329. createProductOptionGroup: ProductOptionGroup;
  330. /** Update an existing ProductOptionGroup */
  331. updateProductOptionGroup: ProductOptionGroup;
  332. /** Create a new ProductOption within a ProductOptionGroup */
  333. createProductOption: ProductOption;
  334. /** Create a new ProductOption within a ProductOptionGroup */
  335. updateProductOption: ProductOption;
  336. reindex: Job;
  337. /** Create a new Product */
  338. createProduct: Product;
  339. /** Update an existing Product */
  340. updateProduct: Product;
  341. /** Delete a Product */
  342. deleteProduct: DeletionResponse;
  343. /** Add an OptionGroup to a Product */
  344. addOptionGroupToProduct: Product;
  345. /** Remove an OptionGroup from a Product */
  346. removeOptionGroupFromProduct: RemoveOptionGroupFromProductResult;
  347. /** Create a set of ProductVariants based on the OptionGroups assigned to the given Product */
  348. createProductVariants: Array<Maybe<ProductVariant>>;
  349. /** Update existing ProductVariants */
  350. updateProductVariants: Array<Maybe<ProductVariant>>;
  351. /** Delete a ProductVariant */
  352. deleteProductVariant: DeletionResponse;
  353. /** Assigns all ProductVariants of Product to the specified Channel */
  354. assignProductsToChannel: Array<Product>;
  355. /** Removes all ProductVariants of Product from the specified Channel */
  356. removeProductsFromChannel: Array<Product>;
  357. /** Assigns ProductVariants to the specified Channel */
  358. assignProductVariantsToChannel: Array<ProductVariant>;
  359. /** Removes ProductVariants from the specified Channel */
  360. removeProductVariantsFromChannel: Array<ProductVariant>;
  361. createPromotion: CreatePromotionResult;
  362. updatePromotion: UpdatePromotionResult;
  363. deletePromotion: DeletionResponse;
  364. /** Create a new Role */
  365. createRole: Role;
  366. /** Update an existing Role */
  367. updateRole: Role;
  368. /** Delete an existing Role */
  369. deleteRole: DeletionResponse;
  370. /** Create a new ShippingMethod */
  371. createShippingMethod: ShippingMethod;
  372. /** Update an existing ShippingMethod */
  373. updateShippingMethod: ShippingMethod;
  374. /** Delete a ShippingMethod */
  375. deleteShippingMethod: DeletionResponse;
  376. /** Create a new Tag */
  377. createTag: Tag;
  378. /** Update an existing Tag */
  379. updateTag: Tag;
  380. /** Delete an existing Tag */
  381. deleteTag: DeletionResponse;
  382. /** Create a new TaxCategory */
  383. createTaxCategory: TaxCategory;
  384. /** Update an existing TaxCategory */
  385. updateTaxCategory: TaxCategory;
  386. /** Deletes a TaxCategory */
  387. deleteTaxCategory: DeletionResponse;
  388. /** Create a new TaxRate */
  389. createTaxRate: TaxRate;
  390. /** Update an existing TaxRate */
  391. updateTaxRate: TaxRate;
  392. /** Delete a TaxRate */
  393. deleteTaxRate: DeletionResponse;
  394. /** Create a new Zone */
  395. createZone: Zone;
  396. /** Update an existing Zone */
  397. updateZone: Zone;
  398. /** Delete a Zone */
  399. deleteZone: DeletionResponse;
  400. /** Add members to a Zone */
  401. addMembersToZone: Zone;
  402. /** Remove members from a Zone */
  403. removeMembersFromZone: Zone;
  404. };
  405. export type MutationCreateAdministratorArgs = {
  406. input: CreateAdministratorInput;
  407. };
  408. export type MutationUpdateAdministratorArgs = {
  409. input: UpdateAdministratorInput;
  410. };
  411. export type MutationUpdateActiveAdministratorArgs = {
  412. input: UpdateActiveAdministratorInput;
  413. };
  414. export type MutationDeleteAdministratorArgs = {
  415. id: Scalars['ID'];
  416. };
  417. export type MutationAssignRoleToAdministratorArgs = {
  418. administratorId: Scalars['ID'];
  419. roleId: Scalars['ID'];
  420. };
  421. export type MutationCreateAssetsArgs = {
  422. input: Array<CreateAssetInput>;
  423. };
  424. export type MutationUpdateAssetArgs = {
  425. input: UpdateAssetInput;
  426. };
  427. export type MutationDeleteAssetArgs = {
  428. id: Scalars['ID'];
  429. force?: Maybe<Scalars['Boolean']>;
  430. };
  431. export type MutationDeleteAssetsArgs = {
  432. ids: Array<Scalars['ID']>;
  433. force?: Maybe<Scalars['Boolean']>;
  434. };
  435. export type MutationLoginArgs = {
  436. username: Scalars['String'];
  437. password: Scalars['String'];
  438. rememberMe?: Maybe<Scalars['Boolean']>;
  439. };
  440. export type MutationAuthenticateArgs = {
  441. input: AuthenticationInput;
  442. rememberMe?: Maybe<Scalars['Boolean']>;
  443. };
  444. export type MutationCreateChannelArgs = {
  445. input: CreateChannelInput;
  446. };
  447. export type MutationUpdateChannelArgs = {
  448. input: UpdateChannelInput;
  449. };
  450. export type MutationDeleteChannelArgs = {
  451. id: Scalars['ID'];
  452. };
  453. export type MutationCreateCollectionArgs = {
  454. input: CreateCollectionInput;
  455. };
  456. export type MutationUpdateCollectionArgs = {
  457. input: UpdateCollectionInput;
  458. };
  459. export type MutationDeleteCollectionArgs = {
  460. id: Scalars['ID'];
  461. };
  462. export type MutationMoveCollectionArgs = {
  463. input: MoveCollectionInput;
  464. };
  465. export type MutationCreateCountryArgs = {
  466. input: CreateCountryInput;
  467. };
  468. export type MutationUpdateCountryArgs = {
  469. input: UpdateCountryInput;
  470. };
  471. export type MutationDeleteCountryArgs = {
  472. id: Scalars['ID'];
  473. };
  474. export type MutationCreateCustomerGroupArgs = {
  475. input: CreateCustomerGroupInput;
  476. };
  477. export type MutationUpdateCustomerGroupArgs = {
  478. input: UpdateCustomerGroupInput;
  479. };
  480. export type MutationDeleteCustomerGroupArgs = {
  481. id: Scalars['ID'];
  482. };
  483. export type MutationAddCustomersToGroupArgs = {
  484. customerGroupId: Scalars['ID'];
  485. customerIds: Array<Scalars['ID']>;
  486. };
  487. export type MutationRemoveCustomersFromGroupArgs = {
  488. customerGroupId: Scalars['ID'];
  489. customerIds: Array<Scalars['ID']>;
  490. };
  491. export type MutationCreateCustomerArgs = {
  492. input: CreateCustomerInput;
  493. password?: Maybe<Scalars['String']>;
  494. };
  495. export type MutationUpdateCustomerArgs = {
  496. input: UpdateCustomerInput;
  497. };
  498. export type MutationDeleteCustomerArgs = {
  499. id: Scalars['ID'];
  500. };
  501. export type MutationCreateCustomerAddressArgs = {
  502. customerId: Scalars['ID'];
  503. input: CreateAddressInput;
  504. };
  505. export type MutationUpdateCustomerAddressArgs = {
  506. input: UpdateAddressInput;
  507. };
  508. export type MutationDeleteCustomerAddressArgs = {
  509. id: Scalars['ID'];
  510. };
  511. export type MutationAddNoteToCustomerArgs = {
  512. input: AddNoteToCustomerInput;
  513. };
  514. export type MutationUpdateCustomerNoteArgs = {
  515. input: UpdateCustomerNoteInput;
  516. };
  517. export type MutationDeleteCustomerNoteArgs = {
  518. id: Scalars['ID'];
  519. };
  520. export type MutationCreateFacetArgs = {
  521. input: CreateFacetInput;
  522. };
  523. export type MutationUpdateFacetArgs = {
  524. input: UpdateFacetInput;
  525. };
  526. export type MutationDeleteFacetArgs = {
  527. id: Scalars['ID'];
  528. force?: Maybe<Scalars['Boolean']>;
  529. };
  530. export type MutationCreateFacetValuesArgs = {
  531. input: Array<CreateFacetValueInput>;
  532. };
  533. export type MutationUpdateFacetValuesArgs = {
  534. input: Array<UpdateFacetValueInput>;
  535. };
  536. export type MutationDeleteFacetValuesArgs = {
  537. ids: Array<Scalars['ID']>;
  538. force?: Maybe<Scalars['Boolean']>;
  539. };
  540. export type MutationUpdateGlobalSettingsArgs = {
  541. input: UpdateGlobalSettingsInput;
  542. };
  543. export type MutationImportProductsArgs = {
  544. csvFile: Scalars['Upload'];
  545. };
  546. export type MutationRemoveSettledJobsArgs = {
  547. queueNames?: Maybe<Array<Scalars['String']>>;
  548. olderThan?: Maybe<Scalars['DateTime']>;
  549. };
  550. export type MutationCancelJobArgs = {
  551. jobId: Scalars['ID'];
  552. };
  553. export type MutationSettlePaymentArgs = {
  554. id: Scalars['ID'];
  555. };
  556. export type MutationAddFulfillmentToOrderArgs = {
  557. input: FulfillOrderInput;
  558. };
  559. export type MutationCancelOrderArgs = {
  560. input: CancelOrderInput;
  561. };
  562. export type MutationRefundOrderArgs = {
  563. input: RefundOrderInput;
  564. };
  565. export type MutationSettleRefundArgs = {
  566. input: SettleRefundInput;
  567. };
  568. export type MutationAddNoteToOrderArgs = {
  569. input: AddNoteToOrderInput;
  570. };
  571. export type MutationUpdateOrderNoteArgs = {
  572. input: UpdateOrderNoteInput;
  573. };
  574. export type MutationDeleteOrderNoteArgs = {
  575. id: Scalars['ID'];
  576. };
  577. export type MutationTransitionOrderToStateArgs = {
  578. id: Scalars['ID'];
  579. state: Scalars['String'];
  580. };
  581. export type MutationTransitionFulfillmentToStateArgs = {
  582. id: Scalars['ID'];
  583. state: Scalars['String'];
  584. };
  585. export type MutationSetOrderCustomFieldsArgs = {
  586. input: UpdateOrderInput;
  587. };
  588. export type MutationModifyOrderArgs = {
  589. input: ModifyOrderInput;
  590. };
  591. export type MutationAddManualPaymentToOrderArgs = {
  592. input: ManualPaymentInput;
  593. };
  594. export type MutationUpdatePaymentMethodArgs = {
  595. input: UpdatePaymentMethodInput;
  596. };
  597. export type MutationCreateProductOptionGroupArgs = {
  598. input: CreateProductOptionGroupInput;
  599. };
  600. export type MutationUpdateProductOptionGroupArgs = {
  601. input: UpdateProductOptionGroupInput;
  602. };
  603. export type MutationCreateProductOptionArgs = {
  604. input: CreateProductOptionInput;
  605. };
  606. export type MutationUpdateProductOptionArgs = {
  607. input: UpdateProductOptionInput;
  608. };
  609. export type MutationCreateProductArgs = {
  610. input: CreateProductInput;
  611. };
  612. export type MutationUpdateProductArgs = {
  613. input: UpdateProductInput;
  614. };
  615. export type MutationDeleteProductArgs = {
  616. id: Scalars['ID'];
  617. };
  618. export type MutationAddOptionGroupToProductArgs = {
  619. productId: Scalars['ID'];
  620. optionGroupId: Scalars['ID'];
  621. };
  622. export type MutationRemoveOptionGroupFromProductArgs = {
  623. productId: Scalars['ID'];
  624. optionGroupId: Scalars['ID'];
  625. };
  626. export type MutationCreateProductVariantsArgs = {
  627. input: Array<CreateProductVariantInput>;
  628. };
  629. export type MutationUpdateProductVariantsArgs = {
  630. input: Array<UpdateProductVariantInput>;
  631. };
  632. export type MutationDeleteProductVariantArgs = {
  633. id: Scalars['ID'];
  634. };
  635. export type MutationAssignProductsToChannelArgs = {
  636. input: AssignProductsToChannelInput;
  637. };
  638. export type MutationRemoveProductsFromChannelArgs = {
  639. input: RemoveProductsFromChannelInput;
  640. };
  641. export type MutationAssignProductVariantsToChannelArgs = {
  642. input: AssignProductVariantsToChannelInput;
  643. };
  644. export type MutationRemoveProductVariantsFromChannelArgs = {
  645. input: RemoveProductVariantsFromChannelInput;
  646. };
  647. export type MutationCreatePromotionArgs = {
  648. input: CreatePromotionInput;
  649. };
  650. export type MutationUpdatePromotionArgs = {
  651. input: UpdatePromotionInput;
  652. };
  653. export type MutationDeletePromotionArgs = {
  654. id: Scalars['ID'];
  655. };
  656. export type MutationCreateRoleArgs = {
  657. input: CreateRoleInput;
  658. };
  659. export type MutationUpdateRoleArgs = {
  660. input: UpdateRoleInput;
  661. };
  662. export type MutationDeleteRoleArgs = {
  663. id: Scalars['ID'];
  664. };
  665. export type MutationCreateShippingMethodArgs = {
  666. input: CreateShippingMethodInput;
  667. };
  668. export type MutationUpdateShippingMethodArgs = {
  669. input: UpdateShippingMethodInput;
  670. };
  671. export type MutationDeleteShippingMethodArgs = {
  672. id: Scalars['ID'];
  673. };
  674. export type MutationCreateTagArgs = {
  675. input: CreateTagInput;
  676. };
  677. export type MutationUpdateTagArgs = {
  678. input: UpdateTagInput;
  679. };
  680. export type MutationDeleteTagArgs = {
  681. id: Scalars['ID'];
  682. };
  683. export type MutationCreateTaxCategoryArgs = {
  684. input: CreateTaxCategoryInput;
  685. };
  686. export type MutationUpdateTaxCategoryArgs = {
  687. input: UpdateTaxCategoryInput;
  688. };
  689. export type MutationDeleteTaxCategoryArgs = {
  690. id: Scalars['ID'];
  691. };
  692. export type MutationCreateTaxRateArgs = {
  693. input: CreateTaxRateInput;
  694. };
  695. export type MutationUpdateTaxRateArgs = {
  696. input: UpdateTaxRateInput;
  697. };
  698. export type MutationDeleteTaxRateArgs = {
  699. id: Scalars['ID'];
  700. };
  701. export type MutationCreateZoneArgs = {
  702. input: CreateZoneInput;
  703. };
  704. export type MutationUpdateZoneArgs = {
  705. input: UpdateZoneInput;
  706. };
  707. export type MutationDeleteZoneArgs = {
  708. id: Scalars['ID'];
  709. };
  710. export type MutationAddMembersToZoneArgs = {
  711. zoneId: Scalars['ID'];
  712. memberIds: Array<Scalars['ID']>;
  713. };
  714. export type MutationRemoveMembersFromZoneArgs = {
  715. zoneId: Scalars['ID'];
  716. memberIds: Array<Scalars['ID']>;
  717. };
  718. export type CreateAdministratorInput = {
  719. firstName: Scalars['String'];
  720. lastName: Scalars['String'];
  721. emailAddress: Scalars['String'];
  722. password: Scalars['String'];
  723. roleIds: Array<Scalars['ID']>;
  724. };
  725. export type UpdateAdministratorInput = {
  726. id: Scalars['ID'];
  727. firstName?: Maybe<Scalars['String']>;
  728. lastName?: Maybe<Scalars['String']>;
  729. emailAddress?: Maybe<Scalars['String']>;
  730. password?: Maybe<Scalars['String']>;
  731. roleIds?: Maybe<Array<Scalars['ID']>>;
  732. };
  733. export type UpdateActiveAdministratorInput = {
  734. firstName?: Maybe<Scalars['String']>;
  735. lastName?: Maybe<Scalars['String']>;
  736. emailAddress?: Maybe<Scalars['String']>;
  737. password?: Maybe<Scalars['String']>;
  738. };
  739. export type Administrator = Node & {
  740. __typename?: 'Administrator';
  741. id: Scalars['ID'];
  742. createdAt: Scalars['DateTime'];
  743. updatedAt: Scalars['DateTime'];
  744. firstName: Scalars['String'];
  745. lastName: Scalars['String'];
  746. emailAddress: Scalars['String'];
  747. user: User;
  748. };
  749. export type AdministratorList = PaginatedList & {
  750. __typename?: 'AdministratorList';
  751. items: Array<Administrator>;
  752. totalItems: Scalars['Int'];
  753. };
  754. export type Asset = Node & {
  755. __typename?: 'Asset';
  756. tags: Array<Tag>;
  757. id: Scalars['ID'];
  758. createdAt: Scalars['DateTime'];
  759. updatedAt: Scalars['DateTime'];
  760. name: Scalars['String'];
  761. type: AssetType;
  762. fileSize: Scalars['Int'];
  763. mimeType: Scalars['String'];
  764. width: Scalars['Int'];
  765. height: Scalars['Int'];
  766. source: Scalars['String'];
  767. preview: Scalars['String'];
  768. focalPoint?: Maybe<Coordinate>;
  769. };
  770. export type MimeTypeError = ErrorResult & {
  771. __typename?: 'MimeTypeError';
  772. errorCode: ErrorCode;
  773. message: Scalars['String'];
  774. fileName: Scalars['String'];
  775. mimeType: Scalars['String'];
  776. };
  777. export type CreateAssetResult = Asset | MimeTypeError;
  778. export type AssetListOptions = {
  779. skip?: Maybe<Scalars['Int']>;
  780. take?: Maybe<Scalars['Int']>;
  781. sort?: Maybe<AssetSortParameter>;
  782. filter?: Maybe<AssetFilterParameter>;
  783. tags?: Maybe<Array<Scalars['String']>>;
  784. tagsOperator?: Maybe<LogicalOperator>;
  785. };
  786. export type CreateAssetInput = {
  787. file: Scalars['Upload'];
  788. tags?: Maybe<Array<Scalars['String']>>;
  789. };
  790. export type CoordinateInput = {
  791. x: Scalars['Float'];
  792. y: Scalars['Float'];
  793. };
  794. export type UpdateAssetInput = {
  795. id: Scalars['ID'];
  796. name?: Maybe<Scalars['String']>;
  797. focalPoint?: Maybe<CoordinateInput>;
  798. tags?: Maybe<Array<Scalars['String']>>;
  799. };
  800. export type NativeAuthenticationResult = CurrentUser | InvalidCredentialsError | NativeAuthStrategyError;
  801. export type AuthenticationResult = CurrentUser | InvalidCredentialsError;
  802. export type CreateChannelInput = {
  803. code: Scalars['String'];
  804. token: Scalars['String'];
  805. defaultLanguageCode: LanguageCode;
  806. pricesIncludeTax: Scalars['Boolean'];
  807. currencyCode: CurrencyCode;
  808. defaultTaxZoneId: Scalars['ID'];
  809. defaultShippingZoneId: Scalars['ID'];
  810. };
  811. export type UpdateChannelInput = {
  812. id: Scalars['ID'];
  813. code?: Maybe<Scalars['String']>;
  814. token?: Maybe<Scalars['String']>;
  815. defaultLanguageCode?: Maybe<LanguageCode>;
  816. pricesIncludeTax?: Maybe<Scalars['Boolean']>;
  817. currencyCode?: Maybe<CurrencyCode>;
  818. defaultTaxZoneId?: Maybe<Scalars['ID']>;
  819. defaultShippingZoneId?: Maybe<Scalars['ID']>;
  820. };
  821. /** Returned if attempting to set a Channel's defaultLanguageCode to a language which is not enabled in GlobalSettings */
  822. export type LanguageNotAvailableError = ErrorResult & {
  823. __typename?: 'LanguageNotAvailableError';
  824. errorCode: ErrorCode;
  825. message: Scalars['String'];
  826. languageCode: Scalars['String'];
  827. };
  828. export type CreateChannelResult = Channel | LanguageNotAvailableError;
  829. export type UpdateChannelResult = Channel | LanguageNotAvailableError;
  830. export type Collection = Node & {
  831. __typename?: 'Collection';
  832. isPrivate: Scalars['Boolean'];
  833. id: Scalars['ID'];
  834. createdAt: Scalars['DateTime'];
  835. updatedAt: Scalars['DateTime'];
  836. languageCode?: Maybe<LanguageCode>;
  837. name: Scalars['String'];
  838. slug: Scalars['String'];
  839. breadcrumbs: Array<CollectionBreadcrumb>;
  840. position: Scalars['Int'];
  841. description: Scalars['String'];
  842. featuredAsset?: Maybe<Asset>;
  843. assets: Array<Asset>;
  844. parent?: Maybe<Collection>;
  845. children?: Maybe<Array<Collection>>;
  846. filters: Array<ConfigurableOperation>;
  847. translations: Array<CollectionTranslation>;
  848. productVariants: ProductVariantList;
  849. customFields?: Maybe<Scalars['JSON']>;
  850. };
  851. export type CollectionProductVariantsArgs = {
  852. options?: Maybe<ProductVariantListOptions>;
  853. };
  854. export type MoveCollectionInput = {
  855. collectionId: Scalars['ID'];
  856. parentId: Scalars['ID'];
  857. index: Scalars['Int'];
  858. };
  859. export type CreateCollectionTranslationInput = {
  860. languageCode: LanguageCode;
  861. name: Scalars['String'];
  862. slug: Scalars['String'];
  863. description: Scalars['String'];
  864. customFields?: Maybe<Scalars['JSON']>;
  865. };
  866. export type UpdateCollectionTranslationInput = {
  867. id?: Maybe<Scalars['ID']>;
  868. languageCode: LanguageCode;
  869. name?: Maybe<Scalars['String']>;
  870. slug?: Maybe<Scalars['String']>;
  871. description?: Maybe<Scalars['String']>;
  872. customFields?: Maybe<Scalars['JSON']>;
  873. };
  874. export type CreateCollectionInput = {
  875. isPrivate?: Maybe<Scalars['Boolean']>;
  876. featuredAssetId?: Maybe<Scalars['ID']>;
  877. assetIds?: Maybe<Array<Scalars['ID']>>;
  878. parentId?: Maybe<Scalars['ID']>;
  879. filters: Array<ConfigurableOperationInput>;
  880. translations: Array<CreateCollectionTranslationInput>;
  881. customFields?: Maybe<Scalars['JSON']>;
  882. };
  883. export type UpdateCollectionInput = {
  884. id: Scalars['ID'];
  885. isPrivate?: Maybe<Scalars['Boolean']>;
  886. featuredAssetId?: Maybe<Scalars['ID']>;
  887. parentId?: Maybe<Scalars['ID']>;
  888. assetIds?: Maybe<Array<Scalars['ID']>>;
  889. filters?: Maybe<Array<ConfigurableOperationInput>>;
  890. translations?: Maybe<Array<UpdateCollectionTranslationInput>>;
  891. customFields?: Maybe<Scalars['JSON']>;
  892. };
  893. export type CountryTranslationInput = {
  894. id?: Maybe<Scalars['ID']>;
  895. languageCode: LanguageCode;
  896. name?: Maybe<Scalars['String']>;
  897. };
  898. export type CreateCountryInput = {
  899. code: Scalars['String'];
  900. translations: Array<CountryTranslationInput>;
  901. enabled: Scalars['Boolean'];
  902. };
  903. export type UpdateCountryInput = {
  904. id: Scalars['ID'];
  905. code?: Maybe<Scalars['String']>;
  906. translations?: Maybe<Array<CountryTranslationInput>>;
  907. enabled?: Maybe<Scalars['Boolean']>;
  908. };
  909. export type Customer = Node & {
  910. __typename?: 'Customer';
  911. groups: Array<CustomerGroup>;
  912. history: HistoryEntryList;
  913. id: Scalars['ID'];
  914. createdAt: Scalars['DateTime'];
  915. updatedAt: Scalars['DateTime'];
  916. title?: Maybe<Scalars['String']>;
  917. firstName: Scalars['String'];
  918. lastName: Scalars['String'];
  919. phoneNumber?: Maybe<Scalars['String']>;
  920. emailAddress: Scalars['String'];
  921. addresses?: Maybe<Array<Address>>;
  922. orders: OrderList;
  923. user?: Maybe<User>;
  924. customFields?: Maybe<Scalars['JSON']>;
  925. };
  926. export type CustomerHistoryArgs = {
  927. options?: Maybe<HistoryEntryListOptions>;
  928. };
  929. export type CustomerOrdersArgs = {
  930. options?: Maybe<OrderListOptions>;
  931. };
  932. export type CustomerGroupList = PaginatedList & {
  933. __typename?: 'CustomerGroupList';
  934. items: Array<CustomerGroup>;
  935. totalItems: Scalars['Int'];
  936. };
  937. export type CreateCustomerGroupInput = {
  938. name: Scalars['String'];
  939. customerIds?: Maybe<Array<Scalars['ID']>>;
  940. };
  941. export type UpdateCustomerGroupInput = {
  942. id: Scalars['ID'];
  943. name?: Maybe<Scalars['String']>;
  944. };
  945. export type UpdateCustomerInput = {
  946. id: Scalars['ID'];
  947. title?: Maybe<Scalars['String']>;
  948. firstName?: Maybe<Scalars['String']>;
  949. lastName?: Maybe<Scalars['String']>;
  950. phoneNumber?: Maybe<Scalars['String']>;
  951. emailAddress?: Maybe<Scalars['String']>;
  952. customFields?: Maybe<Scalars['JSON']>;
  953. };
  954. export type AddNoteToCustomerInput = {
  955. id: Scalars['ID'];
  956. note: Scalars['String'];
  957. isPublic: Scalars['Boolean'];
  958. };
  959. export type UpdateCustomerNoteInput = {
  960. noteId: Scalars['ID'];
  961. note: Scalars['String'];
  962. };
  963. export type CreateCustomerResult = Customer | EmailAddressConflictError;
  964. export type UpdateCustomerResult = Customer | EmailAddressConflictError;
  965. export type Facet = Node & {
  966. __typename?: 'Facet';
  967. isPrivate: Scalars['Boolean'];
  968. id: Scalars['ID'];
  969. createdAt: Scalars['DateTime'];
  970. updatedAt: Scalars['DateTime'];
  971. languageCode: LanguageCode;
  972. name: Scalars['String'];
  973. code: Scalars['String'];
  974. values: Array<FacetValue>;
  975. translations: Array<FacetTranslation>;
  976. customFields?: Maybe<Scalars['JSON']>;
  977. };
  978. export type FacetTranslationInput = {
  979. id?: Maybe<Scalars['ID']>;
  980. languageCode: LanguageCode;
  981. name?: Maybe<Scalars['String']>;
  982. customFields?: Maybe<Scalars['JSON']>;
  983. };
  984. export type CreateFacetInput = {
  985. code: Scalars['String'];
  986. isPrivate: Scalars['Boolean'];
  987. translations: Array<FacetTranslationInput>;
  988. values?: Maybe<Array<CreateFacetValueWithFacetInput>>;
  989. customFields?: Maybe<Scalars['JSON']>;
  990. };
  991. export type UpdateFacetInput = {
  992. id: Scalars['ID'];
  993. isPrivate?: Maybe<Scalars['Boolean']>;
  994. code?: Maybe<Scalars['String']>;
  995. translations?: Maybe<Array<FacetTranslationInput>>;
  996. customFields?: Maybe<Scalars['JSON']>;
  997. };
  998. export type FacetValueTranslationInput = {
  999. id?: Maybe<Scalars['ID']>;
  1000. languageCode: LanguageCode;
  1001. name?: Maybe<Scalars['String']>;
  1002. customFields?: Maybe<Scalars['JSON']>;
  1003. };
  1004. export type CreateFacetValueWithFacetInput = {
  1005. code: Scalars['String'];
  1006. translations: Array<FacetValueTranslationInput>;
  1007. };
  1008. export type CreateFacetValueInput = {
  1009. facetId: Scalars['ID'];
  1010. code: Scalars['String'];
  1011. translations: Array<FacetValueTranslationInput>;
  1012. customFields?: Maybe<Scalars['JSON']>;
  1013. };
  1014. export type UpdateFacetValueInput = {
  1015. id: Scalars['ID'];
  1016. code?: Maybe<Scalars['String']>;
  1017. translations?: Maybe<Array<FacetValueTranslationInput>>;
  1018. customFields?: Maybe<Scalars['JSON']>;
  1019. };
  1020. export type UpdateGlobalSettingsInput = {
  1021. availableLanguages?: Maybe<Array<LanguageCode>>;
  1022. trackInventory?: Maybe<Scalars['Boolean']>;
  1023. outOfStockThreshold?: Maybe<Scalars['Int']>;
  1024. customFields?: Maybe<Scalars['JSON']>;
  1025. };
  1026. /**
  1027. * Returned when the default LanguageCode of a Channel is no longer found in the `availableLanguages`
  1028. * of the GlobalSettings
  1029. */
  1030. export type ChannelDefaultLanguageError = ErrorResult & {
  1031. __typename?: 'ChannelDefaultLanguageError';
  1032. errorCode: ErrorCode;
  1033. message: Scalars['String'];
  1034. language: Scalars['String'];
  1035. channelCode: Scalars['String'];
  1036. };
  1037. export type UpdateGlobalSettingsResult = GlobalSettings | ChannelDefaultLanguageError;
  1038. export type GlobalSettings = {
  1039. __typename?: 'GlobalSettings';
  1040. id: Scalars['ID'];
  1041. createdAt: Scalars['DateTime'];
  1042. updatedAt: Scalars['DateTime'];
  1043. availableLanguages: Array<LanguageCode>;
  1044. trackInventory: Scalars['Boolean'];
  1045. outOfStockThreshold: Scalars['Int'];
  1046. serverConfig: ServerConfig;
  1047. customFields?: Maybe<Scalars['JSON']>;
  1048. };
  1049. export type OrderProcessState = {
  1050. __typename?: 'OrderProcessState';
  1051. name: Scalars['String'];
  1052. to: Array<Scalars['String']>;
  1053. };
  1054. export type PermissionDefinition = {
  1055. __typename?: 'PermissionDefinition';
  1056. name: Scalars['String'];
  1057. description: Scalars['String'];
  1058. assignable: Scalars['Boolean'];
  1059. };
  1060. export type ServerConfig = {
  1061. __typename?: 'ServerConfig';
  1062. orderProcess: Array<OrderProcessState>;
  1063. permittedAssetTypes: Array<Scalars['String']>;
  1064. permissions: Array<PermissionDefinition>;
  1065. customFieldConfig: CustomFields;
  1066. };
  1067. export type HistoryEntry = Node & {
  1068. __typename?: 'HistoryEntry';
  1069. isPublic: Scalars['Boolean'];
  1070. administrator?: Maybe<Administrator>;
  1071. id: Scalars['ID'];
  1072. createdAt: Scalars['DateTime'];
  1073. updatedAt: Scalars['DateTime'];
  1074. type: HistoryEntryType;
  1075. data: Scalars['JSON'];
  1076. };
  1077. export type ImportInfo = {
  1078. __typename?: 'ImportInfo';
  1079. errors?: Maybe<Array<Scalars['String']>>;
  1080. processed: Scalars['Int'];
  1081. imported: Scalars['Int'];
  1082. };
  1083. /**
  1084. * @description
  1085. * The state of a Job in the JobQueue
  1086. *
  1087. * @docsCategory common
  1088. */
  1089. export enum JobState {
  1090. PENDING = 'PENDING',
  1091. RUNNING = 'RUNNING',
  1092. COMPLETED = 'COMPLETED',
  1093. RETRYING = 'RETRYING',
  1094. FAILED = 'FAILED',
  1095. CANCELLED = 'CANCELLED'
  1096. }
  1097. export type JobList = PaginatedList & {
  1098. __typename?: 'JobList';
  1099. items: Array<Job>;
  1100. totalItems: Scalars['Int'];
  1101. };
  1102. export type Job = Node & {
  1103. __typename?: 'Job';
  1104. id: Scalars['ID'];
  1105. createdAt: Scalars['DateTime'];
  1106. startedAt?: Maybe<Scalars['DateTime']>;
  1107. settledAt?: Maybe<Scalars['DateTime']>;
  1108. queueName: Scalars['String'];
  1109. state: JobState;
  1110. progress: Scalars['Float'];
  1111. data?: Maybe<Scalars['JSON']>;
  1112. result?: Maybe<Scalars['JSON']>;
  1113. error?: Maybe<Scalars['JSON']>;
  1114. isSettled: Scalars['Boolean'];
  1115. duration: Scalars['Int'];
  1116. };
  1117. export type JobQueue = {
  1118. __typename?: 'JobQueue';
  1119. name: Scalars['String'];
  1120. running: Scalars['Boolean'];
  1121. };
  1122. export type Order = Node & {
  1123. __typename?: 'Order';
  1124. nextStates: Array<Scalars['String']>;
  1125. modifications: Array<OrderModification>;
  1126. id: Scalars['ID'];
  1127. createdAt: Scalars['DateTime'];
  1128. updatedAt: Scalars['DateTime'];
  1129. /**
  1130. * The date & time that the Order was placed, i.e. the Customer
  1131. * completed the checkout and the Order is no longer "active"
  1132. */
  1133. orderPlacedAt?: Maybe<Scalars['DateTime']>;
  1134. /** A unique code for the Order */
  1135. code: Scalars['String'];
  1136. state: Scalars['String'];
  1137. /** An order is active as long as the payment process has not been completed */
  1138. active: Scalars['Boolean'];
  1139. customer?: Maybe<Customer>;
  1140. shippingAddress?: Maybe<OrderAddress>;
  1141. billingAddress?: Maybe<OrderAddress>;
  1142. lines: Array<OrderLine>;
  1143. /**
  1144. * Surcharges are arbitrary modifications to the Order total which are neither
  1145. * ProductVariants nor discounts resulting from applied Promotions. For example,
  1146. * one-off discounts based on customer interaction, or surcharges based on payment
  1147. * methods.
  1148. */
  1149. surcharges: Array<Surcharge>;
  1150. /**
  1151. * Order-level adjustments to the order total, such as discounts from promotions
  1152. * @deprecated Use `discounts` instead
  1153. */
  1154. adjustments: Array<Adjustment>;
  1155. discounts: Array<Adjustment>;
  1156. /** An array of all coupon codes applied to the Order */
  1157. couponCodes: Array<Scalars['String']>;
  1158. /** Promotions applied to the order. Only gets populated after the payment process has completed. */
  1159. promotions: Array<Promotion>;
  1160. payments?: Maybe<Array<Payment>>;
  1161. fulfillments?: Maybe<Array<Fulfillment>>;
  1162. totalQuantity: Scalars['Int'];
  1163. /**
  1164. * The subTotal is the total of all OrderLines in the Order. This figure also includes any Order-level
  1165. * discounts which have been prorated (proportionally distributed) amongst the OrderItems.
  1166. * To get a total of all OrderLines which does not account for prorated discounts, use the
  1167. * sum of `OrderLine.discountedLinePrice` values.
  1168. */
  1169. subTotal: Scalars['Int'];
  1170. /** Same as subTotal, but inclusive of tax */
  1171. subTotalWithTax: Scalars['Int'];
  1172. currencyCode: CurrencyCode;
  1173. shippingLines: Array<ShippingLine>;
  1174. shipping: Scalars['Int'];
  1175. shippingWithTax: Scalars['Int'];
  1176. /** Equal to subTotal plus shipping */
  1177. total: Scalars['Int'];
  1178. /** The final payable amount. Equal to subTotalWithTax plus shippingWithTax */
  1179. totalWithTax: Scalars['Int'];
  1180. /** A summary of the taxes being applied to this Order */
  1181. taxSummary: Array<OrderTaxSummary>;
  1182. history: HistoryEntryList;
  1183. customFields?: Maybe<Scalars['JSON']>;
  1184. };
  1185. export type OrderHistoryArgs = {
  1186. options?: Maybe<HistoryEntryListOptions>;
  1187. };
  1188. export type Fulfillment = Node & {
  1189. __typename?: 'Fulfillment';
  1190. nextStates: Array<Scalars['String']>;
  1191. id: Scalars['ID'];
  1192. createdAt: Scalars['DateTime'];
  1193. updatedAt: Scalars['DateTime'];
  1194. orderItems: Array<OrderItem>;
  1195. state: Scalars['String'];
  1196. method: Scalars['String'];
  1197. trackingCode?: Maybe<Scalars['String']>;
  1198. customFields?: Maybe<Scalars['JSON']>;
  1199. };
  1200. export type OrderModification = Node & {
  1201. __typename?: 'OrderModification';
  1202. id: Scalars['ID'];
  1203. createdAt: Scalars['DateTime'];
  1204. updatedAt: Scalars['DateTime'];
  1205. priceChange: Scalars['Int'];
  1206. note: Scalars['String'];
  1207. orderItems?: Maybe<Array<OrderItem>>;
  1208. surcharges?: Maybe<Array<Surcharge>>;
  1209. payment?: Maybe<Payment>;
  1210. refund?: Maybe<Refund>;
  1211. isSettled: Scalars['Boolean'];
  1212. };
  1213. export type UpdateOrderInput = {
  1214. id: Scalars['ID'];
  1215. customFields?: Maybe<Scalars['JSON']>;
  1216. };
  1217. export type FulfillOrderInput = {
  1218. lines: Array<OrderLineInput>;
  1219. handler: ConfigurableOperationInput;
  1220. };
  1221. export type CancelOrderInput = {
  1222. /** The id of the order to be cancelled */
  1223. orderId: Scalars['ID'];
  1224. /** Optionally specify which OrderLines to cancel. If not provided, all OrderLines will be cancelled */
  1225. lines?: Maybe<Array<OrderLineInput>>;
  1226. reason?: Maybe<Scalars['String']>;
  1227. };
  1228. export type RefundOrderInput = {
  1229. lines: Array<OrderLineInput>;
  1230. shipping: Scalars['Int'];
  1231. adjustment: Scalars['Int'];
  1232. paymentId: Scalars['ID'];
  1233. reason?: Maybe<Scalars['String']>;
  1234. };
  1235. export type OrderLineInput = {
  1236. orderLineId: Scalars['ID'];
  1237. quantity: Scalars['Int'];
  1238. };
  1239. export type SettleRefundInput = {
  1240. id: Scalars['ID'];
  1241. transactionId: Scalars['String'];
  1242. };
  1243. export type AddNoteToOrderInput = {
  1244. id: Scalars['ID'];
  1245. note: Scalars['String'];
  1246. isPublic: Scalars['Boolean'];
  1247. };
  1248. export type UpdateOrderNoteInput = {
  1249. noteId: Scalars['ID'];
  1250. note?: Maybe<Scalars['String']>;
  1251. isPublic?: Maybe<Scalars['Boolean']>;
  1252. };
  1253. export type AdministratorPaymentInput = {
  1254. paymentMethod?: Maybe<Scalars['String']>;
  1255. metadata?: Maybe<Scalars['JSON']>;
  1256. };
  1257. export type AdministratorRefundInput = {
  1258. paymentId: Scalars['ID'];
  1259. reason?: Maybe<Scalars['String']>;
  1260. };
  1261. export type ModifyOrderOptions = {
  1262. freezePromotions?: Maybe<Scalars['Boolean']>;
  1263. recalculateShipping?: Maybe<Scalars['Boolean']>;
  1264. };
  1265. export type UpdateOrderAddressInput = {
  1266. fullName?: Maybe<Scalars['String']>;
  1267. company?: Maybe<Scalars['String']>;
  1268. streetLine1?: Maybe<Scalars['String']>;
  1269. streetLine2?: Maybe<Scalars['String']>;
  1270. city?: Maybe<Scalars['String']>;
  1271. province?: Maybe<Scalars['String']>;
  1272. postalCode?: Maybe<Scalars['String']>;
  1273. countryCode?: Maybe<Scalars['String']>;
  1274. phoneNumber?: Maybe<Scalars['String']>;
  1275. };
  1276. export type ModifyOrderInput = {
  1277. dryRun: Scalars['Boolean'];
  1278. orderId: Scalars['ID'];
  1279. addItems?: Maybe<Array<AddItemInput>>;
  1280. adjustOrderLines?: Maybe<Array<AdjustOrderLineInput>>;
  1281. surcharges?: Maybe<Array<SurchargeInput>>;
  1282. updateShippingAddress?: Maybe<UpdateOrderAddressInput>;
  1283. updateBillingAddress?: Maybe<UpdateOrderAddressInput>;
  1284. note?: Maybe<Scalars['String']>;
  1285. refund?: Maybe<AdministratorRefundInput>;
  1286. options?: Maybe<ModifyOrderOptions>;
  1287. };
  1288. export type AddItemInput = {
  1289. productVariantId: Scalars['ID'];
  1290. quantity: Scalars['Int'];
  1291. };
  1292. export type AdjustOrderLineInput = {
  1293. orderLineId: Scalars['ID'];
  1294. quantity: Scalars['Int'];
  1295. };
  1296. export type SurchargeInput = {
  1297. description: Scalars['String'];
  1298. sku?: Maybe<Scalars['String']>;
  1299. price: Scalars['Int'];
  1300. priceIncludesTax: Scalars['Boolean'];
  1301. taxRate?: Maybe<Scalars['Float']>;
  1302. taxDescription?: Maybe<Scalars['String']>;
  1303. };
  1304. export type ManualPaymentInput = {
  1305. orderId: Scalars['ID'];
  1306. method: Scalars['String'];
  1307. transactionId?: Maybe<Scalars['String']>;
  1308. metadata?: Maybe<Scalars['JSON']>;
  1309. };
  1310. /** Returned if the Payment settlement fails */
  1311. export type SettlePaymentError = ErrorResult & {
  1312. __typename?: 'SettlePaymentError';
  1313. errorCode: ErrorCode;
  1314. message: Scalars['String'];
  1315. paymentErrorMessage: Scalars['String'];
  1316. };
  1317. /** Returned if no OrderLines have been specified for the operation */
  1318. export type EmptyOrderLineSelectionError = ErrorResult & {
  1319. __typename?: 'EmptyOrderLineSelectionError';
  1320. errorCode: ErrorCode;
  1321. message: Scalars['String'];
  1322. };
  1323. /** Returned if the specified items are already part of a Fulfillment */
  1324. export type ItemsAlreadyFulfilledError = ErrorResult & {
  1325. __typename?: 'ItemsAlreadyFulfilledError';
  1326. errorCode: ErrorCode;
  1327. message: Scalars['String'];
  1328. };
  1329. /** Returned if the specified FulfillmentHandler code is not valid */
  1330. export type InvalidFulfillmentHandlerError = ErrorResult & {
  1331. __typename?: 'InvalidFulfillmentHandlerError';
  1332. errorCode: ErrorCode;
  1333. message: Scalars['String'];
  1334. };
  1335. /** Returned if an error is thrown in a FulfillmentHandler's createFulfillment method */
  1336. export type CreateFulfillmentError = ErrorResult & {
  1337. __typename?: 'CreateFulfillmentError';
  1338. errorCode: ErrorCode;
  1339. message: Scalars['String'];
  1340. fulfillmentHandlerError: Scalars['String'];
  1341. };
  1342. /**
  1343. * Returned if attempting to create a Fulfillment when there is insufficient
  1344. * stockOnHand of a ProductVariant to satisfy the requested quantity.
  1345. */
  1346. export type InsufficientStockOnHandError = ErrorResult & {
  1347. __typename?: 'InsufficientStockOnHandError';
  1348. errorCode: ErrorCode;
  1349. message: Scalars['String'];
  1350. productVariantId: Scalars['ID'];
  1351. productVariantName: Scalars['String'];
  1352. stockOnHand: Scalars['Int'];
  1353. };
  1354. /** Returned if an operation has specified OrderLines from multiple Orders */
  1355. export type MultipleOrderError = ErrorResult & {
  1356. __typename?: 'MultipleOrderError';
  1357. errorCode: ErrorCode;
  1358. message: Scalars['String'];
  1359. };
  1360. /** Returned if an attempting to cancel lines from an Order which is still active */
  1361. export type CancelActiveOrderError = ErrorResult & {
  1362. __typename?: 'CancelActiveOrderError';
  1363. errorCode: ErrorCode;
  1364. message: Scalars['String'];
  1365. orderState: Scalars['String'];
  1366. };
  1367. /** Returned if an attempting to refund a Payment against OrderLines from a different Order */
  1368. export type PaymentOrderMismatchError = ErrorResult & {
  1369. __typename?: 'PaymentOrderMismatchError';
  1370. errorCode: ErrorCode;
  1371. message: Scalars['String'];
  1372. };
  1373. /** Returned if an attempting to refund an Order which is not in the expected state */
  1374. export type RefundOrderStateError = ErrorResult & {
  1375. __typename?: 'RefundOrderStateError';
  1376. errorCode: ErrorCode;
  1377. message: Scalars['String'];
  1378. orderState: Scalars['String'];
  1379. };
  1380. /** Returned if an attempting to refund an Order but neither items nor shipping refund was specified */
  1381. export type NothingToRefundError = ErrorResult & {
  1382. __typename?: 'NothingToRefundError';
  1383. errorCode: ErrorCode;
  1384. message: Scalars['String'];
  1385. };
  1386. /** Returned if an attempting to refund an OrderItem which has already been refunded */
  1387. export type AlreadyRefundedError = ErrorResult & {
  1388. __typename?: 'AlreadyRefundedError';
  1389. errorCode: ErrorCode;
  1390. message: Scalars['String'];
  1391. refundId: Scalars['ID'];
  1392. };
  1393. /** Returned if the specified quantity of an OrderLine is greater than the number of items in that line */
  1394. export type QuantityTooGreatError = ErrorResult & {
  1395. __typename?: 'QuantityTooGreatError';
  1396. errorCode: ErrorCode;
  1397. message: Scalars['String'];
  1398. };
  1399. /** Returned when there is an error in transitioning the Refund state */
  1400. export type RefundStateTransitionError = ErrorResult & {
  1401. __typename?: 'RefundStateTransitionError';
  1402. errorCode: ErrorCode;
  1403. message: Scalars['String'];
  1404. transitionError: Scalars['String'];
  1405. fromState: Scalars['String'];
  1406. toState: Scalars['String'];
  1407. };
  1408. /** Returned when there is an error in transitioning the Payment state */
  1409. export type PaymentStateTransitionError = ErrorResult & {
  1410. __typename?: 'PaymentStateTransitionError';
  1411. errorCode: ErrorCode;
  1412. message: Scalars['String'];
  1413. transitionError: Scalars['String'];
  1414. fromState: Scalars['String'];
  1415. toState: Scalars['String'];
  1416. };
  1417. /** Returned when there is an error in transitioning the Fulfillment state */
  1418. export type FulfillmentStateTransitionError = ErrorResult & {
  1419. __typename?: 'FulfillmentStateTransitionError';
  1420. errorCode: ErrorCode;
  1421. message: Scalars['String'];
  1422. transitionError: Scalars['String'];
  1423. fromState: Scalars['String'];
  1424. toState: Scalars['String'];
  1425. };
  1426. /** Returned when attempting to modify the contents of an Order that is not in the `Modifying` state. */
  1427. export type OrderModificationStateError = ErrorResult & {
  1428. __typename?: 'OrderModificationStateError';
  1429. errorCode: ErrorCode;
  1430. message: Scalars['String'];
  1431. };
  1432. /** Returned when a call to modifyOrder fails to specify any changes */
  1433. export type NoChangesSpecifiedError = ErrorResult & {
  1434. __typename?: 'NoChangesSpecifiedError';
  1435. errorCode: ErrorCode;
  1436. message: Scalars['String'];
  1437. };
  1438. /**
  1439. * Returned when a call to modifyOrder fails to include a paymentMethod even
  1440. * though the price has increased as a result of the changes.
  1441. */
  1442. export type PaymentMethodMissingError = ErrorResult & {
  1443. __typename?: 'PaymentMethodMissingError';
  1444. errorCode: ErrorCode;
  1445. message: Scalars['String'];
  1446. };
  1447. /**
  1448. * Returned when a call to modifyOrder fails to include a refundPaymentId even
  1449. * though the price has decreased as a result of the changes.
  1450. */
  1451. export type RefundPaymentIdMissingError = ErrorResult & {
  1452. __typename?: 'RefundPaymentIdMissingError';
  1453. errorCode: ErrorCode;
  1454. message: Scalars['String'];
  1455. };
  1456. /**
  1457. * Returned when a call to addManualPaymentToOrder is made but the Order
  1458. * is not in the required state.
  1459. */
  1460. export type ManualPaymentStateError = ErrorResult & {
  1461. __typename?: 'ManualPaymentStateError';
  1462. errorCode: ErrorCode;
  1463. message: Scalars['String'];
  1464. };
  1465. export type TransitionOrderToStateResult = Order | OrderStateTransitionError;
  1466. export type SettlePaymentResult = Payment | SettlePaymentError | PaymentStateTransitionError | OrderStateTransitionError;
  1467. export type AddFulfillmentToOrderResult = Fulfillment | EmptyOrderLineSelectionError | ItemsAlreadyFulfilledError | InsufficientStockOnHandError | InvalidFulfillmentHandlerError | FulfillmentStateTransitionError | CreateFulfillmentError;
  1468. export type CancelOrderResult = Order | EmptyOrderLineSelectionError | QuantityTooGreatError | MultipleOrderError | CancelActiveOrderError | OrderStateTransitionError;
  1469. export type RefundOrderResult = Refund | QuantityTooGreatError | NothingToRefundError | OrderStateTransitionError | MultipleOrderError | PaymentOrderMismatchError | RefundOrderStateError | AlreadyRefundedError | RefundStateTransitionError;
  1470. export type SettleRefundResult = Refund | RefundStateTransitionError;
  1471. export type TransitionFulfillmentToStateResult = Fulfillment | FulfillmentStateTransitionError;
  1472. export type ModifyOrderResult = Order | NoChangesSpecifiedError | OrderModificationStateError | PaymentMethodMissingError | RefundPaymentIdMissingError | OrderLimitError | NegativeQuantityError | InsufficientStockError;
  1473. export type AddManualPaymentToOrderResult = Order | ManualPaymentStateError;
  1474. export type PaymentMethodList = PaginatedList & {
  1475. __typename?: 'PaymentMethodList';
  1476. items: Array<PaymentMethod>;
  1477. totalItems: Scalars['Int'];
  1478. };
  1479. export type UpdatePaymentMethodInput = {
  1480. id: Scalars['ID'];
  1481. code?: Maybe<Scalars['String']>;
  1482. enabled?: Maybe<Scalars['Boolean']>;
  1483. configArgs?: Maybe<Array<ConfigArgInput>>;
  1484. };
  1485. export type PaymentMethod = Node & {
  1486. __typename?: 'PaymentMethod';
  1487. id: Scalars['ID'];
  1488. createdAt: Scalars['DateTime'];
  1489. updatedAt: Scalars['DateTime'];
  1490. code: Scalars['String'];
  1491. enabled: Scalars['Boolean'];
  1492. configArgs: Array<ConfigArg>;
  1493. definition: ConfigurableOperationDefinition;
  1494. };
  1495. export type Product = Node & {
  1496. __typename?: 'Product';
  1497. enabled: Scalars['Boolean'];
  1498. channels: Array<Channel>;
  1499. id: Scalars['ID'];
  1500. createdAt: Scalars['DateTime'];
  1501. updatedAt: Scalars['DateTime'];
  1502. languageCode: LanguageCode;
  1503. name: Scalars['String'];
  1504. slug: Scalars['String'];
  1505. description: Scalars['String'];
  1506. featuredAsset?: Maybe<Asset>;
  1507. assets: Array<Asset>;
  1508. variants: Array<ProductVariant>;
  1509. optionGroups: Array<ProductOptionGroup>;
  1510. facetValues: Array<FacetValue>;
  1511. translations: Array<ProductTranslation>;
  1512. collections: Array<Collection>;
  1513. customFields?: Maybe<Scalars['JSON']>;
  1514. };
  1515. export type ProductVariant = Node & {
  1516. __typename?: 'ProductVariant';
  1517. enabled: Scalars['Boolean'];
  1518. trackInventory: GlobalFlag;
  1519. stockOnHand: Scalars['Int'];
  1520. stockAllocated: Scalars['Int'];
  1521. outOfStockThreshold: Scalars['Int'];
  1522. useGlobalOutOfStockThreshold: Scalars['Boolean'];
  1523. stockMovements: StockMovementList;
  1524. channels: Array<Channel>;
  1525. id: Scalars['ID'];
  1526. product: Product;
  1527. productId: Scalars['ID'];
  1528. createdAt: Scalars['DateTime'];
  1529. updatedAt: Scalars['DateTime'];
  1530. languageCode: LanguageCode;
  1531. sku: Scalars['String'];
  1532. name: Scalars['String'];
  1533. featuredAsset?: Maybe<Asset>;
  1534. assets: Array<Asset>;
  1535. price: Scalars['Int'];
  1536. currencyCode: CurrencyCode;
  1537. /** @deprecated price now always excludes tax */
  1538. priceIncludesTax: Scalars['Boolean'];
  1539. priceWithTax: Scalars['Int'];
  1540. taxRateApplied: TaxRate;
  1541. taxCategory: TaxCategory;
  1542. options: Array<ProductOption>;
  1543. facetValues: Array<FacetValue>;
  1544. translations: Array<ProductVariantTranslation>;
  1545. customFields?: Maybe<Scalars['JSON']>;
  1546. };
  1547. export type ProductVariantStockMovementsArgs = {
  1548. options?: Maybe<StockMovementListOptions>;
  1549. };
  1550. export type ProductOptionGroupTranslationInput = {
  1551. id?: Maybe<Scalars['ID']>;
  1552. languageCode: LanguageCode;
  1553. name?: Maybe<Scalars['String']>;
  1554. customFields?: Maybe<Scalars['JSON']>;
  1555. };
  1556. export type CreateProductOptionGroupInput = {
  1557. code: Scalars['String'];
  1558. translations: Array<ProductOptionGroupTranslationInput>;
  1559. options: Array<CreateGroupOptionInput>;
  1560. customFields?: Maybe<Scalars['JSON']>;
  1561. };
  1562. export type UpdateProductOptionGroupInput = {
  1563. id: Scalars['ID'];
  1564. code?: Maybe<Scalars['String']>;
  1565. translations?: Maybe<Array<ProductOptionGroupTranslationInput>>;
  1566. customFields?: Maybe<Scalars['JSON']>;
  1567. };
  1568. export type ProductOptionTranslationInput = {
  1569. id?: Maybe<Scalars['ID']>;
  1570. languageCode: LanguageCode;
  1571. name?: Maybe<Scalars['String']>;
  1572. customFields?: Maybe<Scalars['JSON']>;
  1573. };
  1574. export type CreateGroupOptionInput = {
  1575. code: Scalars['String'];
  1576. translations: Array<ProductOptionGroupTranslationInput>;
  1577. };
  1578. export type CreateProductOptionInput = {
  1579. productOptionGroupId: Scalars['ID'];
  1580. code: Scalars['String'];
  1581. translations: Array<ProductOptionGroupTranslationInput>;
  1582. customFields?: Maybe<Scalars['JSON']>;
  1583. };
  1584. export type UpdateProductOptionInput = {
  1585. id: Scalars['ID'];
  1586. code?: Maybe<Scalars['String']>;
  1587. translations?: Maybe<Array<ProductOptionGroupTranslationInput>>;
  1588. customFields?: Maybe<Scalars['JSON']>;
  1589. };
  1590. export type SearchResult = {
  1591. __typename?: 'SearchResult';
  1592. enabled: Scalars['Boolean'];
  1593. /** An array of ids of the Channels in which this result appears */
  1594. channelIds: Array<Scalars['ID']>;
  1595. sku: Scalars['String'];
  1596. slug: Scalars['String'];
  1597. productId: Scalars['ID'];
  1598. productName: Scalars['String'];
  1599. /** @deprecated Use `productAsset.preview` instead */
  1600. productPreview: Scalars['String'];
  1601. productAsset?: Maybe<SearchResultAsset>;
  1602. productVariantId: Scalars['ID'];
  1603. productVariantName: Scalars['String'];
  1604. /** @deprecated Use `productVariantAsset.preview` instead */
  1605. productVariantPreview: Scalars['String'];
  1606. productVariantAsset?: Maybe<SearchResultAsset>;
  1607. price: SearchResultPrice;
  1608. priceWithTax: SearchResultPrice;
  1609. currencyCode: CurrencyCode;
  1610. description: Scalars['String'];
  1611. facetIds: Array<Scalars['ID']>;
  1612. facetValueIds: Array<Scalars['ID']>;
  1613. /** An array of ids of the Collections in which this result appears */
  1614. collectionIds: Array<Scalars['ID']>;
  1615. /** A relevence score for the result. Differs between database implementations */
  1616. score: Scalars['Float'];
  1617. };
  1618. export type StockMovementListOptions = {
  1619. type?: Maybe<StockMovementType>;
  1620. skip?: Maybe<Scalars['Int']>;
  1621. take?: Maybe<Scalars['Int']>;
  1622. };
  1623. export type ProductTranslationInput = {
  1624. id?: Maybe<Scalars['ID']>;
  1625. languageCode: LanguageCode;
  1626. name?: Maybe<Scalars['String']>;
  1627. slug?: Maybe<Scalars['String']>;
  1628. description?: Maybe<Scalars['String']>;
  1629. customFields?: Maybe<Scalars['JSON']>;
  1630. };
  1631. export type CreateProductInput = {
  1632. featuredAssetId?: Maybe<Scalars['ID']>;
  1633. enabled?: Maybe<Scalars['Boolean']>;
  1634. assetIds?: Maybe<Array<Scalars['ID']>>;
  1635. facetValueIds?: Maybe<Array<Scalars['ID']>>;
  1636. translations: Array<ProductTranslationInput>;
  1637. customFields?: Maybe<Scalars['JSON']>;
  1638. };
  1639. export type UpdateProductInput = {
  1640. id: Scalars['ID'];
  1641. enabled?: Maybe<Scalars['Boolean']>;
  1642. featuredAssetId?: Maybe<Scalars['ID']>;
  1643. assetIds?: Maybe<Array<Scalars['ID']>>;
  1644. facetValueIds?: Maybe<Array<Scalars['ID']>>;
  1645. translations?: Maybe<Array<ProductTranslationInput>>;
  1646. customFields?: Maybe<Scalars['JSON']>;
  1647. };
  1648. export type ProductVariantTranslationInput = {
  1649. id?: Maybe<Scalars['ID']>;
  1650. languageCode: LanguageCode;
  1651. name?: Maybe<Scalars['String']>;
  1652. customFields?: Maybe<Scalars['JSON']>;
  1653. };
  1654. export type CreateProductVariantOptionInput = {
  1655. optionGroupId: Scalars['ID'];
  1656. code: Scalars['String'];
  1657. translations: Array<ProductOptionTranslationInput>;
  1658. };
  1659. export type CreateProductVariantInput = {
  1660. productId: Scalars['ID'];
  1661. translations: Array<ProductVariantTranslationInput>;
  1662. facetValueIds?: Maybe<Array<Scalars['ID']>>;
  1663. sku: Scalars['String'];
  1664. price?: Maybe<Scalars['Int']>;
  1665. taxCategoryId?: Maybe<Scalars['ID']>;
  1666. optionIds?: Maybe<Array<Scalars['ID']>>;
  1667. featuredAssetId?: Maybe<Scalars['ID']>;
  1668. assetIds?: Maybe<Array<Scalars['ID']>>;
  1669. stockOnHand?: Maybe<Scalars['Int']>;
  1670. outOfStockThreshold?: Maybe<Scalars['Int']>;
  1671. useGlobalOutOfStockThreshold?: Maybe<Scalars['Boolean']>;
  1672. trackInventory?: Maybe<GlobalFlag>;
  1673. customFields?: Maybe<Scalars['JSON']>;
  1674. };
  1675. export type UpdateProductVariantInput = {
  1676. id: Scalars['ID'];
  1677. enabled?: Maybe<Scalars['Boolean']>;
  1678. translations?: Maybe<Array<ProductVariantTranslationInput>>;
  1679. facetValueIds?: Maybe<Array<Scalars['ID']>>;
  1680. sku?: Maybe<Scalars['String']>;
  1681. taxCategoryId?: Maybe<Scalars['ID']>;
  1682. price?: Maybe<Scalars['Int']>;
  1683. featuredAssetId?: Maybe<Scalars['ID']>;
  1684. assetIds?: Maybe<Array<Scalars['ID']>>;
  1685. stockOnHand?: Maybe<Scalars['Int']>;
  1686. outOfStockThreshold?: Maybe<Scalars['Int']>;
  1687. useGlobalOutOfStockThreshold?: Maybe<Scalars['Boolean']>;
  1688. trackInventory?: Maybe<GlobalFlag>;
  1689. customFields?: Maybe<Scalars['JSON']>;
  1690. };
  1691. export type AssignProductsToChannelInput = {
  1692. productIds: Array<Scalars['ID']>;
  1693. channelId: Scalars['ID'];
  1694. priceFactor?: Maybe<Scalars['Float']>;
  1695. };
  1696. export type RemoveProductsFromChannelInput = {
  1697. productIds: Array<Scalars['ID']>;
  1698. channelId: Scalars['ID'];
  1699. };
  1700. export type AssignProductVariantsToChannelInput = {
  1701. productVariantIds: Array<Scalars['ID']>;
  1702. channelId: Scalars['ID'];
  1703. priceFactor?: Maybe<Scalars['Float']>;
  1704. };
  1705. export type RemoveProductVariantsFromChannelInput = {
  1706. productVariantIds: Array<Scalars['ID']>;
  1707. channelId: Scalars['ID'];
  1708. };
  1709. export type ProductOptionInUseError = ErrorResult & {
  1710. __typename?: 'ProductOptionInUseError';
  1711. errorCode: ErrorCode;
  1712. message: Scalars['String'];
  1713. optionGroupCode: Scalars['String'];
  1714. productVariantCount: Scalars['Int'];
  1715. };
  1716. export type RemoveOptionGroupFromProductResult = Product | ProductOptionInUseError;
  1717. export type CreatePromotionInput = {
  1718. name: Scalars['String'];
  1719. enabled: Scalars['Boolean'];
  1720. startsAt?: Maybe<Scalars['DateTime']>;
  1721. endsAt?: Maybe<Scalars['DateTime']>;
  1722. couponCode?: Maybe<Scalars['String']>;
  1723. perCustomerUsageLimit?: Maybe<Scalars['Int']>;
  1724. conditions: Array<ConfigurableOperationInput>;
  1725. actions: Array<ConfigurableOperationInput>;
  1726. };
  1727. export type UpdatePromotionInput = {
  1728. id: Scalars['ID'];
  1729. name?: Maybe<Scalars['String']>;
  1730. enabled?: Maybe<Scalars['Boolean']>;
  1731. startsAt?: Maybe<Scalars['DateTime']>;
  1732. endsAt?: Maybe<Scalars['DateTime']>;
  1733. couponCode?: Maybe<Scalars['String']>;
  1734. perCustomerUsageLimit?: Maybe<Scalars['Int']>;
  1735. conditions?: Maybe<Array<ConfigurableOperationInput>>;
  1736. actions?: Maybe<Array<ConfigurableOperationInput>>;
  1737. };
  1738. /** Returned if a PromotionCondition has neither a couponCode nor any conditions set */
  1739. export type MissingConditionsError = ErrorResult & {
  1740. __typename?: 'MissingConditionsError';
  1741. errorCode: ErrorCode;
  1742. message: Scalars['String'];
  1743. };
  1744. export type CreatePromotionResult = Promotion | MissingConditionsError;
  1745. export type UpdatePromotionResult = Promotion | MissingConditionsError;
  1746. export type CreateRoleInput = {
  1747. code: Scalars['String'];
  1748. description: Scalars['String'];
  1749. permissions: Array<Permission>;
  1750. channelIds?: Maybe<Array<Scalars['ID']>>;
  1751. };
  1752. export type UpdateRoleInput = {
  1753. id: Scalars['ID'];
  1754. code?: Maybe<Scalars['String']>;
  1755. description?: Maybe<Scalars['String']>;
  1756. permissions?: Maybe<Array<Permission>>;
  1757. channelIds?: Maybe<Array<Scalars['ID']>>;
  1758. };
  1759. export type ShippingMethodTranslationInput = {
  1760. id?: Maybe<Scalars['ID']>;
  1761. languageCode: LanguageCode;
  1762. name?: Maybe<Scalars['String']>;
  1763. description?: Maybe<Scalars['String']>;
  1764. customFields?: Maybe<Scalars['JSON']>;
  1765. };
  1766. export type CreateShippingMethodInput = {
  1767. code: Scalars['String'];
  1768. fulfillmentHandler: Scalars['String'];
  1769. checker: ConfigurableOperationInput;
  1770. calculator: ConfigurableOperationInput;
  1771. translations: Array<ShippingMethodTranslationInput>;
  1772. customFields?: Maybe<Scalars['JSON']>;
  1773. };
  1774. export type UpdateShippingMethodInput = {
  1775. id: Scalars['ID'];
  1776. code?: Maybe<Scalars['String']>;
  1777. fulfillmentHandler?: Maybe<Scalars['String']>;
  1778. checker?: Maybe<ConfigurableOperationInput>;
  1779. calculator?: Maybe<ConfigurableOperationInput>;
  1780. translations: Array<ShippingMethodTranslationInput>;
  1781. customFields?: Maybe<Scalars['JSON']>;
  1782. };
  1783. export type TestShippingMethodInput = {
  1784. checker: ConfigurableOperationInput;
  1785. calculator: ConfigurableOperationInput;
  1786. shippingAddress: CreateAddressInput;
  1787. lines: Array<TestShippingMethodOrderLineInput>;
  1788. };
  1789. export type TestEligibleShippingMethodsInput = {
  1790. shippingAddress: CreateAddressInput;
  1791. lines: Array<TestShippingMethodOrderLineInput>;
  1792. };
  1793. export type TestShippingMethodOrderLineInput = {
  1794. productVariantId: Scalars['ID'];
  1795. quantity: Scalars['Int'];
  1796. };
  1797. export type TestShippingMethodResult = {
  1798. __typename?: 'TestShippingMethodResult';
  1799. eligible: Scalars['Boolean'];
  1800. quote?: Maybe<TestShippingMethodQuote>;
  1801. };
  1802. export type TestShippingMethodQuote = {
  1803. __typename?: 'TestShippingMethodQuote';
  1804. price: Scalars['Int'];
  1805. priceWithTax: Scalars['Int'];
  1806. metadata?: Maybe<Scalars['JSON']>;
  1807. };
  1808. export enum StockMovementType {
  1809. ADJUSTMENT = 'ADJUSTMENT',
  1810. ALLOCATION = 'ALLOCATION',
  1811. RELEASE = 'RELEASE',
  1812. SALE = 'SALE',
  1813. CANCELLATION = 'CANCELLATION',
  1814. RETURN = 'RETURN'
  1815. }
  1816. export type StockMovement = {
  1817. id: Scalars['ID'];
  1818. createdAt: Scalars['DateTime'];
  1819. updatedAt: Scalars['DateTime'];
  1820. productVariant: ProductVariant;
  1821. type: StockMovementType;
  1822. quantity: Scalars['Int'];
  1823. };
  1824. export type StockAdjustment = Node & StockMovement & {
  1825. __typename?: 'StockAdjustment';
  1826. id: Scalars['ID'];
  1827. createdAt: Scalars['DateTime'];
  1828. updatedAt: Scalars['DateTime'];
  1829. productVariant: ProductVariant;
  1830. type: StockMovementType;
  1831. quantity: Scalars['Int'];
  1832. };
  1833. export type Allocation = Node & StockMovement & {
  1834. __typename?: 'Allocation';
  1835. id: Scalars['ID'];
  1836. createdAt: Scalars['DateTime'];
  1837. updatedAt: Scalars['DateTime'];
  1838. productVariant: ProductVariant;
  1839. type: StockMovementType;
  1840. quantity: Scalars['Int'];
  1841. orderLine: OrderLine;
  1842. };
  1843. export type Sale = Node & StockMovement & {
  1844. __typename?: 'Sale';
  1845. id: Scalars['ID'];
  1846. createdAt: Scalars['DateTime'];
  1847. updatedAt: Scalars['DateTime'];
  1848. productVariant: ProductVariant;
  1849. type: StockMovementType;
  1850. quantity: Scalars['Int'];
  1851. orderItem: OrderItem;
  1852. };
  1853. export type Cancellation = Node & StockMovement & {
  1854. __typename?: 'Cancellation';
  1855. id: Scalars['ID'];
  1856. createdAt: Scalars['DateTime'];
  1857. updatedAt: Scalars['DateTime'];
  1858. productVariant: ProductVariant;
  1859. type: StockMovementType;
  1860. quantity: Scalars['Int'];
  1861. orderLine: OrderLine;
  1862. };
  1863. export type Return = Node & StockMovement & {
  1864. __typename?: 'Return';
  1865. id: Scalars['ID'];
  1866. createdAt: Scalars['DateTime'];
  1867. updatedAt: Scalars['DateTime'];
  1868. productVariant: ProductVariant;
  1869. type: StockMovementType;
  1870. quantity: Scalars['Int'];
  1871. orderItem: OrderItem;
  1872. };
  1873. export type Release = Node & StockMovement & {
  1874. __typename?: 'Release';
  1875. id: Scalars['ID'];
  1876. createdAt: Scalars['DateTime'];
  1877. updatedAt: Scalars['DateTime'];
  1878. productVariant: ProductVariant;
  1879. type: StockMovementType;
  1880. quantity: Scalars['Int'];
  1881. orderItem: OrderItem;
  1882. };
  1883. export type StockMovementItem = StockAdjustment | Allocation | Sale | Cancellation | Return | Release;
  1884. export type StockMovementList = {
  1885. __typename?: 'StockMovementList';
  1886. items: Array<StockMovementItem>;
  1887. totalItems: Scalars['Int'];
  1888. };
  1889. export type CreateTagInput = {
  1890. value: Scalars['String'];
  1891. };
  1892. export type UpdateTagInput = {
  1893. id: Scalars['ID'];
  1894. value?: Maybe<Scalars['String']>;
  1895. };
  1896. export type CreateTaxCategoryInput = {
  1897. name: Scalars['String'];
  1898. };
  1899. export type UpdateTaxCategoryInput = {
  1900. id: Scalars['ID'];
  1901. name?: Maybe<Scalars['String']>;
  1902. };
  1903. export type CreateTaxRateInput = {
  1904. name: Scalars['String'];
  1905. enabled: Scalars['Boolean'];
  1906. value: Scalars['Float'];
  1907. categoryId: Scalars['ID'];
  1908. zoneId: Scalars['ID'];
  1909. customerGroupId?: Maybe<Scalars['ID']>;
  1910. };
  1911. export type UpdateTaxRateInput = {
  1912. id: Scalars['ID'];
  1913. name?: Maybe<Scalars['String']>;
  1914. value?: Maybe<Scalars['Float']>;
  1915. enabled?: Maybe<Scalars['Boolean']>;
  1916. categoryId?: Maybe<Scalars['ID']>;
  1917. zoneId?: Maybe<Scalars['ID']>;
  1918. customerGroupId?: Maybe<Scalars['ID']>;
  1919. };
  1920. export type CreateZoneInput = {
  1921. name: Scalars['String'];
  1922. memberIds?: Maybe<Array<Scalars['ID']>>;
  1923. };
  1924. export type UpdateZoneInput = {
  1925. id: Scalars['ID'];
  1926. name?: Maybe<Scalars['String']>;
  1927. };
  1928. export type Address = Node & {
  1929. __typename?: 'Address';
  1930. id: Scalars['ID'];
  1931. createdAt: Scalars['DateTime'];
  1932. updatedAt: Scalars['DateTime'];
  1933. fullName?: Maybe<Scalars['String']>;
  1934. company?: Maybe<Scalars['String']>;
  1935. streetLine1: Scalars['String'];
  1936. streetLine2?: Maybe<Scalars['String']>;
  1937. city?: Maybe<Scalars['String']>;
  1938. province?: Maybe<Scalars['String']>;
  1939. postalCode?: Maybe<Scalars['String']>;
  1940. country: Country;
  1941. phoneNumber?: Maybe<Scalars['String']>;
  1942. defaultShippingAddress?: Maybe<Scalars['Boolean']>;
  1943. defaultBillingAddress?: Maybe<Scalars['Boolean']>;
  1944. customFields?: Maybe<Scalars['JSON']>;
  1945. };
  1946. export type Coordinate = {
  1947. __typename?: 'Coordinate';
  1948. x: Scalars['Float'];
  1949. y: Scalars['Float'];
  1950. };
  1951. export type AssetList = PaginatedList & {
  1952. __typename?: 'AssetList';
  1953. items: Array<Asset>;
  1954. totalItems: Scalars['Int'];
  1955. };
  1956. export enum AssetType {
  1957. IMAGE = 'IMAGE',
  1958. VIDEO = 'VIDEO',
  1959. BINARY = 'BINARY'
  1960. }
  1961. export type CurrentUser = {
  1962. __typename?: 'CurrentUser';
  1963. id: Scalars['ID'];
  1964. identifier: Scalars['String'];
  1965. channels: Array<CurrentUserChannel>;
  1966. };
  1967. export type CurrentUserChannel = {
  1968. __typename?: 'CurrentUserChannel';
  1969. id: Scalars['ID'];
  1970. token: Scalars['String'];
  1971. code: Scalars['String'];
  1972. permissions: Array<Permission>;
  1973. };
  1974. export type Channel = Node & {
  1975. __typename?: 'Channel';
  1976. id: Scalars['ID'];
  1977. createdAt: Scalars['DateTime'];
  1978. updatedAt: Scalars['DateTime'];
  1979. code: Scalars['String'];
  1980. token: Scalars['String'];
  1981. defaultTaxZone?: Maybe<Zone>;
  1982. defaultShippingZone?: Maybe<Zone>;
  1983. defaultLanguageCode: LanguageCode;
  1984. currencyCode: CurrencyCode;
  1985. pricesIncludeTax: Scalars['Boolean'];
  1986. };
  1987. export type CollectionBreadcrumb = {
  1988. __typename?: 'CollectionBreadcrumb';
  1989. id: Scalars['ID'];
  1990. name: Scalars['String'];
  1991. slug: Scalars['String'];
  1992. };
  1993. export type CollectionTranslation = {
  1994. __typename?: 'CollectionTranslation';
  1995. id: Scalars['ID'];
  1996. createdAt: Scalars['DateTime'];
  1997. updatedAt: Scalars['DateTime'];
  1998. languageCode: LanguageCode;
  1999. name: Scalars['String'];
  2000. slug: Scalars['String'];
  2001. description: Scalars['String'];
  2002. };
  2003. export type CollectionList = PaginatedList & {
  2004. __typename?: 'CollectionList';
  2005. items: Array<Collection>;
  2006. totalItems: Scalars['Int'];
  2007. };
  2008. export type ProductVariantList = PaginatedList & {
  2009. __typename?: 'ProductVariantList';
  2010. items: Array<ProductVariant>;
  2011. totalItems: Scalars['Int'];
  2012. };
  2013. export enum GlobalFlag {
  2014. TRUE = 'TRUE',
  2015. FALSE = 'FALSE',
  2016. INHERIT = 'INHERIT'
  2017. }
  2018. export enum AdjustmentType {
  2019. PROMOTION = 'PROMOTION',
  2020. DISTRIBUTED_ORDER_PROMOTION = 'DISTRIBUTED_ORDER_PROMOTION'
  2021. }
  2022. export enum DeletionResult {
  2023. /** The entity was successfully deleted */
  2024. DELETED = 'DELETED',
  2025. /** Deletion did not take place, reason given in message */
  2026. NOT_DELETED = 'NOT_DELETED'
  2027. }
  2028. /**
  2029. * @description
  2030. * Permissions for administrators and customers. Used to control access to
  2031. * GraphQL resolvers via the {@link Allow} decorator.
  2032. *
  2033. * @docsCategory common
  2034. */
  2035. export enum Permission {
  2036. /** Authenticated means simply that the user is logged in */
  2037. Authenticated = 'Authenticated',
  2038. /** SuperAdmin has unrestricted access to all operations */
  2039. SuperAdmin = 'SuperAdmin',
  2040. /** Owner means the user owns this entity, e.g. a Customer's own Order */
  2041. Owner = 'Owner',
  2042. /** Public means any unauthenticated user may perform the operation */
  2043. Public = 'Public',
  2044. /** Grants permission to create Catalog */
  2045. CreateCatalog = 'CreateCatalog',
  2046. /** Grants permission to read Catalog */
  2047. ReadCatalog = 'ReadCatalog',
  2048. /** Grants permission to update Catalog */
  2049. UpdateCatalog = 'UpdateCatalog',
  2050. /** Grants permission to delete Catalog */
  2051. DeleteCatalog = 'DeleteCatalog',
  2052. /** Grants permission to create Customer */
  2053. CreateCustomer = 'CreateCustomer',
  2054. /** Grants permission to read Customer */
  2055. ReadCustomer = 'ReadCustomer',
  2056. /** Grants permission to update Customer */
  2057. UpdateCustomer = 'UpdateCustomer',
  2058. /** Grants permission to delete Customer */
  2059. DeleteCustomer = 'DeleteCustomer',
  2060. /** Grants permission to create Administrator */
  2061. CreateAdministrator = 'CreateAdministrator',
  2062. /** Grants permission to read Administrator */
  2063. ReadAdministrator = 'ReadAdministrator',
  2064. /** Grants permission to update Administrator */
  2065. UpdateAdministrator = 'UpdateAdministrator',
  2066. /** Grants permission to delete Administrator */
  2067. DeleteAdministrator = 'DeleteAdministrator',
  2068. /** Grants permission to create Order */
  2069. CreateOrder = 'CreateOrder',
  2070. /** Grants permission to read Order */
  2071. ReadOrder = 'ReadOrder',
  2072. /** Grants permission to update Order */
  2073. UpdateOrder = 'UpdateOrder',
  2074. /** Grants permission to delete Order */
  2075. DeleteOrder = 'DeleteOrder',
  2076. /** Grants permission to create Promotion */
  2077. CreatePromotion = 'CreatePromotion',
  2078. /** Grants permission to read Promotion */
  2079. ReadPromotion = 'ReadPromotion',
  2080. /** Grants permission to update Promotion */
  2081. UpdatePromotion = 'UpdatePromotion',
  2082. /** Grants permission to delete Promotion */
  2083. DeletePromotion = 'DeletePromotion',
  2084. /** Grants permission to create Settings */
  2085. CreateSettings = 'CreateSettings',
  2086. /** Grants permission to read Settings */
  2087. ReadSettings = 'ReadSettings',
  2088. /** Grants permission to update Settings */
  2089. UpdateSettings = 'UpdateSettings',
  2090. /** Grants permission to delete Settings */
  2091. DeleteSettings = 'DeleteSettings'
  2092. }
  2093. export enum SortOrder {
  2094. ASC = 'ASC',
  2095. DESC = 'DESC'
  2096. }
  2097. export enum ErrorCode {
  2098. UNKNOWN_ERROR = 'UNKNOWN_ERROR',
  2099. MIME_TYPE_ERROR = 'MIME_TYPE_ERROR',
  2100. LANGUAGE_NOT_AVAILABLE_ERROR = 'LANGUAGE_NOT_AVAILABLE_ERROR',
  2101. CHANNEL_DEFAULT_LANGUAGE_ERROR = 'CHANNEL_DEFAULT_LANGUAGE_ERROR',
  2102. SETTLE_PAYMENT_ERROR = 'SETTLE_PAYMENT_ERROR',
  2103. EMPTY_ORDER_LINE_SELECTION_ERROR = 'EMPTY_ORDER_LINE_SELECTION_ERROR',
  2104. ITEMS_ALREADY_FULFILLED_ERROR = 'ITEMS_ALREADY_FULFILLED_ERROR',
  2105. INVALID_FULFILLMENT_HANDLER_ERROR = 'INVALID_FULFILLMENT_HANDLER_ERROR',
  2106. CREATE_FULFILLMENT_ERROR = 'CREATE_FULFILLMENT_ERROR',
  2107. INSUFFICIENT_STOCK_ON_HAND_ERROR = 'INSUFFICIENT_STOCK_ON_HAND_ERROR',
  2108. MULTIPLE_ORDER_ERROR = 'MULTIPLE_ORDER_ERROR',
  2109. CANCEL_ACTIVE_ORDER_ERROR = 'CANCEL_ACTIVE_ORDER_ERROR',
  2110. PAYMENT_ORDER_MISMATCH_ERROR = 'PAYMENT_ORDER_MISMATCH_ERROR',
  2111. REFUND_ORDER_STATE_ERROR = 'REFUND_ORDER_STATE_ERROR',
  2112. NOTHING_TO_REFUND_ERROR = 'NOTHING_TO_REFUND_ERROR',
  2113. ALREADY_REFUNDED_ERROR = 'ALREADY_REFUNDED_ERROR',
  2114. QUANTITY_TOO_GREAT_ERROR = 'QUANTITY_TOO_GREAT_ERROR',
  2115. REFUND_STATE_TRANSITION_ERROR = 'REFUND_STATE_TRANSITION_ERROR',
  2116. PAYMENT_STATE_TRANSITION_ERROR = 'PAYMENT_STATE_TRANSITION_ERROR',
  2117. FULFILLMENT_STATE_TRANSITION_ERROR = 'FULFILLMENT_STATE_TRANSITION_ERROR',
  2118. ORDER_MODIFICATION_STATE_ERROR = 'ORDER_MODIFICATION_STATE_ERROR',
  2119. NO_CHANGES_SPECIFIED_ERROR = 'NO_CHANGES_SPECIFIED_ERROR',
  2120. PAYMENT_METHOD_MISSING_ERROR = 'PAYMENT_METHOD_MISSING_ERROR',
  2121. REFUND_PAYMENT_ID_MISSING_ERROR = 'REFUND_PAYMENT_ID_MISSING_ERROR',
  2122. MANUAL_PAYMENT_STATE_ERROR = 'MANUAL_PAYMENT_STATE_ERROR',
  2123. PRODUCT_OPTION_IN_USE_ERROR = 'PRODUCT_OPTION_IN_USE_ERROR',
  2124. MISSING_CONDITIONS_ERROR = 'MISSING_CONDITIONS_ERROR',
  2125. NATIVE_AUTH_STRATEGY_ERROR = 'NATIVE_AUTH_STRATEGY_ERROR',
  2126. INVALID_CREDENTIALS_ERROR = 'INVALID_CREDENTIALS_ERROR',
  2127. ORDER_STATE_TRANSITION_ERROR = 'ORDER_STATE_TRANSITION_ERROR',
  2128. EMAIL_ADDRESS_CONFLICT_ERROR = 'EMAIL_ADDRESS_CONFLICT_ERROR',
  2129. ORDER_LIMIT_ERROR = 'ORDER_LIMIT_ERROR',
  2130. NEGATIVE_QUANTITY_ERROR = 'NEGATIVE_QUANTITY_ERROR',
  2131. INSUFFICIENT_STOCK_ERROR = 'INSUFFICIENT_STOCK_ERROR'
  2132. }
  2133. export enum LogicalOperator {
  2134. AND = 'AND',
  2135. OR = 'OR'
  2136. }
  2137. /** Retured when attempting an operation that relies on the NativeAuthStrategy, if that strategy is not configured. */
  2138. export type NativeAuthStrategyError = ErrorResult & {
  2139. __typename?: 'NativeAuthStrategyError';
  2140. errorCode: ErrorCode;
  2141. message: Scalars['String'];
  2142. };
  2143. /** Returned if the user authentication credentials are not valid */
  2144. export type InvalidCredentialsError = ErrorResult & {
  2145. __typename?: 'InvalidCredentialsError';
  2146. errorCode: ErrorCode;
  2147. message: Scalars['String'];
  2148. authenticationError: Scalars['String'];
  2149. };
  2150. /** Returned if there is an error in transitioning the Order state */
  2151. export type OrderStateTransitionError = ErrorResult & {
  2152. __typename?: 'OrderStateTransitionError';
  2153. errorCode: ErrorCode;
  2154. message: Scalars['String'];
  2155. transitionError: Scalars['String'];
  2156. fromState: Scalars['String'];
  2157. toState: Scalars['String'];
  2158. };
  2159. /** Retured when attemting to create a Customer with an email address already registered to an existing User. */
  2160. export type EmailAddressConflictError = ErrorResult & {
  2161. __typename?: 'EmailAddressConflictError';
  2162. errorCode: ErrorCode;
  2163. message: Scalars['String'];
  2164. };
  2165. /** Retured when the maximum order size limit has been reached. */
  2166. export type OrderLimitError = ErrorResult & {
  2167. __typename?: 'OrderLimitError';
  2168. errorCode: ErrorCode;
  2169. message: Scalars['String'];
  2170. maxItems: Scalars['Int'];
  2171. };
  2172. /** Retured when attemting to set a negative OrderLine quantity. */
  2173. export type NegativeQuantityError = ErrorResult & {
  2174. __typename?: 'NegativeQuantityError';
  2175. errorCode: ErrorCode;
  2176. message: Scalars['String'];
  2177. };
  2178. /** Returned when attempting to add more items to the Order than are available */
  2179. export type InsufficientStockError = ErrorResult & {
  2180. __typename?: 'InsufficientStockError';
  2181. errorCode: ErrorCode;
  2182. message: Scalars['String'];
  2183. quantityAvailable: Scalars['Int'];
  2184. order: Order;
  2185. };
  2186. export type PaginatedList = {
  2187. items: Array<Node>;
  2188. totalItems: Scalars['Int'];
  2189. };
  2190. export type Node = {
  2191. id: Scalars['ID'];
  2192. };
  2193. export type ErrorResult = {
  2194. errorCode: ErrorCode;
  2195. message: Scalars['String'];
  2196. };
  2197. export type Adjustment = {
  2198. __typename?: 'Adjustment';
  2199. adjustmentSource: Scalars['String'];
  2200. type: AdjustmentType;
  2201. description: Scalars['String'];
  2202. amount: Scalars['Int'];
  2203. };
  2204. export type TaxLine = {
  2205. __typename?: 'TaxLine';
  2206. description: Scalars['String'];
  2207. taxRate: Scalars['Float'];
  2208. };
  2209. export type ConfigArg = {
  2210. __typename?: 'ConfigArg';
  2211. name: Scalars['String'];
  2212. value: Scalars['String'];
  2213. };
  2214. export type ConfigArgDefinition = {
  2215. __typename?: 'ConfigArgDefinition';
  2216. name: Scalars['String'];
  2217. type: Scalars['String'];
  2218. list: Scalars['Boolean'];
  2219. label?: Maybe<Scalars['String']>;
  2220. description?: Maybe<Scalars['String']>;
  2221. ui?: Maybe<Scalars['JSON']>;
  2222. };
  2223. export type ConfigurableOperation = {
  2224. __typename?: 'ConfigurableOperation';
  2225. code: Scalars['String'];
  2226. args: Array<ConfigArg>;
  2227. };
  2228. export type ConfigurableOperationDefinition = {
  2229. __typename?: 'ConfigurableOperationDefinition';
  2230. code: Scalars['String'];
  2231. args: Array<ConfigArgDefinition>;
  2232. description: Scalars['String'];
  2233. };
  2234. export type DeletionResponse = {
  2235. __typename?: 'DeletionResponse';
  2236. result: DeletionResult;
  2237. message?: Maybe<Scalars['String']>;
  2238. };
  2239. export type ConfigArgInput = {
  2240. name: Scalars['String'];
  2241. value: Scalars['String'];
  2242. };
  2243. export type ConfigurableOperationInput = {
  2244. code: Scalars['String'];
  2245. arguments: Array<ConfigArgInput>;
  2246. };
  2247. export type StringOperators = {
  2248. eq?: Maybe<Scalars['String']>;
  2249. notEq?: Maybe<Scalars['String']>;
  2250. contains?: Maybe<Scalars['String']>;
  2251. notContains?: Maybe<Scalars['String']>;
  2252. in?: Maybe<Array<Scalars['String']>>;
  2253. notIn?: Maybe<Array<Scalars['String']>>;
  2254. regex?: Maybe<Scalars['String']>;
  2255. };
  2256. export type BooleanOperators = {
  2257. eq?: Maybe<Scalars['Boolean']>;
  2258. };
  2259. export type NumberRange = {
  2260. start: Scalars['Float'];
  2261. end: Scalars['Float'];
  2262. };
  2263. export type NumberOperators = {
  2264. eq?: Maybe<Scalars['Float']>;
  2265. lt?: Maybe<Scalars['Float']>;
  2266. lte?: Maybe<Scalars['Float']>;
  2267. gt?: Maybe<Scalars['Float']>;
  2268. gte?: Maybe<Scalars['Float']>;
  2269. between?: Maybe<NumberRange>;
  2270. };
  2271. export type DateRange = {
  2272. start: Scalars['DateTime'];
  2273. end: Scalars['DateTime'];
  2274. };
  2275. export type DateOperators = {
  2276. eq?: Maybe<Scalars['DateTime']>;
  2277. before?: Maybe<Scalars['DateTime']>;
  2278. after?: Maybe<Scalars['DateTime']>;
  2279. between?: Maybe<DateRange>;
  2280. };
  2281. export type SearchInput = {
  2282. term?: Maybe<Scalars['String']>;
  2283. facetValueIds?: Maybe<Array<Scalars['ID']>>;
  2284. facetValueOperator?: Maybe<LogicalOperator>;
  2285. collectionId?: Maybe<Scalars['ID']>;
  2286. collectionSlug?: Maybe<Scalars['String']>;
  2287. groupByProduct?: Maybe<Scalars['Boolean']>;
  2288. take?: Maybe<Scalars['Int']>;
  2289. skip?: Maybe<Scalars['Int']>;
  2290. sort?: Maybe<SearchResultSortParameter>;
  2291. };
  2292. export type SearchResultSortParameter = {
  2293. name?: Maybe<SortOrder>;
  2294. price?: Maybe<SortOrder>;
  2295. };
  2296. export type CreateCustomerInput = {
  2297. title?: Maybe<Scalars['String']>;
  2298. firstName: Scalars['String'];
  2299. lastName: Scalars['String'];
  2300. phoneNumber?: Maybe<Scalars['String']>;
  2301. emailAddress: Scalars['String'];
  2302. customFields?: Maybe<Scalars['JSON']>;
  2303. };
  2304. export type CreateAddressInput = {
  2305. fullName?: Maybe<Scalars['String']>;
  2306. company?: Maybe<Scalars['String']>;
  2307. streetLine1: Scalars['String'];
  2308. streetLine2?: Maybe<Scalars['String']>;
  2309. city?: Maybe<Scalars['String']>;
  2310. province?: Maybe<Scalars['String']>;
  2311. postalCode?: Maybe<Scalars['String']>;
  2312. countryCode: Scalars['String'];
  2313. phoneNumber?: Maybe<Scalars['String']>;
  2314. defaultShippingAddress?: Maybe<Scalars['Boolean']>;
  2315. defaultBillingAddress?: Maybe<Scalars['Boolean']>;
  2316. customFields?: Maybe<Scalars['JSON']>;
  2317. };
  2318. export type UpdateAddressInput = {
  2319. id: Scalars['ID'];
  2320. fullName?: Maybe<Scalars['String']>;
  2321. company?: Maybe<Scalars['String']>;
  2322. streetLine1?: Maybe<Scalars['String']>;
  2323. streetLine2?: Maybe<Scalars['String']>;
  2324. city?: Maybe<Scalars['String']>;
  2325. province?: Maybe<Scalars['String']>;
  2326. postalCode?: Maybe<Scalars['String']>;
  2327. countryCode?: Maybe<Scalars['String']>;
  2328. phoneNumber?: Maybe<Scalars['String']>;
  2329. defaultShippingAddress?: Maybe<Scalars['Boolean']>;
  2330. defaultBillingAddress?: Maybe<Scalars['Boolean']>;
  2331. customFields?: Maybe<Scalars['JSON']>;
  2332. };
  2333. /** Indicates that an operation succeeded, where we do not want to return any more specific information. */
  2334. export type Success = {
  2335. __typename?: 'Success';
  2336. success: Scalars['Boolean'];
  2337. };
  2338. export type Country = Node & {
  2339. __typename?: 'Country';
  2340. id: Scalars['ID'];
  2341. createdAt: Scalars['DateTime'];
  2342. updatedAt: Scalars['DateTime'];
  2343. languageCode: LanguageCode;
  2344. code: Scalars['String'];
  2345. name: Scalars['String'];
  2346. enabled: Scalars['Boolean'];
  2347. translations: Array<CountryTranslation>;
  2348. };
  2349. export type CountryTranslation = {
  2350. __typename?: 'CountryTranslation';
  2351. id: Scalars['ID'];
  2352. createdAt: Scalars['DateTime'];
  2353. updatedAt: Scalars['DateTime'];
  2354. languageCode: LanguageCode;
  2355. name: Scalars['String'];
  2356. };
  2357. export type CountryList = PaginatedList & {
  2358. __typename?: 'CountryList';
  2359. items: Array<Country>;
  2360. totalItems: Scalars['Int'];
  2361. };
  2362. /**
  2363. * @description
  2364. * ISO 4217 currency code
  2365. *
  2366. * @docsCategory common
  2367. */
  2368. export enum CurrencyCode {
  2369. /** United Arab Emirates dirham */
  2370. AED = 'AED',
  2371. /** Afghan afghani */
  2372. AFN = 'AFN',
  2373. /** Albanian lek */
  2374. ALL = 'ALL',
  2375. /** Armenian dram */
  2376. AMD = 'AMD',
  2377. /** Netherlands Antillean guilder */
  2378. ANG = 'ANG',
  2379. /** Angolan kwanza */
  2380. AOA = 'AOA',
  2381. /** Argentine peso */
  2382. ARS = 'ARS',
  2383. /** Australian dollar */
  2384. AUD = 'AUD',
  2385. /** Aruban florin */
  2386. AWG = 'AWG',
  2387. /** Azerbaijani manat */
  2388. AZN = 'AZN',
  2389. /** Bosnia and Herzegovina convertible mark */
  2390. BAM = 'BAM',
  2391. /** Barbados dollar */
  2392. BBD = 'BBD',
  2393. /** Bangladeshi taka */
  2394. BDT = 'BDT',
  2395. /** Bulgarian lev */
  2396. BGN = 'BGN',
  2397. /** Bahraini dinar */
  2398. BHD = 'BHD',
  2399. /** Burundian franc */
  2400. BIF = 'BIF',
  2401. /** Bermudian dollar */
  2402. BMD = 'BMD',
  2403. /** Brunei dollar */
  2404. BND = 'BND',
  2405. /** Boliviano */
  2406. BOB = 'BOB',
  2407. /** Brazilian real */
  2408. BRL = 'BRL',
  2409. /** Bahamian dollar */
  2410. BSD = 'BSD',
  2411. /** Bhutanese ngultrum */
  2412. BTN = 'BTN',
  2413. /** Botswana pula */
  2414. BWP = 'BWP',
  2415. /** Belarusian ruble */
  2416. BYN = 'BYN',
  2417. /** Belize dollar */
  2418. BZD = 'BZD',
  2419. /** Canadian dollar */
  2420. CAD = 'CAD',
  2421. /** Congolese franc */
  2422. CDF = 'CDF',
  2423. /** Swiss franc */
  2424. CHF = 'CHF',
  2425. /** Chilean peso */
  2426. CLP = 'CLP',
  2427. /** Renminbi (Chinese) yuan */
  2428. CNY = 'CNY',
  2429. /** Colombian peso */
  2430. COP = 'COP',
  2431. /** Costa Rican colon */
  2432. CRC = 'CRC',
  2433. /** Cuban convertible peso */
  2434. CUC = 'CUC',
  2435. /** Cuban peso */
  2436. CUP = 'CUP',
  2437. /** Cape Verde escudo */
  2438. CVE = 'CVE',
  2439. /** Czech koruna */
  2440. CZK = 'CZK',
  2441. /** Djiboutian franc */
  2442. DJF = 'DJF',
  2443. /** Danish krone */
  2444. DKK = 'DKK',
  2445. /** Dominican peso */
  2446. DOP = 'DOP',
  2447. /** Algerian dinar */
  2448. DZD = 'DZD',
  2449. /** Egyptian pound */
  2450. EGP = 'EGP',
  2451. /** Eritrean nakfa */
  2452. ERN = 'ERN',
  2453. /** Ethiopian birr */
  2454. ETB = 'ETB',
  2455. /** Euro */
  2456. EUR = 'EUR',
  2457. /** Fiji dollar */
  2458. FJD = 'FJD',
  2459. /** Falkland Islands pound */
  2460. FKP = 'FKP',
  2461. /** Pound sterling */
  2462. GBP = 'GBP',
  2463. /** Georgian lari */
  2464. GEL = 'GEL',
  2465. /** Ghanaian cedi */
  2466. GHS = 'GHS',
  2467. /** Gibraltar pound */
  2468. GIP = 'GIP',
  2469. /** Gambian dalasi */
  2470. GMD = 'GMD',
  2471. /** Guinean franc */
  2472. GNF = 'GNF',
  2473. /** Guatemalan quetzal */
  2474. GTQ = 'GTQ',
  2475. /** Guyanese dollar */
  2476. GYD = 'GYD',
  2477. /** Hong Kong dollar */
  2478. HKD = 'HKD',
  2479. /** Honduran lempira */
  2480. HNL = 'HNL',
  2481. /** Croatian kuna */
  2482. HRK = 'HRK',
  2483. /** Haitian gourde */
  2484. HTG = 'HTG',
  2485. /** Hungarian forint */
  2486. HUF = 'HUF',
  2487. /** Indonesian rupiah */
  2488. IDR = 'IDR',
  2489. /** Israeli new shekel */
  2490. ILS = 'ILS',
  2491. /** Indian rupee */
  2492. INR = 'INR',
  2493. /** Iraqi dinar */
  2494. IQD = 'IQD',
  2495. /** Iranian rial */
  2496. IRR = 'IRR',
  2497. /** Icelandic króna */
  2498. ISK = 'ISK',
  2499. /** Jamaican dollar */
  2500. JMD = 'JMD',
  2501. /** Jordanian dinar */
  2502. JOD = 'JOD',
  2503. /** Japanese yen */
  2504. JPY = 'JPY',
  2505. /** Kenyan shilling */
  2506. KES = 'KES',
  2507. /** Kyrgyzstani som */
  2508. KGS = 'KGS',
  2509. /** Cambodian riel */
  2510. KHR = 'KHR',
  2511. /** Comoro franc */
  2512. KMF = 'KMF',
  2513. /** North Korean won */
  2514. KPW = 'KPW',
  2515. /** South Korean won */
  2516. KRW = 'KRW',
  2517. /** Kuwaiti dinar */
  2518. KWD = 'KWD',
  2519. /** Cayman Islands dollar */
  2520. KYD = 'KYD',
  2521. /** Kazakhstani tenge */
  2522. KZT = 'KZT',
  2523. /** Lao kip */
  2524. LAK = 'LAK',
  2525. /** Lebanese pound */
  2526. LBP = 'LBP',
  2527. /** Sri Lankan rupee */
  2528. LKR = 'LKR',
  2529. /** Liberian dollar */
  2530. LRD = 'LRD',
  2531. /** Lesotho loti */
  2532. LSL = 'LSL',
  2533. /** Libyan dinar */
  2534. LYD = 'LYD',
  2535. /** Moroccan dirham */
  2536. MAD = 'MAD',
  2537. /** Moldovan leu */
  2538. MDL = 'MDL',
  2539. /** Malagasy ariary */
  2540. MGA = 'MGA',
  2541. /** Macedonian denar */
  2542. MKD = 'MKD',
  2543. /** Myanmar kyat */
  2544. MMK = 'MMK',
  2545. /** Mongolian tögrög */
  2546. MNT = 'MNT',
  2547. /** Macanese pataca */
  2548. MOP = 'MOP',
  2549. /** Mauritanian ouguiya */
  2550. MRU = 'MRU',
  2551. /** Mauritian rupee */
  2552. MUR = 'MUR',
  2553. /** Maldivian rufiyaa */
  2554. MVR = 'MVR',
  2555. /** Malawian kwacha */
  2556. MWK = 'MWK',
  2557. /** Mexican peso */
  2558. MXN = 'MXN',
  2559. /** Malaysian ringgit */
  2560. MYR = 'MYR',
  2561. /** Mozambican metical */
  2562. MZN = 'MZN',
  2563. /** Namibian dollar */
  2564. NAD = 'NAD',
  2565. /** Nigerian naira */
  2566. NGN = 'NGN',
  2567. /** Nicaraguan córdoba */
  2568. NIO = 'NIO',
  2569. /** Norwegian krone */
  2570. NOK = 'NOK',
  2571. /** Nepalese rupee */
  2572. NPR = 'NPR',
  2573. /** New Zealand dollar */
  2574. NZD = 'NZD',
  2575. /** Omani rial */
  2576. OMR = 'OMR',
  2577. /** Panamanian balboa */
  2578. PAB = 'PAB',
  2579. /** Peruvian sol */
  2580. PEN = 'PEN',
  2581. /** Papua New Guinean kina */
  2582. PGK = 'PGK',
  2583. /** Philippine peso */
  2584. PHP = 'PHP',
  2585. /** Pakistani rupee */
  2586. PKR = 'PKR',
  2587. /** Polish złoty */
  2588. PLN = 'PLN',
  2589. /** Paraguayan guaraní */
  2590. PYG = 'PYG',
  2591. /** Qatari riyal */
  2592. QAR = 'QAR',
  2593. /** Romanian leu */
  2594. RON = 'RON',
  2595. /** Serbian dinar */
  2596. RSD = 'RSD',
  2597. /** Russian ruble */
  2598. RUB = 'RUB',
  2599. /** Rwandan franc */
  2600. RWF = 'RWF',
  2601. /** Saudi riyal */
  2602. SAR = 'SAR',
  2603. /** Solomon Islands dollar */
  2604. SBD = 'SBD',
  2605. /** Seychelles rupee */
  2606. SCR = 'SCR',
  2607. /** Sudanese pound */
  2608. SDG = 'SDG',
  2609. /** Swedish krona/kronor */
  2610. SEK = 'SEK',
  2611. /** Singapore dollar */
  2612. SGD = 'SGD',
  2613. /** Saint Helena pound */
  2614. SHP = 'SHP',
  2615. /** Sierra Leonean leone */
  2616. SLL = 'SLL',
  2617. /** Somali shilling */
  2618. SOS = 'SOS',
  2619. /** Surinamese dollar */
  2620. SRD = 'SRD',
  2621. /** South Sudanese pound */
  2622. SSP = 'SSP',
  2623. /** São Tomé and Príncipe dobra */
  2624. STN = 'STN',
  2625. /** Salvadoran colón */
  2626. SVC = 'SVC',
  2627. /** Syrian pound */
  2628. SYP = 'SYP',
  2629. /** Swazi lilangeni */
  2630. SZL = 'SZL',
  2631. /** Thai baht */
  2632. THB = 'THB',
  2633. /** Tajikistani somoni */
  2634. TJS = 'TJS',
  2635. /** Turkmenistan manat */
  2636. TMT = 'TMT',
  2637. /** Tunisian dinar */
  2638. TND = 'TND',
  2639. /** Tongan paʻanga */
  2640. TOP = 'TOP',
  2641. /** Turkish lira */
  2642. TRY = 'TRY',
  2643. /** Trinidad and Tobago dollar */
  2644. TTD = 'TTD',
  2645. /** New Taiwan dollar */
  2646. TWD = 'TWD',
  2647. /** Tanzanian shilling */
  2648. TZS = 'TZS',
  2649. /** Ukrainian hryvnia */
  2650. UAH = 'UAH',
  2651. /** Ugandan shilling */
  2652. UGX = 'UGX',
  2653. /** United States dollar */
  2654. USD = 'USD',
  2655. /** Uruguayan peso */
  2656. UYU = 'UYU',
  2657. /** Uzbekistan som */
  2658. UZS = 'UZS',
  2659. /** Venezuelan bolívar soberano */
  2660. VES = 'VES',
  2661. /** Vietnamese đồng */
  2662. VND = 'VND',
  2663. /** Vanuatu vatu */
  2664. VUV = 'VUV',
  2665. /** Samoan tala */
  2666. WST = 'WST',
  2667. /** CFA franc BEAC */
  2668. XAF = 'XAF',
  2669. /** East Caribbean dollar */
  2670. XCD = 'XCD',
  2671. /** CFA franc BCEAO */
  2672. XOF = 'XOF',
  2673. /** CFP franc (franc Pacifique) */
  2674. XPF = 'XPF',
  2675. /** Yemeni rial */
  2676. YER = 'YER',
  2677. /** South African rand */
  2678. ZAR = 'ZAR',
  2679. /** Zambian kwacha */
  2680. ZMW = 'ZMW',
  2681. /** Zimbabwean dollar */
  2682. ZWL = 'ZWL'
  2683. }
  2684. export type CustomField = {
  2685. name: Scalars['String'];
  2686. type: Scalars['String'];
  2687. list: Scalars['Boolean'];
  2688. label?: Maybe<Array<LocalizedString>>;
  2689. description?: Maybe<Array<LocalizedString>>;
  2690. readonly?: Maybe<Scalars['Boolean']>;
  2691. internal?: Maybe<Scalars['Boolean']>;
  2692. };
  2693. export type StringCustomFieldConfig = CustomField & {
  2694. __typename?: 'StringCustomFieldConfig';
  2695. name: Scalars['String'];
  2696. type: Scalars['String'];
  2697. list: Scalars['Boolean'];
  2698. length?: Maybe<Scalars['Int']>;
  2699. label?: Maybe<Array<LocalizedString>>;
  2700. description?: Maybe<Array<LocalizedString>>;
  2701. readonly?: Maybe<Scalars['Boolean']>;
  2702. internal?: Maybe<Scalars['Boolean']>;
  2703. pattern?: Maybe<Scalars['String']>;
  2704. options?: Maybe<Array<StringFieldOption>>;
  2705. };
  2706. export type StringFieldOption = {
  2707. __typename?: 'StringFieldOption';
  2708. value: Scalars['String'];
  2709. label?: Maybe<Array<LocalizedString>>;
  2710. };
  2711. export type LocaleStringCustomFieldConfig = CustomField & {
  2712. __typename?: 'LocaleStringCustomFieldConfig';
  2713. name: Scalars['String'];
  2714. type: Scalars['String'];
  2715. list: Scalars['Boolean'];
  2716. length?: Maybe<Scalars['Int']>;
  2717. label?: Maybe<Array<LocalizedString>>;
  2718. description?: Maybe<Array<LocalizedString>>;
  2719. readonly?: Maybe<Scalars['Boolean']>;
  2720. internal?: Maybe<Scalars['Boolean']>;
  2721. pattern?: Maybe<Scalars['String']>;
  2722. };
  2723. export type IntCustomFieldConfig = CustomField & {
  2724. __typename?: 'IntCustomFieldConfig';
  2725. name: Scalars['String'];
  2726. type: Scalars['String'];
  2727. list: Scalars['Boolean'];
  2728. label?: Maybe<Array<LocalizedString>>;
  2729. description?: Maybe<Array<LocalizedString>>;
  2730. readonly?: Maybe<Scalars['Boolean']>;
  2731. internal?: Maybe<Scalars['Boolean']>;
  2732. min?: Maybe<Scalars['Int']>;
  2733. max?: Maybe<Scalars['Int']>;
  2734. step?: Maybe<Scalars['Int']>;
  2735. };
  2736. export type FloatCustomFieldConfig = CustomField & {
  2737. __typename?: 'FloatCustomFieldConfig';
  2738. name: Scalars['String'];
  2739. type: Scalars['String'];
  2740. list: Scalars['Boolean'];
  2741. label?: Maybe<Array<LocalizedString>>;
  2742. description?: Maybe<Array<LocalizedString>>;
  2743. readonly?: Maybe<Scalars['Boolean']>;
  2744. internal?: Maybe<Scalars['Boolean']>;
  2745. min?: Maybe<Scalars['Float']>;
  2746. max?: Maybe<Scalars['Float']>;
  2747. step?: Maybe<Scalars['Float']>;
  2748. };
  2749. export type BooleanCustomFieldConfig = CustomField & {
  2750. __typename?: 'BooleanCustomFieldConfig';
  2751. name: Scalars['String'];
  2752. type: Scalars['String'];
  2753. list: Scalars['Boolean'];
  2754. label?: Maybe<Array<LocalizedString>>;
  2755. description?: Maybe<Array<LocalizedString>>;
  2756. readonly?: Maybe<Scalars['Boolean']>;
  2757. internal?: Maybe<Scalars['Boolean']>;
  2758. };
  2759. /**
  2760. * Expects the same validation formats as the `<input type="datetime-local">` HTML element.
  2761. * See https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input/datetime-local#Additional_attributes
  2762. */
  2763. export type DateTimeCustomFieldConfig = CustomField & {
  2764. __typename?: 'DateTimeCustomFieldConfig';
  2765. name: Scalars['String'];
  2766. type: Scalars['String'];
  2767. list: Scalars['Boolean'];
  2768. label?: Maybe<Array<LocalizedString>>;
  2769. description?: Maybe<Array<LocalizedString>>;
  2770. readonly?: Maybe<Scalars['Boolean']>;
  2771. internal?: Maybe<Scalars['Boolean']>;
  2772. min?: Maybe<Scalars['String']>;
  2773. max?: Maybe<Scalars['String']>;
  2774. step?: Maybe<Scalars['Int']>;
  2775. };
  2776. export type RelationCustomFieldConfig = CustomField & {
  2777. __typename?: 'RelationCustomFieldConfig';
  2778. name: Scalars['String'];
  2779. type: Scalars['String'];
  2780. list: Scalars['Boolean'];
  2781. label?: Maybe<Array<LocalizedString>>;
  2782. description?: Maybe<Array<LocalizedString>>;
  2783. readonly?: Maybe<Scalars['Boolean']>;
  2784. internal?: Maybe<Scalars['Boolean']>;
  2785. entity: Scalars['String'];
  2786. scalarFields: Array<Scalars['String']>;
  2787. };
  2788. export type LocalizedString = {
  2789. __typename?: 'LocalizedString';
  2790. languageCode: LanguageCode;
  2791. value: Scalars['String'];
  2792. };
  2793. export type CustomFieldConfig = StringCustomFieldConfig | LocaleStringCustomFieldConfig | IntCustomFieldConfig | FloatCustomFieldConfig | BooleanCustomFieldConfig | DateTimeCustomFieldConfig | RelationCustomFieldConfig;
  2794. export type CustomerGroup = Node & {
  2795. __typename?: 'CustomerGroup';
  2796. id: Scalars['ID'];
  2797. createdAt: Scalars['DateTime'];
  2798. updatedAt: Scalars['DateTime'];
  2799. name: Scalars['String'];
  2800. customers: CustomerList;
  2801. };
  2802. export type CustomerGroupCustomersArgs = {
  2803. options?: Maybe<CustomerListOptions>;
  2804. };
  2805. export type CustomerList = PaginatedList & {
  2806. __typename?: 'CustomerList';
  2807. items: Array<Customer>;
  2808. totalItems: Scalars['Int'];
  2809. };
  2810. export type FacetValue = Node & {
  2811. __typename?: 'FacetValue';
  2812. id: Scalars['ID'];
  2813. createdAt: Scalars['DateTime'];
  2814. updatedAt: Scalars['DateTime'];
  2815. languageCode: LanguageCode;
  2816. facet: Facet;
  2817. name: Scalars['String'];
  2818. code: Scalars['String'];
  2819. translations: Array<FacetValueTranslation>;
  2820. customFields?: Maybe<Scalars['JSON']>;
  2821. };
  2822. export type FacetValueTranslation = {
  2823. __typename?: 'FacetValueTranslation';
  2824. id: Scalars['ID'];
  2825. createdAt: Scalars['DateTime'];
  2826. updatedAt: Scalars['DateTime'];
  2827. languageCode: LanguageCode;
  2828. name: Scalars['String'];
  2829. };
  2830. export type FacetTranslation = {
  2831. __typename?: 'FacetTranslation';
  2832. id: Scalars['ID'];
  2833. createdAt: Scalars['DateTime'];
  2834. updatedAt: Scalars['DateTime'];
  2835. languageCode: LanguageCode;
  2836. name: Scalars['String'];
  2837. };
  2838. export type FacetList = PaginatedList & {
  2839. __typename?: 'FacetList';
  2840. items: Array<Facet>;
  2841. totalItems: Scalars['Int'];
  2842. };
  2843. export enum HistoryEntryType {
  2844. CUSTOMER_REGISTERED = 'CUSTOMER_REGISTERED',
  2845. CUSTOMER_VERIFIED = 'CUSTOMER_VERIFIED',
  2846. CUSTOMER_DETAIL_UPDATED = 'CUSTOMER_DETAIL_UPDATED',
  2847. CUSTOMER_ADDED_TO_GROUP = 'CUSTOMER_ADDED_TO_GROUP',
  2848. CUSTOMER_REMOVED_FROM_GROUP = 'CUSTOMER_REMOVED_FROM_GROUP',
  2849. CUSTOMER_ADDRESS_CREATED = 'CUSTOMER_ADDRESS_CREATED',
  2850. CUSTOMER_ADDRESS_UPDATED = 'CUSTOMER_ADDRESS_UPDATED',
  2851. CUSTOMER_ADDRESS_DELETED = 'CUSTOMER_ADDRESS_DELETED',
  2852. CUSTOMER_PASSWORD_UPDATED = 'CUSTOMER_PASSWORD_UPDATED',
  2853. CUSTOMER_PASSWORD_RESET_REQUESTED = 'CUSTOMER_PASSWORD_RESET_REQUESTED',
  2854. CUSTOMER_PASSWORD_RESET_VERIFIED = 'CUSTOMER_PASSWORD_RESET_VERIFIED',
  2855. CUSTOMER_EMAIL_UPDATE_REQUESTED = 'CUSTOMER_EMAIL_UPDATE_REQUESTED',
  2856. CUSTOMER_EMAIL_UPDATE_VERIFIED = 'CUSTOMER_EMAIL_UPDATE_VERIFIED',
  2857. CUSTOMER_NOTE = 'CUSTOMER_NOTE',
  2858. ORDER_STATE_TRANSITION = 'ORDER_STATE_TRANSITION',
  2859. ORDER_PAYMENT_TRANSITION = 'ORDER_PAYMENT_TRANSITION',
  2860. ORDER_FULFILLMENT = 'ORDER_FULFILLMENT',
  2861. ORDER_CANCELLATION = 'ORDER_CANCELLATION',
  2862. ORDER_REFUND_TRANSITION = 'ORDER_REFUND_TRANSITION',
  2863. ORDER_FULFILLMENT_TRANSITION = 'ORDER_FULFILLMENT_TRANSITION',
  2864. ORDER_NOTE = 'ORDER_NOTE',
  2865. ORDER_COUPON_APPLIED = 'ORDER_COUPON_APPLIED',
  2866. ORDER_COUPON_REMOVED = 'ORDER_COUPON_REMOVED',
  2867. ORDER_MODIFIED = 'ORDER_MODIFIED'
  2868. }
  2869. export type HistoryEntryList = PaginatedList & {
  2870. __typename?: 'HistoryEntryList';
  2871. items: Array<HistoryEntry>;
  2872. totalItems: Scalars['Int'];
  2873. };
  2874. /**
  2875. * @description
  2876. * Languages in the form of a ISO 639-1 language code with optional
  2877. * region or script modifier (e.g. de_AT). The selection available is based
  2878. * on the [Unicode CLDR summary list](https://unicode-org.github.io/cldr-staging/charts/37/summary/root.html)
  2879. * and includes the major spoken languages of the world and any widely-used variants.
  2880. *
  2881. * @docsCategory common
  2882. */
  2883. export enum LanguageCode {
  2884. /** Afrikaans */
  2885. af = 'af',
  2886. /** Akan */
  2887. ak = 'ak',
  2888. /** Albanian */
  2889. sq = 'sq',
  2890. /** Amharic */
  2891. am = 'am',
  2892. /** Arabic */
  2893. ar = 'ar',
  2894. /** Armenian */
  2895. hy = 'hy',
  2896. /** Assamese */
  2897. as = 'as',
  2898. /** Azerbaijani */
  2899. az = 'az',
  2900. /** Bambara */
  2901. bm = 'bm',
  2902. /** Bangla */
  2903. bn = 'bn',
  2904. /** Basque */
  2905. eu = 'eu',
  2906. /** Belarusian */
  2907. be = 'be',
  2908. /** Bosnian */
  2909. bs = 'bs',
  2910. /** Breton */
  2911. br = 'br',
  2912. /** Bulgarian */
  2913. bg = 'bg',
  2914. /** Burmese */
  2915. my = 'my',
  2916. /** Catalan */
  2917. ca = 'ca',
  2918. /** Chechen */
  2919. ce = 'ce',
  2920. /** Chinese */
  2921. zh = 'zh',
  2922. /** Simplified Chinese */
  2923. zh_Hans = 'zh_Hans',
  2924. /** Traditional Chinese */
  2925. zh_Hant = 'zh_Hant',
  2926. /** Church Slavic */
  2927. cu = 'cu',
  2928. /** Cornish */
  2929. kw = 'kw',
  2930. /** Corsican */
  2931. co = 'co',
  2932. /** Croatian */
  2933. hr = 'hr',
  2934. /** Czech */
  2935. cs = 'cs',
  2936. /** Danish */
  2937. da = 'da',
  2938. /** Dutch */
  2939. nl = 'nl',
  2940. /** Flemish */
  2941. nl_BE = 'nl_BE',
  2942. /** Dzongkha */
  2943. dz = 'dz',
  2944. /** English */
  2945. en = 'en',
  2946. /** Australian English */
  2947. en_AU = 'en_AU',
  2948. /** Canadian English */
  2949. en_CA = 'en_CA',
  2950. /** British English */
  2951. en_GB = 'en_GB',
  2952. /** American English */
  2953. en_US = 'en_US',
  2954. /** Esperanto */
  2955. eo = 'eo',
  2956. /** Estonian */
  2957. et = 'et',
  2958. /** Ewe */
  2959. ee = 'ee',
  2960. /** Faroese */
  2961. fo = 'fo',
  2962. /** Finnish */
  2963. fi = 'fi',
  2964. /** French */
  2965. fr = 'fr',
  2966. /** Canadian French */
  2967. fr_CA = 'fr_CA',
  2968. /** Swiss French */
  2969. fr_CH = 'fr_CH',
  2970. /** Fulah */
  2971. ff = 'ff',
  2972. /** Galician */
  2973. gl = 'gl',
  2974. /** Ganda */
  2975. lg = 'lg',
  2976. /** Georgian */
  2977. ka = 'ka',
  2978. /** German */
  2979. de = 'de',
  2980. /** Austrian German */
  2981. de_AT = 'de_AT',
  2982. /** Swiss High German */
  2983. de_CH = 'de_CH',
  2984. /** Greek */
  2985. el = 'el',
  2986. /** Gujarati */
  2987. gu = 'gu',
  2988. /** Haitian Creole */
  2989. ht = 'ht',
  2990. /** Hausa */
  2991. ha = 'ha',
  2992. /** Hebrew */
  2993. he = 'he',
  2994. /** Hindi */
  2995. hi = 'hi',
  2996. /** Hungarian */
  2997. hu = 'hu',
  2998. /** Icelandic */
  2999. is = 'is',
  3000. /** Igbo */
  3001. ig = 'ig',
  3002. /** Indonesian */
  3003. id = 'id',
  3004. /** Interlingua */
  3005. ia = 'ia',
  3006. /** Irish */
  3007. ga = 'ga',
  3008. /** Italian */
  3009. it = 'it',
  3010. /** Japanese */
  3011. ja = 'ja',
  3012. /** Javanese */
  3013. jv = 'jv',
  3014. /** Kalaallisut */
  3015. kl = 'kl',
  3016. /** Kannada */
  3017. kn = 'kn',
  3018. /** Kashmiri */
  3019. ks = 'ks',
  3020. /** Kazakh */
  3021. kk = 'kk',
  3022. /** Khmer */
  3023. km = 'km',
  3024. /** Kikuyu */
  3025. ki = 'ki',
  3026. /** Kinyarwanda */
  3027. rw = 'rw',
  3028. /** Korean */
  3029. ko = 'ko',
  3030. /** Kurdish */
  3031. ku = 'ku',
  3032. /** Kyrgyz */
  3033. ky = 'ky',
  3034. /** Lao */
  3035. lo = 'lo',
  3036. /** Latin */
  3037. la = 'la',
  3038. /** Latvian */
  3039. lv = 'lv',
  3040. /** Lingala */
  3041. ln = 'ln',
  3042. /** Lithuanian */
  3043. lt = 'lt',
  3044. /** Luba-Katanga */
  3045. lu = 'lu',
  3046. /** Luxembourgish */
  3047. lb = 'lb',
  3048. /** Macedonian */
  3049. mk = 'mk',
  3050. /** Malagasy */
  3051. mg = 'mg',
  3052. /** Malay */
  3053. ms = 'ms',
  3054. /** Malayalam */
  3055. ml = 'ml',
  3056. /** Maltese */
  3057. mt = 'mt',
  3058. /** Manx */
  3059. gv = 'gv',
  3060. /** Maori */
  3061. mi = 'mi',
  3062. /** Marathi */
  3063. mr = 'mr',
  3064. /** Mongolian */
  3065. mn = 'mn',
  3066. /** Nepali */
  3067. ne = 'ne',
  3068. /** North Ndebele */
  3069. nd = 'nd',
  3070. /** Northern Sami */
  3071. se = 'se',
  3072. /** Norwegian Bokmål */
  3073. nb = 'nb',
  3074. /** Norwegian Nynorsk */
  3075. nn = 'nn',
  3076. /** Nyanja */
  3077. ny = 'ny',
  3078. /** Odia */
  3079. or = 'or',
  3080. /** Oromo */
  3081. om = 'om',
  3082. /** Ossetic */
  3083. os = 'os',
  3084. /** Pashto */
  3085. ps = 'ps',
  3086. /** Persian */
  3087. fa = 'fa',
  3088. /** Dari */
  3089. fa_AF = 'fa_AF',
  3090. /** Polish */
  3091. pl = 'pl',
  3092. /** Portuguese */
  3093. pt = 'pt',
  3094. /** Brazilian Portuguese */
  3095. pt_BR = 'pt_BR',
  3096. /** European Portuguese */
  3097. pt_PT = 'pt_PT',
  3098. /** Punjabi */
  3099. pa = 'pa',
  3100. /** Quechua */
  3101. qu = 'qu',
  3102. /** Romanian */
  3103. ro = 'ro',
  3104. /** Moldavian */
  3105. ro_MD = 'ro_MD',
  3106. /** Romansh */
  3107. rm = 'rm',
  3108. /** Rundi */
  3109. rn = 'rn',
  3110. /** Russian */
  3111. ru = 'ru',
  3112. /** Samoan */
  3113. sm = 'sm',
  3114. /** Sango */
  3115. sg = 'sg',
  3116. /** Sanskrit */
  3117. sa = 'sa',
  3118. /** Scottish Gaelic */
  3119. gd = 'gd',
  3120. /** Serbian */
  3121. sr = 'sr',
  3122. /** Shona */
  3123. sn = 'sn',
  3124. /** Sichuan Yi */
  3125. ii = 'ii',
  3126. /** Sindhi */
  3127. sd = 'sd',
  3128. /** Sinhala */
  3129. si = 'si',
  3130. /** Slovak */
  3131. sk = 'sk',
  3132. /** Slovenian */
  3133. sl = 'sl',
  3134. /** Somali */
  3135. so = 'so',
  3136. /** Southern Sotho */
  3137. st = 'st',
  3138. /** Spanish */
  3139. es = 'es',
  3140. /** European Spanish */
  3141. es_ES = 'es_ES',
  3142. /** Mexican Spanish */
  3143. es_MX = 'es_MX',
  3144. /** Sundanese */
  3145. su = 'su',
  3146. /** Swahili */
  3147. sw = 'sw',
  3148. /** Congo Swahili */
  3149. sw_CD = 'sw_CD',
  3150. /** Swedish */
  3151. sv = 'sv',
  3152. /** Tajik */
  3153. tg = 'tg',
  3154. /** Tamil */
  3155. ta = 'ta',
  3156. /** Tatar */
  3157. tt = 'tt',
  3158. /** Telugu */
  3159. te = 'te',
  3160. /** Thai */
  3161. th = 'th',
  3162. /** Tibetan */
  3163. bo = 'bo',
  3164. /** Tigrinya */
  3165. ti = 'ti',
  3166. /** Tongan */
  3167. to = 'to',
  3168. /** Turkish */
  3169. tr = 'tr',
  3170. /** Turkmen */
  3171. tk = 'tk',
  3172. /** Ukrainian */
  3173. uk = 'uk',
  3174. /** Urdu */
  3175. ur = 'ur',
  3176. /** Uyghur */
  3177. ug = 'ug',
  3178. /** Uzbek */
  3179. uz = 'uz',
  3180. /** Vietnamese */
  3181. vi = 'vi',
  3182. /** Volapük */
  3183. vo = 'vo',
  3184. /** Welsh */
  3185. cy = 'cy',
  3186. /** Western Frisian */
  3187. fy = 'fy',
  3188. /** Wolof */
  3189. wo = 'wo',
  3190. /** Xhosa */
  3191. xh = 'xh',
  3192. /** Yiddish */
  3193. yi = 'yi',
  3194. /** Yoruba */
  3195. yo = 'yo',
  3196. /** Zulu */
  3197. zu = 'zu'
  3198. }
  3199. /**
  3200. * A summary of the taxes being applied to this order, grouped
  3201. * by taxRate.
  3202. */
  3203. export type OrderTaxSummary = {
  3204. __typename?: 'OrderTaxSummary';
  3205. /** A description of this tax */
  3206. description: Scalars['String'];
  3207. /** The taxRate as a percentage */
  3208. taxRate: Scalars['Float'];
  3209. /** The total net price or OrderItems to which this taxRate applies */
  3210. taxBase: Scalars['Int'];
  3211. /** The total tax being applied to the Order at this taxRate */
  3212. taxTotal: Scalars['Int'];
  3213. };
  3214. export type OrderAddress = {
  3215. __typename?: 'OrderAddress';
  3216. fullName?: Maybe<Scalars['String']>;
  3217. company?: Maybe<Scalars['String']>;
  3218. streetLine1?: Maybe<Scalars['String']>;
  3219. streetLine2?: Maybe<Scalars['String']>;
  3220. city?: Maybe<Scalars['String']>;
  3221. province?: Maybe<Scalars['String']>;
  3222. postalCode?: Maybe<Scalars['String']>;
  3223. country?: Maybe<Scalars['String']>;
  3224. countryCode?: Maybe<Scalars['String']>;
  3225. phoneNumber?: Maybe<Scalars['String']>;
  3226. customFields?: Maybe<Scalars['JSON']>;
  3227. };
  3228. export type OrderList = PaginatedList & {
  3229. __typename?: 'OrderList';
  3230. items: Array<Order>;
  3231. totalItems: Scalars['Int'];
  3232. };
  3233. export type ShippingMethodQuote = {
  3234. __typename?: 'ShippingMethodQuote';
  3235. id: Scalars['ID'];
  3236. price: Scalars['Int'];
  3237. priceWithTax: Scalars['Int'];
  3238. name: Scalars['String'];
  3239. description: Scalars['String'];
  3240. metadata?: Maybe<Scalars['JSON']>;
  3241. };
  3242. export type ShippingLine = {
  3243. __typename?: 'ShippingLine';
  3244. shippingMethod: ShippingMethod;
  3245. price: Scalars['Int'];
  3246. priceWithTax: Scalars['Int'];
  3247. discountedPrice: Scalars['Int'];
  3248. discountedPriceWithTax: Scalars['Int'];
  3249. discounts: Array<Adjustment>;
  3250. };
  3251. export type OrderItem = Node & {
  3252. __typename?: 'OrderItem';
  3253. id: Scalars['ID'];
  3254. createdAt: Scalars['DateTime'];
  3255. updatedAt: Scalars['DateTime'];
  3256. cancelled: Scalars['Boolean'];
  3257. /** The price of a single unit, excluding tax and discounts */
  3258. unitPrice: Scalars['Int'];
  3259. /** The price of a single unit, including tax but excluding discounts */
  3260. unitPriceWithTax: Scalars['Int'];
  3261. /**
  3262. * The price of a single unit including discounts, excluding tax.
  3263. *
  3264. * If Order-level discounts have been applied, this will not be the
  3265. * actual taxable unit price (see `proratedUnitPrice`), but is generally the
  3266. * correct price to display to customers to avoid confusion
  3267. * about the internal handling of distributed Order-level discounts.
  3268. */
  3269. discountedUnitPrice: Scalars['Int'];
  3270. /** The price of a single unit including discounts and tax */
  3271. discountedUnitPriceWithTax: Scalars['Int'];
  3272. /**
  3273. * The actual unit price, taking into account both item discounts _and_ prorated (proportially-distributed)
  3274. * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
  3275. * and refund calculations.
  3276. */
  3277. proratedUnitPrice: Scalars['Int'];
  3278. /** The proratedUnitPrice including tax */
  3279. proratedUnitPriceWithTax: Scalars['Int'];
  3280. unitTax: Scalars['Int'];
  3281. /** @deprecated `unitPrice` is now always without tax */
  3282. unitPriceIncludesTax: Scalars['Boolean'];
  3283. taxRate: Scalars['Float'];
  3284. adjustments: Array<Adjustment>;
  3285. taxLines: Array<TaxLine>;
  3286. fulfillment?: Maybe<Fulfillment>;
  3287. refundId?: Maybe<Scalars['ID']>;
  3288. };
  3289. export type OrderLine = Node & {
  3290. __typename?: 'OrderLine';
  3291. id: Scalars['ID'];
  3292. createdAt: Scalars['DateTime'];
  3293. updatedAt: Scalars['DateTime'];
  3294. productVariant: ProductVariant;
  3295. featuredAsset?: Maybe<Asset>;
  3296. /** The price of a single unit, excluding tax and discounts */
  3297. unitPrice: Scalars['Int'];
  3298. /** The price of a single unit, including tax but excluding discounts */
  3299. unitPriceWithTax: Scalars['Int'];
  3300. /**
  3301. * The price of a single unit including discounts, excluding tax.
  3302. *
  3303. * If Order-level discounts have been applied, this will not be the
  3304. * actual taxable unit price (see `proratedUnitPrice`), but is generally the
  3305. * correct price to display to customers to avoid confusion
  3306. * about the internal handling of distributed Order-level discounts.
  3307. */
  3308. discountedUnitPrice: Scalars['Int'];
  3309. /** The price of a single unit including discounts and tax */
  3310. discountedUnitPriceWithTax: Scalars['Int'];
  3311. /**
  3312. * The actual unit price, taking into account both item discounts _and_ prorated (proportially-distributed)
  3313. * Order-level discounts. This value is the true economic value of the OrderItem, and is used in tax
  3314. * and refund calculations.
  3315. */
  3316. proratedUnitPrice: Scalars['Int'];
  3317. /** The proratedUnitPrice including tax */
  3318. proratedUnitPriceWithTax: Scalars['Int'];
  3319. quantity: Scalars['Int'];
  3320. items: Array<OrderItem>;
  3321. /** @deprecated Use `linePriceWithTax` instead */
  3322. totalPrice: Scalars['Int'];
  3323. taxRate: Scalars['Float'];
  3324. /** The total price of the line excluding tax and discounts. */
  3325. linePrice: Scalars['Int'];
  3326. /** The total price of the line including tax bit excluding discounts. */
  3327. linePriceWithTax: Scalars['Int'];
  3328. /** The price of the line including discounts, excluding tax */
  3329. discountedLinePrice: Scalars['Int'];
  3330. /** The price of the line including discounts and tax */
  3331. discountedLinePriceWithTax: Scalars['Int'];
  3332. /**
  3333. * The actual line price, taking into account both item discounts _and_ prorated (proportially-distributed)
  3334. * Order-level discounts. This value is the true economic value of the OrderLine, and is used in tax
  3335. * and refund calculations.
  3336. */
  3337. proratedLinePrice: Scalars['Int'];
  3338. /** The proratedLinePrice including tax */
  3339. proratedLinePriceWithTax: Scalars['Int'];
  3340. /** The total tax on this line */
  3341. lineTax: Scalars['Int'];
  3342. /** @deprecated Use `discounts` instead */
  3343. adjustments: Array<Adjustment>;
  3344. discounts: Array<Adjustment>;
  3345. taxLines: Array<TaxLine>;
  3346. order: Order;
  3347. customFields?: Maybe<Scalars['JSON']>;
  3348. };
  3349. export type Payment = Node & {
  3350. __typename?: 'Payment';
  3351. id: Scalars['ID'];
  3352. createdAt: Scalars['DateTime'];
  3353. updatedAt: Scalars['DateTime'];
  3354. method: Scalars['String'];
  3355. amount: Scalars['Int'];
  3356. state: Scalars['String'];
  3357. transactionId?: Maybe<Scalars['String']>;
  3358. errorMessage?: Maybe<Scalars['String']>;
  3359. refunds: Array<Refund>;
  3360. metadata?: Maybe<Scalars['JSON']>;
  3361. };
  3362. export type Refund = Node & {
  3363. __typename?: 'Refund';
  3364. id: Scalars['ID'];
  3365. createdAt: Scalars['DateTime'];
  3366. updatedAt: Scalars['DateTime'];
  3367. items: Scalars['Int'];
  3368. shipping: Scalars['Int'];
  3369. adjustment: Scalars['Int'];
  3370. total: Scalars['Int'];
  3371. method?: Maybe<Scalars['String']>;
  3372. state: Scalars['String'];
  3373. transactionId?: Maybe<Scalars['String']>;
  3374. reason?: Maybe<Scalars['String']>;
  3375. orderItems: Array<OrderItem>;
  3376. paymentId: Scalars['ID'];
  3377. metadata?: Maybe<Scalars['JSON']>;
  3378. };
  3379. export type Surcharge = Node & {
  3380. __typename?: 'Surcharge';
  3381. id: Scalars['ID'];
  3382. createdAt: Scalars['DateTime'];
  3383. updatedAt: Scalars['DateTime'];
  3384. description: Scalars['String'];
  3385. sku?: Maybe<Scalars['String']>;
  3386. taxLines: Array<TaxLine>;
  3387. price: Scalars['Int'];
  3388. priceWithTax: Scalars['Int'];
  3389. taxRate: Scalars['Float'];
  3390. };
  3391. export type ProductOptionGroup = Node & {
  3392. __typename?: 'ProductOptionGroup';
  3393. id: Scalars['ID'];
  3394. createdAt: Scalars['DateTime'];
  3395. updatedAt: Scalars['DateTime'];
  3396. languageCode: LanguageCode;
  3397. code: Scalars['String'];
  3398. name: Scalars['String'];
  3399. options: Array<ProductOption>;
  3400. translations: Array<ProductOptionGroupTranslation>;
  3401. customFields?: Maybe<Scalars['JSON']>;
  3402. };
  3403. export type ProductOptionGroupTranslation = {
  3404. __typename?: 'ProductOptionGroupTranslation';
  3405. id: Scalars['ID'];
  3406. createdAt: Scalars['DateTime'];
  3407. updatedAt: Scalars['DateTime'];
  3408. languageCode: LanguageCode;
  3409. name: Scalars['String'];
  3410. };
  3411. export type ProductOption = Node & {
  3412. __typename?: 'ProductOption';
  3413. id: Scalars['ID'];
  3414. createdAt: Scalars['DateTime'];
  3415. updatedAt: Scalars['DateTime'];
  3416. languageCode: LanguageCode;
  3417. code: Scalars['String'];
  3418. name: Scalars['String'];
  3419. groupId: Scalars['ID'];
  3420. group: ProductOptionGroup;
  3421. translations: Array<ProductOptionTranslation>;
  3422. customFields?: Maybe<Scalars['JSON']>;
  3423. };
  3424. export type ProductOptionTranslation = {
  3425. __typename?: 'ProductOptionTranslation';
  3426. id: Scalars['ID'];
  3427. createdAt: Scalars['DateTime'];
  3428. updatedAt: Scalars['DateTime'];
  3429. languageCode: LanguageCode;
  3430. name: Scalars['String'];
  3431. };
  3432. export type SearchReindexResponse = {
  3433. __typename?: 'SearchReindexResponse';
  3434. success: Scalars['Boolean'];
  3435. };
  3436. export type SearchResponse = {
  3437. __typename?: 'SearchResponse';
  3438. items: Array<SearchResult>;
  3439. totalItems: Scalars['Int'];
  3440. facetValues: Array<FacetValueResult>;
  3441. };
  3442. /**
  3443. * Which FacetValues are present in the products returned
  3444. * by the search, and in what quantity.
  3445. */
  3446. export type FacetValueResult = {
  3447. __typename?: 'FacetValueResult';
  3448. facetValue: FacetValue;
  3449. count: Scalars['Int'];
  3450. };
  3451. export type SearchResultAsset = {
  3452. __typename?: 'SearchResultAsset';
  3453. id: Scalars['ID'];
  3454. preview: Scalars['String'];
  3455. focalPoint?: Maybe<Coordinate>;
  3456. };
  3457. /** The price of a search result product, either as a range or as a single price */
  3458. export type SearchResultPrice = PriceRange | SinglePrice;
  3459. /** The price value where the result has a single price */
  3460. export type SinglePrice = {
  3461. __typename?: 'SinglePrice';
  3462. value: Scalars['Int'];
  3463. };
  3464. /** The price range where the result has more than one price */
  3465. export type PriceRange = {
  3466. __typename?: 'PriceRange';
  3467. min: Scalars['Int'];
  3468. max: Scalars['Int'];
  3469. };
  3470. export type ProductTranslation = {
  3471. __typename?: 'ProductTranslation';
  3472. id: Scalars['ID'];
  3473. createdAt: Scalars['DateTime'];
  3474. updatedAt: Scalars['DateTime'];
  3475. languageCode: LanguageCode;
  3476. name: Scalars['String'];
  3477. slug: Scalars['String'];
  3478. description: Scalars['String'];
  3479. };
  3480. export type ProductList = PaginatedList & {
  3481. __typename?: 'ProductList';
  3482. items: Array<Product>;
  3483. totalItems: Scalars['Int'];
  3484. };
  3485. export type ProductVariantTranslation = {
  3486. __typename?: 'ProductVariantTranslation';
  3487. id: Scalars['ID'];
  3488. createdAt: Scalars['DateTime'];
  3489. updatedAt: Scalars['DateTime'];
  3490. languageCode: LanguageCode;
  3491. name: Scalars['String'];
  3492. };
  3493. export type Promotion = Node & {
  3494. __typename?: 'Promotion';
  3495. id: Scalars['ID'];
  3496. createdAt: Scalars['DateTime'];
  3497. updatedAt: Scalars['DateTime'];
  3498. startsAt?: Maybe<Scalars['DateTime']>;
  3499. endsAt?: Maybe<Scalars['DateTime']>;
  3500. couponCode?: Maybe<Scalars['String']>;
  3501. perCustomerUsageLimit?: Maybe<Scalars['Int']>;
  3502. name: Scalars['String'];
  3503. enabled: Scalars['Boolean'];
  3504. conditions: Array<ConfigurableOperation>;
  3505. actions: Array<ConfigurableOperation>;
  3506. };
  3507. export type PromotionList = PaginatedList & {
  3508. __typename?: 'PromotionList';
  3509. items: Array<Promotion>;
  3510. totalItems: Scalars['Int'];
  3511. };
  3512. export type Role = Node & {
  3513. __typename?: 'Role';
  3514. id: Scalars['ID'];
  3515. createdAt: Scalars['DateTime'];
  3516. updatedAt: Scalars['DateTime'];
  3517. code: Scalars['String'];
  3518. description: Scalars['String'];
  3519. permissions: Array<Permission>;
  3520. channels: Array<Channel>;
  3521. };
  3522. export type RoleList = PaginatedList & {
  3523. __typename?: 'RoleList';
  3524. items: Array<Role>;
  3525. totalItems: Scalars['Int'];
  3526. };
  3527. export type ShippingMethod = Node & {
  3528. __typename?: 'ShippingMethod';
  3529. id: Scalars['ID'];
  3530. createdAt: Scalars['DateTime'];
  3531. updatedAt: Scalars['DateTime'];
  3532. code: Scalars['String'];
  3533. name: Scalars['String'];
  3534. description: Scalars['String'];
  3535. fulfillmentHandlerCode: Scalars['String'];
  3536. checker: ConfigurableOperation;
  3537. calculator: ConfigurableOperation;
  3538. translations: Array<ShippingMethodTranslation>;
  3539. customFields?: Maybe<Scalars['JSON']>;
  3540. };
  3541. export type ShippingMethodTranslation = {
  3542. __typename?: 'ShippingMethodTranslation';
  3543. id: Scalars['ID'];
  3544. createdAt: Scalars['DateTime'];
  3545. updatedAt: Scalars['DateTime'];
  3546. languageCode: LanguageCode;
  3547. name: Scalars['String'];
  3548. description: Scalars['String'];
  3549. };
  3550. export type ShippingMethodList = PaginatedList & {
  3551. __typename?: 'ShippingMethodList';
  3552. items: Array<ShippingMethod>;
  3553. totalItems: Scalars['Int'];
  3554. };
  3555. export type Tag = Node & {
  3556. __typename?: 'Tag';
  3557. id: Scalars['ID'];
  3558. createdAt: Scalars['DateTime'];
  3559. updatedAt: Scalars['DateTime'];
  3560. value: Scalars['String'];
  3561. };
  3562. export type TagList = PaginatedList & {
  3563. __typename?: 'TagList';
  3564. items: Array<Tag>;
  3565. totalItems: Scalars['Int'];
  3566. };
  3567. export type TaxCategory = Node & {
  3568. __typename?: 'TaxCategory';
  3569. id: Scalars['ID'];
  3570. createdAt: Scalars['DateTime'];
  3571. updatedAt: Scalars['DateTime'];
  3572. name: Scalars['String'];
  3573. };
  3574. export type TaxRate = Node & {
  3575. __typename?: 'TaxRate';
  3576. id: Scalars['ID'];
  3577. createdAt: Scalars['DateTime'];
  3578. updatedAt: Scalars['DateTime'];
  3579. name: Scalars['String'];
  3580. enabled: Scalars['Boolean'];
  3581. value: Scalars['Float'];
  3582. category: TaxCategory;
  3583. zone: Zone;
  3584. customerGroup?: Maybe<CustomerGroup>;
  3585. };
  3586. export type TaxRateList = PaginatedList & {
  3587. __typename?: 'TaxRateList';
  3588. items: Array<TaxRate>;
  3589. totalItems: Scalars['Int'];
  3590. };
  3591. export type User = Node & {
  3592. __typename?: 'User';
  3593. id: Scalars['ID'];
  3594. createdAt: Scalars['DateTime'];
  3595. updatedAt: Scalars['DateTime'];
  3596. identifier: Scalars['String'];
  3597. verified: Scalars['Boolean'];
  3598. roles: Array<Role>;
  3599. lastLogin?: Maybe<Scalars['DateTime']>;
  3600. authenticationMethods: Array<AuthenticationMethod>;
  3601. customFields?: Maybe<Scalars['JSON']>;
  3602. };
  3603. export type AuthenticationMethod = Node & {
  3604. __typename?: 'AuthenticationMethod';
  3605. id: Scalars['ID'];
  3606. createdAt: Scalars['DateTime'];
  3607. updatedAt: Scalars['DateTime'];
  3608. strategy: Scalars['String'];
  3609. };
  3610. export type Zone = Node & {
  3611. __typename?: 'Zone';
  3612. id: Scalars['ID'];
  3613. createdAt: Scalars['DateTime'];
  3614. updatedAt: Scalars['DateTime'];
  3615. name: Scalars['String'];
  3616. members: Array<Country>;
  3617. };
  3618. export type AdministratorListOptions = {
  3619. skip?: Maybe<Scalars['Int']>;
  3620. take?: Maybe<Scalars['Int']>;
  3621. sort?: Maybe<AdministratorSortParameter>;
  3622. filter?: Maybe<AdministratorFilterParameter>;
  3623. };
  3624. export type CollectionListOptions = {
  3625. skip?: Maybe<Scalars['Int']>;
  3626. take?: Maybe<Scalars['Int']>;
  3627. sort?: Maybe<CollectionSortParameter>;
  3628. filter?: Maybe<CollectionFilterParameter>;
  3629. };
  3630. export type CountryListOptions = {
  3631. skip?: Maybe<Scalars['Int']>;
  3632. take?: Maybe<Scalars['Int']>;
  3633. sort?: Maybe<CountrySortParameter>;
  3634. filter?: Maybe<CountryFilterParameter>;
  3635. };
  3636. export type CustomerGroupListOptions = {
  3637. skip?: Maybe<Scalars['Int']>;
  3638. take?: Maybe<Scalars['Int']>;
  3639. sort?: Maybe<CustomerGroupSortParameter>;
  3640. filter?: Maybe<CustomerGroupFilterParameter>;
  3641. };
  3642. export type CustomerListOptions = {
  3643. skip?: Maybe<Scalars['Int']>;
  3644. take?: Maybe<Scalars['Int']>;
  3645. sort?: Maybe<CustomerSortParameter>;
  3646. filter?: Maybe<CustomerFilterParameter>;
  3647. };
  3648. export type FacetListOptions = {
  3649. skip?: Maybe<Scalars['Int']>;
  3650. take?: Maybe<Scalars['Int']>;
  3651. sort?: Maybe<FacetSortParameter>;
  3652. filter?: Maybe<FacetFilterParameter>;
  3653. };
  3654. export type JobListOptions = {
  3655. skip?: Maybe<Scalars['Int']>;
  3656. take?: Maybe<Scalars['Int']>;
  3657. sort?: Maybe<JobSortParameter>;
  3658. filter?: Maybe<JobFilterParameter>;
  3659. };
  3660. export type OrderListOptions = {
  3661. skip?: Maybe<Scalars['Int']>;
  3662. take?: Maybe<Scalars['Int']>;
  3663. sort?: Maybe<OrderSortParameter>;
  3664. filter?: Maybe<OrderFilterParameter>;
  3665. };
  3666. export type PaymentMethodListOptions = {
  3667. skip?: Maybe<Scalars['Int']>;
  3668. take?: Maybe<Scalars['Int']>;
  3669. sort?: Maybe<PaymentMethodSortParameter>;
  3670. filter?: Maybe<PaymentMethodFilterParameter>;
  3671. };
  3672. export type ProductListOptions = {
  3673. skip?: Maybe<Scalars['Int']>;
  3674. take?: Maybe<Scalars['Int']>;
  3675. sort?: Maybe<ProductSortParameter>;
  3676. filter?: Maybe<ProductFilterParameter>;
  3677. };
  3678. export type ProductVariantListOptions = {
  3679. skip?: Maybe<Scalars['Int']>;
  3680. take?: Maybe<Scalars['Int']>;
  3681. sort?: Maybe<ProductVariantSortParameter>;
  3682. filter?: Maybe<ProductVariantFilterParameter>;
  3683. };
  3684. export type PromotionListOptions = {
  3685. skip?: Maybe<Scalars['Int']>;
  3686. take?: Maybe<Scalars['Int']>;
  3687. sort?: Maybe<PromotionSortParameter>;
  3688. filter?: Maybe<PromotionFilterParameter>;
  3689. };
  3690. export type RoleListOptions = {
  3691. skip?: Maybe<Scalars['Int']>;
  3692. take?: Maybe<Scalars['Int']>;
  3693. sort?: Maybe<RoleSortParameter>;
  3694. filter?: Maybe<RoleFilterParameter>;
  3695. };
  3696. export type ShippingMethodListOptions = {
  3697. skip?: Maybe<Scalars['Int']>;
  3698. take?: Maybe<Scalars['Int']>;
  3699. sort?: Maybe<ShippingMethodSortParameter>;
  3700. filter?: Maybe<ShippingMethodFilterParameter>;
  3701. };
  3702. export type TagListOptions = {
  3703. skip?: Maybe<Scalars['Int']>;
  3704. take?: Maybe<Scalars['Int']>;
  3705. sort?: Maybe<TagSortParameter>;
  3706. filter?: Maybe<TagFilterParameter>;
  3707. };
  3708. export type TaxRateListOptions = {
  3709. skip?: Maybe<Scalars['Int']>;
  3710. take?: Maybe<Scalars['Int']>;
  3711. sort?: Maybe<TaxRateSortParameter>;
  3712. filter?: Maybe<TaxRateFilterParameter>;
  3713. };
  3714. export type HistoryEntryListOptions = {
  3715. skip?: Maybe<Scalars['Int']>;
  3716. take?: Maybe<Scalars['Int']>;
  3717. sort?: Maybe<HistoryEntrySortParameter>;
  3718. filter?: Maybe<HistoryEntryFilterParameter>;
  3719. };
  3720. export type AdministratorFilterParameter = {
  3721. createdAt?: Maybe<DateOperators>;
  3722. updatedAt?: Maybe<DateOperators>;
  3723. firstName?: Maybe<StringOperators>;
  3724. lastName?: Maybe<StringOperators>;
  3725. emailAddress?: Maybe<StringOperators>;
  3726. };
  3727. export type AdministratorSortParameter = {
  3728. id?: Maybe<SortOrder>;
  3729. createdAt?: Maybe<SortOrder>;
  3730. updatedAt?: Maybe<SortOrder>;
  3731. firstName?: Maybe<SortOrder>;
  3732. lastName?: Maybe<SortOrder>;
  3733. emailAddress?: Maybe<SortOrder>;
  3734. };
  3735. export type AssetFilterParameter = {
  3736. createdAt?: Maybe<DateOperators>;
  3737. updatedAt?: Maybe<DateOperators>;
  3738. name?: Maybe<StringOperators>;
  3739. type?: Maybe<StringOperators>;
  3740. fileSize?: Maybe<NumberOperators>;
  3741. mimeType?: Maybe<StringOperators>;
  3742. width?: Maybe<NumberOperators>;
  3743. height?: Maybe<NumberOperators>;
  3744. source?: Maybe<StringOperators>;
  3745. preview?: Maybe<StringOperators>;
  3746. };
  3747. export type AssetSortParameter = {
  3748. id?: Maybe<SortOrder>;
  3749. createdAt?: Maybe<SortOrder>;
  3750. updatedAt?: Maybe<SortOrder>;
  3751. name?: Maybe<SortOrder>;
  3752. fileSize?: Maybe<SortOrder>;
  3753. mimeType?: Maybe<SortOrder>;
  3754. width?: Maybe<SortOrder>;
  3755. height?: Maybe<SortOrder>;
  3756. source?: Maybe<SortOrder>;
  3757. preview?: Maybe<SortOrder>;
  3758. };
  3759. export type CollectionFilterParameter = {
  3760. isPrivate?: Maybe<BooleanOperators>;
  3761. createdAt?: Maybe<DateOperators>;
  3762. updatedAt?: Maybe<DateOperators>;
  3763. languageCode?: Maybe<StringOperators>;
  3764. name?: Maybe<StringOperators>;
  3765. slug?: Maybe<StringOperators>;
  3766. position?: Maybe<NumberOperators>;
  3767. description?: Maybe<StringOperators>;
  3768. };
  3769. export type CollectionSortParameter = {
  3770. id?: Maybe<SortOrder>;
  3771. createdAt?: Maybe<SortOrder>;
  3772. updatedAt?: Maybe<SortOrder>;
  3773. name?: Maybe<SortOrder>;
  3774. slug?: Maybe<SortOrder>;
  3775. position?: Maybe<SortOrder>;
  3776. description?: Maybe<SortOrder>;
  3777. };
  3778. export type CountryFilterParameter = {
  3779. createdAt?: Maybe<DateOperators>;
  3780. updatedAt?: Maybe<DateOperators>;
  3781. languageCode?: Maybe<StringOperators>;
  3782. code?: Maybe<StringOperators>;
  3783. name?: Maybe<StringOperators>;
  3784. enabled?: Maybe<BooleanOperators>;
  3785. };
  3786. export type CountrySortParameter = {
  3787. id?: Maybe<SortOrder>;
  3788. createdAt?: Maybe<SortOrder>;
  3789. updatedAt?: Maybe<SortOrder>;
  3790. code?: Maybe<SortOrder>;
  3791. name?: Maybe<SortOrder>;
  3792. };
  3793. export type CustomerGroupFilterParameter = {
  3794. createdAt?: Maybe<DateOperators>;
  3795. updatedAt?: Maybe<DateOperators>;
  3796. name?: Maybe<StringOperators>;
  3797. };
  3798. export type CustomerGroupSortParameter = {
  3799. id?: Maybe<SortOrder>;
  3800. createdAt?: Maybe<SortOrder>;
  3801. updatedAt?: Maybe<SortOrder>;
  3802. name?: Maybe<SortOrder>;
  3803. };
  3804. export type CustomerFilterParameter = {
  3805. createdAt?: Maybe<DateOperators>;
  3806. updatedAt?: Maybe<DateOperators>;
  3807. title?: Maybe<StringOperators>;
  3808. firstName?: Maybe<StringOperators>;
  3809. lastName?: Maybe<StringOperators>;
  3810. phoneNumber?: Maybe<StringOperators>;
  3811. emailAddress?: Maybe<StringOperators>;
  3812. };
  3813. export type CustomerSortParameter = {
  3814. id?: Maybe<SortOrder>;
  3815. createdAt?: Maybe<SortOrder>;
  3816. updatedAt?: Maybe<SortOrder>;
  3817. title?: Maybe<SortOrder>;
  3818. firstName?: Maybe<SortOrder>;
  3819. lastName?: Maybe<SortOrder>;
  3820. phoneNumber?: Maybe<SortOrder>;
  3821. emailAddress?: Maybe<SortOrder>;
  3822. };
  3823. export type FacetFilterParameter = {
  3824. isPrivate?: Maybe<BooleanOperators>;
  3825. createdAt?: Maybe<DateOperators>;
  3826. updatedAt?: Maybe<DateOperators>;
  3827. languageCode?: Maybe<StringOperators>;
  3828. name?: Maybe<StringOperators>;
  3829. code?: Maybe<StringOperators>;
  3830. };
  3831. export type FacetSortParameter = {
  3832. id?: Maybe<SortOrder>;
  3833. createdAt?: Maybe<SortOrder>;
  3834. updatedAt?: Maybe<SortOrder>;
  3835. name?: Maybe<SortOrder>;
  3836. code?: Maybe<SortOrder>;
  3837. };
  3838. export type JobFilterParameter = {
  3839. createdAt?: Maybe<DateOperators>;
  3840. startedAt?: Maybe<DateOperators>;
  3841. settledAt?: Maybe<DateOperators>;
  3842. queueName?: Maybe<StringOperators>;
  3843. state?: Maybe<StringOperators>;
  3844. progress?: Maybe<NumberOperators>;
  3845. isSettled?: Maybe<BooleanOperators>;
  3846. duration?: Maybe<NumberOperators>;
  3847. };
  3848. export type JobSortParameter = {
  3849. id?: Maybe<SortOrder>;
  3850. createdAt?: Maybe<SortOrder>;
  3851. startedAt?: Maybe<SortOrder>;
  3852. settledAt?: Maybe<SortOrder>;
  3853. queueName?: Maybe<SortOrder>;
  3854. progress?: Maybe<SortOrder>;
  3855. duration?: Maybe<SortOrder>;
  3856. };
  3857. export type OrderFilterParameter = {
  3858. createdAt?: Maybe<DateOperators>;
  3859. updatedAt?: Maybe<DateOperators>;
  3860. orderPlacedAt?: Maybe<DateOperators>;
  3861. code?: Maybe<StringOperators>;
  3862. state?: Maybe<StringOperators>;
  3863. active?: Maybe<BooleanOperators>;
  3864. totalQuantity?: Maybe<NumberOperators>;
  3865. subTotal?: Maybe<NumberOperators>;
  3866. subTotalWithTax?: Maybe<NumberOperators>;
  3867. currencyCode?: Maybe<StringOperators>;
  3868. shipping?: Maybe<NumberOperators>;
  3869. shippingWithTax?: Maybe<NumberOperators>;
  3870. total?: Maybe<NumberOperators>;
  3871. totalWithTax?: Maybe<NumberOperators>;
  3872. };
  3873. export type OrderSortParameter = {
  3874. id?: Maybe<SortOrder>;
  3875. createdAt?: Maybe<SortOrder>;
  3876. updatedAt?: Maybe<SortOrder>;
  3877. orderPlacedAt?: Maybe<SortOrder>;
  3878. code?: Maybe<SortOrder>;
  3879. state?: Maybe<SortOrder>;
  3880. totalQuantity?: Maybe<SortOrder>;
  3881. subTotal?: Maybe<SortOrder>;
  3882. subTotalWithTax?: Maybe<SortOrder>;
  3883. shipping?: Maybe<SortOrder>;
  3884. shippingWithTax?: Maybe<SortOrder>;
  3885. total?: Maybe<SortOrder>;
  3886. totalWithTax?: Maybe<SortOrder>;
  3887. };
  3888. export type PaymentMethodFilterParameter = {
  3889. createdAt?: Maybe<DateOperators>;
  3890. updatedAt?: Maybe<DateOperators>;
  3891. code?: Maybe<StringOperators>;
  3892. enabled?: Maybe<BooleanOperators>;
  3893. };
  3894. export type PaymentMethodSortParameter = {
  3895. id?: Maybe<SortOrder>;
  3896. createdAt?: Maybe<SortOrder>;
  3897. updatedAt?: Maybe<SortOrder>;
  3898. code?: Maybe<SortOrder>;
  3899. };
  3900. export type ProductFilterParameter = {
  3901. enabled?: Maybe<BooleanOperators>;
  3902. createdAt?: Maybe<DateOperators>;
  3903. updatedAt?: Maybe<DateOperators>;
  3904. languageCode?: Maybe<StringOperators>;
  3905. name?: Maybe<StringOperators>;
  3906. slug?: Maybe<StringOperators>;
  3907. description?: Maybe<StringOperators>;
  3908. };
  3909. export type ProductSortParameter = {
  3910. id?: Maybe<SortOrder>;
  3911. createdAt?: Maybe<SortOrder>;
  3912. updatedAt?: Maybe<SortOrder>;
  3913. name?: Maybe<SortOrder>;
  3914. slug?: Maybe<SortOrder>;
  3915. description?: Maybe<SortOrder>;
  3916. };
  3917. export type ProductVariantFilterParameter = {
  3918. enabled?: Maybe<BooleanOperators>;
  3919. trackInventory?: Maybe<StringOperators>;
  3920. stockOnHand?: Maybe<NumberOperators>;
  3921. stockAllocated?: Maybe<NumberOperators>;
  3922. outOfStockThreshold?: Maybe<NumberOperators>;
  3923. useGlobalOutOfStockThreshold?: Maybe<BooleanOperators>;
  3924. createdAt?: Maybe<DateOperators>;
  3925. updatedAt?: Maybe<DateOperators>;
  3926. languageCode?: Maybe<StringOperators>;
  3927. sku?: Maybe<StringOperators>;
  3928. name?: Maybe<StringOperators>;
  3929. price?: Maybe<NumberOperators>;
  3930. currencyCode?: Maybe<StringOperators>;
  3931. priceIncludesTax?: Maybe<BooleanOperators>;
  3932. priceWithTax?: Maybe<NumberOperators>;
  3933. };
  3934. export type ProductVariantSortParameter = {
  3935. stockOnHand?: Maybe<SortOrder>;
  3936. stockAllocated?: Maybe<SortOrder>;
  3937. outOfStockThreshold?: Maybe<SortOrder>;
  3938. id?: Maybe<SortOrder>;
  3939. productId?: Maybe<SortOrder>;
  3940. createdAt?: Maybe<SortOrder>;
  3941. updatedAt?: Maybe<SortOrder>;
  3942. sku?: Maybe<SortOrder>;
  3943. name?: Maybe<SortOrder>;
  3944. price?: Maybe<SortOrder>;
  3945. priceWithTax?: Maybe<SortOrder>;
  3946. };
  3947. export type PromotionFilterParameter = {
  3948. createdAt?: Maybe<DateOperators>;
  3949. updatedAt?: Maybe<DateOperators>;
  3950. startsAt?: Maybe<DateOperators>;
  3951. endsAt?: Maybe<DateOperators>;
  3952. couponCode?: Maybe<StringOperators>;
  3953. perCustomerUsageLimit?: Maybe<NumberOperators>;
  3954. name?: Maybe<StringOperators>;
  3955. enabled?: Maybe<BooleanOperators>;
  3956. };
  3957. export type PromotionSortParameter = {
  3958. id?: Maybe<SortOrder>;
  3959. createdAt?: Maybe<SortOrder>;
  3960. updatedAt?: Maybe<SortOrder>;
  3961. startsAt?: Maybe<SortOrder>;
  3962. endsAt?: Maybe<SortOrder>;
  3963. couponCode?: Maybe<SortOrder>;
  3964. perCustomerUsageLimit?: Maybe<SortOrder>;
  3965. name?: Maybe<SortOrder>;
  3966. };
  3967. export type RoleFilterParameter = {
  3968. createdAt?: Maybe<DateOperators>;
  3969. updatedAt?: Maybe<DateOperators>;
  3970. code?: Maybe<StringOperators>;
  3971. description?: Maybe<StringOperators>;
  3972. };
  3973. export type RoleSortParameter = {
  3974. id?: Maybe<SortOrder>;
  3975. createdAt?: Maybe<SortOrder>;
  3976. updatedAt?: Maybe<SortOrder>;
  3977. code?: Maybe<SortOrder>;
  3978. description?: Maybe<SortOrder>;
  3979. };
  3980. export type ShippingMethodFilterParameter = {
  3981. createdAt?: Maybe<DateOperators>;
  3982. updatedAt?: Maybe<DateOperators>;
  3983. code?: Maybe<StringOperators>;
  3984. name?: Maybe<StringOperators>;
  3985. description?: Maybe<StringOperators>;
  3986. fulfillmentHandlerCode?: Maybe<StringOperators>;
  3987. };
  3988. export type ShippingMethodSortParameter = {
  3989. id?: Maybe<SortOrder>;
  3990. createdAt?: Maybe<SortOrder>;
  3991. updatedAt?: Maybe<SortOrder>;
  3992. code?: Maybe<SortOrder>;
  3993. name?: Maybe<SortOrder>;
  3994. description?: Maybe<SortOrder>;
  3995. fulfillmentHandlerCode?: Maybe<SortOrder>;
  3996. };
  3997. export type TagFilterParameter = {
  3998. createdAt?: Maybe<DateOperators>;
  3999. updatedAt?: Maybe<DateOperators>;
  4000. value?: Maybe<StringOperators>;
  4001. };
  4002. export type TagSortParameter = {
  4003. id?: Maybe<SortOrder>;
  4004. createdAt?: Maybe<SortOrder>;
  4005. updatedAt?: Maybe<SortOrder>;
  4006. value?: Maybe<SortOrder>;
  4007. };
  4008. export type TaxRateFilterParameter = {
  4009. createdAt?: Maybe<DateOperators>;
  4010. updatedAt?: Maybe<DateOperators>;
  4011. name?: Maybe<StringOperators>;
  4012. enabled?: Maybe<BooleanOperators>;
  4013. value?: Maybe<NumberOperators>;
  4014. };
  4015. export type TaxRateSortParameter = {
  4016. id?: Maybe<SortOrder>;
  4017. createdAt?: Maybe<SortOrder>;
  4018. updatedAt?: Maybe<SortOrder>;
  4019. name?: Maybe<SortOrder>;
  4020. value?: Maybe<SortOrder>;
  4021. };
  4022. export type HistoryEntryFilterParameter = {
  4023. isPublic?: Maybe<BooleanOperators>;
  4024. createdAt?: Maybe<DateOperators>;
  4025. updatedAt?: Maybe<DateOperators>;
  4026. type?: Maybe<StringOperators>;
  4027. };
  4028. export type HistoryEntrySortParameter = {
  4029. id?: Maybe<SortOrder>;
  4030. createdAt?: Maybe<SortOrder>;
  4031. updatedAt?: Maybe<SortOrder>;
  4032. };
  4033. export type AuthenticationInput = {
  4034. native?: Maybe<NativeAuthInput>;
  4035. };
  4036. export type NativeAuthInput = {
  4037. username: Scalars['String'];
  4038. password: Scalars['String'];
  4039. };
  4040. export type CustomFields = {
  4041. __typename?: 'CustomFields';
  4042. Address: Array<CustomFieldConfig>;
  4043. Collection: Array<CustomFieldConfig>;
  4044. Customer: Array<CustomFieldConfig>;
  4045. Facet: Array<CustomFieldConfig>;
  4046. FacetValue: Array<CustomFieldConfig>;
  4047. Fulfillment: Array<CustomFieldConfig>;
  4048. GlobalSettings: Array<CustomFieldConfig>;
  4049. Order: Array<CustomFieldConfig>;
  4050. OrderLine: Array<CustomFieldConfig>;
  4051. Product: Array<CustomFieldConfig>;
  4052. ProductOption: Array<CustomFieldConfig>;
  4053. ProductOptionGroup: Array<CustomFieldConfig>;
  4054. ProductVariant: Array<CustomFieldConfig>;
  4055. User: Array<CustomFieldConfig>;
  4056. ShippingMethod: Array<CustomFieldConfig>;
  4057. };