Типы#

class playerokapi.types.FileObject(id: str, url: str, filename: str | None, mime: str | None)#

Объект файла.

Параметры:

id (str) – ID файла.
url (str) – URL файла.
filename (str or None) – Имя файла.
mime (str or None) – Mime файла.

id: str#: ID файла.

url: str#: URL файла.

filename: str | None#: Имя файла.

mime: str | None#: Mime файла.

class playerokapi.types.AccountBalance(id: str, value: int, frozen: int, available: int, withdrawable: int, pending_income: int)#

Подкласс, описывающий баланс аккаунта.

Параметры:

id (str) – ID баланса.
value (int) – Сумма баланса.
frozen (int) – Сумма замороженного баланса.
available (int) – Сумма доступного баланса.
withdrawable (int) – Сумма баланса, доступного для вывода.
pending_income (int) – Ожидаемый доход.

id: str#: ID баланса.

value: int#: Сумма общего баланса.

frozen: int#: Сумма замороженного баланса.

available: int#: Сумма доступного баланса.

withdrawable: int#: Сумма баланса, доступного для вывода.

pending_income: int#: Ожидаемый доход.

class playerokapi.types.AccountIncomingDealsStats(total: int, finished: int)#

Подкласс, описывающий статистику входящих сделок аккаунта.

Параметры:

total (int) – Всего исходящих сделок.
finished (int) – Завершённых исходящих сделок.

total: int#: Всего исходящих сделок.

finished: int#: Кол-во завершённых исходящих сделок.

class playerokapi.types.AccountOutgoingDealsStats(total: int, finished: int)#

Подкласс, описывающий статистику исходящих сделок аккаунта.

Параметры:

total (int) – Всего исходящих сделок.
finished (int) – Завершённых исходящих сделок.

total#: Всего исходящих сделок.

finished#: Кол-во завершённых исходящих сделок.

class playerokapi.types.AccountDealsStats(incoming: AccountIncomingDealsStats, outgoing: AccountOutgoingDealsStats)#

Подкласс, описывающий статистику сделок аккаунта.

Параметры:

incoming (playerokapi.types.AccountIncomingDealsStats) – Входящие сделки.
outgoing (playerokapi.types.AccountOutgoingDealsStats) – Исходящие сделки.

incoming: AccountIncomingDealsStats#: Входящие сделки.

outgoing: AccountOutgoingDealsStats#: Исходящие сделки.

class playerokapi.types.AccountItemsStats(total: int, finished: int)#

Подкласс, описывающий статистику предметов аккаунта.

Параметры:

total (int) – Всего предметов.
finished (int) – Завершённых предметов.

total: int#: Всего предметов.

finished: int#: Кол-во завершённых предметов.

class playerokapi.types.AccountStats(items: AccountItemsStats, deals: AccountDealsStats)#

Подкласс, описывающий статистику аккаунта.

Параметры:

items (playerokapi.types.AccountItemsStats) – Статистика предметов.
deals (playerokapi.types.AccountDealsStats) – Статистика сделок.

items: AccountItemsStats#: Статистика предметов.

deals: AccountDealsStats#: Статистика сделок.

class playerokapi.types.AccountProfile(id: str, username: str, email: str, balance: AccountBalance, stats: AccountStats, role: UserTypes, avatar_url: str, is_online: bool, is_blocked: bool, is_blocked_for: str, is_verified: bool, rating: int, reviews_count: int, created_at: str, support_chat_id: str, system_chat_id: str, has_frozen_balance: bool, has_enabled_notifications: bool, unread_chats_counter: int | None)#

Класс, описывающий профиль аккаунта.

Параметры:

id (str) – ID аккаунта.
username (str) – Никнейм аккаунта.
email (str) – Почта аккаунта.
balance (playerokapi.types.AccountBalance) – Объект баланса аккаунта.
stats (str) – Статистика аккаунта.
role (playerokapi.enums.UserTypes) – Роль аккаунта.
avatar_url (str) – URL аватара аккаунта.
is_online (bool) – В онлайне ли сейчас аккаунт.
is_blocked (bool) – Заблокирован ли аккаунт.
is_blocked_for (str) – Причина блокировки.
is_verified (bool) – Верифицирован ли аккаунт.
rating (int) – Рейтинг аккаунта (0-5).
reviews_count (int) – Кол-во отзывов на аккаунте.
created_at (str) – Дата создания аккаунта.
support_chat_id (str) – ID чата поддержки.
system_chat_id (str) – ID системного чата.
has_frozen_balance (bool) – Заморожен ли баланс на аккаунте.
has_enabled_notifications (bool) – Включены ли уведомления на аккаунте.
unread_chats_counter (int or None) – Количество непрочитанных чатов.

id: str#: ID аккаунта.

username: str#: Никнейм аккаунта.

email: str#: Почта аккаунта.

balance: AccountBalance#: Объект баланса аккаунта.

stats: AccountStats#: Статистика аккаунта.

role: UserTypes#: Роль аккаунта.

avatar_url: str#: URL аватара аккаунта.

is_online: bool#: В онлайне ли сейчас аккаунт.

is_blocked: bool#: Заблокирован ли аккаунт.

is_blocked_for: str#: Причина блокировки аккаунта.

is_verified: bool#: Верифицирован ли аккаунт.

rating: int#: Рейтинг аккаунта (0-5).

reviews_count: int#: Кол-во отзывов на аккаунте.

created_at: str#: Дата создания аккаунта.

support_chat_id: str#: ID чата поддержки аккаунта.

system_chat_id: str#: ID системного чата аккаунта.

has_frozen_balance: bool#: Заморожен ли баланс на аккаунте.

has_enabled_notifications: bool#: Включены ли уведомления на аккаунте.

unread_chats_counter: bool | None#: Количество непрочитанных сообщений.

class playerokapi.types.UserProfile(id: str, username: str, role: UserTypes, avatar_url: str, is_online: bool, is_blocked: bool, rating: int, reviews_count: int, support_chat_id: str, system_chat_id: str | None, created_at: str | None)#

Класс, описывающий профиль пользователя.

Параметры:

id (str) – ID пользователя.
username (str) – Никнейм пользователя.
role (playerokapi.enums.UserTypes) – Роль пользователя.
avatar_url (str) – URL аватара пользователя.
is_online (bool) – В онлайне ли сейчас пользователь.
is_blocked (bool) – Заблокирован ли пользователь.
rating (int) – Рейтинг пользователя (0-5).
reviews_count (int) – Кол-во отзывов пользователя.
support_chat_id (str or None) – ID чата поддержки.
system_chat_id (str or None) – ID системного чата.
created_at (str) – Дата создания аккаунта пользователя.

id: str#: ID пользователя.

username: str#: Никнейм пользователя.

role: UserTypes#: Роль пользователя.

avatar_url: str#: URL аватара.

is_online: bool#: В онлайне ли сейчас пользователь.

is_blocked: bool#: Заблокирован ли пользователь.

rating: int#: Рейтинг пользователя (0-5).

reviews_count: int#: Кол-во отзывов пользователя.

support_chat_id: str | None#: ID чата поддержки.

system_chat_id: str | None#: ID системного чата.

created_at: str#: Дата создания аккаунта пользователя.

Получает предметы пользователя.

