Skip to content

Commit 0f2b8f4

Browse files
mrkaspamrkaspa
committed
feat(us_verification): adding transient id field to us verification and bulk verification
1 parent 9dc371f commit 0f2b8f4

9 files changed

+24
-3
lines changed

‎docs/MultipleComponents.md‎

100644100755
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
1111
**city** | [**City**](City.md) | | [optional]
1212
**state** | **str** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. | [optional]
1313
**zip_code** | [**ZipCode**](ZipCode.md) | | [optional]
14+
**transient_id** | **str** | ID that is returned in the response body for the verification | [optional]
1415
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
1516

1617
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/UsVerification.md‎

100644100755
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@ Name | Type | Description | Notes
1111
**urbanization** | [**Urbanization**](Urbanization.md) | | [optional]
1212
**last_line** | **str** | Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) | [optional]
1313
**deliverability** | **str** | Summarizes the deliverability of the `us_verification` object. For full details, see the `deliverability_analysis` field. Possible values are: * `deliverable` – The address is deliverable by the USPS. * `deliverable_unnecessary_unit` – The address is deliverable, but the secondary unit information is unnecessary. * `deliverable_incorrect_unit` – The address is deliverable to the building's default address but the secondary unit provided may not exist. There is a chance the mail will not reach the intended recipient. * `deliverable_missing_unit` – The address is deliverable to the building's default address but is missing secondary unit information. There is a chance the mail will not reach the intended recipient. * `undeliverable` – The address is not deliverable according to the USPS. | [optional]
14+
**valid_address** | **bool** | This field indicates whether an address was found in a more comprehensive address dataset that includes sources from the USPS, open source mapping data, and our proprietary mail delivery data. This field can be interpreted as a representation of whether an address is a real location or not. Additionally a valid address may contradict the deliverability field since an address can be a real valid location but the USPS may not deliver to that address. | [optional]
1415
**components** | [**UsComponents**](UsComponents.md) | | [optional]
1516
**deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional]
1617
**lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional]
1718
**object** | **str** | | [optional] if omitted the server will use the default value of "us_verification"
19+
**transient_id** | **str** | ID that is returned in the response body for the verification | [optional]
1820
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
1921

2022
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎docs/UsVerificationOrError.md‎

100644100755
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
1616
**deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional]
1717
**lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional]
1818
**object** | **str** | | [optional] if omitted the server will use the default value of "us_verification"
19+
**transient_id** | **str** | ID that is returned in the response body for the verification | [optional]
1920
**error** | [**BulkError**](BulkError.md) | | [optional]
2021
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
2122

‎docs/UsVerifications.md‎

100644100755
File mode changed.

‎docs/UsVerificationsWritable.md‎

100644100755
Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44
## Properties
55
Name | Type | Description | Notes
66
------------ | ------------- | ------------- | -------------
7-
**address** | **str** | The entire address in one string (e.g., \"210 King Street 94107\"). _Does not support a recipient and will error when other payload parameters are provided._ | [optional]
7+
**address** | **str** | The entire address in one string (e.g., \"2261 Market Street 94114\"). _Does not support a recipient and will error when other payload parameters are provided._ | [optional]
88
**recipient** | [**Recipient**](Recipient.md) | | [optional]
99
**primary_line** | [**PrimaryLineUs**](PrimaryLineUs.md) | | [optional]
1010
**secondary_line** | [**SecondaryLine**](SecondaryLine.md) | | [optional]
1111
**urbanization** | [**Urbanization**](Urbanization.md) | | [optional]
1212
**city** | [**City**](City.md) | | [optional]
1313
**state** | **str** | The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. | [optional]
1414
**zip_code** | [**ZipCode**](ZipCode.md) | | [optional]
15+
**transient_id** | **str** | ID that is returned in the response body for the verification | [optional]
1516
**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
1617

1718
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

‎lob_python/model/multiple_components.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ def openapi_types():
104104
'city': (str, type(None)), # noqa: E501
105105
'state': (str, type(None)), # noqa: E501
106106
'zip_code': (str, type(None)), # noqa: E501
107+
'transient_id': (str, type(None)), # noqa: E501
107108
}
108109

109110
@cached_property
@@ -119,6 +120,7 @@ def discriminator():
119120
'city': 'city', # noqa: E501
120121
'state': 'state', # noqa: E501
121122
'zip_code': 'zip_code', # noqa: E501
123+
'transient_id': 'transient_id', # noqa: E501
122124
}
123125

124126
read_only_vars = {
@@ -171,6 +173,7 @@ def _from_openapi_data(cls, primary_line, *args, **kwargs): # noqa: E501
171173
city (str, type(None)): [optional] # noqa: E501
172174
state (str, type(None)): The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed.. [optional] # noqa: E501
173175
zip_code (str, type(None)): [optional] # noqa: E501
176+
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
174177
"""
175178

176179
_check_type = kwargs.pop('_check_type', True)
@@ -262,6 +265,7 @@ def __init__(self, primary_line, *args, **kwargs): # noqa: E501
262265
city (str, type(None)): [optional] # noqa: E501
263266
state (str, type(None)): The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed.. [optional] # noqa: E501
264267
zip_code (str, type(None)): [optional] # noqa: E501
268+
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
265269
"""
266270

267271
_check_type = kwargs.pop('_check_type', True)

‎lob_python/model/us_verification.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,7 @@ def openapi_types():
120120
'deliverability_analysis': (DeliverabilityAnalysis, type(None)), # noqa: E501
121121
'lob_confidence_score': (LobConfidenceScore, type(None)), # noqa: E501
122122
'object': (str, type(None)), # noqa: E501
123+
'transient_id': (str, type(None)), # noqa: E501
123124
}
124125

125126
@cached_property
@@ -140,6 +141,7 @@ def discriminator():
140141
'deliverability_analysis': 'deliverability_analysis', # noqa: E501
141142
'lob_confidence_score': 'lob_confidence_score', # noqa: E501
142143
'object': 'object', # noqa: E501
144+
'transient_id': 'transient_id', # noqa: E501
143145
}
144146

145147
read_only_vars = {
@@ -195,6 +197,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
195197
deliverability_analysis (DeliverabilityAnalysis, type(None)): [optional] # noqa: E501
196198
lob_confidence_score (LobConfidenceScore, type(None)): [optional] # noqa: E501
197199
object (str, type(None)): [optional] if omitted the server will use the default value of "us_verification" # noqa: E501
200+
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
198201
"""
199202

200203
_check_type = kwargs.pop('_check_type', True)
@@ -288,6 +291,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
288291
deliverability_analysis (DeliverabilityAnalysis, type(None)): [optional] # noqa: E501
289292
lob_confidence_score (LobConfidenceScore, type(None)): [optional] # noqa: E501
290293
object (str, type(None)): [optional] if omitted the server will use the default value of "us_verification" # noqa: E501
294+
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
291295
"""
292296

293297
_check_type = kwargs.pop('_check_type', True)

‎lob_python/model/us_verification_or_error.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ def openapi_types():
121121
'deliverability_analysis': (DeliverabilityAnalysis, type(None)), # noqa: E501
122122
'lob_confidence_score': (LobConfidenceScore, type(None)), # noqa: E501
123123
'object': (str, type(None)), # noqa: E501
124+
'transient_id': (str, type(None)), # noqa: E501
124125
'error': (BulkError, type(None)), # noqa: E501
125126
}
126127

@@ -141,6 +142,7 @@ def discriminator():
141142
'deliverability_analysis': 'deliverability_analysis', # noqa: E501
142143
'lob_confidence_score': 'lob_confidence_score', # noqa: E501
143144
'object': 'object', # noqa: E501
145+
'transient_id': 'transient_id', # noqa: E501
144146
'error': 'error', # noqa: E501
145147
}
146148

