avatax 14.4.4 → 17.5.0

data/lib/avatax/client/free.rb

@@ -0,0 +1,104 @@
+module AvaTax
+  class Client
+    module Free 
+
+
+      # FREE API - Request a free trial of AvaTax
+      # 
+      # Call this API to obtain a free AvaTax sandbox account.
+      # 
+      # This API is free to use. No authentication credentials are required to call this API.
+      # The account will grant a full trial version of AvaTax (e.g. AvaTaxPro) for a limited period of time.
+      # After this introductory period, you may continue to use the free TaxRates API.
+      # 
+      # Limitations on free trial accounts:
+      #  
+      # * Only one free trial per company.
+      # * The free trial account does not expire.
+      # * Includes a limited time free trial of AvaTaxPro; after that date, the free TaxRates API will continue to work.
+      # * Each free trial account must have its own valid email address.
+      # 
+      # @param FreeTrialRequestModel model Required information to provision a free trial account.
+      # @return NewAccountModel
+      def request_free_trial(model)
+        path = "/api/v2/accounts/freetrials/request"
+        
+        post(path, model)
+      end
+
+
+      # FREE API - Sales tax rates for a specified address
+      # 
+      # # Free-To-Use
+      # 
+      # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
+      # Any customer can request a free AvaTax account and make use of the TaxRates API.
+      # However, this API is currently limited for US only
+      # 
+      # Note that the TaxRates API assumes the sale of general tangible personal property when estimating the sales tax
+      # rate for a specified address. Avalara provides the `CreateTransaction` API, which provides extensive tax calculation 
+      # support for scenarios including, but not limited to:
+      # 
+      # * Nexus declarations
+      # * Taxability based on product/service type
+      # * Sourcing rules affecting origin/destination states
+      # * Customers who are exempt from certain taxes
+      # * States that have dollar value thresholds for tax amounts
+      # * Refunds for products purchased on a different date
+      # * Detailed jurisdiction names and state assigned codes
+      # * And more!
+      # 
+      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
+      # for information on how to upgrade to the full AvaTax CreateTransaction API.
+      # 
+      # @param string line1 The street address of the location.
+      # @param string line2 The street address of the location.
+      # @param string line3 The street address of the location.
+      # @param string city The city name of the location.
+      # @param string region The state or region of the location
+      # @param string postalCode The postal code of the location.
+      # @param string country The two letter ISO-3166 country code.
+      # @return TaxRateModel
+      def tax_rates_by_address(options={})
+        path = "/api/v2/taxrates/byaddress"
+        
+        get(path, options)
+      end
+
+
+      # FREE API - Sales tax rates for a specified country and postal code
+      # 
+      # # Free-To-Use
+      # 
+      # The TaxRates API is a free-to-use, no cost option for estimating sales tax rates.
+      # Any customer can request a free AvaTax account and make use of the TaxRates API.
+      # However, this API is currently limited for US only
+      # 
+      # Note that the TaxRates API assumes the sale of general tangible personal property when estimating the sales tax
+      # rate for a specified address. Avalara provides the `CreateTransaction` API, which provides extensive tax calculation 
+      # support for scenarios including, but not limited to:
+      # 
+      # * Nexus declarations
+      # * Taxability based on product/service type
+      # * Sourcing rules affecting origin/destination states
+      # * Customers who are exempt from certain taxes
+      # * States that have dollar value thresholds for tax amounts
+      # * Refunds for products purchased on a different date
+      # * Detailed jurisdiction names and state assigned codes
+      # * And more!
+      # 
+      # Please see [Estimating Tax with REST v2](http://developer.avalara.com/blog/2016/11/04/estimating-tax-with-rest-v2/)
+      # for information on how to upgrade to the full AvaTax CreateTransaction API.
+      # 
+      # @param string country The two letter ISO-3166 country code.
+      # @param string postalCode The postal code of the location.
+      # @return TaxRateModel
+      def tax_rates_by_postal_code(options={})
+        path = "/api/v2/taxrates/bypostalcode"
+        
+        get(path, options)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/fundingrequests.rb

@@ -0,0 +1,53 @@
+module AvaTax
+  class Client
+    module FundingRequests 
+
+
+      # Request the javascript for a funding setup widget
+      # 
+      # 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 returns back the actual javascript code to insert into your application to render the 
+      # JavaScript funding setup widget inline.
+      # Use the 'methodReturn.javaScript' return value to insert this widget into your HTML page.
+      # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
+      # 
+      # @param int id The unique ID number of this funding request
+      # @return FundingStatusModel
+      def activate_funding_request(id)
+        path = "/api/v2/fundingrequests/#{id}/widget"
+        
+        get(path)
+      end
+
+
+      # Retrieve status about a funding setup request
+      # 
+      # 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 checks the status on an existing funding request.
+      # This API requires a subscription to Avalara Managed Returns or SST Certified Service Provider.
+      # 
+      # @param int id The unique ID number of this funding request
+      # @return FundingStatusModel
+      def funding_request_status(id)
+        path = "/api/v2/fundingrequests/#{id}"
+        
+        get(path)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/items.rb

