avatax 22.5.0 → 22.6.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (72) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/gem-push.yml +31 -0
  3. data/.gitignore +55 -55
  4. data/.rspec +1 -1
  5. data/.vs/VSWorkspaceState.json +5 -5
  6. data/.yardopts +4 -4
  7. data/Gemfile +2 -2
  8. data/LICENSE +201 -201
  9. data/README.md +98 -98
  10. data/Rakefile +9 -9
  11. data/avatax.gemspec +38 -38
  12. data/example/avatax.rb +47 -47
  13. data/example/credentials.example.yaml +5 -5
  14. data/lib/avatax/api.rb +27 -27
  15. data/lib/avatax/client/accounts.rb +22 -22
  16. data/lib/avatax/client/addresses.rb +4 -4
  17. data/lib/avatax/client/advancedrules.rb +5 -5
  18. data/lib/avatax/client/avafileforms.rb +7 -7
  19. data/lib/avatax/client/batches.rb +16 -16
  20. data/lib/avatax/client/certexpressinvites.rb +6 -6
  21. data/lib/avatax/client/certificates.rb +30 -30
  22. data/lib/avatax/client/companies.rb +44 -44
  23. data/lib/avatax/client/compliance.rb +1 -1
  24. data/lib/avatax/client/contacts.rb +12 -12
  25. data/lib/avatax/client/customers.rb +26 -26
  26. data/lib/avatax/client/datasources.rb +12 -12
  27. data/lib/avatax/client/definitions.rb +73 -73
  28. data/lib/avatax/client/distancethresholds.rb +12 -12
  29. data/lib/avatax/client/ecms.rb +73 -73
  30. data/lib/avatax/client/ecommercetoken.rb +4 -4
  31. data/lib/avatax/client/errortransactions.rb +61 -61
  32. data/lib/avatax/client/firmclientlinkages.rb +17 -17
  33. data/lib/avatax/client/free.rb +1 -1
  34. data/lib/avatax/client/fundingrequests.rb +4 -4
  35. data/lib/avatax/client/items.rb +64 -64
  36. data/lib/avatax/client/jurisdictionoverrides.rb +12 -12
  37. data/lib/avatax/client/locations.rb +24 -24
  38. data/lib/avatax/client/multidocument.rb +20 -20
  39. data/lib/avatax/client/nexus.rb +30 -30
  40. data/lib/avatax/client/notices.rb +8 -8
  41. data/lib/avatax/client/notifications.rb +6 -6
  42. data/lib/avatax/client/onboarding.rb +55 -55
  43. data/lib/avatax/client/pointofsale.rb +21 -21
  44. data/lib/avatax/client/provisioning.rb +4 -4
  45. data/lib/avatax/client/registrar.rb +19 -19
  46. data/lib/avatax/client/reports.rb +7 -7
  47. data/lib/avatax/client/settings.rb +12 -12
  48. data/lib/avatax/client/subscriptions.rb +6 -6
  49. data/lib/avatax/client/taxcodes.rb +12 -12
  50. data/lib/avatax/client/taxcontent.rb +8 -8
  51. data/lib/avatax/client/taxprofiles.rb +42 -42
  52. data/lib/avatax/client/taxrules.rb +12 -12
  53. data/lib/avatax/client/transactions.rb +41 -41
  54. data/lib/avatax/client/upcs.rb +12 -12
  55. data/lib/avatax/client/userdefinedfields.rb +6 -6
  56. data/lib/avatax/client/users.rb +16 -16
  57. data/lib/avatax/client/utilities.rb +3 -3
  58. data/lib/avatax/client.rb +37 -37
  59. data/lib/avatax/configuration.rb +76 -76
  60. data/lib/avatax/connection.rb +53 -53
  61. data/lib/avatax/request.rb +51 -51
  62. data/lib/avatax/version.rb +3 -3
  63. data/lib/avatax.rb +26 -26
  64. data/spec/avatax/client/accounts_spec.rb +13 -13
  65. data/spec/avatax/client/transactions_spec.rb +80 -80
  66. data/spec/avatax/request_spec.rb +25 -25
  67. data/spec/avatax_spec.rb +45 -45
  68. data/spec/credentials.yaml.example +4 -4
  69. data/spec/fixtures/accounts.json +15 -15
  70. data/spec/spec_helper.rb +27 -27
  71. metadata +6 -6
  72. data/.travis.yml +0 -19
@@ -24,7 +24,7 @@ module AvaTax
24
24
  # @param hsCode [String] The partial or full HS Code for which you would like to view all of the parents.
25
25
  # @return [FetchResult]
26
26
  def get_cross_border_code(country, hsCode) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}/hierarchy"
27
- get(path, {}, "22.5.0") end
27
+ get(path, {}, "22.6.1") end
28
28
 
29
29
  # Test whether a form supports online login verification
30
30
  #
@@ -38,7 +38,7 @@ module AvaTax
38
38
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
39
39
  # @return [FetchResult]
40
40
  def get_login_verifier_by_form(form, options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers/#{form}"
41
- get(path, options, "22.5.0") end
41
+ get(path, options, "22.6.1") end
42
42
 
43
43
  # List all market place locations.
44
44
  #
@@ -50,7 +50,7 @@ module AvaTax
50
50
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
51
51
  # @return [FetchResult]
52
52
  def list_all_marketplace_locations(options={}) path = "/api/v2/definitions/listallmarketplacelocations"
53
- get(path, options, "22.5.0") end
53
+ get(path, options, "22.6.1") end
54
54
 
55
55
  # Retrieve the full list of the AvaFile Forms available
56
56
  #
@@ -67,7 +67,7 @@ module AvaTax
67
67
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
68
68
  # @return [FetchResult]
69
69
  def list_ava_file_forms(options={}) path = "/api/v2/definitions/avafileforms"
70
- get(path, options, "22.5.0") end
70
+ get(path, options, "22.6.1") end
71
71
 
72
72
  # List certificate attributes used by a company
73
73
  #
@@ -86,7 +86,7 @@ module AvaTax
86
86
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
87
87
  # @return [FetchResult]
88
88
  def list_certificate_attributes(options={}) path = "/api/v2/definitions/certificateattributes"
89
- get(path, options, "22.5.0") end
89
+ get(path, options, "22.6.1") end
90
90
 
91
91
  # List the certificate exempt reasons defined by a company
92
92
  #
@@ -104,7 +104,7 @@ module AvaTax
104
104
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
105
105
  # @return [FetchResult]
106
106
  def list_certificate_exempt_reasons(options={}) path = "/api/v2/definitions/certificateexemptreasons"
107
- get(path, options, "22.5.0") end
107
+ get(path, options, "22.6.1") end
108
108
 
109
109
  # List certificate exposure zones used by a company
110
110
  #
@@ -122,7 +122,7 @@ module AvaTax
122
122
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
123
123
  # @return [FetchResult]
124
124
  def list_certificate_exposure_zones(options={}) path = "/api/v2/definitions/certificateexposurezones"
125
- get(path, options, "22.5.0") end
125
+ get(path, options, "22.6.1") end
126
126
 
127
127
  # Retrieve the full list of Avalara-supported usage of extra parameters for classification of a item.
128
128
  #
@@ -136,7 +136,7 @@ module AvaTax
136
136
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
137
137
  # @return [FetchResult]
138
138
  def list_classification_parameters_usage(options={}) path = "/api/v2/definitions/classification/parametersusage"
139
- get(path, options, "22.5.0") end
139
+ get(path, options, "22.6.1") end
140
140
 
141
141
  # Retrieve the full list of communications service types
142
142
  #
@@ -149,7 +149,7 @@ module AvaTax
149
149
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
150
150
  # @return [FetchResult]
151
151
  def list_communications_service_types(id, options={}) path = "/api/v2/definitions/communications/transactiontypes/#{id}/servicetypes"
152
- get(path, options, "22.5.0") end
152
+ get(path, options, "22.6.1") end
153
153
 
154
154
  # Retrieve the full list of communications transactiontypes
155
155
  #
@@ -162,7 +162,7 @@ module AvaTax
162
162
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
163
163
  # @return [FetchResult]
164
164
  def list_communications_transaction_types(options={}) path = "/api/v2/definitions/communications/transactiontypes"
165
- get(path, options, "22.5.0") end
165
+ get(path, options, "22.6.1") end
166
166
 
167
167
  # Retrieve the full list of communications transaction/service type pairs
168
168
  #
@@ -175,7 +175,7 @@ module AvaTax
175
175
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
176
176
  # @return [FetchResult]
177
177
  def list_communications_t_s_pairs(options={}) path = "/api/v2/definitions/communications/tspairs"
178
- get(path, options, "22.5.0") end
178
+ get(path, options, "22.6.1") end
179
179
 
180
180
  # List all ISO 3166 countries
181
181
  #
@@ -189,7 +189,7 @@ module AvaTax
189
189
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
190
190
  # @return [FetchResult]
191
191
  def list_countries(options={}) path = "/api/v2/definitions/countries"
192
- get(path, options, "22.5.0") end
192
+ get(path, options, "22.6.1") end
193
193
 
194
194
  # List certificate exposure zones used by a company
195
195
  #
@@ -208,7 +208,7 @@ module AvaTax
208
208
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
209
209
  # @return [FetchResult]
210
210
  def list_cover_letters(options={}) path = "/api/v2/definitions/coverletters"
211
- get(path, options, "22.5.0") end
211
+ get(path, options, "22.6.1") end
212
212
 
213
213
  # Lists the next level of HS Codes given a destination country and HS Code prefix.
214
214
  #
@@ -233,7 +233,7 @@ module AvaTax
233
233
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
234
234
  # @return [FetchResult]
235
235
  def list_cross_border_codes(country, hsCode, options={}) path = "/api/v2/definitions/crossborder/#{country}/#{hsCode}"
236
- get(path, options, "22.5.0") end
236
+ get(path, options, "22.6.1") end
237
237
 
238
238
  # List top level HS Code Sections.
239
239
  #
@@ -250,7 +250,7 @@ module AvaTax
250
250
  # Swagger Name: AvaTaxClient
251
251
  # @return [FetchResult]
252
252
  def list_cross_border_sections() path = "/api/v2/definitions/crossborder/sections"
253
- get(path, {}, "22.5.0") end
253
+ get(path, {}, "22.6.1") end
254
254
 
255
255
  # List all ISO 4217 currencies supported by AvaTax.
256
256
  #
@@ -265,7 +265,7 @@ module AvaTax
265
265
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
266
266
  # @return [FetchResult]
267
267
  def list_currencies(options={}) path = "/api/v2/definitions/currencies"
268
- get(path, options, "22.5.0") end
268
+ get(path, options, "22.6.1") end
269
269
 
270
270
  # Retrieve the full list of Avalara-supported entity use codes
271
271
  #
@@ -281,7 +281,7 @@ module AvaTax
281
281
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
282
282
  # @return [FetchResult]
283
283
  def list_entity_use_codes(options={}) path = "/api/v2/definitions/entityusecodes"
284
- get(path, options, "22.5.0") end
284
+ get(path, options, "22.6.1") end
285
285
 
286
286
  # Retrieve the full list of Avalara-supported filing frequencies.
287
287
  #
@@ -294,7 +294,7 @@ module AvaTax
294
294
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
295
295
  # @return [FetchResult]
296
296
  def list_filing_frequencies(options={}) path = "/api/v2/definitions/filingfrequencies"
297
- get(path, options, "22.5.0") end
297
+ get(path, options, "22.6.1") end
298
298
 
299
299
  # List jurisdictions based on the filter provided
300
300
  #
@@ -311,7 +311,7 @@ module AvaTax
311
311
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
312
312
  # @return [FetchResult]
313
313
  def list_jurisdictions(options={}) path = "/api/v2/definitions/jurisdictions"
314
- get(path, options, "22.5.0") end
314
+ get(path, options, "22.6.1") end
315
315
 
316
316
  # List jurisdictions near a specific address
317
317
  #
@@ -336,7 +336,7 @@ module AvaTax
336
336
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
337
337
  # @return [FetchResult]
338
338
  def list_jurisdictions_by_address(options={}) path = "/api/v2/definitions/jurisdictionsnearaddress"
339
- get(path, options, "22.5.0") end
339
+ get(path, options, "22.6.1") end
340
340
 
341
341
  # List jurisdictions based on the TaxType, TaxSubType and RateType provided
342
342
  #
@@ -357,7 +357,7 @@ module AvaTax
357
357
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
358
358
  # @return [FetchResult]
359
359
  def list_jurisdictions_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
360
- get(path, options, "22.5.0") end
360
+ get(path, options, "22.6.1") end
361
361
 
362
362
  # Retrieve the list of questions that are required for a tax location
363
363
  #
@@ -383,7 +383,7 @@ module AvaTax
383
383
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
384
384
  # @return [FetchResult]
385
385
  def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
386
- get(path, options, "22.5.0") end
386
+ get(path, options, "22.6.1") end
387
387
 
388
388
  # List all forms where logins can be verified automatically
389
389
  #
@@ -397,7 +397,7 @@ module AvaTax
397
397
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
398
398
  # @return [FetchResult]
399
399
  def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
400
- get(path, options, "22.5.0") end
400
+ get(path, options, "22.6.1") end
401
401
 
402
402
  # Retrieve the list of locations for a marketplace.
403
403
  #
@@ -409,7 +409,7 @@ module AvaTax
409
409
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
410
410
  # @return [FetchResult]
411
411
  def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
412
- get(path, options, "22.5.0") end
412
+ get(path, options, "22.6.1") end
413
413
 
414
414
  # Retrieve the full list of Avalara-supported nexus for all countries and regions.
415
415
  #
@@ -423,7 +423,7 @@ module AvaTax
423
423
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
424
424
  # @return [FetchResult]
425
425
  def list_nexus(options={}) path = "/api/v2/definitions/nexus"
426
- get(path, options, "22.5.0") end
426
+ get(path, options, "22.6.1") end
427
427
 
428
428
  # List all nexus that apply to a specific address.
429
429
  #
@@ -446,7 +446,7 @@ module AvaTax
446
446
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
447
447
  # @return [FetchResult]
448
448
  def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
449
- get(path, options, "22.5.0") end
449
+ get(path, options, "22.6.1") end
450
450
 
451
451
  # Retrieve the full list of Avalara-supported nexus for a country.
452
452
  #
@@ -461,7 +461,7 @@ module AvaTax
461
461
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
462
462
  # @return [FetchResult]
463
463
  def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
464
- get(path, options, "22.5.0") end
464
+ get(path, options, "22.6.1") end
465
465
 
466
466
  # Retrieve the full list of Avalara-supported nexus for a country and region.
467
467
  #
@@ -477,7 +477,7 @@ module AvaTax
477
477
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
478
478
  # @return [FetchResult]
479
479
  def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
480
- get(path, options, "22.5.0") end
480
+ get(path, options, "22.6.1") end
481
481
 
482
482
  # List nexus related to a tax form
483
483
  #
@@ -495,12 +495,12 @@ module AvaTax
495
495
  #
496
496
  # ### Security Policies
497
497
  #
498
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
498
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
499
499
  # Swagger Name: AvaTaxClient
500
500
  # @param formCode [String] The form code that we are looking up the nexus for
501
501
  # @return [Object]
502
502
  def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
503
- get(path, {}, "22.5.0") end
503
+ get(path, {}, "22.6.1") end
504
504
 
505
505
  # Retrieve the full list of Avalara-supported nexus for a tax type group.
506
506
  #
@@ -515,7 +515,7 @@ module AvaTax
515
515
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
516
516
  # @return [FetchResult]
517
517
  def list_nexus_by_tax_type_group(taxTypeGroup, options={}) path = "/api/v2/definitions/nexus/bytaxtypegroup/#{taxTypeGroup}"
518
- get(path, options, "22.5.0") end
518
+ get(path, options, "22.6.1") end
519
519
 
520
520
  # Retrieve the full list of nexus tax type groups
521
521
  #
@@ -528,7 +528,7 @@ module AvaTax
528
528
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
529
529
  # @return [FetchResult]
530
530
  def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
531
- get(path, options, "22.5.0") end
531
+ get(path, options, "22.6.1") end
532
532
 
533
533
  # Retrieve the full list of Avalara-supported tax notice customer funding options.
534
534
  #
@@ -541,7 +541,7 @@ module AvaTax
541
541
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
542
542
  # @return [FetchResult]
543
543
  def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
544
- get(path, options, "22.5.0") end
544
+ get(path, options, "22.6.1") end
545
545
 
546
546
  # Retrieve the full list of Avalara-supported tax notice customer types.
547
547
  #
@@ -554,7 +554,7 @@ module AvaTax
554
554
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
555
555
  # @return [FetchResult]
556
556
  def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
557
- get(path, options, "22.5.0") end
557
+ get(path, options, "22.6.1") end
558
558
 
559
559
  # Retrieve the full list of Avalara-supported tax notice filing types.
560
560
  #
@@ -567,7 +567,7 @@ module AvaTax
567
567
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
568
568
  # @return [FetchResult]
569
569
  def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
570
- get(path, options, "22.5.0") end
570
+ get(path, options, "22.6.1") end
571
571
 
572
572
  # Retrieve the full list of Avalara-supported tax notice priorities.
573
573
  #
@@ -580,7 +580,7 @@ module AvaTax
580
580
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
581
581
  # @return [FetchResult]
582
582
  def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
583
- get(path, options, "22.5.0") end
583
+ get(path, options, "22.6.1") end
584
584
 
585
585
  # Retrieve the full list of Avalara-supported tax notice reasons.
586
586
  #
@@ -593,7 +593,7 @@ module AvaTax
593
593
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
594
594
  # @return [FetchResult]
595
595
  def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
596
- get(path, options, "22.5.0") end
596
+ get(path, options, "22.6.1") end
597
597
 
598
598
  # Retrieve the full list of Avalara-supported tax notice responsibility ids
599
599
  #
@@ -606,7 +606,7 @@ module AvaTax
606
606
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
607
607
  # @return [FetchResult]
608
608
  def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
609
- get(path, options, "22.5.0") end
609
+ get(path, options, "22.6.1") end
610
610
 
611
611
  # Retrieve the full list of Avalara-supported tax notice root causes
612
612
  #
@@ -619,7 +619,7 @@ module AvaTax
619
619
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
620
620
  # @return [FetchResult]
621
621
  def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
622
- get(path, options, "22.5.0") end
622
+ get(path, options, "22.6.1") end
623
623
 
624
624
  # Retrieve the full list of Avalara-supported tax notice statuses.
625
625
  #
@@ -632,7 +632,7 @@ module AvaTax
632
632
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
633
633
  # @return [FetchResult]
634
634
  def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
635
- get(path, options, "22.5.0") end
635
+ get(path, options, "22.6.1") end
636
636
 
637
637
  # Retrieve the full list of Avalara-supported tax notice types.
638
638
  #
@@ -645,7 +645,7 @@ module AvaTax
645
645
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
646
646
  # @return [FetchResult]
647
647
  def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
648
- get(path, options, "22.5.0") end
648
+ get(path, options, "22.6.1") end
649
649
 
650
650
  # Retrieve the full list of Avalara-supported extra parameters for creating transactions.
651
651
  #
@@ -659,7 +659,7 @@ module AvaTax
659
659
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
660
660
  # @return [FetchResult]
661
661
  def list_parameters(options={}) path = "/api/v2/definitions/parameters"
662
- get(path, options, "22.5.0") end
662
+ get(path, options, "22.6.1") end
663
663
 
664
664
  # Retrieve the parameters by companyCode and itemCode.
665
665
  #
@@ -680,7 +680,7 @@ module AvaTax
680
680
  #
681
681
  # ### Security Policies
682
682
  #
683
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
683
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
684
684
  # Swagger Name: AvaTaxClient
685
685
  # @param companyCode [String] Company code.
686
686
  # @param itemCode [String] Item code.
@@ -690,7 +690,7 @@ module AvaTax
690
690
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
691
691
  # @return [FetchResult]
692
692
  def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
693
- get(path, options, "22.5.0") end
693
+ get(path, options, "22.6.1") end
694
694
 
695
695
  # Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
696
696
  #
@@ -704,7 +704,7 @@ module AvaTax
704
704
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
705
705
  # @return [FetchResult]
706
706
  def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
707
- get(path, options, "22.5.0") end
707
+ get(path, options, "22.6.1") end
708
708
 
709
709
  # Retrieve the full list of Avalara-supported permissions
710
710
  #
@@ -715,7 +715,7 @@ module AvaTax
715
715
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
716
716
  # @return [FetchResult]
717
717
  def list_permissions(options={}) path = "/api/v2/definitions/permissions"
718
- get(path, options, "22.5.0") end
718
+ get(path, options, "22.6.1") end
719
719
 
720
720
  # Retrieve the full list of Avalara-supported postal codes.
721
721
  #
@@ -727,7 +727,7 @@ module AvaTax
727
727
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
728
728
  # @return [FetchResult]
729
729
  def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
730
- get(path, options, "22.5.0") end
730
+ get(path, options, "22.6.1") end
731
731
 
732
732
  # List all customs duty programs recognized by AvaTax
733
733
  #
@@ -747,7 +747,7 @@ module AvaTax
747
747
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
748
748
  # @return [FetchResult]
749
749
  def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
750
- get(path, options, "22.5.0") end
750
+ get(path, options, "22.6.1") end
751
751
 
752
752
  # List all available product classification systems.
753
753
  #
@@ -763,7 +763,7 @@ module AvaTax
763
763
  # @param countryCode [String] If not null, return all records with this code.
764
764
  # @return [FetchResult]
765
765
  def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
766
- get(path, options, "22.5.0") end
766
+ get(path, options, "22.6.1") end
767
767
 
768
768
  # List all product classification systems available to a company based on its nexus.
769
769
  #
@@ -788,7 +788,7 @@ module AvaTax
788
788
  # @param countryCode [String] If not null, return all records with this code.
789
789
  # @return [FetchResult]
790
790
  def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
791
- get(path, options, "22.5.0") end
791
+ get(path, options, "22.6.1") end
792
792
 
793
793
  # Retrieve the full list of rate types for each country
794
794
  #
@@ -802,7 +802,7 @@ module AvaTax
802
802
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
803
803
  # @return [FetchResult]
804
804
  def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
805
- get(path, options, "22.5.0") end
805
+ get(path, options, "22.6.1") end
806
806
 
807
807
  # Retrieve the list of rate types by country, TaxType and by TaxSubType
808
808
  #
@@ -818,7 +818,7 @@ module AvaTax
818
818
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
819
819
  # @return [FetchResult]
820
820
  def list_rate_types_by_country_tax_type_tax_sub_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}/ratetypes"
821
- get(path, options, "22.5.0") end
821
+ get(path, options, "22.6.1") end
822
822
 
823
823
  # List all ISO 3166 regions
824
824
  #
@@ -832,7 +832,7 @@ module AvaTax
832
832
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
833
833
  # @return [FetchResult]
834
834
  def list_regions(options={}) path = "/api/v2/definitions/regions"
835
- get(path, options, "22.5.0") end
835
+ get(path, options, "22.6.1") end
836
836
 
837
837
  # List all ISO 3166 regions for a country
838
838
  #
@@ -847,7 +847,7 @@ module AvaTax
847
847
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
848
848
  # @return [FetchResult]
849
849
  def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
850
- get(path, options, "22.5.0") end
850
+ get(path, options, "22.6.1") end
851
851
 
852
852
  # Retrieve the full list of Avalara-supported resource file types
853
853
  #
@@ -860,7 +860,7 @@ module AvaTax
860
860
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
861
861
  # @return [FetchResult]
862
862
  def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
863
- get(path, options, "22.5.0") end
863
+ get(path, options, "22.6.1") end
864
864
 
865
865
  # Retrieve the full list of Avalara-supported usage of parameters used for returns.
866
866
  #
@@ -874,7 +874,7 @@ module AvaTax
874
874
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
875
875
  # @return [FetchResult]
