avatax 20.9.0 → 21.10.0

data/lib/avatax/client/multidocument.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module MultiDocument 
-
-
-      # Adjust a MultiDocument transaction
-      #
+module AvaTax
+  class Client
+    module MultiDocument 
+
+
+      # Adjust a MultiDocument transaction
+      #
       # Adjusts the current MultiDocument transaction uniquely identified by this URL.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -27,17 +27,17 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param code [String] The transaction code for this MultiDocument transaction
       # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The adjust request you wish to execute
-      # @return [Object]
-      def adjust_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
-        post(path, model, options)      end
-
-      # Get audit information about a MultiDocument transaction
-      #
+      # @return [Object]
+      def adjust_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
+        post(path, model, options)      end
+
+      # Get audit information about a MultiDocument transaction
+      #
       # Retrieve audit information about a MultiDocument transaction stored in AvaTax.
       #
       # The audit API retrieves audit information related to a specific MultiDocument transaction. This audit
@@ -64,15 +64,15 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param code [String] The transaction code for this MultiDocument transaction
       # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
-      # @return [Object]
-      def audit_multi_document_transaction(code, type)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
-        get(path)      end
-
-      # Commit a MultiDocument transaction
-      #
+      # @return [Object]
+      def audit_multi_document_transaction(code, type)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
+        get(path)      end
+
+      # Commit a MultiDocument transaction
+      #
       # Marks a list of transactions by changing its status to `Committed`.
       #
       # Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
@@ -93,14 +93,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param model [Object] The commit request you wish to execute
-      # @return [Object]
-      def commit_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/commit"
-        post(path, model)      end
-
-      # Create a new MultiDocument transaction
-      #
+      # @return [Object]
+      def commit_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/commit"
+        post(path, model)      end
+
+      # Create a new MultiDocument transaction
+      #
       # Records a new MultiDocument transaction in AvaTax.
       #
       # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -145,15 +145,15 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] the multi document transaction model
-      # @return [Object]
-      def create_multi_document_transaction(model, options={})        path = "/api/v2/transactions/multidocument"
-        post(path, model, options)      end
-
-      # Retrieve a MultiDocument transaction
-      #
+      # @return [Object]
+      def create_multi_document_transaction(model, options={})        path = "/api/v2/transactions/multidocument"
+        post(path, model, options)      end
+
+      # Retrieve a MultiDocument transaction
+      #
       # Get the current MultiDocument transaction identified by this URL.
       #
       # If this transaction was adjusted, the return value of this API will be the current transaction with this code.
