avatax 21.9.0 → 22.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (75) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +55 -55
  3. data/.rspec +1 -1
  4. data/.travis.yml +18 -18
  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 -11
  16. data/lib/avatax/client/addresses.rb +4 -2
  17. data/lib/avatax/client/advancedrules.rb +10 -5
  18. data/lib/avatax/client/ageverification.rb +29 -0
  19. data/lib/avatax/client/avafileforms.rb +10 -5
  20. data/lib/avatax/client/batches.rb +16 -8
  21. data/lib/avatax/client/certexpressinvites.rb +6 -3
  22. data/lib/avatax/client/certificates.rb +30 -15
  23. data/lib/avatax/client/companies.rb +61 -21
  24. data/lib/avatax/client/compliance.rb +25 -14
  25. data/lib/avatax/client/contacts.rb +12 -6
  26. data/lib/avatax/client/customers.rb +26 -13
  27. data/lib/avatax/client/datasources.rb +12 -6
  28. data/lib/avatax/client/definitions.rb +140 -70
  29. data/lib/avatax/client/distancethresholds.rb +12 -6
  30. data/lib/avatax/client/ecms.rb +73 -73
  31. data/lib/avatax/client/ecommercetoken.rb +4 -2
  32. data/lib/avatax/client/errortransactions.rb +61 -61
  33. data/lib/avatax/client/filingcalendars.rb +9 -4
  34. data/lib/avatax/client/filings.rb +6 -2
  35. data/lib/avatax/client/firmclientlinkages.rb +18 -9
  36. data/lib/avatax/client/free.rb +2 -1
  37. data/lib/avatax/client/fundingrequests.rb +4 -2
  38. data/lib/avatax/client/items.rb +50 -25
  39. data/lib/avatax/client/jurisdictionoverrides.rb +12 -6
  40. data/lib/avatax/client/locations.rb +24 -12
  41. data/lib/avatax/client/multidocument.rb +20 -10
  42. data/lib/avatax/client/nexus.rb +30 -15
  43. data/lib/avatax/client/notices.rb +8 -4
  44. data/lib/avatax/client/notifications.rb +6 -3
  45. data/lib/avatax/client/onboarding.rb +55 -55
  46. data/lib/avatax/client/pointofsale.rb +21 -21
  47. data/lib/avatax/client/provisioning.rb +4 -2
  48. data/lib/avatax/client/registrar.rb +22 -11
  49. data/lib/avatax/client/reports.rb +8 -4
  50. data/lib/avatax/client/settings.rb +12 -6
  51. data/lib/avatax/client/shippingverification.rb +66 -0
  52. data/lib/avatax/client/subscriptions.rb +6 -3
  53. data/lib/avatax/client/taxcodes.rb +12 -6
  54. data/lib/avatax/client/taxcontent.rb +10 -5
  55. data/lib/avatax/client/taxprofiles.rb +42 -42
  56. data/lib/avatax/client/taxrules.rb +12 -6
  57. data/lib/avatax/client/transactions.rb +42 -21
  58. data/lib/avatax/client/upcs.rb +12 -6
  59. data/lib/avatax/client/userdefinedfields.rb +52 -0
  60. data/lib/avatax/client/users.rb +16 -8
  61. data/lib/avatax/client/utilities.rb +6 -3
  62. data/lib/avatax/client.rb +37 -35
  63. data/lib/avatax/configuration.rb +76 -76
  64. data/lib/avatax/connection.rb +49 -49
  65. data/lib/avatax/request.rb +51 -42
  66. data/lib/avatax/version.rb +3 -3
  67. data/lib/avatax.rb +26 -26
  68. data/spec/avatax/client/accounts_spec.rb +13 -13
  69. data/spec/avatax/client/transactions_spec.rb +80 -80
  70. data/spec/avatax/request_spec.rb +25 -25
  71. data/spec/avatax_spec.rb +45 -45
  72. data/spec/credentials.yaml.example +4 -4
  73. data/spec/fixtures/accounts.json +15 -15
  74. data/spec/spec_helper.rb +27 -27
  75. metadata +9 -13
@@ -20,12 +20,13 @@ module AvaTax
20
20
  # ### Security Policies
21
21
  #
22
22
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
23
+ # Swagger Name: AvaTaxClient
23
24
  # @param companyId [Integer] The ID of the company that owns this location parameter.
24
25
  # @param locationId [Integer] The location id.
25
26
  # @param model [LocationParameterModel[]] The location parameters you wish to create.
26
27
  # @return [LocationParameterModel[]]
27
28
  def create_location_parameters(companyId, locationId, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
28
- post(path, model) end
29
+ post(path, model, {}, "22.2.0") end
29
30
 
30
31
  # Create a new location
31
32
  #
@@ -34,11 +35,12 @@ module AvaTax
34
35
  # ### Security Policies
35
36
  #
36
37
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
38
+ # Swagger Name: AvaTaxClient
37
39
  # @param companyId [Integer] The ID of the company that owns this location.
38
40
  # @param model [LocationModel[]] The location you wish to create.
39
41
  # @return [LocationModel[]]
40
42
  def create_locations(companyId, model) path = "/api/v2/companies/#{companyId}/locations"
41
- post(path, model) end
43
+ post(path, model, {}, "22.2.0") end
42
44
 
43
45
  # Delete a single location
44
46
  #
@@ -47,11 +49,12 @@ module AvaTax
47
49
  # ### Security Policies
48
50
  #
49
51
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
52
+ # Swagger Name: AvaTaxClient
50
53
  # @param companyId [Integer] The ID of the company that owns this location.
51
54
  # @param id [Integer] The ID of the location you wish to delete.
52
55
  # @return [ErrorDetail[]]
53
56
  def delete_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}"
54
- delete(path) end
57
+ delete(path, {}, "22.2.0") end
55
58
 
56
59
  # Delete a single location parameter
57
60
  #
@@ -66,12 +69,13 @@ module AvaTax
66
69
  # ### Security Policies
67
70
  #
68
71
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
72
+ # Swagger Name: AvaTaxClient
69
73
  # @param companyId [Integer] The company id
70
74
  # @param locationId [Integer] The location id
71
75
  # @param id [Integer] The parameter id
72
76
  # @return [ErrorDetail[]]
73
77
  def delete_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
74
- delete(path) end
78
+ delete(path, {}, "22.2.0") end
75
79
 
76
80
  # Retrieve a single location
77
81
  #
@@ -89,12 +93,13 @@ module AvaTax
89
93
  # ### Security Policies
90
94
  #
91
95
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
96
+ # Swagger Name: AvaTaxClient
92
97
  # @param companyId [Integer] The ID of the company that owns this location
93
98
  # @param id [Integer] The primary key of this location
94
99
  # @param include [String] A comma separated list of additional data to retrieve.
95
100
  # @return [Object]
96
101
  def get_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}"
97
- get(path, options) end
102
+ get(path, options, "22.2.0") end
98
103
 
99
104
  # Retrieve a single company location parameter
100
105
  #
@@ -109,12 +114,13 @@ module AvaTax
109
114
  # ### Security Policies
110
115
  #
111
116
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
117
+ # Swagger Name: AvaTaxClient
112
118
  # @param companyId [Integer] The company id
113
119
  # @param locationId [Integer] The location id
114
120
  # @param id [Integer] The parameter id
115
121
  # @return [Object]
116
122
  def get_location_parameter(companyId, locationId, id) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
117
- get(path) end
123
+ get(path, {}, "22.2.0") end
118
124
 
119
125
  # Retrieve parameters for a location
120
126
  #
@@ -132,6 +138,7 @@ module AvaTax
132
138
  # ### Security Policies
133
139
  #
