@line/bot-sdk/dist/manage-audience/api/manageAudienceBlobClient.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 { CreateAudienceGroupResponse } from "../model/createAudienceGroupResponse.js";
import * as Types from "../../types.js";
interface httpClientConfig {
    /**
     * Base URL for requests.
     * Defaults to 'https://api-data.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 ManageAudienceBlobClient {
    private httpClient;
    /**
     * Initializes a new `ManageAudienceBlobClient`.
     *
     * @param config Configuration for this API client.
     * @param config.baseURL The base URL for requests. Defaults to `https://api-data.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 ManageAudienceBlobClient({
     *   channelAccessToken: process.env.LINE_CHANNEL_ACCESS_TOKEN!,
     * });
     */
    constructor(config: httpClientConfig);
    /**
     * Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by file).
     * Calls `PUT https://api-data.line.me/v2/bot/audienceGroup/upload/byFile`.
     * To inspect the HTTP status code or response headers, use {@link addUserIdsToAudienceWithHttpInfo}.
     * @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
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group-by-file">LINE Developers 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).
     * Calls `PUT https://api-data.line.me/v2/bot/audienceGroup/upload/byFile`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @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
     * @returns A promise resolving to the response body together with the underlying `httpResponse`.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group-by-file">LINE Developers documentation</a>
     */
    addUserIdsToAudienceWithHttpInfo(file: Blob, audienceGroupId?: number, uploadDescription?: string): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
    /**
     * Create audience for uploading user IDs (by file).
     * Calls `POST https://api-data.line.me/v2/bot/audienceGroup/upload/byFile`.
     * To inspect the HTTP status code or response headers, use {@link createAudienceForUploadingUserIdsWithHttpInfo}.
     * @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`).
     * @returns A promise resolving to the response body.
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group-by-file">LINE Developers documentation</a>
     */
    createAudienceForUploadingUserIds(file: Blob, description?: string, isIfaAudience?: boolean, uploadDescription?: string): Promise<CreateAudienceGroupResponse>;
    /**
     * Create audience for uploading user IDs (by file).
     * Calls `POST https://api-data.line.me/v2/bot/audienceGroup/upload/byFile`.
     * This method returns the response body together with the underlying `httpResponse`.
     * @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`).
     * @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-upload-audience-group-by-file">LINE Developers documentation</a>
     */
    createAudienceForUploadingUserIdsWithHttpInfo(file: Blob, description?: string, isIfaAudience?: boolean, uploadDescription?: string): Promise<Types.ApiResponseType<CreateAudienceGroupResponse>>;
}
export {};
//# sourceMappingURL=manageAudienceBlobClient.d.ts.map