schema

package
v1.0.19 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2025 License: AGPL-3.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Idx_tenant_environment_credit_note_number_unique = "idx_tenant_environment_credit_note_number_unique"
	Idx_tenant_environment_subscription_id_unique    = "idx_tenant_environment_subscription_id_unique"
)

Variables

View Source 
var Idx_tenant_environment_external_id_unique = "idx_tenant_environment_external_id_unique"
View Source 
var Idx_tenant_environment_idempotency_key_unique = "idx_tenant_environment_idempotency_key_unique"
View Source 
var Idx_tenant_environment_invoice_number_unique = "idx_tenant_environment_invoice_number_unique"
View Source 
var Idx_tenant_environment_lookup_key = "idx_tenant_environment_lookup_key"

Functions

This section is empty.

Types

type Auth 

type Auth struct {
	ent.Schema
}

Auth holds the schema definition for the Auth entity.

func (Auth) Fields 

func (Auth) Fields() []ent.Field

func (Auth) Indexes 

func (Auth) Indexes() []ent.Index

Indexes of the Auth.

type BillingSequence 

type BillingSequence struct {
	ent.Schema
}

BillingSequence holds the schema definition for the BillingSequence entity.

func (BillingSequence) Edges 

func (BillingSequence) Edges() []ent.Edge

Edges of the BillingSequence.

func (BillingSequence) Fields 

func (BillingSequence) Fields() []ent.Field

Fields of the BillingSequence.

func (BillingSequence) Indexes 

func (BillingSequence) Indexes() []ent.Index

Indexes of the BillingSequence.

type Costsheet added in v1.0.18 

type Costsheet struct {
	ent.Schema
}

Costsheet represents the core entity for tracking cost-related configurations in the billing system. It establishes relationships between meters (what we measure) and prices (how much we charge). This entity is crucial for: 1. Determining the cost basis for billing calculations 2. Mapping usage metrics to their associated prices 3. Supporting margin and cost analysis features

func (Costsheet) Annotations added in v1.0.18 

func (Costsheet) Annotations() []schema.Annotation

Annotations configures the underlying database schema. Here we explicitly set the table name to 'costsheet' (singular form) to maintain consistency with our naming conventions.

func (Costsheet) Edges added in v1.0.18 

func (Costsheet) Edges() []ent.Edge

Edges defines the relationships between Costsheet and other entities. These relationships are crucial for: 1. Cost calculation workflows 2. Usage tracking 3. Price application

func (Costsheet) Fields added in v1.0.18 

func (Costsheet) Fields() []ent.Field

Schema fields for the Costsheet entity.

func (Costsheet) Indexes added in v1.0.18 

func (Costsheet) Indexes() []ent.Index

Indexes improves query performance and ensures data integrity. We index: 1. tenant_id + environment_id: For fast multi-tenant, multi-environment queries 2. meter_id + price_id: For unique constraint and fast lookups

func (Costsheet) Mixin added in v1.0.18 

func (Costsheet) Mixin() []ent.Mixin

Mixin injects common fields into the schema. We include: 1. BaseMixin: Common fields for all entities

  • tenant_id: Multi-tenancy support
  • status: Record status (published, draft, etc.)
  • created_at, updated_at: Timestamps
  • created_by, updated_by: Audit fields

2. EnvironmentMixin: Environment segregation

  • environment_id: Separates data by environment (prod, staging, etc.)

type CreditGrant added in v1.0.18 

type CreditGrant struct {
	ent.Schema
}

CreditGrant holds the schema definition for the CreditGrant entity.

func (CreditGrant) Edges added in v1.0.18 

func (CreditGrant) Edges() []ent.Edge

Edges of the CreditGrant entity.

func (CreditGrant) Fields added in v1.0.18 

func (CreditGrant) Fields() []ent.Field

Fields of the CreditGrant entity.

func (CreditGrant) Indexes added in v1.0.18 

func (CreditGrant) Indexes() []ent.Index

Indexes of the CreditGrant entity.

func (CreditGrant) Mixin added in v1.0.18 

func (CreditGrant) Mixin() []ent.Mixin

Mixin of the CreditGrant entity.

type CreditGrantApplication added in v1.0.18 

type CreditGrantApplication struct {
	ent.Schema
}

func (CreditGrantApplication) Edges added in v1.0.18 

func (CreditGrantApplication) Edges() []ent.Edge

Edges of the CreditGrantApplication.

func (CreditGrantApplication) Fields added in v1.0.18 

func (CreditGrantApplication) Fields() []ent.Field

Fields of the CreditGrantApplication.

func (CreditGrantApplication) Mixin added in v1.0.18 

func (CreditGrantApplication) Mixin() []ent.Mixin

type CreditNote added in v1.0.18 

type CreditNote struct {
	ent.Schema
}

CreditNote holds the schema definition for the CreditNote entity.

func (CreditNote) Edges added in v1.0.18 

func (CreditNote) Edges() []ent.Edge

Edges of the CreditNote.

func (CreditNote) Fields added in v1.0.18 

func (CreditNote) Fields() []ent.Field

Fields of the CreditNote entity.

func (CreditNote) Indexes added in v1.0.18 

func (CreditNote) Indexes() []ent.Index

func (CreditNote) Mixin added in v1.0.18 

func (CreditNote) Mixin() []ent.Mixin

Mixin of the CreditNote entity.

type CreditNoteLineItem added in v1.0.18 

type CreditNoteLineItem struct {
	ent.Schema
}

CreditNoteLineItem holds the schema definition for the CreditNoteLineItem entity.

func (CreditNoteLineItem) Edges added in v1.0.18 

func (CreditNoteLineItem) Edges() []ent.Edge

Edges of the CreditNoteLineItem.

func (CreditNoteLineItem) Fields added in v1.0.18 

func (CreditNoteLineItem) Fields() []ent.Field

func (CreditNoteLineItem) Mixin added in v1.0.18 

func (CreditNoteLineItem) Mixin() []ent.Mixin

type Customer 

type Customer struct {
	ent.Schema
}

Customer holds the schema definition for the Customer entity.

func (Customer) Edges 

func (Customer) Edges() []ent.Edge

Edges of the Customer.

func (Customer) Fields 

func (Customer) Fields() []ent.Field

Fields of the Customer.

func (Customer) Indexes 

func (Customer) Indexes() []ent.Index

Indexes of the Customer.

func (Customer) Mixin 

func (Customer) Mixin() []ent.Mixin

Mixin of the Customer.

type Entitlement 

type Entitlement struct {
	ent.Schema
}

Entitlement holds the schema definition for the Entitlement entity.

func (Entitlement) Edges 

func (Entitlement) Edges() []ent.Edge

Edges of the Entitlement.

func (Entitlement) Fields 

func (Entitlement) Fields() []ent.Field

Fields of the Entitlement.

func (Entitlement) Indexes 

func (Entitlement) Indexes() []ent.Index

Indexes of the Entitlement.

func (Entitlement) Mixin 

func (Entitlement) Mixin() []ent.Mixin

Mixin of the Entitlement.

type Environment 

type Environment struct {
	ent.Schema
}

Environment holds the schema definition for the Environment entity.

func (Environment) Fields 

func (Environment) Fields() []ent.Field

func (Environment) Indexes 

func (Environment) Indexes() []ent.Index

Indexes of the Environment.

func (Environment) Mixin 

func (Environment) Mixin() []ent.Mixin

Mixin of the Environment.

type Feature 

type Feature struct {
	ent.Schema
}

Feature holds the schema definition for the Feature entity.

func (Feature) Fields 

func (Feature) Fields() []ent.Field

func (Feature) Indexes 

func (Feature) Indexes() []ent.Index

Indexes of the Feature.

func (Feature) Mixin 

func (Feature) Mixin() []ent.Mixin

Mixin of the Feature.

type Invoice 

type Invoice struct {
	ent.Schema
}

Invoice holds the schema definition for the Invoice entity.

func (Invoice) Edges 

func (Invoice) Edges() []ent.Edge

Edges of the Invoice.

func (Invoice) Fields 

func (Invoice) Fields() []ent.Field

Fields of the Invoice.

func (Invoice) Indexes 

func (Invoice) Indexes() []ent.Index

Indexes of the Invoice.

func (Invoice) Mixin 

func (Invoice) Mixin() []ent.Mixin

