avatax 22.3.0 → 22.7.0

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 (72) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/gem-push.yml +31 -0
  3. data/.gitignore +55 -55
  4. data/.rspec +1 -1
  5. data/.vs/VSWorkspaceState.json +5 -5
  6. data/.yardopts +4 -4
  7. data/Gemfile +2 -2
  8. data/LICENSE +201 -201
  9. data/README.md +98 -98
  10. data/Rakefile +9 -9
  11. data/avatax.gemspec +38 -38
  12. data/example/avatax.rb +47 -47
  13. data/example/credentials.example.yaml +5 -5
  14. data/lib/avatax/api.rb +27 -27
  15. data/lib/avatax/client/accounts.rb +22 -22
  16. data/lib/avatax/client/addresses.rb +4 -4
  17. data/lib/avatax/client/advancedrules.rb +5 -5
  18. data/lib/avatax/client/avafileforms.rb +7 -7
  19. data/lib/avatax/client/batches.rb +16 -16
  20. data/lib/avatax/client/certexpressinvites.rb +6 -6
  21. data/lib/avatax/client/certificates.rb +30 -30
  22. data/lib/avatax/client/companies.rb +47 -45
  23. data/lib/avatax/client/compliance.rb +1 -1
  24. data/lib/avatax/client/contacts.rb +12 -12
  25. data/lib/avatax/client/customers.rb +26 -26
  26. data/lib/avatax/client/datasources.rb +12 -12
  27. data/lib/avatax/client/definitions.rb +90 -75
  28. data/lib/avatax/client/distancethresholds.rb +12 -12
  29. data/lib/avatax/client/ecms.rb +73 -73
  30. data/lib/avatax/client/ecommercetoken.rb +4 -4
  31. data/lib/avatax/client/errortransactions.rb +61 -61
  32. data/lib/avatax/client/firmclientlinkages.rb +17 -17
  33. data/lib/avatax/client/free.rb +1 -1
  34. data/lib/avatax/client/fundingrequests.rb +10 -6
  35. data/lib/avatax/client/items.rb +86 -62
  36. data/lib/avatax/client/jurisdictionoverrides.rb +12 -12
  37. data/lib/avatax/client/locations.rb +24 -24
  38. data/lib/avatax/client/multidocument.rb +20 -20
  39. data/lib/avatax/client/nexus.rb +30 -30
  40. data/lib/avatax/client/notices.rb +8 -8
  41. data/lib/avatax/client/notifications.rb +6 -6
  42. data/lib/avatax/client/onboarding.rb +55 -55
  43. data/lib/avatax/client/pointofsale.rb +21 -21
  44. data/lib/avatax/client/provisioning.rb +4 -4
  45. data/lib/avatax/client/registrar.rb +20 -20
  46. data/lib/avatax/client/reports.rb +7 -7
  47. data/lib/avatax/client/settings.rb +12 -12
  48. data/lib/avatax/client/subscriptions.rb +6 -6
  49. data/lib/avatax/client/taxcodes.rb +12 -12
  50. data/lib/avatax/client/taxcontent.rb +8 -8
  51. data/lib/avatax/client/taxprofiles.rb +42 -42
  52. data/lib/avatax/client/taxrules.rb +12 -12
  53. data/lib/avatax/client/transactions.rb +41 -41
  54. data/lib/avatax/client/upcs.rb +12 -12
  55. data/lib/avatax/client/userdefinedfields.rb +6 -6
  56. data/lib/avatax/client/users.rb +16 -16
  57. data/lib/avatax/client/utilities.rb +3 -3
  58. data/lib/avatax/client.rb +37 -37
  59. data/lib/avatax/configuration.rb +76 -76
  60. data/lib/avatax/connection.rb +53 -49
  61. data/lib/avatax/request.rb +51 -51
  62. data/lib/avatax/version.rb +3 -3
  63. data/lib/avatax.rb +26 -26
  64. data/spec/avatax/client/accounts_spec.rb +13 -13
  65. data/spec/avatax/client/transactions_spec.rb +80 -80
  66. data/spec/avatax/request_spec.rb +25 -25
  67. data/spec/avatax_spec.rb +45 -45
  68. data/spec/credentials.yaml.example +4 -4
  69. data/spec/fixtures/accounts.json +15 -15
  70. data/spec/spec_helper.rb +27 -27
  71. metadata +6 -6
  72. data/.travis.yml +0 -19
@@ -19,7 +19,7 @@ module AvaTax
19
19
  #
20
20
  # ### Security Policies
21
21
  #
22
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
22
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
23
23
  # * This API depends on the following active services:*Required* (all): AutoAddress.
24
24
  # Swagger Name: AvaTaxClient
25
25
  # @param line1 [String] Line 1
@@ -32,7 +32,7 @@ module AvaTax
32
32
  # @param textCase [String] selectable text case for address validation (See TextCase::* for a list of allowable values)
33
33
  # @return [Object]
34
34
  def resolve_address(options={}) path = "/api/v2/addresses/resolve"
35
- get(path, options, "22.3.0") end
35
+ get(path, options, "22.7.0") end
36
36
 
37
37
  # Retrieve geolocation information for a specified address
38
38
  #
@@ -45,13 +45,13 @@ module AvaTax
45
45
  #
46
46
  # ### Security Policies
47
47
  #
48
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
48
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
49
49
  # * This API depends on the following active services:*Required* (all): AutoAddress.
50
50
  # Swagger Name: AvaTaxClient
51
51
  # @param model [Object] The address to resolve
52
52
  # @return [Object]
53
53
  def resolve_address_post(model) path = "/api/v2/addresses/resolve"
54
- post(path, model, {}, "22.3.0") end
54
+ post(path, model, {}, "22.7.0") end
55
55
  end
56
56
  end
57
57
  end
@@ -12,7 +12,7 @@ module AvaTax
12
12
  # @param model [Object] The lookup file you wish to create
13
13
  # @return [Object]
14
14
  def create_company_lookup_file(accountId, companyId, model) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
15
- post(path, model, {}, "22.3.0") end
15
+ post(path, model, {}, "22.7.0") end
16
16
 
17
17
  # Delete a lookup file
18
18
  #
@@ -22,7 +22,7 @@ module AvaTax
22
22
  # @param id [String] The unique ID/GUID for the company lookup file to be deleted
23
23
  # @return [ErrorDetail[]]
24
24
  def delete_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
25
- delete(path, {}, "22.3.0") end
25
+ delete(path, {}, "22.7.0") end
26
26
 
27
27
  # Get the lookup files for a company
28
28
  #
@@ -32,7 +32,7 @@ module AvaTax
32
32
  # @param companyId [Integer] The ID of the company for which to retrieve lookup files
33
33
  # @return [FetchResult]
34
34
  def get_company_lookup_files(accountId, companyId) path = "/api/v2/advancedrules/accounts/#{accountId}/companies/#{companyId}/lookupFiles"
35
- get(path, {}, "22.3.0") end
35
+ get(path, {}, "22.7.0") end
36
36
 
37
37
  # Get a lookup file for an accountId and companyLookupFileId
38
38
  #
@@ -42,7 +42,7 @@ module AvaTax
42
42
  # @param id [String] The unique ID/GUID of the company lookup file to return
43
43
  # @return [Object]
44
44
  def get_lookup_file(accountId, id) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
45
- get(path, {}, "22.3.0") end
45
+ get(path, {}, "22.7.0") end
46
46
 
47
47
  # Update a lookup file
48
48
  #
@@ -53,7 +53,7 @@ module AvaTax
53
53
  # @param model [Object] The new values to update the lookup file
54
54
  # @return [Object]
55
55
  def update_lookup_file(accountId, id, model) path = "/api/v2/advancedrules/accounts/#{accountId}/lookupFiles/#{id}"
56
- put(path, model, {}, "22.3.0") end
56
+ put(path, model, {}, "22.7.0") end
57
57
  end
58
58
  end
59
59
  end
@@ -16,7 +16,7 @@ module AvaTax
16
16
  # @param model [AvaFileFormModel[]] The AvaFileForm you wish to create.
17
17
  # @return [AvaFileFormModel[]]
18
18
  def create_ava_file_forms(model) path = "/api/v2/avafileforms"
19
- post(path, model, {}, "22.3.0") end
19
+ post(path, model, {}, "22.7.0") end
20
20
 
21
21
  # Delete a single AvaFileForm
22
22
  #
@@ -30,7 +30,7 @@ module AvaTax
30
30
  # @param id [Integer] The ID of the AvaFileForm you wish to delete.
31
31
  # @return [ErrorDetail[]]
32
32
  def delete_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
33
- delete(path, {}, "22.3.0") end
33
+ delete(path, {}, "22.7.0") end
34
34
 
35
35
  # Retrieve a single AvaFileForm
36
36
  #
@@ -38,13 +38,13 @@ module AvaTax
38
38
  #
39
39
  # ### Security Policies
40
40
  #
41
- # * 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.
41
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
42
42
  # * 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.
43
43
  # Swagger Name: AvaTaxClient
44
44
  # @param id [Integer] The primary key of this AvaFileForm
45
45
  # @return [Object]
46
46
  def get_ava_file_form(id) path = "/api/v2/avafileforms/#{id}"
47
- get(path, {}, "22.3.0") end
47
+ get(path, {}, "22.7.0") end
48
48
 
49
49
  # Retrieve all AvaFileForms
50
50
  #
@@ -53,7 +53,7 @@ module AvaTax
53
53
  #
54
54
  # ### Security Policies
55
55
  #
56
- # * 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.
56
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, Compliance Temp User, ComplianceAdmin, ComplianceUser, FirmAdmin, FirmUser, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin.
57
57
  # * 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.
58
58
  # Swagger Name: AvaTaxClient
59
59
  # @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
@@ -62,7 +62,7 @@ module AvaTax
62
62
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
63
63
  # @return [FetchResult]
64
64
  def query_ava_file_forms(options={}) path = "/api/v2/avafileforms"
65
- get(path, options, "22.3.0") end
65
+ get(path, options, "22.7.0") end
66
66
 
67
67
  # Update a AvaFileForm
68
68
  #
@@ -78,7 +78,7 @@ module AvaTax
78
78
  # @param model [Object] The AvaFileForm model you wish to update.
79
79
  # @return [Object]
80
80
  def update_ava_file_form(id, model) path = "/api/v2/avafileforms/#{id}"
81
- put(path, model, {}, "22.3.0") end
81
+ put(path, model, {}, "22.7.0") end
82
82
  end
83
83
  end
84
84
  end
@@ -20,13 +20,13 @@ module AvaTax
20
20
  #
21
21
  # ### Security Policies
22
22
  #
23
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
23
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
24
24
  # Swagger Name: AvaTaxClient
25
25
  # @param companyId [Integer] The ID of the company that owns this batch.
26
26
  # @param id [Integer] The ID of the batch to cancel.
27
27
  # @return [Object]
28
28
  def cancel_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}/cancel"
29
- post(path, {}, "22.3.0") end
29
+ post(path, {}, "22.7.0") end
30
30
 
31
31
  # Create a new batch
32
32
  #
@@ -52,13 +52,13 @@ module AvaTax
52
52
  #
53
53
  # ### Security Policies
54
54
  #
55
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
55
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
56
56
  # Swagger Name: AvaTaxClient
57
57
  # @param companyId [Integer] The ID of the company that owns this batch.
58
58
  # @param model [BatchModel[]] The batch you wish to create.
59
59
  # @return [BatchModel[]]
60
60
  def create_batches(companyId, model) path = "/api/v2/companies/#{companyId}/batches"
61
- post(path, model, {}, "22.3.0") end
61
+ post(path, model, {}, "22.7.0") end
62
62
 
63
63
  # Create a new transaction batch
64
64
  #
@@ -82,13 +82,13 @@ module AvaTax
82
82
  #
83
83
  # ### Security Policies
84
84
  #
85
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
85
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, BatchServiceAdmin, CompanyAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
86
86
  # Swagger Name: AvaTaxClient
87
87
  # @param companyId [Integer] The ID of the company that owns this batch.
