Type issue: additionalData.metadata should be Record<string,string>

[naseemkullah]

https://github.com/Adyen/adyen-openapi/blob/fd75cc4d9b401950fcbf90539becc26c32b259a9/yaml/Webhooks-v1.yaml#L1658-L1663

As per the spec, its an object not a string

below is the current workaround:

notificationRequestItem.additionalData?.metadata as unknown as Record<
      string,
      string
    >,

[DjoykeAbyah]

Hi @naseemkullah!

Thank you for making us aware of this issue and apologies for the delayed reply. It indeed seems to be typed incorrectly. I’ve contacted the API owners and will get back to you as soon as I know more.

Kind regards,

Djoyke
Adyen

[gcatanese]

Hi @naseemkullah, we have investigated further and confirmed that the webhook payload can include metadata that is a map of values prefixed with metadata. From the docs:

a set of key-value pairs provided in the request, prefixed with 'metadata.'. For example, 'metadata.myField: myValue'

For example:

notification.additionalData = {
            orderId: "12345",
            customerId: "54321",
            "metadata.myField": "myValue",
            "metadata.anotherField": "anotherValue"
        }  

We have added unit tests in a branch to verify the library works.

We'll look at improving/correcting the OpenAPI spec file that indeed is misleading. in this case. Thank you for raising this issue.