Skip to content

Commit

Permalink
feat(us_verification): adding transient id field to us verification a…
Browse files Browse the repository at this point in the history
…nd bulk verification
  • Loading branch information
mrkaspa committed Jan 31, 2024
1 parent 9dc371f commit 0f2b8f4
Show file tree
Hide file tree
Showing 9 changed files with 24 additions and 3 deletions.
1 change: 1 addition & 0 deletions docs/MultipleComponents.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ Name | Type | Description | Notes
**city** | [**City**](City.md) | | [optional]
**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]
**zip_code** | [**ZipCode**](ZipCode.md) | | [optional]
**transient_id** | **str** | ID that is returned in the response body for the verification | [optional]
**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]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
2 changes: 2 additions & 0 deletions docs/UsVerification.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,12 @@ Name | Type | Description | Notes
**urbanization** | [**Urbanization**](Urbanization.md) | | [optional]
**last_line** | **str** | Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) | [optional]
**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]
**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]
**components** | [**UsComponents**](UsComponents.md) | | [optional]
**deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional]
**lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional]
**object** | **str** | | [optional] if omitted the server will use the default value of "us_verification"
**transient_id** | **str** | ID that is returned in the response body for the verification | [optional]
**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]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
1 change: 1 addition & 0 deletions docs/UsVerificationOrError.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Name | Type | Description | Notes
**deliverability_analysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional]
**lob_confidence_score** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional]
**object** | **str** | | [optional] if omitted the server will use the default value of "us_verification"
**transient_id** | **str** | ID that is returned in the response body for the verification | [optional]
**error** | [**BulkError**](BulkError.md) | | [optional]
**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]

Expand Down
Empty file modified docs/UsVerifications.md
100644 → 100755
Empty file.
3 changes: 2 additions & 1 deletion docs/UsVerificationsWritable.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**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]
**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]
**recipient** | [**Recipient**](Recipient.md) | | [optional]
**primary_line** | [**PrimaryLineUs**](PrimaryLineUs.md) | | [optional]
**secondary_line** | [**SecondaryLine**](SecondaryLine.md) | | [optional]
**urbanization** | [**Urbanization**](Urbanization.md) | | [optional]
**city** | [**City**](City.md) | | [optional]
**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]
**zip_code** | [**ZipCode**](ZipCode.md) | | [optional]
**transient_id** | **str** | ID that is returned in the response body for the verification | [optional]
**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]

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
Expand Down
4 changes: 4 additions & 0 deletions lob_python/model/multiple_components.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,7 @@ def openapi_types():
'city': (str, type(None)), # noqa: E501
'state': (str, type(None)), # noqa: E501
'zip_code': (str, type(None)), # noqa: E501
'transient_id': (str, type(None)), # noqa: E501
}

@cached_property
Expand All @@ -119,6 +120,7 @@ def discriminator():
'city': 'city', # noqa: E501
'state': 'state', # noqa: E501
'zip_code': 'zip_code', # noqa: E501
'transient_id': 'transient_id', # noqa: E501
}

read_only_vars = {
Expand Down Expand Up @@ -171,6 +173,7 @@ def _from_openapi_data(cls, primary_line, *args, **kwargs): # noqa: E501
city (str, type(None)): [optional] # noqa: E501
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
zip_code (str, type(None)): [optional] # noqa: E501
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down Expand Up @@ -262,6 +265,7 @@ def __init__(self, primary_line, *args, **kwargs): # noqa: E501
city (str, type(None)): [optional] # noqa: E501
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
zip_code (str, type(None)): [optional] # noqa: E501
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down
4 changes: 4 additions & 0 deletions lob_python/model/us_verification.py
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ def openapi_types():
'deliverability_analysis': (DeliverabilityAnalysis, type(None)), # noqa: E501
'lob_confidence_score': (LobConfidenceScore, type(None)), # noqa: E501
'object': (str, type(None)), # noqa: E501
'transient_id': (str, type(None)), # noqa: E501
}

@cached_property
Expand All @@ -140,6 +141,7 @@ def discriminator():
'deliverability_analysis': 'deliverability_analysis', # noqa: E501
'lob_confidence_score': 'lob_confidence_score', # noqa: E501
'object': 'object', # noqa: E501
'transient_id': 'transient_id', # noqa: E501
}

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

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

_check_type = kwargs.pop('_check_type', True)
Expand Down
4 changes: 4 additions & 0 deletions lob_python/model/us_verification_or_error.py
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ def openapi_types():
'deliverability_analysis': (DeliverabilityAnalysis, type(None)), # noqa: E501
'lob_confidence_score': (LobConfidenceScore, type(None)), # noqa: E501
'object': (str, type(None)), # noqa: E501
'transient_id': (str, type(None)), # noqa: E501
'error': (BulkError, type(None)), # noqa: E501
}

Expand All @@ -141,6 +142,7 @@ def discriminator():
'deliverability_analysis': 'deliverability_analysis', # noqa: E501
'lob_confidence_score': 'lob_confidence_score', # noqa: E501
'object': 'object', # noqa: E501
'transient_id': 'transient_id', # noqa: E501
'error': 'error', # noqa: E501
}

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

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

Expand Down
8 changes: 6 additions & 2 deletions lob_python/model/us_verifications_writable.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,7 @@ def openapi_types():
'city': (str, type(None)), # noqa: E501
'state': (str, type(None)), # noqa: E501
'zip_code': (str, type(None)), # noqa: E501
'transient_id': (str, type(None)), # noqa: E501
}

@cached_property
Expand All @@ -124,6 +125,7 @@ def discriminator():
'city': 'city', # noqa: E501
'state': 'state', # noqa: E501
'zip_code': 'zip_code', # noqa: E501
'transient_id': 'transient_id', # noqa: E501
}

read_only_vars = {
Expand Down Expand Up @@ -167,14 +169,15 @@ def _from_openapi_data(cls, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
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
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
recipient (str, type(None)): [optional] # noqa: E501
primary_line (str, type(None)): [optional] # noqa: E501
secondary_line (str, type(None)): [optional] # noqa: E501
urbanization (str, type(None)): [optional] # noqa: E501
city (str, type(None)): [optional] # noqa: E501
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
zip_code (str, type(None)): [optional] # noqa: E501
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down Expand Up @@ -256,14 +259,15 @@ def __init__(self, *args, **kwargs): # noqa: E501
Animal class but this time we won't travel
through its discriminator because we passed in
_visited_composed_classes = (Animal,)
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
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
recipient (str, type(None)): [optional] # noqa: E501
primary_line (str, type(None)): [optional] # noqa: E501
secondary_line (str, type(None)): [optional] # noqa: E501
urbanization (str, type(None)): [optional] # noqa: E501
city (str, type(None)): [optional] # noqa: E501
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
zip_code (str, type(None)): [optional] # noqa: E501
transient_id (str, type(None)): ID that is returned in the response body for the verification . [optional] # noqa: E501
"""

_check_type = kwargs.pop('_check_type', True)
Expand Down

0 comments on commit 0f2b8f4

Please sign in to comment.