CampaignFlow.Client.FinanceApplications (CampaignFlow Client v2.0.0)
View SourceFinance Application resource operations for the Campaign Flow API.
Summary
Functions
Creates a new finance application.
Retrieves a specific finance application by ID.
Lists all finance applications.
Sets the status of a finance application.
Submits a finance application.
Updates an existing finance application.
Functions
@spec create(CampaignFlow.Client.t(), map()) :: CampaignFlow.Client.Request.response()
Creates a new finance application.
Examples
{:ok, application} = CampaignFlow.Client.FinanceApplications.create(client, %{
campaign_budget_id: 123,
applicant_name: "John Doe"
})
@spec get(CampaignFlow.Client.t(), integer()) :: CampaignFlow.Client.Request.response()
Retrieves a specific finance application by ID.
Examples
{:ok, application} = CampaignFlow.Client.FinanceApplications.get(client, 123)
@spec list( CampaignFlow.Client.t(), keyword() ) :: CampaignFlow.Client.Request.response()
Lists all finance applications.
Options
:page- Page number for pagination:per_page- Number of items per page
Examples
{:ok, applications} = CampaignFlow.Client.FinanceApplications.list(client)
@spec set_status(CampaignFlow.Client.t(), integer(), map()) :: CampaignFlow.Client.Request.response()
Sets the status of a finance application.
Examples
{:ok, response} = CampaignFlow.Client.FinanceApplications.set_status(client, 123, %{
status: "approved"
})
@spec submit(CampaignFlow.Client.t(), integer()) :: CampaignFlow.Client.Request.response()
Submits a finance application.
Examples
{:ok, response} = CampaignFlow.Client.FinanceApplications.submit(client, 123)
@spec update(CampaignFlow.Client.t(), integer(), map()) :: CampaignFlow.Client.Request.response()
Updates an existing finance application.
Examples
{:ok, application} = CampaignFlow.Client.FinanceApplications.update(client, 123, %{
applicant_name: "Jane Doe"
})