@@ -178,16 +178,16 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
-      # @param code [String] 
-      # @param type [String]  (See DocumentType::* for a list of allowable values)
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # @param code [String] The multidocument code to retrieve
+      # @param type [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in the response after transaction is created
-      # @return [Object]
-      def get_multi_document_transaction_by_code_and_type(code, type, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
-        get(path, options)      end
-
-      # Retrieve a MultiDocument transaction by ID
-      #
+      # @return [Object]
+      def get_multi_document_transaction_by_code_and_type(code, type, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
+        get(path, options)      end
+
+      # Retrieve a MultiDocument transaction by ID
+      #
       # Get the unique MultiDocument transaction identified by this URL.
       #
       # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -221,15 +221,15 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
       # @param include [String] Specifies objects to include in the response after transaction is created
-      # @return [Object]
-      def get_multi_document_transaction_by_id(id, options={})        path = "/api/v2/transactions/multidocument/#{id}"
-        get(path, options)      end
-
-      # Retrieve all MultiDocument transactions
-      #
+      # @return [Object]
+      def get_multi_document_transaction_by_id(id, options={})        path = "/api/v2/transactions/multidocument/#{id}"
+        get(path, options)      end
+
+      # Retrieve all MultiDocument transactions
+      #
       # List all MultiDocument transactions within this account.
       #
       # This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument
@@ -261,18 +261,18 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @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:* documents
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @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_multi_document_transactions(options={})        path = "/api/v2/transactions/multidocument"
-        get(path, options)      end
-
-      # Create a refund for a MultiDocument transaction
-      #
+      # @return [FetchResult]
+      def list_multi_document_transactions(options={})        path = "/api/v2/transactions/multidocument"
+        get(path, options)      end
+
+      # Create a refund for a MultiDocument transaction
+      #
       # Create a refund for a MultiDocument transaction.
       #
       # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -321,17 +321,17 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param code [String] The code of this MultiDocument transaction
       # @param type [String] The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] Information about the refund to create
-      # @return [Object]
-      def refund_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
-        post(path, model, options)      end
-
-      # Verify a MultiDocument transaction
-      #
+      # @return [Object]
+      def refund_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
+        post(path, model, options)      end
+
+      # Verify a MultiDocument transaction
+      #
       # Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values.
       #
       # If the transaction does not match these expected values, this API will return an error code indicating which value did not match.
@@ -350,14 +350,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
-      # @return [Object]
-      def verify_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/verify"
-        post(path, model)      end
-
-      # Void a MultiDocument transaction
-      #
+      # @return [Object]
+      def verify_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/verify"
+        post(path, model)      end
+
+      # Void a MultiDocument transaction
+      #
       # Voids the current transaction uniquely identified by this URL.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -379,13 +379,13 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
       # @param code [String] The transaction code for this MultiDocument transaction
       # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
       # @param model [Object] The void request you wish to execute
-      # @return [Object]
-      def void_multi_document_transaction(code, type, model)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
-        post(path, model)      end
-    end
-  end
+      # @return [Object]
+      def void_multi_document_transaction(code, type, model)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
+        post(path, model)      end
+    end
+  end
 end

data/lib/avatax/client/nexus.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Nexus 
-
-
-      # Create a new nexus
-      #
+module AvaTax
+  class Client
+    module Nexus 
+
+
+      # Create a new nexus
+      #
       # Creates one or more new nexus declarations attached to this company.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -27,15 +27,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 companyId [Integer] The ID of the company that owns this nexus.
       # @param model [NexusModel[]] The nexus you wish to create.
-      # @return [NexusModel[]]
-      def create_nexus(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus"
-        post(path, model)      end
-
-      # Add parameters to a nexus.
-      #
+      # @return [NexusModel[]]
+      def create_nexus(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus"
+        post(path, model)      end
+
+      # Add parameters to a nexus.
+      #
       # Add parameters to the nexus.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -49,16 +49,16 @@ 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 companyId [Integer] The ID of the company that owns this nexus parameter.
       # @param nexusId [Integer] The nexus id.
       # @param model [NexusParameterDetailModel[]] The nexus parameters you wish to create.
-      # @return [NexusParameterDetailModel[]]
-      def create_nexus_parameters(companyId, nexusId, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
-        post(path, model)      end
-
-      # Creates nexus for a list of addresses.
-      #
+      # @return [NexusParameterDetailModel[]]
+      def create_nexus_parameters(companyId, nexusId, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
+        post(path, model)      end
+
+      # Creates nexus for a list of addresses.
+      #
       # This call is intended to simplify adding all applicable nexus to a company, for an address or addresses. Calling this
       # API declares nexus for this company, for the list of addresses provided,
       # for the date range provided. You may also use this API to extend effective date on an already-declared nexus.
@@ -77,15 +77,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 companyId [Integer] The ID of the company that will own this nexus.
       # @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
-      # @return [NexusByAddressModel[]]
-      def declare_nexus_by_address(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus/byaddress"
-        post(path, model)      end
-
-      # Delete a single nexus
-      #
+      # @return [NexusByAddressModel[]]
+      def declare_nexus_by_address(companyId, model)        path = "/api/v2/companies/#{companyId}/nexus/byaddress"
+        post(path, model)      end
+
+      # Delete a single nexus
+      #
       # Marks the existing nexus object at this URL as deleted.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -97,16 +97,16 @@ 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 companyId [Integer] The ID of the company that owns this nexus.
       # @param id [Integer] The ID of the nexus you wish to delete.
       # @param cascadeDelete [Boolean] If true, deletes all the child nexus if they exist along with parent nexus
-      # @return [ErrorDetail[]]
-      def delete_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
-        delete(path, options)      end
-
-      # Delete a single nexus parameter
-      #
+      # @return [ErrorDetail[]]
+      def delete_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        delete(path, options)      end
+
+      # Delete a single nexus parameter
+      #
       # Delete a single nexus parameter.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -116,16 +116,16 @@ 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 companyId [Integer] The company id
       # @param nexusId [Integer] The nexus id
       # @param id [Integer] The parameter id
-      # @return [ErrorDetail[]]
-      def delete_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
-        delete(path)      end
-
-      # Delete all parameters for an nexus
-      #
+      # @return [ErrorDetail[]]
+      def delete_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
+        delete(path)      end
+
+      # Delete all parameters for an nexus
+      #
       # Delete all the parameters for a given nexus.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -135,15 +135,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 companyId [Integer] The ID of the company that owns this nexus.
       # @param nexusId [Integer] The ID of the nexus you wish to delete the parameters.
-      # @return [ErrorDetail[]]
-      def delete_nexus_parameters(companyId, nexusId)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
-        delete(path)      end
-
-      # Retrieve a single nexus
-      #
+      # @return [ErrorDetail[]]
+      def delete_nexus_parameters(companyId, nexusId)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
+        delete(path)      end
+
+      # Retrieve a single nexus
+      #
       # Get the nexus object identified by this URL.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -155,16 +155,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns this nexus object
       # @param id [Integer] The primary key of this nexus
       # @param include [String] 
-      # @return [Object]
-      def get_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
-        get(path, options)      end
-
-      # List company nexus related to a tax form
-      #
+      # @return [Object]
+      def get_nexus(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        get(path, options)      end
+
+      # List company nexus related to a tax form
+      #
       # Retrieves a list of nexus related to a tax form.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -180,16 +180,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns this nexus object
       # @param formCode [String] The form code that we are looking up the nexus for
       # @param include [String] 
-      # @return [Object]
-      def get_nexus_by_form_code(companyId, formCode, options={})        path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
-        get(path, options)      end
-
-      # Retrieve a single nexus parameter
-      #
+      # @return [Object]
+      def get_nexus_by_form_code(companyId, formCode, options={})        path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
+        get(path, options)      end
+
+      # Retrieve a single nexus parameter
+      #
       # Retrieve a single nexus parameter.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller.In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -199,16 +199,16 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The company id
       # @param nexusId [Integer] The nexus id
       # @param id [Integer] The parameter id
-      # @return [Object]
-      def get_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
-        get(path)      end
-
-      # Retrieve nexus for this company
-      #
+      # @return [Object]
+      def get_nexus_parameter(companyId, nexusId, id)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
+        get(path)      end
+
+      # Retrieve nexus for this company
+      #
       # List all nexus objects defined for this company.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -223,19 +223,47 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns these nexus objects
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
+      # @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
       # @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_nexus_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/nexus"
-        get(path, options)      end
-
-      # Retrieve parameters for a nexus
+      # @return [FetchResult]
+      def list_nexus_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/nexus"
+        get(path, options)      end
+
+      # Retrieve nexus for this company By TaxTypeGroup
+      #
+      # List all nexus objects defined for this company filtered by TaxTypeGroup.
+      #
+      # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
+      # taxes. The legal requirements for nexus may vary per country and per jurisdiction; please seek advice from your
+      # accountant or lawyer prior to declaring nexus.
+      #
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      # 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:
+      #
+      #  * Parameters
+      #
+      # ### Security Policies
       #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param companyId [Integer] The ID of the company that owns these nexus objects
+      # @param taxTypeGroup [String] Name of TaxTypeGroup to filter by
+      # @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
+      # @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_nexus_by_company_and_tax_type_group(companyId, taxTypeGroup, options={})        path = "/api/v2/companies/#{companyId}/nexus/byTaxTypeGroup/#{taxTypeGroup}"
+        get(path, options)      end
+
+      # Retrieve parameters for a nexus
+      #
       # List parameters for a nexus.
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
       #
@@ -248,19 +276,19 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The company id
       # @param nexusId [Integer] The nexus 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_nexus_parameters(companyId, nexusId, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
-        get(path, options)      end
-
-      # Retrieve all nexus
-      #
+      # @return [FetchResult]
+      def list_nexus_parameters(companyId, nexusId, options={})        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
+        get(path, options)      end
+
+      # Retrieve all nexus
+      #
       # Get multiple nexus objects across all companies.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -275,18 +303,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @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:* streamlinedSalesTax, isSSTActive, taxAuthorityId, taxName, parameters
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
       # @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_nexus(options={})        path = "/api/v2/nexus"
-        get(path, options)      end
-
-      # Update a single nexus
-      #
+      # @return [FetchResult]
+      def query_nexus(options={})        path = "/api/v2/nexus"
+        get(path, options)      end
+
+      # Update a single nexus
+      #
       # Replace the existing nexus declaration object at this URL with an updated object.
       #
       # The concept of Nexus indicates a place where your company is legally obligated to collect and remit transactional
@@ -309,16 +337,16 @@ 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 companyId [Integer] The ID of the company that this nexus belongs to.
       # @param id [Integer] The ID of the nexus you wish to update
       # @param model [Object] The nexus object you wish to update.
-      # @return [Object]
-      def update_nexus(companyId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
-        put(path, model)      end
-
-      # Update an nexus parameter
-      #
+      # @return [Object]
+      def update_nexus(companyId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        put(path, model)      end
+
+      # Update an nexus parameter
+      #
       # Update an nexus parameter.
       #
       # Some tax calculation and reporting are different depending on the properties of the nexus, such as isRemoteSeller. In AvaTax, these tax-affecting properties are called "parameters".
@@ -329,14 +357,14 @@ 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 companyId [Integer] The company id.
       # @param nexusId [Integer] The nexus id
       # @param id [Integer] The nexus parameter id
       # @param model [Object] The nexus object you wish to update.
-      # @return [Object]
-      def update_nexus_parameter(companyId, nexusId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_nexus_parameter(companyId, nexusId, id, model)        path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
+        put(path, model)      end
+    end
+  end
 end