avatax 17.5.0 → 17.6.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.
@@ -4,17 +4,15 @@ module AvaTax
4
4
 
5
5
 
6
6
  # Request a new Avalara account
7
- #
7
+ #
8
8
  # This API is for use by partner onboarding services customers only.
9
9
  # Calling this API creates an account with the specified product subscriptions, but does not configure billing.
10
10
  # The customer will receive information from Avalara about how to configure billing for their account.
11
11
  # You should call this API when a customer has requested to begin using Avalara services.
12
- #
13
- # @param NewAccountRequestModel model Information about the account you wish to create and the selected product offerings.
14
- # @return NewAccountModel
12
+ # @param model [Object] Information about the account you wish to create and the selected product offerings.
13
+ # @return [Object]
15
14
  def request_new_account(model)
16
15
  path = "/api/v2/accounts/request"
17
-
18
16
  post(path, model)
19
17
  end
20
18
 
@@ -4,18 +4,16 @@ module AvaTax
4
4
 
5
5
 
6
6
  # Point of sale data file generation
7
- #
7
+ #
8
8
  # Builds a point-of-sale data file containing tax rates and rules for items and locations that can be used
9
9
  # to correctly calculate tax in the event a point-of-sale device is not able to reach AvaTax.
10
10
  # This data file can be customized for specific partner devices and usage conditions.
11
11
  # The result of this API is the file you requested in the format you requested using the 'responseType' field.
12
12
  # This API builds the file on demand, and is limited to files with no more than 7500 scenarios.
13
- #
14
- # @param PointOfSaleDataRequestModel model Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
15
- # @return FileResult
13
+ # @param model [Object] Parameters about the desired file format and report format, specifying which company, locations and TaxCodes to include.
14
+ # @return [Object]
16
15
  def build_point_of_sale_data_file(model)
17
16
  path = "/api/v2/pointofsaledata/build"
18
-
19
17
  post(path, model)
20
18
  end
21
19
 
@@ -4,210 +4,188 @@ module AvaTax
4
4
 
5
5
 
6
6
  # Change Password
7
- #
7
+ #
8
8
  # # For Registrar Use Only
9
9
  # This API is for use by Avalara Registrar administrative users only.
10
- #
10
+ #
11
11
  # Allows a user to change their password via the API.
12
12
  # This API only allows the currently authenticated user to change their password; it cannot be used to apply to a
13
13
  # different user than the one authenticating the current API call.
14
- #
15
- # @param PasswordChangeModel model An object containing your current password and the new password.
16
- # @return string
14
+ # @param model [Object] An object containing your current password and the new password.
15
+ # @return [String]
17
16
  def change_password(model)
18
17
  path = "/api/v2/passwords"
19
-
20
18
  put(path, model)
21
19
  end
22
20
 
23
21
 
24
22
  # Create a new account
25
- #
23
+ #
26
24
  # # For Registrar Use Only
27
25
  # This API is for use by Avalara Registrar administrative users only.
28
- #
29
- # Create a single new account object.
26
+ #
27
+ # Create a single new account object.
30
28
  # When creating an account object you may attach subscriptions and users as part of the 'Create' call.
31
- #
32
- # @param AccountModel model The account you wish to create.
33
- # @return AccountModel
29
+ # @param model [Object] The account you wish to create.
30
+ # @return [Object]
34
31
  def create_account(model)
35
32
  path = "/api/v2/accounts"
36
-
37
33
  post(path, model)
38
34
  end
39
35
 
40
36
 
41
37
  # Create a new subscription
42
- #
38
+ #
43
39
  # # For Registrar Use Only
44
40
  # This API is for use by Avalara Registrar administrative users only.
45
- #
41
+ #
46
42
  # Create one or more new subscription objects attached to this account.
47
43
  # A 'subscription' indicates a licensed subscription to a named Avalara service.
48
44
  # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
49
- #
50
- # @param int accountId The ID of the account that owns this subscription.
51
- # @param SubscriptionModel[] model The subscription you wish to create.
52
- # @return SubscriptionModel[]
45
+ # @param accountId [Integer] The ID of the account that owns this subscription.
46
+ # @param model [object[]] The subscription you wish to create.
47
+ # @return [object[]]
53
48
  def create_subscriptions(accountId, model)
54
49
  path = "/api/v2/accounts/#{accountId}/subscriptions"
55
-
56
50
  post(path, model)
57
51
  end
58
52
 
59
53
 
60
54
  # Create new users
61
- #
55
+ #
62
56
  # # For Registrar Use Only
