consoleapi

Documentation

Index

• Variables
• type APIKeys
  • func NewAPIKeys(log *zap.Logger, service *console.Service) *APIKeys
  • func (keys *APIKeys) DeleteByNameAndProjectID(w http.ResponseWriter, r *http.Request)
• type Analytics
  • func NewAnalytics(log *zap.Logger, service *console.Service, a *analytics.Service) *Analytics
  • func (a *Analytics) EventTriggered(w http.ResponseWriter, r *http.Request)
• type Auth
  • func NewAuth(log *zap.Logger, service *console.Service, mailService *mailservice.Service, ...) *Auth
  • func (a *Auth) ChangeEmail(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) ChangePassword(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) DeleteAccount(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) DisableUserMFA(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) EnableUserMFA(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) ForgotPassword(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) GenerateMFARecoveryCodes(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) GenerateMFASecretKey(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) GetAccount(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) Logout(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) Register(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) ResendEmail(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) ResetPassword(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) Token(w http.ResponseWriter, r *http.Request)
  • func (a *Auth) UpdateAccount(w http.ResponseWriter, r *http.Request)
• type Buckets
  • func NewBuckets(log *zap.Logger, service *console.Service) *Buckets
  • func (b *Buckets) AllBucketNames(w http.ResponseWriter, r *http.Request)
• type ContextChannel
  • func (c *ContextChannel) Get(ctx context.Context) (interface{}, error)
  • func (c *ContextChannel) Send(ctx context.Context, val interface{}) error
• type Handler
  • func NewProjectManagement(log *zap.Logger, service ProjectManagementService, router *mux.Router, ...) *Handler
• type Payments
  • func NewPayments(log *zap.Logger, service *console.Service) *Payments
  • func (p *Payments) AccountBalance(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) AddCreditCard(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) ApplyCouponCode(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) BillingHistory(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) GetCoupon(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) ListCreditCards(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) MakeCreditCardDefault(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) ProjectsCharges(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) RemoveCreditCard(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) SetupAccount(w http.ResponseWriter, r *http.Request)
  • func (p *Payments) TokenDeposit(w http.ResponseWriter, r *http.Request)
• type ProjectManagementService
• type UsageLimits
  • func NewUsageLimits(log *zap.Logger, service *console.Service) *UsageLimits
  • func (ul *UsageLimits) DailyUsage(w http.ResponseWriter, r *http.Request)
  • func (ul *UsageLimits) ProjectUsageLimits(w http.ResponseWriter, r *http.Request)
  • func (ul *UsageLimits) TotalUsageLimits(w http.ResponseWriter, r *http.Request)

Variables

var (
	// ErrAPIKeysAPI - console api keys api error type.
	ErrAPIKeysAPI = errs.Class("console api keys")
)

var (
	// ErrAnalyticsAPI - console analytics api error type.
	ErrAnalyticsAPI = errs.Class("consoleapi analytics")
)

var (
	// ErrAuthAPI - console auth api error type.
	ErrAuthAPI = errs.Class("consoleapi auth")
)

var (
	// ErrBucketsAPI - console buckets api error type.
	ErrBucketsAPI = errs.Class("console api buckets")
)

var (
	// ErrPaymentsAPI - console payments api error type.
	ErrPaymentsAPI = errs.Class("consoleapi payments")
)

var ErrProjectsAPI = errs.Class("consoleapi projects api")

var (
	// ErrUsageLimitsAPI - console usage and limits api error type.
	ErrUsageLimitsAPI = errs.Class("console usage and limits")
)

var (
	// ErrUtils - console utils error type.
	ErrUtils = errs.Class("console api utils")
)

Types

type APIKeys

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

APIKeys is an api controller that exposes all api keys related functionality.

func NewAPIKeys

func NewAPIKeys(log *zap.Logger, service *console.Service) *APIKeys

NewAPIKeys is a constructor for api api keys controller.

func (*APIKeys) DeleteByNameAndProjectID

func (keys *APIKeys) DeleteByNameAndProjectID(w http.ResponseWriter, r *http.Request)

DeleteByNameAndProjectID deletes specific api key by it's name and project ID.

type Analytics

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

