refactor: Use PaginatedResource for RBAC list methods

Migrate listPermissions and listEnvironmentRoles to use
PaginatedResource from #316. Also adds pagination params to
listEnvironmentRoles and restores type hint on getPermission.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Author: gjtorikian

lib/RBAC.php

@@ -53,7 +53,7 @@ public function createPermission(
      *
      * @throws Exception\WorkOSException
      *
-     * @return array{?string, ?string, Resource\Permission[]}
+     * @return Resource\PaginatedResource
      */
     public function listPermissions(
         int $limit = self::DEFAULT_PAGE_SIZE,
@@ -72,13 +72,7 @@ public function listPermissions(
 
         $response = Client::request(Client::METHOD_GET, $path, null, $params, true);
 
-        $permissions = [];
-        list($before, $after) = Util\Request::parsePaginationArgs($response);
-        foreach ($response["data"] as $responseData) {
-            \array_push($permissions, Resource\Permission::constructFromResponse($responseData));
-        }
-
-        return [$before, $after, $permissions];
+        return Resource\PaginatedResource::constructFromResponse($response, Resource\Permission::class, 'permissions');
     }
 
     /**
@@ -189,22 +183,33 @@ public function createEnvironmentRole(
     /**
      * List Environment Roles.
      *
+     * @param int $limit Maximum number of records to return
+     * @param null|string $before Role ID to look before
+     * @param null|string $after Role ID to look after
+     * @param null|string $order The order in which to paginate records
+     *
      * @throws Exception\WorkOSException
      *
-     * @return Resource\Role[]
+     * @return Resource\PaginatedResource
      */
-    public function listEnvironmentRoles()
-    {
+    public function listEnvironmentRoles(
+        int $limit = self::DEFAULT_PAGE_SIZE,
+        ?string $before = null,
+        ?string $after = null,
+        ?string $order = null
+    ) {
         $path = "authorization/roles";
 
-        $response = Client::request(Client::METHOD_GET, $path, null, null, true);
+        $params = [
+            "limit" => $limit,
+            "before" => $before,
+            "after" => $after,
+            "order" => $order,
+        ];
 
-        $roles = [];
-        foreach ($response["data"] as $responseData) {
-            \array_push($roles, Resource\Role::constructFromResponse($responseData));
-        }
+        $response = Client::request(Client::METHOD_GET, $path, null, $params, true);
 
-        return $roles;
+        return Resource\PaginatedResource::constructFromResponse($response, Resource\Role::class, 'roles');
     }
 
     /**

tests/WorkOS/RBACTest.php

@@ -71,8 +71,8 @@ public function testListPermissions()
 
         $permission = $this->permissionFixture();
 
-        list($before, $after, $permissions) = $this->rbac->listPermissions();
-        $this->assertSame($permission, $permissions[0]->toArray());
+        $response = $this->rbac->listPermissions();
+        $this->assertSame($permission, $response->permissions[0]->toArray());
     }
 
     public function testGetPermission()
@@ -170,19 +170,26 @@ public function testListEnvironmentRoles()
 
         $result = $this->rolesListResponseFixture();
 
+        $params = [
+            "limit" => RBAC::DEFAULT_PAGE_SIZE,
+            "before" => null,
+            "after" => null,
+            "order" => null,
+        ];
+
         $this->mockRequest(
             Client::METHOD_GET,
             $path,
             null,
-            null,
+            $params,
             true,
             $result
         );
 
         $role = $this->roleFixture();
 
-        $roles = $this->rbac->listEnvironmentRoles();
-        $this->assertSame($role, $roles[0]->toArray());
+        $response = $this->rbac->listEnvironmentRoles();
+        $this->assertSame($role, $response->roles[0]->toArray());
     }
 
     public function testGetEnvironmentRole()
@@ -369,6 +376,10 @@ private function rolesListResponseFixture()
                     "created_at" => "2024-01-01T00:00:00.000Z",
                     "updated_at" => "2024-01-01T00:00:00.000Z"
                 ]
+            ],
+            "list_metadata" => [
+                "before" => null,
+                "after" => null
             ]
         ]);
     }