insurance

type Client struct {
	// contains filtered or unexported fields
}

type Comparison struct {
	OrgID string
	// PlanID is an Archera plan identifier, not a local recommendation ID.
	PlanID string
	// Current is the plan-wide rollup for the line items currently in scope.
	Current Totals
	// Hypotheticals holds one rollup per requested (or candidate-derived)
	// (contract term, payment option) combination.
	Hypotheticals []Hypothetical
	// Rows holds per-line current and candidate offers, in vendor order
	// (by line item ID).
	Rows []ComparisonRow
	// Currency is always nil with the current API schemas: no currency field
	// is documented. Consumers must render it as unknown.
	Currency *string
	// FetchedAt records when the response was retrieved; there is no
	// documented TTL, so staleness policy belongs to the consumer.
	FetchedAt time.Time
}

type ComparisonRequest struct {
	PlanID         string
	LineItemIDs    []string
	ContractTerms  []string
	PaymentOptions []PaymentOption
}

type ComparisonRow struct {
	LineItemID string
	Current    OfferEntry
	Candidates []OfferEntry
}

type Config struct {
	APIKey Secret
	OrgID  string
}

type Financials struct {
	// CommitmentCostTotal is the headline monthly cost paid:
	// CloudProviderCost + Premium, with the premium already included.
	CommitmentCostTotal *big.Rat
	// CloudProviderCost is the amortized monthly cost paid to the cloud
	// provider.
	CloudProviderCost *big.Rat
	// Premium is archera_premium. Already included in CommitmentCostTotal;
	// never add it on top or subtract it again.
	Premium *big.Rat
	// GrossSavings is savings before the premium.
	GrossSavings *big.Rat
	// NetSavings is savings after the premium. It can be negative.
	NetSavings *big.Rat
	// CoveredOnDemandCost is the on-demand cost of usage covered by
	// commitments: the savings baseline, not a cost the user pays.
	CoveredOnDemandCost *big.Rat
}

type HTTPError struct {
	StatusCode int
	// RetryAfter is the parsed Retry-After header, zero when absent or not a
	// number of seconds. The client never retries on its own.
	RetryAfter time.Duration
	Message    string
}

type Hypothetical struct {
	// ContractTerm is nullable in the schema.
	ContractTerm  *string
	PaymentOption PaymentOption
	Totals        Totals
	// Deltas compare this hypothetical against the CURRENT plan, not against
	// on-demand. Positive DeltaMonthlyNetSavings means switching saves more
	// than the plan does today.
	DeltaMonthlyNetSavings     *big.Rat
	DeltaMonthlyCommitmentCost *big.Rat
	// DeltaUpfrontCost is one-time dollars, NOT a rate.
	DeltaUpfrontCost *big.Rat
	LineItems        []HypotheticalLineItem
}

type HypotheticalLineItem struct {
	LineItemID           string
	ActualTerm           *string
	ActualPaymentOption  *PaymentOption
	ActualCommitmentType *string
	Reason               TermReason
}

type LineItem struct {
	ID, PlanID, OfferID string
	AccountID           *string
	SelectedQuantity    int64
	SelectedCommitment  *big.Rat
	IsSelected          bool
	ContractTerm        string
	PaymentOption       PaymentOption
	ContractSpec        LineItemContractSpec
	Offer               LineItemOffer
}

type LineItemContractSpec struct {
	CommitmentType string         `json:"commitment_type"`
	Term           *string        `json:"term"`
	PaymentOption  *PaymentOption `json:"payment_option"`
}

type LineItemOffer struct {
	ID                 string
	ProviderOfferingID string
	Type               string
	Provider           common.ProviderType
	OfferingID         *string
	Region             *string
	AZ                 *string
	InstanceType       *string
	InstanceFamily     *string
	ProductDescription *string
	Tenancy            *string
	PlanType           *string
	IsMultiAZ          *bool
	IsFlexible         *bool
	DurationSeconds    *big.Rat
	OfferingClass      *string
	PaymentOption      *PaymentOption
}

type OfferDelta struct {
	MonthlyNetSavings *big.Rat
	// UpfrontCost is one-time dollars, NOT a rate.
	UpfrontCost  *big.Rat
	DiscountRate *big.Rat
	// BreakevenDays is nil when either side has no finite breakeven.
	BreakevenDays *big.Rat
}

type OfferEntry struct {
	// IsCurrent is true when this entry matches the line item's current
	// offer and lease.
	IsCurrent bool
	OfferID   string
	// SelectedAmount is a count for RI/unit CUD, or $/hour for spend commitments.
	SelectedAmount *big.Rat
	// CommitmentType is the vendor's offer type string. The docs give both
	// "aws/AmazonEC2"-style and "ri"/"savings_plan"/"cud"-style examples;
	// treat it as opaque display text.
	CommitmentType string
	Provider       common.ProviderType
	// ContractTerm is the effective lock-in term (lease lock-in when a lease
	// is attached). Nullable in the schema.
	ContractTerm *string
	// PaymentOption is nullable in the schema.
	PaymentOption *PaymentOption
	// LeaseMenuItemID is the attached Archera lease, nil for none.
	LeaseMenuItemID *string
	// GuaranteedDisplayName is the offer name when purchased as an Archera
	// Guaranteed Commitment; nil when the vendor sends none.
	GuaranteedDisplayName *string
	// Region is nil when the offer does not report one.
	Region *string
	// DiscountRate is the discount versus on-demand on a 0-1 basis.
	DiscountRate *big.Rat
	// BreakevenDays is nil when breakeven is undefined.
	BreakevenDays *big.Rat
	// Monthly holds the 730-hour monthly rate financials.
	Monthly Financials
	// UpfrontCost is one-time dollars at signing, NOT a rate.
	UpfrontCost *big.Rat
	Delta       OfferDelta
}

type PaymentOption string

type Plan struct {
	ID     string
	Status PlanStatus
	// IsCalculating is true while Archera recomputes the plan; consumers
	// show a non-final state instead of treating the figures as current.
	IsCalculating bool
	// FeeHourly is the vendor's fee_hourly, unit basis undocumented.
	FeeHourly *big.Rat
	// SavingsHourly is the vendor's savings_hourly, unit basis undocumented.
	SavingsHourly *big.Rat
	// CommitmentCoverage is the vendor's commitment_coverage; its scale
	// (0-1 or percent) is undocumented. It is native commitment coverage,
	// never insured coverage.
	CommitmentCoverage *big.Rat
	// MonthlySavings is the vendor's monthly_savings, basis undocumented.
	MonthlySavings *big.Rat
}

type PlanStatus string

type ProductSupport struct {
	Status ProductSupportStatus
	// Source is the documentation URL a non-unknown verdict rests on.
	Source string
	// Evidence is the statement quoted from Source.
	Evidence string
}

type ProductSupportStatus string

type QuoteClient interface {
	Comparison(ctx context.Context, req ComparisonRequest) (*Comparison, error)
	Plan(ctx context.Context, planID string) (*Plan, error)
}

type Secret struct {
	// contains filtered or unexported fields
}

type TermReason string

type Totals struct {
	// Monthly holds the 730-hour monthly rate financials.
	Monthly Financials
	// UpfrontCost is one-time dollars due at signing (required by the
	// schema). It is NOT a rate and must never be summed with Monthly.
	UpfrontCost *big.Rat
}