876
876
  def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
877
- get(path, options, "22.5.0") end
877
+ get(path, options, "22.6.1") end
878
878
 
879
879
  # Retrieve the full list of Avalara-supported permissions
880
880
  #
@@ -888,7 +888,7 @@ module AvaTax
888
888
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
889
889
  # @return [FetchResult]
890
890
  def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
891
- get(path, options, "22.5.0") end
891
+ get(path, options, "22.6.1") end
892
892
 
893
893
  # Retrieve the full list of Avalara-supported subscription types
894
894
  #
@@ -903,7 +903,7 @@ module AvaTax
903
903
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
904
904
  # @return [FetchResult]
905
905
  def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
906
- get(path, options, "22.5.0") end
906
+ get(path, options, "22.6.1") end
907
907
 
908
908
  # Retrieve the list all tags supported by avalara
909
909
  #
@@ -915,7 +915,7 @@ module AvaTax
915
915
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
916
916
  # @return [FetchResult]
917
917
  def list_tags(options={}) path = "/api/v2/definitions/tags"
918
- get(path, options, "22.5.0") end
918
+ get(path, options, "22.6.1") end
919
919
 
920
920
  # Retrieve the full list of Avalara-supported tax authorities.
921
921
  #
@@ -928,7 +928,7 @@ module AvaTax
928
928
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
929
929
  # @return [FetchResult]
930
930
  def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
931
- get(path, options, "22.5.0") end
931
+ get(path, options, "22.6.1") end
932
932
 
933
933
  # Retrieve the full list of Avalara-supported forms for each tax authority.
934
934
  #
@@ -943,7 +943,7 @@ module AvaTax
943
943
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
944
944
  # @return [FetchResult]
945
945
  def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
946
- get(path, options, "22.5.0") end
946
+ get(path, options, "22.6.1") end
947
947
 
948
948
  # Retrieve the full list of Avalara-supported tax authority types.
949
949
  #
@@ -956,7 +956,7 @@ module AvaTax
956
956
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
957
957
  # @return [FetchResult]
958
958
  def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
959
- get(path, options, "22.5.0") end
959
+ get(path, options, "22.6.1") end
960
960
 
961
961
  # Retrieve the full list of Avalara-supported tax codes.
962
962
  #
@@ -968,7 +968,7 @@ module AvaTax
968
968
  #
969
969
  # ### Security Policies
970
970
  #
971
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
971
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
972
972
  # Swagger Name: AvaTaxClient
973
973
  # @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/).
974
974
  # @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.
@@ -976,7 +976,7 @@ module AvaTax
976
976
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
977
977
  # @return [FetchResult]
978
978
  def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
979
- get(path, options, "22.5.0") end
979
+ get(path, options, "22.6.1") end
980
980
 
