fix(team)!: move team.accessLogs to use cursor/limit

Author: nlopes

CHANGELOG.md

@@ -106,6 +106,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   > // Use nextCursor for the next page: params.Cursor = nextCursor
   > ```
 
+- **`GetAccessLogs` now uses cursor-based pagination** — `AccessLogParameters` replaces
+  `Count`/`Page` with `Cursor`/`Limit` (and adds `Before`), and `GetAccessLogs`/
+  `GetAccessLogsContext` now return `string` (next cursor) instead of `*Paging`.
+  Slack's `team.accessLogs` API warns `use_cursor_pagination_instead` when using the old
+  parameters.
+
+  > [!WARNING]
+  > **Breaking change.** Both the parameters and return signature have changed:
+  >
+  > ```go
+  > // Before
+  > params := slack.NewAccessLogParameters()
+  > params.Count = 100
+  > params.Page = 2
+  > logins, paging, err := api.GetAccessLogs(params)
+  >
+  > // After
+  > params := slack.NewAccessLogParameters()
+  > params.Limit = 100
+  > logins, nextCursor, err := api.GetAccessLogs(params)
+  > // Use nextCursor for the next page: params.Cursor = nextCursor
+  > ```
+
 ### Fixed
 
 - **`WorkflowButtonBlockElement` missing from `UnmarshalJSON`** — `workflow_button` blocks

team.go

@@ -6,11 +6,6 @@ import (
 	"strconv"
 )
 
-const (
-	DEFAULT_LOGINS_COUNT = 100
-	DEFAULT_LOGINS_PAGE  = 1
-)
-
 type TeamResponse struct {
 	Team TeamInfo `json:"team"`
 	SlackResponse
@@ -46,8 +41,8 @@ type TeamProfileField struct {
 
 type LoginResponse struct {
 	Logins []Login `json:"logins"`
-	Paging `json:"paging"`
 	SlackResponse
+	ResponseMetadata `json:"response_metadata"`
 }
 
 type Login struct {
@@ -75,16 +70,14 @@ type BillingActive struct {
 // AccessLogParameters contains all the parameters necessary (including the optional ones) for a GetAccessLogs() request
 type AccessLogParameters struct {
 	TeamID string
-	Count  int
-	Page   int
+	Cursor string
+	Limit  int
+	Before int
 }
 
 // NewAccessLogParameters provides an instance of AccessLogParameters with all the sane default values set
 func NewAccessLogParameters() AccessLogParameters {
-	return AccessLogParameters{
-		Count: DEFAULT_LOGINS_COUNT,
-		Page:  DEFAULT_LOGINS_PAGE,
-	}
+	return AccessLogParameters{}
 }
 
 func (api *Client) teamRequest(ctx context.Context, path string, values url.Values) (*TeamResponse, error) {
@@ -193,31 +186,34 @@ func (api *Client) GetTeamProfileContext(ctx context.Context, teamID ...string)
 
 // GetAccessLogs retrieves a page of logins according to the parameters given.
 // For more information see the GetAccessLogsContext documentation.
-func (api *Client) GetAccessLogs(params AccessLogParameters) ([]Login, *Paging, error) {
+func (api *Client) GetAccessLogs(params AccessLogParameters) ([]Login, string, error) {
 	return api.GetAccessLogsContext(context.Background(), params)
 }
 
 // GetAccessLogsContext retrieves a page of logins according to the parameters given with a custom context.
 // Slack API docs: https://api.slack.com/methods/team.accessLogs
-func (api *Client) GetAccessLogsContext(ctx context.Context, params AccessLogParameters) ([]Login, *Paging, error) {
+func (api *Client) GetAccessLogsContext(ctx context.Context, params AccessLogParameters) ([]Login, string, error) {
 	values := url.Values{
 		"token": {api.token},
 	}
 	if params.TeamID != "" {
 		values.Add("team_id", params.TeamID)
 	}
-	if params.Count != DEFAULT_LOGINS_COUNT {
-		values.Add("count", strconv.Itoa(params.Count))
+	if params.Cursor != "" {
+		values.Add("cursor", params.Cursor)
+	}
+	if params.Limit != 0 {
+		values.Add("limit", strconv.Itoa(params.Limit))
 	}
-	if params.Page != DEFAULT_LOGINS_PAGE {
-		values.Add("page", strconv.Itoa(params.Page))
+	if params.Before != 0 {
+		values.Add("before", strconv.Itoa(params.Before))
 	}
 
 	response, err := api.accessLogsRequest(ctx, "team.accessLogs", values)
 	if err != nil {
-		return nil, nil, err
+		return nil, "", err
 	}
-	return response.Logins, &response.Paging, nil
+	return response.Logins, response.ResponseMetadata.Cursor, nil
 }
 
 type GetBillableInfoParams struct {

team_test.go

@@ -150,11 +150,8 @@ func getTeamAccessLogs(rw http.ResponseWriter, r *http.Request) {
                         "country": null,
                         "region": null
                         }],
-                        "paging": {
-    			"count": 2,
-    			"total": 2,
-    			"page": 1,
-    			"pages": 1
+                        "response_metadata": {
+    			"next_cursor": "dGVhbV9pZDo5MDAwMTcw"
     			}
   }`)
 	rw.Write(response)
@@ -166,7 +163,10 @@ func TestGetAccessLogs(t *testing.T) {
 	once.Do(startServer)
 	api := New("testing-token", OptionAPIURL("http://"+serverAddr+"/"))
 
-	logins, paging, err := api.GetAccessLogs(NewAccessLogParameters())
+	params := NewAccessLogParameters()
+	params.Limit = 2
+	params.TeamID = "T12345"
+	logins, nextCursor, err := api.GetAccessLogs(params)
 	if err != nil {
 		t.Errorf("Unexpected error: %s", err)
 		return
@@ -222,17 +222,8 @@ func TestGetAccessLogs(t *testing.T) {
 		t.Fatal(ErrIncorrectResponse)
 	}
 
-	// test the paging
-	if paging.Count != 2 {
-		t.Fatal(ErrIncorrectResponse)
-	}
-	if paging.Total != 2 {
-		t.Fatal(ErrIncorrectResponse)
-	}
-	if paging.Page != 1 {
-		t.Fatal(ErrIncorrectResponse)
-	}
-	if paging.Pages != 1 {
-		t.Fatal(ErrIncorrectResponse)
+	// test the cursor
+	if nextCursor != "dGVhbV9pZDo5MDAwMTcw" {
+		t.Fatalf("Expected cursor %q, got %q", "dGVhbV9pZDo5MDAwMTcw", nextCursor)
 	}
 }