avatax 20.9.0 → 21.10.0

data/lib/avatax/client/firmclientlinkages.rb

@@ -1,22 +1,22 @@
-module AvaTax
-  class Client
-    module FirmClientLinkages 
-
-
-      # Approves linkage to a firm for a client account
-      #
+module AvaTax
+  class Client
+    module FirmClientLinkages 
+
+
+      # Approves linkage to a firm for a client account
+      #
       # This API enables the account admin of a client account to approve linkage request by a firm.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] 
-      # @return [Object]
-      def approve_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/approve"
-        post(path)      end
-
-      # Request a new FirmClient account and create an approved linkage to it
-      #
+      # @return [Object]
+      def approve_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/approve"
+        post(path)      end
+
+      # Request a new FirmClient account and create an approved linkage to it
+      #
       # This API is for use by Firms only.
       #
       # Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service.
@@ -30,95 +30,95 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
       # @param model [Object] Information about the account you wish to create.
-      # @return [Object]
-      def create_and_link_new_firm_client_account(model)        path = "/api/v2/firmclientlinkages/createandlinkclient"
-        post(path, model)      end
-
-      # Links a firm account with the client account
-      #
+      # @return [Object]
+      def create_and_link_new_firm_client_account(model)        path = "/api/v2/firmclientlinkages/createandlinkclient"
+        post(path, model)      end
+
+      # Links a firm account with the client account
+      #
       # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param model [Object] FirmClientLinkageInputModel
-      # @return [Object]
-      def create_firm_client_linkage(model)        path = "/api/v2/firmclientlinkages"
-        post(path, model)      end
-
-      # Delete a linkage
-      #
+      # @return [Object]
+      def create_firm_client_linkage(model)        path = "/api/v2/firmclientlinkages"
+        post(path, model)      end
+
+      # Delete a linkage
+      #
       # This API marks a linkage between a firm and client as deleted.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] 
-      # @return [ErrorDetail[]]
-      def delete_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
-        delete(path)      end
-
-      # Get linkage between a firm and client by id
-      #
+      # @return [ErrorDetail[]]
+      def delete_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
+        delete(path)      end
+
+      # Get linkage between a firm and client by id
+      #
       # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] 
-      # @return [Object]
-      def get_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
-        get(path)      end
-
-      # List client linkages for a firm or client
-      #
+      # @return [Object]
+      def get_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
+        get(path)      end
+
+      # List client linkages for a firm or client
+      #
       # This API enables the firm or account users to request the associated linkages to the account.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @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/).<br />*Not filterable:* firmAccountName, clientAccountName
-      # @return [FetchResult]
-      def list_firm_client_linkage(options={})        path = "/api/v2/firmclientlinkages"
-        get(path, options)      end
-
-      # Rejects linkage to a firm for a client account
-      #
+      # @return [FetchResult]
+      def list_firm_client_linkage(options={})        path = "/api/v2/firmclientlinkages"
+        get(path, options)      end
+
+      # Rejects linkage to a firm for a client account
+      #
       # This API enables the account admin of a client account to reject linkage request by a firm.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] 
-      # @return [Object]
-      def reject_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reject"
-        post(path)      end
-
-      # Reset linkage status between a client and firm back to requested
-      #
+      # @return [Object]
+      def reject_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reject"
+        post(path)      end
+
+      # Reset linkage status between a client and firm back to requested
+      #
       # This API enables the firm admin of a client account to reset a previously created linkage request by a firm.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] 
-      # @return [Object]
-      def reset_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reset"
-        post(path)      end
-
-      # Revokes previously approved linkage to a firm for a client account
-      #
+      # @return [Object]
+      def reset_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reset"
+        post(path)      end
+
+      # Revokes previously approved linkage to a firm for a client account
+      #
       # This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] 
-      # @return [Object]
-      def revoke_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/revoke"
-        post(path)      end
-    end
-  end
+      # @return [Object]
+      def revoke_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/revoke"
+        post(path)      end
+    end
+  end
 end

data/lib/avatax/client/free.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Free 
-
-
-      # FREE API - Request a free trial of AvaTax
-      #
+module AvaTax
+  class Client
+    module Free 
+
+
+      # FREE API - Request a free trial of AvaTax
+      #
       # Call this API to obtain a free AvaTax account.
       #
       # This API is free to use. No authentication credentials are required to call this API. You must read and
@@ -18,84 +18,11 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API may be called without providing authentication credentials.
+      # * 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
-    end
-  end
+      # @return [Object]
+      def request_free_trial(model)        path = "/api/v2/accounts/freetrials/request"
+        post(path, model)      end
+    end
+  end
 end

data/lib/avatax/client/fundingrequests.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module FundingRequests 
-
-
-      # Request the javascript for a funding setup widget
-      #
+module AvaTax
+  class Client
+    module FundingRequests 
+
+
+      # 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
@@ -21,14 +21,14 @@ 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
-
-      # Retrieve status about a funding setup 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
@@ -43,11 +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
-    end
-  end
+      # @return [Object]
+      def funding_request_status(id)        path = "/api/v2/fundingrequests/#{id}"
+        get(path)      end
+    end
+  end
 end