avatax 21.3.1 → 21.9.0

data/lib/avatax/client/distancethresholds.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module DistanceThresholds 
-
-
-      # Create one or more DistanceThreshold objects
-      #
+module AvaTax
+  class Client
+    module DistanceThresholds 
+
+
+      # Create one or more DistanceThreshold objects
+      #
       # Create one or more DistanceThreshold objects for this company.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -13,15 +13,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
       # @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
-      # @return [CompanyDistanceThresholdModel[]]
-      def create_distance_threshold(companyId, model)        path = "/api/v2/companies/#{companyId}/distancethresholds"
-        post(path, model)      end
-
-      # Delete a single DistanceThreshold object
-      #
+      # @return [CompanyDistanceThresholdModel[]]
+      def create_distance_threshold(companyId, model)        path = "/api/v2/companies/#{companyId}/distancethresholds"
+        post(path, model)      end
+
+      # Delete a single DistanceThreshold object
+      #
       # Marks the DistanceThreshold object identified by this URL as deleted.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -30,15 +30,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
       # @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_distance_threshold(companyId, id)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
-        delete(path)      end
-
-      # Retrieve a single DistanceThreshold
-      #
+      # @return [ErrorDetail[]]
+      def delete_distance_threshold(companyId, id)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
+        delete(path)      end
+
+      # Retrieve a single DistanceThreshold
+      #
       # Retrieves a single DistanceThreshold object defined by this URL.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -47,15 +47,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param companyId [Integer] The ID of the company that owns this DistanceThreshold object
       # @param id [Integer] The unique ID number referring to this DistanceThreshold object
-      # @return [Object]
-      def get_distance_threshold(companyId, id)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
-        get(path)      end
-
-      # Retrieve all DistanceThresholds for this company.
-      #
+      # @return [Object]
+      def get_distance_threshold(companyId, id)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
+        get(path)      end
+
+      # Retrieve all DistanceThresholds for this company.
+      #
       # Lists all DistanceThreshold objects that belong to this company.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -64,19 +64,19 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param companyId [Integer] The ID of the company whose DistanceThreshold objects you wish to list.
       # @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. 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_distance_thresholds(companyId, options={})        path = "/api/v2/companies/#{companyId}/distancethresholds"
-        get(path, options)      end
-
-      # Retrieve all DistanceThreshold objects
-      #
+      # @return [FetchResult]
+      def list_distance_thresholds(companyId, options={})        path = "/api/v2/companies/#{companyId}/distancethresholds"
+        get(path, options)      end
+
+      # Retrieve all DistanceThreshold objects
+      #
       # Lists all DistanceThreshold objects that belong to this account.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -88,18 +88,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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/).
       # @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. 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_distance_thresholds(options={})        path = "/api/v2/distancethresholds"
-        get(path, options)      end
-
-      # Update a DistanceThreshold object
-      #
+      # @return [FetchResult]
+      def query_distance_thresholds(options={})        path = "/api/v2/distancethresholds"
+        get(path, options)      end
+
+      # Update a DistanceThreshold object
+      #
       # Replace the existing DistanceThreshold object at this URL with an updated object.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -111,13 +111,13 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold object.
       # @param id [Integer] The unique ID number of the DistanceThreshold object to replace.
       # @param model [Object] The new DistanceThreshold object to store.
-      # @return [Object]
-      def update_distance_threshold(companyId, id, model)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_distance_threshold(companyId, id, model)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
+        put(path, model)      end
+    end
+  end
 end

data/lib/avatax/client/ecommercetoken.rb

@@ -5,30 +5,30 @@ module AvaTax
 
       # Create a new eCommerce token.
       #
-      # Creates a new eCommerce token.
-      #
-      # This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
-      #
-      # ### Security Policies
-      #
+      # Creates a new eCommerce token.
+      #
+      # This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
+      #
+      # ### 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.
-      # @param companyId [Integer] The company ID that will be issued this certificate.
-      # @param model [Object] 
+      # @param companyId [Integer] The company ID that will be issued this certificate.
+      # @param model [Object] 
       # @return [Object]
       def create_e_commerce_token(companyId, model)        path = "/api/v2/companies/#{companyId}/ecommercetokens"
         post(path, model)      end
 
       # Refresh an eCommerce token.
       #
