event_docs.go

package gosparkpost

import (
	"context"
	"encoding/json"
	"fmt"

	"github.com/pkg/errors"
)

var EventDocumentationFormat = "/api/v%d/webhooks/events/documentation"

type EventGroup struct {
	Name        string
	Events      map[string]EventMeta `json:"events"`
	Description string               `json:"description"`
	DisplayName string               `json:"display_name"`
}

type EventMeta struct {
	Name        string
	Fields      map[string]EventField `json:"event"`
	Description string                `json:"description"`
	DisplayName string                `json:"display_name"`
}

type EventField struct {
	Description string      `json:"description"`
	SampleValue interface{} `json:"sampleValue"`
}

func (c *Client) EventDocumentation() (g map[string]*EventGroup, res *Response, err error) {
	return c.EventDocumentationContext(context.Background())
}

func (c *Client) EventDocumentationContext(ctx context.Context) (groups map[string]*EventGroup, res *Response, err error) {
	path := fmt.Sprintf(EventDocumentationFormat, c.Config.ApiVersion)
	res, err = c.HttpGet(ctx, c.Config.BaseUrl+path)
	if err != nil {
		return
	}

	var body []byte
	if body, err = res.AssertJson(); err != nil {
		return
	}

	if Is2XX(res.HTTP.StatusCode) {
		var ok bool
		var results map[string]map[string]*EventGroup
		if err = json.Unmarshal(body, &results); err != nil {
		} else if groups, ok = results["results"]; ok {
			// Success!
		} else {
			err = errors.New("Unexpected response format (results)")
		}
	} else {
		if err = res.ParseResponse(); err == nil {
			err = res.HTTPError()
		}
	}
	return
}