constants

package
v1.3.1 Latest Latest
Warning

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

Go to latest
Published: Aug 26, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// GlobalCustomerRoleID is the fixed ID of the global Customer role.
	GlobalCustomerRoleID = "rl_7vafmsquekgt"
	// GlobalCustomerRoleName is the display name of the global Customer role.
	GlobalCustomerRoleName = "Customer"
)

The global "Customer" role assigned to customer-portal users.

It is a single global role (role.account_id IS NULL) of role_type "user", resolved by its fixed ID rather than by type (multiple roles share the "user" type). Its permissions define what a customer may do on the portal. Both the customer registration flow and cmd/backfill-customer-role reference these constants; the row itself is created in production by the backfill command and mirrored in shared/db/seed/0004_auth.sql for local/test.

View Source
const DefaultModelTier = ModelTierHigh

DefaultModelTier is used when a caller doesn't specify one (e.g. a normal agent run).

View Source
const PortalRegistrationSessionTTL = 7 * 24 * time.Hour

PortalRegistrationSessionTTL bounds how long an incomplete buyer registration session can be resumed before it reads as expired. Applied logically at read time (no cleanup job).

View Source
const StripeAPIVersion = "2026-03-04.preview"

Stripe API version used for outbound requests and webhooks. Keep in sync with stripe-go SDK. Used for Stripe-Version header on API calls and for stripe listen --stripe-version.

Variables

View Source
var ModelCatalog = []ModelSpec{

	{ModelClaudeOpus48, "Claude Opus 4.8", "Anthropic"},
	{ModelClaudeOpus47, "Claude Opus 4.7", "Anthropic"},
	{ModelClaudeOpus46, "Claude Opus 4.6", "Anthropic"},
	{ModelClaudeOpus45, "Claude Opus 4.5", "Anthropic"},
	{ModelClaudeSonnet46, "Claude Sonnet 4.6", "Anthropic"},
	{ModelClaudeSonnet45, "Claude Sonnet 4.5", "Anthropic"},
	{ModelClaudeSonnet4, "Claude Sonnet 4", "Anthropic"},
	{ModelClaudeHaiku45, "Claude Haiku 4.5", "Anthropic"},
	{ModelClaude37Sonnet, "Claude 3.7 Sonnet", "Anthropic"},
	{ModelClaude35Sonnet, "Claude 3.5 Sonnet", "Anthropic"},
	{ModelClaude35Haiku, "Claude 3.5 Haiku", "Anthropic"},

	{ModelGPT55, "GPT-5.5", "OpenAI"},
	{ModelGPT54, "GPT-5.4", "OpenAI"},
	{ModelGPT52, "GPT-5.2", "OpenAI"},
	{ModelGPT51, "GPT-5.1", "OpenAI"},
	{ModelGPT5, "GPT-5", "OpenAI"},
	{ModelGPT5Mini, "GPT-5 mini", "OpenAI"},
	{ModelGPT4o, "GPT-4o", "OpenAI"},
	{ModelGPT4oMini, "GPT-4o mini", "OpenAI"},
	{ModelGPT41Mini, "GPT-4.1 mini", "OpenAI"},
	{ModelGPT4, "GPT-4", "OpenAI"},
	{ModelGPT35Turbo, "GPT-3.5 Turbo", "OpenAI"},

	{ModelGemini3Flash, "Gemini 3 Flash", "Google"},
	{ModelGemini25Flash, "Gemini 2.5 Flash", "Google"},
	{ModelGemini25Pro, "Gemini 2.5 Pro", "Google"},

	{ModelGrok4, "Grok 4", "xAI"},
	{ModelGrok3, "Grok 3", "xAI"},
	{ModelGrok3Mini, "Grok 3 mini", "xAI"},
}

ModelCatalog is the full set of LLM models agents may use — the single source of truth for validation and the model enum. IDs mirror the models available in the Stripe AI Gateway dashboard.

View Source
var RegistrationLimitsByPlan = map[PlanCode]RegistrationLimits{
	PlanCodeFree:    {PublicLimit: 10, TotalLimit: 10},
	PlanCodeStarter: {PublicLimit: 20, TotalLimit: 20},
	PlanCodePro:     {PublicLimit: 20, TotalLimit: 20},
}

RegistrationLimitsByPlan maps each plan code to its registration caps. Every public plan shares the same defaults today; the map makes it easy to override per-plan later without changing the enforcement code.

Functions

func BillingPeriodStart

func BillingPeriodStart(subscriptionPeriodEnd *time.Time) time.Time

Resolves the start of the account's billing period — a month back from the subscription's period end, or the first of the calendar month. Shared so per-period caps and usage counts agree.

func EnumPtr added in v1.1.6

func EnumPtr[T ~string](v *string) *T

EnumPtr converts an optional plain string from a lower layer into the optional enum value the API surface exposes.

func IsShippoCarrier

func IsShippoCarrier(code *string) bool

IsShippoCarrier returns true if the given code corresponds to a carrier managed through the Shippo API (FedEx, UPS, USPS).

func Strings added in v1.1.6

func Strings[T ~string](values []T) []string

Strings converts a slice of enum values into plain strings, for handing a validated list filter down to a layer that takes strings.

func TrackingURL

func TrackingURL(code CarrierCode, trackingNumber string) string

TrackingURL returns a carrier tracking deep-link for the given tracking number, or "" when the carrier isn't one we can build a link for (or the tracking number is empty). Mirrors the carrier deep-links used by the frontend.

Types

type ABCClass

type ABCClass string

ABCClass ranks a SKU by how much of the constraint it consumes.

const (
	// ABCClassA indicates a SKU that consumes the largest share of constraint capacity.
	ABCClassA ABCClass = "a"
	// ABCClassB indicates a SKU with moderate constraint consumption.
	ABCClassB ABCClass = "b"
	// ABCClassC indicates a SKU that consumes little constraint capacity.
	ABCClassC ABCClass = "c"
)

func (ABCClass) EnumValues

func (c ABCClass) EnumValues() []string

func (ABCClass) IsValid

func (c ABCClass) IsValid() bool

func (*ABCClass) StringPtr

func (c *ABCClass) StringPtr() *string

type APIKeyStatus

type APIKeyStatus string

APIKeyStatus represents the status of an API key.

const (
	// APIKeyStatusActive indicates that the API key is active and can be used to authenticate requests.
	APIKeyStatusActive APIKeyStatus = "active"
	// APIKeyStatusExpired indicates that the API key has expired and can no longer be used to authenticate requests.
	APIKeyStatusExpired APIKeyStatus = "expired"
	// APIKeyStatusRevoked indicates that the API key has been revoked and can no longer be used to authenticate requests.
	APIKeyStatusRevoked APIKeyStatus = "revoked"
)

func (APIKeyStatus) EnumValues

func (s APIKeyStatus) EnumValues() []string

func (APIKeyStatus) IsValid

func (s APIKeyStatus) IsValid() bool

func (*APIKeyStatus) StringPtr

func (s *APIKeyStatus) StringPtr() *string

type AccountGroupType

type AccountGroupType string

AccountGroupType represents the type of an account group.

const (
	// AccountGroupTypePricingGroup indicates a pricing-based account group.
	AccountGroupTypePricingGroup AccountGroupType = "pricing_group"
	// AccountGroupTypeTypeGroup indicates a type-based account group.
	AccountGroupTypeTypeGroup AccountGroupType = "type_group"
)

func (AccountGroupType) EnumValues

func (m AccountGroupType) EnumValues() []string

func (AccountGroupType) IsValid

func (m AccountGroupType) IsValid() bool

func (*AccountGroupType) StringPtr

func (m *AccountGroupType) StringPtr() *string

type AccountIntegrationStatus

type AccountIntegrationStatus string

AccountIntegrationStatus represents the lifecycle status of an account integration.

const (
	// AccountIntegrationStatusActive indicates the integration is active and available for use.
	AccountIntegrationStatusActive AccountIntegrationStatus = "active"
	// AccountIntegrationStatusInactive indicates the integration is deactivated; its stored credentials are retained but it cannot be used.
	AccountIntegrationStatusInactive AccountIntegrationStatus = "inactive"
)

func AccountIntegrationStatusFromActive

func AccountIntegrationStatusFromActive(active bool) AccountIntegrationStatus

AccountIntegrationStatusFromActive maps the stored is_active boolean to its public status value.

func (AccountIntegrationStatus) EnumValues

func (m AccountIntegrationStatus) EnumValues() []string

func (AccountIntegrationStatus) IsValid

func (m AccountIntegrationStatus) IsValid() bool

func (*AccountIntegrationStatus) StringPtr

func (m *AccountIntegrationStatus) StringPtr() *string

type AccountMode

type AccountMode string

Account Mode is the intended mode of operation for a request. This must be either "production" or "sandbox". The mode of the request is a useful way to ensure that a given request stays within the defined boundaries of its intended mode.

const (
	// AccountModeProduction indicates that the request is targeting production resources and integrations. This mode has real-world consequences and should be used with care.
	AccountModeProduction AccountMode = "prod"
	// AccountModeSandbox indicates that the request is targeting sandbox resources and integrations. This mode is useful for testing and development and can be used more dangerously.
	AccountModeSandbox AccountMode = "test"
)

func (AccountMode) EnumValues

func (m AccountMode) EnumValues() []string

func (AccountMode) IsValid

func (m AccountMode) IsValid() bool

func (*AccountMode) StringPtr

func (m *AccountMode) StringPtr() *string

type AccountPlanLimitKey

type AccountPlanLimitKey string

Names a row in `account_plan_limit`, the per-plan caps an account is billed under. The value is the cap; a missing row or a NULL value means unlimited.

const (
	// Caps how many invoices an account may create per billing period.
	AccountPlanLimitInvoicesMaximum AccountPlanLimitKey = "invoices_maximum"
	// Caps how many batches an account may create per billing period.
	AccountPlanLimitBatchesMaximum AccountPlanLimitKey = "batches_maximum"
	// Caps how many users may hold a seat on the account.
	AccountPlanLimitSeatsMaximum AccountPlanLimitKey = "seats_maximum"
	// Caps how many sandboxes the account may hold at once.
	AccountPlanLimitSandboxesMaximum AccountPlanLimitKey = "sandboxes_maximum"
)

func (AccountPlanLimitKey) EnumValues

func (k AccountPlanLimitKey) EnumValues() []string

func (AccountPlanLimitKey) IsValid

func (k AccountPlanLimitKey) IsValid() bool

func (*AccountPlanLimitKey) StringPtr

func (k *AccountPlanLimitKey) StringPtr() *string

type AccountPriceOrigin

type AccountPriceOrigin string

AccountPriceOrigin says how a customer comes to receive a contracted price, which decides where it has to be changed.

const (
	// AccountPriceOriginDirect indicates that the price is recorded against this customer.
	AccountPriceOriginDirect AccountPriceOrigin = "direct"
	// AccountPriceOriginInherited indicates that the price is recorded against the customer's parent account and reaches this customer through it.
	AccountPriceOriginInherited AccountPriceOrigin = "inherited"
)

func (AccountPriceOrigin) EnumValues

func (m AccountPriceOrigin) EnumValues() []string

func (AccountPriceOrigin) IsValid

func (m AccountPriceOrigin) IsValid() bool

func (*AccountPriceOrigin) StringPtr

func (m *AccountPriceOrigin) StringPtr() *string

type AccountRelationNotificationType

type AccountRelationNotificationType string

AccountRelationNotificationType defines the types of notifications that can be configured on an account relation.

const (
	// AccountRelationNotificationTypeInvoice indicates invoice notifications.
	AccountRelationNotificationTypeInvoice AccountRelationNotificationType = "invoice"
	// AccountRelationNotificationTypeOrderAcknowledgement indicates order acknowledgement notifications.
	AccountRelationNotificationTypeOrderAcknowledgement AccountRelationNotificationType = "order_acknowledgement"
	// AccountRelationNotificationTypePurchaseOrderSubmission indicates purchase order submission notifications.
	AccountRelationNotificationTypePurchaseOrderSubmission AccountRelationNotificationType = "purchase_order_submission"
)

func (AccountRelationNotificationType) EnumValues

func (m AccountRelationNotificationType) EnumValues() []string

func (AccountRelationNotificationType) IsValid

func (*AccountRelationNotificationType) StringPtr

func (m *AccountRelationNotificationType) StringPtr() *string

type AccountRelationRole

type AccountRelationRole string

AccountRelationRole is the role an account_relation plays from the owner account's perspective. It is the discriminator stored in account_relation.account_relation_role_code and the key a contact role is configured against (the customer-support contact, the supplier contact, etc.).

const (
	// AccountRelationRoleCustomer marks a counterparty the owner sells to (portal customers).
	AccountRelationRoleCustomer AccountRelationRole = "customer"
	// AccountRelationRoleSupplier marks a counterparty the owner buys from.
	AccountRelationRoleSupplier AccountRelationRole = "supplier"
	// AccountRelationRolePartner marks a non-buy/sell counterparty relationship.
	AccountRelationRolePartner AccountRelationRole = "partner"
)

func (AccountRelationRole) EnumValues

func (r AccountRelationRole) EnumValues() []string

func (AccountRelationRole) IsValid

func (r AccountRelationRole) IsValid() bool

func (*AccountRelationRole) StringPtr

func (r *AccountRelationRole) StringPtr() *string

type AccountStatusCode

type AccountStatusCode string

AccountStatusCode represents the status code of an account.

const (
	// AccountStatusCodeNormal indicates a normal account status.
	AccountStatusCodeNormal AccountStatusCode = "normal"
	// AccountStatusCodePreferred indicates a preferred account status.
	AccountStatusCodePreferred AccountStatusCode = "preferred"
	// AccountStatusCodeHoldShipment indicates that shipments are on hold.
	AccountStatusCodeHoldShipment AccountStatusCode = "hold_shipment"
	// AccountStatusCodeHoldAll indicates that all activity is on hold.
	AccountStatusCodeHoldAll AccountStatusCode = "hold_all"
)

func (AccountStatusCode) EnumValues

func (m AccountStatusCode) EnumValues() []string

func (AccountStatusCode) IsValid

func (m AccountStatusCode) IsValid() bool

func (*AccountStatusCode) StringPtr

func (m *AccountStatusCode) StringPtr() *string

type AccountTypeCode

type AccountTypeCode string

AccountTypeCode represents the type of an account. This is useful to specify when an account is either a standard account or a sandbox account.

const (
	// AccountTypeCodeStandard indicates that the account is a standard account that is used for production and integration purposes.
	AccountTypeCodeStandard AccountTypeCode = "company" // ! NOTE: Should update to "standard" in DB and app code
	// AccountTypeCodeSandbox indicates that the account is a sandbox account that is used for testing and development purposes.
	AccountTypeCodeSandbox AccountTypeCode = "sandbox"
)

func (AccountTypeCode) EnumValues

func (c AccountTypeCode) EnumValues() []string

func (AccountTypeCode) IsValid

func (c AccountTypeCode) IsValid() bool

func (*AccountTypeCode) StringPtr

func (c *AccountTypeCode) StringPtr() *string

type AccountUserStatus

type AccountUserStatus string

AccountUserStatus represents the status of an account user.

const (
	// AccountUserStatusActive indicates that the account user is active.
	AccountUserStatusActive AccountUserStatus = "active"
	// AccountUserStatusDisabled indicates that the account user is disabled (locked).
	AccountUserStatusDisabled AccountUserStatus = "disabled"
	// AccountUserStatusRemoved indicates that the account user has been soft-deleted.
	AccountUserStatusRemoved AccountUserStatus = "removed"
)

func (AccountUserStatus) EnumValues

func (m AccountUserStatus) EnumValues() []string

func (AccountUserStatus) IsValid

func (m AccountUserStatus) IsValid() bool

func (*AccountUserStatus) StringPtr

func (m *AccountUserStatus) StringPtr() *string

type AcknowledgmentStatus

type AcknowledgmentStatus string

AcknowledgmentStatus represents whether an order acknowledgment has been sent to the customer. Modeled as an enum (rather than a bool) so additional states can be added later without a breaking change.

const (
	// AcknowledgmentStatusNotSent indicates no acknowledgment has been sent.
	AcknowledgmentStatusNotSent AcknowledgmentStatus = "not_sent"
	// AcknowledgmentStatusSent indicates the acknowledgment has been sent.
	AcknowledgmentStatusSent AcknowledgmentStatus = "sent"
)

func (AcknowledgmentStatus) EnumValues

func (m AcknowledgmentStatus) EnumValues() []string

func (AcknowledgmentStatus) IsValid

func (m AcknowledgmentStatus) IsValid() bool

func (*AcknowledgmentStatus) StringPtr

func (m *AcknowledgmentStatus) StringPtr() *string

type ActivationStatus

type ActivationStatus string

ActivationStatus is whether a configuration row is currently applied.

Modelled as a status rather than an `is_active` boolean so that a third state — say `scheduled` or `expired` — can be added without changing the field's shape or meaning.

const (
	// ActivationStatusActive indicates the row is applied.
	ActivationStatusActive ActivationStatus = "active"
	// ActivationStatusInactive indicates the row exists but is not applied.
	ActivationStatusInactive ActivationStatus = "inactive"
)

func ActivationStatusOf

func ActivationStatusOf(active bool) ActivationStatus

ActivationStatusOf maps the stored flag onto the enum the API exposes.

func (ActivationStatus) EnumValues

func (s ActivationStatus) EnumValues() []string

func (ActivationStatus) IsValid

func (s ActivationStatus) IsValid() bool

func (*ActivationStatus) StringPtr

func (s *ActivationStatus) StringPtr() *string

type ActorType

type ActorType string

ActorType represents the type of actor.

const (
	// ActorTypeUser indicates that the actor is a user.
	ActorTypeUser ActorType = "user"
	// ActorTypeAPIKey indicates that the actor is an API key.
	ActorTypeAPIKey ActorType = "api_key"
	// ActorTypeAgent indicates that the actor is an agent.
	ActorTypeAgent ActorType = "agent"
	// ActorTypeGroup indicates that the actor is a shared group identity (e.g. a "Customer Service" persona).
	ActorTypeGroup ActorType = "group"
)

func ActorTypeFromSenderType

func ActorTypeFromSenderType(t NotificationSenderType) ActorType

ActorTypeFromSenderType maps a notification/chat sender type to its unified ActorType. System (and any unattributed/unknown) senders return the empty ActorType, signalling the caller to emit a null actor rather than fabricating one.

func (ActorType) EnumValues

func (m ActorType) EnumValues() []string

func (ActorType) IsValid

func (m ActorType) IsValid() bool

func (*ActorType) StringPtr

func (m *ActorType) StringPtr() *string

type AddressType

type AddressType string

AddressType represents the public category of an address.

const (
	// AddressTypeStandard indicates a normal address.
	AddressTypeStandard AddressType = "standard"
	// AddressTypeDropShip indicates a drop ship address.
	AddressTypeDropShip AddressType = "drop_ship"
)

func (AddressType) EnumValues

func (m AddressType) EnumValues() []string

func (AddressType) IsValid

func (m AddressType) IsValid() bool

func (*AddressType) StringPtr

func (m *AddressType) StringPtr() *string

type AddressValidationStatus

type AddressValidationStatus string

AddressValidationStatus represents the result of validating an address.

const (
	// AddressValidationStatusValid indicates the address was validated successfully.
	AddressValidationStatusValid AddressValidationStatus = "valid"
	// AddressValidationStatusInvalid indicates the address could not be validated.
	AddressValidationStatusInvalid AddressValidationStatus = "invalid"
)

func (AddressValidationStatus) EnumValues

func (m AddressValidationStatus) EnumValues() []string

func (AddressValidationStatus) IsValid

func (m AddressValidationStatus) IsValid() bool

func (*AddressValidationStatus) StringPtr

func (m *AddressValidationStatus) StringPtr() *string

type AdjustmentType

type AdjustmentType string

AdjustmentType represents the type of an adjustment.

const (
	// AdjustmentTypeDiscount indicates that the adjustment is a discount.
	AdjustmentTypeDiscount AdjustmentType = "discount"
	// AdjustmentTypeShippingDiscrepancy indicates a shipping-related discrepancy.
	AdjustmentTypeShippingDiscrepancy AdjustmentType = "shipping_discrepancy"
	// AdjustmentTypeShortPayment indicates a short payment.
	AdjustmentTypeShortPayment AdjustmentType = "short_payment"
	// AdjustmentTypeWriteOff indicates a write-off.
	AdjustmentTypeWriteOff AdjustmentType = "write_off"
	// AdjustmentTypeFee indicates a fee adjustment.
	AdjustmentTypeFee AdjustmentType = "fee"
	// AdjustmentTypeRefund indicates a refund.
	AdjustmentTypeRefund AdjustmentType = "refund"
)

func (AdjustmentType) EnumValues

func (m AdjustmentType) EnumValues() []string

func (AdjustmentType) IsValid

func (m AdjustmentType) IsValid() bool

func (*AdjustmentType) StringPtr

func (m *AdjustmentType) StringPtr() *string

type AgentAccountStatus

type AgentAccountStatus string

AgentAccountStatus describes the per-account activation status of an agent definition.

const (
	// AgentAccountStatusActive indicates the agent is active for this account.
	AgentAccountStatusActive AgentAccountStatus = "active"
	// AgentAccountStatusInactive indicates the agent is inactive for this account.
	AgentAccountStatusInactive AgentAccountStatus = "inactive"
)

func (AgentAccountStatus) EnumValues

func (m AgentAccountStatus) EnumValues() []string

func (AgentAccountStatus) IsValid

func (m AgentAccountStatus) IsValid() bool

func (*AgentAccountStatus) StringPtr

func (m *AgentAccountStatus) StringPtr() *string

type AgentActionStatus

type AgentActionStatus string

AgentActionStatus represents the status of an agent action.

const (
	// AgentActionStatusPendingReview indicates the action is awaiting human review.
	AgentActionStatusPendingReview AgentActionStatus = "pending_review"
	// AgentActionStatusAutoApproved indicates the action was automatically approved by policy.
	AgentActionStatusAutoApproved AgentActionStatus = "auto_approved"
	// AgentActionStatusApproved indicates the action was manually approved by a user.
	AgentActionStatusApproved AgentActionStatus = "approved"
	// AgentActionStatusRejected indicates the action was rejected by a user.
	AgentActionStatusRejected AgentActionStatus = "rejected"
	// AgentActionStatusExecuted indicates the action was successfully executed.
	AgentActionStatusExecuted AgentActionStatus = "executed"
	// AgentActionStatusFailed indicates the action failed during execution.
	AgentActionStatusFailed AgentActionStatus = "failed"
)

func (AgentActionStatus) EnumValues

func (s AgentActionStatus) EnumValues() []string

func (AgentActionStatus) IsValid

func (s AgentActionStatus) IsValid() bool

func (*AgentActionStatus) StringPtr

func (s *AgentActionStatus) StringPtr() *string

type AgentAlertSeverity

type AgentAlertSeverity string

AgentAlertSeverity represents the severity level of an agent alert.

const (
	// AgentAlertSeverityInfo indicates an informational alert that requires no immediate action.
	AgentAlertSeverityInfo AgentAlertSeverity = "info"
	// AgentAlertSeverityWarning indicates a potential issue that should be reviewed.
	AgentAlertSeverityWarning AgentAlertSeverity = "warning"
	// AgentAlertSeverityUrgent indicates an issue that requires prompt attention.
	AgentAlertSeverityUrgent AgentAlertSeverity = "urgent"
	// AgentAlertSeverityCritical indicates a severe issue requiring immediate action.
	AgentAlertSeverityCritical AgentAlertSeverity = "critical"
)

func (AgentAlertSeverity) EnumValues

func (s AgentAlertSeverity) EnumValues() []string

func (AgentAlertSeverity) IsValid

func (s AgentAlertSeverity) IsValid() bool

func (*AgentAlertSeverity) StringPtr

func (s *AgentAlertSeverity) StringPtr() *string

type AgentDefinitionType

type AgentDefinitionType string

AgentDefinitionType classifies an agent definition as system-provided or user-created.

const (
	// AgentDefinitionTypeSystem indicates that the agent definition is provided by the system.
	AgentDefinitionTypeSystem AgentDefinitionType = "system"
	// AgentDefinitionTypeCustom indicates that the agent definition is created by the user.
	AgentDefinitionTypeCustom AgentDefinitionType = "custom"
)

func (AgentDefinitionType) EnumValues

func (m AgentDefinitionType) EnumValues() []string

func (AgentDefinitionType) IsValid

func (m AgentDefinitionType) IsValid() bool

func (*AgentDefinitionType) StringPtr

func (m *AgentDefinitionType) StringPtr() *string

type AgentMemoryCategory

type AgentMemoryCategory string

AgentMemoryCategory is the kind of information an agent memory holds, used to group related memories.

const (
	// AgentMemoryCategoryPreference is how someone likes things done, such as a customer who always wants express shipping.
	AgentMemoryCategoryPreference AgentMemoryCategory = "preference"
	// AgentMemoryCategoryFact is a durable detail worth remembering about the account or one of its records, such as a customer's typical order size.
	AgentMemoryCategoryFact AgentMemoryCategory = "fact"
	// AgentMemoryCategoryInstruction is standing guidance for agents to follow, such as always confirming freight before issuing an order.
	AgentMemoryCategoryInstruction AgentMemoryCategory = "instruction"
)

func (AgentMemoryCategory) EnumValues

func (c AgentMemoryCategory) EnumValues() []string

func (AgentMemoryCategory) IsValid

func (c AgentMemoryCategory) IsValid() bool

func (*AgentMemoryCategory) StringPtr

func (c *AgentMemoryCategory) StringPtr() *string

type AgentRunStatus

type AgentRunStatus string

AgentRunStatus represents the execution status of an agent run.

const (
	// AgentRunStatusPending indicates the run is queued but not yet started.
	AgentRunStatusPending AgentRunStatus = "pending"
	// AgentRunStatusRunning indicates the run is currently executing.
	AgentRunStatusRunning AgentRunStatus = "running"
	// AgentRunStatusCompleted indicates the run finished successfully.
	AgentRunStatusCompleted AgentRunStatus = "completed"
	// AgentRunStatusFailed indicates the run encountered an error.
	AgentRunStatusFailed AgentRunStatus = "failed"
	// AgentRunStatusCancelled indicates the run was cancelled.
	AgentRunStatusCancelled AgentRunStatus = "cancelled"
	// AgentRunStatusAwaitingInput indicates the run is waiting for user input.
	AgentRunStatusAwaitingInput AgentRunStatus = "awaiting_input"
	// AgentRunStatusAwaitingApproval indicates the run is waiting for approval.
	AgentRunStatusAwaitingApproval AgentRunStatus = "awaiting_approval"
)

func (AgentRunStatus) EnumValues

func (m AgentRunStatus) EnumValues() []string

func (AgentRunStatus) IsValid

func (m AgentRunStatus) IsValid() bool

func (*AgentRunStatus) StringPtr

func (m *AgentRunStatus) StringPtr() *string

type AgentToolCategory added in v1.1.6

type AgentToolCategory string

AgentToolCategory is where an agent tool's behavior comes from.

const (
	// AgentToolCategoryBuiltIn is a capability implemented by the agent runtime itself.
	AgentToolCategoryBuiltIn AgentToolCategory = "built_in"
	// AgentToolCategoryAPIEndpoint is an operation of this API exposed as a tool.
	AgentToolCategoryAPIEndpoint AgentToolCategory = "api_endpoint"
)

func (AgentToolCategory) EnumValues added in v1.1.6

func (c AgentToolCategory) EnumValues() []string

func (AgentToolCategory) IsValid added in v1.1.6

func (c AgentToolCategory) IsValid() bool

func (*AgentToolCategory) StringPtr added in v1.1.6

func (c *AgentToolCategory) StringPtr() *string

type AgentTriggerPolicy

type AgentTriggerPolicy string

AgentTriggerPolicy controls when an agent participant is invoked in response to a human message. It is an enum so new policies can be added without a breaking change to the API.

const (
	// AgentTriggerPolicyMention fires only when the agent is @mentioned (body contains "@" + a handle from the participant's trigger keywords).
	AgentTriggerPolicyMention AgentTriggerPolicy = "mention"
	// AgentTriggerPolicyKeyword fires when the body contains any of the participant's trigger keywords.
	AgentTriggerPolicyKeyword AgentTriggerPolicy = "keyword"
	// AgentTriggerPolicyAlways fires on every human message in the conversation.
	AgentTriggerPolicyAlways AgentTriggerPolicy = "always"
)

func (AgentTriggerPolicy) EnumValues

func (p AgentTriggerPolicy) EnumValues() []string

func (AgentTriggerPolicy) IsValid

func (p AgentTriggerPolicy) IsValid() bool

func (*AgentTriggerPolicy) StringPtr

func (p *AgentTriggerPolicy) StringPtr() *string

type AgentTriggerType

type AgentTriggerType string

AgentTriggerType describes how an agent run is initiated.

const (
	// AgentTriggerTypeScheduled indicates that the agent run is initiated by a scheduled event.
	AgentTriggerTypeScheduled AgentTriggerType = "scheduled"
	// AgentTriggerTypeManual indicates that the agent run is initiated by a manual event.
	AgentTriggerTypeManual AgentTriggerType = "manual"
	// AgentTriggerTypeEvent indicates that the agent run is initiated by an event.
	AgentTriggerTypeEvent AgentTriggerType = "event"
	// AgentTriggerTypeChat indicates that the agent run is initiated by a chat message (the run is linked to a conversation and posts its reply back into it).
	AgentTriggerTypeChat AgentTriggerType = "chat"
)

func (AgentTriggerType) EnumValues

func (m AgentTriggerType) EnumValues() []string

func (AgentTriggerType) IsValid

func (m AgentTriggerType) IsValid() bool

func (*AgentTriggerType) StringPtr

func (m *AgentTriggerType) StringPtr() *string

type AnnouncementScope

type AnnouncementScope string

AnnouncementScope is the reach of an announcement: a single account's users, or every user on the platform.

const (
	// AnnouncementScopeAccount targets all active users within one account.
	AnnouncementScopeAccount AnnouncementScope = "account"
	// AnnouncementScopePlatform targets every user across all accounts (platform-wide).
	AnnouncementScopePlatform AnnouncementScope = "platform"
)

func (AnnouncementScope) EnumValues

func (s AnnouncementScope) EnumValues() []string

func (AnnouncementScope) IsValid

func (s AnnouncementScope) IsValid() bool

func (*AnnouncementScope) StringPtr

func (s *AnnouncementScope) StringPtr() *string

type AttainmentBaselineStatus

type AttainmentBaselineStatus string

AttainmentBaselineStatus says whether a measured period had a plan to be measured against at all. A period with no published version has no attainment, which is a different statement from missing the plan entirely.

const (
	// AttainmentBaselineStatusMeasured indicates a published version covered the period.
	AttainmentBaselineStatusMeasured AttainmentBaselineStatus = "measured"
	// AttainmentBaselineStatusNoBaseline indicates nothing was published over the period.
	AttainmentBaselineStatusNoBaseline AttainmentBaselineStatus = "no_baseline"
)

func (AttainmentBaselineStatus) EnumValues

func (s AttainmentBaselineStatus) EnumValues() []string

func (AttainmentBaselineStatus) IsValid

func (s AttainmentBaselineStatus) IsValid() bool

func (*AttainmentBaselineStatus) StringPtr

func (s *AttainmentBaselineStatus) StringPtr() *string

type AttainmentGroupBy

type AttainmentGroupBy string

AttainmentGroupBy is the dimension a schedule-attainment breakdown is grouped by.

const (
	// AttainmentGroupByWeek groups attainment by horizon week.
	AttainmentGroupByWeek AttainmentGroupBy = "week"
	// AttainmentGroupByMachine groups attainment by machine.
	AttainmentGroupByMachine AttainmentGroupBy = "machine"
	// AttainmentGroupByDepartment groups attainment by department.
	AttainmentGroupByDepartment AttainmentGroupBy = "department"
	// AttainmentGroupByItem groups attainment by item.
	AttainmentGroupByItem AttainmentGroupBy = "item"
)

func (AttainmentGroupBy) EnumValues

func (g AttainmentGroupBy) EnumValues() []string

func (AttainmentGroupBy) IsValid

func (g AttainmentGroupBy) IsValid() bool

func (*AttainmentGroupBy) StringPtr

func (g *AttainmentGroupBy) StringPtr() *string

type AuditAction

type AuditAction string

AuditAction is the type of mutation that occurred for an audited resource.

const (
	// AuditActionCreate represents a creation mutation.
	AuditActionCreate AuditAction = "create"
	// AuditActionUpdate represents an update mutation.
	AuditActionUpdate AuditAction = "update"
	// AuditActionUpsert represents an upsert mutation.
	AuditActionUpsert AuditAction = "upsert"
	// AuditActionDelete represents a deletion mutation.
	AuditActionDelete AuditAction = "delete"
	// AuditActionRestore represents a restore mutation.
	AuditActionRestore AuditAction = "restore"
	// AuditActionArchive represents an archive mutation.
	AuditActionArchive AuditAction = "archive"
	// AuditActionApprove represents a human approving a gated action (e.g. letting a review-gated agent tool run).
	AuditActionApprove AuditAction = "approve"
	// AuditActionDeny represents a human denying a gated action (e.g. rejecting a review-gated agent tool).
	AuditActionDeny AuditAction = "deny"
)

func (AuditAction) EnumValues

func (m AuditAction) EnumValues() []string

func (AuditAction) IsValid

func (m AuditAction) IsValid() bool

func (*AuditAction) StringPtr

func (m *AuditAction) StringPtr() *string

type BatchLotType added in v1.1.6

type BatchLotType string

BatchLotType names what a batch's lot number traces back to.

const (
	// BatchLotTypeMaterial means the lot number traces a raw material consumed by the batch.
	BatchLotTypeMaterial BatchLotType = "material"
	// BatchLotTypeProductionRun means the lot number is the production run number the batch belongs to.
	BatchLotTypeProductionRun BatchLotType = "productionRun"
)

func (BatchLotType) EnumValues added in v1.1.6

func (t BatchLotType) EnumValues() []string

func (BatchLotType) IsValid added in v1.1.6

func (t BatchLotType) IsValid() bool

func (*BatchLotType) StringPtr added in v1.1.6

func (t *BatchLotType) StringPtr() *string

type BulkResultAction added in v1.1.6

type BulkResultAction string

BulkResultAction is what a bulk create did to the record behind one row, which may be an update rather than an insert when the row matched something that already existed.

const (
	// BulkResultActionCreated means a new record was inserted.
	BulkResultActionCreated BulkResultAction = "created"
	// BulkResultActionUpdated means an existing record was updated in place.
	BulkResultActionUpdated BulkResultAction = "updated"
	// BulkResultActionSkipped means nothing was written for the row.
	BulkResultActionSkipped BulkResultAction = "skipped"
)

func (BulkResultAction) EnumValues added in v1.1.6

func (a BulkResultAction) EnumValues() []string

func (BulkResultAction) IsValid added in v1.1.6

func (a BulkResultAction) IsValid() bool

func (*BulkResultAction) StringPtr added in v1.1.6

func (a *BulkResultAction) StringPtr() *string

type BulkResultStatus added in v1.1.6

type BulkResultStatus string

BulkResultStatus is the outcome of one row in a bulk create response.

const (
	// BulkResultStatusCreated means the row was written.
	BulkResultStatusCreated BulkResultStatus = "created"
	// BulkResultStatusFailed means the row was rejected; the result carries the reason.
	BulkResultStatusFailed BulkResultStatus = "failed"
)

func (BulkResultStatus) EnumValues added in v1.1.6

func (s BulkResultStatus) EnumValues() []string

func (BulkResultStatus) IsValid added in v1.1.6

func (s BulkResultStatus) IsValid() bool

func (*BulkResultStatus) StringPtr added in v1.1.6

func (s *BulkResultStatus) StringPtr() *string

type CarrierBillingType

type CarrierBillingType string

CarrierBillingType represents the carrier billing type for an account relation.

const (
	// CarrierBillingTypeSender indicates the sender pays for shipping.
	CarrierBillingTypeSender CarrierBillingType = "sender"
	// CarrierBillingTypeThirdParty indicates a third party pays for shipping.
	CarrierBillingTypeThirdParty CarrierBillingType = "third_party"
)

func (CarrierBillingType) EnumValues

func (m CarrierBillingType) EnumValues() []string

func (CarrierBillingType) IsValid

func (m CarrierBillingType) IsValid() bool

func (*CarrierBillingType) StringPtr

func (m *CarrierBillingType) StringPtr() *string

type CarrierCode

type CarrierCode string

CarrierCode identifies a shipping carrier.

const (
	// CarrierCodeFedEx identifies the FedEx carrier.
	CarrierCodeFedEx CarrierCode = "fedex"
	// CarrierCodeUPS identifies the UPS carrier.
	CarrierCodeUPS CarrierCode = "ups"
	// CarrierCodeUSPS identifies the USPS carrier.
	CarrierCodeUSPS CarrierCode = "usps"
	// CarrierCodeWillCall identifies the will-call carrier.
	CarrierCodeWillCall CarrierCode = "will_call"
	// CarrierCodeDelivery identifies the delivery carrier.
	CarrierCodeDelivery CarrierCode = "delivery"
	// CarrierCodeLTL identifies the LTL carrier.
	CarrierCodeLTL CarrierCode = "ltl"
	// CarrierCodeLTL1 identifies the LTL1 carrier.
	CarrierCodeLTL1 CarrierCode = "ltl1"
	// CarrierCodeFreightCollect identifies the freight collect carrier.
	CarrierCodeFreightCollect CarrierCode = "freight_collect"
)

func (CarrierCode) EnumValues

func (m CarrierCode) EnumValues() []string

func (CarrierCode) IsValid

func (m CarrierCode) IsValid() bool

func (*CarrierCode) StringPtr

func (m *CarrierCode) StringPtr() *string

type CarrierConnectionStatus added in v1.1.6

type CarrierConnectionStatus string

CarrierConnectionStatus is how far a carrier account has gotten through OAuth authorization.

const (
	// CarrierConnectionStatusConnected means the account's own carrier account is authorized, for live rating and label purchase.
	CarrierConnectionStatusConnected CarrierConnectionStatus = "connected"
	// CarrierConnectionStatusAuthorizationPending means a carrier account exists but is still the shared default one, so authorization has not been completed.
	CarrierConnectionStatusAuthorizationPending CarrierConnectionStatus = "authorization_pending"
	// CarrierConnectionStatusDisconnected means there is no carrier account to authorize, or it could not be reached. Sandbox accounts always report this.
	CarrierConnectionStatusDisconnected CarrierConnectionStatus = "disconnected"
)

func (CarrierConnectionStatus) EnumValues added in v1.1.6

func (s CarrierConnectionStatus) EnumValues() []string

func (CarrierConnectionStatus) IsValid added in v1.1.6

func (s CarrierConnectionStatus) IsValid() bool

func (*CarrierConnectionStatus) StringPtr added in v1.1.6

func (s *CarrierConnectionStatus) StringPtr() *string

type Color

type Color string

Color represents a color code.

const (
	// ColorBlue indicates the color blue.
	ColorBlue Color = "blue"
	// ColorBrown indicates the color brown.
	ColorBrown Color = "brown"
	// ColorDefault indicates the default color.
	ColorDefault Color = "default"
	// ColorGray indicates the color gray.
	ColorGray Color = "gray"
	// ColorGreen indicates the color green.
	ColorGreen Color = "green"
	// ColorOrange indicates the color orange.
	ColorOrange Color = "orange"
	// ColorPink indicates the color pink.
	ColorPink Color = "pink"
	// ColorPurple indicates the color purple.
	ColorPurple Color = "purple"
	// ColorRed indicates the color red.
	ColorRed Color = "red"
	// ColorYellow indicates the color yellow.
	ColorYellow Color = "yellow"
)

func (Color) EnumValues

func (m Color) EnumValues() []string

func (Color) IsValid

func (m Color) IsValid() bool

func (*Color) StringPtr

func (m *Color) StringPtr() *string

type CommissionPolicy

type CommissionPolicy string

CommissionPolicy represents the commission status of an account group.

const (
	// CommissionPolicyApplied indicates that commission is applied.
	CommissionPolicyApplied CommissionPolicy = "commission_applied"
	// CommissionPolicyExempt indicates that the account group is exempt from commission.
	CommissionPolicyExempt CommissionPolicy = "commission_exempt"
)

func CommissionPolicyFromBool

func CommissionPolicyFromBool(isExempt bool) CommissionPolicy

CommissionPolicyFromBool converts a boolean is_commission_exempt flag to a CommissionPolicy.

func (CommissionPolicy) EnumValues

func (m CommissionPolicy) EnumValues() []string

func (CommissionPolicy) IsValid

func (m CommissionPolicy) IsValid() bool

func (*CommissionPolicy) StringPtr

func (m *CommissionPolicy) StringPtr() *string

func (CommissionPolicy) ToBool

func (m CommissionPolicy) ToBool() bool

ToBool converts a CommissionPolicy to a boolean is_commission_exempt flag.

type CommitmentStep

type CommitmentStep string

CommitmentStep names one rule in the derivation of a ship-by date. Returned as an ordered list so a caller can render why a date is what it is without reimplementing the arithmetic, and so the explanation cannot drift from the calculation.

const (
	// CommitmentStepBasis is the starting date, from whichever basis the order pinned or the lead-time chain resolved.
	CommitmentStepBasis CommitmentStep = "basis"
	// CommitmentStepReceiveCalendar is the move back onto a day the customer's dock accepts freight.
	CommitmentStepReceiveCalendar CommitmentStep = "receive_calendar"
	// CommitmentStepCarrierTransit is the walk back through the days the carrier moves freight.
	CommitmentStepCarrierTransit CommitmentStep = "carrier_transit"
	// CommitmentStepShipCalendar is the move back onto a day the plant tenders freight.
	CommitmentStepShipCalendar CommitmentStep = "ship_calendar"
	// CommitmentStepPickupCutoff is the time of day the ship-by date resolves to, from the plant's cutoff.
	CommitmentStepPickupCutoff CommitmentStep = "pickup_cutoff"
)

func (CommitmentStep) EnumValues

func (m CommitmentStep) EnumValues() []string

func (CommitmentStep) IsValid

func (m CommitmentStep) IsValid() bool

func (*CommitmentStep) StringPtr

func (m *CommitmentStep) StringPtr() *string

type ContactRelationship

type ContactRelationship string

ContactRelationship describes how the caller relates to the account a matched contact belongs to.

const (
	// ContactRelationshipCustomer indicates the contact belongs to one of the caller's customers.
	ContactRelationshipCustomer ContactRelationship = "customer"
	// ContactRelationshipSupplier indicates the contact belongs to one of the caller's suppliers.
	ContactRelationshipSupplier ContactRelationship = "supplier"
	// ContactRelationshipSelf indicates the contact belongs to the caller's own account.
	ContactRelationshipSelf ContactRelationship = "self"
)

func (ContactRelationship) EnumValues

func (r ContactRelationship) EnumValues() []string

func (ContactRelationship) IsValid

func (r ContactRelationship) IsValid() bool

func (*ContactRelationship) StringPtr

func (r *ContactRelationship) StringPtr() *string

type ConversationAssigneeType added in v1.1.6

type ConversationAssigneeType string

ConversationAssigneeType names the kind of owner a customer-service case is assigned to.

const (
	// ConversationAssigneeTypeAccountUser gives the case to an individual teammate.
	ConversationAssigneeTypeAccountUser ConversationAssigneeType = "account_user"
	// ConversationAssigneeTypeAccountGroup gives the case to a team, so anyone on it can pick it up.
	ConversationAssigneeTypeAccountGroup ConversationAssigneeType = "account_group"
)

func (ConversationAssigneeType) EnumValues added in v1.1.6

func (t ConversationAssigneeType) EnumValues() []string

func (ConversationAssigneeType) IsValid added in v1.1.6

func (t ConversationAssigneeType) IsValid() bool

func (*ConversationAssigneeType) StringPtr added in v1.1.6

func (t *ConversationAssigneeType) StringPtr() *string

type ConversationAudience

type ConversationAudience string

ConversationAudience is the direction of a conversation, orthogonal to its type. "internal" is a team-only conversation (the customer is never a participant — e.g. a DM, group, or object-linked discussion ABOUT a customer); "customer" is an external customer-facing case the customer participates in and sees (portal support or an email-bridged thread). It drives the support inbox and the per-message customer-visible read filtering.

const (
	// ConversationAudienceInternal is a team-only conversation.
	ConversationAudienceInternal ConversationAudience = "internal"
	// ConversationAudienceCustomer is an external customer-facing case.
	ConversationAudienceCustomer ConversationAudience = "customer"
)

func (ConversationAudience) EnumValues

func (a ConversationAudience) EnumValues() []string

func (ConversationAudience) IsValid

func (a ConversationAudience) IsValid() bool

func (*ConversationAudience) StringPtr

func (a *ConversationAudience) StringPtr() *string

type ConversationListStatus

type ConversationListStatus string

ConversationListStatus filters the caller's conversation list by visibility.

const (
	// ConversationListStatusActive returns visible conversations (not hidden by the caller).
	ConversationListStatusActive ConversationListStatus = "active"
	// ConversationListStatusHidden returns conversations the caller has hidden.
	ConversationListStatusHidden ConversationListStatus = "hidden"
)

func (ConversationListStatus) EnumValues

func (s ConversationListStatus) EnumValues() []string

func (ConversationListStatus) IsValid

func (s ConversationListStatus) IsValid() bool

func (*ConversationListStatus) StringPtr

func (s *ConversationListStatus) StringPtr() *string

type ConversationStatus

type ConversationStatus string

ConversationStatus is the caller's effective view of a conversation. It is an enum (not a boolean) so new states (e.g. frozen, deleted) can be added without a breaking change to the API. Hidden is per-caller and takes precedence over the account-level archived state.

const (
	// ConversationStatusActive is a normal, visible conversation.
	ConversationStatusActive ConversationStatus = "active"
	// ConversationStatusArchived is archived at the account level.
	ConversationStatusArchived ConversationStatus = "archived"
	// ConversationStatusHidden is hidden from the caller's list (per-caller, dismissed).
	ConversationStatusHidden ConversationStatus = "hidden"
)

func (ConversationStatus) EnumValues

func (s ConversationStatus) EnumValues() []string

func (ConversationStatus) IsValid

func (s ConversationStatus) IsValid() bool

func (*ConversationStatus) StringPtr

func (s *ConversationStatus) StringPtr() *string

type ConversationType

type ConversationType string

ConversationType is the kind of conversation container.

const (
	// ConversationTypeDM is a 1:1 direct message between exactly two users.
	ConversationTypeDM ConversationType = "direct_message"
	// ConversationTypeGroup is a named conversation with 2+ user/agent participants.
	ConversationTypeGroup ConversationType = "group"
	// ConversationTypeSystem is a per-account/per-category system channel for alerts.
	ConversationTypeSystem ConversationType = "system"
)

func (ConversationType) EnumValues

func (t ConversationType) EnumValues() []string

func (ConversationType) IsValid

func (t ConversationType) IsValid() bool

func (*ConversationType) StringPtr

func (t *ConversationType) StringPtr() *string

type ConversationWorkflowStatus

type ConversationWorkflowStatus string

ConversationWorkflowStatus is the triage lane of an external (audience=customer) customer-service case. It is orthogonal to the per-caller ConversationStatus (active/hidden/archived): a case is archived via is_archived, while the workflow status drives the support inbox. Null on internal conversations.

const (
	// ConversationWorkflowStatusNew is a freshly opened case nobody has triaged yet.
	ConversationWorkflowStatusNew ConversationWorkflowStatus = "new"
	// ConversationWorkflowStatusOpen is an actively worked case.
	ConversationWorkflowStatusOpen ConversationWorkflowStatus = "open"
	// ConversationWorkflowStatusWaitingInternal is blocked on the internal team.
	ConversationWorkflowStatusWaitingInternal ConversationWorkflowStatus = "waiting_internal"
	// ConversationWorkflowStatusWaitingExternal is blocked on an external reply.
	ConversationWorkflowStatusWaitingExternal ConversationWorkflowStatus = "waiting_external"
	// ConversationWorkflowStatusNeedsApproval has a draft reply awaiting human approval.
	ConversationWorkflowStatusNeedsApproval ConversationWorkflowStatus = "needs_approval"
	// ConversationWorkflowStatusResolved is a closed-out case.
	ConversationWorkflowStatusResolved ConversationWorkflowStatus = "resolved"
)

func (ConversationWorkflowStatus) EnumValues

func (s ConversationWorkflowStatus) EnumValues() []string

func (ConversationWorkflowStatus) IsValid

func (s ConversationWorkflowStatus) IsValid() bool

func (*ConversationWorkflowStatus) StringPtr

func (s *ConversationWorkflowStatus) StringPtr() *string

type CreatedByRelation

type CreatedByRelation string

CreatedByRelation describes the relationship of an order's creator to the account that owns the order.

const (
	// CreatedByRelationInternal indicates the creator was an internal user of the owning account.
	CreatedByRelationInternal CreatedByRelation = "internal"
	// CreatedByRelationCustomer indicates the creator was a customer of the owning account.
	CreatedByRelationCustomer CreatedByRelation = "customer"
	// CreatedByRelationSystem indicates the resource was created by the system, with no human actor (e.g. EDI import).
	CreatedByRelationSystem CreatedByRelation = "system"
)

func (CreatedByRelation) EnumValues

func (r CreatedByRelation) EnumValues() []string

func (CreatedByRelation) IsValid

func (r CreatedByRelation) IsValid() bool

func (*CreatedByRelation) StringPtr

func (r *CreatedByRelation) StringPtr() *string

type CustomerParentAccountStatus

type CustomerParentAccountStatus string

CustomerParentAccountStatus filters whether customers have child accounts.

const (
	// CustomerParentAccountStatusParent indicates customers with child accounts.
	CustomerParentAccountStatusParent CustomerParentAccountStatus = "parent"
	// CustomerParentAccountStatusNonParent indicates customers without child accounts.
	CustomerParentAccountStatusNonParent CustomerParentAccountStatus = "non_parent"
)

func (CustomerParentAccountStatus) EnumValues

func (m CustomerParentAccountStatus) EnumValues() []string

func (CustomerParentAccountStatus) IsValid

func (m CustomerParentAccountStatus) IsValid() bool

func (*CustomerParentAccountStatus) StringPtr

func (m *CustomerParentAccountStatus) StringPtr() *string

type CustomerPortalVisibility

type CustomerPortalVisibility string

CustomerPortalVisibility represents whether a resource is visible in the customer portal.

const (
	// CustomerPortalVisibilityVisible indicates the resource is visible in the customer portal.
	CustomerPortalVisibilityVisible CustomerPortalVisibility = "visible"
	// CustomerPortalVisibilityHidden indicates the resource is hidden from the customer portal.
	CustomerPortalVisibilityHidden CustomerPortalVisibility = "hidden"
)

func (CustomerPortalVisibility) EnumValues

func (m CustomerPortalVisibility) EnumValues() []string

func (CustomerPortalVisibility) IsValid

func (m CustomerPortalVisibility) IsValid() bool

func (*CustomerPortalVisibility) StringPtr

func (m *CustomerPortalVisibility) StringPtr() *string

type CustomerRelationshipType

type CustomerRelationshipType string

CustomerRelationshipType represents a customer's position in an account hierarchy.

const (
	// CustomerRelationshipTypeStandalone indicates the customer has no parent or child accounts.
	CustomerRelationshipTypeStandalone CustomerRelationshipType = "standalone"
	// CustomerRelationshipTypeParent indicates the customer has child accounts.
	CustomerRelationshipTypeParent CustomerRelationshipType = "parent"
	// CustomerRelationshipTypeChild indicates the customer belongs to a parent account.
	CustomerRelationshipTypeChild CustomerRelationshipType = "child"
)

func (CustomerRelationshipType) EnumValues

func (m CustomerRelationshipType) EnumValues() []string

func (CustomerRelationshipType) IsValid

func (m CustomerRelationshipType) IsValid() bool

func (*CustomerRelationshipType) StringPtr

func (m *CustomerRelationshipType) StringPtr() *string

type DNSRecordReason

type DNSRecordReason string

DNSRecordReason explains why a portal domain DNS record must be published.

const (
	// DNSRecordReasonRouting indicates the record points traffic at the portal's serving infrastructure.
	DNSRecordReasonRouting DNSRecordReason = "routing"
	// DNSRecordReasonOwnership indicates the record proves control of a domain that is claimed elsewhere.
	DNSRecordReasonOwnership DNSRecordReason = "ownership"
)

func (DNSRecordReason) EnumValues

func (r DNSRecordReason) EnumValues() []string

func (DNSRecordReason) IsValid

func (r DNSRecordReason) IsValid() bool

func (*DNSRecordReason) StringPtr

func (r *DNSRecordReason) StringPtr() *string

type DNSRecordType

type DNSRecordType string

DNSRecordType is the DNS record type a customer must publish for a portal domain.

const (
	// DNSRecordTypeCNAME points a subdomain at the portal's serving infrastructure.
	DNSRecordTypeCNAME DNSRecordType = "CNAME"
	// DNSRecordTypeA points an apex domain at the portal's serving infrastructure.
	DNSRecordTypeA DNSRecordType = "A"
	// DNSRecordTypeTXT carries an ownership-verification challenge.
	DNSRecordTypeTXT DNSRecordType = "TXT"
)

func (DNSRecordType) EnumValues

func (t DNSRecordType) EnumValues() []string

func (DNSRecordType) IsValid

func (t DNSRecordType) IsValid() bool

func (*DNSRecordType) StringPtr

func (t *DNSRecordType) StringPtr() *string

type DashboardPath

type DashboardPath string

DashboardPath represents all routes to the OpenMRP Dashboard.

const (
	// DashboardPathRegisterVerify is the path where we should send a user to verify their registration token.
	DashboardPathRegisterVerify DashboardPath = "/auth/register/verify"
	// DashboardPathResetPassword is the path where we should send a user to reset their password.
	DashboardPathResetPassword DashboardPath = "/auth/password-reset" // #nosec G101 - URL path, not a credential
	// DashboardPathLogin is the path where we should send a user to login.
	DashboardPathLogin DashboardPath = "/auth/login"
	// DashboardPathRegisterCheckoutReturn is the path Stripe redirects to after checkout. Use with fmt.Sprintf to inject the session ID: fmt.Sprintf(path, sessionTypeID)
	DashboardPathRegisterCheckoutReturn DashboardPath = "/auth/register/%s?checkout_session_id={CHECKOUT_SESSION_ID}"
	// DashboardPathBillingPortal is the path users return to after the Stripe billing portal.
	DashboardPathBillingPortal DashboardPath = "/dashboard/account?tab=billing"
	// DashboardPathMagicLogin is the path where a magic login token is exchanged for a session.
	DashboardPathMagicLogin DashboardPath = "/auth/magic-login"
)

func (DashboardPath) EnumValues

func (m DashboardPath) EnumValues() []string

func (DashboardPath) IsValid

func (m DashboardPath) IsValid() bool

func (*DashboardPath) StringPtr

func (m *DashboardPath) StringPtr() *string

type DeletedRecordResourceType

type DeletedRecordResourceType string

DeletedRecordResourceType represents a resource type stored in deleted_record.

const (
	// DeletedRecordResourceTypeAccountGroup identifies deleted account_group records.
	DeletedRecordResourceTypeAccountGroup DeletedRecordResourceType = "account_group"
	// DeletedRecordResourceTypeAccountGroupProductLineAccess identifies deleted account_group_product_line_access records.
	DeletedRecordResourceTypeAccountGroupProductLineAccess DeletedRecordResourceType = "account_group_product_line_access"
	// DeletedRecordResourceTypeAccountIntegration identifies deleted account_integration records.
	DeletedRecordResourceTypeAccountIntegration DeletedRecordResourceType = "account_integration"
	// DeletedRecordResourceTypeAccountPrice identifies deleted account_price records.
	DeletedRecordResourceTypeAccountPrice DeletedRecordResourceType = "account_price"
	// DeletedRecordResourceTypeAccountUser identifies deleted account_user records.
	DeletedRecordResourceTypeAccountUser DeletedRecordResourceType = "account_user"
	// DeletedRecordResourceTypeAddress identifies deleted address records.
	DeletedRecordResourceTypeAddress DeletedRecordResourceType = "address"
	// DeletedRecordResourceTypeAttribute identifies deleted attribute records.
	DeletedRecordResourceTypeAttribute DeletedRecordResourceType = "attribute"
	// DeletedRecordResourceTypeBatch identifies deleted batch records.
	DeletedRecordResourceTypeBatch DeletedRecordResourceType = "batch"
	// DeletedRecordResourceTypeCarrier identifies deleted carrier records.
	DeletedRecordResourceTypeCarrier DeletedRecordResourceType = "carrier"
	// DeletedRecordResourceTypeServiceLevel identifies deleted service_level records.
	DeletedRecordResourceTypeServiceLevel DeletedRecordResourceType = "service_level"
	// DeletedRecordResourceTypeConsumption identifies deleted consumption records.
	DeletedRecordResourceTypeConsumption DeletedRecordResourceType = "consumption"
	// DeletedRecordResourceTypeCustomAgent identifies deleted custom_agent records.
	DeletedRecordResourceTypeCustomAgent DeletedRecordResourceType = "custom_agent"
	// DeletedRecordResourceTypeAgentMemory identifies deleted agent_memory records.
	DeletedRecordResourceTypeAgentMemory DeletedRecordResourceType = "agent_memory"
	// DeletedRecordResourceTypeMessagingGroup identifies deleted messaging_group records.
	DeletedRecordResourceTypeMessagingGroup DeletedRecordResourceType = "messaging_group"
	// DeletedRecordResourceTypeCustomer identifies deleted customer records.
	DeletedRecordResourceTypeCustomer DeletedRecordResourceType = "customer"
	// DeletedRecordResourceTypeCustomerProductLineAccess identifies deleted customer_product_line_access records.
	DeletedRecordResourceTypeCustomerProductLineAccess DeletedRecordResourceType = "customer_product_line_access"
	// DeletedRecordResourceTypeDCLocation identifies deleted dc_location records.
	DeletedRecordResourceTypeDCLocation DeletedRecordResourceType = "dc_location"
	// DeletedRecordResourceTypeDepartment identifies deleted department records.
	DeletedRecordResourceTypeDepartment DeletedRecordResourceType = "department"
	// DeletedRecordResourceTypeItemCategory identifies deleted item_category records.
	DeletedRecordResourceTypeItemCategory DeletedRecordResourceType = "item_category"
	// DeletedRecordResourceTypeMachine identifies deleted machine records.
	DeletedRecordResourceTypeMachine DeletedRecordResourceType = "machine"
	// DeletedRecordResourceTypeMaterial identifies deleted material records.
	DeletedRecordResourceTypeMaterial DeletedRecordResourceType = "material"
	// DeletedRecordResourceTypeOrderDiscount identifies deleted order_discount records.
	DeletedRecordResourceTypeOrderDiscount DeletedRecordResourceType = "order_discount"
	// DeletedRecordResourceTypePart identifies deleted part records.
	DeletedRecordResourceTypePart DeletedRecordResourceType = "part"
	// DeletedRecordResourceTypePaymentTerm identifies deleted payment_term records.
	DeletedRecordResourceTypePaymentTerm DeletedRecordResourceType = "payment_term"
	// DeletedRecordResourceTypeProduct identifies deleted product records.
	DeletedRecordResourceTypeProduct DeletedRecordResourceType = "product"
	// DeletedRecordResourceTypeProductLine identifies deleted product_line records.
	DeletedRecordResourceTypeProductLine DeletedRecordResourceType = "product_line"
	// DeletedRecordResourceTypeProductType identifies deleted product_type records.
	DeletedRecordResourceTypeProductType DeletedRecordResourceType = "product_type"
	// DeletedRecordResourceTypeProductionRun identifies deleted production_run records.
	DeletedRecordResourceTypeProductionRun DeletedRecordResourceType = "production_run"
	// DeletedRecordResourceTypeProductionStep identifies deleted production_step records.
	DeletedRecordResourceTypeProductionStep DeletedRecordResourceType = "production_step"
	// DeletedRecordResourceTypeProperty identifies deleted property records.
	DeletedRecordResourceTypeProperty DeletedRecordResourceType = "property"
	// DeletedRecordResourceTypePurchaseOrder identifies deleted purchase_order records.
	DeletedRecordResourceTypePurchaseOrder DeletedRecordResourceType = "purchase_order"
	// DeletedRecordResourceTypePurchaseOrderLine identifies deleted purchase_order_line records.
	DeletedRecordResourceTypePurchaseOrderLine DeletedRecordResourceType = "purchase_order_line"
	// DeletedRecordResourceTypeRegistrationFlow identifies deleted registration_flow records.
	DeletedRecordResourceTypeRegistrationFlow DeletedRecordResourceType = "registration_flow"
	// DeletedRecordResourceTypeRole identifies deleted role records.
	DeletedRecordResourceTypeRole DeletedRecordResourceType = "role"
	// DeletedRecordResourceTypeSalesOrder identifies deleted sales_order records.
	DeletedRecordResourceTypeSalesOrder DeletedRecordResourceType = "sales_order"
	// DeletedRecordResourceTypeSalesOrderLine identifies deleted sales_order_line records.
	DeletedRecordResourceTypeSalesOrderLine DeletedRecordResourceType = "sales_order_line"
	// DeletedRecordResourceTypeSandbox identifies deleted sandbox records.
	DeletedRecordResourceTypeSandbox DeletedRecordResourceType = "sandbox"
	// DeletedRecordResourceTypeScanningStation identifies deleted scanning_station records.
	DeletedRecordResourceTypeScanningStation DeletedRecordResourceType = "scanning_station"
	// DeletedRecordResourceTypeSettlement identifies deleted settlement records.
	DeletedRecordResourceTypeSettlement DeletedRecordResourceType = "settlement"
	// DeletedRecordResourceTypeShipment identifies deleted shipment records.
	DeletedRecordResourceTypeShipment DeletedRecordResourceType = "shipment"
	// DeletedRecordResourceTypeShipmentLine identifies deleted shipment_line records.
	DeletedRecordResourceTypeShipmentLine DeletedRecordResourceType = "shipment_line"
	// DeletedRecordResourceTypeShippingCase identifies deleted shipping_case records.
	DeletedRecordResourceTypeShippingCase DeletedRecordResourceType = "shipping_case"
	// DeletedRecordResourceTypeShippingTerm identifies deleted shipping_term records.
	DeletedRecordResourceTypeShippingTerm DeletedRecordResourceType = "shipping_term"
	// DeletedRecordResourceTypeLocation identifies deleted storage_location records.
	DeletedRecordResourceTypeLocation DeletedRecordResourceType = "storage_location"
	// DeletedRecordResourceTypeSupplier identifies deleted supplier records.
	DeletedRecordResourceTypeSupplier DeletedRecordResourceType = "supplier"
	// DeletedRecordResourceTypeSupplierMaterial identifies deleted supplier_material records.
	DeletedRecordResourceTypeSupplierMaterial DeletedRecordResourceType = "supplier_material"
	// DeletedRecordResourceTypeTerritory identifies deleted territory records.
	DeletedRecordResourceTypeTerritory DeletedRecordResourceType = "territory"
	// DeletedRecordResourceTypeTransaction identifies deleted transaction records.
	DeletedRecordResourceTypeTransaction DeletedRecordResourceType = "transaction"
	// DeletedRecordResourceTypeTransactionAllocation identifies deleted transaction_allocation records.
	DeletedRecordResourceTypeTransactionAllocation DeletedRecordResourceType = "transaction_allocation"
	// DeletedRecordResourceTypeUnit identifies deleted unit records.
	DeletedRecordResourceTypeUnit DeletedRecordResourceType = "unit"
	// DeletedRecordResourceTypeUnitGroup identifies deleted unit_group records.
	DeletedRecordResourceTypeUnitGroup DeletedRecordResourceType = "unit_group"
	// DeletedRecordResourceTypeUnitGroupUnit identifies deleted unit_group_unit records.
	DeletedRecordResourceTypeUnitGroupUnit DeletedRecordResourceType = "unit_group_unit"
	// DeletedRecordResourceTypeVolumeDiscount identifies deleted volume_discount records.
	DeletedRecordResourceTypeVolumeDiscount DeletedRecordResourceType = "volume_discount"
)

func (DeletedRecordResourceType) EnumValues

func (m DeletedRecordResourceType) EnumValues() []string

func (DeletedRecordResourceType) IsValid

func (m DeletedRecordResourceType) IsValid() bool

func (*DeletedRecordResourceType) StringPtr

func (m *DeletedRecordResourceType) StringPtr() *string

type DeliveryGranularity

type DeliveryGranularity string

DeliveryGranularity is the period delivery performance is bucketed into.

const (
	// DeliveryGranularityDay buckets by the day a commitment came due.
	DeliveryGranularityDay DeliveryGranularity = "day"
	// DeliveryGranularityWeek buckets by the week a commitment came due, starting Monday to match the production schedule.
	DeliveryGranularityWeek DeliveryGranularity = "week"
	// DeliveryGranularityMonth buckets by the month a commitment came due.
	DeliveryGranularityMonth DeliveryGranularity = "month"
)

func (DeliveryGranularity) EnumValues

func (m DeliveryGranularity) EnumValues() []string

func (DeliveryGranularity) IsValid

func (m DeliveryGranularity) IsValid() bool

func (*DeliveryGranularity) StringPtr

func (m *DeliveryGranularity) StringPtr() *string

type DeliveryListStatus

type DeliveryListStatus string

DeliveryListStatus filters a delivery list by status. It is deliberately not DeliveryStatus: it carries an `all` sentinel that is not a status a delivery can be in.

const (
	// DeliveryListStatusAll returns deliveries of every status.
	DeliveryListStatusAll DeliveryListStatus = "all"
	// DeliveryListStatusAccepted returns only deliveries that accepted goods into inventory.
	DeliveryListStatusAccepted DeliveryListStatus = "accepted"
	// DeliveryListStatusRejected returns only deliveries where nothing was accepted into inventory.
	DeliveryListStatusRejected DeliveryListStatus = "rejected"
)

func (DeliveryListStatus) EnumValues

func (s DeliveryListStatus) EnumValues() []string

func (DeliveryListStatus) IsValid

func (s DeliveryListStatus) IsValid() bool

func (*DeliveryListStatus) StringPtr

func (s *DeliveryListStatus) StringPtr() *string

type DeliveryStatus

type DeliveryStatus string

DeliveryStatus represents the status of a delivery.

const (
	// DeliveryStatusAccepted indicates the delivery has been accepted.
	DeliveryStatusAccepted DeliveryStatus = "accepted"
	// DeliveryStatusRejected indicates the delivery has been rejected.
	DeliveryStatusRejected DeliveryStatus = "rejected"
)

func (DeliveryStatus) EnumValues

func (m DeliveryStatus) EnumValues() []string

func (DeliveryStatus) IsValid

func (m DeliveryStatus) IsValid() bool

func (*DeliveryStatus) StringPtr

func (m *DeliveryStatus) StringPtr() *string

type DemandOverrideAdjustment

type DemandOverrideAdjustment string

DemandOverrideAdjustment is how an override's value changes the forecast. When several land on the same month they apply in declaration order.

const (
	// DemandOverrideAdjustmentAbsolute replaces the forecast for the period.
	DemandOverrideAdjustmentAbsolute DemandOverrideAdjustment = "absolute"
	// DemandOverrideAdjustmentDeltaUnits adds to the forecast.
	DemandOverrideAdjustmentDeltaUnits DemandOverrideAdjustment = "delta_units"
	// DemandOverrideAdjustmentDeltaPercent scales the forecast.
	DemandOverrideAdjustmentDeltaPercent DemandOverrideAdjustment = "delta_percent"
)

func (DemandOverrideAdjustment) EnumValues

func (a DemandOverrideAdjustment) EnumValues() []string

func (DemandOverrideAdjustment) IsValid

func (a DemandOverrideAdjustment) IsValid() bool

func (*DemandOverrideAdjustment) StringPtr

func (a *DemandOverrideAdjustment) StringPtr() *string

type DemandOverrideReason

type DemandOverrideReason string

DemandOverrideReason explains why the demand a plan is solved against was adjusted by hand.

const (
	// DemandOverrideReasonNewCustomer indicates demand from a customer with no order history.
	DemandOverrideReasonNewCustomer DemandOverrideReason = "new_customer"
	// DemandOverrideReasonLostAccount indicates demand that history contains but the future will not.
	DemandOverrideReasonLostAccount DemandOverrideReason = "lost_account"
	// DemandOverrideReasonPromotion indicates a planned campaign that history cannot predict.
	DemandOverrideReasonPromotion DemandOverrideReason = "promotion"
	// DemandOverrideReasonSeasonalShift indicates a season arriving earlier or later than usual.
	DemandOverrideReasonSeasonalShift DemandOverrideReason = "seasonal_shift"
	// DemandOverrideReasonNewProduct indicates an item with no history to forecast from.
	DemandOverrideReasonNewProduct DemandOverrideReason = "new_product"
	// DemandOverrideReasonDiscontinued indicates an item being wound down.
	DemandOverrideReasonDiscontinued DemandOverrideReason = "discontinued"
	// DemandOverrideReasonMarketIntelligence indicates knowledge of the market that the order book does not yet show.
	DemandOverrideReasonMarketIntelligence DemandOverrideReason = "market_intelligence"
	// DemandOverrideReasonOther indicates a reason outside the list, which should be explained in the note.
	DemandOverrideReasonOther DemandOverrideReason = "other"
)

func DemandOverrideReasonPtr

func DemandOverrideReasonPtr(value *string) *DemandOverrideReason

DemandOverrideReasonPtr converts a stored string into the typed reason, returning nil when there is nothing recorded.

func (DemandOverrideReason) EnumValues

func (r DemandOverrideReason) EnumValues() []string

func (DemandOverrideReason) IsValid

func (r DemandOverrideReason) IsValid() bool

func (*DemandOverrideReason) StringPtr

func (r *DemandOverrideReason) StringPtr() *string

type DemandOverrideScope

type DemandOverrideScope string

DemandOverrideScope is what an override targets.

const (
	// DemandOverrideScopeItem indicates the override targets a single item.
	DemandOverrideScopeItem DemandOverrideScope = "item"
	// DemandOverrideScopeProductLine indicates the override targets a product line, distributed across its items.
	DemandOverrideScopeProductLine DemandOverrideScope = "product_line"
	// DemandOverrideScopeAccount indicates the override applies to every planned item, e.g. scaling all demand for growth planning.
	DemandOverrideScopeAccount DemandOverrideScope = "account"
)

func (DemandOverrideScope) EnumValues

func (s DemandOverrideScope) EnumValues() []string

func (DemandOverrideScope) IsValid

func (s DemandOverrideScope) IsValid() bool

func (*DemandOverrideScope) StringPtr

func (s *DemandOverrideScope) StringPtr() *string

type DowntimePlanningStatus

type DowntimePlanningStatus string

DowntimePlanningStatus is whether a stoppage was scheduled in advance. Planned maintenance and an unplanned breakdown are read very differently, so the distinction is named rather than left as a bare flag.

const (
	// DowntimePlanningStatusPlanned indicates the stoppage was scheduled in advance.
	DowntimePlanningStatusPlanned DowntimePlanningStatus = "planned"
	// DowntimePlanningStatusUnplanned indicates the stoppage was not scheduled.
	DowntimePlanningStatusUnplanned DowntimePlanningStatus = "unplanned"
)

func DowntimePlanningStatusOf

func DowntimePlanningStatusOf(planned bool) DowntimePlanningStatus

DowntimePlanningStatusOf maps the stored flag onto the enum the API exposes.

func (DowntimePlanningStatus) EnumValues

func (s DowntimePlanningStatus) EnumValues() []string

func (DowntimePlanningStatus) IsValid

func (s DowntimePlanningStatus) IsValid() bool

func (*DowntimePlanningStatus) StringPtr

func (s *DowntimePlanningStatus) StringPtr() *string

type DowntimeStatus

type DowntimeStatus string

DowntimeStatus is whether a machine is still down.

const (
	// DowntimeStatusOpen indicates the machine is down right now.
	DowntimeStatusOpen DowntimeStatus = "open"
	// DowntimeStatusClosed indicates the machine is running again.
	DowntimeStatusClosed DowntimeStatus = "closed"
)

func (DowntimeStatus) EnumValues

func (s DowntimeStatus) EnumValues() []string

func (DowntimeStatus) IsValid

func (s DowntimeStatus) IsValid() bool

func (*DowntimeStatus) StringPtr

func (s *DowntimeStatus) StringPtr() *string

type DuplicateCheckType added in v1.1.6

type DuplicateCheckType string

DuplicateCheckType names which kind of record number a duplicate check looks at.

const (
	// DuplicateCheckTypeInvoiceNumber checks invoice numbers.
	DuplicateCheckTypeInvoiceNumber DuplicateCheckType = "invoice_number"
	// DuplicateCheckTypeOrderNumber checks sales order numbers.
	DuplicateCheckTypeOrderNumber DuplicateCheckType = "order_number"
	// DuplicateCheckTypeCustomerPONumber checks customer PO numbers on sales orders, scoped to a customer.
	DuplicateCheckTypeCustomerPONumber DuplicateCheckType = "customer_po_number"
)

func (DuplicateCheckType) EnumValues added in v1.1.6

func (t DuplicateCheckType) EnumValues() []string

func (DuplicateCheckType) IsValid added in v1.1.6

func (t DuplicateCheckType) IsValid() bool

func (*DuplicateCheckType) StringPtr added in v1.1.6

func (t *DuplicateCheckType) StringPtr() *string

type EDIStatus

type EDIStatus string

EDIStatus represents whether EDI is enabled for a customer.

const (
	// EDIStatusEnabled indicates EDI is enabled.
	EDIStatusEnabled EDIStatus = "enabled"
	// EDIStatusDisabled indicates EDI is disabled.
	EDIStatusDisabled EDIStatus = "disabled"
)

func (EDIStatus) EnumValues

func (m EDIStatus) EnumValues() []string

func (EDIStatus) IsValid

func (m EDIStatus) IsValid() bool

func (*EDIStatus) StringPtr

func (m *EDIStatus) StringPtr() *string

type Editability

type Editability string

Editability is whether the caller can edit a resource. It is an enum (not a boolean) so additional states (e.g. locked, restricted) can be added without a breaking change.

const (
	// EditabilityEditable means the caller can edit the resource.
	EditabilityEditable Editability = "editable"
	// EditabilityReadOnly means the caller cannot edit the resource.
	EditabilityReadOnly Editability = "read_only"
)

func EditabilityFromBool

func EditabilityFromBool(editable bool) Editability

EditabilityFromBool maps the persisted boolean to its editability enum.

func (Editability) EnumValues

func (s Editability) EnumValues() []string

func (Editability) IsValid

func (s Editability) IsValid() bool

func (*Editability) StringPtr

func (s *Editability) StringPtr() *string

type EmailDomainStatus added in v1.1.6

type EmailDomainStatus string

EmailDomainStatus is how far a customer-owned sending domain has gotten through DKIM verification.

const (
	// EmailDomainStatusPending means the DNS records have been issued but not yet verified.
	EmailDomainStatusPending EmailDomainStatus = "pending"
	// EmailDomainStatusVerified means the domain is verified and can send mail.
	EmailDomainStatusVerified EmailDomainStatus = "verified"
	// EmailDomainStatusFailed means verification did not complete.
	EmailDomainStatusFailed EmailDomainStatus = "failed"
)

func (EmailDomainStatus) EnumValues added in v1.1.6

func (s EmailDomainStatus) EnumValues() []string

func (EmailDomainStatus) IsValid added in v1.1.6

func (s EmailDomainStatus) IsValid() bool

func (*EmailDomainStatus) StringPtr added in v1.1.6

func (s *EmailDomainStatus) StringPtr() *string

type EmailInboxStatus added in v1.1.6

type EmailInboxStatus string

EmailInboxStatus is whether an email inbox accepts inbound mail.

const (
	// EmailInboxStatusActive threads inbound mail into a conversation.
	EmailInboxStatusActive EmailInboxStatus = "active"
	// EmailInboxStatusDisabled keeps the inbox provisioned and its history intact, but drops inbound mail without threading it.
	EmailInboxStatusDisabled EmailInboxStatus = "disabled"
)

func (EmailInboxStatus) EnumValues added in v1.1.6

func (s EmailInboxStatus) EnumValues() []string

func (EmailInboxStatus) IsValid added in v1.1.6

func (s EmailInboxStatus) IsValid() bool

func (*EmailInboxStatus) StringPtr added in v1.1.6

func (s *EmailInboxStatus) StringPtr() *string

type EmailRecordType

type EmailRecordType string

EmailRecordType represents the type of record to email to its configured recipients.

const (
	// EmailRecordTypeInvoice emails an invoice to the contacts on its sales order set to receive invoice emails.
	EmailRecordTypeInvoice EmailRecordType = "invoice"
	// EmailRecordTypeSalesOrder sends a sales order's acknowledgement to its acknowledgement recipients.
	EmailRecordTypeSalesOrder EmailRecordType = "sales_order"
	// EmailRecordTypePurchaseOrder sends a purchase order's submission to its submission recipients.
	EmailRecordTypePurchaseOrder EmailRecordType = "purchase_order"
)

func (EmailRecordType) EnumValues

func (t EmailRecordType) EnumValues() []string

func (EmailRecordType) IsValid

func (t EmailRecordType) IsValid() bool

func (*EmailRecordType) StringPtr

func (t *EmailRecordType) StringPtr() *string

type EmailSendStatus

type EmailSendStatus string

EmailSendStatus represents the delivery lifecycle status of an email.

const (
	// EmailSendStatusSent indicates the email was sent.
	EmailSendStatusSent EmailSendStatus = "sent"
	// EmailSendStatusPending indicates the email has not been sent yet.
	EmailSendStatusPending EmailSendStatus = "pending"
)

func (EmailSendStatus) EnumValues

func (m EmailSendStatus) EnumValues() []string

func (EmailSendStatus) IsValid

func (m EmailSendStatus) IsValid() bool

func (*EmailSendStatus) StringPtr

func (m *EmailSendStatus) StringPtr() *string

type EmailTemplate

type EmailTemplate string

EmailTemplate represents the type of email template to render.

const (
	// EmailTemplateWelcome indicates that the email template is for a welcome email.
	EmailTemplateWelcome EmailTemplate = "welcome"
	// EmailTemplatePasswordReset indicates that the email template is for a password reset email.
	EmailTemplatePasswordReset EmailTemplate = "password_reset"
	// EmailTemplatePasswordUpdated indicates that the email template is for a password updated email.
	EmailTemplatePasswordUpdated EmailTemplate = "password_updated"
	// EmailTemplateRegistrationVerify indicates that the email template is for a registration verify email.
	EmailTemplateRegistrationVerify EmailTemplate = "registration_verify"
	// EmailTemplateRegistrationVerifyExisting indicates that the email template is for a registration verify existing email.
	EmailTemplateRegistrationVerifyExisting EmailTemplate = "registration_verify_existing"
	// EmailTemplateEnterpriseRequest indicates that the email template is for a enterprise request email.
	EmailTemplateEnterpriseRequest EmailTemplate = "enterprise_request"
	// EmailTemplateInternalErrorAlert indicates that the email template is for a 5xx internal error alert.
	EmailTemplateInternalErrorAlert EmailTemplate = "internal_error_alert"
	// EmailTemplateNewRegistrationAlert indicates that the email template is for a new account registration alert.
	EmailTemplateNewRegistrationAlert EmailTemplate = "new_registration_alert"
	// EmailTemplatePlanChangeAlert indicates that the email template is for a plan change alert.
	EmailTemplatePlanChangeAlert EmailTemplate = "plan_change_alert"
	// EmailTemplateRegistrationLimitAlert indicates that the email template is for a registration limit reached alert.
	EmailTemplateRegistrationLimitAlert EmailTemplate = "registration_limit_alert"
	// EmailTemplateNewUserWelcome indicates that the email template is for a new user welcome email with a temporary password.
	EmailTemplateNewUserWelcome EmailTemplate = "new_user_welcome"
	// EmailTemplateOrderCheckout indicates that the email template is for an order checkout email.
	EmailTemplateOrderCheckout EmailTemplate = "order_checkout"
	// EmailTemplatePurchaseOrderSubmission indicates that the email template is for a purchase order submission email.
	EmailTemplatePurchaseOrderSubmission EmailTemplate = "purchase_order_submission"
	// EmailTemplateStatementOfAccount indicates that the email template is for a statement of account email.
	EmailTemplateStatementOfAccount EmailTemplate = "statement_of_account"
	// EmailTemplateInvoice indicates that the email template is for an invoice email.
	EmailTemplateInvoice EmailTemplate = "invoice"
	// EmailTemplateOrderAcknowledgement indicates that the email template is for an order acknowledgement email.
	EmailTemplateOrderAcknowledgement EmailTemplate = "order_acknowledgement"
	// EmailTemplateAlreadyRegistered indicates that the email template is for an already registered email with a magic login link.
	EmailTemplateAlreadyRegistered EmailTemplate = "already_registered"

	// EmailTemplateChatMessage notifies a user by email of a new chat message (the in-app/email bridge).
	EmailTemplateChatMessage EmailTemplate = "chat_message"
	// EmailTemplateMessageFailureAlert indicates that the email template is for the async message failure monitor digest (failed/stuck inbox and outbox rows).
	EmailTemplateMessageFailureAlert EmailTemplate = "message_failure_alert"
)

func (EmailTemplate) EnumValues

func (t EmailTemplate) EnumValues() []string

func (EmailTemplate) IsValid

func (t EmailTemplate) IsValid() bool

func (*EmailTemplate) StringPtr

func (t *EmailTemplate) StringPtr() *string

type FreightExemptionType added in v1.1.6

type FreightExemptionType string

FreightExemptionType names the special freight outcome applied to a set of rate options.

const (
	// FreightExemptionTypeFreightExempt means the order is exempt from freight, so no options are returned.
	FreightExemptionTypeFreightExempt FreightExemptionType = "freight_exempt"
	// FreightExemptionTypeMinimumOrderMet means the order cleared the shipping term's free-shipping minimum, so options are rated at zero.
	FreightExemptionTypeMinimumOrderMet FreightExemptionType = "minimum_order_met"
	// FreightExemptionTypeFlatRate means the shipping term's flat rate replaced every option's carrier rate.
	FreightExemptionTypeFlatRate FreightExemptionType = "flat_rate"
	// FreightExemptionTypeNone means standard carrier rates apply.
	FreightExemptionTypeNone FreightExemptionType = "none"
)

func (FreightExemptionType) EnumValues added in v1.1.6

func (t FreightExemptionType) EnumValues() []string

func (FreightExemptionType) IsValid added in v1.1.6

func (t FreightExemptionType) IsValid() bool

func (*FreightExemptionType) StringPtr added in v1.1.6

func (t *FreightExemptionType) StringPtr() *string

type FreightPolicy

type FreightPolicy string

FreightPolicy represents the freight status of an account group.

const (
	// FreightPolicyFree indicates no shipping cost to the buyer.
	FreightPolicyFree FreightPolicy = "free_freight"
	// FreightPolicyBilled indicates that freight is billed to the buyer.
	FreightPolicyBilled FreightPolicy = "billed_freight"
)

func FreightPolicyFromBool

func FreightPolicyFromBool(isExempt bool) FreightPolicy

FreightPolicyFromBool converts a boolean is_freight_exempt flag to a FreightPolicy.

func (FreightPolicy) EnumValues

func (m FreightPolicy) EnumValues() []string

func (FreightPolicy) IsValid

func (m FreightPolicy) IsValid() bool

func (*FreightPolicy) StringPtr

func (m *FreightPolicy) StringPtr() *string

func (FreightPolicy) ToBool

func (m FreightPolicy) ToBool() bool

ToBool converts a FreightPolicy to a boolean is_freight_exempt flag.

type FulfillmentPolicy

type FulfillmentPolicy string

FulfillmentPolicy is how a SKU is produced: to a forecast, or only against orders already placed.

const (
	// FulfillmentPolicyMakeToStock builds to the forecast and holds a safety stock against its variability.
	FulfillmentPolicyMakeToStock FulfillmentPolicy = "make_to_stock"
	// FulfillmentPolicyMakeToOrder contributes no forecast demand and holds no safety stock, so it is built only against the order book.
	FulfillmentPolicyMakeToOrder FulfillmentPolicy = "make_to_order"
)

func (FulfillmentPolicy) EnumValues

func (m FulfillmentPolicy) EnumValues() []string

func (FulfillmentPolicy) IsValid

func (m FulfillmentPolicy) IsValid() bool

func (*FulfillmentPolicy) StringPtr

func (m *FulfillmentPolicy) StringPtr() *string

type FulfillmentPolicySource

type FulfillmentPolicySource string

FulfillmentPolicySource names which rule in the chain decided a SKU's policy.

const (
	// FulfillmentPolicySourceItem is an explicit per-item override.
	FulfillmentPolicySourceItem FulfillmentPolicySource = "item"
	// FulfillmentPolicySourceProductLine is the default set on the item's product line.
	FulfillmentPolicySourceProductLine FulfillmentPolicySource = "product_line"
	// FulfillmentPolicySourceAccountDefault is the account-wide fallback.
	FulfillmentPolicySourceAccountDefault FulfillmentPolicySource = "account_default"
)

func (FulfillmentPolicySource) EnumValues

func (m FulfillmentPolicySource) EnumValues() []string

func (FulfillmentPolicySource) IsValid

func (m FulfillmentPolicySource) IsValid() bool

func (*FulfillmentPolicySource) StringPtr

func (m *FulfillmentPolicySource) StringPtr() *string

type FulfillmentRecommendationReason

type FulfillmentRecommendationReason string

FulfillmentRecommendationReason is the rule that decided how a SKU should be produced.

const (
	// FulfillmentRecommendationReasonLeadTimeInfeasible means customers are promised less time than production needs, so the stock has to exist before the order does.
	FulfillmentRecommendationReasonLeadTimeInfeasible FulfillmentRecommendationReason = "lead_time_infeasible"
	// FulfillmentRecommendationReasonNoRecentDemand means nothing has sold for long enough that a buffer is dead stock.
	FulfillmentRecommendationReasonNoRecentDemand FulfillmentRecommendationReason = "no_recent_demand"
	// FulfillmentRecommendationReasonSingleCustomer means effectively one customer buys it, and that customer is served to order.
	FulfillmentRecommendationReasonSingleCustomer FulfillmentRecommendationReason = "single_customer"
	// FulfillmentRecommendationReasonLumpyDemand means demand arrives rarely and in wildly different sizes.
	FulfillmentRecommendationReasonLumpyDemand FulfillmentRecommendationReason = "lumpy_demand"
	// FulfillmentRecommendationReasonSlowMovingHighValue means expensive units and few sold.
	FulfillmentRecommendationReasonSlowMovingHighValue FulfillmentRecommendationReason = "slow_moving_high_value"
	// FulfillmentRecommendationReasonSteadyDemand means demand is regular enough to forecast.
	FulfillmentRecommendationReasonSteadyDemand FulfillmentRecommendationReason = "steady_demand"
)

func (FulfillmentRecommendationReason) EnumValues

func (m FulfillmentRecommendationReason) EnumValues() []string

func (FulfillmentRecommendationReason) IsValid

func (*FulfillmentRecommendationReason) StringPtr

func (m *FulfillmentRecommendationReason) StringPtr() *string

type HTTPMethod

type HTTPMethod string

HTTPMethod represents an HTTP request method.

const (
	// HTTPMethodGet represents the GET method.
	HTTPMethodGet HTTPMethod = "GET"
	// HTTPMethodPost represents the POST method.
	HTTPMethodPost HTTPMethod = "POST"
	// HTTPMethodPut represents the PUT method.
	HTTPMethodPut HTTPMethod = "PUT"
	// HTTPMethodPatch represents the PATCH method.
	HTTPMethodPatch HTTPMethod = "PATCH"
	// HTTPMethodDelete represents the DELETE method.
	HTTPMethodDelete HTTPMethod = "DELETE"
	// HTTPMethodHead represents the HEAD method.
	HTTPMethodHead HTTPMethod = "HEAD"
	// HTTPMethodOptions represents the OPTIONS method.
	HTTPMethodOptions HTTPMethod = "OPTIONS"
)

func (HTTPMethod) EnumValues

func (m HTTPMethod) EnumValues() []string

func (HTTPMethod) IsValid

func (m HTTPMethod) IsValid() bool

func (*HTTPMethod) StringPtr

func (m *HTTPMethod) StringPtr() *string

type HubspotCompanyReviewAction

type HubspotCompanyReviewAction string

HubspotCompanyReviewAction represents a decision applied to a HubSpot company-match review.

const (
	// HubspotCompanyReviewActionLink matches the customer to an existing HubSpot company.
	HubspotCompanyReviewActionLink HubspotCompanyReviewAction = "link"
	// HubspotCompanyReviewActionCreateNew creates a new HubSpot company for the customer.
	HubspotCompanyReviewActionCreateNew HubspotCompanyReviewAction = "create_new"
	// HubspotCompanyReviewActionSkip leaves the customer and its orders out of the sync.
	HubspotCompanyReviewActionSkip HubspotCompanyReviewAction = "skip"
)

func (HubspotCompanyReviewAction) EnumValues

func (m HubspotCompanyReviewAction) EnumValues() []string

func (HubspotCompanyReviewAction) IsValid

func (m HubspotCompanyReviewAction) IsValid() bool

func (*HubspotCompanyReviewAction) StringPtr

func (m *HubspotCompanyReviewAction) StringPtr() *string

type HubspotCompanyReviewStatus

type HubspotCompanyReviewStatus string

HubspotCompanyReviewStatus represents the resolution state of a HubSpot company-match review.

const (
	// HubspotCompanyReviewStatusPending indicates the review is awaiting a human decision.
	HubspotCompanyReviewStatusPending HubspotCompanyReviewStatus = "pending"
	// HubspotCompanyReviewStatusResolved indicates the review was resolved (linked or marked create-new).
	HubspotCompanyReviewStatusResolved HubspotCompanyReviewStatus = "resolved"
	// HubspotCompanyReviewStatusSkipped indicates the customer was excluded from the sync.
	HubspotCompanyReviewStatusSkipped HubspotCompanyReviewStatus = "skipped"
)

func (HubspotCompanyReviewStatus) EnumValues

func (m HubspotCompanyReviewStatus) EnumValues() []string

func (HubspotCompanyReviewStatus) IsValid

func (m HubspotCompanyReviewStatus) IsValid() bool

func (*HubspotCompanyReviewStatus) StringPtr

func (m *HubspotCompanyReviewStatus) StringPtr() *string

type HubspotSyncJobStatus

type HubspotSyncJobStatus string

HubspotSyncJobStatus represents the lifecycle state of a HubSpot backfill sync job.

const (
	// HubspotSyncJobStatusPreviewing indicates the read-only matching pass is running.
	HubspotSyncJobStatusPreviewing HubspotSyncJobStatus = "previewing"
	// HubspotSyncJobStatusReviewPending indicates the job is awaiting review resolution and execute confirmation.
	HubspotSyncJobStatusReviewPending HubspotSyncJobStatus = "review_pending"
	// HubspotSyncJobStatusExecuting indicates the write phase is running.
	HubspotSyncJobStatusExecuting HubspotSyncJobStatus = "executing"
	// HubspotSyncJobStatusCompleted indicates the job finished successfully.
	HubspotSyncJobStatusCompleted HubspotSyncJobStatus = "completed"
	// HubspotSyncJobStatusFailed indicates the job stopped on an error and can be re-run.
	HubspotSyncJobStatusFailed HubspotSyncJobStatus = "failed"
)

func (HubspotSyncJobStatus) EnumValues

func (m HubspotSyncJobStatus) EnumValues() []string

func (HubspotSyncJobStatus) IsValid

func (m HubspotSyncJobStatus) IsValid() bool

func (*HubspotSyncJobStatus) StringPtr

func (m *HubspotSyncJobStatus) StringPtr() *string

type HubspotSyncRecordAugnoType

type HubspotSyncRecordAugnoType string

HubspotSyncRecordAugnoType is the kind of OpenMRP record a sync record maps from.

const (
	// HubspotSyncRecordAugnoTypeCustomer maps an OpenMRP customer to a HubSpot company.
	HubspotSyncRecordAugnoTypeCustomer HubspotSyncRecordAugnoType = "customer"
	// HubspotSyncRecordAugnoTypeContact maps an OpenMRP customer's billing contact to a HubSpot contact.
	HubspotSyncRecordAugnoTypeContact HubspotSyncRecordAugnoType = "contact"
	// HubspotSyncRecordAugnoTypeDeal maps an OpenMRP sales order to a HubSpot deal.
	HubspotSyncRecordAugnoTypeDeal HubspotSyncRecordAugnoType = "deal"
)

func (HubspotSyncRecordAugnoType) EnumValues

func (m HubspotSyncRecordAugnoType) EnumValues() []string

func (HubspotSyncRecordAugnoType) IsValid

func (m HubspotSyncRecordAugnoType) IsValid() bool

func (*HubspotSyncRecordAugnoType) StringPtr

func (m *HubspotSyncRecordAugnoType) StringPtr() *string

type HubspotSyncRecordHubspotType

type HubspotSyncRecordHubspotType string

HubspotSyncRecordHubspotType is the HubSpot CRM object a sync record maps to. The values are HubSpot's own object-type names, which is what its API and URLs use.

const (
	HubspotSyncRecordHubspotTypeCompanies HubspotSyncRecordHubspotType = "companies"
	HubspotSyncRecordHubspotTypeContacts  HubspotSyncRecordHubspotType = "contacts"
	HubspotSyncRecordHubspotTypeDeals     HubspotSyncRecordHubspotType = "deals"
)

func (HubspotSyncRecordHubspotType) EnumValues

func (m HubspotSyncRecordHubspotType) EnumValues() []string

func (HubspotSyncRecordHubspotType) IsValid

func (m HubspotSyncRecordHubspotType) IsValid() bool

func (*HubspotSyncRecordHubspotType) StringPtr

func (m *HubspotSyncRecordHubspotType) StringPtr() *string

type IntegrationCode

type IntegrationCode string

IntegrationCode identifies a third-party integration provider.

const (
	// IntegrationCodeStripe identifies the Stripe payment integration.
	IntegrationCodeStripe IntegrationCode = "stripe"
	// IntegrationCodeShippo identifies the Shippo shipping integration.
	IntegrationCodeShippo IntegrationCode = "shippo"
	// IntegrationCodeHubspot identifies the HubSpot CRM integration.
	IntegrationCodeHubspot IntegrationCode = "hubspot"
)

func (IntegrationCode) EnumValues

func (m IntegrationCode) EnumValues() []string

func (IntegrationCode) IsValid

func (m IntegrationCode) IsValid() bool

func (*IntegrationCode) StringPtr

func (m *IntegrationCode) StringPtr() *string

type InventoryActionType

type InventoryActionType string

InventoryActionType represents the type of action that caused an inventory change.

const (
	// InventoryActionTypeScan indicates a scan-based inventory change (e.g. production step).
	InventoryActionTypeScan InventoryActionType = "scan"
	// InventoryActionTypeUserAction indicates a manual user-initiated inventory change.
	InventoryActionTypeUserAction InventoryActionType = "user_action"
	// InventoryActionTypeSystemAction indicates a system-initiated inventory change.
	InventoryActionTypeSystemAction InventoryActionType = "system_action"
	// InventoryActionTypeUserCorrection indicates a user-initiated inventory correction.
	InventoryActionTypeUserCorrection InventoryActionType = "user_correction"
)

func (InventoryActionType) EnumValues

func (m InventoryActionType) EnumValues() []string

func (InventoryActionType) IsValid

func (m InventoryActionType) IsValid() bool

func (*InventoryActionType) StringPtr

func (m *InventoryActionType) StringPtr() *string

type InventoryUpdateOperation

type InventoryUpdateOperation string

InventoryUpdateOperation controls how quantity_change is applied when updating item inventory.

const (
	// InventoryUpdateOperationAdjust adds quantity_change to the current inventory.
	InventoryUpdateOperationAdjust InventoryUpdateOperation = "adjust"
	// InventoryUpdateOperationReconcile sets inventory to the exact value given by quantity_change.
	InventoryUpdateOperationReconcile InventoryUpdateOperation = "reconcile"
)

func (InventoryUpdateOperation) EnumValues

func (o InventoryUpdateOperation) EnumValues() []string

func (InventoryUpdateOperation) IsValid

func (o InventoryUpdateOperation) IsValid() bool

func (*InventoryUpdateOperation) StringPtr

func (o *InventoryUpdateOperation) StringPtr() *string

type InvoiceListStatus

type InvoiceListStatus string

InvoiceListStatus filters an invoice list by payment state. It is deliberately not InvoicePaymentStatus: it carries an `all` sentinel that is not a state an invoice can be in, and it buckets partially-paid invoices under `unpaid` rather than exposing them separately.

const (
	// InvoiceListStatusAll applies no payment-state filtering, the same as omitting the parameter.
	InvoiceListStatusAll InvoiceListStatus = "all"
	// InvoiceListStatusPaid returns only invoices marked paid in full.
	InvoiceListStatusPaid InvoiceListStatus = "paid"
	// InvoiceListStatusUnpaid returns only invoices that are neither paid in full nor overpaid, including invoices carrying partial payments.
	InvoiceListStatusUnpaid InvoiceListStatus = "unpaid"
	// InvoiceListStatusOverpaid returns only invoices whose applied payments exceed the invoiced amount.
	InvoiceListStatusOverpaid InvoiceListStatus = "overpaid"
)

func (InvoiceListStatus) EnumValues

func (s InvoiceListStatus) EnumValues() []string

func (InvoiceListStatus) IsValid

func (s InvoiceListStatus) IsValid() bool

func (*InvoiceListStatus) StringPtr

func (s *InvoiceListStatus) StringPtr() *string

type InvoicePaymentStatus

type InvoicePaymentStatus string

InvoicePaymentStatus represents the payment state of an invoice. Modeled as an enum (rather than separate is_paid_in_full / is_over_paid booleans) so new states can be added later without a breaking change.

const (
	// InvoicePaymentStatusUnpaid indicates no payment has been received.
	InvoicePaymentStatusUnpaid InvoicePaymentStatus = "unpaid"
	// InvoicePaymentStatusPartiallyPaid indicates the invoice is partially paid.
	InvoicePaymentStatusPartiallyPaid InvoicePaymentStatus = "partially_paid"
	// InvoicePaymentStatusPaid indicates the invoice is paid in full.
	InvoicePaymentStatusPaid InvoicePaymentStatus = "paid"
	// InvoicePaymentStatusOverpaid indicates the invoice has been overpaid.
	InvoicePaymentStatusOverpaid InvoicePaymentStatus = "overpaid"
)

func (InvoicePaymentStatus) EnumValues

func (m InvoicePaymentStatus) EnumValues() []string

func (InvoicePaymentStatus) IsValid

func (m InvoicePaymentStatus) IsValid() bool

func (*InvoicePaymentStatus) StringPtr

func (m *InvoicePaymentStatus) StringPtr() *string

type ItemCategoryType

type ItemCategoryType string

ItemCategoryType represents the kind of item category.

const (
	// ItemCategoryTypeMaterial represents a category for raw materials or components.
	ItemCategoryTypeMaterial ItemCategoryType = "material_category"
	// ItemCategoryTypeProduct represents a category for finished products.
	ItemCategoryTypeProduct ItemCategoryType = "product_category"
)

func (ItemCategoryType) EnumValues

func (m ItemCategoryType) EnumValues() []string

func (ItemCategoryType) IsValid

func (m ItemCategoryType) IsValid() bool

func (*ItemCategoryType) StringPtr

func (m *ItemCategoryType) StringPtr() *string

type ItemLotSource

type ItemLotSource string

ItemLotSource names which rule in the precedence chain produced an item's lot.

The chain is ordered most specific first, and the source is reported alongside the lot so a planner can see why a SKU is being made in sixties rather than having to work it out from four places it might have come from.

const (
	// ItemLotSourceItemOverride indicates a lot size set on the item itself.
	ItemLotSourceItemOverride ItemLotSource = "item_override"
	// ItemLotSourceProductLine indicates the convention of the line the item sells under.
	ItemLotSourceProductLine ItemLotSource = "product_line"
	// ItemLotSourceDownstreamProductLine indicates a lot inherited from the finished goods an intermediate item becomes.
	ItemLotSourceDownstreamProductLine ItemLotSource = "downstream_product_line"
	// ItemLotSourceAccountDefault indicates the account-wide fallback lot size.
	ItemLotSourceAccountDefault ItemLotSource = "account_default"
	// ItemLotSourceNone indicates no rule supplied a lot.
	ItemLotSourceNone ItemLotSource = ""
)

func (ItemLotSource) EnumValues

func (ItemLotSource) EnumValues() []string

func (ItemLotSource) IsValid

func (s ItemLotSource) IsValid() bool

func (*ItemLotSource) StringPtr

func (s *ItemLotSource) StringPtr() *string

type ItemReconcileType added in v1.1.6

type ItemReconcileType string

ItemReconcileType is how a bulk reconcile applies each quantity to the item's current quantity.

const (
	// ItemReconcileTypeAddition adds the quantity to the item's current quantity.
	ItemReconcileTypeAddition ItemReconcileType = "addition"
	// ItemReconcileTypeForce sets the item's current quantity to exactly the given quantity.
	ItemReconcileTypeForce ItemReconcileType = "force"
)

func (ItemReconcileType) EnumValues added in v1.1.6

func (t ItemReconcileType) EnumValues() []string

func (ItemReconcileType) IsValid added in v1.1.6

func (t ItemReconcileType) IsValid() bool

func (*ItemReconcileType) StringPtr added in v1.1.6

func (t *ItemReconcileType) StringPtr() *string

type ItemTrendType

type ItemTrendType string

ItemTrendType represents a time-series trend that can be fetched for an item.

const (
	// ItemTrendTypeInventory returns 30 days of inventory-log measurements.
	ItemTrendTypeInventory ItemTrendType = "inventory"
)

func (ItemTrendType) EnumValues

func (m ItemTrendType) EnumValues() []string

func (ItemTrendType) IsValid

func (m ItemTrendType) IsValid() bool

type ItemTypeCode

type ItemTypeCode string

ItemTypeCode represents the type of an item.

const (
	// ItemTypeCodeProduct represents a finished product.
	ItemTypeCodeProduct ItemTypeCode = "product"
	// ItemTypeCodeMaterial represents a raw material or component.
	ItemTypeCodeMaterial ItemTypeCode = "material"
	// ItemTypeCodePart represents a part used in production.
	ItemTypeCodePart ItemTypeCode = "part"
)

func (ItemTypeCode) EnumValues

func (m ItemTypeCode) EnumValues() []string

func (ItemTypeCode) IsValid

func (m ItemTypeCode) IsValid() bool

func (*ItemTypeCode) StringPtr

func (m *ItemTypeCode) StringPtr() *string

type JobResultStatus

type JobResultStatus string

JobResultStatus is what became of one row of a bulk request: it created a resource, updated an existing one, or failed.

const (
	// JobResultStatusCreated indicates the row produced a newly created resource.
	JobResultStatusCreated JobResultStatus = "created"
	// JobResultStatusUpdated indicates the row updated an existing resource.
	JobResultStatusUpdated JobResultStatus = "updated"
	// JobResultStatusFailed indicates the row was rejected and wrote nothing.
	JobResultStatusFailed JobResultStatus = "failed"
)

func (JobResultStatus) EnumValues

func (a JobResultStatus) EnumValues() []string

func (JobResultStatus) IsValid

func (a JobResultStatus) IsValid() bool

func (*JobResultStatus) StringPtr

func (a *JobResultStatus) StringPtr() *string

type JobStatus

type JobStatus string

JobStatus represents the execution status of a message queued async job.

const (
	// JobStatusCreated indicates the job is queued but not yet started.
	JobStatusCreated JobStatus = "created"
	// JobStatusStarted indicates the job is currently executing.
	JobStatusStarted JobStatus = "started"
	// JobStatusCompleted indicates the job completed successfully.
	JobStatusCompleted JobStatus = "completed"
	// JobStatusFailed indicates the job failed.
	JobStatusFailed JobStatus = "failed"
	// JobStatusCancelled indicates the job has been cancelled.
	JobStatusCancelled JobStatus = "cancelled"
)

func (JobStatus) EnumValues

func (m JobStatus) EnumValues() []string

func (JobStatus) IsValid

func (m JobStatus) IsValid() bool

func (*JobStatus) StringPtr

func (m *JobStatus) StringPtr() *string

type JobType

type JobType string

JobType represents the execution type of a message queued async job.

const (
	// JobTypeBulkCreate indicates the job is a bulk creation of an object.
	JobTypeBulkCreate JobType = "bulk_create"
	// JobTypeBulkUpsert indicates the job is a bulk upsert of an object.
	JobTypeBulkUpsert JobType = "bulk_upsert"
	// JobTypeExport indicates the job renders a resource as a downloadable file.
	JobTypeExport JobType = "export"
	// Packs a pick into a new shipment with its lines and cases.
	JobTypePackPick JobType = "pack_pick"
)

func (JobType) EnumValues

func (m JobType) EnumValues() []string

func (JobType) IsValid

func (m JobType) IsValid() bool

func (*JobType) StringPtr

func (m *JobType) StringPtr() *string

type LabelSizeCode

type LabelSizeCode string

LabelSizeCode identifies a label size for a scanning station.

const (
	// LabelSizeCodeOneByOne indicates a 1x1 label.
	LabelSizeCodeOneByOne LabelSizeCode = "1x1"
	// LabelSizeCodeOneByThree indicates a 1x3 label.
	LabelSizeCodeOneByThree LabelSizeCode = "1x3"
	// LabelSizeCodeOneByFour indicates a 1x4 label.
	LabelSizeCodeOneByFour LabelSizeCode = "1x4"
	// LabelSizeCodeTwoByFour indicates a 2x4 label.
	LabelSizeCodeTwoByFour LabelSizeCode = "2x4"
)

func (LabelSizeCode) EnumValues

func (c LabelSizeCode) EnumValues() []string

func (LabelSizeCode) IsValid

func (c LabelSizeCode) IsValid() bool

func (*LabelSizeCode) StringPtr

func (c *LabelSizeCode) StringPtr() *string

type LabelTypeCode

type LabelTypeCode string

LabelTypeCode identifies a label type for a scanning station.

const (
	// LabelTypeCodeTag indicates a tag label.
	LabelTypeCodeTag LabelTypeCode = "tag"
	// LabelTypeCodeTraveler indicates a traveler label.
	LabelTypeCodeTraveler LabelTypeCode = "traveler"
)

func (LabelTypeCode) EnumValues

func (c LabelTypeCode) EnumValues() []string

func (LabelTypeCode) IsValid

func (c LabelTypeCode) IsValid() bool

func (*LabelTypeCode) StringPtr

func (c *LabelTypeCode) StringPtr() *string

type LeadTimeSource

type LeadTimeSource string

LeadTimeSource names which rule produced an order's ship-by commitment. Stored on the order alongside the date so the commitment can always explain itself, rather than requiring the settings to be reconstructed as they stood when the order was issued.

const (
	// LeadTimeSourceCustomer is the customer's own default lead time.
	LeadTimeSourceCustomer LeadTimeSource = "customer"
	// LeadTimeSourceParentCustomer is the lead time inherited from the customer's parent account.
	LeadTimeSourceParentCustomer LeadTimeSource = "parent_customer"
	// LeadTimeSourceAccountGroup is the lead time inherited from the customer's account group.
	LeadTimeSourceAccountGroup LeadTimeSource = "account_group"
	// LeadTimeSourceAccount is the account-wide default, the last fallback in the chain.
	LeadTimeSourceAccount LeadTimeSource = "account"
	// LeadTimeSourceManual is an explicitly promised delivery date, which overrides every rule. Named before the other two per-order bases existed; it means the promised date specifically, not "somebody set this by hand".
	LeadTimeSourceManual LeadTimeSource = "manual"
	// LeadTimeSourceOrderLeadTime is a lead time set on one order, replacing the standing customer chain.
	LeadTimeSourceOrderLeadTime LeadTimeSource = "order_lead_time"
	// LeadTimeSourceOrderShipBy is a ship date pinned on one order, bypassing transit and the receiving calendar.
	LeadTimeSourceOrderShipBy LeadTimeSource = "order_ship_by"
)

func (LeadTimeSource) EnumValues

func (m LeadTimeSource) EnumValues() []string

func (LeadTimeSource) IsValid

func (m LeadTimeSource) IsValid() bool

func (*LeadTimeSource) StringPtr

func (m *LeadTimeSource) StringPtr() *string

type LegalHoldStatus

type LegalHoldStatus string

LegalHoldStatus is whether a conversation is under legal hold, which exempts it from automatic retention purging and from GDPR redaction until the hold is released. It is an enum (not a boolean) so additional states (e.g. pending-review) can be added without a breaking change.

const (
	// LegalHoldStatusReleased means the conversation is not under legal hold (the default).
	LegalHoldStatusReleased LegalHoldStatus = "released"
	// LegalHoldStatusHeld means the conversation is under legal hold and exempt from purge/redaction.
	LegalHoldStatusHeld LegalHoldStatus = "held"
)

func LegalHoldStatusFromHeld

func LegalHoldStatusFromHeld(held bool) LegalHoldStatus

LegalHoldStatusFromHeld maps the persisted boolean to its legal-hold-status enum.

func (LegalHoldStatus) EnumValues

func (s LegalHoldStatus) EnumValues() []string

func (LegalHoldStatus) IsValid

func (s LegalHoldStatus) IsValid() bool

func (*LegalHoldStatus) StringPtr

func (s *LegalHoldStatus) StringPtr() *string

type LocationTypeCode

type LocationTypeCode string

LocationTypeCode represents the type of a location.

const (
	// LocationTypeCodeBuilding indicates a building-level location.
	LocationTypeCodeBuilding LocationTypeCode = "building"
	// LocationTypeCodeSection indicates a section within a building.
	LocationTypeCodeSection LocationTypeCode = "section"
	// LocationTypeCodeAisle indicates an aisle within a section.
	LocationTypeCodeAisle LocationTypeCode = "aisle"
	// LocationTypeCodeRack indicates a rack within an aisle.
	LocationTypeCodeRack LocationTypeCode = "rack"
	// LocationTypeCodeShelf indicates a shelf within a rack.
	LocationTypeCodeShelf LocationTypeCode = "shelf"
	// LocationTypeCodeBin indicates a bin within a shelf.
	LocationTypeCodeBin LocationTypeCode = "bin"
)

func (LocationTypeCode) EnumValues

func (s LocationTypeCode) EnumValues() []string

func (LocationTypeCode) IsValid

func (s LocationTypeCode) IsValid() bool

func (*LocationTypeCode) StringPtr

func (s *LocationTypeCode) StringPtr() *string

type MachineDowntimeReasonCode

type MachineDowntimeReasonCode string

MachineDowntimeReasonCode identifies why a machine stopped.

The set matches the seeded `machine_downtime_reason` taxonomy, whose rows carry the OEE bucket each reason charges. Merchant-defined reasons are a later phase; when they land this stops being a closed set.

const (
	// MachineDowntimeReasonCodeBreakdown indicates an unplanned mechanical or electrical failure.
	MachineDowntimeReasonCodeBreakdown MachineDowntimeReasonCode = "breakdown"
	// MachineDowntimeReasonCodeChangeover indicates a yarn or style change.
	MachineDowntimeReasonCodeChangeover MachineDowntimeReasonCode = "changeover"
	// MachineDowntimeReasonCodeMaterialShortage indicates the machine had nothing to run.
	MachineDowntimeReasonCodeMaterialShortage MachineDowntimeReasonCode = "material_shortage"
	// MachineDowntimeReasonCodeNoOperator indicates the machine was staffed by nobody.
	MachineDowntimeReasonCodeNoOperator MachineDowntimeReasonCode = "no_operator"
	// MachineDowntimeReasonCodePlannedMaintenance indicates preventive maintenance scheduled in advance.
	MachineDowntimeReasonCodePlannedMaintenance MachineDowntimeReasonCode = "planned_maintenance"
	// MachineDowntimeReasonCodeMinorStop indicates a short stoppage that costs speed rather than availability.
	MachineDowntimeReasonCodeMinorStop MachineDowntimeReasonCode = "minor_stop"
	// MachineDowntimeReasonCodeQualityHold indicates the machine was stopped over a quality problem.
	MachineDowntimeReasonCodeQualityHold MachineDowntimeReasonCode = "quality_hold"
	// MachineDowntimeReasonCodeNoSchedule indicates time the machine was never planned to run, which is removed from the OEE calculation rather than counted against it.
	MachineDowntimeReasonCodeNoSchedule MachineDowntimeReasonCode = "no_schedule"
)

func (MachineDowntimeReasonCode) EnumValues

func (r MachineDowntimeReasonCode) EnumValues() []string

func (MachineDowntimeReasonCode) IsValid

func (r MachineDowntimeReasonCode) IsValid() bool

func (*MachineDowntimeReasonCode) StringPtr

func (r *MachineDowntimeReasonCode) StringPtr() *string

type MachineDowntimeSource

type MachineDowntimeSource string

MachineDowntimeSource records how a stoppage came to be recorded.

const (
	// MachineDowntimeSourceManual indicates a person logged the stoppage.
	MachineDowntimeSourceManual MachineDowntimeSource = "manual"
	// MachineDowntimeSourceScanner indicates a shop-floor station logged the stoppage.
	MachineDowntimeSourceScanner MachineDowntimeSource = "scanner"
	// MachineDowntimeSourceInferred indicates the system derived the stoppage from a gap in activity.
	MachineDowntimeSourceInferred MachineDowntimeSource = "inferred"
	// MachineDowntimeSourceAPI indicates an integration reported the stoppage.
	MachineDowntimeSourceAPI MachineDowntimeSource = "api"
)

func (MachineDowntimeSource) EnumValues

func (s MachineDowntimeSource) EnumValues() []string

func (MachineDowntimeSource) IsValid

func (s MachineDowntimeSource) IsValid() bool

func (*MachineDowntimeSource) StringPtr

func (s *MachineDowntimeSource) StringPtr() *string

type MachineWorkStatus

type MachineWorkStatus string

MachineWorkStatus is what a machine is doing right now.

const (
	// MachineWorkStatusRunning indicates a released campaign with work still to scan.
	MachineWorkStatusRunning MachineWorkStatus = "running"
	// MachineWorkStatusIdle indicates nothing is released to the machine.
	MachineWorkStatusIdle MachineWorkStatus = "idle"
	// MachineWorkStatusDown indicates an open downtime event, which outranks running: a broken machine is not producing whatever the plan says.
	MachineWorkStatusDown MachineWorkStatus = "down"
)

func (MachineWorkStatus) EnumValues

func (MachineWorkStatus) EnumValues() []string

func (MachineWorkStatus) IsValid

func (s MachineWorkStatus) IsValid() bool

func (*MachineWorkStatus) StringPtr

func (s *MachineWorkStatus) StringPtr() *string

type MeasureOwnerType added in v1.1.6

type MeasureOwnerType string

MeasureOwnerType names the kind of resource a rate or quantity is attached to.

const (
	// MeasureOwnerTypeItem attaches the measure to an item.
	MeasureOwnerTypeItem MeasureOwnerType = "item"
	// MeasureOwnerTypeProductionStep attaches the measure to a production step.
	MeasureOwnerTypeProductionStep MeasureOwnerType = "production_step"
	// MeasureOwnerTypeDepartment attaches the measure to a department.
	MeasureOwnerTypeDepartment MeasureOwnerType = "department"
)

func (MeasureOwnerType) EnumValues added in v1.1.6

func (t MeasureOwnerType) EnumValues() []string

func (MeasureOwnerType) IsValid added in v1.1.6

func (t MeasureOwnerType) IsValid() bool

func (*MeasureOwnerType) StringPtr added in v1.1.6

func (t *MeasureOwnerType) StringPtr() *string

type MessageAttachmentKind

type MessageAttachmentKind string

MessageAttachmentKind classifies a message attachment. It is an enum so new kinds can be added without a breaking change to the API.

const (
	// MessageAttachmentKindFile is an uploaded non-image file (stored in the chat bucket).
	MessageAttachmentKindFile MessageAttachmentKind = "file"
	// MessageAttachmentKindImage is an uploaded image (stored in the chat bucket).
	MessageAttachmentKindImage MessageAttachmentKind = "image"
	// MessageAttachmentKindLink is an external URL reference (no stored object).
	MessageAttachmentKindLink MessageAttachmentKind = "link"
	// MessageAttachmentKindResource is a typed in-app resource reference (e.g. an order).
	MessageAttachmentKindResource MessageAttachmentKind = "resource"
)

func UploadedAttachmentKindForContentType

func UploadedAttachmentKindForContentType(contentType string) MessageAttachmentKind

UploadedAttachmentKindForContentType picks file vs image for a staged upload from its MIME type.

func (MessageAttachmentKind) EnumValues

func (k MessageAttachmentKind) EnumValues() []string

func (MessageAttachmentKind) IsUploaded

func (k MessageAttachmentKind) IsUploaded() bool

IsUploaded reports whether the kind is backed by a stored object in the chat bucket.

func (MessageAttachmentKind) IsValid

func (k MessageAttachmentKind) IsValid() bool

func (*MessageAttachmentKind) StringPtr

func (k *MessageAttachmentKind) StringPtr() *string

type MessageChannel

type MessageChannel string

MessageChannel is how a message was delivered (or, for a draft, how it will be delivered on approve): an in-conversation chat message or email via the bridged inbox.

const (
	// MessageChannelMessage delivers as an in-conversation chat message (the customer portal timeline for external cases).
	MessageChannelMessage MessageChannel = "message"
	// MessageChannelEmail delivers as email through the conversation's bridged inbox.
	MessageChannelEmail MessageChannel = "email"
)

func ResolveMessageChannel

func ResolveMessageChannel(stored *string, kind string) MessageChannel

ResolveMessageChannel normalizes a stored channel value (including legacy "portal") and infers email from kind when absent.

func (MessageChannel) EnumValues

func (c MessageChannel) EnumValues() []string

func (MessageChannel) IsValid

func (c MessageChannel) IsValid() bool

func (*MessageChannel) StringPtr

func (c *MessageChannel) StringPtr() *string

type MessageKind

type MessageKind string

MessageKind classifies what a message row represents.

const (
	// MessageKindChat is a user-authored chat message.
	MessageKindChat MessageKind = "chat"
	// MessageKindSystemEvent is a system-generated event message.
	MessageKindSystemEvent MessageKind = "system_event"
	// MessageKindAgent is a message authored by an AI agent participant.
	MessageKindAgent MessageKind = "agent"
	// MessageKindScheduled is a message materialized from a scheduled send.
	MessageKindScheduled MessageKind = "scheduled"
	// MessageKindAlert is a system/producer alert rendered as a message.
	MessageKindAlert MessageKind = "alert"
	// MessageKindEmail is an inbound email materialized into a conversation by the email bridge.
	MessageKindEmail MessageKind = "email"
)

func (MessageKind) EnumValues

func (k MessageKind) EnumValues() []string

func (MessageKind) IsValid

func (k MessageKind) IsValid() bool

func (*MessageKind) StringPtr

func (k *MessageKind) StringPtr() *string

type MessageSendMode

type MessageSendMode string

MessageSendMode is whether a create-message request is delivered immediately (or scheduled) or held as a customer-reply draft awaiting human approval.

const (
	// MessageSendModeSend delivers the message (immediately, or at scheduled_at).
	MessageSendModeSend MessageSendMode = "send"
	// MessageSendModeDraft creates a status-draft customer-reply proposal, held for approval rather than sent.
	MessageSendModeDraft MessageSendMode = "draft"
)

func (MessageSendMode) EnumValues

func (m MessageSendMode) EnumValues() []string

func (MessageSendMode) IsValid

func (m MessageSendMode) IsValid() bool

func (*MessageSendMode) StringPtr

func (m *MessageSendMode) StringPtr() *string

type MessageStatus

type MessageStatus string

MessageStatus is the lifecycle state of a message. A message is the single resource for sent, scheduled, and draft content. Only Sent messages occupy the conversation timeline (and carry a sequence); Draft and Scheduled are unsent rows promoted to Sent in place. The remaining states are terminal. It is an enum so new states can be added without a breaking change to the API.

const (
	// MessageStatusDraft is an editable customer-reply draft awaiting approval (not in the timeline).
	MessageStatusDraft MessageStatus = "draft"
	// MessageStatusScheduled is queued for delivery at a future time (not yet in the timeline).
	MessageStatusScheduled MessageStatus = "scheduled"
	// MessageStatusSent is a delivered timeline message (has a sequence).
	MessageStatusSent MessageStatus = "sent"
	// MessageStatusCanceled is a scheduled message canceled before delivery (terminal).
	MessageStatusCanceled MessageStatus = "canceled"
	// MessageStatusRejected is a draft discarded without sending (terminal).
	MessageStatusRejected MessageStatus = "rejected"
	// MessageStatusFailed is a scheduled message that exhausted delivery attempts (terminal).
	MessageStatusFailed MessageStatus = "failed"
	// MessageStatusSuperseded is a draft replaced by a newer one for the same source thread (terminal).
	MessageStatusSuperseded MessageStatus = "superseded"
)

func (MessageStatus) EnumValues

func (s MessageStatus) EnumValues() []string

func (MessageStatus) IsValid

func (s MessageStatus) IsValid() bool

func (*MessageStatus) StringPtr

func (s *MessageStatus) StringPtr() *string

type MessageStreamingState added in v1.1.6

type MessageStreamingState string

MessageStreamingState is whether an agent reply's body is still being generated.

const (
	// MessageStreamingStateStreaming means the body keeps growing as realtime updates arrive.
	MessageStreamingStateStreaming MessageStreamingState = "streaming"
	// MessageStreamingStateComplete means the body is final.
	MessageStreamingStateComplete MessageStreamingState = "complete"
)

func (MessageStreamingState) EnumValues added in v1.1.6

func (s MessageStreamingState) EnumValues() []string

func (MessageStreamingState) IsValid added in v1.1.6

func (s MessageStreamingState) IsValid() bool

func (*MessageStreamingState) StringPtr added in v1.1.6

func (s *MessageStreamingState) StringPtr() *string

type MessageVisibility

type MessageVisibility string

MessageVisibility is the audience of a single message inside a conversation. It is the central safety primitive for external (audience=customer) conversations: an internal note is never serialized into a customer payload, while an external message is part of the official customer communication history. Internal conversations force Internal. System is for events visible to both parties (linked-record added, draft generated, status changed).

const (
	// MessageVisibilityInternal is a team-only message (internal note / private discussion).
	MessageVisibilityInternal MessageVisibility = "internal"
	// MessageVisibilityExternal is a message sent to or received from an external party (e.g. the customer on a support case).
	MessageVisibilityExternal MessageVisibility = "external"
	// MessageVisibilitySystem is a system/event message shown to both the team and the customer.
	MessageVisibilitySystem MessageVisibility = "system"
)

func (MessageVisibility) EnumValues

func (v MessageVisibility) EnumValues() []string

func (MessageVisibility) IsValid

func (v MessageVisibility) IsValid() bool

func (*MessageVisibility) StringPtr

func (v *MessageVisibility) StringPtr() *string

type MessagingGroupMemberType

type MessagingGroupMemberType string

MessagingGroupMemberType identifies what kind of member a reusable-roster member is.

const (
	// MessagingGroupMemberTypeUser is an account user roster member.
	MessagingGroupMemberTypeUser MessagingGroupMemberType = "user"
	// MessagingGroupMemberTypeAgent is an AI agent roster member.
	MessagingGroupMemberTypeAgent MessagingGroupMemberType = "agent"
)

func (MessagingGroupMemberType) EnumValues

func (t MessagingGroupMemberType) EnumValues() []string

func (MessagingGroupMemberType) IsValid

func (t MessagingGroupMemberType) IsValid() bool

func (*MessagingGroupMemberType) StringPtr

func (t *MessagingGroupMemberType) StringPtr() *string

type Model

type Model string

Model is the stable identifier for an LLM model that agents can be configured to use. Values match the Stripe AI Gateway naming convention (no provider prefix; the gateway client adds it).

const (
	ModelClaudeOpus48   Model = "claude-opus-4.8"
	ModelClaudeOpus47   Model = "claude-opus-4.7"
	ModelClaudeOpus46   Model = "claude-opus-4.6"
	ModelClaudeOpus45   Model = "claude-opus-4.5"
	ModelClaudeSonnet46 Model = "claude-sonnet-4.6"
	ModelClaudeSonnet45 Model = "claude-sonnet-4.5"
	ModelClaudeSonnet4  Model = "claude-sonnet-4"
	ModelClaudeHaiku45  Model = "claude-haiku-4.5"
	ModelClaude37Sonnet Model = "claude-3.7-sonnet"
	ModelClaude35Sonnet Model = "claude-3.5-sonnet"
	ModelClaude35Haiku  Model = "claude-3.5-haiku"
	ModelGPT55          Model = "gpt-5.5"
	ModelGPT54          Model = "gpt-5.4"
	ModelGPT52          Model = "gpt-5.2"
	ModelGPT51          Model = "gpt-5.1"
	ModelGPT5           Model = "gpt-5"
	ModelGPT5Mini       Model = "gpt-5-mini"
	ModelGPT4o          Model = "gpt-4o"
	ModelGPT4oMini      Model = "gpt-4o-mini"
	ModelGPT41Mini      Model = "gpt-4.1-mini"
	ModelGPT4           Model = "gpt-4"
	ModelGPT35Turbo     Model = "gpt-3.5-turbo"
	ModelGemini3Flash   Model = "gemini-3-flash"
	ModelGemini25Flash  Model = "gemini-2.5-flash"
	ModelGemini25Pro    Model = "gemini-2.5-pro"
	ModelGrok4          Model = "grok-4"
	ModelGrok3          Model = "grok-3"
	ModelGrok3Mini      Model = "grok-3-mini"
)

The model catalog — every model agents may use. Each has a named constant (the constants-adherence test requires one per EnumValues entry); ModelCatalog pairs each with display metadata.

func (Model) EnumValues

func (m Model) EnumValues() []string

func (Model) IsValid

func (m Model) IsValid() bool

func (*Model) StringPtr

func (m *Model) StringPtr() *string

type ModelSpec

type ModelSpec struct {
	ID       Model
	Name     string
	Provider string
}

ModelSpec is a catalog entry: the gateway model id plus its display metadata.

type ModelTier

type ModelTier string

ModelTier selects an intelligence/cost level instead of a specific model. Callers pick a tier; the harness resolves it to an ordered model chain (primary first, then fallbacks). Higher tiers cost more and reason better; reserve them for genuinely hard work and use cheaper tiers for background reasoning, extraction, and routine transforms.

const (
	// ModelTierFrontier is the hardest-intelligence tier: multi-step planning, ambiguous agent work, hard coding/architecture, tool-heavy workflows.
	ModelTierFrontier ModelTier = "frontier"
	// ModelTierHigh is the default agent tier: normal planning, code edits, synthesis, customer-facing reasoning.
	ModelTierHigh ModelTier = "high"
	// ModelTierBalanced is for research, summarization, classification, structured extraction, and light tool use.
	ModelTierBalanced ModelTier = "balanced"
	// ModelTierCheap is for simple transforms, validation, formatting, keyword lookup, and routing.
	ModelTierCheap ModelTier = "cheap"
	// ModelTierLegacy is for compatibility / regression comparison only; avoid unless needed.
	ModelTierLegacy ModelTier = "legacy"
)

func (ModelTier) EnumValues

func (t ModelTier) EnumValues() []string

func (ModelTier) IsValid

func (t ModelTier) IsValid() bool

IsValid reports whether the tier is a known tier.

func (ModelTier) ModelChain

func (t ModelTier) ModelChain() []string

ModelChain returns the ordered model chain (primary first, then fallbacks) for the tier, falling back to the default tier for an unknown/empty tier. The runner tries each model in order, advancing to the next on a provider failure.

func (*ModelTier) StringPtr

func (t *ModelTier) StringPtr() *string

type NotificationCategory

type NotificationCategory string

NotificationCategory classifies an in-app notification. The set is intentionally open-ended (producers may introduce new categories), so notification fields use `validate:"required"` rather than a strict enum tag; the named constants below cover the common, first-party categories.

const (
	// NotificationCategoryChatMessage is a new chat message in a conversation.
	NotificationCategoryChatMessage NotificationCategory = "chat.message"
	// NotificationCategoryChatMention is a direct @mention (pierces mute).
	NotificationCategoryChatMention NotificationCategory = "chat.mention"
	// NotificationCategoryChatAdded indicates the user was added to a conversation.
	NotificationCategoryChatAdded NotificationCategory = "chat.added"
	// NotificationCategoryOrderUpdated indicates a change to an order the user is involved with.
	NotificationCategoryOrderUpdated NotificationCategory = "order.updated"
	// NotificationCategoryAgentRunCompleted indicates an agent run the user triggered finished.
	NotificationCategoryAgentRunCompleted NotificationCategory = "agent.run_completed"
	// NotificationCategoryAgentAlert is an alert an agent raised during a run.
	NotificationCategoryAgentAlert NotificationCategory = "agent.alert"
	// NotificationCategorySystemBroadcast is a targeted system message to a user.
	NotificationCategorySystemBroadcast NotificationCategory = "system.broadcast"
	// NotificationCategoryCustomerRegistered indicates a buyer completed registration on the account's customer portal; sent to the customer-service support group.
	NotificationCategoryCustomerRegistered NotificationCategory = "customer.registered"
)

func (NotificationCategory) EnumValues

func (c NotificationCategory) EnumValues() []string

func (NotificationCategory) IsValid

func (c NotificationCategory) IsValid() bool

func (*NotificationCategory) StringPtr

func (c *NotificationCategory) StringPtr() *string

type NotificationDigest

type NotificationDigest string

NotificationDigest controls how email delivery for a notification category is batched. It is an enum (not a boolean) so new cadences can be added without a breaking change to the API.

const (
	// NotificationDigestInstant delivers an email per eligible notification immediately.
	NotificationDigestInstant NotificationDigest = "instant"
	// NotificationDigestHourly batches eligible notifications into an hourly email.
	NotificationDigestHourly NotificationDigest = "hourly"
	// NotificationDigestDaily batches eligible notifications into a daily email.
	NotificationDigestDaily NotificationDigest = "daily"
	// NotificationDigestOff disables email delivery for the category.
	NotificationDigestOff NotificationDigest = "off"
)

func (NotificationDigest) EnumValues

func (d NotificationDigest) EnumValues() []string

func (NotificationDigest) IsValid

func (d NotificationDigest) IsValid() bool

func (*NotificationDigest) StringPtr

func (d *NotificationDigest) StringPtr() *string

type NotificationPriority

type NotificationPriority string

NotificationPriority represents the delivery priority of an in-app notification.

const (
	// NotificationPriorityLow indicates a low-priority, informational notification.
	NotificationPriorityLow NotificationPriority = "low"
	// NotificationPriorityNormal indicates a standard-priority notification (default).
	NotificationPriorityNormal NotificationPriority = "normal"
	// NotificationPriorityHigh indicates a high-priority notification that should stand out.
	NotificationPriorityHigh NotificationPriority = "high"
	// NotificationPriorityUrgent indicates an urgent notification requiring prompt attention.
	NotificationPriorityUrgent NotificationPriority = "urgent"
)

func (NotificationPriority) EnumValues

func (p NotificationPriority) EnumValues() []string

func (NotificationPriority) IsValid

func (p NotificationPriority) IsValid() bool

func (*NotificationPriority) StringPtr

func (p *NotificationPriority) StringPtr() *string

type NotificationSenderType

type NotificationSenderType string

NotificationSenderType identifies what kind of actor generated a notification (its polymorphic sender): user, group, system, agent, or api_key.

const (
	// NotificationSenderTypeUser is an account user.
	NotificationSenderTypeUser NotificationSenderType = "user"
	// NotificationSenderTypeGroup is a shared group identity (e.g. "Customer Service").
	NotificationSenderTypeGroup NotificationSenderType = "group"
	// NotificationSenderTypeSystem is the platform itself.
	NotificationSenderTypeSystem NotificationSenderType = "system"
	// NotificationSenderTypeAgent is an AI agent.
	NotificationSenderTypeAgent NotificationSenderType = "agent"
	// NotificationSenderTypeAPIKey is an API key actor.
	NotificationSenderTypeAPIKey NotificationSenderType = "apikey"
)

func (NotificationSenderType) EnumValues

func (t NotificationSenderType) EnumValues() []string

func (NotificationSenderType) IsValid

func (t NotificationSenderType) IsValid() bool

func (*NotificationSenderType) StringPtr

func (t *NotificationSenderType) StringPtr() *string

type NotificationStatus

type NotificationStatus string

NotificationStatus is the lifecycle state of an in-app notification. Modeled as a constant (rather than seen/read booleans) so new states can be added without breaking existing clients. The state is derived from the seen/read/dismissed timestamps.

const (
	// NotificationStatusUnseen indicates the notification has not yet appeared in the dropdown.
	NotificationStatusUnseen NotificationStatus = "unseen"
	// NotificationStatusSeen indicates the notification has been surfaced but not opened.
	NotificationStatusSeen NotificationStatus = "seen"
	// NotificationStatusRead indicates the notification has been explicitly opened.
	NotificationStatusRead NotificationStatus = "read"
	// NotificationStatusDismissed indicates the notification has been dismissed.
	NotificationStatusDismissed NotificationStatus = "dismissed"
)

func (NotificationStatus) EnumValues

func (s NotificationStatus) EnumValues() []string

func (NotificationStatus) IsValid

func (s NotificationStatus) IsValid() bool

func (*NotificationStatus) StringPtr

func (s *NotificationStatus) StringPtr() *string

type NotificationTargetType

type NotificationTargetType string

NotificationTargetType identifies what a notification send is aimed at. It is an enum (not a boolean) so new target kinds (groups, roles, segments, …) can be added without a breaking change to the send API.

const (
	// NotificationTargetTypeAccountUser targets a single account user (a per-user notification).
	NotificationTargetTypeAccountUser NotificationTargetType = "account_user"
	// NotificationTargetTypeAccount targets every user in an account (a broadcast announcement).
	NotificationTargetTypeAccount NotificationTargetType = "account"
)

func (NotificationTargetType) EnumValues

func (t NotificationTargetType) EnumValues() []string

func (NotificationTargetType) IsValid

func (t NotificationTargetType) IsValid() bool

func (*NotificationTargetType) StringPtr

func (t *NotificationTargetType) StringPtr() *string

type ObjectType

type ObjectType string

ObjectType is a string that indicates what type of object a given object is.

const (
	// ObjectTypeAccount indicates that the object is an account.
	ObjectTypeAccount ObjectType = "account"
	// ObjectTypeActor indicates that the object is an actor.
	ObjectTypeActor ObjectType = "actor"
	// ObjectTypeEntity indicates that the object is a polymorphic entity reference.
	ObjectTypeEntity ObjectType = "entity"
	// ObjectTypeRecord indicates that the object is a lightweight reference to a business record.
	ObjectTypeRecord ObjectType = "record"
	// ObjectTypeFreight indicates that the object is a freight (carrier selection and billing) sub-resource.
	ObjectTypeFreight ObjectType = "freight"
	// ObjectTypeSalesOrderTotals indicates that the object is a sales order totals sub-resource.
	ObjectTypeSalesOrderTotals ObjectType = "sales_order_totals"
	// ObjectTypeSalesOrderStageTotal indicates that the object is a sales order per-stage total (amount + completion) sub-resource.
	ObjectTypeSalesOrderStageTotal ObjectType = "sales_order_stage_total"
	// Marks an object that groups the records related to a sales order.
	ObjectTypeSalesOrderRelated ObjectType = "sales_order_related"

	// Marks an object that groups the records related to a shipment.
	ObjectTypeShipmentRelated ObjectType = "shipment_related"

	// Marks an object that groups the records related to an invoice.
	ObjectTypeInvoiceRelated ObjectType = "invoice_related"

	// Marks an object that groups the records related to a pick.
	ObjectTypePickRelated ObjectType = "pick_related"

	// Marks a pick's per-stage fulfillment progress.
	// ObjectTypePickShipmentsResponse indicates that the object is a pick shipments response.
	ObjectTypePickShipmentsResponse ObjectType = "pick_shipments_response"
	ObjectTypePickTotals            ObjectType = "pick_totals"

	// Marks the progress of one fulfillment stage of a pick.
	ObjectTypePickStageTotal ObjectType = "pick_stage_total"

	// ObjectTypeOrderContact indicates that the object groups a sales order's email recipients by notification purpose.
	ObjectTypeOrderContact ObjectType = "order_contact"
	// ObjectTypeUser indicates that the object is a user.
	ObjectTypeUser ObjectType = "user"
	// ObjectTypeAddress indicates that the object is an address.
	ObjectTypeAddress ObjectType = "address"
	// ObjectTypeAPIKey indicates that the object is an API key.
	ObjectTypeAPIKey ObjectType = "api_key"
	// ObjectTypeCreatedAPIKey indicates a one-time API key creation response including the secret.
	ObjectTypeCreatedAPIKey ObjectType = "created_api_key"
	// ObjectTypeRefreshToken indicates that the object is a refresh token.
	ObjectTypeRefreshToken ObjectType = "refresh_token"
	// ObjectTypeList indicates that the object is a list.
	ObjectTypeList ObjectType = "list"
	// ObjectTypeSandbox indicates that the object is a sandbox.
	ObjectTypeSandbox ObjectType = "sandbox"
	// ObjectTypeRegistrationSession indicates that the object is a registration session.
	ObjectTypeRegistrationSession ObjectType = "registration_session"
	// ObjectTypePricingPlan indicates that the object is a pricing plan.
	ObjectTypePricingPlan ObjectType = "pricing_plan"
	// ObjectTypeAccountPlan indicates that the object is a resolved account plan.
	ObjectTypeAccountPlan ObjectType = "account_plan"
	// ObjectTypePlanChange indicates that the object is a plan change.
	ObjectTypePlanChange ObjectType = "plan_change"
	// ObjectTypeEnterpriseInquiry indicates that the object is an enterprise inquiry.
	ObjectTypeEnterpriseInquiry ObjectType = "enterprise_inquiry"
	// ObjectTypeRequestLog indicates that the object is a request log.
	ObjectTypeRequestLog ObjectType = "request_log"
	// ObjectTypeAuditEvent indicates that the object is an audit event record.
	ObjectTypeAuditEvent ObjectType = "audit_event"
	// ObjectTypeAuditFieldChange indicates that the object is an audit field change.
	ObjectTypeAuditFieldChange ObjectType = "audit_field_change"
	// ObjectTypeRole indicates that the object is a role.
	ObjectTypeRole ObjectType = "role"
	// ObjectTypeUnit indicates that the object is a unit.
	ObjectTypeUnit ObjectType = "unit"
	// ObjectTypeAccountAffiliation indicates that the object is an account affiliation.
	ObjectTypeAccountAffiliation ObjectType = "account_affiliation"
	// ObjectTypeAgentDefinition indicates that the object is an agent definition.
	ObjectTypeAgentDefinition ObjectType = "agent_definition"
	// ObjectTypeAvailableTool indicates that the object is an available tool.
	ObjectTypeAvailableTool ObjectType = "available_tool"
	// ObjectTypeAgentDefinitionTool indicates that the object is an agent definition tool.
	ObjectTypeAgentDefinitionTool ObjectType = "agent_definition_tool"
	// ObjectTypeAgentAccountStatus indicates that the object is an agent account status.
	ObjectTypeAgentAccountStatus ObjectType = "agent_account_status"
	// ObjectTypeAgentRun indicates that the object is an agent run.
	ObjectTypeAgentRun ObjectType = "agent_run"
	// ObjectTypeAgentAction indicates that the object is an agent action.
	ObjectTypeAgentAction ObjectType = "agent_action"
	// ObjectTypeAgentRunStep indicates that the object is an agent run step.
	ObjectTypeAgentRunStep ObjectType = "agent_run_step"
	// ObjectTypeAgentTokenUsage indicates that the object is an agent token usage record.
	ObjectTypeAgentTokenUsage ObjectType = "agent_token_usage"
	// ObjectTypeAgentMemory indicates that the object is an agent memory.
	ObjectTypeAgentMemory ObjectType = "agent_memory"
	// ObjectTypeNotification indicates that the object is an in-app notification.
	ObjectTypeNotification ObjectType = "notification"
	// ObjectTypeNotificationUnreadCount indicates that the object is an unread-count summary.
	ObjectTypeNotificationUnreadCount ObjectType = "notification_unread_count"
	// ObjectTypeNotificationSendResult indicates that the object is a notification-send acknowledgement.
	ObjectTypeNotificationSendResult ObjectType = "notification_send_result"
	// ObjectTypeNotificationUnreadSummary indicates that the object is a cross-account unread summary.
	ObjectTypeNotificationUnreadSummary ObjectType = "notification_unread_summary"
	// ObjectTypeAnnouncement indicates that the object is a broadcast announcement.
	ObjectTypeAnnouncement ObjectType = "announcement"
	// ObjectTypeConversation indicates that the object is a conversation.
	ObjectTypeConversation ObjectType = "conversation"
	// ObjectTypeSupportCase indicates that the object is a customer-facing support case (an audience=customer conversation). Used to route notification links to the support inbox rather than team messages.
	ObjectTypeSupportCase ObjectType = "support_case"
	// ObjectTypeConversationParticipant indicates that the object is a conversation participant.
	ObjectTypeConversationParticipant ObjectType = "conversation_participant"
	// ObjectTypeReadCursor indicates that the object is a participant's read cursor (read receipts).
	ObjectTypeReadCursor ObjectType = "read_cursor"
	// ObjectTypeChatMessage indicates that the object is a chat message within a conversation.
	ObjectTypeChatMessage ObjectType = "chat_message"
	// ObjectTypeNotificationUnreadSummaryAccount indicates that the object is one account's unread tally in a cross-account summary.
	ObjectTypeNotificationUnreadSummaryAccount ObjectType = "notification_unread_summary_account"
	// ObjectTypeMessagingBlock indicates that the object is a 1:1 messaging block.
	ObjectTypeMessagingBlock ObjectType = "messaging_block"
	// ObjectTypeNotificationPreference indicates that the object is a per-user notification preference.
	ObjectTypeNotificationPreference ObjectType = "notification_preference"
	// ObjectTypeMessageAttachment indicates that the object is a message attachment.
	ObjectTypeMessageAttachment ObjectType = "message_attachment"
	// ObjectTypeAttachmentUploadTarget indicates that the object is a presigned attachment upload target.
	ObjectTypeAttachmentUploadTarget ObjectType = "attachment_upload_target"
	// ObjectTypeScheduledMessage indicates that the object is a scheduled message.
	ObjectTypeScheduledMessage ObjectType = "scheduled_message"
	// ObjectTypeMessagingContact indicates that the object is a messageable directory contact.
	ObjectTypeMessagingContact ObjectType = "messaging_contact"
	// ObjectTypeMessageReport indicates that the object is an abuse report for a message/conversation.
	ObjectTypeMessageReport ObjectType = "message_report"
	// ObjectTypeToolGroup indicates that the object is a tool group.
	ObjectTypeToolGroup ObjectType = "tool_group"
	// ObjectTypeModel indicates that the object is an LLM model available to agents.
	ObjectTypeModel ObjectType = "model"
	// ObjectTypePaymentTerm indicates that the object is a payment term.
	ObjectTypePaymentTerm ObjectType = "payment_term"
	// ObjectTypeShippingTerm indicates that the object is a shipping term.
	ObjectTypeShippingTerm ObjectType = "shipping_term"
	// ObjectTypeQuantity indicates that the object is a quantity.
	ObjectTypeQuantity ObjectType = "quantity"
	// ObjectTypeAccountGroup indicates that the object is an account group.
	ObjectTypeAccountGroup ObjectType = "account_group"
	// ObjectTypeSupportRoute indicates that the object is a support route: the group conversation handling a relationship's inbound support.
	ObjectTypeSupportRoute ObjectType = "support_route"
	// ObjectTypeReplyDraft indicates that the object is a customer-reply draft on an external case.
	ObjectTypeReplyDraft ObjectType = "reply_draft"
	// ObjectTypeConversationLink indicates that the object is a business-record link on a conversation.
	ObjectTypeConversationLink ObjectType = "conversation_link"
	// ObjectTypeMessagingGroup indicates that the object is a reusable messaging roster (a named member set that seeds conversations).
	ObjectTypeMessagingGroup ObjectType = "messaging_group"
	// ObjectTypeMessagingGroupMember indicates that the object is a member of a reusable messaging roster.
	ObjectTypeMessagingGroupMember ObjectType = "messaging_group_member"
	// ObjectTypeSupportAvailability indicates that the object reports whether a customer can contact support.
	ObjectTypeSupportAvailability ObjectType = "support_availability"
	// ObjectTypeAccountStatus indicates that the object is an account status.
	ObjectTypeAccountStatus ObjectType = "account_status"
	// ObjectTypeGeolocation indicates that the object is a geolocation.
	ObjectTypeGeolocation ObjectType = "geolocation"
	// ObjectTypeAccountUser indicates that the object is an account user.
	ObjectTypeAccountUser ObjectType = "account_user"
	// ObjectTypeDepartment indicates that the object is a department.
	ObjectTypeDepartment ObjectType = "department"
	// ObjectTypeAccountIntegration indicates that the object is an account integration.
	ObjectTypeAccountIntegration ObjectType = "account_integration"
	// ObjectTypeHubspotSyncJob indicates that the object is a HubSpot backfill sync job.
	ObjectTypeHubspotSyncJob ObjectType = "hubspot_sync_job"
	// ObjectTypeHubspotSyncReport indicates that the object is the dry-run report embedded in a HubSpot sync job.
	ObjectTypeHubspotSyncReport ObjectType = "hubspot_sync_report"
	// ObjectTypeHubspotCompanyReview indicates that the object is a HubSpot company-match review.
	ObjectTypeHubspotCompanyReview ObjectType = "hubspot_company_review"
	// ObjectTypeHubspotCompanyCandidate indicates that the object is a candidate HubSpot company match within a review.
	ObjectTypeHubspotCompanyCandidate ObjectType = "hubspot_company_candidate"
	// ObjectTypeHubspotSyncRecord indicates that the object is a mapping from an OpenMRP record to its HubSpot counterpart.
	ObjectTypeHubspotSyncRecord ObjectType = "hubspot_sync_record"
	// ObjectTypeAccountPrice indicates that the object is an account price.
	ObjectTypeAccountPrice ObjectType = "account_price"
	// ObjectTypeProductLine indicates that the object is a product line.
	ObjectTypeProductLine ObjectType = "product_line"
	// ObjectTypeItemCategory indicates that the object is an item category.
	ObjectTypeItemCategory ObjectType = "item_category"
	// ObjectTypeAttribute indicates that the object is an attribute.
	ObjectTypeAttribute ObjectType = "attribute"
	// ObjectTypeRate indicates that the object is a rate.
	ObjectTypeRate ObjectType = "rate"
	// ObjectTypeAccountGroupProductLineAccess indicates that the object is an account group product line access.
	ObjectTypeAccountGroupProductLineAccess ObjectType = "account_group_product_line_access"
	// ObjectTypeSalesTarget indicates that the object is a sales target.
	ObjectTypeSalesTarget ObjectType = "sales_target"
	// ObjectTypeAdjustmentType indicates that the object is an adjustment type.
	ObjectTypeAdjustmentType ObjectType = "adjustment_type"
	// ObjectTypeAccountBranding indicates that the object is an account branding record.
	ObjectTypeAccountBranding ObjectType = "account_branding"
	// ObjectTypeAccountPortal indicates that the object is an account portal record.
	ObjectTypeAccountPortal ObjectType = "account_portal"
	// ObjectTypeAccountLogoURL indicates that the object is an account logo URL response.
	ObjectTypeAccountLogoURL ObjectType = "account_logo_url"
	// ObjectTypeAccountFaviconURL indicates that the object is an account favicon URL response.
	ObjectTypeAccountFaviconURL ObjectType = "account_favicon_url"
	// ObjectTypePublicAccount indicates that the object is a public account record.
	ObjectTypePublicAccount ObjectType = "public_account"
	// ObjectTypePortalProfile indicates that the object is an authenticated seller portal profile (identity + letterhead address).
	ObjectTypePortalProfile ObjectType = "portal_profile"
	// ObjectTypePortalRegistrationSession indicates that the object is a buyer's customer-portal registration session.
	ObjectTypePortalRegistrationSession ObjectType = "portal_registration_session"
	// ObjectTypePortalRegistrationSessionData indicates that the object is the scratch form data of a portal registration session.
	ObjectTypePortalRegistrationSessionData ObjectType = "portal_registration_session_data"
	// ObjectTypeProperty indicates that the object is a property.
	ObjectTypeProperty ObjectType = "property"
	// ObjectTypeCarrier indicates that the object is a carrier.
	ObjectTypeCarrier ObjectType = "carrier"
	// ObjectTypeServiceLevel indicates that the object is a service level.
	ObjectTypeServiceLevel ObjectType = "service_level"
	// ObjectTypeItem indicates that the object is an item.
	ObjectTypeItem ObjectType = "item"
	// ObjectTypeItemLotDefault indicates that the object is the lot an item is made in.
	ObjectTypeItemLotDefault ObjectType = "item_lot_default"
	// ObjectTypeCustomerLeadTime indicates that the object is a customer's resolved ship-by lead time.
	ObjectTypeCustomerLeadTime ObjectType = "customer_lead_time"
	// ObjectTypeItemInventory indicates that the object is an item's inventory data.
	ObjectTypeItemInventory ObjectType = "item_inventory"
	// ObjectTypeProduct indicates that the object is a product.
	ObjectTypeProduct ObjectType = "product"
	// ObjectTypeBatch indicates that the object is a batch.
	ObjectTypeBatch ObjectType = "batch"
	// ObjectTypeBatchFlowNode indicates that the object is a batch flow node.
	ObjectTypeBatchFlowNode ObjectType = "batch_flow_node"
	// ObjectTypeScanningConsumption indicates that the object is a scanning consumption.
	ObjectTypeScanningConsumption ObjectType = "scanning_consumption"
	// ObjectTypeOpenBatchSummary indicates that the object is an open batch summary.
	ObjectTypeOpenBatchSummary ObjectType = "open_batch_summary"
	// ObjectTypeScanningProductionStepInfo indicates that the object is a scanning production step info.
	ObjectTypeScanningProductionStepInfo ObjectType = "scanning_production_step_info"
	// ObjectTypeScanningStation indicates that the object is a scanning station.
	ObjectTypeScanningStation ObjectType = "scanning_station"
	// ObjectTypeProductionStep indicates that the object is a production step.
	ObjectTypeProductionStep ObjectType = "production_step"
	// ObjectTypeProductionRun indicates that the object is a production run.
	ObjectTypeProductionRun ObjectType = "production_run"
	// ObjectTypeMachine indicates that the object is a machine.
	ObjectTypeMachine ObjectType = "machine"
	// ObjectTypeMachineStatus indicates that the object is a machine's current work status.
	ObjectTypeMachineStatus ObjectType = "machine_status"
	// ObjectTypeMachineDowntimeEvent indicates that the object is a machine downtime event.
	ObjectTypeMachineDowntimeEvent ObjectType = "machine_downtime_event"

	// ObjectTypeDemandOverride indicates that the object is a demand override.
	ObjectTypeDemandOverride ObjectType = "demand_override"

	// ObjectTypeDemandOverrideType indicates that the object is a demand override type.
	ObjectTypeDemandOverrideType ObjectType = "demand_override_type"
	// ObjectTypeMachineDowntimeReason indicates that the object is a machine downtime reason.
	ObjectTypeMachineDowntimeReason ObjectType = "machine_downtime_reason"
	// ObjectTypeProductionSchedulePreview indicates that the object is a production schedule preview.
	ObjectTypeProductionSchedulePreview ObjectType = "production_schedule_preview"
	// ObjectTypeProductionScheduleRegeneratePreview indicates that the object is a production schedule regenerate preview.
	ObjectTypeProductionScheduleRegeneratePreview ObjectType = "production_schedule_regenerate_preview"
	// ObjectTypeProductionSchedule indicates that the object is a production schedule.
	ObjectTypeProductionSchedule ObjectType = "production_schedule"
	// ObjectTypeProductionScheduleLine indicates that the object is a production schedule line.
	ObjectTypeProductionScheduleLine ObjectType = "production_schedule_line"

	// ObjectTypeProductionScheduleDeviation indicates that the object is a production schedule deviation.
	ObjectTypeProductionScheduleDeviation ObjectType = "production_schedule_deviation"

	// ObjectTypeProductionScheduleDerivedLine indicates that the object is a derived production schedule line.
	ObjectTypeProductionScheduleDerivedLine ObjectType = "production_schedule_derived_line"

	// ObjectTypeProductionScheduleSettings indicates that the object is the account's production schedule settings.
	ObjectTypeProductionScheduleSettings ObjectType = "production_schedule_settings"

	// ObjectTypeAnalyzeDeliveryPerformanceResponse indicates that the object is a delivery-reliability analysis.
	ObjectTypeAnalyzeDeliveryPerformanceResponse ObjectType = "analyze_delivery_performance_response"
	// ObjectTypeDeliveryPerformance indicates that the object is delivery reliability for one period.
	ObjectTypeDeliveryPerformance ObjectType = "delivery_performance"
	// ObjectTypeDeliveryBacklogBucket indicates that the object is one age band of overdue orders.
	ObjectTypeDeliveryBacklogBucket ObjectType = "delivery_backlog_bucket"
	// ObjectTypeDeliveryLatenessBucket indicates that the object is one band of how far the window's misses missed by.
	ObjectTypeDeliveryLatenessBucket ObjectType = "delivery_lateness_bucket"
	// ObjectTypeDeliveryBreakdown indicates that the object is delivery performance for one slice of the order book.
	ObjectTypeDeliveryBreakdown ObjectType = "delivery_breakdown"
	// ObjectTypeScheduleOrderCoverage indicates that the object is an order a schedule does not build in time.
	ObjectTypeScheduleOrderCoverage ObjectType = "schedule_order_coverage"
	// ObjectTypeScheduleOrderCoverageLine indicates that the object is one campaign earmarked for an order.
	ObjectTypeScheduleOrderCoverageLine ObjectType = "schedule_order_coverage_line"
	// ObjectTypeFulfillmentRecommendation indicates that the object is advice on how a SKU should be produced.
	ObjectTypeFulfillmentRecommendation ObjectType = "fulfillment_recommendation"
	// ObjectTypeProductionScheduleItemSetting indicates that the object is one item's planning overrides.
	ObjectTypeProductionScheduleItemSetting ObjectType = "production_schedule_item_setting"
	// ObjectTypeProductionScheduleResourceSetting indicates that the object is a per-resource scheduling override.
	ObjectTypeProductionScheduleResourceSetting ObjectType = "production_schedule_resource_setting"

	// ObjectTypeScheduleAtRiskOrder indicates that the object is an order commitment the plan does not meet.
	ObjectTypeScheduleAtRiskOrder ObjectType = "schedule_at_risk_order"
	// ObjectTypeScheduleDeviationType indicates that the object is a schedule deviation type.
	ObjectTypeScheduleDeviationType ObjectType = "schedule_deviation_type"
	// ObjectTypeProductionScheduleFinishedPolicy indicates that the object is a production schedule finished-goods policy.
	ObjectTypeProductionScheduleFinishedPolicy ObjectType = "production_schedule_finished_policy"
	// ObjectTypeProductionScheduleFinishingLine indicates that the object is a second-stage plan line: one finished good's build in one week.
	ObjectTypeProductionScheduleFinishingLine ObjectType = "production_schedule_finishing_line"
	// ObjectTypeProductionScheduleWeekRelease indicates that the object is the production run created from one week of a schedule.
	ObjectTypeProductionScheduleWeekRelease ObjectType = "production_schedule_week_release"
	// ObjectTypeProductionScheduleWeekReleasePreview indicates that the object is a preview of releasing one week of a schedule.
	ObjectTypeProductionScheduleWeekReleasePreview ObjectType = "production_schedule_week_release_preview"
	// ObjectTypeProductionScheduleItemPolicy indicates that the object is a production schedule item policy.
	ObjectTypeProductionScheduleItemPolicy ObjectType = "production_schedule_item_policy"
	// ObjectTypeChildAccount indicates that the object is a child account.
	ObjectTypeChildAccount ObjectType = "child_account"
	// ObjectTypeUnitGroup indicates that the object is a unit group.
	ObjectTypeUnitGroup ObjectType = "unit_group"
	// ObjectTypeUnitGroupUnit indicates that the object is a unit group unit conversion.
	ObjectTypeUnitGroupUnit ObjectType = "unit_group_unit"
	// ObjectTypeConsumption indicates that the object is a consumption.
	ObjectTypeConsumption ObjectType = "consumption"
	// ObjectTypeCustomerProductLineAccess indicates that the object is a customer product line access.
	ObjectTypeCustomerProductLineAccess ObjectType = "customer_product_line_access"
	// ObjectTypeCustomer indicates that the object is a customer.
	ObjectTypeCustomer ObjectType = "customer"
	// ObjectTypeFrequentlyOrderedProduct indicates that the object is a frequently ordered product.
	ObjectTypeFrequentlyOrderedProduct ObjectType = "frequently_ordered_product"
	// ObjectTypePriority indicates that the object is a priority.
	ObjectTypePriority ObjectType = "priority"
	// ObjectTypeDelivery indicates that the object is a delivery.
	ObjectTypeDelivery ObjectType = "delivery"
	// ObjectTypeDeliveryLine indicates that the object is a delivery line.
	ObjectTypeDeliveryLine ObjectType = "delivery_line"
	// ObjectTypeSalesOrder indicates that the object is a sales order.
	ObjectTypeSalesOrder ObjectType = "sales_order"
	// ObjectTypeLocation indicates that the object is a location.
	ObjectTypeLocation ObjectType = "location"
	// ObjectTypeLocationType indicates that the object is a location type.
	ObjectTypeLocationType ObjectType = "location_type"
	// ObjectTypeLot indicates that the object is a lot.
	ObjectTypeLot ObjectType = "lot"
	// ObjectTypeEmailLog indicates that the object is an email log.
	ObjectTypeEmailLog ObjectType = "email_log"
	// ObjectTypeEmailDomain indicates that the object is a customer-owned sending/receiving domain registered with the email bridge.
	ObjectTypeEmailDomain ObjectType = "email_domain"
	// ObjectTypeEmailInbox indicates that the object is a routable email inbox bound to chat conversations.
	ObjectTypeEmailInbox ObjectType = "email_inbox"
	// ObjectTypePortalDomain indicates that the object is a customer-supplied custom domain serving the account's customer portal.
	ObjectTypePortalDomain ObjectType = "portal_domain"
	// ObjectTypeDNSRecord indicates that the object is a DNS record the customer must publish for a portal domain.
	ObjectTypeDNSRecord ObjectType = "dns_record"
	// ObjectTypeInventoryChangeLog indicates that the object is an inventory change log.
	ObjectTypeInventoryChangeLog ObjectType = "inventory_change_log"
	// ObjectTypeInvoice indicates that the object is an invoice.
	ObjectTypeInvoice ObjectType = "invoice"
	// ObjectTypeInvoiceSummary indicates that the object is an invoice summary.
	ObjectTypeInvoiceSummary ObjectType = "invoice_summary"
	// ObjectTypeInvoiceLine indicates that the object is an invoice line.
	ObjectTypeInvoiceLine ObjectType = "invoice_line"
	// ObjectTypeInvoiceAllocation indicates that the object is an invoice allocation.
	ObjectTypeInvoiceAllocation ObjectType = "invoice_allocation"
	// ObjectTypeInvoiceForPayment indicates that the object is an invoice for payment.
	ObjectTypeInvoiceForPayment ObjectType = "invoice_for_payment"
	// ObjectTypeShipment indicates that the object is a shipment.
	ObjectTypeShipment ObjectType = "shipment"
	// ObjectTypeShipmentSummary indicates that the object is a shipment summary.
	ObjectTypeShipmentSummary ObjectType = "shipment_summary"
	// ObjectTypeShipmentLine indicates that the object is a shipment line.
	ObjectTypeShipmentLine ObjectType = "shipment_line"
	// ObjectTypeShippingCase indicates that the object is a shipping case.
	ObjectTypeShippingCase ObjectType = "shipping_case"
	// ObjectTypeShippingCaseLabelURL indicates that the object is a shipping case label URL response.
	ObjectTypeShippingCaseLabelURL ObjectType = "shipping_case_label_url"
	// ObjectTypeSettlement indicates that the object is a settlement.
	ObjectTypeSettlement ObjectType = "settlement"
	// ObjectTypeSettlementSummary indicates that the object is a settlement summary.
	ObjectTypeSettlementSummary ObjectType = "settlement_summary"
	// ObjectTypeRolePermission indicates that the object is a role permission.
	ObjectTypeRolePermission ObjectType = "role_permission"
	// ObjectTypeRegistrationFlow indicates that the object is a registration flow.
	ObjectTypeRegistrationFlow ObjectType = "registration_flow"
	// ObjectTypeRegistrationFlowOption indicates that the object is a registration flow option.
	ObjectTypeRegistrationFlowOption ObjectType = "registration_flow_option"
	// ObjectTypeTransaction indicates that the object is a transaction.
	ObjectTypeTransaction ObjectType = "transaction"
	// ObjectTypeTransactionSummary indicates that the object is a transaction summary.
	ObjectTypeTransactionSummary ObjectType = "transaction_summary"
	// ObjectTypeTransactionMethod indicates that the object is a transaction method.
	ObjectTypeTransactionMethod ObjectType = "transaction_method"
	// ObjectTypeTransactionType indicates that the object is a transaction type.
	ObjectTypeTransactionType ObjectType = "transaction_type"
	// ObjectTypeTransactionAllocation indicates that the object is a transaction allocation.
	ObjectTypeTransactionAllocation ObjectType = "transaction_allocation"
	// ObjectTypeUsageItem indicates that the object is a usage item.
	ObjectTypeUsageItem ObjectType = "usage_item"
	// ObjectTypeAccountUsageResponse indicates that the object is an account usage response.
	ObjectTypeAccountUsageResponse ObjectType = "account_usage_response"
	// ObjectTypeSubscriptionInfo indicates that the object is a subscription info.
	ObjectTypeSubscriptionInfo ObjectType = "subscription_info"
	// ObjectTypeBillingPortalSessionResponse indicates that the object is a billing portal session response.
	ObjectTypeBillingPortalSessionResponse ObjectType = "billing_portal_session_response"
	// ObjectTypeSwitchPlanResponse indicates that the object is a switch plan response.
	ObjectTypeSwitchPlanResponse ObjectType = "switch_plan_response"
	// ObjectTypeEnsureBillingCustomerResponse indicates that the object is an ensure billing customer response.
	ObjectTypeEnsureBillingCustomerResponse ObjectType = "ensure_billing_customer_response"
	// ObjectTypeSpendingCapResponse indicates that the object is a spending cap response.
	ObjectTypeSpendingCapResponse ObjectType = "spending_cap_response"
	// ObjectTypeAgentSpendInfo indicates that the object is an agent spend info.
	ObjectTypeAgentSpendInfo ObjectType = "agent_spend_info"
	// ObjectTypeWebhookResponse indicates that the object is a webhook response.
	ObjectTypeWebhookResponse ObjectType = "webhook_response"
	// ObjectTypeAddressSuggestion indicates that the object is an address suggestion.
	ObjectTypeAddressSuggestion ObjectType = "address_suggestion"
	// ObjectTypeAddressComponents indicates that the object is an address components record.
	ObjectTypeAddressComponents ObjectType = "address_components"
	// ObjectTypeAddressDetailsResult indicates that the object is an address details result.
	ObjectTypeAddressDetailsResult ObjectType = "address_details_result"
	// ObjectTypeContactMatch indicates that the object is a contact match (an account user found by email on a related account).
	ObjectTypeContactMatch ObjectType = "contact_match"
	// ObjectTypeValidatedAddress indicates that the object is a validated address.
	ObjectTypeValidatedAddress ObjectType = "validated_address"
	// ObjectTypePlanLimit indicates that the object is a plan limit.
	ObjectTypePlanLimit ObjectType = "plan_limit"
	// ObjectTypePlanChangeProration indicates that the object is a plan change proration.
	ObjectTypePlanChangeProration ObjectType = "plan_change_proration"
	// ObjectTypePlanChangeLineItem indicates that the object is a plan change line item.
	ObjectTypePlanChangeLineItem ObjectType = "plan_change_line_item"
	// ObjectTypeSetupBillingResponse indicates that the object is a setup billing response.
	ObjectTypeSetupBillingResponse ObjectType = "setup_billing_response"
	// ObjectTypeConfirmPaymentResponse indicates that the object is a confirm payment response.
	ObjectTypeConfirmPaymentResponse ObjectType = "confirm_payment_response"
	// ObjectTypeOAuthResponse indicates that the object is an OAuth response.
	ObjectTypeOAuthResponse ObjectType = "oauth_response"
	// ObjectTypeOAuthStatusResponse indicates that the object is an OAuth status response.
	ObjectTypeOAuthStatusResponse ObjectType = "oauth_status_response"
	// ObjectTypeStripePublishableKey indicates that the object is a Stripe publishable key.
	ObjectTypeStripePublishableKey ObjectType = "stripe_publishable_key"
	// ObjectTypeStripeStatus indicates that the object is a Stripe status.
	ObjectTypeStripeStatus ObjectType = "stripe_status"
	// ObjectTypeHealthcheck indicates that the object is a healthcheck.
	ObjectTypeHealthcheck ObjectType = "healthcheck"
	// ObjectTypeAgentDefinitionConfig indicates that the object is an agent definition config.
	ObjectTypeAgentDefinitionConfig ObjectType = "agent_definition_config"
	// ObjectTypeTriggerConfig indicates that the object is a trigger config.
	ObjectTypeTriggerConfig ObjectType = "trigger_config"
	// ObjectTypeCustomerContactInfo indicates that the object is customer contact info.
	ObjectTypeCustomerContactInfo ObjectType = "customer_contact_info"
	// ObjectTypeCustomerFreightPreferences indicates that the object is customer freight preferences.
	ObjectTypeCustomerFreightPreferences ObjectType = "customer_freight_preferences"
	// ObjectTypeCustomerDefaults indicates that the object is customer defaults.
	ObjectTypeCustomerDefaults ObjectType = "customer_defaults"
	// ObjectTypeCustomerNotificationPreferences indicates that the object is customer notification preferences.
	ObjectTypeCustomerNotificationPreferences ObjectType = "customer_notification_preferences"
	// ObjectTypeOrderNotificationRecipient indicates that the object is a default order-notification recipient for a customer.
	ObjectTypeOrderNotificationRecipient ObjectType = "order_notification_recipient"
	// ObjectTypeOrderDiscount indicates that the object is an order discount.
	ObjectTypeOrderDiscount ObjectType = "order_discount"
	// ObjectTypeSalesOrderLine indicates that the object is a sales order line.
	ObjectTypeSalesOrderLine ObjectType = "sales_order_line"
	// ObjectTypeSalesOrderType indicates that the object is a sales order type.
	ObjectTypeSalesOrderType ObjectType = "sales_order_type"
	// ObjectTypeSalesOrderStatus indicates that the object is a sales order status.
	ObjectTypeSalesOrderStatus ObjectType = "sales_order_status"
	// ObjectTypeMaterial indicates that the object is a material.
	ObjectTypeMaterial ObjectType = "material"
	// ObjectTypeSupplierMaterial indicates that the object is a supplier material.
	ObjectTypeSupplierMaterial ObjectType = "supplier_material"
	// ObjectTypePart indicates that the object is a part.
	ObjectTypePart ObjectType = "part"
	// ObjectTypePermissionGroup indicates that the object is a permission group.
	ObjectTypePermissionGroup ObjectType = "permission_group"
	// ObjectTypePermission indicates that the object is a permission.
	ObjectTypePermission ObjectType = "permission"
	// ObjectTypePick indicates that the object is a pick.
	ObjectTypePick ObjectType = "pick"
	// ObjectTypePickLine indicates that the object is a pick line.
	ObjectTypePickLine ObjectType = "pick_line"
	// ObjectTypeProductType indicates that the object is a product type.
	ObjectTypeProductType ObjectType = "product_type"
	// ObjectTypeProduction indicates that the object is a production output.
	ObjectTypeProduction ObjectType = "production"
	// ObjectTypeProductionFlow indicates that the object is a production flow.
	ObjectTypeProductionFlow ObjectType = "production_flow"
	// ObjectTypeMap indicates that the object is a map.
	ObjectTypeMap ObjectType = "map"
	// ObjectTypePurchaseOrder indicates that the object is a purchase order.
	ObjectTypePurchaseOrder ObjectType = "purchase_order"
	// ObjectTypePurchaseOrderLine indicates that the object is a purchase order line.
	ObjectTypePurchaseOrderLine ObjectType = "purchase_order_line"
	// ObjectTypeSupplier indicates that the object is a supplier.
	ObjectTypeSupplier ObjectType = "supplier"
	// ObjectTypeSupplierSummary indicates that the object is a supplier summary.
	ObjectTypeSupplierSummary ObjectType = "supplier_summary"
	// ObjectTypeReceivableEntry indicates that the object is a receivable entry.
	ObjectTypeReceivableEntry ObjectType = "receivable_entry"
	// ObjectTypeReceivingOrder indicates that the object is a receiving order.
	ObjectTypeReceivingOrder ObjectType = "receiving_order"
	// ObjectTypeReceivingOrderLine indicates that the object is a receiving order line.
	ObjectTypeReceivingOrderLine ObjectType = "receiving_order_line"
	// ObjectTypeEmailContact indicates that the object is an email contact.
	ObjectTypeEmailContact ObjectType = "email_contact"
	// ObjectTypeAllocationEntry indicates that the object is an allocation entry.
	ObjectTypeAllocationEntry ObjectType = "allocation_entry"
	// ObjectTypeOpenCreditEntry indicates that the object is an open credit entry.
	ObjectTypeOpenCreditEntry ObjectType = "open_credit_entry" // #nosec G101 -- constant name, not a credential
	// ObjectTypeVolumeDiscount indicates that the object is a volume discount.
	ObjectTypeVolumeDiscount ObjectType = "volume_discount"
	// ObjectTypeVolumeDiscountTier indicates that the object is a volume discount tier.
	ObjectTypeVolumeDiscountTier ObjectType = "volume_discount_tier"
	// ObjectTypeAnalyzeDeliveriesResponse indicates that the object is an analyze deliveries response.
	ObjectTypeAnalyzeDeliveriesResponse ObjectType = "analyze_deliveries_response"
	// ObjectTypeAnalyzeManufacturingResponse indicates that the object is an analyze manufacturing response.
	ObjectTypeAnalyzeManufacturingResponse ObjectType = "analyze_manufacturing_response"
	// ObjectTypeAnalyzeManufacturingBatchResponse indicates that the object is an analyze manufacturing batch response.
	ObjectTypeAnalyzeManufacturingBatchResponse ObjectType = "analyze_manufacturing_batch_response"
	// ObjectTypeAnalyzeQuarterlyOrdersResponse indicates that the object is an analyze quarterly orders response.
	ObjectTypeAnalyzeQuarterlyOrdersResponse ObjectType = "analyze_quarterly_orders_response"
	// ObjectTypeAnalyzeNewCustomersResponse indicates that the object is an analyze new customers response.
	ObjectTypeAnalyzeNewCustomersResponse ObjectType = "analyze_new_customers_response"
	// ObjectTypeAnalyzeDemandForecastResponse indicates that the object is an analyze demand forecast response.
	ObjectTypeAnalyzeDemandForecastResponse ObjectType = "analyze_demand_forecast_response"
	// ObjectTypeAnalyzeOeeResponse indicates that the object is an analyze OEE response.
	ObjectTypeAnalyzeOeeResponse ObjectType = "analyze_oee_response"
	// ObjectTypeAnalyzeOeeTrendResponse indicates that the object is an analyze OEE trend response.
	ObjectTypeAnalyzeOeeTrendResponse ObjectType = "analyze_oee_trend_response"

	// ObjectTypeAnalyzeScheduleAttainmentResponse indicates that the object is a schedule attainment analysis response.
	ObjectTypeAnalyzeScheduleAttainmentResponse ObjectType = "analyze_schedule_attainment_response"
	// ObjectTypeCatalogProductLine indicates that the object is a catalog product line.
	ObjectTypeCatalogProductLine ObjectType = "catalog_product_line"
	// ObjectTypeCatalogCategory indicates that the object is a catalog category.
	ObjectTypeCatalogCategory ObjectType = "catalog_category"
	// ObjectTypeCatalogProduct indicates that the object is a catalog product.
	ObjectTypeCatalogProduct ObjectType = "catalog_product"
	// ObjectTypeCatalogProperty indicates that the object is a catalog property.
	ObjectTypeCatalogProperty ObjectType = "catalog_property"
	// ObjectTypeCatalogAttribute indicates that the object is a catalog attribute.
	ObjectTypeCatalogAttribute ObjectType = "catalog_attribute"
	// ObjectTypeDCLocation indicates that the object is a DC location.
	ObjectTypeDCLocation ObjectType = "dc_location"
	// ObjectTypeEDIRun indicates that the object is an EDI run.
	ObjectTypeEDIRun ObjectType = "edi_run"
	// ObjectTypeInventoryItem indicates that the object is an inventory item.
	ObjectTypeInventoryItem ObjectType = "inventory_item"
	// ObjectTypeAnalyzeWeeksOfSalesResponse indicates that the object is a weeks of sales analytics response.
	ObjectTypeAnalyzeWeeksOfSalesResponse ObjectType = "analyze_weeks_of_sales_response"
	// ObjectTypeBulkReconcileItemsResponse indicates that the object is a bulk reconcile items response.
	ObjectTypeBulkReconcileItemsResponse ObjectType = "bulk_reconcile_items_response"
	// ObjectTypeSysProperty indicates that the object is a system property.
	ObjectTypeSysProperty ObjectType = "sys_property"
	// ObjectTypeSysPropertyType indicates that the object is a system property type.
	ObjectTypeSysPropertyType ObjectType = "sys_property_type"
	// ObjectTypeSysPropertyValue indicates that the object is a system property value.
	ObjectTypeSysPropertyValue ObjectType = "sys_property_value"
	// ObjectTypeTerritory indicates that the object is a territory.
	ObjectTypeTerritory ObjectType = "territory"
	// ObjectTypeTenancy indicates that the object is a tenancy.
	ObjectTypeTenancy ObjectType = "tenancy"
	// ObjectTypeCheckoutSession indicates that the object is a checkout session.
	ObjectTypeCheckoutSession ObjectType = "checkout_session"
	// ObjectTypeEstimateRateResult indicates that the object is an estimate rate result.
	ObjectTypeEstimateRateResult ObjectType = "estimate_rate_result"
	// ObjectTypeRateShopOption indicates that the object is a rate shop option.
	ObjectTypeRateShopOption ObjectType = "rate_shop_option"
	// ObjectTypeRateShopResult indicates that the object is a rate shop result.
	ObjectTypeRateShopResult ObjectType = "rate_shop_result"
	// ObjectTypeOwner indicates that the object is a resource owner.
	ObjectTypeOwner ObjectType = "owner"
	// ObjectTypeCreatedBy indicates that the object describes who created a resource.
	ObjectTypeCreatedBy ObjectType = "created_by"
	// ObjectTypeMessage indicates a simple human-readable status message payload.
	ObjectTypeMessage ObjectType = "message"
	// ObjectTypeAccountPhotoUploadResult indicates that the object is an account photo upload result.
	ObjectTypeAccountPhotoUploadResult ObjectType = "account_photo_upload_result"
	// ObjectTypeUserPhotoUploadResult indicates that the object is a user photo upload result.
	ObjectTypeUserPhotoUploadResult ObjectType = "user_photo_upload_result"
	// ObjectTypeUserPhotoURL indicates that the object is a user photo URL response.
	ObjectTypeUserPhotoURL ObjectType = "user_photo_url"
	// ObjectTypeBatchLot indicates that the object is a batch lot.
	ObjectTypeBatchLot ObjectType = "batch_lot"
	// ObjectTypeCheckDuplicateResult indicates that the object is a duplicate check result.
	ObjectTypeCheckDuplicateResult ObjectType = "check_duplicate_result"
	// ObjectTypeItemTrendPoint indicates that the object is an item trend data point.
	ObjectTypeItemTrendPoint ObjectType = "item_trend_point"
	// ObjectTypeTenancyPendingRegistration indicates that the object is a pending registration on a tenancy.
	ObjectTypeTenancyPendingRegistration ObjectType = "tenancy_pending_registration"
	// ObjectTypeInvoiceAllocationEntry indicates that the object is an invoice allocation entry on an open credit.
	ObjectTypeInvoiceAllocationEntry ObjectType = "invoice_allocation_entry"
	// ObjectTypeAllocationCustomer indicates that the object is a minimal customer sub-resource on an allocation entry.
	ObjectTypeAllocationCustomer ObjectType = "allocation_customer"
	// ObjectTypeCheckoutSalesOrderResponse indicates that the object is a sales order checkout response.
	ObjectTypeCheckoutSalesOrderResponse ObjectType = "checkout_sales_order"
	// ObjectTypeSalesOrderPriceQuote indicates that the object is a sales order line price quote.
	ObjectTypeSalesOrderPriceQuote ObjectType = "sales_order_price_quote"
	// ObjectTypeJob indicates that the object is a job.
	ObjectTypeJob ObjectType = "job"
	// ObjectTypeJobResult indicates that the object is what one row of a job's request produced.
	ObjectTypeJobResult ObjectType = "job_result"
	// ObjectTypeJobExport indicates that the object is a completed export job's download.
	ObjectTypeJobExport ObjectType = "job_export"
	// ObjectTypeSalesOrderFreightQuote indicates that the object is a sales order freight (shipping) charge quote.
	ObjectTypeSalesOrderFreightQuote ObjectType = "sales_order_freight_quote"
	// ObjectTypeSalesOrderCommitmentQuote indicates that the object is a preview of the ship-by date a set of commitment inputs would produce.
	ObjectTypeSalesOrderCommitmentQuote ObjectType = "sales_order_commitment_quote"
	// ObjectTypeOperatingCalendar indicates that the object is a set of days one party to a shipment operates.
	ObjectTypeOperatingCalendar ObjectType = "operating_calendar"
	// ObjectTypeOperatingCalendarClosure indicates that the object is one date an operating calendar is shut.
	ObjectTypeOperatingCalendarClosure ObjectType = "operating_calendar_closure"
	// ObjectTypeSalesOrderPriceQuoteLine indicates that the object is a single priced line within a sales order price quote.
	ObjectTypeSalesOrderPriceQuoteLine ObjectType = "sales_order_price_quote_line"
	// ObjectTypePackList indicates that the object is an assembled pack-list document for a shipment.
	ObjectTypePackList ObjectType = "pack_list"
	// ObjectTypePackListParty indicates that the object is a bill-to or ship-to party on a pack list.
	ObjectTypePackListParty ObjectType = "pack_list_party"
	// ObjectTypePackListLineItem indicates that the object is a packed line item on a pack list.
	ObjectTypePackListLineItem ObjectType = "pack_list_line_item"
	// ObjectTypePackListBackOrder indicates that the object is a back-ordered line on a pack list.
	ObjectTypePackListBackOrder ObjectType = "pack_list_back_order"
	// ObjectTypePackListCase indicates that the object is a shipping case on a pack list.
	ObjectTypePackListCase ObjectType = "pack_list_case"
	// ObjectTypeAnalyzeCustomerPricingResponse indicates that the object is an analyze customer pricing response.
	ObjectTypeAnalyzeCustomerPricingResponse ObjectType = "analyze_customer_pricing_response"
	// ObjectTypeCustomerPricingFinding indicates that the object is a flagged customer price.
	ObjectTypeCustomerPricingFinding ObjectType = "customer_pricing_finding"
	// ObjectTypeCustomerPricingSummary indicates that the object is a customer pricing analysis summary.
	ObjectTypeCustomerPricingSummary ObjectType = "customer_pricing_summary"
	// ObjectTypeComputedRate indicates that the object is a rate calculated on demand rather than stored.
	ObjectTypeComputedRate ObjectType = "computed_rate"
	// ObjectTypeComputedQuantity indicates that the object is an amount calculated on demand rather than stored.
	ObjectTypeComputedQuantity ObjectType = "computed_quantity"
	// ObjectTypeAnalyzeRealizedMarginsResponse indicates that the object is an analyze realized margins response.
	ObjectTypeAnalyzeRealizedMarginsResponse ObjectType = "analyze_realized_margins_response"
	// ObjectTypeRealizedMarginFinding indicates that the object is a flagged realized trading relationship.
	ObjectTypeRealizedMarginFinding ObjectType = "realized_margin_finding"
	// ObjectTypeRealizedMarginSummary indicates that the object is a realized margin analysis summary.
	ObjectTypeRealizedMarginSummary ObjectType = "realized_margin_summary"
)

func (ObjectType) EnumValues

func (m ObjectType) EnumValues() []string

func (ObjectType) IsValid

func (m ObjectType) IsValid() bool

func (*ObjectType) StringPtr

func (m *ObjectType) StringPtr() *string

type OeeAnomaly

type OeeAnomaly string

OeeAnomaly is a data-quality warning attached to an OEE result.

Modelled as a list of named anomalies rather than one boolean per condition so a new warning does not add another flag to every department in every response.

const (
	// OeeAnomalyPerformanceAboveCapacity indicates performance exceeded 100%, which means a stale ideal cycle time rather than a real result. The raw value is still reported; clamping it would hide the data problem.
	OeeAnomalyPerformanceAboveCapacity OeeAnomaly = "performance_above_capacity"
)

func (OeeAnomaly) EnumValues

func (a OeeAnomaly) EnumValues() []string

func (OeeAnomaly) IsValid

func (a OeeAnomaly) IsValid() bool

func (*OeeAnomaly) StringPtr

func (a *OeeAnomaly) StringPtr() *string

type OeeBucket

type OeeBucket string

OeeBucket is the OEE term a stoppage charges.

OeeBucketNotScheduled is the odd one out: it is removed from the Availability denominator entirely rather than counted as a loss against it, because a machine nobody planned to run has no OEE rather than 0% OEE.

const (
	// OeeBucketAvailability indicates lost run time.
	OeeBucketAvailability OeeBucket = "availability"
	// OeeBucketPerformance indicates minor stops and speed loss.
	OeeBucketPerformance OeeBucket = "performance"
	// OeeBucketQuality indicates rework and holds.
	OeeBucketQuality OeeBucket = "quality"
	// OeeBucketNotScheduled indicates time the machine was never expected to run.
	OeeBucketNotScheduled OeeBucket = "not_scheduled"
)

func (OeeBucket) EnumValues

func (b OeeBucket) EnumValues() []string

func (OeeBucket) IsValid

func (b OeeBucket) IsValid() bool

func (*OeeBucket) StringPtr

func (b *OeeBucket) StringPtr() *string

type OeeMeasurementStatus

type OeeMeasurementStatus string

OeeMeasurementStatus says whether a grouping's OEE was measured from logged downtime or estimated from runtime.

This matters more than it looks: a department with no logged downtime computes Availability as 100%, so its OEE jumps the day downtime logging ships. The status makes an estimate visibly an estimate instead of a suspiciously good measurement.

const (
	// OeeMeasurementStatusMeasured indicates availability came from logged downtime events.
	OeeMeasurementStatusMeasured OeeMeasurementStatus = "measured"
	// OeeMeasurementStatusEstimated indicates no downtime was logged, so availability was inferred.
	OeeMeasurementStatusEstimated OeeMeasurementStatus = "estimated"
)

func (OeeMeasurementStatus) EnumValues

func (s OeeMeasurementStatus) EnumValues() []string

func (OeeMeasurementStatus) IsValid

func (s OeeMeasurementStatus) IsValid() bool

func (*OeeMeasurementStatus) StringPtr

func (s *OeeMeasurementStatus) StringPtr() *string

type OnboardingStatus added in v1.1.6

type OnboardingStatus string

OnboardingStatus is how far an account has progressed through onboarding, and whether it is usable.

const (
	// OnboardingStatusUnclaimed means the account exists but nobody has taken ownership of it yet.
	OnboardingStatusUnclaimed OnboardingStatus = "unclaimed"
	// OnboardingStatusActive means the account is fully set up and usable.
	OnboardingStatusActive OnboardingStatus = "active"
	// OnboardingStatusSuspended means access is temporarily withdrawn, typically for non-payment.
	OnboardingStatusSuspended OnboardingStatus = "suspended"
	// OnboardingStatusDeactivated means the account has been shut down.
	OnboardingStatusDeactivated OnboardingStatus = "deactivated"
)

func (OnboardingStatus) EnumValues added in v1.1.6

func (s OnboardingStatus) EnumValues() []string

func (OnboardingStatus) IsValid added in v1.1.6

func (s OnboardingStatus) IsValid() bool

func (*OnboardingStatus) StringPtr added in v1.1.6

func (s *OnboardingStatus) StringPtr() *string

type OperatingCalendarKind

type OperatingCalendarKind string

OperatingCalendarKind names which side of a shipment a calendar describes. The two are kept in one table because they are the same shape — open weekdays less dated closures — and an account often wants the same holiday set on both.

const (
	// OperatingCalendarKindShip is the days a plant tenders freight to a carrier, and the only kind that carries a pickup cutoff.
	OperatingCalendarKindShip OperatingCalendarKind = "ship"
	// OperatingCalendarKindReceive is the days a customer's dock accepts freight.
	OperatingCalendarKindReceive OperatingCalendarKind = "receive"
)

func (OperatingCalendarKind) EnumValues

func (m OperatingCalendarKind) EnumValues() []string

func (OperatingCalendarKind) IsValid

func (m OperatingCalendarKind) IsValid() bool

func (*OperatingCalendarKind) StringPtr

func (m *OperatingCalendarKind) StringPtr() *string

type OperatorRequirement

type OperatorRequirement string

OperatorRequirement represents operator requirements for a scanning station.

const (
	// OperatorRequirementNone means no special operator requirement.
	OperatorRequirementNone OperatorRequirement = "none"
	// OperatorRequirementMaterialCheck means material check is required.
	OperatorRequirementMaterialCheck OperatorRequirement = "material_check"
)

func (OperatorRequirement) EnumValues

func (o OperatorRequirement) EnumValues() []string

func (OperatorRequirement) IsValid

func (o OperatorRequirement) IsValid() bool

func (*OperatorRequirement) StringPtr

func (o *OperatorRequirement) StringPtr() *string

type OrderDiscountType

type OrderDiscountType string

OrderDiscountType represents the type of discount applied to an order.

const (
	// OrderDiscountTypePercentage indicates a percentage-based discount.
	OrderDiscountTypePercentage OrderDiscountType = "percentage"
	// OrderDiscountTypeAmount indicates a fixed-amount discount.
	OrderDiscountTypeAmount OrderDiscountType = "amount"
)

func (OrderDiscountType) EnumValues

func (m OrderDiscountType) EnumValues() []string

func (OrderDiscountType) IsValid

func (m OrderDiscountType) IsValid() bool

func (*OrderDiscountType) StringPtr

func (m *OrderDiscountType) StringPtr() *string

type OwnerType

type OwnerType string

OwnerType indicates the provenance of a resource.

const (
	// OwnerTypeSystem indicates the resource is a platform-provided system default.
	OwnerTypeSystem OwnerType = "system"
	// OwnerTypeAccount indicates the resource is owned by a specific account.
	OwnerTypeAccount OwnerType = "account"
)

func (OwnerType) EnumValues

func (m OwnerType) EnumValues() []string

func (OwnerType) IsValid

func (m OwnerType) IsValid() bool

func (*OwnerType) StringPtr

func (m *OwnerType) StringPtr() *string

type ParticipantMembership

type ParticipantMembership string

ParticipantMembership is a participant's membership in a conversation.

