Pickup
extends EasyPostObject
in package
Table of Contents
- $address : Address
- $carrier_accounts : array<string|int, CarrierAccount>
- $confirmation : string
- $created_at : string
- $id : string
- $instructions : string
- $is_account_address : bool
- $max_datetime : string
- $messages : array<string|int, Message>
- $min_datetime : string
- $mode : string
- $object : string
- $pickup_rates : array<string|int, PickupRate>
- $reference : string
- $status : string
- $updated_at : string
- $_immutableValues : array<string|int, mixed>
- $_values : array<string|int, mixed>
- $_name : mixed
- $_parent : mixed
- __construct() : mixed
- Constructor for EasyPost objects.
- __get() : mixed
- Getter.
- __isset() : bool
- `isset` magic method.
- __set() : void
- Standard accessor magic methods.
- __toArray() : array<string|int, mixed>
- Convert object to an array.
- __toJSON() : string|bool
- Convert object to JSON.
- __toString() : string
- Convert object to a string.
- __unset() : void
- `unset` magic method.
- constructFrom() : mixed
- Construct EasyPost objects from a response.
- convertEach() : void
- Convert each piece of an EasyPost object.
- current() : mixed
- Iterator methods.
- key() : mixed
- Iterator methods.
- lowestRate() : PickupRate
- Get the lowest rate for the pickup.
- next() : void
- Iterator methods.
- offsetExists() : bool
- ArrayAccess methods.
- offsetGet() : mixed
- ArrayAccess methods.
- offsetSet() : void
- ArrayAccess methods.
- offsetUnset() : void
- ArrayAccess methods.
- rewind() : void
- Iterator methods.
- valid() : bool
- Iterator methods.
Properties
$address
public
Address
$address
$carrier_accounts
public
array<string|int, CarrierAccount>
$carrier_accounts
$confirmation
public
string
$confirmation
$created_at
public
string
$created_at
$id
public
string
$id
$instructions
public
string
$instructions
$is_account_address
public
bool
$is_account_address
$max_datetime
public
string
$max_datetime
$messages
public
array<string|int, Message>
$messages
$min_datetime
public
string
$min_datetime
$mode
public
string
$mode
$object
public
string
$object
$pickup_rates
public
array<string|int, PickupRate>
$pickup_rates
$reference
public
string
$reference
$status
public
string
$status
$updated_at
public
string
$updated_at
$_immutableValues
protected
array<string|int, mixed>
$_immutableValues
$_values
protected
array<string|int, mixed>
$_values
$_name
private
mixed
$_name
$_parent
private
mixed
$_parent
Methods
__construct()
Constructor for EasyPost objects.
public
__construct([mixed $parent = null ][, mixed $name = null ]) : mixed
Parameters
- $parent : mixed = null
- $name : mixed = null
Return values
mixed —__get()
Getter.
public
__get(string $k) : mixed
Parameters
- $k : string
Return values
mixed —__isset()
`isset` magic method.
public
__isset(string $k) : bool
Parameters
- $k : string
Return values
bool —__set()
Standard accessor magic methods.
public
__set(string $k, mixed $v) : void
Parameters
- $k : string
- $v : mixed
Return values
void —__toArray()
Convert object to an array.
public
__toArray([bool|null $recursive = false ]) : array<string|int, mixed>
Parameters
- $recursive : bool|null = false
Return values
array<string|int, mixed> —__toJSON()
Convert object to JSON.
public
__toJSON() : string|bool
Return values
string|bool —__toString()
Convert object to a string.
public
__toString() : string
Return values
string —__unset()
`unset` magic method.
public
__unset(string $k) : void
Parameters
- $k : string
Return values
void —constructFrom()
Construct EasyPost objects from a response.
public
static constructFrom(EasyPostClient|null $client, array<string|int, mixed> $values, string $class) : mixed
Parameters
- $client : EasyPostClient|null
- $values : array<string|int, mixed>
- $class : string
Return values
mixed —convertEach()
Convert each piece of an EasyPost object.
public
convertEach(EasyPostClient|null $client, array<string|int, mixed> $values) : void
Parameters
- $client : EasyPostClient|null
- $values : array<string|int, mixed>
Return values
void —current()
Iterator methods.
public
current() : mixed
Return values
mixed —key()
Iterator methods.
public
key() : mixed
Return values
mixed —lowestRate()
Get the lowest rate for the pickup.
public
lowestRate([array<string|int, string>|null $carriers = [] ][, array<string|int, string>|null $services = [] ]) : PickupRate
To exclude a carrier or service, prepend the string with !.
Parameters
- $carriers : array<string|int, string>|null = []
- $services : array<string|int, string>|null = []
Return values
PickupRate —next()
Iterator methods.
public
next() : void
Return values
void —offsetExists()
ArrayAccess methods.
public
offsetExists(mixed $k) : bool
Parameters
- $k : mixed
Return values
bool —offsetGet()
ArrayAccess methods.
public
offsetGet(mixed $k) : mixed
Parameters
- $k : mixed
Return values
mixed —offsetSet()
ArrayAccess methods.
public
offsetSet(mixed $k, mixed $v) : void
Parameters
- $k : mixed
- $v : mixed
Return values
void —offsetUnset()
ArrayAccess methods.
public
offsetUnset(mixed $k) : void
Parameters
- $k : mixed
Return values
void —rewind()
Iterator methods.
public
rewind() : void
Return values
void —valid()
Iterator methods.
public
valid() : bool