com.ringcentral.definitions.MessageBatchResponse Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ringcentral Show documentation
RingCentral Java SDK
There is a newer version: 3.2.1
package com.ringcentral.definitions;


/**
 * Batch of A2P SMS messages. This object provides a specification
 * to send message(s) to many recipients. It contains top-level attributes which apply to all messages. In addition
 * to that, it is possible to override this attribute for each message. This
 * way a single API call may be used to send individual messages to many recipients
 */
public class MessageBatchResponse {
    /**
     * Unique identifier of the message batch
     * Example: 12345
     */
    public String id;
    /**
     * Phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format from which the messages are going to be sent
     * Example: +15551234567
     */
    public String from;
    /**
     * Total number of messages in the accepted batch
     * Format: int32
     * Example: 5
     */
    public Long batchSize;
    /**
     * Total number of messages currently processed in the batch
     * Format: int32
     * Example: 1
     */
    public Long processedCount;
    /**
     * The last time the batch was processed.
     * Format: date-time
     */
    public String lastModifiedTime;
    /**
     * Current status of a message batch
     * Example: Processing
     * Enum: Processing, Completed
     */
    public String status;
    /**
     * The time at which the batch was created
     * Format: date-time
     */
    public String creationTime;
    /**
     * The list of rejected/invalid recipients
     */
    public RejectedRecipientResponseResource[] rejected;
    /**
     * The estimated batch cost for completed batch. Calculated after batch processing is completed.
     * Format: double
     * Example: 0.007
     */
    public Double cost;

    public MessageBatchResponse id(String id) {
        this.id = id;
        return this;
    }

    public MessageBatchResponse from(String from) {
        this.from = from;
        return this;
    }

    public MessageBatchResponse batchSize(Long batchSize) {
        this.batchSize = batchSize;
        return this;
    }

    public MessageBatchResponse processedCount(Long processedCount) {
        this.processedCount = processedCount;
        return this;
    }

    public MessageBatchResponse lastModifiedTime(String lastModifiedTime) {
        this.lastModifiedTime = lastModifiedTime;
        return this;
    }

    public MessageBatchResponse status(String status) {
        this.status = status;
        return this;
    }

    public MessageBatchResponse creationTime(String creationTime) {
        this.creationTime = creationTime;
        return this;
    }

    public MessageBatchResponse rejected(RejectedRecipientResponseResource[] rejected) {
        this.rejected = rejected;
        return this;
    }

    public MessageBatchResponse cost(Double cost) {
        this.cost = cost;
        return this;
    }
}