wbapi-async 0.2.0__tar.gz → 0.2.2__tar.gz

{wbapi_async-0.2.0 → wbapi_async-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wbapi-async
-Version: 0.2.0
+Version: 0.2.2
 Summary: Asynchronous client for Wildberries API
 Project-URL: Documentation, https://serdukow.github.io/wbapi-async/
 Project-URL: Repository, https://github.com/serdukow/wbapi-async

{wbapi_async-0.2.0 → wbapi_async-0.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "wbapi-async"
-version = "0.2.0"
+version = "0.2.2"
 description = "Asynchronous client for Wildberries API"
 authors = [
     { name = "Andrei Serdiukov", email = "asyncdf@gmail.com" },

{wbapi_async-0.2.0 → wbapi_async-0.2.2}/src/wbapi_async/analytics/__init__.py

@@ -1,5 +1,9 @@
 from .enums.aggregation_level import AggregationLevel
 from .enums.position_cluster import PositionCluster
+from .enums.product_data_availability import ProductDataAvailability
+from .enums.product_data_order_field import ProductDataOrderField
+from .enums.product_data_order_mode import ProductDataOrderMode
+from .enums.product_data_stock_type import ProductDataStockType
 from .enums.top_order_by import TopOrderBy
 from .types.create_the_report_response import CreateTheReportResponse
 from .types.group_data_item import GroupDataItem
@@ -13,6 +17,8 @@ from .types.pagination_by_products_within_a_group_response import PaginationByPr
 from .types.product_cards_statistics_per_days_response import ProductCardsStatisticsPerDaysResponse
 from .types.product_cards_statistics_per_period_response import ProductCardsStatisticsPerPeriodResponse
 from .types.product_data_item import ProductDataItem
+from .types.product_data_order_by import ProductDataOrderBy
+from .types.product_data_period import ProductDataPeriod
 from .types.regenerate_the_report_response import RegenerateTheReportResponse
 from .types.search_texts_by_product_response import SearchTextsByProductResponse
 from .types.size_data_item import SizeDataItem
@@ -31,6 +37,12 @@ __all__ = (
     "PaginationByGroupsResponse",
     "PaginationByProductsWithinAGroupResponse",
     "PositionCluster",
+    "ProductDataAvailability",
+    "ProductDataOrderBy",
+    "ProductDataOrderField",
+    "ProductDataOrderMode",
+    "ProductDataPeriod",
+    "ProductDataStockType",
     "ProductCardsStatisticsPerDaysResponse",
     "ProductCardsStatisticsPerPeriodResponse",
     "ProductDataItem",

wbapi_async-0.2.2/src/wbapi_async/analytics/enums/__init__.py

@@ -0,0 +1,18 @@
+from .aggregation_level import AggregationLevel
+from .position_cluster import PositionCluster
+from .product_data_availability import ProductDataAvailability
+from .product_data_order_field import ProductDataOrderField
+from .product_data_order_mode import ProductDataOrderMode
+from .product_data_stock_type import ProductDataStockType
+from .top_order_by import TopOrderBy
+
+
+__all__ = (
+    "AggregationLevel",
+    "PositionCluster",
+    "ProductDataAvailability",
+    "ProductDataOrderField",
+    "ProductDataOrderMode",
+    "ProductDataStockType",
+    "TopOrderBy",
+)

wbapi_async-0.2.2/src/wbapi_async/analytics/enums/product_data_availability.py

@@ -0,0 +1,12 @@
+from enum import StrEnum
+
+
+class ProductDataAvailability(StrEnum):
+    """Item availability filter"""
+
+    DEFICIENT = "deficient"
+    ACTUAL = "actual"
+    BALANCED = "balanced"
+    NON_ACTUAL = "nonActual"
+    NON_LIQUID = "nonLiquid"
+    INVALID_DATA = "invalidData"

wbapi_async-0.2.2/src/wbapi_async/analytics/enums/product_data_order_field.py

@@ -0,0 +1,25 @@
+from enum import StrEnum
+
+
+class ProductDataOrderField(StrEnum):
+    """Sorting field for product data"""
+
+    ORDERS_COUNT = "ordersCount"
+    ORDERS_SUM = "ordersSum"
+    AVG_ORDERS = "avgOrders"
+    BUYOUT_COUNT = "buyoutCount"
+    BUYOUT_SUM = "buyoutSum"
+    BUYOUT_PERCENT = "buyoutPercent"
+    STOCK_COUNT = "stockCount"
+    STOCK_SUM = "stockSum"
+    SALE_RATE = "saleRate"
+    AVG_STOCK_TURNOVER = "avgStockTurnover"
+    TO_CLIENT_COUNT = "toClientCount"
+    FROM_CLIENT_COUNT = "fromClientCount"
+    MIN_PRICE = "minPrice"
+    MAX_PRICE = "maxPrice"
+    OFFICE_MISSING_TIME = "officeMissingTime"
+    LOST_ORDERS_COUNT = "lostOrdersCount"
+    LOST_ORDERS_SUM = "lostOrdersSum"
+    LOST_BUYOUTS_COUNT = "lostBuyoutsCount"
+    LOST_BUYOUTS_SUM = "lostBuyoutsSum"

wbapi_async-0.2.2/src/wbapi_async/analytics/enums/product_data_order_mode.py

@@ -0,0 +1,8 @@
+from enum import StrEnum
+
+
+class ProductDataOrderMode(StrEnum):
+    """Sorting order for product data"""
+
+    ASC = "asc"
+    DESC = "desc"

wbapi_async-0.2.2/src/wbapi_async/analytics/enums/product_data_stock_type.py

@@ -0,0 +1,9 @@
+from enum import StrEnum
+
+
+class ProductDataStockType(StrEnum):
+    """Type of products storage warehouse"""
+
+    ALL = ""
+    WB = "wb"
+    MP = "mp"

wbapi_async-0.2.2/src/wbapi_async/analytics/methods/product_data.py

@@ -0,0 +1,39 @@
+from pydantic import Field
+
+from ...methods.base import WbMethod
+from ...types import ProductDataItem, RequestLimit
+from ..enums.product_data_availability import ProductDataAvailability
+from ..enums.product_data_stock_type import ProductDataStockType
+from ..types.product_data_order_by import ProductDataOrderBy
+from ..types.product_data_period import ProductDataPeriod
+
+
+class ProductData(WbMethod):
+    """
+    Forms a dataset for inventory by products. You can get data for individual products as well as
+    for the entire report if there are no filters in the query: `nmIDs`, `subjectID`, `brandName`,
+    `tagID`.
+
+    Source: https://dev.wildberries.ru/en/docs/openapi/analytics#tag/Stocks-Report/paths/~1api~1v2~1stocks-report~1products~1products/post
+    """
+
+    __return__ = ProductDataItem
+    __api__ = "seller-analytics-api"
+    __method__ = "api/v2/stocks-report/products/products"
+    __http_method__ = "POST"
+    __data_key__ = "data.items"
+    __pagination__ = "offset"
+
+    request_limit: RequestLimit = RequestLimit(period=60, limit=3, interval=20, burst=3)
+
+    nm_ids: list[int] | None = Field(None, alias="nmIDs")
+    subject_id: int | None = Field(None, alias="subjectID")
+    brand_name: str | None = Field(None, alias="brandName")
+    tag_id: int | None = Field(None, alias="tagID")
+    current_period: ProductDataPeriod = Field(alias="currentPeriod")
+    stock_type: ProductDataStockType = Field(alias="stockType")
+    skip_deleted_nm: bool = Field(alias="skipDeletedNm")
+    order_by: ProductDataOrderBy = Field(alias="orderBy")
+    availability_filters: list[ProductDataAvailability] = Field(alias="availabilityFilters")
+    limit: int | None = Field(1000)
+    offset: int = Field(0)

{wbapi_async-0.2.0 → wbapi_async-0.2.2}/src/wbapi_async/analytics/types/__init__.py

@@ -10,6 +10,8 @@ from .pagination_by_products_within_a_group_response import PaginationByProducts
 from .product_cards_statistics_per_days_response import ProductCardsStatisticsPerDaysResponse
 from .product_cards_statistics_per_period_response import ProductCardsStatisticsPerPeriodResponse
 from .product_data_item import ProductDataItem
+from .product_data_order_by import ProductDataOrderBy
+from .product_data_period import ProductDataPeriod
 from .regenerate_the_report_response import RegenerateTheReportResponse
 from .search_texts_by_product_response import SearchTextsByProductResponse
 from .size_data_item import SizeDataItem
@@ -29,6 +31,8 @@ __all__ = (
     "ProductCardsStatisticsPerDaysResponse",
     "ProductCardsStatisticsPerPeriodResponse",
     "ProductDataItem",
+    "ProductDataOrderBy",
+    "ProductDataPeriod",
     "RegenerateTheReportResponse",
     "SearchTextsByProductResponse",
     "SizeDataItem",

wbapi_async-0.2.2/src/wbapi_async/analytics/types/product_data_order_by.py

@@ -0,0 +1,12 @@
+from pydantic import Field
+
+from ...types.base import BaseType
+from ..enums.product_data_order_field import ProductDataOrderField
+from ..enums.product_data_order_mode import ProductDataOrderMode
+
+
+class ProductDataOrderBy(BaseType):
+    """Sorting parameters for product data"""
+
+    field: ProductDataOrderField = Field()
+    mode: ProductDataOrderMode = Field()

wbapi_async-0.2.2/src/wbapi_async/analytics/types/product_data_period.py

@@ -0,0 +1,8 @@
+from ...types.base import BaseType
+
+
+class ProductDataPeriod(BaseType):
+    """Period for product data inventory report (format: YYYY-MM-DD, no earlier than 3 months ago)"""
+
+    start: str
+    end: str

{wbapi_async-0.2.0 → wbapi_async-0.2.2}/src/wbapi_async/client/api.py

@@ -13,6 +13,8 @@ from ..enums import (
     Period,
     PinOn,
     PositionCluster,
+    ProductDataAvailability,
+    ProductDataStockType,
     Sort,
     SortBlocked,
     SortList,
@@ -403,6 +405,8 @@ from ..types import (
     ProductCardsStatisticsPerPeriodResponse,
     ProductCategoryCommissionResponse,
     ProductDataItem,
+    ProductDataOrderBy,
+    ProductDataPeriod,
     ProductDetail,
     ProductLabelingItem,
     ProductsInQuarantineItem,
@@ -5119,21 +5123,56 @@ class WbAPI:
 
     product_cards_statistics_per_period.__wrapped_cls__ = ProductCardsStatisticsPerPeriod
 
-    async def product_data(
+    async def get_product_data(
         self,
+        current_period: ProductDataPeriod,
+        stock_type: ProductDataStockType,
+        skip_deleted_nm: bool,
+        order_by: ProductDataOrderBy,
+        availability_filters: list[ProductDataAvailability],
+        nm_ids: list[int] | None = None,
+        subject_id: int | None = None,
+        brand_name: str | None = None,
+        tag_id: int | None = None,
+        limit: int | None = 1000,
+        offset: int = 0,
     ) -> list[ProductDataItem]:
         """
         Forms a dataset for inventory by products. You can get data for individual products as well
-        asfor the entire report if there are no filters in the query: `nmIDs`, `subjectID`,
-        `brandName`,`tagID`.
+        as for the entire report if there are no filters in the query: `nmIDs`, `subjectID`,
+        `brandName`, `tagID`.
 
         Source: https://dev.wildberries.ru/en/docs/openapi/analytics#tag/Stocks-Report/paths/~1api~1v2~1stocks-report~1products~1products/post
+
+        :param current_period: Period (format: YYYY-MM-DD, no earlier than 3 months from today)
+        :param stock_type: Type of storage warehouse
+        :param skip_deleted_nm: Skip deleted items
+        :param order_by: Sorting parameters
+        :param availability_filters: Item availability filters
+        :param nm_ids: List of WB article numbers for filtering
+        :param subject_id: Subject ID
+        :param brand_name: Brand name
+        :param tag_id: Tag ID
+        :param limit: Number of groups in the response (max 1000)
+        :param offset: From which element to start outputting data
         :return: list[ProductDataItem]
         """
-        call = ProductData()
+        call = ProductData(
+            current_period=current_period,
+            stock_type=stock_type,
+            skip_deleted_nm=skip_deleted_nm,
+            order_by=order_by,
+            availability_filters=availability_filters,
+            nm_ids=nm_ids,
+            subject_id=subject_id,
+            brand_name=brand_name,
+            tag_id=tag_id,
+            limit=limit,
+            offset=offset,
+        )
         return await self(call)
 
-    product_data.__wrapped_cls__ = ProductData
+    get_product_data.__wrapped_cls__ = ProductData
 
     async def recover_product_card_from_trash(
         self,

{wbapi_async-0.2.0 → wbapi_async-0.2.2}/src/wbapi_async/enums/__init__.py

@@ -1,5 +1,9 @@
 from ..analytics.enums.aggregation_level import AggregationLevel
 from ..analytics.enums.position_cluster import PositionCluster
+from ..analytics.enums.product_data_availability import ProductDataAvailability
+from ..analytics.enums.product_data_order_field import ProductDataOrderField
+from ..analytics.enums.product_data_order_mode import ProductDataOrderMode
+from ..analytics.enums.product_data_stock_type import ProductDataStockType
 from ..analytics.enums.top_order_by import TopOrderBy
 from ..communications.enums.order import Order
 from ..communications.enums.pin_on import PinOn
@@ -24,6 +28,10 @@ from ..reports.enums.sort_shadowed import SortShadowed
 __all__ = (
     "AggregationLevel",
     "PositionCluster",
+    "ProductDataAvailability",
+    "ProductDataOrderField",
+    "ProductDataOrderMode",
+    "ProductDataStockType",
     "TopOrderBy",
     "Order",
     "PinOn",

{wbapi_async-0.2.0 → wbapi_async-0.2.2}/src/wbapi_async/types/__init__.py

@@ -16,6 +16,8 @@ from ..analytics.types.product_cards_statistics_per_period_response import (
     ProductCardsStatisticsPerPeriodResponse,
 )
 from ..analytics.types.product_data_item import ProductDataItem
+from ..analytics.types.product_data_order_by import ProductDataOrderBy
+from ..analytics.types.product_data_period import ProductDataPeriod
 from ..analytics.types.regenerate_the_report_response import RegenerateTheReportResponse
 from ..analytics.types.search_texts_by_product_response import SearchTextsByProductResponse
 from ..analytics.types.size_data_item import SizeDataItem
@@ -506,6 +508,8 @@ __all__ = (
     "ProductCardsStatisticsPerPeriodResponse",
     "ProductCategoryCommissionResponse",
     "ProductDataItem",
+    "ProductDataOrderBy",
+    "ProductDataPeriod",
     "ProductDetail",
     "ProductDetailColor",
     "ProductDetailPrice",

wbapi_async-0.2.0/src/wbapi_async/analytics/enums/__init__.py

@@ -1,10 +0,0 @@
-from .aggregation_level import AggregationLevel
-from .position_cluster import PositionCluster
-from .top_order_by import TopOrderBy
-
-
-__all__ = (
-    "AggregationLevel",
-    "PositionCluster",
-    "TopOrderBy",
-)

wbapi_async-0.2.0/src/wbapi_async/analytics/methods/product_data.py

@@ -1,20 +0,0 @@
-from ...methods.base import WbMethod
-from ...types import ProductDataItem, RequestLimit
-
-
-class ProductData(WbMethod):
-    """
-    Forms a dataset for inventory by products. You can get data for individual products as well as
-    forthe entire report if there are no filters in the query: `nmIDs`, `subjectID`, `brandName`,
-    `tagID`.
-
-    Source: https://dev.wildberries.ru/en/docs/openapi/analytics#tag/Stocks-Report/paths/~1api~1v2~1stocks-report~1products~1products/post
-    """
-
-    __return__ = ProductDataItem
-    __api__ = "seller-analytics-api"
-    __method__ = "api/v2/stocks-report/products/products"
-    __http_method__ = "POST"
-    __data_key__ = "data.items"
-
-    request_limit: RequestLimit = RequestLimit(period=60, limit=10, interval=600, burst=5)