View Source ExChargebee.PortalSession (ex_chargebee v0.4.1)

An interface for Interacting with portal_sessions

For More information see Chargebee portal_session Documentation

Summary

Functions

Creates a portal_session.

Returns a list of portal_sessions. Pagination is handled automatically unless the opt paginate is set to false.

Returns a stream of portal_sessions. Pagination is handled automatically as the stream is consumed.

Functions

Link to this function

create(params, opts \\ [])

View Source

Creates a portal_session.

Find more information in the Chargebee Documentation

Link to this function

list(params \\ %{}, opts \\ [])

View Source
@spec list(
  map(),
  keyword()
) :: [map()] | nil

Returns a list of portal_sessions. Pagination is handled automatically unless the opt paginate is set to false.

opts:

  • site: the site to use for the request. Defaults to the default site.
  • paginate: whether to paginate the results. Defaults to false. If false, all results will be returned.
Link to this function

resource_base_path(path \\ "")

View Source
Link to this function

resource_path(id, path \\ "")

View Source
Link to this function

retrieve(resource_id, opts \\ [])

View Source
@spec retrieve(
  String.t(),
  keyword()
) :: map() | nil
Link to this function

stream_list(params \\ %{}, opts \\ [])

View Source
@spec stream_list(
  map(),
  keyword()
) :: Enumerable.t()

Returns a stream of portal_sessions. Pagination is handled automatically as the stream is consumed.

Link to this function

update(resource_id, params, path \\ "", opts \\ [])

View Source

Updates a portal_session.

Find more information in the Chargebee Documentation