Package Avalara.SDK.api.A1099.V2

Class CompaniesW9Api

java.lang.Object

Avalara.SDK.api.A1099.V2.CompaniesW9Api

public class CompaniesW9Api
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CompaniesW9Api.CreateCompanyRequest	Represents the Request object for the CreateCompany API
class	CompaniesW9Api.DeleteCompanyRequest	Represents the Request object for the DeleteCompany API
class	CompaniesW9Api.GetCompaniesRequest	Represents the Request object for the GetCompanies API
class	CompaniesW9Api.GetCompanyRequest	Represents the Request object for the GetCompany API
class	CompaniesW9Api.UpdateCompanyRequest	Represents the Request object for the UpdateCompany API

Constructor Summary

Constructors

Constructor	Description
CompaniesW9Api(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CompanyResponse	createCompany(CompaniesW9Api.CreateCompanyRequest requestParameters)	Create a company Create a company.
okhttp3.Call	createCompanyAsync(CompaniesW9Api.CreateCompanyRequest requestParameters, ApiCallback<CompanyResponse> _callback)	Create a company (asynchronously) Create a company.
okhttp3.Call	createCompanyCall(CompaniesW9Api.CreateCompanyRequest requestParameters, ApiCallback _callback)	Build call for createCompany
ApiResponse<CompanyResponse>	createCompanyWithHttpInfo(CompaniesW9Api.CreateCompanyRequest requestParameters)	Create a company Create a company.
void	deleteCompany(CompaniesW9Api.DeleteCompanyRequest requestParameters)	Delete a company Delete a company.
okhttp3.Call	deleteCompanyAsync(CompaniesW9Api.DeleteCompanyRequest requestParameters, ApiCallback<Void> _callback)	Delete a company (asynchronously) Delete a company.
okhttp3.Call	deleteCompanyCall(CompaniesW9Api.DeleteCompanyRequest requestParameters, ApiCallback _callback)	Build call for deleteCompany
ApiResponse<Void>	deleteCompanyWithHttpInfo(CompaniesW9Api.DeleteCompanyRequest requestParameters)	Delete a company Delete a company.
ApiClient	getApiClient()
PaginatedQueryResultModelCompanyResponse	getCompanies(CompaniesW9Api.GetCompaniesRequest requestParameters)	List companies List existing companies.
okhttp3.Call	getCompaniesAsync(CompaniesW9Api.GetCompaniesRequest requestParameters, ApiCallback<PaginatedQueryResultModelCompanyResponse> _callback)	List companies (asynchronously) List existing companies.
okhttp3.Call	getCompaniesCall(CompaniesW9Api.GetCompaniesRequest requestParameters, ApiCallback _callback)	Build call for getCompanies
ApiResponse<PaginatedQueryResultModelCompanyResponse>	getCompaniesWithHttpInfo(CompaniesW9Api.GetCompaniesRequest requestParameters)	List companies List existing companies.
CompanyResponse	getCompany(CompaniesW9Api.GetCompanyRequest requestParameters)	Retrieve a company Retrieve a company.
okhttp3.Call	getCompanyAsync(CompaniesW9Api.GetCompanyRequest requestParameters, ApiCallback<CompanyResponse> _callback)	Retrieve a company (asynchronously) Retrieve a company.
okhttp3.Call	getCompanyCall(CompaniesW9Api.GetCompanyRequest requestParameters, ApiCallback _callback)	Build call for getCompany
ApiResponse<CompanyResponse>	getCompanyWithHttpInfo(CompaniesW9Api.GetCompanyRequest requestParameters)	Retrieve a company Retrieve a company.
CompaniesW9Api.CreateCompanyRequest	getCreateCompanyRequest()	Getter function to instantiate Request class
String	getCustomBaseUrl()
CompaniesW9Api.DeleteCompanyRequest	getDeleteCompanyRequest()	Getter function to instantiate Request class
CompaniesW9Api.GetCompaniesRequest	getGetCompaniesRequest()	Getter function to instantiate Request class
CompaniesW9Api.GetCompanyRequest	getGetCompanyRequest()	Getter function to instantiate Request class
int	getHostIndex()
CompaniesW9Api.UpdateCompanyRequest	getUpdateCompanyRequest()	Getter function to instantiate Request class
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)
CompanyResponse	updateCompany(CompaniesW9Api.UpdateCompanyRequest requestParameters)	Update a company Update a company.
okhttp3.Call	updateCompanyAsync(CompaniesW9Api.UpdateCompanyRequest requestParameters, ApiCallback<CompanyResponse> _callback)	Update a company (asynchronously) Update a company.
okhttp3.Call	updateCompanyCall(CompaniesW9Api.UpdateCompanyRequest requestParameters, ApiCallback _callback)	Build call for updateCompany
ApiResponse<CompanyResponse>	updateCompanyWithHttpInfo(CompaniesW9Api.UpdateCompanyRequest requestParameters)	Update a company Update a company.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CompaniesW9Api

public CompaniesW9Api(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createCompanyCall

public okhttp3.Call createCompanyCall(CompaniesW9Api.CreateCompanyRequest requestParameters,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createCompany

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created company	-
400	Bad request (e.g., model validation failed)	-
401	Authentication failed	-

createCompany

public CompanyResponse createCompany(CompaniesW9Api.CreateCompanyRequest requestParameters)
                              throws ApiException

Create a company Create a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

CompanyResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created company	-
400	Bad request (e.g., model validation failed)	-
401	Authentication failed	-

createCompanyWithHttpInfo

public ApiResponse<CompanyResponse> createCompanyWithHttpInfo(CompaniesW9Api.CreateCompanyRequest requestParameters)
                                                       throws ApiException

Create a company Create a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<CompanyResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
201	Created company	-
400	Bad request (e.g., model validation failed)	-
401	Authentication failed	-

createCompanyAsync

public okhttp3.Call createCompanyAsync(CompaniesW9Api.CreateCompanyRequest requestParameters,
                                       ApiCallback<CompanyResponse> _callback)
                                throws ApiException

Create a company (asynchronously) Create a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
201	Created company	-
400	Bad request (e.g., model validation failed)	-
401	Authentication failed	-

getCreateCompanyRequest

public CompaniesW9Api.CreateCompanyRequest getCreateCompanyRequest()

Getter function to instantiate Request class

deleteCompanyCall

public okhttp3.Call deleteCompanyCall(CompaniesW9Api.DeleteCompanyRequest requestParameters,
                                      ApiCallback _callback)
                               throws ApiException

Build call for deleteCompany

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Company deleted	-
401	Authentication failed.	-
404	Company was not found or your user does not have to permission to delete it.	-
409	Company can't be deleted since it still have forms associated with it.	-
500	An error happened while attempting to delete the company.	-

deleteCompany

public void deleteCompany(CompaniesW9Api.DeleteCompanyRequest requestParameters)
                   throws ApiException

Delete a company Delete a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Company deleted	-
401	Authentication failed.	-
404	Company was not found or your user does not have to permission to delete it.	-
409	Company can't be deleted since it still have forms associated with it.	-
500	An error happened while attempting to delete the company.	-

deleteCompanyWithHttpInfo

public ApiResponse<Void> deleteCompanyWithHttpInfo(CompaniesW9Api.DeleteCompanyRequest requestParameters)
                                            throws ApiException

Delete a company Delete a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<Void>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
204	Company deleted	-
401	Authentication failed.	-
404	Company was not found or your user does not have to permission to delete it.	-
409	Company can't be deleted since it still have forms associated with it.	-
500	An error happened while attempting to delete the company.	-

deleteCompanyAsync

public okhttp3.Call deleteCompanyAsync(CompaniesW9Api.DeleteCompanyRequest requestParameters,
                                       ApiCallback<Void> _callback)
                                throws ApiException

Delete a company (asynchronously) Delete a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
204	Company deleted	-
401	Authentication failed.	-
404	Company was not found or your user does not have to permission to delete it.	-
409	Company can't be deleted since it still have forms associated with it.	-
500	An error happened while attempting to delete the company.	-

getDeleteCompanyRequest

public CompaniesW9Api.DeleteCompanyRequest getDeleteCompanyRequest()

Getter function to instantiate Request class

getCompaniesCall

public okhttp3.Call getCompaniesCall(CompaniesW9Api.GetCompaniesRequest requestParameters,
                                     ApiCallback _callback)
                              throws ApiException

Build call for getCompanies

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List of companies	-
400	Bad request (e.g., invalid sort key)	-
404	Not Found	-
500	Server Error	-
401	Authentication failed	-

getCompanies

public PaginatedQueryResultModelCompanyResponse getCompanies(CompaniesW9Api.GetCompaniesRequest requestParameters)
                                                      throws ApiException

List companies List existing companies. Filterable/Sortable fields are: \"name\", \"referenceId\", \"group.name\", \"createdAt\" and \"updatedAt\".

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

PaginatedQueryResultModelCompanyResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	List of companies	-
400	Bad request (e.g., invalid sort key)	-
404	Not Found	-
500	Server Error	-
401	Authentication failed	-

getCompaniesWithHttpInfo

public ApiResponse<PaginatedQueryResultModelCompanyResponse> getCompaniesWithHttpInfo(CompaniesW9Api.GetCompaniesRequest requestParameters)
                                                                               throws ApiException

List companies List existing companies. Filterable/Sortable fields are: \"name\", \"referenceId\", \"group.name\", \"createdAt\" and \"updatedAt\".

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<PaginatedQueryResultModelCompanyResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	List of companies	-
400	Bad request (e.g., invalid sort key)	-
404	Not Found	-
500	Server Error	-
401	Authentication failed	-

getCompaniesAsync

public okhttp3.Call getCompaniesAsync(CompaniesW9Api.GetCompaniesRequest requestParameters,
                                      ApiCallback<PaginatedQueryResultModelCompanyResponse> _callback)
                               throws ApiException

List companies (asynchronously) List existing companies. Filterable/Sortable fields are: \"name\", \"referenceId\", \"group.name\", \"createdAt\" and \"updatedAt\".

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	List of companies	-
400	Bad request (e.g., invalid sort key)	-
404	Not Found	-
500	Server Error	-
401	Authentication failed	-

getGetCompaniesRequest

public CompaniesW9Api.GetCompaniesRequest getGetCompaniesRequest()

Getter function to instantiate Request class

getCompanyCall

public okhttp3.Call getCompanyCall(CompaniesW9Api.GetCompanyRequest requestParameters,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getCompany

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single company	-
400	Bad request (e.g., invalid sort key)	-
404	Company not found	-
500	Server Error	-
401	Authentication failed	-

getCompany

public CompanyResponse getCompany(CompaniesW9Api.GetCompanyRequest requestParameters)
                           throws ApiException

Retrieve a company Retrieve a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

CompanyResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single company	-
400	Bad request (e.g., invalid sort key)	-
404	Company not found	-
500	Server Error	-
401	Authentication failed	-

getCompanyWithHttpInfo

public ApiResponse<CompanyResponse> getCompanyWithHttpInfo(CompaniesW9Api.GetCompanyRequest requestParameters)
                                                    throws ApiException

Retrieve a company Retrieve a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<CompanyResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Single company	-
400	Bad request (e.g., invalid sort key)	-
404	Company not found	-
500	Server Error	-
401	Authentication failed	-

getCompanyAsync

public okhttp3.Call getCompanyAsync(CompaniesW9Api.GetCompanyRequest requestParameters,
                                    ApiCallback<CompanyResponse> _callback)
                             throws ApiException

Retrieve a company (asynchronously) Retrieve a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Single company	-
400	Bad request (e.g., invalid sort key)	-
404	Company not found	-
500	Server Error	-
401	Authentication failed	-

getGetCompanyRequest

public CompaniesW9Api.GetCompanyRequest getGetCompanyRequest()

Getter function to instantiate Request class

updateCompanyCall

public okhttp3.Call updateCompanyCall(CompaniesW9Api.UpdateCompanyRequest requestParameters,
                                      ApiCallback _callback)
                               throws ApiException

Build call for updateCompany

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Updated company	-
400	Bad request (e.g., model validation failed)	-
401	Authentication failed	-
404	Company not found	-

updateCompany

public CompanyResponse updateCompany(CompaniesW9Api.UpdateCompanyRequest requestParameters)
                              throws ApiException

Update a company Update a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

CompanyResponse

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Updated company	-
400	Bad request (e.g., model validation failed)	-
401	Authentication failed	-
404	Company not found	-

updateCompanyWithHttpInfo

public ApiResponse<CompanyResponse> updateCompanyWithHttpInfo(CompaniesW9Api.UpdateCompanyRequest requestParameters)
                                                       throws ApiException

Update a company Update a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

Returns:

ApiResponse<CompanyResponse>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	Updated company	-
400	Bad request (e.g., model validation failed)	-
401	Authentication failed	-
404	Company not found	-

updateCompanyAsync

public okhttp3.Call updateCompanyAsync(CompaniesW9Api.UpdateCompanyRequest requestParameters,
                                       ApiCallback<CompanyResponse> _callback)
                                throws ApiException

Update a company (asynchronously) Update a company.

Parameters:

requestOptions - Object which represents the options available for a given API/request

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	Updated company	-
400	Bad request (e.g., model validation failed)	-
401	Authentication failed	-
404	Company not found	-

getUpdateCompanyRequest

public CompaniesW9Api.UpdateCompanyRequest getUpdateCompanyRequest()

Getter function to instantiate Request class