generated-shop-types.ts 29 KB

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