avatax 18.7.1 → 18.9.0

data/lib/avatax/client/settings.rb

@@ -84,8 +84,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns these settings
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_settings_by_company(companyId, options={})
@@ -111,8 +111,8 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_settings(options={})

data/lib/avatax/client/subscriptions.rb

@@ -27,8 +27,8 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param accountId [Integer] The ID of the account that owns these subscriptions
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_subscriptions_by_account(accountId, options={})
@@ -46,8 +46,8 @@ module AvaTax
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_subscriptions(options={})

data/lib/avatax/client/taxcodes.rb

@@ -60,8 +60,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns these tax codes
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_tax_codes_by_company(companyId, options={})
@@ -82,8 +82,8 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_tax_codes(options={})

data/lib/avatax/client/taxcontent.rb

@@ -7,6 +7,12 @@ module AvaTax
       #
       # Builds a tax content file containing information useful for a retail point-of-sale solution.
       #
+      # Since tax rates may change based on decisions made by a variety of tax authorities, we recommend
+      # that users of this tax content API download new data every day. Many tax authorities may finalize
+      # decisions on tax changes at unexpected times and may make changes in response to legal issues or
+      # governmental priorities. Any tax content downloaded for future time periods is subject to change
+      # if tax rates or tax laws change.
+      #
       # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
       # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
       # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
@@ -34,6 +40,12 @@ module AvaTax
       #
       # Builds a tax content file containing information useful for a retail point-of-sale solution.
       #
+      # Since tax rates may change based on decisions made by a variety of tax authorities, we recommend
+      # that users of this tax content API download new data every day. Many tax authorities may finalize
+      # decisions on tax changes at unexpected times and may make changes in response to legal issues or
+      # governmental priorities. Any tax content downloaded for future time periods is subject to change
+      # if tax rates or tax laws change.
+      #
       # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
       # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
       # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
@@ -54,7 +66,7 @@ module AvaTax
       # @param date [DateTime] The date for which point-of-sale data would be calculated (today by default)
       # @param format [String] The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)
       # @param partnerId [String] If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values)
-      # @param includeJurisCodes [object] When true, the file will include jurisdiction codes in the result.
+      # @param includeJurisCodes [Boolean] When true, the file will include jurisdiction codes in the result.
       # @return [Object]
       def build_tax_content_file_for_location(companyId, id, options={})
         path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
@@ -67,6 +79,12 @@ module AvaTax
       # Download a CSV file containing all five digit postal codes in the United States and their sales
       # and use tax rates for tangible personal property.
       #
+      # Since tax rates may change based on decisions made by a variety of tax authorities, we recommend
+      # that users of this tax content API download new data every day. Many tax authorities may finalize
+      # decisions on tax changes at unexpected times and may make changes in response to legal issues or
+      # governmental priorities. Any tax content downloaded for future time periods is subject to change
+      # if tax rates or tax laws change.
+      #
       # This rates file is intended to be used as a default for tax calculation when your software cannot
       # call the `CreateTransaction` API call. When using this file, your software will be unable to
       # handle complex tax rules such as:

data/lib/avatax/client/taxrules.rb

@@ -5,11 +5,19 @@ module AvaTax
 
       # Create a new tax rule
       #
-      # Create one or more new taxrule objects attached to this company.
-      # A tax rule represents a custom taxability rule for a product or service sold by your company.
-      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
-      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
-      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
+      # Create one or more custom tax rules attached to this company.
+      #
+      # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
+      # can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your
+      # auditor, legal representative, and accounting team.
       # @param companyId [Integer] The ID of the company that owns this tax rule.
       # @param model [TaxRuleModel[]] The tax rule you wish to create.
       # @return [TaxRuleModel[]]
@@ -21,7 +29,19 @@ module AvaTax
 
       # Delete a single tax rule
       #
-      # Mark the TaxRule identified by this URL as deleted.
+      # Mark the custom tax rule identified by this URL as deleted.
+      #
+      # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
+      # can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your
+      # auditor, legal representative, and accounting team.
       # @param companyId [Integer] The ID of the company that owns this tax rule.
       # @param id [Integer] The ID of the tax rule you wish to delete.
       # @return [ErrorDetail[]]
@@ -34,10 +54,18 @@ module AvaTax
       # Retrieve a single tax rule
       #
       # Get the taxrule object identified by this URL.
-      # A tax rule represents a custom taxability rule for a product or service sold by your company.
-      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
-      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
-      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
+      #
+      # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
+      # can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your
+      # auditor, legal representative, and accounting team.
       # @param companyId [Integer] The ID of the company that owns this tax rule
       # @param id [Integer] The primary key of this tax rule
       # @return [Object]
