avalara_sdk 2.4.5.6

data/docs/AgeVerificationApi.md

@@ -0,0 +1,87 @@
+# AvalaraSdk::AgeVerificationApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**verify_age**](AgeVerificationApi.md#verify_age) | **POST** /api/v2/ageverification/verify | Determines whether an individual meets or exceeds the minimum legal drinking age. |
+
+
+## verify_age
+
+> <AgeVerifyResult> verify_age(age_verify_request, opts)
+
+Determines whether an individual meets or exceeds the minimum legal drinking age.
+
+The request must meet the following criteria in order to be evaluated: * *firstName*, *lastName*, and *address* are required fields. * One of the following sets of attributes are required for the *address*:   * *line1, city, region*   * *line1, postalCode*  Optionally, the transaction and its lines may use the following parameters: * A *DOB* (Date of Birth) field. The value should be ISO-8601 compliant (e.g. 2020-07-21). * Beyond the required *address* fields above, a *country* field is permitted   * The valid values for this attribute are [*US, USA*]  **Security Policies** This API depends on the active subscription *AgeVerification*
+
+### Examples
+
+```ruby
+require 'time'
+require 'avalara_sdk'
+# setup authorization
+AvalaraSdk.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Bearer
+  config.api_key['Bearer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Bearer'] = 'Bearer'
+end
+
+api_instance = AvalaraSdk::AgeVerificationApi.new
+age_verify_request = AvalaraSdk::AgeVerifyRequest.new # AgeVerifyRequest | Information about the individual whose age is being verified.
+opts = {
+  simulated_failure_code: AvalaraSdk::AgeVerifyFailureCode::NOT_FOUND # AgeVerifyFailureCode | (Optional) The failure code included in the simulated response of the endpoint. Note that this endpoint is only available in Sandbox for testing purposes.
+}
+
+begin
+  # Determines whether an individual meets or exceeds the minimum legal drinking age.
+  result = api_instance.verify_age(age_verify_request, opts)
+  p result
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling AgeVerificationApi->verify_age: #{e}"
+end
+```
+
+#### Using the verify_age_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AgeVerifyResult>, Integer, Hash)> verify_age_with_http_info(age_verify_request, opts)
+
+```ruby
+begin
+  # Determines whether an individual meets or exceeds the minimum legal drinking age.
+  data, status_code, headers = api_instance.verify_age_with_http_info(age_verify_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AgeVerifyResult>
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling AgeVerificationApi->verify_age_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **age_verify_request** | [**AgeVerifyRequest**](AgeVerifyRequest.md) | Information about the individual whose age is being verified. |  |
+| **simulated_failure_code** | [**AgeVerifyFailureCode**](.md) | (Optional) The failure code included in the simulated response of the endpoint. Note that this endpoint is only available in Sandbox for testing purposes. | [optional] |
+
+### Return type
+
+[**AgeVerifyResult**](AgeVerifyResult.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AgeVerifyFailureCode.md

@@ -0,0 +1,15 @@
+# AvalaraSdk::AgeVerifyFailureCode
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::AgeVerifyFailureCode.new()
+```
+

data/docs/AgeVerifyRequest.md

@@ -0,0 +1,24 @@
+# AvalaraSdk::AgeVerifyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **address** | [**AgeVerifyRequestAddress**](AgeVerifyRequestAddress.md) |  | [optional] |
+| **dob** | **String** | The value should be ISO-8601 compliant (e.g. 2020-07-21). | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::AgeVerifyRequest.new(
+  first_name: null,
+  last_name: null,
+  address: null,
+  dob: null
+)
+```
+

data/docs/AgeVerifyRequestAddress.md

@@ -0,0 +1,26 @@
+# AvalaraSdk::AgeVerifyRequestAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **line1** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **region** | **String** | The state code of the address. | [optional] |
+| **country** | **String** | The country code of the address. | [optional] |
+| **postal_code** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::AgeVerifyRequestAddress.new(
+  line1: null,
+  city: null,
+  region: null,
+  country: null,
+  postal_code: null
+)
+```
+

