@line/bot-sdk

constructor(
    message: string,
    { status, statusText, headers, body }: FetchErrorDetails
);

body: string;

headers: Headers;

status: number;

statusText: string;

constructor(message: string, { raw }?: ErrorDetails);

raw: any;

protected readonly clients: LineBotClientDelegates;

static fromChannelAccessToken: (
    config: LineBotClientChannelAccessTokenConfig
) => LineBotClient;

constructor(message: string, { signature }?: ErrorDetails);

signature?: string;

body: T;

httpResponse: Response;

readonly channelAccessToken: string;

channelSecret: string;

skipSignatureVerification?: () => boolean;

type ChannelAccessTokenKeyIdsResponse = {
    /**
     * Array of channel access token key IDs.
     */
    kids: Array<string>;
};

type ErrorResponse = {
    /**
     * Error summary
     */
    error?: string;
    /**
     * Details of the error. Not returned in certain situations.
     */
    error_description?: string;
};

type IssueChannelAccessTokenResponse = {
    /**
     * Channel access token.
     */
    access_token: string;
    /**
     * Amount of time in seconds from issue to expiration of the channel access token
     */
    expires_in: number;
    /**
     * A token type.
     * @default 'Bearer'
     */
    token_type: string;
    /**
     * Unique key ID for identifying the channel access token.
     */
    key_id: string;
};

type IssueShortLivedChannelAccessTokenResponse = {
    /**
     * A short-lived channel access token. Valid for 30 days. Note: Channel access tokens cannot be refreshed.
     */
    access_token: string;
    /**
     * Time until channel access token expires in seconds from time the token is issued.
     */
    expires_in: number;
    /**
     * Token type. The value is always `Bearer`.
     * @default 'Bearer'
     */
    token_type: string;
};

type IssueStatelessChannelAccessTokenResponse = {
    /**
     * A stateless channel access token. The token is an opaque string which means its format is an implementation detail and the consumer of this token should never try to use the data parsed from the token.
     */
    access_token: string;
    /**
     * Duration in seconds after which the issued access token expires
     */
    expires_in: number;
    /**
     * Token type. The value is always `Bearer`.
     * @default 'Bearer'
     */
    token_type: string;
};

type VerifyChannelAccessTokenResponse = {
    /**
     * The channel ID for which the channel access token was issued.
     */
    client_id: string;
    /**
     * Number of seconds before the channel access token expires.
     */
    expires_in: number;
    /**
     * Permissions granted to the channel access token.
     */
    scope?: string;
};

type AgeTile = {
    /**
     * users' age
     */
    age?: AgeTile.AgeEnum;
    /**
     * Percentage
     */
    percentage?: number;
};

type AppTypeTile = {
    /**
     * users' OS
     */
    appType?: AppTypeTile.AppTypeEnum;
    /**
     * Percentage
     */
    percentage?: number;
};

type AreaTile = {
    /**
     * users' country and region
     */
    area?: string;
    /**
     * Percentage
     */
    percentage?: number;
};

type ErrorDetail = {
    /**
     * Details of the error. Not included in the response under certain situations.
     */
    message?: string;
    /**
     * Location of where the error occurred. Returns the JSON field name or query parameter name of the request. Not included in the response under certain situations.
     */
    property?: string;
};

type ErrorResponse = {
    /**
     * Message containing information about the error.
     */
    message: string;
    /**
     * An array of error details. If the array is empty, this property will not be included in the response.
     */
    details?: Array<ErrorDetail>;
};

type GenderTile = {
    /**
     * users' gender
     */
    gender?: GenderTile.GenderEnum;
    /**
     * Percentage
     */
    percentage?: number;
};

type GetFriendsDemographicsResponse = {
    /**
     * true if friend demographic information is available.
     */
    available?: boolean;
    /**
     * Percentage per gender.
     */
    genders?: Array<GenderTile>;
    /**
     * Percentage per age group.
     */
    ages?: Array<AgeTile>;
    /**
     * Percentage per area.
     */
    areas?: Array<AreaTile>;
    /**
     * Percentage by OS.
     */
    appTypes?: Array<AppTypeTile>;
    /**
     * Percentage per friendship duration.
     */
    subscriptionPeriods?: Array<SubscriptionPeriodTile>;
};

type GetMessageEventResponse = {
    overview?: GetMessageEventResponseOverview;
    /**
     * Array of information about individual message bubbles.
     */
    messages?: Array<GetMessageEventResponseMessage>;
    /**
     * Array of information about opened URLs in the message.
     */
    clicks?: Array<GetMessageEventResponseClick>;
};

