fix: Add missing pagination to getUsers() and getTeams()

Author: jhnns

README.md

@@ -443,7 +443,7 @@ await clockodo.getTeam({ id: 10 });
 
 ### [getTeams()](https://docs.clockodo.com/#tag/Team/operation/getTeamsV3)
 
-Get list of all teams.
+Get list of all teams from all pages.
 
 #### Example:
 
@@ -453,6 +453,18 @@ await clockodo.getTeams();
 
 ---
 
+### [getTeamsPage()](https://docs.clockodo.com/#tag/Team/operation/getTeamsV3)
+
+Get all teams from a specific page.
+
+#### Example:
+
+```js
+await clockodo.getTeamsPage({ page: 2 });
+```
+
+---
+
 ### [getLumpSumService()](https://docs.clockodo.com/#tag/LumpSumService/operation/getLumpSumServiceByIdV4)
 
 Get a lumpsum service by its ID.
@@ -529,7 +541,7 @@ await clockodo.getUser({ id: 1263 });
 
 ### [getUsers()](https://docs.clockodo.com/#tag/User/operation/getUsersV3)
 
-Get list of users
+Get list of users from all pages.
 
 #### Example:
 
@@ -539,6 +551,18 @@ await clockodo.getUsers();
 
 ---
 
+### [getUsersPage()](https://docs.clockodo.com/#tag/User/operation/getUsersV3)
+
+Get all users from a specific page.
+
+#### Example:
+
+```js
+await clockodo.getUsersPage({ page: 2 });
+```
+
+---
+
 ### getSurchargeModel()
 
 Get a surcharge model by ID.

src/clockodo.test.ts

@@ -599,6 +599,50 @@ describe("Clockodo (instance)", () => {
       });
     });
 
+    describe("getTeam()", () => {
+      it("correctly builds getTeam() request", async () => {
+        const nockScope = nock(CLOCKODO_API_BASE_URL)
+          .get("/v3/teams/1")
+          .reply(200, {});
+
+        await expect(clockodo.getTeam({ id: 1 })).resolves.not.toBeInstanceOf(
+          Error,
+        );
+
+        nockScope.done();
+      });
+    });
+
+    describe("getTeamsPage()", () => {
+      it("correctly builds getTeamsPage() request", async () => {
+        const nockScope = nock(CLOCKODO_API_BASE_URL)
+          .get("/v3/teams")
+          .reply(200, {});
+
+        await expect(clockodo.getTeamsPage()).resolves.not.toBeInstanceOf(
+          Error,
+        );
+
+        nockScope.done();
+      });
+    });
+
+    describe("getTeams()", () => {
+      it("requests all team pages", async () => {
+        const nockScope = setupPaginatedApiMock({
+          baseUrl: "/v3/teams?",
+          countPages: 3,
+          createPageResponse: (page) => ({ data: [page] }),
+        });
+
+        const { data } = await clockodo.getTeams();
+
+        expect(data).toMatchObject([1, 2, 3]);
+
+        nockScope.done();
+      });
+    });
+
     describe("getSingleTargetHourSet", () => {
       it("correctly builds getSingleTargetHourSet() request", async () => {
         const nockScope = nock(CLOCKODO_API_BASE_URL)
@@ -641,13 +685,31 @@ describe("Clockodo (instance)", () => {
       });
     });
 
-    describe("getUsers()", () => {
-      it("correctly builds getUsers() request", async () => {
+    describe("getUsersPage()", () => {
+      it("correctly builds getUsersPage() request", async () => {
         const nockScope = nock(CLOCKODO_API_BASE_URL)
           .get("/v3/users")
           .reply(200, {});
 
-        await expect(clockodo.getUsers()).resolves.not.toBeInstanceOf(Error);
+        await expect(clockodo.getUsersPage()).resolves.not.toBeInstanceOf(
+          Error,
+        );
+
+        nockScope.done();
+      });
+    });
+
+    describe("getUsers()", () => {
+      it("requests all user pages", async () => {
+        const nockScope = setupPaginatedApiMock({
+          baseUrl: "/v3/users?",
+          countPages: 3,
+          createPageResponse: (page) => ({ data: [page] }),
+        });
+
+        const { data } = await clockodo.getUsers();
+
+        expect(data).toMatchObject([1, 2, 3]);
 
         nockScope.done();
       });

src/clockodo.ts

@@ -340,12 +340,22 @@ export class Clockodo {
     return this.api.get("/v3/teams/" + id, remainingParams);
   }
 
-  async getTeams(
+  async getTeamsPage(
     params?: Params<TeamsParams & ParamsWithPage>,
   ): Promise<TeamsReturnType> {
     return this.api.get("/v3/teams", params);
   }
 
+  async getTeams(
+    params?: Params<TeamsParams>,
+  ): Promise<ResponseWithoutPaging<TeamsReturnType>> {
+    return this.getAllPagesAndMergeArray<TeamsReturnType, TeamsParams>(
+      "/v3/teams",
+      params,
+      "data",
+    );
+  }
+
   async getLumpSumService(
     params: Params<{ id: LumpsumService["id"] }>,
   ): Promise<LumpsumServiceReturnType> {
@@ -395,10 +405,22 @@ export class Clockodo {
     return this.api.get("/v3/users/" + id, remainingParams);
   }
 
-  async getUsers(params?: Params<UsersParams>): Promise<UsersReturnType> {
+  async getUsersPage(
+    params?: Params<UsersParams & ParamsWithPage>,
+  ): Promise<UsersReturnType> {
     return this.api.get("/v3/users", params);
   }
 
+  async getUsers(
+    params?: Params<UsersParams>,
+  ): Promise<ResponseWithoutPaging<UsersReturnType>> {
+    return this.getAllPagesAndMergeArray<UsersReturnType, UsersParams>(
+      "/v3/users",
+      params,
+      "data",
+    );
+  }
+
   async getSurchargeModel(
     params: Params<{ id: SurchargeModel["id"] }>,
   ): Promise<SurchargeModelReturnType> {