cdek.apps.check package¶

class cdek.apps.check.CheckApp(client: CdekClient)[исходный код]¶

Базовые классы: App

Класс для работы с чеками

get(filter_params: CheckFilter) → CheckResponse[исходный код]¶

Метод используется для получения информации о чеке по заказу или за выбранный день

Args:

filter_params (CheckFilter): фильтр для получения: информации о чеке по заказу или за выбранный день

Returns:

CheckResponse: объект с информацией о чеке по заказу или за выбранный день

Raises:

ValueError: если filter_params не является объектом CheckFilter

class cdek.apps.check.CheckFilter(*, order_uuid: str | None, cdek_number: str | None, date: date | None)[исходный код]¶

Базовые классы: BaseModel

Фильтр для получения информации о чеке

cdek_number: str | None¶

date: Date | None¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order_uuid: str | None¶

serialize_date(date: date) → str[исходный код]¶: Преобразовать дату фильтра в строку YYYY-MM-DD

class cdek.apps.check.CheckInfo(*, order_uuid: str, cdek_number: str, date: datetime, document_number: str, fiscal_sign: int, type: Literal['CASH_RECEIPT_IN', 'CASH_RECEIPT_REFUND'], payment_info: list[PaymentInfo], shift_no: int | None = None)[исходный код]¶

Базовые классы: BaseModel

cdek_number: str¶

date: DateTime¶

document_number: str¶

fiscal_sign: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order_uuid: str¶

payment_info: list[PaymentInfo]¶

serialize_date(date: datetime) → str[исходный код]¶: Вернуть дату формирования чека в формате YYYY-MM-DD

shift_no: int | None¶

type: Literal['CASH_RECEIPT_IN', 'CASH_RECEIPT_REFUND']¶

class cdek.apps.check.CheckResponse(*, check_info: list[CheckInfo], errors: list[Error] | None = None, warnings: list[WarningModel] | None = None)[исходный код]¶

Базовые классы: BaseModel

check_info: list[CheckInfo]¶

errors: list[Error] | None¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

warnings: list[WarningModel] | None¶

Submodules¶

cdek.apps.check.check module¶

class cdek.apps.check.check.CheckApp(client: CdekClient)[исходный код]¶

Базовые классы: App

Класс для работы с чеками

get(filter_params: CheckFilter) → CheckResponse[исходный код]¶

Метод используется для получения информации о чеке по заказу или за выбранный день

Args:

filter_params (CheckFilter): фильтр для получения: информации о чеке по заказу или за выбранный день

Returns:

CheckResponse: объект с информацией о чеке по заказу или за выбранный день

Raises:

ValueError: если filter_params не является объектом CheckFilter

cdek.apps.check.filters module¶

class cdek.apps.check.filters.CheckFilter(*, order_uuid: str | None, cdek_number: str | None, date: date | None)[исходный код]¶

Базовые классы: BaseModel

Фильтр для получения информации о чеке

cdek_number: str | None¶

date: Date | None¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order_uuid: str | None¶

serialize_date(date: date) → str[исходный код]¶: Преобразовать дату фильтра в строку YYYY-MM-DD

cdek.apps.check.responses module¶

class cdek.apps.check.responses.CheckInfo(*, order_uuid: str, cdek_number: str, date: datetime, document_number: str, fiscal_sign: int, type: Literal['CASH_RECEIPT_IN', 'CASH_RECEIPT_REFUND'], payment_info: list[PaymentInfo], shift_no: int | None = None)[исходный код]¶

Базовые классы: BaseModel

cdek_number: str¶

date: DateTime¶

document_number: str¶

fiscal_sign: int¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

order_uuid: str¶

payment_info: list[PaymentInfo]¶

serialize_date(date: datetime) → str[исходный код]¶: Вернуть дату формирования чека в формате YYYY-MM-DD

shift_no: int | None¶

type: Literal['CASH_RECEIPT_IN', 'CASH_RECEIPT_REFUND']¶

class cdek.apps.check.responses.CheckResponse(*, check_info: list[CheckInfo], errors: list[Error] | None = None, warnings: list[WarningModel] | None = None)[исходный код]¶

Базовые классы: BaseModel

check_info: list[CheckInfo]¶

errors: list[Error] | None¶

model_config: ClassVar[ConfigDict] = {}¶: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

warnings: list[WarningModel] | None¶