com.twilio.sdk.resource.instance.pricing.PhoneNumberCountry 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.pricing;

import com.twilio.sdk.TwilioPricingClient;
import com.twilio.sdk.resource.NextGenInstanceResource;
import org.apache.commons.lang3.builder.EqualsBuilder;
import org.apache.commons.lang3.builder.HashCodeBuilder;

import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

/**
 * Pricing information for Phone Numbers in a specific country.
 * 
 * For more information see the Twilio REST API documentation.
 */
public class PhoneNumberCountry extends NextGenInstanceResource {

	public PhoneNumberCountry(final TwilioPricingClient client) {
		super(client);
	}

	public PhoneNumberCountry(final TwilioPricingClient client, final Map properties) {
		super(client, properties);
	}

	public PhoneNumberCountry(final TwilioPricingClient client, final String isoCountry) {
		super(client);
		if (isoCountry == null || "".equals(isoCountry)) {
			throw new IllegalArgumentException("isoCountry cannot be null");
		}
		setProperty("iso_country", isoCountry);
	}

	/**
	 * Get an abbreviated identifier for the country this pricing information applies to.
	 *
	 * @return the ISO 3166-1 alpha-2 country code
	 */
	public String getIsoCountry() {
		return getProperty("iso_country");
	}

	/**
	 * Get the name of the country this pricing information applies to.
	 *
	 * @return the country name
	 */
	public String getCountry() {
		return getProperty("country");
	}

	/**
	 * Get the currency unit for this pricing information.
	 *
	 * @return A string representing the currency information, e.g. "USD" for US Dollars.
	 */
	public String getPriceUnit() {
		return getProperty("price_unit");
	}

	/**
	 * Get a list of prices for available phone number types in this country.
	 * 
	 * Twilio Phone Numbers are priced per month, and each price object will contain the price for a specific type of
	 * phone number (e.g. mobile, local, toll-free) both before and after any discounts available for the requesting
	 * account are applied.
	 *
	 * @return A list of objects with phone number pricing information.
	 */
	public List getPhoneNumberPrices() {
		List> priceData = getCastedObject("phone_number_prices");
		List prices = new ArrayList();

 		for (Map p : priceData) {
			prices.add(new NumberPrice(
				NumberType.valueOf(p.get("number_type").replace(' ', '_').toUpperCase()),
				new BigDecimal(p.get("base_price")),
				new BigDecimal(p.get("current_price"))));
			}
		return prices;
	}

	protected String getResourceLocation() {
		return "/" + TwilioPricingClient.DEFAULT_VERSION + "/PhoneNumbers/Countries/" + getIsoCountry();
	}

	public class NumberPrice {
		private final NumberType numberType;
		private final BigDecimal basePrice;
		private final BigDecimal currentPrice;

		public NumberPrice(final NumberType numberType, final BigDecimal basePrice, final BigDecimal currentPrice) {
			this.numberType = numberType;
			this.basePrice = basePrice;
			this.currentPrice = currentPrice;
		}

		/**
		 * The type of number for which this price applies,
		 * e.g. NumberType.MOBILE
		 * @return The number type
		 */
		public NumberType getNumberType() {
			return numberType;
		}

		/**
		 * The price per minute for inbound calls to numbers of this type,
		 * before discounts have been applied.
		 * @return Base inbound call price/minute.
		 */
		public BigDecimal getBasePrice() {
			return basePrice;
		}

		/**
		 * The price per minute for inbound calls to numbers of this type,
		 * after available discounts have been applied.
		 * @return Discounted inbound call price/minute.
		 */
		public BigDecimal getCurrentPrice() {
			return currentPrice;
		}

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

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

			NumberPrice that = (NumberPrice) o;
			return new EqualsBuilder()
					.append(basePrice, that.basePrice)
					.append(currentPrice, that.currentPrice)
					.append(numberType, that.numberType)
					.isEquals();
		}

		@Override
		public int hashCode() {
			return new HashCodeBuilder()
					.append(numberType)
					.append(basePrice)
					.append(currentPrice)
					.toHashCode();
		}
	}


}