@line/bot-sdk
Version:
Node.js SDK for LINE Messaging API
775 lines • 102 kB
TypeScript
/**
* This file is autogenerated.
*
* Generated by scripts/line-bot-client-generator/main.mjs
* Do not edit this file directly.
*/
import type { Readable } from "node:stream";
import type * as Types from "./types.js";
import type * as insight from "./insight/api.js";
import type * as liff from "./liff/api.js";
import type * as manageAudience from "./manage-audience/api.js";
import type * as messagingApi from "./messaging-api/api.js";
import type * as moduleOperation from "./module/api.js";
import type * as moduleAttach from "./module-attach/api.js";
import type * as shop from "./shop/api.js";
export interface LineBotClientDelegates {
readonly insight: insight.InsightClient;
readonly liff: liff.LiffClient;
readonly manageAudience: manageAudience.ManageAudienceClient;
readonly manageAudienceBlob: manageAudience.ManageAudienceBlobClient;
readonly messagingApi: messagingApi.MessagingApiClient;
readonly messagingApiBlob: messagingApi.MessagingApiBlobClient;
readonly lineModule: moduleOperation.LineModuleClient;
readonly lineModuleAttach: moduleAttach.LineModuleAttachClient;
readonly shop: shop.ShopClient;
}
export declare abstract class LineBotClientBase {
protected abstract readonly clients: LineBotClientDelegates;
/**
* Retrieves the demographic attributes for a LINE Official Account\'s friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID).
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-demographic"> Documentation</a>
*/
getFriendsDemographics(): Promise<insight.GetFriendsDemographicsResponse>;
/**
* Retrieves the demographic attributes for a LINE Official Account\'s friends.You can only retrieve information about friends for LINE Official Accounts created by users in Japan (JP), Thailand (TH), Taiwan (TW) and Indonesia (ID). .
* This method includes HttpInfo object to return additional information.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-demographic"> Documentation</a>
*/
getFriendsDemographicsWithHttpInfo(): Promise<Types.ApiResponseType<insight.GetFriendsDemographicsResponse>>;
/**
* Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account.
* @summary Get user interaction statistics
* @param requestId Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-message-event">Get user interaction statistics Documentation</a>
*/
getMessageEvent(requestId: string): Promise<insight.GetMessageEventResponse>;
/**
* Returns statistics about how users interact with narrowcast messages or broadcast messages sent from your LINE Official Account. .
* This method includes HttpInfo object to return additional information.
* @summary Get user interaction statistics
* @param requestId Request ID of a narrowcast message or broadcast message. Each Messaging API request has a request ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-message-event">Get user interaction statistics Documentation</a>
*/
getMessageEventWithHttpInfo(requestId: string): Promise<Types.ApiResponseType<insight.GetMessageEventResponse>>;
/**
* Returns the number of users who have added the LINE Official Account on or before a specified date.
* @summary Get number of followers
* @param date Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers">Get number of followers Documentation</a>
*/
getNumberOfFollowers(date?: string): Promise<insight.GetNumberOfFollowersResponse>;
/**
* Returns the number of users who have added the LINE Official Account on or before a specified date. .
* This method includes HttpInfo object to return additional information.
* @summary Get number of followers
* @param date Date for which to retrieve the number of followers. Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-followers">Get number of followers Documentation</a>
*/
getNumberOfFollowersWithHttpInfo(date?: string): Promise<Types.ApiResponseType<insight.GetNumberOfFollowersResponse>>;
/**
* Returns the number of messages sent from LINE Official Account on a specified day.
* @summary Get number of message deliveries
* @param date Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">Get number of message deliveries Documentation</a>
*/
getNumberOfMessageDeliveries(date: string): Promise<insight.GetNumberOfMessageDeliveriesResponse>;
/**
* Returns the number of messages sent from LINE Official Account on a specified day. .
* This method includes HttpInfo object to return additional information.
* @summary Get number of message deliveries
* @param date Date for which to retrieve number of sent messages. - Format: yyyyMMdd (e.g. 20191231) - Timezone: UTC+9
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-delivery-messages">Get number of message deliveries Documentation</a>
*/
getNumberOfMessageDeliveriesWithHttpInfo(date: string): Promise<Types.ApiResponseType<insight.GetNumberOfMessageDeliveriesResponse>>;
/**
* You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account.
* @param customAggregationUnit Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names.
* @param from Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
* @param to End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit"> Documentation</a>
*/
getStatisticsPerUnit(customAggregationUnit: string, from: string, to: string): Promise<insight.GetStatisticsPerUnitResponse>;
/**
* You can check the per-unit statistics of how users interact with push messages and multicast messages sent from your LINE Official Account. .
* This method includes HttpInfo object to return additional information.
* @param customAggregationUnit Name of aggregation unit specified when sending the message. Case-sensitive. For example, `Promotion_a` and `Promotion_A` are regarded as different unit names.
* @param from Start date of aggregation period. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
* @param to End date of aggregation period. The end date can be specified for up to 30 days later. For example, if the start date is 20210301, the latest end date is 20210331. Format: yyyyMMdd (e.g. 20210301) Time zone: UTC+9
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-statistics-per-unit"> Documentation</a>
*/
getStatisticsPerUnitWithHttpInfo(customAggregationUnit: string, from: string, to: string): Promise<Types.ApiResponseType<insight.GetStatisticsPerUnitResponse>>;
/**
* Adding the LIFF app to a channel
* @summary Create LIFF app
* @param addLiffAppRequest
*
* @see <a href="https://developers.line.biz/en/reference/liff-server/#add-liff-app">Create LIFF app Documentation</a>
*/
addLIFFApp(addLiffAppRequest: liff.AddLiffAppRequest): Promise<liff.AddLiffAppResponse>;
/**
* Adding the LIFF app to a channel.
* This method includes HttpInfo object to return additional information.
* @summary Create LIFF app
* @param addLiffAppRequest
*
* @see <a href="https://developers.line.biz/en/reference/liff-server/#add-liff-app">Create LIFF app Documentation</a>
*/
addLIFFAppWithHttpInfo(addLiffAppRequest: liff.AddLiffAppRequest): Promise<Types.ApiResponseType<liff.AddLiffAppResponse>>;
/**
* Deletes a LIFF app from a channel.
* @summary Delete LIFF app from a channel
* @param liffId ID of the LIFF app to be updated
*
* @see <a href="https://developers.line.biz/en/reference/liff-server/#delete-liff-app">Delete LIFF app from a channel Documentation</a>
*/
deleteLIFFApp(liffId: string): Promise<Types.MessageAPIResponseBase>;
/**
* Deletes a LIFF app from a channel. .
* This method includes HttpInfo object to return additional information.
* @summary Delete LIFF app from a channel
* @param liffId ID of the LIFF app to be updated
*
* @see <a href="https://developers.line.biz/en/reference/liff-server/#delete-liff-app">Delete LIFF app from a channel Documentation</a>
*/
deleteLIFFAppWithHttpInfo(liffId: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Gets information on all the LIFF apps added to the channel.
* @summary Get all LIFF apps
*
* @see <a href="https://developers.line.biz/en/reference/liff-server/#get-all-liff-apps">Get all LIFF apps Documentation</a>
*/
getAllLIFFApps(): Promise<liff.GetAllLiffAppsResponse>;
/**
* Gets information on all the LIFF apps added to the channel..
* This method includes HttpInfo object to return additional information.
* @summary Get all LIFF apps
*
* @see <a href="https://developers.line.biz/en/reference/liff-server/#get-all-liff-apps">Get all LIFF apps Documentation</a>
*/
getAllLIFFAppsWithHttpInfo(): Promise<Types.ApiResponseType<liff.GetAllLiffAppsResponse>>;
/**
* Update LIFF app settings
* @summary Update LIFF app from a channel
* @param liffId ID of the LIFF app to be updated
* @param updateLiffAppRequest
*
* @see <a href="https://developers.line.biz/en/reference/liff-server/#update-liff-app">Update LIFF app from a channel Documentation</a>
*/
updateLIFFApp(liffId: string, updateLiffAppRequest: liff.UpdateLiffAppRequest): Promise<Types.MessageAPIResponseBase>;
/**
* Update LIFF app settings.
* This method includes HttpInfo object to return additional information.
* @summary Update LIFF app from a channel
* @param liffId ID of the LIFF app to be updated
* @param updateLiffAppRequest
*
* @see <a href="https://developers.line.biz/en/reference/liff-server/#update-liff-app">Update LIFF app from a channel Documentation</a>
*/
updateLIFFAppWithHttpInfo(liffId: string, updateLiffAppRequest: liff.UpdateLiffAppRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
* @param addAudienceToAudienceGroupRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group"> Documentation</a>
*/
addAudienceToAudienceGroup(addAudienceToAudienceGroupRequest: manageAudience.AddAudienceToAudienceGroupRequest): Promise<Types.MessageAPIResponseBase>;
/**
* Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON).
* This method includes HttpInfo object to return additional information.
* @param addAudienceToAudienceGroupRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group"> Documentation</a>
*/
addAudienceToAudienceGroupWithHttpInfo(addAudienceToAudienceGroupRequest: manageAudience.AddAudienceToAudienceGroupRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Create audience for uploading user IDs (by JSON)
* @param createAudienceGroupRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group"> Documentation</a>
*/
createAudienceGroup(createAudienceGroupRequest: manageAudience.CreateAudienceGroupRequest): Promise<manageAudience.CreateAudienceGroupResponse>;
/**
* Create audience for uploading user IDs (by JSON).
* This method includes HttpInfo object to return additional information.
* @param createAudienceGroupRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group"> Documentation</a>
*/
createAudienceGroupWithHttpInfo(createAudienceGroupRequest: manageAudience.CreateAudienceGroupRequest): Promise<Types.ApiResponseType<manageAudience.CreateAudienceGroupResponse>>;
/**
* Create audience for click-based retargeting
* @param createClickBasedAudienceGroupRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group"> Documentation</a>
*/
createClickBasedAudienceGroup(createClickBasedAudienceGroupRequest: manageAudience.CreateClickBasedAudienceGroupRequest): Promise<manageAudience.CreateClickBasedAudienceGroupResponse>;
/**
* Create audience for click-based retargeting.
* This method includes HttpInfo object to return additional information.
* @param createClickBasedAudienceGroupRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group"> Documentation</a>
*/
createClickBasedAudienceGroupWithHttpInfo(createClickBasedAudienceGroupRequest: manageAudience.CreateClickBasedAudienceGroupRequest): Promise<Types.ApiResponseType<manageAudience.CreateClickBasedAudienceGroupResponse>>;
/**
* Create audience for impression-based retargeting
* @param createImpBasedAudienceGroupRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group"> Documentation</a>
*/
createImpBasedAudienceGroup(createImpBasedAudienceGroupRequest: manageAudience.CreateImpBasedAudienceGroupRequest): Promise<manageAudience.CreateImpBasedAudienceGroupResponse>;
/**
* Create audience for impression-based retargeting.
* This method includes HttpInfo object to return additional information.
* @param createImpBasedAudienceGroupRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group"> Documentation</a>
*/
createImpBasedAudienceGroupWithHttpInfo(createImpBasedAudienceGroupRequest: manageAudience.CreateImpBasedAudienceGroupRequest): Promise<Types.ApiResponseType<manageAudience.CreateImpBasedAudienceGroupResponse>>;
/**
* Delete audience
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-audience-group"> Documentation</a>
*/
deleteAudienceGroup(audienceGroupId: number): Promise<Types.MessageAPIResponseBase>;
/**
* Delete audience.
* This method includes HttpInfo object to return additional information.
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-audience-group"> Documentation</a>
*/
deleteAudienceGroupWithHttpInfo(audienceGroupId: number): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Gets audience data.
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-group"> Documentation</a>
*/
getAudienceData(audienceGroupId: number): Promise<manageAudience.GetAudienceDataResponse>;
/**
* Gets audience data..
* This method includes HttpInfo object to return additional information.
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-group"> Documentation</a>
*/
getAudienceDataWithHttpInfo(audienceGroupId: number): Promise<Types.ApiResponseType<manageAudience.GetAudienceDataResponse>>;
/**
* Gets data for more than one audience.
* @param page The page to return when getting (paginated) results. Must be 1 or higher.
* @param description The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
* @param status The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
* @param size The number of audiences per page. Default: 20 Max: 40
* @param includesExternalPublicGroups true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
* @param createRoute How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups"> Documentation</a>
*/
getAudienceGroups(page: number, description?: string, status?: manageAudience.AudienceGroupStatus, size?: number, includesExternalPublicGroups?: boolean, createRoute?: manageAudience.AudienceGroupCreateRoute): Promise<manageAudience.GetAudienceGroupsResponse>;
/**
* Gets data for more than one audience..
* This method includes HttpInfo object to return additional information.
* @param page The page to return when getting (paginated) results. Must be 1 or higher.
* @param description The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
* @param status The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
* @param size The number of audiences per page. Default: 20 Max: 40
* @param includesExternalPublicGroups true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
* @param createRoute How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups"> Documentation</a>
*/
getAudienceGroupsWithHttpInfo(page: number, description?: string, status?: manageAudience.AudienceGroupStatus, size?: number, includesExternalPublicGroups?: boolean, createRoute?: manageAudience.AudienceGroupCreateRoute): Promise<Types.ApiResponseType<manageAudience.GetAudienceGroupsResponse>>;
/**
* Gets audience data.
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-shared-audience"> Documentation</a>
*/
getSharedAudienceData(audienceGroupId: number): Promise<manageAudience.GetSharedAudienceDataResponse>;
/**
* Gets audience data..
* This method includes HttpInfo object to return additional information.
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-shared-audience"> Documentation</a>
*/
getSharedAudienceDataWithHttpInfo(audienceGroupId: number): Promise<Types.ApiResponseType<manageAudience.GetSharedAudienceDataResponse>>;
/**
* Gets data for more than one audience, including those shared by the Business Manager.
* @param page The page to return when getting (paginated) results. Must be 1 or higher.
* @param description The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
* @param status The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
* @param size The number of audiences per page. Default: 20 Max: 40
* @param createRoute How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API.
* @param includesOwnedAudienceGroups true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-shared-audience-list"> Documentation</a>
*/
getSharedAudienceGroups(page: number, description?: string, status?: manageAudience.AudienceGroupStatus, size?: number, createRoute?: manageAudience.AudienceGroupCreateRoute, includesOwnedAudienceGroups?: boolean): Promise<manageAudience.GetSharedAudienceGroupsResponse>;
/**
* Gets data for more than one audience, including those shared by the Business Manager..
* This method includes HttpInfo object to return additional information.
* @param page The page to return when getting (paginated) results. Must be 1 or higher.
* @param description The name of the audience(s) to return. You can search for partial matches. This is case-insensitive, meaning AUDIENCE and audience are considered identical. If omitted, the name of the audience(s) will not be used as a search criterion.
* @param status The status of the audience(s) to return. If omitted, the status of the audience(s) will not be used as a search criterion.
* @param size The number of audiences per page. Default: 20 Max: 40
* @param createRoute How the audience was created. If omitted, all audiences are included. `OA_MANAGER`: Return only audiences created with LINE Official Account Manager (opens new window). `MESSAGING_API`: Return only audiences created with Messaging API.
* @param includesOwnedAudienceGroups true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-shared-audience-list"> Documentation</a>
*/
getSharedAudienceGroupsWithHttpInfo(page: number, description?: string, status?: manageAudience.AudienceGroupStatus, size?: number, createRoute?: manageAudience.AudienceGroupCreateRoute, includesOwnedAudienceGroups?: boolean): Promise<Types.ApiResponseType<manageAudience.GetSharedAudienceGroupsResponse>>;
/**
* Renames an existing audience.
* @param audienceGroupId The audience ID.
* @param updateAudienceGroupDescriptionRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#set-description-audience-group"> Documentation</a>
*/
updateAudienceGroupDescription(audienceGroupId: number, updateAudienceGroupDescriptionRequest: manageAudience.UpdateAudienceGroupDescriptionRequest): Promise<Types.MessageAPIResponseBase>;
/**
* Renames an existing audience..
* This method includes HttpInfo object to return additional information.
* @param audienceGroupId The audience ID.
* @param updateAudienceGroupDescriptionRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#set-description-audience-group"> Documentation</a>
*/
updateAudienceGroupDescriptionWithHttpInfo(audienceGroupId: number, updateAudienceGroupDescriptionRequest: manageAudience.UpdateAudienceGroupDescriptionRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).
* @param file A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
* @param audienceGroupId The audience ID.
* @param uploadDescription The description to register with the job
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group-by-file"> Documentation</a>
*/
addUserIdsToAudience(file: Blob, audienceGroupId?: number, uploadDescription?: string): Promise<Types.MessageAPIResponseBase>;
/**
* Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file)..
* This method includes HttpInfo object to return additional information.
* @param file A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
* @param audienceGroupId The audience ID.
* @param uploadDescription The description to register with the job
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group-by-file"> Documentation</a>
*/
addUserIdsToAudienceWithHttpInfo(file: Blob, audienceGroupId?: number, uploadDescription?: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Create audience for uploading user IDs (by file).
* @param file A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
* @param description The audience\\\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
* @param isIfaAudience To specify recipients by IFAs: set `true`. To specify recipients by user IDs: set `false` or omit isIfaAudience property.
* @param uploadDescription The description to register for the job (in `jobs[].description`).
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group-by-file"> Documentation</a>
*/
createAudienceForUploadingUserIds(file: Blob, description?: string, isIfaAudience?: boolean, uploadDescription?: string): Promise<manageAudience.CreateAudienceGroupResponse>;
/**
* Create audience for uploading user IDs (by file)..
* This method includes HttpInfo object to return additional information.
* @param file A text file with one user ID or IFA entered per line. Specify text/plain as Content-Type. Max file number: 1 Max number: 1,500,000
* @param description The audience\\\'s name. This is case-insensitive, meaning AUDIENCE and audience are considered identical. Max character limit: 120
* @param isIfaAudience To specify recipients by IFAs: set `true`. To specify recipients by user IDs: set `false` or omit isIfaAudience property.
* @param uploadDescription The description to register for the job (in `jobs[].description`).
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group-by-file"> Documentation</a>
*/
createAudienceForUploadingUserIdsWithHttpInfo(file: Blob, description?: string, isIfaAudience?: boolean, uploadDescription?: string): Promise<Types.ApiResponseType<manageAudience.CreateAudienceGroupResponse>>;
/**
* Sends a message to multiple users at any time.
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message"> Documentation</a>
*/
broadcast(broadcastRequest: messagingApi.BroadcastRequest, xLineRetryKey?: string): Promise<object>;
/**
* Sends a message to multiple users at any time..
* This method includes HttpInfo object to return additional information.
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-broadcast-message"> Documentation</a>
*/
broadcastWithHttpInfo(broadcastRequest: messagingApi.BroadcastRequest, xLineRetryKey?: string): Promise<Types.ApiResponseType<object>>;
/**
* Cancel default rich menu
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#cancel-default-rich-menu"> Documentation</a>
*/
cancelDefaultRichMenu(): Promise<Types.MessageAPIResponseBase>;
/**
* Cancel default rich menu.
* This method includes HttpInfo object to return additional information.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#cancel-default-rich-menu"> Documentation</a>
*/
cancelDefaultRichMenuWithHttpInfo(): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Close coupon
* @param couponId
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#discontinue-coupon"> Documentation</a>
*/
closeCoupon(couponId: string): Promise<Types.MessageAPIResponseBase>;
/**
* Close coupon.
* This method includes HttpInfo object to return additional information.
* @param couponId
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#discontinue-coupon"> Documentation</a>
*/
closeCouponWithHttpInfo(couponId: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Create a new coupon. Define coupon details such as type, title, and validity period.
* @param couponCreateRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-coupon"> Documentation</a>
*/
createCoupon(couponCreateRequest?: messagingApi.CouponCreateRequest): Promise<messagingApi.CouponCreateResponse>;
/**
* Create a new coupon. Define coupon details such as type, title, and validity period..
* This method includes HttpInfo object to return additional information.
* @param couponCreateRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-coupon"> Documentation</a>
*/
createCouponWithHttpInfo(couponCreateRequest?: messagingApi.CouponCreateRequest): Promise<Types.ApiResponseType<messagingApi.CouponCreateResponse>>;
/**
* Create rich menu
* @param richMenuRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-rich-menu"> Documentation</a>
*/
createRichMenu(richMenuRequest: messagingApi.RichMenuRequest): Promise<messagingApi.RichMenuIdResponse>;
/**
* Create rich menu.
* This method includes HttpInfo object to return additional information.
* @param richMenuRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-rich-menu"> Documentation</a>
*/
createRichMenuWithHttpInfo(richMenuRequest: messagingApi.RichMenuRequest): Promise<Types.ApiResponseType<messagingApi.RichMenuIdResponse>>;
/**
* Create rich menu alias
* @param createRichMenuAliasRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-rich-menu-alias"> Documentation</a>
*/
createRichMenuAlias(createRichMenuAliasRequest: messagingApi.CreateRichMenuAliasRequest): Promise<Types.MessageAPIResponseBase>;
/**
* Create rich menu alias.
* This method includes HttpInfo object to return additional information.
* @param createRichMenuAliasRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-rich-menu-alias"> Documentation</a>
*/
createRichMenuAliasWithHttpInfo(createRichMenuAliasRequest: messagingApi.CreateRichMenuAliasRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Deletes a rich menu.
* @param richMenuId ID of a rich menu
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu"> Documentation</a>
*/
deleteRichMenu(richMenuId: string): Promise<Types.MessageAPIResponseBase>;
/**
* Deletes a rich menu..
* This method includes HttpInfo object to return additional information.
* @param richMenuId ID of a rich menu
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu"> Documentation</a>
*/
deleteRichMenuWithHttpInfo(richMenuId: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Delete rich menu alias
* @param richMenuAliasId Rich menu alias ID that you want to delete.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu-alias"> Documentation</a>
*/
deleteRichMenuAlias(richMenuAliasId: string): Promise<Types.MessageAPIResponseBase>;
/**
* Delete rich menu alias.
* This method includes HttpInfo object to return additional information.
* @param richMenuAliasId Rich menu alias ID that you want to delete.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-rich-menu-alias"> Documentation</a>
*/
deleteRichMenuAliasWithHttpInfo(richMenuAliasId: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
/**
* Get name list of units used this month
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-name-list-of-units-used-this-month"> Documentation</a>
*/
getAggregationUnitNameList(limit?: string, start?: string): Promise<messagingApi.GetAggregationUnitNameListResponse>;
/**
* Get name list of units used this month.
* This method includes HttpInfo object to return additional information.
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-name-list-of-units-used-this-month"> Documentation</a>
*/
getAggregationUnitNameListWithHttpInfo(limit?: string, start?: string): Promise<Types.ApiResponseType<messagingApi.GetAggregationUnitNameListResponse>>;
/**
* Get number of units used this month
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-units-used-this-month"> Documentation</a>
*/
getAggregationUnitUsage(): Promise<messagingApi.GetAggregationUnitUsageResponse>;
/**
* Get number of units used this month.
* This method includes HttpInfo object to return additional information.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-units-used-this-month"> Documentation</a>
*/
getAggregationUnitUsageWithHttpInfo(): Promise<Types.ApiResponseType<messagingApi.GetAggregationUnitUsageResponse>>;
/**
* Get bot info
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-bot-info"> Documentation</a>
*/
getBotInfo(): Promise<messagingApi.BotInfoResponse>;
/**
* Get bot info.
* This method includes HttpInfo object to return additional information.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-bot-info"> Documentation</a>
*/
getBotInfoWithHttpInfo(): Promise<Types.ApiResponseType<messagingApi.BotInfoResponse>>;
/**
* Get coupon detail
* @param couponId
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupon"> Documentation</a>
*/
getCouponDetail(couponId: string): Promise<messagingApi.CouponResponse>;
/**
* Get coupon detail.
* This method includes HttpInfo object to return additional information.
* @param couponId
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-coupon"> Documentation</a>
*/
getCouponDetailWithHttpInfo(couponId: string): Promise<Types.ApiResponseType<messagingApi.CouponResponse>>;
/**
* Gets the ID of the default rich menu set with the Messaging API.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-default-rich-menu-id"> Documentation</a>
*/
getDefaultRichMenuId(): Promise<messagingApi.RichMenuIdResponse>;
/**
* Gets the ID of the default rich menu set with the Messaging API..
* This method includes HttpInfo object to return additional information.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-default-rich-menu-id"> Documentation</a>
*/
getDefaultRichMenuIdWithHttpInfo(): Promise<Types.ApiResponseType<messagingApi.RichMenuIdResponse>>;
/**
* Get a list of users who added your LINE Official Account as a friend
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-follower-ids"> Documentation</a>
*/
getFollowers(start?: string, limit?: number): Promise<messagingApi.GetFollowersResponse>;
/**
* Get a list of users who added your LINE Official Account as a friend.
* This method includes HttpInfo object to return additional information.
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-follower-ids"> Documentation</a>
*/
getFollowersWithHttpInfo(start?: string, limit?: number): Promise<Types.ApiResponseType<messagingApi.GetFollowersResponse>>;
/**
* Get number of users in a group chat
* @param groupId Group ID
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-members-group-count"> Documentation</a>
*/
getGroupMemberCount(groupId: string): Promise<messagingApi.GroupMemberCountResponse>;
/**
* Get number of users in a group chat.
* This method includes HttpInfo object to return additional information.
* @param groupId Group ID
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-members-group-count"> Documentation</a>
*/
getGroupMemberCountWithHttpInfo(groupId: string): Promise<Types.ApiResponseType<messagingApi.GroupMemberCountResponse>>;
/**
* Get group chat member profile
* @param groupId Group ID
* @param userId User ID
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-member-profile"> Documentation</a>
*/
getGroupMemberProfile(groupId: string, userId: string): Promise<messagingApi.GroupUserProfileResponse>;
/**
* Get group chat member profile.
* This method includes HttpInfo object to return additional information.
* @param groupId Group ID
* @param userId User ID
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-member-profile"> Documentation</a>
*/
getGroupMemberProfileWithHttpInfo(groupId: string, userId: string): Promise<Types.ApiResponseType<messagingApi.GroupUserProfileResponse>>;
/**
* Get group chat member user IDs
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-member-user-ids"> Documentation</a>
*/
getGroupMembersIds(groupId: string, start?: string): Promise<messagingApi.MembersIdsResponse>;
/**
* Get group chat member user IDs.
* This method includes HttpInfo object to return additional information.
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-member-user-ids"> Documentation</a>
*/
getGroupMembersIdsWithHttpInfo(groupId: string, start?: string): Promise<Types.ApiResponseType<messagingApi.MembersIdsResponse>>;
/**
* Get group chat summary
* @param groupId Group ID
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-summary"> Documentation</a>
*/
getGroupSummary(groupId: string): Promise<messagingApi.GroupSummaryResponse>;
/**
* Get group chat summary.
* This method includes HttpInfo object to return additional information.
* @param groupId Group ID
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-group-summary"> Documentation</a>
*/
getGroupSummaryWithHttpInfo(groupId: string): Promise<Types.ApiResponseType<messagingApi.GroupSummaryResponse>>;
/**
* Get a list of user IDs who joined the membership.
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-user-ids"> Documentation</a>
*/
getJoinedMembershipUsers(membershipId: number, start?: string, limit?: number): Promise<messagingApi.GetJoinedMembershipUsersResponse>;
/**
* Get a list of user IDs who joined the membership..
* This method includes HttpInfo object to return additional information.
* @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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-user-ids"> Documentation</a>
*/
getJoinedMembershipUsersWithHttpInfo(membershipId: number, start?: string, limit?: number): Promise<Types.ApiResponseType<messagingApi.GetJoinedMembershipUsersResponse>>;
/**
* Get a list of memberships.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-plans"> Documentation</a>
*/
getMembershipList(): Promise<messagingApi.MembershipListResponse>;
/**
* Get a list of memberships..
* This method includes HttpInfo object to return additional information.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-plans"> Documentation</a>
*/
getMembershipListWithHttpInfo(): Promise<Types.ApiResponseType<messagingApi.MembershipListResponse>>;
/**
* Get a user\'s membership subscription.
* @param userId User ID
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status"> Documentation</a>
*/
getMembershipSubscription(userId: string): Promise<messagingApi.GetMembershipSubscriptionResponse>;
/**
* Get a user\'s membership subscription..
* This method includes HttpInfo object to return additional information.
* @param userId User ID
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status"> Documentation</a>
*/
getMembershipSubscriptionWithHttpInfo(userId: string): Promise<Types.ApiResponseType<messagingApi.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.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-quota"> Documentation</a>
*/
getMessageQuota(): Promise<messagingApi.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..
* This method includes HttpInfo object to return additional information.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-quota"> Documentation</a>
*/
getMessageQuotaWithHttpInfo(): Promise<Types.ApiResponseType<messagingApi.MessageQuotaResponse>>;
/**
* Gets the number of messages sent in the current month.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-consumption"> Documentation</a>
*/
getMessageQuotaConsumption(): Promise<messagingApi.QuotaConsumptionResponse>;
/**
* Gets the number of messages sent in the current month..
* This method includes HttpInfo object to return additional information.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-consumption"> Documentation</a>
*/
getMessageQuotaConsumptionWithHttpInfo(): Promise<Types.ApiResponseType<messagingApi.QuotaConsumptionResponse>>;
/**
* Gets the status of a narrowcast message.
* @param requestId The narrowcast message\'s request ID. Each Messaging API request has a request ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status"> Documentation</a>
*/
getNarrowcastProgress(requestId: string): Promise<messagingApi.NarrowcastProgressResponse>;
/**
* Gets the status of a narrowcast message..
* This method includes HttpInfo object to return additional information.
* @param requestId The narrowcast message\'s request ID. Each Messaging API request has a request ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-narrowcast-progress-status"> Documentation</a>
*/
getNarrowcastProgressWithHttpInfo(requestId: string): Promise<Types.ApiResponseType<messagingApi.NarrowcastProgressResponse>>;
/**
* Get number of sent broadcast messages
* @param date Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-broadcast-messages"> Documentation</a>
*/
getNumberOfSentBroadcastMessages(date: string): Promise<messagingApi.NumberOfMessagesResponse>;
/**
* Get number of sent broadcast messages.
* This method includes HttpInfo object to return additional information.
* @param date Date the messages were sent Format: yyyyMMdd (e.g. 20191231) Timezone: UTC+9
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-broadcast-messages"> Documentation</a>
*/
getNumberOfSentBroadcastMessagesWithHttpInfo(date: string): Promise<Types.ApiResponseType<messagingApi.NumberOfMessagesResponse>>;
/**
* Get number of sent multicast messages
* @param date Date the messages were sent Format: `yyyyMMdd` (e.g. `20191231`) Timezone: UTC+9
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-number-of-multicast-messages"> Documentation</a>
*/
getNumberOfSentMulticastMessages(date: string): Promise<messagingApi.NumberOfMessagesResponse>;
/**
* Get