CampaignFlow.Client.Referrals (CampaignFlow Client v2.0.0)
View SourceReferral resource operations for the Campaign Flow API.
Summary
Functions
@spec create(CampaignFlow.Client.t(), map()) :: CampaignFlow.Client.Request.response()
Submits a new referral.
Examples
{:ok, referral} = CampaignFlow.Client.Referrals.create(client, %{
name: "John Doe",
email: "john@example.com"
})
@spec get(CampaignFlow.Client.t(), integer()) :: CampaignFlow.Client.Request.response()
Retrieves a specific referral by ID.
Examples
{:ok, referral} = CampaignFlow.Client.Referrals.get(client, 123)
@spec list( CampaignFlow.Client.t(), keyword() ) :: CampaignFlow.Client.Request.response()
Lists all referrals.
Options
:page- Page number for pagination:per_page- Number of items per page
Examples
{:ok, referrals} = CampaignFlow.Client.Referrals.list(client)