avatax 21.3.1 → 21.9.0

data/lib/avatax/client/registrar.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Registrar 
-
-
-      # Create a new account
-      #
+module AvaTax
+  class Client
+    module Registrar 
+
+
+      # Create a new account
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
       #
@@ -13,14 +13,14 @@ module AvaTax
       #
       # ### 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.
       # @param model [Object] The account you wish to create.
-      # @return [AccountModel[]]
-      def create_account(model)        path = "/api/v2/accounts"
-        post(path, model)      end
-
-      # Create new notifications.
-      #
+      # @return [AccountModel[]]
+      def create_account(model)        path = "/api/v2/accounts"
+        post(path, model)      end
+
+      # Create new notifications.
+      #
       # This API is available by invitation only.
       #
       # Create a single notification.
@@ -38,14 +38,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
+      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
       # @param model [NotificationModel[]] The notifications you wish to create.
-      # @return [NotificationModel[]]
-      def create_notifications(model)        path = "/api/v2/notifications"
-        post(path, model)      end
-
-      # Create a new subscription
-      #
+      # @return [NotificationModel[]]
+      def create_notifications(model)        path = "/api/v2/notifications"
+        post(path, model)      end
+
+      # Create a new subscription
+      #
       # This API is for use by Avalara Registrar administrative users only.
       #
       # Create one or more new subscription objects attached to this account.
@@ -54,15 +54,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param accountId [Integer] The ID of the account that owns this subscription.
       # @param model [SubscriptionModel[]] The subscription you wish to create.
-      # @return [SubscriptionModel[]]
-      def create_subscriptions(accountId, model)        path = "/api/v2/accounts/#{accountId}/subscriptions"
-        post(path, model)      end
-
-      # Delete a single account
-      #
+      # @return [SubscriptionModel[]]
+      def create_subscriptions(accountId, model)        path = "/api/v2/accounts/#{accountId}/subscriptions"
+        post(path, model)      end
+
+      # Delete a single account
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
       #
@@ -71,14 +71,14 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires the user role SystemAdmin.
+      # * This API requires the user role SystemAdmin.
       # @param id [Integer] The ID of the account you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_account(id)        path = "/api/v2/accounts/#{id}"
-        delete(path)      end
-
-      # Delete a single notification.
-      #
+      # @return [ErrorDetail[]]
+      def delete_account(id)        path = "/api/v2/accounts/#{id}"
+        delete(path)      end
+
+      # Delete a single notification.
+      #
       # This API is available by invitation only.
       #
       # Delete the existing notification identified by this URL.
@@ -93,14 +93,14 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
+      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
       # @param id [Integer] The id of the notification you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_notification(id)        path = "/api/v2/notifications/#{id}"
-        delete(path)      end
-
-      # Delete a single subscription
-      #
+      # @return [ErrorDetail[]]
+      def delete_notification(id)        path = "/api/v2/notifications/#{id}"
+        delete(path)      end
+
+      # Delete a single subscription
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
       #
@@ -108,15 +108,25 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param accountId [Integer] The ID of the account that owns this subscription.
       # @param id [Integer] The ID of the subscription you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
-        delete(path)      end
-
-      # Reset a user's password programmatically
+      # @return [ErrorDetail[]]
+      def delete_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
+        delete(path)      end
+
+      # Retrieve List of Accounts by Account Migration Status
+      #
+      # ### Security Policies
       #
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param writeMode [String]  (See TssAccountMigrationId::* for a list of allowable values)
+      # @return [Object]
+      def list_accounts_by_tss_write_mode(writeMode)        path = "/api/v2/accounts/ListAccountsByTssWriteMode/#{writeMode}"
+        get(path)      end
+
+      # Reset a user's password programmatically
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
       #
@@ -127,16 +137,16 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
-      # * This API is available to Avalara system-level (registrar-level) users only.
+      # * This API is available to Avalara system-level (registrar-level) users only.
       # @param userId [Integer] The unique ID of the user whose password will be changed
       # @param unmigrateFromAi [Boolean] If user's password was migrated to AI, undo this.
       # @param model [Object] The new password for this user
-      # @return [String]
-      def reset_password(userId, model, options={})        path = "/api/v2/passwords/#{userId}/reset"
-        post(path, model, options)      end
-
-      # Update a single account
-      #
+      # @return [String]
+      def reset_password(userId, model, options={})        path = "/api/v2/passwords/#{userId}/reset"
+        post(path, model, options)      end
+
+      # Update a single account
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
       #
@@ -144,15 +154,15 @@ module AvaTax
       #
       # ### 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.
       # @param id [Integer] The ID of the account you wish to update.
       # @param model [Object] The account object you wish to update.
