Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
115 changes: 76 additions & 39 deletions README.md

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion docs/A1099/V2/BulkUpsert1099FormsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ require 'avalara_sdk'
AvalaraSdk::A1099::V2::BulkUpsert1099FormsRequest.openapi_one_of
# =>
# [
# :'Form1042SList',
# :'Form1095BList',
# :'Form1099DivList',
# :'Form1099KList',
Expand All @@ -33,7 +34,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
require 'avalara_sdk'

AvalaraSdk::A1099::V2::BulkUpsert1099FormsRequest.build(data)
# => #<Form1095BList:0x00007fdd4aab02a0>
# => #<Form1042SList:0x00007fdd4aab02a0>

AvalaraSdk::A1099::V2::BulkUpsert1099FormsRequest.build(data_that_doesnt_match)
# => nil
Expand All @@ -47,6 +48,7 @@ AvalaraSdk::A1099::V2::BulkUpsert1099FormsRequest.build(data_that_doesnt_match)

#### Return type

- `Form1042SList`
- `Form1095BList`
- `Form1099DivList`
- `Form1099KList`
Expand Down
44 changes: 22 additions & 22 deletions docs/A1099/V2/CompaniesW9Api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**create_company**](CompaniesW9Api.md#create_company) | **POST** /w9/companies | Creates a new company |
| [**delete_company**](CompaniesW9Api.md#delete_company) | **DELETE** /w9/companies/{id} | Deletes a company |
| [**create_company**](CompaniesW9Api.md#create_company) | **POST** /w9/companies | Create a company |
| [**delete_company**](CompaniesW9Api.md#delete_company) | **DELETE** /w9/companies/{id} | Delete a company |
| [**get_companies**](CompaniesW9Api.md#get_companies) | **GET** /w9/companies | List companies |
| [**get_company**](CompaniesW9Api.md#get_company) | **GET** /w9/companies/{id} | Retrieve a company |
| [**update_company**](CompaniesW9Api.md#update_company) | **PUT** /w9/companies/{id} | Update a company |
Expand All @@ -15,9 +15,9 @@ All URIs are relative to *https://api-ava1099.eta.sbx.us-east-1.aws.avalara.io/a

> <CompanyResponseModel> create_company(avalara_version, opts)

Creates a new company
Create a company

Creates a new company
Create a company.

### Examples

Expand All @@ -37,15 +37,15 @@ end
api_client = AvalaraSdk::ApiClient.new config
api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client

avalara_version = '2.0' # String | API version
avalara_version = '2.0.0' # String | API version
opts = {
x_correlation_id: 'd0e29cf5-55bc-44e6-9894-3e1cd2923e5a', # String | Unique correlation Id in a GUID format
x_correlation_id: '144f810d-5777-472b-b372-c1028d9a13ae', # String | Unique correlation Id in a GUID format
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/) .
company_create_update_request_model: AvalaraSdk::A1099::V2::CompanyCreateUpdateRequestModel.new # CompanyCreateUpdateRequestModel | The company to create
}

begin
# Creates a new company
# Create a company
result = api_instance.create_company(avalara_version, opts)
p result
rescue AvalaraSdk::ApiError => e
Expand All @@ -61,7 +61,7 @@ This returns an Array which contains the response data, status code and headers.

```ruby
begin
# Creates a new company
# Create a company
data, status_code, headers = api_instance.create_company_with_http_info(avalara_version, opts)
p status_code # => 2xx
p headers # => { ... }
Expand Down Expand Up @@ -98,9 +98,9 @@ end

> delete_company(id, avalara_version, opts)

Deletes a company
Delete a company

Deletes a company
Delete a company.

### Examples

Expand All @@ -121,14 +121,14 @@ api_client = AvalaraSdk::ApiClient.new config
api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client

id = 'id_example' # String | The company to delete
avalara_version = '2.0' # String | API version
avalara_version = '2.0.0' # String | API version
opts = {
x_correlation_id: '713ec82b-b94e-4e2f-8b82-0cecc0abb124', # String | Unique correlation Id in a GUID format
x_correlation_id: 'db071c51-528f-4929-a031-523aa34002d1', # String | Unique correlation Id in a GUID format
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/) .
}

begin
# Deletes a company
# Delete a company
api_instance.delete_company(id, avalara_version, opts)
rescue AvalaraSdk::ApiError => e
puts "Error when calling CompaniesW9Api->delete_company: #{e}"
Expand All @@ -143,7 +143,7 @@ This returns an Array which contains the response data (`nil` in this case), sta

```ruby
begin
# Deletes a company
# Delete a company
data, status_code, headers = api_instance.delete_company_with_http_info(id, avalara_version, opts)
p status_code # => 2xx
p headers # => { ... }
Expand Down Expand Up @@ -202,15 +202,15 @@ end
api_client = AvalaraSdk::ApiClient.new config
api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client

avalara_version = '2.0' # String | API version
avalara_version = '2.0.0' # String | API version
opts = {
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>.
top: 56, # 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.
skip: 56, # Integer | If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets.
order_by: 'order_by_example', # String | A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.
count: true, # Boolean | If true, return the global count of elements in the collection.
count_only: true, # Boolean | If true, return ONLY the global count of elements in the collection. It only applies when count=true.
x_correlation_id: '38d61b75-2ccf-4a20-8fc0-6fc047805ec3', # String | Unique correlation Id in a GUID format
x_correlation_id: '7ad30f3a-b27d-440e-98da-516663741d89', # String | Unique correlation Id in a GUID format
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/) .
}

Expand Down Expand Up @@ -275,7 +275,7 @@ end

Retrieve a company

Retrieve an existing company
Retrieve a company.

### Examples

Expand All @@ -296,9 +296,9 @@ api_client = AvalaraSdk::ApiClient.new config
api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client

id = 'id_example' # String | Id of the company
avalara_version = '2.0' # String | API version
avalara_version = '2.0.0' # String | API version
opts = {
x_correlation_id: 'dccf03ba-f1c1-4540-a0ab-3a642cb46223', # String | Unique correlation Id in a GUID format
x_correlation_id: '77521b27-805c-40b1-a6c8-3d6339acba99', # String | Unique correlation Id in a GUID format
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/) .
}

Expand Down Expand Up @@ -358,7 +358,7 @@ end

Update a company

Update a company
Update a company.

### Examples

Expand All @@ -379,9 +379,9 @@ api_client = AvalaraSdk::ApiClient.new config
api_instance = AvalaraSdk::A1099::V2::CompaniesW9Api.new api_client

id = 'id_example' # String | The ID of the company to update
avalara_version = '2.0' # String | API version
avalara_version = '2.0.0' # String | API version
opts = {
x_correlation_id: 'e5197be7-4ab7-4f90-a190-c0a491ebb8e1', # String | Unique correlation Id in a GUID format
x_correlation_id: '9b982dee-5208-416e-8acf-84070e235acc', # String | Unique correlation Id in a GUID format
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/) .
company_create_update_request_model: AvalaraSdk::A1099::V2::CompanyCreateUpdateRequestModel.new # CompanyCreateUpdateRequestModel | The updated company data
}
Expand Down
56 changes: 56 additions & 0 deletions docs/A1099/V2/CoveredIndividualReferenceResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# AvalaraSdk::A1099::V2::CoveredIndividualReferenceResponse

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | Covered individual ID | [optional] |
| **first_name** | **String** | Covered individual&#39;s first name | [optional] |
| **middle_name** | **String** | Covered individual&#39;s middle name | [optional] |
| **last_name** | **String** | Covered individual&#39;s last name | [optional] |
| **name_suffix** | **String** | Covered individual&#39;s name suffix | [optional] |
| **tin** | **String** | Covered individual&#39;s TIN (SSN or ITIN) | [optional] |
| **birth_date** | **Time** | Covered individual&#39;s date of birth | [optional] |
| **covered_month0** | **Boolean** | Coverage indicator for all 12 months | [optional] |
| **covered_month1** | **Boolean** | Coverage indicator for January | [optional] |
| **covered_month2** | **Boolean** | Coverage indicator for February | [optional] |
| **covered_month3** | **Boolean** | Coverage indicator for March | [optional] |
| **covered_month4** | **Boolean** | Coverage indicator for April | [optional] |
| **covered_month5** | **Boolean** | Coverage indicator for May | [optional] |
| **covered_month6** | **Boolean** | Coverage indicator for June | [optional] |
| **covered_month7** | **Boolean** | Coverage indicator for July | [optional] |
| **covered_month8** | **Boolean** | Coverage indicator for August | [optional] |
| **covered_month9** | **Boolean** | Coverage indicator for September | [optional] |
| **covered_month10** | **Boolean** | Coverage indicator for October | [optional] |
| **covered_month11** | **Boolean** | Coverage indicator for November | [optional] |
| **covered_month12** | **Boolean** | Coverage indicator for December | [optional] |

## Example

```ruby
require 'avalara_sdk'

instance = AvalaraSdk::A1099::V2::CoveredIndividualReferenceResponse.new(
id: null,
first_name: null,
middle_name: null,
last_name: null,
name_suffix: null,
tin: null,
birth_date: null,
covered_month0: null,
covered_month1: null,
covered_month2: null,
covered_month3: null,
covered_month4: null,
covered_month5: null,
covered_month6: null,
covered_month7: null,
covered_month8: null,
covered_month9: null,
covered_month10: null,
covered_month11: null,
covered_month12: null
)
```

38 changes: 19 additions & 19 deletions docs/A1099/V2/CoveredIndividualRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,25 @@

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **first_name** | **String** | | [optional] |
| **middle_name** | **String** | | [optional] |
| **last_name** | **String** | | [optional] |
| **name_suffix** | **String** | | [optional] |
| **tin** | **String** | | [optional] |
| **birth_date** | **Time** | | [optional] |
| **covered_month_indicator0** | **Boolean** | | [optional] |
| **covered_month_indicator1** | **Boolean** | | [optional] |
| **covered_month_indicator2** | **Boolean** | | [optional] |
| **covered_month_indicator3** | **Boolean** | | [optional] |
| **covered_month_indicator4** | **Boolean** | | [optional] |
| **covered_month_indicator5** | **Boolean** | | [optional] |
| **covered_month_indicator6** | **Boolean** | | [optional] |
| **covered_month_indicator7** | **Boolean** | | [optional] |
| **covered_month_indicator8** | **Boolean** | | [optional] |
| **covered_month_indicator9** | **Boolean** | | [optional] |
| **covered_month_indicator10** | **Boolean** | | [optional] |
| **covered_month_indicator11** | **Boolean** | | [optional] |
| **covered_month_indicator12** | **Boolean** | | [optional] |
| **first_name** | **String** | Covered individual&#39;s first name | [optional] |
| **middle_name** | **String** | Covered individual&#39;s middle name | [optional] |
| **last_name** | **String** | Covered individual&#39;s last name | [optional] |
| **name_suffix** | **String** | Covered individual&#39;s name suffix | [optional] |
| **tin** | **String** | Covered individual&#39;s TIN (SSN or ITIN) | [optional] |
| **birth_date** | **Time** | Covered individual&#39;s date of birth | [optional] |
| **covered_month_indicator0** | **Boolean** | Coverage indicator for all 12 months | [optional] |
| **covered_month_indicator1** | **Boolean** | Coverage indicator for January | [optional] |
| **covered_month_indicator2** | **Boolean** | Coverage indicator for February | [optional] |
| **covered_month_indicator3** | **Boolean** | Coverage indicator for March | [optional] |
| **covered_month_indicator4** | **Boolean** | Coverage indicator for April | [optional] |
| **covered_month_indicator5** | **Boolean** | Coverage indicator for May | [optional] |
| **covered_month_indicator6** | **Boolean** | Coverage indicator for June | [optional] |
| **covered_month_indicator7** | **Boolean** | Coverage indicator for July | [optional] |
| **covered_month_indicator8** | **Boolean** | Coverage indicator for August | [optional] |
| **covered_month_indicator9** | **Boolean** | Coverage indicator for September | [optional] |
| **covered_month_indicator10** | **Boolean** | Coverage indicator for October | [optional] |
| **covered_month_indicator11** | **Boolean** | Coverage indicator for November | [optional] |
| **covered_month_indicator12** | **Boolean** | Coverage indicator for December | [optional] |

## Example

Expand Down
59 changes: 59 additions & 0 deletions docs/A1099/V2/Create1099Form201Response.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# AvalaraSdk::A1099::V2::Create1099Form201Response

## Class instance methods

### `openapi_one_of`

Returns the list of classes defined in oneOf.

#### Example

```ruby
require 'avalara_sdk'

AvalaraSdk::A1099::V2::Create1099Form201Response.openapi_one_of
# =>
# [
# :'Form1042SListItemResponse',
# :'Form1095BListItemResponse',
# :'Form1099BaseResponse',
# :'Form1099KListItemResponse',
# :'Form1099MiscListItemResponse',
# :'Form1099NecListItemResponse',
# :'Form1099RListItemResponse'
# ]
```

### build

Find the appropriate object from the `openapi_one_of` list and casts the data into it.

#### Example

```ruby
require 'avalara_sdk'

AvalaraSdk::A1099::V2::Create1099Form201Response.build(data)
# => #<Form1042SListItemResponse:0x00007fdd4aab02a0>

AvalaraSdk::A1099::V2::Create1099Form201Response.build(data_that_doesnt_match)
# => nil
```

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| **data** | **Mixed** | data to be matched against the list of oneOf items |

#### Return type

- `Form1042SListItemResponse`
- `Form1095BListItemResponse`
- `Form1099BaseResponse`
- `Form1099KListItemResponse`
- `Form1099MiscListItemResponse`
- `Form1099NecListItemResponse`
- `Form1099RListItemResponse`
- `nil` (if no type matches)

55 changes: 55 additions & 0 deletions docs/A1099/V2/CreateW9Form201Response.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# AvalaraSdk::A1099::V2::CreateW9Form201Response

## Class instance methods

### `openapi_one_of`

Returns the list of classes defined in oneOf.

#### Example

```ruby
require 'avalara_sdk'

AvalaraSdk::A1099::V2::CreateW9Form201Response.openapi_one_of
# =>
# [
# :'W4FormResponse',
# :'W8BenEFormResponse',
# :'W8BenFormResponse',
# :'W8ImyFormResponse',
# :'W9FormResponse'
# ]
```

### build

Find the appropriate object from the `openapi_one_of` list and casts the data into it.

#### Example

```ruby
require 'avalara_sdk'

AvalaraSdk::A1099::V2::CreateW9Form201Response.build(data)
# => #<W4FormResponse:0x00007fdd4aab02a0>

AvalaraSdk::A1099::V2::CreateW9Form201Response.build(data_that_doesnt_match)
# => nil
```

#### Parameters

| Name | Type | Description |
| ---- | ---- | ----------- |
| **data** | **Mixed** | data to be matched against the list of oneOf items |

#### Return type

- `W4FormResponse`
- `W8BenEFormResponse`
- `W8BenFormResponse`
- `W8ImyFormResponse`
- `W9FormResponse`
- `nil` (if no type matches)

Loading