Add includesOwnedAudienceGroups Parameter to Audience API (#1247)

line/line-openapi#105

# Enhancement to Shared Audiences API

This PR introduces a new query parameter `includesOwnedAudienceGroups`
to the `/v2/bot/audienceGroup/shared/list` endpoint in the Business
Manager API. This enhancement allows users to specify whether to include
audience groups owned by the user in the response.

## Changes Made
- Added the `includesOwnedAudienceGroups` parameter to the API endpoint.
  - **Type**: Boolean
  - **Default**: false
  - **Description**: 
- `true`: Include audience groups owned by the LINE Official Account
Manager.
- `false`: Respond only with audience groups shared by Business Manager.
- Removed the `/v2/bot/audienceGroup/{audienceGroupId}/activate` and
`/v2/bot/audienceGroup/authorityLevel` endpoints.

## Purpose
This update provides more flexibility in retrieving audience groups by
allowing users to filter based on ownership. It is especially useful for
users who manage both shared and owned audience groups. The removal of
certain endpoints is part of a cleanup effort to streamline the API.

Please review the changes and let me know if there are any questions or
further modifications needed.

## Documents and Reference
- [Get List of Shared
Audiences](https://developers.line.biz/en/reference/messaging-api/#get-shared-audience-list)
- [Removed
Endpoints](https://developers.line.biz/en/news/2025/03/26/cross-targeting-closing/)

For more information, please refer to the links provided above.

Co-authored-by: github-actions <[email protected]>

Author: github-actions[bot]

lib/manage-audience/.openapi-generator/FILES

@@ -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
@@ -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

lib/manage-audience/api/manageAudienceClient.ts

@@ -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";
@@ -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
@@ -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.
@@ -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>
    */
@@ -443,6 +385,7 @@ export class ManageAudienceClient {
     status?: AudienceGroupStatus,
     size?: number,
     createRoute?: AudienceGroupCreateRoute,
+    includesOwnedAudienceGroups?: boolean,
   ): Promise<GetSharedAudienceGroupsResponse> {
     return (
       await this.getSharedAudienceGroupsWithHttpInfo(
@@ -451,6 +394,7 @@ export class ManageAudienceClient {
         status,
         size,
         createRoute,
+        includesOwnedAudienceGroups,
       )
     ).body;
   }
@@ -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>
    */
@@ -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) {
@@ -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.

lib/manage-audience/model/audienceGroupAuthorityLevel.ts

@@ -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";
@@ -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";