Параметры:

game_id (str or None) – ID игры/приложения, чьи предметы нужно получить, _опционально_.
category_id (str or None) – ID категории игры/приложения, чьи предметы нужно получить, _опционально_.
obtaining_type_id (str or None) – ID типа получения товара, _опционально_.
statuses (list[playerokapi.enums.ItemStatuses] or None) – Статусы, предметы которых нужно получать.
count (int) – Кол-во предеметов, которые нужно получить (не более 24 за один запрос), _опционально_.
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.

Результат:

Страница профилей предметов.

Тип результата:

PlayerokAPI.types.ItemProfileList

get_reviews(count: int = 24, comment_required: bool = False, rating: int | None = None, game_id: str | None = None, category_id: str | None = None, min_item_price: int | None = None, max_item_price: int | None = None, sort_direction: SortDirections = SortDirections.DESC, sort_field: str = 'createdAt', after_cursor: str | None = None) → ReviewList#

Получает отзывы пользователя.

Параметры:

count (int) – Кол-во отзывов, которые нужно получить (не более 24 за один запрос), _опционально_.
comment_required (bool) – Обязателен ли комментарий в отзыве, _опционально_.
rating (int or None) – Рейтинг отзывов (1-5), _опционально_.
game_id (str or None) – ID игры отзывов, _опционально_.
category_id (str or None) – ID категории отзывов, _опционально_.
min_item_price (bool or None) – Минимальная цена предмета отзыва, _опционально_.
max_item_price (bool or None) – Максимальная цена предмета отзыва, _опционально_.
sort_direction (playerokapi.enums.SortDirections) – Тип сортировки.
sort_field (str) – Поле, по которому будет идти сортировка (по умолчанию createdAt - по дате)
after_cursor (str or None) – Курсор, с которого будет идти парсинг (если нету - ищет с самого начала страницы), _опционально_.

Результат:

Страница отзывов.

Тип результата:

PlayerokAPI.types.ReviewList

class playerokapi.types.ItemDealProps(auto_confirm_period: int)#

Параметры сделки.

Параметры:: auto_confirm_period (int) – Срок авто-подтверждения сделки (в днях).

auto_confirm_period: int#: Срок авто-подтверждения сделки (в днях).

class playerokapi.types.ItemDeal(id: str, status: ItemDealStatuses, status_expiration_date: str | None, status_description: str | None, direction: ItemDealDirections, obtaining: str | None, has_problem: bool, report_problem_enabled: bool | None, completed_user: UserProfile | None, props: str | None, previous_status: ItemDealStatuses | None, completed_at: str, created_at: str, logs: list[ItemLog] | None, transaction: Transaction | None, user: UserProfile, chat: Chat | None, item: Item, review: Review | None, obtaining_fields: list[GameCategoryDataField] | None, comment_from_buyer: str | None)#

Объект сделки с предметом.

Параметры:

id (str) – ID сделки.
status (playerokapi.enums.ItemDealStatuses) – Статус сделки.
status_expiration_date (str or None) – Дата истечения статуса.
status_description (str or None) – Описание статуса сделки ().
direction (playerokapi.enums.ItemDealDirections) – Направление сделки (покупка/продажа).
obtaining (str or None) – Получение сделки.
has_problem (bool) – Есть ли проблема в сделке.
report_problem_enabled (bool or None) – Включено ли обжалование проблемы.
completed_user (playerokapi.types.UserProfile or None) – Профиль пользователя, подтвердившего сделку.
props (str or None) – Прочие настройки сделки.
previous_status (playerokapi.enums.ItemDealStatuses or None) – Предыдущий статус.
completed_at (str or None) – Дата подтверждения сделки.
created_at (str or None) – Дата создания сделки.
logs (list[playerokapi.types.ItemLog] or None) – Логи сделки.
transaction (playerokapi.types.Transaction or None) – Транзакция сделки.
user (playerokapi.types.UserProfile) – Профиль пользователя, совершившего сделку.
chat (playerokapi.types.Chat or None) – Чат сделки (передаётся только его ID).
item (playerokapi.types.Item) – Предмет сделки.
review (playerokapi.types.Review or None) – Отзыв по сделке.
obtaining_fields (list[playerokapi.types.GameCategoryDataField] or None) – Получаемые поля.
comment_from_buyer (str or None) – Комментарий от покупателя.

id: str#: ID сделки.

status: ItemDealStatuses#: Статус сделки.

status_expiration_date: str | None#: Дата истечения статуса.

status_description: str | None#: Описание статуса сделки.

direction: ItemDealDirections#: Направление сделки (покупка/продажа).

obtaining: str | None#: Получение сделки.

has_problem: bool#: Есть ли проблема в сделке.

report_problem_enabled: bool | None#: Включено ли обжалование проблемы.

completed_user: UserProfile | None#: Профиль пользователя, подтвердившего сделку.

props: str | None#: Прочие настройки сделки.

previous_status: ItemDealStatuses | None#: Предыдущий статус.

completed_at: str | None#: Дата подтверждения сделки.

created_at: str | None#: Дата создания сделки.

logs: list[ItemLog] | None#: Логи сделки.

transaction: Transaction | None#: Транзакция сделки.

user: UserProfile#: Профиль пользователя, совершившего сделку.

chat: Chat | None#: Чат сделки (передаётся только его ID).

item: Item#: Предмет сделки.

review: Review | None#: Отзыв по сделке.

obtaining_fields: list[GameCategoryDataField] | None#: Получаемые поля.

comment_from_buyer: str | None#: Комментарий от покупателя.

class playerokapi.types.ItemDealPageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице сделок.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.ItemDealList(deals: list[ItemDeal], page_info: ItemDealPageInfo, total_count: int)#

Класс, описывающий страницу отзывов.

Параметры:

deals (list[playerokapi.types.ItemDeal]) – Сделки страницы.
page_info (playerokapi.types.ItemDealPageInfo) – Информация о странице.
total_count (int) – Всего сделок.

deals: list[ItemDeal]#: Сделки страницы.

page_info: ItemDealPageInfo#: Информация о странице.

total_count: int#: Всего сделок.

class playerokapi.types.GameCategoryAgreement(id: str, description: str, icontype: GameCategoryAgreementIconTypes, sequence: int)#

Подкласс, описывающий соглашения покупателя.

Параметры:

id (str) – ID соглашения.
description (str) – Описание соглашения.
icontype (playerokapi.enums.GameCategoryAgreementIconTypes) – Тип иконки соглашения.
sequence (str) – Последовательность соглашения.

id: str#: ID соглашения.

description: str#: Описание соглашения.

icontype: GameCategoryAgreementIconTypes#: Тип иконки соглашения.

sequence: str#: Последовательность соглашения.

class playerokapi.types.GameCategoryAgreementPageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице соглашений покупателя.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.GameCategoryAgreementList(agreements: list[GameCategoryAgreement], page_info: GameCategoryAgreementPageInfo, total_count: int)#

Класс, описывающий страницу соглашений покупателя.

Параметры:

agreements (list[playerokapi.types.GameCategoryAgreement]) – Соглашения страницы.
page_info (playerokapi.types.GameCategoryAgreementPageInfo) – Информация о странице.
total_count (int) – Всего соглашений.