@@ -196,6 +198,7 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
196198
deliverability_analysis (DeliverabilityAnalysis, type(None)): [optional] # noqa: E501
197199
lob_confidence_score (LobConfidenceScore, type(None)): [optional] # noqa: E501
198200
object (str, type(None)): [optional] if omitted the server will use the default value of "us_verification" # noqa: E501
201+
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
199202
error (BulkError, type(None)): [optional] # noqa: E501
200203
"""
201204

@@ -289,6 +292,7 @@ def __init__(self, *args, **kwargs): # noqa: E501
289292
deliverability_analysis (DeliverabilityAnalysis, type(None)): [optional] # noqa: E501
290293
lob_confidence_score (LobConfidenceScore, type(None)): [optional] # noqa: E501
291294
object (str, type(None)): [optional] if omitted the server will use the default value of "us_verification" # noqa: E501
295+
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
292296
error (BulkError, type(None)): [optional] # noqa: E501
293297
"""
294298

‎lob_python/model/us_verifications_writable.py‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,7 @@ def openapi_types():
108108
'city': (str, type(None)), # noqa: E501
109109
'state': (str, type(None)), # noqa: E501
110110
'zip_code': (str, type(None)), # noqa: E501
111+
'transient_id': (str, type(None)), # noqa: E501
111112
}
112113

113114
@cached_property
@@ -124,6 +125,7 @@ def discriminator():
124125
'city': 'city', # noqa: E501
125126
'state': 'state', # noqa: E501
126127
'zip_code': 'zip_code', # noqa: E501
128+
'transient_id': 'transient_id', # noqa: E501
127129
}
128130

129131
read_only_vars = {
@@ -167,14 +169,15 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
167169
Animal class but this time we won't travel
168170
through its discriminator because we passed in
169171
_visited_composed_classes = (Animal,)
170-
address (str, type(None)): The entire address in one string (e.g., \"210 King Street 94107\"). _Does not support a recipient and will error when other payload parameters are provided._ . [optional] # noqa: E501
172+
address (str, type(None)): The entire address in one string (e.g., \"2261 Market Street 94114\"). _Does not support a recipient and will error when other payload parameters are provided._ . [optional] # noqa: E501
171173
recipient (str, type(None)): [optional] # noqa: E501
172174
primary_line (str, type(None)): [optional] # noqa: E501
173175
secondary_line (str, type(None)): [optional] # noqa: E501
174176
urbanization (str, type(None)): [optional] # noqa: E501
175177
city (str, type(None)): [optional] # noqa: E501
176178
state (str, type(None)): The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed.. [optional] # noqa: E501
177179
zip_code (str, type(None)): [optional] # noqa: E501
180+
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
178181
"""
179182

180183
_check_type = kwargs.pop('_check_type', True)
@@ -256,14 +259,15 @@ def __init__(self, *args, **kwargs): # noqa: E501
256259
Animal class but this time we won't travel
257260
through its discriminator because we passed in
258261
_visited_composed_classes = (Animal,)
259-
address (str, type(None)): The entire address in one string (e.g., \"210 King Street 94107\"). _Does not support a recipient and will error when other payload parameters are provided._ . [optional] # noqa: E501
262+
address (str, type(None)): The entire address in one string (e.g., \"2261 Market Street 94114\"). _Does not support a recipient and will error when other payload parameters are provided._ . [optional] # noqa: E501
260263
recipient (str, type(None)): [optional] # noqa: E501
261264
primary_line (str, type(None)): [optional] # noqa: E501
262265
secondary_line (str, type(None)): [optional] # noqa: E501
263266
urbanization (str, type(None)): [optional] # noqa: E501
264267
city (str, type(None)): [optional] # noqa: E501
265268
state (str, type(None)): The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2:US) two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed.. [optional] # noqa: E501
266269
zip_code (str, type(None)): [optional] # noqa: E501
270+
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
267271
"""
268272

269273
_check_type = kwargs.pop('_check_type', True)

0 commit comments

Comments
 (0)