88
88
  # @param model [Object] The transaction batch you wish to create.
89
89
  # @return [Object]
90
90
  def create_transaction_batch(companyId, model) path = "/api/v2/companies/#{companyId}/batches/transactions"
91
- post(path, model, {}, "22.3.0") end
91
+ post(path, model, {}, "22.7.0") end
92
92
 
93
93
  # Delete a single batch
94
94
  #
@@ -105,13 +105,13 @@ module AvaTax
105
105
  #
106
106
  # ### Security Policies
107
107
  #
108
- # * This API requires one of the following user roles: CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
108
+ # * This API requires one of the following user roles: BatchServiceAdmin, CSPAdmin, CSPTester, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin.
109
109
  # Swagger Name: AvaTaxClient
110
110
  # @param companyId [Integer] The ID of the company that owns this batch.
111
111
  # @param id [Integer] The ID of the batch to delete.
112
112
  # @return [ErrorDetail[]]
113
113
  def delete_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
114
- delete(path, {}, "22.3.0") end
114
+ delete(path, {}, "22.7.0") end
115
115
 
116
116
  # Download a single batch file
117
117
  #
@@ -119,14 +119,14 @@ module AvaTax
119
119
  #
120
120
  # ### Security Policies
121
121
  #
122
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
122
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
123
123
  # Swagger Name: AvaTaxClient
124
124
  # @param companyId [Integer] The ID of the company that owns this batch
125
125
  # @param batchId [Integer] The ID of the batch object
126
126
  # @param id [Integer] The primary key of this batch file object
127
127
  # @return [Object]
128
128
  def download_batch(companyId, batchId, id) path = "/api/v2/companies/#{companyId}/batches/#{batchId}/files/#{id}/attachment"
129
- get(path, {}, "22.3.0") end
129
+ get(path, {}, "22.7.0") end
130
130
 
131
131
  # Retrieve a single batch
132
132
  #
@@ -148,13 +148,13 @@ module AvaTax
148
148
  #
149
149
  # ### Security Policies
150
150
  #
151
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
151
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
152
152
  # Swagger Name: AvaTaxClient
153
153
  # @param companyId [Integer] The ID of the company that owns this batch
154
154
  # @param id [Integer] The primary key of this batch
155
155
  # @return [Object]
156
156
  def get_batch(companyId, id) path = "/api/v2/companies/#{companyId}/batches/#{id}"
157
- get(path, {}, "22.3.0") end
157
+ get(path, {}, "22.7.0") end
158
158
 
159
159
  # Retrieve all batches for this company
160
160
  #
@@ -182,7 +182,7 @@ module AvaTax
182
182
  #
183
183
  # ### Security Policies
184
184
  #
185
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
185
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
186
186
  # Swagger Name: AvaTaxClient
187
187
  # @param companyId [Integer] The ID of the company that owns these batches
188
188
  # @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:* files
@@ -192,7 +192,7 @@ module AvaTax
192
192
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
193
193
  # @return [FetchResult]
194
194
  def list_batches_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/batches"
195
- get(path, options, "22.3.0") end
195
+ get(path, options, "22.7.0") end
196
196
 
197
197
  # Retrieve all batches
198
198
  #
@@ -217,7 +217,7 @@ module AvaTax
217
217
  #
218
218
  # ### Security Policies
219
219
  #
220
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
220
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, SystemOperator, TechnicalSupportAdmin, TechnicalSupportUser.
221
221
  # Swagger Name: AvaTaxClient
222
222
  # @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:* files
223
223
  # @param include [String] A comma separated list of additional data to retrieve.
@@ -226,7 +226,7 @@ module AvaTax
226
226
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
227
227
  # @return [FetchResult]
228
228
  def query_batches(options={}) path = "/api/v2/batches"
229
- get(path, options, "22.3.0") end
229
+ get(path, options, "22.7.0") end
230
230
  end
231
231
  end
232
232
  end
@@ -23,7 +23,7 @@ module AvaTax
23
23
  #
24
24
  # ### Security Policies
25
25
  #
