@teez-sdk/teez-b2c-api 1.0.0 → 1.0.1

package/dist/index.mjs

@@ -46,14 +46,22 @@ const BannersApiListResponseSchema = z.array(BannersApiBannerItemSchema);
 * API for retrieving promotional and informational banners.
 */
 var BannersApi = class {
+	/**
+	* Initializes a new instance of the BannersApi.
+	*
+	* @param http HTTP client instance.
+	*/
 	constructor(http) {
 		this.http = http;
 	}
 	/**
 	* Retrieves a list of active banners.
+	*
+	* @example
+	* const banners = await client.banners.list();
 	*/
-	async list(params = {}) {
-		return await this.http.get({
+	list(params = {}) {
+		return this.http.get({
 			path: "/api/v3/banners",
 			params,
 			schema: BannersApiListResponseSchema
@@ -115,14 +123,22 @@ const CategoriesApiGetParentsResponseSchema = z.array(CategoriesApiGetParentsRes
 * API for retrieving product category information.
 */
 var CategoriesApi = class {
+	/**
+	* Initializes a new instance of the CategoriesApi.
+	*
+	* @param http HTTP client instance.
+	*/
 	constructor(http) {
 		this.http = http;
 	}
 	/**
 	* Retrieves a list of all categories.
+	*
+	* @example
+	* const categories = await client.categories.list();
 	*/
-	async list(params = {}) {
-		return await this.http.get({
+	list(params = {}) {
+		return this.http.get({
 			path: "/categories",
 			params,
 			schema: CategoriesApiListResponseSchema
@@ -130,9 +146,14 @@ var CategoriesApi = class {
 	}
 	/**
 	* Retrieves detailed information about a specific category by its ID.
+	*
+	* @example
+	* const category = await client.categories.get({
+	*   categoryId: 1234
+	* });
 	*/
-	async get(params) {
-		return await this.http.get({
+	get(params) {
+		return this.http.get({
 			path: `/categories/${params.categoryId}`,
 			params,
 			schema: CategoriesApiGetResponseSchema
@@ -140,9 +161,14 @@ var CategoriesApi = class {
 	}
 	/**
 	* Retrieves parent categories for specific category IDs.
+	*
+	* @example
+	* const parents = await client.categories.getParents({
+	*   categoryId: [123, 456]
+	* });
 	*/
-	async getParents(params) {
-		return await this.http.get({
+	getParents(params) {
+		return this.http.get({
 			path: "/api/v1/categories/parents",
 			params,
 			schema: CategoriesApiGetParentsResponseSchema
@@ -285,14 +311,25 @@ const CollectionsApiGetResponseSchema = z.object({
 * API for retrieving curated collections of products.
 */
 var CollectionsApi = class {
+	/**
+	* Initializes a new instance of the CollectionsApi.
+	*
+	* @param http HTTP client instance.
+	*/
 	constructor(http) {
 		this.http = http;
 	}
 	/**
 	* Retrieves a list of SKUs belonging to a specific collection with pagination and sorting.
+	*
+	* @example
+	* const skus = await client.collections.getSkus({
+	*   collectionId: 123,
+	*   pageSize: 10
+	* });
 	*/
-	async getSkus(params) {
-		return await this.http.get({
+	getSkus(params) {
+		return this.http.get({
 			path: "/api/v2/collections/skus",
 			params,
 			schema: CollectionsApiGetSkusResponseSchema
@@ -300,9 +337,12 @@ var CollectionsApi = class {
 	}
 	/**
 	* Retrieves a list of all collections.
+	*
+	* @example
+	* const collections = await client.collections.list();
 	*/
-	async list(params = {}) {
-		return await this.http.get({
+	list(params = {}) {
+		return this.http.get({
 			path: "/collections",
 			params,
 			schema: CollectionsApiListResponseSchema
@@ -310,9 +350,14 @@ var CollectionsApi = class {
 	}
 	/**
 	* Retrieves detailed information about a specific collection by its ID.
+	*
+	* @example
+	* const collection = await client.collections.get({
+	*   collectionId: 123
+	* });
 	*/
-	async get(params) {
-		return await this.http.get({
+	get(params) {
+		return this.http.get({
 			path: `/collections/${params.collectionId}`,
 			params,
 			schema: CollectionsApiGetResponseSchema
@@ -340,14 +385,22 @@ const FeatureFlagsApiListResponseSchema = z.array(FeatureFlagsApiItemSchema);
 * API for retrieving feature flags configuration.
 */
 var FeatureFlagsApi = class {
+	/**
+	* Initializes a new instance of the FeatureFlagsApi.
+	*
+	* @param http HTTP client instance.
+	*/
 	constructor(http) {
 		this.http = http;
 	}
 	/**
 	* Retrieves all active feature flags.
+	*
+	* @example
+	* const flags = await client.featureFlags.list();
 	*/
-	async list(params = {}) {
-		return await this.http.get({
+	list(params = {}) {
+		return this.http.get({
 			path: "/api/v1/feature-flags",
 			params,
 			schema: FeatureFlagsApiListResponseSchema
@@ -463,14 +516,22 @@ const ProductsApiListResponseSchema = z.object({
 * API for retrieving product listings, details, and reviews.
 */
 var ProductsApi = class {
+	/**
+	* Initializes a new instance of the ProductsApi.
+	*
+	* @param http HTTP client instance.
+	*/
 	constructor(http) {
 		this.http = http;
 	}
 	/**
 	* Retrieves available sorting options for product lists.
+	*
+	* @example
+	* const sortOptions = await client.products.getSortOptions();
 	*/
-	async getSortOptions(params = {}) {
-		return await this.http.get({
+	getSortOptions(params = {}) {
+		return this.http.get({
 			path: "/api/product/sort-options",
 			params,
 			schema: ProductsApiGetSortOptionsResponseSchema
@@ -478,9 +539,15 @@ var ProductsApi = class {
 	}
 	/**
 	* Retrieves a list of products with optional filtering and pagination.
+	*
+	* @example
+	* const products = await client.products.list({
+	*   pageSize: 20,
+	*   pageNumber: 1
+	* });
 	*/
-	async list(params = {}) {
-		return await this.http.get({
+	list(params = {}) {
+		return this.http.get({
 			path: "/api/v2/product",
 			params,
 			schema: ProductsApiListResponseSchema
@@ -488,9 +555,14 @@ var ProductsApi = class {
 	}
 	/**
 	* Retrieves reviews for a specific product.
+	*
+	* @example
+	* const reviews = await client.products.getReviews({
+	*   productId: 12345
+	* });
 	*/
-	async getReviews(params) {
-		return await this.http.get({
+	getReviews(params) {
+		return this.http.get({
 			path: `/api/v1/product/${params.productId}/review`,
 			params,
 			schema: ProductsApiGetReviewsResponseSchema
@@ -522,14 +594,22 @@ const PromoApiListResponseSchema = z.array(PromoApiItemSchema);
 * API for retrieving active promotions.
 */
 var PromoApi = class {
+	/**
+	* Initializes a new instance of the PromoApi.
+	*
+	* @param http HTTP client instance.
+	*/
 	constructor(http) {
 		this.http = http;
 	}
 	/**
 	* Retrieves a list of all active promotions.
+	*
+	* @example
+	* const promos = await client.promo.list();
 	*/
-	async list(params = {}) {
-		return await this.http.get({
+	list(params = {}) {
+		return this.http.get({
 			path: "/api/promo",
 			params,
 			schema: PromoApiListResponseSchema
@@ -646,14 +726,24 @@ const ShopsApiGetProductsResponseSchema = z.object({
 * API for interacting with shop-related endpoints.
 */
 var ShopsApi = class {
+	/**
+	* Initializes a new instance of the ShopsApi.
+	*
+	* @param http HTTP client instance.
+	*/
 	constructor(http) {
 		this.http = http;
 	}
 	/**
 	* Retrieves details of a specific shop.
+	*
+	* @example
+	* const shop = await client.shops.get({
+	*   shopId: 123
+	* });
 	*/
-	async get(params) {
-		return await this.http.get({
+	get(params) {
+		return this.http.get({
 			path: `/api/v1/shops/${params.shopId}`,
 			params,
 			schema: ShopsApiGetResponseSchema
@@ -661,9 +751,12 @@ var ShopsApi = class {
 	}
 	/**
 	* Retrieves monobrand shop details.
+	*
+	* @example
+	* const monobrand = await client.shops.getMonobrand();
 	*/
-	async getMonobrand(params = {}) {
-		return await this.http.get({
+	getMonobrand(params = {}) {
+		return this.http.get({
 			path: "/api/v1/shops/monobrand",
 			params,
 			schema: ShopsApiGetMonobrandResponseSchema
@@ -671,9 +764,15 @@ var ShopsApi = class {
 	}
 	/**
 	* Retrieves products for a specific shop.
+	*
+	* @example
+	* const shopProducts = await client.shops.getProducts({
+	*   shopId: 123,
+	*   pageSize: 10
+	* });
 	*/
-	async getProducts(params) {
-		return await this.http.get({
+	getProducts(params) {
+		return this.http.get({
 			path: `/api/v2/shops/${params.shopId}/products`,
 			params,
 			schema: ShopsApiGetProductsResponseSchema
@@ -856,14 +955,24 @@ const SkuApiGetReviewAvailableResponseSchema = z.object({
 * API for interacting with SKU-related endpoints.
 */
 var SkuApi = class {
+	/**
+	* Initializes a new instance of the SkuApi.
+	*
+	* @param http HTTP client instance.
+	*/
 	constructor(http) {
 		this.http = http;
 	}
 	/**
 	* Retrieves details of a specific SKU.
+	*
+	* @example
+	* const sku = await client.sku.get({
+	*   skuId: 123
+	* });
 	*/
-	async get(params) {
-		return await this.http.get({
+	get(params) {
+		return this.http.get({
 			path: `/api/v2/sku/${params.skuId}`,
 			params,
 			schema: SkuApiGetResponseSchema
@@ -871,9 +980,14 @@ var SkuApi = class {
 	}
 	/**
 	* Retrieves similar SKUs.
+	*
+	* @example
+	* const similar = await client.sku.getSimilar({
+	*   skuId: 123
+	* });
 	*/
-	async getSimilar(params) {
-		return await this.http.get({
+	getSimilar(params) {
+		return this.http.get({
 			path: "/api/v2/sku/similar-skus",
 			params,
 			schema: SkuApiGetSimilarResponseSchema
@@ -881,9 +995,14 @@ var SkuApi = class {
 	}
 	/**
 	* Retrieves collections associated with a SKU.
+	*
+	* @example
+	* const collections = await client.sku.getCollections({
+	*   skuId: 123
+	* });
 	*/
-	async getCollections(params) {
-		return await this.http.get({
+	getCollections(params) {
+		return this.http.get({
 			path: `/sku/${params.skuId}/collections`,
 			params,
 			schema: SkuApiGetCollectionsResponseSchema
@@ -891,9 +1010,14 @@ var SkuApi = class {
 	}
 	/**
 	* Checks if a review is available for a SKU.
+	*
+	* @example
+	* const isAvailable = await client.sku.getReviewAvailable({
+	*   skuId: 123
+	* });
 	*/
-	async getReviewAvailable(params) {
-		return await this.http.get({
+	getReviewAvailable(params) {
+		return this.http.get({
 			path: `/sku/${params.skuId}/review-available`,
 			params,
 			schema: SkuApiGetReviewAvailableResponseSchema
@@ -1149,6 +1273,11 @@ var HttpClient = class {
 	* Request timeout in milliseconds.
 	*/
 	timeout;
+	/**
+	* Initializes a new instance of the HttpClient.
+	*
+	* @param config Resolved client configuration.
+	*/
 	constructor(config) {
 		this.baseUrl = config.baseUrl;
 		this.headers = buildHeaders(config);
@@ -1156,6 +1285,8 @@ var HttpClient = class {
 	}
 	/**
 	* Performs a low-level HTTP request.
+	*
+	* @param options Request options.
 	*/
 	async request(options) {
 		const { url, headers, ...fetchOptions } = options;
@@ -1220,6 +1351,12 @@ var HttpClient = class {
 //#region src/client.ts
 /**
 * Main client for interacting with the Teez B2C API.
+*
+* @example
+* const client = new TeezClient({
+*   language: "ru",
+*   timeout: 10000
+* });
 */
 var TeezClient = class {
 	/**
@@ -1262,6 +1399,11 @@ var TeezClient = class {
 	* API for retrieving SKU details.
 	*/
 	sku;
+	/**
+	* Initializes a new instance of the TeezClient.
+	*
+	* @param config Optional client configuration.
+	*/
 	constructor(config) {
 		this.config = resolveConfig(config);
 		this.http = new HttpClient(this.config);