avatax 20.7.0 → 21.3.0

data/lib/avatax/client/free.rb

@@ -21,90 +21,8 @@ module AvaTax
       # * This API may be called without providing authentication credentials.
       # @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.
-      #
-      # 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
-      # * Customers who are exempt from certain taxes
-      # * States that have dollar value thresholds for tax amounts
-      # * 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 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] Name or ISO 3166 code identifying the region within the country.     This field supports many different region identifiers:   * Two and three character ISO 3166 region codes   * Fully spelled out names of the region in ISO supported languages   * Common alternative spellings for many regions     For a full list of all supported codes and names, please see the Definitions API `ListRegions`.
-      # @param postalCode [String] The postal code of the location.
-      # @param country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
-      # @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. This API is only available for US postal codes.
-      #
-      # # Free-To-Use
-      #
-      # This API is only available for a US postal codes.
-      #
-      # 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.
-      #
-      # 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
-      # * Customers who are exempt from certain taxes
-      # * States that have dollar value thresholds for tax amounts
-      # * 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 country [String] Name or ISO 3166 code identifying the country.     This field supports many different country identifiers:   * Two character ISO 3166 codes   * Three character ISO 3166 codes   * Fully spelled out names of the country in ISO supported languages   * Common alternative spellings for many countries     For a full list of all supported codes and names, please see the Definitions API `ListCountries`.
-      # @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
-
+      def request_free_trial(model)        path = "/api/v2/accounts/freetrials/request"
+        post(path, model)      end
     end
   end
 end

data/lib/avatax/client/fundingrequests.rb

@@ -21,14 +21,11 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @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
-
+      def activate_funding_request(id)        path = "/api/v2/fundingrequests/#{id}/widget"
+        get(path)      end
 
       # Retrieve status about a funding setup request
       #
@@ -46,14 +43,11 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @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
-
+      def funding_request_status(id)        path = "/api/v2/fundingrequests/#{id}"
+        get(path)      end
     end
   end
 end

data/lib/avatax/client/items.rb

@@ -17,11 +17,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param itemId [Integer] The ID of the item you wish to delete the classifications.
       # @return [ErrorDetail[]]
