ShipmentAttributes.php 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629
  1. <?php
  2. /**
  3. * Refer to LICENSE.txt distributed with the Temando Shipping module for notice of license
  4. */
  5. namespace Temando\Shipping\Rest\Response\Fields;
  6. use Temando\Shipping\Rest\Response\Fields\Shipment\ExportDeclaration;
  7. use Temando\Shipping\Rest\Response\Fields\Shipment\Order;
  8. use Temando\Shipping\Rest\Response\Fields\Shipment\SelectedServices;
  9. /**
  10. * Temando API Shipment Resource Object Attributes
  11. *
  12. * @package Temando\Shipping\Rest
  13. * @author Christoph Aßmann <christoph.assmann@netresearch.de>
  14. * @license https://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
  15. * @link https://www.temando.com/
  16. */
  17. class ShipmentAttributes
  18. {
  19. /**
  20. * @var string
  21. */
  22. private $pickupAt;
  23. /**
  24. * @var string
  25. */
  26. private $expectedAt;
  27. /**
  28. * @var bool
  29. */
  30. private $isDutiable;
  31. /**
  32. * @var bool
  33. */
  34. private $isPaperless;
  35. /**
  36. * @var \Temando\Shipping\Rest\Response\Fields\LocationAttributes
  37. */
  38. private $origin;
  39. /**
  40. * @var \Temando\Shipping\Rest\Response\Fields\LocationAttributes
  41. */
  42. private $destination;
  43. /**
  44. * @var \Temando\Shipping\Rest\Response\Fields\LocationAttributes
  45. */
  46. private $finalRecipient;
  47. /**
  48. * @var \Temando\Shipping\Rest\Response\Fields\Generic\Package[]
  49. */
  50. private $packages = [];
  51. /**
  52. * @var \Temando\Shipping\Rest\Response\Fields\Generic\Documentation[]
  53. */
  54. private $documentation = [];
  55. /**
  56. * @var string
  57. */
  58. private $instructionsToDeliveryAgent;
  59. /**
  60. * Anonymous list of capabilities.
  61. *
  62. * $format = [
  63. * 'capabilityCodeX' => [
  64. * 'propertyOne' => 'valueOne',
  65. * 'propertyTwo' => 'valueTwo',
  66. * ],
  67. * 'capabilityCodeY' => [
  68. * 'propertyOne' => 'valueOne',
  69. * ],
  70. * ]
  71. *
  72. * @var mixed[][]
  73. */
  74. private $capabilities = [];
  75. /**
  76. * @var \Temando\Shipping\Rest\Response\Fields\Shipment\ExportDeclaration
  77. */
  78. private $exportDeclaration;
  79. /**
  80. * @var \Temando\Shipping\Rest\Response\Fields\Shipment\Order
  81. */
  82. private $order;
  83. /**
  84. * @var string
  85. */
  86. private $orderId;
  87. /**
  88. * @var string
  89. */
  90. private $originId;
  91. /**
  92. * @var string
  93. */
  94. private $destinationId;
  95. /**
  96. * Shipment Status OR Shipment Allocation Error Status
  97. * @var string
  98. */
  99. private $status;
  100. /**
  101. * @var string
  102. */
  103. private $completionId;
  104. /**
  105. * @var \Temando\Shipping\Rest\Response\Fields\Shipment\Fulfill
  106. */
  107. private $fulfill;
  108. /**
  109. * @var \Temando\Shipping\Rest\Response\Fields\Shipment\SelectedServices
  110. */
  111. private $selectedServices;
  112. /**
  113. * @var string
  114. */
  115. private $createdAt;
  116. /**
  117. * @var string
  118. */
  119. private $modifiedAt;
  120. /**
  121. * @var \Temando\Shipping\Rest\Response\Fields\Generic\Item[]
  122. */
  123. private $items = [];
  124. /**
  125. * Shipment Allocation Error Title
  126. * @var string
  127. */
  128. private $title;
  129. /**
  130. * Shipment Allocation Error Code
  131. * @var string
  132. */
  133. private $code;
  134. /**
  135. * Shipment Allocation Error Detail
  136. * @var string
  137. */
  138. private $detail;
  139. /**
  140. * @var string[]
  141. */
  142. private $customAttributes;
  143. /**
  144. * @return string
  145. */
  146. public function getPickupAt()
  147. {
  148. return $this->pickupAt;
  149. }
  150. /**
  151. * @param string $pickupAt
  152. * @return void
  153. */
  154. public function setPickupAt($pickupAt)
  155. {
  156. $this->pickupAt = $pickupAt;
  157. }
  158. /**
  159. * @return string
  160. */
  161. public function getExpectedAt()
  162. {
  163. return $this->expectedAt;
  164. }
  165. /**
  166. * @param string $expectedAt
  167. * @return void
  168. */
  169. public function setExpectedAt($expectedAt)
  170. {
  171. $this->expectedAt = $expectedAt;
  172. }
  173. /**
  174. * @return boolean
  175. */
  176. public function getIsDutiable()
  177. {
  178. return $this->isDutiable;
  179. }
  180. /**
  181. * @param boolean $isDutiable
  182. * @return void
  183. */
  184. public function setIsDutiable($isDutiable)
  185. {
  186. $this->isDutiable = $isDutiable;
  187. }
  188. /**
  189. * @return boolean
  190. */
  191. public function getIsPaperless()
  192. {
  193. return $this->isPaperless;
  194. }
  195. /**
  196. * @param boolean $isPaperless
  197. * @return void
  198. */
  199. public function setIsPaperless($isPaperless)
  200. {
  201. $this->isPaperless = $isPaperless;
  202. }
  203. /**
  204. * @return \Temando\Shipping\Rest\Response\Fields\LocationAttributes
  205. */
  206. public function getOrigin()
  207. {
  208. return $this->origin;
  209. }
  210. /**
  211. * @param \Temando\Shipping\Rest\Response\Fields\LocationAttributes $origin
  212. * @return void
  213. */
  214. public function setOrigin(LocationAttributes $origin)
  215. {
  216. $this->origin = $origin;
  217. }
  218. /**
  219. * @return \Temando\Shipping\Rest\Response\Fields\LocationAttributes
  220. */
  221. public function getDestination()
  222. {
  223. return $this->destination;
  224. }
  225. /**
  226. * @param \Temando\Shipping\Rest\Response\Fields\LocationAttributes $destination
  227. * @return void
  228. */
  229. public function setDestination(LocationAttributes $destination)
  230. {
  231. $this->destination = $destination;
  232. }
  233. /**
  234. * @return \Temando\Shipping\Rest\Response\Fields\LocationAttributes
  235. */
  236. public function getFinalRecipient()
  237. {
  238. return $this->finalRecipient;
  239. }
  240. /**
  241. * @param \Temando\Shipping\Rest\Response\Fields\LocationAttributes $finalRecipient
  242. * @return void
  243. */
  244. public function setFinalRecipient(LocationAttributes $finalRecipient)
  245. {
  246. $this->finalRecipient = $finalRecipient;
  247. }
  248. /**
  249. * @return \Temando\Shipping\Rest\Response\Fields\Generic\Package[]
  250. */
  251. public function getPackages()
  252. {
  253. return $this->packages;
  254. }
  255. /**
  256. * @param \Temando\Shipping\Rest\Response\Fields\Generic\Package[] $packages
  257. * @return void
  258. */
  259. public function setPackages($packages)
  260. {
  261. $this->packages = $packages;
  262. }
  263. /**
  264. * @return \Temando\Shipping\Rest\Response\Fields\Generic\Documentation[]
  265. */
  266. public function getDocumentation()
  267. {
  268. return $this->documentation;
  269. }
  270. /**
  271. * @param \Temando\Shipping\Rest\Response\Fields\Generic\Documentation[] $documentation
  272. * @return void
  273. */
  274. public function setDocumentation(array $documentation)
  275. {
  276. $this->documentation = $documentation;
  277. }
  278. /**
  279. * @return string
  280. */
  281. public function getInstructionsToDeliveryAgent()
  282. {
  283. return $this->instructionsToDeliveryAgent;
  284. }
  285. /**
  286. * @param string $instructionsToDeliveryAgent
  287. * @return void
  288. */
  289. public function setInstructionsToDeliveryAgent($instructionsToDeliveryAgent)
  290. {
  291. $this->instructionsToDeliveryAgent = $instructionsToDeliveryAgent;
  292. }
  293. /**
  294. * @return mixed[][]
  295. */
  296. public function getCapabilities()
  297. {
  298. return $this->capabilities;
  299. }
  300. /**
  301. * @param mixed[][] $capabilities
  302. * @return void
  303. */
  304. public function setCapabilities(array $capabilities)
  305. {
  306. $this->capabilities = $capabilities;
  307. }
  308. /**
  309. * @return \Temando\Shipping\Rest\Response\Fields\Shipment\ExportDeclaration
  310. */
  311. public function getExportDeclaration()
  312. {
  313. return $this->exportDeclaration;
  314. }
  315. /**
  316. * @param \Temando\Shipping\Rest\Response\Fields\Shipment\ExportDeclaration $exportDeclaration
  317. * @return void
  318. */
  319. public function setExportDeclaration(ExportDeclaration $exportDeclaration)
  320. {
  321. $this->exportDeclaration = $exportDeclaration;
  322. }
  323. /**
  324. * @return \Temando\Shipping\Rest\Response\Fields\Shipment\Order
  325. */
  326. public function getOrder()
  327. {
  328. return $this->order;
  329. }
  330. /**
  331. * @param \Temando\Shipping\Rest\Response\Fields\Shipment\Order $order
  332. * @return void
  333. */
  334. public function setOrder(Order $order)
  335. {
  336. $this->order = $order;
  337. }
  338. /**
  339. * @return string
  340. */
  341. public function getOrderId()
  342. {
  343. return $this->orderId;
  344. }
  345. /**
  346. * @param string $orderId
  347. * @return void
  348. */
  349. public function setOrderId($orderId)
  350. {
  351. $this->orderId = $orderId;
  352. }
  353. /**
  354. * @return string
  355. */
  356. public function getOriginId()
  357. {
  358. return $this->originId;
  359. }
  360. /**
  361. * @param string $originId
  362. * @return void
  363. */
  364. public function setOriginId($originId)
  365. {
  366. $this->originId = $originId;
  367. }
  368. /**
  369. * @return string
  370. */
  371. public function getDestinationId()
  372. {
  373. return $this->destinationId;
  374. }
  375. /**
  376. * @param string $destinationId
  377. * @return void
  378. */
  379. public function setDestinationId($destinationId)
  380. {
  381. $this->destinationId = $destinationId;
  382. }
  383. /**
  384. * @return string
  385. */
  386. public function getStatus()
  387. {
  388. return $this->status;
  389. }
  390. /**
  391. * @param string $status
  392. * @return void
  393. */
  394. public function setStatus($status)
  395. {
  396. $this->status = $status;
  397. }
  398. /**
  399. * @return string
  400. */
  401. public function getCompletionId()
  402. {
  403. return $this->completionId;
  404. }
  405. /**
  406. * @param string $completionId
  407. * @return void
  408. */
  409. public function setCompletionId($completionId)
  410. {
  411. $this->completionId = $completionId;
  412. }
  413. /**
  414. * @return \Temando\Shipping\Rest\Response\Fields\Shipment\Fulfill
  415. */
  416. public function getFulfill()
  417. {
  418. return $this->fulfill;
  419. }
  420. /**
  421. * @param \Temando\Shipping\Rest\Response\Fields\Shipment\Fulfill $fulfill
  422. * @return void
  423. */
  424. public function setFulfill($fulfill)
  425. {
  426. $this->fulfill = $fulfill;
  427. }
  428. /**
  429. * @return \Temando\Shipping\Rest\Response\Fields\Shipment\SelectedServices
  430. */
  431. public function getSelectedServices()
  432. {
  433. return $this->selectedServices;
  434. }
  435. /**
  436. * @param \Temando\Shipping\Rest\Response\Fields\Shipment\SelectedServices $selectedServices
  437. * @return void
  438. */
  439. public function setSelectedServices(SelectedServices $selectedServices)
  440. {
  441. $this->selectedServices = $selectedServices;
  442. }
  443. /**
  444. * @return string
  445. */
  446. public function getCreatedAt()
  447. {
  448. return $this->createdAt;
  449. }
  450. /**
  451. * @param string $createdAt
  452. * @return void
  453. */
  454. public function setCreatedAt($createdAt)
  455. {
  456. $this->createdAt = $createdAt;
  457. }
  458. /**
  459. * @return string
  460. */
  461. public function getModifiedAt()
  462. {
  463. return $this->modifiedAt;
  464. }
  465. /**
  466. * @param string $modifiedAt
  467. * @return void
  468. */
  469. public function setModifiedAt($modifiedAt)
  470. {
  471. $this->modifiedAt = $modifiedAt;
  472. }
  473. /**
  474. * @return \Temando\Shipping\Rest\Response\Fields\Generic\Item[]
  475. */
  476. public function getItems()
  477. {
  478. return $this->items;
  479. }
  480. /**
  481. * @param \Temando\Shipping\Rest\Response\Fields\Generic\Item[] $items
  482. * @return void
  483. */
  484. public function setItems(array $items)
  485. {
  486. $this->items = $items;
  487. }
  488. /**
  489. * @return string[]
  490. */
  491. public function getCustomAttributes()
  492. {
  493. return $this->customAttributes;
  494. }
  495. /**
  496. * @param string[] $customAttributes
  497. * @return void
  498. */
  499. public function setCustomAttributes(array $customAttributes)
  500. {
  501. $this->customAttributes = $customAttributes;
  502. }
  503. /**
  504. * @return string
  505. */
  506. public function getTitle()
  507. {
  508. return $this->title;
  509. }
  510. /**
  511. * @param string $title
  512. * @return void
  513. */
  514. public function setTitle($title)
  515. {
  516. $this->title = $title;
  517. }
  518. /**
  519. * @return string
  520. */
  521. public function getCode()
  522. {
  523. return $this->code;
  524. }
  525. /**
  526. * @param string $code
  527. * @return void
  528. */
  529. public function setCode($code)
  530. {
  531. $this->code = $code;
  532. }
  533. /**
  534. * @return string
  535. */
  536. public function getDetail()
  537. {
  538. return $this->detail;
  539. }
  540. /**
  541. * @param string $detail
  542. * @return void
  543. */
  544. public function setDetail($detail)
  545. {
  546. $this->detail = $detail;
  547. }
  548. }