Packages

mux

2.3.0
3.2.2 3.2.1 3.2.0 3.1.0 3.0.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.9.1 1.9.0 1.8.1 1.8.0 1.7.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 1.0.0-beta.1 1.0.0-beta.0

Official Elixir package for interacting with the Mux APIs

HexDocs

Current section

Files

Jump to
Readme
25 Versions
3 Dependencies
Dependants
Files
Activity
mux lib mux video delivery_usage.ex
Raw

lib/mux/video/delivery_usage.ex 

defmodule Mux.Video.DeliveryUsage do

  @moduledoc """

  This module provides functions for reading delivery usage in Mux Video. [API Documentation](https://docs.mux.com/api-reference/video#tag/delivery-usage)

  """

  alias Mux.{Base, Fixtures}



  @path "/video/v1/delivery-usage"



  @doc """

  Get delivery usage for a specified timeframe. [API Documentation](https://docs.mux.com/api-reference/video#operation/list-delivery-usage)



  Returns `{:ok, delivery_usage, %Tesla.Env{}}`.



  ## Examples



      iex> client = Mux.Base.new("my_token_id", "my_token_secret")

      iex> {:ok, delivery_usage, _env} = Mux.Video.DeliveryUsage.list(client, %{timeframe: [1564617600, 1569283200]})

      iex> delivery_usage

      #{inspect([Fixtures.delivery_usage(), Fixtures.delivery_usage()])}

  """



  def list(client, options \\ []) do

    Base.get(client, @path, query: options)

  end

end