avatax 22.3.0 → 22.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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 +47 -45
  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 +90 -75
  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 +10 -6
  35. data/lib/avatax/client/items.rb +86 -62
  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 +20 -20
  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 -49
  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.3.0") end
27
+ get(path, {}, "22.7.0") 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.3.0") end
41
+ get(path, options, "22.7.0") 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.3.0") end
53
+ get(path, options, "22.7.0") 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.3.0") end
70
+ get(path, options, "22.7.0") 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.3.0") end
89
+ get(path, options, "22.7.0") 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.3.0") end
107
+ get(path, options, "22.7.0") 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.3.0") end
125
+ get(path, options, "22.7.0") 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.3.0") end
139
+ get(path, options, "22.7.0") 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.3.0") end
152
+ get(path, options, "22.7.0") 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.3.0") end
165
+ get(path, options, "22.7.0") 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.3.0") end
178
+ get(path, options, "22.7.0") 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.3.0") end
192
+ get(path, options, "22.7.0") 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.3.0") end
211
+ get(path, options, "22.7.0") 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.3.0") end
236
+ get(path, options, "22.7.0") 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.3.0") end
253
+ get(path, {}, "22.7.0") 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.3.0") end
268
+ get(path, options, "22.7.0") 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.3.0") end
284
+ get(path, options, "22.7.0") 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.3.0") end
297
+ get(path, options, "22.7.0") 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.3.0") end
314
+ get(path, options, "22.7.0") end
315
315
 
316
316
  # List jurisdictions near a specific address
317
317
  #
@@ -336,11 +336,13 @@ 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.3.0") end
339
+ get(path, options, "22.7.0") end
340
340
 
341
- # List jurisdictions based on the TaxType, TaxSubType and RateType provided
341
+ # List jurisdictions based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId
342
342
  #
343
- # Returns a list of all Avalara-supported taxing jurisdictions filtered by TaxType, TaxSubType and RateType.
343
+ # Returns a list of all Avalara-supported taxing jurisdictions filtered by taxTypeId, taxSubTypeId, country, and rateTypeId.
344
+ #
345
+ # You can optionally pass region as a query parameter to retrieve jurisdictions that are under that region.
344
346
  #
345
347
  # This API allows you to examine all Avalara-supported jurisdictions. You can filter your search by supplying
346
348
  # SQL-like query for fetching only the ones you concerned about. For example: effectiveDate > '2016-01-01'
@@ -351,13 +353,26 @@ module AvaTax
351
353
  # @param taxTypeId [String] The taxtype for which you want to retrieve the jurisdiction information
352
354
  # @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the jurisdiction information
353
355
  # @param rateTypeId [String] The ratetype for which you want to retrieve the jurisdiction information
356
+ # @param region [String] The region for which you want to retrieve the jurisdiction information
354
357
  # @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:* id, country, state, jurisdictionCode, longName, taxTypeId, taxSubTypeId, taxTypeGroupId, rateTypeId
355
358
  # @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.
356
359
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
357
360
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
358
361
  # @return [FetchResult]
359
362
  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.3.0") end
363
+ get(path, options, "22.7.0") end
364
+
365
+ # List jurisdiction types based on the provided taxTypeId, taxSubTypeId, country, and rateTypeId
366
+ #
367
+ # Returns a list of all applicable jurisdiction types based on country, taxTypeId, taxSubTypeId, and rateTypeId
368
+ # Swagger Name: AvaTaxClient
369
+ # @param country [String] The country for which you want to retrieve the jurisdiction information
370
+ # @param taxTypeId [String] The taxtype for which you want to retrieve the jurisdiction information
371
+ # @param taxSubTypeId [String] The taxsubtype for which you want to retrieve the jurisdiction information
372
+ # @param rateTypeId [String] The ratetype for which you want to retrieve the jurisdiction information
373
+ # @return [string[]]
374
+ def list_jurisdiction_types_by_rate_type_tax_type_mapping(country, taxTypeId, taxSubTypeId, options={}) path = "/api/v2/definitions/jurisdictionTypes/countries/#{country}/taxtypes/#{taxTypeId}/taxsubtypes/#{taxSubTypeId}"
375
+ get(path, options, "22.7.0") end
361
376
 
362
377
  # Retrieve the list of questions that are required for a tax location
