Humaans.RoleMembers (Humaans v0.6.0)

This module provides functions for listing and retrieving role member resources in the Humaans API. Role members are read-only via the API.

Summary

Types

list_response()

response()

Functions

list(client, params \\ %{})

Lists all role_members.

retrieve(client, id)

Retrieves a specific role_member by ID.

Types

list_response()

@type list_response() ::
  {:ok,
   [
     %Humaans.Resources.RoleMember{
       id: term(),
       person_id: term(),
       role_id: term()
     }
   ]}
  | {:error, Humaans.Error.t()}

response()

@type response() ::
  {:ok,
   %Humaans.Resources.RoleMember{id: term(), person_id: term(), role_id: term()}}
  | {:error, Humaans.Error.t()}

Functions

list(client, params \\ %{})

@spec list(client :: map(), params :: map() | keyword() | [{String.t(), term()}]) ::
  {:ok, [Humaans.Resources.RoleMember.t()]} | {:error, Humaans.Error.t()}

Lists all role_members.

Returns a list of role_members matching the optional filter params.

Parameters

client - Client created with Humaans.new/1
params - Optional map of filter parameters (default: %{})

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, role_members} = Humaans.RoleMembers.list(client)
{:ok, role_members} = Humaans.RoleMembers.list(client, %{})

retrieve(client, id)

@spec retrieve(client :: map(), id :: String.t()) ::
  {:ok, Humaans.Resources.RoleMember.t()} | {:error, Humaans.Error.t()}

Retrieves a specific role_member by ID.

Parameters

client - Client created with Humaans.new/1
id - String ID of the role_member to retrieve

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, role_member} = Humaans.RoleMembers.retrieve(client, "role_member_id")