generated-shop-types.ts 32 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871
  1. // tslint:disable
  2. // Generated in 2019-03-20T14:52:47+01:00
  3. export type Maybe<T> = T | null;
  4. export interface OrderListOptions {
  5. skip?: Maybe<number>;
  6. take?: Maybe<number>;
  7. sort?: Maybe<OrderSortParameter>;
  8. filter?: Maybe<OrderFilterParameter>;
  9. }
  10. export interface OrderSortParameter {
  11. id?: Maybe<SortOrder>;
  12. createdAt?: Maybe<SortOrder>;
  13. updatedAt?: Maybe<SortOrder>;
  14. code?: Maybe<SortOrder>;
  15. state?: Maybe<SortOrder>;
  16. subTotalBeforeTax?: Maybe<SortOrder>;
  17. subTotal?: Maybe<SortOrder>;
  18. shipping?: Maybe<SortOrder>;
  19. totalBeforeTax?: Maybe<SortOrder>;
  20. total?: Maybe<SortOrder>;
  21. }
  22. export interface OrderFilterParameter {
  23. createdAt?: Maybe<DateOperators>;
  24. updatedAt?: Maybe<DateOperators>;
  25. code?: Maybe<StringOperators>;
  26. state?: Maybe<StringOperators>;
  27. active?: Maybe<BooleanOperators>;
  28. subTotalBeforeTax?: Maybe<NumberOperators>;
  29. subTotal?: Maybe<NumberOperators>;
  30. currencyCode?: Maybe<StringOperators>;
  31. shipping?: Maybe<NumberOperators>;
  32. totalBeforeTax?: Maybe<NumberOperators>;
  33. total?: Maybe<NumberOperators>;
  34. }
  35. export interface DateOperators {
  36. eq?: Maybe<DateTime>;
  37. before?: Maybe<DateTime>;
  38. after?: Maybe<DateTime>;
  39. between?: Maybe<DateRange>;
  40. }
  41. export interface DateRange {
  42. start: DateTime;
  43. end: DateTime;
  44. }
  45. export interface StringOperators {
  46. eq?: Maybe<string>;
  47. contains?: Maybe<string>;
  48. }
  49. export interface BooleanOperators {
  50. eq?: Maybe<boolean>;
  51. }
  52. export interface NumberOperators {
  53. eq?: Maybe<number>;
  54. lt?: Maybe<number>;
  55. lte?: Maybe<number>;
  56. gt?: Maybe<number>;
  57. gte?: Maybe<number>;
  58. between?: Maybe<NumberRange>;
  59. }
  60. export interface NumberRange {
  61. start: number;
  62. end: number;
  63. }
  64. export interface CollectionListOptions {
  65. skip?: Maybe<number>;
  66. take?: Maybe<number>;
  67. sort?: Maybe<CollectionSortParameter>;
  68. filter?: Maybe<CollectionFilterParameter>;
  69. }
  70. export interface CollectionSortParameter {
  71. id?: Maybe<SortOrder>;
  72. createdAt?: Maybe<SortOrder>;
  73. updatedAt?: Maybe<SortOrder>;
  74. name?: Maybe<SortOrder>;
  75. position?: Maybe<SortOrder>;
  76. description?: Maybe<SortOrder>;
  77. }
  78. export interface CollectionFilterParameter {
  79. createdAt?: Maybe<DateOperators>;
  80. updatedAt?: Maybe<DateOperators>;
  81. languageCode?: Maybe<StringOperators>;
  82. name?: Maybe<StringOperators>;
  83. position?: Maybe<NumberOperators>;
  84. description?: Maybe<StringOperators>;
  85. }
  86. export interface ProductVariantListOptions {
  87. skip?: Maybe<number>;
  88. take?: Maybe<number>;
  89. sort?: Maybe<ProductVariantSortParameter>;
  90. filter?: Maybe<ProductVariantFilterParameter>;
  91. }
  92. export interface ProductVariantSortParameter {
  93. id?: Maybe<SortOrder>;
  94. productId?: Maybe<SortOrder>;
  95. createdAt?: Maybe<SortOrder>;
  96. updatedAt?: Maybe<SortOrder>;
  97. sku?: Maybe<SortOrder>;
  98. name?: Maybe<SortOrder>;
  99. price?: Maybe<SortOrder>;
  100. priceWithTax?: Maybe<SortOrder>;
  101. }
  102. export interface ProductVariantFilterParameter {
  103. createdAt?: Maybe<DateOperators>;
  104. updatedAt?: Maybe<DateOperators>;
  105. languageCode?: Maybe<StringOperators>;
  106. sku?: Maybe<StringOperators>;
  107. name?: Maybe<StringOperators>;
  108. price?: Maybe<NumberOperators>;
  109. currencyCode?: Maybe<StringOperators>;
  110. priceIncludesTax?: Maybe<BooleanOperators>;
  111. priceWithTax?: Maybe<NumberOperators>;
  112. }
  113. export interface ProductListOptions {
  114. skip?: Maybe<number>;
  115. take?: Maybe<number>;
  116. sort?: Maybe<ProductSortParameter>;
  117. filter?: Maybe<ProductFilterParameter>;
  118. }
  119. export interface ProductSortParameter {
  120. id?: Maybe<SortOrder>;
  121. createdAt?: Maybe<SortOrder>;
  122. updatedAt?: Maybe<SortOrder>;
  123. name?: Maybe<SortOrder>;
  124. slug?: Maybe<SortOrder>;
  125. description?: Maybe<SortOrder>;
  126. }
  127. export interface ProductFilterParameter {
  128. createdAt?: Maybe<DateOperators>;
  129. updatedAt?: Maybe<DateOperators>;
  130. languageCode?: Maybe<StringOperators>;
  131. name?: Maybe<StringOperators>;
  132. slug?: Maybe<StringOperators>;
  133. description?: Maybe<StringOperators>;
  134. }
  135. export interface SearchInput {
  136. term?: Maybe<string>;
  137. facetIds?: Maybe<string[]>;
  138. collectionId?: Maybe<string>;
  139. groupByProduct?: Maybe<boolean>;
  140. take?: Maybe<number>;
  141. skip?: Maybe<number>;
  142. sort?: Maybe<SearchResultSortParameter>;
  143. }
  144. export interface SearchResultSortParameter {
  145. name?: Maybe<SortOrder>;
  146. price?: Maybe<SortOrder>;
  147. }
  148. export interface CreateAddressInput {
  149. fullName?: Maybe<string>;
  150. company?: Maybe<string>;
  151. streetLine1: string;
  152. streetLine2?: Maybe<string>;
  153. city?: Maybe<string>;
  154. province?: Maybe<string>;
  155. postalCode?: Maybe<string>;
  156. countryCode: string;
  157. phoneNumber?: Maybe<string>;
  158. defaultShippingAddress?: Maybe<boolean>;
  159. defaultBillingAddress?: Maybe<boolean>;
  160. customFields?: Maybe<Json>;
  161. }
  162. export interface PaymentInput {
  163. method: string;
  164. metadata: Json;
  165. }
  166. export interface CreateCustomerInput {
  167. title?: Maybe<string>;
  168. firstName: string;
  169. lastName: string;
  170. phoneNumber?: Maybe<string>;
  171. emailAddress: string;
  172. customFields?: Maybe<Json>;
  173. }
  174. export interface RegisterCustomerInput {
  175. emailAddress: string;
  176. title?: Maybe<string>;
  177. firstName?: Maybe<string>;
  178. lastName?: Maybe<string>;
  179. password?: Maybe<string>;
  180. }
  181. export interface UpdateCustomerInput {
  182. title?: Maybe<string>;
  183. firstName?: Maybe<string>;
  184. lastName?: Maybe<string>;
  185. phoneNumber?: Maybe<string>;
  186. emailAddress?: Maybe<string>;
  187. customFields?: Maybe<Json>;
  188. }
  189. export interface UpdateAddressInput {
  190. id: string;
  191. fullName?: Maybe<string>;
  192. company?: Maybe<string>;
  193. streetLine1?: Maybe<string>;
  194. streetLine2?: Maybe<string>;
  195. city?: Maybe<string>;
  196. province?: Maybe<string>;
  197. postalCode?: Maybe<string>;
  198. countryCode?: Maybe<string>;
  199. phoneNumber?: Maybe<string>;
  200. defaultShippingAddress?: Maybe<boolean>;
  201. defaultBillingAddress?: Maybe<boolean>;
  202. customFields?: Maybe<Json>;
  203. }
  204. export interface ConfigArgInput {
  205. name: string;
  206. type: ConfigArgType;
  207. value?: Maybe<string>;
  208. }
  209. export interface ConfigurableOperationInput {
  210. code: string;
  211. arguments: ConfigArgInput[];
  212. }
  213. /** ISO 639-1 language code */
  214. export enum LanguageCode {
  215. aa = 'aa',
  216. ab = 'ab',
  217. af = 'af',
  218. ak = 'ak',
  219. sq = 'sq',
  220. am = 'am',
  221. ar = 'ar',
  222. an = 'an',
  223. hy = 'hy',
  224. as = 'as',
  225. av = 'av',
  226. ae = 'ae',
  227. ay = 'ay',
  228. az = 'az',
  229. ba = 'ba',
  230. bm = 'bm',
  231. eu = 'eu',
  232. be = 'be',
  233. bn = 'bn',
  234. bh = 'bh',
  235. bi = 'bi',
  236. bs = 'bs',
  237. br = 'br',
  238. bg = 'bg',
  239. my = 'my',
  240. ca = 'ca',
  241. ch = 'ch',
  242. ce = 'ce',
  243. zh = 'zh',
  244. cu = 'cu',
  245. cv = 'cv',
  246. kw = 'kw',
  247. co = 'co',
  248. cr = 'cr',
  249. cs = 'cs',
  250. da = 'da',
  251. dv = 'dv',
  252. nl = 'nl',
  253. dz = 'dz',
  254. en = 'en',
  255. eo = 'eo',
  256. et = 'et',
  257. ee = 'ee',
  258. fo = 'fo',
  259. fj = 'fj',
  260. fi = 'fi',
  261. fr = 'fr',
  262. fy = 'fy',
  263. ff = 'ff',
  264. ka = 'ka',
  265. de = 'de',
  266. gd = 'gd',
  267. ga = 'ga',
  268. gl = 'gl',
  269. gv = 'gv',
  270. el = 'el',
  271. gn = 'gn',
  272. gu = 'gu',
  273. ht = 'ht',
  274. ha = 'ha',
  275. he = 'he',
  276. hz = 'hz',
  277. hi = 'hi',
  278. ho = 'ho',
  279. hr = 'hr',
  280. hu = 'hu',
  281. ig = 'ig',
  282. is = 'is',
  283. io = 'io',
  284. ii = 'ii',
  285. iu = 'iu',
  286. ie = 'ie',
  287. ia = 'ia',
  288. id = 'id',
  289. ik = 'ik',
  290. it = 'it',
  291. jv = 'jv',
  292. ja = 'ja',
  293. kl = 'kl',
  294. kn = 'kn',
  295. ks = 'ks',
  296. kr = 'kr',
  297. kk = 'kk',
  298. km = 'km',
  299. ki = 'ki',
  300. rw = 'rw',
  301. ky = 'ky',
  302. kv = 'kv',
  303. kg = 'kg',
  304. ko = 'ko',
  305. kj = 'kj',
  306. ku = 'ku',
  307. lo = 'lo',
  308. la = 'la',
  309. lv = 'lv',
  310. li = 'li',
  311. ln = 'ln',
  312. lt = 'lt',
  313. lb = 'lb',
  314. lu = 'lu',
  315. lg = 'lg',
  316. mk = 'mk',
  317. mh = 'mh',
  318. ml = 'ml',
  319. mi = 'mi',
  320. mr = 'mr',
  321. ms = 'ms',
  322. mg = 'mg',
  323. mt = 'mt',
  324. mn = 'mn',
  325. na = 'na',
  326. nv = 'nv',
  327. nr = 'nr',
  328. nd = 'nd',
  329. ng = 'ng',
  330. ne = 'ne',
  331. nn = 'nn',
  332. nb = 'nb',
  333. no = 'no',
  334. ny = 'ny',
  335. oc = 'oc',
  336. oj = 'oj',
  337. or = 'or',
  338. om = 'om',
  339. os = 'os',
  340. pa = 'pa',
  341. fa = 'fa',
  342. pi = 'pi',
  343. pl = 'pl',
  344. pt = 'pt',
  345. ps = 'ps',
  346. qu = 'qu',
  347. rm = 'rm',
  348. ro = 'ro',
  349. rn = 'rn',
  350. ru = 'ru',
  351. sg = 'sg',
  352. sa = 'sa',
  353. si = 'si',
  354. sk = 'sk',
  355. sl = 'sl',
  356. se = 'se',
  357. sm = 'sm',
  358. sn = 'sn',
  359. sd = 'sd',
  360. so = 'so',
  361. st = 'st',
  362. es = 'es',
  363. sc = 'sc',
  364. sr = 'sr',
  365. ss = 'ss',
  366. su = 'su',
  367. sw = 'sw',
  368. sv = 'sv',
  369. ty = 'ty',
  370. ta = 'ta',
  371. tt = 'tt',
  372. te = 'te',
  373. tg = 'tg',
  374. tl = 'tl',
  375. th = 'th',
  376. bo = 'bo',
  377. ti = 'ti',
  378. to = 'to',
  379. tn = 'tn',
  380. ts = 'ts',
  381. tk = 'tk',
  382. tr = 'tr',
  383. tw = 'tw',
  384. ug = 'ug',
  385. uk = 'uk',
  386. ur = 'ur',
  387. uz = 'uz',
  388. ve = 've',
  389. vi = 'vi',
  390. vo = 'vo',
  391. cy = 'cy',
  392. wa = 'wa',
  393. wo = 'wo',
  394. xh = 'xh',
  395. yi = 'yi',
  396. yo = 'yo',
  397. za = 'za',
  398. zu = 'zu',
  399. }
  400. export enum SortOrder {
  401. ASC = 'ASC',
  402. DESC = 'DESC',
  403. }
  404. export enum AssetType {
  405. IMAGE = 'IMAGE',
  406. VIDEO = 'VIDEO',
  407. BINARY = 'BINARY',
  408. }
  409. /** ISO 4217 currency code */
  410. export enum CurrencyCode {
  411. AED = 'AED',
  412. AFN = 'AFN',
  413. ALL = 'ALL',
  414. AMD = 'AMD',
  415. ANG = 'ANG',
  416. AOA = 'AOA',
  417. ARS = 'ARS',
  418. AUD = 'AUD',
  419. AWG = 'AWG',
  420. AZN = 'AZN',
  421. BAM = 'BAM',
  422. BBD = 'BBD',
  423. BDT = 'BDT',
  424. BGN = 'BGN',
  425. BHD = 'BHD',
  426. BIF = 'BIF',
  427. BMD = 'BMD',
  428. BND = 'BND',
  429. BOB = 'BOB',
  430. BRL = 'BRL',
  431. BSD = 'BSD',
  432. BTN = 'BTN',
  433. BWP = 'BWP',
  434. BYN = 'BYN',
  435. BZD = 'BZD',
  436. CAD = 'CAD',
  437. CHE = 'CHE',
  438. CHW = 'CHW',
  439. CLP = 'CLP',
  440. CNY = 'CNY',
  441. COP = 'COP',
  442. CRC = 'CRC',
  443. CUC = 'CUC',
  444. CUP = 'CUP',
  445. CVE = 'CVE',
  446. CZK = 'CZK',
  447. DJF = 'DJF',
  448. DKK = 'DKK',
  449. DOP = 'DOP',
  450. DZD = 'DZD',
  451. EGP = 'EGP',
  452. ERN = 'ERN',
  453. ETB = 'ETB',
  454. EUR = 'EUR',
  455. FJD = 'FJD',
  456. FKP = 'FKP',
  457. GBP = 'GBP',
  458. GEL = 'GEL',
  459. GHS = 'GHS',
  460. GIP = 'GIP',
  461. GMD = 'GMD',
  462. GNF = 'GNF',
  463. GTQ = 'GTQ',
  464. GYD = 'GYD',
  465. HKD = 'HKD',
  466. HNL = 'HNL',
  467. HRK = 'HRK',
  468. HTG = 'HTG',
  469. HUF = 'HUF',
  470. IDR = 'IDR',
  471. ILS = 'ILS',
  472. INR = 'INR',
  473. IQD = 'IQD',
  474. IRR = 'IRR',
  475. ISK = 'ISK',
  476. JMD = 'JMD',
  477. JOD = 'JOD',
  478. JPY = 'JPY',
  479. KES = 'KES',
  480. KGS = 'KGS',
  481. KHR = 'KHR',
  482. KMF = 'KMF',
  483. KPW = 'KPW',
  484. KRW = 'KRW',
  485. KWD = 'KWD',
  486. KYD = 'KYD',
  487. KZT = 'KZT',
  488. LAK = 'LAK',
  489. LBP = 'LBP',
  490. LKR = 'LKR',
  491. LRD = 'LRD',
  492. LSL = 'LSL',
  493. LYD = 'LYD',
  494. MAD = 'MAD',
  495. MDL = 'MDL',
  496. MGA = 'MGA',
  497. MKD = 'MKD',
  498. MMK = 'MMK',
  499. MNT = 'MNT',
  500. MOP = 'MOP',
  501. MRU = 'MRU',
  502. MUR = 'MUR',
  503. MVR = 'MVR',
  504. MWK = 'MWK',
  505. MXN = 'MXN',
  506. MYR = 'MYR',
  507. MZN = 'MZN',
  508. NAD = 'NAD',
  509. NGN = 'NGN',
  510. NIO = 'NIO',
  511. NOK = 'NOK',
  512. NPR = 'NPR',
  513. NZD = 'NZD',
  514. OMR = 'OMR',
  515. PAB = 'PAB',
  516. PEN = 'PEN',
  517. PGK = 'PGK',
  518. PHP = 'PHP',
  519. PKR = 'PKR',
  520. PLN = 'PLN',
  521. PYG = 'PYG',
  522. QAR = 'QAR',
  523. RON = 'RON',
  524. RSD = 'RSD',
  525. RUB = 'RUB',
  526. RWF = 'RWF',
  527. SAR = 'SAR',
  528. SBD = 'SBD',
  529. SCR = 'SCR',
  530. SDG = 'SDG',
  531. SEK = 'SEK',
  532. SGD = 'SGD',
  533. SHP = 'SHP',
  534. SLL = 'SLL',
  535. SOS = 'SOS',
  536. SRD = 'SRD',
  537. SSP = 'SSP',
  538. STN = 'STN',
  539. SVC = 'SVC',
  540. SYP = 'SYP',
  541. SZL = 'SZL',
  542. THB = 'THB',
  543. TJS = 'TJS',
  544. TMT = 'TMT',
  545. TND = 'TND',
  546. TOP = 'TOP',
  547. TRY = 'TRY',
  548. TTD = 'TTD',
  549. TWD = 'TWD',
  550. TZS = 'TZS',
  551. UAH = 'UAH',
  552. UGX = 'UGX',
  553. USD = 'USD',
  554. UYU = 'UYU',
  555. UZS = 'UZS',
  556. VES = 'VES',
  557. VND = 'VND',
  558. VUV = 'VUV',
  559. WST = 'WST',
  560. XAF = 'XAF',
  561. XCD = 'XCD',
  562. XOF = 'XOF',
  563. XPF = 'XPF',
  564. YER = 'YER',
  565. ZAR = 'ZAR',
  566. ZMW = 'ZMW',
  567. ZWL = 'ZWL',
  568. }
  569. export enum AdjustmentType {
  570. TAX = 'TAX',
  571. PROMOTION = 'PROMOTION',
  572. SHIPPING = 'SHIPPING',
  573. REFUND = 'REFUND',
  574. TAX_REFUND = 'TAX_REFUND',
  575. PROMOTION_REFUND = 'PROMOTION_REFUND',
  576. SHIPPING_REFUND = 'SHIPPING_REFUND',
  577. }
  578. /** Certain entities allow arbitrary configuration arguments to be specified which can then be set in the admin-ui and used in the business logic of the app. These are the valid data types of such arguments. The data type influences: 1. How the argument form field is rendered in the admin-ui 2. The JavaScript type into which the value is coerced before being passed to the business logic. */
  579. export enum ConfigArgType {
  580. PERCENTAGE = 'PERCENTAGE',
  581. MONEY = 'MONEY',
  582. INT = 'INT',
  583. STRING = 'STRING',
  584. DATETIME = 'DATETIME',
  585. BOOLEAN = 'BOOLEAN',
  586. FACET_VALUE_IDS = 'FACET_VALUE_IDS',
  587. }
  588. /** Permissions for administrators and customers */
  589. export enum Permission {
  590. Authenticated = 'Authenticated',
  591. SuperAdmin = 'SuperAdmin',
  592. Owner = 'Owner',
  593. Public = 'Public',
  594. CreateCatalog = 'CreateCatalog',
  595. ReadCatalog = 'ReadCatalog',
  596. UpdateCatalog = 'UpdateCatalog',
  597. DeleteCatalog = 'DeleteCatalog',
  598. CreateCustomer = 'CreateCustomer',
  599. ReadCustomer = 'ReadCustomer',
  600. UpdateCustomer = 'UpdateCustomer',
  601. DeleteCustomer = 'DeleteCustomer',
  602. CreateAdministrator = 'CreateAdministrator',
  603. ReadAdministrator = 'ReadAdministrator',
  604. UpdateAdministrator = 'UpdateAdministrator',
  605. DeleteAdministrator = 'DeleteAdministrator',
  606. CreateOrder = 'CreateOrder',
  607. ReadOrder = 'ReadOrder',
  608. UpdateOrder = 'UpdateOrder',
  609. DeleteOrder = 'DeleteOrder',
  610. CreateSettings = 'CreateSettings',
  611. ReadSettings = 'ReadSettings',
  612. UpdateSettings = 'UpdateSettings',
  613. DeleteSettings = 'DeleteSettings',
  614. }
  615. export enum DeletionResult {
  616. DELETED = 'DELETED',
  617. NOT_DELETED = 'NOT_DELETED',
  618. }
  619. /** 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. */
  620. export type DateTime = any;
  621. /** The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf). */
  622. export type Json = any;
  623. /** The `Upload` scalar type represents a file upload. */
  624. export type Upload = any;
  625. // ====================================================
  626. // Scalars
  627. // ====================================================
  628. // ====================================================
  629. // Interfaces
  630. // ====================================================
  631. export interface Node {
  632. id: string;
  633. }
  634. export interface PaginatedList {
  635. items: Node[];
  636. totalItems: number;
  637. }
  638. // ====================================================
  639. // Types
  640. // ====================================================
  641. export interface Query {
  642. activeCustomer?: Maybe<Customer>;
  643. activeOrder?: Maybe<Order>;
  644. availableCountries: Country[];
  645. collections: CollectionList;
  646. collection?: Maybe<Collection>;
  647. eligibleShippingMethods: ShippingMethodQuote[];
  648. me?: Maybe<CurrentUser>;
  649. nextOrderStates: string[];
  650. order?: Maybe<Order>;
  651. orderByCode?: Maybe<Order>;
  652. product?: Maybe<Product>;
  653. products: ProductList;
  654. search: SearchResponse;
  655. temp__?: Maybe<boolean>;
  656. }
  657. export interface Customer extends Node {
  658. id: string;
  659. createdAt: DateTime;
  660. updatedAt: DateTime;
  661. title?: Maybe<string>;
  662. firstName: string;
  663. lastName: string;
  664. phoneNumber?: Maybe<string>;
  665. emailAddress: string;
  666. addresses?: Maybe<Address[]>;
  667. orders: OrderList;
  668. user?: Maybe<User>;
  669. customFields?: Maybe<Json>;
  670. }
  671. export interface Address extends Node {
  672. id: string;
  673. createdAt: DateTime;
  674. updatedAt: DateTime;
  675. fullName?: Maybe<string>;
  676. company?: Maybe<string>;
  677. streetLine1: string;
  678. streetLine2?: Maybe<string>;
  679. city?: Maybe<string>;
  680. province?: Maybe<string>;
  681. postalCode?: Maybe<string>;
  682. country: Country;
  683. phoneNumber?: Maybe<string>;
  684. defaultShippingAddress?: Maybe<boolean>;
  685. defaultBillingAddress?: Maybe<boolean>;
  686. customFields?: Maybe<Json>;
  687. }
  688. export interface Country extends Node {
  689. id: string;
  690. languageCode: LanguageCode;
  691. code: string;
  692. name: string;
  693. enabled: boolean;
  694. translations: CountryTranslation[];
  695. }
  696. export interface CountryTranslation {
  697. id: string;
  698. createdAt: DateTime;
  699. updatedAt: DateTime;
  700. languageCode: LanguageCode;
  701. name: string;
  702. }
  703. export interface OrderList extends PaginatedList {
  704. items: Order[];
  705. totalItems: number;
  706. }
  707. export interface Order extends Node {
  708. id: string;
  709. createdAt: DateTime;
  710. updatedAt: DateTime;
  711. code: string;
  712. state: string;
  713. active: boolean;
  714. customer?: Maybe<Customer>;
  715. shippingAddress?: Maybe<OrderAddress>;
  716. billingAddress?: Maybe<OrderAddress>;
  717. lines: OrderLine[];
  718. adjustments: Adjustment[];
  719. payments?: Maybe<Payment[]>;
  720. subTotalBeforeTax: number;
  721. subTotal: number;
  722. currencyCode: CurrencyCode;
  723. shipping: number;
  724. shippingMethod?: Maybe<ShippingMethod>;
  725. totalBeforeTax: number;
  726. total: number;
  727. }
  728. export interface OrderAddress {
  729. fullName?: Maybe<string>;
  730. company?: Maybe<string>;
  731. streetLine1?: Maybe<string>;
  732. streetLine2?: Maybe<string>;
  733. city?: Maybe<string>;
  734. province?: Maybe<string>;
  735. postalCode?: Maybe<string>;
  736. country?: Maybe<string>;
  737. countryCode?: Maybe<string>;
  738. phoneNumber?: Maybe<string>;
  739. }
  740. export interface OrderLine extends Node {
  741. id: string;
  742. createdAt: DateTime;
  743. updatedAt: DateTime;
  744. productVariant: ProductVariant;
  745. featuredAsset?: Maybe<Asset>;
  746. unitPrice: number;
  747. unitPriceWithTax: number;
  748. quantity: number;
  749. items: OrderItem[];
  750. totalPrice: number;
  751. adjustments: Adjustment[];
  752. order: Order;
  753. }
  754. export interface ProductVariant extends Node {
  755. id: string;
  756. productId: string;
  757. createdAt: DateTime;
  758. updatedAt: DateTime;
  759. languageCode: LanguageCode;
  760. sku: string;
  761. name: string;
  762. featuredAsset?: Maybe<Asset>;
  763. assets: Asset[];
  764. price: number;
  765. currencyCode: CurrencyCode;
  766. priceIncludesTax: boolean;
  767. priceWithTax: number;
  768. taxRateApplied: TaxRate;
  769. taxCategory: TaxCategory;
  770. options: ProductOption[];
  771. facetValues: FacetValue[];
  772. translations: ProductVariantTranslation[];
  773. customFields?: Maybe<Json>;
  774. }
  775. export interface Asset extends Node {
  776. id: string;
  777. name: string;
  778. type: AssetType;
  779. fileSize: number;
  780. mimeType: string;
  781. source: string;
  782. preview: string;
  783. }
  784. export interface TaxRate extends Node {
  785. id: string;
  786. createdAt: DateTime;
  787. updatedAt: DateTime;
  788. name: string;
  789. enabled: boolean;
  790. value: number;
  791. category: TaxCategory;
  792. zone: Zone;
  793. customerGroup?: Maybe<CustomerGroup>;
  794. }
  795. export interface TaxCategory extends Node {
  796. id: string;
  797. createdAt: DateTime;
  798. updatedAt: DateTime;
  799. name: string;
  800. }
  801. export interface Zone extends Node {
  802. id: string;
  803. createdAt: DateTime;
  804. updatedAt: DateTime;
  805. name: string;
  806. members: Country[];
  807. }
  808. export interface CustomerGroup extends Node {
  809. id: string;
  810. createdAt: DateTime;
  811. updatedAt: DateTime;
  812. name: string;
  813. }
  814. export interface ProductOption extends Node {
  815. id: string;
  816. createdAt: DateTime;
  817. updatedAt: DateTime;
  818. languageCode?: Maybe<LanguageCode>;
  819. code?: Maybe<string>;
  820. name?: Maybe<string>;
  821. translations: ProductOptionTranslation[];
  822. customFields?: Maybe<Json>;
  823. }
  824. export interface ProductOptionTranslation {
  825. id: string;
  826. createdAt: DateTime;
  827. updatedAt: DateTime;
  828. languageCode: LanguageCode;
  829. name: string;
  830. }
  831. export interface FacetValue extends Node {
  832. id: string;
  833. createdAt: DateTime;
  834. updatedAt: DateTime;
  835. languageCode: LanguageCode;
  836. facet: Facet;
  837. name: string;
  838. code: string;
  839. translations: FacetValueTranslation[];
  840. customFields?: Maybe<Json>;
  841. }
  842. export interface Facet extends Node {
  843. id: string;
  844. createdAt: DateTime;
  845. updatedAt: DateTime;
  846. languageCode: LanguageCode;
  847. name: string;
  848. code: string;
  849. values: FacetValue[];
  850. translations: FacetTranslation[];
  851. customFields?: Maybe<Json>;
  852. }
  853. export interface FacetTranslation {
  854. id: string;
  855. createdAt: DateTime;
  856. updatedAt: DateTime;
  857. languageCode: LanguageCode;
  858. name: string;
  859. }
  860. export interface FacetValueTranslation {
  861. id: string;
  862. createdAt: DateTime;
  863. updatedAt: DateTime;
  864. languageCode: LanguageCode;
  865. name: string;
  866. }
  867. export interface ProductVariantTranslation {
  868. id: string;
  869. createdAt: DateTime;
  870. updatedAt: DateTime;
  871. languageCode: LanguageCode;
  872. name: string;
  873. }
  874. export interface OrderItem extends Node {
  875. id: string;
  876. createdAt: DateTime;
  877. updatedAt: DateTime;
  878. unitPrice: number;
  879. unitPriceWithTax: number;
  880. unitPriceIncludesTax: boolean;
  881. taxRate: number;
  882. adjustments: Adjustment[];
  883. }
  884. export interface Adjustment {
  885. adjustmentSource: string;
  886. type: AdjustmentType;
  887. description: string;
  888. amount: number;
  889. }
  890. export interface Payment extends Node {
  891. id: string;
  892. createdAt: DateTime;
  893. updatedAt: DateTime;
  894. method: string;
  895. amount: number;
  896. state: string;
  897. transactionId?: Maybe<string>;
  898. metadata?: Maybe<Json>;
  899. }
  900. export interface ShippingMethod extends Node {
  901. id: string;
  902. createdAt: DateTime;
  903. updatedAt: DateTime;
  904. code: string;
  905. description: string;
  906. checker: ConfigurableOperation;
  907. calculator: ConfigurableOperation;
  908. }
  909. export interface ConfigurableOperation {
  910. code: string;
  911. args: ConfigArg[];
  912. description: string;
  913. }
  914. export interface ConfigArg {
  915. name: string;
  916. type: ConfigArgType;
  917. value?: Maybe<string>;
  918. }
  919. export interface User extends Node {
  920. id: string;
  921. createdAt: DateTime;
  922. updatedAt: DateTime;
  923. identifier: string;
  924. verified: boolean;
  925. roles: Role[];
  926. lastLogin?: Maybe<string>;
  927. customFields?: Maybe<Json>;
  928. }
  929. export interface Role extends Node {
  930. id: string;
  931. createdAt: DateTime;
  932. updatedAt: DateTime;
  933. code: string;
  934. description: string;
  935. permissions: Permission[];
  936. channels: Channel[];
  937. }
  938. export interface Channel extends Node {
  939. id: string;
  940. createdAt: DateTime;
  941. updatedAt: DateTime;
  942. code: string;
  943. token: string;
  944. defaultTaxZone?: Maybe<Zone>;
  945. defaultShippingZone?: Maybe<Zone>;
  946. defaultLanguageCode: LanguageCode;
  947. currencyCode: CurrencyCode;
  948. pricesIncludeTax: boolean;
  949. }
  950. export interface CollectionList extends PaginatedList {
  951. items: Collection[];
  952. totalItems: number;
  953. }
  954. export interface Collection extends Node {
  955. id: string;
  956. createdAt: DateTime;
  957. updatedAt: DateTime;
  958. languageCode?: Maybe<LanguageCode>;
  959. name: string;
  960. breadcrumbs: CollectionBreadcrumb[];
  961. position: number;
  962. description: string;
  963. featuredAsset?: Maybe<Asset>;
  964. assets: Asset[];
  965. parent: Collection;
  966. children?: Maybe<Collection[]>;
  967. filters: ConfigurableOperation[];
  968. translations: CollectionTranslation[];
  969. productVariants: ProductVariantList;
  970. customFields?: Maybe<Json>;
  971. }
  972. export interface CollectionBreadcrumb {
  973. id: string;
  974. name: string;
  975. }
  976. export interface CollectionTranslation {
  977. id: string;
  978. createdAt: DateTime;
  979. updatedAt: DateTime;
  980. languageCode: LanguageCode;
  981. name: string;
  982. description: string;
  983. }
  984. export interface ProductVariantList extends PaginatedList {
  985. items: ProductVariant[];
  986. totalItems: number;
  987. }
  988. export interface ShippingMethodQuote {
  989. id: string;
  990. price: number;
  991. description: string;
  992. }
  993. export interface CurrentUser {
  994. id: string;
  995. identifier: string;
  996. channelTokens: string[];
  997. }
  998. export interface Product extends Node {
  999. id: string;
  1000. createdAt: DateTime;
  1001. updatedAt: DateTime;
  1002. languageCode: LanguageCode;
  1003. name: string;
  1004. slug: string;
  1005. description: string;
  1006. featuredAsset?: Maybe<Asset>;
  1007. assets: Asset[];
  1008. variants: ProductVariant[];
  1009. optionGroups: ProductOptionGroup[];
  1010. facetValues: FacetValue[];
  1011. translations: ProductTranslation[];
  1012. customFields?: Maybe<Json>;
  1013. }
  1014. export interface ProductOptionGroup extends Node {
  1015. id: string;
  1016. createdAt: DateTime;
  1017. updatedAt: DateTime;
  1018. languageCode: LanguageCode;
  1019. code: string;
  1020. name: string;
  1021. options: ProductOption[];
  1022. translations: ProductOptionGroupTranslation[];
  1023. customFields?: Maybe<Json>;
  1024. }
  1025. export interface ProductOptionGroupTranslation {
  1026. id: string;
  1027. createdAt: DateTime;
  1028. updatedAt: DateTime;
  1029. languageCode: LanguageCode;
  1030. name: string;
  1031. }
  1032. export interface ProductTranslation {
  1033. id: string;
  1034. createdAt: DateTime;
  1035. updatedAt: DateTime;
  1036. languageCode: LanguageCode;
  1037. name: string;
  1038. slug: string;
  1039. description: string;
  1040. }
  1041. export interface ProductList extends PaginatedList {
  1042. items: Product[];
  1043. totalItems: number;
  1044. }
  1045. export interface SearchResponse {
  1046. items: SearchResult[];
  1047. totalItems: number;
  1048. facetValues: FacetValue[];
  1049. }
  1050. export interface SearchResult {
  1051. sku: string;
  1052. slug: string;
  1053. productId: string;
  1054. productName: string;
  1055. productPreview: string;
  1056. productVariantId: string;
  1057. productVariantName: string;
  1058. productVariantPreview: string;
  1059. price: number;
  1060. currencyCode: CurrencyCode;
  1061. description: string;
  1062. facetIds: string[];
  1063. facetValueIds: string[];
  1064. collectionIds: string[];
  1065. score: number;
  1066. }
  1067. export interface Mutation {
  1068. addItemToOrder?: Maybe<Order>;
  1069. removeItemFromOrder?: Maybe<Order>;
  1070. adjustItemQuantity?: Maybe<Order>;
  1071. transitionOrderToState?: Maybe<Order>;
  1072. setOrderShippingAddress?: Maybe<Order>;
  1073. setOrderShippingMethod?: Maybe<Order>;
  1074. addPaymentToOrder?: Maybe<Order>;
  1075. setCustomerForOrder?: Maybe<Order>;
  1076. login: LoginResult;
  1077. logout: boolean;
  1078. /** Regenerate and send a verification token for a new Customer registration. Only applicable if `authOptions.requireVerification` is set to true. */
  1079. refreshCustomerVerification: boolean;
  1080. /** Register a Customer account with the given credentials */
  1081. registerCustomerAccount: boolean;
  1082. /** Update an existing Customer */
  1083. updateCustomer: Customer;
  1084. /** Create a new Customer Address */
  1085. createCustomerAddress: Address;
  1086. /** Update an existing Address */
  1087. updateCustomerAddress: Address;
  1088. /** Delete an existing Address */
  1089. deleteCustomerAddress: boolean;
  1090. /** Verify a Customer email address with the token sent to that address. Only applicable if `authOptions.requireVerification` is set to true. */
  1091. verifyCustomerAccount: LoginResult;
  1092. /** Update the password of the active Customer */
  1093. updateCustomerPassword?: Maybe<boolean>;
  1094. /** Requests a password reset email to be sent */
  1095. requestPasswordReset?: Maybe<boolean>;
  1096. /** Resets a Customer's password based on the provided token */
  1097. resetPassword: LoginResult;
  1098. }
  1099. export interface LoginResult {
  1100. user: CurrentUser;
  1101. }
  1102. export interface AdjustmentOperations {
  1103. conditions: ConfigurableOperation[];
  1104. actions: ConfigurableOperation[];
  1105. }
  1106. export interface Administrator extends Node {
  1107. id: string;
  1108. createdAt: DateTime;
  1109. updatedAt: DateTime;
  1110. firstName: string;
  1111. lastName: string;
  1112. emailAddress: string;
  1113. user: User;
  1114. }
  1115. export interface AdministratorList extends PaginatedList {
  1116. items: Administrator[];
  1117. totalItems: number;
  1118. }
  1119. export interface AssetList extends PaginatedList {
  1120. items: Asset[];
  1121. totalItems: number;
  1122. }
  1123. export interface CountryList extends PaginatedList {
  1124. items: Country[];
  1125. totalItems: number;
  1126. }
  1127. export interface CustomerList extends PaginatedList {
  1128. items: Customer[];
  1129. totalItems: number;
  1130. }
  1131. export interface DeletionResponse {
  1132. result: DeletionResult;
  1133. message?: Maybe<string>;
  1134. }
  1135. export interface FacetList extends PaginatedList {
  1136. items: Facet[];
  1137. totalItems: number;
  1138. }
  1139. export interface GlobalSettings {
  1140. id: string;
  1141. createdAt: DateTime;
  1142. updatedAt: DateTime;
  1143. availableLanguages: LanguageCode[];
  1144. serverConfig: ServerConfig;
  1145. customFields?: Maybe<Json>;
  1146. }
  1147. export interface ServerConfig {
  1148. customFields?: Maybe<Json>;
  1149. }
  1150. export interface ImportInfo {
  1151. errors?: Maybe<string[]>;
  1152. processed: number;
  1153. imported: number;
  1154. }
  1155. export interface PaymentMethod extends Node {
  1156. id: string;
  1157. createdAt: DateTime;
  1158. updatedAt: DateTime;
  1159. code: string;
  1160. enabled: boolean;
  1161. configArgs: ConfigArg[];
  1162. }
  1163. export interface Promotion extends Node {
  1164. id: string;
  1165. createdAt: DateTime;
  1166. updatedAt: DateTime;
  1167. name: string;
  1168. enabled: boolean;
  1169. conditions: ConfigurableOperation[];
  1170. actions: ConfigurableOperation[];
  1171. }
  1172. export interface PromotionList extends PaginatedList {
  1173. items: Promotion[];
  1174. totalItems: number;
  1175. }
  1176. export interface RoleList extends PaginatedList {
  1177. items: Role[];
  1178. totalItems: number;
  1179. }
  1180. export interface SearchReindexResponse {
  1181. success: boolean;
  1182. timeTaken: number;
  1183. indexedItemCount: number;
  1184. }
  1185. export interface ShippingMethodList extends PaginatedList {
  1186. items: ShippingMethod[];
  1187. totalItems: number;
  1188. }
  1189. export interface TaxRateList extends PaginatedList {
  1190. items: TaxRate[];
  1191. totalItems: number;
  1192. }
  1193. // ====================================================
  1194. // Arguments
  1195. // ====================================================
  1196. export interface CollectionsQueryArgs {
  1197. languageCode?: Maybe<LanguageCode>;
  1198. options?: Maybe<CollectionListOptions>;
  1199. }
  1200. export interface CollectionQueryArgs {
  1201. id: string;
  1202. languageCode?: Maybe<LanguageCode>;
  1203. }
  1204. export interface OrderQueryArgs {
  1205. id: string;
  1206. }
  1207. export interface OrderByCodeQueryArgs {
  1208. code: string;
  1209. }
  1210. export interface ProductQueryArgs {
  1211. id: string;
  1212. languageCode?: Maybe<LanguageCode>;
  1213. }
  1214. export interface ProductsQueryArgs {
  1215. languageCode?: Maybe<LanguageCode>;
  1216. options?: Maybe<ProductListOptions>;
  1217. }
  1218. export interface SearchQueryArgs {
  1219. input: SearchInput;
  1220. }
  1221. export interface OrdersCustomerArgs {
  1222. options?: Maybe<OrderListOptions>;
  1223. }
  1224. export interface ProductVariantsCollectionArgs {
  1225. options?: Maybe<ProductVariantListOptions>;
  1226. }
  1227. export interface AddItemToOrderMutationArgs {
  1228. productVariantId: string;
  1229. quantity: number;
  1230. }
  1231. export interface RemoveItemFromOrderMutationArgs {
  1232. orderItemId: string;
  1233. }
  1234. export interface AdjustItemQuantityMutationArgs {
  1235. orderItemId: string;
  1236. quantity: number;
  1237. }
  1238. export interface TransitionOrderToStateMutationArgs {
  1239. state: string;
  1240. }
  1241. export interface SetOrderShippingAddressMutationArgs {
  1242. input: CreateAddressInput;
  1243. }
  1244. export interface SetOrderShippingMethodMutationArgs {
  1245. shippingMethodId: string;
  1246. }
  1247. export interface AddPaymentToOrderMutationArgs {
  1248. input: PaymentInput;
  1249. }
  1250. export interface SetCustomerForOrderMutationArgs {
  1251. input: CreateCustomerInput;
  1252. }
  1253. export interface LoginMutationArgs {
  1254. username: string;
  1255. password: string;
  1256. rememberMe?: Maybe<boolean>;
  1257. }
  1258. export interface RefreshCustomerVerificationMutationArgs {
  1259. emailAddress: string;
  1260. }
  1261. export interface RegisterCustomerAccountMutationArgs {
  1262. input: RegisterCustomerInput;
  1263. }
  1264. export interface UpdateCustomerMutationArgs {
  1265. input: UpdateCustomerInput;
  1266. }
  1267. export interface CreateCustomerAddressMutationArgs {
  1268. input: CreateAddressInput;
  1269. }
  1270. export interface UpdateCustomerAddressMutationArgs {
  1271. input: UpdateAddressInput;
  1272. }
  1273. export interface DeleteCustomerAddressMutationArgs {
  1274. id: string;
  1275. }
  1276. export interface VerifyCustomerAccountMutationArgs {
  1277. token: string;
  1278. password: string;
  1279. }
  1280. export interface UpdateCustomerPasswordMutationArgs {
  1281. currentPassword: string;
  1282. newPassword: string;
  1283. }
  1284. export interface RequestPasswordResetMutationArgs {
  1285. emailAddress: string;
  1286. }
  1287. export interface ResetPasswordMutationArgs {
  1288. token: string;
  1289. password: string;
  1290. }