Merge pull request #167 from avadev/24.8.2

Update for 24.8.2

Author: svc-developer

lib/avatax/client/certificates.rb

@@ -110,6 +110,11 @@ def download_certificate_image(companyId, id, options={})        path = "/api/v2
       # * customers - Retrieves the list of customers linked to the certificate.
       # * po_numbers - Retrieves all PO numbers tied to the certificate.
       # * attributes - Retrieves all attributes applied to the certificate.
+      # * histories - Retrieves the certificate update history
+      # * jobs - Retrieves the jobs for this certificate
+      # * logs - Retrieves the certificate log
+      # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
+      # * custom_fields - Retrieves custom fields set for this certificate
       #
       # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
       # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
@@ -123,7 +128,7 @@ def download_certificate_image(companyId, id, options={})        path = "/api/v2
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID number of the company that recorded this certificate
       # @param id [Integer] The unique ID number of this certificate
-      # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.
+      # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.   * histories - Retrieves the certificate update history   * jobs - Retrieves the jobs for this certificate   * logs - Retrieves the certificate log   * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid   * custom_fields - Retrieves custom fields set for this certificate
       # @return [Object]
       def get_certificate(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
         get(path, options, AvaTax::VERSION)      end
@@ -278,6 +283,11 @@ def list_customers_for_certificate(companyId, id, options={})        path = "/ap
       # * customers - Retrieves the list of customers linked to the certificate.
       # * po_numbers - Retrieves all PO numbers tied to the certificate.
       # * attributes - Retrieves all attributes applied to the certificate.
+      # * histories - Retrieves the certificate update history
+      # * jobs - Retrieves the jobs for this certificate
+      # * logs - Retrieves the certificate log
+      # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
+      # * custom_fields - Retrieves custom fields set for this certificate
       #
       # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
       # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
@@ -290,7 +300,7 @@ def list_customers_for_certificate(companyId, id, options={})        path = "/ap
       # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID number of the company to search
-      # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.
+      # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.   * histories - Retrieves the certificate update history   * jobs - Retrieves the jobs for this certificate   * logs - Retrieves the certificate log   * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid   * custom_fields - Retrieves custom fields set for this certificate
       # @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:* exemptionNumber, status, ecmStatus, ecmsId, ecmsStatus, pdf, pages
       # @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.

lib/avatax/client/communicationcertificates.rb

@@ -0,0 +1,42 @@
+module AvaTax
+  class Client
+    module CommunicationCertificates 
+
+
+      # Retrieve a single communication certificate.
+      #
+      # ### Security Policies
+      #
+      # * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The ID number of the company to search
+      # @param certificateId [Integer] The ID number of the certifificate to search
+      # @return [Object]
+      def get_communication_certificate(companyId, certificateId)        path = "/companies/#{companyId}/communication-certificates/#{certificateId}"
+        get(path, {}, AvaTax::VERSION)      end
+
+      # Retrieve all communication certificates.
+      #
+      # 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.
+      # For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
+      #
+      # ### Security Policies
+      #
+      # * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
+      # Swagger Name: AvaTaxClient	  
+      # @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:* EffectiveDate, ExpirationDate, TaxNumber, Exemptions
+      # @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`.
+      # @param companyId [Integer] The ID number of the company to search
+      # @return [Object]
+      def list_communication_certificates(companyId, options={})        path = "/companies/#{companyId}/communication-certificates"
+        get(path, options, AvaTax::VERSION)      end
+    end
+  end
+end

lib/avatax/client/contacts.rb

@@ -61,7 +61,7 @@ def get_contact(companyId, id)        path = "/api/v2/companies/#{companyId}/con
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The ID of the company that owns these contacts
-      # @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:* scsContactId
       # @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`.
@@ -82,7 +82,7 @@ def list_contacts_by_company(companyId, options={})        path = "/api/v2/compa
       #
       # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
       # Swagger Name: AvaTaxClient	  
-      # @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:* scsContactId
       # @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`.

lib/avatax/client/customers.rb

@@ -70,9 +70,16 @@ def delete_customer(companyId, customerCode)        path = "/api/v2/companies/#{
       #
       # You can use the `$include` parameter to fetch the following additional objects for expansion:
       #
-      # * Certificates - Fetch a list of certificates linked to this customer.
-      # * CustomFields - Fetch a list of custom fields associated to this customer.
+      # * certificates - Fetch a list of certificates linked to this customer.
       # * attributes - Retrieves all attributes applied to the customer.
+      # * active_certificates - Retrieves all the active certificates linked to this customer
+      # * histories - Retrieves the update history for this customer
+      # * logs - Retrieves customer logs
+      # * jobs - Retrieves customer jobs
+      # * billTos - Retrieves bill-tos linked with this customer
+      # * shipTos - Retrieves ship-tos linked with this customer
+      # * shipToStates - Retrieves ship-to states for this customer
+      # * custom_fields - Retrieves custom fields set for this customer
       #
       # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
       # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
@@ -227,7 +234,7 @@ def list_attributes_for_customer(companyId, customerCode)        path = "/api/v2
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
       # @param customerCode [String] The unique code representing this customer
-      # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.
+      # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following:      * customers - Retrieves the list of customers linked to the certificate.   * po_numbers - Retrieves all PO numbers tied to the certificate.   * attributes - Retrieves all attributes applied to the certificate.   * histories - Retrieves the certificate update history   * jobs - Retrieves the jobs for this certificate   * logs - Retrieves the certificate log   * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid   * custom_fields - Retrieves custom fields set for this certificate
       # @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:* exemptionNumber, status, ecmStatus, ecmsId, ecmsStatus, pdf, pages
       # @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.
@@ -279,8 +286,16 @@ def list_valid_certificates_for_customer(companyId, customerCode, country, regio
       #
       # You can use the `$include` parameter to fetch the following additional objects for expansion:
       #
-      # * Certificates - Fetch a list of certificates linked to this customer.
+      # * certificates - Fetch a list of certificates linked to this customer.
       # * attributes - Retrieves all attributes applied to the customer.
+      # * active_certificates - Retrieves all the active certificates linked to this customer
+      # * histories - Retrieves the update history for this customer
+      # * logs - Retrieves customer logs
+      # * jobs - Retrieves customer jobs
+      # * billTos - Retrieves bill-tos linked with this customer
+      # * shipTos - Retrieves ship-tos linked with this customer
+      # * shipToStates - Retrieves ship-to states for this customer
+      # * custom_fields - Retrieves custom fields set for this customer
       #
       # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
       # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
@@ -293,7 +308,7 @@ def list_valid_certificates_for_customer(companyId, customerCode, country, regio
       # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
       # Swagger Name: AvaTaxClient	  
       # @param companyId [Integer] The unique ID number of the company that recorded this customer
-      # @param include [String] OPTIONAL - You can specify the value `certificates` to fetch information about certificates linked to the customer.
+      # @param include [String] OPTIONAL - You can specify any of the values in `certificates`, `attributes`, `active_certificates`, `histories`, `logs`, `jobs`, `billTos`, `shipTos`, `shipToStates`, and `custom_fields` to fetch additional information for this certificate.
       # @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.

lib/avatax/client/ecmeventnotifications.rb

@@ -0,0 +1,53 @@
+module AvaTax
+  class Client
+    module EcmEventNotifications 
+
+
+      # Delete AFC event notifications.
+      #
+      # ### Security Policies
+      #
+      # * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param isDlq [Boolean] Specify `true` to delete event notifications from the dead letter queue; otherwise, specify `false`.
+      # @param model [Object] Details of the event you want to delete.
+      # @return [FetchResult]
+      def delete_afc_event_notifications(model, options={})        path = "/api/v2/event-notifications/afc"
+        delete(path, model, options, AvaTax::VERSION)      end
+
+      # Delete company event notifications
+      #
+      # ### Security Policies
+      #
+      # * This API depends on the following active services:*Required* (all): ECMPro, ECMPremium.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID number of the company that recorded these event notifications.
+      # @param model [Object] Details of the event you want to delete.
+      # @return [FetchResult]
+      def delete_event_notifications(companyId, model)        path = "/api/v2/event-notifications/companies/#{companyId}"
+        delete(path, model, {}, AvaTax::VERSION)      end
+
+      # Retrieve company event notifications.
+      #
+      # ### Security Policies
+      #
+      # * This API depends on the following active services:*Required* (all): ECMPro, ECMPremium.
+      # Swagger Name: AvaTaxClient	  
+      # @param companyId [Integer] The unique ID number of the company that recorded these event notifications.
+      # @return [FetchResult]
+      def get_event_notifications(companyId)        path = "/api/v2/event-notifications/companies/#{companyId}"
+        get(path, {}, AvaTax::VERSION)      end
+
+      # Retrieve AFC event notifications
+      #
+      # ### Security Policies
+      #
+      # * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
+      # Swagger Name: AvaTaxClient	  
+      # @param isDlq [Boolean] Specify `true` to retrieve event notifications from the dead letter queue; otherwise, specify `false`.
+      # @return [FetchResult]
+      def list_afc_event_notifications(options={})        path = "/api/v2/event-notifications/afc"
+        get(path, options, AvaTax::VERSION)      end
+    end
+  end
+end