avatax 19.7.0 → 19.8.0

data/lib/avatax/client/firmclientlinkages.rb

@@ -0,0 +1,151 @@
+module AvaTax
+  class Client
+    module FirmClientLinkages 
+
+
+      # Approves linkage to a firm for a client account
+      #
+      # This API enables the account admin of a client account to approve linkage request by a firm.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param id [Integer] 
+      # @return [Object]
+      def approve_firm_client_linkage(id)
+        path = "/api/v2/firmclientlinkages/#{id}/approve"
+        post(path)
+      end
+
+
+      # Request a new FirmClient account and create an approved linkage to it
+      #
+      # This API is for use by Firms only.
+      #
+      # Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service.
+      # Firms can create accounts of FirmClient for customers they are managing using this API.
+      #
+      # Calling this API creates an account with the specified product subscriptions, but without a new user for account.
+      # Account is then linked to the Firm so they can managed their returns.
+      # You should call this API when a customer does not have an AvaTax account and is to be managed only by the firm.
+      #
+      # The created account will be created in `Active` status but there will be no user or license key associated with account.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SystemAdmin.
+      # @param model [Object] Information about the account you wish to create.
+      # @return [Object]
+      def create_and_link_new_firm_client_account(model)
+        path = "/api/v2/firmclientlinkages/createandlinkclient"
+        post(path, model)
+      end
+
+
+      # Links a firm account with the client account
+      #
+      # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param model [Object] FirmClientLinkageInputModel
+      # @return [Object]
+      def create_firm_client_linkage(model)
+        path = "/api/v2/firmclientlinkages"
+        post(path, model)
+      end
+
+
+      # Delete a linkage
+      #
+      # This API marks a linkage between a firm and client as deleted.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param id [Integer] 
+      # @return [ErrorDetail[]]
+      def delete_firm_client_linkage(id)
+        path = "/api/v2/firmclientlinkages/#{id}"
+        delete(path)
+      end
+
+
+      # Get linkage between a firm and client by id
+      #
+      # This API enables the firm admins/firm users to request the linkage of a firm account and a client account.
+      #
+      # ### 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.
+      # @param id [Integer] 
+      # @return [Object]
+      def get_firm_client_linkage(id)
+        path = "/api/v2/firmclientlinkages/#{id}"
+        get(path)
+      end
+
+
+      # List client linkages for a firm or client
+      #
+      # This API enables the firm or account users to request the associated linkages to the account.
+      #
+      # ### 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.
+      # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* firmAccountName, clientAccountName
+      # @return [FetchResult]
+      def list_firm_client_linkage(options={})
+        path = "/api/v2/firmclientlinkages"
+        get(path, options)
+      end
+
+
+      # Rejects linkage to a firm for a client account
+      #
+      # This API enables the account admin of a client account to reject linkage request by a firm.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param id [Integer] 
+      # @return [Object]
+      def reject_firm_client_linkage(id)
+        path = "/api/v2/firmclientlinkages/#{id}/reject"
+        post(path)
+      end
+
+
+      # Reset linkage status between a client and firm back to requested
+      #
+      # This API enables the firm admin of a client account to reset a previously created linkage request by a firm.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param id [Integer] 
+      # @return [Object]
+      def reset_firm_client_linkage(id)
+        path = "/api/v2/firmclientlinkages/#{id}/reset"
+        post(path)
+      end
+
+
+      # Revokes previously approved linkage to a firm for a client account
+      #
+      # This API enables the account admin of a client account to revoke a previously approved linkage request by a firm.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
+      # @param id [Integer] 
+      # @return [Object]
+      def revoke_firm_client_linkage(id)
+        path = "/api/v2/firmclientlinkages/#{id}/revoke"
+        post(path)
+      end
+
+    end
+  end
+end

data/lib/avatax/client/fundingrequests.rb

@@ -21,8 +21,8 @@ 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 depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
+      # * 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.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param id [Integer] The unique ID number of this funding request
       # @return [Object]
       def activate_funding_request(id)
@@ -47,8 +47,8 @@ module AvaTax
       # ### Security Policies
       #
       # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
-      # * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.
-      # * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request host address whitelisting for [Returns] for your servers.
+      # * 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.<br />*Exempt security roles*: ComplianceRootUser, ComplianceAdmin, ComplianceUser, TechnicalSupportAdmin, TechnicalSupportUser.
       # @param id [Integer] The unique ID number of this funding request
       # @return [Object]
       def funding_request_status(id)

data/lib/avatax/client/items.rb

@@ -374,6 +374,33 @@ module AvaTax
       end
 
 
+      # Sync items from a product catalog
+      #
+      # Syncs a list of items with AvaTax without waiting for them to be created. It is ideal for syncing large product catalogs
+      # with AvaTax.
+      #
+      # Any invalid or duplicate items will be ignored. To diagnose why an item is not created, use the normal create transaction API to receive validation information.
+      #
+      # This API is currently limited to 1000 items per call (the limit is subject to change).
+      #
+      # Items are a way of separating your tax calculation process from your tax configuration details. If you choose, you
+      # can provide `itemCode` values for each `CreateTransaction()` API call rather than specifying tax codes, parameters, descriptions,
+      # and other data fields. AvaTax will automatically look up each `itemCode` and apply the correct tax codes and parameters
+      # from the item table instead. This allows your CreateTransaction call to be as simple as possible, and your tax compliance
+      # team can manage your item catalog and adjust the tax behavior of items without having to modify your software.
+      #
+      # ### Security Policies
+      #
+      # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
+      # @param companyId [Integer] The ID of the company that owns this item.
+      # @param model [Object] The request object.
+      # @return [Object]
+      def sync_items(companyId, model)
+        path = "/api/v2/companies/#{companyId}/items/sync"
+        post(path, model)
+      end
+
+
       # Update a single item
       #
       # Replace the existing `Item` object at this URL with an updated object.

data/lib/avatax/client/notifications.rb

@@ -18,6 +18,8 @@ module AvaTax
       # dismissed. You can then later review which employees of your company dismissed notifications to
       # determine if they were resolved appropriately.
       #
+      # A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span.
+      #
       # ### 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.

data/lib/avatax/client/registrar.rb

@@ -32,6 +32,9 @@ module AvaTax
       # to regularly review notifications and then dismiss them when you are certain that you have addressed
       # any relevant concerns raised by this notification.
       #
+      # A Global notification is a message which is directed to all the accounts and is set to expire within
+      # a certain time and cannot be dismissed by the user. Make accountId and companyId null to create a global notification.
+      #
       # An example of a notification would be a message about new software, or a change to AvaTax that may
       # affect you, or a potential issue with your company's tax profile.
       #

data/lib/avatax/version.rb

@@ -1,3 +1,3 @@
 module AvaTax
-  VERSION = '19.7.0'.freeze unless defined?(::AvaTax::VERSION)
+  VERSION = '19.8.0'.freeze unless defined?(::AvaTax::VERSION)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 19.7.0
+  version: 19.8.0
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-16 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -149,6 +149,7 @@ files:
 - lib/avatax/client/ecms.rb
 - lib/avatax/client/filingcalendars.rb
 - lib/avatax/client/filings.rb
+- lib/avatax/client/firmclientlinkages.rb
 - lib/avatax/client/free.rb
 - lib/avatax/client/fundingrequests.rb
 - lib/avatax/client/items.rb