Sendio.Topics (sendio v1.1.0)
Manage topics in Sendio.
Summary
Functions
Creates a new topic.
Gets a topic by ID.
Lists all topics.
Removes a topic.
Updates a topic.
Functions
Link to this function
create(client \\ Sendio.client(), opts)
@spec create(Sendio.Client.t(), Keyword.t()) :: Sendio.Client.response(Sendio.Topics.Topic.t())
Creates a new topic.
Options
:name- The name of the topic (required, max 50 characters):default_subscription- Required. Values:opt_inoropt_out. Cannot be changed after creation.:description- Description of the topic (max 200 characters):visibility-publicorprivate(default:private)
Link to this function
get(client \\ Sendio.client(), topic_id)
@spec get(Sendio.Client.t(), String.t()) :: Sendio.Client.response(Sendio.Topics.Topic.t())
Gets a topic by ID.
Link to this function
list(client_or_opts \\ [])
@spec list(Keyword.t()) :: Sendio.Client.response(Sendio.List.t(Sendio.Topics.Topic.t()))
Lists all topics.
Options
:limit- Maximum number of topics to return (1-100, default: 20):after- Cursor for pagination (topic ID to start after):before- Cursor for pagination (topic 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.Topics.Topic.t()))
Link to this function
remove(client \\ Sendio.client(), topic_id)
@spec remove(Sendio.Client.t(), String.t()) :: Sendio.Client.response(Sendio.Empty.t())
Removes a topic.
Link to this function
update(client \\ Sendio.client(), topic_id, opts)
@spec update(Sendio.Client.t(), String.t(), Keyword.t()) :: Sendio.Client.response(Sendio.Topics.Topic.t())
Updates a topic.
Options
:name- The name of the topic:description- Description of the topic (max 200 characters):visibility-publicorprivate
Note: default_subscription cannot be changed after creation.