moysklad-api 0.5.13a1__tar.gz → 0.5.15a1__tar.gz

{moysklad_api-0.5.13a1 → moysklad_api-0.5.15a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: moysklad-api
-Version: 0.5.13a1
+Version: 0.5.15a1
 Summary: Мой Склад API
 Project-URL: Homepage, https://github.com/serdukow/moysklad-api
 Project-URL: Documentation, https://github.com/serdukow/moysklad-api#readme

{moysklad_api-0.5.13a1 → moysklad_api-0.5.15a1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "moysklad-api"
-version = "0.5.13a1"
+version = "0.5.15a1"
 description = "Мой Склад API"
 authors = [
     { name = "Andrei Serdiukov", email = "serdukow1@gmail.com" },

{moysklad_api-0.5.13a1 → moysklad_api-0.5.15a1}/src/moysklad_api/client/api.py

@@ -8,8 +8,12 @@ from ..filters.condition import Condition
 from ..methods import (
     GetAssortment,
     GetAudit,
+    GetBonusProgram,
+    GetBonusPrograms,
     GetBonusTransaction,
     GetBonusTransactions,
+    GetCommissionReportIn,
+    GetCommissionReportIns,
     GetCounterparty,
     GetCurrentStock,
     GetEvents,
@@ -38,6 +42,7 @@ from ..methods.get_demands import GetDemands
 from ..types import (
     Assortment,
     Audit,
+    BonusProgram,
     BonusTransaction,
     Counterparty,
     CurrentStock,
@@ -52,6 +57,7 @@ from ..types import (
     Variant,
     Webhook,
 )
+from ..types.commissionreportin import CommissionReportIn
 from ..utils.token import validate_token
 
 
@@ -180,6 +186,63 @@ class MoyskladAPI:
         )
         return await self(call)
 
+    async def get_bonusprogram(
+        self,
+        bonusprogram_id: str,
+        filters: Condition | Sequence[Condition] | None = None,
+        limit: int | None = 1000,
+        offset: int | None = None,
+        expand: Sequence[str] | str | None = None,
+    ) -> BonusProgram:
+        """
+        Используйте этот метод для получения бонусной программы по ID.
+
+        Источник:
+        https://dev.moysklad.ru/doc/api/remap/1.2/#/dictionaries/bonus-operation#3-poluchit-bonusnuyu-operaciyu
+
+        :param bonusprogram_id: Идентификатор бонусной программы
+        :param filters: Фильтрация выборки
+        :param limit: Количество элементов в выданном списке
+        :param offset: Отступ в выданном списке
+        :param expand: Замена ссылок объектами
+        :return: :class:`BonusProgram`
+        """
+        call = GetBonusProgram(
+            bonusprogram_id=bonusprogram_id,
+            limit=limit,
+            offset=offset,
+            expand=expand,
+            filters=filters,
+        )
+        return await self(call)
+
+    async def get_bonusprograms(
+        self,
+        filters: Condition | Sequence[Condition] | None = None,
+        limit: int | None = 1000,
+        offset: int | None = None,
+        expand: Sequence[str] | str | None = None,
+    ) -> MetaArray[BonusProgram]:
+        """
+        Используйте этот метод для получения списка бонусных программ.
+
+        Источник:
+        https://dev.moysklad.ru/doc/api/remap/1.2/#/dictionaries/bonus-operation#3-poluchit-bonusnye-operacii
+
+        :param filters: Фильтрация выборки
+        :param limit: Количество элементов в выданном списке
+        :param offset: Отступ в выданном списке
+        :param expand: Замена ссылок объектами
+        :return: :class:`MetaArray[BonusProgram]`
+        """
+        call = GetBonusPrograms(
+            limit=limit,
+            offset=offset,
+            expand=expand,
+            filters=filters,
+        )
+        return await self(call)
+
     async def get_bonustransactions(
         self,
         filters: Condition | Sequence[Condition] | None = None,
@@ -528,6 +591,73 @@ class MoyskladAPI:
         )
         return await self(call)
 
+    async def get_commissionreportin(
+        self,
+        commissionreportin_id: str,
+        incoming_date: datetime | None = None,
+        filters: Condition | Sequence[Condition] | None = None,
+        limit: int | None = 1000,
+        offset: int | None = None,
+        search: str | None = None,
+        expand: Sequence[str] | str | None = None,
+    ) -> CommissionReportIn:
+        """
+        Используйте этот метод для получения отчетов комиссионера по ID.
+
+        Источник: https://dev.moysklad.ru/doc/api/remap/1.2/#/documents/commissionreportin#3-poluchit-otchet-komissionera
+
+        :param commissionreportin_id: Идентификатор полученного отчета комиссионера
+        :param incoming_date: Параметр для фильтрации выборки по входящей дате
+        :param filters: Фильтрация выборки
+        :param limit: Количество элементов в выданном списке
+        :param offset: Отступ в выданном списке
+        :param search: Контекстный поиск
+        :param expand: Замена ссылок объектами
+        :return: :class:`CommissionReportIn`
+        """
+        call = GetCommissionReportIn(
+            commissionreportin_id=commissionreportin_id,
+            incoming_date=incoming_date,
+            filters=filters,
+            limit=limit,
+            offset=offset,
+            search=search,
+            expand=expand,
+        )
+        return await self(call)
+
+    async def get_commissionreportins(
+        self,
+        incoming_date: datetime | None = None,
+        filters: Condition | Sequence[Condition] | None = None,
+        limit: int | None = 1000,
+        offset: int | None = None,
+        search: str | None = None,
+        expand: Sequence[str] | str | None = None,
+    ) -> MetaArray[CommissionReportIn]:
+        """
+        Используйте этот метод для получения всех полученных отчетов комиссионера.
+
+        Источник: https://dev.moysklad.ru/doc/api/remap/1.2/#/documents/commissionreportin#3-poluchit-otchety-komissionera
+
+        :param incoming_date: Параметр для фильтрации выборки по входящей дате
+        :param filters: Фильтрация выборки
+        :param limit: Количество элементов в выданном списке
+        :param offset: Отступ в выданном списке
+        :param search: Контекстный поиск
+        :param expand: Замена ссылок объектами
+        :return: :class:`MetaArray[CommissionReportIn]`
+        """
+        call = GetCommissionReportIns(
+            incoming_date=incoming_date,
+            filters=filters,
+            limit=limit,
+            offset=offset,
+            search=search,
+            expand=expand,
+        )
+        return await self(call)
+
     async def get_webhook(
         self,
         webhook_id: str,

{moysklad_api-0.5.13a1 → moysklad_api-0.5.15a1}/src/moysklad_api/enums/__init__.py

@@ -1,3 +1,4 @@
+from .bonus_program_welcome_mode import BonusProgramWelcomeMode as BonusProgramWelcomeMode
 from .distribution import OverheadDistribution as OverheadDistribution
 from .entity_type import EntityType as EntityType
 from .event_type import EventType as EventType

moysklad_api-0.5.15a1/src/moysklad_api/enums/bonus_program_welcome_mode.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+
+class BonusProgramWelcomeMode(str, Enum):
+    REGISTRATION = "REGISTRATION"
+    FIRST_PURCHASE = "FIRST_PURCHASE"

{moysklad_api-0.5.13a1 → moysklad_api-0.5.15a1}/src/moysklad_api/filters/prop.py

@@ -22,7 +22,7 @@ class Prop:
     def __le__(self, v):
         return Condition(self.k, "<=", v)
 
-    def _is(self, v):
+    def is_(self, v):
         return Condition(self.k, "=", v)
 
     def contains(self, v):

{moysklad_api-0.5.13a1 → moysklad_api-0.5.15a1}/src/moysklad_api/methods/__init__.py

@@ -1,8 +1,12 @@
 from .base import MSMethod, T
 from .get_assortment import GetAssortment
 from .get_audit import GetAudit
+from .get_bonus_program import GetBonusProgram
+from .get_bonus_programs import GetBonusPrograms
 from .get_bonus_transaction import GetBonusTransaction
 from .get_bonus_transactions import GetBonusTransactions
+from .get_commissionreportin import GetCommissionReportIn
+from .get_commissionreportins import GetCommissionReportIns
 from .get_counterparty import GetCounterparty
 from .get_current_stock import GetCurrentStock
 from .get_demand import GetDemand
@@ -50,4 +54,8 @@ __all__ = (
     "GetProfit",
     "GetBonusTransactions",
     "GetBonusTransaction",
+    "GetBonusProgram",
+    "GetBonusPrograms",
+    "GetCommissionReportIns",
+    "GetCommissionReportIn",
 )

moysklad_api-0.5.15a1/src/moysklad_api/methods/get_bonus_program.py

@@ -0,0 +1,18 @@
+from collections.abc import Sequence
+
+from pydantic import Field
+
+from ..filters.condition import Condition
+from ..methods import MSMethod
+from ..types import BonusProgram
+
+
+class GetBonusProgram(MSMethod):
+    __return__ = BonusProgram
+    __api_method__ = "entity/bonusprogram"
+
+    id: str = Field(..., alias="bonusprogram_id")
+    limit: int | None = None
+    offset: int | None = None
+    expand: Sequence[str] | str | None = None
+    filters: Condition | Sequence[Condition] | None = None

moysklad_api-0.5.15a1/src/moysklad_api/methods/get_bonus_programs.py

@@ -0,0 +1,15 @@
+from collections.abc import Sequence
+
+from ..filters.condition import Condition
+from ..methods import MSMethod
+from ..types import BonusProgram, MetaArray
+
+
+class GetBonusPrograms(MSMethod):
+    __return__ = MetaArray[BonusProgram]
+    __api_method__ = "entity/bonusprogram"
+
+    limit: int | None = None
+    offset: int | None = None
+    expand: Sequence[str] | str | None = None
+    filters: Condition | Sequence[Condition] | None = None

moysklad_api-0.5.15a1/src/moysklad_api/methods/get_commissionreportin.py

@@ -0,0 +1,21 @@
+from collections.abc import Sequence
+from datetime import datetime
+
+from pydantic import Field
+
+from ..filters.condition import Condition
+from ..methods import MSMethod
+from ..types.commissionreportin import CommissionReportIn
+
+
+class GetCommissionReportIn(MSMethod):
+    __return__ = CommissionReportIn
+    __api_method__ = "entity/commissionreportin"
+
+    id: str = Field(..., alias="commissionreportin_id")
+    limit: int | None = None
+    offset: int | None = None
+    search: str | None = None
+    expand: Sequence[str] | str | None = None
+    incoming_date: datetime | None = Field(None, alias="incomingDate")
+    filters: Condition | Sequence[Condition] | None = None

moysklad_api-0.5.15a1/src/moysklad_api/methods/get_commissionreportins.py

@@ -0,0 +1,21 @@
+from collections.abc import Sequence
+from datetime import datetime
+
+from pydantic import Field
+
+from ..filters.condition import Condition
+from ..methods import MSMethod
+from ..types import MetaArray
+from ..types.commissionreportin import CommissionReportIn
+
+
+class GetCommissionReportIns(MSMethod):
+    __return__ = MetaArray[CommissionReportIn]
+    __api_method__ = "entity/commissionreportin"
+
+    limit: int | None = None
+    offset: int | None = None
+    search: str | None = None
+    expand: Sequence[str] | str | None = None
+    incoming_date: datetime | None = Field(None, alias="incomingDate")
+    filters: Condition | Sequence[Condition] | None = None

{moysklad_api-0.5.13a1 → moysklad_api-0.5.15a1}/src/moysklad_api/methods/get_current_stock.py

@@ -17,7 +17,6 @@ class GetCurrentStock(MSMethod):
     offset: int | None = None
     expand: Sequence[str] | str | None = None
     filters: Condition | Sequence[Condition] | None = None
-
     include: str | None = None
     changed_since: datetime | None = Field(None, alias="changedSince")
     stock_type: StockType = Field(StockType.STOCK, alias="stockType")

{moysklad_api-0.5.13a1 → moysklad_api-0.5.15a1}/src/moysklad_api/types/__init__.py

@@ -1,6 +1,7 @@
 from .account import Account
 from .actual_address_full import ActualAddressFull
 from .agent import Agent
+from .agent_account import AgentAccount
 from .alcoholic import Alcoholic
 from .assortment import Assortment
 from .attribute import Attribute
@@ -9,6 +10,7 @@ from .barcode import Barcode
 from .bonus_program import BonusProgram
 from .bonus_transaction import BonusTransaction
 from .buy_price import BuyPrice
+from .commissionreportin import CommissionReportIn
 from .contract import Contract
 from .counterpatry import Counterparty
 from .country import Country
@@ -46,6 +48,7 @@ from .purchaseorder_position import PurchaseOrderPosition
 from .rate import Rate
 from .region import Region
 from .report import Report
+from .return_to_commissioner_position import ReturnToCommissionerPosition
 from .sale_price import SalePrice
 from .sales_channel import SalesChannel
 from .shipment_address_full import ShipmentAddressFull
@@ -120,4 +123,7 @@ __all__ = (
     "BonusTransaction",
     "BonusProgram",
     "ParentDocument",
+    "AgentAccount",
+    "ReturnToCommissionerPosition",
+    "CommissionReportIn",
 )

moysklad_api-0.5.13a1/src/moysklad_api/types/bonus_program.py → moysklad_api-0.5.15a1/src/moysklad_api/types/agent_account.py

@@ -1,5 +1,5 @@
 from .entity import Entity
 
 
-class BonusProgram(Entity):
+class AgentAccount(Entity):
     pass

moysklad_api-0.5.15a1/src/moysklad_api/types/bonus_program.py

@@ -0,0 +1,24 @@
+from pydantic import Field
+
+from ..enums import BonusProgramWelcomeMode
+from .entity import Entity
+from .meta import Meta
+
+
+class BonusProgram(Entity):
+    meta: Meta | None = Field(None, alias="meta")
+    id: str | None = Field(None, alias="id")
+    account_id: str | None = Field(None, alias="accountId")
+    name: str | None = Field(None, alias="name")
+    active: bool | None = Field(None, alias="active")
+    all_agents: bool | None = Field(None, alias="allAgents")
+    all_products: bool | None = Field(None, alias="allProducts")
+    agent_tags: list[str] | None = Field(None, alias="agentTags")
+    earn_rate_roubles_to_point: int | None = Field(None, alias="earnRateRoublesToPoint")
+    earn_while_redeeming: bool | None = Field(None, alias="earnWhileRedeeming")
+    spend_rate_points_to_rouble: int | None = Field(None, alias="spendRatePointsToRouble")
+    max_paid_rate_percents: int | None = Field(None, alias="maxPaidRatePercents")
+    postponed_bonuses_delay_days: int | None = Field(None, alias="postponedBonusesDelayDays")
+    welcome_bonuses_enabled: bool | None = Field(None, alias="welcomeBonusesEnabled")
+    welcome_bonuses_mode: BonusProgramWelcomeMode | None = Field(None, alias="welcomeBonusesMode")
+    welcome_bonuses_value: int | None = Field(None, alias="welcomeBonusesValue")

moysklad_api-0.5.15a1/src/moysklad_api/types/commissionreportin.py

@@ -0,0 +1,65 @@
+from pydantic import Field
+
+from .agent import Agent
+from .agent_account import AgentAccount
+from .attribute import Attribute
+from .commissionreportin_position import CommissionReportInPosition
+from .contract import Contract
+from .entity import Entity
+from .file import File
+from .group import Group
+from .meta import Meta
+from .meta_array import MetaArray
+from .organization import Organization
+from .organization_account import OrganizationAccount
+from .owner import Owner
+from .project import Project
+from .rate import Rate
+from .return_to_commissioner_position import ReturnToCommissionerPosition
+
+
+class CommissionReportIn(Entity):
+    id: str | None = Field(None, alias="id")
+    account_id: str | None = Field(None, alias="accountId")
+    agent: Agent | None = Field(None, alias="agent")
+    agent_account: AgentAccount | None = Field(None, alias="agentAccount")
+    applicable: bool | None = Field(None, alias="applicable")
+    attributes: list[Attribute] | None = Field(None, alias="attributes")
+    code: str | None = Field(None, alias="code")
+    commission_overhead: dict | None = Field(None, alias="commissionOverhead")
+    commission_period_end: str | None = Field(None, alias="commissionPeriodEnd")
+    commission_period_start: str | None = Field(None, alias="commissionPeriodStart")
+    commitent_sum: float | None = Field(None, alias="commitentSum")
+    contract: Contract | None = Field(None, alias="contract")
+    created: str | None = Field(None, alias="created")
+    deleted: str | None = Field(None, alias="deleted")
+    description: str | None = Field(None, alias="description")
+    external_code: str | None = Field(None, alias="externalCode")
+    files: MetaArray[File] | File | None = Field(None, alias="files")
+    group: Group | None = Field(None, alias="group")
+    meta: Meta | None = Field(None, alias="meta")
+    moment: str | None = Field(None, alias="moment")
+    name: str | None = Field(None, alias="name")
+    organization: Organization | None = Field(None, alias="organization")
+    organization_account: OrganizationAccount | None = Field(None, alias="organizationAccount")
+    owner: Owner | None = Field(None, alias="owner")
+    payed_sum: float | None = Field(None, alias="payedSum")
+    positions: CommissionReportInPosition | None = Field(None, alias="positions")
+    return_to_commissioner_positions: ReturnToCommissionerPosition | None = Field(
+        None, alias="returnToCommissionerPositions"
+    )
+    printed: bool | None = Field(None, alias="printed")
+    published: bool | None = Field(None, alias="published")
+    shared: bool | None = Field(None, alias="shared")
+    project: Project | None = Field(None, alias="project")
+    sales_channel: Meta | None = Field(None, alias="salesChannel")
+    state: Meta | None = Field(None, alias="state")
+    rate: Rate | None = Field(None, alias="rate")
+    reward_percent: int | None = Field(None, alias="rewardPercent")
+    reward_type: str | None = Field(None, alias="rewardType")
+    sum: float | None = Field(None, alias="sum")
+    sync_id: str | None = Field(None, alias="syncId")
+    updated: str | None = Field(None, alias="updated")
+    vat_enabled: bool | None = Field(None, alias="vatEnabled")
+    vat_included: bool | None = Field(None, alias="vatIncluded")
+    vat_sum: float | None = Field(None, alias="vatSum")

moysklad_api-0.5.15a1/src/moysklad_api/types/commissionreportin_position.py

@@ -0,0 +1,17 @@
+from pydantic import Field
+
+from .assortment import Assortment
+from .entity import Entity
+from .pack import Pack
+
+
+class CommissionReportInPosition(Entity):
+    id: str | None = Field(None, alias="id")
+    account_id: str | None = Field(None, alias="accountId")
+    assortment: Assortment | None = Field(None, alias="assortment")
+    pack: Pack | None = Field(None, alias="pack")
+    price: float | None = Field(None, alias="price")
+    quantity: float | None = Field(None, alias="quantity")
+    reward: float | None = Field(None, alias="reward")
+    vat: int | None = Field(None, alias="vat")
+    vat_enabled: bool | None = Field(None, alias="vatEnabled")

moysklad_api-0.5.15a1/src/moysklad_api/types/return_to_commissioner_position.py

@@ -0,0 +1,15 @@
+from pydantic import Field
+
+from .assortment import Assortment
+from .entity import Entity
+
+
+class ReturnToCommissionerPosition(Entity):
+    id: str | None = Field(None, alias="id")
+    account_id: str | None = Field(None, alias="accountId")
+    assortment: Assortment | None = Field(None, alias="assortment")
+    price: float | None = Field(None, alias="price")
+    quantity: float | None = Field(None, alias="quantity")
+    reward: float | None = Field(None, alias="reward")
+    vat: int | None = Field(None, alias="vat")
+    vat_enabled: bool | None = Field(None, alias="vatEnabled")