avatax 21.8.0 → 21.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (41) 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 +550 -446
  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 +39 -20
  17. data/lib/avatax/client/filings.rb +20 -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 +181 -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 +131 -103
  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 +83 -83
  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/version.rb +1 -1
  41. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 9c4e6d9ada20f80e3f0b71f73750f12bd075933c7c42d98c9bb4eb6188b7536f
4
- data.tar.gz: 110bf1de00cad8607af9fde49716a5ec7869485254c507e857f1cf5f96734222
3
+ metadata.gz: f093a4a8890e9266820d341d75bd24beccedce72570c1ff2a9af69d0db500927
4
+ data.tar.gz: 606c268a3a348169041822234a16e84573c8e3eaa5c07fa3a22f1db6459896d6
5
5
  SHA512:
6
- metadata.gz: 21c5e1d9231277473215a0ba598e675caa993893ffecc4aa0467a2fd37cd2c197dbbf883da0c5f39a7c2a8593f9278de0b92dca518f2c7d44a503f6011a368f3
7
- data.tar.gz: 5f176a87cff27f315e93ab4473af059cc0dd3d35b77b56ccf862a2e08946da75102b045ec58910ca55b2bb87dcaf777891f941a05e018ed98b94f4155d1ef457
6
+ metadata.gz: 496e76e866a9eea1b0e610f718173b71416f491a045d31e795836bae930068f44c618dc3b3dadf345a6935bbb3b65f1ddb89af40d054f276d76c4244f74a343c
7
+ data.tar.gz: ca40289b423c2a54b2c1be792a77051ca2e8a2b4ff4e005a52c4e255005e85ab94d20b062551f5750bfc072c1e2505a1feb25496ee0f42a46b00263bc631c978
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Accounts
4
-
5
-
6
- # Reset this account's license key
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Accounts
4
+
5
+
6
+ # Reset this account's license key
7
+ #
8
8
  # Resets the existing license key for this account to a new key.
9
9
  #
10
10
  # To reset your account, you must specify the ID of the account you wish to reset and confirm the action.
@@ -22,15 +22,15 @@ module AvaTax
22
22
  #
23
23
  # ### Security Policies
24
24
  #
25
- # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
25
+ # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
26
26
  # @param id [Integer] The ID of the account you wish to update.
27
27
  # @param model [Object] A request confirming that you wish to reset the license key of this account.
28
- # @return [Object]
29
- def account_reset_license_key(id, model) path = "/api/v2/accounts/#{id}/resetlicensekey"
30
- post(path, model) end
31
-
32
- # Activate an account by accepting terms and conditions
33
- #
28
+ # @return [Object]
29
+ def account_reset_license_key(id, model) path = "/api/v2/accounts/#{id}/resetlicensekey"
30
+ post(path, model) end
31
+
32
+ # Activate an account by accepting terms and conditions
33
+ #
34
34
  # Activate the account specified by the unique accountId number.
35
35
  #
36
36
  # This activation request can only be called by account administrators. You must indicate
@@ -44,15 +44,15 @@ module AvaTax
44
44
  #
45
45
  # ### Security Policies
46
46
  #
47
- # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
47
+ # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
48
48
  # @param id [Integer] The ID of the account to activate
49
49
  # @param model [Object] The activation request
50
- # @return [Object]
51
- def activate_account(id, model) path = "/api/v2/accounts/#{id}/activate"
52
- post(path, model) end
53
-
54
- # Retrieve audit history for an account.
55
- #
50
+ # @return [Object]
51
+ def activate_account(id, model) path = "/api/v2/accounts/#{id}/activate"
52
+ post(path, model) end
53
+
54
+ # Retrieve audit history for an account.
55
+ #
56
56
  # Retrieve audit trace history for an account.
57
57
  #
58
58
  # Your audit trace history contains a record of all API calls made against the AvaTax REST API that returned an error. You can use this API to investigate
@@ -70,18 +70,18 @@ module AvaTax
70
70
  #
71
71
  # ### Security Policies
72
72
  #
73
- # * 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.
73
+ # * 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.
74
74
  # @param id [Integer] The ID of the account you wish to audit.
75
75
  # @param start [DateTime] The start datetime of audit history you with to retrieve, e.g. "2018-06-08T17:00:00Z". Defaults to the past 15 minutes.
76
76
  # @param end [DateTime] The end datetime of audit history you with to retrieve, e.g. "2018-06-08T17:15:00Z. Defaults to the current time. Maximum of an hour after the start time.
77
77
  # @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.
78
78
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
79
- # @return [FetchResult]
80
- def audit_account(id, options={}) path = "/api/v2/accounts/#{id}/audit"
81
- get(path, options) end
82
-
83
- # Create license key for this account
84
- #
79
+ # @return [FetchResult]
80
+ def audit_account(id, options={}) path = "/api/v2/accounts/#{id}/audit"
81
+ get(path, options) end
82
+
83
+ # Create license key for this account
84
+ #
85
85
  # Creates a new license key for this account.
86
86
  #
87
87
  # To create a license key for your account, you must specify the ID of the account and license key name.
@@ -95,15 +95,15 @@ module AvaTax
95
95
  #
96
96
  # ### Security Policies
97
97
  #
98
- # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
98
+ # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
99
99
  # @param id [Integer] The ID of the account you wish to update.
100
100
  # @param model [Object]
101
- # @return [Object]
102
- def create_license_key(id, model) path = "/api/v2/accounts/#{id}/licensekey"
103
- post(path, model) end
104
-
105
- # Delete license key for this account by license key name
106
- #
101
+ # @return [Object]
102
+ def create_license_key(id, model) path = "/api/v2/accounts/#{id}/licensekey"
103
+ post(path, model) end
104
+
105
+ # Delete license key for this account by license key name
106
+ #
107
107
  # Deletes the license key for this account using license key name.
108
108
  #
109
109
  # To delete a license key for your account, you must specify the accountID of the account and license key name.
@@ -112,15 +112,15 @@ module AvaTax
112
112
  #
113
113
  # ### Security Policies
114
114
  #
115
- # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
115
+ # * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
116
116
  # @param id [Integer] The ID of the account you wish to update.
117
117
  # @param licensekeyname [String] The license key name you wish to update.
118
- # @return [ErrorDetail[]]
119
- def delete_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
120
- delete(path) end
121
-
122
- # Retrieve a single account
123
- #
118
+ # @return [ErrorDetail[]]
119
+ def delete_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
120
+ delete(path) end
121
+
122
+ # Retrieve a single account
123
+ #
124
124
  # Get the account object identified by this URL.
125
125
  # You may use the '$include' parameter to fetch additional nested data:
126
126
  #
@@ -129,15 +129,15 @@ module AvaTax
129
129
  #
130
130
  # ### Security Policies
131
131
  #
132
- # * 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.
132
+ # * 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.
133
133
  # @param id [Integer] The ID of the account to retrieve
134
134
  # @param include [String] A comma separated list of special fetch options
135
- # @return [Object]
136
- def get_account(id, options={}) path = "/api/v2/accounts/#{id}"
137
- get(path, options) end
138
-
139
- # Get configuration settings for this account
140
- #
135
+ # @return [Object]
136
+ def get_account(id, options={}) path = "/api/v2/accounts/#{id}"
137
+ get(path, options) end
138
+
139
+ # Get configuration settings for this account
140
+ #
141
141
  # Retrieve a list of all configuration settings tied to this account.
142
142
  #
143
143
  # Configuration settings provide you with the ability to control features of your account and of your
@@ -153,37 +153,37 @@ module AvaTax
153
153
  #
154
154
  # ### Security Policies
155
155
  #
156
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
156
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
157
157
  # @param id [Integer]
158
- # @return [AccountConfigurationModel[]]
159
- def get_account_configuration(id) path = "/api/v2/accounts/#{id}/configuration"
160
- get(path) end
161
-
162
- # Retrieve license key by license key name
163
- #
158
+ # @return [AccountConfigurationModel[]]
159
+ def get_account_configuration(id) path = "/api/v2/accounts/#{id}/configuration"
160
+ get(path) end
161
+
162
+ # Retrieve license key by license key name
163
+ #
164
164
  # ### Security Policies
165
165
  #
166
- # * 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.
166
+ # * 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.
167
167
  # @param id [Integer] The ID of the account to retrieve
168
168
  # @param licensekeyname [String] The ID of the account to retrieve
169
- # @return [Object]
170
- def get_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
171
- get(path) end
172
-
173
- # Retrieve all license keys for this account
174
- #
169
+ # @return [Object]
170
+ def get_license_key(id, licensekeyname) path = "/api/v2/accounts/#{id}/licensekey/#{licensekeyname}"
171
+ get(path) end
172
+
173
+ # Retrieve all license keys for this account
174
+ #
175
175
  # Gets list of all the license keys used by the account.
176
176
  #
177
177
  # ### Security Policies
178
178
  #
179
- # * 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.
179
+ # * 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.
180
180
  # @param id [Integer] The ID of the account to retrieve
181
- # @return [AccountLicenseKeyModel[]]
182
- def get_license_keys(id) path = "/api/v2/accounts/#{id}/licensekeys"
183
- get(path) end
184
-
185
- # Retrieve all accounts
186
- #
181
+ # @return [AccountLicenseKeyModel[]]
182
+ def get_license_keys(id) path = "/api/v2/accounts/#{id}/licensekeys"
183
+ get(path) end
184
+
185
+ # Retrieve all accounts
186
+ #
187
187
  # List all account objects that can be seen by the current user.
188
188
  #
189
189
  # This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account.
@@ -199,18 +199,18 @@ module AvaTax
199
199
  #
200
200
  # ### Security Policies
201
201
  #
202
- # * 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.
202
+ # * 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.
203
203
  # @param include [String] A comma separated list of objects to fetch underneath this account. Any object with a URL path underneath this account can be fetched by specifying its name.
204
204
  # @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/).<br />*Not filterable:* subscriptions, users
205
205
  # @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.
206
206
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
207
207
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
208
- # @return [FetchResult]
209
- def query_accounts(options={}) path = "/api/v2/accounts"
210
- get(path, options) end
211
-
212
- # Change configuration settings for this account
213
- #
208
+ # @return [FetchResult]
209
+ def query_accounts(options={}) path = "/api/v2/accounts"
210
+ get(path, options) end
211
+
212
+ # Change configuration settings for this account
213
+ #
214
214
  # Update configuration settings tied to this account.
215
215
  #
216
216
  # Configuration settings provide you with the ability to control features of your account and of your
@@ -226,12 +226,12 @@ module AvaTax
226
226
  #
227
227
  # ### Security Policies
228
228
  #
229
- # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
229
+ # * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
230
230
  # @param id [Integer]
231
231
  # @param model [AccountConfigurationModel[]]
232
- # @return [AccountConfigurationModel[]]
233
- def set_account_configuration(id, model) path = "/api/v2/accounts/#{id}/configuration"
234
- post(path, model) end
235
- end
236
- end
232
+ # @return [AccountConfigurationModel[]]
233
+ def set_account_configuration(id, model) path = "/api/v2/accounts/#{id}/configuration"
234
+ post(path, model) end
235
+ end
236
+ end
237
237
  end
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module Addresses
4
-
5
-
6
- # Retrieve geolocation information for a specified address
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module Addresses
4
+
5
+
6
+ # Retrieve geolocation information for a specified address
7
+ #
8
8
  # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
9
9
  # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
10
10
  # to identify how closely this address can be located. If the address cannot be clearly located, use the
@@ -20,7 +20,7 @@ module AvaTax
20
20
  # ### Security Policies
21
21
  #
22
22
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
23
- # * This API depends on the following active services:*Required* (all): AutoAddress.
23
+ # * This API depends on the following active services:*Required* (all): AutoAddress.
24
24
  # @param line1 [String] Line 1
25
25
  # @param line2 [String] Line 2
26
26
  # @param line3 [String] Line 3
@@ -29,12 +29,12 @@ module AvaTax
29
29
  # @param postalCode [String] Postal Code / Zip Code
30
30
  # @param country [String] Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)
31
31
  # @param textCase [String] selectable text case for address validation (See TextCase::* for a list of allowable values)
32
- # @return [Object]
33
- def resolve_address(options={}) path = "/api/v2/addresses/resolve"
34
- get(path, options) end
35
-
36
- # Retrieve geolocation information for a specified address
37
- #
32
+ # @return [Object]
33
+ def resolve_address(options={}) path = "/api/v2/addresses/resolve"
34
+ get(path, options) end
35
+
36
+ # Retrieve geolocation information for a specified address
37
+ #
38
38
  # Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
39
39
  # provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
40
40
  # to identify how closely this address can be located. If the address cannot be clearly located, use the
@@ -45,11 +45,11 @@ module AvaTax
45
45
  # ### Security Policies
46
46
  #
47
47
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
48
- # * This API depends on the following active services:*Required* (all): AutoAddress.
48
+ # * This API depends on the following active services:*Required* (all): AutoAddress.
49
49
  # @param model [Object] The address to resolve
50
- # @return [Object]
51
- def resolve_address_post(model) path = "/api/v2/addresses/resolve"
52
- post(path, model) end
53
- end
54
- end
50
+ # @return [Object]
51
+ def resolve_address_post(model) path = "/api/v2/addresses/resolve"
52
+ post(path, model) end
53
+ end
54
+ end
55
55
  end
@@ -1,54 +1,54 @@
1
- module AvaTax
2
- class Client
3
- module AdvancedRules
4
-
5
-
6
- # Create a lookup file for a company
7
- #
8
- #
1
+ module AvaTax
2
+ class Client
3
+ module AdvancedRules
4
+
5
+
6
+ # Create a lookup file for a company
7
+ #
8
+ #
9
9
  # @param accountId [Integer] The ID of the account for the company
10
10
  # @param companyId [Integer] The ID of the company for which the lookup file is to be created
11
11
  # @param model [Object] The lookup file you wish to create
12
- # @return [Object]
13
- def create_company_lookup_file(accountId, companyId, model) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
14
- post(path, model) end
15
-
16
- # Delete a lookup file
17
- #
18
- #
12
+ # @return [Object]
13
+ def create_company_lookup_file(accountId, companyId, model) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
14
+ post(path, model) end
15
+
16
+ # Delete a lookup file
17
+ #
18
+ #
19
19
  # @param accountId [Integer] The ID of the account for the company the lookup file is for
20
20
  # @param id [String] The unique ID/GUID for the company lookup file to be deleted
21
- # @return [ErrorDetail[]]
22
- def delete_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
23
- delete(path) end
24
-
25
- # Get the lookup files for a company
26
- #
27
- #
21
+ # @return [ErrorDetail[]]
22
+ def delete_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
23
+ delete(path) end
24
+
25
+ # Get the lookup files for a company
26
+ #
27
+ #
28
28
  # @param accountId [Integer] The account ID for the company
29
29
  # @param companyId [Integer] The ID of the company for which to retrieve lookup files
30
- # @return [FetchResult]
31
- def get_company_lookup_files(accountId, companyId) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
32
- get(path) end
33
-
34
- # Get a lookup file for an accountId and companyLookupFileId
35
- #
36
- #
30
+ # @return [FetchResult]
31
+ def get_company_lookup_files(accountId, companyId) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
32
+ get(path) end
33
+
34
+ # Get a lookup file for an accountId and companyLookupFileId
35
+ #
36
+ #
37
37
  # @param accountId [Integer] The ID of the account for the lookup file
38
38
  # @param id [String] The unique ID/GUID of the company lookup file to return
39
- # @return [Object]
40
- def get_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
41
- get(path) end
42
-
43
- # Update a lookup file
44
- #
45
- #
39
+ # @return [Object]
40
+ def get_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
41
+ get(path) end
42
+
43
+ # Update a lookup file
44
+ #
45
+ #
46
46
  # @param accountId [Integer] The ID of the account for the company the lookup file is for
47
47
  # @param id [String] The unique ID/GUID of the company lookup file to be updated
48
48
  # @param model [Object] The new values to update the lookup file
