avatax 21.6.0 → 21.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. checksums.yaml +4 -4
  2. data/lib/avatax/client/accounts.rb +83 -83
  3. data/lib/avatax/client/addresses.rb +20 -20
  4. data/lib/avatax/client/advancedrules.rb +41 -41
  5. data/lib/avatax/client/avafileforms.rb +41 -41
  6. data/lib/avatax/client/batches.rb +62 -62
  7. data/lib/avatax/client/certexpressinvites.rb +27 -27
  8. data/lib/avatax/client/certificates.rb +111 -111
  9. data/lib/avatax/client/companies.rb +153 -153
  10. data/lib/avatax/client/contacts.rb +48 -48
  11. data/lib/avatax/client/customers.rb +97 -97
  12. data/lib/avatax/client/datasources.rb +48 -48
  13. data/lib/avatax/client/definitions.rb +558 -443
  14. data/lib/avatax/client/distancethresholds.rb +48 -48
  15. data/lib/avatax/client/ecommercetoken.rb +16 -16
  16. data/lib/avatax/client/filingcalendars.rb +41 -20
  17. data/lib/avatax/client/filings.rb +22 -20
  18. data/lib/avatax/client/firmclientlinkages.rb +69 -69
  19. data/lib/avatax/client/free.rb +13 -13
  20. data/lib/avatax/client/fundingrequests.rb +20 -20
  21. data/lib/avatax/client/items.rb +185 -181
  22. data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
  23. data/lib/avatax/client/locations.rb +90 -90
  24. data/lib/avatax/client/multidocument.rb +76 -76
  25. data/lib/avatax/client/nexus.rb +133 -105
  26. data/lib/avatax/client/notices.rb +22 -22
  27. data/lib/avatax/client/notifications.rb +27 -27
  28. data/lib/avatax/client/provisioning.rb +20 -20
  29. data/lib/avatax/client/registrar.rb +85 -75
  30. data/lib/avatax/client/reports.rb +34 -34
  31. data/lib/avatax/client/settings.rb +48 -48
  32. data/lib/avatax/client/subscriptions.rb +27 -27
  33. data/lib/avatax/client/taxcodes.rb +48 -48
  34. data/lib/avatax/client/taxcontent.rb +41 -41
  35. data/lib/avatax/client/taxrules.rb +50 -50
  36. data/lib/avatax/client/transactions.rb +153 -153
  37. data/lib/avatax/client/upcs.rb +48 -48
  38. data/lib/avatax/client/users.rb +62 -62
  39. data/lib/avatax/client/utilities.rb +27 -27
  40. data/lib/avatax/request.rb +11 -3
  41. data/lib/avatax/version.rb +1 -1
  42. metadata +11 -4
@@ -5,50 +5,50 @@ module AvaTax
5
5
 
6
6
  # Creates a new tax notice responsibility type.
7
7
  #
8
- # This API is available by invitation only and only available for users with Compliance admin access.
9
- #
10
- # ### Security Policies
11
- #
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.
8
+ # This API is available by invitation only and only available for users with Compliance admin access.
9
+ #
10
+ # ### Security Policies
11
+ #
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
- # @param model [Object] The responsibility type to create
14
+ # @param model [Object] The responsibility type to create
15
15
  # @return [Object]
16
16
  def create_notice_responsibility_type(model) path = "/api/v2/notices/responsibilities"
17
17
  post(path, model) end
18
18
 
19
19
  # Creates a new tax notice root cause type.
20
20
  #
21
- # This API is available by invitation only and only available for users with Compliance admin access.
22
- #
23
- # ### Security Policies
24
- #
25
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
21
+ # This API is available by invitation only and only available for users with Compliance admin access.
22
+ #
23
+ # ### Security Policies
24
+ #
25
+ # * 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
26
  # * 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.
27
- # @param model [Object] The root cause type to create
27
+ # @param model [Object] The root cause type to create
28
28
  # @return [Object]
29
29
  def create_notice_root_cause_type(model) path = "/api/v2/notices/rootcauses"
30
30
  post(path, model) end
31
31
 
32
32
  # Delete a tax notice responsibility type.
33
33
  #
