diff --git a/docs/MultipleComponents.md b/docs/MultipleComponents.md old mode 100644 new mode 100755 index fd3864c..117aa53 --- a/docs/MultipleComponents.md +++ b/docs/MultipleComponents.md @@ -5,12 +5,13 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Recipient** | **string** | The intended recipient, typically a person's or firm's name. | [optional] -**PrimaryLine** | **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] +**PrimaryLine** | **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` | **SecondaryLine** | **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] **ZipCode** | **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] +**TransientId** | **string** | ID that is returned in the response body for the verification | [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) diff --git a/docs/UsVerification.md b/docs/UsVerification.md old mode 100644 new mode 100755 index c52035a..6729d46 --- a/docs/UsVerification.md +++ b/docs/UsVerification.md @@ -11,10 +11,12 @@ 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] **LastLine** | **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] +**ValidAddress** | **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] **DeliverabilityAnalysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional] **LobConfidenceScore** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional] **Object** | **string** | | [optional] [default to ObjectEnum.UsVerification] +**TransientId** | **string** | ID that is returned in the response body for the verification | [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) diff --git a/docs/UsVerificationOrError.md b/docs/UsVerificationOrError.md old mode 100644 new mode 100755 index d5108dd..4861d8a --- a/docs/UsVerificationOrError.md +++ b/docs/UsVerificationOrError.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **DeliverabilityAnalysis** | [**DeliverabilityAnalysis**](DeliverabilityAnalysis.md) | | [optional] **LobConfidenceScore** | [**LobConfidenceScore**](LobConfidenceScore.md) | | [optional] **Object** | **string** | | [optional] [default to ObjectEnum.UsVerification] +**TransientId** | **string** | ID that is returned in the response body for the verification | [optional] **Error** | [**BulkError**](BulkError.md) | | [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) diff --git a/docs/UsVerifications.md b/docs/UsVerifications.md old mode 100644 new mode 100755 index 9a1496c..67634af --- a/docs/UsVerifications.md +++ b/docs/UsVerifications.md @@ -4,8 +4,8 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**Addresses** | [**List<UsVerificationOrError>**](UsVerificationOrError.md) | | [optional] -**Errors** | **bool** | Indicates whether any errors occurred during the verification process. | [optional] +**Addresses** | [**List<UsVerificationOrError>**](UsVerificationOrError.md) | | +**Errors** | **bool** | Indicates whether any errors occurred during the verification process. | [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/UsVerificationsWritable.md b/docs/UsVerificationsWritable.md old mode 100644 new mode 100755 index 6aaa28d..95910c1 --- a/docs/UsVerificationsWritable.md +++ b/docs/UsVerificationsWritable.md @@ -4,7 +4,7 @@ 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] **PrimaryLine** | **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] **SecondaryLine** | **string** | The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. | [optional] @@ -12,6 +12,7 @@ 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] **ZipCode** | **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] +**TransientId** | **string** | ID that is returned in the response body for the verification | [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) diff --git a/src/lob.dotnet/Model/MultipleComponents.cs b/src/lob.dotnet/Model/MultipleComponents.cs index 6d3e65e..639a3d5 100755 --- a/src/lob.dotnet/Model/MultipleComponents.cs +++ b/src/lob.dotnet/Model/MultipleComponents.cs @@ -47,7 +47,8 @@ protected MultipleComponents() { } /// city. /// 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.. /// 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`).. - public MultipleComponents(string recipient = default(string), string primaryLine = default(string), string secondaryLine = default(string), string urbanization = default(string), string city = default(string), string state = default(string), string zipCode = default(string)) + /// ID that is returned in the response body for the verification . + public MultipleComponents(string recipient = default(string), string primaryLine = default(string), string secondaryLine = default(string), string urbanization = default(string), string city = default(string), string state = default(string), string zipCode = default(string), string transientId = default(string)) { // to ensure "primaryLine" is required (not null) if (primaryLine == null) @@ -61,6 +62,7 @@ protected MultipleComponents() { } this.City = city; this.State = state; this.ZipCode = zipCode; + this.TransientId = transientId; } /// @@ -111,6 +113,13 @@ protected MultipleComponents() { } [DataMember(Name = "zip_code", EmitDefaultValue = false)] public string ZipCode { get; set; } + /// + /// ID that is returned in the response body for the verification + /// + /// ID that is returned in the response body for the verification + [DataMember(Name = "transient_id", EmitDefaultValue = false)] + public string TransientId { get; set; } + /// /// Returns the string presentation of the object /// @@ -126,6 +135,7 @@ public override string ToString() sb.Append(" City: ").Append(City).Append("\n"); sb.Append(" State: ").Append(State).Append("\n"); sb.Append(" ZipCode: ").Append(ZipCode).Append("\n"); + sb.Append(" TransientId: ").Append(TransientId).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -195,6 +205,11 @@ public bool Equals(MultipleComponents input) this.ZipCode == input.ZipCode || (this.ZipCode != null && this.ZipCode.Equals(input.ZipCode)) + ) && + ( + this.TransientId == input.TransientId || + (this.TransientId != null && + this.TransientId.Equals(input.TransientId)) ); } @@ -235,6 +250,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.ZipCode.GetHashCode(); } + if (this.TransientId != null) + { + hashCode = (hashCode * 59) + this.TransientId.GetHashCode(); + } return hashCode; } } diff --git a/src/lob.dotnet/Model/UsVerification.cs b/src/lob.dotnet/Model/UsVerification.cs old mode 100644 new mode 100755 index 84244b2..43a9acb --- a/src/lob.dotnet/Model/UsVerification.cs +++ b/src/lob.dotnet/Model/UsVerification.cs @@ -119,7 +119,8 @@ public enum ObjectEnum /// deliverabilityAnalysis. /// lobConfidenceScore. /// _object (default to ObjectEnum.UsVerification). - public UsVerification(string id = default(string), string recipient = default(string), string primaryLine = default(string), string secondaryLine = default(string), string urbanization = default(string), string lastLine = default(string), DeliverabilityEnum? deliverability = default(DeliverabilityEnum?), bool validAddress = default(bool), UsComponents components = default(UsComponents), DeliverabilityAnalysis deliverabilityAnalysis = default(DeliverabilityAnalysis), LobConfidenceScore lobConfidenceScore = default(LobConfidenceScore), ObjectEnum? _object = ObjectEnum.UsVerification) + /// ID that is returned in the response body for the verification . + public UsVerification(string id = default(string), string recipient = default(string), string primaryLine = default(string), string secondaryLine = default(string), string urbanization = default(string), string lastLine = default(string), DeliverabilityEnum? deliverability = default(DeliverabilityEnum?), bool validAddress = default(bool), UsComponents components = default(UsComponents), DeliverabilityAnalysis deliverabilityAnalysis = default(DeliverabilityAnalysis), LobConfidenceScore lobConfidenceScore = default(LobConfidenceScore), ObjectEnum? _object = ObjectEnum.UsVerification, string transientId = default(string)) { this.Id = id; this.Recipient = recipient; @@ -133,6 +134,7 @@ public enum ObjectEnum this.DeliverabilityAnalysis = deliverabilityAnalysis; this.LobConfidenceScore = lobConfidenceScore; this.Object = _object; + this.TransientId = transientId; } /// @@ -202,6 +204,13 @@ public enum ObjectEnum [DataMember(Name = "lob_confidence_score", EmitDefaultValue = false)] public LobConfidenceScore LobConfidenceScore { get; set; } + /// + /// ID that is returned in the response body for the verification + /// + /// ID that is returned in the response body for the verification + [DataMember(Name = "transient_id", EmitDefaultValue = false)] + public string TransientId { get; set; } + /// /// Returns the string presentation of the object /// @@ -222,6 +231,7 @@ public override string ToString() sb.Append(" DeliverabilityAnalysis: ").Append(DeliverabilityAnalysis).Append("\n"); sb.Append(" LobConfidenceScore: ").Append(LobConfidenceScore).Append("\n"); sb.Append(" Object: ").Append(Object).Append("\n"); + sb.Append(" TransientId: ").Append(TransientId).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -313,6 +323,11 @@ public bool Equals(UsVerification input) ( this.Object == input.Object || this.Object.Equals(input.Object) + ) && + ( + this.TransientId == input.TransientId || + (this.TransientId != null && + this.TransientId.Equals(input.TransientId)) ); } @@ -364,6 +379,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.LobConfidenceScore.GetHashCode(); } hashCode = (hashCode * 59) + this.Object.GetHashCode(); + if (this.TransientId != null) + { + hashCode = (hashCode * 59) + this.TransientId.GetHashCode(); + } return hashCode; } } diff --git a/src/lob.dotnet/Model/UsVerificationOrError.cs b/src/lob.dotnet/Model/UsVerificationOrError.cs old mode 100644 new mode 100755 index 056e206..19b87eb --- a/src/lob.dotnet/Model/UsVerificationOrError.cs +++ b/src/lob.dotnet/Model/UsVerificationOrError.cs @@ -116,8 +116,9 @@ public enum ObjectEnum /// deliverabilityAnalysis. /// lobConfidenceScore. /// _object (default to ObjectEnum.UsVerification). + /// ID that is returned in the response body for the verification . /// error. - public UsVerificationOrError(string id = default(string), string recipient = default(string), string primaryLine = default(string), string secondaryLine = default(string), string urbanization = default(string), string lastLine = default(string), DeliverabilityEnum? deliverability = default(DeliverabilityEnum?), UsComponents components = default(UsComponents), DeliverabilityAnalysis deliverabilityAnalysis = default(DeliverabilityAnalysis), LobConfidenceScore lobConfidenceScore = default(LobConfidenceScore), ObjectEnum? _object = ObjectEnum.UsVerification, BulkError error = default(BulkError)) + public UsVerificationOrError(string id = default(string), string recipient = default(string), string primaryLine = default(string), string secondaryLine = default(string), string urbanization = default(string), string lastLine = default(string), DeliverabilityEnum? deliverability = default(DeliverabilityEnum?), UsComponents components = default(UsComponents), DeliverabilityAnalysis deliverabilityAnalysis = default(DeliverabilityAnalysis), LobConfidenceScore lobConfidenceScore = default(LobConfidenceScore), ObjectEnum? _object = ObjectEnum.UsVerification, string transientId = default(string), BulkError error = default(BulkError)) { this.Id = id; this.Recipient = recipient; @@ -130,6 +131,7 @@ public enum ObjectEnum this.DeliverabilityAnalysis = deliverabilityAnalysis; this.LobConfidenceScore = lobConfidenceScore; this.Object = _object; + this.TransientId = transientId; this.Error = error; } @@ -192,6 +194,13 @@ public enum ObjectEnum [DataMember(Name = "lob_confidence_score", EmitDefaultValue = false)] public LobConfidenceScore LobConfidenceScore { get; set; } + /// + /// ID that is returned in the response body for the verification + /// + /// ID that is returned in the response body for the verification + [DataMember(Name = "transient_id", EmitDefaultValue = false)] + public string TransientId { get; set; } + /// /// Gets or Sets Error /// @@ -217,6 +226,7 @@ public override string ToString() sb.Append(" DeliverabilityAnalysis: ").Append(DeliverabilityAnalysis).Append("\n"); sb.Append(" LobConfidenceScore: ").Append(LobConfidenceScore).Append("\n"); sb.Append(" Object: ").Append(Object).Append("\n"); + sb.Append(" TransientId: ").Append(TransientId).Append("\n"); sb.Append(" Error: ").Append(Error).Append("\n"); sb.Append("}\n"); return sb.ToString(); @@ -306,6 +316,11 @@ public bool Equals(UsVerificationOrError input) this.Object == input.Object || this.Object.Equals(input.Object) ) && + ( + this.TransientId == input.TransientId || + (this.TransientId != null && + this.TransientId.Equals(input.TransientId)) + ) && ( this.Error == input.Error || (this.Error != null && @@ -360,6 +375,10 @@ public override int GetHashCode() hashCode = (hashCode * 59) + this.LobConfidenceScore.GetHashCode(); } hashCode = (hashCode * 59) + this.Object.GetHashCode(); + if (this.TransientId != null) + { + hashCode = (hashCode * 59) + this.TransientId.GetHashCode(); + } if (this.Error != null) { hashCode = (hashCode * 59) + this.Error.GetHashCode(); diff --git a/src/lob.dotnet/Model/UsVerifications.cs b/src/lob.dotnet/Model/UsVerifications.cs old mode 100644 new mode 100755 diff --git a/src/lob.dotnet/Model/UsVerificationsWritable.cs b/src/lob.dotnet/Model/UsVerificationsWritable.cs index a8687f9..f797563 100755 --- a/src/lob.dotnet/Model/UsVerificationsWritable.cs +++ b/src/lob.dotnet/Model/UsVerificationsWritable.cs @@ -35,7 +35,7 @@ public partial class UsVerificationsWritable : IEquatable /// Initializes a new instance of the class. /// - /// 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._ . + /// 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._ . /// The intended recipient, typically a person's or firm's name.. /// 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` . /// The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. . @@ -43,7 +43,8 @@ public partial class UsVerificationsWritable : IEquatablecity. /// 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.. /// 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`).. - public UsVerificationsWritable(string address = default(string), string recipient = default(string), string primaryLine = default(string), string secondaryLine = default(string), string urbanization = default(string), string city = default(string), string state = default(string), string zipCode = default(string)) + /// ID that is returned in the response body for the verification . + public UsVerificationsWritable(string address = default(string), string recipient = default(string), string primaryLine = default(string), string secondaryLine = default(string), string urbanization = default(string), string city = default(string), string state = default(string), string zipCode = default(string), string transientId = default(string)) { this.Address = address; this.Recipient = recipient; @@ -53,12 +54,13 @@ public partial class UsVerificationsWritable : IEquatable - /// 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._ + /// 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._ /// - /// 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._ + /// 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._ [DataMember(Name = "address", EmitDefaultValue = false)] public string Address { get; set; } @@ -110,6 +112,13 @@ public partial class UsVerificationsWritable : IEquatable + /// ID that is returned in the response body for the verification + /// + /// ID that is returned in the response body for the verification + [DataMember(Name = "transient_id", EmitDefaultValue = false)] + public string TransientId { get; set; } + /// /// Returns the string presentation of the object /// @@ -126,6 +135,7 @@ public override string ToString() sb.Append(" City: ").Append(City).Append("\n"); sb.Append(" State: ").Append(State).Append("\n"); sb.Append(" ZipCode: ").Append(ZipCode).Append("\n"); + sb.Append(" TransientId: ").Append(TransientId).Append("\n"); sb.Append("}\n"); return sb.ToString(); } @@ -200,6 +210,11 @@ public bool Equals(UsVerificationsWritable input) this.ZipCode == input.ZipCode || (this.ZipCode != null && this.ZipCode.Equals(input.ZipCode)) + ) && + ( + this.TransientId == input.TransientId || + (this.TransientId != null && + this.TransientId.Equals(input.TransientId)) ); } @@ -244,6 +259,10 @@ public override int GetHashCode() { hashCode = (hashCode * 59) + this.ZipCode.GetHashCode(); } + if (this.TransientId != null) + { + hashCode = (hashCode * 59) + this.TransientId.GetHashCode(); + } return hashCode; } }