avatax 19.12.1 → 20.1.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.
- checksums.yaml +4 -4
- data/lib/avatax/client/accounts.rb +14 -35
- data/lib/avatax/client/addresses.rb +4 -10
- data/lib/avatax/client/avafileforms.rb +10 -25
- data/lib/avatax/client/batches.rb +12 -30
- data/lib/avatax/client/certexpressinvites.rb +6 -15
- data/lib/avatax/client/certificates.rb +31 -76
- data/lib/avatax/client/companies.rb +32 -80
- data/lib/avatax/client/compliance.rb +2 -5
- data/lib/avatax/client/contacts.rb +12 -30
- data/lib/avatax/client/customers.rb +26 -65
- data/lib/avatax/client/datasources.rb +12 -30
- data/lib/avatax/client/definitions.rb +124 -284
- data/lib/avatax/client/distancethresholds.rb +12 -30
- data/lib/avatax/client/filings.rb +2 -5
- data/lib/avatax/client/firmclientlinkages.rb +18 -45
- data/lib/avatax/client/free.rb +6 -15
- data/lib/avatax/client/fundingrequests.rb +4 -10
- data/lib/avatax/client/items.rb +38 -95
- data/lib/avatax/client/jurisdictionoverrides.rb +12 -30
- data/lib/avatax/client/locations.rb +14 -35
- data/lib/avatax/client/multidocument.rb +20 -50
- data/lib/avatax/client/nexus.rb +16 -40
- data/lib/avatax/client/notifications.rb +6 -15
- data/lib/avatax/client/provisioning.rb +4 -10
- data/lib/avatax/client/registrar.rb +20 -50
- data/lib/avatax/client/reports.rb +8 -20
- data/lib/avatax/client/settings.rb +12 -30
- data/lib/avatax/client/subscriptions.rb +6 -15
- data/lib/avatax/client/taxcodes.rb +12 -30
- data/lib/avatax/client/taxcontent.rb +6 -15
- data/lib/avatax/client/taxrules.rb +12 -30
- data/lib/avatax/client/transactions.rb +49 -112
- data/lib/avatax/client/upcs.rb +12 -30
- data/lib/avatax/client/users.rb +16 -40
- data/lib/avatax/client/utilities.rb +6 -15
- data/lib/avatax/version.rb +1 -1
- metadata +2 -2
@@ -18,11 +18,8 @@ module AvaTax
|
|
18
18
|
# @param accountId [Integer] The ID of the account that owns this override
|
19
19
|
# @param model [JurisdictionOverrideModel[]] The jurisdiction override objects to create
|
20
20
|
# @return [JurisdictionOverrideModel[]]
|
21
|
-
def create_jurisdiction_overrides(accountId, model)
|
22
|
-
path
|
23
|
-
post(path, model)
|
24
|
-
end
|
25
|
-
|
21
|
+
def create_jurisdiction_overrides(accountId, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
22
|
+
post(path, model) end
|
26
23
|
|
27
24
|
# Delete a single override
|
28
25
|
#
|
@@ -34,11 +31,8 @@ module AvaTax
|
|
34
31
|
# @param accountId [Integer] The ID of the account that owns this override
|
35
32
|
# @param id [Integer] The ID of the override you wish to delete
|
36
33
|
# @return [ErrorDetail[]]
|
37
|
-
def delete_jurisdiction_override(accountId, id)
|
38
|
-
path
|
39
|
-
delete(path)
|
40
|
-
end
|
41
|
-
|
34
|
+
def delete_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
35
|
+
delete(path) end
|
42
36
|
|
43
37
|
# Retrieve a single override
|
44
38
|
#
|
@@ -55,11 +49,8 @@ module AvaTax
|
|
55
49
|
# @param accountId [Integer] The ID of the account that owns this override
|
56
50
|
# @param id [Integer] The primary key of this override
|
57
51
|
# @return [Object]
|
58
|
-
def get_jurisdiction_override(accountId, id)
|
59
|
-
path
|
60
|
-
get(path)
|
61
|
-
end
|
62
|
-
|
52
|
+
def get_jurisdiction_override(accountId, id) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
53
|
+
get(path) end
|
63
54
|
|
64
55
|
# Retrieve overrides for this account
|
65
56
|
#
|
@@ -83,11 +74,8 @@ module AvaTax
|
|
83
74
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
84
75
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
85
76
|
# @return [FetchResult]
|
86
|
-
def list_jurisdiction_overrides_by_account(accountId, options={})
|
87
|
-
path
|
88
|
-
get(path, options)
|
89
|
-
end
|
90
|
-
|
77
|
+
def list_jurisdiction_overrides_by_account(accountId, options={}) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides"
|
78
|
+
get(path, options) end
|
91
79
|
|
92
80
|
# Retrieve all overrides
|
93
81
|
#
|
@@ -110,11 +98,8 @@ module AvaTax
|
|
110
98
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
111
99
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
112
100
|
# @return [FetchResult]
|
113
|
-
def query_jurisdiction_overrides(options={})
|
114
|
-
path
|
115
|
-
get(path, options)
|
116
|
-
end
|
117
|
-
|
101
|
+
def query_jurisdiction_overrides(options={}) path = "/api/v2/jurisdictionoverrides"
|
102
|
+
get(path, options) end
|
118
103
|
|
119
104
|
# Update a single jurisdictionoverride
|
120
105
|
#
|
@@ -127,11 +112,8 @@ module AvaTax
|
|
127
112
|
# @param id [Integer] The ID of the jurisdictionoverride you wish to update
|
128
113
|
# @param model [Object] The jurisdictionoverride object you wish to update.
|
129
114
|
# @return [Object]
|
130
|
-
def update_jurisdiction_override(accountId, id, model)
|
131
|
-
path
|
132
|
-
put(path, model)
|
133
|
-
end
|
134
|
-
|
115
|
+
def update_jurisdiction_override(accountId, id, model) path = "/api/v2/accounts/#{accountId}/jurisdictionoverrides/#{id}"
|
116
|
+
put(path, model) end
|
135
117
|
end
|
136
118
|
end
|
137
119
|
end
|
@@ -13,11 +13,8 @@ module AvaTax
|
|
13
13
|
# @param companyId [Integer] The ID of the company that owns this location.
|
14
14
|
# @param model [LocationModel[]] The location you wish to create.
|
15
15
|
# @return [LocationModel[]]
|
16
|
-
def create_locations(companyId, model)
|
17
|
-
path
|
18
|
-
post(path, model)
|
19
|
-
end
|
20
|
-
|
16
|
+
def create_locations(companyId, model) path = "/api/v2/companies/#{companyId}/locations"
|
17
|
+
post(path, model) end
|
21
18
|
|
22
19
|
# Delete a single location
|
23
20
|
#
|
@@ -29,11 +26,8 @@ module AvaTax
|
|
29
26
|
# @param companyId [Integer] The ID of the company that owns this location.
|
30
27
|
# @param id [Integer] The ID of the location you wish to delete.
|
31
28
|
# @return [ErrorDetail[]]
|
32
|
-
def delete_location(companyId, id)
|
33
|
-
path
|
34
|
-
delete(path)
|
35
|
-
end
|
36
|
-
|
29
|
+
def delete_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
30
|
+
delete(path) end
|
37
31
|
|
38
32
|
# Retrieve a single location
|
39
33
|
#
|
@@ -54,11 +48,8 @@ module AvaTax
|
|
54
48
|
# @param id [Integer] The primary key of this location
|
55
49
|
# @param include [String] A comma separated list of additional data to retrieve. You may specify `LocationSettings` to retrieve location settings.
|
56
50
|
# @return [Object]
|
57
|
-
def get_location(companyId, id, options={})
|
58
|
-
path
|
59
|
-
get(path, options)
|
60
|
-
end
|
61
|
-
|
51
|
+
def get_location(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
52
|
+
get(path, options) end
|
62
53
|
|
63
54
|
# Retrieve locations for this company
|
64
55
|
#
|
@@ -84,11 +75,8 @@ module AvaTax
|
|
84
75
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
85
76
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
86
77
|
# @return [FetchResult]
|
87
|
-
def list_locations_by_company(companyId, options={})
|
88
|
-
path
|
89
|
-
get(path, options)
|
90
|
-
end
|
91
|
-
|
78
|
+
def list_locations_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/locations"
|
79
|
+
get(path, options) end
|
92
80
|
|
93
81
|
# Retrieve all locations
|
94
82
|
#
|
@@ -114,11 +102,8 @@ module AvaTax
|
|
114
102
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
115
103
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
116
104
|
# @return [FetchResult]
|
117
|
-
def query_locations(options={})
|
118
|
-
path
|
119
|
-
get(path, options)
|
120
|
-
end
|
121
|
-
|
105
|
+
def query_locations(options={}) path = "/api/v2/locations"
|
106
|
+
get(path, options) end
|
122
107
|
|
123
108
|
# Update a single location
|
124
109
|
#
|
@@ -133,11 +118,8 @@ module AvaTax
|
|
133
118
|
# @param id [Integer] The ID of the location you wish to update
|
134
119
|
# @param model [Object] The location you wish to update.
|
135
120
|
# @return [Object]
|
136
|
-
def update_location(companyId, id, model)
|
137
|
-
path
|
138
|
-
put(path, model)
|
139
|
-
end
|
140
|
-
|
121
|
+
def update_location(companyId, id, model) path = "/api/v2/companies/#{companyId}/locations/#{id}"
|
122
|
+
put(path, model) end
|
141
123
|
|
142
124
|
# Validate the location against local requirements
|
143
125
|
#
|
@@ -151,11 +133,8 @@ module AvaTax
|
|
151
133
|
# @param companyId [Integer] The ID of the company that owns this location
|
152
134
|
# @param id [Integer] The primary key of this location
|
153
135
|
# @return [Object]
|
154
|
-
def validate_location(companyId, id)
|
155
|
-
path
|
156
|
-
get(path)
|
157
|
-
end
|
158
|
-
|
136
|
+
def validate_location(companyId, id) path = "/api/v2/companies/#{companyId}/locations/#{id}/validate"
|
137
|
+
get(path) end
|
159
138
|
end
|
160
139
|
end
|
161
140
|
end
|
@@ -25,11 +25,8 @@ module AvaTax
|
|
25
25
|
# @param include [String] Specifies objects to include in this fetch call
|
26
26
|
# @param model [Object] The adjust request you wish to execute
|
27
27
|
# @return [Object]
|
28
|
-
def adjust_multi_document_transaction(code, type, model, options={})
|
29
|
-
path
|
30
|
-
post(path, model, options)
|
31
|
-
end
|
32
|
-
|
28
|
+
def adjust_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/adjust"
|
29
|
+
post(path, model, options) end
|
33
30
|
|
34
31
|
# Get audit information about a MultiDocument transaction
|
35
32
|
#
|
@@ -55,11 +52,8 @@ module AvaTax
|
|
55
52
|
# @param code [String] The transaction code for this MultiDocument transaction
|
56
53
|
# @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
|
57
54
|
# @return [Object]
|
58
|
-
def audit_multi_document_transaction(code, type)
|
59
|
-
path
|
60
|
-
get(path)
|
61
|
-
end
|
62
|
-
|
55
|
+
def audit_multi_document_transaction(code, type) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/audit"
|
56
|
+
get(path) end
|
63
57
|
|
64
58
|
# Commit a MultiDocument transaction
|
65
59
|
#
|
@@ -78,11 +72,8 @@ module AvaTax
|
|
78
72
|
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
79
73
|
# @param model [Object] The commit request you wish to execute
|
80
74
|
# @return [Object]
|
81
|
-
def commit_multi_document_transaction(model)
|
82
|
-
path
|
83
|
-
post(path, model)
|
84
|
-
end
|
85
|
-
|
75
|
+
def commit_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/commit"
|
76
|
+
post(path, model) end
|
86
77
|
|
87
78
|
# Create a new MultiDocument transaction
|
88
79
|
#
|
@@ -126,11 +117,8 @@ module AvaTax
|
|
126
117
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
127
118
|
# @param model [Object] the multi document transaction model
|
128
119
|
# @return [Object]
|
129
|
-
def create_multi_document_transaction(model, options={})
|
130
|
-
path
|
131
|
-
post(path, model, options)
|
132
|
-
end
|
133
|
-
|
120
|
+
def create_multi_document_transaction(model, options={}) path = "/api/v2/transactions/multidocument"
|
121
|
+
post(path, model, options) end
|
134
122
|
|
135
123
|
# Retrieve a MultiDocument transaction
|
136
124
|
#
|
@@ -155,11 +143,8 @@ module AvaTax
|
|
155
143
|
# @param type [String] (See DocumentType::* for a list of allowable values)
|
156
144
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
157
145
|
# @return [Object]
|
158
|
-
def get_multi_document_transaction_by_code_and_type(code, type, options={})
|
159
|
-
path
|
160
|
-
get(path, options)
|
161
|
-
end
|
162
|
-
|
146
|
+
def get_multi_document_transaction_by_code_and_type(code, type, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}"
|
147
|
+
get(path, options) end
|
163
148
|
|
164
149
|
# Retrieve a MultiDocument transaction by ID
|
165
150
|
#
|
@@ -192,11 +177,8 @@ module AvaTax
|
|
192
177
|
# @param id [Integer] The unique ID number of the MultiDocument transaction to retrieve
|
193
178
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
194
179
|
# @return [Object]
|
195
|
-
def get_multi_document_transaction_by_id(id, options={})
|
196
|
-
path
|
197
|
-
get(path, options)
|
198
|
-
end
|
199
|
-
|
180
|
+
def get_multi_document_transaction_by_id(id, options={}) path = "/api/v2/transactions/multidocument/#{id}"
|
181
|
+
get(path, options) end
|
200
182
|
|
201
183
|
# Retrieve all MultiDocument transactions
|
202
184
|
#
|
@@ -230,11 +212,8 @@ module AvaTax
|
|
230
212
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
231
213
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
232
214
|
# @return [FetchResult]
|
233
|
-
def list_multi_document_transactions(options={})
|
234
|
-
path
|
235
|
-
get(path, options)
|
236
|
-
end
|
237
|
-
|
215
|
+
def list_multi_document_transactions(options={}) path = "/api/v2/transactions/multidocument"
|
216
|
+
get(path, options) end
|
238
217
|
|
239
218
|
# Create a refund for a MultiDocument transaction
|
240
219
|
#
|
@@ -284,11 +263,8 @@ module AvaTax
|
|
284
263
|
# @param include [String] Specifies objects to include in the response after transaction is created
|
285
264
|
# @param model [Object] Information about the refund to create
|
286
265
|
# @return [Object]
|
287
|
-
def refund_multi_document_transaction(code, type, model, options={})
|
288
|
-
path
|
289
|
-
post(path, model, options)
|
290
|
-
end
|
291
|
-
|
266
|
+
def refund_multi_document_transaction(code, type, model, options={}) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/refund"
|
267
|
+
post(path, model, options) end
|
292
268
|
|
293
269
|
# Verify a MultiDocument transaction
|
294
270
|
#
|
@@ -305,11 +281,8 @@ module AvaTax
|
|
305
281
|
# * This API depends on the following active services<br />*Required* (all): AvaTaxPro.
|
306
282
|
# @param model [Object] Information from your accounting system to verify against this MultiDocument transaction as it is stored in AvaTax
|
307
283
|
# @return [Object]
|
308
|
-
def verify_multi_document_transaction(model)
|
309
|
-
path
|
310
|
-
post(path, model)
|
311
|
-
end
|
312
|
-
|
284
|
+
def verify_multi_document_transaction(model) path = "/api/v2/transactions/multidocument/verify"
|
285
|
+
post(path, model) end
|
313
286
|
|
314
287
|
# Void a MultiDocument transaction
|
315
288
|
#
|
@@ -331,11 +304,8 @@ module AvaTax
|
|
331
304
|
# @param type [String] The transaction type for this MultiDocument transaction (See DocumentType::* for a list of allowable values)
|
332
305
|
# @param model [Object] The void request you wish to execute
|
333
306
|
# @return [Object]
|
334
|
-
def void_multi_document_transaction(code, type, model)
|
335
|
-
path
|
336
|
-
post(path, model)
|
337
|
-
end
|
338
|
-
|
307
|
+
def void_multi_document_transaction(code, type, model) path = "/api/v2/transactions/multidocument/#{code}/type/#{type}/void"
|
308
|
+
post(path, model) end
|
339
309
|
end
|
340
310
|
end
|
341
311
|
end
|
data/lib/avatax/client/nexus.rb
CHANGED
@@ -31,11 +31,8 @@ module AvaTax
|
|
31
31
|
# @param companyId [Integer] The ID of the company that owns this nexus.
|
32
32
|
# @param model [NexusModel[]] The nexus you wish to create.
|
33
33
|
# @return [NexusModel[]]
|
34
|
-
def create_nexus(companyId, model)
|
35
|
-
path
|
36
|
-
post(path, model)
|
37
|
-
end
|
38
|
-
|
34
|
+
def create_nexus(companyId, model) path = "/api/v2/companies/#{companyId}/nexus"
|
35
|
+
post(path, model) end
|
39
36
|
|
40
37
|
# Creates nexus for a list of addresses.
|
41
38
|
#
|
@@ -61,11 +58,8 @@ module AvaTax
|
|
61
58
|
# @param companyId [Integer] The ID of the company that will own this nexus.
|
62
59
|
# @param model [DeclareNexusByAddressModel[]] The nexus you wish to create.
|
63
60
|
# @return [NexusByAddressModel[]]
|
64
|
-
def declare_nexus_by_address(companyId, model)
|
65
|
-
path
|
66
|
-
post(path, model)
|
67
|
-
end
|
68
|
-
|
61
|
+
def declare_nexus_by_address(companyId, model) path = "/api/v2/companies/#{companyId}/nexus/byaddress"
|
62
|
+
post(path, model) end
|
69
63
|
|
70
64
|
# Delete a single nexus
|
71
65
|
#
|
@@ -84,11 +78,8 @@ module AvaTax
|
|
84
78
|
# @param companyId [Integer] The ID of the company that owns this nexus.
|
85
79
|
# @param id [Integer] The ID of the nexus you wish to delete.
|
86
80
|
# @return [ErrorDetail[]]
|
87
|
-
def delete_nexus(companyId, id)
|
88
|
-
path
|
89
|
-
delete(path)
|
90
|
-
end
|
91
|
-
|
81
|
+
def delete_nexus(companyId, id) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
82
|
+
delete(path) end
|
92
83
|
|
93
84
|
# Retrieve a single nexus
|
94
85
|
#
|
@@ -104,11 +95,8 @@ module AvaTax
|
|
104
95
|
# @param companyId [Integer] The ID of the company that owns this nexus object
|
105
96
|
# @param id [Integer] The primary key of this nexus
|
106
97
|
# @return [Object]
|
107
|
-
def get_nexus(companyId, id)
|
108
|
-
path
|
109
|
-
get(path)
|
110
|
-
end
|
111
|
-
|
98
|
+
def get_nexus(companyId, id) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
99
|
+
get(path) end
|
112
100
|
|
113
101
|
# List company nexus related to a tax form
|
114
102
|
#
|
@@ -128,11 +116,8 @@ module AvaTax
|
|
128
116
|
# @param companyId [Integer] The ID of the company that owns this nexus object
|
129
117
|
# @param formCode [String] The form code that we are looking up the nexus for
|
130
118
|
# @return [Object]
|
131
|
-
def get_nexus_by_form_code(companyId, formCode)
|
132
|
-
path
|
133
|
-
get(path)
|
134
|
-
end
|
135
|
-
|
119
|
+
def get_nexus_by_form_code(companyId, formCode) path = "/api/v2/companies/#{companyId}/nexus/byform/#{formCode}"
|
120
|
+
get(path) end
|
136
121
|
|
137
122
|
# Retrieve nexus for this company
|
138
123
|
#
|
@@ -155,11 +140,8 @@ module AvaTax
|
|
155
140
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
156
141
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
157
142
|
# @return [FetchResult]
|
158
|
-
def list_nexus_by_company(companyId, options={})
|
159
|
-
path
|
160
|
-
get(path, options)
|
161
|
-
end
|
162
|
-
|
143
|
+
def list_nexus_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/nexus"
|
144
|
+
get(path, options) end
|
163
145
|
|
164
146
|
# Retrieve all nexus
|
165
147
|
#
|
@@ -181,11 +163,8 @@ module AvaTax
|
|
181
163
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
182
164
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
183
165
|
# @return [FetchResult]
|
184
|
-
def query_nexus(options={})
|
185
|
-
path
|
186
|
-
get(path, options)
|
187
|
-
end
|
188
|
-
|
166
|
+
def query_nexus(options={}) path = "/api/v2/nexus"
|
167
|
+
get(path, options) end
|
189
168
|
|
190
169
|
# Update a single nexus
|
191
170
|
#
|
@@ -216,11 +195,8 @@ module AvaTax
|
|
216
195
|
# @param id [Integer] The ID of the nexus you wish to update
|
217
196
|
# @param model [Object] The nexus object you wish to update.
|
218
197
|
# @return [Object]
|
219
|
-
def update_nexus(companyId, id, model)
|
220
|
-
path
|
221
|
-
put(path, model)
|
222
|
-
end
|
223
|
-
|
198
|
+
def update_nexus(companyId, id, model) path = "/api/v2/companies/#{companyId}/nexus/#{id}"
|
199
|
+
put(path, model) end
|
224
200
|
end
|
225
201
|
end
|
226
202
|
end
|
@@ -25,11 +25,8 @@ module AvaTax
|
|
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
26
|
# @param id [Integer] The id of the notification you wish to mark as dismissed.
|
27
27
|
# @return [Object]
|
28
|
-
def dismiss_notification(id)
|
29
|
-
path
|
30
|
-
put(path)
|
31
|
-
end
|
32
|
-
|
28
|
+
def dismiss_notification(id) path = "/api/v2/notifications/#{id}/dismiss"
|
29
|
+
put(path) end
|
33
30
|
|
34
31
|
# Retrieve a single notification.
|
35
32
|
#
|
@@ -47,11 +44,8 @@ module AvaTax
|
|
47
44
|
# * 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.
|
48
45
|
# @param id [Integer] The id of the notification to retrieve.
|
49
46
|
# @return [Object]
|
50
|
-
def get_notification(id)
|
51
|
-
path
|
52
|
-
get(path)
|
53
|
-
end
|
54
|
-
|
47
|
+
def get_notification(id) path = "/api/v2/notifications/#{id}"
|
48
|
+
get(path) end
|
55
49
|
|
56
50
|
# List all notifications.
|
57
51
|
#
|
@@ -75,11 +69,8 @@ module AvaTax
|
|
75
69
|
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
76
70
|
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
77
71
|
# @return [FetchResult]
|
78
|
-
def list_notifications(options={})
|
79
|
-
path
|
80
|
-
get(path, options)
|
81
|
-
end
|
82
|
-
|
72
|
+
def list_notifications(options={}) path = "/api/v2/notifications"
|
73
|
+
get(path, options) end
|
83
74
|
end
|
84
75
|
end
|
85
76
|
end
|