avatax 20.1.0 → 20.9.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/avatax.gemspec +0 -1
- data/lib/avatax/client/accounts.rb +236 -172
- data/lib/avatax/client/addresses.rb +54 -54
- data/lib/avatax/client/advancedrules.rb +63 -162
- data/lib/avatax/client/avafileforms.rb +78 -78
- data/lib/avatax/client/batches.rb +223 -170
- data/lib/avatax/client/certexpressinvites.rb +97 -97
- data/lib/avatax/client/certificates.rb +424 -424
- data/lib/avatax/client/companies.rb +457 -350
- data/lib/avatax/client/compliance.rb +15 -15
- data/lib/avatax/client/contacts.rb +106 -106
- data/lib/avatax/client/customers.rb +376 -376
- data/lib/avatax/client/datasources.rb +99 -99
- data/lib/avatax/client/definitions.rb +862 -847
- data/lib/avatax/client/distancethresholds.rb +122 -122
- data/lib/avatax/client/ecommercetoken.rb +37 -0
- data/lib/avatax/client/filingcalendars.rb +20 -508
- data/lib/avatax/client/filings.rb +37 -26
- data/lib/avatax/client/firmclientlinkages.rb +123 -123
- data/lib/avatax/client/free.rb +100 -100
- data/lib/avatax/client/fundingrequests.rb +52 -52
- data/lib/avatax/client/items.rb +423 -423
- data/lib/avatax/client/jurisdictionoverrides.rb +118 -118
- data/lib/avatax/client/locations.rb +253 -139
- data/lib/avatax/client/multidocument.rb +390 -310
- data/lib/avatax/client/nexus.rb +341 -201
- data/lib/avatax/client/notifications.rb +75 -75
- data/lib/avatax/client/provisioning.rb +49 -49
- data/lib/avatax/client/registrar.rb +198 -198
- data/lib/avatax/client/reports.rb +97 -97
- data/lib/avatax/client/settings.rb +156 -156
- data/lib/avatax/client/subscriptions.rb +62 -62
- data/lib/avatax/client/taxcodes.rb +120 -120
- data/lib/avatax/client/taxcontent.rb +133 -133
- data/lib/avatax/client/taxrules.rb +170 -170
- data/lib/avatax/client/transactions.rb +836 -791
- data/lib/avatax/client/upcs.rb +111 -111
- data/lib/avatax/client/users.rb +183 -183
- data/lib/avatax/client/utilities.rb +61 -61
- data/lib/avatax/connection.rb +3 -3
- data/lib/avatax/request.rb +2 -0
- data/lib/avatax/version.rb +1 -1
- metadata +4 -17
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: c08d7f2d60ccec52c65e15e8378aae00107bf689f85616977c26ba80d52a7e31
|
4
|
+
data.tar.gz: 941810e2bbaca8285c4e92e990a3484cf40305a232096dc7b6f3bd3cbdeeee4c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ba3e6760464cb115a26cc3c546d237336b8a29001f746f20f0feea89aaa89be664fe474bc05eac0110190736f9d73dcfdef74efe4cdfc4f46a5de00939b856ed
|
7
|
+
data.tar.gz: 26bbf0e85b649d41e2a590bd4c03e6ce720cd4ef8e5f63f5fdc6515a81b2e6503a8d1585a772d9f2f2e1f9f64a5595aae847a9862dea8923392e055af4fec6dd
|
data/avatax.gemspec
CHANGED
@@ -7,7 +7,6 @@ Gem::Specification.new do |s|
|
|
7
7
|
s.add_runtime_dependency('faraday', '>= 0.10')
|
8
8
|
s.add_runtime_dependency('faraday_middleware', '>= 0.10')
|
9
9
|
s.add_runtime_dependency('multi_json', '>= 1.0.3')
|
10
|
-
s.add_runtime_dependency('faraday_middleware-parse_oj', '~> 0.3.2')
|
11
10
|
s.authors = ["Marcus Vorwaller"]
|
12
11
|
s.description = %q{A Ruby wrapper for the AvaTax REST and Search APIs}
|
13
12
|
s.post_install_message =<<eos
|
@@ -1,173 +1,237 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Accounts
|
4
|
-
|
5
|
-
|
6
|
-
# Reset this account's license key
|
7
|
-
#
|
8
|
-
# Resets the existing license key for this account to a new key.
|
9
|
-
#
|
10
|
-
# To reset your account, you must specify the ID of the account you wish to reset and confirm the action.
|
11
|
-
#
|
12
|
-
# This API is only available to account administrators for the account in question, and may only be called after
|
13
|
-
# an account has been activated by reading and accepting Avalara's terms and conditions. To activate your account
|
14
|
-
# please log onto the AvaTax website or call the `ActivateAccount` API.
|
15
|
-
#
|
16
|
-
#
|
17
|
-
#
|
18
|
-
#
|
19
|
-
#
|
20
|
-
#
|
21
|
-
#
|
22
|
-
#
|
23
|
-
#
|
24
|
-
#
|
25
|
-
#
|
26
|
-
# @
|
27
|
-
|
28
|
-
|
29
|
-
|
30
|
-
|
31
|
-
|
32
|
-
# Activate
|
33
|
-
#
|
34
|
-
#
|
35
|
-
#
|
36
|
-
#
|
37
|
-
#
|
38
|
-
#
|
39
|
-
#
|
40
|
-
#
|
41
|
-
#
|
42
|
-
#
|
43
|
-
#
|
44
|
-
#
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
# @
|
49
|
-
|
50
|
-
|
51
|
-
|
52
|
-
|
53
|
-
|
54
|
-
# Retrieve audit
|
55
|
-
#
|
56
|
-
#
|
57
|
-
#
|
58
|
-
#
|
59
|
-
#
|
60
|
-
#
|
61
|
-
#
|
62
|
-
#
|
63
|
-
#
|
64
|
-
#
|
65
|
-
#
|
66
|
-
# *
|
67
|
-
# *
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
74
|
-
# @param
|
75
|
-
# @param
|
76
|
-
# @param
|
77
|
-
# @
|
78
|
-
|
79
|
-
|
80
|
-
|
81
|
-
|
82
|
-
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
#
|
94
|
-
#
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
# ### Security Policies
|
114
|
-
#
|
115
|
-
# * This API requires one of the following user roles: AccountAdmin,
|
116
|
-
# @param id [Integer]
|
117
|
-
# @
|
118
|
-
|
119
|
-
|
120
|
-
|
121
|
-
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
# *
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
#
|
140
|
-
#
|
141
|
-
#
|
142
|
-
#
|
143
|
-
#
|
144
|
-
#
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
#
|
154
|
-
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
159
|
-
|
160
|
-
|
161
|
-
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
167
|
-
# @param
|
168
|
-
# @
|
169
|
-
|
170
|
-
|
171
|
-
|
172
|
-
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Accounts
|
4
|
+
|
5
|
+
|
6
|
+
# Reset this account's license key
|
7
|
+
#
|
8
|
+
# Resets the existing license key for this account to a new key.
|
9
|
+
#
|
10
|
+
# To reset your account, you must specify the ID of the account you wish to reset and confirm the action.
|
11
|
+
#
|
12
|
+
# This API is only available to account administrators for the account in question, and may only be called after
|
13
|
+
# an account has been activated by reading and accepting Avalara's terms and conditions. To activate your account
|
14
|
+
# please log onto the AvaTax website or call the `ActivateAccount` API.
|
15
|
+
#
|
16
|
+
# You can only reset license with 'Default' license key name.
|
17
|
+
# Resetting a license key cannot be undone. Any previous license keys will immediately cease to work when a new key is created.
|
18
|
+
#
|
19
|
+
# When you call this API, all account administrators for this account will receive an email with the newly updated license key.
|
20
|
+
# The email will specify which user reset the license key and it will contain the new key to use to update your connectors.
|
21
|
+
# Note: The reset license key functionality will only be available for existing active license key i.e. when you reset license key for the account, the Default license key will be reset.The reset license key functionality is not available for newly created license keys i.e. license keys other than Default
|
22
|
+
#
|
23
|
+
# ### Security Policies
|
24
|
+
#
|
25
|
+
# * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
26
|
+
# @param id [Integer] The ID of the account you wish to update.
|
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
|
+
#
|
34
|
+
# Activate the account specified by the unique accountId number.
|
35
|
+
#
|
36
|
+
# This activation request can only be called by account administrators. You must indicate
|
37
|
+
# that you have read and accepted Avalara's terms and conditions to call this API.
|
38
|
+
#
|
39
|
+
# Once you have activated your account, use the `AccountResetLicenseKey` API to generate
|
40
|
+
# a license key for your account.
|
41
|
+
#
|
42
|
+
# If you have not read or accepted the terms and conditions, this API call will return the
|
43
|
+
# unchanged account model.
|
44
|
+
#
|
45
|
+
# ### Security Policies
|
46
|
+
#
|
47
|
+
# * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
48
|
+
# @param id [Integer] The ID of the account to activate
|
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
|
+
#
|
56
|
+
# Retrieve audit trace history for an account.
|
57
|
+
#
|
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
|
59
|
+
# problems and see exactly what information was sent back and forth between your code and AvaTax.
|
60
|
+
#
|
61
|
+
# When specifying a start and end datetime, please include a valid timezone indicator, such as the "Z" present in the examples for the start and end query parameters.
|
62
|
+
# You can learn more about valid time zone designators at https://en.wikipedia.org/wiki/ISO_8601#Time_zone_designators.
|
63
|
+
#
|
64
|
+
# This API enforces limits to the amount of data retrieved. These limits are subject to change.
|
65
|
+
#
|
66
|
+
# * You may request data from a maximum of a one-hour time period.
|
67
|
+
# * The amount of data and number of API calls returned by this API are limited and may be adjusted at any time.
|
68
|
+
# * Old records may be migrated out of immediately available storage. To request older data, please contact your account manager.
|
69
|
+
# * New records must migrate to available storage before they can be retrieved. You may need to wait a period of time before newly created records can be fetched.
|
70
|
+
#
|
71
|
+
# ### Security Policies
|
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.
|
74
|
+
# @param id [Integer] The ID of the account you wish to audit.
|
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
|
+
# @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
|
+
# @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
|
+
# @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
|
+
#
|
85
|
+
# Creates a new license key for this account.
|
86
|
+
#
|
87
|
+
# To create a license key for your account, you must specify the ID of the account and license key name.
|
88
|
+
#
|
89
|
+
# This API is only available to account administrators for the account in question, and may only be called after
|
90
|
+
# an account has been activated by reading and accepting Avalara's terms and conditions. To activate your account
|
91
|
+
# please log onto the AvaTax website or call the `ActivateAccount` API.
|
92
|
+
#
|
93
|
+
# You will reference this key using license key name. The existing license key will be using 'Default' as license key name.
|
94
|
+
# Hence make sure that the license key name is unique per account considering the existing license key name 'Default'
|
95
|
+
#
|
96
|
+
# ### Security Policies
|
97
|
+
#
|
98
|
+
# * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
99
|
+
# @param id [Integer] The ID of the account you wish to update.
|
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
|
+
#
|
107
|
+
# Deletes the license key for this account using license key name.
|
108
|
+
#
|
109
|
+
# To delete a license key for your account, you must specify the accountID of the account and license key name.
|
110
|
+
#
|
111
|
+
# This API is only available to account administrators for the account in question.
|
112
|
+
#
|
113
|
+
# ### Security Policies
|
114
|
+
#
|
115
|
+
# * This API requires one of the following user roles: AccountAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
|
116
|
+
# @param id [Integer] The ID of the account you wish to update.
|
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
|
+
#
|
124
|
+
# Get the account object identified by this URL.
|
125
|
+
# You may use the '$include' parameter to fetch additional nested data:
|
126
|
+
#
|
127
|
+
# * Subscriptions
|
128
|
+
# * Users
|
129
|
+
#
|
130
|
+
# ### Security Policies
|
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.
|
133
|
+
# @param id [Integer] The ID of the account to retrieve
|
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
|
+
#
|
141
|
+
# Retrieve a list of all configuration settings tied to this account.
|
142
|
+
#
|
143
|
+
# Configuration settings provide you with the ability to control features of your account and of your
|
144
|
+
# tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for
|
145
|
+
# Avalara internal software configuration values; to store your own account-level settings, please
|
146
|
+
# create a new category name that begins with `X-`, for example, `X-MyCustomCategory`.
|
147
|
+
#
|
148
|
+
# Account settings are permanent settings that cannot be deleted. You can set the value of an
|
149
|
+
# account setting to null if desired.
|
150
|
+
#
|
151
|
+
# Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's
|
152
|
+
# tax calculation and address resolution, and should only be changed with care.
|
153
|
+
#
|
154
|
+
# ### Security Policies
|
155
|
+
#
|
156
|
+
# * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
|
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
|
+
#
|
164
|
+
# ### Security Policies
|
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.
|
167
|
+
# @param id [Integer] The ID of the account to retrieve
|
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
|
+
#
|
175
|
+
# Gets list of all the license keys used by the account.
|
176
|
+
#
|
177
|
+
# ### Security Policies
|
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.
|
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
|
+
#
|
187
|
+
# List all account objects that can be seen by the current user.
|
188
|
+
#
|
189
|
+
# This API lists all accounts you are allowed to see. In general, most users will only be able to see their own account.
|
190
|
+
#
|
191
|
+
# 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/) .
|
192
|
+
# Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
|
193
|
+
# You may specify one or more of the following values in the `$include` parameter to fetch additional nested data, using commas to separate multiple values:
|
194
|
+
#
|
195
|
+
# * Subscriptions
|
196
|
+
# * Users
|
197
|
+
#
|
198
|
+
# For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
|
199
|
+
#
|
200
|
+
# ### Security Policies
|
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.
|
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
|
+
# @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
|
+
# @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
|
+
# @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
|
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
|
+
#
|
214
|
+
# Update configuration settings tied to this account.
|
215
|
+
#
|
216
|
+
# Configuration settings provide you with the ability to control features of your account and of your
|
217
|
+
# tax software. The category names `TaxServiceConfig` and `AddressServiceConfig` are reserved for
|
218
|
+
# Avalara internal software configuration values; to store your own account-level settings, please
|
219
|
+
# create a new category name that begins with `X-`, for example, `X-MyCustomCategory`.
|
220
|
+
#
|
221
|
+
# Account settings are permanent settings that cannot be deleted. You can set the value of an
|
222
|
+
# account setting to null if desired.
|
223
|
+
#
|
224
|
+
# Avalara-based account settings for `TaxServiceConfig` and `AddressServiceConfig` affect your account's
|
225
|
+
# tax calculation and address resolution, and should only be changed with care.
|
226
|
+
#
|
227
|
+
# ### Security Policies
|
228
|
+
#
|
229
|
+
# * This API requires one of the following user roles: AccountAdmin, CSPTester, SSTAdmin, TechnicalSupportAdmin.
|
230
|
+
# @param id [Integer]
|
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
|
173
237
|
end
|
@@ -1,55 +1,55 @@
|
|
1
|
-
module AvaTax
|
2
|
-
class Client
|
3
|
-
module Addresses
|
4
|
-
|
5
|
-
|
6
|
-
# Retrieve geolocation information for a specified address
|
7
|
-
#
|
8
|
-
# Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
|
9
|
-
# provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
|
10
|
-
# to identify how closely this address can be located. If the address cannot be clearly located, use the
|
11
|
-
# 'messages' structure to learn more about problems with this address.
|
12
|
-
# This is the same API as the POST /api/v2/addresses/resolve endpoint.
|
13
|
-
# Both verbs are supported to provide for flexible implementation.
|
14
|
-
#
|
15
|
-
# Inorder to get any evaluation for an address please provide atleast one of the following fields/pairs:
|
16
|
-
# 1. postal code
|
17
|
-
# 2. line1 + city + region
|
18
|
-
# 3. line1 + postal code
|
19
|
-
#
|
20
|
-
# ### Security Policies
|
21
|
-
#
|
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<br />*Required* (all): AutoAddress.
|
24
|
-
# @param line1 [String] Line 1
|
25
|
-
# @param line2 [String] Line 2
|
26
|
-
# @param line3 [String] Line 3
|
27
|
-
# @param city [String] City
|
28
|
-
# @param region [String] State / Province / Region
|
29
|
-
# @param postalCode [String] Postal Code / Zip Code
|
30
|
-
# @param country [String] Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)
|
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
|
-
#
|
38
|
-
# Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
|
39
|
-
# provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
|
40
|
-
# to identify how closely this address can be located. If the address cannot be clearly located, use the
|
41
|
-
# 'messages' structure to learn more about problems with this address.
|
42
|
-
# This is the same API as the GET /api/v2/addresses/resolve endpoint.
|
43
|
-
# Both verbs are supported to provide for flexible implementation.
|
44
|
-
#
|
45
|
-
# ### Security Policies
|
46
|
-
#
|
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<br />*Required* (all): AutoAddress.
|
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
|
1
|
+
module AvaTax
|
2
|
+
class Client
|
3
|
+
module Addresses
|
4
|
+
|
5
|
+
|
6
|
+
# Retrieve geolocation information for a specified address
|
7
|
+
#
|
8
|
+
# Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
|
9
|
+
# provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
|
10
|
+
# to identify how closely this address can be located. If the address cannot be clearly located, use the
|
11
|
+
# 'messages' structure to learn more about problems with this address.
|
12
|
+
# This is the same API as the POST /api/v2/addresses/resolve endpoint.
|
13
|
+
# Both verbs are supported to provide for flexible implementation.
|
14
|
+
#
|
15
|
+
# Inorder to get any evaluation for an address please provide atleast one of the following fields/pairs:
|
16
|
+
# 1. postal code
|
17
|
+
# 2. line1 + city + region
|
18
|
+
# 3. line1 + postal code
|
19
|
+
#
|
20
|
+
# ### Security Policies
|
21
|
+
#
|
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<br />*Required* (all): AutoAddress.
|
24
|
+
# @param line1 [String] Line 1
|
25
|
+
# @param line2 [String] Line 2
|
26
|
+
# @param line3 [String] Line 3
|
27
|
+
# @param city [String] City
|
28
|
+
# @param region [String] State / Province / Region
|
29
|
+
# @param postalCode [String] Postal Code / Zip Code
|
30
|
+
# @param country [String] Two character ISO 3166 Country Code (see /api/v2/definitions/countries for a full list)
|
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
|
+
#
|
38
|
+
# Resolve an address against Avalara's address-validation system. If the address can be resolved, this API
|
39
|
+
# provides the latitude and longitude of the resolved location. The value 'resolutionQuality' can be used
|
40
|
+
# to identify how closely this address can be located. If the address cannot be clearly located, use the
|
41
|
+
# 'messages' structure to learn more about problems with this address.
|
42
|
+
# This is the same API as the GET /api/v2/addresses/resolve endpoint.
|
43
|
+
# Both verbs are supported to provide for flexible implementation.
|
44
|
+
#
|
45
|
+
# ### Security Policies
|
46
|
+
#
|
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<br />*Required* (all): AutoAddress.
|
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
|
55
55
|
end
|