Batch
Class Payload
Table of Contents
Methods
- addItem() : $this
- Add item.
- getArray() : mixed
- getCode() : string
- Get code.
- getExternalId() : string
- Get external ID.
- getItems() : array<string|int, Item>|array<string|int, LeadItem>
- Get item instances.
- getRequestId() : string
- Get request ID.
- getSource() : string
- Get source.
- setArray() : $this
- Set array.
- setCode() : $this
- Set code.
- setExternalId() : $this
- Set external ID.
- setLeadItemsArray() : $this
- Set lead items array.
- setRequestId() : $this
- Set request ID.
- setSource() : $this
- Set request ID.
Methods
addItem()
Add item.
public
addItem(Item $item) : $this
Parameters
- $item : Item
-
Item instance.
Return values
$thisgetArray()
public
getArray() : mixed
getCode()
Get code.
public
getCode() : string
Return values
stringgetExternalId()
Get external ID.
public
getExternalId() : string
Return values
stringgetItems()
Get item instances.
public
getItems() : array<string|int, Item>|array<string|int, LeadItem>
Return values
array<string|int, Item>|array<string|int, LeadItem>getRequestId()
Get request ID.
public
getRequestId() : string
Return values
stringgetSource()
Get source.
public
getSource() : string
Return values
stringsetArray()
Set array.
public
setArray(array<string|int, mixed> $data) : $this
Parameters
- $data : array<string|int, mixed>
Return values
$thissetCode()
Set code.
public
setCode(string $code) : $this
Parameters
- $code : string
-
Code.
Return values
$thissetExternalId()
Set external ID.
public
setExternalId(string $externalId) : $this
Parameters
- $externalId : string
-
External ID.
Return values
$thissetLeadItemsArray()
Set lead items array.
public
setLeadItemsArray(array<string|int, mixed> $items) : $this
Parameters
- $items : array<string|int, mixed>
-
Items.
Return values
$thissetRequestId()
Set request ID.
public
setRequestId(string $requestId) : $this
Parameters
- $requestId : string
-
Request ID.
Return values
$thissetSource()
Set request ID.
public
setSource(string $source) : $this
Parameters
- $source : string
-
Source.