@line/bot-sdk/lib/manage-audience/model/getAudienceGroupsResponse.ts

Node.js SDK for LINE Messaging API

/**
 * 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 { AudienceGroup } from "./audienceGroup.js";

/**
 * Gets data for more than one audience.
 */
export type GetAudienceGroupsResponse = {
  /**
   * An array of audience data. If there are no audiences that match the specified filter, an empty array will be returned.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups">audienceGroups Documentation</a>
   */
  audienceGroups?: Array<AudienceGroup> /**/;
  /**
   * true when this is not the last page.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups">hasNextPage Documentation</a>
   */
  hasNextPage?: boolean /**/;
  /**
   * The total number of audiences that can be returned with the specified filter.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups">totalCount Documentation</a>
   */
  totalCount?: number /**/;
  /**
   * Of the audiences you can get with the specified filter, the number of audiences with the update permission set to READ_WRITE.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups">readWriteAudienceGroupTotalCount Documentation</a>
   */
  readWriteAudienceGroupTotalCount?: number /**/;
  /**
   * The current page number.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups">page Documentation</a>
   */
  page?: number /**/;
  /**
   * The maximum number of audiences on the current page.
   *
   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-audience-groups">size Documentation</a>
   */
  size?: number /**/;
};