appentity

type App interface {
	GetAppBase() appentitybase.AppBase
	GetID() appentitybase.AppID
	GetType() appentitybase.AppType
	GetName() string
	GetDescription() *string
	GetStatus() appentitybase.AppStatus
	GetMetadata() map[string]string
	GetListing() appentitybase.MarketplaceListing

	// ValidateCapabilities validates if the app can run for the given capabilities
	ValidateCapabilities(capabilities ...appentitybase.CapabilityType) error

	// Customer data
	GetCustomerData(ctx context.Context, input GetAppInstanceCustomerDataInput) (CustomerData, error)
	UpsertCustomerData(ctx context.Context, input UpsertAppInstanceCustomerDataInput) error
	DeleteCustomerData(ctx context.Context, input DeleteAppInstanceCustomerDataInput) error
}

type AppFactory interface {
	NewApp(context.Context, appentitybase.AppBase) (App, error)
	InstallAppWithAPIKey(ctx context.Context, input AppFactoryInstallAppWithAPIKeyInput) (App, error)
	UninstallApp(ctx context.Context, input UninstallAppInput) error
}

type AppFactoryInstallAppWithAPIKeyInput struct {
	Namespace string
	APIKey    string
	BaseURL   string
	Name      string
}

type AuthorizeOauth2InstallInput struct {
	MarketplaceListingID

	Code string
	// Success response fields
	State string
	// Error response fields
	Error            string
	ErrorDescription string
	ErrorURI         string
}

type CreateAppInput struct {
	Namespace   string
	Name        string
	Description string
	Type        appentitybase.AppType
}

type CustomerApp struct {
	App          App
	CustomerData CustomerData
}

type CustomerData interface {
	Validate() error
}

type DeleteAppInstanceCustomerDataInput struct {
	CustomerID customerentity.CustomerID
}

type GetAppInput = appentitybase.AppID

type GetAppInstanceCustomerDataInput struct {
	CustomerID customerentity.CustomerID
}

type GetDefaultAppInput struct {
	Namespace string
	Type      appentitybase.AppType
}

type GetOauth2InstallURLInput = MarketplaceListingID

type GetOauth2InstallURLOutput struct {
	URL string
}

type InstallAppWithAPIKeyInput struct {
	MarketplaceListingID

	Namespace string
	APIKey    string
	Name      string
}

type ListAppInput struct {
	Namespace string
	pagination.Page

	Type           *appentitybase.AppType
	IncludeDeleted bool
	// Only list apps that has data for the given customer
	CustomerID *customerentity.CustomerID
}

type MarketplaceGetInput = MarketplaceListingID

type MarketplaceListInput struct {
	pagination.Page
}

type MarketplaceListingID struct {
	Type appentitybase.AppType
}

type RegisterMarketplaceListingInput = RegistryItem

type RegistryItem struct {
	Listing appentitybase.MarketplaceListing
	Factory AppFactory
}

type UninstallAppInput = appentitybase.AppID

type UpsertAppInstanceCustomerDataInput struct {
	CustomerID customerentity.CustomerID
	Data       CustomerData
}