createDeal

Параметры

• ctx:app.Ctx
  Контекст приложения, предоставляющий доступ к различным компонентам и настройкам приложения.

• params:CreateDealParams
  Объект с параметрами для создания сделки.

Свойства params

• user: User
  Объект пользователя, для которого создается сделка.

• system: System (необязательно)
  Объект системы, в рамках которой создается сделка.

• session: Session (необязательно)
  Объект сессии, связанной со сделкой.

• deal: Deal
  Объект сделки, содержащий информацию о создаваемой сделке.

Свойства User

• id?: number - необязательное поле, идентификатор пользователя.
• email?: string - необязательное поле, email пользователя.
• phone?: string - необязательное поле, номер телефона пользователя.
• first_name?: string - необязательное поле, имя пользователя.
• last_name?: string - необязательное поле, фамилия пользователя.
• city?: string - необязательное поле, город пользователя.
• country?: string - необязательное поле, страна пользователя.
• addfields?: { [fieldName: string]: string } - объект, представляющий дополнительные поля. Каждое поле имеет строковый ключ fieldName и строковое значение.

Свойства System

• refresh_if_exists?: 1 | 0 - необязательное свойство, указывающее на необходимость обновления объекта, если он уже существует. Значение 1 означает включение функции, 0 - отключение.
• partner_email?: string - необязательное строковое поле для хранения email партнера.
• return_payment_link?: 1 | 0 - необязательное свойство, указывающее на необходимость возврата ссылки на оплату (значение 1 - да, 0 - нет).
• return_deal_number?: 1 | 0 - необязательное свойство, указывающее на необходимость возврата номера сделки (значение 1 - да, 0 - нет).

Свойства Session

• utm_source?: string - Необязательное поле, которое хранит источник трафика (например, поисковик или сайт).
• utm_medium?: string - Необязательное поле, представляющее тип трафика (например, баннер, органический поиск и т.д.).
• utm_content?: string - Необязательное поле, используемое для дифференциации контента, если на странице есть несколько ссылок.
• utm_campaign?: string - Необязательное поле для хранения названия кампании, к которой относится этот трафик.
• utm_group?: string - Необязательное поле, которое может представлять группу, к которой относится сессия.
• gcpc?: string - Поле, которое может использоваться для дополнительных меток или информации.
• gcao?: string - Еще одно специфичное поле для хранения параметров, связанных с аналитикой.
• referer?: string - Поле для хранения URL-адреса реферера, откуда пользователь перешел на текущую страницу.

Свойства Deal

• recalc_user_product?: 1 | 0 - Необходимость пересчета пользовательского продукта (1 - да, 0 - нет).
• deal_number?: string - Номер сделки.
• offer_code?: string - Код предложения.
• product_title?: string - Название продукта.
• product_description?: string - Описание продукта.
• quantity?: number - Количество продукта в сделке.
• deal_cost?: string - Стоимость сделки.
• deal_status?: DealStatus - Статус сделки.
• deal_is_paid?: 1 | 0 - Оплачена ли сделка (1 - да, 0 - нет).
• manager_email?: string - Email менеджера, ответственного за сделку.
• deal_created_at?: string - Дата создания сделки.
• deal_finished_at?: string - Дата завершения сделки.
• deal_comment?: string - Комментарий к сделке.
• payment_type?: PaymentType - Тип платежа.
• payment_status?: PaymentStatus - Статус платежа.
• partner_email?: string - Email партнера.
• addfields?: { [fieldName: string]: string } - Дополнительные поля сделки.
• deal_currency?: Currency - Валюта сделки.
• offers?: Array<Offer> - Список предложений, связанных с сделкой. Поля предложения включают:
• create_offer?: boolean - Создать предложение (true - да, false - нет).
• offer_id?: number - Идентификатор предложения.
• offer_code?: string - Код предложения.
• quantity: number - Количество.
• product_title?: string - Название продукта.
• cost?: number - Стоимость.
• disable_notifications?: boolean - Отключить уведомления для данной сделки.
• addtags?: string[] - Дополнительные теги, связанные с этой сделкой.

Возвращаемое значение

• Promise<CreateDealResult>
  Тип возвращаемого значения является объектом CreateDealResult, содержащим информацию о результате создания сделки.

Свойства CreateDealResult

• success: boolean
  Успешно ли была создана сделка.

• deal_id: number
  Идентификатор созданной сделки.

• deal_number: number
  Номер созданной сделки.

• user_id: number
  Идентификатор пользователя, для которого была создана сделка.

• user_status: string
  Статус пользователя (например, "added").

• error_message: string
  Сообщение об ошибке, если создание сделки не удалось.

• error: boolean
  Признак ошибки.

• payment_link: string
  Ссылка для оплаты сделки.