avatax 22.5.0 → 22.6.1

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 +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
@@ -13,13 +13,13 @@ module AvaTax
13
13
  #
14
14
  # ### Security Policies
15
15
  #
16
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
16
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
17
17
  # Swagger Name: AvaTaxClient
18
18
  # @param companyId [Integer] The ID of the company that owns this item.
19
19
  # @param itemId [Integer] The ID of the item you wish to delete the classifications.
20
20
  # @return [ErrorDetail[]]
21
21
  def batch_delete_item_classifications(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
22
- delete(path, {}, "22.5.0") end
22
+ delete(path, {}, "22.6.1") end
23
23
 
24
24
  # Delete all parameters for an item
25
25
  #
@@ -33,13 +33,13 @@ module AvaTax
33
33
  #
34
34
  # ### Security Policies
35
35
  #
36
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
36
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
37
37
  # Swagger Name: AvaTaxClient
38
38
  # @param companyId [Integer] The ID of the company that owns this item.
39
39
  # @param itemId [Integer] The ID of the item you wish to delete the parameters.
40
40
  # @return [ErrorDetail[]]
41
41
  def batch_delete_item_parameters(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
42
- delete(path, {}, "22.5.0") end
42
+ delete(path, {}, "22.6.1") end
43
43
 
44
44
  # Bulk upload items from a product catalog
45
45
  #
@@ -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, CSPTester, SSTAdmin, TechnicalSupportAdmin.
58
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
59
59
  # Swagger Name: AvaTaxClient
60
60
  # @param companyId [Integer] The ID of the company that owns this items.
61
61
  # @param model [Object] The items you wish to upload.
62
62
  # @return [Object]
63
63
  def bulk_upload_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/upload"
64
- post(path, model, {}, "22.5.0") end
64
+ post(path, model, {}, "22.6.1") end
65
65
 
66
66
  # Add classifications to an item.
67
67
  #
@@ -75,14 +75,14 @@ module AvaTax
75
75
  #
76
76
  # ### Security Policies
77
77
  #
78
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
78
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
79
79
  # Swagger Name: AvaTaxClient
80
80
  # @param companyId [Integer] The company id.
81
81
  # @param itemId [Integer] The item id.
82
82
  # @param model [ItemClassificationInputModel[]] The item classifications you wish to create.
83
83
  # @return [ItemClassificationOutputModel[]]
84
84
  def create_item_classifications(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
85
- post(path, model, {}, "22.5.0") end
85
+ post(path, model, {}, "22.6.1") end
86
86
 
87
87
  # Add parameters to an item.
88
88
  #
@@ -100,14 +100,14 @@ module AvaTax
100
100
  #
101
101
  # ### Security Policies
102
102
  #
103
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
103
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
104
104
  # Swagger Name: AvaTaxClient
105
105
  # @param companyId [Integer] The ID of the company that owns this item parameter.
106
106
  # @param itemId [Integer] The item id.
107
107
  # @param model [ItemParameterModel[]] The item parameters you wish to create.
108
108
  # @return [ItemParameterModel[]]
109
109
  def create_item_parameters(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
110
- post(path, model, {}, "22.5.0") end
110
+ post(path, model, {}, "22.6.1") end
111
111
 
112
112
  # Create a new item
113
113
  #
@@ -123,13 +123,13 @@ module AvaTax
123
123
  #
124
124
  # ### Security Policies
125
125
  #
126
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
126
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
127
127
  # Swagger Name: AvaTaxClient
128
128
  # @param companyId [Integer] The ID of the company that owns this item.
129
129
  # @param model [ItemModel[]] The item you wish to create.
130
130
  # @return [ItemModel[]]
131
131
  def create_items(companyId, model) path = "/api/v2/companies/#{companyId}/items"
132
- post(path, model, {}, "22.5.0") end
132
+ post(path, model, {}, "22.6.1") end
133
133
 
134
134
  # Create tags for a item
135
135
  #
@@ -139,14 +139,14 @@ module AvaTax
139
139
  #
140
140
  # ### Security Policies
141
141
  #
142
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
142
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
143
143
  # Swagger Name: AvaTaxClient
144
144
  # @param companyId [Integer] The ID of the company that defined these items
145
145
  # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
146
146
  # @param model [ItemTagDetailModel[]] Tags you wish to associate with the Item
147
147
  # @return [ItemTagDetailModel[]]
148
148
  def create_item_tags(companyId, itemId, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
149
- post(path, model, {}, "22.5.0") end
149
+ post(path, model, {}, "22.6.1") end
150
150
 
151
151
  # Create a new tax code classification request
152
152
  #
@@ -158,13 +158,13 @@ module AvaTax
158
158
  #
159
159
  # ### Security Policies
160
160
  #
161
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
161
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
162
162
  # Swagger Name: AvaTaxClient
163
163
  # @param companyId [Integer] The ID of the company creating this request.
164
164
  # @param model [Object] The request you wish to create.
165
165
  # @return [Object]
166
166
  def create_tax_code_classification_request(companyId, model) path = "/api/v2/companies/#{companyId}/classificationrequests/taxcode"
167
- post(path, model, {}, "22.5.0") end
167
+ post(path, model, {}, "22.6.1") end
168
168
 
169
169
  # Delete a single item
170
170
  #
@@ -186,13 +186,13 @@ module AvaTax
186
186
  #
187
187
  # ### Security Policies
188
188
  #
189
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
189
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
190
190
  # Swagger Name: AvaTaxClient
191
191
  # @param companyId [Integer] The ID of the company that owns this item.
192
192
  # @param itemCode [String] The code of the item you want to delete.
193
193
  # @return [ErrorDetail[]]
194
194
  def delete_catalogue_item(companyId, itemCode) path = "/api/v2/companies/#{companyId}/itemcatalogue/#{itemCode}"
195
- delete(path, {}, "22.5.0") end
195
+ delete(path, {}, "22.6.1") end
196
196
 
197
197
  # Delete a single item
198
198
  #
@@ -208,13 +208,13 @@ module AvaTax
208
208
  #
209
209
  # ### Security Policies
210
210
  #
211
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
211
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
212
212
  # Swagger Name: AvaTaxClient
213
213
  # @param companyId [Integer] The ID of the company that owns this item.
214
214
  # @param id [Integer] The ID of the item you wish to delete.
215
215
  # @return [ErrorDetail[]]
216
216
  def delete_item(companyId, id) path = "/api/v2/companies/#{companyId}/items/#{id}"
217
- delete(path, {}, "22.5.0") end
217
+ delete(path, {}, "22.6.1") end
218
218
 
219
219
  # Delete a single item classification.
220
220
  #
@@ -226,14 +226,14 @@ module AvaTax
226
226
  #
227
227
  # ### Security Policies
228
228
  #
229
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
229
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
230
230
  # Swagger Name: AvaTaxClient
231
231
  # @param companyId [Integer] The company id.
232
232
  # @param itemId [Integer] The item id.
233
233
  # @param id [Integer] The item classification id.
234
234
  # @return [ErrorDetail[]]
235
235
  def delete_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
236
- delete(path, {}, "22.5.0") end
236
+ delete(path, {}, "22.6.1") end
237
237
 
238
238
  # Delete a single item parameter
239
239
  #
@@ -247,14 +247,14 @@ module AvaTax
247
247
  #
248
248
  # ### Security Policies
249
249
  #
250
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
250
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
251
251
  # Swagger Name: AvaTaxClient
252
252
  # @param companyId [Integer] The company id
253
253
  # @param itemId [Integer] The item id
254
254
  # @param id [Integer] The parameter id
255
255
  # @return [ErrorDetail[]]
256
256
  def delete_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
257
- delete(path, {}, "22.5.0") end
257
+ delete(path, {}, "22.6.1") end
258
258
 
259
259
  # Delete item tag by id
260
260
  #
@@ -264,14 +264,14 @@ module AvaTax
264
264
  #
265
265
  # ### Security Policies
266
266
  #
267
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
267
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
268
268
  # Swagger Name: AvaTaxClient
269
269
  # @param companyId [Integer] The ID of the company that defined these items
270
270
  # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
271
271
  # @param itemTagDetailId [Integer] The ID of the item tag detail you wish to delete.
272
272
  # @return [ErrorDetail[]]
273
273
  def delete_item_tag(companyId, itemId, itemTagDetailId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags/#{itemTagDetailId}"
274
- delete(path, {}, "22.5.0") end
274
+ delete(path, {}, "22.6.1") end
275
275
 
276
276
  # Delete all item tags
277
277
  #
@@ -281,13 +281,13 @@ module AvaTax
281
281
  #
282
282
  # ### Security Policies
283
283
  #
284
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
284
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
285
285
  # Swagger Name: AvaTaxClient
286
286
  # @param companyId [Integer] The ID of the company that defined these items.
287
287
  # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
288
288
  # @return [ErrorDetail[]]
289
289
  def delete_item_tags(companyId, itemId) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
290
- delete(path, {}, "22.5.0") end
290
+ delete(path, {}, "22.6.1") end
291
291
 
292
292
  # Get the status of classification requests for a company
293
293
  #
@@ -301,7 +301,7 @@ module AvaTax
301
301
  #
302
302
  # ### Security Policies
303
303
  #
304
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
304
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
305
305
  # Swagger Name: AvaTaxClient
306
306
  # @param companyId [Integer] The ID of the company that defined these items
307
307
  # @param includeClassificationDetails [Boolean] A Boolean field that specifies whether to get a detailed classification status.
@@ -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 get_classification_status(companyId, options={}) path = "/api/v2/companies/#{companyId}/classificationrequests/taxcode"
314
- get(path, options, "22.5.0") end
314
+ get(path, options, "22.6.1") end
315
315
 
316
316
  # Retrieve a single item
317
317
  #
@@ -325,14 +325,14 @@ module AvaTax
325
325
  #
326
326
  # ### Security Policies
327
327
  #
328
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
328
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
329
329
  # Swagger Name: AvaTaxClient
330
330
  # @param companyId [Integer] The ID of the company that owns this item object
331
331
  # @param id [Integer] The primary key of this item
332
332
  # @param include [String] A comma separated list of additional data to retrieve.
333
333
  # @return [Object]
334
334
  def get_item(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/items/#{id}"
335
- get(path, options, "22.5.0") end
335
+ get(path, options, "22.6.1") end
336
336
 
337
337
  # Retrieve a single item classification.
338
338
  #
@@ -344,14 +344,14 @@ module AvaTax
344
344
  #
345
345
  # ### Security Policies
346
346
  #
347
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
347
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
348
348
  # Swagger Name: AvaTaxClient
349
349
  # @param companyId [Integer] The company id.
350
350
  # @param itemId [Integer] The item id.
351
351
  # @param id [Integer] The item classification id.
352
352
  # @return [Object]
353
353
  def get_item_classification(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
354
- get(path, {}, "22.5.0") end
354
+ get(path, {}, "22.6.1") end
355
355
 
356
356
  # Retrieve a single item parameter
357
357
  #
@@ -365,14 +365,14 @@ module AvaTax
365
365
  #
366
366
  # ### Security Policies
367
367
  #
368
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
368
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
369
369
  # Swagger Name: AvaTaxClient
370
370
  # @param companyId [Integer] The company id
371
371
  # @param itemId [Integer] The item id
372
372
  # @param id [Integer] The parameter id
373
373
  # @return [Object]
374
374
  def get_item_parameter(companyId, itemId, id) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
375
- get(path, {}, "22.5.0") end
375
+ get(path, {}, "22.6.1") end
376
376
 
377
377
  # Retrieve tags for an item
378
378
  #
@@ -382,7 +382,7 @@ module AvaTax
382
382
  #
383
383
  # ### Security Policies
384
384
  #
385
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
385
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
386
386
  # Swagger Name: AvaTaxClient
387
387
  # @param companyId [Integer] The ID of the company that defined these items
388
388
  # @param itemId [Integer] The ID of the item as defined by the company that owns this tag.
@@ -391,7 +391,7 @@ module AvaTax
391
391
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
392
392
  # @return [FetchResult]
393
393
  def get_item_tags(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/tags"
394
- get(path, options, "22.5.0") end
394
+ get(path, options, "22.6.1") end
395
395
 
396
396
  # Retrieve premium classification for a company's item based on its ItemCode and SystemCode.
397
397
  #
@@ -408,14 +408,14 @@ module AvaTax
408
408
  #
409
409
  # ### Security Policies
410
410
  #
411
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
411
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
412
412
  # Swagger Name: AvaTaxClient
413
413
  # @param companyId [Integer] The ID of the company that owns this item object
414
414
  # @param itemCode [String] The ItemCode of the item for which you want to retrieve premium classification
415
415
  # @param systemCode [String] The SystemCode for which you want to retrieve premium classification
416
416
  # @return [Object]
417
417
  def get_premium_classification(companyId, itemCode, systemCode) path = "/api/v2/companies/#{companyId}/items/#{itemCode}/premiumClassification/#{systemCode}"
418
- get(path, {}, "22.5.0") end
418
+ get(path, {}, "22.6.1") end
419
419
 
420
420
  # Get tax code recommendations
421
421
  #
@@ -427,7 +427,7 @@ module AvaTax
427
427
  #
428
428
  # ### Security Policies
429
429
  #
430
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
430
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
431
431
  # Swagger Name: AvaTaxClient
432
432
  # @param companyId [Integer] The ID of the company that defined these items
433
433
  # @param requestId [Integer] The ID of the classification request
@@ -437,7 +437,7 @@ module AvaTax
437
437
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
438
438
  # @return [FetchResult]
439
439
  def get_tax_code_recommendations(companyId, requestId, options={}) path = "/api/v2/companies/#{companyId}/classificationrequests/taxcode/#{requestId}/recommendations"
440
- get(path, options, "22.5.0") end
440
+ get(path, options, "22.6.1") end
441
441
 
442
442
  # Retrieve Restrictions for Item by CountryOfImport
443
443
  #
@@ -454,7 +454,7 @@ module AvaTax
454
454
  #
455
455
  # ### Security Policies
456
456
  #
457
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
457
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
458
458
  # Swagger Name: AvaTaxClient
459
459
  # @param companyId [Integer] The ID of the company that owns this item object
460
460
  # @param itemCode [String] ItemCode for the item
@@ -464,7 +464,7 @@ module AvaTax
464
464
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
465
465
  # @return [FetchResult]
466
466
  def list_import_restrictions(companyId, itemCode, countryOfImport, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemCode}/restrictions/import/#{countryOfImport}"
467
- get(path, options, "22.5.0") end
467
+ get(path, options, "22.6.1") end
468
468
 
469
469
  # Retrieve classifications for an item.
470
470
  #
@@ -479,7 +479,7 @@ module AvaTax
479
479
  #
480
480
  # ### Security Policies
481
481
  #
482
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
482
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
483
483
  # Swagger Name: AvaTaxClient
484
484
  # @param companyId [Integer] The company id.
485
485
  # @param itemId [Integer] The item id.
@@ -489,7 +489,7 @@ module AvaTax
489
489
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
490
490
  # @return [FetchResult]
491
491
  def list_item_classifications(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications"
492
- get(path, options, "22.5.0") end
492
+ get(path, options, "22.6.1") end
493
493
 
494
494
  # Retrieve parameters for an item
495
495
  #
@@ -506,7 +506,7 @@ module AvaTax
506
506
  #
507
507
  # ### Security Policies
508
508
  #
509
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
509
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
510
510
  # Swagger Name: AvaTaxClient
511
511
  # @param companyId [Integer] The company id
512
512
  # @param itemId [Integer] The item id
@@ -516,7 +516,7 @@ module AvaTax
516
516
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
517
517
  # @return [FetchResult]
518
518
  def list_item_parameters(companyId, itemId, options={}) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters"
519
- get(path, options, "22.5.0") end
519
+ get(path, options, "22.6.1") end
520
520
 
521
521
  # Retrieve items for this company
522
522
  #
@@ -542,7 +542,7 @@ module AvaTax
542
542
  #
543
543
  # ### Security Policies
544
544
  #
545
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
545
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
546
546
  # Swagger Name: AvaTaxClient
547
547
  # @param companyId [Integer] The ID of the company that defined these items
548
548
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxCode, source, upc, classifications, parameters, tags
@@ -553,7 +553,7 @@ module AvaTax
553
553
  # @param tagName [String] Tag Name on the basis of which you want to filter Items
554
554
  # @return [FetchResult]
555
555
  def list_items_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/items"
556
- get(path, options, "22.5.0") end
556
+ get(path, options, "22.6.1") end
557
557
 
558
558
  # Retrieve all items
559
559
  #
@@ -571,7 +571,7 @@ module AvaTax
571
571
  #
572
572
  # ### Security Policies
573
573
  #
574
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
574
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
575
575
  # Swagger Name: AvaTaxClient
576
576
  # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/).<br />*Not filterable:* taxCode, source, upc, classifications, parameters, tags
577
577
  # @param include [String] A comma separated list of additional data to retrieve.
@@ -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 query_items(options={}) path = "/api/v2/items"
583
- get(path, options, "22.5.0") end
583
+ get(path, options, "22.6.1") end
584
584
 
585
585
  # Retrieve all items associated with given tag
586
586
  #
@@ -598,7 +598,7 @@ module AvaTax
598
598
  #
599
599
  # ### Security Policies
600
600
  #
601
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
601
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
602
602
  # Swagger Name: AvaTaxClient
603
603
  # @param companyId [Integer] The ID of the company that defined these items.
604
604
  # @param tag [String] The master tag to be associated with item.
@@ -609,7 +609,7 @@ module AvaTax
609
609
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
610
610
  # @return [FetchResult]
611
611
  def query_items_by_tag(companyId, tag, options={}) path = "/api/v2/companies/#{companyId}/items/bytags/#{tag}"
612
- get(path, options, "22.5.0") end
612
+ get(path, options, "22.6.1") end
613
613
 
614
614
  # Create or update items from a product catalog.
615
615
  #
@@ -621,13 +621,13 @@ module AvaTax
621
621
  #
622
622
  # ### Security Policies
623
623
  #
624
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
624
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
625
625
  # Swagger Name: AvaTaxClient
626
626
  # @param companyId [Integer] The ID of the company that owns this item.
627
627
  # @param model [ItemCatalogueInputModel[]] The items you want to create or update.
628
628
  # @return [Object]
629
629
  def sync_item_catalogue(companyId, model) path = "/api/v2/companies/#{companyId}/itemcatalogue"
630
- post(path, model, {}, "22.5.0") end
630
+ post(path, model, {}, "22.6.1") end
631
631
 
632
632
  # Sync items from a product catalog
633
633
  #
@@ -646,13 +646,13 @@ module AvaTax
646
646
  #
647
647
  # ### Security Policies
648
648
  #
649
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
649
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
650
650
  # Swagger Name: AvaTaxClient
651
651
  # @param companyId [Integer] The ID of the company that owns this item.
652
652
  # @param model [Object] The request object.
653
653
  # @return [Object]
654
654
  def sync_items(companyId, model) path = "/api/v2/companies/#{companyId}/items/sync"
655
- post(path, model, {}, "22.5.0") end
655
+ post(path, model, {}, "22.6.1") end
656
656
 
657
657
  # Update a single item
658
658
  #
@@ -671,14 +671,14 @@ module AvaTax
671
671
  #
672
672
  # ### Security Policies
673
673
  #
674
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
674
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
675
675
  # Swagger Name: AvaTaxClient
676
676
  # @param companyId [Integer] The ID of the company that this item belongs to.
677
677
  # @param id [Integer] The ID of the item you wish to update
678
678
  # @param model [Object] The item object you wish to update.
679
679
  # @return [Object]
680
680
  def update_item(companyId, id, model) path = "/api/v2/companies/#{companyId}/items/#{id}"
681
- put(path, model, {}, "22.5.0") end
681
+ put(path, model, {}, "22.6.1") end
682
682
 
683
683
  # Update an item classification.
684
684
  #
@@ -692,7 +692,7 @@ module AvaTax
692
692
  #
693
693
  # ### Security Policies
694
694
  #
695
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
695
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
696
696
  # Swagger Name: AvaTaxClient
697
697
  # @param companyId [Integer] The company id.
698
698
  # @param itemId [Integer] The item id.
@@ -700,7 +700,7 @@ module AvaTax
700
700
  # @param model [Object] The item object you wish to update.
701
701
  # @return [Object]
702
702
  def update_item_classification(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/classifications/#{id}"
703
- put(path, model, {}, "22.5.0") end
703
+ put(path, model, {}, "22.6.1") end
704
704
 
705
705
  # Update an item parameter
706
706
  #
@@ -714,7 +714,7 @@ module AvaTax
714
714
  #
715
715
  # ### Security Policies
716
716
  #
717
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
717
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
718
718
  # Swagger Name: AvaTaxClient
719
719
  # @param companyId [Integer] The company id.
720
720
  # @param itemId [Integer] The item id
@@ -722,7 +722,7 @@ module AvaTax
722
722
  # @param model [Object] The item object you wish to update.
723
723
  # @return [Object]
724
724
  def update_item_parameter(companyId, itemId, id, model) path = "/api/v2/companies/#{companyId}/items/#{itemId}/parameters/#{id}"
725
- put(path, model, {}, "22.5.0") end
725
+ put(path, model, {}, "22.6.1") end
726
726
  end
727
727
  end
728
728
  end
@@ -14,13 +14,13 @@ module AvaTax
14
14
  #
15
15
  # ### Security Policies
16
16
  #
17
- # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
17
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
18
18
  # Swagger Name: AvaTaxClient
19
19
  # @param accountId [Integer] The ID of the account that owns this override
20
20
  # @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
21
21
  # @return [JurisdictionOverrideModel[]]
22
22
  def create_jurisdiction_overrides(accountId, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
23
- post(path, model, {}, "22.5.0") end
23
+ post(path, model, {}, "22.6.1") end
24
24
 
25
25
  # Delete a single override
26
26
  #
@@ -28,13 +28,13 @@ module AvaTax
28
28
  #
29
29
  # ### Security Policies
30
30
  #
31
- # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
31
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
32
32
  # Swagger Name: AvaTaxClient
33
33
  # @param accountId [Integer] The ID of the account that owns this override
34
34
  # @param id [Integer] The ID of the override you wish to delete
35
35
  # @return [ErrorDetail[]]
36
36
  def delete_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
37
- delete(path, {}, "22.5.0") end
37
+ delete(path, {}, "22.6.1") end
38
38
 
39
39
  # Retrieve a single override
40
40
  #
@@ -47,13 +47,13 @@ module AvaTax
47
47
  #
48
48
  # ### Security Policies
49
49
  #
50
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
50
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
51
51
  # Swagger Name: AvaTaxClient
52
52
  # @param accountId [Integer] The ID of the account that owns this override
53
53
  # @param id [Integer] The primary key of this override
54
54
  # @return [Object]
55
55
  def get_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
56
- get(path, {}, "22.5.0") end
56
+ get(path, {}, "22.6.1") end
57
57
 
58
58
  # Retrieve overrides for this account
59
59
  #
@@ -69,7 +69,7 @@ module AvaTax
69
69
  #
70
70
  # ### Security Policies
71
71
  #
72
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
72
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
73
73
  # Swagger Name: AvaTaxClient
74
74
  # @param accountId [Integer] The ID of the account that owns this override
75
75
  # @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:* country, Jurisdictions
@@ -79,7 +79,7 @@ module AvaTax
79
79
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
80
80
  # @return [FetchResult]
81
81
  def list_jurisdiction_overrides_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
82
- get(path, options, "22.5.0") end
82
+ get(path, options, "22.6.1") end
83
83
 
84
84
  # Retrieve all overrides
85
85
  #
@@ -95,7 +95,7 @@ module AvaTax
95
95
  #
96
96
  # ### Security Policies
97
97
  #
98
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
98
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
99
99
  # Swagger Name: AvaTaxClient
100
100
  # @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:* country, Jurisdictions
101
101
  # @param include [String] A comma separated list of additional data to retrieve.
@@ -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 query_jurisdiction_overrides(options={}) path = "/api/v2/jurisdictionoverrides"
107
- get(path, options, "22.5.0") end
107
+ get(path, options, "22.6.1") end
108
108
 
109
109
  # Update a single jurisdictionoverride
110
110
  #
@@ -112,14 +112,14 @@ module AvaTax
112
112
  #
113
113
  # ### Security Policies
114
114
  #
115
- # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
115
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
116
116
  # Swagger Name: AvaTaxClient
117
117
  # @param accountId [Integer] The ID of the account that this jurisdictionoverride belongs to.
118
118
  # @param id [Integer] The ID of the jurisdictionoverride you wish to update
119
119
  # @param model [Object] The jurisdictionoverride object you wish to update.
120
120
  # @return [Object]
121
121
  def update_jurisdiction_override(accountId, id, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
122
- put(path, model, {}, "22.5.0") end
122
+ put(path, model, {}, "22.6.1") end
123
123
  end
124
124
  end
125
125
  end