Analytics is an api controller that exposes analytics related functionality.

func NewAnalytics

func NewAnalytics(log *zap.Logger, service *console.Service, a *analytics.Service) *Analytics

NewAnalytics is a constructor for api analytics controller.

func (*Analytics) EventTriggered

func (a *Analytics) EventTriggered(w http.ResponseWriter, r *http.Request)

EventTriggered tracks the occurrence of an arbitrary event on the client.

type Auth

type Auth struct {
	ExternalAddress           string
	LetUsKnowURL              string
	TermsAndConditionsURL     string
	ContactInfoURL            string
	PasswordRecoveryURL       string
	CancelPasswordRecoveryURL string
	ActivateAccountURL        string
	// contains filtered or unexported fields
}

Auth is an api controller that exposes all auth functionality.

func NewAuth

func NewAuth(log *zap.Logger, service *console.Service, mailService *mailservice.Service, cookieAuth *consolewebauth.CookieAuth, partners *rewards.PartnersService, analytics *analytics.Service, externalAddress string, letUsKnowURL string, termsAndConditionsURL string, contactInfoURL string) *Auth

NewAuth is a constructor for api auth controller.

func (*Auth) ChangeEmail

func (a *Auth) ChangeEmail(w http.ResponseWriter, r *http.Request)

ChangeEmail auth user, changes users email for a new one.

func (*Auth) ChangePassword

func (a *Auth) ChangePassword(w http.ResponseWriter, r *http.Request)

ChangePassword auth user, changes users password for a new one.

func (*Auth) DeleteAccount

func (a *Auth) DeleteAccount(w http.ResponseWriter, r *http.Request)

DeleteAccount authorizes user and deletes account by password.

func (*Auth) DisableUserMFA

func (a *Auth) DisableUserMFA(w http.ResponseWriter, r *http.Request)

DisableUserMFA disables multi-factor authentication for the user.

func (*Auth) EnableUserMFA

func (a *Auth) EnableUserMFA(w http.ResponseWriter, r *http.Request)

EnableUserMFA enables multi-factor authentication for the user.

func (*Auth) ForgotPassword

func (a *Auth) ForgotPassword(w http.ResponseWriter, r *http.Request)

ForgotPassword creates password-reset token and sends email to user.

func (*Auth) GenerateMFARecoveryCodes

func (a *Auth) GenerateMFARecoveryCodes(w http.ResponseWriter, r *http.Request)

GenerateMFARecoveryCodes creates a new set of MFA recovery codes for the user.

func (*Auth) GenerateMFASecretKey

func (a *Auth) GenerateMFASecretKey(w http.ResponseWriter, r *http.Request)

GenerateMFASecretKey creates a new TOTP secret key for the user.

func (*Auth) GetAccount

func (a *Auth) GetAccount(w http.ResponseWriter, r *http.Request)

GetAccount gets authorized user and take it's params.

func (*Auth) Logout

func (a *Auth) Logout(w http.ResponseWriter, r *http.Request)

Logout removes auth cookie.

func (*Auth) Register

func (a *Auth) Register(w http.ResponseWriter, r *http.Request)

Register creates new user, sends activation e-mail. If a user with the given e-mail address already exists, a password reset e-mail is sent instead.

func (*Auth) ResendEmail

func (a *Auth) ResendEmail(w http.ResponseWriter, r *http.Request)

ResendEmail generates activation token by e-mail address and sends email account activation email to user. If the account is already activated, a password reset e-mail is sent instead.

func (*Auth) ResetPassword

func (a *Auth) ResetPassword(w http.ResponseWriter, r *http.Request)

ResetPassword resets user's password using recovery token.

func (*Auth) Token

func (a *Auth) Token(w http.ResponseWriter, r *http.Request)

Token authenticates user by credentials and returns auth token.

func (*Auth) UpdateAccount

func (a *Auth) UpdateAccount(w http.ResponseWriter, r *http.Request)

UpdateAccount updates user's full name and short name.

type Buckets

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

Buckets is an api controller that exposes all buckets related functionality.

func NewBuckets

func NewBuckets(log *zap.Logger, service *console.Service) *Buckets

NewBuckets is a constructor for api buckets controller.

func (*Buckets) AllBucketNames

func (b *Buckets) AllBucketNames(w http.ResponseWriter, r *http.Request)

AllBucketNames returns all bucket names for a specific project.

type ContextChannel

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

ContextChannel is a generic, context-aware channel.

func (*ContextChannel) Get

func (c *ContextChannel) Get(ctx context.Context) (interface{}, error)

Get waits until a value is sent and returns it, or returns an error if the context has closed.

func (*ContextChannel) Send

func (c *ContextChannel) Send(ctx context.Context, val interface{}) error

Send waits until a value can be sent and sends it, or returns an error if the context has closed.

type Handler

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

Handler is an api handler that exposes all projects related functionality.

func NewProjectManagement

func NewProjectManagement(log *zap.Logger, service ProjectManagementService, router *mux.Router, auth api.Auth) *Handler

type Payments

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

Payments is an api controller that exposes all payment related functionality.

func NewPayments

func NewPayments(log *zap.Logger, service *console.Service) *Payments

NewPayments is a constructor for api payments controller.

func (*Payments) AccountBalance

func (p *Payments) AccountBalance(w http.ResponseWriter, r *http.Request)

AccountBalance returns an integer amount in cents that represents the current balance of payment account.

func (*Payments) AddCreditCard

func (p *Payments) AddCreditCard(w http.ResponseWriter, r *http.Request)

AddCreditCard is used to save new credit card and attach it to payment account.

func (*Payments) ApplyCouponCode

func (p *Payments) ApplyCouponCode(w http.ResponseWriter, r *http.Request)

ApplyCouponCode applies a coupon code to the user's account.

func (*Payments) BillingHistory

func (p *Payments) BillingHistory(w http.ResponseWriter, r *http.Request)

BillingHistory returns a list of invoices, transactions and all others billing history items for payment account.

func (*Payments) GetCoupon

func (p *Payments) GetCoupon(w http.ResponseWriter, r *http.Request)

GetCoupon returns the coupon applied to the user's account.

func (*Payments) ListCreditCards

func (p *Payments) ListCreditCards(w http.ResponseWriter, r *http.Request)

ListCreditCards returns a list of credit cards for a given payment account.

func (*Payments) MakeCreditCardDefault

func (p *Payments) MakeCreditCardDefault(w http.ResponseWriter, r *http.Request)

MakeCreditCardDefault makes a credit card default payment method.

func (*Payments) ProjectsCharges

func (p *Payments) ProjectsCharges(w http.ResponseWriter, r *http.Request)

ProjectsCharges returns how much money current user will be charged for each project which he owns.

func (*Payments) RemoveCreditCard

func (p *Payments) RemoveCreditCard(w http.ResponseWriter, r *http.Request)

RemoveCreditCard is used to detach a credit card from payment account.

func (*Payments) SetupAccount

func (p *Payments) SetupAccount(w http.ResponseWriter, r *http.Request)

SetupAccount creates a payment account for the user.

func (*Payments) TokenDeposit

func (p *Payments) TokenDeposit(w http.ResponseWriter, r *http.Request)

TokenDeposit creates new deposit transaction and info about address and amount of newly created tx.

type ProjectManagementService

type ProjectManagementService interface {
	GetUserProjects(context.Context) ([]console.Project, api.HTTPError)
}

type UsageLimits

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

UsageLimits is an api controller that exposes all usage and limits related functionality.

func NewUsageLimits

func NewUsageLimits(log *zap.Logger, service *console.Service) *UsageLimits

NewUsageLimits is a constructor for api usage and limits controller.

func (*UsageLimits) DailyUsage

func (ul *UsageLimits) DailyUsage(w http.ResponseWriter, r *http.Request)

DailyUsage returns daily usage by project ID.

func (*UsageLimits) ProjectUsageLimits

func (ul *UsageLimits) ProjectUsageLimits(w http.ResponseWriter, r *http.Request)

ProjectUsageLimits returns usage and limits by project ID.

func (*UsageLimits) TotalUsageLimits

func (ul *UsageLimits) TotalUsageLimits(w http.ResponseWriter, r *http.Request)

TotalUsageLimits returns total usage and limits for all the projects that user owns.