diff --git a/local-nuget/lob.dotnet/1.1.0/.nupkg.metadata b/local-nuget/lob.dotnet/1.1.0/.nupkg.metadata new file mode 100644 index 0000000..d81eb81 --- /dev/null +++ b/local-nuget/lob.dotnet/1.1.0/.nupkg.metadata @@ -0,0 +1,5 @@ +{ + "version": 2, + "contentHash": "N9hTKyTLVAHiBtiYuP9JJOGwr6H7cUlzJxjzufGrO3c71bXo0Pu6TvFEsuEDzNnQvPX+lNLDtIApxRyHWi3Gfw==", + "source": null +} \ No newline at end of file diff --git a/local-nuget/lob.dotnet/1.1.0/lib/netcoreapp3.1/lob.dotnet.dll b/local-nuget/lob.dotnet/1.1.0/lib/netcoreapp3.1/lob.dotnet.dll new file mode 100755 index 0000000..28b95db Binary files /dev/null and b/local-nuget/lob.dotnet/1.1.0/lib/netcoreapp3.1/lob.dotnet.dll differ diff --git a/local-nuget/lob.dotnet/1.1.0/lib/netcoreapp3.1/lob.dotnet.xml b/local-nuget/lob.dotnet/1.1.0/lib/netcoreapp3.1/lob.dotnet.xml new file mode 100755 index 0000000..11108b3 --- /dev/null +++ b/local-nuget/lob.dotnet/1.1.0/lib/netcoreapp3.1/lob.dotnet.xml @@ -0,0 +1,23374 @@ + + + + lob.dotnet + + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new address given information + + Thrown when fails to make API call + + Index associated with the operation. + Address + + + + create + + + Creates a new address given information + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of Address + + + + delete + + + Deletes the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + AddressDeletion + + + + delete + + + Deletes the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + ApiResponse of AddressDeletion + + + + get + + + Retrieves the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Address + + + + get + + + Retrieves the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + ApiResponse of Address + + + + list + + + Returns a list of your addresses. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + AddressList + + + + list + + + Returns a list of your addresses. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + ApiResponse of AddressList + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new address given information + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Address + + + + create + + + Creates a new address given information + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Address) + + + + delete + + + Deletes the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Cancellation Token to cancel the request. + Task of AddressDeletion + + + + delete + + + Deletes the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (AddressDeletion) + + + + get + + + Retrieves the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Address + + + + get + + + Retrieves the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Address) + + + + list + + + Returns a list of your addresses. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of AddressList + + + + list + + + Returns a list of your addresses. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (AddressList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + create Creates a new address given information + + Thrown when fails to make API call + + Index associated with the operation. + Address + + + + create Creates a new address given information + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of Address + + + + create Creates a new address given information + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Address + + + + create Creates a new address given information + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Address) + + + + delete Deletes the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + AddressDeletion + + + + delete Deletes the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + ApiResponse of AddressDeletion + + + + delete Deletes the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Cancellation Token to cancel the request. + Task of AddressDeletion + + + + delete Deletes the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (AddressDeletion) + + + + get Retrieves the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Address + + + + get Retrieves the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + ApiResponse of Address + + + + get Retrieves the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Address + + + + get Retrieves the details of an existing address. + + Thrown when fails to make API call + id of the address + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Address) + + + + list Returns a list of your addresses. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + AddressList + + + + list Returns a list of your addresses. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + ApiResponse of AddressList + + + + list Returns a list of your addresses. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of AddressList + + + + list Returns a list of your addresses. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (AddressList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\". + + Thrown when fails to make API call + + Index associated with the operation. + BankAccount + + + + create + + + Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\". + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of BankAccount + + + + delete + + + Permanently deletes a bank account. It cannot be undone. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + BankAccountDeletion + + + + delete + + + Permanently deletes a bank account. It cannot be undone. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + ApiResponse of BankAccountDeletion + + + + get + + + Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + BankAccount + + + + get + + + Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + ApiResponse of BankAccount + + + + verify + + + Verify a bank account in order to create a check. + + Thrown when fails to make API call + id of the bank account to be verified + + Index associated with the operation. + BankAccount + + + + verify + + + Verify a bank account in order to create a check. + + Thrown when fails to make API call + id of the bank account to be verified + + Index associated with the operation. + ApiResponse of BankAccount + + + + list + + + Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + BankAccountList + + + + list + + + Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + ApiResponse of BankAccountList + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\". + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccount + + + + create + + + Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\". + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccount) + + + + delete + + + Permanently deletes a bank account. It cannot be undone. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccountDeletion + + + + delete + + + Permanently deletes a bank account. It cannot be undone. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccountDeletion) + + + + get + + + Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccount + + + + get + + + Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccount) + + + + verify + + + Verify a bank account in order to create a check. + + Thrown when fails to make API call + id of the bank account to be verified + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccount + + + + verify + + + Verify a bank account in order to create a check. + + Thrown when fails to make API call + id of the bank account to be verified + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccount) + + + + list + + + Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccountList + + + + list + + + Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccountList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + create Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\". + + Thrown when fails to make API call + + Index associated with the operation. + BankAccount + + + + create Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\". + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of BankAccount + + + + create Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\". + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccount + + + + create Creates a new bank account with the provided properties. Bank accounts created in live mode will need to be verified via micro deposits before being able to send live checks. The deposits will appear in the bank account in 2-3 business days and have the description \"VERIFICATION\". + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccount) + + + + delete Permanently deletes a bank account. It cannot be undone. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + BankAccountDeletion + + + + delete Permanently deletes a bank account. It cannot be undone. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + ApiResponse of BankAccountDeletion + + + + delete Permanently deletes a bank account. It cannot be undone. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccountDeletion + + + + delete Permanently deletes a bank account. It cannot be undone. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccountDeletion) + + + + get Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + BankAccount + + + + get Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + ApiResponse of BankAccount + + + + get Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccount + + + + get Retrieves the details of an existing bank account. You need only supply the unique bank account identifier that was returned upon bank account creation. + + Thrown when fails to make API call + id of the bank account + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccount) + + + + verify Verify a bank account in order to create a check. + + Thrown when fails to make API call + id of the bank account to be verified + + Index associated with the operation. + BankAccount + + + + verify Verify a bank account in order to create a check. + + Thrown when fails to make API call + id of the bank account to be verified + + Index associated with the operation. + ApiResponse of BankAccount + + + + verify Verify a bank account in order to create a check. + + Thrown when fails to make API call + id of the bank account to be verified + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccount + + + + verify Verify a bank account in order to create a check. + + Thrown when fails to make API call + id of the bank account to be verified + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccount) + + + + list Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + BankAccountList + + + + list Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + ApiResponse of BankAccountList + + + + list Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BankAccountList + + + + list Returns a list of your bank accounts. The bank accounts are returned sorted by creation date, with the most recently created bank accounts appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BankAccountList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new billing_group with the provided properties. + + Thrown when fails to make API call + + Index associated with the operation. + BillingGroup + + + + create + + + Creates a new billing_group with the provided properties. + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of BillingGroup + + + + get + + + Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. + + Thrown when fails to make API call + id of the billing_group + Index associated with the operation. + BillingGroup + + + + get + + + Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. + + Thrown when fails to make API call + id of the billing_group + Index associated with the operation. + ApiResponse of BillingGroup + + + + update + + + Updates all editable attributes of the billing_group with the given id. + + Thrown when fails to make API call + id of the billing_group + + Index associated with the operation. + BillingGroup + + + + update + + + Updates all editable attributes of the billing_group with the given id. + + Thrown when fails to make API call + id of the billing_group + + Index associated with the operation. + ApiResponse of BillingGroup + + + + list + + + Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by date modified. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `date_modfied`, not both. (optional) + Index associated with the operation. + BillingGroupList + + + + list + + + Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by date modified. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `date_modfied`, not both. (optional) + Index associated with the operation. + ApiResponse of BillingGroupList + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new billing_group with the provided properties. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BillingGroup + + + + create + + + Creates a new billing_group with the provided properties. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BillingGroup) + + + + get + + + Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. + + Thrown when fails to make API call + id of the billing_group + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BillingGroup + + + + get + + + Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. + + Thrown when fails to make API call + id of the billing_group + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BillingGroup) + + + + update + + + Updates all editable attributes of the billing_group with the given id. + + Thrown when fails to make API call + id of the billing_group + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BillingGroup + + + + update + + + Updates all editable attributes of the billing_group with the given id. + + Thrown when fails to make API call + id of the billing_group + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BillingGroup) + + + + list + + + Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by date modified. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `date_modfied`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BillingGroupList + + + + list + + + Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by date modified. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `date_modfied`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BillingGroupList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + create Creates a new billing_group with the provided properties. + + Thrown when fails to make API call + + Index associated with the operation. + BillingGroup + + + + create Creates a new billing_group with the provided properties. + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of BillingGroup + + + + create Creates a new billing_group with the provided properties. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BillingGroup + + + + create Creates a new billing_group with the provided properties. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BillingGroup) + + + + get Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. + + Thrown when fails to make API call + id of the billing_group + Index associated with the operation. + BillingGroup + + + + get Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. + + Thrown when fails to make API call + id of the billing_group + Index associated with the operation. + ApiResponse of BillingGroup + + + + get Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. + + Thrown when fails to make API call + id of the billing_group + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BillingGroup + + + + get Retrieves the details of an existing billing_group. You need only supply the unique billing_group identifier that was returned upon billing_group creation. + + Thrown when fails to make API call + id of the billing_group + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BillingGroup) + + + + update Updates all editable attributes of the billing_group with the given id. + + Thrown when fails to make API call + id of the billing_group + + Index associated with the operation. + BillingGroup + + + + update Updates all editable attributes of the billing_group with the given id. + + Thrown when fails to make API call + id of the billing_group + + Index associated with the operation. + ApiResponse of BillingGroup + + + + update Updates all editable attributes of the billing_group with the given id. + + Thrown when fails to make API call + id of the billing_group + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BillingGroup + + + + update Updates all editable attributes of the billing_group with the given id. + + Thrown when fails to make API call + id of the billing_group + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BillingGroup) + + + + list Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by date modified. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `date_modfied`, not both. (optional) + Index associated with the operation. + BillingGroupList + + + + list Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by date modified. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `date_modfied`, not both. (optional) + Index associated with the operation. + ApiResponse of BillingGroupList + + + + list Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by date modified. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `date_modfied`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of BillingGroupList + + + + list Returns a list of your billing_groups. The billing_groups are returned sorted by creation date, with the most recently created billing_groups appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by date modified. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `date_modfied`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (BillingGroupList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new card order given information + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + + Index associated with the operation. + CardOrder + + + + create + + + Creates a new card order given information + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + + Index associated with the operation. + ApiResponse of CardOrder + + + + get + + + Retrieves the card orders associated with the given card id. + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Index associated with the operation. + CardOrderList + + + + get + + + Retrieves the card orders associated with the given card id. + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Index associated with the operation. + ApiResponse of CardOrderList + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new card order given information + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CardOrder + + + + create + + + Creates a new card order given information + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CardOrder) + + + + get + + + Retrieves the card orders associated with the given card id. + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CardOrderList + + + + get + + + Retrieves the card orders associated with the given card id. + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CardOrderList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + create Creates a new card order given information + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + + Index associated with the operation. + CardOrder + + + + create Creates a new card order given information + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + + Index associated with the operation. + ApiResponse of CardOrder + + + + create Creates a new card order given information + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CardOrder + + + + create Creates a new card order given information + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CardOrder) + + + + get Retrieves the card orders associated with the given card id. + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Index associated with the operation. + CardOrderList + + + + get Retrieves the card orders associated with the given card id. + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Index associated with the operation. + ApiResponse of CardOrderList + + + + get Retrieves the card orders associated with the given card id. + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CardOrderList + + + + get Retrieves the card orders associated with the given card id. + + Thrown when fails to make API call + The ID of the card to which the card orders belong. + How many results to return. (optional, default to 10) + An integer that designates the offset at which to begin returning results. Defaults to 0. (optional, default to 0) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CardOrderList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new card given information + + Thrown when fails to make API call + + Index associated with the operation. + Card + + + + create + + + Creates a new card given information + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of Card + + + + delete + + + Delete an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + CardDeletion + + + + delete + + + Delete an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + ApiResponse of CardDeletion + + + + get + + + Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Card + + + + get + + + Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + ApiResponse of Card + + + + update + + + Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + + Index associated with the operation. + Card + + + + update + + + Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + + Index associated with the operation. + ApiResponse of Card + + + + list + + + Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Index associated with the operation. + CardList + + + + list + + + Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Index associated with the operation. + ApiResponse of CardList + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new card given information + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Card + + + + create + + + Creates a new card given information + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Card) + + + + delete + + + Delete an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CardDeletion + + + + delete + + + Delete an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CardDeletion) + + + + get + + + Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Card + + + + get + + + Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Card) + + + + update + + + Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Card + + + + update + + + Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Card) + + + + list + + + Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CardList + + + + list + + + Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CardList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + create Creates a new card given information + + Thrown when fails to make API call + + Index associated with the operation. + Card + + + + create Creates a new card given information + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of Card + + + + create Creates a new card given information + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Card + + + + create Creates a new card given information + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Card) + + + + delete Delete an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + CardDeletion + + + + delete Delete an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + ApiResponse of CardDeletion + + + + delete Delete an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CardDeletion + + + + delete Delete an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CardDeletion) + + + + get Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Card + + + + get Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + ApiResponse of Card + + + + get Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Card + + + + get Retrieves the details of an existing card. You need only supply the unique customer identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Card) + + + + update Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + + Index associated with the operation. + Card + + + + update Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + + Index associated with the operation. + ApiResponse of Card + + + + update Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Card + + + + update Update the details of an existing card. You need only supply the unique identifier that was returned upon card creation. + + Thrown when fails to make API call + id of the card + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Card) + + + + list Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Index associated with the operation. + CardList + + + + list Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Index associated with the operation. + ApiResponse of CardList + + + + list Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CardList + + + + list Returns a list of your cards. The cards are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CardList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + cancel + + + Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + CheckDeletion + + + + cancel + + + Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + ApiResponse of CheckDeletion + + + + create + + + Creates a new check with the provided properties. + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Check + + + + create + + + Creates a new check with the provided properties. + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + ApiResponse of Check + + + + get + + + Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Check + + + + get + + + Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + ApiResponse of Check + + + + list + + + Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + CheckList + + + + list + + + Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + ApiResponse of CheckList + + + + Represents a collection of functions to interact with the API endpoints + + + + + cancel + + + Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CheckDeletion + + + + cancel + + + Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CheckDeletion) + + + + create + + + Creates a new check with the provided properties. + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Check + + + + create + + + Creates a new check with the provided properties. + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Check) + + + + get + + + Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Check + + + + get + + + Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Check) + + + + list + + + Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CheckList + + + + list + + + Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CheckList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + cancel Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + CheckDeletion + + + + cancel Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + ApiResponse of CheckDeletion + + + + cancel Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CheckDeletion + + + + cancel Completely removes a check from production. This can only be done if the check has a `send_date` and the `send_date` has not yet passed. If the check is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CheckDeletion) + + + + create Creates a new check with the provided properties. + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Check + + + + create Creates a new check with the provided properties. + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + ApiResponse of Check + + + + create Creates a new check with the provided properties. + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Check + + + + create Creates a new check with the provided properties. + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Check) + + + + get Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Check + + + + get Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + ApiResponse of Check + + + + get Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Check + + + + get Retrieves the details of an existing check. You need only supply the unique check identifier that was returned upon check creation. + + Thrown when fails to make API call + id of the check + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Check) + + + + list Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + CheckList + + + + list Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + ApiResponse of CheckList + + + + list Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of CheckList + + + + list Returns a list of your checks. The checks are returned sorted by creation date, with the most recently created checks appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (CheckList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + placeholder_no_call + + + Don't call this. It's so that the right models can be generated. + + Thrown when fails to make API call + Index associated with the operation. + PlaceholderModel + + + + placeholder_no_call + + + Don't call this. It's so that the right models can be generated. + + Thrown when fails to make API call + Index associated with the operation. + ApiResponse of PlaceholderModel + + + + Represents a collection of functions to interact with the API endpoints + + + + + placeholder_no_call + + + Don't call this. It's so that the right models can be generated. + + Thrown when fails to make API call + Index associated with the operation. + Cancellation Token to cancel the request. + Task of PlaceholderModel + + + + placeholder_no_call + + + Don't call this. It's so that the right models can be generated. + + Thrown when fails to make API call + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (PlaceholderModel) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + placeholder_no_call Don't call this. It's so that the right models can be generated. + + Thrown when fails to make API call + Index associated with the operation. + PlaceholderModel + + + + placeholder_no_call Don't call this. It's so that the right models can be generated. + + Thrown when fails to make API call + Index associated with the operation. + ApiResponse of PlaceholderModel + + + + placeholder_no_call Don't call this. It's so that the right models can be generated. + + Thrown when fails to make API call + Index associated with the operation. + Cancellation Token to cancel the request. + Task of PlaceholderModel + + + + placeholder_no_call Don't call this. It's so that the right models can be generated. + + Thrown when fails to make API call + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (PlaceholderModel) + + + + Represents a collection of functions to interact with the API endpoints + + + + + validate + + + Validates whether a given name is associated with an address. + + Thrown when fails to make API call + + Index associated with the operation. + IdentityValidation + + + + validate + + + Validates whether a given name is associated with an address. + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of IdentityValidation + + + + Represents a collection of functions to interact with the API endpoints + + + + + validate + + + Validates whether a given name is associated with an address. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of IdentityValidation + + + + validate + + + Validates whether a given name is associated with an address. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (IdentityValidation) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + validate Validates whether a given name is associated with an address. + + Thrown when fails to make API call + + Index associated with the operation. + IdentityValidation + + + + validate Validates whether a given name is associated with an address. + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of IdentityValidation + + + + validate Validates whether a given name is associated with an address. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of IdentityValidation + + + + validate Validates whether a given name is associated with an address. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (IdentityValidation) + + + + Represents a collection of functions to interact with the API endpoints + + + + + autocomplete + + + Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + IntlAutocompletions + + + + autocomplete + + + Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + ApiResponse of IntlAutocompletions + + + + Represents a collection of functions to interact with the API endpoints + + + + + autocomplete + + + Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of IntlAutocompletions + + + + autocomplete + + + Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (IntlAutocompletions) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + autocomplete Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + IntlAutocompletions + + + + autocomplete Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + ApiResponse of IntlAutocompletions + + + + autocomplete Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of IntlAutocompletions + + + + autocomplete Given an address prefix consisting of a partial primary line and country, as well as optional input of city, state, and zip code, this functionality returns up to 10 full International address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/intl_verification). + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (IntlAutocompletions) + + + + Represents a collection of functions to interact with the API endpoints + + + + + verifyBulk + + + Verify a list of international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + Index associated with the operation. + IntlVerifications + + + + verifyBulk + + + Verify a list of international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of IntlVerifications + + + + verifySingle + + + Verify an international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + IntlVerification + + + + verifySingle + + + Verify an international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + ApiResponse of IntlVerification + + + + Represents a collection of functions to interact with the API endpoints + + + + + verifyBulk + + + Verify a list of international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of IntlVerifications + + + + verifyBulk + + + Verify a list of international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (IntlVerifications) + + + + verifySingle + + + Verify an international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of IntlVerification + + + + verifySingle + + + Verify an international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (IntlVerification) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + verifyBulk Verify a list of international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + Index associated with the operation. + IntlVerifications + + + + verifyBulk Verify a list of international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of IntlVerifications + + + + verifyBulk Verify a list of international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of IntlVerifications + + + + verifyBulk Verify a list of international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (IntlVerifications) + + + + verifySingle Verify an international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + IntlVerification + + + + verifySingle Verify an international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + ApiResponse of IntlVerification + + + + verifySingle Verify an international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of IntlVerification + + + + verifySingle Verify an international (except US or US territories) address with a live API key. + + Thrown when fails to make API call + + * `native` - Translate response to the native language of the country in the request * `match` - match the response to the language in the request Default response is in English. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (IntlVerification) + + + + Represents a collection of functions to interact with the API endpoints + + + + + cancel + + + Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + LetterDeletion + + + + cancel + + + Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + ApiResponse of LetterDeletion + + + + create + + + Creates a new letter given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Letter + + + + create + + + Creates a new letter given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + ApiResponse of Letter + + + + get + + + Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Letter + + + + get + + + Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + ApiResponse of Letter + + + + list + + + Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + LetterList + + + + list + + + Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + ApiResponse of LetterList + + + + Represents a collection of functions to interact with the API endpoints + + + + + cancel + + + Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Cancellation Token to cancel the request. + Task of LetterDeletion + + + + cancel + + + Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (LetterDeletion) + + + + create + + + Creates a new letter given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Letter + + + + create + + + Creates a new letter given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Letter) + + + + get + + + Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Letter + + + + get + + + Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Letter) + + + + list + + + Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of LetterList + + + + list + + + Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (LetterList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + cancel Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + LetterDeletion + + + + cancel Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + ApiResponse of LetterDeletion + + + + cancel Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Cancellation Token to cancel the request. + Task of LetterDeletion + + + + cancel Completely removes a letter from production. This can only be done if the letter has a `send_date` and the `send_date` has not yet passed. If the letter is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (LetterDeletion) + + + + create Creates a new letter given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Letter + + + + create Creates a new letter given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + ApiResponse of Letter + + + + create Creates a new letter given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Letter + + + + create Creates a new letter given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Letter) + + + + get Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Letter + + + + get Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + ApiResponse of Letter + + + + get Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Letter + + + + get Retrieves the details of an existing letter. You need only supply the unique letter identifier that was returned upon letter creation. + + Thrown when fails to make API call + id of the letter + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Letter) + + + + list Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + LetterList + + + + list Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + ApiResponse of LetterList + + + + list Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of LetterList + + + + list Returns a list of your letters. The letters are returned sorted by creation date, with the most recently created letters appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Set to `true` to return only color letters. Set to `false` to return only black & white letters. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (LetterList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new postcard given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Postcard + + + + create + + + Creates a new postcard given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + ApiResponse of Postcard + + + + cancel + + + Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + PostcardDeletion + + + + cancel + + + Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + ApiResponse of PostcardDeletion + + + + get + + + Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Postcard + + + + get + + + Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + ApiResponse of Postcard + + + + list + + + Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + PostcardList + + + + list + + + Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + ApiResponse of PostcardList + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new postcard given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Postcard + + + + create + + + Creates a new postcard given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Postcard) + + + + cancel + + + Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Cancellation Token to cancel the request. + Task of PostcardDeletion + + + + cancel + + + Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (PostcardDeletion) + + + + get + + + Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Postcard + + + + get + + + Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Postcard) + + + + list + + + Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of PostcardList + + + + list + + + Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (PostcardList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + create Creates a new postcard given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Postcard + + + + create Creates a new postcard given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + ApiResponse of Postcard + + + + create Creates a new postcard given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Postcard + + + + create Creates a new postcard given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Postcard) + + + + cancel Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + PostcardDeletion + + + + cancel Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + ApiResponse of PostcardDeletion + + + + cancel Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Cancellation Token to cancel the request. + Task of PostcardDeletion + + + + cancel Completely removes a postcard from production. This can only be done if the postcard has a `send_date` and the `send_date` has not yet passed. If the postcard is successfully canceled, you will not be charged for it. Read more on [cancellation windows](#section/Cancellation-Windows) and [scheduling](#section/Scheduled-Mailings). Scheduling and cancellation is a premium feature. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (PostcardDeletion) + + + + get Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Postcard + + + + get Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + ApiResponse of Postcard + + + + get Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Postcard + + + + get Retrieves the details of an existing postcard. You need only supply the unique customer identifier that was returned upon postcard creation. + + Thrown when fails to make API call + id of the postcard + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Postcard) + + + + list Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + PostcardList + + + + list Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + ApiResponse of PostcardList + + + + list Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of PostcardList + + + + list Returns a list of your postcards. The addresses are returned sorted by creation date, with the most recently created addresses appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (PostcardList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + lookup + + + Reverse geocode a valid US location with a live API key. + + Thrown when fails to make API call + + Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (optional, default to 5) + Index associated with the operation. + ReverseGeocode + + + + lookup + + + Reverse geocode a valid US location with a live API key. + + Thrown when fails to make API call + + Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (optional, default to 5) + Index associated with the operation. + ApiResponse of ReverseGeocode + + + + Represents a collection of functions to interact with the API endpoints + + + + + lookup + + + Reverse geocode a valid US location with a live API key. + + Thrown when fails to make API call + + Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (optional, default to 5) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ReverseGeocode + + + + lookup + + + Reverse geocode a valid US location with a live API key. + + Thrown when fails to make API call + + Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (optional, default to 5) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (ReverseGeocode) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + lookup Reverse geocode a valid US location with a live API key. + + Thrown when fails to make API call + + Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (optional, default to 5) + Index associated with the operation. + ReverseGeocode + + + + lookup Reverse geocode a valid US location with a live API key. + + Thrown when fails to make API call + + Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (optional, default to 5) + Index associated with the operation. + ApiResponse of ReverseGeocode + + + + lookup Reverse geocode a valid US location with a live API key. + + Thrown when fails to make API call + + Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (optional, default to 5) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ReverseGeocode + + + + lookup Reverse geocode a valid US location with a live API key. + + Thrown when fails to make API call + + Determines the number of locations returned. Possible values are between 1 and 50 and any number higher will be rounded down to 50. Default size is a list of 5 reverse geocoded locations. (optional, default to 5) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (ReverseGeocode) + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new self_mailer given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + SelfMailer + + + + create + + + Creates a new self_mailer given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + ApiResponse of SelfMailer + + + + delete + + + Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + SelfMailerDeletion + + + + delete + + + Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + ApiResponse of SelfMailerDeletion + + + + get + + + Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + SelfMailer + + + + get + + + Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + ApiResponse of SelfMailer + + + + list + + + Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + The self mailer sizes to be returned. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + SelfMailerList + + + + list + + + Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + The self mailer sizes to be returned. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + ApiResponse of SelfMailerList + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new self_mailer given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of SelfMailer + + + + create + + + Creates a new self_mailer given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (SelfMailer) + + + + delete + + + Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + Cancellation Token to cancel the request. + Task of SelfMailerDeletion + + + + delete + + + Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (SelfMailerDeletion) + + + + get + + + Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + Cancellation Token to cancel the request. + Task of SelfMailer + + + + get + + + Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (SelfMailer) + + + + list + + + Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + The self mailer sizes to be returned. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of SelfMailerList + + + + list + + + Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + The self mailer sizes to be returned. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (SelfMailerList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + create Creates a new self_mailer given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + SelfMailer + + + + create Creates a new self_mailer given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + ApiResponse of SelfMailer + + + + create Creates a new self_mailer given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of SelfMailer + + + + create Creates a new self_mailer given information + + Thrown when fails to make API call + + A string of no longer than 256 characters that uniquely identifies this resource. For more help integrating idempotency keys, refer to our [implementation guide](https://www.lob.com/guides#idempotent_request). (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (SelfMailer) + + + + delete Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + SelfMailerDeletion + + + + delete Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + ApiResponse of SelfMailerDeletion + + + + delete Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + Cancellation Token to cancel the request. + Task of SelfMailerDeletion + + + + delete Completely removes a self mailer from production. This can only be done if the self mailer's `send_date` has not yet passed. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (SelfMailerDeletion) + + + + get Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + SelfMailer + + + + get Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + ApiResponse of SelfMailer + + + + get Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + Cancellation Token to cancel the request. + Task of SelfMailer + + + + get Retrieves the details of an existing self_mailer. You need only supply the unique self_mailer identifier that was returned upon self_mailer creation. + + Thrown when fails to make API call + id of the self_mailer + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (SelfMailer) + + + + list Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + The self mailer sizes to be returned. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + SelfMailerList + + + + list Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + The self mailer sizes to be returned. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + ApiResponse of SelfMailerList + + + + list Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + The self mailer sizes to be returned. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of SelfMailerList + + + + list Returns a list of your self_mailers. The self_mailers are returned sorted by creation date, with the most recently created self_mailers appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + The self mailer sizes to be returned. (optional) + * `true` - only return orders (past or future) where `send_date` is greater than `date_created` * `false` - only return orders where `send_date` is equal to `date_created` (optional) + Filter by date sent. (optional) + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. (optional) + Sorts items by ascending or descending dates. Use either `date_created` or `send_date`, not both. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (SelfMailerList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. + + Thrown when fails to make API call + + Index associated with the operation. + Template + + + + create + + + Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of Template + + + + delete + + + Permanently deletes a template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + TemplateDeletion + + + + delete + + + Permanently deletes a template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + ApiResponse of TemplateDeletion + + + + get + + + Retrieves the details of an existing template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Template + + + + get + + + Retrieves the details of an existing template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + ApiResponse of Template + + + + update + + + Updates the description and/or published version of the template with the given id. + + Thrown when fails to make API call + id of the template + + Index associated with the operation. + Template + + + + update + + + Updates the description and/or published version of the template with the given id. + + Thrown when fails to make API call + id of the template + + Index associated with the operation. + ApiResponse of Template + + + + list + + + Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + TemplateList + + + + list + + + Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + ApiResponse of TemplateList + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Template + + + + create + + + Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Template) + + + + delete + + + Permanently deletes a template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateDeletion + + + + delete + + + Permanently deletes a template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateDeletion) + + + + get + + + Retrieves the details of an existing template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Template + + + + get + + + Retrieves the details of an existing template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Template) + + + + update + + + Updates the description and/or published version of the template with the given id. + + Thrown when fails to make API call + id of the template + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Template + + + + update + + + Updates the description and/or published version of the template with the given id. + + Thrown when fails to make API call + id of the template + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Template) + + + + list + + + Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateList + + + + list + + + Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + create Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. + + Thrown when fails to make API call + + Index associated with the operation. + Template + + + + create Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of Template + + + + create Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Template + + + + create Creates a new template for use with the Print & Mail API. In Live mode, you can only have as many non-deleted templates as allotted in your current [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions). If you attempt to create a template past your limit, you will receive a `403` error. There is no limit in Test mode. + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Template) + + + + delete Permanently deletes a template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + TemplateDeletion + + + + delete Permanently deletes a template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + ApiResponse of TemplateDeletion + + + + delete Permanently deletes a template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateDeletion + + + + delete Permanently deletes a template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateDeletion) + + + + get Retrieves the details of an existing template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Template + + + + get Retrieves the details of an existing template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + ApiResponse of Template + + + + get Retrieves the details of an existing template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Template + + + + get Retrieves the details of an existing template. + + Thrown when fails to make API call + id of the template + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Template) + + + + update Updates the description and/or published version of the template with the given id. + + Thrown when fails to make API call + id of the template + + Index associated with the operation. + Template + + + + update Updates the description and/or published version of the template with the given id. + + Thrown when fails to make API call + id of the template + + Index associated with the operation. + ApiResponse of Template + + + + update Updates the description and/or published version of the template with the given id. + + Thrown when fails to make API call + id of the template + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Template + + + + update Updates the description and/or published version of the template with the given id. + + Thrown when fails to make API call + id of the template + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Template) + + + + list Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + TemplateList + + + + list Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + ApiResponse of TemplateList + + + + list Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateList + + + + list Returns a list of your templates. The templates are returned sorted by creation date, with the most recently created templates appearing first. + + Thrown when fails to make API call + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Filter by metadata key-value pair`. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new template version attached to the specified template. + + Thrown when fails to make API call + The ID of the template the new version will be attached to + + Index associated with the operation. + TemplateVersion + + + + create + + + Creates a new template version attached to the specified template. + + Thrown when fails to make API call + The ID of the template the new version will be attached to + + Index associated with the operation. + ApiResponse of TemplateVersion + + + + delete + + + Permanently deletes a template version. A template's `published_version` can not be deleted. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + TemplateVersionDeletion + + + + delete + + + Permanently deletes a template version. A template's `published_version` can not be deleted. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + ApiResponse of TemplateVersionDeletion + + + + get + + + Retrieves the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + TemplateVersion + + + + get + + + Retrieves the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + ApiResponse of TemplateVersion + + + + update + + + Updates the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + + Index associated with the operation. + TemplateVersion + + + + update + + + Updates the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + + Index associated with the operation. + ApiResponse of TemplateVersion + + + + list + + + Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. + + Thrown when fails to make API call + The ID of the template associated with the retrieved versions + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Index associated with the operation. + TemplateVersionList + + + + list + + + Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. + + Thrown when fails to make API call + The ID of the template associated with the retrieved versions + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Index associated with the operation. + ApiResponse of TemplateVersionList + + + + Represents a collection of functions to interact with the API endpoints + + + + + create + + + Creates a new template version attached to the specified template. + + Thrown when fails to make API call + The ID of the template the new version will be attached to + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersion + + + + create + + + Creates a new template version attached to the specified template. + + Thrown when fails to make API call + The ID of the template the new version will be attached to + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersion) + + + + delete + + + Permanently deletes a template version. A template's `published_version` can not be deleted. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersionDeletion + + + + delete + + + Permanently deletes a template version. A template's `published_version` can not be deleted. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersionDeletion) + + + + get + + + Retrieves the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersion + + + + get + + + Retrieves the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersion) + + + + update + + + Updates the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersion + + + + update + + + Updates the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersion) + + + + list + + + Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. + + Thrown when fails to make API call + The ID of the template associated with the retrieved versions + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersionList + + + + list + + + Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. + + Thrown when fails to make API call + The ID of the template associated with the retrieved versions + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersionList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + create Creates a new template version attached to the specified template. + + Thrown when fails to make API call + The ID of the template the new version will be attached to + + Index associated with the operation. + TemplateVersion + + + + create Creates a new template version attached to the specified template. + + Thrown when fails to make API call + The ID of the template the new version will be attached to + + Index associated with the operation. + ApiResponse of TemplateVersion + + + + create Creates a new template version attached to the specified template. + + Thrown when fails to make API call + The ID of the template the new version will be attached to + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersion + + + + create Creates a new template version attached to the specified template. + + Thrown when fails to make API call + The ID of the template the new version will be attached to + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersion) + + + + delete Permanently deletes a template version. A template's `published_version` can not be deleted. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + TemplateVersionDeletion + + + + delete Permanently deletes a template version. A template's `published_version` can not be deleted. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + ApiResponse of TemplateVersionDeletion + + + + delete Permanently deletes a template version. A template's `published_version` can not be deleted. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersionDeletion + + + + delete Permanently deletes a template version. A template's `published_version` can not be deleted. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersionDeletion) + + + + get Retrieves the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + TemplateVersion + + + + get Retrieves the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + ApiResponse of TemplateVersion + + + + get Retrieves the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersion + + + + get Retrieves the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersion) + + + + update Updates the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + + Index associated with the operation. + TemplateVersion + + + + update Updates the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + + Index associated with the operation. + ApiResponse of TemplateVersion + + + + update Updates the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersion + + + + update Updates the template version with the given template and version ids. + + Thrown when fails to make API call + The ID of the template to which the version belongs. + id of the template_version + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersion) + + + + list Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. + + Thrown when fails to make API call + The ID of the template associated with the retrieved versions + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Index associated with the operation. + TemplateVersionList + + + + list Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. + + Thrown when fails to make API call + The ID of the template associated with the retrieved versions + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Index associated with the operation. + ApiResponse of TemplateVersionList + + + + list Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. + + Thrown when fails to make API call + The ID of the template associated with the retrieved versions + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of TemplateVersionList + + + + list Returns a list of template versions for the given template ID. The template versions are sorted by creation date, with the most recently created appearing first. + + Thrown when fails to make API call + The ID of the template associated with the retrieved versions + How many results to return. (optional, default to 10) + A reference to a list entry used for paginating to the previous set of entries. This field is pre-populated in the `previous_url` field in the return response. (optional) + A reference to a list entry used for paginating to the next set of entries. This field is pre-populated in the `next_url` field in the return response. (optional) + Request that the response include the total count by specifying `include[]=total_count`. (optional) + Filter by date created. (optional) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (TemplateVersionList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + autocomplete + + + Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). + + Thrown when fails to make API call + + Index associated with the operation. + UsAutocompletions + + + + autocomplete + + + Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of UsAutocompletions + + + + Represents a collection of functions to interact with the API endpoints + + + + + autocomplete + + + Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of UsAutocompletions + + + + autocomplete + + + Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (UsAutocompletions) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + autocomplete Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). + + Thrown when fails to make API call + + Index associated with the operation. + UsAutocompletions + + + + autocomplete Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of UsAutocompletions + + + + autocomplete Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of UsAutocompletions + + + + autocomplete Given an address prefix consisting of a partial primary line, as well as optional input of city, state, and zip code, this functionality returns up to 10 full US address suggestions. Not all of them will turn out to be valid addresses; they'll need to be [verified](#operation/verification_us). + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (UsAutocompletions) + + + + Represents a collection of functions to interact with the API endpoints + + + + + verifyBulk + + + Verify a list of US or US territory addresses with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + UsVerifications + + + + verifyBulk + + + Verify a list of US or US territory addresses with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + ApiResponse of UsVerifications + + + + verifySingle + + + Verify a US or US territory address with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + UsVerification + + + + verifySingle + + + Verify a US or US territory address with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + ApiResponse of UsVerification + + + + Represents a collection of functions to interact with the API endpoints + + + + + verifyBulk + + + Verify a list of US or US territory addresses with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of UsVerifications + + + + verifyBulk + + + Verify a list of US or US territory addresses with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (UsVerifications) + + + + verifySingle + + + Verify a US or US territory address with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of UsVerification + + + + verifySingle + + + Verify a US or US territory address with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (UsVerification) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + verifyBulk Verify a list of US or US territory addresses with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + UsVerifications + + + + verifyBulk Verify a list of US or US territory addresses with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + ApiResponse of UsVerifications + + + + verifyBulk Verify a list of US or US territory addresses with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of UsVerifications + + + + verifyBulk Verify a list of US or US territory addresses with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (UsVerifications) + + + + verifySingle Verify a US or US territory address with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + UsVerification + + + + verifySingle Verify a US or US territory address with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + ApiResponse of UsVerification + + + + verifySingle Verify a US or US territory address with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of UsVerification + + + + verifySingle Verify a US or US territory address with a live API key. + + Thrown when fails to make API call + + Casing of the verified address. Possible values are `upper` and `proper` for uppercased (e.g. \"PO BOX\") and proper-cased (e.g. \"PO Box\"), respectively. (optional, default to upper) + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (UsVerification) + + + + Represents a collection of functions to interact with the API endpoints + + + + + lookup + + + Returns information about a ZIP code + + Thrown when fails to make API call + + Index associated with the operation. + Zip + + + + lookup + + + Returns information about a ZIP code + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of Zip + + + + Represents a collection of functions to interact with the API endpoints + + + + + lookup + + + Returns information about a ZIP code + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Zip + + + + lookup + + + Returns information about a ZIP code + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Zip) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Initializes a new instance of the class + using a Configuration object and client instance. + + The client interface for synchronous API access. + The client interface for asynchronous API access. + The configuration object. + + + + The client for accessing this underlying API asynchronously. + + + + + The client for accessing this underlying API synchronously. + + + + + Gets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + lookup Returns information about a ZIP code + + Thrown when fails to make API call + + Index associated with the operation. + Zip + + + + lookup Returns information about a ZIP code + + Thrown when fails to make API call + + Index associated with the operation. + ApiResponse of Zip + + + + lookup Returns information about a ZIP code + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of Zip + + + + lookup Returns information about a ZIP code + + Thrown when fails to make API call + + Index associated with the operation. + Cancellation Token to cancel the request. + Task of ApiResponse (Zip) + + + + Allows RestSharp to Serialize/Deserialize JSON using our custom logic, but only when ContentType is JSON. + + + + + Serialize the object into a JSON string. + + Object to be serialized. + A JSON string. + + + + Deserialize the JSON string into a proper object. + + The HTTP response. + Object type. + Object representation of the JSON string. + + + + Provides a default implementation of an Api client (both synchronous and asynchronous implementations), + encapsulating general REST accessor use cases. + + + + + Specifies the settings on a object. + These settings can be adjusted to accommodate custom serialization rules. + + + + + Initializes a new instance of the , defaulting to the global configurations' base url. + + + + + Initializes a new instance of the + + The target service's base path in URL format. + + + + + Constructs the RestSharp version of an http method + + Swagger Client Custom HttpMethod + RestSharp's HttpMethod instance. + + + + + Provides all logic for constructing a new RestSharp . + At this point, all information for querying the service is known. Here, it is simply + mapped into the RestSharp request. + + The http verb. + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + [private] A new RestRequest instance. + + + + + Make a HTTP GET request (async). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + Token that enables callers to cancel the request. + A Task containing ApiResponse + + + + Make a HTTP POST request (async). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + Token that enables callers to cancel the request. + A Task containing ApiResponse + + + + Make a HTTP PUT request (async). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + Token that enables callers to cancel the request. + A Task containing ApiResponse + + + + Make a HTTP DELETE request (async). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + Token that enables callers to cancel the request. + A Task containing ApiResponse + + + + Make a HTTP HEAD request (async). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + Token that enables callers to cancel the request. + A Task containing ApiResponse + + + + Make a HTTP OPTION request (async). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + Token that enables callers to cancel the request. + A Task containing ApiResponse + + + + Make a HTTP PATCH request (async). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + Token that enables callers to cancel the request. + A Task containing ApiResponse + + + + Make a HTTP GET request (synchronous). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + A Task containing ApiResponse + + + + Make a HTTP POST request (synchronous). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + A Task containing ApiResponse + + + + Make a HTTP PUT request (synchronous). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + A Task containing ApiResponse + + + + Make a HTTP DELETE request (synchronous). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + A Task containing ApiResponse + + + + Make a HTTP HEAD request (synchronous). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + A Task containing ApiResponse + + + + Make a HTTP OPTION request (synchronous). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + A Task containing ApiResponse + + + + Make a HTTP PATCH request (synchronous). + + The target path (or resource). + The additional request options. + A per-request configuration object. It is assumed that any merge with + GlobalConfiguration has been done before calling this method. + A Task containing ApiResponse + + + + API Exception + + + + + Gets or sets the error code (HTTP status code) + + The error code (HTTP status code). + + + + Gets or sets the error content (body json object) + + The error content (Http response body). + + + + Gets or sets the HTTP headers + + HTTP headers + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + HTTP status code. + Error message. + + + + Initializes a new instance of the class. + + HTTP status code. + Error message. + Error content. + HTTP Headers. + + + + Provides a non-generic contract for the ApiResponse wrapper. + + + + + The data type of + + + + + The content of this response + + + + + Gets or sets the status code (HTTP status code) + + The status code. + + + + Gets or sets the HTTP headers + + HTTP headers + + + + Gets or sets any error text defined by the calling client. + + + + + Gets or sets any cookies passed along on the response. + + + + + The raw content of this response + + + + + API Response + + + + + Gets or sets the status code (HTTP status code) + + The status code. + + + + Gets or sets the HTTP headers + + HTTP headers + + + + Gets or sets the data (parsed HTTP body) + + The data. + + + + Gets or sets any error text defined by the calling client. + + + + + Gets or sets any cookies passed along on the response. + + + + + The content of this response + + + + + The data type of + + + + + The raw content + + + + + Initializes a new instance of the class. + + HTTP status code. + HTTP headers. + Data (parsed HTTP body) + Raw content. + + + + Initializes a new instance of the class. + + HTTP status code. + HTTP headers. + Data (parsed HTTP body) + + + + Initializes a new instance of the class. + + HTTP status code. + Data (parsed HTTP body) + Raw content. + + + + Initializes a new instance of the class. + + HTTP status code. + Data (parsed HTTP body) + + + + Utility functions providing some benefit to API client consumers. + + + + + Sanitize filename by removing the path + + Filename + Filename + + + + Convert params to key/value pairs. + Use collectionFormat to properly format lists and collections. + + The swagger-supported collection format, one of: csv, tsv, ssv, pipes, multi + Key name. + Value object. + A multimap of keys with 1..n associated values. + + + + If parameter is DateTime, output in a formatted string (default ISO 8601), customizable with Configuration.DateTime. + If parameter is a list, join the list with ",". + Otherwise just return the string. + + The parameter (header, path, query, form). + An optional configuration instance, providing formatting options used in processing. + Formatted string. + + + + Encode string in base64 format. + + string to be encoded. + Encoded string. + + + + Convert stream to byte array + + Input stream to be converted + Byte array + + + + Select the Content-Type header's value from the given content-type array: + if JSON type exists in the given array, use it; + otherwise use the first one defined in 'consumes' + + The Content-Type array to select from. + The Content-Type header to use. + + + + Select the Accept header's value from the given accepts array: + if JSON exists in the given array, use it; + otherwise use all of them (joining into a string) + + The accepts array to select from. + The Accept header to use. + + + + Provides a case-insensitive check that a provided content type is a known JSON-like content type. + + + + + Check if the given MIME is a JSON MIME. + JSON MIME examples: + application/json + application/json; charset=UTF8 + APPLICATION/JSON + application/vnd.company+json + + MIME + Returns True if MIME type is json. + + + + Represents a set of configuration settings + + + + + Version of the package. + + Version of the package. + + + + Identifier for ISO 8601 DateTime Format + + See https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx#Anchor_8 for more information. + + + + Default creation of exceptions for a given method name and response object + + + + + Defines the base path of the target API server. + Example: http://localhost:3000/v1/ + + + + + Gets or sets the API key based on the authentication name. + This is the key and value comprising the "secret" for accessing an API. + + The API key. + + + + Gets or sets the prefix (e.g. Token) of the API key based on the authentication name. + + The prefix of the API key. + + + + Gets or sets the servers defined in the OpenAPI spec. + + The servers + + + + Gets or sets the operation servers defined in the OpenAPI spec. + + The operation servers + + + + Initializes a new instance of the class + + + + + Initializes a new instance of the class + + + + + Gets or sets the base path for API access. + + + + + Gets or sets the default header. + + + + + Gets or sets the default headers. + + + + + Gets or sets the HTTP timeout (milliseconds) of ApiClient. Default to 100000 milliseconds. + + + + + Gets or sets the proxy + + Proxy. + + + + Gets or sets the HTTP user agent. + + Http user agent. + + + + Gets or sets the username (HTTP basic authentication). + + The username. + + + + Gets or sets the password (HTTP basic authentication). + + The password. + + + + Gets the API key with prefix. + + API key identifier (authentication scheme). + API key with prefix. + + + + Gets or sets certificate collection to be sent with requests. + + X509 Certificate collection. + + + + Gets or sets the access token for OAuth2 authentication. + + This helper property simplifies code generation. + + The access token. + + + + Gets or sets the temporary folder path to store the files downloaded from the server. + + Folder path. + + + + Gets or sets the date time format used when serializing in the ApiClient + By default, it's set to ISO 8601 - "o", for others see: + https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx + and https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx + No validation is done to ensure that the string you're providing is valid + + The DateTimeFormat string + + + + Gets or sets the prefix (e.g. Token) of the API key based on the authentication name. + + Whatever you set here will be prepended to the value defined in AddApiKey. + + An example invocation here might be: + + ApiKeyPrefix["Authorization"] = "Bearer"; + + … where ApiKey["Authorization"] would then be used to set the value of your bearer token. + + + OAuth2 workflows should set tokens via AccessToken. + + + The prefix of the API key. + + + + Gets or sets the API key based on the authentication name. + + The API key. + + + + Gets or sets the servers. + + The servers. + + + + Gets or sets the operation servers. + + The operation servers. + + + + Returns URL based on server settings without providing values + for the variables + + Array index of the server settings. + The server URL. + + + + Returns URL based on server settings. + + Array index of the server settings. + Dictionary of the variables and the corresponding values. + The server URL. + + + + Returns URL based on operation server settings. + + Operation associated with the request path. + Array index of the server settings. + The operation server URL. + + + + Returns URL based on operation server settings. + + Operation associated with the request path. + Array index of the server settings. + Dictionary of the variables and the corresponding values. + The operation server URL. + + + + Returns URL based on server settings. + + Dictionary of server settings. + Array index of the server settings. + Dictionary of the variables and the corresponding values. + The server URL. + + + + Returns a string with essential information for debugging. + + + + + Add Api Key Header. + + Api Key name. + Api Key value. + + + + + Sets the API key prefix. + + Api Key name. + Api Key value. + + + + Merge configurations. + + First configuration. + Second configuration. + Merged configuration. + + + + A delegate to ExceptionFactory method + + Method name + Response + Exceptions + + + + provides a compile-time extension point for globally configuring + API Clients. + + + A customized implementation via partial class may reside in another file and may + be excluded from automatic generation via a .openapi-generator-ignore file. + + + + + + + + + + + Gets or sets the default Configuration. + + Configuration. + + + + Http methods supported by swagger + + + + HTTP GET request. + + + HTTP POST request. + + + HTTP PUT request. + + + HTTP DELETE request. + + + HTTP HEAD request. + + + HTTP OPTIONS request. + + + HTTP PATCH request. + + + + Represents configuration aspects required to interact with the API endpoints. + + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Gets the base path of the API client. + + The base path + + + + Provides a factory method hook for the creation of exceptions. + + + + + Contract for Asynchronous RESTful API interactions. + + This interface allows consumers to provide a custom API accessor client. + + + + + Executes a non-blocking call to some using the GET http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + Cancellation Token to cancel the request. + The return type. + A task eventually representing the response data, decorated with + + + + Executes a non-blocking call to some using the POST http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + Cancellation Token to cancel the request. + The return type. + A task eventually representing the response data, decorated with + + + + Executes a non-blocking call to some using the PUT http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + Cancellation Token to cancel the request. + The return type. + A task eventually representing the response data, decorated with + + + + Executes a non-blocking call to some using the DELETE http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + Cancellation Token to cancel the request. + The return type. + A task eventually representing the response data, decorated with + + + + Executes a non-blocking call to some using the HEAD http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + Cancellation Token to cancel the request. + The return type. + A task eventually representing the response data, decorated with + + + + Executes a non-blocking call to some using the OPTIONS http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + Cancellation Token to cancel the request. + The return type. + A task eventually representing the response data, decorated with + + + + Executes a non-blocking call to some using the PATCH http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + Cancellation Token to cancel the request. + The return type. + A task eventually representing the response data, decorated with + + + + Represents a readable-only configuration contract. + + + + + Gets the access token. + + Access token. + + + + Gets the API key. + + API key. + + + + Gets the API key prefix. + + API key prefix. + + + + Gets the base path. + + Base path. + + + + Gets the date time format. + + Date time format. + + + + Gets the default header. + + Default header. + + + + Gets the default headers. + + Default headers. + + + + Gets the temp folder path. + + Temp folder path. + + + + Gets the HTTP connection timeout (in milliseconds) + + HTTP connection timeout. + + + + Gets the proxy. + + Proxy. + + + + Gets the user agent. + + User agent. + + + + Gets the username. + + Username. + + + + Gets the password. + + Password. + + + + Get the servers associated with the operation. + + Operation servers. + + + + Gets the API key with prefix. + + API key identifier (authentication scheme). + API key with prefix. + + + + Gets the Operation server url at the provided index. + + Operation server name. + Index of the operation server settings. + + + + + Gets certificate collection to be sent with requests. + + X509 Certificate collection. + + + + Contract for Synchronous RESTful API interactions. + + This interface allows consumers to provide a custom API accessor client. + + + + + Executes a blocking call to some using the GET http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + The return type. + The response data, decorated with + + + + Executes a blocking call to some using the POST http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + The return type. + The response data, decorated with + + + + Executes a blocking call to some using the PUT http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + The return type. + The response data, decorated with + + + + Executes a blocking call to some using the DELETE http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + The return type. + The response data, decorated with + + + + Executes a blocking call to some using the HEAD http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + The return type. + The response data, decorated with + + + + Executes a blocking call to some using the OPTIONS http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + The return type. + The response data, decorated with + + + + Executes a blocking call to some using the PATCH http verb. + + The relative path to invoke. + The request parameters to pass along to the client. + Per-request configurable settings. + The return type. + The response data, decorated with + + + + A dictionary in which one key has many associated values. + + The type of the key + The type of the value associated with the key. + + + + Empty Constructor. + + + + + Constructor with comparer. + + + + + + To get the enumerator. + + Enumerator + + + + To get the enumerator. + + Enumerator + + + + Add values to Multimap + + Key value pair + + + + Add Multimap to Multimap + + Multimap + + + + Clear Multimap + + + + + Determines whether Multimap contains the specified item. + + Key value pair + Method needs to be implemented + true if the Multimap contains the item; otherwise, false. + + + + Copy items of the Multimap to an array, + starting at a particular array index. + + The array that is the destination of the items copied + from Multimap. The array must have zero-based indexing. + The zero-based index in array at which copying begins. + Method needs to be implemented + + + + Removes the specified item from the Multimap. + + Key value pair + true if the item is successfully removed; otherwise, false. + Method needs to be implemented + + + + Gets the number of items contained in the Multimap. + + + + + Gets a value indicating whether the Multimap is read-only. + + + + + Adds an item with the provided key and value to the Multimap. + + The object to use as the key of the item to add. + The object to use as the value of the item to add. + Thrown when couldn't add the value to Multimap. + + + + Determines whether the Multimap contains an item with the specified key. + + The key to locate in the Multimap. + true if the Multimap contains an item with + the key; otherwise, false. + + + + Removes item with the specified key from the Multimap. + + The key to locate in the Multimap. + true if the item is successfully removed; otherwise, false. + + + + Gets the value associated with the specified key. + + The key whose value to get. + When this method returns, the value associated with the specified key, if the + key is found; otherwise, the default value for the type of the value parameter. + This parameter is passed uninitialized. + true if the object that implements Multimap contains + an item with the specified key; otherwise, false. + + + + Gets or sets the item with the specified key. + + The key of the item to get or set. + The value of the specified key. + + + + Gets a System.Collections.Generic.ICollection containing the keys of the Multimap. + + + + + Gets a System.Collections.Generic.ICollection containing the values of the Multimap. + + + + + Copy the items of the Multimap to an System.Array, + starting at a particular System.Array index. + + The one-dimensional System.Array that is the destination of the items copied + from Multimap. The System.Array must have zero-based indexing. + The zero-based index in array at which copying begins. + + + + Adds an item with the provided key and value to the Multimap. + + The object to use as the key of the item to add. + The object to use as the value of the item to add. + Thrown when couldn't add value to Multimap. + + + Helper method to encapsulate generator differences between dictionary types. + + + Helper method to encapsulate generator differences between dictionary types. + + + + Formatter for 'date' openapi formats ss defined by full-date - RFC3339 + see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#data-types + + + + + Initializes a new instance of the class. + + + + + A container for generalized request inputs. This type allows consumers to extend the request functionality + by abstracting away from the default (built-in) request framework (e.g. RestSharp). + + + + + Parameters to be bound to path parts of the Request's URL + + + + + Query parameters to be applied to the request. + Keys may have 1 or more values associated. + + + + + Header parameters to be applied to to the request. + Keys may have 1 or more values associated. + + + + + Form parameters to be sent along with the request. + + + + + File parameters to be sent along with the request. + + + + + Cookies to be sent along with the request. + + + + + Operation associated with the request path. + + + + + Index associated with the operation. + + + + + Any data associated with a request body. + + + + + Constructs a new instance of + + + + + Configuration class to set the polly retry policies to be applied to the requests. + + + + + Retry policy + + + + + Async retry policy + + + + + Abstract base class for oneOf, anyOf schemas in the OpenAPI specification + + + + + Custom JSON serializer + + + + + Custom JSON serializer for objects with additional properties + + + + + Gets or Sets the actual instance + + + + + Gets or Sets IsNullable to indicate whether the instance is nullable + + + + + Gets or Sets the schema type, which can be either `oneOf` or `anyOf` + + + + + Converts the instance into JSON string. + + + + + Address + + + + + Defines Object + + + + + Enum Address for value: address + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `adr_`.. + An internal description that identifies this resource. Must be no longer than 255 characters. . + name associated with address. + Either `name` or `company` is required, you may also add both.. + Must be no longer than 40 characters.. + Must be no longer than 100 characters.. + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + addressLine1. + addressLine2. + addressCity. + 2 letter state short-name code. + Must follow the ZIP format of `12345` or ZIP+4 format of `12345-1234`. . + addressCountry. + _object (default to ObjectEnum.Address). + A timestamp in ISO 8601 format of the date the resource was created.. + A timestamp in ISO 8601 format of the date the resource was last modified.. + Only returned if the resource has been successfully deleted.. + Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print &amp; Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account. . + + + + Unique identifier prefixed with `adr_`. + + Unique identifier prefixed with `adr_`. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + name associated with address + + name associated with address + + + + Either `name` or `company` is required, you may also add both. + + Either `name` or `company` is required, you may also add both. + + + + Must be no longer than 40 characters. + + Must be no longer than 40 characters. + + + + Must be no longer than 100 characters. + + Must be no longer than 100 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Gets or Sets AddressLine1 + + + + + Gets or Sets AddressLine2 + + + + + Gets or Sets AddressCity + + + + + 2 letter state short-name code + + 2 letter state short-name code + + + + Must follow the ZIP format of `12345` or ZIP+4 format of `12345-1234`. + + Must follow the ZIP format of `12345` or ZIP+4 format of `12345-1234`. + + + + Gets or Sets AddressCountry + + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print &amp; Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account. + + Only returned for accounts on certain <a href=\"https://dashboard.lob.com/#/settings/editions\">Print &amp; Mail Editions</a>. Value is `true` if the address was altered because the recipient filed for a <a href=\"#ncoa\">National Change of Address (NCOA)</a>, `false` if the NCOA check was run but no altered address was found, and `null` if the NCOA check was not run. The NCOA check does not happen for non-US addresses, for non-deliverable US addresses, or for addresses created before the NCOA feature was added to your account. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Address instances are equal + + Instance of Address to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Object returned upon deleting an address + + + + + Value is type of resource. + + Value is type of resource. + + + + Enum AddressDeleted for value: address_deleted + + + + + Value is type of resource. + + Value is type of resource. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `adr_`.. + Only returned if the resource has been successfully deleted.. + Value is type of resource. (default to ObjectEnum.AddressDeleted). + + + + Unique identifier prefixed with `adr_`. + + Unique identifier prefixed with `adr_`. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if AddressDeletion instances are equal + + Instance of AddressDeletion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + AddressDomestic + + + + + Initializes a new instance of the class. + + The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters.. + The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters.. + addressCity. + addressState. + Optional postal code. For US addresses, must be either 5 or 9 digits.. + An internal description that identifies this resource. Must be no longer than 255 characters. . + Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. . + Either `name` or `company` is required, you may also add both.. + Must be no longer than 40 characters.. + Must be no longer than 100 characters.. + The country associated with this address.. + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + + + + The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. + + The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. + + + + The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. + + The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. + + + + Gets or Sets AddressCity + + + + + Gets or Sets AddressState + + + + + Optional postal code. For US addresses, must be either 5 or 9 digits. + + Optional postal code. For US addresses, must be either 5 or 9 digits. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. + + Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. + + + + Either `name` or `company` is required, you may also add both. + + Either `name` or `company` is required, you may also add both. + + + + Must be no longer than 40 characters. + + Must be no longer than 40 characters. + + + + Must be no longer than 100 characters. + + Must be no longer than 100 characters. + + + + The country associated with this address. + + The country associated with this address. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if AddressDomestic instances are equal + + Instance of AddressDomestic to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + AddressDomesticExpanded + + + + + Initializes a new instance of the class. + + The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters.. + The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters.. + addressCity. + addressState. + Optional postal code. For US addresses, must be either 5 or 9 digits.. + An internal description that identifies this resource. Must be no longer than 255 characters. . + Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. . + Either `name` or `company` is required, you may also add both.. + Must be no longer than 40 characters.. + Must be no longer than 100 characters.. + The country associated with this address.. + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + + + + The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. + + The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. + + + + The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. + + The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. + + + + Gets or Sets AddressCity + + + + + Gets or Sets AddressState + + + + + Optional postal code. For US addresses, must be either 5 or 9 digits. + + Optional postal code. For US addresses, must be either 5 or 9 digits. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. + + Either `name` or `company` is required, you may also add both. Must be no longer than 40 characters. If both `name` and `company` are provided, they will be printed on two separate lines above the rest of the address. + + + + Either `name` or `company` is required, you may also add both. + + Either `name` or `company` is required, you may also add both. + + + + Must be no longer than 40 characters. + + Must be no longer than 40 characters. + + + + Must be no longer than 100 characters. + + Must be no longer than 100 characters. + + + + The country associated with this address. + + The country associated with this address. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if AddressDomesticExpanded instances are equal + + Instance of AddressDomesticExpanded to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + AddressEditable + + + + + Initializes a new instance of the class. + + The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters.. + The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters.. + addressCity. + addressState. + Optional postal code. For US addresses, must be either 5 or 9 digits.. + addressCountry. + An internal description that identifies this resource. Must be no longer than 255 characters. . + name associated with address.. + Either `name` or `company` is required, you may also add both.. + Must be no longer than 40 characters.. + Must be no longer than 100 characters.. + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + + + + The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. + + The building number, street name, street suffix, and any street directionals. For US addresses, the max length is 64 characters. + + + + The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. + + The suite or apartment number of the recipient address, if applicable. For US addresses, the max length is 64 characters. + + + + Gets or Sets AddressCity + + + + + Gets or Sets AddressState + + + + + Optional postal code. For US addresses, must be either 5 or 9 digits. + + Optional postal code. For US addresses, must be either 5 or 9 digits. + + + + Gets or Sets AddressCountry + + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + name associated with address. + + name associated with address. + + + + Either `name` or `company` is required, you may also add both. + + Either `name` or `company` is required, you may also add both. + + + + Must be no longer than 40 characters. + + Must be no longer than 40 characters. + + + + Must be no longer than 100 characters. + + Must be no longer than 100 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if AddressEditable instances are equal + + Instance of AddressEditable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + AddressList + + + + + Initializes a new instance of the class. + + list of addresses. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + indicates the total number of records. Provided when the request specifies an \"include\" query parameter. + + + + list of addresses + + list of addresses + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if AddressList instances are equal + + Instance of AddressList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + BankAccount + + + + + The type of entity that holds the account. + + The type of entity that holds the account. + + + + Enum Company for value: company + + + + + Enum Individual for value: individual + + + + + The type of entity that holds the account. + + The type of entity that holds the account. + + + + Defines Object + + + + + Enum BankAccount for value: bank_account + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + An internal description that identifies this resource. Must be no longer than 255 characters. . + Must be a [valid US routing number](https://www.frbservices.org/index.html). (required). + accountNumber (required). + The type of entity that holds the account. (required). + The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). (required). + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + Unique identifier prefixed with `bank_`. (required). + A signed link to the signature image. will be generated.. + The name of the bank based on the provided routing number, e.g. `JPMORGAN CHASE BANK`.. + A bank account must be verified before a check can be created. (default to false). + A timestamp in ISO 8601 format of the date the resource was created. (required). + A timestamp in ISO 8601 format of the date the resource was last modified. (required). + Only returned if the resource has been successfully deleted.. + _object (required) (default to ObjectEnum.BankAccount). + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Must be a [valid US routing number](https://www.frbservices.org/index.html). + + Must be a [valid US routing number](https://www.frbservices.org/index.html). + + + + Gets or Sets AccountNumber + + + + + The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). + + The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Unique identifier prefixed with `bank_`. + + Unique identifier prefixed with `bank_`. + + + + A signed link to the signature image. will be generated. + + A signed link to the signature image. will be generated. + + + + The name of the bank based on the provided routing number, e.g. `JPMORGAN CHASE BANK`. + + The name of the bank based on the provided routing number, e.g. `JPMORGAN CHASE BANK`. + + + + A bank account must be verified before a check can be created. + + A bank account must be verified before a check can be created. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BankAccount instances are equal + + Instance of BankAccount to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + + + + + Value is type of resource. + + Value is type of resource. + + + + Enum BankAccountDeleted for value: bank_account_deleted + + + + + Value is type of resource. + + Value is type of resource. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `bank_`.. + Only returned if the resource has been successfully deleted.. + Value is type of resource. (default to ObjectEnum.BankAccountDeleted). + + + + Unique identifier prefixed with `bank_`. + + Unique identifier prefixed with `bank_`. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BankAccountDeletion instances are equal + + Instance of BankAccountDeletion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + BankAccountList + + + + + Initializes a new instance of the class. + + list of addresses. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + indicates the total number of records. Provided when the request specifies an \"include\" query parameter. + + + + list of addresses + + list of addresses + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BankAccountList instances are equal + + Instance of BankAccountList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + BankAccountVerify + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + In live mode, an array containing the two micro deposits (in cents) placed in the bank account. In test mode, no micro deposits will be placed, so any two integers between `1` and `100` will work. (required). + + + + In live mode, an array containing the two micro deposits (in cents) placed in the bank account. In test mode, no micro deposits will be placed, so any two integers between `1` and `100` will work. + + In live mode, an array containing the two micro deposits (in cents) placed in the bank account. In test mode, no micro deposits will be placed, so any two integers between `1` and `100` will work. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BankAccountVerify instances are equal + + Instance of BankAccountVerify to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + BankAccountWritable + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + An internal description that identifies this resource. Must be no longer than 255 characters. . + Must be a [valid US routing number](https://www.frbservices.org/index.html). (required). + accountNumber (required). + accountType (required). + The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). (required). + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Must be a [valid US routing number](https://www.frbservices.org/index.html). + + Must be a [valid US routing number](https://www.frbservices.org/index.html). + + + + Gets or Sets AccountNumber + + + + + Gets or Sets AccountType + + + + + The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). + + The signatory associated with your account. This name will be printed on checks created with this bank account. If you prefer to use a custom signature image on your checks instead, please create your bank account from the [Dashboard](https://dashboard.lob.com/#/login). + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BankAccountWritable instances are equal + + Instance of BankAccountWritable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + The type of entity that holds the account. + + The type of entity that holds the account. + + + + Enum Company for value: company + + + + + Enum Individual for value: individual + + + + + BillingGroup + + + + + Value is resource type. + + Value is resource type. + + + + Enum BillingGroup for value: billing_group + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Description of the billing group.. + Name of the billing group. (required). + Unique identifier prefixed with `bg_`. (required). + A timestamp in ISO 8601 format of the date the resource was created. (required). + A timestamp in ISO 8601 format of the date the resource was last modified. (required). + Value is resource type. (required) (default to ObjectEnum.BillingGroup). + + + + Description of the billing group. + + Description of the billing group. + + + + Name of the billing group. + + Name of the billing group. + + + + Unique identifier prefixed with `bg_`. + + Unique identifier prefixed with `bg_`. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BillingGroup instances are equal + + Instance of BillingGroup to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + BillingGroupEditable + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Description of the billing group.. + Name of the billing group. (required). + + + + Description of the billing group. + + Description of the billing group. + + + + Name of the billing group. + + Name of the billing group. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BillingGroupEditable instances are equal + + Instance of BillingGroupEditable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + BillingGroupList + + + + + Initializes a new instance of the class. + + list of billing groups. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + + + + list of billing groups + + list of billing groups + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BillingGroupList instances are equal + + Instance of BillingGroupList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. + + + + + Initializes a new instance of the class. + + error. + + + + Gets or Sets Error + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BulkError instances are equal + + Instance of BulkError to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Bulk error properties + + + + + A conventional HTTP status code. + + A conventional HTTP status code. + + + + Enum NUMBER_401 for value: 401 + + + + + Enum NUMBER_403 for value: 403 + + + + + Enum NUMBER_404 for value: 404 + + + + + Enum NUMBER_413 for value: 413 + + + + + Enum NUMBER_422 for value: 422 + + + + + Enum NUMBER_429 for value: 429 + + + + + Enum NUMBER_500 for value: 500 + + + + + A conventional HTTP status code. + + A conventional HTTP status code. + + + + Initializes a new instance of the class. + + A human-readable message with more details about the error. + A conventional HTTP status code.. + + + + A human-readable message with more details about the error + + A human-readable message with more details about the error + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if BulkErrorProperties instances are equal + + Instance of BulkErrorProperties to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Card + + + + + Defines Status + + + + + Enum Processed for value: processed + + + + + Enum Rendered for value: rendered + + + + + Gets or Sets Status + + + + + The orientation of the card. + + The orientation of the card. + + + + Enum Horizontal for value: horizontal + + + + + Enum Vertical for value: vertical + + + + + The orientation of the card. + + The orientation of the card. + + + + object + + object + + + + Enum Card for value: card + + + + + object + + object + + + + The size of the card + + The size of the card + + + + Enum _3375x2125 for value: 3.375x2.125 + + + + + Enum _2125x3375 for value: 2.125x3.375 + + + + + The size of the card + + The size of the card + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `card_`. (required). + The signed link for the card. (required). + True if the cards should be auto-reordered. (required) (default to false). + The number of cards to be reordered. Only present when auto_reorder is True.. + The raw URL of the card.. + The original URL of the front template.. + The original URL of the back template.. + thumbnails (required). + The available quantity of cards. (required) (default to 0). + The pending quantity of cards. (required) (default to 0). + status. + The orientation of the card. (default to OrientationEnum.Horizontal). + The threshold amount of the card (default to 0). + A timestamp in ISO 8601 format of the date the resource was created. (required). + A timestamp in ISO 8601 format of the date the resource was last modified. (required). + Only returned if the resource has been successfully deleted.. + object (required) (default to ObjectEnum.Card). + Description of the card.. + The size of the card (required) (default to SizeEnum._2125x3375). + + + + Unique identifier prefixed with `card_`. + + Unique identifier prefixed with `card_`. + + + + The signed link for the card. + + The signed link for the card. + + + + True if the cards should be auto-reordered. + + True if the cards should be auto-reordered. + + + + The number of cards to be reordered. Only present when auto_reorder is True. + + The number of cards to be reordered. Only present when auto_reorder is True. + + + + The raw URL of the card. + + The raw URL of the card. + + + + The original URL of the front template. + + The original URL of the front template. + + + + The original URL of the back template. + + The original URL of the back template. + + + + Gets or Sets Thumbnails + + + + + The available quantity of cards. + + The available quantity of cards. + + + + The pending quantity of cards. + + The pending quantity of cards. + + + + The threshold amount of the card + + The threshold amount of the card + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Description of the card. + + Description of the card. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Card instances are equal + + Instance of Card to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + + + + + Value is type of resource. + + Value is type of resource. + + + + Enum CardDeleted for value: card_deleted + + + + + Value is type of resource. + + Value is type of resource. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `card_`.. + Only returned if the resource has been successfully deleted.. + Value is type of resource. (default to ObjectEnum.CardDeleted). + + + + Unique identifier prefixed with `card_`. + + Unique identifier prefixed with `card_`. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CardDeletion instances are equal + + Instance of CardDeletion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + CardEditable + + + + + The size of the card + + The size of the card + + + + Enum _3375x2125 for value: 3.375x2.125 + + + + + Enum _2125x3375 for value: 2.125x3.375 + + + + + The size of the card + + The size of the card + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A PDF template for the front of the card (required). + A PDF template for the back of the card (default to "https://s3.us-west-2.amazonaws.com/public.lob.com/assets/card_blank_horizontal.pdf"). + The size of the card (default to SizeEnum._2125x3375). + Description of the card.. + + + + A PDF template for the front of the card + + A PDF template for the front of the card + + + + A PDF template for the back of the card + + A PDF template for the back of the card + + + + Description of the card. + + Description of the card. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CardEditable instances are equal + + Instance of CardEditable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + CardList + + + + + Initializes a new instance of the class. + + list of cards. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + indicates the total number of records. Provided when the request specifies an \"include\" query parameter. + + + + list of cards + + list of cards + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CardList instances are equal + + Instance of CardList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + CardOrder + + + + + The status of the card order. + + The status of the card order. + + + + Enum Pending for value: pending + + + + + Enum Printing for value: printing + + + + + Enum Available for value: available + + + + + Enum Cancelled for value: cancelled + + + + + Enum Depleted for value: depleted + + + + + The status of the card order. + + The status of the card order. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `co_`.. + Unique identifier prefixed with `card_`.. + The status of the card order.. + The inventory of the card order. (default to 0M). + The quantity of cards ordered (default to 0M). + The unit price for the card order. (default to 0M). + The reason for cancellation.. + A timestamp in ISO 8601 format of the date the resource was created.. + The fixed deadline for the cards to be printed.. + A timestamp in ISO 8601 format of the date the resource was created. (required). + A timestamp in ISO 8601 format of the date the resource was last modified. (required). + Only returned if the resource has been successfully deleted.. + Value is type of resource. (required). + + + + Unique identifier prefixed with `co_`. + + Unique identifier prefixed with `co_`. + + + + Unique identifier prefixed with `card_`. + + Unique identifier prefixed with `card_`. + + + + The inventory of the card order. + + The inventory of the card order. + + + + The quantity of cards ordered + + The quantity of cards ordered + + + + The unit price for the card order. + + The unit price for the card order. + + + + The reason for cancellation. + + The reason for cancellation. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + The fixed deadline for the cards to be printed. + + The fixed deadline for the cards to be printed. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Value is type of resource. + + Value is type of resource. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CardOrder instances are equal + + Instance of CardOrder to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + CardOrderEditable + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + quantity (required). + + + + Gets or Sets Quantity + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CardOrderEditable instances are equal + + Instance of CardOrderEditable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + CardOrderList + + + + + Initializes a new instance of the class. + + list of card orders. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + + + + list of card orders + + list of card orders + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CardOrderList instances are equal + + Instance of CardOrderList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + CardUpdatable + + + + + Initializes a new instance of the class. + + Description of the card.. + Allows for auto reordering. + The quantity of items to be reordered (only required when auto_reorder is true).. + + + + Description of the card. + + Description of the card. + + + + Allows for auto reordering + + Allows for auto reordering + + + + The quantity of items to be reordered (only required when auto_reorder is true). + + The quantity of items to be reordered (only required when auto_reorder is true). + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CardUpdatable instances are equal + + Instance of CardUpdatable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Check + + + + + Checks must be sent `usps_first_class` + + Checks must be sent `usps_first_class` + + + + Enum UspsFirstClass for value: usps_first_class + + + + + Checks must be sent `usps_first_class` + + Checks must be sent `usps_first_class` + + + + Defines Carrier + + + + + Enum USPS for value: USPS + + + + + Gets or Sets Carrier + + + + + Defines Object + + + + + Enum Check for value: check + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `chk_`. (required). + to (required). + from. + An internal description that identifies this resource. Must be no longer than 255 characters. . + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.. + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. + Checks must be sent `usps_first_class` (default to MailTypeEnum.UspsFirstClass). + Text to include on the memo line of the check.. + An integer that designates the check number. If `check_number` is not provided, checks created from a new `bank_account` will start at `10000` and increment with each check created with the `bank_account`. A provided `check_number` overrides the defaults. Subsequent checks created with the same `bank_account` will increment from the provided check number.. + Max of 400 characters to be included at the bottom of the check page.. + The payment amount to be sent in US dollars. (required). + bankAccount (required). + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).. + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).. + Unique identifier prefixed with `vrsn_`.. + Unique identifier prefixed with `vrsn_`.. + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. (required). + carrier (required) (default to CarrierEnum.USPS). + thumbnails. + A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`.. + An array of tracking_event objects ordered by ascending `time`. Will not be populated for checks created in test mode.. + _object (required) (default to ObjectEnum.Check). + A timestamp in ISO 8601 format of the date the resource was created. (required). + A timestamp in ISO 8601 format of the date the resource was last modified. (required). + Only returned if the resource has been successfully deleted.. + useType (required). + + + + Unique identifier prefixed with `chk_`. + + Unique identifier prefixed with `chk_`. + + + + Gets or Sets To + + + + + Gets or Sets From + + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + + + Text to include on the memo line of the check. + + Text to include on the memo line of the check. + + + + An integer that designates the check number. If `check_number` is not provided, checks created from a new `bank_account` will start at `10000` and increment with each check created with the `bank_account`. A provided `check_number` overrides the defaults. Subsequent checks created with the same `bank_account` will increment from the provided check number. + + An integer that designates the check number. If `check_number` is not provided, checks created from a new `bank_account` will start at `10000` and increment with each check created with the `bank_account`. A provided `check_number` overrides the defaults. Subsequent checks created with the same `bank_account` will increment from the provided check number. + + + + Max of 400 characters to be included at the bottom of the check page. + + Max of 400 characters to be included at the bottom of the check page. + + + + The payment amount to be sent in US dollars. + + The payment amount to be sent in US dollars. + + + + Gets or Sets BankAccount + + + + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + + + Unique identifier prefixed with `vrsn_`. + + Unique identifier prefixed with `vrsn_`. + + + + Unique identifier prefixed with `vrsn_`. + + Unique identifier prefixed with `vrsn_`. + + + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + + + Gets or Sets Thumbnails + + + + + A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. + + A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. + + + + An array of tracking_event objects ordered by ascending `time`. Will not be populated for checks created in test mode. + + An array of tracking_event objects ordered by ascending `time`. Will not be populated for checks created in test mode. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Gets or Sets UseType + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Check instances are equal + + Instance of Check to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + + + + + Value is type of resource. + + Value is type of resource. + + + + Enum CheckDeleted for value: check_deleted + + + + + Value is type of resource. + + Value is type of resource. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `chk_`.. + Only returned if the resource has been successfully deleted.. + Value is type of resource. (default to ObjectEnum.CheckDeleted). + + + + Unique identifier prefixed with `chk_`. + + Unique identifier prefixed with `chk_`. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CheckDeletion instances are equal + + Instance of CheckDeletion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + CheckEditable + + + + + Checks must be sent `usps_first_class` + + Checks must be sent `usps_first_class` + + + + Enum UspsFirstClass for value: usps_first_class + + + + + Checks must be sent `usps_first_class` + + Checks must be sent `usps_first_class` + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Must either be an address ID or an inline object with correct address parameters. (required). + Must either be an address ID or an inline object with correct address parameters. (required). + bankAccount (required). + The payment amount to be sent in US dollars. (required). + Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check.. + The artwork to use on the bottom of the check page. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at 8.5\"x11\" at 300 DPI, while supplied HTML will be rendered and trimmed to fit on a 8.5\"x11\" page. - The check bottom will always be printed in black & white. - Must conform to [this template](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_bottom_template.pdf). Need more help? Consult our [HTML examples](#section/HTML-Examples).. + A document to include with the check.. + An internal description that identifies this resource. Must be no longer than 255 characters. . + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.. + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. + Checks must be sent `usps_first_class` (default to MailTypeEnum.UspsFirstClass). + Text to include on the memo line of the check.. + An integer that designates the check number.. + Max of 400 characters to be included at the bottom of the check page.. + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information.. + useType (required). + + + + Must either be an address ID or an inline object with correct address parameters. + + Must either be an address ID or an inline object with correct address parameters. + + + + Must either be an address ID or an inline object with correct address parameters. + + Must either be an address ID or an inline object with correct address parameters. + + + + Gets or Sets BankAccount + + + + + The payment amount to be sent in US dollars. + + The payment amount to be sent in US dollars. + + + + Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. + + Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. + + + + The artwork to use on the bottom of the check page. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at 8.5\"x11\" at 300 DPI, while supplied HTML will be rendered and trimmed to fit on a 8.5\"x11\" page. - The check bottom will always be printed in black & white. - Must conform to [this template](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_bottom_template.pdf). Need more help? Consult our [HTML examples](#section/HTML-Examples). + + The artwork to use on the bottom of the check page. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at 8.5\"x11\" at 300 DPI, while supplied HTML will be rendered and trimmed to fit on a 8.5\"x11\" page. - The check bottom will always be printed in black & white. - Must conform to [this template](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/check_bottom_template.pdf). Need more help? Consult our [HTML examples](#section/HTML-Examples). + + + + A document to include with the check. + + A document to include with the check. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + + + Text to include on the memo line of the check. + + Text to include on the memo line of the check. + + + + An integer that designates the check number. + + An integer that designates the check number. + + + + Max of 400 characters to be included at the bottom of the check page. + + Max of 400 characters to be included at the bottom of the check page. + + + + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. + + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. + + + + Gets or Sets UseType + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CheckEditable instances are equal + + Instance of CheckEditable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + CheckList + + + + + Initializes a new instance of the class. + + list of checks. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + indicates the total number of records. Provided when the request specifies an \"include\" query parameter. + + + + list of checks + + list of checks + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CheckList instances are equal + + Instance of CheckList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TThe use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). + + TThe use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). + + + + Enum Marketing for value: marketing + + + + + Enum Operational for value: operational + + + + + Enum Null for value: null + + + + + Must be a 2 letter country short-name code (ISO 3166). + + Must be a 2 letter country short-name code (ISO 3166). + + + + Enum Empty for value: + + + + + Enum AD for value: AD + + + + + Enum AE for value: AE + + + + + Enum AF for value: AF + + + + + Enum AG for value: AG + + + + + Enum AI for value: AI + + + + + Enum AL for value: AL + + + + + Enum AN for value: AN + + + + + Enum AO for value: AO + + + + + Enum AQ for value: AQ + + + + + Enum AR for value: AR + + + + + Enum AT for value: AT + + + + + Enum AU for value: AU + + + + + Enum AW for value: AW + + + + + Enum AZ for value: AZ + + + + + Enum BA for value: BA + + + + + Enum BB for value: BB + + + + + Enum BD for value: BD + + + + + Enum BE for value: BE + + + + + Enum BF for value: BF + + + + + Enum BG for value: BG + + + + + Enum BH for value: BH + + + + + Enum BI for value: BI + + + + + Enum BJ for value: BJ + + + + + Enum BM for value: BM + + + + + Enum BN for value: BN + + + + + Enum BO for value: BO + + + + + Enum BQ for value: BQ + + + + + Enum BR for value: BR + + + + + Enum BS for value: BS + + + + + Enum BT for value: BT + + + + + Enum BW for value: BW + + + + + Enum BY for value: BY + + + + + Enum BZ for value: BZ + + + + + Enum CA for value: CA + + + + + Enum CD for value: CD + + + + + Enum CG for value: CG + + + + + Enum CH for value: CH + + + + + Enum CI for value: CI + + + + + Enum CK for value: CK + + + + + Enum CL for value: CL + + + + + Enum CM for value: CM + + + + + Enum CN for value: CN + + + + + Enum CO for value: CO + + + + + Enum CR for value: CR + + + + + Enum CS for value: CS + + + + + Enum CU for value: CU + + + + + Enum CV for value: CV + + + + + Enum CW for value: CW + + + + + Enum CY for value: CY + + + + + Enum CZ for value: CZ + + + + + Enum DE for value: DE + + + + + Enum DJ for value: DJ + + + + + Enum DK for value: DK + + + + + Enum DM for value: DM + + + + + Enum DO for value: DO + + + + + Enum DZ for value: DZ + + + + + Enum EC for value: EC + + + + + Enum EE for value: EE + + + + + Enum EG for value: EG + + + + + Enum EH for value: EH + + + + + Enum ER for value: ER + + + + + Enum ES for value: ES + + + + + Enum ET for value: ET + + + + + Enum FI for value: FI + + + + + Enum FJ for value: FJ + + + + + Enum FK for value: FK + + + + + Enum FO for value: FO + + + + + Enum FR for value: FR + + + + + Enum GA for value: GA + + + + + Enum GB for value: GB + + + + + Enum GD for value: GD + + + + + Enum GE for value: GE + + + + + Enum GH for value: GH + + + + + Enum GI for value: GI + + + + + Enum GL for value: GL + + + + + Enum GM for value: GM + + + + + Enum GN for value: GN + + + + + Enum GQ for value: GQ + + + + + Enum GR for value: GR + + + + + Enum GS for value: GS + + + + + Enum GT for value: GT + + + + + Enum GW for value: GW + + + + + Enum GY for value: GY + + + + + Enum HK for value: HK + + + + + Enum HN for value: HN + + + + + Enum HR for value: HR + + + + + Enum HT for value: HT + + + + + Enum HU for value: HU + + + + + Enum ID for value: ID + + + + + Enum IE for value: IE + + + + + Enum IL for value: IL + + + + + Enum IN for value: IN + + + + + Enum IO for value: IO + + + + + Enum IQ for value: IQ + + + + + Enum IR for value: IR + + + + + Enum IS for value: IS + + + + + Enum IT for value: IT + + + + + Enum JM for value: JM + + + + + Enum JO for value: JO + + + + + Enum JP for value: JP + + + + + Enum KE for value: KE + + + + + Enum KG for value: KG + + + + + Enum KH for value: KH + + + + + Enum KI for value: KI + + + + + Enum KM for value: KM + + + + + Enum KN for value: KN + + + + + Enum KP for value: KP + + + + + Enum KR for value: KR + + + + + Enum KW for value: KW + + + + + Enum KY for value: KY + + + + + Enum KZ for value: KZ + + + + + Enum LA for value: LA + + + + + Enum LB for value: LB + + + + + Enum LC for value: LC + + + + + Enum LI for value: LI + + + + + Enum LK for value: LK + + + + + Enum LR for value: LR + + + + + Enum LS for value: LS + + + + + Enum LT for value: LT + + + + + Enum LU for value: LU + + + + + Enum LV for value: LV + + + + + Enum LY for value: LY + + + + + Enum MA for value: MA + + + + + Enum MC for value: MC + + + + + Enum MD for value: MD + + + + + Enum ME for value: ME + + + + + Enum MG for value: MG + + + + + Enum MK for value: MK + + + + + Enum ML for value: ML + + + + + Enum MM for value: MM + + + + + Enum MN for value: MN + + + + + Enum MO for value: MO + + + + + Enum MR for value: MR + + + + + Enum MS for value: MS + + + + + Enum MT for value: MT + + + + + Enum MU for value: MU + + + + + Enum MV for value: MV + + + + + Enum MW for value: MW + + + + + Enum MX for value: MX + + + + + Enum MY for value: MY + + + + + Enum MZ for value: MZ + + + + + Enum NA for value: NA + + + + + Enum NE for value: NE + + + + + Enum NF for value: NF + + + + + Enum NG for value: NG + + + + + Enum NI for value: NI + + + + + Enum NL for value: NL + + + + + Enum NO for value: NO + + + + + Enum NP for value: NP + + + + + Enum NR for value: NR + + + + + Enum NU for value: NU + + + + + Enum NZ for value: NZ + + + + + Enum OM for value: OM + + + + + Enum PA for value: PA + + + + + Enum PE for value: PE + + + + + Enum PG for value: PG + + + + + Enum PH for value: PH + + + + + Enum PK for value: PK + + + + + Enum PL for value: PL + + + + + Enum PN for value: PN + + + + + Enum PT for value: PT + + + + + Enum PY for value: PY + + + + + Enum QA for value: QA + + + + + Enum RO for value: RO + + + + + Enum RS for value: RS + + + + + Enum RU for value: RU + + + + + Enum RW for value: RW + + + + + Enum SA for value: SA + + + + + Enum SB for value: SB + + + + + Enum SC for value: SC + + + + + Enum SD for value: SD + + + + + Enum SE for value: SE + + + + + Enum SG for value: SG + + + + + Enum SH for value: SH + + + + + Enum SI for value: SI + + + + + Enum SK for value: SK + + + + + Enum SL for value: SL + + + + + Enum SM for value: SM + + + + + Enum SN for value: SN + + + + + Enum SO for value: SO + + + + + Enum SR for value: SR + + + + + Enum SS for value: SS + + + + + Enum ST for value: ST + + + + + Enum SV for value: SV + + + + + Enum SX for value: SX + + + + + Enum SY for value: SY + + + + + Enum SZ for value: SZ + + + + + Enum TC for value: TC + + + + + Enum TD for value: TD + + + + + Enum TG for value: TG + + + + + Enum TH for value: TH + + + + + Enum TJ for value: TJ + + + + + Enum TK for value: TK + + + + + Enum TL for value: TL + + + + + Enum TM for value: TM + + + + + Enum TN for value: TN + + + + + Enum TO for value: TO + + + + + Enum TR for value: TR + + + + + Enum TT for value: TT + + + + + Enum TV for value: TV + + + + + Enum TW for value: TW + + + + + Enum TZ for value: TZ + + + + + Enum UA for value: UA + + + + + Enum UG for value: UG + + + + + Enum US for value: US + + + + + Enum UY for value: UY + + + + + Enum UZ for value: UZ + + + + + Enum VA for value: VA + + + + + Enum VC for value: VC + + + + + Enum VE for value: VE + + + + + Enum VG for value: VG + + + + + Enum VN for value: VN + + + + + Enum VU for value: VU + + + + + Enum WS for value: WS + + + + + Enum YE for value: YE + + + + + Enum ZA for value: ZA + + + + + Enum ZM for value: ZM + + + + + Enum ZW for value: ZW + + + + + Full name of country + + Full name of country + + + + Enum Empty for value: + + + + + Enum AFGHANISTAN for value: AFGHANISTAN + + + + + Enum ALBANIA for value: ALBANIA + + + + + Enum ALGERIA for value: ALGERIA + + + + + Enum AMERICANSAMOA for value: AMERICAN SAMOA + + + + + Enum ANDORRA for value: ANDORRA + + + + + Enum ANGOLA for value: ANGOLA + + + + + Enum ANGUILLA for value: ANGUILLA + + + + + Enum ANTARCTICA for value: ANTARCTICA + + + + + Enum ANTIGUAANDBARBUDA for value: ANTIGUA AND BARBUDA + + + + + Enum ARGENTINA for value: ARGENTINA + + + + + Enum ARUBA for value: ARUBA + + + + + Enum AUSTRALIA for value: AUSTRALIA + + + + + Enum AUSTRIA for value: AUSTRIA + + + + + Enum AZERBAIJAN for value: AZERBAIJAN + + + + + Enum BAHRAIN for value: BAHRAIN + + + + + Enum BANGLADESH for value: BANGLADESH + + + + + Enum BARBADOS for value: BARBADOS + + + + + Enum BELARUS for value: BELARUS + + + + + Enum BELGIUM for value: BELGIUM + + + + + Enum BELIZE for value: BELIZE + + + + + Enum BENIN for value: BENIN + + + + + Enum BERMUDA for value: BERMUDA + + + + + Enum BHUTAN for value: BHUTAN + + + + + Enum BOLIVIAPLURINATIONALSTATEOF for value: BOLIVIA (PLURINATIONAL STATE OF) + + + + + Enum BONAIRESAINTEUSTATIUSANDSABA for value: BONAIRE, SAINT EUSTATIUS AND SABA + + + + + Enum BOSNIAANDHERZEGOVINA for value: BOSNIA AND HERZEGOVINA + + + + + Enum BOTSWANA for value: BOTSWANA + + + + + Enum BRAZIL for value: BRAZIL + + + + + Enum BRITISHINDIANOCEANTERRITORY for value: BRITISH INDIAN OCEAN TERRITORY + + + + + Enum BRITISHVIRGINISLANDS for value: BRITISH VIRGIN ISLANDS + + + + + Enum BRUNEIDARUSSALAM for value: BRUNEI DARUSSALAM + + + + + Enum BULGARIA for value: BULGARIA + + + + + Enum BURKINAFASO for value: BURKINA FASO + + + + + Enum BURUNDI for value: BURUNDI + + + + + Enum CABOVERDE for value: CABO VERDE + + + + + Enum CAMBODIA for value: CAMBODIA + + + + + Enum CAMEROON for value: CAMEROON + + + + + Enum CANADA for value: CANADA + + + + + Enum CAYMANISLANDS for value: CAYMAN ISLANDS + + + + + Enum CENTRALAFRICANREPUBLIC for value: CENTRAL AFRICAN REPUBLIC + + + + + Enum CHAD for value: CHAD + + + + + Enum CHILE for value: CHILE + + + + + Enum CHINA for value: CHINA + + + + + Enum COLOMBIA for value: COLOMBIA + + + + + Enum COMOROS for value: COMOROS + + + + + Enum CONGO for value: CONGO + + + + + Enum CONGODEMOCRATICREPUBLICOFTHE for value: CONGO, DEMOCRATIC REPUBLIC OF THE + + + + + Enum COOKISLANDS for value: COOK ISLANDS + + + + + Enum COSTARICA for value: COSTA RICA + + + + + Enum CTEDIVOIRE for value: CÔTE D`IVOIRE + + + + + Enum CROATIA for value: CROATIA + + + + + Enum CUBA for value: CUBA + + + + + Enum CURAAO for value: CURAÇAO + + + + + Enum CYPRUS for value: CYPRUS + + + + + Enum CZECHREPUBLIC for value: CZECH REPUBLIC + + + + + Enum DENMARK for value: DENMARK + + + + + Enum DJIBOUTI for value: DJIBOUTI + + + + + Enum DOMINICA for value: DOMINICA + + + + + Enum DOMINICANREPUBLIC for value: DOMINICAN REPUBLIC + + + + + Enum ECUADOR for value: ECUADOR + + + + + Enum EGYPT for value: EGYPT + + + + + Enum ELSALVADOR for value: EL SALVADOR + + + + + Enum EQUATORIALGUINEA for value: EQUATORIAL GUINEA + + + + + Enum ERITREA for value: ERITREA + + + + + Enum ESTONIA for value: ESTONIA + + + + + Enum ESWATINI for value: ESWATINI + + + + + Enum ETHIOPIA for value: ETHIOPIA + + + + + Enum FALKLANDISLANDSMALVINAS for value: FALKLAND ISLANDS (MALVINAS) + + + + + Enum FAROEISLANDS for value: FAROE ISLANDS + + + + + Enum FIJI for value: FIJI + + + + + Enum FINLAND for value: FINLAND + + + + + Enum FRANCE for value: FRANCE + + + + + Enum GABON for value: GABON + + + + + Enum GAMBIA for value: GAMBIA + + + + + Enum GEORGIA for value: GEORGIA + + + + + Enum GERMANY for value: GERMANY + + + + + Enum GHANA for value: GHANA + + + + + Enum GIBRALTAR for value: GIBRALTAR + + + + + Enum GREECE for value: GREECE + + + + + Enum GREENLAND for value: GREENLAND + + + + + Enum GRENADA for value: GRENADA + + + + + Enum GUATEMALA for value: GUATEMALA + + + + + Enum GUINEA for value: GUINEA + + + + + Enum GUINEABISSAU for value: GUINEA-BISSAU + + + + + Enum GUYANA for value: GUYANA + + + + + Enum HAITI for value: HAITI + + + + + Enum HOLYSEE for value: HOLY SEE + + + + + Enum HONDURAS for value: HONDURAS + + + + + Enum HONGKONG for value: HONG KONG + + + + + Enum HUNGARY for value: HUNGARY + + + + + Enum ICELAND for value: ICELAND + + + + + Enum INDIA for value: INDIA + + + + + Enum INDONESIA for value: INDONESIA + + + + + Enum IRANISLAMICREPUBLICOF for value: IRAN (ISLAMIC REPUBLIC OF) + + + + + Enum IRAQ for value: IRAQ + + + + + Enum IRELAND for value: IRELAND + + + + + Enum ISRAEL for value: ISRAEL + + + + + Enum ITALY for value: ITALY + + + + + Enum JAMAICA for value: JAMAICA + + + + + Enum JAPAN for value: JAPAN + + + + + Enum JORDAN for value: JORDAN + + + + + Enum KAZAKHSTAN for value: KAZAKHSTAN + + + + + Enum KENYA for value: KENYA + + + + + Enum KIRIBATI for value: KIRIBATI + + + + + Enum KOREADEMOCRATICPEOPLESREPUBLICOF for value: KOREA (DEMOCRATIC PEOPLE’S REPUBLIC OF) + + + + + Enum KOREAREPUBLICOF for value: KOREA, REPUBLIC OF + + + + + Enum KUWAIT for value: KUWAIT + + + + + Enum KYRGYZSTAN for value: KYRGYZSTAN + + + + + Enum LAOPEOPLESDEMOCRATICREPUBLIC for value: LAO PEOPLE’S DEMOCRATIC REPUBLIC + + + + + Enum LATVIA for value: LATVIA + + + + + Enum LEBANON for value: LEBANON + + + + + Enum LESOTHO for value: LESOTHO + + + + + Enum LIBERIA for value: LIBERIA + + + + + Enum LIBYA for value: LIBYA + + + + + Enum LIECHTENSTEIN for value: LIECHTENSTEIN + + + + + Enum LITHUANIA for value: LITHUANIA + + + + + Enum LUXEMBOURG for value: LUXEMBOURG + + + + + Enum MACAO for value: MACAO + + + + + Enum MACEDONIA for value: MACEDONIA + + + + + Enum MADAGASCAR for value: MADAGASCAR + + + + + Enum MALAWI for value: MALAWI + + + + + Enum MALAYSIA for value: MALAYSIA + + + + + Enum MALDIVES for value: MALDIVES + + + + + Enum MALI for value: MALI + + + + + Enum MALTA for value: MALTA + + + + + Enum MAURITANIA for value: MAURITANIA + + + + + Enum MAURITIUS for value: MAURITIUS + + + + + Enum MEXICO for value: MEXICO + + + + + Enum MOLDOVAREPUBLICOF for value: MOLDOVA, REPUBLIC OF + + + + + Enum MONACO for value: MONACO + + + + + Enum MONGOLIA for value: MONGOLIA + + + + + Enum MONTENEGRO for value: MONTENEGRO + + + + + Enum MONTSERRAT for value: MONTSERRAT + + + + + Enum MOROCCO for value: MOROCCO + + + + + Enum MOZAMBIQUE for value: MOZAMBIQUE + + + + + Enum MYANMAR for value: MYANMAR + + + + + Enum NAMIBIA for value: NAMIBIA + + + + + Enum NAURU for value: NAURU + + + + + Enum NEPAL for value: NEPAL + + + + + Enum NETHERLANDANTILLES for value: NETHERLAND ANTILLES + + + + + Enum NETHERLANDS for value: NETHERLANDS + + + + + Enum NEWZEALAND for value: NEW ZEALAND + + + + + Enum NICARAGUA for value: NICARAGUA + + + + + Enum NIGER for value: NIGER + + + + + Enum NIGERIA for value: NIGERIA + + + + + Enum NIUE for value: NIUE + + + + + Enum NORFOLKISLAND for value: NORFOLK ISLAND + + + + + Enum NORWAY for value: NORWAY + + + + + Enum OMAN for value: OMAN + + + + + Enum PAKISTAN for value: PAKISTAN + + + + + Enum PANAMA for value: PANAMA + + + + + Enum PAPUANEWGUINEA for value: PAPUA NEW GUINEA + + + + + Enum PARAGUAY for value: PARAGUAY + + + + + Enum PERU for value: PERU + + + + + Enum PHILIPPINES for value: PHILIPPINES + + + + + Enum PITCAIRN for value: PITCAIRN + + + + + Enum POLAND for value: POLAND + + + + + Enum PORTUGAL for value: PORTUGAL + + + + + Enum QATAR for value: QATAR + + + + + Enum ROMANIA for value: ROMANIA + + + + + Enum RUSSIANFEDERATION for value: RUSSIAN FEDERATION + + + + + Enum RWANDA for value: RWANDA + + + + + Enum SAINTHELENA for value: SAINT HELENA + + + + + Enum SAINTKITTSANDNEVIS for value: SAINT KITTS AND NEVIS + + + + + Enum SAINTLUCIA for value: SAINT LUCIA + + + + + Enum SAINTVINCENTANDTHEGRENADINES for value: SAINT VINCENT AND THE GRENADINES + + + + + Enum SAMOA for value: SAMOA + + + + + Enum SANMARINO for value: SAN MARINO + + + + + Enum SAOTOMEANDPRINCIPE for value: SAO TOME AND PRINCIPE + + + + + Enum SAUDIARABIA for value: SAUDI ARABIA + + + + + Enum SENEGAL for value: SENEGAL + + + + + Enum SERBIA for value: SERBIA + + + + + Enum SEYCHELLES for value: SEYCHELLES + + + + + Enum SIERRALEONE for value: SIERRA LEONE + + + + + Enum SINGAPORE for value: SINGAPORE + + + + + Enum SINTMAARTEN for value: SINT MAARTEN + + + + + Enum SLOVAKIA for value: SLOVAKIA + + + + + Enum SLOVENIA for value: SLOVENIA + + + + + Enum SOLOMONISLANDS for value: SOLOMON ISLANDS + + + + + Enum SOMALIA for value: SOMALIA + + + + + Enum SOUTHAFRICA for value: SOUTH AFRICA + + + + + Enum SOUTHGEORGIAANDTHESOUTHSANDWICHISLANDS for value: SOUTH GEORGIA AND THE SOUTH SANDWICH ISLANDS + + + + + Enum SOUTHSUDAN for value: SOUTH SUDAN + + + + + Enum SPAIN for value: SPAIN + + + + + Enum SRILANKA for value: SRI LANKA + + + + + Enum SUDAN for value: SUDAN + + + + + Enum SURINAME for value: SURINAME + + + + + Enum SWEDEN for value: SWEDEN + + + + + Enum SWITZERLAND for value: SWITZERLAND + + + + + Enum SYRIANARABREPUBLIC for value: SYRIAN ARAB REPUBLIC + + + + + Enum TAIWAN for value: TAIWAN + + + + + Enum TAJIKISTAN for value: TAJIKISTAN + + + + + Enum TANZANIA for value: TANZANIA + + + + + Enum THAILAND for value: THAILAND + + + + + Enum THEBAHAMAS for value: THE BAHAMAS + + + + + Enum TIMORLESTE for value: TIMOR-LESTE + + + + + Enum TOGO for value: TOGO + + + + + Enum TOKELAU for value: TOKELAU + + + + + Enum TONGA for value: TONGA + + + + + Enum TRINIDADANDTOBAGO for value: TRINIDAD AND TOBAGO + + + + + Enum TUNISIA for value: TUNISIA + + + + + Enum TURKEY for value: TURKEY + + + + + Enum TURKMENISTAN for value: TURKMENISTAN + + + + + Enum TURKSANDCAICOSISLANDS for value: TURKS AND CAICOS ISLANDS + + + + + Enum TUVALU for value: TUVALU + + + + + Enum UGANDA for value: UGANDA + + + + + Enum UKRAINE for value: UKRAINE + + + + + Enum UNITEDARABEMIRATES for value: UNITED ARAB EMIRATES + + + + + Enum UNITEDKINGDOM for value: UNITED KINGDOM + + + + + Enum UNITEDSTATES for value: UNITED STATES + + + + + Enum URUGUAY for value: URUGUAY + + + + + Enum UZBEKISTAN for value: UZBEKISTAN + + + + + Enum VANUATU for value: VANUATU + + + + + Enum VENEZUELA for value: VENEZUELA + + + + + Enum VIETNAM for value: VIET NAM + + + + + Enum WESTERNSAHARA for value: WESTERN SAHARA + + + + + Enum YEMEN for value: YEMEN + + + + + Enum ZAMBIA for value: ZAMBIA + + + + + Enum ZIMBABWE for value: ZIMBABWE + + + + + A nested custom envelope object containing more information about the custom envelope used or `null` if a custom envelope was not used. + + + + + Defines Object + + + + + Enum Envelope for value: envelope + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The unique identifier of the custom envelope used. (required). + The url of the envelope asset used. (required). + _object (required) (default to ObjectEnum.Envelope). + + + + The unique identifier of the custom envelope used. + + The unique identifier of the custom envelope used. + + + + The url of the envelope asset used. + + The url of the envelope asset used. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CustomEnvelopeReturned instances are equal + + Instance of CustomEnvelopeReturned to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A nested object containing a breakdown of the deliverability of an address. + + + + + 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. + + 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. + + + + Enum Y for value: Y + + + + + Enum S for value: S + + + + + Enum D for value: D + + + + + Enum N for value: N + + + + + Enum Empty for value: + + + + + 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. + + 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. + + + + 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). + + 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). + + + + Enum Y for value: Y + + + + + Enum N for value: N + + + + + Enum Empty for value: + + + + + 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). + + 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). + + + + 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). + + 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). + + + + Enum Y for value: Y + + + + + Enum N for value: N + + + + + Enum Empty for value: + + + + + 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). + + 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). + + + + 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). + + 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). + + + + Enum Y for value: Y + + + + + Enum N for value: N + + + + + Enum Empty for value: + + + + + 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). + + 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). + + + + 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). + + 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). + + + + Enum Y for value: Y + + + + + Enum N for value: N + + + + + Enum Empty for value: + + + + + 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). + + 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). + + + + A return code that indicates whether the address was matched and corrected by [Suite<sup>Link</sup>](https://postalpro.usps.com/address-quality-solutions/suitelink). Suite<sup>Link</sup> attempts to provide secondary information to business addresses. Possible values are: * `A` –– A Suite<sup>Link</sup> match was found and secondary information was added. * `00` –– A Suite<sup>Link</sup> match could not be found and no secondary information was added. * `''` –– Suite<sup>Link</sup> lookup was not attempted. + + A return code that indicates whether the address was matched and corrected by [Suite<sup>Link</sup>](https://postalpro.usps.com/address-quality-solutions/suitelink). Suite<sup>Link</sup> attempts to provide secondary information to business addresses. Possible values are: * `A` –– A Suite<sup>Link</sup> match was found and secondary information was added. * `00` –– A Suite<sup>Link</sup> match could not be found and no secondary information was added. * `''` –– Suite<sup>Link</sup> lookup was not attempted. + + + + Enum A for value: A + + + + + Enum _00 for value: 00 + + + + + Enum Empty for value: + + + + + A return code that indicates whether the address was matched and corrected by [Suite<sup>Link</sup>](https://postalpro.usps.com/address-quality-solutions/suitelink). Suite<sup>Link</sup> attempts to provide secondary information to business addresses. Possible values are: * `A` –– A Suite<sup>Link</sup> match was found and secondary information was added. * `00` –– A Suite<sup>Link</sup> match could not be found and no secondary information was added. * `''` –– Suite<sup>Link</sup> lookup was not attempted. + + A return code that indicates whether the address was matched and corrected by [Suite<sup>Link</sup>](https://postalpro.usps.com/address-quality-solutions/suitelink). Suite<sup>Link</sup> attempts to provide secondary information to business addresses. Possible values are: * `A` –– A Suite<sup>Link</sup> match was found and secondary information was added. * `00` –– A Suite<sup>Link</sup> match could not be found and no secondary information was added. * `''` –– Suite<sup>Link</sup> lookup was not attempted. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + 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. (required). + 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). (required). + 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). (required). + 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). (required). + 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). (required). + 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. (required). + 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). (required). + A code indicating how `deliverability_analysis[lacs_indicator]` was determined. Possible values are: * `A` — A new address was produced because a match was found in LACS<sup>Link</sup>. * `92` — A LACS<sup>Link</sup> record was matched after dropping secondary information. * `14` — A match was found in LACS<sup>Link</sup>, but could not be converted to a deliverable address. * `00` — A match was not found in LACS<sup>Link</sup>, and no new address was produced. * `''` — LACS<sup>Link</sup> was not attempted. (required). + A return code that indicates whether the address was matched and corrected by [Suite<sup>Link</sup>](https://postalpro.usps.com/address-quality-solutions/suitelink). Suite<sup>Link</sup> attempts to provide secondary information to business addresses. Possible values are: * `A` –– A Suite<sup>Link</sup> match was found and secondary information was added. * `00` –– A Suite<sup>Link</sup> match could not be found and no secondary information was added. * `''` –– Suite<sup>Link</sup> lookup was not attempted. (required). + + + + 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). + + 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). + + + + 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. + + 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. + + + + A code indicating how `deliverability_analysis[lacs_indicator]` was determined. Possible values are: * `A` — A new address was produced because a match was found in LACS<sup>Link</sup>. * `92` — A LACS<sup>Link</sup> record was matched after dropping secondary information. * `14` — A match was found in LACS<sup>Link</sup>, but could not be converted to a deliverable address. * `00` — A match was not found in LACS<sup>Link</sup>, and no new address was produced. * `''` — LACS<sup>Link</sup> was not attempted. + + A code indicating how `deliverability_analysis[lacs_indicator]` was determined. Possible values are: * `A` — A new address was produced because a match was found in LACS<sup>Link</sup>. * `92` — A LACS<sup>Link</sup> record was matched after dropping secondary information. * `14` — A match was found in LACS<sup>Link</sup>, but could not be converted to a deliverable address. * `00` — A match was not found in LACS<sup>Link</sup>, and no new address was produced. * `''` — LACS<sup>Link</sup> was not attempted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if DeliverabilityAnalysis instances are equal + + Instance of DeliverabilityAnalysis to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines dpv_footnote + + + + + Enum AA for value: AA + + + + + Enum A1 for value: A1 + + + + + Enum BB for value: BB + + + + + Enum CC for value: CC + + + + + Enum N1 for value: N1 + + + + + Enum F1 for value: F1 + + + + + Enum G1 for value: G1 + + + + + Enum U1 for value: U1 + + + + + Enum M1 for value: M1 + + + + + Enum M3 for value: M3 + + + + + Enum P1 for value: P1 + + + + + Enum P3 for value: P3 + + + + + Enum R1 for value: R1 + + + + + Enum R7 for value: R7 + + + + + Enum RR for value: RR + + + + + The engine used to combine HTML template with merge variables. * `legacy` - Lob's original engine * `handlebars` + + The engine used to combine HTML template with merge variables. * `legacy` - Lob's original engine * `handlebars` + + + + Enum Legacy for value: legacy + + + + + Enum Handlebars for value: handlebars + + + + + Events + + + + + Value is resource type. + + Value is resource type. + + + + Enum Event for value: event + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `evt_`. (required). + The body of the associated resource as they were at the time of the event, i.e. the [postcard object](https://docs.lob.com/#tag/Postcards/operation/postcard_retrieve), [the letter object](https://docs.lob.com/#tag/Letters/operation/letter_retrieve), [the check object](https://docs.lob.com/#tag/Checks/operation/check_retrieve), [the address object](https://docs.lob.com/#tag/Addresses/operation/address_retrieve), or [the bank account object](https://docs.lob.com/#tag/Bank-Accounts/operation/bank_account_retrieve). For `.deleted` events, the body matches the response for the corresponding delete endpoint for that resource (e.g. the [postcard cancel response](https://docs.lob.com/#tag/Postcards/operation/postcard_delete)). (required). + Unique identifier of the related resource for the event. (required). + eventType (required). + A timestamp in ISO 8601 format of the date the resource was created. (required). + Value is resource type. (required) (default to ObjectEnum.Event). + + + + Unique identifier prefixed with `evt_`. + + Unique identifier prefixed with `evt_`. + + + + The body of the associated resource as they were at the time of the event, i.e. the [postcard object](https://docs.lob.com/#tag/Postcards/operation/postcard_retrieve), [the letter object](https://docs.lob.com/#tag/Letters/operation/letter_retrieve), [the check object](https://docs.lob.com/#tag/Checks/operation/check_retrieve), [the address object](https://docs.lob.com/#tag/Addresses/operation/address_retrieve), or [the bank account object](https://docs.lob.com/#tag/Bank-Accounts/operation/bank_account_retrieve). For `.deleted` events, the body matches the response for the corresponding delete endpoint for that resource (e.g. the [postcard cancel response](https://docs.lob.com/#tag/Postcards/operation/postcard_delete)). + + The body of the associated resource as they were at the time of the event, i.e. the [postcard object](https://docs.lob.com/#tag/Postcards/operation/postcard_retrieve), [the letter object](https://docs.lob.com/#tag/Letters/operation/letter_retrieve), [the check object](https://docs.lob.com/#tag/Checks/operation/check_retrieve), [the address object](https://docs.lob.com/#tag/Addresses/operation/address_retrieve), or [the bank account object](https://docs.lob.com/#tag/Bank-Accounts/operation/bank_account_retrieve). For `.deleted` events, the body matches the response for the corresponding delete endpoint for that resource (e.g. the [postcard cancel response](https://docs.lob.com/#tag/Postcards/operation/postcard_delete)). + + + + Unique identifier of the related resource for the event. + + Unique identifier of the related resource for the event. + + + + Gets or Sets EventType + + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Events instances are equal + + Instance of Events to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + EventType + + + + + Defines Resource + + + + + Enum Postcards for value: postcards + + + + + Enum SelfMailers for value: self mailers + + + + + Enum Letters for value: letters + + + + + Enum Checks for value: checks + + + + + Enum Addresses for value: addresses + + + + + Enum BankAccounts for value: bank accounts + + + + + Gets or Sets Resource + + + + + Value is resource type. + + Value is resource type. + + + + Enum EventType for value: event_type + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + Value is `true` if the event type is enabled in both the test and live environments. (required). + resource (required). + Value is resource type. (required) (default to ObjectEnum.EventType). + + + + Gets or Sets Id + + + + + Value is `true` if the event type is enabled in both the test and live environments. + + Value is `true` if the event type is enabled in both the test and live environments. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if EventType instances are equal + + Instance of EventType to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ExportModel + + + + + Defines Type + + + + + Enum All for value: all + + + + + Enum Failures for value: failures + + + + + Enum Successes for value: successes + + + + + Gets or Sets Type + + + + + Initializes a new instance of the class. + + type. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ExportModel instances are equal + + Instance of ExportModel to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + GeocodeAddresses + + + + + Initializes a new instance of the class. + + components. + locationAnalysis. + + + + Gets or Sets Components + + + + + Gets or Sets LocationAnalysis + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if GeocodeAddresses instances are equal + + Instance of GeocodeAddresses to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A nested object containing a breakdown of each component of a reverse geocoded response. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The 5-digit ZIP code (required). + zipCodePlus4 (required). + + + + The 5-digit ZIP code + + The 5-digit ZIP code + + + + Gets or Sets ZipCodePlus4 + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if GeocodeComponents instances are equal + + Instance of GeocodeComponents to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + IdentityValidation + + + + + Indicates the likelihood the recipient name and address match based on our custom internal calculation. Possible values are: - `high` — Has a Lob confidence score greater than 70. - `medium` — Has a Lob confidence score between 40 and 70. - `low` — Has a Lob confidence score less than 40. - `\"\"` — No tracking data exists for this address. + + Indicates the likelihood the recipient name and address match based on our custom internal calculation. Possible values are: - `high` — Has a Lob confidence score greater than 70. - `medium` — Has a Lob confidence score between 40 and 70. - `low` — Has a Lob confidence score less than 40. - `\"\"` — No tracking data exists for this address. + + + + Enum High for value: high + + + + + Enum Medium for value: medium + + + + + Enum Low for value: low + + + + + Enum Empty for value: + + + + + Indicates the likelihood the recipient name and address match based on our custom internal calculation. Possible values are: - `high` — Has a Lob confidence score greater than 70. - `medium` — Has a Lob confidence score between 40 and 70. - `low` — Has a Lob confidence score less than 40. - `\"\"` — No tracking data exists for this address. + + Indicates the likelihood the recipient name and address match based on our custom internal calculation. Possible values are: - `high` — Has a Lob confidence score greater than 70. - `medium` — Has a Lob confidence score between 40 and 70. - `low` — Has a Lob confidence score less than 40. - `\"\"` — No tracking data exists for this address. + + + + Value is resource type. + + Value is resource type. + + + + Enum IdValidation for value: id_validation + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `id_validation_`.. + 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. . + 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. . + Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) . + A numerical score between 0 and 100 that represents the likelihood the provided name is associated with a physical address. . + Indicates the likelihood the recipient name and address match based on our custom internal calculation. Possible values are: - `high` — Has a Lob confidence score greater than 70. - `medium` — Has a Lob confidence score between 40 and 70. - `low` — Has a Lob confidence score less than 40. - `\"\"` — No tracking data exists for this address. . + Value is resource type. (default to ObjectEnum.IdValidation). + + + + Unique identifier prefixed with `id_validation_`. + + Unique identifier prefixed with `id_validation_`. + + + + The intended recipient, typically a person's or firm's name. + + 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 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. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + 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. + + 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. + + + + Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) + + Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) + + + + A numerical score between 0 and 100 that represents the likelihood the provided name is associated with a physical address. + + A numerical score between 0 and 100 that represents the likelihood the provided name is associated with a physical address. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IdentityValidation instances are equal + + Instance of IdentityValidation to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + IntlAutocompletions + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `intl_auto_`.. + An array of objects representing suggested addresses. . + + + + Unique identifier prefixed with `intl_auto_`. + + Unique identifier prefixed with `intl_auto_`. + + + + An array of objects representing suggested addresses. + + An array of objects representing suggested addresses. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IntlAutocompletions instances are equal + + Instance of IntlAutocompletions to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + IntlAutocompletionsWritable + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Only accepts numbers and street names in an alphanumeric format. (required). + An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations. . + An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations. . + An optional Zip Code input used to filter suggestions. Matches partial entries. . + country (required). + + + + Only accepts numbers and street names in an alphanumeric format. + + Only accepts numbers and street names in an alphanumeric format. + + + + An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations. + + An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations. + + + + An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations. + + An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations. + + + + An optional Zip Code input used to filter suggestions. Matches partial entries. + + An optional Zip Code input used to filter suggestions. Matches partial entries. + + + + Gets or Sets Country + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IntlAutocompletionsWritable instances are equal + + Instance of IntlAutocompletionsWritable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A nested object containing a breakdown of each component of an address. + + + + + Initializes a new instance of the class. + + The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number.. + The name of the street.. + city. + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. . + The postal code.. + + + + The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number. + + The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number. + + + + The name of the street. + + The name of the street. + + + + Gets or Sets City + + + + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + + + The postal code. + + The postal code. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IntlComponents instances are equal + + Instance of IntlComponents to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + IntlSuggestions + + + + + Value is resource type. + + Value is resource type. + + + + Enum IntlAutocompletion for value: intl_autocompletion + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The primary number range of the address that identifies a building at street level. (required). + The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` (required). + city (required). + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. (required). + country (required). + A 5-digit zip code. Left empty if a test key is used. (required). + Value is resource type. (default to ObjectEnum.IntlAutocompletion). + + + + The primary number range of the address that identifies a building at street level. + + The primary number range of the address that identifies a building at street level. + + + + The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` + + The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` + + + + Gets or Sets City + + + + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + + + Gets or Sets Country + + + + + A 5-digit zip code. Left empty if a test key is used. + + A 5-digit zip code. Left empty if a test key is used. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IntlSuggestions instances are equal + + Instance of IntlSuggestions to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + IntlVerification + + + + + The coverage level for the country. This represents the maximum level of accuracy an input address can be verified to. * `SUBBUILDING` - Coverage down to unit numbers. For example, in an apartment or a large building * `HOUSENUMBER/BUILDING` - Coverage down to house number. For example, the address where a house or building may be located * `STREET` - Coverage down to street. This means that we can verify that an street exists in a city, state, country * `LOCALITY` - Coverage down to city, state, or village or province. This means that we can verify that a city, village, province, or state exists in a country. Countries differ in how they define what is a province, state, city, village, etc. This attempts to group eveyrthing together. * `SPARSE` - Some addresses for this country exist in our databases + + The coverage level for the country. This represents the maximum level of accuracy an input address can be verified to. * `SUBBUILDING` - Coverage down to unit numbers. For example, in an apartment or a large building * `HOUSENUMBER/BUILDING` - Coverage down to house number. For example, the address where a house or building may be located * `STREET` - Coverage down to street. This means that we can verify that an street exists in a city, state, country * `LOCALITY` - Coverage down to city, state, or village or province. This means that we can verify that a city, village, province, or state exists in a country. Countries differ in how they define what is a province, state, city, village, etc. This attempts to group eveyrthing together. * `SPARSE` - Some addresses for this country exist in our databases + + + + Enum SUBBUILDING for value: SUBBUILDING + + + + + Enum HOUSENUMBERBUILDING for value: HOUSENUMBER/BUILDING + + + + + Enum STREET for value: STREET + + + + + Enum LOCALITY for value: LOCALITY + + + + + Enum SPARSE for value: SPARSE + + + + + The coverage level for the country. This represents the maximum level of accuracy an input address can be verified to. * `SUBBUILDING` - Coverage down to unit numbers. For example, in an apartment or a large building * `HOUSENUMBER/BUILDING` - Coverage down to house number. For example, the address where a house or building may be located * `STREET` - Coverage down to street. This means that we can verify that an street exists in a city, state, country * `LOCALITY` - Coverage down to city, state, or village or province. This means that we can verify that a city, village, province, or state exists in a country. Countries differ in how they define what is a province, state, city, village, etc. This attempts to group eveyrthing together. * `SPARSE` - Some addresses for this country exist in our databases + + The coverage level for the country. This represents the maximum level of accuracy an input address can be verified to. * `SUBBUILDING` - Coverage down to unit numbers. For example, in an apartment or a large building * `HOUSENUMBER/BUILDING` - Coverage down to house number. For example, the address where a house or building may be located * `STREET` - Coverage down to street. This means that we can verify that an street exists in a city, state, country * `LOCALITY` - Coverage down to city, state, or village or province. This means that we can verify that a city, village, province, or state exists in a country. Countries differ in how they define what is a province, state, city, village, etc. This attempts to group eveyrthing together. * `SPARSE` - Some addresses for this country exist in our databases + + + + Summarizes the deliverability of the `intl_verification` object. Possible values are: * `deliverable` — The address is deliverable. * `deliverable_missing_info` — The address is missing some information, but is most likely deliverable. * `undeliverable` — The address is most likely not deliverable. Some components of the address (such as city or postal code) may have been found. * `no_match` — This address is not deliverable. No matching street could be found within the city or postal code. + + Summarizes the deliverability of the `intl_verification` object. Possible values are: * `deliverable` — The address is deliverable. * `deliverable_missing_info` — The address is missing some information, but is most likely deliverable. * `undeliverable` — The address is most likely not deliverable. Some components of the address (such as city or postal code) may have been found. * `no_match` — This address is not deliverable. No matching street could be found within the city or postal code. + + + + Enum Deliverable for value: deliverable + + + + + Enum DeliverableMissingInfo for value: deliverable_missing_info + + + + + Enum Undeliverable for value: undeliverable + + + + + Enum NoMatch for value: no_match + + + + + Summarizes the deliverability of the `intl_verification` object. Possible values are: * `deliverable` — The address is deliverable. * `deliverable_missing_info` — The address is missing some information, but is most likely deliverable. * `undeliverable` — The address is most likely not deliverable. Some components of the address (such as city or postal code) may have been found. * `no_match` — This address is not deliverable. No matching street could be found within the city or postal code. + + Summarizes the deliverability of the `intl_verification` object. Possible values are: * `deliverable` — The address is deliverable. * `deliverable_missing_info` — The address is missing some information, but is most likely deliverable. * `undeliverable` — The address is most likely not deliverable. Some components of the address (such as city or postal code) may have been found. * `no_match` — This address is not deliverable. No matching street could be found within the city or postal code. + + + + The status level for the country. This represents the maximum level of accuracy an input address can be verified to. * `LV4` - Verified. The input data is correct. All input data was able to match in databases. * `LV3` - Verified. The input data is correct. All input data was able to match in databases <em>after</em> some or all elements were standarized. The input data may also be using outdated city, state, or country names. * `LV2` - Verified. The input data is correct although some input data is unverifiable due to incomplete data. * `LV1` - Verified. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LF4` - Fixed. The input data is matched and fixed. (Example: Brighon, UK -> Brighton, UK) * `LF3` - Fixed. The input data is matched and fixed but some elements such as Subbuilding number and house number cannot be checked. * `LF2` - Fixed. The input data is matched but some elements such as Street cannot be checked. * `LF1` - Fixed. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LM4` - Missing Info. The input data cannot be corrected completely. * `LM3` - Missing Info. The input data cannot be corrected completely and there were multiple matches found in databases. * `LM2` - Missing Info. The input data cannot be corrected completely and only some elements were found. * `LU1` - Unverified. The input data cannot be corrected or matched. + + The status level for the country. This represents the maximum level of accuracy an input address can be verified to. * `LV4` - Verified. The input data is correct. All input data was able to match in databases. * `LV3` - Verified. The input data is correct. All input data was able to match in databases <em>after</em> some or all elements were standarized. The input data may also be using outdated city, state, or country names. * `LV2` - Verified. The input data is correct although some input data is unverifiable due to incomplete data. * `LV1` - Verified. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LF4` - Fixed. The input data is matched and fixed. (Example: Brighon, UK -> Brighton, UK) * `LF3` - Fixed. The input data is matched and fixed but some elements such as Subbuilding number and house number cannot be checked. * `LF2` - Fixed. The input data is matched but some elements such as Street cannot be checked. * `LF1` - Fixed. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LM4` - Missing Info. The input data cannot be corrected completely. * `LM3` - Missing Info. The input data cannot be corrected completely and there were multiple matches found in databases. * `LM2` - Missing Info. The input data cannot be corrected completely and only some elements were found. * `LU1` - Unverified. The input data cannot be corrected or matched. + + + + Enum LV4 for value: LV4 + + + + + Enum LV3 for value: LV3 + + + + + Enum LV2 for value: LV2 + + + + + Enum LV1 for value: LV1 + + + + + Enum LF4 for value: LF4 + + + + + Enum LF3 for value: LF3 + + + + + Enum LF2 for value: LF2 + + + + + Enum LF1 for value: LF1 + + + + + Enum LM4 for value: LM4 + + + + + Enum LM3 for value: LM3 + + + + + Enum LM2 for value: LM2 + + + + + Enum LU1 for value: LU1 + + + + + The status level for the country. This represents the maximum level of accuracy an input address can be verified to. * `LV4` - Verified. The input data is correct. All input data was able to match in databases. * `LV3` - Verified. The input data is correct. All input data was able to match in databases <em>after</em> some or all elements were standarized. The input data may also be using outdated city, state, or country names. * `LV2` - Verified. The input data is correct although some input data is unverifiable due to incomplete data. * `LV1` - Verified. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LF4` - Fixed. The input data is matched and fixed. (Example: Brighon, UK -> Brighton, UK) * `LF3` - Fixed. The input data is matched and fixed but some elements such as Subbuilding number and house number cannot be checked. * `LF2` - Fixed. The input data is matched but some elements such as Street cannot be checked. * `LF1` - Fixed. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LM4` - Missing Info. The input data cannot be corrected completely. * `LM3` - Missing Info. The input data cannot be corrected completely and there were multiple matches found in databases. * `LM2` - Missing Info. The input data cannot be corrected completely and only some elements were found. * `LU1` - Unverified. The input data cannot be corrected or matched. + + The status level for the country. This represents the maximum level of accuracy an input address can be verified to. * `LV4` - Verified. The input data is correct. All input data was able to match in databases. * `LV3` - Verified. The input data is correct. All input data was able to match in databases <em>after</em> some or all elements were standarized. The input data may also be using outdated city, state, or country names. * `LV2` - Verified. The input data is correct although some input data is unverifiable due to incomplete data. * `LV1` - Verified. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LF4` - Fixed. The input data is matched and fixed. (Example: Brighon, UK -> Brighton, UK) * `LF3` - Fixed. The input data is matched and fixed but some elements such as Subbuilding number and house number cannot be checked. * `LF2` - Fixed. The input data is matched but some elements such as Street cannot be checked. * `LF1` - Fixed. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LM4` - Missing Info. The input data cannot be corrected completely. * `LM3` - Missing Info. The input data cannot be corrected completely and there were multiple matches found in databases. * `LM2` - Missing Info. The input data cannot be corrected completely and only some elements were found. * `LU1` - Unverified. The input data cannot be corrected or matched. + + + + Value is resource type. + + Value is resource type. + + + + Enum IntlVerification for value: intl_verification + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `intl_ver_`.. + The intended recipient, typically a person's or firm's name.. + The primary delivery line (usually the street address) of the address. . + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. . + Combination of the following applicable `components`: * `city` * `state` * `zip_code` * `zip_code_plus_4` . + The country of the address. Will be returned as a 2 letter country short-name code (ISO 3166).. + The coverage level for the country. This represents the maximum level of accuracy an input address can be verified to. * `SUBBUILDING` - Coverage down to unit numbers. For example, in an apartment or a large building * `HOUSENUMBER/BUILDING` - Coverage down to house number. For example, the address where a house or building may be located * `STREET` - Coverage down to street. This means that we can verify that an street exists in a city, state, country * `LOCALITY` - Coverage down to city, state, or village or province. This means that we can verify that a city, village, province, or state exists in a country. Countries differ in how they define what is a province, state, city, village, etc. This attempts to group eveyrthing together. * `SPARSE` - Some addresses for this country exist in our databases . + Summarizes the deliverability of the `intl_verification` object. Possible values are: * `deliverable` — The address is deliverable. * `deliverable_missing_info` — The address is missing some information, but is most likely deliverable. * `undeliverable` — The address is most likely not deliverable. Some components of the address (such as city or postal code) may have been found. * `no_match` — This address is not deliverable. No matching street could be found within the city or postal code. . + The status level for the country. This represents the maximum level of accuracy an input address can be verified to. * `LV4` - Verified. The input data is correct. All input data was able to match in databases. * `LV3` - Verified. The input data is correct. All input data was able to match in databases <em>after</em> some or all elements were standarized. The input data may also be using outdated city, state, or country names. * `LV2` - Verified. The input data is correct although some input data is unverifiable due to incomplete data. * `LV1` - Verified. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LF4` - Fixed. The input data is matched and fixed. (Example: Brighon, UK -> Brighton, UK) * `LF3` - Fixed. The input data is matched and fixed but some elements such as Subbuilding number and house number cannot be checked. * `LF2` - Fixed. The input data is matched but some elements such as Street cannot be checked. * `LF1` - Fixed. The input data is acceptable but in an attempt to standarize user input, errors were introduced. * `LM4` - Missing Info. The input data cannot be corrected completely. * `LM3` - Missing Info. The input data cannot be corrected completely and there were multiple matches found in databases. * `LM2` - Missing Info. The input data cannot be corrected completely and only some elements were found. * `LU1` - Unverified. The input data cannot be corrected or matched. . + components. + Value is resource type. (default to ObjectEnum.IntlVerification). + + + + Unique identifier prefixed with `intl_ver_`. + + Unique identifier prefixed with `intl_ver_`. + + + + The intended recipient, typically a person's or firm's name. + + The intended recipient, typically a person's or firm's name. + + + + The primary delivery line (usually the street address) of the address. + + The primary delivery line (usually the street address) of the address. + + + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + Combination of the following applicable `components`: * `city` * `state` * `zip_code` * `zip_code_plus_4` + + Combination of the following applicable `components`: * `city` * `state` * `zip_code` * `zip_code_plus_4` + + + + The country of the address. Will be returned as a 2 letter country short-name code (ISO 3166). + + The country of the address. Will be returned as a 2 letter country short-name code (ISO 3166). + + + + Gets or Sets Components + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IntlVerification instances are equal + + Instance of IntlVerification to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A model used to represent an entry in a result list where the entry can either be a intl_verification or an Error. The SDK will perform necessary casting into the correct corresponding type. + + + + + Defines Coverage + + + + + Enum SUBBUILDING for value: SUBBUILDING + + + + + Enum HOUSENUMBERBUILDING for value: HOUSENUMBER/BUILDING + + + + + Enum STREET for value: STREET + + + + + Enum LOCALITY for value: LOCALITY + + + + + Enum SPARSE for value: SPARSE + + + + + Gets or Sets Coverage + + + + + Defines Deliverability + + + + + Enum Deliverable for value: deliverable + + + + + Enum DeliverableMissingInfo for value: deliverable_missing_info + + + + + Enum Undeliverable for value: undeliverable + + + + + Enum NoMatch for value: no_match + + + + + Gets or Sets Deliverability + + + + + Defines Status + + + + + Enum LV4 for value: LV4 + + + + + Enum LV3 for value: LV3 + + + + + Enum LV2 for value: LV2 + + + + + Enum LV1 for value: LV1 + + + + + Enum LF4 for value: LF4 + + + + + Enum LF3 for value: LF3 + + + + + Enum LF2 for value: LF2 + + + + + Enum LF1 for value: LF1 + + + + + Enum LM4 for value: LM4 + + + + + Enum LM3 for value: LM3 + + + + + Enum LM2 for value: LM2 + + + + + Enum LU1 for value: LU1 + + + + + Gets or Sets Status + + + + + Defines Object + + + + + Enum IntlVerification for value: intl_verification + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `intl_ver_`.. + The intended recipient, typically a person's or firm's name.. + primaryLine. + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. . + lastLine. + country. + coverage. + deliverability. + status. + components. + _object (default to ObjectEnum.IntlVerification). + error. + + + + Unique identifier prefixed with `intl_ver_`. + + Unique identifier prefixed with `intl_ver_`. + + + + The intended recipient, typically a person's or firm's name. + + The intended recipient, typically a person's or firm's name. + + + + Gets or Sets PrimaryLine + + + + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + Gets or Sets LastLine + + + + + Gets or Sets Country + + + + + Gets or Sets Components + + + + + Gets or Sets Error + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IntlVerificationOrError instances are equal + + Instance of IntlVerificationOrError to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + IntlVerifications + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + addresses (required). + Indicates whether any errors occurred during the verification process. (required). + + + + Gets or Sets Addresses + + + + + Indicates whether any errors occurred during the verification process. + + Indicates whether any errors occurred during the verification process. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IntlVerifications instances are equal + + Instance of IntlVerifications to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + IntlVerificationsPayload + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + addresses (required). + + + + Gets or Sets Addresses + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IntlVerificationsPayload instances are equal + + Instance of IntlVerificationsPayload to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + IntlVerificationWritable + + + + + Initializes a new instance of the class. + + The intended recipient, typically a person's or firm's name.. + The primary delivery line (usually the street address) of the address. . + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. . + city. + The name of the state.. + The postal code.. + country. + The entire address in one string (e.g., \"370 Water St C1N 1C4\"). . + + + + The intended recipient, typically a person's or firm's name. + + The intended recipient, typically a person's or firm's name. + + + + The primary delivery line (usually the street address) of the address. + + The primary delivery line (usually the street address) of the address. + + + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + Gets or Sets City + + + + + The name of the state. + + The name of the state. + + + + The postal code. + + The postal code. + + + + Gets or Sets Country + + + + + The entire address in one string (e.g., \"370 Water St C1N 1C4\"). + + The entire address in one string (e.g., \"370 Water St C1N 1C4\"). + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if IntlVerificationWritable instances are equal + + Instance of IntlVerificationWritable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Letter + + + + + Defines Carrier + + + + + Enum USPS for value: USPS + + + + + Gets or Sets Carrier + + + + + Defines Object + + + + + Enum Letter for value: letter + + + + + Gets or Sets Object + + + + + Specifies the location of the address information that will show through the double-window envelope. + + Specifies the location of the address information that will show through the double-window envelope. + + + + Enum TopFirstPage for value: top_first_page + + + + + Enum InsertBlankPage for value: insert_blank_page + + + + + Enum BottomFirstPageCenter for value: bottom_first_page_center + + + + + Enum BottomFirstPage for value: bottom_first_page + + + + + Specifies the location of the address information that will show through the double-window envelope. + + Specifies the location of the address information that will show through the double-window envelope. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + to (required). + from (required). + carrier (default to CarrierEnum.USPS). + thumbnails. + A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`.. + A timestamp in ISO 8601 format of the date the resource was created. (required). + A timestamp in ISO 8601 format of the date the resource was last modified. (required). + Only returned if the resource has been successfully deleted.. + Unique identifier prefixed with `ltr_`. (required). + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).. + Unique identifier prefixed with `vrsn_`.. + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.. + _object (required) (default to ObjectEnum.Letter). + An internal description that identifies this resource. Must be no longer than 255 characters. . + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.. + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. + Add an extra service to your letter. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred.. + The tracking number, if applicable, will appear here when it becomes available. Dummy tracking numbers are not created in test mode.. + Tracking events are not populated for registered or regular (no extra service) letters.. + Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelope tracking beta, and has `return_envelope`, and `perforated_page` fields populated in the API request.. + mailType. + Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white.. + Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. (default to true). + Specifies the location of the address information that will show through the double-window envelope. (default to AddressPlacementEnum.TopFirstPage). + returnEnvelope (required). + Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf).. + customEnvelope. + The unique ID of the associated campaign if the resource was generated from a campaign.. + useType (required). + + + + Gets or Sets To + + + + + Gets or Sets From + + + + + Gets or Sets Thumbnails + + + + + A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. + + A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Unique identifier prefixed with `ltr_`. + + Unique identifier prefixed with `ltr_`. + + + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + + + Unique identifier prefixed with `vrsn_`. + + Unique identifier prefixed with `vrsn_`. + + + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + + + Add an extra service to your letter. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. + + Add an extra service to your letter. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. + + + + The tracking number, if applicable, will appear here when it becomes available. Dummy tracking numbers are not created in test mode. + + The tracking number, if applicable, will appear here when it becomes available. Dummy tracking numbers are not created in test mode. + + + + Tracking events are not populated for registered or regular (no extra service) letters. + + Tracking events are not populated for registered or regular (no extra service) letters. + + + + Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelope tracking beta, and has `return_envelope`, and `perforated_page` fields populated in the API request. + + Specifies the address the return envelope will be sent back to. This is an optional argument that is available if an account is signed up for the return envelope tracking beta, and has `return_envelope`, and `perforated_page` fields populated in the API request. + + + + Gets or Sets MailType + + + + + Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. + + Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. + + + + Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. + + Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. + + + + Gets or Sets ReturnEnvelope + + + + + Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf). + + Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf). + + + + Gets or Sets CustomEnvelope + + + + + The unique ID of the associated campaign if the resource was generated from a campaign. + + The unique ID of the associated campaign if the resource was generated from a campaign. + + + + Gets or Sets UseType + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Letter instances are equal + + Instance of Letter to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A nested custom envelope object containing more information about the custom envelope used or `null` if a custom envelope was not used. Accepts an envelope ID for any customized envelope with available inventory. If no inventory is available for the specified ID, the letter will not be sent, and an error will be returned. If the letter has more than 6 sheets, it will be sent in a blank flat envelope. Custom envelopes may be created and ordered from the dashboard. This feature is exclusive to certain customers. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + + + + Defines Object + + + + + Enum Envelope for value: envelope + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + The unique identifier of the custom envelope used.. + The url of the envelope asset used.. + _object (default to ObjectEnum.Envelope). + + + + The unique identifier of the custom envelope used. + + The unique identifier of the custom envelope used. + + + + The url of the envelope asset used. + + The url of the envelope asset used. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LetterCustomEnvelope instances are equal + + Instance of LetterCustomEnvelope to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + + + + + Value is type of resource. + + Value is type of resource. + + + + Enum LetterDeleted for value: letter_deleted + + + + + Value is type of resource. + + Value is type of resource. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `ltr_`.. + Only returned if the resource has been successfully deleted.. + Value is type of resource. (default to ObjectEnum.LetterDeleted). + + + + Unique identifier prefixed with `ltr_`. + + Unique identifier prefixed with `ltr_`. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LetterDeletion instances are equal + + Instance of LetterDeletion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Properties that the letters in your Creative should have. + + + + + Specifies the location of the address information that will show through the double-window envelope. + + Specifies the location of the address information that will show through the double-window envelope. + + + + Enum TopFirstPage for value: top_first_page + + + + + Enum InsertBlankPage for value: insert_blank_page + + + + + Enum BottomFirstPageCenter for value: bottom_first_page_center + + + + + Enum BottomFirstPage for value: bottom_first_page + + + + + Specifies the location of the address information that will show through the double-window envelope. + + Specifies the location of the address information that will show through the double-window envelope. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Set this key to `true` if you would like to print in color, false for black and white. (required). + A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. (required). + Specifies the location of the address information that will show through the double-window envelope. (default to AddressPlacementEnum.TopFirstPage). + customEnvelope. + Set this attribute to `true` for double sided printing, `false` for for single sided printing. (default to true). + Add an extra service to your letter.. + mailType. + returnEnvelope. + Allows for letter bleed. Enabled only with specific feature flags. (default to false). + fileOriginalUrl. + + + + Set this key to `true` if you would like to print in color, false for black and white. + + Set this key to `true` if you would like to print in color, false for black and white. + + + + A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. + + A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. + + + + Gets or Sets CustomEnvelope + + + + + Set this attribute to `true` for double sided printing, `false` for for single sided printing. + + Set this attribute to `true` for double sided printing, `false` for for single sided printing. + + + + Add an extra service to your letter. + + Add an extra service to your letter. + + + + Gets or Sets MailType + + + + + Gets or Sets ReturnEnvelope + + + + + Allows for letter bleed. Enabled only with specific feature flags. + + Allows for letter bleed. Enabled only with specific feature flags. + + + + Gets or Sets FileOriginalUrl + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LetterDetailsReturned instances are equal + + Instance of LetterDetailsReturned to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Properties that the letters in your Creative should have. + + + + + Specifies the location of the address information that will show through the double-window envelope. + + Specifies the location of the address information that will show through the double-window envelope. + + + + Enum TopFirstPage for value: top_first_page + + + + + Enum InsertBlankPage for value: insert_blank_page + + + + + Enum BottomFirstPageCenter for value: bottom_first_page_center + + + + + Enum BottomFirstPage for value: bottom_first_page + + + + + Specifies the location of the address information that will show through the double-window envelope. + + Specifies the location of the address information that will show through the double-window envelope. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Specifies the location of the address information that will show through the double-window envelope. (default to AddressPlacementEnum.TopFirstPage). + A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. (required). + Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. (required). + Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. (default to true). + Add an extra service to your letter.. + mailType. + returnEnvelope (default to false). + Accepts an envelope ID for any customized envelope with available inventory.. + + + + A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. + + A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. + + + + Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. + + Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. + + + + Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. + + Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. + + + + Add an extra service to your letter. + + Add an extra service to your letter. + + + + Gets or Sets MailType + + + + + Gets or Sets ReturnEnvelope + + + + + Accepts an envelope ID for any customized envelope with available inventory. + + Accepts an envelope ID for any customized envelope with available inventory. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LetterDetailsWritable instances are equal + + Instance of LetterDetailsWritable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + LetterEditable + + + + + Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template. * `top_first_page` - (default) print address information at the top of your provided first page * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page) * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page * `bottom_first_page` - print address information at the bottom of your provided first page + + Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template. * `top_first_page` - (default) print address information at the top of your provided first page * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page) * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page * `bottom_first_page` - print address information at the bottom of your provided first page + + + + Enum TopFirstPage for value: top_first_page + + + + + Enum InsertBlankPage for value: insert_blank_page + + + + + Enum BottomFirstPageCenter for value: bottom_first_page_center + + + + + Enum BottomFirstPage for value: bottom_first_page + + + + + Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template. * `top_first_page` - (default) print address information at the top of your provided first page * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page) * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page * `bottom_first_page` - print address information at the bottom of your provided first page + + Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template. * `top_first_page` - (default) print address information at the top of your provided first page * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page) * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page * `bottom_first_page` - print address information at the bottom of your provided first page + + + + Add an extra service to your letter: * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet. * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter * `registered` - provides tracking and confirmation for international addresses + + Add an extra service to your letter: * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet. * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter * `registered` - provides tracking and confirmation for international addresses + + + + Enum Certified for value: certified + + + + + Enum CertifiedReturnReceipt for value: certified_return_receipt + + + + + Enum Registered for value: registered + + + + + Enum Null for value: null + + + + + Add an extra service to your letter: * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet. * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter * `registered` - provides tracking and confirmation for international addresses + + Add an extra service to your letter: * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet. * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter * `registered` - provides tracking and confirmation for international addresses + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + An internal description that identifies this resource. Must be no longer than 255 characters. . + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + mailType. + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.. + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. + Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. (required). + Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. (default to true). + Specifies the location of the address information that will show through the double-window envelope. To see how this will impact your letter design, view our letter template. * `top_first_page` - (default) print address information at the top of your provided first page * `insert_blank_page` - insert a blank address page at the beginning of your file (you will be charged for the extra page) * `bottom_first_page_center` - **(deprecation planned within a few months)** print address information at the bottom center of your provided first page * `bottom_first_page` - print address information at the bottom of your provided first page (default to AddressPlacementEnum.TopFirstPage). + indicates if a return envelope is requested for the letter. The value corresponding to this field is by default a boolean. But if the account is signed up for custom return envelopes, the value is of type string and is `no_9_single_window` for a standard return envelope and a custom `return_envelope_id` for non-standard return envelopes. To include a return envelope with your letter, set to `true` and specify the `perforated_page`. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred.. + Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf).. + customEnvelope. + Must either be an address ID or an inline object with correct address parameters. (required). + Must either be an address ID or an inline object with correct address parameters. (required). + PDF file containing the letter's formatting. (required). + Add an extra service to your letter: * `certified` - track and confirm delivery for domestic destinations. An extra sheet (1 PDF page single-sided or 2 PDF pages double-sided) is added to the beginning of your letter for address and barcode information. See here for templates: [#10 envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_template.pdf) and [flat envelope](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_certified_flat_template.pdf) (used for letters over 6 pages single-sided or 12 pages double-sided). You will not be charged for this extra sheet. * `certified_return_receipt` - request an electronic copy of the recipient's signature to prove delivery of your certified letter * `registered` - provides tracking and confirmation for international addresses . + A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information.. + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information.. + qrCode. + useType (required). + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Gets or Sets MailType + + + + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + + + Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. + + Set this key to `true` if you would like to print in color. Set to `false` if you would like to print in black and white. + + + + Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. + + Set this attribute to `true` for double sided printing, or `false` for for single sided printing. Defaults to `true`. + + + + indicates if a return envelope is requested for the letter. The value corresponding to this field is by default a boolean. But if the account is signed up for custom return envelopes, the value is of type string and is `no_9_single_window` for a standard return envelope and a custom `return_envelope_id` for non-standard return envelopes. To include a return envelope with your letter, set to `true` and specify the `perforated_page`. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. + + indicates if a return envelope is requested for the letter. The value corresponding to this field is by default a boolean. But if the account is signed up for custom return envelopes, the value is of type string and is `no_9_single_window` for a standard return envelope and a custom `return_envelope_id` for non-standard return envelopes. To include a return envelope with your letter, set to `true` and specify the `perforated_page`. See [pricing](https://www.lob.com/pricing/print-mail#compare) for extra costs incurred. + + + + Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf). + + Required if `return_envelope` is `true`. The number of the page that should be perforated for use with the return envelope. Must be greater than or equal to `1`. The blank page added by `address_placement=insert_blank_page` will be ignored when considering the perforated page number. To see how perforation will impact your letter design, view our [perforation guide](https://s3-us-west-2.amazonaws.com/public.lob.com/assets/templates/letter_perf_template.pdf). + + + + Gets or Sets CustomEnvelope + + + + + Must either be an address ID or an inline object with correct address parameters. + + Must either be an address ID or an inline object with correct address parameters. + + + + Must either be an address ID or an inline object with correct address parameters. + + Must either be an address ID or an inline object with correct address parameters. + + + + PDF file containing the letter's formatting. + + PDF file containing the letter's formatting. + + + + A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. + + A single-element array containing an existing card id in a string format. See [cards](#tag/Cards) for more information. + + + + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. + + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. + + + + Gets or Sets QrCode + + + + + Gets or Sets UseType + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LetterEditable instances are equal + + Instance of LetterEditable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A nested custom envelope object containing more information about the custom envelope used or `null` if a custom envelope was not used. Accepts an envelope ID for any customized envelope with available inventory. If no inventory is available for the specified ID, the letter will not be sent, and an error will be returned. If the letter has more than 6 sheets, it will be sent in a blank flat envelope. Custom envelopes may be created and ordered from the dashboard. This feature is exclusive to certain customers. Upgrade to the appropriate [Print & Mail Edition](https://dashboard.lob.com/#/settings/editions) to gain access. + + + + + Defines Object + + + + + Enum Envelope for value: envelope + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The unique identifier of the custom envelope used. (required). + The url of the envelope asset used. (required). + _object (required) (default to ObjectEnum.Envelope). + + + + The unique identifier of the custom envelope used. + + The unique identifier of the custom envelope used. + + + + The url of the envelope asset used. + + The url of the envelope asset used. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LetterEditableCustomEnvelope instances are equal + + Instance of LetterEditableCustomEnvelope to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + LetterList + + + + + Initializes a new instance of the class. + + list of letters. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + indicates the total number of records. Provided when the request specifies an \"include\" query parameter. + + + + list of letters + + list of letters + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LetterList instances are equal + + Instance of LetterList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob Confidence Score is a nested object that provides a numerical value between 0-100 of the likelihood that an address is deliverable based on Lob’s mail delivery data to over half of US households. + + + + + indicates the likelihood that the address is a valid, mail-receiving address. Possible values are: - `high` — Over 70% of mailpieces Lob has sent to this address were delivered successfully and recent mailings were also successful. - `medium` — Between 40% and 70% of mailpieces Lob has sent to this address were delivered successfully. - `low` — Less than 40% of mailpieces Lob has sent to this address were delivered successfully and recent mailings weren't successful. - `\"\"` — No tracking data exists for this address or lob deliverability was unable to find a corresponding level of mail success. + + indicates the likelihood that the address is a valid, mail-receiving address. Possible values are: - `high` — Over 70% of mailpieces Lob has sent to this address were delivered successfully and recent mailings were also successful. - `medium` — Between 40% and 70% of mailpieces Lob has sent to this address were delivered successfully. - `low` — Less than 40% of mailpieces Lob has sent to this address were delivered successfully and recent mailings weren't successful. - `\"\"` — No tracking data exists for this address or lob deliverability was unable to find a corresponding level of mail success. + + + + Enum High for value: high + + + + + Enum Medium for value: medium + + + + + Enum Low for value: low + + + + + Enum Empty for value: + + + + + indicates the likelihood that the address is a valid, mail-receiving address. Possible values are: - `high` — Over 70% of mailpieces Lob has sent to this address were delivered successfully and recent mailings were also successful. - `medium` — Between 40% and 70% of mailpieces Lob has sent to this address were delivered successfully. - `low` — Less than 40% of mailpieces Lob has sent to this address were delivered successfully and recent mailings weren't successful. - `\"\"` — No tracking data exists for this address or lob deliverability was unable to find a corresponding level of mail success. + + indicates the likelihood that the address is a valid, mail-receiving address. Possible values are: - `high` — Over 70% of mailpieces Lob has sent to this address were delivered successfully and recent mailings were also successful. - `medium` — Between 40% and 70% of mailpieces Lob has sent to this address were delivered successfully. - `low` — Less than 40% of mailpieces Lob has sent to this address were delivered successfully and recent mailings weren't successful. - `\"\"` — No tracking data exists for this address or lob deliverability was unable to find a corresponding level of mail success. + + + + Initializes a new instance of the class. + + A numerical score between 0 and 100 that represents the percentage of mailpieces Lob has sent to this addresses that have been delivered successfully over the past 2 years. Will be `null` if no tracking data exists for this address. . + indicates the likelihood that the address is a valid, mail-receiving address. Possible values are: - `high` — Over 70% of mailpieces Lob has sent to this address were delivered successfully and recent mailings were also successful. - `medium` — Between 40% and 70% of mailpieces Lob has sent to this address were delivered successfully. - `low` — Less than 40% of mailpieces Lob has sent to this address were delivered successfully and recent mailings weren't successful. - `\"\"` — No tracking data exists for this address or lob deliverability was unable to find a corresponding level of mail success. . + + + + A numerical score between 0 and 100 that represents the percentage of mailpieces Lob has sent to this addresses that have been delivered successfully over the past 2 years. Will be `null` if no tracking data exists for this address. + + A numerical score between 0 and 100 that represents the percentage of mailpieces Lob has sent to this addresses that have been delivered successfully over the past 2 years. Will be `null` if no tracking data exists for this address. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LobConfidenceScore instances are equal + + Instance of LobConfidenceScore to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. + + + + + A conventional HTTP status code. + + A conventional HTTP status code. + + + + Enum NUMBER_401 for value: 401 + + + + + Enum NUMBER_403 for value: 403 + + + + + Enum NUMBER_404 for value: 404 + + + + + Enum NUMBER_413 for value: 413 + + + + + Enum NUMBER_422 for value: 422 + + + + + Enum NUMBER_429 for value: 429 + + + + + Enum NUMBER_500 for value: 500 + + + + + A conventional HTTP status code. + + A conventional HTTP status code. + + + + A pre-defined string identifying an error. + + A pre-defined string identifying an error. + + + + Enum BadRequest for value: bad_request + + + + + Enum Conflict for value: conflict + + + + + Enum FeatureLimitReached for value: feature_limit_reached + + + + + Enum InternalServerError for value: internal_server_error + + + + + Enum Invalid for value: invalid + + + + + Enum NotDeletable for value: not_deletable + + + + + Enum NotFound for value: not_found + + + + + Enum RequestTimeout for value: request_timeout + + + + + Enum ServiceUnavailable for value: service_unavailable + + + + + Enum UnrecognizedEndpoint for value: unrecognized_endpoint + + + + + Enum UnsupportedLobVersion for value: unsupported_lob_version + + + + + Enum AddressLengthExceedsLimit for value: address_length_exceeds_limit + + + + + Enum BankAccountAlreadyVerified for value: bank_account_already_verified + + + + + Enum BankError for value: bank_error + + + + + Enum CustomEnvelopeInventoryDepleted for value: custom_envelope_inventory_depleted + + + + + Enum DeletedBankAccount for value: deleted_bank_account + + + + + Enum FailedDeliverabilityStrictness for value: failed_deliverability_strictness + + + + + Enum FilePagesBelowMin for value: file_pages_below_min + + + + + Enum FilePagesExceedMax for value: file_pages_exceed_max + + + + + Enum FileSizeExceedsLimit for value: file_size_exceeds_limit + + + + + Enum ForeignReturnAddress for value: foreign_return_address + + + + + Enum InconsistentPageDimensions for value: inconsistent_page_dimensions + + + + + Enum InvalidBankAccount for value: invalid_bank_account + + + + + Enum InvalidBankAccountVerification for value: invalid_bank_account_verification + + + + + Enum InvalidCheckInternational for value: invalid_check_international + + + + + Enum InvalidCountryCovid for value: invalid_country_covid + + + + + Enum InvalidFile for value: invalid_file + + + + + Enum InvalidFileDimensions for value: invalid_file_dimensions + + + + + Enum InvalidFileDownloadTime for value: invalid_file_download_time + + + + + Enum InvalidFileUrl for value: invalid_file_url + + + + + Enum InvalidImageDpi for value: invalid_image_dpi + + + + + Enum InvalidInternationalFeature for value: invalid_international_feature + + + + + Enum InvalidPerforationReturnEnvelope for value: invalid_perforation_return_envelope + + + + + Enum InvalidTemplateHtml for value: invalid_template_html + + + + + Enum MergeVariableRequired for value: merge_variable_required + + + + + Enum MergeVariableWhitespace for value: merge_variable_whitespace + + + + + Enum PaymentMethodUnverified for value: payment_method_unverified + + + + + Enum PdfEncrypted for value: pdf_encrypted + + + + + Enum SpecialCharactersRestricted for value: special_characters_restricted + + + + + Enum UnembeddedFonts for value: unembedded_fonts + + + + + Enum EmailRequired for value: email_required + + + + + Enum InvalidApiKey for value: invalid_api_key + + + + + Enum PublishableKeyNotAllowed for value: publishable_key_not_allowed + + + + + Enum RateLimitExceeded for value: rate_limit_exceeded + + + + + Enum Unauthorized for value: unauthorized + + + + + Enum UnauthorizedToken for value: unauthorized_token + + + + + Enum CardQuantityBelowMin for value: card_quantity_below_min + + + + + A pre-defined string identifying an error. + + A pre-defined string identifying an error. + + + + Initializes a new instance of the class. + + A human-readable message with more details about the error. + A conventional HTTP status code.. + A pre-defined string identifying an error.. + + + + A human-readable message with more details about the error + + A human-readable message with more details about the error + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LobError instances are equal + + Instance of LobError to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Location + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be input with `longitude` to pinpoint locations on a map. (required). + A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be input with `latitude` to pinpoint locations on a map. (required). + + + + A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be input with `longitude` to pinpoint locations on a map. + + A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be input with `longitude` to pinpoint locations on a map. + + + + A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be input with `latitude` to pinpoint locations on a map. + + A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be input with `latitude` to pinpoint locations on a map. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Location instances are equal + + Instance of Location to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A nested object containing a breakdown of the analysis of a reverse geocoded location. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A positive or negative decimal indicating the geographic latitude of the address. (required). + A positive or negative decimal indicating the geographic longitude of the address. (required). + The distance from the input location to this exact zip code in miles. (required). + + + + A positive or negative decimal indicating the geographic latitude of the address. + + A positive or negative decimal indicating the geographic latitude of the address. + + + + A positive or negative decimal indicating the geographic longitude of the address. + + A positive or negative decimal indicating the geographic longitude of the address. + + + + The distance from the input location to this exact zip code in miles. + + The distance from the input location to this exact zip code in miles. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LocationAnalysis instances are equal + + Instance of LocationAnalysis to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). + + The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). + + + + Enum Marketing for value: marketing + + + + + Enum Operational for value: operational + + + + + Enum Null for value: null + + + + + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. + + A string designating the mail postage type: * `usps_first_class` - (default) * `usps_standard` - a [cheaper option](https://lob.com/pricing/print-mail#compare) which is less predictable and takes longer to deliver. `usps_standard` cannot be used with `4x6` postcards or for any postcards sent outside of the United States. + + + + Enum FirstClass for value: usps_first_class + + + + + Enum Standard for value: usps_standard + + + + + MultiLineAddress + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The intended recipient, typically a person's or firm's name.. + Either `name` or `company` is required, you may also add both.. + 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` (required). + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. . + 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. . + city. + The <a href=\"https://en.wikipedia.org/wiki/ISO_3166-2:US\" target=\"_blank\">ISO 3166-2</a> 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`).. + + + + The intended recipient, typically a person's or firm's name. + + The intended recipient, typically a person's or firm's name. + + + + Either `name` or `company` is required, you may also add both. + + Either `name` or `company` is required, you may also add both. + + + + 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 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. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + 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. + + 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. + + + + Gets or Sets City + + + + + The <a href=\"https://en.wikipedia.org/wiki/ISO_3166-2:US\" target=\"_blank\">ISO 3166-2</a> two letter code or subdivision name for the state. `city` and `state` are required if no `zip_code` is passed. + + The <a href=\"https://en.wikipedia.org/wiki/ISO_3166-2:US\" target=\"_blank\">ISO 3166-2</a> 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`). + + 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`). + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if MultiLineAddress instances are equal + + Instance of MultiLineAddress to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + MultipleComponents + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + 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` (required). + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. . + 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. . + 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`).. + + + + The intended recipient, typically a person's or firm's name. + + 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 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. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + 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. + + 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. + + + + Gets or Sets 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. + + 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`). + + 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`). + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if MultipleComponents instances are equal + + Instance of MultipleComponents to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + MultipleComponentsIntl + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The intended recipient, typically a person's or firm's name.. + The primary delivery line (usually the street address) of the address. (required). + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. . + city. + The name of the state.. + The postal code.. + country (required). + + + + The intended recipient, typically a person's or firm's name. + + The intended recipient, typically a person's or firm's name. + + + + The primary delivery line (usually the street address) of the address. + + The primary delivery line (usually the street address) of the address. + + + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + Gets or Sets City + + + + + The name of the state. + + The name of the state. + + + + The postal code. + + The postal code. + + + + Gets or Sets Country + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if MultipleComponentsIntl instances are equal + + Instance of MultipleComponentsIntl to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + MultipleComponentsList + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + addresses (required). + + + + Gets or Sets Addresses + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if MultipleComponentsList instances are equal + + Instance of MultipleComponentsList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + PlaceholderModel + + + + + Initializes a new instance of the class. + + returnEnvelope. + addressDomestic. + letterDetailsWritable. + postcardDetailsWritable. + letterDetailsReturned. + postcardDetailsReturned. + + + + Gets or Sets ReturnEnvelope + + + + + Gets or Sets AddressDomestic + + + + + Gets or Sets LetterDetailsWritable + + + + + Gets or Sets PostcardDetailsWritable + + + + + Gets or Sets LetterDetailsReturned + + + + + Gets or Sets PostcardDetailsReturned + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if PlaceholderModel instances are equal + + Instance of PlaceholderModel to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Postcard + + + + + Defines Carrier + + + + + Enum USPS for value: USPS + + + + + Gets or Sets Carrier + + + + + Defines Object + + + + + Enum Postcard for value: postcard + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `psc_`. (required). + to. + from. + carrier (default to CarrierEnum.USPS). + thumbnails. + size. + A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`.. + A timestamp in ISO 8601 format of the date the resource was created.. + A timestamp in ISO 8601 format of the date the resource was last modified.. + Only returned if the resource has been successfully deleted.. + The unique ID of the HTML template used for the front of the postcard.. + The unique ID of the HTML template used for the back of the postcard.. + The unique ID of the specific version of the HTML template used for the front of the postcard.. + The unique ID of the specific version of the HTML template used for the back of the postcard.. + An array of tracking_event objects ordered by ascending `time`. Will not be populated for postcards created in test mode.. + _object (default to ObjectEnum.Postcard). + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. (required). + An internal description that identifies this resource. Must be no longer than 255 characters. . + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + mailType. + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.. + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. + useType. + + + + Unique identifier prefixed with `psc_`. + + Unique identifier prefixed with `psc_`. + + + + Gets or Sets To + + + + + Gets or Sets From + + + + + Gets or Sets Thumbnails + + + + + Gets or Sets Size + + + + + A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. + + A date in YYYY-MM-DD format of the mailpiece's expected delivery date based on its `send_date`. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + The unique ID of the HTML template used for the front of the postcard. + + The unique ID of the HTML template used for the front of the postcard. + + + + The unique ID of the HTML template used for the back of the postcard. + + The unique ID of the HTML template used for the back of the postcard. + + + + The unique ID of the specific version of the HTML template used for the front of the postcard. + + The unique ID of the specific version of the HTML template used for the front of the postcard. + + + + The unique ID of the specific version of the HTML template used for the back of the postcard. + + The unique ID of the specific version of the HTML template used for the back of the postcard. + + + + An array of tracking_event objects ordered by ascending `time`. Will not be populated for postcards created in test mode. + + An array of tracking_event objects ordered by ascending `time`. Will not be populated for postcards created in test mode. + + + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Gets or Sets MailType + + + + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + + + Gets or Sets UseType + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Postcard instances are equal + + Instance of Postcard to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + + + + + Value is type of resource. + + Value is type of resource. + + + + Enum PostcardDeleted for value: postcard_deleted + + + + + Value is type of resource. + + Value is type of resource. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `psc_`.. + Only returned if the resource has been successfully deleted.. + Value is type of resource. (default to ObjectEnum.PostcardDeleted). + + + + Unique identifier prefixed with `psc_`. + + Unique identifier prefixed with `psc_`. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if PostcardDeletion instances are equal + + Instance of PostcardDeletion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Properties that the postcards in your Creative should have. + + + + + Initializes a new instance of the class. + + mailType. + size. + setting (default to 1001). + The original URL of the front template.. + The original URL of the back template.. + + + + Gets or Sets MailType + + + + + Gets or Sets Size + + + + + Gets or Sets Setting + + + + + The original URL of the front template. + + The original URL of the front template. + + + + The original URL of the back template. + + The original URL of the back template. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if PostcardDetailsReturned instances are equal + + Instance of PostcardDetailsReturned to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Properties that the postcards in your Creative should have. + + + + + Initializes a new instance of the class. + + mailType. + size. + + + + Gets or Sets MailType + + + + + Gets or Sets Size + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if PostcardDetailsWritable instances are equal + + Instance of PostcardDetailsWritable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + PostcardEditable + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Must either be an address ID or an inline object with correct address parameters. (required). + Required if `to` address is international. Must either be an address ID or an inline object with correct address parameters.. + size. + An internal description that identifies this resource. Must be no longer than 255 characters. . + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + mailType. + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.. + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. + The artwork to use as the front of your postcard. (required). + The artwork to use as the back of your postcard. (required). + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information.. + qrCode. + useType (required). + + + + Must either be an address ID or an inline object with correct address parameters. + + Must either be an address ID or an inline object with correct address parameters. + + + + Required if `to` address is international. Must either be an address ID or an inline object with correct address parameters. + + Required if `to` address is international. Must either be an address ID or an inline object with correct address parameters. + + + + Gets or Sets Size + + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Gets or Sets MailType + + + + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + + + The artwork to use as the front of your postcard. + + The artwork to use as the front of your postcard. + + + + The artwork to use as the back of your postcard. + + The artwork to use as the back of your postcard. + + + + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. + + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. + + + + Gets or Sets QrCode + + + + + Gets or Sets UseType + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if PostcardEditable instances are equal + + Instance of PostcardEditable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + PostcardList + + + + + Initializes a new instance of the class. + + list of postcards. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + indicates the total number of records. Provided when the request specifies an \"include\" query parameter. + + + + list of postcards + + list of postcards + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if PostcardList instances are equal + + Instance of PostcardList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. + + Specifies the size of the postcard. Only `4x6` postcards can be sent to international destinations. + + + + Enum _4x6 for value: 4x6 + + + + + Enum _6x9 for value: 6x9 + + + + + Enum _6x11 for value: 6x11 + + + + + The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). + + The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). + + + + Enum Marketing for value: marketing + + + + + Enum Operational for value: operational + + + + + Enum Null for value: null + + + + + Customize and place a QR code on the creative at the required position. + + + + + Sets how a QR code is being positioned in the document. + + Sets how a QR code is being positioned in the document. + + + + Enum Fixed for value: fixed + + + + + Enum Relative for value: relative + + + + + Sets how a QR code is being positioned in the document. + + Sets how a QR code is being positioned in the document. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Sets how a QR code is being positioned in the document. (required). + Vertical distance(in inches) to place QR code from the top.. + Horizonal distance(in inches) to place QR code from the right.. + Horizonal distance(in inches) to place QR code from the left.. + Vertical distance(in inches) to place QR code from the bottom.. + The url to redirect the user when a QR code is scanned. The url must start with `https://` (required). + The size(in inches) of the QR code. All QR codes are generated as a square. (required). + + + + Vertical distance(in inches) to place QR code from the top. + + Vertical distance(in inches) to place QR code from the top. + + + + Horizonal distance(in inches) to place QR code from the right. + + Horizonal distance(in inches) to place QR code from the right. + + + + Horizonal distance(in inches) to place QR code from the left. + + Horizonal distance(in inches) to place QR code from the left. + + + + Vertical distance(in inches) to place QR code from the bottom. + + Vertical distance(in inches) to place QR code from the bottom. + + + + The url to redirect the user when a QR code is scanned. The url must start with `https://` + + The url to redirect the user when a QR code is scanned. The url must start with `https://` + + + + The size(in inches) of the QR code. All QR codes are generated as a square. + + The size(in inches) of the QR code. All QR codes are generated as a square. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if QrCode instances are equal + + Instance of QrCode to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ReturnEnvelope + + + + + Initializes a new instance of the class. + + The unique ID of the Return Envelope. + A quick reference name for the Return Envelope. + The url of the return envelope. + _object. + + + + The unique ID of the Return Envelope + + The unique ID of the Return Envelope + + + + A quick reference name for the Return Envelope + + A quick reference name for the Return Envelope + + + + The url of the return envelope + + The url of the return envelope + + + + Gets or Sets Object + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ReturnEnvelope instances are equal + + Instance of ReturnEnvelope to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ReverseGeocode + + + + + Value is resource type. + + Value is resource type. + + + + Enum UsReverseGeocodeLookup for value: us_reverse_geocode_lookup + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `us_reverse_geocode_`.. + list of addresses . + Value is resource type. (default to ObjectEnum.UsReverseGeocodeLookup). + + + + Unique identifier prefixed with `us_reverse_geocode_`. + + Unique identifier prefixed with `us_reverse_geocode_`. + + + + list of addresses + + list of addresses + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ReverseGeocode instances are equal + + Instance of ReverseGeocode to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SelfMailer + + + + + Value is resource type. + + Value is resource type. + + + + Enum SelfMailer for value: self_mailer + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `sfm_`. (required). + to (required). + from. + size. + An internal description that identifies this resource. Must be no longer than 255 characters. . + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + mailType. + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.. + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. + The unique ID of the HTML template used for the outside of the self mailer.. + The unique ID of the HTML template used for the inside of the self mailer.. + The unique ID of the specific version of the HTML template used for the outside of the self mailer.. + The unique ID of the specific version of the HTML template used for the inside of the self mailer.. + Value is resource type. (default to ObjectEnum.SelfMailer). + An array of certified tracking events ordered by ascending `time`. Not populated in test mode.. + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. (required). + useType (required). + + + + Unique identifier prefixed with `sfm_`. + + Unique identifier prefixed with `sfm_`. + + + + Gets or Sets To + + + + + Gets or Sets From + + + + + Gets or Sets Size + + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Gets or Sets MailType + + + + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + + + The unique ID of the HTML template used for the outside of the self mailer. + + The unique ID of the HTML template used for the outside of the self mailer. + + + + The unique ID of the HTML template used for the inside of the self mailer. + + The unique ID of the HTML template used for the inside of the self mailer. + + + + The unique ID of the specific version of the HTML template used for the outside of the self mailer. + + The unique ID of the specific version of the HTML template used for the outside of the self mailer. + + + + The unique ID of the specific version of the HTML template used for the inside of the self mailer. + + The unique ID of the specific version of the HTML template used for the inside of the self mailer. + + + + An array of certified tracking events ordered by ascending `time`. Not populated in test mode. + + An array of certified tracking events ordered by ascending `time`. Not populated in test mode. + + + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + + + Gets or Sets UseType + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SelfMailer instances are equal + + Instance of SelfMailer to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + + + + + Value is type of resource. + + Value is type of resource. + + + + Enum SelfMailerDeleted for value: self_mailer_deleted + + + + + Value is type of resource. + + Value is type of resource. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `sfm_`.. + Only returned if the resource has been successfully deleted.. + Value is type of resource. (default to ObjectEnum.SelfMailerDeleted). + + + + Unique identifier prefixed with `sfm_`. + + Unique identifier prefixed with `sfm_`. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SelfMailerDeletion instances are equal + + Instance of SelfMailerDeletion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SelfMailerEditable + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Must either be an address ID or an inline object with correct address parameters. (required). + Must either be an address ID or an inline object with correct address parameters.. + size. + An internal description that identifies this resource. Must be no longer than 255 characters. . + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + mailType. + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string.. + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC.. + The artwork to use as the inside of your self mailer. (required). + The artwork to use as the outside of your self mailer. (required). + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information.. + useType (required). + + + + Must either be an address ID or an inline object with correct address parameters. + + Must either be an address ID or an inline object with correct address parameters. + + + + Must either be an address ID or an inline object with correct address parameters. + + Must either be an address ID or an inline object with correct address parameters. + + + + Gets or Sets Size + + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Gets or Sets MailType + + + + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{\"variable_name\": \"Harry\"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `\"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\\`, `]`, `^`, `` ` ``, `{`, `|`, `}`, `~`. More instructions can be found in [our guide to using html and merge variables](https://lob.com/resources/guides/general/using-html-and-merge-variables). Depending on your [Merge Variable strictness](https://dashboard.lob.com/#/settings/account) setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. + + + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default [cancellation window](#section/Cancellation-Windows) applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. + + + + The artwork to use as the inside of your self mailer. + + The artwork to use as the inside of your self mailer. + + + + The artwork to use as the outside of your self mailer. + + The artwork to use as the outside of your self mailer. + + + + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. + + An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See [Billing Group API](https://lob.github.io/lob-openapi/#tag/Billing-Groups) for more information. + + + + Gets or Sets UseType + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SelfMailerEditable instances are equal + + Instance of SelfMailerEditable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SelfMailerList + + + + + Initializes a new instance of the class. + + list of self-mailers. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + indicates the total number of records. Provided when the request specifies an \"include\" query parameter. + + + + list of self-mailers + + list of self-mailers + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SelfMailerList instances are equal + + Instance of SelfMailerList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Specifies the size of the self mailer. + + Specifies the size of the self mailer. + + + + Enum _6x18Bifold for value: 6x18_bifold + + + + + Enum _11x9Bifold for value: 11x9_bifold + + + + + Enum _12x9Bifold for value: 12x9_bifold + + + + + The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). + + The use type for each mailpiece. Can be one of marketing, operational, or null. Null use_type is only allowed if an account default use_type is selected in Account Settings. For more information on use_type, see our [Help Center article](https://help.lob.com/print-and-mail/building-a-mail-strategy/managing-mail-settings/declaring-mail-use-type). + + + + Enum Marketing for value: marketing + + + + + Enum Operational for value: operational + + + + + Enum Null for value: null + + + + + SortBy + + + + + Defines DateCreated + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets DateCreated + + + + + Defines SendDate + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets SendDate + + + + + Initializes a new instance of the class. + + dateCreated. + sendDate. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SortBy instances are equal + + Instance of SortBy to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SortBy1 + + + + + Defines DateCreated + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets DateCreated + + + + + Defines SendDate + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets SendDate + + + + + Initializes a new instance of the class. + + dateCreated. + sendDate. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SortBy1 instances are equal + + Instance of SortBy1 to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SortBy2 + + + + + Defines DateCreated + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets DateCreated + + + + + Defines SendDate + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets SendDate + + + + + Initializes a new instance of the class. + + dateCreated. + sendDate. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SortBy2 instances are equal + + Instance of SortBy2 to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SortBy3 + + + + + Defines DateCreated + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets DateCreated + + + + + Defines SendDate + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets SendDate + + + + + Initializes a new instance of the class. + + dateCreated. + sendDate. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SortBy3 instances are equal + + Instance of SortBy3 to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SortBy4 + + + + + Defines DateCreated + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets DateCreated + + + + + Defines SendDate + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets SendDate + + + + + Initializes a new instance of the class. + + dateCreated. + sendDate. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SortBy4 instances are equal + + Instance of SortBy4 to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SortBy5 + + + + + Defines DateCreated + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets DateCreated + + + + + Defines SendDate + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets SendDate + + + + + Initializes a new instance of the class. + + dateCreated. + sendDate. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SortBy5 instances are equal + + Instance of SortBy5 to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SortByDateModified + + + + + Defines DateCreated + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets DateCreated + + + + + Defines DateModified + + + + + Enum Asc for value: asc + + + + + Enum Desc for value: desc + + + + + Gets or Sets DateModified + + + + + Initializes a new instance of the class. + + dateCreated. + dateModified. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SortByDateModified instances are equal + + Instance of SortByDateModified to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Suggestions + + + + + Value is resource type. + + Value is resource type. + + + + Enum UsAutocompletion for value: us_autocompletion + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` (required). + city (required). + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. (required). + A 5-digit zip code. Left empty if a test key is used. (required). + Value is resource type. (default to ObjectEnum.UsAutocompletion). + + + + The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` + + The primary delivery line (usually the street address) of the address. Combination of the following applicable `components` (primary number & secondary information may be missing or inaccurate): * `primary_number` * `street_predirection` * `street_name` * `street_suffix` * `street_postdirection` * `secondary_designator` * `secondary_number` * `pmb_designator` * `pmb_number` + + + + Gets or Sets City + + + + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + + + A 5-digit zip code. Left empty if a test key is used. + + A 5-digit zip code. Left empty if a test key is used. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Suggestions instances are equal + + Instance of Suggestions to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Template + + + + + Value is resource type. + + Value is resource type. + + + + Enum Template for value: template + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + An internal description that identifies this resource. Must be no longer than 255 characters. . + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). (required). + An array of all non-deleted [version objects](#tag/Template-Versions) associated with the template. (required). + publishedVersion (required). + Value is resource type. (default to ObjectEnum.Template). + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + A timestamp in ISO 8601 format of the date the resource was created.. + A timestamp in ISO 8601 format of the date the resource was last modified.. + Only returned if the resource has been successfully deleted.. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + + + An array of all non-deleted [version objects](#tag/Template-Versions) associated with the template. + + An array of all non-deleted [version objects](#tag/Template-Versions) associated with the template. + + + + Gets or Sets PublishedVersion + + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Template instances are equal + + Instance of Template to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + + + + + Value is type of resource. + + Value is type of resource. + + + + Enum TemplateDeleted for value: template_deleted + + + + + Value is type of resource. + + Value is type of resource. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates).. + Only returned if the resource has been successfully deleted.. + Value is type of resource. (default to ObjectEnum.TemplateDeleted). + + + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + Unique identifier prefixed with `tmpl_`. ID of a saved [HTML template](#section/HTML-Templates). + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TemplateDeletion instances are equal + + Instance of TemplateDeletion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TemplateList + + + + + Initializes a new instance of the class. + + list of templates. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + indicates the total number of records. Provided when the request specifies an \"include\" query parameter. + + + + list of templates + + list of templates + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TemplateList instances are equal + + Instance of TemplateList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TemplateUpdate + + + + + Initializes a new instance of the class. + + An internal description that identifies this resource. Must be no longer than 255 characters. . + Unique identifier prefixed with `vrsn_`.. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Unique identifier prefixed with `vrsn_`. + + Unique identifier prefixed with `vrsn_`. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TemplateUpdate instances are equal + + Instance of TemplateUpdate to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TemplateVersion + + + + + Value is resource type. + + Value is resource type. + + + + Enum Version for value: version + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `vrsn_`. (required). + An internal description that identifies this resource. Must be no longer than 255 characters. . + An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. (required). + engine. + Used by frontend, true if the template uses advanced features. . + Used by frontend, an object representing the keys of every merge variable present in the template. It has one key named 'keys', and its value is an array of strings. . + A timestamp in ISO 8601 format of the date the resource was created.. + A timestamp in ISO 8601 format of the date the resource was last modified.. + Only returned if the resource has been successfully deleted.. + Value is resource type. (default to ObjectEnum.Version). + + + + Unique identifier prefixed with `vrsn_`. + + Unique identifier prefixed with `vrsn_`. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. + + An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. + + + + Gets or Sets Engine + + + + + Used by frontend, true if the template uses advanced features. + + Used by frontend, true if the template uses advanced features. + + + + Used by frontend, an object representing the keys of every merge variable present in the template. It has one key named 'keys', and its value is an array of strings. + + Used by frontend, an object representing the keys of every merge variable present in the template. It has one key named 'keys', and its value is an array of strings. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TemplateVersion instances are equal + + Instance of TemplateVersion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Lob uses RESTful HTTP response codes to indicate success or failure of an API request. In general, 2xx indicates success, 4xx indicate an input error, and 5xx indicates an error on Lob's end. + + + + + Value is type of resource. + + Value is type of resource. + + + + Enum TemplateVersionDeleted for value: template_version_deleted + + + + + Value is type of resource. + + Value is type of resource. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `vrsn_`.. + Only returned if the resource has been successfully deleted.. + Value is type of resource. (default to ObjectEnum.TemplateVersionDeleted). + + + + Unique identifier prefixed with `vrsn_`. + + Unique identifier prefixed with `vrsn_`. + + + + Only returned if the resource has been successfully deleted. + + Only returned if the resource has been successfully deleted. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TemplateVersionDeletion instances are equal + + Instance of TemplateVersionDeletion to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TemplateVersionList + + + + + Initializes a new instance of the class. + + list of template versions. + Value is type of resource.. + url of next page of items in list.. + url of previous page of items in list.. + number of resources in a set. + indicates the total number of records. Provided when the request specifies an \"include\" query parameter. + + + + list of template versions + + list of template versions + + + + Value is type of resource. + + Value is type of resource. + + + + url of next page of items in list. + + url of next page of items in list. + + + + url of previous page of items in list. + + url of previous page of items in list. + + + + number of resources in a set + + number of resources in a set + + + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + indicates the total number of records. Provided when the request specifies an \"include\" query parameter + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TemplateVersionList instances are equal + + Instance of TemplateVersionList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TemplateVersionUpdatable + + + + + Initializes a new instance of the class. + + An internal description that identifies this resource. Must be no longer than 255 characters. . + engine. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + Gets or Sets Engine + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TemplateVersionUpdatable instances are equal + + Instance of TemplateVersionUpdatable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TemplateVersionWritable + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + An internal description that identifies this resource. Must be no longer than 255 characters. . + An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. (required). + engine. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. + + An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. + + + + Gets or Sets Engine + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TemplateVersionWritable instances are equal + + Instance of TemplateVersionWritable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TemplateWritable + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + An internal description that identifies this resource. Must be no longer than 255 characters. . + An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. (required). + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information.. + engine. + + + + An internal description that identifies this resource. Must be no longer than 255 characters. + + An internal description that identifies this resource. Must be no longer than 255 characters. + + + + An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. + + An HTML string of less than 100,000 characters to be used as the `published_version` of this template. See [here](#section/HTML-Examples) for guidance on designing HTML templates. Please see endpoint specific documentation for any other product-specific HTML details: - [Postcards](https://docs.lob.com/#tag/Postcards/operation/postcard_create) - `front` and `back` - [Self Mailers](https://docs.lob.com/#tag/Self-Mailers/operation/self_mailer_create) - `inside` and `outside` - [Letters](https://docs.lob.com/#tag/Letters/operation/letter_create) - `file` - [Checks](https://docs.lob.com/#tag/Checks/operation/check_create) - `check_bottom` and `attachment` - [Cards](https://docs.lob.com/#tag/Cards/operation/card_create) - `front` and `back` If there is a syntax error with your variable names within your HTML, then an error will be thrown, e.g. using a `{{#users}}` opening tag without the corresponding closing tag `{{/users}}`. + + + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `\"` and `\\`. i.e. '{\"customer_id\" : \"NEWYORK2015\"}' Nested objects are not supported. See [Metadata](#section/Metadata) for more information. + + + + Gets or Sets Engine + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TemplateWritable instances are equal + + Instance of TemplateWritable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Thumbnail + + + + + Initializes a new instance of the class. + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.. + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.. + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated.. + + + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + A [signed link](#section/Asset-URLs) served over HTTPS. The link returned will expire in 30 days to prevent mis-sharing. Each time a GET request is initiated, a new signed URL will be generated. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Thumbnail instances are equal + + Instance of Thumbnail to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TrackingEventCertified + + + + + a Certified letter tracking event + + a Certified letter tracking event + + + + Enum Certified for value: certified + + + + + a Certified letter tracking event + + a Certified letter tracking event + + + + Name of tracking event for Certified letters. Letters sent with USPS Certified Mail are fully tracked by USPS, therefore their tracking events have an additional details object with more detailed information about the tracking event. Some certified tracking event names have multiple meanings, noted in the list here. See the description of the details object for the full set of combined certified tracking event name meanings. * `Mailed` - Package has been accepted into the carrier network for delivery. * `In Transit` - Maps to four distinct stages of transit. * `In Local Area` - Package is at a location near the end destination. * `Processed for Delivery` - Maps to two distinct stages of delivery. * `Pickup Available` - Package is available for pickup at carrier location. * `Delivered` - Package has been delivered. * `Re-Routed` - Package has been forwarded. * `Returned to Sender` - Package is to be returned to sender. * `Issue` - Maps to (at least) 15 possible issues, some of which are actionable. + + Name of tracking event for Certified letters. Letters sent with USPS Certified Mail are fully tracked by USPS, therefore their tracking events have an additional details object with more detailed information about the tracking event. Some certified tracking event names have multiple meanings, noted in the list here. See the description of the details object for the full set of combined certified tracking event name meanings. * `Mailed` - Package has been accepted into the carrier network for delivery. * `In Transit` - Maps to four distinct stages of transit. * `In Local Area` - Package is at a location near the end destination. * `Processed for Delivery` - Maps to two distinct stages of delivery. * `Pickup Available` - Package is available for pickup at carrier location. * `Delivered` - Package has been delivered. * `Re-Routed` - Package has been forwarded. * `Returned to Sender` - Package is to be returned to sender. * `Issue` - Maps to (at least) 15 possible issues, some of which are actionable. + + + + Enum Mailed for value: Mailed + + + + + Enum InTransit for value: In Transit + + + + + Enum InLocalArea for value: In Local Area + + + + + Enum ProcessedForDelivery for value: Processed for Delivery + + + + + Enum PickupAvailable for value: Pickup Available + + + + + Enum Delivered for value: Delivered + + + + + Enum ReRouted for value: Re-Routed + + + + + Enum ReturnedToSender for value: Returned to Sender + + + + + Enum Issue for value: Issue + + + + + Name of tracking event for Certified letters. Letters sent with USPS Certified Mail are fully tracked by USPS, therefore their tracking events have an additional details object with more detailed information about the tracking event. Some certified tracking event names have multiple meanings, noted in the list here. See the description of the details object for the full set of combined certified tracking event name meanings. * `Mailed` - Package has been accepted into the carrier network for delivery. * `In Transit` - Maps to four distinct stages of transit. * `In Local Area` - Package is at a location near the end destination. * `Processed for Delivery` - Maps to two distinct stages of delivery. * `Pickup Available` - Package is available for pickup at carrier location. * `Delivered` - Package has been delivered. * `Re-Routed` - Package has been forwarded. * `Returned to Sender` - Package is to be returned to sender. * `Issue` - Maps to (at least) 15 possible issues, some of which are actionable. + + Name of tracking event for Certified letters. Letters sent with USPS Certified Mail are fully tracked by USPS, therefore their tracking events have an additional details object with more detailed information about the tracking event. Some certified tracking event names have multiple meanings, noted in the list here. See the description of the details object for the full set of combined certified tracking event name meanings. * `Mailed` - Package has been accepted into the carrier network for delivery. * `In Transit` - Maps to four distinct stages of transit. * `In Local Area` - Package is at a location near the end destination. * `Processed for Delivery` - Maps to two distinct stages of delivery. * `Pickup Available` - Package is available for pickup at carrier location. * `Delivered` - Package has been delivered. * `Re-Routed` - Package has been forwarded. * `Returned to Sender` - Package is to be returned to sender. * `Issue` - Maps to (at least) 15 possible issues, some of which are actionable. + + + + Defines Object + + + + + Enum TrackingEvent for value: tracking_event + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + a Certified letter tracking event (required). + Name of tracking event for Certified letters. Letters sent with USPS Certified Mail are fully tracked by USPS, therefore their tracking events have an additional details object with more detailed information about the tracking event. Some certified tracking event names have multiple meanings, noted in the list here. See the description of the details object for the full set of combined certified tracking event name meanings. * `Mailed` - Package has been accepted into the carrier network for delivery. * `In Transit` - Maps to four distinct stages of transit. * `In Local Area` - Package is at a location near the end destination. * `Processed for Delivery` - Maps to two distinct stages of delivery. * `Pickup Available` - Package is available for pickup at carrier location. * `Delivered` - Package has been delivered. * `Re-Routed` - Package has been forwarded. * `Returned to Sender` - Package is to be returned to sender. * `Issue` - Maps to (at least) 15 possible issues, some of which are actionable. (required). + details. + The zip code in which the event occurred if it exists, otherwise will be the name of a Regional Distribution Center if it exists, otherwise will be null. . + Unique identifier prefixed with `evnt_`. (required). + A timestamp in ISO 8601 format of the date USPS registered the event.. + A timestamp in ISO 8601 format of the date the resource was created. (required). + A timestamp in ISO 8601 format of the date the resource was last modified. (required). + _object (required) (default to ObjectEnum.TrackingEvent). + + + + Gets or Sets Details + + + + + The zip code in which the event occurred if it exists, otherwise will be the name of a Regional Distribution Center if it exists, otherwise will be null. + + The zip code in which the event occurred if it exists, otherwise will be the name of a Regional Distribution Center if it exists, otherwise will be null. + + + + Unique identifier prefixed with `evnt_`. + + Unique identifier prefixed with `evnt_`. + + + + A timestamp in ISO 8601 format of the date USPS registered the event. + + A timestamp in ISO 8601 format of the date USPS registered the event. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TrackingEventCertified instances are equal + + Instance of TrackingEventCertified to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TrackingEventDetails + + + + + Find the full table [here](#tag/Tracking-Events). A detailed substatus about the event: * `package_accepted` - Package has been accepted into the carrier network for delivery. * `package_arrived` - Package has arrived at an intermediate location in the carrier network. * `package_departed` - Package has departed from an intermediate location in the carrier network. * `package_processing` - Package is processing at an intermediate location in the carrier network. * `package_processed` - Package has been processed at an intermediate location. * `package_in_local_area` - Package is at a location near the end destination. * `delivery_scheduled` - Package is scheduled for delivery. * `out_for_delivery` - Package is out for delivery. * `pickup_available` - Package is available for pickup at carrier location. * `delivered` - Package has been delivered. * `package_forwarded` - Package has been forwarded. * `returned_to_sender` - Package is to be returned to sender. * `address_issue` - Address information is incorrect. Contact carrier to ensure delivery. * `contact_carrier` - Contact the carrier for more information. * `delayed` - Delivery of package is delayed. * `delivery_attempted` - Delivery of package has been attempted. Contact carrier to ensure delivery. * `delivery_rescheduled` - Delivery of package has been rescheduled. * `location_inaccessible` - Delivery location inaccessible to carrier. Contact carrier to ensure delivery. * `notice_left` - Carrier left notice during attempted delivery. Follow carrier instructions on notice. * `package_damaged` - Package has been damaged. Contact carrier for more details. * `package_disposed` - Package has been disposed. * `package_held` - Package held at carrier location. Contact carrier for more details. * `package_lost` - Package has been lost. Contact carrier for more details. * `package_unclaimed` - Package is unclaimed. * `package_undeliverable` - Package is not able to be delivered. * `reschedule_delivery` - Contact carrier to reschedule delivery. * `other` - Unrecognized carrier status. + + Find the full table [here](#tag/Tracking-Events). A detailed substatus about the event: * `package_accepted` - Package has been accepted into the carrier network for delivery. * `package_arrived` - Package has arrived at an intermediate location in the carrier network. * `package_departed` - Package has departed from an intermediate location in the carrier network. * `package_processing` - Package is processing at an intermediate location in the carrier network. * `package_processed` - Package has been processed at an intermediate location. * `package_in_local_area` - Package is at a location near the end destination. * `delivery_scheduled` - Package is scheduled for delivery. * `out_for_delivery` - Package is out for delivery. * `pickup_available` - Package is available for pickup at carrier location. * `delivered` - Package has been delivered. * `package_forwarded` - Package has been forwarded. * `returned_to_sender` - Package is to be returned to sender. * `address_issue` - Address information is incorrect. Contact carrier to ensure delivery. * `contact_carrier` - Contact the carrier for more information. * `delayed` - Delivery of package is delayed. * `delivery_attempted` - Delivery of package has been attempted. Contact carrier to ensure delivery. * `delivery_rescheduled` - Delivery of package has been rescheduled. * `location_inaccessible` - Delivery location inaccessible to carrier. Contact carrier to ensure delivery. * `notice_left` - Carrier left notice during attempted delivery. Follow carrier instructions on notice. * `package_damaged` - Package has been damaged. Contact carrier for more details. * `package_disposed` - Package has been disposed. * `package_held` - Package held at carrier location. Contact carrier for more details. * `package_lost` - Package has been lost. Contact carrier for more details. * `package_unclaimed` - Package is unclaimed. * `package_undeliverable` - Package is not able to be delivered. * `reschedule_delivery` - Contact carrier to reschedule delivery. * `other` - Unrecognized carrier status. + + + + Enum PackageAccepted for value: package_accepted + + + + + Enum PackageArrived for value: package_arrived + + + + + Enum PackageDeparted for value: package_departed + + + + + Enum PackageProcessing for value: package_processing + + + + + Enum PackageProcessed for value: package_processed + + + + + Enum PackageInLocalArea for value: package_in_local_area + + + + + Enum DeliveryScheduled for value: delivery_scheduled + + + + + Enum OutForDelivery for value: out_for_delivery + + + + + Enum PickupAvailable for value: pickup_available + + + + + Enum Delivered for value: delivered + + + + + Enum PackageForwarded for value: package_forwarded + + + + + Enum ReturnedToSender for value: returned_to_sender + + + + + Enum AddressIssue for value: address_issue + + + + + Enum ContactCarrier for value: contact_carrier + + + + + Enum Delayed for value: delayed + + + + + Enum DeliveryAttempted for value: delivery_attempted + + + + + Enum DeliveryRescheduled for value: delivery_rescheduled + + + + + Enum LocationInaccessible for value: location_inaccessible + + + + + Enum NoticeLeft for value: notice_left + + + + + Enum PackageDamaged for value: package_damaged + + + + + Enum PackageDisposed for value: package_disposed + + + + + Enum PackageHeld for value: package_held + + + + + Enum PackageLost for value: package_lost + + + + + Enum PackageUnclaimed for value: package_unclaimed + + + + + Enum PackageUndeliverable for value: package_undeliverable + + + + + Enum RescheduleDelivery for value: reschedule_delivery + + + + + Enum Other for value: other + + + + + Find the full table [here](#tag/Tracking-Events). A detailed substatus about the event: * `package_accepted` - Package has been accepted into the carrier network for delivery. * `package_arrived` - Package has arrived at an intermediate location in the carrier network. * `package_departed` - Package has departed from an intermediate location in the carrier network. * `package_processing` - Package is processing at an intermediate location in the carrier network. * `package_processed` - Package has been processed at an intermediate location. * `package_in_local_area` - Package is at a location near the end destination. * `delivery_scheduled` - Package is scheduled for delivery. * `out_for_delivery` - Package is out for delivery. * `pickup_available` - Package is available for pickup at carrier location. * `delivered` - Package has been delivered. * `package_forwarded` - Package has been forwarded. * `returned_to_sender` - Package is to be returned to sender. * `address_issue` - Address information is incorrect. Contact carrier to ensure delivery. * `contact_carrier` - Contact the carrier for more information. * `delayed` - Delivery of package is delayed. * `delivery_attempted` - Delivery of package has been attempted. Contact carrier to ensure delivery. * `delivery_rescheduled` - Delivery of package has been rescheduled. * `location_inaccessible` - Delivery location inaccessible to carrier. Contact carrier to ensure delivery. * `notice_left` - Carrier left notice during attempted delivery. Follow carrier instructions on notice. * `package_damaged` - Package has been damaged. Contact carrier for more details. * `package_disposed` - Package has been disposed. * `package_held` - Package held at carrier location. Contact carrier for more details. * `package_lost` - Package has been lost. Contact carrier for more details. * `package_unclaimed` - Package is unclaimed. * `package_undeliverable` - Package is not able to be delivered. * `reschedule_delivery` - Contact carrier to reschedule delivery. * `other` - Unrecognized carrier status. + + Find the full table [here](#tag/Tracking-Events). A detailed substatus about the event: * `package_accepted` - Package has been accepted into the carrier network for delivery. * `package_arrived` - Package has arrived at an intermediate location in the carrier network. * `package_departed` - Package has departed from an intermediate location in the carrier network. * `package_processing` - Package is processing at an intermediate location in the carrier network. * `package_processed` - Package has been processed at an intermediate location. * `package_in_local_area` - Package is at a location near the end destination. * `delivery_scheduled` - Package is scheduled for delivery. * `out_for_delivery` - Package is out for delivery. * `pickup_available` - Package is available for pickup at carrier location. * `delivered` - Package has been delivered. * `package_forwarded` - Package has been forwarded. * `returned_to_sender` - Package is to be returned to sender. * `address_issue` - Address information is incorrect. Contact carrier to ensure delivery. * `contact_carrier` - Contact the carrier for more information. * `delayed` - Delivery of package is delayed. * `delivery_attempted` - Delivery of package has been attempted. Contact carrier to ensure delivery. * `delivery_rescheduled` - Delivery of package has been rescheduled. * `location_inaccessible` - Delivery location inaccessible to carrier. Contact carrier to ensure delivery. * `notice_left` - Carrier left notice during attempted delivery. Follow carrier instructions on notice. * `package_damaged` - Package has been damaged. Contact carrier for more details. * `package_disposed` - Package has been disposed. * `package_held` - Package held at carrier location. Contact carrier for more details. * `package_lost` - Package has been lost. Contact carrier for more details. * `package_unclaimed` - Package is unclaimed. * `package_undeliverable` - Package is not able to be delivered. * `reschedule_delivery` - Contact carrier to reschedule delivery. * `other` - Unrecognized carrier status. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Find the full table [here](#tag/Tracking-Events). A detailed substatus about the event: * `package_accepted` - Package has been accepted into the carrier network for delivery. * `package_arrived` - Package has arrived at an intermediate location in the carrier network. * `package_departed` - Package has departed from an intermediate location in the carrier network. * `package_processing` - Package is processing at an intermediate location in the carrier network. * `package_processed` - Package has been processed at an intermediate location. * `package_in_local_area` - Package is at a location near the end destination. * `delivery_scheduled` - Package is scheduled for delivery. * `out_for_delivery` - Package is out for delivery. * `pickup_available` - Package is available for pickup at carrier location. * `delivered` - Package has been delivered. * `package_forwarded` - Package has been forwarded. * `returned_to_sender` - Package is to be returned to sender. * `address_issue` - Address information is incorrect. Contact carrier to ensure delivery. * `contact_carrier` - Contact the carrier for more information. * `delayed` - Delivery of package is delayed. * `delivery_attempted` - Delivery of package has been attempted. Contact carrier to ensure delivery. * `delivery_rescheduled` - Delivery of package has been rescheduled. * `location_inaccessible` - Delivery location inaccessible to carrier. Contact carrier to ensure delivery. * `notice_left` - Carrier left notice during attempted delivery. Follow carrier instructions on notice. * `package_damaged` - Package has been damaged. Contact carrier for more details. * `package_disposed` - Package has been disposed. * `package_held` - Package held at carrier location. Contact carrier for more details. * `package_lost` - Package has been lost. Contact carrier for more details. * `package_unclaimed` - Package is unclaimed. * `package_undeliverable` - Package is not able to be delivered. * `reschedule_delivery` - Contact carrier to reschedule delivery. * `other` - Unrecognized carrier status. (required). + The description as listed in the description for event. (required). + Event-specific notes from USPS about the tracking event.. + `true` if action is required by the end recipient, `false` otherwise. (required). + + + + The description as listed in the description for event. + + The description as listed in the description for event. + + + + Event-specific notes from USPS about the tracking event. + + Event-specific notes from USPS about the tracking event. + + + + `true` if action is required by the end recipient, `false` otherwise. + + `true` if action is required by the end recipient, `false` otherwise. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TrackingEventDetails instances are equal + + Instance of TrackingEventDetails to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + TrackingEventNormal + + + + + non-Certified postcards, self mailers, letters, and checks + + non-Certified postcards, self mailers, letters, and checks + + + + Enum Normal for value: normal + + + + + non-Certified postcards, self mailers, letters, and checks + + non-Certified postcards, self mailers, letters, and checks + + + + Name of tracking event (for normal postcards, self mailers, letters, and checks): * `In Transit` - The mailpiece is being processed at the entry/origin facility. * `In Local Area` - The mailpiece is being processed at the destination facility. * `Processed for Delivery` - The mailpiece has been greenlit for delivery at the recipient's nearest postal facility. The mailpiece should reach the mailbox within 1 business day of this tracking event. * `Re-Routed` - The mailpiece is re-routed due to recipient change of address, address errors, or USPS relabeling of barcode/ID tag area. * `Returned to Sender` - The mailpiece is being returned to sender due to barcode, ID tag area, or address errors. * `Mailed` - The mailpiece has been handed off to and accepted by USPS and is en route. [More about Mailed.](https://support.lob.com/hc/en-us/articles/360001724400-What-does-a-Mailed-tracking-event-mean-) Note this data is only available in Enterprise editions of Lob. [Contact Sales](https://lob.com/support/contact#contact) if you want access to this feature. [More about tracking](https://support.lob.com/hc/en-us/articles/115000097404-Can-I-track-my-mail-) + + Name of tracking event (for normal postcards, self mailers, letters, and checks): * `In Transit` - The mailpiece is being processed at the entry/origin facility. * `In Local Area` - The mailpiece is being processed at the destination facility. * `Processed for Delivery` - The mailpiece has been greenlit for delivery at the recipient's nearest postal facility. The mailpiece should reach the mailbox within 1 business day of this tracking event. * `Re-Routed` - The mailpiece is re-routed due to recipient change of address, address errors, or USPS relabeling of barcode/ID tag area. * `Returned to Sender` - The mailpiece is being returned to sender due to barcode, ID tag area, or address errors. * `Mailed` - The mailpiece has been handed off to and accepted by USPS and is en route. [More about Mailed.](https://support.lob.com/hc/en-us/articles/360001724400-What-does-a-Mailed-tracking-event-mean-) Note this data is only available in Enterprise editions of Lob. [Contact Sales](https://lob.com/support/contact#contact) if you want access to this feature. [More about tracking](https://support.lob.com/hc/en-us/articles/115000097404-Can-I-track-my-mail-) + + + + Enum InTransit for value: In Transit + + + + + Enum InLocalArea for value: In Local Area + + + + + Enum ProcessedForDelivery for value: Processed for Delivery + + + + + Enum ReRouted for value: Re-Routed + + + + + Enum ReturnedToSender for value: Returned to Sender + + + + + Enum Mailed for value: Mailed + + + + + Name of tracking event (for normal postcards, self mailers, letters, and checks): * `In Transit` - The mailpiece is being processed at the entry/origin facility. * `In Local Area` - The mailpiece is being processed at the destination facility. * `Processed for Delivery` - The mailpiece has been greenlit for delivery at the recipient's nearest postal facility. The mailpiece should reach the mailbox within 1 business day of this tracking event. * `Re-Routed` - The mailpiece is re-routed due to recipient change of address, address errors, or USPS relabeling of barcode/ID tag area. * `Returned to Sender` - The mailpiece is being returned to sender due to barcode, ID tag area, or address errors. * `Mailed` - The mailpiece has been handed off to and accepted by USPS and is en route. [More about Mailed.](https://support.lob.com/hc/en-us/articles/360001724400-What-does-a-Mailed-tracking-event-mean-) Note this data is only available in Enterprise editions of Lob. [Contact Sales](https://lob.com/support/contact#contact) if you want access to this feature. [More about tracking](https://support.lob.com/hc/en-us/articles/115000097404-Can-I-track-my-mail-) + + Name of tracking event (for normal postcards, self mailers, letters, and checks): * `In Transit` - The mailpiece is being processed at the entry/origin facility. * `In Local Area` - The mailpiece is being processed at the destination facility. * `Processed for Delivery` - The mailpiece has been greenlit for delivery at the recipient's nearest postal facility. The mailpiece should reach the mailbox within 1 business day of this tracking event. * `Re-Routed` - The mailpiece is re-routed due to recipient change of address, address errors, or USPS relabeling of barcode/ID tag area. * `Returned to Sender` - The mailpiece is being returned to sender due to barcode, ID tag area, or address errors. * `Mailed` - The mailpiece has been handed off to and accepted by USPS and is en route. [More about Mailed.](https://support.lob.com/hc/en-us/articles/360001724400-What-does-a-Mailed-tracking-event-mean-) Note this data is only available in Enterprise editions of Lob. [Contact Sales](https://lob.com/support/contact#contact) if you want access to this feature. [More about tracking](https://support.lob.com/hc/en-us/articles/115000097404-Can-I-track-my-mail-) + + + + Will be `null` for `type=normal` events + + Will be `null` for `type=normal` events + + + + Enum Null for value: null + + + + + Will be `null` for `type=normal` events + + Will be `null` for `type=normal` events + + + + Defines Object + + + + + Enum TrackingEvent for value: tracking_event + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + non-Certified postcards, self mailers, letters, and checks (required). + Name of tracking event (for normal postcards, self mailers, letters, and checks): * `In Transit` - The mailpiece is being processed at the entry/origin facility. * `In Local Area` - The mailpiece is being processed at the destination facility. * `Processed for Delivery` - The mailpiece has been greenlit for delivery at the recipient's nearest postal facility. The mailpiece should reach the mailbox within 1 business day of this tracking event. * `Re-Routed` - The mailpiece is re-routed due to recipient change of address, address errors, or USPS relabeling of barcode/ID tag area. * `Returned to Sender` - The mailpiece is being returned to sender due to barcode, ID tag area, or address errors. * `Mailed` - The mailpiece has been handed off to and accepted by USPS and is en route. [More about Mailed.](https://support.lob.com/hc/en-us/articles/360001724400-What-does-a-Mailed-tracking-event-mean-) Note this data is only available in Enterprise editions of Lob. [Contact Sales](https://lob.com/support/contact#contact) if you want access to this feature. [More about tracking](https://support.lob.com/hc/en-us/articles/115000097404-Can-I-track-my-mail-) (required). + Will be `null` for `type=normal` events. + The zip code in which the scan event occurred. Null for `Mailed` events. . + Unique identifier prefixed with `evnt_`.. + A timestamp in ISO 8601 format of the date USPS registered the event.. + A timestamp in ISO 8601 format of the date the resource was created.. + A timestamp in ISO 8601 format of the date the resource was last modified.. + _object (default to ObjectEnum.TrackingEvent). + + + + The zip code in which the scan event occurred. Null for `Mailed` events. + + The zip code in which the scan event occurred. Null for `Mailed` events. + + + + Unique identifier prefixed with `evnt_`. + + Unique identifier prefixed with `evnt_`. + + + + A timestamp in ISO 8601 format of the date USPS registered the event. + + A timestamp in ISO 8601 format of the date USPS registered the event. + + + + A timestamp in ISO 8601 format of the date the resource was created. + + A timestamp in ISO 8601 format of the date the resource was created. + + + + A timestamp in ISO 8601 format of the date the resource was last modified. + + A timestamp in ISO 8601 format of the date the resource was last modified. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if TrackingEventNormal instances are equal + + Instance of TrackingEventNormal to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + UsAutocompletions + + + + + Value is resource type. + + Value is resource type. + + + + Enum UsAutocompletion for value: us_autocompletion + + + + + Value is resource type. + + Value is resource type. + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `us_auto_`.. + An array of objects representing suggested addresses. . + Value is resource type. (default to ObjectEnum.UsAutocompletion). + + + + Unique identifier prefixed with `us_auto_`. + + Unique identifier prefixed with `us_auto_`. + + + + An array of objects representing suggested addresses. + + An array of objects representing suggested addresses. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if UsAutocompletions instances are equal + + Instance of UsAutocompletions to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + UsAutocompletionsWritable + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + Only accepts numbers and street names in an alphanumeric format. (required). + An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations. . + An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations. . + An optional ZIP Code input used to filter suggestions. Matches partial entries. . + If `true`, sort suggestions by proximity to the IP set in the `X-Forwarded-For` header. . + + + + Only accepts numbers and street names in an alphanumeric format. + + Only accepts numbers and street names in an alphanumeric format. + + + + An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations. + + An optional city input used to filter suggestions. Case insensitive and does not match partial abbreviations. + + + + An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations. + + An optional state input used to filter suggestions. Case insensitive and does not match partial abbreviations. + + + + An optional ZIP Code input used to filter suggestions. Matches partial entries. + + An optional ZIP Code input used to filter suggestions. Matches partial entries. + + + + If `true`, sort suggestions by proximity to the IP set in the `X-Forwarded-For` header. + + If `true`, sort suggestions by proximity to the IP set in the `X-Forwarded-For` header. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if UsAutocompletionsWritable instances are equal + + Instance of UsAutocompletionsWritable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A nested object containing a breakdown of each component of an address. + + + + + Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). + + Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). + + + + Enum N for value: N + + + + + Enum S for value: S + + + + + Enum E for value: E + + + + + Enum W for value: W + + + + + Enum NE for value: NE + + + + + Enum SW for value: SW + + + + + Enum SE for value: SE + + + + + Enum NW for value: NW + + + + + Enum Empty for value: + + + + + Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). + + Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). + + + + Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). + + Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). + + + + Enum N for value: N + + + + + Enum S for value: S + + + + + Enum E for value: E + + + + + Enum W for value: W + + + + + Enum NE for value: NE + + + + + Enum SW for value: SW + + + + + Enum SE for value: SE + + + + + Enum NW for value: NW + + + + + Enum Empty for value: + + + + + Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). + + Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). + + + + Uses USPS's [Residential Delivery Indicator (RDI)](https://www.usps.com/nationalpremieraccounts/rdi.htm) to identify whether an address is classified as residential or business. Possible values are: * `residential` –– The address is residential or a PO Box. * `commercial` –– The address is commercial. * `''` –– Not enough information provided to be determined. + + Uses USPS's [Residential Delivery Indicator (RDI)](https://www.usps.com/nationalpremieraccounts/rdi.htm) to identify whether an address is classified as residential or business. Possible values are: * `residential` –– The address is residential or a PO Box. * `commercial` –– The address is commercial. * `''` –– Not enough information provided to be determined. + + + + Enum Residential for value: residential + + + + + Enum Commercial for value: commercial + + + + + Enum Empty for value: + + + + + Uses USPS's [Residential Delivery Indicator (RDI)](https://www.usps.com/nationalpremieraccounts/rdi.htm) to identify whether an address is classified as residential or business. Possible values are: * `residential` –– The address is residential or a PO Box. * `commercial` –– The address is commercial. * `''` –– Not enough information provided to be determined. + + Uses USPS's [Residential Delivery Indicator (RDI)](https://www.usps.com/nationalpremieraccounts/rdi.htm) to identify whether an address is classified as residential or business. Possible values are: * `residential` –– The address is residential or a PO Box. * `commercial` –– The address is commercial. * `''` –– Not enough information provided to be determined. + + + + A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]` is `Y`, `S`, or `D`). For more detailed information about each record type, see [US Verification Details](#tag/US-Verification-Types). + + A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]` is `Y`, `S`, or `D`). For more detailed information about each record type, see [US Verification Details](#tag/US-Verification-Types). + + + + Enum Street for value: street + + + + + Enum Highrise for value: highrise + + + + + Enum Firm for value: firm + + + + + Enum PoBox for value: po_box + + + + + Enum RuralRoute for value: rural_route + + + + + Enum GeneralDelivery for value: general_delivery + + + + + Enum Empty for value: + + + + + A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]` is `Y`, `S`, or `D`). For more detailed information about each record type, see [US Verification Details](#tag/US-Verification-Types). + + A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]` is `Y`, `S`, or `D`). For more detailed information about each record type, see [US Verification Details](#tag/US-Verification-Types). + + + + The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types). + + The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types). + + + + Enum CityDelivery for value: city_delivery + + + + + Enum RuralRoute for value: rural_route + + + + + Enum HighwayContract for value: highway_contract + + + + + Enum PoBox for value: po_box + + + + + Enum GeneralDelivery for value: general_delivery + + + + + Enum Empty for value: + + + + + The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types). + + The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types). + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number. (required). + Geographic direction preceding a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). (required). + The name of the street. (required). + The standard USPS abbreviation for the street suffix (`ST`, `AVE`, `BLVD`, etc). (required). + Geographic direction following a street name (`N`, `S`, `E`, `W`, `NE`, `SW`, `SE`, `NW`). (required). + The standard USPS abbreviation describing the `components[secondary_number]` (`STE`, `APT`, `BLDG`, etc). (required). + Number of the apartment/unit/etc. (required). + Designator of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox. (required). + Number of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox. (required). + An extra (often unnecessary) secondary designator provided with the input address. (required). + An extra (often unnecessary) secondary number provided with the input address. (required). + city (required). + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. (required). + The 5-digit ZIP code (required). + zipCodePlus4 (required). + zipCodeType (required). + A 12-digit identifier that uniquely identifies a delivery point (location where mail can be sent and received). It consists of the 5-digit ZIP code (`zip_code`), 4-digit ZIP+4 add-on (`zip_code_plus_4`), 2-digit delivery point, and 1-digit delivery point check digit. (required). + Uses USPS's [Residential Delivery Indicator (RDI)](https://www.usps.com/nationalpremieraccounts/rdi.htm) to identify whether an address is classified as residential or business. Possible values are: * `residential` –– The address is residential or a PO Box. * `commercial` –– The address is commercial. * `''` –– Not enough information provided to be determined. (required). + A description of the type of address. Populated if a DPV match is made (`deliverability_analysis[dpv_confirmation]` is `Y`, `S`, or `D`). For more detailed information about each record type, see [US Verification Details](#tag/US-Verification-Types). (required). + Designates whether or not the address is the default address for a building containing multiple delivery points. (required). + County name of the address city. (required). + A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. (required). + A 4-character code assigned to a mail delivery route within a ZIP code. (required). + The type of `components[carrier_route]`. For more detailed information about each carrier route type, see [US Verification Details](#tag/US-Verification-Types). (required). + A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). . + A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). . + + + + The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number. + + The numeric or alphanumeric part of an address preceding the street name. Often the house, building, or PO Box number. + + + + The name of the street. + + The name of the street. + + + + The standard USPS abbreviation for the street suffix (`ST`, `AVE`, `BLVD`, etc). + + The standard USPS abbreviation for the street suffix (`ST`, `AVE`, `BLVD`, etc). + + + + The standard USPS abbreviation describing the `components[secondary_number]` (`STE`, `APT`, `BLDG`, etc). + + The standard USPS abbreviation describing the `components[secondary_number]` (`STE`, `APT`, `BLDG`, etc). + + + + Number of the apartment/unit/etc. + + Number of the apartment/unit/etc. + + + + Designator of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox. + + Designator of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox. + + + + Number of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox. + + Number of a [CMRA-authorized](https://en.wikipedia.org/wiki/Commercial_mail_receiving_agency) private mailbox. + + + + An extra (often unnecessary) secondary designator provided with the input address. + + An extra (often unnecessary) secondary designator provided with the input address. + + + + An extra (often unnecessary) secondary number provided with the input address. + + An extra (often unnecessary) secondary number provided with the input address. + + + + Gets or Sets City + + + + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + + + The 5-digit ZIP code + + The 5-digit ZIP code + + + + Gets or Sets ZipCodePlus4 + + + + + Gets or Sets ZipCodeType + + + + + A 12-digit identifier that uniquely identifies a delivery point (location where mail can be sent and received). It consists of the 5-digit ZIP code (`zip_code`), 4-digit ZIP+4 add-on (`zip_code_plus_4`), 2-digit delivery point, and 1-digit delivery point check digit. + + A 12-digit identifier that uniquely identifies a delivery point (location where mail can be sent and received). It consists of the 5-digit ZIP code (`zip_code`), 4-digit ZIP+4 add-on (`zip_code_plus_4`), 2-digit delivery point, and 1-digit delivery point check digit. + + + + Designates whether or not the address is the default address for a building containing multiple delivery points. + + Designates whether or not the address is the default address for a building containing multiple delivery points. + + + + County name of the address city. + + County name of the address city. + + + + A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. + + A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. + + + + A 4-character code assigned to a mail delivery route within a ZIP code. + + A 4-character code assigned to a mail delivery route within a ZIP code. + + + + A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). + + A positive or negative decimal indicating the geographic latitude of the address, specifying the north-to-south position of a location. This should be used with `longitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). + + + + A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). + + A positive or negative decimal indicating the geographic longitude of the address, specifying the north-to-south position of a location. This should be used with `latitude` to pinpoint locations on a map. Will not be returned for undeliverable addresses or military addresses (state is `AA`, `AE`, or `AP`). + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if UsComponents instances are equal + + Instance of UsComponents to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + UsVerification + + + + + 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. + + 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. + + + + Enum Deliverable for value: deliverable + + + + + Enum DeliverableUnnecessaryUnit for value: deliverable_unnecessary_unit + + + + + Enum DeliverableIncorrectUnit for value: deliverable_incorrect_unit + + + + + Enum DeliverableMissingUnit for value: deliverable_missing_unit + + + + + Enum Undeliverable for value: undeliverable + + + + + 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. + + 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. + + + + Defines Object + + + + + Enum UsVerification for value: us_verification + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `us_ver_`.. + 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. . + 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. . + Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) . + 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. . + 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. . + components. + deliverabilityAnalysis. + lobConfidenceScore. + _object (default to ObjectEnum.UsVerification). + + + + Unique identifier prefixed with `us_ver_`. + + Unique identifier prefixed with `us_ver_`. + + + + The intended recipient, typically a person's or firm's name. + + 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 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. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + 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. + + 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. + + + + Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) + + Combination of the following applicable `components`: * City (`city`) * State (`state`) * ZIP code (`zip_code`) * ZIP+4 (`zip_code_plus_4`) + + + + 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. + + 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. + + + + Gets or Sets Components + + + + + Gets or Sets DeliverabilityAnalysis + + + + + Gets or Sets LobConfidenceScore + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if UsVerification instances are equal + + Instance of UsVerification to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A model used to represent an entry in a result list where the entry can either be a us_verification or an Error. The SDK will perform necessary casting into the correct corresponding type. + + + + + Defines Deliverability + + + + + Enum Deliverable for value: deliverable + + + + + Enum DeliverableUnnecessaryUnit for value: deliverable_unnecessary_unit + + + + + Enum DeliverableIncorrectUnit for value: deliverable_incorrect_unit + + + + + Enum DeliverableMissingUnit for value: deliverable_missing_unit + + + + + Enum Undeliverable for value: undeliverable + + + + + Gets or Sets Deliverability + + + + + Defines Object + + + + + Enum UsVerification for value: us_verification + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + Unique identifier prefixed with `us_ver_`.. + 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. . + 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. . + lastLine. + deliverability. + components. + deliverabilityAnalysis. + lobConfidenceScore. + _object (default to ObjectEnum.UsVerification). + error. + + + + Unique identifier prefixed with `us_ver_`. + + Unique identifier prefixed with `us_ver_`. + + + + The intended recipient, typically a person's or firm's name. + + 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 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. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + 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. + + 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. + + + + Gets or Sets LastLine + + + + + Gets or Sets Components + + + + + Gets or Sets DeliverabilityAnalysis + + + + + Gets or Sets LobConfidenceScore + + + + + Gets or Sets Error + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if UsVerificationOrError instances are equal + + Instance of UsVerificationOrError to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + UsVerifications + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + addresses (required). + Indicates whether any errors occurred during the verification process. (required). + + + + Gets or Sets Addresses + + + + + Indicates whether any errors occurred during the verification process. + + Indicates whether any errors occurred during the verification process. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if UsVerifications instances are equal + + Instance of UsVerifications to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + UsVerificationsWritable + + + + + 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 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. . + 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. . + 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`).. + + + + 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., \"210 King Street 94107\"). _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 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 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. + + The secondary delivery line of the address. This field is typically empty but may contain information if `primary_line` is too long. + + + + 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. + + 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. + + + + Gets or Sets 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. + + 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`). + + 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`). + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if UsVerificationsWritable instances are equal + + Instance of UsVerificationsWritable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Zip + + + + + Defines Object + + + + + Enum UsZipLookup for value: us_zip_lookup + + + + + Gets or Sets Object + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + A 5-digit ZIP code.. + Unique identifier prefixed with `us_zip_`. (required). + An array of city objects containing valid cities for the `zip_code`. Multiple cities will be returned if more than one city is associated with the input ZIP code. (required). + zipCodeType (required). + _object (required) (default to ObjectEnum.UsZipLookup). + + + + A 5-digit ZIP code. + + A 5-digit ZIP code. + + + + Unique identifier prefixed with `us_zip_`. + + Unique identifier prefixed with `us_zip_`. + + + + An array of city objects containing valid cities for the `zip_code`. Multiple cities will be returned if more than one city is associated with the input ZIP code. + + An array of city objects containing valid cities for the `zip_code`. Multiple cities will be returned if more than one city is associated with the input ZIP code. + + + + Gets or Sets ZipCodeType + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if Zip instances are equal + + Instance of Zip to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + A description of the ZIP code type. For more detailed information about each ZIP code type, see [US Verification Details](#tag/US-Verification-Types). + + A description of the ZIP code type. For more detailed information about each ZIP code type, see [US Verification Details](#tag/US-Verification-Types). + + + + Enum Standard for value: standard + + + + + Enum PoBox for value: po_box + + + + + Enum Unique for value: unique + + + + + Enum Military for value: military + + + + + Enum Empty for value: + + + + + ZipEditable + + + + + Initializes a new instance of the class. + + A 5-digit ZIP code.. + + + + A 5-digit ZIP code. + + A 5-digit ZIP code. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ZipEditable instances are equal + + Instance of ZipEditable to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ZipLookupCity + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + city (required). + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. (required). + County name of the address city. (required). + A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. (required). + Indicates whether or not the city is the [USPS default city](https://en.wikipedia.org/wiki/ZIP_Code#ZIP_Codes_and_previous_zoning_lines) (preferred city) of a ZIP code. There is only one preferred city per ZIP code, which will always be in position 0 in the array of cities. (required). + + + + Gets or Sets City + + + + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) two letter code for the state. + + + + County name of the address city. + + County name of the address city. + + + + A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. + + A 5-digit [FIPS county code](https://en.wikipedia.org/wiki/FIPS_county_code) which uniquely identifies `components[county]`. It consists of a 2-digit state code and a 3-digit county code. + + + + Indicates whether or not the city is the [USPS default city](https://en.wikipedia.org/wiki/ZIP_Code#ZIP_Codes_and_previous_zoning_lines) (preferred city) of a ZIP code. There is only one preferred city per ZIP code, which will always be in position 0 in the array of cities. + + Indicates whether or not the city is the [USPS default city](https://en.wikipedia.org/wiki/ZIP_Code#ZIP_Codes_and_previous_zoning_lines) (preferred city) of a ZIP code. There is only one preferred city per ZIP code, which will always be in position 0 in the array of cities. + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ZipLookupCity instances are equal + + Instance of ZipLookupCity to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + diff --git a/local-nuget/lob.dotnet/1.1.0/lob.dotnet.1.1.0.nupkg.sha512 b/local-nuget/lob.dotnet/1.1.0/lob.dotnet.1.1.0.nupkg.sha512 new file mode 100644 index 0000000..9262b57 --- /dev/null +++ b/local-nuget/lob.dotnet/1.1.0/lob.dotnet.1.1.0.nupkg.sha512 @@ -0,0 +1 @@ +N9hTKyTLVAHiBtiYuP9JJOGwr6H7cUlzJxjzufGrO3c71bXo0Pu6TvFEsuEDzNnQvPX+lNLDtIApxRyHWi3Gfw== \ No newline at end of file diff --git a/local-nuget/lob.dotnet/1.1.0/lob.dotnet.nuspec b/local-nuget/lob.dotnet/1.1.0/lob.dotnet.nuspec new file mode 100755 index 0000000..dcb0aaf --- /dev/null +++ b/local-nuget/lob.dotnet/1.1.0/lob.dotnet.nuspec @@ -0,0 +1,26 @@ + + + + lob.dotnet + 1.1.0 + lob + false + MIT + https://licenses.nuget.org/MIT + https://github.com/lob/lob-dotnet + https://assets-global.website-files.com/5e1e5c62fa3d4447af417098/5e3a2c100e42b0337dd413c3_Logo.svg + A library generated from a OpenAPI spec for the Csharp language + Beta Release + address verification address validation address autocomplete lob lob.com + + + + + + + + + + + + \ No newline at end of file