avatax 17.5.0 → 17.6.0

data/lib/avatax/client/onboarding.rb

@@ -4,17 +4,15 @@ module AvaTax
 
 
       # Request a new Avalara account
-      # 
+      #
       # This API is for use by partner onboarding services customers only.
       # Calling this API creates an account with the specified product subscriptions, but does not configure billing.
       # The customer will receive information from Avalara about how to configure billing for their account.
       # You should call this API when a customer has requested to begin using Avalara services.
-      # 
-      # @param NewAccountRequestModel model Information about the account you wish to create and the selected product offerings.
-      # @return NewAccountModel
+      # @param model [Object] Information about the account you wish to create and the selected product offerings.
+      # @return [Object]
       def request_new_account(model)
         path = "/api/v2/accounts/request"
-        
         post(path, model)
       end
 

data/lib/avatax/client/pointofsale.rb

@@ -4,18 +4,16 @@ module AvaTax
 
 
       # Point of sale data file generation
-      # 
+      #
       # Builds a point-of-sale data file containing 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.
-      # 
-      # @param PointOfSaleDataRequestModel model Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
-      # @return FileResult
+      # @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
+      # @return [Object]
       def build_point_of_sale_data_file(model)
         path = "/api/v2/pointofsaledata/build"
-        
         post(path, model)
       end
 

data/lib/avatax/client/registrar.rb

@@ -4,210 +4,188 @@ module AvaTax
 
 
       # Change Password
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Allows a user to change their password via the API.
       # This API only allows the currently authenticated user to change their password; it cannot be used to apply to a
       # different user than the one authenticating the current API call.
-      # 
-      # @param PasswordChangeModel model An object containing your current password and the new password.
-      # @return string
+      # @param model [Object] An object containing your current password and the new password.
+      # @return [String]
       def change_password(model)
         path = "/api/v2/passwords"
-        
         put(path, model)
       end
 
 
       # Create a new account
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
-      # Create a single new account object. 
+      #
+      # Create a single new account object.
       # When creating an account object you may attach subscriptions and users as part of the 'Create' call.
-      # 
-      # @param AccountModel model The account you wish to create.
-      # @return AccountModel
+      # @param model [Object] The account you wish to create.
+      # @return [Object]
       def create_account(model)
         path = "/api/v2/accounts"
-        
         post(path, model)
       end
 
 
       # Create a new subscription
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Create one or more new 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.
-      # 
-      # @param int accountId The ID of the account that owns this subscription.
-      # @param SubscriptionModel[] model The subscription you wish to create.
-      # @return SubscriptionModel[]
+      # @param accountId [Integer] The ID of the account that owns this subscription.
+      # @param model [object[]] The subscription you wish to create.
+      # @return [object[]]
       def create_subscriptions(accountId, model)
         path = "/api/v2/accounts/#{accountId}/subscriptions"
-        
         post(path, model)
       end
 
 
       # Create new users
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Create one or more new user objects attached to this account.
       # A user represents one person with access privileges to make API calls and work with a specific account.
-      # 
-      # @param int accountId The unique ID number of the account where these users will be created.
-      # @param UserModel[] model The user or array of users you wish to create.
-      # @return UserModel[]
+      # @param accountId [Integer] The unique ID number of the account where these users will be created.
+      # @param model [object[]] The user or array of users you wish to create.
+      # @return [object[]]
       def create_users(accountId, model)
         path = "/api/v2/accounts/#{accountId}/users"
-        
         post(path, model)
       end
 
 
       # Delete a single account
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Delete an account.
       # Deleting an account will delete all companies and all account level users attached to this account.
-      # 
-      # @param int id The ID of the account you wish to delete.
-      # @return ErrorDetail[]
+      # @param id [Integer] The ID of the account you wish to delete.
+      # @return [object[]]
       def delete_account(id)
         path = "/api/v2/accounts/#{id}"
-        
         delete(path)
       end
 
 
       # Delete a single subscription
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Mark the existing account identified by this URL as deleted.
-      # 
-      # @param int accountId The ID of the account that owns this subscription.
-      # @param int id The ID of the subscription you wish to delete.
-      # @return ErrorDetail[]
+      # @param accountId [Integer] The ID of the account that owns this subscription.
+      # @param id [Integer] The ID of the subscription you wish to delete.
+      # @return [object[]]
       def delete_subscription(accountId, id)
         path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
-        
         delete(path)
       end
 
 
       # Delete a single user
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Mark the user object identified by this URL as deleted.
-      # 
-      # @param int id The ID of the user you wish to delete.
-      # @param int accountId The accountID of the user you wish to delete.
-      # @return ErrorDetail[]
+      # @param id [Integer] The ID of the user you wish to delete.
+      # @param accountId [Integer] The accountID of the user you wish to delete.
+      # @return [object[]]
       def delete_user(id, accountId)
         path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        
         delete(path)
       end
 
 
       # Retrieve all accounts
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Get multiple account objects.
       # 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:
-      #  
+      #
       # * Subscriptions
       # * Users
-      #  
+      #
       # For more information about filtering in REST, please see the documentation at 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 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_accounts(options={})
         path = "/api/v2/accounts"
