apitypes

Documentation

Index

• Constants
• func UsageByFeature(a, b Usage) bool
• type CheckoutRequest
• type CheckoutResponse
• type Error
  • func (e *Error) Error() string
• type Feature
• type InvoiceSettings
• type Model
• type OrgInfo
• type Phase
• type PhaseResponse
• type Plan
• type PushResponse
• type PushResult
• type ReportRequest
• type ScheduleRequest
• type ScheduleResponse
• type Tier
  • func (t *Tier) MarshalJSON() ([]byte, error)
  • func (t *Tier) UnmarshalJSON(data []byte) error
• type Usage
• type UsageResponse
• type WhoAmIResponse
• type WhoIsResponse

Constants

const Inf = 1<<63 - 1

Functions

func UsageByFeature

func UsageByFeature(a, b Usage) bool

Types

type CheckoutRequest

type CheckoutRequest struct {
	Org        string   `json:"org"`
	TrialDays  int      `json:"trial_days"`
	Features   []string `json:"features"`
	SuccessURL string   `json:"success_url"`
	CancelURL  string   `json:"cancel_url"`
}

type CheckoutResponse

type CheckoutResponse struct {
	URL string `json:"url"`
}

type Error

type Error struct {
	Status  int    `json:"status"`
	Code    string `json:"code"` // (e.g. "invalid_request")
	Message string `json:"message"`
}

func (*Error) Error

func (e *Error) Error() string

type Feature

type Feature struct {
	Title     string `json:"title,omitempty"`
	Base      int    `json:"base,omitempty"`
	Mode      string `json:"mode,omitempty"`
	Aggregate string `json:"aggregate,omitempty"`
	Tiers     []Tier `json:"tiers,omitempty"`
	PermLink  string `json:"permLink,omitempty"`
}

type InvoiceSettings

type InvoiceSettings struct {
	DefaultPaymentMethod string `json:"default_payment_method"`
}

type Model

type Model struct {
	Plans map[refs.Plan]Plan `json:"plans"`
}

type OrgInfo

type OrgInfo struct {
	Email       string            `json:"email"`
	Name        string            `json:"name"`
	Description string            `json:"description"`
	Phone       string            `json:"phone"`
	Metadata    map[string]string `json:"metadata"`

	PaymentMethod   string          `json:"payment_method"`
	InvoiceSettings InvoiceSettings `json:"invoice_settings"`
}

type Phase

type Phase struct {
	Trial     bool      `json:"trial,omitempty"`
	Effective time.Time `json:"effective,omitempty"`
	Features  []string  `json:"features,omitempty"`
}

type PhaseResponse

type PhaseResponse struct {
	Effective time.Time          `json:"effective,omitempty"`
	Features  []refs.FeaturePlan `json:"features,omitempty"`
	Plans     []refs.Plan        `json:"plans,omitempty"`
	Fragments []refs.FeaturePlan `json:"fragments,omitempty"`
}

type Plan

type Plan struct {
	Title    string                `json:"title,omitempty"`
	Interval string                `json:"interval,omitempty"`
	Currency string                `json:"currency,omitempty"`
	Features map[refs.Name]Feature `json:"features,omitempty"`
}

type PushResponse

type PushResponse struct {
	Results []PushResult `json:"results,omitempty"`
}

type PushResult

type PushResult struct {
	Feature refs.FeaturePlan `json:"feature"`
	Status  string           `json:"status"`
	Reason  string           `json:"reason"`
}

type ReportRequest

type ReportRequest struct {
	Org     string    `json:"org"`
	Feature refs.Name `json:"feature"`
	N       int       `json:"n"`
	At      time.Time `json:"at"`
	Clobber bool      `json:"clobber"`
}

type ScheduleRequest

type ScheduleRequest struct {
	Org    string   `json:"org"`
	Info   *OrgInfo `json:"info"`
	Phases []Phase  `json:"phases"`
}

type ScheduleResponse

type ScheduleResponse struct{}

ScheduleResponse is the expected response from a schedule request. It is currently empty, reserved for furture use.

type Tier

type Tier struct {
	Upto  int     `json:"upto,omitempty"`
	Price float64 `json:"price,omitempty"`
	Base  int     `json:"base,omitempty"`
}

func (*Tier) MarshalJSON

func (t *Tier) MarshalJSON() ([]byte, error)

func (*Tier) UnmarshalJSON

func (t *Tier) UnmarshalJSON(data []byte) error

type Usage

type Usage struct {
	Feature refs.Name `json:"feature"`
	Used    int       `json:"used"`
	Limit   int       `json:"limit"`
}

type UsageResponse

type UsageResponse struct {
	Org   string  `json:"org"`
	Usage []Usage `json:"usage"`
}

type WhoAmIResponse

type WhoAmIResponse struct {
	ProviderID string    `json:"id"`
	Email      string    `json:"email"`
	Created    time.Time `json:"created"`
	KeySource  string    `json:"key_source"`
	Isolated   bool      `json:"isolated"`
	URL        string    `json:"url"`
}

type WhoIsResponse

type WhoIsResponse struct {
	*OrgInfo
	Org      string `json:"org"`
	StripeID string `json:"stripe_id"`
}