@line/bot-sdk/dist/module/api/lineModuleClient.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 { AcquireChatControlRequest } from "../model/acquireChatControlRequest.js";
import { DetachModuleRequest } from "../model/detachModuleRequest.js";
import { GetModulesResponse } from "../model/getModulesResponse.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 LineModuleClient {
    private httpClient;
    /**
     * Initializes a new `LineModuleClient`.
     *
     * @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 LineModuleClient({
     *   channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!,
     * });
     */
    constructor(config: httpClientConfig);
    /**
     * If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel.
     * Calls `POST https://api.line.me/v2/bot/chat/{chatId}/control/acquire`.
     * To inspect the HTTP status code or response headers, use {@link acquireChatControlWithHttpInfo}.
     * @param chatId The `userId`, `roomId`, or `groupId`
     * @param acquireChatControlRequest
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/partner-docs/#acquire-control-api">LINE Developers documentation</a>
     */
    acquireChatControl(chatId: string, acquireChatControlRequest?: AcquireChatControlRequest): Promise<Types.MessageAPIResponseBase>;
    /**
     * If the Standby Channel wants to take the initiative (Chat Control), it calls the Acquire Control API. The channel that was previously an Active Channel will automatically switch to a Standby Channel.
     * Calls `POST https://api.line.me/v2/bot/chat/{chatId}/control/acquire`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param chatId The `userId`, `roomId`, or `groupId`
     * @param acquireChatControlRequest
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/partner-docs/#acquire-control-api">LINE Developers documentation</a>
     */
    acquireChatControlWithHttpInfo(chatId: string, acquireChatControlRequest?: AcquireChatControlRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
    /**
     * The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.
     * Calls `POST https://api.line.me/v2/bot/channel/detach`.
     * To inspect the HTTP status code or response headers, use {@link detachModuleWithHttpInfo}.
     * @param detachModuleRequest
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/partner-docs/#unlink-detach-module-channel-by-operation-mc-admin">LINE Developers documentation</a>
     */
    detachModule(detachModuleRequest?: DetachModuleRequest): Promise<Types.MessageAPIResponseBase>;
    /**
     * The module channel admin calls the Detach API to detach the module channel from a LINE Official Account.
     * Calls `POST https://api.line.me/v2/bot/channel/detach`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param detachModuleRequest
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/partner-docs/#unlink-detach-module-channel-by-operation-mc-admin">LINE Developers documentation</a>
     */
    detachModuleWithHttpInfo(detachModuleRequest?: DetachModuleRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
    /**
     * Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.
     * Calls `GET https://api.line.me/v2/bot/list`.
     * To inspect the HTTP status code or response headers, use {@link getModulesWithHttpInfo}.
     * @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 basic information about the bots in one request, include this parameter to get the remaining array.
     * @param limit Specify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/partner-docs/#get-multiple-bot-info-api">LINE Developers documentation</a>
     */
    getModules(start?: string, limit?: number): Promise<GetModulesResponse>;
    /**
     * Gets a list of basic information about the bots of multiple LINE Official Accounts that have attached module channels.
     * Calls `GET https://api.line.me/v2/bot/list`.
     * 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. If you can't get all basic information about the bots in one request, include this parameter to get the remaining array.
     * @param limit Specify the maximum number of bots that you get basic information from. The default value is 100. Max value: 100
     * @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-multiple-bot-info-api">LINE Developers documentation</a>
     */
    getModulesWithHttpInfo(start?: string, limit?: number): Promise<Types.ApiResponseType<GetModulesResponse>>;
    /**
     * To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API.
     * Calls `POST https://api.line.me/v2/bot/chat/{chatId}/control/release`.
     * To inspect the HTTP status code or response headers, use {@link releaseChatControlWithHttpInfo}.
     * @param chatId The `userId`, `roomId`, or `groupId`
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/partner-docs/#release-control-api">LINE Developers documentation</a>
     */
    releaseChatControl(chatId: string): Promise<Types.MessageAPIResponseBase>;
    /**
     * To return the initiative (Chat Control) of Active Channel to Primary Channel, call the Release Control API.
     * Calls `POST https://api.line.me/v2/bot/chat/{chatId}/control/release`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @param chatId The `userId`, `roomId`, or `groupId`
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/partner-docs/#release-control-api">LINE Developers documentation</a>
     */
    releaseChatControlWithHttpInfo(chatId: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
}
export {};
//# sourceMappingURL=lineModuleClient.d.ts.map