@faststore/api 2.2.38 → 2.2.43

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (520) hide show
  1. package/dist/cjs/package.json +79 -0
  2. package/dist/{__generated__ → cjs/src/__generated__}/schema.d.ts +1045 -1045
  3. package/dist/cjs/src/__generated__/schema.js +7 -0
  4. package/dist/cjs/src/__generated__/schema.js.map +1 -0
  5. package/dist/{directives → cjs/src/directives}/cacheControl.d.ts +9 -9
  6. package/dist/cjs/src/directives/cacheControl.js +45 -0
  7. package/dist/cjs/src/directives/cacheControl.js.map +1 -0
  8. package/dist/{directives → cjs/src/directives}/index.d.ts +5 -5
  9. package/dist/cjs/src/directives/index.js +3 -0
  10. package/dist/cjs/src/directives/index.js.map +1 -0
  11. package/dist/{index.d.ts → cjs/src/index.d.ts} +163 -163
  12. package/dist/cjs/src/index.js +38 -0
  13. package/dist/cjs/src/index.js.map +1 -0
  14. package/dist/{platforms → cjs/src/platforms}/errors.d.ts +19 -19
  15. package/dist/cjs/src/platforms/errors.js +30 -0
  16. package/dist/cjs/src/platforms/errors.js.map +1 -0
  17. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/index.d.ts +75 -75
  18. package/dist/cjs/src/platforms/vtex/clients/commerce/index.js +165 -0
  19. package/dist/cjs/src/platforms/vtex/clients/commerce/index.js.map +1 -0
  20. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/Address.d.ts +16 -16
  21. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Address.js +3 -0
  22. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Address.js.map +1 -0
  23. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/Brand.d.ts +8 -8
  24. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Brand.js +3 -0
  25. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Brand.js.map +1 -0
  26. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/CategoryTree.d.ts +9 -9
  27. package/dist/cjs/src/platforms/vtex/clients/commerce/types/CategoryTree.js +3 -0
  28. package/dist/cjs/src/platforms/vtex/clients/commerce/types/CategoryTree.js.map +1 -0
  29. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/Newsletter.d.ts +4 -4
  30. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Newsletter.js +3 -0
  31. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Newsletter.js.map +1 -0
  32. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/OrderForm.d.ts +371 -371
  33. package/dist/cjs/src/platforms/vtex/clients/commerce/types/OrderForm.js +3 -0
  34. package/dist/cjs/src/platforms/vtex/clients/commerce/types/OrderForm.js.map +1 -0
  35. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/Portal.d.ts +17 -17
  36. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Portal.js +3 -0
  37. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Portal.js.map +1 -0
  38. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/Product.d.ts +174 -174
  39. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Product.js +53 -0
  40. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Product.js.map +1 -0
  41. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/Region.d.ts +19 -19
  42. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Region.js +3 -0
  43. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Region.js.map +1 -0
  44. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/SalesChannel.d.ts +24 -24
  45. package/dist/cjs/src/platforms/vtex/clients/commerce/types/SalesChannel.js +3 -0
  46. package/dist/cjs/src/platforms/vtex/clients/commerce/types/SalesChannel.js.map +1 -0
  47. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/Session.d.ts +33 -33
  48. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Session.js +3 -0
  49. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Session.js.map +1 -0
  50. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/ShippingData.d.ts +38 -38
  51. package/dist/cjs/src/platforms/vtex/clients/commerce/types/ShippingData.js +3 -0
  52. package/dist/cjs/src/platforms/vtex/clients/commerce/types/ShippingData.js.map +1 -0
  53. package/dist/{platforms → cjs/src/platforms}/vtex/clients/commerce/types/Simulation.d.ts +154 -154
  54. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Simulation.js +3 -0
  55. package/dist/cjs/src/platforms/vtex/clients/commerce/types/Simulation.js.map +1 -0
  56. package/dist/{platforms → cjs/src/platforms}/vtex/clients/fetch.d.ts +1 -1
  57. package/dist/cjs/src/platforms/vtex/clients/fetch.js +24 -0
  58. package/dist/cjs/src/platforms/vtex/clients/fetch.js.map +1 -0
  59. package/dist/{platforms → cjs/src/platforms}/vtex/clients/index.d.ts +71 -71
  60. package/dist/cjs/src/platforms/vtex/clients/index.js +18 -0
  61. package/dist/cjs/src/platforms/vtex/clients/index.js.map +1 -0
  62. package/dist/{platforms → cjs/src/platforms}/vtex/clients/search/index.d.ts +26 -26
  63. package/dist/cjs/src/platforms/vtex/clients/search/index.js +88 -0
  64. package/dist/cjs/src/platforms/vtex/clients/search/index.js.map +1 -0
  65. package/dist/{platforms → cjs/src/platforms}/vtex/clients/search/types/AttributeSearchResult.d.ts +30 -30
  66. package/dist/cjs/src/platforms/vtex/clients/search/types/AttributeSearchResult.js +3 -0
  67. package/dist/cjs/src/platforms/vtex/clients/search/types/AttributeSearchResult.js.map +1 -0
  68. package/dist/{platforms → cjs/src/platforms}/vtex/clients/search/types/FacetSearchResult.d.ts +31 -31
  69. package/dist/cjs/src/platforms/vtex/clients/search/types/FacetSearchResult.js +3 -0
  70. package/dist/cjs/src/platforms/vtex/clients/search/types/FacetSearchResult.js.map +1 -0
  71. package/dist/{platforms → cjs/src/platforms}/vtex/clients/search/types/ProductSearchResult.d.ts +206 -206
  72. package/dist/cjs/src/platforms/vtex/clients/search/types/ProductSearchResult.js +3 -0
  73. package/dist/cjs/src/platforms/vtex/clients/search/types/ProductSearchResult.js.map +1 -0
  74. package/dist/{platforms → cjs/src/platforms}/vtex/clients/sp/index.d.ts +14 -14
  75. package/dist/cjs/src/platforms/vtex/clients/sp/index.js +49 -0
  76. package/dist/cjs/src/platforms/vtex/clients/sp/index.js.map +1 -0
  77. package/dist/{platforms → cjs/src/platforms}/vtex/index.d.ts +188 -188
  78. package/dist/cjs/src/platforms/vtex/index.js +59 -0
  79. package/dist/cjs/src/platforms/vtex/index.js.map +1 -0
  80. package/dist/{platforms → cjs/src/platforms}/vtex/loaders/collection.d.ts +6 -6
  81. package/dist/cjs/src/platforms/vtex/loaders/collection.js +38 -0
  82. package/dist/cjs/src/platforms/vtex/loaders/collection.js.map +1 -0
  83. package/dist/{platforms → cjs/src/platforms}/vtex/loaders/index.d.ts +8 -8
  84. package/dist/cjs/src/platforms/vtex/loaders/index.js +21 -0
  85. package/dist/cjs/src/platforms/vtex/loaders/index.js.map +1 -0
  86. package/dist/{platforms → cjs/src/platforms}/vtex/loaders/salesChannel.d.ts +5 -5
  87. package/dist/cjs/src/platforms/vtex/loaders/salesChannel.js +11 -0
  88. package/dist/cjs/src/platforms/vtex/loaders/salesChannel.js.map +1 -0
  89. package/dist/{platforms → cjs/src/platforms}/vtex/loaders/simulation.d.ts +5 -5
  90. package/dist/cjs/src/platforms/vtex/loaders/simulation.js +44 -0
  91. package/dist/cjs/src/platforms/vtex/loaders/simulation.js.map +1 -0
  92. package/dist/{platforms → cjs/src/platforms}/vtex/loaders/sku.d.ts +5 -5
  93. package/dist/cjs/src/platforms/vtex/loaders/sku.js +33 -0
  94. package/dist/cjs/src/platforms/vtex/loaders/sku.js.map +1 -0
  95. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/aggregateOffer.d.ts +7 -7
  96. package/dist/cjs/src/platforms/vtex/resolvers/aggregateOffer.js +23 -0
  97. package/dist/cjs/src/platforms/vtex/resolvers/aggregateOffer.js.map +1 -0
  98. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/aggregateRating.d.ts +2 -2
  99. package/dist/cjs/src/platforms/vtex/resolvers/aggregateRating.js +9 -0
  100. package/dist/cjs/src/platforms/vtex/resolvers/aggregateRating.js.map +1 -0
  101. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/collection.d.ts +8 -8
  102. package/dist/cjs/src/platforms/vtex/resolvers/collection.js +81 -0
  103. package/dist/cjs/src/platforms/vtex/resolvers/collection.js.map +1 -0
  104. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/faceValue.d.ts +3 -3
  105. package/dist/cjs/src/platforms/vtex/resolvers/faceValue.js +10 -0
  106. package/dist/cjs/src/platforms/vtex/resolvers/faceValue.js.map +1 -0
  107. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/facet.d.ts +6 -6
  108. package/dist/cjs/src/platforms/vtex/resolvers/facet.js +50 -0
  109. package/dist/cjs/src/platforms/vtex/resolvers/facet.js.map +1 -0
  110. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/mutation.d.ts +59 -59
  111. package/dist/cjs/src/platforms/vtex/resolvers/mutation.js +12 -0
  112. package/dist/cjs/src/platforms/vtex/resolvers/mutation.js.map +1 -0
  113. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/objectOrString.d.ts +2 -2
  114. package/dist/cjs/src/platforms/vtex/resolvers/objectOrString.js +41 -0
  115. package/dist/cjs/src/platforms/vtex/resolvers/objectOrString.js.map +1 -0
  116. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/offer.d.ts +12 -12
  117. package/dist/cjs/src/platforms/vtex/resolvers/offer.js +94 -0
  118. package/dist/cjs/src/platforms/vtex/resolvers/offer.js.map +1 -0
  119. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/organization.d.ts +5 -5
  120. package/dist/cjs/src/platforms/vtex/resolvers/organization.js +7 -0
  121. package/dist/cjs/src/platforms/vtex/resolvers/organization.js.map +1 -0
  122. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/product.d.ts +14 -14
  123. package/dist/cjs/src/platforms/vtex/resolvers/product.js +78 -0
  124. package/dist/cjs/src/platforms/vtex/resolvers/product.js.map +1 -0
  125. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/productGroup.d.ts +5 -5
  126. package/dist/cjs/src/platforms/vtex/resolvers/productGroup.js +22 -0
  127. package/dist/cjs/src/platforms/vtex/resolvers/productGroup.js.map +1 -0
  128. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/propertyValue.d.ts +4 -4
  129. package/dist/cjs/src/platforms/vtex/resolvers/propertyValue.js +11 -0
  130. package/dist/cjs/src/platforms/vtex/resolvers/propertyValue.js.map +1 -0
  131. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/query.d.ts +72 -72
  132. package/dist/cjs/src/platforms/vtex/resolvers/query.js +223 -0
  133. package/dist/cjs/src/platforms/vtex/resolvers/query.js.map +1 -0
  134. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/review.d.ts +2 -2
  135. package/dist/cjs/src/platforms/vtex/resolvers/review.js +13 -0
  136. package/dist/cjs/src/platforms/vtex/resolvers/review.js.map +1 -0
  137. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/root.d.ts +12 -12
  138. package/dist/cjs/src/platforms/vtex/resolvers/root.js +3 -0
  139. package/dist/cjs/src/platforms/vtex/resolvers/root.js.map +1 -0
  140. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/searchResult.d.ts +8 -8
  141. package/dist/cjs/src/platforms/vtex/resolvers/searchResult.js +97 -0
  142. package/dist/cjs/src/platforms/vtex/resolvers/searchResult.js.map +1 -0
  143. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/seo.d.ts +7 -7
  144. package/dist/cjs/src/platforms/vtex/resolvers/seo.js +10 -0
  145. package/dist/cjs/src/platforms/vtex/resolvers/seo.js.map +1 -0
  146. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/shippingSLA.d.ts +13 -13
  147. package/dist/cjs/src/platforms/vtex/resolvers/shippingSLA.js +48 -0
  148. package/dist/cjs/src/platforms/vtex/resolvers/shippingSLA.js.map +1 -0
  149. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/skuVariations.d.ts +5 -5
  150. package/dist/cjs/src/platforms/vtex/resolvers/skuVariations.js +17 -0
  151. package/dist/cjs/src/platforms/vtex/resolvers/skuVariations.js.map +1 -0
  152. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/subscribeToNewsletter.d.ts +3 -3
  153. package/dist/cjs/src/platforms/vtex/resolvers/subscribeToNewsletter.js +9 -0
  154. package/dist/cjs/src/platforms/vtex/resolvers/subscribeToNewsletter.js.map +1 -0
  155. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/validateCart.d.ts +70 -70
  156. package/dist/cjs/src/platforms/vtex/resolvers/validateCart.js +282 -0
  157. package/dist/cjs/src/platforms/vtex/resolvers/validateCart.js.map +1 -0
  158. package/dist/{platforms → cjs/src/platforms}/vtex/resolvers/validateSession.d.ts +3 -3
  159. package/dist/cjs/src/platforms/vtex/resolvers/validateSession.js +58 -0
  160. package/dist/cjs/src/platforms/vtex/resolvers/validateSession.js.map +1 -0
  161. package/dist/{platforms → cjs/src/platforms}/vtex/utils/canonical.d.ts +2 -2
  162. package/dist/cjs/src/platforms/vtex/utils/canonical.js +6 -0
  163. package/dist/cjs/src/platforms/vtex/utils/canonical.js.map +1 -0
  164. package/dist/{platforms → cjs/src/platforms}/vtex/utils/channel.d.ts +9 -9
  165. package/dist/cjs/src/platforms/vtex/utils/channel.js +23 -0
  166. package/dist/cjs/src/platforms/vtex/utils/channel.js.map +1 -0
  167. package/dist/{platforms → cjs/src/platforms}/vtex/utils/contex.d.ts +3 -3
  168. package/dist/cjs/src/platforms/vtex/utils/contex.js +14 -0
  169. package/dist/cjs/src/platforms/vtex/utils/contex.js.map +1 -0
  170. package/dist/{platforms → cjs/src/platforms}/vtex/utils/createNewAddress.d.ts +3 -3
  171. package/dist/cjs/src/platforms/vtex/utils/createNewAddress.js +34 -0
  172. package/dist/cjs/src/platforms/vtex/utils/createNewAddress.js.map +1 -0
  173. package/dist/{platforms → cjs/src/platforms}/vtex/utils/enhanceCommercialOffer.d.ts +10 -10
  174. package/dist/cjs/src/platforms/vtex/utils/enhanceCommercialOffer.js +10 -0
  175. package/dist/cjs/src/platforms/vtex/utils/enhanceCommercialOffer.js.map +1 -0
  176. package/dist/{platforms → cjs/src/platforms}/vtex/utils/enhanceSku.d.ts +5 -5
  177. package/dist/cjs/src/platforms/vtex/utils/enhanceSku.js +18 -0
  178. package/dist/cjs/src/platforms/vtex/utils/enhanceSku.js.map +1 -0
  179. package/dist/{platforms → cjs/src/platforms}/vtex/utils/facets.d.ts +32 -31
  180. package/dist/cjs/src/platforms/vtex/utils/facets.js +65 -0
  181. package/dist/cjs/src/platforms/vtex/utils/facets.js.map +1 -0
  182. package/dist/{platforms → cjs/src/platforms}/vtex/utils/getAddressOrderForm.d.ts +3 -3
  183. package/dist/cjs/src/platforms/vtex/utils/getAddressOrderForm.js +42 -0
  184. package/dist/cjs/src/platforms/vtex/utils/getAddressOrderForm.js.map +1 -0
  185. package/dist/{platforms → cjs/src/platforms}/vtex/utils/md5.d.ts +1 -1
  186. package/dist/cjs/src/platforms/vtex/utils/md5.js +8 -0
  187. package/dist/cjs/src/platforms/vtex/utils/md5.js.map +1 -0
  188. package/dist/{platforms → cjs/src/platforms}/vtex/utils/orderStatistics.d.ts +4 -4
  189. package/dist/cjs/src/platforms/vtex/utils/orderStatistics.js +18 -0
  190. package/dist/cjs/src/platforms/vtex/utils/orderStatistics.js.map +1 -0
  191. package/dist/{platforms → cjs/src/platforms}/vtex/utils/productStock.d.ts +7 -7
  192. package/dist/cjs/src/platforms/vtex/utils/productStock.js +25 -0
  193. package/dist/cjs/src/platforms/vtex/utils/productStock.js.map +1 -0
  194. package/dist/{platforms → cjs/src/platforms}/vtex/utils/propertyValue.d.ts +12 -12
  195. package/dist/cjs/src/platforms/vtex/utils/propertyValue.js +21 -0
  196. package/dist/cjs/src/platforms/vtex/utils/propertyValue.js.map +1 -0
  197. package/dist/{platforms → cjs/src/platforms}/vtex/utils/sanitizeHtml.d.ts +17 -17
  198. package/dist/cjs/src/platforms/vtex/utils/sanitizeHtml.js +23 -0
  199. package/dist/cjs/src/platforms/vtex/utils/sanitizeHtml.js.map +1 -0
  200. package/dist/{platforms → cjs/src/platforms}/vtex/utils/shouldUpdateShippingData.d.ts +6 -6
  201. package/dist/cjs/src/platforms/vtex/utils/shouldUpdateShippingData.js +72 -0
  202. package/dist/cjs/src/platforms/vtex/utils/shouldUpdateShippingData.js.map +1 -0
  203. package/dist/{platforms → cjs/src/platforms}/vtex/utils/sku.d.ts +8 -8
  204. package/dist/cjs/src/platforms/vtex/utils/sku.js +22 -0
  205. package/dist/cjs/src/platforms/vtex/utils/sku.js.map +1 -0
  206. package/dist/{platforms → cjs/src/platforms}/vtex/utils/skuVariants.d.ts +15 -15
  207. package/dist/cjs/src/platforms/vtex/utils/skuVariants.js +139 -0
  208. package/dist/cjs/src/platforms/vtex/utils/skuVariants.js.map +1 -0
  209. package/dist/{platforms → cjs/src/platforms}/vtex/utils/slugify.d.ts +1 -1
  210. package/dist/cjs/src/platforms/vtex/utils/slugify.js +43 -0
  211. package/dist/cjs/src/platforms/vtex/utils/slugify.js.map +1 -0
  212. package/dist/{platforms → cjs/src/platforms}/vtex/utils/sort.d.ts +10 -10
  213. package/dist/cjs/src/platforms/vtex/utils/sort.js +14 -0
  214. package/dist/cjs/src/platforms/vtex/utils/sort.js.map +1 -0
  215. package/dist/{telemetry → cjs/src/telemetry}/index.d.ts +8 -8
  216. package/dist/cjs/src/telemetry/index.js +77 -0
  217. package/dist/cjs/src/telemetry/index.js.map +1 -0
  218. package/dist/{telemetry → cjs/src/telemetry}/useFaststoreTelemetry.d.ts +24 -24
  219. package/dist/cjs/src/telemetry/useFaststoreTelemetry.js +174 -0
  220. package/dist/cjs/src/telemetry/useFaststoreTelemetry.js.map +1 -0
  221. package/dist/cjs/src/typeDefs/address.graphql +45 -0
  222. package/dist/cjs/src/typeDefs/aggregateOffer.graphql +25 -0
  223. package/dist/cjs/src/typeDefs/aggregateRating.graphql +13 -0
  224. package/dist/cjs/src/typeDefs/author.graphql +9 -0
  225. package/dist/cjs/src/typeDefs/brand.graphql +9 -0
  226. package/dist/cjs/src/typeDefs/breadcrumb.graphql +31 -0
  227. package/dist/cjs/src/typeDefs/cart.graphql +37 -0
  228. package/dist/cjs/src/typeDefs/collection.graphql +83 -0
  229. package/dist/cjs/src/typeDefs/facet.graphql +77 -0
  230. package/dist/cjs/src/typeDefs/image.graphql +27 -0
  231. package/dist/{typeDefs → cjs/src/typeDefs}/index.d.ts +1 -1
  232. package/dist/cjs/src/typeDefs/index.js +10 -0
  233. package/dist/cjs/src/typeDefs/index.js.map +1 -0
  234. package/dist/cjs/src/typeDefs/mutation.graphql +14 -0
  235. package/dist/cjs/src/typeDefs/newsletter.graphql +24 -0
  236. package/dist/cjs/src/typeDefs/objectOrString.graphql +1 -0
  237. package/dist/cjs/src/typeDefs/offer.graphql +71 -0
  238. package/dist/cjs/src/typeDefs/order.graphql +31 -0
  239. package/dist/cjs/src/typeDefs/organization.graphql +19 -0
  240. package/dist/cjs/src/typeDefs/pageInfo.graphql +25 -0
  241. package/dist/cjs/src/typeDefs/person.graphql +43 -0
  242. package/dist/cjs/src/typeDefs/product.graphql +91 -0
  243. package/dist/cjs/src/typeDefs/productGroup.graphql +27 -0
  244. package/dist/cjs/src/typeDefs/propertyValue.graphql +40 -0
  245. package/dist/cjs/src/typeDefs/query.graphql +377 -0
  246. package/dist/cjs/src/typeDefs/review.graphql +27 -0
  247. package/dist/cjs/src/typeDefs/seo.graphql +21 -0
  248. package/dist/cjs/src/typeDefs/session.graphql +194 -0
  249. package/dist/cjs/src/typeDefs/shipping.graphql +331 -0
  250. package/dist/cjs/src/typeDefs/skuVariants.graphql +90 -0
  251. package/dist/cjs/src/typeDefs/status.graphql +8 -0
  252. package/dist/cjs/src/typings/index.d.ts +3 -0
  253. package/dist/cjs/src/typings/index.js +3 -0
  254. package/dist/cjs/src/typings/index.js.map +1 -0
  255. package/dist/esm/package.json +79 -0
  256. package/dist/esm/src/__generated__/schema.d.ts +1045 -0
  257. package/dist/esm/src/__generated__/schema.js +6 -0
  258. package/dist/esm/src/__generated__/schema.js.map +1 -0
  259. package/dist/esm/src/directives/cacheControl.d.ts +9 -0
  260. package/dist/esm/src/directives/cacheControl.js +41 -0
  261. package/dist/esm/src/directives/cacheControl.js.map +1 -0
  262. package/dist/esm/src/directives/index.d.ts +5 -0
  263. package/dist/esm/src/directives/index.js +2 -0
  264. package/dist/esm/src/directives/index.js.map +1 -0
  265. package/dist/esm/src/index.d.ts +163 -0
  266. package/dist/esm/src/index.js +29 -0
  267. package/dist/esm/src/index.js.map +1 -0
  268. package/dist/esm/src/platforms/errors.d.ts +19 -0
  269. package/dist/esm/src/platforms/errors.js +22 -0
  270. package/dist/esm/src/platforms/errors.js.map +1 -0
  271. package/dist/esm/src/platforms/vtex/clients/commerce/index.d.ts +75 -0
  272. package/dist/esm/src/platforms/vtex/clients/commerce/index.js +161 -0
  273. package/dist/esm/src/platforms/vtex/clients/commerce/index.js.map +1 -0
  274. package/dist/esm/src/platforms/vtex/clients/commerce/types/Address.d.ts +16 -0
  275. package/dist/esm/src/platforms/vtex/clients/commerce/types/Address.js +2 -0
  276. package/dist/esm/src/platforms/vtex/clients/commerce/types/Address.js.map +1 -0
  277. package/dist/esm/src/platforms/vtex/clients/commerce/types/Brand.d.ts +8 -0
  278. package/dist/esm/src/platforms/vtex/clients/commerce/types/Brand.js +2 -0
  279. package/dist/esm/src/platforms/vtex/clients/commerce/types/Brand.js.map +1 -0
  280. package/dist/esm/src/platforms/vtex/clients/commerce/types/CategoryTree.d.ts +9 -0
  281. package/dist/esm/src/platforms/vtex/clients/commerce/types/CategoryTree.js +2 -0
  282. package/dist/esm/src/platforms/vtex/clients/commerce/types/CategoryTree.js.map +1 -0
  283. package/dist/esm/src/platforms/vtex/clients/commerce/types/Newsletter.d.ts +4 -0
  284. package/dist/esm/src/platforms/vtex/clients/commerce/types/Newsletter.js +2 -0
  285. package/dist/esm/src/platforms/vtex/clients/commerce/types/Newsletter.js.map +1 -0
  286. package/dist/esm/src/platforms/vtex/clients/commerce/types/OrderForm.d.ts +371 -0
  287. package/dist/esm/src/platforms/vtex/clients/commerce/types/OrderForm.js +2 -0
  288. package/dist/esm/src/platforms/vtex/clients/commerce/types/OrderForm.js.map +1 -0
  289. package/dist/esm/src/platforms/vtex/clients/commerce/types/Portal.d.ts +17 -0
  290. package/dist/esm/src/platforms/vtex/clients/commerce/types/Portal.js +2 -0
  291. package/dist/esm/src/platforms/vtex/clients/commerce/types/Portal.js.map +1 -0
  292. package/dist/esm/src/platforms/vtex/clients/commerce/types/Product.d.ts +174 -0
  293. package/dist/esm/src/platforms/vtex/clients/commerce/types/Product.js +52 -0
  294. package/dist/esm/src/platforms/vtex/clients/commerce/types/Product.js.map +1 -0
  295. package/dist/esm/src/platforms/vtex/clients/commerce/types/Region.d.ts +19 -0
  296. package/dist/esm/src/platforms/vtex/clients/commerce/types/Region.js +2 -0
  297. package/dist/esm/src/platforms/vtex/clients/commerce/types/Region.js.map +1 -0
  298. package/dist/esm/src/platforms/vtex/clients/commerce/types/SalesChannel.d.ts +24 -0
  299. package/dist/esm/src/platforms/vtex/clients/commerce/types/SalesChannel.js +2 -0
  300. package/dist/esm/src/platforms/vtex/clients/commerce/types/SalesChannel.js.map +1 -0
  301. package/dist/esm/src/platforms/vtex/clients/commerce/types/Session.d.ts +33 -0
  302. package/dist/esm/src/platforms/vtex/clients/commerce/types/Session.js +2 -0
  303. package/dist/esm/src/platforms/vtex/clients/commerce/types/Session.js.map +1 -0
  304. package/dist/esm/src/platforms/vtex/clients/commerce/types/ShippingData.d.ts +38 -0
  305. package/dist/esm/src/platforms/vtex/clients/commerce/types/ShippingData.js +2 -0
  306. package/dist/esm/src/platforms/vtex/clients/commerce/types/ShippingData.js.map +1 -0
  307. package/dist/esm/src/platforms/vtex/clients/commerce/types/Simulation.d.ts +154 -0
  308. package/dist/esm/src/platforms/vtex/clients/commerce/types/Simulation.js +2 -0
  309. package/dist/esm/src/platforms/vtex/clients/commerce/types/Simulation.js.map +1 -0
  310. package/dist/esm/src/platforms/vtex/clients/fetch.d.ts +1 -0
  311. package/dist/esm/src/platforms/vtex/clients/fetch.js +19 -0
  312. package/dist/esm/src/platforms/vtex/clients/fetch.js.map +1 -0
  313. package/dist/esm/src/platforms/vtex/clients/index.d.ts +71 -0
  314. package/dist/esm/src/platforms/vtex/clients/index.js +14 -0
  315. package/dist/esm/src/platforms/vtex/clients/index.js.map +1 -0
  316. package/dist/esm/src/platforms/vtex/clients/search/index.d.ts +26 -0
  317. package/dist/esm/src/platforms/vtex/clients/search/index.js +83 -0
  318. package/dist/esm/src/platforms/vtex/clients/search/index.js.map +1 -0
  319. package/dist/esm/src/platforms/vtex/clients/search/types/AttributeSearchResult.d.ts +30 -0
  320. package/dist/esm/src/platforms/vtex/clients/search/types/AttributeSearchResult.js +2 -0
  321. package/dist/esm/src/platforms/vtex/clients/search/types/AttributeSearchResult.js.map +1 -0
  322. package/dist/esm/src/platforms/vtex/clients/search/types/FacetSearchResult.d.ts +31 -0
  323. package/dist/esm/src/platforms/vtex/clients/search/types/FacetSearchResult.js +2 -0
  324. package/dist/esm/src/platforms/vtex/clients/search/types/FacetSearchResult.js.map +1 -0
  325. package/dist/esm/src/platforms/vtex/clients/search/types/ProductSearchResult.d.ts +206 -0
  326. package/dist/esm/src/platforms/vtex/clients/search/types/ProductSearchResult.js +2 -0
  327. package/dist/esm/src/platforms/vtex/clients/search/types/ProductSearchResult.js.map +1 -0
  328. package/dist/esm/src/platforms/vtex/clients/sp/index.d.ts +14 -0
  329. package/dist/esm/src/platforms/vtex/clients/sp/index.js +45 -0
  330. package/dist/esm/src/platforms/vtex/clients/sp/index.js.map +1 -0
  331. package/dist/esm/src/platforms/vtex/index.d.ts +188 -0
  332. package/dist/esm/src/platforms/vtex/index.js +53 -0
  333. package/dist/esm/src/platforms/vtex/index.js.map +1 -0
  334. package/dist/esm/src/platforms/vtex/loaders/collection.d.ts +6 -0
  335. package/dist/esm/src/platforms/vtex/loaders/collection.js +32 -0
  336. package/dist/esm/src/platforms/vtex/loaders/collection.js.map +1 -0
  337. package/dist/esm/src/platforms/vtex/loaders/index.d.ts +8 -0
  338. package/dist/esm/src/platforms/vtex/loaders/index.js +17 -0
  339. package/dist/esm/src/platforms/vtex/loaders/index.js.map +1 -0
  340. package/dist/esm/src/platforms/vtex/loaders/salesChannel.d.ts +5 -0
  341. package/dist/esm/src/platforms/vtex/loaders/salesChannel.js +6 -0
  342. package/dist/esm/src/platforms/vtex/loaders/salesChannel.js.map +1 -0
  343. package/dist/esm/src/platforms/vtex/loaders/simulation.d.ts +5 -0
  344. package/dist/esm/src/platforms/vtex/loaders/simulation.js +39 -0
  345. package/dist/esm/src/platforms/vtex/loaders/simulation.js.map +1 -0
  346. package/dist/esm/src/platforms/vtex/loaders/sku.d.ts +5 -0
  347. package/dist/esm/src/platforms/vtex/loaders/sku.js +28 -0
  348. package/dist/esm/src/platforms/vtex/loaders/sku.js.map +1 -0
  349. package/dist/esm/src/platforms/vtex/resolvers/aggregateOffer.d.ts +7 -0
  350. package/dist/esm/src/platforms/vtex/resolvers/aggregateOffer.js +20 -0
  351. package/dist/esm/src/platforms/vtex/resolvers/aggregateOffer.js.map +1 -0
  352. package/dist/esm/src/platforms/vtex/resolvers/aggregateRating.d.ts +2 -0
  353. package/dist/esm/src/platforms/vtex/resolvers/aggregateRating.js +6 -0
  354. package/dist/esm/src/platforms/vtex/resolvers/aggregateRating.js.map +1 -0
  355. package/dist/esm/src/platforms/vtex/resolvers/collection.d.ts +8 -0
  356. package/dist/esm/src/platforms/vtex/resolvers/collection.js +78 -0
  357. package/dist/esm/src/platforms/vtex/resolvers/collection.js.map +1 -0
  358. package/dist/esm/src/platforms/vtex/resolvers/faceValue.d.ts +3 -0
  359. package/dist/esm/src/platforms/vtex/resolvers/faceValue.js +7 -0
  360. package/dist/esm/src/platforms/vtex/resolvers/faceValue.js.map +1 -0
  361. package/dist/esm/src/platforms/vtex/resolvers/facet.d.ts +6 -0
  362. package/dist/esm/src/platforms/vtex/resolvers/facet.js +47 -0
  363. package/dist/esm/src/platforms/vtex/resolvers/facet.js.map +1 -0
  364. package/dist/esm/src/platforms/vtex/resolvers/mutation.d.ts +59 -0
  365. package/dist/esm/src/platforms/vtex/resolvers/mutation.js +9 -0
  366. package/dist/esm/src/platforms/vtex/resolvers/mutation.js.map +1 -0
  367. package/dist/esm/src/platforms/vtex/resolvers/objectOrString.d.ts +2 -0
  368. package/dist/esm/src/platforms/vtex/resolvers/objectOrString.js +38 -0
  369. package/dist/esm/src/platforms/vtex/resolvers/objectOrString.js.map +1 -0
  370. package/dist/esm/src/platforms/vtex/resolvers/offer.d.ts +12 -0
  371. package/dist/esm/src/platforms/vtex/resolvers/offer.js +91 -0
  372. package/dist/esm/src/platforms/vtex/resolvers/offer.js.map +1 -0
  373. package/dist/esm/src/platforms/vtex/resolvers/organization.d.ts +5 -0
  374. package/dist/esm/src/platforms/vtex/resolvers/organization.js +4 -0
  375. package/dist/esm/src/platforms/vtex/resolvers/organization.js.map +1 -0
  376. package/dist/esm/src/platforms/vtex/resolvers/product.d.ts +14 -0
  377. package/dist/esm/src/platforms/vtex/resolvers/product.js +75 -0
  378. package/dist/esm/src/platforms/vtex/resolvers/product.js.map +1 -0
  379. package/dist/esm/src/platforms/vtex/resolvers/productGroup.d.ts +5 -0
  380. package/dist/esm/src/platforms/vtex/resolvers/productGroup.js +19 -0
  381. package/dist/esm/src/platforms/vtex/resolvers/productGroup.js.map +1 -0
  382. package/dist/esm/src/platforms/vtex/resolvers/propertyValue.d.ts +4 -0
  383. package/dist/esm/src/platforms/vtex/resolvers/propertyValue.js +8 -0
  384. package/dist/esm/src/platforms/vtex/resolvers/propertyValue.js.map +1 -0
  385. package/dist/esm/src/platforms/vtex/resolvers/query.d.ts +72 -0
  386. package/dist/esm/src/platforms/vtex/resolvers/query.js +220 -0
  387. package/dist/esm/src/platforms/vtex/resolvers/query.js.map +1 -0
  388. package/dist/esm/src/platforms/vtex/resolvers/review.d.ts +2 -0
  389. package/dist/esm/src/platforms/vtex/resolvers/review.js +10 -0
  390. package/dist/esm/src/platforms/vtex/resolvers/review.js.map +1 -0
  391. package/dist/esm/src/platforms/vtex/resolvers/root.d.ts +12 -0
  392. package/dist/esm/src/platforms/vtex/resolvers/root.js +2 -0
  393. package/dist/esm/src/platforms/vtex/resolvers/root.js.map +1 -0
  394. package/dist/esm/src/platforms/vtex/resolvers/searchResult.d.ts +8 -0
  395. package/dist/esm/src/platforms/vtex/resolvers/searchResult.js +94 -0
  396. package/dist/esm/src/platforms/vtex/resolvers/searchResult.js.map +1 -0
  397. package/dist/esm/src/platforms/vtex/resolvers/seo.d.ts +7 -0
  398. package/dist/esm/src/platforms/vtex/resolvers/seo.js +7 -0
  399. package/dist/esm/src/platforms/vtex/resolvers/seo.js.map +1 -0
  400. package/dist/esm/src/platforms/vtex/resolvers/shippingSLA.d.ts +13 -0
  401. package/dist/esm/src/platforms/vtex/resolvers/shippingSLA.js +44 -0
  402. package/dist/esm/src/platforms/vtex/resolvers/shippingSLA.js.map +1 -0
  403. package/dist/esm/src/platforms/vtex/resolvers/skuVariations.d.ts +5 -0
  404. package/dist/esm/src/platforms/vtex/resolvers/skuVariations.js +14 -0
  405. package/dist/esm/src/platforms/vtex/resolvers/skuVariations.js.map +1 -0
  406. package/dist/esm/src/platforms/vtex/resolvers/subscribeToNewsletter.d.ts +3 -0
  407. package/dist/esm/src/platforms/vtex/resolvers/subscribeToNewsletter.js +5 -0
  408. package/dist/esm/src/platforms/vtex/resolvers/subscribeToNewsletter.js.map +1 -0
  409. package/dist/esm/src/platforms/vtex/resolvers/validateCart.d.ts +70 -0
  410. package/dist/esm/src/platforms/vtex/resolvers/validateCart.js +277 -0
  411. package/dist/esm/src/platforms/vtex/resolvers/validateCart.js.map +1 -0
  412. package/dist/esm/src/platforms/vtex/resolvers/validateSession.d.ts +3 -0
  413. package/dist/esm/src/platforms/vtex/resolvers/validateSession.js +53 -0
  414. package/dist/esm/src/platforms/vtex/resolvers/validateSession.js.map +1 -0
  415. package/dist/esm/src/platforms/vtex/utils/canonical.d.ts +2 -0
  416. package/dist/esm/src/platforms/vtex/utils/canonical.js +2 -0
  417. package/dist/esm/src/platforms/vtex/utils/canonical.js.map +1 -0
  418. package/dist/esm/src/platforms/vtex/utils/channel.d.ts +9 -0
  419. package/dist/esm/src/platforms/vtex/utils/channel.js +20 -0
  420. package/dist/esm/src/platforms/vtex/utils/channel.js.map +1 -0
  421. package/dist/esm/src/platforms/vtex/utils/contex.d.ts +3 -0
  422. package/dist/esm/src/platforms/vtex/utils/contex.js +8 -0
  423. package/dist/esm/src/platforms/vtex/utils/contex.js.map +1 -0
  424. package/dist/esm/src/platforms/vtex/utils/createNewAddress.d.ts +3 -0
  425. package/dist/esm/src/platforms/vtex/utils/createNewAddress.js +30 -0
  426. package/dist/esm/src/platforms/vtex/utils/createNewAddress.js.map +1 -0
  427. package/dist/esm/src/platforms/vtex/utils/enhanceCommercialOffer.d.ts +10 -0
  428. package/dist/esm/src/platforms/vtex/utils/enhanceCommercialOffer.js +6 -0
  429. package/dist/esm/src/platforms/vtex/utils/enhanceCommercialOffer.js.map +1 -0
  430. package/dist/esm/src/platforms/vtex/utils/enhanceSku.d.ts +5 -0
  431. package/dist/esm/src/platforms/vtex/utils/enhanceSku.js +14 -0
  432. package/dist/esm/src/platforms/vtex/utils/enhanceSku.js.map +1 -0
  433. package/dist/esm/src/platforms/vtex/utils/facets.d.ts +32 -0
  434. package/dist/esm/src/platforms/vtex/utils/facets.js +54 -0
  435. package/dist/esm/src/platforms/vtex/utils/facets.js.map +1 -0
  436. package/dist/esm/src/platforms/vtex/utils/getAddressOrderForm.d.ts +3 -0
  437. package/dist/esm/src/platforms/vtex/utils/getAddressOrderForm.js +38 -0
  438. package/dist/esm/src/platforms/vtex/utils/getAddressOrderForm.js.map +1 -0
  439. package/dist/esm/src/platforms/vtex/utils/md5.d.ts +1 -0
  440. package/dist/esm/src/platforms/vtex/utils/md5.js +3 -0
  441. package/dist/esm/src/platforms/vtex/utils/md5.js.map +1 -0
  442. package/dist/esm/src/platforms/vtex/utils/orderStatistics.d.ts +4 -0
  443. package/dist/esm/src/platforms/vtex/utils/orderStatistics.js +14 -0
  444. package/dist/esm/src/platforms/vtex/utils/orderStatistics.js.map +1 -0
  445. package/dist/esm/src/platforms/vtex/utils/productStock.d.ts +7 -0
  446. package/dist/esm/src/platforms/vtex/utils/productStock.js +16 -0
  447. package/dist/esm/src/platforms/vtex/utils/productStock.js.map +1 -0
  448. package/dist/esm/src/platforms/vtex/utils/propertyValue.d.ts +12 -0
  449. package/dist/esm/src/platforms/vtex/utils/propertyValue.js +16 -0
  450. package/dist/esm/src/platforms/vtex/utils/propertyValue.js.map +1 -0
  451. package/dist/esm/src/platforms/vtex/utils/sanitizeHtml.d.ts +17 -0
  452. package/dist/esm/src/platforms/vtex/utils/sanitizeHtml.js +18 -0
  453. package/dist/esm/src/platforms/vtex/utils/sanitizeHtml.js.map +1 -0
  454. package/dist/esm/src/platforms/vtex/utils/shouldUpdateShippingData.d.ts +6 -0
  455. package/dist/esm/src/platforms/vtex/utils/shouldUpdateShippingData.js +68 -0
  456. package/dist/esm/src/platforms/vtex/utils/shouldUpdateShippingData.js.map +1 -0
  457. package/dist/esm/src/platforms/vtex/utils/sku.d.ts +8 -0
  458. package/dist/esm/src/platforms/vtex/utils/sku.js +17 -0
  459. package/dist/esm/src/platforms/vtex/utils/sku.js.map +1 -0
  460. package/dist/esm/src/platforms/vtex/utils/skuVariants.d.ts +15 -0
  461. package/dist/esm/src/platforms/vtex/utils/skuVariants.js +132 -0
  462. package/dist/esm/src/platforms/vtex/utils/skuVariants.js.map +1 -0
  463. package/dist/esm/src/platforms/vtex/utils/slugify.d.ts +1 -0
  464. package/dist/esm/src/platforms/vtex/utils/slugify.js +39 -0
  465. package/dist/esm/src/platforms/vtex/utils/slugify.js.map +1 -0
  466. package/dist/esm/src/platforms/vtex/utils/sort.d.ts +10 -0
  467. package/dist/esm/src/platforms/vtex/utils/sort.js +11 -0
  468. package/dist/esm/src/platforms/vtex/utils/sort.js.map +1 -0
  469. package/dist/esm/src/telemetry/index.d.ts +8 -0
  470. package/dist/esm/src/telemetry/index.js +72 -0
  471. package/dist/esm/src/telemetry/index.js.map +1 -0
  472. package/dist/esm/src/telemetry/useFaststoreTelemetry.d.ts +24 -0
  473. package/dist/esm/src/telemetry/useFaststoreTelemetry.js +170 -0
  474. package/dist/esm/src/telemetry/useFaststoreTelemetry.js.map +1 -0
  475. package/dist/esm/src/typeDefs/address.graphql +45 -0
  476. package/dist/esm/src/typeDefs/aggregateOffer.graphql +25 -0
  477. package/dist/esm/src/typeDefs/aggregateRating.graphql +13 -0
  478. package/dist/esm/src/typeDefs/author.graphql +9 -0
  479. package/dist/esm/src/typeDefs/brand.graphql +9 -0
  480. package/dist/esm/src/typeDefs/breadcrumb.graphql +31 -0
  481. package/dist/esm/src/typeDefs/cart.graphql +37 -0
  482. package/dist/esm/src/typeDefs/collection.graphql +83 -0
  483. package/dist/esm/src/typeDefs/facet.graphql +77 -0
  484. package/dist/esm/src/typeDefs/image.graphql +27 -0
  485. package/dist/esm/src/typeDefs/index.d.ts +1 -0
  486. package/dist/esm/src/typeDefs/index.js +7 -0
  487. package/dist/esm/src/typeDefs/index.js.map +1 -0
  488. package/dist/esm/src/typeDefs/mutation.graphql +14 -0
  489. package/dist/esm/src/typeDefs/newsletter.graphql +24 -0
  490. package/dist/esm/src/typeDefs/objectOrString.graphql +1 -0
  491. package/dist/esm/src/typeDefs/offer.graphql +71 -0
  492. package/dist/esm/src/typeDefs/order.graphql +31 -0
  493. package/dist/esm/src/typeDefs/organization.graphql +19 -0
  494. package/dist/esm/src/typeDefs/pageInfo.graphql +25 -0
  495. package/dist/esm/src/typeDefs/person.graphql +43 -0
  496. package/dist/esm/src/typeDefs/product.graphql +91 -0
  497. package/dist/esm/src/typeDefs/productGroup.graphql +27 -0
  498. package/dist/esm/src/typeDefs/propertyValue.graphql +40 -0
  499. package/dist/esm/src/typeDefs/query.graphql +377 -0
  500. package/dist/esm/src/typeDefs/review.graphql +27 -0
  501. package/dist/esm/src/typeDefs/seo.graphql +21 -0
  502. package/dist/esm/src/typeDefs/session.graphql +194 -0
  503. package/dist/esm/src/typeDefs/shipping.graphql +331 -0
  504. package/dist/esm/src/typeDefs/skuVariants.graphql +90 -0
  505. package/dist/esm/src/typeDefs/status.graphql +8 -0
  506. package/dist/esm/src/typings/index.d.ts +3 -0
  507. package/dist/esm/src/typings/index.js +2 -0
  508. package/dist/esm/src/typings/index.js.map +1 -0
  509. package/package.json +34 -17
  510. package/src/index.ts +1 -1
  511. package/src/platforms/vtex/resolvers/searchResult.ts +7 -2
  512. package/src/typeDefs/index.ts +3 -58
  513. package/dist/api.cjs.development.js +0 -2942
  514. package/dist/api.cjs.development.js.map +0 -1
  515. package/dist/api.cjs.production.min.js +0 -2
  516. package/dist/api.cjs.production.min.js.map +0 -1
  517. package/dist/api.esm.js +0 -2928
  518. package/dist/api.esm.js.map +0 -1
  519. package/dist/index.js +0 -8
  520. package/dist/typings/index.d.ts +0 -3
