[Docs]: Improve error display | Add better samples for email and sms notifications

[AyresMonteiro]

What's on your mind?

I had to use axios in order to figure out what's happening in my 400 status code request due to errors being show as GenericErrorErrorsInner without clear error messages.

It would be simpler if docs had a sample of sms notification requiring sms_from prop, and an equivalent sample for email notification sending.

I would appreciate it if the documentation was improved in this regard.

Indeed, notification type not contains include_subscription_ids prop.

Code of Conduct

• I agree to follow this project's Code of Conduct

[sherwinski]

Hey there, sorry this issue has gone stale. I'll try to address each of your questions separately.

I had to use axios in order to figure out what's happening in my 400 status code request due to errors being show as GenericErrorErrorsInner without clear error messages.

Fortunately, this is currently possible by accessing the code, body, headers properties on the ApiException object. I believe this library no longer uses GenericErrorErrorsInner.

It would be simpler if docs had a sample of sms notification requiring sms_from prop, and an equivalent sample for email notification sending.

Agreed that certain operation examples could be better documented. Unfortunately, with there being many different notification and subscription uses cases this isn't something that will likely be fixed quickly. I'm always happy to help if there's a specific use case that you are trying to achieve and need help stringing together the right function calls, etc.

Indeed, notification type not contains include_subscription_ids prop.

include_subscription_ids has since been added to SubscriptionNotificationTarget and is available in the v5 channel 🥳

I'm going to close this issue now as there aren't any outstanding action items but please feel free to follow up or open a new issue if you have any further questions.