All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.twilio.rest.taskrouter.v1.workspace.worker.Reservation Maven / Gradle / Ivy

There is a newer version: 10.1.5
Show newest version
/**
 * This code was generated by
 * \ / _    _  _|   _  _
 *  | (_)\/(_)(_|\/| |(/_  v1.0.0
 *       /       /
 */

package com.twilio.rest.taskrouter.v1.workspace.worker;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.JsonParseException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.twilio.base.Resource;
import com.twilio.converter.DateConverter;
import com.twilio.converter.Promoter;
import com.twilio.exception.ApiConnectionException;
import com.twilio.exception.ApiException;
import com.twilio.exception.RestException;
import com.twilio.http.HttpMethod;
import com.twilio.http.Request;
import com.twilio.http.Response;
import com.twilio.http.TwilioRestClient;
import com.twilio.rest.Domains;
import lombok.ToString;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
import java.time.ZonedDateTime;
import java.util.Map;
import java.util.Objects;

@JsonIgnoreProperties(ignoreUnknown = true)
@ToString
public class Reservation extends Resource {
    private static final long serialVersionUID = 63448280807644L;

    public enum Status {
        PENDING("pending"),
        ACCEPTED("accepted"),
        REJECTED("rejected"),
        TIMEOUT("timeout"),
        CANCELED("canceled"),
        RESCINDED("rescinded"),
        WRAPPING("wrapping"),
        COMPLETED("completed");

        private final String value;

        private Status(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }

        /**
         * Generate a Status from a string.
         * @param value string value
         * @return generated Status
         */
        @JsonCreator
        public static Status forValue(final String value) {
            return Promoter.enumFromString(value, Status.values());
        }
    }

    public enum CallStatus {
        INITIATED("initiated"),
        RINGING("ringing"),
        ANSWERED("answered"),
        COMPLETED("completed");

        private final String value;

        private CallStatus(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }

        /**
         * Generate a CallStatus from a string.
         * @param value string value
         * @return generated CallStatus
         */
        @JsonCreator
        public static CallStatus forValue(final String value) {
            return Promoter.enumFromString(value, CallStatus.values());
        }
    }

    public enum ConferenceEvent {
        START("start"),
        END("end"),
        JOIN("join"),
        LEAVE("leave"),
        MUTE("mute"),
        HOLD("hold"),
        SPEAKER("speaker");

        private final String value;

        private ConferenceEvent(final String value) {
            this.value = value;
        }

        public String toString() {
            return value;
        }

        /**
         * Generate a ConferenceEvent from a string.
         * @param value string value
         * @return generated ConferenceEvent
         */
        @JsonCreator
        public static ConferenceEvent forValue(final String value) {
            return Promoter.enumFromString(value, ConferenceEvent.values());
        }
    }

    /**
     * Create a ReservationReader to execute read.
     *
     * @param pathWorkspaceSid The SID of the Workspace with the WorkerReservation
     *                         resources to read
     * @param pathWorkerSid The SID of the reserved Worker resource with the
     *                      WorkerReservation resources to read
     * @return ReservationReader capable of executing the read
     */
    public static ReservationReader reader(final String pathWorkspaceSid,
                                           final String pathWorkerSid) {
        return new ReservationReader(pathWorkspaceSid, pathWorkerSid);
    }

    /**
     * Create a ReservationFetcher to execute fetch.
     *
     * @param pathWorkspaceSid The SID of the Workspace with the WorkerReservation
     *                         resource to fetch
     * @param pathWorkerSid The SID of the reserved Worker resource with the
     *                      WorkerReservation resource to fetch
     * @param pathSid The SID of the WorkerReservation resource to fetch
     * @return ReservationFetcher capable of executing the fetch
     */
    public static ReservationFetcher fetcher(final String pathWorkspaceSid,
                                             final String pathWorkerSid,
                                             final String pathSid) {
        return new ReservationFetcher(pathWorkspaceSid, pathWorkerSid, pathSid);
    }

    /**
     * Create a ReservationUpdater to execute update.
     *
     * @param pathWorkspaceSid The SID of the Workspace with the WorkerReservation
     *                         resources to update
     * @param pathWorkerSid The SID of the reserved Worker resource with the
     *                      WorkerReservation resources to update
     * @param pathSid The SID of the WorkerReservation resource to update
     * @return ReservationUpdater capable of executing the update
     */
    public static ReservationUpdater updater(final String pathWorkspaceSid,
                                             final String pathWorkerSid,
                                             final String pathSid) {
        return new ReservationUpdater(pathWorkspaceSid, pathWorkerSid, pathSid);
    }

    /**
     * Converts a JSON String into a Reservation object using the provided
     * ObjectMapper.
     *
     * @param json Raw JSON String
     * @param objectMapper Jackson ObjectMapper
     * @return Reservation object represented by the provided JSON
     */
    public static Reservation fromJson(final String json, final ObjectMapper objectMapper) {
        // Convert all checked exceptions to Runtime
        try {
            return objectMapper.readValue(json, Reservation.class);
        } catch (final JsonMappingException | JsonParseException e) {
            throw new ApiException(e.getMessage(), e);
        } catch (final IOException e) {
            throw new ApiConnectionException(e.getMessage(), e);
        }
    }

    /**
     * Converts a JSON InputStream into a Reservation object using the provided
     * ObjectMapper.
     *
     * @param json Raw JSON InputStream
     * @param objectMapper Jackson ObjectMapper
     * @return Reservation object represented by the provided JSON
     */
    public static Reservation fromJson(final InputStream json, final ObjectMapper objectMapper) {
        // Convert all checked exceptions to Runtime
        try {
            return objectMapper.readValue(json, Reservation.class);
        } catch (final JsonMappingException | JsonParseException e) {
            throw new ApiException(e.getMessage(), e);
        } catch (final IOException e) {
            throw new ApiConnectionException(e.getMessage(), e);
        }
    }

    private final String accountSid;
    private final ZonedDateTime dateCreated;
    private final ZonedDateTime dateUpdated;
    private final Reservation.Status reservationStatus;
    private final String sid;
    private final String taskSid;
    private final String workerName;
    private final String workerSid;
    private final String workspaceSid;
    private final URI url;
    private final Map links;

    @JsonCreator
    private Reservation(@JsonProperty("account_sid")
                        final String accountSid,
                        @JsonProperty("date_created")
                        final String dateCreated,
                        @JsonProperty("date_updated")
                        final String dateUpdated,
                        @JsonProperty("reservation_status")
                        final Reservation.Status reservationStatus,
                        @JsonProperty("sid")
                        final String sid,
                        @JsonProperty("task_sid")
                        final String taskSid,
                        @JsonProperty("worker_name")
                        final String workerName,
                        @JsonProperty("worker_sid")
                        final String workerSid,
                        @JsonProperty("workspace_sid")
                        final String workspaceSid,
                        @JsonProperty("url")
                        final URI url,
                        @JsonProperty("links")
                        final Map links) {
        this.accountSid = accountSid;
        this.dateCreated = DateConverter.iso8601DateTimeFromString(dateCreated);
        this.dateUpdated = DateConverter.iso8601DateTimeFromString(dateUpdated);
        this.reservationStatus = reservationStatus;
        this.sid = sid;
        this.taskSid = taskSid;
        this.workerName = workerName;
        this.workerSid = workerSid;
        this.workspaceSid = workspaceSid;
        this.url = url;
        this.links = links;
    }

    /**
     * Returns The SID of the Account that created the resource.
     *
     * @return The SID of the Account that created the resource
     */
    public final String getAccountSid() {
        return this.accountSid;
    }

    /**
     * Returns The ISO 8601 date and time in GMT when the resource was created.
     *
     * @return The ISO 8601 date and time in GMT when the resource was created
     */
    public final ZonedDateTime getDateCreated() {
        return this.dateCreated;
    }

    /**
     * Returns The ISO 8601 date and time in GMT when the resource was last updated.
     *
     * @return The ISO 8601 date and time in GMT when the resource was last updated
     */
    public final ZonedDateTime getDateUpdated() {
        return this.dateUpdated;
    }

    /**
     * Returns The current status of the reservation.
     *
     * @return The current status of the reservation
     */
    public final Reservation.Status getReservationStatus() {
        return this.reservationStatus;
    }

    /**
     * Returns The unique string that identifies the resource.
     *
     * @return The unique string that identifies the resource
     */
    public final String getSid() {
        return this.sid;
    }

    /**
     * Returns The SID of the reserved Task resource.
     *
     * @return The SID of the reserved Task resource
     */
    public final String getTaskSid() {
        return this.taskSid;
    }

    /**
     * Returns The friendly_name of the Worker that is reserved.
     *
     * @return The friendly_name of the Worker that is reserved
     */
    public final String getWorkerName() {
        return this.workerName;
    }

    /**
     * Returns The SID of the reserved Worker resource.
     *
     * @return The SID of the reserved Worker resource
     */
    public final String getWorkerSid() {
        return this.workerSid;
    }

    /**
     * Returns The SID of the Workspace that this worker is contained within..
     *
     * @return The SID of the Workspace that this worker is contained within.
     */
    public final String getWorkspaceSid() {
        return this.workspaceSid;
    }

    /**
     * Returns The absolute URL of the WorkerReservation resource.
     *
     * @return The absolute URL of the WorkerReservation resource
     */
    public final URI getUrl() {
        return this.url;
    }

    /**
     * Returns The URLs of related resources.
     *
     * @return The URLs of related resources
     */
    public final Map getLinks() {
        return this.links;
    }

    @Override
    public boolean equals(final Object o) {
        if (this == o) {
            return true;
        }

        if (o == null || getClass() != o.getClass()) {
            return false;
        }

        Reservation other = (Reservation) o;

        return Objects.equals(accountSid, other.accountSid) &&
               Objects.equals(dateCreated, other.dateCreated) &&
               Objects.equals(dateUpdated, other.dateUpdated) &&
               Objects.equals(reservationStatus, other.reservationStatus) &&
               Objects.equals(sid, other.sid) &&
               Objects.equals(taskSid, other.taskSid) &&
               Objects.equals(workerName, other.workerName) &&
               Objects.equals(workerSid, other.workerSid) &&
               Objects.equals(workspaceSid, other.workspaceSid) &&
               Objects.equals(url, other.url) &&
               Objects.equals(links, other.links);
    }

    @Override
    public int hashCode() {
        return Objects.hash(accountSid,
                            dateCreated,
                            dateUpdated,
                            reservationStatus,
                            sid,
                            taskSid,
                            workerName,
                            workerSid,
                            workspaceSid,
                            url,
                            links);
    }
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy