Pinata (ex_pinata v1.0.0) View Source

Link to this section Summary

Link to this section Functions

Specs

data_usage() :: {:ok, Pinata.Models.DataUsage.t()} | {:error, any()}
Link to this function

generate_api_key(key_name, permissions, opts \\ [])

View Source

Specs

generate_api_key(String.t(), map(), keyword()) ::
  {:ok, Pinata.Models.Key.t()} | {:error, any()}
Link to this function

global_pin_policy(policy, opts \\ [])

View Source

Specs

global_pin_policy(map(), keyword()) :: :ok | {:error, any()}
Link to this function

hash_metadata(hash, opts \\ [])

View Source

Specs

hash_metadata(String.t(), keyword()) :: :ok | {:error, any()}
Link to this function

hash_pin_policy(hash, policy)

View Source

Specs

hash_pin_policy(String.t(), map()) :: :ok | {:error, any()}
Link to this function

pin_by_hash(hash, metadata \\ %{}, options \\ %{})

View Source

Specs

pin_by_hash(String.t(), map(), map()) ::
  {:ok, Pinata.Models.HashPin.t()} | {:error, any()}
Link to this function

pin_file(file, filename, metadata \\ %{}, options \\ %{})

View Source

Specs

pin_file(binary(), String.t(), map(), map()) ::
  {:ok, Pinata.Models.Pin.t()} | {:error, any()}

Specs

pin_jobs(keyword()) :: {:ok, Pinata.Models.Jobs.t()} | {:error, any()}
Link to this function

pin_json(object, metadata \\ %{}, options \\ %{})

View Source

Specs

pin_json(map() | list(), map(), map()) ::
  {:ok, Pinata.Models.Pin.t()} | {:error, any()}

Specs

revoke_api_key(String.t()) :: :ok | {:error, any()}

Specs

unpin(String.t()) :: :ok | {:error, any()}