avatax 17.5.0 → 17.6.0

data/lib/avatax/client/upcs.rb

@@ -4,106 +4,94 @@ module AvaTax
 
 
       # Create a new UPC
-      # 
+      #
       # Create one or more new UPC objects attached to this company.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
-      # 
-      # @param int companyId The ID of the company that owns this UPC.
-      # @param UPCModel[] model The UPC you wish to create.
-      # @return UPCModel[]
+      # @param companyId [Integer] The ID of the company that owns this UPC.
+      # @param model [object[]] The UPC you wish to create.
+      # @return [object[]]
       def create_u_p_cs(companyId, model)
         path = "/api/v2/companies/#{companyId}/upcs"
-        
         post(path, model)
       end
 
 
       # Delete a single UPC
-      # 
+      #
       # Marks the UPC object identified by this URL as deleted.
-      # 
-      # @param int companyId The ID of the company that owns this UPC.
-      # @param int id The ID of the UPC you wish to delete.
-      # @return ErrorDetail[]
+      # @param companyId [Integer] The ID of the company that owns this UPC.
+      # @param id [Integer] The ID of the UPC you wish to delete.
+      # @return [object[]]
       def delete_u_p_c(companyId, id)
         path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        
         delete(path)
       end
 
 
       # Retrieve a single UPC
-      # 
+      #
       # Get the UPC object identified by this URL.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
-      # 
-      # @param int companyId The ID of the company that owns this UPC
-      # @param int id The primary key of this UPC
-      # @return UPCModel
+      # @param companyId [Integer] The ID of the company that owns this UPC
+      # @param id [Integer] The primary key of this UPC
+      # @return [Object]
       def get_u_p_c(companyId, id)
         path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        
         get(path)
       end
 
 
       # Retrieve UPCs for this company
-      # 
+      #
       # List all UPC objects attached to this company.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
-      # 
+      #
       # 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 UPCs
-      # @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 UPCs
+      # @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_u_p_cs_by_company(companyId, options={})
         path = "/api/v2/companies/#{companyId}/upcs"
-        
         get(path, options)
       end
 
 
       # Retrieve all UPCs
-      # 
+      #
       # Get multiple UPC objects across all companies.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
-      # 
+      #
       # 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_u_p_cs(options={})
         path = "/api/v2/upcs"
-        
         get(path, options)
       end
 
 
       # Update a single UPC
-      # 
+      #
       # Replace the existing UPC object at this URL with an updated object.
       # A UPC represents a single UPC code in your catalog and matches this product to the tax code identified by this UPC.
