avatax 20.9.0 → 21.10.0

data/lib/avatax/client/distancethresholds.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module DistanceThresholds 
-
-
-      # Create one or more DistanceThreshold objects
-      #
+module AvaTax
+  class Client
+    module DistanceThresholds 
+
+
+      # Create one or more DistanceThreshold objects
+      #
       # Create one or more DistanceThreshold objects for this company.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -13,15 +13,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @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
-
-      # Delete a single DistanceThreshold object
-      #
+      # @return [CompanyDistanceThresholdModel[]]
+      def create_distance_threshold(companyId, model)        path = "/api/v2/companies/#{companyId}/distancethresholds"
+        post(path, model)      end
+
+      # Delete a single DistanceThreshold object
+      #
       # Marks the DistanceThreshold object identified by this URL as deleted.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -30,15 +30,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @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
-
-      # Retrieve a single DistanceThreshold
-      #
+      # @return [ErrorDetail[]]
+      def delete_distance_threshold(companyId, id)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
+        delete(path)      end
+
+      # Retrieve a single DistanceThreshold
+      #
       # Retrieves a single DistanceThreshold object defined by this URL.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -47,15 +47,15 @@ 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.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @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
-
-      # Retrieve all DistanceThresholds for this company.
-      #
+      # @return [Object]
+      def get_distance_threshold(companyId, id)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
+        get(path)      end
+
+      # Retrieve all DistanceThresholds for this company.
+      #
       # Lists all DistanceThreshold objects that belong to this company.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -64,19 +64,19 @@ 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.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @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.
       # @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_distance_thresholds(companyId, options={})        path = "/api/v2/companies/#{companyId}/distancethresholds"
-        get(path, options)      end
-
-      # Retrieve all DistanceThreshold objects
-      #
+      # @return [FetchResult]
+      def list_distance_thresholds(companyId, options={})        path = "/api/v2/companies/#{companyId}/distancethresholds"
+        get(path, options)      end
+
+      # Retrieve all DistanceThreshold objects
+      #
       # Lists all DistanceThreshold objects that belong to this account.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -88,18 +88,18 @@ 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.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @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.
       # @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_distance_thresholds(options={})        path = "/api/v2/distancethresholds"
-        get(path, options)      end
-
-      # Update a DistanceThreshold object
-      #
+      # @return [FetchResult]
+      def query_distance_thresholds(options={})        path = "/api/v2/distancethresholds"
+        get(path, options)      end
+
+      # Update a DistanceThreshold object
+      #
       # Replace the existing DistanceThreshold object at this URL with an updated object.
       #
       # A company-distance-threshold model indicates the distance between a company
@@ -111,13 +111,13 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @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
-    end
-  end
+      # @return [Object]
+      def update_distance_threshold(companyId, id, model)        path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
+        put(path, model)      end
+    end
+  end
 end

data/lib/avatax/client/ecms.rb

@@ -1,17 +1,6 @@
 module AvaTax
   class Client
-    module ECMS 
-
-
-      # Bridge API for integration of validated certificates
-      #
-      # This API is for use by invitation only.
-      # @param model [EcmsModel[]] Either a single exempt certificate or an array of certificates to create
-      # @return [EcmsModel[]]
-      def cert_capture_bridge(model)
-        path = "/api/v2/certcapturebridge"
-        post(path, model)
-      end
+    module Ecms 
 
 
       # Get an ECMS identified by company id and ECMS id
@@ -22,15 +11,17 @@ module AvaTax
       # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
       #
       # * Details
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services<br />*Required* (all): AvaCert.
       # @param companyId [Integer] company to retrieve exempt certificate for
       # @param ecmsId [Integer] exempt certificate Id
       # @param include [String] 
       # @return [Object]
-      def get_e_c_m_s_by_id(companyId, ecmsId, options={})
-        path = "/api/v2/companies/#{companyId}/ecms/#{ecmsId}"
-        get(path, options)
-      end
-
+      def get_e_c_m_s_by_id(companyId, ecmsId, options={})        path = "/api/v2/companies/#{companyId}/ecms/#{ecmsId}"
+        get(path, options)      end
 
       # Get list of ECMS data for this company
       #
@@ -40,18 +31,20 @@ module AvaTax
       # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
       #
       # * Details
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services<br />*Required* (all): AvaCert.
       # @param companyId [Integer] which company to retrieve certificates from
-      # @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 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:* details
       # @param include [String] 
       # @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 [EcmsModel[]]
-      def list_e_c_m_s_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/ecms"
-        get(path, options)
-      end
-
+      # @return [FetchResult]
+      def list_e_c_m_s_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/ecms"
+        get(path, options)      end
 
       # Get all exempt certificates
       #
@@ -63,17 +56,19 @@ module AvaTax
       # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
       #
       # * Details
