Incorrect example documentation for Events?

[zacharytyhacz]

I just want to get failed email events. The examples and documentation for this package is a little misleading.

I was reading these docs about the events API

It says that it accepts a query as second parameter mg.events.get(domain, query), but the example shows second parameter as an object of options:

The official Mailgun documentation show more query options:
https://documentation.mailgun.com/en/latest/api-events.html#filter-field

[olexandr-mazepa]

Hi @zacharytyhacz
Thank you for highlighting this.
For some reason this readme section wasn't finished, I will update it shortly.
Till that time I can confirm that second parameter should be an object and you can use next types to see expected/allowed properties:

mailgun.js/lib/Types/Events/Events.ts

Lines 9 to 30 in 077eb69

	export type FilterField = {
	event?: string;
	list?: string;
	attachment?: string;
	from?: string;
	'message-id'?: string;
	subject?: string;
	to?: string;
	size?: string;
	recipient?: string;
	recipients?: string;
	tags?: string;
	severity?: string;
	}
	export type EventsQuery = FilterField & {
	page?: string;
	begin?: string;
	end?: string;
	ascending?: 'yes'| 'no';
	limit?: number;
	}

[zacharytyhacz]

@olexandr-mazepa 🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏🙏