Documentation
¶
Index ¶
- Constants
- Variables
- type Addon
- type AddonAssociation
- type AlertLogs
- type Auth
- type BillingSequence
- type Connection
- type Costsheet
- type Coupon
- type CouponApplication
- type CouponAssociation
- type CreditGrant
- type CreditGrantApplication
- type CreditNote
- type CreditNoteLineItem
- type Customer
- type Entitlement
- type EntityIntegrationMapping
- type Environment
- type Feature
- type Group
- type Invoice
- type InvoiceLineItem
- type InvoiceSequence
- type Meter
- type MeterAggregation
- type MeterFilter
- type Payment
- type PaymentAttempt
- type Plan
- type Price
- type PriceUnit
- type ScheduledTask
- type Secret
- type Settings
- type Subscription
- type SubscriptionLineItem
- type SubscriptionPause
- type SubscriptionSchedule
- type SubscriptionSchedulePhase
- type Task
- type TaxApplied
- type TaxAssociation
- type TaxRate
- type Tenant
- type TenantAddress
- type TenantBillingDetails
- type User
- type Wallet
- type WalletTransaction
Constants ¶
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" )
const ( Idx_entity_tax_rate_id = "idx_entity_tax_rate_id" Idx_entity_tax_association_lookup = "idx_entity_tax_association_lookup" )
const ( Idx_entity_type_entity_id_tenant_id_environment_id = "idx_entity_type_entity_id_tenant_id_environment_id" Idx_tax_rate_id_tenant_id_environment_id = "idx_tax_rate_id_tenant_id_environment_id" Idx_entity_lookup_active = "idx_entity_lookup_active" Unique_entity_tax_mapping = "unique_entity_tax_mapping" Idx_auto_apply_lookup = "idx_auto_apply_lookup" )
const (
AddonTenantIDEnvironmentIDLookupKeyConstraint = "addon_tenant_id_environment_id_lookup_key"
)
const (
Idx_code_tenant_id_environment_id = "idx_code_tenant_id_environment_id"
)
Variables ¶
var Idx_costsheet_tenant_environment_lookup_key = "idx_costsheet_tenant_environment_lookup_key"
var Idx_entity_integration_mapping_unique = "idx_entity_integration_mapping_unique"
var Idx_group_tenant_environment_lookup_key = "idx_group_tenant_environment_lookup_key"
var Idx_tenant_environment_external_id_unique = "idx_tenant_environment_external_id_unique"
var Idx_tenant_environment_idempotency_key_unique = "idx_tenant_environment_idempotency_key_unique"
var Idx_tenant_environment_invoice_number_unique = "idx_tenant_environment_invoice_number_unique"
var Idx_tenant_environment_lookup_key = "idx_tenant_environment_lookup_key"
Functions ¶
This section is empty.
Types ¶
type AddonAssociation ¶ added in v1.0.21
AddonAssociation holds the schema definition for the AddonAssociation entity.
func (AddonAssociation) Edges ¶ added in v1.0.21
func (AddonAssociation) Edges() []ent.Edge
Edges of the AddonAssociation.
func (AddonAssociation) Fields ¶ added in v1.0.21
func (AddonAssociation) Fields() []ent.Field
Fields of the AddonAssociation.
func (AddonAssociation) Indexes ¶ added in v1.0.21
func (AddonAssociation) Indexes() []ent.Index
Indexes of the AddonAssociation.
func (AddonAssociation) Mixin ¶ added in v1.0.21
func (AddonAssociation) Mixin() []ent.Mixin
Mixin of the AddonAssociation.
type AlertLogs ¶ added in v1.0.29
type BillingSequence ¶
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 Connection ¶ added in v1.0.21
Connection holds the schema definition for the Connection entity.
func (Connection) Fields ¶ added in v1.0.21
func (Connection) Fields() []ent.Field
Fields of the Connection.
func (Connection) Indexes ¶ added in v1.0.21
func (Connection) Indexes() []ent.Index
Indexes of the Connection.
func (Connection) Mixin ¶ added in v1.0.21
func (Connection) Mixin() []ent.Mixin
Mixin of the Connection.
type Costsheet ¶ added in v1.0.18
Costsheet represents the costsheet entity for tracking cost-related configurations. This entity includes basic columns as specified in the requirements: - id, name, tenant_id, environment_id, status, created_at, created_by, updated_at, updated_by This is used for comparing revenue and costsheet calculations.
func (Costsheet) Indexes ¶ added in v1.0.18
Indexes improves query performance and ensures data integrity. We index: 1. tenant_id + environment_id: For fast multi-tenant, multi-environment queries 2. tenant_id + environment_id + lookup_key: For unique lookup key queries
func (Costsheet) Mixin ¶ added in v1.0.18
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 CouponApplication ¶ added in v1.0.21
CouponApplication holds the schema definition for the CouponApplication entity.
func (CouponApplication) Edges ¶ added in v1.0.21
func (CouponApplication) Edges() []ent.Edge
Edges of the CouponApplication.
func (CouponApplication) Fields ¶ added in v1.0.21
func (CouponApplication) Fields() []ent.Field
Fields of the CouponApplication.
func (CouponApplication) Indexes ¶ added in v1.0.21
func (CouponApplication) Indexes() []ent.Index
Indexes of the CouponApplication.
func (CouponApplication) Mixin ¶ added in v1.0.21
func (CouponApplication) Mixin() []ent.Mixin
Mixin of the CouponApplication.
type CouponAssociation ¶ added in v1.0.21
CouponAssociation holds the schema definition for the CouponAssociation entity.
func (CouponAssociation) Edges ¶ added in v1.0.21
func (CouponAssociation) Edges() []ent.Edge
Edges of the CouponAssociation.
func (CouponAssociation) Fields ¶ added in v1.0.21
func (CouponAssociation) Fields() []ent.Field
Fields of the CouponAssociation.
func (CouponAssociation) Indexes ¶ added in v1.0.21
func (CouponAssociation) Indexes() []ent.Index
Indexes of the CouponAssociation.
func (CouponAssociation) Mixin ¶ added in v1.0.21
func (CouponAssociation) Mixin() []ent.Mixin
Mixin of the CouponAssociation.
type CreditGrant ¶ added in v1.0.18
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
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
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
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 Entitlement ¶
Entitlement holds the schema definition for the Entitlement entity.
type EntityIntegrationMapping ¶ added in v1.0.21
EntityIntegrationMapping holds the schema definition for the EntityIntegrationMapping entity.
func (EntityIntegrationMapping) Edges ¶ added in v1.0.21
func (EntityIntegrationMapping) Edges() []ent.Edge
Edges of the EntityIntegrationMapping.
func (EntityIntegrationMapping) Fields ¶ added in v1.0.21
func (EntityIntegrationMapping) Fields() []ent.Field
Fields of the EntityIntegrationMapping.
func (EntityIntegrationMapping) Indexes ¶ added in v1.0.21
func (EntityIntegrationMapping) Indexes() []ent.Index
Indexes of the EntityIntegrationMapping.
func (EntityIntegrationMapping) Mixin ¶ added in v1.0.21
func (EntityIntegrationMapping) Mixin() []ent.Mixin
Mixin of the EntityIntegrationMapping.
type Environment ¶
Environment holds the schema definition for the Environment entity.
func (Environment) Fields ¶
func (Environment) Fields() []ent.Field
type InvoiceLineItem ¶
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 ¶
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 MeterAggregation ¶
type MeterAggregation struct {
Type types.AggregationType `json:"type"`
Field string `json:"field,omitempty"`
Multiplier *decimal.Decimal `json:"multiplier,omitempty"`
BucketSize types.WindowSize `json:"bucket_size,omitempty"`
}
MeterAggregation defines the aggregation configuration for a meter
type MeterFilter ¶
Additional types needed for JSON fields
type PaymentAttempt ¶
PaymentAttempt holds the schema definition for the PaymentAttempt entity.
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 PriceUnit ¶ added in v1.0.21
PriceUnit holds the schema definition for the PriceUnit entity.
func (PriceUnit) Annotations ¶ added in v1.0.21
func (PriceUnit) Annotations() []schema.Annotation
Annotations of the PriceUnit.
type ScheduledTask ¶ added in v1.0.32
ScheduledTask holds the schema definition for the ScheduledTask entity. This entity manages scheduled export tasks for various entity types to external destinations (S3, etc.)
func (ScheduledTask) Fields ¶ added in v1.0.32
func (ScheduledTask) Fields() []ent.Field
Fields of the ScheduledTask.
func (ScheduledTask) Indexes ¶ added in v1.0.32
func (ScheduledTask) Indexes() []ent.Index
Indexes of the ScheduledTask.
func (ScheduledTask) Mixin ¶ added in v1.0.32
func (ScheduledTask) Mixin() []ent.Mixin
Mixin of the ScheduledTask.
type Settings ¶ added in v1.0.22
Settings holds the schema definition for the Settings entity.
type Subscription ¶
Subscription holds the schema definition for the Subscription entity.
func (Subscription) Indexes ¶
func (Subscription) Indexes() []ent.Index
Indexes of the Subscription.
type SubscriptionLineItem ¶
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 ¶
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
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
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 TaxApplied ¶ added in v1.0.21
TaxApplied holds the schema definition for the TaxApplied entity.
func (TaxApplied) Edges ¶ added in v1.0.21
func (TaxApplied) Edges() []ent.Edge
Edges of the TaxApplied.
func (TaxApplied) Fields ¶ added in v1.0.21
func (TaxApplied) Fields() []ent.Field
Fields of the TaxApplied.
func (TaxApplied) Indexes ¶ added in v1.0.21
func (TaxApplied) Indexes() []ent.Index
Indexes of the TaxApplied.
func (TaxApplied) Mixin ¶ added in v1.0.21
func (TaxApplied) Mixin() []ent.Mixin
Mixin of the TaxApplied.
type TaxAssociation ¶ added in v1.0.21
TaxAssociation holds the schema definition for the TaxAssociation entity.
func (TaxAssociation) Edges ¶ added in v1.0.21
func (TaxAssociation) Edges() []ent.Edge
Edges of the TaxAssociation.
func (TaxAssociation) Fields ¶ added in v1.0.21
func (TaxAssociation) Fields() []ent.Field
Fields of the TaxAssociation.
func (TaxAssociation) Indexes ¶ added in v1.0.21
func (TaxAssociation) Indexes() []ent.Index
Indexes of the TaxAssociation.
func (TaxAssociation) Mixin ¶ added in v1.0.21
func (TaxAssociation) Mixin() []ent.Mixin
Mixin of the TaxAssociation.
type TaxRate ¶ added in v1.0.21
TaxRate holds the schema definition for the TaxRate entity.
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 WalletTransaction ¶
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
¶
- addon.go
- addonassociation.go
- alertlogs.go
- auth.go
- billingsequence.go
- connection.go
- costsheet.go
- coupon.go
- coupon_application.go
- coupon_association.go
- creditgrant.go
- creditgrantapplication.go
- creditnote.go
- creditnote_line_item.go
- customer.go
- entitlement.go
- entityintegrationmapping.go
- environment.go
- feature.go
- group.go
- invoice.go
- invoice_line_item.go
- invoicesequence.go
- meter.go
- payment.go
- payment_attempt.go
- plan.go
- price.go
- priceunit.go
- scheduledtask.go
- secret.go
- settings.go
- subscription.go
- subscription_line_item.go
- subscription_pause.go
- subscriptionschedule.go
- subscriptionschedulephase.go
- task.go
- taxapplied.go
- taxassociation.go
- taxrate.go
- tenant.go
- user.go
- wallet.go
- wallettransaction.go