generated-shop-types.ts 31 KB

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