api

Documentation

Index

• func AbortBadRequest(c *gin.Context, err error)
• func AbortForbidden(c *gin.Context)
• func AbortInternalServerError(c *gin.Context, err error)
• func AbortNotFound(c *gin.Context)
• func AbortUnauthorized(c *gin.Context)
• func BearerToken(ctx *gin.Context) (string, error)
• func GetClaims(ctx *gin.Context) jwt.MapClaims
• func GetIntegrationId(ctx *gin.Context) string
• func GetLocaleCode(ctx *gin.Context) string
• func GetMemberId(ctx *gin.Context) string
• func GetOrigin(ctx *gin.Context) string
• func GetPlanId(ctx *gin.Context) string
• func GetPlanName(ctx *gin.Context) string
• func GetTrustFundId(ctx *gin.Context) int
• func HandleError(c *gin.Context, err striveexceptions.Exception)
• func NoContentResponse(c *gin.Context)
• func OkResponse(c *gin.Context, data interface{})
• func ReadFileFromRequest(req *http.Request, formKey string) ([]byte, string, error)
• func Realm(ctx *gin.Context) string
• func SetClaims(ctx *gin.Context, claims jwt.MapClaims)
• func SetIntegrationId(ctx *gin.Context, integrationId string)
• func SetLocaleCode(ctx *gin.Context, localeCode string)
• func SetPlanId(ctx *gin.Context, planId string)
• func SetPlanName(ctx *gin.Context, planName string)
• func SetTrustFundId(ctx *gin.Context, trustFundId int)
• func UserId(ctx *gin.Context) string
• func Username(ctx *gin.Context) string
• type Api
• type ApiError
  • func NewError(message, path string, statusCode int) *ApiError
  • func NewErrorCode(message, path string, err error) *ApiError
• type ApiResponse
  • func (r ApiResponse) Serialize() (*string, *string)
  • func (r ApiResponse) ToString() string
• type ApiRoute
  • func (a ApiRoute) ShouldCheckPlanId() bool
• type EventHandlerError
  • func FatalEventError(err error) *EventHandlerError
  • func RetriableEventError(err error) *EventHandlerError
• type EventHandlerFunc
• type EventRoute
• type MethodType

Functions

func AbortBadRequest

func AbortBadRequest(c *gin.Context, err error)

func AbortForbidden

func AbortForbidden(c *gin.Context)

func AbortInternalServerError

func AbortInternalServerError(c *gin.Context, err error)

func AbortNotFound

func AbortNotFound(c *gin.Context)

func AbortUnauthorized

func AbortUnauthorized(c *gin.Context)

func BearerToken

func BearerToken(ctx *gin.Context) (string, error)

func GetClaims

func GetClaims(ctx *gin.Context) jwt.MapClaims

func GetIntegrationId

func GetIntegrationId(ctx *gin.Context) string

func GetLocaleCode

func GetLocaleCode(ctx *gin.Context) string

func GetMemberId

func GetMemberId(ctx *gin.Context) string

func GetOrigin

func GetOrigin(ctx *gin.Context) string

func GetPlanId

func GetPlanId(ctx *gin.Context) string

func GetPlanName

func GetPlanName(ctx *gin.Context) string

func GetTrustFundId

func GetTrustFundId(ctx *gin.Context) int

Deprecated: Use GetPlanId instead

func HandleError

func HandleError(c *gin.Context, err striveexceptions.Exception)

func NoContentResponse

func NoContentResponse(c *gin.Context)

func OkResponse

func OkResponse(c *gin.Context, data interface{})

func ReadFileFromRequest

func ReadFileFromRequest(req *http.Request, formKey string) ([]byte, string, error)

func Realm

func Realm(ctx *gin.Context) string

func SetClaims

func SetClaims(ctx *gin.Context, claims jwt.MapClaims)

func SetIntegrationId

func SetIntegrationId(ctx *gin.Context, integrationId string)

func SetLocaleCode

func SetLocaleCode(ctx *gin.Context, localeCode string)

func SetPlanId

func SetPlanId(ctx *gin.Context, planId string)

func SetPlanName

func SetPlanName(ctx *gin.Context, planName string)

func SetTrustFundId

func SetTrustFundId(ctx *gin.Context, trustFundId int)

Deprecated: Use SetPlanId instead

func UserId

func UserId(ctx *gin.Context) string

func Username

func Username(ctx *gin.Context) string

Types

type Api

type Api interface {
	GetRoutes() []ApiRoute
}

type ApiError

type ApiError struct {
	Message string      `json:"message"`
	Path    string      `json:"path"`
	Code    int         `json:"code"`
	Detail  interface{} `json:"detail"`
}

func NewError

func NewError(message, path string, statusCode int) *ApiError

Deprecated: Will be removed in future versions

func NewErrorCode

func NewErrorCode(message, path string, err error) *ApiError

type ApiResponse

type ApiResponse struct {
	Data  interface{} `json:"data"`
	Error *ApiError   `json:"error"`
}

func (ApiResponse) Serialize

func (r ApiResponse) Serialize() (*string, *string)

func (ApiResponse) ToString

func (r ApiResponse) ToString() string

type ApiRoute

type ApiRoute struct {
	MethodType MethodType
	Anonymous  bool
	// Deprecated: Use SkipPlanCheck instead
	SkipTrustFundCheck   bool
	SkipPlanCheck        bool
	SkipIntegrationCheck bool
	Path                 string
	Handler              gin.HandlerFunc
}

func (ApiRoute) ShouldCheckPlanId

func (a ApiRoute) ShouldCheckPlanId() bool

type EventHandlerError

type EventHandlerError struct {
	Error    error
	CanRetry bool
}

func FatalEventError

func FatalEventError(err error) *EventHandlerError

func RetriableEventError

func RetriableEventError(err error) *EventHandlerError

type EventHandlerFunc

type EventHandlerFunc func(e event.Event) *EventHandlerError

type EventRoute

type EventRoute struct {
	AlwaysAck    bool
	Handler      EventHandlerFunc
	Subscription subscribe.Subscription
}

type MethodType

type MethodType int

const (
	GET MethodType = iota
	POST
	PUT
	DELETE
)