-      # @return [Object]
-      def update_account(id, model)        path = "/api/v2/accounts/#{id}"
-        put(path, model)      end
-
-      # Update a single notification.
-      #
+      # @return [Object]
+      def update_account(id, model)        path = "/api/v2/accounts/#{id}"
+        put(path, model)      end
+
+      # Update a single notification.
+      #
       # This API is available by invitation only.
       #
       # Replaces the notification identified by this URL with a new notification.
@@ -167,15 +177,15 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
+      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
       # @param id [Integer] The id of the notification you wish to update.
       # @param model [Object] The notification object you wish to update.
-      # @return [Object]
-      def update_notification(id, model)        path = "/api/v2/notifications/#{id}"
-        put(path, model)      end
-
-      # Update a single subscription
-      #
+      # @return [Object]
+      def update_notification(id, model)        path = "/api/v2/notifications/#{id}"
+        put(path, model)      end
+
+      # Update a single subscription
+      #
       # # For Registrar Use Only
       # This API is for use by Avalara Registrar administrative users only.
       #
@@ -187,13 +197,13 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param accountId [Integer] The ID of the account that this subscription belongs to.
       # @param id [Integer] The ID of the subscription you wish to update
       # @param model [Object] The subscription you wish to update.
-      # @return [Object]
-      def update_subscription(accountId, id, model)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_subscription(accountId, id, model)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
+        put(path, model)      end
+    end
+  end
 end

data/lib/avatax/client/reports.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Reports 
-
-
-      # Download a report
-      #
+module AvaTax
+  class Client
+    module Reports 
+
+
+      # Download a report
+      #
       # This API downloads the file associated with a report.
       #
       # If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete,
@@ -18,18 +18,18 @@ module AvaTax
       # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
       # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
       #
-      # This API works for all report types.
+      # * We throttle this API. You can only call this API up to 5 times in a minute.
       #
       # ### 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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param id [Integer] The unique ID number of this report
-      # @return [Object]
-      def download_report(id)        path = "/api/v2/reports/#{id}/attachment"
-        get(path)      end
-
-      # Retrieve a single report
-      #
+      # @return [Object]
+      def download_report(id)        path = "/api/v2/reports/#{id}/attachment"
+        get(path)      end
+
+      # Retrieve a single report
+      #
       # Retrieve a single report by its unique ID number.
       #
       # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
@@ -40,14 +40,14 @@ module AvaTax
       # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
       # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
       #
-      # This API call returns information about any report type.
+      # This API call returns information about any report type.
       # @param id [Integer] The unique ID number of the report to retrieve
-      # @return [Object]
-      def get_report(id)        path = "/api/v2/reports/#{id}"
-        get(path)      end
-
-      # Initiate an ExportDocumentLine report task
-      #
+      # @return [Object]
+      def get_report(id)        path = "/api/v2/reports/#{id}"
+        get(path)      end
+
+      # Initiate an ExportDocumentLine report task
+      #
       # Begins running an `ExportDocumentLine` report task and returns the identity of the report.
       #
       # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
@@ -71,15 +71,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The unique ID number of the company to report on.
       # @param model [Object] Options that may be configured to customize the report.
-      # @return [ReportModel[]]
-      def initiate_export_document_line_report(companyId, model)        path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
-        post(path, model)      end
-
-      # List all report tasks for account
-      #
+      # @return [ReportModel[]]
+      def initiate_export_document_line_report(companyId, model)        path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
+        post(path, model)      end
+
+      # List all report tasks for account
+      #
       # List all report tasks for your account.
       #
       # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
@@ -94,14 +94,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 requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The id of the company for which to get reports.
       # @param pageKey [String] Provide a page key to retrieve the next page of results.
       # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
       # @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.
-      # @return [FetchResult]
-      def list_reports(options={})        path = "/api/v2/reports"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def list_reports(options={})        path = "/api/v2/reports"
+        get(path, options)      end
+    end
+  end
 end

data/lib/avatax/client/settings.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Settings 
-
-
-      # Create a new setting
-      #
+module AvaTax
+  class Client
+    module Settings 
+
+
+      # Create a new setting
+      #
       # Create one or more new setting objects attached to this company.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -16,17 +16,22 @@ module AvaTax
       # When creating this object, you may define your own `set`, `name`, and `value` parameters.
       # To define your own values, please choose a `set` name that begins with `X-` to indicate an extension.
       #
+      # Use Set = Transactions, Name = TaxCodePrioritization/HSCodePrioritization and Value = Transaction/ItemMaster for prioritizing which TaxCodes/HsCodes should be used for calculating taxes.
+      #
+      # Example: To prioritize TaxCodes passed in a Transaction over values stored with Items when calculating tax, use
+      # Set = Transactions, Name = TaxCodePrioritization, Value = Transaction
+      #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this setting.
       # @param model [SettingModel[]] The setting you wish to create.
