View Source ExPipedrive.DealFields (ex_pipedrive v0.1.0)

API v2 deal field definitions.

field_code is the hash used as a key in %ExPipedrive.Deal{}.custom_fields; field_name is its human-readable label. Use ExPipedrive.Fields to resolve between them.

Summary

Functions

list_deal_fields(client, opts \\ [])

Alias for list_page/2.

list_page(client, opts \\ [])

Lists one cursor page of deal field definitions via GET /api/v2/dealFields.

stream(client, opts \\ [])

Lazily streams deal field definitions across API v2 cursor pages.

Functions

list_deal_fields(client, opts \\ [])

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

Alias for list_page/2.

list_page(client, opts \\ [])

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

Lists one cursor page of deal field definitions via GET /api/v2/dealFields.

Options: :cursor, :limit (clamped to 500), and :include_fields.

stream(client, opts \\ [])

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

Lazily streams deal field definitions across API v2 cursor pages.