@line/bot-sdk/dist/messaging-api/model/limit.d.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.
 */
/**
 * Limit of the Narrowcast
 */
export type Limit = {
    /**
     * The maximum number of narrowcast messages to send. Use this parameter to limit the number of narrowcast messages sent. The recipients will be chosen at random.
     *
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message">max Documentation</a>
     */
    max?: number;
    /**
     * If true, the message will be sent within the maximum number of deliverable messages. The default value is `false`.  Targets will be selected at random.
     *
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message">upToRemainingQuota Documentation</a>
     */
    upToRemainingQuota?: boolean;
    /**
     * This option prevents messages from being delivered to only a subset of the target audience. If true, the narrowcast request success but fails asynchronously. You can check whether message delivery was canceled by retrieving the narrowcast message progress.  This property can be set to true only if upToRemainingQuota is set to true.
     *
     * @see <a href="https://developers.line.biz/en/reference/messaging-api/#send-narrowcast-message">forbidPartialDelivery Documentation</a>
     */
    forbidPartialDelivery?: boolean;
};
//# sourceMappingURL=limit.d.ts.map