avatax 17.5.0 → 17.6.0

data/lib/avatax/client/free.rb

@@ -4,41 +4,43 @@ module AvaTax
 
 
       # FREE API - Request a free trial of AvaTax
-      # 
+      #
       # Call this API to obtain a free AvaTax sandbox account.
-      # 
+      #
       # This API is free to use. No authentication credentials are required to call this API.
       # The account will grant a full trial version of AvaTax (e.g. AvaTaxPro) for a limited period of time.
       # After this introductory period, you may continue to use the free TaxRates API.
-      # 
+      #
       # Limitations on free trial accounts:
-      #  
+      #
       # * Only one free trial per company.
       # * The free trial account does not expire.
       # * Includes a limited time free trial of AvaTaxPro; after that date, the free TaxRates API will continue to work.
       # * Each free trial account must have its own valid email address.
-      # 
-      # @param FreeTrialRequestModel model Required information to provision a free trial account.
-      # @return NewAccountModel
+      # @param model [Object] Required information to provision a free trial account.
+      # @return [Object]
       def request_free_trial(model)
         path = "/api/v2/accounts/freetrials/request"
-        
         post(path, model)
       end
 
 
       # FREE API - Sales tax rates for a specified address
-      # 
+      #
       # # Free-To-Use
-      # 
+      #
       # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
       # Any customer can request a free AvaTax account and make use of the TaxRates API.
-      # However, this API is currently limited for US only
-      # 
-      # Note that the TaxRates API assumes the sale of general tangible personal property when estimating the sales tax
-      # rate for a specified address. Avalara provides the `CreateTransaction` API, which provides extensive tax calculation 
-      # support for scenarios including, but not limited to:
-      # 
+      #
+      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
+      # response code 429 - `Too Many Requests`.
+      #
+      # This API assumes that you are selling general tangible personal property at a retail point-of-sale
+      # location in the United States only.
+      #
+      # For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API,
+      # which supports features including, but not limited to:
+      #
       # * Nexus declarations
       # * Taxability based on product/service type
       # * Sourcing rules affecting origin/destination states
@@ -47,37 +49,39 @@ module AvaTax
       # * Refunds for products purchased on a different date
       # * Detailed jurisdiction names and state assigned codes
       # * And more!
-      # 
+      #
       # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
       # for information on how to upgrade to the full AvaTax CreateTransaction API.
-      # 
-      # @param string line1 The street address of the location.
-      # @param string line2 The street address of the location.
-      # @param string line3 The street address of the location.
-      # @param string city The city name of the location.
-      # @param string region The state or region of the location
-      # @param string postalCode The postal code of the location.
-      # @param string country The two letter ISO-3166 country code.
-      # @return TaxRateModel
+      # @param line1 [String] The street address of the location.
+      # @param line2 [String] The street address of the location.
+      # @param line3 [String] The street address of the location.
+      # @param city [String] The city name of the location.
+      # @param region [String] The state or region of the location
+      # @param postalCode [String] The postal code of the location.
+      # @param country [String] The two letter ISO-3166 country code.
+      # @return [Object]
       def tax_rates_by_address(options={})
         path = "/api/v2/taxrates/byaddress"
-        
         get(path, options)
       end
 
 
       # FREE API - Sales tax rates for a specified country and postal code
-      # 
+      #
       # # Free-To-Use
-      # 
+      #
       # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
       # Any customer can request a free AvaTax account and make use of the TaxRates API.
-      # However, this API is currently limited for US only
-      # 
-      # Note that the TaxRates API assumes the sale of general tangible personal property when estimating the sales tax
-      # rate for a specified address. Avalara provides the `CreateTransaction` API, which provides extensive tax calculation 
-      # support for scenarios including, but not limited to:
-      # 
+      #
+      # Usage of this API is subject to rate limits. Users who exceed the rate limit will receive HTTP
+      # response code 429 - `Too Many Requests`.
+      #
+      # This API assumes that you are selling general tangible personal property at a retail point-of-sale
+      # location in the United States only.
+      #
+      # For more powerful tax calculation, please consider upgrading to the `CreateTransaction` API,
+      # which supports features including, but not limited to:
+      #
       # * Nexus declarations
       # * Taxability based on product/service type
       # * Sourcing rules affecting origin/destination states
@@ -86,16 +90,14 @@ module AvaTax
       # * Refunds for products purchased on a different date
       # * Detailed jurisdiction names and state assigned codes
       # * And more!
-      # 
+      #
       # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
       # for information on how to upgrade to the full AvaTax CreateTransaction API.
-      # 
-      # @param string country The two letter ISO-3166 country code.
-      # @param string postalCode The postal code of the location.
-      # @return TaxRateModel
+      # @param country [String] The two letter ISO-3166 country code.
+      # @param postalCode [String] The postal code of the location.
+      # @return [Object]
       def tax_rates_by_postal_code(options={})
         path = "/api/v2/taxrates/bypostalcode"
-        
         get(path, options)
       end
 

data/lib/avatax/client/fundingrequests.rb

@@ -4,34 +4,32 @@ module AvaTax
 
 
       # Request the javascript for a funding setup widget
