Humaans.EsignBulkRecipients (Humaans v0.6.0)

This module provides functions for listing and retrieving e-signature bulk recipient resources in the Humaans API. Esign bulk recipients are read-only via the API.

Summary

Types

list_response()

response()

Functions

list(client, params \\ %{})

Lists all esign_bulk_recipients.

retrieve(client, id)

Retrieves a specific esign_bulk_recipient by ID.

Types

list_response()

@type list_response() ::
  {:ok,
   [
     %Humaans.Resources.EsignBulkRecipient{
       created_at: term(),
       esign_bulk_id: term(),
       id: term(),
       person_id: term(),
       signed_at: term(),
       status: term(),
       updated_at: term()
     }
   ]}
  | {:error, Humaans.Error.t()}

response()

@type response() ::
  {:ok,
   %Humaans.Resources.EsignBulkRecipient{
     created_at: term(),
     esign_bulk_id: term(),
     id: term(),
     person_id: term(),
     signed_at: 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.EsignBulkRecipient.t()]}
  | {:error, Humaans.Error.t()}

Lists all esign_bulk_recipients.

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

retrieve(client, id)

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

Retrieves a specific esign_bulk_recipient by ID.

Parameters

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

Examples

client = Humaans.new(access_token: "your_access_token")
{:ok, esign_bulk_recipient} = Humaans.EsignBulkRecipients.retrieve(client, "esign_bulk_recipient_id")