@@ -0,0 +1,111 @@
+module AvaTax
+  class Client
+    module Items 
+
+
+      # Create a new item
+      # 
+      # Creates one or more new item objects attached to this company.
+      # 
+      # @param int companyId The ID of the company that owns this item.
+      # @param ItemModel[] model The item you wish to create.
+      # @return ItemModel[]
+      def create_items(companyId, model)
+        path = "/api/v2/companies/#{companyId}/items"
+        
+        post(path, model)
+      end
+
+
+      # Delete a single item
+      # 
+      # Marks the item object at this URL as deleted.
+      # 
+      # @param int companyId The ID of the company that owns this item.
+      # @param int id The ID of the item you wish to delete.
+      # @return ErrorDetail[]
+      def delete_item(companyId, id)
+        path = "/api/v2/companies/#{companyId}/items/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Retrieve a single item
+      # 
+      # Get the item object identified by this URL.
+      # An 'Item' represents a product or service that your company offers for sale.
+      # 
+      # @param int companyId The ID of the company that owns this item object
+      # @param int id The primary key of this item
+      # @return ItemModel
+      def get_item(companyId, id)
+        path = "/api/v2/companies/#{companyId}/items/#{id}"
+        
+        get(path)
+      end
+
+
+      # Retrieve items for this company
+      # 
+      # List all items defined for the current company.
+      # 
+      # An 'Item' represents a product or service that your company offers for sale.
+      # 
+      # 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 defined these items
+      # @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_items_by_company(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/items"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve all items
+      # 
+      # Get multiple item objects across all companies.
+      # An 'Item' represents a product or service that your company offers for sale.
+      # 
+      # 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_items(options={})
+        path = "/api/v2/items"
+        
+        get(path, options)
+      end
+
+
+      # Update a single item
+      # 
+      # Replace the existing item object at this URL with an updated object.
+      # 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 item belongs to.
+      # @param int id The ID of the item you wish to update
+      # @param ItemModel model The item object you wish to update.
+      # @return ItemModel
+      def update_item(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/items/#{id}"
+        
+        put(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/jurisdictionoverrides.rb

@@ -0,0 +1,125 @@
+module AvaTax
+  class Client
+    module JurisdictionOverrides 
+
+
+      # Create one or more overrides
+      # 
+      # Creates one or more jurisdiction override objects for this account.
+      # 
+      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
+      # jurisdiction for a specific address. If you encounter an address that is on the boundary
+      # between two different jurisdictions, you can choose to set up a jurisdiction override
+      # to switch this address to use different taxing jurisdictions.
+      # 
+      # @param int accountId The ID of the account that owns this override
+      # @param JurisdictionOverrideModel[] model The jurisdiction override objects to create
+      # @return JurisdictionOverrideModel[]
+      def create_jurisdiction_overrides(accountId, model)
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
+        
+        post(path, model)
+      end
+
+
+      # Delete a single override
+      # 
+      # Marks the item object at this URL as deleted.
+      # 
+      # @param int accountId The ID of the account that owns this override
+      # @param int id The ID of the override you wish to delete
+      # @return ErrorDetail[]
+      def delete_jurisdiction_override(accountId, id)
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Retrieve a single override
+      # 
+      # Get the item object identified by this URL.
+      # 
+      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
+      # jurisdiction for a specific address. If you encounter an address that is on the boundary
+      # between two different jurisdictions, you can choose to set up a jurisdiction override
+      # to switch this address to use different taxing jurisdictions.
+      # 
+      # @param int accountId The ID of the account that owns this override
+      # @param int id The primary key of this override
+      # @return JurisdictionOverrideModel
+      def get_jurisdiction_override(accountId, id)
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        
+        get(path)
+      end
+
+
+      # Retrieve overrides for this account
+      # 
+      # List all jurisdiction override objects defined for this account.
+      # 
+      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
+      # jurisdiction for a specific address. If you encounter an address that is on the boundary
+      # between two different jurisdictions, you can choose to set up a jurisdiction override
+      # to switch this address to use different taxing jurisdictions.
+      # 
+      # 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 accountId The ID of the account that owns this override
+      # @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_jurisdiction_overrides_by_account(accountId, options={})
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve all overrides
+      # 
+      # Get multiple jurisdiction override objects across all companies.
+      # 
+      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
+      # jurisdiction for a specific address. If you encounter an address that is on the boundary
+      # between two different jurisdictions, you can choose to set up a jurisdiction override
+      # to switch this address to use different taxing jurisdictions.
+      # 
+      # 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_jurisdiction_overrides(options={})
+        path = "/api/v2/jurisdictionoverrides"
+        
+        get(path, options)
+      end
+
+
+      # Update a single jurisdictionoverride
+      # 
+      # Replace the existing jurisdictionoverride object at this URL with an updated object.
+      # 
+      # @param int accountId The ID of the account that this jurisdictionoverride belongs to.
+      # @param int id The ID of the jurisdictionoverride you wish to update
+      # @param JurisdictionOverrideModel model The jurisdictionoverride object you wish to update.
+      # @return JurisdictionOverrideModel
+      def update_jurisdiction_override(accountId, id, model)
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        
+        put(path, model)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/locations.rb

@@ -0,0 +1,158 @@
+module AvaTax
+  class Client
+    module Locations 
+
+
+      # Point of sale data file generation
+      # 
+      # Builds a point-of-sale data file containing tax rates and rules for this location, containing tax rates for all
+      # items defined for this company. This data file can be used to correctly calculate tax in the event a 
+      # point-of-sale device is not able to reach AvaTax.
+      # This data file can be customized for specific partner devices and usage conditions.
+      # The result of this API is the file you requested in the format you requested using the 'responseType' field.
+      # This API builds the file on demand, and is limited to a maximum of 7500 items.
+      # 
+      # @param int companyId The ID number of the company that owns this location.
+      # @param int id The ID number of the location to retrieve point-of-sale data.
+      # @param string date The date for which point-of-sale data would be calculated (today by default)
+      # @param string format The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)
+      # @param string partnerId If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values)
+      # @param boolean includeJurisCodes When true, the file will include jurisdiction codes in the result.
+      # @return FileResult
+      def build_point_of_sale_data_for_location(companyId, id, options={})
+        path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
+        
+        get(path, options)
+      end
+
+
+      # Create a new location
+      # 
+      # Create one or more new location objects attached to this company.
+      # 
+      # @param int companyId The ID of the company that owns this location.
+      # @param LocationModel[] model The location you wish to create.
+      # @return LocationModel[]
+      def create_locations(companyId, model)
+        path = "/api/v2/companies/#{companyId}/locations"
+        
+        post(path, model)
+      end
+
+
+      # Delete a single location
+      # 
+      # Mark the location object at this URL as deleted.
+      # 
+      # @param int companyId The ID of the company that owns this location.
+      # @param int id The ID of the location you wish to delete.
+      # @return ErrorDetail[]
+      def delete_location(companyId, id)
+        path = "/api/v2/companies/#{companyId}/locations/#{id}"
+        
+        delete(path)
+      end
+
+
+      # Retrieve a single location
+      # 
+      # Get the location object identified by this URL.
+      # An 'Location' represents a physical address where a company does business.
+      # Many taxing authorities require that you define a list of all locations where your company does business.
+      # These locations may require additional custom configuration or tax registration with these authorities.
+      # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
+      # 
+      # @param int companyId The ID of the company that owns this location
+      # @param int id The primary key of this location
+      # @return LocationModel
+      def get_location(companyId, id)
+        path = "/api/v2/companies/#{companyId}/locations/#{id}"
+        
+        get(path)
+      end
+
+
+      # Retrieve locations for this company
+      # 
+      # List all location objects defined for this company.
+      # An 'Location' represents a physical address where a company does business.
+      # Many taxing authorities require that you define a list of all locations where your company does business.
+      # These locations may require additional custom configuration or tax registration with these authorities.
+      # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
+      # 
+      # 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 locations
+      # @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_locations_by_company(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/locations"
+        
+        get(path, options)
+      end
+
+
+      # Retrieve all locations
+      # 
+      # Get multiple location objects across all companies.
+      # An 'Location' represents a physical address where a company does business.
+      # Many taxing authorities require that you define a list of all locations where your company does business.
+      # These locations may require additional custom configuration or tax registration with these authorities.
+      # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
+      # 
+      # 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_locations(options={})
+        path = "/api/v2/locations"
+        
+        get(path, options)
+      end
+
+
+      # Update a single location
+      # 
+      # Replace the existing location object at this URL with an updated object.
+      # 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 location belongs to.
+      # @param int id The ID of the location you wish to update
+      # @param LocationModel model The location you wish to update.
+      # @return LocationModel
+      def update_location(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/locations/#{id}"
+        
+        put(path, model)
+      end
+
+
+      # Validate the location against local requirements
+      # 
+      # Returns validation information for this location.
+      # This API call is intended to compare this location against the currently known taxing authority rules and regulations,
+      # and provide information about what additional work is required to completely setup this location.
+      # 
+      # @param int companyId The ID of the company that owns this location
+      # @param int id The primary key of this location
+      # @return LocationValidationModel
+      def validate_location(companyId, id)
+        path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
+        
+        get(path)
+      end
+
+    end
+  end
+end