com.twilio.rest.proxy.v1.service.ShortCode Maven / Gradle / Ivy
/**
* This code was generated by
* \ / _ _ _| _ _
* | (_)\/(_)(_|\/| |(/_ v1.0.0
* / /
*/
package com.twilio.rest.proxy.v1.service;
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.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 com.twilio.type.PhoneNumberCapabilities;
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;
/**
* PLEASE NOTE that this class contains beta products that are subject to
* change. Use them with caution.
*/
@JsonIgnoreProperties(ignoreUnknown = true)
@ToString
public class ShortCode extends Resource {
private static final long serialVersionUID = 62346607367423L;
/**
* Create a ShortCodeCreator to execute create.
*
* @param pathServiceSid The SID of the parent Service resource
* @param sid The SID of a Twilio ShortCode resource
* @return ShortCodeCreator capable of executing the create
*/
public static ShortCodeCreator creator(final String pathServiceSid,
final String sid) {
return new ShortCodeCreator(pathServiceSid, sid);
}
/**
* Create a ShortCodeDeleter to execute delete.
*
* @param pathServiceSid The SID of the parent Service to delete the ShortCode
* resource from
* @param pathSid The unique string that identifies the resource
* @return ShortCodeDeleter capable of executing the delete
*/
public static ShortCodeDeleter deleter(final String pathServiceSid,
final String pathSid) {
return new ShortCodeDeleter(pathServiceSid, pathSid);
}
/**
* Create a ShortCodeReader to execute read.
*
* @param pathServiceSid The SID of the parent Service to read the resource from
* @return ShortCodeReader capable of executing the read
*/
public static ShortCodeReader reader(final String pathServiceSid) {
return new ShortCodeReader(pathServiceSid);
}
/**
* Create a ShortCodeFetcher to execute fetch.
*
* @param pathServiceSid The SID of the parent Service to fetch the resource
* from
* @param pathSid The unique string that identifies the resource
* @return ShortCodeFetcher capable of executing the fetch
*/
public static ShortCodeFetcher fetcher(final String pathServiceSid,
final String pathSid) {
return new ShortCodeFetcher(pathServiceSid, pathSid);
}
/**
* Create a ShortCodeUpdater to execute update.
*
* @param pathServiceSid The SID of the Service to update the resource from
* @param pathSid The unique string that identifies the resource
* @return ShortCodeUpdater capable of executing the update
*/
public static ShortCodeUpdater updater(final String pathServiceSid,
final String pathSid) {
return new ShortCodeUpdater(pathServiceSid, pathSid);
}
/**
* Converts a JSON String into a ShortCode object using the provided
* ObjectMapper.
*
* @param json Raw JSON String
* @param objectMapper Jackson ObjectMapper
* @return ShortCode object represented by the provided JSON
*/
public static ShortCode fromJson(final String json, final ObjectMapper objectMapper) {
// Convert all checked exceptions to Runtime
try {
return objectMapper.readValue(json, ShortCode.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 ShortCode object using the provided
* ObjectMapper.
*
* @param json Raw JSON InputStream
* @param objectMapper Jackson ObjectMapper
* @return ShortCode object represented by the provided JSON
*/
public static ShortCode fromJson(final InputStream json, final ObjectMapper objectMapper) {
// Convert all checked exceptions to Runtime
try {
return objectMapper.readValue(json, ShortCode.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 sid;
private final String accountSid;
private final String serviceSid;
private final ZonedDateTime dateCreated;
private final ZonedDateTime dateUpdated;
private final String shortCode;
private final String isoCountry;
private final PhoneNumberCapabilities capabilities;
private final URI url;
private final Boolean isReserved;
@JsonCreator
private ShortCode(@JsonProperty("sid")
final String sid,
@JsonProperty("account_sid")
final String accountSid,
@JsonProperty("service_sid")
final String serviceSid,
@JsonProperty("date_created")
final String dateCreated,
@JsonProperty("date_updated")
final String dateUpdated,
@JsonProperty("short_code")
final String shortCode,
@JsonProperty("iso_country")
final String isoCountry,
@JsonProperty("capabilities")
final PhoneNumberCapabilities capabilities,
@JsonProperty("url")
final URI url,
@JsonProperty("is_reserved")
final Boolean isReserved) {
this.sid = sid;
this.accountSid = accountSid;
this.serviceSid = serviceSid;
this.dateCreated = DateConverter.iso8601DateTimeFromString(dateCreated);
this.dateUpdated = DateConverter.iso8601DateTimeFromString(dateUpdated);
this.shortCode = shortCode;
this.isoCountry = isoCountry;
this.capabilities = capabilities;
this.url = url;
this.isReserved = isReserved;
}
/**
* 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 Account that created the resource.
*
* @return The SID of the Account that created the resource
*/
public final String getAccountSid() {
return this.accountSid;
}
/**
* Returns The SID of the resource's parent Service.
*
* @return The SID of the resource's parent Service
*/
public final String getServiceSid() {
return this.serviceSid;
}
/**
* 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 short code's number.
*
* @return The short code's number
*/
public final String getShortCode() {
return this.shortCode;
}
/**
* Returns The ISO Country Code.
*
* @return The ISO Country Code
*/
public final String getIsoCountry() {
return this.isoCountry;
}
/**
* Returns The capabilities of the short code.
*
* @return The capabilities of the short code
*/
public final PhoneNumberCapabilities getCapabilities() {
return this.capabilities;
}
/**
* Returns The absolute URL of the ShortCode resource.
*
* @return The absolute URL of the ShortCode resource
*/
public final URI getUrl() {
return this.url;
}
/**
* Returns Whether the short code should be reserved for manual assignment to
* participants only.
*
* @return Whether the short code should be reserved for manual assignment to
* participants only
*/
public final Boolean getIsReserved() {
return this.isReserved;
}
@Override
public boolean equals(final Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ShortCode other = (ShortCode) o;
return Objects.equals(sid, other.sid) &&
Objects.equals(accountSid, other.accountSid) &&
Objects.equals(serviceSid, other.serviceSid) &&
Objects.equals(dateCreated, other.dateCreated) &&
Objects.equals(dateUpdated, other.dateUpdated) &&
Objects.equals(shortCode, other.shortCode) &&
Objects.equals(isoCountry, other.isoCountry) &&
Objects.equals(capabilities, other.capabilities) &&
Objects.equals(url, other.url) &&
Objects.equals(isReserved, other.isReserved);
}
@Override
public int hashCode() {
return Objects.hash(sid,
accountSid,
serviceSid,
dateCreated,
dateUpdated,
shortCode,
isoCountry,
capabilities,
url,
isReserved);
}
}© 2015 - 2025 Weber Informatics LLC | Privacy Policy