Skip to content

Mindbox-Helpers-CustomerHelper.md

Latest commit

 

History

History
425 lines (187 loc) · 17.4 KB

Mindbox-Helpers-CustomerHelper.md

File metadata and controls

425 lines (187 loc) · 17.4 KB

Mindbox\Helpers\CustomerHelper

Хелпер, являющий обёрткой над универсальным запросом. Содержит методы для отправки запросов, связанных с действиями над потребителем.

Class CustomerHelper

Properties

$client

protected \Mindbox\Clients\AbstractMindboxClient $client
  • Visibility: protected

Methods

authorize

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::authorize(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.AuthorizeCustomer:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

checkByPhone

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::checkByPhone(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.CheckCustomerByMobilePhone:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

checkByMail

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::checkByMail(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.CheckCustomerByEmail:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

register

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::register(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.RegisterCustomer:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

edit

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::edit(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.EditCustomer:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

fill

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::fill(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.FillCustomerProfile:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

getDataByDiscountCard

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::getDataByDiscountCard(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.GetCustomerDataByDiscountCard:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

merge

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::merge(\Mindbox\DTO\V3\Requests\MergeCustomersRequestDTO $customersToMerge, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.MergeCustomers:

  • Visibility: public

Arguments

  • $customersToMerge Mindbox\DTO\V3\Requests\MergeCustomersRequestDTO - <p>Объект, содержащий данные объединяемых потребителей для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

checkActive

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::checkActive(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.CheckCustomerIsInLoyalityProgram:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

getBonusPointsHistory

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::getBonusPointsHistory(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, \Mindbox\DTO\V3\Requests\PageRequestDTO $page, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.GetCustomerBonusPointsHistory:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $page Mindbox\DTO\V3\Requests\PageRequestDTO - <p>Объект, содержащий данные пагинации для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

sendAuthorizationCode

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::sendAuthorizationCode(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID, boolean $isSync)

Выполняет вызов стандартной операции Website.SendMobilePhoneAuthorizationCode:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>
  • $isSync boolean - <p>Флаг, сообщающий о необходимости выполнять запрос синхронно/асинхронно.</p>

checkAuthorizationCode

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::checkAuthorizationCode(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $authentificationCode, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.CheckMobilePhoneAuthorizationCode:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $authentificationCode string - <p>Код аутентификации.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

resendConfirmationCode

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::resendConfirmationCode(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID, boolean $isSync)

Выполняет вызов стандартной операции Website.ResendMobilePhoneConfirmationCode:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>
  • $isSync boolean - <p>Флаг, сообщающий о необходимости выполнять запрос синхронно/асинхронно.</p>

confirmMobile

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::confirmMobile(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, \Mindbox\DTO\V3\Requests\SmsConfirmationRequestDTO $smsConfirmation, string $operationName, boolean $addDeviceUUID, boolean $isSync)

Выполняет вызов стандартной операции Website.ConfirmMobilePhone:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $smsConfirmation Mindbox\DTO\V3\Requests\SmsConfirmationRequestDTO - <p>Объект, содержащий код подтверждения.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>
  • $isSync boolean - <p>Флаг, сообщающий о необходимости выполнять запрос синхронно/асинхронно.</p>

subscribe

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::subscribe(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID, boolean $isSync)

Выполняет вызов стандартной операции Website.SubscribeCustomer:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>
  • $isSync boolean - <p>Флаг, сообщающий о необходимости выполнять запрос синхронно/асинхронно.</p>

autoConfirmMobile

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::autoConfirmMobile(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.AutoConfirmMobilePhone:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

getBalance

\Mindbox\Clients\AbstractMindboxClient Mindbox\Helpers\CustomerHelper::getBalance(\Mindbox\DTO\V3\Requests\CustomerRequestDTO $customer, string $operationName, boolean $addDeviceUUID)

Выполняет вызов стандартной операции Website.GetCustomerBalance:

  • Visibility: public

Arguments

  • $customer Mindbox\DTO\V3\Requests\CustomerRequestDTO - <p>Объект, содержащий данные потребителя для запроса.</p>
  • $operationName string - <p>Название операции.</p>
  • $addDeviceUUID boolean - <p>Флаг, сообщающий о необходимости передать в запросе DeviceUUID.</p>

__construct

mixed Mindbox\Helpers\AbstractMindboxHelper::__construct(\Mindbox\Clients\AbstractMindboxClient $client)

Конструктор AbstractMindboxHelper.

Arguments

createOperation

\Mindbox\DTO\V3\OperationDTO Mindbox\Helpers\AbstractMindboxHelper::createOperation()

Инициализация объекта OperationDTO.

getLastResponse

\Mindbox\MindboxResponse Mindbox\Helpers\AbstractMindboxHelper::getLastResponse()

Возвращает экземпляр последнего ответа от Mindbox.

sendRequest

\Mindbox\MindboxResponse Mindbox\Helpers\AbstractMindboxHelper::sendRequest()

getRequest

\Mindbox\MindboxRequest Mindbox\Helpers\AbstractMindboxHelper::getRequest()