Package pl.grizzlysoftware.dotykacka.client.v1.api.service

Interface WarehouseService

public interface WarehouseService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<Warehouse>	createWarehouse(java.lang.Long cloudId, Warehouse warehouse)
retrofit2.Call<Warehouse>	deleteWarehouse(java.lang.Long cloudId, java.lang.Long warehouseId)
retrofit2.Call<Warehouse>	getWarehouse(java.lang.Long cloudId, java.lang.Long warehouseId)
retrofit2.Call<java.util.Collection<Warehouse>>	getWarehouses(java.lang.Long cloudId, int limit, int offset, java.lang.String sort)
retrofit2.Call<Warehouse>	updateWarehouse(java.lang.Long cloudId, java.lang.Long warehouseId, Warehouse warehouse)

Method Detail

getWarehouse

@GET("{cloudId}/{warehouseId}")
retrofit2.Call<Warehouse> getWarehouse(@Path("cloudId")
                                       java.lang.Long cloudId,
                                       @Path("warehouseId")
                                       java.lang.Long warehouseId)

Parameters:

cloudId - - cloud id

warehouseId - - warehouse id

Returns:

createWarehouse

@POST("{cloudId}/create")
retrofit2.Call<Warehouse> createWarehouse(@Path("cloudId")
                                          java.lang.Long cloudId,
                                          @Body
                                          Warehouse warehouse)

Parameters:

cloudId - - cloud id

warehouse - - warehouse to be created

Returns:

updateWarehouse

@POST("{cloudId}/{warehouseId}/update")
retrofit2.Call<Warehouse> updateWarehouse(@Path("cloudId")
                                          java.lang.Long cloudId,
                                          @Path("warehouseId")
                                          java.lang.Long warehouseId,
                                          @Body
                                          Warehouse warehouse)

Parameters:

cloudId - - cloud id

warehouse - - warehouse to be updated

Returns:

deleteWarehouse

@GET("{cloudId}/{warehouseId}/delete")
retrofit2.Call<Warehouse> deleteWarehouse(@Path("cloudId")
                                          java.lang.Long cloudId,
                                          @Path("warehouseId")
                                          java.lang.Long warehouseId)

Parameters:

cloudId - - cloud id

warehouseId - - warehouse id

Returns:

getWarehouses

@GET("{cloudId}")
retrofit2.Call<java.util.Collection<Warehouse>> getWarehouses(@Path("cloudId")
                                                              java.lang.Long cloudId,
                                                              @Query("limit")
                                                              int limit,
                                                              @Query("offset")
                                                              int offset,
                                                              @Query("sort")
                                                              java.lang.String sort)

Parameters:

cloudId - - cloud id

offset - - pagination parameter, default = 0

limit - - pagination parameter, default = 100, max = 100

sort - - Description: Sort parameters in format: column_name1,column_name2 //means asc -column_name1,-column_name2 //means desc

Returns: