@line/bot-sdk/dist/messaging-api/api/messagingApiClient.d.ts

Node.js SDK for LINE Messaging API

/**
 * LINE Messaging API
 * This document describes LINE Messaging API.
 *
 * The version of the OpenAPI document: 0.0.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { BotInfoResponse } from "../model/botInfoResponse.js";
import { BroadcastRequest } from "../model/broadcastRequest.js";
import { CouponCreateRequest } from "../model/couponCreateRequest.js";
import { CouponCreateResponse } from "../model/couponCreateResponse.js";
import { CouponResponse } from "../model/couponResponse.js";
import { CreateRichMenuAliasRequest } from "../model/createRichMenuAliasRequest.js";
import { GetAggregationUnitNameListResponse } from "../model/getAggregationUnitNameListResponse.js";
import { GetAggregationUnitUsageResponse } from "../model/getAggregationUnitUsageResponse.js";
import { GetFollowersResponse } from "../model/getFollowersResponse.js";
import { GetJoinedMembershipUsersResponse } from "../model/getJoinedMembershipUsersResponse.js";
import { GetMembershipSubscriptionResponse } from "../model/getMembershipSubscriptionResponse.js";
import { GetWebhookEndpointResponse } from "../model/getWebhookEndpointResponse.js";
import { GroupMemberCountResponse } from "../model/groupMemberCountResponse.js";
import { GroupSummaryResponse } from "../model/groupSummaryResponse.js";
import { GroupUserProfileResponse } from "../model/groupUserProfileResponse.js";
import { IssueLinkTokenResponse } from "../model/issueLinkTokenResponse.js";
import { MarkMessagesAsReadByTokenRequest } from "../model/markMessagesAsReadByTokenRequest.js";
import { MarkMessagesAsReadRequest } from "../model/markMessagesAsReadRequest.js";
import { MembersIdsResponse } from "../model/membersIdsResponse.js";
import { MembershipListResponse } from "../model/membershipListResponse.js";
import { MessageQuotaResponse } from "../model/messageQuotaResponse.js";
import { MessagingApiPagerCouponListResponse } from "../model/messagingApiPagerCouponListResponse.js";
import { MulticastRequest } from "../model/multicastRequest.js";
import { NarrowcastProgressResponse } from "../model/narrowcastProgressResponse.js";
import { NarrowcastRequest } from "../model/narrowcastRequest.js";
import { NumberOfMessagesResponse } from "../model/numberOfMessagesResponse.js";
import { PnpMessagesRequest } from "../model/pnpMessagesRequest.js";
import { PushMessageRequest } from "../model/pushMessageRequest.js";
import { PushMessageResponse } from "../model/pushMessageResponse.js";
import { QuotaConsumptionResponse } from "../model/quotaConsumptionResponse.js";
import { ReplyMessageRequest } from "../model/replyMessageRequest.js";
import { ReplyMessageResponse } from "../model/replyMessageResponse.js";
import { RichMenuAliasListResponse } from "../model/richMenuAliasListResponse.js";
import { RichMenuAliasResponse } from "../model/richMenuAliasResponse.js";
import { RichMenuBatchProgressResponse } from "../model/richMenuBatchProgressResponse.js";
import { RichMenuBatchRequest } from "../model/richMenuBatchRequest.js";
import { RichMenuBulkLinkRequest } from "../model/richMenuBulkLinkRequest.js";
import { RichMenuBulkUnlinkRequest } from "../model/richMenuBulkUnlinkRequest.js";
import { RichMenuIdResponse } from "../model/richMenuIdResponse.js";
import { RichMenuListResponse } from "../model/richMenuListResponse.js";
import { RichMenuRequest } from "../model/richMenuRequest.js";
import { RichMenuResponse } from "../model/richMenuResponse.js";
import { RoomMemberCountResponse } from "../model/roomMemberCountResponse.js";
import { RoomUserProfileResponse } from "../model/roomUserProfileResponse.js";
import { SetWebhookEndpointRequest } from "../model/setWebhookEndpointRequest.js";
import { ShowLoadingAnimationRequest } from "../model/showLoadingAnimationRequest.js";
import { TestWebhookEndpointRequest } from "../model/testWebhookEndpointRequest.js";
import { TestWebhookEndpointResponse } from "../model/testWebhookEndpointResponse.js";
import { UpdateRichMenuAliasRequest } from "../model/updateRichMenuAliasRequest.js";
import { UserProfileResponse } from "../model/userProfileResponse.js";
import { ValidateMessageRequest } from "../model/validateMessageRequest.js";
import * as Types from "../../types.js";
interface httpClientConfig {
    /**
     * Base URL for requests.
     * Defaults to 'https://api.line.me'.
     * You can override this for testing or to use a mock server.
     */
    baseURL?: string;
    /**
     * Channel access token used for authorization.
     */
    channelAccessToken: string;
    /**
     * Extra headers merged into every request.
     */
    defaultHeaders?: Record<string, string>;
}
/**
 * @see {@link LineBotClient} for a unified interface that wraps this client.
 */