-      # 
+      #
       # This API is available by invitation only.
-      # Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are 
-      # required to setup their funding configuration before Avalara can begin filing tax returns on their 
+      # Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are
+      # required to setup their funding configuration before Avalara can begin filing tax returns on their
       # behalf.
       # Funding configuration for each company is set up by submitting a funding setup request, which can
       # be sent either via email or via an embedded HTML widget.
       # When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members
       # before approval.
-      # This API returns back the actual javascript code to insert into your application to render the 
+      # This API returns back the actual javascript code to insert into your application to render the
       # JavaScript funding setup widget inline.
       # Use the 'methodReturn.javaScript' return value to insert this widget into your HTML page.
       # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
-      # 
-      # @param int id The unique ID number of this funding request
-      # @return FundingStatusModel
+      # @param id [Integer] The unique ID number of this funding request
+      # @return [Object]
       def activate_funding_request(id)
         path = "/api/v2/fundingrequests/#{id}/widget"
-        
         get(path)
       end
 
 
       # Retrieve status about a funding setup request
-      # 
+      #
       # This API is available by invitation only.
-      # Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are 
-      # required to setup their funding configuration before Avalara can begin filing tax returns on their 
+      # Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are
+      # required to setup their funding configuration before Avalara can begin filing tax returns on their
       # behalf.
       # Funding configuration for each company is set up by submitting a funding setup request, which can
       # be sent either via email or via an embedded HTML widget.
@@ -39,12 +37,10 @@ module AvaTax
       # before approval.
       # This API checks the status on an existing funding request.
       # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
-      # 
-      # @param int id The unique ID number of this funding request
-      # @return FundingStatusModel
+      # @param id [Integer] The unique ID number of this funding request
+      # @return [Object]
       def funding_request_status(id)
         path = "/api/v2/fundingrequests/#{id}"
-        
         get(path)
       end
 

data/lib/avatax/client/items.rb

@@ -4,105 +4,93 @@ module AvaTax
 
 
       # Create a new item
-      # 
+      #
       # Creates one or more new item objects attached to this company.
-      # 
-      # @param int companyId The ID of the company that owns this item.
-      # @param ItemModel[] model The item you wish to create.
-      # @return ItemModel[]
+      # @param companyId [Integer] The ID of the company that owns this item.
+      # @param model [object[]] The item you wish to create.
+      # @return [object[]]
       def create_items(companyId, model)
         path = "/api/v2/companies/#{companyId}/items"
-        
         post(path, model)
       end
 
 
       # Delete a single item
-      # 
+      #
       # Marks the item object at this URL as deleted.
-      # 
-      # @param int companyId The ID of the company that owns this item.
-      # @param int id The ID of the item you wish to delete.
-      # @return ErrorDetail[]
+      # @param companyId [Integer] The ID of the company that owns this item.
+      # @param id [Integer] The ID of the item you wish to delete.
+      # @return [object[]]
       def delete_item(companyId, id)
         path = "/api/v2/companies/#{companyId}/items/#{id}"
-        
         delete(path)
       end
 
 
       # Retrieve a single item
-      # 
+      #
       # Get the item object identified by this URL.
       # An 'Item' represents a product or service that your company offers for sale.
-      # 
-      # @param int companyId The ID of the company that owns this item object
-      # @param int id The primary key of this item
-      # @return ItemModel
+      # @param companyId [Integer] The ID of the company that owns this item object
+      # @param id [Integer] The primary key of this item
+      # @return [Object]
       def get_item(companyId, id)
         path = "/api/v2/companies/#{companyId}/items/#{id}"
-        
         get(path)
       end
 
 
       # Retrieve items for this company
-      # 
+      #
       # List all items defined for the current company.
-      # 
+      #
       # An 'Item' represents a product or service that your company offers for sale.
-      # 
+      #
       # 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 int companyId The ID of the company that defined these items
-      # @param string filter 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 string include A comma separated list of child objects to return underneath the primary object.
-      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
-      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
-      # @return FetchResult
+      # @param companyId [Integer] The ID of the company that defined these items
+      # @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 child objects to return underneath the primary object.
+      # @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 orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
       def list_items_by_company(companyId, options={})
         path = "/api/v2/companies/#{companyId}/items"
-        
         get(path, options)
       end
 
 
       # Retrieve all items
-      # 
+      #
       # Get multiple item objects across all companies.
       # An 'Item' represents a product or service that your company offers for sale.
-      # 
+      #
       # 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 string filter 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 string include A comma separated list of child objects to return underneath the primary object.
-      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
-      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
-      # @return FetchResult
+      # @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 child objects to return underneath the primary object.
+      # @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 orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
       def query_items(options={})
         path = "/api/v2/items"
-        
         get(path, options)
       end
 
 
       # Update a single item
-      # 
+      #
       # Replace the existing item object at this URL with an updated object.
