avatax 21.8.0 → 22.2.0

data/lib/avatax/client/filings.rb

@@ -1,26 +1,30 @@
-module AvaTax
-  class Client
-    module Filings 
-
-
-      # Retrieve a filing containing the return and all its accrual returns.
-      #
+module AvaTax
+  class Client
+    module Filings 
+
+
+      # Retrieve a filing containing the return and all its accrual returns.
+      #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # * This API requires openId bearer token for authentication
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns these returns
       # @param filingReturnId [Integer] The ID of the filing return
-      # @return [FetchResult]
-      def get_accrual_filings(companyId, filingReturnId)        path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
-        get(path)      end
-
-      # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
-      #
+      # @return [FetchResult]
+      def get_accrual_filings(companyId, filingReturnId)        path = "/api/v2/companies/#{companyId}/filings/accrual/#{filingReturnId}"
+        get(path, {}, "22.2.0")      end
+
+      # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
+      #
       # ### Security Policies
       #
+      # * This API requires openId bearer token for authentication
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # * This API is available by invitation only.*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin.
-      # * 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.
+      # * 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.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns these batches
       # @param endPeriodMonth [Integer] The month of the period you are trying to retrieve
       # @param endPeriodYear [Integer] The year of the period you are trying to retrieve
@@ -30,9 +34,9 @@ module AvaTax
       # @param region [String] The region of the return(s) you are trying to retrieve
       # @param filingCalendarId [Integer] The filing calendar id of the return you are trying to retrieve
       # @param taxformCode [String] The unique tax form code of the form.
-      # @return [FetchResult]
-      def get_filed_returns(companyId, options={})        path = "/api/v2/companies/#{companyId}/filings/returns/filed"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def get_filed_returns(companyId, options={})        path = "/api/v2/companies/#{companyId}/filings/returns/filed"
+        get(path, options, "22.2.0")      end
+    end
+  end
 end

data/lib/avatax/client/firmclientlinkages.rb

@@ -1,22 +1,23 @@
-module AvaTax
-  class Client
-    module FirmClientLinkages 
-
-
-      # Approves linkage to a firm for a client account
-      #
+module AvaTax
+  class Client
+    module FirmClientLinkages 
+
+
+      # Approves linkage to a firm for a client account
+      #
       # This API enables the account admin of a client account to approve linkage request by a firm.
       #
       # ### 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.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] 
-      # @return [Object]
-      def approve_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/approve"
-        post(path)      end
-
-      # Request a new FirmClient account and create an approved linkage to it
-      #
+      # @return [Object]
+      def approve_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/approve"
+        post(path, {}, "22.2.0")      end
+
+      # Request a new FirmClient account and create an approved linkage to it
+      #
       # This API is for use by Firms only.
       #
       # Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service.
@@ -30,95 +31,103 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] Information about the account you wish to create.
-      # @return [Object]
-      def create_and_link_new_firm_client_account(model)        path = "/api/v2/firmclientlinkages/createandlinkclient"
-        post(path, model)      end
-
-      # Links a firm account with the client account
-      #
+      # @return [Object]
+      def create_and_link_new_firm_client_account(model)        path = "/api/v2/firmclientlinkages/createandlinkclient"
+        post(path, model, {}, "22.2.0")      end
+
+      # Links a firm account with the client account
+      #
       # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] FirmClientLinkageInputModel
-      # @return [Object]
-      def create_firm_client_linkage(model)        path = "/api/v2/firmclientlinkages"
-        post(path, model)      end
-
-      # Delete a linkage
-      #
+      # @return [Object]
+      def create_firm_client_linkage(model)        path = "/api/v2/firmclientlinkages"
+        post(path, model, {}, "22.2.0")      end
+
+      # Delete a linkage
+      #
       # This API marks a linkage between a firm and client as deleted.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] 
-      # @return [ErrorDetail[]]
-      def delete_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
-        delete(path)      end
-
-      # Get linkage between a firm and client by id
-      #
+      # @return [ErrorDetail[]]
+      def delete_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
+        delete(path, {}, "22.2.0")      end
+
+      # Get linkage between a firm and client by id
+      #
       # This API enables the firm admins/firm users to request the linkage of a firm account and a client 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.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] 
