avatax 24.6.1 → 24.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/avatax/client/certificates.rb +13 -3
- data/lib/avatax/client/communicationcertificates.rb +42 -0
- data/lib/avatax/client/contacts.rb +2 -2
- data/lib/avatax/client/customers.rb +22 -7
- data/lib/avatax/client/ecmeventnotifications.rb +53 -0
- data/lib/avatax/client/items.rb +36 -14
- data/lib/avatax/version.rb +1 -1
- metadata +4 -2
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: 55bf345b8bc422170f0c9c09199256638bffc7bdc1e51c1fcb5acc167dbb0351
         | 
| 4 | 
            +
              data.tar.gz: fbd18c5e6998c2b762b78c49b4d13551b5cdc8cab70deda76a325d8ad66534a2
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: 0c2c3f924f7b8d7a584b54b4c39b668942c088175f06aaf286959d9db0563f437f68e143cecddf7d71465ff3a33e26673e531e55568425eab1081eac98004d8b
         | 
| 7 | 
            +
              data.tar.gz: ec7e075c5f29eb35db1501bf3f63c2453628f6f9d361dc09b317eedc39f274c934457d20ed58ddd7b233f50a64105f930f4df764b8348e1c3396141d8b688851
         | 
| @@ -110,6 +110,11 @@ module AvaTax | |
| 110 110 | 
             
                  # * customers - Retrieves the list of customers linked to the certificate.
         | 
| 111 111 | 
             
                  # * po_numbers - Retrieves all PO numbers tied to the certificate.
         | 
| 112 112 | 
             
                  # * attributes - Retrieves all attributes applied to the certificate.
         | 
| 113 | 
            +
                  # * histories - Retrieves the certificate update history
         | 
| 114 | 
            +
                  # * jobs - Retrieves the jobs for this certificate
         | 
| 115 | 
            +
                  # * logs - Retrieves the certificate log
         | 
| 116 | 
            +
                  # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
         | 
| 117 | 
            +
                  # * custom_fields - Retrieves custom fields set for this certificate
         | 
| 113 118 | 
             
                  #
         | 
| 114 119 | 
             
                  # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
         | 
| 115 120 | 
             
                  # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
         | 
| @@ -123,7 +128,7 @@ module AvaTax | |
| 123 128 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 124 129 | 
             
                  # @param companyId [Integer] The ID number of the company that recorded this certificate
         | 
| 125 130 | 
             
                  # @param id [Integer] The unique ID number of this certificate
         | 
| 126 | 
            -
                  # @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.
         | 
| 131 | 
            +
                  # @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
         | 
| 127 132 | 
             
                  # @return [Object]
         | 
| 128 133 | 
             
                  def get_certificate(companyId, id, options={})        path = "/api/v2/companies/#{companyId}/certificates/#{id}"
         | 
| 129 134 | 
             
                    get(path, options, AvaTax::VERSION)      end
         | 
| @@ -278,6 +283,11 @@ module AvaTax | |
| 278 283 | 
             
                  # * customers - Retrieves the list of customers linked to the certificate.
         | 
| 279 284 | 
             
                  # * po_numbers - Retrieves all PO numbers tied to the certificate.
         | 
| 280 285 | 
             
                  # * attributes - Retrieves all attributes applied to the certificate.
         | 
| 286 | 
            +
                  # * histories - Retrieves the certificate update history
         | 
| 287 | 
            +
                  # * jobs - Retrieves the jobs for this certificate
         | 
| 288 | 
            +
                  # * logs - Retrieves the certificate log
         | 
| 289 | 
            +
                  # * invalid_reasons - Retrieves invalid reasons for this certificate if the certificate is invalid
         | 
| 290 | 
            +
                  # * custom_fields - Retrieves custom fields set for this certificate
         | 
| 281 291 | 
             
                  #
         | 
| 282 292 | 
             
                  # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
         | 
| 283 293 | 
             
                  # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
         | 
| @@ -290,8 +300,8 @@ module AvaTax | |
| 290 300 | 
             
                  # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
         | 
| 291 301 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 292 302 | 
             
                  # @param companyId [Integer] The ID number of the company to search
         | 
| 293 | 
            -
                  # @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.
         | 
| 294 | 
            -
                  # @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, ecmsId, ecmsStatus, pdf, pages
         | 
| 303 | 
            +
                  # @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
         | 
| 304 | 
            +
                  # @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
         | 
