Skip to content

Commit ba6e519

Browse files
jon-signaljon-signal
committed
[fix!]: add BigDecimal getters for prices and deprecate double getters
1 parent cee6614 commit ba6e519

File tree

9 files changed

+191
-17
lines changed

9 files changed

+191
-17
lines changed

‎src/main/java/com/twilio/type/InboundCallPrice.java‎

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import com.twilio.converter.Promoter;
77
import lombok.ToString;
88

9+
import java.math.BigDecimal;
910
import java.util.Objects;
1011

1112
/**
@@ -41,8 +42,8 @@ public static Type forValue(final String value) {
4142
}
4243
}
4344

44-
private final double basePrice;
45-
private final double currentPrice;
45+
private final BigDecimal basePrice;
46+
private final BigDecimal currentPrice;
4647
private final Type type;
4748

4849
/**
@@ -53,19 +54,57 @@ public static Type forValue(final String value) {
5354
* @param type type of phone number
5455
*/
5556
@JsonCreator
56-
public InboundCallPrice(@JsonProperty("base_price") final double basePrice,
57-
@JsonProperty("current_price") final double currentPrice,
57+
public InboundCallPrice(@JsonProperty("base_price") final BigDecimal basePrice,
58+
@JsonProperty("current_price") final BigDecimal currentPrice,
5859
@JsonProperty("number_type") final Type type) {
5960
this.basePrice = basePrice;
6061
this.currentPrice = currentPrice;
6162
this.type = type;
6263
}
6364

65+
/**
66+
* Returns the retail price per minute to receive a call to this phone number type. The value returned by this
67+
* method is represented as a {@code double}, which may result in loss of precision.
68+
*
69+
* @return the retail price per minute to receive a call to this phone number type
70+
*
71+
* @deprecated please use {{@link #getBasePriceDecimal()}} instead for a lossless representation of the price
72+
*/
73+
@Deprecated
6474
public double getBasePrice() {
75+
return basePrice.doubleValue();
76+
}
77+
78+
/**
79+
* Returns the retail price per minute to receive a call to this phone number type.
80+
*
81+
* @return the retail price per minute to receive a call to this phone number type
82+
*/
83+
public BigDecimal getBasePriceDecimal() {
6584
return basePrice;
6685
}
6786

87+
/**
88+
* Returns the current price per minute (which accounts for any volume or custom price discounts) to receive a call
89+
* to this phone number type. The value returned by this method is represented as a {@code double}, which may result
90+
* in loss of precision.
91+
*
92+
* @return the current price per minute to receive a call to this phone number type
93+
*
94+
* @deprecated please use {{@link #getCurrentPriceDecimal()} instead for a lossless representation of the price
95+
*/
96+
@Deprecated
6897
public double getCurrentPrice() {
98+
return currentPrice.doubleValue();
99+
}
100+
101+
/**
102+
* Returns the current price per minute (which accounts for any volume or custom price discounts) to receive a call
103+
* to this phone number type.
104+
*
105+
* @return the current price per minute to receive a call to this phone number type
106+
*/
107+
public BigDecimal getCurrentPriceDecimal() {
69108
return currentPrice;
70109
}
71110

‎src/main/java/com/twilio/type/InboundSmsPrice.java‎

Lines changed: 41 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
import com.twilio.converter.Promoter;
77
import lombok.ToString;
88

9+
import java.math.BigDecimal;
910
import java.util.Objects;
1011

1112
/**
@@ -42,8 +43,8 @@ public static Type forValue(final String value) {
4243
}
4344
}
4445

45-
private final double basePrice;
46-
private final double currentPrice;
46+
private final BigDecimal basePrice;
47+
private final BigDecimal currentPrice;
4748
private final Type type;
4849

4950
/**
@@ -54,19 +55,55 @@ public static Type forValue(final String value) {
5455
* @param type type of phone number
5556
*/
5657
@JsonCreator
57-
public InboundSmsPrice(@JsonProperty("base_price") final double basePrice,
58-
@JsonProperty("current_price") final double currentPrice,
58+
public InboundSmsPrice(@JsonProperty("base_price") final BigDecimal basePrice,
59+
@JsonProperty("current_price") final BigDecimal currentPrice,
5960
@JsonProperty("number_type") final Type type) {
6061
this.basePrice = basePrice;
6162
this.currentPrice = currentPrice;
6263
this.type = type;
6364
}
6465

66+
/**
67+
* Returns the retail price to receive a message. The value returned by this method is represented as a
68+
* {@code double}, which may result in loss of precision.
69+
*
70+
* @return the retail price to receive a message
71+
*
72+
* @deprecated please use {{@link #getBasePriceDecimal()}} instead for a lossless representation of the price
73+
*/
74+
@Deprecated
6575
public double getBasePrice() {
76+
return basePrice.doubleValue();
77+
}
78+
79+
/**
80+
* Returns the retail price to receive a message.
81+
*
82+
* @return the retail price to receive a message
83+
*/
84+
public BigDecimal getBasePriceDecimal() {
6685
return basePrice;
6786
}
6887

88+
/**
89+
* Returns the current price (which accounts for any volume or custom price discounts) to receive a message. The
90+
* value returned by this method is represented as a {@code double}, which may result in loss of precision.
91+
*
92+
* @return the current price to receive a message
93+
*
94+
* @deprecated please use {{@link #getCurrentPriceDecimal()} instead for a lossless representation of the price
95+
*/
96+
@Deprecated
6997
public double getCurrentPrice() {
98+
return currentPrice.doubleValue();
99+
}
100+
101+
/**
102+
* Returns the current price (which accounts for any volume or custom price discounts) to receive a message.
103+
*
104+
* @return the current price to receive a message
105+
*/
106+
public BigDecimal getCurrentPriceDecimal() {
70107
return currentPrice;
71108
}
72109

‎src/main/java/com/twilio/type/OutboundCallPrice.java‎

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,26 +5,65 @@
55
import com.fasterxml.jackson.annotation.JsonProperty;
66
import lombok.ToString;
77

8+
import java.math.BigDecimal;
89
import java.util.Objects;
910

1011
@JsonIgnoreProperties(ignoreUnknown = true)
1112
@ToString
1213
public class OutboundCallPrice {
13-
private final double basePrice;
14-
private final double currentPrice;
14+
private final BigDecimal basePrice;
15+
private final BigDecimal currentPrice;
1516

1617
@JsonCreator
17-
public OutboundCallPrice(@JsonProperty("base_price") final double basePrice,
18-
@JsonProperty("current_price") final double currentPrice) {
18+
public OutboundCallPrice(@JsonProperty("base_price") final BigDecimal basePrice,
19+
@JsonProperty("current_price") final BigDecimal currentPrice) {
1920
this.basePrice = basePrice;
2021
this.currentPrice = currentPrice;
2122
}
2223

24+
/**
25+
* Returns the retail price per minute to make a call from this phone number type. The value returned by this
26+
* method is represented as a {@code double}, which may result in loss of precision.
27+
*
28+
* @return the retail price per minute to make a call from this phone number type
29+
*
30+
* @deprecated please use {{@link #getBasePriceDecimal()}} instead for a lossless representation of the price
31+
*/
32+
@Deprecated
2333
public double getBasePrice() {
34+
return basePrice.doubleValue();
35+
}
36+
37+
/**
38+
* Returns the retail price per minute to make a call from this phone number type.
39+
*
40+
* @return the retail price per minute to make a call from this phone number type
41+
*/
42+
public BigDecimal getBasePriceDecimal() {
2443
return basePrice;
2544
}
2645

46+
/**
47+
* Returns the current price per minute (which accounts for any volume or custom price discounts) to make a call
48+
* from this phone number type. The value returned by this method is represented as a {@code double}, which may
49+
* result in loss of precision.
50+
*
51+
* @return the current price per minute to make a call from this phone number type
52+
*
53+
* @deprecated please use {{@link #getCurrentPriceDecimal()} instead for a lossless representation of the price
54+
*/
55+
@Deprecated
2756
public double getCurrentPrice() {
57+
return currentPrice.doubleValue();
58+
}
59+
60+
/**
61+
* Returns the current price per minute (which accounts for any volume or custom price discounts) to make a call
62+
* from this phone number type.
63+
*
64+
* @return the current price per minute to make a call from this phone number type
65+
*/
66+
public BigDecimal getCurrentPriceDecimal() {
2867
return currentPrice;
2968
}
3069

‎src/main/java/com/twilio/type/OutboundPrefixPrice.java‎

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
import com.fasterxml.jackson.annotation.JsonProperty;
66
import lombok.ToString;
77

8+
import java.math.BigDecimal;
89
import java.util.List;
910
import java.util.Objects;
1011

@@ -22,8 +23,8 @@ public class OutboundPrefixPrice {
2223

2324
private final List<String> prefixes;
2425
private final String friendlyName;
25-
private final double basePrice;
26-
private final double currentPrice;
26+
private final BigDecimal basePrice;
27+
private final BigDecimal currentPrice;
2728

2829
/**
2930
* Initialize an OutboundPrefixPrice.
@@ -36,8 +37,8 @@ public class OutboundPrefixPrice {
3637
@JsonCreator
3738
public OutboundPrefixPrice(@JsonProperty("prefixes") final List<String> prefixes,
3839
@JsonProperty("friendly_name") final String friendlyName,
39-
@JsonProperty("base_price") final double basePrice,
40-
@JsonProperty("current_price") final double currentPrice) {
40+
@JsonProperty("base_price") final BigDecimal basePrice,
41+
@JsonProperty("current_price") final BigDecimal currentPrice) {
4142
this.prefixes = prefixes;
4243
this.friendlyName = friendlyName;
4344
this.basePrice = basePrice;
@@ -52,11 +53,49 @@ public String getFriendlyName() {
5253
return friendlyName;
5354
}
5455

56+
/**
57+
* Returns the retail price per minute to make a call to numbers matching this prefix list. The value returned by
58+
* this method is represented as a {@code double}, which may result in loss of precision.
59+
*
60+
* @return the retail price per minute to make a call to numbers matching this prefix list
61+
*
62+
* @deprecated please use {{@link #getBasePriceDecimal()}} instead for a lossless representation of the price
63+
*/
64+
@Deprecated
5565
public double getBasePrice() {
66+
return basePrice.doubleValue();
67+
}
68+
69+
/**
70+
* Returns the retail price per minute to make a call to numbers matching this prefix list.
71+
*
72+
* @return the retail price per minute to make a call to numbers matching this prefix list
73+
*/
74+
public BigDecimal getBasePriceDecimal() {
5675
return basePrice;
5776
}
5877

78+
/**
79+
* Returns the current price per minute (which accounts for any volume or custom price discounts) to make a call to
80+
* numbers matching this prefix list. The value returned by this method is represented as a {@code double}, which
81+
* may result in loss of precision.
82+
*
83+
* @return the current price per minute to make a call to numbers matching this prefix list
84+
*
85+
* @deprecated please use {{@link #getCurrentPriceDecimal()} instead for a lossless representation of the price
86+
*/
87+
@Deprecated
5988
public double getCurrentPrice() {
89+
return currentPrice.doubleValue();
90+
}
91+
92+
/**
93+
* Returns the current price per minute (which accounts for any volume or custom price discounts) to make a call to
94+
* numbers matching this prefix list.
95+
*
96+
* @return the current price per minute to make a call to numbers matching this prefix list
97+
*/
98+
public BigDecimal getCurrentPriceDecimal() {
6099
return currentPrice;
61100
}
62101

‎src/test/java/com/twilio/type/InboundCallPriceTest.java‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import org.junit.Test;
55

66
import java.io.IOException;
7+
import java.math.BigDecimal;
78

89
/**
910
* Test class for {@link InboundCallPrice}.
@@ -21,6 +22,8 @@ public void testFromJson() throws IOException {
2122
InboundCallPrice icp = fromJson(json, InboundCallPrice.class);
2223
Assert.assertEquals(1.00, icp.getBasePrice(), 0.00);
2324
Assert.assertEquals(2.00, icp.getCurrentPrice(), 0.00);
25+
Assert.assertEquals(new BigDecimal("1.00"), icp.getBasePriceDecimal());
26+
Assert.assertEquals(new BigDecimal("2.00"), icp.getCurrentPriceDecimal());
2427
Assert.assertEquals(InboundCallPrice.Type.MOBILE, icp.getType());
2528
}
2629

@@ -35,6 +38,8 @@ public void testFromJsonTollFree() throws IOException {
3538
InboundCallPrice icp = fromJson(json, InboundCallPrice.class);
3639
Assert.assertEquals(1.00, icp.getBasePrice(), 0.00);
3740
Assert.assertEquals(2.00, icp.getCurrentPrice(), 0.00);
41+
Assert.assertEquals(new BigDecimal("1.00"), icp.getBasePriceDecimal());
42+
Assert.assertEquals(new BigDecimal("2.00"), icp.getCurrentPriceDecimal());
3843
Assert.assertEquals(InboundCallPrice.Type.TOLLFREE, icp.getType());
3944
}
4045

@@ -50,6 +55,8 @@ public void testFromJsonExtraField() throws IOException {
5055
InboundCallPrice icp = fromJson(json, InboundCallPrice.class);
5156
Assert.assertEquals(1.00, icp.getBasePrice(), 0.00);
5257
Assert.assertEquals(2.00, icp.getCurrentPrice(), 0.00);
58+
Assert.assertEquals(new BigDecimal("1.00"), icp.getBasePriceDecimal());
59+
Assert.assertEquals(new BigDecimal("2.00"), icp.getCurrentPriceDecimal());
5360
Assert.assertEquals(InboundCallPrice.Type.TOLLFREE, icp.getType());
5461
}
5562
}

‎src/test/java/com/twilio/type/InboundSmsPriceTest.java‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import org.junit.Test;
55

66
import java.io.IOException;
7+
import java.math.BigDecimal;
78

89
/**
910
* Test class for {@link InboundSmsPrice}.
@@ -21,6 +22,8 @@ public void testFromJson() throws IOException {
2122
InboundSmsPrice icp = fromJson(json, InboundSmsPrice.class);
2223
Assert.assertEquals(1.00, icp.getBasePrice(), 0.00);
2324
Assert.assertEquals(2.00, icp.getCurrentPrice(), 0.00);
25+
Assert.assertEquals(new BigDecimal("1.00"), icp.getBasePriceDecimal());
26+
Assert.assertEquals(new BigDecimal("2.00"), icp.getCurrentPriceDecimal());
2427
Assert.assertEquals(InboundSmsPrice.Type.MOBILE, icp.getType());
2528
}
2629

@@ -35,6 +38,8 @@ public void testFromJsonTollFree() throws IOException {
3538
InboundSmsPrice icp = fromJson(json, InboundSmsPrice.class);
3639
Assert.assertEquals(1.00, icp.getBasePrice(), 0.00);
3740
Assert.assertEquals(2.00, icp.getCurrentPrice(), 0.00);
41+
Assert.assertEquals(new BigDecimal("1.00"), icp.getBasePriceDecimal());
42+
Assert.assertEquals(new BigDecimal("2.00"), icp.getCurrentPriceDecimal());
3843
Assert.assertEquals(InboundSmsPrice.Type.TOLLFREE, icp.getType());
3944
}
4045
}

‎src/test/java/com/twilio/type/OutboundCallPriceTest.java‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import org.junit.Test;
55

66
import java.io.IOException;
7+
import java.math.BigDecimal;
78

89
/**
910
* Test class for {@link OutboundCallPrice}.
@@ -20,5 +21,7 @@ public void testFromJson() throws IOException {
2021
OutboundCallPrice ocp = fromJson(json, OutboundCallPrice.class);
2122
Assert.assertEquals(1.00, ocp.getBasePrice(), 0.00);
2223
Assert.assertEquals(2.00, ocp.getCurrentPrice(), 0.00);
24+
Assert.assertEquals(new BigDecimal("1.00"), ocp.getBasePriceDecimal());
25+
Assert.assertEquals(new BigDecimal("2.00"), ocp.getCurrentPriceDecimal());
2326
}
2427
}

‎src/test/java/com/twilio/type/OutboundPrefixPriceTest.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import org.junit.Test;
55

66
import java.io.IOException;
7+
import java.math.BigDecimal;
78
import java.util.Arrays;
89

910
/**
@@ -28,5 +29,8 @@ public void testFromJson() throws IOException {
2829
Assert.assertEquals("name", opp.getFriendlyName());
2930
Assert.assertEquals(1.00, opp.getBasePrice(), 0.00);
3031
Assert.assertEquals(2.00, opp.getCurrentPrice(), 0.00);
32+
Assert.assertEquals(new BigDecimal("1.00"), opp.getBasePriceDecimal());
33+
Assert.assertEquals(new BigDecimal("2.00"), opp.getCurrentPriceDecimal());
34+
3135
}
3236
}

0 commit comments

Comments
 (0)