-      # All data from the existing object will be replaced with data in the object you PUT. 
+      # 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.
-      # 
-      # @param int companyId The ID of the company that this item belongs to.
-      # @param int id The ID of the item you wish to update
-      # @param ItemModel model The item object you wish to update.
-      # @return ItemModel
+      # @param companyId [Integer] The ID of the company that this item belongs to.
+      # @param id [Integer] The ID of the item you wish to update
+      # @param model [Object] The item object you wish to update.
+      # @return [Object]
       def update_item(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/items/#{id}"
-        
         put(path, model)
       end
 

data/lib/avatax/client/jurisdictionoverrides.rb

@@ -4,119 +4,107 @@ module AvaTax
 
 
       # Create one or more overrides
-      # 
+      #
       # Creates one or more jurisdiction override objects for this account.
-      # 
+      #
       # A Jurisdiction Override is a configuration setting that allows you to select the taxing
       # jurisdiction for a specific address. If you encounter an address that is on the boundary
       # between two different jurisdictions, you can choose to set up a jurisdiction override
       # to switch this address to use different taxing jurisdictions.
-      # 
-      # @param int accountId The ID of the account that owns this override
-      # @param JurisdictionOverrideModel[] model The jurisdiction override objects to create
-      # @return JurisdictionOverrideModel[]
+      # @param accountId [Integer] The ID of the account that owns this override
+      # @param model [object[]] The jurisdiction override objects to create
+      # @return [object[]]
       def create_jurisdiction_overrides(accountId, model)
         path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
-        
         post(path, model)
       end
 
 
       # Delete a single override
-      # 
+      #
       # Marks the item object at this URL as deleted.
-      # 
-      # @param int accountId The ID of the account that owns this override
-      # @param int id The ID of the override you wish to delete
-      # @return ErrorDetail[]
+      # @param accountId [Integer] The ID of the account that owns this override
+      # @param id [Integer] The ID of the override you wish to delete
+      # @return [object[]]
       def delete_jurisdiction_override(accountId, id)
         path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        
         delete(path)
       end
 
 
       # Retrieve a single override
-      # 
+      #
       # Get the item object identified by this URL.
-      # 
+      #
       # A Jurisdiction Override is a configuration setting that allows you to select the taxing
       # jurisdiction for a specific address. If you encounter an address that is on the boundary
       # between two different jurisdictions, you can choose to set up a jurisdiction override
       # to switch this address to use different taxing jurisdictions.
-      # 
-      # @param int accountId The ID of the account that owns this override
-      # @param int id The primary key of this override
-      # @return JurisdictionOverrideModel
+      # @param accountId [Integer] The ID of the account that owns this override
+      # @param id [Integer] The primary key of this override
+      # @return [Object]
       def get_jurisdiction_override(accountId, id)
         path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        
         get(path)
       end
 
 
       # Retrieve overrides for this account
-      # 
+      #
       # List all jurisdiction override objects defined for this account.
-      # 
+      #
       # A Jurisdiction Override is a configuration setting that allows you to select the taxing
       # jurisdiction for a specific address. If you encounter an address that is on the boundary
       # between two different jurisdictions, you can choose to set up a jurisdiction override
       # to switch this address to use different taxing jurisdictions.
-      # 
+      #
       # 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 int accountId The ID of the account that owns this override
-      # @param string filter 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 string include A comma separated list of child objects to return underneath the primary object.
-      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
-      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
-      # @return FetchResult
+      # @param accountId [Integer] The ID of the account that owns this override
+      # @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 child objects to return underneath the primary object.
+      # @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 orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
       def list_jurisdiction_overrides_by_account(accountId, options={})
         path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
-        
         get(path, options)
       end
 
 
       # Retrieve all overrides
-      # 
+      #
       # Get multiple jurisdiction override objects across all companies.
-      # 
+      #
       # A Jurisdiction Override is a configuration setting that allows you to select the taxing
       # jurisdiction for a specific address. If you encounter an address that is on the boundary
       # between two different jurisdictions, you can choose to set up a jurisdiction override
       # to switch this address to use different taxing jurisdictions.
-      # 
+      #
       # 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 string filter 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 string include A comma separated list of child objects to return underneath the primary object.
-      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
-      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
-      # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
-      # @return FetchResult
+      # @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 child objects to return underneath the primary object.
+      # @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 orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
+      # @return [FetchResult]
       def query_jurisdiction_overrides(options={})
         path = "/api/v2/jurisdictionoverrides"
-        
         get(path, options)
       end
 
 
       # Update a single jurisdictionoverride
-      # 
+      #
       # Replace the existing jurisdictionoverride object at this URL with an updated object.
-      # 
-      # @param int accountId The ID of the account that this jurisdictionoverride belongs to.
-      # @param int id The ID of the jurisdictionoverride you wish to update
-      # @param JurisdictionOverrideModel model The jurisdictionoverride object you wish to update.
-      # @return JurisdictionOverrideModel
+      # @param accountId [Integer] The ID of the account that this jurisdictionoverride belongs to.
+      # @param id [Integer] The ID of the jurisdictionoverride you wish to update
+      # @param model [Object] The jurisdictionoverride object you wish to update.
+      # @return [Object]
       def update_jurisdiction_override(accountId, id, model)
         path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        
         put(path, model)
       end