# Shipment

class Shipment extends DataModel

Shipment Model with reference to a deliveryNote

## Properties

protected array | $fields |  | from DataModel
protected boolean | $isEncrypted |  | from DataModel
protected Identity | $deliveryNoteId |  |
protected Identity | $id |  |
protected string | $carrierName |  |
protected DateTime | $creationDate |  |
protected string | $identCode |  |
protected string | $note |  |
protected string | $trackingUrl |  |

## Methods

__construct()

Constructor

multitype:
getProperties()

Get the Model Properties

from Model
Model
setOptions(stdClass $object = null, array $options = null)

Sets Properties with matching Array Values

from DataModel
stdClass
getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))

Convert the Model into stdClass Object

from DataModel
toJson()

No description

from Model
mixed:string
getFields()

Fields Getter

from DataModel
validate()

Object Validation

from DataModel
mixed:string|NULL
getField(boolean $toWawi = false, string $key)

Get a Model Member Name

from DataModel
map(boolean $toWawi = false, stdClass $obj = null)

Object Mapping

from DataModel
DataType
getModelType()

No description

from DataModel
boolean
isEncrypted()

Encrypted Status

from DataModel
setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)

No description

from DataModel
setProperty($name, $value, $type)

No description

from DataModel
validateType($value, $type)

No description

from DataModel
Shipment
setDeliveryNoteId(Identity $deliveryNoteId)

No description

Identity
getDeliveryNoteId()

No description

Shipment
setId(Identity $id)

No description

Identity
getId()

No description

Shipment
setCarrierName(string $carrierName)

No description

string
getCarrierName()

No description

Shipment
setCreationDate(DateTime $creationDate = null)

No description

DateTime
getCreationDate()

No description

Shipment
setIdentCode(string $identCode)

No description

string
getIdentCode()

No description

Shipment
setNote(string $note)

No description

string
getNote()

No description

Shipment
setTrackingUrl(string $trackingUrl)

No description

string
getTrackingUrl()

No description

## Details

###
at line 83
`__construct()`

Constructor

###
in Model at line 33
`multitype: getProperties()`

Get the Model Properties

#### Return Value

multitype: | string

###
in DataModel at line 172
`Model setOptions(stdClass $object = null, array $options = null)`

Sets Properties with matching Array Values

#### Parameters

stdClass | $object |
array | $options |

#### Return Value

Model |

###
in DataModel at line 70
`stdClass getPublic(array $publics = array('fields', 'isEncrypted', 'identities', '_type'))`

Convert the Model into stdClass Object

#### Parameters

array | $publics |

#### Return Value

stdClass | $object

###
in Model at line 115
`toJson()`

###
in DataModel at line 35
`mixed:string getFields()`

Fields Getter

#### Return Value

mixed:string |

###
in DataModel at line 45
`validate()`

Object Validation

#### Exceptions

SchemaException |

###
in DataModel at line 59
`mixed:string|NULL getField(boolean $toWawi = false, string $key)`

Get a Model Member Name

#### Parameters

boolean | $toWawi |
string | $key |

#### Return Value

mixed:string|NULL |

###
in DataModel at line 81
`map(boolean $toWawi = false, stdClass $obj = null)`

Object Mapping

#### Parameters

boolean | $toWawi |
stdClass | $obj | Object to map

###
in DataModel at line 42
`DataType getModelType()`

#### Return Value

DataType |

###
in DataModel at line 59
`boolean isEncrypted()`

Encrypted Status

#### Return Value

boolean |

###
in DataModel at line 123
`setIdentity(string $propertyName, string|null $endpoint = null, int|null $host = null)`

#### Parameters

string | $propertyName |
string|null | $endpoint |
int|null | $host |

###
in DataModel at line 179
`protected setProperty($name, $value, $type)`

#### Parameters

| $name |
| $value |
| $type |

###
in DataModel at line 190
`protected validateType($value, $type)`

#### Parameters

| $value |
| $type |

###
at line 94
`Shipment setDeliveryNoteId(Identity $deliveryNoteId)`

#### Parameters

Identity | $deliveryNoteId | Reference to deliveryNote

#### Return Value

Shipment |

#### Exceptions

InvalidArgumentException | if the provided argument is not of type 'Identity'.

###
at line 102
`Identity getDeliveryNoteId()`

#### Return Value

Identity | Reference to deliveryNote

###
at line 112
`Shipment setId(Identity $id)`

#### Parameters

Identity | $id | Unique shipment id

#### Return Value

Shipment |

#### Exceptions

InvalidArgumentException | if the provided argument is not of type 'Identity'.

###
at line 120
`Identity getId()`

#### Return Value

Identity | Unique shipment id

###
at line 129
`Shipment setCarrierName(string $carrierName)`

#### Parameters

string | $carrierName | Carrier name

#### Return Value

Shipment |

###
at line 137
`string getCarrierName()`

#### Return Value

string | Carrier name

###
at line 147
`Shipment setCreationDate(DateTime $creationDate = null)`

#### Parameters

DateTime | $creationDate | Creation date

#### Return Value

Shipment |

#### Exceptions

InvalidArgumentException | if the provided argument is not of type 'DateTime'.

###
at line 155
`DateTime getCreationDate()`

#### Return Value

DateTime | Creation date

###
at line 164
`Shipment setIdentCode(string $identCode)`

#### Parameters

string | $identCode | Optional Identcode

#### Return Value

Shipment |

###
at line 172
`string getIdentCode()`

#### Return Value

string | Optional Identcode

###
at line 181
`Shipment setNote(string $note)`

#### Parameters

string | $note | Optional shipment note

#### Return Value

Shipment |

###
at line 189
`string getNote()`

#### Return Value

string | Optional shipment note

###
at line 198
`Shipment setTrackingUrl(string $trackingUrl)`

#### Parameters

string | $trackingUrl |

#### Return Value

Shipment |

###
at line 206
`string getTrackingUrl()`

#### Return Value

string |