avatax 21.8.0 → 22.2.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 (75) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +55 -55
  3. data/.rspec +1 -1
  4. data/.travis.yml +18 -18
  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 +94 -83
  16. data/lib/avatax/client/addresses.rb +22 -20
  17. data/lib/avatax/client/advancedrules.rb +46 -41
  18. data/lib/avatax/client/ageverification.rb +29 -0
  19. data/lib/avatax/client/avafileforms.rb +46 -41
  20. data/lib/avatax/client/batches.rb +70 -62
  21. data/lib/avatax/client/certexpressinvites.rb +30 -27
  22. data/lib/avatax/client/certificates.rb +126 -111
  23. data/lib/avatax/client/companies.rb +192 -152
  24. data/lib/avatax/client/compliance.rb +25 -14
  25. data/lib/avatax/client/contacts.rb +54 -48
  26. data/lib/avatax/client/customers.rb +110 -97
  27. data/lib/avatax/client/datasources.rb +54 -48
  28. data/lib/avatax/client/definitions.rb +620 -446
  29. data/lib/avatax/client/distancethresholds.rb +54 -48
  30. data/lib/avatax/client/ecms.rb +73 -73
  31. data/lib/avatax/client/ecommercetoken.rb +20 -18
  32. data/lib/avatax/client/errortransactions.rb +61 -61
  33. data/lib/avatax/client/filingcalendars.rb +44 -20
  34. data/lib/avatax/client/filings.rb +24 -20
  35. data/lib/avatax/client/firmclientlinkages.rb +78 -69
  36. data/lib/avatax/client/free.rb +14 -13
  37. data/lib/avatax/client/fundingrequests.rb +22 -20
  38. data/lib/avatax/client/items.rb +206 -181
  39. data/lib/avatax/client/jurisdictionoverrides.rb +54 -48
  40. data/lib/avatax/client/locations.rb +102 -90
  41. data/lib/avatax/client/multidocument.rb +86 -76
  42. data/lib/avatax/client/nexus.rb +146 -103
  43. data/lib/avatax/client/notices.rb +30 -26
  44. data/lib/avatax/client/notifications.rb +30 -27
  45. data/lib/avatax/client/onboarding.rb +55 -55
  46. data/lib/avatax/client/pointofsale.rb +21 -21
  47. data/lib/avatax/client/provisioning.rb +22 -20
  48. data/lib/avatax/client/registrar.rb +94 -83
  49. data/lib/avatax/client/reports.rb +38 -34
  50. data/lib/avatax/client/settings.rb +54 -48
  51. data/lib/avatax/client/shippingverification.rb +66 -0
  52. data/lib/avatax/client/subscriptions.rb +30 -27
  53. data/lib/avatax/client/taxcodes.rb +54 -48
  54. data/lib/avatax/client/taxcontent.rb +46 -41
  55. data/lib/avatax/client/taxprofiles.rb +42 -42
  56. data/lib/avatax/client/taxrules.rb +56 -50
  57. data/lib/avatax/client/transactions.rb +174 -153
  58. data/lib/avatax/client/upcs.rb +54 -48
  59. data/lib/avatax/client/userdefinedfields.rb +52 -0
  60. data/lib/avatax/client/users.rb +70 -62
  61. data/lib/avatax/client/utilities.rb +30 -27
  62. data/lib/avatax/client.rb +37 -35
  63. data/lib/avatax/configuration.rb +76 -76
  64. data/lib/avatax/connection.rb +49 -49
  65. data/lib/avatax/request.rb +51 -42
  66. data/lib/avatax/version.rb +3 -3
  67. data/lib/avatax.rb +26 -26
  68. data/spec/avatax/client/accounts_spec.rb +13 -13
  69. data/spec/avatax/client/transactions_spec.rb +80 -80
  70. data/spec/avatax/request_spec.rb +25 -25
  71. data/spec/avatax_spec.rb +45 -45
  72. data/spec/credentials.yaml.example +4 -4
  73. data/spec/fixtures/accounts.json +15 -15
  74. data/spec/spec_helper.rb +27 -27
  75. metadata +9 -13
