feat(TypeScript): "ping" event payload definitions (#121)

Co-authored-by: Octokit Bot <[email protected]>
octokit · Apr 12, 2020 · b9c82a5 · b9c82a5
1 parent dc62e27
commit b9c82a5
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 4 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -12,6 +12,31 @@ type Options = {
 };
 
 declare namespace Webhooks {
+  type WebhookPayloadPingPayloadHookConfig = {
+    content_type: string;
+    insecure_ssl: string;
+    url: string;
+  };
+  type WebhookPayloadPingPayloadHook = {
+    type: string;
+    id: number;
+    name: string;
+    active: boolean;
+    events: Array<string>;
+    config: WebhookPayloadPingPayloadHookConfig;
+    updated_at: string;
+    created_at: string;
+    app_id: number;
+  };
+  type WebhookPayloadPingPayload = {
+    zen: string;
+    hook_id: number;
+    hook: WebhookPayloadPingPayloadHook;
+  };
+  type WebhookPayloadPing = {
+    event: string;
+    payload: WebhookPayloadPingPayload;
+  };
   type WebhookPayloadWatchSender = {
     login: string;
     id: number;
@@ -4668,6 +4693,13 @@ declare class Webhooks {
     ) => Promise<void> | void
   ): void;
 
+  public on(
+    event: "ping",
+    callback: (
+      event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadPing>
+    ) => Promise<void> | void
+  ): void;
+
   public sign(data: any): string;
   public verify(eventPayload: any, signature: string): boolean;
   public verifyAndReceive(options: {

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -15,7 +15,7 @@
   },
   "devDependencies": {
     "@gimenete/type-writer": "^0.1.5",
-    "@octokit/webhooks-definitions": "3.4.2",
+    "@octokit/webhooks-definitions": "3.5.0",
     "axios": "^0.19.0",
     "cheerio": "^1.0.0-rc.2",
     "get-port": "^5.0.0",