ExCwmanage v0.2.3 ExCwmanage.Api behaviour View Source

Raw API commands

Link to this section Summary

Functions

Example Initial call {:ok, next, c} = ExCwmanage.Api.get_page("/company/companies") Next page {:ok, next, c} = ExCwmanage.Api.get_page("/company/companies", [pageid: next]) Next page (custom page size) {:ok, next, c} = ExCwmanage.Api.get_page("/company/companies", [pageid: next], [pagesize: 10])

Link to this section Types

Link to this section Functions

Link to this function

delete(path, params \\ [])

View Source
Link to this function

get_page(path, params \\ [])

View Source

Example Initial call {:ok, next, c} = ExCwmanage.Api.get_page("/company/companies") Next page {:ok, next, c} = ExCwmanage.Api.get_page("/company/companies", [pageid: next]) Next page (custom page size) {:ok, next, c} = ExCwmanage.Api.get_page("/company/companies", [pageid: next], [pagesize: 10])

Link to this function

get_raw(path, params \\ [])

View Source

Link to this section Callbacks

Link to this callback

delete(path, params)

View Source
delete(path :: path(), params :: list()) :: map()
Link to this callback

get(path, params)

View Source
get(path :: path(), params :: list()) :: map()
Link to this callback

get_page(path, params)

View Source
get_page(path :: path(), params :: list()) :: map()
Link to this callback

get_raw(path, params)

View Source
get_raw(path :: path(), params :: list()) :: binary()
Link to this callback

patch(path, payload)

View Source
patch(path :: path(), payload :: String.t()) :: map()
Link to this callback

post(path, payload)

View Source
post(path :: path(), payload :: String.t()) :: map()
Link to this callback

put(path, payload)

View Source
put(path :: path(), payload :: String.t()) :: map()