generated-shop-types.ts 30 KB

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