it.fattureincloud.sdk.api

Class ProductsApi

java.lang.Object

it.fattureincloud.sdk.api.ProductsApi

public class ProductsApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ProductsApi()
ProductsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CreateProductResponse	createProduct(java.lang.Integer companyId, CreateProductRequest createProductRequest) Create Product Creates a new product.
okhttp3.Call	createProductAsync(java.lang.Integer companyId, CreateProductRequest createProductRequest, ApiCallback<CreateProductResponse> _callback) Create Product (asynchronously) Creates a new product.
okhttp3.Call	createProductCall(java.lang.Integer companyId, CreateProductRequest createProductRequest, ApiCallback _callback) Build call for createProduct
ApiResponse<CreateProductResponse>	createProductWithHttpInfo(java.lang.Integer companyId, CreateProductRequest createProductRequest) Create Product Creates a new product.
void	deleteProduct(java.lang.Integer companyId, java.lang.Integer productId) Delete Product Deletes the specified product.
okhttp3.Call	deleteProductAsync(java.lang.Integer companyId, java.lang.Integer productId, ApiCallback<java.lang.Void> _callback) Delete Product (asynchronously) Deletes the specified product.
okhttp3.Call	deleteProductCall(java.lang.Integer companyId, java.lang.Integer productId, ApiCallback _callback) Build call for deleteProduct
ApiResponse<java.lang.Void>	deleteProductWithHttpInfo(java.lang.Integer companyId, java.lang.Integer productId) Delete Product Deletes the specified product.
ApiClient	getApiClient()
java.lang.String	getCustomBaseUrl()
int	getHostIndex()
GetProductResponse	getProduct(java.lang.Integer companyId, java.lang.Integer productId, java.lang.String fields, java.lang.String fieldset) Get Product Gets the specified product.
okhttp3.Call	getProductAsync(java.lang.Integer companyId, java.lang.Integer productId, java.lang.String fields, java.lang.String fieldset, ApiCallback<GetProductResponse> _callback) Get Product (asynchronously) Gets the specified product.
okhttp3.Call	getProductCall(java.lang.Integer companyId, java.lang.Integer productId, java.lang.String fields, java.lang.String fieldset, ApiCallback _callback) Build call for getProduct
ApiResponse<GetProductResponse>	getProductWithHttpInfo(java.lang.Integer companyId, java.lang.Integer productId, java.lang.String fields, java.lang.String fieldset) Get Product Gets the specified product.
ListProductsResponse	listProducts(java.lang.Integer companyId, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q) List Products Lists the products.
okhttp3.Call	listProductsAsync(java.lang.Integer companyId, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q, ApiCallback<ListProductsResponse> _callback) List Products (asynchronously) Lists the products.
okhttp3.Call	listProductsCall(java.lang.Integer companyId, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q, ApiCallback _callback) Build call for listProducts
ApiResponse<ListProductsResponse>	listProductsWithHttpInfo(java.lang.Integer companyId, java.lang.String fields, java.lang.String fieldset, java.lang.String sort, java.lang.Integer page, java.lang.Integer perPage, java.lang.String q) List Products Lists the products.
ModifyProductResponse	modifyProduct(java.lang.Integer companyId, java.lang.Integer productId, ModifyProductRequest modifyProductRequest) Modify Product Modifies the specified product.
okhttp3.Call	modifyProductAsync(java.lang.Integer companyId, java.lang.Integer productId, ModifyProductRequest modifyProductRequest, ApiCallback<ModifyProductResponse> _callback) Modify Product (asynchronously) Modifies the specified product.
okhttp3.Call	modifyProductCall(java.lang.Integer companyId, java.lang.Integer productId, ModifyProductRequest modifyProductRequest, ApiCallback _callback) Build call for modifyProduct
ApiResponse<ModifyProductResponse>	modifyProductWithHttpInfo(java.lang.Integer companyId, java.lang.Integer productId, ModifyProductRequest modifyProductRequest) Modify Product Modifies the specified product.
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(java.lang.String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

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

Constructor Detail

ProductsApi

public ProductsApi()

ProductsApi

public ProductsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public java.lang.String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(java.lang.String customBaseUrl)

createProductCall

public okhttp3.Call createProductCall(java.lang.Integer companyId,
                                      CreateProductRequest createProductRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for createProduct

Parameters:

companyId - The ID of the company. (required)

createProductRequest - (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-

createProduct

public CreateProductResponse createProduct(java.lang.Integer companyId,
                                           CreateProductRequest createProductRequest)
                                    throws ApiException

Create Product Creates a new product.

Parameters:

companyId - The ID of the company. (required)

createProductRequest - (optional)

Returns:

CreateProductResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-

createProductWithHttpInfo

public ApiResponse<CreateProductResponse> createProductWithHttpInfo(java.lang.Integer companyId,
                                                                    CreateProductRequest createProductRequest)
                                                             throws ApiException

Create Product Creates a new product.

Parameters:

companyId - The ID of the company. (required)

createProductRequest - (optional)

Returns:

ApiResponse<CreateProductResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-

createProductAsync

public okhttp3.Call createProductAsync(java.lang.Integer companyId,
                                       CreateProductRequest createProductRequest,
                                       ApiCallback<CreateProductResponse> _callback)
                                throws ApiException

Create Product (asynchronously) Creates a new product.

Parameters:

companyId - The ID of the company. (required)

createProductRequest - (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Example response	-

deleteProductCall

public okhttp3.Call deleteProductCall(java.lang.Integer companyId,
                                      java.lang.Integer productId,
                                      ApiCallback _callback)
                               throws ApiException

Build call for deleteProduct

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Product removed.	-
401	Unauthorized	-
404	Not Found	-

deleteProduct

public void deleteProduct(java.lang.Integer companyId,
                          java.lang.Integer productId)
                   throws ApiException

Delete Product Deletes the specified product.

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Product removed.	-
401	Unauthorized	-
404	Not Found	-

deleteProductWithHttpInfo

public ApiResponse<java.lang.Void> deleteProductWithHttpInfo(java.lang.Integer companyId,
                                                             java.lang.Integer productId)
                                                      throws ApiException

Delete Product Deletes the specified product.

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

Returns:

ApiResponse<Void>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Product removed.	-
401	Unauthorized	-
404	Not Found	-

deleteProductAsync

public okhttp3.Call deleteProductAsync(java.lang.Integer companyId,
                                       java.lang.Integer productId,
                                       ApiCallback<java.lang.Void> _callback)
                                throws ApiException

Delete Product (asynchronously) Deletes the specified product.

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

_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

Response Details

Status Code	Description	Response Headers
200	Product removed.	-
401	Unauthorized	-
404	Not Found	-

getProductCall

public okhttp3.Call getProductCall(java.lang.Integer companyId,
                                   java.lang.Integer productId,
                                   java.lang.String fields,
                                   java.lang.String fieldset,
                                   ApiCallback _callback)
                            throws ApiException

Build call for getProduct

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-
404	Not Found	-

getProduct

public GetProductResponse getProduct(java.lang.Integer companyId,
                                     java.lang.Integer productId,
                                     java.lang.String fields,
                                     java.lang.String fieldset)
                              throws ApiException

Get Product Gets the specified product.

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

Returns:

GetProductResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-
404	Not Found	-

getProductWithHttpInfo

public ApiResponse<GetProductResponse> getProductWithHttpInfo(java.lang.Integer companyId,
                                                              java.lang.Integer productId,
                                                              java.lang.String fields,
                                                              java.lang.String fieldset)
                                                       throws ApiException

Get Product Gets the specified product.

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

Returns:

ApiResponse<GetProductResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-
404	Not Found	-

getProductAsync

public okhttp3.Call getProductAsync(java.lang.Integer companyId,
                                    java.lang.Integer productId,
                                    java.lang.String fields,
                                    java.lang.String fieldset,
                                    ApiCallback<GetProductResponse> _callback)
                             throws ApiException

Get Product (asynchronously) Gets the specified product.

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-
404	Not Found	-

listProductsCall

public okhttp3.Call listProductsCall(java.lang.Integer companyId,
                                     java.lang.String fields,
                                     java.lang.String fieldset,
                                     java.lang.String sort,
                                     java.lang.Integer page,
                                     java.lang.Integer perPage,
                                     java.lang.String q,
                                     ApiCallback _callback)
                              throws ApiException

Build call for listProducts

Parameters:

companyId - The ID of the company. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Products List.	-
401	Unauthorized	-

listProducts

public ListProductsResponse listProducts(java.lang.Integer companyId,
                                         java.lang.String fields,
                                         java.lang.String fieldset,
                                         java.lang.String sort,
                                         java.lang.Integer page,
                                         java.lang.Integer perPage,
                                         java.lang.String q)
                                  throws ApiException

List Products Lists the products.

Parameters:

companyId - The ID of the company. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

Returns:

ListProductsResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Products List.	-
401	Unauthorized	-

listProductsWithHttpInfo

public ApiResponse<ListProductsResponse> listProductsWithHttpInfo(java.lang.Integer companyId,
                                                                  java.lang.String fields,
                                                                  java.lang.String fieldset,
                                                                  java.lang.String sort,
                                                                  java.lang.Integer page,
                                                                  java.lang.Integer perPage,
                                                                  java.lang.String q)
                                                           throws ApiException

List Products Lists the products.

Parameters:

companyId - The ID of the company. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

Returns:

ApiResponse<ListProductsResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Products List.	-
401	Unauthorized	-

listProductsAsync

public okhttp3.Call listProductsAsync(java.lang.Integer companyId,
                                      java.lang.String fields,
                                      java.lang.String fieldset,
                                      java.lang.String sort,
                                      java.lang.Integer page,
                                      java.lang.Integer perPage,
                                      java.lang.String q,
                                      ApiCallback<ListProductsResponse> _callback)
                               throws ApiException

List Products (asynchronously) Lists the products.

Parameters:

companyId - The ID of the company. (required)

fields - List of comma-separated fields. (optional)

fieldset - Name of the fieldset. (optional)

sort - List of comma-separated fields for result sorting (minus for desc sorting). (optional)

page - The page to retrieve. (optional, default to 1)

perPage - The size of the page. (optional, default to 5)

q - Query for filtering the results. (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Products List.	-
401	Unauthorized	-

modifyProductCall

public okhttp3.Call modifyProductCall(java.lang.Integer companyId,
                                      java.lang.Integer productId,
                                      ModifyProductRequest modifyProductRequest,
                                      ApiCallback _callback)
                               throws ApiException

Build call for modifyProduct

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

modifyProductRequest - Modified product details. (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-
404	Not Found	-

modifyProduct

public ModifyProductResponse modifyProduct(java.lang.Integer companyId,
                                           java.lang.Integer productId,
                                           ModifyProductRequest modifyProductRequest)
                                    throws ApiException

Modify Product Modifies the specified product.

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

modifyProductRequest - Modified product details. (optional)

Returns:

ModifyProductResponse

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-
404	Not Found	-

modifyProductWithHttpInfo

public ApiResponse<ModifyProductResponse> modifyProductWithHttpInfo(java.lang.Integer companyId,
                                                                    java.lang.Integer productId,
                                                                    ModifyProductRequest modifyProductRequest)
                                                             throws ApiException

Modify Product Modifies the specified product.

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

modifyProductRequest - Modified product details. (optional)

Returns:

ApiResponse<ModifyProductResponse>

Throws:

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

Http Response Details

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-
404	Not Found	-

modifyProductAsync

public okhttp3.Call modifyProductAsync(java.lang.Integer companyId,
                                       java.lang.Integer productId,
                                       ModifyProductRequest modifyProductRequest,
                                       ApiCallback<ModifyProductResponse> _callback)
                                throws ApiException

Modify Product (asynchronously) Modifies the specified product.

Parameters:

companyId - The ID of the company. (required)

productId - The ID of the product. (required)

modifyProductRequest - Modified product details. (optional)

_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

Response Details

Status Code	Description	Response Headers
200	Example response	-
401	Unauthorized	-
404	Not Found	-