avatax 20.6.0 → 21.1.2

data/lib/avatax/client/notifications.rb

@@ -25,11 +25,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @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
-
+      def dismiss_notification(id)        path = "/api/v2/notifications/#{id}/dismiss"
+        put(path)      end
 
       # Retrieve a single notification.
       #
@@ -47,11 +44,8 @@ module AvaTax
       # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # @param id [Integer] The id of the notification to retrieve.
       # @return [Object]
-      def get_notification(id)
-        path = "/api/v2/notifications/#{id}"
-        get(path)
-      end
-
+      def get_notification(id)        path = "/api/v2/notifications/#{id}"
+        get(path)      end
 
       # List all notifications.
       #
@@ -75,11 +69,8 @@ module AvaTax
       # @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
-
+      def list_notifications(options={})        path = "/api/v2/notifications"
+        get(path, options)      end
     end
   end
 end

data/lib/avatax/client/provisioning.rb

@@ -27,11 +27,8 @@ module AvaTax
       # * 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
-
+      def request_new_account(model)        path = "/api/v2/accounts/request"
+        post(path, model)      end
 
       # Request a new entitilement to an existing customer
       #
@@ -46,11 +43,8 @@ module AvaTax
       # @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
-
+      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

@@ -16,11 +16,8 @@ module AvaTax
       # * 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
-
+      def create_account(model)        path = "/api/v2/accounts"
+        post(path, model)      end
 
       # Create new notifications.
       #
@@ -44,11 +41,8 @@ module AvaTax
       # * 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
-
+      def create_notifications(model)        path = "/api/v2/notifications"
+        post(path, model)      end
 
       # Create a new subscription
       #
@@ -64,11 +58,8 @@ module AvaTax
       # @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
-
+      def create_subscriptions(accountId, model)        path = "/api/v2/accounts/#{accountId}/subscriptions"
+        post(path, model)      end
 
       # Delete a single account
       #
@@ -83,11 +74,8 @@ module AvaTax
       # * 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
-
+      def delete_account(id)        path = "/api/v2/accounts/#{id}"
+        delete(path)      end
 
       # Delete a single notification.
       #
@@ -108,11 +96,8 @@ module AvaTax
       # * 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
-
+      def delete_notification(id)        path = "/api/v2/notifications/#{id}"
+        delete(path)      end
 
       # Delete a single subscription
       #
@@ -127,11 +112,8 @@ module AvaTax
       # @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
-
+      def delete_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
+        delete(path)      end
 
       # Reset a user's password programmatically
       #
@@ -150,11 +132,8 @@ module AvaTax
       # @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
-
+      def reset_password(userId, model, options={})        path = "/api/v2/passwords/#{userId}/reset"
+        post(path, model, options)      end
 
       # Update a single account
       #
@@ -169,11 +148,8 @@ module AvaTax
       # @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
-
+      def update_account(id, model)        path = "/api/v2/accounts/#{id}"
+        put(path, model)      end
 
       # Update a single notification.
       #
@@ -195,11 +171,8 @@ module AvaTax
       # @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
-
+      def update_notification(id, model)        path = "/api/v2/notifications/#{id}"
+        put(path, model)      end
 
       # Update a single subscription
       #
@@ -219,11 +192,8 @@ module AvaTax
       # @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
-
+      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

@@ -25,11 +25,8 @@ module AvaTax
       # * 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
-
+      def download_report(id)        path = "/api/v2/reports/#{id}/attachment"
+        get(path)      end
 
       # Retrieve a single report
       #
@@ -46,11 +43,8 @@ module AvaTax
       # 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
-
+      def get_report(id)        path = "/api/v2/reports/#{id}"
+        get(path)      end
 
       # Initiate an ExportDocumentLine report task
       #
@@ -66,17 +60,23 @@ 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.
       # @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
-
+      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
       #
@@ -100,11 +100,8 @@ module AvaTax
       # @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
-
+      def list_reports(options={})        path = "/api/v2/reports"
+        get(path, options)      end
     end
   end
 end

data/lib/avatax/client/settings.rb

@@ -22,11 +22,8 @@ module AvaTax
       # @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