363
378
  #
@@ -383,7 +398,7 @@ module AvaTax
383
398
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
384
399
  # @return [FetchResult]
385
400
  def list_location_questions_by_address(options={}) path = "/api/v2/definitions/locationquestions"
386
- get(path, options, "22.3.0") end
401
+ get(path, options, "22.7.0") end
387
402
 
388
403
  # List all forms where logins can be verified automatically
389
404
  #
@@ -397,7 +412,7 @@ module AvaTax
397
412
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
398
413
  # @return [FetchResult]
399
414
  def list_login_verifiers(options={}) path = "/api/v2/definitions/filingcalendars/loginverifiers"
400
- get(path, options, "22.3.0") end
415
+ get(path, options, "22.7.0") end
401
416
 
402
417
  # Retrieve the list of locations for a marketplace.
403
418
  #
@@ -409,7 +424,7 @@ module AvaTax
409
424
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
410
425
  # @return [FetchResult]
411
426
  def list_marketplace_locations(options={}) path = "/api/v2/definitions/marketplacelocations"
412
- get(path, options, "22.3.0") end
427
+ get(path, options, "22.7.0") end
413
428
 
414
429
  # Retrieve the full list of Avalara-supported nexus for all countries and regions.
415
430
  #
@@ -423,7 +438,7 @@ module AvaTax
423
438
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
424
439
  # @return [FetchResult]
425
440
  def list_nexus(options={}) path = "/api/v2/definitions/nexus"
426
- get(path, options, "22.3.0") end
441
+ get(path, options, "22.7.0") end
427
442
 
428
443
  # List all nexus that apply to a specific address.
429
444
  #
@@ -446,7 +461,7 @@ module AvaTax
446
461
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
447
462
  # @return [FetchResult]
448
463
  def list_nexus_by_address(options={}) path = "/api/v2/definitions/nexus/byaddress"
449
- get(path, options, "22.3.0") end
464
+ get(path, options, "22.7.0") end
450
465
 
451
466
  # Retrieve the full list of Avalara-supported nexus for a country.
452
467
  #
@@ -461,7 +476,7 @@ module AvaTax
461
476
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
462
477
  # @return [FetchResult]
463
478
  def list_nexus_by_country(country, options={}) path = "/api/v2/definitions/nexus/#{country}"
464
- get(path, options, "22.3.0") end
479
+ get(path, options, "22.7.0") end
465
480
 
466
481
  # Retrieve the full list of Avalara-supported nexus for a country and region.
467
482
  #
@@ -477,7 +492,7 @@ module AvaTax
477
492
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
478
493
  # @return [FetchResult]
479
494
  def list_nexus_by_country_and_region(country, region, options={}) path = "/api/v2/definitions/nexus/#{country}/#{region}"
480
- get(path, options, "22.3.0") end
495
+ get(path, options, "22.7.0") end
481
496
 
482
497
  # List nexus related to a tax form
483
498
  #
@@ -495,12 +510,12 @@ module AvaTax
495
510
  #
496
511
  # ### Security Policies
497
512
  #
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.
513
+ # * 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
514
  # Swagger Name: AvaTaxClient
500
515
  # @param formCode [String] The form code that we are looking up the nexus for
501
516
  # @return [Object]
502
517
  def list_nexus_by_form_code(formCode) path = "/api/v2/definitions/nexus/byform/#{formCode}"
503
- get(path, {}, "22.3.0") end
518
+ get(path, {}, "22.7.0") end
504
519
 
505
520
  # Retrieve the full list of Avalara-supported nexus for a tax type group.
506
521
  #
@@ -515,7 +530,7 @@ module AvaTax
515
530
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
516
531
  # @return [FetchResult]
517
532
  def list_nexus_by_tax_type_group(taxTypeGroup, options={}) path = "/api/v2/definitions/nexus/bytaxtypegroup/#{taxTypeGroup}"
518
- get(path, options, "22.3.0") end
533
+ get(path, options, "22.7.0") end
519
534
 
520
535
  # Retrieve the full list of nexus tax type groups
521
536
  #
@@ -528,7 +543,7 @@ module AvaTax
528
543
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
529
544
  # @return [FetchResult]
530
545
  def list_nexus_tax_type_groups(options={}) path = "/api/v2/definitions/nexustaxtypegroups"
531
- get(path, options, "22.3.0") end
546
+ get(path, options, "22.7.0") end
532
547
 
533
548
  # Retrieve the full list of Avalara-supported tax notice customer funding options.
534
549
  #
@@ -541,7 +556,7 @@ module AvaTax
541
556
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
542
557
  # @return [FetchResult]
543
558
  def list_notice_customer_funding_options(options={}) path = "/api/v2/definitions/noticecustomerfundingoptions"
544
- get(path, options, "22.3.0") end
559
+ get(path, options, "22.7.0") end
545
560
 
546
561
  # Retrieve the full list of Avalara-supported tax notice customer types.
547
562
  #
@@ -554,7 +569,7 @@ module AvaTax
554
569
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
555
570
  # @return [FetchResult]
556
571
  def list_notice_customer_types(options={}) path = "/api/v2/definitions/noticecustomertypes"
557
- get(path, options, "22.3.0") end
572
+ get(path, options, "22.7.0") end
558
573
 
559
574
  # Retrieve the full list of Avalara-supported tax notice filing types.
560
575
  #
@@ -567,7 +582,7 @@ module AvaTax
567
582
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
568
583
  # @return [FetchResult]
569
584
  def list_notice_filingtypes(options={}) path = "/api/v2/definitions/noticefilingtypes"
570
- get(path, options, "22.3.0") end
585
+ get(path, options, "22.7.0") end
571
586
 
572
587
  # Retrieve the full list of Avalara-supported tax notice priorities.
573
588
  #
@@ -580,7 +595,7 @@ module AvaTax
580
595
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
581
596
  # @return [FetchResult]
582
597
  def list_notice_priorities(options={}) path = "/api/v2/definitions/noticepriorities"
583
- get(path, options, "22.3.0") end
598
+ get(path, options, "22.7.0") end
584
599
 
585
600
  # Retrieve the full list of Avalara-supported tax notice reasons.
586
601
  #
@@ -593,7 +608,7 @@ module AvaTax
593
608
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
594
609
  # @return [FetchResult]
595
610
  def list_notice_reasons(options={}) path = "/api/v2/definitions/noticereasons"
596
- get(path, options, "22.3.0") end
611
+ get(path, options, "22.7.0") end
597
612
 
598
613
  # Retrieve the full list of Avalara-supported tax notice responsibility ids
599
614
  #
@@ -606,7 +621,7 @@ module AvaTax
606
621
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
607
622
  # @return [FetchResult]
608
623
  def list_notice_responsibilities(options={}) path = "/api/v2/definitions/noticeresponsibilities"
609
- get(path, options, "22.3.0") end
624
+ get(path, options, "22.7.0") end
610
625
 
611
626
  # Retrieve the full list of Avalara-supported tax notice root causes
612
627
  #
@@ -619,7 +634,7 @@ module AvaTax
619
634
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
620
635
  # @return [FetchResult]
621
636
  def list_notice_root_causes(options={}) path = "/api/v2/definitions/noticerootcauses"
622
- get(path, options, "22.3.0") end
637
+ get(path, options, "22.7.0") end
623
638
 
624
639
  # Retrieve the full list of Avalara-supported tax notice statuses.
625
640
  #
@@ -632,7 +647,7 @@ module AvaTax
632
647
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
633
648
  # @return [FetchResult]
634
649
  def list_notice_statuses(options={}) path = "/api/v2/definitions/noticestatuses"
635
- get(path, options, "22.3.0") end
650
+ get(path, options, "22.7.0") end
636
651
 
637
652
  # Retrieve the full list of Avalara-supported tax notice types.
638
653
  #
@@ -645,7 +660,7 @@ module AvaTax
645
660
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
646
661
  # @return [FetchResult]
647
662
  def list_notice_types(options={}) path = "/api/v2/definitions/noticetypes"
648
- get(path, options, "22.3.0") end
663
+ get(path, options, "22.7.0") end
649
664
 
650
665
  # Retrieve the full list of Avalara-supported extra parameters for creating transactions.
651
666
  #
@@ -659,7 +674,7 @@ module AvaTax
659
674
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
660
675
  # @return [FetchResult]
661
676
  def list_parameters(options={}) path = "/api/v2/definitions/parameters"
