API Reference CampaignFlow Client v#2.2.0

The CampaignFlow Application module.

Main client module for the Campaign Flow API.

Agency resource operations for the Campaign Flow API.

Agency suggestion operations for the Campaign Flow API.

Airwallex payment operations for the Campaign Flow API.

Asset resource operations for the Campaign Flow API.

Attachment resource operations for the Campaign Flow API.

Handles OAuth2 authentication for the Campaign Flow API.

Campaign Budget resource operations for the Campaign Flow API.

Campaign resource operations for the Campaign Flow API.

Error handling for the Campaign Flow API client.

Finance Application resource operations for the Campaign Flow API.

Invoice resource operations for the Campaign Flow API.

Property resource operations for the Campaign Flow API.

Property suggestion operations for the Campaign Flow API.

Referral resource operations for the Campaign Flow API.

Handles HTTP requests to the Campaign Flow API using Req.

Signatory resource operations for the Campaign Flow API.

Tenant resource operations for the Campaign Flow API.

GenServer that manages OAuth2 access tokens for the Campaign Flow API.

User resource operations for the Campaign Flow API.

Mock Campaign Flow server for development and testing.

Handles campaign-related endpoints for the mock server.

Shared helpers for mock server HTTP handlers: bearer auth, integer path-param parsing, and the like. Keeps individual handler modules free of boilerplate.

Handles OAuth2 token endpoint for the mock server.

Handles referral-related endpoints for the mock server.

Migrations for the mock server PostgreSQL tables.

Standardized response builders for the mock Campaign Flow API.

Plug router for the mock Campaign Flow server.

Ecto schema for mock server agents (listing and submitting).

Ecto schema for mock server campaigns.

Ecto schema for mock server campaign budgets.

Ecto schema for mock server finance applications.

Ecto schema for mock server properties.

Ecto schema for mock server referrals.

Ecto schema for mock server vendor parties.

Ecto schema for mock server webhook events.

State management for the mock server.

Storage behaviour for mock server persistence.

PostgreSQL storage adapter for the mock server.

Supervisor for the mock Campaign Flow server.

Test-only helpers for driving the mock CampaignFlow server from Elixir code.

Outbound webhook dispatch for the mock server.

Periodic GenServer that drains pending webhook events whose next_retry_at has elapsed.

HMAC-SHA256 signing for outbound webhook payloads.