Make events parameter required for ListEvents (#325)

* Make events parameter required for ListEvents. * Fix formatting. * Bump minor version. * Undo version bump.
workos · Apr 11, 2024 · 87de1f7 · 87de1f7
1 parent d06b649
commit 87de1f7
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 3 deletions.
diff --git a/pkg/events/client.go b/pkg/events/client.go
@@ -89,7 +89,7 @@ type Event struct {
 // ListEventsOpts contains the options to request provisioned Events.
 type ListEventsOpts struct {
 	// Filter to only return Events of particular types.
-	Events []string `url:"events,omitempty"`
+	Events []string `url:"events"`
 
 	// Maximum number of records to return.
 	Limit int `url:"limit"`

diff --git a/pkg/events/client_test.go b/pkg/events/client_test.go
@@ -36,7 +36,10 @@ func TestListEvents(t *testing.T) {
 			},
 		}
 
-		events, err := client.ListEvents(context.Background(), ListEventsOpts{})
+		params := ListEventsOpts{
+			Events: []string{"dsync.user.created"},
+		}
+		events, err := client.ListEvents(context.Background(), params)
 
 		require.NoError(t, err)
 		require.Equal(t, expectedResponse, events)
@@ -56,6 +59,7 @@ func TestListEvents(t *testing.T) {
 		rangeEnd := currentTime.AddDate(0, 0, -1)
 
 		params := ListEventsOpts{
+			Events:     []string{"dsync.user.created"},
 			RangeStart: rangeStart.String(),
 			RangeEnd:   rangeEnd.String(),
 		}

diff --git a/pkg/events/events_test.go b/pkg/events/events_test.go
@@ -21,6 +21,10 @@ func TestEventsListEvents(t *testing.T) {
 	}
 	SetAPIKey("test")
 
+	params := ListEventsOpts{
+		Events: []string{"dsync.user.created"},
+	}
+
 	expectedResponse := ListEventsResponse{
 		Data: []Event{
 			{
@@ -33,7 +37,7 @@ func TestEventsListEvents(t *testing.T) {
 			After: "",
 		},
 	}
-	eventsResponse, err := ListEvents(context.Background(), ListEventsOpts{})
+	eventsResponse, err := ListEvents(context.Background(), params)
 
 	require.NoError(t, err)
 	require.Equal(t, expectedResponse, eventsResponse)