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