avalara_sdk 25.10.0 → 25.10.1

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 (37) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +1 -0
  4. data/docs/A1099/V2/CompaniesW9Api.md +5 -5
  5. data/docs/A1099/V2/Forms1099Api.md +7 -7
  6. data/docs/A1099/V2/FormsW9Api.md +91 -8
  7. data/docs/A1099/V2/Issuers1099Api.md +5 -5
  8. data/docs/A1099/V2/JobsApi.md +1 -1
  9. data/docs/A1099/V2/W8BenEFormRequest.md +4 -4
  10. data/docs/A1099/V2/W8BenFormRequest.md +7 -7
  11. data/lib/avalara_sdk/api/A1099/V2/companies_w9_api.rb +1 -1
  12. data/lib/avalara_sdk/api/A1099/V2/forms1099_api.rb +1 -1
  13. data/lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb +138 -1
  14. data/lib/avalara_sdk/api/A1099/V2/issuers1099_api.rb +1 -1
  15. data/lib/avalara_sdk/api/A1099/V2/jobs_api.rb +1 -1
  16. data/lib/avalara_sdk/api/EInvoicing/V1/data_input_fields_api.rb +1 -1
  17. data/lib/avalara_sdk/api/EInvoicing/V1/documents_api.rb +1 -1
  18. data/lib/avalara_sdk/api/EInvoicing/V1/interop_api.rb +1 -1
  19. data/lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb +1 -1
  20. data/lib/avalara_sdk/api/EInvoicing/V1/subscriptions_api.rb +1 -1
  21. data/lib/avalara_sdk/api/EInvoicing/V1/tax_identifiers_api.rb +1 -1
  22. data/lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb +1 -1
  23. data/lib/avalara_sdk/models/A1099/V2/w8_ben_e_form_request.rb +100 -4
  24. data/lib/avalara_sdk/models/A1099/V2/w8_ben_form_request.rb +91 -7
  25. data/lib/avalara_sdk/version.rb +1 -1
  26. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/byebug-11.1.3/gem_make.out +5 -5
  27. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/date-3.4.1/gem_make.out +5 -5
  28. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debase-0.2.9/gem_make.out +5 -5
  29. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/debug-1.10.0/gem_make.out +5 -5
  30. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/erb-5.0.1/gem_make.out +5 -5
  31. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/io-console-0.8.0/gem_make.out +5 -5
  32. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/json-2.12.2/gem_make.out +5 -5
  33. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/prism-1.4.0/gem_make.out +5 -5
  34. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/psych-5.2.6/gem_make.out +5 -5
  35. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/racc-1.8.1/gem_make.out +5 -5
  36. data/vendor/bundle/ruby/3.3.0/extensions/x86_64-linux/3.3.0/stringio-3.1.7/gem_make.out +5 -5
  37. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a3555a0818250e2b4ea7d4a4064451e1388902b4446970767684c495ebeb86a2
4
- data.tar.gz: 7daffd36ca7422b41f426d864de63caf9ed91c71078401d95310220c688ae3e4
3
+ metadata.gz: c226f201a9780343e296e62abb5b6d1bfc5dcafcb950397823bb32b0cb19ce80
4
+ data.tar.gz: 4bdef9704a775b69330dfee6e6608241c6b183607d74030db0484e534981e22d
5
5
  SHA512:
6
- metadata.gz: eb1b77be61190bf5f1f3308a602538bd205585fe68bf249cf5c4321581fe5e197d42a7a91025a244adc2931904d555ada07ec229db650ae1a4e60ffb63650666
7
- data.tar.gz: 4d7306e6aee483f5fd345fbe9f7cca01e6ac9a5fbd71168e641318534decf3b2e54c60680fa210ebd420742a94f90403e9cd817dca3e794ef072fba8247dab0e
6
+ metadata.gz: 574311937fbf3ab112136a89afad861810ce289b20c4ec72398630de5af0e12750b5b42769c9e486f30d8c6c9d339b95d926083bbf53947b3eccf97b84ccff92
7
+ data.tar.gz: 403e6a5eb8516ba43f41a5f79705ebe7f858ac14ea603f1f4daa26490c95659487817c47c9aa8f740845fbd8ef4855c58498998c3c8e2ed109ebdfbc42638995
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- avalara_sdk (25.9.0)
4
+ avalara_sdk (25.10.0)
5
5
  faraday (~> 1.0, >= 1.0.1)
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -94,6 +94,7 @@ Class | Method | HTTP request | Description
94
94
  *FormsW9Api* | [**create_w9_form**](docs/A1099/V2/FormsW9Api.md#create_w9_form) | **POST** /w9/forms | Create a W9/W4/W8 form
95
95
  *FormsW9Api* | [**delete_w9_form**](docs/A1099/V2/FormsW9Api.md#delete_w9_form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form
96
96
  *FormsW9Api* | [**get_w9_form**](docs/A1099/V2/FormsW9Api.md#get_w9_form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form
97
+ *FormsW9Api* | [**get_w9_form_pdf**](docs/A1099/V2/FormsW9Api.md#get_w9_form_pdf) | **GET** /w9/forms/{id}/pdf | Download the PDF for a W9/W4/W8 form.
97
98
  *FormsW9Api* | [**list_w9_forms**](docs/A1099/V2/FormsW9Api.md#list_w9_forms) | **GET** /w9/forms | List W9/W4/W8 forms
98
99
  *FormsW9Api* | [**send_w9_form_email**](docs/A1099/V2/FormsW9Api.md#send_w9_form_email) | **POST** /w9/forms/{id}/$send-email | Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form
99
100
  *FormsW9Api* | [**update_w9_form**](docs/A1099/V2/FormsW9Api.md#update_w9_form) | **PUT** /w9/forms/{id} | Update a W9/W4/W8 form
@@ -39,7 +39,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
39
39
 
40
40
  avalara_version = '2.0.0' # String | API version
41
41
  opts = {
42
- x_correlation_id: '6df88900-1e19-42cb-b5a0-fc2442681327', # String | Unique correlation Id in a GUID format
42
+ x_correlation_id: 'e059925d-91f6-4c34-9bcd-2a0e997dd8fa', # String | Unique correlation Id in a GUID format
43
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
  company_request: AvalaraSdk::A1099::V2::CompanyRequest.new({name: 'name_example', email: 'email_example', address: 'address_example', city: 'city_example', zip: 'zip_example', telephone: 'telephone_example', tin: 'tin_example', country_code: 'country_code_example'}) # CompanyRequest | The company to create
45
45
  }
@@ -123,7 +123,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
123
123
  id = 'id_example' # String | The company to delete
124
124
  avalara_version = '2.0.0' # String | API version
125
125
  opts = {
126
- x_correlation_id: '33931030-471d-4055-be36-8dcc3c48c11d', # String | Unique correlation Id in a GUID format
126
+ x_correlation_id: 'b01f9bff-5e8c-49d6-8c9b-44892e578dc5', # String | Unique correlation Id in a GUID format
127
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
128
  }
129
129
 
@@ -210,7 +210,7 @@ opts = {
210
210
  order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
211
211
  count: true, # Boolean | If true, return the global count of elements in the collection.
212
212
  count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
213
- x_correlation_id: 'cf08fb7e-1d1c-43e2-a2b8-dfe7be26d43f', # String | Unique correlation Id in a GUID format
213
+ x_correlation_id: '9654708e-0675-4a73-a0fa-5b8016bb2175', # String | Unique correlation Id in a GUID format
214
214
  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/) .
215
215
  }
216
216
 
@@ -298,7 +298,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
298
298
  id = 'id_example' # String | Id of the company
299
299
  avalara_version = '2.0.0' # String | API version
300
300
  opts = {
301
- x_correlation_id: 'f29e8436-2c45-494b-b537-a22ae251829e', # String | Unique correlation Id in a GUID format
301
+ x_correlation_id: 'c9747d06-85d9-42ed-a7d2-1438a48a4d33', # String | Unique correlation Id in a GUID format
302
302
  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/) .
303
303
  }
304
304
 
@@ -381,7 +381,7 @@ api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client
381
381
  id = 'id_example' # String | The ID of the company to update
382
382
  avalara_version = '2.0.0' # String | API version
383
383
  opts = {
384
- x_correlation_id: '595ee1c9-2b9e-4d5a-8aa6-661b1fe4669f', # String | Unique correlation Id in a GUID format
384
+ x_correlation_id: '0227fcc3-16c4-439b-a4ea-28c316d311ef', # String | Unique correlation Id in a GUID format
385
385
  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/) .
386
386
  company_request: AvalaraSdk::A1099::V2::CompanyRequest.new({name: 'name_example', email: 'email_example', address: 'address_example', city: 'city_example', zip: 'zip_example', telephone: 'telephone_example', tin: 'tin_example', country_code: 'country_code_example'}) # CompanyRequest | The updated company data
387
387
  }
@@ -42,7 +42,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
42
42
  avalara_version = '2.0.0' # String | API version
43
43
  opts = {
44
44
  dry_run: true, # Boolean | defaults to false. If true, it will NOT change the DB. It will just return a report of what would've have been changed in the DB
45
- x_correlation_id: 'eec0b095-bfa8-4786-bbad-3f20a4b61ac2', # String | Unique correlation Id in a GUID format
45
+ x_correlation_id: '2d9b6e7b-79bb-4d14-9699-4638bb6151d9', # String | Unique correlation Id in a GUID format
46
46
  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/) .
47
47
  form1099_list_request: AvalaraSdk::A1099::V2::Form1099ListRequest.new # Form1099ListRequest |
48
48
  }
@@ -126,7 +126,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
126
126
 
127
127
  avalara_version = '2.0.0' # String | API version
128
128
  opts = {
129
- x_correlation_id: 'ea80e3d4-6198-4297-9fff-4b12b5d270a0', # String | Unique correlation Id in a GUID format
129
+ x_correlation_id: '5274903f-4f84-4aba-9dcf-408ca56e00ea', # String | Unique correlation Id in a GUID format
130
130
  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/) .
131
131
  get1099_form200_response: AvalaraSdk::A1099::V2::Form1042S.new({unique_form_id: 'unique_form_id_example', income_code: '01', gross_income: 3.56, withholding_indicator: '3', tax_country_code: 'tax_country_code_example', type: 'Form1099Nec', recipient_name: 'recipient_name_example', address: 'address_example', city: 'city_example', country_code: 'country_code_example'}) # Get1099Form200Response |
132
132
  }
@@ -210,7 +210,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
210
210
  id = 'id_example' # String | The unique identifier of the desired form to delete.
211
211
  avalara_version = '2.0.0' # String | API version
212
212
  opts = {
213
- x_correlation_id: '6f61d545-12cb-445a-b60c-bd21c3f78ae3', # String | Unique correlation Id in a GUID format
213
+ x_correlation_id: 'f59c9692-f2fb-4dbe-8cba-98633c4bfb3b', # String | Unique correlation Id in a GUID format
214
214
  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/) .
215
215
  }
216
216
 
@@ -292,7 +292,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
292
292
  id = 'id_example' # String |
293
293
  avalara_version = '2.0.0' # String | API version
294
294
  opts = {
295
- x_correlation_id: '3dda6df9-8f00-4ac0-8eab-0e56263c2895', # String | Unique correlation Id in a GUID format
295
+ x_correlation_id: '73429041-37dd-428a-8fd5-94f9bfdc849d', # String | Unique correlation Id in a GUID format
296
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/) .
297
297
  }