981
981
  # Retrieve the full list of Avalara-supported tax code types.
982
982
  #
@@ -988,7 +988,7 @@ module AvaTax
988
988
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
989
989
  # @return [Object]
990
990
  def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
991
- get(path, options, "22.5.0") end
991
+ get(path, options, "22.6.1") end
992
992
 
993
993
  # Retrieve the full list of the Tax Forms available
994
994
  #
@@ -1001,7 +1001,7 @@ module AvaTax
1001
1001
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1002
1002
  # @return [FetchResult]
1003
1003
  def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
1004
- get(path, options, "22.5.0") end
1004
+ get(path, options, "22.6.1") end
1005
1005
 
1006
1006
  # Retrieve the full list of tax sub types
1007
1007
  #
@@ -1014,7 +1014,7 @@ module AvaTax
1014
1014
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1015
1015
  # @return [FetchResult]
1016
1016
  def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
1017
- get(path, options, "22.5.0") end
1017
+ get(path, options, "22.6.1") end
1018
1018
 
1019
1019
  # Retrieve the full list of tax sub types by Country and TaxType
1020
1020
  #
@@ -1029,7 +1029,7 @@ module AvaTax
1029
1029
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1030
1030
  # @return [FetchResult]
1031
1031
  def list_tax_sub_types_by_country_and_tax_type(country, taxTypeId, options={}) path = "/api/v2/definitions/taxsubtypes/countries/#{country}/taxtypes/#{taxTypeId}"
