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

package/dist/index.d.cts

@@ -191,9 +191,16 @@ declare class HttpClient {
    * Request timeout in milliseconds.
    */
   private readonly timeout;
+  /**
+   * Initializes a new instance of the HttpClient.
+   *
+   * @param config Resolved client configuration.
+   */
   constructor(config: ResolvedTeezClientConfig);
   /**
    * Performs a low-level HTTP request.
+   *
+   * @param options Request options.
    */
   request(options: HttpRequestOptions): Promise<unknown>;
   /**
@@ -281,9 +288,17 @@ interface BannersApiListParams extends BaseParams {
  */
 declare class BannersApi {
   private http;
+  /**
+   * Initializes a new instance of the BannersApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves a list of active banners.
+   *
+   * @example
+   * const banners = await client.banners.list();
    */
   list(params?: BannersApiListParams): Promise<BannersApiListResponse>;
 }
@@ -426,17 +441,35 @@ interface CategoriesApiGetParentsParams extends BaseParams {
  */
 declare class CategoriesApi {
   private http;
+  /**
+   * Initializes a new instance of the CategoriesApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves a list of all categories.
+   *
+   * @example
+   * const categories = await client.categories.list();
    */
   list(params?: CategoriesApiListParams): Promise<CategoriesApiListResponse>;
   /**
    * Retrieves detailed information about a specific category by its ID.
+   *
+   * @example
+   * const category = await client.categories.get({
+   *   categoryId: 1234
+   * });
    */
   get(params: CategoriesApiGetParams): Promise<CategoriesApiGetResponse>;
   /**
    * Retrieves parent categories for specific category IDs.
+   *
+   * @example
+   * const parents = await client.categories.getParents({
+   *   categoryId: [123, 456]
+   * });
    */
   getParents(params: CategoriesApiGetParentsParams): Promise<CategoriesApiGetParentsResponse>;
 }
@@ -700,17 +733,36 @@ interface CollectionsApiGetParams extends BaseParams {
  */
 declare class CollectionsApi {
   private http;
+  /**
+   * Initializes a new instance of the CollectionsApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * 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
+   * });
    */
   getSkus(params: CollectionsApiGetSkusParams): Promise<CollectionsApiGetSkusResponse>;
   /**
    * Retrieves a list of all collections.
+   *
+   * @example
+   * const collections = await client.collections.list();
    */
   list(params?: CollectionsApiListParams): Promise<CollectionsApiListResponse>;
   /**
    * Retrieves detailed information about a specific collection by its ID.
+   *
+   * @example
+   * const collection = await client.collections.get({
+   *   collectionId: 123
+   * });
    */
   get(params: CollectionsApiGetParams): Promise<CollectionsApiGetResponse>;
 }
@@ -751,9 +803,17 @@ type FeatureFlagsApiListParams = BaseParams;
  */
 declare class FeatureFlagsApi {
   private http;
+  /**
+   * Initializes a new instance of the FeatureFlagsApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves all active feature flags.
+   *
+   * @example
+   * const flags = await client.featureFlags.list();
    */
   list(params?: FeatureFlagsApiListParams): Promise<FeatureFlagsApiListResponse>;
 }
@@ -1087,17 +1147,36 @@ interface ProductsApiListParams extends BaseParams {
  */
 declare class ProductsApi {
   private http;
+  /**
+   * Initializes a new instance of the ProductsApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves available sorting options for product lists.
+   *
+   * @example
+   * const sortOptions = await client.products.getSortOptions();
    */
   getSortOptions(params?: ProductsApiGetSortOptionsParams): Promise<ProductsApiGetSortOptionsResponse>;
   /**
    * Retrieves a list of products with optional filtering and pagination.
+   *
+   * @example
+   * const products = await client.products.list({
+   *   pageSize: 20,
+   *   pageNumber: 1
+   * });
    */
   list(params?: ProductsApiListParams): Promise<ProductsApiListResponse>;
   /**
    * Retrieves reviews for a specific product.
+   *
+   * @example
+   * const reviews = await client.products.getReviews({
+   *   productId: 12345
+   * });
    */
   getReviews(params: ProductsApiGetReviewsParams): Promise<ProductsApiGetReviewsResponse>;
 }
@@ -1154,9 +1233,17 @@ type PromoApiListParams = BaseParams;
  */
 declare class PromoApi {
   private http;
+  /**
+   * Initializes a new instance of the PromoApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves a list of all active promotions.
+   *
+   * @example
+   * const promos = await client.promo.list();
    */
   list(params?: PromoApiListParams): Promise<PromoApiListResponse>;
 }
@@ -1523,17 +1610,36 @@ interface ShopsApiGetProductsParams extends BaseParams {
  */
 declare class ShopsApi {
   private http;
+  /**
+   * Initializes a new instance of the ShopsApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves details of a specific shop.
+   *
+   * @example
+   * const shop = await client.shops.get({
+   *   shopId: 123
+   * });
    */
   get(params: ShopsApiGetParams): Promise<ShopsApiGetResponse>;
   /**
    * Retrieves monobrand shop details.
+   *
+   * @example
+   * const monobrand = await client.shops.getMonobrand();
    */
   getMonobrand(params?: ShopsApiGetMonobrandParams): Promise<ShopsApiGetMonobrandResponse>;
   /**
    * Retrieves products for a specific shop.
+   *
+   * @example
+   * const shopProducts = await client.shops.getProducts({
+   *   shopId: 123,
+   *   pageSize: 10
+   * });
    */
   getProducts(params: ShopsApiGetProductsParams): Promise<ShopsApiGetProductsResponse>;
 }
@@ -2027,21 +2133,46 @@ interface SkuApiGetReviewAvailableParams extends BaseParams {
  */
 declare class SkuApi {
   private http;
+  /**
+   * Initializes a new instance of the SkuApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves details of a specific SKU.
+   *
+   * @example
+   * const sku = await client.sku.get({
+   *   skuId: 123
+   * });
    */
   get(params: SkuApiGetParams): Promise<SkuApiGetResponse>;
   /**
    * Retrieves similar SKUs.
+   *
+   * @example
+   * const similar = await client.sku.getSimilar({
+   *   skuId: 123
+   * });
    */
   getSimilar(params: SkuApiGetSimilarParams): Promise<SkuApiGetSimilarResponse>;
   /**
    * Retrieves collections associated with a SKU.
+   *
+   * @example
+   * const collections = await client.sku.getCollections({
+   *   skuId: 123
+   * });
    */
   getCollections(params: SkuApiGetCollectionsParams): Promise<SkuApiGetCollectionsResponse>;
   /**
    * Checks if a review is available for a SKU.
+   *
+   * @example
+   * const isAvailable = await client.sku.getReviewAvailable({
+   *   skuId: 123
+   * });
    */
   getReviewAvailable(params: SkuApiGetReviewAvailableParams): Promise<SkuApiGetReviewAvailableResponse>;
 }
@@ -2049,6 +2180,12 @@ declare class SkuApi {
 //#region src/client.d.ts
 /**
  * Main client for interacting with the Teez B2C API.
+ *
+ * @example
+ * const client = new TeezClient({
+ *   language: "ru",
+ *   timeout: 10000
+ * });
  */
 declare class TeezClient {
   /**
@@ -2091,6 +2228,11 @@ declare class TeezClient {
    * API for retrieving SKU details.
    */
   readonly sku: SkuApi;
+  /**
+   * Initializes a new instance of the TeezClient.
+   *
+   * @param config Optional client configuration.
+   */
   constructor(config?: TeezClientConfig);
   /**
    * Returns the current client configuration.

package/dist/index.d.mts

@@ -191,9 +191,16 @@ declare class HttpClient {
    * Request timeout in milliseconds.
    */
   private readonly timeout;
+  /**
+   * Initializes a new instance of the HttpClient.
+   *
+   * @param config Resolved client configuration.
+   */
   constructor(config: ResolvedTeezClientConfig);
   /**
    * Performs a low-level HTTP request.
+   *
+   * @param options Request options.
    */
   request(options: HttpRequestOptions): Promise<unknown>;
   /**
@@ -281,9 +288,17 @@ interface BannersApiListParams extends BaseParams {
  */
 declare class BannersApi {
   private http;
+  /**
+   * Initializes a new instance of the BannersApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves a list of active banners.
+   *
+   * @example
+   * const banners = await client.banners.list();
    */
   list(params?: BannersApiListParams): Promise<BannersApiListResponse>;
 }
@@ -426,17 +441,35 @@ interface CategoriesApiGetParentsParams extends BaseParams {
  */
 declare class CategoriesApi {
   private http;
+  /**
+   * Initializes a new instance of the CategoriesApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves a list of all categories.
+   *
+   * @example
+   * const categories = await client.categories.list();
    */
   list(params?: CategoriesApiListParams): Promise<CategoriesApiListResponse>;
   /**
    * Retrieves detailed information about a specific category by its ID.
+   *
+   * @example
+   * const category = await client.categories.get({
+   *   categoryId: 1234
+   * });
    */
   get(params: CategoriesApiGetParams): Promise<CategoriesApiGetResponse>;
   /**
    * Retrieves parent categories for specific category IDs.
+   *
+   * @example
+   * const parents = await client.categories.getParents({
+   *   categoryId: [123, 456]
+   * });
    */
   getParents(params: CategoriesApiGetParentsParams): Promise<CategoriesApiGetParentsResponse>;
 }
@@ -700,17 +733,36 @@ interface CollectionsApiGetParams extends BaseParams {
  */
 declare class CollectionsApi {
   private http;
+  /**
+   * Initializes a new instance of the CollectionsApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * 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
+   * });
    */
   getSkus(params: CollectionsApiGetSkusParams): Promise<CollectionsApiGetSkusResponse>;
   /**
    * Retrieves a list of all collections.
+   *
+   * @example
+   * const collections = await client.collections.list();
    */
   list(params?: CollectionsApiListParams): Promise<CollectionsApiListResponse>;
   /**
    * Retrieves detailed information about a specific collection by its ID.
+   *
+   * @example
+   * const collection = await client.collections.get({
+   *   collectionId: 123
+   * });
    */
   get(params: CollectionsApiGetParams): Promise<CollectionsApiGetResponse>;
 }
@@ -751,9 +803,17 @@ type FeatureFlagsApiListParams = BaseParams;
  */
 declare class FeatureFlagsApi {
   private http;
+  /**
+   * Initializes a new instance of the FeatureFlagsApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves all active feature flags.
+   *
+   * @example
+   * const flags = await client.featureFlags.list();
    */
   list(params?: FeatureFlagsApiListParams): Promise<FeatureFlagsApiListResponse>;
 }
@@ -1087,17 +1147,36 @@ interface ProductsApiListParams extends BaseParams {
  */
 declare class ProductsApi {
   private http;
+  /**
+   * Initializes a new instance of the ProductsApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves available sorting options for product lists.
+   *
+   * @example
+   * const sortOptions = await client.products.getSortOptions();
    */
   getSortOptions(params?: ProductsApiGetSortOptionsParams): Promise<ProductsApiGetSortOptionsResponse>;
   /**
    * Retrieves a list of products with optional filtering and pagination.
+   *
+   * @example
+   * const products = await client.products.list({
+   *   pageSize: 20,
+   *   pageNumber: 1
+   * });
    */
   list(params?: ProductsApiListParams): Promise<ProductsApiListResponse>;
   /**
    * Retrieves reviews for a specific product.
+   *
+   * @example
+   * const reviews = await client.products.getReviews({
+   *   productId: 12345
+   * });
    */
   getReviews(params: ProductsApiGetReviewsParams): Promise<ProductsApiGetReviewsResponse>;
 }
@@ -1154,9 +1233,17 @@ type PromoApiListParams = BaseParams;
  */
 declare class PromoApi {
   private http;
+  /**
+   * Initializes a new instance of the PromoApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves a list of all active promotions.
+   *
+   * @example
+   * const promos = await client.promo.list();
    */
   list(params?: PromoApiListParams): Promise<PromoApiListResponse>;
 }
@@ -1523,17 +1610,36 @@ interface ShopsApiGetProductsParams extends BaseParams {
  */
 declare class ShopsApi {
   private http;
+  /**
+   * Initializes a new instance of the ShopsApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves details of a specific shop.
+   *
+   * @example
+   * const shop = await client.shops.get({
+   *   shopId: 123
+   * });
    */
   get(params: ShopsApiGetParams): Promise<ShopsApiGetResponse>;
   /**
    * Retrieves monobrand shop details.
+   *
+   * @example
+   * const monobrand = await client.shops.getMonobrand();
    */
   getMonobrand(params?: ShopsApiGetMonobrandParams): Promise<ShopsApiGetMonobrandResponse>;
   /**
    * Retrieves products for a specific shop.
+   *
+   * @example
+   * const shopProducts = await client.shops.getProducts({
+   *   shopId: 123,
+   *   pageSize: 10
+   * });
    */
   getProducts(params: ShopsApiGetProductsParams): Promise<ShopsApiGetProductsResponse>;
 }
@@ -2027,21 +2133,46 @@ interface SkuApiGetReviewAvailableParams extends BaseParams {
  */
 declare class SkuApi {
   private http;
+  /**
+   * Initializes a new instance of the SkuApi.
+   *
+   * @param http HTTP client instance.
+   */
   constructor(http: HttpClient);
   /**
    * Retrieves details of a specific SKU.
+   *
+   * @example
+   * const sku = await client.sku.get({
+   *   skuId: 123
+   * });
    */
   get(params: SkuApiGetParams): Promise<SkuApiGetResponse>;
   /**
    * Retrieves similar SKUs.
+   *
+   * @example
+   * const similar = await client.sku.getSimilar({
+   *   skuId: 123
+   * });
    */
   getSimilar(params: SkuApiGetSimilarParams): Promise<SkuApiGetSimilarResponse>;
   /**
    * Retrieves collections associated with a SKU.
+   *
+   * @example
+   * const collections = await client.sku.getCollections({
+   *   skuId: 123
+   * });
    */
   getCollections(params: SkuApiGetCollectionsParams): Promise<SkuApiGetCollectionsResponse>;
   /**
    * Checks if a review is available for a SKU.
+   *
+   * @example
+   * const isAvailable = await client.sku.getReviewAvailable({
+   *   skuId: 123
+   * });
    */
   getReviewAvailable(params: SkuApiGetReviewAvailableParams): Promise<SkuApiGetReviewAvailableResponse>;
 }
@@ -2049,6 +2180,12 @@ declare class SkuApi {
 //#region src/client.d.ts
 /**
  * Main client for interacting with the Teez B2C API.
+ *
+ * @example
+ * const client = new TeezClient({
+ *   language: "ru",
+ *   timeout: 10000
+ * });
  */
 declare class TeezClient {
   /**
@@ -2091,6 +2228,11 @@ declare class TeezClient {
    * API for retrieving SKU details.
    */
   readonly sku: SkuApi;
+  /**
+   * Initializes a new instance of the TeezClient.
+   *
+   * @param config Optional client configuration.
+   */
   constructor(config?: TeezClientConfig);
   /**
    * Returns the current client configuration.