agreements: list[GameCategoryAgreement]#: Соглашения страницы.

page_info: GameCategoryAgreementPageInfo#: Информация о странице.

total_count: int#: Всего соглашений.

class playerokapi.types.GameCategoryObtainingType(id: str, name: str, description: str, game_category_id: str, no_comment_from_buyer: bool, instruction_for_buyer: str | None, instruction_for_seller: str | None, sequence: int, fee_multiplier: float, agreements: list[GameCategoryAgreement], props: GameCategoryProps)#

Подкласс, описывающий тип (способ) получения предмета в категории.

Параметры:

id (str) – ID способа.
name (str) – Название способа.
description (str) – Описание способа.
game_category_id (str) – ID категории игры способа.
no_comment_from_buyer (bool) – Без комментария от покупателя?
instruction_for_buyer (str) – Инструкция для покупателя.
instruction_for_seller (str) – Инструкция для продавца.
sequence (int) – Последовательность способа.
fee_multiplier (float) – Множитель комиссии.
agreements (list[playerokapi.types.GameCategoryAgreement]) – Соглашения покупателя на покупку/продавца на продажу.
props (playerokapi.types.GameCategoryProps) – Пропорции категории.

id: str#: ID способа.

name: str#: Название способа.

description: str#: Описание способа.

game_category_id: str#: ID категории игры способа.

no_comment_from_buyer: bool#: Без комментария от покупателя?

instruction_for_buyer: str | None#: Инструкция для покупателя.

instruction_for_seller: str | None#: Инструкция для продавца.

sequence: int#: Последовательность способа.

fee_multiplier: float#: Множитель комиссии.

agreements: list[GameCategoryAgreement]#: Соглашения покупателя на покупку/продавца на продажу.

props: GameCategoryProps#: Пропорции категории.

class playerokapi.types.GameCategoryObtainingTypePageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице типов (способов) получения предмета в категории.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.GameCategoryObtainingTypeList(obtaining_types: list[GameCategoryObtainingType], page_info: GameCategoryObtainingTypePageInfo, total_count: int)#

Класс, описывающий страницу типов (способов) получения предмета в категории.

Параметры:

obtaining_types (list[playerokapi.types.GameCategoryObtainingType]) – Способы страницы.
page_info (playerokapi.types.GameCategoryObtainingTypePageInfo) – Информация о странице.
total_count (int) – Всего способов.

obtaining_types: list[GameCategoryObtainingType]#: Соглашения страницы.

page_info: GameCategoryAgreementPageInfo#: Информация о странице.

total_count: int#: Всего способов.

class playerokapi.types.GameCategoryDataField(id: str, label: str, type: GameCategoryDataFieldTypes, input_type: GameCategoryDataFieldInputTypes, copyable: bool, hidden: bool, required: bool, value: str | None)#

Подкласс, описывающий поля с данными предмета в категории (которые отправляются после покупки).

Параметры:

id (str) – ID поля с данными.
label (str) – Надпись-название поля.
type (playerokapi.enums.GameCategoryDataFieldTypes) – Тип поля с данными.
input_type (playerokapi.enums.GameCategoryDataFieldInputTypes) – Тип вводимого значения поля.
copyable (bool) – Разрешено ли копирование значения с поля.
hidden (bool) – Скрыты ли данные в поле.
required (bool) – Обязательно ли это поле.
value (str or None) – Значение данных в поле.

id: str#: ID поля с данными.

label: str#: Надпись-название поля.

type: GameCategoryDataFieldTypes#: Тип поля с данными.

input_type: GameCategoryDataFieldInputTypes#: Тип вводимого значения поля.

copyable: bool#: Разрешено ли копирование значения с поля.

hidden: bool#: Скрыты ли данные в поле.

required: bool#: Обязательно ли это поле.

value: str | None#: Значение данных в поле.

class playerokapi.types.GameCategoryDataFieldPageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице полей с данными предмета.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.GameCategoryDataFieldList(data_fields: list[GameCategoryDataField], page_info: GameCategoryDataFieldPageInfo, total_count: int)#

Класс, описывающий страницу полей с данными предмета.

Параметры:

data_fields (list[playerokapi.types.GameCategoryDataField]) – Поля с данными предмета в категории на странице.
page_info (playerokapi.types.GameCategoryDataFieldPageInfo) – Информация о странице.
total_count (int) – Всего полей с данными.

data_fields: list[GameCategoryDataField]#: Поля с данными предмета в категории на странице.

page_info: GameCategoryDataFieldPageInfo#: Информация о странице.

total_count: int#: Всего полей с данными.

class playerokapi.types.GameCategoryProps(min_reviews: int, min_reviews_for_seller: int)#

Подкласс, описывающий пропорции категории.

Параметры:

min_reviews (int) – Минимальное количество отзывов.
min_reviews_for_seller (int) – Минимальное количество отзывов для продавца.

min_reviews: int#: Минимальное количество отзывов.

min_reviews_for_seller: int#: Минимальное количество отзывов для продавца.

class playerokapi.types.GameCategoryOption(id: str, group: str, label: str, type: GameCategoryOptionTypes, field: str, value: str, value_range_limit: int | None)#

Подкласс, описывающий опцию категории.

Параметры:

id (str) – ID опции.
group (str) – Группа опции.
label (str) – Надпись-название опции.
type (playerokapi.enums.GameCategoryOptionTypes) – Тип опции.
field (str) – Название поля (для payload запроса на сайт).
value (str) – Значение поля (для payload запроса на сайт).
value_range_limit (int or None) – Лимит разброса по значению.

id: str#: ID опции.

group: str#: Группа опции.

label: str#: Надпись-название опции.

type: GameCategoryOptionTypes#: Тип опции.

field: str#: Название поля (для payload запроса на сайт).

value: str#: Значение поля (для payload запроса на сайт).

value_range_limit: int | None#: Лимит разброса по значению.

class playerokapi.types.GameCategoryInstruction(id: str, text: str)#

Подкласс, описывающий информацию о странице инструкии по продаже/покупке в категории.

Параметры:

id (str) – ID инструкции.
text (str) – Текст инструкции.

id: str#: ID инструкции.

text: str#: Текст инструкции.

class playerokapi.types.GameCategoryInstructionPageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий инструкцию по продаже/покупке в категории.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.GameCategoryInstructionList(instructions: list[GameCategoryInstruction], page_info: GameCategoryInstructionPageInfo, total_count: int)#

Класс, описывающий страницу инструкций по продаже/покупке в категории.

Параметры:

instructions (list[playerokapi.types.GameCategoryInstruction]) – Инструкции страницы.
page_info (playerokapi.types.GameCategoryInstructionPageInfo) – Информация о странице.
total_count (int) – Всего инструкций.

instructions: list[GameCategoryInstruction]#: Соглашения страницы.

page_info: GameCategoryInstructionPageInfo#: Информация о странице.

total_count: int#: Всего инструкций.

Объект категории игры/приложения.

Параметры:

