@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,18 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var StoreInventoryRow;
3
+ (function (StoreInventoryRow) {
4
+ /**
5
+ * unknown is not zero: see unknownReason.
6
+ *
7
+ * * `out_of_stock` - out_of_stock
8
+ * * `low` - low
9
+ * * `ok` - ok
10
+ * * `unknown` - unknown
11
+ */
12
+ StoreInventoryRow.StockState = {
13
+ OutOfStock: "out_of_stock",
14
+ Low: "low",
15
+ Ok: "ok",
16
+ Unknown: "unknown",
17
+ };
18
+ })(StoreInventoryRow || (StoreInventoryRow = {}));
@@ -0,0 +1,12 @@
1
+ export interface StoreKpi {
2
+ revenue: number | null;
3
+ netRevenue: number | null;
4
+ costs: number | null;
5
+ profit: number | null;
6
+ orders: number | null;
7
+ sales: number | null;
8
+ returns: number | null;
9
+ adCosts?: (number | null) | undefined;
10
+ /** Advertising cost divided by the revenue of the whole store. Percentage: 9.0 is 9%. */
11
+ storeTacos?: (number | null) | undefined;
12
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,13 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface StoreOverviewResponse {
3
+ period: MarktMentor.CurrentPeriod;
4
+ previousPeriod: MarktMentor.Period;
5
+ filters: MarktMentor.StoreFilters;
6
+ kpis: MarktMentor.StoreKpi;
7
+ previous: MarktMentor.StorePreviousKpi;
8
+ /** The value of this period minus the value of the previous period. */
9
+ change: MarktMentor.StoreChange;
10
+ /** Each value is the change divided by the previous value. Percentage: 20.0 is +20%. A value is null when the previous value is zero or negative (a loss): a percentage of such a value has no meaning. Use change then. */
11
+ changePct: MarktMentor.StoreChange;
12
+ asOf: string;
13
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,48 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface StorePerformanceProductPerformanceItem {
3
+ title?: (string | null) | undefined;
4
+ ean: string;
5
+ inSelectedStore?: boolean | undefined;
6
+ image?: (string | null) | undefined;
7
+ /** Average review rating, in stars from 1 to 5. 0 without reviews. */
8
+ reviewScore?: (number | null) | undefined;
9
+ reviewCount?: (number | null) | undefined;
10
+ productLink?: (string | null) | undefined;
11
+ productCode?: (string | null) | undefined;
12
+ sales?: number | undefined;
13
+ orders?: number | undefined;
14
+ revenue?: number | undefined;
15
+ netRevenue?: number | undefined;
16
+ commission?: number | undefined;
17
+ totalCosts?: number | undefined;
18
+ salesCosts?: number | undefined;
19
+ salesCostsBreakdown?: MarktMentor.StorePerformanceSalesCostsBreakdown | undefined;
20
+ salesProfits?: number | undefined;
21
+ /** Profit on sales divided by the revenue. Percentage: 25.0 is 25%. */
22
+ salesProfitMargin?: number | undefined;
23
+ /** Profit on sales divided by the sales costs. Percentage: 25.0 is 25%; it can be above 100. */
24
+ salesRoi?: number | undefined;
25
+ returns?: number | undefined;
26
+ returnCosts?: number | undefined;
27
+ returnCostsBreakdown?: MarktMentor.StorePerformanceReturnCostsBreakdown | undefined;
28
+ totalProfits?: number | undefined;
29
+ /** Total profit (after returns, advertising and storage) divided by the net revenue. Percentage: 25.0 is 25%. For a row without returns, advertising and storage costs the divisor can be the revenue. */
30
+ totalMargin?: number | undefined;
31
+ /** Total profit divided by the total costs. Percentage: 25.0 is 25%; it can be above 100. */
32
+ totalRoi?: number | undefined;
33
+ clicks?: number | undefined;
34
+ /** Orders divided by the visits (clicks). Percentage: 5.0 is 5%. */
35
+ conversion?: number | undefined;
36
+ /** Conversion of the product group. Percentage: 6.4 is 6.4%, the same unit as conversion. Null when there is no benchmark. */
37
+ conversionBenchmark?: (number | null) | undefined;
38
+ adCost?: number | undefined;
39
+ /** Advertising cost divided by the advertising revenue. Percentage: 8.0 is 8%; it can be above 100. The advertising cost of today is left out, because there is no advertising revenue for today yet; adCost includes today. 0 without advertising revenue. */
40
+ acos?: number | undefined;
41
+ /** Advertising cost divided by the total revenue. Percentage: 4.0 is 4%. */
42
+ tacos?: number | undefined;
43
+ isActive?: boolean | undefined;
44
+ storageCosts?: number | undefined;
45
+ gradedStorageCosts?: number | undefined;
46
+ /** False when no purchase price is known for the EAN, or when costs are hidden. The profit is then the revenue minus bol costs only. */
47
+ hasProductCosts: boolean;
48
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,10 @@
1
+ export interface StorePerformanceReturnCostsBreakdown {
2
+ otherReturnCosts: number;
3
+ returnLabelCost: number;
4
+ productLostLeniency: number;
5
+ otherCompensation: number;
6
+ commissionCorrection: number;
7
+ revenueCorrection: number;
8
+ shipAdditionalProducts: number;
9
+ productsBackInStockCorrection: number;
10
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,10 @@
1
+ export interface StorePerformanceSalesCostsBreakdown {
2
+ shippingCosts: number;
3
+ surcharge: number;
4
+ productCosts: number;
5
+ surchargeRefunds: number;
6
+ shippingLabelRefunds: number;
7
+ commission: number;
8
+ commissionCorrection: number;
9
+ compensation: number;
10
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,9 @@
1
+ export interface StorePreviousKpi {
2
+ revenue: number | null;
3
+ netRevenue: number | null;
4
+ costs: number | null;
5
+ profit: number | null;
6
+ orders: number | null;
7
+ sales: number | null;
8
+ returns: number | null;
9
+ }
@@ -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 StoreProductsFilters {
2
+ country: string | null;
3
+ eans: string[] | null;
4
+ categoryId: number | null;
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 interface StoreProductsPagination {
2
+ page: number;
3
+ pageSize: number;
4
+ /** Number of selected products with orders in the period. This is not the size of the catalog. null: the page is empty and it is not the first page, thus the total is unknown. */
5
+ total: number | null;
6
+ hasNext: boolean;
7
+ /** True when the total is unknown or is 1,000 or more. The source selects at most 1,000 EANs: the selection can then be incomplete. Use the EAN or category filter to make it smaller. */
8
+ totalMayBeCapped: boolean;
9
+ }
@@ -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 StoreProductsResponse {
3
+ period: MarktMentor.Period;
4
+ filters: MarktMentor.StoreProductsFilters;
5
+ /** Products with orders in the period, not the full catalog and not a ranking of the most profitable products. */
6
+ data: MarktMentor.StorePerformanceProductPerformanceItem[];
7
+ pagination: MarktMentor.StoreProductsPagination;
8
+ /** False when product and shipping costs are hidden for this store. The profit is then before those costs. */
9
+ costsVisible: boolean;
10
+ asOf: string;
11
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,3 @@
1
+ export interface UnauthorizedErrorBody {
2
+ detail: string;
3
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,51 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface Usage {
3
+ organization: MarktMentor.UsageOrganization;
4
+ /**
5
+ * oauth for a portal or app connection, key for an API key.
6
+ *
7
+ * * `oauth` - oauth
8
+ * * `key` - key
9
+ */
10
+ credential: Usage.Credential;
11
+ /**
12
+ * bundle: requests count toward the API bundle. unmetered: a grant without a request limit. free: the free monthly allowance. none: research requests are not available.
13
+ *
14
+ * * `bundle` - bundle
15
+ * * `unmetered` - unmetered
16
+ * * `free` - free
17
+ * * `none` - none
18
+ */
19
+ plan: Usage.Plan;
20
+ bundle: MarktMentor.BundleUsage | null;
21
+ /** The free monthly allowance of the organization, shared by its API keys and portal connections. Absent when the plan does not allow it. */
22
+ freeTier: MarktMentor.FreeTierUsage | null;
23
+ }
24
+ export declare namespace Usage {
25
+ /**
26
+ * oauth for a portal or app connection, key for an API key.
27
+ *
28
+ * * `oauth` - oauth
29
+ * * `key` - key
30
+ */
31
+ const Credential: {
32
+ readonly Oauth: "oauth";
33
+ readonly Key: "key";
34
+ };
35
+ type Credential = (typeof Credential)[keyof typeof Credential];
36
+ /**
37
+ * bundle: requests count toward the API bundle. unmetered: a grant without a request limit. free: the free monthly allowance. none: research requests are not available.
38
+ *
39
+ * * `bundle` - bundle
40
+ * * `unmetered` - unmetered
41
+ * * `free` - free
42
+ * * `none` - none
43
+ */
44
+ const Plan: {
45
+ readonly Bundle: "bundle";
46
+ readonly Unmetered: "unmetered";
47
+ readonly Free: "free";
48
+ readonly None: "none";
49
+ };
50
+ type Plan = (typeof Plan)[keyof typeof Plan];
51
+ }
@@ -0,0 +1,28 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export var Usage;
3
+ (function (Usage) {
4
+ /**
5
+ * oauth for a portal or app connection, key for an API key.
6
+ *
7
+ * * `oauth` - oauth
8
+ * * `key` - key
9
+ */
10
+ Usage.Credential = {
11
+ Oauth: "oauth",
12
+ Key: "key",
13
+ };
14
+ /**
15
+ * bundle: requests count toward the API bundle. unmetered: a grant without a request limit. free: the free monthly allowance. none: research requests are not available.
16
+ *
17
+ * * `bundle` - bundle
18
+ * * `unmetered` - unmetered
19
+ * * `free` - free
20
+ * * `none` - none
21
+ */
22
+ Usage.Plan = {
23
+ Bundle: "bundle",
24
+ Unmetered: "unmetered",
25
+ Free: "free",
26
+ None: "none",
27
+ };
28
+ })(Usage || (Usage = {}));
@@ -0,0 +1,4 @@
1
+ export interface UsageOrganization {
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,7 @@
1
+ import type * as MarktMentor from "../index.js";
2
+ export interface VisibilityHistoryResponse {
3
+ market: string;
4
+ period: string;
5
+ interval: string;
6
+ data: MarktMentor.VisibilityPoint[];
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 VisibilityMarkets {
3
+ NL?: MarktMentor.VisibilityMetrics | undefined;
4
+ BE?: MarktMentor.VisibilityMetrics | 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 VisibilityMetrics {
2
+ categoryImpressions: number | null;
3
+ keywordImpressions: number | 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 VisibilityPoint {
3
+ date: string;
4
+ markets: MarktMentor.VisibilityMarkets;
5
+ }
@@ -0,0 +1,2 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ export {};
@@ -0,0 +1,92 @@
1
+ export * from "./AllowanceError.js";
2
+ export * from "./Brand.js";
3
+ export * from "./BrandListResponse.js";
4
+ export * from "./BundleUsage.js";
5
+ export * from "./Category.js";
6
+ export * from "./CategoryItem.js";
7
+ export * from "./CategoryListResponse.js";
8
+ export * from "./CategoryPathItem.js";
9
+ export * from "./CategoryRanking.js";
10
+ export * from "./CategoryRankingsResponse.js";
11
+ export * from "./CategoryResponse.js";
12
+ export * from "./CommissionBracket.js";
13
+ export * from "./CurrentPeriod.js";
14
+ export * from "./Dimensions.js";
15
+ export * from "./DistributionBucket.js";
16
+ export * from "./DistributionData.js";
17
+ export * from "./FreeTierUsage.js";
18
+ export * from "./KeywordItem.js";
19
+ export * from "./KeywordMarkets.js";
20
+ export * from "./KeywordMetrics.js";
21
+ export * from "./KeywordRanking.js";
22
+ export * from "./KeywordRankingsResponse.js";
23
+ export * from "./KeywordResponse.js";
24
+ export * from "./ListingChanges.js";
25
+ export * from "./NicheDetail.js";
26
+ export * from "./NicheDetailResponse.js";
27
+ export * from "./NicheDistributionsResponse.js";
28
+ export * from "./NicheHistoryData.js";
29
+ export * from "./NicheHistoryResponse.js";
30
+ export * from "./NicheItem.js";
31
+ export * from "./NicheListResponse.js";
32
+ export * from "./NicheMarkets.js";
33
+ export * from "./NicheMetrics.js";
34
+ export * from "./NichePeriod.js";
35
+ export * from "./OauthScope.js";
36
+ export * from "./Organization.js";
37
+ export * from "./Pagination.js";
38
+ export * from "./Period.js";
39
+ export * from "./PeriodRatings.js";
40
+ export * from "./PeriodReviews.js";
41
+ export * from "./ProductDetail.js";
42
+ export * from "./ProductDetailResponse.js";
43
+ export * from "./ProductDistributions.js";
44
+ export * from "./ProductItem.js";
45
+ export * from "./ProductListResponse.js";
46
+ export * from "./ProductMarketMetrics.js";
47
+ export * from "./ProductMarkets.js";
48
+ export * from "./PublicApiError.js";
49
+ export * from "./RankMarkets.js";
50
+ export * from "./RankPoint.js";
51
+ export * from "./RatingCount.js";
52
+ export * from "./ResearchError.js";
53
+ export * from "./ReviewHistoryPoint.js";
54
+ export * from "./ReviewItem.js";
55
+ export * from "./ReviewListResponse.js";
56
+ export * from "./ReviewSummary.js";
57
+ export * from "./ReviewSummaryResponse.js";
58
+ export * from "./ReviewTopic.js";
59
+ export * from "./SalesHistoryMarkets.js";
60
+ export * from "./SalesHistoryMetrics.js";
61
+ export * from "./SalesHistoryPoint.js";
62
+ export * from "./SalesHistoryResponse.js";
63
+ export * from "./SellerItem.js";
64
+ export * from "./SellerMarkets.js";
65
+ export * from "./SellerMetrics.js";
66
+ export * from "./SellerResponse.js";
67
+ export * from "./SellerSummaryMarkets.js";
68
+ export * from "./SellerSummaryMetrics.js";
69
+ export * from "./StoreChange.js";
70
+ export * from "./StoreError.js";
71
+ export * from "./StoreFilters.js";
72
+ export * from "./StoreInventoryCounts.js";
73
+ export * from "./StoreInventoryFilters.js";
74
+ export * from "./StoreInventoryPagination.js";
75
+ export * from "./StoreInventoryResponse.js";
76
+ export * from "./StoreInventoryRow.js";
77
+ export * from "./StoreKpi.js";
78
+ export * from "./StoreOverviewResponse.js";
79
+ export * from "./StorePerformanceProductPerformanceItem.js";
80
+ export * from "./StorePerformanceReturnCostsBreakdown.js";
81
+ export * from "./StorePerformanceSalesCostsBreakdown.js";
82
+ export * from "./StorePreviousKpi.js";
83
+ export * from "./StoreProductsFilters.js";
84
+ export * from "./StoreProductsPagination.js";
85
+ export * from "./StoreProductsResponse.js";
86
+ export * from "./UnauthorizedErrorBody.js";
87
+ export * from "./Usage.js";
88
+ export * from "./UsageOrganization.js";
89
+ export * from "./VisibilityHistoryResponse.js";
90
+ export * from "./VisibilityMarkets.js";
91
+ export * from "./VisibilityMetrics.js";
92
+ export * from "./VisibilityPoint.js";
@@ -0,0 +1,92 @@
1
+ export * from "./AllowanceError.js";
2
+ export * from "./Brand.js";
3
+ export * from "./BrandListResponse.js";
4
+ export * from "./BundleUsage.js";
5
+ export * from "./Category.js";
6
+ export * from "./CategoryItem.js";
7
+ export * from "./CategoryListResponse.js";
8
+ export * from "./CategoryPathItem.js";
9
+ export * from "./CategoryRanking.js";
10
+ export * from "./CategoryRankingsResponse.js";
11
+ export * from "./CategoryResponse.js";
12
+ export * from "./CommissionBracket.js";
13
+ export * from "./CurrentPeriod.js";
14
+ export * from "./Dimensions.js";
15
+ export * from "./DistributionBucket.js";
16
+ export * from "./DistributionData.js";
17
+ export * from "./FreeTierUsage.js";
18
+ export * from "./KeywordItem.js";
19
+ export * from "./KeywordMarkets.js";
20
+ export * from "./KeywordMetrics.js";
21
+ export * from "./KeywordRanking.js";
22
+ export * from "./KeywordRankingsResponse.js";
23
+ export * from "./KeywordResponse.js";
24
+ export * from "./ListingChanges.js";
25
+ export * from "./NicheDetail.js";
26
+ export * from "./NicheDetailResponse.js";
27
+ export * from "./NicheDistributionsResponse.js";
28
+ export * from "./NicheHistoryData.js";
29
+ export * from "./NicheHistoryResponse.js";
30
+ export * from "./NicheItem.js";
31
+ export * from "./NicheListResponse.js";
32
+ export * from "./NicheMarkets.js";
33
+ export * from "./NicheMetrics.js";
34
+ export * from "./NichePeriod.js";
35
+ export * from "./OauthScope.js";
36
+ export * from "./Organization.js";
37
+ export * from "./Pagination.js";
38
+ export * from "./Period.js";
39
+ export * from "./PeriodRatings.js";
40
+ export * from "./PeriodReviews.js";
41
+ export * from "./ProductDetail.js";
42
+ export * from "./ProductDetailResponse.js";
43
+ export * from "./ProductDistributions.js";
44
+ export * from "./ProductItem.js";
45
+ export * from "./ProductListResponse.js";
46
+ export * from "./ProductMarketMetrics.js";
47
+ export * from "./ProductMarkets.js";
48
+ export * from "./PublicApiError.js";
49
+ export * from "./RankMarkets.js";
50
+ export * from "./RankPoint.js";
51
+ export * from "./RatingCount.js";
52
+ export * from "./ResearchError.js";
53
+ export * from "./ReviewHistoryPoint.js";
54
+ export * from "./ReviewItem.js";
55
+ export * from "./ReviewListResponse.js";
56
+ export * from "./ReviewSummary.js";
57
+ export * from "./ReviewSummaryResponse.js";
58
+ export * from "./ReviewTopic.js";
59
+ export * from "./SalesHistoryMarkets.js";
60
+ export * from "./SalesHistoryMetrics.js";
61
+ export * from "./SalesHistoryPoint.js";
62
+ export * from "./SalesHistoryResponse.js";
63
+ export * from "./SellerItem.js";
64
+ export * from "./SellerMarkets.js";
65
+ export * from "./SellerMetrics.js";
66
+ export * from "./SellerResponse.js";
67
+ export * from "./SellerSummaryMarkets.js";
68
+ export * from "./SellerSummaryMetrics.js";
69
+ export * from "./StoreChange.js";
70
+ export * from "./StoreError.js";
71
+ export * from "./StoreFilters.js";
72
+ export * from "./StoreInventoryCounts.js";
73
+ export * from "./StoreInventoryFilters.js";
74
+ export * from "./StoreInventoryPagination.js";
75
+ export * from "./StoreInventoryResponse.js";
76
+ export * from "./StoreInventoryRow.js";
77
+ export * from "./StoreKpi.js";
78
+ export * from "./StoreOverviewResponse.js";
79
+ export * from "./StorePerformanceProductPerformanceItem.js";
80
+ export * from "./StorePerformanceReturnCostsBreakdown.js";
81
+ export * from "./StorePerformanceSalesCostsBreakdown.js";
82
+ export * from "./StorePreviousKpi.js";
83
+ export * from "./StoreProductsFilters.js";
84
+ export * from "./StoreProductsPagination.js";
85
+ export * from "./StoreProductsResponse.js";
86
+ export * from "./UnauthorizedErrorBody.js";
87
+ export * from "./Usage.js";
88
+ export * from "./UsageOrganization.js";
89
+ export * from "./VisibilityHistoryResponse.js";
90
+ export * from "./VisibilityMarkets.js";
91
+ export * from "./VisibilityMetrics.js";
92
+ export * from "./VisibilityPoint.js";
@@ -0,0 +1,20 @@
1
+ import * as core from "../core/index.js";
2
+ declare const TOKEN_PARAM: "token";
3
+ export declare class BearerAuthProvider implements core.AuthProvider {
4
+ private readonly options;
5
+ constructor(options: BearerAuthProvider.Options);
6
+ static canCreate(options: Partial<BearerAuthProvider.Options>): boolean;
7
+ getAuthRequest({ endpointMetadata, }?: {
8
+ endpointMetadata?: core.EndpointMetadata;
9
+ }): Promise<core.AuthRequest>;
10
+ }
11
+ export declare namespace BearerAuthProvider {
12
+ const AUTH_SCHEME: "MarktMentorOAuth2";
13
+ const AUTH_CONFIG_ERROR_MESSAGE: string;
14
+ type Options = AuthOptions;
15
+ type AuthOptions = {
16
+ [TOKEN_PARAM]: core.Supplier<core.BearerToken>;
17
+ };
18
+ function createInstance(options: Options): core.AuthProvider;
19
+ }
20
+ export {};
@@ -0,0 +1,32 @@
1
+ // This file was auto-generated by Fern from our API Definition.
2
+ import * as core from "../core/index.js";
3
+ import * as errors from "../errors/index.js";
4
+ const TOKEN_PARAM = "token";
5
+ export class BearerAuthProvider {
6
+ options;
7
+ constructor(options) {
8
+ this.options = options;
9
+ }
10
+ static canCreate(options) {
11
+ return options?.[TOKEN_PARAM] != null;
12
+ }
13
+ async getAuthRequest({ endpointMetadata, } = {}) {
14
+ const token = await core.Supplier.get(this.options[TOKEN_PARAM]);
15
+ if (token == null) {
16
+ throw new errors.MarktMentorError({
17
+ message: BearerAuthProvider.AUTH_CONFIG_ERROR_MESSAGE,
18
+ });
19
+ }
20
+ return {
21
+ headers: { Authorization: `Bearer ${token}` },
22
+ };
23
+ }
24
+ }
25
+ (function (BearerAuthProvider) {
26
+ BearerAuthProvider.AUTH_SCHEME = "MarktMentorOAuth2";
27
+ BearerAuthProvider.AUTH_CONFIG_ERROR_MESSAGE = `Please provide '${TOKEN_PARAM}' when initializing the client`;
28
+ function createInstance(options) {
29
+ return new BearerAuthProvider(options);
30
+ }
31
+ BearerAuthProvider.createInstance = createInstance;
32
+ })(BearerAuthProvider || (BearerAuthProvider = {}));
@@ -0,0 +1 @@
1
+ export { BearerAuthProvider } from "./BearerAuthProvider.js";
@@ -0,0 +1 @@
1
+ export { BearerAuthProvider } from "./BearerAuthProvider.js";
@@ -0,0 +1,8 @@
1
+ import type { EndpointMetadata } from "../fetcher/EndpointMetadata.js";
2
+ import type { AuthRequest } from "./AuthRequest.js";
3
+ export interface AuthProvider {
4
+ getAuthRequest(arg?: {
5
+ endpointMetadata?: EndpointMetadata;
6
+ }): Promise<AuthRequest>;
7
+ }
8
+ export declare function isAuthProvider(value: unknown): value is AuthProvider;
@@ -0,0 +1,6 @@
1
+ export function isAuthProvider(value) {
2
+ return (typeof value === "object" &&
3
+ value !== null &&
4
+ "getAuthRequest" in value &&
5
+ typeof value.getAuthRequest === "function");
6
+ }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Request parameters for authentication requests.
3
+ */
4
+ export interface AuthRequest {
5
+ /**
6
+ * The headers to be included in the request.
7
+ */
8
+ headers: Record<string, string>;
9
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,8 @@
1
+ export interface BasicAuth {
2
+ username?: string;
3
+ password?: string;
4
+ }
5
+ export declare const BasicAuth: {
6
+ toAuthorizationHeader: (basicAuth: BasicAuth | undefined) => string | undefined;
7
+ fromAuthorizationHeader: (header: string) => BasicAuth;
8
+ };