134
140
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
141
+ # Swagger Name: AvaTaxClient
135
142
  # @param companyId [Integer] The company id
136
143
  # @param locationId [Integer] The ID of the location
137
144
  # @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:* name, unit
@@ -140,7 +147,7 @@ module AvaTax
140
147
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
141
148
  # @return [FetchResult]
142
149
  def list_location_parameters(companyId, locationId, options={}) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters"
143
- get(path, options) end
150
+ get(path, options, "22.2.0") end
144
151
 
145
152
  # Retrieve locations for this company
146
153
  #
@@ -160,6 +167,7 @@ module AvaTax
160
167
  # ### Security Policies
161
168
  #
162
169
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
170
+ # Swagger Name: AvaTaxClient
163
171
  # @param companyId [Integer] The ID of the company that owns these locations
164
172
  # @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:* isMarketplaceOutsideUsa, settings, parameters
165
173
  # @param include [String] A comma separated list of additional data to retrieve.
@@ -168,7 +176,7 @@ module AvaTax
168
176
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
169
177
  # @return [FetchResult]
170
178
  def list_locations_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/locations"
171
- get(path, options) end
179
+ get(path, options, "22.2.0") end
172
180
 
173
181
  # Retrieve all locations
174
182
  #
@@ -189,6 +197,7 @@ module AvaTax
189
197
  # ### Security Policies
190
198
  #
191
199
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
200
+ # Swagger Name: AvaTaxClient
192
201
  # @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:* isMarketplaceOutsideUsa, settings, parameters
193
202
  # @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
194
203
  # @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.
@@ -196,7 +205,7 @@ module AvaTax
196
205
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
197
206
  # @return [FetchResult]
198
207
  def query_locations(options={}) path = "/api/v2/locations"
199
- get(path, options) end
208
+ get(path, options, "22.2.0") end
200
209
 
201
210
  # Update a single location
202
211
  #
@@ -207,12 +216,13 @@ module AvaTax
207
216
  # ### Security Policies
208
217
  #
209
218
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
219
+ # Swagger Name: AvaTaxClient
210
220
  # @param companyId [Integer] The ID of the company that this location belongs to.
211
221
  # @param id [Integer] The ID of the location you wish to update
212
222
  # @param model [Object] The location you wish to update.
213
223
  # @return [Object]
