avatax 22.5.0 → 22.6.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.github/workflows/gem-push.yml +31 -0
- data/.gitignore +55 -55
- data/.rspec +1 -1
- data/.vs/VSWorkspaceState.json +5 -5
- data/.yardopts +4 -4
- data/Gemfile +2 -2
- data/LICENSE +201 -201
- data/README.md +98 -98
- data/Rakefile +9 -9
- data/avatax.gemspec +38 -38
- data/example/avatax.rb +47 -47
- data/example/credentials.example.yaml +5 -5
- data/lib/avatax/api.rb +27 -27
- data/lib/avatax/client/accounts.rb +22 -22
- data/lib/avatax/client/addresses.rb +4 -4
- data/lib/avatax/client/advancedrules.rb +5 -5
- data/lib/avatax/client/avafileforms.rb +7 -7
- data/lib/avatax/client/batches.rb +16 -16
- data/lib/avatax/client/certexpressinvites.rb +6 -6
- data/lib/avatax/client/certificates.rb +30 -30
- data/lib/avatax/client/companies.rb +44 -44
- data/lib/avatax/client/compliance.rb +1 -1
- data/lib/avatax/client/contacts.rb +12 -12
- data/lib/avatax/client/customers.rb +26 -26
- data/lib/avatax/client/datasources.rb +12 -12
- data/lib/avatax/client/definitions.rb +73 -73
- data/lib/avatax/client/distancethresholds.rb +12 -12
- data/lib/avatax/client/ecms.rb +73 -73
- data/lib/avatax/client/ecommercetoken.rb +4 -4
- data/lib/avatax/client/errortransactions.rb +61 -61
- data/lib/avatax/client/firmclientlinkages.rb +17 -17
- data/lib/avatax/client/free.rb +1 -1
- data/lib/avatax/client/fundingrequests.rb +4 -4
- data/lib/avatax/client/items.rb +64 -64
- data/lib/avatax/client/jurisdictionoverrides.rb +12 -12
- data/lib/avatax/client/locations.rb +24 -24
- data/lib/avatax/client/multidocument.rb +20 -20
- data/lib/avatax/client/nexus.rb +30 -30
- data/lib/avatax/client/notices.rb +8 -8
- data/lib/avatax/client/notifications.rb +6 -6
- data/lib/avatax/client/onboarding.rb +55 -55
- data/lib/avatax/client/pointofsale.rb +21 -21
- data/lib/avatax/client/provisioning.rb +4 -4
- data/lib/avatax/client/registrar.rb +19 -19
- data/lib/avatax/client/reports.rb +7 -7
- data/lib/avatax/client/settings.rb +12 -12
- data/lib/avatax/client/subscriptions.rb +6 -6
- data/lib/avatax/client/taxcodes.rb +12 -12
- data/lib/avatax/client/taxcontent.rb +8 -8
- data/lib/avatax/client/taxprofiles.rb +42 -42
- data/lib/avatax/client/taxrules.rb +12 -12
- data/lib/avatax/client/transactions.rb +41 -41
- data/lib/avatax/client/upcs.rb +12 -12
- data/lib/avatax/client/userdefinedfields.rb +6 -6
- data/lib/avatax/client/users.rb +16 -16
- data/lib/avatax/client/utilities.rb +3 -3
- data/lib/avatax/client.rb +37 -37
- data/lib/avatax/configuration.rb +76 -76
- data/lib/avatax/connection.rb +53 -53
- data/lib/avatax/request.rb +51 -51
- data/lib/avatax/version.rb +3 -3
- data/lib/avatax.rb +26 -26
- data/spec/avatax/client/accounts_spec.rb +13 -13
- data/spec/avatax/client/transactions_spec.rb +80 -80
- data/spec/avatax/request_spec.rb +25 -25
- data/spec/avatax_spec.rb +45 -45
- data/spec/credentials.yaml.example +4 -4
- data/spec/fixtures/accounts.json +15 -15
- data/spec/spec_helper.rb +27 -27
- metadata +6 -6
- data/.travis.yml +0 -19
@@ -28,14 +28,14 @@ module AvaTax
|
|
28
28
|
#
|
29
29
|
# ### Security Policies
|
30
30
|
#
|
31
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
31
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
32
32
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
33
33
|
# Swagger Name: AvaTaxClient
|
34
34
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
35
35
|
# @param model [Object] information about the transaction and lines to be added
|
36
36
|
# @return [Object]
|
37
37
|
def add_lines(model, options={}) path = "/api/v2/companies/transactions/lines/add"
|
38
|
-
post(path, model, options, "22.
|
38
|
+
post(path, model, options, "22.6.1") end
|
39
39
|
|
40
40
|
# Correct a previously created transaction
|
41
41
|
#
|
@@ -71,7 +71,7 @@ module AvaTax
|
|
71
71
|
#
|
72
72
|
# ### Security Policies
|
73
73
|
#
|
74
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
74
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
75
75
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
76
76
|
# Swagger Name: AvaTaxClient
|
77
77
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -81,7 +81,7 @@ module AvaTax
|
|
81
81
|
# @param model [Object] The adjustment you wish to make
|
82
82
|
# @return [Object]
|
83
83
|
def adjust_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/adjust"
|
84
|
-
post(path, model, options, "22.
|
84
|
+
post(path, model, options, "22.6.1") end
|
85
85
|
|
86
86
|
# Get audit information about a transaction
|
87
87
|
#
|
@@ -111,14 +111,14 @@ module AvaTax
|
|
111
111
|
#
|
112
112
|
# ### Security Policies
|
113
113
|
#
|
114
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
114
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
115
115
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
116
116
|
# Swagger Name: AvaTaxClient
|
117
117
|
# @param companyCode [String] The code identifying the company that owns this transaction
|
118
118
|
# @param transactionCode [String] The code identifying the transaction
|
119
119
|
# @return [Object]
|
120
120
|
def audit_transaction(companyCode, transactionCode) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/audit"
|
121
|
-
get(path, {}, "22.
|
121
|
+
get(path, {}, "22.6.1") end
|
122
122
|
|
123
123
|
# Get audit information about a transaction
|
124
124
|
#
|
@@ -148,7 +148,7 @@ module AvaTax
|
|
148
148
|
#
|
149
149
|
# ### Security Policies
|
150
150
|
#
|
151
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
151
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
152
152
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
153
153
|
# Swagger Name: AvaTaxClient
|
154
154
|
# @param companyCode [String] The code identifying the company that owns this transaction
|
@@ -156,7 +156,7 @@ module AvaTax
|
|
156
156
|
# @param documentType [String] The document type of the original transaction (See DocumentType::* for a list of allowable values)
|
157
157
|
# @return [Object]
|
158
158
|
def audit_transaction_with_type(companyCode, transactionCode, documentType) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}/audit"
|
159
|
-
get(path, {}, "22.
|
159
|
+
get(path, {}, "22.6.1") end
|
160
160
|
|
161
161
|
# Lock a set of documents
|
162
162
|
#
|
@@ -176,7 +176,7 @@ module AvaTax
|
|
176
176
|
# @param model [Object] bulk lock request
|
177
177
|
# @return [Object]
|
178
178
|
def bulk_lock_transaction(model) path = "/api/v2/transactions/lock"
|
179
|
-
post(path, model, {}, "22.
|
179
|
+
post(path, model, {}, "22.6.1") end
|
180
180
|
|
181
181
|
# Change a transaction's code
|
182
182
|
#
|
@@ -212,7 +212,7 @@ module AvaTax
|
|
212
212
|
#
|
213
213
|
# ### Security Policies
|
214
214
|
#
|
215
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
215
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
216
216
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
217
217
|
# Swagger Name: AvaTaxClient
|
218
218
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -222,7 +222,7 @@ module AvaTax
|
|
222
222
|
# @param model [Object] The code change request you wish to execute
|
223
223
|
# @return [Object]
|
224
224
|
def change_transaction_code(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/changecode"
|
225
|
-
post(path, model, options, "22.
|
225
|
+
post(path, model, options, "22.6.1") end
|
226
226
|
|
227
227
|
# Commit a transaction for reporting
|
228
228
|
#
|
@@ -257,7 +257,7 @@ module AvaTax
|
|
257
257
|
#
|
258
258
|
# ### Security Policies
|
259
259
|
#
|
260
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
260
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
261
261
|
# Swagger Name: AvaTaxClient
|
262
262
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
263
263
|
# @param transactionCode [String] The transaction code to commit
|
@@ -266,7 +266,7 @@ module AvaTax
|
|
266
266
|
# @param model [Object] The commit request you wish to execute
|
267
267
|
# @return [Object]
|
268
268
|
def commit_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/commit"
|
269
|
-
post(path, model, options, "22.
|
269
|
+
post(path, model, options, "22.6.1") end
|
270
270
|
|
271
271
|
# Create or adjust a transaction
|
272
272
|
#
|
@@ -306,14 +306,14 @@ module AvaTax
|
|
306
306
|
#
|
307
307
|
# ### Security Policies
|
308
308
|
#
|
309
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
309
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
310
310
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
311
311
|
# Swagger Name: AvaTaxClient
|
312
312
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
313
313
|
# @param model [Object] The transaction you wish to create or adjust
|
314
314
|
# @return [Object]
|
315
315
|
def create_or_adjust_transaction(model, options={}) path = "/api/v2/transactions/createoradjust"
|
316
|
-
post(path, model, options, "22.
|
316
|
+
post(path, model, options, "22.6.1") end
|
317
317
|
|
318
318
|
# Create a new transaction
|
319
319
|
#
|
@@ -360,14 +360,14 @@ module AvaTax
|
|
360
360
|
#
|
361
361
|
# ### Security Policies
|
362
362
|
#
|
363
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
363
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
364
364
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
365
365
|
# Swagger Name: AvaTaxClient
|
366
366
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
367
367
|
# @param model [Object] The transaction you wish to create
|
368
368
|
# @return [Object]
|
369
369
|
def create_transaction(model, options={}) path = "/api/v2/transactions/create"
|
370
|
-
post(path, model, options, "22.
|
370
|
+
post(path, model, options, "22.6.1") end
|
371
371
|
|
372
372
|
# Remove lines from an existing unlocked transaction
|
373
373
|
#
|
@@ -391,14 +391,14 @@ module AvaTax
|
|
391
391
|
#
|
392
392
|
# ### Security Policies
|
393
393
|
#
|
394
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
394
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
395
395
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
396
396
|
# Swagger Name: AvaTaxClient
|
397
397
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
398
398
|
# @param model [Object] information about the transaction and lines to be removed
|
399
399
|
# @return [Object]
|
400
400
|
def delete_lines(model, options={}) path = "/api/v2/companies/transactions/lines/delete"
|
401
|
-
post(path, model, options, "22.
|
401
|
+
post(path, model, options, "22.6.1") end
|
402
402
|
|
403
403
|
# Retrieve a single transaction by code
|
404
404
|
#
|
@@ -431,7 +431,7 @@ module AvaTax
|
|
431
431
|
#
|
432
432
|
# ### Security Policies
|
433
433
|
#
|
434
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
434
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
435
435
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
436
436
|
# Swagger Name: AvaTaxClient
|
437
437
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -440,7 +440,7 @@ module AvaTax
|
|
440
440
|
# @param include [String] Specifies objects to include in this fetch call
|
441
441
|
# @return [Object]
|
442
442
|
def get_transaction_by_code(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}"
|
443
|
-
get(path, options, "22.
|
443
|
+
get(path, options, "22.6.1") end
|
444
444
|
|
445
445
|
# Retrieve a single transaction by code
|
446
446
|
#
|
@@ -456,7 +456,7 @@ module AvaTax
|
|
456
456
|
#
|
457
457
|
# ### Security Policies
|
458
458
|
#
|
459
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
459
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
460
460
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
461
461
|
# Swagger Name: AvaTaxClient
|
462
462
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -465,7 +465,7 @@ module AvaTax
|
|
465
465
|
# @param include [String] Specifies objects to include in this fetch call
|
466
466
|
# @return [Object]
|
467
467
|
def get_transaction_by_code_and_type(companyCode, transactionCode, documentType, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/types/#{documentType}"
|
468
|
-
get(path, options, "22.
|
468
|
+
get(path, options, "22.6.1") end
|
469
469
|
|
470
470
|
# Retrieve a single transaction by ID
|
471
471
|
#
|
@@ -488,14 +488,14 @@ module AvaTax
|
|
488
488
|
#
|
489
489
|
# ### Security Policies
|
490
490
|
#
|
491
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
491
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
492
492
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
493
493
|
# Swagger Name: AvaTaxClient
|
494
494
|
# @param id [Integer] The unique ID number of the transaction to retrieve
|
495
495
|
# @param include [String] Specifies objects to include in this fetch call
|
496
496
|
# @return [Object]
|
497
497
|
def get_transaction_by_id(id, options={}) path = "/api/v2/transactions/#{id}"
|
498
|
-
get(path, options, "22.
|
498
|
+
get(path, options, "22.6.1") end
|
499
499
|
|
500
500
|
# Retrieve all transactions
|
501
501
|
#
|
@@ -531,7 +531,7 @@ module AvaTax
|
|
531
531
|
#
|
532
532
|
# ### Security Policies
|
533
533
|
#
|
534
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
534
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
535
535
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
536
536
|
# Swagger Name: AvaTaxClient
|
537
537
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -543,7 +543,7 @@ module AvaTax
|
|
543
543
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
544
544
|
# @return [FetchResult]
|
545
545
|
def list_transactions_by_company(companyCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions"
|
546
|
-
get(path, options, "22.
|
546
|
+
get(path, options, "22.6.1") end
|
547
547
|
|
548
548
|
# Lock a single transaction
|
549
549
|
#
|
@@ -579,7 +579,7 @@ module AvaTax
|
|
579
579
|
#
|
580
580
|
# ### Security Policies
|
581
581
|
#
|
582
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
582
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
583
583
|
# * 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.
|
584
584
|
# Swagger Name: AvaTaxClient
|
585
585
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -589,7 +589,7 @@ module AvaTax
|
|
589
589
|
# @param model [Object] The lock request you wish to execute
|
590
590
|
# @return [Object]
|
591
591
|
def lock_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/lock"
|
592
|
-
post(path, model, options, "22.
|
592
|
+
post(path, model, options, "22.6.1") end
|
593
593
|
|
594
594
|
# Create a refund for a transaction
|
595
595
|
#
|
@@ -635,7 +635,7 @@ module AvaTax
|
|
635
635
|
#
|
636
636
|
# ### Security Policies
|
637
637
|
#
|
638
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
638
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
639
639
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
640
640
|
# Swagger Name: AvaTaxClient
|
641
641
|
# @param companyCode [String] The code of the company that made the original sale
|
@@ -646,7 +646,7 @@ module AvaTax
|
|
646
646
|
# @param model [Object] Information about the refund to create
|
647
647
|
# @return [Object]
|
648
648
|
def refund_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/refund"
|
649
|
-
post(path, model, options, "22.
|
649
|
+
post(path, model, options, "22.6.1") end
|
650
650
|
|
651
651
|
# Perform multiple actions on a transaction
|
652
652
|
#
|
@@ -681,7 +681,7 @@ module AvaTax
|
|
681
681
|
#
|
682
682
|
# ### Security Policies
|
683
683
|
#
|
684
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
684
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
685
685
|
# Swagger Name: AvaTaxClient
|
686
686
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
687
687
|
# @param transactionCode [String] The transaction code to settle
|
@@ -690,7 +690,7 @@ module AvaTax
|
|
690
690
|
# @param model [Object] The data from an external system to reconcile against AvaTax
|
691
691
|
# @return [Object]
|
692
692
|
def settle_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/settle"
|
693
|
-
post(path, model, options, "22.
|
693
|
+
post(path, model, options, "22.6.1") end
|
694
694
|
|
695
695
|
# Uncommit a transaction for reporting
|
696
696
|
#
|
@@ -719,7 +719,7 @@ module AvaTax
|
|
719
719
|
#
|
720
720
|
# ### Security Policies
|
721
721
|
#
|
722
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
722
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
723
723
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
724
724
|
# Swagger Name: AvaTaxClient
|
725
725
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -728,7 +728,7 @@ module AvaTax
|
|
728
728
|
# @param include [String] Specifies objects to include in this fetch call
|
729
729
|
# @return [Object]
|
730
730
|
def uncommit_transaction(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/uncommit"
|
731
|
-
post(path, options, "22.
|
731
|
+
post(path, options, "22.6.1") end
|
732
732
|
|
733
733
|
# Unvoids a transaction
|
734
734
|
#
|
@@ -754,7 +754,7 @@ module AvaTax
|
|
754
754
|
#
|
755
755
|
# ### Security Policies
|
756
756
|
#
|
757
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
757
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
758
758
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
759
759
|
# Swagger Name: AvaTaxClient
|
760
760
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -763,7 +763,7 @@ module AvaTax
|
|
763
763
|
# @param include [String] Specifies objects to include in this fetch call
|
764
764
|
# @return [Object]
|
765
765
|
def unvoid_transaction(companyCode, transactionCode, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/unvoid"
|
766
|
-
post(path, options, "22.
|
766
|
+
post(path, options, "22.6.1") end
|
767
767
|
|
768
768
|
# Verify a transaction
|
769
769
|
#
|
@@ -796,7 +796,7 @@ module AvaTax
|
|
796
796
|
#
|
797
797
|
# ### Security Policies
|
798
798
|
#
|
799
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
799
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
800
800
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
801
801
|
# Swagger Name: AvaTaxClient
|
802
802
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -806,7 +806,7 @@ module AvaTax
|
|
806
806
|
# @param model [Object] The data from an external system to reconcile against AvaTax
|
807
807
|
# @return [Object]
|
808
808
|
def verify_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/verify"
|
809
|
-
post(path, model, options, "22.
|
809
|
+
post(path, model, options, "22.6.1") end
|
810
810
|
|
811
811
|
# Void a transaction
|
812
812
|
#
|
@@ -841,7 +841,7 @@ module AvaTax
|
|
841
841
|
#
|
842
842
|
# ### Security Policies
|
843
843
|
#
|
844
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
844
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
|
845
845
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
846
846
|
# Swagger Name: AvaTaxClient
|
847
847
|
# @param companyCode [String] The company code of the company that recorded this transaction
|
@@ -851,7 +851,7 @@ module AvaTax
|
|
851
851
|
# @param model [Object] The void request you wish to execute. To void a transaction the code must be set to 'DocVoided'
|
852
852
|
# @return [Object]
|
853
853
|
def void_transaction(companyCode, transactionCode, model, options={}) path = "/api/v2/companies/#{companyCode}/transactions/#{transactionCode}/void"
|
854
|
-
post(path, model, options, "22.
|
854
|
+
post(path, model, options, "22.6.1") end
|
855
855
|
end
|
856
856
|
end
|
857
857
|
end
|
data/lib/avatax/client/upcs.rb
CHANGED
@@ -10,14 +10,14 @@ module AvaTax
|
|
10
10
|
#
|
11
11
|
# ### Security Policies
|
12
12
|
#
|
13
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
13
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
14
14
|
# * This API depends on the following active services:*Required* (all): AvaUpc.
|
15
15
|
# Swagger Name: AvaTaxClient
|
16
16
|
# @param companyId [Integer] The ID of the company that owns this UPC.
|
17
17
|
# @param model [UPCModel[]] The UPC you wish to create.
|
18
18
|
# @return [UPCModel[]]
|
19
19
|
def create_u_p_cs(companyId, model) path = "/api/v2/companies/#{companyId}/upcs"
|
20
|
-
post(path, model, {}, "22.
|
20
|
+
post(path, model, {}, "22.6.1") end
|
21
21
|
|
22
22
|
# Delete a single UPC
|
23
23
|
#
|
@@ -25,14 +25,14 @@ module AvaTax
|
|
25
25
|
#
|
26
26
|
# ### Security Policies
|
27
27
|
#
|
28
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
28
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
29
29
|
# * This API depends on the following active services:*Required* (all): AvaUpc.
|
30
30
|
# Swagger Name: AvaTaxClient
|
31
31
|
# @param companyId [Integer] The ID of the company that owns this UPC.
|
32
32
|
# @param id [Integer] The ID of the UPC you wish to delete.
|
33
33
|
# @return [ErrorDetail[]]
|
34
34
|
def delete_u_p_c(companyId, id) path = "/api/v2/companies/#{companyId}/upcs/#{id}"
|
35
|
-
delete(path, {}, "22.
|
35
|
+
delete(path, {}, "22.6.1") end
|
36
36
|
|
37
37
|
# Retrieve a single UPC
|
38
38
|
#
|
@@ -41,14 +41,14 @@ module AvaTax
|
|
41
41
|
#
|
42
42
|
# ### Security Policies
|
43
43
|
#
|
44
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
44
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
45
45
|
# * This API depends on the following active services:*Required* (all): AvaUpc.
|
46
46
|
# Swagger Name: AvaTaxClient
|
47
47
|
# @param companyId [Integer] The ID of the company that owns this UPC
|
48
48
|
# @param id [Integer] The primary key of this UPC
|
49
49
|
# @return [Object]
|
50
50
|
def get_u_p_c(companyId, id) path = "/api/v2/companies/#{companyId}/upcs/#{id}"
|
51
|
-
get(path, {}, "22.
|
51
|
+
get(path, {}, "22.6.1") end
|
52
52
|
|
53
53
|
# Retrieve UPCs for this company
|
54
54
|
#
|
@@ -60,7 +60,7 @@ module AvaTax
|
|
60
60
|
#
|
61
61
|
# ### Security Policies
|
62
62
|
#
|
63
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
63
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
64
64
|
# * This API depends on the following active services:*Required* (all): AvaUpc.
|
65
65
|
# Swagger Name: AvaTaxClient
|
66
66
|
# @param companyId [Integer] The ID of the company that owns these UPCs
|
@@ -71,7 +71,7 @@ module AvaTax
|
|
71
71
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
72
72
|
# @return [FetchResult]
|
73
73
|
def list_u_p_cs_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/upcs"
|
74
|
-
get(path, options, "22.
|
74
|
+
get(path, options, "22.6.1") end
|
75
75
|
|
76
76
|
# Retrieve all UPCs
|
77
77
|
#
|
@@ -83,7 +83,7 @@ module AvaTax
|
|
83
83
|
#
|
84
84
|
# ### Security Policies
|
85
85
|
#
|
86
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
86
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
87
87
|
# * This API depends on the following active services:*Required* (all): AvaUpc.
|
88
88
|
# Swagger Name: AvaTaxClient
|
89
89
|
# @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/).
|
@@ -93,7 +93,7 @@ module AvaTax
|
|
93
93
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
94
94
|
# @return [FetchResult]
|
95
95
|
def query_u_p_cs(options={}) path = "/api/v2/upcs"
|
96
|
-
get(path, options, "22.
|
96
|
+
get(path, options, "22.6.1") end
|
97
97
|
|
98
98
|
# Update a single UPC
|
99
99
|
#
|
@@ -104,7 +104,7 @@ module AvaTax
|
|
104
104
|
#
|
105
105
|
# ### Security Policies
|
106
106
|
#
|
107
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
107
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
108
108
|
# * This API depends on the following active services:*Required* (all): AvaUpc.
|
109
109
|
# Swagger Name: AvaTaxClient
|
110
110
|
# @param companyId [Integer] The ID of the company that this UPC belongs to.
|
@@ -112,7 +112,7 @@ module AvaTax
|
|
112
112
|
# @param model [Object] The UPC you wish to update.
|
113
113
|
# @return [Object]
|
114
114
|
def update_u_p_c(companyId, id, model) path = "/api/v2/companies/#{companyId}/upcs/#{id}"
|
115
|
-
put(path, model, {}, "22.
|
115
|
+
put(path, model, {}, "22.6.1") end
|
116
116
|
end
|
117
117
|
end
|
118
118
|
end
|
@@ -9,20 +9,20 @@ module AvaTax
|
|
9
9
|
#
|
10
10
|
# ### Security Policies
|
11
11
|
#
|
12
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
12
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
13
13
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
14
14
|
# Swagger Name: AvaTaxClient
|
15
15
|
# @param companyId [Integer] The id of the company the User Defined Field belongs to.
|
16
16
|
# @param id [Integer] The id of the User Defined Field you wish to delete.
|
17
17
|
# @return [ErrorDetail[]]
|
18
18
|
def delete_user_defined_field(companyId, id) path = "/api/v2/companies/#{companyId}/userdefinedfields/#{id}"
|
19
|
-
delete(path, {}, "22.
|
19
|
+
delete(path, {}, "22.6.1") end
|
20
20
|
|
21
21
|
#
|
22
22
|
#
|
23
23
|
# ### Security Policies
|
24
24
|
#
|
25
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
25
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
26
26
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
27
27
|
# Swagger Name: AvaTaxClient
|
28
28
|
# @param companyId [Integer]
|
@@ -30,7 +30,7 @@ module AvaTax
|
|
30
30
|
# @param allowDefaults [Boolean] If true this will add defaulted UDFs to the list that are not named yet
|
31
31
|
# @return [FetchResult]
|
32
32
|
def list_user_defined_fields_by_company_id(companyId, options={}) path = "/api/v2/companies/#{companyId}/userdefinedfields"
|
33
|
-
get(path, options, "22.
|
33
|
+
get(path, options, "22.6.1") end
|
34
34
|
|
35
35
|
# Update a User Defined Field identified by id for a company
|
36
36
|
#
|
@@ -38,7 +38,7 @@ module AvaTax
|
|
38
38
|
#
|
39
39
|
# ### Security Policies
|
40
40
|
#
|
41
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
41
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
42
42
|
# * This API depends on the following active services:*Required* (all): AvaTaxPro, BasicReturns.
|
43
43
|
# Swagger Name: AvaTaxClient
|
44
44
|
# @param companyId [Integer] The id of the company the user defined field belongs to.
|
@@ -46,7 +46,7 @@ module AvaTax
|
|
46
46
|
# @param model [Object]
|
47
47
|
# @return [Object]
|
48
48
|
def update_user_defined_field(companyId, model, options={}) path = "/api/v2/companies/#{companyId}/userdefinedfields"
|
49
|
-
post(path, model, options, "22.
|
49
|
+
post(path, model, options, "22.6.1") end
|
50
50
|
end
|
51
51
|
end
|
52
52
|
end
|
data/lib/avatax/client/users.rb
CHANGED
@@ -15,12 +15,12 @@ module AvaTax
|
|
15
15
|
#
|
16
16
|
# ### Security Policies
|
17
17
|
#
|
18
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
18
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
19
19
|
# Swagger Name: AvaTaxClient
|
20
20
|
# @param model [Object] An object containing your current password and the new password.
|
21
21
|
# @return [String]
|
22
22
|
def change_password(model) path = "/api/v2/passwords"
|
23
|
-
put(path, model, {}, "22.
|
23
|
+
put(path, model, {}, "22.6.1") end
|
24
24
|
|
25
25
|
# Create new users
|
26
26
|
#
|
@@ -36,13 +36,13 @@ module AvaTax
|
|
36
36
|
#
|
37
37
|
# ### Security Policies
|
38
38
|
#
|
39
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
39
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
40
40
|
# Swagger Name: AvaTaxClient
|
41
41
|
# @param accountId [Integer] The unique ID number of the account where these users will be created.
|
42
42
|
# @param model [UserModel[]] The user or array of users you wish to create.
|
43
43
|
# @return [UserModel[]]
|
44
44
|
def create_users(accountId, model) path = "/api/v2/accounts/#{accountId}/users"
|
45
|
-
post(path, model, {}, "22.
|
45
|
+
post(path, model, {}, "22.6.1") end
|
46
46
|
|
47
47
|
# Delete a single user
|
48
48
|
#
|
@@ -55,13 +55,13 @@ module AvaTax
|
|
55
55
|
#
|
56
56
|
# ### Security Policies
|
57
57
|
#
|
58
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.
|
58
|
+
# * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, Compliance Root User, CSPTester, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TreasuryAdmin.
|
59
59
|
# Swagger Name: AvaTaxClient
|
60
60
|
# @param id [Integer] The ID of the user you wish to delete.
|
61
61
|
# @param accountId [Integer] The accountID of the user you wish to delete.
|
62
62
|
# @return [ErrorDetail[]]
|
63
63
|
def delete_user(id, accountId) path = "/api/v2/accounts/#{accountId}/users/#{id}"
|
64
|
-
delete(path, {}, "22.
|
64
|
+
delete(path, {}, "22.6.1") end
|
65
65
|
|
66
66
|
# Retrieve a single user
|
67
67
|
#
|
@@ -74,14 +74,14 @@ module AvaTax
|
|
74
74
|
#
|
75
75
|
# ### Security Policies
|
76
76
|
#
|
77
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
77
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
78
78
|
# Swagger Name: AvaTaxClient
|
79
79
|
# @param id [Integer] The ID of the user to retrieve.
|
80
80
|
# @param accountId [Integer] The accountID of the user you wish to get.
|
81
81
|
# @param include [String] Optional fetch commands.
|
82
82
|
# @return [Object]
|
83
83
|
def get_user(id, accountId, options={}) path = "/api/v2/accounts/#{accountId}/users/#{id}"
|
84
|
-
get(path, options, "22.
|
84
|
+
get(path, options, "22.6.1") end
|
85
85
|
|
86
86
|
# Retrieve all entitlements for a single user
|
87
87
|
#
|
@@ -103,13 +103,13 @@ module AvaTax
|
|
103
103
|
#
|
104
104
|
# ### Security Policies
|
105
105
|
#
|
106
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
106
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
107
107
|
# Swagger Name: AvaTaxClient
|
108
108
|
# @param id [Integer] The ID of the user to retrieve.
|
109
109
|
# @param accountId [Integer] The accountID of the user you wish to get.
|
110
110
|
# @return [Object]
|
111
111
|
def get_user_entitlements(id, accountId) path = "/api/v2/accounts/#{accountId}/users/#{id}/entitlements"
|
112
|
-
get(path, {}, "22.
|
112
|
+
get(path, {}, "22.6.1") end
|
113
113
|
|
114
114
|
# Retrieve users for this account
|
115
115
|
#
|
@@ -128,7 +128,7 @@ module AvaTax
|
|
128
128
|
#
|
129
129
|
# ### Security Policies
|
130
130
|
#
|
131
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
131
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
132
132
|
# Swagger Name: AvaTaxClient
|
133
133
|
# @param accountId [Integer] The accountID of the user you wish to list.
|
134
134
|
# @param include [String] Optional fetch commands.
|
@@ -138,7 +138,7 @@ module AvaTax
|
|
138
138
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
139
139
|
# @return [FetchResult]
|
140
140
|
def list_users_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/users"
|
141
|
-
get(path, options, "22.
|
141
|
+
get(path, options, "22.6.1") end
|
142
142
|
|
143
143
|
# Retrieve all users
|
144
144
|
#
|
@@ -159,7 +159,7 @@ module AvaTax
|
|
159
159
|
#
|
160
160
|
# ### Security Policies
|
161
161
|
#
|
162
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
162
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
163
163
|
# Swagger Name: AvaTaxClient
|
164
164
|
# @param include [String] Optional fetch commands.
|
165
165
|
# @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:* SuppressNewUserEmail
|
@@ -168,7 +168,7 @@ module AvaTax
|
|
168
168
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
169
169
|
# @return [FetchResult]
|
170
170
|
def query_users(options={}) path = "/api/v2/users"
|
171
|
-
get(path, options, "22.
|
171
|
+
get(path, options, "22.6.1") end
|
172
172
|
|
173
173
|
# Update a single user
|
174
174
|
#
|
@@ -179,14 +179,14 @@ module AvaTax
|
|
179
179
|
#
|
180
180
|
# ### Security Policies
|
181
181
|
#
|
182
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
182
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
183
183
|
# Swagger Name: AvaTaxClient
|
184
184
|
# @param id [Integer] The ID of the user you wish to update.
|
185
185
|
# @param accountId [Integer] The accountID of the user you wish to update.
|
186
186
|
# @param model [Object] The user object you wish to update.
|
187
187
|
# @return [Object]
|
188
188
|
def update_user(id, accountId, model) path = "/api/v2/accounts/#{accountId}/users/#{id}"
|
189
|
-
put(path, model, {}, "22.
|
189
|
+
put(path, model, {}, "22.6.1") end
|
190
190
|
end
|
191
191
|
end
|
192
192
|
end
|