298
298
 
@@ -376,7 +376,7 @@ id = 'id_example' # String | The ID of the form
376
376
  avalara_version = '2.0.0' # String | API version
377
377
  opts = {
378
378
  mark_edelivered: true, # Boolean | Optional boolean that if set indicates that the form should be marked as having been successfully edelivered
379
- x_correlation_id: '83471033-6587-4425-a03e-1057de8d14cf', # String | Unique correlation Id in a GUID format
379
+ x_correlation_id: '880a787b-1d92-485f-a3db-b5277d3d0ba1', # String | Unique correlation Id in a GUID format
380
380
  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/) .
381
381
  }
382
382
 
@@ -465,7 +465,7 @@ opts = {
465
465
  order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
466
466
  count: true, # Boolean | If true, return the global count of elements in the collection.
467
467
  count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
468
- x_correlation_id: '9cd2b713-72ed-419c-8c1f-4aeef9f6b0d4', # String | Unique correlation Id in a GUID format
468
+ x_correlation_id: '612ac19d-6b12-4fe1-b92b-61e73b3b5d54', # String | Unique correlation Id in a GUID format
469
469
  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/) .
470
470
  }
471
471
 
@@ -553,7 +553,7 @@ api_instance = AvalaraSdk::A1099::V2::Forms1099Api.new api_client
553
553
  id = 'id_example' # String |
554
554
  avalara_version = '2.0.0' # String | API version
555
555
  opts = {
556
- x_correlation_id: 'b0bb9771-ffdf-4884-bac3-7cf00bf7c745', # String | Unique correlation Id in a GUID format
556
+ x_correlation_id: '5717cd04-c60c-4603-9ede-aba2bec55e19', # String | Unique correlation Id in a GUID format
557
557
  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/) .
558
558
  get1099_form200_response: AvalaraSdk::A1099::V2::Form1042S.new({unique_form_id: 'unique_form_id_example', income_code: '01', gross_income: 3.56, withholding_indicator: '3', tax_country_code: 'tax_country_code_example', type: 'Form1099Nec', recipient_name: 'recipient_name_example', address: 'address_example', city: 'city_example', country_code: 'country_code_example'}) # Get1099Form200Response |
559
559
  }
