feat(rest-api-client): add app.moveToSpace method

examples/rest-api-client-demo/src/app.ts

@@ -764,4 +764,14 @@ export class App {
       console.log(error);
     }
   }
+
+  public async moveToSpace() {
+    try {
+      console.log(
+        await this.client.app.moveToSpace({ app: APP_ID, space: SPACE_ID }),
+      );
+    } catch (error) {
+      console.log(error);
+    }
+  }
 }

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

@@ -36,6 +36,7 @@
 - [updateReports](#updateReports)
 - [getAppActions](#getAppActions)
 - [updateAppActions](#updateAppActions)
+- [moveToSpace](#moveToSpace)
 
 ## Overview
 
@@ -1353,3 +1354,22 @@ Updates the [Action](https://get.kintone.help/k/en/user/app_settings/appaction/s
 #### Reference
 
 - https://kintone.dev/en/docs/kintone/rest-api/apps/update-action-settings/
+
+### moveToSpace
+
+Changes the Space to which an App belongs.
+
+#### Parameters
+
+| Name  |           Type           | Required | Description                                                                                                             |
+| ----- | :----------------------: | :------: | ----------------------------------------------------------------------------------------------------------------------- |
+| app   |     Number or String     |   Yes    | The App ID.                                                                                                             |
+| space | Number or String or null |   Yes    | The Space ID of where the App will be moved to. <br />To remove an App from its current space, `null` can be specified. |
+
+#### Returns
+
+An empty object.
+
+#### Reference
+
+- https://kintone.dev/en/docs/kintone/rest-api/apps/move-app-to-space/

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

@@ -33,6 +33,7 @@ import type {
   ReportForResponse,
   AppActionsForParameter,
   AppActionsForResponse,
+  SpaceID,
 } from "./types";
 import { BaseClient } from "./BaseClient";
 type RowLayoutForParameter = {
@@ -616,4 +617,14 @@ export class AppClient extends BaseClient {
     });
     return this.client.put(path, params);
   }
+
+  public moveToSpace(params: {
+    app: AppID;
+    space: SpaceID | null;
+  }): Promise<{}> {
+    const path = this.buildPath({
+      endpointName: "app/move",
+    });
+    return this.client.post(path, params);
+  }
 }

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

@@ -1312,6 +1312,37 @@ describe("AppClient", () => {
   });
 });
 
+describe("AppClient: moveToSpace", () => {
+  let mockClient: MockClient;
+  let appClient: AppClient;
+
+  beforeEach(() => {
+    const requestConfigBuilder = new KintoneRequestConfigBuilder({
+      baseUrl: "https://example.cybozu.com",
+      auth: { type: "apiToken", apiToken: "foo" },
+    });
+    mockClient = buildMockClient(requestConfigBuilder);
+    appClient = new AppClient(mockClient);
+  });
+  describe("moveToSpace", () => {
+    const params = { app: APP_ID, space: 1 } as const;
+    describe("without preview", () => {
+      beforeEach(async () => {
+        await appClient.moveToSpace(params);
+      });
+      it("should pass the path to the http client", () => {
+        expect(mockClient.getLogs()[0].path).toBe("/k/v1/app/move.json");
+      });
+      it("should send a post request", () => {
+        expect(mockClient.getLogs()[0].method).toBe("post");
+      });
+      it("should pass app and space as a param to the http client", () => {
+        expect(mockClient.getLogs()[0].params).toEqual(params);
+      });
+    });
+  });
+});
+
 describe("AppClient with guestSpaceId", () => {
   it("should pass the path to the http client", async () => {
     const GUEST_SPACE_ID = 2;