avatax 21.3.1 → 21.9.0

data/lib/avatax/client/notices.rb

@@ -3,424 +3,55 @@ module AvaTax
     module Notices 
 
 
-      # Create a new notice comment.
-      #
-      # This API is available by invitation only.
-      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the tax notice we are adding the comment for.
-      # @param model [NoticeCommentModel[]] The notice comments you wish to create.
-      # @return [NoticeCommentModel[]]
-      def create_notice_comment(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
-        post(path, model)      end
-
-      # Create a new notice finance details.
-      #
-      # This API is available by invitation only.
-      # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
-      # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice added to the finance details.
-      # @param model [NoticeFinanceModel[]] The notice finance details you wish to create.
-      # @return [NoticeFinanceModel[]]
-      def create_notice_finance_details(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
-        post(path, model)      end
-
-      # Create a new notice responsibility.
-      #
-      # This API is available by invitation only.
-      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
-      # @param model [NoticeResponsibilityDetailModel[]] The notice responsibilities you wish to create.
-      # @return [NoticeResponsibilityDetailModel[]]
-      def create_notice_responsibilities(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
-        post(path, model)      end
-
-      # Create a new notice root cause.
-      #
-      # This API is available by invitation only.
-      # 'Notice root causes' are are those who are responsible for the notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the tax notice we are adding the responsibility for.
-      # @param model [NoticeRootCauseDetailModel[]] The notice root causes you wish to create.
-      # @return [NoticeRootCauseDetailModel[]]
-      def create_notice_root_causes(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
+      # Creates a new tax notice responsibility type.
+      #
+      # This API is available by invitation only and only available for users with Compliance admin 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 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 model [Object] The responsibility type to create
+      # @return [Object]
+      def create_notice_responsibility_type(model)        path = "/api/v2/notices/responsibilities"
         post(path, model)      end
 
-      # Create a new notice.
-      #
-      # This API is available by invitation only.
-      # Create one or more new notice objects.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
+      # Creates a new tax notice root cause type.
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param model [NoticeModel[]] The notice object you wish to create.
-      # @return [NoticeModel[]]
-      def create_notices(companyId, model)        path = "/api/v2/companies/#{companyId}/notices"
+      # This API is available by invitation only and only available for users with Compliance admin 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 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 model [Object] The root cause type to create
+      # @return [Object]
+      def create_notice_root_cause_type(model)        path = "/api/v2/notices/rootcauses"
         post(path, model)      end
 
-      # Delete a single notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # Delete a tax notice responsibility type.
       #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
-      # @param commentDetailsId [Integer] The ID of the comment you wish to delete.
+      # This API is available by invitation only and only available for users with Compliance admin 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.
+      # @param responsibilityId [Integer] The unique ID of the responsibility type
       # @return [ErrorDetail[]]
-      def delete_comment_details(companyId, id, commentDetailsId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
+      def delete_notice_responsibility_type(responsibilityId)        path = "/api/v2/notices/responsibilities/#{responsibilityId}"
         delete(path)      end
 
-      # Delete a single notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
-      # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # Delete a tax notice root cause type.
       #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
-      # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
+      # This API is available by invitation only and only available for users with Compliance admin 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.
+      # @param rootCauseId [Integer] The unique ID of the root cause type
       # @return [ErrorDetail[]]
-      def delete_finance_details(companyId, id, financeDetailsId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
+      def delete_notice_root_cause_type(rootCauseId)        path = "/api/v2/notices/rootcauses/#{rootCauseId}"
         delete(path)      end
-
-      # Delete a single notice.
-      #
-      # This API is available by invitation only.
-      # Mark the existing notice object at this URL as deleted.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_notice(companyId, id)        path = "/api/v2/companies/#{companyId}/notices/#{id}"
-        delete(path)      end
-
-      # Delete a single responsibility
-      #
-      # This API is available by invitation only.
-      # Mark the existing notice object at this URL as deleted.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param noticeId [Integer] The ID of the notice you wish to delete.
-      # @param id [Integer] The ID of the responsibility you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_responsibilities(companyId, noticeId, id)        path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/responsibilities/#{id}"
-        delete(path)      end
-
-      # Delete a single root cause.
-      #
-      # This API is available by invitation only.
-      # Mark the existing notice object at this URL as deleted.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param noticeId [Integer] The ID of the notice you wish to delete.
-      # @param id [Integer] The ID of the root cause you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_root_causes(companyId, noticeId, id)        path = "/api/v2/companies/#{companyId}/notices/#{noticeId}/rootcauses/#{id}"
-        delete(path)      end
-
-      # Retrieve a single attachment
-      #
-      # This API is available by invitation only.
-      # Get the file attachment identified by this URL.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company for this attachment.
-      # @param id [Integer] The ResourceFileId of the attachment to download.
-      # @return [Object]
-      def download_notice_attachment(companyId, id)        path = "/api/v2/companies/#{companyId}/notices/files/#{id}/attachment"
-        get(path)      end
-
-      # Retrieve a single notice.
-      #
-      # This API is available by invitation only.
-      # Get the tax notice object identified by this URL.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company for this notice.
-      # @param id [Integer] The ID of this notice.
-      # @return [Object]
-      def get_notice(companyId, id)        path = "/api/v2/companies/#{companyId}/notices/#{id}"
-        get(path)      end
-
-      # Retrieve notice comments for a specific notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param id [Integer] The ID of the notice.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @return [FetchResult]
-      def get_notice_comments(id, companyId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/comments"
-        get(path)      end
-
-      # Retrieve notice finance details for a specific notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
-      # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param id [Integer] The ID of the company that owns these notices.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @return [FetchResult]
-      def get_notice_finance_details(id, companyId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails"
-        get(path)      end
-
-      # Retrieve notice responsibilities for a specific notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice responsibilities' are are those who are responsible for the notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param id [Integer] The ID of the notice.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @return [FetchResult]
-      def get_notice_responsibilities(id, companyId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/responsibilities"
-        get(path)      end
-
-      # Retrieve notice root causes for a specific notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice root causes' are are those who are responsible for the notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param id [Integer] The ID of the notice.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @return [FetchResult]
-      def get_notice_root_causes(id, companyId)        path = "/api/v2/companies/#{companyId}/notices/#{id}/rootcauses"
-        get(path)      end
-
-      # Retrieve notices for a company.
-      #
-      # This API is available by invitation only.
-      # List all tax notice objects assigned to this company.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # 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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that owns these notices.
-      # @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:* status, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
-      # @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_notices_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/notices"
-        get(path, options)      end
-
-      # Retrieve all notices.
-      #
-      # This API is available by invitation only.
-      #
-      # This API is deprecated - please use POST `/api/v2/notices/query` API.
-      #
-      # Get multiple notice objects across all companies.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      #
-      # 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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @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:* status, totalRemit, ticketReferenceNo, ticketReferenceUrl, reason, type, createdByUserName, documentReference, jurisdictionName, jurisdictionType, comments, finances, responsibility, rootCause
-      # @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_notices(options={})        path = "/api/v2/notices"
-        get(path, options)      end
-
-      # Retrieve all notices.
-      #
-      # This API is available by invitation only.
-      #
-      # This API is intended to replace the GET `/api/v2/notices` API. The fetch request object is posted on the body of the request instead of the URI, so it's not limited by a set number of characters.
-      # The documentation of the GET API shows how filtering, sorting and pagination works.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param model [Object] Query object to filter, sort and paginate the filing calendars.
-      # @return [FetchResult]
-      def query_notices_post(model)        path = "/api/v2/notices/query"
-        post(path, model)      end
-
-      # Update a single notice finance detail.
-      #
-      # This API is available by invitation only.
-      # All data from the existing object will be replaced with data in the object you PUT.
-      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that this notice finance detail belongs to.
-      # @param noticeid [Integer] The ID of the notice finance detail you wish to update.
-      # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
-      # @param model [Object] The notice finance detail object you wish to update.
-      # @return [Object]
-      def update_finance_details(companyId, noticeid, financeDetailsId, model)        path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/financedetails/#{financedetailsid}"
-        put(path, model)      end
-
-      # Update a single notice.
-      #
-      # This API is available by invitation only.
-      # Replace the existing notice object at this URL with an updated object.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      # All data from the existing object will be replaced with data in the object you PUT.
-      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that this notice belongs to.
-      # @param id [Integer] The ID of the notice you wish to update.
-      # @param model [Object] The notice object you wish to update.
-      # @return [Object]
-      def update_notice(companyId, id, model)        path = "/api/v2/companies/#{companyId}/notices/#{id}"
-        put(path, model)      end
-
-      # Update a single notice comment.
-      #
-      # This API is available by invitation only.
-      # All data from the existing object will be replaced with data in the object you PUT.
-      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company that this notice comment belongs to.
-      # @param noticeid [Integer] The ID of the notice you wish to update.
-      # @param commentDetailsId [Integer] The ID of the comment you wish to update.
-      # @param model [Object] The notice comment object you wish to update.
-      # @return [Object]
-      def update_notice_comments(companyId, noticeid, commentDetailsId, model)        path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/commentdetails/#{commentdetailsid}"
-        put(path, model)      end
-
-      # Upload a new notice attachment.
-      #
-      # This API is available by invitation only.
-      #
-      # Uploads a file attachment for a tax notice.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Operator, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
-      # @param companyId [Integer] The ID of the company for this attachment.
-      # @param model [Object] The upload request.
-      # @return [Object]
-      def upload_attachment(companyId, model)        path = "/api/v2/companies/#{companyId}/notices/files/attachment"
-        post(path, model)      end
     end
   end
 end

data/lib/avatax/client/notifications.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Notifications 
-
-
-      # Mark a single notification as dismissed.
-      #
+module AvaTax
+  class Client
+    module Notifications 
+
+
+      # Mark a single notification as dismissed.
+      #
       # Marks the notification identified by this URL as dismissed.
       #
       # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -22,14 +22,14 @@ 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, 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] The id of the notification you wish to mark as dismissed.
-      # @return [Object]
-      def dismiss_notification(id)        path = "/api/v2/notifications/#{id}/dismiss"
-        put(path)      end
-
-      # Retrieve a single notification.
-      #
+      # @return [Object]
+      def dismiss_notification(id)        path = "/api/v2/notifications/#{id}/dismiss"
+        put(path)      end
+
+      # Retrieve a single notification.
+      #
       # Retrieve a single notification by its unique ID number.
       #
       # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -41,14 +41,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 notification to retrieve.
-      # @return [Object]
-      def get_notification(id)        path = "/api/v2/notifications/#{id}"
-        get(path)      end
-
-      # List all notifications.
-      #
+      # @return [Object]
+      def get_notification(id)        path = "/api/v2/notifications/#{id}"
+        get(path)      end
+
+      # List all notifications.
+      #
       # List all notifications.
       #
       # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -63,14 +63,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 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_notifications(options={})        path = "/api/v2/notifications"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def list_notifications(options={})        path = "/api/v2/notifications"
+        get(path, options)      end
+    end
+  end
 end

data/lib/avatax/client/provisioning.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Provisioning 
-
-
-      # Request a new Avalara account
-      #
+module AvaTax
+  class Client
+    module Provisioning 
+
+
+      # Request a new Avalara account
+      #
       # This API is for use by partner provisioning services customers only.
       #
       # Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
@@ -24,14 +24,14 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API is available by invitation only.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
+      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
       # @param model [Object] Information about the account you wish to create and the selected product offerings.
-      # @return [Object]
-      def request_new_account(model)        path = "/api/v2/accounts/request"
-        post(path, model)      end
-
-      # Request a new entitilement to an existing customer
-      #
+      # @return [Object]
+      def request_new_account(model)        path = "/api/v2/accounts/request"
+        post(path, model)      end
+
+      # Request a new entitilement to an existing customer
+      #
       # This API is for use by partner provisioning services customers only. This will allow the partners to allow
       # the add new entitlement to an existing customer
       #
@@ -39,12 +39,12 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API is available by invitation only.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
+      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
       # @param id [Integer] The avatax account id of the customer
       # @param offer [String] The offer to be added to an already existing customer
-      # @return [Object]
-      def request_new_entitlement(id, offer)        path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
-        post(path)      end
-    end
-  end
+      # @return [Object]
+      def request_new_entitlement(id, offer)        path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
+        post(path)      end
+    end
+  end
 end