generated-shop-types.ts 31 KB

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