avatax 21.10.0 → 21.12.0

data/lib/avatax/client/distancethresholds.rb

@@ -14,11 +14,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
       # @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
       # @return [CompanyDistanceThresholdModel[]]
       def create_distance_threshold(companyId, model)        path = "/api/v2/companies/#{companyId}/distancethresholds"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
 
       # Delete a single DistanceThreshold object
       #
@@ -31,11 +32,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
       # @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
       # @return [ErrorDetail[]]
       def delete_distance_threshold(companyId, id)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
-        delete(path)      end
+        delete(path, {}, "21.12.0")      end
 
       # Retrieve a single DistanceThreshold
       #
@@ -48,11 +50,12 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns this DistanceThreshold object
       # @param id [Integer] The unique ID number referring to this DistanceThreshold object
       # @return [Object]
       def get_distance_threshold(companyId, id)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
-        get(path)      end
+        get(path, {}, "21.12.0")      end
 
       # Retrieve all DistanceThresholds for this company.
       #
@@ -65,6 +68,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company whose DistanceThreshold objects you wish to list.
       # @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/).
       # @param include [String] A comma separated list of additional data to retrieve.
@@ -73,7 +77,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def list_distance_thresholds(companyId, options={})        path = "/api/v2/companies/#{companyId}/distancethresholds"
-        get(path, options)      end
+        get(path, options, "21.12.0")      end
 
       # Retrieve all DistanceThreshold objects
       #
@@ -89,6 +93,7 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, 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/).
       # @param include [String] A comma separated list of additional data to retrieve.
       # @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.
@@ -96,7 +101,7 @@ module AvaTax
       # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
       # @return [FetchResult]
       def query_distance_thresholds(options={})        path = "/api/v2/distancethresholds"
-        get(path, options)      end
+        get(path, options, "21.12.0")      end
 
       # Update a DistanceThreshold object
       #
@@ -112,12 +117,13 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold object.
       # @param id [Integer] The unique ID number of the DistanceThreshold object to replace.
       # @param model [Object] The new DistanceThreshold object to store.
       # @return [Object]
       def update_distance_threshold(companyId, id, model)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
-        put(path, model)      end
+        put(path, model, {}, "21.12.0")      end
     end
   end
 end

data/lib/avatax/client/ecommercetoken.rb

@@ -12,11 +12,12 @@ 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.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The company ID that will be issued this certificate.
       # @param model [Object] 
       # @return [Object]
       def create_e_commerce_token(companyId, model)        path = "/api/v2/companies/#{companyId}/ecommercetokens"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
 
       # Refresh an eCommerce token.
       #
@@ -27,11 +28,12 @@ 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.
+      # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
       # @param model [Object] 
       # @return [FetchResult]
       def refresh_e_commerce_token(companyId, model)        path = "/api/v2/companies/#{companyId}/ecommercetokens"
-        put(path, model)      end
+        put(path, model, {}, "21.12.0")      end
     end
   end
 end

data/lib/avatax/client/filingcalendars.rb

@@ -13,11 +13,12 @@ module AvaTax
       #
       # * This API requires openId bearer token for authentication
       # * 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 unique ID of the company that owns the filing calendar object
       # @param model [Object] Cycle Safe Options Request
       # @return [Object]
       def cycle_safe_options(companyId, model)        path = "/api/v2/companies/#{companyId}/filingcalendars/edit/cycleSafeOptions"
-        post(path, model)      end
+        post(path, model, {}, "21.12.0")      end
 
       # Delete a company return setting
       #
@@ -27,12 +28,13 @@ module AvaTax
       #
       # * 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 unique ID of the company
       # @param filingCalendarId [Integer] The unique ID of the filing calendar that will remove setting
       # @param companyReturnSettingId [Integer] The unique ID of the company return setting that will be deleted from the filing calendar
       # @return [CompanyReturnSettingModel[]]
       def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId)        path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
-        delete(path)      end
+        delete(path, {}, "21.12.0")      end
 
       # Retrieve all legacy filing calendars for this company
       #
@@ -42,8 +44,9 @@ 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.
       # * 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 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:* taxAuthorityId, taxAuthorityName, taxAuthorityType, settings
+      # @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:* taxTypes, taxAuthorityId, taxAuthorityName, taxAuthorityType, settings
       # @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`.
@@ -51,7 +54,7 @@ module AvaTax
       # @param returnRegion [String] A comma separated list of regions
       # @return [FetchResult]
       def legacy_filing_calendars(companyId, options={})        path = "/api/v2/companies/#{companyId}/filingcalendars/Legacy"
-        get(path, options)      end
+        get(path, options, "21.12.0")      end
     end
   end
 end

data/lib/avatax/client/filings.rb

@@ -9,11 +9,12 @@ module AvaTax
       #
       # * 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
+        get(path, {}, "21.12.0")      end
 
       # Retrieve a list of filed returns for the specified company in the year and month of a given filing period.
       #
@@ -23,6 +24,7 @@ module AvaTax
       # * 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.
+      # 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
@@ -34,7 +36,7 @@ module AvaTax
       # @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
+        get(path, options, "21.12.0")      end
     end
   end
 end

data/lib/avatax/client/firmclientlinkages.rb

@@ -10,10 +10,11 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        post(path, {}, "21.12.0")      end
 
       # Request a new FirmClient account and create an approved linkage to it
       #
@@ -31,10 +32,11 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        post(path, model, {}, "21.12.0")      end
 
       # Links a firm account with the client account
       #
@@ -43,10 +45,11 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        post(path, model, {}, "21.12.0")      end
 
       # Delete a linkage
       #
@@ -55,10 +58,11 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        delete(path, {}, "21.12.0")      end
 
       # Get linkage between a firm and client by id
       #
@@ -67,10 +71,11 @@ 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.
+      # Swagger Name: AvaTaxClient	  
       # @param id [Integer] 
       # @return [Object]
       def get_firm_client_linkage(id)        path = "/api/v2/firmclientlinkages/#{id}"
-        get(path)      end
+        get(path, {}, "21.12.0")      end
 
       # List client linkages for a firm or client
       #
@@ -79,10 +84,11 @@ 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.
+      # 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
+        get(path, options, "21.12.0")      end
 
       # Rejects linkage to a firm for a client account
       #
@@ -91,10 +97,11 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        post(path, {}, "21.12.0")      end
 
       # Reset linkage status between a client and firm back to requested
       #
@@ -103,10 +110,11 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        post(path, {}, "21.12.0")      end
 
       # Revokes previously approved linkage to a firm for a client account
       #
@@ -115,10 +123,11 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        post(path, {}, "21.12.0")      end
     end
   end
 end

data/lib/avatax/client/free.rb

@@ -19,10 +19,11 @@ module AvaTax
       # ### Security Policies
       #
       # * 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
+        post(path, model, {}, "21.12.0")      end
     end
   end
 end

data/lib/avatax/client/fundingrequests.rb

@@ -22,10 +22,11 @@ module AvaTax
       #
       # * 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.
+      # 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
+        get(path, {}, "21.12.0")      end
 
       # Retrieve status about a funding setup request
       #
@@ -44,10 +45,11 @@ module AvaTax
       #
       # * 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.
+      # 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
+        get(path, {}, "21.12.0")      end
     end
   end
 end