ch.loway.oss.ari4java.generated.actions.ActionMailboxes Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ari4java Show documentation

Asterisk ARI interface bindings for Java

There is a newer version: 0.17.0

package ch.loway.oss.ari4java.generated.actions;

// ----------------------------------------------------
//      THIS CLASS WAS GENERATED AUTOMATICALLY
//               PLEASE DO NOT EDIT
//    Generated on: Mon Jul 11 11:00:30 SAST 2022
// ----------------------------------------------------

import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.ArrayList;
import ch.loway.oss.ari4java.tools.*;
import ch.loway.oss.ari4java.tools.tags.EventSource;
import ch.loway.oss.ari4java.generated.actions.requests.*;
import ch.loway.oss.ari4java.generated.models.Module;
import ch.loway.oss.ari4java.generated.models.*;

/** Generated by: JavaInterface */
public interface ActionMailboxes {
  /**
   * Retrieve the current state of a mailbox.
   *
   * @param mailboxName Name of the mailbox
   * @return MailboxesGetRequest
   * @throws RestException an error
   * @since ARI_1_1_0
   */
  public MailboxesGetRequest get(String mailboxName) throws RestException;
  /**
   * Change the state of a mailbox. (Note - implicitly creates the mailbox).
   *
   * @param mailboxName Name of the mailbox
   * @param oldMessages Count of old messages in the mailbox
   * @param newMessages Count of new messages in the mailbox
   * @return MailboxesUpdatePutRequest
   * @throws RestException an error
   * @since ARI_1_1_0
   */
  public MailboxesUpdatePutRequest update(
      String mailboxName, Integer oldMessages, Integer newMessages) throws RestException;
  /**
   * Destroy a mailbox.
   *
   * @param mailboxName Name of the mailbox
   * @return MailboxesDeleteRequest
   * @throws RestException an error
   * @since ARI_1_1_0
   */
  public MailboxesDeleteRequest delete(String mailboxName) throws RestException;
  /**
   * List all mailboxes.
   *
   * @return MailboxesListGetRequest
   * @throws RestException an error
   * @since ARI_1_1_0
   */
  public MailboxesListGetRequest list() throws RestException;
}