@@ -8,6 +8,7 @@ All URIs are relative to *https://api.sbx.avalara.com/avalara1099*
8
8
  | [**create_w9_form**](FormsW9Api.md#create_w9_form) | **POST** /w9/forms | Create a W9/W4/W8 form |
9
9
  | [**delete_w9_form**](FormsW9Api.md#delete_w9_form) | **DELETE** /w9/forms/{id} | Delete a W9/W4/W8 form |
10
10
  | [**get_w9_form**](FormsW9Api.md#get_w9_form) | **GET** /w9/forms/{id} | Retrieve a W9/W4/W8 form |
11
+ | [**get_w9_form_pdf**](FormsW9Api.md#get_w9_form_pdf) | **GET** /w9/forms/{id}/pdf | Download the PDF for a W9/W4/W8 form. |
11
12
  | [**list_w9_forms**](FormsW9Api.md#list_w9_forms) | **GET** /w9/forms | List W9/W4/W8 forms |
12
13
  | [**send_w9_form_email**](FormsW9Api.md#send_w9_form_email) | **POST** /w9/forms/{id}/$send-email | Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form |
13
14
  | [**update_w9_form**](FormsW9Api.md#update_w9_form) | **PUT** /w9/forms/{id} | Update a W9/W4/W8 form |
@@ -42,7 +43,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
42
43
 
43
44
  avalara_version = '2.0.0' # String | API version
44
45
  opts = {
45
- x_correlation_id: '0ab9baaf-56ae-484d-a812-1586d6141797', # String | Unique correlation Id in a GUID format
46
+ x_correlation_id: 'fa427ec8-fbb3-4e25-8c7e-2f81d68241ec', # String | Unique correlation Id in a GUID format
46
47
  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/) .
47
48
  create_and_send_w9_form_email_request: AvalaraSdk::A1099::V2::W4FormMinimalRequest.new({email: 'email_example', employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example'}) # CreateAndSendW9FormEmailRequest | Form to be created
48
49
  }
@@ -125,7 +126,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
125
126
 
126
127
  avalara_version = '2.0.0' # String | API version
127
128
  opts = {
128
- x_correlation_id: 'd1c7d02a-c0be-4a64-9fbb-0b4aed2f526c', # String | Unique correlation Id in a GUID format
129
+ x_correlation_id: '6bde16cf-bc27-448b-8abd-a3461599deff', # String | Unique correlation Id in a GUID format
129
130
  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/) .
130
131
  create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new({employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example', tin_type: 'tin_type_example', tin: 'tin_example'}) # CreateW9FormRequest | Form to be created
131
132
  }
@@ -209,7 +210,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
209
210
  id = 'id_example' # String | ID of the form to delete
210
211
  avalara_version = '2.0.0' # String | API version
211
212
  opts = {
212
- x_correlation_id: '5c349318-0f66-4478-bcc0-ce6af3c9f485', # String | Unique correlation Id in a GUID format
213
+ x_correlation_id: '4bc1a0f7-f202-4e27-ba6d-37645f4a839e', # String | Unique correlation Id in a GUID format
213
214
  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/) .
214
215
  }
215
216
 
@@ -291,7 +292,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
291
292
  id = 'id_example' # String | ID of the form
292
293
  avalara_version = '2.0.0' # String | API version
293
294
  opts = {
294
- x_correlation_id: 'f39583e2-33c6-460f-aed2-66bc23ef3b6a', # String | Unique correlation Id in a GUID format
295
+ x_correlation_id: '7dd6cb2c-d9ed-4fb7-8f97-67d35d09e59e', # String | Unique correlation Id in a GUID format
295
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/) .
296
297
  }
297
298
 
@@ -345,6 +346,88 @@ end
345
346
  - **Accept**: application/json
346
347
 
347
348
 
349
+ ## get_w9_form_pdf
350
+
351
+ > get_w9_form_pdf(id, avalara_version, opts)
352
+
353
+ Download the PDF for a W9/W4/W8 form.
354
+
355
+ Returns the PDF file for a W9/W4/W8 form.
356
+
357
+ ### Examples
358
+
359
+ ```ruby
360
+ require 'time'
361
+ require 'avalara_sdk'
362
+ # setup authorization
363
+ AvalaraSdk::A1099::V2.configure do |config|
364
+ # See Documentation for Authorization section in main README.md for more auth examples.
365
+ config.bearer_token='<Your Avalara Identity Access Token>'
366
+ config.environment='sandbox'
367
+ config.app_name='testApp'
368
+ config.app_version='1.2.3'
369
+ config.machine_name='testMachine'
370
+ end
371
+
372
+ api_client = AvalaraSdk::ApiClient.new config
373
+ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
374
+
375
+ id = 'id_example' # String | Id of the form
376
+ avalara_version = '2.0.0' # String | API version
377
+ opts = {
378
+ x_correlation_id: '783194b6-5fc6-41c5-a5b4-1b02018e09dd', # String | Unique correlation Id in a GUID format
379
+ 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/) .
380
+ }
381
+
382
+ begin
383
+ # Download the PDF for a W9/W4/W8 form.
384
+ api_instance.get_w9_form_pdf(id, avalara_version, opts)
385
+ rescue AvalaraSdk::ApiError => e
386
+ puts "Error when calling FormsW9Api->get_w9_form_pdf: #{e}"
387
+ end
388
+ ```
389
+
390
+ #### Using the get_w9_form_pdf_with_http_info variant
391
+
392
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
393
+
394
+ > <Array(nil, Integer, Hash)> get_w9_form_pdf_with_http_info(id, avalara_version, opts)
395
+
396
+ ```ruby
397
+ begin
398
+ # Download the PDF for a W9/W4/W8 form.
399
+ data, status_code, headers = api_instance.get_w9_form_pdf_with_http_info(id, avalara_version, opts)
400
+ p status_code # => 2xx
401
+ p headers # => { ... }
402
+ p data # => nil
403
+ rescue AvalaraSdk::A1099::V2::ApiError => e
404
+ puts "Error when calling FormsW9Api->get_w9_form_pdf_with_http_info: #{e}"
405
+ end
406
+ ```
407
+
408
+ ### Parameters
409
+
410
+ | Name | Type | Description | Notes |
411
+ | ---- | ---- | ----------- | ----- |
412
+ | **id** | **String** | Id of the form | |
413
+ | **avalara_version** | **String** | API version | |
414
+ | **x_correlation_id** | **String** | Unique correlation Id in a GUID format | [optional] |
415
+ | **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] |
416
+
417
+ ### Return type
418
+
419
+ nil (empty response body)
420
+
421
+ ### Authorization
422
+
423
+ [bearer](../../../README.md#documentation-for-authorization)
424
+
425
+ ### HTTP request headers
426
+
427
+ - **Content-Type**: Not defined
428
+ - **Accept**: application/pdf, application/json
429
+
430
+
348
431
  ## list_w9_forms
349
432
 
350
433
  > <PaginatedQueryResultModelW9FormBaseResponse> list_w9_forms(avalara_version, opts)
@@ -379,7 +462,7 @@ opts = {
379
462
  order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
380
463
  count: true, # Boolean | If true, return the global count of elements in the collection.
381
464
  count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
382
- x_correlation_id: 'a60536fb-e758-4f92-a0cd-7d99addcc735', # String | Unique correlation Id in a GUID format
465
+ x_correlation_id: 'c1b56927-f8e5-4243-8fd5-b5d13f7c0c29', # String | Unique correlation Id in a GUID format
383
466
  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/) .
384
467
  }
385
468
 
@@ -467,7 +550,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
467
550
  id = 'id_example' # String | The ID of the W9/W4/W8 form.
468
551
  avalara_version = '2.0.0' # String | API version
469
552
  opts = {
470
- x_correlation_id: '8f2f717b-24cb-4bf1-9820-ded88ed93798', # String | Unique correlation Id in a GUID format
553
+ x_correlation_id: 'ef646026-89fe-420b-bea9-e29ec45d9557', # String | Unique correlation Id in a GUID format
471
554
  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/) .
472
555
  }
473
556
 
@@ -550,7 +633,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
550
633
  id = 'id_example' # String | ID of the form to update
551
634
  avalara_version = '2.0.0' # String | API version
552
635
  opts = {
553
- x_correlation_id: '8688fb2d-d79c-433a-9abf-4f96ea744f32', # String | Unique correlation Id in a GUID format
636
+ x_correlation_id: 'ac8f162c-fbee-4c4d-b9fa-986df02c90e3', # String | Unique correlation Id in a GUID format
554
637
  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/) .
555
638
  create_w9_form_request: AvalaraSdk::A1099::V2::W4FormRequest.new({employee_first_name: 'employee_first_name_example', employee_last_name: 'employee_last_name_example', tin_type: 'tin_type_example', tin: 'tin_example'}) # CreateW9FormRequest | Form to be updated
556
639
  }
@@ -635,7 +718,7 @@ api_instance = AvalaraSdk::A1099::V2::FormsW9Api.new api_client
635
718
  id = 'id_example' # String | Id of the form
636
719
  avalara_version = '2.0.0' # String | API version
637
720
  opts = {
638
- x_correlation_id: '13008974-9cbc-417c-a3d1-7779277a2077', # String | Unique correlation Id in a GUID format
721
+ x_correlation_id: 'c332bc05-2179-4a35-bd1a-1d01a3d03e36', # String | Unique correlation Id in a GUID format
639
722
  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/) .
640
723
  file: File.new('/path/to/some/file') # File |
641
724
  }
@@ -39,7 +39,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
39
39
 
40
40
  avalara_version = '2.0.0' # String | API version
41
41
  opts = {
42
- x_correlation_id: '019c2b9f-42e4-424f-a440-2de4183e50c9', # String | Unique correlation Id in a GUID format
42
+ x_correlation_id: '0183bbfe-d8da-48ad-a320-b999accf40bd', # String | Unique correlation Id in a GUID format
43
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
  issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to create
45
45
  }
@@ -123,7 +123,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
123
123
  id = 'id_example' # String | Id of the issuer to delete
124
124
  avalara_version = '2.0.0' # String | API version
125
125
  opts = {
126
- x_correlation_id: '2c4f0724-28b8-4321-940c-7aea4e6a1ae4', # String | Unique correlation Id in a GUID format
126
+ x_correlation_id: 'c0d08fe4-5eaf-4902-aa48-db347d045ba2', # String | Unique correlation Id in a GUID format
127
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
128
  }
129
129
 
@@ -205,7 +205,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
205
205
  id = 'id_example' # String | Id of the issuer to retrieve
206
206
  avalara_version = '2.0.0' # String | API version
207
207
  opts = {
208
- x_correlation_id: 'e7d6ad5f-3589-4822-b711-bb658238ebf6', # String | Unique correlation Id in a GUID format
208
+ x_correlation_id: '126ca6ac-f595-4b34-ada2-22cdd14960f5', # String | Unique correlation Id in a GUID format
209
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
210
  }
211
211
 
@@ -293,7 +293,7 @@ opts = {
293
293
  order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
294
294
  count: true, # Boolean | If true, return the global count of elements in the collection.
295
295
  count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
296
- x_correlation_id: '2c3cf6e2-a30b-4934-8dad-94105b6b668c', # String | Unique correlation Id in a GUID format
296
+ x_correlation_id: '51f8e5b5-bb09-4b2c-954f-f0f7b119003b', # String | Unique correlation Id in a GUID format
297
297
  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/) .
298
298
  }
299
299
 
@@ -381,7 +381,7 @@ api_instance = AvalaraSdk::A1099::V2::Issuers1099Api.new api_client
381
381
  id = 'id_example' # String | Id of the issuer to update
382
382
  avalara_version = '2.0.0' # String | API version
383
383
  opts = {
384
- x_correlation_id: '1d3cb56d-6c88-4c68-863a-81b0f64c270f', # String | Unique correlation Id in a GUID format
384
+ x_correlation_id: '508db50e-5f2e-404d-9974-509003a9dfa8', # String | Unique correlation Id in a GUID format
385
385
  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/) .
386
386
  issuer_request: AvalaraSdk::A1099::V2::IssuerRequest.new({name: 'name_example', telephone: 'telephone_example', tax_year: 37, email: 'email_example', address: 'address_example', city: 'city_example', state: 'state_example', zip: 'zip_example', last_filing: false}) # IssuerRequest | The issuer to update
387
387
  }
@@ -36,7 +36,7 @@ api_instance = AvalaraSdk::A1099::V2::JobsApi.new api_client
36
36
  id = 'id_example' # String | Job id obtained from other API responses, like `/1099/bulk-upsert`.
37
37
  avalara_version = '2.0.0' # String | API version
38
38
  opts = {
39
- x_correlation_id: 'a5bf9066-6d69-4811-95f8-646108327017', # String | Unique correlation Id in a GUID format
39
+ x_correlation_id: '44d0405b-1dec-4c17-8933-d5f2e21f598d', # String | Unique correlation Id in a GUID format
40
40
  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/) .
41
41
  }
