Billcom v0.1.1 Billcom.User View Source

Link to this section Summary

Functions

create(connection, data)

Billcom.User.create/2 for bill.com api

delete(connection, data)

Billcom.User.delete/2 for bill.com api

list(conn, data)

Billcom.User.list/2 for bill.com api

read(connection, data)

Billcom.User.read/2 for bill.com api

undelete(connection, data)

Billcom.User.undelete/2 for bill.com api

update(connection, data)

Billcom.User.update/2 for bill.com api

Link to this section Functions

create(connection, data)

Specs

create(map(), map()) :: {atom(), map()}

Billcom.User.create/2 for bill.com api

Parameters:

conn: a connection strucure (see Billcom.login!/0)
data: data object to send for the object

return:

success:

{:ok, data}

Returned data from create for User

failure:

{:error, val}

Where val hold information about failure reason.

delete(connection, data)

Specs

delete(map(), map()) :: {atom(), map()}

Billcom.User.delete/2 for bill.com api

Parameters:

conn: a connection strucure (see Billcom.login!/0)
data: data object to send for the object

return:

success:

{:ok, data}

Returned data from delete for User

failure:

{:error, val}

Where val hold information about failure reason.

list(conn, data)

Specs

list(map(), map()) :: {atom(), map()}

Billcom.User.list/2 for bill.com api

Parameters:

conn: a connection strucure (see Billcom.login!/0)
data: data object to send for the object

return:

success:

{:ok, data}

Where data is a collection of User object list

failure:

{:error, val}

Where val hold information about failure reason.

read(connection, data)

Specs

read(map(), map()) :: {atom(), map()}

Billcom.User.read/2 for bill.com api

Parameters:

conn: a connection strucure (see Billcom.login!/0)
data: data object to send for the object

return:

success:

{:ok, data}

Returned data from read for User

failure:

{:error, val}

Where val hold information about failure reason.

undelete(connection, data)

Specs

undelete(map(), map()) :: {atom(), map()}

Billcom.User.undelete/2 for bill.com api

Parameters:

conn: a connection strucure (see Billcom.login!/0)
data: data object to send for the object

return:

success:

{:ok, data}

Returned data from undelete for User

failure:

{:error, val}

Where val hold information about failure reason.

update(connection, data)

Specs

update(map(), map()) :: {atom(), map()}

Billcom.User.update/2 for bill.com api

Parameters:

conn: a connection strucure (see Billcom.login!/0)
data: data object to send for the object

return:

success:

{:ok, data}

Returned data from update for User

failure:

{:error, val}

Where val hold information about failure reason.