Lingo.Api.SKU (Lingo v0.4.2)

Copy Markdown View Source

SKUs and their subscriptions.

Every function returns {:ok, result}, :ok when Discord sends no body, or {:error, %Lingo.Error{}}. Calls go to the current bot (see Lingo.with_bot/2).

Summary

Functions

get_subscription(sku_id, subscription_id)

Fetches a subscription to a SKU.

list()

Lists the application's SKUs.

list_subscriptions(sku_id, opts \\ [])

Lists the subscriptions to a SKU.

Functions

get_subscription(sku_id, subscription_id)

@spec get_subscription(Lingo.Api.id(), Lingo.Api.id()) ::
  Lingo.Api.result(Lingo.Type.Subscription.t())

Fetches a subscription to a SKU.

list()

@spec list() :: Lingo.Api.result([Lingo.Type.SKU.t()])

Lists the application's SKUs.

list_subscriptions(sku_id, opts \\ [])

@spec list_subscriptions(
  Lingo.Api.id(),
  keyword()
) :: Lingo.Api.result([Lingo.Type.Subscription.t()])

Lists the subscriptions to a SKU.