com.twilio.rest.api.v2010.account.Transcription Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio Show documentation
Show all versions of twilio Show documentation
Twilio Java Helper Library
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.api.v2010.account;
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.fasterxml.jackson.databind.annotation.JsonDeserialize;
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.math.BigDecimal;
import java.time.ZonedDateTime;
import java.util.Currency;
import java.util.Map;
import java.util.Objects;
@JsonIgnoreProperties(ignoreUnknown = true)
@ToString
public class Transcription extends Resource {
private static final long serialVersionUID = 3308072321352L;
public enum Status {
IN_PROGRESS("in-progress"),
COMPLETED("completed"),
FAILED("failed");
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());
}
}
/**
* Create a TranscriptionFetcher to execute fetch.
*
* @param pathAccountSid The SID of the Account that created the resource to
* fetch
* @param pathSid The unique string that identifies the resource
* @return TranscriptionFetcher capable of executing the fetch
*/
public static TranscriptionFetcher fetcher(final String pathAccountSid,
final String pathSid) {
return new TranscriptionFetcher(pathAccountSid, pathSid);
}
/**
* Create a TranscriptionFetcher to execute fetch.
*
* @param pathSid The unique string that identifies the resource
* @return TranscriptionFetcher capable of executing the fetch
*/
public static TranscriptionFetcher fetcher(final String pathSid) {
return new TranscriptionFetcher(pathSid);
}
/**
* Create a TranscriptionDeleter to execute delete.
*
* @param pathAccountSid The SID of the Account that created the resources to
* delete
* @param pathSid The unique string that identifies the resource
* @return TranscriptionDeleter capable of executing the delete
*/
public static TranscriptionDeleter deleter(final String pathAccountSid,
final String pathSid) {
return new TranscriptionDeleter(pathAccountSid, pathSid);
}
/**
* Create a TranscriptionDeleter to execute delete.
*
* @param pathSid The unique string that identifies the resource
* @return TranscriptionDeleter capable of executing the delete
*/
public static TranscriptionDeleter deleter(final String pathSid) {
return new TranscriptionDeleter(pathSid);
}
/**
* Create a TranscriptionReader to execute read.
*
* @param pathAccountSid The SID of the Account that created the resources to
* read
* @return TranscriptionReader capable of executing the read
*/
public static TranscriptionReader reader(final String pathAccountSid) {
return new TranscriptionReader(pathAccountSid);
}
/**
* Create a TranscriptionReader to execute read.
*
* @return TranscriptionReader capable of executing the read
*/
public static TranscriptionReader reader() {
return new TranscriptionReader();
}
/**
* Converts a JSON String into a Transcription object using the provided
* ObjectMapper.
*
* @param json Raw JSON String
* @param objectMapper Jackson ObjectMapper
* @return Transcription object represented by the provided JSON
*/
public static Transcription fromJson(final String json, final ObjectMapper objectMapper) {
// Convert all checked exceptions to Runtime
try {
return objectMapper.readValue(json, Transcription.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 Transcription object using the provided
* ObjectMapper.
*
* @param json Raw JSON InputStream
* @param objectMapper Jackson ObjectMapper
* @return Transcription object represented by the provided JSON
*/
public static Transcription fromJson(final InputStream json, final ObjectMapper objectMapper) {
// Convert all checked exceptions to Runtime
try {
return objectMapper.readValue(json, Transcription.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 String apiVersion;
private final ZonedDateTime dateCreated;
private final ZonedDateTime dateUpdated;
private final String duration;
private final BigDecimal price;
private final Currency priceUnit;
private final String recordingSid;
private final String sid;
private final Transcription.Status status;
private final String transcriptionText;
private final String type;
private final String uri;
@JsonCreator
private Transcription(@JsonProperty("account_sid")
final String accountSid,
@JsonProperty("api_version")
final String apiVersion,
@JsonProperty("date_created")
final String dateCreated,
@JsonProperty("date_updated")
final String dateUpdated,
@JsonProperty("duration")
final String duration,
@JsonProperty("price")
final BigDecimal price,
@JsonProperty("price_unit")
@JsonDeserialize(using = com.twilio.converter.CurrencyDeserializer.class)
final Currency priceUnit,
@JsonProperty("recording_sid")
final String recordingSid,
@JsonProperty("sid")
final String sid,
@JsonProperty("status")
final Transcription.Status status,
@JsonProperty("transcription_text")
final String transcriptionText,
@JsonProperty("type")
final String type,
@JsonProperty("uri")
final String uri) {
this.accountSid = accountSid;
this.apiVersion = apiVersion;
this.dateCreated = DateConverter.rfc2822DateTimeFromString(dateCreated);
this.dateUpdated = DateConverter.rfc2822DateTimeFromString(dateUpdated);
this.duration = duration;
this.price = price;
this.priceUnit = priceUnit;
this.recordingSid = recordingSid;
this.sid = sid;
this.status = status;
this.transcriptionText = transcriptionText;
this.type = type;
this.uri = uri;
}
/**
* 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 API version used to create the transcription.
*
* @return The API version used to create the transcription
*/
public final String getApiVersion() {
return this.apiVersion;
}
/**
* Returns The RFC 2822 date and time in GMT that the resource was created.
*
* @return The RFC 2822 date and time in GMT that the resource was created
*/
public final ZonedDateTime getDateCreated() {
return this.dateCreated;
}
/**
* Returns The RFC 2822 date and time in GMT that the resource was last updated.
*
* @return The RFC 2822 date and time in GMT that the resource was last updated
*/
public final ZonedDateTime getDateUpdated() {
return this.dateUpdated;
}
/**
* Returns The duration of the transcribed audio in seconds..
*
* @return The duration of the transcribed audio in seconds.
*/
public final String getDuration() {
return this.duration;
}
/**
* Returns The charge for the transcription.
*
* @return The charge for the transcription
*/
public final BigDecimal getPrice() {
return this.price;
}
/**
* Returns The currency in which price is measured.
*
* @return The currency in which price is measured
*/
public final Currency getPriceUnit() {
return this.priceUnit;
}
/**
* Returns The SID that identifies the transcription's recording.
*
* @return The SID that identifies the transcription's recording
*/
public final String getRecordingSid() {
return this.recordingSid;
}
/**
* 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 status of the transcription.
*
* @return The status of the transcription
*/
public final Transcription.Status getStatus() {
return this.status;
}
/**
* Returns The text content of the transcription..
*
* @return The text content of the transcription.
*/
public final String getTranscriptionText() {
return this.transcriptionText;
}
/**
* Returns The transcription type.
*
* @return The transcription type
*/
public final String getType() {
return this.type;
}
/**
* Returns The URI of the resource, relative to `https://api.twilio.com`.
*
* @return The URI of the resource, relative to `https://api.twilio.com`
*/
public final String getUri() {
return this.uri;
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Transcription other = (Transcription) o;
return Objects.equals(accountSid, other.accountSid) &&
Objects.equals(apiVersion, other.apiVersion) &&
Objects.equals(dateCreated, other.dateCreated) &&
Objects.equals(dateUpdated, other.dateUpdated) &&
Objects.equals(duration, other.duration) &&
Objects.equals(price, other.price) &&
Objects.equals(priceUnit, other.priceUnit) &&
Objects.equals(recordingSid, other.recordingSid) &&
Objects.equals(sid, other.sid) &&
Objects.equals(status, other.status) &&
Objects.equals(transcriptionText, other.transcriptionText) &&
Objects.equals(type, other.type) &&
Objects.equals(uri, other.uri);
}
@Override
public int hashCode() {
return Objects.hash(accountSid,
apiVersion,
dateCreated,
dateUpdated,
duration,
price,
priceUnit,
recordingSid,
sid,
status,
transcriptionText,
type,
uri);
}
}