@line/bot-sdk
Version:
Node.js SDK for LINE Messaging API
308 lines • 16.1 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.
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.ManageAudienceClient = void 0;
const Types = require("../../types.js");
const http_fetch_js_1 = require("../../http-fetch.js");
class ManageAudienceClient {
constructor(config) {
const baseURL = config.baseURL || "https://api.line.me";
this.httpClient = new http_fetch_js_1.default({
defaultHeaders: {
Authorization: "Bearer " + config.channelAccessToken,
},
baseURL: baseURL,
});
}
async parseHTTPResponse(response) {
const { LINE_REQUEST_ID_HTTP_HEADER_NAME } = Types;
let resBody = Object.assign({}, (await response.json()));
if (response.headers.get(LINE_REQUEST_ID_HTTP_HEADER_NAME)) {
resBody[LINE_REQUEST_ID_HTTP_HEADER_NAME] = response.headers.get(LINE_REQUEST_ID_HTTP_HEADER_NAME);
}
return resBody;
}
/**
* Activate audience
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#activate-audience-group"> Documentation</a>
*/
async activateAudienceGroup(audienceGroupId) {
return (await this.activateAudienceGroupWithHttpInfo(audienceGroupId)).body;
}
/**
* Activate 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/#activate-audience-group"> Documentation</a>
*/
async activateAudienceGroupWithHttpInfo(audienceGroupId) {
const res = await this.httpClient.put("/v2/bot/audienceGroup/{audienceGroupId}/activate".replace("{audienceGroupId}", String(audienceGroupId)));
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* 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>
*/
async addAudienceToAudienceGroup(addAudienceToAudienceGroupRequest) {
return (await this.addAudienceToAudienceGroupWithHttpInfo(addAudienceToAudienceGroupRequest)).body;
}
/**
* 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>
*/
async addAudienceToAudienceGroupWithHttpInfo(addAudienceToAudienceGroupRequest) {
const params = addAudienceToAudienceGroupRequest;
const res = await this.httpClient.put("/v2/bot/audienceGroup/upload", params);
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* 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>
*/
async createAudienceGroup(createAudienceGroupRequest) {
return (await this.createAudienceGroupWithHttpInfo(createAudienceGroupRequest)).body;
}
/**
* 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>
*/
async createAudienceGroupWithHttpInfo(createAudienceGroupRequest) {
const params = createAudienceGroupRequest;
const res = await this.httpClient.post("/v2/bot/audienceGroup/upload", params);
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* 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>
*/
async createClickBasedAudienceGroup(createClickBasedAudienceGroupRequest) {
return (await this.createClickBasedAudienceGroupWithHttpInfo(createClickBasedAudienceGroupRequest)).body;
}
/**
* 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>
*/
async createClickBasedAudienceGroupWithHttpInfo(createClickBasedAudienceGroupRequest) {
const params = createClickBasedAudienceGroupRequest;
const res = await this.httpClient.post("/v2/bot/audienceGroup/click", params);
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* 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>
*/
async createImpBasedAudienceGroup(createImpBasedAudienceGroupRequest) {
return (await this.createImpBasedAudienceGroupWithHttpInfo(createImpBasedAudienceGroupRequest)).body;
}
/**
* 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>
*/
async createImpBasedAudienceGroupWithHttpInfo(createImpBasedAudienceGroupRequest) {
const params = createImpBasedAudienceGroupRequest;
const res = await this.httpClient.post("/v2/bot/audienceGroup/imp", params);
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* Delete audience
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-audience-group"> Documentation</a>
*/
async deleteAudienceGroup(audienceGroupId) {
return (await this.deleteAudienceGroupWithHttpInfo(audienceGroupId)).body;
}
/**
* 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>
*/
async deleteAudienceGroupWithHttpInfo(audienceGroupId) {
const res = await this.httpClient.delete("/v2/bot/audienceGroup/{audienceGroupId}".replace("{audienceGroupId}", String(audienceGroupId)));
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* Gets audience data.
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-group"> Documentation</a>
*/
async getAudienceData(audienceGroupId) {
return (await this.getAudienceDataWithHttpInfo(audienceGroupId)).body;
}
/**
* 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>
*/
async getAudienceDataWithHttpInfo(audienceGroupId) {
const res = await this.httpClient.get("/v2/bot/audienceGroup/{audienceGroupId}".replace("{audienceGroupId}", String(audienceGroupId)));
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* Get the authority level of the audience
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-authority-level"> Documentation</a>
*/
async getAudienceGroupAuthorityLevel() {
return (await this.getAudienceGroupAuthorityLevelWithHttpInfo()).body;
}
/**
* Get the authority level of the audience.
* This method includes HttpInfo object to return additional information.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-authority-level"> Documentation</a>
*/
async getAudienceGroupAuthorityLevelWithHttpInfo() {
const res = await this.httpClient.get("/v2/bot/audienceGroup/authorityLevel");
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* 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>
*/
async getAudienceGroups(page, description, status, size, includesExternalPublicGroups, createRoute) {
return (await this.getAudienceGroupsWithHttpInfo(page, description, status, size, includesExternalPublicGroups, createRoute)).body;
}
/**
* 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>
*/
async getAudienceGroupsWithHttpInfo(page, description, status, size, includesExternalPublicGroups, createRoute) {
const queryParams = {
page: page,
description: description,
status: status,
size: size,
includesExternalPublicGroups: includesExternalPublicGroups,
createRoute: createRoute,
};
Object.keys(queryParams).forEach((key) => {
if (queryParams[key] === undefined) {
delete queryParams[key];
}
});
const res = await this.httpClient.get("/v2/bot/audienceGroup/list", queryParams);
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* Change the authority level of the audience
* @param updateAudienceGroupAuthorityLevelRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#change-authority-level"> Documentation</a>
*/
async updateAudienceGroupAuthorityLevel(updateAudienceGroupAuthorityLevelRequest) {
return (await this.updateAudienceGroupAuthorityLevelWithHttpInfo(updateAudienceGroupAuthorityLevelRequest)).body;
}
/**
* Change the authority level of the audience.
* This method includes HttpInfo object to return additional information.
* @param updateAudienceGroupAuthorityLevelRequest
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#change-authority-level"> Documentation</a>
*/
async updateAudienceGroupAuthorityLevelWithHttpInfo(updateAudienceGroupAuthorityLevelRequest) {
const params = updateAudienceGroupAuthorityLevelRequest;
const res = await this.httpClient.put("/v2/bot/audienceGroup/authorityLevel", params);
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
/**
* 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>
*/
async updateAudienceGroupDescription(audienceGroupId, updateAudienceGroupDescriptionRequest) {
return (await this.updateAudienceGroupDescriptionWithHttpInfo(audienceGroupId, updateAudienceGroupDescriptionRequest)).body;
}
/**
* 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>
*/
async updateAudienceGroupDescriptionWithHttpInfo(audienceGroupId, updateAudienceGroupDescriptionRequest) {
const params = updateAudienceGroupDescriptionRequest;
const res = await this.httpClient.put("/v2/bot/audienceGroup/{audienceGroupId}/updateDescription".replace("{audienceGroupId}", String(audienceGroupId)), params);
const text = await res.text();
const parsedBody = text ? JSON.parse(text) : null;
return { httpResponse: res, body: parsedBody };
}
}
exports.ManageAudienceClient = ManageAudienceClient;
//# sourceMappingURL=manageAudienceClient.js.map