export declare class MessagingApiClient {
    private httpClient;
    /**
     * Initializes a new `MessagingApiClient`.
     *
     * @param config Configuration for this API client.
     * @param config.baseURL The base URL for requests. Defaults to `https://api.line.me`.
     * @param config.channelAccessToken The channel access token used for authorization.
     * @param config.defaultHeaders Extra headers merged into every request.
     *
     * @example
     * const client = new MessagingApiClient({
     *   channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!,
     * });
     */
    constructor(config: httpClientConfig);
    /**
     * Sends a message to multiple users at any time.
     * Calls `POST https://api.line.me/v2/bot/message/broadcast`.
     * To inspect the HTTP status code or response headers, use {@link broadcastWithHttpInfo}.
     * @param broadcastRequest
     * @param xLineRetryKey Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message">LINE Developers documentation</a>
     */
    broadcast(broadcastRequest: BroadcastRequest, xLineRetryKey?: string): Promise<object>;
    /**
     * Sends a message to multiple users at any time.
     * Calls `POST https://api.line.me/v2/bot/message/broadcast`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param broadcastRequest
     * @param xLineRetryKey Retry key. Specifies the UUID in hexadecimal format (e.g., `123e4567-e89b-12d3-a456-426614174000`) generated by any method. The retry key isn't generated by LINE. Each developer must generate their own retry key.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message">LINE Developers documentation</a>
     */
    broadcastWithHttpInfo(broadcastRequest: BroadcastRequest, xLineRetryKey?: string): Promise<Types.ApiResponseType<object>>;
    /**
     * Cancel default rich menu
     * Calls `DELETE https://api.line.me/v2/bot/user/all/richmenu`.
     * To inspect the HTTP status code or response headers, use {@link cancelDefaultRichMenuWithHttpInfo}.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#cancel-default-rich-menu">LINE Developers documentation</a>
     */
    cancelDefaultRichMenu(): Promise<Types.MessageAPIResponseBase>;
    /**
     * Cancel default rich menu
     * Calls `DELETE https://api.line.me/v2/bot/user/all/richmenu`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#cancel-default-rich-menu">LINE Developers documentation</a>
     */
    cancelDefaultRichMenuWithHttpInfo(): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
    /**
     * Close coupon
     * Calls `PUT https://api.line.me/v2/bot/coupon/{couponId}/close`.
     * To inspect the HTTP status code or response headers, use {@link closeCouponWithHttpInfo}.
     * @param couponId
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#discontinue-coupon">LINE Developers documentation</a>
     */
    closeCoupon(couponId: string): Promise<Types.MessageAPIResponseBase>;
    /**
     * Close coupon
     * Calls `PUT https://api.line.me/v2/bot/coupon/{couponId}/close`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param couponId
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#discontinue-coupon">LINE Developers documentation</a>
     */
    closeCouponWithHttpInfo(couponId: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
    /**
     * Create a new coupon. Define coupon details such as type, title, and validity period.
     * Calls `POST https://api.line.me/v2/bot/coupon`.
     * To inspect the HTTP status code or response headers, use {@link createCouponWithHttpInfo}.
     * @param couponCreateRequest
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-coupon">LINE Developers documentation</a>
     */
    createCoupon(couponCreateRequest?: CouponCreateRequest): Promise<CouponCreateResponse>;
    /**
     * Create a new coupon. Define coupon details such as type, title, and validity period.
     * Calls `POST https://api.line.me/v2/bot/coupon`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param couponCreateRequest
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-coupon">LINE Developers documentation</a>
     */
    createCouponWithHttpInfo(couponCreateRequest?: CouponCreateRequest): Promise<Types.ApiResponseType<CouponCreateResponse>>;
    /**
     * Create rich menu
     * Calls `POST https://api.line.me/v2/bot/richmenu`.
     * To inspect the HTTP status code or response headers, use {@link createRichMenuWithHttpInfo}.
     * @param richMenuRequest
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-rich-menu">LINE Developers documentation</a>
     */
    createRichMenu(richMenuRequest: RichMenuRequest): Promise<RichMenuIdResponse>;
    /**
     * Create rich menu
     * Calls `POST https://api.line.me/v2/bot/richmenu`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param richMenuRequest
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-rich-menu">LINE Developers documentation</a>
     */
    createRichMenuWithHttpInfo(richMenuRequest: RichMenuRequest): Promise<Types.ApiResponseType<RichMenuIdResponse>>;
    /**
     * Create rich menu alias
     * Calls `POST https://api.line.me/v2/bot/richmenu/alias`.
     * To inspect the HTTP status code or response headers, use {@link createRichMenuAliasWithHttpInfo}.
     * @param createRichMenuAliasRequest
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-rich-menu-alias">LINE Developers documentation</a>
     */
    createRichMenuAlias(createRichMenuAliasRequest: CreateRichMenuAliasRequest): Promise<Types.MessageAPIResponseBase>;
    /**
     * Create rich menu alias
     * Calls `POST https://api.line.me/v2/bot/richmenu/alias`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param createRichMenuAliasRequest
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-rich-menu-alias">LINE Developers documentation</a>
     */
    createRichMenuAliasWithHttpInfo(createRichMenuAliasRequest: CreateRichMenuAliasRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
    /**
     * Deletes a rich menu.
     * Calls `DELETE https://api.line.me/v2/bot/richmenu/{richMenuId}`.
     * To inspect the HTTP status code or response headers, use {@link deleteRichMenuWithHttpInfo}.
     * @param richMenuId ID of a rich menu
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu">LINE Developers documentation</a>
     */
    deleteRichMenu(richMenuId: string): Promise<Types.MessageAPIResponseBase>;
    /**
     * Deletes a rich menu.
     * Calls `DELETE https://api.line.me/v2/bot/richmenu/{richMenuId}`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param richMenuId ID of a rich menu
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu">LINE Developers documentation</a>
     */
    deleteRichMenuWithHttpInfo(richMenuId: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
    /**
     * Delete rich menu alias
     * Calls `DELETE https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}`.
     * To inspect the HTTP status code or response headers, use {@link deleteRichMenuAliasWithHttpInfo}.
     * @param richMenuAliasId Rich menu alias ID that you want to delete.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu-alias">LINE Developers documentation</a>
     */
    deleteRichMenuAlias(richMenuAliasId: string): Promise<Types.MessageAPIResponseBase>;
    /**
     * Delete rich menu alias
     * Calls `DELETE https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param richMenuAliasId Rich menu alias ID that you want to delete.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu-alias">LINE Developers documentation</a>
     */
    deleteRichMenuAliasWithHttpInfo(richMenuAliasId: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
    /**
     * Get name list of units used this month
     * Calls `GET https://api.line.me/v2/bot/message/aggregation/list`.
     * To inspect the HTTP status code or response headers, use {@link getAggregationUnitNameListWithHttpInfo}.
     * @param limit The maximum number of aggregation units you can get per request.
     * @param start Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-name-list-of-units-used-this-month">LINE Developers documentation</a>
     */
    getAggregationUnitNameList(limit?: string, start?: string): Promise<GetAggregationUnitNameListResponse>;
    /**
     * Get name list of units used this month
     * Calls `GET https://api.line.me/v2/bot/message/aggregation/list`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param limit The maximum number of aggregation units you can get per request.
     * @param start Value of the continuation token found in the next property of the JSON object returned in the response. If you can't get all the aggregation units in one request, include this parameter to get the remaining array.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-name-list-of-units-used-this-month">LINE Developers documentation</a>
     */
    getAggregationUnitNameListWithHttpInfo(limit?: string, start?: string): Promise<Types.ApiResponseType<GetAggregationUnitNameListResponse>>;
    /**
     * Get number of units used this month
     * Calls `GET https://api.line.me/v2/bot/message/aggregation/info`.
     * To inspect the HTTP status code or response headers, use {@link getAggregationUnitUsageWithHttpInfo}.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-units-used-this-month">LINE Developers documentation</a>
     */
    getAggregationUnitUsage(): Promise<GetAggregationUnitUsageResponse>;
    /**
     * Get number of units used this month
     * Calls `GET https://api.line.me/v2/bot/message/aggregation/info`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-units-used-this-month">LINE Developers documentation</a>
     */
    getAggregationUnitUsageWithHttpInfo(): Promise<Types.ApiResponseType<GetAggregationUnitUsageResponse>>;
    /**
     * Get bot info
     * Calls `GET https://api.line.me/v2/bot/info`.
     * To inspect the HTTP status code or response headers, use {@link getBotInfoWithHttpInfo}.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-bot-info">LINE Developers documentation</a>
     */
    getBotInfo(): Promise<BotInfoResponse>;
    /**
     * Get bot info
     * Calls `GET https://api.line.me/v2/bot/info`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-bot-info">LINE Developers documentation</a>
     */
    getBotInfoWithHttpInfo(): Promise<Types.ApiResponseType<BotInfoResponse>>;
    /**
     * Get coupon detail
     * Calls `GET https://api.line.me/v2/bot/coupon/{couponId}`.
     * To inspect the HTTP status code or response headers, use {@link getCouponDetailWithHttpInfo}.
     * @param couponId
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupon">LINE Developers documentation</a>
     */
    getCouponDetail(couponId: string): Promise<CouponResponse>;
    /**
     * Get coupon detail
     * Calls `GET https://api.line.me/v2/bot/coupon/{couponId}`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param couponId
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupon">LINE Developers documentation</a>
     */
    getCouponDetailWithHttpInfo(couponId: string): Promise<Types.ApiResponseType<CouponResponse>>;
    /**
     * Gets the ID of the default rich menu set with the Messaging API.
     * Calls `GET https://api.line.me/v2/bot/user/all/richmenu`.
     * To inspect the HTTP status code or response headers, use {@link getDefaultRichMenuIdWithHttpInfo}.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-default-rich-menu-id">LINE Developers documentation</a>
     */
    getDefaultRichMenuId(): Promise<RichMenuIdResponse>;
    /**
     * Gets the ID of the default rich menu set with the Messaging API.
     * Calls `GET https://api.line.me/v2/bot/user/all/richmenu`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-default-rich-menu-id">LINE Developers documentation</a>
     */
    getDefaultRichMenuIdWithHttpInfo(): Promise<Types.ApiResponseType<RichMenuIdResponse>>;
    /**
     * Get a list of users who added your LINE Official Account as a friend
     * Calls `GET https://api.line.me/v2/bot/followers/ids`.
     * To inspect the HTTP status code or response headers, use {@link getFollowersWithHttpInfo}.
     * @param start Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
     * @param limit The maximum number of user IDs to retrieve in a single request.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-follower-ids">LINE Developers documentation</a>
     */
    getFollowers(start?: string, limit?: number): Promise<GetFollowersResponse>;
    /**
     * Get a list of users who added your LINE Official Account as a friend
     * Calls `GET https://api.line.me/v2/bot/followers/ids`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param start Value of the continuation token found in the next property of the JSON object returned in the response. Include this parameter to get the next array of user IDs.
     * @param limit The maximum number of user IDs to retrieve in a single request.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-follower-ids">LINE Developers documentation</a>
     */
    getFollowersWithHttpInfo(start?: string, limit?: number): Promise<Types.ApiResponseType<GetFollowersResponse>>;
    /**
     * Get number of users in a group chat
     * Calls `GET https://api.line.me/v2/bot/group/{groupId}/members/count`.
     * To inspect the HTTP status code or response headers, use {@link getGroupMemberCountWithHttpInfo}.
     * @param groupId Group ID
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-members-group-count">LINE Developers documentation</a>
     */
    getGroupMemberCount(groupId: string): Promise<GroupMemberCountResponse>;
    /**
     * Get number of users in a group chat
     * Calls `GET https://api.line.me/v2/bot/group/{groupId}/members/count`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param groupId Group ID
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-members-group-count">LINE Developers documentation</a>
     */
    getGroupMemberCountWithHttpInfo(groupId: string): Promise<Types.ApiResponseType<GroupMemberCountResponse>>;
    /**
     * Get group chat member profile
     * Calls `GET https://api.line.me/v2/bot/group/{groupId}/member/{userId}`.
     * To inspect the HTTP status code or response headers, use {@link getGroupMemberProfileWithHttpInfo}.
     * @param groupId Group ID
     * @param userId User ID
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-member-profile">LINE Developers documentation</a>
     */
    getGroupMemberProfile(groupId: string, userId: string): Promise<GroupUserProfileResponse>;
    /**
     * Get group chat member profile
     * Calls `GET https://api.line.me/v2/bot/group/{groupId}/member/{userId}`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param groupId Group ID
     * @param userId User ID
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-member-profile">LINE Developers documentation</a>
     */
    getGroupMemberProfileWithHttpInfo(groupId: string, userId: string): Promise<Types.ApiResponseType<GroupUserProfileResponse>>;
    /**
     * Get group chat member user IDs
     * Calls `GET https://api.line.me/v2/bot/group/{groupId}/members/ids`.
     * To inspect the HTTP status code or response headers, use {@link getGroupMembersIdsWithHttpInfo}.
     * @param groupId Group ID
     * @param start Value of the continuation token found in the `next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-member-user-ids">LINE Developers documentation</a>
     */
    getGroupMembersIds(groupId: string, start?: string): Promise<MembersIdsResponse>;
    /**
     * Get group chat member user IDs
     * Calls `GET https://api.line.me/v2/bot/group/{groupId}/members/ids`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param groupId Group ID
     * @param start Value of the continuation token found in the `next` property of the JSON object returned in the response. Include this parameter to get the next array of user IDs for the members of the group.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-member-user-ids">LINE Developers documentation</a>
     */
    getGroupMembersIdsWithHttpInfo(groupId: string, start?: string): Promise<Types.ApiResponseType<MembersIdsResponse>>;
    /**
     * Get group chat summary
     * Calls `GET https://api.line.me/v2/bot/group/{groupId}/summary`.
     * To inspect the HTTP status code or response headers, use {@link getGroupSummaryWithHttpInfo}.
     * @param groupId Group ID
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-summary">LINE Developers documentation</a>
     */
    getGroupSummary(groupId: string): Promise<GroupSummaryResponse>;
    /**
     * Get group chat summary
     * Calls `GET https://api.line.me/v2/bot/group/{groupId}/summary`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param groupId Group ID
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-summary">LINE Developers documentation</a>
     */
    getGroupSummaryWithHttpInfo(groupId: string): Promise<Types.ApiResponseType<GroupSummaryResponse>>;
    /**
     * Get a list of user IDs who joined the membership.
     * Calls `GET https://api.line.me/v2/bot/membership/{membershipId}/users/ids`.
     * To inspect the HTTP status code or response headers, use {@link getJoinedMembershipUsersWithHttpInfo}.
     * @param membershipId Membership plan ID.
     * @param start A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).
     * @param limit The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-user-ids">LINE Developers documentation</a>
     */
    getJoinedMembershipUsers(membershipId: number, start?: string, limit?: number): Promise<GetJoinedMembershipUsersResponse>;
    /**
     * Get a list of user IDs who joined the membership.
     * Calls `GET https://api.line.me/v2/bot/membership/{membershipId}/users/ids`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param membershipId Membership plan ID.
     * @param start A continuation token to get next remaining membership user IDs. Returned only when there are remaining user IDs that weren't returned in the userIds property in the previous request. The continuation token expires in 24 hours (86,400 seconds).
     * @param limit The max number of items to return for this API call. The value is set to 300 by default, but the max acceptable value is 1000.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-user-ids">LINE Developers documentation</a>
     */
    getJoinedMembershipUsersWithHttpInfo(membershipId: number, start?: string, limit?: number): Promise<Types.ApiResponseType<GetJoinedMembershipUsersResponse>>;
    /**
     * Get a list of memberships.
     * Calls `GET https://api.line.me/v2/bot/membership/list`.
     * To inspect the HTTP status code or response headers, use {@link getMembershipListWithHttpInfo}.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-plans">LINE Developers documentation</a>
     */
    getMembershipList(): Promise<MembershipListResponse>;
    /**
     * Get a list of memberships.
     * Calls `GET https://api.line.me/v2/bot/membership/list`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-plans">LINE Developers documentation</a>
     */
    getMembershipListWithHttpInfo(): Promise<Types.ApiResponseType<MembershipListResponse>>;
    /**
     * Get a user's membership subscription.
     * Calls `GET https://api.line.me/v2/bot/membership/subscription/{userId}`.
     * To inspect the HTTP status code or response headers, use {@link getMembershipSubscriptionWithHttpInfo}.
     * @param userId User ID
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status">LINE Developers documentation</a>
     */
    getMembershipSubscription(userId: string): Promise<GetMembershipSubscriptionResponse>;
    /**
     * Get a user's membership subscription.
     * Calls `GET https://api.line.me/v2/bot/membership/subscription/{userId}`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param userId User ID
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status">LINE Developers documentation</a>
     */
    getMembershipSubscriptionWithHttpInfo(userId: string): Promise<Types.ApiResponseType<GetMembershipSubscriptionResponse>>;
    /**
     * Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.
     * Calls `GET https://api.line.me/v2/bot/message/quota`.
     * To inspect the HTTP status code or response headers, use {@link getMessageQuotaWithHttpInfo}.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-quota">LINE Developers documentation</a>
     */
    getMessageQuota(): Promise<MessageQuotaResponse>;
    /**
     * Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.
     * Calls `GET https://api.line.me/v2/bot/message/quota`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-quota">LINE Developers documentation</a>
     */
    getMessageQuotaWithHttpInfo(): Promise<Types.ApiResponseType<MessageQuotaResponse>>;
    /**
     * Gets the number of messages sent in the current month.
     * Calls `GET https://api.line.me/v2/bot/message/quota/consumption`.
     * To inspect the HTTP status code or response headers, use {@link getMessageQuotaConsumptionWithHttpInfo}.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-consumption">LINE Developers documentation</a>
     */
    getMessageQuotaConsumption(): Promise<QuotaConsumptionResponse>;
    /**
     * Gets the number of messages sent in the current month.
     * Calls `GET https://api.line.me/v2/bot/message/quota/consumption`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-consumption">LINE Developers documentation</a>
     */
    getMessageQuotaConsumptionWithHttpInfo(): Promise<Types.ApiResponseType<QuotaConsumptionResponse>>;
    /**
     * Gets the status of a narrowcast message.
     * Calls `GET https://api.line.me/v2/bot/message/progress/narrowcast`.
     * To inspect the HTTP status code or response headers, use {@link getNarrowcastProgressWithHttpInfo}.
     * @param requestId The narrowcast message's request ID. Each Messaging API request has a request ID.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">LINE Developers documentation</a>
     */
    getNarrowcastProgress(requestId: string): Promise<NarrowcastProgressResponse>;
    /**
     * Gets the status of a narrowcast message.
     * Calls `GET https://api.line.me/v2/bot/message/progress/narrowcast`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param requestId The narrowcast message's request ID. Each Messaging API request has a request ID.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status">LINE Developers documentation</a>
     */
    getNarrowcastProgressWithHttpInfo(requestId: string): Promise<Types.ApiResponseType<NarrowcastProgressResponse>>;
    /**
     * Get number of sent broadcast messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/broadcast`.
     * To inspect the HTTP status code or response headers, use {@link getNumberOfSentBroadcastMessagesWithHttpInfo}.
     * @param date Date the messages were sent  Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-broadcast-messages">LINE Developers documentation</a>
     */
    getNumberOfSentBroadcastMessages(date: string): Promise<NumberOfMessagesResponse>;
    /**
     * Get number of sent broadcast messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/broadcast`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param date Date the messages were sent  Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-broadcast-messages">LINE Developers documentation</a>
     */
    getNumberOfSentBroadcastMessagesWithHttpInfo(date: string): Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;
    /**
     * Get number of sent multicast messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/multicast`.
     * To inspect the HTTP status code or response headers, use {@link getNumberOfSentMulticastMessagesWithHttpInfo}.
     * @param date Date the messages were sent  Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-multicast-messages">LINE Developers documentation</a>
     */
    getNumberOfSentMulticastMessages(date: string): Promise<NumberOfMessagesResponse>;
    /**
     * Get number of sent multicast messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/multicast`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param date Date the messages were sent  Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-multicast-messages">LINE Developers documentation</a>
     */
    getNumberOfSentMulticastMessagesWithHttpInfo(date: string): Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;
    /**
     * Get number of sent push messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/push`.
     * To inspect the HTTP status code or response headers, use {@link getNumberOfSentPushMessagesWithHttpInfo}.
     * @param date Date the messages were sent  Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-push-messages">LINE Developers documentation</a>
     */
    getNumberOfSentPushMessages(date: string): Promise<NumberOfMessagesResponse>;
    /**
     * Get number of sent push messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/push`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param date Date the messages were sent  Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-push-messages">LINE Developers documentation</a>
     */
    getNumberOfSentPushMessagesWithHttpInfo(date: string): Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;
    /**
     * Get number of sent reply messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/reply`.
     * To inspect the HTTP status code or response headers, use {@link getNumberOfSentReplyMessagesWithHttpInfo}.
     * @param date Date the messages were sent  Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-reply-messages">LINE Developers documentation</a>
     */
    getNumberOfSentReplyMessages(date: string): Promise<NumberOfMessagesResponse>;
    /**
     * Get number of sent reply messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/reply`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param date Date the messages were sent  Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-reply-messages">LINE Developers documentation</a>
     */
    getNumberOfSentReplyMessagesWithHttpInfo(date: string): Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;
    /**
     * Get number of sent LINE notification messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/pnp`.
     * To inspect the HTTP status code or response headers, use {@link getPNPMessageStatisticsWithHttpInfo}.
     * @param date Date the message was sent  Format: `yyyyMMdd` (Example:`20211231`) Time zone: UTC+9
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/partner-docs/#get-number-of-sent-line-notification-messages">LINE Developers documentation</a>
     */
    getPNPMessageStatistics(date: string): Promise<NumberOfMessagesResponse>;
    /**
     * Get number of sent LINE notification messages
     * Calls `GET https://api.line.me/v2/bot/message/delivery/pnp`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param date Date the message was sent  Format: `yyyyMMdd` (Example:`20211231`) Time zone: UTC+9
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/partner-docs/#get-number-of-sent-line-notification-messages">LINE Developers documentation</a>
     */
    getPNPMessageStatisticsWithHttpInfo(date: string): Promise<Types.ApiResponseType<NumberOfMessagesResponse>>;
    /**
     * Get profile
     * Calls `GET https://api.line.me/v2/bot/profile/{userId}`.
     * To inspect the HTTP status code or response headers, use {@link getProfileWithHttpInfo}.
     * @param userId User ID
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-profile">LINE Developers documentation</a>
     */
    getProfile(userId: string): Promise<UserProfileResponse>;
    /**
     * Get profile
     * Calls `GET https://api.line.me/v2/bot/profile/{userId}`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param userId User ID
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-profile">LINE Developers documentation</a>
     */
    getProfileWithHttpInfo(userId: string): Promise<Types.ApiResponseType<UserProfileResponse>>;
    /**
     * Gets a rich menu via a rich menu ID.
     * Calls `GET https://api.line.me/v2/bot/richmenu/{richMenuId}`.
     * To inspect the HTTP status code or response headers, use {@link getRichMenuWithHttpInfo}.
     * @param richMenuId ID of a rich menu
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu">LINE Developers documentation</a>
     */
    getRichMenu(richMenuId: string): Promise<RichMenuResponse>;
    /**
     * Gets a rich menu via a rich menu ID.
     * Calls `GET https://api.line.me/v2/bot/richmenu/{richMenuId}`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param richMenuId ID of a rich menu
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu">LINE Developers documentation</a>
     */
    getRichMenuWithHttpInfo(richMenuId: string): Promise<Types.ApiResponseType<RichMenuResponse>>;
    /**
     * Get rich menu alias information
     * Calls `GET https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}`.
     * To inspect the HTTP status code or response headers, use {@link getRichMenuAliasWithHttpInfo}.
     * @param richMenuAliasId The rich menu alias ID whose information you want to obtain.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-by-id">LINE Developers documentation</a>
     */
    getRichMenuAlias(richMenuAliasId: string): Promise<RichMenuAliasResponse>;
    /**
     * Get rich menu alias information
     * Calls `GET https://api.line.me/v2/bot/richmenu/alias/{richMenuAliasId}`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param richMenuAliasId The rich menu alias ID whose information you want to obtain.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-by-id">LINE Developers documentation</a>
     */
    getRichMenuAliasWithHttpInfo(richMenuAliasId: string): Promise<Types.ApiResponseType<RichMenuAliasResponse>>;
    /**
     * Get list of rich menu alias
     * Calls `GET https://api.line.me/v2/bot/richmenu/alias/list`.
     * To inspect the HTTP status code or response headers, use {@link getRichMenuAliasListWithHttpInfo}.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-list">LINE Developers documentation</a>
     */
    getRichMenuAliasList(): Promise<RichMenuAliasListResponse>;
    /**
     * Get list of rich menu alias
     * Calls `GET https://api.line.me/v2/bot/richmenu/alias/list`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-alias-list">LINE Developers documentation</a>
     */
    getRichMenuAliasListWithHttpInfo(): Promise<Types.ApiResponseType<RichMenuAliasListResponse>>;
    /**
     * Get the status of Replace or unlink a linked rich menus in batches.
     * Calls `GET https://api.line.me/v2/bot/richmenu/progress/batch`.
     * To inspect the HTTP status code or response headers, use {@link getRichMenuBatchProgressWithHttpInfo}.
     * @param requestId A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-batch-control-rich-menus-progress-status">LINE Developers documentation</a>
     */
    getRichMenuBatchProgress(requestId: string): Promise<RichMenuBatchProgressResponse>;
    /**
     * Get the status of Replace or unlink a linked rich menus in batches.
     * Calls `GET https://api.line.me/v2/bot/richmenu/progress/batch`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param requestId A request ID used to batch control the rich menu linked to the user. Each Messaging API request has a request ID.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-batch-control-rich-menus-progress-status">LINE Developers documentation</a>
     */
    getRichMenuBatchProgressWithHttpInfo(requestId: string): Promise<Types.ApiResponseType<RichMenuBatchProgressResponse>>;
    /**
     * Get rich menu ID of user
     * Calls `GET https://api.line.me/v2/bot/user/{userId}/richmenu`.
     * To inspect the HTTP status code or response headers, use {@link getRichMenuIdOfUserWithHttpInfo}.
     * @param userId User ID. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-id-of-user">LINE Developers documentation</a>
     */
    getRichMenuIdOfUser(userId: string): Promise<RichMenuIdResponse>;
    /**
     * Get rich menu ID of user
     * Calls `GET https://api.line.me/v2/bot/user/{userId}/richmenu`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param userId User ID. Found in the `source` object of webhook event objects. Do not use the LINE ID used in LINE.
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-id-of-user">LINE Developers documentation</a>
     */
    getRichMenuIdOfUserWithHttpInfo(userId: string): Promise<Types.ApiResponseType<RichMenuIdResponse>>;
    /**
     * Get rich menu list
     * Calls `GET https://api.line.me/v2/bot/richmenu/list`.
     * To inspect the HTTP status code or response headers, use {@link getRichMenuListWithHttpInfo}.
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-rich-menu-list">LINE Developers documentation</a>
     */
    getRichMenuList(): Promise<RichMenuListResponse>;
    /**
     * Get rich menu list
     * Calls `GET https://api.line.me/v2/bot/richmenu/list