Connected social accounts — what a post is actually delivered to.
Accounts on platforms that use OAuth are connected in the FoPost dashboard; create/2
is for the platforms where you already hold the credentials.
Summary
Functions
An account's stored follower snapshots, newest first.
Same as analytics/3, but raises FoPost.Error.
Connects an account from credentials you already hold.
Same as create/2, but raises FoPost.Error.
Disconnects an account.
Same as delete/2, but raises FoPost.Error.
One account.
Same as get/2, but raises FoPost.Error.
One account's health.
Same as health/3, but raises FoPost.Error.
Every reachable account's health, optionally narrowed with :workspace_id.
Same as health_summary/2, but raises FoPost.Error.
The connected accounts the key can reach, optionally narrowed with :workspace_id.
Same as list/2, but raises FoPost.Error.
Renews an account's OAuth token ahead of its expiry.
Same as refresh_token/2, but raises FoPost.Error.
Makes this the account that leads its platform in the workspace.
Same as set_primary/2, but raises FoPost.Error.
Checks an account's stored credentials against the platform.
Same as validate/2, but raises FoPost.Error.
Functions
@spec analytics(FoPost.Client.t(), String.t(), keyword()) :: {:ok, FoPost.AccountAnalytics.t()} | {:error, FoPost.Error.t()}
An account's stored follower snapshots, newest first.
:limit caps how many come back; leaving it out keeps the API's own default.
Same as analytics/3, but raises FoPost.Error.
@spec create( FoPost.Client.t(), keyword() ) :: {:ok, FoPost.Account.t()} | {:error, FoPost.Error.t()}
Connects an account from credentials you already hold.
Required: :workspace_id, :platform, :username, :name. Optional: :avatar,
:credentials — a map of the platform's own fields.
Same as create/2, but raises FoPost.Error.
@spec delete(FoPost.Client.t(), String.t()) :: {:ok, FoPost.Message.t()} | {:error, FoPost.Error.t()}
Disconnects an account.
Same as delete/2, but raises FoPost.Error.
@spec get(FoPost.Client.t(), String.t()) :: {:ok, FoPost.Account.t()} | {:error, FoPost.Error.t()}
One account.
Same as get/2, but raises FoPost.Error.
@spec health(FoPost.Client.t(), String.t(), keyword()) :: {:ok, FoPost.AccountHealth.t()} | {:error, FoPost.Error.t()}
One account's health.
Pass refresh: true to check it live rather than reading the last stored result.
Same as health/3, but raises FoPost.Error.
@spec health_summary( FoPost.Client.t(), keyword() ) :: {:ok, FoPost.HealthSummary.t()} | {:error, FoPost.Error.t()}
Every reachable account's health, optionally narrowed with :workspace_id.
Same as health_summary/2, but raises FoPost.Error.
@spec list( FoPost.Client.t(), keyword() ) :: {:ok, [FoPost.Account.t()]} | {:error, FoPost.Error.t()}
The connected accounts the key can reach, optionally narrowed with :workspace_id.
Same as list/2, but raises FoPost.Error.
@spec refresh_token(FoPost.Client.t(), String.t()) :: {:ok, FoPost.TokenRefresh.t()} | {:error, FoPost.Error.t()}
Renews an account's OAuth token ahead of its expiry.
Same as refresh_token/2, but raises FoPost.Error.
@spec set_primary(FoPost.Client.t(), String.t()) :: {:ok, FoPost.Account.t()} | {:error, FoPost.Error.t()}
Makes this the account that leads its platform in the workspace.
Same as set_primary/2, but raises FoPost.Error.
@spec validate(FoPost.Client.t(), String.t()) :: {:ok, FoPost.ValidationResult.t()} | {:error, FoPost.Error.t()}
Checks an account's stored credentials against the platform.
Same as validate/2, but raises FoPost.Error.