diff --git a/models/deliverability-analysis.ts b/models/deliverability-analysis.ts index 78a7f57..2e5b276 100644 --- a/models/deliverability-analysis.ts +++ b/models/deliverability-analysis.ts @@ -35,6 +35,24 @@ export class DeliverabilityAnalysis { if (typeof input?.dpv_active !== "undefined") { this.dpv_active = input.dpv_active; } + if (typeof input?.dpv_inactive_reason !== "undefined") { + this.dpv_inactive_reason = input.dpv_inactive_reason; + } + if (typeof input?.dpv_throwback !== "undefined") { + this.dpv_throwback = input.dpv_throwback; + } + if (typeof input?.dpv_non_delivery_day_flag !== "undefined") { + this.dpv_non_delivery_day_flag = input.dpv_non_delivery_day_flag; + } + if (typeof input?.dpv_non_delivery_day_values !== "undefined") { + this.dpv_non_delivery_day_values = input.dpv_non_delivery_day_values; + } + if (typeof input?.dpv_no_secure_location !== "undefined") { + this.dpv_no_secure_location = input.dpv_no_secure_location; + } + if (typeof input?.dpv_door_not_accessible !== "undefined") { + this.dpv_door_not_accessible = input.dpv_door_not_accessible; + } if (typeof input?.dpv_footnotes !== "undefined") { this.dpv_footnotes = input.dpv_footnotes; } @@ -80,6 +98,48 @@ export class DeliverabilityAnalysis { */ "dpv_active": DeliverabilityAnalysisDpvActiveEnum; + /** + * 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. + * @type {string} + * @memberof DeliverabilityAnalysis + */ + "dpv_inactive_reason": DeliverabilityAnalysisDpvInactiveReasonEnum; + + /** + * 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). + * @type {string} + * @memberof DeliverabilityAnalysis + */ + "dpv_throwback": DeliverabilityAnalysisDpvThrowbackEnum; + + /** + * 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). + * @type {string} + * @memberof DeliverabilityAnalysis + */ + "dpv_non_delivery_day_flag": DeliverabilityAnalysisDpvNonDeliveryDayFlagEnum; + + /** + * 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). + * @type {string} + * @memberof DeliverabilityAnalysis + */ + "dpv_non_delivery_day_values": string; + + /** + * 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). + * @type {string} + * @memberof DeliverabilityAnalysis + */ + "dpv_no_secure_location": DeliverabilityAnalysisDpvNoSecureLocationEnum; + + /** + * 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). + * @type {string} + * @memberof DeliverabilityAnalysis + */ + "dpv_door_not_accessible": DeliverabilityAnalysisDpvDoorNotAccessibleEnum; + /** * 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). * @type {Array} @@ -164,6 +224,55 @@ export enum DeliverabilityAnalysisDpvActiveEnum { N = "N", Empty = "", } +/** + * @export + * @enum {string} + */ +export enum DeliverabilityAnalysisDpvInactiveReasonEnum { + _01 = "01", + _02 = "02", + _03 = "03", + _04 = "04", + _05 = "05", + _06 = "06", + Empty = "", +} +/** + * @export + * @enum {string} + */ +export enum DeliverabilityAnalysisDpvThrowbackEnum { + Y = "Y", + N = "N", + Empty = "", +} +/** + * @export + * @enum {string} + */ +export enum DeliverabilityAnalysisDpvNonDeliveryDayFlagEnum { + Y = "Y", + N = "N", + Empty = "", +} +/** + * @export + * @enum {string} + */ +export enum DeliverabilityAnalysisDpvNoSecureLocationEnum { + Y = "Y", + N = "N", + Empty = "", +} +/** + * @export + * @enum {string} + */ +export enum DeliverabilityAnalysisDpvDoorNotAccessibleEnum { + Y = "Y", + N = "N", + Empty = "", +} /** * @export * @enum {string} diff --git a/models/dpv-footnote.ts b/models/dpv-footnote.ts index d4df455..d7b27e5 100644 --- a/models/dpv-footnote.ts +++ b/models/dpv-footnote.ts @@ -25,17 +25,21 @@ export enum DpvFootnote { A1 = "A1", Bb = "BB", Cc = "CC", - N1 = "N1", + C1 = "C1", F1 = "F1", G1 = "G1", - U1 = "U1", + Ia = "IA", M1 = "M1", M3 = "M3", + N1 = "N1", + Pb = "PB", P1 = "P1", P3 = "P3", R1 = "R1", R7 = "R7", Rr = "RR", + Ta = "TA", + U1 = "U1", } /** diff --git a/models/us-components.ts b/models/us-components.ts index b0918dd..4fe7d03 100644 --- a/models/us-components.ts +++ b/models/us-components.ts @@ -95,6 +95,9 @@ export class UsComponents { if (typeof input?.carrier_route_type !== "undefined") { this.carrier_route_type = input.carrier_route_type; } + if (typeof input?.po_box_only_flag !== "undefined") { + this.po_box_only_flag = input.po_box_only_flag; + } if (typeof input?.latitude !== "undefined") { this.latitude = input.latitude; } @@ -204,7 +207,7 @@ export class UsComponents { return this._zip_code; } public set zip_code(newValue: string) { - if (newValue && !/^\d{5}$/.test(newValue)) { + if (newValue && !/(^$)|(^\d{5}$)/.test(newValue)) { throw new Error("Invalid zip_code provided"); } this._zip_code = newValue; @@ -220,7 +223,7 @@ export class UsComponents { return this._zip_code_plus_4; } public set zip_code_plus_4(newValue: string) { - if (newValue && !/^\d{4}$/.test(newValue)) { + if (newValue && !/^(\d{4})?$/.test(newValue)) { throw new Error("Invalid zip_code_plus_4 provided"); } this._zip_code_plus_4 = newValue; @@ -289,6 +292,13 @@ export class UsComponents { */ "carrier_route_type": UsComponentsCarrierRouteTypeEnum; + /** + * Indicates the mailing facility for an address only supports PO Box deliveries and other forms of mail delivery are not available. + * @type {string} + * @memberof UsComponents + */ + "po_box_only_flag": UsComponentsPoBoxOnlyFlagEnum; + /** * 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`). * @type {number} @@ -378,6 +388,15 @@ export enum UsComponentsCarrierRouteTypeEnum { GeneralDelivery = "general_delivery", Empty = "", } +/** + * @export + * @enum {string} + */ +export enum UsComponentsPoBoxOnlyFlagEnum { + Y = "Y", + N = "N", + Empty = "", +} /** * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). diff --git a/package-lock.json b/package-lock.json index 432f041..ecb03f4 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@lob/lob-typescript-sdk", - "version": "1.3.2", + "version": "1.3.3", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "@lob/lob-typescript-sdk", - "version": "1.3.2", + "version": "1.3.3", "license": "MIT", "dependencies": { "axios": "0.24.0", diff --git a/package.json b/package.json index 0aefe34..0e4f794 100755 --- a/package.json +++ b/package.json @@ -14,7 +14,7 @@ "address validation", "address autocomplete" ], - "version": "1.3.2", + "version": "1.3.3", "homepage": "https://github.com/lob/lob-typescript-sdk", "author": "Lob (https://lob.com/)", "repository": {