avatax 14.4.4 → 17.5.0

data/lib/avatax/client/batches.rb

@@ -0,0 +1,117 @@
+module AvaTax
+  class Client
+    module Batches 
+
+
+      # Create a new batch
+      # 
+      # Create one or more new batch objects attached to this company.
+      # A batch object is a large collection of API calls stored in a compact file.
+      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
+      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
+      # Each batch object may have one or more file objects attached.
+      # 
+      # @param int companyId The ID of the company that owns this batch.
+      # @param BatchModel[] model The batch you wish to create.
+      # @return BatchModel[]
+      def create_batches(companyId, model)
+        path = "/api/v2/companies/#{companyId}/batches"
+        
+        post(path, model)
+      end
+
+
+      # Delete a single batch
+      # 
+      # Mark the existing batch object at this URL as deleted.
+      # 
+      # @param int companyId The ID of the company that owns this batch.
+      # @param int id The ID of the batch you wish to delete.
+      # @return ErrorDetail[]
+      def delete_batch(companyId, id)
+        path = "/api/v2/companies/#{companyId}/batches/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Download a single batch file
+      # 
+      # Download a single batch file identified by this URL.
+      # 
+      # @param int companyId The ID of the company that owns this batch
+      # @param int batchId The ID of the batch object
+      # @param int id The primary key of this batch file object
+      # @return FileResult
+      def download_batch(companyId, batchId, id)
+        path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
+        
+        get(path)
+      end
+
+
+      # Retrieve a single batch
+      # 
+      # Get the batch object identified by this URL.
+      # A batch object is a large collection of API calls stored in a compact file.
+      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
+      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
+      # 
+      # @param int companyId The ID of the company that owns this batch
+      # @param int id The primary key of this batch
+      # @return BatchModel
+      def get_batch(companyId, id)
+        path = "/api/v2/companies/#{companyId}/batches/#{id}"
+        
+        get(path)
+      end
+
+
+      # Retrieve all batches for this company
+      # 
+      # List all batch objects attached to the specified company.
+      # A batch object is a large collection of API calls stored in a compact file.
+      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
+      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
+      # 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 batches
+      # @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_batches_by_company(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/batches"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve all batches
+      # 
+      # Get multiple batch objects across all companies.
+      # A batch object is a large collection of API calls stored in a compact file.
+      # When you create a batch, it is added to the AvaTax Batch Queue and will be processed in the order it was received.
+      # You may fetch a batch to check on its status and retrieve the results of the batch operation.
+      # 
+      # 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_batches(options={})
+        path = "/api/v2/batches"
+        
+        get(path, options)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/companies.rb

@@ -0,0 +1,218 @@
+module AvaTax
+  class Client
+    module Companies 
+
+
+      # Quick setup for a company with a single physical address
+      # 
+      # Shortcut to quickly setup a single-physical-location company with critical information and activate it.
+      # This API provides quick and simple company setup functionality and does the following things:
+      #  
+      # * Create a company object with its own tax profile
+      # * Add a key contact person for the company
+      # * Set up one physical location for the main office
+      # * Declare nexus in all taxing jurisdictions for that main office address
+      # * Activate the company
+      #  
+      # This API only provides a limited subset of functionality compared to the 'Create Company' API call. 
+      # If you need additional features or options not present in this 'Quick Setup' API call, please use the full 'Create Company' call instead.
+      # 
+      # @param CompanyInitializationModel model Information about the company you wish to create.
+      # @return CompanyModel
+      def company_initialize(model)
+        path = "/api/v2/companies/initialize"
+        
+        post(path, model)
+      end
+
+
+      # Create new companies
+      # 
+      # Create one or more new company objects.
+      # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
+      # You may attach nested data objects such as contacts, locations, and nexus with this CREATE call, and those objects will be created with the company.
+      # 
+      # @param CompanyModel[] model Either a single company object or an array of companies to create
+      # @return CompanyModel[]
+      def create_companies(model)
+        path = "/api/v2/companies"
+        
+        post(path, model)
+      end
+
+
+      # Request managed returns funding setup for a company
+      # 
+      # This API is available by invitation only.
+      # Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are 
+      # required to setup their funding configuration before Avalara can begin filing tax returns on their 
+      # behalf.
+      # Funding configuration for each company is set up by submitting a funding setup request, which can
+      # be sent either via email or via an embedded HTML widget.
+      # When the funding configuration is submitted to Avalara, it will be reviewed by treasury team members
+      # before approval.
+      # This API records that an ambedded HTML funding setup widget was activated.
+      # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
+      # 
+      # @param int id The unique identifier of the company
+      # @param FundingInitiateModel model The funding initialization request
+      # @return FundingStatusModel
+      def create_funding_request(id, model)
+        path = "/api/v2/companies/#{id}/funding/setup"
+        
+        post(path, model)
+      end
+
+
+      # Delete a single company
+      # 
+      # Deleting a company will delete all child companies, and all users attached to this company.
+      # 
+      # @param int id The ID of the company you wish to delete.
+      # @return ErrorDetail[]
+      def delete_company(id)
+        path = "/api/v2/companies/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Retrieve a single company
+      # 
+      # Get the company object identified by this URL.
+      # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
+      # You may specify one or more of the following values in the '$include' parameter to fetch additional nested data, using commas to separate multiple values:
+      # 
+      #  * Contacts
+      #  * Items
+      #  * Locations
+      #  * Nexus
+      #  * Settings
+      #  * TaxCodes
+      #  * TaxRules
+      #  * UPC
+      # 
+      # @param int id The ID of the company to retrieve.
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @return CompanyModel
+      def get_company(id, options={})
+        path = "/api/v2/companies/#{id}"
+        
+        get(path, options)
+      end
+
+
+      # Get configuration settings for this company
+      # 
+      # Retrieve a list of all configuration settings tied to this company.
+      # 
+      # Configuration settings provide you with the ability to control features of your account and of your
+      # tax software. The category names `AvaCertServiceConfig` is reserved for
+      # Avalara internal software configuration values; to store your own account-level settings, please
+      # create a new category name that begins with `X-`, for example, `X-MyCustomCategory`.
+      # 
+      # Company settings are permanent settings that cannot be deleted. You can set the value of a
+      # company setting to null if desired.
+      # 
+      # Avalara-based account settings for `AvaCertServiceConfig` affect your account's exemption certificate
+      # processing, and should only be changed with care.
+      # 
+      # @param int id 
+      # @return CompanyConfigurationModel[]
+      def get_company_configuration(id)
+        path = "/api/v2/companies/#{id}/configuration"
+        
+        get(path)
+      end
+
+
+      # Check managed returns funding configuration for a company
+      # 
+      # This API is available by invitation only.
+      # Requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
+      # Returns a list of funding setup requests and their current status.
+      # Each object in the result is a request that was made to setup or adjust funding configuration for this company.
+      # 
+      # @param int id The unique identifier of the company
+      # @return FundingStatusModel[]
+      def list_funding_requests_by_company(id)
+        path = "/api/v2/companies/#{id}/funding"
+        
+        get(path)
+      end
+
+
+      # Retrieve all companies
+      # 
+      # Get multiple company objects.
+      # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
+      # 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:
+      #  
+      # * Contacts
+      # * Items
+      # * Locations
+      # * Nexus
+      # * Settings
+      # * TaxCodes
+      # * TaxRules
+      # * UPC
+      # 
+      # @param string include A comma separated list of child objects to return underneath the primary object.
+      # @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 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_companies(options={})
+        path = "/api/v2/companies"
+        
+        get(path, options)
+      end
+
+
+      # Change configuration settings for this account
+      # 
+      # Update configuration settings tied to this account.
+      # 
+      # Configuration settings provide you with the ability to control features of your account and of your
+      # tax software. The category names `AvaCertServiceConfig` is reserved for
+      # Avalara internal software configuration values; to store your own account-level settings, please
+      # create a new category name that begins with `X-`, for example, `X-MyCustomCategory`.
+      # 
+      # Company settings are permanent settings that cannot be deleted. You can set the value of a
+      # company setting to null if desired.
+      # 
+      # Avalara-based account settings for `AvaCertServiceConfig` affect your account's exemption certificate
+      # processing, and should only be changed with care.
+      # 
+      # @param int id 
+      # @param CompanyConfigurationModel[] model 
+      # @return CompanyConfigurationModel[]
+      def set_company_configuration(id, model)
+        path = "/api/v2/companies/#{id}/configuration"
+        
+        post(path, model)
+      end
+
+
+      # Update a single company
+      # 
+      # Replace the existing company object at this URL with an updated object.
+      # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
+      # 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 id The ID of the company you wish to update.
+      # @param CompanyModel model The company object you wish to update.
+      # @return CompanyModel
+      def update_company(id, model)
+        path = "/api/v2/companies/#{id}"
+        
+        put(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/contacts.rb

@@ -0,0 +1,115 @@
+module AvaTax
+  class Client
+    module Contacts 
+
+
+      # Create a new contact
+      # 
+      # Create one or more new contact objects.
+      # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
+      # a tax collecting and filing entity.
+      # 
+      # @param int companyId The ID of the company that owns this contact.
+      # @param ContactModel[] model The contacts you wish to create.
+      # @return ContactModel[]
+      def create_contacts(companyId, model)
+        path = "/api/v2/companies/#{companyId}/contacts"
+        
+        post(path, model)
+      end
+
+
+      # Delete a single contact
+      # 
+      # Mark the existing contact object at this URL as deleted.
+      # 
+      # @param int companyId The ID of the company that owns this contact.
+      # @param int id The ID of the contact you wish to delete.
+      # @return ErrorDetail[]
+      def delete_contact(companyId, id)
+        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Retrieve a single contact
+      # 
+      # Get the contact object identified by this URL.
+      # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
+      # a tax collecting and filing entity.
+      # 
+      # @param int companyId The ID of the company for this contact
+      # @param int id The primary key of this contact
+      # @return ContactModel
+      def get_contact(companyId, id)
+        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
+        
+        get(path)
+      end
+
+
+      # Retrieve contacts for this company
+      # 
+      # List all contact objects assigned to this company.
+      # 
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      # 
+      # @param int companyId The ID of the company that owns these contacts
+      # @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_contacts_by_company(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/contacts"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve all contacts
+      # 
+      # Get multiple contact objects across all companies.
+      # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
+      # a tax collecting and filing entity.
+      # 
+      # 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_contacts(options={})
+        path = "/api/v2/contacts"
+        
+        get(path, options)
+      end
+
+
+      # Update a single contact
+      # 
+      # Replace the existing contact object at this URL with an updated object.
+      # A 'contact' is a person associated with a company who is designated to handle certain responsibilities of
+      # a tax collecting and filing entity.
+      # 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 contact belongs to.
+      # @param int id The ID of the contact you wish to update
+      # @param ContactModel model The contact you wish to update.
+      # @return ContactModel
+      def update_contact(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/contacts/#{id}"
+        
+        put(path, model)
+      end
+
+    end
+  end
+end