avatax 20.5.0 → 20.12.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.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/.vs/slnx.sqlite +0 -0
  3. data/avatax.gemspec +0 -1
  4. data/lib/avatax/client/accounts.rb +83 -83
  5. data/lib/avatax/client/addresses.rb +21 -21
  6. data/lib/avatax/client/advancedrules.rb +51 -41
  7. data/lib/avatax/client/avafileforms.rb +41 -41
  8. data/lib/avatax/client/batches.rb +101 -48
  9. data/lib/avatax/client/certexpressinvites.rb +39 -39
  10. data/lib/avatax/client/certificates.rb +163 -163
  11. data/lib/avatax/client/companies.rb +226 -121
  12. data/lib/avatax/client/compliance.rb +13 -13
  13. data/lib/avatax/client/contacts.rb +48 -48
  14. data/lib/avatax/client/customers.rb +145 -145
  15. data/lib/avatax/client/datasources.rb +48 -48
  16. data/lib/avatax/client/definitions.rb +422 -420
  17. data/lib/avatax/client/distancethresholds.rb +48 -48
  18. data/lib/avatax/client/ecms.rb +26 -31
  19. data/lib/avatax/client/ecommercetoken.rb +37 -0
  20. data/lib/avatax/client/errortransactions.rb +27 -15
  21. data/lib/avatax/client/filingcalendars.rb +28 -13
  22. data/lib/avatax/client/filings.rb +25 -14
  23. data/lib/avatax/client/firmclientlinkages.rb +69 -69
  24. data/lib/avatax/client/free.rb +27 -27
  25. data/lib/avatax/client/fundingrequests.rb +20 -20
  26. data/lib/avatax/client/items.rb +139 -139
  27. data/lib/avatax/client/jurisdictionoverrides.rb +48 -48
  28. data/lib/avatax/client/locations.rb +168 -57
  29. data/lib/avatax/client/multidocument.rb +98 -78
  30. data/lib/avatax/client/nexus.rb +104 -104
  31. data/lib/avatax/client/notices.rb +47 -139
  32. data/lib/avatax/client/notifications.rb +27 -27
  33. data/lib/avatax/client/provisioning.rb +20 -20
  34. data/lib/avatax/client/registrar.rb +76 -76
  35. data/lib/avatax/client/reports.rb +34 -34
  36. data/lib/avatax/client/settings.rb +48 -48
  37. data/lib/avatax/client/subscriptions.rb +27 -27
  38. data/lib/avatax/client/taxcodes.rb +48 -48
  39. data/lib/avatax/client/taxcontent.rb +27 -27
  40. data/lib/avatax/client/taxprofiles.rb +14 -10
  41. data/lib/avatax/client/taxrules.rb +48 -48
  42. data/lib/avatax/client/transactions.rb +185 -155
  43. data/lib/avatax/client/upcs.rb +48 -48
  44. data/lib/avatax/client/users.rb +62 -62
  45. data/lib/avatax/client/utilities.rb +27 -27
  46. data/lib/avatax/connection.rb +2 -2
  47. data/lib/avatax/version.rb +1 -1
  48. metadata +3 -16
@@ -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,15 @@ 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
119
- #
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
119
+ #
120
120
  # # For Registrar Use Only
121
121
  # This API is for use by Avalara Registrar administrative users only.
122
122
  #
@@ -127,16 +127,16 @@ module AvaTax
127
127
  # ### Security Policies
128
128
  #
129
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
- # * This API is available to Avalara system-level (registrar-level) users only.
130
+ # * This API is available to Avalara system-level (registrar-level) users only.
131
131
  # @param userId [Integer] The unique ID of the user whose password will be changed
132
132
  # @param unmigrateFromAi [Boolean] If user's password was migrated to AI, undo this.
133
133
  # @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
- #
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
+ #
140
140
  # # For Registrar Use Only
141
141
  # This API is for use by Avalara Registrar administrative users only.
142
142
  #
@@ -144,15 +144,15 @@ module AvaTax
144
144
  #
145
145
  # ### Security Policies
146
146
  #
147
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
147
+ # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
148
148
  # @param id [Integer] The ID of the account you wish to update.
149
149
  # @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
- #
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
+ #
156
156
  # This API is available by invitation only.
157
157
  #
158
158
  # Replaces the notification identified by this URL with a new notification.
@@ -167,15 +167,15 @@ module AvaTax
167
167
  # ### Security Policies
168
168
  #
169
169
  # * 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].
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
171
  # @param id [Integer] The id of the notification you wish to update.
172
172
  # @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
- #
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
+ #
179
179
  # # For Registrar Use Only
180
180
  # This API is for use by Avalara Registrar administrative users only.
181
181
  #
@@ -187,13 +187,13 @@ module AvaTax
187
187
  #
188
188
  # ### Security Policies
189
189
  #
190
- # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
190
+ # * This API requires one of the following user roles: Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
191
191
  # @param accountId [Integer] The ID of the account that this subscription belongs to.
192
192
  # @param id [Integer] The ID of the subscription you wish to update
193
193
  # @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
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
199
199
  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
@@ -62,15 +62,15 @@ module AvaTax
62
62
  #
63
63
  # ### Security Policies
64
64
  #
65
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
65
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
66
66
  # @param companyId [Integer] The unique ID number of the company to report on.
67
67
  # @param model [Object] Options that may be configured to customize the report.
68
- # @return [ReportModel[]]
69
- def initiate_export_document_line_report(companyId, model) path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
70
- post(path, model) end
71
-
72
- # List all report tasks for account
73
- #
68
+ # @return [ReportModel[]]
69
+ def initiate_export_document_line_report(companyId, model) path = "/api/v2/companies/#{companyId}/reports/exportdocumentline/initiate"
70
+ post(path, model) end
71
+
72
+ # List all report tasks for account
73
+ #
74
74
  # List all report tasks for your account.
75
75
  #
76
76
  # Reports are run as asynchronous report tasks on the server. When complete, the report file will be available for download
@@ -85,14 +85,14 @@ module AvaTax
85
85
  #
86
86
  # ### Security Policies
87
87
  #
88
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
88
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
89
89
  # @param companyId [Integer] The id of the company for which to get reports.
90
90
  # @param pageKey [String] Provide a page key to retrieve the next page of results.
91
91
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
92
92
  # @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.
93
- # @return [FetchResult]
94
- def list_reports(options={}) path = "/api/v2/reports"
95
- get(path, options) end
96
- end
97
- end
93
+ # @return [FetchResult]
94
+ def list_reports(options={}) path = "/api/v2/reports"
95
+ get(path, options) end
96
+ end
97
+ end
98
98
  end