AV-4625 feat(us_verification): adding transient id field to us verifi…

…cation a… (#342)

* feat(us_verification): adding transient id field to us verification and bulk verification

* upgrading library version

docs/MultipleComponents.md

@@ -14,6 +14,7 @@ Name | Type | Description | Notes
 **city** | **String** |  |  [optional]
 **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. |  [optional]
 **zipCode** | **String** | Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`). |  [optional]
+**transientId** | **String** | ID that is returned in the response body for the verification  |  [optional]
 
 
 

docs/UsVerification.md

@@ -14,10 +14,12 @@ Name | Type | Description | Notes
 **urbanization** | **String** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification.  |  [optional]
 **lastLine** | **String** | Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`)  |  [optional]
 **deliverability** | [**DeliverabilityEnum**](#DeliverabilityEnum) | Summarizes the deliverability of the `us_verification` object. For full details, see the `deliverability_analysis` field. Possible values are: * `deliverable` – The address is deliverable by the USPS. * `deliverable_unnecessary_unit` – The address is deliverable, but the secondary unit information is unnecessary. * `deliverable_incorrect_unit` – The address is deliverable to the building's default address but the secondary unit provided may not exist. There is a chance the mail will not reach the intended recipient. * `deliverable_missing_unit` – The address is deliverable to the building's default address but is missing secondary unit information. There is a chance the mail will not reach the intended recipient. * `undeliverable` – The address is not deliverable according to the USPS.  |  [optional]
+**validAddress** | **Boolean** | This field indicates whether an address was found in a more comprehensive address dataset that includes sources from the USPS, open source mapping data, and our proprietary mail delivery data. This field can be interpreted as a representation of whether an address is a real location or not. Additionally a valid address may contradict the deliverability field since an address can be a real valid location but the USPS may not deliver to that address.  |  [optional]
 **components** | [**UsComponents**](UsComponents.md) |  |  [optional]
 **deliverabilityAnalysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) |  |  [optional]
 **lobConfidenceScore** | [**LobConfidenceScore**](LobConfidenceScore.md) |  |  [optional]
 **_object** | [**ObjectEnum**](#ObjectEnum) |  |  [optional]
+**transientId** | **String** | ID that is returned in the response body for the verification  |  [optional]
 
 
 

docs/UsVerificationOrError.md

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
 **deliverabilityAnalysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) |  |  [optional]
 **lobConfidenceScore** | [**LobConfidenceScore**](LobConfidenceScore.md) |  |  [optional]
 **_object** | [**ObjectEnum**](#ObjectEnum) |  |  [optional]
+**transientId** | **String** | ID that is returned in the response body for the verification  |  [optional]
 **error** | [**BulkError**](BulkError.md) |  |  [optional]
 
 

docs/UsVerificationsWritable.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **city** | **String** |  |  [optional]
 **state** | **String** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. |  [optional]
 **zipCode** | **String** | Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`). |  [optional]
+**transientId** | **String** | ID that is returned in the response body for the verification  |  [optional]
 
 
 

pom.xml

@@ -3,8 +3,7 @@
     <groupId>com.lob</groupId>
     <artifactId>lob-java</artifactId>
     <packaging>jar</packaging>
-    <version>13.4.4</version>
-
+    <version>13.4.5</version>
     <name>${project.groupId}:${project.artifactId}</name>
     <description>Parent pom for the Lob API Java Wrapper</description>
     <url>https://github.com/lob/lob-java</url>

src/main/java/com/lob/model/MultipleComponents.java

@@ -184,6 +184,27 @@ public void setZipCode (String zipCode) throws IllegalArgumentException {
 
 
 
+  public static final String SERIALIZED_NAME_TRANSIENT_ID = "transient_id";
+
+  @SerializedName(SERIALIZED_NAME_TRANSIENT_ID)
+
+
+  private String transientId;
+  /**
+  * ID that is returned in the response body for the verification 
+  * @return transientId
+  **/
+
+  @javax.annotation.Nullable
+
+  @ApiModelProperty(value = "ID that is returned in the response body for the verification ")
+
+  public String getTransientId() {
+      return transientId;
+  }
+
+
+
 
   /*
   public MultipleComponents recipient(String recipient) {
@@ -287,6 +308,21 @@ public MultipleComponents zipCode(String zipCode) {
 
 
 
+  /*
+  public MultipleComponents transientId(String transientId) {
+    
+    this.transientId = transientId;
+    return this;
+  }
+  */
+
+
+  public void setTransientId(String transientId) {
+    this.transientId = transientId;
+  }
+
+
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
@@ -302,7 +338,8 @@ public boolean equals(Object o) {
         Objects.equals(this.urbanization, multipleComponents.urbanization) &&
         Objects.equals(this.city, multipleComponents.city) &&
         Objects.equals(this.state, multipleComponents.state) &&
-        Objects.equals(this.zipCode, multipleComponents.zipCode);
+        Objects.equals(this.zipCode, multipleComponents.zipCode) &&
+        Objects.equals(this.transientId, multipleComponents.transientId);
   }
 
   private static <T> boolean equalsNullable(JsonNullable<T> a, JsonNullable<T> b) {
@@ -311,7 +348,7 @@ private static <T> boolean equalsNullable(JsonNullable<T> a, JsonNullable<T> b)
 
   @Override
   public int hashCode() {
-    return Objects.hash(recipient, primaryLine, secondaryLine, urbanization, city, state, zipCode);
+    return Objects.hash(recipient, primaryLine, secondaryLine, urbanization, city, state, zipCode, transientId);
   }
 
   private static <T> int hashCodeNullable(JsonNullable<T> a) {
@@ -332,6 +369,7 @@ public String toString() {
     sb.append("    city: ").append(toIndentedString(city)).append("\n");
     sb.append("    state: ").append(toIndentedString(state)).append("\n");
     sb.append("    zipCode: ").append(toIndentedString(zipCode)).append("\n");
+    sb.append("    transientId: ").append(toIndentedString(transientId)).append("\n");
     sb.append("}");
     return sb.toString();
   }
@@ -345,6 +383,7 @@ public Map<String, Object> toMap() {
       localMap.put("city", city);
       localMap.put("state", state);
       localMap.put("zip_code", zipCode);
+      localMap.put("transient_id", transientId);
       return localMap;
     }
 

src/main/java/com/lob/model/UsVerification.java

@@ -390,6 +390,27 @@ public ObjectEnum getObject() {
 
 
 
+  public static final String SERIALIZED_NAME_TRANSIENT_ID = "transient_id";
+
+  @SerializedName(SERIALIZED_NAME_TRANSIENT_ID)
+
+
+  private String transientId;
+  /**
+  * ID that is returned in the response body for the verification 
+  * @return transientId
+  **/
+
+  @javax.annotation.Nullable
+
+  @ApiModelProperty(value = "ID that is returned in the response body for the verification ")
+
+  public String getTransientId() {
+      return transientId;
+  }
+
+
+
 
   /*
   public UsVerification id(String id) {
@@ -568,6 +589,21 @@ public void setObject(ObjectEnum _object) {
 
 
 
+  /*
+  public UsVerification transientId(String transientId) {
+    
+    this.transientId = transientId;
+    return this;
+  }
+  */
+
+
+  public void setTransientId(String transientId) {
+    this.transientId = transientId;
+  }
+
+
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
@@ -588,7 +624,8 @@ public boolean equals(Object o) {
         Objects.equals(this.components, usVerification.components) &&
         Objects.equals(this.deliverabilityAnalysis, usVerification.deliverabilityAnalysis) &&
         Objects.equals(this.lobConfidenceScore, usVerification.lobConfidenceScore) &&
-        Objects.equals(this._object, usVerification._object);
+        Objects.equals(this._object, usVerification._object) &&
+        Objects.equals(this.transientId, usVerification.transientId);
   }
 
   private static <T> boolean equalsNullable(JsonNullable<T> a, JsonNullable<T> b) {
@@ -597,7 +634,7 @@ private static <T> boolean equalsNullable(JsonNullable<T> a, JsonNullable<T> b)
 
   @Override
   public int hashCode() {
-    return Objects.hash(id, recipient, primaryLine, secondaryLine, urbanization, lastLine, deliverability, validAddress, components, deliverabilityAnalysis, lobConfidenceScore, _object);
+    return Objects.hash(id, recipient, primaryLine, secondaryLine, urbanization, lastLine, deliverability, validAddress, components, deliverabilityAnalysis, lobConfidenceScore, _object, transientId);
   }
 
   private static <T> int hashCodeNullable(JsonNullable<T> a) {
@@ -623,6 +660,7 @@ public String toString() {
     sb.append("    deliverabilityAnalysis: ").append(toIndentedString(deliverabilityAnalysis)).append("\n");
     sb.append("    lobConfidenceScore: ").append(toIndentedString(lobConfidenceScore)).append("\n");
     sb.append("    _object: ").append(toIndentedString(_object)).append("\n");
+    sb.append("    transientId: ").append(toIndentedString(transientId)).append("\n");
     sb.append("}");
     return sb.toString();
   }
@@ -641,6 +679,7 @@ public Map<String, Object> toMap() {
       localMap.put("deliverability_analysis", deliverabilityAnalysis);
       localMap.put("lob_confidence_score", lobConfidenceScore);
       localMap.put("object", _object);
+      localMap.put("transient_id", transientId);
       return localMap;
     }
 

src/main/java/com/lob/model/UsVerificationOrError.java

@@ -371,6 +371,27 @@ public ObjectEnum getObject() {
 
 
 
+  public static final String SERIALIZED_NAME_TRANSIENT_ID = "transient_id";
+
+  @SerializedName(SERIALIZED_NAME_TRANSIENT_ID)
+
+
+  private String transientId;
+  /**
+  * ID that is returned in the response body for the verification 
+  * @return transientId
+  **/
+
+  @javax.annotation.Nullable
+
+  @ApiModelProperty(value = "ID that is returned in the response body for the verification ")
+
+  public String getTransientId() {
+      return transientId;
+  }
+
+
+
   public static final String SERIALIZED_NAME_ERROR = "error";
 
   @SerializedName(SERIALIZED_NAME_ERROR)
@@ -555,6 +576,21 @@ public void setObject(ObjectEnum _object) {
 
 
 
+  /*
+  public UsVerificationOrError transientId(String transientId) {
+    
+    this.transientId = transientId;
+    return this;
+  }
+  */
+
+
+  public void setTransientId(String transientId) {
+    this.transientId = transientId;
+  }
+
+
+
   /*
   public UsVerificationOrError error(BulkError error) {
     
@@ -590,6 +626,7 @@ public boolean equals(Object o) {
         Objects.equals(this.deliverabilityAnalysis, usVerificationOrError.deliverabilityAnalysis) &&
         Objects.equals(this.lobConfidenceScore, usVerificationOrError.lobConfidenceScore) &&
         Objects.equals(this._object, usVerificationOrError._object) &&
+        Objects.equals(this.transientId, usVerificationOrError.transientId) &&
         Objects.equals(this.error, usVerificationOrError.error);
   }
 
@@ -599,7 +636,7 @@ private static <T> boolean equalsNullable(JsonNullable<T> a, JsonNullable<T> b)
 
   @Override
   public int hashCode() {
-    return Objects.hash(id, recipient, primaryLine, secondaryLine, urbanization, lastLine, deliverability, components, deliverabilityAnalysis, lobConfidenceScore, _object, error);
+    return Objects.hash(id, recipient, primaryLine, secondaryLine, urbanization, lastLine, deliverability, components, deliverabilityAnalysis, lobConfidenceScore, _object, transientId, error);
   }
 
   private static <T> int hashCodeNullable(JsonNullable<T> a) {
@@ -624,6 +661,7 @@ public String toString() {
     sb.append("    deliverabilityAnalysis: ").append(toIndentedString(deliverabilityAnalysis)).append("\n");
     sb.append("    lobConfidenceScore: ").append(toIndentedString(lobConfidenceScore)).append("\n");
     sb.append("    _object: ").append(toIndentedString(_object)).append("\n");
+    sb.append("    transientId: ").append(toIndentedString(transientId)).append("\n");
     sb.append("    error: ").append(toIndentedString(error)).append("\n");
     sb.append("}");
     return sb.toString();
@@ -642,6 +680,7 @@ public Map<String, Object> toMap() {
       localMap.put("deliverability_analysis", deliverabilityAnalysis);
       localMap.put("lob_confidence_score", lobConfidenceScore);
       localMap.put("object", _object);
+      localMap.put("transient_id", transientId);
       localMap.put("error", error);
       return localMap;
     }

src/main/java/com/lob/model/UsVerificationsWritable.java

@@ -205,6 +205,27 @@ public void setZipCode (String zipCode) throws IllegalArgumentException {
 
 
 
+  public static final String SERIALIZED_NAME_TRANSIENT_ID = "transient_id";
+
+  @SerializedName(SERIALIZED_NAME_TRANSIENT_ID)
+
+
+  private String transientId;
+  /**
+  * ID that is returned in the response body for the verification 
+  * @return transientId
+  **/
+
+  @javax.annotation.Nullable
+
+  @ApiModelProperty(value = "ID that is returned in the response body for the verification ")
+
+  public String getTransientId() {
+      return transientId;
+  }
+
+
+
 
   /*
   public UsVerificationsWritable address(String address) {
@@ -323,6 +344,21 @@ public UsVerificationsWritable zipCode(String zipCode) {
 
 
 
+  /*
+  public UsVerificationsWritable transientId(String transientId) {
+    
+    this.transientId = transientId;
+    return this;
+  }
+  */
+
+
+  public void setTransientId(String transientId) {
+    this.transientId = transientId;
+  }
+
+
+
   @Override
   public boolean equals(Object o) {
     if (this == o) {
@@ -339,7 +375,8 @@ public boolean equals(Object o) {
         Objects.equals(this.urbanization, usVerificationsWritable.urbanization) &&
         Objects.equals(this.city, usVerificationsWritable.city) &&
         Objects.equals(this.state, usVerificationsWritable.state) &&
-        Objects.equals(this.zipCode, usVerificationsWritable.zipCode);
+        Objects.equals(this.zipCode, usVerificationsWritable.zipCode) &&
+        Objects.equals(this.transientId, usVerificationsWritable.transientId);
   }
 
   private static <T> boolean equalsNullable(JsonNullable<T> a, JsonNullable<T> b) {
@@ -348,7 +385,7 @@ private static <T> boolean equalsNullable(JsonNullable<T> a, JsonNullable<T> b)
 
   @Override
   public int hashCode() {
-    return Objects.hash(address, recipient, primaryLine, secondaryLine, urbanization, city, state, zipCode);
+    return Objects.hash(address, recipient, primaryLine, secondaryLine, urbanization, city, state, zipCode, transientId);
   }
 
   private static <T> int hashCodeNullable(JsonNullable<T> a) {
@@ -370,6 +407,7 @@ public String toString() {
     sb.append("    city: ").append(toIndentedString(city)).append("\n");
     sb.append("    state: ").append(toIndentedString(state)).append("\n");
     sb.append("    zipCode: ").append(toIndentedString(zipCode)).append("\n");
+    sb.append("    transientId: ").append(toIndentedString(transientId)).append("\n");
     sb.append("}");
     return sb.toString();
   }
@@ -384,6 +422,7 @@ public Map<String, Object> toMap() {
       localMap.put("city", city);
       localMap.put("state", state);
       localMap.put("zip_code", zipCode);
+      localMap.put("transient_id", transientId);
       return localMap;
     }