generated-shop-types.ts 31 KB

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