ExStreamClient.Operations.Chat.Campaigns (ExStreamClient v0.1.3)

View Source

Modules 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

Starts or schedules a campaign

Functions

get_campaign(id, opts \\ [])

@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:

query_campaigns(payload, opts \\ [])

@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:

schedule_campaign(id, payload, opts \\ [])

@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:

start_campaign(id, payload, opts \\ [])

@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: