AV-4535 feat(us_verification): adding transient id field to us verification a…

docs/Model/MultipleComponents.md

@@ -11,5 +11,6 @@ Name | Type | Description | Notes
 **city** | **string** |  | [optional]
 **state** | **string** | 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** | **string** | Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`). | [optional]
+**transient_id** | **string** | ID that is returned in the response body for the verification | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/Model/UsVerification.md

@@ -11,9 +11,11 @@ Name | Type | Description | Notes
 **urbanization** | **string** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification. | [optional]
 **last_line** | **string** | Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) | [optional]
 **deliverability** | **string** | 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** | [**\OpenAPI\Client\Model\UsComponents**](UsComponents.md) |  | [optional]
 **deliverability_analysis** | [**\OpenAPI\Client\Model\DeliverabilityAnalysis**](DeliverabilityAnalysis.md) |  | [optional]
 **lob_confidence_score** | [**\OpenAPI\Client\Model\LobConfidenceScore**](LobConfidenceScore.md) |  | [optional]
 **object** | **string** |  | [optional] [default to OBJECT_US_VERIFICATION]
+**transient_id** | **string** | ID that is returned in the response body for the verification | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/Model/UsVerificationOrError.md

@@ -15,6 +15,7 @@ Name | Type | Description | Notes
 **deliverability_analysis** | [**\OpenAPI\Client\Model\DeliverabilityAnalysis**](DeliverabilityAnalysis.md) |  | [optional]
 **lob_confidence_score** | [**\OpenAPI\Client\Model\LobConfidenceScore**](LobConfidenceScore.md) |  | [optional]
 **object** | **string** |  | [optional] [default to OBJECT_US_VERIFICATION]
+**transient_id** | **string** | ID that is returned in the response body for the verification | [optional]
 **error** | [**\OpenAPI\Client\Model\BulkError**](BulkError.md) |  | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

docs/Model/UsVerificationsWritable.md

@@ -4,13 +4,14 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**address** | **string** | 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** | **string** | 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** | **string** | The intended recipient, typically a person's or firm's name. | [optional]
 **primary_line** | **string** | The primary delivery line (usually the street address) of the address. Combination of the following applicable `components`: * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` | [optional]
 **secondary_line** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional]
 **urbanization** | **string** | Only present for addresses in Puerto Rico. An urbanization refers to an area, sector, or development within a city. See [USPS documentation](https://pe.usps.com/text/pub28/28api_008.htm#:~:text=I51.,-4%20Urbanizations&text=In%20Puerto%20Rico%2C%20identical%20street,placed%20before%20the%20urbanization%20name.) for clarification. | [optional]
 **city** | **string** |  | [optional]
 **state** | **string** | 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** | **string** | Required if `city` and `state` are not passed in. If included, must be formatted as a US ZIP or ZIP+4 (e.g. `94107`, `941072282`, `94107-2282`). | [optional]
+**transient_id** | **string** | ID that is returned in the response body for the verification | [optional]
 
 [[Back to Model list]](../../README.md#models) [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

lib/Model/MultipleComponents.php

@@ -66,7 +66,8 @@ class MultipleComponents implements ModelInterface, ArrayAccess, \JsonSerializab
         'urbanization' => 'string',
         'city' => 'string',
         'state' => 'string',
-        'zip_code' => 'string'
+        'zip_code' => 'string',
+        'transient_id' => 'string'
     ];
 
     /**
@@ -83,7 +84,8 @@ class MultipleComponents implements ModelInterface, ArrayAccess, \JsonSerializab
         'urbanization' => null,
         'city' => null,
         'state' => null,
-        'zip_code' => null
+        'zip_code' => null,
+        'transient_id' => null
     ];
 
     /**
@@ -119,7 +121,8 @@ public static function openAPIFormats()
         'urbanization' => 'urbanization',
         'city' => 'city',
         'state' => 'state',
-        'zip_code' => 'zip_code'
+        'zip_code' => 'zip_code',
+        'transient_id' => 'transient_id'
     ];
 
     /**
@@ -134,7 +137,8 @@ public static function openAPIFormats()
         'urbanization' => 'setUrbanization',
         'city' => 'setCity',
         'state' => 'setState',
-        'zip_code' => 'setZipCode'
+        'zip_code' => 'setZipCode',
+        'transient_id' => 'setTransientId'
     ];
 
     /**
@@ -149,7 +153,8 @@ public static function openAPIFormats()
         'urbanization' => 'getUrbanization',
         'city' => 'getCity',
         'state' => 'getState',
-        'zip_code' => 'getZipCode'
+        'zip_code' => 'getZipCode',
+        'transient_id' => 'getTransientId'
     ];
 
     /**
@@ -216,6 +221,7 @@ public function __construct(array $data = null)
         $this->container['city'] = $data['city'] ?? null;
         $this->container['state'] = $data['state'] ?? null;
         $this->container['zip_code'] = $data['zip_code'] ?? null;
+        $this->container['transient_id'] = $data['transient_id'] ?? null;
     }
 
     /**
@@ -506,6 +512,31 @@ public function setZipCode($zip_code)
 
         return $this;
     }
+
+
+    /**
+     * Gets transient_id
+     *
+     * @return string|null
+     */
+    public function getTransientId()
+    {
+        return $this->container['transient_id'];
+    }
+
+    /**
+     * Sets transient_id
+     *
+     * @param string|null $transient_id ID that is returned in the response body for the verification
+     *
+     * @return self
+     */
+    public function setTransientId($transient_id)
+    {
+        $this->container['transient_id'] = $transient_id;
+
+        return $this;
+    }
     /**
      * Returns true if offset exists. False otherwise.
      *

lib/Model/UsVerification.php

@@ -71,7 +71,8 @@ class UsVerification implements ModelInterface, ArrayAccess, \JsonSerializable
         'components' => '\OpenAPI\Client\Model\UsComponents',
         'deliverability_analysis' => '\OpenAPI\Client\Model\DeliverabilityAnalysis',
         'lob_confidence_score' => '\OpenAPI\Client\Model\LobConfidenceScore',
-        'object' => 'string'
+        'object' => 'string',
+        'transient_id' => 'string'
     ];
 
     /**
@@ -93,7 +94,8 @@ class UsVerification implements ModelInterface, ArrayAccess, \JsonSerializable
         'components' => null,
         'deliverability_analysis' => null,
         'lob_confidence_score' => null,
-        'object' => null
+        'object' => null,
+        'transient_id' => null
     ];
 
     /**
@@ -134,7 +136,8 @@ public static function openAPIFormats()
         'components' => 'components',
         'deliverability_analysis' => 'deliverability_analysis',
         'lob_confidence_score' => 'lob_confidence_score',
-        'object' => 'object'
+        'object' => 'object',
+        'transient_id' => 'transient_id'
     ];
 
     /**
@@ -154,7 +157,8 @@ public static function openAPIFormats()
         'components' => 'setComponents',
         'deliverability_analysis' => 'setDeliverabilityAnalysis',
         'lob_confidence_score' => 'setLobConfidenceScore',
-        'object' => 'setObject'
+        'object' => 'setObject',
+        'transient_id' => 'setTransientId'
     ];
 
     /**
@@ -174,7 +178,8 @@ public static function openAPIFormats()
         'components' => 'getComponents',
         'deliverability_analysis' => 'getDeliverabilityAnalysis',
         'lob_confidence_score' => 'getLobConfidenceScore',
-        'object' => 'getObject'
+        'object' => 'getObject',
+        'transient_id' => 'getTransientId'
     ];
 
     /**
@@ -280,6 +285,7 @@ public function __construct(array $data = null)
         $this->container['deliverability_analysis'] = $data['deliverability_analysis'] ?? null;
         $this->container['lob_confidence_score'] = $data['lob_confidence_score'] ?? null;
         $this->container['object'] = $data['object'] ?? null;
+        $this->container['transient_id'] = $data['transient_id'] ?? null;
     }
 
     /**
@@ -714,6 +720,31 @@ public function setObject($object)
 
         return $this;
     }
+
+
+    /**
+     * Gets transient_id
+     *
+     * @return string|null
+     */
+    public function getTransientId()
+    {
+        return $this->container['transient_id'];
+    }
+
+    /**
+     * Sets transient_id
+     *
+     * @param string|null $transient_id ID that is returned in the response body for the verification
+     *
+     * @return self
+     */
+    public function setTransientId($transient_id)
+    {
+        $this->container['transient_id'] = $transient_id;
+
+        return $this;
+    }
     /**
      * Returns true if offset exists. False otherwise.
      *

lib/Model/UsVerificationOrError.php

@@ -72,6 +72,7 @@ class UsVerificationOrError implements ModelInterface, ArrayAccess, \JsonSeriali
         'deliverability_analysis' => '\OpenAPI\Client\Model\DeliverabilityAnalysis',
         'lob_confidence_score' => '\OpenAPI\Client\Model\LobConfidenceScore',
         'object' => 'string',
+        'transient_id' => 'string',
         'error' => '\OpenAPI\Client\Model\BulkError'
     ];
 
@@ -94,6 +95,7 @@ class UsVerificationOrError implements ModelInterface, ArrayAccess, \JsonSeriali
         'deliverability_analysis' => null,
         'lob_confidence_score' => null,
         'object' => null,
+        'transient_id' => null,
         'error' => null
     ];
 
@@ -135,6 +137,7 @@ public static function openAPIFormats()
         'deliverability_analysis' => 'deliverability_analysis',
         'lob_confidence_score' => 'lob_confidence_score',
         'object' => 'object',
+        'transient_id' => 'transient_id',
         'error' => 'error'
     ];
 
@@ -155,6 +158,7 @@ public static function openAPIFormats()
         'deliverability_analysis' => 'setDeliverabilityAnalysis',
         'lob_confidence_score' => 'setLobConfidenceScore',
         'object' => 'setObject',
+        'transient_id' => 'setTransientId',
         'error' => 'setError'
     ];
 
@@ -175,6 +179,7 @@ public static function openAPIFormats()
         'deliverability_analysis' => 'getDeliverabilityAnalysis',
         'lob_confidence_score' => 'getLobConfidenceScore',
         'object' => 'getObject',
+        'transient_id' => 'getTransientId',
         'error' => 'getError'
     ];
 
@@ -280,6 +285,7 @@ public function __construct(array $data = null)
         $this->container['deliverability_analysis'] = $data['deliverability_analysis'] ?? null;
         $this->container['lob_confidence_score'] = $data['lob_confidence_score'] ?? null;
         $this->container['object'] = $data['object'] ?? null;
+        $this->container['transient_id'] = $data['transient_id'] ?? null;
         $this->container['error'] = $data['error'] ?? null;
     }
 
@@ -692,6 +698,31 @@ public function setObject($object)
     }
 
 
+    /**
+     * Gets transient_id
+     *
+     * @return string|null
+     */
+    public function getTransientId()
+    {
+        return $this->container['transient_id'];
+    }
+
+    /**
+     * Sets transient_id
+     *
+     * @param string|null $transient_id ID that is returned in the response body for the verification
+     *
+     * @return self
+     */
+    public function setTransientId($transient_id)
+    {
+        $this->container['transient_id'] = $transient_id;
+
+        return $this;
+    }
+
+
     /**
      * Gets error
      *