-
+      def create_settings(companyId, model)        path = "/api/v2/companies/#{companyId}/settings"
+        post(path, model)      end
 
       # Delete a single setting
       #
@@ -47,11 +44,8 @@ module AvaTax
       # @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
-
+      def delete_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        delete(path)      end
 
       # Retrieve a single setting
       #
@@ -72,11 +66,8 @@ module AvaTax
       # @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
-
+      def get_setting(companyId, id)        path = "/api/v2/companies/#{companyId}/settings/#{id}"
+        get(path)      end
 
       # Retrieve all settings for this company
       #
@@ -104,11 +95,8 @@ module AvaTax
       # @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
-
+      def list_settings_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/settings"
+        get(path, options)      end
 
       # Retrieve all settings
       #
@@ -135,11 +123,8 @@ module AvaTax
       # @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
-
+      def query_settings(options={})        path = "/api/v2/settings"
+        get(path, options)      end
 
       # Update a single setting
       #
@@ -165,11 +150,8 @@ module AvaTax
       # @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
-
+      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

@@ -15,11 +15,8 @@ module AvaTax
       # @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
-
+      def get_subscription(accountId, id)        path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
+        get(path)      end
 
       # Retrieve subscriptions for this account
       #
@@ -39,11 +36,8 @@ module AvaTax
       # @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
-
+      def list_subscriptions_by_account(accountId, options={})        path = "/api/v2/accounts/#{accountId}/subscriptions"
+        get(path, options)      end
 
       # Retrieve all subscriptions
       #
@@ -62,11 +56,8 @@ module AvaTax
       # @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
-
+      def query_subscriptions(options={})        path = "/api/v2/subscriptions"
+        get(path, options)      end
     end
   end
 end

data/lib/avatax/client/taxcodes.rb

@@ -17,11 +17,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this tax code.
       # @param model [TaxCodeModel[]] The tax code you wish to create.
       # @return [TaxCodeModel[]]
-      def create_tax_codes(companyId, model)
-        path = "/api/v2/companies/#{companyId}/taxcodes"
-        post(path, model)
-      end
-
+      def create_tax_codes(companyId, model)        path = "/api/v2/companies/#{companyId}/taxcodes"
+        post(path, model)      end
 
       # Delete a single tax code
       #
@@ -33,11 +30,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this tax code.
       # @param id [Integer] The ID of the tax code you wish to delete.
       # @return [ErrorDetail[]]
-      def delete_tax_code(companyId, id)
-        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
-        delete(path)
-      end
-
+      def delete_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
+        delete(path)      end
 
       # Retrieve a single tax code
       #
@@ -53,11 +47,8 @@ module AvaTax
       # @param companyId [Integer] The ID of the company that owns this tax code
       # @param id [Integer] The primary key of this tax code
       # @return [Object]
-      def get_tax_code(companyId, id)
-        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
-        get(path)
-      end
-
+      def get_tax_code(companyId, id)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
+        get(path)      end
 
       # Retrieve tax codes for this company
       #
@@ -80,11 +71,8 @@ module AvaTax
       # @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_tax_codes_by_company(companyId, options={})
-        path = "/api/v2/companies/#{companyId}/taxcodes"
-        get(path, options)
-      end
-
+      def list_tax_codes_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/taxcodes"
+        get(path, options)      end
 
       # Retrieve all tax codes
       #
@@ -106,11 +94,8 @@ module AvaTax
       # @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_tax_codes(options={})
-        path = "/api/v2/taxcodes"
-        get(path, options)
-      end
-
+      def query_tax_codes(options={})        path = "/api/v2/taxcodes"
+        get(path, options)      end
 
       # Update a single tax code
       #
@@ -129,11 +114,8 @@ module AvaTax
       # @param id [Integer] The ID of the tax code you wish to update
       # @param model [Object] The tax code you wish to update.
       # @return [Object]
-      def update_tax_code(companyId, id, model)
-        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
-        put(path, model)
-      end
-
+      def update_tax_code(companyId, id, model)        path = "/api/v2/companies/#{companyId}/taxcodes/#{id}"
+        put(path, model)      end
     end
   end
 end