credits

package
v1.0.6 Latest Latest
Warning

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

Go to latest
Published: Mar 21, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AutoReplenishConfig

type AutoReplenishConfig struct {
	Enabled   bool             `json:"enabled"`
	Threshold mo.Option[int64] `json:"threshold,omitzero"`
	Amount    mo.Option[int64] `json:"amount,omitzero"`
}

type CreditExpiration

type CreditExpiration struct {
	Balance        int64                `json:"balance"`
	CreationDate   mo.Option[time.Time] `json:"creation_date,omitzero"`
	ExpirationDate mo.Option[time.Time] `json:"expiration_date,omitzero"`
}

type OrganizationCreditDetails

type OrganizationCreditDetails struct {
	Balance             int64               `json:"balance"`
	CreditExpirations   []CreditExpiration  `json:"credit_expirations"`
	AutoReplenishConfig AutoReplenishConfig `json:"auto_replenish_config"`
}

type OrganizationCreditDetailsResult

type OrganizationCreditDetailsResult struct {
	Meta *responsemeta.ResponseMeta
	Data OrganizationCreditDetails
}

type Service

type Service interface {
	// GetOrganizationCreditDetails retrieves the credit details for an organization.
	GetOrganizationCreditDetails(
		ctx context.Context,
		orgID identifiers.OrganizationID,
	) (OrganizationCreditDetailsResult, cenclierrors.CencliError)
	// GetUserCreditDetails retrieves the credit details for the current user.
	GetUserCreditDetails(
		ctx context.Context,
	) (UserCreditDetailsResult, cenclierrors.CencliError)
}

Service provides credit details capabilities.

func New

func New(client client.Client) Service

type UserCreditDetails

type UserCreditDetails struct {
	Balance  int64                `json:"balance"`
	ResetsAt mo.Option[time.Time] `json:"resets_at,omitzero"`
}

type UserCreditDetailsResult

type UserCreditDetailsResult struct {
	Meta *responsemeta.ResponseMeta
	Data UserCreditDetails
}

Jump to

Keyboard shortcuts

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