662
- get(path, options, "22.3.0") end
677
+ get(path, options, "22.7.0") end
663
678
 
664
679
  # Retrieve the parameters by companyCode and itemCode.
665
680
  #
@@ -680,7 +695,7 @@ module AvaTax
680
695
  #
681
696
  # ### Security Policies
682
697
  #
683
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
698
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
684
699
  # Swagger Name: AvaTaxClient
685
700
  # @param companyCode [String] Company code.
686
701
  # @param itemCode [String] Item code.
@@ -690,7 +705,7 @@ module AvaTax
690
705
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
691
706
  # @return [FetchResult]
692
707
  def list_parameters_by_item(companyCode, itemCode, options={}) path = "/api/v2/definitions/parameters/byitem/#{companyCode}/#{itemCode}"
693
- get(path, options, "22.3.0") end
708
+ get(path, options, "22.7.0") end
694
709
 
695
710
  # Retrieve the full list of Avalara-supported usage of extra parameters for creating transactions.
696
711
  #
@@ -704,7 +719,7 @@ module AvaTax
704
719
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
705
720
  # @return [FetchResult]
706
721
  def list_parameters_usage(options={}) path = "/api/v2/definitions/parametersusage"
707
- get(path, options, "22.3.0") end
722
+ get(path, options, "22.7.0") end
708
723
 
709
724
  # Retrieve the full list of Avalara-supported permissions
710
725
  #
@@ -715,7 +730,7 @@ module AvaTax
715
730
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
716
731
  # @return [FetchResult]
717
732
  def list_permissions(options={}) path = "/api/v2/definitions/permissions"
718
- get(path, options, "22.3.0") end
733
+ get(path, options, "22.7.0") end
719
734
 
720
735
  # Retrieve the full list of Avalara-supported postal codes.
721
736
  #
@@ -727,7 +742,7 @@ module AvaTax
727
742
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
728
743
  # @return [FetchResult]
729
744
  def list_postal_codes(options={}) path = "/api/v2/definitions/postalcodes"
730
- get(path, options, "22.3.0") end
745
+ get(path, options, "22.7.0") end
731
746
 
732
747
  # List all customs duty programs recognized by AvaTax
733
748
  #
@@ -747,7 +762,7 @@ module AvaTax
747
762
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
748
763
  # @return [FetchResult]
749
764
  def list_preferred_programs(options={}) path = "/api/v2/definitions/preferredprograms"
750
- get(path, options, "22.3.0") end
765
+ get(path, options, "22.7.0") end
751
766
 
752
767
  # List all available product classification systems.
753
768
  #
@@ -763,7 +778,7 @@ module AvaTax
763
778
  # @param countryCode [String] If not null, return all records with this code.
764
779
  # @return [FetchResult]
765
780
  def list_product_classification_systems(options={}) path = "/api/v2/definitions/productclassificationsystems"
766
- get(path, options, "22.3.0") end
781
+ get(path, options, "22.7.0") end
767
782
 
768
783
  # List all product classification systems available to a company based on its nexus.
769
784
  #
@@ -788,7 +803,7 @@ module AvaTax
788
803
  # @param countryCode [String] If not null, return all records with this code.
789
804
  # @return [FetchResult]
790
805
  def list_product_classification_systems_by_company(companyCode, options={}) path = "/api/v2/definitions/productclassificationsystems/bycompany/#{companyCode}"
791
- get(path, options, "22.3.0") end
806
+ get(path, options, "22.7.0") end
792
807
 
793
808
  # Retrieve the full list of rate types for each country
794
809
  #
@@ -802,7 +817,7 @@ module AvaTax
802
817
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
803
818
  # @return [FetchResult]
804
819
  def list_rate_types_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/ratetypes"
805
- get(path, options, "22.3.0") end
820
+ get(path, options, "22.7.0") end
806
821
 
807
822
  # Retrieve the list of rate types by country, TaxType and by TaxSubType
808
823
  #
@@ -818,7 +833,7 @@ module AvaTax
818
833
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
819
834
  # @return [FetchResult]
820
835
  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.3.0") end
836
+ get(path, options, "22.7.0") end
822
837
 
823
838
  # List all ISO 3166 regions
824
839
  #
