avatax 20.7.0 → 21.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a3c2015349a64ef8875c8198e04f26a6cf2c0bd631328c9a2f885e4cf8e16e4
-  data.tar.gz: 7d086ee2c887b48680dc53a302a7cc1c0f3e116764695518124282ca9cc2cd21
+  metadata.gz: b184760b2c4cae98e6c312cd19bb6bd2b06f0729d937875e1b4255099c2c74e8
+  data.tar.gz: 3fd974ce95d2b2aa3d4d0a05a6e3d323d1e7ebfe62b11ab63fd713ab23e6a365
 SHA512:
-  metadata.gz: 1aae1f7fd0a836bbeb38ee880f2eee39783013d516e098cc5acdca753f3776d39693c6bd7feb345ba71526ff43380c4013723e67bb1893b6d472d1ce62122707
-  data.tar.gz: 355dc16e423551083fd33180ad36d7477a5cdaf593281eb580b15366689b761a3f1885675a0dc2c37da670837f65a3b6ce4bc8351ce6f756790281b454a1f996
+  metadata.gz: 8a867c76f21fee855a964ebc9dcc77cc0b1ae48c7e4ebcd8759f422bd4eb9c9467262047ca26e12eaa66f298c9b45006b329db84f45df62ccef8928666c68bb5
+  data.tar.gz: e78b33a26bc3b66b6d4f28046716a8878aa6333a8840987597388b8808f1d1b264b983e524bd6b4c907161a1858f32aebf1d243b4e57f70d62a55c698ce768dd

data/lib/avatax/client/accounts.rb

@@ -26,11 +26,8 @@ module AvaTax
       # @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
-
+      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
       #
@@ -51,11 +48,8 @@ module AvaTax
       # @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
-
+      def activate_account(id, model)        path = "/api/v2/accounts/#{id}/activate"
+        post(path, model)      end
 
       # Retrieve audit history for an account.
       #
@@ -83,11 +77,8 @@ module AvaTax
       # @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
-
+      def audit_account(id, options={})        path = "/api/v2/accounts/#{id}/audit"
+        get(path, options)      end
 
       # Create license key for this account
       #
@@ -108,11 +99,8 @@ module AvaTax
       # @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
-
+      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
       #
@@ -128,11 +116,8 @@ module AvaTax
       # @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
-
+      def delete_license_key(id, licensekeyname)        path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
+        delete(path)      end
 
       # Retrieve a single account
       #
@@ -148,11 +133,8 @@ module AvaTax
       # @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
-
+      def get_account(id, options={})        path = "/api/v2/accounts/#{id}"
+        get(path, options)      end
 
       # Get configuration settings for this account
       #
@@ -174,11 +156,8 @@ module AvaTax
       # * 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
-
+      def get_account_configuration(id)        path = "/api/v2/accounts/#{id}/configuration"
+        get(path)      end
 
       # Retrieve license key by license key name
       #
@@ -188,11 +167,8 @@ module AvaTax
       # @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
-
+      def get_license_key(id, licensekeyname)        path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
+        get(path)      end
 
       # Retrieve all license keys for this account
       #
@@ -203,11 +179,8 @@ module AvaTax
       # * 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
-
+      def get_license_keys(id)        path = "/api/v2/accounts/#{id}/licensekeys"
+        get(path)      end
 
       # Retrieve all accounts
       #
@@ -233,11 +206,8 @@ module AvaTax
       # @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
-
+      def query_accounts(options={})        path = "/api/v2/accounts"
+        get(path, options)      end
 
       # Change configuration settings for this account
       #
@@ -260,11 +230,8 @@ module AvaTax
       # @param id [Integer] 
       # @param model [AccountConfigurationModel[]] 
       # @return [AccountConfigurationModel[]]
-      def set_account_configuration(id, model)
-        path = "/api/v2/accounts/#{id}/configuration"
-        post(path, model)
-      end
-
+      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

@@ -12,7 +12,7 @@ module AvaTax
       # This is the same API as the POST /api/v2/addresses/resolve endpoint.
       # Both verbs are supported to provide for flexible implementation.
       #
-      # Inorder to get any evaluation for an address please provide atleast one of the following fields/pairs:
+      # In order to get any evaluation for an address, please provide at least one of the following fields/pairs:
       # 1. postal code
       # 2. line1 + city + region
       # 3. line1 + postal code
@@ -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:*Required* (all): AutoAddress.
       # @param line1 [String] Line 1
       # @param line2 [String] Line 2
       # @param line3 [String] Line 3
@@ -30,11 +30,8 @@ module AvaTax
       # @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
-
+      def resolve_address(options={})        path = "/api/v2/addresses/resolve"
+        get(path, options)      end
 
       # Retrieve geolocation information for a specified address
       #
@@ -48,14 +45,11 @@ 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:*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
-
+      def resolve_address_post(model)        path = "/api/v2/addresses/resolve"
+        post(path, model)      end
     end
   end
 end

data/lib/avatax/client/advancedrules.rb

@@ -10,11 +10,8 @@ module AvaTax
       # @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
-
+      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
       #
@@ -22,24 +19,8 @@ module AvaTax
       # @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 audit records by account id and date range.
-      #
-      # 
-      # @param accountId [Integer] The ID of the account
-      # @param fromDate [String] Date
-      # @param toDate [String] Date
-      # @return [Object]
-      def get_audit_records(accountId, fromDate, toDate)
-        path = "/api/v2/advancedrules/audits/accounts/#{accountId}/from/#{fromDate}/to/#{toDate}"
-        get(path)
-      end
-
+      def delete_lookup_file(accountId, id)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
+        delete(path)      end
 
       # Get the lookup files for a company
       #
@@ -47,11 +28,8 @@ module AvaTax
       # @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
-
+      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
       #
@@ -59,11 +37,8 @@ module AvaTax
       # @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
-
+      def get_lookup_file(accountId, id)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
+        get(path)      end
 
       # Update a lookup file
       #
@@ -72,11 +47,8 @@ module AvaTax
       # @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
-
+      def update_lookup_file(accountId, id, model)        path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/avafileforms.rb

@@ -11,14 +11,11 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires the user role Compliance Root User.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
       # @return [AvaFileFormModel[]]
-      def create_ava_file_forms(model)
-        path = "/api/v2/avafileforms"
-        post(path, model)
-      end
-
+      def create_ava_file_forms(model)        path = "/api/v2/avafileforms"
+        post(path, model)      end
 
       # Delete a single AvaFileForm
       #
@@ -27,14 +24,11 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param id [Integer] The ID of the AvaFileForm you wish to delete.
       # @return [ErrorDetail[]]
-      def delete_ava_file_form(id)
-        path = "/api/v2/avafileforms/#{id}"
-        delete(path)
-      end
-
+      def delete_ava_file_form(id)        path = "/api/v2/avafileforms/#{id}"
+        delete(path)      end
 
       # Retrieve a single AvaFileForm
       #
@@ -43,14 +37,11 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param id [Integer] The primary key of this AvaFileForm
       # @return [Object]
-      def get_ava_file_form(id)
-        path = "/api/v2/avafileforms/#{id}"
-        get(path)
-      end
-
+      def get_ava_file_form(id)        path = "/api/v2/avafileforms/#{id}"
+        get(path)      end
 
       # Retrieve all AvaFileForms
       #
@@ -60,17 +51,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @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:* outletTypeId
       # @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_ava_file_forms(options={})
-        path = "/api/v2/avafileforms"
-        get(path, options)
-      end
-
+      def query_ava_file_forms(options={})        path = "/api/v2/avafileforms"
+        get(path, options)      end
 
       # Update a AvaFileForm
       #
@@ -80,15 +68,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires the user role Compliance Root User.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
+      # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
       # @param id [Integer] The ID of the AvaFileForm you wish to update
       # @param model [Object] The AvaFileForm model you wish to update.
       # @return [Object]
-      def update_ava_file_form(id, model)
-        path = "/api/v2/avafileforms/#{id}"
-        put(path, model)
-      end
-
+      def update_ava_file_form(id, model)        path = "/api/v2/avafileforms/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/batches.rb

@@ -24,11 +24,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param id [Integer] The ID of the batch to cancel.
       # @return [Object]
-      def cancel_batch(companyId, id)
-        path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
-        post(path)
-      end
-
+      def cancel_batch(companyId, id)        path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
+        post(path)      end
 
       # Create a new batch
       #
@@ -58,11 +55,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param model [BatchModel[]] The batch you wish to create.
       # @return [BatchModel[]]
-      def create_batches(companyId, model)
-        path = "/api/v2/companies/#{companyId}/batches"
-        post(path, model)
-      end
-
+      def create_batches(companyId, model)        path = "/api/v2/companies/#{companyId}/batches"
+        post(path, model)      end
 
       # Create a new transaction batch
       #
@@ -90,11 +84,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param model [Object] The transaction batch you wish to create.
       # @return [Object]
-      def create_transaction_batch(companyId, model)
-        path = "/api/v2/companies/#{companyId}/batches/transactions"
-        post(path, model)
-      end
-
+      def create_transaction_batch(companyId, model)        path = "/api/v2/companies/#{companyId}/batches/transactions"
+        post(path, model)      end
 
       # Delete a single batch
       #
@@ -115,11 +106,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this batch.
       # @param id [Integer] The ID of the batch to delete.
       # @return [ErrorDetail[]]
-      def delete_batch(companyId, id)
-        path = "/api/v2/companies/#{companyId}/batches/#{id}"
-        delete(path)
-      end
-
+      def delete_batch(companyId, id)        path = "/api/v2/companies/#{companyId}/batches/#{id}"
+        delete(path)      end
 
       # Download a single batch file
       #
@@ -132,11 +120,8 @@ module AvaTax
       # @param batchId [Integer] The ID of the batch object
       # @param id [Integer] The primary key of this batch file object
       # @return [Object]
-      def download_batch(companyId, batchId, id)
-        path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
-        get(path)
-      end
-
+      def download_batch(companyId, batchId, id)        path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
+        get(path)      end
 
       # Retrieve a single batch
       #
@@ -162,11 +147,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this batch
       # @param id [Integer] The primary key of this batch
       # @return [Object]
-      def get_batch(companyId, id)
-        path = "/api/v2/companies/#{companyId}/batches/#{id}"
-        get(path)
-      end
-
+      def get_batch(companyId, id)        path = "/api/v2/companies/#{companyId}/batches/#{id}"
+        get(path)      end
 
       # Retrieve all batches for this company
       #
@@ -202,11 +184,8 @@ module AvaTax
       # @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_batches_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/batches"
-        get(path, options)
-      end
-
+      def list_batches_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/batches"
+        get(path, options)      end
 
       # Retrieve all batches
       #
@@ -238,11 +217,8 @@ module AvaTax
       # @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_batches(options={})
-        path = "/api/v2/batches"
-        get(path, options)
-      end
-
+      def query_batches(options={})        path = "/api/v2/batches"
+        get(path, options)      end
     end
   end
 end