avatax 18.5.1 → 18.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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 2a76fdb83a5c471fa9773fd14b692eedc72dcfcc40d0b5a64b4a702bfc2888bc
4
- data.tar.gz: 2756b24bd169058892928ffb36c949523558326f3f558558f4d1686ee22bd589
3
+ metadata.gz: ee85cb2ad965a98ca293c0e2c9cfcfad65c776cabb455e9e8bc53167c80301e9
4
+ data.tar.gz: 034f1d99a65944c9ddfd594ab91cfc7f89b9e6d6bad57d9485d0b099aa1373ab
5
5
  SHA512:
6
- metadata.gz: 182a5ae62e391f7d0501c6be42626a05815c26c5e3fe7e288ffdceeeca5083034ee9200077b58fbe73a51f677b4850f95dd18cd0759970104bbb421559d224fe
7
- data.tar.gz: b12f298325080c3188ec59148f7ca2dea3376559f2b555a600482b21f1d20a004cbce4bda0e4ee6a75f4c1a7249f596938b21b4a7a971621d179463b9a5c6a42
6
+ metadata.gz: c6194d2b8d143dc402fe472cccba23e7ec00fba4b7b4f7b5cab27a375256ef1842c535b4c8b10bcba77d643ad71e543f291ad08d24ccb67c363ba61e9f1f6d60
7
+ data.tar.gz: 011b78bba1aacdd6df2b9ace456de797b28d96379b7df26fe056d067905a950d21a56a6d8248a389f4f4c3954aaa1f6f4560d890f0674e1a0e176759e7545190
@@ -86,6 +86,32 @@ module AvaTax
86
86
  end
87
87
 
88
88
 
89
+ # Retrieve all accounts
90
+ #
91
+ # List all account objects that can be seen by the current user.
92
+ #
93
+ # This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account.
94
+ #
95
+ # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
96
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
97
+ # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
98
+ #
99
+ # * Subscriptions
100
+ # * Users
101
+ #
102
+ # For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
103
+ # @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
104
+ # @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/) .
105
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
106
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
107
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
108
+ # @return [FetchResult]
109
+ def query_accounts(options={})
110
+ path = "/api/v2/accounts"
111
+ get(path, options)
112
+ end
113
+
114
+
89
115
  # Change configuration settings for this account
90
116
  #
91
117
  # Update configuration settings tied to this account.
@@ -188,7 +188,7 @@ module AvaTax
188
188
  # Retrieve the list of attributes that are linked to this certificate.
189
189
  #
190
190
  # A certificate may have multiple attributes that control its behavior. You may link or unlink attributes to a
191
- # certificate at any time. The full list of defined attributes may be found using `/api/v2/definitions/certificateattributes`.
191
+ # certificate at any time. The full list of defined attributes may be found using [ListCertificateAttributes](https://developer.avalara.com/api-reference/avatax/rest/v2/methods/Definitions/ListCertificateAttributes/) API.
192
192
  #
193
193
  # A certificate is a document stored in either AvaTax Exemptions or CertCapture. The certificate document
194
194
  # can contain information about a customer's eligibility for exemption from sales or use taxes based on
@@ -220,7 +220,9 @@ module AvaTax
220
220
  # Retrieve all companies
221
221
  #
222
222
  # Get multiple company objects.
223
- # A 'company' represents a single corporation or individual that is registered to handle transactional taxes.
223
+ #
224
+ # A `company` represents a single corporation or individual that is registered to handle transactional taxes.
225
+ #
224
226
  # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
225
227
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
226
228
  # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
@@ -3,22 +3,6 @@ module AvaTax
3
3
  module Notices
4
4
 
5
5
 
6
- # Delete a single notice.
7
- #
8
- # This API is available by invitation only.
9
- # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
10
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
11
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
12
- # @param companyId [Integer] The ID of the company that owns this notice.
13
- # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
14
- # @param commentDetailsId [Integer] The ID of the comment you wish to delete.
15
- # @return [ErrorDetail[]]
16
- def comment_details_delete(companyId, id, commentDetailsId)
17
- path = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
18
- delete(path)
19
- end
20
-
21
-
22
6
  # Create a new notice comment.
23
7
  #
24
8
  # This API is available by invitation only.
@@ -99,6 +83,39 @@ module AvaTax
99
83
  end
100
84
 
101
85
 
