Package pl.grizzlysoftware.dotykacka.client.v2.service

Interface CustomerService

public interface CustomerService

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<java.util.Collection<Customer>>	createCustomers(java.util.Collection<Customer> customers)
retrofit2.Call<Customer>	deleteCustomer(java.lang.Long customerId)
retrofit2.Call<Customer>	getCustomer(java.lang.Long customerId)
retrofit2.Call<ResultPage<Customer>>	getCustomers(int page, int limit, java.lang.String filter, java.lang.String sort)
retrofit2.Call<Customer>	patchCustomer(java.lang.Long customerId, Customer customer)
retrofit2.Call<Customer>	updateCustomer(java.lang.Long customerId, Customer customer)
retrofit2.Call<java.util.Collection<Customer>>	updateCustomers(java.util.Collection<Customer> customers)

Method Detail

createCustomers

@POST(" ")
retrofit2.Call<java.util.Collection<Customer>> createCustomers(@Body
                                                               java.util.Collection<Customer> customers)

Parameters:

customers - - customers to be created

Returns:

Customer

updateCustomers

@PUT(" ")
retrofit2.Call<java.util.Collection<Customer>> updateCustomers(@Body
                                                               java.util.Collection<Customer> customers)

Parameters:

customers - - customers to be created or updated

Returns:

Customers

updateCustomer

@PUT("{customerId}")
retrofit2.Call<Customer> updateCustomer(@Path("customerId")
                                        java.lang.Long customerId,
                                        @Body
                                        Customer customer)

Parameters:

customerId - - id of customer to be updated

customer - - customer to be updated

Returns:

Customer

patchCustomer

@PATCH("{customerId}")
retrofit2.Call<Customer> patchCustomer(@Path("customerId")
                                       java.lang.Long customerId,
                                       @Body
                                       Customer customer)

Parameters:

customerId - - id of customer to be patched

customer - - customer to be patched

Returns:

Customer

deleteCustomer

@DELETE("{customerId}")
retrofit2.Call<Customer> deleteCustomer(@Path("customerId")
                                        java.lang.Long customerId)

Parameters:

customerId - - customer id

Returns:

Customer

getCustomer

@GET("{customerId}")
retrofit2.Call<Customer> getCustomer(@Path("customerId")
                                     java.lang.Long customerId)

Parameters:

customerId - - customerId id

Returns:

Customer

getCustomers

@GET(" ")
retrofit2.Call<ResultPage<Customer>> getCustomers(@Query("page")
                                                  int page,
                                                  @Query("limit")
                                                  int limit,
                                                  @Query("filter")
                                                  java.lang.String filter,
                                                  @Query("sort")
                                                  java.lang.String sort)

Parameters:

page - - pagination parameter, default = 1

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

filter - - query filter

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

Returns:

Customers