-      # @return [Object]
-      def get_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
-        get(path)      end
-
-      # List client linkages for a firm or client
-      #
+      # @return [Object]
+      def get_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
+        get(path, {}, "22.2.0")      end
+
+      # List client linkages for a firm or client
+      #
       # This API enables the firm or account users to request the associated linkages to 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.
+      # 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:* firmAccountName, clientAccountName
-      # @return [FetchResult]
-      def list_firm_client_linkage(options={})        path = "/api/v2/firmclientlinkages"
-        get(path, options)      end
-
-      # Rejects linkage to a firm for a client account
-      #
+      # @return [FetchResult]
+      def list_firm_client_linkage(options={})        path = "/api/v2/firmclientlinkages"
+        get(path, options, "22.2.0")      end
+
+      # Rejects linkage to a firm for a client account
+      #
       # This API enables the account admin of a client account to reject linkage request by a firm.
       #
       # ### 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.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] 
-      # @return [Object]
-      def reject_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reject"
-        post(path)      end
-
-      # Reset linkage status between a client and firm back to requested
-      #
+      # @return [Object]
+      def reject_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reject"
+        post(path, {}, "22.2.0")      end
+
+      # Reset linkage status between a client and firm back to requested
+      #
       # This API enables the firm admin of a client account to reset a previously created linkage request by a firm.
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] 
-      # @return [Object]
-      def reset_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reset"
-        post(path)      end
-
-      # Revokes previously approved linkage to a firm for a client account
-      #
+      # @return [Object]
+      def reset_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/reset"
+        post(path, {}, "22.2.0")      end
+
+      # Revokes previously approved linkage to a firm for a client account
+      #
       # This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
       #
       # ### 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.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] 
-      # @return [Object]
-      def revoke_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/revoke"
-        post(path)      end
-    end
-  end
+      # @return [Object]
+      def revoke_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}/revoke"
+        post(path, {}, "22.2.0")      end
+    end
+  end
 end

data/lib/avatax/client/free.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Free 
-
-
-      # FREE API - Request a free trial of AvaTax
-      #
+module AvaTax
+  class Client
+    module Free 
+
+
+      # FREE API - Request a free trial of AvaTax
+      #
       # Call this API to obtain a free AvaTax account.
       #
       # This API is free to use. No authentication credentials are required to call this API. You must read and
@@ -18,11 +18,12 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API may be called without providing authentication credentials.
+      # * This API may be called without providing authentication credentials.
+      # Swagger Name: AvaTaxClient	  
       # @param model [Object] Required information to provision a free trial account.
-      # @return [Object]
-      def request_free_trial(model)        path = "/api/v2/accounts/freetrials/request"
-        post(path, model)      end
-    end
-  end
+      # @return [Object]
+      def request_free_trial(model)        path = "/api/v2/accounts/freetrials/request"
+        post(path, model, {}, "22.2.0")      end
+    end
+  end
 end

data/lib/avatax/client/fundingrequests.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module FundingRequests 
-
-
-      # Request the javascript for a funding setup widget
-      #
+module AvaTax
+  class Client
+    module FundingRequests 
+
+
+      # Request the javascript for a funding setup widget
+      #
       # This API is available by invitation only.
       # Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are
       # required to setup their funding configuration before Avalara can begin filing tax returns on their
@@ -21,14 +21,15 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * 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.
+      # * 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.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The unique ID number of this funding request
-      # @return [Object]
-      def activate_funding_request(id)        path = "/api/v2/fundingrequests/#{id}/widget"
-        get(path)      end
-
-      # Retrieve status about a funding setup request
-      #
+      # @return [Object]
+      def activate_funding_request(id)        path = "/api/v2/fundingrequests/#{id}/widget"
+        get(path, {}, "22.2.0")      end
+
+      # Retrieve status about a funding setup request
+      #
       # This API is available by invitation only.
       # Companies that use the Avalara Managed Returns or the SST Certified Service Provider services are
       # required to setup their funding configuration before Avalara can begin filing tax returns on their
@@ -43,11 +44,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * 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.
+      # * 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.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] The unique ID number of this funding request
-      # @return [Object]
-      def funding_request_status(id)        path = "/api/v2/fundingrequests/#{id}"
-        get(path)      end
-    end
-  end
+      # @return [Object]
+      def funding_request_status(id)        path = "/api/v2/fundingrequests/#{id}"
+        get(path, {}, "22.2.0")      end
+    end
+  end
 end