Mixin of the Invoice.

type InvoiceLineItem 

type InvoiceLineItem struct {
	ent.Schema
}

InvoiceLineItem holds the schema definition for the InvoiceLineItem entity.

func (InvoiceLineItem) Edges 

func (InvoiceLineItem) Edges() []ent.Edge

Edges of the InvoiceLineItem.

func (InvoiceLineItem) Fields 

func (InvoiceLineItem) Fields() []ent.Field

Fields of the InvoiceLineItem.

func (InvoiceLineItem) Indexes 

func (InvoiceLineItem) Indexes() []ent.Index

Indexes of the InvoiceLineItem.

func (InvoiceLineItem) Mixin 

func (InvoiceLineItem) Mixin() []ent.Mixin

Mixin of the InvoiceLineItem.

type InvoiceSequence 

type InvoiceSequence struct {
	ent.Schema
}

InvoiceSequence holds the schema definition for the InvoiceSequence entity.

func (InvoiceSequence) Edges 

func (InvoiceSequence) Edges() []ent.Edge

Edges of the InvoiceSequence.

func (InvoiceSequence) Fields 

func (InvoiceSequence) Fields() []ent.Field

Fields of the InvoiceSequence.

func (InvoiceSequence) Indexes 

func (InvoiceSequence) Indexes() []ent.Index

Indexes of the InvoiceSequence.

type Meter 

type Meter struct {
	ent.Schema
}

Meter holds the schema definition for the Meter entity.

func (Meter) Edges 

func (Meter) Edges() []ent.Edge

Edges of the Meter.

func (Meter) Fields 

func (Meter) Fields() []ent.Field

Fields of the Meter.

func (Meter) Indexes 

func (Meter) Indexes() []ent.Index

Indexes of the Meter.

func (Meter) Mixin 

func (Meter) Mixin() []ent.Mixin

Mixin of the Meter.

type MeterAggregation 

type MeterAggregation struct {
	Type       types.AggregationType `json:"type"`
	Field      string                `json:"field,omitempty"`
	Multiplier decimal.Decimal       `json:"multiplier,omitempty"`
}

type MeterFilter 

type MeterFilter struct {
	Key    string   `json:"key"`
	Values []string `json:"values"`
}

Additional types needed for JSON fields

type Payment 

type Payment struct {
	ent.Schema
}

Payment holds the schema definition for the Payment entity.

func (Payment) Edges 

func (Payment) Edges() []ent.Edge

Edges of the Payment.

func (Payment) Fields 

func (Payment) Fields() []ent.Field

Fields of the Payment.

func (Payment) Indexes 

func (Payment) Indexes() []ent.Index

Indexes of the Payment.

func (Payment) Mixin 

func (Payment) Mixin() []ent.Mixin

Mixin of the Payment.

type PaymentAttempt 

type PaymentAttempt struct {
	ent.Schema
}

PaymentAttempt holds the schema definition for the PaymentAttempt entity.

func (PaymentAttempt) Edges 

func (PaymentAttempt) Edges() []ent.Edge

Edges of the PaymentAttempt.

func (PaymentAttempt) Fields 

func (PaymentAttempt) Fields() []ent.Field

Fields of the PaymentAttempt.

func (PaymentAttempt) Indexes 

func (PaymentAttempt) Indexes() []ent.Index

Indexes of the PaymentAttempt.

func (PaymentAttempt) Mixin 

func (PaymentAttempt) Mixin() []ent.Mixin

Mixin of the PaymentAttempt.

type Plan 

type Plan struct {
	ent.Schema
}

Plan holds the schema definition for the Plan entity.

func (Plan) Edges 

func (Plan) Edges() []ent.Edge

Edges of the Plan.

func (Plan) Fields 

func (Plan) Fields() []ent.Field

Fields of the Plan.

func (Plan) Indexes 

func (Plan) Indexes() []ent.Index

Indexes of the Plan.

func (Plan) Mixin 

func (Plan) Mixin() []ent.Mixin

Mixin of the Plan.

type Price 

type Price struct {
	ent.Schema
}

Price holds the schema definition for the Price entity.

func (Price) Edges 

func (Price) Edges() []ent.Edge