-      def batch_delete_item_classifications(companyId, itemId)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
-        delete(path)
-      end
-
+      def batch_delete_item_classifications(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
+        delete(path)      end
 
       # Delete all parameters for an item
       #
@@ -39,11 +36,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param itemId [Integer] The ID of the item you wish to delete the parameters.
       # @return [ErrorDetail[]]
-      def batch_delete_item_parameters(companyId, itemId)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
-        delete(path)
-      end
-
+      def batch_delete_item_parameters(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
+        delete(path)      end
 
       # Add classifications to an item.
       #
@@ -62,11 +56,8 @@ module AvaTax
       # @param itemId [Integer] The item id.
       # @param model [ItemClassificationInputModel[]] The item classifications you wish to create.
       # @return [ItemClassificationOutputModel[]]
-      def create_item_classifications(companyId, itemId, model)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
-        post(path, model)
-      end
-
+      def create_item_classifications(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
+        post(path, model)      end
 
       # Add parameters to an item.
       #
@@ -89,11 +80,8 @@ module AvaTax
       # @param itemId [Integer] The item id.
       # @param model [ItemParameterModel[]] The item parameters you wish to create.
       # @return [ItemParameterModel[]]
-      def create_item_parameters(companyId, itemId, model)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
-        post(path, model)
-      end
-
+      def create_item_parameters(companyId, itemId, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
+        post(path, model)      end
 
       # Create a new item
       #
@@ -113,11 +101,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param model [ItemModel[]] The item you wish to create.
       # @return [ItemModel[]]
-      def create_items(companyId, model)
-        path = "/api/v2/companies/#{companyId}/items"
-        post(path, model)
-      end
-
+      def create_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items"
+        post(path, model)      end
 
       # Delete a single item
       #
@@ -137,11 +122,8 @@ module AvaTax
       # @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 [ErrorDetail[]]
-      def delete_item(companyId, id)
-        path = "/api/v2/companies/#{companyId}/items/#{id}"
-        delete(path)
-      end
-
+      def delete_item(companyId, id)        path = "/api/v2/companies/#{companyId}/items/#{id}"
+        delete(path)      end
 
       # Delete a single item classification.
       #
@@ -158,11 +140,8 @@ module AvaTax
       # @param itemId [Integer] The item id.
       # @param id [Integer] The item classification id.
       # @return [ErrorDetail[]]
-      def delete_item_classification(companyId, itemId, id)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
-        delete(path)
-      end
-
+      def delete_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
+        delete(path)      end
 
       # Delete a single item parameter
       #
@@ -181,11 +160,8 @@ module AvaTax
       # @param itemId [Integer] The item id
       # @param id [Integer] The parameter id
       # @return [ErrorDetail[]]
-      def delete_item_parameter(companyId, itemId, id)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
-        delete(path)
-      end
-
+      def delete_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
+        delete(path)      end
 
       # Retrieve a single item
       #
@@ -204,11 +180,8 @@ module AvaTax
       # @param id [Integer] The primary key of this item
       # @param include [String] A comma separated list of additional data to retrieve.
       # @return [Object]
-      def get_item(companyId, id, options={})
-        path = "/api/v2/companies/#{companyId}/items/#{id}"
-        get(path, options)
-      end
-
+      def get_item(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/items/#{id}"
+        get(path, options)      end
 
       # Retrieve a single item classification.
       #
@@ -225,11 +198,8 @@ module AvaTax
       # @param itemId [Integer] The item id.
       # @param id [Integer] The item classification id.
       # @return [Object]
-      def get_item_classification(companyId, itemId, id)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
-        get(path)
-      end
-
+      def get_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
+        get(path)      end
 
       # Retrieve a single item parameter
       #
@@ -248,11 +218,8 @@ module AvaTax
       # @param itemId [Integer] The item id
       # @param id [Integer] The parameter id
       # @return [Object]
-      def get_item_parameter(companyId, itemId, id)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
-        get(path)
-      end
-
+      def get_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
+        get(path)      end
 
       # Retrieve classifications for an item.
       #
@@ -275,11 +242,8 @@ module AvaTax
       # @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_item_classifications(companyId, itemId, options={})
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
-        get(path, options)
-      end
-
+      def list_item_classifications(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
+        get(path, options)      end
 
       # Retrieve parameters for an item
       #
@@ -304,11 +268,8 @@ module AvaTax
       # @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_item_parameters(companyId, itemId, options={})
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
-        get(path, options)
-      end
-
+      def list_item_parameters(companyId, itemId, options={})        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
+        get(path, options)      end
 
       # Retrieve items for this company
       #
@@ -339,11 +300,8 @@ module AvaTax
       # @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
-
+      def list_items_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/items"
+        get(path, options)      end
 
       # Retrieve all items
       #
@@ -368,11 +326,8 @@ module AvaTax
       # @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
-
+      def query_items(options={})        path = "/api/v2/items"
+        get(path, options)      end
 
       # Sync items from a product catalog
       #
@@ -395,11 +350,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this item.
       # @param model [Object] The request object.
       # @return [Object]
-      def sync_items(companyId, model)
-        path = "/api/v2/companies/#{companyId}/items/sync"
-        post(path, model)
-      end
-
+      def sync_items(companyId, model)        path = "/api/v2/companies/#{companyId}/items/sync"
+        post(path, model)      end
 
       # Update a single item
       #
@@ -423,11 +375,8 @@ module AvaTax
       # @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
-
+      def update_item(companyId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{id}"
+        put(path, model)      end
 
       # Update an item classification.
       #
@@ -447,11 +396,8 @@ module AvaTax
       # @param id [Integer] The item classification id.
       # @param model [Object] The item object you wish to update.
       # @return [Object]
-      def update_item_classification(companyId, itemId, id, model)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
-        put(path, model)
-      end
-
+      def update_item_classification(companyId, itemId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
+        put(path, model)      end
 
       # Update an item parameter
       #
@@ -471,11 +417,8 @@ module AvaTax
       # @param id [Integer] The item parameter id
       # @param model [Object] The item object you wish to update.
       # @return [Object]
-      def update_item_parameter(companyId, itemId, id, model)
-        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
-        put(path, model)
-      end
-
+      def update_item_parameter(companyId, itemId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/jurisdictionoverrides.rb

@@ -18,11 +18,8 @@ module AvaTax
       # @param accountId [Integer] The ID of the account that owns this override
       # @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
       # @return [JurisdictionOverrideModel[]]
-      def create_jurisdiction_overrides(accountId, model)
-        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
-        post(path, model)
-      end
-
+      def create_jurisdiction_overrides(accountId, model)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
+        post(path, model)      end
 
       # Delete a single override
       #
@@ -34,11 +31,8 @@ module AvaTax
       # @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 [ErrorDetail[]]
-      def delete_jurisdiction_override(accountId, id)
-        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        delete(path)
-      end
-
+      def delete_jurisdiction_override(accountId, id)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        delete(path)      end
 
       # Retrieve a single override
       #
@@ -55,11 +49,8 @@ module AvaTax
       # @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
-
+      def get_jurisdiction_override(accountId, id)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        get(path)      end
 
       # Retrieve overrides for this account
       #
@@ -83,11 +74,8 @@ module AvaTax
       # @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
-
+      def list_jurisdiction_overrides_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
+        get(path, options)      end
 
       # Retrieve all overrides
       #
@@ -110,11 +98,8 @@ module AvaTax
       # @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
-
+      def query_jurisdiction_overrides(options={})        path = "/api/v2/jurisdictionoverrides"
+        get(path, options)      end
 
       # Update a single jurisdictionoverride
       #
@@ -127,11 +112,8 @@ module AvaTax
       # @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
-
+      def update_jurisdiction_override(accountId, id, model)        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        put(path, model)      end
     end
   end
 end