CampaignFlow.Client.Users (CampaignFlow Client v2.0.0)
View SourceUser resource operations for the Campaign Flow API.
Summary
Functions
Creates a new user.
Retrieves a specific user by ID.
Lists all users.
Updates an existing user.
Functions
@spec create(CampaignFlow.Client.t(), map()) :: CampaignFlow.Client.Request.response()
Creates a new user.
Examples
{:ok, user} = CampaignFlow.Client.Users.create(client, %{
email: "user@example.com",
name: "John Doe"
})
@spec get(CampaignFlow.Client.t(), integer()) :: CampaignFlow.Client.Request.response()
Retrieves a specific user by ID.
Examples
{:ok, user} = CampaignFlow.Client.Users.get(client, 123)
@spec list( CampaignFlow.Client.t(), keyword() ) :: CampaignFlow.Client.Request.response()
Lists all users.
Options
:page- Page number for pagination:per_page- Number of items per page
Examples
{:ok, users} = CampaignFlow.Client.Users.list(client)
{:ok, users} = CampaignFlow.Client.Users.list(client, page: 2)
@spec update(CampaignFlow.Client.t(), integer(), map()) :: CampaignFlow.Client.Request.response()
Updates an existing user.
Examples
{:ok, user} = CampaignFlow.Client.Users.update(client, 123, %{
name: "Jane Doe"
})