Sendio.Segments (sendio v1.1.0)
Manage segments in Sendio.
Summary
Functions
Link to this function
create(client \\ Sendio.client(), opts)
@spec create(Sendio.Client.t(), Keyword.t()) :: Sendio.Client.response(Sendio.Segments.Segment.t())
Creates a new segment.
Options
:name- The name of the segment (required)
Link to this function
get(client \\ Sendio.client(), segment_id)
@spec get(Sendio.Client.t(), String.t()) :: Sendio.Client.response(Sendio.Segments.Segment.t())
Gets a segment by ID.
Link to this function
list(client_or_opts \\ [])
@spec list(Keyword.t()) :: Sendio.Client.response(Sendio.List.t(Sendio.Segments.Segment.t()))
Lists all segments.
Options
:limit- Maximum number of segments to return (1-100):after- Cursor for pagination (segment ID to start after):before- Cursor for pagination (segment ID to start before)
Link to this function
list(client, opts)
@spec list(Sendio.Client.t(), Keyword.t()) :: Sendio.Client.response(Sendio.List.t(Sendio.Segments.Segment.t()))
Link to this function
remove(client \\ Sendio.client(), segment_id)
@spec remove(Sendio.Client.t(), String.t()) :: Sendio.Client.response(Sendio.Empty.t())
Removes a segment.