@@ -1,1045 +1,1045 @@
1
- export declare type Maybe<T> = T | null;
2
- export declare type Exact<T extends {
3
- [key: string]: unknown;
4
- }> = {
5
- [K in keyof T]: T[K];
6
- };
7
- export declare type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
8
- [SubKey in K]?: Maybe<T[SubKey]>;
9
- };
10
- export declare type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
11
- [SubKey in K]: Maybe<T[SubKey]>;
12
- };
13
- /** All built-in and custom scalars, mapped to their actual values */
14
- export declare type Scalars = {
15
- ID: string;
16
- String: string;
17
- Boolean: boolean;
18
- Int: number;
19
- Float: number;
20
- /**
21
- * Example:
22
- *
23
- * ```json
24
- * {
25
- * Color: 'Red', Size: '42'
26
- * }
27
- * ```
28
- */
29
- ActiveVariations: any;
30
- /**
31
- * Example:
32
- *
33
- * ```json
34
- * {
35
- * Color: [
36
- * {
37
- * src: "https://storecomponents.vtexassets.com/...",
38
- * alt: "...",
39
- * label: "...",
40
- * value: "..."
41
- * },
42
- * {
43
- * src: "https://storecomponents.vtexassets.com/...",
44
- * alt: "...",
45
- * label: "...",
46
- * value: "..."
47
- * }
48
- * ],
49
- * Size: [
50
- * {
51
- * src: "https://storecomponents.vtexassets.com/...",
52
- * alt: "...",
53
- * label: "...",
54
- * value: "..."
55
- * }
56
- * ]
57
- * }
58
- * ```
59
- */
60
- FormattedVariants: any;
61
- ObjectOrString: any;
62
- /**
63
- * Example:
64
- *
65
- * ```json
66
- * {
67
- * 'Color-Red-Size-40': 'classic-shoes-37'
68
- * }
69
- * ```
70
- */
71
- SlugsMap: any;
72
- /**
73
- * Example:
74
- *
75
- * ```json
76
- * {
77
- * Color: [ "Red", "Blue", "Green" ],
78
- * Size: [ "40", "41" ]
79
- * }
80
- * ```
81
- */
82
- VariantsByName: any;
83
- };
84
- /** Address information. */
85
- export declare type Address = {
86
- __typename?: 'Address';
87
- /** Address city */
88
- city?: Maybe<Scalars['String']>;
89
- /** Address complement */
90
- complement?: Maybe<Scalars['String']>;
91
- /** Address country */
92
- country?: Maybe<Scalars['String']>;
93
- /** Address geoCoordinates */
94
- geoCoordinates?: Maybe<Array<Maybe<Scalars['Float']>>>;
95
- /** Address neighborhood */
96
- neighborhood?: Maybe<Scalars['String']>;
97
- /** Address number */
98
- number?: Maybe<Scalars['String']>;
99
- /** Address postal code */
100
- postalCode?: Maybe<Scalars['String']>;
101
- /** Address reference */
102
- reference?: Maybe<Scalars['String']>;
103
- /** Address state */
104
- state?: Maybe<Scalars['String']>;
105
- /** Address street */
106
- street?: Maybe<Scalars['String']>;
107
- };
108
- export declare type AvailableDeliveryWindows = {
109
- __typename?: 'AvailableDeliveryWindows';
110
- /** Available delivery window end date in UTC */
111
- endDateUtc?: Maybe<Scalars['String']>;
112
- /** Available delivery window list price */
113
- listPrice?: Maybe<Scalars['Int']>;
114
- /** Available delivery window price */
115
- price?: Maybe<Scalars['Int']>;
116
- /** Available delivery window start date in UTC */
117
- startDateUtc?: Maybe<Scalars['String']>;
118
- /** Available delivery window tax */
119
- tax?: Maybe<Scalars['Int']>;
120
- };
121
- export declare type DeliveryIds = {
122
- __typename?: 'DeliveryIds';
123
- /** DeliveryIds courier id */
124
- courierId?: Maybe<Scalars['String']>;
125
- /** DeliveryIds courier name */
126
- courierName?: Maybe<Scalars['String']>;
127
- /** DeliveryIds dock id */
128
- dockId?: Maybe<Scalars['String']>;
129
- /** DeliveryIds quantity */
130
- quantity?: Maybe<Scalars['Int']>;
131
- /** DeliveryIds warehouse id */
132
- warehouseId?: Maybe<Scalars['String']>;
133
- };
134
- export declare type IGeoCoordinates = {
135
- /** The latitude of the geographic coordinates. */
136
- latitude: Scalars['Float'];
137
- /** The longitude of the geographic coordinates. */
138
- longitude: Scalars['Float'];
139
- };
140
- /** Person data input to the newsletter. */
141
- export declare type IPersonNewsletter = {
142
- /** Person's email. */
143
- email: Scalars['String'];
144
- /** Person's name. */
145
- name: Scalars['String'];
146
- };
147
- /** Shipping Simulation item input. */
148
- export declare type IShippingItem = {
149
- /** ShippingItem ID / Sku. */
150
- id: Scalars['String'];
151
- /** Number of items. */
152
- quantity: Scalars['Int'];
153
- /** Seller responsible for the ShippingItem. */
154
- seller: Scalars['String'];
155
- };
156
- /** Shopping cart input. */
157
- export declare type IStoreCart = {
158
- /** Order information, including `orderNumber`, `acceptedOffer` and `shouldSplitItem`. */
159
- order: IStoreOrder;
160
- };
161
- export declare type IStoreCurrency = {
162
- /** Currency code (e.g: USD). */
163
- code: Scalars['String'];
164
- /** Currency symbol (e.g: $). */
165
- symbol: Scalars['String'];
166
- };
167
- export declare type IStoreDeliveryMode = {
168
- /** The delivery channel information of the session. */
169
- deliveryChannel: Scalars['String'];
170
- /** The delivery method information of the session. */
171
- deliveryMethod: Scalars['String'];
172
- /** The delivery window information of the session. */
173
- deliveryWindow?: Maybe<IStoreDeliveryWindow>;
174
- };
175
- /** Delivery window information. */
176
- export declare type IStoreDeliveryWindow = {
177
- /** The delivery window end date information. */
178
- endDate: Scalars['String'];
179
- /** The delivery window start date information. */
180
- startDate: Scalars['String'];
181
- };
182
- export declare type IStoreGeoCoordinates = {
183
- /** The latitude of the geographic coordinates. */
184
- latitude: Scalars['Float'];
185
- /** The longitude of the geographic coordinates. */
186
- longitude: Scalars['Float'];
187
- };
188
- /** Image input. */
189
- export declare type IStoreImage = {
190
- /** Alias for the input image. */
191
- alternateName: Scalars['String'];
192
- /** Image input URL. */
193
- url: Scalars['String'];
194
- };
195
- /** Offer input. */
196
- export declare type IStoreOffer = {
197
- /** Information on the item being offered. */
198
- itemOffered: IStoreProduct;
199
- /** This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. */
200
- listPrice: Scalars['Float'];
201
- /** Also known as spot price. */
202
- price: Scalars['Float'];
203
- /** Number of items offered. */
204
- quantity: Scalars['Int'];
205
- /** Seller responsible for the offer. */
206
- seller: IStoreOrganization;
207
- };
208
- /** Order input. */
209
- export declare type IStoreOrder = {
210
- /** Array with information on each accepted offer. */
211
- acceptedOffer: Array<IStoreOffer>;
212
- /** ID of the order in [VTEX order management](https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg#). */
213
- orderNumber: Scalars['String'];
214
- /** Indicates whether or not items with attachments should be split. */
215
- shouldSplitItem?: Maybe<Scalars['Boolean']>;
216
- };
217
- /** Organization input. */
218
- export declare type IStoreOrganization = {
219
- /** Organization ID. */
220
- identifier: Scalars['String'];
221
- };
222
- /** Client profile data. */
223
- export declare type IStorePerson = {
224
- /** Client email. */
225
- email: Scalars['String'];
226
- /** Client last name. */
227
- familyName: Scalars['String'];
228
- /** Client first name. */
229
- givenName: Scalars['String'];
230
- /** Client ID. */
231
- id: Scalars['String'];
232
- };
233
- /** Product input. Products are variants within product groups, equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. */
234
- export declare type IStoreProduct = {
235
- /** Custom Product Additional Properties. */
236
- additionalProperty?: Maybe<Array<IStorePropertyValue>>;
237
- /** Array of product images. */
238
- image: Array<IStoreImage>;
239
- /** Product name. */
240
- name: Scalars['String'];
241
- /** Stock Keeping Unit. Merchant-specific ID for the product. */
242
- sku: Scalars['String'];
243
- };
244
- export declare type IStorePropertyValue = {
245
- /** Property name. */
246
- name: Scalars['String'];
247
- /** Property id. This propert changes according to the content of the object. */
248
- propertyID?: Maybe<Scalars['String']>;
249
- /** Property value. May hold a string or the string representation of an object. */
250
- value: Scalars['ObjectOrString'];
251
- /** Specifies the nature of the value */
252
- valueReference: Scalars['String'];
253
- };
254
- /** Selected search facet input. */
255
- export declare type IStoreSelectedFacet = {
256
- /** Selected search facet key. */
257
- key: Scalars['String'];
258
- /** Selected search facet value. */
259
- value: Scalars['String'];
260
- };
261
- /** Session input. */
262
- export declare type IStoreSession = {
263
- /** Session input address type. */
264
- addressType?: Maybe<Scalars['String']>;
265
- /** Session input channel. */
266
- channel?: Maybe<Scalars['String']>;
267
- /** Session input country. */
268
- country: Scalars['String'];
269
- /** Session input currency. */
270
- currency: IStoreCurrency;
271
- /** Session input delivery mode. */
272
- deliveryMode?: Maybe<IStoreDeliveryMode>;
273
- /** Session input geoCoordinates. */
274
- geoCoordinates?: Maybe<IStoreGeoCoordinates>;
275
- /** Session input locale. */
276
- locale: Scalars['String'];
277
- /** Session input person. */
278
- person?: Maybe<IStorePerson>;
279
- /** Session input postal code. */
280
- postalCode?: Maybe<Scalars['String']>;
281
- };
282
- export declare type LogisticsInfo = {
283
- __typename?: 'LogisticsInfo';
284
- /** LogisticsInfo itemIndex. */
285
- itemIndex?: Maybe<Scalars['String']>;
286
- /** LogisticsInfo selectedSla. */
287
- selectedSla?: Maybe<Scalars['String']>;
288
- /** List of LogisticsInfo ShippingSLA. */
289
- slas?: Maybe<Array<Maybe<ShippingSla>>>;
290
- };
291
- /** Shipping Simulation Logistic Item. */
292
- export declare type LogisticsItem = {
293
- __typename?: 'LogisticsItem';
294
- /** LogisticsItem availability. */
295
- availability?: Maybe<Scalars['String']>;
296
- /** LogisticsItem ID / Sku. */
297
- id?: Maybe<Scalars['String']>;
298
- /** LogisticsItem listPrice. */
299
- listPrice?: Maybe<Scalars['Int']>;
300
- /** LogisticsItem measurementUnit. */
301
- measurementUnit?: Maybe<Scalars['String']>;
302
- /** LogisticsItem price. */
303
- price?: Maybe<Scalars['Int']>;
304
- /** Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time. */
305
- priceValidUntil?: Maybe<Scalars['String']>;
306
- /** Number of items. */
307
- quantity?: Maybe<Scalars['Int']>;
308
- requestIndex?: Maybe<Scalars['Int']>;
309
- /** LogisticsItem rewardValue. */
310
- rewardValue?: Maybe<Scalars['Int']>;
311
- /** Seller responsible for the ShippingItem. */
312
- seller?: Maybe<Scalars['String']>;
313
- /** List of Sellers. */
314
- sellerChain?: Maybe<Array<Maybe<Scalars['String']>>>;
315
- /** LogisticsItem sellingPrice. */
316
- sellingPrice?: Maybe<Scalars['Int']>;
317
- /** LogisticsItem tax. */
318
- tax?: Maybe<Scalars['Int']>;
319
- /** LogisticsItem unitMultiplier. */
320
- unitMultiplier?: Maybe<Scalars['Int']>;
321
- };
322
- export declare type MessageFields = {
323
- __typename?: 'MessageFields';
324
- /** MessageFields ean. */
325
- ean?: Maybe<Scalars['String']>;
326
- /** MessageFields item index. */
327
- itemIndex?: Maybe<Scalars['String']>;
328
- /** MessageFields sku name. */
329
- skuName?: Maybe<Scalars['String']>;
330
- };
331
- export declare type MessageInfo = {
332
- __typename?: 'MessageInfo';
333
- /** MessageInfo code. */
334
- code?: Maybe<Scalars['String']>;
335
- /** MessageInfo fields. */
336
- fields?: Maybe<MessageFields>;
337
- /** MessageInfo status. */
338
- status?: Maybe<Scalars['String']>;
339
- /** MessageInfo text. */
340
- text?: Maybe<Scalars['String']>;
341
- };
342
- export declare type Mutation = {
343
- __typename?: 'Mutation';
344
- /** Subscribes a new person to the newsletter list. */
345
- subscribeToNewsletter?: Maybe<PersonNewsletter>;
346
- /** Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns `null`. */
347
- validateCart?: Maybe<StoreCart>;
348
- /** Updates a web session with the specified values. */
349
- validateSession?: Maybe<StoreSession>;
350
- };
351
- export declare type MutationSubscribeToNewsletterArgs = {
352
- data: IPersonNewsletter;
353
- };
354
- export declare type MutationValidateCartArgs = {
355
- cart: IStoreCart;
356
- session?: Maybe<IStoreSession>;
357
- };
358
- export declare type MutationValidateSessionArgs = {
359
- search: Scalars['String'];
360
- session: IStoreSession;
361
- };
362
- /** Newsletter information. */
363
- export declare type PersonNewsletter = {
364
- __typename?: 'PersonNewsletter';
365
- /** Person's ID in the newsletter list. */
366
- id: Scalars['String'];
367
- };
368
- export declare type PickupAddress = {
369
- __typename?: 'PickupAddress';
370
- /** PickupAddress address id. */
371
- addressId?: Maybe<Scalars['String']>;
372
- /** PickupAddress address type. */
373
- addressType?: Maybe<Scalars['String']>;
374
- /** PickupAddress city. */
375
- city?: Maybe<Scalars['String']>;
376
- /** PickupAddress complement. */
377
- complement?: Maybe<Scalars['String']>;
378
- /** PickupAddress country. */
379
- country?: Maybe<Scalars['String']>;
380
- /** PickupAddress geo coordinates. */
381
- geoCoordinates?: Maybe<Array<Maybe<Scalars['Float']>>>;
382
- /** PickupAddress neighborhood. */
383
- neighborhood?: Maybe<Scalars['String']>;
384
- /** PickupAddress number. */
385
- number?: Maybe<Scalars['String']>;
386
- /** PickupAddress postal code. */
387
- postalCode?: Maybe<Scalars['String']>;
388
- /** PickupAddress receiver name. */
389
- receiverName?: Maybe<Scalars['String']>;
390
- /** PickupAddress reference. */
391
- reference?: Maybe<Scalars['String']>;
392
- /** PickupAddress state. */
393
- state?: Maybe<Scalars['String']>;
394
- /** PickupAddress street. */
395
- street?: Maybe<Scalars['String']>;
396
- };
397
- export declare type PickupStoreInfo = {
398
- __typename?: 'PickupStoreInfo';
399
- /** PickupStoreInfo additional information. */
400
- additionalInfo?: Maybe<Scalars['String']>;
401
- /** PickupStoreInfo address. */
402
- address?: Maybe<PickupAddress>;
403
- /** PickupStoreInfo dock id. */
404
- dockId?: Maybe<Scalars['String']>;
405
- /** PickupStoreInfo friendly name. */
406
- friendlyName?: Maybe<Scalars['String']>;
407
- /** Information if the store has pickup enable. */
408
- isPickupStore?: Maybe<Scalars['Boolean']>;
409
- };
410
- export declare type Query = {
411
- __typename?: 'Query';
412
- /** Returns information about all collections. */
413
- allCollections: StoreCollectionConnection;
414
- /** Returns information about all products. */
415
- allProducts: StoreProductConnection;
416
- /** Returns the details of a collection based on the collection slug. */
417
- collection: StoreCollection;
418
- /** Returns the details of a product based on the specified locator. */
419
- product: StoreProduct;
420
- /** Returns if there's a redirect for a search. */
421
- redirect?: Maybe<StoreRedirect>;
422
- /** Returns the result of a product, facet, or suggestion search. */
423
- search: StoreSearchResult;
424
- /** Returns a list of sellers available for a specific localization. */
425
- sellers?: Maybe<SellersData>;
426
- /** Returns information about shipping simulation. */
427
- shipping?: Maybe<ShippingData>;
428
- };
429
- export declare type QueryAllCollectionsArgs = {
430
- after?: Maybe<Scalars['String']>;
431
- first: Scalars['Int'];
432
- };
433
- export declare type QueryAllProductsArgs = {
434
- after?: Maybe<Scalars['String']>;
435
- first: Scalars['Int'];
436
- };
437
- export declare type QueryCollectionArgs = {
438
- slug: Scalars['String'];
439
- };
440
- export declare type QueryProductArgs = {
441
- locator: Array<IStoreSelectedFacet>;
442
- };
443
- export declare type QueryRedirectArgs = {
444
- selectedFacets?: Maybe<Array<IStoreSelectedFacet>>;
445
- term?: Maybe<Scalars['String']>;
446
- };
447
- export declare type QuerySearchArgs = {
448
- after?: Maybe<Scalars['String']>;
449
- first: Scalars['Int'];
450
- selectedFacets?: Maybe<Array<IStoreSelectedFacet>>;
451
- sort?: Maybe<StoreSort>;
452
- term?: Maybe<Scalars['String']>;
453
- };
454
- export declare type QuerySellersArgs = {
455
- country: Scalars['String'];
456
- geoCoordinates?: Maybe<IGeoCoordinates>;
457
- postalCode?: Maybe<Scalars['String']>;
458
- salesChannel?: Maybe<Scalars['String']>;
459
- };
460
- export declare type QueryShippingArgs = {
461
- country: Scalars['String'];
462
- items: Array<IShippingItem>;
463
- postalCode: Scalars['String'];
464
- };
465
- /** Search result. */
466
- export declare type SearchMetadata = {
467
- __typename?: 'SearchMetadata';
468
- /** Indicates if the search term was misspelled. */
469
- isTermMisspelled: Scalars['Boolean'];
470
- /** Logical operator used to run the search. */
471
- logicalOperator: Scalars['String'];
472
- };
473
- /** Information of sellers. */
474
- export declare type SellerInfo = {
475
- __typename?: 'SellerInfo';
476
- /** Identification of the seller */
477
- id?: Maybe<Scalars['String']>;
478
- /** Logo of the seller */
479
- logo?: Maybe<Scalars['String']>;
480
- /** Name of the seller */
481
- name?: Maybe<Scalars['String']>;
482
- };
483
- /** Regionalization with sellers information. */
484
- export declare type SellersData = {
485
- __typename?: 'SellersData';
486
- /** Identification of region. */
487
- id?: Maybe<Scalars['String']>;
488
- /** List of sellers. */
489
- sellers?: Maybe<Array<Maybe<SellerInfo>>>;
490
- };
491
- /** Shipping Simulation information. */
492
- export declare type ShippingData = {
493
- __typename?: 'ShippingData';
494
- /** Address information. */
495
- address?: Maybe<Address>;
496
- /** List of LogisticsItem. */
497
- items?: Maybe<Array<Maybe<LogisticsItem>>>;
498
- /** List of LogisticsInfo. */
499
- logisticsInfo?: Maybe<Array<Maybe<LogisticsInfo>>>;
500
- /** List of MessageInfo. */
501
- messages?: Maybe<Array<Maybe<MessageInfo>>>;
502
- };
503
- export declare type ShippingSla = {
504
- __typename?: 'ShippingSLA';
505
- /** ShippingSLA available delivery windows. */
506
- availableDeliveryWindows?: Maybe<Array<Maybe<AvailableDeliveryWindows>>>;
507
- /** ShippingSLA carrier. */
508
- carrier?: Maybe<Scalars['String']>;
509
- /** ShippingSLA delivery channel. */
510
- deliveryChannel?: Maybe<Scalars['String']>;
511
- /** List of ShippingSLA delivery ids. */
512
- deliveryIds?: Maybe<Array<Maybe<DeliveryIds>>>;
513
- /** ShippingSLA friendly name. */
514
- friendlyName?: Maybe<Scalars['String']>;
515
- /** ShippingSLA id. */
516
- id?: Maybe<Scalars['String']>;
517
- /**
518
- * ShippingSLA localized shipping estimate.
519
- * Note: this will always return a localized string for locale `en-US`.
520
- */
521
- localizedEstimates?: Maybe<Scalars['String']>;
522
- /** ShippingSLA name. */
523
- name?: Maybe<Scalars['String']>;
524
- /** ShippingSLA pickup distance. */
525
- pickupDistance?: Maybe<Scalars['Float']>;
526
- /** ShippingSLA pickup point id. */
527
- pickupPointId?: Maybe<Scalars['String']>;
528
- /** ShippingSLA pickup store info. */
529
- pickupStoreInfo?: Maybe<PickupStoreInfo>;
530
- /** ShippingSLA price. */
531
- price?: Maybe<Scalars['Float']>;
532
- /** ShippingSLA shipping estimate. */
533
- shippingEstimate?: Maybe<Scalars['String']>;
534
- /** ShippingSLA shipping estimate date. */
535
- shippingEstimateDate?: Maybe<Scalars['String']>;
536
- };
537
- export declare type SkuVariants = {
538
- __typename?: 'SkuVariants';
539
- /** SKU property values for the current SKU. */
540
- activeVariations?: Maybe<Scalars['ActiveVariations']>;
541
- /** All available options for each SKU variant property, indexed by their name. */
542
- allVariantsByName?: Maybe<Scalars['VariantsByName']>;
543
- /**
544
- * Available options for each varying SKU property, taking into account the
545
- * `dominantVariantName` property. Returns all available options for the
546
- * dominant property, and only options that can be combined with its current
547
- * value for other properties.
548
- * If `dominantVariantName` is not present, the first variant will be
549
- * considered the dominant one.
550
- */
551
- availableVariations?: Maybe<Scalars['FormattedVariants']>;
552
- /**
553
- * Maps property value combinations to their respective SKU's slug. Enables
554
- * us to retrieve the slug for the SKU that matches the currently selected
555
- * variations in O(1) time.
556
- * If `dominantVariantName` is not present, the first variant will be
557
- * considered the dominant one.
558
- */
559
- slugsMap?: Maybe<Scalars['SlugsMap']>;
560
- };
561
- export declare type SkuVariantsAvailableVariationsArgs = {
562
- dominantVariantName?: Maybe<Scalars['String']>;
563
- };
564
- export declare type SkuVariantsSlugsMapArgs = {
565
- dominantVariantName?: Maybe<Scalars['String']>;
566
- };
567
- /** Aggregate offer information, for a given SKU that is available to be fulfilled by multiple sellers. */
568
- export declare type StoreAggregateOffer = {
569
- __typename?: 'StoreAggregateOffer';
570
- /** Highest price among all sellers. */
571
- highPrice: Scalars['Float'];
572
- /** Lowest price among all sellers. */
573
- lowPrice: Scalars['Float'];
574
- /** Number of sellers selling this SKU. */
575
- offerCount: Scalars['Int'];
576
- /** Array with information on each available offer. */
577
- offers: Array<StoreOffer>;
578
- /** ISO code of the currency used for the offer prices. */
579
- priceCurrency: Scalars['String'];
580
- };
581
- /** Average rating, based on multiple ratings or reviews. */
582
- export declare type StoreAggregateRating = {
583
- __typename?: 'StoreAggregateRating';
584
- /** Value of the aggregate rating. */
585
- ratingValue: Scalars['Float'];
586
- /** Total number of ratings. */
587
- reviewCount: Scalars['Int'];
588
- };
589
- /** information about the author of a product review or rating. */
590
- export declare type StoreAuthor = {
591
- __typename?: 'StoreAuthor';
592
- /** Author name. */
593
- name: Scalars['String'];
594
- };
595
- /** Brand of a given product. */
596
- export declare type StoreBrand = {
597
- __typename?: 'StoreBrand';
598
- /** Brand name. */
599
- name: Scalars['String'];
600
- };
601
- /** List of items consisting of chain linked web pages, ending with the current page. */
602
- export declare type StoreBreadcrumbList = {
603
- __typename?: 'StoreBreadcrumbList';
604
- /** Array with breadcrumb elements. */
605
- itemListElement: Array<StoreListItem>;
606
- /** Number of breadcrumbs in the list. */
607
- numberOfItems: Scalars['Int'];
608
- };
609
- /** Shopping cart information. */
610
- export declare type StoreCart = {
611
- __typename?: 'StoreCart';
612
- /** List of shopping cart messages. */
613
- messages: Array<StoreCartMessage>;
614
- /** Order information, including `orderNumber` and `acceptedOffer`. */
615
- order: StoreOrder;
616
- };
617
- /** Shopping cart message. */
618
- export declare type StoreCartMessage = {
619
- __typename?: 'StoreCartMessage';
620
- /** Shopping cart message status, which can be `INFO`, `WARNING` or `ERROR`. */
621
- status: StoreStatus;
622
- /** Shopping cart message text. */
623
- text: Scalars['String'];
624
- };
625
- /** Product collection information. */
626
- export declare type StoreCollection = {
627
- __typename?: 'StoreCollection';
628
- /** List of items consisting of chain linked web pages, ending with the current page. */
629
- breadcrumbList: StoreBreadcrumbList;
630
- /** Collection ID. */
631
- id: Scalars['ID'];
632
- /** Collection meta information. Used for search. */
633
- meta: StoreCollectionMeta;
634
- /** Meta tag data. */
635
- seo: StoreSeo;
636
- /** Corresponding collection URL slug, with which to retrieve this entity. */
637
- slug: Scalars['String'];
638
- /** Collection type. */
639
- type: StoreCollectionType;
640
- };
641
- /** Collection connections, including pagination information and collections returned by the query. */
642
- export declare type StoreCollectionConnection = {
643
- __typename?: 'StoreCollectionConnection';
644
- /** Array with collection connection page edges, each containing a collection and a corresponding cursor.. */
645
- edges: Array<StoreCollectionEdge>;
646
- /** Collection pagination information. */
647
- pageInfo: StorePageInfo;
648
- };
649
- /** Each collection edge contains a `node`, with product collection information, and a `cursor`, that can be used as a reference for pagination. */
650
- export declare type StoreCollectionEdge = {
651
- __typename?: 'StoreCollectionEdge';
652
- /** Collection cursor. Used as pagination reference. */
653
- cursor: Scalars['String'];
654
- /** Each collection node contains the information of a product collection returned by the query. */
655
- node: StoreCollection;
656
- };
657
- /** Product collection facet, used for search. */
658
- export declare type StoreCollectionFacet = {
659
- __typename?: 'StoreCollectionFacet';
660
- /** Facet key. */
661
- key: Scalars['String'];
662
- /** Facet value. */
663
- value: Scalars['String'];
664
- };
665
- /** Collection meta information. Used for search. */
666
- export declare type StoreCollectionMeta = {
667
- __typename?: 'StoreCollectionMeta';
668
- /** List of selected collection facets. */
669
- selectedFacets: Array<StoreCollectionFacet>;
670
- };
671
- /** Product collection type. Possible values are `Department`, `Category`, `Brand`, `Cluster`, `SubCategory` or `Collection`. */
672
- export declare const enum StoreCollectionType {
673
- /** Product brand. */
674
- Brand = "Brand",
675
- /** Second level of product categorization. */
676
- Category = "Category",
677
- /** Product cluster. */
678
- Cluster = "Cluster",
679
- /** Product collection. */
680
- Collection = "Collection",
681
- /** First level of product categorization. */
682
- Department = "Department",
683
- /** Third level of product categorization. */
684
- SubCategory = "SubCategory"
685
- }
686
- /** Currency information. */
687
- export declare type StoreCurrency = {
688
- __typename?: 'StoreCurrency';
689
- /** Currency code (e.g: USD). */
690
- code: Scalars['String'];
691
- /** Currency symbol (e.g: $). */
692
- symbol: Scalars['String'];
693
- };
694
- /** Delivery mode information. */
695
- export declare type StoreDeliveryMode = {
696
- __typename?: 'StoreDeliveryMode';
697
- /** The delivery channel information of the session. */
698
- deliveryChannel: Scalars['String'];
699
- /** The delivery method information of the session. */
700
- deliveryMethod: Scalars['String'];
701
- /** The delivery window information of the session. */
702
- deliveryWindow?: Maybe<StoreDeliveryWindow>;
703
- };
704
- /** Delivery window information. */
705
- export declare type StoreDeliveryWindow = {
706
- __typename?: 'StoreDeliveryWindow';
707
- /** The delivery window end date information. */
708
- endDate: Scalars['String'];
709
- /** The delivery window start date information. */
710
- startDate: Scalars['String'];
711
- };
712
- export declare type StoreFacet = StoreFacetBoolean | StoreFacetRange;
713
- /** Search facet boolean information. */
714
- export declare type StoreFacetBoolean = {
715
- __typename?: 'StoreFacetBoolean';
716
- /** Facet key. */
717
- key: Scalars['String'];
718
- /** Facet label. */
719
- label: Scalars['String'];
720
- /** Array with information on each facet value. */
721
- values: Array<StoreFacetValueBoolean>;
722
- };
723
- /** Search facet range information. */
724
- export declare type StoreFacetRange = {
725
- __typename?: 'StoreFacetRange';
726
- /** Facet key. */
727
- key: Scalars['String'];
728
- /** Facet label. */
729
- label: Scalars['String'];
730
- /** Maximum facet range value. */
731
- max: StoreFacetValueRange;
732
- /** Minimum facet range value. */
733
- min: StoreFacetValueRange;
734
- };
735
- /** Search facet type. */
736
- export declare const enum StoreFacetType {
737
- /** Indicates boolean search facet. */
738
- Boolean = "BOOLEAN",
739
- /** Indicates range type search facet. */
740
- Range = "RANGE"
741
- }
742
- /** Information of a specific facet value. */
743
- export declare type StoreFacetValueBoolean = {
744
- __typename?: 'StoreFacetValueBoolean';
745
- /** Facet value label. */
746
- label: Scalars['String'];
747
- /** Number of items with this facet. */
748
- quantity: Scalars['Int'];
749
- /** Indicates whether facet is selected. */
750
- selected: Scalars['Boolean'];
751
- /** Facet value. */
752
- value: Scalars['String'];
753
- };
754
- /** Search facet range value information. Used for minimum and maximum range values. */
755
- export declare type StoreFacetValueRange = {
756
- __typename?: 'StoreFacetValueRange';
757
- /** Search facet range absolute value. */
758
- absolute: Scalars['Float'];
759
- /** Search facet range selected value. */
760
- selected: Scalars['Float'];
761
- };
762
- /** Geographic coordinates information. */
763
- export declare type StoreGeoCoordinates = {
764
- __typename?: 'StoreGeoCoordinates';
765
- /** The latitude of the geographic coordinates. */
766
- latitude: Scalars['Float'];
767
- /** The longitude of the geographic coordinates. */
768
- longitude: Scalars['Float'];
769
- };
770
- /** Image. */
771
- export declare type StoreImage = {
772
- __typename?: 'StoreImage';
773
- /** Alias for the image. */
774
- alternateName: Scalars['String'];
775
- /** Image URL. */
776
- url: Scalars['String'];
777
- };
778
- /** Item of a list. */
779
- export declare type StoreListItem = {
780
- __typename?: 'StoreListItem';
781
- /** List item value. */
782
- item: Scalars['String'];
783
- /** Name of the list item. */
784
- name: Scalars['String'];
785
- /** Position of the item in the list. */
786
- position: Scalars['Int'];
787
- };
788
- /** Offer information. */
789
- export declare type StoreOffer = {
790
- __typename?: 'StoreOffer';
791
- /** Offer item availability. */
792
- availability: Scalars['String'];
793
- /** Offer item condition. */
794
- itemCondition: Scalars['String'];
795
- /** Information on the item being offered. */
796
- itemOffered: StoreProduct;
797
- /** This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. */
798
- listPrice: Scalars['Float'];
799
- /** Also known as spot price. */
800
- price: Scalars['Float'];
801
- /** ISO code of the currency used for the offer prices. */
802
- priceCurrency: Scalars['String'];
803
- /** Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time. */
804
- priceValidUntil: Scalars['String'];
805
- /** Number of items offered. */
806
- quantity: Scalars['Int'];
807
- /** Seller responsible for the offer. */
808
- seller: StoreOrganization;
809
- /** Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf. */
810
- sellingPrice: Scalars['Float'];
811
- };
812
- /** Information of a specific order. */
813
- export declare type StoreOrder = {
814
- __typename?: 'StoreOrder';
815
- /** Array with information on each accepted offer. */
816
- acceptedOffer: Array<StoreOffer>;
817
- /** ID of the order in [VTEX order management](https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg#). */
818
- orderNumber: Scalars['String'];
819
- };
820
- /** Organization. */
821
- export declare type StoreOrganization = {
822
- __typename?: 'StoreOrganization';
823
- /** Organization ID. */
824
- identifier: Scalars['String'];
825
- };
826
- /** Whenever you make a query that allows for pagination, such as `allProducts` or `allCollections`, you can check `StorePageInfo` to learn more about the complete set of items and use it to paginate your queries. */
827
- export declare type StorePageInfo = {
828
- __typename?: 'StorePageInfo';
829
- /** Cursor corresponding to the last possible item. */
830
- endCursor: Scalars['String'];
831
- /** Indicates whether there is at least one more page with items after the ones returned in the current query. */
832
- hasNextPage: Scalars['Boolean'];
833
- /** Indicates whether there is at least one more page with items before the ones returned in the current query. */
834
- hasPreviousPage: Scalars['Boolean'];
835
- /** Cursor corresponding to the first possible item. */
836
- startCursor: Scalars['String'];
837
- /** Total number of items (products or collections), not pages. */
838
- totalCount: Scalars['Int'];
839
- };
840
- /** Client profile data. */
841
- export declare type StorePerson = {
842
- __typename?: 'StorePerson';
843
- /** Client email. */
844
- email: Scalars['String'];
845
- /** Client last name. */
846
- familyName: Scalars['String'];
847
- /** Client first name. */
848
- givenName: Scalars['String'];
849
- /** Client ID. */
850
- id: Scalars['String'];
851
- };
852
- /** Product information. Products are variants within product groups, equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. */
853
- export declare type StoreProduct = {
854
- __typename?: 'StoreProduct';
855
- /** Array of additional properties. */
856
- additionalProperty: Array<StorePropertyValue>;
857
- /** Aggregate ratings data. */
858
- aggregateRating: StoreAggregateRating;
859
- /** Product brand. */
860
- brand: StoreBrand;
861
- /** List of items consisting of chain linked web pages, ending with the current page. */
862
- breadcrumbList: StoreBreadcrumbList;
863
- /** Product description. */
864
- description: Scalars['String'];
865
- /** Global Trade Item Number. */
866
- gtin: Scalars['String'];
867
- /** Array of images. */
868
- image: Array<StoreImage>;
869
- /** Indicates product group related to this product. */
870
- isVariantOf: StoreProductGroup;
871
- /** Product name. */
872
- name: Scalars['String'];
873
- /** Aggregate offer information. */
874
- offers: StoreAggregateOffer;
875
- /** Product ID, such as [ISBN](https://www.isbn-international.org/content/what-isbn) or similar global IDs. */
876
- productID: Scalars['String'];
877
- /** The product's release date. Formatted using https://en.wikipedia.org/wiki/ISO_8601 */
878
- releaseDate: Scalars['String'];
879
- /** Array with review information. */
880
- review: Array<StoreReview>;
881
- /** Meta tag data. */
882
- seo: StoreSeo;
883
- /** Stock Keeping Unit. Merchant-specific ID for the product. */
884
- sku: Scalars['String'];
885
- /** Corresponding collection URL slug, with which to retrieve this entity. */
886
- slug: Scalars['String'];
887
- };
888
- /** Product connections, including pagination information and products returned by the query. */
889
- export declare type StoreProductConnection = {
890
- __typename?: 'StoreProductConnection';
891
- /** Array with product connection edges, each containing a product and a corresponding cursor. */
892
- edges: Array<StoreProductEdge>;
893
- /** Product pagination information. */
894
- pageInfo: StorePageInfo;
895
- };
896
- /** Each product edge contains a `node`, with product information, and a `cursor`, that can be used as a reference for pagination. */
897
- export declare type StoreProductEdge = {
898
- __typename?: 'StoreProductEdge';
899
- /** Product cursor. Used as pagination reference. */
900
- cursor: Scalars['String'];
901
- /** Each product node contains the information of a product returned by the query. */
902
- node: StoreProduct;
903
- };
904
- /** Product group information. Product groups are catalog entities that may contain variants. They are equivalent to VTEX [Products](https://help.vtex.com/en/tutorial/what-is-a-product--2zrB2gFCHyQokCKKE8kuAw#), whereas each variant is equivalent to a VTEX [SKU](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. */
905
- export declare type StoreProductGroup = {
906
- __typename?: 'StoreProductGroup';
907
- /** Array of additional properties. */
908
- additionalProperty: Array<StorePropertyValue>;
909
- /** Array of variants related to product group. Variants are equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). */
910
- hasVariant: Array<StoreProduct>;
911
- /** Product group name. */
912
- name: Scalars['String'];
913
- /** Product group ID. */
914
- productGroupID: Scalars['String'];
915
- /**
916
- * Object containing data structures to facilitate handling different SKU
917
- * variant properties. Specially useful for implementing SKU selection
918
- * components.
919
- */
920
- skuVariants?: Maybe<SkuVariants>;
921
- };
922
- /** Properties that can be associated with products and products groups. */
923
- export declare type StorePropertyValue = {
924
- __typename?: 'StorePropertyValue';
925
- /** Property name. */
926
- name: Scalars['String'];
927
- /** Property id. This propert changes according to the content of the object. */
928
- propertyID: Scalars['String'];
929
- /** Property value. May hold a string or the string representation of an object. */
930
- value: Scalars['ObjectOrString'];
931
- /** Specifies the nature of the value */
932
- valueReference: Scalars['String'];
933
- };
934
- /**
935
- * Redirect informations, including url returned by the query.
936
- * https://schema.org/Thing
937
- */
938
- export declare type StoreRedirect = {
939
- __typename?: 'StoreRedirect';
940
- /** URL to redirect */
941
- url?: Maybe<Scalars['String']>;
942
- };
943
- /** Information of a given review. */
944
- export declare type StoreReview = {
945
- __typename?: 'StoreReview';
946
- /** Review author. */
947
- author: StoreAuthor;
948
- /** Review rating information. */
949
- reviewRating: StoreReviewRating;
950
- };
951
- /** Information of a given review rating. */
952
- export declare type StoreReviewRating = {
953
- __typename?: 'StoreReviewRating';
954
- /** Best rating value. */
955
- bestRating: Scalars['Float'];
956
- /** Rating value. */
957
- ratingValue: Scalars['Float'];
958
- };
959
- /** Search result. */
960
- export declare type StoreSearchResult = {
961
- __typename?: 'StoreSearchResult';
962
- /** Array of search result facets. */
963
- facets: Array<StoreFacet>;
964
- /** Search result metadata. Additional data can be used to send analytics events. */
965
- metadata?: Maybe<SearchMetadata>;
966
- /** Search result products. */
967
- products: StoreProductConnection;
968
- /** Search result suggestions. */
969
- suggestions: StoreSuggestions;
970
- };
971
- /** Search Engine Optimization (SEO) tags data. */
972
- export declare type StoreSeo = {
973
- __typename?: 'StoreSeo';
974
- /** Canonical tag. */
975
- canonical: Scalars['String'];
976
- /** Description tag. */
977
- description: Scalars['String'];
978
- /** Title tag. */
979
- title: Scalars['String'];
980
- /** Title template tag. */
981
- titleTemplate: Scalars['String'];
982
- };
983
- /** Session information. */
984
- export declare type StoreSession = {
985
- __typename?: 'StoreSession';
986
- /** Session address type. */
987
- addressType?: Maybe<Scalars['String']>;
988
- /** Session channel. */
989
- channel?: Maybe<Scalars['String']>;
990
- /** Session country. */
991
- country: Scalars['String'];
992
- /** Session currency. */
993
- currency: StoreCurrency;
994
- /** Session delivery mode. */
995
- deliveryMode?: Maybe<StoreDeliveryMode>;
996
- /** Session input geoCoordinates. */
997
- geoCoordinates?: Maybe<StoreGeoCoordinates>;
998
- /** Session locale. */
999
- locale: Scalars['String'];
1000
- /** Session input person. */
1001
- person?: Maybe<StorePerson>;
1002
- /** Session postal code. */
1003
- postalCode?: Maybe<Scalars['String']>;
1004
- };
1005
- /** Product search results sorting options. */
1006
- export declare const enum StoreSort {
1007
- /** Sort by discount value, from highest to lowest. */
1008
- DiscountDesc = "discount_desc",
1009
- /** Sort by name, in alphabetical order. */
1010
- NameAsc = "name_asc",
1011
- /** Sort by name, in reverse alphabetical order. */
1012
- NameDesc = "name_desc",
1013
- /** Sort by orders, from highest to lowest. */
1014
- OrdersDesc = "orders_desc",
1015
- /** Sort by price, from lowest to highest. */
1016
- PriceAsc = "price_asc",
1017
- /** Sort by price, from highest to lowest. */
1018
- PriceDesc = "price_desc",
1019
- /** Sort by release date, from highest to lowest. */
1020
- ReleaseDesc = "release_desc",
1021
- /** Sort by product score, from highest to lowest. */
1022
- ScoreDesc = "score_desc"
1023
- }
1024
- /** Status used to indicate a message type. For instance, a shopping cart informative or error message. */
1025
- export declare const enum StoreStatus {
1026
- Error = "ERROR",
1027
- Info = "INFO",
1028
- Warning = "WARNING"
1029
- }
1030
- /** Suggestion term. */
1031
- export declare type StoreSuggestionTerm = {
1032
- __typename?: 'StoreSuggestionTerm';
1033
- /** Its occurrences count. */
1034
- count: Scalars['Int'];
1035
- /** The term. */
1036
- value: Scalars['String'];
1037
- };
1038
- /** Suggestions information. */
1039
- export declare type StoreSuggestions = {
1040
- __typename?: 'StoreSuggestions';
1041
- /** Array with suggestion products' information. */
1042
- products: Array<StoreProduct>;
1043
- /** Array with suggestion terms. */
1044
- terms: Array<StoreSuggestionTerm>;
1045
- };
1
+ export type Maybe<T> = T | null;
2
+ export type Exact<T extends {
3
+ [key: string]: unknown;
4
+ }> = {
5
+ [K in keyof T]: T[K];
6
+ };
7
+ export type MakeOptional<T, K extends keyof T> = Omit<T, K> & {
8
+ [SubKey in K]?: Maybe<T[SubKey]>;
9
+ };
10
+ export type MakeMaybe<T, K extends keyof T> = Omit<T, K> & {
11
+ [SubKey in K]: Maybe<T[SubKey]>;
12
+ };
13
+ /** All built-in and custom scalars, mapped to their actual values */
14
+ export type Scalars = {
15
+ ID: string;
16
+ String: string;
17
+ Boolean: boolean;
18
+ Int: number;
19
+ Float: number;
20
+ /**
21
+ * Example:
22
+ *
23
+ * ```json
24
+ * {
25
+ * Color: 'Red', Size: '42'
26
+ * }
27
+ * ```
28
+ */
29
+ ActiveVariations: any;
30
+ /**
31
+ * Example:
32
+ *
33
+ * ```json
34
+ * {
35
+ * Color: [
36
+ * {
37
+ * src: "https://storecomponents.vtexassets.com/...",
38
+ * alt: "...",
39
+ * label: "...",
40
+ * value: "..."
41
+ * },
42
+ * {
43
+ * src: "https://storecomponents.vtexassets.com/...",
44
+ * alt: "...",
45
+ * label: "...",
46
+ * value: "..."
47
+ * }
48
+ * ],
49
+ * Size: [
50
+ * {
51
+ * src: "https://storecomponents.vtexassets.com/...",
52
+ * alt: "...",
53
+ * label: "...",
54
+ * value: "..."
55
+ * }
56
+ * ]
57
+ * }
58
+ * ```
59
+ */
60
+ FormattedVariants: any;
61
+ ObjectOrString: any;
62
+ /**
63
+ * Example:
64
+ *
65
+ * ```json
66
+ * {
67
+ * 'Color-Red-Size-40': 'classic-shoes-37'
68
+ * }
69
+ * ```
70
+ */
71
+ SlugsMap: any;
72
+ /**
73
+ * Example:
74
+ *
75
+ * ```json
76
+ * {
77
+ * Color: [ "Red", "Blue", "Green" ],
78
+ * Size: [ "40", "41" ]
79
+ * }
80
+ * ```
81
+ */
82
+ VariantsByName: any;
83
+ };
84
+ /** Address information. */
85
+ export type Address = {
86
+ __typename?: 'Address';
87
+ /** Address city */
88
+ city?: Maybe<Scalars['String']>;
89
+ /** Address complement */
90
+ complement?: Maybe<Scalars['String']>;
91
+ /** Address country */
92
+ country?: Maybe<Scalars['String']>;
93
+ /** Address geoCoordinates */
94
+ geoCoordinates?: Maybe<Array<Maybe<Scalars['Float']>>>;
95
+ /** Address neighborhood */
96
+ neighborhood?: Maybe<Scalars['String']>;
97
+ /** Address number */
98
+ number?: Maybe<Scalars['String']>;
99
+ /** Address postal code */
100
+ postalCode?: Maybe<Scalars['String']>;
101
+ /** Address reference */
102
+ reference?: Maybe<Scalars['String']>;
103
+ /** Address state */
104
+ state?: Maybe<Scalars['String']>;
105
+ /** Address street */
106
+ street?: Maybe<Scalars['String']>;
107
+ };
108
+ export type AvailableDeliveryWindows = {
109
+ __typename?: 'AvailableDeliveryWindows';
110
+ /** Available delivery window end date in UTC */
111
+ endDateUtc?: Maybe<Scalars['String']>;
112
+ /** Available delivery window list price */
113
+ listPrice?: Maybe<Scalars['Int']>;
114
+ /** Available delivery window price */
115
+ price?: Maybe<Scalars['Int']>;
116
+ /** Available delivery window start date in UTC */
117
+ startDateUtc?: Maybe<Scalars['String']>;
118
+ /** Available delivery window tax */
119
+ tax?: Maybe<Scalars['Int']>;
120
+ };
121
+ export type DeliveryIds = {
122
+ __typename?: 'DeliveryIds';
123
+ /** DeliveryIds courier id */
124
+ courierId?: Maybe<Scalars['String']>;
125
+ /** DeliveryIds courier name */
126
+ courierName?: Maybe<Scalars['String']>;
127
+ /** DeliveryIds dock id */
128
+ dockId?: Maybe<Scalars['String']>;
129
+ /** DeliveryIds quantity */
130
+ quantity?: Maybe<Scalars['Int']>;
131
+ /** DeliveryIds warehouse id */
132
+ warehouseId?: Maybe<Scalars['String']>;
133
+ };
134
+ export type IGeoCoordinates = {
135
+ /** The latitude of the geographic coordinates. */
136
+ latitude: Scalars['Float'];
137
+ /** The longitude of the geographic coordinates. */
138
+ longitude: Scalars['Float'];
139
+ };
140
+ /** Person data input to the newsletter. */
141
+ export type IPersonNewsletter = {
142
+ /** Person's email. */
143
+ email: Scalars['String'];
144
+ /** Person's name. */
145
+ name: Scalars['String'];
146
+ };
147
+ /** Shipping Simulation item input. */
148
+ export type IShippingItem = {
149
+ /** ShippingItem ID / Sku. */
150
+ id: Scalars['String'];
151
+ /** Number of items. */
152
+ quantity: Scalars['Int'];
153
+ /** Seller responsible for the ShippingItem. */
154
+ seller: Scalars['String'];
155
+ };
156
+ /** Shopping cart input. */
157
+ export type IStoreCart = {
158
+ /** Order information, including `orderNumber`, `acceptedOffer` and `shouldSplitItem`. */
159
+ order: IStoreOrder;
160
+ };
161
+ export type IStoreCurrency = {
162
+ /** Currency code (e.g: USD). */
163
+ code: Scalars['String'];
164
+ /** Currency symbol (e.g: $). */
165
+ symbol: Scalars['String'];
166
+ };
167
+ export type IStoreDeliveryMode = {
168
+ /** The delivery channel information of the session. */
169
+ deliveryChannel: Scalars['String'];
170
+ /** The delivery method information of the session. */
171
+ deliveryMethod: Scalars['String'];
172
+ /** The delivery window information of the session. */
173
+ deliveryWindow?: Maybe<IStoreDeliveryWindow>;
174
+ };
175
+ /** Delivery window information. */
176
+ export type IStoreDeliveryWindow = {
177
+ /** The delivery window end date information. */
178
+ endDate: Scalars['String'];
179
+ /** The delivery window start date information. */
180
+ startDate: Scalars['String'];
181
+ };
182
+ export type IStoreGeoCoordinates = {
183
+ /** The latitude of the geographic coordinates. */
184
+ latitude: Scalars['Float'];
185
+ /** The longitude of the geographic coordinates. */
186
+ longitude: Scalars['Float'];
187
+ };
188
+ /** Image input. */
189
+ export type IStoreImage = {
190
+ /** Alias for the input image. */
191
+ alternateName: Scalars['String'];
192
+ /** Image input URL. */
193
+ url: Scalars['String'];
194
+ };
195
+ /** Offer input. */
196
+ export type IStoreOffer = {
197
+ /** Information on the item being offered. */
198
+ itemOffered: IStoreProduct;
199
+ /** This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. */
200
+ listPrice: Scalars['Float'];
201
+ /** Also known as spot price. */
202
+ price: Scalars['Float'];
203
+ /** Number of items offered. */
204
+ quantity: Scalars['Int'];
205
+ /** Seller responsible for the offer. */
206
+ seller: IStoreOrganization;
207
+ };
208
+ /** Order input. */
209
+ export type IStoreOrder = {
210
+ /** Array with information on each accepted offer. */
211
+ acceptedOffer: Array<IStoreOffer>;
212
+ /** ID of the order in [VTEX order management](https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg#). */
213
+ orderNumber: Scalars['String'];
214
+ /** Indicates whether or not items with attachments should be split. */
215
+ shouldSplitItem?: Maybe<Scalars['Boolean']>;
216
+ };
217
+ /** Organization input. */
218
+ export type IStoreOrganization = {
219
+ /** Organization ID. */
220
+ identifier: Scalars['String'];
221
+ };
222
+ /** Client profile data. */
223
+ export type IStorePerson = {
224
+ /** Client email. */
225
+ email: Scalars['String'];
226
+ /** Client last name. */
227
+ familyName: Scalars['String'];
228
+ /** Client first name. */
229
+ givenName: Scalars['String'];
230
+ /** Client ID. */
231
+ id: Scalars['String'];
232
+ };
233
+ /** Product input. Products are variants within product groups, equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. */
234
+ export type IStoreProduct = {
235
+ /** Custom Product Additional Properties. */
236
+ additionalProperty?: Maybe<Array<IStorePropertyValue>>;
237
+ /** Array of product images. */
238
+ image: Array<IStoreImage>;
239
+ /** Product name. */
240
+ name: Scalars['String'];
241
+ /** Stock Keeping Unit. Merchant-specific ID for the product. */
242
+ sku: Scalars['String'];
243
+ };
244
+ export type IStorePropertyValue = {
245
+ /** Property name. */
246
+ name: Scalars['String'];
247
+ /** Property id. This propert changes according to the content of the object. */
248
+ propertyID?: Maybe<Scalars['String']>;
249
+ /** Property value. May hold a string or the string representation of an object. */
250
+ value: Scalars['ObjectOrString'];
251
+ /** Specifies the nature of the value */
252
+ valueReference: Scalars['String'];
253
+ };
254
+ /** Selected search facet input. */
255
+ export type IStoreSelectedFacet = {
256
+ /** Selected search facet key. */
257
+ key: Scalars['String'];
258
+ /** Selected search facet value. */
259
+ value: Scalars['String'];
260
+ };
261
+ /** Session input. */
262
+ export type IStoreSession = {
263
+ /** Session input address type. */
264
+ addressType?: Maybe<Scalars['String']>;
265
+ /** Session input channel. */
266
+ channel?: Maybe<Scalars['String']>;
267
+ /** Session input country. */
268
+ country: Scalars['String'];
269
+ /** Session input currency. */
270
+ currency: IStoreCurrency;
271
+ /** Session input delivery mode. */
272
+ deliveryMode?: Maybe<IStoreDeliveryMode>;
273
+ /** Session input geoCoordinates. */
274
+ geoCoordinates?: Maybe<IStoreGeoCoordinates>;
275
+ /** Session input locale. */
276
+ locale: Scalars['String'];
277
+ /** Session input person. */
278
+ person?: Maybe<IStorePerson>;
279
+ /** Session input postal code. */
280
+ postalCode?: Maybe<Scalars['String']>;
281
+ };
282
+ export type LogisticsInfo = {
283
+ __typename?: 'LogisticsInfo';
284
+ /** LogisticsInfo itemIndex. */
285
+ itemIndex?: Maybe<Scalars['String']>;
286
+ /** LogisticsInfo selectedSla. */
287
+ selectedSla?: Maybe<Scalars['String']>;
288
+ /** List of LogisticsInfo ShippingSLA. */
289
+ slas?: Maybe<Array<Maybe<ShippingSla>>>;
290
+ };
291
+ /** Shipping Simulation Logistic Item. */
292
+ export type LogisticsItem = {
293
+ __typename?: 'LogisticsItem';
294
+ /** LogisticsItem availability. */
295
+ availability?: Maybe<Scalars['String']>;
296
+ /** LogisticsItem ID / Sku. */
297
+ id?: Maybe<Scalars['String']>;
298
+ /** LogisticsItem listPrice. */
299
+ listPrice?: Maybe<Scalars['Int']>;
300
+ /** LogisticsItem measurementUnit. */
301
+ measurementUnit?: Maybe<Scalars['String']>;
302
+ /** LogisticsItem price. */
303
+ price?: Maybe<Scalars['Int']>;
304
+ /** Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time. */
305
+ priceValidUntil?: Maybe<Scalars['String']>;
306
+ /** Number of items. */
307
+ quantity?: Maybe<Scalars['Int']>;
308
+ requestIndex?: Maybe<Scalars['Int']>;
309
+ /** LogisticsItem rewardValue. */
310
+ rewardValue?: Maybe<Scalars['Int']>;
311
+ /** Seller responsible for the ShippingItem. */
312
+ seller?: Maybe<Scalars['String']>;
313
+ /** List of Sellers. */
314
+ sellerChain?: Maybe<Array<Maybe<Scalars['String']>>>;
315
+ /** LogisticsItem sellingPrice. */
316
+ sellingPrice?: Maybe<Scalars['Int']>;
317
+ /** LogisticsItem tax. */
318
+ tax?: Maybe<Scalars['Int']>;
319
+ /** LogisticsItem unitMultiplier. */
320
+ unitMultiplier?: Maybe<Scalars['Int']>;
321
+ };
322
+ export type MessageFields = {
323
+ __typename?: 'MessageFields';
324
+ /** MessageFields ean. */
325
+ ean?: Maybe<Scalars['String']>;
326
+ /** MessageFields item index. */
327
+ itemIndex?: Maybe<Scalars['String']>;
328
+ /** MessageFields sku name. */
329
+ skuName?: Maybe<Scalars['String']>;
330
+ };
331
+ export type MessageInfo = {
332
+ __typename?: 'MessageInfo';
333
+ /** MessageInfo code. */
334
+ code?: Maybe<Scalars['String']>;
335
+ /** MessageInfo fields. */
336
+ fields?: Maybe<MessageFields>;
337
+ /** MessageInfo status. */
338
+ status?: Maybe<Scalars['String']>;
339
+ /** MessageInfo text. */
340
+ text?: Maybe<Scalars['String']>;
341
+ };
342
+ export type Mutation = {
343
+ __typename?: 'Mutation';
344
+ /** Subscribes a new person to the newsletter list. */
345
+ subscribeToNewsletter?: Maybe<PersonNewsletter>;
346
+ /** Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns `null`. */
347
+ validateCart?: Maybe<StoreCart>;
348
+ /** Updates a web session with the specified values. */
349
+ validateSession?: Maybe<StoreSession>;
350
+ };
351
+ export type MutationSubscribeToNewsletterArgs = {
352
+ data: IPersonNewsletter;
353
+ };
354
+ export type MutationValidateCartArgs = {
355
+ cart: IStoreCart;
356
+ session?: Maybe<IStoreSession>;
357
+ };
358
+ export type MutationValidateSessionArgs = {
359
+ search: Scalars['String'];
360
+ session: IStoreSession;
361
+ };
362
+ /** Newsletter information. */
363
+ export type PersonNewsletter = {
364
+ __typename?: 'PersonNewsletter';
365
+ /** Person's ID in the newsletter list. */
366
+ id: Scalars['String'];
367
+ };
368
+ export type PickupAddress = {
369
+ __typename?: 'PickupAddress';
370
+ /** PickupAddress address id. */
371
+ addressId?: Maybe<Scalars['String']>;
372
+ /** PickupAddress address type. */
373
+ addressType?: Maybe<Scalars['String']>;
374
+ /** PickupAddress city. */
375
+ city?: Maybe<Scalars['String']>;
376
+ /** PickupAddress complement. */
377
+ complement?: Maybe<Scalars['String']>;
378
+ /** PickupAddress country. */
379
+ country?: Maybe<Scalars['String']>;
380
+ /** PickupAddress geo coordinates. */
381
+ geoCoordinates?: Maybe<Array<Maybe<Scalars['Float']>>>;
382
+ /** PickupAddress neighborhood. */
383
+ neighborhood?: Maybe<Scalars['String']>;
384
+ /** PickupAddress number. */
385
+ number?: Maybe<Scalars['String']>;
386
+ /** PickupAddress postal code. */
387
+ postalCode?: Maybe<Scalars['String']>;
388
+ /** PickupAddress receiver name. */
389
+ receiverName?: Maybe<Scalars['String']>;
390
+ /** PickupAddress reference. */
391
+ reference?: Maybe<Scalars['String']>;
392
+ /** PickupAddress state. */
393
+ state?: Maybe<Scalars['String']>;
394
+ /** PickupAddress street. */
395
+ street?: Maybe<Scalars['String']>;
396
+ };
397
+ export type PickupStoreInfo = {
398
+ __typename?: 'PickupStoreInfo';
399
+ /** PickupStoreInfo additional information. */
400
+ additionalInfo?: Maybe<Scalars['String']>;
401
+ /** PickupStoreInfo address. */
402
+ address?: Maybe<PickupAddress>;
403
+ /** PickupStoreInfo dock id. */
404
+ dockId?: Maybe<Scalars['String']>;
405
+ /** PickupStoreInfo friendly name. */
406
+ friendlyName?: Maybe<Scalars['String']>;
407
+ /** Information if the store has pickup enable. */
408
+ isPickupStore?: Maybe<Scalars['Boolean']>;
409
+ };
410
+ export type Query = {
411
+ __typename?: 'Query';
412
+ /** Returns information about all collections. */
413
+ allCollections: StoreCollectionConnection;
414
+ /** Returns information about all products. */
415
+ allProducts: StoreProductConnection;
416
+ /** Returns the details of a collection based on the collection slug. */
417
+ collection: StoreCollection;
418
+ /** Returns the details of a product based on the specified locator. */
419
+ product: StoreProduct;
420
+ /** Returns if there's a redirect for a search. */
421
+ redirect?: Maybe<StoreRedirect>;
422
+ /** Returns the result of a product, facet, or suggestion search. */
423
+ search: StoreSearchResult;
424
+ /** Returns a list of sellers available for a specific localization. */
425
+ sellers?: Maybe<SellersData>;
426
+ /** Returns information about shipping simulation. */
427
+ shipping?: Maybe<ShippingData>;
428
+ };
429
+ export type QueryAllCollectionsArgs = {
430
+ after?: Maybe<Scalars['String']>;
431
+ first: Scalars['Int'];
432
+ };
433
+ export type QueryAllProductsArgs = {
434
+ after?: Maybe<Scalars['String']>;
435
+ first: Scalars['Int'];
436
+ };
437
+ export type QueryCollectionArgs = {
438
+ slug: Scalars['String'];
439
+ };
440
+ export type QueryProductArgs = {
441
+ locator: Array<IStoreSelectedFacet>;
442
+ };
443
+ export type QueryRedirectArgs = {
444
+ selectedFacets?: Maybe<Array<IStoreSelectedFacet>>;
445
+ term?: Maybe<Scalars['String']>;
446
+ };
447
+ export type QuerySearchArgs = {
448
+ after?: Maybe<Scalars['String']>;
449
+ first: Scalars['Int'];
450
+ selectedFacets?: Maybe<Array<IStoreSelectedFacet>>;
451
+ sort?: Maybe<StoreSort>;
452
+ term?: Maybe<Scalars['String']>;
453
+ };
454
+ export type QuerySellersArgs = {
455
+ country: Scalars['String'];
456
+ geoCoordinates?: Maybe<IGeoCoordinates>;
457
+ postalCode?: Maybe<Scalars['String']>;
458
+ salesChannel?: Maybe<Scalars['String']>;
459
+ };
460
+ export type QueryShippingArgs = {
461
+ country: Scalars['String'];
462
+ items: Array<IShippingItem>;
463
+ postalCode: Scalars['String'];
464
+ };
465
+ /** Search result. */
466
+ export type SearchMetadata = {
467
+ __typename?: 'SearchMetadata';
468
+ /** Indicates if the search term was misspelled. */
469
+ isTermMisspelled: Scalars['Boolean'];
470
+ /** Logical operator used to run the search. */
471
+ logicalOperator: Scalars['String'];
472
+ };
473
+ /** Information of sellers. */
474
+ export type SellerInfo = {
475
+ __typename?: 'SellerInfo';
476
+ /** Identification of the seller */
477
+ id?: Maybe<Scalars['String']>;
478
+ /** Logo of the seller */
479
+ logo?: Maybe<Scalars['String']>;
480
+ /** Name of the seller */
481
+ name?: Maybe<Scalars['String']>;
482
+ };
483
+ /** Regionalization with sellers information. */
484
+ export type SellersData = {
485
+ __typename?: 'SellersData';
486
+ /** Identification of region. */
487
+ id?: Maybe<Scalars['String']>;
488
+ /** List of sellers. */
489
+ sellers?: Maybe<Array<Maybe<SellerInfo>>>;
490
+ };
491
+ /** Shipping Simulation information. */
492
+ export type ShippingData = {
493
+ __typename?: 'ShippingData';
494
+ /** Address information. */
495
+ address?: Maybe<Address>;
496
+ /** List of LogisticsItem. */
497
+ items?: Maybe<Array<Maybe<LogisticsItem>>>;
498
+ /** List of LogisticsInfo. */
499
+ logisticsInfo?: Maybe<Array<Maybe<LogisticsInfo>>>;
500
+ /** List of MessageInfo. */
501
+ messages?: Maybe<Array<Maybe<MessageInfo>>>;
502
+ };
503
+ export type ShippingSla = {
504
+ __typename?: 'ShippingSLA';
505
+ /** ShippingSLA available delivery windows. */
506
+ availableDeliveryWindows?: Maybe<Array<Maybe<AvailableDeliveryWindows>>>;
507
+ /** ShippingSLA carrier. */
508
+ carrier?: Maybe<Scalars['String']>;
509
+ /** ShippingSLA delivery channel. */
510
+ deliveryChannel?: Maybe<Scalars['String']>;
511
+ /** List of ShippingSLA delivery ids. */
512
+ deliveryIds?: Maybe<Array<Maybe<DeliveryIds>>>;
513
+ /** ShippingSLA friendly name. */
514
+ friendlyName?: Maybe<Scalars['String']>;
515
+ /** ShippingSLA id. */
516
+ id?: Maybe<Scalars['String']>;
517
+ /**
518
+ * ShippingSLA localized shipping estimate.
519
+ * Note: this will always return a localized string for locale `en-US`.
520
+ */
521
+ localizedEstimates?: Maybe<Scalars['String']>;
522
+ /** ShippingSLA name. */
523
+ name?: Maybe<Scalars['String']>;
524
+ /** ShippingSLA pickup distance. */
525
+ pickupDistance?: Maybe<Scalars['Float']>;
526
+ /** ShippingSLA pickup point id. */
527
+ pickupPointId?: Maybe<Scalars['String']>;
528
+ /** ShippingSLA pickup store info. */
529
+ pickupStoreInfo?: Maybe<PickupStoreInfo>;
530
+ /** ShippingSLA price. */
531
+ price?: Maybe<Scalars['Float']>;
532
+ /** ShippingSLA shipping estimate. */
533
+ shippingEstimate?: Maybe<Scalars['String']>;
534
+ /** ShippingSLA shipping estimate date. */
535
+ shippingEstimateDate?: Maybe<Scalars['String']>;
536
+ };
537
+ export type SkuVariants = {
538
+ __typename?: 'SkuVariants';
539
+ /** SKU property values for the current SKU. */
540
+ activeVariations?: Maybe<Scalars['ActiveVariations']>;
541
+ /** All available options for each SKU variant property, indexed by their name. */
542
+ allVariantsByName?: Maybe<Scalars['VariantsByName']>;
543
+ /**
544
+ * Available options for each varying SKU property, taking into account the
545
+ * `dominantVariantName` property. Returns all available options for the
546
+ * dominant property, and only options that can be combined with its current
547
+ * value for other properties.
548
+ * If `dominantVariantName` is not present, the first variant will be
549
+ * considered the dominant one.
550
+ */
551
+ availableVariations?: Maybe<Scalars['FormattedVariants']>;
552
+ /**
553
+ * Maps property value combinations to their respective SKU's slug. Enables
554
+ * us to retrieve the slug for the SKU that matches the currently selected
555
+ * variations in O(1) time.
556
+ * If `dominantVariantName` is not present, the first variant will be
557
+ * considered the dominant one.
558
+ */
559
+ slugsMap?: Maybe<Scalars['SlugsMap']>;
560
+ };
561
+ export type SkuVariantsAvailableVariationsArgs = {
562
+ dominantVariantName?: Maybe<Scalars['String']>;
563
+ };
564
+ export type SkuVariantsSlugsMapArgs = {
565
+ dominantVariantName?: Maybe<Scalars['String']>;
566
+ };
567
+ /** Aggregate offer information, for a given SKU that is available to be fulfilled by multiple sellers. */
568
+ export type StoreAggregateOffer = {
569
+ __typename?: 'StoreAggregateOffer';
570
+ /** Highest price among all sellers. */
571
+ highPrice: Scalars['Float'];
572
+ /** Lowest price among all sellers. */
573
+ lowPrice: Scalars['Float'];
574
+ /** Number of sellers selling this SKU. */
575
+ offerCount: Scalars['Int'];
576
+ /** Array with information on each available offer. */
577
+ offers: Array<StoreOffer>;
578
+ /** ISO code of the currency used for the offer prices. */
579
+ priceCurrency: Scalars['String'];
580
+ };
581
+ /** Average rating, based on multiple ratings or reviews. */
582
+ export type StoreAggregateRating = {
583
+ __typename?: 'StoreAggregateRating';
584
+ /** Value of the aggregate rating. */
585
+ ratingValue: Scalars['Float'];
586
+ /** Total number of ratings. */
587
+ reviewCount: Scalars['Int'];
588
+ };
589
+ /** information about the author of a product review or rating. */
590
+ export type StoreAuthor = {
591
+ __typename?: 'StoreAuthor';
592
+ /** Author name. */
593
+ name: Scalars['String'];
594
+ };
595
+ /** Brand of a given product. */
596
+ export type StoreBrand = {
597
+ __typename?: 'StoreBrand';
598
+ /** Brand name. */
599
+ name: Scalars['String'];
600
+ };
601
+ /** List of items consisting of chain linked web pages, ending with the current page. */
602
+ export type StoreBreadcrumbList = {
603
+ __typename?: 'StoreBreadcrumbList';
604
+ /** Array with breadcrumb elements. */
605
+ itemListElement: Array<StoreListItem>;
606
+ /** Number of breadcrumbs in the list. */
607
+ numberOfItems: Scalars['Int'];
608
+ };
609
+ /** Shopping cart information. */
610
+ export type StoreCart = {
611
+ __typename?: 'StoreCart';
612
+ /** List of shopping cart messages. */
613
+ messages: Array<StoreCartMessage>;
614
+ /** Order information, including `orderNumber` and `acceptedOffer`. */
615
+ order: StoreOrder;
616
+ };
617
+ /** Shopping cart message. */
618
+ export type StoreCartMessage = {
619
+ __typename?: 'StoreCartMessage';
620
+ /** Shopping cart message status, which can be `INFO`, `WARNING` or `ERROR`. */
621
+ status: StoreStatus;
622
+ /** Shopping cart message text. */
623
+ text: Scalars['String'];
624
+ };
625
+ /** Product collection information. */
626
+ export type StoreCollection = {
627
+ __typename?: 'StoreCollection';
628
+ /** List of items consisting of chain linked web pages, ending with the current page. */
629
+ breadcrumbList: StoreBreadcrumbList;
630
+ /** Collection ID. */
631
+ id: Scalars['ID'];
632
+ /** Collection meta information. Used for search. */
633
+ meta: StoreCollectionMeta;
634
+ /** Meta tag data. */
635
+ seo: StoreSeo;
636
+ /** Corresponding collection URL slug, with which to retrieve this entity. */
637
+ slug: Scalars['String'];
638
+ /** Collection type. */
639
+ type: StoreCollectionType;
640
+ };
641
+ /** Collection connections, including pagination information and collections returned by the query. */
642
+ export type StoreCollectionConnection = {
643
+ __typename?: 'StoreCollectionConnection';
644
+ /** Array with collection connection page edges, each containing a collection and a corresponding cursor.. */
645
+ edges: Array<StoreCollectionEdge>;
646
+ /** Collection pagination information. */
647
+ pageInfo: StorePageInfo;
648
+ };
649
+ /** Each collection edge contains a `node`, with product collection information, and a `cursor`, that can be used as a reference for pagination. */
650
+ export type StoreCollectionEdge = {
651
+ __typename?: 'StoreCollectionEdge';
652
+ /** Collection cursor. Used as pagination reference. */
653
+ cursor: Scalars['String'];
654
+ /** Each collection node contains the information of a product collection returned by the query. */
655
+ node: StoreCollection;
656
+ };
657
+ /** Product collection facet, used for search. */
658
+ export type StoreCollectionFacet = {
659
+ __typename?: 'StoreCollectionFacet';
660
+ /** Facet key. */
661
+ key: Scalars['String'];
662
+ /** Facet value. */
663
+ value: Scalars['String'];
664
+ };
665
+ /** Collection meta information. Used for search. */
666
+ export type StoreCollectionMeta = {
667
+ __typename?: 'StoreCollectionMeta';
668
+ /** List of selected collection facets. */
669
+ selectedFacets: Array<StoreCollectionFacet>;
670
+ };
671
+ /** Product collection type. Possible values are `Department`, `Category`, `Brand`, `Cluster`, `SubCategory` or `Collection`. */
672
+ export declare const enum StoreCollectionType {
673
+ /** Product brand. */
674
+ Brand = "Brand",
675
+ /** Second level of product categorization. */
676
+ Category = "Category",
677
+ /** Product cluster. */
678
+ Cluster = "Cluster",
679
+ /** Product collection. */
680
+ Collection = "Collection",
681
+ /** First level of product categorization. */
682
+ Department = "Department",
683
+ /** Third level of product categorization. */
684
+ SubCategory = "SubCategory"
685
+ }
686
+ /** Currency information. */
687
+ export type StoreCurrency = {
688
+ __typename?: 'StoreCurrency';
689
+ /** Currency code (e.g: USD). */
690
+ code: Scalars['String'];
691
+ /** Currency symbol (e.g: $). */
692
+ symbol: Scalars['String'];
693
+ };
694
+ /** Delivery mode information. */
695
+ export type StoreDeliveryMode = {
696
+ __typename?: 'StoreDeliveryMode';
697
+ /** The delivery channel information of the session. */
698
+ deliveryChannel: Scalars['String'];
699
+ /** The delivery method information of the session. */
700
+ deliveryMethod: Scalars['String'];
701
+ /** The delivery window information of the session. */
702
+ deliveryWindow?: Maybe<StoreDeliveryWindow>;
703
+ };
704
+ /** Delivery window information. */
705
+ export type StoreDeliveryWindow = {
706
+ __typename?: 'StoreDeliveryWindow';
707
+ /** The delivery window end date information. */
708
+ endDate: Scalars['String'];
709
+ /** The delivery window start date information. */
710
+ startDate: Scalars['String'];
711
+ };
712
+ export type StoreFacet = StoreFacetBoolean | StoreFacetRange;
713
+ /** Search facet boolean information. */
714
+ export type StoreFacetBoolean = {
715
+ __typename?: 'StoreFacetBoolean';
716
+ /** Facet key. */
717
+ key: Scalars['String'];
718
+ /** Facet label. */
719
+ label: Scalars['String'];
720
+ /** Array with information on each facet value. */
721
+ values: Array<StoreFacetValueBoolean>;
722
+ };
723
+ /** Search facet range information. */
724
+ export type StoreFacetRange = {
725
+ __typename?: 'StoreFacetRange';
726
+ /** Facet key. */
727
+ key: Scalars['String'];
728
+ /** Facet label. */
729
+ label: Scalars['String'];
730
+ /** Maximum facet range value. */
731
+ max: StoreFacetValueRange;
732
+ /** Minimum facet range value. */
733
+ min: StoreFacetValueRange;
734
+ };
735
+ /** Search facet type. */
736
+ export declare const enum StoreFacetType {
737
+ /** Indicates boolean search facet. */
738
+ Boolean = "BOOLEAN",
739
+ /** Indicates range type search facet. */
740
+ Range = "RANGE"
741
+ }
742
+ /** Information of a specific facet value. */
743
+ export type StoreFacetValueBoolean = {
744
+ __typename?: 'StoreFacetValueBoolean';
745
+ /** Facet value label. */
746
+ label: Scalars['String'];
747
+ /** Number of items with this facet. */
748
+ quantity: Scalars['Int'];
749
+ /** Indicates whether facet is selected. */
750
+ selected: Scalars['Boolean'];
751
+ /** Facet value. */
752
+ value: Scalars['String'];
753
+ };
754
+ /** Search facet range value information. Used for minimum and maximum range values. */
755
+ export type StoreFacetValueRange = {
756
+ __typename?: 'StoreFacetValueRange';
757
+ /** Search facet range absolute value. */
758
+ absolute: Scalars['Float'];
759
+ /** Search facet range selected value. */
760
+ selected: Scalars['Float'];
761
+ };
762
+ /** Geographic coordinates information. */
763
+ export type StoreGeoCoordinates = {
764
+ __typename?: 'StoreGeoCoordinates';
765
+ /** The latitude of the geographic coordinates. */
766
+ latitude: Scalars['Float'];
767
+ /** The longitude of the geographic coordinates. */
768
+ longitude: Scalars['Float'];
769
+ };
770
+ /** Image. */
771
+ export type StoreImage = {
772
+ __typename?: 'StoreImage';
773
+ /** Alias for the image. */
774
+ alternateName: Scalars['String'];
775
+ /** Image URL. */
776
+ url: Scalars['String'];
777
+ };
778
+ /** Item of a list. */
779
+ export type StoreListItem = {
780
+ __typename?: 'StoreListItem';
781
+ /** List item value. */
782
+ item: Scalars['String'];
783
+ /** Name of the list item. */
784
+ name: Scalars['String'];
785
+ /** Position of the item in the list. */
786
+ position: Scalars['Int'];
787
+ };
788
+ /** Offer information. */
789
+ export type StoreOffer = {
790
+ __typename?: 'StoreOffer';
791
+ /** Offer item availability. */
792
+ availability: Scalars['String'];
793
+ /** Offer item condition. */
794
+ itemCondition: Scalars['String'];
795
+ /** Information on the item being offered. */
796
+ itemOffered: StoreProduct;
797
+ /** This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. */
798
+ listPrice: Scalars['Float'];
799
+ /** Also known as spot price. */
800
+ price: Scalars['Float'];
801
+ /** ISO code of the currency used for the offer prices. */
802
+ priceCurrency: Scalars['String'];
803
+ /** Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time. */
804
+ priceValidUntil: Scalars['String'];
805
+ /** Number of items offered. */
806
+ quantity: Scalars['Int'];
807
+ /** Seller responsible for the offer. */
808
+ seller: StoreOrganization;
809
+ /** Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf. */
810
+ sellingPrice: Scalars['Float'];
811
+ };
812
+ /** Information of a specific order. */
813
+ export type StoreOrder = {
814
+ __typename?: 'StoreOrder';
815
+ /** Array with information on each accepted offer. */
816
+ acceptedOffer: Array<StoreOffer>;
817
+ /** ID of the order in [VTEX order management](https://help.vtex.com/en/tutorial/license-manager-resources-oms--60QcBsvWeum02cFi3GjBzg#). */
818
+ orderNumber: Scalars['String'];
819
+ };
820
+ /** Organization. */
821
+ export type StoreOrganization = {
822
+ __typename?: 'StoreOrganization';
823
+ /** Organization ID. */
824
+ identifier: Scalars['String'];
825
+ };
826
+ /** Whenever you make a query that allows for pagination, such as `allProducts` or `allCollections`, you can check `StorePageInfo` to learn more about the complete set of items and use it to paginate your queries. */
827
+ export type StorePageInfo = {
828
+ __typename?: 'StorePageInfo';
829
+ /** Cursor corresponding to the last possible item. */
830
+ endCursor: Scalars['String'];
831
+ /** Indicates whether there is at least one more page with items after the ones returned in the current query. */
832
+ hasNextPage: Scalars['Boolean'];
833
+ /** Indicates whether there is at least one more page with items before the ones returned in the current query. */
834
+ hasPreviousPage: Scalars['Boolean'];
835
+ /** Cursor corresponding to the first possible item. */
836
+ startCursor: Scalars['String'];
837
+ /** Total number of items (products or collections), not pages. */
838
+ totalCount: Scalars['Int'];
839
+ };
840
+ /** Client profile data. */
841
+ export type StorePerson = {
842
+ __typename?: 'StorePerson';
843
+ /** Client email. */
844
+ email: Scalars['String'];
845
+ /** Client last name. */
846
+ familyName: Scalars['String'];
847
+ /** Client first name. */
848
+ givenName: Scalars['String'];
849
+ /** Client ID. */
850
+ id: Scalars['String'];
851
+ };
852
+ /** Product information. Products are variants within product groups, equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. */
853
+ export type StoreProduct = {
854
+ __typename?: 'StoreProduct';
855
+ /** Array of additional properties. */
856
+ additionalProperty: Array<StorePropertyValue>;
857
+ /** Aggregate ratings data. */
858
+ aggregateRating: StoreAggregateRating;
859
+ /** Product brand. */
860
+ brand: StoreBrand;
861
+ /** List of items consisting of chain linked web pages, ending with the current page. */
862
+ breadcrumbList: StoreBreadcrumbList;
863
+ /** Product description. */
864
+ description: Scalars['String'];
865
+ /** Global Trade Item Number. */
866
+ gtin: Scalars['String'];
867
+ /** Array of images. */
868
+ image: Array<StoreImage>;
869
+ /** Indicates product group related to this product. */
870
+ isVariantOf: StoreProductGroup;
871
+ /** Product name. */
872
+ name: Scalars['String'];
873
+ /** Aggregate offer information. */
874
+ offers: StoreAggregateOffer;
875
+ /** Product ID, such as [ISBN](https://www.isbn-international.org/content/what-isbn) or similar global IDs. */
876
+ productID: Scalars['String'];
877
+ /** The product's release date. Formatted using https://en.wikipedia.org/wiki/ISO_8601 */
878
+ releaseDate: Scalars['String'];
879
+ /** Array with review information. */
880
+ review: Array<StoreReview>;
881
+ /** Meta tag data. */
882
+ seo: StoreSeo;
883
+ /** Stock Keeping Unit. Merchant-specific ID for the product. */
884
+ sku: Scalars['String'];
885
+ /** Corresponding collection URL slug, with which to retrieve this entity. */
886
+ slug: Scalars['String'];
887
+ };
888
+ /** Product connections, including pagination information and products returned by the query. */
889
+ export type StoreProductConnection = {
890
+ __typename?: 'StoreProductConnection';
891
+ /** Array with product connection edges, each containing a product and a corresponding cursor. */
892
+ edges: Array<StoreProductEdge>;
893
+ /** Product pagination information. */
894
+ pageInfo: StorePageInfo;
895
+ };
896
+ /** Each product edge contains a `node`, with product information, and a `cursor`, that can be used as a reference for pagination. */
897
+ export type StoreProductEdge = {
898
+ __typename?: 'StoreProductEdge';
899
+ /** Product cursor. Used as pagination reference. */
900
+ cursor: Scalars['String'];
901
+ /** Each product node contains the information of a product returned by the query. */
902
+ node: StoreProduct;
903
+ };
904
+ /** Product group information. Product groups are catalog entities that may contain variants. They are equivalent to VTEX [Products](https://help.vtex.com/en/tutorial/what-is-a-product--2zrB2gFCHyQokCKKE8kuAw#), whereas each variant is equivalent to a VTEX [SKU](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). For example, you may have a **Shirt** product group with associated products such as **Blue shirt size L**, **Green shirt size XL** and so on. */
905
+ export type StoreProductGroup = {
906
+ __typename?: 'StoreProductGroup';
907
+ /** Array of additional properties. */
908
+ additionalProperty: Array<StorePropertyValue>;
909
+ /** Array of variants related to product group. Variants are equivalent to VTEX [SKUs](https://help.vtex.com/en/tutorial/what-is-an-sku--1K75s4RXAQyOuGUYKMM68u#). */
910
+ hasVariant: Array<StoreProduct>;
911
+ /** Product group name. */
912
+ name: Scalars['String'];
913
+ /** Product group ID. */
914
+ productGroupID: Scalars['String'];
915
+ /**
916
+ * Object containing data structures to facilitate handling different SKU
917
+ * variant properties. Specially useful for implementing SKU selection
918
+ * components.
919
+ */
920
+ skuVariants?: Maybe<SkuVariants>;
921
+ };
922
+ /** Properties that can be associated with products and products groups. */
923
+ export type StorePropertyValue = {
924
+ __typename?: 'StorePropertyValue';
925
+ /** Property name. */
926
+ name: Scalars['String'];
927
+ /** Property id. This propert changes according to the content of the object. */
928
+ propertyID: Scalars['String'];
929
+ /** Property value. May hold a string or the string representation of an object. */
930
+ value: Scalars['ObjectOrString'];
931
+ /** Specifies the nature of the value */
932
+ valueReference: Scalars['String'];
933
+ };
934
+ /**
935
+ * Redirect informations, including url returned by the query.
936
+ * https://schema.org/Thing
937
+ */
938
+ export type StoreRedirect = {
939
+ __typename?: 'StoreRedirect';
940
+ /** URL to redirect */
941
+ url?: Maybe<Scalars['String']>;
942
+ };
943
+ /** Information of a given review. */
944
+ export type StoreReview = {
945
+ __typename?: 'StoreReview';
946
+ /** Review author. */
947
+ author: StoreAuthor;
948
+ /** Review rating information. */
949
+ reviewRating: StoreReviewRating;
950
+ };
951
+ /** Information of a given review rating. */
952
+ export type StoreReviewRating = {
953
+ __typename?: 'StoreReviewRating';
954
+ /** Best rating value. */
955
+ bestRating: Scalars['Float'];
956
+ /** Rating value. */
957
+ ratingValue: Scalars['Float'];
958
+ };
959
+ /** Search result. */
960
+ export type StoreSearchResult = {
961
+ __typename?: 'StoreSearchResult';
962
+ /** Array of search result facets. */
963
+ facets: Array<StoreFacet>;
964
+ /** Search result metadata. Additional data can be used to send analytics events. */
965
+ metadata?: Maybe<SearchMetadata>;
966
+ /** Search result products. */
967
+ products: StoreProductConnection;
968
+ /** Search result suggestions. */
969
+ suggestions: StoreSuggestions;
970
+ };
971
+ /** Search Engine Optimization (SEO) tags data. */
972
+ export type StoreSeo = {
973
+ __typename?: 'StoreSeo';
974
+ /** Canonical tag. */
975
+ canonical: Scalars['String'];
976
+ /** Description tag. */
977
+ description: Scalars['String'];
978
+ /** Title tag. */
979
+ title: Scalars['String'];
980
+ /** Title template tag. */
981
+ titleTemplate: Scalars['String'];
982
+ };
983
+ /** Session information. */
984
+ export type StoreSession = {
985
+ __typename?: 'StoreSession';
986
+ /** Session address type. */
987
+ addressType?: Maybe<Scalars['String']>;
988
+ /** Session channel. */
989
+ channel?: Maybe<Scalars['String']>;
990
+ /** Session country. */
991
+ country: Scalars['String'];
992
+ /** Session currency. */
993
+ currency: StoreCurrency;
994
+ /** Session delivery mode. */
995
+ deliveryMode?: Maybe<StoreDeliveryMode>;
996
+ /** Session input geoCoordinates. */
997
+ geoCoordinates?: Maybe<StoreGeoCoordinates>;
998
+ /** Session locale. */
999
+ locale: Scalars['String'];
1000
+ /** Session input person. */
1001
+ person?: Maybe<StorePerson>;
1002
+ /** Session postal code. */
1003
+ postalCode?: Maybe<Scalars['String']>;
1004
+ };
1005
+ /** Product search results sorting options. */
1006
+ export declare const enum StoreSort {
1007
+ /** Sort by discount value, from highest to lowest. */
1008
+ DiscountDesc = "discount_desc",
1009
+ /** Sort by name, in alphabetical order. */
1010
+ NameAsc = "name_asc",
1011
+ /** Sort by name, in reverse alphabetical order. */
1012
+ NameDesc = "name_desc",
1013
+ /** Sort by orders, from highest to lowest. */
1014
+ OrdersDesc = "orders_desc",
1015
+ /** Sort by price, from lowest to highest. */
1016
+ PriceAsc = "price_asc",
1017
+ /** Sort by price, from highest to lowest. */
1018
+ PriceDesc = "price_desc",
1019
+ /** Sort by release date, from highest to lowest. */
1020
+ ReleaseDesc = "release_desc",
1021
+ /** Sort by product score, from highest to lowest. */
1022
+ ScoreDesc = "score_desc"
1023
+ }
1024
+ /** Status used to indicate a message type. For instance, a shopping cart informative or error message. */
1025
+ export declare const enum StoreStatus {
1026
+ Error = "ERROR",
1027
+ Info = "INFO",
1028
+ Warning = "WARNING"
1029
+ }
1030
+ /** Suggestion term. */
1031
+ export type StoreSuggestionTerm = {
1032
+ __typename?: 'StoreSuggestionTerm';
1033
+ /** Its occurrences count. */
1034
+ count: Scalars['Int'];
1035
+ /** The term. */
1036
+ value: Scalars['String'];
1037
+ };
1038
+ /** Suggestions information. */
1039
+ export type StoreSuggestions = {
1040
+ __typename?: 'StoreSuggestions';
1041
+ /** Array with suggestion products' information. */
1042
+ products: Array<StoreProduct>;
1043
+ /** Array with suggestion terms. */
1044
+ terms: Array<StoreSuggestionTerm>;
1045
+ };