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
@@ -13,13 +13,13 @@ module AvaTax
13
13
  #
14
14
  # ### Security Policies
15
15
  #
16
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
16
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
17
17
  # Swagger Name: AvaTaxClient
18
18
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
19
19
  # @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
20
20
  # @return [CompanyDistanceThresholdModel[]]
21
21
  def create_distance_threshold(companyId, model) path = "/api/v2/companies/#{companyId}/distancethresholds"
22
- post(path, model, {}, "22.3.0") end
22
+ post(path, model, {}, "22.7.0") end
23
23
 
24
24
  # Delete a single DistanceThreshold object
25
25
  #
@@ -31,13 +31,13 @@ module AvaTax
31
31
  #
32
32
  # ### Security Policies
33
33
  #
34
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
34
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
35
35
  # Swagger Name: AvaTaxClient
36
36
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
37
37
  # @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
38
38
  # @return [ErrorDetail[]]
39
39
  def delete_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
40
- delete(path, {}, "22.3.0") end
40
+ delete(path, {}, "22.7.0") end
41
41
 
42
42
  # Retrieve a single DistanceThreshold
43
43
  #
@@ -49,13 +49,13 @@ module AvaTax
49
49
  #
50
50
  # ### Security Policies
51
51
  #
52
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
52
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
53
53
  # Swagger Name: AvaTaxClient
54
54
  # @param companyId [Integer] The ID of the company that owns this DistanceThreshold object
55
55
  # @param id [Integer] The unique ID number referring to this DistanceThreshold object
56
56
  # @return [Object]
57
57
  def get_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
58
- get(path, {}, "22.3.0") end
58
+ get(path, {}, "22.7.0") end
59
59
 
60
60
  # Retrieve all DistanceThresholds for this company.
61
61
  #
@@ -67,7 +67,7 @@ module AvaTax
67
67
  #
68
68
  # ### Security Policies
69
69
  #
70
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
70
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
71
71
  # Swagger Name: AvaTaxClient
72
72
  # @param companyId [Integer] The ID of the company whose DistanceThreshold objects you wish to list.
73
73
  # @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/).
@@ -77,7 +77,7 @@ module AvaTax
77
77
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
78
78
  # @return [FetchResult]
79
79
  def list_distance_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/distancethresholds"
80
- get(path, options, "22.3.0") end
80
+ get(path, options, "22.7.0") end
81
81
 
82
82
  # Retrieve all DistanceThreshold objects
83
83
  #
@@ -92,7 +92,7 @@ module AvaTax
92
92
  #
93
93
  # ### Security Policies
94
94
  #
95
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
95
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
96
96
  # Swagger Name: AvaTaxClient
97
97
  # @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/).
98
98
  # @param include [String] A comma separated list of additional data to retrieve.
@@ -101,7 +101,7 @@ module AvaTax
101
101
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
102
102
  # @return [FetchResult]
103
103
  def query_distance_thresholds(options={}) path = "/api/v2/distancethresholds"
104
- get(path, options, "22.3.0") end
104
+ get(path, options, "22.7.0") end
105
105
 
106
106
  # Update a DistanceThreshold object
107
107
  #
@@ -116,14 +116,14 @@ module AvaTax
116
116
  #
117
117
  # ### Security Policies
118
118
  #
119
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
119
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
120
120
  # Swagger Name: AvaTaxClient
121
121
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold object.
122
122
  # @param id [Integer] The unique ID number of the DistanceThreshold object to replace.
123
123
  # @param model [Object] The new DistanceThreshold object to store.
124
124
  # @return [Object]
125
125
  def update_distance_threshold(companyId, id, model) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
126
- put(path, model, {}, "22.3.0") end
126
+ put(path, model, {}, "22.7.0") end
127
127
  end
128
128
  end
129
129
  end
