`getOutboundMessageDetails()` is nesting events twice

[Maxwell2022]

"name": "wildbit/postmark-php",
"version": "v6.0.9",

According to the API documentation: https://postmarkapp.com/developer/api/messages-api#outbound-message-details

When requesting message details, it should return an array of events. Dumping the response it's actually returning nested arrays:

In order to access these events we need to target MessageEvents from MessageEvents:

foreach ($messageDetails->MessageEvents->MessageEvents as $event) {
  // got the event
}

I would expect to loop over events like this:

foreach ($messageDetails->MessageEvents as $event) {
  // got the event
}

[ewood-ac]

I'm not able to find exactly what you mean. Can you please let me know what method in the SDK you are calling? From the code it appears that we have PostmarkMessageEvents (many) and PostmarkMessageEvent (singular) but I don't see where this gets nested like you are showing. I understand the concept but just not where you are experiencing the issue with the SDK. Thanks.

[malles]

I have spotted the same. The Postmark\Models\PostmarkOutboundMessageDetail has public PostmarkMessageEvents $MessageEvents which itself is a collection that needs the extra getMessageEvents() call (or direct public property access).

So you get $message->getMessageEvents()->getMessageEvents() to get to the actual array with the events.

I think that is in line with other subcollections, like PostmarkTemplateList or PostmarkSenderSignatureList. Maybe this collection is not called a list because it has no totalCount property.

The message events seems to be the only model with a plural name, and a bit of the odd one out I guess. If it were called list, the call $message->getMessageEventList()->getMessageEvents() would make more sense.

Although how the PHP SDK wraps the data does not have to be a one to one relation to the raw API data, I do understand the confusion it may cause.

[ewood-ac]

Much appreciated I will take a look and see if I can't get a change for this.

[ewood-ac]

I addressed this in the lastest release. I wanted to keep compatibility... but you should see if this works for you all.