id (str) – ID категории.
slug (str) – Имя страницы категории.
name (str) – Название категории.
category_id (str or None) – ID родительской категории.
game_id (str or None) – ID игры категории.
obtaining (str or None or None) – Тип получения.
options (list[playerokapi.types.GameCategoryOption] or None) – Опции категории.
props (playerokapi.types.GameCategoryProps or None) – Пропорции категории.
no_comment_from_buyer (bool or None) – Без комментария от покупателя?
instruction_for_buyer (str or None) – Инструкция для покупателя.
instruction_for_seller (str or None) – Инструкция для продавца.
use_custom_obtaining (bool) – Используется ли кастомное получение.
auto_confirm_period (playerokapi.enums.GameCategoryAutoConfirmPeriods or None) – Период авто-подтверждения сделки этой категории.
auto_moderation_mode (bool or None) – Включена ли автоматическая модерация.
agreements (list[playerokapi.types.GameCategoryAgreement] or None) – Соглашения покупателя.
fee_multiplier (float or None) – Множитель комиссии.

id: str#: ID категории.

slug: str#: Имя страницы категории.

name: str#: Название категории.

category_id: str | None#: ID родительской категории.

game_id: str | None#: ID игры категории.

obtaining: str | None#: Тип получения.

options: list[GameCategoryOption] | None#: Опции категории.

props: str | None#: Пропорции категории.

no_comment_from_buyer: bool | None#: Без комментария от покупателя?

instruction_for_buyer: str | None#: Инструкция для покупателя.

instruction_for_seller: str | None#: Инструкция для продавца.

use_custom_obtaining: bool#: Используется ли кастомное получение.

auto_confirm_period: GameCategoryAutoConfirmPeriods | None#: Период авто-подтверждения сделки этой категории.

auto_moderation_mode: bool | None#: Включена ли автоматическая модерация.

agreements: list[GameCategoryAgreement] | None#: Соглашения покупателя.

fee_multiplier: float | None#: Множитель комиссии.

class playerokapi.types.Game(id: str, slug: str, name: str, type: GameTypes, logo: FileObject, banner: FileObject, categories: list[GameCategory], created_at: str)#

Объект игры/приложения.

Параметры:

id (str) – ID игры/приложения.
slug (str) – Имя страницы игры/приложения.
name (str) – Название игры/приложения.
type (playerokapi.enums.GameTypes) – Тип: игра или приложение.
logo (playerokapi.types.FileObject) – Лого игры/приложения.
banner (FileObject) – Баннер игры/приложения.
categories (list[playerokapi.types.GameCategory]) – Список категорий игры/приложения.
created_at (str) – Дата создания.

id: str#: ID игры/приложения.

slug: str#: Имя страницы игры/приложения.

name: str#: Название игры/приложения.

type: GameTypes#

игра или приложение.

Type:: Тип

logo: FileObject#: Лого игры/приложения.

banner: FileObject#: Баннер игры/приложения.

categories: list[GameCategory]#: Список категорий игры/приложения.

created_at: str#: Дата создания.

class playerokapi.types.GameProfile(id: str, slug: str, name: str, type: GameTypes, logo: FileObject)#

Профиль игры/приложения.

Параметры:

id (str) – ID игры/приложения.
slug (str) – Имя страницы игры/приложения.
name (str) – Название игры/приложения.
type (playerokapi.types.GameTypes) – Тип: игра или приложение.
logo (playerokapi.types.FileObject) – Лого игры/приложения.

id: str#: ID игры/приложения.

slug: str#: Имя страницы игры/приложения.

name: str#: Название игры/приложения.

type: GameTypes#

игра или приложение.

Type:: Тип

logo: FileObject#: Лого игры/приложения.

class playerokapi.types.GamePageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице игр.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.GameList(games: list[Game], page_info: GamePageInfo, total_count: int)#

Класс, описывающий страницу игр.

Параметры:

games (list[playerokapi.types.Game]) – Игры/приложения страницы.
page_info (playerokapi.types.ChatPageInfo) – Информация о странице.
total_count (int) – Всего игр.

games: list[Game]#: Игры/приложения страницы.

page_info: ChatPageInfo#: Информация о странице.

total_count: int#: Всего игр.

class playerokapi.types.ItemPriorityStatusPriceRange(min: int, max: str)#

Подкласс, описывающий ценовой диапазон предмета, подходящего для опред. статуса приоритета.

Параметры:

min (int) – Минимальная цена предмета.
max (int) – Максимальная цена предмета.

min: int#: Минимальная цена предмета (в рублях).

max: int#: Максимальная цена предмета (в рублях).

class playerokapi.types.ItemPriorityStatus(id: str, price: int, name: str, type: PriorityTypes, period: int, price_range: ItemPriorityStatusPriceRange)#

Класс, описывающий статус приоритета предмета.

Параметры:

id (str) – ID статуса приоритета.
price (int) – Цена статуса (в рублях).
name (str) – Название статуса.
type (playerokapi.enums.PriorityTypes) – Тип статуса.
period (str) – Длительность статуса (в днях).
price_range (playerokapi.types.ItemPriorityStatusPriceRange) – Ценовой диапазон предмета статуса.

id: str#: ID статуса приоритета.

price: int#: Цена статуса (в рублях).

name: str#: Название статуса.

type: PriorityTypes#: Тип статуса.

period: int#: Длительность статуса (в днях).

price_range: ItemPriorityStatusPriceRange#: Ценовой диапазон предмета статуса.

class playerokapi.types.ItemLog(id: str, event: ItemLogEvents, created_at: str, user: UserProfile)#

Подкласс, описывающий лог действия с предметом.

Параметры:

id (str) – ID лога.
event (playerokapi.enums.ItemLogEvents) – Событие лога.
created_at (str) – Дата создания лога.
user (playerokapi.types.UserProfile) – Профиль пользователя, совершившего лог.

id: str#: ID лога.

event: ItemLogEvents#: Событие лога.

created_at: str#: Дата создания лога.

user: UserProfile#: Профиль пользователя, совершившего лог.

class playerokapi.types.Item(id: str, slug: str, name: str, description: str, obtaining_type: GameCategoryObtainingType | None, price: int, raw_price: int, priority: PriorityTypes, priority_position: int, attachments: list[FileObject], attributes: dict, category: GameCategory, comment: str | None, data_fields: list[GameCategoryDataField] | None, fee_multiplier: float, game: GameProfile, seller_type: UserTypes, status: ItemStatuses, user: UserProfile)#

Объект предмета.

Параметры:

id (str) – ID предмета.
name (str) – Название предмета.
description (str) – Описание предмета.
status (playerokapi.enums.ItemStatuses) – Статус предмета.
obtaining_type (playerokapi.types.GameCategoryObtainingType or None) – Способ получения.
price (int) – Цена предмета.
raw_price (int) – Цена без учёта скидки.
priority (playerokapi.enums.PriorityTypes) – Статус приоритета.
priority_position (int) – Приоритетная позиция.
attachments (list[playerokapi.types.FileObject]) – Файлы-приложения.
attributes (dict) – Аттрибуты предмета.
category (playerokapi.types.GameCategory) – Категория игры предмета.
comment (str or None) – Комментарий предмета.
data_fields (list[playerokapi.types.GameCategoryDataField] or None) – Поля данных предмета.
fee_multiplier (float) – Множитель комиссии.
game (playerokapi.types.GameProfile) – Профиль игры предмета.
seller_type (playerokapi.enums.UserTypes) – Тип продавца.
slug (str) – Имя страницы предмета.
user (playerokapi.types.UserProfile) – Профиль продавца.

