View Source ExPipedrive.LeadFields (ex_pipedrive v0.2.0)

API v1 lead field definitions.

key is the hash used in lead custom field payloads; name is its human-readable label. Use ExPipedrive.Fields to resolve between them.

Summary

Lists one offset page of lead field definitions via GET /api/v1/leadFields.

Alias for list/2.

Lazily streams lead field definitions across API v1 offset pages.

@spec list(
  Tesla.Client.t(),
  keyword()
) :: {:ok, ExPipedrive.PagedResult.t()} | {:error, ExPipedrive.Error.t()}

Lists one offset page of lead field definitions via GET /api/v1/leadFields.

Options: :start (default 0), :limit (default 500).

Returns {:ok, %PagedResult{data: [%Field{}]}}.

@spec list_lead_fields(
  Tesla.Client.t(),
  keyword()
) :: {:ok, ExPipedrive.PagedResult.t()} | {:error, ExPipedrive.Error.t()}

Alias for list/2.

@spec stream(
  Tesla.Client.t(),
  keyword()
) :: Enumerable.t()

Lazily streams lead field definitions across API v1 offset pages.