avatax 18.5.1 → 18.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a76fdb83a5c471fa9773fd14b692eedc72dcfcc40d0b5a64b4a702bfc2888bc
-  data.tar.gz: 2756b24bd169058892928ffb36c949523558326f3f558558f4d1686ee22bd589
+  metadata.gz: ee85cb2ad965a98ca293c0e2c9cfcfad65c776cabb455e9e8bc53167c80301e9
+  data.tar.gz: 034f1d99a65944c9ddfd594ab91cfc7f89b9e6d6bad57d9485d0b099aa1373ab
 SHA512:
-  metadata.gz: 182a5ae62e391f7d0501c6be42626a05815c26c5e3fe7e288ffdceeeca5083034ee9200077b58fbe73a51f677b4850f95dd18cd0759970104bbb421559d224fe
-  data.tar.gz: b12f298325080c3188ec59148f7ca2dea3376559f2b555a600482b21f1d20a004cbce4bda0e4ee6a75f4c1a7249f596938b21b4a7a971621d179463b9a5c6a42
+  metadata.gz: c6194d2b8d143dc402fe472cccba23e7ec00fba4b7b4f7b5cab27a375256ef1842c535b4c8b10bcba77d643ad71e543f291ad08d24ccb67c363ba61e9f1f6d60
+  data.tar.gz: 011b78bba1aacdd6df2b9ace456de797b28d96379b7df26fe056d067905a950d21a56a6d8248a389f4f4c3954aaa1f6f4560d890f0674e1a0e176759e7545190

data/lib/avatax/client/accounts.rb

@@ -86,6 +86,32 @@ module AvaTax
       end
 
 
+      # Retrieve all accounts
+      #
+      # List all account objects that can be seen by the current user.
+      #
+      # This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account.
+      #
+      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
+      #
+      # * Subscriptions
+      # * Users
+      #
+      # For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
+      # @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
+      # @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.
+      # @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_accounts(options={})
+        path = "/api/v2/accounts"
+        get(path, options)
+      end
+
+
       # Change configuration settings for this account
       #
       # Update configuration settings tied to this account.

data/lib/avatax/client/certificates.rb

@@ -188,7 +188,7 @@ module AvaTax
       # Retrieve the list of attributes that are linked to this certificate.
       #
       # A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
-      # certificate at any time. The full list of defined attributes may be found using `/api/v2/definitions/certificateattributes`.
+      # certificate at any time. The full list of defined attributes may be found using [ListCertificateAttributes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListCertificateAttributes/) API.
       #
       # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
       # can contain information about a customer's eligibility for exemption from sales or use taxes based on

data/lib/avatax/client/companies.rb

@@ -220,7 +220,9 @@ module AvaTax
       # Retrieve all companies
       #
       # Get multiple company objects.
-      # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
+      #
+      # A `company` represents a single corporation or individual that is registered to handle transactional taxes.
+      #
       # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
       # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
       # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:

data/lib/avatax/client/notices.rb

@@ -3,22 +3,6 @@ module AvaTax
     module Notices 
 
 
-      # Delete a single notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
-      # @param commentDetailsId [Integer] The ID of the comment you wish to delete.
-      # @return [ErrorDetail[]]
-      def comment_details_delete(companyId, id, commentDetailsId)
-        path = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
-        delete(path)
-      end
-
-
       # Create a new notice comment.
       #
       # This API is available by invitation only.
@@ -99,6 +83,39 @@ module AvaTax
       end
 
 
+      # Delete a single notice.
+      #
+      # This API is available by invitation only.
+      # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
+      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
+      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # @param companyId [Integer] The ID of the company that owns this notice.
+      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
+      # @param commentDetailsId [Integer] The ID of the comment you wish to delete.
+      # @return [ErrorDetail[]]
+      def delete_comment_details(companyId, id, commentDetailsId)
+        path = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
+        delete(path)
+      end
+
+
+      # Delete a single notice.
+      #
+      # This API is available by invitation only.
+      # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
+      # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
+      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
+      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
+      # @param companyId [Integer] The ID of the company that owns this notice.
+      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
+      # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
+      # @return [ErrorDetail[]]
+      def delete_finance_details(companyId, id, financeDetailsId)
+        path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
+        delete(path)
+      end
+
+
       # Delete a single notice.
       #
       # This API is available by invitation only.
@@ -159,23 +176,6 @@ module AvaTax
       end
 
 
-      # Delete a single notice.
-      #
-      # This API is available by invitation only.
-      # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
-      # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
-      # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
-      # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
-      # @param companyId [Integer] The ID of the company that owns this notice.
-      # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
-      # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
-      # @return [ErrorDetail[]]
-      def financedetailsdelete(companyId, id, financeDetailsId)
-        path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
-        delete(path)
-      end
-
-
       # Retrieve a single notice.
       #
       # This API is available by invitation only.
@@ -295,6 +295,22 @@ module AvaTax
       end
 
 
+      # Update a single notice finance detail.
+      #
+      # This API is available by invitation only.
+      # All data from the existing object will be replaced with data in the object you PUT.
+      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
+      # @param companyId [Integer] The ID of the company that this notice finance detail belongs to.
+      # @param noticeid [Integer] The ID of the notice finance detail you wish to update.
+      # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
+      # @param model [Object] The notice finance detail object you wish to update.
+      # @return [Object]
+      def update_finance_details(companyId, noticeid, financeDetailsId, model)
+        path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/financedetails/#{financedetailsid}"
+        put(path, model)
+      end
+
+
       # Update a single notice.
       #
       # This API is available by invitation only.
@@ -313,6 +329,22 @@ module AvaTax
       end
 
 
+      # Update a single notice comment.
+      #
+      # This API is available by invitation only.
+      # All data from the existing object will be replaced with data in the object you PUT.
+      # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
+      # @param companyId [Integer] The ID of the company that this notice comment belongs to.
+      # @param noticeid [Integer] The ID of the notice you wish to update.
+      # @param commentDetailsId [Integer] The ID of the comment you wish to update.
+      # @param model [Object] The notice comment object you wish to update.
+      # @return [Object]
+      def update_notice_comments(companyId, noticeid, commentDetailsId, model)
+        path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/commentdetails/#{commentdetailsid}"
+        put(path, model)
+      end
+
+
       # Retrieve a single attachment
       #
       # This API is available by invitation only.

data/lib/avatax/client/notifications.rb

@@ -0,0 +1,71 @@
+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
+      # to regularly review notifications and then dismiss them when you are certain that you have addressed
+      # any relevant concerns raised by this 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.
+      #
+      # When you dismiss a notification, the notification will track the user and time when it was
+      # dismissed. You can then later review which employees of your company dismissed notifications to
+      # determine if they were resolved appropriately.
+      # @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.
+      #
+      # 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
+      # to regularly review notifications and then dismiss them when you are certain that you have addressed
+      # any relevant concerns raised by this 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.
+      # @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.
+      #
+      # List all notifications.
+      #
+      # A notification is a message from Avalara that may have relevance to your business. You may want
+      # to regularly review notifications and then dismiss them when you are certain that you have addressed
+      # any relevant concerns raised by this 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.
+      #
+      # You may search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
+      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
+      # @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.
+      # @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
+end

data/lib/avatax/client/onboarding.rb

@@ -26,6 +26,19 @@ module AvaTax
         post(path, model)
       end
 
+
+      # Request a new entitilement to an existing customer
+      #
+      # This API is for use by partner onboarding services customers only. This will allow the partners to allow
+      # the add new entitlement to an existing customer
+      # @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
 end

data/lib/avatax/client/registrar.rb

@@ -34,6 +34,26 @@ module AvaTax
       end
 
 
+      # Create new notifications.
+      #
+      # This API is available by invitation only.
+      #
+      # Create a single notification.
+      #
+      # A notification is a message from Avalara that may have relevance to your business. You may want
+      # to regularly review notifications and then dismiss them when you are certain that you have addressed
+      # any relevant concerns raised by this 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.
+      # @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
       #
       # # For Registrar Use Only
@@ -66,6 +86,26 @@ module AvaTax
       end
 
 
+      # Delete a single notification.
+      #
+      # This API is available by invitation only.
+      #
+      # Delete the existing notification identified by this URL.
+      #
+      # A notification is a message from Avalara that may have relevance to your business. You may want
+      # to regularly review notifications and then dismiss them when you are certain that you have addressed
+      # any relevant concerns raised by this 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.
+      # @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
       #
       # # For Registrar Use Only
@@ -96,32 +136,6 @@ module AvaTax
       end
 
 
-      # Retrieve all accounts
-      #
-      # # For Registrar Use Only
-      # This API is for use by Avalara Registrar administrative users only.
-      #
-      # Get multiple account objects.
-      # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
-      # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
-      # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
-      #
-      # * Subscriptions
-      # * Users
-      #
-      # For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
-      # @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
-      # @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.
-      # @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_accounts(options={})
-        path = "/api/v2/accounts"
-        get(path, options)
-      end
-
-
       # Reset a user's password programmatically
       #
       # # For Registrar Use Only
@@ -154,6 +168,27 @@ module AvaTax
       end
 
 
+      # Update a single notification.
+      #
+      # This API is available by invitation only.
+      #
+      # Replaces the notification identified by this URL with a new notification.
+      #
+      # A notification is a message from Avalara that may have relevance to your business. You may want
+      # to regularly review notifications and then dismiss them when you are certain that you have addressed
+      # any relevant concerns raised by this 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.
+      # @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
       #
       # # For Registrar Use Only

data/lib/avatax/client/taxcontent.rb

@@ -7,8 +7,12 @@ module AvaTax
       #
       # Builds a tax content file containing information useful for a retail point-of-sale solution.
       #
-      # This file contains tax rates and rules for items and locations that can be used
-      # to correctly calculate tax in the event a point-of-sale device is not able to reach AvaTax.
+      # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
+      # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
+      # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
+      # item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content
+      # file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,
+      # then use `CreateItems()` to create an item that uses the custom tax code.
       #
       # This data file can be customized for specific partner devices and usage conditions.
       #
@@ -30,8 +34,12 @@ module AvaTax
       #
       # Builds a tax content file containing information useful for a retail point-of-sale solution.
       #
-      # This file contains tax rates and rules for all items for a single location. Data from this API
-      # can be used to correctly calculate tax in the event a point-of-sale device is not able to reach AvaTax.
+      # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
+      # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
+      # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
+      # item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content
+      # file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,
+      # then use `CreateItems()` to create an item that uses the custom tax code.
       #
       # This data file can be customized for specific partner devices and usage conditions.
       #

data/lib/avatax/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avatax
 version: !ruby/object:Gem::Version
-  version: 18.5.1
+  version: 18.6.1
 platform: ruby
 authors:
 - Marcus Vorwaller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-30 00:00:00.000000000 Z
+date: 2018-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -165,6 +165,7 @@ files:
 - lib/avatax/client/multidocument.rb
 - lib/avatax/client/nexus.rb
 - lib/avatax/client/notices.rb
+- lib/avatax/client/notifications.rb
 - lib/avatax/client/onboarding.rb
 - lib/avatax/client/pointofsale.rb
 - lib/avatax/client/registrar.rb