26
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
26
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
27
27
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
28
28
  # Swagger Name: AvaTaxClient
29
29
  # @param companyId [Integer] The unique ID number of the company that will record certificates
@@ -31,7 +31,7 @@ module AvaTax
31
31
  # @param model [CreateCertExpressInvitationModel[]] the requests to send out to customers
32
32
  # @return [CertExpressInvitationStatusModel[]]
33
33
  def create_cert_express_invitation(companyId, customerCode, model) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites"
34
- post(path, model, {}, "22.3.0") end
34
+ post(path, model, {}, "22.7.0") end
35
35
 
36
36
  # Retrieve a single CertExpress invitation
37
37
  #
@@ -53,7 +53,7 @@ module AvaTax
53
53
  #
54
54
  # ### Security Policies
55
55
  #
56
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
56
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
57
57
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
58
58
  # Swagger Name: AvaTaxClient
59
59
  # @param companyId [Integer] The unique ID number of the company that issued this invitation
@@ -62,7 +62,7 @@ module AvaTax
62
62
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are defined at this time.
63
63
  # @return [Object]
64
64
  def get_cert_express_invitation(companyId, customerCode, id, options={}) path = "/api/v2/companies/#{companyId}/customers/#{customerCode}/certexpressinvites/#{id}"
65
- get(path, options, "22.3.0") end
65
+ get(path, options, "22.7.0") end
66
66
 
67
67
  # List CertExpress invitations
68
68
  #
@@ -84,7 +84,7 @@ module AvaTax
84
84
  #
85
85
  # ### Security Policies
86
86
  #
87
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
87
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
88
88
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
89
89
  # Swagger Name: AvaTaxClient
90
90
  # @param companyId [Integer] The unique ID number of the company that issued this invitation
@@ -95,7 +95,7 @@ module AvaTax
95
95
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
96
96
  # @return [FetchResult]
97
97
  def list_cert_express_invitations(companyId, options={}) path = "/api/v2/companies/#{companyId}/certexpressinvites"
98
- get(path, options, "22.3.0") end
98
+ get(path, options, "22.7.0") end
99
99
  end
100
100
  end
101
101
  end
@@ -29,7 +29,7 @@ module AvaTax
29
29
  #
30
30
  # ### Security Policies
31
31
  #
32
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
32
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
33
33
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
34
34
  # Swagger Name: AvaTaxClient
35
35
  # @param companyId [Integer] The ID number of the company recording this certificate
@@ -37,7 +37,7 @@ module AvaTax
37
37
  # @param model [CertificateModel[]] Certificates to be created
38
38
  # @return [CertificateModel[]]
39
39
  def create_certificates(companyId, model, options={}) path = "/api/v2/companies/#{companyId}/certificates"
40
- post(path, model, options, "22.3.0") end
40
+ post(path, model, options, "22.7.0") end
41
41
 
42
42
  # Revoke and delete a certificate
43
43
  #
@@ -57,14 +57,14 @@ module AvaTax
57
57
  #
58
58
  # ### Security Policies
59
59
  #
60
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
60
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
61
61
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
62
62
  # Swagger Name: AvaTaxClient
63
63
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
64
64
  # @param id [Integer] The unique ID number of this certificate
65
65
  # @return [ErrorDetail[]]
66
66
  def delete_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
67
- delete(path, {}, "22.3.0") end
67
+ delete(path, {}, "22.7.0") end
68
68
 
69
69
  # Download an image for this certificate
70
70
  #
@@ -85,7 +85,7 @@ module AvaTax
85
85
  #
86
86
  # ### Security Policies
87
87
  #
88
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
88
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
89
89
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
90
90
  # Swagger Name: AvaTaxClient
91
91
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
@@ -94,7 +94,7 @@ module AvaTax
94
94
  # @param type [String] The data format in which to retrieve the certificate image (See CertificatePreviewType::* for a list of allowable values)
95
95
  # @return [Object]
