Stories v0.1.1 Stories.User View Source

Link to this section Summary

Functions

Create new Elixir.Stories.User resource. Parameters are not validated, but passed along in the request body. Please see Stories API documentation for the appropriate body parameters for your resource.

Delete Stories Elixir.Stories.User with provided id.

Retrieve Elixir.Stories.User by id. Accepts a keyword list of options.

Retrieve list of Elixir.Stories.User Stories resource. Shares all options with get/1

Update given Elixir.Stories.User resource. Parameters are not validated, but passed along in the request body. Please see Stories API documentation for the appropriate body parameters for your resource.

Link to this section Functions

Link to this function

create(properties, options \\ [])

View Source

Create new Elixir.Stories.User resource. Parameters are not validated, but passed along in the request body. Please see Stories API documentation for the appropriate body parameters for your resource.

returns %Elixir.Stories.User{}

Params

  • properties - Map of resource properties to create the resource with. This will be different for each resource based on the specification in Stories API
Link to this function

delete(id, options \\ [])

View Source

Delete Stories Elixir.Stories.User with provided id.

Will return :ok on success, {:error, 404} if resource not found, or throw StoriesError for implementation errors.

Params

  • id - id of Elixir.Stories.User resource to delete

Retrieve Elixir.Stories.User by id. Accepts a keyword list of options.

returns %Elixir.Stories.User{}

Options

  • :id - The id of the resource you are trying to retrieve. Defaults to empty, giving same behaviour as list/1
  • :get_parameters - Map of query parameters that you want to include in the query.

Retrieve list of Elixir.Stories.User Stories resource. Shares all options with get/1

returns [%Elixir.Stories.User{}]

Options

  • :page - The page number to use in pagination. Default 1
  • :per_page - The number of records to return per page. Currently only 50 is supported.
  • :recurse_pages - Recursively follow each next page and return all records.
  • :get_parameters - Map of query parameters that you want to include in the query.
Link to this function

update(id, changes, options \\ [])

View Source

Update given Elixir.Stories.User resource. Parameters are not validated, but passed along in the request body. Please see Stories API documentation for the appropriate body parameters for your resource.

returns %Elixir.Stories.User{}

Params

  • id - id of Elixir.Stories.User resource being updated.
  • changes - Map of changes to be applied to the resource.