@@ -1,74 +1,74 @@
1
- module AvaTax
2
- class Client
3
- module Ecms
4
-
5
-
6
- # Get an ECMS identified by company id and ECMS id
7
- #
8
- # Get an ECMS identified by company id and ECMS id.
9
- # An ECMS data represents a documentation based on which companies can claim tax exemption
10
- # You may attach nested data objects such as exempt cert detail, and those objects will be created with certificate.
11
- # 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:
12
- #
13
- # * Details
14
- #
15
- # ### Security Policies
16
- #
17
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
18
- # * This API depends on the following active services<br />*Required* (all): AvaCert.
19
- # @param companyId [Integer] company to retrieve exempt certificate for
20
- # @param ecmsId [Integer] exempt certificate Id
21
- # @param include [String]
22
- # @return [Object]
23
- def get_e_c_m_s_by_id(companyId, ecmsId, options={}) path = "/api/v2/companies/#{companyId}/ecms/#{ecmsId}"
24
- get(path, options) end
25
-
26
- # Get list of ECMS data for this company
27
- #
28
- # Get list of ECMS data for this company
29
- # An ECMS data represents a documentation based on which companies can claim tax exemption
30
- # You may attach nested data objects such as ECMS detail, and those objects will be created with certificate.
31
- # 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:
32
- #
33
- # * Details
34
- #
35
- # ### Security Policies
36
- #
37
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
38
- # * This API depends on the following active services<br />*Required* (all): AvaCert.
39
- # @param companyId [Integer] which company to retrieve certificates from
40
- # @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:* details
41
- # @param include [String]
42
- # @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.
43
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
44
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
45
- # @return [FetchResult]
46
- def list_e_c_m_s_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/ecms"
47
- get(path, options) end
48
-
49
- # Get all exempt certificates
50
- #
51
- # Get all ECMS currently available in database.
52
- # An ECMS data represents a documentation based on which companies can claim tax exemption
53
- # You may attach nested data objects such as ECMS detail, and those objects will be created with certificate.
54
- # 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/) .
55
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
56
- # 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:
57
- #
58
- # * Details
59
- #
60
- # ### Security Policies
61
- #
62
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
63
- # * This API depends on the following active services<br />*Required* (all): AvaCert.
64
- # @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:* details
65
- # @param include [String]
66
- # @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.
67
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
68
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
69
- # @return [FetchResult]
70
- def query_e_c_m_s(options={}) path = "/api/v2/ecms"
71
- get(path, options) end
72
- end
73
- end
1
+ module AvaTax
2
+ class Client
3
+ module Ecms
4
+
5
+
6
+ # Get an ECMS identified by company id and ECMS id
7
+ #
8
+ # Get an ECMS identified by company id and ECMS id.
9
+ # An ECMS data represents a documentation based on which companies can claim tax exemption
10
+ # You may attach nested data objects such as exempt cert detail, and those objects will be created with certificate.
11
+ # 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:
12
+ #
13
+ # * Details
14
+ #
15
+ # ### Security Policies
16
+ #
17
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
18
+ # * This API depends on the following active services<br />*Required* (all): AvaCert.
19
+ # @param companyId [Integer] company to retrieve exempt certificate for
20
+ # @param ecmsId [Integer] exempt certificate Id
21
+ # @param include [String]
22
+ # @return [Object]
23
+ def get_e_c_m_s_by_id(companyId, ecmsId, options={}) path = "/api/v2/companies/#{companyId}/ecms/#{ecmsId}"
24
+ get(path, options) end
25
+
26
+ # Get list of ECMS data for this company
27
+ #
28
+ # Get list of ECMS data for this company
29
+ # An ECMS data represents a documentation based on which companies can claim tax exemption
30
+ # You may attach nested data objects such as ECMS detail, and those objects will be created with certificate.
31
+ # 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:
32
+ #
33
+ # * Details
34
+ #
35
+ # ### Security Policies
36
+ #
37
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
38
+ # * This API depends on the following active services<br />*Required* (all): AvaCert.
39
+ # @param companyId [Integer] which company to retrieve certificates from
40
+ # @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:* details
41
+ # @param include [String]
42
+ # @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.
43
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
44
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
45
+ # @return [FetchResult]
46
+ def list_e_c_m_s_by_company(companyId, options={}) path = "/api/v2/companies/#{companyId}/ecms"
47
+ get(path, options) end
48
+
49
+ # Get all exempt certificates
50
+ #
51
+ # Get all ECMS currently available in database.
52
+ # An ECMS data represents a documentation based on which companies can claim tax exemption
53
+ # You may attach nested data objects such as ECMS detail, and those objects will be created with certificate.
54
+ # 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/) .
55
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
56
+ # 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:
57
+ #
58
+ # * Details
59
+ #
60
+ # ### Security Policies
61
+ #
62
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
63
+ # * This API depends on the following active services<br />*Required* (all): AvaCert.
64
+ # @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:* details
65
+ # @param include [String]
66
+ # @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.
67
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
68
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
69
+ # @return [FetchResult]
70
+ def query_e_c_m_s(options={}) path = "/api/v2/ecms"
71
+ get(path, options) end
72
+ end
73
+ end
74
74
  end
@@ -11,13 +11,13 @@ module AvaTax
11
11
  #
12
12
  # ### Security Policies
13
13
  #
14
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
14
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
15
15
  # Swagger Name: AvaTaxClient
16
16
  # @param companyId [Integer] The company ID that will be issued this certificate.
17
17
  # @param model [Object]
18
18
  # @return [Object]
19
19
  def create_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
20
- post(path, model, {}, "22.3.0") end
20
+ post(path, model, {}, "22.7.0") end
21
21
 
22
22
  # Refresh an eCommerce token.
23
23
  #
@@ -27,13 +27,13 @@ module AvaTax
27
27
  #
28
28
  # ### Security Policies
29
29
  #
30
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
30
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
31
31
  # Swagger Name: AvaTaxClient
32
32
  # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
33
33
  # @param model [Object]
34
34
  # @return [FetchResult]
35
35
  def refresh_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
36
- put(path, model, {}, "22.3.0") end
36
+ put(path, model, {}, "22.7.0") end
37
37
  end
38
38
  end
39
39
  end
@@ -1,62 +1,62 @@
1
- module AvaTax
2
- class Client
3
- module ErrorTransactions
4
-
5
-
6
- # Delete a batch of error transactions
7
- #
8
- # Delete a batch of error transactions attached to a company.
9
- #
10
- # If any of the provided error transaction isn't found then it'll be treated as a success.
11
- #
12
- # ### Security Policies
13
- #
14
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
15
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
16
- # @param companyId [Integer] ID number of the company to delete error transactions from.
17
- # @param model [Object] The request that contains error transactions to be deleted
18
- # @return [Object]
19
- def delete_error_transactions(companyId, model) path = "/api/v2/companies/#{companyId}/errortransactions"
20
- delete(path, model) end
21
-
22
- # Get a list of error transactions' error codes and its counts
23
- #
24
- # Get a list of error transactions' error codes and their counts
25
- # When you try to create or adjust a transaction with a datasource for a company and for any reason that call fails with an error,
26
- # those errors with their count can be retrieved by this API.
27
- #
28
- # ### Security Policies
29
- #
30
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
31
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
32
- # @param companyId [Integer] ID number of the company to query from.
33
- # @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.
34
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
35
- # @return [CappedFetchResult]
36
- def list_error_codes(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions/errorcodes"
37
- get(path, options) end
38
-
39
- # Retrieve list of error transactions
40
- #
41
- # List error transactions attached to this company. Results are dependent on `$filter` if provided.
42
- #
43
- # This endpoint is limited to returning 1000 error transactions at a time maximum.
44
- #
45
- # 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/) .
46
- # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
47
- #
48
- # ### Security Policies
49
- #
50
- # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
51
- # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
52
- # @param companyId [Integer] The company ID to filter error transactions on.
53
- # @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:* companyId, avataxErrorJson, avataxCreateTransactionJson, expiresAt
54
- # @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.
55
- # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
56
- # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
57
- # @return [CappedFetchResult]
58
- def list_error_transactions(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions"
59
- get(path, options) end
60
- end
61
- end
1
+ module AvaTax
2
+ class Client
3
+ module ErrorTransactions
4
+
5
+
6
+ # Delete a batch of error transactions
7
+ #
8
+ # Delete a batch of error transactions attached to a company.
9
+ #
10
+ # If any of the provided error transaction isn't found then it'll be treated as a success.
11
+ #
12
+ # ### Security Policies
13
+ #
14
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
15
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
16
+ # @param companyId [Integer] ID number of the company to delete error transactions from.
17
+ # @param model [Object] The request that contains error transactions to be deleted
18
+ # @return [Object]
19
+ def delete_error_transactions(companyId, model) path = "/api/v2/companies/#{companyId}/errortransactions"
20
+ delete(path, model) end
21
+
22
+ # Get a list of error transactions' error codes and its counts
23
+ #
24
+ # Get a list of error transactions' error codes and their counts
25
+ # When you try to create or adjust a transaction with a datasource for a company and for any reason that call fails with an error,
26
+ # those errors with their count can be retrieved by this API.
27
+ #
28
+ # ### Security Policies
29
+ #
30
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
31
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
32
+ # @param companyId [Integer] ID number of the company to query from.
33
+ # @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.
34
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
35
+ # @return [CappedFetchResult]
36
+ def list_error_codes(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions/errorcodes"
37
+ get(path, options) end
38
+
39
+ # Retrieve list of error transactions
40
+ #
41
+ # List error transactions attached to this company. Results are dependent on `$filter` if provided.
42
+ #
43
+ # This endpoint is limited to returning 1000 error transactions at a time maximum.
44
+ #
45
+ # 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/) .
46
+ # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
47
+ #
48
+ # ### Security Policies
49
+ #
50
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, ProStoresOperator, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser.
51
+ # * This API depends on the following active services<br />*Required* (all): AvaTaxPro, BasicReturns.
52
+ # @param companyId [Integer] The company ID to filter error transactions on.
53
+ # @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:* companyId, avataxErrorJson, avataxCreateTransactionJson, expiresAt
54
+ # @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.
55
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
56
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
57
+ # @return [CappedFetchResult]
58
+ def list_error_transactions(companyId, options={}) path = "/api/v2/companies/#{companyId}/errortransactions"
59
+ get(path, options) end
60
+ end
61
+ end
62
62
  end
@@ -9,12 +9,12 @@ module AvaTax
9
9
  #
10
10
  # ### Security Policies
11
11
  #
12
- # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
12
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
13
13
  # Swagger Name: AvaTaxClient
14
14
  # @param id [Integer]
15
15
  # @return [Object]
16
16
  def approve_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/approve"
17
- post(path, {}, "22.3.0") end
17
+ post(path, {}, "22.7.0") end
18
18
 
19
19
  # Request a new FirmClient account and create an approved linkage to it
20
20
  #
@@ -36,7 +36,7 @@ module AvaTax
36
36
  # @param model [Object] Information about the account you wish to create.
37
37
  # @return [Object]
38
38
  def create_and_link_new_firm_client_account(model) path = "/api/v2/firmclientlinkages/createandlinkclient"
39
- post(path, model, {}, "22.3.0") end
39
+ post(path, model, {}, "22.7.0") end
40
40
 
41
41
  # Links a firm account with the client account
42
42
  #
@@ -44,12 +44,12 @@ module AvaTax
44
44
  #
45
45
  # ### Security Policies
46
46
  #
47
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
47
+ # * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
48
48
  # Swagger Name: AvaTaxClient
49
49
  # @param model [Object] FirmClientLinkageInputModel
50
50
  # @return [Object]
51
51
  def create_firm_client_linkage(model) path = "/api/v2/firmclientlinkages"
52
- post(path, model, {}, "22.3.0") end
52
+ post(path, model, {}, "22.7.0") end
53
53
 
54
54
  # Delete a linkage
55
55
  #
@@ -57,12 +57,12 @@ module AvaTax
57
57
  #
58
58
  # ### Security Policies
59
59
  #
60
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
60
+ # * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
61
61
  # Swagger Name: AvaTaxClient
62
62
  # @param id [Integer]
63
63
  # @return [ErrorDetail[]]
64
64
  def delete_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
65
- delete(path, {}, "22.3.0") end
65
+ delete(path, {}, "22.7.0") end
66
66
 
67
67
  # Get linkage between a firm and client by id
68
68
  #
@@ -70,12 +70,12 @@ 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, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
74
74
  # Swagger Name: AvaTaxClient
75
75
  # @param id [Integer]
76
76
  # @return [Object]
77
77
  def get_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}"
78
- get(path, {}, "22.3.0") end
78
+ get(path, {}, "22.7.0") end
79
79
 
80
80
  # List client linkages for a firm or client
81
81
  #
@@ -83,12 +83,12 @@ module AvaTax
83
83
  #
84
84
  # ### Security Policies
85
85
  #
86
- # * 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.
86
+ # * This API requires one of the following user roles: AccountAdmin, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
87
87
  # Swagger Name: AvaTaxClient
88
88
  # @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:* firmAccountName, clientAccountName
89
89
  # @return [FetchResult]
90
90
  def list_firm_client_linkage(options={}) path = "/api/v2/firmclientlinkages"
91
- get(path, options, "22.3.0") end
91
+ get(path, options, "22.7.0") end
92
92
 
93
93
  # Rejects linkage to a firm for a client account
94
94
  #
@@ -96,12 +96,12 @@ module AvaTax
96
96
  #
97
97
  # ### Security Policies
98
98
  #
99
- # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
99
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
100
100
  # Swagger Name: AvaTaxClient
101
101
  # @param id [Integer]
102
102
  # @return [Object]
103
103
  def reject_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reject"
104
- post(path, {}, "22.3.0") end
104
+ post(path, {}, "22.7.0") end
105
105
 
106
106
  # Reset linkage status between a client and firm back to requested
107
107
  #
@@ -109,12 +109,12 @@ module AvaTax
109
109
  #
110
110
  # ### Security Policies
111
111
  #
112
- # * This API requires one of the following user roles: FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
112
+ # * This API requires one of the following user roles: BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
113
113
  # Swagger Name: AvaTaxClient
114
114
  # @param id [Integer]
115
115
  # @return [Object]
116
116
  def reset_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/reset"
117
- post(path, {}, "22.3.0") end
117
+ post(path, {}, "22.7.0") end
118
118
 
119
119
  # Revokes previously approved linkage to a firm for a client account
120
120
  #
@@ -122,12 +122,12 @@ module AvaTax
122
122
  #
123
123
  # ### Security Policies
124
124
  #
125
- # * This API requires one of the following user roles: AccountAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
125
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
126
126
  # Swagger Name: AvaTaxClient
127
127
  # @param id [Integer]
128
128
  # @return [Object]
129
129
  def revoke_firm_client_linkage(id) path = "/api/v2/firmclientlinkages/#{id}/revoke"
130
- post(path, {}, "22.3.0") end
130
+ post(path, {}, "22.7.0") end
131
131
  end
132
132
  end
133
133
  end
@@ -23,7 +23,7 @@ module AvaTax
23
23
  # @param model [Object] Required information to provision a free trial account.
24
24
  # @return [Object]
25
25
  def request_free_trial(model) path = "/api/v2/accounts/freetrials/request"
26
- post(path, model, {}, "22.3.0") end
26
+ post(path, model, {}, "22.7.0") end
27
27
  end
28
28
  end
29
29
  end
@@ -20,13 +20,15 @@ module AvaTax
20
20
  #
21
21
  # ### Security Policies
22
22
  #
23
- # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
23
+ # * This API requires one of the following user roles: AccountAdmin, AccountOperator, AccountUser, BatchServiceAdmin, CompanyAdmin, CompanyUser, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPAdmin, CSPTester, FirmAdmin, FirmUser, ProStoresOperator, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
24
24
  # * 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.
25
25
  # Swagger Name: AvaTaxClient
26
26
  # @param id [Integer] The unique ID number of this funding request
27
+ # @param businessUnit [String] The company's business unit (See POABusinessUnit::* for a list of allowable values)
28
+ # @param subscriptionType [String] The company's subscription type (See POASubscriptionType::* for a list of allowable values)
27
29
  # @return [Object]
28
- def activate_funding_request(id) path = "/api/v2/fundingrequests/#{id}/widget"
29
- get(path, {}, "22.3.0") end
30
+ def activate_funding_request(id, options={}) path = "/api/v2/fundingrequests/#{id}/widget"
31
+ get(path, options, "22.7.0") end
30
32
 
31
33
  # Retrieve status about a funding setup request
32
34
  #
@@ -43,13 +45,15 @@ module AvaTax
43
45
  #
44
46
  # ### Security Policies
45
47
  #
46
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
48
+ # * This API requires one of the following user roles: AccountAdmin, BatchServiceAdmin, CompanyAdmin, CSPTester, FirmAdmin, Registrar, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
47
49
  # * 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.
48
50
  # Swagger Name: AvaTaxClient
49
51
  # @param id [Integer] The unique ID number of this funding request
52
+ # @param businessUnit [String] The company's business unit (See POABusinessUnit::* for a list of allowable values)
53
+ # @param subscriptionType [String] The company's subscription type (See POASubscriptionType::* for a list of allowable values)
50
54
  # @return [Object]
51
- def funding_request_status(id) path = "/api/v2/fundingrequests/#{id}"
52
- get(path, {}, "22.3.0") end
55
+ def funding_request_status(id, options={}) path = "/api/v2/fundingrequests/#{id}"
56
+ get(path, options, "22.7.0") end
53
57
  end
54
58
  end
55
59
  end