avatax 17.5.0 → 17.6.0

data/lib/avatax/client/subscriptions.rb

@@ -4,60 +4,54 @@ module AvaTax
 
 
       # Retrieve a single subscription
-      # 
+      #
       # Get the subscription object identified by this URL.
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
-      # 
-      # @param int accountId The ID of the account that owns this subscription
-      # @param int id The primary key of this subscription
-      # @return SubscriptionModel
+      # @param accountId [Integer] The ID of the account that owns this subscription
+      # @param id [Integer] The primary key of this subscription
+      # @return [Object]
       def get_subscription(accountId, id)
         path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
-        
         get(path)
       end
 
 
       # Retrieve subscriptions for this account
-      # 
+      #
       # List all subscription objects attached to this account.
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
-      # 
+      #
       # 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 these subscriptions
-      # @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
+      # @param accountId [Integer] The ID of the account that owns these subscriptions
+      # @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.
+      # @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_subscriptions_by_account(accountId, options={})
         path = "/api/v2/accounts/#{accountId}/subscriptions"
-        
         get(path, options)
       end
 
 
       # Retrieve all subscriptions
-      # 
+      #
       # Get multiple subscription objects across all accounts.
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
-      # 
+      #
       # 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 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
+      # @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.
+      # @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_subscriptions(options={})
         path = "/api/v2/subscriptions"
-        
         get(path, options)
       end
 

data/lib/avatax/client/taxcodes.rb

@@ -4,121 +4,109 @@ module AvaTax
 
 
       # Create a new tax code
-      # 
+      #
       # Create one or more new taxcode objects attached to this company.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
       # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
-      # 
-      # @param int companyId The ID of the company that owns this tax code.
-      # @param TaxCodeModel[] model The tax code you wish to create.
-      # @return TaxCodeModel[]
+      # @param companyId [Integer] The ID of the company that owns this tax code.
+      # @param model [object[]] The tax code you wish to create.
+      # @return [object[]]
       def create_tax_codes(companyId, model)
         path = "/api/v2/companies/#{companyId}/taxcodes"
-        
         post(path, model)
       end
 
 
       # Delete a single tax code
-      # 
+      #
       # Marks the existing TaxCode object at this URL as deleted.
-      # 
-      # @param int companyId The ID of the company that owns this tax code.
-      # @param int id The ID of the tax code you wish to delete.
-      # @return ErrorDetail[]
+      # @param companyId [Integer] The ID of the company that owns this tax code.
+      # @param id [Integer] The ID of the tax code you wish to delete.
+      # @return [object[]]
       def delete_tax_code(companyId, id)
         path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
-        
         delete(path)
       end
 
 
       # Retrieve a single tax code
-      # 
+      #
       # Get the taxcode object identified by this URL.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
       # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
-      # 
-      # @param int companyId The ID of the company that owns this tax code
-      # @param int id The primary key of this tax code
-      # @return TaxCodeModel
+      # @param companyId [Integer] The ID of the company that owns this tax code
+      # @param id [Integer] The primary key of this tax code
+      # @return [Object]
       def get_tax_code(companyId, id)
         path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
-        
         get(path)
       end
 
 
       # Retrieve tax codes for this company
-      # 
+      #
       # List all taxcode objects attached to this company.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
       # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported 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 companyId The ID of the company that owns these tax codes
-      # @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
+      # @param companyId [Integer] The ID of the company that owns these tax codes
+      # @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 include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @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_tax_codes_by_company(companyId, options={})
         path = "/api/v2/companies/#{companyId}/taxcodes"
-        
         get(path, options)
       end
 
 
       # Retrieve all tax codes
-      # 
+      #
       # Get multiple taxcode objects across all companies.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
       # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported 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
+      # @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 include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @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_tax_codes(options={})
         path = "/api/v2/taxcodes"
-        
         get(path, options)
       end
 
 
       # Update a single tax code
-      # 
+      #
       # Replace the existing taxcode object at this URL with an updated object.
       # A 'TaxCode' represents a uniquely identified type of product, good, or service.
       # Avalara supports correct tax rates and taxability rules for all TaxCodes in all supported jurisdictions.
       # If you identify your products by tax code in your 'Create Transacion' API calls, Avalara will correctly calculate tax rates and
       # taxability rules for this product in all supported jurisdictions.