const (
	// ParticipantMembershipActive is an active member.
	ParticipantMembershipActive ParticipantMembership = "active"
	// ParticipantMembershipLeft means the participant voluntarily left.
	ParticipantMembershipLeft ParticipantMembership = "left"
	// ParticipantMembershipRemoved means an admin removed the participant.
	ParticipantMembershipRemoved ParticipantMembership = "removed"
	// ParticipantMembershipHidden means the participant hid the conversation.
	ParticipantMembershipHidden ParticipantMembership = "hidden"
)

func (ParticipantMembership) EnumValues

func (s ParticipantMembership) EnumValues() []string

func (ParticipantMembership) IsValid

func (s ParticipantMembership) IsValid() bool

func (*ParticipantMembership) StringPtr

func (s *ParticipantMembership) StringPtr() *string

type ParticipantNotifications

type ParticipantNotifications string

ParticipantNotifications is a participant's notification preference for a conversation. It is an enum (not a boolean) so finer-grained levels (e.g. mentions-only, muted-until) can be added without a breaking change to the API.

const (
	// ParticipantNotificationsUnmuted means the participant receives normal notifications.
	ParticipantNotificationsUnmuted ParticipantNotifications = "unmuted"
	// ParticipantNotificationsMuted means the participant has muted the conversation.
	ParticipantNotificationsMuted ParticipantNotifications = "muted"
)

func ParticipantNotificationsFromMuted

func ParticipantNotificationsFromMuted(muted bool) ParticipantNotifications

ParticipantNotificationsFromMuted maps the persisted boolean to its notifications enum.

func (ParticipantNotifications) EnumValues

func (s ParticipantNotifications) EnumValues() []string

func (ParticipantNotifications) IsValid

func (s ParticipantNotifications) IsValid() bool

func (*ParticipantNotifications) StringPtr

func (s *ParticipantNotifications) StringPtr() *string

type ParticipantRole

type ParticipantRole string

ParticipantRole is a participant's permission level within a conversation.

const (
	// ParticipantRoleOwner can rename/delete, manage members and roles.
	ParticipantRoleOwner ParticipantRole = "owner"
	// ParticipantRoleAdmin can add/remove members and rename.
	ParticipantRoleAdmin ParticipantRole = "admin"
	// ParticipantRoleMember can post, leave, mute, react.
	ParticipantRoleMember ParticipantRole = "member"
	// ParticipantRoleViewer is read-only.
	ParticipantRoleViewer ParticipantRole = "viewer"
)

func (ParticipantRole) EnumValues

func (r ParticipantRole) EnumValues() []string

func (ParticipantRole) IsValid

func (r ParticipantRole) IsValid() bool

func (*ParticipantRole) StringPtr

func (r *ParticipantRole) StringPtr() *string

type ParticipantType

type ParticipantType string

ParticipantType identifies what kind of actor a conversation participant is.

const (
	// ParticipantTypeUser is an account user participant.
	ParticipantTypeUser ParticipantType = "user"
	// ParticipantTypeAgent is an AI agent participant.
	ParticipantTypeAgent ParticipantType = "agent"
	// ParticipantTypeSystem is the system pseudo-participant.
	ParticipantTypeSystem ParticipantType = "system"
	// ParticipantTypeCustomer is a customer relation participant (cross-account, no account_user), keyed by the customer's account in a customer-audience portal support case.
	ParticipantTypeCustomer ParticipantType = "customer"
)

func (ParticipantType) EnumValues

func (t ParticipantType) EnumValues() []string

func (ParticipantType) IsValid

func (t ParticipantType) IsValid() bool

func (*ParticipantType) StringPtr

func (t *ParticipantType) StringPtr() *string

type ParticipationStatus

type ParticipationStatus string

ParticipationStatus says whether a resource takes part in planning.

Machines are selected by department — the room that sets the pace of the factory — so this does not opt one in. It takes one out: a machine down for a rebuild should not have campaigns planned onto it, and the absence of a setting has to mean "planned" or adding a machine to the department would quietly do nothing.

const (
	// ParticipationStatusIncluded indicates the resource is planned, which is the default for anything in the constraint department.
	ParticipationStatusIncluded ParticipationStatus = "included"
	// ParticipationStatusExcluded indicates the resource is deliberately left out of planning.
	ParticipationStatusExcluded ParticipationStatus = "excluded"
)

func ParticipationStatusOf

func ParticipationStatusOf(isExcluded bool) ParticipationStatus

ParticipationStatusOf maps the stored exclusion flag onto the status.

func (ParticipationStatus) EnumValues

func (s ParticipationStatus) EnumValues() []string

func (ParticipationStatus) IsValid

func (s ParticipationStatus) IsValid() bool

func (*ParticipationStatus) StringPtr

func (s *ParticipationStatus) StringPtr() *string

type PaymentTermStatus

type PaymentTermStatus string

PaymentTermStatus represents the status of a payment term.

const (
	// PaymentTermStatusActive indicates that the payment term is active and can be used.
	PaymentTermStatusActive PaymentTermStatus = "active"
	// PaymentTermStatusInactive indicates that the payment term is inactive and cannot be used.
	PaymentTermStatusInactive PaymentTermStatus = "inactive"
)

func (PaymentTermStatus) EnumValues

func (s PaymentTermStatus) EnumValues() []string

func (PaymentTermStatus) IsValid

func (s PaymentTermStatus) IsValid() bool

func (*PaymentTermStatus) StringPtr

func (s *PaymentTermStatus) StringPtr() *string

type PickSort

type PickSort string

Names the order a list of picks comes back in.

const (
	// Orders by the sales order's delivery commitment, soonest first, so the floor sees the most urgent work at the top. Picks whose order has no ship-by date sort last.
	PickSortShipByDate PickSort = "ship_by_date"
	// Orders by when the pick was created, newest first.
	PickSortCreatedAt PickSort = "created_at"
)

func (PickSort) EnumValues

func (s PickSort) EnumValues() []string

func (PickSort) IsValid

func (s PickSort) IsValid() bool

func (*PickSort) StringPtr

func (s *PickSort) StringPtr() *string

type PickStatus added in v1.1.6

type PickStatus string

PickStatus filters a list of picks by whether the pick has been finished.

const (
	// PickStatusOpen returns picks that have not been finished.
	PickStatusOpen PickStatus = "open"
	// PickStatusClosed returns picks that have been finished.
	PickStatusClosed PickStatus = "closed"
)

func (PickStatus) EnumValues added in v1.1.6

func (s PickStatus) EnumValues() []string

func (PickStatus) IsValid added in v1.1.6

func (s PickStatus) IsValid() bool

func (*PickStatus) StringPtr added in v1.1.6

func (s *PickStatus) StringPtr() *string

type PlanCode

type PlanCode string

PlanCode represents the category of a plan.

const (
	// PlanCodeFree indicates that the plan is a free plan.
	PlanCodeFree PlanCode = "free"
	// PlanCodeStarter indicates that the plan is a starter plan.
	PlanCodeStarter PlanCode = "starter"
	// PlanCodePro indicates that the plan is a pro plan.
	PlanCodePro PlanCode = "pro"
	// PlanCodeEnterprise indicates that the plan is an enterprise plan.
	PlanCodeEnterprise PlanCode = "enterprise"
	// PlanCodeEnterpriseTemplate indicates that the plan is an enterprise template plan. In practice, we only use the template plan for display purposes.
	PlanCodeEnterpriseTemplate PlanCode = "enterprise_template"
)

func (PlanCode) EnumValues

func (p PlanCode) EnumValues() []string

func (PlanCode) IsValid

func (p PlanCode) IsValid() bool

func (*PlanCode) StringPtr

func (p *PlanCode) StringPtr() *string

type PlatformMode

type PlatformMode string

PlatformMode represents the mode the server is running in.

const (
	// PlatformModeProduction indicates that the server is running in production mode. This is the default mode and should be used for all production environments.
	PlatformModeProduction PlatformMode = "production"
	// PlatformModeDevelopment indicates that the server is running in development mode. This mode is somewhat more permissive and has guardrails to mock some application behaviors for testing and development purposes.
	PlatformModeDevelopment PlatformMode = "development"
	// PlatformModeTest indicates that the server is running in test mode. Third-party integrations (Stripe, AWS, Google Maps, etc.) are replaced with no-op stubs.
	PlatformModeTest PlatformMode = "test"
)

func (PlatformMode) EnumValues

func (m PlatformMode) EnumValues() []string

func (PlatformMode) IsDevelopment

func (m PlatformMode) IsDevelopment() bool

func (PlatformMode) IsProduction

func (m PlatformMode) IsProduction() bool

func (PlatformMode) IsTest

func (m PlatformMode) IsTest() bool

func (PlatformMode) IsValid

func (m PlatformMode) IsValid() bool

func (*PlatformMode) StringPtr

func (m *PlatformMode) StringPtr() *string

type PortalDomainStatus

type PortalDomainStatus string

PortalDomainStatus is the verification status of a customer portal custom domain.

const (
	// PortalDomainStatusPending indicates the domain is registered and awaiting correct DNS configuration.
	PortalDomainStatusPending PortalDomainStatus = "pending"
	// PortalDomainStatusSecuring indicates DNS is configured correctly and the serving provider is issuing the domain's TLS certificate. The portal is not yet reachable over HTTPS; this clears to verified once the certificate is live.
	PortalDomainStatusSecuring PortalDomainStatus = "securing"
	// PortalDomainStatusVerified indicates the domain's DNS is confirmed, its TLS certificate is live, and the portal is served on it.
	PortalDomainStatusVerified PortalDomainStatus = "verified"
	// PortalDomainStatusFailed indicates the domain was terminally rejected and cannot be used.
	PortalDomainStatusFailed PortalDomainStatus = "failed"
)

func (PortalDomainStatus) EnumValues

func (s PortalDomainStatus) EnumValues() []string

func (PortalDomainStatus) IsValid

func (s PortalDomainStatus) IsValid() bool

func (*PortalDomainStatus) StringPtr

func (s *PortalDomainStatus) StringPtr() *string

type PortalRegistrationStatus

type PortalRegistrationStatus string

PortalRegistrationStatus is the lifecycle state of a buyer's customer-portal registration session, derived from its completion/abandonment timestamps and the resume TTL. It lets customer service see which registrations stalled so they can follow up.

const (
	// PortalRegistrationStatusInProgress indicates an incomplete session still within its resume window.
	PortalRegistrationStatusInProgress PortalRegistrationStatus = "in_progress"
	// PortalRegistrationStatusCompleted indicates the buyer finished registering.
	PortalRegistrationStatusCompleted PortalRegistrationStatus = "completed"
	// PortalRegistrationStatusAbandoned indicates the buyer explicitly abandoned the session.
	PortalRegistrationStatusAbandoned PortalRegistrationStatus = "abandoned"
	// PortalRegistrationStatusExpired indicates an incomplete session whose resume window has elapsed.
	PortalRegistrationStatusExpired PortalRegistrationStatus = "expired"
)

func (PortalRegistrationStatus) EnumValues

func (s PortalRegistrationStatus) EnumValues() []string

func (PortalRegistrationStatus) IsValid

func (s PortalRegistrationStatus) IsValid() bool

func (*PortalRegistrationStatus) StringPtr

func (s *PortalRegistrationStatus) StringPtr() *string

type PortalRegistrationStep

type PortalRegistrationStep string

PortalRegistrationStep represents the step of a buyer's customer-portal registration.

const (
	// PortalRegistrationStepCustomerDetails indicates the buyer is choosing existing-vs-new and providing customer details (name, group, terms).
	PortalRegistrationStepCustomerDetails PortalRegistrationStep = "customer_details"
	// PortalRegistrationStepBillingAddress indicates the buyer is providing a billing address.
	PortalRegistrationStepBillingAddress PortalRegistrationStep = "billing_address"
	// PortalRegistrationStepContact indicates the buyer is providing contact information.
	PortalRegistrationStepContact PortalRegistrationStep = "contact"
	// PortalRegistrationStepCompleted indicates the registration has completed.
	PortalRegistrationStepCompleted PortalRegistrationStep = "completed"
)

func (PortalRegistrationStep) EnumValues

func (s PortalRegistrationStep) EnumValues() []string

func (PortalRegistrationStep) IsAfter

IsAfter returns true if this step comes after the other step in the flow.

func (PortalRegistrationStep) IsValid

func (s PortalRegistrationStep) IsValid() bool

func (PortalRegistrationStep) Ordinal

func (s PortalRegistrationStep) Ordinal() int

Ordinal returns the numeric ordering of a step. Higher values indicate later steps.

func (*PortalRegistrationStep) StringPtr

func (s *PortalRegistrationStep) StringPtr() *string

type PricingFindingReason

type PricingFindingReason string

PricingFindingReason names why a price was flagged. The analysis runs two independent checks and a finding is only produced when at least one fails, so the values enumerate every combination that can actually occur.

const (
	// PricingFindingReasonBelowPeerMedian indicates that the price sits far enough below what comparable customers pay to be flagged, but still clears the target gross margin.
	PricingFindingReasonBelowPeerMedian PricingFindingReason = "below_peer_median"
	// PricingFindingReasonBelowTargetMargin indicates that the price fails to clear the target gross margin, but is not unusually low against comparable customers.
	PricingFindingReasonBelowTargetMargin PricingFindingReason = "below_target_margin"
	// PricingFindingReasonBelowPeerMedianAndTargetMargin indicates that the price is both unusually low against comparable customers and fails to clear the target gross margin.
	PricingFindingReasonBelowPeerMedianAndTargetMargin PricingFindingReason = "below_peer_median_and_target_margin"
)

func (PricingFindingReason) EnumValues

func (m PricingFindingReason) EnumValues() []string

func (PricingFindingReason) IsValid

func (m PricingFindingReason) IsValid() bool

func (*PricingFindingReason) StringPtr

func (m *PricingFindingReason) StringPtr() *string

type PriorityCode

type PriorityCode string

PriorityCode represents the code of a priority level.

const (
	// PriorityCodeLow indicates a low priority.
	PriorityCodeLow PriorityCode = "low"
	// PriorityCodeNormal indicates a normal priority.
	PriorityCodeNormal PriorityCode = "normal"
	// PriorityCodeHigh indicates a high priority.
	PriorityCodeHigh PriorityCode = "high"
)

func (PriorityCode) EnumValues

func (m PriorityCode) EnumValues() []string

func (PriorityCode) IsValid

func (m PriorityCode) IsValid() bool

func (*PriorityCode) StringPtr

func (m *PriorityCode) StringPtr() *string

type ProductTypeCode

type ProductTypeCode string

ProductTypeCode represents the type code of a product.

const (
	// ProductTypeCodeSale indicates a sellable product.
	ProductTypeCodeSale ProductTypeCode = "sale"
	// ProductTypeCodeService indicates a service product.
	ProductTypeCodeService ProductTypeCode = "service"
	// ProductTypeCodeShipping indicates a shipping charge product.
	ProductTypeCodeShipping ProductTypeCode = "shipping"
	// ProductTypeCodeCredit indicates a credit product.
	ProductTypeCodeCredit ProductTypeCode = "credit"
	// ProductTypeCodeReturn indicates a return product.
	ProductTypeCodeReturn ProductTypeCode = "return"
	// ProductTypeCodeTax indicates a tax product.
	ProductTypeCodeTax ProductTypeCode = "tax"
)

func (ProductTypeCode) EnumValues

func (m ProductTypeCode) EnumValues() []string

func (ProductTypeCode) IsValid

func (m ProductTypeCode) IsValid() bool

func (*ProductTypeCode) StringPtr

func (m *ProductTypeCode) StringPtr() *string

type ProductionRunStatus added in v1.1.6

type ProductionRunStatus string

ProductionRunStatus filters a list of production runs by whether the run has completed.

const (
	// ProductionRunStatusOpen returns runs that still have batches left to scan.
	ProductionRunStatusOpen ProductionRunStatus = "open"
	// ProductionRunStatusClosed returns runs whose batches have all been scanned or deleted.
	ProductionRunStatusClosed ProductionRunStatus = "closed"
)

func (ProductionRunStatus) EnumValues added in v1.1.6

func (s ProductionRunStatus) EnumValues() []string

func (ProductionRunStatus) IsValid added in v1.1.6

func (s ProductionRunStatus) IsValid() bool

func (*ProductionRunStatus) StringPtr added in v1.1.6

func (s *ProductionRunStatus) StringPtr() *string

type ProductionScheduleLineStatus

type ProductionScheduleLineStatus string

ProductionScheduleLineStatus is the progress of one planned campaign.

const (
	// ProductionScheduleLineStatusPlanned indicates the campaign has not been released to the floor.
	ProductionScheduleLineStatusPlanned ProductionScheduleLineStatus = "planned"
	// ProductionScheduleLineStatusReleased indicates the campaign has been released to the floor.
	ProductionScheduleLineStatusReleased ProductionScheduleLineStatus = "released"
	// ProductionScheduleLineStatusInProgress indicates the campaign is being run.
	ProductionScheduleLineStatusInProgress ProductionScheduleLineStatus = "in_progress"
	// ProductionScheduleLineStatusComplete indicates the campaign finished.
	ProductionScheduleLineStatusComplete ProductionScheduleLineStatus = "complete"
	// ProductionScheduleLineStatusCancelled indicates the campaign will not be run.
	ProductionScheduleLineStatusCancelled ProductionScheduleLineStatus = "cancelled"
)

func (ProductionScheduleLineStatus) EnumValues

func (s ProductionScheduleLineStatus) EnumValues() []string

func (ProductionScheduleLineStatus) IsValid

func (s ProductionScheduleLineStatus) IsValid() bool

func (*ProductionScheduleLineStatus) StringPtr

func (s *ProductionScheduleLineStatus) StringPtr() *string

type ProductionScheduleStatus

type ProductionScheduleStatus string

ProductionScheduleStatus is the lifecycle state of a schedule version.

const (
	// ProductionScheduleStatusDraft indicates the version is still editable and commits to nothing.
	ProductionScheduleStatusDraft ProductionScheduleStatus = "draft"
	// ProductionScheduleStatusGenerating indicates the solver is still building the version.
	ProductionScheduleStatusGenerating ProductionScheduleStatus = "generating"
	// ProductionScheduleStatusPublished indicates the version is live and its frozen weeks are committed.
	ProductionScheduleStatusPublished ProductionScheduleStatus = "published"
	// ProductionScheduleStatusSuperseded indicates a later version replaced this one over the same horizon.
	ProductionScheduleStatusSuperseded ProductionScheduleStatus = "superseded"
	// ProductionScheduleStatusArchived indicates the version was retired without being replaced.
	ProductionScheduleStatusArchived ProductionScheduleStatus = "archived"
	// ProductionScheduleStatusFailed indicates the solver could not produce a plan.
	ProductionScheduleStatusFailed ProductionScheduleStatus = "failed"
)

func (ProductionScheduleStatus) EnumValues

func (s ProductionScheduleStatus) EnumValues() []string

func (ProductionScheduleStatus) IsValid

func (s ProductionScheduleStatus) IsValid() bool

func (*ProductionScheduleStatus) StringPtr

func (s *ProductionScheduleStatus) StringPtr() *string

type Protocol

type Protocol string

Protocol is the transport protocol.

const (
	// ProtocolHTTP is the HTTP protocol
	ProtocolHTTP Protocol = "http"
	// ProtocolGRPC is the GRPC protocol.
	ProtocolGRPC Protocol = "grpc"
)

func (Protocol) EnumValues

func (p Protocol) EnumValues() []string

func (Protocol) IsValid

func (p Protocol) IsValid() bool

func (Protocol) Normalize

func (p Protocol) Normalize() Protocol

func (*Protocol) StringPtr

func (p *Protocol) StringPtr() *string

type PublicPlanCode

type PublicPlanCode string

PublicPlanCode is the public facing code for a plan.

const (
	// PublicPlanCodeFree indicates that the plan is a free plan.
	PublicPlanCodeFree PublicPlanCode = "free"
	// PublicPlanCodeStarter indicates that the plan is a starter plan.
	PublicPlanCodeStarter PublicPlanCode = "starter"
	// PublicPlanCodePro indicates that the plan is a pro plan.
	PublicPlanCodePro PublicPlanCode = "pro"
)

func (PublicPlanCode) EnumValues

func (p PublicPlanCode) EnumValues() []string

func (PublicPlanCode) IsValid

func (p PublicPlanCode) IsValid() bool

func (*PublicPlanCode) StringPtr

func (p *PublicPlanCode) StringPtr() *string

type ReceivingOrderStatus added in v1.1.6

type ReceivingOrderStatus string

ReceivingOrderStatus filters a list of receiving orders by completion.

const (
	// ReceivingOrderStatusOpen returns orders that have not been completed.
	ReceivingOrderStatusOpen ReceivingOrderStatus = "open"
	// ReceivingOrderStatusCompleted returns orders that have been completed.
	ReceivingOrderStatusCompleted ReceivingOrderStatus = "completed"
	// ReceivingOrderStatusAll returns orders in either state.
	ReceivingOrderStatusAll ReceivingOrderStatus = "all"
)

func (ReceivingOrderStatus) EnumValues added in v1.1.6

func (s ReceivingOrderStatus) EnumValues() []string

func (ReceivingOrderStatus) IsValid added in v1.1.6

func (s ReceivingOrderStatus) IsValid() bool

func (*ReceivingOrderStatus) StringPtr added in v1.1.6

func (s *ReceivingOrderStatus) StringPtr() *string

type RecordType

type RecordType string

RecordType represents the kind of business record referenced by a Record.

const (
	// RecordTypeSalesOrder indicates that the record is a sales order.
	RecordTypeSalesOrder RecordType = "sales_order"
	// RecordTypePurchaseOrder indicates that the record is a purchase order.
	RecordTypePurchaseOrder RecordType = "purchase_order"
	// RecordTypeReceivingOrder indicates that the record is a receiving order.
	RecordTypeReceivingOrder RecordType = "receiving_order"
	// RecordTypePick indicates that the record is a pick.
	RecordTypePick RecordType = "pick"
	// RecordTypeShipment indicates that the record is a shipment.
	RecordTypeShipment RecordType = "shipment"
	// RecordTypeDelivery indicates that the record is a delivery.
	RecordTypeDelivery RecordType = "delivery"
	// RecordTypeProductionRun indicates that the record is a production run.
	RecordTypeProductionRun RecordType = "production_run"
	// RecordTypeInvoice indicates that the record is an invoice.
	RecordTypeInvoice RecordType = "invoice"
	// RecordTypeTransaction indicates that the record is a transaction.
	RecordTypeTransaction RecordType = "transaction"
	// RecordTypeSettlement indicates that the record is a settlement.
	RecordTypeSettlement RecordType = "settlement"
)

func (RecordType) EnumValues

func (m RecordType) EnumValues() []string

func (RecordType) IsValid

func (m RecordType) IsValid() bool

func (*RecordType) StringPtr

func (m *RecordType) StringPtr() *string

type RegistrationLimits

type RegistrationLimits struct {
	PublicLimit int64
	TotalLimit  int64
}

RegistrationLimits defines the per-plan-code caps on how many accounts can register. PublicLimit restricts registrations that arrive without an invitation token. TotalLimit caps all registrations (public + invited) combined. Both limits are checked against non-sandbox accounts only.

func GetRegistrationLimits

func GetRegistrationLimits(planCode PlanCode) RegistrationLimits

GetRegistrationLimits returns the registration limits for a plan code. Returns zero limits (effectively closed) for unrecognized plan codes.

type RegistrationStep

type RegistrationStep string

RegistrationStep represents the step of the registration process.

const (
	// RegistrationStepVerification indicates that the user is verifying their email address.
	RegistrationStepVerification RegistrationStep = "verification"
	// RegistrationStepUserDetails indicates that the user is providing their user details.
	RegistrationStepUserDetails RegistrationStep = "user_details"
	// RegistrationStepAccountDetails indicates that the user is providing their account details.
	RegistrationStepAccountDetails RegistrationStep = "account_details"
	// RegistrationStepReview indicates that the user is reviewing their registration details.
	RegistrationStepReview RegistrationStep = "review"
	// RegistrationStepPayment indicates that the user is providing their payment details.
	RegistrationStepPayment RegistrationStep = "payment"
	// RegistrationStepCompleted indicates that the user has completed the registration process.
	RegistrationStepCompleted RegistrationStep = "completed"
)

func (RegistrationStep) EnumValues

func (m RegistrationStep) EnumValues() []string

func (RegistrationStep) IsAfter

func (m RegistrationStep) IsAfter(other RegistrationStep) bool

IsAfter returns true if this step comes after the other step in the flow.

func (RegistrationStep) IsValid

func (m RegistrationStep) IsValid() bool

func (RegistrationStep) Ordinal

func (m RegistrationStep) Ordinal() int

Ordinal returns the numeric ordering of a registration step. Higher values indicate later steps in the flow.

func (*RegistrationStep) StringPtr

func (m *RegistrationStep) StringPtr() *string

type RemovedResourceScope

type RemovedResourceScope string

RemovedResourceScope controls whether removed resources are included in a list.

const (
	// RemovedResourceScopeExcluded omits removed resources.
	RemovedResourceScopeExcluded RemovedResourceScope = "excluded"
	// RemovedResourceScopeIncluded includes removed resources.
	RemovedResourceScopeIncluded RemovedResourceScope = "included"
)

func (RemovedResourceScope) EnumValues

func (m RemovedResourceScope) EnumValues() []string

func (RemovedResourceScope) IsValid

func (m RemovedResourceScope) IsValid() bool

func (*RemovedResourceScope) StringPtr

func (m *RemovedResourceScope) StringPtr() *string

type ReplyDraftStatus

type ReplyDraftStatus string

ReplyDraftStatus is the lifecycle of a structured customer-reply draft. Draft-first is the safe default: an agent or user proposes (Draft); a human approves & sends (Sent) or discards (Rejected). Superseded marks a draft stale (its source thread changed) so it can no longer be sent.

const (
	// ReplyDraftStatusDraft is an open, editable draft awaiting review.
	ReplyDraftStatusDraft ReplyDraftStatus = "draft"
	// ReplyDraftStatusApproved is reserved for a two-step approve-then-send flow (approved, not yet sent).
	ReplyDraftStatusApproved ReplyDraftStatus = "approved"
	// ReplyDraftStatusSent has been materialized into a customer-visible message (and delivered).
	ReplyDraftStatusSent ReplyDraftStatus = "sent"
	// ReplyDraftStatusRejected was discarded without sending.
	ReplyDraftStatusRejected ReplyDraftStatus = "rejected"
	// ReplyDraftStatusSuperseded was invalidated because the thread it was drafted from changed.
	ReplyDraftStatusSuperseded ReplyDraftStatus = "superseded"
)

func (ReplyDraftStatus) EnumValues

func (s ReplyDraftStatus) EnumValues() []string

func (ReplyDraftStatus) IsValid

func (s ReplyDraftStatus) IsValid() bool

func (*ReplyDraftStatus) StringPtr

func (s *ReplyDraftStatus) StringPtr() *string

type ReviewRequirement

type ReviewRequirement string

ReviewRequirement is whether a human must review/approve something before it executes. It is an enum (not a boolean) so additional requirements (e.g. conditional, first-use-only) can be added without a breaking change. It applies both to an individual agent action and to an agent's tool configuration.

const (
	// ReviewRequirementNotRequired means no human review is required before execution (the default).
	ReviewRequirementNotRequired ReviewRequirement = "not_required"
	// ReviewRequirementRequired means a human must review/approve before execution.
	ReviewRequirementRequired ReviewRequirement = "required"
)

func ReviewRequirementFromBool

func ReviewRequirementFromBool(required bool) ReviewRequirement

ReviewRequirementFromBool maps the persisted boolean to its review-requirement enum.

func (ReviewRequirement) EnumValues

func (s ReviewRequirement) EnumValues() []string

func (ReviewRequirement) IsValid

func (s ReviewRequirement) IsValid() bool

func (*ReviewRequirement) StringPtr

func (s *ReviewRequirement) StringPtr() *string

type RoleType

type RoleType string

RoleType represents the type of role a user has.

const (
	// RoleTypeAdmin indicates that the user is an admin.
	RoleTypeAdmin RoleType = "admin"
	// RoleTypeCustom indicates that the role was custom made to fit a particular need.
	RoleTypeCustom RoleType = "user" // ! NOTE: Should update to "custom" in DB and app code
	// RoleTypeScanner indicates that the user is a scanner.
	RoleTypeScanner RoleType = "scanner"
	// RoleTypeSalesRep indicates that the user is a sales rep.
	RoleTypeSalesRep RoleType = "sales_rep"
	// RoleTypeAgent indicates that the role is assigned to an agent.
	RoleTypeAgent RoleType = "agent"
)

func (RoleType) EnumValues

func (m RoleType) EnumValues() []string

func (RoleType) IsValid

func (m RoleType) IsValid() bool

func (*RoleType) StringPtr

func (m *RoleType) StringPtr() *string

type SalesOrderPaymentStatus

type SalesOrderPaymentStatus string

SalesOrderPaymentStatus represents the payment state of a sales order.

const (
	// SalesOrderPaymentStatusUnpaid indicates no payment has been received.
	SalesOrderPaymentStatusUnpaid SalesOrderPaymentStatus = "unpaid"
	// SalesOrderPaymentStatusPartiallyPaid indicates the order is partially paid.
	SalesOrderPaymentStatusPartiallyPaid SalesOrderPaymentStatus = "partially_paid"
	// SalesOrderPaymentStatusPaid indicates the order is paid in full.
	SalesOrderPaymentStatusPaid SalesOrderPaymentStatus = "paid"
)

func (SalesOrderPaymentStatus) EnumValues

func (m SalesOrderPaymentStatus) EnumValues() []string

func (SalesOrderPaymentStatus) IsValid

func (m SalesOrderPaymentStatus) IsValid() bool

func (*SalesOrderPaymentStatus) StringPtr

func (m *SalesOrderPaymentStatus) StringPtr() *string

type SalesOrderStatusChange

type SalesOrderStatusChange string

SalesOrderStatusChange represents a status change action for a sales order.

const (
	// SalesOrderStatusChangeIssue transitions an order from estimate to issued.
	SalesOrderStatusChangeIssue SalesOrderStatusChange = "issue"
	// SalesOrderStatusChangeClose transitions an order from issued to fulfilled.
	SalesOrderStatusChangeClose SalesOrderStatusChange = "close"
	// SalesOrderStatusChangeUnissue transitions an order from issued to estimate.
	SalesOrderStatusChangeUnissue SalesOrderStatusChange = "unissue"
	// SalesOrderStatusChangeOpen transitions an order from fulfilled to issued.
	SalesOrderStatusChangeOpen SalesOrderStatusChange = "open"
)

func (SalesOrderStatusChange) EnumValues

func (m SalesOrderStatusChange) EnumValues() []string

func (SalesOrderStatusChange) IsValid

func (m SalesOrderStatusChange) IsValid() bool

func (*SalesOrderStatusChange) StringPtr

func (m *SalesOrderStatusChange) StringPtr() *string

type SalesOrderStatusCode

type SalesOrderStatusCode string

SalesOrderStatusCode represents the status code of a sales order.

const (
	// SalesOrderStatusCodeEstimate indicates the order is an estimate.
	SalesOrderStatusCodeEstimate SalesOrderStatusCode = "estimate"
	// SalesOrderStatusCodeIssued indicates the order has been issued.
	SalesOrderStatusCodeIssued SalesOrderStatusCode = "issued"
	// SalesOrderStatusCodeFulfilled indicates the order has been fulfilled.
	SalesOrderStatusCodeFulfilled SalesOrderStatusCode = "fulfilled"
)

func (SalesOrderStatusCode) EnumValues

func (m SalesOrderStatusCode) EnumValues() []string

func (SalesOrderStatusCode) IsValid