@@ -1,10 +1,10 @@
1
- module AvaTax
2
- class Client
3
- module DistanceThresholds
4
-
5
-
6
- # Create one or more DistanceThreshold objects
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module DistanceThresholds
4
+
5
+
6
+ # Create one or more DistanceThreshold objects
7
+ #
8
8
  # Create one or more DistanceThreshold objects for this company.
9
9
  #
10
10
  # A company-distance-threshold model indicates the distance between a company
@@ -13,15 +13,16 @@ 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, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
17
+ # Swagger Name: AvaTaxClient
17
18
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
18
19
  # @param model [CompanyDistanceThresholdModel[]] The DistanceThreshold object or objects you wish to create.
19
- # @return [CompanyDistanceThresholdModel[]]
20
- def create_distance_threshold(companyId, model) path = "/api/v2/companies/#{companyId}/distancethresholds"
21
- post(path, model) end
22
-
23
- # Delete a single DistanceThreshold object
24
- #
20
+ # @return [CompanyDistanceThresholdModel[]]
21
+ def create_distance_threshold(companyId, model) path = "/api/v2/companies/#{companyId}/distancethresholds"
22
+ post(path, model, {}, "22.2.0") end
23
+
24
+ # Delete a single DistanceThreshold object
25
+ #
25
26
  # Marks the DistanceThreshold object identified by this URL as deleted.
26
27
  #
27
28
  # A company-distance-threshold model indicates the distance between a company
@@ -30,15 +31,16 @@ module AvaTax
30
31
  #
31
32
  # ### Security Policies
32
33
  #
33
- # * 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, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
35
+ # Swagger Name: AvaTaxClient
34
36
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold
35
37
  # @param id [Integer] The unique ID number of the DistanceThreshold object you wish to delete.
36
- # @return [ErrorDetail[]]
37
- def delete_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
38
- delete(path) end
39
-
40
- # Retrieve a single DistanceThreshold
41
- #
38
+ # @return [ErrorDetail[]]
39
+ def delete_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
40
+ delete(path, {}, "22.2.0") end
41
+
42
+ # Retrieve a single DistanceThreshold
43
+ #
42
44
  # Retrieves a single DistanceThreshold object defined by this URL.
43
45
  #
44
46
  # A company-distance-threshold model indicates the distance between a company
@@ -47,15 +49,16 @@ module AvaTax
47
49
  #
48
50
  # ### Security Policies
49
51
  #
50
- # * 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, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
53
+ # Swagger Name: AvaTaxClient
51
54
  # @param companyId [Integer] The ID of the company that owns this DistanceThreshold object
52
55
  # @param id [Integer] The unique ID number referring to this DistanceThreshold object
53
- # @return [Object]
54
- def get_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
55
- get(path) end
56
-
57
- # Retrieve all DistanceThresholds for this company.
58
- #
56
+ # @return [Object]
57
+ def get_distance_threshold(companyId, id) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
58
+ get(path, {}, "22.2.0") end
59
+
60
+ # Retrieve all DistanceThresholds for this company.
61
+ #
59
62
  # Lists all DistanceThreshold objects that belong to this company.
60
63
  #
61
64
  # A company-distance-threshold model indicates the distance between a company
@@ -64,19 +67,20 @@ module AvaTax
64
67
  #
65
68
  # ### Security Policies
66
69
  #
67
- # * 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, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
71
+ # Swagger Name: AvaTaxClient
68
72
  # @param companyId [Integer] The ID of the company whose DistanceThreshold objects you wish to list.
69
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/).
70
74
  # @param include [String] A comma separated list of additional data to retrieve.
71
75
  # @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.
72
76
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
73
77
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
74
- # @return [FetchResult]
75
- def list_distance_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/distancethresholds"
76
- get(path, options) end
77
-
78
- # Retrieve all DistanceThreshold objects
79
- #
78
+ # @return [FetchResult]
79
+ def list_distance_thresholds(companyId, options={}) path = "/api/v2/companies/#{companyId}/distancethresholds"
80
+ get(path, options, "22.2.0") end
81
+
82
+ # Retrieve all DistanceThreshold objects
83
+ #
80
84
  # Lists all DistanceThreshold objects that belong to this account.
81
85
  #
82
86
  # A company-distance-threshold model indicates the distance between a company
@@ -88,18 +92,19 @@ module AvaTax
88
92
  #
89
93
  # ### Security Policies
90
94
  #
91
- # * 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, CompanyAdmin, CompanyUser, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
96
+ # Swagger Name: AvaTaxClient
92
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/).
93
98
  # @param include [String] A comma separated list of additional data to retrieve.
94
99
  # @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.
95
100
  # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
96
101
  # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
97
- # @return [FetchResult]
98
- def query_distance_thresholds(options={}) path = "/api/v2/distancethresholds"
99
- get(path, options) end
100
-
101
- # Update a DistanceThreshold object
102
- #
102
+ # @return [FetchResult]
103
+ def query_distance_thresholds(options={}) path = "/api/v2/distancethresholds"
104
+ get(path, options, "22.2.0") end
105
+
106
+ # Update a DistanceThreshold object
107
+ #
103
108
  # Replace the existing DistanceThreshold object at this URL with an updated object.
104
109
  #
105
110
  # A company-distance-threshold model indicates the distance between a company
@@ -111,13 +116,14 @@ module AvaTax
111
116
  #
112
117
  # ### Security Policies
113
118
  #
114
- # * 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, CompanyAdmin, CSPAdmin, CSPTester, SiteAdmin, SSTAdmin, SystemAdmin, TechnicalSupportAdmin.
120
+ # Swagger Name: AvaTaxClient
115
121
  # @param companyId [Integer] The unique ID number of the company that owns this DistanceThreshold object.
116
122
  # @param id [Integer] The unique ID number of the DistanceThreshold object to replace.
117
123
  # @param model [Object] The new DistanceThreshold object to store.
118
- # @return [Object]
119
- def update_distance_threshold(companyId, id, model) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
120
- put(path, model) end
121
- end
122
- end
124
+ # @return [Object]
125
+ def update_distance_threshold(companyId, id, model) path = "/api/v2/companies/#{companyId}/distancethresholds/#{id}"
126
+ put(path, model, {}, "22.2.0") end
127
+ end
128
+ end
123
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
@@ -5,33 +5,35 @@ module AvaTax
5
5
 
6
6
  # Create a new eCommerce token.
7
7
  #
8
- # Creates a new eCommerce token.
9
- #
10
- # This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
11
- #
12
- # ### Security Policies
13
- #
8
+ # Creates a new eCommerce token.
9
+ #
10
+ # This API is used to create a new eCommerce token. An eCommerce token is required in order to launch the CertCapture eCommerce plugin. Create a token for each of your CertCapture customers.
11
+ #
12
+ # ### Security Policies
13
+ #
14
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.
15
- # @param companyId [Integer] The company ID that will be issued this certificate.
16
- # @param model [Object]
15
+ # Swagger Name: AvaTaxClient
16
+ # @param companyId [Integer] The company ID that will be issued this certificate.
17
+ # @param model [Object]
17
18
  # @return [Object]
18
19
  def create_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
19
- post(path, model) end
20
+ post(path, model, {}, "22.2.0") end
20
21
 
21
22
  # Refresh an eCommerce token.
22
23
  #
23
- # Refresh an eCommerce token.
24
- #
25
- # CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.
26
- #
27
- # ### Security Policies
28
- #
24
+ # Refresh an eCommerce token.
25
+ #
26
+ # CertCapture eCommerce tokens expire after one hour. This API is used to refresh an eCommerce token that is about to expire. This API can only be used with active tokens. If your token has expired, you must generate a new one.
27
+ #
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
- # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
31
- # @param model [Object]
31
+ # Swagger Name: AvaTaxClient
32
+ # @param companyId [Integer] The company ID that the refreshed certificate belongs to.
33
+ # @param model [Object]
32
34
  # @return [FetchResult]
33
35
  def refresh_e_commerce_token(companyId, model) path = "/api/v2/companies/#{companyId}/ecommercetokens"
34
- put(path, model) end
36
+ put(path, model, {}, "22.2.0") end
35
37
  end
36
38
  end
37
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
@@ -1,36 +1,60 @@
1
- module AvaTax
2
- class Client
3
- module FilingCalendars
4
-
5
-
6
- # Add or Edit options
7
- #
1
+ module AvaTax
2
+ class Client
3
+ module FilingCalendars
4
+
5
+
6
+ # Add or Edit options
7
+ #
8
8
  # Returns a list of options for adding tax forms for the company and tax form code specified.
9
9
  # Returns edit options when modifying a filing calendar.
10
10
  # This API is available by invitation only.
11
11
  #
12
12
  # ### Security Policies
13
13
  #
14
- # * This API depends on the following active services:*Returns* (at least one of): Mrs, MRSComplianceManager, AvaTaxCsp.*Firm Managed* (for accounts managed by a firm): ARA, ARAManaged.
14
+ # * This API requires openId bearer token for authentication
15
+ # * 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.
16
+ # Swagger Name: AvaTaxClient
15
17
  # @param companyId [Integer] The unique ID of the company that owns the filing calendar object
16
18
  # @param model [Object] Cycle Safe Options Request
17
- # @return [Object]
18
- def cycle_safe_options(companyId, model) path = "/api/v2/companies/#{companyId}/filingcalendars/edit/cycleSafeOptions"
19
- post(path, model) end
20
-
21
- # Delete a company return setting
22
- #
19
+ # @return [Object]
20
+ def cycle_safe_options(companyId, model) path = "/api/v2/companies/#{companyId}/filingcalendars/edit/cycleSafeOptions"
21
+ post(path, model, {}, "22.2.0") end
22
+
23
+ # Delete a company return setting
24
+ #
23
25
  # This API is available by invitation only and only available for users with Compliance access
24
26
  #
25
27
  # ### Security Policies
26
28
  #
27
- # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
29
+ # * This API requires openId bearer token for authentication
30
+ # * This API requires one of the following user roles: AccountAdmin, CompanyAdmin, Compliance Root User, ComplianceAdmin, ComplianceUser, CSPTester, FirmAdmin, FirmUser, SSTAdmin, TechnicalSupportAdmin, TechnicalSupportUser, TreasuryAdmin, TreasuryUser.
31
+ # Swagger Name: AvaTaxClient
28
32
  # @param companyId [Integer] The unique ID of the company
29
33
  # @param filingCalendarId [Integer] The unique ID of the filing calendar that will remove setting
30
34
  # @param companyReturnSettingId [Integer] The unique ID of the company return setting that will be deleted from the filing calendar
31
- # @return [CompanyReturnSettingModel[]]
32
- def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId) path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
33
- delete(path) end
34
- end
35
- end
35
+ # @return [CompanyReturnSettingModel[]]
36
+ def delete_company_return_settings(companyId, filingCalendarId, companyReturnSettingId) path = "/api/v2/companies/#{companyId}/filingcalendars/#{filingCalendarId}/setting/#{companyReturnSettingId}"
37
+ delete(path, {}, "22.2.0") end
38
+
39
+ # Retrieve all legacy filing calendars for this company
40
+ #
41
+ # This API is available by invitation only.
42
+ #
43
+ # ### Security Policies
44
+ #
45
+ # * 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.
46
+ # * 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.
47
+ # Swagger Name: AvaTaxClient
48
+ # @param companyId [Integer] The ID of the company that owns these batches
49
+ # @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:* taxTypes, taxAuthorityId, taxAuthorityName, taxAuthorityType, settings
50
+ # @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.
51
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with `$top` to provide pagination for large datasets.
52
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
53
+ # @param returnCountry [String] A comma separated list of countries
54
+ # @param returnRegion [String] A comma separated list of regions
55
+ # @return [FetchResult]
56
+ def legacy_filing_calendars(companyId, options={}) path = "/api/v2/companies/#{companyId}/filingcalendars/Legacy"
57
+ get(path, options, "22.2.0") end
58
+ end
59
+ end
36
60
  end