86
+ # Delete a single notice.
87
+ #
88
+ # This API is available by invitation only.
89
+ # 'Notice comments' are updates by the notice team on the work to be done and that has been done so far on a notice.
90
+ # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
91
+ # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
92
+ # @param companyId [Integer] The ID of the company that owns this notice.
93
+ # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
94
+ # @param commentDetailsId [Integer] The ID of the comment you wish to delete.
95
+ # @return [ErrorDetail[]]
96
+ def delete_comment_details(companyId, id, commentDetailsId)
97
+ path = "/api/v2/companies/#{companyId}/notices/#{id}/commentdetails/#{commentdetailsid}"
98
+ delete(path)
99
+ end
100
+
101
+
102
+ # Delete a single notice.
103
+ #
104
+ # This API is available by invitation only.
105
+ # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
106
+ # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
107
+ # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
108
+ # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
109
+ # @param companyId [Integer] The ID of the company that owns this notice.
110
+ # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
111
+ # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
112
+ # @return [ErrorDetail[]]
113
+ def delete_finance_details(companyId, id, financeDetailsId)
114
+ path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
115
+ delete(path)
116
+ end
117
+
118
+
102
119
  # Delete a single notice.
103
120
  #
104
121
  # This API is available by invitation only.
@@ -159,23 +176,6 @@ module AvaTax
159
176
  end
160
177
 
161
178
 
162
- # Delete a single notice.
163
- #
164
- # This API is available by invitation only.
165
- # 'Notice finance details' is the categorical breakdown of the total charge levied by the tax authority on our customer,
166
- # as broken down in our "notice log" found in Workflow. Main examples of the categories are 'Tax Due', 'Interest', 'Penalty', 'Total Abated'.
167
- # A 'notice' represents a letter sent to a business by a tax authority regarding tax filing issues. Avalara
168
- # Returns customers often receive support and assistance from the Compliance Notices team in handling notices received by taxing authorities.
169
- # @param companyId [Integer] The ID of the company that owns this notice.
170
- # @param id [Integer] The ID of the notice you wish to delete the finance detail from.
171
- # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
172
- # @return [ErrorDetail[]]
173
- def financedetailsdelete(companyId, id, financeDetailsId)
174
- path = "/api/v2/companies/#{companyId}/notices/#{id}/financedetails/#{financedetailsid}"
175
- delete(path)
176
- end
177
-
178
-
179
179
  # Retrieve a single notice.
180
180
  #
181
181
  # This API is available by invitation only.
@@ -295,6 +295,22 @@ module AvaTax
295
295
  end
296
296
 
297
297
 
298
+ # Update a single notice finance detail.
299
+ #
300
+ # This API is available by invitation only.
301
+ # All data from the existing object will be replaced with data in the object you PUT.
302
+ # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
303
+ # @param companyId [Integer] The ID of the company that this notice finance detail belongs to.
304
+ # @param noticeid [Integer] The ID of the notice finance detail you wish to update.
305
+ # @param financeDetailsId [Integer] The ID of the finance detail you wish to delete.
306
+ # @param model [Object] The notice finance detail object you wish to update.
307
+ # @return [Object]
308
+ def update_finance_details(companyId, noticeid, financeDetailsId, model)
309
+ path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/financedetails/#{financedetailsid}"
310
+ put(path, model)
311
+ end
312
+
313
+
298
314
  # Update a single notice.
299
315
  #
300
316
  # This API is available by invitation only.
@@ -313,6 +329,22 @@ module AvaTax
313
329
  end
314
330
 
315
331
 
332
+ # Update a single notice comment.
333
+ #
334
+ # This API is available by invitation only.
335
+ # All data from the existing object will be replaced with data in the object you PUT.
336
+ # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
337
+ # @param companyId [Integer] The ID of the company that this notice comment belongs to.
338
+ # @param noticeid [Integer] The ID of the notice you wish to update.
339
+ # @param commentDetailsId [Integer] The ID of the comment you wish to update.
340
+ # @param model [Object] The notice comment object you wish to update.
341
+ # @return [Object]
342
+ def update_notice_comments(companyId, noticeid, commentDetailsId, model)
343
+ path = "/api/v2/companies/#{companyId}/notices/#{noticeid}/commentdetails/#{commentdetailsid}"
344
+ put(path, model)
345
+ end
346
+
347
+
316
348
  # Retrieve a single attachment
317
349
  #
318
350
  # This API is available by invitation only.