-      # All data from the existing object will be replaced with data in the object you PUT. 
+      # 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 tax code belongs to.
-      # @param int id The ID of the tax code you wish to update
-      # @param TaxCodeModel model The tax code you wish to update.
-      # @return TaxCodeModel
+      # @param companyId [Integer] The ID of the company that this tax code belongs to.
+      # @param id [Integer] The ID of the tax code you wish to update
+      # @param model [Object] The tax code you wish to update.
+      # @return [Object]
       def update_tax_code(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
-        
         put(path, model)
       end
 

data/lib/avatax/client/taxcontent.rb

@@ -0,0 +1,54 @@
+module AvaTax
+  class Client
+    module TaxContent 
+
+
+      # Build a multi-location tax content file
+      #
+      # Builds a tax content file containing information useful for a retail point-of-sale solution.
+      #
+      # This file contains tax rates and rules for items and locations that 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 files with no more than 7500 scenarios. To build a tax content
+      # file for a single location at a time, please use `BuildTaxContentFileForLocation`.
+      # @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
+      # @return [Object]
+      def build_tax_content_file(model)
+        path = "/api/v2/pointofsaledata/build"
+        post(path, model)
+      end
+
+
+      # Build a tax content file for a single location
+      #
+      # Builds a tax content file containing information useful for a retail point-of-sale solution.
+      #
+      # This file contains tax rates and rules for all items for a single location. Data from this API
+      # 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 files with no more than 7500 scenarios. To build a tax content
+      # file for a multiple locations in a single file, please use `BuildTaxContentFile`.
+      # @param companyId [Integer] The ID number of the company that owns this location.
+      # @param id [Integer] The ID number of the location to retrieve point-of-sale data.
+      # @param date [DateTime] The date for which point-of-sale data would be calculated (today by default)
+      # @param format [String] The format of the file (JSON by default) (See PointOfSaleFileType::* for a list of allowable values)
+      # @param partnerId [String] If specified, requests a custom partner-formatted version of the file. (See PointOfSalePartnerId::* for a list of allowable values)
+      # @param includeJurisCodes [object] When true, the file will include jurisdiction codes in the result.
+      # @return [Object]
+      def build_tax_content_file_for_location(companyId, id, options={})
+        path = "/api/v2/companies/#{companyId}/locations/#{id}/pointofsaledata"
+        get(path, options)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/taxrules.rb

@@ -4,121 +4,109 @@ module AvaTax
 
 
       # Create a new tax rule
-      # 
+      #
       # Create one or more new taxrule objects attached to this company.
       # A tax rule represents a custom taxability rule for a product or service sold by your company.
       # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
       # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
       # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
-      # 
-      # @param int companyId The ID of the company that owns this tax rule.
-      # @param TaxRuleModel[] model The tax rule you wish to create.
-      # @return TaxRuleModel[]
+      # @param companyId [Integer] The ID of the company that owns this tax rule.
+      # @param model [object[]] The tax rule you wish to create.
+      # @return [object[]]
       def create_tax_rules(companyId, model)
         path = "/api/v2/companies/#{companyId}/taxrules"
-        
         post(path, model)
       end
 
 
       # Delete a single tax rule
-      # 
+      #
       # Mark the TaxRule identified by this URL as deleted.
-      # 
-      # @param int companyId The ID of the company that owns this tax rule.
-      # @param int id The ID of the tax rule you wish to delete.
-      # @return ErrorDetail[]
+      # @param companyId [Integer] The ID of the company that owns this tax rule.
+      # @param id [Integer] The ID of the tax rule you wish to delete.
+      # @return [object[]]
       def delete_tax_rule(companyId, id)
         path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        
         delete(path)
       end
 
 
       # Retrieve a single tax rule
-      # 
+      #
       # Get the taxrule object identified by this URL.
       # A tax rule represents a custom taxability rule for a product or service sold by your company.
       # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
       # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
       # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
-      # 
-      # @param int companyId The ID of the company that owns this tax rule
-      # @param int id The primary key of this tax rule
-      # @return TaxRuleModel
+      # @param companyId [Integer] The ID of the company that owns this tax rule
+      # @param id [Integer] The primary key of this tax rule
+      # @return [Object]
       def get_tax_rule(companyId, id)
         path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        
         get(path)
       end
 
 
       # Retrieve tax rules for this company
-      # 
+      #
       # List all taxrule objects attached to this company.
       # A tax rule represents a custom taxability rule for a product or service sold by your company.
       # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
       # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
       # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
-      # 
+      #
       # 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 tax rules
-      # @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
+      # @param companyId [Integer] The ID of the company that owns these tax rules
+      # @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 include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @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_tax_rules(companyId, options={})
         path = "/api/v2/companies/#{companyId}/taxrules"
-        
         get(path, options)
       end
 
 
       # Retrieve all tax rules
-      # 
+      #
       # Get multiple taxrule objects across all companies.
       # A tax rule represents a custom taxability rule for a product or service sold by your company.
       # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
       # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
       # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
-      # 
+      #
       # 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
+      # @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 include [String] A comma separated list of child objects to return underneath the primary object.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
+      # @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_tax_rules(options={})
         path = "/api/v2/taxrules"
-        
         get(path, options)
       end
 
 
       # Update a single tax rule
-      # 
+      #
       # Replace the existing taxrule object at this URL with an updated object.
       # A tax rule represents a custom taxability rule for a product or service sold by your company.
       # If you have obtained a custom tax ruling from an auditor that changes the behavior of certain goods or services
       # within certain taxing jurisdictions, or you have obtained special tax concessions for certain dates or locations,
       # you may wish to create a TaxRule object to override the AvaTax engine's default behavior in those circumstances.
-      # All data from the existing object will be replaced with data in the object you PUT. 
+      # 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 tax rule belongs to.
-      # @param int id The ID of the tax rule you wish to update
-      # @param TaxRuleModel model The tax rule you wish to update.
-      # @return TaxRuleModel
+      # @param companyId [Integer] The ID of the company that this tax rule belongs to.
+      # @param id [Integer] The ID of the tax rule you wish to update
+      # @param model [Object] The tax rule you wish to update.
+      # @return [Object]
       def update_tax_rule(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        
         put(path, model)
       end