Webhook APIs (#264)

* Implement getBotInfo API (#261)

* Add getBotInfo API support

* Update doc for getBotInfo

Co-authored-by: xingo xu <xingoxu@users.noreply.github.com>

* Implement testWebhookEndpoint API

* Implement setWebhookEndpointUrl API

Co-authored-by: xingo xu <xingoxu@users.noreply.github.com>

Author: dlackty

docs/api-reference/client.md

@@ -54,7 +54,7 @@ class Client {
   linkRichMenuToUser(userId: string, richMenuId: string): Promise<any>
   unlinkRichMenuFromUser(userId: string, richMenuId: string): Promise<any>
   linkRichMenuToMultipleUsers(richMenuId: string, userIds: string[]): Promise<any>
-	unlinkRichMenusFromMultipleUsers(userIds: string[]): Promise<any>
+  unlinkRichMenusFromMultipleUsers(userIds: string[]): Promise<any>
   getRichMenuImage(richMenuId: string): Promise<Readable>
   setRichMenuImage(richMenuId: string, data: Buffer | Readable, contentType?: string): Promise<any>
   getRichMenuList(): Promise<Array<RichMenuResponse>>
@@ -175,6 +175,20 @@ class Client {
 
   // Bot
   getBotInfo(): Promise<BotInfoResponse>
+
+  // Webhook
+  setWebhookEndpointUrl(endpoint: string): Promise<{}>
+  getWebhookEndpointInfo(): Promise<{
+    endpoint: string;
+    active: boolean;
+  }>
+  testWebhookEndpoint(endpoint?: string): Promise<{
+    success: boolean;
+    timestamp: string;
+    statusCode: number;
+    reason: string;
+    detail: string;
+  }>
 }
 ```
 
@@ -676,3 +690,18 @@ It corresponds to the [Get friend demographics](https://developers.line.biz/en/r
 #### `getBotInfo(): Promise<BotInfoResponse>`
 
 It corresponds to the [Get bot info](https://developers.line.biz/en/reference/messaging-api/#get-bot-info) API.
+
+### Webhook
+
+#### `setWebhookEndpointUrl(endpoint: string): Promise<{}}>`
+
+It corresponds to the [Set webhook endpoint URL](https://developers.line.biz/en/reference/messaging-api/#set-webhook-endpoint-url) API.
+
+
+#### `getWebhookEndpointInfo(): Promise<Types.WebhookEndpointInfoResponse>`
+
+It corresponds to the [Get webhook endpoint information](https://developers.line.biz/en/reference/messaging-api/#get-webhook-endpoint-information) API.
+
+#### `testWebhookEndpoint(endpoint?: string): Promise<Types.TestWebhookEndpointResponse>`
+
+It corresponds to the [Test webhook endpoint](https://developers.line.biz/en/reference/messaging-api/#test-webhook-endpoint) API.

lib/client.ts

@@ -637,6 +637,28 @@ export default class Client {
     );
     return ensureJSON(res);
   }
+
+  public async setWebhookEndpointUrl(endpoint: string) {
+    return this.http.put<{}>(
+      `${MESSAGING_API_PREFIX}/channel/webhook/endpoint`,
+      { endpoint },
+    );
+  }
+
+  public async getWebhookEndpointInfo() {
+    const res = await this.http.get<Types.WebhookEndpointInfoResponse>(
+      `${MESSAGING_API_PREFIX}/channel/webhook/endpoint`,
+    );
+    return ensureJSON(res);
+  }
+
+  public async testWebhookEndpoint(endpoint?: string) {
+    const res = await this.http.post<Types.TestWebhookEndpointResponse>(
+      `${MESSAGING_API_PREFIX}/channel/webhook/test`,
+      { endpoint },
+    );
+    return ensureJSON(res);
+  }
 }
 
 export class OAuth {

lib/types.ts

@@ -2602,3 +2602,26 @@ export type BotInfoResponse = {
   chatMode: "chat" | "bot";
   markAsReadMode: "auto" | "manual";
 };
+
+/**
+ * Response body of get webhook endpoint info.
+ *
+ * @see [Get get webhook endpoint info](https://developers.line.biz/en/reference/messaging-api/#get-webhook-endpoint-information)
+ */
+export type WebhookEndpointInfoResponse = {
+  endpoint: string;
+  active: boolean;
+};
+
+/**
+ * Response body of test webhook endpoint.
+ *
+ * @see [Test webhook endpoint](https://developers.line.biz/en/reference/messaging-api/#test-webhook-endpoint)
+ */
+export type TestWebhookEndpointResponse = {
+  success: boolean;
+  timestamp: string;
+  statusCode: number;
+  reason: string;
+  detail: string;
+};

test/client.spec.ts

@@ -904,6 +904,33 @@ describe("client", () => {
     equal(scope.isDone(), true);
   });
 
+  it("setWebhookEndpointUrl", async () => {
+    const endpoint = "https://developers.line.biz/";
+    const scope = mockPut(MESSAGING_API_PREFIX, `/channel/webhook/endpoint`, {
+      endpoint,
+    });
+
+    await client.setWebhookEndpointUrl(endpoint);
+    equal(scope.isDone(), true);
+  });
+
+  it("getWebhookEndpointInfo", async () => {
+    const scope = mockGet(MESSAGING_API_PREFIX, `/channel/webhook/endpoint`);
+
+    await client.getWebhookEndpointInfo();
+    equal(scope.isDone(), true);
+  });
+
+  it("testWebhookEndpoint", async () => {
+    const endpoint = "https://developers.line.biz/";
+    const scope = mockPost(MESSAGING_API_PREFIX, `/channel/webhook/test`, {
+      endpoint,
+    });
+
+    await client.testWebhookEndpoint(endpoint);
+    equal(scope.isDone(), true);
+  });
+
   it("set option once and clear option", async () => {
     const expectedBody = {
       messages: [testMsg],