avatax 19.12.0 → 20.7.0

data/lib/avatax/client/jurisdictionoverrides.rb

@@ -1,137 +1,137 @@
-module AvaTax
-  class Client
-    module JurisdictionOverrides 
-
-
-      # Create one or more overrides
-      #
-      # Creates one or more jurisdiction override objects for this account.
-      #
-      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
-      # jurisdiction for a specific address. If you encounter an address that is on the boundary
-      # between two different jurisdictions, you can choose to set up a jurisdiction override
-      # to switch this address to use different taxing jurisdictions.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # @param accountId [Integer] The ID of the account that owns this override
-      # @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
-      # @return [JurisdictionOverrideModel[]]
-      def create_jurisdiction_overrides(accountId, model)
-        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
-        post(path, model)
-      end
-
-
-      # Delete a single override
-      #
-      # Marks the item object at this URL as deleted.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # @param accountId [Integer] The ID of the account that owns this override
-      # @param id [Integer] The ID of the override you wish to delete
-      # @return [ErrorDetail[]]
-      def delete_jurisdiction_override(accountId, id)
-        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        delete(path)
-      end
-
-
-      # Retrieve a single override
-      #
-      # Get the item object identified by this URL.
-      #
-      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
-      # jurisdiction for a specific address. If you encounter an address that is on the boundary
-      # between two different jurisdictions, you can choose to set up a jurisdiction override
-      # to switch this address to use different taxing jurisdictions.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @param accountId [Integer] The ID of the account that owns this override
-      # @param id [Integer] The primary key of this override
-      # @return [Object]
-      def get_jurisdiction_override(accountId, id)
-        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        get(path)
-      end
-
-
-      # Retrieve overrides for this account
-      #
-      # List all jurisdiction override objects defined for this account.
-      #
-      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
-      # jurisdiction for a specific address. If you encounter an address that is on the boundary
-      # between two different jurisdictions, you can choose to set up a jurisdiction override
-      # to switch this address to use different taxing jurisdictions.
-      #
-      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @param accountId [Integer] The ID of the account that owns this override
-      # @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/).<br />*Not filterable:* country, Jurisdictions
-      # @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_jurisdiction_overrides_by_account(accountId, options={})
-        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
-        get(path, options)
-      end
-
-
-      # Retrieve all overrides
-      #
-      # Get multiple jurisdiction override objects across all companies.
-      #
-      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
-      # jurisdiction for a specific address. If you encounter an address that is on the boundary
-      # between two different jurisdictions, you can choose to set up a jurisdiction override
-      # to switch this address to use different taxing jurisdictions.
-      #
-      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @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/).<br />*Not filterable:* country, Jurisdictions
-      # @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_jurisdiction_overrides(options={})
-        path = "/api/v2/jurisdictionoverrides"
-        get(path, options)
-      end
-
-
-      # Update a single jurisdictionoverride
-      #
-      # Replace the existing jurisdictionoverride object at this URL with an updated object.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
-      # @param accountId [Integer] The ID of the account that this jurisdictionoverride belongs to.
-      # @param id [Integer] The ID of the jurisdictionoverride you wish to update
-      # @param model [Object] The jurisdictionoverride object you wish to update.
-      # @return [Object]
-      def update_jurisdiction_override(accountId, id, model)
-        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
-        put(path, model)
-      end
-
-    end
-  end
+module AvaTax
+  class Client
+    module JurisdictionOverrides 
+
+
+      # Create one or more overrides
+      #
+      # Creates one or more jurisdiction override objects for this account.
+      #
+      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
+      # jurisdiction for a specific address. If you encounter an address that is on the boundary
+      # between two different jurisdictions, you can choose to set up a jurisdiction override
+      # to switch this address to use different taxing jurisdictions.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param accountId [Integer] The ID of the account that owns this override
+      # @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
+      # @return [JurisdictionOverrideModel[]]
+      def create_jurisdiction_overrides(accountId, model)
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
+        post(path, model)
+      end
+
+
+      # Delete a single override
+      #
+      # Marks the item object at this URL as deleted.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param accountId [Integer] The ID of the account that owns this override
+      # @param id [Integer] The ID of the override you wish to delete
+      # @return [ErrorDetail[]]
+      def delete_jurisdiction_override(accountId, id)
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        delete(path)
+      end
+
+
+      # Retrieve a single override
+      #
+      # Get the item object identified by this URL.
+      #
+      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
+      # jurisdiction for a specific address. If you encounter an address that is on the boundary
+      # between two different jurisdictions, you can choose to set up a jurisdiction override
+      # to switch this address to use different taxing jurisdictions.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param accountId [Integer] The ID of the account that owns this override
+      # @param id [Integer] The primary key of this override
+      # @return [Object]
+      def get_jurisdiction_override(accountId, id)
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        get(path)
+      end
+
+
+      # Retrieve overrides for this account
+      #
+      # List all jurisdiction override objects defined for this account.
+      #
+      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
+      # jurisdiction for a specific address. If you encounter an address that is on the boundary
+      # between two different jurisdictions, you can choose to set up a jurisdiction override
+      # to switch this address to use different taxing jurisdictions.
+      #
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @param accountId [Integer] The ID of the account that owns this override
+      # @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/).<br />*Not filterable:* country, Jurisdictions
+      # @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_jurisdiction_overrides_by_account(accountId, options={})
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
+        get(path, options)
+      end
+
+
+      # Retrieve all overrides
+      #
+      # Get multiple jurisdiction override objects across all companies.
+      #
+      # A Jurisdiction Override is a configuration setting that allows you to select the taxing
+      # jurisdiction for a specific address. If you encounter an address that is on the boundary
+      # between two different jurisdictions, you can choose to set up a jurisdiction override
+      # to switch this address to use different taxing jurisdictions.
+      #
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @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/).<br />*Not filterable:* country, Jurisdictions
+      # @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_jurisdiction_overrides(options={})
+        path = "/api/v2/jurisdictionoverrides"
+        get(path, options)
+      end
+
+
+      # Update a single jurisdictionoverride
+      #
+      # Replace the existing jurisdictionoverride object at this URL with an updated object.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param accountId [Integer] The ID of the account that this jurisdictionoverride belongs to.
+      # @param id [Integer] The ID of the jurisdictionoverride you wish to update
+      # @param model [Object] The jurisdictionoverride object you wish to update.
+      # @return [Object]
+      def update_jurisdiction_override(accountId, id, model)
+        path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
+        put(path, model)
+      end
+
+    end
+  end
 end