@@ -832,7 +847,7 @@ module AvaTax
832
847
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
833
848
  # @return [FetchResult]
834
849
  def list_regions(options={}) path = "/api/v2/definitions/regions"
835
- get(path, options, "22.3.0") end
850
+ get(path, options, "22.7.0") end
836
851
 
837
852
  # List all ISO 3166 regions for a country
838
853
  #
@@ -847,7 +862,7 @@ module AvaTax
847
862
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
848
863
  # @return [FetchResult]
849
864
  def list_regions_by_country(country, options={}) path = "/api/v2/definitions/countries/#{country}/regions"
850
- get(path, options, "22.3.0") end
865
+ get(path, options, "22.7.0") end
851
866
 
852
867
  # Retrieve the full list of Avalara-supported resource file types
853
868
  #
@@ -860,7 +875,7 @@ module AvaTax
860
875
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
861
876
  # @return [FetchResult]
862
877
  def list_resource_file_types(options={}) path = "/api/v2/definitions/resourcefiletypes"
863
- get(path, options, "22.3.0") end
878
+ get(path, options, "22.7.0") end
864
879
 
865
880
  # Retrieve the full list of Avalara-supported usage of parameters used for returns.
866
881
  #
@@ -874,7 +889,7 @@ module AvaTax
874
889
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
875
890
  # @return [FetchResult]
876
891
  def list_returns_parameters_usage(options={}) path = "/api/v2/definitions/returns/parametersusage"
877
- get(path, options, "22.3.0") end
892
+ get(path, options, "22.7.0") end
878
893
 
879
894
  # Retrieve the full list of Avalara-supported permissions
880
895
  #
@@ -888,7 +903,7 @@ module AvaTax
888
903
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
889
904
  # @return [FetchResult]
890
905
  def list_security_roles(options={}) path = "/api/v2/definitions/securityroles"
891
- get(path, options, "22.3.0") end
906
+ get(path, options, "22.7.0") end
892
907
 
893
908
  # Retrieve the full list of Avalara-supported subscription types
894
909
  #
@@ -903,7 +918,7 @@ module AvaTax
903
918
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
904
919
  # @return [FetchResult]
905
920
  def list_subscription_types(options={}) path = "/api/v2/definitions/subscriptiontypes"
906
- get(path, options, "22.3.0") end
921
+ get(path, options, "22.7.0") end
907
922
 
908
923
  # Retrieve the list all tags supported by avalara
909
924
  #
@@ -915,7 +930,7 @@ module AvaTax
915
930
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
916
931
  # @return [FetchResult]
917
932
  def list_tags(options={}) path = "/api/v2/definitions/tags"
918
- get(path, options, "22.3.0") end
933
+ get(path, options, "22.7.0") end
919
934
 
920
935
  # Retrieve the full list of Avalara-supported tax authorities.
921
936
  #
@@ -928,7 +943,7 @@ module AvaTax
928
943
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
929
944
  # @return [FetchResult]
930
945
  def list_tax_authorities(options={}) path = "/api/v2/definitions/taxauthorities"
931
- get(path, options, "22.3.0") end
946
+ get(path, options, "22.7.0") end
932
947
 
933
948
  # Retrieve the full list of Avalara-supported forms for each tax authority.
934
949
  #
@@ -943,7 +958,7 @@ module AvaTax
943
958
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
944
959
  # @return [FetchResult]
945
960
  def list_tax_authority_forms(options={}) path = "/api/v2/definitions/taxauthorityforms"
946
- get(path, options, "22.3.0") end
961
+ get(path, options, "22.7.0") end
947
962
 
948
963
  # Retrieve the full list of Avalara-supported tax authority types.
949
964
  #
@@ -956,7 +971,7 @@ module AvaTax
956
971
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
957
972
  # @return [FetchResult]
958
973
  def list_tax_authority_types(options={}) path = "/api/v2/definitions/taxauthoritytypes"
959
- get(path, options, "22.3.0") end
974
+ get(path, options, "22.7.0") end
960
975
 
961
976
  # Retrieve the full list of Avalara-supported tax codes.
962
977
  #
@@ -968,7 +983,7 @@ module AvaTax
968
983
  #
969
984
  # ### Security Policies
970
985
  #
971
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
986
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
972
987
  # Swagger Name: AvaTaxClient
973
988
  # @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
989
  # @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 +991,7 @@ module AvaTax
976
991
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
977
992
  # @return [FetchResult]
978
993
  def list_tax_codes(options={}) path = "/api/v2/definitions/taxcodes"
979
- get(path, options, "22.3.0") end
994
+ get(path, options, "22.7.0") end
980
995
 
981
996
  # Retrieve the full list of Avalara-supported tax code types.
982
997
  #
@@ -988,7 +1003,7 @@ module AvaTax
988
1003
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
989
1004
  # @return [Object]
990
1005
  def list_tax_code_types(options={}) path = "/api/v2/definitions/taxcodetypes"
991
- get(path, options, "22.3.0") end
1006
+ get(path, options, "22.7.0") end
992
1007
 
993
1008
  # Retrieve the full list of the Tax Forms available
994
1009
  #
@@ -1001,7 +1016,7 @@ module AvaTax
1001
1016
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1002
1017
  # @return [FetchResult]
1003
1018
  def list_tax_forms(options={}) path = "/api/v2/definitions/taxforms"
1004
- get(path, options, "22.3.0") end
1019
+ get(path, options, "22.7.0") end
1005
1020
 
1006
1021
  # Retrieve the full list of tax sub types
1007
1022
  #
@@ -1014,7 +1029,7 @@ module AvaTax
1014
1029
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1015
1030
  # @return [FetchResult]
1016
1031
  def list_tax_sub_types(options={}) path = "/api/v2/definitions/taxsubtypes"
1017
- get(path, options, "22.3.0") end
1032
+ get(path, options, "22.7.0") end
1018
1033
 
1019
1034
  # Retrieve the full list of tax sub types by Country and TaxType
1020
1035
  #
@@ -1029,7 +1044,7 @@ module AvaTax
1029
1044
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1030
1045
  # @return [FetchResult]
1031
1046
  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.3.0") end
1047
+ get(path, options, "22.7.0") end
1033
1048
 
1034
1049
  # Retrieve the full list of tax sub types by jurisdiction code and region
1035
1050
  #
@@ -1044,7 +1059,7 @@ module AvaTax
1044
1059
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1045
1060
  # @return [FetchResult]
1046
1061
  def list_tax_sub_types_by_jurisdiction_and_region(jurisdictionCode, region, options={}) path = "/api/v2/definitions/taxsubtypes/#{jurisdictionCode}/#{region}"
1047
- get(path, options, "22.3.0") end
1062
+ get(path, options, "22.7.0") end
1048
1063
 
1049
1064
  # Retrieve the full list of tax type groups
1050
1065
  #
@@ -1057,7 +1072,7 @@ module AvaTax
1057
1072
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1058
1073
  # @return [FetchResult]
1059
1074
  def list_tax_type_groups(options={}) path = "/api/v2/definitions/taxtypegroups"
1060
- get(path, options, "22.3.0") end
1075
+ get(path, options, "22.7.0") end
1061
1076
 
1062
1077
  # Retrieve the list of applicable TaxTypes
1063
1078
  #
@@ -1070,7 +1085,7 @@ module AvaTax
1070
1085
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1071
1086
  # @return [FetchResult]
1072
1087
  def list_tax_types_by_nexus_and_country(country, options={}) path = "/api/v2/definitions/taxtypes/countries/#{country}"
1073
- get(path, options, "22.3.0") end
1088
+ get(path, options, "22.7.0") end
1074
1089
 
1075
1090
  # Retrieve the list of applicable UnitOfBasis
1076
1091
  #
@@ -1085,7 +1100,7 @@ module AvaTax
1085
1100
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1086
1101
  # @return [FetchResult]
1087
1102
  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.3.0") end
1103
+ get(path, options, "22.7.0") end
1089
1104
 
1090
1105
  # List all defined units of measurement
1091
1106
  #
@@ -1099,7 +1114,7 @@ module AvaTax
1099
1114
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
1100
1115
  # @return [FetchResult]
1101
1116
  def list_unit_of_measurement(options={}) path = "/api/v2/definitions/unitofmeasurements"
1102
- get(path, options, "22.3.0") end
1117
+ get(path, options, "22.7.0") end
1103
1118
  end
1104
1119
  end
1105
1120
  end