feat(rest-api-client): add get app statistics api (#3479)

Author: nameless-mc

packages/rest-api-client/docs/app.md

@@ -41,6 +41,7 @@
 - [move](#move)
 - [getPlugins](#getPlugins)
 - [addPlugins](#addPlugins)
+- [getStatistics](#getStatistics)
 
 ## Overview
 
@@ -1508,3 +1509,27 @@ Adds Plug-ins to an App.
 #### Reference
 
 - https://kintone.dev/en/docs/kintone/rest-api/apps/add-plugins/
+
+### getStatistics
+
+Gets usage statistics for multiple Apps.
+
+> [!NOTE]
+> This API is available only in Wide Course.
+
+#### Parameters
+
+| Name   |  Type  | Required | Description                                                                                                   |
+| ------ | :----: | :------: | ------------------------------------------------------------------------------------------------------------- |
+| offset | Number |          | The offset. Default value is 0 if this parameter is ignored.                                                  |
+| limit  | Number |          | The number of Apps to retrieve. Must be between 1 and 100. Default value is 100 if this parameter is ignored. |
+
+#### Returns
+
+| Name | Type  | Description                                                                                                                                                                                                          |
+| ---- | :---: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| apps | Array | An array of objects containing App usage statistics. <br/>For each object's properties, see "Response Parameters" section of [the reference](https://kintone.dev/en/kintone/docs/rest-api/apps/get-apps-statistics/) |
+
+#### Reference
+
+- https://cybozu.dev/ja/kintone/docs/rest-api/apps/get-apps-statistics/

packages/rest-api-client/src/client/AppClient.ts

@@ -37,6 +37,8 @@ import type {
   AdminNotesForParameter,
   SpaceID,
   PluginLocale,
+  GetStatisticsRequest,
+  GetStatisticsResponse,
 } from "./types";
 import { BaseClient } from "./BaseClient";
 import type { AppPlugin } from "./types/app/plugin";
@@ -635,4 +637,13 @@ export class AppClient extends BaseClient {
     });
     return this.client.post(path, params);
   }
+
+  public getStatistics(
+    params?: GetStatisticsRequest,
+  ): Promise<GetStatisticsResponse> {
+    const path = this.buildPath({
+      endpointName: "apps/statistics",
+    });
+    return this.client.get(path, params ?? {});
+  }
 }

packages/rest-api-client/src/client/__tests__/app/App.test.ts

@@ -130,4 +130,40 @@ describe("App Test", () => {
       });
     });
   });
+
+  describe("getStatistics", () => {
+    describe("without params", () => {
+      beforeEach(async () => {
+        await appClient.getStatistics();
+      });
+      it("should pass the path to the http client", () => {
+        expect(mockClient.getLogs()[0].path).toBe("/k/v1/apps/statistics.json");
+      });
+      it("should send a get request", () => {
+        expect(mockClient.getLogs()[0].method).toBe("get");
+      });
+      it("should pass empty params to the http client", () => {
+        expect(mockClient.getLogs()[0].params).toEqual({});
+      });
+    });
+
+    describe("with offset and limit", () => {
+      const params = {
+        offset: 10,
+        limit: 50,
+      };
+      beforeEach(async () => {
+        await appClient.getStatistics(params);
+      });
+      it("should pass the path to the http client", () => {
+        expect(mockClient.getLogs()[0].path).toBe("/k/v1/apps/statistics.json");
+      });
+      it("should send a get request", () => {
+        expect(mockClient.getLogs()[0].method).toBe("get");
+      });
+      it("should pass offset and limit as a param to the http client", () => {
+        expect(mockClient.getLogs()[0].params).toEqual(params);
+      });
+    });
+  });
 });

packages/rest-api-client/src/client/types/app/index.ts

@@ -28,3 +28,4 @@ export * from "./notification";
 export * from "./report";
 export * from "./action";
 export * from "./adminNotes";
+export * from "./statistics";

packages/rest-api-client/src/client/types/app/statistics.ts

@@ -0,0 +1,37 @@
+import type { AppID, SpaceID } from "../";
+
+export type GetStatisticsRequest = {
+  offset?: number;
+  limit?: number;
+};
+
+export type AppStatistics = {
+  id: AppID;
+  name: string;
+  space: {
+    id: SpaceID;
+    name: string;
+  } | null;
+  appGroup: string;
+  status: "CHANGED" | "NOT_ACTIVATED" | "ACTIVATED";
+  recordUpdatedAt: string;
+  recordCount: string;
+  fieldCount: string;
+  dailyRequestCount: string;
+  storageUsage: string;
+  customized: boolean;
+  creator: {
+    code: string;
+    name: string;
+  };
+  createdAt: string;
+  modifier: {
+    code: string;
+    name: string;
+  };
+  modifiedAt: string;
+};
+
+export type GetStatisticsResponse = {
+  apps: AppStatistics[];
+};