@@ -0,0 +1,71 @@
1
+ module AvaTax
2
+ class Client
3
+ module Notifications
4
+
5
+
6
+ # Mark a single notification as dismissed.
7
+ #
8
+ # Marks the notification identified by this URL as dismissed.
9
+ #
10
+ # A notification is a message from Avalara that may have relevance to your business. You may want
11
+ # to regularly review notifications and then dismiss them when you are certain that you have addressed
12
+ # any relevant concerns raised by this notification.
13
+ #
14
+ # An example of a notification would be a message about new software, or a change to AvaTax that may
15
+ # affect you, or a potential issue with your company's tax profile.
16
+ #
17
+ # When you dismiss a notification, the notification will track the user and time when it was
18
+ # dismissed. You can then later review which employees of your company dismissed notifications to
19
+ # determine if they were resolved appropriately.
20
+ # @param id [Integer] The id of the notification you wish to mark as dismissed.
21
+ # @return [Object]
22
+ def dismiss_notification(id)
23
+ path = "/api/v2/notifications/#{id}/dismiss"
24
+ put(path)
25
+ end
26
+
27
+
28
+ # Retrieve a single notification.
29
+ #
30
+ # Retrieve a single notification by its unique ID number.
31
+ #
32
+ # A notification is a message from Avalara that may have relevance to your business. You may want
33
+ # to regularly review notifications and then dismiss them when you are certain that you have addressed
34
+ # any relevant concerns raised by this notification.
35
+ #
36
+ # An example of a notification would be a message about new software, or a change to AvaTax that may
37
+ # affect you, or a potential issue with your company's tax profile.
38
+ # @param id [Integer] The id of the notification to retrieve.
39
+ # @return [Object]
40
+ def get_notification(id)
41
+ path = "/api/v2/notifications/#{id}"
42
+ get(path)
43
+ end
44
+
45
+
46
+ # List all notifications.
47
+ #
48
+ # List all notifications.
49
+ #
50
+ # A notification is a message from Avalara that may have relevance to your business. You may want
51
+ # to regularly review notifications and then dismiss them when you are certain that you have addressed
52
+ # any relevant concerns raised by this notification.
53
+ #
54
+ # An example of a notification would be a message about new software, or a change to AvaTax that may
55
+ # affect you, or a potential issue with your company's tax profile.
56
+ #
57
+ # You may search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
58
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
59
+ # @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/) .
60
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
61
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
62
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
63
+ # @return [FetchResult]
64
+ def list_notifications(options={})
65
+ path = "/api/v2/notifications"
66
+ get(path, options)
67
+ end
68
+
69
+ end
70
+ end
71
+ end
@@ -26,6 +26,19 @@ module AvaTax
26
26
  post(path, model)
27
27
  end
28
28
 
29
+
30
+ # Request a new entitilement to an existing customer
31
+ #
32
+ # This API is for use by partner onboarding services customers only. This will allow the partners to allow
33
+ # the add new entitlement to an existing customer
34
+ # @param id [Integer] The avatax account id of the customer
35
+ # @param offer [String] The offer to be added to an already existing customer
36
+ # @return [Object]
37
+ def request_new_entitlement(id, offer)
38
+ path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
39
+ post(path)
40
+ end
41
+
29
42
  end
30
43
  end
31
44
  end
@@ -34,6 +34,26 @@ module AvaTax
34
34
  end
35
35
 
36
36
 
37
+ # Create new notifications.
38
+ #
39
+ # This API is available by invitation only.
40
+ #
41
+ # Create a single notification.
42
+ #
43
+ # A notification is a message from Avalara that may have relevance to your business. You may want
44
+ # to regularly review notifications and then dismiss them when you are certain that you have addressed
45
+ # any relevant concerns raised by this notification.
46
+ #
47
+ # An example of a notification would be a message about new software, or a change to AvaTax that may
48
+ # affect you, or a potential issue with your company's tax profile.
49
+ # @param model [NotificationModel[]] The notifications you wish to create.
50
+ # @return [NotificationModel[]]
51
+ def create_notifications(model)
52
+ path = "/api/v2/notifications"
53
+ post(path, model)
54
+ end
55
+
56
+
37
57
  # Create a new subscription
38
58
  #
39
59
  # # For Registrar Use Only
@@ -66,6 +86,26 @@ module AvaTax
66
86
  end
67
87
 
68
88
 
89
+ # Delete a single notification.
90
+ #
91
+ # This API is available by invitation only.
92
+ #
93
+ # Delete the existing notification identified by this URL.
94
+ #
95
+ # A notification is a message from Avalara that may have relevance to your business. You may want
96
+ # to regularly review notifications and then dismiss them when you are certain that you have addressed
97
+ # any relevant concerns raised by this notification.
98
+ #
99
+ # An example of a notification would be a message about new software, or a change to AvaTax that may
100
+ # affect you, or a potential issue with your company's tax profile.
101
+ # @param id [Integer] The id of the notification you wish to delete.
102
+ # @return [ErrorDetail[]]
103
+ def delete_notification(id)
104
+ path = "/api/v2/notifications/#{id}"
105
+ delete(path)
106
+ end
107
+
108
+
69
109
  # Delete a single subscription