42
42
 
@@ -8,9 +8,9 @@
8
8
  | **name** | **String** | The name of the individual or entity associated with the form. | |
9
9
  | **citizenship_country** | **String** | The country of citizenship. | |
10
10
  | **disregarded_entity** | **String** | The name of the disregarded entity receiving the payment (if applicable). | [optional] |
11
- | **entity_type** | **String** | The entity type. Available values: - 1: Corporation - 2: Disregarded entity - 3: Partnership - 4: Simple trust - 5: Grantor trust - 6: Complex trust - 7: Estate - 8: Foreign Government - Controlled Entity - 9: Central Bank of Issue - 10: Tax-exempt organization - 11: Private foundation - 12: International organization - 13: Foreign Government - Controlled Integral Part | |
11
+ | **entity_type** | **String** | Represents the entity type for tax forms. Each value corresponds to a specific entity classification. - 1: Corporation - 2: Disregarded entity - 3: Partnership - 4: Simple trust - 5: Grantor trust - 6: Complex trust - 7: Estate - 8: Foreign Government - Controlled Entity - 9: Central Bank of Issue - 10: Tax-exempt organization - 11: Private foundation - 12: International organization - 13: Foreign Government - Controlled Integral Part | |
12
12
  | **making_treaty_claim** | **Boolean** | Indicates whether the entity is making a treaty claim. | [optional] |
13
- | **fatca_status** | **String** | The FATCA status. Available values: - 1: Nonparticipating FFI (including a limited FFI or an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner) - 2: Participating FFI - 3: Reporting Model 1 FFI - 4: Reporting Model 2 FFI - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XII) - 6: Sponsored FFI that has not obtained a GIIN - 7: Certified deemed-compliant nonregistering local bank - 8: Certified deemed-compliant FFI with only low-value accounts - 9: Certified deemed-compliant sponsored, closely held investment vehicle - 10: Certified deemed-compliant limited life debt investment entity - 11: Certified deemed-compliant investment advisors and investment managers - 12: Owner-documented FFI - 13: Restricted distributor - 14: Nonreporting IGA FFI - 15: Foreign government, government of a U.S. possession, or foreign central bank of issue - 16: International organization - 17: Exempt retirement plans - 18: Entity wholly owned by exempt beneficial owners - 19: Territory financial institution - 20: Nonfinancial group entity - 21: Excepted nonfinancial start-up company - 22: Excepted nonfinancial entity in liquidation or bankruptcy - 23: 501(c) organization - 24: Nonprofit organization - 25: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation - 26: Excepted territory NFFE - 27: Active NFFE - 28: Passive NFFE - 29: Excepted inter-affiliate FFI - 30: Direct reporting NFFE - 31: Sponsored direct reporting NFFE - 32: Account that is not a financial account | |
13
+ | **fatca_status** | **String** | Represents the FATCA status types for tax forms. Used for W8-BEN-E forms and FATCA compliance validations. Values correspond to numeric identifiers used in forms. - 1: Nonparticipating FFI (including a limited FFI or an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI, participating FFI, or exempt beneficial owner) - 2: Participating FFI - 3: Reporting Model 1 FFI - 4: Reporting Model 2 FFI - 5: Registered deemed-compliant FFI (other than a reporting Model 1 FFI, sponsored FFI, or nonreporting IGA FFI covered in Part XII) - 6: Sponsored FFI that has not obtained a GIIN - 7: Certified deemed-compliant nonregistering local bank - 8: Certified deemed-compliant FFI with only low-value accounts - 9: Certified deemed-compliant sponsored, closely held investment vehicle - 10: Certified deemed-compliant limited life debt investment entity - 11: Certified deemed-compliant investment advisors and investment managers - 12: Owner-documented FFI - 13: Restricted distributor - 14: Nonreporting IGA FFI - 15: Foreign government, government of a U.S. possession, or foreign central bank of issue - 16: International organization - 17: Exempt retirement plans - 18: Entity wholly owned by exempt beneficial owners - 19: Territory financial institution - 20: Nonfinancial group entity - 21: Excepted nonfinancial start-up company - 22: Excepted nonfinancial entity in liquidation or bankruptcy - 23: 501(c) organization - 24: Nonprofit organization - 25: Publicly traded NFFE or NFFE affiliate of a publicly traded corporation - 26: Excepted territory NFFE - 27: Active NFFE - 28: Passive NFFE - 29: Excepted inter-affiliate FFI - 30: Direct reporting NFFE - 31: Sponsored direct reporting NFFE - 32: Account that is not a financial account | |
14
14
  | **residence_address** | **String** | The residential address of the individual or entity. | [optional] |
15
15
  | **residence_city** | **String** | The city of residence. | [optional] |
16
16
  | **residence_state** | **String** | The state of residence. | [optional] |
@@ -27,7 +27,7 @@
27
27
  | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not required. | [optional] |
28
28
  | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] |
29
29
  | **reference_number** | **String** | A reference number for the form. | [optional] |
30
- | **disregarded_entity_fatca_status** | **String** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Limited Branch - 2: U.S. Branch - 3: Participating FFI - 4: Reporting Model 1 FFI - 5: Reporting Model 2 FFI | [optional] |
30
+ | **disregarded_entity_fatca_status** | **String** | The FATCA status of disregarded entity or branch receiving payment. Available values: - 1: Branch treated as nonparticipating FFI - 2: U.S. Branch - 3: Participating FFI - 4: Reporting Model 1 FFI - 5: Reporting Model 2 FFI | [optional] |
31
31
  | **disregarded_address** | **String** | The address for disregarded entities. | [optional] |
32
32
  | **disregarded_city** | **String** | The city for disregarded entities. | [optional] |
33
33
  | **disregarded_state** | **String** | The state for disregarded entities. | [optional] |
@@ -37,7 +37,7 @@
37
37
  | **treaty_country_certification** | **Boolean** | Certifies the beneficial owner&#39;s country under the U.S. tax treaty. | [optional] |
38
38
  | **treaty_country** | **String** | The treaty country of the beneficial owner. | [optional] |
39
39
  | **benefit_limitation_certification** | **Boolean** | Certifies that the beneficial owner is eligible for treaty benefits and meets any limitation on benefits requirements. | [optional] |
40
- | **benefit_limitation** | **String** | The benefit limitation for tax treaty claims. Available values: - 1: Government - 2: Tax exempt pension trust or pension fund - 3: Other tax exempt organization - 4: Publicly traded corporation - 5: Subsidiary of a publicly traded corporation - 6: Company that meets the ownership and base erosion test - 7: Company that meets the derivative benefits test - 8: Company with an item of income that meets active trade or business test - 9: Favorable discretionary determination by the U.S. competent authority received - 10: Other | [optional] |
40
+ | **benefit_limitation** | **String** | The benefit limitation for tax treaty claims. Available values: - 1: Government - 2: Tax exempt pension trust or pension fund - 3: Other tax exempt organization - 4: Publicly traded corporation - 5: Subsidiary of a publicly traded corporation - 6: Company that meets the ownership and base erosion test - 7: Company that meets the derivative benefits test - 8: Company with an item of income that meets active trade or business test - 9: Favorable discretionary determination by the U.S. competent authority received - 10: Other - 11: No LOB article in treaty | [optional] |
41
41
  | **qualified_resident_status_certification** | **Boolean** | Certifies that the beneficial owner claims treaty benefits and meets the qualified resident status for specific U.S. source income. | [optional] |
