wildberries-sdk 0.1.0__py3-none-any.whl → 0.1.3__py3-none-any.whl

wildberries_sdk/analytics/models/table_size_response_sizes_inner_metrics.py

@@ -0,0 +1,147 @@
+# coding: utf-8
+
+"""
+    Аналитика и данные
+
+    <div class=\"description_important\">   Узнать больше об аналитике и данных можно в <a href=\"https://seller.wildberries.ru/instructions/ru/ru/subcategory/seller-analytics\">справочном центре</a> </div>  В разделе описаны методы получения:   1. [Воронки продаж](/openapi/analytics#tag/Voronka-prodazh)   2. [Поисковых запросов по вашим товарам](/openapi/analytics#tag/Poiskovye-zaprosy-po-vashim-tovaram)   3. [Истории остатков](/openapi/analytics#tag/Istoriya-ostatkov)   4. [Аналитики продавца в формате CSV](/openapi/analytics#tag/Analitika-prodavca-CSV) 
+
+    The version of the OpenAPI document: analytics
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Union
+from wildberries_sdk.analytics.models.float_graph_by_period_item import FloatGraphByPeriodItem
+from wildberries_sdk.analytics.models.table_common_metrics_avg_stock_turnover import TableCommonMetricsAvgStockTurnover
+from wildberries_sdk.analytics.models.table_common_metrics_office_missing_time import TableCommonMetricsOfficeMissingTime
+from wildberries_sdk.analytics.models.table_common_metrics_sale_rate import TableCommonMetricsSaleRate
+from wildberries_sdk.analytics.models.table_product_item_st_metrics_all_of_current_price import TableProductItemStMetricsAllOfCurrentPrice
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TableSizeResponseSizesInnerMetrics(BaseModel):
+    """
+    Метрики размера
+    """ # noqa: E501
+    orders_count: StrictInt = Field(description="Заказы, шт.", alias="ordersCount")
+    orders_sum: StrictInt = Field(description="Заказы, сумма", alias="ordersSum")
+    avg_orders: Union[StrictFloat, StrictInt] = Field(description="Среднее количество заказов в день", alias="avgOrders")
+    avg_orders_by_month: List[FloatGraphByPeriodItem] = Field(description="Среднее количество заказов по месяцам", alias="avgOrdersByMonth")
+    buyout_count: StrictInt = Field(description="Выкупы, шт.", alias="buyoutCount")
+    buyout_sum: StrictInt = Field(description="Выкупы, сумма", alias="buyoutSum")
+    buyout_percent: StrictInt = Field(description="Процент выкупа", alias="buyoutPercent")
+    stock_count: StrictInt = Field(description="Остатки на текущий день, шт.", alias="stockCount")
+    stock_sum: StrictInt = Field(description="Стоимость остатков на текущий день", alias="stockSum")
+    sale_rate: TableCommonMetricsSaleRate = Field(alias="saleRate")
+    avg_stock_turnover: TableCommonMetricsAvgStockTurnover = Field(alias="avgStockTurnover")
+    to_client_count: StrictInt = Field(description="В пути к клиенту, шт.", alias="toClientCount")
+    from_client_count: StrictInt = Field(description="В пути от клиента, шт.", alias="fromClientCount")
+    office_missing_time: TableCommonMetricsOfficeMissingTime = Field(alias="officeMissingTime")
+    lost_orders_count: Union[StrictFloat, StrictInt] = Field(description="Упущенные заказы, шт. Особые случаи:   1. Значение меньше `0` и не равно `-2` — значение не рассчитано   2. Значение `-2` — нулевое значение ", alias="lostOrdersCount")
+    lost_orders_sum: Union[StrictFloat, StrictInt] = Field(description="Упущенные заказы, сумма. Особые случаи:   1. Значение меньше `0` и не равно `-2` — значение не рассчитано   2. Значение `-2` — нулевое значение ", alias="lostOrdersSum")
+    lost_buyouts_count: Union[StrictFloat, StrictInt] = Field(description="Упущенные выкупы, шт. Особые случаи:   1. Значение меньше `0` и не равно `-2` — значение не рассчитано   2. Значение `-2` — нулевое значение ", alias="lostBuyoutsCount")
+    lost_buyouts_sum: Union[StrictFloat, StrictInt] = Field(description="Упущенные выкупы, сумма. Особые случаи:   1. Значение меньше `0` и не равно `-2` — значение не рассчитано   2. Значение `-2` — нулевое значение ", alias="lostBuyoutsSum")
+    current_price: TableProductItemStMetricsAllOfCurrentPrice = Field(alias="currentPrice")
+    __properties: ClassVar[List[str]] = ["ordersCount", "ordersSum", "avgOrders", "avgOrdersByMonth", "buyoutCount", "buyoutSum", "buyoutPercent", "stockCount", "stockSum", "saleRate", "avgStockTurnover", "toClientCount", "fromClientCount", "officeMissingTime", "lostOrdersCount", "lostOrdersSum", "lostBuyoutsCount", "lostBuyoutsSum", "currentPrice"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of TableSizeResponseSizesInnerMetrics from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in avg_orders_by_month (list)
+        _items = []
+        if self.avg_orders_by_month:
+            for _item_avg_orders_by_month in self.avg_orders_by_month:
+                if _item_avg_orders_by_month:
+                    _items.append(_item_avg_orders_by_month.to_dict())
+            _dict['avgOrdersByMonth'] = _items
+        # override the default output from pydantic by calling `to_dict()` of sale_rate
+        if self.sale_rate:
+            _dict['saleRate'] = self.sale_rate.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of avg_stock_turnover
+        if self.avg_stock_turnover:
+            _dict['avgStockTurnover'] = self.avg_stock_turnover.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of office_missing_time
+        if self.office_missing_time:
+            _dict['officeMissingTime'] = self.office_missing_time.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of current_price
+        if self.current_price:
+            _dict['currentPrice'] = self.current_price.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TableSizeResponseSizesInnerMetrics from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "ordersCount": obj.get("ordersCount"),
+            "ordersSum": obj.get("ordersSum"),
+            "avgOrders": obj.get("avgOrders"),
+            "avgOrdersByMonth": [FloatGraphByPeriodItem.from_dict(_item) for _item in obj["avgOrdersByMonth"]] if obj.get("avgOrdersByMonth") is not None else None,
+            "buyoutCount": obj.get("buyoutCount"),
+            "buyoutSum": obj.get("buyoutSum"),
+            "buyoutPercent": obj.get("buyoutPercent"),
+            "stockCount": obj.get("stockCount"),
+            "stockSum": obj.get("stockSum"),
+            "saleRate": TableCommonMetricsSaleRate.from_dict(obj["saleRate"]) if obj.get("saleRate") is not None else None,
+            "avgStockTurnover": TableCommonMetricsAvgStockTurnover.from_dict(obj["avgStockTurnover"]) if obj.get("avgStockTurnover") is not None else None,
+            "toClientCount": obj.get("toClientCount"),
+            "fromClientCount": obj.get("fromClientCount"),
+            "officeMissingTime": TableCommonMetricsOfficeMissingTime.from_dict(obj["officeMissingTime"]) if obj.get("officeMissingTime") is not None else None,
+            "lostOrdersCount": obj.get("lostOrdersCount"),
+            "lostOrdersSum": obj.get("lostOrdersSum"),
+            "lostBuyoutsCount": obj.get("lostBuyoutsCount"),
+            "lostBuyoutsSum": obj.get("lostBuyoutsSum"),
+            "currentPrice": TableProductItemStMetricsAllOfCurrentPrice.from_dict(obj["currentPrice"]) if obj.get("currentPrice") is not None else None
+        })
+        return _obj
+
+

wildberries_sdk/analytics/models/visibility_info.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    Аналитика и данные
+
+    <div class=\"description_important\">   Узнать больше об аналитике и данных можно в <a href=\"https://seller.wildberries.ru/instructions/ru/ru/subcategory/seller-analytics\">справочном центре</a> </div>  В разделе описаны методы получения:   1. [Воронки продаж](/openapi/analytics#tag/Voronka-prodazh)   2. [Поисковых запросов по вашим товарам](/openapi/analytics#tag/Poiskovye-zaprosy-po-vashim-tovaram)   3. [Истории остатков](/openapi/analytics#tag/Istoriya-ostatkov)   4. [Аналитики продавца в формате CSV](/openapi/analytics#tag/Analitika-prodavca-CSV) 
+
+    The version of the OpenAPI document: analytics
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from wildberries_sdk.analytics.models.visibility_info_by_day_inner import VisibilityInfoByDayInner
+from wildberries_sdk.analytics.models.visibility_info_open_card import VisibilityInfoOpenCard
+from wildberries_sdk.analytics.models.visibility_info_visibility import VisibilityInfoVisibility
+from typing import Optional, Set
+from typing_extensions import Self
+
+class VisibilityInfo(BaseModel):
+    """
+    Видимость карточек и переходы в карточки. По дням, неделям, месяцам
+    """ # noqa: E501
+    visibility: VisibilityInfoVisibility
+    open_card: VisibilityInfoOpenCard = Field(alias="openCard")
+    by_day: Optional[List[VisibilityInfoByDayInner]] = Field(default=None, description="Данные для отрисовки графика в личном кабинете по видимости и переходам в карточки по дням", alias="byDay")
+    by_week: Optional[List[VisibilityInfoByDayInner]] = Field(default=None, description="Данные для отрисовки графика в личном кабинете по видимости и переходам в карточки по неделям", alias="byWeek")
+    by_month: Optional[List[VisibilityInfoByDayInner]] = Field(default=None, description="Данные для отрисовки графика в личном кабинете по видимости и переходам в карточки по месяцам", alias="byMonth")
+    __properties: ClassVar[List[str]] = ["visibility", "openCard", "byDay", "byWeek", "byMonth"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of VisibilityInfo from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of visibility
+        if self.visibility:
+            _dict['visibility'] = self.visibility.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of open_card
+        if self.open_card:
+            _dict['openCard'] = self.open_card.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in by_day (list)
+        _items = []
+        if self.by_day:
+            for _item_by_day in self.by_day:
+                if _item_by_day:
+                    _items.append(_item_by_day.to_dict())
+            _dict['byDay'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in by_week (list)
+        _items = []
+        if self.by_week:
+            for _item_by_week in self.by_week:
+                if _item_by_week:
+                    _items.append(_item_by_week.to_dict())
+            _dict['byWeek'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in by_month (list)
+        _items = []
+        if self.by_month:
+            for _item_by_month in self.by_month:
+                if _item_by_month:
+                    _items.append(_item_by_month.to_dict())
+            _dict['byMonth'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of VisibilityInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "visibility": VisibilityInfoVisibility.from_dict(obj["visibility"]) if obj.get("visibility") is not None else None,
+            "openCard": VisibilityInfoOpenCard.from_dict(obj["openCard"]) if obj.get("openCard") is not None else None,
+            "byDay": [VisibilityInfoByDayInner.from_dict(_item) for _item in obj["byDay"]] if obj.get("byDay") is not None else None,
+            "byWeek": [VisibilityInfoByDayInner.from_dict(_item) for _item in obj["byWeek"]] if obj.get("byWeek") is not None else None,
+            "byMonth": [VisibilityInfoByDayInner.from_dict(_item) for _item in obj["byMonth"]] if obj.get("byMonth") is not None else None
+        })
+        return _obj
+
+

wildberries_sdk/analytics/rest.py

@@ -0,0 +1,263 @@
+# coding: utf-8
+
+"""
+    Аналитика и данные
+
+    <div class=\"description_important\">   Узнать больше об аналитике и данных можно в <a href=\"https://seller.wildberries.ru/instructions/ru/ru/subcategory/seller-analytics\">справочном центре</a> </div>  В разделе описаны методы получения:   1. [Воронки продаж](/openapi/analytics#tag/Voronka-prodazh)   2. [Поисковых запросов по вашим товарам](/openapi/analytics#tag/Poiskovye-zaprosy-po-vashim-tovaram)   3. [Истории остатков](/openapi/analytics#tag/Istoriya-ostatkov)   4. [Аналитики продавца в формате CSV](/openapi/analytics#tag/Analitika-prodavca-CSV) 
+
+    The version of the OpenAPI document: analytics
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import io
+import json
+import re
+import ssl
+
+import urllib3
+
+from wildberries_sdk.analytics.exceptions import ApiException, ApiValueError
+
+SUPPORTED_SOCKS_PROXIES = {"socks5", "socks5h", "socks4", "socks4a"}
+RESTResponseType = urllib3.HTTPResponse
+
+
+def is_socks_proxy_url(url):
+    if url is None:
+        return False
+    split_section = url.split("://")
+    if len(split_section) < 2:
+        return False
+    else:
+        return split_section[0].lower() in SUPPORTED_SOCKS_PROXIES
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = None
+
+    def read(self):
+        if self.data is None:
+            self.data = self.response.data
+        return self.data
+
+    @property
+    def headers(self):
+        """Returns a dictionary of response headers."""
+        return self.response.headers
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers; use ``headers`` instead."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header; use ``headers.get()`` instead."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        pool_args = {
+            "cert_reqs": cert_reqs,
+            "ca_certs": configuration.ssl_ca_cert,
+            "cert_file": configuration.cert_file,
+            "key_file": configuration.key_file,
+            "ca_cert_data": configuration.ca_cert_data,
+        }
+        if configuration.assert_hostname is not None:
+            pool_args['assert_hostname'] = (
+                configuration.assert_hostname
+            )
+
+        if configuration.retries is not None:
+            pool_args['retries'] = configuration.retries
+
+        if configuration.tls_server_name:
+            pool_args['server_hostname'] = configuration.tls_server_name
+
+
+        if configuration.socket_options is not None:
+            pool_args['socket_options'] = configuration.socket_options
+
+        if configuration.connection_pool_maxsize is not None:
+            pool_args['maxsize'] = configuration.connection_pool_maxsize
+
+        # https pool manager
+        self.pool_manager: urllib3.PoolManager
+
+        if configuration.proxy:
+            if is_socks_proxy_url(configuration.proxy):
+                from urllib3.contrib.socks import SOCKSProxyManager
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["headers"] = configuration.proxy_headers
+                self.pool_manager = SOCKSProxyManager(**pool_args)
+            else:
+                pool_args["proxy_url"] = configuration.proxy
+                pool_args["proxy_headers"] = configuration.proxy_headers
+                self.pool_manager = urllib3.ProxyManager(**pool_args)
+        else:
+            self.pool_manager = urllib3.PoolManager(**pool_args)
+
+    def request(
+        self,
+        method,
+        url,
+        headers=None,
+        body=None,
+        post_params=None,
+        _request_timeout=None
+    ):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, float)):
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (
+                    isinstance(_request_timeout, tuple)
+                    and len(_request_timeout) == 2
+                ):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0],
+                    read=_request_timeout[1]
+                )
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+
+                # no content type provided or payload is json
+                content_type = headers.get('Content-Type')
+                if (
+                    not content_type
+                    or re.search('json', content_type, re.IGNORECASE)
+                ):
+                    request_body = None
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'application/x-www-form-urlencoded':
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif content_type == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    # Ensures that dict objects are serialized
+                    post_params = [(a, json.dumps(b)) if isinstance(b, dict) else (a,b) for a, b in post_params]
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                # Pass a `string` parameter directly in the body to support
+                # other content types than JSON when `body` argument is
+                # provided in serialized form.
+                elif isinstance(body, str) or isinstance(body, bytes):
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=body,
+                        timeout=timeout,
+                        headers=headers,
+                        preload_content=False
+                    )
+                elif headers['Content-Type'].startswith('text/') and isinstance(body, bool):
+                    request_body = "true" if body else "false"
+                    r = self.pool_manager.request(
+                        method,
+                        url,
+                        body=request_body,
+                        preload_content=False,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(
+                    method,
+                    url,
+                    fields={},
+                    timeout=timeout,
+                    headers=headers,
+                    preload_content=False
+                )
+        except urllib3.exceptions.SSLError as e:
+            msg = "\n".join([type(e).__name__, str(e)])
+            raise ApiException(status=0, reason=msg)
+
+        return RESTResponse(r)