id: str#: ID предмета.

name: str#: Название предмета.

description: str#: Описание предмета.

obtaining_type: GameCategoryObtainingType | None#: Способ получения.

price: int#: Цена предмета.

raw_price: int#: Цена без учёта скидки.

priority: int#: Статус приоритета.

priority_position: int#: Приоритетная позиция.

attachments: list[FileObject]#: Файлы-приложения.

attributes: dict#: Аттрибуты предмета.

category: GameCategory#: Категория игры предмета.

comment: str | None#: Комментарий предмета.

data_fields: list[GameCategoryDataField] | None#: Поля данных предмета.

fee_multiplier: float#: Множитель комиссии.

game: GameProfile#: Профиль игры предмета.

seller_type: UserTypes#: Тип продавца.

slug: str#: Имя страницы предмета.

status: ItemStatuses#: Статус предмета.

user: UserProfile#: Профиль продавца.

class playerokapi.types.MyItem(id: str, slug: str, name: str, description: str, obtaining_type: GameCategoryObtainingType | None, price: int, raw_price: int, priority_position: int, attachments: list[FileObject], attributes: dict, buyer: UserProfile, category: GameCategory, comment: str | None, data_fields: list[GameCategoryDataField] | None, fee_multiplier: float, game: GameProfile, seller_type: UserTypes, status: ItemStatuses, user: UserProfile, prev_price: int, prev_fee_multiplier: float, seller_notified_about_fee_change: bool, priority: PriorityTypes, priority_price: int, sequence: int | None, status_expiration_date: str | None, status_description: str | None, status_payment: Transaction | None, views_counter: int, is_editable: bool, approval_date: str | None, deleted_at: str | None, updated_at: str | None, created_at: str | None)#

Объект своего предмета.

Параметры:

id (str) – ID предмета.
slug (str) – Имя страницы предмета.
name (str) – Название предмета.
description (str) – Описание предмета.
status (playerokapi.enums.ItemStatuses) – Статус предмета.
obtaining_type (playerokapi.types.GameCategoryObtainingType or None) – Способ получения.
price (int) – Цена предмета.
prev_price (int) – Предыдущая цена.
raw_price (int) – Цена без учёта скидки.
priority_position (int) – Приоритетная позиция.
attachments (list[playerokapi.types.FileObject]) – Файлы-приложения.
attributes (dict) – Аттрибуты предмета.
category (playerokapi.types.GameCategory) – Категория игры предмета.
comment (str or None) – Комментарий предмета.
data_fields (list[playerokapi.types.GameCategoryDataField] or None) – Поля данных предмета.
fee_multiplier (float) – Множитель комиссии.
prev_fee_multiplier (float) – Предыдущий множитель комиссии.
seller_notified_about_fee_change (bool) – Оповещён ли продавец о смене комиссии.
game (playerokapi.types.GameProfile) – Профиль игры предмета.
seller_type (playerokapi.enums.UserTypes) – Тип продавца.
user (playerokapi.types.UserProfile) – Профиль продавца.
buyer – Профиль продавца.
priority (playerokapi.types.PriorityTypes) – Статус приоритета предмета.
priority_price (int) – Цены статуса приоритета.
sequence (int or None) – Позиция предмета в таблице товаров пользователей.
status_expiration_date (str or None) – Дата истечения статуса приоритета.
status_description (str or None) – Описание статуса приоритета.
status_payment (playerokapi.types.Transaction or None) – Платёж статуса (транзакция).
views_counter (int) – Количество просмотров предмета.
is_editable (bool) – Можно ли редактировать товар.
approval_date (str or None) – Дата публикации товара.
deleted_at (str or None) – Дата удаления товара.
updated_at (str or None) – Дата последнего обновления товара.
created_at (str or None) – Дата создания товара.

id: str#: ID предмета.

slug: str#: Имя страницы предмета.

name: str#: Название предмета.

status: ItemStatuses#: Статус предмета.

description: str#: Описание предмета.

obtaining_type: GameCategoryObtainingType | None#: Способ получения.

price: int#: Цена предмета.

prev_price: int#: Предыдущая цена.

raw_price: int#: Цена без учёта скидки.

priority_position: int#: Приоритетная позиция.

attachments: list[FileObject]#: Файлы-приложения.

attributes: dict#: Аттрибуты предмета.

category: GameCategory#: Категория игры предмета.

comment: str | None#: Комментарий предмета.

data_fields: list[GameCategoryDataField] | None#: Поля данных предмета.

fee_multiplier: float#: Множитель комиссии.

prev_fee_multiplier: float#: Предыдущий множитель комиссии.

seller_notified_about_fee_change: bool#: Оповещён ли продавец о смене комиссии.

game: GameProfile#: Профиль игры предмета.

seller_type: UserTypes#: Тип продавца.

user: UserProfile#: Профиль продавца.

buyer: UserProfile#: Профиль покупателя предмета (если продан).

priority: PriorityTypes#: Статус приоритета предмета.

priority_price: int#: Цены статуса приоритета.

sequence: int | None#: Позиция предмета в таблице товаров пользователей.

status_expiration_date: str | None#: Дата истечения статуса приоритета.

status_description: str | None#: Описание статуса приоритета.

status_payment: str | None#: Платёж статуса (транзакция).

views_counter: int#: Количество просмотров предмета.

is_editable: bool#: Можно ли редактировать товар.

approval_date: str | None#: Дата публикации товара.

deleted_at: str | None#: Дата удаления товара.

updated_at: str | None#: Дата последнего обновления товара.

created_at: str | None#: Дата создания товара.

class playerokapi.types.ItemProfile(id: str, slug: str, priority: PriorityTypes, status: ItemStatuses, name: str, price: int, raw_price: int, seller_type: UserTypes, attachment: FileObject, user: UserProfile, approval_date: str, priority_position: int, views_counter: int | None, fee_multiplier: float, created_at: str)#

Профиль предмета.

Параметры:

id (str) – ID предмета.
slug (str) – Имя страницы предмета.
priority (playerokapi.enums.PriorityTypes) – Приоритет предмета.
status (playerokapi.enums.ItemStatuses) – Статус предмета.
name (str) – Название предмета.
price (int) – Цена предмета.
raw_price (int) – Цена без учёта скидки.
seller_type (playerokapi.enums.UserTypes) – Тип продавца.
attachment (playerokapi.types.FileObject) – Файл-приложение.
user (playerokapi.types.UserProfile) – Профиль продавца.
approval_date (str) – Дата одобрения.
priority_position (int) – Приоритетная позиция.
views_counter (int or None) – Количество просмотров.
fee_multiplier (float) – Множитель комиссии.
created_at (str) – Дата создания.

id: str#: ID предмета.

slug: str#: Имя страницы предмета.

priority: PriorityTypes#: Приоритет предмета.

status: ItemStatuses#: Статус предмета.

name: str#: Название предмета.

price: int#: Цена предмета.

raw_price: int#: Цена без учёта скидки.

seller_type: UserTypes#: Тип продавца.

attachment: FileObject#: Файл-приложение.

user: UserProfile#: Профиль продавца.

approval_date: str#: Дата одобрения.

priority_position: int#: Приоритетная позиция.

views_counter: int | None#: Количество просмотров.

fee_multiplier: float#: Множитель комиссии.

created_at: str#: Дата создания.

class playerokapi.types.ItemProfilePageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице предметов.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.ItemProfileList(items: list[ItemProfile], page_info: ItemProfilePageInfo, total_count: int)#

Профиль страницы предметов.

Параметры:

items (list[playerokapi.types.Item]) – Предметы страницы.
page_info (playerokapi.types.ItemProfilePageInfo) – Информация о странице.
total_count (int) – Всего предметов.

items: list[ItemProfile]#: Предметы страницы.

page_info: ItemProfilePageInfo#: Информация о странице.

total_count: int#: Всего предметов.

class playerokapi.types.SBPBankMember(id: str, name: str, icon: str)#

Объект членов СБП банка.

Параметры:

id (str) – ID.
name (str) – Название.
icon (str) – URL иконки.

id: str#: ID.

name: str#: Название.

icon: str#: URL иконки.

class playerokapi.types.TransactionPaymentMethod(id: TransactionPaymentMethodIds, name: str, fee: int, provider_id: TransactionProviderIds, account: AccountProfile | None, props: TransactionProviderProps, limits: TransactionProviderLimits)#

Платёжный метод транзакции.

Параметры:

id (playerokapi.types.TransactionPaymentMethodIds) – ID метода.
name (str) – Название метода.
fee (int) – Комиссия метода.
provider_id (playerokapi.types.TransactionProviderIds) – ID провайдера транзакции.
account (AccountProfile or None) – Аккаунт метода (?).
props (playerokapi.types.TransactionProviderProps) – Параметры провайдера транзакции.
limits (playerokapi.types.TransactionProviderLimits) – Лимиты провайдера транзакции.

id: TransactionPaymentMethodIds#: ID метода.

name: str#: Названиие метода.

fee: int#: Комиссия метода.

provider_id: TransactionProviderIds#: ID провайдера транзакции.

account: AccountProfile | None#: Аккаунт метода (?).

props: TransactionProviderProps#: Параметры провайдера транзакции.

limits: TransactionProviderLimits#: Лимиты провайдера транзакции.

class playerokapi.types.TransactionProviderLimitRange(min: int, max: int)#

Диапозон лимитов провайдера транзакции.

Параметры:

min (int) – Минимальная сумма (в рублях).
max (int) – Максимальная сумма (в рублях).

min: int#: Минимальная сумма (в рублях).

max: int#: Максимальная сумма (в рублях).

class playerokapi.types.TransactionProviderLimits(incoming: TransactionProviderLimitRange, outgoing: TransactionProviderLimitRange)#

Лимиты провайдера транзакции.

Параметры:

incoming (playerokapi.types.TransactionProviderLimitRange) – На пополнение.
outgoing (playerokapi.types.TransactionProviderLimitRange) – На вывод.

incoming: TransactionProviderLimitRange#: На пополнение.

outgoing: TransactionProviderLimitRange#: На вывод.

class playerokapi.types.TransactionProviderRequiredUserData(email: bool, phone_number: bool, erip_account_number: bool | None)#

Обязательные пользовательские данные провайдера транзакции.

Параметры:

email (bool) – Обязательно ли указывать EMail?
phone_number (bool) – Обязательно ли указывать номер телефона?
erip_account_number (bool or None) – Обязательно ли указывать номер аккаунта ЕРИП?

email: bool#: Обязательно ли указывать EMail?

phone_number: bool#: Обязательно ли указывать номер телефона?

erip_account_number: bool | None#: Обязательно ли указывать номер аккаунта ЕРИП?

class playerokapi.types.TransactionProviderProps(required_user_data: TransactionProviderRequiredUserData, tooltip: str | None)#

Параметры провайдера транзакции.

Параметры:

required_user_data (playerokapi.types.TransactionProviderRequiredUserData) – Обязательные пользовательские данные.
tooltip (str or None) – Подсказка.

required_user_data: TransactionProviderRequiredUserData#: Обязательные пользовательские данные.

tooltip: str | None#: Подсказка.

class playerokapi.types.TransactionProvider(id: TransactionProviderIds, name: str, fee: int, min_fee_amount: int | None, description: str | None, account: AccountProfile | None, props: TransactionProviderProps, limits: TransactionProviderLimits, payment_methods: list[TransactionPaymentMethod])#

Объект провайдера транзакции.

Параметры:

id (playerokapi.enums.TransactionProviderIds) – ID провайдера.
name (str) – Название провайдера.
fee (int) – Комиссия провайдера.
min_fee_amount (int or None) – Минимальная комиссия.
description (str or None) – Описание провайдера.
account (playerokapi.types.AccountProfile or None) – Аккаунт провайдера (?).
props (playerokapi.types.TransactionProviderProps) – Параметры провайдера.
limits (playerokapi.types.TransactionProviderLimits) – Лимиты провайдера.
payment_methods (list of playerokapi.types.TransactionPaymentMethod) – Платёжные методы.

id: TransactionProviderIds#: ID провайдера.

name: str#: Название провайдера.

fee: int#: Комиссия провайдера.

min_fee_amount: int | None#: Минимальная комиссия.

description: str | None#: Описание провайдера.

account: AccountProfile | None#: Аккаунт провайдера (?).

props: TransactionProviderProps#: Параметры провайдера.

limits: TransactionProviderLimits#: Лимиты провайдера.

payment_methods: list[TransactionPaymentMethod]#: Платёжные методы.

class playerokapi.types.Transaction(id: str, operation: TransactionOperations, direction: TransactionDirections, provider_id: TransactionProviderIds, provider: TransactionProvider, user: UserProfile, creator: UserProfile, status: TransactionStatuses, status_description: str | None, status_expiration_date: str | None, value: int, fee: int, created_at: str, verified_at: str | None, verified_by: UserProfile | None, completed_at: str | None, completed_by: UserProfile | None, payment_method_id: str | None, is_suspicious: bool | None, sbp_bank_name: str | None)#

Объект транзакции.

Параметры:

id (str) – ID транзакции.
operation (playerokapi.enums.TransactionOperations) – Тип выполненной операции.
direction (playerokapi.enums.TransactionDirections) – Направление транзакции.
provider_id (playerokapi.enums.TransactionProviderIds) – ID платёжного провайдера.
provider (playerokapi.types.TransactionProvider) – Объект провайдера транзакции.
user (playerokapi.types.UserProfile) – Объект пользователя-совершателя транзакции.
creator (playerokapi.types.UserProfile or None) – Объект пользователя-создателя транзакции.
status (playerokapi.enums.TransactionStatuses) – Статус обработки транзакции.
status_description (str or None) – Описание статуса.
status_expiration_date (str or None) – Дата истечения статуса.
value (int) – Сумма транзакции.
fee (int) – Комиссия транзакции.
created_at (str) – Дата создания транзакции.
verified_at (str or None) – Дата подтверждения транзакции.
verified_by (playerokapi.types.UserProfile or None) – Объект пользователя, подтвердившего транзакцию.
completed_at (str or None) – Дата выполнения транзакции.
completed_by (playerokapi.types.UserProfile or None) – Объект пользователя, выполнившего транзакцию.
payment_method_id (str or None) – ID способа оплаты.
is_suspicious (bool or None) – Подозрительная ли транзакция.
sbp_bank_name (str or None) – Название банка СБП (если транзакция была совершена с помощью СБП).

id: str#: ID транзакции.

operation: TransactionOperations#: Тип выполненной операции.

direction: TransactionDirections#: Направление транзакции.

provider_id: TransactionProviderIds#: ID платёжного провайдера.

provider: TransactionProvider#: Объект провайдера транзакции.

user: UserProfile#: Объект пользователя-совершателя транзакции.

creator: UserProfile | None#: Объект пользователя-создателя транзакции.

status: TransactionStatuses#: Статус обработки транзакции.

status_description: str | None#: Описание статуса.

status_expiration_date: str | None#: Дата истечения статуса.

value: int#: Сумма транзакции.

fee: int#: Комиссия транзакции.

created_at: str#: Дата создания транзакции.

verified_at: str | None#: Дата подтверждения транзакции.

verified_by: UserProfile | None#: Объект пользователя, подтвердившего транзакцию.

completed_at: str | None#: Дата выполнения транзакции.

completed_by: UserProfile | None#: Объект пользователя, выполнившего транзакцию.

payment_method_id: str | None#: ID способа оплаты.

is_suspicious: bool | None#: Подозрительная ли транзакция.

sbp_bank_name: str | None#: Название банка СБП (если транзакция была совершена с помощью СБП).

class playerokapi.types.TransactionPageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице транзакций.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.TransactionList(transactions: list[Transaction], page_info: TransactionPageInfo, total_count: int)#

Класс, описывающий страницу сообщений чата.

Параметры:

transactions (list[playerokapi.types.Transaction]) – Транзакции страницы.
page_info (playerokapi.types.TransactionPageInfo) – Информация о странице.
total_count (int) – Всего транзакций на странице.

transactions: list[Transaction]#: Транзакции страницы.

page_info: TransactionPageInfo#: Информация о странице.

total_count: int#: Всего транзакций на странице.

class playerokapi.types.UserBankCard(id: str, card_first_six: str, card_last_four: str, card_type: BankCardTypes, is_chosen: bool)#

Объект банковской карты пользователя.

Параметры:

id (str) – ID карты.
card_first_six (str) – Первые шесть цифр карты.
card_last_four (str) – Последние четыре цифры карты.
card_type (playerokapi.enums.BankCardTypes) – Тип банковской карты.
is_chosen (bool) – Выбрана ли эта карта как по умолчанию?

id: str#: ID карты.

card_first_six: str#: Первые шесть цифр карты.

card_last_four: str#: Последние четыре цифры карты.

card_type: BankCardTypes#: Тип банковской карты.

is_chosen: bool#: Выбрана ли эта карта как по умолчанию?

class playerokapi.types.UserBankCardPageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице банковских карт пользователя.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.UserBankCardList(bank_cards: list[UserBankCard], page_info: UserBankCardPageInfo, total_count: int)#

Класс, описывающий страницу банковских карт пользователя.

Параметры:

bank_cards (list[playerokapi.types.UserBankCard]) – Банковские карты страницы.
page_info (playerokapi.types.UserBankCardPageInfo) – Информация о странице.
total_count (int) – Всего банковских карт на странице.

bank_cards: list[UserBankCard]#: Банковские карты страницы.

page_info: UserBankCardPageInfo#: Информация о странице.

total_count: int#: Всего банковских карт на странице.

class playerokapi.types.TemporaryAttachmentUploadOutput(id: str, url: str, chat_id: str, client_attachment_id: str, expires_at: str)#

Выходные данные для загрузки временного вложения (приложенное к сообщению изображение).

Параметры:

id (str) – ID данных.
url (str) – URL изображения.
chat_id (str) – ID чата, куда отправляется изображение.
client_attachment_id (str) – ID файла-приложения клиента.
expires_at (str) – Дата истечения.

id: str#: ID данных.

url: str#: URL изображения.

chat_id: str#: ID чата, куда отправляется изображение.

client_attachment_id: str#: ID приложения клиента.

expires_at: str#: Дата истечения.

class playerokapi.types.ChatMessageButton(type: ChatMessageButtonTypes, url: str | None, text: str)#

Объект кнопки сообщения.

Параметры:

type (playerokapi.types.ChatMessageButtonTypes) – Тип кнопки.
url (str or None) – URL кнопки.
text (str) – Текст кнопки.

type: ChatMessageButtonTypes#: Тип кнопки.

url: str | None#: URL кнопки.

text: str#: Текст кнопки.

class playerokapi.types.ChatMessage(id: str, text: str, created_at: str, deleted_at: str | None, is_read: bool, is_suspicious: bool, is_bulk_messaging: bool, game: Game | None, images: list[FileObject] | None, user: UserProfile, deal: ItemDeal | None, item: ItemProfile | None, transaction: Transaction | None, moderator: Moderator | None, event_by_user: UserProfile | None, event_to_user: UserProfile | None, is_auto_response: bool, event: ChatMessageEvents | None, buttons: list[ChatMessageButton])#

Класс, описывающий сообщение в чате.

Параметры:

id (str) – ID сообщения.
text (str) – Текст сообщения.
created_at (str) – Дата создания сообщения.
deleted_at (str or None) – Дата удаления сообщения.
is_read (bool) – Прочитано ли сообщение.
is_suspicious (bool) – Подозрительное ли сообщение.
is_bulk_messaging (bool) – Массовая ли это рассылка.
game (str or None) – Игра, к которой относится сообщение.
images (list[playerokapi.types.FileObject] or None) – Изображения, прикреплённые к сообщению.
user (playerokapi.types.UserProfile) – Пользователь, который отправил сообщение.
deal (playerokapi.types.Deal or None) – Сделка, к которой относится сообщение.
item (playerokapi.types.Item or None) – Предмет, к которому относится сообщение (обычно передаётся только сама сделка в переменную deal).
transaction (playerokapi.types.Transaction or None) – Транзакция сообщения.
moderator (playerokapi.types.Moderator) – Модератор сообщения.
event_by_user (playerokapi.types.UserProfile or None) – Ивент от пользователя.
event_to_user (playerokapi.types.UserProfile or None) – Ивент для пользователя.
is_auto_response (bool) – Авто-ответ ли это.
event (playerokapi.enums.ChatMessageEvents or None) – Ивент сообщения.
buttons (list[playerokapi.types.MessageButton]) – Кнопки сообщения.

id: str#: ID сообщения.

text: str#: Текст сообщения.

created_at: str#: Дата создания сообщения.

deleted_at: str | None#: Дата удаления сообщения.

is_read: bool#: Прочитано ли сообщение.

is_suspicious: bool#: Подозрительное ли сообщение.

is_bulk_messaging: bool#: Массовая ли это рассылка.

game: Game | None#: Игра, к которой относится сообщение.

images: list[FileObject] | None#: Изображения, прикреплённые к сообщению.

user: UserProfile#: Пользователь, который отправил сообщение.

deal: ItemDeal | None#: Сделка, к которой относится сообщение.

item: ItemProfile | None#: Предмет, к которому относится сообщение (обычно передаётся только сама сделка в переменную deal).

