diff --git a/docs/Model/DeliverabilityAnalysis.md b/docs/Model/DeliverabilityAnalysis.md index a917fad..2d37759 100644 --- a/docs/Model/DeliverabilityAnalysis.md +++ b/docs/Model/DeliverabilityAnalysis.md @@ -8,6 +8,12 @@ Name | Type | Description | Notes **dpv_cmra** | **string** | indicates whether or not the address is [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency). Possible values are: * `Y` –– Address is CMRA-authorized. * `N` –– Address is not CMRA-authorized. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | **dpv_vacant** | **string** | indicates that an address was once deliverable, but has become vacant and is no longer receiving deliveries. Possible values are: * `Y` –– Address is vacant. * `N` –– Address is not vacant. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | **dpv_active** | **string** | Corresponds to the USPS field `dpv_no_stat`. Indicates that an address has been vacated in the recent past, and is no longer receiving deliveries. If it's been unoccupied for 90+ days, or temporarily vacant, this will be flagged. Possible values are: * `Y` –– Address is active. * `N` –– Address is not active. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | +**dpv_inactive_reason** | **string** | 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. | +**dpv_throwback** | **string** | 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). | +**dpv_non_delivery_day_flag** | **string** | 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). | +**dpv_non_delivery_day_values** | **string** | 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). | +**dpv_no_secure_location** | **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). | +**dpv_door_not_accessible** | **string** | 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). | **dpv_footnotes** | [**\OpenAPI\Client\Model\DpvFootnote[]**](DpvFootnote.md) | 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). | **ews_match** | **bool** | 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. | **lacs_indicator** | **string** | indicates whether this address has been converted by [LACS<sup>Link</sup>](https://postalpro.usps.com/address-quality/lacslink). LACS<sup>Link</sup> corrects outdated addresses into their modern counterparts. Possible values are: * `Y` –– New address produced with a matching record in LACS<sup>Link</sup>. * `N` –– New address could not be produced with a matching record in LACS<sup>Link</sup>. * `''` –– A DPV match is not made (`deliverability_analysis[dpv_confirmation]` is `N` or an empty string). | diff --git a/docs/Model/UsComponents.md b/docs/Model/UsComponents.md index 3394655..25503f7 100644 --- a/docs/Model/UsComponents.md +++ b/docs/Model/UsComponents.md @@ -28,6 +28,7 @@ Name | Type | Description | Notes **county_fips** | **string** | A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. | **carrier_route** | **string** | A 4-character code assigned to a mail delivery route within a ZIP code. | **carrier_route_type** | **string** | The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types). | +**po_box_only_flag** | **string** | 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 `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). | [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 `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). | [optional] diff --git a/lib/Model/DeliverabilityAnalysis.php b/lib/Model/DeliverabilityAnalysis.php index 5c83611..6152fa9 100755 --- a/lib/Model/DeliverabilityAnalysis.php +++ b/lib/Model/DeliverabilityAnalysis.php @@ -65,6 +65,12 @@ class DeliverabilityAnalysis implements ModelInterface, ArrayAccess, \JsonSerial 'dpv_cmra' => 'string', 'dpv_vacant' => 'string', 'dpv_active' => 'string', + 'dpv_inactive_reason' => 'string', + 'dpv_throwback' => 'string', + 'dpv_non_delivery_day_flag' => 'string', + 'dpv_non_delivery_day_values' => 'string', + 'dpv_no_secure_location' => 'string', + 'dpv_door_not_accessible' => 'string', 'dpv_footnotes' => '\OpenAPI\Client\Model\DpvFootnote[]', 'ews_match' => 'bool', 'lacs_indicator' => 'string', @@ -84,6 +90,12 @@ class DeliverabilityAnalysis implements ModelInterface, ArrayAccess, \JsonSerial 'dpv_cmra' => null, 'dpv_vacant' => null, 'dpv_active' => null, + 'dpv_inactive_reason' => null, + 'dpv_throwback' => null, + 'dpv_non_delivery_day_flag' => null, + 'dpv_non_delivery_day_values' => null, + 'dpv_no_secure_location' => null, + 'dpv_door_not_accessible' => null, 'dpv_footnotes' => null, 'ews_match' => null, 'lacs_indicator' => null, @@ -122,6 +134,12 @@ public static function openAPIFormats() 'dpv_cmra' => 'dpv_cmra', 'dpv_vacant' => 'dpv_vacant', 'dpv_active' => 'dpv_active', + 'dpv_inactive_reason' => 'dpv_inactive_reason', + 'dpv_throwback' => 'dpv_throwback', + 'dpv_non_delivery_day_flag' => 'dpv_non_delivery_day_flag', + 'dpv_non_delivery_day_values' => 'dpv_non_delivery_day_values', + 'dpv_no_secure_location' => 'dpv_no_secure_location', + 'dpv_door_not_accessible' => 'dpv_door_not_accessible', 'dpv_footnotes' => 'dpv_footnotes', 'ews_match' => 'ews_match', 'lacs_indicator' => 'lacs_indicator', @@ -139,6 +157,12 @@ public static function openAPIFormats() 'dpv_cmra' => 'setDpvCmra', 'dpv_vacant' => 'setDpvVacant', 'dpv_active' => 'setDpvActive', + 'dpv_inactive_reason' => 'setDpvInactiveReason', + 'dpv_throwback' => 'setDpvThrowback', + 'dpv_non_delivery_day_flag' => 'setDpvNonDeliveryDayFlag', + 'dpv_non_delivery_day_values' => 'setDpvNonDeliveryDayValues', + 'dpv_no_secure_location' => 'setDpvNoSecureLocation', + 'dpv_door_not_accessible' => 'setDpvDoorNotAccessible', 'dpv_footnotes' => 'setDpvFootnotes', 'ews_match' => 'setEwsMatch', 'lacs_indicator' => 'setLacsIndicator', @@ -156,6 +180,12 @@ public static function openAPIFormats() 'dpv_cmra' => 'getDpvCmra', 'dpv_vacant' => 'getDpvVacant', 'dpv_active' => 'getDpvActive', + 'dpv_inactive_reason' => 'getDpvInactiveReason', + 'dpv_throwback' => 'getDpvThrowback', + 'dpv_non_delivery_day_flag' => 'getDpvNonDeliveryDayFlag', + 'dpv_non_delivery_day_values' => 'getDpvNonDeliveryDayValues', + 'dpv_no_secure_location' => 'getDpvNoSecureLocation', + 'dpv_door_not_accessible' => 'getDpvDoorNotAccessible', 'dpv_footnotes' => 'getDpvFootnotes', 'ews_match' => 'getEwsMatch', 'lacs_indicator' => 'getLacsIndicator', @@ -218,6 +248,25 @@ public function getModelName() const DPV_ACTIVE_Y = 'Y'; const DPV_ACTIVE_N = 'N'; const DPV_ACTIVE_EMPTY = ''; + const DPV_INACTIVE_REASON__01 = '01'; + const DPV_INACTIVE_REASON__02 = '02'; + const DPV_INACTIVE_REASON__03 = '03'; + const DPV_INACTIVE_REASON__04 = '04'; + const DPV_INACTIVE_REASON__05 = '05'; + const DPV_INACTIVE_REASON__06 = '06'; + const DPV_INACTIVE_REASON_EMPTY = ''; + const DPV_THROWBACK_Y = 'Y'; + const DPV_THROWBACK_N = 'N'; + const DPV_THROWBACK_EMPTY = ''; + const DPV_NON_DELIVERY_DAY_FLAG_Y = 'Y'; + const DPV_NON_DELIVERY_DAY_FLAG_N = 'N'; + const DPV_NON_DELIVERY_DAY_FLAG_EMPTY = ''; + const DPV_NO_SECURE_LOCATION_Y = 'Y'; + const DPV_NO_SECURE_LOCATION_N = 'N'; + const DPV_NO_SECURE_LOCATION_EMPTY = ''; + const DPV_DOOR_NOT_ACCESSIBLE_Y = 'Y'; + const DPV_DOOR_NOT_ACCESSIBLE_N = 'N'; + const DPV_DOOR_NOT_ACCESSIBLE_EMPTY = ''; const LACS_INDICATOR_Y = 'Y'; const LACS_INDICATOR_N = 'N'; const LACS_INDICATOR_EMPTY = ''; @@ -283,6 +332,80 @@ public function getDpvActiveAllowableValues() ]; } + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getDpvInactiveReasonAllowableValues() + { + return [ + self::DPV_INACTIVE_REASON__01, + self::DPV_INACTIVE_REASON__02, + self::DPV_INACTIVE_REASON__03, + self::DPV_INACTIVE_REASON__04, + self::DPV_INACTIVE_REASON__05, + self::DPV_INACTIVE_REASON__06, + self::DPV_INACTIVE_REASON_EMPTY, + ]; + } + + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getDpvThrowbackAllowableValues() + { + return [ + self::DPV_THROWBACK_Y, + self::DPV_THROWBACK_N, + self::DPV_THROWBACK_EMPTY, + ]; + } + + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getDpvNonDeliveryDayFlagAllowableValues() + { + return [ + self::DPV_NON_DELIVERY_DAY_FLAG_Y, + self::DPV_NON_DELIVERY_DAY_FLAG_N, + self::DPV_NON_DELIVERY_DAY_FLAG_EMPTY, + ]; + } + + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getDpvNoSecureLocationAllowableValues() + { + return [ + self::DPV_NO_SECURE_LOCATION_Y, + self::DPV_NO_SECURE_LOCATION_N, + self::DPV_NO_SECURE_LOCATION_EMPTY, + ]; + } + + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getDpvDoorNotAccessibleAllowableValues() + { + return [ + self::DPV_DOOR_NOT_ACCESSIBLE_Y, + self::DPV_DOOR_NOT_ACCESSIBLE_N, + self::DPV_DOOR_NOT_ACCESSIBLE_EMPTY, + ]; + } + /** * Gets allowable values of the enum * @@ -330,6 +453,12 @@ public function __construct(array $data = null) $this->container['dpv_cmra'] = $data['dpv_cmra'] ?? null; $this->container['dpv_vacant'] = $data['dpv_vacant'] ?? null; $this->container['dpv_active'] = $data['dpv_active'] ?? null; + $this->container['dpv_inactive_reason'] = $data['dpv_inactive_reason'] ?? null; + $this->container['dpv_throwback'] = $data['dpv_throwback'] ?? null; + $this->container['dpv_non_delivery_day_flag'] = $data['dpv_non_delivery_day_flag'] ?? null; + $this->container['dpv_non_delivery_day_values'] = $data['dpv_non_delivery_day_values'] ?? null; + $this->container['dpv_no_secure_location'] = $data['dpv_no_secure_location'] ?? null; + $this->container['dpv_door_not_accessible'] = $data['dpv_door_not_accessible'] ?? null; $this->container['dpv_footnotes'] = $data['dpv_footnotes'] ?? null; $this->container['ews_match'] = $data['ews_match'] ?? null; $this->container['lacs_indicator'] = $data['lacs_indicator'] ?? null; @@ -410,6 +539,91 @@ public function listInvalidProperties() } } + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if ($this->container['dpv_inactive_reason'] === null) { + $invalidProperties[] = "'dpv_inactive_reason' can't be null"; + } + } + $allowedValues = $this->getDpvInactiveReasonAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!is_null($this->container['dpv_inactive_reason']) && !in_array($this->container['dpv_inactive_reason'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value '%s' for 'dpv_inactive_reason', must be one of '%s'", + $this->container['dpv_inactive_reason'], + implode("', '", $allowedValues) + ); + } + } + + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if ($this->container['dpv_throwback'] === null) { + $invalidProperties[] = "'dpv_throwback' can't be null"; + } + } + $allowedValues = $this->getDpvThrowbackAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!is_null($this->container['dpv_throwback']) && !in_array($this->container['dpv_throwback'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value '%s' for 'dpv_throwback', must be one of '%s'", + $this->container['dpv_throwback'], + implode("', '", $allowedValues) + ); + } + } + + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if ($this->container['dpv_non_delivery_day_flag'] === null) { + $invalidProperties[] = "'dpv_non_delivery_day_flag' can't be null"; + } + } + $allowedValues = $this->getDpvNonDeliveryDayFlagAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!is_null($this->container['dpv_non_delivery_day_flag']) && !in_array($this->container['dpv_non_delivery_day_flag'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value '%s' for 'dpv_non_delivery_day_flag', must be one of '%s'", + $this->container['dpv_non_delivery_day_flag'], + implode("', '", $allowedValues) + ); + } + } + + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if ($this->container['dpv_non_delivery_day_values'] === null) { + $invalidProperties[] = "'dpv_non_delivery_day_values' can't be null"; + } + } + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if ($this->container['dpv_no_secure_location'] === null) { + $invalidProperties[] = "'dpv_no_secure_location' can't be null"; + } + } + $allowedValues = $this->getDpvNoSecureLocationAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!is_null($this->container['dpv_no_secure_location']) && !in_array($this->container['dpv_no_secure_location'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value '%s' for 'dpv_no_secure_location', must be one of '%s'", + $this->container['dpv_no_secure_location'], + implode("', '", $allowedValues) + ); + } + } + + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if ($this->container['dpv_door_not_accessible'] === null) { + $invalidProperties[] = "'dpv_door_not_accessible' can't be null"; + } + } + $allowedValues = $this->getDpvDoorNotAccessibleAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!is_null($this->container['dpv_door_not_accessible']) && !in_array($this->container['dpv_door_not_accessible'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value '%s' for 'dpv_door_not_accessible', must be one of '%s'", + $this->container['dpv_door_not_accessible'], + implode("', '", $allowedValues) + ); + } + } + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { if ($this->container['dpv_footnotes'] === null) { $invalidProperties[] = "'dpv_footnotes' can't be null"; @@ -625,6 +839,221 @@ public function setDpvActive($dpv_active) } + /** + * Gets dpv_inactive_reason + * + * @return string + */ + public function getDpvInactiveReason() + { + return $this->container['dpv_inactive_reason']; + } + + /** + * Sets dpv_inactive_reason + * + * @param string $dpv_inactive_reason 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. + * + * @return self + */ + public function setDpvInactiveReason($dpv_inactive_reason) + { + $allowedValues = $this->getDpvInactiveReasonAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!in_array($dpv_inactive_reason, $allowedValues, true)) { + throw new \InvalidArgumentException( + sprintf( + "Invalid value '%s' for 'dpv_inactive_reason', must be one of '%s'", + $dpv_inactive_reason, + implode("', '", $allowedValues) + ) + ); + } + } + + $this->container['dpv_inactive_reason'] = $dpv_inactive_reason; + + return $this; + } + + + /** + * Gets dpv_throwback + * + * @return string + */ + public function getDpvThrowback() + { + return $this->container['dpv_throwback']; + } + + /** + * Sets dpv_throwback + * + * @param string $dpv_throwback 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). + * + * @return self + */ + public function setDpvThrowback($dpv_throwback) + { + $allowedValues = $this->getDpvThrowbackAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!in_array($dpv_throwback, $allowedValues, true)) { + throw new \InvalidArgumentException( + sprintf( + "Invalid value '%s' for 'dpv_throwback', must be one of '%s'", + $dpv_throwback, + implode("', '", $allowedValues) + ) + ); + } + } + + $this->container['dpv_throwback'] = $dpv_throwback; + + return $this; + } + + + /** + * Gets dpv_non_delivery_day_flag + * + * @return string + */ + public function getDpvNonDeliveryDayFlag() + { + return $this->container['dpv_non_delivery_day_flag']; + } + + /** + * Sets dpv_non_delivery_day_flag + * + * @param string $dpv_non_delivery_day_flag 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). + * + * @return self + */ + public function setDpvNonDeliveryDayFlag($dpv_non_delivery_day_flag) + { + $allowedValues = $this->getDpvNonDeliveryDayFlagAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!in_array($dpv_non_delivery_day_flag, $allowedValues, true)) { + throw new \InvalidArgumentException( + sprintf( + "Invalid value '%s' for 'dpv_non_delivery_day_flag', must be one of '%s'", + $dpv_non_delivery_day_flag, + implode("', '", $allowedValues) + ) + ); + } + } + + $this->container['dpv_non_delivery_day_flag'] = $dpv_non_delivery_day_flag; + + return $this; + } + + + /** + * Gets dpv_non_delivery_day_values + * + * @return string + */ + public function getDpvNonDeliveryDayValues() + { + return $this->container['dpv_non_delivery_day_values']; + } + + /** + * Sets dpv_non_delivery_day_values + * + * @param string $dpv_non_delivery_day_values 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). + * + * @return self + */ + public function setDpvNonDeliveryDayValues($dpv_non_delivery_day_values) + { + $this->container['dpv_non_delivery_day_values'] = $dpv_non_delivery_day_values; + + return $this; + } + + + /** + * Gets dpv_no_secure_location + * + * @return string + */ + public function getDpvNoSecureLocation() + { + return $this->container['dpv_no_secure_location']; + } + + /** + * Sets dpv_no_secure_location + * + * @param string $dpv_no_secure_location 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). + * + * @return self + */ + public function setDpvNoSecureLocation($dpv_no_secure_location) + { + $allowedValues = $this->getDpvNoSecureLocationAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!in_array($dpv_no_secure_location, $allowedValues, true)) { + throw new \InvalidArgumentException( + sprintf( + "Invalid value '%s' for 'dpv_no_secure_location', must be one of '%s'", + $dpv_no_secure_location, + implode("', '", $allowedValues) + ) + ); + } + } + + $this->container['dpv_no_secure_location'] = $dpv_no_secure_location; + + return $this; + } + + + /** + * Gets dpv_door_not_accessible + * + * @return string + */ + public function getDpvDoorNotAccessible() + { + return $this->container['dpv_door_not_accessible']; + } + + /** + * Sets dpv_door_not_accessible + * + * @param string $dpv_door_not_accessible 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). + * + * @return self + */ + public function setDpvDoorNotAccessible($dpv_door_not_accessible) + { + $allowedValues = $this->getDpvDoorNotAccessibleAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!in_array($dpv_door_not_accessible, $allowedValues, true)) { + throw new \InvalidArgumentException( + sprintf( + "Invalid value '%s' for 'dpv_door_not_accessible', must be one of '%s'", + $dpv_door_not_accessible, + implode("', '", $allowedValues) + ) + ); + } + } + + $this->container['dpv_door_not_accessible'] = $dpv_door_not_accessible; + + return $this; + } + + /** * Gets dpv_footnotes * diff --git a/lib/Model/DpvFootnote.php b/lib/Model/DpvFootnote.php index 2140096..38c55d9 100755 --- a/lib/Model/DpvFootnote.php +++ b/lib/Model/DpvFootnote.php @@ -51,18 +51,22 @@ enum DpvFootnote: string case CC = 'CC'; - case N1 = 'N1'; + case C1 = 'C1'; case F1 = 'F1'; case G1 = 'G1'; - case U1 = 'U1'; + case IA = 'IA'; case M1 = 'M1'; case M3 = 'M3'; + case N1 = 'N1'; + + case PB = 'PB'; + case P1 = 'P1'; case P3 = 'P3'; @@ -73,6 +77,10 @@ enum DpvFootnote: string case RR = 'RR'; + case TA = 'TA'; + + case U1 = 'U1'; + } diff --git a/lib/Model/UsComponents.php b/lib/Model/UsComponents.php index 1da1741..19cfbf7 100755 --- a/lib/Model/UsComponents.php +++ b/lib/Model/UsComponents.php @@ -85,6 +85,7 @@ class UsComponents implements ModelInterface, ArrayAccess, \JsonSerializable 'county_fips' => 'string', 'carrier_route' => 'string', 'carrier_route_type' => 'string', + 'po_box_only_flag' => 'string', 'latitude' => 'float', 'longitude' => 'float' ]; @@ -121,6 +122,7 @@ class UsComponents implements ModelInterface, ArrayAccess, \JsonSerializable 'county_fips' => null, 'carrier_route' => null, 'carrier_route_type' => null, + 'po_box_only_flag' => null, 'latitude' => 'float', 'longitude' => 'float' ]; @@ -176,6 +178,7 @@ public static function openAPIFormats() 'county_fips' => 'county_fips', 'carrier_route' => 'carrier_route', 'carrier_route_type' => 'carrier_route_type', + 'po_box_only_flag' => 'po_box_only_flag', 'latitude' => 'latitude', 'longitude' => 'longitude' ]; @@ -210,6 +213,7 @@ public static function openAPIFormats() 'county_fips' => 'setCountyFips', 'carrier_route' => 'setCarrierRoute', 'carrier_route_type' => 'setCarrierRouteType', + 'po_box_only_flag' => 'setPoBoxOnlyFlag', 'latitude' => 'setLatitude', 'longitude' => 'setLongitude' ]; @@ -244,6 +248,7 @@ public static function openAPIFormats() 'county_fips' => 'getCountyFips', 'carrier_route' => 'getCarrierRoute', 'carrier_route_type' => 'getCarrierRouteType', + 'po_box_only_flag' => 'getPoBoxOnlyFlag', 'latitude' => 'getLatitude', 'longitude' => 'getLongitude' ]; @@ -323,6 +328,9 @@ public function getModelName() const CARRIER_ROUTE_TYPE_PO_BOX = 'po_box'; const CARRIER_ROUTE_TYPE_GENERAL_DELIVERY = 'general_delivery'; const CARRIER_ROUTE_TYPE_EMPTY = ''; + const PO_BOX_ONLY_FLAG_Y = 'Y'; + const PO_BOX_ONLY_FLAG_N = 'N'; + const PO_BOX_ONLY_FLAG_EMPTY = ''; /** * Gets allowable values of the enum @@ -413,6 +421,20 @@ public function getCarrierRouteTypeAllowableValues() ]; } + /** + * Gets allowable values of the enum + * + * @return string[] + */ + public function getPoBoxOnlyFlagAllowableValues() + { + return [ + self::PO_BOX_ONLY_FLAG_Y, + self::PO_BOX_ONLY_FLAG_N, + self::PO_BOX_ONLY_FLAG_EMPTY, + ]; + } + /** * Associative array for storing property values * @@ -452,6 +474,7 @@ public function __construct(array $data = null) $this->container['county_fips'] = $data['county_fips'] ?? null; $this->container['carrier_route'] = $data['carrier_route'] ?? null; $this->container['carrier_route_type'] = $data['carrier_route_type'] ?? null; + $this->container['po_box_only_flag'] = $data['po_box_only_flag'] ?? null; $this->container['latitude'] = $data['latitude'] ?? null; $this->container['longitude'] = $data['longitude'] ?? null; } @@ -664,6 +687,22 @@ public function listInvalidProperties() } } + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if ($this->container['po_box_only_flag'] === null) { + $invalidProperties[] = "'po_box_only_flag' can't be null"; + } + } + $allowedValues = $this->getPoBoxOnlyFlagAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!is_null($this->container['po_box_only_flag']) && !in_array($this->container['po_box_only_flag'], $allowedValues, true)) { + $invalidProperties[] = sprintf( + "invalid value '%s' for 'po_box_only_flag', must be one of '%s'", + $this->container['po_box_only_flag'], + implode("', '", $allowedValues) + ); + } + } + return $invalidProperties; } @@ -1371,6 +1410,44 @@ public function setCarrierRouteType($carrier_route_type) } + /** + * Gets po_box_only_flag + * + * @return string + */ + public function getPoBoxOnlyFlag() + { + return $this->container['po_box_only_flag']; + } + + /** + * Sets po_box_only_flag + * + * @param string $po_box_only_flag Indicates the mailing facility for an address only supports PO Box deliveries and other forms of mail delivery are not available. + * + * @return self + */ + public function setPoBoxOnlyFlag($po_box_only_flag) + { + $allowedValues = $this->getPoBoxOnlyFlagAllowableValues(); + if (!method_exists($this, 'getId') || (!empty($this->getId()) && strpos($this->getId(), "fakeId") === False)) { + if (!in_array($po_box_only_flag, $allowedValues, true)) { + throw new \InvalidArgumentException( + sprintf( + "Invalid value '%s' for 'po_box_only_flag', must be one of '%s'", + $po_box_only_flag, + implode("', '", $allowedValues) + ) + ); + } + } + + $this->container['po_box_only_flag'] = $po_box_only_flag; + + return $this; + } + + /** * Gets latitude *