avatax 21.8.0 → 22.2.0

data/lib/avatax/client/multidocument.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module MultiDocument 
-
-
-      # Adjust a MultiDocument transaction
-      #
+module AvaTax
+  class Client
+    module MultiDocument 
+
+
+      # Adjust a MultiDocument transaction
+      #
       # Adjusts the current MultiDocument transaction uniquely identified by this URL.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -27,17 +27,18 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param code [String] The transaction code for this MultiDocument transaction
       # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in this fetch call
       # @param model [Object] The adjust request you wish to execute
-      # @return [Object]
-      def adjust_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
-        post(path, model, options)      end
-
-      # Get audit information about a MultiDocument transaction
-      #
+      # @return [Object]
+      def adjust_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
+        post(path, model, options, "22.2.0")      end
+
+      # Get audit information about a MultiDocument transaction
+      #
       # Retrieve audit information about a MultiDocument transaction stored in AvaTax.
       #
       # The audit API retrieves audit information related to a specific MultiDocument transaction. This audit
@@ -64,15 +65,16 @@ 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:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param code [String] The transaction code for this MultiDocument transaction
       # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
-      # @return [Object]
-      def audit_multi_document_transaction(code, type)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
-        get(path)      end
-
-      # Commit a MultiDocument transaction
-      #
+      # @return [Object]
+      def audit_multi_document_transaction(code, type)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
+        get(path, {}, "22.2.0")      end
+
+      # Commit a MultiDocument transaction
+      #
       # Marks a list of transactions by changing its status to `Committed`.
       #
       # Transactions that are committed are available to be reported to a tax authority by Avalara Managed Returns.
@@ -93,14 +95,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:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] The commit request you wish to execute
-      # @return [Object]
-      def commit_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/commit"
-        post(path, model)      end
-
-      # Create a new MultiDocument transaction
-      #
+      # @return [Object]
+      def commit_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/commit"
+        post(path, model, {}, "22.2.0")      end
+
+      # Create a new MultiDocument transaction
+      #
       # Records a new MultiDocument transaction in AvaTax.
       #
       # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -145,15 +148,16 @@ 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:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] the multi document transaction model
-      # @return [Object]
-      def create_multi_document_transaction(model, options={})        path = "/api/v2/transactions/multidocument"
-        post(path, model, options)      end
-
-      # Retrieve a MultiDocument transaction
-      #
+      # @return [Object]
+      def create_multi_document_transaction(model, options={})        path = "/api/v2/transactions/multidocument"
+        post(path, model, options, "22.2.0")      end
+
+      # Retrieve a MultiDocument transaction
+      #
       # Get the current MultiDocument transaction identified by this URL.
       #
       # If this transaction was adjusted, the return value of this API will be the current transaction with this code.
@@ -178,16 +182,17 @@ 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:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param code [String] The multidocument code to retrieve
       # @param type [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in the response after transaction is created
-      # @return [Object]
-      def get_multi_document_transaction_by_code_and_type(code, type, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
-        get(path, options)      end
-
-      # Retrieve a MultiDocument transaction by ID
-      #
+      # @return [Object]
+      def get_multi_document_transaction_by_code_and_type(code, type, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
+        get(path, options, "22.2.0")      end
+
+      # Retrieve a MultiDocument transaction by ID
+      #
       # Get the unique MultiDocument transaction identified by this URL.
       #
       # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -221,15 +226,16 @@ 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:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
       # @param include [String] Specifies objects to include in the response after transaction is created
-      # @return [Object]
-      def get_multi_document_transaction_by_id(id, options={})        path = "/api/v2/transactions/multidocument/#{id}"
-        get(path, options)      end
-
-      # Retrieve all MultiDocument transactions
-      #
+      # @return [Object]
+      def get_multi_document_transaction_by_id(id, options={})        path = "/api/v2/transactions/multidocument/#{id}"
+        get(path, options, "22.2.0")      end
+
+      # Retrieve all MultiDocument transactions
+      #
       # List all MultiDocument transactions within this account.
       #
       # This endpoint is limited to returning 1,000 MultiDocument transactions at a time. To retrieve more than 1,000 MultiDocument
@@ -261,18 +267,19 @@ 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:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @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:* documents
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @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_multi_document_transactions(options={})        path = "/api/v2/transactions/multidocument"
-        get(path, options)      end
-
-      # Create a refund for a MultiDocument transaction
-      #
+      # @return [FetchResult]
+      def list_multi_document_transactions(options={})        path = "/api/v2/transactions/multidocument"
+        get(path, options, "22.2.0")      end
+
+      # Create a refund for a MultiDocument transaction
+      #
       # Create a refund for a MultiDocument transaction.
       #
       # A traditional transaction requires exactly two parties: a seller and a buyer. MultiDocument transactions can
@@ -321,17 +328,18 @@ 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:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param code [String] The code of this MultiDocument transaction
       # @param type [String] The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)
       # @param include [String] Specifies objects to include in the response after transaction is created
       # @param model [Object] Information about the refund to create
-      # @return [Object]
-      def refund_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
-        post(path, model, options)      end
-
-      # Verify a MultiDocument transaction
-      #
+      # @return [Object]
+      def refund_multi_document_transaction(code, type, model, options={})        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
+        post(path, model, options, "22.2.0")      end
+
+      # Verify a MultiDocument transaction
+      #
       # Verifies that the MultiDocument transaction uniquely identified by this URL matches certain expected values.
       #
       # If the transaction does not match these expected values, this API will return an error code indicating which value did not match.
@@ -350,14 +358,15 @@ 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:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
-      # @return [Object]
-      def verify_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/verify"
-        post(path, model)      end
-
-      # Void a MultiDocument transaction
-      #
+      # @return [Object]
+      def verify_multi_document_transaction(model)        path = "/api/v2/transactions/multidocument/verify"
+        post(path, model, {}, "22.2.0")      end
+
+      # Void a MultiDocument transaction
+      #
       # Voids the current transaction uniquely identified by this URL.
       #
       # A transaction represents a unique potentially taxable action that your company has recorded, and transactions include actions like
@@ -379,13 +388,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # * This API depends on the following active services:*Required* (all): AvaTaxPro.
+      # Swagger Name: AvaTaxClient	  
       # @param code [String] The transaction code for this MultiDocument transaction
       # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
       # @param model [Object] The void request you wish to execute
-      # @return [Object]
-      def void_multi_document_transaction(code, type, model)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
-        post(path, model)      end
-    end
-  end
+      # @return [Object]
+      def void_multi_document_transaction(code, type, model)        path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
+        post(path, model, {}, "22.2.0")      end
+    end
+  end
 end