CampaignFlow.Client.Properties (CampaignFlow Client v2.0.0)
View SourceProperty resource operations for the Campaign Flow API.
Summary
Functions
Creates a new property.
Deletes a property.
Retrieves a specific property by ID.
Lists all properties.
Updates an existing property.
Functions
@spec create(CampaignFlow.Client.t(), map()) :: CampaignFlow.Client.Request.response()
Creates a new property.
Examples
{:ok, property} = CampaignFlow.Client.Properties.create(client, %{
name: "New Property",
address: "123 Main St"
})
@spec delete(CampaignFlow.Client.t(), integer()) :: CampaignFlow.Client.Request.response()
Deletes a property.
Examples
{:ok, response} = CampaignFlow.Client.Properties.delete(client, 123)
@spec get(CampaignFlow.Client.t(), integer()) :: CampaignFlow.Client.Request.response()
Retrieves a specific property by ID.
Examples
{:ok, property} = CampaignFlow.Client.Properties.get(client, 123)
@spec list( CampaignFlow.Client.t(), keyword() ) :: CampaignFlow.Client.Request.response()
Lists all properties.
Options
:page- Page number for pagination:per_page- Number of items per page
Examples
{:ok, properties} = CampaignFlow.Client.Properties.list(client)
@spec update(CampaignFlow.Client.t(), integer(), map()) :: CampaignFlow.Client.Request.response()
Updates an existing property.
Examples
{:ok, property} = CampaignFlow.Client.Properties.update(client, 123, %{
name: "Updated Property Name"
})