70
110
  #
71
111
  # # For Registrar Use Only
@@ -96,32 +136,6 @@ module AvaTax
96
136
  end
97
137
 
98
138
 
99
- # Retrieve all accounts
100
- #
101
- # # For Registrar Use Only
102
- # This API is for use by Avalara Registrar administrative users only.
103
- #
104
- # Get multiple account objects.
105
- # Search for specific objects using the criteria in the `$filter` parameter; full documentation is available on [Filtering in REST](http://developer.avalara.com/avatax/filtering-in-rest/) .
106
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
107
- # You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
108
- #
109
- # * Subscriptions
110
- # * Users
111
- #
112
- # For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
113
- # @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
114
- # @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/) .
115
- # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
116
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
117
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
118
- # @return [FetchResult]
119
- def query_accounts(options={})
120
- path = "/api/v2/accounts"
121
- get(path, options)
122
- end
123
-
124
-
125
139
  # Reset a user's password programmatically
126
140
  #
127
141
  # # For Registrar Use Only
@@ -154,6 +168,27 @@ module AvaTax
154
168
  end
155
169
 
156
170
 
171
+ # Update a single notification.
172
+ #
173
+ # This API is available by invitation only.
174
+ #
175
+ # Replaces the notification identified by this URL with a new notification.
176
+ #
177
+ # A notification is a message from Avalara that may have relevance to your business. You may want
178
+ # to regularly review notifications and then dismiss them when you are certain that you have addressed
179
+ # any relevant concerns raised by this notification.
180
+ #
181
+ # An example of a notification would be a message about new software, or a change to AvaTax that may
182
+ # affect you, or a potential issue with your company's tax profile.
183
+ # @param id [Integer] The id of the notification you wish to update.
184
+ # @param model [Object] The notification object you wish to update.
185
+ # @return [Object]
186
+ def update_notification(id, model)
187
+ path = "/api/v2/notifications/#{id}"
188
+ put(path, model)
189
+ end
190
+
191
+
157
192
  # Update a single subscription
158
193
  #
159
194
  # # For Registrar Use Only
@@ -7,8 +7,12 @@ module AvaTax
7
7
  #
8
8
  # Builds a tax content file containing information useful for a retail point-of-sale solution.
9
9
  #
10
- # This file contains tax rates and rules for items and locations that can be used
11
- # to correctly calculate tax in the event a point-of-sale device is not able to reach AvaTax.
10
+ # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
11
+ # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
12
+ # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
13
+ # item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content
14
+ # file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,
15
+ # then use `CreateItems()` to create an item that uses the custom tax code.
12
16
  #
13
17
  # This data file can be customized for specific partner devices and usage conditions.
14
18
  #
@@ -30,8 +34,12 @@ module AvaTax
30
34
  #
31
35
  # Builds a tax content file containing information useful for a retail point-of-sale solution.
32
36
  #
33
- # This file contains tax rates and rules for all items for a single location. Data from this API
34
- # can be used to correctly calculate tax in the event a point-of-sale device is not able to reach AvaTax.
37
+ # A TaxContent file contains a matrix of the taxes that would be charged when you sell any of your
38
+ # Items at any of your Locations. To create items, use `CreateItems()`. To create locations, use
39
+ # `CreateLocations()`. The file is built by looking up the tax profile for your location and your
40
+ # item and calculating taxes for each in turn. To include a custom `TaxCode` in this tax content
41
+ # file, first create the custom tax code using `CreateTaxCodes()` to create the custom tax code,
42
+ # then use `CreateItems()` to create an item that uses the custom tax code.
35
43
  #
36
44
  # This data file can be customized for specific partner devices and usage conditions.
37
45
  #
@@ -1,3 +1,3 @@
1
1
  module AvaTax
2
- VERSION = '18.5.1'.freeze unless defined?(::AvaTax::VERSION)
2
+ VERSION = '18.6.1'.freeze unless defined?(::AvaTax::VERSION)
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: avatax
3
3
  version: !ruby/object:Gem::Version
4
- version: 18.5.1
4
+ version: 18.6.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Marcus Vorwaller
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2018-05-30 00:00:00.000000000 Z
11
+ date: 2018-07-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: rake
@@ -165,6 +165,7 @@ files:
165
165
  - lib/avatax/client/multidocument.rb
166
166
  - lib/avatax/client/nexus.rb
167
167
  - lib/avatax/client/notices.rb
168
+ - lib/avatax/client/notifications.rb
168
169
  - lib/avatax/client/onboarding.rb
169
170
  - lib/avatax/client/pointofsale.rb
170
171
  - lib/avatax/client/registrar.rb