@line/bot-sdk
Version:
Node.js SDK for LINE Messaging API
111 lines • 6.81 kB
JavaScript
/**
* 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 HTTPFetchClient, { mergeHeaders, } from "../../http-fetch.js";
/**
* @see {@link LineBotClient} for a unified interface that wraps this client.
*/
export class ManageAudienceBlobClient {
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) {
const baseURL = config.baseURL || "https://api-data.line.me";
const defaultHeaders = mergeHeaders(config.defaultHeaders, {
Authorization: "Bearer " + config.channelAccessToken,
});
this.httpClient = new HTTPFetchClient({
defaultHeaders: defaultHeaders,
baseURL: baseURL,
});
}
/**
* 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>
*/
async addUserIdsToAudience(file, audienceGroupId, uploadDescription) {
return (await this.addUserIdsToAudienceWithHttpInfo(file, audienceGroupId, uploadDescription)).body;
}
/**
* 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>
*/
async addUserIdsToAudienceWithHttpInfo(file, audienceGroupId, uploadDescription) {
const form = new FormData();
form.append("audienceGroupId", String(audienceGroupId));
form.append("uploadDescription", String(uploadDescription));
form.append("file", file); // file
const res = await this.httpClient.putFormMultipart("/v2/bot/audienceGroup/upload/byFile", form);
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* 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>
*/
async createAudienceForUploadingUserIds(file, description, isIfaAudience, uploadDescription) {
return (await this.createAudienceForUploadingUserIdsWithHttpInfo(file, description, isIfaAudience, uploadDescription)).body;
}
/**
* 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>
*/
async createAudienceForUploadingUserIdsWithHttpInfo(file, description, isIfaAudience, uploadDescription) {
const form = new FormData();
form.append("description", String(description));
form.append("isIfaAudience", String(isIfaAudience));
form.append("uploadDescription", String(uploadDescription));
form.append("file", file); // file
const res = await this.httpClient.postFormMultipart("/v2/bot/audienceGroup/upload/byFile", form);
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
}
//# sourceMappingURL=manageAudienceBlobClient.js.map