-      # @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/).
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API depends on the following active services<br />*Required* (all): AvaCert.
+      # @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:* details
       # @param include [String] 
       # @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 [EcmsModel[]]
-      def query_e_c_m_s(options={})
-        path = "/api/v2/ecms"
-        get(path, options)
-      end
-
+      # @return [FetchResult]
+      def query_e_c_m_s(options={})        path = "/api/v2/ecms"
+        get(path, options)      end
     end
   end
 end

data/lib/avatax/client/ecommercetoken.rb

@@ -5,30 +5,30 @@ module AvaTax
 
       # Create a new eCommerce token.
       #
-      # Creates a new eCommerce token.
-      #
-      # This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
-      #
-      # ### Security Policies
-      #
+      # Creates a new eCommerce token.
+      #
+      # This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
+      #
+      # ### 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.
-      # @param companyId [Integer] The company ID that will be issued this certificate.
-      # @param model [Object] 
-      # @return [FetchResult]
+      # @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
 
       # Refresh an eCommerce token.
       #
-      # Refresh an eCommerce token.
-      #
-      # CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.
-      #
-      # ### Security Policies
-      #
+      # Refresh an eCommerce token.
+      #
+      # CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.
+      #
+      # ### 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.
-      # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
-      # @param model [Object] 
+      # @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

data/lib/avatax/client/errortransactions.rb

@@ -12,20 +12,35 @@ 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 companyId [Integer] ID number of the company to delete error transactions from.
       # @param model [Object] The request that contains error transactions to be deleted
       # @return [Object]
-      def delete_error_transactions(model)
-        path = "/api/v2/errortransactions"
-        delete(path, model)
-      end
+      def delete_error_transactions(companyId, model)        path = "/api/v2/companies/#{companyId}/errortransactions"
+        delete(path, model)      end
 
+      # Get a list of error transactions' error codes and its counts
+      #
+      # Get a list of error transactions' error codes and their counts
+      # When you try to create or adjust a transaction with a datasource for a company and for any reason that call fails with an error,
+      # those errors with their count can be retrieved by this API.
+      #
+      # ### 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, BasicReturns.
+      # @param companyId [Integer] ID number of the company to query from.
+      # @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 [CappedFetchResult]
+      def list_error_codes(companyId, options={})        path = "/api/v2/companies/#{companyId}/errortransactions/errorcodes"
+        get(path, options)      end
 
       # Retrieve list of error transactions
       #
       # List error transactions attached to this company. Results are dependent on `$filter` if provided.
       #
-      # This endpoint is limited to returning 250 error transactions at a time maximum.
+      # This endpoint is limited to returning 1000 error transactions at a time maximum.
       #
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
@@ -33,18 +48,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<br />*Required* (all): AvaTaxPro.
-      # @param companyCode [String] The company code to filter on. This query parameter is required.
-      # @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:* companyId, avataxErrorJson, avataxCreateTransactionJson
+      # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
+      # @param companyId [Integer] The company ID to filter error transactions on.
+      # @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:* companyId, avataxErrorJson, avataxCreateTransactionJson, expiresAt
       # @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_error_transactions(options={})
-        path = "/api/v2/errortransactions"
-        get(path, options)
-      end
-
+      # @return [CappedFetchResult]
+      def list_error_transactions(companyId, options={})        path = "/api/v2/companies/#{companyId}/errortransactions"
+        get(path, options)      end
     end
   end
 end

data/lib/avatax/client/filingcalendars.rb

@@ -1,21 +1,57 @@
-module AvaTax
-  class Client
-    module FilingCalendars 
-
-
-      # Delete a company return setting
+module AvaTax
+  class Client
+    module FilingCalendars 
+
+
+      # Add or Edit options
+      #
+      # Returns a list of options for adding tax forms for the company and tax form code specified.
+      # Returns edit options when modifying a filing calendar.
+      # This API is available by invitation only.
       #
+      # ### Security Policies
+      #
+      # * 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.
+      # @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
+
+      # Delete a company return setting
+      #
       # This API is available by invitation only and only available for users with Compliance access
       #
       # ### 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.
       # @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
-    end
-  end
+      # @return [CompanyReturnSettingModel[]]
+      def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId)        path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
+        delete(path)      end
+
+      # Retrieve all legacy filing calendars for this company
+      #
+      # This API is available by invitation only.
+      #
+      # ### 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 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 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 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`.
+      # @param returnCountry [String] A comma separated list of countries
+      # @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
+    end
+  end
 end

data/lib/avatax/client/filings.rb

@@ -1,26 +1,28 @@
-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.
       # @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)      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.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser, CompanyUser, AccountUser, CompanyAdmin, AccountAdmin.
-      # * 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 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.
       # @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 +32,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)      end
+    end
+  end
 end