Edges of the Price.

func (Price) Fields 

func (Price) Fields() []ent.Field

Fields of the Price.

func (Price) Indexes 

func (Price) Indexes() []ent.Index

Indexes of the Price.

func (Price) Mixin 

func (Price) Mixin() []ent.Mixin

Mixin of the Price.

type PriceTier 

type PriceTier struct {
	UpTo       *uint64          `json:"up_to"`
	UnitAmount decimal.Decimal  `json:"unit_amount"`
	FlatAmount *decimal.Decimal `json:"flat_amount,omitempty"`
}

Additional types needed for JSON fields

type Secret 

type Secret struct {
	ent.Schema
}

Secret holds the schema definition for the Secret entity.

func (Secret) Edges 

func (Secret) Edges() []ent.Edge

Edges of the Secret.

func (Secret) Fields 

func (Secret) Fields() []ent.Field

Fields of the Secret.

func (Secret) Indexes 

func (Secret) Indexes() []ent.Index

Indexes of the Secret.

func (Secret) Mixin 

func (Secret) Mixin() []ent.Mixin

Mixin of the Secret.

type Subscription 

type Subscription struct {
	ent.Schema
}

Subscription holds the schema definition for the Subscription entity.

func (Subscription) Edges 

func (Subscription) Edges() []ent.Edge

Edges of the Subscription.

func (Subscription) Fields 

func (Subscription) Fields() []ent.Field

Fields of the Subscription.

func (Subscription) Indexes 

func (Subscription) Indexes() []ent.Index

Indexes of the Subscription.

func (Subscription) Mixin 

func (Subscription) Mixin() []ent.Mixin

Mixin of the Subscription.

type SubscriptionLineItem 

type SubscriptionLineItem struct {
	ent.Schema
}

SubscriptionLineItem holds the schema definition for the SubscriptionLineItem entity.

func (SubscriptionLineItem) Edges 

func (SubscriptionLineItem) Edges() []ent.Edge

Edges of the SubscriptionLineItem.

func (SubscriptionLineItem) Fields 

func (SubscriptionLineItem) Fields() []ent.Field

Fields of the SubscriptionLineItem.

func (SubscriptionLineItem) Indexes 

func (SubscriptionLineItem) Indexes() []ent.Index

Indexes of the SubscriptionLineItem.

func (SubscriptionLineItem) Mixin 

func (SubscriptionLineItem) Mixin() []ent.Mixin

Mixin of the SubscriptionLineItem.

type SubscriptionPause 

type SubscriptionPause struct {
	ent.Schema
}

SubscriptionPause holds the schema definition for the SubscriptionPause entity.

func (SubscriptionPause) Edges 

func (SubscriptionPause) Edges() []ent.Edge

Edges of the SubscriptionPause.

func (SubscriptionPause) Fields 

func (SubscriptionPause) Fields() []ent.Field

Fields of the SubscriptionPause.

func (SubscriptionPause) Indexes 

func (SubscriptionPause) Indexes() []ent.Index

Indexes of the SubscriptionPause.

func (SubscriptionPause) Mixin 

func (SubscriptionPause) Mixin() []ent.Mixin

Mixin of the SubscriptionPause.

type SubscriptionSchedule added in v1.0.18 

type SubscriptionSchedule struct {
	ent.Schema
}

SubscriptionSchedule holds the schema definition for the SubscriptionSchedule entity.

func (SubscriptionSchedule) Edges added in v1.0.18 

func (SubscriptionSchedule) Edges() []ent.Edge

Edges of the SubscriptionSchedule.

func (SubscriptionSchedule) Fields added in v1.0.18 

func (SubscriptionSchedule) Fields() []ent.Field

Fields of the SubscriptionSchedule.

func (SubscriptionSchedule) Indexes added in v1.0.18 

func (SubscriptionSchedule) Indexes() []ent.Index

Indexes of the SubscriptionSchedule.

func (SubscriptionSchedule) Mixin added in v1.0.18 

func (SubscriptionSchedule) Mixin() []ent.Mixin

Mixin of the SubscriptionSchedule.

type SubscriptionSchedulePhase added in v1.0.18 

type SubscriptionSchedulePhase struct {
	ent.Schema
}

