Add workspace list pagination params

Author: AaronDDM

CHANGELOG.md

@@ -7,7 +7,7 @@
   - `Applications.update()` for `PATCH /v3/applications`
   - Redirect URI updates use `PATCH /v3/applications/redirect-uris/{id}`
   - Manage Domains admin CRUD and verification endpoints on `client.domains()` via `/v3/admin/domains`; these support `ServiceAccountSigner` for Nylas Service Account request-signing auth without Bearer auth and still accept manually signed headers in `RequestOverrides.headers`
-  - `Workspaces` resource via `client.workspaces()`: CRUD, `autoGroup`, `manualAssign`, `default`, `policyId`, and `ruleIds`; `CreateWorkspaceRequest` validates that `domain` is present when `autoGroup` is true
+  - `Workspaces` resource via `client.workspaces()`: CRUD, paginated listing with `limit` and `page_token`, `autoGroup`, `manualAssign`, `default`, `policyId`, and `ruleIds`; `CreateWorkspaceRequest` validates that `domain` is present when `autoGroup` is true
 * Transactional email support via `Domains.sendTransactionalEmail()`
   - `SendTransactionalEmailRequest` model (and fluent `Builder`) for composing transactional messages from a verified domain — supports `to`, `from`, `cc`, `bcc`, `reply_to`, `subject`, `body`, `send_at`, `reply_to_message_id`, `tracking_options`, `use_draft`, `custom_headers`, and `is_plaintext`
   - `NylasClient.domains()` accessor returning the new `Domains` resource

src/main/kotlin/com/nylas/models/ListWorkspacesQueryParams.kt

@@ -0,0 +1,47 @@
+package com.nylas.models
+
+import com.squareup.moshi.Json
+
+/**
+ * Class representation of the query parameters for listing workspaces.
+ */
+data class ListWorkspacesQueryParams(
+  /**
+   * The maximum number of objects to return.
+   */
+  @Json(name = "limit")
+  val limit: Int? = null,
+  /**
+   * Cursor for pagination. Pass the value of [ListResponse.nextCursor] to get the next page.
+   */
+  @Json(name = "page_token")
+  val pageToken: String? = null,
+) : IQueryParams {
+  /**
+   * Builder for [ListWorkspacesQueryParams].
+   */
+  class Builder {
+    private var limit: Int? = null
+    private var pageToken: String? = null
+
+    /**
+     * Set the maximum number of objects to return.
+     * @param limit The maximum number of objects to return.
+     * @return The builder.
+     */
+    fun limit(limit: Int) = apply { this.limit = limit }
+
+    /**
+     * Set the pagination cursor.
+     * @param pageToken Cursor for pagination. Pass the value of [ListResponse.nextCursor].
+     * @return The builder.
+     */
+    fun pageToken(pageToken: String) = apply { this.pageToken = pageToken }
+
+    /**
+     * Build the [ListWorkspacesQueryParams].
+     * @return A [ListWorkspacesQueryParams] with the provided values.
+     */
+    fun build() = ListWorkspacesQueryParams(limit, pageToken)
+  }
+}

src/main/kotlin/com/nylas/resources/Workspaces.kt

@@ -17,13 +17,14 @@ import com.squareup.moshi.Types
 class Workspaces(client: NylasClient) : Resource<Workspace>(client, Workspace::class.java) {
   /**
    * Return all workspaces for your application.
+   * @param queryParams Optional query parameters to apply
    * @param overrides Optional request overrides to apply
    * @return The list of workspaces
    */
   @Throws(NylasApiError::class, NylasSdkTimeoutError::class)
   @JvmOverloads
-  fun list(overrides: RequestOverrides? = null): ListResponse<Workspace> {
-    return listResource("v3/workspaces", overrides = overrides)
+  fun list(queryParams: ListWorkspacesQueryParams? = null, overrides: RequestOverrides? = null): ListResponse<Workspace> {
+    return listResource("v3/workspaces", queryParams, overrides)
   }
 
   /**

src/test/kotlin/com/nylas/resources/WorkspacesTests.kt

@@ -171,6 +171,28 @@ class WorkspacesTests {
 
       assertEquals("v3/workspaces", pathCaptor.firstValue)
       assertEquals(Types.newParameterizedType(ListResponse::class.java, Workspace::class.java), typeCaptor.firstValue)
+      assertNull(queryParamCaptor.firstValue)
+    }
+
+    @Test
+    fun `listing workspaces with query params passes them correctly`() {
+      val queryParams = ListWorkspacesQueryParams(limit = 5, pageToken = "cursor123")
+      workspaces.list(queryParams)
+
+      val pathCaptor = argumentCaptor<String>()
+      val typeCaptor = argumentCaptor<Type>()
+      val queryParamCaptor = argumentCaptor<IQueryParams>()
+      val overrideParamCaptor = argumentCaptor<RequestOverrides>()
+      verify(mockNylasClient).executeGet<ListResponse<Workspace>>(
+        pathCaptor.capture(),
+        typeCaptor.capture(),
+        queryParamCaptor.capture(),
+        overrideParamCaptor.capture(),
+      )
+
+      assertEquals("v3/workspaces", pathCaptor.firstValue)
+      assertEquals(Types.newParameterizedType(ListResponse::class.java, Workspace::class.java), typeCaptor.firstValue)
+      assertEquals(queryParams, queryParamCaptor.firstValue)
     }
 
     @Test