truetrial

package module

Go to main page

Versions in this module

v1

v1.0.1

May 20, 2026

Changes in this version

+ type ConfirmManuallyParams struct

+ ConfirmedByEmail string

+ DeliveredAt string

+ Reason string

type OrderStatus

+ const OrderStatusDeliveryFailed

type ShipmentsService

+ func (s *ShipmentsService) ConfirmManually(ctx context.Context, orderID string, params ConfirmManuallyParams) (*Order, error)

type WebhookEvent

+ const WebhookEventDeliveryFailed

v1.0.0

May 7, 2026

Changes in this version

+ const DefaultBaseURL

+ const DefaultTimeout

+ const DefaultWebhookTolerance

+ const Version

+ const WebhookEventHeader

+ const WebhookSignatureHeader

+ const WebhookTimestampHeader

+ func IsAuthenticationError(err error) bool

+ func IsNotFoundError(err error) bool

+ func IsRateLimitError(err error) bool

+ func IsServerError(err error) bool

+ func IsValidationError(err error) bool

+ func VerifyWebhookSignature(payload []byte, signature string, secret string) bool

+ func VerifyWebhookSignatureWithTolerance(payload []byte, signature string, secret string, tolerance time.Duration) bool

+ type AdjustTemporalParams struct

+ NewEndTime string

+ Reason string

+ type Cancellation struct

+ CancelledAt string

+ ID string

+ OrderID string

+ Reason string

+ Status string

+ type CancellationsService struct

+ func (s *CancellationsService) Create(ctx context.Context, orderID string, params CreateCancellationParams) (*Cancellation, error)

+ func (s *CancellationsService) Get(ctx context.Context, orderID string) (*Cancellation, error)

+ type Carrier string

+ const CarrierAfterShip

+ const CarrierDHL

+ const CarrierFedEx

+ const CarrierShippo

+ const CarrierUPS

+ const CarrierUSPS

+ type CarrierHealthEntry struct

+ Carrier Carrier

+ CheckedAt string

+ Latency int

+ Status string

+ type ClaimParams struct

+ Description string

+ Reason string

+ type Client struct

+ Cancellations *CancellationsService

+ DigitalDelivery *DigitalDeliveryService

+ Orders *OrdersService

+ Shipments *ShipmentsService

+ System *SystemService

+ Temporal *TemporalService

+ Webhooks *WebhooksService

+ func NewClient(apiKey string, opts ...Option) *Client

+ type ConfirmDigitalDeliveryParams struct

+ DeliveredAt string

+ DeliverySource DeliverySource

+ type Consumer struct

+ Email string

+ FirstName string

+ ID string

+ LastName string

+ Phone string

+ type ConsumerParams struct

+ Email string

+ FirstName string

+ LastName string

+ Phone string

+ type CreateCancellationParams struct

+ Reason string

+ type CreateOrderParams struct

+ Consumer ConsumerParams

+ Currency string

+ DurationUnit DurationUnit

+ DurationValue int

+ ExternalOrderID string

+ Metadata any

+ PriceCents int

+ ProductName string

+ ProductType ProductType

+ TemporalType TemporalType

+ type CreateShipmentParams struct

+ Carrier Carrier

+ EstimatedDelivery string

+ TrackingNumber string

+ type CreateWebhookParams struct

+ Events []WebhookEvent

+ URL string

+ type DeliverySource string

+ const DeliverySourceFallbackCarrier

+ const DeliverySourceManual

+ const DeliverySourcePoll

+ const DeliverySourceWebhook

+ type DigitalDeliveryService struct

+ func (s *DigitalDeliveryService) Confirm(ctx context.Context, orderID string, params ConfirmDigitalDeliveryParams) (*Order, error)

+ type DurationUnit string

+ const DurationUnitDays

+ const DurationUnitMonths

+ const DurationUnitWeeks

+ const DurationUnitYears

+ type ExtendTemporalParams struct

+ DurationUnit DurationUnit

+ DurationValue int

+ Reason string

+ type ListOrdersParams struct

+ Page int

+ Status OrderStatus

+ type Option func(*Client)

+ func WithBaseURL(url string) Option

+ func WithHTTPClient(hc *http.Client) Option

+ type Order struct

+ Consumer *Consumer

+ ConsumerID string

+ CreatedAt string

+ ExternalOrderID string

+ ID string

+ Metadata any

+ ProductCurrency string

+ ProductName string

+ ProductPriceCents int

+ ProductType ProductType

+ Status OrderStatus

+ TenantID string

+ type OrderStatus string

+ const OrderStatusCancelled

+ const OrderStatusConverted

+ const OrderStatusDelivered

+ const OrderStatusExpired

+ const OrderStatusInTransit

+ const OrderStatusReceived

+ const OrderStatusReturned

+ const OrderStatusShipped

+ const OrderStatusTrialActive

+ type OrderStatusResponse struct

+ ExternalOrderID string

+ OrderID string

+ OrderStatus OrderStatus

+ ShipmentStatus ShipmentStatus

+ TemporalElementStatus TemporalStatus

+ type OrdersService struct