| 295 305 | 
             
                  # @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.
         | 
| 296 306 | 
             
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| 297 307 | 
             
                  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
         | 
| @@ -0,0 +1,42 @@ | |
| 1 | 
            +
            module AvaTax
         | 
| 2 | 
            +
              class Client
         | 
| 3 | 
            +
                module CommunicationCertificates 
         | 
| 4 | 
            +
             | 
| 5 | 
            +
             | 
| 6 | 
            +
                  # Retrieve a single communication certificate.
         | 
| 7 | 
            +
                  #
         | 
| 8 | 
            +
                  # ### Security Policies
         | 
| 9 | 
            +
                  #
         | 
| 10 | 
            +
                  # * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
         | 
| 11 | 
            +
                  # Swagger Name: AvaTaxClient	  
         | 
| 12 | 
            +
                  # @param companyId [Integer] The ID number of the company to search
         | 
| 13 | 
            +
                  # @param certificateId [Integer] The ID number of the certifificate to search
         | 
| 14 | 
            +
                  # @return [Object]
         | 
| 15 | 
            +
                  def get_communication_certificate(companyId, certificateId)        path = "/companies/#{companyId}/communication-certificates/#{certificateId}"
         | 
| 16 | 
            +
                    get(path, {}, AvaTax::VERSION)      end
         | 
| 17 | 
            +
             | 
| 18 | 
            +
                  # Retrieve all communication certificates.
         | 
| 19 | 
            +
                  #
         | 
| 20 | 
            +
                  # List all account objects that can be seen by the current user.
         | 
| 21 | 
            +
                  #
         | 
| 22 | 
            +
                  # This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account.
         | 
| 23 | 
            +
                  #
         | 
| 24 | 
            +
                  # 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/) .
         | 
| 25 | 
            +
                  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
         | 
| 26 | 
            +
                  # For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
         | 
| 27 | 
            +
                  #
         | 
| 28 | 
            +
                  # ### Security Policies
         | 
| 29 | 
            +
                  #
         | 
| 30 | 
            +
                  # * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
         | 
| 31 | 
            +
                  # Swagger Name: AvaTaxClient	  
         | 
| 32 | 
            +
                  # @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
         | 
| 33 | 
            +
                  # @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.
         | 
| 34 | 
            +
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| 35 | 
            +
                  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
         | 
| 36 | 
            +
                  # @param companyId [Integer] The ID number of the company to search
         | 
| 37 | 
            +
                  # @return [Object]
         | 
| 38 | 
            +
                  def list_communication_certificates(companyId, options={})        path = "/companies/#{companyId}/communication-certificates"
         | 
| 39 | 
            +
                    get(path, options, AvaTax::VERSION)      end
         | 
| 40 | 
            +
                end
         | 
| 41 | 
            +
              end
         | 
| 42 | 
            +
            end
         | 
| @@ -61,7 +61,7 @@ module AvaTax | |
| 61 61 | 
             
                  # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
         | 
| 62 62 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 63 63 | 
             
                  # @param companyId [Integer] The ID of the company that owns these contacts
         | 
| 64 | 
            -
                  # @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/) | 
| 64 | 
            +
                  # @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
         | 
| 65 65 | 
             
                  # @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.
         | 
| 66 66 | 
             
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| 67 67 | 
             
                  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
         | 
| @@ -82,7 +82,7 @@ module AvaTax | |
| 82 82 | 
             
                  #
         | 
| 83 83 | 
             
                  # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
         | 
| 84 84 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 85 | 
            -
                  # @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/) | 
| 85 | 
            +
                  # @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
         | 
| 86 86 | 
             
                  # @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.
         | 
| 87 87 | 
             
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| 88 88 | 
             
                  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
         | 
| @@ -70,9 +70,16 @@ module AvaTax | |
| 70 70 | 
             
                  #
         | 
| 71 71 | 
             
                  # You can use the `$include` parameter to fetch the following additional objects for expansion:
         | 
| 72 72 | 
             
                  #
         | 
| 73 | 
            -
                  # *  | 
| 74 | 
            -
                  # * CustomFields - Fetch a list of custom fields associated to this customer.
         | 
| 73 | 
            +
                  # * certificates - Fetch a list of certificates linked to this customer.
         | 
| 75 74 | 
             
                  # * attributes - Retrieves all attributes applied to the customer.
         | 
| 75 | 
            +
                  # * active_certificates - Retrieves all the active certificates linked to this customer
         | 
| 76 | 
            +
                  # * histories - Retrieves the update history for this customer
         | 
| 77 | 
            +
                  # * logs - Retrieves customer logs
         | 
| 78 | 
            +
                  # * jobs - Retrieves customer jobs
         | 
| 79 | 
            +
                  # * billTos - Retrieves bill-tos linked with this customer
         | 
| 80 | 
            +
                  # * shipTos - Retrieves ship-tos linked with this customer
         | 
| 81 | 
            +
                  # * shipToStates - Retrieves ship-to states for this customer
         | 
| 82 | 
            +
                  # * custom_fields - Retrieves custom fields set for this customer
         | 
| 76 83 | 
             
                  #
         | 
| 77 84 | 
             
                  # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
         | 
| 78 85 | 
             
                  # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
         | 
| @@ -227,8 +234,8 @@ module AvaTax | |
| 227 234 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 228 235 | 
             
                  # @param companyId [Integer] The unique ID number of the company that recorded this customer
         | 
| 229 236 | 
             
                  # @param customerCode [String] The unique code representing this customer
         | 
| 230 | 
            -
                  # @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.
         | 
| 231 | 
            -
                  # @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, ecmsId, ecmsStatus, pdf, pages
         | 
| 237 | 
            +
                  # @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
         | 
| 238 | 
            +
                  # @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
         | 
| 232 239 | 
             
                  # @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.
         | 
| 233 240 | 
             
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| 234 241 | 
             
                  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
         | 
| @@ -279,8 +286,16 @@ module AvaTax | |
| 279 286 | 
             
                  #
         | 
| 280 287 | 
             
                  # You can use the `$include` parameter to fetch the following additional objects for expansion:
         | 
| 281 288 | 
             
                  #
         | 
| 282 | 
            -
                  # *  | 
| 289 | 
            +
                  # * certificates - Fetch a list of certificates linked to this customer.
         | 
| 283 290 | 
             
                  # * attributes - Retrieves all attributes applied to the customer.
         | 
| 291 | 
            +
                  # * active_certificates - Retrieves all the active certificates linked to this customer
         | 
| 292 | 
            +
                  # * histories - Retrieves the update history for this customer
         | 
| 293 | 
            +
                  # * logs - Retrieves customer logs
         | 
| 294 | 
            +
                  # * jobs - Retrieves customer jobs
         | 
| 295 | 
            +
                  # * billTos - Retrieves bill-tos linked with this customer
         | 
| 296 | 
            +
                  # * shipTos - Retrieves ship-tos linked with this customer
         | 
| 297 | 
            +
                  # * shipToStates - Retrieves ship-to states for this customer
         | 
| 298 | 
            +
                  # * custom_fields - Retrieves custom fields set for this customer
         | 
| 284 299 | 
             
                  #
         | 
| 285 300 | 
             
                  # Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
         | 
| 286 301 | 
             
                  # Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
         | 
| @@ -293,8 +308,8 @@ module AvaTax | |
| 293 308 | 
             
                  # * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
         | 
| 294 309 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 295 310 | 
             
                  # @param companyId [Integer] The unique ID number of the company that recorded this customer
         | 
| 296 | 
            -
                  # @param include [String] OPTIONAL - You can specify the  | 
| 297 | 
            -
                  # @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/) | 
| 311 | 
            +
                  # @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.
         | 
| 312 | 
            +
                  # @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/).
         | 
| 298 313 | 
             
                  # @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.
         | 
| 299 314 | 
             
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| 300 315 | 
             
                  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
         | 
| @@ -0,0 +1,53 @@ | |
| 1 | 
            +
            module AvaTax
         | 
| 2 | 
            +
              class Client
         | 
| 3 | 
            +
                module EcmEventNotifications 
         | 
| 4 | 
            +
             | 
| 5 | 
            +
             | 
| 6 | 
            +
                  # Delete AFC event notifications.
         | 
| 7 | 
            +
                  #
         | 
| 8 | 
            +
                  # ### Security Policies
         | 
| 9 | 
            +
                  #
         | 
| 10 | 
            +
                  # * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
         | 
| 11 | 
            +
                  # Swagger Name: AvaTaxClient	  
         | 
| 12 | 
            +
                  # @param isDlq [Boolean] Specify `true` to delete event notifications from the dead letter queue; otherwise, specify `false`.
         | 
| 13 | 
            +
                  # @param model [Object] Details of the event you want to delete.
         | 
| 14 | 
            +
                  # @return [FetchResult]
         | 
| 15 | 
            +
                  def delete_afc_event_notifications(model, options={})        path = "/api/v2/event-notifications/afc"
         | 
| 16 | 
            +
                    delete(path, model, options, AvaTax::VERSION)      end
         | 
| 17 | 
            +
             | 
| 18 | 
            +
                  # Delete company event notifications
         | 
| 19 | 
            +
                  #
         | 
| 20 | 
            +
                  # ### Security Policies
         | 
| 21 | 
            +
                  #
         | 
| 22 | 
            +
                  # * This API depends on the following active services:*Required* (all): ECMPro, ECMPremium.
         | 
| 23 | 
            +
                  # Swagger Name: AvaTaxClient	  
         | 
| 24 | 
            +
                  # @param companyId [Integer] The unique ID number of the company that recorded these event notifications.
         | 
| 25 | 
            +
                  # @param model [Object] Details of the event you want to delete.
         | 
| 26 | 
            +
                  # @return [FetchResult]
         | 
| 27 | 
            +
                  def delete_event_notifications(companyId, model)        path = "/api/v2/event-notifications/companies/#{companyId}"
         | 
| 28 | 
            +
                    delete(path, model, {}, AvaTax::VERSION)      end
         | 
| 29 | 
            +
             | 
| 30 | 
            +
                  # Retrieve company event notifications.
         | 
| 31 | 
            +
                  #
         | 
| 32 | 
            +
                  # ### Security Policies
         | 
| 33 | 
            +
                  #
         | 
| 34 | 
            +
                  # * This API depends on the following active services:*Required* (all): ECMPro, ECMPremium.
         | 
| 35 | 
            +
                  # Swagger Name: AvaTaxClient	  
         | 
| 36 | 
            +
                  # @param companyId [Integer] The unique ID number of the company that recorded these event notifications.
         | 
| 37 | 
            +
                  # @return [FetchResult]
         | 
| 38 | 
            +
                  def get_event_notifications(companyId)        path = "/api/v2/event-notifications/companies/#{companyId}"
         | 
| 39 | 
            +
                    get(path, {}, AvaTax::VERSION)      end
         | 
| 40 | 
            +
             | 
| 41 | 
            +
                  # Retrieve AFC event notifications
         | 
| 42 | 
            +
                  #
         | 
| 43 | 
            +
                  # ### Security Policies
         | 
| 44 | 
            +
                  #
         | 
| 45 | 
            +
                  # * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
         | 
| 46 | 
            +
                  # Swagger Name: AvaTaxClient	  
         | 
| 47 | 
            +
                  # @param isDlq [Boolean] Specify `true` to retrieve event notifications from the dead letter queue; otherwise, specify `false`.
         | 
| 48 | 
            +
                  # @return [FetchResult]
         | 
| 49 | 
            +
                  def list_afc_event_notifications(options={})        path = "/api/v2/event-notifications/afc"
         | 
| 50 | 
            +
                    get(path, options, AvaTax::VERSION)      end
         | 
| 51 | 
            +
                end
         | 
| 52 | 
            +
              end
         | 
| 53 | 
            +
            end
         | 
    
        data/lib/avatax/client/items.rb
    CHANGED
    
    | @@ -17,7 +17,7 @@ module AvaTax | |
| 17 17 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 18 18 | 
             
                  # @param companyId [Integer] The ID of the company that owns this item.
         | 
| 19 19 | 
             
                  # @param itemId [Integer] The ID of the item you wish to delete the classifications.
         | 
| 20 | 
            -
                  # @return [ | 
| 20 | 
            +
                  # @return [AssociatedObjectDeletedErrorDetailsModel[]]
         | 
| 21 21 | 
             
                  def batch_delete_item_classifications(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
         | 
| 22 22 | 
             
                    delete(path, {}, AvaTax::VERSION)      end
         | 
| 23 23 |  | 
| @@ -37,7 +37,7 @@ module AvaTax | |
| 37 37 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 38 38 | 
             
                  # @param companyId [Integer] The ID of the company that owns this item.
         | 
| 39 39 | 
             
                  # @param itemId [Integer] The ID of the item you wish to delete the parameters.
         | 
| 40 | 
            -
                  # @return [ | 
| 40 | 
            +
                  # @return [AssociatedObjectDeletedErrorDetailsModel[]]
         | 
| 41 41 | 
             
                  def batch_delete_item_parameters(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
         | 
| 42 42 | 
             
                    delete(path, {}, AvaTax::VERSION)      end
         | 
| 43 43 |  | 
| @@ -191,7 +191,7 @@ module AvaTax | |
| 191 191 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 192 192 | 
             
                  # @param companyId [Integer] The ID of the company that owns this item.
         | 
| 193 193 | 
             
                  # @param itemCode [String] The code of the item you want to delete.
         | 
| 194 | 
            -
                  # @return [ | 
| 194 | 
            +
                  # @return [ObjectDeletedErrorModel[]]
         | 
| 195 195 | 
             
                  def delete_catalogue_item(companyId, itemCode)        path = "/api/v2/companies/#{companyId}/itemcatalogue/#{itemCode}"
         | 
| 196 196 | 
             
                    delete(path, {}, AvaTax::VERSION)      end
         | 
| 197 197 |  | 
| @@ -213,7 +213,7 @@ module AvaTax | |
| 213 213 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 214 214 | 
             
                  # @param companyId [Integer] The ID of the company that owns this item.
         | 
| 215 215 | 
             
                  # @param id [Integer] The ID of the item you wish to delete.
         | 
| 216 | 
            -
                  # @return [ | 
| 216 | 
            +
                  # @return [ObjectDeletedErrorModel[]]
         | 
| 217 217 | 
             
                  def delete_item(companyId, id)        path = "/api/v2/companies/#{companyId}/items/#{id}"
         | 
| 218 218 | 
             
                    delete(path, {}, AvaTax::VERSION)      end
         | 
| 219 219 |  | 
| @@ -232,7 +232,7 @@ module AvaTax | |
| 232 232 | 
             
                  # @param companyId [Integer] The company id.
         | 
| 233 233 | 
             
                  # @param itemId [Integer] The item id.
         | 
| 234 234 | 
             
                  # @param id [Integer] The item classification id.
         | 
| 235 | 
            -
                  # @return [ | 
| 235 | 
            +
                  # @return [ObjectDeletedErrorModel[]]
         | 
| 236 236 | 
             
                  def delete_item_classification(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
         | 
| 237 237 | 
             
                    delete(path, {}, AvaTax::VERSION)      end
         | 
| 238 238 |  | 
| @@ -253,7 +253,7 @@ module AvaTax | |
| 253 253 | 
             
                  # @param companyId [Integer] The company id
         | 
| 254 254 | 
             
                  # @param itemId [Integer] The item id
         | 
| 255 255 | 
             
                  # @param id [Integer] The parameter id
         | 
| 256 | 
            -
                  # @return [ | 
| 256 | 
            +
                  # @return [ObjectDeletedErrorModel[]]
         | 
| 257 257 | 
             
                  def delete_item_parameter(companyId, itemId, id)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
         | 
| 258 258 | 
             
                    delete(path, {}, AvaTax::VERSION)      end
         | 
| 259 259 |  | 
| @@ -270,7 +270,7 @@ module AvaTax | |
| 270 270 | 
             
                  # @param companyId [Integer] The ID of the company that defined these items
         | 
| 271 271 | 
             
                  # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
         | 
| 272 272 | 
             
                  # @param itemTagDetailId [Integer] The ID of the item tag detail you wish to delete.
         | 
| 273 | 
            -
                  # @return [ | 
| 273 | 
            +
                  # @return [ObjectDeletedErrorModel[]]
         | 
| 274 274 | 
             
                  def delete_item_tag(companyId, itemId, itemTagDetailId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags/#{itemTagDetailId}"
         | 
| 275 275 | 
             
                    delete(path, {}, AvaTax::VERSION)      end
         | 
| 276 276 |  | 
| @@ -286,7 +286,7 @@ module AvaTax | |
| 286 286 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 287 287 | 
             
                  # @param companyId [Integer] The ID of the company that defined these items.
         | 
| 288 288 | 
             
                  # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
         | 
| 289 | 
            -
                  # @return [ | 
| 289 | 
            +
                  # @return [AssociatedObjectDeletedErrorDetailsModel[]]
         | 
| 290 290 | 
             
                  def delete_item_tags(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
         | 
| 291 291 | 
             
                    delete(path, {}, AvaTax::VERSION)      end
         | 
| 292 292 |  | 
| @@ -380,7 +380,7 @@ module AvaTax | |
| 380 380 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 381 381 | 
             
                  # @param companyId [Integer] 
         | 
| 382 382 | 
             
                  # @param itemId [Integer] 
         | 
| 383 | 
            -
                  # @return [ | 
| 383 | 
            +
                  # @return [TaxCodeRecommendationOutputModel[]]
         | 
| 384 384 | 
             
                  def get_item_tax_code_recommendations(companyId, itemId)        path = "/api/v2/companies/#{companyId}/items/#{itemId}/taxcoderecommendations"
         | 
| 385 385 | 
             
                    get(path, {}, AvaTax::VERSION)      end
         | 
| 386 386 |  | 
| @@ -513,13 +513,14 @@ module AvaTax | |
| 513 513 | 
             
                  # * Classifications
         | 
| 514 514 | 
             
                  # * Tags
         | 
| 515 515 | 
             
                  # * Properties
         | 
| 516 | 
            +
                  # * TaxCodeRecommendationStatus
         | 
| 516 517 | 
             
                  #
         | 
| 517 518 | 
             
                  # ### Security Policies
         | 
| 518 519 | 
             
                  #
         | 
| 519 520 | 
             
                  # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
         | 
| 520 521 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 521 522 | 
             
                  # @param companyId [Integer] The ID of the company that defined these items
         | 
| 522 | 
            -
                  # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus
         | 
| 523 | 
            +
                  # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations
         | 
| 523 524 | 
             
                  # @param include [String] A comma separated list of additional data to retrieve.
         | 
| 524 525 | 
             
                  # @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.
         | 
| 525 526 | 
             
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| @@ -531,6 +532,26 @@ module AvaTax | |
| 531 532 | 
             
                  def list_items_by_company(companyId, options={})        path = "/api/v2/companies/#{companyId}/items"
         | 
| 532 533 | 
             
                    get(path, options, AvaTax::VERSION)      end
         | 
| 533 534 |  | 
| 535 | 
            +
                  # Retrieve the parameters by companyId and itemId.
         | 
| 536 | 
            +
                  #
         | 
| 537 | 
            +
                  # Returns the list of parameters based on the company's service types and the item code.
         | 
| 538 | 
            +
                  # Ignores nexus if a service type is configured in the 'IgnoreNexusForServiceTypes' configuration section.
         | 
| 539 | 
            +
                  # Ignores nexus for the AvaAlcohol service type.
         | 
| 540 | 
            +
                  #
         | 
| 541 | 
            +
                  # ### Security Policies
         | 
| 542 | 
            +
                  #
         | 
| 543 | 
            +
                  # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
         | 
| 544 | 
            +
                  # Swagger Name: AvaTaxClient	  
         | 
| 545 | 
            +
                  # @param companyId [Integer] Company Identifier.
         | 
| 546 | 
            +
                  # @param itemId [Integer] Item Identifier.
         | 
| 547 | 
            +
                  # @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:* serviceTypes, regularExpression, attributeSubType, values
         | 
| 548 | 
            +
                  # @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.
         | 
| 549 | 
            +
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| 550 | 
            +
                  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
         | 
| 551 | 
            +
                  # @return [FetchResult]
         | 
| 552 | 
            +
                  def list_recommended_parameter_by_company_id_and_item_id(companyId, itemId, options={})        path = "/api/v2/definitions/companies/#{companyId}/items/#{itemId}/parameters"
         | 
| 553 | 
            +
                    get(path, options, AvaTax::VERSION)      end
         | 
| 554 | 
            +
             | 
| 534 555 | 
             
                  # Retrieve all items
         | 
| 535 556 | 
             
                  #
         | 
| 536 557 | 
             
                  # Get multiple item objects across all companies.
         | 
| @@ -549,7 +570,7 @@ module AvaTax | |
| 549 570 | 
             
                  #
         | 
| 550 571 | 
             
                  # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
         | 
| 551 572 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 552 | 
            -
                  # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus
         | 
| 573 | 
            +
                  # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations
         | 
| 553 574 | 
             
                  # @param include [String] A comma separated list of additional data to retrieve.
         | 
| 554 575 | 
             
                  # @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.
         | 
| 555 576 | 
             
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| @@ -606,7 +627,7 @@ module AvaTax | |
| 606 627 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 607 628 | 
             
                  # @param companyId [Integer] The ID of the company that defined these items.
         | 
| 608 629 | 
             
                  # @param tag [String] The master tag to be associated with item.
         | 
| 609 | 
            -
                  # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus
         | 
| 630 | 
            +
                  # @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:* taxCode, source, sourceEntityId, itemType, upc, summary, classifications, parameters, tags, properties, itemStatus, taxCodeRecommendationStatus, taxCodeRecommendations
         | 
| 610 631 | 
             
                  # @param include [String] A comma separated list of additional data to retrieve.
         | 
| 611 632 | 
             
                  # @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.
         | 
| 612 633 | 
             
                  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
         | 
| @@ -681,10 +702,11 @@ module AvaTax | |
| 681 702 | 
             
                  # Swagger Name: AvaTaxClient	  
         | 
| 682 703 | 
             
                  # @param companyId [Integer] The ID of the company that this item belongs to.
         | 
| 683 704 | 
             
                  # @param id [Integer] The ID of the item you wish to update
         | 
| 705 | 
            +
                  # @param isRecommendationSelected [Boolean] If true then Set recommendation status to RecommendationSelected
         | 
| 684 706 | 
             
                  # @param model [Object] The item object you wish to update.
         | 
| 685 707 | 
             
                  # @return [Object]
         | 
| 686 | 
            -
                  def update_item(companyId, id, model)        path = "/api/v2/companies/#{companyId}/items/#{id}"
         | 
| 687 | 
            -
                    put(path, model,  | 
| 708 | 
            +
                  def update_item(companyId, id, model, options={})        path = "/api/v2/companies/#{companyId}/items/#{id}"
         | 
| 709 | 
            +
                    put(path, model, options, AvaTax::VERSION)      end
         | 
| 688 710 |  | 
| 689 711 | 
             
                  # Update an item classification.
         | 
| 690 712 | 
             
                  #
         | 
    
        data/lib/avatax/version.rb
    CHANGED
    
    
    
        metadata
    CHANGED
    
    | @@ -1,14 +1,14 @@ | |
| 1 1 | 
             
            --- !ruby/object:Gem::Specification
         | 
| 2 2 | 
             
            name: avatax
         | 
| 3 3 | 
             
            version: !ruby/object:Gem::Version
         | 
| 4 | 
            -
              version: 24. | 
| 4 | 
            +
              version: 24.8.2
         | 
| 5 5 | 
             
            platform: ruby
         | 
| 6 6 | 
             
            authors:
         | 
| 7 7 | 
             
            - Marcus Vorwaller
         | 
| 8 8 | 
             
            autorequire: 
         | 
| 9 9 | 
             
            bindir: bin
         | 
| 10 10 | 
             
            cert_chain: []
         | 
| 11 | 
            -
            date: 2024- | 
| 11 | 
            +
            date: 2024-08-30 00:00:00.000000000 Z
         | 
| 12 12 | 
             
            dependencies:
         | 
| 13 13 | 
             
            - !ruby/object:Gem::Dependency
         | 
| 14 14 | 
             
              name: rake
         | 
| @@ -127,6 +127,7 @@ files: | |
| 127 127 | 
             
            - lib/avatax/client/batches.rb
         | 
| 128 128 | 
             
            - lib/avatax/client/certexpressinvites.rb
         | 
| 129 129 | 
             
            - lib/avatax/client/certificates.rb
         | 
| 130 | 
            +
            - lib/avatax/client/communicationcertificates.rb
         | 
| 130 131 | 
             
            - lib/avatax/client/companies.rb
         | 
| 131 132 | 
             
            - lib/avatax/client/compliance.rb
         | 
| 132 133 | 
             
            - lib/avatax/client/contacts.rb
         | 
| @@ -136,6 +137,7 @@ files: | |
| 136 137 | 
             
            - lib/avatax/client/definitions.rb
         | 
| 137 138 | 
             
            - lib/avatax/client/distancethresholds.rb
         | 
| 138 139 | 
             
            - lib/avatax/client/domaincontrolverification.rb
         | 
| 140 | 
            +
            - lib/avatax/client/ecmeventnotifications.rb
         | 
| 139 141 | 
             
            - lib/avatax/client/ecms.rb
         | 
| 140 142 | 
             
            - lib/avatax/client/ecommercetoken.rb
         | 
| 141 143 | 
             
            - lib/avatax/client/errortransactions.rb
         |