+ Claim
+
+
+ extends EasyPostObject
+
+
+
+ in package
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
++ Table of Contents + +
+ +-
+
- + $approved_amount + + : string + + + +
- + $attachments + + : array<string|int, string> + + + +
- + $check_delivery_address + + : string + + + +
- + $contact_email + + : string + + + +
- + $description + + : string + + + +
- + $history + + : object + + + +
- + $id + + : string + + + +
- + $insurance_amount + + : string + + + +
- + $insurance_id + + : string + + + +
- + $payment_method + + : string + + + +
- + $recipient_name + + : string + + + +
- + $requested_amount + + : string + + + +
- + $salvage_value + + : string + + + +
- + $shipment_id + + : string + + + +
- + $status + + : string + + + +
- + $status_detail + + : string + + + +
- + $status_timestamp + + : string + + + +
- + $tracking_code + + : string + + + +
- + $type + + : 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. + +
- + 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 + +
++ $approved_amount + + + +
+ + + +
+ public
+ string
+ $approved_amount
+
+
+
+
+
+
+
++ $attachments + + + +
+ + + +
+ public
+ array<string|int, string>
+ $attachments
+
+
+
+
+
+
+
++ $check_delivery_address + + + +
+ + + +
+ public
+ string
+ $check_delivery_address
+
+
+
+
+
+
+
++ $contact_email + + + +
+ + + +
+ public
+ string
+ $contact_email
+
+
+
+
+
+
+
++ $description + + + +
+ + + +
+ public
+ string
+ $description
+
+
+
+
+
+
+
++ $history + + + +
+ + + +
+ public
+ object
+ $history
+
+
+
+
+
+
+
++ $id + + + +
+ + + +
+ public
+ string
+ $id
+
+
+
+
+
+
+
++ $insurance_amount + + + +
+ + + +
+ public
+ string
+ $insurance_amount
+
+
+
+
+
+
+
++ $insurance_id + + + +
+ + + +
+ public
+ string
+ $insurance_id
+
+
+
+
+
+
+
++ $payment_method + + + +
+ + + +
+ public
+ string
+ $payment_method
+
+
+
+
+
+
+
++ $recipient_name + + + +
+ + + +
+ public
+ string
+ $recipient_name
+
+
+
+
+
+
+
++ $requested_amount + + + +
+ + + +
+ public
+ string
+ $requested_amount
+
+
+
+
+
+
+
++ $salvage_value + + + +
+ + + +
+ public
+ string
+ $salvage_value
+
+
+
+
+
+
+
++ $shipment_id + + + +
+ + + +
+ public
+ string
+ $shipment_id
+
+
+
+
+
+
+
++ $status + + + +
+ + + +
+ public
+ string
+ $status
+
+
+
+
+
+
+
++ $status_detail + + + +
+ + + +
+ public
+ string
+ $status_detail
+
+
+
+
+
+
+
++ $status_timestamp + + + +
+ + + +
+ public
+ string
+ $status_timestamp
+
+
+
+
+
+
+
++ $tracking_code + + + +
+ + + +
+ public
+ string
+ $tracking_code
+
+
+
+
+
+
+
++ $type + + + +
+ + + +
+ public
+ string
+ $type
+
+
+
+
+
+
+
++ $_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 + — + + ++ 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
+
+
+
+
+
+