avatax 21.8.0 → 21.9.0

data/lib/avatax/client/companies.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Companies 
-
-
-      # Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
-      #
+module AvaTax
+  class Client
+    module Companies 
+
+
+      # Checks whether the integration being used to set up this company and run transactions onto this company is compliant to all requirements.
+      #
       # Examines the most recent 100 transactions or data from the last month when verifying transaction-related integrations.
       # For partners who write integrations against AvaTax for many clients, this API is a way to do a quick self testing to verify whether the
       # written integrations for a company are sufficient enough to be delivered to the respective customers to start using it.
@@ -31,14 +31,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 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 id [Integer] The ID of the company to check if its integration is certified.
-      # @return [String]
-      def certify_integration(id)        path = "/api/v2/companies/#{id}/certify"
-        get(path)      end
-
-      # Change the filing status of this company
-      #
+      # @return [String]
+      def certify_integration(id)        path = "/api/v2/companies/#{id}/certify"
+        get(path)      end
+
+      # Change the filing status of this company
+      #
       # Changes the current filing status of this company.
       #
       # For customers using Avalara's Managed Returns Service, each company within their account can request
@@ -55,15 +55,15 @@ 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 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 id [Integer] 
       # @param model [Object] 
-      # @return [String]
-      def change_filing_status(id, model)        path = "/api/v2/companies/#{id}/filingstatus"
-        post(path, model)      end
-
-      # Quick setup for a company with a single physical address
-      #
+      # @return [String]
+      def change_filing_status(id, model)        path = "/api/v2/companies/#{id}/filingstatus"
+        post(path, model)      end
+
+      # Quick setup for a company with a single physical address
+      #
       # Shortcut to quickly setup a single-physical-location company with critical information and activate it.
       # This API provides quick and simple company setup functionality and does the following things:
       #
@@ -79,14 +79,14 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param model [Object] Information about the company you wish to create.
-      # @return [Object]
-      def company_initialize(model)        path = "/api/v2/companies/initialize"
-        post(path, model)      end
-
-      # Create new companies
-      #
+      # @return [Object]
+      def company_initialize(model)        path = "/api/v2/companies/initialize"
+        post(path, model)      end
+
+      # Create new companies
+      #
       # Create one or more new company objects.
       # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
       # You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company.
@@ -95,14 +95,14 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param model [CompanyModel[]] Either a single company object or an array of companies to create
-      # @return [CompanyModel[]]
-      def create_companies(model)        path = "/api/v2/companies"
-        post(path, model)      end
-
-      # Add parameters to a company.
-      #
+      # @return [CompanyModel[]]
+      def create_companies(model)        path = "/api/v2/companies"
+        post(path, model)      end
+
+      # Add parameters to a company.
+      #
       # Add parameters to a company.
       #
       # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
@@ -117,15 +117,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this company parameter.
       # @param model [CompanyParameterDetailModel[]] The company parameters you wish to create.
-      # @return [CompanyParameterDetailModel[]]
-      def create_company_parameters(companyId, model)        path = "/api/v2/companies/#{companyId}/parameters"
-        post(path, model)      end
-
-      # Request managed returns funding setup for a company
-      #
+      # @return [CompanyParameterDetailModel[]]
+      def create_company_parameters(companyId, model)        path = "/api/v2/companies/#{companyId}/parameters"
+        post(path, model)      end
+
+      # Request managed returns funding setup for a company
+      #
       # 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
@@ -140,27 +140,27 @@ module AvaTax
       # ### Security Policies
       #
       # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
-      # * 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 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 id [Integer] The unique identifier of the company
       # @param model [Object] The funding initialization request
-      # @return [Object]
-      def create_funding_request(id, model)        path = "/api/v2/companies/#{id}/funding/setup"
-        post(path, model)      end
-
-      # Delete a single company
-      #
+      # @return [Object]
+      def create_funding_request(id, model)        path = "/api/v2/companies/#{id}/funding/setup"
+        post(path, model)      end
+
+      # Delete a single company
+      #
       # Deleting a company will delete all child companies, and all users attached to this company.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
       # @param id [Integer] The ID of the company you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_company(id)        path = "/api/v2/companies/#{id}"
-        delete(path)      end
-
-      # Delete a single company parameter
-      #
+      # @return [ErrorDetail[]]
+      def delete_company(id)        path = "/api/v2/companies/#{id}"
+        delete(path)      end
+
+      # Delete a single company parameter
+      #
       # Delete a parameter of a company.
       # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -170,15 +170,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The company id
       # @param id [Integer] The parameter id
-      # @return [ErrorDetail[]]
-      def delete_company_parameter(companyId, id)        path = "/api/v2/companies/#{companyId}/parameters/#{id}"
-        delete(path)      end
-
-      # Check the funding configuration of a company
-      #
+      # @return [ErrorDetail[]]
+      def delete_company_parameter(companyId, id)        path = "/api/v2/companies/#{companyId}/parameters/#{id}"
+        delete(path)      end
+
+      # Check the funding configuration of a company
+      #
       # This API is available by invitation only.
       # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
       # Returns the funding configuration of the requested company.
@@ -187,14 +187,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 companyId [Integer] The unique identifier of the company
-      # @return [Object]
-      def funding_configuration_by_company(companyId)        path = "/api/v2/companies/#{companyId}/funding/configuration"
-        get(path)      end
-
-      # Check the funding configuration of a company
-      #
+      # @return [Object]
+      def funding_configuration_by_company(companyId)        path = "/api/v2/companies/#{companyId}/funding/configuration"
+        get(path)      end
+
+      # Check the funding configuration of a company
+      #
       # This API is available by invitation only.
       # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
       # Returns the funding configuration of the requested company.
@@ -203,15 +203,15 @@ 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 companyId [Integer] The unique identifier of the company
       # @param currency [String] The currency of the funding. USD and CAD are the only valid currencies
-      # @return [FundingConfigurationModel[]]
-      def funding_configurations_by_company_and_currency(companyId, options={})        path = "/api/v2/companies/#{companyId}/funding/configurations"
-        get(path, options)      end
-
-      # Retrieve a single company
-      #
+      # @return [FundingConfigurationModel[]]
+      def funding_configurations_by_company_and_currency(companyId, options={})        path = "/api/v2/companies/#{companyId}/funding/configurations"
+        get(path, options)      end
+
+      # Retrieve a single company
+      #
       # Get the company object identified by this URL.
       # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
       # You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
@@ -228,15 +228,15 @@ 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 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 id [Integer] The ID of the company to retrieve.
       # @param include [String] OPTIONAL: A comma separated list of special fetch options.      * Child objects - Specify one or more of the following to retrieve objects related to each company: "Contacts", "FilingCalendars", "Items", "Locations", "Nexus", "TaxCodes", "NonReportingChildren" or "TaxRules".   * Deleted objects - Specify "FetchDeleted" to retrieve information about previously deleted objects.
-      # @return [Object]
-      def get_company(id, options={})        path = "/api/v2/companies/#{id}"
-        get(path, options)      end
-
-      # Get configuration settings for this company
-      #
+      # @return [Object]
+      def get_company(id, options={})        path = "/api/v2/companies/#{id}"
+        get(path, options)      end
+
+      # Get configuration settings for this company
+      #
       # Retrieve a list of all configuration settings tied to this company.
       #
       # Configuration settings provide you with the ability to control features of your account and of your
@@ -252,14 +252,14 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param id [Integer] 
-      # @return [CompanyConfigurationModel[]]
-      def get_company_configuration(id)        path = "/api/v2/companies/#{id}/configuration"
-        get(path)      end
-
-      # Retrieve a single company parameter
-      #
+      # @return [CompanyConfigurationModel[]]
+      def get_company_configuration(id)        path = "/api/v2/companies/#{id}/configuration"
+        get(path)      end
+
+      # Retrieve a single company parameter
+      #
       # Retrieves a single parameter of a company.
       #
       # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
@@ -270,15 +270,15 @@ 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 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] 
       # @param id [Integer] 
-      # @return [Object]
-      def get_company_parameter_detail(companyId, id)        path = "/api/v2/companies/#{companyId}/parameters/#{id}"
-        get(path)      end
-
-      # Get this company's filing status
-      #
+      # @return [Object]
+      def get_company_parameter_detail(companyId, id)        path = "/api/v2/companies/#{companyId}/parameters/#{id}"
+        get(path)      end
+
+      # Get this company's filing status
+      #
       # Retrieve the current filing status of this company.
       #
       # For customers using Avalara's Managed Returns Service, each company within their account can request
@@ -296,14 +296,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 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 id [Integer] 
-      # @return [String]
-      def get_filing_status(id)        path = "/api/v2/companies/#{id}/filingstatus"
-        get(path)      end
-
-      # Retrieve parameters for a company
-      #
+      # @return [String]
+      def get_filing_status(id)        path = "/api/v2/companies/#{id}/filingstatus"
+        get(path)      end
+
+      # Retrieve parameters for a company
+      #
       # Retrieve all parameters of a company.
       #
       # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
@@ -317,18 +317,18 @@ 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 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
       # @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:* name, unit
       # @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_company_parameter_details(companyId, options={})        path = "/api/v2/companies/#{companyId}/parameters"
-        get(path, options)      end
-
-      # Check managed returns funding status for a company
-      #
+      # @return [FetchResult]
+      def list_company_parameter_details(companyId, options={})        path = "/api/v2/companies/#{companyId}/parameters"
+        get(path, options)      end
+
+      # Check managed returns funding status for a company
+      #
       # This API is available by invitation only.
       # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
       # Returns a list of funding setup requests and their current status.
@@ -337,27 +337,27 @@ module AvaTax
       # ### Security Policies
       #
       # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
-      # * 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 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 id [Integer] The unique identifier of the company
-      # @return [FundingStatusModel[]]
-      def list_funding_requests_by_company(id)        path = "/api/v2/companies/#{id}/funding"
-        get(path)      end
-
-      # Retrieve a list of MRS Companies with account
-      #
+      # @return [FundingStatusModel[]]
+      def list_funding_requests_by_company(id)        path = "/api/v2/companies/#{id}/funding"
+        get(path)      end
+
+      # Retrieve a list of MRS Companies with account
+      #
       # This API is available by invitation only.
       #
       # Get a list of companies with an active MRS service.
       #
       # ### 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.
-      # @return [FetchResult]
-      def list_mrs_companies()        path = "/api/v2/companies/mrs"
-        get(path)      end
-
-      # Retrieve all companies
-      #
+      # * 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.
+      # @return [FetchResult]
+      def list_mrs_companies()        path = "/api/v2/companies/mrs"
+        get(path)      end
+
+      # Retrieve all companies
+      #
       # Get multiple company objects.
       #
       # A `company` represents a single corporation or individual that is registered to handle transactional taxes.
@@ -378,18 +378,18 @@ 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 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 include [String] A comma separated list of objects to fetch underneath this company. Any object with a URL path underneath this company can be fetched by specifying its name.
       # @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:* IsFein, contacts, items, locations, nexus, settings, taxCodes, taxRules, upcs, nonReportingChildCompanies, exemptCerts, parameters, supplierandcustomers
       # @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_companies(options={})        path = "/api/v2/companies"
-        get(path, options)      end
-
-      # Change configuration settings for this company
-      #
+      # @return [FetchResult]
+      def query_companies(options={})        path = "/api/v2/companies"
+        get(path, options)      end
+
+      # Change configuration settings for this company
+      #
       # Update configuration settings tied to this company.
       #
       # Configuration settings provide you with the ability to control features of your account and of your
@@ -405,15 +405,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param id [Integer] 
       # @param model [CompanyConfigurationModel[]] 
-      # @return [CompanyConfigurationModel[]]
-      def set_company_configuration(id, model)        path = "/api/v2/companies/#{id}/configuration"
-        post(path, model)      end
-
-      # Update a single company
-      #
+      # @return [CompanyConfigurationModel[]]
+      def set_company_configuration(id, model)        path = "/api/v2/companies/#{id}/configuration"
+        post(path, model)      end
+
+      # Update a single company
+      #
       # Replace the existing company object at this URL with an updated object.
       #
       # A `CompanyModel` represents a single corporation or individual that is registered to handle transactional taxes.
@@ -428,15 +428,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] The ID of the company you wish to update.
       # @param model [Object] The company object you wish to update.
-      # @return [Object]
-      def update_company(id, model)        path = "/api/v2/companies/#{id}"
-        put(path, model)      end
-
-      # Update a company parameter
-      #
+      # @return [Object]
+      def update_company(id, model)        path = "/api/v2/companies/#{id}"
+        put(path, model)      end
+
+      # Update a company parameter
+      #
       # Update a parameter of a company.
       #
       # Some companies can be taxed and reported differently depending on the properties of the company, such as IsPrimaryAddress. In AvaTax, these tax-affecting properties are called "parameters".
@@ -447,13 +447,13 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The company id.
       # @param id [Integer] The company parameter id
       # @param model [Object] The company parameter object you wish to update.
-      # @return [Object]
-      def update_company_parameter_detail(companyId, id, model)        path = "/api/v2/companies/#{companyId}/parameters/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_company_parameter_detail(companyId, id, model)        path = "/api/v2/companies/#{companyId}/parameters/#{id}"
+        put(path, model)      end
+    end
+  end
 end

data/lib/avatax/client/contacts.rb

@@ -1,53 +1,53 @@
-module AvaTax
-  class Client
-    module Contacts 
-
-
-      # Create a new contact
-      #
+module AvaTax
+  class Client
+    module Contacts 
+
+
+      # Create a new contact
+      #
       # Create one or more new contact objects.
       # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
       # a tax collecting and filing entity.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this contact.
       # @param model [ContactModel[]] The contacts you wish to create.
-      # @return [ContactModel[]]
-      def create_contacts(companyId, model)        path = "/api/v2/companies/#{companyId}/contacts"
-        post(path, model)      end
-
-      # Delete a single contact
-      #
+      # @return [ContactModel[]]
+      def create_contacts(companyId, model)        path = "/api/v2/companies/#{companyId}/contacts"
+        post(path, model)      end
+
+      # Delete a single contact
+      #
       # Mark the existing contact object at this URL as deleted.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this contact.
       # @param id [Integer] The ID of the contact you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_contact(companyId, id)        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
-        delete(path)      end
-
-      # Retrieve a single contact
-      #
+      # @return [ErrorDetail[]]
+      def delete_contact(companyId, id)        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
+        delete(path)      end
+
+      # Retrieve a single contact
+      #
       # Get the contact object identified by this URL.
       # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
       # a tax collecting and filing entity.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param companyId [Integer] The ID of the company for this contact
       # @param id [Integer] The primary key of this contact
-      # @return [Object]
-      def get_contact(companyId, id)        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
-        get(path)      end
-
-      # Retrieve contacts for this company
-      #
+      # @return [Object]
+      def get_contact(companyId, id)        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
+        get(path)      end
+
+      # Retrieve contacts for this company
+      #
       # List all contact objects assigned to this company.
       #
       # 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/) .
@@ -55,18 +55,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param companyId [Integer] The ID of the company that owns these contacts
       # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).
       # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. 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_contacts_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/contacts"
-        get(path, options)      end
-
-      # Retrieve all contacts
-      #
+      # @return [FetchResult]
+      def list_contacts_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/contacts"
+        get(path, options)      end
+
+      # Retrieve all contacts
+      #
       # Get multiple contact objects across all companies.
       # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
       # a tax collecting and filing entity.
@@ -76,17 +76,17 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, 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 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_contacts(options={})        path = "/api/v2/contacts"
-        get(path, options)      end
-
-      # Update a single contact
-      #
+      # @return [FetchResult]
+      def query_contacts(options={})        path = "/api/v2/contacts"
+        get(path, options)      end
+
+      # Update a single contact
+      #
       # Replace the existing contact object at this URL with an updated object.
       # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
       # a tax collecting and filing entity.
@@ -95,13 +95,13 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, SSTAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that this contact belongs to.
       # @param id [Integer] The ID of the contact you wish to update
       # @param model [Object] The contact you wish to update.
-      # @return [Object]
-      def update_contact(companyId, id, model)        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_contact(companyId, id, model)        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
+        put(path, model)      end
+    end
+  end
 end