Humaans.IdentityDocumentTypes (Humaans v0.6.0)

This module provides functions for listing identity document type resources in the Humaans API. Identity document types are read-only via the API.

Summary

Types

list_response()

Functions

list(client, params \\ %{})

Lists all identity_document_types.

Types

list_response()

@type list_response() ::
  {:ok,
   [
     %Humaans.Resources.IdentityDocumentType{
       company_id: term(),
       created_at: term(),
       id: term(),
       name: 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.IdentityDocumentType.t()]}
  | {:error, Humaans.Error.t()}

Lists all identity_document_types.

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