Skip to content

Commit 97ae45c

Browse files
Merge pull request #172 from avadev/25.2.2
Update for 25.2.2
2 parents 6e3a023 + a473493 commit 97ae45c

File tree

6 files changed

+46
-5
lines changed

6 files changed

+46
-5
lines changed

lib/avatax/api.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
require File.expand_path('../connection', __FILE__)
22
require File.expand_path('../request', __FILE__)
3+
require 'active_support'
34
require 'active_support/notifications'
45
require 'logger'
56

lib/avatax/client/certificates.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ def list_customers_for_certificate(companyId, id, options={}) path = "/ap
301301
# Swagger Name: AvaTaxClient
302302
# @param companyId [Integer] The ID number of the company to search
303303
# @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, ecmsId, ecmsStatus, pdf, pages
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, ecmsId, ecmsStatus, pdf, pages
305305
# @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.
306306
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
307307
# @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

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,6 +183,26 @@ def link_certificates_to_customer(companyId, customerCode, model) path =
183183
def link_ship_to_customers_to_bill_customer(companyId, code, model) path = "/api/v2/companies/#{companyId}/customers/billto/#{code}/shipto/link"
184184
post(path, model, {}, AvaTax::VERSION) end
185185

186+
# Retrieves a list of active certificates for a specified customer within a company.
187+
#
188+
# This API is intended to identify whether a customer has any active certificates.
189+
#
190+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
191+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
192+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
193+
# certificate storage for this company, call `RequestCertificateSetup`.
194+
#
195+
# ### Security Policies
196+
#
197+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
198+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
199+
# Swagger Name: AvaTaxClient
200+
# @param companyId [Integer] The unique ID number of the company that recorded this customer
201+
# @param customerCode [String] The unique code representing this customer
202+
# @return [Object]
203+
def list_active_certificates_for_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/active"
204+
get(path, {}, AvaTax::VERSION) end
205+
186206
# Retrieve a customer's attributes
187207
#
188208
# Retrieve the attributes linked to the customer identified by this URL.
@@ -235,14 +255,35 @@ def list_attributes_for_customer(companyId, customerCode) path = "/api/v2
235255
# @param companyId [Integer] The unique ID number of the company that recorded this customer
236256
# @param customerCode [String] The unique code representing this customer
237257
# @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, ecmsId, ecmsStatus, pdf, pages
258+
# @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, ecmsId, ecmsStatus, pdf, pages
239259
# @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.
240260
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
241261
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
242262
# @return [FetchResult]
243263
def list_certificates_for_customer(companyId, customerCode, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates"
244264
get(path, options, AvaTax::VERSION) end
245265

266+
# Retrieves a list of inactive certificates for a specified customer within a company.
267+
#
268+
# This API is used to retrieve inactive certificates for a customer. Inactive certificates may include expired,
269+
# revoked, or otherwise non-compliant certificates.
270+
#
271+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
272+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
273+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
274+
# certificate storage for this company, call `RequestCertificateSetup`.
275+
#
276+
# ### Security Policies
277+
#
278+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
279+
# * This API depends on the following active services:*Required* (all): AvaTaxPro, ECMEssentials, ECMPro, ECMPremium, VEMPro, VEMPremium, ECMProComms, ECMPremiumComms.
280+
# Swagger Name: AvaTaxClient
281+
# @param companyId [Integer] The unique ID number of the company that recorded this customer
282+
# @param customerCode [String] The unique code representing this customer
283+
# @return [Object]
284+
def list_in_active_certificates_for_customer(companyId, customerCode) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certificates/inactive"
285+
get(path, {}, AvaTax::VERSION) end
286+
246287
# List valid certificates for a location
247288
#
248289
# List valid certificates linked to a customer in a particular country and region.

lib/avatax/client/reports.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ def get_report(id) path = "/api/v2/reports/#{id}"
5555
# Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
5656
# for up to 30 days after completion. To run an asynchronous report, you should follow these steps:
5757
#
58-
# * Begin a report by calling the report's Initiate API. There is a separate initiate API call for each report type.
58+
# * Begin a report by calling the report's Initiate API.
5959
# * In the result of the Initiate API, you receive back a report's `id` value.
6060
# * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
6161
# * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.

lib/avatax/version.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module AvaTax
2-
VERSION = '25.1.0'.freeze unless defined?(::AvaTax::VERSION)
2+
VERSION = '25.2.2'.freeze unless defined?(::AvaTax::VERSION)
33
end

spec/spec_helper.rb

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
require File.expand_path('../../lib/avatax', __FILE__)
22
require 'rspec'
3-
require 'active_support'
43
require 'yaml'
54

65

0 commit comments

Comments
 (0)