avatax 20.9.0 → 21.10.0

data/lib/avatax/client/notifications.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Notifications 
-
-
-      # Mark a single notification as dismissed.
-      #
+module AvaTax
+  class Client
+    module Notifications 
+
+
+      # Mark a single notification as dismissed.
+      #
       # Marks the notification identified by this URL as dismissed.
       #
       # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -22,14 +22,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 id [Integer] The id of the notification you wish to mark as dismissed.
-      # @return [Object]
-      def dismiss_notification(id)        path = "/api/v2/notifications/#{id}/dismiss"
-        put(path)      end
-
-      # Retrieve a single notification.
-      #
+      # @return [Object]
+      def dismiss_notification(id)        path = "/api/v2/notifications/#{id}/dismiss"
+        put(path)      end
+
+      # Retrieve a single notification.
+      #
       # Retrieve a single notification by its unique ID number.
       #
       # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -41,14 +41,14 @@ 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 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 id [Integer] The id of the notification to retrieve.
-      # @return [Object]
-      def get_notification(id)        path = "/api/v2/notifications/#{id}"
-        get(path)      end
-
-      # List all notifications.
-      #
+      # @return [Object]
+      def get_notification(id)        path = "/api/v2/notifications/#{id}"
+        get(path)      end
+
+      # List all notifications.
+      #
       # List all notifications.
       #
       # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -63,14 +63,14 @@ 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 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 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 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_notifications(options={})        path = "/api/v2/notifications"
-        get(path, options)      end
-    end
-  end
+      # @return [FetchResult]
+      def list_notifications(options={})        path = "/api/v2/notifications"
+        get(path, options)      end
+    end
+  end
 end

data/lib/avatax/client/provisioning.rb

@@ -1,10 +1,10 @@
-module AvaTax
-  class Client
-    module Provisioning 
-
-
-      # Request a new Avalara account
-      #
+module AvaTax
+  class Client
+    module Provisioning 
+
+
+      # Request a new Avalara account
+      #
       # This API is for use by partner provisioning services customers only.
       #
       # Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
@@ -24,14 +24,14 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API is available by invitation only.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
+      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
       # @param model [Object] Information about the account you wish to create and the selected product offerings.
-      # @return [Object]
-      def request_new_account(model)        path = "/api/v2/accounts/request"
-        post(path, model)      end
-
-      # Request a new entitilement to an existing customer
-      #
+      # @return [Object]
+      def request_new_account(model)        path = "/api/v2/accounts/request"
+        post(path, model)      end
+
+      # Request a new entitilement to an existing customer
+      #
       # This API is for use by partner provisioning services customers only. This will allow the partners to allow
       # the add new entitlement to an existing customer
       #
@@ -39,12 +39,12 @@ module AvaTax
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
       # * This API is available by invitation only.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
+      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
       # @param id [Integer] The avatax account id of the customer
       # @param offer [String] The offer to be added to an already existing customer
-      # @return [Object]
-      def request_new_entitlement(id, offer)        path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
-        post(path)      end
-    end
-  end
+      # @return [Object]
+      def request_new_entitlement(id, offer)        path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
+        post(path)      end
+    end
+  end
 end

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
@@ -60,17 +60,26 @@ module AvaTax
       #
       # The `ExportDocumentLine` report produces information about invoice lines recorded within your account.
       #
+      # To split large reports into multiple smaller partitions, use the numberOfPartitions and partition properties on ExportDocumentLineModel.
+      #
+      # Example - split a report into three partitions
+      #
+      # * Follow the steps above with numberOfPartitions = 3 and partition = 0
+      # * Follow the steps above with numberOfPartitions = 3 and partition = 1
+      # * Follow the steps above with numberOfPartitions = 3 and partition = 2
+      # * Once all three reports are downloaded merge the files on the client side.
+      #
       # ### 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
@@ -85,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