avalara_sdk 25.6.0 → 25.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 (116) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +17 -3
  3. data/docs/A1099/V2/BulkUpsert1099FormsRequest.md +3 -1
  4. data/docs/A1099/V2/CompaniesW9Api.md +45 -31
  5. data/docs/A1099/V2/CoveredIndividualReference.md +58 -0
  6. data/docs/A1099/V2/CoveredIndividualRequest.md +54 -0
  7. data/docs/A1099/V2/Form1095B.md +86 -0
  8. data/docs/A1099/V2/Form1095BList.md +20 -0
  9. data/docs/A1099/V2/Form1095BListItem.md +74 -0
  10. data/docs/A1099/V2/Form1095BRequest.md +76 -0
  11. data/docs/A1099/V2/Form1099Base.md +8 -8
  12. data/docs/A1099/V2/Form1099DivListItem.md +11 -11
  13. data/docs/A1099/V2/Form1099DivRequest.md +11 -17
  14. data/docs/A1099/V2/Form1099DivResponse.md +88 -0
  15. data/docs/A1099/V2/Form1099K.md +8 -8
  16. data/docs/A1099/V2/Form1099KListItem.md +11 -11
  17. data/docs/A1099/V2/Form1099KRequest.md +11 -17
  18. data/docs/A1099/V2/Form1099List.md +1 -1
  19. data/docs/A1099/V2/Form1099ListDataInner.md +32 -0
  20. data/docs/A1099/V2/Form1099Misc.md +8 -8
  21. data/docs/A1099/V2/Form1099MiscListItem.md +11 -11
  22. data/docs/A1099/V2/Form1099MiscRequest.md +11 -17
  23. data/docs/A1099/V2/Form1099MiscResponse.md +120 -0
  24. data/docs/A1099/V2/Form1099Nec.md +8 -8
  25. data/docs/A1099/V2/Form1099NecListItem.md +11 -11
  26. data/docs/A1099/V2/Form1099NecRequest.md +11 -17
  27. data/docs/A1099/V2/Form1099NecResponse.md +96 -0
  28. data/docs/A1099/V2/Form1099R.md +8 -8
  29. data/docs/A1099/V2/Form1099RListItem.md +11 -11
  30. data/docs/A1099/V2/Form1099RRequest.md +11 -17
  31. data/docs/A1099/V2/FormRequestBase.md +9 -13
  32. data/docs/A1099/V2/FormRequestCsvBase.md +66 -0
  33. data/docs/A1099/V2/FormResponseBase.md +43 -9
  34. data/docs/A1099/V2/FormSingleRequestBase.md +11 -15
  35. data/docs/A1099/V2/Forms1099Api.md +75 -57
  36. data/docs/A1099/V2/FormsW9Api.md +63 -123
  37. data/docs/A1099/V2/Get1099Form200Response.md +55 -0
  38. data/docs/A1099/V2/IncludedBase.md +20 -0
  39. data/docs/A1099/V2/Issuers1099Api.md +45 -31
  40. data/docs/A1099/V2/Jobs1099Api.md +10 -6
  41. data/docs/A1099/V2/StateAndLocalWithholdingResponse.md +32 -0
  42. data/docs/A1099/V2/StateEfileStatusDetail.md +1 -1
  43. data/docs/A1099/V2/StateEfileStatusDetailApp.md +22 -0
  44. data/docs/A1099/V2/StatusDetail.md +20 -0
  45. data/docs/A1099/V2/Update1099Form200Response.md +53 -0
  46. data/docs/A1099/V2/ValidationErrorApp.md +20 -0
  47. data/docs/EInvoicing/V1/DataInputFieldsApi.md +4 -4
  48. data/docs/EInvoicing/V1/DocumentsApi.md +2 -2
  49. data/docs/EInvoicing/V1/MandatesApi.md +4 -4
  50. data/docs/EInvoicing/V1/SubscriptionsApi.md +4 -4
  51. data/docs/EInvoicing/V1/TradingPartnersApi.md +4 -4
  52. data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +103 -43
  53. data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +171 -87
  54. data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +135 -176
  55. data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +103 -43
  56. data/lib/avalara_sdk/api/A1099/V2/jobs1099_api.rb +19 -7
  57. data/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +6 -6
  58. data/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +4 -4
  59. data/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +1 -1
  60. data/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +6 -6
  61. data/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +6 -6
  62. data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +7 -7
  63. data/lib/avalara_sdk/models/A1099/V2/bulk_upsert1099_forms_request.rb +1 -0
  64. data/lib/avalara_sdk/models/A1099/V2/covered_individual_reference.rb +403 -0
  65. data/lib/avalara_sdk/models/A1099/V2/covered_individual_request.rb +378 -0
  66. data/lib/avalara_sdk/models/A1099/V2/form1095_b.rb +572 -0
  67. data/lib/avalara_sdk/models/A1099/V2/form1095_b_list.rb +238 -0
  68. data/lib/avalara_sdk/models/A1099/V2/form1095_b_list_item.rb +538 -0
  69. data/lib/avalara_sdk/models/A1099/V2/form1095_b_request.rb +559 -0
  70. data/lib/avalara_sdk/models/A1099/V2/form1099_base.rb +29 -29
  71. data/lib/avalara_sdk/models/A1099/V2/form1099_div_list_item.rb +78 -36
  72. data/lib/avalara_sdk/models/A1099/V2/form1099_div_request.rb +80 -53
  73. data/lib/avalara_sdk/models/A1099/V2/form1099_div_response.rb +600 -0
  74. data/lib/avalara_sdk/models/A1099/V2/form1099_k.rb +29 -29
  75. data/lib/avalara_sdk/models/A1099/V2/form1099_k_list_item.rb +56 -37
  76. data/lib/avalara_sdk/models/A1099/V2/form1099_k_request.rb +80 -54
  77. data/lib/avalara_sdk/models/A1099/V2/form1099_list.rb +1 -1
  78. data/lib/avalara_sdk/models/A1099/V2/form1099_list_data_inner.rb +20 -68
  79. data/lib/avalara_sdk/models/A1099/V2/form1099_misc.rb +29 -29
  80. data/lib/avalara_sdk/models/A1099/V2/form1099_misc_list_item.rb +78 -36
  81. data/lib/avalara_sdk/models/A1099/V2/form1099_misc_request.rb +80 -53
  82. data/lib/avalara_sdk/models/A1099/V2/form1099_misc_response.rb +744 -0
  83. data/lib/avalara_sdk/models/A1099/V2/form1099_nec.rb +29 -29
  84. data/lib/avalara_sdk/models/A1099/V2/form1099_nec_list_item.rb +78 -36
  85. data/lib/avalara_sdk/models/A1099/V2/form1099_nec_request.rb +80 -53
  86. data/lib/avalara_sdk/models/A1099/V2/form1099_nec_response.rb +636 -0
  87. data/lib/avalara_sdk/models/A1099/V2/form1099_r.rb +29 -29
  88. data/lib/avalara_sdk/models/A1099/V2/form1099_r_list_item.rb +56 -36
  89. data/lib/avalara_sdk/models/A1099/V2/form1099_r_request.rb +80 -53
  90. data/lib/avalara_sdk/models/A1099/V2/form_request_base.rb +68 -44
  91. data/lib/avalara_sdk/models/A1099/V2/form_request_csv_base.rb +475 -0
  92. data/lib/avalara_sdk/models/A1099/V2/form_response_base.rb +252 -31
  93. data/lib/avalara_sdk/models/A1099/V2/form_single_request_base.rb +80 -44
  94. data/lib/avalara_sdk/models/A1099/V2/get1099_form200_response.rb +104 -0
  95. data/lib/avalara_sdk/models/A1099/V2/included_base.rb +219 -0
  96. data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_request.rb +1 -0
  97. data/lib/avalara_sdk/models/A1099/V2/state_and_local_withholding_response.rb +274 -0
  98. data/lib/avalara_sdk/models/A1099/V2/state_efile_status_detail_app.rb +231 -0
  99. data/lib/avalara_sdk/models/A1099/V2/status_detail.rb +221 -0
  100. data/lib/avalara_sdk/models/A1099/V2/update1099_form200_response.rb +103 -0
  101. data/lib/avalara_sdk/models/A1099/V2/validation_error_app.rb +229 -0
  102. data/lib/avalara_sdk/version.rb +1 -1
  103. data/lib/avalara_sdk.rb +17 -0
  104. data/spec/integration/a1099_spec.rb +12 -12
  105. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
  106. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +5 -5
  107. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/gem_make.out +5 -5
  108. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/gem_make.out +5 -5
  109. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/gem_make.out +5 -5
  110. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/gem_make.out +5 -5
  111. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/gem_make.out +5 -5
  112. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/gem_make.out +5 -5
  113. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +5 -5
  114. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
  115. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/gem_make.out +5 -5
  116. metadata +36 -2
