avatax 14.4.4 → 17.5.0

data/lib/avatax/client/nexus.rb

@@ -0,0 +1,157 @@
+module AvaTax
+  class Client
+    module Nexus 
+
+
+      # Create a new nexus
+      # 
+      # Creates one or more new nexus objects attached to this company.
+      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
+      # to collect and remit transaction-based taxes.
+      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
+      # in all jurisdictions affected by your transactions.
+      # Note that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the
+      # '/api/v2/definitions/nexus' endpoint.
+      # You may only define nexus matching the official list of declared nexus.
+      # 
+      # @param int companyId The ID of the company that owns this nexus.
+      # @param NexusModel[] model The nexus you wish to create.
+      # @return NexusModel[]
+      def create_nexus(companyId, model)
+        path = "/api/v2/companies/#{companyId}/nexus"
+        
+        post(path, model)
+      end
+
+
+      # Delete a single nexus
+      # 
+      # Marks the existing nexus object at this URL as deleted.
+      # 
+      # @param int companyId The ID of the company that owns this nexus.
+      # @param int id The ID of the nexus you wish to delete.
+      # @return ErrorDetail[]
+      def delete_nexus(companyId, id)
+        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        
+        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 has sufficient physical presence and is obligated
+      # to collect and remit transaction-based taxes.
+      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
+      # in all jurisdictions affected by your transactions.
+      # 
+      # @param int companyId The ID of the company that owns this nexus object
+      # @param int id The primary key of this nexus
+      # @return NexusModel
+      def get_nexus(companyId, id)
+        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        
+        get(path)
+      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 has sufficient physical presence and is obligated
+      # to collect and remit transaction-based taxes.
+      # 
+      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
+      # in all jurisdictions affected by your transactions.
+      # 
+      # This API is intended to provide useful information when examining a tax form. If you are about to begin filing
+      # a tax form, you may want to know whether you have declared nexus in all the jurisdictions related to that tax 
+      # form in order to better understand how the form will be filled out.
+      # 
+      # @param int companyId The ID of the company that owns this nexus object
+      # @param string formCode The form code that we are looking up the nexus for
+      # @return NexusByTaxFormModel
+      def get_nexus_by_form_code(companyId, formCode)
+        path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
+        
+        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 has sufficient physical presence and is obligated
+      # to collect and remit transaction-based taxes.
+      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
+      # in all jurisdictions affected by your transactions.
+      # 
+      # 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.
+      # 
+      # @param int companyId The ID of the company that owns these nexus objects
+      # @param string filter 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 string include A comma separated list of child objects to return underneath the primary object.
+      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy 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 all nexus
+      # 
+      # Get multiple nexus objects across all companies.
+      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
+      # to collect and remit transaction-based taxes.
+      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
+      # in all jurisdictions affected by your transactions.
+      # 
+      # 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.
+      # 
+      # @param string filter 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 string include A comma separated list of child objects to return underneath the primary object.
+      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy 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
+      # 
+      # Replace the existing nexus object at this URL with an updated object.
+      # The concept of 'Nexus' indicates a place where your company has sufficient physical presence and is obligated
+      # to collect and remit transaction-based taxes.
+      # When defining companies in AvaTax, you must declare nexus for your company in order to correctly calculate tax
+      # in all jurisdictions affected by your transactions.
+      # Note that not all fields within a nexus can be updated; Avalara publishes a list of all defined nexus at the
+      # '/api/v2/definitions/nexus' endpoint.
+      # You may only define nexus matching the official list of declared nexus.
+      # 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.
+      # 
+      # @param int companyId The ID of the company that this nexus belongs to.
+      # @param int id The ID of the nexus you wish to update
+      # @param NexusModel model The nexus object you wish to update.
+      # @return NexusModel
+      def update_nexus(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/nexus/#{id}"
+        
+        put(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/notices.rb

@@ -0,0 +1,297 @@
+module AvaTax
+  class Client
+    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.
+      # 
+      # @param int companyId The ID of the company that owns this notice.
+      # @param int id The ID of the tax notice we are adding the comment for.
+      # @param NoticeCommentModel[] model 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.
+      # 
+      # @param int companyId The ID of the company that owns this notice.
+      # @param int id The ID of the notice added to the finance details.
+      # @param NoticeFinanceModel[] model 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.
+      # 
+      # @param int companyId The ID of the company that owns this notice.
+      # @param int id The ID of the tax notice we are adding the responsibility for.
+      # @param NoticeResponsibilityDetailModel[] model 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.
+      # 
+      # @param int companyId The ID of the company that owns this notice.
+      # @param int id The ID of the tax notice we are adding the responsibility for.
+      # @param NoticeRootCauseDetailModel[] model 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"
+        
+        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.
+      # 
+      # @param int companyId The ID of the company that owns this notice.
+      # @param NoticeModel[] model The notice object you wish to create.
+      # @return NoticeModel[]
+      def create_notices(companyId, model)
+        path = "/api/v2/companies/#{companyId}/notices"
+        
+        post(path, model)
+      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.
+      # 
+      # @param int companyId The ID of the company that owns this notice.
+      # @param int id 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
+
+
+      # Retrieve a single attachment
+      # 
+      # This API is available by invitation only.
+      # Get the file attachment identified by this URL.
+      # 
+      # @param int companyId The ID of the company for this attachment.
+      # @param int id The ResourceFileId of the attachment to download.
+      # @return FileResult
+      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.
+      # 
+      # @param int companyId The ID of the company for this notice.
+      # @param int id The ID of this notice.
+      # @return NoticeModel
+      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.
+      # 
+      # @param int id The ID of the notice.
+      # @param int companyId 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.
+      # 
+      # @param int id The ID of the company that owns these notices.
+      # @param int companyId 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.
+      # 
+      # @param int id The ID of the notice.
+      # @param int companyId 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.
+      # 
+      # @param int id The ID of the notice.
+      # @param int companyId 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.
+      # 
+      # @param int companyId The ID of the company that owns these notices.
+      # @param string filter 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 string include A comma separated list of child objects to return underneath the primary object.
+      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy 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.
+      # 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.
+      # 
+      # @param string filter 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 string include A comma separated list of child objects to return underneath the primary object.
+      # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
+      # @param string orderBy 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
+
+
+      # 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.
+      # 
+      # @param int companyId The ID of the company that this notice belongs to.
+      # @param int id The ID of the notice you wish to update.
+      # @param NoticeModel model The notice object you wish to update.
+      # @return NoticeModel
+      def update_notice(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/notices/#{id}"
+        
+        put(path, model)
+      end
+
+
+      # Retrieve a single attachment
+      # 
+      # This API is available by invitation only.
+      # Get the file attachment identified by this URL.
+      # 
+      # @param int companyId The ID of the company for this attachment.
+      # @param ResourceFileUploadRequestModel model The ResourceFileId of the attachment to download.
+      # @return FileResult
+      def upload_attachment(companyId, model)
+        path = "/api/v2/companies/#{companyId}/notices/files/attachment"
+        
+        post(path, model)
+      end
+
+    end
+  end
+end