-        
         get(path, options)
       end
 
 
       # Reset a user's password programmatically
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Allows a system admin to reset the password for a specific user via the API.
       # This API is only available for Avalara Registrar Admins, and can be used to reset the password of any
       # user based on internal Avalara business processes.
-      # 
-      # @param int userId The unique ID of the user whose password will be changed
-      # @param SetPasswordModel model The new password for this user
-      # @return string
+      # @param userId [Integer] The unique ID of the user whose password will be changed
+      # @param model [Object] The new password for this user
+      # @return [String]
       def reset_password(userId, model)
         path = "/api/v2/passwords/#{userId}/reset"
-        
         post(path, model)
       end
 
 
       # Update a single account
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Replace an existing account object with an updated account object.
-      # 
-      # @param int id The ID of the account you wish to update.
-      # @param AccountModel model The account object you wish to update.
-      # @return AccountModel
+      # @param id [Integer] The ID of the account you wish to update.
+      # @param model [Object] The account object you wish to update.
+      # @return [Object]
       def update_account(id, model)
         path = "/api/v2/accounts/#{id}"
-        
         put(path, model)
       end
 
 
       # Update a single subscription
-      # 
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
-      # 
+      #
       # Replace the existing subscription object at this URL with an updated object.
       # 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.
-      # 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 accountId The ID of the account that this subscription belongs to.
-      # @param int id The ID of the subscription you wish to update
-      # @param SubscriptionModel model The subscription you wish to update.
-      # @return SubscriptionModel
+      # @param accountId [Integer] The ID of the account that this subscription belongs to.
+      # @param id [Integer] The ID of the subscription you wish to update
+      # @param model [Object] The subscription you wish to update.
+      # @return [Object]
       def update_subscription(accountId, id, model)
         path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
-        
         put(path, model)
       end
 

data/lib/avatax/client/settings.rb

@@ -4,131 +4,119 @@ module AvaTax
 
 
       # Create a new setting
-      # 
+      #
       # Create one or more new setting objects attached to this company.
       # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
       # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and 
+      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
       # 'value' data fields.
       # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
       # the 'set' data field.
-      # 
-      # @param int companyId The ID of the company that owns this setting.
-      # @param SettingModel[] model The setting you wish to create.
-      # @return SettingModel[]
+      # @param companyId [Integer] The ID of the company that owns this setting.
+      # @param model [object[]] The setting you wish to create.
+      # @return [object[]]
       def create_settings(companyId, model)
         path = "/api/v2/companies/#{companyId}/settings"
-        
         post(path, model)
       end
 
 
       # Delete a single setting
-      # 
+      #
       # Mark the setting object at this URL as deleted.
-      # 
-      # @param int companyId The ID of the company that owns this setting.
-      # @param int id The ID of the setting you wish to delete.
-      # @return ErrorDetail[]
+      # @param companyId [Integer] The ID of the company that owns this setting.
+      # @param id [Integer] The ID of the setting you wish to delete.
+      # @return [object[]]
       def delete_setting(companyId, id)
         path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        
         delete(path)
       end
 
 
       # Retrieve a single setting
-      # 
+      #
       # Get a single setting object by its unique ID.
       # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
       # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and 
+      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
       # 'value' data fields.
       # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
       # the 'set' data field.
-      # 
-      # @param int companyId The ID of the company that owns this setting
-      # @param int id The primary key of this setting
-      # @return SettingModel
+      # @param companyId [Integer] The ID of the company that owns this setting
+      # @param id [Integer] The primary key of this setting
+      # @return [Object]
       def get_setting(companyId, id)
         path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        
         get(path)
       end
 
 
       # Retrieve all settings for this company
-      # 
+      #
       # List all setting objects attached to this company.
       # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
       # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and 
+      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
       # 'value' data fields.
       # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
       # the 'set' data field.
-      # 
+      #
       # 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 settings
-      # @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 settings
+      # @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_settings_by_company(companyId, options={})
         path = "/api/v2/companies/#{companyId}/settings"
-        
         get(path, options)
       end
 
 
       # Retrieve all settings
-      # 
+      #
       # Get multiple setting objects across all companies.
       # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
       # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and 
+      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
       # 'value' data fields.
       # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
       # the 'set' data field.
-      # 
+      #
       # 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_settings(options={})
         path = "/api/v2/settings"
-        
         get(path, options)
       end
 
 
       # Update a single setting
-      # 
+      #
       # Replace the existing setting object at this URL with an updated object.
       # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
       # not defined or managed by Avalara.
-      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and 
+      # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
       # 'value' data fields.
       # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
       # the 'set' data field.
-      # 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 setting belongs to.
-      # @param int id The ID of the setting you wish to update
-      # @param SettingModel model The setting you wish to update.
-      # @return SettingModel
+      # @param companyId [Integer] The ID of the company that this setting belongs to.
+      # @param id [Integer] The ID of the setting you wish to update
+      # @param model [Object] The setting you wish to update.
+      # @return [Object]
       def update_setting(companyId, id, model)
         path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        
         put(path, model)
       end