ExDoppler.Invites (ExDoppler v1.0.1)

View Source

Module for interacting with ExDoppler.Invite

๐Ÿ“– Resources

Summary

Functions

Same as list_invites/1 but won't wrap a successful response in {:ok, response}

Functions

list_invites(opts \\ [])

Lists ExDoppler.Invite

๐Ÿท๏ธ Params

  • opts: Optional modifications to the list call
    • page - which page to list (starts at 1) (e.g page: 2). Default: 1
    • per_page - the number of ExDoppler.Invite to return for this page (e.g per_page: 50). Default: 20

โคต๏ธ Returns

โœ… On Success

  {:ok, [%ExDoppler.Invite{...}]}

โŒ On Failure

  {:error, err}

๐Ÿ’ป Examples

iex> alias ExDoppler.Invites
iex> {:ok, _invites} = Invites.list_invites()

๐Ÿ“– Resources

list_invites!(opts \\ [])

Same as list_invites/1 but won't wrap a successful response in {:ok, response}