Skip to content

Commit c9837c3

Browse files
committed
updating cycle o model's fields
1 parent 0eb13de commit c9837c3

2 files changed

Lines changed: 80 additions & 4 deletions

File tree

lob_python/model/deliverability_analysis.py

100755100644
Lines changed: 67 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,35 @@ class DeliverabilityAnalysis(ModelNormal):
8080
'N': "N",
8181
'EMPTY': "",
8282
},
83+
('dpv_inactive_reason',): {
84+
'01': "01",
85+
'02': "02",
86+
'03': "03",
87+
'04': "04",
88+
'05': "05",
89+
'06': "06",
90+
'EMPTY': "",
91+
},
92+
('dpv_throwback',): {
93+
'Y': "Y",
94+
'N': "N",
95+
'EMPTY': "",
96+
},
97+
('dpv_non_delivery_day_flag',): {
98+
'Y': "Y",
99+
'N': "N",
100+
'EMPTY': "",
101+
},
102+
('dpv_no_secure_location',): {
103+
'Y': "Y",
104+
'N': "N",
105+
'EMPTY': "",
106+
},
107+
('dpv_door_not_accessible',): {
108+
'Y': "Y",
109+
'N': "N",
110+
'EMPTY': "",
111+
},
83112
('lacs_indicator',): {
84113
'Y': "Y",
85114
'N': "N",
@@ -120,6 +149,12 @@ def openapi_types():
120149
'dpv_cmra': (str,), # noqa: E501
121150
'dpv_vacant': (str,), # noqa: E501
122151
'dpv_active': (str,), # noqa: E501
152+
'dpv_inactive_reason': (str,), # noqa: E501
153+
'dpv_throwback': (str,), # noqa: E501
154+
'dpv_non_delivery_day_flag': (str,), # noqa: E501
155+
'dpv_non_delivery_day_values': (str,), # noqa: E501
156+
'dpv_no_secure_location': (str,), # noqa: E501
157+
'dpv_door_not_accessible': (str,), # noqa: E501
123158
'dpv_footnotes': (list,), # noqa: E501
124159
'ews_match': (bool,), # noqa: E501
125160
'lacs_indicator': (str,), # noqa: E501
@@ -137,6 +172,12 @@ def discriminator():
137172
'dpv_cmra': 'dpv_cmra', # noqa: E501
138173
'dpv_vacant': 'dpv_vacant', # noqa: E501
139174
'dpv_active': 'dpv_active', # noqa: E501
175+
'dpv_inactive_reason': 'dpv_inactive_reason', # noqa: E501
176+
'dpv_throwback': 'dpv_throwback', # noqa: E501
177+
'dpv_non_delivery_day_flag': 'dpv_non_delivery_day_flag', # noqa: E501
178+
'dpv_non_delivery_day_values': 'dpv_non_delivery_day_values', # noqa: E501
179+
'dpv_no_secure_location': 'dpv_no_secure_location', # noqa: E501
180+
'dpv_door_not_accessible': 'dpv_door_not_accessible', # noqa: E501
140181
'dpv_footnotes': 'dpv_footnotes', # noqa: E501
141182
'ews_match': 'ews_match', # noqa: E501
142183
'lacs_indicator': 'lacs_indicator', # noqa: E501
@@ -151,14 +192,20 @@ def discriminator():
151192

152193
@classmethod
153194
@convert_js_args_to_python_args
154-
def _from_openapi_data(cls, dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active, dpv_footnotes, ews_match, lacs_indicator, lacs_return_code, suite_return_code, *args, **kwargs): # noqa: E501
195+
def _from_openapi_data(cls, dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active, dpv_inactive_reason, dpv_throwback, dpv_non_delivery_day_flag, dpv_non_delivery_day_values, dpv_no_secure_location, dpv_door_not_accessible, dpv_footnotes, ews_match, lacs_indicator, lacs_return_code, suite_return_code, *args, **kwargs): # noqa: E501
155196
"""DeliverabilityAnalysis - a model defined in OpenAPI
156197
157198
Args:
158199
dpv_confirmation (str): Result of Delivery Point Validation (DPV), which determines whether or not the address is deliverable by the USPS. Possible values are: * `Y` –– The address is deliverable by the USPS. * `S` –– The address is deliverable by removing the provided secondary unit designator. This information may be incorrect or unnecessary. * `D` –– The address is deliverable to the building's default address but is missing a secondary unit designator and/or number. There is a chance the mail will not reach the intended recipient. * `N` –– The address is not deliverable according to the USPS, but parts of the address are valid (such as the street and ZIP code). * `''` –– This address is not deliverable. No matching street could be found within the city or ZIP code.
159200
dpv_cmra (str): 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).
160201
dpv_vacant (str): 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).
161202
dpv_active (str): 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).
203+
dpv_inactive_reason (str): 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.
204+
dpv_throwback (str): 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).
205+
dpv_non_delivery_day_flag (str): 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).
206+
dpv_non_delivery_day_values (str): 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).
207+
dpv_no_secure_location (str): 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).
208+
dpv_door_not_accessible (str): 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).
162209
dpv_footnotes (list): 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).
163210
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.
164211
lacs_indicator (str): 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).
@@ -227,6 +274,12 @@ def _from_openapi_data(cls, dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active,
227274
self.dpv_cmra = dpv_cmra
228275
self.dpv_vacant = dpv_vacant
229276
self.dpv_active = dpv_active
277+
self.dpv_inactive_reason = dpv_inactive_reason
278+
self.dpv_throwback = dpv_throwback
279+
self.dpv_non_delivery_day_flag = dpv_non_delivery_day_flag
280+
self.dpv_non_delivery_day_values = dpv_non_delivery_day_values
281+
self.dpv_no_secure_location = dpv_no_secure_location
282+
self.dpv_door_not_accessible = dpv_door_not_accessible
230283
self.dpv_footnotes = dpv_footnotes
231284
self.ews_match = ews_match
232285
self.lacs_indicator = lacs_indicator
@@ -252,14 +305,20 @@ def _from_openapi_data(cls, dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active,
252305
])
253306

254307
@convert_js_args_to_python_args
255-
def __init__(self, dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active, dpv_footnotes, ews_match, lacs_indicator, lacs_return_code, suite_return_code, *args, **kwargs): # noqa: E501
308+
def __init__(self, dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active, dpv_inactive_reason, dpv_throwback, dpv_non_delivery_day_flag, dpv_non_delivery_day_values, dpv_no_secure_location, dpv_door_not_accessible, dpv_footnotes, ews_match, lacs_indicator, lacs_return_code, suite_return_code, *args, **kwargs): # noqa: E501
256309
"""DeliverabilityAnalysis - a model defined in OpenAPI
257310
258311
Args:
259312
dpv_confirmation (str): Result of Delivery Point Validation (DPV), which determines whether or not the address is deliverable by the USPS. Possible values are: * `Y` –– The address is deliverable by the USPS. * `S` –– The address is deliverable by removing the provided secondary unit designator. This information may be incorrect or unnecessary. * `D` –– The address is deliverable to the building's default address but is missing a secondary unit designator and/or number. There is a chance the mail will not reach the intended recipient. * `N` –– The address is not deliverable according to the USPS, but parts of the address are valid (such as the street and ZIP code). * `''` –– This address is not deliverable. No matching street could be found within the city or ZIP code.
260313
dpv_cmra (str): 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).
261314
dpv_vacant (str): 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).
262315
dpv_active (str): 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).
316+
dpv_inactive_reason (str): 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.
317+
dpv_throwback (str): 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).
318+
dpv_non_delivery_day_flag (str): 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).
319+
dpv_non_delivery_day_values (str): 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).
320+
dpv_no_secure_location (str): 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).
321+
dpv_door_not_accessible (str): 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).
263322
dpv_footnotes ([DpvFootnote]): 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).
264323
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.
265324
lacs_indicator (str): 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).
@@ -326,6 +385,12 @@ def __init__(self, dpv_confirmation, dpv_cmra, dpv_vacant, dpv_active, dpv_footn
326385
self.dpv_cmra = dpv_cmra
327386
self.dpv_vacant = dpv_vacant
328387
self.dpv_active = dpv_active
388+
self.dpv_inactive_reason = dpv_inactive_reason
389+
self.dpv_throwback = dpv_throwback
390+
self.dpv_non_delivery_day_flag = dpv_non_delivery_day_flag
391+
self.dpv_non_delivery_day_values = dpv_non_delivery_day_values
392+
self.dpv_no_secure_location = dpv_no_secure_location
393+
self.dpv_door_not_accessible = dpv_door_not_accessible
329394
self.dpv_footnotes = dpv_footnotes
330395
self.ews_match = ews_match
331396
self.lacs_indicator = lacs_indicator

0 commit comments

Comments
 (0)