@line/bot-sdk/lib/webhook/model/event.ts

Node.js SDK for LINE Messaging API

/**
 * Webhook Type Definition
 * Webhook event definition of the LINE Messaging API
 *
 * The version of the OpenAPI document: 1.0.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */

import { DeliveryContext } from "./deliveryContext";
import { EventMode } from "./eventMode";
import { Source } from "./source";

import { AccountLinkEvent } from "./models";
import { ActivatedEvent } from "./models";
import { BeaconEvent } from "./models";
import { BotResumedEvent } from "./models";
import { BotSuspendedEvent } from "./models";
import { DeactivatedEvent } from "./models";
import { FollowEvent } from "./models";
import { JoinEvent } from "./models";
import { LeaveEvent } from "./models";
import { MemberJoinedEvent } from "./models";
import { MemberLeftEvent } from "./models";
import { MessageEvent } from "./models";
import { ModuleEvent } from "./models";
import { PostbackEvent } from "./models";
import { ThingsEvent } from "./models";
import { UnfollowEvent } from "./models";
import { UnsendEvent } from "./models";
import { VideoPlayCompleteEvent } from "./models";

export type Event =
  | AccountLinkEvent // accountLink
  | ActivatedEvent // activated
  | BeaconEvent // beacon
  | BotResumedEvent // botResumed
  | BotSuspendedEvent // botSuspended
  | DeactivatedEvent // deactivated
  | FollowEvent // follow
  | JoinEvent // join
  | LeaveEvent // leave
  | MemberJoinedEvent // memberJoined
  | MemberLeftEvent // memberLeft
  | MessageEvent // message
  | ModuleEvent // module
  | PostbackEvent // postback
  | ThingsEvent // things
  | UnfollowEvent // unfollow
  | UnsendEvent // unsend
  | VideoPlayCompleteEvent // videoPlayComplete
  | UnknownEvent;

export type UnknownEvent = EventBase & {
  [key: string]: unknown;
};

/**
 * Webhook event
 */
export type EventBase = {
  /**
   * Type of the event
   */
  type: string /**/;
  /**
   */
  source?: Source /**/;
  /**
   * Time of the event in milliseconds.
   */
  timestamp: number /**/;
  /**
   */
  mode: EventMode /**/;
  /**
   * Webhook Event ID. An ID that uniquely identifies a webhook event. This is a string in ULID format.
   */
  webhookEventId: string /**/;
  /**
   */
  deliveryContext: DeliveryContext /**/;
};

export namespace Event {}