CampaignFlow.Client.PropertySuggestions (CampaignFlow Client v2.0.0)

View Source

Property suggestion operations for the Campaign Flow API.

Provides address suggestions for properties.

Summary

Functions

list(client, params \\ [])

Suggests property addresses matching the given partial string.

Functions

list(client, params \\ [])

@spec list(
  CampaignFlow.Client.t(),
  keyword()
) :: CampaignFlow.Client.Request.response()

Suggests property addresses matching the given partial string.

Options

  • :q - Query string for searching property addresses
  • :limit - Maximum number of suggestions to return

Examples

{:ok, suggestions} = CampaignFlow.Client.PropertySuggestions.list(client, q: "123 Main")