postmark-java icon indicating copy to clipboard operation
postmark-java copied to clipboard

Metadata field is not present in "Bounce" class

Open robertop87 opened this issue 1 year ago • 1 comments

Describe the bug Metadata field in Bounce response object is not present. It is very important for custom integrations, because it provides specific custom information for API consumers.

To Reproduce Provide steps to reproduce the behavior:

  1. Open the Bounce.java
  2. Verify that "metadata" field is not present

Expected behavior "metadata" field must be present, and it should be Map<String, String> or Map<String, Object>

Java (please complete the following information): No related to java

Additional context None

robertop87 avatar Jul 04 '24 18:07 robertop87

@robertop87 - If you review our documentation there is not a mention of metadata being present on a bounce. Can you explain what you are looking for?

ewood-ac avatar Jul 30 '24 13:07 ewood-ac

Hello @ewood-ac thank for take this issue.

I just reviewed the doc for second time, and you are right, "Metadata" is not mentioned there.

But recently I'm working with a client who is asking me to read and store this "Metadata" which should be present in the response because my client required it directly to Postmark and looks it was accepted.

An example of this value in the JSON response is the next:

"Metadata": {
  "customName1" : <some-value>,
  "customName2" : <some-value>
}

And the "Metadata" could have many customName.

robertop87 avatar Aug 19 '24 12:08 robertop87

@robertop87 - Currently the only place that the metadata you are referencing is used is the bounce webhook. This is not an issue with the SDK rather it is a product feature. If you need to request an update. Please contact our Customer Service to request a change to our Bounce payload.

ewood-ac avatar Aug 19 '24 13:08 ewood-ac