-      # @return [SettingModel[]]
-      def create_settings(companyId, model)        path = "/api/v2/companies/#{companyId}/settings"
-        post(path, model)      end
-
-      # Delete a single setting
-      #
+      # @return [SettingModel[]]
+      def create_settings(companyId, model)        path = "/api/v2/companies/#{companyId}/settings"
+        post(path, model)      end
+
+      # Delete a single setting
+      #
       # Mark the setting object at this URL as deleted.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -40,15 +45,15 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that owns this setting.
       # @param id [Integer] The ID of the setting you wish to delete.
-      # @return [ErrorDetail[]]
-      def delete_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        delete(path)      end
-
-      # Retrieve a single setting
-      #
+      # @return [ErrorDetail[]]
+      def delete_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        delete(path)      end
+
+      # Retrieve a single setting
+      #
       # Get a single setting object by its unique ID.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -62,15 +67,15 @@ 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, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns this setting
       # @param id [Integer] The primary key of this setting
-      # @return [Object]
-      def get_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        get(path)      end
-
-      # Retrieve all settings for this company
-      #
+      # @return [Object]
+      def get_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        get(path)      end
+
+      # Retrieve all settings for this company
+      #
       # List all setting objects attached to this company.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -87,19 +92,19 @@ 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, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param companyId [Integer] The ID of the company that owns these 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/).
+      # @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:* modifiedDate, ModifiedUserId
       # @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_settings_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/settings"
-        get(path, options)      end
-
-      # Retrieve all settings
-      #
+      # @return [FetchResult]
+      def list_settings_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/settings"
+        get(path, options)      end
+
+      # Retrieve all settings
+      #
       # Get multiple setting objects across all companies.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -116,18 +121,18 @@ 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, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
-      # @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/).
+      # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
+      # @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:* modifiedDate, ModifiedUserId
       # @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_settings(options={})        path = "/api/v2/settings"
-        get(path, options)      end
-
-      # Update a single setting
-      #
+      # @return [FetchResult]
+      def query_settings(options={})        path = "/api/v2/settings"
+        get(path, options)      end
+
+      # Update a single setting
+      #
       # Replace the existing setting object at this URL with an updated object.
       #
       # The company settings system is a metadata system that you can use to store extra information
@@ -145,13 +150,13 @@ module AvaTax
       #
       # ### Security Policies
       #
-      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # @param companyId [Integer] The ID of the company that this setting belongs to.
       # @param id [Integer] The ID of the setting you wish to update
       # @param model [Object] The setting you wish to update.
-      # @return [Object]
-      def update_setting(companyId, id, model)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
-        put(path, model)      end
-    end
-  end
+      # @return [Object]
+      def update_setting(companyId, id, model)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        put(path, model)      end
+    end
+  end
 end

data/lib/avatax/client/subscriptions.rb

@@ -1,25 +1,25 @@
-module AvaTax
-  class Client
-    module Subscriptions 
-
-
-      # Retrieve a single subscription
-      #
+module AvaTax
+  class Client
+    module Subscriptions 
+
+
+      # Retrieve a single subscription
+      #
       # Get the subscription object identified by this URL.
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
       #
       # ### 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.
       # @param accountId [Integer] The ID of the account that owns this subscription
       # @param id [Integer] The primary key of this subscription
-      # @return [Object]
-      def get_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
-        get(path)      end
-
-      # Retrieve subscriptions for this account
-      #
+      # @return [Object]
+      def get_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
+        get(path)      end
+
+      # Retrieve subscriptions for this account
+      #
       # List all subscription objects attached to this account.
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
@@ -29,18 +29,18 @@ 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.
+      # * 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.
       # @param accountId [Integer] The ID of the account that owns these subscriptions
       # @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:* subscriptionDescription
       # @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_subscriptions_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/subscriptions"
-        get(path, options)      end
-
-      # Retrieve all subscriptions
-      #
+      # @return [FetchResult]
+      def list_subscriptions_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/subscriptions"
+        get(path, options)      end
+
+      # Retrieve all subscriptions
+      #
       # Get multiple subscription objects across all accounts.
       # A 'subscription' indicates a licensed subscription to a named Avalara service.
       # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
@@ -50,14 +50,14 @@ 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.
+      # * 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.
       # @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:* subscriptionDescription
       # @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_subscriptions(options={})        path = "/api/v2/subscriptions"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def query_subscriptions(options={})        path = "/api/v2/subscriptions"
+        get(path, options)      end
+    end
+  end
 end