Skip to content

Add includesOwnedAudienceGroups Parameter to Audience API #1247

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 21, 2025
Merged

Add includesOwnedAudienceGroups Parameter to Audience API #1247

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions lib/manage-audience/.openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ model/adaccount.ts
model/addAudienceToAudienceGroupRequest.ts
model/audience.ts
model/audienceGroup.ts
model/audienceGroupAuthorityLevel.ts
model/audienceGroupCreateRoute.ts
model/audienceGroupFailedType.ts
model/audienceGroupJob.ts
Expand All @@ -27,12 +26,10 @@ model/detailedOwner.ts
model/errorDetail.ts
model/errorResponse.ts
model/getAudienceDataResponse.ts
model/getAudienceGroupAuthorityLevelResponse.ts
model/getAudienceGroupsResponse.ts
model/getSharedAudienceDataResponse.ts
model/getSharedAudienceGroupsResponse.ts
model/models.ts
model/updateAudienceGroupAuthorityLevelRequest.ts
model/updateAudienceGroupDescriptionRequest.ts
tests/api/ManageAudienceBlobClientTest.spec.ts
tests/api/ManageAudienceClientTest.spec.ts
101 changes: 6 additions & 95 deletions lib/manage-audience/api/manageAudienceClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ import { CreateImpBasedAudienceGroupRequest } from "../model/createImpBasedAudie
import { CreateImpBasedAudienceGroupResponse } from "../model/createImpBasedAudienceGroupResponse.js";
import { ErrorResponse } from "../model/errorResponse.js";
import { GetAudienceDataResponse } from "../model/getAudienceDataResponse.js";
import { GetAudienceGroupAuthorityLevelResponse } from "../model/getAudienceGroupAuthorityLevelResponse.js";
import { GetAudienceGroupsResponse } from "../model/getAudienceGroupsResponse.js";
import { GetSharedAudienceDataResponse } from "../model/getSharedAudienceDataResponse.js";
import { GetSharedAudienceGroupsResponse } from "../model/getSharedAudienceGroupsResponse.js";
import { UpdateAudienceGroupAuthorityLevelRequest } from "../model/updateAudienceGroupAuthorityLevelRequest.js";
import { UpdateAudienceGroupDescriptionRequest } from "../model/updateAudienceGroupDescriptionRequest.js";

import * as Types from "../../types.js";
Expand Down Expand Up @@ -62,38 +60,6 @@ export class ManageAudienceClient {
});
}

/**
* Activate audience
* @param audienceGroupId The audience ID.
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#activate-audience-group"> Documentation</a>
*/
public async activateAudienceGroup(
audienceGroupId: number,
): Promise<Types.MessageAPIResponseBase> {
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>
*/
public async activateAudienceGroupWithHttpInfo(
audienceGroupId: number,
): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>> {
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
Expand Down Expand Up @@ -297,31 +263,6 @@ export class ManageAudienceClient {
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>
*/
public async getAudienceGroupAuthorityLevel(): Promise<GetAudienceGroupAuthorityLevelResponse> {
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>
*/
public async getAudienceGroupAuthorityLevelWithHttpInfo(): Promise<
Types.ApiResponseType<GetAudienceGroupAuthorityLevelResponse>
> {
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.
Expand Down Expand Up @@ -434,6 +375,7 @@ export class ManageAudienceClient {
* @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 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.
* @param includesOwnedAudienceGroups true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-shared-audience-list"> Documentation</a>
*/
Expand All @@ -443,6 +385,7 @@ export class ManageAudienceClient {
status?: AudienceGroupStatus,
size?: number,
createRoute?: AudienceGroupCreateRoute,
includesOwnedAudienceGroups?: boolean,
): Promise<GetSharedAudienceGroupsResponse> {
return (
await this.getSharedAudienceGroupsWithHttpInfo(
Expand All @@ -451,6 +394,7 @@ export class ManageAudienceClient {
status,
size,
createRoute,
includesOwnedAudienceGroups,
)
).body;
}
Expand All @@ -463,6 +407,7 @@ export class ManageAudienceClient {
* @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 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.
* @param includesOwnedAudienceGroups true: Include audienceGroups owned by LINE Official Account Manager false: Respond only audienceGroups shared by Business Manager
*
* @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-shared-audience-list"> Documentation</a>
*/
Expand All @@ -472,13 +417,15 @@ export class ManageAudienceClient {
status?: AudienceGroupStatus,
size?: number,
createRoute?: AudienceGroupCreateRoute,
includesOwnedAudienceGroups?: boolean,
): Promise<Types.ApiResponseType<GetSharedAudienceGroupsResponse>> {
const queryParams = {
page: page,
description: description,
status: status,
size: size,
createRoute: createRoute,
includesOwnedAudienceGroups: includesOwnedAudienceGroups,
};
Object.keys(queryParams).forEach((key: keyof typeof queryParams) => {
if (queryParams[key] === undefined) {
Expand All @@ -494,42 +441,6 @@ export class ManageAudienceClient {
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>
*/
public async updateAudienceGroupAuthorityLevel(
updateAudienceGroupAuthorityLevelRequest: UpdateAudienceGroupAuthorityLevelRequest,
): Promise<Types.MessageAPIResponseBase> {
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>
*/
public async updateAudienceGroupAuthorityLevelWithHttpInfo(
updateAudienceGroupAuthorityLevelRequest: UpdateAudienceGroupAuthorityLevelRequest,
): Promise<Types.ApiResponseType<Types.MessageAPIResponseBase>> {
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.
Expand Down
17 changes: 0 additions & 17 deletions lib/manage-audience/model/audienceGroupAuthorityLevel.ts
View file
Open in desktop

This file was deleted.

26 changes: 0 additions & 26 deletions lib/manage-audience/model/getAudienceGroupAuthorityLevelResponse.ts
View file
Open in desktop

This file was deleted.

3 changes: 0 additions & 3 deletions lib/manage-audience/model/models.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@ export * from "./adaccount.js";
export * from "./addAudienceToAudienceGroupRequest.js";
export * from "./audience.js";
export * from "./audienceGroup.js";
export * from "./audienceGroupAuthorityLevel.js";
export * from "./audienceGroupCreateRoute.js";
export * from "./audienceGroupFailedType.js";
export * from "./audienceGroupJob.js";
Expand All @@ -22,9 +21,7 @@ export * from "./detailedOwner.js";
export * from "./errorDetail.js";
export * from "./errorResponse.js";
export * from "./getAudienceDataResponse.js";
export * from "./getAudienceGroupAuthorityLevelResponse.js";
export * from "./getAudienceGroupsResponse.js";
export * from "./getSharedAudienceDataResponse.js";
export * from "./getSharedAudienceGroupsResponse.js";
export * from "./updateAudienceGroupAuthorityLevelRequest.js";
export * from "./updateAudienceGroupDescriptionRequest.js";
26 changes: 0 additions & 26 deletions lib/manage-audience/model/updateAudienceGroupAuthorityLevelRequest.ts
View file
Open in desktop

This file was deleted.

Loading