@@ -7,7 +7,6 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
7
7
  | [**create_w9_form**](FormsW9Api.md#create_w9_form) | **POST** /w9/forms | Create a W9/W4/W8 form |
8
8
  | [**delete_w9_form**](FormsW9Api.md#delete_w9_form) | **DELETE** /w9/forms/{id} | Delete a form |
9
9
  | [**get_w9_form**](FormsW9Api.md#get_w9_form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form |
10
- | [**get_w9_form_request**](FormsW9Api.md#get_w9_form_request) | **GET** /w9/forms/requests/{formRequestId} | Retrieve a form request |
11
10
  | [**list_w9_forms**](FormsW9Api.md#list_w9_forms) | **GET** /w9/forms | List W9/W4/W8 forms. |
12
11
  | [**send_w9_form_email**](FormsW9Api.md#send_w9_form_email) | **POST** /w9/forms/{id}/$send-email | Sends a W9 email request to a vendor/payee |
13
12
  | [**update_w9_form**](FormsW9Api.md#update_w9_form) | **PUT** /w9/forms/{id} | Update a W9/W4/W8 form |
@@ -16,7 +15,7 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a
16
15
 
17
16
  ## create_w9_form
18
17
 
19
- > <IW9FormDataModelsOneOf> create_w9_form(avalara_version, x_correlation_id, opts)
18
+ > <IW9FormDataModelsOneOf> create_w9_form(avalara_version, opts)
20
19
 
21
20
  Create a W9/W4/W8 form
22
21
 
@@ -39,14 +38,15 @@ api_client = AvalaraSdk::ApiClient.new config
39
38
  api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
40
39
 
41
40
  avalara_version = '2.0' # String | API version
42
- x_correlation_id = '5597173b-9f5b-4f24-8c59-e451219875ee' # String | Unique correlation Id in a GUID format
43
41
  opts = {
42
+ x_correlation_id: '739f8226-3469-4e95-8303-d31b9609ba21', # String | Unique correlation Id in a GUID format
43
+ x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
44
44
  iw9_form_data_models_one_of: AvalaraSdk::A1099::V2::W4FormDataModel.new # IW9FormDataModelsOneOf | Form to be created
45
45
  }
46
46
 
47
47
  begin
48
48
  # Create a W9/W4/W8 form
49
- result = api_instance.create_w9_form(avalara_version, x_correlation_id, opts)
49
+ result = api_instance.create_w9_form(avalara_version, opts)
50
50
  p result
51
51
  rescue AvalaraSdk::ApiError => e
52
52
  puts "Error when calling FormsW9Api->create_w9_form: #{e}"
@@ -57,12 +57,12 @@ end
57
57
 
58
58
  This returns an Array which contains the response data, status code and headers.
59
59
 
60
- > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> create_w9_form_with_http_info(avalara_version, x_correlation_id, opts)
60
+ > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> create_w9_form_with_http_info(avalara_version, opts)
61
61
 
62
62
  ```ruby
63
63
  begin
64
64
  # Create a W9/W4/W8 form
65
- data, status_code, headers = api_instance.create_w9_form_with_http_info(avalara_version, x_correlation_id, opts)
65
+ data, status_code, headers = api_instance.create_w9_form_with_http_info(avalara_version, opts)
66
66
  p status_code # => 2xx
67
67
  p headers # => { ... }
68
68
  p data # => <IW9FormDataModelsOneOf>
@@ -76,7 +76,8 @@ end
76
76
  | Name | Type | Description | Notes |
77
77
  | ---- | ---- | ----------- | ----- |
78
78
  | **avalara_version** | **String** | API version | |
79
- | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
79
+ | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
80
+ | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
80
81
  | **iw9_form_data_models_one_of** | [**IW9FormDataModelsOneOf**](IW9FormDataModelsOneOf.md) | Form to be created | [optional] |
81
82
 
82
83
  ### Return type
@@ -95,7 +96,7 @@ end
95
96
 
96
97
  ## delete_w9_form
97
98
 
98
- > delete_w9_form(id, avalara_version, x_correlation_id)
99
+ > delete_w9_form(id, avalara_version, opts)
99
100
 
100
101
  Delete a form
101
102
 
@@ -121,11 +122,14 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
121
122
 
122
123
  id = 'id_example' # String | Id of the form to delete
123
124
  avalara_version = '2.0' # String | API version
124
- x_correlation_id = 'd8b9b636-90cb-47e8-abb3-183deeb8b1be' # String | Unique correlation Id in a GUID format
125
+ opts = {
126
+ x_correlation_id: '925e214f-a0bb-40ce-bceb-20d39ab390bf', # String | Unique correlation Id in a GUID format
127
+ x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
128
+ }
125
129
 
126
130
  begin
127
131
  # Delete a form
128
- api_instance.delete_w9_form(id, avalara_version, x_correlation_id)
132
+ api_instance.delete_w9_form(id, avalara_version, opts)
129
133
  rescue AvalaraSdk::ApiError => e
130
134
  puts "Error when calling FormsW9Api->delete_w9_form: #{e}"
131
135
  end
@@ -135,12 +139,12 @@ end
135
139
 
136
140
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
137
141
 
138
- > <Array(nil, Integer, Hash)> delete_w9_form_with_http_info(id, avalara_version, x_correlation_id)
142
+ > <Array(nil, Integer, Hash)> delete_w9_form_with_http_info(id, avalara_version, opts)
139
143
 
140
144
  ```ruby
141
145
  begin
142
146
  # Delete a form
143
- data, status_code, headers = api_instance.delete_w9_form_with_http_info(id, avalara_version, x_correlation_id)
147
+ data, status_code, headers = api_instance.delete_w9_form_with_http_info(id, avalara_version, opts)
144
148
  p status_code # => 2xx
145
149
  p headers # => { ... }
146
150
  p data # => nil
@@ -155,7 +159,8 @@ end
155
159
  | ---- | ---- | ----------- | ----- |
156
160
  | **id** | **String** | Id of the form to delete | |
157
161
  | **avalara_version** | **String** | API version | |
158
- | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
162
+ | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
163
+ | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
159
164
 
160
165
  ### Return type
161
166
 
@@ -173,7 +178,7 @@ nil (empty response body)
173
178
 
174
179
  ## get_w9_form
175
180
 
176
- > <IW9FormDataModelsOneOf> get_w9_form(id, avalara_version, x_correlation_id)
181
+ > <IW9FormDataModelsOneOf> get_w9_form(id, avalara_version, opts)
177
182
 
178
183
  Retrieve a W9/W4/W8 form
179
184
 
@@ -199,11 +204,14 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
199
204
 
200
205
  id = 'id_example' # String | Id of the form
201
206
  avalara_version = '2.0' # String | API version
202
- x_correlation_id = 'c94f4b08-050e-45b8-a62c-266aa7fe15ba' # String | Unique correlation Id in a GUID format
207
+ opts = {
208
+ x_correlation_id: 'c2c772cd-8e94-40a4-b736-20fcf8a50846', # String | Unique correlation Id in a GUID format
209
+ x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
210
+ }
203
211
 
204
212
  begin
205
213
  # Retrieve a W9/W4/W8 form
206
- result = api_instance.get_w9_form(id, avalara_version, x_correlation_id)
214
+ result = api_instance.get_w9_form(id, avalara_version, opts)
207
215
  p result
208
216
  rescue AvalaraSdk::ApiError => e
209
217
  puts "Error when calling FormsW9Api->get_w9_form: #{e}"
@@ -214,12 +222,12 @@ end
214
222
 
215
223
  This returns an Array which contains the response data, status code and headers.
216
224
 
217
- > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> get_w9_form_with_http_info(id, avalara_version, x_correlation_id)
225
+ > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> get_w9_form_with_http_info(id, avalara_version, opts)
218
226
 
219
227
  ```ruby
220
228
  begin
221
229
  # Retrieve a W9/W4/W8 form
222
- data, status_code, headers = api_instance.get_w9_form_with_http_info(id, avalara_version, x_correlation_id)
230
+ data, status_code, headers = api_instance.get_w9_form_with_http_info(id, avalara_version, opts)
223
231
  p status_code # => 2xx
224
232
  p headers # => { ... }
225
233
  p data # => <IW9FormDataModelsOneOf>
@@ -234,7 +242,8 @@ end
234
242
  | ---- | ---- | ----------- | ----- |
235
243
  | **id** | **String** | Id of the form | |
236
244
  | **avalara_version** | **String** | API version | |
237
- | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
245
+ | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
246
+ | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
238
247
 
239
248
  ### Return type
240
249
 
@@ -250,88 +259,9 @@ end
250
259
  - **Accept**: application/json
251
260
 
252
261
 
253
- ## get_w9_form_request
254
-
255
- > <FormRequestModel> get_w9_form_request(form_request_id, avalara_version, x_correlation_id)
256
-
257
- Retrieve a form request
258
-
259
- Retrieve a form request after creation: not likely to be useful except in testing. Previously-valid form requests will be Not Found after `expires_at`.
260
-
261
- ### Examples
262
-
263
- ```ruby
264
- require 'time'
265
- require 'avalara_sdk'
266
- # setup authorization
267
- AvalaraSdk::A1099::V2.configure do |config|
268
- # See Documentation for Authorization section in main README.md for more auth examples.
269
- config.bearer_token='<Your Avalara Identity Access Token>'
270
- config.environment='sandbox'
271
- config.app_name='testApp'
272
- config.app_version='1.2.3'
273
- config.machine_name='testMachine'
274
- end
275
-
276
- api_client = AvalaraSdk::ApiClient.new config
277
- api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
278
-
279
- form_request_id = 'form_request_id_example' # String |
280
- avalara_version = '2.0' # String | API version
281
- x_correlation_id = '6f9c508a-38ae-403e-b1d9-a45c6031241c' # String | Unique correlation Id in a GUID format
282
-
283
- begin
284
- # Retrieve a form request
285
- result = api_instance.get_w9_form_request(form_request_id, avalara_version, x_correlation_id)
286
- p result
287
- rescue AvalaraSdk::ApiError => e
288
- puts "Error when calling FormsW9Api->get_w9_form_request: #{e}"
289
- end
290
- ```
291
-
292
- #### Using the get_w9_form_request_with_http_info variant
293
-
294
- This returns an Array which contains the response data, status code and headers.
295
-
296
- > <Array(<FormRequestModel>, Integer, Hash)> get_w9_form_request_with_http_info(form_request_id, avalara_version, x_correlation_id)
297
-
298
- ```ruby
299
- begin
300
- # Retrieve a form request
301
- data, status_code, headers = api_instance.get_w9_form_request_with_http_info(form_request_id, avalara_version, x_correlation_id)
302
- p status_code # => 2xx
303
- p headers # => { ... }
304
- p data # => <FormRequestModel>
305
- rescue AvalaraSdk::A1099::V2::ApiError => e
306
- puts "Error when calling FormsW9Api->get_w9_form_request_with_http_info: #{e}"
307
- end
308
- ```
309
-
310
- ### Parameters
311
-
312
- | Name | Type | Description | Notes |
313
- | ---- | ---- | ----------- | ----- |
314
- | **form_request_id** | **String** | | |
315
- | **avalara_version** | **String** | API version | |
316
- | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
317
-
318
- ### Return type
319
-
320
- [**FormRequestModel**](FormRequestModel.md)
321
-
322
- ### Authorization
323
-
324
- [bearer](../../../README.md#documentation-for-authorization)
325
-
326
- ### HTTP request headers
327
-
328
- - **Content-Type**: Not defined
329
- - **Accept**: application/json
330
-
331
-
332
262
  ## list_w9_forms
333
263
 
334
- > <PaginatedW9FormsModel> list_w9_forms(avalara_version, x_correlation_id, opts)
264
+ > <PaginatedW9FormsModel> list_w9_forms(avalara_version, opts)
335
265
 
336
266
  List W9/W4/W8 forms.
337
267
 
@@ -356,18 +286,19 @@ api_client = AvalaraSdk::ApiClient.new config
356
286
  api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
357
287
 
358
288
  avalara_version = '2.0' # String | API version
359
- x_correlation_id = 'a6e7aff4-3c52-4caa-b332-ccb199f51da3' # String | Unique correlation Id in a GUID format
360
289
  opts = {
361
290
  filter: 'filter_example', # String | A filter statement to identify specific records to retrieve. For more information on filtering, see <a href=\"https://developer.avalara.com/avatax/filtering-in-rest/\">Filtering in REST</a>.
362
291
  top: 56, # 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.
363
292
  skip: 56, # Integer | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets.
364
293
  order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
365
- count: true # Boolean | When true, returns a @recordSetCount in the result set
294
+ count: true, # Boolean | When true, returns a @recordSetCount in the result set
295
+ x_correlation_id: 'eb4798f6-0845-49bb-91ba-1e3b977f5bea', # String | Unique correlation Id in a GUID format
296
+ x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
366
297
  }
367
298
 
368
299
  begin
369
300
  # List W9/W4/W8 forms.
370
- result = api_instance.list_w9_forms(avalara_version, x_correlation_id, opts)
301
+ result = api_instance.list_w9_forms(avalara_version, opts)
371
302
  p result
372
303
  rescue AvalaraSdk::ApiError => e
373
304
  puts "Error when calling FormsW9Api->list_w9_forms: #{e}"
@@ -378,12 +309,12 @@ end
378
309
 
379
310
  This returns an Array which contains the response data, status code and headers.
380
311
 
381
- > <Array(<PaginatedW9FormsModel>, Integer, Hash)> list_w9_forms_with_http_info(avalara_version, x_correlation_id, opts)
312
+ > <Array(<PaginatedW9FormsModel>, Integer, Hash)> list_w9_forms_with_http_info(avalara_version, opts)
382
313
 
383
314
  ```ruby
384
315
  begin
385
316
  # List W9/W4/W8 forms.
386
- data, status_code, headers = api_instance.list_w9_forms_with_http_info(avalara_version, x_correlation_id, opts)
317
+ data, status_code, headers = api_instance.list_w9_forms_with_http_info(avalara_version, opts)
387
318
  p status_code # => 2xx
388
319
  p headers # => { ... }
389
320
  p data # => <PaginatedW9FormsModel>
@@ -397,12 +328,13 @@ end
397
328
  | Name | Type | Description | Notes |
398
329
  | ---- | ---- | ----------- | ----- |
399
330
  | **avalara_version** | **String** | API version | |
400
- | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
401
331
  | **filter** | **String** | A filter statement to identify specific records to retrieve. For more information on filtering, see &lt;a href&#x3D;\&quot;https://developer.avalara.com/avatax/filtering-in-rest/\&quot;&gt;Filtering in REST&lt;/a&gt;. | [optional] |
402
332
  | **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. | [optional][default to 10] |
403
333
  | **skip** | **Integer** | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. | [optional][default to 0] |
404
334
  | **order_by** | **String** | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. | [optional] |
405
335
  | **count** | **Boolean** | When true, returns a @recordSetCount in the result set | [optional] |
336
+ | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
337
+ | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
406
338
 
407
339
  ### Return type
408
340
 
@@ -420,7 +352,7 @@ end
420
352
 
421
353
  ## send_w9_form_email
422
354
 
423
- > <IW9FormDataModelsOneOf> send_w9_form_email(id, avalara_version, x_correlation_id)
355
+ > <IW9FormDataModelsOneOf> send_w9_form_email(id, avalara_version, opts)
424
356
 
425
357
  Sends a W9 email request to a vendor/payee
426
358
 
@@ -444,11 +376,14 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
444
376
 
445
377
  id = 'id_example' # String | The ID of the W9/W4/W8 form.
446
378
  avalara_version = '2.0' # String | API version
447
- x_correlation_id = '0727cf38-4b0b-4f71-a61f-b4fb6918c976' # String | Unique correlation Id in a GUID format
379
+ opts = {
380
+ x_correlation_id: 'ce6f8ce6-3fc9-47e5-8c6e-39d76954b035', # String | Unique correlation Id in a GUID format
381
+ x_avalara_client: 'Swagger UI; 22.1.0' # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
382
+ }
448
383
 
449
384
  begin
450
385
  # Sends a W9 email request to a vendor/payee
451
- result = api_instance.send_w9_form_email(id, avalara_version, x_correlation_id)
386
+ result = api_instance.send_w9_form_email(id, avalara_version, opts)
452
387
  p result
453
388
  rescue AvalaraSdk::ApiError => e
454
389
  puts "Error when calling FormsW9Api->send_w9_form_email: #{e}"
@@ -459,12 +394,12 @@ end
459
394
 
460
395
  This returns an Array which contains the response data, status code and headers.
461
396
 
462
- > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> send_w9_form_email_with_http_info(id, avalara_version, x_correlation_id)
397
+ > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> send_w9_form_email_with_http_info(id, avalara_version, opts)
463
398
 
464
399
  ```ruby
465
400
  begin
466
401
  # Sends a W9 email request to a vendor/payee
467
- data, status_code, headers = api_instance.send_w9_form_email_with_http_info(id, avalara_version, x_correlation_id)
402
+ data, status_code, headers = api_instance.send_w9_form_email_with_http_info(id, avalara_version, opts)
468
403
  p status_code # => 2xx
469
404
  p headers # => { ... }
470
405
  p data # => <IW9FormDataModelsOneOf>
@@ -479,7 +414,8 @@ end
479
414
  | ---- | ---- | ----------- | ----- |
480
415
  | **id** | **String** | The ID of the W9/W4/W8 form. | |
481
416
  | **avalara_version** | **String** | API version | |
482
- | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
417
+ | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
418
+ | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
483
419
 
484
420
  ### Return type
485
421
 
@@ -497,7 +433,7 @@ end
497
433
 
498
434
  ## update_w9_form
499
435
 
500
- > <IW9FormDataModelsOneOf> update_w9_form(id, avalara_version, x_correlation_id, opts)
436
+ > <IW9FormDataModelsOneOf> update_w9_form(id, avalara_version, opts)
501
437
 
502
438
  Update a W9/W4/W8 form
503
439
 
@@ -521,14 +457,15 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
521
457
 
522
458
  id = 'id_example' # String | Id of the form to update
523
459
  avalara_version = '2.0' # String | API version
524
- x_correlation_id = 'dcd6d6cb-d31d-4ee8-b8dd-0cddd81376bd' # String | Unique correlation Id in a GUID format
525
460
  opts = {
461
+ x_correlation_id: '868a2e22-ac97-40b7-855d-1d3c102dc138', # String | Unique correlation Id in a GUID format
462
+ x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
526
463
  iw9_form_data_models_one_of: AvalaraSdk::A1099::V2::W4FormDataModel.new # IW9FormDataModelsOneOf | Form to be updated
527
464
  }
528
465
 
529
466
  begin
530
467
  # Update a W9/W4/W8 form
531
- result = api_instance.update_w9_form(id, avalara_version, x_correlation_id, opts)
468
+ result = api_instance.update_w9_form(id, avalara_version, opts)
532
469
  p result
533
470
  rescue AvalaraSdk::ApiError => e
534
471
  puts "Error when calling FormsW9Api->update_w9_form: #{e}"
@@ -539,12 +476,12 @@ end
539
476
 
540
477
  This returns an Array which contains the response data, status code and headers.
541
478
 
542
- > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> update_w9_form_with_http_info(id, avalara_version, x_correlation_id, opts)
479
+ > <Array(<IW9FormDataModelsOneOf>, Integer, Hash)> update_w9_form_with_http_info(id, avalara_version, opts)
543
480
 
544
481
  ```ruby
545
482
  begin
546
483
  # Update a W9/W4/W8 form
547
- data, status_code, headers = api_instance.update_w9_form_with_http_info(id, avalara_version, x_correlation_id, opts)
484
+ data, status_code, headers = api_instance.update_w9_form_with_http_info(id, avalara_version, opts)
548
485
  p status_code # => 2xx
549
486
  p headers # => { ... }
550
487
  p data # => <IW9FormDataModelsOneOf>
@@ -559,7 +496,8 @@ end
559
496
  | ---- | ---- | ----------- | ----- |
560
497
  | **id** | **String** | Id of the form to update | |
561
498
  | **avalara_version** | **String** | API version | |
562
- | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
499
+ | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
500
+ | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
563
501
  | **iw9_form_data_models_one_of** | [**IW9FormDataModelsOneOf**](IW9FormDataModelsOneOf.md) | Form to be updated | [optional] |
564
502
 
565
503
  ### Return type
@@ -578,7 +516,7 @@ end
578
516
 
579
517
  ## upload_w9_files
580
518
 
581
- > String upload_w9_files(id, avalara_version, x_correlation_id, opts)
519
+ > String upload_w9_files(id, avalara_version, opts)
582
520
 
583
521
  Upload files for a W9/W4/W8 form
584
522
 
@@ -604,14 +542,15 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
604
542
 
605
543
  id = 'id_example' # String | Id of the form
606
544
  avalara_version = '2.0' # String | API version
607
- x_correlation_id = 'a3cd6765-c6df-4223-86db-b9942a3cd56e' # String | Unique correlation Id in a GUID format
608
545
  opts = {
546
+ x_correlation_id: 'bbc832ee-2df9-43ae-9bc9-bbb9e6a9b867', # String | Unique correlation Id in a GUID format
547
+ x_avalara_client: 'Swagger UI; 22.1.0', # String | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) .
609
548
  file: File.new('/path/to/some/file') # File |
610
549
  }
611
550
 
612
551
  begin
613
552
  # Upload files for a W9/W4/W8 form
614
- result = api_instance.upload_w9_files(id, avalara_version, x_correlation_id, opts)
553
+ result = api_instance.upload_w9_files(id, avalara_version, opts)
615
554
  p result
616
555
  rescue AvalaraSdk::ApiError => e
617
556
  puts "Error when calling FormsW9Api->upload_w9_files: #{e}"
@@ -622,12 +561,12 @@ end
622
561
 
623
562
  This returns an Array which contains the response data, status code and headers.
624
563
 
625
- > <Array(String, Integer, Hash)> upload_w9_files_with_http_info(id, avalara_version, x_correlation_id, opts)
564
+ > <Array(String, Integer, Hash)> upload_w9_files_with_http_info(id, avalara_version, opts)
626
565
 
627
566
  ```ruby
628
567
  begin
629
568
  # Upload files for a W9/W4/W8 form
630
- data, status_code, headers = api_instance.upload_w9_files_with_http_info(id, avalara_version, x_correlation_id, opts)
569
+ data, status_code, headers = api_instance.upload_w9_files_with_http_info(id, avalara_version, opts)
631
570
  p status_code # => 2xx
632
571
  p headers # => { ... }
633
572
  p data # => String
@@ -642,7 +581,8 @@ end
642
581
  | ---- | ---- | ----------- | ----- |
643
582
  | **id** | **String** | Id of the form | |
644
583
  | **avalara_version** | **String** | API version | |
645
- | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | |
584
+ | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
585
+ | **x_avalara_client** | **String** | Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](https://developer.avalara.com/avatax/client-headers/) . | [optional] |
646
586
  | **file** | **File** | | [optional] |
647
587
 
648
588
  ### Return type
@@ -0,0 +1,55 @@
1
+ # AvalaraSdk::A1099::V2::Get1099Form200Response
2
+
3
+ ## Class instance methods
4
+
5
+ ### `openapi_one_of`
6
+
7
+ Returns the list of classes defined in oneOf.
8
+
9
+ #### Example
10
+
11
+ ```ruby
12
+ require 'avalara_sdk'
13
+
14
+ AvalaraSdk::A1099::V2::Get1099Form200Response.openapi_one_of
15
+ # =>
16
+ # [
17
+ # :'Form1095B',
18
+ # :'Form1099K',
19
+ # :'Form1099Misc',
20
+ # :'Form1099Nec',
21
+ # :'Form1099R'
22
+ # ]
23
+ ```
24
+
25
+ ### build
26
+
27
+ Find the appropriate object from the `openapi_one_of` list and casts the data into it.
28
+
29
+ #### Example
30
+
31
+ ```ruby
32
+ require 'avalara_sdk'
33
+
34
+ AvalaraSdk::A1099::V2::Get1099Form200Response.build(data)
35
+ # => #<Form1095B:0x00007fdd4aab02a0>
36
+
37
+ AvalaraSdk::A1099::V2::Get1099Form200Response.build(data_that_doesnt_match)
38
+ # => nil
39
+ ```
40
+
41
+ #### Parameters
42
+
43
+ | Name | Type | Description |
44
+ | ---- | ---- | ----------- |
45
+ | **data** | **Mixed** | data to be matched against the list of oneOf items |
46
+
47
+ #### Return type
48
+
49
+ - `Form1095B`
50
+ - `Form1099K`
51
+ - `Form1099Misc`
52
+ - `Form1099Nec`
53
+ - `Form1099R`
54
+ - `nil` (if no type matches)
55
+
@@ -0,0 +1,20 @@
1
+ # AvalaraSdk::A1099::V2::IncludedBase
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **id** | **String** | | [optional] |
8
+ | **type** | **String** | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'avalara_sdk'
14
+
15
+ instance = AvalaraSdk::A1099::V2::IncludedBase.new(
16
+ id: null,
17
+ type: null
18
+ )
19
+ ```
20
+