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