@spec add_finance_option(CampaignFlow.Client.t(), integer(), map()) ::
  CampaignFlow.Client.Request.response()

Adds a finance option to a campaign budget.

Examples

{:ok, option} = CampaignFlow.Client.CampaignBudgets.add_finance_option(client, 123, %{
  option_code: "PREMIUM",
  terms: "12 months"
})

@spec create(CampaignFlow.Client.t(), map()) :: CampaignFlow.Client.Request.response()

Creates a new campaign budget.

Examples

{:ok, budget} = CampaignFlow.Client.CampaignBudgets.create(client, %{
  campaign_id: 123,
  amount: 10000.00
})

@spec get(CampaignFlow.Client.t(), integer()) ::
  CampaignFlow.Client.Request.response()

Retrieves a specific campaign budget by ID.

Examples

{:ok, budget} = CampaignFlow.Client.CampaignBudgets.get(client, 123)

@spec get_finance_option(CampaignFlow.Client.t(), integer(), String.t()) ::
  CampaignFlow.Client.Request.response()

Retrieves a specific finance option for a campaign budget.

Examples

{:ok, option} = CampaignFlow.Client.CampaignBudgets.get_finance_option(client, 123, "OPTION_CODE")

@spec get_finance_quote(CampaignFlow.Client.t(), integer(), String.t()) ::
  CampaignFlow.Client.Request.response()

Gets a quote for a finance option.

Examples

{:ok, quote} = CampaignFlow.Client.CampaignBudgets.get_finance_quote(client, 123, "OPTION_CODE")

@spec list(
  CampaignFlow.Client.t(),
  keyword()
) :: CampaignFlow.Client.Request.response()

Lists all campaign budgets.

Options

• :page - Page number for pagination
• :per_page - Number of items per page

Examples

{:ok, budgets} = CampaignFlow.Client.CampaignBudgets.list(client)

@spec list_finance_options(CampaignFlow.Client.t(), integer()) ::
  CampaignFlow.Client.Request.response()

Lists finance options for a campaign budget.

Examples

{:ok, options} = CampaignFlow.Client.CampaignBudgets.list_finance_options(client, 123)

@spec remove_finance_option(CampaignFlow.Client.t(), integer(), String.t()) ::
  CampaignFlow.Client.Request.response()

Removes a finance option from a campaign budget.

Examples

{:ok, response} = CampaignFlow.Client.CampaignBudgets.remove_finance_option(client, 123, "OPTION_CODE")

@spec update(CampaignFlow.Client.t(), integer(), map()) ::
  CampaignFlow.Client.Request.response()

Updates an existing campaign budget.

Examples

{:ok, budget} = CampaignFlow.Client.CampaignBudgets.update(client, 123, %{
  amount: 12000.00
})

@spec update_finance_option(CampaignFlow.Client.t(), integer(), String.t(), map()) ::
  CampaignFlow.Client.Request.response()

Configures a finance option for a campaign budget.

Examples

{:ok, option} = CampaignFlow.Client.CampaignBudgets.update_finance_option(client, 123, "OPTION_CODE", %{
  terms: "24 months"
})