42
42
  | **treaty_article** | **String** | Indicates the specific article and paragraph of the tax treaty under which the beneficial owner is claiming benefits. | [optional] |
43
43
  | **withholding_rate** | **String** | Specifies the reduced withholding rate claimed under the applicable tax treaty. | [optional] |
@@ -6,27 +6,27 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **type** | **String** | The form type (always \&quot;w8ben\&quot; for this model). | [optional][readonly] |
8
8
  | **name** | **String** | The name of the individual or entity associated with the form. | |
9
- | **citizenship_country** | **String** | The country of citizenship. | |
9
+ | **citizenship_country** | **String** | The country of citizenship.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | |
10
10
  | **residence_address** | **String** | The residential address of the individual or entity. | [optional] |
11
11
  | **residence_city** | **String** | The city of residence. | [optional] |
12
- | **residence_state** | **String** | The state of residence. | [optional] |
12
+ | **residence_state** | **String** | The state of residence. Required for US and Canada.. Allowed values: AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO (and 65 more) | [optional] |
13
13
  | **residence_zip** | **String** | The ZIP code of the residence. | [optional] |
14
- | **residence_country** | **String** | The country of residence. | |
14
+ | **residence_country** | **String** | The country of residence.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | |
15
15
  | **residence_is_mailing** | **Boolean** | Indicates whether the residence address is the mailing address. | [optional] |
16
16
  | **mailing_address** | **String** | The mailing address. | [optional] |
17
17
  | **mailing_city** | **String** | The city of the mailing address. | [optional] |
18
- | **mailing_state** | **String** | The state of the mailing address. | [optional] |
18
+ | **mailing_state** | **String** | The state of the mailing address. Required for US and Canada.. Allowed values: AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO (and 65 more) | [optional] |
19
19
  | **mailing_zip** | **String** | The ZIP code of the mailing address. | [optional] |
20
- | **mailing_country** | **String** | The country of the mailing address. | |
20
+ | **mailing_country** | **String** | The country of the mailing address.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | |
21
21
  | **tin** | **String** | The taxpayer identification number (TIN). | [optional] |
22
22
  | **foreign_tin_not_required** | **Boolean** | Indicates whether a foreign TIN is not legally required. | [optional] |
23
23
  | **foreign_tin** | **String** | The foreign taxpayer identification number (TIN). | [optional] |
24
24
  | **reference_number** | **String** | A reference number for the form. | [optional] |
25
25
  | **birthday** | **Date** | The birthday of the individual associated with the form. | [optional] |
26
- | **treaty_country** | **String** | The country for which the treaty applies. | [optional] |
26
+ | **treaty_country** | **String** | The country for which the treaty applies.. Allowed values: US, AF, AX, AL, AG, AQ, AN, AO, AV, AY (and 248 more) | [optional] |
27
27
  | **treaty_article** | **String** | The specific article of the treaty being claimed. | [optional] |
28
28
  | **treaty_reasons** | **String** | The reasons for claiming treaty benefits. | [optional] |
29
- | **withholding_rate** | **String** | The withholding rate applied as per the treaty. | [optional] |
29
+ | **withholding_rate** | **String** | The withholding rate applied as per the treaty. Must be a percentage with up to two decimals (e.g., 12.50, 0).. Allowed values: 0, 0.0, 0.00, 5, 5.5, 10, 12.50, 15, 20, 25 (and 1 more) | [optional] |
30
30
  | **income_type** | **String** | The type of income covered by the treaty. | [optional] |
31
31
  | **signer_name** | **String** | The name of the signer of the form. | [optional] |
32
32
  | **e_delivery_consented_at** | **Time** | The date when e-delivery was consented. | [optional] |
@@ -17,7 +17,7 @@ module AvalaraSdk::A1099
17
17
  if (api_client.nil?)
18
18
  fail ArgumentError,'api_client is nil'
19
19
  end
20
- api_client.set_sdk_version("25.10.0")
20
+ api_client.set_sdk_version("25.10.1")
21
21
  @api_client = api_client
22
22
  end
23
23
 
@@ -17,7 +17,7 @@ module AvalaraSdk::A1099
17
17
  if (api_client.nil?)
18
18
  fail ArgumentError,'api_client is nil'
19
19
  end
20
- api_client.set_sdk_version("25.10.0")
20
+ api_client.set_sdk_version("25.10.1")
21
21
  @api_client = api_client
22
22
  end
23
23
 
@@ -17,7 +17,7 @@ module AvalaraSdk::A1099
17
17
  if (api_client.nil?)
18
18
  fail ArgumentError,'api_client is nil'
19
19
  end
20
- api_client.set_sdk_version("25.10.0")
20
+ api_client.set_sdk_version("25.10.1")
21
21
  @api_client = api_client
22
22
  end
23
23
 
@@ -571,6 +571,92 @@ module AvalaraSdk::A1099
571
571
  return data, response.code, response.headers
572
572
  end
573
573
 
574
+ # Download the PDF for a W9/W4/W8 form.
575
+ # Returns the PDF file for a W9/W4/W8 form.
576
+ # @param id [String] Id of the form # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param 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/) .
577
+ # @return [nil]
578
+ def get_w9_form_pdf(request_parameters)
579
+ get_w9_form_pdf_with_http_info(request_parameters)
580
+ nil
581
+ end
582
+
583
+ # Download the PDF for a W9/W4/W8 form.
584
+ # Returns the PDF file for a W9/W4/W8 form.
585
+
586
+ # @param id [String] Id of the form
587
+ # @param avalara_version [String] API version
588
+ # @param x_correlation_id [String] Unique correlation Id in a GUID format
589
+ # @param 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/) .
590
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
591
+ def get_w9_form_pdf_with_http_info(request_parameters)
592
+ # OAuth2 Scopes
593
+ required_scopes = ''
594
+ # Request Parameters
595
+ id = request_parameters.get_id()
596
+ avalara_version = request_parameters.get_avalara_version()
597
+ x_correlation_id = request_parameters.get_x_correlation_id()
598
+ x_avalara_client = request_parameters.get_x_avalara_client()
599
+ # verify the required parameter 'id' is set
600
+ if @api_client.config.client_side_validation && id.nil?
601
+ fail ArgumentError, "Missing the required parameter 'id' when calling FormsW9Api.get_w9_form_pdf"
602
+ end
603
+ # verify the required parameter 'avalara_version' is set
604
+ if @api_client.config.client_side_validation && avalara_version.nil?
605
+ fail ArgumentError, "Missing the required parameter 'avalara_version' when calling FormsW9Api.get_w9_form_pdf"
606
+ end
607
+ # resource path
608
+ local_var_path = '/w9/forms/{id}/pdf'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
609
+
610
+ # query parameters
611
+ query_params = {}
612
+
613
+ # header parameters
614
+ header_params = {}
615
+ # HTTP header 'Accept' (if needed)
616
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
617
+ if !avalara_version.nil?
618
+ header_params[:'avalara-version'] = avalara_version
619
+ end
620
+ if !x_correlation_id.nil?
621
+ header_params[:'X-Correlation-Id'] = x_correlation_id
622
+ end
623
+ if !x_avalara_client.nil?
624
+ header_params[:'X-Avalara-Client'] = x_avalara_client
625
+ end
626
+
627
+ # form parameters
628
+ form_params = {}
629
+
630
+ # http body (model)
631
+ post_body = {}
632
+
633
+ # return_type
634
+ return_type = ''
635
+
636
+ # auth_names
637
+ auth_names = ['bearer']
638
+
639
+ @api_client.apply_auth_to_request!(header_params, auth_names, required_scopes)
640
+
641
+ new_options = {
642
+ :operation => :"FormsW9Api.get_w9_form_pdf",
643
+ :header_params => header_params,
644
+ :query_params => query_params,
645
+ :form_params => form_params,
646
+ :body => post_body,
647
+ :auth_names => auth_names,
648
+ :return_type => return_type
649
+ }
650
+
651
+ response = @api_client.call_api(:GET, local_var_path, new_options, required_scopes, false, :A1099)
652
+ if new_options[:return_type]
653
+ data = deserialize(response, new_options[:return_type])
654
+ else
655
+ data = nil
656
+ end
657
+ return data, response.code, response.headers
658
+ end
659
+
574
660
  # List W9/W4/W8 forms
575
661
  # List W9/W4/W8 forms. Filterable/Sortable fields are: \"companyId\", \"type\", \"displayName\", \"entryStatus\", \"email\", \"archived\" and \"referenceId\".
576
662
  # @param avalara_version [String] API version # @param 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;. # @param top [Integer] If zero or greater than 1000, return at most 1000 results. Otherwise, return this number of results. Used with skip to provide pagination for large datasets. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. # @param order_by [String] A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. # @param count [Boolean] If true, return the global count of elements in the collection. # @param count_only [Boolean] If true, return ONLY the global count of elements in the collection. It only applies when count&#x3D;true. # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param 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/) .
@@ -1160,6 +1246,57 @@ module AvalaraSdk::A1099
1160
1246
  @x_avalara_client = x_avalara_client
1161
1247
  end
1162
1248
  end
1249
+ # Represents the Request object for the GetW9FormPdf API
1250
+ #
1251
+ # @param String $id Id of the form (required)
1252
+ # @param String $avalara_version API version (required)
1253
+ # @param String $x_correlation_id Unique correlation Id in a GUID format (optional)
1254
+ # @param String $x_avalara_client 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)
1255
+ #
1256
+ class GetW9FormPdfRequestSdk
1257
+ attr_accessor :id
1258
+
1259
+ attr_accessor :avalara_version
1260
+
1261
+ attr_accessor :x_correlation_id
1262
+
1263
+ attr_accessor :x_avalara_client
1264
+
1265
+ def initialize()
1266
+ end
1267
+
1268
+ def get_id()
1269
+ return @id
1270
+ end
1271
+
1272
+ def set_id(id)
1273
+ @id = id
1274
+ end
1275
+
1276
+ def get_avalara_version()
1277
+ return @avalara_version || '2.0'
1278
+ end
1279
+
1280
+ def set_avalara_version(avalara_version)
1281
+ @avalara_version = avalara_version
1282
+ end
1283
+
1284
+ def get_x_correlation_id()
1285
+ return @x_correlation_id
1286
+ end
1287
+
1288
+ def set_x_correlation_id(x_correlation_id)
1289
+ @x_correlation_id = x_correlation_id
1290
+ end
1291
+
1292
+ def get_x_avalara_client()
1293
+ return @x_avalara_client
1294
+ end
1295
+
1296
+ def set_x_avalara_client(x_avalara_client)
1297
+ @x_avalara_client = x_avalara_client
1298
+ end
1299
+ end
1163
1300
  # Represents the Request object for the ListW9Forms API
1164
1301
  #
1165
1302
  # @param String $avalara_version API version (required)