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

com.twilio.rest.proxy.v1.service.ShortCode Maven / Gradle / Ivy

There is a newer version: 7.9.1
Show newest version
/**
 * 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.google.common.base.MoreObjects;
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 org.joda.time.DateTime;

import java.io.IOException;
import java.io.InputStream;
import java.net.URI;
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)
public class ShortCode extends Resource {
    private static final long serialVersionUID = 62346607367423L;

    /**
     * Create a ShortCodeCreator to execute create.
     * 
     * @param pathServiceSid Service Sid.
     * @param sid A string that uniquely identifies this Short Code.
     * @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 Service Sid.
     * @param pathSid A string that uniquely identifies this Short Code.
     * @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 Service Sid.
     * @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 Service Sid.
     * @param pathSid A string that uniquely identifies this Short Code.
     * @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 Service Sid.
     * @param pathSid A string that uniquely identifies this Short Code.
     * @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 DateTime dateCreated;
    private final DateTime 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 A string that uniquely identifies this Short Code..
     * 
     * @return A string that uniquely identifies this Short Code.
     */
    public final String getSid() {
        return this.sid;
    }

    /**
     * Returns The Account Sid..
     * 
     * @return Account Sid.
     */
    public final String getAccountSid() {
        return this.accountSid;
    }

    /**
     * Returns The Service Sid..
     * 
     * @return Service Sid.
     */
    public final String getServiceSid() {
        return this.serviceSid;
    }

    /**
     * Returns The The date this Short Code was added to the service.
     * 
     * @return The date this Short Code was added to the service
     */
    public final DateTime getDateCreated() {
        return this.dateCreated;
    }

    /**
     * Returns The The date this Short Code was updated.
     * 
     * @return The date this Short Code was updated
     */
    public final DateTime getDateUpdated() {
        return this.dateUpdated;
    }

    /**
     * Returns The Shortcode..
     * 
     * @return Shortcode.
     */
    public final String getShortCode() {
        return this.shortCode;
    }

    /**
     * Returns The ISO Country Code,.
     * 
     * @return ISO Country Code,
     */
    public final String getIsoCountry() {
        return this.isoCountry;
    }

    /**
     * Returns The A list of capabilities..
     * 
     * @return A list of capabilities.
     */
    public final PhoneNumberCapabilities getCapabilities() {
        return this.capabilities;
    }

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

    /**
     * Returns The Reserve for manual assignment to participants only..
     * 
     * @return Reserve 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);
    }

    @Override
    public String toString() {
        return MoreObjects.toStringHelper(this)
                          .add("sid", sid)
                          .add("accountSid", accountSid)
                          .add("serviceSid", serviceSid)
                          .add("dateCreated", dateCreated)
                          .add("dateUpdated", dateUpdated)
                          .add("shortCode", shortCode)
                          .add("isoCountry", isoCountry)
                          .add("capabilities", capabilities)
                          .add("url", url)
                          .add("isReserved", isReserved)
                          .toString();
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy