Skip to content

🧑‍💻 Support includes on shipment-statuses #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zwaans merged 2 commits into from
Sep 12, 2025
Merged

🧑‍💻 Support includes on shipment-statuses #251

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
59b7d41
:technologist: support includes on shipment-statuses
M4tini Sep 11, 2025
9e096ce
:technologist: add the ProcessIncludes trait to other resources that …
M4tini Sep 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/Resources/Collection.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,22 @@
use MyParcelCom\ApiSdk\Resources\Interfaces\ShopInterface;
use MyParcelCom\ApiSdk\Resources\Interfaces\StatusInterface;
use MyParcelCom\ApiSdk\Resources\Traits\JsonSerializable;
use MyParcelCom\ApiSdk\Resources\Traits\ProcessIncludes;
use MyParcelCom\ApiSdk\Resources\Traits\Resource;

class Collection implements CollectionInterface
{
use JsonSerializable;
use ProcessIncludes;
use Resource;

const INCLUDES = [
ResourceInterface::TYPE_CONTRACT => 'contract',
ResourceInterface::TYPE_MANIFEST => 'manifest',
ResourceInterface::TYPE_SHOP => 'shop',
ResourceInterface::TYPE_STATUS => 'status',
];

private ?string $id = null;
private string $type = ResourceInterface::TYPE_COLLECTION;

Expand Down
6 changes: 6 additions & 0 deletions src/Resources/Contract.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@
use MyParcelCom\ApiSdk\Resources\Interfaces\ContractInterface;
use MyParcelCom\ApiSdk\Resources\Interfaces\ResourceInterface;
use MyParcelCom\ApiSdk\Resources\Traits\JsonSerializable;
use MyParcelCom\ApiSdk\Resources\Traits\ProcessIncludes;
use MyParcelCom\ApiSdk\Resources\Traits\Resource;

class Contract implements ContractInterface
{
use JsonSerializable;
use ProcessIncludes;
use Resource;

const ATTRIBUTE_CURRENCY = 'currency';
Expand All @@ -22,6 +24,10 @@ class Contract implements ContractInterface

const RELATIONSHIP_CARRIER = 'carrier';

const INCLUDES = [
ResourceInterface::TYPE_CARRIER => self::RELATIONSHIP_CARRIER,
];

private ?string $id = null;

private string $type = ResourceInterface::TYPE_CONTRACT;
Expand Down
6 changes: 6 additions & 0 deletions src/Resources/Manifest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,19 @@
use MyParcelCom\ApiSdk\Resources\Interfaces\ShipmentInterface;
use MyParcelCom\ApiSdk\Resources\Interfaces\ShopInterface;
use MyParcelCom\ApiSdk\Resources\Traits\JsonSerializable;
use MyParcelCom\ApiSdk\Resources\Traits\ProcessIncludes;
use MyParcelCom\ApiSdk\Resources\Traits\Resource;

class Manifest implements ManifestInterface
{
use JsonSerializable;
use ProcessIncludes;
use Resource;

const INCLUDES = [
ResourceInterface::TYPE_CONTRACT => 'contract',
];

private ?string $id = null;
private string $type = ResourceInterface::TYPE_MANIFEST;
private array $attributes = [
Expand Down
3 changes: 2 additions & 1 deletion src/Resources/ResourceFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,8 @@ protected function shipmentFactory(array &$data): Shipment
if (isset($data['id'])) {
$shipment->setStatusHistoryCallback(function () use ($data) {
return $this->api->getResourcesFromUri(
str_replace('{shipment_id}', $data['id'], MyParcelComApiInterface::PATH_SHIPMENT_STATUSES),
str_replace('{shipment_id}', $data['id'], MyParcelComApiInterface::PATH_SHIPMENT_STATUSES)
. '?include=' . ShipmentStatus::RELATIONSHIP_STATUS,
);
});
}
Expand Down
6 changes: 6 additions & 0 deletions src/Resources/Service.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,13 @@
use MyParcelCom\ApiSdk\Resources\Interfaces\ServiceInterface;
use MyParcelCom\ApiSdk\Resources\Interfaces\ServiceRateInterface;
use MyParcelCom\ApiSdk\Resources\Traits\JsonSerializable;
use MyParcelCom\ApiSdk\Resources\Traits\ProcessIncludes;
use MyParcelCom\ApiSdk\Resources\Traits\Resource;

class Service implements ServiceInterface
{
use JsonSerializable;
use ProcessIncludes;
use Resource;

const ATTRIBUTE_NAME = 'name';
Expand All @@ -32,6 +34,10 @@ class Service implements ServiceInterface

const RELATIONSHIP_CARRIER = 'carrier';

const INCLUDES = [
ResourceInterface::TYPE_CARRIER => self::RELATIONSHIP_CARRIER,
];

private ?string $id = null;

private string $type = ResourceInterface::TYPE_SERVICE;
Expand Down
7 changes: 7 additions & 0 deletions src/Resources/ShipmentStatus.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,14 @@
use MyParcelCom\ApiSdk\Resources\Interfaces\ShipmentStatusInterface;
use MyParcelCom\ApiSdk\Resources\Interfaces\StatusInterface;
use MyParcelCom\ApiSdk\Resources\Traits\JsonSerializable;
use MyParcelCom\ApiSdk\Resources\Traits\ProcessIncludes;
use MyParcelCom\ApiSdk\Resources\Traits\Resource;
use MyParcelCom\ApiSdk\Utils\DateUtils;

class ShipmentStatus implements ShipmentStatusInterface
{
use JsonSerializable;
use ProcessIncludes;
use Resource;

const ATTRIBUTE_CARRIER_STATUSES = 'carrier_statuses';
Expand All @@ -27,6 +29,11 @@ class ShipmentStatus implements ShipmentStatusInterface
const RELATIONSHIP_STATUS = 'status';
const RELATIONSHIP_SHIPMENT = 'shipment';

const INCLUDES = [
ResourceInterface::TYPE_SHIPMENT => self::RELATIONSHIP_SHIPMENT,
ResourceInterface::TYPE_STATUS => self::RELATIONSHIP_STATUS,
];

private ?string $id = null;

private string $type = ResourceInterface::TYPE_SHIPMENT_STATUS;
Expand Down
6 changes: 6 additions & 0 deletions src/Resources/Shop.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,14 @@
use MyParcelCom\ApiSdk\Resources\Interfaces\ResourceInterface;
use MyParcelCom\ApiSdk\Resources\Interfaces\ShopInterface;
use MyParcelCom\ApiSdk\Resources\Traits\JsonSerializable;
use MyParcelCom\ApiSdk\Resources\Traits\ProcessIncludes;
use MyParcelCom\ApiSdk\Resources\Traits\Resource;
use MyParcelCom\ApiSdk\Utils\DateUtils;

class Shop implements ShopInterface
{
use JsonSerializable;
use ProcessIncludes;
use Resource;

const ATTRIBUTE_NAME = 'name';
Expand All @@ -26,6 +28,10 @@ class Shop implements ShopInterface

const RELATIONSHIP_ORGANIZATION = 'organization';

const INCLUDES = [
ResourceInterface::TYPE_ORGANIZATION => self::RELATIONSHIP_ORGANIZATION,
];

private ?string $id = null;

private string $type = ResourceInterface::TYPE_SHOP;
Expand Down
16 changes: 16 additions & 0 deletions ...api-shipments-shipment-id-1-statuses.json → ...hipment-id-1-statuses/include-status.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,22 @@
"total_pages": 1,
"total_records": 5
},
"included": [
{
"type": "statuses",
"id": "status-id-5",
"attributes": {
"code": "shipment-concept",
"resource_type": "shipments",
"level": "concept",
"name": "Concept",
"description": "The shipment is a concept"
},
"links": {
"self": "https://api/statuses/status-id-5"
}
}
],
"links": {
"self": "https://api/shipments/shipment-id-1/statuses?page[number]=1&page[size]=30",
"first": "https://api/shipments/shipment-id-1/statuses?page[number]=1&page[size]=30",
Expand Down