@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,140 @@
1
+ export const LogLevel = {
2
+ Debug: "debug",
3
+ Info: "info",
4
+ Warn: "warn",
5
+ Error: "error",
6
+ };
7
+ const logLevelMap = {
8
+ [LogLevel.Debug]: 1,
9
+ [LogLevel.Info]: 2,
10
+ [LogLevel.Warn]: 3,
11
+ [LogLevel.Error]: 4,
12
+ };
13
+ /**
14
+ * Default console-based logger implementation.
15
+ */
16
+ export class ConsoleLogger {
17
+ debug(message, ...args) {
18
+ console.debug(message, ...args);
19
+ }
20
+ info(message, ...args) {
21
+ console.info(message, ...args);
22
+ }
23
+ warn(message, ...args) {
24
+ console.warn(message, ...args);
25
+ }
26
+ error(message, ...args) {
27
+ console.error(message, ...args);
28
+ }
29
+ }
30
+ /**
31
+ * Logger class that provides level-based logging functionality.
32
+ */
33
+ export class Logger {
34
+ level;
35
+ logger;
36
+ silent;
37
+ /**
38
+ * Creates a new logger instance.
39
+ * @param config - Logger configuration
40
+ */
41
+ constructor(config) {
42
+ this.level = logLevelMap[config.level];
43
+ this.logger = config.logger;
44
+ this.silent = config.silent;
45
+ }
46
+ /**
47
+ * Checks if a log level should be output based on configuration.
48
+ * @param level - The log level to check
49
+ * @returns True if the level should be logged
50
+ */
51
+ shouldLog(level) {
52
+ return !this.silent && this.level <= logLevelMap[level];
53
+ }
54
+ /**
55
+ * Checks if debug logging is enabled.
56
+ * @returns True if debug logs should be output
57
+ */
58
+ isDebug() {
59
+ return this.shouldLog(LogLevel.Debug);
60
+ }
61
+ /**
62
+ * Logs a debug message if debug logging is enabled.
63
+ * @param message - The message to log
64
+ * @param args - Additional arguments to log
65
+ */
66
+ debug(message, ...args) {
67
+ if (this.isDebug()) {
68
+ this.logger.debug(message, ...args);
69
+ }
70
+ }
71
+ /**
72
+ * Checks if info logging is enabled.
73
+ * @returns True if info logs should be output
74
+ */
75
+ isInfo() {
76
+ return this.shouldLog(LogLevel.Info);
77
+ }
78
+ /**
79
+ * Logs an info message if info logging is enabled.
80
+ * @param message - The message to log
81
+ * @param args - Additional arguments to log
82
+ */
83
+ info(message, ...args) {
84
+ if (this.isInfo()) {
85
+ this.logger.info(message, ...args);
86
+ }
87
+ }
88
+ /**
89
+ * Checks if warning logging is enabled.
90
+ * @returns True if warning logs should be output
91
+ */
92
+ isWarn() {
93
+ return this.shouldLog(LogLevel.Warn);
94
+ }
95
+ /**
96
+ * Logs a warning message if warning logging is enabled.
97
+ * @param message - The message to log
98
+ * @param args - Additional arguments to log
99
+ */
100
+ warn(message, ...args) {
101
+ if (this.isWarn()) {
102
+ this.logger.warn(message, ...args);
103
+ }
104
+ }
105
+ /**
106
+ * Checks if error logging is enabled.
107
+ * @returns True if error logs should be output
108
+ */
109
+ isError() {
110
+ return this.shouldLog(LogLevel.Error);
111
+ }
112
+ /**
113
+ * Logs an error message if error logging is enabled.
114
+ * @param message - The message to log
115
+ * @param args - Additional arguments to log
116
+ */
117
+ error(message, ...args) {
118
+ if (this.isError()) {
119
+ this.logger.error(message, ...args);
120
+ }
121
+ }
122
+ }
123
+ export function createLogger(config) {
124
+ if (config == null) {
125
+ return defaultLogger;
126
+ }
127
+ if (config instanceof Logger) {
128
+ return config;
129
+ }
130
+ config = config ?? {};
131
+ config.level ??= LogLevel.Info;
132
+ config.logger ??= new ConsoleLogger();
133
+ config.silent ??= true;
134
+ return new Logger(config);
135
+ }
136
+ const defaultLogger = new Logger({
137
+ level: LogLevel.Info,
138
+ logger: new ConsoleLogger(),
139
+ silent: true,
140
+ });
@@ -0,0 +1,33 @@
1
+ import type { HttpResponsePromise, RawResponse } from "../fetcher/index.js";
2
+ /**
3
+ * A page of results from a paginated API.
4
+ *
5
+ * @template T The type of the items in the page.
6
+ * @template R The type of the API response.
7
+ */
8
+ export declare class Page<T, R = unknown> implements AsyncIterable<T> {
9
+ data: T[];
10
+ rawResponse: RawResponse;
11
+ response: R;
12
+ private _hasNextPage;
13
+ private getItems;
14
+ private loadNextPage;
15
+ constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }: {
16
+ response: R;
17
+ rawResponse: RawResponse;
18
+ hasNextPage: (response: R) => boolean;
19
+ getItems: (response: R) => T[];
20
+ loadPage: (response: R) => HttpResponsePromise<R>;
21
+ });
22
+ /**
23
+ * Retrieves the next page
24
+ * @returns this
25
+ */
26
+ getNextPage(): Promise<this>;
27
+ /**
28
+ * @returns whether there is a next page to load
29
+ */
30
+ hasNextPage(): boolean;
31
+ private iterMessages;
32
+ [Symbol.asyncIterator](): AsyncIterator<T, void, unknown>;
33
+ }
@@ -0,0 +1,55 @@
1
+ /**
2
+ * A page of results from a paginated API.
3
+ *
4
+ * @template T The type of the items in the page.
5
+ * @template R The type of the API response.
6
+ */
7
+ export class Page {
8
+ data;
9
+ rawResponse;
10
+ response;
11
+ _hasNextPage;
12
+ getItems;
13
+ loadNextPage;
14
+ constructor({ response, rawResponse, hasNextPage, getItems, loadPage, }) {
15
+ this.response = response;
16
+ this.rawResponse = rawResponse;
17
+ this.data = getItems(response);
18
+ this._hasNextPage = hasNextPage;
19
+ this.getItems = getItems;
20
+ this.loadNextPage = loadPage;
21
+ }
22
+ /**
23
+ * Retrieves the next page
24
+ * @returns this
25
+ */
26
+ async getNextPage() {
27
+ const { data, rawResponse } = await this.loadNextPage(this.response).withRawResponse();
28
+ this.response = data;
29
+ this.rawResponse = rawResponse;
30
+ this.data = this.getItems(this.response);
31
+ return this;
32
+ }
33
+ /**
34
+ * @returns whether there is a next page to load
35
+ */
36
+ hasNextPage() {
37
+ return this._hasNextPage(this.response);
38
+ }
39
+ async *iterMessages() {
40
+ for (const item of this.data) {
41
+ yield item;
42
+ }
43
+ while (this.hasNextPage()) {
44
+ await this.getNextPage();
45
+ for (const item of this.data) {
46
+ yield item;
47
+ }
48
+ }
49
+ }
50
+ async *[Symbol.asyncIterator]() {
51
+ for await (const message of this.iterMessages()) {
52
+ yield message;
53
+ }
54
+ }
55
+ }
@@ -0,0 +1 @@
1
+ export type { Page } from "./Page.js";
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1 @@
1
+ export { Page } from "./Page.js";
@@ -0,0 +1 @@
1
+ export { Page } from "./Page.js";
@@ -0,0 +1,12 @@
1
+ /**
2
+ * Spreads caller-supplied `additionalBodyParameters` (from `requestOptions.additionalBodyParameters`)
3
+ * on top of the request body. Caller-supplied properties win over the endpoint body. When no
4
+ * additional body parameters are provided, the original body is returned unchanged so serialization
5
+ * is unaffected.
6
+ *
7
+ * The merge only applies to plain-object (JSON object) bodies. When the body is `null`/`undefined`
8
+ * the additional parameters become the body; when the body is an array or a primitive JSON value it
9
+ * is returned unchanged, since object properties cannot be spread into it. This mirrors the Python
10
+ * SDK, which only merges additional body parameters into mapping bodies.
11
+ */
12
+ export declare function mergeAdditionalBodyParameters(body: unknown, additionalBodyParameters: Record<string, unknown> | undefined): unknown;
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Spreads caller-supplied `additionalBodyParameters` (from `requestOptions.additionalBodyParameters`)
3
+ * on top of the request body. Caller-supplied properties win over the endpoint body. When no
4
+ * additional body parameters are provided, the original body is returned unchanged so serialization
5
+ * is unaffected.
6
+ *
7
+ * The merge only applies to plain-object (JSON object) bodies. When the body is `null`/`undefined`
8
+ * the additional parameters become the body; when the body is an array or a primitive JSON value it
9
+ * is returned unchanged, since object properties cannot be spread into it. This mirrors the Python
10
+ * SDK, which only merges additional body parameters into mapping bodies.
11
+ */
12
+ export function mergeAdditionalBodyParameters(body, additionalBodyParameters) {
13
+ if (additionalBodyParameters == null) {
14
+ return body;
15
+ }
16
+ if (body == null) {
17
+ return { ...additionalBodyParameters };
18
+ }
19
+ if (typeof body === "object" && !Array.isArray(body)) {
20
+ return { ...body, ...additionalBodyParameters };
21
+ }
22
+ return body;
23
+ }
@@ -0,0 +1 @@
1
+ export { getUserAgent, RUNTIME } from "./runtime.js";
@@ -0,0 +1 @@
1
+ export { getUserAgent, RUNTIME } from "./runtime.js";
@@ -0,0 +1,28 @@
1
+ /**
2
+ * A constant that indicates which environment and version the SDK is running in.
3
+ */
4
+ export declare const RUNTIME: Runtime;
5
+ export interface Runtime {
6
+ type: "browser" | "web-worker" | "deno" | "bun" | "node" | "react-native" | "unknown" | "workerd" | "edge-runtime";
7
+ version?: string;
8
+ parsedVersion?: number;
9
+ /**
10
+ * The operating system the SDK is running on, when it can be determined
11
+ * (e.g. "linux", "darwin", "win32" on server runtimes). Undefined in
12
+ * environments where the OS is not observable (e.g. browsers).
13
+ */
14
+ os?: string;
15
+ /**
16
+ * The CPU architecture the SDK is running on, when it can be determined
17
+ * (e.g. "x64", "arm64" on server runtimes). Undefined in environments where
18
+ * the architecture is not observable (e.g. browsers).
19
+ */
20
+ arch?: string;
21
+ }
22
+ /**
23
+ * Builds a structured User-Agent string of the form
24
+ * `{sdkName}/{sdkVersion} ({os}; {arch}) {runtime}/{runtimeVersion}`
25
+ * where the platform group and runtime segment are omitted gracefully when the
26
+ * underlying values cannot be determined (e.g. in a browser).
27
+ */
28
+ export declare function getUserAgent(sdkName: string, sdkVersion: string): string;
@@ -0,0 +1,171 @@
1
+ /**
2
+ * A constant that indicates which environment and version the SDK is running in.
3
+ */
4
+ export const RUNTIME = evaluateRuntime();
5
+ function evaluateRuntime() {
6
+ /**
7
+ * A constant that indicates whether the environment the code is running is a Web Browser.
8
+ */
9
+ const isBrowser = typeof window !== "undefined" && typeof window.document !== "undefined";
10
+ if (isBrowser) {
11
+ return {
12
+ type: "browser",
13
+ version: window.navigator.userAgent,
14
+ };
15
+ }
16
+ /**
17
+ * A constant that indicates whether the environment the code is running is Cloudflare.
18
+ * https://developers.cloudflare.com/workers/runtime-apis/web-standards/#navigatoruseragent
19
+ */
20
+ const isCloudflare = typeof globalThis !== "undefined" && globalThis?.navigator?.userAgent === "Cloudflare-Workers";
21
+ if (isCloudflare) {
22
+ return {
23
+ type: "workerd",
24
+ };
25
+ }
26
+ /**
27
+ * A constant that indicates whether the environment the code is running is Edge Runtime.
28
+ * https://vercel.com/docs/functions/runtimes/edge-runtime#check-if-you're-running-on-the-edge-runtime
29
+ */
30
+ const isEdgeRuntime = typeof EdgeRuntime === "string";
31
+ if (isEdgeRuntime) {
32
+ return {
33
+ type: "edge-runtime",
34
+ };
35
+ }
36
+ /**
37
+ * A constant that indicates whether the environment the code is running is a Web Worker.
38
+ */
39
+ const isWebWorker = typeof self === "object" &&
40
+ typeof self?.importScripts === "function" &&
41
+ (self.constructor?.name === "DedicatedWorkerGlobalScope" ||
42
+ self.constructor?.name === "ServiceWorkerGlobalScope" ||
43
+ self.constructor?.name === "SharedWorkerGlobalScope");
44
+ if (isWebWorker) {
45
+ return {
46
+ type: "web-worker",
47
+ };
48
+ }
49
+ /**
50
+ * A constant that indicates whether the environment the code is running is Deno.
51
+ * FYI Deno spoofs process.versions.node, see https://deno.land/std@0.177.0/node/process.ts?s=versions
52
+ */
53
+ const isDeno = typeof Deno !== "undefined" && typeof Deno.version !== "undefined" && typeof Deno.version.deno !== "undefined";
54
+ if (isDeno) {
55
+ return {
56
+ type: "deno",
57
+ version: Deno.version.deno,
58
+ os: Deno.build?.os,
59
+ arch: Deno.build?.arch,
60
+ };
61
+ }
62
+ /**
63
+ * A constant that indicates whether the environment the code is running is Bun.sh.
64
+ */
65
+ const isBun = typeof Bun !== "undefined" && typeof Bun.version !== "undefined";
66
+ if (isBun) {
67
+ return {
68
+ type: "bun",
69
+ version: Bun.version,
70
+ os: typeof process !== "undefined" ? process.platform : undefined,
71
+ arch: typeof process !== "undefined" ? process.arch : undefined,
72
+ };
73
+ }
74
+ /**
75
+ * A constant that indicates whether the environment the code is running is in React-Native.
76
+ * This check should come before Node.js detection since React Native may have a process polyfill.
77
+ * https://github.com/facebook/react-native/blob/main/packages/react-native/Libraries/Core/setUpNavigator.js
78
+ */
79
+ const isReactNative = typeof navigator !== "undefined" && navigator?.product === "ReactNative";
80
+ if (isReactNative) {
81
+ return {
82
+ type: "react-native",
83
+ };
84
+ }
85
+ /**
86
+ * A constant that indicates whether the environment the code is running is Node.JS.
87
+ *
88
+ * We assign `process` to a local variable first to avoid being flagged by
89
+ * bundlers that perform static analysis on `process.versions` (e.g. Next.js
90
+ * Edge Runtime warns about Node.js APIs even when they are guarded).
91
+ */
92
+ const _process = typeof process !== "undefined" ? process : undefined;
93
+ const isNode = typeof _process !== "undefined" && typeof _process.versions?.node === "string";
94
+ if (isNode) {
95
+ return {
96
+ type: "node",
97
+ version: _process.versions.node,
98
+ parsedVersion: Number(_process.versions.node.split(".")[0]),
99
+ os: _process.platform,
100
+ arch: _process.arch,
101
+ };
102
+ }
103
+ return {
104
+ type: "unknown",
105
+ };
106
+ }
107
+ /**
108
+ * Display names for the language runtimes whose version is meaningful to encode
109
+ * in a User-Agent. Environments where a version string is not useful (e.g.
110
+ * browsers, where `version` is the full navigator UA) are intentionally mapped
111
+ * to `undefined` so they are omitted from the User-Agent.
112
+ */
113
+ const RUNTIME_DISPLAY_NAMES = {
114
+ node: "Node",
115
+ deno: "Deno",
116
+ bun: "Bun",
117
+ browser: undefined,
118
+ "web-worker": undefined,
119
+ "react-native": undefined,
120
+ workerd: undefined,
121
+ "edge-runtime": undefined,
122
+ unknown: undefined,
123
+ };
124
+ /**
125
+ * CPU architecture aliases that all refer to 64-bit x86. They are normalized to
126
+ * the single canonical token `x86_64` so the User-Agent architecture label is
127
+ * consistent regardless of which runtime reports it (Node reports `x64`, others
128
+ * report `amd64` or `x86_64`).
129
+ */
130
+ const X86_64_ARCH_ALIASES = new Set(["x64", "amd64", "x86_64"]);
131
+ /**
132
+ * Normalizes a CPU architecture token, collapsing the 64-bit x86 aliases
133
+ * (`x64`, `amd64`, `x86_64`) to `x86_64`. Other architectures are returned
134
+ * unchanged.
135
+ */
136
+ function normalizeArch(arch) {
137
+ if (arch == null) {
138
+ return arch;
139
+ }
140
+ return X86_64_ARCH_ALIASES.has(arch.toLowerCase()) ? "x86_64" : arch;
141
+ }
142
+ /**
143
+ * Percent-encodes the `@` and `/` characters in an npm package name so the
144
+ * User-Agent product token stays within the RFC 7230 token grammar. The
145
+ * original scoped package name can be recovered by URL-decoding (e.g.
146
+ * `@dummy/sdk` becomes `%40dummy%2Fsdk`).
147
+ */
148
+ function encodeProductName(sdkName) {
149
+ return sdkName.replace(/@/g, "%40").replace(/\//g, "%2F");
150
+ }
151
+ /**
152
+ * Builds a structured User-Agent string of the form
153
+ * `{sdkName}/{sdkVersion} ({os}; {arch}) {runtime}/{runtimeVersion}`
154
+ * where the platform group and runtime segment are omitted gracefully when the
155
+ * underlying values cannot be determined (e.g. in a browser).
156
+ */
157
+ export function getUserAgent(sdkName, sdkVersion) {
158
+ let userAgent = `${encodeProductName(sdkName)}/${sdkVersion}`;
159
+ const platform = [RUNTIME.os, normalizeArch(RUNTIME.arch)].filter((part) => part != null && part.length > 0);
160
+ if (platform.length > 0) {
161
+ userAgent += ` (${platform.join("; ")})`;
162
+ }
163
+ const runtimeName = RUNTIME_DISPLAY_NAMES[RUNTIME.type];
164
+ if (runtimeName != null) {
165
+ userAgent += ` ${runtimeName}`;
166
+ if (RUNTIME.version != null && RUNTIME.version.length > 0) {
167
+ userAgent += `/${RUNTIME.version}`;
168
+ }
169
+ }
170
+ return userAgent;
171
+ }
@@ -0,0 +1,47 @@
1
+ /**
2
+ * Creates a fluent builder for constructing URL query strings.
3
+ *
4
+ * Each `.add()` call serializes its value immediately (like C#'s builder),
5
+ * so no format tracking is needed — the style is applied at add-time.
6
+ *
7
+ * Usage (generated code):
8
+ *
9
+ * const qs = core.url.queryBuilder()
10
+ * .add("limit", limit)
11
+ * .add("tags", tags, { style: "comma" }) // explode: false
12
+ * .mergeAdditional(requestOptions?.queryParams)
13
+ * .build();
14
+ */
15
+ export declare function queryBuilder(): QueryStringBuilder;
16
+ declare class QueryStringBuilder {
17
+ private parts;
18
+ /**
19
+ * Adds a query parameter, serializing it immediately.
20
+ *
21
+ * By default arrays use "repeat" format (`key=a&key=b`).
22
+ * Pass `{ style: "comma" }` for OpenAPI `explode: false` parameters
23
+ * to get comma-separated values (`key=a,b,c`).
24
+ *
25
+ * Null / undefined values are silently skipped.
26
+ */
27
+ add(key: string, value: unknown, options?: {
28
+ style?: "comma";
29
+ }): this;
30
+ /**
31
+ * Adds multiple query parameters at once from a record.
32
+ * All parameters use the default "repeat" array format.
33
+ * Null / undefined values are silently skipped.
34
+ */
35
+ addMany(params: Record<string, unknown>): this;
36
+ /**
37
+ * Merges additional query parameters supplied at call-time via
38
+ * `requestOptions.queryParams`. Overrides existing keys (last-write-wins).
39
+ */
40
+ mergeAdditional(additionalParams?: Record<string, unknown>): this;
41
+ /**
42
+ * Returns the assembled query string (without the leading `?`).
43
+ * Returns an empty string when no parameters were added.
44
+ */
45
+ build(): string;
46
+ }
47
+ export {};
@@ -0,0 +1,78 @@
1
+ import { toQueryString } from "./qs.js";
2
+ /**
3
+ * Creates a fluent builder for constructing URL query strings.
4
+ *
5
+ * Each `.add()` call serializes its value immediately (like C#'s builder),
6
+ * so no format tracking is needed — the style is applied at add-time.
7
+ *
8
+ * Usage (generated code):
9
+ *
10
+ * const qs = core.url.queryBuilder()
11
+ * .add("limit", limit)
12
+ * .add("tags", tags, { style: "comma" }) // explode: false
13
+ * .mergeAdditional(requestOptions?.queryParams)
14
+ * .build();
15
+ */
16
+ export function queryBuilder() {
17
+ return new QueryStringBuilder();
18
+ }
19
+ class QueryStringBuilder {
20
+ parts = new Map();
21
+ /**
22
+ * Adds a query parameter, serializing it immediately.
23
+ *
24
+ * By default arrays use "repeat" format (`key=a&key=b`).
25
+ * Pass `{ style: "comma" }` for OpenAPI `explode: false` parameters
26
+ * to get comma-separated values (`key=a,b,c`).
27
+ *
28
+ * Null / undefined values are silently skipped.
29
+ */
30
+ add(key, value, options) {
31
+ if (value === undefined || value === null) {
32
+ return this;
33
+ }
34
+ const serialized = toQueryString({ [key]: value }, { arrayFormat: options?.style === "comma" ? "comma" : "repeat" });
35
+ if (serialized.length > 0) {
36
+ this.parts.set(key, serialized);
37
+ }
38
+ return this;
39
+ }
40
+ /**
41
+ * Adds multiple query parameters at once from a record.
42
+ * All parameters use the default "repeat" array format.
43
+ * Null / undefined values are silently skipped.
44
+ */
45
+ addMany(params) {
46
+ if (params != null) {
47
+ for (const [key, value] of Object.entries(params)) {
48
+ this.add(key, value);
49
+ }
50
+ }
51
+ return this;
52
+ }
53
+ /**
54
+ * Merges additional query parameters supplied at call-time via
55
+ * `requestOptions.queryParams`. Overrides existing keys (last-write-wins).
56
+ */
57
+ mergeAdditional(additionalParams) {
58
+ if (additionalParams != null) {
59
+ for (const [key, value] of Object.entries(additionalParams)) {
60
+ if (value === undefined || value === null) {
61
+ continue;
62
+ }
63
+ const serialized = toQueryString({ [key]: value }, { arrayFormat: "repeat" });
64
+ if (serialized.length > 0) {
65
+ this.parts.set(key, serialized);
66
+ }
67
+ }
68
+ }
69
+ return this;
70
+ }
71
+ /**
72
+ * Returns the assembled query string (without the leading `?`).
73
+ * Returns an empty string when no parameters were added.
74
+ */
75
+ build() {
76
+ return [...this.parts.values()].join("&");
77
+ }
78
+ }
@@ -0,0 +1,3 @@
1
+ export declare function encodePathParam(param: unknown, InvalidPathParameterError?: new (args: {
2
+ message: string;
3
+ }) => Error): string;
@@ -0,0 +1,24 @@
1
+ export function encodePathParam(param, InvalidPathParameterError) {
2
+ if (param === null) {
3
+ return "null";
4
+ }
5
+ const typeofParam = typeof param;
6
+ switch (typeofParam) {
7
+ case "undefined":
8
+ return "undefined";
9
+ case "string":
10
+ case "number":
11
+ case "boolean":
12
+ break;
13
+ default:
14
+ param = String(param);
15
+ break;
16
+ }
17
+ const encoded = encodeURIComponent(param);
18
+ // "." and ".." are dot segments: URL resolution would remove them and send the request to a different path.
19
+ if (encoded === "." || encoded === "..") {
20
+ const message = `Invalid path parameter "${encoded}": "." and ".." are not allowed because they change the request path.`;
21
+ throw InvalidPathParameterError != null ? new InvalidPathParameterError({ message }) : new Error(message);
22
+ }
23
+ return encoded;
24
+ }
@@ -0,0 +1,4 @@
1
+ export { encodePathParam } from "./encodePathParam.js";
2
+ export { join } from "./join.js";
3
+ export { queryBuilder } from "./QueryStringBuilder.js";
4
+ export { toQueryString } from "./qs.js";
@@ -0,0 +1,4 @@
1
+ export { encodePathParam } from "./encodePathParam.js";
2
+ export { join } from "./join.js";
3
+ export { queryBuilder } from "./QueryStringBuilder.js";
4
+ export { toQueryString } from "./qs.js";
@@ -0,0 +1 @@
1
+ export declare function join(base: string, ...segments: string[]): string;