avatax 19.12.1 → 20.1.0

data/lib/avatax/client/taxrules.rb

@@ -25,11 +25,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this tax rule.
       # @param model [TaxRuleModel[]] The tax rule you wish to create.
       # @return [TaxRuleModel[]]
-      def create_tax_rules(companyId, model)
-        path = "/api/v2/companies/#{companyId}/taxrules"
-        post(path, model)
-      end
-
+      def create_tax_rules(companyId, model)        path = "/api/v2/companies/#{companyId}/taxrules"
+        post(path, model)      end
 
       # Delete a single tax rule
       #
@@ -53,11 +50,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this tax rule.
       # @param id [Integer] The ID of the tax rule you wish to delete.
       # @return [ErrorDetail[]]
-      def delete_tax_rule(companyId, id)
-        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        delete(path)
-      end
-
+      def delete_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
+        delete(path)      end
 
       # Retrieve a single tax rule
       #
@@ -81,11 +75,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this tax rule
       # @param id [Integer] The primary key of this tax rule
       # @return [Object]
-      def get_tax_rule(companyId, id)
-        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        get(path)
-      end
-
+      def get_tax_rule(companyId, id)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
+        get(path)      end
 
       # Retrieve tax rules for this company
       #
@@ -116,11 +107,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_tax_rules(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/taxrules"
-        get(path, options)
-      end
-
+      def list_tax_rules(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxrules"
+        get(path, options)      end
 
       # Retrieve all tax rules
       #
@@ -150,11 +138,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_tax_rules(options={})
-        path = "/api/v2/taxrules"
-        get(path, options)
-      end
-
+      def query_tax_rules(options={})        path = "/api/v2/taxrules"
+        get(path, options)      end
 
       # Update a single tax rule
       #
@@ -179,11 +164,8 @@ module AvaTax
       # @param id [Integer] The ID of the tax rule you wish to update
       # @param model [Object] The tax rule you wish to update.
       # @return [Object]
-      def update_tax_rule(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
-        put(path, model)
-      end
-
+      def update_tax_rule(companyId, id, model)        path = "/api/v2/companies/#{companyId}/taxrules/#{id}"
+        put(path, model)      end
     end
   end
 end

data/lib/avatax/client/transactions.rb

@@ -33,11 +33,8 @@ module AvaTax
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] information about the transaction and lines to be added
       # @return [Object]
-      def add_lines(model, options={})
-        path = "/api/v2/companies/transactions/lines/add"
-        post(path, model, options)
-      end
-
+      def add_lines(model, options={})        path = "/api/v2/companies/transactions/lines/add"
+        post(path, model, options)      end
 
       # Correct a previously created transaction
       #
@@ -78,11 +75,8 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The adjustment you wish to make
       # @return [Object]
-      def adjust_transaction(companyCode, transactionCode, model, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
-        post(path, model, options)
-      end
-
+      def adjust_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
+        post(path, model, options)      end
 
       # Get audit information about a transaction
       #
@@ -114,11 +108,8 @@ module AvaTax
       # @param companyCode [String] The code identifying the company that owns this transaction
       # @param transactionCode [String] The code identifying the transaction
       # @return [Object]
-      def audit_transaction(companyCode, transactionCode)
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/audit"
-        get(path)
-      end
-
+      def audit_transaction(companyCode, transactionCode)        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/audit"
+        get(path)      end
 
       # Get audit information about a transaction
       #
@@ -151,11 +142,8 @@ module AvaTax
       # @param transactionCode [String] The code identifying the transaction
       # @param documentType [String] The document type of the original transaction (See DocumentType::* for a list of allowable values)
       # @return [Object]
-      def audit_transaction_with_type(companyCode, transactionCode, documentType)
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}/audit"
-        get(path)
-      end
-
+      def audit_transaction_with_type(companyCode, transactionCode, documentType)        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}/audit"
+        get(path)      end
 
       # Lock a set of documents
       #
@@ -173,11 +161,8 @@ module AvaTax
       # * 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.
       # @param model [Object] bulk lock request
       # @return [Object]
-      def bulk_lock_transaction(model)
-        path = "/api/v2/transactions/lock"
-        post(path, model)
-      end
-
+      def bulk_lock_transaction(model)        path = "/api/v2/transactions/lock"
+        post(path, model)      end
 
       # Change a transaction's code
       #
@@ -211,18 +196,15 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, AvaTaxST.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to change
       # @param documentType [String] (Optional): The document type of the transaction to change document code. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The code change request you wish to execute
       # @return [Object]
-      def change_transaction_code(companyCode, transactionCode, model, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
-        post(path, model, options)
-      end
-
+      def change_transaction_code(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
+        post(path, model, options)      end
 
       # Commit a transaction for reporting
       #
@@ -261,11 +243,8 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The commit request you wish to execute
       # @return [Object]
-      def commit_transaction(companyCode, transactionCode, model, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
-        post(path, model, options)
-      end
-
+      def commit_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
+        post(path, model, options)      end
 
       # Create or adjust a transaction
       #
@@ -306,15 +285,12 @@ 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): AvaTaxPro.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] The transaction you wish to create or adjust
       # @return [Object]
-      def create_or_adjust_transaction(model, options={})
-        path = "/api/v2/transactions/createoradjust"
-        post(path, model, options)
-      end
-
+      def create_or_adjust_transaction(model, options={})        path = "/api/v2/transactions/createoradjust"
+        post(path, model, options)      end
 
       # Create a new transaction
       #
@@ -362,15 +338,12 @@ 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): AvaTaxPro.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] The transaction you wish to create
       # @return [Object]
-      def create_transaction(model, options={})
-        path = "/api/v2/transactions/create"
-        post(path, model, options)
-      end
-
+      def create_transaction(model, options={})        path = "/api/v2/transactions/create"
+        post(path, model, options)      end
 
       # Remove lines from an existing unlocked transaction
       #
@@ -399,11 +372,8 @@ module AvaTax
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] information about the transaction and lines to be removed
       # @return [Object]
-      def delete_lines(model, options={})
-        path = "/api/v2/companies/transactions/lines/delete"
-        post(path, model, options)
-      end
-
+      def delete_lines(model, options={})        path = "/api/v2/companies/transactions/lines/delete"
+        post(path, model, options)      end
 
       # Retrieve a single transaction by code
       #
@@ -434,17 +404,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to retrieve
       # @param documentType [String] (Optional): The document type of the transaction to retrieve (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
-      def get_transaction_by_code(companyCode, transactionCode, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
-        get(path, options)
-      end
-
+      def get_transaction_by_code(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
+        get(path, options)      end
 
       # Retrieve a single transaction by code
       #
@@ -458,17 +425,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param transactionCode [String] The transaction code to retrieve
       # @param documentType [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
-      def get_transaction_by_code_and_type(companyCode, transactionCode, documentType, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}"
-        get(path, options)
-      end
-
+      def get_transaction_by_code_and_type(companyCode, transactionCode, documentType, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}"
+        get(path, options)      end
 
       # Retrieve a single transaction by ID
       #
@@ -493,15 +457,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
       # @param id [Integer] The unique ID number of the transaction to retrieve
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
-      def get_transaction_by_id(id, options={})
-        path = "/api/v2/transactions/#{id}"
-        get(path, options)
-      end
-
+      def get_transaction_by_id(id, options={})        path = "/api/v2/transactions/#{id}"
+        get(path, options)      end
 
       # Retrieve all transactions
       #
@@ -535,7 +496,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
       # @param companyCode [String] The company code of the company that recorded this transaction
       # @param dataSourceId [Integer] Optionally filter transactions to those from a specific data source.
       # @param include [String] Specifies objects to include in this fetch call
@@ -544,11 +505,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_transactions_by_company(companyCode, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions"
-        get(path, options)
-      end
-
+      def list_transactions_by_company(companyCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions"
+        get(path, options)      end
 
       # Lock a single transaction
       #
@@ -589,11 +547,8 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The lock request you wish to execute
       # @return [Object]
-      def lock_transaction(companyCode, transactionCode, model, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
-        post(path, model, options)
-      end
-
+      def lock_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
+        post(path, model, options)      end
 
       # Create a refund for a transaction
       #
@@ -645,11 +600,8 @@ module AvaTax
       # @param useTaxDateOverride [Boolean] (Optional): If set to true, processes refund using taxDateOverride rather than taxAmountOverride (Note: taxAmountOverride is not allowed for SST states).
       # @param model [Object] Information about the refund to create
       # @return [Object]
-      def refund_transaction(companyCode, transactionCode, model, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
-        post(path, model, options)
-      end
-
+      def refund_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
+        post(path, model, options)      end
 
       # Perform multiple actions on a transaction
       #
@@ -688,11 +640,8 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The data from an external system to reconcile against AvaTax
       # @return [Object]
-      def settle_transaction(companyCode, transactionCode, model, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
-        post(path, model, options)
-      end
-
+      def settle_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
+        post(path, model, options)      end
 
       # Uncommit a transaction for reporting
       #
@@ -725,11 +674,8 @@ module AvaTax
       # @param documentType [String] (Optional): The document type of the transaction to Uncommit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
-      def uncommit_transaction(companyCode, transactionCode, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
-        post(path, options)
-      end
-
+      def uncommit_transaction(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
+        post(path, options)      end
 
       # Unvoids a transaction
       #
@@ -759,11 +705,8 @@ module AvaTax
       # @param documentType [String] (Optional): The document type of the transaction to commit. If not provided, the default is SalesInvoice. (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @return [Object]
-      def unvoid_transaction(companyCode, transactionCode, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
-        post(path, options)
-      end
-
+      def unvoid_transaction(companyCode, transactionCode, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
+        post(path, options)      end
 
       # Verify a transaction
       #
@@ -801,11 +744,8 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The data from an external system to reconcile against AvaTax
       # @return [Object]
-      def verify_transaction(companyCode, transactionCode, model, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
-        post(path, model, options)
-      end
-
+      def verify_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
+        post(path, model, options)      end
 
       # Void a transaction
       #
@@ -845,11 +785,8 @@ module AvaTax
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The void request you wish to execute. To void a transaction the code must be set to 'DocVoided'
       # @return [Object]
-      def void_transaction(companyCode, transactionCode, model, options={})
-        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
-        post(path, model, options)
-      end
-
+      def void_transaction(companyCode, transactionCode, model, options={})        path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
+        post(path, model, options)      end
     end
   end
 end

data/lib/avatax/client/upcs.rb

@@ -15,11 +15,8 @@ module AvaTax
       # @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
-
+      def create_u_p_cs(companyId, model)        path = "/api/v2/companies/#{companyId}/upcs"
+        post(path, model)      end
 
       # Delete a single UPC
       #
@@ -32,11 +29,8 @@ module AvaTax
       # @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
-
+      def delete_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
+        delete(path)      end
 
       # Retrieve a single UPC
       #
@@ -50,11 +44,8 @@ module AvaTax
       # @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
-
+      def get_u_p_c(companyId, id)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
+        get(path)      end
 
       # Retrieve UPCs for this company
       #
@@ -75,11 +66,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_u_p_cs_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/upcs"
-        get(path, options)
-      end
-
+      def list_u_p_cs_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/upcs"
+        get(path, options)      end
 
       # Retrieve all UPCs
       #
@@ -99,11 +87,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_u_p_cs(options={})
-        path = "/api/v2/upcs"
-        get(path, options)
-      end
-
+      def query_u_p_cs(options={})        path = "/api/v2/upcs"
+        get(path, options)      end
 
       # Update a single UPC
       #
@@ -120,11 +105,8 @@ module AvaTax
       # @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
-
+      def update_u_p_c(companyId, id, model)        path = "/api/v2/companies/#{companyId}/upcs/#{id}"
+        put(path, model)      end
     end
   end
 end