34
- # This API is available by invitation only and only available for users with Compliance admin access.
35
- #
36
- # ### Security Policies
37
- #
34
+ # This API is available by invitation only and only available for users with Compliance admin access.
35
+ #
36
+ # ### Security Policies
37
+ #
38
38
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
39
- # @param responsibilityId [Integer] The unique ID of the responsibility type
39
+ # @param responsibilityId [Integer] The unique ID of the responsibility type
40
40
  # @return [ErrorDetail[]]
41
41
  def delete_notice_responsibility_type(responsibilityId) path = "/api/v2/notices/responsibilities/#{responsibilityId}"
42
42
  delete(path) end
43
43
 
44
44
  # Delete a tax notice root cause type.
45
45
  #
46
- # This API is available by invitation only and only available for users with Compliance admin access.
47
- #
48
- # ### Security Policies
49
- #
46
+ # This API is available by invitation only and only available for users with Compliance admin access.
47
+ #
48
+ # ### Security Policies
49
+ #
50
50
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
51
- # @param rootCauseId [Integer] The unique ID of the root cause type
51
+ # @param rootCauseId [Integer] The unique ID of the root cause type
52
52
  # @return [ErrorDetail[]]
53
53
  def delete_notice_root_cause_type(rootCauseId) path = "/api/v2/notices/rootcauses/#{rootCauseId}"
54
54
  delete(path) end
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Notifications
4
-
5
-
6
- # Mark a single notification as dismissed.
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Notifications
4
+
5
+
6
+ # Mark a single notification as dismissed.
7
+ #
8
8
  # Marks the notification identified by this URL as dismissed.
9
9
  #
10
10
  # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -22,14 +22,14 @@ module AvaTax
22
22
  #
23
23
  # ### Security Policies
24
24
  #
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.
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
- # @return [Object]
28
- def dismiss_notification(id) path = "/api/v2/notifications/#{id}/dismiss"
29
- put(path) end
30
-
31
- # Retrieve a single notification.
32
- #
27
+ # @return [Object]
28
+ def dismiss_notification(id) path = "/api/v2/notifications/#{id}/dismiss"
29
+ put(path) end
30
+
31
+ # Retrieve a single notification.
32
+ #
33
33
  # Retrieve a single notification by its unique ID number.
34
34
  #
35
35
  # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -41,14 +41,14 @@ module AvaTax
41
41
  #
42
42
  # ### Security Policies
43
43
  #
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.
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
45
  # @param id [Integer] The id of the notification to retrieve.
46
- # @return [Object]
47
- def get_notification(id) path = "/api/v2/notifications/#{id}"
48
- get(path) end
49
-
50
- # List all notifications.
51
- #
46
+ # @return [Object]
47
+ def get_notification(id) path = "/api/v2/notifications/#{id}"
48
+ get(path) end
49
+
50
+ # List all notifications.
51
+ #
52
52
  # List all notifications.
53
53
  #
54
54
  # A notification is a message from Avalara that may have relevance to your business. You may want
@@ -63,14 +63,14 @@ module AvaTax
63
63
  #
64
64
  # ### Security Policies
65
65
  #
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.
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
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
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
69
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
70
70
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
71
- # @return [FetchResult]
72
- def list_notifications(options={}) path = "/api/v2/notifications"
73
- get(path, options) end
74
- end
75
- end
71
+ # @return [FetchResult]
72
+ def list_notifications(options={}) path = "/api/v2/notifications"
73
+ get(path, options) end
74
+ end
75
+ end
76
76
  end
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Provisioning
4
-
5
-
6
- # Request a new Avalara account
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Provisioning
4
+
5
+
6
+ # Request a new Avalara account
7
+ #
8
8
  # This API is for use by partner provisioning services customers only.
9
9
  #
10
10
  # Avalara invites select partners to refer new customers to the AvaTax service using the onboarding features
@@ -24,14 +24,14 @@ module AvaTax
24
24
  #
25
25
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
26
26
  # * This API is available by invitation only.
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].
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
28
  # @param model [Object] Information about the account you wish to create and the selected product offerings.
29
- # @return [Object]
30
- def request_new_account(model) path = "/api/v2/accounts/request"
31
- post(path, model) end
32
-
33
- # Request a new entitilement to an existing customer
34
- #
29
+ # @return [Object]
30
+ def request_new_account(model) path = "/api/v2/accounts/request"
31
+ post(path, model) end
32
+
33
+ # Request a new entitilement to an existing customer
34
+ #
35
35
  # This API is for use by partner provisioning services customers only. This will allow the partners to allow
36
36
  # the add new entitlement to an existing customer
37
37
  #
@@ -39,12 +39,12 @@ module AvaTax
39
39
  #
40
40
  # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
41
41
  # * This API is available by invitation only.
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].
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
43
  # @param id [Integer] The avatax account id of the customer
44
44
  # @param offer [String] The offer to be added to an already existing customer
45
- # @return [Object]
46
- def request_new_entitlement(id, offer) path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
47
- post(path) end
48
- end
49
- end
45
+ # @return [Object]
46
+ def request_new_entitlement(id, offer) path = "/api/v2/accounts/#{id}/entitlements/#{offer}"
47
+ post(path) end
48
+ end
49
+ end
50
50
  end
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Registrar
4
-
5
-
6
- # Create a new account
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Registrar
4
+
5
+
6
+ # Create a new account
7
+ #
8
8
  # # For Registrar Use Only
9
9
  # This API is for use by Avalara Registrar administrative users only.
10
10
  #
@@ -13,14 +13,14 @@ module AvaTax
13
13
  #
14
14
  # ### Security Policies
15
15
  #
16
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
16
+ # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
17
17
  # @param model [Object] The account you wish to create.
18
- # @return [AccountModel[]]
19
- def create_account(model) path = "/api/v2/accounts"
20
- post(path, model) end
21
-
22
- # Create new notifications.
23
- #
18
+ # @return [AccountModel[]]
19
+ def create_account(model) path = "/api/v2/accounts"
20
+ post(path, model) end
21
+
22
+ # Create new notifications.
23
+ #
24
24
  # This API is available by invitation only.
25
25
  #
26
26
  # Create a single notification.
@@ -38,14 +38,14 @@ module AvaTax
38
38
  # ### Security Policies
39
39
  #
40
40
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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].
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
42
  # @param model [NotificationModel[]] The notifications you wish to create.
43
- # @return [NotificationModel[]]
44
- def create_notifications(model) path = "/api/v2/notifications"
45
- post(path, model) end
46
-
47
- # Create a new subscription
48
- #
43
+ # @return [NotificationModel[]]
44
+ def create_notifications(model) path = "/api/v2/notifications"
45
+ post(path, model) end
46
+
47
+ # Create a new subscription
48
+ #
49
49
  # This API is for use by Avalara Registrar administrative users only.
50
50
  #
51
51
  # Create one or more new subscription objects attached to this account.
@@ -54,15 +54,15 @@ module AvaTax
54
54
  #
55
55
  # ### Security Policies
56
56
  #
57
- # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
57
+ # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
58
58
  # @param accountId [Integer] The ID of the account that owns this subscription.
59
59
  # @param model [SubscriptionModel[]] The subscription you wish to create.
60
- # @return [SubscriptionModel[]]
61
- def create_subscriptions(accountId, model) path = "/api/v2/accounts/#{accountId}/subscriptions"
62
- post(path, model) end
63
-
64
- # Delete a single account
65
- #
60
+ # @return [SubscriptionModel[]]
61
+ def create_subscriptions(accountId, model) path = "/api/v2/accounts/#{accountId}/subscriptions"
62
+ post(path, model) end
63
+
64
+ # Delete a single account
65
+ #
66
66
  # # For Registrar Use Only
67
67
  # This API is for use by Avalara Registrar administrative users only.
68
68
  #
@@ -71,14 +71,14 @@ module AvaTax
71
71
  #
72
72
  # ### Security Policies
73
73
  #
74
- # * This API requires the user role SystemAdmin.
74
+ # * This API requires the user role SystemAdmin.
75
75
  # @param id [Integer] The ID of the account you wish to delete.
76
- # @return [ErrorDetail[]]
77
- def delete_account(id) path = "/api/v2/accounts/#{id}"
78
- delete(path) end
79
-
80
- # Delete a single notification.
81
- #
76
+ # @return [ErrorDetail[]]
77
+ def delete_account(id) path = "/api/v2/accounts/#{id}"
78
+ delete(path) end
79
+
80
+ # Delete a single notification.
81
+ #
82
82
  # This API is available by invitation only.
83
83
  #
84
84
  # Delete the existing notification identified by this URL.
@@ -93,14 +93,14 @@ module AvaTax
93
93
  # ### Security Policies
94
94
  #
95
95
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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].
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
97
  # @param id [Integer] The id of the notification you wish to delete.
98
- # @return [ErrorDetail[]]
99
- def delete_notification(id) path = "/api/v2/notifications/#{id}"
100
- delete(path) end
101
-
102
- # Delete a single subscription
103
- #
98
+ # @return [ErrorDetail[]]
99
+ def delete_notification(id) path = "/api/v2/notifications/#{id}"
100
+ delete(path) end
101
+
102
+ # Delete a single subscription
103
+ #
104
104
  # # For Registrar Use Only
105
105
  # This API is for use by Avalara Registrar administrative users only.
106
106
  #
@@ -108,15 +108,25 @@ module AvaTax
108
108
  #
109
109
  # ### Security Policies
110
110
  #
111
- # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
111
+ # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
112
112
  # @param accountId [Integer] The ID of the account that owns this subscription.
113
113
  # @param id [Integer] The ID of the subscription you wish to delete.
114
- # @return [ErrorDetail[]]
115
- def delete_subscription(accountId, id) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
116
- delete(path) end
117
-
118
- # Reset a user's password programmatically
114
+ # @return [ErrorDetail[]]
115
+ def delete_subscription(accountId, id) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
116
+ delete(path) end
117
+
118
+ # Retrieve List of Accounts by Account Migration Status
119
+ #
120
+ # ### Security Policies
119
121
  #
122
+ # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
123
+ # @param writeMode [String] (See TssAccountMigrationId::* for a list of allowable values)
124
+ # @return [Object]
125
+ def list_accounts_by_tss_write_mode(writeMode) path = "/api/v2/accounts/ListAccountsByTssWriteMode/#{writeMode}"
126
+ get(path) end
127
+
128
+ # Reset a user's password programmatically
129
+ #
120
130
  # # For Registrar Use Only
121
131
  # This API is for use by Avalara Registrar administrative users only.
122
132
  #
@@ -127,16 +137,16 @@ module AvaTax
127
137
  # ### Security Policies
128
138
  #
129
139
  # * 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
- # * This API is available to Avalara system-level (registrar-level) users only.
140
+ # * This API is available to Avalara system-level (registrar-level) users only.
131
141
  # @param userId [Integer] The unique ID of the user whose password will be changed
132
142
  # @param unmigrateFromAi [Boolean] If user's password was migrated to AI, undo this.
133
143
  # @param model [Object] The new password for this user
134
- # @return [String]
135
- def reset_password(userId, model, options={}) path = "/api/v2/passwords/#{userId}/reset"
136
- post(path, model, options) end
137
-
138
- # Update a single account
139
- #
144
+ # @return [String]
145
+ def reset_password(userId, model, options={}) path = "/api/v2/passwords/#{userId}/reset"
146
+ post(path, model, options) end
147
+
148
+ # Update a single account
149
+ #
140
150
  # # For Registrar Use Only
141
151
  # This API is for use by Avalara Registrar administrative users only.
142
152
  #
@@ -144,15 +154,15 @@ module AvaTax
144
154
  #
145
155
  # ### Security Policies
146
156
  #
147
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
157
+ # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
148
158
  # @param id [Integer] The ID of the account you wish to update.
149
159
  # @param model [Object] The account object you wish to update.
150
- # @return [Object]
151
- def update_account(id, model) path = "/api/v2/accounts/#{id}"
152
- put(path, model) end
153
-
154
- # Update a single notification.
155
- #
160
+ # @return [Object]
161
+ def update_account(id, model) path = "/api/v2/accounts/#{id}"
162
+ put(path, model) end
163
+
164
+ # Update a single notification.
165
+ #
156
166
  # This API is available by invitation only.
157
167
  #
158
168
  # Replaces the notification identified by this URL with a new notification.
@@ -167,15 +177,15 @@ module AvaTax
167
177
  # ### Security Policies
168
178
  #
169
179
  # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
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].
180
+ # * 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
181
  # @param id [Integer] The id of the notification you wish to update.
172
182
  # @param model [Object] The notification object you wish to update.
173
- # @return [Object]
174
- def update_notification(id, model) path = "/api/v2/notifications/#{id}"
175
- put(path, model) end
176
-
177
- # Update a single subscription
178
- #
183
+ # @return [Object]
184
+ def update_notification(id, model) path = "/api/v2/notifications/#{id}"
185
+ put(path, model) end
186
+
187
+ # Update a single subscription
188
+ #
179
189
  # # For Registrar Use Only
180
190
  # This API is for use by Avalara Registrar administrative users only.
181
191
  #
@@ -187,13 +197,13 @@ module AvaTax
187
197
  #
188
198
  # ### Security Policies
189
199
  #
190
- # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
200
+ # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
191
201
  # @param accountId [Integer] The ID of the account that this subscription belongs to.
192
202
  # @param id [Integer] The ID of the subscription you wish to update
193
203
  # @param model [Object] The subscription you wish to update.
194
- # @return [Object]
195
- def update_subscription(accountId, id, model) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
196
- put(path, model) end
197
- end
198
- end
204
+ # @return [Object]
205
+ def update_subscription(accountId, id, model) path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
206
+ put(path, model) end
207
+ end
208
+ end
199
209
  end
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Reports
4
-
5
-
6
- # Download a report
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Reports
4
+
5
+
6
+ # Download a report
7
+ #
8
8
  # This API downloads the file associated with a report.
9
9
  #
10
10
  # If the report is not yet complete, you will receive a `ReportNotFinished` error. To check if a report is complete,
@@ -22,14 +22,14 @@ module AvaTax
22
22
  #
23
23
  # ### Security Policies
24
24
  #
25
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
25
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
26
26
  # @param id [Integer] The unique ID number of this report
27
- # @return [Object]
28
- def download_report(id) path = "/api/v2/reports/#{id}/attachment"
29
- get(path) end
30
-
31
- # Retrieve a single report
32
- #
27
+ # @return [Object]
28
+ def download_report(id) path = "/api/v2/reports/#{id}/attachment"
29
+ get(path) end
30
+
31
+ # Retrieve a single report
32
+ #
33
33
  # Retrieve a single report by its unique ID number.
34
34
  #
35
35
  # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
@@ -40,14 +40,14 @@ module AvaTax
40
40
  # * Check the status of a report by calling `GetReport` and passing in the report's `id` value.
41
41
  # * When a report's status is `Completed`, call `DownloadReport` to retrieve the file.
42
42
  #
43
- # This API call returns information about any report type.
43
+ # This API call returns information about any report type.
44
44
  # @param id [Integer] The unique ID number of the report to retrieve
45
- # @return [Object]
46
- def get_report(id) path = "/api/v2/reports/#{id}"
47
- get(path) end
48
-
49
- # Initiate an ExportDocumentLine report task
50
- #
45
+ # @return [Object]
46
+ def get_report(id) path = "/api/v2/reports/#{id}"
47
+ get(path) end
48
+
49
+ # Initiate an ExportDocumentLine report task
50
+ #
51
51
  # Begins running an `ExportDocumentLine` report task and returns the identity of the report.
52
52
  #
53
53
  # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
@@ -71,15 +71,15 @@ module AvaTax
71
71
  #
72
72
  # ### Security Policies
73
73
  #
74
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
74
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
75
75
  # @param companyId [Integer] The unique ID number of the company to report on.
76
76
  # @param model [Object] Options that may be configured to customize the report.
77
- # @return [ReportModel[]]
78
- def initiate_export_document_line_report(companyId, model) path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
79
- post(path, model) end
80
-
81
- # List all report tasks for account
82
- #
77
+ # @return [ReportModel[]]
78
+ def initiate_export_document_line_report(companyId, model) path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
79
+ post(path, model) end
80
+
81
+ # List all report tasks for account
82
+ #
83
83
  # List all report tasks for your account.
84
84
  #
85
85
  # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
@@ -94,14 +94,14 @@ module AvaTax
94
94
  #
95
95
  # ### Security Policies
96
96
  #
97
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
97
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
98
98
  # @param companyId [Integer] The id of the company for which to get reports.
99
99
  # @param pageKey [String] Provide a page key to retrieve the next page of results.
100
100
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
101
101
  # @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.
102
- # @return [FetchResult]
103
- def list_reports(options={}) path = "/api/v2/reports"
104
- get(path, options) end
105
- end
106
- end
102
+ # @return [FetchResult]
103
+ def list_reports(options={}) path = "/api/v2/reports"
104
+ get(path, options) end
105
+ end
106
+ end
107
107
  end