+ func (s *OrdersService) Create(ctx context.Context, params CreateOrderParams) (*Order, error)

+ func (s *OrdersService) Get(ctx context.Context, id string) (*Order, error)

+ func (s *OrdersService) List(ctx context.Context, params *ListOrdersParams) (*PaginatedResponse, error)

+ func (s *OrdersService) Status(ctx context.Context, id string) (*OrderStatusResponse, error)

+ type PaginatedResponse struct

+ CurrentPage int

+ Data json.RawMessage

+ LastPage int

+ PerPage int

+ Total int

+ type ProductType string

+ const ProductTypeDigital

+ const ProductTypePhysical

+ type ResolveClaimParams struct

+ Notes string

+ Resolution string

+ type Shipment struct

+ Carrier Carrier

+ DeliveredAt string

+ EstimatedDelivery string

+ ID string

+ OrderID string

+ Status ShipmentStatus

+ TrackingNumber string

+ type ShipmentStatus string

+ const ShipmentStatusDelivered

+ const ShipmentStatusFailed

+ const ShipmentStatusInTransit

+ const ShipmentStatusOutForDelivery

+ const ShipmentStatusPending

+ const ShipmentStatusReturnedToSender

+ type ShipmentsService struct

+ func (s *ShipmentsService) Create(ctx context.Context, orderID string, params CreateShipmentParams) (*Shipment, error)

+ func (s *ShipmentsService) List(ctx context.Context, orderID string) ([]Shipment, error)

+ type SystemService struct

+ func (s *SystemService) CarrierHealth(ctx context.Context) ([]CarrierHealthEntry, error)

+ type TemporalElement struct

+ BeginTime string

+ DurationUnit DurationUnit

+ DurationValue int

+ EndTime string

+ ExpiresAt string

+ ID string

+ OrderID string

+ Status TemporalStatus

+ Type TemporalType

+ type TemporalService struct

+ func (s *TemporalService) Adjust(ctx context.Context, orderID string, params AdjustTemporalParams) (*TemporalElement, error)

+ func (s *TemporalService) Claim(ctx context.Context, orderID string, params ClaimParams) (*TemporalElement, error)

+ func (s *TemporalService) Extend(ctx context.Context, orderID string, params ExtendTemporalParams) (*TemporalElement, error)

+ func (s *TemporalService) Get(ctx context.Context, orderID string) (*TemporalElement, error)

+ func (s *TemporalService) ResolveClaim(ctx context.Context, orderID string, params ResolveClaimParams) (*TemporalElement, error)

+ type TemporalStatus string

+ const TemporalStatusActive

+ const TemporalStatusCancelled

+ const TemporalStatusClaimApproved

+ const TemporalStatusClaimDenied

+ const TemporalStatusClaimed

+ const TemporalStatusConverted

+ const TemporalStatusExpired

+ const TemporalStatusExpiring

+ const TemporalStatusPending

+ const TemporalStatusRenewed

+ const TemporalStatusSuspended

+ type TemporalType string

+ const TemporalTypeEvaluation

+ const TemporalTypeGuarantee

+ const TemporalTypeSubscription

+ const TemporalTypeTrial

+ const TemporalTypeWarranty

+ type TrueTrialError struct

+ Errors map[string][]string

+ Message string

+ ResponseBody []byte

+ RetryAfter int

+ StatusCode int

+ func NewAuthenticationError(message string, body []byte) *TrueTrialError

+ func NewNotFoundError(message string, body []byte) *TrueTrialError

+ func NewRateLimitError(message string, retryAfter int, body []byte) *TrueTrialError

+ func NewServerError(statusCode int, message string, body []byte) *TrueTrialError

+ func NewValidationError(message string, errors map[string][]string, body []byte) *TrueTrialError

+ func (e *TrueTrialError) Error() string

+ type WebhookEvent string

+ const WebhookEventCancellationInitiated

+ const WebhookEventDisputeCreated

+ const WebhookEventDisputeLost

+ const WebhookEventDisputeWon

+ const WebhookEventOrderCreated

+ const WebhookEventOrderDelivered

+ const WebhookEventPaymentFailed

+ const WebhookEventPaymentSucceeded

+ const WebhookEventRiskScoreChanged

+ const WebhookEventSubscriptionRenewed

+ const WebhookEventTemporalAdjusted

+ const WebhookEventTemporalExtended

+ const WebhookEventTrialConverted

+ const WebhookEventTrialExpired

+ const WebhookEventTrialExpiring

+ const WebhookEventTrialStarted

+ const WebhookEventWarrantyClaimResolved

+ const WebhookEventWarrantyClaimed

+ type WebhookSubscription struct

+ Events []WebhookEvent

+ ID string

+ LastTriggeredAt string

+ Secret string

+ URL string

+ type WebhooksService struct

+ func (s *WebhooksService) Create(ctx context.Context, params CreateWebhookParams) (*WebhookSubscription, error)

+ func (s *WebhooksService) Delete(ctx context.Context, id string) error

+ func (s *WebhooksService) List(ctx context.Context) ([]WebhookSubscription, error)

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