Excontentstack.Delivery (Excontentstack v0.5.0)

Contentstack Delivery API client.

Summary

Functions

Creates a new Delivery API client.

Functions

new(opts \\ [])

Creates a new Delivery API client.

Options

  • :api_key - Your stack's API key (required)
  • :delivery_token - Delivery token for the environment (required)
  • :environment - Publishing environment name (required, e.g., "live", "preview")
  • :region - Region atom (default: :us)
  • :master_locale - Master locale (required, e.g., "en-us")
  • :req_opts - Additional Req options (optional)
  • :configure_req - A function to customize the Req.Request pipeline (optional)

Examples

# Basic client
client = Excontentstack.Delivery.new(
  api_key: "...",
  delivery_token: "...",
  environment: "...",
  master_locale: "en-us",
)

# With custom request pipeline
client = Excontentstack.Delivery.new(
  api_key: "...",
  delivery_token: "...",
  environment: "...",
  master_locale: "en-us",
  configure_req: fn req ->
    req
    |> Req.Request.append_request_steps(log_request: &MyApp.log_request/1)
    |> Req.Request.append_response_steps(log_response: &MyApp.log_response/1)
  end
)