96
96
  def download_certificate_image(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
97
- get(path, options, "22.3.0") end
97
+ get(path, options, "22.7.0") end
98
98
 
99
99
  # Retrieve a single certificate
100
100
  #
@@ -118,7 +118,7 @@ module AvaTax
118
118
  #
119
119
  # ### Security Policies
120
120
  #
121
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
121
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
122
122
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
123
123
  # Swagger Name: AvaTaxClient
124
124
  # @param companyId [Integer] The ID number of the company that recorded this certificate
@@ -126,7 +126,7 @@ module AvaTax
126
126
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. You can specify one or more of the following: * customers - Retrieves the list of customers linked to the certificate. * po_numbers - Retrieves all PO numbers tied to the certificate. * attributes - Retrieves all attributes applied to the certificate.
127
127
  # @return [Object]
128
128
  def get_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
129
- get(path, options, "22.3.0") end
129
+ get(path, options, "22.7.0") end
130
130
 
131
131
  # Check a company's exemption certificate status.
132
132
  #
@@ -140,13 +140,13 @@ module AvaTax
140
140
  #
141
141
  # ### Security Policies
142
142
  #
143
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
143
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
144
144
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
145
145
  # Swagger Name: AvaTaxClient
146
146
  # @param companyId [Integer] The company ID to check
147
147
  # @return [Object]
148
148
  def get_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
149
- get(path, {}, "22.3.0") end
149
+ get(path, {}, "22.7.0") end
150
150
 
151
151
  # Link attributes to a certificate
152
152
  #
@@ -167,7 +167,7 @@ module AvaTax
167
167
  #
168
168
  # ### Security Policies
169
169
  #
170
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
170
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
171
171
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
172
172
  # Swagger Name: AvaTaxClient
173
173
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
@@ -175,7 +175,7 @@ module AvaTax
175
175
  # @param model [CertificateAttributeModel[]] The list of attributes to link to this certificate.
176
176
  # @return [FetchResult]
177
177
  def link_attributes_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/link"
178
- post(path, model, {}, "22.3.0") end
178
+ post(path, model, {}, "22.7.0") end
179
179
 
180
180
  # Link customers to a certificate
181
181
  #
@@ -197,7 +197,7 @@ module AvaTax
197
197
  #
198
198
  # ### Security Policies
199
199
  #
200
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
200
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
201
201
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
202
202
  # Swagger Name: AvaTaxClient
203
203
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
@@ -205,7 +205,7 @@ module AvaTax
205
205
  # @param model [Object] The list of customers needed be added to the Certificate for exemption
206
206
  # @return [FetchResult]
207
207
  def link_customers_to_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/link"
208
- post(path, model, {}, "22.3.0") end
208
+ post(path, model, {}, "22.7.0") end
209
209
 
210
210
  # List all attributes applied to this certificate
211
211
  #
@@ -226,14 +226,14 @@ module AvaTax
226
226
  #
227
227
  # ### Security Policies
228
228
  #
229
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
229
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
230
230
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
231
231
  # Swagger Name: AvaTaxClient
232
232
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
233
233
  # @param id [Integer] The unique ID number of this certificate
234
234
  # @return [FetchResult]
235
235
  def list_attributes_for_certificate(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes"
236
- get(path, {}, "22.3.0") end
236
+ get(path, {}, "22.7.0") end
237
237
 
238
238
  # List customers linked to this certificate
239
239
  #
@@ -254,7 +254,7 @@ module AvaTax
254
254
  #
255
255
  # ### Security Policies
256
256
  #
257
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
257
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
258
258
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
259
259
  # Swagger Name: AvaTaxClient
260
260
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
@@ -262,7 +262,7 @@ module AvaTax
262
262
  # @param include [String] OPTIONAL: A comma separated list of special fetch options. No options are currently available when fetching customers.
263
263
  # @return [FetchResult]
264
264
  def list_customers_for_certificate(companyId, id, options={}) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers"
265
- get(path, options, "22.3.0") end
265
+ get(path, options, "22.7.0") end
266
266
 
267
267
  # List all certificates for a company
268
268
  #
@@ -286,7 +286,7 @@ module AvaTax
286
286
  #
287
287
  # ### Security Policies
288
288
  #
289
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
289
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
290
290
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
291
291
  # Swagger Name: AvaTaxClient
292
292
  # @param companyId [Integer] The ID number of the company to search
@@ -297,7 +297,7 @@ module AvaTax
297
297
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
298
298
  # @return [FetchResult]
299
299
  def query_certificates(companyId, options={}) path = "/api/v2/companies/#{companyId}/certificates"
300
- get(path, options, "22.3.0") end
300
+ get(path, options, "22.7.0") end
301
301
 
302
302
  # Request setup of exemption certificates for this company.
303
303
  #
@@ -313,13 +313,13 @@ module AvaTax
313
313
  #
314
314
  # ### Security Policies
315
315
  #
316
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
316
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
317
317
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
318
318
  # Swagger Name: AvaTaxClient
319
319
  # @param companyId [Integer]
320
320
  # @return [Object]
321
321
  def request_certificate_setup(companyId) path = "/api/v2/companies/#{companyId}/certificates/setup"
322
- post(path, {}, "22.3.0") end
322
+ post(path, {}, "22.7.0") end
323
323
 
324
324
  # Unlink attributes from a certificate
325
325
  #
@@ -340,7 +340,7 @@ module AvaTax
340
340
  #
341
341
  # ### Security Policies
342
342
  #
343
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
343
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
344
344
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
345
345
  # Swagger Name: AvaTaxClient
346
346
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
@@ -348,7 +348,7 @@ module AvaTax
348
348
  # @param model [CertificateAttributeModel[]] The list of attributes to unlink from this certificate.
349
349
  # @return [FetchResult]
350
350
  def unlink_attributes_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attributes/unlink"
351
- post(path, model, {}, "22.3.0") end
351
+ post(path, model, {}, "22.7.0") end
352
352
 
353
353
  # Unlink customers from a certificate
354
354
  #
@@ -371,7 +371,7 @@ module AvaTax
371
371
  #
372
372
  # ### Security Policies
373
373
  #
374
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
374
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
375
375
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
376
376
  # Swagger Name: AvaTaxClient
377
377
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
@@ -379,7 +379,7 @@ module AvaTax
379
379
  # @param model [Object] The list of customers to unlink from this certificate
380
380
  # @return [FetchResult]
381
381
  def unlink_customers_from_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}/customers/unlink"
382
- post(path, model, {}, "22.3.0") end
382
+ post(path, model, {}, "22.7.0") end
383
383
 
384
384
  # Update a single certificate
385
385
  #
@@ -397,7 +397,7 @@ module AvaTax
397
397
  #
398
398
  # ### Security Policies
399
399
  #
400
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
400
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin.
401
401
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
402
402
  # Swagger Name: AvaTaxClient
403
403
  # @param companyId [Integer] The ID number of the company that recorded this certificate
@@ -405,7 +405,7 @@ module AvaTax
405
405
  # @param model [Object] The new certificate object that will replace the existing one
406
406
  # @return [Object]
407
407
  def update_certificate(companyId, id, model) path = "/api/v2/companies/#{companyId}/certificates/#{id}"
408
- put(path, model, {}, "22.3.0") end
408
+ put(path, model, {}, "22.7.0") end
409
409
 
410
410
  # Upload an image or PDF attachment for this certificate
411
411
  #
@@ -426,7 +426,7 @@ module AvaTax
426
426
  #
427
427
  # ### Security Policies
428
428
  #
429
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
429
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPTester, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
430
430
  # * This API depends on the following active services:*Required* (all): AvaTaxPro.
431
431
  # Swagger Name: AvaTaxClient
432
432
  # @param companyId [Integer] The unique ID number of the company that recorded this certificate
@@ -434,7 +434,7 @@ module AvaTax
434
434
  # @param file [Object] The exemption certificate file you wanted to upload. Accepted formats are: PDF, JPEG, TIFF, PNG.
435
435
  # @return [String]
436
436
  def upload_certificate_image(companyId, id) path = "/api/v2/companies/#{companyId}/certificates/#{id}/attachment"
437
- post(path, {}, "22.3.0") end
437
+ post(path, {}, "22.7.0") end
438
438
  end
439
439
  end
440
440
  end