transaction: Transaction | None#: Транзакция сообщения.

moderator: Moderator#: Модератор сообщения.

event_by_user: UserProfile | None#: Ивент от пользователя.

event_to_user: UserProfile | None#: Ивент для пользователя.

is_auto_response: bool#: Авто-ответ ли это.

event: ChatMessageEvents | None#: Ивент сообщения.

buttons: list[ChatMessageButton]#: Кнопки сообщения.

class playerokapi.types.ChatMessagePageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице сообщений.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.ChatMessageList(messages: list[ChatMessage], page_info: ChatMessagePageInfo, total_count: int)#

Класс, описывающий страницу сообщений чата.

Параметры:

messages (list[playerokapi.types.ChatMessage]) – Сообщения страницы.
page_info (playerokapi.types.ChatMessagePageInfo) – Информация о странице.
total_count (int) – Всего сообщений в чате.

messages: list[ChatMessage]#: Сообщения страницы.

page_info: ChatMessagePageInfo#: Информация о странице.

total_count: int#: Всего сообщений в чате.

Объект чата.

Параметры:

id (str) – ID чата.
type (playerokapi.enums.ChatTypes) – Тип чата.
status (playerokapi.enums.ChatStatuses or None) – Статус чата.
unread_messages_counter (int) – Количество непрочитанных сообщений.
bookmarked (bool or None) – В закладках ли чат.
is_texting_allowed (bool or None) – Разрешено ли писать в чат.
owner (bool or None) – Владелец чата (только если это чат с ботом).
deals (list[playerokapi.types.ItemDeal] or None) – Сделки в чате.
last_message (playerokapi.types.ChatMessage or None) – Объект последнего сообщения в чате
users (list[UserProfile]) – Участники чата.
started_at (str or None) – Дата начала диалога.
finished_at (str or None) – Дата завершения диалога.

id: str#: ID чата.

type: ChatTypes#: Тип чата.

status: ChatStatuses | None#: Статус чата.

unread_messages_counter: int#: Количество непрочитанных сообщений.

bookmarked: bool | None#: В закладках ли чат.

is_texting_allowed: bool | None#: Разрешено ли писать в чат.

owner: UserProfile#: Владелец чата.

deals: list[ItemDeal] | None#: Сделки в чате.

last_message: ChatMessage | None#: Объект последнего сообщения в чате.

users: list[UserProfile]#: Участники чата.

started_at: str | None#: Дата начала диалога.

finished_at: str | None#: Дата завершения диалога.

class playerokapi.types.ChatPageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице чатов.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.ChatList(chats: list[Chat], page_info: ChatPageInfo, total_count: int)#

Класс, описывающий страницу чатов.

Параметры:

chats (list[playerokapi.types.Chat]) – Чаты страницы.
page_info (playerokapi.types.ChatPageInfo) – Информация о странице.
total_count (int) – Всего чатов.

chats: list[Chat]#: Чаты страницы.

page_info: ChatPageInfo#: Информация о странице.

total_count: int#: Всего чатов.

class playerokapi.types.Review(id: str, status: ReviewStatuses, text: str | None, rating: int, created_at: str, updated_at: str, deal: ItemDeal, creator: UserProfile, moderator: Moderator | None, user: UserProfile)#

Объект отзыва.

Параметры:

id (str) – ID отзыва.
status (playerokapi.enums.ReviewStatuses) – Статус отзыва.
text (str or None) – Текст отзыва.
rating (int) – Рейтинг отзыва.
created_at (str) – Дата создания отзыва.
updated_at (str) – Дата изменения отзыва.
deal (Deal) – Сделка, связанная с отзывом.
creator (UserProfile) – Профиль создателя отзыва.
moderator (Moderator or None) – Модератор, обработавший отзыв.
user (UserProfile) – Профиль продавца, к которому относится отзыв.

id: str#: ID отзыва.

status: ReviewStatuses#: Статус отзыва.

text: str | None#: Текст отзыва.

rating: int#: Рейтинг отзыва.

created_at: str#: Дата создания отзыва.

updated_at: str#: Дата изменения отзыва.

deal: ItemDeal#: Сделка, связанная с отзывом.

creator: UserProfile#: Профиль создателя отзыва.

moderator: Moderator | None#: Модератор, обработавший отзыв.

user: UserProfile#: Профиль продавца, к которому относится отзыв.

class playerokapi.types.ReviewPageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице отзывов.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.ReviewList(reviews: list[Review], page_info: ReviewPageInfo, total_count: int)#

Класс, описывающий страницу отзывов.

Параметры:

reviews (list[playerokapi.types.Review]) – Отзывы страницы.
page_info (playerokapi.types.ReviewPageInfo) – Информация о странице.
total_count (int) – Всего отзывов.

reviews: list[Review]#: Отзывы страницы.

page_info: ReviewPageInfo#: Информация о странице.

total_count: int#: Всего отзывов.

class playerokapi.types.MessageTemplate(id: str, type: MessageTemplateTypes, title: str, text: str, sequence: int, created_at: str, group: str | None)#

Объект шаблонного сообщения.

Параметры:

id (str) – ID шаблонного сообщения.
type (playerokapi.enums.MessageTemplateTypes) – Тип шаблонного сообщения.
title (str) – Заголовок шаблонного сообщения.
text (str) – Текст шаблонного сообщения.
sequence (int) – Последовательность шаблонного сообщения.
created_at (str) – Дата создания шаблонного соощбения.
group (str or None) – Группа шаблонного сообщения (?).

id: str#: ID шаблонного сообщения.

type: MessageTemplateTypes#: Тип шаблонного сообщения.

title: str#: Заголовок шаблонного сообщения.

text: str#: Текст шаблонного сообщения.

sequence: int#: Последовательность шаблонного сообщения.

created_at: str#: Дата создания шаблонного соощбения.

group: str | None#: Группа шаблонного сообщения (?).

class playerokapi.types.MessageTemplatePageInfo(start_cursor: str, end_cursor: str, has_previous_page: bool, has_next_page: bool)#

Подкласс, описывающий информацию о странице шаблонных сообщений.

Параметры:

start_cursor (str) – Курсор начала страницы.
end_cursor (str) – Курсок конца страницы.
has_previous_page (bool) – Имеет ли предыдущую страницу.
has_next_page (bool) – Имеет ли следующую страницу.

start_cursor: str#: Курсор начала страницы.

end_cursor: str#: Курсор конца страницы.

has_previous_page: bool#: Имеет ли предыдущую страницу.

has_next_page: bool#: Имеет ли следующую страницу.

class playerokapi.types.MessageTemplateList(message_templates: list[MessageTemplate], page_info: MessageTemplatePageInfo, total_count: int)#

Класс, описывающий страницу шаблонных сообщения.

Параметры:

message_templates (list[playerokapi.types.MessageTemplate]) – Шаблонные сообщения страницы.
page_info (playerokapi.types.MessageTemplatePageInfo) – Информация о странице.
total_count (int) – Всего шаблонных сообщений.

message_templates: list[MessageTemplate]#: Шаблонные сообщения страницы.

page_info: MessageTemplatePageInfo#: Информация о странице.

total_count: int#: Всего шаблонных сообщений.