avatax 20.5.0 → 20.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 919361911b2c607af6a9f0e004c164e68f3a66ae2bcb2617a5dc40b0aa881dc8
-  data.tar.gz: 971f945593297cd7b5084b231b93e1b2916e21e5584778cd2035bb39eec1f2d6
+  metadata.gz: 6ef7307b17dd1599496ed59f0082b8f4a5c550e314d2158859869019114557b7
+  data.tar.gz: 61c2b84e2f1a241482786ea18576061517086c124cac6dfa0cf8b03bb889fe3a
 SHA512:
-  metadata.gz: cb706706f40d263e52744854ef1dea8ef62094bfa525b5ba65e4a1b9fae2f9f06f344f80fd723b196a1f3ed6156c6dff1c5018eb5b2f07c400fbebaadbc08f9d
-  data.tar.gz: 87f68816e16ae20f3079bd9c27a058c484f98c90f976a1a636b67fb294888b9b76802669b62caddc7fa6ff050b3e84a6fd237be0c498715a6e7b39d19feddfff
+  metadata.gz: d40eca5e62391fb14ececa093915fbac5554dab803c2c1516fa310ad8063060b07bc448377fa4e8bc6e3bcd0f4fa2f003e8cc8a90b67a54eca0d3d8bdbbcdd9c
+  data.tar.gz: b02b8f1e8fa85437980bf7cf508085a8155565c822e19e48d9c91069d72e5d90f1752db962be1441896ec5cf362f3dc58bb3449b78844a5eb2fd48ebd21a5e96

data/lib/avatax/client/accounts.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Accounts 
-
-
-      # Reset this account's license key
-      #
+module AvaTax
+  class Client
+    module Accounts 
+
+
+      # Reset this account's license key
+      #
       # Resets the existing license key for this account to a new key.
       #
       # To reset your account, you must specify the ID of the account you wish to reset and confirm the action.
@@ -22,15 +22,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] The ID of the account you wish to update.
       # @param model [Object] A request confirming that you wish to reset the license key of this account.
-      # @return [Object]
-      def account_reset_license_key(id, model)        path = "/api/v2/accounts/#{id}/resetlicensekey"
-        post(path, model)      end
-
-      # Activate an account by accepting terms and conditions
-      #
+      # @return [Object]
+      def account_reset_license_key(id, model)
+        path = "/api/v2/accounts/#{id}/resetlicensekey"
+        post(path, model)
+      end
+
+
+      # Activate an account by accepting terms and conditions
+      #
       # Activate the account specified by the unique accountId number.
       #
       # This activation request can only be called by account administrators. You must indicate
@@ -44,15 +47,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] The ID of the account to activate
       # @param model [Object] The activation request
-      # @return [Object]
-      def activate_account(id, model)        path = "/api/v2/accounts/#{id}/activate"
-        post(path, model)      end
-
-      # Retrieve audit history for an account.
-      #
+      # @return [Object]
+      def activate_account(id, model)
+        path = "/api/v2/accounts/#{id}/activate"
+        post(path, model)
+      end
+
+
+      # Retrieve audit history for an account.
+      #
       # Retrieve audit trace history for an account.
       #
       # Your audit trace history contains a record of all API calls made against the AvaTax REST API that returned an error. You can use this API to investigate
@@ -70,18 +76,21 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] The ID of the account you wish to audit.
       # @param start [DateTime] The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.
       # @param end [DateTime] The end datetime of audit history you with to retrieve, e.g. "2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.
       # @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.
-      # @return [FetchResult]
-      def audit_account(id, options={})        path = "/api/v2/accounts/#{id}/audit"
-        get(path, options)      end
-
-      # Create license key for this account
-      #
+      # @return [FetchResult]
+      def audit_account(id, options={})
+        path = "/api/v2/accounts/#{id}/audit"
+        get(path, options)
+      end
+
+
+      # Create license key for this account
+      #
       # Creates a new license key for this account.
       #
       # To create a license key for your account, you must specify the ID of the account and license key name.
@@ -95,15 +104,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] The ID of the account you wish to update.
       # @param model [Object] 
-      # @return [Object]
-      def create_license_key(id, model)        path = "/api/v2/accounts/#{id}/licensekey"
-        post(path, model)      end
-
-      # Delete license key for this account by license key name
-      #
+      # @return [Object]
+      def create_license_key(id, model)
+        path = "/api/v2/accounts/#{id}/licensekey"
+        post(path, model)
+      end
+
+
+      # Delete license key for this account by license key name
+      #
       # Deletes the license key for this account using license key name.
       #
       # To delete a license key for your account, you must specify the accountID of the account and license key name.
@@ -112,15 +124,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param id [Integer] The ID of the account you wish to update.
       # @param licensekeyname [String] The license key name you wish to update.
-      # @return [ErrorDetail[]]
-      def delete_license_key(id, licensekeyname)        path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
-        delete(path)      end
-
-      # Retrieve a single account
-      #
+      # @return [ErrorDetail[]]
+      def delete_license_key(id, licensekeyname)
+        path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
+        delete(path)
+      end
+
+
+      # Retrieve a single account
+      #
       # Get the account object identified by this URL.
       # You may use the '$include' parameter to fetch additional nested data:
       #
@@ -129,15 +144,18 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] The ID of the account to retrieve
       # @param include [String] A comma separated list of special fetch options
-      # @return [Object]
-      def get_account(id, options={})        path = "/api/v2/accounts/#{id}"
-        get(path, options)      end
-
-      # Get configuration settings for this account
-      #
+      # @return [Object]
+      def get_account(id, options={})
+        path = "/api/v2/accounts/#{id}"
+        get(path, options)
+      end
+
+
+      # Get configuration settings for this account
+      #
       # Retrieve a list of all configuration settings tied to this account.
       #
       # Configuration settings provide you with the ability to control features of your account and of your
@@ -153,37 +171,46 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param id [Integer] 
-      # @return [AccountConfigurationModel[]]
-      def get_account_configuration(id)        path = "/api/v2/accounts/#{id}/configuration"
-        get(path)      end
-
-      # Retrieve license key by license key name
-      #
+      # @return [AccountConfigurationModel[]]
+      def get_account_configuration(id)
+        path = "/api/v2/accounts/#{id}/configuration"
+        get(path)
+      end
+
+
+      # Retrieve license key by license key name
+      #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] The ID of the account to retrieve
       # @param licensekeyname [String] The ID of the account to retrieve
-      # @return [Object]
-      def get_license_key(id, licensekeyname)        path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
-        get(path)      end
-
-      # Retrieve all license keys for this account
-      #
+      # @return [Object]
+      def get_license_key(id, licensekeyname)
+        path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
+        get(path)
+      end
+
+
+      # Retrieve all license keys for this account
+      #
       # Gets list of all the license keys used by the account.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] The ID of the account to retrieve
-      # @return [AccountLicenseKeyModel[]]
-      def get_license_keys(id)        path = "/api/v2/accounts/#{id}/licensekeys"
-        get(path)      end
-
-      # Retrieve all accounts
-      #
+      # @return [AccountLicenseKeyModel[]]
+      def get_license_keys(id)
+        path = "/api/v2/accounts/#{id}/licensekeys"
+        get(path)
+      end
+
+
+      # Retrieve all accounts
+      #
       # List all account objects that can be seen by the current user.
       #
       # This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account.
@@ -199,18 +226,21 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
       # @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:* subscriptions, users
       # @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_accounts(options={})        path = "/api/v2/accounts"
-        get(path, options)      end
-
-      # Change configuration settings for this account
-      #
+      # @return [FetchResult]
+      def query_accounts(options={})
+        path = "/api/v2/accounts"
+        get(path, options)
+      end
+
+
+      # Change configuration settings for this account
+      #
       # Update configuration settings tied to this account.
       #
       # Configuration settings provide you with the ability to control features of your account and of your
@@ -226,12 +256,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
       # @param id [Integer] 
       # @param model [AccountConfigurationModel[]] 
-      # @return [AccountConfigurationModel[]]
-      def set_account_configuration(id, model)        path = "/api/v2/accounts/#{id}/configuration"
-        post(path, model)      end
-    end
-  end
+      # @return [AccountConfigurationModel[]]
+      def set_account_configuration(id, model)
+        path = "/api/v2/accounts/#{id}/configuration"
+        post(path, model)
+      end
+
+    end
+  end
 end

data/lib/avatax/client/addresses.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Addresses 
-
-
-      # Retrieve geolocation information for a specified address
-      #
+module AvaTax
+  class Client
+    module Addresses 
+
+
+      # Retrieve geolocation information for a specified address
+      #
       # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
       # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
       # to identify how closely this address can be located. If the address cannot be clearly located, use the