type GetMessageEventResponseClick = {
    /**
     * The URL's serial number.
     */
    seq?: number;
    /**
     * URL.
     */
    url?: string;
    /**
     * Number of times the URL was opened.
     */
    click?: number | null;
    /**
     * Number of users that opened the URL.
     */
    uniqueClick?: number | null;
    /**
     * Number of users who opened this url through any link in the message. If a message contains two links to the same URL and a user opens both links, they're counted only once.
     */
    uniqueClickOfRequest?: number | null;
};

type GetMessageEventResponseMessage = {
    /**
     * Bubble's serial number.
     */
    seq?: number;
    /**
     * Number of times the bubble was displayed.
     */
    impression?: number | null;
    /**
     * Number of times audio or video in the bubble started playing.
     */
    mediaPlayed?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 25% of the total time.
     */
    mediaPlayed25Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 50% of the total time.
     */
    mediaPlayed50Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 75% of the total time.
     */
    mediaPlayed75Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 100% of the total time.
     */
    mediaPlayed100Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble.
     */
    uniqueMediaPlayed?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 25% of the total time.
     */
    uniqueMediaPlayed25Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 50% of the total time.
     */
    uniqueMediaPlayed50Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 75% of the total time.
     */
    uniqueMediaPlayed75Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 100% of the total time.
     */
    uniqueMediaPlayed100Percent?: number | null;
};

type GetMessageEventResponseOverview = {
    /**
     * Request ID.
     */
    requestId?: string;
    /**
     * UNIX timestamp for message delivery time in seconds.
     */
    timestamp?: number;
    /**
     * Number of messages delivered. This property shows values of less than 20. However, if all messages have not been sent, it will be null.
     */
    delivered?: number;
    /**
     * Number of users who opened the message, meaning they displayed at least 1 bubble.
     */
    uniqueImpression?: number | null;
    /**
     * Number of users who opened any URL in the message.
     */
    uniqueClick?: number | null;
    /**
     * Number of users who started playing any video or audio in the message.
     */
    uniqueMediaPlayed?: number | null;
    /**
     * Number of users who played the entirety of any video or audio in the message.
     */
    uniqueMediaPlayed100Percent?: number | null;
};

type GetNumberOfFollowersResponse = {
    /**
     * Calculation status.
     */
    status?: GetNumberOfFollowersResponse.StatusEnum;
    /**
     * The number of times, as of the specified date, that a user added this LINE Official Account as a friend for the first time. The number doesn't decrease even if a user later blocks the account or when they delete their LINE account.
     */
    followers?: number;
    /**
     * The number of users, as of the specified date, that the LINE Official Account can reach through targeted messages based on gender, age, and/or region. This number only includes users who are active on LINE or LINE services and whose demographics have a high level of certainty.
     */
    targetedReaches?: number;
    /**
     * The number of users blocking the account as of the specified date. The number decreases when a user unblocks the account.
     */
    blocks?: number;
};

type GetNumberOfMessageDeliveriesResponse = {
    /**
     * Status of the counting process.
     */
    status?: GetNumberOfMessageDeliveriesResponse.StatusEnum;
    /**
     * Number of messages sent to all of this LINE Official Account's friends (broadcast messages).
     */
    broadcast?: number;
    /**
     * Number of messages sent to some of this LINE Official Account's friends, based on specific attributes (targeted messages).
     */
    targeting?: number;
    /**
     * Number of auto-response messages sent.
     */
    autoResponse?: number;
    /**
     * Number of greeting messages sent.
     */
    welcomeResponse?: number;
    /**
     * Number of messages sent from LINE Official Account Manager [Chat screen](https://www.linebiz.com/jp/manual/OfficialAccountManager/chats/) (only available in Japanese).
     */
    chat?: number;
    /**
     * Number of broadcast messages sent with the `Send broadcast message` Messaging API operation.
     */
    apiBroadcast?: number;
    /**
     * Number of push messages sent with the `Send push message` Messaging API operation.
     */
    apiPush?: number;
    /**
     * Number of multicast messages sent with the `Send multicast message` Messaging API operation.
     */
    apiMulticast?: number;
    /**
     * Number of narrowcast messages sent with the `Send narrowcast message` Messaging API operation.
     */
    apiNarrowcast?: number;
    /**
     * Number of replies sent with the `Send reply message` Messaging API operation.
     */
    apiReply?: number;
};

type GetStatisticsPerUnitResponse = {
    overview: GetStatisticsPerUnitResponseOverview;
    /**
     * Array of information about individual message bubbles.
     */
    messages: Array<GetStatisticsPerUnitResponseMessage>;
    /**
     * Array of information about opened URLs in the message.
     */
    clicks: Array<GetStatisticsPerUnitResponseClick>;
};