data/lib/avatax/client/locations.rb

@@ -1,161 +1,164 @@
-module AvaTax
-  class Client
-    module Locations 
-
-
-      # Create a new location
-      #
-      # Create one or more new location objects attached to this company.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param companyId [Integer] The ID of the company that owns this location.
-      # @param model [LocationModel[]] The location you wish to create.
-      # @return [LocationModel[]]
-      def create_locations(companyId, model)
-        path = "/api/v2/companies/#{companyId}/locations"
-        post(path, model)
-      end
-
-
-      # Delete a single location
-      #
-      # Mark the location object at this URL as deleted.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param companyId [Integer] The ID of the company that owns this location.
-      # @param id [Integer] The ID of the location you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_location(companyId, id)
-        path = "/api/v2/companies/#{companyId}/locations/#{id}"
-        delete(path)
-      end
-
-
-      # Retrieve a single location
-      #
-      # Get the location object identified by this URL.
-      # An 'Location' represents a physical address where a company does business.
-      # Many taxing authorities require that you define a list of all locations where your company does business.
-      # These locations may require additional custom configuration or tax registration with these authorities.
-      # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
-      #
-      # 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:
-      #
-      # * LocationSettings
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @param companyId [Integer] The ID of the company that owns this location
-      # @param id [Integer] The primary key of this location
-      # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
-      # @return [Object]
-      def get_location(companyId, id, options={})
-        path = "/api/v2/companies/#{companyId}/locations/#{id}"
-        get(path, options)
-      end
-
-
-      # Retrieve locations for this company
-      #
-      # List all location objects defined for this company.
-      # An 'Location' represents a physical address where a company does business.
-      # Many taxing authorities require that you define a list of all locations where your company does business.
-      # These locations may require additional custom configuration or tax registration with these authorities.
-      # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
-      #
-      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
-      # 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:
-      #
-      # * LocationSettings
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @param companyId [Integer] The ID of the company that owns these locations
-      # @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/).<br />*Not filterable:* settings
-      # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
-      # @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_locations_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/locations"
-        get(path, options)
-      end
-
-
-      # Retrieve all locations
-      #
-      # Get multiple location objects across all companies.
-      # An 'Location' represents a physical address where a company does business.
-      # Many taxing authorities require that you define a list of all locations where your company does business.
-      # These locations may require additional custom configuration or tax registration with these authorities.
-      # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
-      #
-      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
-      #
-      # 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:
-      #
-      # * LocationSettings
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @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/).<br />*Not filterable:* settings
-      # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
-      # @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_locations(options={})
-        path = "/api/v2/locations"
-        get(path, options)
-      end
-
-
-      # Update a single location
-      #
-      # Replace the existing location object at this URL with an updated object.
-      # All data from the existing object will be replaced with data in the object you PUT.
-      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # @param companyId [Integer] The ID of the company that this location belongs to.
-      # @param id [Integer] The ID of the location you wish to update
-      # @param model [Object] The location you wish to update.
-      # @return [Object]
-      def update_location(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/locations/#{id}"
-        put(path, model)
-      end
-
-
-      # Validate the location against local requirements
-      #
-      # Returns validation information for this location.
-      # This API call is intended to compare this location against the currently known taxing authority rules and regulations,
-      # and provide information about what additional work is required to completely setup this location.
-      #
-      # ### Security Policies
-      #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # @param companyId [Integer] The ID of the company that owns this location
-      # @param id [Integer] The primary key of this location
-      # @return [Object]
-      def validate_location(companyId, id)
-        path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
-        get(path)
-      end
-
-    end
-  end
+module AvaTax
+  class Client
+    module Locations 
+
+
+      # Create a new location
+      #
+      # Create one or more new location objects attached to this company.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this location.
+      # @param model [LocationModel[]] The location you wish to create.
+      # @return [LocationModel[]]
+      def create_locations(companyId, model)
+        path = "/api/v2/companies/#{companyId}/locations"
+        post(path, model)
+      end
+
+
+      # Delete a single location
+      #
+      # Mark the location object at this URL as deleted.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this location.
+      # @param id [Integer] The ID of the location you wish to delete.
+      # @return [ErrorDetail[]]
+      def delete_location(companyId, id)
+        path = "/api/v2/companies/#{companyId}/locations/#{id}"
+        delete(path)
+      end
+
+
+      # Retrieve a single location
+      #
+      # Get the location object identified by this URL.
+      # An 'Location' represents a physical address where a company does business.
+      # Many taxing authorities require that you define a list of all locations where your company does business.
+      # These locations may require additional custom configuration or tax registration with these authorities.
+      # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
+      #
+      # 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:
+      #
+      # * LocationSettings
+      # * parameters
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param companyId [Integer] The ID of the company that owns this location
+      # @param id [Integer] The primary key of this location
+      # @param include [String] A comma separated list of additional data to retrieve.
+      # @return [Object]
+      def get_location(companyId, id, options={})
+        path = "/api/v2/companies/#{companyId}/locations/#{id}"
+        get(path, options)
+      end
+
+
+      # Retrieve locations for this company
+      #
+      # List all location objects defined for this company.
+      # An 'Location' represents a physical address where a company does business.
+      # Many taxing authorities require that you define a list of all locations where your company does business.
+      # These locations may require additional custom configuration or tax registration with these authorities.
+      # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
+      #
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      # 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:
+      #
+      # * LocationSettings
+      # * parameters
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param companyId [Integer] The ID of the company that owns these locations
+      # @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/).<br />*Not filterable:* settings, parameters
+      # @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_locations_by_company(companyId, options={})
+        path = "/api/v2/companies/#{companyId}/locations"
+        get(path, options)
+      end
+
+
+      # Retrieve all locations
+      #
+      # Get multiple location objects across all companies.
+      # An 'Location' represents a physical address where a company does business.
+      # Many taxing authorities require that you define a list of all locations where your company does business.
+      # These locations may require additional custom configuration or tax registration with these authorities.
+      # For more information on metadata requirements, see the '/api/v2/definitions/locationquestions' API.
+      #
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      #
+      # 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:
+      #
+      # * LocationSettings
+      # * parameters
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @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/).<br />*Not filterable:* settings, parameters
+      # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
+      # @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_locations(options={})
+        path = "/api/v2/locations"
+        get(path, options)
+      end
+
+
+      # Update a single location
+      #
+      # Replace the existing location object at this URL with an updated object.
+      # All data from the existing object will be replaced with data in the object you PUT.
+      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that this location belongs to.
+      # @param id [Integer] The ID of the location you wish to update
+      # @param model [Object] The location you wish to update.
+      # @return [Object]
+      def update_location(companyId, id, model)
+        path = "/api/v2/companies/#{companyId}/locations/#{id}"
+        put(path, model)
+      end
+
+
+      # Validate the location against local requirements
+      #
+      # Returns validation information for this location.
+      # This API call is intended to compare this location against the currently known taxing authority rules and regulations,
+      # and provide information about what additional work is required to completely setup this location.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # @param companyId [Integer] The ID of the company that owns this location
+      # @param id [Integer] The primary key of this location
+      # @return [Object]
+      def validate_location(companyId, id)
+        path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
+        get(path)
+      end
+
+    end
+  end
 end