-      # Refresh an eCommerce token.
-      #
-      # CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.
-      #
-      # ### Security Policies
-      #
+      # Refresh an eCommerce token.
+      #
+      # CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.
+      #
+      # ### 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.
-      # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
-      # @param model [Object] 
+      # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
+      # @param model [Object] 
       # @return [FetchResult]
       def refresh_e_commerce_token(companyId, model)        path = "/api/v2/companies/#{companyId}/ecommercetokens"
         put(path, model)      end

data/lib/avatax/client/filingcalendars.rb

@@ -1,36 +1,55 @@
-module AvaTax
-  class Client
-    module FilingCalendars 
-
-
-      # Add or Edit options
-      #
+module AvaTax
+  class Client
+    module FilingCalendars 
+
+
+      # Add or Edit options
+      #
       # Returns a list of options for adding tax forms for the company and tax form code specified.
       # Returns edit options when modifying a filing calendar.
       # This API is available by invitation only.
       #
       # ### Security Policies
       #
-      # * 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.
+      # * 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 companyId [Integer] The unique ID of the company that owns the filing calendar object
       # @param model [Object] Cycle Safe Options Request
-      # @return [Object]
-      def cycle_safe_options(companyId, model)        path = "/api/v2/companies/#{companyId}/filingcalendars/edit/cycleSafeOptions"
-        post(path, model)      end
-
-      # Delete a company return setting
-      #
+      # @return [Object]
+      def cycle_safe_options(companyId, model)        path = "/api/v2/companies/#{companyId}/filingcalendars/edit/cycleSafeOptions"
+        post(path, model)      end
+
+      # Delete a company return setting
+      #
       # This API is available by invitation only and only available for users with Compliance access
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param companyId [Integer] The unique ID of the company
       # @param filingCalendarId [Integer] The unique ID of the filing calendar that will remove setting
       # @param companyReturnSettingId [Integer] The unique ID of the company return setting that will be deleted from the filing calendar
-      # @return [CompanyReturnSettingModel[]]
-      def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId)        path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
-        delete(path)      end
-    end
-  end
+      # @return [CompanyReturnSettingModel[]]
+      def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId)        path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
+        delete(path)      end
+
+      # Retrieve all legacy filing calendars for this company
+      #
+      # This API is available by invitation only.
+      #
+      # ### 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 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 companyId [Integer] The ID of the company that owns these batches
+      # @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:* taxAuthorityId, taxAuthorityName, taxAuthorityType, settings
+      # @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`.
+      # @param returnCountry [String] A comma separated list of countries
+      # @param returnRegion [String] A comma separated list of regions
+      # @return [FetchResult]
+      def legacy_filing_calendars(companyId, options={})        path = "/api/v2/companies/#{companyId}/filingcalendars/Legacy"
+        get(path, options)      end
+    end
+  end
 end

data/lib/avatax/client/filings.rb

@@ -1,26 +1,26 @@
-module AvaTax
-  class Client
-    module Filings 
-
-
-      # Retrieve a filing containing the return and all its accrual returns.
-      #
+module AvaTax
+  class Client
+    module Filings 
+
+
+      # Retrieve a filing containing the return and all its accrual returns.
+      #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param companyId [Integer] The ID of the company that owns these returns
       # @param filingReturnId [Integer] The ID of the filing return
-      # @return [FetchResult]
-      def get_accrual_filings(companyId, filingReturnId)        path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
-        get(path)      end
-
-      # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
-      #
+      # @return [FetchResult]
+      def get_accrual_filings(companyId, filingReturnId)        path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
+        get(path)      end
+
+      # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
+      #
       # ### 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 is available by invitation only.*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin.
-      # * 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.
+      # * 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 companyId [Integer] The ID of the company that owns these batches
       # @param endPeriodMonth [Integer] The month of the period you are trying to retrieve
       # @param endPeriodYear [Integer] The year of the period you are trying to retrieve
@@ -30,9 +30,9 @@ module AvaTax
       # @param region [String] The region of the return(s) you are trying to retrieve
       # @param filingCalendarId [Integer] The filing calendar id of the return you are trying to retrieve
       # @param taxformCode [String] The unique tax form code of the form.
-      # @return [FetchResult]
-      def get_filed_returns(companyId, options={})        path = "/api/v2/companies/#{companyId}/filings/returns/filed"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def get_filed_returns(companyId, options={})        path = "/api/v2/companies/#{companyId}/filings/returns/filed"
+        get(path, options)      end
+    end
+  end
 end

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,11 +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
-    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:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*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:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*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