63
57
  # This API is for use by Avalara Registrar administrative users only.
64
- #
58
+ #
65
59
  # Create one or more new user objects attached to this account.
66
60
  # A user represents one person with access privileges to make API calls and work with a specific account.
67
- #
68
- # @param int accountId The unique ID number of the account where these users will be created.
69
- # @param UserModel[] model The user or array of users you wish to create.
70
- # @return UserModel[]
61
+ # @param accountId [Integer] The unique ID number of the account where these users will be created.
62
+ # @param model [object[]] The user or array of users you wish to create.
63
+ # @return [object[]]
71
64
  def create_users(accountId, model)
72
65
  path = "/api/v2/accounts/#{accountId}/users"
73
-
74
66
  post(path, model)
75
67
  end
76
68
 
77
69
 
78
70
  # Delete a single account
79
- #
71
+ #
80
72
  # # For Registrar Use Only
81
73
  # This API is for use by Avalara Registrar administrative users only.
82
- #
74
+ #
83
75
  # Delete an account.
84
76
  # Deleting an account will delete all companies and all account level users attached to this account.
85
- #
86
- # @param int id The ID of the account you wish to delete.
87
- # @return ErrorDetail[]
77
+ # @param id [Integer] The ID of the account you wish to delete.
78
+ # @return [object[]]
88
79
  def delete_account(id)
89
80
  path = "/api/v2/accounts/#{id}"
90
-
91
81
  delete(path)
92
82
  end
93
83
 
94
84
 
95
85
  # Delete a single subscription
96
- #
86
+ #
97
87
  # # For Registrar Use Only
98
88
  # This API is for use by Avalara Registrar administrative users only.
99
- #
89
+ #
100
90
  # Mark the existing account identified by this URL as deleted.
101
- #
102
- # @param int accountId The ID of the account that owns this subscription.
103
- # @param int id The ID of the subscription you wish to delete.
104
- # @return ErrorDetail[]
91
+ # @param accountId [Integer] The ID of the account that owns this subscription.
92
+ # @param id [Integer] The ID of the subscription you wish to delete.
93
+ # @return [object[]]
105
94
  def delete_subscription(accountId, id)
106
95
  path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
107
-
108
96
  delete(path)
109
97
  end
110
98
 
111
99
 
112
100
  # Delete a single user
113
- #
101
+ #
114
102
  # # For Registrar Use Only
115
103
  # This API is for use by Avalara Registrar administrative users only.
116
- #
104
+ #
117
105
  # Mark the user object identified by this URL as deleted.
118
- #
119
- # @param int id The ID of the user you wish to delete.
120
- # @param int accountId The accountID of the user you wish to delete.
121
- # @return ErrorDetail[]
106
+ # @param id [Integer] The ID of the user you wish to delete.
107
+ # @param accountId [Integer] The accountID of the user you wish to delete.
108
+ # @return [object[]]
122
109
  def delete_user(id, accountId)
123
110
  path = "/api/v2/accounts/#{accountId}/users/#{id}"
124
-
125
111
  delete(path)
126
112
  end
127
113
 
128
114
 
129
115
  # Retrieve all accounts
130
- #
116
+ #
131
117
  # # For Registrar Use Only
132
118
  # This API is for use by Avalara Registrar administrative users only.
133
- #
119
+ #
134
120
  # Get multiple account objects.
135
121
  # 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/) .
136
122
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
137
123
  # 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:
138
- #
124
+ #
139
125
  # * Subscriptions
140
126
  # * Users
141
- #
127
+ #
142
128
  # For more information about filtering in REST, please see the documentation at http://developer.avalara.com/avatax/filtering-in-rest/ .
143
- #
144
- # @param string include A comma separated list of child objects to return underneath the primary object.
145
- # @param string filter 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/) .
146
- # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
147
- # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
148
- # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
149
- # @return FetchResult
129
+ # @param include [String] A comma separated list of child objects to return underneath the primary object.
130
+ # @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/) .
131
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
132
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
133
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
134
+ # @return [FetchResult]
150
135
  def query_accounts(options={})
151
136
  path = "/api/v2/accounts"
152
-
153
137
  get(path, options)
154
138
  end
155
139
 
156
140
 
157
141
  # Reset a user's password programmatically
158
- #
142
+ #
159
143
  # # For Registrar Use Only
160
144
  # This API is for use by Avalara Registrar administrative users only.
161
- #
145
+ #
162
146
  # Allows a system admin to reset the password for a specific user via the API.
163
147
  # This API is only available for Avalara Registrar Admins, and can be used to reset the password of any
164
148
  # user based on internal Avalara business processes.
165
- #
166
- # @param int userId The unique ID of the user whose password will be changed
167
- # @param SetPasswordModel model The new password for this user
168
- # @return string
149
+ # @param userId [Integer] The unique ID of the user whose password will be changed
150
+ # @param model [Object] The new password for this user
151
+ # @return [String]
169
152
  def reset_password(userId, model)
170
153
  path = "/api/v2/passwords/#{userId}/reset"
171
-
172
154
  post(path, model)
173
155
  end
174
156
 
175
157
 
176
158
  # Update a single account
177
- #
159
+ #
178
160
  # # For Registrar Use Only
179
161
  # This API is for use by Avalara Registrar administrative users only.
180
- #
162
+ #
181
163
  # Replace an existing account object with an updated account object.
182
- #
183
- # @param int id The ID of the account you wish to update.
184
- # @param AccountModel model The account object you wish to update.
185
- # @return AccountModel
164
+ # @param id [Integer] The ID of the account you wish to update.
165
+ # @param model [Object] The account object you wish to update.
166
+ # @return [Object]
186
167
  def update_account(id, model)
187
168
  path = "/api/v2/accounts/#{id}"
188
-
189
169
  put(path, model)
190
170
  end
191
171
 
192
172
 
193
173
  # Update a single subscription
194
- #
174
+ #
195
175
  # # For Registrar Use Only
196
176
  # This API is for use by Avalara Registrar administrative users only.
197
- #
177
+ #
198
178
  # Replace the existing subscription object at this URL with an updated object.
199
179
  # A 'subscription' indicates a licensed subscription to a named Avalara service.
200
180
  # To request or remove subscriptions, please contact Avalara sales or your customer account manager.
201
- # All data from the existing object will be replaced with data in the object you PUT.
181
+ # All data from the existing object will be replaced with data in the object you PUT.
202
182
  # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
203
- #
204
- # @param int accountId The ID of the account that this subscription belongs to.
205
- # @param int id The ID of the subscription you wish to update
206
- # @param SubscriptionModel model The subscription you wish to update.
207
- # @return SubscriptionModel
183
+ # @param accountId [Integer] The ID of the account that this subscription belongs to.
184
+ # @param id [Integer] The ID of the subscription you wish to update
185
+ # @param model [Object] The subscription you wish to update.
186
+ # @return [Object]
208
187
  def update_subscription(accountId, id, model)
209
188
  path = "/api/v2/accounts/#{accountId}/subscriptions/#{id}"
210
-
211
189
  put(path, model)
212
190
  end
213
191
 
@@ -4,131 +4,119 @@ module AvaTax
4
4
 
5
5
 
6
6
  # Create a new setting
7
- #
7
+ #
8
8
  # Create one or more new setting objects attached to this company.
9
9
  # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
10
10
  # not defined or managed by Avalara.
11
- # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
11
+ # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
12
12
  # 'value' data fields.
13
13
  # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
14
14
  # the 'set' data field.
15
- #
16
- # @param int companyId The ID of the company that owns this setting.
17
- # @param SettingModel[] model The setting you wish to create.
18
- # @return SettingModel[]
15
+ # @param companyId [Integer] The ID of the company that owns this setting.
16
+ # @param model [object[]] The setting you wish to create.
17
+ # @return [object[]]
19
18
  def create_settings(companyId, model)
20
19
  path = "/api/v2/companies/#{companyId}/settings"
21
-
22
20
  post(path, model)
23
21
  end
24
22
 
25
23
 
26
24
  # Delete a single setting
27
- #
25
+ #
28
26
  # Mark the setting object at this URL as deleted.
29
- #
30
- # @param int companyId The ID of the company that owns this setting.
31
- # @param int id The ID of the setting you wish to delete.
32
- # @return ErrorDetail[]
27
+ # @param companyId [Integer] The ID of the company that owns this setting.
28
+ # @param id [Integer] The ID of the setting you wish to delete.
29
+ # @return [object[]]
33
30
  def delete_setting(companyId, id)
34
31
  path = "/api/v2/companies/#{companyId}/settings/#{id}"
35
-
36
32
  delete(path)
37
33
  end
38
34
 
39
35
 
40
36
  # Retrieve a single setting
41
- #
37
+ #
42
38
  # Get a single setting object by its unique ID.
43
39
  # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
44
40
  # not defined or managed by Avalara.
45
- # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
41
+ # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
46
42
  # 'value' data fields.
47
43
  # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
48
44
  # the 'set' data field.
49
- #
50
- # @param int companyId The ID of the company that owns this setting
51
- # @param int id The primary key of this setting
52
- # @return SettingModel
45
+ # @param companyId [Integer] The ID of the company that owns this setting
46
+ # @param id [Integer] The primary key of this setting
47
+ # @return [Object]
53
48
  def get_setting(companyId, id)
54
49
  path = "/api/v2/companies/#{companyId}/settings/#{id}"
55
-
56
50
  get(path)
57
51
  end
58
52
 
59
53
 
60
54
  # Retrieve all settings for this company
61
- #
55
+ #
62
56
  # List all setting objects attached to this company.
63
57
  # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
64
58
  # not defined or managed by Avalara.
65
- # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
59
+ # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
66
60
  # 'value' data fields.
67
61
  # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
68
62
  # the 'set' data field.
69
- #
63
+ #
70
64
  # 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/) .
71
65
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
72
- #
73
- # @param int companyId The ID of the company that owns these settings
74
- # @param string filter 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/) .
75
- # @param string include A comma separated list of child objects to return underneath the primary object.
76
- # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
77
- # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
78
- # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
79
- # @return FetchResult
66
+ # @param companyId [Integer] The ID of the company that owns these settings
67
+ # @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/) .
68
+ # @param include [String] A comma separated list of child objects to return underneath the primary object.
69
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
70
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
71
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
72
+ # @return [FetchResult]
80
73
  def list_settings_by_company(companyId, options={})
81
74
  path = "/api/v2/companies/#{companyId}/settings"
82
-
83
75
  get(path, options)
84
76
  end
85
77
 
86
78
 
87
79
  # Retrieve all settings
88
- #
80
+ #
89
81
  # Get multiple setting objects across all companies.
90
82
  # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
91
83
  # not defined or managed by Avalara.
92
- # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
84
+ # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
93
85
  # 'value' data fields.
94
86
  # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
95
87
  # the 'set' data field.
96
- #
88
+ #
97
89
  # 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/) .
98
90
  # Paginate your results using the `$top`, `$skip`, and `$orderby` parameters.
99
- #
100
- # @param string filter 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/) .
101
- # @param string include A comma separated list of child objects to return underneath the primary object.
102
- # @param int top If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
103
- # @param int skip If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
104
- # @param string orderBy A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
105
- # @return FetchResult
91
+ # @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/) .
92
+ # @param include [String] A comma separated list of child objects to return underneath the primary object.
93
+ # @param top [Integer] If nonzero, return no more than this number of results. Used with $skip to provide pagination for large datasets.
94
+ # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with $top to provide pagination for large datasets.
95
+ # @param orderBy [String] A comma separated list of sort statements in the format `(fieldname) [ASC|DESC]`, for example `id ASC`.
96
+ # @return [FetchResult]
106
97
  def query_settings(options={})
107
98
  path = "/api/v2/settings"
108
-
109
99
  get(path, options)
110
100
  end
111
101
 
112
102
 
113
103
  # Update a single setting
114
- #
104
+ #
115
105
  # Replace the existing setting object at this URL with an updated object.
116
106
  # A 'setting' is a piece of user-defined data that can be attached to a company, and it provides you the ability to store information
117
107
  # not defined or managed by Avalara.
118
- # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
108
+ # You may create, update, and delete your own settings objects as required, and there is no mandatory data format for the 'name' and
119
109
  # 'value' data fields.
120
110
  # To ensure correct operation of other programs or connectors, please create a new GUID for your application and use that value for
121
111
  # the 'set' data field.
122
- # All data from the existing object will be replaced with data in the object you PUT.
112
+ # All data from the existing object will be replaced with data in the object you PUT.
123
113
  # To set a field's value to null, you may either set its value to null or omit that field from the object you post.
124
- #
125
- # @param int companyId The ID of the company that this setting belongs to.
126
- # @param int id The ID of the setting you wish to update
127
- # @param SettingModel model The setting you wish to update.
128
- # @return SettingModel
114
+ # @param companyId [Integer] The ID of the company that this setting belongs to.
115
+ # @param id [Integer] The ID of the setting you wish to update
116
+ # @param model [Object] The setting you wish to update.
117
+ # @return [Object]
129
118
  def update_setting(companyId, id, model)
130
119
  path = "/api/v2/companies/#{companyId}/settings/#{id}"
131
-
132
120
  put(path, model)
133
121
  end
134
122