ApiError
extends BaseEnum
in package
This describes an API error.
Tags
Table of Contents
- apiAuthFailed() :
- authFailed() :
- authorizationException() :
- customerAlreadyActive() :
- customerExists() :
- customerNotActivated() :
- labels() : array<string|int, mixed>
- methodNotAllowed() :
- missingParameter() :
- modelNotFound() :
- needAuth() :
- singleOptinCustomerExists() :
- throttleRequestsException() :
- validationFailed() :
- values() : array<string|int, mixed>
- wrongTimeStamp() :
Methods
apiAuthFailed()
public
static apiAuthFailed() :
The authentification to the api failed. You may have to check into config or .env file for your brand credentials
Return values
—authFailed()
public
static authFailed() :
The authentification for this customer failed because of wrong credentials
Return values
—authorizationException()
public
static authorizationException() :
You are maybe trying to access data that is out of your range. This should not happen normally, it is here to allow you to handle this case. If this happens fill a ticket on https://supportweb.ldc.fr with some technical details
Return values
—customerAlreadyActive()
public
static customerAlreadyActive() :
You have requested to activate a customer account, but it is already active
Return values
—customerExists()
public
static customerExists() :
The customer already exists
Return values
—customerNotActivated()
public
static customerNotActivated() :
The customer account is not activated and cannot perform this action
Return values
—labels()
public
static labels() : array<string|int, mixed>
Return values
array<string|int, mixed> —methodNotAllowed()
public
static methodNotAllowed() :
This http method is not allowed
Return values
—missingParameter()
public
static missingParameter() :
The request is missing some parameters
Return values
—modelNotFound()
public
static modelNotFound() :
The request model was not found (typically the customer)
Return values
—needAuth()
public
static needAuth() :
This action requires to be authenticated
Return values
—singleOptinCustomerExists()
public
static singleOptinCustomerExists() :
You have requested to create a single optin for an email, but it already exists
Return values
—throttleRequestsException()
public
static throttleRequestsException() :
Too many requests have been attempted. The is a throttle security. Normally you should not trigger this. If this happens fill a ticket on https://supportweb.ldc.fr with some technical details
Return values
—validationFailed()
public
static validationFailed() :
This means some data could not be validated, you may have to look into message to get the details
Return values
—values()
public
static values() : array<string|int, mixed>
Return values
array<string|int, mixed> —wrongTimeStamp()
public
static wrongTimeStamp() :
The timestamp given is wrong. This would happen in case if a replay attack scenario. Timestamps are provided in headers and in the http body