func (m SalesOrderStatusCode) IsValid() bool

func (*SalesOrderStatusCode) StringPtr

func (m *SalesOrderStatusCode) StringPtr() *string

type SandboxMode

type SandboxMode string

SandboxMode represents how a sandbox environment is initialized.

const (
	// SandboxModeBlank creates an empty sandbox with no pre-populated data.
	SandboxModeBlank SandboxMode = "blank"
	// SandboxModeSeeded creates a sandbox pre-populated with sample data.
	SandboxModeSeeded SandboxMode = "seeded"
)

func (SandboxMode) EnumValues

func (m SandboxMode) EnumValues() []string

func (SandboxMode) IsValid

func (m SandboxMode) IsValid() bool

func (*SandboxMode) StringPtr

func (m *SandboxMode) StringPtr() *string

type ScanningStationType

type ScanningStationType string

ScanningStationType represents the type of a scanning station.

const (
	// ScanningStationTypeInitBatch is the type for initializing a batch.
	ScanningStationTypeInitBatch ScanningStationType = "init_batch"
	// ScanningStationTypeMergeBatch is the type for merging batches.
	ScanningStationTypeMergeBatch ScanningStationType = "merge_batch"
	// ScanningStationTypeMoveBatch is the type for moving a batch.
	ScanningStationTypeMoveBatch ScanningStationType = "move_batch"
	// ScanningStationTypeSplitBatch is the type for splitting a batch.
	ScanningStationTypeSplitBatch ScanningStationType = "split_batch"
)

func (ScanningStationType) EnumValues

func (s ScanningStationType) EnumValues() []string

func (ScanningStationType) IsValid

func (s ScanningStationType) IsValid() bool

func (*ScanningStationType) StringPtr

func (s *ScanningStationType) StringPtr() *string

type ScheduleAtRiskReason

type ScheduleAtRiskReason string

ScheduleAtRiskReason is why a plan does not meet an order's ship-by commitment.

const (
	// ScheduleAtRiskReasonPastDue indicates production needed to start before the plan begins.
	ScheduleAtRiskReasonPastDue ScheduleAtRiskReason = "past_due"
	// ScheduleAtRiskReasonUndated indicates the order carries no ship-by commitment and is treated as owed now.
	ScheduleAtRiskReasonUndated ScheduleAtRiskReason = "undated"
	// ScheduleAtRiskReasonShort indicates the plan projects less stock than the order needs in the week it is needed.
	ScheduleAtRiskReasonShort ScheduleAtRiskReason = "short"
)

func (ScheduleAtRiskReason) EnumValues

func (m ScheduleAtRiskReason) EnumValues() []string

func (ScheduleAtRiskReason) IsValid

func (m ScheduleAtRiskReason) IsValid() bool

func (*ScheduleAtRiskReason) StringPtr

func (m *ScheduleAtRiskReason) StringPtr() *string

type ScheduleChangeReason

type ScheduleChangeReason string

ScheduleChangeReason explains why a plan was changed by hand.

Distinct from ScheduleDeviationType, which names *what* changed about a line. The type is derived from the change itself; the reason is what the person supplies, and only a change inside a frozen week is required to supply one.

const (
	// ScheduleChangeReasonMachineDown indicates the machine the campaign was on stopped running.
	ScheduleChangeReasonMachineDown ScheduleChangeReason = "machine_down"
	// ScheduleChangeReasonMaterialShortage indicates the material the campaign needs did not arrive.
	ScheduleChangeReasonMaterialShortage ScheduleChangeReason = "material_shortage"
	// ScheduleChangeReasonRushOrder indicates demand that could not wait for the next plan.
	ScheduleChangeReasonRushOrder ScheduleChangeReason = "rush_order"
	// ScheduleChangeReasonQualityHold indicates the work was stopped for a quality problem.
	ScheduleChangeReasonQualityHold ScheduleChangeReason = "quality_hold"
	// ScheduleChangeReasonOverRun indicates the floor produced more than the plan asked for.
	ScheduleChangeReasonOverRun ScheduleChangeReason = "over_run"
	// ScheduleChangeReasonUnderRun indicates the floor produced less than the plan asked for.
	ScheduleChangeReasonUnderRun ScheduleChangeReason = "under_run"
	// ScheduleChangeReasonCapacityChange indicates the available machine time changed, such as a shutdown or an added shift.
	ScheduleChangeReasonCapacityChange ScheduleChangeReason = "capacity_change"
	// ScheduleChangeReasonOther indicates a reason outside the list, which should be explained in the note.
	ScheduleChangeReasonOther ScheduleChangeReason = "other"
)

func ScheduleChangeReasonPtr

func ScheduleChangeReasonPtr(value *string) *ScheduleChangeReason

ScheduleChangeReasonPtr converts a stored string into the typed reason, returning nil when there is nothing recorded.

Unknown values are returned as-is rather than dropped: a reason written before a code was retired is still the honest answer to why a plan changed, and silently blanking it would make the deviation log lie.

func (ScheduleChangeReason) EnumValues

func (r ScheduleChangeReason) EnumValues() []string

func (ScheduleChangeReason) IsValid

func (r ScheduleChangeReason) IsValid() bool

func (*ScheduleChangeReason) StringPtr

func (r *ScheduleChangeReason) StringPtr() *string

type ScheduleDemandBasis

type ScheduleDemandBasis string

ScheduleDemandBasis is how demand was derived for a plan.

const (
	// ScheduleDemandBasisTrailing12 indicates demand came from the trailing twelve months of orders.
	ScheduleDemandBasisTrailing12 ScheduleDemandBasis = "trailing_12"
	// ScheduleDemandBasisSeasonalEMA indicates demand came from a seasonal exponential moving average.
	ScheduleDemandBasisSeasonalEMA ScheduleDemandBasis = "seasonal_ema"
)

func (ScheduleDemandBasis) EnumValues

func (b ScheduleDemandBasis) EnumValues() []string

func (ScheduleDemandBasis) IsValid

func (b ScheduleDemandBasis) IsValid() bool

func (*ScheduleDemandBasis) StringPtr

func (b *ScheduleDemandBasis) StringPtr() *string

type ScheduleDeviationType

type ScheduleDeviationType string

ScheduleDeviationType names what changed about a campaign.

const (
	// ScheduleDeviationTypeLineAdded indicates a campaign was added by hand.
	ScheduleDeviationTypeLineAdded ScheduleDeviationType = "line_added"
	// ScheduleDeviationTypeLineRemoved indicates a campaign was removed.
	ScheduleDeviationTypeLineRemoved ScheduleDeviationType = "line_removed"
	// ScheduleDeviationTypeQuantityChanged indicates a campaign's quantity changed.
	ScheduleDeviationTypeQuantityChanged ScheduleDeviationType = "quantity_changed"
	// ScheduleDeviationTypeMachineChanged indicates a campaign moved to another machine.
	ScheduleDeviationTypeMachineChanged ScheduleDeviationType = "machine_changed"
	// ScheduleDeviationTypeResequenced indicates a campaign's position within its week changed.
	ScheduleDeviationTypeResequenced ScheduleDeviationType = "resequenced"
	// ScheduleDeviationTypeWeekMoved indicates a campaign moved to another week.
	ScheduleDeviationTypeWeekMoved ScheduleDeviationType = "week_moved"
)

func (ScheduleDeviationType) EnumValues

func (d ScheduleDeviationType) EnumValues() []string

func (ScheduleDeviationType) IsValid

func (d ScheduleDeviationType) IsValid() bool

func (*ScheduleDeviationType) StringPtr

func (d *ScheduleDeviationType) StringPtr() *string

type ScheduleDiffChange

type ScheduleDiffChange string

ScheduleDiffChange is what a regenerate would do to one campaign.

const (
	// ScheduleDiffChangeAdded indicates a campaign the fresh solve wants that the current plan does not have.
	ScheduleDiffChangeAdded ScheduleDiffChange = "added"
	// ScheduleDiffChangeRemoved indicates a campaign the current plan has that the fresh solve does not want.
	ScheduleDiffChangeRemoved ScheduleDiffChange = "removed"
	// ScheduleDiffChangeChanged indicates a campaign both have, in a different quantity.
	ScheduleDiffChangeChanged ScheduleDiffChange = "changed"
	// ScheduleDiffChangeUnchanged indicates a campaign both agree on.
	ScheduleDiffChangeUnchanged ScheduleDiffChange = "unchanged"
)

func (ScheduleDiffChange) EnumValues

func (c ScheduleDiffChange) EnumValues() []string

func (ScheduleDiffChange) IsValid

func (c ScheduleDiffChange) IsValid() bool

func (*ScheduleDiffChange) StringPtr

func (c *ScheduleDiffChange) StringPtr() *string

type ScheduleFreezeStatus

type ScheduleFreezeStatus string

ScheduleFreezeStatus says whether a campaign or a change sits inside the committed part of a horizon.

const (
	// ScheduleFreezeStatusFrozen indicates the campaign is a commitment; changing it requires a reason.
	ScheduleFreezeStatusFrozen ScheduleFreezeStatus = "frozen"
	// ScheduleFreezeStatusFlexible indicates the campaign is still a plan and can be changed freely.
	ScheduleFreezeStatusFlexible ScheduleFreezeStatus = "flexible"
)

func FreezeStatusOf

func FreezeStatusOf(frozen bool) ScheduleFreezeStatus

FreezeStatusOf maps the stored flag onto the enum the API exposes.

func (ScheduleFreezeStatus) EnumValues

func (f ScheduleFreezeStatus) EnumValues() []string

func (ScheduleFreezeStatus) IsValid

func (f ScheduleFreezeStatus) IsValid() bool

func (*ScheduleFreezeStatus) StringPtr

func (f *ScheduleFreezeStatus) StringPtr() *string

type ScheduleGenerationSource

type ScheduleGenerationSource string

ScheduleGenerationSource records what caused a version to be generated.

const (
	// ScheduleGenerationSourceManual indicates a person asked for the version.
	ScheduleGenerationSourceManual ScheduleGenerationSource = "manual"
	// ScheduleGenerationSourceScheduled indicates the generation cadence produced the version.
	ScheduleGenerationSourceScheduled ScheduleGenerationSource = "scheduled"
)

func (ScheduleGenerationSource) EnumValues

func (s ScheduleGenerationSource) EnumValues() []string

func (ScheduleGenerationSource) IsValid

func (s ScheduleGenerationSource) IsValid() bool

func (*ScheduleGenerationSource) StringPtr

func (s *ScheduleGenerationSource) StringPtr() *string

type ScheduleLineReason

type ScheduleLineReason string

ScheduleLineReason is why the solver planned a campaign.

const (
	// ScheduleLineReasonReorderPoint indicates the item's projected position fell below its statistical trigger.
	ScheduleLineReasonReorderPoint ScheduleLineReason = "reorder_point"
	// ScheduleLineReasonFirmOrder indicates the campaign exists to serve orders already on the book, not a forecast.
	ScheduleLineReasonFirmOrder ScheduleLineReason = "firm_order"
	// ScheduleLineReasonManual indicates the line was added or edited by hand.
	ScheduleLineReasonManual ScheduleLineReason = "manual"
)

func (ScheduleLineReason) EnumValues

func (m ScheduleLineReason) EnumValues() []string

func (ScheduleLineReason) IsValid

func (m ScheduleLineReason) IsValid() bool

func (*ScheduleLineReason) StringPtr

func (m *ScheduleLineReason) StringPtr() *string

type ScheduleLineSource

type ScheduleLineSource string

ScheduleLineSource records who put a campaign on the plan. A regenerate has to be able to tell hand-placed work from solver output.

const (
	// ScheduleLineSourceSolver indicates the campaign came from the scheduling solver.
	ScheduleLineSourceSolver ScheduleLineSource = "solver"
	// ScheduleLineSourceManual indicates the campaign was placed or edited by hand.
	ScheduleLineSourceManual ScheduleLineSource = "manual"
)

func (ScheduleLineSource) EnumValues

func (s ScheduleLineSource) EnumValues() []string

func (ScheduleLineSource) IsValid

func (s ScheduleLineSource) IsValid() bool

func (*ScheduleLineSource) StringPtr

func (s *ScheduleLineSource) StringPtr() *string

type ScheduleMergeMode

type ScheduleMergeMode string

ScheduleMergeMode says what a regenerate does with the hand edits already on a draft.

There is no "preserve frozen" mode because only a published version has frozen lines and a published version is never regenerated in place — it is superseded by publishing a newer one. Regenerating a commitment the floor is already working to would rewrite history rather than replan.

const (
	// ScheduleMergeModePreserveManual keeps every hand-edited campaign and replaces the rest with the fresh solve.
	ScheduleMergeModePreserveManual ScheduleMergeMode = "preserve_manual"
	// ScheduleMergeModeReplaceAll discards every hand edit and takes the fresh solve whole.
	ScheduleMergeModeReplaceAll ScheduleMergeMode = "replace_all"
)

func (ScheduleMergeMode) EnumValues

func (m ScheduleMergeMode) EnumValues() []string

func (ScheduleMergeMode) IsValid

func (m ScheduleMergeMode) IsValid() bool

func (*ScheduleMergeMode) StringPtr

func (m *ScheduleMergeMode) StringPtr() *string

type SchedulePolicyConstraint

type SchedulePolicyConstraint string

SchedulePolicyConstraint names a limit the solver hit while sizing a SKU's campaigns. Modelled as a list of named constraints rather than one boolean per limit so a new limit does not add another flag to every response.

const (
	// SchedulePolicyConstraintEOQCapped indicates the economic order quantity was capped at the maximum weeks of supply.
	SchedulePolicyConstraintEOQCapped SchedulePolicyConstraint = "eoq_capped"
	// SchedulePolicyConstraintCapacityStarved indicates demand exceeded the capacity available to the SKU.
	SchedulePolicyConstraintCapacityStarved SchedulePolicyConstraint = "capacity_starved"
)

func (SchedulePolicyConstraint) EnumValues

func (c SchedulePolicyConstraint) EnumValues() []string

func (SchedulePolicyConstraint) IsValid

func (c SchedulePolicyConstraint) IsValid() bool

func (*SchedulePolicyConstraint) StringPtr

func (c *SchedulePolicyConstraint) StringPtr() *string

type ScheduleResourceScope

type ScheduleResourceScope string

ScheduleResourceScope is what a per-resource planning override attaches to.

const (
	// ScheduleResourceScopeMachine overrides planning for one machine.
	ScheduleResourceScopeMachine ScheduleResourceScope = "machine"
	// ScheduleResourceScopeDepartment overrides planning for one department.
	ScheduleResourceScopeDepartment ScheduleResourceScope = "department"
	// ScheduleResourceScopeProductionStep overrides planning for one production step.
	ScheduleResourceScopeProductionStep ScheduleResourceScope = "production_step"
)

func (ScheduleResourceScope) EnumValues

func (s ScheduleResourceScope) EnumValues() []string

func (ScheduleResourceScope) IsValid

func (s ScheduleResourceScope) IsValid() bool

func (*ScheduleResourceScope) StringPtr

func (s *ScheduleResourceScope) StringPtr() *string

type ScheduledMessageStatus

type ScheduledMessageStatus string

ScheduledMessageStatus is the lifecycle state of a scheduled message. It is an enum so new states can be added without a breaking change to the API.

const (
	// ScheduledMessageStatusPending is queued for delivery at its scheduled time.
	ScheduledMessageStatusPending ScheduledMessageStatus = "pending"
	// ScheduledMessageStatusSent was delivered (sent_message_id points at the resulting message).
	ScheduledMessageStatusSent ScheduledMessageStatus = "sent"
	// ScheduledMessageStatusCanceled was canceled before delivery (by the user, or because the conversation/sender was no longer valid at send time).
	ScheduledMessageStatusCanceled ScheduledMessageStatus = "canceled"
	// ScheduledMessageStatusFailed exhausted delivery attempts.
	ScheduledMessageStatusFailed ScheduledMessageStatus = "failed"
)

func (ScheduledMessageStatus) EnumValues

func (s ScheduledMessageStatus) EnumValues() []string

func (ScheduledMessageStatus) IsValid

func (s ScheduledMessageStatus) IsValid() bool

func (*ScheduledMessageStatus) StringPtr

func (s *ScheduledMessageStatus) StringPtr() *string

type ServiceLevelCode

type ServiceLevelCode string

ServiceLevelCode identifies a shipping service level for a carrier. Values are carrier-specific and user-defined (e.g. "fedex_ground", "ups_next_day_air").

func (ServiceLevelCode) EnumValues

func (c ServiceLevelCode) EnumValues() []string

EnumValues returns an empty slice because ServiceLevelCode values are carrier-specific and user-defined.

func (ServiceLevelCode) IsValid

func (c ServiceLevelCode) IsValid() bool

IsValid returns true if the service level code is non-empty. ServiceLevelCode values are carrier-specific so any non-empty string is valid.

func (*ServiceLevelCode) StringPtr

func (c *ServiceLevelCode) StringPtr() *string

type SettingsStatus

type SettingsStatus string

SettingsStatus says whether a settings resource holds values the merchant saved or the defaults the solver would otherwise apply. Exposed so a settings page can show "using defaults" rather than implying someone chose these numbers.

const (
	// SettingsStatusStored indicates the values were saved by the merchant.
	SettingsStatusStored SettingsStatus = "stored"
	// SettingsStatusDefault indicates the values are the solver's defaults.
	SettingsStatusDefault SettingsStatus = "default"
)

func SettingsStatusOf

func SettingsStatusOf(stored bool) SettingsStatus

SettingsStatusOf maps the stored flag onto the enum the API exposes.

func (SettingsStatus) EnumValues

func (s SettingsStatus) EnumValues() []string

func (SettingsStatus) IsValid

func (s SettingsStatus) IsValid() bool

func (*SettingsStatus) StringPtr

func (s *SettingsStatus) StringPtr() *string

type ShipmentStatus

type ShipmentStatus string

ShipmentStatus represents the status of a shipment.

const (
	// ShipmentStatusPacked indicates that the shipment has been packed.
	ShipmentStatusPacked ShipmentStatus = "packed"
	// ShipmentStatusShipped indicates that the shipment has been shipped.
	ShipmentStatusShipped ShipmentStatus = "shipped"
)

func (ShipmentStatus) EnumValues

func (s ShipmentStatus) EnumValues() []string

func (ShipmentStatus) IsValid

func (s ShipmentStatus) IsValid() bool

func (*ShipmentStatus) StringPtr

func (s *ShipmentStatus) StringPtr() *string

type ShippingTermType

type ShippingTermType string

ShippingTermType represents the freight pricing model for a shipping term.

const (
	// ShippingTermTypeFreeFreight indicates no shipping cost to the buyer.
	ShippingTermTypeFreeFreight ShippingTermType = "free_freight"
	// ShippingTermTypeFlatRateFreight indicates a fixed shipping cost regardless of order details.
	ShippingTermTypeFlatRateFreight ShippingTermType = "flat_rate_freight"
	// ShippingTermTypeCarrierRateFreight indicates shipping cost is determined by the carrier's rate.
	ShippingTermTypeCarrierRateFreight ShippingTermType = "carrier_rate_freight"
)

func (ShippingTermType) EnumValues

func (m ShippingTermType) EnumValues() []string

func (ShippingTermType) IsValid

func (m ShippingTermType) IsValid() bool

func (*ShippingTermType) StringPtr

func (m *ShippingTermType) StringPtr() *string

type StripeConnectionStatus

type StripeConnectionStatus string

StripeConnectionStatus represents whether an account has a Stripe integration configured.

const (
	// StripeConnectionStatusConnected indicates the account has a Stripe integration on file.
	StripeConnectionStatusConnected StripeConnectionStatus = "connected"
	// StripeConnectionStatusNotConnected indicates the account has no Stripe integration.
	StripeConnectionStatusNotConnected StripeConnectionStatus = "not_connected"
)

func StripeConnectionStatusFromExists

func StripeConnectionStatusFromExists(exists bool) StripeConnectionStatus

StripeConnectionStatusFromExists maps the existence boolean to its public status value.

func (StripeConnectionStatus) EnumValues

func (m StripeConnectionStatus) EnumValues() []string

func (StripeConnectionStatus) IsValid

func (m StripeConnectionStatus) IsValid() bool

func (*StripeConnectionStatus) StringPtr

func (m *StripeConnectionStatus) StringPtr() *string

type SubassemblyFilter

type SubassemblyFilter string

SubassemblyFilter controls which items are returned when listing by subassembly scope.

const (
	// SubassemblyFilterAll does not restrict to initial subassemblies only.
	SubassemblyFilterAll SubassemblyFilter = "all"
	// SubassemblyFilterInitialOnly returns only items that are initial subassemblies.
	SubassemblyFilterInitialOnly SubassemblyFilter = "initial_only"
)

func (SubassemblyFilter) EnumValues

func (f SubassemblyFilter) EnumValues() []string

func (SubassemblyFilter) IsValid

func (f SubassemblyFilter) IsValid() bool

func (*SubassemblyFilter) StringPtr

func (f *SubassemblyFilter) StringPtr() *string

type SubscriptionStatus

type SubscriptionStatus string

SubscriptionStatus represents the status of a Stripe subscription.

const (
	// SubscriptionStatusActive indicates the subscription is current and fully paid.
	SubscriptionStatusActive SubscriptionStatus = "active"
	// SubscriptionStatusTrialing indicates the subscription is in a free trial period.
	SubscriptionStatusTrialing SubscriptionStatus = "trialing"
	// SubscriptionStatusPastDue indicates the subscription has an outstanding unpaid invoice.
	SubscriptionStatusPastDue SubscriptionStatus = "past_due"
	// SubscriptionStatusCanceled indicates the subscription has been canceled.
	SubscriptionStatusCanceled SubscriptionStatus = "canceled"
	// SubscriptionStatusUnpaid indicates the subscription is unpaid after exhausting retry attempts.
	SubscriptionStatusUnpaid SubscriptionStatus = "unpaid"
)

func (SubscriptionStatus) EnumValues

func (s SubscriptionStatus) EnumValues() []string

func (SubscriptionStatus) IsValid

func (s SubscriptionStatus) IsValid() bool

func (SubscriptionStatus) String

func (s SubscriptionStatus) String() string

func (*SubscriptionStatus) StringPtr

func (s *SubscriptionStatus) StringPtr() *string

type SupplierMaterialStatus

type SupplierMaterialStatus string

SupplierMaterialStatus represents whether a supplier material link is active.

const (
	// SupplierMaterialStatusActive indicates the supplier material is active.
	SupplierMaterialStatusActive SupplierMaterialStatus = "active"
	// SupplierMaterialStatusInactive indicates the supplier material is inactive.
	SupplierMaterialStatusInactive SupplierMaterialStatus = "inactive"
)

func (SupplierMaterialStatus) EnumValues

func (s SupplierMaterialStatus) EnumValues() []string

func (SupplierMaterialStatus) IsValid

func (s SupplierMaterialStatus) IsValid() bool

func (*SupplierMaterialStatus) StringPtr

func (s *SupplierMaterialStatus) StringPtr() *string

type SysPropertyTypeCode

type SysPropertyTypeCode string

SysPropertyTypeCode represents the code for a system property type.

const (
	// SysPropertyTypeCodeTransactionNumber is the type code for transaction numbers.
	SysPropertyTypeCodeTransactionNumber SysPropertyTypeCode = "transaction_number"
	// SysPropertyTypeCodeSettlementNumber is the type code for settlement numbers.
	SysPropertyTypeCodeSettlementNumber SysPropertyTypeCode = "settlement_number"
	// SysPropertyTypeCodeSalesOrderNumber is the type code for sales order numbers.
	SysPropertyTypeCodeSalesOrderNumber SysPropertyTypeCode = "sales_order_number"
	// SysPropertyTypeCodePurchaseOrderNumber is the type code for purchase order numbers.
	SysPropertyTypeCodePurchaseOrderNumber SysPropertyTypeCode = "purchase_order_number"
	// SysPropertyTypeCodeSupplierNumber is the type code for supplier numbers.
	SysPropertyTypeCodeSupplierNumber SysPropertyTypeCode = "supplier_number"
	// SysPropertyTypeCodeCustomerNumber is the type code for customer numbers.
	SysPropertyTypeCodeCustomerNumber SysPropertyTypeCode = "customer_number"
	// SysPropertyTypeCodeSsccCount is the type code for SSCC counts.
	SysPropertyTypeCodeSsccCount SysPropertyTypeCode = "sscc_count"
	// SysPropertyTypeCodeProductionRunNumber is the type code for production run numbers.
	SysPropertyTypeCodeProductionRunNumber SysPropertyTypeCode = "production_run_number"
)

func (SysPropertyTypeCode) EnumValues

func (m SysPropertyTypeCode) EnumValues() []string

func (SysPropertyTypeCode) IsValid

func (m SysPropertyTypeCode) IsValid() bool

func (*SysPropertyTypeCode) StringPtr

func (m *SysPropertyTypeCode) StringPtr() *string

type Tool

type Tool string

Tool represents the slug identifier for a built-in agent tool.

const (
	// ToolCreateArtifact creates an artifact (report, document, data export).
	ToolCreateArtifact Tool = "create_artifact"
	// ToolReadDoc reads OpenMRP documentation pages.
	ToolReadDoc Tool = "read_doc"
	// ToolFetchUrl fetches content from a public URL.
	ToolFetchUrl Tool = "fetch_url"
	// ToolSendEmail sends an email reply through the conversation's bound inbox (gated by human review).
	ToolSendEmail Tool = "send_email"
	// ToolDraftReply proposes a reply to the external party on a case (a customer, supplier, or any
	// contact the case corresponds with) as a draft held for human approval — channel resolved from the
	// case: email if bridged to an inbox, else a portal message. Does not send.
	ToolDraftReply Tool = "draft_reply"
)

func (Tool) EnumValues

func (s Tool) EnumValues() []string

func (Tool) IsValid

func (s Tool) IsValid() bool

func (*Tool) StringPtr

func (s *Tool) StringPtr() *string

type TransactionAllocationStatus added in v1.1.6

type TransactionAllocationStatus string

TransactionAllocationStatus filters a list of transactions by how much of the transaction has been applied to invoices.

const (
	// TransactionAllocationStatusAllocated returns transactions marked fully applied to invoices.
	TransactionAllocationStatusAllocated TransactionAllocationStatus = "allocated"
	// TransactionAllocationStatusUnallocated returns transactions still counted as an open credit.
	TransactionAllocationStatusUnallocated TransactionAllocationStatus = "unallocated"
)

func (TransactionAllocationStatus) EnumValues added in v1.1.6

func (s TransactionAllocationStatus) EnumValues() []string

func (TransactionAllocationStatus) IsValid added in v1.1.6

func (s TransactionAllocationStatus) IsValid() bool

func (*TransactionAllocationStatus) StringPtr added in v1.1.6

func (s *TransactionAllocationStatus) StringPtr() *string

type TransactionMethod

type TransactionMethod string

TransactionMethod represents the method of a transaction.

const (
	// TransactionMethodCash indicates a cash transaction.
	TransactionMethodCash TransactionMethod = "cash"
	// TransactionMethodCheck indicates a check transaction.
	TransactionMethodCheck TransactionMethod = "check"
	// TransactionMethodCreditCard indicates a credit card transaction.
	TransactionMethodCreditCard TransactionMethod = "credit_card"
	// TransactionMethodGiftCard indicates a gift card transaction.
	TransactionMethodGiftCard TransactionMethod = "gift_card"
	// TransactionMethodACH indicates an ACH transaction.
	TransactionMethodACH TransactionMethod = "ach"
)

func (TransactionMethod) EnumValues

func (m TransactionMethod) EnumValues() []string

func (TransactionMethod) IsValid

func (m TransactionMethod) IsValid() bool

func (*TransactionMethod) StringPtr

func (m *TransactionMethod) StringPtr() *string

type TransactionType

type TransactionType string

TransactionType represents the type of a transaction.

const (
	// TransactionTypePayment indicates a payment transaction.
	TransactionTypePayment TransactionType = "payment"
	// TransactionTypeCreditMemo indicates a credit memo transaction.
	TransactionTypeCreditMemo TransactionType = "credit_memo"
	// TransactionTypeAdjustment indicates an adjustment transaction.
	TransactionTypeAdjustment TransactionType = "adjustment"
	// TransactionTypeRebate indicates a rebate transaction.
	TransactionTypeRebate TransactionType = "rebate"
)

func (TransactionType) EnumValues

func (m TransactionType) EnumValues() []string

func (TransactionType) IsValid

func (m TransactionType) IsValid() bool

func (*TransactionType) StringPtr

func (m *TransactionType) StringPtr() *string

type TransitEstimateSource

type TransitEstimateSource string

TransitEstimateSource names how a cached lane estimate was obtained. It decides what a refresh is allowed to overwrite: a harvested row is disposable and can be replaced whenever a newer quote arrives, where an operator's row is the only transit the system will ever have for a lane no carrier will rate.

const (
	// TransitEstimateSourceShippo is harvested from a rate quote the system already made, and is free to be refreshed.
	TransitEstimateSourceShippo TransitEstimateSource = "shippo"
	// TransitEstimateSourceManual was entered by an operator and must survive refreshes.
	TransitEstimateSourceManual TransitEstimateSource = "manual"
)

func (TransitEstimateSource) EnumValues

func (m TransitEstimateSource) EnumValues() []string

func (TransitEstimateSource) IsValid

func (m TransitEstimateSource) IsValid() bool

func (*TransitEstimateSource) StringPtr

func (m *TransitEstimateSource) StringPtr() *string

type TransitSource

type TransitSource string

TransitSource names where an order's transit time came from. Stored on the order beside the day count for the same reason the lead-time source is: a commitment has to be able to explain itself later, and "3 days" reads very differently depending on whether the carrier quoted that lane or someone typed a default into the service level.

const (
	// TransitSourceCarrierLane is a cached carrier estimate for this order's exact lane, the most specific answer available.
	TransitSourceCarrierLane TransitSource = "carrier_lane"
	// TransitSourceServiceLevel is the service level's default, used when no lane estimate has been cached and for carriers that cannot be rated.
	TransitSourceServiceLevel TransitSource = "service_level"
)

func (TransitSource) EnumValues

func (m TransitSource) EnumValues() []string

func (TransitSource) IsValid

func (m TransitSource) IsValid() bool

func (*TransitSource) StringPtr

func (m *TransitSource) StringPtr() *string

type UnitType

type UnitType string

UnitType represents the category of a unit of measure.

const (
	// UnitTypeCurrency represents monetary units such as dollars or euros.
	UnitTypeCurrency UnitType = "currency"
	// UnitTypeQuantity represents discrete countable units.
	UnitTypeQuantity UnitType = "quantity"
	// UnitTypeTime represents time-based units such as hours or minutes.
	UnitTypeTime UnitType = "time"
	// UnitTypeMass represents weight-based units such as kilograms or pounds.
	UnitTypeMass UnitType = "mass"
	// UnitTypeVolume represents volumetric units such as liters or gallons.
	UnitTypeVolume UnitType = "volume"
	// UnitTypeLength represents distance-based units such as meters or feet.
	UnitTypeLength UnitType = "length"
	// UnitTypeTemperature represents temperature units such as Celsius or Fahrenheit.
	UnitTypeTemperature UnitType = "temperature"
	// UnitTypeArea represents area-based units such as square meters or acres.
	UnitTypeArea UnitType = "area"
)

func (UnitType) EnumValues

func (m UnitType) EnumValues() []string

func (UnitType) IsValid

func (m UnitType) IsValid() bool

func (*UnitType) StringPtr

func (m *UnitType) StringPtr() *string

Source Files

Jump to

Keyboard shortcuts

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