Delete improvements

[bastienbeurier]

@khaliqgant recently added the ability to detect deletions in sync scripts in two ways:

• call batchDelete in the sync script
• configure the detect_deletes option in nango.yaml + return all records each time in the sync script (i.e. full sync)

Now we should improve the interface for reading deletes from the API + backend SDK.

In the nango.getRecords response, we should return metadata along with each record in a _nango_metadata field which would contain update at, created at, delete at information, etc. This should not be a breaking change. Deletes records should be returned as well.

We should add the deleted count to the webhook payload.

We should deprecate the includeNangoMetadata field (because the metadata will be return all the time). For now, if people do use this includeNangoMetadata, we should return the records in the format that we used to, to avoid a breaking change (i.e. metadata in an object wrapping the record object).

---

Implemented Features

• deleted property for the webhook is no longer optional and is always provided
• getRecords from the sdk now has the _nango_metadata type included along with a generic