ExStreamClient.Operations.Chat.Campaigns (ExStreamClient v0.1.3)
View SourceModules for interacting with the chat/campaigns
group of Stream APIs
API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2
Summary
Functions
Get campaign by ID.
Query campaigns with filter query
Stops a campaign
Starts or schedules a campaign
Functions
@spec get_campaign(String.t(), client: module(), limit: integer(), next: String.t(), prev: String.t() ) :: {:ok, ExStreamClient.Model.GetCampaignResponse.t()} | {:error, any()}
Get campaign by ID.
Required Arguments:
id
Optional Arguments:
prev
next
limit
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec query_campaigns(ExStreamClient.Model.QueryCampaignsRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.QueryCampaignsResponse.t()} | {:error, any()}
Query campaigns with filter query
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec schedule_campaign(String.t(), ExStreamClient.Model.StopCampaignRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.CampaignResponse.t()} | {:error, any()}
Stops a campaign
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)
@spec start_campaign(String.t(), ExStreamClient.Model.StartCampaignRequest.t(), [ {:client, module()} ]) :: {:ok, ExStreamClient.Model.StartCampaignResponse.t()} | {:error, any()}
Starts or schedules a campaign
Required Arguments:
Optional Arguments:
client
: HTTP client to use. Must implementExStreamClient.Http.Behavior
(e.g.,ExStreamClient.Http
)