214
224
  def update_location(companyId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{id}"
215
- put(path, model) end
225
+ put(path, model, {}, "22.2.0") end
216
226
 
217
227
  # Update a location parameter
218
228
  #
@@ -227,13 +237,14 @@ module AvaTax
227
237
  # ### Security Policies
228
238
  #
229
239
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, FirmAdmin, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
240
+ # Swagger Name: AvaTaxClient
230
241
  # @param companyId [Integer] The company id.
231
242
  # @param locationId [Integer] The location id
232
243
  # @param id [Integer] The location parameter id
233
244
  # @param model [Object] The location parameter object you wish to update.
234
245
  # @return [Object]
235
246
  def update_location_parameter(companyId, locationId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{locationId}/parameters/#{id}"
236
- put(path, model) end
247
+ put(path, model, {}, "22.2.0") end
237
248
 
238
249
  # Validate the location against local requirements
239
250
  #
@@ -244,11 +255,12 @@ module AvaTax
244
255
  # ### Security Policies
245
256
  #
246
257
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
258
+ # Swagger Name: AvaTaxClient
247
259
  # @param companyId [Integer] The ID of the company that owns this location
248
260
  # @param id [Integer] The primary key of this location
249
261
  # @return [Object]
250
262
  def validate_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
251
- get(path) end
263
+ get(path, {}, "22.2.0") end
252
264
  end
253
265
  end
254
266
  end
@@ -28,13 +28,14 @@ module AvaTax
28
28
  #
29
29
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
30
30
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
31
+ # Swagger Name: AvaTaxClient
31
32
  # @param code [String] The transaction code for this MultiDocument transaction
32
33
  # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
33
34
  # @param include [String] Specifies objects to include in this fetch call
34
35
  # @param model [Object] The adjust request you wish to execute
35
36
  # @return [Object]
36
37
  def adjust_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
37
- post(path, model, options) end
38
+ post(path, model, options, "22.2.0") end
38
39
 
39
40
  # Get audit information about a MultiDocument transaction
40
41
  #
@@ -65,11 +66,12 @@ module AvaTax
65
66
  #
66
67
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
67
68
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
69
+ # Swagger Name: AvaTaxClient
68
70
  # @param code [String] The transaction code for this MultiDocument transaction
69
71
  # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
70
72
  # @return [Object]
71
73
  def audit_multi_document_transaction(code, type) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
72
- get(path) end
74
+ get(path, {}, "22.2.0") end
73
75
 
74
76
  # Commit a MultiDocument transaction
75
77
  #
@@ -94,10 +96,11 @@ module AvaTax
94
96
  #
95
97
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
96
98
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
99
+ # Swagger Name: AvaTaxClient
97
100
  # @param model [Object] The commit request you wish to execute
98
101
  # @return [Object]
99
102
  def commit_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/commit"
100
- post(path, model) end
103
+ post(path, model, {}, "22.2.0") end
101
104
 
102
105
  # Create a new MultiDocument transaction
103
106
  #
@@ -146,11 +149,12 @@ module AvaTax
146
149
  #
147
150
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
148
151
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
152
+ # Swagger Name: AvaTaxClient
149
153
  # @param include [String] Specifies objects to include in the response after transaction is created
150
154
  # @param model [Object] the multi document transaction model
151
155
  # @return [Object]
152
156
  def create_multi_document_transaction(model, options={}) path = "/api/v2/transactions/multidocument"
153
- post(path, model, options) end
157
+ post(path, model, options, "22.2.0") end
154
158
 
155
159
  # Retrieve a MultiDocument transaction
156
160
  #
@@ -179,12 +183,13 @@ module AvaTax
179
183
  #
180
184
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
181
185
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
186
+ # Swagger Name: AvaTaxClient
182
187
  # @param code [String] The multidocument code to retrieve
183
188
  # @param type [String] The transaction type to retrieve (See DocumentType::* for a list of allowable values)
184
189
  # @param include [String] Specifies objects to include in the response after transaction is created
185
190
  # @return [Object]
186
191
  def get_multi_document_transaction_by_code_and_type(code, type, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
187
- get(path, options) end
192
+ get(path, options, "22.2.0") end
188
193
 
189
194
  # Retrieve a MultiDocument transaction by ID
190
195
  #
@@ -222,11 +227,12 @@ module AvaTax
222
227
  #
223
228
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
224
229
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
230
+ # Swagger Name: AvaTaxClient
225
231
  # @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
226
232
  # @param include [String] Specifies objects to include in the response after transaction is created
227
233
  # @return [Object]
228
234
  def get_multi_document_transaction_by_id(id, options={}) path = "/api/v2/transactions/multidocument/#{id}"
229
- get(path, options) end
235
+ get(path, options, "22.2.0") end
230
236
 
231
237
  # Retrieve all MultiDocument transactions
232
238
  #
@@ -262,6 +268,7 @@ module AvaTax
262
268
  #
263
269
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
264
270
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
271
+ # Swagger Name: AvaTaxClient
265
272
  # @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:* documents
266
273
  # @param include [String] Specifies objects to include in the response after transaction is created
267
274
  # @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.
@@ -269,7 +276,7 @@ module AvaTax
269
276
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
270
277
  # @return [FetchResult]
271
278
  def list_multi_document_transactions(options={}) path = "/api/v2/transactions/multidocument"
272
- get(path, options) end
279
+ get(path, options, "22.2.0") end
273
280
 
274
281
  # Create a refund for a MultiDocument transaction
275
282
  #
@@ -322,13 +329,14 @@ module AvaTax
322
329
  #
323
330
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
324
331
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
332
+ # Swagger Name: AvaTaxClient
325
333
  # @param code [String] The code of this MultiDocument transaction
326
334
  # @param type [String] The type of this MultiDocument transaction (See DocumentType::* for a list of allowable values)
327
335
  # @param include [String] Specifies objects to include in the response after transaction is created
328
336
  # @param model [Object] Information about the refund to create
329
337
  # @return [Object]
330
338
  def refund_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
331
- post(path, model, options) end
339
+ post(path, model, options, "22.2.0") end
332
340
 
333
341
  # Verify a MultiDocument transaction
334
342
  #
@@ -351,10 +359,11 @@ module AvaTax
351
359
  #
352
360
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
353
361
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
362
+ # Swagger Name: AvaTaxClient
354
363
  # @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
355
364
  # @return [Object]
356
365
  def verify_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/verify"
357
- post(path, model) end
366
+ post(path, model, {}, "22.2.0") end
358
367
 
359
368
  # Void a MultiDocument transaction
360
369
  #
@@ -380,12 +389,13 @@ module AvaTax
380
389
  #
381
390
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, ProStoresOperator, SSTAdmin, TechnicalSupportAdmin.
382
391
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
392
+ # Swagger Name: AvaTaxClient
383
393
  # @param code [String] The transaction code for this MultiDocument transaction
384
394
  # @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
385
395
  # @param model [Object] The void request you wish to execute
386
396
  # @return [Object]
387
397
  def void_multi_document_transaction(code, type, model) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
388
- post(path, model) end
398
+ post(path, model, {}, "22.2.0") end
389
399
  end
390
400
  end
391
401
  end
@@ -28,11 +28,12 @@ module AvaTax
28
28
  # ### Security Policies
29
29
  #
30
30
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
31
+ # Swagger Name: AvaTaxClient
31
32
  # @param companyId [Integer] The ID of the company that owns this nexus.
32
33
  # @param model [NexusModel[]] The nexus you wish to create.
33
34
  # @return [NexusModel[]]
34
35
  def create_nexus(companyId, model) path = "/api/v2/companies/#{companyId}/nexus"
35
- post(path, model) end
36
+ post(path, model, {}, "22.2.0") end
36
37
 
37
38
  # Add parameters to a nexus.
38
39
  #
@@ -50,12 +51,13 @@ module AvaTax
50
51
  # ### Security Policies
51
52
  #
52
53
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
54
+ # Swagger Name: AvaTaxClient
53
55
  # @param companyId [Integer] The ID of the company that owns this nexus parameter.
54
56
  # @param nexusId [Integer] The nexus id.
55
57
  # @param model [NexusParameterDetailModel[]] The nexus parameters you wish to create.
56
58
  # @return [NexusParameterDetailModel[]]
57
59
  def create_nexus_parameters(companyId, nexusId, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
58
- post(path, model) end
60
+ post(path, model, {}, "22.2.0") end
59
61
 
60
62
  # Creates nexus for a list of addresses.
61
63
  #
@@ -78,11 +80,12 @@ module AvaTax
78
80
  # ### Security Policies
79
81
  #
80
82
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
83
+ # Swagger Name: AvaTaxClient
81
84
  # @param companyId [Integer] The ID of the company that will own this nexus.
82
85
  # @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
83
86
  # @return [NexusByAddressModel[]]
84
87
  def declare_nexus_by_address(companyId, model) path = "/api/v2/companies/#{companyId}/nexus/byaddress"
85
- post(path, model) end
88
+ post(path, model, {}, "22.2.0") end
86
89
 
87
90
  # Delete a single nexus
88
91
  #
@@ -98,12 +101,13 @@ module AvaTax
98
101
  # ### Security Policies
99
102
  #
100
103
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
104
+ # Swagger Name: AvaTaxClient
101
105
  # @param companyId [Integer] The ID of the company that owns this nexus.
102
106
  # @param id [Integer] The ID of the nexus you wish to delete.
103
107
  # @param cascadeDelete [Boolean] If true, deletes all the child nexus if they exist along with parent nexus
104
108
  # @return [ErrorDetail[]]
105
109
  def delete_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
106
- delete(path, options) end
110
+ delete(path, options, "22.2.0") end
107
111
 
108
112
  # Delete a single nexus parameter
109
113
  #
@@ -117,12 +121,13 @@ module AvaTax
117
121
  # ### Security Policies
118
122
  #
119
123
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
124
+ # Swagger Name: AvaTaxClient
120
125
  # @param companyId [Integer] The company id
121
126
  # @param nexusId [Integer] The nexus id
122
127
  # @param id [Integer] The parameter id
123
128
  # @return [ErrorDetail[]]
124
129
  def delete_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
125
- delete(path) end
130
+ delete(path, {}, "22.2.0") end
126
131
 
127
132
  # Delete all parameters for an nexus
128
133
  #
@@ -136,11 +141,12 @@ module AvaTax
136
141
  # ### Security Policies
137
142
  #
138
143
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
144
+ # Swagger Name: AvaTaxClient
139
145
  # @param companyId [Integer] The ID of the company that owns this nexus.
140
146
  # @param nexusId [Integer] The ID of the nexus you wish to delete the parameters.
141
147
  # @return [ErrorDetail[]]
142
148
  def delete_nexus_parameters(companyId, nexusId) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
143
- delete(path) end
149
+ delete(path, {}, "22.2.0") end
144
150
 
145
151
  # Retrieve a single nexus
146
152
  #
@@ -156,12 +162,13 @@ module AvaTax
156
162
  # ### Security Policies
157
163
  #
158
164
  # * 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.
165
+ # Swagger Name: AvaTaxClient
159
166
  # @param companyId [Integer] The ID of the company that owns this nexus object
160
167
  # @param id [Integer] The primary key of this nexus
161
168
  # @param include [String]
162
169
  # @return [Object]
163
170
  def get_nexus(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
164
- get(path, options) end
171
+ get(path, options, "22.2.0") end
165
172
 
166
173
  # List company nexus related to a tax form
167
174
  #
@@ -181,12 +188,13 @@ module AvaTax
181
188
  # ### Security Policies
182
189
  #
183
190
  # * 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.
191
+ # Swagger Name: AvaTaxClient
184
192
  # @param companyId [Integer] The ID of the company that owns this nexus object
185
193
  # @param formCode [String] The form code that we are looking up the nexus for
186
194
  # @param include [String]
187
195
  # @return [Object]
188
196
  def get_nexus_by_form_code(companyId, formCode, options={}) path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
189
- get(path, options) end
197
+ get(path, options, "22.2.0") end
190
198
 
191
199
  # Retrieve a single nexus parameter
192
200
  #
@@ -200,12 +208,13 @@ module AvaTax
200
208
  # ### Security Policies
201
209
  #
202
210
  # * 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.
211
+ # Swagger Name: AvaTaxClient
203
212
  # @param companyId [Integer] The company id
204
213
  # @param nexusId [Integer] The nexus id
205
214
  # @param id [Integer] The parameter id
206
215
  # @return [Object]
207
216
  def get_nexus_parameter(companyId, nexusId, id) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
208
- get(path) end
217
+ get(path, {}, "22.2.0") end
209
218
 
210
219
  # Retrieve nexus for this company
211
220
  #
@@ -224,6 +233,7 @@ module AvaTax
224
233
  # ### Security Policies
225
234
  #
226
235
  # * 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.
236
+ # Swagger Name: AvaTaxClient
227
237
  # @param companyId [Integer] The ID of the company that owns these nexus objects
228
238
  # @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
229
239
  # @param include [String] A comma separated list of additional data to retrieve.
@@ -232,7 +242,7 @@ module AvaTax
232
242
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
233
243
  # @return [FetchResult]
234
244
  def list_nexus_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/nexus"
235
- get(path, options) end
245
+ get(path, options, "22.2.0") end
236
246
 
237
247
  # Retrieve nexus for this company By TaxTypeGroup
238
248
  #
@@ -251,6 +261,7 @@ module AvaTax
251
261
  # ### Security Policies
252
262
  #
253
263
  # * 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.
264
+ # Swagger Name: AvaTaxClient
254
265
  # @param companyId [Integer] The ID of the company that owns these nexus objects
255
266
  # @param taxTypeGroup [String] Name of TaxTypeGroup to filter by
256
267
  # @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
@@ -260,7 +271,7 @@ module AvaTax
260
271
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
261
272
  # @return [FetchResult]
262
273
  def list_nexus_by_company_and_tax_type_group(companyId, taxTypeGroup, options={}) path = "/api/v2/companies/#{companyId}/nexus/byTaxTypeGroup/#{taxTypeGroup}"
263
- get(path, options) end
274
+ get(path, options, "22.2.0") end
264
275
 
265
276
  # Retrieve parameters for a nexus
266
277
  #
@@ -277,6 +288,7 @@ module AvaTax
277
288
  # ### Security Policies
278
289
  #
279
290
  # * 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.
291
+ # Swagger Name: AvaTaxClient
280
292
  # @param companyId [Integer] The company id
281
293
  # @param nexusId [Integer] The nexus id
282
294
  # @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:* name, unit
@@ -285,7 +297,7 @@ module AvaTax
285
297
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
286
298
  # @return [FetchResult]
287
299
  def list_nexus_parameters(companyId, nexusId, options={}) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters"
288
- get(path, options) end
300
+ get(path, options, "22.2.0") end
289
301
 
290
302
  # Retrieve all nexus
291
303
  #
@@ -304,6 +316,7 @@ module AvaTax
304
316
  # ### Security Policies
305
317
  #
306
318
  # * 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.
319
+ # Swagger Name: AvaTaxClient
307
320
  # @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:* streamlinedSalesTax, isSSTActive, taxTypeGroup, taxAuthorityId, taxName, parameters, taxableNexus
308
321
  # @param include [String] A comma separated list of additional data to retrieve.
309
322
  # @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.
@@ -311,7 +324,7 @@ module AvaTax
311
324
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
312
325
  # @return [FetchResult]
313
326
  def query_nexus(options={}) path = "/api/v2/nexus"
314
- get(path, options) end
327
+ get(path, options, "22.2.0") end
315
328
 
316
329
  # Update a single nexus
317
330
  #
@@ -338,12 +351,13 @@ module AvaTax
338
351
  # ### Security Policies
339
352
  #
340
353
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
354
+ # Swagger Name: AvaTaxClient
341
355
  # @param companyId [Integer] The ID of the company that this nexus belongs to.
342
356
  # @param id [Integer] The ID of the nexus you wish to update
343
357
  # @param model [Object] The nexus object you wish to update.
344
358
  # @return [Object]
345
359
  def update_nexus(companyId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
346
- put(path, model) end
360
+ put(path, model, {}, "22.2.0") end
347
361
 
348
362
  # Update an nexus parameter
349
363
  #
@@ -358,13 +372,14 @@ module AvaTax
358
372
  # ### Security Policies
359
373
  #
360
374
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
375
+ # Swagger Name: AvaTaxClient
361
376
  # @param companyId [Integer] The company id.
362
377
  # @param nexusId [Integer] The nexus id
363
378
  # @param id [Integer] The nexus parameter id
364
379
  # @param model [Object] The nexus object you wish to update.
365
380
  # @return [Object]
366
381
  def update_nexus_parameter(companyId, nexusId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{nexusId}/parameters/#{id}"
367
- put(path, model) end
382
+ put(path, model, {}, "22.2.0") end
368
383
  end
369
384
  end
370
385
  end
@@ -11,10 +11,11 @@ module AvaTax
11
11
  #
12
12
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
13
13
  # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
14
+ # Swagger Name: AvaTaxClient
14
15
  # @param model [Object] The responsibility type to create
15
16
  # @return [Object]
16
17
  def create_notice_responsibility_type(model) path = "/api/v2/notices/responsibilities"
17
- post(path, model) end
18
+ post(path, model, {}, "22.2.0") end
18
19
 
19
20
  # Creates a new tax notice root cause type.
20
21
  #
@@ -24,10 +25,11 @@ module AvaTax
24
25
  #
25
26
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
26
27
  # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
28
+ # Swagger Name: AvaTaxClient
27
29
  # @param model [Object] The root cause type to create
28
30
  # @return [Object]
29
31
  def create_notice_root_cause_type(model) path = "/api/v2/notices/rootcauses"
30
- post(path, model) end
32
+ post(path, model, {}, "22.2.0") end
31
33
 
32
34
  # Delete a tax notice responsibility type.
33
35
  #
@@ -36,10 +38,11 @@ module AvaTax
36
38
  # ### Security Policies
37
39
  #
38
40
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
41
+ # Swagger Name: AvaTaxClient
39
42
  # @param responsibilityId [Integer] The unique ID of the responsibility type
40
43
  # @return [ErrorDetail[]]
41
44
  def delete_notice_responsibility_type(responsibilityId) path = "/api/v2/notices/responsibilities/#{responsibilityId}"
42
- delete(path) end
45
+ delete(path, {}, "22.2.0") end
43
46
 
44
47
  # Delete a tax notice root cause type.
45
48
  #
@@ -48,10 +51,11 @@ module AvaTax
48
51
  # ### Security Policies
49
52
  #
50
53
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
54
+ # Swagger Name: AvaTaxClient
51
55
  # @param rootCauseId [Integer] The unique ID of the root cause type
52
56
  # @return [ErrorDetail[]]
53
57
  def delete_notice_root_cause_type(rootCauseId) path = "/api/v2/notices/rootcauses/#{rootCauseId}"
54
- delete(path) end
58
+ delete(path, {}, "22.2.0") end
55
59
  end
56
60
  end
57
61
  end
@@ -23,10 +23,11 @@ module AvaTax
23
23
  # ### Security Policies
24
24
  #
25
25
  # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
26
+ # Swagger Name: AvaTaxClient
26
27
  # @param id [Integer] The id of the notification you wish to mark as dismissed.
27
28
  # @return [Object]
28
29
  def dismiss_notification(id) path = "/api/v2/notifications/#{id}/dismiss"
29
- put(path) end
30
+ put(path, {}, "22.2.0") end
30
31
 
31
32
  # Retrieve a single notification.
32
33
  #
@@ -42,10 +43,11 @@ module AvaTax
42
43
  # ### Security Policies
43
44
  #
44
45
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
46
+ # Swagger Name: AvaTaxClient
45
47
  # @param id [Integer] The id of the notification to retrieve.
46
48
  # @return [Object]
47
49
  def get_notification(id) path = "/api/v2/notifications/#{id}"
48
- get(path) end
50
+ get(path, {}, "22.2.0") end
49
51
 
50
52
  # List all notifications.
51
53
  #
@@ -64,13 +66,14 @@ module AvaTax
64
66
  # ### Security Policies
65
67
  #
66
68
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
69
+ # Swagger Name: AvaTaxClient
67
70
  # @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/).
68
71
  # @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.
69
72
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
70
73
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
71
74
  # @return [FetchResult]
72
75
  def list_notifications(options={}) path = "/api/v2/notifications"
73
- get(path, options) end
76
+ get(path, options, "22.2.0") end
74
77
  end
75
78
  end
76
79
  end