com.twilio.sdk.resource.instance.Application Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of twilio-java-sdk Show documentation
Release Candidate for Next-Gen Twilio Java Helper Library
There is a newer version: 7.0.0-rc-10
package com.twilio.sdk.resource.instance;

import com.twilio.sdk.TwilioRestClient;
import com.twilio.sdk.TwilioRestException;
import com.twilio.sdk.TwilioRestResponse;
import com.twilio.sdk.resource.InstanceResource;

import java.util.Date;
import java.util.Map;

// TODO: Auto-generated Javadoc
/**
 * The Class Application.
 *
 * For more information see https://www.twilio.com/docs/api/rest/applications
 */
public class Application extends InstanceResource {

    /** The Constant STATUS_PROPERTY. */
    private static final String STATUS_PROPERTY = "status";

    /** The Constant FRIENDLY_NAME_PROPERTY. */
    private static final String FRIENDLY_NAME_PROPERTY = "friendly_name";

    /**
     * Instantiates a new application.
     *
     * @param client
     *            the client
     */
    public Application(TwilioRestClient client) {
        super(client);
    }

    /**
     * Instantiates a new application.
     *
     * @param client
     *            the client
     * @param sid
     *            the sid
     */
    public Application(TwilioRestClient client, String sid) {
        super(client);
        if (sid == null) {
            throw new IllegalStateException("The Sid for an Application can not be null");
        }
        this.setProperty(SID_PROPERTY, sid);
    }

    /**
     * Instantiates a new application.
     *
     * @param client
     *            the client
     * @param properties
     *            the properties
     */
    public Application(TwilioRestClient client, Map properties) {
        super(client, properties);
    }

    /*
     * (non-Javadoc)
     *
     * @see com.twilio.sdk.resource.Resource#getResourceLocation()
     */
    @Override
    protected String getResourceLocation() {
        return "/" + TwilioRestClient.DEFAULT_VERSION + "/Accounts/"
                + this.getRequestAccountSid() + "/Applications/" + this.getSid() + ".json";
    }

    /*
     * Property getters
     */
    /**
     * Gets the sid.
     *
     * @return the sid
     */
    public String getSid() {
        return this.getProperty(SID_PROPERTY);
    }

    /**
     * Gets the friendly name.
     *
     * @return the friendly name
     */
    public String getFriendlyName() {
        return this.getProperty(FRIENDLY_NAME_PROPERTY);
    }

    /**
     * Gets the status.
     *
     * @return the status
     */
    public String getStatus() {
        return this.getProperty(STATUS_PROPERTY);
    }

    /**
     * Gets the date created.
     *
     * @return the date created
     */
    public Date getDateCreated() {
        return getDateProperty(DATE_CREATED_PROPERTY);
    }

    /**
     * Gets the date updated.
     *
     * @return the date updated
     */
    public Date getDateUpdated() {
        return getDateProperty(DATE_UPDATED_PROPERTY);
    }

    /**
     * Gets the account sid.
     *
     * @return the account sid
     */
    public String getAccountSid() {
        return this.getProperty("account_sid");
    }

    /**
     * Gets the api version.
     *
     * @return the api version
     */
    public String getApiVersion() {
        return this.getProperty("api_version");
    }

    /**
     * Gets the voice url.
     *
     * @return the voice url
     */
    public String getVoiceUrl() {
        return this.getProperty("voice_url");
    }

    /**
     * Gets the voice method.
     *
     * @return the voice method
     */
    public String getVoiceMethod() {
        return this.getProperty("voice_method");
    }

    /**
     * Gets the voice fallback url.
     *
     * @return the voice fallback url
     */
    public String getVoiceFallbackUrl() {
        return this.getProperty("voice_fallback_url");
    }

    /**
     * Gets the voice fallback method.
     *
     * @return the voice fallback method
     */
    public String getVoiceFallbackMethod() {
        return this.getProperty("voice_fallback_method");
    }

    /**
     * Gets the status callback.
     *
     * @return the status callback
     */
    public String getStatusCallback() {
        return this.getProperty("status_callback");
    }

    /**
     * Gets the status callback method.
     *
     * @return the status callback method
     */
    public String getStatusCallbackMethod() {
        return this.getProperty("status_callback_method");
    }

    /**
     * Gets the voice caller id lookup.
     *
     * @return the voice caller id lookup
     */
    public String getVoiceCallerIdLookup() {
        return this.getProperty("voice_caller_id_lookup");
    }

    /**
     * Gets the sms url.
     *
     * @return the sms url
     */
    public String getSmsUrl() {
        return this.getProperty("sms_url");
    }

    /**
     * Gets the sms method.
     *
     * @return the sms method
     */
    public String getSmsMethod() {
        return this.getProperty("sms_method_url");
    }

    /**
     * Gets the sms fallback url.
     *
     * @return the sms fallback url
     */
    public String getSmsFallbackUrl() {
        return this.getProperty("sms_fallback_url");
    }

    /**
     * Gets the sms fallback method.
     *
     * @return the sms fallback method
     */
    public String getSmsFallbackMethod() {
        return this.getProperty("sms_fallback_method");
    }

    /**
     * Gets the sms status callback.
     *
     * @return the sms status callback
     */
    public String getSmsStatusCallback() {
        return this.getProperty("sms_status_callback");
    }

    /**
     * Delete this {@link Application}. This will remove it from this {@link Account}, only if it is not currently
     * linked to an {@link IncomingPhoneNumber}.
     *
     * @throws TwilioRestException
     *             if there is an error in the request
     * @return true, if successful
     *
     */
    public boolean delete() throws TwilioRestException {
        TwilioRestResponse response = this.getClient().safeRequest(
                this.getResourceLocation(), "DELETE", (Map) null);

        return !response.isError();
    }

}