CampaignFlow.Client.Agencies (CampaignFlow Client v2.0.0)

View Source

Agency resource operations for the Campaign Flow API.

Summary

Functions

Registers a new agency.

Retrieves a specific agency by ID.

Lists all agencies.

Functions

create(client, params)

Registers a new agency.

Examples

{:ok, agency} = CampaignFlow.Client.Agencies.create(client, %{
  name: "ABC Real Estate",
  abn: "12345678901"
})

get(client, id)

Retrieves a specific agency by ID.

Examples

{:ok, agency} = CampaignFlow.Client.Agencies.get(client, 123)

list(client, params \\ [])

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)