@marktmentor/api 0.0.0-stage → 0.1.0

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 (523) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +29 -2
  3. package/dist/BaseClient.d.ts +54 -0
  4. package/dist/BaseClient.js +43 -0
  5. package/dist/Client.d.ts +41 -0
  6. package/dist/Client.js +60 -0
  7. package/dist/api/errors/BadRequestError.d.ts +5 -0
  8. package/dist/api/errors/BadRequestError.js +17 -0
  9. package/dist/api/errors/ConflictError.d.ts +5 -0
  10. package/dist/api/errors/ConflictError.js +17 -0
  11. package/dist/api/errors/ForbiddenError.d.ts +5 -0
  12. package/dist/api/errors/ForbiddenError.js +17 -0
  13. package/dist/api/errors/NotFoundError.d.ts +7 -0
  14. package/dist/api/errors/NotFoundError.js +17 -0
  15. package/dist/api/errors/PaymentRequiredError.d.ts +7 -0
  16. package/dist/api/errors/PaymentRequiredError.js +17 -0
  17. package/dist/api/errors/ServiceUnavailableError.d.ts +5 -0
  18. package/dist/api/errors/ServiceUnavailableError.js +17 -0
  19. package/dist/api/errors/TooManyRequestsError.d.ts +5 -0
  20. package/dist/api/errors/TooManyRequestsError.js +17 -0
  21. package/dist/api/errors/UnauthorizedError.d.ts +5 -0
  22. package/dist/api/errors/UnauthorizedError.js +17 -0
  23. package/dist/api/errors/index.d.ts +8 -0
  24. package/dist/api/errors/index.js +8 -0
  25. package/dist/api/index.d.ts +3 -0
  26. package/dist/api/index.js +3 -0
  27. package/dist/api/resources/index.d.ts +13 -0
  28. package/dist/api/resources/index.js +13 -0
  29. package/dist/api/resources/niches/client/Client.d.ts +188 -0
  30. package/dist/api/resources/niches/client/Client.js +655 -0
  31. package/dist/api/resources/niches/client/index.d.ts +1 -0
  32. package/dist/api/resources/niches/client/index.js +1 -0
  33. package/dist/api/resources/niches/client/requests/GetNichesRequest.d.ts +17 -0
  34. package/dist/api/resources/niches/client/requests/GetNichesRequest.js +2 -0
  35. package/dist/api/resources/niches/client/requests/ListNichesRequest.d.ts +34 -0
  36. package/dist/api/resources/niches/client/requests/ListNichesRequest.js +2 -0
  37. package/dist/api/resources/niches/client/requests/ProductDistributionsNichesRequest.d.ts +13 -0
  38. package/dist/api/resources/niches/client/requests/ProductDistributionsNichesRequest.js +2 -0
  39. package/dist/api/resources/niches/client/requests/ProductsNichesRequest.d.ts +48 -0
  40. package/dist/api/resources/niches/client/requests/ProductsNichesRequest.js +2 -0
  41. package/dist/api/resources/niches/client/requests/ReviewHistoryNichesRequest.d.ts +23 -0
  42. package/dist/api/resources/niches/client/requests/ReviewHistoryNichesRequest.js +2 -0
  43. package/dist/api/resources/niches/client/requests/ReviewSummaryNichesRequest.d.ts +5 -0
  44. package/dist/api/resources/niches/client/requests/ReviewSummaryNichesRequest.js +2 -0
  45. package/dist/api/resources/niches/client/requests/ReviewsNichesRequest.d.ts +33 -0
  46. package/dist/api/resources/niches/client/requests/ReviewsNichesRequest.js +2 -0
  47. package/dist/api/resources/niches/client/requests/index.d.ts +7 -0
  48. package/dist/api/resources/niches/client/requests/index.js +1 -0
  49. package/dist/api/resources/niches/exports.d.ts +2 -0
  50. package/dist/api/resources/niches/exports.js +3 -0
  51. package/dist/api/resources/niches/index.d.ts +2 -0
  52. package/dist/api/resources/niches/index.js +2 -0
  53. package/dist/api/resources/niches/types/GetNichesRequestMarket.d.ts +6 -0
  54. package/dist/api/resources/niches/types/GetNichesRequestMarket.js +6 -0
  55. package/dist/api/resources/niches/types/GetNichesRequestPeriod.d.ts +6 -0
  56. package/dist/api/resources/niches/types/GetNichesRequestPeriod.js +6 -0
  57. package/dist/api/resources/niches/types/ListNichesRequestMarket.d.ts +6 -0
  58. package/dist/api/resources/niches/types/ListNichesRequestMarket.js +6 -0
  59. package/dist/api/resources/niches/types/ListNichesRequestPeriod.d.ts +6 -0
  60. package/dist/api/resources/niches/types/ListNichesRequestPeriod.js +6 -0
  61. package/dist/api/resources/niches/types/ListNichesRequestSort.d.ts +9 -0
  62. package/dist/api/resources/niches/types/ListNichesRequestSort.js +9 -0
  63. package/dist/api/resources/niches/types/ProductDistributionsNichesRequestPeriod.d.ts +6 -0
  64. package/dist/api/resources/niches/types/ProductDistributionsNichesRequestPeriod.js +6 -0
  65. package/dist/api/resources/niches/types/ProductsNichesRequestMarket.d.ts +6 -0
  66. package/dist/api/resources/niches/types/ProductsNichesRequestMarket.js +6 -0
  67. package/dist/api/resources/niches/types/ProductsNichesRequestPeriod.d.ts +6 -0
  68. package/dist/api/resources/niches/types/ProductsNichesRequestPeriod.js +6 -0
  69. package/dist/api/resources/niches/types/ProductsNichesRequestSort.d.ts +9 -0
  70. package/dist/api/resources/niches/types/ProductsNichesRequestSort.js +9 -0
  71. package/dist/api/resources/niches/types/ReviewHistoryNichesRequestInterval.d.ts +5 -0
  72. package/dist/api/resources/niches/types/ReviewHistoryNichesRequestInterval.js +5 -0
  73. package/dist/api/resources/niches/types/ReviewHistoryNichesRequestMarket.d.ts +4 -0
  74. package/dist/api/resources/niches/types/ReviewHistoryNichesRequestMarket.js +4 -0
  75. package/dist/api/resources/niches/types/ReviewHistoryNichesRequestPeriod.d.ts +7 -0
  76. package/dist/api/resources/niches/types/ReviewHistoryNichesRequestPeriod.js +7 -0
  77. package/dist/api/resources/niches/types/ReviewsNichesRequestMarket.d.ts +4 -0
  78. package/dist/api/resources/niches/types/ReviewsNichesRequestMarket.js +4 -0
  79. package/dist/api/resources/niches/types/ReviewsNichesRequestPeriod.d.ts +7 -0
  80. package/dist/api/resources/niches/types/ReviewsNichesRequestPeriod.js +7 -0
  81. package/dist/api/resources/niches/types/ReviewsNichesRequestSort.d.ts +7 -0
  82. package/dist/api/resources/niches/types/ReviewsNichesRequestSort.js +7 -0
  83. package/dist/api/resources/niches/types/index.d.ts +15 -0
  84. package/dist/api/resources/niches/types/index.js +15 -0
  85. package/dist/api/resources/organization/client/Client.d.ts +32 -0
  86. package/dist/api/resources/organization/client/Client.js +73 -0
  87. package/dist/api/resources/organization/client/index.d.ts +1 -0
  88. package/dist/api/resources/organization/client/index.js +1 -0
  89. package/dist/api/resources/organization/exports.d.ts +2 -0
  90. package/dist/api/resources/organization/exports.js +3 -0
  91. package/dist/api/resources/organization/index.d.ts +1 -0
  92. package/dist/api/resources/organization/index.js +1 -0
  93. package/dist/api/resources/products/client/Client.d.ts +269 -0
  94. package/dist/api/resources/products/client/Client.js +927 -0
  95. package/dist/api/resources/products/client/index.d.ts +1 -0
  96. package/dist/api/resources/products/client/index.js +1 -0
  97. package/dist/api/resources/products/client/requests/CategoryRankingsProductsRequest.d.ts +23 -0
  98. package/dist/api/resources/products/client/requests/CategoryRankingsProductsRequest.js +2 -0
  99. package/dist/api/resources/products/client/requests/GetProductsRequest.d.ts +15 -0
  100. package/dist/api/resources/products/client/requests/GetProductsRequest.js +2 -0
  101. package/dist/api/resources/products/client/requests/KeywordRankingsProductsRequest.d.ts +27 -0
  102. package/dist/api/resources/products/client/requests/KeywordRankingsProductsRequest.js +2 -0
  103. package/dist/api/resources/products/client/requests/KeywordsProductsRequest.d.ts +19 -0
  104. package/dist/api/resources/products/client/requests/KeywordsProductsRequest.js +2 -0
  105. package/dist/api/resources/products/client/requests/ListProductsRequest.d.ts +50 -0
  106. package/dist/api/resources/products/client/requests/ListProductsRequest.js +2 -0
  107. package/dist/api/resources/products/client/requests/ReviewSummaryProductsRequest.d.ts +8 -0
  108. package/dist/api/resources/products/client/requests/ReviewSummaryProductsRequest.js +2 -0
  109. package/dist/api/resources/products/client/requests/ReviewsProductsRequest.d.ts +35 -0
  110. package/dist/api/resources/products/client/requests/ReviewsProductsRequest.js +2 -0
  111. package/dist/api/resources/products/client/requests/SalesHistoryProductsRequest.d.ts +23 -0
  112. package/dist/api/resources/products/client/requests/SalesHistoryProductsRequest.js +2 -0
  113. package/dist/api/resources/products/client/requests/SellersProductsRequest.d.ts +16 -0
  114. package/dist/api/resources/products/client/requests/SellersProductsRequest.js +2 -0
  115. package/dist/api/resources/products/client/requests/VisibilityHistoryProductsRequest.d.ts +23 -0
  116. package/dist/api/resources/products/client/requests/VisibilityHistoryProductsRequest.js +2 -0
  117. package/dist/api/resources/products/client/requests/index.d.ts +10 -0
  118. package/dist/api/resources/products/client/requests/index.js +1 -0
  119. package/dist/api/resources/products/exports.d.ts +2 -0
  120. package/dist/api/resources/products/exports.js +3 -0
  121. package/dist/api/resources/products/index.d.ts +2 -0
  122. package/dist/api/resources/products/index.js +2 -0
  123. package/dist/api/resources/products/types/CategoryRankingsProductsRequestInterval.d.ts +5 -0
  124. package/dist/api/resources/products/types/CategoryRankingsProductsRequestInterval.js +5 -0
  125. package/dist/api/resources/products/types/CategoryRankingsProductsRequestMarket.d.ts +6 -0
  126. package/dist/api/resources/products/types/CategoryRankingsProductsRequestMarket.js +6 -0
  127. package/dist/api/resources/products/types/CategoryRankingsProductsRequestPeriod.d.ts +7 -0
  128. package/dist/api/resources/products/types/CategoryRankingsProductsRequestPeriod.js +7 -0
  129. package/dist/api/resources/products/types/GetProductsRequestMarket.d.ts +6 -0
  130. package/dist/api/resources/products/types/GetProductsRequestMarket.js +6 -0
  131. package/dist/api/resources/products/types/GetProductsRequestPeriod.d.ts +6 -0
  132. package/dist/api/resources/products/types/GetProductsRequestPeriod.js +6 -0
  133. package/dist/api/resources/products/types/KeywordRankingsProductsRequestInterval.d.ts +5 -0
  134. package/dist/api/resources/products/types/KeywordRankingsProductsRequestInterval.js +5 -0
  135. package/dist/api/resources/products/types/KeywordRankingsProductsRequestMarket.d.ts +6 -0
  136. package/dist/api/resources/products/types/KeywordRankingsProductsRequestMarket.js +6 -0
  137. package/dist/api/resources/products/types/KeywordRankingsProductsRequestPeriod.d.ts +7 -0
  138. package/dist/api/resources/products/types/KeywordRankingsProductsRequestPeriod.js +7 -0
  139. package/dist/api/resources/products/types/KeywordsProductsRequestMarket.d.ts +6 -0
  140. package/dist/api/resources/products/types/KeywordsProductsRequestMarket.js +6 -0
  141. package/dist/api/resources/products/types/KeywordsProductsRequestPeriod.d.ts +6 -0
  142. package/dist/api/resources/products/types/KeywordsProductsRequestPeriod.js +6 -0
  143. package/dist/api/resources/products/types/ListProductsRequestMarket.d.ts +6 -0
  144. package/dist/api/resources/products/types/ListProductsRequestMarket.js +6 -0
  145. package/dist/api/resources/products/types/ListProductsRequestPeriod.d.ts +6 -0
  146. package/dist/api/resources/products/types/ListProductsRequestPeriod.js +6 -0
  147. package/dist/api/resources/products/types/ListProductsRequestSort.d.ts +9 -0
  148. package/dist/api/resources/products/types/ListProductsRequestSort.js +9 -0
  149. package/dist/api/resources/products/types/ReviewsProductsRequestMarket.d.ts +4 -0
  150. package/dist/api/resources/products/types/ReviewsProductsRequestMarket.js +4 -0
  151. package/dist/api/resources/products/types/ReviewsProductsRequestPeriod.d.ts +7 -0
  152. package/dist/api/resources/products/types/ReviewsProductsRequestPeriod.js +7 -0
  153. package/dist/api/resources/products/types/ReviewsProductsRequestSort.d.ts +7 -0
  154. package/dist/api/resources/products/types/ReviewsProductsRequestSort.js +7 -0
  155. package/dist/api/resources/products/types/SalesHistoryProductsRequestInterval.d.ts +5 -0
  156. package/dist/api/resources/products/types/SalesHistoryProductsRequestInterval.js +5 -0
  157. package/dist/api/resources/products/types/SalesHistoryProductsRequestMarket.d.ts +6 -0
  158. package/dist/api/resources/products/types/SalesHistoryProductsRequestMarket.js +6 -0
  159. package/dist/api/resources/products/types/SalesHistoryProductsRequestPeriod.d.ts +7 -0
  160. package/dist/api/resources/products/types/SalesHistoryProductsRequestPeriod.js +7 -0
  161. package/dist/api/resources/products/types/SellersProductsRequestMarket.d.ts +6 -0
  162. package/dist/api/resources/products/types/SellersProductsRequestMarket.js +6 -0
  163. package/dist/api/resources/products/types/SellersProductsRequestPeriod.d.ts +7 -0
  164. package/dist/api/resources/products/types/SellersProductsRequestPeriod.js +7 -0
  165. package/dist/api/resources/products/types/VisibilityHistoryProductsRequestInterval.d.ts +5 -0
  166. package/dist/api/resources/products/types/VisibilityHistoryProductsRequestInterval.js +5 -0
  167. package/dist/api/resources/products/types/VisibilityHistoryProductsRequestMarket.d.ts +6 -0
  168. package/dist/api/resources/products/types/VisibilityHistoryProductsRequestMarket.js +6 -0
  169. package/dist/api/resources/products/types/VisibilityHistoryProductsRequestPeriod.d.ts +7 -0
  170. package/dist/api/resources/products/types/VisibilityHistoryProductsRequestPeriod.js +7 -0
  171. package/dist/api/resources/products/types/index.d.ts +24 -0
  172. package/dist/api/resources/products/types/index.js +24 -0
  173. package/dist/api/resources/reference/client/Client.d.ts +84 -0
  174. package/dist/api/resources/reference/client/Client.js +254 -0
  175. package/dist/api/resources/reference/client/index.d.ts +1 -0
  176. package/dist/api/resources/reference/client/index.js +1 -0
  177. package/dist/api/resources/reference/client/requests/BrandsReferenceRequest.d.ts +12 -0
  178. package/dist/api/resources/reference/client/requests/BrandsReferenceRequest.js +2 -0
  179. package/dist/api/resources/reference/client/requests/CategoriesReferenceRequest.d.ts +18 -0
  180. package/dist/api/resources/reference/client/requests/CategoriesReferenceRequest.js +2 -0
  181. package/dist/api/resources/reference/client/requests/CategoryReferenceRequest.d.ts +5 -0
  182. package/dist/api/resources/reference/client/requests/CategoryReferenceRequest.js +2 -0
  183. package/dist/api/resources/reference/client/requests/index.d.ts +3 -0
  184. package/dist/api/resources/reference/client/requests/index.js +1 -0
  185. package/dist/api/resources/reference/exports.d.ts +2 -0
  186. package/dist/api/resources/reference/exports.js +3 -0
  187. package/dist/api/resources/reference/index.d.ts +1 -0
  188. package/dist/api/resources/reference/index.js +1 -0
  189. package/dist/api/resources/store/client/Client.d.ts +82 -0
  190. package/dist/api/resources/store/client/Client.js +291 -0
  191. package/dist/api/resources/store/client/index.d.ts +1 -0
  192. package/dist/api/resources/store/client/index.js +1 -0
  193. package/dist/api/resources/store/client/requests/InventoryStoreRequest.d.ts +23 -0
  194. package/dist/api/resources/store/client/requests/InventoryStoreRequest.js +2 -0
  195. package/dist/api/resources/store/client/requests/OverviewStoreRequest.d.ts +13 -0
  196. package/dist/api/resources/store/client/requests/OverviewStoreRequest.js +2 -0
  197. package/dist/api/resources/store/client/requests/ProductsStoreRequest.d.ts +49 -0
  198. package/dist/api/resources/store/client/requests/ProductsStoreRequest.js +2 -0
  199. package/dist/api/resources/store/client/requests/index.d.ts +3 -0
  200. package/dist/api/resources/store/client/requests/index.js +1 -0
  201. package/dist/api/resources/store/exports.d.ts +2 -0
  202. package/dist/api/resources/store/exports.js +3 -0
  203. package/dist/api/resources/store/index.d.ts +2 -0
  204. package/dist/api/resources/store/index.js +2 -0
  205. package/dist/api/resources/store/types/InventoryStoreRequestStockState.d.ts +6 -0
  206. package/dist/api/resources/store/types/InventoryStoreRequestStockState.js +6 -0
  207. package/dist/api/resources/store/types/OverviewStoreRequestCountry.d.ts +6 -0
  208. package/dist/api/resources/store/types/OverviewStoreRequestCountry.js +6 -0
  209. package/dist/api/resources/store/types/ProductsStoreRequestCountry.d.ts +5 -0
  210. package/dist/api/resources/store/types/ProductsStoreRequestCountry.js +5 -0
  211. package/dist/api/resources/store/types/ProductsStoreRequestSort.d.ts +11 -0
  212. package/dist/api/resources/store/types/ProductsStoreRequestSort.js +11 -0
  213. package/dist/api/resources/store/types/index.d.ts +4 -0
  214. package/dist/api/resources/store/types/index.js +4 -0
  215. package/dist/api/resources/usage/client/Client.d.ts +32 -0
  216. package/dist/api/resources/usage/client/Client.js +73 -0
  217. package/dist/api/resources/usage/client/index.d.ts +1 -0
  218. package/dist/api/resources/usage/client/index.js +1 -0
  219. package/dist/api/resources/usage/exports.d.ts +2 -0
  220. package/dist/api/resources/usage/exports.js +3 -0
  221. package/dist/api/resources/usage/index.d.ts +1 -0
  222. package/dist/api/resources/usage/index.js +1 -0
  223. package/dist/api/types/AllowanceError.d.ts +26 -0
  224. package/dist/api/types/AllowanceError.js +16 -0
  225. package/dist/api/types/Brand.d.ts +4 -0
  226. package/dist/api/types/Brand.js +2 -0
  227. package/dist/api/types/BrandListResponse.d.ts +6 -0
  228. package/dist/api/types/BrandListResponse.js +2 -0
  229. package/dist/api/types/BundleUsage.d.ts +15 -0
  230. package/dist/api/types/BundleUsage.js +2 -0
  231. package/dist/api/types/Category.d.ts +14 -0
  232. package/dist/api/types/Category.js +2 -0
  233. package/dist/api/types/CategoryItem.d.ts +4 -0
  234. package/dist/api/types/CategoryItem.js +2 -0
  235. package/dist/api/types/CategoryListResponse.d.ts +5 -0
  236. package/dist/api/types/CategoryListResponse.js +2 -0
  237. package/dist/api/types/CategoryPathItem.d.ts +4 -0
  238. package/dist/api/types/CategoryPathItem.js +2 -0
  239. package/dist/api/types/CategoryRanking.d.ts +5 -0
  240. package/dist/api/types/CategoryRanking.js +2 -0
  241. package/dist/api/types/CategoryRankingsResponse.d.ts +7 -0
  242. package/dist/api/types/CategoryRankingsResponse.js +2 -0
  243. package/dist/api/types/CategoryResponse.d.ts +4 -0
  244. package/dist/api/types/CategoryResponse.js +2 -0
  245. package/dist/api/types/CommissionBracket.d.ts +8 -0
  246. package/dist/api/types/CommissionBracket.js +2 -0
  247. package/dist/api/types/CurrentPeriod.d.ts +8 -0
  248. package/dist/api/types/CurrentPeriod.js +2 -0
  249. package/dist/api/types/Dimensions.d.ts +8 -0
  250. package/dist/api/types/Dimensions.js +2 -0
  251. package/dist/api/types/DistributionBucket.d.ts +5 -0
  252. package/dist/api/types/DistributionBucket.js +2 -0
  253. package/dist/api/types/DistributionData.d.ts +7 -0
  254. package/dist/api/types/DistributionData.js +2 -0
  255. package/dist/api/types/FreeTierUsage.d.ts +12 -0
  256. package/dist/api/types/FreeTierUsage.js +2 -0
  257. package/dist/api/types/KeywordItem.d.ts +6 -0
  258. package/dist/api/types/KeywordItem.js +2 -0
  259. package/dist/api/types/KeywordMarkets.d.ts +5 -0
  260. package/dist/api/types/KeywordMarkets.js +2 -0
  261. package/dist/api/types/KeywordMetrics.d.ts +4 -0
  262. package/dist/api/types/KeywordMetrics.js +2 -0
  263. package/dist/api/types/KeywordRanking.d.ts +7 -0
  264. package/dist/api/types/KeywordRanking.js +2 -0
  265. package/dist/api/types/KeywordRankingsResponse.d.ts +7 -0
  266. package/dist/api/types/KeywordRankingsResponse.js +2 -0
  267. package/dist/api/types/KeywordResponse.d.ts +7 -0
  268. package/dist/api/types/KeywordResponse.js +2 -0
  269. package/dist/api/types/ListingChanges.d.ts +5 -0
  270. package/dist/api/types/ListingChanges.js +2 -0
  271. package/dist/api/types/NicheDetail.d.ts +12 -0
  272. package/dist/api/types/NicheDetail.js +2 -0
  273. package/dist/api/types/NicheDetailResponse.d.ts +6 -0
  274. package/dist/api/types/NicheDetailResponse.js +2 -0
  275. package/dist/api/types/NicheDistributionsResponse.d.ts +5 -0
  276. package/dist/api/types/NicheDistributionsResponse.js +2 -0
  277. package/dist/api/types/NicheHistoryData.d.ts +4 -0
  278. package/dist/api/types/NicheHistoryData.js +2 -0
  279. package/dist/api/types/NicheHistoryResponse.d.ts +7 -0
  280. package/dist/api/types/NicheHistoryResponse.js +2 -0
  281. package/dist/api/types/NicheItem.d.ts +11 -0
  282. package/dist/api/types/NicheItem.js +2 -0
  283. package/dist/api/types/NicheListResponse.d.ts +7 -0
  284. package/dist/api/types/NicheListResponse.js +2 -0
  285. package/dist/api/types/NicheMarkets.d.ts +5 -0
  286. package/dist/api/types/NicheMarkets.js +2 -0
  287. package/dist/api/types/NicheMetrics.d.ts +5 -0
  288. package/dist/api/types/NicheMetrics.js +2 -0
  289. package/dist/api/types/NichePeriod.d.ts +5 -0
  290. package/dist/api/types/NichePeriod.js +2 -0
  291. package/dist/api/types/OauthScope.d.ts +9 -0
  292. package/dist/api/types/OauthScope.js +9 -0
  293. package/dist/api/types/Organization.d.ts +4 -0
  294. package/dist/api/types/Organization.js +2 -0
  295. package/dist/api/types/Pagination.d.ts +6 -0
  296. package/dist/api/types/Pagination.js +2 -0
  297. package/dist/api/types/Period.d.ts +5 -0
  298. package/dist/api/types/Period.js +2 -0
  299. package/dist/api/types/PeriodRatings.d.ts +7 -0
  300. package/dist/api/types/PeriodRatings.js +2 -0
  301. package/dist/api/types/PeriodReviews.d.ts +9 -0
  302. package/dist/api/types/PeriodReviews.js +2 -0
  303. package/dist/api/types/ProductDetail.d.ts +29 -0
  304. package/dist/api/types/ProductDetail.js +2 -0
  305. package/dist/api/types/ProductDetailResponse.d.ts +24 -0
  306. package/dist/api/types/ProductDetailResponse.js +14 -0
  307. package/dist/api/types/ProductDistributions.d.ts +6 -0
  308. package/dist/api/types/ProductDistributions.js +2 -0
  309. package/dist/api/types/ProductItem.d.ts +27 -0
  310. package/dist/api/types/ProductItem.js +2 -0
  311. package/dist/api/types/ProductListResponse.d.ts +25 -0
  312. package/dist/api/types/ProductListResponse.js +14 -0
  313. package/dist/api/types/ProductMarketMetrics.d.ts +11 -0
  314. package/dist/api/types/ProductMarketMetrics.js +2 -0
  315. package/dist/api/types/ProductMarkets.d.ts +5 -0
  316. package/dist/api/types/ProductMarkets.js +2 -0
  317. package/dist/api/types/PublicApiError.d.ts +4 -0
  318. package/dist/api/types/PublicApiError.js +2 -0
  319. package/dist/api/types/RankMarkets.d.ts +4 -0
  320. package/dist/api/types/RankMarkets.js +2 -0
  321. package/dist/api/types/RankPoint.d.ts +5 -0
  322. package/dist/api/types/RankPoint.js +2 -0
  323. package/dist/api/types/RatingCount.d.ts +5 -0
  324. package/dist/api/types/RatingCount.js +2 -0
  325. package/dist/api/types/ResearchError.d.ts +6 -0
  326. package/dist/api/types/ResearchError.js +2 -0
  327. package/dist/api/types/ReviewHistoryPoint.d.ts +6 -0
  328. package/dist/api/types/ReviewHistoryPoint.js +2 -0
  329. package/dist/api/types/ReviewItem.d.ts +12 -0
  330. package/dist/api/types/ReviewItem.js +2 -0
  331. package/dist/api/types/ReviewListResponse.d.ts +7 -0
  332. package/dist/api/types/ReviewListResponse.js +2 -0
  333. package/dist/api/types/ReviewSummary.d.ts +10 -0
  334. package/dist/api/types/ReviewSummary.js +2 -0
  335. package/dist/api/types/ReviewSummaryResponse.d.ts +5 -0
  336. package/dist/api/types/ReviewSummaryResponse.js +2 -0
  337. package/dist/api/types/ReviewTopic.d.ts +4 -0
  338. package/dist/api/types/ReviewTopic.js +2 -0
  339. package/dist/api/types/SalesHistoryMarkets.d.ts +5 -0
  340. package/dist/api/types/SalesHistoryMarkets.js +2 -0
  341. package/dist/api/types/SalesHistoryMetrics.d.ts +5 -0
  342. package/dist/api/types/SalesHistoryMetrics.js +2 -0
  343. package/dist/api/types/SalesHistoryPoint.d.ts +5 -0
  344. package/dist/api/types/SalesHistoryPoint.js +2 -0
  345. package/dist/api/types/SalesHistoryResponse.d.ts +7 -0
  346. package/dist/api/types/SalesHistoryResponse.js +2 -0
  347. package/dist/api/types/SellerItem.d.ts +8 -0
  348. package/dist/api/types/SellerItem.js +2 -0
  349. package/dist/api/types/SellerMarkets.d.ts +5 -0
  350. package/dist/api/types/SellerMarkets.js +2 -0
  351. package/dist/api/types/SellerMetrics.d.ts +7 -0
  352. package/dist/api/types/SellerMetrics.js +2 -0
  353. package/dist/api/types/SellerResponse.d.ts +9 -0
  354. package/dist/api/types/SellerResponse.js +2 -0
  355. package/dist/api/types/SellerSummaryMarkets.d.ts +5 -0
  356. package/dist/api/types/SellerSummaryMarkets.js +2 -0
  357. package/dist/api/types/SellerSummaryMetrics.d.ts +6 -0
  358. package/dist/api/types/SellerSummaryMetrics.js +2 -0
  359. package/dist/api/types/StoreChange.d.ts +9 -0
  360. package/dist/api/types/StoreChange.js +2 -0
  361. package/dist/api/types/StoreError.d.ts +5 -0
  362. package/dist/api/types/StoreError.js +2 -0
  363. package/dist/api/types/StoreFilters.d.ts +3 -0
  364. package/dist/api/types/StoreFilters.js +2 -0
  365. package/dist/api/types/StoreInventoryCounts.d.ts +7 -0
  366. package/dist/api/types/StoreInventoryCounts.js +2 -0
  367. package/dist/api/types/StoreInventoryFilters.d.ts +4 -0
  368. package/dist/api/types/StoreInventoryFilters.js +2 -0
  369. package/dist/api/types/StoreInventoryPagination.d.ts +7 -0
  370. package/dist/api/types/StoreInventoryPagination.js +2 -0
  371. package/dist/api/types/StoreInventoryResponse.d.ts +28 -0
  372. package/dist/api/types/StoreInventoryResponse.js +14 -0
  373. package/dist/api/types/StoreInventoryRow.d.ts +35 -0
  374. package/dist/api/types/StoreInventoryRow.js +18 -0
  375. package/dist/api/types/StoreKpi.d.ts +12 -0
  376. package/dist/api/types/StoreKpi.js +2 -0
  377. package/dist/api/types/StoreOverviewResponse.d.ts +13 -0
  378. package/dist/api/types/StoreOverviewResponse.js +2 -0
  379. package/dist/api/types/StorePerformanceProductPerformanceItem.d.ts +48 -0
  380. package/dist/api/types/StorePerformanceProductPerformanceItem.js +2 -0
  381. package/dist/api/types/StorePerformanceReturnCostsBreakdown.d.ts +10 -0
  382. package/dist/api/types/StorePerformanceReturnCostsBreakdown.js +2 -0
  383. package/dist/api/types/StorePerformanceSalesCostsBreakdown.d.ts +10 -0
  384. package/dist/api/types/StorePerformanceSalesCostsBreakdown.js +2 -0
  385. package/dist/api/types/StorePreviousKpi.d.ts +9 -0
  386. package/dist/api/types/StorePreviousKpi.js +2 -0
  387. package/dist/api/types/StoreProductsFilters.d.ts +5 -0
  388. package/dist/api/types/StoreProductsFilters.js +2 -0
  389. package/dist/api/types/StoreProductsPagination.d.ts +9 -0
  390. package/dist/api/types/StoreProductsPagination.js +2 -0
  391. package/dist/api/types/StoreProductsResponse.d.ts +11 -0
  392. package/dist/api/types/StoreProductsResponse.js +2 -0
  393. package/dist/api/types/UnauthorizedErrorBody.d.ts +3 -0
  394. package/dist/api/types/UnauthorizedErrorBody.js +2 -0
  395. package/dist/api/types/Usage.d.ts +51 -0
  396. package/dist/api/types/Usage.js +28 -0
  397. package/dist/api/types/UsageOrganization.d.ts +4 -0
  398. package/dist/api/types/UsageOrganization.js +2 -0
  399. package/dist/api/types/VisibilityHistoryResponse.d.ts +7 -0
  400. package/dist/api/types/VisibilityHistoryResponse.js +2 -0
  401. package/dist/api/types/VisibilityMarkets.d.ts +5 -0
  402. package/dist/api/types/VisibilityMarkets.js +2 -0
  403. package/dist/api/types/VisibilityMetrics.d.ts +4 -0
  404. package/dist/api/types/VisibilityMetrics.js +2 -0
  405. package/dist/api/types/VisibilityPoint.d.ts +5 -0
  406. package/dist/api/types/VisibilityPoint.js +2 -0
  407. package/dist/api/types/index.d.ts +92 -0
  408. package/dist/api/types/index.js +92 -0
  409. package/dist/auth/BearerAuthProvider.d.ts +20 -0
  410. package/dist/auth/BearerAuthProvider.js +32 -0
  411. package/dist/auth/index.d.ts +1 -0
  412. package/dist/auth/index.js +1 -0
  413. package/dist/core/auth/AuthProvider.d.ts +8 -0
  414. package/dist/core/auth/AuthProvider.js +6 -0
  415. package/dist/core/auth/AuthRequest.d.ts +9 -0
  416. package/dist/core/auth/AuthRequest.js +1 -0
  417. package/dist/core/auth/BasicAuth.d.ts +8 -0
  418. package/dist/core/auth/BasicAuth.js +29 -0
  419. package/dist/core/auth/BearerToken.d.ts +7 -0
  420. package/dist/core/auth/BearerToken.js +13 -0
  421. package/dist/core/auth/NoOpAuthProvider.d.ts +5 -0
  422. package/dist/core/auth/NoOpAuthProvider.js +5 -0
  423. package/dist/core/auth/index.d.ts +5 -0
  424. package/dist/core/auth/index.js +4 -0
  425. package/dist/core/base64.d.ts +2 -0
  426. package/dist/core/base64.js +22 -0
  427. package/dist/core/exports.d.ts +2 -0
  428. package/dist/core/exports.js +2 -0
  429. package/dist/core/fetcher/APIResponse.d.ts +20 -0
  430. package/dist/core/fetcher/APIResponse.js +1 -0
  431. package/dist/core/fetcher/BinaryResponse.d.ts +19 -0
  432. package/dist/core/fetcher/BinaryResponse.js +14 -0
  433. package/dist/core/fetcher/EndpointMetadata.d.ts +13 -0
  434. package/dist/core/fetcher/EndpointMetadata.js +1 -0
  435. package/dist/core/fetcher/EndpointSupplier.d.ts +12 -0
  436. package/dist/core/fetcher/EndpointSupplier.js +10 -0
  437. package/dist/core/fetcher/Fetcher.d.ts +56 -0
  438. package/dist/core/fetcher/Fetcher.js +254 -0
  439. package/dist/core/fetcher/Headers.d.ts +2 -0
  440. package/dist/core/fetcher/Headers.js +83 -0
  441. package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
  442. package/dist/core/fetcher/HttpResponsePromise.js +90 -0
  443. package/dist/core/fetcher/RawResponse.d.ts +29 -0
  444. package/dist/core/fetcher/RawResponse.js +40 -0
  445. package/dist/core/fetcher/Supplier.d.ts +4 -0
  446. package/dist/core/fetcher/Supplier.js +10 -0
  447. package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
  448. package/dist/core/fetcher/createRequestUrl.js +5 -0
  449. package/dist/core/fetcher/getErrorResponseBody.d.ts +1 -0
  450. package/dist/core/fetcher/getErrorResponseBody.js +43 -0
  451. package/dist/core/fetcher/getFetchFn.d.ts +1 -0
  452. package/dist/core/fetcher/getFetchFn.js +3 -0
  453. package/dist/core/fetcher/getHeader.d.ts +1 -0
  454. package/dist/core/fetcher/getHeader.js +8 -0
  455. package/dist/core/fetcher/getRequestBody.d.ts +7 -0
  456. package/dist/core/fetcher/getRequestBody.js +13 -0
  457. package/dist/core/fetcher/getResponseBody.d.ts +17 -0
  458. package/dist/core/fetcher/getResponseBody.js +70 -0
  459. package/dist/core/fetcher/index.d.ts +13 -0
  460. package/dist/core/fetcher/index.js +7 -0
  461. package/dist/core/fetcher/makePassthroughRequest.d.ts +49 -0
  462. package/dist/core/fetcher/makePassthroughRequest.js +157 -0
  463. package/dist/core/fetcher/makeRequest.d.ts +11 -0
  464. package/dist/core/fetcher/makeRequest.js +85 -0
  465. package/dist/core/fetcher/redactUrl.d.ts +2 -0
  466. package/dist/core/fetcher/redactUrl.js +84 -0
  467. package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
  468. package/dist/core/fetcher/requestWithRetries.js +77 -0
  469. package/dist/core/fetcher/signals.d.ts +6 -0
  470. package/dist/core/fetcher/signals.js +28 -0
  471. package/dist/core/headers.d.ts +2 -0
  472. package/dist/core/headers.js +27 -0
  473. package/dist/core/index.d.ts +8 -0
  474. package/dist/core/index.js +8 -0
  475. package/dist/core/json.d.ts +15 -0
  476. package/dist/core/json.js +19 -0
  477. package/dist/core/logging/exports.d.ts +18 -0
  478. package/dist/core/logging/exports.js +9 -0
  479. package/dist/core/logging/index.d.ts +1 -0
  480. package/dist/core/logging/index.js +1 -0
  481. package/dist/core/logging/logger.d.ts +126 -0
  482. package/dist/core/logging/logger.js +140 -0
  483. package/dist/core/pagination/Page.d.ts +33 -0
  484. package/dist/core/pagination/Page.js +55 -0
  485. package/dist/core/pagination/exports.d.ts +1 -0
  486. package/dist/core/pagination/exports.js +1 -0
  487. package/dist/core/pagination/index.d.ts +1 -0
  488. package/dist/core/pagination/index.js +1 -0
  489. package/dist/core/requestBody.d.ts +12 -0
  490. package/dist/core/requestBody.js +23 -0
  491. package/dist/core/runtime/index.d.ts +1 -0
  492. package/dist/core/runtime/index.js +1 -0
  493. package/dist/core/runtime/runtime.d.ts +28 -0
  494. package/dist/core/runtime/runtime.js +171 -0
  495. package/dist/core/url/QueryStringBuilder.d.ts +47 -0
  496. package/dist/core/url/QueryStringBuilder.js +78 -0
  497. package/dist/core/url/encodePathParam.d.ts +3 -0
  498. package/dist/core/url/encodePathParam.js +24 -0
  499. package/dist/core/url/index.d.ts +4 -0
  500. package/dist/core/url/index.js +4 -0
  501. package/dist/core/url/join.d.ts +1 -0
  502. package/dist/core/url/join.js +65 -0
  503. package/dist/core/url/qs.d.ts +7 -0
  504. package/dist/core/url/qs.js +76 -0
  505. package/dist/core/utils/index.d.ts +1 -0
  506. package/dist/core/utils/index.js +1 -0
  507. package/dist/core/utils/setObjectProperty.d.ts +12 -0
  508. package/dist/core/utils/setObjectProperty.js +45 -0
  509. package/dist/environments.d.ts +4 -0
  510. package/dist/environments.js +4 -0
  511. package/dist/errors/MarktMentorError.d.ts +15 -0
  512. package/dist/errors/MarktMentorError.js +52 -0
  513. package/dist/errors/MarktMentorTimeoutError.d.ts +6 -0
  514. package/dist/errors/MarktMentorTimeoutError.js +15 -0
  515. package/dist/errors/handleNonStatusCodeError.d.ts +2 -0
  516. package/dist/errors/handleNonStatusCodeError.js +32 -0
  517. package/dist/errors/index.d.ts +2 -0
  518. package/dist/errors/index.js +2 -0
  519. package/dist/exports.d.ts +1 -0
  520. package/dist/exports.js +1 -0
  521. package/dist/index.d.ts +6 -0
  522. package/dist/index.js +5 -0
  523. package/package.json +33 -4
@@ -0,0 +1,73 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
3
+ import { mergeHeaders } from "../../../../core/headers.js";
4
+ import * as core from "../../../../core/index.js";
5
+ import * as environments from "../../../../environments.js";
6
+ import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
7
+ import * as errors from "../../../../errors/index.js";
8
+ import * as MarktMentor from "../../../index.js";
9
+ export class UsageClient {
10
+ _options;
11
+ constructor(options) {
12
+ this._options = normalizeClientOptionsWithAuth(options);
13
+ }
14
+ /**
15
+ * Get the research requests of the organization in the current period: what the API bundle includes, what is used and what is left, or the state of the free monthly allowance. Use it to stop before the limit.
16
+ *
17
+ * This request is free: it does not count as a research request.
18
+ *
19
+ * @param {UsageClient.RequestOptions} requestOptions - Request-specific configuration.
20
+ *
21
+ * @throws {@link MarktMentor.UnauthorizedError}
22
+ * @throws {@link MarktMentor.ForbiddenError}
23
+ * @throws {@link MarktMentor.TooManyRequestsError}
24
+ * @throws {@link MarktMentor.ServiceUnavailableError}
25
+ * @throws {@link errors.MarktMentorError}
26
+ * @throws {@link errors.MarktMentorTimeoutError}
27
+ *
28
+ * @example
29
+ * await client.usage.get()
30
+ */
31
+ get(requestOptions) {
32
+ return core.HttpResponsePromise.fromPromise(this.__get(requestOptions));
33
+ }
34
+ async __get(requestOptions) {
35
+ const _authRequest = await this._options.authProvider.getAuthRequest();
36
+ const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
37
+ const _response = await core.fetcher({
38
+ url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
39
+ (await core.Supplier.get(this._options.environment)) ??
40
+ environments.MarktMentorEnvironment.Production, "api/public/v1/usage/"),
41
+ method: "GET",
42
+ headers: _headers,
43
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions?.queryParams).build(),
44
+ timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
45
+ maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
46
+ abortSignal: requestOptions?.abortSignal,
47
+ fetchFn: this._options?.fetch,
48
+ logging: this._options.logging,
49
+ });
50
+ if (_response.ok) {
51
+ return { data: _response.body, rawResponse: _response.rawResponse };
52
+ }
53
+ if (_response.error.reason === "status-code") {
54
+ switch (_response.error.statusCode) {
55
+ case 401:
56
+ throw new MarktMentor.UnauthorizedError(_response.error.body, _response.rawResponse);
57
+ case 403:
58
+ throw new MarktMentor.ForbiddenError(_response.error.body, _response.rawResponse);
59
+ case 429:
60
+ throw new MarktMentor.TooManyRequestsError(_response.error.body, _response.rawResponse);
61
+ case 503:
62
+ throw new MarktMentor.ServiceUnavailableError(_response.error.body, _response.rawResponse);
63
+ default:
64
+ throw new errors.MarktMentorError({
65
+ statusCode: _response.error.statusCode,
66
+ body: _response.error.body,
67
+ rawResponse: _response.rawResponse,
68
+ });
69
+ }
70
+ }
71
+ return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/api/public/v1/usage/");
72
+ }
73
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,2 @@
1
+ export { UsageClient } from "./client/Client.js";
2
+ export * from "./client/index.js";
@@ -0,0 +1,3 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export { UsageClient } from "./client/Client.js";
3
+ export * from "./client/index.js";
@@ -0,0 +1 @@
1
+ export * from "./client/index.js";
@@ -0,0 +1 @@
1
+ export * from "./client/index.js";
@@ -0,0 +1,26 @@
1
+ export interface AllowanceError {
2
+ /**
3
+ * Which allowance is used up. See the description of HTTP 402.
4
+ *
5
+ * * `bundle_exhausted` - bundle_exhausted
6
+ * * `overage_limit_reached` - overage_limit_reached
7
+ * * `free_quota_exhausted` - free_quota_exhausted
8
+ */
9
+ code: AllowanceError.Code;
10
+ detail: string;
11
+ }
12
+ export declare namespace AllowanceError {
13
+ /**
14
+ * Which allowance is used up. See the description of HTTP 402.
15
+ *
16
+ * * `bundle_exhausted` - bundle_exhausted
17
+ * * `overage_limit_reached` - overage_limit_reached
18
+ * * `free_quota_exhausted` - free_quota_exhausted
19
+ */
20
+ const Code: {
21
+ readonly BundleExhausted: "bundle_exhausted";
22
+ readonly OverageLimitReached: "overage_limit_reached";
23
+ readonly FreeQuotaExhausted: "free_quota_exhausted";
24
+ };
25
+ type Code = (typeof Code)[keyof typeof Code];
26
+ }
@@ -0,0 +1,16 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var AllowanceError;
3
+ (function (AllowanceError) {
4
+ /**
5
+ * Which allowance is used up. See the description of HTTP 402.
6
+ *
7
+ * * `bundle_exhausted` - bundle_exhausted
8
+ * * `overage_limit_reached` - overage_limit_reached
9
+ * * `free_quota_exhausted` - free_quota_exhausted
10
+ */
11
+ AllowanceError.Code = {
12
+ BundleExhausted: "bundle_exhausted",
13
+ OverageLimitReached: "overage_limit_reached",
14
+ FreeQuotaExhausted: "free_quota_exhausted",
15
+ };
16
+ })(AllowanceError || (AllowanceError = {}));
@@ -0,0 +1,4 @@
1
+ export interface Brand {
2
+ /** The brand name as we store it. Send exactly this text as `brand` in a product search. */
3
+ name: string;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,6 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface BrandListResponse {
3
+ /** True when more brands match than `limit`. Make the search longer. */
4
+ hasMore: boolean;
5
+ data: MarktMentor.Brand[];
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,15 @@
1
+ export interface BundleUsage {
2
+ /** Requests included in the current billing period. */
3
+ includedRequests: number;
4
+ /** Successful research requests charged in this period. */
5
+ usedRequests: number;
6
+ /** Included requests left in this period. */
7
+ remainingRequests: number;
8
+ /** Requests above the included amount, billed at €0.05 each. */
9
+ additionalRequests: number;
10
+ /** Most the organization pays for requests above the bundle in one billing period, in euro cents. 0 (the default): requests stop when the bundle is used up and return 402 `bundle_exhausted`. Above 0: extra requests are allowed up to this amount, then return 402 `overage_limit_reached`. */
11
+ additionalRequestsLimitAmount: number;
12
+ periodStart: string;
13
+ /** The included requests reset at this time. */
14
+ periodEnd: string;
15
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,14 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface Category {
3
+ /** The bol category identifier. Use it as `categoryId` in the product, niche and store filters. */
4
+ categoryId: number;
5
+ name: string;
6
+ /** Depth in the tree. Level 1 is the top of the tree. */
7
+ level: number;
8
+ /** The category directly above. Null for a level 1 category. */
9
+ parentId: number | null;
10
+ /** From the level 1 category down to this category, itself included. */
11
+ path: MarktMentor.CategoryPathItem[];
12
+ /** Number of categories directly below. 0: this is a leaf. */
13
+ childCount: number;
14
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,4 @@
1
+ export interface CategoryItem {
2
+ categoryId: number;
3
+ name: string | null;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface CategoryListResponse {
3
+ pagination: MarktMentor.Pagination;
4
+ data: MarktMentor.Category[];
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,4 @@
1
+ export interface CategoryPathItem {
2
+ categoryId: number;
3
+ name: string;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface CategoryRanking {
3
+ categoryId: number;
4
+ history: MarktMentor.RankPoint[];
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface CategoryRankingsResponse {
3
+ market: string;
4
+ period: string;
5
+ interval: string;
6
+ data: MarktMentor.CategoryRanking[];
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,4 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface CategoryResponse {
3
+ data: MarktMentor.Category;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ export interface CommissionBracket {
2
+ /** Applies to sale prices below this amount. Null for the top bracket. */
3
+ priceBelow: number | null;
4
+ /** Fixed fee in euros. */
5
+ fixed: number | null;
6
+ /** Percentage of the sale price. */
7
+ percentage: number | null;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ export interface CurrentPeriod {
2
+ startDate: string;
3
+ endDate: string;
4
+ days: number;
5
+ requestedDays: number;
6
+ daysCapped: boolean;
7
+ maxDays: number;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,8 @@
1
+ export interface Dimensions {
2
+ lengthCm: number | null;
3
+ widthCm: number | null;
4
+ heightCm: number | null;
5
+ weightGrams: number | null;
6
+ /** bol shipping package type, such as Pakket M. */
7
+ packageType: string | null;
8
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ export interface DistributionBucket {
2
+ fromValue: number | null;
3
+ toValue: number | null;
4
+ productCount: number;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface DistributionData {
3
+ /** Preferred products (no duplicate variants) in the product snapshot of the requested period that match the niche's EANs, including variant EANs. Not restricted to products with sales. It can be much lower than the productCount of Get a niche (example niche 6797: 25,956 in the niche data and 2,934 here). */
4
+ productCount: number;
5
+ /** Distributions over the total of both markets (NL and BE together). Price is the price of the period, else the current price. Null when there are no EANs. */
6
+ total: MarktMentor.ProductDistributions | null;
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,12 @@
1
+ export interface FreeTierUsage {
2
+ /** True when the organization has an active paid MarktMentor Premium subscription. */
3
+ eligible: boolean;
4
+ /** Free research requests per month. */
5
+ limit: number;
6
+ used: number;
7
+ remaining: number;
8
+ /** Maximum results per page on free requests. */
9
+ pageSize: number;
10
+ /** Start of the next calendar month (UTC). */
11
+ resetsAt: string;
12
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,6 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface KeywordItem {
3
+ keywordId: string;
4
+ keyword: string | null;
5
+ markets: MarktMentor.KeywordMarkets;
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface KeywordMarkets {
3
+ NL?: MarktMentor.KeywordMetrics | undefined;
4
+ BE?: MarktMentor.KeywordMetrics | undefined;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,4 @@
1
+ export interface KeywordMetrics {
2
+ searchVolume: number | null;
3
+ position: number | null;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface KeywordRanking {
3
+ keywordId: string;
4
+ /** Null when the product has no position on the term in the keywords endpoint. */
5
+ keyword: string | null;
6
+ history: MarktMentor.RankPoint[];
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface KeywordRankingsResponse {
3
+ market: string;
4
+ period: string;
5
+ interval: string;
6
+ data: MarktMentor.KeywordRanking[];
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface KeywordResponse {
3
+ market: string;
4
+ period: string;
5
+ pagination: MarktMentor.Pagination;
6
+ data: MarktMentor.KeywordItem[];
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ export interface ListingChanges {
2
+ mainImage: number | null;
3
+ title: number | null;
4
+ description: number | null;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,12 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface NicheDetail {
3
+ nicheId: string;
4
+ name: string;
5
+ productCount: number | null;
6
+ /** Score from 0 to 10. Not a percentage. */
7
+ qualityScore: number | null;
8
+ /** Score from 0 to 10. Not a percentage. */
9
+ competitionScore: number | null;
10
+ markets: MarktMentor.NicheMarkets;
11
+ periods?: MarktMentor.NichePeriod[] | undefined;
12
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,6 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface NicheDetailResponse {
3
+ market: string;
4
+ period: string;
5
+ data: MarktMentor.NicheDetail;
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface NicheDistributionsResponse {
3
+ period: string;
4
+ data: MarktMentor.DistributionData;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,4 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface NicheHistoryData {
3
+ reviews: MarktMentor.ReviewHistoryPoint[];
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface NicheHistoryResponse {
3
+ market: string;
4
+ period: string;
5
+ interval: string;
6
+ data: MarktMentor.NicheHistoryData;
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,11 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface NicheItem {
3
+ nicheId: string;
4
+ name: string;
5
+ productCount: number | null;
6
+ /** Score from 0 to 10. Not a percentage. */
7
+ qualityScore: number | null;
8
+ /** Score from 0 to 10. Not a percentage. */
9
+ competitionScore: number | null;
10
+ markets: MarktMentor.NicheMarkets;
11
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,7 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface NicheListResponse {
3
+ market: string;
4
+ period: string;
5
+ pagination: MarktMentor.Pagination;
6
+ data: MarktMentor.NicheItem[];
7
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface NicheMarkets {
3
+ NL?: MarktMentor.NicheMetrics | undefined;
4
+ BE?: MarktMentor.NicheMetrics | undefined;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ export interface NicheMetrics {
2
+ searchVolume: number | null;
3
+ sales: number | null;
4
+ revenue: number | null;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface NichePeriod {
3
+ period: string;
4
+ markets: MarktMentor.NicheMarkets;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ export declare const OauthScope: {
2
+ /**
3
+ * Read organization store data */
4
+ readonly StoreRead: "store:read";
5
+ /**
6
+ * Read Product Research data */
7
+ readonly ResearchRead: "research:read";
8
+ };
9
+ export type OauthScope = (typeof OauthScope)[keyof typeof OauthScope];
@@ -0,0 +1,9 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export const OauthScope = {
3
+ /**
4
+ * Read organization store data */
5
+ StoreRead: "store:read",
6
+ /**
7
+ * Read Product Research data */
8
+ ResearchRead: "research:read",
9
+ };
@@ -0,0 +1,4 @@
1
+ export interface Organization {
2
+ id: number;
3
+ name: string;
4
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,6 @@
1
+ export interface Pagination {
2
+ page: number;
3
+ pageSize: number;
4
+ total: number;
5
+ hasNext: boolean;
6
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,5 @@
1
+ export interface Period {
2
+ startDate: string;
3
+ endDate: string;
4
+ days: number;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};