View Source ExMarketo.ApiBehaviour behaviour (ex marketo v0.1.4)

Defines a behaviour for REST API calls.

Link to this section Summary

Link to this section Callbacks

@callback authenticate() :: Tesla.Env.result()
Link to this callback

describe_leads(access_token)

View Source
@callback describe_leads(access_token :: String.t()) :: Tesla.Env.result()
Link to this callback

query_leads_by_email(email, access_token)

View Source
@callback query_leads_by_email(email :: String.t(), access_token :: String.t()) ::
  Tesla.Env.result()
Link to this callback

query_leads_by_field(field_type, filter_value, access_token)

View Source
@callback query_leads_by_field(
  field_type :: String.t(),
  filter_value :: String.t() | integer(),
  access_token :: String.t()
) :: Tesla.Env.result()
Link to this callback

update_lead_unsubscribed_status(email, unsubscribed, access_token)

View Source
@callback update_lead_unsubscribed_status(
  email :: String.t(),
  unsubscribed :: boolean(),
  access_token :: String.t()
) :: Tesla.Env.result()