cfapi

Documentation

Index

• type APIError
  • func (a *APIError) Error() string
  • func (a *APIError) Is(target error) bool
• type APIResponse
• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() *Client
  • func (b *Builder) Clone() *Builder
  • func (b *Builder) WithClient(hc *http.Client) *Builder
  • func (b *Builder) WithServiceKey(key []byte) *Builder
  • func (b *Builder) WithToken(token []byte) *Builder
• type Client
  • func New(options ...Options) *Client
  • func (c *Client) Sign(ctx context.Context, req *SignRequest) (*SignResponse, error)
• type Interface
• type Options
  • func WithClient(client *http.Client) Options
  • func WithEndpoint(endpoint string) (Options, error)
  • func WithServiceKey(key []byte) Options
  • func WithToken(token []byte) Options
• type SignRequest
• type SignResponse
  • func (r *SignResponse) UnmarshalJSON(p []byte) error

Types

type APIError

type APIError struct {
	Code    int    `json:"code"`
	Message string `json:"message"`
	RayID   string `json:"-"`
}

func (*APIError) Error

func (a *APIError) Error() string

func (*APIError) Is

func (a *APIError) Is(target error) bool

type APIResponse

type APIResponse struct {
	Success  bool            `json:"success"`
	Errors   []APIError      `json:"errors"`
	Messages []string        `json:"messages"`
	Result   json.RawMessage `json:"result"`
}

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

func NewBuilder

func NewBuilder() *Builder

func (*Builder) Build

func (b *Builder) Build() *Client

func (*Builder) Clone

func (b *Builder) Clone() *Builder

func (*Builder) WithClient

func (b *Builder) WithClient(hc *http.Client) *Builder

func (*Builder) WithServiceKey

func (b *Builder) WithServiceKey(key []byte) *Builder

func (*Builder) WithToken

func (b *Builder) WithToken(token []byte) *Builder

type Client

type Client struct {
	// contains filtered or unexported fields
}

func New

func New(options ...Options) *Client

func (*Client) Sign

func (c *Client) Sign(ctx context.Context, req *SignRequest) (*SignResponse, error)

type Interface

type Interface interface {
	Sign(context.Context, *SignRequest) (*SignResponse, error)
}

type Options

type Options func(c *Client)

func WithClient

func WithClient(client *http.Client) Options

func WithEndpoint

func WithEndpoint(endpoint string) (Options, error)

func WithServiceKey

func WithServiceKey(key []byte) Options

func WithToken

func WithToken(token []byte) Options

type SignRequest

type SignRequest struct {
	Hostnames []string `json:"hostnames"`
	Validity  int      `json:"requested_validity"`
	Type      string   `json:"request_type"`
	CSR       string   `json:"csr"`
}

type SignResponse

type SignResponse struct {
	Id          string    `json:"id"`
	Certificate string    `json:"certificate"`
	Hostnames   []string  `json:"hostnames"`
	Expiration  time.Time `json:"expires_on"`
	Type        string    `json:"request_type"`
	Validity    int       `json:"requested_validity"`
	CSR         string    `json:"csr"`
}

func (*SignResponse) UnmarshalJSON

func (r *SignResponse) UnmarshalJSON(p []byte) error

adapted from http://choly.ca/post/go-json-marshalling/