feat: base.getOrganizaions (#46)

Author: miyajan

docs/base.md

@@ -1,6 +1,7 @@
 # Base
 
 - [getUsers](#getusers)
+- [getOrganizations](#getorganizations)
 
 ## Overview
 
@@ -40,3 +41,23 @@ See the example response in the `Reference`.
 #### Reference
 
 - https://developer.cybozu.io/hc/ja/articles/360018124651#step1
+
+### getOrganizations
+
+Get organizations specified by conditions.
+
+#### Parameters
+
+| Name   |  Type  | Required | Description                                                                                                                                |
+| ------ | :----: | :------: | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| limit  | Number |          | The number of organizations to retrieve.<br />Must be between `1` and `1000`.<br />If nothing is specified, it will default to `100`.      |
+| offset | Number |          | The number of retrievals that will be skipped.<br />Must be between `0` and `2147483647`. If nothing is specified, it will default to `0`. |
+| name   | String |          | The name for searching organizations.                                                                                                      |
+
+#### Returns
+
+See the example response in the `Reference`.
+
+#### Reference
+
+- https://developer.cybozu.io/hc/ja/articles/360017843172#step1

src/client/BaseClient.ts

@@ -18,8 +18,27 @@ export class BaseClient {
       name: string;
       code: string;
     }>;
+    hasNext: boolean;
   }> {
     const path = buildPath({ endpointName: "base/users" });
     return this.client.get(path, params ?? {});
   }
+
+  public getOrganizations(params?: {
+    limit?: number;
+    offset?: number;
+    name?: string;
+  }): Promise<{
+    organizations: Array<{
+      id: string;
+      name: string;
+      code: string;
+      parentOrganization: string;
+      childOrganizations: Array<{ id: string }>;
+    }>;
+    hasNext: boolean;
+  }> {
+    const path = buildPath({ endpointName: "base/organizations" });
+    return this.client.get(path, params ?? {});
+  }
 }

src/client/__tests__/BaseClient.test.ts

@@ -39,4 +39,24 @@ describe("BaseClient", () => {
       expect(mockClient.getLogs()[0].params).toEqual(params);
     });
   });
+
+  describe("getOrganizations", () => {
+    const params = {
+      limit: 100,
+      offset: 0,
+      name: "test",
+    };
+    beforeEach(async () => {
+      await baseClient.getOrganizations(params);
+    });
+    it("should pass the path to the http client", () => {
+      expect(mockClient.getLogs()[0].path).toBe("/api/v1/base/organizations");
+    });
+    it("should send a get request", () => {
+      expect(mockClient.getLogs()[0].method).toBe("get");
+    });
+    it("should pass params as a param to the http client", () => {
+      expect(mockClient.getLogs()[0].params).toEqual(params);
+    });
+  });
 });