Skip to content

Commit 95e2fb5

Browse files
author
genevieve.conty
committed
Merge branch 'master' of github.com:avadev/AvaTax-REST-V2-Ruby-SDK into pr82
2 parents e647f6e + bd7ecd2 commit 95e2fb5

27 files changed

+814
-502
lines changed

.vs/slnx.sqlite

0 Bytes
Binary file not shown.

lib/avatax/client/addresses.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ module Addresses
1212
# This is the same API as the POST /api/v2/addresses/resolve endpoint.
1313
# Both verbs are supported to provide for flexible implementation.
1414
#
15-
# Inorder to get any evaluation for an address please provide atleast one of the following fields/pairs:
15+
# In order to get any evaluation for an address, please provide at least one of the following fields/pairs:
1616
# 1. postal code
1717
# 2. line1 + city + region
1818
# 3. line1 + postal code
1919
#
2020
# ### Security Policies
2121
#
2222
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
23-
# * This API depends on the following active services<br />*Required* (all): AutoAddress.
23+
# * This API depends on the following active services:*Required* (all): AutoAddress.
2424
# @param line1 [String] Line 1
2525
# @param line2 [String] Line 2
2626
# @param line3 [String] Line 3
@@ -45,7 +45,7 @@ def resolve_address(options={}) path = "/api/v2/addresses/resolve"
4545
# ### Security Policies
4646
#
4747
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
48-
# * This API depends on the following active services<br />*Required* (all): AutoAddress.
48+
# * This API depends on the following active services:*Required* (all): AutoAddress.
4949
# @param model [Object] The address to resolve
5050
# @return [Object]
5151
def resolve_address_post(model) path = "/api/v2/addresses/resolve"

lib/avatax/client/advancedrules.rb

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,6 @@ def create_company_lookup_file(accountId, companyId, model) path = "/api/
2222
def delete_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
2323
delete(path) end
2424

25-
# Get audit records by account id and date range.
26-
#
27-
#
28-
# @param accountId [Integer] The ID of the account
29-
# @param fromDate [String] Date
30-
# @param toDate [String] Date
31-
# @return [Object]
32-
def get_audit_records(accountId, fromDate, toDate) path = "/api/v2/advancedrules/audits/accounts/#{accountId}/from/#{fromDate}/to/#{toDate}"
33-
get(path) end
34-
3525
# Get the lookup files for a company
3626
#
3727
#

lib/avatax/client/avafileforms.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ module AvaFileForms
1111
# ### Security Policies
1212
#
1313
# * This API requires the user role Compliance Root User.
14-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
14+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
1515
# @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
1616
# @return [AvaFileFormModel[]]
1717
def create_ava_file_forms(model) path = "/api/v2/avafileforms"
@@ -24,7 +24,7 @@ def create_ava_file_forms(model) path = "/api/v2/avafileforms"
2424
# ### Security Policies
2525
#
2626
# * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
27-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
27+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
2828
# @param id [Integer] The ID of the AvaFileForm you wish to delete.
2929
# @return [ErrorDetail[]]
3030
def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
@@ -37,7 +37,7 @@ def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
3737
# ### Security Policies
3838
#
3939
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
40-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
40+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
4141
# @param id [Integer] The primary key of this AvaFileForm
4242
# @return [Object]
4343
def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
@@ -51,7 +51,7 @@ def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
5151
# ### Security Policies
5252
#
5353
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
54-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
54+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
5555
# @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:* outletTypeId
5656
# @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.
5757
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -68,7 +68,7 @@ def query_ava_file_forms(options={}) path = "/api/v2/avafileforms"
6868
# ### Security Policies
6969
#
7070
# * This API requires the user role Compliance Root User.
71-
# * This API depends on the following active services<br />*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.<br />*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
71+
# * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
7272
# @param id [Integer] The ID of the AvaFileForm you wish to update
7373
# @param model [Object] The AvaFileForm model you wish to update.
7474
# @return [Object]

lib/avatax/client/certexpressinvites.rb

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ module CertExpressInvites
1616
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
1717
# your company so that they can be used for tax exemptions.
1818
#
19-
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
20-
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
21-
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
22-
# storage for this company, call `RequestCertificateSetup`.
19+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
20+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
21+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
22+
# certificate storage for this company, call `RequestCertificateSetup`.
2323
#
2424
# ### Security Policies
2525
#
2626
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
27-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
27+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
2828
# @param companyId [Integer] The unique ID number of the company that will record certificates
2929
# @param customerCode [String] The number of the customer where the request is sent to
3030
# @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
@@ -45,15 +45,15 @@ def create_cert_express_invitation(companyId, customerCode, model) path =
4545
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
4646
# your company so that they can be used for tax exemptions.
4747
#
48-
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
49-
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
50-
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
51-
# storage for this company, call `RequestCertificateSetup`.
48+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
49+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
50+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
51+
# certificate storage for this company, call `RequestCertificateSetup`.
5252
#
5353
# ### Security Policies
5454
#
5555
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
56-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
56+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
5757
# @param companyId [Integer] The unique ID number of the company that issued this invitation
5858
# @param customerCode [String] The number of the customer where the request is sent to
5959
# @param id [Integer] The unique ID number of this CertExpress invitation
@@ -75,15 +75,15 @@ def get_cert_express_invitation(companyId, customerCode, id, options={})
7575
# Using CertExpress with this API will ensure that your certificates are automatically linked correctly into
7676
# your company so that they can be used for tax exemptions.
7777
#
78-
# Using exemption certificates endpoints requires setup of an auditable document storage for each company that will use certificates.
79-
# Companies that do not have this storage system set up will receive the error `CertCaptureNotConfiguredError` when they call exemption
80-
# certificate related APIs. To check if this company is set up, call `GetCertificateSetup`. To request setup of the auditable document
81-
# storage for this company, call `RequestCertificateSetup`.
78+
# Before you can use any exemption certificates endpoints, you must set up your company for exemption certificate data storage.
79+
# Companies that do not have this storage system set up will see `CertCaptureNotConfiguredError` when they call exemption
80+
# certificate related APIs. To check if this is set up for a company, call `GetCertificateSetup`. To request setup of exemption
81+
# certificate storage for this company, call `RequestCertificateSetup`.
8282
#
8383
# ### Security Policies
8484
#
8585
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
86-
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
86+
# * This API depends on the following active services:*Required* (all): AvaTaxPro.
8787
# @param companyId [Integer] The unique ID number of the company that issued this invitation
8888
# @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
8989
# @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:* companyId, customer, coverLetter, exposureZones, exemptReasons, requestLink

0 commit comments

Comments
 (0)