@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.
- package/LICENSE +21 -0
- package/README.md +29 -2
- package/dist/BaseClient.d.ts +54 -0
- package/dist/BaseClient.js +43 -0
- package/dist/Client.d.ts +41 -0
- package/dist/Client.js +60 -0
- package/dist/api/errors/BadRequestError.d.ts +5 -0
- package/dist/api/errors/BadRequestError.js +17 -0
- package/dist/api/errors/ConflictError.d.ts +5 -0
- package/dist/api/errors/ConflictError.js +17 -0
- package/dist/api/errors/ForbiddenError.d.ts +5 -0
- package/dist/api/errors/ForbiddenError.js +17 -0
- package/dist/api/errors/NotFoundError.d.ts +7 -0
- package/dist/api/errors/NotFoundError.js +17 -0
- package/dist/api/errors/PaymentRequiredError.d.ts +7 -0
- package/dist/api/errors/PaymentRequiredError.js +17 -0
- package/dist/api/errors/ServiceUnavailableError.d.ts +5 -0
- package/dist/api/errors/ServiceUnavailableError.js +17 -0
- package/dist/api/errors/TooManyRequestsError.d.ts +5 -0
- package/dist/api/errors/TooManyRequestsError.js +17 -0
- package/dist/api/errors/UnauthorizedError.d.ts +5 -0
- package/dist/api/errors/UnauthorizedError.js +17 -0
- package/dist/api/errors/index.d.ts +8 -0
- package/dist/api/errors/index.js +8 -0
- package/dist/api/index.d.ts +3 -0
- package/dist/api/index.js +3 -0
- package/dist/api/resources/index.d.ts +13 -0
- package/dist/api/resources/index.js +13 -0
- package/dist/api/resources/niches/client/Client.d.ts +188 -0
- package/dist/api/resources/niches/client/Client.js +655 -0
- package/dist/api/resources/niches/client/index.d.ts +1 -0
- package/dist/api/resources/niches/client/index.js +1 -0
- package/dist/api/resources/niches/client/requests/GetNichesRequest.d.ts +17 -0
- package/dist/api/resources/niches/client/requests/GetNichesRequest.js +2 -0
- package/dist/api/resources/niches/client/requests/ListNichesRequest.d.ts +34 -0
- package/dist/api/resources/niches/client/requests/ListNichesRequest.js +2 -0
- package/dist/api/resources/niches/client/requests/ProductDistributionsNichesRequest.d.ts +13 -0
- package/dist/api/resources/niches/client/requests/ProductDistributionsNichesRequest.js +2 -0
- package/dist/api/resources/niches/client/requests/ProductsNichesRequest.d.ts +48 -0
- package/dist/api/resources/niches/client/requests/ProductsNichesRequest.js +2 -0
- package/dist/api/resources/niches/client/requests/ReviewHistoryNichesRequest.d.ts +23 -0
- package/dist/api/resources/niches/client/requests/ReviewHistoryNichesRequest.js +2 -0
- package/dist/api/resources/niches/client/requests/ReviewSummaryNichesRequest.d.ts +5 -0
- package/dist/api/resources/niches/client/requests/ReviewSummaryNichesRequest.js +2 -0
- package/dist/api/resources/niches/client/requests/ReviewsNichesRequest.d.ts +33 -0
- package/dist/api/resources/niches/client/requests/ReviewsNichesRequest.js +2 -0
- package/dist/api/resources/niches/client/requests/index.d.ts +7 -0
- package/dist/api/resources/niches/client/requests/index.js +1 -0
- package/dist/api/resources/niches/exports.d.ts +2 -0
- package/dist/api/resources/niches/exports.js +3 -0
- package/dist/api/resources/niches/index.d.ts +2 -0
- package/dist/api/resources/niches/index.js +2 -0
- package/dist/api/resources/niches/types/GetNichesRequestMarket.d.ts +6 -0
- package/dist/api/resources/niches/types/GetNichesRequestMarket.js +6 -0
- package/dist/api/resources/niches/types/GetNichesRequestPeriod.d.ts +6 -0
- package/dist/api/resources/niches/types/GetNichesRequestPeriod.js +6 -0
- package/dist/api/resources/niches/types/ListNichesRequestMarket.d.ts +6 -0
- package/dist/api/resources/niches/types/ListNichesRequestMarket.js +6 -0
- package/dist/api/resources/niches/types/ListNichesRequestPeriod.d.ts +6 -0
- package/dist/api/resources/niches/types/ListNichesRequestPeriod.js +6 -0
- package/dist/api/resources/niches/types/ListNichesRequestSort.d.ts +9 -0
- package/dist/api/resources/niches/types/ListNichesRequestSort.js +9 -0
- package/dist/api/resources/niches/types/ProductDistributionsNichesRequestPeriod.d.ts +6 -0
- package/dist/api/resources/niches/types/ProductDistributionsNichesRequestPeriod.js +6 -0
- package/dist/api/resources/niches/types/ProductsNichesRequestMarket.d.ts +6 -0
- package/dist/api/resources/niches/types/ProductsNichesRequestMarket.js +6 -0
- package/dist/api/resources/niches/types/ProductsNichesRequestPeriod.d.ts +6 -0
- package/dist/api/resources/niches/types/ProductsNichesRequestPeriod.js +6 -0
- package/dist/api/resources/niches/types/ProductsNichesRequestSort.d.ts +9 -0
- package/dist/api/resources/niches/types/ProductsNichesRequestSort.js +9 -0
- package/dist/api/resources/niches/types/ReviewHistoryNichesRequestInterval.d.ts +5 -0
- package/dist/api/resources/niches/types/ReviewHistoryNichesRequestInterval.js +5 -0
- package/dist/api/resources/niches/types/ReviewHistoryNichesRequestMarket.d.ts +4 -0
- package/dist/api/resources/niches/types/ReviewHistoryNichesRequestMarket.js +4 -0
- package/dist/api/resources/niches/types/ReviewHistoryNichesRequestPeriod.d.ts +7 -0
- package/dist/api/resources/niches/types/ReviewHistoryNichesRequestPeriod.js +7 -0
- package/dist/api/resources/niches/types/ReviewsNichesRequestMarket.d.ts +4 -0
- package/dist/api/resources/niches/types/ReviewsNichesRequestMarket.js +4 -0
- package/dist/api/resources/niches/types/ReviewsNichesRequestPeriod.d.ts +7 -0
- package/dist/api/resources/niches/types/ReviewsNichesRequestPeriod.js +7 -0
- package/dist/api/resources/niches/types/ReviewsNichesRequestSort.d.ts +7 -0
- package/dist/api/resources/niches/types/ReviewsNichesRequestSort.js +7 -0
- package/dist/api/resources/niches/types/index.d.ts +15 -0
- package/dist/api/resources/niches/types/index.js +15 -0
- package/dist/api/resources/organization/client/Client.d.ts +32 -0
- package/dist/api/resources/organization/client/Client.js +73 -0
- package/dist/api/resources/organization/client/index.d.ts +1 -0
- package/dist/api/resources/organization/client/index.js +1 -0
- package/dist/api/resources/organization/exports.d.ts +2 -0
- package/dist/api/resources/organization/exports.js +3 -0
- package/dist/api/resources/organization/index.d.ts +1 -0
- package/dist/api/resources/organization/index.js +1 -0
- package/dist/api/resources/products/client/Client.d.ts +269 -0
- package/dist/api/resources/products/client/Client.js +927 -0
- package/dist/api/resources/products/client/index.d.ts +1 -0
- package/dist/api/resources/products/client/index.js +1 -0
- package/dist/api/resources/products/client/requests/CategoryRankingsProductsRequest.d.ts +23 -0
- package/dist/api/resources/products/client/requests/CategoryRankingsProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/GetProductsRequest.d.ts +15 -0
- package/dist/api/resources/products/client/requests/GetProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/KeywordRankingsProductsRequest.d.ts +27 -0
- package/dist/api/resources/products/client/requests/KeywordRankingsProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/KeywordsProductsRequest.d.ts +19 -0
- package/dist/api/resources/products/client/requests/KeywordsProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/ListProductsRequest.d.ts +50 -0
- package/dist/api/resources/products/client/requests/ListProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/ReviewSummaryProductsRequest.d.ts +8 -0
- package/dist/api/resources/products/client/requests/ReviewSummaryProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/ReviewsProductsRequest.d.ts +35 -0
- package/dist/api/resources/products/client/requests/ReviewsProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/SalesHistoryProductsRequest.d.ts +23 -0
- package/dist/api/resources/products/client/requests/SalesHistoryProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/SellersProductsRequest.d.ts +16 -0
- package/dist/api/resources/products/client/requests/SellersProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/VisibilityHistoryProductsRequest.d.ts +23 -0
- package/dist/api/resources/products/client/requests/VisibilityHistoryProductsRequest.js +2 -0
- package/dist/api/resources/products/client/requests/index.d.ts +10 -0
- package/dist/api/resources/products/client/requests/index.js +1 -0
- package/dist/api/resources/products/exports.d.ts +2 -0
- package/dist/api/resources/products/exports.js +3 -0
- package/dist/api/resources/products/index.d.ts +2 -0
- package/dist/api/resources/products/index.js +2 -0
- package/dist/api/resources/products/types/CategoryRankingsProductsRequestInterval.d.ts +5 -0
- package/dist/api/resources/products/types/CategoryRankingsProductsRequestInterval.js +5 -0
- package/dist/api/resources/products/types/CategoryRankingsProductsRequestMarket.d.ts +6 -0
- package/dist/api/resources/products/types/CategoryRankingsProductsRequestMarket.js +6 -0
- package/dist/api/resources/products/types/CategoryRankingsProductsRequestPeriod.d.ts +7 -0
- package/dist/api/resources/products/types/CategoryRankingsProductsRequestPeriod.js +7 -0
- package/dist/api/resources/products/types/GetProductsRequestMarket.d.ts +6 -0
- package/dist/api/resources/products/types/GetProductsRequestMarket.js +6 -0
- package/dist/api/resources/products/types/GetProductsRequestPeriod.d.ts +6 -0
- package/dist/api/resources/products/types/GetProductsRequestPeriod.js +6 -0
- package/dist/api/resources/products/types/KeywordRankingsProductsRequestInterval.d.ts +5 -0
- package/dist/api/resources/products/types/KeywordRankingsProductsRequestInterval.js +5 -0
- package/dist/api/resources/products/types/KeywordRankingsProductsRequestMarket.d.ts +6 -0
- package/dist/api/resources/products/types/KeywordRankingsProductsRequestMarket.js +6 -0
- package/dist/api/resources/products/types/KeywordRankingsProductsRequestPeriod.d.ts +7 -0
- package/dist/api/resources/products/types/KeywordRankingsProductsRequestPeriod.js +7 -0
- package/dist/api/resources/products/types/KeywordsProductsRequestMarket.d.ts +6 -0
- package/dist/api/resources/products/types/KeywordsProductsRequestMarket.js +6 -0
- package/dist/api/resources/products/types/KeywordsProductsRequestPeriod.d.ts +6 -0
- package/dist/api/resources/products/types/KeywordsProductsRequestPeriod.js +6 -0
- package/dist/api/resources/products/types/ListProductsRequestMarket.d.ts +6 -0
- package/dist/api/resources/products/types/ListProductsRequestMarket.js +6 -0
- package/dist/api/resources/products/types/ListProductsRequestPeriod.d.ts +6 -0
- package/dist/api/resources/products/types/ListProductsRequestPeriod.js +6 -0
- package/dist/api/resources/products/types/ListProductsRequestSort.d.ts +9 -0
- package/dist/api/resources/products/types/ListProductsRequestSort.js +9 -0
- package/dist/api/resources/products/types/ReviewsProductsRequestMarket.d.ts +4 -0
- package/dist/api/resources/products/types/ReviewsProductsRequestMarket.js +4 -0
- package/dist/api/resources/products/types/ReviewsProductsRequestPeriod.d.ts +7 -0
- package/dist/api/resources/products/types/ReviewsProductsRequestPeriod.js +7 -0
- package/dist/api/resources/products/types/ReviewsProductsRequestSort.d.ts +7 -0
- package/dist/api/resources/products/types/ReviewsProductsRequestSort.js +7 -0
- package/dist/api/resources/products/types/SalesHistoryProductsRequestInterval.d.ts +5 -0
- package/dist/api/resources/products/types/SalesHistoryProductsRequestInterval.js +5 -0
- package/dist/api/resources/products/types/SalesHistoryProductsRequestMarket.d.ts +6 -0
- package/dist/api/resources/products/types/SalesHistoryProductsRequestMarket.js +6 -0
- package/dist/api/resources/products/types/SalesHistoryProductsRequestPeriod.d.ts +7 -0
- package/dist/api/resources/products/types/SalesHistoryProductsRequestPeriod.js +7 -0
- package/dist/api/resources/products/types/SellersProductsRequestMarket.d.ts +6 -0
- package/dist/api/resources/products/types/SellersProductsRequestMarket.js +6 -0
- package/dist/api/resources/products/types/SellersProductsRequestPeriod.d.ts +7 -0
- package/dist/api/resources/products/types/SellersProductsRequestPeriod.js +7 -0
- package/dist/api/resources/products/types/VisibilityHistoryProductsRequestInterval.d.ts +5 -0
- package/dist/api/resources/products/types/VisibilityHistoryProductsRequestInterval.js +5 -0
- package/dist/api/resources/products/types/VisibilityHistoryProductsRequestMarket.d.ts +6 -0
- package/dist/api/resources/products/types/VisibilityHistoryProductsRequestMarket.js +6 -0
- package/dist/api/resources/products/types/VisibilityHistoryProductsRequestPeriod.d.ts +7 -0
- package/dist/api/resources/products/types/VisibilityHistoryProductsRequestPeriod.js +7 -0
- package/dist/api/resources/products/types/index.d.ts +24 -0
- package/dist/api/resources/products/types/index.js +24 -0
- package/dist/api/resources/reference/client/Client.d.ts +84 -0
- package/dist/api/resources/reference/client/Client.js +254 -0
- package/dist/api/resources/reference/client/index.d.ts +1 -0
- package/dist/api/resources/reference/client/index.js +1 -0
- package/dist/api/resources/reference/client/requests/BrandsReferenceRequest.d.ts +12 -0
- package/dist/api/resources/reference/client/requests/BrandsReferenceRequest.js +2 -0
- package/dist/api/resources/reference/client/requests/CategoriesReferenceRequest.d.ts +18 -0
- package/dist/api/resources/reference/client/requests/CategoriesReferenceRequest.js +2 -0
- package/dist/api/resources/reference/client/requests/CategoryReferenceRequest.d.ts +5 -0
- package/dist/api/resources/reference/client/requests/CategoryReferenceRequest.js +2 -0
- package/dist/api/resources/reference/client/requests/index.d.ts +3 -0
- package/dist/api/resources/reference/client/requests/index.js +1 -0
- package/dist/api/resources/reference/exports.d.ts +2 -0
- package/dist/api/resources/reference/exports.js +3 -0
- package/dist/api/resources/reference/index.d.ts +1 -0
- package/dist/api/resources/reference/index.js +1 -0
- package/dist/api/resources/store/client/Client.d.ts +82 -0
- package/dist/api/resources/store/client/Client.js +291 -0
- package/dist/api/resources/store/client/index.d.ts +1 -0
- package/dist/api/resources/store/client/index.js +1 -0
- package/dist/api/resources/store/client/requests/InventoryStoreRequest.d.ts +23 -0
- package/dist/api/resources/store/client/requests/InventoryStoreRequest.js +2 -0
- package/dist/api/resources/store/client/requests/OverviewStoreRequest.d.ts +13 -0
- package/dist/api/resources/store/client/requests/OverviewStoreRequest.js +2 -0
- package/dist/api/resources/store/client/requests/ProductsStoreRequest.d.ts +49 -0
- package/dist/api/resources/store/client/requests/ProductsStoreRequest.js +2 -0
- package/dist/api/resources/store/client/requests/index.d.ts +3 -0
- package/dist/api/resources/store/client/requests/index.js +1 -0
- package/dist/api/resources/store/exports.d.ts +2 -0
- package/dist/api/resources/store/exports.js +3 -0
- package/dist/api/resources/store/index.d.ts +2 -0
- package/dist/api/resources/store/index.js +2 -0
- package/dist/api/resources/store/types/InventoryStoreRequestStockState.d.ts +6 -0
- package/dist/api/resources/store/types/InventoryStoreRequestStockState.js +6 -0
- package/dist/api/resources/store/types/OverviewStoreRequestCountry.d.ts +6 -0
- package/dist/api/resources/store/types/OverviewStoreRequestCountry.js +6 -0
- package/dist/api/resources/store/types/ProductsStoreRequestCountry.d.ts +5 -0
- package/dist/api/resources/store/types/ProductsStoreRequestCountry.js +5 -0
- package/dist/api/resources/store/types/ProductsStoreRequestSort.d.ts +11 -0
- package/dist/api/resources/store/types/ProductsStoreRequestSort.js +11 -0
- package/dist/api/resources/store/types/index.d.ts +4 -0
- package/dist/api/resources/store/types/index.js +4 -0
- package/dist/api/resources/usage/client/Client.d.ts +32 -0
- package/dist/api/resources/usage/client/Client.js +73 -0
- package/dist/api/resources/usage/client/index.d.ts +1 -0
- package/dist/api/resources/usage/client/index.js +1 -0
- package/dist/api/resources/usage/exports.d.ts +2 -0
- package/dist/api/resources/usage/exports.js +3 -0
- package/dist/api/resources/usage/index.d.ts +1 -0
- package/dist/api/resources/usage/index.js +1 -0
- package/dist/api/types/AllowanceError.d.ts +26 -0
- package/dist/api/types/AllowanceError.js +16 -0
- package/dist/api/types/Brand.d.ts +4 -0
- package/dist/api/types/Brand.js +2 -0
- package/dist/api/types/BrandListResponse.d.ts +6 -0
- package/dist/api/types/BrandListResponse.js +2 -0
- package/dist/api/types/BundleUsage.d.ts +15 -0
- package/dist/api/types/BundleUsage.js +2 -0
- package/dist/api/types/Category.d.ts +14 -0
- package/dist/api/types/Category.js +2 -0
- package/dist/api/types/CategoryItem.d.ts +4 -0
- package/dist/api/types/CategoryItem.js +2 -0
- package/dist/api/types/CategoryListResponse.d.ts +5 -0
- package/dist/api/types/CategoryListResponse.js +2 -0
- package/dist/api/types/CategoryPathItem.d.ts +4 -0
- package/dist/api/types/CategoryPathItem.js +2 -0
- package/dist/api/types/CategoryRanking.d.ts +5 -0
- package/dist/api/types/CategoryRanking.js +2 -0
- package/dist/api/types/CategoryRankingsResponse.d.ts +7 -0
- package/dist/api/types/CategoryRankingsResponse.js +2 -0
- package/dist/api/types/CategoryResponse.d.ts +4 -0
- package/dist/api/types/CategoryResponse.js +2 -0
- package/dist/api/types/CommissionBracket.d.ts +8 -0
- package/dist/api/types/CommissionBracket.js +2 -0
- package/dist/api/types/CurrentPeriod.d.ts +8 -0
- package/dist/api/types/CurrentPeriod.js +2 -0
- package/dist/api/types/Dimensions.d.ts +8 -0
- package/dist/api/types/Dimensions.js +2 -0
- package/dist/api/types/DistributionBucket.d.ts +5 -0
- package/dist/api/types/DistributionBucket.js +2 -0
- package/dist/api/types/DistributionData.d.ts +7 -0
- package/dist/api/types/DistributionData.js +2 -0
- package/dist/api/types/FreeTierUsage.d.ts +12 -0
- package/dist/api/types/FreeTierUsage.js +2 -0
- package/dist/api/types/KeywordItem.d.ts +6 -0
- package/dist/api/types/KeywordItem.js +2 -0
- package/dist/api/types/KeywordMarkets.d.ts +5 -0
- package/dist/api/types/KeywordMarkets.js +2 -0
- package/dist/api/types/KeywordMetrics.d.ts +4 -0
- package/dist/api/types/KeywordMetrics.js +2 -0
- package/dist/api/types/KeywordRanking.d.ts +7 -0
- package/dist/api/types/KeywordRanking.js +2 -0
- package/dist/api/types/KeywordRankingsResponse.d.ts +7 -0
- package/dist/api/types/KeywordRankingsResponse.js +2 -0
- package/dist/api/types/KeywordResponse.d.ts +7 -0
- package/dist/api/types/KeywordResponse.js +2 -0
- package/dist/api/types/ListingChanges.d.ts +5 -0
- package/dist/api/types/ListingChanges.js +2 -0
- package/dist/api/types/NicheDetail.d.ts +12 -0
- package/dist/api/types/NicheDetail.js +2 -0
- package/dist/api/types/NicheDetailResponse.d.ts +6 -0
- package/dist/api/types/NicheDetailResponse.js +2 -0
- package/dist/api/types/NicheDistributionsResponse.d.ts +5 -0
- package/dist/api/types/NicheDistributionsResponse.js +2 -0
- package/dist/api/types/NicheHistoryData.d.ts +4 -0
- package/dist/api/types/NicheHistoryData.js +2 -0
- package/dist/api/types/NicheHistoryResponse.d.ts +7 -0
- package/dist/api/types/NicheHistoryResponse.js +2 -0
- package/dist/api/types/NicheItem.d.ts +11 -0
- package/dist/api/types/NicheItem.js +2 -0
- package/dist/api/types/NicheListResponse.d.ts +7 -0
- package/dist/api/types/NicheListResponse.js +2 -0
- package/dist/api/types/NicheMarkets.d.ts +5 -0
- package/dist/api/types/NicheMarkets.js +2 -0
- package/dist/api/types/NicheMetrics.d.ts +5 -0
- package/dist/api/types/NicheMetrics.js +2 -0
- package/dist/api/types/NichePeriod.d.ts +5 -0
- package/dist/api/types/NichePeriod.js +2 -0
- package/dist/api/types/OauthScope.d.ts +9 -0
- package/dist/api/types/OauthScope.js +9 -0
- package/dist/api/types/Organization.d.ts +4 -0
- package/dist/api/types/Organization.js +2 -0
- package/dist/api/types/Pagination.d.ts +6 -0
- package/dist/api/types/Pagination.js +2 -0
- package/dist/api/types/Period.d.ts +5 -0
- package/dist/api/types/Period.js +2 -0
- package/dist/api/types/PeriodRatings.d.ts +7 -0
- package/dist/api/types/PeriodRatings.js +2 -0
- package/dist/api/types/PeriodReviews.d.ts +9 -0
- package/dist/api/types/PeriodReviews.js +2 -0
- package/dist/api/types/ProductDetail.d.ts +29 -0
- package/dist/api/types/ProductDetail.js +2 -0
- package/dist/api/types/ProductDetailResponse.d.ts +24 -0
- package/dist/api/types/ProductDetailResponse.js +14 -0
- package/dist/api/types/ProductDistributions.d.ts +6 -0
- package/dist/api/types/ProductDistributions.js +2 -0
- package/dist/api/types/ProductItem.d.ts +27 -0
- package/dist/api/types/ProductItem.js +2 -0
- package/dist/api/types/ProductListResponse.d.ts +25 -0
- package/dist/api/types/ProductListResponse.js +14 -0
- package/dist/api/types/ProductMarketMetrics.d.ts +11 -0
- package/dist/api/types/ProductMarketMetrics.js +2 -0
- package/dist/api/types/ProductMarkets.d.ts +5 -0
- package/dist/api/types/ProductMarkets.js +2 -0
- package/dist/api/types/PublicApiError.d.ts +4 -0
- package/dist/api/types/PublicApiError.js +2 -0
- package/dist/api/types/RankMarkets.d.ts +4 -0
- package/dist/api/types/RankMarkets.js +2 -0
- package/dist/api/types/RankPoint.d.ts +5 -0
- package/dist/api/types/RankPoint.js +2 -0
- package/dist/api/types/RatingCount.d.ts +5 -0
- package/dist/api/types/RatingCount.js +2 -0
- package/dist/api/types/ResearchError.d.ts +6 -0
- package/dist/api/types/ResearchError.js +2 -0
- package/dist/api/types/ReviewHistoryPoint.d.ts +6 -0
- package/dist/api/types/ReviewHistoryPoint.js +2 -0
- package/dist/api/types/ReviewItem.d.ts +12 -0
- package/dist/api/types/ReviewItem.js +2 -0
- package/dist/api/types/ReviewListResponse.d.ts +7 -0
- package/dist/api/types/ReviewListResponse.js +2 -0
- package/dist/api/types/ReviewSummary.d.ts +10 -0
- package/dist/api/types/ReviewSummary.js +2 -0
- package/dist/api/types/ReviewSummaryResponse.d.ts +5 -0
- package/dist/api/types/ReviewSummaryResponse.js +2 -0
- package/dist/api/types/ReviewTopic.d.ts +4 -0
- package/dist/api/types/ReviewTopic.js +2 -0
- package/dist/api/types/SalesHistoryMarkets.d.ts +5 -0
- package/dist/api/types/SalesHistoryMarkets.js +2 -0
- package/dist/api/types/SalesHistoryMetrics.d.ts +5 -0
- package/dist/api/types/SalesHistoryMetrics.js +2 -0
- package/dist/api/types/SalesHistoryPoint.d.ts +5 -0
- package/dist/api/types/SalesHistoryPoint.js +2 -0
- package/dist/api/types/SalesHistoryResponse.d.ts +7 -0
- package/dist/api/types/SalesHistoryResponse.js +2 -0
- package/dist/api/types/SellerItem.d.ts +8 -0
- package/dist/api/types/SellerItem.js +2 -0
- package/dist/api/types/SellerMarkets.d.ts +5 -0
- package/dist/api/types/SellerMarkets.js +2 -0
- package/dist/api/types/SellerMetrics.d.ts +7 -0
- package/dist/api/types/SellerMetrics.js +2 -0
- package/dist/api/types/SellerResponse.d.ts +9 -0
- package/dist/api/types/SellerResponse.js +2 -0
- package/dist/api/types/SellerSummaryMarkets.d.ts +5 -0
- package/dist/api/types/SellerSummaryMarkets.js +2 -0
- package/dist/api/types/SellerSummaryMetrics.d.ts +6 -0
- package/dist/api/types/SellerSummaryMetrics.js +2 -0
- package/dist/api/types/StoreChange.d.ts +9 -0
- package/dist/api/types/StoreChange.js +2 -0
- package/dist/api/types/StoreError.d.ts +5 -0
- package/dist/api/types/StoreError.js +2 -0
- package/dist/api/types/StoreFilters.d.ts +3 -0
- package/dist/api/types/StoreFilters.js +2 -0
- package/dist/api/types/StoreInventoryCounts.d.ts +7 -0
- package/dist/api/types/StoreInventoryCounts.js +2 -0
- package/dist/api/types/StoreInventoryFilters.d.ts +4 -0
- package/dist/api/types/StoreInventoryFilters.js +2 -0
- package/dist/api/types/StoreInventoryPagination.d.ts +7 -0
- package/dist/api/types/StoreInventoryPagination.js +2 -0
- package/dist/api/types/StoreInventoryResponse.d.ts +28 -0
- package/dist/api/types/StoreInventoryResponse.js +14 -0
- package/dist/api/types/StoreInventoryRow.d.ts +35 -0
- package/dist/api/types/StoreInventoryRow.js +18 -0
- package/dist/api/types/StoreKpi.d.ts +12 -0
- package/dist/api/types/StoreKpi.js +2 -0
- package/dist/api/types/StoreOverviewResponse.d.ts +13 -0
- package/dist/api/types/StoreOverviewResponse.js +2 -0
- package/dist/api/types/StorePerformanceProductPerformanceItem.d.ts +48 -0
- package/dist/api/types/StorePerformanceProductPerformanceItem.js +2 -0
- package/dist/api/types/StorePerformanceReturnCostsBreakdown.d.ts +10 -0
- package/dist/api/types/StorePerformanceReturnCostsBreakdown.js +2 -0
- package/dist/api/types/StorePerformanceSalesCostsBreakdown.d.ts +10 -0
- package/dist/api/types/StorePerformanceSalesCostsBreakdown.js +2 -0
- package/dist/api/types/StorePreviousKpi.d.ts +9 -0
- package/dist/api/types/StorePreviousKpi.js +2 -0
- package/dist/api/types/StoreProductsFilters.d.ts +5 -0
- package/dist/api/types/StoreProductsFilters.js +2 -0
- package/dist/api/types/StoreProductsPagination.d.ts +9 -0
- package/dist/api/types/StoreProductsPagination.js +2 -0
- package/dist/api/types/StoreProductsResponse.d.ts +11 -0
- package/dist/api/types/StoreProductsResponse.js +2 -0
- package/dist/api/types/UnauthorizedErrorBody.d.ts +3 -0
- package/dist/api/types/UnauthorizedErrorBody.js +2 -0
- package/dist/api/types/Usage.d.ts +51 -0
- package/dist/api/types/Usage.js +28 -0
- package/dist/api/types/UsageOrganization.d.ts +4 -0
- package/dist/api/types/UsageOrganization.js +2 -0
- package/dist/api/types/VisibilityHistoryResponse.d.ts +7 -0
- package/dist/api/types/VisibilityHistoryResponse.js +2 -0
- package/dist/api/types/VisibilityMarkets.d.ts +5 -0
- package/dist/api/types/VisibilityMarkets.js +2 -0
- package/dist/api/types/VisibilityMetrics.d.ts +4 -0
- package/dist/api/types/VisibilityMetrics.js +2 -0
- package/dist/api/types/VisibilityPoint.d.ts +5 -0
- package/dist/api/types/VisibilityPoint.js +2 -0
- package/dist/api/types/index.d.ts +92 -0
- package/dist/api/types/index.js +92 -0
- package/dist/auth/BearerAuthProvider.d.ts +20 -0
- package/dist/auth/BearerAuthProvider.js +32 -0
- package/dist/auth/index.d.ts +1 -0
- package/dist/auth/index.js +1 -0
- package/dist/core/auth/AuthProvider.d.ts +8 -0
- package/dist/core/auth/AuthProvider.js +6 -0
- package/dist/core/auth/AuthRequest.d.ts +9 -0
- package/dist/core/auth/AuthRequest.js +1 -0
- package/dist/core/auth/BasicAuth.d.ts +8 -0
- package/dist/core/auth/BasicAuth.js +29 -0
- package/dist/core/auth/BearerToken.d.ts +7 -0
- package/dist/core/auth/BearerToken.js +13 -0
- package/dist/core/auth/NoOpAuthProvider.d.ts +5 -0
- package/dist/core/auth/NoOpAuthProvider.js +5 -0
- package/dist/core/auth/index.d.ts +5 -0
- package/dist/core/auth/index.js +4 -0
- package/dist/core/base64.d.ts +2 -0
- package/dist/core/base64.js +22 -0
- package/dist/core/exports.d.ts +2 -0
- package/dist/core/exports.js +2 -0
- package/dist/core/fetcher/APIResponse.d.ts +20 -0
- package/dist/core/fetcher/APIResponse.js +1 -0
- package/dist/core/fetcher/BinaryResponse.d.ts +19 -0
- package/dist/core/fetcher/BinaryResponse.js +14 -0
- package/dist/core/fetcher/EndpointMetadata.d.ts +13 -0
- package/dist/core/fetcher/EndpointMetadata.js +1 -0
- package/dist/core/fetcher/EndpointSupplier.d.ts +12 -0
- package/dist/core/fetcher/EndpointSupplier.js +10 -0
- package/dist/core/fetcher/Fetcher.d.ts +56 -0
- package/dist/core/fetcher/Fetcher.js +254 -0
- package/dist/core/fetcher/Headers.d.ts +2 -0
- package/dist/core/fetcher/Headers.js +83 -0
- package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/core/fetcher/HttpResponsePromise.js +90 -0
- package/dist/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/core/fetcher/RawResponse.js +40 -0
- package/dist/core/fetcher/Supplier.d.ts +4 -0
- package/dist/core/fetcher/Supplier.js +10 -0
- package/dist/core/fetcher/createRequestUrl.d.ts +1 -0
- package/dist/core/fetcher/createRequestUrl.js +5 -0
- package/dist/core/fetcher/getErrorResponseBody.d.ts +1 -0
- package/dist/core/fetcher/getErrorResponseBody.js +43 -0
- package/dist/core/fetcher/getFetchFn.d.ts +1 -0
- package/dist/core/fetcher/getFetchFn.js +3 -0
- package/dist/core/fetcher/getHeader.d.ts +1 -0
- package/dist/core/fetcher/getHeader.js +8 -0
- package/dist/core/fetcher/getRequestBody.d.ts +7 -0
- package/dist/core/fetcher/getRequestBody.js +13 -0
- package/dist/core/fetcher/getResponseBody.d.ts +17 -0
- package/dist/core/fetcher/getResponseBody.js +70 -0
- package/dist/core/fetcher/index.d.ts +13 -0
- package/dist/core/fetcher/index.js +7 -0
- package/dist/core/fetcher/makePassthroughRequest.d.ts +49 -0
- package/dist/core/fetcher/makePassthroughRequest.js +157 -0
- package/dist/core/fetcher/makeRequest.d.ts +11 -0
- package/dist/core/fetcher/makeRequest.js +85 -0
- package/dist/core/fetcher/redactUrl.d.ts +2 -0
- package/dist/core/fetcher/redactUrl.js +84 -0
- package/dist/core/fetcher/requestWithRetries.d.ts +1 -0
- package/dist/core/fetcher/requestWithRetries.js +77 -0
- package/dist/core/fetcher/signals.d.ts +6 -0
- package/dist/core/fetcher/signals.js +28 -0
- package/dist/core/headers.d.ts +2 -0
- package/dist/core/headers.js +27 -0
- package/dist/core/index.d.ts +8 -0
- package/dist/core/index.js +8 -0
- package/dist/core/json.d.ts +15 -0
- package/dist/core/json.js +19 -0
- package/dist/core/logging/exports.d.ts +18 -0
- package/dist/core/logging/exports.js +9 -0
- package/dist/core/logging/index.d.ts +1 -0
- package/dist/core/logging/index.js +1 -0
- package/dist/core/logging/logger.d.ts +126 -0
- package/dist/core/logging/logger.js +140 -0
- package/dist/core/pagination/Page.d.ts +33 -0
- package/dist/core/pagination/Page.js +55 -0
- package/dist/core/pagination/exports.d.ts +1 -0
- package/dist/core/pagination/exports.js +1 -0
- package/dist/core/pagination/index.d.ts +1 -0
- package/dist/core/pagination/index.js +1 -0
- package/dist/core/requestBody.d.ts +12 -0
- package/dist/core/requestBody.js +23 -0
- package/dist/core/runtime/index.d.ts +1 -0
- package/dist/core/runtime/index.js +1 -0
- package/dist/core/runtime/runtime.d.ts +28 -0
- package/dist/core/runtime/runtime.js +171 -0
- package/dist/core/url/QueryStringBuilder.d.ts +47 -0
- package/dist/core/url/QueryStringBuilder.js +78 -0
- package/dist/core/url/encodePathParam.d.ts +3 -0
- package/dist/core/url/encodePathParam.js +24 -0
- package/dist/core/url/index.d.ts +4 -0
- package/dist/core/url/index.js +4 -0
- package/dist/core/url/join.d.ts +1 -0
- package/dist/core/url/join.js +65 -0
- package/dist/core/url/qs.d.ts +7 -0
- package/dist/core/url/qs.js +76 -0
- package/dist/core/utils/index.d.ts +1 -0
- package/dist/core/utils/index.js +1 -0
- package/dist/core/utils/setObjectProperty.d.ts +12 -0
- package/dist/core/utils/setObjectProperty.js +45 -0
- package/dist/environments.d.ts +4 -0
- package/dist/environments.js +4 -0
- package/dist/errors/MarktMentorError.d.ts +15 -0
- package/dist/errors/MarktMentorError.js +52 -0
- package/dist/errors/MarktMentorTimeoutError.d.ts +6 -0
- package/dist/errors/MarktMentorTimeoutError.js +15 -0
- package/dist/errors/handleNonStatusCodeError.d.ts +2 -0
- package/dist/errors/handleNonStatusCodeError.js +32 -0
- package/dist/errors/index.d.ts +2 -0
- package/dist/errors/index.js +2 -0
- package/dist/exports.d.ts +1 -0
- package/dist/exports.js +1 -0
- package/dist/index.d.ts +6 -0
- package/dist/index.js +5 -0
- package/package.json +33 -4
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
|
|
3
|
+
import * as core from "../../../../core/index.js";
|
|
4
|
+
import * as MarktMentor from "../../../index.js";
|
|
5
|
+
export declare namespace StoreClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Read the data of your own connected bol store: store performance, performance per product and stock per product. Each call gives one kind of data. Needs an API key or OAuth with store:read, a connected store and the Pro plan or higher. Store requests are free: they do not count toward the API bundle. Limit: 60 requests per minute per organization.
|
|
12
|
+
*/
|
|
13
|
+
export declare class StoreClient {
|
|
14
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<StoreClient.Options>;
|
|
15
|
+
constructor(options: StoreClient.Options);
|
|
16
|
+
/**
|
|
17
|
+
* Get the revenue, costs, profit, orders, sales and returns of your own connected bol store for a period, compared with the period before.
|
|
18
|
+
*
|
|
19
|
+
* This request is free: it does not count as a research request.
|
|
20
|
+
*
|
|
21
|
+
* @param {MarktMentor.OverviewStoreRequest} request
|
|
22
|
+
* @param {StoreClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
23
|
+
*
|
|
24
|
+
* @throws {@link MarktMentor.BadRequestError}
|
|
25
|
+
* @throws {@link MarktMentor.UnauthorizedError}
|
|
26
|
+
* @throws {@link MarktMentor.ForbiddenError}
|
|
27
|
+
* @throws {@link MarktMentor.ConflictError}
|
|
28
|
+
* @throws {@link MarktMentor.TooManyRequestsError}
|
|
29
|
+
* @throws {@link MarktMentor.ServiceUnavailableError}
|
|
30
|
+
* @throws {@link errors.MarktMentorError}
|
|
31
|
+
* @throws {@link errors.MarktMentorTimeoutError}
|
|
32
|
+
*
|
|
33
|
+
* @example
|
|
34
|
+
* await client.store.overview()
|
|
35
|
+
*/
|
|
36
|
+
overview(request?: MarktMentor.OverviewStoreRequest, requestOptions?: StoreClient.RequestOptions): core.HttpResponsePromise<MarktMentor.StoreOverviewResponse>;
|
|
37
|
+
private __overview;
|
|
38
|
+
/**
|
|
39
|
+
* List the products of your own connected bol store that had orders in the period, with sales, revenue, costs and profit per product.
|
|
40
|
+
*
|
|
41
|
+
* This request is free: it does not count as a research request.
|
|
42
|
+
*
|
|
43
|
+
* @param {MarktMentor.ProductsStoreRequest} request
|
|
44
|
+
* @param {StoreClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link MarktMentor.BadRequestError}
|
|
47
|
+
* @throws {@link MarktMentor.UnauthorizedError}
|
|
48
|
+
* @throws {@link MarktMentor.ForbiddenError}
|
|
49
|
+
* @throws {@link MarktMentor.ConflictError}
|
|
50
|
+
* @throws {@link MarktMentor.TooManyRequestsError}
|
|
51
|
+
* @throws {@link MarktMentor.ServiceUnavailableError}
|
|
52
|
+
* @throws {@link errors.MarktMentorError}
|
|
53
|
+
* @throws {@link errors.MarktMentorTimeoutError}
|
|
54
|
+
*
|
|
55
|
+
* @example
|
|
56
|
+
* await client.store.products()
|
|
57
|
+
*/
|
|
58
|
+
products(request?: MarktMentor.ProductsStoreRequest, requestOptions?: StoreClient.RequestOptions): Promise<core.Page<MarktMentor.StorePerformanceProductPerformanceItem, MarktMentor.StoreProductsResponse>>;
|
|
59
|
+
/**
|
|
60
|
+
* List the active products of your own connected bol store with their stock and stock state.
|
|
61
|
+
*
|
|
62
|
+
* This request is free: it does not count as a research request.
|
|
63
|
+
*
|
|
64
|
+
* @param {MarktMentor.InventoryStoreRequest} request
|
|
65
|
+
* @param {StoreClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link MarktMentor.BadRequestError}
|
|
68
|
+
* @throws {@link MarktMentor.UnauthorizedError}
|
|
69
|
+
* @throws {@link MarktMentor.ForbiddenError}
|
|
70
|
+
* @throws {@link MarktMentor.ConflictError}
|
|
71
|
+
* @throws {@link MarktMentor.TooManyRequestsError}
|
|
72
|
+
* @throws {@link MarktMentor.ServiceUnavailableError}
|
|
73
|
+
* @throws {@link errors.MarktMentorError}
|
|
74
|
+
* @throws {@link errors.MarktMentorTimeoutError}
|
|
75
|
+
*
|
|
76
|
+
* @example
|
|
77
|
+
* await client.store.inventory({
|
|
78
|
+
* ean: "5407005143414"
|
|
79
|
+
* })
|
|
80
|
+
*/
|
|
81
|
+
inventory(request?: MarktMentor.InventoryStoreRequest, requestOptions?: StoreClient.RequestOptions): Promise<core.Page<MarktMentor.StoreInventoryRow, MarktMentor.StoreInventoryResponse>>;
|
|
82
|
+
}
|
|
@@ -0,0 +1,291 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
|
|
3
|
+
import { mergeHeaders } from "../../../../core/headers.js";
|
|
4
|
+
import * as core from "../../../../core/index.js";
|
|
5
|
+
import * as environments from "../../../../environments.js";
|
|
6
|
+
import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
|
|
7
|
+
import * as errors from "../../../../errors/index.js";
|
|
8
|
+
import * as MarktMentor from "../../../index.js";
|
|
9
|
+
/**
|
|
10
|
+
* Read the data of your own connected bol store: store performance, performance per product and stock per product. Each call gives one kind of data. Needs an API key or OAuth with store:read, a connected store and the Pro plan or higher. Store requests are free: they do not count toward the API bundle. Limit: 60 requests per minute per organization.
|
|
11
|
+
*/
|
|
12
|
+
export class StoreClient {
|
|
13
|
+
_options;
|
|
14
|
+
constructor(options) {
|
|
15
|
+
this._options = normalizeClientOptionsWithAuth(options);
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* Get the revenue, costs, profit, orders, sales and returns of your own connected bol store for a period, compared with the period before.
|
|
19
|
+
*
|
|
20
|
+
* This request is free: it does not count as a research request.
|
|
21
|
+
*
|
|
22
|
+
* @param {MarktMentor.OverviewStoreRequest} request
|
|
23
|
+
* @param {StoreClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
24
|
+
*
|
|
25
|
+
* @throws {@link MarktMentor.BadRequestError}
|
|
26
|
+
* @throws {@link MarktMentor.UnauthorizedError}
|
|
27
|
+
* @throws {@link MarktMentor.ForbiddenError}
|
|
28
|
+
* @throws {@link MarktMentor.ConflictError}
|
|
29
|
+
* @throws {@link MarktMentor.TooManyRequestsError}
|
|
30
|
+
* @throws {@link MarktMentor.ServiceUnavailableError}
|
|
31
|
+
* @throws {@link errors.MarktMentorError}
|
|
32
|
+
* @throws {@link errors.MarktMentorTimeoutError}
|
|
33
|
+
*
|
|
34
|
+
* @example
|
|
35
|
+
* await client.store.overview()
|
|
36
|
+
*/
|
|
37
|
+
overview(request = {}, requestOptions) {
|
|
38
|
+
return core.HttpResponsePromise.fromPromise(this.__overview(request, requestOptions));
|
|
39
|
+
}
|
|
40
|
+
async __overview(request = {}, requestOptions) {
|
|
41
|
+
const { country, days } = request;
|
|
42
|
+
const _queryParams = {
|
|
43
|
+
country: country != null ? country : undefined,
|
|
44
|
+
days,
|
|
45
|
+
};
|
|
46
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
47
|
+
const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
48
|
+
const _response = await core.fetcher({
|
|
49
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
50
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
51
|
+
environments.MarktMentorEnvironment.Production, "api/public/v1/store/overview/"),
|
|
52
|
+
method: "GET",
|
|
53
|
+
headers: _headers,
|
|
54
|
+
queryString: core.url
|
|
55
|
+
.queryBuilder()
|
|
56
|
+
.addMany(_queryParams)
|
|
57
|
+
.mergeAdditional(requestOptions?.queryParams)
|
|
58
|
+
.build(),
|
|
59
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
60
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
61
|
+
abortSignal: requestOptions?.abortSignal,
|
|
62
|
+
fetchFn: this._options?.fetch,
|
|
63
|
+
logging: this._options.logging,
|
|
64
|
+
});
|
|
65
|
+
if (_response.ok) {
|
|
66
|
+
return { data: _response.body, rawResponse: _response.rawResponse };
|
|
67
|
+
}
|
|
68
|
+
if (_response.error.reason === "status-code") {
|
|
69
|
+
switch (_response.error.statusCode) {
|
|
70
|
+
case 400:
|
|
71
|
+
throw new MarktMentor.BadRequestError(_response.error.body, _response.rawResponse);
|
|
72
|
+
case 401:
|
|
73
|
+
throw new MarktMentor.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
74
|
+
case 403:
|
|
75
|
+
throw new MarktMentor.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
76
|
+
case 409:
|
|
77
|
+
throw new MarktMentor.ConflictError(_response.error.body, _response.rawResponse);
|
|
78
|
+
case 429:
|
|
79
|
+
throw new MarktMentor.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
80
|
+
case 503:
|
|
81
|
+
throw new MarktMentor.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
82
|
+
default:
|
|
83
|
+
throw new errors.MarktMentorError({
|
|
84
|
+
statusCode: _response.error.statusCode,
|
|
85
|
+
body: _response.error.body,
|
|
86
|
+
rawResponse: _response.rawResponse,
|
|
87
|
+
});
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/api/public/v1/store/overview/");
|
|
91
|
+
}
|
|
92
|
+
/**
|
|
93
|
+
* List the products of your own connected bol store that had orders in the period, with sales, revenue, costs and profit per product.
|
|
94
|
+
*
|
|
95
|
+
* This request is free: it does not count as a research request.
|
|
96
|
+
*
|
|
97
|
+
* @param {MarktMentor.ProductsStoreRequest} request
|
|
98
|
+
* @param {StoreClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link MarktMentor.BadRequestError}
|
|
101
|
+
* @throws {@link MarktMentor.UnauthorizedError}
|
|
102
|
+
* @throws {@link MarktMentor.ForbiddenError}
|
|
103
|
+
* @throws {@link MarktMentor.ConflictError}
|
|
104
|
+
* @throws {@link MarktMentor.TooManyRequestsError}
|
|
105
|
+
* @throws {@link MarktMentor.ServiceUnavailableError}
|
|
106
|
+
* @throws {@link errors.MarktMentorError}
|
|
107
|
+
* @throws {@link errors.MarktMentorTimeoutError}
|
|
108
|
+
*
|
|
109
|
+
* @example
|
|
110
|
+
* await client.store.products()
|
|
111
|
+
*/
|
|
112
|
+
async products(request = {}, requestOptions) {
|
|
113
|
+
const list = core.HttpResponsePromise.interceptFunction(async (request) => {
|
|
114
|
+
const { categoryId, country, days, eans, endDate, page, pageSize, sort, startDate } = request;
|
|
115
|
+
const _queryParams = {
|
|
116
|
+
categoryId,
|
|
117
|
+
country: country != null ? country : undefined,
|
|
118
|
+
days,
|
|
119
|
+
eans,
|
|
120
|
+
endDate: endDate != null ? endDate : undefined,
|
|
121
|
+
page,
|
|
122
|
+
pageSize,
|
|
123
|
+
sort: sort != null ? sort : undefined,
|
|
124
|
+
startDate: startDate != null ? startDate : undefined,
|
|
125
|
+
};
|
|
126
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
127
|
+
const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
128
|
+
const _response = await core.fetcher({
|
|
129
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
130
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
131
|
+
environments.MarktMentorEnvironment.Production, "api/public/v1/store/products/"),
|
|
132
|
+
method: "GET",
|
|
133
|
+
headers: _headers,
|
|
134
|
+
queryString: core.url
|
|
135
|
+
.queryBuilder()
|
|
136
|
+
.addMany(_queryParams)
|
|
137
|
+
.mergeAdditional(requestOptions?.queryParams)
|
|
138
|
+
.build(),
|
|
139
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
140
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
141
|
+
abortSignal: requestOptions?.abortSignal,
|
|
142
|
+
fetchFn: this._options?.fetch,
|
|
143
|
+
logging: this._options.logging,
|
|
144
|
+
});
|
|
145
|
+
if (_response.ok) {
|
|
146
|
+
return {
|
|
147
|
+
data: _response.body,
|
|
148
|
+
rawResponse: _response.rawResponse,
|
|
149
|
+
};
|
|
150
|
+
}
|
|
151
|
+
if (_response.error.reason === "status-code") {
|
|
152
|
+
switch (_response.error.statusCode) {
|
|
153
|
+
case 400:
|
|
154
|
+
throw new MarktMentor.BadRequestError(_response.error.body, _response.rawResponse);
|
|
155
|
+
case 401:
|
|
156
|
+
throw new MarktMentor.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
157
|
+
case 403:
|
|
158
|
+
throw new MarktMentor.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
159
|
+
case 409:
|
|
160
|
+
throw new MarktMentor.ConflictError(_response.error.body, _response.rawResponse);
|
|
161
|
+
case 429:
|
|
162
|
+
throw new MarktMentor.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
163
|
+
case 503:
|
|
164
|
+
throw new MarktMentor.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
165
|
+
default:
|
|
166
|
+
throw new errors.MarktMentorError({
|
|
167
|
+
statusCode: _response.error.statusCode,
|
|
168
|
+
body: _response.error.body,
|
|
169
|
+
rawResponse: _response.rawResponse,
|
|
170
|
+
});
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/api/public/v1/store/products/");
|
|
174
|
+
});
|
|
175
|
+
let _offset = request?.page != null ? request?.page : 1;
|
|
176
|
+
const dataWithRawResponse = await list(request).withRawResponse();
|
|
177
|
+
return new core.Page({
|
|
178
|
+
response: dataWithRawResponse.data,
|
|
179
|
+
rawResponse: dataWithRawResponse.rawResponse,
|
|
180
|
+
hasNextPage: (response) => response?.pagination.hasNext ?? (response?.data ?? []).length > 0,
|
|
181
|
+
getItems: (response) => response?.data ?? [],
|
|
182
|
+
loadPage: (_response) => {
|
|
183
|
+
const _nextOffset = _offset + 1;
|
|
184
|
+
return core.HttpResponsePromise.fromPromise(list(core.setObjectProperty(request, "page", _nextOffset))
|
|
185
|
+
.withRawResponse()
|
|
186
|
+
.then((_pageResponse) => {
|
|
187
|
+
_offset = _nextOffset;
|
|
188
|
+
return _pageResponse;
|
|
189
|
+
}));
|
|
190
|
+
},
|
|
191
|
+
});
|
|
192
|
+
}
|
|
193
|
+
/**
|
|
194
|
+
* List the active products of your own connected bol store with their stock and stock state.
|
|
195
|
+
*
|
|
196
|
+
* This request is free: it does not count as a research request.
|
|
197
|
+
*
|
|
198
|
+
* @param {MarktMentor.InventoryStoreRequest} request
|
|
199
|
+
* @param {StoreClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
200
|
+
*
|
|
201
|
+
* @throws {@link MarktMentor.BadRequestError}
|
|
202
|
+
* @throws {@link MarktMentor.UnauthorizedError}
|
|
203
|
+
* @throws {@link MarktMentor.ForbiddenError}
|
|
204
|
+
* @throws {@link MarktMentor.ConflictError}
|
|
205
|
+
* @throws {@link MarktMentor.TooManyRequestsError}
|
|
206
|
+
* @throws {@link MarktMentor.ServiceUnavailableError}
|
|
207
|
+
* @throws {@link errors.MarktMentorError}
|
|
208
|
+
* @throws {@link errors.MarktMentorTimeoutError}
|
|
209
|
+
*
|
|
210
|
+
* @example
|
|
211
|
+
* await client.store.inventory({
|
|
212
|
+
* ean: "5407005143414"
|
|
213
|
+
* })
|
|
214
|
+
*/
|
|
215
|
+
async inventory(request = {}, requestOptions) {
|
|
216
|
+
const list = core.HttpResponsePromise.interceptFunction(async (request) => {
|
|
217
|
+
const { ean, page, pageSize, stockState } = request;
|
|
218
|
+
const _queryParams = {
|
|
219
|
+
ean,
|
|
220
|
+
page,
|
|
221
|
+
pageSize,
|
|
222
|
+
stockState: stockState != null ? stockState : undefined,
|
|
223
|
+
};
|
|
224
|
+
const _authRequest = await this._options.authProvider.getAuthRequest();
|
|
225
|
+
const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
|
|
226
|
+
const _response = await core.fetcher({
|
|
227
|
+
url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
|
|
228
|
+
(await core.Supplier.get(this._options.environment)) ??
|
|
229
|
+
environments.MarktMentorEnvironment.Production, "api/public/v1/store/inventory/"),
|
|
230
|
+
method: "GET",
|
|
231
|
+
headers: _headers,
|
|
232
|
+
queryString: core.url
|
|
233
|
+
.queryBuilder()
|
|
234
|
+
.addMany(_queryParams)
|
|
235
|
+
.mergeAdditional(requestOptions?.queryParams)
|
|
236
|
+
.build(),
|
|
237
|
+
timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
|
|
238
|
+
maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
|
|
239
|
+
abortSignal: requestOptions?.abortSignal,
|
|
240
|
+
fetchFn: this._options?.fetch,
|
|
241
|
+
logging: this._options.logging,
|
|
242
|
+
});
|
|
243
|
+
if (_response.ok) {
|
|
244
|
+
return {
|
|
245
|
+
data: _response.body,
|
|
246
|
+
rawResponse: _response.rawResponse,
|
|
247
|
+
};
|
|
248
|
+
}
|
|
249
|
+
if (_response.error.reason === "status-code") {
|
|
250
|
+
switch (_response.error.statusCode) {
|
|
251
|
+
case 400:
|
|
252
|
+
throw new MarktMentor.BadRequestError(_response.error.body, _response.rawResponse);
|
|
253
|
+
case 401:
|
|
254
|
+
throw new MarktMentor.UnauthorizedError(_response.error.body, _response.rawResponse);
|
|
255
|
+
case 403:
|
|
256
|
+
throw new MarktMentor.ForbiddenError(_response.error.body, _response.rawResponse);
|
|
257
|
+
case 409:
|
|
258
|
+
throw new MarktMentor.ConflictError(_response.error.body, _response.rawResponse);
|
|
259
|
+
case 429:
|
|
260
|
+
throw new MarktMentor.TooManyRequestsError(_response.error.body, _response.rawResponse);
|
|
261
|
+
case 503:
|
|
262
|
+
throw new MarktMentor.ServiceUnavailableError(_response.error.body, _response.rawResponse);
|
|
263
|
+
default:
|
|
264
|
+
throw new errors.MarktMentorError({
|
|
265
|
+
statusCode: _response.error.statusCode,
|
|
266
|
+
body: _response.error.body,
|
|
267
|
+
rawResponse: _response.rawResponse,
|
|
268
|
+
});
|
|
269
|
+
}
|
|
270
|
+
}
|
|
271
|
+
return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/api/public/v1/store/inventory/");
|
|
272
|
+
});
|
|
273
|
+
let _offset = request?.page != null ? request?.page : 1;
|
|
274
|
+
const dataWithRawResponse = await list(request).withRawResponse();
|
|
275
|
+
return new core.Page({
|
|
276
|
+
response: dataWithRawResponse.data,
|
|
277
|
+
rawResponse: dataWithRawResponse.rawResponse,
|
|
278
|
+
hasNextPage: (response) => response?.pagination.hasNext ?? (response?.data ?? []).length > 0,
|
|
279
|
+
getItems: (response) => response?.data ?? [],
|
|
280
|
+
loadPage: (_response) => {
|
|
281
|
+
const _nextOffset = _offset + 1;
|
|
282
|
+
return core.HttpResponsePromise.fromPromise(list(core.setObjectProperty(request, "page", _nextOffset))
|
|
283
|
+
.withRawResponse()
|
|
284
|
+
.then((_pageResponse) => {
|
|
285
|
+
_offset = _nextOffset;
|
|
286
|
+
return _pageResponse;
|
|
287
|
+
}));
|
|
288
|
+
},
|
|
289
|
+
});
|
|
290
|
+
}
|
|
291
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.js";
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./requests/index.js";
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type * as MarktMentor from "../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {
|
|
5
|
+
* ean: "5407005143414"
|
|
6
|
+
* }
|
|
7
|
+
*/
|
|
8
|
+
export interface InventoryStoreRequest {
|
|
9
|
+
/** Only the product with this EAN. */
|
|
10
|
+
ean?: string;
|
|
11
|
+
/** Page number, starting at 1. */
|
|
12
|
+
page?: number;
|
|
13
|
+
/** Results per page (maximum 100). */
|
|
14
|
+
pageSize?: number;
|
|
15
|
+
/**
|
|
16
|
+
* out_of_stock: the stock is zero. low: the stock is 5 or less. ok: more than 5.
|
|
17
|
+
*
|
|
18
|
+
* * `out_of_stock` - out_of_stock
|
|
19
|
+
* * `low` - low
|
|
20
|
+
* * `ok` - ok
|
|
21
|
+
*/
|
|
22
|
+
stockState?: MarktMentor.InventoryStoreRequestStockState;
|
|
23
|
+
}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
import type * as MarktMentor from "../../../../index.js";
|
|
2
|
+
/**
|
|
3
|
+
* @example
|
|
4
|
+
* {}
|
|
5
|
+
*/
|
|
6
|
+
export interface ProductsStoreRequest {
|
|
7
|
+
/** Only products in this bol category or in a category below it. The same identifier as `categoryId` in the research filters; find it with List categories. */
|
|
8
|
+
categoryId?: number;
|
|
9
|
+
/**
|
|
10
|
+
* NL or BE. Without this parameter: both countries.
|
|
11
|
+
*
|
|
12
|
+
* * `NL` - NL
|
|
13
|
+
* * `BE` - BE
|
|
14
|
+
*/
|
|
15
|
+
country?: MarktMentor.ProductsStoreRequestCountry;
|
|
16
|
+
/** The last N days, today included. Do not combine with startDate and endDate. */
|
|
17
|
+
days?: number;
|
|
18
|
+
/** EANs, separated by commas (maximum 100). With this filter, the page is in the sequence of sales (high to low) and `sort` only selects the products. */
|
|
19
|
+
eans?: string;
|
|
20
|
+
/** Last day of the period (YYYY-MM-DD), included. */
|
|
21
|
+
endDate?: string;
|
|
22
|
+
/** Page number, from 1 to 100. */
|
|
23
|
+
page?: number;
|
|
24
|
+
/**
|
|
25
|
+
* Results per page: 5, 10, 25, 50 or 100.
|
|
26
|
+
*
|
|
27
|
+
* * `5` - 5
|
|
28
|
+
* * `10` - 10
|
|
29
|
+
* * `25` - 25
|
|
30
|
+
* * `50` - 50
|
|
31
|
+
* * `100` - 100
|
|
32
|
+
*/
|
|
33
|
+
pageSize?: number;
|
|
34
|
+
/**
|
|
35
|
+
* Sort field; a `-` prefix gives high to low. Selection and sequence use the order amounts before the final cost adjustments (advertising, storage, returns). Thus the sequence can be different from the sequence of `totalCosts` or `totalProfits`.
|
|
36
|
+
*
|
|
37
|
+
* * `revenue` - revenue
|
|
38
|
+
* * `-revenue` - -revenue
|
|
39
|
+
* * `sales` - sales
|
|
40
|
+
* * `-sales` - -sales
|
|
41
|
+
* * `costs` - costs
|
|
42
|
+
* * `-costs` - -costs
|
|
43
|
+
* * `profits` - profits
|
|
44
|
+
* * `-profits` - -profits
|
|
45
|
+
*/
|
|
46
|
+
sort?: MarktMentor.ProductsStoreRequestSort;
|
|
47
|
+
/** First day of the period (YYYY-MM-DD). Send it together with endDate. The period can be at most 366 days. */
|
|
48
|
+
startDate?: string;
|
|
49
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
export declare const InventoryStoreRequestStockState: {
|
|
2
|
+
readonly OutOfStock: "out_of_stock";
|
|
3
|
+
readonly Low: "low";
|
|
4
|
+
readonly Ok: "ok";
|
|
5
|
+
};
|
|
6
|
+
export type InventoryStoreRequestStockState = (typeof InventoryStoreRequestStockState)[keyof typeof InventoryStoreRequestStockState];
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export declare const ProductsStoreRequestSort: {
|
|
2
|
+
readonly RevenueAsc: "revenue";
|
|
3
|
+
readonly RevenueDesc: "-revenue";
|
|
4
|
+
readonly SalesAsc: "sales";
|
|
5
|
+
readonly SalesDesc: "-sales";
|
|
6
|
+
readonly CostsAsc: "costs";
|
|
7
|
+
readonly CostsDesc: "-costs";
|
|
8
|
+
readonly ProfitsAsc: "profits";
|
|
9
|
+
readonly ProfitsDesc: "-profits";
|
|
10
|
+
};
|
|
11
|
+
export type ProductsStoreRequestSort = (typeof ProductsStoreRequestSort)[keyof typeof ProductsStoreRequestSort];
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
// This file was auto-generated by Fern from our API Definition.
|
|
2
|
+
export const ProductsStoreRequestSort = {
|
|
3
|
+
RevenueAsc: "revenue",
|
|
4
|
+
RevenueDesc: "-revenue",
|
|
5
|
+
SalesAsc: "sales",
|
|
6
|
+
SalesDesc: "-sales",
|
|
7
|
+
CostsAsc: "costs",
|
|
8
|
+
CostsDesc: "-costs",
|
|
9
|
+
ProfitsAsc: "profits",
|
|
10
|
+
ProfitsDesc: "-profits",
|
|
11
|
+
};
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
|
|
2
|
+
import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
|
|
3
|
+
import * as core from "../../../../core/index.js";
|
|
4
|
+
import * as MarktMentor from "../../../index.js";
|
|
5
|
+
export declare namespace UsageClient {
|
|
6
|
+
type Options = BaseClientOptions;
|
|
7
|
+
interface RequestOptions extends BaseRequestOptions {
|
|
8
|
+
}
|
|
9
|
+
}
|
|
10
|
+
export declare class UsageClient {
|
|
11
|
+
protected readonly _options: NormalizedClientOptionsWithAuth<UsageClient.Options>;
|
|
12
|
+
constructor(options: UsageClient.Options);
|
|
13
|
+
/**
|
|
14
|
+
* Get the research requests of the organization in the current period: what the API bundle includes, what is used and what is left, or the state of the free monthly allowance. Use it to stop before the limit.
|
|
15
|
+
*
|
|
16
|
+
* This request is free: it does not count as a research request.
|
|
17
|
+
*
|
|
18
|
+
* @param {UsageClient.RequestOptions} requestOptions - Request-specific configuration.
|
|
19
|
+
*
|
|
20
|
+
* @throws {@link MarktMentor.UnauthorizedError}
|
|
21
|
+
* @throws {@link MarktMentor.ForbiddenError}
|
|
22
|
+
* @throws {@link MarktMentor.TooManyRequestsError}
|
|
23
|
+
* @throws {@link MarktMentor.ServiceUnavailableError}
|
|
24
|
+
* @throws {@link errors.MarktMentorError}
|
|
25
|
+
* @throws {@link errors.MarktMentorTimeoutError}
|
|
26
|
+
*
|
|
27
|
+
* @example
|
|
28
|
+
* await client.usage.get()
|
|
29
|
+
*/
|
|
30
|
+
get(requestOptions?: UsageClient.RequestOptions): core.HttpResponsePromise<MarktMentor.Usage>;
|
|
31
|
+
private __get;
|
|
32
|
+
}
|