1032
- get(path, options, "22.5.0") end
1032
+ get(path, options, "22.6.1") end
1033
1033
 
1034
1034
  # Retrieve the full list of tax sub types by jurisdiction code and region
1035
1035
  #
@@ -1044,7 +1044,7 @@ module AvaTax
1044
1044
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1045
1045
  # @return [FetchResult]
1046
1046
  def list_tax_sub_types_by_jurisdiction_and_region(jurisdictionCode, region, options={}) path = "/api/v2/definitions/taxsubtypes/#{jurisdictionCode}/#{region}"
1047
- get(path, options, "22.5.0") end
1047
+ get(path, options, "22.6.1") end
1048
1048
 
1049
1049
  # Retrieve the full list of tax type groups
1050
1050
  #
@@ -1057,7 +1057,7 @@ module AvaTax
1057
1057
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1058
1058
  # @return [FetchResult]
1059
1059
  def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
1060
- get(path, options, "22.5.0") end
1060
+ get(path, options, "22.6.1") end
1061
1061
 
1062
1062
  # Retrieve the list of applicable TaxTypes
1063
1063
  #
@@ -1070,7 +1070,7 @@ module AvaTax
1070
1070
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1071
1071
  # @return [FetchResult]
1072
1072
  def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
1073
- get(path, options, "22.5.0") end
1073
+ get(path, options, "22.6.1") end
1074
1074
 
1075
1075
  # Retrieve the list of applicable UnitOfBasis
1076
1076
  #
@@ -1085,7 +1085,7 @@ module AvaTax
1085
1085
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1086
1086
  # @return [FetchResult]
1087
1087
  def list_unit_of_basis_by_country_and_tax_type_and_tax_sub_type_and_rate_type(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/unitofbasis/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
1088
- get(path, options, "22.5.0") end
1088
+ get(path, options, "22.6.1") end
1089
1089
 
1090
1090
  # List all defined units of measurement
1091
1091
  #
@@ -1099,7 +1099,7 @@ module AvaTax
1099
1099
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1100
1100
  # @return [FetchResult]
1101
1101
  def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
1102
- get(path, options, "22.5.0") end
1102
+ get(path, options, "22.6.1") end
1103
1103
  end
1104
1104
  end
1105
1105
  end