-      # 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 UPC belongs to.
-      # @param int id The ID of the UPC you wish to update
-      # @param UPCModel model The UPC you wish to update.
-      # @return UPCModel
+      # @param companyId [Integer] The ID of the company that this UPC belongs to.
+      # @param id [Integer] The ID of the UPC you wish to update
+      # @param model [Object] The UPC you wish to update.
+      # @return [Object]
       def update_u_p_c(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/upcs/#{id}"
-        
         put(path, model)
       end
 

data/lib/avatax/client/users.rb

@@ -4,106 +4,96 @@ module AvaTax
 
 
       # Retrieve a single user
-      # 
+      #
       # Get the user object identified by this URL.
       # A user represents one person with access privileges to make API calls and work with a specific account.
-      # 
-      # @param int id The ID of the user to retrieve.
-      # @param int accountId The accountID of the user you wish to get.
-      # @param string include A comma separated list of child objects to return underneath the primary object.
-      # @return UserModel
+      # @param id [Integer] The ID of the user to retrieve.
+      # @param accountId [Integer] The accountID of the user you wish to get.
+      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @return [Object]
       def get_user(id, accountId, options={})
         path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        
         get(path, options)
       end
 
 
       # Retrieve all entitlements for a single user
-      # 
+      #
       # Return a list of all entitlements to which this user has rights to access.
-      # Entitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is 
+      # Entitlements are a list of specified API calls the user is permitted to make, a list of identifier numbers for companies the user is
       # allowed to use, and an access level identifier that indicates what types of access roles the user is allowed to use.
       # This API call is intended to provide a validation endpoint to determine, before making an API call, whether this call is likely to succeed.
       # For example, if user 567 within account 999 is attempting to create a new child company underneath company 12345, you could preview the user's
       # entitlements and predict whether this call would succeed:
-      #  
-      # * Retrieve entitlements by calling '/api/v2/accounts/999/users/567/entitlements' . If the call fails, you do not have accurate 
+      #
+      # * Retrieve entitlements by calling '/api/v2/accounts/999/users/567/entitlements' . If the call fails, you do not have accurate
       #  credentials for this user.
       # * If the 'accessLevel' field within entitlements is 'None', the call will fail.
       # * If the 'accessLevel' field within entitlements is 'SingleCompany' or 'SingleAccount', the call will fail if the companies
       #  table does not contain the ID number 12345.
       # * If the 'permissions' array within entitlements does not contain 'AccountSvc.CompanySave', the call will fail.
-      #  
+      #
       # For a full list of defined permissions, please use '/api/v2/definitions/permissions' .
-      # 
-      # @param int id The ID of the user to retrieve.
-      # @param int accountId The accountID of the user you wish to get.
-      # @return UserEntitlementModel
+      # @param id [Integer] The ID of the user to retrieve.
+      # @param accountId [Integer] The accountID of the user you wish to get.
+      # @return [Object]
       def get_user_entitlements(id, accountId)
         path = "/api/v2/accounts/#{accountId}/users/#{id}/entitlements"
-        
         get(path)
       end
 
 
       # Retrieve users for this account
-      # 
+      #
       # List all user objects attached to this account.
       # A user represents one person with access privileges to make API calls and work with a specific account.
-      # 
+      #
       # 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 accountID of the user you wish to list.
-      # @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
+      # @param accountId [Integer] The accountID of the user you wish to list.
+      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @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_users_by_account(accountId, options={})
         path = "/api/v2/accounts/#{accountId}/users"
-        
         get(path, options)
       end
 
 
       # Retrieve all users
-      # 
+      #
       # Get multiple user objects across all accounts.
       # A user represents one person with access privileges to make API calls and work with a specific account.
-      # 
+      #
       # 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 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
+      # @param include [String] A comma separated list of child objects to return underneath the primary object.
+      # @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_users(options={})
         path = "/api/v2/users"
-        
         get(path, options)
       end
 
 
       # Update a single user
-      # 
+      #
       # Replace the existing user object at this URL with an updated object.
       # A user represents one person with access privileges to make API calls and work with a specific account.
-      # 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 id The ID of the user you wish to update.
-      # @param int accountId The accountID of the user you wish to update.
-      # @param UserModel model The user object you wish to update.
-      # @return UserModel
+      # @param id [Integer] The ID of the user you wish to update.
+      # @param accountId [Integer] The accountID of the user you wish to update.
+      # @param model [Object] The user object you wish to update.
+      # @return [Object]
       def update_user(id, accountId, model)
         path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        
         put(path, model)
       end
 

data/lib/avatax/client/utilities.rb

@@ -4,46 +4,40 @@ module AvaTax
 
 
       # Checks if the current user is subscribed to a specific service
-      # 
+      #
       # Returns a subscription object for the current account, or 404 Not Found if this subscription is not enabled for this account.
       # This API call is intended to allow you to identify whether you have the necessary account configuration to access certain
       # features of AvaTax, and would be useful in debugging access privilege problems.
-      # 
-      # @param string serviceTypeId The service to check (See ServiceTypeId::* for a list of allowable values)
-      # @return SubscriptionModel
+      # @param serviceTypeId [String] The service to check (See ServiceTypeId::* for a list of allowable values)
+      # @return [Object]
       def get_my_subscription(serviceTypeId)
         path = "/api/v2/utilities/subscriptions/#{serviceTypeId}"
-        
         get(path)
       end
 
 
       # List all services to which the current user is subscribed
-      # 
+      #
       # Returns the list of all subscriptions enabled for the current account.
       # This API is intended to help you determine whether you have the necessary subscription to use certain API calls
       # within AvaTax.
-      # 
-      # @return FetchResult
+      # @return [FetchResult]
       def list_my_subscriptions()
         path = "/api/v2/utilities/subscriptions"
-        
         get(path)
       end
 
 
       # Tests connectivity and version of the service
-      # 
-      # This API helps diagnose connectivity problems between your application and AvaTax; you may call this API even 
+      #
+      # This API helps diagnose connectivity problems between your application and AvaTax; you may call this API even
       # if you do not have verified connection credentials.
       # The results of this API call will help you determine whether your computer can contact AvaTax via the network,
       # whether your authentication credentials are recognized, and the roundtrip time it takes to communicate with
       # AvaTax.
-      # 
-      # @return PingResultModel
+      # @return [Object]
       def ping()
         path = "/api/v2/utilities/ping"
-        
         get(path)
       end
 

data/lib/avatax/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '17.5.0'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '17.6.0'.freeze unless defined?(::AvaTax::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 17.5.0
+  version: 17.6.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-21 00:00:00.000000000 Z
+date: 2017-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -150,6 +150,7 @@ files:
 - lib/avatax/client/settings.rb
 - lib/avatax/client/subscriptions.rb
 - lib/avatax/client/taxcodes.rb
+- lib/avatax/client/taxcontent.rb
 - lib/avatax/client/taxrules.rb
 - lib/avatax/client/transactions.rb
 - lib/avatax/client/upcs.rb