Skip to content

Commit

Permalink
AV-4425 updating cycle o model's fields (#337)
Browse files Browse the repository at this point in the history
* updating cycle o model's fields

* adding docs

* adding new dpv footnote

* Removing CODEOWNERS

* update versions

* [maven-release-plugin] prepare release lob-java-13.4.4

* update versions

* [maven-release-plugin] prepare for next development iteration

* [maven-release-plugin] prepare release lob-java-13.4.4

---------

Co-authored-by: Andrew Jorczak <76975308+ajorczak-lob@users.noreply.github.com>
  • Loading branch information
mrkaspa and ajorczak-lob authored Nov 9, 2023
1 parent 68e8fb0 commit 3d5c731
Show file tree
Hide file tree
Showing 12 changed files with 703 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @lob/developer-experience @BennyKitchell

2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,5 @@ build

# Filesystem
.DS_Store

pom.xml.releaseBackup
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ apply plugin: 'eclipse'
apply plugin: 'java'

group = 'com.github.lob'
version = '13.0.0'
version = '13.4.4'

buildscript {
repositories {
Expand Down
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ lazy val root = (project in file(".")).
settings(
organization := "com.github.lob",
name := "lob-java",
version := "13.0.0",
version := "13.4.4",
scalaVersion := "2.11.4",
scalacOptions ++= Seq("-feature"),
javacOptions in compile ++= Seq("-Xlint:deprecation"),
Expand Down
60 changes: 60 additions & 0 deletions docs/DeliverabilityAnalysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ Name | Type | Description | Notes
**dpvCmra** | [**DpvCmraEnum**](#DpvCmraEnum) | indicates whether or not the address is [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency). Possible values are: * &#x60;Y&#x60; –– Address is CMRA-authorized. * &#x60;N&#x60; –– Address is not CMRA-authorized. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string). |
**dpvVacant** | [**DpvVacantEnum**](#DpvVacantEnum) | indicates that an address was once deliverable, but has become vacant and is no longer receiving deliveries. Possible values are: * &#x60;Y&#x60; –– Address is vacant. * &#x60;N&#x60; –– Address is not vacant. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string). |
**dpvActive** | [**DpvActiveEnum**](#DpvActiveEnum) | Corresponds to the USPS field &#x60;dpv_no_stat&#x60;. Indicates that an address has been vacated in the recent past, and is no longer receiving deliveries. If it&#39;s been unoccupied for 90+ days, or temporarily vacant, this will be flagged. Possible values are: * &#x60;Y&#x60; –– Address is active. * &#x60;N&#x60; –– Address is not active. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string). |
**dpvInactiveReason** | [**DpvInactiveReasonEnum**](#DpvInactiveReasonEnum) | Indicates the reason why an address is vacant or no longer receiving deliveries. Possible values are: * &#x60;01&#x60; –– Address does not receive mail from the USPS directly, but is serviced by a drop address. * &#x60;02&#x60; –– Address not yet deliverable. * &#x60;03&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string). * &#x60;04&#x60; –– Address is a College, Military Zone, or other type. * &#x60;05&#x60; –– Address no longer receives deliveries. * &#x60;06&#x60; –– Address is missing required secondary information. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made or the address is active. |
**dpvThrowback** | [**DpvThrowbackEnum**](#DpvThrowbackEnum) | Indicates a street address for which mail is delivered to a PO Box. Possible values are: * &#x60;Y&#x60; –– Address is a PO Box throwback delivery point. * &#x60;N&#x60; –– Address is not a PO Box throwback delivery point. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string). |
**dpvNonDeliveryDayFlag** | [**DpvNonDeliveryDayFlagEnum**](#DpvNonDeliveryDayFlagEnum) | Indicates whether deliveries are not performed on one or more days of the week at an address. Possible values are: * &#x60;Y&#x60; –– Mail delivery does not occur on some days of the week. * &#x60;N&#x60; –– Mail delivery occurs every day of the week. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string). |
**dpvNonDeliveryDayValues** | **String** | Indicates days of the week (starting on Sunday) deliveries are not performed at an address. For example: * &#x60;YNNNNNN&#x60; –– Mail delivery does not occur on Sunday&#39;s. * &#x60;NYNNNYN&#x60; –– Mail delivery does not occur on Monday&#39;s or Friday&#39;s. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string) or address receives mail every day of the week (&#x60;deliverability_analysis[dpv_non_delivery_day_flag]&#x60; is &#x60;N&#x60; or an empty string). |
**dpvNoSecureLocation** | [**DpvNoSecureLocationEnum**](#DpvNoSecureLocationEnum) | Indicates packages to this address will not be left due to security concerns. Possible values are: * &#x60;Y&#x60; –– Address does not have a secure mailbox. * &#x60;N&#x60; –– Address has a secure mailbox. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string). |
**dpvDoorNotAccessible** | [**DpvDoorNotAccessibleEnum**](#DpvDoorNotAccessibleEnum) | Indicates the door of the address is not accessible for mail delivery. Possible values are: * &#x60;Y&#x60; –– Door is not accessible. * &#x60;N&#x60; –– Door is accessible. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string). |
**dpvFootnotes** | **List&lt;DpvFootnote&gt;** | An array of 2-character strings that gives more insight into how &#x60;deliverability_analysis[dpv_confirmation]&#x60; was determined. Will always include at least 1 string, and can include up to 3. For details, see [US Verification Details](#tag/US-Verification-Types). |
**ewsMatch** | **Boolean** | indicates whether or not an address has been flagged in the [Early Warning System](https://docs.informatica.com/data-engineering/data-engineering-quality/10-4-0/address-validator-port-reference/postal-carrier-certification-data-ports/early-warning-system-return-code.html), meaning the address is under development and not yet ready to receive mail. However, it should become available in a few months. |
**lacsIndicator** | [**LacsIndicatorEnum**](#LacsIndicatorEnum) | indicates whether this address has been converted by [LACS&lt;sup&gt;Link&lt;/sup&gt;](https://postalpro.usps.com/address-quality/lacslink). LACS&lt;sup&gt;Link&lt;/sup&gt; corrects outdated addresses into their modern counterparts. Possible values are: * &#x60;Y&#x60; –– New address produced with a matching record in LACS&lt;sup&gt;Link&lt;/sup&gt;. * &#x60;N&#x60; –– New address could not be produced with a matching record in LACS&lt;sup&gt;Link&lt;/sup&gt;. * &#x60;&#39;&#39;&#x60; –– A DPV match is not made (&#x60;deliverability_analysis[dpv_confirmation]&#x60; is &#x60;N&#x60; or an empty string). |
Expand Down Expand Up @@ -62,6 +68,60 @@ EMPTY | &quot;&quot;



## Enum: DpvInactiveReasonEnum

Name | Value
---- | -----
_01 | &quot;01&quot;
_02 | &quot;02&quot;
_03 | &quot;03&quot;
_04 | &quot;04&quot;
_05 | &quot;05&quot;
_06 | &quot;06&quot;
EMPTY | &quot;&quot;



## Enum: DpvThrowbackEnum

Name | Value
---- | -----
Y | &quot;Y&quot;
N | &quot;N&quot;
EMPTY | &quot;&quot;



## Enum: DpvNonDeliveryDayFlagEnum

Name | Value
---- | -----
Y | &quot;Y&quot;
N | &quot;N&quot;
EMPTY | &quot;&quot;



## Enum: DpvNoSecureLocationEnum

Name | Value
---- | -----
Y | &quot;Y&quot;
N | &quot;N&quot;
EMPTY | &quot;&quot;



## Enum: DpvDoorNotAccessibleEnum

Name | Value
---- | -----
Y | &quot;Y&quot;
N | &quot;N&quot;
EMPTY | &quot;&quot;



## Enum: LacsIndicatorEnum

Name | Value
Expand Down
12 changes: 10 additions & 2 deletions docs/DpvFootnote.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,22 @@

* `CC` (value: `"CC"`)

* `N1` (value: `"N1"`)
* `C1` (value: `"C1"`)

* `F1` (value: `"F1"`)

* `G1` (value: `"G1"`)

* `U1` (value: `"U1"`)
* `IA` (value: `"IA"`)

* `M1` (value: `"M1"`)

* `M3` (value: `"M3"`)

* `N1` (value: `"N1"`)

* `PB` (value: `"PB"`)

* `P1` (value: `"P1"`)

* `P3` (value: `"P3"`)
Expand All @@ -35,5 +39,9 @@

* `RR` (value: `"RR"`)

* `TA` (value: `"TA"`)

* `U1` (value: `"U1"`)



11 changes: 11 additions & 0 deletions docs/UsComponents.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Name | Type | Description | Notes
**countyFips** | **String** | A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies &#x60;components[county]&#x60;. It consists of a 2-digit state code and a 3-digit county code. |
**carrierRoute** | **String** | A 4-character code assigned to a mail delivery route within a ZIP code. |
**carrierRouteType** | [**CarrierRouteTypeEnum**](#CarrierRouteTypeEnum) | The type of &#x60;components[carrier_route]&#x60;. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types). |
**poBoxOnlyFlag** | [**PoBoxOnlyFlagEnum**](#PoBoxOnlyFlagEnum) | Indicates the mailing facility for an address only supports PO Box deliveries and other forms of mail delivery are not available. |
**latitude** | **Float** | A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with &#x60;longitude&#x60; to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is &#x60;AA&#x60;, &#x60;AE&#x60;, or &#x60;AP&#x60;). | [optional]
**longitude** | **Float** | A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with &#x60;latitude&#x60; to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is &#x60;AA&#x60;, &#x60;AE&#x60;, or &#x60;AP&#x60;). | [optional]

Expand Down Expand Up @@ -106,3 +107,13 @@ EMPTY | &quot;&quot;



## Enum: PoBoxOnlyFlagEnum

Name | Value
---- | -----
Y | &quot;Y&quot;
N | &quot;N&quot;
EMPTY | &quot;&quot;



4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<groupId>com.lob</groupId>
<artifactId>lob-java</artifactId>
<packaging>jar</packaging>
<version>13.4.4-SNAPSHOT</version>
<version>13.4.4</version>

<name>${project.groupId}:${project.artifactId}</name>
<description>Parent pom for the Lob API Java Wrapper</description>
Expand Down Expand Up @@ -38,7 +38,7 @@
<connection>scm:git:git@github.com:lob/lob-java.git</connection>
<developerConnection>scm:git:git@github.com:lob/lob-java.git</developerConnection>
<url>https://github.com/lob/lob-java</url>
<tag>lob-java-13.3.0</tag>
<tag>lob-java-13.4.4</tag>
</scm>

<build>
Expand Down
27 changes: 27 additions & 0 deletions release.properties
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
#release configuration
#Thu Nov 09 09:48:44 COT 2023
completedPhase=run-preparation-goals
exec.additionalArguments=-DskipTests
exec.pomFileName=pom.xml
exec.snapshotReleasePluginAllowed=false
pinExternals=false
preparationGoals=clean verify
project.dev.com.lob\:lob-java=13.4.5-SNAPSHOT
project.rel.com.lob\:lob-java=13.4.4
project.scm.com.lob\:lob-java.connection=scm\:git\:git@github.com\:lob/lob-java.git
project.scm.com.lob\:lob-java.developerConnection=scm\:git\:git@github.com\:lob/lob-java.git
project.scm.com.lob\:lob-java.tag=lob-java-13.4.4
project.scm.com.lob\:lob-java.url=https\://github.com/lob/lob-java
projectVersionPolicyConfig=<projectVersionPolicyConfig>${projectVersionPolicyConfig}</projectVersionPolicyConfig>\n
projectVersionPolicyId=default
pushChanges=true
releaseStrategyId=default
remoteTagging=true
scm.branchCommitComment=@{prefix} prepare branch @{releaseLabel}
scm.commentPrefix=[maven-release-plugin]
scm.developmentCommitComment=@{prefix} prepare for next development iteration
scm.releaseCommitComment=@{prefix} prepare release @{releaseLabel}
scm.rollbackCommitComment=@{prefix} rollback the release of @{releaseLabel}
scm.tag=lob-java-13.4.4
scm.tagNameFormat=@{project.artifactId}-@{project.version}
scm.url=scm\:git\:git@github.com\:lob/lob-java.git
Loading

0 comments on commit 3d5c731

Please sign in to comment.