avatax 19.12.0 → 20.7.0

data/lib/avatax/client/upcs.rb

@@ -1,130 +1,130 @@
-module AvaTax
-  class Client
-    module Upcs 
-
-
-      # 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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
-      # @param companyId [Integer] The ID of the company that owns this UPC.
-      # @param model [UPCModel[]] The UPC you wish to create.
-      # @return [UPCModel[]]
-      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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
-      # @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 [ErrorDetail[]]
-      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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
-      # @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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
-      # @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 additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
-      # @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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
-      # @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 additional data to retrieve.
-      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
-      # @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.
-      # 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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
-      # @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
-
-    end
-  end
+module AvaTax
+  class Client
+    module Upcs 
+
+
+      # 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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # @param companyId [Integer] The ID of the company that owns this UPC.
+      # @param model [UPCModel[]] The UPC you wish to create.
+      # @return [UPCModel[]]
+      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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # @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 [ErrorDetail[]]
+      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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # @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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # @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 additional data to retrieve.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # @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 additional data to retrieve.
+      # @param top [Integer] If nonzero, return no more than this number of results. Used with `$skip` to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @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.
+      # 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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API depends on the following active services<br />*Required* (all): AvaUpc.
+      # @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
+
+    end
+  end
 end

data/lib/avatax/client/users.rb

@@ -1,208 +1,208 @@
-module AvaTax
-  class Client
-    module Users 
-
-
-      # Change Password
-      #
-      # Allows a user to change their password via an API call.
-      #
-      # This API allows an authenticated user to change their password via an API call. This feature is only available
-      # for accounts that do not use SAML integrated password validation.
-      #
-      # 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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @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 new users
-      #
-      # 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.
-      #
-      # Users who are account administrators or company users are permitted to create user records to invite
-      # additional team members to work with AvaTax.
-      #
-      # A newly created user will receive an email inviting them to create their password. This means that you
-      # must provide a valid email address for all user accounts created.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @param accountId [Integer] The unique ID number of the account where these users will be created.
-      # @param model [UserModel[]] The user or array of users you wish to create.
-      # @return [UserModel[]]
-      def create_users(accountId, model)
-        path = "/api/v2/accounts/#{accountId}/users"
-        post(path, model)
-      end
-
-
-      # Delete a single user
-      #
-      # Mark the user object identified by this URL as deleted.
-      #
-      # This API is available for use by account and company administrators only.
-      #
-      # Account and company administrators may only delete users within the appropriate organizations
-      # they control.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.
-      # @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 [ErrorDetail[]]
-      def delete_user(id, accountId)
-        path = "/api/v2/accounts/#{accountId}/users/#{id}"
-        delete(path)
-      end
-
-
-      # 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.
-      #
-      #  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:
-      #
-      # * FetchDeleted
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @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] Optional fetch commands.
-      # @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
-      # 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
-      #  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' .
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @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.
-      #
-      # When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key.
-      # By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
-      #
-      # 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:
-      #
-      # * FetchDeleted
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @param accountId [Integer] The accountID of the user you wish to list.
-      # @param include [String] Optional fetch commands.
-      # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
-      # @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 or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated
-      # via either username / password authentication, an OpenID / OAuth Bearer Token, or a legacy AvaTax License Key.
-      #
-      # When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key.
-      # By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
-      #
-      # 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:
-      #
-      # * FetchDeleted
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @param include [String] Optional fetch commands.
-      # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
-      # @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.
-      # 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.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @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
-
-    end
-  end
+module AvaTax
+  class Client
+    module Users 
+
+
+      # Change Password
+      #
+      # Allows a user to change their password via an API call.
+      #
+      # This API allows an authenticated user to change their password via an API call. This feature is only available
+      # for accounts that do not use SAML integrated password validation.
+      #
+      # 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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @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 new users
+      #
+      # 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.
+      #
+      # Users who are account administrators or company users are permitted to create user records to invite
+      # additional team members to work with AvaTax.
+      #
+      # A newly created user will receive an email inviting them to create their password. This means that you
+      # must provide a valid email address for all user accounts created.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param accountId [Integer] The unique ID number of the account where these users will be created.
+      # @param model [UserModel[]] The user or array of users you wish to create.
+      # @return [UserModel[]]
+      def create_users(accountId, model)
+        path = "/api/v2/accounts/#{accountId}/users"
+        post(path, model)
+      end
+
+
+      # Delete a single user
+      #
+      # Mark the user object identified by this URL as deleted.
+      #
+      # This API is available for use by account and company administrators only.
+      #
+      # Account and company administrators may only delete users within the appropriate organizations
+      # they control.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.
+      # @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 [ErrorDetail[]]
+      def delete_user(id, accountId)
+        path = "/api/v2/accounts/#{accountId}/users/#{id}"
+        delete(path)
+      end
+
+
+      # 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.
+      #
+      #  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:
+      #
+      # * FetchDeleted
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @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] Optional fetch commands.
+      # @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
+      # 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
+      #  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' .
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @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.
+      #
+      # When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key.
+      # By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
+      #
+      # 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:
+      #
+      # * FetchDeleted
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param accountId [Integer] The accountID of the user you wish to list.
+      # @param include [String] Optional fetch commands.
+      # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @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 or set of credentials with access privileges to make API calls and work with a specific account. A user can be authenticated
+      # via either username / password authentication, an OpenID / OAuth Bearer Token, or a legacy AvaTax License Key.
+      #
+      # When an API is called using a legacy AvaTax License Key, the API log entry is recorded as being performed by a special user attached to that license key.
+      # By default, this API will not return a listing of license key users. Users with registrar-level security may call this API to list license key users.
+      #
+      # 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:
+      #
+      # * FetchDeleted
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param include [String] Optional fetch commands.
+      # @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. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.
+      # @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.
+      # 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.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @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
+
+    end
+  end
 end