avatax 20.1.0 → 20.5.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/avatax/client/accounts.rb +180 -116
- data/lib/avatax/client/addresses.rb +34 -34
- data/lib/avatax/client/advancedrules.rb +33 -142
- data/lib/avatax/client/avafileforms.rb +37 -37
- data/lib/avatax/client/batches.rb +122 -122
- data/lib/avatax/client/certexpressinvites.rb +70 -70
- data/lib/avatax/client/certificates.rb +313 -313
- data/lib/avatax/client/companies.rb +234 -232
- data/lib/avatax/client/compliance.rb +2 -2
- data/lib/avatax/client/contacts.rb +58 -58
- data/lib/avatax/client/customers.rb +279 -279
- data/lib/avatax/client/datasources.rb +51 -51
- data/lib/avatax/client/definitions.rb +448 -435
- data/lib/avatax/client/distancethresholds.rb +74 -74
- data/lib/avatax/client/filingcalendars.rb +10 -498
- data/lib/avatax/client/filings.rb +13 -13
- data/lib/avatax/client/firmclientlinkages.rb +54 -54
- data/lib/avatax/client/free.rb +73 -73
- data/lib/avatax/client/fundingrequests.rb +32 -32
- data/lib/avatax/client/items.rb +284 -284
- data/lib/avatax/client/jurisdictionoverrides.rb +70 -70
- data/lib/avatax/client/locations.rb +87 -84
- data/lib/avatax/client/multidocument.rb +294 -234
- data/lib/avatax/client/nexus.rb +283 -143
- data/lib/avatax/client/notifications.rb +48 -48
- data/lib/avatax/client/provisioning.rb +29 -29
- data/lib/avatax/client/registrar.rb +122 -122
- data/lib/avatax/client/reports.rb +63 -63
- data/lib/avatax/client/settings.rb +108 -108
- data/lib/avatax/client/subscriptions.rb +35 -35
- data/lib/avatax/client/taxcodes.rb +72 -72
- data/lib/avatax/client/taxcontent.rb +106 -106
- data/lib/avatax/client/taxrules.rb +122 -122
- data/lib/avatax/client/transactions.rb +654 -639
- data/lib/avatax/client/upcs.rb +63 -63
- data/lib/avatax/client/users.rb +121 -121
- data/lib/avatax/client/utilities.rb +34 -34
- data/lib/avatax/connection.rb +1 -1
- data/lib/avatax/request.rb +2 -0
- data/lib/avatax/version.rb +1 -1
- metadata +3 -3
@@ -5,69 +5,69 @@ module AvaTax
|
|
5
5
|
|
6
6
|
# Mark a single notification as dismissed.
|
7
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
|
-
#
|
21
|
-
# A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span.
|
22
|
-
#
|
23
|
-
# ### Security Policies
|
24
|
-
#
|
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
|
+
#
|
21
|
+
# A Global notification with null accountId and companyId cannot be dismissed and will expire within a given time span.
|
22
|
+
#
|
23
|
+
# ### Security Policies
|
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
|
-
# @param id [Integer] The id of the notification you wish to mark as dismissed.
|
26
|
+
# @param id [Integer] The id of the notification you wish to mark as dismissed.
|
27
27
|
# @return [Object]
|
28
28
|
def dismiss_notification(id) path = "/api/v2/notifications/#{id}/dismiss"
|
29
29
|
put(path) end
|
30
30
|
|
31
31
|
# Retrieve a single notification.
|
32
32
|
#
|
33
|
-
# Retrieve a single notification by its unique ID number.
|
34
|
-
#
|
35
|
-
# A notification is a message from Avalara that may have relevance to your business. You may want
|
36
|
-
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
37
|
-
# any relevant concerns raised by this notification.
|
38
|
-
#
|
39
|
-
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
40
|
-
# affect you, or a potential issue with your company's tax profile.
|
41
|
-
#
|
42
|
-
# ### Security Policies
|
43
|
-
#
|
33
|
+
# Retrieve a single notification by its unique ID number.
|
34
|
+
#
|
35
|
+
# A notification is a message from Avalara that may have relevance to your business. You may want
|
36
|
+
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
37
|
+
# any relevant concerns raised by this notification.
|
38
|
+
#
|
39
|
+
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
40
|
+
# affect you, or a potential issue with your company's tax profile.
|
41
|
+
#
|
42
|
+
# ### Security Policies
|
43
|
+
#
|
44
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.
|
45
|
-
# @param id [Integer] The id of the notification to retrieve.
|
45
|
+
# @param id [Integer] The id of the notification to retrieve.
|
46
46
|
# @return [Object]
|
47
47
|
def get_notification(id) path = "/api/v2/notifications/#{id}"
|
48
48
|
get(path) end
|
49
49
|
|
50
50
|
# List all notifications.
|
51
51
|
#
|
52
|
-
# List all notifications.
|
53
|
-
#
|
54
|
-
# A notification is a message from Avalara that may have relevance to your business. You may want
|
55
|
-
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
56
|
-
# any relevant concerns raised by this notification.
|
57
|
-
#
|
58
|
-
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
59
|
-
# affect you, or a potential issue with your company's tax profile.
|
60
|
-
#
|
61
|
-
# 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/) .
|
62
|
-
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
63
|
-
#
|
64
|
-
# ### Security Policies
|
65
|
-
#
|
52
|
+
# List all notifications.
|
53
|
+
#
|
54
|
+
# A notification is a message from Avalara that may have relevance to your business. You may want
|
55
|
+
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
56
|
+
# any relevant concerns raised by this notification.
|
57
|
+
#
|
58
|
+
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
59
|
+
# affect you, or a potential issue with your company's tax profile.
|
60
|
+
#
|
61
|
+
# 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/) .
|
62
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
63
|
+
#
|
64
|
+
# ### Security Policies
|
65
|
+
#
|
66
66
|
# * 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.
|
67
|
-
# @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
|
-
# @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
|
-
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
70
|
-
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
67
|
+
# @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
|
+
# @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
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
70
|
+
# @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
|
71
71
|
# @return [FetchResult]
|
72
72
|
def list_notifications(options={}) path = "/api/v2/notifications"
|
73
73
|
get(path, options) end
|
@@ -5,43 +5,43 @@ module AvaTax
|
|
5
5
|
|
6
6
|
# Request a new Avalara account
|
7
7
|
#
|
8
|
-
# This API is for use by partner provisioning services customers only.
|
9
|
-
#
|
10
|
-
# Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
|
11
|
-
# of AvaTax. These partners can create accounts for new customers using this API.
|
12
|
-
#
|
13
|
-
# Calling this API creates an account with the specified product subscriptions, but does not configure billing.
|
14
|
-
# The customer will receive information from Avalara about how to configure billing for their account.
|
15
|
-
# You should call this API when a customer has requested to begin using Avalara services.
|
16
|
-
#
|
17
|
-
# If the newly created account owner wishes, they can confirm that they have read and agree to the Avalara
|
18
|
-
# terms and conditions. If they do so, they can receive a license key as part of this API and their
|
19
|
-
# API will be created in `Active` status. If the customer has not yet read and accepted these terms and
|
20
|
-
# conditions, the account will be created in `New` status and they can receive a license key by logging
|
21
|
-
# onto the AvaTax website and reviewing terms and conditions online.
|
22
|
-
#
|
23
|
-
# ### Security Policies
|
24
|
-
#
|
25
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
26
|
-
# * This API is available by invitation only.
|
8
|
+
# This API is for use by partner provisioning services customers only.
|
9
|
+
#
|
10
|
+
# Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
|
11
|
+
# of AvaTax. These partners can create accounts for new customers using this API.
|
12
|
+
#
|
13
|
+
# Calling this API creates an account with the specified product subscriptions, but does not configure billing.
|
14
|
+
# The customer will receive information from Avalara about how to configure billing for their account.
|
15
|
+
# You should call this API when a customer has requested to begin using Avalara services.
|
16
|
+
#
|
17
|
+
# If the newly created account owner wishes, they can confirm that they have read and agree to the Avalara
|
18
|
+
# terms and conditions. If they do so, they can receive a license key as part of this API and their
|
19
|
+
# API will be created in `Active` status. If the customer has not yet read and accepted these terms and
|
20
|
+
# conditions, the account will be created in `New` status and they can receive a license key by logging
|
21
|
+
# onto the AvaTax website and reviewing terms and conditions online.
|
22
|
+
#
|
23
|
+
# ### Security Policies
|
24
|
+
#
|
25
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
26
|
+
# * This API is available by invitation only.
|
27
27
|
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
28
|
-
# @param model [Object] Information about the account you wish to create and the selected product offerings.
|
28
|
+
# @param model [Object] Information about the account you wish to create and the selected product offerings.
|
29
29
|
# @return [Object]
|
30
30
|
def request_new_account(model) path = "/api/v2/accounts/request"
|
31
31
|
post(path, model) end
|
32
32
|
|
33
33
|
# Request a new entitilement to an existing customer
|
34
34
|
#
|
35
|
-
# This API is for use by partner provisioning services customers only. This will allow the partners to allow
|
36
|
-
# the add new entitlement to an existing customer
|
37
|
-
#
|
38
|
-
# ### Security Policies
|
39
|
-
#
|
40
|
-
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
41
|
-
# * This API is available by invitation only.
|
35
|
+
# This API is for use by partner provisioning services customers only. This will allow the partners to allow
|
36
|
+
# the add new entitlement to an existing customer
|
37
|
+
#
|
38
|
+
# ### Security Policies
|
39
|
+
#
|
40
|
+
# * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
41
|
+
# * This API is available by invitation only.
|
42
42
|
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [Provisioning:RequestNewAccount].
|
43
|
-
# @param id [Integer] The avatax account id of the customer
|
44
|
-
# @param offer [String] The offer to be added to an already existing customer
|
43
|
+
# @param id [Integer] The avatax account id of the customer
|
44
|
+
# @param offer [String] The offer to be added to an already existing customer
|
45
45
|
# @return [Object]
|
46
46
|
def request_new_entitlement(id, offer) path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
|
47
47
|
post(path) end
|
@@ -5,192 +5,192 @@ module AvaTax
|
|
5
5
|
|
6
6
|
# Create a new account
|
7
7
|
#
|
8
|
-
# # For Registrar Use Only
|
9
|
-
# This API is for use by Avalara Registrar administrative users only.
|
10
|
-
#
|
11
|
-
# Create a single new account object.
|
12
|
-
# When creating an account object you may attach subscriptions and users as part of the 'Create' call.
|
13
|
-
#
|
14
|
-
# ### Security Policies
|
15
|
-
#
|
8
|
+
# # For Registrar Use Only
|
9
|
+
# This API is for use by Avalara Registrar administrative users only.
|
10
|
+
#
|
11
|
+
# Create a single new account object.
|
12
|
+
# When creating an account object you may attach subscriptions and users as part of the 'Create' call.
|
13
|
+
#
|
14
|
+
# ### Security Policies
|
15
|
+
#
|
16
16
|
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
17
|
-
# @param model [Object] The account you wish to create.
|
17
|
+
# @param model [Object] The account you wish to create.
|
18
18
|
# @return [AccountModel[]]
|
19
19
|
def create_account(model) path = "/api/v2/accounts"
|
20
20
|
post(path, model) end
|
21
21
|
|
22
22
|
# Create new notifications.
|
23
23
|
#
|
24
|
-
# This API is available by invitation only.
|
25
|
-
#
|
26
|
-
# Create a single notification.
|
27
|
-
#
|
28
|
-
# A notification is a message from Avalara that may have relevance to your business. You may want
|
29
|
-
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
30
|
-
# any relevant concerns raised by this notification.
|
31
|
-
#
|
32
|
-
# A Global notification is a message which is directed to all the accounts and is set to expire within
|
33
|
-
# a certain time and cannot be dismissed by the user. Make accountId and companyId null to create a global notification.
|
34
|
-
#
|
35
|
-
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
36
|
-
# affect you, or a potential issue with your company's tax profile.
|
37
|
-
#
|
38
|
-
# ### Security Policies
|
39
|
-
#
|
40
|
-
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
24
|
+
# This API is available by invitation only.
|
25
|
+
#
|
26
|
+
# Create a single notification.
|
27
|
+
#
|
28
|
+
# A notification is a message from Avalara that may have relevance to your business. You may want
|
29
|
+
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
30
|
+
# any relevant concerns raised by this notification.
|
31
|
+
#
|
32
|
+
# A Global notification is a message which is directed to all the accounts and is set to expire within
|
33
|
+
# a certain time and cannot be dismissed by the user. Make accountId and companyId null to create a global notification.
|
34
|
+
#
|
35
|
+
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
36
|
+
# affect you, or a potential issue with your company's tax profile.
|
37
|
+
#
|
38
|
+
# ### Security Policies
|
39
|
+
#
|
40
|
+
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
41
41
|
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
|
42
|
-
# @param model [NotificationModel[]] The notifications you wish to create.
|
42
|
+
# @param model [NotificationModel[]] The notifications you wish to create.
|
43
43
|
# @return [NotificationModel[]]
|
44
44
|
def create_notifications(model) path = "/api/v2/notifications"
|
45
45
|
post(path, model) end
|
46
46
|
|
47
47
|
# Create a new subscription
|
48
48
|
#
|
49
|
-
# This API is for use by Avalara Registrar administrative users only.
|
50
|
-
#
|
51
|
-
# Create one or more new subscription objects attached to this account.
|
52
|
-
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
53
|
-
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
54
|
-
#
|
55
|
-
# ### Security Policies
|
56
|
-
#
|
49
|
+
# This API is for use by Avalara Registrar administrative users only.
|
50
|
+
#
|
51
|
+
# Create one or more new subscription objects attached to this account.
|
52
|
+
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
53
|
+
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
54
|
+
#
|
55
|
+
# ### Security Policies
|
56
|
+
#
|
57
57
|
# * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
58
|
-
# @param accountId [Integer] The ID of the account that owns this subscription.
|
59
|
-
# @param model [SubscriptionModel[]] The subscription you wish to create.
|
58
|
+
# @param accountId [Integer] The ID of the account that owns this subscription.
|
59
|
+
# @param model [SubscriptionModel[]] The subscription you wish to create.
|
60
60
|
# @return [SubscriptionModel[]]
|
61
61
|
def create_subscriptions(accountId, model) path = "/api/v2/accounts/#{accountId}/subscriptions"
|
62
62
|
post(path, model) end
|
63
63
|
|
64
64
|
# Delete a single account
|
65
65
|
#
|
66
|
-
# # For Registrar Use Only
|
67
|
-
# This API is for use by Avalara Registrar administrative users only.
|
68
|
-
#
|
69
|
-
# Delete an account.
|
70
|
-
# Deleting an account will delete all companies
|
71
|
-
#
|
72
|
-
# ### Security Policies
|
73
|
-
#
|
66
|
+
# # For Registrar Use Only
|
67
|
+
# This API is for use by Avalara Registrar administrative users only.
|
68
|
+
#
|
69
|
+
# Delete an account.
|
70
|
+
# Deleting an account will delete all companies, all account level users and license keys attached to this account.
|
71
|
+
#
|
72
|
+
# ### Security Policies
|
73
|
+
#
|
74
74
|
# * This API requires the user role SystemAdmin.
|
75
|
-
# @param id [Integer] The ID of the account you wish to delete.
|
75
|
+
# @param id [Integer] The ID of the account you wish to delete.
|
76
76
|
# @return [ErrorDetail[]]
|
77
77
|
def delete_account(id) path = "/api/v2/accounts/#{id}"
|
78
78
|
delete(path) end
|
79
79
|
|
80
80
|
# Delete a single notification.
|
81
81
|
#
|
82
|
-
# This API is available by invitation only.
|
83
|
-
#
|
84
|
-
# Delete the existing notification identified by this URL.
|
85
|
-
#
|
86
|
-
# A notification is a message from Avalara that may have relevance to your business. You may want
|
87
|
-
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
88
|
-
# any relevant concerns raised by this notification.
|
89
|
-
#
|
90
|
-
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
91
|
-
# affect you, or a potential issue with your company's tax profile.
|
92
|
-
#
|
93
|
-
# ### Security Policies
|
94
|
-
#
|
95
|
-
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
82
|
+
# This API is available by invitation only.
|
83
|
+
#
|
84
|
+
# Delete the existing notification identified by this URL.
|
85
|
+
#
|
86
|
+
# A notification is a message from Avalara that may have relevance to your business. You may want
|
87
|
+
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
88
|
+
# any relevant concerns raised by this notification.
|
89
|
+
#
|
90
|
+
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
91
|
+
# affect you, or a potential issue with your company's tax profile.
|
92
|
+
#
|
93
|
+
# ### Security Policies
|
94
|
+
#
|
95
|
+
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
96
96
|
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
|
97
|
-
# @param id [Integer] The id of the notification you wish to delete.
|
97
|
+
# @param id [Integer] The id of the notification you wish to delete.
|
98
98
|
# @return [ErrorDetail[]]
|
99
99
|
def delete_notification(id) path = "/api/v2/notifications/#{id}"
|
100
100
|
delete(path) end
|
101
101
|
|
102
102
|
# Delete a single subscription
|
103
103
|
#
|
104
|
-
# # For Registrar Use Only
|
105
|
-
# This API is for use by Avalara Registrar administrative users only.
|
106
|
-
#
|
107
|
-
# Mark the existing account identified by this URL as deleted.
|
108
|
-
#
|
109
|
-
# ### Security Policies
|
110
|
-
#
|
104
|
+
# # For Registrar Use Only
|
105
|
+
# This API is for use by Avalara Registrar administrative users only.
|
106
|
+
#
|
107
|
+
# Mark the existing account identified by this URL as deleted.
|
108
|
+
#
|
109
|
+
# ### Security Policies
|
110
|
+
#
|
111
111
|
# * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
112
|
-
# @param accountId [Integer] The ID of the account that owns this subscription.
|
113
|
-
# @param id [Integer] The ID of the subscription you wish to delete.
|
112
|
+
# @param accountId [Integer] The ID of the account that owns this subscription.
|
113
|
+
# @param id [Integer] The ID of the subscription you wish to delete.
|
114
114
|
# @return [ErrorDetail[]]
|
115
115
|
def delete_subscription(accountId, id) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
|
116
116
|
delete(path) end
|
117
117
|
|
118
118
|
# Reset a user's password programmatically
|
119
119
|
#
|
120
|
-
# # For Registrar Use Only
|
121
|
-
# This API is for use by Avalara Registrar administrative users only.
|
122
|
-
#
|
123
|
-
# Allows a system admin to reset the password for a specific user via the API.
|
124
|
-
# This API is only available for Avalara Registrar Admins, and can be used to reset the password of any
|
125
|
-
# user based on internal Avalara business processes.
|
126
|
-
#
|
127
|
-
# ### Security Policies
|
128
|
-
#
|
129
|
-
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
120
|
+
# # For Registrar Use Only
|
121
|
+
# This API is for use by Avalara Registrar administrative users only.
|
122
|
+
#
|
123
|
+
# Allows a system admin to reset the password for a specific user via the API.
|
124
|
+
# This API is only available for Avalara Registrar Admins, and can be used to reset the password of any
|
125
|
+
# user based on internal Avalara business processes.
|
126
|
+
#
|
127
|
+
# ### Security Policies
|
128
|
+
#
|
129
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
|
130
130
|
# * This API is available to Avalara system-level (registrar-level) users only.
|
131
|
-
# @param userId [Integer] The unique ID of the user whose password will be changed
|
132
|
-
# @param unmigrateFromAi [Boolean] If user's password was migrated to AI, undo this.
|
133
|
-
# @param model [Object] The new password for this user
|
131
|
+
# @param userId [Integer] The unique ID of the user whose password will be changed
|
132
|
+
# @param unmigrateFromAi [Boolean] If user's password was migrated to AI, undo this.
|
133
|
+
# @param model [Object] The new password for this user
|
134
134
|
# @return [String]
|
135
135
|
def reset_password(userId, model, options={}) path = "/api/v2/passwords/#{userId}/reset"
|
136
136
|
post(path, model, options) end
|
137
137
|
|
138
138
|
# Update a single account
|
139
139
|
#
|
140
|
-
# # For Registrar Use Only
|
141
|
-
# This API is for use by Avalara Registrar administrative users only.
|
142
|
-
#
|
143
|
-
# Replace an existing account object with an updated account object.
|
144
|
-
#
|
145
|
-
# ### Security Policies
|
146
|
-
#
|
140
|
+
# # For Registrar Use Only
|
141
|
+
# This API is for use by Avalara Registrar administrative users only.
|
142
|
+
#
|
143
|
+
# Replace an existing account object with an updated account object.
|
144
|
+
#
|
145
|
+
# ### Security Policies
|
146
|
+
#
|
147
147
|
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
148
|
-
# @param id [Integer] The ID of the account you wish to update.
|
149
|
-
# @param model [Object] The account object you wish to update.
|
148
|
+
# @param id [Integer] The ID of the account you wish to update.
|
149
|
+
# @param model [Object] The account object you wish to update.
|
150
150
|
# @return [Object]
|
151
151
|
def update_account(id, model) path = "/api/v2/accounts/#{id}"
|
152
152
|
put(path, model) end
|
153
153
|
|
154
154
|
# Update a single notification.
|
155
155
|
#
|
156
|
-
# This API is available by invitation only.
|
157
|
-
#
|
158
|
-
# Replaces the notification identified by this URL with a new notification.
|
159
|
-
#
|
160
|
-
# A notification is a message from Avalara that may have relevance to your business. You may want
|
161
|
-
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
162
|
-
# any relevant concerns raised by this notification.
|
163
|
-
#
|
164
|
-
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
165
|
-
# affect you, or a potential issue with your company's tax profile.
|
166
|
-
#
|
167
|
-
# ### Security Policies
|
168
|
-
#
|
169
|
-
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
156
|
+
# This API is available by invitation only.
|
157
|
+
#
|
158
|
+
# Replaces the notification identified by this URL with a new notification.
|
159
|
+
#
|
160
|
+
# A notification is a message from Avalara that may have relevance to your business. You may want
|
161
|
+
# to regularly review notifications and then dismiss them when you are certain that you have addressed
|
162
|
+
# any relevant concerns raised by this notification.
|
163
|
+
#
|
164
|
+
# An example of a notification would be a message about new software, or a change to AvaTax that may
|
165
|
+
# affect you, or a potential issue with your company's tax profile.
|
166
|
+
#
|
167
|
+
# ### Security Policies
|
168
|
+
#
|
169
|
+
# * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
170
170
|
# * This API is available by invitation only. To request access to this feature, please speak to a business development manager and request access to [NotificationsAPI:Create].
|
171
|
-
# @param id [Integer] The id of the notification you wish to update.
|
172
|
-
# @param model [Object] The notification object you wish to update.
|
171
|
+
# @param id [Integer] The id of the notification you wish to update.
|
172
|
+
# @param model [Object] The notification object you wish to update.
|
173
173
|
# @return [Object]
|
174
174
|
def update_notification(id, model) path = "/api/v2/notifications/#{id}"
|
175
175
|
put(path, model) end
|
176
176
|
|
177
177
|
# Update a single subscription
|
178
178
|
#
|
179
|
-
# # For Registrar Use Only
|
180
|
-
# This API is for use by Avalara Registrar administrative users only.
|
181
|
-
#
|
182
|
-
# Replace the existing subscription object at this URL with an updated object.
|
183
|
-
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
184
|
-
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
185
|
-
# All data from the existing object will be replaced with data in the object you PUT.
|
186
|
-
# 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.
|
187
|
-
#
|
188
|
-
# ### Security Policies
|
189
|
-
#
|
179
|
+
# # For Registrar Use Only
|
180
|
+
# This API is for use by Avalara Registrar administrative users only.
|
181
|
+
#
|
182
|
+
# Replace the existing subscription object at this URL with an updated object.
|
183
|
+
# A 'subscription' indicates a licensed subscription to a named Avalara service.
|
184
|
+
# To request or remove subscriptions, please contact Avalara sales or your customer account manager.
|
185
|
+
# All data from the existing object will be replaced with data in the object you PUT.
|
186
|
+
# 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.
|
187
|
+
#
|
188
|
+
# ### Security Policies
|
189
|
+
#
|
190
190
|
# * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
191
|
-
# @param accountId [Integer] The ID of the account that this subscription belongs to.
|
192
|
-
# @param id [Integer] The ID of the subscription you wish to update
|
193
|
-
# @param model [Object] The subscription you wish to update.
|
191
|
+
# @param accountId [Integer] The ID of the account that this subscription belongs to.
|
192
|
+
# @param id [Integer] The ID of the subscription you wish to update
|
193
|
+
# @param model [Object] The subscription you wish to update.
|
194
194
|
# @return [Object]
|
195
195
|
def update_subscription(accountId, id, model) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
|
196
196
|
put(path, model) end
|