Skip to content

Commit 0edcf38

Browse files
amaan-lobamaan-lob
authored
Merge pull request #272 from lob/AV-4395-us-verifications-update
2 parents f31502d + f3f94d5 commit 0edcf38

File tree

5 files changed

+139
-7
lines changed

5 files changed

+139
-7
lines changed

‎models/deliverability-analysis.ts‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,24 @@ export class DeliverabilityAnalysis {
3535
if (typeof input?.dpv_active !== "undefined") {
3636
this.dpv_active = input.dpv_active;
3737
}
38+
if (typeof input?.dpv_inactive_reason !== "undefined") {
39+
this.dpv_inactive_reason = input.dpv_inactive_reason;
40+
}
41+
if (typeof input?.dpv_throwback !== "undefined") {
42+
this.dpv_throwback = input.dpv_throwback;
43+
}
44+
if (typeof input?.dpv_non_delivery_day_flag !== "undefined") {
45+
this.dpv_non_delivery_day_flag = input.dpv_non_delivery_day_flag;
46+
}
47+
if (typeof input?.dpv_non_delivery_day_values !== "undefined") {
48+
this.dpv_non_delivery_day_values = input.dpv_non_delivery_day_values;
49+
}
50+
if (typeof input?.dpv_no_secure_location !== "undefined") {
51+
this.dpv_no_secure_location = input.dpv_no_secure_location;
52+
}
53+
if (typeof input?.dpv_door_not_accessible !== "undefined") {
54+
this.dpv_door_not_accessible = input.dpv_door_not_accessible;
55+
}
3856
if (typeof input?.dpv_footnotes !== "undefined") {
3957
this.dpv_footnotes = input.dpv_footnotes;
4058
}
@@ -80,6 +98,48 @@ export class DeliverabilityAnalysis {
8098
*/
8199
"dpv_active": DeliverabilityAnalysisDpvActiveEnum;
82100

101+
/**
102+
* Indicates the reason why an address is vacant or no longer receiving deliveries. Possible values are: * `01` –– Address does not receive mail from the USPS directly, but is serviced by a drop address. * `02` –– Address not yet deliverable. * `03` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). * `04` –– Address is a College, Military Zone, or other type. * `05` –– Address no longer receives deliveries. * `06` –– Address is missing required secondary information. * `\'\'` –– A DPV match is not made or the address is active.
103+
* @type {string}
104+
* @memberof DeliverabilityAnalysis
105+
*/
106+
"dpv_inactive_reason": DeliverabilityAnalysisDpvInactiveReasonEnum;
107+
108+
/**
109+
* Indicates a street address for which mail is delivered to a PO Box. Possible values are: * `Y` –– Address is a PO Box throwback delivery point. * `N` –– Address is not a PO Box throwback delivery point. * `\'\'` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
110+
* @type {string}
111+
* @memberof DeliverabilityAnalysis
112+
*/
113+
"dpv_throwback": DeliverabilityAnalysisDpvThrowbackEnum;
114+
115+
/**
116+
* Indicates whether deliveries are not performed on one or more days of the week at an address. Possible values are: * `Y` –– Mail delivery does not occur on some days of the week. * `N` –– Mail delivery occurs every day of the week. * `\'\'` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
117+
* @type {string}
118+
* @memberof DeliverabilityAnalysis
119+
*/
120+
"dpv_non_delivery_day_flag": DeliverabilityAnalysisDpvNonDeliveryDayFlagEnum;
121+
122+
/**
123+
* Indicates days of the week (starting on Sunday) deliveries are not performed at an address. For example: * `YNNNNNN` –– Mail delivery does not occur on Sunday\'s. * `NYNNNYN` –– Mail delivery does not occur on Monday\'s or Friday\'s. * `\'\'` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string) or address receives mail every day of the week (`deliverability_analysis[dpv_non_delivery_day_flag]` is `N` or an empty string).
124+
* @type {string}
125+
* @memberof DeliverabilityAnalysis
126+
*/
127+
"dpv_non_delivery_day_values": string;
128+
129+
/**
130+
* Indicates packages to this address will not be left due to security concerns. Possible values are: * `Y` –– Address does not have a secure mailbox. * `N` –– Address has a secure mailbox. * `\'\'` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
131+
* @type {string}
132+
* @memberof DeliverabilityAnalysis
133+
*/
134+
"dpv_no_secure_location": DeliverabilityAnalysisDpvNoSecureLocationEnum;
135+
136+
/**
137+
* Indicates the door of the address is not accessible for mail delivery. Possible values are: * `Y` –– Door is not accessible. * `N` –– Door is accessible. * `\'\'` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string).
138+
* @type {string}
139+
* @memberof DeliverabilityAnalysis
140+
*/
141+
"dpv_door_not_accessible": DeliverabilityAnalysisDpvDoorNotAccessibleEnum;
142+
83143
/**
84144
* An array of 2-character strings that gives more insight into how `deliverability_analysis[dpv_confirmation]` 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).
85145
* @type {Array<DpvFootnote>}
@@ -164,6 +224,55 @@ export enum DeliverabilityAnalysisDpvActiveEnum {
164224
N = "N",
165225
Empty = "",
166226
}
227+
/**
228+
* @export
229+
* @enum {string}
230+
*/
231+
export enum DeliverabilityAnalysisDpvInactiveReasonEnum {
232+
_01 = "01",
233+
_02 = "02",
234+
_03 = "03",
235+
_04 = "04",
236+
_05 = "05",
237+
_06 = "06",
238+
Empty = "",
239+
}
240+
/**
241+
* @export
242+
* @enum {string}
243+
*/
244+
export enum DeliverabilityAnalysisDpvThrowbackEnum {
245+
Y = "Y",
246+
N = "N",
247+
Empty = "",
248+
}
249+
/**
250+
* @export
251+
* @enum {string}
252+
*/
253+
export enum DeliverabilityAnalysisDpvNonDeliveryDayFlagEnum {
254+
Y = "Y",
255+
N = "N",
256+
Empty = "",
257+
}
258+
/**
259+
* @export
260+
* @enum {string}
261+
*/
262+
export enum DeliverabilityAnalysisDpvNoSecureLocationEnum {
263+
Y = "Y",
264+
N = "N",
265+
Empty = "",
266+
}
267+
/**
268+
* @export
269+
* @enum {string}
270+
*/
271+
export enum DeliverabilityAnalysisDpvDoorNotAccessibleEnum {
272+
Y = "Y",
273+
N = "N",
274+
Empty = "",
275+
}
167276
/**
168277
* @export
169278
* @enum {string}

‎models/dpv-footnote.ts‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,21 @@ export enum DpvFootnote {
2525
A1 = "A1",
2626
Bb = "BB",
2727
Cc = "CC",
28-
N1 = "N1",
28+
C1 = "C1",
2929
F1 = "F1",
3030
G1 = "G1",
31-
U1 = "U1",
31+
Ia = "IA",
3232
M1 = "M1",
3333
M3 = "M3",
34+
N1 = "N1",
35+
Pb = "PB",
3436
P1 = "P1",
3537
P3 = "P3",
3638
R1 = "R1",
3739
R7 = "R7",
3840
Rr = "RR",
41+
Ta = "TA",
42+
U1 = "U1",
3943
}
4044

4145
/**

‎models/us-components.ts‎

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,9 @@ export class UsComponents {
9595
if (typeof input?.carrier_route_type !== "undefined") {
9696
this.carrier_route_type = input.carrier_route_type;
9797
}
98+
if (typeof input?.po_box_only_flag !== "undefined") {
99+
this.po_box_only_flag = input.po_box_only_flag;
100+
}
98101
if (typeof input?.latitude !== "undefined") {
99102
this.latitude = input.latitude;
100103
}
@@ -204,7 +207,7 @@ export class UsComponents {
204207
return this._zip_code;
205208
}
206209
public set zip_code(newValue: string) {
207-
if (newValue && !/^\d{5}$/.test(newValue)) {
210+
if (newValue && !/(^$)|(^\d{5}$)/.test(newValue)) {
208211
throw new Error("Invalid zip_code provided");
209212
}
210213
this._zip_code = newValue;
@@ -220,7 +223,7 @@ export class UsComponents {
220223
return this._zip_code_plus_4;
221224
}
222225
public set zip_code_plus_4(newValue: string) {
223-
if (newValue && !/^\d{4}$/.test(newValue)) {
226+
if (newValue && !/^(\d{4})?$/.test(newValue)) {
224227
throw new Error("Invalid zip_code_plus_4 provided");
225228
}
226229
this._zip_code_plus_4 = newValue;
@@ -289,6 +292,13 @@ export class UsComponents {
289292
*/
290293
"carrier_route_type": UsComponentsCarrierRouteTypeEnum;
291294

295+
/**
296+
* Indicates the mailing facility for an address only supports PO Box deliveries and other forms of mail delivery are not available.
297+
* @type {string}
298+
* @memberof UsComponents
299+
*/
300+
"po_box_only_flag": UsComponentsPoBoxOnlyFlagEnum;
301+
292302
/**
293303
* 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 `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`).
294304
* @type {number}
@@ -378,6 +388,15 @@ export enum UsComponentsCarrierRouteTypeEnum {
378388
GeneralDelivery = "general_delivery",
379389
Empty = "",
380390
}
391+
/**
392+
* @export
393+
* @enum {string}
394+
*/
395+
export enum UsComponentsPoBoxOnlyFlagEnum {
396+
Y = "Y",
397+
N = "N",
398+
Empty = "",
399+
}
381400

382401
/**
383402
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

‎package-lock.json‎

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"address validation",
1515
"address autocomplete"
1616
],
17-
"version": "1.3.2",
17+
"version": "1.3.3",
1818
"homepage": "https://github.com/lob/lob-typescript-sdk",
1919
"author": "Lob <[email protected]> (https://lob.com/)",
2020
"repository": {

0 commit comments

Comments
 (0)