CampaignFlow.Client.Properties (CampaignFlow Client v2.0.0)

View Source

Property 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

create(client, params)

Creates a new property.

Examples

{:ok, property} = CampaignFlow.Client.Properties.create(client, %{
  name: "New Property",
  address: "123 Main St"
})

delete(client, id)

Deletes a property.

Examples

{:ok, response} = CampaignFlow.Client.Properties.delete(client, 123)

get(client, id)

Retrieves a specific property by ID.

Examples

{:ok, property} = CampaignFlow.Client.Properties.get(client, 123)

list(client, params \\ [])

Lists all properties.

Options

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

Examples

{:ok, properties} = CampaignFlow.Client.Properties.list(client)

update(client, id, params)

Updates an existing property.

Examples

{:ok, property} = CampaignFlow.Client.Properties.update(client, 123, %{
  name: "Updated Property Name"
})