partnerFlyerService

partnerFlyerService

• partnerFlyerService
  • Request(body) ⇒ Promise.<ApiResult>
  • GetByPartner(request) ⇒ Promise.<ApiResult>
  • MarkSending(flyerId) ⇒ Promise.<ApiResult>
  • Cancel(flyerId) ⇒ Promise.<ApiResult>

Request(body) ⇒ Promise.<ApiResult>

Запрашивает выдачу флаеров партнёру: по одной выдаче на каждый переданный тип.

Партнёр переходит в статус «ожидает флаер», для бумажной выдачи бэкенд заказывает сопроводительное письмо, для электронной — сразу отправляет имейл с приложенным макетом.

Принимаемые параметры

Param	Type	Description
body	RequestPartnerFlyersRequestDto	Партнёр и список типов с макетами. См. RequestPartnerFlyersRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Созданные выдачи под полем flyers

WARNING

Макет (mailFlyerId) обязателен для обоих типов: бумажный менеджер печатает, электронный уходит вложением. Незавершённая выдача того же типа у партнёра может быть только одна.

Пример

await partnerFlyerService.Request({
  partnerId: 42,
  flyers: [
    { flyerType: FlyerTypeDto.MailFlyer, mailFlyerId: 3 },
    { flyerType: FlyerTypeDto.EmailFlyer, mailFlyerId: 3 },
  ],
})

---

GetByPartner(request) ⇒ Promise.<ApiResult>

Получает выдачи флаеров партнёра вместе с выбранным макетом

Принимаемые параметры

Param	Type	Description
request	GetPartnerFlyersRequestDto	Идентификатор партнёра. См. GetPartnerFlyersRequestDto

Возвращаемые данные

Returns: Promise.<ApiResult> - Выдачи под полем flyers

---

MarkSending(flyerId) ⇒ Promise.<ApiResult>

Отмечает, что менеджер отправляет бумажную партию флаеров.

Принимаемые параметры

Param	Type	Description
flyerId	number	ID выдачи флаера

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

WARNING

Только для бумажной выдачи: статус электронной ведёт само письмо.

---

Cancel(flyerId) ⇒ Promise.<ApiResult>

Отменяет выдачу флаера и архивирует связанное письмо.

Принимаемые параметры

Param	Type	Description
flyerId	number	ID выдачи флаера

Возвращаемые данные

Returns: Promise.<ApiResult> - Подтверждение операции

WARNING

Отправленную выдачу отменить нельзя. Живую электронную — тоже: её ведёт письмо, отмена доступна только если отправка провалилась.

---