data/docs/AgeVerifyResult.md

@@ -0,0 +1,20 @@
+# AvalaraSdk::AgeVerifyResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **is_of_age** | **Boolean** | Describes whether the individual meets or exceeds the minimum legal drinking age. | [optional] |
+| **failure_codes** | [**Array<AgeVerifyResult>**](AgeVerifyResult.md) | A list of failure codes describing why a *false* age determination was made. | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::AgeVerifyResult.new(
+  is_of_age: null,
+  failure_codes: null
+)
+```
+

data/docs/ErrorDetails.md

@@ -0,0 +1,18 @@
+# AvalaraSdk::ErrorDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorDetailsError**](ErrorDetailsError.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::ErrorDetails.new(
+  error: null
+)
+```
+

data/docs/ErrorDetailsError.md

@@ -0,0 +1,22 @@
+# AvalaraSdk::ErrorDetailsError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Name of the error or message. | [optional] |
+| **message** | **String** | Concise summary of the message, suitable for display in the caption of an alert box. | [optional] |
+| **details** | [**ErrorDetailsErrorDetails**](ErrorDetailsErrorDetails.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::ErrorDetailsError.new(
+  code: InvalidAddress,
+  message: The address is not deliverable.,
+  details: null
+)
+```
+

data/docs/ErrorDetailsErrorDetails.md

@@ -0,0 +1,30 @@
+# AvalaraSdk::ErrorDetailsErrorDetails
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Name of the error or message. | [optional] |
+| **message** | **String** | Concise summary of the message, suitable for display in the caption of an alert box. | [optional] |
+| **number** | **Integer** | Unique ID number referring to this error or message. | [optional] |
+| **description** | **String** | A more detailed description of the problem referenced by this error message, suitable for display in the contents area of an alert box. | [optional] |
+| **fault_code** | **String** | Indicates the SOAP Fault code, if this was related to an error that corresponded to AvaTax SOAP v1 behavior. | [optional] |
+| **help_link** | **String** | URL to help for this message | [optional] |
+| **severity** | **String** | Severity of the message | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::ErrorDetailsErrorDetails.new(
+  code: InvalidAddress,
+  message: The address is not deliverable.,
+  number: 309,
+  description: The physical location exists but there are no homes on this street. One reason might be railroad tracks or rivers running alongside this street, as they would prevent construction of homes in this location.,
+  fault_code: Client,
+  help_link: http://developer.avalara.com/avatax/errors/InvalidAddress,
+  severity: Error
+)
+```
+

data/docs/ShippingVerificationApi.md

@@ -0,0 +1,327 @@
+# AvalaraSdk::ShippingVerificationApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**deregister_shipment**](ShippingVerificationApi.md#deregister_shipment) | **DELETE** /api/v2/companies/{companyCode}/transactions/{transactionCode}/shipment/registration | Removes the transaction from consideration when evaluating regulations that span multiple transactions. |
+| [**register_shipment**](ShippingVerificationApi.md#register_shipment) | **PUT** /api/v2/companies/{companyCode}/transactions/{transactionCode}/shipment/registration | Registers the transaction so that it may be included when evaluating regulations that span multiple transactions. |
+| [**register_shipment_if_compliant**](ShippingVerificationApi.md#register_shipment_if_compliant) | **PUT** /api/v2/companies/{companyCode}/transactions/{transactionCode}/shipment/registerIfCompliant | Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions. |
+| [**verify_shipment**](ShippingVerificationApi.md#verify_shipment) | **GET** /api/v2/companies/{companyCode}/transactions/{transactionCode}/shipment/verify | Evaluates a transaction against a set of direct-to-consumer shipping regulations. |
+
+
+## deregister_shipment
+
+> deregister_shipment(company_code, transaction_code, opts)
+
+Removes the transaction from consideration when evaluating regulations that span multiple transactions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'avalara_sdk'
+# setup authorization
+AvalaraSdk.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Bearer
+  config.api_key['Bearer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Bearer'] = 'Bearer'
+end
+
+api_instance = AvalaraSdk::ShippingVerificationApi.new
+company_code = 'company_code_example' # String | The company code of the company that recorded the transaction
+transaction_code = 'transaction_code_example' # String | The transaction code to retrieve
+opts = {
+  document_type: 'SalesInvoice' # String | (Optional): The document type of the transaction to operate on. If omitted, defaults to \"SalesInvoice\"
+}
+
+begin
+  # Removes the transaction from consideration when evaluating regulations that span multiple transactions.
+  api_instance.deregister_shipment(company_code, transaction_code, opts)
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling ShippingVerificationApi->deregister_shipment: #{e}"
+end
+```
+
+#### Using the deregister_shipment_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> deregister_shipment_with_http_info(company_code, transaction_code, opts)
+
+```ruby
+begin
+  # Removes the transaction from consideration when evaluating regulations that span multiple transactions.
+  data, status_code, headers = api_instance.deregister_shipment_with_http_info(company_code, transaction_code, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling ShippingVerificationApi->deregister_shipment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_code** | **String** | The company code of the company that recorded the transaction |  |
+| **transaction_code** | **String** | The transaction code to retrieve |  |
+| **document_type** | **String** | (Optional): The document type of the transaction to operate on. If omitted, defaults to \&quot;SalesInvoice\&quot; | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## register_shipment
+
+> register_shipment(company_code, transaction_code, opts)
+
+Registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'avalara_sdk'
+# setup authorization
+AvalaraSdk.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Bearer
+  config.api_key['Bearer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Bearer'] = 'Bearer'
+end
+
+api_instance = AvalaraSdk::ShippingVerificationApi.new
+company_code = 'company_code_example' # String | The company code of the company that recorded the transaction
+transaction_code = 'transaction_code_example' # String | The transaction code to retrieve
+opts = {
+  document_type: 'SalesInvoice' # String | (Optional): The document type of the transaction to operate on. If omitted, defaults to \"SalesInvoice\"
+}
+
+begin
+  # Registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+  api_instance.register_shipment(company_code, transaction_code, opts)
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling ShippingVerificationApi->register_shipment: #{e}"
+end
+```
+
+#### Using the register_shipment_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> register_shipment_with_http_info(company_code, transaction_code, opts)
+
+```ruby
+begin
+  # Registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+  data, status_code, headers = api_instance.register_shipment_with_http_info(company_code, transaction_code, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling ShippingVerificationApi->register_shipment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_code** | **String** | The company code of the company that recorded the transaction |  |
+| **transaction_code** | **String** | The transaction code to retrieve |  |
+| **document_type** | **String** | (Optional): The document type of the transaction to operate on. If omitted, defaults to \&quot;SalesInvoice\&quot; | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## register_shipment_if_compliant
+
+> <ShippingVerifyResult> register_shipment_if_compliant(company_code, transaction_code, opts)
+
+Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'avalara_sdk'
+# setup authorization
+AvalaraSdk.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Bearer
+  config.api_key['Bearer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Bearer'] = 'Bearer'
+end
+
+api_instance = AvalaraSdk::ShippingVerificationApi.new
+company_code = 'company_code_example' # String | The company code of the company that recorded the transaction
+transaction_code = 'transaction_code_example' # String | The transaction code to retrieve
+opts = {
+  document_type: 'SalesInvoice' # String | (Optional): The document type of the transaction to operate on. If omitted, defaults to \"SalesInvoice\"
+}
+
+begin
+  # Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+  result = api_instance.register_shipment_if_compliant(company_code, transaction_code, opts)
+  p result
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling ShippingVerificationApi->register_shipment_if_compliant: #{e}"
+end
+```
+
+#### Using the register_shipment_if_compliant_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ShippingVerifyResult>, Integer, Hash)> register_shipment_if_compliant_with_http_info(company_code, transaction_code, opts)
+
+```ruby
+begin
+  # Evaluates a transaction against a set of direct-to-consumer shipping regulations and, if compliant, registers the transaction so that it may be included when evaluating regulations that span multiple transactions.
+  data, status_code, headers = api_instance.register_shipment_if_compliant_with_http_info(company_code, transaction_code, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ShippingVerifyResult>
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling ShippingVerificationApi->register_shipment_if_compliant_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_code** | **String** | The company code of the company that recorded the transaction |  |
+| **transaction_code** | **String** | The transaction code to retrieve |  |
+| **document_type** | **String** | (Optional): The document type of the transaction to operate on. If omitted, defaults to \&quot;SalesInvoice\&quot; | [optional] |
+
+### Return type
+
+[**ShippingVerifyResult**](ShippingVerifyResult.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## verify_shipment
+
+> <ShippingVerifyResult> verify_shipment(company_code, transaction_code, opts)
+
+Evaluates a transaction against a set of direct-to-consumer shipping regulations.
+
+The transaction and its lines must meet the following criteria in order to be evaluated: * The transaction must be recorded. Using a type of *SalesInvoice* is recommended. * A parameter with the name *AlcoholRouteType* must be specified and the value must be one of the following: '*DTC*', '*Retailer DTC*' * A parameter with the name *RecipientName* must be specified and the value must be the name of the recipient. * Each alcohol line must include a *ContainerSize* parameter that describes the volume of a single container. Use the *unit* field to specify one of the following units: '*Litre*', '*Millilitre*', '*gallon (US fluid)*', '*quart (US fluid)*', '*ounce (fluid US customary)*' * Each alcohol line must include a *PackSize* parameter that describes the number of containers in a pack. Specify *Count* in the *unit* field.  Optionally, the transaction and its lines may use the following parameters: * The *ShipDate* parameter may be used if the date of shipment is different than the date of the transaction. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *RecipientDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *PurchaserDOB* parameter may be used to evaluate age restrictions. The value should be ISO-8601 compliant (e.g. 2020-07-21). * The *SalesLocation* parameter may be used to describe whether the sale was made *OnSite* or *OffSite*. *OffSite* is the default value. * The *AlcoholContent* parameter may be used to describe the alcohol percentage by volume of the item. Specify *Percentage* in the *unit* field.  **Security Policies** This API depends on all of the following active subscriptions: *AvaAlcohol, AutoAddress, AvaTaxPro*
+
+### Examples
+
+```ruby
+require 'time'
+require 'avalara_sdk'
+# setup authorization
+AvalaraSdk.configure do |config|
+  # Configure HTTP basic authorization: BasicAuth
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+
+  # Configure API key authorization: Bearer
+  config.api_key['Bearer'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Bearer'] = 'Bearer'
+end
+
+api_instance = AvalaraSdk::ShippingVerificationApi.new
+company_code = 'company_code_example' # String | The company code of the company that recorded the transaction
+transaction_code = 'transaction_code_example' # String | The transaction code to retrieve
+opts = {
+  document_type: 'SalesInvoice' # String | (Optional): The document type of the transaction to operate on. If omitted, defaults to \"SalesInvoice\"
+}
+
+begin
+  # Evaluates a transaction against a set of direct-to-consumer shipping regulations.
+  result = api_instance.verify_shipment(company_code, transaction_code, opts)
+  p result
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling ShippingVerificationApi->verify_shipment: #{e}"
+end
+```
+
+#### Using the verify_shipment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ShippingVerifyResult>, Integer, Hash)> verify_shipment_with_http_info(company_code, transaction_code, opts)
+
+```ruby
+begin
+  # Evaluates a transaction against a set of direct-to-consumer shipping regulations.
+  data, status_code, headers = api_instance.verify_shipment_with_http_info(company_code, transaction_code, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ShippingVerifyResult>
+rescue AvalaraSdk::ApiError => e
+  puts "Error when calling ShippingVerificationApi->verify_shipment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_code** | **String** | The company code of the company that recorded the transaction |  |
+| **transaction_code** | **String** | The transaction code to retrieve |  |
+| **document_type** | **String** | (Optional): The document type of the transaction to operate on. If omitted, defaults to \&quot;SalesInvoice\&quot; | [optional] |
+
+### Return type
+
+[**ShippingVerifyResult**](ShippingVerifyResult.md)
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ShippingVerifyResult.md

@@ -0,0 +1,30 @@
+# AvalaraSdk::ShippingVerifyResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **compliant** | **Boolean** | Whether every line in the transaction is compliant. | [optional] |
+| **message** | **String** | A short description of the result of the compliance check. | [optional] |
+| **success_messages** | **String** | A detailed description of the result of each of the passed checks made against this transaction, separated by line. | [optional] |
+| **failure_messages** | **String** | A detailed description of the result of each of the failed checks made against this transaction, separated by line. | [optional] |
+| **failure_codes** | **Array<String>** | An enumeration of all the failure codes received across all lines. | [optional] |
+| **warning_codes** | **Array<String>** | An enumeration of all the warning codes received across all lines that a determination could not be made for. | [optional] |
+| **lines** | [**Array<ShippingVerifyResultLines>**](ShippingVerifyResultLines.md) | Describes the results of the checks made for each line in the transaction. | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::ShippingVerifyResult.new(
+  compliant: null,
+  message: null,
+  success_messages: null,
+  failure_messages: null,
+  failure_codes: null,
+  warning_codes: null,
+  lines: null
+)
+```
+

data/docs/ShippingVerifyResultLines.md

@@ -0,0 +1,28 @@
+# AvalaraSdk::ShippingVerifyResultLines
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **result_code** | **String** | Describes whether the line is compliant or not. In cases where a determination could not be made, resultCode will provide the reason why. | [optional] |
+| **line_number** | **String** | The lineNumber of the line evaluated. | [optional] |
+| **message** | **String** | A short description of the result of the checks made against this line. | [optional] |
+| **success_messages** | **String** | A detailed description of the result of each of the passed checks made against this line. | [optional] |
+| **failure_messages** | **String** | A detailed description of the result of each of the failed checks made against this line. | [optional] |
+| **failure_codes** | **Array<String>** | An enumeration of all the failure codes received for this line. | [optional] |
+
+## Example
+
+```ruby
+require 'avalara_sdk'
+
+instance = AvalaraSdk::ShippingVerifyResultLines.new(
+  result_code: null,
+  line_number: null,
+  message: null,
+  success_messages: null,
+  failure_messages: null,
+  failure_codes: null
+)
+```
+

data/example/test.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../../lib/avalara_sdk', __FILE__)
+
+  config = AvalaraSdk::Configuration.new  
+  config.username = ''
+  config.password = ''
+  config.environment='test'
+  config.test_url='https://sandbox-rest.avatax.com'
+  config.verify_ssl=false
+  config.debugging=true
+  config.app_name="testApp"
+  config.app_version="2.3.1"
+  config.machine_name="AVL_WIN_007"
+  api_client = AvalaraSdk::ApiClient.new config
+  api_instance = AvalaraSdk::ShippingVerificationApi.new api_client
+
+  begin
+    result =api_instance.deregister_shipment('DEFAULT', '063e1af4-11d3-4489-b8ba-ae1149758df4')
+    p result
+    puts "Call Completed" 
+    
+  rescue AvalaraSdk::ApiError => e
+    puts "Exception #{e}"
+  end
+
+  puts "Success"