Documentation ¶
Overview ¶
Package convertkit provides a client to the ConvertKit API v3. See http://help.convertkit.com/article/33-api-documentation-v3
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ( // ErrKeyMissing is returned when the API key is required, but not present. ErrKeyMissing = errors.New("ConvertKit API key missing") // ErrSecretMissing is returned when the API secret is required, but not present. ErrSecretMissing = errors.New("ConvertKit API secret missing") )
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is the client to the ConvertKit API. Create a client with NewClient.
func (*Client) Subscribers ¶
func (c *Client) Subscribers(query *SubscriberQuery) ([]Subscriber, error)
Subscribers returns a list of all confirmed subscribers.
func (*Client) TotalSubscribers ¶
TotalSubscribers returns the number of confirmed subscribers.
type Config ¶
Config is used to configure the creation of the client.
func DefaultConfig ¶
func DefaultConfig() *Config
DefaultConfig returns a default configuration for the client. It parses the environment variables CONVERTKIT_ENDPOINT, CONVERTKIT_API_KEY, and CONVERTKIT_API_SECRET.
Click to show internal directories.
Click to hide internal directories.