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

View Source

Modules for interacting with the chat/campaigns group of Stream APIs

API Reference: https://getstream.github.io/protocol/?urls.primaryName=Chat%20v2

Shared options

All functions in this module accept the following optional parameters:

  • api_key - API key to use. If not provided, the default key from config will be used
  • api_key_secret - API key secret to use. If not provided, the default secret from config will be used
  • endpoint - endpoint to use. If not provided, the default endpoint from config will be used
  • client - HTTP client to use. Must implement ExStreamClient.Http.Behavior. Defaults to ExStreamClient.Http
  • req_opts - all of these options will be forwarded to req. See Req.new/1 for available options

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(),
  req_opts: keyword(),
  client: module(),
  endpoint: String.t(),
  api_key: String.t(),
  api_key_secret: String.t(),
  limit: integer(),
  next: String.t(),
  prev: String.t()
) :: {:ok, ExStreamClient.Model.GetCampaignResponse.t()} | {:error, any()}

Get campaign by ID.

Required Arguments:

  • id

Optional Arguments:

  • limit
  • next
  • prev

All options from Shared Options are supported.

query_campaigns(payload, opts \\ [])

Query campaigns with filter query

Required Arguments:

All options from Shared Options are supported.

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

Stops a campaign

Required Arguments:

All options from Shared Options are supported.

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

Starts or schedules a campaign

Required Arguments:

All options from Shared Options are supported.