@@ -50,18 +78,26 @@ module AvaTax
       # Retrieve tax rules for this company
       #
       # List all taxrule objects attached to this company.
-      # A tax rule represents a custom taxability rule for a product or service sold by your company.
-      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
-      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
-      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
+      #
+      # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
+      # can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your
+      # auditor, legal representative, and accounting team.
       #
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param companyId [Integer] The ID of the company that owns these tax rules
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_tax_rules(companyId, options={})
@@ -73,17 +109,25 @@ module AvaTax
       # Retrieve all tax rules
       #
       # Get multiple taxrule objects across all companies.
-      # A tax rule represents a custom taxability rule for a product or service sold by your company.
-      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
-      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
-      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
+      #
+      # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
+      # can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your
+      # auditor, legal representative, and accounting team.
       #
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_tax_rules(options={})
@@ -94,13 +138,19 @@ module AvaTax
 
       # Update a single tax rule
       #
-      # Replace the existing taxrule object at this URL with an updated object.
-      # A tax rule represents a custom taxability rule for a product or service sold by your company.
-      # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
-      # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
-      # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
-      # All data from the existing object will be replaced with data in the object you PUT.
-      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
+      # Replace the existing custom tax rule object at this URL with an updated object.
+      #
+      # A tax rule represents a rule that changes the default AvaTax behavior for a product or jurisdiction. Custom tax rules
+      # can be used to change the taxability of an item, to change the tax base of an item, or to change the tax rate
+      # charged when selling an item. Tax rules can also change tax behavior depending on the `entityUseCode` value submitted
+      # with the transaction.
+      #
+      # You can create custom tax rules to customize the behavior of AvaTax to match specific rules that are custom to your
+      # business. If you have obtained a ruling from a tax auditor that requires custom tax calculations, you can use
+      # custom tax rules to redefine the behavior for your company or item.
+      #
+      # Please use custom tax rules carefully and ensure that these tax rules match the behavior agreed upon with your
+      # auditor, legal representative, and accounting team.
       # @param companyId [Integer] The ID of the company that this tax rule belongs to.
       # @param id [Integer] The ID of the tax rule you wish to update
       # @param model [Object] The tax rule you wish to update.

data/lib/avatax/client/transactions.rb

@@ -248,6 +248,7 @@ module AvaTax
       # * SummaryOnly (omit lines and details - reduces API response size)
       # * LinesOnly (omit details - reduces API response size)
       # * ForceTimeout - Simulates a timeout. This adds a 30 second delay and error to your API call. This can be used to test your code to ensure it can respond correctly in the case of a dropped connection.
+      # * TaxDetailsByTaxType - Includes the aggregated tax, exempt tax, taxable and non-taxable for each tax type returned in the transaction summary.
       #
       # If you omit the `$include` parameter, the API will assume you want `Summary,Addresses`.
       # @param include [String] Specifies objects to include in the response after transaction is created
@@ -385,8 +386,8 @@ module AvaTax
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param include [String] Specifies objects to include in this fetch call
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_transactions_by_company(companyCode, options={})
@@ -456,7 +457,7 @@ module AvaTax
       # @param transactionCode [String] The transaction code of the original sale
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param documentType [String] (Optional): The document type of the transaction to refund. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
-      # @param useTaxDateOverride [object] (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).
+      # @param useTaxDateOverride [Boolean] (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).
       # @param model [Object] Information about the refund to create
       # @return [Object]
       def refund_transaction(companyCode, transactionCode, model, options={})

data/lib/avatax/client/upcs.rb

@@ -51,8 +51,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns these UPCs
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_u_p_cs_by_company(companyId, options={})
@@ -70,8 +70,8 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # @param include [String] A comma separated list of additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_u_p_cs(options={})

data/lib/avatax/client/users.rb

@@ -3,6 +3,23 @@ module AvaTax
     module Users 
 
 
+      # Change Password
+      #
+      # Allows a user to change their password via an API call.
+      #
+      # This API allows an authenticated user to change their password via an API call. This feature is only available
+      # for accounts that do not use SAML integrated password validation.
+      #
+      # This API only allows the currently authenticated user to change their password; it cannot be used to apply to a
+      # different user than the one authenticating the current API call.
+      # @param model [Object] An object containing your current password and the new password.
+      # @return [String]
+      def change_password(model)
+        path = "/api/v2/passwords"
+        put(path, model)
+      end
+
+
       # Create new users
       #
       # Create one or more new user objects attached to this account.
@@ -23,6 +40,23 @@ module AvaTax
       end
 
 
+      # Delete a single user
+      #
+      # Mark the user object identified by this URL as deleted.
+      #
+      # This API is available for use by account and company administrators only.
+      #
+      # Account and company administrators may only delete users within the appropriate organizations
+      # they control.
+      # @param id [Integer] The ID of the user you wish to delete.
+      # @param accountId [Integer] The accountID of the user you wish to delete.
+      # @return [ErrorDetail[]]
+      def delete_user(id, accountId)
+        path = "/api/v2/accounts/#{accountId}/users/#{id}"
+        delete(path)
+      end
+
+
       # Retrieve a single user
       #
       # Get the user object identified by this URL.
@@ -63,20 +97,6 @@ module AvaTax
       end
 
 
-      # Get information about a username.
-      #
-      # You may call this API prior to creating a user, to check if a particular username is available for use. Using this API, you can
-      # present a friendly experience prior to attempting to create a new user object.
-      #
-      # Please ensure that the query string is url encoded if you wish to check information for a user that contains url-sensitive characters.
-      # @param username [String] The username to search.
-      # @return [Object]
-      def get_username(options={})
-        path = "/api/v2/usernames"
-        get(path, options)
-      end
-
-
       # Retrieve users for this account
       #
       # List all user objects attached to this account.
@@ -90,8 +110,8 @@ module AvaTax
       # @param accountId [Integer] The accountID of the user you wish to list.
       # @param include [String] Optional fetch commands.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_users_by_account(accountId, options={})
@@ -114,8 +134,8 @@ module AvaTax
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # @param include [String] Optional fetch commands.
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_users(options={})

data/lib/avatax/client/utilities.rb

@@ -6,8 +6,13 @@ module AvaTax
       # Checks if the current user is subscribed to a specific service
       #
       # Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account.
-      # This API call is intended to allow you to identify whether you have the necessary account configuration to access certain
-      # features of AvaTax, and would be useful in debugging access privilege problems.
+      #
+      # This API will return an error if it is called with invalid authentication credentials.
+      #
+      # This API is intended to help you determine whether you have the necessary subscription to use certain API calls
+      # within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product
+      # or subscription to provide useful information to the current user as to whether they are entitled to use
+      # specific features of AvaTax.
       # @param serviceTypeId [String] The service to check (See ServiceTypeId::* for a list of allowable values)
       # @return [Object]
       def get_my_subscription(serviceTypeId)
@@ -18,9 +23,14 @@ module AvaTax
 
       # List all services to which the current user is subscribed
       #
-      # Returns the list of all subscriptions enabled for the current account.
+      # Returns the list of all subscriptions enabled for the currently logged in user.
+      #
+      # This API will return an error if it is called with invalid authentication credentials.
+      #
       # This API is intended to help you determine whether you have the necessary subscription to use certain API calls
-      # within AvaTax.
+      # within AvaTax. You can examine the subscriptions returned from this API call to look for a particular product
+      # or subscription to provide useful information to the current user as to whether they are entitled to use
+      # specific features of AvaTax.
       # @return [FetchResult]
       def list_my_subscriptions()
         path = "/api/v2/utilities/subscriptions"
@@ -30,11 +40,22 @@ module AvaTax
 
       # Tests connectivity and version of the service
       #
+      # Check connectivity to AvaTax and return information about the AvaTax API server.
+      #
+      # This API is intended to help you verify that your connection is working. This API will always succeed and will
+      # never return a error. It provides basic information about the server you connect to:
+      #
+      # * `version` - The version number of the AvaTax API server that responded to your request. The AvaTax API version number is updated once per month during Avalara's update process.
+      # * `authenticated` - A boolean flag indicating whether or not you sent valid credentials with your API request.
+      # * `authenticationType` - If you provided valid credentials to the API, this field will tell you whether you used Bearer, Username, or LicenseKey authentication.
+      # * `authenticatedUserName` - If you provided valid credentials to the API, this field will tell you the username of the currently logged in user.
+      # * `authenticatedUserId` - If you provided valid credentials to the API, this field will tell you the user ID of the currently logged in user.
+      # * `authenticatedAccountId` - If you provided valid credentials to the API, this field will contain the account ID of the currently logged in user.
+      #
       # This API helps diagnose connectivity problems between your application and AvaTax; you may call this API even
-      # if you do not have verified connection credentials.
-      # The results of this API call will help you determine whether your computer can contact AvaTax via the network,
-      # whether your authentication credentials are recognized, and the roundtrip time it takes to communicate with
-      # AvaTax.
+      # if you do not have verified connection credentials. If this API fails, either your computer is not connected to
+      # the internet, or there is a routing problem between your office and Avalara, or the Avalara server is not available.
+      # For more information on the uptime of AvaTax, please see [Avalara's AvaTax Status Page](https://status.avalara.com/).
       # @return [Object]
       def ping()
         path = "/api/v2/utilities/ping"