SubscriptionSchedulePhase holds the schema definition for the SubscriptionSchedulePhase entity.

func (SubscriptionSchedulePhase) Edges added in v1.0.18 

func (SubscriptionSchedulePhase) Edges() []ent.Edge

Edges of the SubscriptionSchedulePhase.

func (SubscriptionSchedulePhase) Fields added in v1.0.18 

func (SubscriptionSchedulePhase) Fields() []ent.Field

Fields of the SubscriptionSchedulePhase.

func (SubscriptionSchedulePhase) Indexes added in v1.0.18 

func (SubscriptionSchedulePhase) Indexes() []ent.Index

Indexes of the SubscriptionSchedulePhase.

func (SubscriptionSchedulePhase) Mixin added in v1.0.18 

func (SubscriptionSchedulePhase) Mixin() []ent.Mixin

Mixin of the SubscriptionSchedulePhase.

type Task 

type Task struct {
	ent.Schema
}

Task holds the schema definition for the Task entity.

func (Task) Edges 

func (Task) Edges() []ent.Edge

Edges of the Task.

func (Task) Fields 

func (Task) Fields() []ent.Field

Fields of the Task.

func (Task) Indexes 

func (Task) Indexes() []ent.Index

Indexes of the Task.

func (Task) Mixin 

func (Task) Mixin() []ent.Mixin

Mixin of the Task.

type Tenant 

type Tenant struct {
	ent.Schema
}

Tenant holds the schema definition for the Tenant entity.

func (Tenant) Fields 

func (Tenant) Fields() []ent.Field

func (Tenant) Indexes 

func (Tenant) Indexes() []ent.Index

Indexes of the Tenant.

type TenantAddress added in v1.0.0 

type TenantAddress struct {
	Line1      string `json:"address_line1,omitempty"`
	Line2      string `json:"address_line2,omitempty"`
	City       string `json:"address_city,omitempty"`
	State      string `json:"address_state,omitempty"`
	PostalCode string `json:"address_postal_code,omitempty"`
	Country    string `json:"address_country,omitempty"`
}

TenantAddress represents a physical address in the tenant billing details

type TenantBillingDetails added in v1.0.0 

type TenantBillingDetails struct {
	Email     string        `json:"email,omitempty"`
	HelpEmail string        `json:"help_email,omitempty"`
	Phone     string        `json:"phone,omitempty"`
	Address   TenantAddress `json:"address,omitempty"`
}

TenantBillingDetails structure for the billing details

type TransformQuantity 

type TransformQuantity struct {
	DivideBy int    `json:"divide_by,omitempty"`
	Round    string `json:"round,omitempty"`
}

type User 

type User struct {
	ent.Schema
}

User holds the schema definition for the User entity.

func (User) Fields 

func (User) Fields() []ent.Field

func (User) Indexes 

func (User) Indexes() []ent.Index

Indexes of the User.

func (User) Mixin 

func (User) Mixin() []ent.Mixin

Mixin of the User.

type Wallet 

type Wallet struct {
	ent.Schema
}

Wallet holds the schema definition for the Wallet entity.

func (Wallet) Edges 

func (Wallet) Edges() []ent.Edge

Edges of the Wallet.

func (Wallet) Fields 

func (Wallet) Fields() []ent.Field

Fields of the Wallet.

func (Wallet) Indexes 

func (Wallet) Indexes() []ent.Index

Indexes of the Wallet.

func (Wallet) Mixin 

func (Wallet) Mixin() []ent.Mixin

Mixin of the Wallet.

type WalletTransaction 

type WalletTransaction struct {
	ent.Schema
}

WalletTransaction holds the schema definition for the WalletTransaction entity.

func (WalletTransaction) Edges 

func (WalletTransaction) Edges() []ent.Edge

Edges of the WalletTransaction.

func (WalletTransaction) Fields 

func (WalletTransaction) Fields() []ent.Field

Fields of the WalletTransaction.

func (WalletTransaction) Indexes 

func (WalletTransaction) Indexes() []ent.Index

Indexes of the WalletTransaction.

func (WalletTransaction) Mixin 

func (WalletTransaction) Mixin() []ent.Mixin

Mixin of the WalletTransaction.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.