CheckoutRequest
in package
implements
JsonSerializable
Class CheckoutRequest
Tags
Table of Contents
Interfaces
- JsonSerializable
Constants
- STATUS_ID_DONE = 2
- STATUS_ID_FAILED = -1
- STATUS_ID_FAILURE_RESOLVED = -2
- STATUS_ID_NOT_STARTED = 0
- STATUS_ID_PENDING = 1
- STATUS_LABEL_DONE = "active"
- STATUS_LABEL_FAILED = "creation_failed"
- STATUS_LABEL_FAILURE_RESOLVED = "failure_resolved"
- STATUS_LABEL_MAP = [self::STATUS_ID_FAILURE_RESOLVED => self::STATUS_LABEL_FAILURE_RESOLVED, self::STATUS_ID_FAILED => self::STATUS_LABEL_FAILED, self::STATUS_ID_NOT_STARTED => self::STATUS_LABEL_NOT_STARTED, self::STATUS_ID_PENDING => self::STATUS_LABEL_PENDING, self::STATUS_ID_DONE => self::STATUS_LABEL_DONE]
- STATUS_LABEL_NOT_STARTED = "creation_not_started"
- STATUS_LABEL_PENDING = "creation_pending"
Properties
- $billingData : array<string|int, mixed>
- $checkoutRequestOss : array<string|int, CheckoutRequestOss>
- $checkoutRequestProforma : array<string|int, CheckoutRequestProforma>
- $checkoutRequestVatReg : array<string|int, CheckoutRequestVatReg>
- $client : Client
- $endTime : DateTime
- $excessPayments : int
- $id : int|null
- $ipAddress : string
- $loggedInUserAccountId : int
- $promotionalCredits : int
- $refundableCredits : int
- $requestTime : DateTime
- $requestUserAccountId : int
- $responseMessage : string|null
- $startTime : DateTime
- $status : int
- $unbilledCharges : int
Methods
- __construct() : mixed
- getBillingData() : array<string|int, mixed>
- Get the value of billingData
- getCheckoutRequestOss() : array<string|int, CheckoutRequestOss>
- Get the value of checkoutRequestOss
- getCheckoutRequestProforma() : array<string|int, CheckoutRequestProforma>
- Get the value of checkoutRequestProforma
- getCheckoutRequestVatReg() : array<string|int, CheckoutRequestVatReg>
- Get the value of checkoutRequestVatReg
- getCheckoutRequestVatRegArray() : mixed
- getClient() : Client
- Get the value of client
- getEndTime() : DateTime
- Get the value of endTime
- getExcessPayments() : int
- Get the value of excessPayments
- getId() : int|null
- Get $id
- getIpAddress() : string
- Get the value of ipAddress
- getLoggedInUserAccountId() : int
- Get the value of loggedInUserAccountId
- getPromotionalCredits() : int
- Get the value of promotionalCredits
- getRefundableCredits() : int
- Get the value of refundableCredits
- getRequestTime() : DateTime
- Get the value of requestTime
- getRequestUserAccountId() : int
- Get the value of requestUserAccountId
- getResponseMessage() : string|null
- Get the value of responseMessage
- getStartTime() : DateTime
- Get the value of startTime
- getStatus() : int
- Get the value of status
- getSubscriptions() : array<string|int, CheckoutRequestVatReg>|array<string|int, CheckoutRequestProforma>
- getUnbilledCharges() : int
- Get the value of unbilledCharges
- jsonSerialize() : mixed
- setBillingData() : self
- Set the value of billingData
- setClient() : self
- Set the value of client
- setEndTime() : self
- Set the value of endTime
- setExcessPayments() : self
- Set the value of excessPayments
- setIpAddress() : self
- Set the value of ipAddress
- setLoggedInUserAccountId() : self
- Set the value of loggedInUserAccountId
- setPromotionalCredits() : self
- Set the value of promotionalCredits
- setRefundableCredits() : self
- Set the value of refundableCredits
- setRequestTime() : self
- Set the value of requestTime
- setRequestUserAccountId() : self
- Set the value of requestUserAccountId
- setResponseMessage() : self
- Set the value of responseMessage
- setStartTime() : self
- Set the value of startTime
- setStatus() : self
- Set the value of status
- setUnbilledCharges() : self
- Set the value of unbilledCharges
Constants
STATUS_ID_DONE
public
mixed
STATUS_ID_DONE
= 2
STATUS_ID_FAILED
public
mixed
STATUS_ID_FAILED
= -1
STATUS_ID_FAILURE_RESOLVED
public
mixed
STATUS_ID_FAILURE_RESOLVED
= -2
STATUS_ID_NOT_STARTED
public
mixed
STATUS_ID_NOT_STARTED
= 0
STATUS_ID_PENDING
public
mixed
STATUS_ID_PENDING
= 1
STATUS_LABEL_DONE
public
mixed
STATUS_LABEL_DONE
= "active"
STATUS_LABEL_FAILED
public
mixed
STATUS_LABEL_FAILED
= "creation_failed"
STATUS_LABEL_FAILURE_RESOLVED
public
mixed
STATUS_LABEL_FAILURE_RESOLVED
= "failure_resolved"
STATUS_LABEL_MAP
public
mixed
STATUS_LABEL_MAP
= [self::STATUS_ID_FAILURE_RESOLVED => self::STATUS_LABEL_FAILURE_RESOLVED, self::STATUS_ID_FAILED => self::STATUS_LABEL_FAILED, self::STATUS_ID_NOT_STARTED => self::STATUS_LABEL_NOT_STARTED, self::STATUS_ID_PENDING => self::STATUS_LABEL_PENDING, self::STATUS_ID_DONE => self::STATUS_LABEL_DONE]
STATUS_LABEL_NOT_STARTED
public
mixed
STATUS_LABEL_NOT_STARTED
= "creation_not_started"
STATUS_LABEL_PENDING
public
mixed
STATUS_LABEL_PENDING
= "creation_pending"
Properties
$billingData
private
array<string|int, mixed>
$billingData
Tags
$checkoutRequestOss
private
array<string|int, CheckoutRequestOss>
$checkoutRequestOss
Tags
$checkoutRequestProforma
private
array<string|int, CheckoutRequestProforma>
$checkoutRequestProforma
Tags
$checkoutRequestVatReg
private
array<string|int, CheckoutRequestVatReg>
$checkoutRequestVatReg
Tags
$client
private
Client
$client
Tags
$endTime
private
DateTime
$endTime
Tags
$excessPayments
private
int
$excessPayments
Tags
$id
private
int|null
$id
Tags
$ipAddress
private
string
$ipAddress
Tags
$loggedInUserAccountId
private
int
$loggedInUserAccountId
Tags
$promotionalCredits
private
int
$promotionalCredits
Tags
$refundableCredits
private
int
$refundableCredits
Tags
$requestTime
private
DateTime
$requestTime
Tags
$requestUserAccountId
private
int
$requestUserAccountId
Tags
$responseMessage
private
string|null
$responseMessage
Tags
$startTime
private
DateTime
$startTime
Tags
$status
private
int
$status
Tags
$unbilledCharges
private
int
$unbilledCharges
Tags
Methods
__construct()
public
__construct() : mixed
getBillingData()
Get the value of billingData
public
getBillingData() : array<string|int, mixed>
Return values
array<string|int, mixed>getCheckoutRequestOss()
Get the value of checkoutRequestOss
public
getCheckoutRequestOss() : array<string|int, CheckoutRequestOss>
Return values
array<string|int, CheckoutRequestOss>getCheckoutRequestProforma()
Get the value of checkoutRequestProforma
public
getCheckoutRequestProforma() : array<string|int, CheckoutRequestProforma>
Return values
array<string|int, CheckoutRequestProforma>getCheckoutRequestVatReg()
Get the value of checkoutRequestVatReg
public
getCheckoutRequestVatReg() : array<string|int, CheckoutRequestVatReg>
Return values
array<string|int, CheckoutRequestVatReg>getCheckoutRequestVatRegArray()
public
getCheckoutRequestVatRegArray() : mixed
getClient()
Get the value of client
public
getClient() : Client
Return values
ClientgetEndTime()
Get the value of endTime
public
getEndTime() : DateTime
Return values
DateTimegetExcessPayments()
Get the value of excessPayments
public
getExcessPayments() : int
Return values
intgetId()
Get $id
public
getId() : int|null
Return values
int|nullgetIpAddress()
Get the value of ipAddress
public
getIpAddress() : string
Return values
stringgetLoggedInUserAccountId()
Get the value of loggedInUserAccountId
public
getLoggedInUserAccountId() : int
Return values
intgetPromotionalCredits()
Get the value of promotionalCredits
public
getPromotionalCredits() : int
Return values
intgetRefundableCredits()
Get the value of refundableCredits
public
getRefundableCredits() : int
Return values
intgetRequestTime()
Get the value of requestTime
public
getRequestTime() : DateTime
Return values
DateTimegetRequestUserAccountId()
Get the value of requestUserAccountId
public
getRequestUserAccountId() : int
Return values
intgetResponseMessage()
Get the value of responseMessage
public
getResponseMessage() : string|null
Return values
string|nullgetStartTime()
Get the value of startTime
public
getStartTime() : DateTime
Return values
DateTimegetStatus()
Get the value of status
public
getStatus() : int
Return values
intgetSubscriptions()
public
getSubscriptions() : array<string|int, CheckoutRequestVatReg>|array<string|int, CheckoutRequestProforma>
Return values
array<string|int, CheckoutRequestVatReg>|array<string|int, CheckoutRequestProforma>getUnbilledCharges()
Get the value of unbilledCharges
public
getUnbilledCharges() : int
Return values
intjsonSerialize()
public
jsonSerialize() : mixed
setBillingData()
Set the value of billingData
public
setBillingData(array<string|int, mixed> $billingData) : self
Parameters
- $billingData : array<string|int, mixed>
Return values
selfsetClient()
Set the value of client
public
setClient(Client $client) : self
Parameters
- $client : Client
Return values
selfsetEndTime()
Set the value of endTime
public
setEndTime(DateTime $endTime) : self
Parameters
- $endTime : DateTime
Return values
selfsetExcessPayments()
Set the value of excessPayments
public
setExcessPayments(int $excessPayments) : self
Parameters
- $excessPayments : int
Return values
selfsetIpAddress()
Set the value of ipAddress
public
setIpAddress(string $ipAddress) : self
Parameters
- $ipAddress : string
Return values
selfsetLoggedInUserAccountId()
Set the value of loggedInUserAccountId
public
setLoggedInUserAccountId(int $loggedInUserAccountId) : self
Parameters
- $loggedInUserAccountId : int
Return values
selfsetPromotionalCredits()
Set the value of promotionalCredits
public
setPromotionalCredits(int $promotionalCredits) : self
Parameters
- $promotionalCredits : int
Return values
selfsetRefundableCredits()
Set the value of refundableCredits
public
setRefundableCredits(int $refundableCredits) : self
Parameters
- $refundableCredits : int
Return values
selfsetRequestTime()
Set the value of requestTime
public
setRequestTime(DateTime $requestTime) : self
Parameters
- $requestTime : DateTime
Return values
selfsetRequestUserAccountId()
Set the value of requestUserAccountId
public
setRequestUserAccountId(int $requestUserAccountId) : self
Parameters
- $requestUserAccountId : int
Return values
selfsetResponseMessage()
Set the value of responseMessage
public
setResponseMessage(string|null $responseMessage) : self
Parameters
- $responseMessage : string|null
Return values
selfsetStartTime()
Set the value of startTime
public
setStartTime(DateTime $startTime) : self
Parameters
- $startTime : DateTime
Return values
selfsetStatus()
Set the value of status
public
setStatus(int $status) : self
Parameters
- $status : int
Return values
selfsetUnbilledCharges()
Set the value of unbilledCharges
public
setUnbilledCharges(int $unbilledCharges) : self
Parameters
- $unbilledCharges : int