View Source ShortcutApi.Members (shortcut_api_ex v1.0.5)

API wrapper for Shortcut Members endpoints. See: https://developer.shortcut.com/api/rest/v3#Member

All functions require a valid Shortcut API token.

Summary

Types

response()
token()

Functions

get_current_member(token)

Gets information about the currently authenticated member.

Types

response()

@type response() :: {:ok, map() | [map()]} | {:error, any()}

token()

@type token() :: String.t()

Functions

get_current_member(token)

@spec get_current_member(token()) :: response()

Gets information about the currently authenticated member.

Parameters

  • token - Shortcut API token

Examples 

iex> ShortcutApi.Members.get_current_member("token")
{:ok, %{id: "12345678-9012-3456-7890-123456789012", name: "Member Name"}}