CampaignFlow.Client.Agencies (CampaignFlow Client v2.0.0)
View SourceAgency resource operations for the Campaign Flow API.
Summary
Functions
@spec create(CampaignFlow.Client.t(), map()) :: CampaignFlow.Client.Request.response()
Registers a new agency.
Examples
{:ok, agency} = CampaignFlow.Client.Agencies.create(client, %{
name: "ABC Real Estate",
abn: "12345678901"
})
@spec get(CampaignFlow.Client.t(), integer()) :: CampaignFlow.Client.Request.response()
Retrieves a specific agency by ID.
Examples
{:ok, agency} = CampaignFlow.Client.Agencies.get(client, 123)
@spec list( CampaignFlow.Client.t(), keyword() ) :: CampaignFlow.Client.Request.response()
Lists all agencies.
Options
:page- Page number for pagination:per_page- Number of items per page
Examples
{:ok, agencies} = CampaignFlow.Client.Agencies.list(client)
{:ok, agencies} = CampaignFlow.Client.Agencies.list(client, page: 2)