Humaans.Requests (Humaans v0.6.0)

This module provides functions for listing and retrieving request resources in the Humaans API. Requests are read-only via the API.

Summary

Types

list_response()

response()

Functions

list(client, params \\ %{})

Lists all requests.

retrieve(client, id)

Retrieves a specific request by ID.

Types

list_response()

@type list_response() ::
  {:ok,
   [
     %Humaans.Resources.Request{
       company_id: term(),
       created_at: term(),
       data: term(),
       id: term(),
       person_id: term(),
       request_type_id: term(),
       status: term(),
       updated_at: term()
     }
   ]}
  | {:error, Humaans.Error.t()}

response()

@type response() ::
  {:ok,
   %Humaans.Resources.Request{
     company_id: term(),
     created_at: term(),
     data: term(),
     id: term(),
     person_id: term(),
     request_type_id: term(),
     status: term(),
     updated_at: term()
   }}
  | {:error, Humaans.Error.t()}

Functions

list(client, params \\ %{})

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

Lists all requests.

Returns a list of requests 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, requests} = Humaans.Requests.list(client)
{:ok, requests} = Humaans.Requests.list(client, %{})

retrieve(client, id)

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

Retrieves a specific request by ID.

Parameters

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

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, request} = Humaans.Requests.retrieve(client, "request_id")