Make events parameter required for list_events

[mattgd]

Description

Make events parameter required for list_events.

Documentation

Does this require changes to the WorkOS Docs? E.g. the API Reference or code snippets need updates.

[ ] Yes

If yes, link a related docs PR and add a docs maintainer as a reviewer. Their approval is required.

[linear]

DSYNC-1309 Update Ruby SDK to require event names parameter

[mattgd]

I'm not much of a rubyist. Do I need to update the method signature or comment at all on this options hash to reflect this parameter requirement?

workos-ruby/lib/workos/events.rb

Lines 16 to 24 in 2a90a0b

	# @param [Hash] options An options hash
	# @option options [String] event The type of event
	# retrieved.
	# @option options [String] limit Maximum number of records to return.
	# @option options [String] after Pagination cursor to receive records
	# after a provided Event ID.
	#
	# @return [Hash]
	def list_events(options = {})

[jasonroelofs]

This change doesn't look to be doing what you want. The InvalidRequestError would come from making the request with no parameters, not the SDK telling the user they need to add a parameter. If event is a required parameter I would probably change the signature of list_event to thus:

def list_event(event:, options = {})
end

This way the user will get a ArgumentError when they forget event and this should also be backwards compatible to current callers to this function.

[jasonroelofs]

Ah, right, that syntax isn't 2.7 compatible. You might need to add extra logic looking for options[:event] and throw an ArgumentError if it doesn't exist.

[mattgd]

Ah, right, that syntax isn't 2.7 compatible. You might need to add extra logic looking for options[:event] and throw an ArgumentError if it doesn't exist.

Ah okay. Let me move make some changes.