Skip to content

Commit 734860e

Browse files
svc-developersvc-developer
authored
Merge pull request #168 from avadev/24.10.0
Update for 24.10.0
2 parents 7f55f09 + 1ff5daa commit 734860e

File tree

9 files changed

+57
-23
lines changed

9 files changed

+57
-23
lines changed

‎lib/avatax/client/accounts.rb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ def activate_account(id, model) path = "/api/v2/accounts/#{id}/activate"
7272
#
7373
# ### Security Policies
7474
#
75-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
75+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
7676
# Swagger Name: AvaTaxClient
7777
# @param id [Integer] The ID of the account you wish to audit.
7878
# @param start [DateTime] The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.
@@ -134,7 +134,7 @@ def delete_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}
134134
#
135135
# ### Security Policies
136136
#
137-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
137+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
138138
# Swagger Name: AvaTaxClient
139139
# @param id [Integer] The ID of the account to retrieve
140140
# @param include [String] A comma separated list of special fetch options
@@ -170,7 +170,7 @@ def get_account_configuration(id) path = "/api/v2/accounts/#{id}/configur
170170
#
171171
# ### Security Policies
172172
#
173-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
173+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
174174
# Swagger Name: AvaTaxClient
175175
# @param id [Integer] The ID of the account to retrieve
176176
# @param licensekeyname [String] The ID of the account to retrieve
@@ -184,7 +184,7 @@ def get_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}/li
184184
#
185185
# ### Security Policies
186186
#
187-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
187+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
188188
# Swagger Name: AvaTaxClient
189189
# @param id [Integer] The ID of the account to retrieve
190190
# @return [AccountLicenseKeyModel[]]
@@ -199,7 +199,7 @@ def get_license_keys(id) path = "/api/v2/accounts/#{id}/licensekeys"
199199
#
200200
# ### Security Policies
201201
#
202-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
202+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
203203
# Swagger Name: AvaTaxClient
204204
# @return [FetchResult]
205205
def list_mrs_accounts() path = "/api/v2/accounts/mrs"
@@ -222,7 +222,7 @@ def list_mrs_accounts() path = "/api/v2/accounts/mrs"
222222
#
223223
# ### Security Policies
224224
#
225-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
225+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
226226
# Swagger Name: AvaTaxClient
227227
# @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
228228
# @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:* subscriptions, users

‎lib/avatax/client/communicationcertificates.rb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ module CommunicationCertificates
1010
# * This API depends on the following active services:*Required* (all): ECMPremiumComms, ECMProComms.
1111
# Swagger Name: AvaTaxClient
1212
# @param companyId [Integer] The ID number of the company to search
13-
# @param certificateId [Integer] The ID number of the certifificate to search
13+
# @param certificateId [Integer] The ID number of the certificate to search
1414
# @return [Object]
1515
def get_communication_certificate(companyId, certificateId) path = "/companies/#{companyId}/communication-certificates/#{certificateId}"
1616
get(path, {}, AvaTax::VERSION) end
1717

1818
# Retrieve all communication certificates.
1919
#
20-
# List all account objects that can be seen by the current user.
20+
# List all communication certificates that can be seen by the current user.
2121
#
22-
# This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account.
22+
# This API lists all communication certificates you are allowed to see.
2323
#
2424
# 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/) .
2525
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.

‎lib/avatax/client/ecommercetoken.rb

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,15 @@ class Client
33
module ECommerceToken
44

55

6-
# Create a new eCommerce token.
6+
# Create a new ecommerce token.
77
#
8-
# Creates a new eCommerce token.
8+
# Creates a new ecommerce token.
99
#
10-
# This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
10+
# This API is used to create a new ecommerce token. An ecommerce token is required in order to launch the ECM/CertCapture ecommerce plugin. Create a separate token for each of your ECM/CertCapture customers.
11+
#
12+
# Use the SDK to embed ECM’s document submission form into your ecommerce platform or online store. Once the token is created, place the returned token value for that customer record in the token field in your ecommerce SDK code. This allows customers to manage their exemption certificates before or after making the purchase. More information is available in the [ECM/CertCapture integration guide](https://developer.avalara.com/document-management/set-up-ecm-for-ecommerce/ecm-in-ecom-environments/).
13+
#
14+
# You can also use the [ecommerce Plugin Demo](https://developer.avalara.com/certcapture/cert-demo/) on developer.avalara.com to test generating a token. Using your AvaTax username and password, try generating the token and combining it with various parameters.
1115
#
1216
# ### Security Policies
1317
#

‎lib/avatax/client/firmclientlinkages.rb

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -70,20 +70,34 @@ def delete_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{i
7070
#
7171
# ### Security Policies
7272
#
73-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
73+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
7474
# Swagger Name: AvaTaxClient
7575
# @param id [Integer]
7676
# @return [Object]
7777
def get_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
7878
get(path, {}, AvaTax::VERSION) end
7979

80+
# Insert a full FirmClientLinkage record
81+
#
82+
# Avalara allows firms to manage returns for clients without the clients needing to use AvaTax service.
83+
# Firms can create accounts of FirmClient for customers they are managing using this API.
84+
#
85+
# ### Security Policies
86+
#
87+
# * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
88+
# Swagger Name: AvaTaxClient
89+
# @param model [Object] FirmClientLinkage record
90+
# @return [Object]
91+
def insert_firm_client_linkage(model) path = "/api/v2/firmclientlinkages/insert"
92+
post(path, model, {}, AvaTax::VERSION) end
93+
8094
# List client linkages for a firm or client
8195
#
8296
# This API enables the firm or account users to request the associated linkages to the account.
8397
#
8498
# ### Security Policies
8599
#
86-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
100+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, ECMAccountUser, ECMCompanyUser, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
87101
# Swagger Name: AvaTaxClient
88102
# @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:* firmAccountName, clientAccountName
89103
# @return [FetchResult]
@@ -128,6 +142,20 @@ def reset_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id
128142
# @return [Object]
129143
def revoke_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/revoke"
130144
post(path, {}, {}, AvaTax::VERSION) end
145+
146+
# Update a full FirmClientLinkage record
147+
#
148+
# Avalara allow updating the firm client linkage as a pass thru call.
149+
# Firms can create accounts of FirmClient for customers they are managing using this API.
150+
#
151+
# ### Security Policies
152+
#
153+
# * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
154+
# Swagger Name: AvaTaxClient
155+
# @param model [Object] FirmClientLinkage record
156+
# @return [Object]
157+
def update_firm_client_linkage(model) path = "/api/v2/firmclientlinkages"
158+
put(path, model, {}, AvaTax::VERSION) end
131159
end
132160
end
133161
end

‎lib/avatax/client/items.rb

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -514,13 +514,14 @@ def list_item_parameters(companyId, itemId, options={}) path = "/api/v2/c
514514
# * Tags
515515
# * Properties
516516
# * TaxCodeRecommendationStatus
517+
# * TaxCodeDetails
517518
#
518519
# ### Security Policies
519520
#
520521
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
521522
# Swagger Name: AvaTaxClient
522523
# @param companyId [Integer] The ID of the company that defined these items
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
524+
# @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, taxCodeDetails
524525
# @param include [String] A comma separated list of additional data to retrieve.
525526
# @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.
526527
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -570,7 +571,7 @@ def list_recommended_parameter_by_company_id_and_item_id(companyId, itemId, opti
570571
#
571572
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
572573
# Swagger Name: AvaTaxClient
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
574+
# @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, taxCodeDetails
574575
# @param include [String] A comma separated list of additional data to retrieve.
575576
# @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.
576577
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -627,7 +628,7 @@ def query_items_by_system_code(companyId, systemCode, model, options={})
627628
# Swagger Name: AvaTaxClient
628629
# @param companyId [Integer] The ID of the company that defined these items.
629630
# @param tag [String] The master tag to be associated with item.
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
631+
# @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, taxCodeDetails
631632
# @param include [String] A comma separated list of additional data to retrieve.
632633
# @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.
633634
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
@@ -703,6 +704,7 @@ def sync_items(companyId, model) path = "/api/v2/companies/#{companyId}/i
703704
# @param companyId [Integer] The ID of the company that this item belongs to.
704705
# @param id [Integer] The ID of the item you wish to update
705706
# @param isRecommendationSelected [Boolean] If true then Set recommendation status to RecommendationSelected
707+
# @param isRecommendationRejected [Boolean] If true then Set recommendation status to RecommendationRejected, When the taxCode recommendation status is RecommendationAvailable. Else will be thrown as error
706708
# @param model [Object] The item object you wish to update.
707709
# @return [Object]
708710
def update_item(companyId, id, model, options={}) path = "/api/v2/companies/#{companyId}/items/#{id}"

0 commit comments

Comments
 (0)