UNPKG

13.4 kBTypeScriptView Raw
1/**
2 * LINE Messaging API
3 * This document describes LINE Messaging API.
4 *
5 * The version of the OpenAPI document: 0.0.1
6 *
7 *
8 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9 * https://openapi-generator.tech
10 * Do not edit the class manually.
11 */
12import { AddAudienceToAudienceGroupRequest } from "../model/addAudienceToAudienceGroupRequest.js";
13import { AudienceGroupCreateRoute } from "../model/audienceGroupCreateRoute.js";
14import { AudienceGroupStatus } from "../model/audienceGroupStatus.js";
15import { CreateAudienceGroupRequest } from "../model/createAudienceGroupRequest.js";
16import { CreateAudienceGroupResponse } from "../model/createAudienceGroupResponse.js";
17import { CreateClickBasedAudienceGroupRequest } from "../model/createClickBasedAudienceGroupRequest.js";
18import { CreateClickBasedAudienceGroupResponse } from "../model/createClickBasedAudienceGroupResponse.js";
19import { CreateImpBasedAudienceGroupRequest } from "../model/createImpBasedAudienceGroupRequest.js";
20import { CreateImpBasedAudienceGroupResponse } from "../model/createImpBasedAudienceGroupResponse.js";
21import { GetAudienceDataResponse } from "../model/getAudienceDataResponse.js";
22import { GetAudienceGroupAuthorityLevelResponse } from "../model/getAudienceGroupAuthorityLevelResponse.js";
23import { GetAudienceGroupsResponse } from "../model/getAudienceGroupsResponse.js";
24import { UpdateAudienceGroupAuthorityLevelRequest } from "../model/updateAudienceGroupAuthorityLevelRequest.js";
25import { UpdateAudienceGroupDescriptionRequest } from "../model/updateAudienceGroupDescriptionRequest.js";
26import * as Types from "../../types.js";
27interface httpClientConfig {
28 baseURL?: string;
29 channelAccessToken: string;
30}
31export declare class ManageAudienceClient {
32 private httpClient;
33 constructor(config: httpClientConfig);
34 private parseHTTPResponse;
35 /**
36 * Activate audience
37 * @param audienceGroupId The audience ID.
38 *
39 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#activate-audience-group"> Documentation</a>
40 */
41 activateAudienceGroup(audienceGroupId: number): Promise<Types.MessageAPIResponseBase>;
42 /**
43 * Activate audience.
44 * This method includes HttpInfo object to return additional information.
45 * @param audienceGroupId The audience ID.
46 *
47 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#activate-audience-group"> Documentation</a>
48 */
49 activateAudienceGroupWithHttpInfo(audienceGroupId: number): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
50 /**
51 * Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON)
52 * @param addAudienceToAudienceGroupRequest
53 *
54 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group"> Documentation</a>
55 */
56 addAudienceToAudienceGroup(addAudienceToAudienceGroupRequest: AddAudienceToAudienceGroupRequest): Promise<Types.MessageAPIResponseBase>;
57 /**
58 * Add user IDs or Identifiers for Advertisers (IFAs) to an audience for uploading user IDs (by JSON).
59 * This method includes HttpInfo object to return additional information.
60 * @param addAudienceToAudienceGroupRequest
61 *
62 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#update-upload-audience-group"> Documentation</a>
63 */
64 addAudienceToAudienceGroupWithHttpInfo(addAudienceToAudienceGroupRequest: AddAudienceToAudienceGroupRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
65 /**
66 * Create audience for uploading user IDs (by JSON)
67 * @param createAudienceGroupRequest
68 *
69 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group"> Documentation</a>
70 */
71 createAudienceGroup(createAudienceGroupRequest: CreateAudienceGroupRequest): Promise<CreateAudienceGroupResponse>;
72 /**
73 * Create audience for uploading user IDs (by JSON).
74 * This method includes HttpInfo object to return additional information.
75 * @param createAudienceGroupRequest
76 *
77 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-upload-audience-group"> Documentation</a>
78 */
79 createAudienceGroupWithHttpInfo(createAudienceGroupRequest: CreateAudienceGroupRequest): Promise<Types.ApiResponseType<CreateAudienceGroupResponse>>;
80 /**
81 * Create audience for click-based retargeting
82 * @param createClickBasedAudienceGroupRequest
83 *
84 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group"> Documentation</a>
85 */
86 createClickBasedAudienceGroup(createClickBasedAudienceGroupRequest: CreateClickBasedAudienceGroupRequest): Promise<CreateClickBasedAudienceGroupResponse>;
87 /**
88 * Create audience for click-based retargeting.
89 * This method includes HttpInfo object to return additional information.
90 * @param createClickBasedAudienceGroupRequest
91 *
92 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-click-audience-group"> Documentation</a>
93 */
94 createClickBasedAudienceGroupWithHttpInfo(createClickBasedAudienceGroupRequest: CreateClickBasedAudienceGroupRequest): Promise<Types.ApiResponseType<CreateClickBasedAudienceGroupResponse>>;
95 /**
96 * Create audience for impression-based retargeting
97 * @param createImpBasedAudienceGroupRequest
98 *
99 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group"> Documentation</a>
100 */
101 createImpBasedAudienceGroup(createImpBasedAudienceGroupRequest: CreateImpBasedAudienceGroupRequest): Promise<CreateImpBasedAudienceGroupResponse>;
102 /**
103 * Create audience for impression-based retargeting.
104 * This method includes HttpInfo object to return additional information.
105 * @param createImpBasedAudienceGroupRequest
106 *
107 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#create-imp-audience-group"> Documentation</a>
108 */
109 createImpBasedAudienceGroupWithHttpInfo(createImpBasedAudienceGroupRequest: CreateImpBasedAudienceGroupRequest): Promise<Types.ApiResponseType<CreateImpBasedAudienceGroupResponse>>;
110 /**
111 * Delete audience
112 * @param audienceGroupId The audience ID.
113 *
114 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-audience-group"> Documentation</a>
115 */
116 deleteAudienceGroup(audienceGroupId: number): Promise<Types.MessageAPIResponseBase>;
117 /**
118 * Delete audience.
119 * This method includes HttpInfo object to return additional information.
120 * @param audienceGroupId The audience ID.
121 *
122 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#delete-audience-group"> Documentation</a>
123 */
124 deleteAudienceGroupWithHttpInfo(audienceGroupId: number): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
125 /**
126 * Gets audience data.
127 * @param audienceGroupId The audience ID.
128 *
129 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-group"> Documentation</a>
130 */
131 getAudienceData(audienceGroupId: number): Promise<GetAudienceDataResponse>;
132 /**
133 * Gets audience data..
134 * This method includes HttpInfo object to return additional information.
135 * @param audienceGroupId The audience ID.
136 *
137 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-group"> Documentation</a>
138 */
139 getAudienceDataWithHttpInfo(audienceGroupId: number): Promise<Types.ApiResponseType<GetAudienceDataResponse>>;
140 /**
141 * Get the authority level of the audience
142 *
143 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-authority-level"> Documentation</a>
144 */
145 getAudienceGroupAuthorityLevel(): Promise<GetAudienceGroupAuthorityLevelResponse>;
146 /**
147 * Get the authority level of the audience.
148 * This method includes HttpInfo object to return additional information.
149 *
150 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-authority-level"> Documentation</a>
151 */
152 getAudienceGroupAuthorityLevelWithHttpInfo(): Promise<Types.ApiResponseType<GetAudienceGroupAuthorityLevelResponse>>;
153 /**
154 * Gets data for more than one audience.
155 * @param page The page to return when getting (paginated) results. Must be 1 or higher.
156 * @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.
157 * @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.
158 * @param size The number of audiences per page. Default: 20 Max: 40
159 * @param includesExternalPublicGroups true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
160 * @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.
161 *
162 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups"> Documentation</a>
163 */
164 getAudienceGroups(page: number, description?: string, status?: AudienceGroupStatus, size?: number, includesExternalPublicGroups?: boolean, createRoute?: AudienceGroupCreateRoute): Promise<GetAudienceGroupsResponse>;
165 /**
166 * Gets data for more than one audience..
167 * This method includes HttpInfo object to return additional information.
168 * @param page The page to return when getting (paginated) results. Must be 1 or higher.
169 * @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.
170 * @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.
171 * @param size The number of audiences per page. Default: 20 Max: 40
172 * @param includesExternalPublicGroups true (default): Get public audiences created in all channels linked to the same bot. false: Get audiences created in the same channel.
173 * @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.
174 *
175 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups"> Documentation</a>
176 */
177 getAudienceGroupsWithHttpInfo(page: number, description?: string, status?: AudienceGroupStatus, size?: number, includesExternalPublicGroups?: boolean, createRoute?: AudienceGroupCreateRoute): Promise<Types.ApiResponseType<GetAudienceGroupsResponse>>;
178 /**
179 * Change the authority level of the audience
180 * @param updateAudienceGroupAuthorityLevelRequest
181 *
182 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#change-authority-level"> Documentation</a>
183 */
184 updateAudienceGroupAuthorityLevel(updateAudienceGroupAuthorityLevelRequest: UpdateAudienceGroupAuthorityLevelRequest): Promise<Types.MessageAPIResponseBase>;
185 /**
186 * Change the authority level of the audience.
187 * This method includes HttpInfo object to return additional information.
188 * @param updateAudienceGroupAuthorityLevelRequest
189 *
190 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#change-authority-level"> Documentation</a>
191 */
192 updateAudienceGroupAuthorityLevelWithHttpInfo(updateAudienceGroupAuthorityLevelRequest: UpdateAudienceGroupAuthorityLevelRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
193 /**
194 * Renames an existing audience.
195 * @param audienceGroupId The audience ID.
196 * @param updateAudienceGroupDescriptionRequest
197 *
198 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#set-description-audience-group"> Documentation</a>
199 */
200 updateAudienceGroupDescription(audienceGroupId: number, updateAudienceGroupDescriptionRequest: UpdateAudienceGroupDescriptionRequest): Promise<Types.MessageAPIResponseBase>;
201 /**
202 * Renames an existing audience..
203 * This method includes HttpInfo object to return additional information.
204 * @param audienceGroupId The audience ID.
205 * @param updateAudienceGroupDescriptionRequest
206 *
207 * @see <a href="https://developers.line.biz/en/reference/messaging-api/#set-description-audience-group"> Documentation</a>
208 */
209 updateAudienceGroupDescriptionWithHttpInfo(audienceGroupId: number, updateAudienceGroupDescriptionRequest: UpdateAudienceGroupDescriptionRequest): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>>;
210}
211export {};
212//# sourceMappingURL=manageAudienceClient.d.ts.map
\No newline at end of file