@@ -20,7 +20,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AutoAddress.
+      # * This API depends on the following active services<br />*Required* (all): AutoAddress.
       # @param line1 [String] Line 1
       # @param line2 [String] Line 2
       # @param line3 [String] Line 3
@@ -29,12 +29,15 @@ module AvaTax
       # @param postalCode [String] Postal Code / Zip Code
       # @param country [String] Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)
       # @param textCase [String] selectable text case for address validation (See TextCase::* for a list of allowable values)
-      # @return [Object]
-      def resolve_address(options={})        path = "/api/v2/addresses/resolve"
-        get(path, options)      end
-
-      # Retrieve geolocation information for a specified address
-      #
+      # @return [Object]
+      def resolve_address(options={})
+        path = "/api/v2/addresses/resolve"
+        get(path, options)
+      end
+
+
+      # Retrieve geolocation information for a specified address
+      #
       # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
       # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
       # to identify how closely this address can be located. If the address cannot be clearly located, use the
@@ -45,11 +48,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AutoAddress.
+      # * This API depends on the following active services<br />*Required* (all): AutoAddress.
       # @param model [Object] The address to resolve
-      # @return [Object]
-      def resolve_address_post(model)        path = "/api/v2/addresses/resolve"
-        post(path, model)      end
-    end
-  end
+      # @return [Object]
+      def resolve_address_post(model)
+        path = "/api/v2/addresses/resolve"
+        post(path, model)
+      end
+
+    end
+  end
 end

data/lib/avatax/client/advancedrules.rb

@@ -1,54 +1,69 @@
-module AvaTax
-  class Client
-    module AdvancedRules 
-
-
-      # Create a lookup file for a company
-      #
-      # 
+module AvaTax
+  class Client
+    module AdvancedRules 
+
+
+      # Create a lookup file for a company
+      #
+      # 
       # @param accountId [Integer] The ID of the account for the company
       # @param companyId [Integer] The ID of the company for which the lookup file is to be created
       # @param model [Object] The lookup file you wish to create
-      # @return [Object]
-      def create_company_lookup_file(accountId, companyId, model)        path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
-        post(path, model)      end
-
-      # Delete a lookup file
-      #
-      # 
+      # @return [Object]
+      def create_company_lookup_file(accountId, companyId, model)
+        path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
+        post(path, model)
+      end
+
+
+      # Delete a lookup file
+      #
+      # 
       # @param accountId [Integer] The ID of the account for the company the lookup file is for
       # @param id [String] The unique ID/GUID for the company lookup file to be deleted
-      # @return [ErrorDetail[]]
-      def delete_lookup_file(accountId, id)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
-        delete(path)      end
-
-      # Get the lookup files for a company
-      #
-      # 
+      # @return [ErrorDetail[]]
+      def delete_lookup_file(accountId, id)
+        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
+        delete(path)
+      end
+
+
+      # Get the lookup files for a company
+      #
+      # 
       # @param accountId [Integer] The account ID for the company
       # @param companyId [Integer] The ID of the company for which to retrieve lookup files
-      # @return [FetchResult]
-      def get_company_lookup_files(accountId, companyId)        path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
-        get(path)      end
-
-      # Get a lookup file for an accountId and companyLookupFileId
-      #
-      # 
+      # @return [FetchResult]
+      def get_company_lookup_files(accountId, companyId)
+        path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
+        get(path)
+      end
+
+
+      # Get a lookup file for an accountId and companyLookupFileId
+      #
+      # 
       # @param accountId [Integer] The ID of the account for the lookup file
       # @param id [String] The unique ID/GUID of the company lookup file to return
-      # @return [Object]
-      def get_lookup_file(accountId, id)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
-        get(path)      end
-
-      # Update a lookup file
-      #
-      # 
+      # @return [Object]
+      def get_lookup_file(accountId, id)
+        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
+        get(path)
+      end
+
+
+      # Update a lookup file
+      #
+      # 
       # @param accountId [Integer] The ID of the account for the company the lookup file is for
       # @param id [String] The unique ID/GUID of the company lookup file to be updated
       # @param model [Object] The new values to update the lookup file
-      # @return [Object]
-      def update_lookup_file(accountId, id, model)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_lookup_file(accountId, id, model)
+        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
+        put(path, model)
+      end
+
+    end
+  end
 end