ExStreamClient.Operations.Chat.Campaigns (ExStreamClient v0.1.1)
View SourceModules for interacting with the `chat/campaigns` group of OpenAI APIs
API Reference: https://platform.openai.com/docs/api-reference/chat/campaigns
Summary
Functions
@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`
@spec query_campaigns(ExStreamClient.Model.QueryCampaignsRequest.t()) :: {:ok, ExStreamClient.Model.QueryCampaignsResponse.t()} | {:error, any()}
Query campaigns with filter query
### Required Arguments:
- `payload`: QueryCampaignsRequest
@spec schedule_campaign(String.t(), ExStreamClient.Model.StopCampaignRequest.t()) :: {:ok, ExStreamClient.Model.CampaignResponse.t()} | {:error, any()}
Stops a campaign
### Required Arguments:
- `id`
- `payload`: StopCampaignRequest
@spec start_campaign(String.t(), ExStreamClient.Model.StartCampaignRequest.t()) :: {:ok, ExStreamClient.Model.StartCampaignResponse.t()} | {:error, any()}
Starts or schedules a campaign
### Required Arguments:
- `id`
- `payload`: StartCampaignRequest