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

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(id, opts \\ [])

@spec get_campaign(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:
    - `prev`
    - `next`
    - `limit`

query_campaigns(payload)

Query campaigns with filter query


### Required Arguments:
    - `payload`: QueryCampaignsRequest

schedule_campaign(id, payload)

Stops a campaign


### Required Arguments:
    - `id`
    - `payload`: StopCampaignRequest

start_campaign(id, payload)

Starts or schedules a campaign


### Required Arguments:
    - `id`
    - `payload`: StartCampaignRequest