49
- # @return [Object]
50
- def update_lookup_file(accountId, id, model) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
51
- put(path, model) end
52
- end
53
- end
49
+ # @return [Object]
50
+ def update_lookup_file(accountId, id, model) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
51
+ put(path, model) end
52
+ end
53
+ end
54
54
  end
@@ -1,79 +1,79 @@
1
- module AvaTax
2
- class Client
3
- module AvaFileForms
4
-
5
-
6
- # Create a new AvaFileForm
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module AvaFileForms
4
+
5
+
6
+ # Create a new AvaFileForm
7
+ #
8
8
  # Create one or more AvaFileForms
9
9
  # A 'AvaFileForm' represents a form supported by our returns team
10
10
  #
11
11
  # ### Security Policies
12
12
  #
13
13
  # * This API requires the user role Compliance Root User.
14
- # * 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
+ # * 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.
15
15
  # @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
16
- # @return [AvaFileFormModel[]]
17
- def create_ava_file_forms(model) path = "/api/v2/avafileforms"
18
- post(path, model) end
19
-
20
- # Delete a single AvaFileForm
21
- #
16
+ # @return [AvaFileFormModel[]]
17
+ def create_ava_file_forms(model) path = "/api/v2/avafileforms"
18
+ post(path, model) end
19
+
20
+ # Delete a single AvaFileForm
21
+ #
22
22
  # Marks the existing AvaFileForm object at this URL as deleted.
23
23
  #
24
24
  # ### Security Policies
25
25
  #
26
26
  # * This API requires one of the following user roles: Compliance Root User, ComplianceUser, FirmAdmin.
27
- # * 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
+ # * 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.
28
28
  # @param id [Integer] The ID of the AvaFileForm you wish to delete.
29
- # @return [ErrorDetail[]]
30
- def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
31
- delete(path) end
32
-
33
- # Retrieve a single AvaFileForm
34
- #
29
+ # @return [ErrorDetail[]]
30
+ def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
31
+ delete(path) end
32
+
33
+ # Retrieve a single AvaFileForm
34
+ #
35
35
  # Get the AvaFileForm object identified by this URL.
36
36
  #
37
37
  # ### Security Policies
38
38
  #
39
39
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
40
- # * 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.
40
+ # * 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.
41
41
  # @param id [Integer] The primary key of this AvaFileForm
42
- # @return [Object]
43
- def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
44
- get(path) end
45
-
46
- # Retrieve all AvaFileForms
47
- #
42
+ # @return [Object]
43
+ def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
44
+ get(path) end
45
+
46
+ # Retrieve all AvaFileForms
47
+ #
48
48
  # 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/) .
49
49
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
50
50
  #
51
51
  # ### Security Policies
52
52
  #
53
53
  # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
54
- # * 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.
54
+ # * 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.
55
55
  # @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/).<br />*Not filterable:* outletTypeId
56
56
  # @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.
57
57
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
58
58
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
59
- # @return [FetchResult]
60
- def query_ava_file_forms(options={}) path = "/api/v2/avafileforms"
61
- get(path, options) end
62
-
63
- # Update a AvaFileForm
64
- #
59
+ # @return [FetchResult]
60
+ def query_ava_file_forms(options={}) path = "/api/v2/avafileforms"
61
+ get(path, options) end
62
+
63
+ # Update a AvaFileForm
64
+ #
65
65
  # All data from the existing object will be replaced with data in the object you PUT.
66
66
  # 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.
67
67
  #
68
68
  # ### Security Policies
69
69
  #
70
70
  # * This API requires the user role Compliance Root User.
71
- # * 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.
71
+ # * 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.
72
72
  # @param id [Integer] The ID of the AvaFileForm you wish to update
73
73
  # @param model [Object] The AvaFileForm model you wish to update.
74
- # @return [Object]
75
- def update_ava_file_form(id, model) path = "/api/v2/avafileforms/#{id}"
76
- put(path, model) end
77
- end
78
- end
74
+ # @return [Object]
75
+ def update_ava_file_form(id, model) path = "/api/v2/avafileforms/#{id}"
76
+ put(path, model) end
77
+ end
78
+ end
79
79
  end