ExStreamClient.Operations.Chat.PushTemplates (ExStreamClient v0.1.7)

View Source

Modules for interacting with the chat/push_templates 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

Types

shared_opts()

Functions

get_push_templates(push_provider_type, opts \\ [])

Retrieve push notification templates for Chat.

upsert_push_template(payload, opts \\ [])

Create or update a push notification template for a specific event type and push provider

Types

shared_opts()

@type shared_opts() :: [
  api_key: String.t(),
  api_key_secret: String.t(),
  client: module(),
  endpoint: String.t(),
  req_opts: keyword()
]

Functions

get_push_templates(push_provider_type, opts \\ [])

@spec get_push_templates(String.t(), [
  {:push_provider_name, String.t()} | shared_opts()
]) ::
  {:ok, ExStreamClient.Model.GetPushTemplatesResponse.t()} | {:error, any()}

Retrieve push notification templates for Chat.

Required Arguments:

  • push_provider_type

Optional Arguments:

upsert_push_template(payload, opts \\ [])

@spec upsert_push_template(
  ExStreamClient.Model.UpsertPushTemplateRequest.t(),
  shared_opts()
) ::
  {:ok, ExStreamClient.Model.UpsertPushTemplateResponse.t()} | {:error, any()}

Create or update a push notification template for a specific event type and push provider

Required Arguments:

Optional Arguments: