appentitybase

package

v1.0.0-beta.187 Latest Latest Go to latest Published: Dec 18, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation ¶

Index ¶

type AppBase
type AppID
- func (i AppID) Validate() error
type AppStatus
type AppType
type Capability
- func (c Capability) Validate() error
type CapabilityType
type MarketplaceListing
- func (p MarketplaceListing) Validate() error

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type AppBase ¶

type AppBase struct {
	models.ManagedResource

	Type     AppType            `json:"type"`
	Status   AppStatus          `json:"status"`
	Listing  MarketplaceListing `json:"listing"`
	Metadata map[string]string  `json:"metadata"`
}

AppBase represents an abstract with the base fields of an app

func (AppBase) GetAppBase ¶

func (a AppBase) GetAppBase() AppBase

func (AppBase) GetDescription ¶

func (a AppBase) GetDescription() *string

func (AppBase) GetID ¶

func (a AppBase) GetID() AppID

func (AppBase) GetListing ¶

func (a AppBase) GetListing() MarketplaceListing

func (AppBase) GetMetadata ¶

func (a AppBase) GetMetadata() map[string]string

func (AppBase) GetName ¶

func (a AppBase) GetName() string

func (AppBase) GetStatus ¶

func (a AppBase) GetStatus() AppStatus

func (AppBase) GetType ¶

func (a AppBase) GetType() AppType

func (AppBase) Validate ¶

func (a AppBase) Validate() error

Validate validates the app base

func (AppBase) ValidateCapabilities ¶

func (a AppBase) ValidateCapabilities(capabilities ...CapabilityType) error

ValidateCapabilities validates if the app can run for the given capabilities

type AppID ¶

type AppID struct {
	Namespace string
	ID        string
}

AppID represents the unique identifier for an installed app

func (AppID) Validate ¶

func (i AppID) Validate() error

type AppStatus ¶

type AppStatus string

AppStatus represents the status of an app

const (
	AppStatusReady        AppStatus = "ready"
	AppStatusUnauthorized AppStatus = "unauthorized"
)

type AppType ¶

type AppType string

AppType represents the type of an app

const (
	AppTypeStripe  AppType = "stripe"
	AppTypeSandbox AppType = "sandbox"
)

type Capability ¶

type Capability struct {
	Type        CapabilityType `json:"type"`
	Key         string         `json:"key"`
	Name        string         `json:"name"`
	Description string         `json:"description"`
}

func (Capability) Validate ¶

func (c Capability) Validate() error

type CapabilityType ¶

type CapabilityType string

const (
	CapabilityTypeReportUsage      CapabilityType = "reportUsage"
	CapabilityTypeReportEvents     CapabilityType = "reportEvents"
	CapabilityTypeCalculateTax     CapabilityType = "calculateTax"
	CapabilityTypeInvoiceCustomers CapabilityType = "invoiceCustomers"
	CapabilityTypeCollectPayments  CapabilityType = "collectPayments"
)

type MarketplaceListing ¶

type MarketplaceListing struct {
	Type         AppType      `json:"type"`
	Name         string       `json:"name"`
	Description  string       `json:"description"`
	IconURL      string       `json:"iconUrl"`
	Capabilities []Capability `json:"capabilities"`
}

func (MarketplaceListing) Validate ¶

func (p MarketplaceListing) Validate() error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL