Usage for batch sending undocumented #271
Description
As your documentation states, "In case of errors on one or several of the messages, the API will not stop the processing of other successful messages.". This is not reflected in the documentation, examples, response types or error types and can easily lead to wrong usage and sending mails multiple times.
- Please define and document a type for the response of sending a mail. Currently, Promise<LibraryResponse> is returned which is completely useless.
- Define and document a type for Errors (e.g. MailjetSendError). Please have a look at the code at https://github.com/mailjet/mailjet-apiv3-nodejs/blob/master/lib/request/index.ts#L281 ff - the resulting error type is completely undocumented and almost impossible to understand.
- Please fix your examples. This code is misleading: https://github.com/mailjet/mailjet-apiv3-nodejs/tree/master?tab=readme-ov-file#send-email-example
- For batch usage, it is mandatory to include a try / catch and evaluate the response of both successful API calls as well as errors. Nothing in the client documentation hints that even though an error is thrown, mails have been sent.