type GetStatisticsPerUnitResponseClick = {
    /**
     * The URL's serial number.
     */
    seq: number;
    /**
     * URL.
     */
    url: string;
    /**
     * Number of times the URL in the bubble was opened.
     */
    click?: number | null;
    /**
     * Number of users that opened the URL in the bubble.
     */
    uniqueClick?: number | null;
    /**
     * Number of users who opened this url through any link in the message. If another message bubble contains the same URL and a user opens both links, it's counted only once.
     */
    uniqueClickOfRequest?: number | null;
};

type GetStatisticsPerUnitResponseMessage = {
    /**
     * Bubble's serial number.
     */
    seq: number;
    /**
     * Number of times the bubble was displayed.
     */
    impression?: number | null;
    /**
     * Number of times audio or video in the bubble started playing.
     */
    mediaPlayed?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 25% of the total time.
     */
    mediaPlayed25Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 50% of the total time.
     */
    mediaPlayed50Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 75% of the total time.
     */
    mediaPlayed75Percent?: number | null;
    /**
     * Number of times audio or video in the bubble started playing and was played 100% of the total time.
     */
    mediaPlayed100Percent?: number | null;
    /**
     * Number of users the bubble was displayed.
     */
    uniqueImpression?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble.
     */
    uniqueMediaPlayed?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 25% of the total time.
     */
    uniqueMediaPlayed25Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 50% of the total time.
     */
    uniqueMediaPlayed50Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 75% of the total time.
     */
    uniqueMediaPlayed75Percent?: number | null;
    /**
     * Number of users that started playing audio or video in the bubble and played 100% of the total time.
     */
    uniqueMediaPlayed100Percent?: number | null;
};

type GetStatisticsPerUnitResponseOverview = {
    /**
     * Number of users who opened the message, meaning they displayed at least 1 bubble.
     */
    uniqueImpression?: number | null;
    /**
     * Number of users who opened any URL in the message.
     */
    uniqueClick?: number | null;
    /**
     * Number of users who started playing any video or audio in the message.
     */
    uniqueMediaPlayed?: number | null;
    /**
     * Number of users who played the entirety of any video or audio in the message.
     */
    uniqueMediaPlayed100Percent?: number | null;
};

type SubscriptionPeriodTile = {
    /**
     * Subscription period. Possible values: `within7days`, `within90days`, `unknown` etc.
     */
    subscriptionPeriod?: SubscriptionPeriodTile.SubscriptionPeriodEnum;
    /**
     * Percentage. Possible values: [0.0,100.0] e.g. 0, 2.9, 37.6.
     */
    percentage?: number;
};

type AgeEnum =
    | 'from0to14'
    | 'from15to19'
    | 'from20to24'
    | 'from25to29'
    | 'from30to34'
    | 'from35to39'
    | 'from40to44'
    | 'from45to49'
    | 'from50'
    | 'from50to54'
    | 'from55to59'
    | 'from60to64'
    | 'from65to69'
    | 'from70'
    | 'unknown';

type AppTypeEnum = 'ios' | 'android' | 'others';

type GenderEnum = 'male' | 'female' | 'unknown';

type StatusEnum = 'ready' | 'unready' | 'out_of_service';

type StatusEnum = 'ready' | 'unready' | 'out_of_service';

type SubscriptionPeriodEnum =
    | 'within7days'
    | 'within30days'
    | 'within90days'
    | 'within180days'
    | 'within365days'
    | 'over365days'
    | 'unknown';

type AddLiffAppRequest = {
    view: LiffView;
    /**
     * Name of the LIFF app.  The LIFF app name can't include \"LINE\" or similar strings, or inappropriate strings.
     */
    description?: string;
    features?: LiffFeatures;
    /**
     * How additional information in LIFF URLs is handled. Specify `concat`.
     */
    permanentLinkPattern?: string;
    scope?: Array<LiffScope>;
    botPrompt?: LiffBotPrompt;
};

type AddLiffAppResponse = {
    liffId: string;
};

type GetAllLiffAppsResponse = {
    apps?: Array<LiffApp>;
};

type LiffApp = {
    /**
     * LIFF app ID
     */
    liffId?: string;
    view?: LiffView;
    /**
     * Name of the LIFF app
     */
    description?: string;
    features?: LiffFeatures;
    /**
     * How additional information in LIFF URLs is handled. concat is returned.
     */
    permanentLinkPattern?: string;
    scope?: Array<LiffScope>;
    botPrompt?: LiffBotPrompt;
};

type LiffBotPrompt = 'normal' | 'aggressive' | 'none';

type LiffFeatures = {
    /**
     * `true` if the LIFF app supports Bluetooth® Low Energy for LINE Things. `false` otherwise.
     */
    ble?: boolean;
    /**
     * `true` to use the 2D code reader in the LIFF app. false otherwise. The default value is `false`.
     * @default false
     */
    qrCode?: boolean;
};