api

package
v0.29.3 Latest Latest
Warning

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

 Go to latest Published: May 25, 2026 License: MIT Imports: 29 Imported by: 0

Documentation

Overview

Package api provides a generated client for the Primitive HTTP API.

The generated client is derived from the canonical OpenAPI specification in the sdks repository. Use NewAPIClient for the common API-key flow, or create your own SecuritySource when you need download-token-only access.

Code generated by ogen, DO NOT EDIT.

Index

Constants

View Source 
const (
	DefaultAPIBaseURL1 = "https://www.primitive.dev/api/v1"
	DefaultAPIBaseURL2 = "https://api.primitive.dev/v1"
	// DefaultBaseURL is a back-compat alias for DefaultAPIBaseURL1.
	DefaultBaseURL = DefaultAPIBaseURL1
)

Default production hosts. Two-host split exists because /send-mail needs a larger body cap than Vercel allows; host 2 is a Cloudflare Worker that accepts ~30 MiB raw. Host 1 carries everything else. Customers don't see this split: the top-level primitive.Client routes /send-mail to host 2 internally via a second underlying generated client, every other operation routes to host 1.

Both base URLs are independently overridable via primitive.ClientOptions. Override is for internal staging/local testing; not part of the publicly-supported surface.

Variables

This section is empty.

Functions

func GetRolesForBearerAuth 

func GetRolesForBearerAuth(operation string) []string

GetRolesForBearerAuth returns the required roles for the given operation.

This is useful for authorization scenarios where you need to know which roles are required for an operation.

Example: 

requiredRoles := GetRolesForBearerAuth(AddPetOperation)

Returns nil if the operation has no role requirements or if the operation is unknown.

func GetRolesForDownloadToken 

func GetRolesForDownloadToken(operation string) []string

GetRolesForDownloadToken returns the required roles for the given operation.

This is useful for authorization scenarios where you need to know which roles are required for an operation.

Example: 

requiredRoles := GetRolesForDownloadToken(AddPetOperation)

Returns nil if the operation has no role requirements or if the operation is unknown.

func WithServerURL 

func WithServerURL(ctx context.Context, u *url.URL) context.Context

WithServerURL sets context key to override server URL.

Types

type Account 

type Account struct {
	ID                               uuid.UUID      `json:"id"`
	Email                            string         `json:"email"`
	Plan                             string         `json:"plan"`
	CreatedAt                        time.Time      `json:"created_at"`
	OnboardingCompleted              OptBool        `json:"onboarding_completed"`
	OnboardingStep                   OptNilString   `json:"onboarding_step"`
	StripeSubscriptionStatus         OptNilString   `json:"stripe_subscription_status"`
	SubscriptionCurrentPeriodEnd     OptNilDateTime `json:"subscription_current_period_end"`
	SubscriptionCancelAtPeriodEnd    OptNilBool     `json:"subscription_cancel_at_period_end"`
	SpamThreshold                    OptNilFloat64  `json:"spam_threshold"`
	DiscardContentOnWebhookConfirmed bool           `json:"discard_content_on_webhook_confirmed"`
	WebhookSecretRotatedAt           OptNilDateTime `json:"webhook_secret_rotated_at"`
}

Ref: #/components/schemas/Account

func (*Account) Decode 

func (s *Account) Decode(d *jx.Decoder) error

Decode decodes Account from json.

func (*Account) Encode 

func (s *Account) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*Account) GetCreatedAt 

func (s *Account) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*Account) GetDiscardContentOnWebhookConfirmed 

func (s *Account) GetDiscardContentOnWebhookConfirmed() bool

GetDiscardContentOnWebhookConfirmed returns the value of DiscardContentOnWebhookConfirmed.

func (*Account) GetEmail 

func (s *Account) GetEmail() string

GetEmail returns the value of Email.

func (*Account) GetID 

func (s *Account) GetID() uuid.UUID

GetID returns the value of ID.

func (*Account) GetOnboardingCompleted 

func (s *Account) GetOnboardingCompleted() OptBool

GetOnboardingCompleted returns the value of OnboardingCompleted.

func (*Account) GetOnboardingStep 

func (s *Account) GetOnboardingStep() OptNilString

GetOnboardingStep returns the value of OnboardingStep.

func (*Account) GetPlan 

func (s *Account) GetPlan() string

GetPlan returns the value of Plan.

func (*Account) GetSpamThreshold 

func (s *Account) GetSpamThreshold() OptNilFloat64

GetSpamThreshold returns the value of SpamThreshold.

func (*Account) GetStripeSubscriptionStatus 

func (s *Account) GetStripeSubscriptionStatus() OptNilString

GetStripeSubscriptionStatus returns the value of StripeSubscriptionStatus.

func (*Account) GetSubscriptionCancelAtPeriodEnd 

func (s *Account) GetSubscriptionCancelAtPeriodEnd() OptNilBool

GetSubscriptionCancelAtPeriodEnd returns the value of SubscriptionCancelAtPeriodEnd.

func (*Account) GetSubscriptionCurrentPeriodEnd 

func (s *Account) GetSubscriptionCurrentPeriodEnd() OptNilDateTime

GetSubscriptionCurrentPeriodEnd returns the value of SubscriptionCurrentPeriodEnd.

func (*Account) GetWebhookSecretRotatedAt 

func (s *Account) GetWebhookSecretRotatedAt() OptNilDateTime

GetWebhookSecretRotatedAt returns the value of WebhookSecretRotatedAt.

func (*Account) MarshalJSON 

func (s *Account) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Account) SetCreatedAt 

func (s *Account) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*Account) SetDiscardContentOnWebhookConfirmed 

func (s *Account) SetDiscardContentOnWebhookConfirmed(val bool)

SetDiscardContentOnWebhookConfirmed sets the value of DiscardContentOnWebhookConfirmed.

func (*Account) SetEmail 

func (s *Account) SetEmail(val string)

SetEmail sets the value of Email.

func (*Account) SetID 

func (s *Account) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*Account) SetOnboardingCompleted 

func (s *Account) SetOnboardingCompleted(val OptBool)

SetOnboardingCompleted sets the value of OnboardingCompleted.

func (*Account) SetOnboardingStep 

func (s *Account) SetOnboardingStep(val OptNilString)

SetOnboardingStep sets the value of OnboardingStep.

func (*Account) SetPlan 

func (s *Account) SetPlan(val string)

SetPlan sets the value of Plan.

func (*Account) SetSpamThreshold 

func (s *Account) SetSpamThreshold(val OptNilFloat64)

SetSpamThreshold sets the value of SpamThreshold.

func (*Account) SetStripeSubscriptionStatus 

func (s *Account) SetStripeSubscriptionStatus(val OptNilString)

SetStripeSubscriptionStatus sets the value of StripeSubscriptionStatus.

func (*Account) SetSubscriptionCancelAtPeriodEnd 

func (s *Account) SetSubscriptionCancelAtPeriodEnd(val OptNilBool)

SetSubscriptionCancelAtPeriodEnd sets the value of SubscriptionCancelAtPeriodEnd.

func (*Account) SetSubscriptionCurrentPeriodEnd 

func (s *Account) SetSubscriptionCurrentPeriodEnd(val OptNilDateTime)

SetSubscriptionCurrentPeriodEnd sets the value of SubscriptionCurrentPeriodEnd.

func (*Account) SetWebhookSecretRotatedAt 

func (s *Account) SetWebhookSecretRotatedAt(val OptNilDateTime)

SetWebhookSecretRotatedAt sets the value of WebhookSecretRotatedAt.

func (*Account) UnmarshalJSON 

func (s *Account) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Account) Validate 

func (s *Account) Validate() error

type AccountUpdated 

type AccountUpdated struct {
	ID                               uuid.UUID     `json:"id"`
	Email                            string        `json:"email"`
	Plan                             string        `json:"plan"`
	SpamThreshold                    OptNilFloat64 `json:"spam_threshold"`
	DiscardContentOnWebhookConfirmed bool          `json:"discard_content_on_webhook_confirmed"`
}

Ref: #/components/schemas/AccountUpdated

func (*AccountUpdated) Decode 

func (s *AccountUpdated) Decode(d *jx.Decoder) error

Decode decodes AccountUpdated from json.

func (*AccountUpdated) Encode 

func (s *AccountUpdated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*AccountUpdated) GetDiscardContentOnWebhookConfirmed 

func (s *AccountUpdated) GetDiscardContentOnWebhookConfirmed() bool

GetDiscardContentOnWebhookConfirmed returns the value of DiscardContentOnWebhookConfirmed.

func (*AccountUpdated) GetEmail 

func (s *AccountUpdated) GetEmail() string

GetEmail returns the value of Email.

func (*AccountUpdated) GetID 

func (s *AccountUpdated) GetID() uuid.UUID

GetID returns the value of ID.

func (*AccountUpdated) GetPlan 

func (s *AccountUpdated) GetPlan() string

GetPlan returns the value of Plan.

func (*AccountUpdated) GetSpamThreshold 

func (s *AccountUpdated) GetSpamThreshold() OptNilFloat64

GetSpamThreshold returns the value of SpamThreshold.

func (*AccountUpdated) MarshalJSON 

func (s *AccountUpdated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AccountUpdated) SetDiscardContentOnWebhookConfirmed 

func (s *AccountUpdated) SetDiscardContentOnWebhookConfirmed(val bool)

SetDiscardContentOnWebhookConfirmed sets the value of DiscardContentOnWebhookConfirmed.

func (*AccountUpdated) SetEmail 

func (s *AccountUpdated) SetEmail(val string)

SetEmail sets the value of Email.

func (*AccountUpdated) SetID 

func (s *AccountUpdated) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*AccountUpdated) SetPlan 

func (s *AccountUpdated) SetPlan(val string)

SetPlan sets the value of Plan.

func (*AccountUpdated) SetSpamThreshold 

func (s *AccountUpdated) SetSpamThreshold(val OptNilFloat64)

SetSpamThreshold sets the value of SpamThreshold.

func (*AccountUpdated) UnmarshalJSON 

func (s *AccountUpdated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AccountUpdated) Validate 

func (s *AccountUpdated) Validate() error

type AddDomainBadRequest 

type AddDomainBadRequest ErrorResponse

func (*AddDomainBadRequest) Decode 

func (s *AddDomainBadRequest) Decode(d *jx.Decoder) error

Decode decodes AddDomainBadRequest from json.

func (*AddDomainBadRequest) Encode 

func (s *AddDomainBadRequest) Encode(e *jx.Encoder)

Encode encodes AddDomainBadRequest as json.

func (*AddDomainBadRequest) MarshalJSON 

func (s *AddDomainBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddDomainBadRequest) UnmarshalJSON 

func (s *AddDomainBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddDomainBadRequest) Validate 

func (s *AddDomainBadRequest) Validate() error

type AddDomainConflict added in v0.4.0 

type AddDomainConflict ErrorResponse

func (*AddDomainConflict) Decode added in v0.4.0 

func (s *AddDomainConflict) Decode(d *jx.Decoder) error

Decode decodes AddDomainConflict from json.

func (*AddDomainConflict) Encode added in v0.4.0 

func (s *AddDomainConflict) Encode(e *jx.Encoder)

Encode encodes AddDomainConflict as json.

func (*AddDomainConflict) MarshalJSON added in v0.4.0 

func (s *AddDomainConflict) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddDomainConflict) UnmarshalJSON added in v0.4.0 

func (s *AddDomainConflict) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddDomainConflict) Validate added in v0.4.0 

func (s *AddDomainConflict) Validate() error

type AddDomainCreated 

type AddDomainCreated struct {
	Success bool             `json:"success"`
	Data    UnverifiedDomain `json:"data"`
}

Merged schema.

func (*AddDomainCreated) Decode 

func (s *AddDomainCreated) Decode(d *jx.Decoder) error

Decode decodes AddDomainCreated from json.

func (*AddDomainCreated) Encode 

func (s *AddDomainCreated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*AddDomainCreated) GetData 

func (s *AddDomainCreated) GetData() UnverifiedDomain

GetData returns the value of Data.

func (*AddDomainCreated) GetSuccess 

func (s *AddDomainCreated) GetSuccess() bool

GetSuccess returns the value of Success.

func (*AddDomainCreated) MarshalJSON 

func (s *AddDomainCreated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddDomainCreated) SetData 

func (s *AddDomainCreated) SetData(val UnverifiedDomain)

SetData sets the value of Data.

func (*AddDomainCreated) SetSuccess 

func (s *AddDomainCreated) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*AddDomainCreated) UnmarshalJSON 

func (s *AddDomainCreated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddDomainCreated) Validate added in v0.29.2 

func (s *AddDomainCreated) Validate() error

type AddDomainInput 

type AddDomainInput struct {
	// The domain name to claim (e.g. "example.com").
	Domain string `json:"domain"`
	// Set to true to confirm replacing an existing mailbox provider after an mx_conflict response.
	Confirmed OptBool `json:"confirmed"`
	// Deprecated and ignored. Outbound DNS is provisioned for every new domain claim.
	//
	// Deprecated: schema marks this property as deprecated.
	Outbound OptBool `json:"outbound"`
}

Ref: #/components/schemas/AddDomainInput

func (*AddDomainInput) Decode 

func (s *AddDomainInput) Decode(d *jx.Decoder) error

Decode decodes AddDomainInput from json.

func (*AddDomainInput) Encode 

func (s *AddDomainInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*AddDomainInput) GetConfirmed added in v0.29.2 

func (s *AddDomainInput) GetConfirmed() OptBool

GetConfirmed returns the value of Confirmed.

func (*AddDomainInput) GetDomain 

func (s *AddDomainInput) GetDomain() string

GetDomain returns the value of Domain.

func (*AddDomainInput) GetOutbound added in v0.29.2 

func (s *AddDomainInput) GetOutbound() OptBool

GetOutbound returns the value of Outbound.

func (*AddDomainInput) MarshalJSON 

func (s *AddDomainInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddDomainInput) SetConfirmed added in v0.29.2 

func (s *AddDomainInput) SetConfirmed(val OptBool)

SetConfirmed sets the value of Confirmed.

func (*AddDomainInput) SetDomain 

func (s *AddDomainInput) SetDomain(val string)

SetDomain sets the value of Domain.

func (*AddDomainInput) SetOutbound added in v0.29.2 

func (s *AddDomainInput) SetOutbound(val OptBool)

SetOutbound sets the value of Outbound.

func (*AddDomainInput) UnmarshalJSON 

func (s *AddDomainInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddDomainInput) Validate 

func (s *AddDomainInput) Validate() error

type AddDomainRes 

type AddDomainRes interface {
	// contains filtered or unexported methods
}

type AddDomainUnauthorized 

type AddDomainUnauthorized ErrorResponse

func (*AddDomainUnauthorized) Decode 

func (s *AddDomainUnauthorized) Decode(d *jx.Decoder) error

Decode decodes AddDomainUnauthorized from json.

func (*AddDomainUnauthorized) Encode 

func (s *AddDomainUnauthorized) Encode(e *jx.Encoder)

Encode encodes AddDomainUnauthorized as json.

func (*AddDomainUnauthorized) MarshalJSON 

func (s *AddDomainUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddDomainUnauthorized) UnmarshalJSON 

func (s *AddDomainUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddDomainUnauthorized) Validate 

func (s *AddDomainUnauthorized) Validate() error

type AgentOrgRef added in v0.29.2 

type AgentOrgRef struct {
	ID   uuid.UUID `json:"id"`
	Name NilString `json:"name"`
}

Ref: #/components/schemas/AgentOrgRef

func (*AgentOrgRef) Decode added in v0.29.2 

func (s *AgentOrgRef) Decode(d *jx.Decoder) error

Decode decodes AgentOrgRef from json.

func (*AgentOrgRef) Encode added in v0.29.2 

func (s *AgentOrgRef) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*AgentOrgRef) GetID added in v0.29.2 

func (s *AgentOrgRef) GetID() uuid.UUID

GetID returns the value of ID.

func (*AgentOrgRef) GetName added in v0.29.2 

func (s *AgentOrgRef) GetName() NilString

GetName returns the value of Name.

func (*AgentOrgRef) MarshalJSON added in v0.29.2 

func (s *AgentOrgRef) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AgentOrgRef) SetID added in v0.29.2 

func (s *AgentOrgRef) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*AgentOrgRef) SetName added in v0.29.2 

func (s *AgentOrgRef) SetName(val NilString)

SetName sets the value of Name.

func (*AgentOrgRef) UnmarshalJSON added in v0.29.2 

func (s *AgentOrgRef) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type AgentSignupResendResult added in v0.29.2 

type AgentSignupResendResult struct {
	Email string `json:"email"`
	// Seconds until the pending signup expires.
	ExpiresIn int `json:"expires_in"`
	// Minimum seconds before requesting another verification email.
	ResendAfter int `json:"resend_after"`
	// Number of digits in the emailed verification code.
	VerificationCodeLength int `json:"verification_code_length"`
}

Ref: #/components/schemas/AgentSignupResendResult

func (*AgentSignupResendResult) Decode added in v0.29.2 

func (s *AgentSignupResendResult) Decode(d *jx.Decoder) error

Decode decodes AgentSignupResendResult from json.

func (*AgentSignupResendResult) Encode added in v0.29.2 

func (s *AgentSignupResendResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*AgentSignupResendResult) GetEmail added in v0.29.2 

func (s *AgentSignupResendResult) GetEmail() string

GetEmail returns the value of Email.

func (*AgentSignupResendResult) GetExpiresIn added in v0.29.2 

func (s *AgentSignupResendResult) GetExpiresIn() int

GetExpiresIn returns the value of ExpiresIn.

func (*AgentSignupResendResult) GetResendAfter added in v0.29.2 

func (s *AgentSignupResendResult) GetResendAfter() int

GetResendAfter returns the value of ResendAfter.

func (*AgentSignupResendResult) GetVerificationCodeLength added in v0.29.2 

func (s *AgentSignupResendResult) GetVerificationCodeLength() int

GetVerificationCodeLength returns the value of VerificationCodeLength.

func (*AgentSignupResendResult) MarshalJSON added in v0.29.2 

func (s *AgentSignupResendResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AgentSignupResendResult) SetEmail added in v0.29.2 

func (s *AgentSignupResendResult) SetEmail(val string)

SetEmail sets the value of Email.

func (*AgentSignupResendResult) SetExpiresIn added in v0.29.2 

func (s *AgentSignupResendResult) SetExpiresIn(val int)

SetExpiresIn sets the value of ExpiresIn.

func (*AgentSignupResendResult) SetResendAfter added in v0.29.2 

func (s *AgentSignupResendResult) SetResendAfter(val int)

SetResendAfter sets the value of ResendAfter.

func (*AgentSignupResendResult) SetVerificationCodeLength added in v0.29.2 

func (s *AgentSignupResendResult) SetVerificationCodeLength(val int)

SetVerificationCodeLength sets the value of VerificationCodeLength.

func (*AgentSignupResendResult) UnmarshalJSON added in v0.29.2 

func (s *AgentSignupResendResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AgentSignupResendResult) Validate added in v0.29.2 

func (s *AgentSignupResendResult) Validate() error

type AgentSignupStartResult added in v0.29.2 

type AgentSignupStartResult struct {
	// Opaque token used to verify or resend the pending agent signup.
	SignupToken string `json:"signup_token"`
	Email       string `json:"email"`
	// Seconds until the pending signup expires.
	ExpiresIn int `json:"expires_in"`
	// Minimum seconds before requesting another verification email.
	ResendAfter int `json:"resend_after"`
	// Number of digits in the emailed verification code.
	VerificationCodeLength int `json:"verification_code_length"`
}

Ref: #/components/schemas/AgentSignupStartResult

func (*AgentSignupStartResult) Decode added in v0.29.2 

func (s *AgentSignupStartResult) Decode(d *jx.Decoder) error

Decode decodes AgentSignupStartResult from json.

func (*AgentSignupStartResult) Encode added in v0.29.2 

func (s *AgentSignupStartResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*AgentSignupStartResult) GetEmail added in v0.29.2 

func (s *AgentSignupStartResult) GetEmail() string

GetEmail returns the value of Email.

func (*AgentSignupStartResult) GetExpiresIn added in v0.29.2 

func (s *AgentSignupStartResult) GetExpiresIn() int

GetExpiresIn returns the value of ExpiresIn.

func (*AgentSignupStartResult) GetResendAfter added in v0.29.2 

func (s *AgentSignupStartResult) GetResendAfter() int

GetResendAfter returns the value of ResendAfter.

func (*AgentSignupStartResult) GetSignupToken added in v0.29.2 

func (s *AgentSignupStartResult) GetSignupToken() string

GetSignupToken returns the value of SignupToken.

func (*AgentSignupStartResult) GetVerificationCodeLength added in v0.29.2 

func (s *AgentSignupStartResult) GetVerificationCodeLength() int

GetVerificationCodeLength returns the value of VerificationCodeLength.

func (*AgentSignupStartResult) MarshalJSON added in v0.29.2 

func (s *AgentSignupStartResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AgentSignupStartResult) SetEmail added in v0.29.2 

func (s *AgentSignupStartResult) SetEmail(val string)

SetEmail sets the value of Email.

func (*AgentSignupStartResult) SetExpiresIn added in v0.29.2 

func (s *AgentSignupStartResult) SetExpiresIn(val int)

SetExpiresIn sets the value of ExpiresIn.

func (*AgentSignupStartResult) SetResendAfter added in v0.29.2 

func (s *AgentSignupStartResult) SetResendAfter(val int)

SetResendAfter sets the value of ResendAfter.

func (*AgentSignupStartResult) SetSignupToken added in v0.29.2 

func (s *AgentSignupStartResult) SetSignupToken(val string)

SetSignupToken sets the value of SignupToken.

func (*AgentSignupStartResult) SetVerificationCodeLength added in v0.29.2 

func (s *AgentSignupStartResult) SetVerificationCodeLength(val int)

SetVerificationCodeLength sets the value of VerificationCodeLength.

func (*AgentSignupStartResult) UnmarshalJSON added in v0.29.2 

func (s *AgentSignupStartResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AgentSignupStartResult) Validate added in v0.29.2 

func (s *AgentSignupStartResult) Validate() error

type AgentSignupVerifyResult added in v0.29.2 

type AgentSignupVerifyResult struct {
	// Legacy alias for access_token. New CLI builds should persist access_token and refresh_token.
	APIKey string `json:"api_key"`
	// Legacy alias for oauth_grant_id.
	KeyID uuid.UUID `json:"key_id"`
	// Legacy display prefix derived from access_token.
	KeyPrefix string `json:"key_prefix"`
	// OAuth access token for CLI API authentication.
	AccessToken string `json:"access_token"`
	// OAuth refresh token used by the CLI to renew access.
	RefreshToken string                           `json:"refresh_token"`
	TokenType    AgentSignupVerifyResultTokenType `json:"token_type"`
	// Seconds until access_token expires.
	ExpiresIn     int                               `json:"expires_in"`
	AuthMethod    AgentSignupVerifyResultAuthMethod `json:"auth_method"`
	OAuthGrantID  uuid.UUID                         `json:"oauth_grant_id"`
	OAuthClientID string                            `json:"oauth_client_id"`
	OrgID         uuid.UUID                         `json:"org_id"`
	OrgName       NilString                         `json:"org_name"`
	// Workspaces available to the verified email. The minted session targets `org_id`.
	Orgs []AgentOrgRef `json:"orgs"`
}

Ref: #/components/schemas/AgentSignupVerifyResult

func (*AgentSignupVerifyResult) Decode added in v0.29.2 

func (s *AgentSignupVerifyResult) Decode(d *jx.Decoder) error

Decode decodes AgentSignupVerifyResult from json.

func (*AgentSignupVerifyResult) Encode added in v0.29.2 

func (s *AgentSignupVerifyResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*AgentSignupVerifyResult) GetAPIKey added in v0.29.2 

func (s *AgentSignupVerifyResult) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*AgentSignupVerifyResult) GetAccessToken added in v0.29.2 

func (s *AgentSignupVerifyResult) GetAccessToken() string

GetAccessToken returns the value of AccessToken.

func (*AgentSignupVerifyResult) GetAuthMethod added in v0.29.2 

func (s *AgentSignupVerifyResult) GetAuthMethod() AgentSignupVerifyResultAuthMethod

GetAuthMethod returns the value of AuthMethod.

func (*AgentSignupVerifyResult) GetExpiresIn added in v0.29.2 

func (s *AgentSignupVerifyResult) GetExpiresIn() int

GetExpiresIn returns the value of ExpiresIn.

func (*AgentSignupVerifyResult) GetKeyID added in v0.29.2 

func (s *AgentSignupVerifyResult) GetKeyID() uuid.UUID

GetKeyID returns the value of KeyID.

func (*AgentSignupVerifyResult) GetKeyPrefix added in v0.29.2 

func (s *AgentSignupVerifyResult) GetKeyPrefix() string

GetKeyPrefix returns the value of KeyPrefix.

func (*AgentSignupVerifyResult) GetOAuthClientID added in v0.29.2 

func (s *AgentSignupVerifyResult) GetOAuthClientID() string

GetOAuthClientID returns the value of OAuthClientID.

func (*AgentSignupVerifyResult) GetOAuthGrantID added in v0.29.2 

func (s *AgentSignupVerifyResult) GetOAuthGrantID() uuid.UUID

GetOAuthGrantID returns the value of OAuthGrantID.

func (*AgentSignupVerifyResult) GetOrgID added in v0.29.2 

func (s *AgentSignupVerifyResult) GetOrgID() uuid.UUID

GetOrgID returns the value of OrgID.

func (*AgentSignupVerifyResult) GetOrgName added in v0.29.2 

func (s *AgentSignupVerifyResult) GetOrgName() NilString

GetOrgName returns the value of OrgName.

func (*AgentSignupVerifyResult) GetOrgs added in v0.29.2 

func (s *AgentSignupVerifyResult) GetOrgs() []AgentOrgRef

GetOrgs returns the value of Orgs.

func (*AgentSignupVerifyResult) GetRefreshToken added in v0.29.2 

func (s *AgentSignupVerifyResult) GetRefreshToken() string

GetRefreshToken returns the value of RefreshToken.

func (*AgentSignupVerifyResult) GetTokenType added in v0.29.2 

func (s *AgentSignupVerifyResult) GetTokenType() AgentSignupVerifyResultTokenType

GetTokenType returns the value of TokenType.

func (*AgentSignupVerifyResult) MarshalJSON added in v0.29.2 

func (s *AgentSignupVerifyResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AgentSignupVerifyResult) SetAPIKey added in v0.29.2 

func (s *AgentSignupVerifyResult) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

func (*AgentSignupVerifyResult) SetAccessToken added in v0.29.2 

func (s *AgentSignupVerifyResult) SetAccessToken(val string)

SetAccessToken sets the value of AccessToken.

func (*AgentSignupVerifyResult) SetAuthMethod added in v0.29.2 

func (s *AgentSignupVerifyResult) SetAuthMethod(val AgentSignupVerifyResultAuthMethod)

SetAuthMethod sets the value of AuthMethod.

func (*AgentSignupVerifyResult) SetExpiresIn added in v0.29.2 

func (s *AgentSignupVerifyResult) SetExpiresIn(val int)

SetExpiresIn sets the value of ExpiresIn.

func (*AgentSignupVerifyResult) SetKeyID added in v0.29.2 

func (s *AgentSignupVerifyResult) SetKeyID(val uuid.UUID)

SetKeyID sets the value of KeyID.

func (*AgentSignupVerifyResult) SetKeyPrefix added in v0.29.2 

func (s *AgentSignupVerifyResult) SetKeyPrefix(val string)

SetKeyPrefix sets the value of KeyPrefix.

func (*AgentSignupVerifyResult) SetOAuthClientID added in v0.29.2 

func (s *AgentSignupVerifyResult) SetOAuthClientID(val string)

SetOAuthClientID sets the value of OAuthClientID.

func (*AgentSignupVerifyResult) SetOAuthGrantID added in v0.29.2 

func (s *AgentSignupVerifyResult) SetOAuthGrantID(val uuid.UUID)

SetOAuthGrantID sets the value of OAuthGrantID.

func (*AgentSignupVerifyResult) SetOrgID added in v0.29.2 

func (s *AgentSignupVerifyResult) SetOrgID(val uuid.UUID)

SetOrgID sets the value of OrgID.

func (*AgentSignupVerifyResult) SetOrgName added in v0.29.2 

func (s *AgentSignupVerifyResult) SetOrgName(val NilString)

SetOrgName sets the value of OrgName.

func (*AgentSignupVerifyResult) SetOrgs added in v0.29.2 

func (s *AgentSignupVerifyResult) SetOrgs(val []AgentOrgRef)

SetOrgs sets the value of Orgs.

func (*AgentSignupVerifyResult) SetRefreshToken added in v0.29.2 

func (s *AgentSignupVerifyResult) SetRefreshToken(val string)

SetRefreshToken sets the value of RefreshToken.

func (*AgentSignupVerifyResult) SetTokenType added in v0.29.2 

func (s *AgentSignupVerifyResult) SetTokenType(val AgentSignupVerifyResultTokenType)

SetTokenType sets the value of TokenType.

func (*AgentSignupVerifyResult) UnmarshalJSON added in v0.29.2 

func (s *AgentSignupVerifyResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AgentSignupVerifyResult) Validate added in v0.29.2 

func (s *AgentSignupVerifyResult) Validate() error

type AgentSignupVerifyResultAuthMethod added in v0.29.2 

type AgentSignupVerifyResultAuthMethod string
const (
	AgentSignupVerifyResultAuthMethodOAuth AgentSignupVerifyResultAuthMethod = "oauth"
)

func (AgentSignupVerifyResultAuthMethod) AllValues added in v0.29.2 

func (AgentSignupVerifyResultAuthMethod) AllValues() []AgentSignupVerifyResultAuthMethod

AllValues returns all AgentSignupVerifyResultAuthMethod values.

func (*AgentSignupVerifyResultAuthMethod) Decode added in v0.29.2 

func (s *AgentSignupVerifyResultAuthMethod) Decode(d *jx.Decoder) error

Decode decodes AgentSignupVerifyResultAuthMethod from json.

func (AgentSignupVerifyResultAuthMethod) Encode added in v0.29.2 

func (s AgentSignupVerifyResultAuthMethod) Encode(e *jx.Encoder)

Encode encodes AgentSignupVerifyResultAuthMethod as json.

func (AgentSignupVerifyResultAuthMethod) MarshalJSON added in v0.29.2 

func (s AgentSignupVerifyResultAuthMethod) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (AgentSignupVerifyResultAuthMethod) MarshalText added in v0.29.2 

func (s AgentSignupVerifyResultAuthMethod) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*AgentSignupVerifyResultAuthMethod) UnmarshalJSON added in v0.29.2 

func (s *AgentSignupVerifyResultAuthMethod) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AgentSignupVerifyResultAuthMethod) UnmarshalText added in v0.29.2 

func (s *AgentSignupVerifyResultAuthMethod) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (AgentSignupVerifyResultAuthMethod) Validate added in v0.29.2 

func (s AgentSignupVerifyResultAuthMethod) Validate() error

type AgentSignupVerifyResultTokenType added in v0.29.2 

type AgentSignupVerifyResultTokenType string
const (
	AgentSignupVerifyResultTokenTypeBearer AgentSignupVerifyResultTokenType = "Bearer"
)

func (AgentSignupVerifyResultTokenType) AllValues added in v0.29.2 

func (AgentSignupVerifyResultTokenType) AllValues() []AgentSignupVerifyResultTokenType

AllValues returns all AgentSignupVerifyResultTokenType values.

func (*AgentSignupVerifyResultTokenType) Decode added in v0.29.2 

func (s *AgentSignupVerifyResultTokenType) Decode(d *jx.Decoder) error

Decode decodes AgentSignupVerifyResultTokenType from json.

func (AgentSignupVerifyResultTokenType) Encode added in v0.29.2 

func (s AgentSignupVerifyResultTokenType) Encode(e *jx.Encoder)

Encode encodes AgentSignupVerifyResultTokenType as json.

func (AgentSignupVerifyResultTokenType) MarshalJSON added in v0.29.2 

func (s AgentSignupVerifyResultTokenType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (AgentSignupVerifyResultTokenType) MarshalText added in v0.29.2 

func (s AgentSignupVerifyResultTokenType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*AgentSignupVerifyResultTokenType) UnmarshalJSON added in v0.29.2 

func (s *AgentSignupVerifyResultTokenType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AgentSignupVerifyResultTokenType) UnmarshalText added in v0.29.2 

func (s *AgentSignupVerifyResultTokenType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (AgentSignupVerifyResultTokenType) Validate added in v0.29.2 

func (s AgentSignupVerifyResultTokenType) Validate() error

type BearerAuth 

type BearerAuth struct {
	Token string
	Roles []string
}

func (*BearerAuth) GetRoles 

func (s *BearerAuth) GetRoles() []string

GetRoles returns the value of Roles.

func (*BearerAuth) GetToken 

func (s *BearerAuth) GetToken() string

GetToken returns the value of Token.

func (*BearerAuth) SetRoles 

func (s *BearerAuth) SetRoles(val []string)

SetRoles sets the value of Roles.

func (*BearerAuth) SetToken 

func (s *BearerAuth) SetToken(val string)

SetToken sets the value of Token.

type CliLoginPollResult added in v0.19.0 

type CliLoginPollResult struct {
	// Legacy alias for access_token. New CLI builds should persist access_token and refresh_token.
	APIKey string `json:"api_key"`
	// Legacy alias for oauth_grant_id.
	KeyID uuid.UUID `json:"key_id"`
	// Legacy display prefix derived from access_token.
	KeyPrefix string `json:"key_prefix"`
	// OAuth access token for CLI API authentication.
	AccessToken string `json:"access_token"`
	// OAuth refresh token used by the CLI to renew access.
	RefreshToken string                      `json:"refresh_token"`
	TokenType    CliLoginPollResultTokenType `json:"token_type"`
	// Seconds until access_token expires.
	ExpiresIn     int                          `json:"expires_in"`
	AuthMethod    CliLoginPollResultAuthMethod `json:"auth_method"`
	OAuthGrantID  uuid.UUID                    `json:"oauth_grant_id"`
	OAuthClientID string                       `json:"oauth_client_id"`
	OrgID         uuid.UUID                    `json:"org_id"`
	OrgName       NilString                    `json:"org_name"`
}

Ref: #/components/schemas/CliLoginPollResult

func (*CliLoginPollResult) Decode added in v0.19.0 

func (s *CliLoginPollResult) Decode(d *jx.Decoder) error

Decode decodes CliLoginPollResult from json.

func (*CliLoginPollResult) Encode added in v0.19.0 

func (s *CliLoginPollResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CliLoginPollResult) GetAPIKey added in v0.19.0 

func (s *CliLoginPollResult) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*CliLoginPollResult) GetAccessToken added in v0.29.2 

func (s *CliLoginPollResult) GetAccessToken() string

GetAccessToken returns the value of AccessToken.

func (*CliLoginPollResult) GetAuthMethod added in v0.29.2 

func (s *CliLoginPollResult) GetAuthMethod() CliLoginPollResultAuthMethod

GetAuthMethod returns the value of AuthMethod.

func (*CliLoginPollResult) GetExpiresIn added in v0.29.2 

func (s *CliLoginPollResult) GetExpiresIn() int

GetExpiresIn returns the value of ExpiresIn.

func (*CliLoginPollResult) GetKeyID added in v0.19.0 

func (s *CliLoginPollResult) GetKeyID() uuid.UUID

GetKeyID returns the value of KeyID.

func (*CliLoginPollResult) GetKeyPrefix added in v0.19.0 

func (s *CliLoginPollResult) GetKeyPrefix() string

GetKeyPrefix returns the value of KeyPrefix.

func (*CliLoginPollResult) GetOAuthClientID added in v0.29.2 

func (s *CliLoginPollResult) GetOAuthClientID() string

GetOAuthClientID returns the value of OAuthClientID.

func (*CliLoginPollResult) GetOAuthGrantID added in v0.29.2 

func (s *CliLoginPollResult) GetOAuthGrantID() uuid.UUID

GetOAuthGrantID returns the value of OAuthGrantID.

func (*CliLoginPollResult) GetOrgID added in v0.19.0 

func (s *CliLoginPollResult) GetOrgID() uuid.UUID

GetOrgID returns the value of OrgID.

func (*CliLoginPollResult) GetOrgName added in v0.19.0 

func (s *CliLoginPollResult) GetOrgName() NilString

GetOrgName returns the value of OrgName.

func (*CliLoginPollResult) GetRefreshToken added in v0.29.2 

func (s *CliLoginPollResult) GetRefreshToken() string

GetRefreshToken returns the value of RefreshToken.

func (*CliLoginPollResult) GetTokenType added in v0.29.2 

func (s *CliLoginPollResult) GetTokenType() CliLoginPollResultTokenType

GetTokenType returns the value of TokenType.

func (*CliLoginPollResult) MarshalJSON added in v0.19.0 

func (s *CliLoginPollResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliLoginPollResult) SetAPIKey added in v0.19.0 

func (s *CliLoginPollResult) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

func (*CliLoginPollResult) SetAccessToken added in v0.29.2 

func (s *CliLoginPollResult) SetAccessToken(val string)

SetAccessToken sets the value of AccessToken.

func (*CliLoginPollResult) SetAuthMethod added in v0.29.2 

func (s *CliLoginPollResult) SetAuthMethod(val CliLoginPollResultAuthMethod)

SetAuthMethod sets the value of AuthMethod.

func (*CliLoginPollResult) SetExpiresIn added in v0.29.2 

func (s *CliLoginPollResult) SetExpiresIn(val int)

SetExpiresIn sets the value of ExpiresIn.

func (*CliLoginPollResult) SetKeyID added in v0.19.0 

func (s *CliLoginPollResult) SetKeyID(val uuid.UUID)

SetKeyID sets the value of KeyID.

func (*CliLoginPollResult) SetKeyPrefix added in v0.19.0 

func (s *CliLoginPollResult) SetKeyPrefix(val string)

SetKeyPrefix sets the value of KeyPrefix.

func (*CliLoginPollResult) SetOAuthClientID added in v0.29.2 

func (s *CliLoginPollResult) SetOAuthClientID(val string)

SetOAuthClientID sets the value of OAuthClientID.

func (*CliLoginPollResult) SetOAuthGrantID added in v0.29.2 

func (s *CliLoginPollResult) SetOAuthGrantID(val uuid.UUID)

SetOAuthGrantID sets the value of OAuthGrantID.

func (*CliLoginPollResult) SetOrgID added in v0.19.0 

func (s *CliLoginPollResult) SetOrgID(val uuid.UUID)

SetOrgID sets the value of OrgID.

func (*CliLoginPollResult) SetOrgName added in v0.19.0 

func (s *CliLoginPollResult) SetOrgName(val NilString)

SetOrgName sets the value of OrgName.

func (*CliLoginPollResult) SetRefreshToken added in v0.29.2 

func (s *CliLoginPollResult) SetRefreshToken(val string)

SetRefreshToken sets the value of RefreshToken.

func (*CliLoginPollResult) SetTokenType added in v0.29.2 

func (s *CliLoginPollResult) SetTokenType(val CliLoginPollResultTokenType)

SetTokenType sets the value of TokenType.

func (*CliLoginPollResult) UnmarshalJSON added in v0.19.0 

func (s *CliLoginPollResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliLoginPollResult) Validate added in v0.29.2 

func (s *CliLoginPollResult) Validate() error

type CliLoginPollResultAuthMethod added in v0.29.2 

type CliLoginPollResultAuthMethod string
const (
	CliLoginPollResultAuthMethodOAuth CliLoginPollResultAuthMethod = "oauth"
)

func (CliLoginPollResultAuthMethod) AllValues added in v0.29.2 

func (CliLoginPollResultAuthMethod) AllValues() []CliLoginPollResultAuthMethod

AllValues returns all CliLoginPollResultAuthMethod values.

func (*CliLoginPollResultAuthMethod) Decode added in v0.29.2 

func (s *CliLoginPollResultAuthMethod) Decode(d *jx.Decoder) error

Decode decodes CliLoginPollResultAuthMethod from json.

func (CliLoginPollResultAuthMethod) Encode added in v0.29.2 

func (s CliLoginPollResultAuthMethod) Encode(e *jx.Encoder)

Encode encodes CliLoginPollResultAuthMethod as json.

func (CliLoginPollResultAuthMethod) MarshalJSON added in v0.29.2 

func (s CliLoginPollResultAuthMethod) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (CliLoginPollResultAuthMethod) MarshalText added in v0.29.2 

func (s CliLoginPollResultAuthMethod) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*CliLoginPollResultAuthMethod) UnmarshalJSON added in v0.29.2 

func (s *CliLoginPollResultAuthMethod) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliLoginPollResultAuthMethod) UnmarshalText added in v0.29.2 

func (s *CliLoginPollResultAuthMethod) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (CliLoginPollResultAuthMethod) Validate added in v0.29.2 

func (s CliLoginPollResultAuthMethod) Validate() error

type CliLoginPollResultTokenType added in v0.29.2 

type CliLoginPollResultTokenType string
const (
	CliLoginPollResultTokenTypeBearer CliLoginPollResultTokenType = "Bearer"
)

func (CliLoginPollResultTokenType) AllValues added in v0.29.2 

func (CliLoginPollResultTokenType) AllValues() []CliLoginPollResultTokenType

AllValues returns all CliLoginPollResultTokenType values.

func (*CliLoginPollResultTokenType) Decode added in v0.29.2 

func (s *CliLoginPollResultTokenType) Decode(d *jx.Decoder) error

Decode decodes CliLoginPollResultTokenType from json.

func (CliLoginPollResultTokenType) Encode added in v0.29.2 

func (s CliLoginPollResultTokenType) Encode(e *jx.Encoder)

Encode encodes CliLoginPollResultTokenType as json.

func (CliLoginPollResultTokenType) MarshalJSON added in v0.29.2 

func (s CliLoginPollResultTokenType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (CliLoginPollResultTokenType) MarshalText added in v0.29.2 

func (s CliLoginPollResultTokenType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*CliLoginPollResultTokenType) UnmarshalJSON added in v0.29.2 

func (s *CliLoginPollResultTokenType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliLoginPollResultTokenType) UnmarshalText added in v0.29.2 

func (s *CliLoginPollResultTokenType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (CliLoginPollResultTokenType) Validate added in v0.29.2 

func (s CliLoginPollResultTokenType) Validate() error

type CliLoginStartResult added in v0.19.0 

type CliLoginStartResult struct {
	// Opaque code used by the CLI to poll for approval.
	DeviceCode string `json:"device_code"`
	// Short code the user confirms in the browser.
	UserCode string `json:"user_code"`
	// Browser URL where the user approves the login.
	VerificationURI string `json:"verification_uri"`
	// Browser URL with the user code prefilled.
	VerificationURIComplete string `json:"verification_uri_complete"`
	// Seconds until the login session expires.
	ExpiresIn int `json:"expires_in"`
	// Minimum seconds between poll requests.
	Interval int `json:"interval"`
}

Ref: #/components/schemas/CliLoginStartResult

func (*CliLoginStartResult) Decode added in v0.19.0 

func (s *CliLoginStartResult) Decode(d *jx.Decoder) error

Decode decodes CliLoginStartResult from json.

func (*CliLoginStartResult) Encode added in v0.19.0 

func (s *CliLoginStartResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CliLoginStartResult) GetDeviceCode added in v0.19.0 

func (s *CliLoginStartResult) GetDeviceCode() string

GetDeviceCode returns the value of DeviceCode.

func (*CliLoginStartResult) GetExpiresIn added in v0.19.0 

func (s *CliLoginStartResult) GetExpiresIn() int

GetExpiresIn returns the value of ExpiresIn.

func (*CliLoginStartResult) GetInterval added in v0.19.0 

func (s *CliLoginStartResult) GetInterval() int

GetInterval returns the value of Interval.

func (*CliLoginStartResult) GetUserCode added in v0.19.0 

func (s *CliLoginStartResult) GetUserCode() string

GetUserCode returns the value of UserCode.

func (*CliLoginStartResult) GetVerificationURI added in v0.19.0 

func (s *CliLoginStartResult) GetVerificationURI() string

GetVerificationURI returns the value of VerificationURI.

func (*CliLoginStartResult) GetVerificationURIComplete added in v0.19.0 

func (s *CliLoginStartResult) GetVerificationURIComplete() string

GetVerificationURIComplete returns the value of VerificationURIComplete.

func (*CliLoginStartResult) MarshalJSON added in v0.19.0 

func (s *CliLoginStartResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliLoginStartResult) SetDeviceCode added in v0.19.0 

func (s *CliLoginStartResult) SetDeviceCode(val string)

SetDeviceCode sets the value of DeviceCode.

func (*CliLoginStartResult) SetExpiresIn added in v0.19.0 

func (s *CliLoginStartResult) SetExpiresIn(val int)

SetExpiresIn sets the value of ExpiresIn.

func (*CliLoginStartResult) SetInterval added in v0.19.0 

func (s *CliLoginStartResult) SetInterval(val int)

SetInterval sets the value of Interval.

func (*CliLoginStartResult) SetUserCode added in v0.19.0 

func (s *CliLoginStartResult) SetUserCode(val string)

SetUserCode sets the value of UserCode.

func (*CliLoginStartResult) SetVerificationURI added in v0.19.0 

func (s *CliLoginStartResult) SetVerificationURI(val string)

SetVerificationURI sets the value of VerificationURI.

func (*CliLoginStartResult) SetVerificationURIComplete added in v0.19.0 

func (s *CliLoginStartResult) SetVerificationURIComplete(val string)

SetVerificationURIComplete sets the value of VerificationURIComplete.

func (*CliLoginStartResult) UnmarshalJSON added in v0.19.0 

func (s *CliLoginStartResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliLoginStartResult) Validate added in v0.19.0 

func (s *CliLoginStartResult) Validate() error

type CliLogoutBadRequest added in v0.19.0 

type CliLogoutBadRequest ErrorResponse

func (*CliLogoutBadRequest) Decode added in v0.19.0 

func (s *CliLogoutBadRequest) Decode(d *jx.Decoder) error

Decode decodes CliLogoutBadRequest from json.

func (*CliLogoutBadRequest) Encode added in v0.19.0 

func (s *CliLogoutBadRequest) Encode(e *jx.Encoder)

Encode encodes CliLogoutBadRequest as json.

func (*CliLogoutBadRequest) MarshalJSON added in v0.19.0 

func (s *CliLogoutBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliLogoutBadRequest) UnmarshalJSON added in v0.19.0 

func (s *CliLogoutBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliLogoutBadRequest) Validate added in v0.19.0 

func (s *CliLogoutBadRequest) Validate() error

type CliLogoutForbidden added in v0.19.0 

type CliLogoutForbidden ErrorResponse

func (*CliLogoutForbidden) Decode added in v0.19.0 

func (s *CliLogoutForbidden) Decode(d *jx.Decoder) error

Decode decodes CliLogoutForbidden from json.

func (*CliLogoutForbidden) Encode added in v0.19.0 

func (s *CliLogoutForbidden) Encode(e *jx.Encoder)

Encode encodes CliLogoutForbidden as json.

func (*CliLogoutForbidden) MarshalJSON added in v0.19.0 

func (s *CliLogoutForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliLogoutForbidden) UnmarshalJSON added in v0.19.0 

func (s *CliLogoutForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliLogoutForbidden) Validate added in v0.19.0 

func (s *CliLogoutForbidden) Validate() error

type CliLogoutInput added in v0.19.0 

type CliLogoutInput struct {
	// Optional id guard; when provided it must match the authenticated OAuth grant id or API key id.
	KeyID OptUUID `json:"key_id"`
}

Ref: #/components/schemas/CliLogoutInput

func (*CliLogoutInput) Decode added in v0.19.0 

func (s *CliLogoutInput) Decode(d *jx.Decoder) error

Decode decodes CliLogoutInput from json.

func (*CliLogoutInput) Encode added in v0.19.0 

func (s *CliLogoutInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CliLogoutInput) GetKeyID added in v0.19.0 

func (s *CliLogoutInput) GetKeyID() OptUUID

GetKeyID returns the value of KeyID.

func (*CliLogoutInput) MarshalJSON added in v0.19.0 

func (s *CliLogoutInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliLogoutInput) SetKeyID added in v0.19.0 

func (s *CliLogoutInput) SetKeyID(val OptUUID)

SetKeyID sets the value of KeyID.

func (*CliLogoutInput) UnmarshalJSON added in v0.19.0 

func (s *CliLogoutInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type CliLogoutNotFound added in v0.19.0 

type CliLogoutNotFound ErrorResponse

func (*CliLogoutNotFound) Decode added in v0.19.0 

func (s *CliLogoutNotFound) Decode(d *jx.Decoder) error

Decode decodes CliLogoutNotFound from json.

func (*CliLogoutNotFound) Encode added in v0.19.0 

func (s *CliLogoutNotFound) Encode(e *jx.Encoder)

Encode encodes CliLogoutNotFound as json.

func (*CliLogoutNotFound) MarshalJSON added in v0.19.0 

func (s *CliLogoutNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliLogoutNotFound) UnmarshalJSON added in v0.19.0 

func (s *CliLogoutNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliLogoutNotFound) Validate added in v0.19.0 

func (s *CliLogoutNotFound) Validate() error

type CliLogoutOK added in v0.19.0 

type CliLogoutOK struct {
	Success bool            `json:"success"`
	Data    CliLogoutResult `json:"data"`
}

Merged schema.

func (*CliLogoutOK) Decode added in v0.19.0 

func (s *CliLogoutOK) Decode(d *jx.Decoder) error

Decode decodes CliLogoutOK from json.

func (*CliLogoutOK) Encode added in v0.19.0 

func (s *CliLogoutOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CliLogoutOK) GetData added in v0.19.0 

func (s *CliLogoutOK) GetData() CliLogoutResult

GetData returns the value of Data.

func (*CliLogoutOK) GetSuccess added in v0.19.0 

func (s *CliLogoutOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*CliLogoutOK) MarshalJSON added in v0.19.0 

func (s *CliLogoutOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliLogoutOK) SetData added in v0.19.0 

func (s *CliLogoutOK) SetData(val CliLogoutResult)

SetData sets the value of Data.

func (*CliLogoutOK) SetSuccess added in v0.19.0 

func (s *CliLogoutOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*CliLogoutOK) UnmarshalJSON added in v0.19.0 

func (s *CliLogoutOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type CliLogoutRes added in v0.19.0 

type CliLogoutRes interface {
	// contains filtered or unexported methods
}

type CliLogoutResult added in v0.19.0 

type CliLogoutResult struct {
	// True when an OAuth grant was revoked. False for API-key-authenticated legacy logout, which only
	// clears local CLI state.
	Revoked bool `json:"revoked"`
	// API key id for API-key-authenticated legacy logout.
	KeyID OptUUID `json:"key_id"`
	// OAuth grant id revoked by OAuth-authenticated logout.
	OAuthGrantID OptUUID `json:"oauth_grant_id"`
}

Ref: #/components/schemas/CliLogoutResult

func (*CliLogoutResult) Decode added in v0.19.0 

func (s *CliLogoutResult) Decode(d *jx.Decoder) error

Decode decodes CliLogoutResult from json.

func (*CliLogoutResult) Encode added in v0.19.0 

func (s *CliLogoutResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CliLogoutResult) GetKeyID added in v0.19.0 

func (s *CliLogoutResult) GetKeyID() OptUUID

GetKeyID returns the value of KeyID.

func (*CliLogoutResult) GetOAuthGrantID added in v0.29.2 

func (s *CliLogoutResult) GetOAuthGrantID() OptUUID

GetOAuthGrantID returns the value of OAuthGrantID.

func (*CliLogoutResult) GetRevoked added in v0.19.0 

func (s *CliLogoutResult) GetRevoked() bool

GetRevoked returns the value of Revoked.

func (*CliLogoutResult) MarshalJSON added in v0.19.0 

func (s *CliLogoutResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliLogoutResult) SetKeyID added in v0.19.0 

func (s *CliLogoutResult) SetKeyID(val OptUUID)

SetKeyID sets the value of KeyID.

func (*CliLogoutResult) SetOAuthGrantID added in v0.29.2 

func (s *CliLogoutResult) SetOAuthGrantID(val OptUUID)

SetOAuthGrantID sets the value of OAuthGrantID.

func (*CliLogoutResult) SetRevoked added in v0.19.0 

func (s *CliLogoutResult) SetRevoked(val bool)

SetRevoked sets the value of Revoked.

func (*CliLogoutResult) UnmarshalJSON added in v0.19.0 

func (s *CliLogoutResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type CliLogoutUnauthorized added in v0.19.0 

type CliLogoutUnauthorized ErrorResponse

func (*CliLogoutUnauthorized) Decode added in v0.19.0 

func (s *CliLogoutUnauthorized) Decode(d *jx.Decoder) error

Decode decodes CliLogoutUnauthorized from json.

func (*CliLogoutUnauthorized) Encode added in v0.19.0 

func (s *CliLogoutUnauthorized) Encode(e *jx.Encoder)

Encode encodes CliLogoutUnauthorized as json.

func (*CliLogoutUnauthorized) MarshalJSON added in v0.19.0 

func (s *CliLogoutUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliLogoutUnauthorized) UnmarshalJSON added in v0.19.0 

func (s *CliLogoutUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliLogoutUnauthorized) Validate added in v0.19.0 

func (s *CliLogoutUnauthorized) Validate() error

type CliSignupResendResult added in v0.28.0 

type CliSignupResendResult struct {
	Email string `json:"email"`
	// Seconds until the pending signup expires.
	ExpiresIn int `json:"expires_in"`
	// Minimum seconds before requesting another verification email.
	ResendAfter int `json:"resend_after"`
	// Number of digits in the emailed verification code.
	VerificationCodeLength int `json:"verification_code_length"`
}

Ref: #/components/schemas/CliSignupResendResult

func (*CliSignupResendResult) Decode added in v0.28.0 

func (s *CliSignupResendResult) Decode(d *jx.Decoder) error

Decode decodes CliSignupResendResult from json.

func (*CliSignupResendResult) Encode added in v0.28.0 

func (s *CliSignupResendResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CliSignupResendResult) GetEmail added in v0.28.0 

func (s *CliSignupResendResult) GetEmail() string

GetEmail returns the value of Email.

func (*CliSignupResendResult) GetExpiresIn added in v0.28.0 

func (s *CliSignupResendResult) GetExpiresIn() int

GetExpiresIn returns the value of ExpiresIn.

func (*CliSignupResendResult) GetResendAfter added in v0.28.0 

func (s *CliSignupResendResult) GetResendAfter() int

GetResendAfter returns the value of ResendAfter.

func (*CliSignupResendResult) GetVerificationCodeLength added in v0.28.0 

func (s *CliSignupResendResult) GetVerificationCodeLength() int

GetVerificationCodeLength returns the value of VerificationCodeLength.

func (*CliSignupResendResult) MarshalJSON added in v0.28.0 

func (s *CliSignupResendResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliSignupResendResult) SetEmail added in v0.28.0 

func (s *CliSignupResendResult) SetEmail(val string)

SetEmail sets the value of Email.

func (*CliSignupResendResult) SetExpiresIn added in v0.28.0 

func (s *CliSignupResendResult) SetExpiresIn(val int)

SetExpiresIn sets the value of ExpiresIn.

func (*CliSignupResendResult) SetResendAfter added in v0.28.0 

func (s *CliSignupResendResult) SetResendAfter(val int)

SetResendAfter sets the value of ResendAfter.

func (*CliSignupResendResult) SetVerificationCodeLength added in v0.28.0 

func (s *CliSignupResendResult) SetVerificationCodeLength(val int)

SetVerificationCodeLength sets the value of VerificationCodeLength.

func (*CliSignupResendResult) UnmarshalJSON added in v0.28.0 

func (s *CliSignupResendResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliSignupResendResult) Validate added in v0.28.0 

func (s *CliSignupResendResult) Validate() error

type CliSignupStartResult added in v0.28.0 

type CliSignupStartResult struct {
	// Opaque token used to verify or resend the pending CLI signup.
	SignupToken string `json:"signup_token"`
	Email       string `json:"email"`
	// Seconds until the pending signup expires.
	ExpiresIn int `json:"expires_in"`
	// Minimum seconds before requesting another verification email.
	ResendAfter int `json:"resend_after"`
	// Number of digits in the emailed verification code.
	VerificationCodeLength int `json:"verification_code_length"`
}

Ref: #/components/schemas/CliSignupStartResult

func (*CliSignupStartResult) Decode added in v0.28.0 

func (s *CliSignupStartResult) Decode(d *jx.Decoder) error

Decode decodes CliSignupStartResult from json.

func (*CliSignupStartResult) Encode added in v0.28.0 

func (s *CliSignupStartResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CliSignupStartResult) GetEmail added in v0.28.0 

func (s *CliSignupStartResult) GetEmail() string

GetEmail returns the value of Email.

func (*CliSignupStartResult) GetExpiresIn added in v0.28.0 

func (s *CliSignupStartResult) GetExpiresIn() int

GetExpiresIn returns the value of ExpiresIn.

func (*CliSignupStartResult) GetResendAfter added in v0.28.0 

func (s *CliSignupStartResult) GetResendAfter() int

GetResendAfter returns the value of ResendAfter.

func (*CliSignupStartResult) GetSignupToken added in v0.28.0 

func (s *CliSignupStartResult) GetSignupToken() string

GetSignupToken returns the value of SignupToken.

func (*CliSignupStartResult) GetVerificationCodeLength added in v0.28.0 

func (s *CliSignupStartResult) GetVerificationCodeLength() int

GetVerificationCodeLength returns the value of VerificationCodeLength.

func (*CliSignupStartResult) MarshalJSON added in v0.28.0 

func (s *CliSignupStartResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliSignupStartResult) SetEmail added in v0.28.0 

func (s *CliSignupStartResult) SetEmail(val string)

SetEmail sets the value of Email.

func (*CliSignupStartResult) SetExpiresIn added in v0.28.0 

func (s *CliSignupStartResult) SetExpiresIn(val int)

SetExpiresIn sets the value of ExpiresIn.

func (*CliSignupStartResult) SetResendAfter added in v0.28.0 

func (s *CliSignupStartResult) SetResendAfter(val int)

SetResendAfter sets the value of ResendAfter.

func (*CliSignupStartResult) SetSignupToken added in v0.28.0 

func (s *CliSignupStartResult) SetSignupToken(val string)

SetSignupToken sets the value of SignupToken.

func (*CliSignupStartResult) SetVerificationCodeLength added in v0.28.0 

func (s *CliSignupStartResult) SetVerificationCodeLength(val int)

SetVerificationCodeLength sets the value of VerificationCodeLength.

func (*CliSignupStartResult) UnmarshalJSON added in v0.28.0 

func (s *CliSignupStartResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliSignupStartResult) Validate added in v0.28.0 

func (s *CliSignupStartResult) Validate() error

type CliSignupVerifyResult added in v0.28.0 

type CliSignupVerifyResult struct {
	// Legacy alias for access_token. New CLI builds should persist access_token and refresh_token.
	APIKey string `json:"api_key"`
	// Legacy alias for oauth_grant_id.
	KeyID uuid.UUID `json:"key_id"`
	// Legacy display prefix derived from access_token.
	KeyPrefix string `json:"key_prefix"`
	// OAuth access token for CLI API authentication.
	AccessToken string `json:"access_token"`
	// OAuth refresh token used by the CLI to renew access.
	RefreshToken string                         `json:"refresh_token"`
	TokenType    CliSignupVerifyResultTokenType `json:"token_type"`
	// Seconds until access_token expires.
	ExpiresIn     int                             `json:"expires_in"`
	AuthMethod    CliSignupVerifyResultAuthMethod `json:"auth_method"`
	OAuthGrantID  uuid.UUID                       `json:"oauth_grant_id"`
	OAuthClientID string                          `json:"oauth_client_id"`
	OrgID         uuid.UUID                       `json:"org_id"`
	OrgName       NilString                       `json:"org_name"`
}

Ref: #/components/schemas/CliSignupVerifyResult

func (*CliSignupVerifyResult) Decode added in v0.28.0 

func (s *CliSignupVerifyResult) Decode(d *jx.Decoder) error

Decode decodes CliSignupVerifyResult from json.

func (*CliSignupVerifyResult) Encode added in v0.28.0 

func (s *CliSignupVerifyResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CliSignupVerifyResult) GetAPIKey added in v0.28.0 

func (s *CliSignupVerifyResult) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*CliSignupVerifyResult) GetAccessToken added in v0.29.2 

func (s *CliSignupVerifyResult) GetAccessToken() string

GetAccessToken returns the value of AccessToken.

func (*CliSignupVerifyResult) GetAuthMethod added in v0.29.2 

func (s *CliSignupVerifyResult) GetAuthMethod() CliSignupVerifyResultAuthMethod

GetAuthMethod returns the value of AuthMethod.

func (*CliSignupVerifyResult) GetExpiresIn added in v0.29.2 

func (s *CliSignupVerifyResult) GetExpiresIn() int

GetExpiresIn returns the value of ExpiresIn.

func (*CliSignupVerifyResult) GetKeyID added in v0.28.0 

func (s *CliSignupVerifyResult) GetKeyID() uuid.UUID

GetKeyID returns the value of KeyID.

func (*CliSignupVerifyResult) GetKeyPrefix added in v0.28.0 

func (s *CliSignupVerifyResult) GetKeyPrefix() string

GetKeyPrefix returns the value of KeyPrefix.

func (*CliSignupVerifyResult) GetOAuthClientID added in v0.29.2 

func (s *CliSignupVerifyResult) GetOAuthClientID() string

GetOAuthClientID returns the value of OAuthClientID.

func (*CliSignupVerifyResult) GetOAuthGrantID added in v0.29.2 

func (s *CliSignupVerifyResult) GetOAuthGrantID() uuid.UUID

GetOAuthGrantID returns the value of OAuthGrantID.

func (*CliSignupVerifyResult) GetOrgID added in v0.28.0 

func (s *CliSignupVerifyResult) GetOrgID() uuid.UUID

GetOrgID returns the value of OrgID.

func (*CliSignupVerifyResult) GetOrgName added in v0.28.0 

func (s *CliSignupVerifyResult) GetOrgName() NilString

GetOrgName returns the value of OrgName.

func (*CliSignupVerifyResult) GetRefreshToken added in v0.29.2 

func (s *CliSignupVerifyResult) GetRefreshToken() string

GetRefreshToken returns the value of RefreshToken.

func (*CliSignupVerifyResult) GetTokenType added in v0.29.2 

func (s *CliSignupVerifyResult) GetTokenType() CliSignupVerifyResultTokenType

GetTokenType returns the value of TokenType.

func (*CliSignupVerifyResult) MarshalJSON added in v0.28.0 

func (s *CliSignupVerifyResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CliSignupVerifyResult) SetAPIKey added in v0.28.0 

func (s *CliSignupVerifyResult) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

func (*CliSignupVerifyResult) SetAccessToken added in v0.29.2 

func (s *CliSignupVerifyResult) SetAccessToken(val string)

SetAccessToken sets the value of AccessToken.

func (*CliSignupVerifyResult) SetAuthMethod added in v0.29.2 

func (s *CliSignupVerifyResult) SetAuthMethod(val CliSignupVerifyResultAuthMethod)

SetAuthMethod sets the value of AuthMethod.

func (*CliSignupVerifyResult) SetExpiresIn added in v0.29.2 

func (s *CliSignupVerifyResult) SetExpiresIn(val int)

SetExpiresIn sets the value of ExpiresIn.

func (*CliSignupVerifyResult) SetKeyID added in v0.28.0 

func (s *CliSignupVerifyResult) SetKeyID(val uuid.UUID)

SetKeyID sets the value of KeyID.

func (*CliSignupVerifyResult) SetKeyPrefix added in v0.28.0 

func (s *CliSignupVerifyResult) SetKeyPrefix(val string)

SetKeyPrefix sets the value of KeyPrefix.

func (*CliSignupVerifyResult) SetOAuthClientID added in v0.29.2 

func (s *CliSignupVerifyResult) SetOAuthClientID(val string)

SetOAuthClientID sets the value of OAuthClientID.

func (*CliSignupVerifyResult) SetOAuthGrantID added in v0.29.2 

func (s *CliSignupVerifyResult) SetOAuthGrantID(val uuid.UUID)

SetOAuthGrantID sets the value of OAuthGrantID.

func (*CliSignupVerifyResult) SetOrgID added in v0.28.0 

func (s *CliSignupVerifyResult) SetOrgID(val uuid.UUID)

SetOrgID sets the value of OrgID.

func (*CliSignupVerifyResult) SetOrgName added in v0.28.0 

func (s *CliSignupVerifyResult) SetOrgName(val NilString)

SetOrgName sets the value of OrgName.

func (*CliSignupVerifyResult) SetRefreshToken added in v0.29.2 

func (s *CliSignupVerifyResult) SetRefreshToken(val string)

SetRefreshToken sets the value of RefreshToken.

func (*CliSignupVerifyResult) SetTokenType added in v0.29.2 

func (s *CliSignupVerifyResult) SetTokenType(val CliSignupVerifyResultTokenType)

SetTokenType sets the value of TokenType.

func (*CliSignupVerifyResult) UnmarshalJSON added in v0.28.0 

func (s *CliSignupVerifyResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliSignupVerifyResult) Validate added in v0.29.2 

func (s *CliSignupVerifyResult) Validate() error

type CliSignupVerifyResultAuthMethod added in v0.29.2 

type CliSignupVerifyResultAuthMethod string
const (
	CliSignupVerifyResultAuthMethodOAuth CliSignupVerifyResultAuthMethod = "oauth"
)

func (CliSignupVerifyResultAuthMethod) AllValues added in v0.29.2 

func (CliSignupVerifyResultAuthMethod) AllValues() []CliSignupVerifyResultAuthMethod

AllValues returns all CliSignupVerifyResultAuthMethod values.

func (*CliSignupVerifyResultAuthMethod) Decode added in v0.29.2 

func (s *CliSignupVerifyResultAuthMethod) Decode(d *jx.Decoder) error

Decode decodes CliSignupVerifyResultAuthMethod from json.

func (CliSignupVerifyResultAuthMethod) Encode added in v0.29.2 

func (s CliSignupVerifyResultAuthMethod) Encode(e *jx.Encoder)

Encode encodes CliSignupVerifyResultAuthMethod as json.

func (CliSignupVerifyResultAuthMethod) MarshalJSON added in v0.29.2 

func (s CliSignupVerifyResultAuthMethod) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (CliSignupVerifyResultAuthMethod) MarshalText added in v0.29.2 

func (s CliSignupVerifyResultAuthMethod) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*CliSignupVerifyResultAuthMethod) UnmarshalJSON added in v0.29.2 

func (s *CliSignupVerifyResultAuthMethod) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliSignupVerifyResultAuthMethod) UnmarshalText added in v0.29.2 

func (s *CliSignupVerifyResultAuthMethod) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (CliSignupVerifyResultAuthMethod) Validate added in v0.29.2 

func (s CliSignupVerifyResultAuthMethod) Validate() error

type CliSignupVerifyResultTokenType added in v0.29.2 

type CliSignupVerifyResultTokenType string
const (
	CliSignupVerifyResultTokenTypeBearer CliSignupVerifyResultTokenType = "Bearer"
)

func (CliSignupVerifyResultTokenType) AllValues added in v0.29.2 

func (CliSignupVerifyResultTokenType) AllValues() []CliSignupVerifyResultTokenType

AllValues returns all CliSignupVerifyResultTokenType values.

func (*CliSignupVerifyResultTokenType) Decode added in v0.29.2 

func (s *CliSignupVerifyResultTokenType) Decode(d *jx.Decoder) error

Decode decodes CliSignupVerifyResultTokenType from json.

func (CliSignupVerifyResultTokenType) Encode added in v0.29.2 

func (s CliSignupVerifyResultTokenType) Encode(e *jx.Encoder)

Encode encodes CliSignupVerifyResultTokenType as json.

func (CliSignupVerifyResultTokenType) MarshalJSON added in v0.29.2 

func (s CliSignupVerifyResultTokenType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (CliSignupVerifyResultTokenType) MarshalText added in v0.29.2 

func (s CliSignupVerifyResultTokenType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*CliSignupVerifyResultTokenType) UnmarshalJSON added in v0.29.2 

func (s *CliSignupVerifyResultTokenType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CliSignupVerifyResultTokenType) UnmarshalText added in v0.29.2 

func (s *CliSignupVerifyResultTokenType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (CliSignupVerifyResultTokenType) Validate added in v0.29.2 

func (s CliSignupVerifyResultTokenType) Validate() error

type Client 

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

Client implements OAS client.

func NewAPIClient 

func NewAPIClient(apiKey string, opts ...ClientOption) (*Client, error)

func NewClient 

func NewClient(serverURL string, sec SecuritySource, opts ...ClientOption) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) AddDomain 

func (c *Client) AddDomain(ctx context.Context, request *AddDomainInput) (AddDomainRes, error)

AddDomain invokes addDomain operation.

Creates an unverified domain claim and returns the exact DNS records to publish in `dns_records`. Publish those records before calling the verify endpoint. To give users an importable DNS file, call `downloadDomainZoneFile` or run `primitive domains zone-file --id <domain-id>`.

POST /domains

func (*Client) CliLogout added in v0.19.0 

func (c *Client) CliLogout(ctx context.Context, request OptCliLogoutInput) (CliLogoutRes, error)

CliLogout invokes cliLogout operation.

Revokes the OAuth grant used to authenticate the request. API-key authenticated legacy logout requests succeed without deleting server API keys so old local CLI state can be cleared safely.

POST /cli/logout

func (*Client) CreateEndpoint 

func (c *Client) CreateEndpoint(ctx context.Context, request *CreateEndpointInput) (CreateEndpointRes, error)

CreateEndpoint invokes createEndpoint operation.

Creates a new webhook endpoint. If a deactivated endpoint with the same URL and domain exists, it is reactivated instead. Subject to plan limits on the number of active endpoints. **Signing is account-scoped, not per-endpoint.** This call does not return any signing material; every endpoint on the account uses the same webhook secret, fetched via `GET /account/webhook-secret`. See the API-level "Webhook signing" section for the full wire format (header name, signed string, hash algo, secret format, tolerance) and a language-agnostic verification recipe. After creating the endpoint, fire a test delivery against it via `POST /endpoints/{id}/test` to confirm your verifier accepts the signature.

POST /endpoints

func (*Client) CreateFilter 

func (c *Client) CreateFilter(ctx context.Context, request *CreateFilterInput) (CreateFilterRes, error)

CreateFilter invokes createFilter operation.

Creates a new whitelist or blocklist filter. Per-domain filters require a Pro plan. Patterns are stored as lowercase.

POST /filters

func (*Client) CreateFunction added in v0.20.0 

func (c *Client) CreateFunction(ctx context.Context, request *CreateFunctionInput) (CreateFunctionRes, error)

CreateFunction invokes createFunction operation.

Creates and deploys a new function. The handler must be a single ESM module whose default export is an object with an async `fetch(request, env)` method (Workers-style). Primitive signs each delivery and forwards the `Primitive-Signature` header to the handler. Verify the raw request body with `PRIMITIVE_WEBHOOK_SECRET` before parsing JSON; after verification the request body parses to an `email.received` event (see `EmailReceivedEvent` and the Webhook payload section for the full schema). Code is bundled before being uploaded; ship a single self-contained file rather than relying on external imports. **Code limits.** `code` is capped at 1 MiB UTF-8. `sourceMap` (optional) is capped at 5 MiB UTF-8, stored with each deployment attempt, and sent to the runtime so stack traces can resolve to original source files. **Auto-wiring.** On successful deploy, Primitive automatically creates a webhook endpoint that delivers inbound mail to the function. There is nothing to configure on the Endpoints API for this to work; the internal runtime URL is not returned by the API and is not a customer-facing integration surface. **Secrets.** New functions ship with the managed secrets (`PRIMITIVE_WEBHOOK_SECRET`, `PRIMITIVE_API_KEY`, `PRIMITIVE_API_BASE_URL`) already bound. Add user-set secrets via `POST /functions/{id}/secrets`; secret writes only land in the running handler on the next redeploy.

POST /functions

func (*Client) CreateFunctionSecret added in v0.20.0 

func (c *Client) CreateFunctionSecret(ctx context.Context, request *CreateFunctionSecretInput, params CreateFunctionSecretParams) (CreateFunctionSecretRes, error)

CreateFunctionSecret invokes createFunctionSecret operation.

Idempotent insert-or-update keyed on `(function_id, key)`. Returns 201 the first time the key is set, 200 on subsequent updates. Values are encrypted at rest and only become visible to the running handler on the next deploy (`PUT /functions/{id}` with the existing code is sufficient to refresh bindings). Keys must match `^[A-Z_][A-Z0-9_]*$` (uppercase letters, digits, underscores; first character is a letter or underscore). Values are at most 4096 UTF-8 bytes. System- managed keys are reserved and rejected.

POST /functions/{id}/secrets

func (*Client) DeleteDomain 

func (c *Client) DeleteDomain(ctx context.Context, params DeleteDomainParams) (DeleteDomainRes, error)

DeleteDomain invokes deleteDomain operation.

Deletes a verified or unverified domain claim.

DELETE /domains/{id}

func (*Client) DeleteEmail 

func (c *Client) DeleteEmail(ctx context.Context, params DeleteEmailParams) (DeleteEmailRes, error)

DeleteEmail invokes deleteEmail operation.

Delete an email.

DELETE /emails/{id}

func (*Client) DeleteEndpoint 

func (c *Client) DeleteEndpoint(ctx context.Context, params DeleteEndpointParams) (DeleteEndpointRes, error)

DeleteEndpoint invokes deleteEndpoint operation.

Soft-deletes a webhook endpoint. The endpoint will no longer receive webhook deliveries.

DELETE /endpoints/{id}

func (*Client) DeleteFilter 

func (c *Client) DeleteFilter(ctx context.Context, params DeleteFilterParams) (DeleteFilterRes, error)

DeleteFilter invokes deleteFilter operation.

Delete a filter rule.

DELETE /filters/{id}

func (*Client) DeleteFunction added in v0.20.0 

func (c *Client) DeleteFunction(ctx context.Context, params DeleteFunctionParams) (DeleteFunctionRes, error)

DeleteFunction invokes deleteFunction operation.

Soft-deletes the function row, removes the script from the edge runtime, and deactivates the auto-wired webhook endpoint so no further inbound mail is delivered. Past deploy history, invocations, and logs are retained. Returns 502 if the runtime delete fails partway; the function row stays in place and the call is safe to retry until it succeeds.

DELETE /functions/{id}

func (*Client) DeleteFunctionSecret added in v0.20.0 

func (c *Client) DeleteFunctionSecret(ctx context.Context, params DeleteFunctionSecretParams) (DeleteFunctionSecretRes, error)

DeleteFunctionSecret invokes deleteFunctionSecret operation.

Removes the secret. The binding stays live in the running handler until the next deploy refreshes the binding set (`PUT /functions/{id}` with the existing code is sufficient). Returns 404 if the key did not exist. Managed system keys cannot be deleted.

DELETE /functions/{id}/secrets/{key}

func (*Client) DiscardEmailContent added in v0.19.0 

func (c *Client) DiscardEmailContent(ctx context.Context, params DiscardEmailContentParams) (DiscardEmailContentRes, error)

DiscardEmailContent invokes discardEmailContent operation.

Permanently deletes the email's raw bytes, parsed body (text + HTML), and attachments while preserving metadata (sender, recipient, subject, timestamps, hashes, attachment manifest) for audit logs. Idempotent: a second call returns success with `already_discarded: true` and does no work. **Gated** on the customer's discard-content opt-in (managed in the dashboard at Settings > Webhooks). When the toggle is off, this endpoint returns `403` with code `discard_not_enabled` and a message pointing the human at the dashboard. There is intentionally no API to flip this toggle. Opting in to a destructive, non-reversible operation must be a deliberate human click in the UI.

POST /emails/{id}/discard-content

func (*Client) DownloadAttachments 

func (c *Client) DownloadAttachments(ctx context.Context, params DownloadAttachmentsParams) (DownloadAttachmentsRes, error)

DownloadAttachments invokes downloadAttachments operation.

Downloads all attachments as a gzip-compressed tar archive. Authenticates via a signed download token (provided in webhook payloads) or a valid session.

GET /emails/{id}/attachments.tar.gz

func (*Client) DownloadDomainZoneFile added in v0.29.2 

func (c *Client) DownloadDomainZoneFile(ctx context.Context, params DownloadDomainZoneFileParams) (DownloadDomainZoneFileRes, error)

DownloadDomainZoneFile invokes downloadDomainZoneFile operation.

Downloads a BIND-format DNS zone file containing the DNS records required for a domain claim. Agents should offer this after `addDomain` when users want to import DNS records instead of copying each record manually.

GET /domains/{id}/zone-file

func (*Client) DownloadRawEmail 

func (c *Client) DownloadRawEmail(ctx context.Context, params DownloadRawEmailParams) (DownloadRawEmailRes, error)

DownloadRawEmail invokes downloadRawEmail operation.

Downloads the raw RFC 822 email file (.eml). Authenticates via a signed download token (provided in webhook payloads) or a valid session.

GET /emails/{id}/raw

func (*Client) GetAccount 

func (c *Client) GetAccount(ctx context.Context) (GetAccountRes, error)

GetAccount invokes getAccount operation.

Get account info.

GET /account

func (*Client) GetEmail 

func (c *Client) GetEmail(ctx context.Context, params GetEmailParams) (GetEmailRes, error)

GetEmail invokes getEmail operation.

Returns the full record for an inbound email received at one of your verified domains, including the parsed text and HTML bodies, threading metadata, SMTP envelope detail, webhook delivery state, and a `replies` array for any outbound sends recorded as replies to this inbound. For listing inbound emails (with cursor pagination, status and date filters, and free-text search), use `/emails`. Outbound (sent) email records are NOT returned here; use `/sent-emails/{id}` for those. The response carries four sender-shaped fields whose meanings overlap. `from_email` is the canonical "who sent this" field for most use cases (parsed bare address from the `From:` header, with a `sender` fallback). `from_header` is the raw header including any display name. `sender` and `smtp_mail_from` both carry the SMTP envelope MAIL FROM (return-path) and are equal by construction; `sender` is the older field name retained for compatibility. See `primitive describe emails:get-email | jq '.responseSchema.properties'` for per-field detail.

GET /emails/{id}

func (*Client) GetFunction added in v0.20.0 

func (c *Client) GetFunction(ctx context.Context, params GetFunctionParams) (GetFunctionRes, error)

GetFunction invokes getFunction operation.

Returns the full record for a function, including its current source code and the deploy status / error from the most recent deploy attempt.

GET /functions/{id}

func (*Client) GetFunctionTestRunTrace added in v0.29.0 

func (c *Client) GetFunctionTestRunTrace(ctx context.Context, params GetFunctionTestRunTraceParams) (GetFunctionTestRunTraceRes, error)

GetFunctionTestRunTrace invokes getFunctionTestRunTrace operation.

Returns the current end-to-end trace for a function test run. The trace is intentionally partial while the test is still in flight: callers can poll this endpoint and watch it fill in from send -> inbound -> webhook deliveries -> outbound requests, logs, and replies.

GET /functions/{id}/test-runs/{run_id}/trace

func (*Client) GetInboxStatus added in v0.29.3 

func (c *Client) GetInboxStatus(ctx context.Context) (GetInboxStatusRes, error)

GetInboxStatus invokes getInboxStatus operation.

Returns one consolidated view of inbound domain readiness, webhook/function processing routes, deployed Functions, and recent inbound email activity. Agents should call this before guiding a user through inbound setup. It answers the practical questions "can I receive mail", "will anything process that mail", and "what should I do next" without forcing clients to stitch together domains, endpoints, functions, and emails manually.

GET /inbox/status

func (*Client) GetSendPermissions added in v0.19.0 

func (c *Client) GetSendPermissions(ctx context.Context) (GetSendPermissionsRes, error)

GetSendPermissions invokes getSendPermissions operation.

Returns a flat list of rules describing every recipient the caller may send to. Each rule has a `type`, a kind-specific payload, and a human-readable `description`. If any rule matches the recipient, /send-mail will accept the send under the recipient-scope check. The endpoint is the answer to "where can I send" without exposing internal entitlement names. Agents that don't recognize a `type` can still read the `description` prose and act on it. Rule kinds, ordered broadest-first so an agent can stop scanning at the first match: 1. `any_recipient` (one entry, only when the org can send anywhere): every other rule below it is redundant. 2. `managed_zone` (always emitted, one per Primitive-managed zone): sends to any address at *.primitive.email or *.email.works always succeed; no entitlement required. 3. `your_domain` (one per active verified outbound domain owned by the org): sends to that domain are approved. 4. `address` (one per address that has authenticated inbound mail to the org, capped at `meta.address_cap`): sends to that exact address are approved. The list is informational, not an authorization check. /send-mail remains the source of truth on whether an individual send will succeed (it also enforces the from-address and the `send_mail` entitlement, which are not recipient-scope concerns and are not represented here).

GET /send-permissions

func (*Client) GetSentEmail added in v0.19.0 

func (c *Client) GetSentEmail(ctx context.Context, params GetSentEmailParams) (GetSentEmailRes, error)

GetSentEmail invokes getSentEmail operation.

Returns the full sent-email record by id, including `body_text` and `body_html` (omitted from the listing endpoint to keep paginated responses small). Use this when diagnosing a specific send, e.g. inspecting the receiver's SMTP response on a `bounced` row or pulling the gate denial detail on a `gate_denied` row.

GET /sent-emails/{id}

func (*Client) GetStorageStats 

func (c *Client) GetStorageStats(ctx context.Context) (GetStorageStatsRes, error)

GetStorageStats invokes getStorageStats operation.

Get storage usage.

GET /account/storage

func (*Client) GetWebhookSecret 

func (c *Client) GetWebhookSecret(ctx context.Context) (GetWebhookSecretRes, error)

GetWebhookSecret invokes getWebhookSecret operation.

Returns the webhook signing secret for your account. If no secret exists yet, one is generated automatically on first access. Signing is account-scoped, not per-endpoint. Every webhook delivery from any of your registered endpoints is signed with this single secret. Rotate via `POST /account/webhook-secret/rotate`. **Secret format**: the returned string looks base64-shaped (e.g. `XNHBBW8VqoBjRfNs1tkZj11jTk...`) but is NOT base64. Use it AS-IS as a UTF-8 string when computing HMAC over a delivery body. Base64-decoding before HMAC will silently produce mismatched signatures. See the API-level "Webhook signing" section for the full wire format (header name, signed string shape, hash algo, tolerance) including a language-agnostic verification recipe.

GET /account/webhook-secret

func (*Client) ListDeliveries 

func (c *Client) ListDeliveries(ctx context.Context, params ListDeliveriesParams) (ListDeliveriesRes, error)

ListDeliveries invokes listDeliveries operation.

Returns a paginated list of webhook delivery attempts. Each delivery includes a nested `email` object with sender, recipient, and subject.

GET /webhooks/deliveries

func (*Client) ListDomains 

func (c *Client) ListDomains(ctx context.Context) (ListDomainsRes, error)

ListDomains invokes listDomains operation.

Returns all verified and unverified domains for your organization, sorted by creation date (newest first). Each domain includes a `verified` boolean to distinguish between the two states.

GET /domains

func (*Client) ListEmails 

func (c *Client) ListEmails(ctx context.Context, params ListEmailsParams) (ListEmailsRes, error)

ListEmails invokes listEmails operation.

Returns a paginated list of INBOUND emails received at your verified domains. Outbound messages sent via /send-mail are not included; this endpoint is the inbox view, not a unified send/receive history. Supports filtering by domain, status, date range, and free-text search across subject, sender, and recipient fields. For a compact text-table summary of the most recent N inbounds (no filters, no cursor pagination), the CLI ships `primitive emails:latest` as a one-line-per-email shortcut. It's TTY-aware so id columns are full UUIDs when piped, and a `--json` flag returns the same envelope this endpoint does. Use whichever fits the call site.

GET /emails

func (*Client) ListEndpoints 

func (c *Client) ListEndpoints(ctx context.Context) (ListEndpointsRes, error)

ListEndpoints invokes listEndpoints operation.

Returns all active (non-deleted) webhook endpoints.

GET /endpoints

func (*Client) ListFilters 

func (c *Client) ListFilters(ctx context.Context) (ListFiltersRes, error)

ListFilters invokes listFilters operation.

Returns all whitelist and blocklist filter rules.

GET /filters

func (*Client) ListFunctionLogs added in v0.26.0 

func (c *Client) ListFunctionLogs(ctx context.Context, params ListFunctionLogsParams) (ListFunctionLogsRes, error)

ListFunctionLogs invokes listFunctionLogs operation.

Returns the most recent `function_logs` rows for the function, newest first. Each row is a single `console.log` / `console.error` invocation captured from the running handler. Page through history with the opaque `cursor` returned as `next_cursor`; pass it back as the `cursor` query param on the next call. `next_cursor` is `null` when there are no further rows. The cursor format is an implementation detail and should not be parsed by callers.

GET /functions/{id}/logs

func (*Client) ListFunctionSecrets added in v0.20.0 

func (c *Client) ListFunctionSecrets(ctx context.Context, params ListFunctionSecretsParams) (ListFunctionSecretsRes, error)

ListFunctionSecrets invokes listFunctionSecrets operation.

Returns metadata for every secret bound to the function, with managed entries (provisioned by Primitive) listed first and user-set entries listed alphabetically after. **Values are never returned.** Secret writes are write-only. Managed entries (e.g. `PRIMITIVE_WEBHOOK_SECRET`, `PRIMITIVE_API_KEY`, `PRIMITIVE_API_BASE_URL`) carry a `description` instead of `created_at` / `updated_at`. They cannot be created, updated, or deleted via this API.

GET /functions/{id}/secrets

func (*Client) ListFunctions added in v0.20.0 

func (c *Client) ListFunctions(ctx context.Context) (ListFunctionsRes, error)

ListFunctions invokes listFunctions operation.

Returns every active (non-deleted) function in the org, newest first. Each entry carries deploy status and timestamps. To inspect the source code or deploy errors, use `GET /functions/{id}`.

GET /functions

func (*Client) ListSentEmails added in v0.19.0 

func (c *Client) ListSentEmails(ctx context.Context, params ListSentEmailsParams) (ListSentEmailsRes, error)

ListSentEmails invokes listSentEmails operation.

Returns a paginated list of OUTBOUND emails the caller's org has sent via /send-mail (and /emails/{id}/reply, which forwards through /send-mail). Includes every recorded attempt, including gate-denied attempts that the agent never called and rows still in `queued` state. For inbound mail received at your verified domains, see /emails. There is no unified send/receive history endpoint; the two surfaces are intentionally separate because the underlying tables, statuses, and lifecycle differ. Email bodies (`body_text`, `body_html`) are NOT included on list rows so a 50-row page can't balloon into a multi-MB response when sends are near the 5MB body cap. Use /sent-emails/{id} to fetch a single row with bodies, or cross-reference by `client_idempotency_key` if the caller already has the body locally.

GET /sent-emails

func (*Client) PollCliLogin added in v0.19.0 

func (c *Client) PollCliLogin(ctx context.Context, request *PollCliLoginInput) (PollCliLoginRes, error)

PollCliLogin invokes pollCliLogin operation.

Polls a CLI login session until the browser approval either succeeds, is denied, expires, or is polled too quickly. The OAuth token set is created only after approval and is returned exactly once.

POST /cli/login/poll

func (*Client) ReplayDelivery 

func (c *Client) ReplayDelivery(ctx context.Context, params ReplayDeliveryParams) (ReplayDeliveryRes, error)

ReplayDelivery invokes replayDelivery operation.

Re-sends the stored webhook payload from a previous delivery attempt. If the original endpoint is still active, it is targeted. If the original endpoint was deleted, the oldest active endpoint is used. Deactivated endpoints cannot be replayed to. Rate limited per-org, sharing an org-wide budget with email replays.

POST /webhooks/deliveries/{id}/replay

func (*Client) ReplayEmailWebhooks 

func (c *Client) ReplayEmailWebhooks(ctx context.Context, params ReplayEmailWebhooksParams) (ReplayEmailWebhooksRes, error)

ReplayEmailWebhooks invokes replayEmailWebhooks operation.

Re-delivers the webhook payload for this email to all active endpoints matching the email's domain. Rate limited per-email (short cooldown between successive replays of the same email) and per-org (burst + sustained windows), sharing an org-wide budget with delivery replays.

POST /emails/{id}/replay

func (*Client) ReplyToEmail added in v0.10.0 

func (c *Client) ReplyToEmail(ctx context.Context, request *ReplyInput, params ReplyToEmailParams) (ReplyToEmailRes, error)

ReplyToEmail invokes replyToEmail operation.

Sends an outbound reply to the inbound email identified by `id`. Threading headers (`In-Reply-To`, `References`), recipient derivation (Reply-To, then From, then bare sender), and the `Re:` subject prefix are all derived server-side from the stored inbound row. The request body carries only the message body and optional `wait` flag; passing any header or recipient override is rejected by the schema (`additionalProperties: false`). Forwards through the same gates as `/send-mail`: the response status, error envelope, and `idempotent_replay` flag mirror the send-mail contract verbatim.

POST /emails/{id}/reply

func (*Client) ResendAgentSignupVerification added in v0.29.2 

func (c *Client) ResendAgentSignupVerification(ctx context.Context, request *ResendAgentSignupVerificationInput) (ResendAgentSignupVerificationRes, error)

ResendAgentSignupVerification invokes resendAgentSignupVerification operation.

Sends a new email verification code for a pending agent signup session. This endpoint does not require an API key.

POST /agent/signup/resend

func (*Client) ResendCliSignupVerification added in v0.28.0 

func (c *Client) ResendCliSignupVerification(ctx context.Context, request *ResendCliSignupVerificationInput) (ResendCliSignupVerificationRes, error)

ResendCliSignupVerification invokes resendCliSignupVerification operation.

Sends a new email verification code for a pending CLI signup session. This endpoint does not require an API key.

POST /cli/signup/resend

func (*Client) RotateWebhookSecret 

func (c *Client) RotateWebhookSecret(ctx context.Context) (RotateWebhookSecretRes, error)

RotateWebhookSecret invokes rotateWebhookSecret operation.

Generates a new webhook signing secret, replacing the current one. Rate limited to once per 60 minutes.

POST /account/webhook-secret/rotate

func (*Client) SearchEmails added in v0.21.0 

func (c *Client) SearchEmails(ctx context.Context, params SearchEmailsParams) (SearchEmailsRes, error)

SearchEmails invokes searchEmails operation.

Searches inbound emails with structured filters and optional full-text matching across parsed email fields. This endpoint is optimized for filtered inbox views and CLI polling workflows: callers that only need new accepted mail can pass `sort=received_at_asc`, `snippet=false`, `include_facets=false`, and a `date_from` timestamp. `q`, `subject`, and `body` use the same English full-text index as the web inbox search. Structured filters such as `from`, `to`, `domain_id`, status, attachment presence, and spam score bounds are combined with the text query.

GET /emails/search

func (*Client) SendEmail added in v0.8.0 

func (c *Client) SendEmail(ctx context.Context, request *SendMailInput, params SendEmailParams) (SendEmailRes, error)

SendEmail invokes sendEmail operation.

Sends an outbound email through Primitive's outbound relay. By default the request returns once the relay accepts the message for delivery. Set `wait: true` to wait for the first downstream SMTP delivery outcome. **Host routing.** /send-mail is served by the attachments- supporting host (`https://api.primitive.dev/v1`) so the request body can carry inline attachments up to ~30 MiB raw. The primary host (`https://www.primitive.dev/api/v1`) also accepts /send-mail for attachment-free sends; sends WITH attachments to the primary host return 413 `attachments_unsupported_on_this_endpoint`. The typed SDKs route /send-mail to the attachments host automatically.

POST /send-mail

func (*Client) SetFunctionSecret added in v0.20.0 

func (c *Client) SetFunctionSecret(ctx context.Context, request *SetFunctionSecretInput, params SetFunctionSecretParams) (SetFunctionSecretRes, error)

SetFunctionSecret invokes setFunctionSecret operation.

Path-keyed companion to `POST /functions/{id}/secrets`. Idempotent: returns 201 the first time the key is set, 200 on subsequent updates. Same validation rules and same write-only guarantees as the POST verb; the new value lands in the running handler on the next deploy.

PUT /functions/{id}/secrets/{key}

func (*Client) StartAgentSignup added in v0.29.2 

func (c *Client) StartAgentSignup(ctx context.Context, request *StartAgentSignupInput) (StartAgentSignupRes, error)

StartAgentSignup invokes startAgentSignup operation.

Starts an agent-native signup session. The API validates the signup code, creates a pending signup session, sends an email verification code, and returns an opaque signup token used by the resend and verify steps. This endpoint does not require an API key.

POST /agent/signup/start

func (*Client) StartCliLogin added in v0.19.0 

func (c *Client) StartCliLogin(ctx context.Context, request OptStartCliLoginInput) (StartCliLoginRes, error)

StartCliLogin invokes startCliLogin operation.

Starts a browser-assisted CLI login session. The response includes a device code for polling and a user code that the user approves in the browser. This endpoint does not require an API key.

POST /cli/login/start

func (*Client) StartCliSignup added in v0.28.0 

func (c *Client) StartCliSignup(ctx context.Context, request *StartCliSignupInput) (StartCliSignupRes, error)

StartCliSignup invokes startCliSignup operation.

Starts a terminal-native CLI signup. The API validates the signup code, creates a pending signup session, sends an email verification code, and returns an opaque signup token used by the resend and verify steps. This endpoint does not require an API key.

POST /cli/signup/start

func (*Client) TestEndpoint 

func (c *Client) TestEndpoint(ctx context.Context, params TestEndpointParams) (TestEndpointRes, error)

TestEndpoint invokes testEndpoint operation.

Sends a sample `email.received` event to the endpoint. The request includes SSRF protection (private IP rejection and DNS pinning). Rate limited to 4 per minute and 30 per hour (non-exempt). Successful deliveries and verified-domain endpoints are exempt from the rate limit.

POST /endpoints/{id}/test

func (*Client) TestFunction added in v0.20.0 

func (c *Client) TestFunction(ctx context.Context, request OptTestFunctionReq, params TestFunctionParams) (TestFunctionRes, error)

TestFunction invokes testFunction operation.

Sends a real test email from a Primitive-controlled sender to a local-part on one of the org's verified inbound domains. By default the recipient is a synthetic `__primitive_function_test+<random>@<domain>` address on a domain selected to route to the function. Scoped functions use their scoped domain; fallback functions use a domain that has no enabled domain-scoped endpoint. Pass `local_part` to override and exercise routing logic that branches on a specific recipient (the common pattern when one function handles multiple inboxes like `summarize@` and `action@`). The function fires through the normal MX delivery path, so reply / send-mail calls from inside the handler against the inbound's `email.id` work the same as in production. Returns immediately after the send is queued; the invocation appears on the function's invocations list within a few seconds. Requires that the function is currently `deployed`. Returns 422 if the function is in `pending` or `failed` state, or if the org has no verified inbound domain to receive the test mail. Returns 400 if `local_part` is set to a value that does not match the local-part character set.

POST /functions/{id}/test

func (*Client) UpdateAccount 

func (c *Client) UpdateAccount(ctx context.Context, request *UpdateAccountInput) (UpdateAccountRes, error)

UpdateAccount invokes updateAccount operation.

Update account settings.

PATCH /account

func (*Client) UpdateDomain 

func (c *Client) UpdateDomain(ctx context.Context, request *UpdateDomainInput, params UpdateDomainParams) (UpdateDomainRes, error)

UpdateDomain invokes updateDomain operation.

Update a verified domain's settings. Only verified domains can be updated. Per-domain spam thresholds require a Pro plan.

PATCH /domains/{id}

func (*Client) UpdateEndpoint 

func (c *Client) UpdateEndpoint(ctx context.Context, request *UpdateEndpointInput, params UpdateEndpointParams) (UpdateEndpointRes, error)

UpdateEndpoint invokes updateEndpoint operation.

Updates an active webhook endpoint. If the URL is changed, the old endpoint is deactivated and a new one is created (or an existing deactivated endpoint with the new URL is reactivated).

PATCH /endpoints/{id}

func (*Client) UpdateFilter 

func (c *Client) UpdateFilter(ctx context.Context, request *UpdateFilterInput, params UpdateFilterParams) (UpdateFilterRes, error)

UpdateFilter invokes updateFilter operation.

Toggle a filter's enabled state.

PATCH /filters/{id}

func (*Client) UpdateFunction added in v0.20.0 

func (c *Client) UpdateFunction(ctx context.Context, request *UpdateFunctionInput, params UpdateFunctionParams) (UpdateFunctionRes, error)

UpdateFunction invokes updateFunction operation.

Replaces the function's source code with the body's `code` and triggers a redeploy. Same size limits as `POST /functions`. Use this verb to push secret writes into the running handler: passing the same `code` re-runs the deploy and refreshes the binding set with the latest values from the secrets table. On deploy failure, the previously-deployed code stays live; the runtime never serves a half-built bundle. The response uses `error.code` `deploy_failed`, and the function's `deploy_error` field carries the latest deploy error for dashboard/API reads.

PUT /functions/{id}

func (*Client) VerifyAgentSignup added in v0.29.2 

func (c *Client) VerifyAgentSignup(ctx context.Context, request *VerifyAgentSignupInput) (VerifyAgentSignupRes, error)

VerifyAgentSignup invokes verifyAgentSignup operation.

Verifies the email code for an agent signup session, creates the account when needed, redeems the reserved signup code, mints an org-scoped OAuth session for CLI authentication, and returns the raw tokens exactly once. For existing users, the optional `org_id` selects which accessible workspace should receive the new session.

POST /agent/signup/verify

func (*Client) VerifyCliSignup added in v0.28.0 

func (c *Client) VerifyCliSignup(ctx context.Context, request *VerifyCliSignupInput) (VerifyCliSignupRes, error)

VerifyCliSignup invokes verifyCliSignup operation.

Verifies the email code for a CLI signup session, creates the account, redeems the reserved signup code, creates an org-scoped OAuth CLI session, and returns the token set exactly once. This endpoint does not require an API key.

POST /cli/signup/verify

func (*Client) VerifyDomain 

func (c *Client) VerifyDomain(ctx context.Context, params VerifyDomainParams) (VerifyDomainRes, error)

VerifyDomain invokes verifyDomain operation.

Checks DNS records required for inbound routing, ownership, and outbound authentication: MX, ownership TXT, SPF, DKIM, DMARC, and TLS-RPT. On success, the domain is promoted from unverified to verified. On failure, returns which checks passed and which failed, plus the exact DNS records still expected. To give users an importable DNS file for missing records, call `downloadDomainZoneFile` or run `primitive domains zone-file --id <domain-id>`.

POST /domains/{id}/verify

type ClientOption 

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption is client config option.

func WithClient 

func WithClient(client ht.Client) ClientOption

WithClient specifies http client to use.

type CreateEndpointBadRequest 

type CreateEndpointBadRequest ErrorResponse

func (*CreateEndpointBadRequest) Decode 

func (s *CreateEndpointBadRequest) Decode(d *jx.Decoder) error

Decode decodes CreateEndpointBadRequest from json.

func (*CreateEndpointBadRequest) Encode 

func (s *CreateEndpointBadRequest) Encode(e *jx.Encoder)

Encode encodes CreateEndpointBadRequest as json.

func (*CreateEndpointBadRequest) MarshalJSON 

func (s *CreateEndpointBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateEndpointBadRequest) UnmarshalJSON 

func (s *CreateEndpointBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateEndpointBadRequest) Validate 

func (s *CreateEndpointBadRequest) Validate() error

type CreateEndpointCreated 

type CreateEndpointCreated struct {
	Success bool     `json:"success"`
	Data    Endpoint `json:"data"`
}

Merged schema.

func (*CreateEndpointCreated) Decode 

func (s *CreateEndpointCreated) Decode(d *jx.Decoder) error

Decode decodes CreateEndpointCreated from json.

func (*CreateEndpointCreated) Encode 

func (s *CreateEndpointCreated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateEndpointCreated) GetData 

func (s *CreateEndpointCreated) GetData() Endpoint

GetData returns the value of Data.

func (*CreateEndpointCreated) GetSuccess 

func (s *CreateEndpointCreated) GetSuccess() bool

GetSuccess returns the value of Success.

func (*CreateEndpointCreated) MarshalJSON 

func (s *CreateEndpointCreated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateEndpointCreated) SetData 

func (s *CreateEndpointCreated) SetData(val Endpoint)

SetData sets the value of Data.

func (*CreateEndpointCreated) SetSuccess 

func (s *CreateEndpointCreated) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*CreateEndpointCreated) UnmarshalJSON 

func (s *CreateEndpointCreated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type CreateEndpointInput 

type CreateEndpointInput struct {
	// The webhook URL to deliver events to.
	URL string `json:"url"`
	// Whether the endpoint is active.
	Enabled OptBool `json:"enabled"`
	// Restrict to emails from a specific domain.
	DomainID OptNilUUID `json:"domain_id"`
	// Endpoint-specific filtering rules.
	Rules *CreateEndpointInputRules `json:"rules"`
}

Ref: #/components/schemas/CreateEndpointInput

func (*CreateEndpointInput) Decode 

func (s *CreateEndpointInput) Decode(d *jx.Decoder) error

Decode decodes CreateEndpointInput from json.

func (*CreateEndpointInput) Encode 

func (s *CreateEndpointInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateEndpointInput) GetDomainID 

func (s *CreateEndpointInput) GetDomainID() OptNilUUID

GetDomainID returns the value of DomainID.

func (*CreateEndpointInput) GetEnabled 

func (s *CreateEndpointInput) GetEnabled() OptBool

GetEnabled returns the value of Enabled.

func (*CreateEndpointInput) GetRules 

func (s *CreateEndpointInput) GetRules() *CreateEndpointInputRules

GetRules returns the value of Rules.

func (*CreateEndpointInput) GetURL 

func (s *CreateEndpointInput) GetURL() string

GetURL returns the value of URL.

func (*CreateEndpointInput) MarshalJSON 

func (s *CreateEndpointInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateEndpointInput) SetDomainID 

func (s *CreateEndpointInput) SetDomainID(val OptNilUUID)

SetDomainID sets the value of DomainID.

func (*CreateEndpointInput) SetEnabled 

func (s *CreateEndpointInput) SetEnabled(val OptBool)

SetEnabled sets the value of Enabled.

func (*CreateEndpointInput) SetRules 

func (s *CreateEndpointInput) SetRules(val *CreateEndpointInputRules)

SetRules sets the value of Rules.

func (*CreateEndpointInput) SetURL 

func (s *CreateEndpointInput) SetURL(val string)

SetURL sets the value of URL.

func (*CreateEndpointInput) UnmarshalJSON 

func (s *CreateEndpointInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateEndpointInput) Validate 

func (s *CreateEndpointInput) Validate() error

type CreateEndpointInputRules 

type CreateEndpointInputRules struct{}

Endpoint-specific filtering rules.

func (*CreateEndpointInputRules) Decode 

func (s *CreateEndpointInputRules) Decode(d *jx.Decoder) error

Decode decodes CreateEndpointInputRules from json.

func (*CreateEndpointInputRules) Encode 

func (s *CreateEndpointInputRules) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateEndpointInputRules) MarshalJSON 

func (s *CreateEndpointInputRules) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateEndpointInputRules) UnmarshalJSON 

func (s *CreateEndpointInputRules) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type CreateEndpointRes 

type CreateEndpointRes interface {
	// contains filtered or unexported methods
}

type CreateEndpointUnauthorized 

type CreateEndpointUnauthorized ErrorResponse

func (*CreateEndpointUnauthorized) Decode 

func (s *CreateEndpointUnauthorized) Decode(d *jx.Decoder) error

Decode decodes CreateEndpointUnauthorized from json.

func (*CreateEndpointUnauthorized) Encode 

func (s *CreateEndpointUnauthorized) Encode(e *jx.Encoder)

Encode encodes CreateEndpointUnauthorized as json.

func (*CreateEndpointUnauthorized) MarshalJSON 

func (s *CreateEndpointUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateEndpointUnauthorized) UnmarshalJSON 

func (s *CreateEndpointUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateEndpointUnauthorized) Validate 

func (s *CreateEndpointUnauthorized) Validate() error

type CreateFilterBadRequest 

type CreateFilterBadRequest ErrorResponse

func (*CreateFilterBadRequest) Decode 

func (s *CreateFilterBadRequest) Decode(d *jx.Decoder) error

Decode decodes CreateFilterBadRequest from json.

func (*CreateFilterBadRequest) Encode 

func (s *CreateFilterBadRequest) Encode(e *jx.Encoder)

Encode encodes CreateFilterBadRequest as json.

func (*CreateFilterBadRequest) MarshalJSON 

func (s *CreateFilterBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFilterBadRequest) UnmarshalJSON 

func (s *CreateFilterBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFilterBadRequest) Validate 

func (s *CreateFilterBadRequest) Validate() error

type CreateFilterCreated 

type CreateFilterCreated struct {
	Success bool   `json:"success"`
	Data    Filter `json:"data"`
}

Merged schema.

func (*CreateFilterCreated) Decode 

func (s *CreateFilterCreated) Decode(d *jx.Decoder) error

Decode decodes CreateFilterCreated from json.

func (*CreateFilterCreated) Encode 

func (s *CreateFilterCreated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateFilterCreated) GetData 

func (s *CreateFilterCreated) GetData() Filter

GetData returns the value of Data.

func (*CreateFilterCreated) GetSuccess 

func (s *CreateFilterCreated) GetSuccess() bool

GetSuccess returns the value of Success.

func (*CreateFilterCreated) MarshalJSON 

func (s *CreateFilterCreated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFilterCreated) SetData 

func (s *CreateFilterCreated) SetData(val Filter)

SetData sets the value of Data.

func (*CreateFilterCreated) SetSuccess 

func (s *CreateFilterCreated) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*CreateFilterCreated) UnmarshalJSON 

func (s *CreateFilterCreated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFilterCreated) Validate 

func (s *CreateFilterCreated) Validate() error

type CreateFilterInput 

type CreateFilterInput struct {
	Type CreateFilterInputType `json:"type"`
	// Email address or pattern to filter.
	Pattern string `json:"pattern"`
	// Restrict filter to a specific domain (Pro plan required).
	DomainID OptNilUUID `json:"domain_id"`
}

Ref: #/components/schemas/CreateFilterInput

func (*CreateFilterInput) Decode 

func (s *CreateFilterInput) Decode(d *jx.Decoder) error

Decode decodes CreateFilterInput from json.

func (*CreateFilterInput) Encode 

func (s *CreateFilterInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateFilterInput) GetDomainID 

func (s *CreateFilterInput) GetDomainID() OptNilUUID

GetDomainID returns the value of DomainID.

func (*CreateFilterInput) GetPattern 

func (s *CreateFilterInput) GetPattern() string

GetPattern returns the value of Pattern.

func (*CreateFilterInput) GetType 

func (s *CreateFilterInput) GetType() CreateFilterInputType

GetType returns the value of Type.

func (*CreateFilterInput) MarshalJSON 

func (s *CreateFilterInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFilterInput) SetDomainID 

func (s *CreateFilterInput) SetDomainID(val OptNilUUID)

SetDomainID sets the value of DomainID.

func (*CreateFilterInput) SetPattern 

func (s *CreateFilterInput) SetPattern(val string)

SetPattern sets the value of Pattern.

func (*CreateFilterInput) SetType 

func (s *CreateFilterInput) SetType(val CreateFilterInputType)

SetType sets the value of Type.

func (*CreateFilterInput) UnmarshalJSON 

func (s *CreateFilterInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFilterInput) Validate 

func (s *CreateFilterInput) Validate() error

type CreateFilterInputType 

type CreateFilterInputType string
const (
	CreateFilterInputTypeWhitelist CreateFilterInputType = "whitelist"
	CreateFilterInputTypeBlocklist CreateFilterInputType = "blocklist"
)

func (CreateFilterInputType) AllValues 

func (CreateFilterInputType) AllValues() []CreateFilterInputType

AllValues returns all CreateFilterInputType values.

func (*CreateFilterInputType) Decode 

func (s *CreateFilterInputType) Decode(d *jx.Decoder) error

Decode decodes CreateFilterInputType from json.

func (CreateFilterInputType) Encode 

func (s CreateFilterInputType) Encode(e *jx.Encoder)

Encode encodes CreateFilterInputType as json.

func (CreateFilterInputType) MarshalJSON 

func (s CreateFilterInputType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (CreateFilterInputType) MarshalText 

func (s CreateFilterInputType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*CreateFilterInputType) UnmarshalJSON 

func (s *CreateFilterInputType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFilterInputType) UnmarshalText 

func (s *CreateFilterInputType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (CreateFilterInputType) Validate 

func (s CreateFilterInputType) Validate() error

type CreateFilterNotFound 

type CreateFilterNotFound ErrorResponse

func (*CreateFilterNotFound) Decode 

func (s *CreateFilterNotFound) Decode(d *jx.Decoder) error

Decode decodes CreateFilterNotFound from json.

func (*CreateFilterNotFound) Encode 

func (s *CreateFilterNotFound) Encode(e *jx.Encoder)

Encode encodes CreateFilterNotFound as json.

func (*CreateFilterNotFound) MarshalJSON 

func (s *CreateFilterNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFilterNotFound) UnmarshalJSON 

func (s *CreateFilterNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFilterNotFound) Validate 

func (s *CreateFilterNotFound) Validate() error

type CreateFilterRes 

type CreateFilterRes interface {
	// contains filtered or unexported methods
}

type CreateFilterUnauthorized 

type CreateFilterUnauthorized ErrorResponse

func (*CreateFilterUnauthorized) Decode 

func (s *CreateFilterUnauthorized) Decode(d *jx.Decoder) error

Decode decodes CreateFilterUnauthorized from json.

func (*CreateFilterUnauthorized) Encode 

func (s *CreateFilterUnauthorized) Encode(e *jx.Encoder)

Encode encodes CreateFilterUnauthorized as json.

func (*CreateFilterUnauthorized) MarshalJSON 

func (s *CreateFilterUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFilterUnauthorized) UnmarshalJSON 

func (s *CreateFilterUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFilterUnauthorized) Validate 

func (s *CreateFilterUnauthorized) Validate() error

type CreateFunctionBadRequest added in v0.20.0 

type CreateFunctionBadRequest ErrorResponse

func (*CreateFunctionBadRequest) Decode added in v0.20.0 

func (s *CreateFunctionBadRequest) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionBadRequest from json.

func (*CreateFunctionBadRequest) Encode added in v0.20.0 

func (s *CreateFunctionBadRequest) Encode(e *jx.Encoder)

Encode encodes CreateFunctionBadRequest as json.

func (*CreateFunctionBadRequest) MarshalJSON added in v0.20.0 

func (s *CreateFunctionBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionBadRequest) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionBadRequest) Validate added in v0.20.0 

func (s *CreateFunctionBadRequest) Validate() error

type CreateFunctionConflict added in v0.20.0 

type CreateFunctionConflict ErrorResponse

func (*CreateFunctionConflict) Decode added in v0.20.0 

func (s *CreateFunctionConflict) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionConflict from json.

func (*CreateFunctionConflict) Encode added in v0.20.0 

func (s *CreateFunctionConflict) Encode(e *jx.Encoder)

Encode encodes CreateFunctionConflict as json.

func (*CreateFunctionConflict) MarshalJSON added in v0.20.0 

func (s *CreateFunctionConflict) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionConflict) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionConflict) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionConflict) Validate added in v0.20.0 

func (s *CreateFunctionConflict) Validate() error

type CreateFunctionCreated added in v0.20.0 

type CreateFunctionCreated struct {
	Success bool                 `json:"success"`
	Data    CreateFunctionResult `json:"data"`
}

Merged schema.

func (*CreateFunctionCreated) Decode added in v0.20.0 

func (s *CreateFunctionCreated) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionCreated from json.

func (*CreateFunctionCreated) Encode added in v0.20.0 

func (s *CreateFunctionCreated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateFunctionCreated) GetData added in v0.20.0 

func (s *CreateFunctionCreated) GetData() CreateFunctionResult

GetData returns the value of Data.

func (*CreateFunctionCreated) GetSuccess added in v0.20.0 

func (s *CreateFunctionCreated) GetSuccess() bool

GetSuccess returns the value of Success.

func (*CreateFunctionCreated) MarshalJSON added in v0.20.0 

func (s *CreateFunctionCreated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionCreated) SetData added in v0.20.0 

func (s *CreateFunctionCreated) SetData(val CreateFunctionResult)

SetData sets the value of Data.

func (*CreateFunctionCreated) SetSuccess added in v0.20.0 

func (s *CreateFunctionCreated) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*CreateFunctionCreated) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionCreated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionCreated) Validate added in v0.20.0 

func (s *CreateFunctionCreated) Validate() error

type CreateFunctionFailedDependency added in v0.28.0 

type CreateFunctionFailedDependency ErrorResponse

func (*CreateFunctionFailedDependency) Decode added in v0.28.0 

func (s *CreateFunctionFailedDependency) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionFailedDependency from json.

func (*CreateFunctionFailedDependency) Encode added in v0.28.0 

func (s *CreateFunctionFailedDependency) Encode(e *jx.Encoder)

Encode encodes CreateFunctionFailedDependency as json.

func (*CreateFunctionFailedDependency) MarshalJSON added in v0.28.0 

func (s *CreateFunctionFailedDependency) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionFailedDependency) UnmarshalJSON added in v0.28.0 

func (s *CreateFunctionFailedDependency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionFailedDependency) Validate added in v0.28.0 

func (s *CreateFunctionFailedDependency) Validate() error

type CreateFunctionInput added in v0.20.0 

type CreateFunctionInput struct {
	// Slug-style name. Lowercase letters, digits, hyphens, and
	// underscores. 1 to 64 characters. Must be unique within the
	// org; a 409 is returned on collision.
	Name string `json:"name"`
	// Bundled handler as a single ESM module. Up to 1 MiB UTF-8.
	// Must export a default `{ async fetch(req, env, ctx) { ... } }`
	// object.
	Code string `json:"code"`
	// Optional source map for the bundle. Up to 5 MiB UTF-8.
	// Stored with the deployment attempt and sent to the runtime
	// to symbolicate stack traces in the function's logs.
	SourceMap OptString `json:"sourceMap"`
}

Ref: #/components/schemas/CreateFunctionInput

func (*CreateFunctionInput) Decode added in v0.20.0 

func (s *CreateFunctionInput) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionInput from json.

func (*CreateFunctionInput) Encode added in v0.20.0 

func (s *CreateFunctionInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateFunctionInput) GetCode added in v0.20.0 

func (s *CreateFunctionInput) GetCode() string

GetCode returns the value of Code.

func (*CreateFunctionInput) GetName added in v0.20.0 

func (s *CreateFunctionInput) GetName() string

GetName returns the value of Name.

func (*CreateFunctionInput) GetSourceMap added in v0.20.0 

func (s *CreateFunctionInput) GetSourceMap() OptString

GetSourceMap returns the value of SourceMap.

func (*CreateFunctionInput) MarshalJSON added in v0.20.0 

func (s *CreateFunctionInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionInput) SetCode added in v0.20.0 

func (s *CreateFunctionInput) SetCode(val string)

SetCode sets the value of Code.

func (*CreateFunctionInput) SetName added in v0.20.0 

func (s *CreateFunctionInput) SetName(val string)

SetName sets the value of Name.

func (*CreateFunctionInput) SetSourceMap added in v0.20.0 

func (s *CreateFunctionInput) SetSourceMap(val OptString)

SetSourceMap sets the value of SourceMap.

func (*CreateFunctionInput) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionInput) Validate added in v0.20.0 

func (s *CreateFunctionInput) Validate() error

type CreateFunctionRes added in v0.20.0 

type CreateFunctionRes interface {
	// contains filtered or unexported methods
}

type CreateFunctionResult added in v0.20.0 

type CreateFunctionResult struct {
	ID           uuid.UUID            `json:"id"`
	Name         string               `json:"name"`
	DeployStatus FunctionDeployStatus `json:"deploy_status"`
}

Returned by POST /functions on a successful deploy. Ref: #/components/schemas/CreateFunctionResult

func (*CreateFunctionResult) Decode added in v0.20.0 

func (s *CreateFunctionResult) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionResult from json.

func (*CreateFunctionResult) Encode added in v0.20.0 

func (s *CreateFunctionResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateFunctionResult) GetDeployStatus added in v0.20.0 

func (s *CreateFunctionResult) GetDeployStatus() FunctionDeployStatus

GetDeployStatus returns the value of DeployStatus.

func (*CreateFunctionResult) GetID added in v0.20.0 

func (s *CreateFunctionResult) GetID() uuid.UUID

GetID returns the value of ID.

func (*CreateFunctionResult) GetName added in v0.20.0 

func (s *CreateFunctionResult) GetName() string

GetName returns the value of Name.

func (*CreateFunctionResult) MarshalJSON added in v0.20.0 

func (s *CreateFunctionResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionResult) SetDeployStatus added in v0.20.0 

func (s *CreateFunctionResult) SetDeployStatus(val FunctionDeployStatus)

SetDeployStatus sets the value of DeployStatus.

func (*CreateFunctionResult) SetID added in v0.20.0 

func (s *CreateFunctionResult) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*CreateFunctionResult) SetName added in v0.20.0 

func (s *CreateFunctionResult) SetName(val string)

SetName sets the value of Name.

func (*CreateFunctionResult) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionResult) Validate added in v0.20.0 

func (s *CreateFunctionResult) Validate() error

type CreateFunctionSecretBadRequest added in v0.20.0 

type CreateFunctionSecretBadRequest ErrorResponse

func (*CreateFunctionSecretBadRequest) Decode added in v0.20.0 

func (s *CreateFunctionSecretBadRequest) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionSecretBadRequest from json.

func (*CreateFunctionSecretBadRequest) Encode added in v0.20.0 

func (s *CreateFunctionSecretBadRequest) Encode(e *jx.Encoder)

Encode encodes CreateFunctionSecretBadRequest as json.

func (*CreateFunctionSecretBadRequest) MarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionSecretBadRequest) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionSecretBadRequest) Validate added in v0.20.0 

func (s *CreateFunctionSecretBadRequest) Validate() error

type CreateFunctionSecretCreated added in v0.20.0 

type CreateFunctionSecretCreated struct {
	Success bool                      `json:"success"`
	Data    FunctionSecretWriteResult `json:"data"`
}

Merged schema.

func (*CreateFunctionSecretCreated) Decode added in v0.20.0 

func (s *CreateFunctionSecretCreated) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionSecretCreated from json.

func (*CreateFunctionSecretCreated) Encode added in v0.20.0 

func (s *CreateFunctionSecretCreated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateFunctionSecretCreated) GetData added in v0.20.0 

func (s *CreateFunctionSecretCreated) GetData() FunctionSecretWriteResult

GetData returns the value of Data.

func (*CreateFunctionSecretCreated) GetSuccess added in v0.20.0 

func (s *CreateFunctionSecretCreated) GetSuccess() bool

GetSuccess returns the value of Success.

func (*CreateFunctionSecretCreated) MarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretCreated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionSecretCreated) SetData added in v0.20.0 

func (s *CreateFunctionSecretCreated) SetData(val FunctionSecretWriteResult)

SetData sets the value of Data.

func (*CreateFunctionSecretCreated) SetSuccess added in v0.20.0 

func (s *CreateFunctionSecretCreated) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*CreateFunctionSecretCreated) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretCreated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type CreateFunctionSecretInput added in v0.20.0 

type CreateFunctionSecretInput struct {
	// Uppercase letters, digits, and underscores. Must start with
	// a letter or underscore. System-managed keys (e.g.
	// PRIMITIVE_WEBHOOK_SECRET, PRIMITIVE_API_KEY, and
	// PRIMITIVE_API_BASE_URL) are reserved.
	Key string `json:"key"`
	// Secret value, up to 4096 UTF-8 bytes. Encrypted at rest.
	// Never returned by any read endpoint.
	Value string `json:"value"`
}

Body for POST /functions/{id}/secrets. Ref: #/components/schemas/CreateFunctionSecretInput

func (*CreateFunctionSecretInput) Decode added in v0.20.0 

func (s *CreateFunctionSecretInput) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionSecretInput from json.

func (*CreateFunctionSecretInput) Encode added in v0.20.0 

func (s *CreateFunctionSecretInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateFunctionSecretInput) GetKey added in v0.20.0 

func (s *CreateFunctionSecretInput) GetKey() string

GetKey returns the value of Key.

func (*CreateFunctionSecretInput) GetValue added in v0.20.0 

func (s *CreateFunctionSecretInput) GetValue() string

GetValue returns the value of Value.

func (*CreateFunctionSecretInput) MarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionSecretInput) SetKey added in v0.20.0 

func (s *CreateFunctionSecretInput) SetKey(val string)

SetKey sets the value of Key.

func (*CreateFunctionSecretInput) SetValue added in v0.20.0 

func (s *CreateFunctionSecretInput) SetValue(val string)

SetValue sets the value of Value.

func (*CreateFunctionSecretInput) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionSecretInput) Validate added in v0.20.0 

func (s *CreateFunctionSecretInput) Validate() error

type CreateFunctionSecretNotFound added in v0.20.0 

type CreateFunctionSecretNotFound ErrorResponse

func (*CreateFunctionSecretNotFound) Decode added in v0.20.0 

func (s *CreateFunctionSecretNotFound) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionSecretNotFound from json.

func (*CreateFunctionSecretNotFound) Encode added in v0.20.0 

func (s *CreateFunctionSecretNotFound) Encode(e *jx.Encoder)

Encode encodes CreateFunctionSecretNotFound as json.

func (*CreateFunctionSecretNotFound) MarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionSecretNotFound) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionSecretNotFound) Validate added in v0.20.0 

func (s *CreateFunctionSecretNotFound) Validate() error

type CreateFunctionSecretOK added in v0.20.0 

type CreateFunctionSecretOK struct {
	Success bool                      `json:"success"`
	Data    FunctionSecretWriteResult `json:"data"`
}

Merged schema.

func (*CreateFunctionSecretOK) Decode added in v0.20.0 

func (s *CreateFunctionSecretOK) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionSecretOK from json.

func (*CreateFunctionSecretOK) Encode added in v0.20.0 

func (s *CreateFunctionSecretOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*CreateFunctionSecretOK) GetData added in v0.20.0 

func (s *CreateFunctionSecretOK) GetData() FunctionSecretWriteResult

GetData returns the value of Data.

func (*CreateFunctionSecretOK) GetSuccess added in v0.20.0 

func (s *CreateFunctionSecretOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*CreateFunctionSecretOK) MarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionSecretOK) SetData added in v0.20.0 

func (s *CreateFunctionSecretOK) SetData(val FunctionSecretWriteResult)

SetData sets the value of Data.

func (*CreateFunctionSecretOK) SetSuccess added in v0.20.0 

func (s *CreateFunctionSecretOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*CreateFunctionSecretOK) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type CreateFunctionSecretParams added in v0.20.0 

type CreateFunctionSecretParams struct {
	// Resource UUID.
	ID uuid.UUID
}

CreateFunctionSecretParams is parameters of createFunctionSecret operation.

type CreateFunctionSecretRes added in v0.20.0 

type CreateFunctionSecretRes interface {
	// contains filtered or unexported methods
}

type CreateFunctionSecretUnauthorized added in v0.20.0 

type CreateFunctionSecretUnauthorized ErrorResponse

func (*CreateFunctionSecretUnauthorized) Decode added in v0.20.0 

func (s *CreateFunctionSecretUnauthorized) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionSecretUnauthorized from json.

func (*CreateFunctionSecretUnauthorized) Encode added in v0.20.0 

func (s *CreateFunctionSecretUnauthorized) Encode(e *jx.Encoder)

Encode encodes CreateFunctionSecretUnauthorized as json.

func (*CreateFunctionSecretUnauthorized) MarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionSecretUnauthorized) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionSecretUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionSecretUnauthorized) Validate added in v0.20.0 

func (s *CreateFunctionSecretUnauthorized) Validate() error

type CreateFunctionServiceUnavailable added in v0.28.0 

type CreateFunctionServiceUnavailable ErrorResponse

func (*CreateFunctionServiceUnavailable) Decode added in v0.28.0 

func (s *CreateFunctionServiceUnavailable) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionServiceUnavailable from json.

func (*CreateFunctionServiceUnavailable) Encode added in v0.28.0 

func (s *CreateFunctionServiceUnavailable) Encode(e *jx.Encoder)

Encode encodes CreateFunctionServiceUnavailable as json.

func (*CreateFunctionServiceUnavailable) MarshalJSON added in v0.28.0 

func (s *CreateFunctionServiceUnavailable) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionServiceUnavailable) UnmarshalJSON added in v0.28.0 

func (s *CreateFunctionServiceUnavailable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionServiceUnavailable) Validate added in v0.28.0 

func (s *CreateFunctionServiceUnavailable) Validate() error

type CreateFunctionTooManyRequests added in v0.28.0 

type CreateFunctionTooManyRequests ErrorResponse

func (*CreateFunctionTooManyRequests) Decode added in v0.28.0 

func (s *CreateFunctionTooManyRequests) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionTooManyRequests from json.

func (*CreateFunctionTooManyRequests) Encode added in v0.28.0 

func (s *CreateFunctionTooManyRequests) Encode(e *jx.Encoder)

Encode encodes CreateFunctionTooManyRequests as json.

func (*CreateFunctionTooManyRequests) MarshalJSON added in v0.28.0 

func (s *CreateFunctionTooManyRequests) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionTooManyRequests) UnmarshalJSON added in v0.28.0 

func (s *CreateFunctionTooManyRequests) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionTooManyRequests) Validate added in v0.28.0 

func (s *CreateFunctionTooManyRequests) Validate() error

type CreateFunctionUnauthorized added in v0.20.0 

type CreateFunctionUnauthorized ErrorResponse

func (*CreateFunctionUnauthorized) Decode added in v0.20.0 

func (s *CreateFunctionUnauthorized) Decode(d *jx.Decoder) error

Decode decodes CreateFunctionUnauthorized from json.

func (*CreateFunctionUnauthorized) Encode added in v0.20.0 

func (s *CreateFunctionUnauthorized) Encode(e *jx.Encoder)

Encode encodes CreateFunctionUnauthorized as json.

func (*CreateFunctionUnauthorized) MarshalJSON added in v0.20.0 

func (s *CreateFunctionUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*CreateFunctionUnauthorized) UnmarshalJSON added in v0.20.0 

func (s *CreateFunctionUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*CreateFunctionUnauthorized) Validate added in v0.20.0 

func (s *CreateFunctionUnauthorized) Validate() error

type DeleteDomainBadRequest 

type DeleteDomainBadRequest ErrorResponse

func (*DeleteDomainBadRequest) Decode 

func (s *DeleteDomainBadRequest) Decode(d *jx.Decoder) error

Decode decodes DeleteDomainBadRequest from json.

func (*DeleteDomainBadRequest) Encode 

func (s *DeleteDomainBadRequest) Encode(e *jx.Encoder)

Encode encodes DeleteDomainBadRequest as json.

func (*DeleteDomainBadRequest) MarshalJSON 

func (s *DeleteDomainBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteDomainBadRequest) UnmarshalJSON 

func (s *DeleteDomainBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteDomainBadRequest) Validate 

func (s *DeleteDomainBadRequest) Validate() error

type DeleteDomainNotFound 

type DeleteDomainNotFound ErrorResponse

func (*DeleteDomainNotFound) Decode 

func (s *DeleteDomainNotFound) Decode(d *jx.Decoder) error

Decode decodes DeleteDomainNotFound from json.

func (*DeleteDomainNotFound) Encode 

func (s *DeleteDomainNotFound) Encode(e *jx.Encoder)

Encode encodes DeleteDomainNotFound as json.

func (*DeleteDomainNotFound) MarshalJSON 

func (s *DeleteDomainNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteDomainNotFound) UnmarshalJSON 

func (s *DeleteDomainNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteDomainNotFound) Validate 

func (s *DeleteDomainNotFound) Validate() error

type DeleteDomainParams 

type DeleteDomainParams struct {
	// Resource UUID.
	ID uuid.UUID
}

DeleteDomainParams is parameters of deleteDomain operation.

type DeleteDomainRes 

type DeleteDomainRes interface {
	// contains filtered or unexported methods
}

type DeleteDomainUnauthorized 

type DeleteDomainUnauthorized ErrorResponse

func (*DeleteDomainUnauthorized) Decode 

func (s *DeleteDomainUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DeleteDomainUnauthorized from json.

func (*DeleteDomainUnauthorized) Encode 

func (s *DeleteDomainUnauthorized) Encode(e *jx.Encoder)

Encode encodes DeleteDomainUnauthorized as json.

func (*DeleteDomainUnauthorized) MarshalJSON 

func (s *DeleteDomainUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteDomainUnauthorized) UnmarshalJSON 

func (s *DeleteDomainUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteDomainUnauthorized) Validate 

func (s *DeleteDomainUnauthorized) Validate() error

type DeleteEmailBadRequest 

type DeleteEmailBadRequest ErrorResponse

func (*DeleteEmailBadRequest) Decode 

func (s *DeleteEmailBadRequest) Decode(d *jx.Decoder) error

Decode decodes DeleteEmailBadRequest from json.

func (*DeleteEmailBadRequest) Encode 

func (s *DeleteEmailBadRequest) Encode(e *jx.Encoder)

Encode encodes DeleteEmailBadRequest as json.

func (*DeleteEmailBadRequest) MarshalJSON 

func (s *DeleteEmailBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteEmailBadRequest) UnmarshalJSON 

func (s *DeleteEmailBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteEmailBadRequest) Validate 

func (s *DeleteEmailBadRequest) Validate() error

type DeleteEmailNotFound 

type DeleteEmailNotFound ErrorResponse

func (*DeleteEmailNotFound) Decode 

func (s *DeleteEmailNotFound) Decode(d *jx.Decoder) error

Decode decodes DeleteEmailNotFound from json.

func (*DeleteEmailNotFound) Encode 

func (s *DeleteEmailNotFound) Encode(e *jx.Encoder)

Encode encodes DeleteEmailNotFound as json.

func (*DeleteEmailNotFound) MarshalJSON 

func (s *DeleteEmailNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteEmailNotFound) UnmarshalJSON 

func (s *DeleteEmailNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteEmailNotFound) Validate 

func (s *DeleteEmailNotFound) Validate() error

type DeleteEmailParams 

type DeleteEmailParams struct {
	// Resource UUID.
	ID uuid.UUID
}

DeleteEmailParams is parameters of deleteEmail operation.

type DeleteEmailRes 

type DeleteEmailRes interface {
	// contains filtered or unexported methods
}

type DeleteEmailUnauthorized 

type DeleteEmailUnauthorized ErrorResponse

func (*DeleteEmailUnauthorized) Decode 

func (s *DeleteEmailUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DeleteEmailUnauthorized from json.

func (*DeleteEmailUnauthorized) Encode 

func (s *DeleteEmailUnauthorized) Encode(e *jx.Encoder)

Encode encodes DeleteEmailUnauthorized as json.

func (*DeleteEmailUnauthorized) MarshalJSON 

func (s *DeleteEmailUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteEmailUnauthorized) UnmarshalJSON 

func (s *DeleteEmailUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteEmailUnauthorized) Validate 

func (s *DeleteEmailUnauthorized) Validate() error

type DeleteEndpointBadRequest 

type DeleteEndpointBadRequest ErrorResponse

func (*DeleteEndpointBadRequest) Decode 

func (s *DeleteEndpointBadRequest) Decode(d *jx.Decoder) error

Decode decodes DeleteEndpointBadRequest from json.

func (*DeleteEndpointBadRequest) Encode 

func (s *DeleteEndpointBadRequest) Encode(e *jx.Encoder)

Encode encodes DeleteEndpointBadRequest as json.

func (*DeleteEndpointBadRequest) MarshalJSON 

func (s *DeleteEndpointBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteEndpointBadRequest) UnmarshalJSON 

func (s *DeleteEndpointBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteEndpointBadRequest) Validate 

func (s *DeleteEndpointBadRequest) Validate() error

type DeleteEndpointNotFound 

type DeleteEndpointNotFound ErrorResponse

func (*DeleteEndpointNotFound) Decode 

func (s *DeleteEndpointNotFound) Decode(d *jx.Decoder) error

Decode decodes DeleteEndpointNotFound from json.

func (*DeleteEndpointNotFound) Encode 

func (s *DeleteEndpointNotFound) Encode(e *jx.Encoder)

Encode encodes DeleteEndpointNotFound as json.

func (*DeleteEndpointNotFound) MarshalJSON 

func (s *DeleteEndpointNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteEndpointNotFound) UnmarshalJSON 

func (s *DeleteEndpointNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteEndpointNotFound) Validate 

func (s *DeleteEndpointNotFound) Validate() error

type DeleteEndpointParams 

type DeleteEndpointParams struct {
	// Resource UUID.
	ID uuid.UUID
}

DeleteEndpointParams is parameters of deleteEndpoint operation.

type DeleteEndpointRes 

type DeleteEndpointRes interface {
	// contains filtered or unexported methods
}

type DeleteEndpointUnauthorized 

type DeleteEndpointUnauthorized ErrorResponse

func (*DeleteEndpointUnauthorized) Decode 

func (s *DeleteEndpointUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DeleteEndpointUnauthorized from json.

func (*DeleteEndpointUnauthorized) Encode 

func (s *DeleteEndpointUnauthorized) Encode(e *jx.Encoder)

Encode encodes DeleteEndpointUnauthorized as json.

func (*DeleteEndpointUnauthorized) MarshalJSON 

func (s *DeleteEndpointUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteEndpointUnauthorized) UnmarshalJSON 

func (s *DeleteEndpointUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteEndpointUnauthorized) Validate 

func (s *DeleteEndpointUnauthorized) Validate() error

type DeleteFilterBadRequest 

type DeleteFilterBadRequest ErrorResponse

func (*DeleteFilterBadRequest) Decode 

func (s *DeleteFilterBadRequest) Decode(d *jx.Decoder) error

Decode decodes DeleteFilterBadRequest from json.

func (*DeleteFilterBadRequest) Encode 

func (s *DeleteFilterBadRequest) Encode(e *jx.Encoder)

Encode encodes DeleteFilterBadRequest as json.

func (*DeleteFilterBadRequest) MarshalJSON 

func (s *DeleteFilterBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteFilterBadRequest) UnmarshalJSON 

func (s *DeleteFilterBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteFilterBadRequest) Validate 

func (s *DeleteFilterBadRequest) Validate() error

type DeleteFilterNotFound 

type DeleteFilterNotFound ErrorResponse

func (*DeleteFilterNotFound) Decode 

func (s *DeleteFilterNotFound) Decode(d *jx.Decoder) error

Decode decodes DeleteFilterNotFound from json.

func (*DeleteFilterNotFound) Encode 

func (s *DeleteFilterNotFound) Encode(e *jx.Encoder)

Encode encodes DeleteFilterNotFound as json.

func (*DeleteFilterNotFound) MarshalJSON 

func (s *DeleteFilterNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteFilterNotFound) UnmarshalJSON 

func (s *DeleteFilterNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteFilterNotFound) Validate 

func (s *DeleteFilterNotFound) Validate() error

type DeleteFilterParams 

type DeleteFilterParams struct {
	// Resource UUID.
	ID uuid.UUID
}

DeleteFilterParams is parameters of deleteFilter operation.

type DeleteFilterRes 

type DeleteFilterRes interface {
	// contains filtered or unexported methods
}

type DeleteFilterUnauthorized 

type DeleteFilterUnauthorized ErrorResponse

func (*DeleteFilterUnauthorized) Decode 

func (s *DeleteFilterUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DeleteFilterUnauthorized from json.

func (*DeleteFilterUnauthorized) Encode 

func (s *DeleteFilterUnauthorized) Encode(e *jx.Encoder)

Encode encodes DeleteFilterUnauthorized as json.

func (*DeleteFilterUnauthorized) MarshalJSON 

func (s *DeleteFilterUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteFilterUnauthorized) UnmarshalJSON 

func (s *DeleteFilterUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteFilterUnauthorized) Validate 

func (s *DeleteFilterUnauthorized) Validate() error

type DeleteFunctionBadGateway added in v0.20.0 

type DeleteFunctionBadGateway ErrorResponse

func (*DeleteFunctionBadGateway) Decode added in v0.20.0 

func (s *DeleteFunctionBadGateway) Decode(d *jx.Decoder) error

Decode decodes DeleteFunctionBadGateway from json.

func (*DeleteFunctionBadGateway) Encode added in v0.20.0 

func (s *DeleteFunctionBadGateway) Encode(e *jx.Encoder)

Encode encodes DeleteFunctionBadGateway as json.

func (*DeleteFunctionBadGateway) MarshalJSON added in v0.20.0 

func (s *DeleteFunctionBadGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteFunctionBadGateway) UnmarshalJSON added in v0.20.0 

func (s *DeleteFunctionBadGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteFunctionBadGateway) Validate added in v0.20.0 

func (s *DeleteFunctionBadGateway) Validate() error

type DeleteFunctionNotFound added in v0.20.0 

type DeleteFunctionNotFound ErrorResponse

func (*DeleteFunctionNotFound) Decode added in v0.20.0 

func (s *DeleteFunctionNotFound) Decode(d *jx.Decoder) error

Decode decodes DeleteFunctionNotFound from json.

func (*DeleteFunctionNotFound) Encode added in v0.20.0 

func (s *DeleteFunctionNotFound) Encode(e *jx.Encoder)

Encode encodes DeleteFunctionNotFound as json.

func (*DeleteFunctionNotFound) MarshalJSON added in v0.20.0 

func (s *DeleteFunctionNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteFunctionNotFound) UnmarshalJSON added in v0.20.0 

func (s *DeleteFunctionNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteFunctionNotFound) Validate added in v0.20.0 

func (s *DeleteFunctionNotFound) Validate() error

type DeleteFunctionParams added in v0.20.0 

type DeleteFunctionParams struct {
	// Resource UUID.
	ID uuid.UUID
}

DeleteFunctionParams is parameters of deleteFunction operation.

type DeleteFunctionRes added in v0.20.0 

type DeleteFunctionRes interface {
	// contains filtered or unexported methods
}

type DeleteFunctionSecretBadRequest added in v0.20.0 

type DeleteFunctionSecretBadRequest ErrorResponse

func (*DeleteFunctionSecretBadRequest) Decode added in v0.20.0 

func (s *DeleteFunctionSecretBadRequest) Decode(d *jx.Decoder) error

Decode decodes DeleteFunctionSecretBadRequest from json.

func (*DeleteFunctionSecretBadRequest) Encode added in v0.20.0 

func (s *DeleteFunctionSecretBadRequest) Encode(e *jx.Encoder)

Encode encodes DeleteFunctionSecretBadRequest as json.

func (*DeleteFunctionSecretBadRequest) MarshalJSON added in v0.20.0 

func (s *DeleteFunctionSecretBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteFunctionSecretBadRequest) UnmarshalJSON added in v0.20.0 

func (s *DeleteFunctionSecretBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteFunctionSecretBadRequest) Validate added in v0.20.0 

func (s *DeleteFunctionSecretBadRequest) Validate() error

type DeleteFunctionSecretNoContent added in v0.20.0 

type DeleteFunctionSecretNoContent struct{}

DeleteFunctionSecretNoContent is response for DeleteFunctionSecret operation.

type DeleteFunctionSecretNotFound added in v0.20.0 

type DeleteFunctionSecretNotFound ErrorResponse

func (*DeleteFunctionSecretNotFound) Decode added in v0.20.0 

func (s *DeleteFunctionSecretNotFound) Decode(d *jx.Decoder) error

Decode decodes DeleteFunctionSecretNotFound from json.

func (*DeleteFunctionSecretNotFound) Encode added in v0.20.0 

func (s *DeleteFunctionSecretNotFound) Encode(e *jx.Encoder)

Encode encodes DeleteFunctionSecretNotFound as json.

func (*DeleteFunctionSecretNotFound) MarshalJSON added in v0.20.0 

func (s *DeleteFunctionSecretNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteFunctionSecretNotFound) UnmarshalJSON added in v0.20.0 

func (s *DeleteFunctionSecretNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteFunctionSecretNotFound) Validate added in v0.20.0 

func (s *DeleteFunctionSecretNotFound) Validate() error

type DeleteFunctionSecretParams added in v0.20.0 

type DeleteFunctionSecretParams struct {
	// Resource UUID.
	ID uuid.UUID
	// Secret key. Must match `^[A-Z_][A-Z0-9_]*$`.
	Key string
}

DeleteFunctionSecretParams is parameters of deleteFunctionSecret operation.

type DeleteFunctionSecretRes added in v0.20.0 

type DeleteFunctionSecretRes interface {
	// contains filtered or unexported methods
}

type DeleteFunctionSecretUnauthorized added in v0.20.0 

type DeleteFunctionSecretUnauthorized ErrorResponse

func (*DeleteFunctionSecretUnauthorized) Decode added in v0.20.0 

func (s *DeleteFunctionSecretUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DeleteFunctionSecretUnauthorized from json.

func (*DeleteFunctionSecretUnauthorized) Encode added in v0.20.0 

func (s *DeleteFunctionSecretUnauthorized) Encode(e *jx.Encoder)

Encode encodes DeleteFunctionSecretUnauthorized as json.

func (*DeleteFunctionSecretUnauthorized) MarshalJSON added in v0.20.0 

func (s *DeleteFunctionSecretUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteFunctionSecretUnauthorized) UnmarshalJSON added in v0.20.0 

func (s *DeleteFunctionSecretUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteFunctionSecretUnauthorized) Validate added in v0.20.0 

func (s *DeleteFunctionSecretUnauthorized) Validate() error

type DeleteFunctionUnauthorized added in v0.20.0 

type DeleteFunctionUnauthorized ErrorResponse

func (*DeleteFunctionUnauthorized) Decode added in v0.20.0 

func (s *DeleteFunctionUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DeleteFunctionUnauthorized from json.

func (*DeleteFunctionUnauthorized) Encode added in v0.20.0 

func (s *DeleteFunctionUnauthorized) Encode(e *jx.Encoder)

Encode encodes DeleteFunctionUnauthorized as json.

func (*DeleteFunctionUnauthorized) MarshalJSON added in v0.20.0 

func (s *DeleteFunctionUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteFunctionUnauthorized) UnmarshalJSON added in v0.20.0 

func (s *DeleteFunctionUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteFunctionUnauthorized) Validate added in v0.20.0 

func (s *DeleteFunctionUnauthorized) Validate() error

type Deleted 

type Deleted struct {
	Success bool        `json:"success"`
	Data    DeletedData `json:"data"`
}

Merged schema.

func (*Deleted) Decode 

func (s *Deleted) Decode(d *jx.Decoder) error

Decode decodes Deleted from json.

func (*Deleted) Encode 

func (s *Deleted) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*Deleted) GetData 

func (s *Deleted) GetData() DeletedData

GetData returns the value of Data.

func (*Deleted) GetSuccess 

func (s *Deleted) GetSuccess() bool

GetSuccess returns the value of Success.

func (*Deleted) MarshalJSON 

func (s *Deleted) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Deleted) SetData 

func (s *Deleted) SetData(val DeletedData)

SetData sets the value of Data.

func (*Deleted) SetSuccess 

func (s *Deleted) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*Deleted) UnmarshalJSON 

func (s *Deleted) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type DeletedData 

type DeletedData struct {
	Deleted bool `json:"deleted"`
}

func (*DeletedData) Decode 

func (s *DeletedData) Decode(d *jx.Decoder) error

Decode decodes DeletedData from json.

func (*DeletedData) Encode 

func (s *DeletedData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*DeletedData) GetDeleted 

func (s *DeletedData) GetDeleted() bool

GetDeleted returns the value of Deleted.

func (*DeletedData) MarshalJSON 

func (s *DeletedData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeletedData) SetDeleted 

func (s *DeletedData) SetDeleted(val bool)

SetDeleted sets the value of Deleted.

func (*DeletedData) UnmarshalJSON 

func (s *DeletedData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type DeliveryStatus added in v0.8.0 

type DeliveryStatus string

Narrower enum covering only the four terminal delivery outcomes returned to a synchronous `wait: true` send. On the SendMailResult shape, `delivery_status` is always equal to `status` whenever both are present (i.e. on terminal-state replays and live wait=true responses). The two fields exist so callers that want to type-narrow on "this is a delivery outcome" can pattern-match against the four-value enum without handling the broader SentEmailStatus value set (which also covers `queued`, `submitted_to_agent`, `agent_failed`, `gate_denied`, `unknown`). On async-mode and pre-terminal responses, `delivery_status` is absent and only `status` is populated. Use `status` if you want a single field that's always present. Ref: #/components/schemas/DeliveryStatus 

const (
	DeliveryStatusDelivered   DeliveryStatus = "delivered"
	DeliveryStatusBounced     DeliveryStatus = "bounced"
	DeliveryStatusDeferred    DeliveryStatus = "deferred"
	DeliveryStatusWaitTimeout DeliveryStatus = "wait_timeout"
)

func (DeliveryStatus) AllValues added in v0.8.0 

func (DeliveryStatus) AllValues() []DeliveryStatus

AllValues returns all DeliveryStatus values.

func (*DeliveryStatus) Decode added in v0.8.0 

func (s *DeliveryStatus) Decode(d *jx.Decoder) error

Decode decodes DeliveryStatus from json.

func (DeliveryStatus) Encode added in v0.8.0 

func (s DeliveryStatus) Encode(e *jx.Encoder)

Encode encodes DeliveryStatus as json.

func (DeliveryStatus) MarshalJSON added in v0.8.0 

func (s DeliveryStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (DeliveryStatus) MarshalText added in v0.8.0 

func (s DeliveryStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*DeliveryStatus) UnmarshalJSON added in v0.8.0 

func (s *DeliveryStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeliveryStatus) UnmarshalText added in v0.8.0 

func (s *DeliveryStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (DeliveryStatus) Validate added in v0.8.0 

func (s DeliveryStatus) Validate() error

type DeliverySummary 

type DeliverySummary struct {
	// Delivery ID (numeric string).
	ID           string                     `json:"id"`
	EmailID      uuid.UUID                  `json:"email_id"`
	OrgID        uuid.UUID                  `json:"org_id"`
	EndpointID   uuid.UUID                  `json:"endpoint_id"`
	EndpointURL  string                     `json:"endpoint_url"`
	Status       DeliverySummaryStatus      `json:"status"`
	AttemptCount int                        `json:"attempt_count"`
	DurationMs   OptNilInt                  `json:"duration_ms"`
	LastError    OptNilString               `json:"last_error"`
	CreatedAt    time.Time                  `json:"created_at"`
	UpdatedAt    time.Time                  `json:"updated_at"`
	Email        OptNilDeliverySummaryEmail `json:"email"`
}

Ref: #/components/schemas/DeliverySummary

func (*DeliverySummary) Decode 

func (s *DeliverySummary) Decode(d *jx.Decoder) error

Decode decodes DeliverySummary from json.

func (*DeliverySummary) Encode 

func (s *DeliverySummary) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*DeliverySummary) GetAttemptCount 

func (s *DeliverySummary) GetAttemptCount() int

GetAttemptCount returns the value of AttemptCount.

func (*DeliverySummary) GetCreatedAt 

func (s *DeliverySummary) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*DeliverySummary) GetDurationMs 

func (s *DeliverySummary) GetDurationMs() OptNilInt

GetDurationMs returns the value of DurationMs.

func (*DeliverySummary) GetEmail 

func (s *DeliverySummary) GetEmail() OptNilDeliverySummaryEmail

GetEmail returns the value of Email.

func (*DeliverySummary) GetEmailID 

func (s *DeliverySummary) GetEmailID() uuid.UUID

GetEmailID returns the value of EmailID.

func (*DeliverySummary) GetEndpointID 

func (s *DeliverySummary) GetEndpointID() uuid.UUID

GetEndpointID returns the value of EndpointID.

func (*DeliverySummary) GetEndpointURL 

func (s *DeliverySummary) GetEndpointURL() string

GetEndpointURL returns the value of EndpointURL.

func (*DeliverySummary) GetID 

func (s *DeliverySummary) GetID() string

GetID returns the value of ID.

func (*DeliverySummary) GetLastError 

func (s *DeliverySummary) GetLastError() OptNilString

GetLastError returns the value of LastError.

func (*DeliverySummary) GetOrgID 

func (s *DeliverySummary) GetOrgID() uuid.UUID

GetOrgID returns the value of OrgID.

func (*DeliverySummary) GetStatus 

func (s *DeliverySummary) GetStatus() DeliverySummaryStatus

GetStatus returns the value of Status.

func (*DeliverySummary) GetUpdatedAt 

func (s *DeliverySummary) GetUpdatedAt() time.Time

GetUpdatedAt returns the value of UpdatedAt.

func (*DeliverySummary) MarshalJSON 

func (s *DeliverySummary) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeliverySummary) SetAttemptCount 

func (s *DeliverySummary) SetAttemptCount(val int)

SetAttemptCount sets the value of AttemptCount.

func (*DeliverySummary) SetCreatedAt 

func (s *DeliverySummary) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*DeliverySummary) SetDurationMs 

func (s *DeliverySummary) SetDurationMs(val OptNilInt)

SetDurationMs sets the value of DurationMs.

func (*DeliverySummary) SetEmail 

func (s *DeliverySummary) SetEmail(val OptNilDeliverySummaryEmail)

SetEmail sets the value of Email.

func (*DeliverySummary) SetEmailID 

func (s *DeliverySummary) SetEmailID(val uuid.UUID)

SetEmailID sets the value of EmailID.

func (*DeliverySummary) SetEndpointID 

func (s *DeliverySummary) SetEndpointID(val uuid.UUID)

SetEndpointID sets the value of EndpointID.

func (*DeliverySummary) SetEndpointURL 

func (s *DeliverySummary) SetEndpointURL(val string)

SetEndpointURL sets the value of EndpointURL.

func (*DeliverySummary) SetID 

func (s *DeliverySummary) SetID(val string)

SetID sets the value of ID.

func (*DeliverySummary) SetLastError 

func (s *DeliverySummary) SetLastError(val OptNilString)

SetLastError sets the value of LastError.

func (*DeliverySummary) SetOrgID 

func (s *DeliverySummary) SetOrgID(val uuid.UUID)

SetOrgID sets the value of OrgID.

func (*DeliverySummary) SetStatus 

func (s *DeliverySummary) SetStatus(val DeliverySummaryStatus)

SetStatus sets the value of Status.

func (*DeliverySummary) SetUpdatedAt 

func (s *DeliverySummary) SetUpdatedAt(val time.Time)

SetUpdatedAt sets the value of UpdatedAt.

func (*DeliverySummary) UnmarshalJSON 

func (s *DeliverySummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeliverySummary) Validate 

func (s *DeliverySummary) Validate() error

type DeliverySummaryEmail 

type DeliverySummaryEmail struct {
	Sender    string       `json:"sender"`
	Recipient string       `json:"recipient"`
	Subject   OptNilString `json:"subject"`
}

func (*DeliverySummaryEmail) Decode 

func (s *DeliverySummaryEmail) Decode(d *jx.Decoder) error

Decode decodes DeliverySummaryEmail from json.

func (*DeliverySummaryEmail) Encode 

func (s *DeliverySummaryEmail) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*DeliverySummaryEmail) GetRecipient 

func (s *DeliverySummaryEmail) GetRecipient() string

GetRecipient returns the value of Recipient.

func (*DeliverySummaryEmail) GetSender 

func (s *DeliverySummaryEmail) GetSender() string

GetSender returns the value of Sender.

func (*DeliverySummaryEmail) GetSubject 

func (s *DeliverySummaryEmail) GetSubject() OptNilString

GetSubject returns the value of Subject.

func (*DeliverySummaryEmail) MarshalJSON 

func (s *DeliverySummaryEmail) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeliverySummaryEmail) SetRecipient 

func (s *DeliverySummaryEmail) SetRecipient(val string)

SetRecipient sets the value of Recipient.

func (*DeliverySummaryEmail) SetSender 

func (s *DeliverySummaryEmail) SetSender(val string)

SetSender sets the value of Sender.

func (*DeliverySummaryEmail) SetSubject 

func (s *DeliverySummaryEmail) SetSubject(val OptNilString)

SetSubject sets the value of Subject.

func (*DeliverySummaryEmail) UnmarshalJSON 

func (s *DeliverySummaryEmail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type DeliverySummaryStatus 

type DeliverySummaryStatus string
const (
	DeliverySummaryStatusPending         DeliverySummaryStatus = "pending"
	DeliverySummaryStatusDelivered       DeliverySummaryStatus = "delivered"
	DeliverySummaryStatusHeaderConfirmed DeliverySummaryStatus = "header_confirmed"
	DeliverySummaryStatusFailed          DeliverySummaryStatus = "failed"
)

func (DeliverySummaryStatus) AllValues 

func (DeliverySummaryStatus) AllValues() []DeliverySummaryStatus

AllValues returns all DeliverySummaryStatus values.

func (*DeliverySummaryStatus) Decode 

func (s *DeliverySummaryStatus) Decode(d *jx.Decoder) error

Decode decodes DeliverySummaryStatus from json.

func (DeliverySummaryStatus) Encode 

func (s DeliverySummaryStatus) Encode(e *jx.Encoder)

Encode encodes DeliverySummaryStatus as json.

func (DeliverySummaryStatus) MarshalJSON 

func (s DeliverySummaryStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (DeliverySummaryStatus) MarshalText 

func (s DeliverySummaryStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*DeliverySummaryStatus) UnmarshalJSON 

func (s *DeliverySummaryStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeliverySummaryStatus) UnmarshalText 

func (s *DeliverySummaryStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (DeliverySummaryStatus) Validate 

func (s DeliverySummaryStatus) Validate() error

type DiscardContentResult added in v0.19.0 

type DiscardContentResult struct {
	// Always `true` on a 2xx response. The content is either now
	// discarded as a result of this call, or was already discarded
	// before this call ran.
	Discarded bool `json:"discarded"`
	// `true` if the email's content was already discarded before
	// this call ran (no work was done). `false` if this call was
	// the one that performed the discard.
	AlreadyDiscarded bool `json:"already_discarded"`
}

Ref: #/components/schemas/DiscardContentResult

func (*DiscardContentResult) Decode added in v0.19.0 

func (s *DiscardContentResult) Decode(d *jx.Decoder) error

Decode decodes DiscardContentResult from json.

func (*DiscardContentResult) Encode added in v0.19.0 

func (s *DiscardContentResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*DiscardContentResult) GetAlreadyDiscarded added in v0.19.0 

func (s *DiscardContentResult) GetAlreadyDiscarded() bool

GetAlreadyDiscarded returns the value of AlreadyDiscarded.

func (*DiscardContentResult) GetDiscarded added in v0.19.0 

func (s *DiscardContentResult) GetDiscarded() bool

GetDiscarded returns the value of Discarded.

func (*DiscardContentResult) MarshalJSON added in v0.19.0 

func (s *DiscardContentResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DiscardContentResult) SetAlreadyDiscarded added in v0.19.0 

func (s *DiscardContentResult) SetAlreadyDiscarded(val bool)

SetAlreadyDiscarded sets the value of AlreadyDiscarded.

func (*DiscardContentResult) SetDiscarded added in v0.19.0 

func (s *DiscardContentResult) SetDiscarded(val bool)

SetDiscarded sets the value of Discarded.

func (*DiscardContentResult) UnmarshalJSON added in v0.19.0 

func (s *DiscardContentResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type DiscardEmailContentBadRequest added in v0.19.0 

type DiscardEmailContentBadRequest ErrorResponse

func (*DiscardEmailContentBadRequest) Decode added in v0.19.0 

func (s *DiscardEmailContentBadRequest) Decode(d *jx.Decoder) error

Decode decodes DiscardEmailContentBadRequest from json.

func (*DiscardEmailContentBadRequest) Encode added in v0.19.0 

func (s *DiscardEmailContentBadRequest) Encode(e *jx.Encoder)

Encode encodes DiscardEmailContentBadRequest as json.

func (*DiscardEmailContentBadRequest) MarshalJSON added in v0.19.0 

func (s *DiscardEmailContentBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DiscardEmailContentBadRequest) UnmarshalJSON added in v0.19.0 

func (s *DiscardEmailContentBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DiscardEmailContentBadRequest) Validate added in v0.19.0 

func (s *DiscardEmailContentBadRequest) Validate() error

type DiscardEmailContentForbidden added in v0.19.0 

type DiscardEmailContentForbidden ErrorResponse

func (*DiscardEmailContentForbidden) Decode added in v0.19.0 

func (s *DiscardEmailContentForbidden) Decode(d *jx.Decoder) error

Decode decodes DiscardEmailContentForbidden from json.

func (*DiscardEmailContentForbidden) Encode added in v0.19.0 

func (s *DiscardEmailContentForbidden) Encode(e *jx.Encoder)

Encode encodes DiscardEmailContentForbidden as json.

func (*DiscardEmailContentForbidden) MarshalJSON added in v0.19.0 

func (s *DiscardEmailContentForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DiscardEmailContentForbidden) UnmarshalJSON added in v0.19.0 

func (s *DiscardEmailContentForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DiscardEmailContentForbidden) Validate added in v0.19.0 

func (s *DiscardEmailContentForbidden) Validate() error

type DiscardEmailContentInternalServerError added in v0.19.0 

type DiscardEmailContentInternalServerError ErrorResponse

func (*DiscardEmailContentInternalServerError) Decode added in v0.19.0 

func (s *DiscardEmailContentInternalServerError) Decode(d *jx.Decoder) error

Decode decodes DiscardEmailContentInternalServerError from json.

func (*DiscardEmailContentInternalServerError) Encode added in v0.19.0 

func (s *DiscardEmailContentInternalServerError) Encode(e *jx.Encoder)

Encode encodes DiscardEmailContentInternalServerError as json.

func (*DiscardEmailContentInternalServerError) MarshalJSON added in v0.19.0 

func (s *DiscardEmailContentInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DiscardEmailContentInternalServerError) UnmarshalJSON added in v0.19.0 

func (s *DiscardEmailContentInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DiscardEmailContentInternalServerError) Validate added in v0.19.0 

func (s *DiscardEmailContentInternalServerError) Validate() error

type DiscardEmailContentNotFound added in v0.19.0 

type DiscardEmailContentNotFound ErrorResponse

func (*DiscardEmailContentNotFound) Decode added in v0.19.0 

func (s *DiscardEmailContentNotFound) Decode(d *jx.Decoder) error

Decode decodes DiscardEmailContentNotFound from json.

func (*DiscardEmailContentNotFound) Encode added in v0.19.0 

func (s *DiscardEmailContentNotFound) Encode(e *jx.Encoder)

Encode encodes DiscardEmailContentNotFound as json.

func (*DiscardEmailContentNotFound) MarshalJSON added in v0.19.0 

func (s *DiscardEmailContentNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DiscardEmailContentNotFound) UnmarshalJSON added in v0.19.0 

func (s *DiscardEmailContentNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DiscardEmailContentNotFound) Validate added in v0.19.0 

func (s *DiscardEmailContentNotFound) Validate() error

type DiscardEmailContentOK added in v0.19.0 

type DiscardEmailContentOK struct {
	Success bool                 `json:"success"`
	Data    DiscardContentResult `json:"data"`
}

Merged schema.

func (*DiscardEmailContentOK) Decode added in v0.19.0 

func (s *DiscardEmailContentOK) Decode(d *jx.Decoder) error

Decode decodes DiscardEmailContentOK from json.

func (*DiscardEmailContentOK) Encode added in v0.19.0 

func (s *DiscardEmailContentOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*DiscardEmailContentOK) GetData added in v0.19.0 

func (s *DiscardEmailContentOK) GetData() DiscardContentResult

GetData returns the value of Data.

func (*DiscardEmailContentOK) GetSuccess added in v0.19.0 

func (s *DiscardEmailContentOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*DiscardEmailContentOK) MarshalJSON added in v0.19.0 

func (s *DiscardEmailContentOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DiscardEmailContentOK) SetData added in v0.19.0 

func (s *DiscardEmailContentOK) SetData(val DiscardContentResult)

SetData sets the value of Data.

func (*DiscardEmailContentOK) SetSuccess added in v0.19.0 

func (s *DiscardEmailContentOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*DiscardEmailContentOK) UnmarshalJSON added in v0.19.0 

func (s *DiscardEmailContentOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type DiscardEmailContentParams added in v0.19.0 

type DiscardEmailContentParams struct {
	// Resource UUID.
	ID uuid.UUID
}

DiscardEmailContentParams is parameters of discardEmailContent operation.

type DiscardEmailContentRes added in v0.19.0 

type DiscardEmailContentRes interface {
	// contains filtered or unexported methods
}

type DiscardEmailContentUnauthorized added in v0.19.0 

type DiscardEmailContentUnauthorized ErrorResponse

func (*DiscardEmailContentUnauthorized) Decode added in v0.19.0 

func (s *DiscardEmailContentUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DiscardEmailContentUnauthorized from json.

func (*DiscardEmailContentUnauthorized) Encode added in v0.19.0 

func (s *DiscardEmailContentUnauthorized) Encode(e *jx.Encoder)

Encode encodes DiscardEmailContentUnauthorized as json.

func (*DiscardEmailContentUnauthorized) MarshalJSON added in v0.19.0 

func (s *DiscardEmailContentUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DiscardEmailContentUnauthorized) UnmarshalJSON added in v0.19.0 

func (s *DiscardEmailContentUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DiscardEmailContentUnauthorized) Validate added in v0.19.0 

func (s *DiscardEmailContentUnauthorized) Validate() error

type Domain 

type Domain struct {
	Type             DomainType // switch on this field
	VerifiedDomain   VerifiedDomain
	UnverifiedDomain UnverifiedDomain
}

A domain can be either verified or unverified. Verified domains have `is_active` and `spam_threshold` fields. Unverified domains have a `verification_token` and `dns_records` for DNS setup. Ref: #/components/schemas/Domain Domain represents sum type.

func NewUnverifiedDomainDomain 

func NewUnverifiedDomainDomain(v UnverifiedDomain) Domain

NewUnverifiedDomainDomain returns new Domain from UnverifiedDomain.

func NewVerifiedDomainDomain 

func NewVerifiedDomainDomain(v VerifiedDomain) Domain

NewVerifiedDomainDomain returns new Domain from VerifiedDomain.

func (*Domain) Decode 

func (s *Domain) Decode(d *jx.Decoder) error

Decode decodes Domain from json.

func (Domain) Encode 

func (s Domain) Encode(e *jx.Encoder)

Encode encodes Domain as json.

func (Domain) GetUnverifiedDomain 

func (s Domain) GetUnverifiedDomain() (v UnverifiedDomain, ok bool)

GetUnverifiedDomain returns UnverifiedDomain and true boolean if Domain is UnverifiedDomain.

func (Domain) GetVerifiedDomain 

func (s Domain) GetVerifiedDomain() (v VerifiedDomain, ok bool)

GetVerifiedDomain returns VerifiedDomain and true boolean if Domain is VerifiedDomain.

func (Domain) IsUnverifiedDomain 

func (s Domain) IsUnverifiedDomain() bool

IsUnverifiedDomain reports whether Domain is UnverifiedDomain.

func (Domain) IsVerifiedDomain 

func (s Domain) IsVerifiedDomain() bool

IsVerifiedDomain reports whether Domain is VerifiedDomain.

func (Domain) MarshalJSON 

func (s Domain) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Domain) SetUnverifiedDomain 

func (s *Domain) SetUnverifiedDomain(v UnverifiedDomain)

SetUnverifiedDomain sets Domain to UnverifiedDomain.

func (*Domain) SetVerifiedDomain 

func (s *Domain) SetVerifiedDomain(v VerifiedDomain)

SetVerifiedDomain sets Domain to VerifiedDomain.

func (*Domain) UnmarshalJSON 

func (s *Domain) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (Domain) Validate 

func (s Domain) Validate() error

type DomainDnsRecord added in v0.29.2 

type DomainDnsRecord struct {
	// DNS record type.
	Type DomainDnsRecordType `json:"type"`
	// DNS-provider host/name value relative to the managed root zone.
	Name string `json:"name"`
	// Fully-qualified DNS record name.
	Fqdn string `json:"fqdn"`
	// Exact value to publish.
	Value string `json:"value"`
	// MX priority. Present only for MX records.
	Priority OptInt `json:"priority"`
	// Suggested TTL in seconds when the API can provide one.
	TTL      OptInt                 `json:"ttl"`
	Required bool                   `json:"required"`
	Purpose  DomainDnsRecordPurpose `json:"purpose"`
	Status   DomainDnsRecordStatus  `json:"status"`
	// Short explanation of why this record is needed.
	Message OptString `json:"message"`
}

Ref: #/components/schemas/DomainDnsRecord

func (*DomainDnsRecord) Decode added in v0.29.2 

func (s *DomainDnsRecord) Decode(d *jx.Decoder) error

Decode decodes DomainDnsRecord from json.

func (*DomainDnsRecord) Encode added in v0.29.2 

func (s *DomainDnsRecord) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*DomainDnsRecord) GetFqdn added in v0.29.2 

func (s *DomainDnsRecord) GetFqdn() string

GetFqdn returns the value of Fqdn.

func (*DomainDnsRecord) GetMessage added in v0.29.2 

func (s *DomainDnsRecord) GetMessage() OptString

GetMessage returns the value of Message.

func (*DomainDnsRecord) GetName added in v0.29.2 

func (s *DomainDnsRecord) GetName() string

GetName returns the value of Name.

func (*DomainDnsRecord) GetPriority added in v0.29.2 

func (s *DomainDnsRecord) GetPriority() OptInt

GetPriority returns the value of Priority.

func (*DomainDnsRecord) GetPurpose added in v0.29.2 

func (s *DomainDnsRecord) GetPurpose() DomainDnsRecordPurpose

GetPurpose returns the value of Purpose.

func (*DomainDnsRecord) GetRequired added in v0.29.2 

func (s *DomainDnsRecord) GetRequired() bool

GetRequired returns the value of Required.

func (*DomainDnsRecord) GetStatus added in v0.29.2 

func (s *DomainDnsRecord) GetStatus() DomainDnsRecordStatus

GetStatus returns the value of Status.

func (*DomainDnsRecord) GetTTL added in v0.29.2 

func (s *DomainDnsRecord) GetTTL() OptInt

GetTTL returns the value of TTL.

func (*DomainDnsRecord) GetType added in v0.29.2 

func (s *DomainDnsRecord) GetType() DomainDnsRecordType

GetType returns the value of Type.

func (*DomainDnsRecord) GetValue added in v0.29.2 

func (s *DomainDnsRecord) GetValue() string

GetValue returns the value of Value.

func (*DomainDnsRecord) MarshalJSON added in v0.29.2 

func (s *DomainDnsRecord) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DomainDnsRecord) SetFqdn added in v0.29.2 

func (s *DomainDnsRecord) SetFqdn(val string)

SetFqdn sets the value of Fqdn.

func (*DomainDnsRecord) SetMessage added in v0.29.2 

func (s *DomainDnsRecord) SetMessage(val OptString)

SetMessage sets the value of Message.

func (*DomainDnsRecord) SetName added in v0.29.2 

func (s *DomainDnsRecord) SetName(val string)

SetName sets the value of Name.

func (*DomainDnsRecord) SetPriority added in v0.29.2 

func (s *DomainDnsRecord) SetPriority(val OptInt)

SetPriority sets the value of Priority.

func (*DomainDnsRecord) SetPurpose added in v0.29.2 

func (s *DomainDnsRecord) SetPurpose(val DomainDnsRecordPurpose)

SetPurpose sets the value of Purpose.

func (*DomainDnsRecord) SetRequired added in v0.29.2 

func (s *DomainDnsRecord) SetRequired(val bool)

SetRequired sets the value of Required.

func (*DomainDnsRecord) SetStatus added in v0.29.2 

func (s *DomainDnsRecord) SetStatus(val DomainDnsRecordStatus)

SetStatus sets the value of Status.

func (*DomainDnsRecord) SetTTL added in v0.29.2 

func (s *DomainDnsRecord) SetTTL(val OptInt)

SetTTL sets the value of TTL.

func (*DomainDnsRecord) SetType added in v0.29.2 

func (s *DomainDnsRecord) SetType(val DomainDnsRecordType)

SetType sets the value of Type.

func (*DomainDnsRecord) SetValue added in v0.29.2 

func (s *DomainDnsRecord) SetValue(val string)

SetValue sets the value of Value.

func (*DomainDnsRecord) UnmarshalJSON added in v0.29.2 

func (s *DomainDnsRecord) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DomainDnsRecord) Validate added in v0.29.2 

func (s *DomainDnsRecord) Validate() error

type DomainDnsRecordPurpose added in v0.29.2 

type DomainDnsRecordPurpose string
const (
	DomainDnsRecordPurposeInboundMx             DomainDnsRecordPurpose = "inbound_mx"
	DomainDnsRecordPurposeOwnershipVerification DomainDnsRecordPurpose = "ownership_verification"
	DomainDnsRecordPurposeSpf                   DomainDnsRecordPurpose = "spf"
	DomainDnsRecordPurposeDkim                  DomainDnsRecordPurpose = "dkim"
	DomainDnsRecordPurposeDmarc                 DomainDnsRecordPurpose = "dmarc"
	DomainDnsRecordPurposeTLSReporting          DomainDnsRecordPurpose = "tls_reporting"
)

func (DomainDnsRecordPurpose) AllValues added in v0.29.2 

func (DomainDnsRecordPurpose) AllValues() []DomainDnsRecordPurpose

AllValues returns all DomainDnsRecordPurpose values.

func (*DomainDnsRecordPurpose) Decode added in v0.29.2 

func (s *DomainDnsRecordPurpose) Decode(d *jx.Decoder) error

Decode decodes DomainDnsRecordPurpose from json.

func (DomainDnsRecordPurpose) Encode added in v0.29.2 

func (s DomainDnsRecordPurpose) Encode(e *jx.Encoder)

Encode encodes DomainDnsRecordPurpose as json.

func (DomainDnsRecordPurpose) MarshalJSON added in v0.29.2 

func (s DomainDnsRecordPurpose) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (DomainDnsRecordPurpose) MarshalText added in v0.29.2 

func (s DomainDnsRecordPurpose) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*DomainDnsRecordPurpose) UnmarshalJSON added in v0.29.2 

func (s *DomainDnsRecordPurpose) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DomainDnsRecordPurpose) UnmarshalText added in v0.29.2 

func (s *DomainDnsRecordPurpose) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (DomainDnsRecordPurpose) Validate added in v0.29.2 

func (s DomainDnsRecordPurpose) Validate() error

type DomainDnsRecordStatus added in v0.29.2 

type DomainDnsRecordStatus string
const (
	DomainDnsRecordStatusPending   DomainDnsRecordStatus = "pending"
	DomainDnsRecordStatusFound     DomainDnsRecordStatus = "found"
	DomainDnsRecordStatusMissing   DomainDnsRecordStatus = "missing"
	DomainDnsRecordStatusIncorrect DomainDnsRecordStatus = "incorrect"
)

func (DomainDnsRecordStatus) AllValues added in v0.29.2 

func (DomainDnsRecordStatus) AllValues() []DomainDnsRecordStatus

AllValues returns all DomainDnsRecordStatus values.

func (*DomainDnsRecordStatus) Decode added in v0.29.2 

func (s *DomainDnsRecordStatus) Decode(d *jx.Decoder) error

Decode decodes DomainDnsRecordStatus from json.

func (DomainDnsRecordStatus) Encode added in v0.29.2 

func (s DomainDnsRecordStatus) Encode(e *jx.Encoder)

Encode encodes DomainDnsRecordStatus as json.

func (DomainDnsRecordStatus) MarshalJSON added in v0.29.2 

func (s DomainDnsRecordStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (DomainDnsRecordStatus) MarshalText added in v0.29.2 

func (s DomainDnsRecordStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*DomainDnsRecordStatus) UnmarshalJSON added in v0.29.2 

func (s *DomainDnsRecordStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DomainDnsRecordStatus) UnmarshalText added in v0.29.2 

func (s *DomainDnsRecordStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (DomainDnsRecordStatus) Validate added in v0.29.2 

func (s DomainDnsRecordStatus) Validate() error

type DomainDnsRecordType added in v0.29.2 

type DomainDnsRecordType string

DNS record type. 

const (
	DomainDnsRecordTypeMX  DomainDnsRecordType = "MX"
	DomainDnsRecordTypeTXT DomainDnsRecordType = "TXT"
)

func (DomainDnsRecordType) AllValues added in v0.29.2 

func (DomainDnsRecordType) AllValues() []DomainDnsRecordType

AllValues returns all DomainDnsRecordType values.

func (*DomainDnsRecordType) Decode added in v0.29.2 

func (s *DomainDnsRecordType) Decode(d *jx.Decoder) error

Decode decodes DomainDnsRecordType from json.

func (DomainDnsRecordType) Encode added in v0.29.2 

func (s DomainDnsRecordType) Encode(e *jx.Encoder)

Encode encodes DomainDnsRecordType as json.

func (DomainDnsRecordType) MarshalJSON added in v0.29.2 

func (s DomainDnsRecordType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (DomainDnsRecordType) MarshalText added in v0.29.2 

func (s DomainDnsRecordType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*DomainDnsRecordType) UnmarshalJSON added in v0.29.2 

func (s *DomainDnsRecordType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DomainDnsRecordType) UnmarshalText added in v0.29.2 

func (s *DomainDnsRecordType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (DomainDnsRecordType) Validate added in v0.29.2 

func (s DomainDnsRecordType) Validate() error

type DomainType 

type DomainType string

DomainType is oneOf type of Domain. 

const (
	VerifiedDomainDomain   DomainType = "VerifiedDomain"
	UnverifiedDomainDomain DomainType = "UnverifiedDomain"
)

Possible values for DomainType.

type DomainVerifyResult 

type DomainVerifyResult struct {
	Type                DomainVerifyResultType // switch on this field
	DomainVerifyResult0 DomainVerifyResult0
	DomainVerifyResult1 DomainVerifyResult1
}

Ref: #/components/schemas/DomainVerifyResult DomainVerifyResult represents sum type.

func NewDomainVerifyResult0DomainVerifyResult 

func NewDomainVerifyResult0DomainVerifyResult(v DomainVerifyResult0) DomainVerifyResult

NewDomainVerifyResult0DomainVerifyResult returns new DomainVerifyResult from DomainVerifyResult0.

func NewDomainVerifyResult1DomainVerifyResult 

func NewDomainVerifyResult1DomainVerifyResult(v DomainVerifyResult1) DomainVerifyResult

NewDomainVerifyResult1DomainVerifyResult returns new DomainVerifyResult from DomainVerifyResult1.

func (*DomainVerifyResult) Decode 

func (s *DomainVerifyResult) Decode(d *jx.Decoder) error

Decode decodes DomainVerifyResult from json.

func (DomainVerifyResult) Encode 

func (s DomainVerifyResult) Encode(e *jx.Encoder)

Encode encodes DomainVerifyResult as json.

func (DomainVerifyResult) GetDomainVerifyResult0 

func (s DomainVerifyResult) GetDomainVerifyResult0() (v DomainVerifyResult0, ok bool)

GetDomainVerifyResult0 returns DomainVerifyResult0 and true boolean if DomainVerifyResult is DomainVerifyResult0.

func (DomainVerifyResult) GetDomainVerifyResult1 

func (s DomainVerifyResult) GetDomainVerifyResult1() (v DomainVerifyResult1, ok bool)

GetDomainVerifyResult1 returns DomainVerifyResult1 and true boolean if DomainVerifyResult is DomainVerifyResult1.

func (DomainVerifyResult) IsDomainVerifyResult0 

func (s DomainVerifyResult) IsDomainVerifyResult0() bool

IsDomainVerifyResult0 reports whether DomainVerifyResult is DomainVerifyResult0.

func (DomainVerifyResult) IsDomainVerifyResult1 

func (s DomainVerifyResult) IsDomainVerifyResult1() bool

IsDomainVerifyResult1 reports whether DomainVerifyResult is DomainVerifyResult1.

func (DomainVerifyResult) MarshalJSON 

func (s DomainVerifyResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DomainVerifyResult) SetDomainVerifyResult0 

func (s *DomainVerifyResult) SetDomainVerifyResult0(v DomainVerifyResult0)

SetDomainVerifyResult0 sets DomainVerifyResult to DomainVerifyResult0.

func (*DomainVerifyResult) SetDomainVerifyResult1 

func (s *DomainVerifyResult) SetDomainVerifyResult1(v DomainVerifyResult1)

SetDomainVerifyResult1 sets DomainVerifyResult to DomainVerifyResult1.

func (*DomainVerifyResult) UnmarshalJSON 

func (s *DomainVerifyResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (DomainVerifyResult) Validate added in v0.29.2 

func (s DomainVerifyResult) Validate() error

type DomainVerifyResult0 

type DomainVerifyResult0 struct {
	Verified bool `json:"verified"`
	// Exact DNS records checked for this verification attempt.
	DNSRecords []DomainDnsRecord `json:"dns_records"`
}

func (*DomainVerifyResult0) Decode 

func (s *DomainVerifyResult0) Decode(d *jx.Decoder) error

Decode decodes DomainVerifyResult0 from json.

func (*DomainVerifyResult0) Encode 

func (s *DomainVerifyResult0) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*DomainVerifyResult0) GetDNSRecords added in v0.29.2 

func (s *DomainVerifyResult0) GetDNSRecords() []DomainDnsRecord

GetDNSRecords returns the value of DNSRecords.

func (*DomainVerifyResult0) GetVerified 

func (s *DomainVerifyResult0) GetVerified() bool

GetVerified returns the value of Verified.

func (*DomainVerifyResult0) MarshalJSON 

func (s *DomainVerifyResult0) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DomainVerifyResult0) SetDNSRecords added in v0.29.2 

func (s *DomainVerifyResult0) SetDNSRecords(val []DomainDnsRecord)

SetDNSRecords sets the value of DNSRecords.

func (*DomainVerifyResult0) SetVerified 

func (s *DomainVerifyResult0) SetVerified(val bool)

SetVerified sets the value of Verified.

func (*DomainVerifyResult0) UnmarshalJSON 

func (s *DomainVerifyResult0) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DomainVerifyResult0) Validate added in v0.29.2 

func (s *DomainVerifyResult0) Validate() error

type DomainVerifyResult1 

type DomainVerifyResult1 struct {
	Verified bool `json:"verified"`
	// Whether MX records point to Primitive.
	MxFound bool `json:"mxFound"`
	// Whether the TXT verification record was found.
	TxtFound bool `json:"txtFound"`
	// Whether the SPF record includes Primitive.
	SpfFound OptBool `json:"spfFound"`
	// Whether the DKIM public key record was found.
	DkimFound OptBool `json:"dkimFound"`
	// Whether the DMARC record was found.
	DmarcFound OptBool `json:"dmarcFound"`
	// Whether the TLS-RPT record was found.
	TlsRptFound OptBool `json:"tlsRptFound"`
	// Exact DNS records checked for this verification attempt.
	DNSRecords []DomainDnsRecord `json:"dns_records"`
	// Human-readable verification failure reason.
	Error string `json:"error"`
}

func (*DomainVerifyResult1) Decode 

func (s *DomainVerifyResult1) Decode(d *jx.Decoder) error

Decode decodes DomainVerifyResult1 from json.

func (*DomainVerifyResult1) Encode 

func (s *DomainVerifyResult1) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*DomainVerifyResult1) GetDNSRecords added in v0.29.2 

func (s *DomainVerifyResult1) GetDNSRecords() []DomainDnsRecord

GetDNSRecords returns the value of DNSRecords.

func (*DomainVerifyResult1) GetDkimFound added in v0.29.2 

func (s *DomainVerifyResult1) GetDkimFound() OptBool

GetDkimFound returns the value of DkimFound.

func (*DomainVerifyResult1) GetDmarcFound added in v0.29.2 

func (s *DomainVerifyResult1) GetDmarcFound() OptBool

GetDmarcFound returns the value of DmarcFound.

func (*DomainVerifyResult1) GetError 

func (s *DomainVerifyResult1) GetError() string

GetError returns the value of Error.

func (*DomainVerifyResult1) GetMxFound 

func (s *DomainVerifyResult1) GetMxFound() bool

GetMxFound returns the value of MxFound.

func (*DomainVerifyResult1) GetSpfFound added in v0.29.2 

func (s *DomainVerifyResult1) GetSpfFound() OptBool

GetSpfFound returns the value of SpfFound.

func (*DomainVerifyResult1) GetTlsRptFound added in v0.29.2 

func (s *DomainVerifyResult1) GetTlsRptFound() OptBool

GetTlsRptFound returns the value of TlsRptFound.

func (*DomainVerifyResult1) GetTxtFound 

func (s *DomainVerifyResult1) GetTxtFound() bool

GetTxtFound returns the value of TxtFound.

func (*DomainVerifyResult1) GetVerified 

func (s *DomainVerifyResult1) GetVerified() bool

GetVerified returns the value of Verified.

func (*DomainVerifyResult1) MarshalJSON 

func (s *DomainVerifyResult1) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DomainVerifyResult1) SetDNSRecords added in v0.29.2 

func (s *DomainVerifyResult1) SetDNSRecords(val []DomainDnsRecord)

SetDNSRecords sets the value of DNSRecords.

func (*DomainVerifyResult1) SetDkimFound added in v0.29.2 

func (s *DomainVerifyResult1) SetDkimFound(val OptBool)

SetDkimFound sets the value of DkimFound.

func (*DomainVerifyResult1) SetDmarcFound added in v0.29.2 

func (s *DomainVerifyResult1) SetDmarcFound(val OptBool)

SetDmarcFound sets the value of DmarcFound.

func (*DomainVerifyResult1) SetError 

func (s *DomainVerifyResult1) SetError(val string)

SetError sets the value of Error.

func (*DomainVerifyResult1) SetMxFound 

func (s *DomainVerifyResult1) SetMxFound(val bool)

SetMxFound sets the value of MxFound.

func (*DomainVerifyResult1) SetSpfFound added in v0.29.2 

func (s *DomainVerifyResult1) SetSpfFound(val OptBool)

SetSpfFound sets the value of SpfFound.

func (*DomainVerifyResult1) SetTlsRptFound added in v0.29.2 

func (s *DomainVerifyResult1) SetTlsRptFound(val OptBool)

SetTlsRptFound sets the value of TlsRptFound.

func (*DomainVerifyResult1) SetTxtFound 

func (s *DomainVerifyResult1) SetTxtFound(val bool)

SetTxtFound sets the value of TxtFound.

func (*DomainVerifyResult1) SetVerified 

func (s *DomainVerifyResult1) SetVerified(val bool)

SetVerified sets the value of Verified.

func (*DomainVerifyResult1) UnmarshalJSON 

func (s *DomainVerifyResult1) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DomainVerifyResult1) Validate added in v0.29.2 

func (s *DomainVerifyResult1) Validate() error

type DomainVerifyResultType 

type DomainVerifyResultType string

DomainVerifyResultType is oneOf type of DomainVerifyResult. 

const (
	DomainVerifyResult0DomainVerifyResult DomainVerifyResultType = "DomainVerifyResult0"
	DomainVerifyResult1DomainVerifyResult DomainVerifyResultType = "DomainVerifyResult1"
)

Possible values for DomainVerifyResultType.

type DownloadAttachmentsBadRequest 

type DownloadAttachmentsBadRequest ErrorResponse

func (*DownloadAttachmentsBadRequest) Decode 

func (s *DownloadAttachmentsBadRequest) Decode(d *jx.Decoder) error

Decode decodes DownloadAttachmentsBadRequest from json.

func (*DownloadAttachmentsBadRequest) Encode 

func (s *DownloadAttachmentsBadRequest) Encode(e *jx.Encoder)

Encode encodes DownloadAttachmentsBadRequest as json.

func (*DownloadAttachmentsBadRequest) MarshalJSON 

func (s *DownloadAttachmentsBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DownloadAttachmentsBadRequest) UnmarshalJSON 

func (s *DownloadAttachmentsBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DownloadAttachmentsBadRequest) Validate 

func (s *DownloadAttachmentsBadRequest) Validate() error

type DownloadAttachmentsNotFound 

type DownloadAttachmentsNotFound ErrorResponse

func (*DownloadAttachmentsNotFound) Decode 

func (s *DownloadAttachmentsNotFound) Decode(d *jx.Decoder) error

Decode decodes DownloadAttachmentsNotFound from json.

func (*DownloadAttachmentsNotFound) Encode 

func (s *DownloadAttachmentsNotFound) Encode(e *jx.Encoder)

Encode encodes DownloadAttachmentsNotFound as json.

func (*DownloadAttachmentsNotFound) MarshalJSON 

func (s *DownloadAttachmentsNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DownloadAttachmentsNotFound) UnmarshalJSON 

func (s *DownloadAttachmentsNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DownloadAttachmentsNotFound) Validate 

func (s *DownloadAttachmentsNotFound) Validate() error

type DownloadAttachmentsOK 

type DownloadAttachmentsOK struct {
	Data io.Reader
}

func (DownloadAttachmentsOK) Read 

func (s DownloadAttachmentsOK) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type DownloadAttachmentsOKHeaders 

type DownloadAttachmentsOKHeaders struct {
	ContentDisposition OptString
	XAttachmentCount   OptString
	XContentSHA256     OptString
	Response           DownloadAttachmentsOK
}

DownloadAttachmentsOKHeaders wraps DownloadAttachmentsOK with response headers.

func (*DownloadAttachmentsOKHeaders) GetContentDisposition 

func (s *DownloadAttachmentsOKHeaders) GetContentDisposition() OptString

GetContentDisposition returns the value of ContentDisposition.

func (*DownloadAttachmentsOKHeaders) GetResponse 

func (s *DownloadAttachmentsOKHeaders) GetResponse() DownloadAttachmentsOK

GetResponse returns the value of Response.

func (*DownloadAttachmentsOKHeaders) GetXAttachmentCount 

func (s *DownloadAttachmentsOKHeaders) GetXAttachmentCount() OptString

GetXAttachmentCount returns the value of XAttachmentCount.

func (*DownloadAttachmentsOKHeaders) GetXContentSHA256 

func (s *DownloadAttachmentsOKHeaders) GetXContentSHA256() OptString

GetXContentSHA256 returns the value of XContentSHA256.

func (*DownloadAttachmentsOKHeaders) SetContentDisposition 

func (s *DownloadAttachmentsOKHeaders) SetContentDisposition(val OptString)

SetContentDisposition sets the value of ContentDisposition.

func (*DownloadAttachmentsOKHeaders) SetResponse 

func (s *DownloadAttachmentsOKHeaders) SetResponse(val DownloadAttachmentsOK)

SetResponse sets the value of Response.

func (*DownloadAttachmentsOKHeaders) SetXAttachmentCount 

func (s *DownloadAttachmentsOKHeaders) SetXAttachmentCount(val OptString)

SetXAttachmentCount sets the value of XAttachmentCount.

func (*DownloadAttachmentsOKHeaders) SetXContentSHA256 

func (s *DownloadAttachmentsOKHeaders) SetXContentSHA256(val OptString)

SetXContentSHA256 sets the value of XContentSHA256.

type DownloadAttachmentsParams 

type DownloadAttachmentsParams struct {
	// Signed download token from webhook payload.
	Token OptString `json:",omitempty,omitzero"`
	// Resource UUID.
	ID uuid.UUID
}

DownloadAttachmentsParams is parameters of downloadAttachments operation.

type DownloadAttachmentsRes 

type DownloadAttachmentsRes interface {
	// contains filtered or unexported methods
}

type DownloadAttachmentsUnauthorized 

type DownloadAttachmentsUnauthorized ErrorResponse

func (*DownloadAttachmentsUnauthorized) Decode 

func (s *DownloadAttachmentsUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DownloadAttachmentsUnauthorized from json.

func (*DownloadAttachmentsUnauthorized) Encode 

func (s *DownloadAttachmentsUnauthorized) Encode(e *jx.Encoder)

Encode encodes DownloadAttachmentsUnauthorized as json.

func (*DownloadAttachmentsUnauthorized) MarshalJSON 

func (s *DownloadAttachmentsUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DownloadAttachmentsUnauthorized) UnmarshalJSON 

func (s *DownloadAttachmentsUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DownloadAttachmentsUnauthorized) Validate 

func (s *DownloadAttachmentsUnauthorized) Validate() error

type DownloadDomainZoneFileBadRequest added in v0.29.2 

type DownloadDomainZoneFileBadRequest ErrorResponse

func (*DownloadDomainZoneFileBadRequest) Decode added in v0.29.2 

func (s *DownloadDomainZoneFileBadRequest) Decode(d *jx.Decoder) error

Decode decodes DownloadDomainZoneFileBadRequest from json.

func (*DownloadDomainZoneFileBadRequest) Encode added in v0.29.2 

func (s *DownloadDomainZoneFileBadRequest) Encode(e *jx.Encoder)

Encode encodes DownloadDomainZoneFileBadRequest as json.

func (*DownloadDomainZoneFileBadRequest) MarshalJSON added in v0.29.2 

func (s *DownloadDomainZoneFileBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DownloadDomainZoneFileBadRequest) UnmarshalJSON added in v0.29.2 

func (s *DownloadDomainZoneFileBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DownloadDomainZoneFileBadRequest) Validate added in v0.29.2 

func (s *DownloadDomainZoneFileBadRequest) Validate() error

type DownloadDomainZoneFileNotFound added in v0.29.2 

type DownloadDomainZoneFileNotFound ErrorResponse

func (*DownloadDomainZoneFileNotFound) Decode added in v0.29.2 

func (s *DownloadDomainZoneFileNotFound) Decode(d *jx.Decoder) error

Decode decodes DownloadDomainZoneFileNotFound from json.

func (*DownloadDomainZoneFileNotFound) Encode added in v0.29.2 

func (s *DownloadDomainZoneFileNotFound) Encode(e *jx.Encoder)

Encode encodes DownloadDomainZoneFileNotFound as json.

func (*DownloadDomainZoneFileNotFound) MarshalJSON added in v0.29.2 

func (s *DownloadDomainZoneFileNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DownloadDomainZoneFileNotFound) UnmarshalJSON added in v0.29.2 

func (s *DownloadDomainZoneFileNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DownloadDomainZoneFileNotFound) Validate added in v0.29.2 

func (s *DownloadDomainZoneFileNotFound) Validate() error

type DownloadDomainZoneFileOK added in v0.29.2 

type DownloadDomainZoneFileOK struct {
	Data io.Reader
}

func (DownloadDomainZoneFileOK) Read added in v0.29.2 

func (s DownloadDomainZoneFileOK) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type DownloadDomainZoneFileOKHeaders added in v0.29.2 

type DownloadDomainZoneFileOKHeaders struct {
	ContentDisposition OptString
	Response           DownloadDomainZoneFileOK
}

DownloadDomainZoneFileOKHeaders wraps DownloadDomainZoneFileOK with response headers.

func (*DownloadDomainZoneFileOKHeaders) GetContentDisposition added in v0.29.2 

func (s *DownloadDomainZoneFileOKHeaders) GetContentDisposition() OptString

GetContentDisposition returns the value of ContentDisposition.

func (*DownloadDomainZoneFileOKHeaders) GetResponse added in v0.29.2 

func (s *DownloadDomainZoneFileOKHeaders) GetResponse() DownloadDomainZoneFileOK

GetResponse returns the value of Response.

func (*DownloadDomainZoneFileOKHeaders) SetContentDisposition added in v0.29.2 

func (s *DownloadDomainZoneFileOKHeaders) SetContentDisposition(val OptString)

SetContentDisposition sets the value of ContentDisposition.

func (*DownloadDomainZoneFileOKHeaders) SetResponse added in v0.29.2 

func (s *DownloadDomainZoneFileOKHeaders) SetResponse(val DownloadDomainZoneFileOK)

SetResponse sets the value of Response.

type DownloadDomainZoneFileParams added in v0.29.2 

type DownloadDomainZoneFileParams struct {
	// When true, include only outbound DNS records. Verified domains
	// default to outbound-only; pending claims default to all required
	// records.
	OutboundOnly OptBool `json:",omitempty,omitzero"`
	// Resource UUID.
	ID uuid.UUID
}

DownloadDomainZoneFileParams is parameters of downloadDomainZoneFile operation.

type DownloadDomainZoneFileRes added in v0.29.2 

type DownloadDomainZoneFileRes interface {
	// contains filtered or unexported methods
}

type DownloadDomainZoneFileUnauthorized added in v0.29.2 

type DownloadDomainZoneFileUnauthorized ErrorResponse

func (*DownloadDomainZoneFileUnauthorized) Decode added in v0.29.2 

func (s *DownloadDomainZoneFileUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DownloadDomainZoneFileUnauthorized from json.

func (*DownloadDomainZoneFileUnauthorized) Encode added in v0.29.2 

func (s *DownloadDomainZoneFileUnauthorized) Encode(e *jx.Encoder)

Encode encodes DownloadDomainZoneFileUnauthorized as json.

func (*DownloadDomainZoneFileUnauthorized) MarshalJSON added in v0.29.2 

func (s *DownloadDomainZoneFileUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DownloadDomainZoneFileUnauthorized) UnmarshalJSON added in v0.29.2 

func (s *DownloadDomainZoneFileUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DownloadDomainZoneFileUnauthorized) Validate added in v0.29.2 

func (s *DownloadDomainZoneFileUnauthorized) Validate() error

type DownloadRawEmailBadRequest 

type DownloadRawEmailBadRequest ErrorResponse

func (*DownloadRawEmailBadRequest) Decode 

func (s *DownloadRawEmailBadRequest) Decode(d *jx.Decoder) error

Decode decodes DownloadRawEmailBadRequest from json.

func (*DownloadRawEmailBadRequest) Encode 

func (s *DownloadRawEmailBadRequest) Encode(e *jx.Encoder)

Encode encodes DownloadRawEmailBadRequest as json.

func (*DownloadRawEmailBadRequest) MarshalJSON 

func (s *DownloadRawEmailBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DownloadRawEmailBadRequest) UnmarshalJSON 

func (s *DownloadRawEmailBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DownloadRawEmailBadRequest) Validate 

func (s *DownloadRawEmailBadRequest) Validate() error

type DownloadRawEmailNotFound 

type DownloadRawEmailNotFound ErrorResponse

func (*DownloadRawEmailNotFound) Decode 

func (s *DownloadRawEmailNotFound) Decode(d *jx.Decoder) error

Decode decodes DownloadRawEmailNotFound from json.

func (*DownloadRawEmailNotFound) Encode 

func (s *DownloadRawEmailNotFound) Encode(e *jx.Encoder)

Encode encodes DownloadRawEmailNotFound as json.

func (*DownloadRawEmailNotFound) MarshalJSON 

func (s *DownloadRawEmailNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DownloadRawEmailNotFound) UnmarshalJSON 

func (s *DownloadRawEmailNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DownloadRawEmailNotFound) Validate 

func (s *DownloadRawEmailNotFound) Validate() error

type DownloadRawEmailOK 

type DownloadRawEmailOK struct {
	Data io.Reader
}

func (DownloadRawEmailOK) Read 

func (s DownloadRawEmailOK) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type DownloadRawEmailOKHeaders 

type DownloadRawEmailOKHeaders struct {
	ContentDisposition OptString
	XContentSHA256     OptString
	Response           DownloadRawEmailOK
}

DownloadRawEmailOKHeaders wraps DownloadRawEmailOK with response headers.

func (*DownloadRawEmailOKHeaders) GetContentDisposition 

func (s *DownloadRawEmailOKHeaders) GetContentDisposition() OptString

GetContentDisposition returns the value of ContentDisposition.

func (*DownloadRawEmailOKHeaders) GetResponse 

func (s *DownloadRawEmailOKHeaders) GetResponse() DownloadRawEmailOK

GetResponse returns the value of Response.

func (*DownloadRawEmailOKHeaders) GetXContentSHA256 

func (s *DownloadRawEmailOKHeaders) GetXContentSHA256() OptString

GetXContentSHA256 returns the value of XContentSHA256.

func (*DownloadRawEmailOKHeaders) SetContentDisposition 

func (s *DownloadRawEmailOKHeaders) SetContentDisposition(val OptString)

SetContentDisposition sets the value of ContentDisposition.

func (*DownloadRawEmailOKHeaders) SetResponse 

func (s *DownloadRawEmailOKHeaders) SetResponse(val DownloadRawEmailOK)

SetResponse sets the value of Response.

func (*DownloadRawEmailOKHeaders) SetXContentSHA256 

func (s *DownloadRawEmailOKHeaders) SetXContentSHA256(val OptString)

SetXContentSHA256 sets the value of XContentSHA256.

type DownloadRawEmailParams 

type DownloadRawEmailParams struct {
	// Signed download token from webhook payload.
	Token OptString `json:",omitempty,omitzero"`
	// Resource UUID.
	ID uuid.UUID
}

DownloadRawEmailParams is parameters of downloadRawEmail operation.

type DownloadRawEmailRes 

type DownloadRawEmailRes interface {
	// contains filtered or unexported methods
}

type DownloadRawEmailUnauthorized 

type DownloadRawEmailUnauthorized ErrorResponse

func (*DownloadRawEmailUnauthorized) Decode 

func (s *DownloadRawEmailUnauthorized) Decode(d *jx.Decoder) error

Decode decodes DownloadRawEmailUnauthorized from json.

func (*DownloadRawEmailUnauthorized) Encode 

func (s *DownloadRawEmailUnauthorized) Encode(e *jx.Encoder)

Encode encodes DownloadRawEmailUnauthorized as json.

func (*DownloadRawEmailUnauthorized) MarshalJSON 

func (s *DownloadRawEmailUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DownloadRawEmailUnauthorized) UnmarshalJSON 

func (s *DownloadRawEmailUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DownloadRawEmailUnauthorized) Validate 

func (s *DownloadRawEmailUnauthorized) Validate() error

type DownloadToken 

type DownloadToken struct {
	APIKey string
	Roles  []string
}

func (*DownloadToken) GetAPIKey 

func (s *DownloadToken) GetAPIKey() string

GetAPIKey returns the value of APIKey.

func (*DownloadToken) GetRoles 

func (s *DownloadToken) GetRoles() []string

GetRoles returns the value of Roles.

func (*DownloadToken) SetAPIKey 

func (s *DownloadToken) SetAPIKey(val string)

SetAPIKey sets the value of APIKey.

func (*DownloadToken) SetRoles 

func (s *DownloadToken) SetRoles(val []string)

SetRoles sets the value of Roles.

type EmailDetail 

type EmailDetail struct {
	ID        uuid.UUID    `json:"id"`
	MessageID OptNilString `json:"message_id"`
	DomainID  OptNilUUID   `json:"domain_id"`
	OrgID     OptNilUUID   `json:"org_id"`
	// SMTP envelope sender (return-path) the inbound mail server
	// accepted. Same value as `smtp_mail_from`; both fields exist
	// so protocol-aware tooling can use whichever name it expects.
	// For most legitimate mail this equals `from_email`; for
	// mailing lists, bounce handlers, and forwarders it is
	// typically the bounce-handling address rather than the
	// human-visible sender.
	// **For the canonical "who sent this email" value, use
	// `from_email`.**.
	Sender    string       `json:"sender"`
	Recipient string       `json:"recipient"`
	Subject   OptNilString `json:"subject"`
	// Plain-text body parsed from the inbound MIME, matching the `email.parsed.body_text` field on the
	// webhook payload. Null when the message had no text part or parsing failed.
	BodyText OptNilString `json:"body_text"`
	// HTML body parsed from the inbound MIME, matching the `email.parsed.body_html` field on the webhook
	// payload. Null when the message had no HTML part or parsing failed.
	BodyHTML              OptNilString             `json:"body_html"`
	Status                EmailStatus              `json:"status"`
	Domain                string                   `json:"domain"`
	SpamScore             OptNilFloat64            `json:"spam_score"`
	RawSizeBytes          OptNilInt                `json:"raw_size_bytes"`
	RawSHA256             OptNilString             `json:"raw_sha256"`
	CreatedAt             time.Time                `json:"created_at"`
	ReceivedAt            time.Time                `json:"received_at"`
	RejectionReason       OptNilString             `json:"rejection_reason"`
	WebhookStatus         OptNilEmailWebhookStatus `json:"webhook_status"`
	WebhookAttemptCount   int                      `json:"webhook_attempt_count"`
	WebhookLastAttemptAt  OptNilDateTime           `json:"webhook_last_attempt_at"`
	WebhookLastStatusCode OptNilInt                `json:"webhook_last_status_code"`
	WebhookLastError      OptNilString             `json:"webhook_last_error"`
	WebhookFiredAt        OptNilDateTime           `json:"webhook_fired_at"`
	SMTPHelo              OptNilString             `json:"smtp_helo"`
	// SMTP envelope MAIL FROM (return-path), as accepted by the
	// inbound mail server. Same value as `sender`; both fields
	// exist so protocol-aware tooling can use whichever name it
	// expects.
	// For the canonical "who sent this email" value (display name
	// stripped, From-header preferred), use `from_email`.
	SMTPMailFrom OptNilString      `json:"smtp_mail_from"`
	SMTPRcptTo   OptNilStringArray `json:"smtp_rcpt_to"`
	// Raw `From:` header from the message body, including any
	// display name (e.g. `"Alice Example" <alice@example.com>`).
	// Use this when you need the display name for rendering.
	// For the bare email address (display name stripped), use
	// `from_email`.
	FromHeader                   OptNilString   `json:"from_header"`
	ContentDiscardedAt           OptNilDateTime `json:"content_discarded_at"`
	ContentDiscardedByDeliveryID OptNilString   `json:"content_discarded_by_delivery_id"`
	// Bare email address parsed from the `From:` header, with
	// display name stripped (e.g. `alice@example.com`). Falls
	// back to `sender` (the SMTP envelope MAIL FROM) when the
	// `From:` header cannot be parsed.
	// **This is the canonical "who sent this email" field for
	// most use cases**, including comparing against allowlists,
	// routing replies, or displaying the sender to a user. Use
	// `from_header` when you specifically need the display name,
	// or `sender`/`smtp_mail_from` when you need the SMTP
	// envelope value (e.g. to follow a bounce).
	FromEmail string `json:"from_email"`
	// Parsed to address (same as recipient).
	ToEmail string `json:"to_email"`
	// True when the inbound's sender address has a matching grant
	// in the org's known-send-addresses list. Advisory: a true
	// value does not by itself guarantee that a reply will be
	// accepted by send-mail's gates; the per-send check at send
	// time remains authoritative.
	FromKnownAddress OptBool `json:"from_known_address"`
	// Sent emails recorded as replies to this inbound, in send
	// order (ascending). Populated when a customer's send-mail
	// request carries an `in_reply_to` Message-ID that matches
	// this inbound's `message_id` in the same org. Includes
	// attempts that were gate-denied, so the array reflects every
	// recorded reply attempt regardless of outcome.
	Replies []EmailDetailReply `json:"replies"`
	// The `sent_emails.id` of the outbound this inbound was a
	// reply to, when resolvable. Set at inbound ingest by
	// matching the parsed In-Reply-To (or References, as a
	// fallback) against `sent_emails.message_id` in the same
	// org. The mirror of `sent_emails.in_reply_to_email_id` for
	// the inbound side of a thread. NULL when the inbound is
	// not a threaded reply to one of your sends, when neither
	// header survived the path through intermediate MTAs, or on
	// inbound received before this auto-link landed.
	ReplyToSentEmailID OptNilUUID `json:"reply_to_sent_email_id"`
}

Ref: #/components/schemas/EmailDetail

func (*EmailDetail) Decode 

func (s *EmailDetail) Decode(d *jx.Decoder) error

Decode decodes EmailDetail from json.

func (*EmailDetail) Encode 

func (s *EmailDetail) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EmailDetail) GetBodyHTML added in v0.10.0 

func (s *EmailDetail) GetBodyHTML() OptNilString

GetBodyHTML returns the value of BodyHTML.

func (*EmailDetail) GetBodyText added in v0.10.0 

func (s *EmailDetail) GetBodyText() OptNilString

GetBodyText returns the value of BodyText.

func (*EmailDetail) GetContentDiscardedAt 

func (s *EmailDetail) GetContentDiscardedAt() OptNilDateTime

GetContentDiscardedAt returns the value of ContentDiscardedAt.

func (*EmailDetail) GetContentDiscardedByDeliveryID 

func (s *EmailDetail) GetContentDiscardedByDeliveryID() OptNilString

GetContentDiscardedByDeliveryID returns the value of ContentDiscardedByDeliveryID.

func (*EmailDetail) GetCreatedAt 

func (s *EmailDetail) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*EmailDetail) GetDomain 

func (s *EmailDetail) GetDomain() string

GetDomain returns the value of Domain.

func (*EmailDetail) GetDomainID 

func (s *EmailDetail) GetDomainID() OptNilUUID

GetDomainID returns the value of DomainID.

func (*EmailDetail) GetFromEmail 

func (s *EmailDetail) GetFromEmail() string

GetFromEmail returns the value of FromEmail.

func (*EmailDetail) GetFromHeader 

func (s *EmailDetail) GetFromHeader() OptNilString

GetFromHeader returns the value of FromHeader.

func (*EmailDetail) GetFromKnownAddress added in v0.10.0 

func (s *EmailDetail) GetFromKnownAddress() OptBool

GetFromKnownAddress returns the value of FromKnownAddress.

func (*EmailDetail) GetID 

func (s *EmailDetail) GetID() uuid.UUID

GetID returns the value of ID.

func (*EmailDetail) GetMessageID 

func (s *EmailDetail) GetMessageID() OptNilString

GetMessageID returns the value of MessageID.

func (*EmailDetail) GetOrgID 

func (s *EmailDetail) GetOrgID() OptNilUUID

GetOrgID returns the value of OrgID.

func (*EmailDetail) GetRawSHA256 

func (s *EmailDetail) GetRawSHA256() OptNilString

GetRawSHA256 returns the value of RawSHA256.

func (*EmailDetail) GetRawSizeBytes 

func (s *EmailDetail) GetRawSizeBytes() OptNilInt

GetRawSizeBytes returns the value of RawSizeBytes.

func (*EmailDetail) GetReceivedAt 

func (s *EmailDetail) GetReceivedAt() time.Time

GetReceivedAt returns the value of ReceivedAt.

func (*EmailDetail) GetRecipient 

func (s *EmailDetail) GetRecipient() string

GetRecipient returns the value of Recipient.

func (*EmailDetail) GetRejectionReason 

func (s *EmailDetail) GetRejectionReason() OptNilString

GetRejectionReason returns the value of RejectionReason.

func (*EmailDetail) GetReplies added in v0.10.0 

func (s *EmailDetail) GetReplies() []EmailDetailReply

GetReplies returns the value of Replies.

func (*EmailDetail) GetReplyToSentEmailID added in v0.29.1 

func (s *EmailDetail) GetReplyToSentEmailID() OptNilUUID

GetReplyToSentEmailID returns the value of ReplyToSentEmailID.

func (*EmailDetail) GetSMTPHelo 

func (s *EmailDetail) GetSMTPHelo() OptNilString

GetSMTPHelo returns the value of SMTPHelo.

func (*EmailDetail) GetSMTPMailFrom 

func (s *EmailDetail) GetSMTPMailFrom() OptNilString

GetSMTPMailFrom returns the value of SMTPMailFrom.

func (*EmailDetail) GetSMTPRcptTo 

func (s *EmailDetail) GetSMTPRcptTo() OptNilStringArray

GetSMTPRcptTo returns the value of SMTPRcptTo.

func (*EmailDetail) GetSender 

func (s *EmailDetail) GetSender() string

GetSender returns the value of Sender.

func (*EmailDetail) GetSpamScore 

func (s *EmailDetail) GetSpamScore() OptNilFloat64

GetSpamScore returns the value of SpamScore.

func (*EmailDetail) GetStatus 

func (s *EmailDetail) GetStatus() EmailStatus

GetStatus returns the value of Status.

func (*EmailDetail) GetSubject 

func (s *EmailDetail) GetSubject() OptNilString

GetSubject returns the value of Subject.

func (*EmailDetail) GetToEmail 

func (s *EmailDetail) GetToEmail() string

GetToEmail returns the value of ToEmail.

func (*EmailDetail) GetWebhookAttemptCount 

func (s *EmailDetail) GetWebhookAttemptCount() int

GetWebhookAttemptCount returns the value of WebhookAttemptCount.

func (*EmailDetail) GetWebhookFiredAt 

func (s *EmailDetail) GetWebhookFiredAt() OptNilDateTime

GetWebhookFiredAt returns the value of WebhookFiredAt.

func (*EmailDetail) GetWebhookLastAttemptAt 

func (s *EmailDetail) GetWebhookLastAttemptAt() OptNilDateTime

GetWebhookLastAttemptAt returns the value of WebhookLastAttemptAt.

func (*EmailDetail) GetWebhookLastError 

func (s *EmailDetail) GetWebhookLastError() OptNilString

GetWebhookLastError returns the value of WebhookLastError.

func (*EmailDetail) GetWebhookLastStatusCode 

func (s *EmailDetail) GetWebhookLastStatusCode() OptNilInt

GetWebhookLastStatusCode returns the value of WebhookLastStatusCode.

func (*EmailDetail) GetWebhookStatus 

func (s *EmailDetail) GetWebhookStatus() OptNilEmailWebhookStatus

GetWebhookStatus returns the value of WebhookStatus.

func (*EmailDetail) MarshalJSON 

func (s *EmailDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EmailDetail) SetBodyHTML added in v0.10.0 

func (s *EmailDetail) SetBodyHTML(val OptNilString)

SetBodyHTML sets the value of BodyHTML.

func (*EmailDetail) SetBodyText added in v0.10.0 

func (s *EmailDetail) SetBodyText(val OptNilString)

SetBodyText sets the value of BodyText.

func (*EmailDetail) SetContentDiscardedAt 

func (s *EmailDetail) SetContentDiscardedAt(val OptNilDateTime)

SetContentDiscardedAt sets the value of ContentDiscardedAt.

func (*EmailDetail) SetContentDiscardedByDeliveryID 

func (s *EmailDetail) SetContentDiscardedByDeliveryID(val OptNilString)

SetContentDiscardedByDeliveryID sets the value of ContentDiscardedByDeliveryID.

func (*EmailDetail) SetCreatedAt 

func (s *EmailDetail) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*EmailDetail) SetDomain 

func (s *EmailDetail) SetDomain(val string)

SetDomain sets the value of Domain.

func (*EmailDetail) SetDomainID 

func (s *EmailDetail) SetDomainID(val OptNilUUID)

SetDomainID sets the value of DomainID.

func (*EmailDetail) SetFromEmail 

func (s *EmailDetail) SetFromEmail(val string)

SetFromEmail sets the value of FromEmail.

func (*EmailDetail) SetFromHeader 

func (s *EmailDetail) SetFromHeader(val OptNilString)

SetFromHeader sets the value of FromHeader.

func (*EmailDetail) SetFromKnownAddress added in v0.10.0 

func (s *EmailDetail) SetFromKnownAddress(val OptBool)

SetFromKnownAddress sets the value of FromKnownAddress.

func (*EmailDetail) SetID 

func (s *EmailDetail) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*EmailDetail) SetMessageID 

func (s *EmailDetail) SetMessageID(val OptNilString)

SetMessageID sets the value of MessageID.

func (*EmailDetail) SetOrgID 

func (s *EmailDetail) SetOrgID(val OptNilUUID)

SetOrgID sets the value of OrgID.

func (*EmailDetail) SetRawSHA256 

func (s *EmailDetail) SetRawSHA256(val OptNilString)

SetRawSHA256 sets the value of RawSHA256.

func (*EmailDetail) SetRawSizeBytes 

func (s *EmailDetail) SetRawSizeBytes(val OptNilInt)

SetRawSizeBytes sets the value of RawSizeBytes.

func (*EmailDetail) SetReceivedAt 

func (s *EmailDetail) SetReceivedAt(val time.Time)

SetReceivedAt sets the value of ReceivedAt.

func (*EmailDetail) SetRecipient 

func (s *EmailDetail) SetRecipient(val string)

SetRecipient sets the value of Recipient.

func (*EmailDetail) SetRejectionReason 

func (s *EmailDetail) SetRejectionReason(val OptNilString)

SetRejectionReason sets the value of RejectionReason.

func (*EmailDetail) SetReplies added in v0.10.0 

func (s *EmailDetail) SetReplies(val []EmailDetailReply)

SetReplies sets the value of Replies.

func (*EmailDetail) SetReplyToSentEmailID added in v0.29.1 

func (s *EmailDetail) SetReplyToSentEmailID(val OptNilUUID)

SetReplyToSentEmailID sets the value of ReplyToSentEmailID.

func (*EmailDetail) SetSMTPHelo 

func (s *EmailDetail) SetSMTPHelo(val OptNilString)

SetSMTPHelo sets the value of SMTPHelo.

func (*EmailDetail) SetSMTPMailFrom 

func (s *EmailDetail) SetSMTPMailFrom(val OptNilString)

SetSMTPMailFrom sets the value of SMTPMailFrom.

func (*EmailDetail) SetSMTPRcptTo 

func (s *EmailDetail) SetSMTPRcptTo(val OptNilStringArray)

SetSMTPRcptTo sets the value of SMTPRcptTo.

func (*EmailDetail) SetSender 

func (s *EmailDetail) SetSender(val string)

SetSender sets the value of Sender.

func (*EmailDetail) SetSpamScore 

func (s *EmailDetail) SetSpamScore(val OptNilFloat64)

SetSpamScore sets the value of SpamScore.

func (*EmailDetail) SetStatus 

func (s *EmailDetail) SetStatus(val EmailStatus)

SetStatus sets the value of Status.

func (*EmailDetail) SetSubject 

func (s *EmailDetail) SetSubject(val OptNilString)

SetSubject sets the value of Subject.

func (*EmailDetail) SetToEmail 

func (s *EmailDetail) SetToEmail(val string)

SetToEmail sets the value of ToEmail.

func (*EmailDetail) SetWebhookAttemptCount 

func (s *EmailDetail) SetWebhookAttemptCount(val int)

SetWebhookAttemptCount sets the value of WebhookAttemptCount.

func (*EmailDetail) SetWebhookFiredAt 

func (s *EmailDetail) SetWebhookFiredAt(val OptNilDateTime)

SetWebhookFiredAt sets the value of WebhookFiredAt.

func (*EmailDetail) SetWebhookLastAttemptAt 

func (s *EmailDetail) SetWebhookLastAttemptAt(val OptNilDateTime)

SetWebhookLastAttemptAt sets the value of WebhookLastAttemptAt.

func (*EmailDetail) SetWebhookLastError 

func (s *EmailDetail) SetWebhookLastError(val OptNilString)

SetWebhookLastError sets the value of WebhookLastError.

func (*EmailDetail) SetWebhookLastStatusCode 

func (s *EmailDetail) SetWebhookLastStatusCode(val OptNilInt)

SetWebhookLastStatusCode sets the value of WebhookLastStatusCode.

func (*EmailDetail) SetWebhookStatus 

func (s *EmailDetail) SetWebhookStatus(val OptNilEmailWebhookStatus)

SetWebhookStatus sets the value of WebhookStatus.

func (*EmailDetail) UnmarshalJSON 

func (s *EmailDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailDetail) Validate 

func (s *EmailDetail) Validate() error

type EmailDetailReply added in v0.10.0 

type EmailDetailReply struct {
	// Sent-email row id.
	ID     uuid.UUID       `json:"id"`
	Status SentEmailStatus `json:"status"`
	// Recipient address as recorded on the sent_emails row.
	ToAddress string       `json:"to_address"`
	Subject   OptNilString `json:"subject"`
	CreatedAt time.Time    `json:"created_at"`
	// Outbound relay queue identifier when available.
	QueueID OptNilString `json:"queue_id"`
}

Ref: #/components/schemas/EmailDetailReply

func (*EmailDetailReply) Decode added in v0.10.0 

func (s *EmailDetailReply) Decode(d *jx.Decoder) error

Decode decodes EmailDetailReply from json.

func (*EmailDetailReply) Encode added in v0.10.0 

func (s *EmailDetailReply) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EmailDetailReply) GetCreatedAt added in v0.10.0 

func (s *EmailDetailReply) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*EmailDetailReply) GetID added in v0.10.0 

func (s *EmailDetailReply) GetID() uuid.UUID

GetID returns the value of ID.

func (*EmailDetailReply) GetQueueID added in v0.10.0 

func (s *EmailDetailReply) GetQueueID() OptNilString

GetQueueID returns the value of QueueID.

func (*EmailDetailReply) GetStatus added in v0.10.0 

func (s *EmailDetailReply) GetStatus() SentEmailStatus

GetStatus returns the value of Status.

func (*EmailDetailReply) GetSubject added in v0.10.0 

func (s *EmailDetailReply) GetSubject() OptNilString

GetSubject returns the value of Subject.

func (*EmailDetailReply) GetToAddress added in v0.10.0 

func (s *EmailDetailReply) GetToAddress() string

GetToAddress returns the value of ToAddress.

func (*EmailDetailReply) MarshalJSON added in v0.10.0 

func (s *EmailDetailReply) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EmailDetailReply) SetCreatedAt added in v0.10.0 

func (s *EmailDetailReply) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*EmailDetailReply) SetID added in v0.10.0 

func (s *EmailDetailReply) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*EmailDetailReply) SetQueueID added in v0.10.0 

func (s *EmailDetailReply) SetQueueID(val OptNilString)

SetQueueID sets the value of QueueID.

func (*EmailDetailReply) SetStatus added in v0.10.0 

func (s *EmailDetailReply) SetStatus(val SentEmailStatus)

SetStatus sets the value of Status.

func (*EmailDetailReply) SetSubject added in v0.10.0 

func (s *EmailDetailReply) SetSubject(val OptNilString)

SetSubject sets the value of Subject.

func (*EmailDetailReply) SetToAddress added in v0.10.0 

func (s *EmailDetailReply) SetToAddress(val string)

SetToAddress sets the value of ToAddress.

func (*EmailDetailReply) UnmarshalJSON added in v0.10.0 

func (s *EmailDetailReply) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailDetailReply) Validate added in v0.10.0 

func (s *EmailDetailReply) Validate() error

type EmailSearchFacetBucket added in v0.21.0 

type EmailSearchFacetBucket struct {
	Value NilString `json:"value"`
	Count int       `json:"count"`
}

Ref: #/components/schemas/EmailSearchFacetBucket

func (*EmailSearchFacetBucket) Decode added in v0.21.0 

func (s *EmailSearchFacetBucket) Decode(d *jx.Decoder) error

Decode decodes EmailSearchFacetBucket from json.

func (*EmailSearchFacetBucket) Encode added in v0.21.0 

func (s *EmailSearchFacetBucket) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EmailSearchFacetBucket) GetCount added in v0.21.0 

func (s *EmailSearchFacetBucket) GetCount() int

GetCount returns the value of Count.

func (*EmailSearchFacetBucket) GetValue added in v0.21.0 

func (s *EmailSearchFacetBucket) GetValue() NilString

GetValue returns the value of Value.

func (*EmailSearchFacetBucket) MarshalJSON added in v0.21.0 

func (s *EmailSearchFacetBucket) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EmailSearchFacetBucket) SetCount added in v0.21.0 

func (s *EmailSearchFacetBucket) SetCount(val int)

SetCount sets the value of Count.

func (*EmailSearchFacetBucket) SetValue added in v0.21.0 

func (s *EmailSearchFacetBucket) SetValue(val NilString)

SetValue sets the value of Value.

func (*EmailSearchFacetBucket) UnmarshalJSON added in v0.21.0 

func (s *EmailSearchFacetBucket) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type EmailSearchFacets added in v0.21.0 

type EmailSearchFacets struct {
	BySender      []EmailSearchFacetBucket       `json:"by_sender"`
	ByDomain      []EmailSearchFacetBucket       `json:"by_domain"`
	ByStatus      []EmailSearchFacetBucket       `json:"by_status"`
	HasAttachment EmailSearchFacetsHasAttachment `json:"has_attachment"`
}

Ref: #/components/schemas/EmailSearchFacets

func (*EmailSearchFacets) Decode added in v0.21.0 

func (s *EmailSearchFacets) Decode(d *jx.Decoder) error

Decode decodes EmailSearchFacets from json.

func (*EmailSearchFacets) Encode added in v0.21.0 

func (s *EmailSearchFacets) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EmailSearchFacets) GetByDomain added in v0.21.0 

func (s *EmailSearchFacets) GetByDomain() []EmailSearchFacetBucket

GetByDomain returns the value of ByDomain.

func (*EmailSearchFacets) GetBySender added in v0.21.0 

func (s *EmailSearchFacets) GetBySender() []EmailSearchFacetBucket

GetBySender returns the value of BySender.

func (*EmailSearchFacets) GetByStatus added in v0.21.0 

func (s *EmailSearchFacets) GetByStatus() []EmailSearchFacetBucket

GetByStatus returns the value of ByStatus.

func (*EmailSearchFacets) GetHasAttachment added in v0.21.0 

func (s *EmailSearchFacets) GetHasAttachment() EmailSearchFacetsHasAttachment

GetHasAttachment returns the value of HasAttachment.

func (*EmailSearchFacets) MarshalJSON added in v0.21.0 

func (s *EmailSearchFacets) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EmailSearchFacets) SetByDomain added in v0.21.0 

func (s *EmailSearchFacets) SetByDomain(val []EmailSearchFacetBucket)

SetByDomain sets the value of ByDomain.

func (*EmailSearchFacets) SetBySender added in v0.21.0 

func (s *EmailSearchFacets) SetBySender(val []EmailSearchFacetBucket)

SetBySender sets the value of BySender.

func (*EmailSearchFacets) SetByStatus added in v0.21.0 

func (s *EmailSearchFacets) SetByStatus(val []EmailSearchFacetBucket)

SetByStatus sets the value of ByStatus.

func (*EmailSearchFacets) SetHasAttachment added in v0.21.0 

func (s *EmailSearchFacets) SetHasAttachment(val EmailSearchFacetsHasAttachment)

SetHasAttachment sets the value of HasAttachment.

func (*EmailSearchFacets) UnmarshalJSON added in v0.21.0 

func (s *EmailSearchFacets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailSearchFacets) Validate added in v0.21.0 

func (s *EmailSearchFacets) Validate() error

type EmailSearchFacetsHasAttachment added in v0.21.0 

type EmailSearchFacetsHasAttachment struct {
	True  int `json:"true"`
	False int `json:"false"`
}

func (*EmailSearchFacetsHasAttachment) Decode added in v0.21.0 

func (s *EmailSearchFacetsHasAttachment) Decode(d *jx.Decoder) error

Decode decodes EmailSearchFacetsHasAttachment from json.

func (*EmailSearchFacetsHasAttachment) Encode added in v0.21.0 

func (s *EmailSearchFacetsHasAttachment) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EmailSearchFacetsHasAttachment) GetFalse added in v0.21.0 

func (s *EmailSearchFacetsHasAttachment) GetFalse() int

GetFalse returns the value of False.

func (*EmailSearchFacetsHasAttachment) GetTrue added in v0.21.0 

func (s *EmailSearchFacetsHasAttachment) GetTrue() int

GetTrue returns the value of True.

func (*EmailSearchFacetsHasAttachment) MarshalJSON added in v0.21.0 

func (s *EmailSearchFacetsHasAttachment) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EmailSearchFacetsHasAttachment) SetFalse added in v0.21.0 

func (s *EmailSearchFacetsHasAttachment) SetFalse(val int)

SetFalse sets the value of False.

func (*EmailSearchFacetsHasAttachment) SetTrue added in v0.21.0 

func (s *EmailSearchFacetsHasAttachment) SetTrue(val int)

SetTrue sets the value of True.

func (*EmailSearchFacetsHasAttachment) UnmarshalJSON added in v0.21.0 

func (s *EmailSearchFacetsHasAttachment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type EmailSearchHighlights added in v0.21.0 

type EmailSearchHighlights struct {
	// Subject snippets with matching terms highlighted.
	Subject []string `json:"subject"`
	// Body snippets with matching terms highlighted.
	Body []string `json:"body"`
}

Ref: #/components/schemas/EmailSearchHighlights

func (*EmailSearchHighlights) Decode added in v0.21.0 

func (s *EmailSearchHighlights) Decode(d *jx.Decoder) error

Decode decodes EmailSearchHighlights from json.

func (*EmailSearchHighlights) Encode added in v0.21.0 

func (s *EmailSearchHighlights) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EmailSearchHighlights) GetBody added in v0.21.0 

func (s *EmailSearchHighlights) GetBody() []string

GetBody returns the value of Body.

func (*EmailSearchHighlights) GetSubject added in v0.21.0 

func (s *EmailSearchHighlights) GetSubject() []string

GetSubject returns the value of Subject.

func (*EmailSearchHighlights) MarshalJSON added in v0.21.0 

func (s *EmailSearchHighlights) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EmailSearchHighlights) SetBody added in v0.21.0 

func (s *EmailSearchHighlights) SetBody(val []string)

SetBody sets the value of Body.

func (*EmailSearchHighlights) SetSubject added in v0.21.0 

func (s *EmailSearchHighlights) SetSubject(val []string)

SetSubject sets the value of Subject.

func (*EmailSearchHighlights) UnmarshalJSON added in v0.21.0 

func (s *EmailSearchHighlights) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailSearchHighlights) Validate added in v0.21.0 

func (s *EmailSearchHighlights) Validate() error

type EmailSearchMeta added in v0.21.0 

type EmailSearchMeta struct {
	// Total number of matching records, capped when `total_capped` is true.
	Total int `json:"total"`
	// Whether `total` was capped instead of counted exactly.
	TotalCapped bool `json:"total_capped"`
	// Page size used for this request.
	Limit int `json:"limit"`
	// Cursor for the next search page, or null if no more results.
	Cursor NilString `json:"cursor"`
	// Sort mode used for the result page.
	Sort EmailSearchMetaSort `json:"sort"`
}

Ref: #/components/schemas/EmailSearchMeta

func (*EmailSearchMeta) Decode added in v0.21.0 

func (s *EmailSearchMeta) Decode(d *jx.Decoder) error

Decode decodes EmailSearchMeta from json.

func (*EmailSearchMeta) Encode added in v0.21.0 

func (s *EmailSearchMeta) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EmailSearchMeta) GetCursor added in v0.21.0 

func (s *EmailSearchMeta) GetCursor() NilString

GetCursor returns the value of Cursor.

func (*EmailSearchMeta) GetLimit added in v0.21.0 

func (s *EmailSearchMeta) GetLimit() int

GetLimit returns the value of Limit.

func (*EmailSearchMeta) GetSort added in v0.21.0 

func (s *EmailSearchMeta) GetSort() EmailSearchMetaSort

GetSort returns the value of Sort.

func (*EmailSearchMeta) GetTotal added in v0.21.0 

func (s *EmailSearchMeta) GetTotal() int

GetTotal returns the value of Total.

func (*EmailSearchMeta) GetTotalCapped added in v0.21.0 

func (s *EmailSearchMeta) GetTotalCapped() bool

GetTotalCapped returns the value of TotalCapped.

func (*EmailSearchMeta) MarshalJSON added in v0.21.0 

func (s *EmailSearchMeta) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EmailSearchMeta) SetCursor added in v0.21.0 

func (s *EmailSearchMeta) SetCursor(val NilString)

SetCursor sets the value of Cursor.

func (*EmailSearchMeta) SetLimit added in v0.21.0 

func (s *EmailSearchMeta) SetLimit(val int)

SetLimit sets the value of Limit.

func (*EmailSearchMeta) SetSort added in v0.21.0 

func (s *EmailSearchMeta) SetSort(val EmailSearchMetaSort)

SetSort sets the value of Sort.

func (*EmailSearchMeta) SetTotal added in v0.21.0 

func (s *EmailSearchMeta) SetTotal(val int)

SetTotal sets the value of Total.

func (*EmailSearchMeta) SetTotalCapped added in v0.21.0 

func (s *EmailSearchMeta) SetTotalCapped(val bool)

SetTotalCapped sets the value of TotalCapped.

func (*EmailSearchMeta) UnmarshalJSON added in v0.21.0 

func (s *EmailSearchMeta) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailSearchMeta) Validate added in v0.21.0 

func (s *EmailSearchMeta) Validate() error

type EmailSearchMetaSort added in v0.21.0 

type EmailSearchMetaSort string

Sort mode used for the result page. 

const (
	EmailSearchMetaSortRelevance      EmailSearchMetaSort = "relevance"
	EmailSearchMetaSortReceivedAtDesc EmailSearchMetaSort = "received_at_desc"
	EmailSearchMetaSortReceivedAtAsc  EmailSearchMetaSort = "received_at_asc"
)

func (EmailSearchMetaSort) AllValues added in v0.21.0 

func (EmailSearchMetaSort) AllValues() []EmailSearchMetaSort

AllValues returns all EmailSearchMetaSort values.

func (*EmailSearchMetaSort) Decode added in v0.21.0 

func (s *EmailSearchMetaSort) Decode(d *jx.Decoder) error

Decode decodes EmailSearchMetaSort from json.

func (EmailSearchMetaSort) Encode added in v0.21.0 

func (s EmailSearchMetaSort) Encode(e *jx.Encoder)

Encode encodes EmailSearchMetaSort as json.

func (EmailSearchMetaSort) MarshalJSON added in v0.21.0 

func (s EmailSearchMetaSort) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (EmailSearchMetaSort) MarshalText added in v0.21.0 

func (s EmailSearchMetaSort) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*EmailSearchMetaSort) UnmarshalJSON added in v0.21.0 

func (s *EmailSearchMetaSort) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailSearchMetaSort) UnmarshalText added in v0.21.0 

func (s *EmailSearchMetaSort) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (EmailSearchMetaSort) Validate added in v0.21.0 

func (s EmailSearchMetaSort) Validate() error

type EmailSearchResult added in v0.21.0 

type EmailSearchResult struct {
	ID        uuid.UUID    `json:"id"`
	MessageID OptNilString `json:"message_id"`
	DomainID  OptNilUUID   `json:"domain_id"`
	OrgID     OptNilUUID   `json:"org_id"`
	Status    EmailStatus  `json:"status"`
	// SMTP envelope sender (return-path) the inbound mail server
	// accepted. For most legitimate mail this equals the bare
	// address in the From header; for mailing lists, bounce
	// handlers, and forwarders it is typically the bounce address
	// rather than the human-visible sender.
	// For the parsed From-header value (with display name handling
	// and a sender-fallback when the header is unparseable), GET
	// the email by id and use `from_email`.
	Sender              string                   `json:"sender"`
	Recipient           string                   `json:"recipient"`
	Subject             OptNilString             `json:"subject"`
	Domain              string                   `json:"domain"`
	SpamScore           OptNilFloat64            `json:"spam_score"`
	CreatedAt           time.Time                `json:"created_at"`
	ReceivedAt          time.Time                `json:"received_at"`
	RawSizeBytes        OptNilInt                `json:"raw_size_bytes"`
	WebhookStatus       OptNilEmailWebhookStatus `json:"webhook_status"`
	WebhookAttemptCount int                      `json:"webhook_attempt_count"`
	// Number of parsed attachments on the email.
	AttachmentCount int `json:"attachment_count"`
	// Whether the parsed From address is known to this org from prior authenticated inbound mail.
	FromKnownAddress bool `json:"from_known_address"`
	// Relevance score. Present only when sorting by relevance.
	Score      OptFloat64               `json:"score"`
	Highlights OptEmailSearchHighlights `json:"highlights"`
}

Merged schema. Ref: #/components/schemas/EmailSearchResult

func (*EmailSearchResult) Decode added in v0.21.0 

func (s *EmailSearchResult) Decode(d *jx.Decoder) error

Decode decodes EmailSearchResult from json.

func (*EmailSearchResult) Encode added in v0.21.0 

func (s *EmailSearchResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EmailSearchResult) GetAttachmentCount added in v0.21.0 

func (s *EmailSearchResult) GetAttachmentCount() int

GetAttachmentCount returns the value of AttachmentCount.

func (*EmailSearchResult) GetCreatedAt added in v0.21.0 

func (s *EmailSearchResult) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*EmailSearchResult) GetDomain added in v0.21.0 

func (s *EmailSearchResult) GetDomain() string

GetDomain returns the value of Domain.

func (*EmailSearchResult) GetDomainID added in v0.21.0 

func (s *EmailSearchResult) GetDomainID() OptNilUUID

GetDomainID returns the value of DomainID.

func (*EmailSearchResult) GetFromKnownAddress added in v0.21.0 

func (s *EmailSearchResult) GetFromKnownAddress() bool

GetFromKnownAddress returns the value of FromKnownAddress.

func (*EmailSearchResult) GetHighlights added in v0.21.0 

func (s *EmailSearchResult) GetHighlights() OptEmailSearchHighlights

GetHighlights returns the value of Highlights.

func (*EmailSearchResult) GetID added in v0.21.0 

func (s *EmailSearchResult) GetID() uuid.UUID

GetID returns the value of ID.

func (*EmailSearchResult) GetMessageID added in v0.21.0 

func (s *EmailSearchResult) GetMessageID() OptNilString

GetMessageID returns the value of MessageID.

func (*EmailSearchResult) GetOrgID added in v0.21.0 

func (s *EmailSearchResult) GetOrgID() OptNilUUID

GetOrgID returns the value of OrgID.

func (*EmailSearchResult) GetRawSizeBytes added in v0.21.0 

func (s *EmailSearchResult) GetRawSizeBytes() OptNilInt

GetRawSizeBytes returns the value of RawSizeBytes.

func (*EmailSearchResult) GetReceivedAt added in v0.21.0 

func (s *EmailSearchResult) GetReceivedAt() time.Time

GetReceivedAt returns the value of ReceivedAt.

func (*EmailSearchResult) GetRecipient added in v0.21.0 

func (s *EmailSearchResult) GetRecipient() string

GetRecipient returns the value of Recipient.

func (*EmailSearchResult) GetScore added in v0.21.0 

func (s *EmailSearchResult) GetScore() OptFloat64

GetScore returns the value of Score.

func (*EmailSearchResult) GetSender added in v0.21.0 

func (s *EmailSearchResult) GetSender() string

GetSender returns the value of Sender.

func (*EmailSearchResult) GetSpamScore added in v0.21.0 

func (s *EmailSearchResult) GetSpamScore() OptNilFloat64

GetSpamScore returns the value of SpamScore.

func (*EmailSearchResult) GetStatus added in v0.21.0 

func (s *EmailSearchResult) GetStatus() EmailStatus

GetStatus returns the value of Status.

func (*EmailSearchResult) GetSubject added in v0.21.0 

func (s *EmailSearchResult) GetSubject() OptNilString

GetSubject returns the value of Subject.

func (*EmailSearchResult) GetWebhookAttemptCount added in v0.21.0 

func (s *EmailSearchResult) GetWebhookAttemptCount() int

GetWebhookAttemptCount returns the value of WebhookAttemptCount.

func (*EmailSearchResult) GetWebhookStatus added in v0.21.0 

func (s *EmailSearchResult) GetWebhookStatus() OptNilEmailWebhookStatus

GetWebhookStatus returns the value of WebhookStatus.

func (*EmailSearchResult) MarshalJSON added in v0.21.0 

func (s *EmailSearchResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EmailSearchResult) SetAttachmentCount added in v0.21.0 

func (s *EmailSearchResult) SetAttachmentCount(val int)

SetAttachmentCount sets the value of AttachmentCount.

func (*EmailSearchResult) SetCreatedAt added in v0.21.0 

func (s *EmailSearchResult) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*EmailSearchResult) SetDomain added in v0.21.0 

func (s *EmailSearchResult) SetDomain(val string)

SetDomain sets the value of Domain.

func (*EmailSearchResult) SetDomainID added in v0.21.0 

func (s *EmailSearchResult) SetDomainID(val OptNilUUID)

SetDomainID sets the value of DomainID.

func (*EmailSearchResult) SetFromKnownAddress added in v0.21.0 

func (s *EmailSearchResult) SetFromKnownAddress(val bool)

SetFromKnownAddress sets the value of FromKnownAddress.

func (*EmailSearchResult) SetHighlights added in v0.21.0 

func (s *EmailSearchResult) SetHighlights(val OptEmailSearchHighlights)

SetHighlights sets the value of Highlights.

func (*EmailSearchResult) SetID added in v0.21.0 

func (s *EmailSearchResult) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*EmailSearchResult) SetMessageID added in v0.21.0 

func (s *EmailSearchResult) SetMessageID(val OptNilString)

SetMessageID sets the value of MessageID.

func (*EmailSearchResult) SetOrgID added in v0.21.0 

func (s *EmailSearchResult) SetOrgID(val OptNilUUID)

SetOrgID sets the value of OrgID.

func (*EmailSearchResult) SetRawSizeBytes added in v0.21.0 

func (s *EmailSearchResult) SetRawSizeBytes(val OptNilInt)

SetRawSizeBytes sets the value of RawSizeBytes.

func (*EmailSearchResult) SetReceivedAt added in v0.21.0 

func (s *EmailSearchResult) SetReceivedAt(val time.Time)

SetReceivedAt sets the value of ReceivedAt.

func (*EmailSearchResult) SetRecipient added in v0.21.0 

func (s *EmailSearchResult) SetRecipient(val string)

SetRecipient sets the value of Recipient.

func (*EmailSearchResult) SetScore added in v0.21.0 

func (s *EmailSearchResult) SetScore(val OptFloat64)

SetScore sets the value of Score.

func (*EmailSearchResult) SetSender added in v0.21.0 

func (s *EmailSearchResult) SetSender(val string)

SetSender sets the value of Sender.

func (*EmailSearchResult) SetSpamScore added in v0.21.0 

func (s *EmailSearchResult) SetSpamScore(val OptNilFloat64)

SetSpamScore sets the value of SpamScore.

func (*EmailSearchResult) SetStatus added in v0.21.0 

func (s *EmailSearchResult) SetStatus(val EmailStatus)

SetStatus sets the value of Status.

func (*EmailSearchResult) SetSubject added in v0.21.0 

func (s *EmailSearchResult) SetSubject(val OptNilString)

SetSubject sets the value of Subject.

func (*EmailSearchResult) SetWebhookAttemptCount added in v0.21.0 

func (s *EmailSearchResult) SetWebhookAttemptCount(val int)

SetWebhookAttemptCount sets the value of WebhookAttemptCount.

func (*EmailSearchResult) SetWebhookStatus added in v0.21.0 

func (s *EmailSearchResult) SetWebhookStatus(val OptNilEmailWebhookStatus)

SetWebhookStatus sets the value of WebhookStatus.

func (*EmailSearchResult) UnmarshalJSON added in v0.21.0 

func (s *EmailSearchResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailSearchResult) Validate added in v0.21.0 

func (s *EmailSearchResult) Validate() error

type EmailStatus added in v0.19.0 

type EmailStatus string

Lifecycle status of an INBOUND email (a row in the `emails` table). Distinct from `SentEmailStatus`, which describes the OUTBOUND lifecycle (the `sent_emails` table) and uses a different vocabulary because the lifecycles differ. Possible values: - `pending`: the row was inserted at ingestion (mx_main) and has not yet completed the spam / filter / auth pipeline. Body and parsed fields are present; webhook delivery is not yet scheduled. Most rows transition out of `pending` within seconds. - `accepted`: the inbound passed the policy gates and is queued for webhook delivery. The `webhook_status` field tracks the separate webhook-delivery lifecycle from this point. - `completed`: terminal success. Webhook delivery attempted and acknowledged by every active endpoint, OR no endpoints are configured, so the row is durably archived. - `rejected`: terminal failure at ingestion (spam, blocked sender, filter rule, malformed). The body and metadata are stored for auditing but no webhook fires and the row is not repliable. See also `webhook_status` (separate enum tracking the webhook-delivery state machine) and `SentEmailStatus` (the outbound vocabulary). Ref: #/components/schemas/EmailStatus 

const (
	EmailStatusPending   EmailStatus = "pending"
	EmailStatusAccepted  EmailStatus = "accepted"
	EmailStatusCompleted EmailStatus = "completed"
	EmailStatusRejected  EmailStatus = "rejected"
)

func (EmailStatus) AllValues added in v0.19.0 

func (EmailStatus) AllValues() []EmailStatus

AllValues returns all EmailStatus values.

func (*EmailStatus) Decode added in v0.19.0 

func (s *EmailStatus) Decode(d *jx.Decoder) error

Decode decodes EmailStatus from json.

func (EmailStatus) Encode added in v0.19.0 

func (s EmailStatus) Encode(e *jx.Encoder)

Encode encodes EmailStatus as json.

func (EmailStatus) MarshalJSON added in v0.19.0 

func (s EmailStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (EmailStatus) MarshalText added in v0.19.0 

func (s EmailStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*EmailStatus) UnmarshalJSON added in v0.19.0 

func (s *EmailStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailStatus) UnmarshalText added in v0.19.0 

func (s *EmailStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (EmailStatus) Validate added in v0.19.0 

func (s EmailStatus) Validate() error

type EmailSummary 

type EmailSummary struct {
	ID        uuid.UUID    `json:"id"`
	MessageID OptNilString `json:"message_id"`
	DomainID  OptNilUUID   `json:"domain_id"`
	OrgID     OptNilUUID   `json:"org_id"`
	Status    EmailStatus  `json:"status"`
	// SMTP envelope sender (return-path) the inbound mail server
	// accepted. For most legitimate mail this equals the bare
	// address in the From header; for mailing lists, bounce
	// handlers, and forwarders it is typically the bounce address
	// rather than the human-visible sender.
	// For the parsed From-header value (with display name handling
	// and a sender-fallback when the header is unparseable), GET
	// the email by id and use `from_email`.
	Sender              string                   `json:"sender"`
	Recipient           string                   `json:"recipient"`
	Subject             OptNilString             `json:"subject"`
	Domain              string                   `json:"domain"`
	SpamScore           OptNilFloat64            `json:"spam_score"`
	CreatedAt           time.Time                `json:"created_at"`
	ReceivedAt          time.Time                `json:"received_at"`
	RawSizeBytes        OptNilInt                `json:"raw_size_bytes"`
	WebhookStatus       OptNilEmailWebhookStatus `json:"webhook_status"`
	WebhookAttemptCount int                      `json:"webhook_attempt_count"`
}

Ref: #/components/schemas/EmailSummary

func (*EmailSummary) Decode 

func (s *EmailSummary) Decode(d *jx.Decoder) error

Decode decodes EmailSummary from json.

func (*EmailSummary) Encode 

func (s *EmailSummary) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EmailSummary) GetCreatedAt 

func (s *EmailSummary) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*EmailSummary) GetDomain 

func (s *EmailSummary) GetDomain() string

GetDomain returns the value of Domain.

func (*EmailSummary) GetDomainID 

func (s *EmailSummary) GetDomainID() OptNilUUID

GetDomainID returns the value of DomainID.

func (*EmailSummary) GetID 

func (s *EmailSummary) GetID() uuid.UUID

GetID returns the value of ID.

func (*EmailSummary) GetMessageID 

func (s *EmailSummary) GetMessageID() OptNilString

GetMessageID returns the value of MessageID.

func (*EmailSummary) GetOrgID 

func (s *EmailSummary) GetOrgID() OptNilUUID

GetOrgID returns the value of OrgID.

func (*EmailSummary) GetRawSizeBytes 

func (s *EmailSummary) GetRawSizeBytes() OptNilInt

GetRawSizeBytes returns the value of RawSizeBytes.

func (*EmailSummary) GetReceivedAt 

func (s *EmailSummary) GetReceivedAt() time.Time

GetReceivedAt returns the value of ReceivedAt.

func (*EmailSummary) GetRecipient 

func (s *EmailSummary) GetRecipient() string

GetRecipient returns the value of Recipient.

func (*EmailSummary) GetSender 

func (s *EmailSummary) GetSender() string

GetSender returns the value of Sender.

func (*EmailSummary) GetSpamScore 

func (s *EmailSummary) GetSpamScore() OptNilFloat64

GetSpamScore returns the value of SpamScore.

func (*EmailSummary) GetStatus 

func (s *EmailSummary) GetStatus() EmailStatus

GetStatus returns the value of Status.

func (*EmailSummary) GetSubject 

func (s *EmailSummary) GetSubject() OptNilString

GetSubject returns the value of Subject.

func (*EmailSummary) GetWebhookAttemptCount 

func (s *EmailSummary) GetWebhookAttemptCount() int

GetWebhookAttemptCount returns the value of WebhookAttemptCount.

func (*EmailSummary) GetWebhookStatus 

func (s *EmailSummary) GetWebhookStatus() OptNilEmailWebhookStatus

GetWebhookStatus returns the value of WebhookStatus.

func (*EmailSummary) MarshalJSON 

func (s *EmailSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EmailSummary) SetCreatedAt 

func (s *EmailSummary) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*EmailSummary) SetDomain 

func (s *EmailSummary) SetDomain(val string)

SetDomain sets the value of Domain.

func (*EmailSummary) SetDomainID 

func (s *EmailSummary) SetDomainID(val OptNilUUID)

SetDomainID sets the value of DomainID.

func (*EmailSummary) SetID 

func (s *EmailSummary) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*EmailSummary) SetMessageID 

func (s *EmailSummary) SetMessageID(val OptNilString)

SetMessageID sets the value of MessageID.

func (*EmailSummary) SetOrgID 

func (s *EmailSummary) SetOrgID(val OptNilUUID)

SetOrgID sets the value of OrgID.

func (*EmailSummary) SetRawSizeBytes 

func (s *EmailSummary) SetRawSizeBytes(val OptNilInt)

SetRawSizeBytes sets the value of RawSizeBytes.

func (*EmailSummary) SetReceivedAt 

func (s *EmailSummary) SetReceivedAt(val time.Time)

SetReceivedAt sets the value of ReceivedAt.

func (*EmailSummary) SetRecipient 

func (s *EmailSummary) SetRecipient(val string)

SetRecipient sets the value of Recipient.

func (*EmailSummary) SetSender 

func (s *EmailSummary) SetSender(val string)

SetSender sets the value of Sender.

func (*EmailSummary) SetSpamScore 

func (s *EmailSummary) SetSpamScore(val OptNilFloat64)

SetSpamScore sets the value of SpamScore.

func (*EmailSummary) SetStatus 

func (s *EmailSummary) SetStatus(val EmailStatus)

SetStatus sets the value of Status.

func (*EmailSummary) SetSubject 

func (s *EmailSummary) SetSubject(val OptNilString)

SetSubject sets the value of Subject.

func (*EmailSummary) SetWebhookAttemptCount 

func (s *EmailSummary) SetWebhookAttemptCount(val int)

SetWebhookAttemptCount sets the value of WebhookAttemptCount.

func (*EmailSummary) SetWebhookStatus 

func (s *EmailSummary) SetWebhookStatus(val OptNilEmailWebhookStatus)

SetWebhookStatus sets the value of WebhookStatus.

func (*EmailSummary) UnmarshalJSON 

func (s *EmailSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailSummary) Validate 

func (s *EmailSummary) Validate() error

type EmailWebhookStatus added in v0.19.0 

type EmailWebhookStatus string

Webhook-delivery state for an inbound email. Tracks a SEPARATE lifecycle from the email's `status` field; the same row carries both. Possible values: - `pending`: ingestion is past `pending` (the email itself is `accepted`) but the webhook fan-out has not yet started for this row. - `in_flight`: at least one delivery attempt is in flight. - `fired`: terminal success. Every active endpoint acknowledged the delivery (or accepted it after retries). - `failed`: terminal partial-failure. At least one endpoint exhausted its retry budget; some endpoints may still have succeeded. - `exhausted`: terminal failure. Every endpoint exhausted its retry budget without success. - `null`: no endpoints configured, so no webhook lifecycle applies. Note that the value `pending` here does NOT mean the email is `pending`; it means the email is past ingestion but webhook delivery has not yet begun. Two overlapping uses of the word `pending` for distinct lifecycle phases. Ref: #/components/schemas/EmailWebhookStatus 

const (
	EmailWebhookStatusPending   EmailWebhookStatus = "pending"
	EmailWebhookStatusInFlight  EmailWebhookStatus = "in_flight"
	EmailWebhookStatusFired     EmailWebhookStatus = "fired"
	EmailWebhookStatusFailed    EmailWebhookStatus = "failed"
	EmailWebhookStatusExhausted EmailWebhookStatus = "exhausted"
)

func (EmailWebhookStatus) AllValues added in v0.19.0 

func (EmailWebhookStatus) AllValues() []EmailWebhookStatus

AllValues returns all EmailWebhookStatus values.

func (*EmailWebhookStatus) Decode added in v0.19.0 

func (s *EmailWebhookStatus) Decode(d *jx.Decoder) error

Decode decodes EmailWebhookStatus from json.

func (EmailWebhookStatus) Encode added in v0.19.0 

func (s EmailWebhookStatus) Encode(e *jx.Encoder)

Encode encodes EmailWebhookStatus as json.

func (EmailWebhookStatus) MarshalJSON added in v0.19.0 

func (s EmailWebhookStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (EmailWebhookStatus) MarshalText added in v0.19.0 

func (s EmailWebhookStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*EmailWebhookStatus) UnmarshalJSON added in v0.19.0 

func (s *EmailWebhookStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*EmailWebhookStatus) UnmarshalText added in v0.19.0 

func (s *EmailWebhookStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (EmailWebhookStatus) Validate added in v0.19.0 

func (s EmailWebhookStatus) Validate() error

type Endpoint 

type Endpoint struct {
	ID      uuid.UUID    `json:"id"`
	OrgID   uuid.UUID    `json:"org_id"`
	URL     OptNilString `json:"url"`
	Enabled bool         `json:"enabled"`
	// Restrict this endpoint to emails from a specific domain.
	DomainID OptNilUUID `json:"domain_id"`
	// Endpoint-specific filtering rules.
	Rules     EndpointRules `json:"rules"`
	CreatedAt time.Time     `json:"created_at"`
	UpdatedAt time.Time     `json:"updated_at"`
	// Total webhook deliveries attempted.
	DeliveryCount int `json:"delivery_count"`
	// Successful deliveries.
	SuccessCount int `json:"success_count"`
	// Failed deliveries.
	FailureCount int `json:"failure_count"`
	// Current streak of consecutive failures.
	ConsecutiveFails int            `json:"consecutive_fails"`
	LastDeliveryAt   OptNilDateTime `json:"last_delivery_at"`
	LastSuccessAt    OptNilDateTime `json:"last_success_at"`
	LastFailureAt    OptNilDateTime `json:"last_failure_at"`
	DeactivatedAt    OptNilDateTime `json:"deactivated_at"`
}

Ref: #/components/schemas/Endpoint

func (*Endpoint) Decode 

func (s *Endpoint) Decode(d *jx.Decoder) error

Decode decodes Endpoint from json.

func (*Endpoint) Encode 

func (s *Endpoint) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*Endpoint) GetConsecutiveFails 

func (s *Endpoint) GetConsecutiveFails() int

GetConsecutiveFails returns the value of ConsecutiveFails.

func (*Endpoint) GetCreatedAt 

func (s *Endpoint) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*Endpoint) GetDeactivatedAt 

func (s *Endpoint) GetDeactivatedAt() OptNilDateTime

GetDeactivatedAt returns the value of DeactivatedAt.

func (*Endpoint) GetDeliveryCount 

func (s *Endpoint) GetDeliveryCount() int

GetDeliveryCount returns the value of DeliveryCount.

func (*Endpoint) GetDomainID 

func (s *Endpoint) GetDomainID() OptNilUUID

GetDomainID returns the value of DomainID.

func (*Endpoint) GetEnabled 

func (s *Endpoint) GetEnabled() bool

GetEnabled returns the value of Enabled.

func (*Endpoint) GetFailureCount 

func (s *Endpoint) GetFailureCount() int

GetFailureCount returns the value of FailureCount.

func (*Endpoint) GetID 

func (s *Endpoint) GetID() uuid.UUID

GetID returns the value of ID.

func (*Endpoint) GetLastDeliveryAt 

func (s *Endpoint) GetLastDeliveryAt() OptNilDateTime

GetLastDeliveryAt returns the value of LastDeliveryAt.

func (*Endpoint) GetLastFailureAt 

func (s *Endpoint) GetLastFailureAt() OptNilDateTime

GetLastFailureAt returns the value of LastFailureAt.

func (*Endpoint) GetLastSuccessAt 

func (s *Endpoint) GetLastSuccessAt() OptNilDateTime

GetLastSuccessAt returns the value of LastSuccessAt.

func (*Endpoint) GetOrgID 

func (s *Endpoint) GetOrgID() uuid.UUID

GetOrgID returns the value of OrgID.

func (*Endpoint) GetRules 

func (s *Endpoint) GetRules() EndpointRules

GetRules returns the value of Rules.

func (*Endpoint) GetSuccessCount 

func (s *Endpoint) GetSuccessCount() int

GetSuccessCount returns the value of SuccessCount.

func (*Endpoint) GetURL 

func (s *Endpoint) GetURL() OptNilString

GetURL returns the value of URL.

func (*Endpoint) GetUpdatedAt 

func (s *Endpoint) GetUpdatedAt() time.Time

GetUpdatedAt returns the value of UpdatedAt.

func (*Endpoint) MarshalJSON 

func (s *Endpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Endpoint) SetConsecutiveFails 

func (s *Endpoint) SetConsecutiveFails(val int)

SetConsecutiveFails sets the value of ConsecutiveFails.

func (*Endpoint) SetCreatedAt 

func (s *Endpoint) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*Endpoint) SetDeactivatedAt 

func (s *Endpoint) SetDeactivatedAt(val OptNilDateTime)

SetDeactivatedAt sets the value of DeactivatedAt.

func (*Endpoint) SetDeliveryCount 

func (s *Endpoint) SetDeliveryCount(val int)

SetDeliveryCount sets the value of DeliveryCount.

func (*Endpoint) SetDomainID 

func (s *Endpoint) SetDomainID(val OptNilUUID)

SetDomainID sets the value of DomainID.

func (*Endpoint) SetEnabled 

func (s *Endpoint) SetEnabled(val bool)

SetEnabled sets the value of Enabled.

func (*Endpoint) SetFailureCount 

func (s *Endpoint) SetFailureCount(val int)

SetFailureCount sets the value of FailureCount.

func (*Endpoint) SetID 

func (s *Endpoint) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*Endpoint) SetLastDeliveryAt 

func (s *Endpoint) SetLastDeliveryAt(val OptNilDateTime)

SetLastDeliveryAt sets the value of LastDeliveryAt.

func (*Endpoint) SetLastFailureAt 

func (s *Endpoint) SetLastFailureAt(val OptNilDateTime)

SetLastFailureAt sets the value of LastFailureAt.

func (*Endpoint) SetLastSuccessAt 

func (s *Endpoint) SetLastSuccessAt(val OptNilDateTime)

SetLastSuccessAt sets the value of LastSuccessAt.

func (*Endpoint) SetOrgID 

func (s *Endpoint) SetOrgID(val uuid.UUID)

SetOrgID sets the value of OrgID.

func (*Endpoint) SetRules 

func (s *Endpoint) SetRules(val EndpointRules)

SetRules sets the value of Rules.

func (*Endpoint) SetSuccessCount 

func (s *Endpoint) SetSuccessCount(val int)

SetSuccessCount sets the value of SuccessCount.

func (*Endpoint) SetURL 

func (s *Endpoint) SetURL(val OptNilString)

SetURL sets the value of URL.

func (*Endpoint) SetUpdatedAt 

func (s *Endpoint) SetUpdatedAt(val time.Time)

SetUpdatedAt sets the value of UpdatedAt.

func (*Endpoint) UnmarshalJSON 

func (s *Endpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type EndpointRules 

type EndpointRules struct{}

Endpoint-specific filtering rules.

func (*EndpointRules) Decode 

func (s *EndpointRules) Decode(d *jx.Decoder) error

Decode decodes EndpointRules from json.

func (*EndpointRules) Encode 

func (s *EndpointRules) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*EndpointRules) MarshalJSON 

func (s *EndpointRules) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*EndpointRules) UnmarshalJSON 

func (s *EndpointRules) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type ErrorResponse 

type ErrorResponse struct {
	Success bool               `json:"success"`
	Error   ErrorResponseError `json:"error"`
}

Ref: #/components/schemas/ErrorResponse

func (*ErrorResponse) Decode 

func (s *ErrorResponse) Decode(d *jx.Decoder) error

Decode decodes ErrorResponse from json.

func (*ErrorResponse) Encode 

func (s *ErrorResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ErrorResponse) GetError 

func (s *ErrorResponse) GetError() ErrorResponseError

GetError returns the value of Error.

func (*ErrorResponse) GetSuccess 

func (s *ErrorResponse) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ErrorResponse) MarshalJSON 

func (s *ErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ErrorResponse) SetError 

func (s *ErrorResponse) SetError(val ErrorResponseError)

SetError sets the value of Error.

func (*ErrorResponse) SetSuccess 

func (s *ErrorResponse) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ErrorResponse) UnmarshalJSON 

func (s *ErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ErrorResponse) Validate 

func (s *ErrorResponse) Validate() error

type ErrorResponseError 

type ErrorResponseError struct {
	Code    ErrorResponseErrorCode `json:"code"`
	Message string                 `json:"message"`
	// Optional structured data that callers can inspect to recover
	// from the error. The fields present depend on `code`. Additional
	// keys may be added over time without a major-version bump.
	Details OptErrorResponseErrorDetails `json:"details"`
	// Structured per-gate denial detail for recipient-scope send-mail failures.
	Gates []GateDenial `json:"gates"`
	// Server-issued request identifier for support and tracing.
	RequestID OptString `json:"request_id"`
}

func (*ErrorResponseError) Decode 

func (s *ErrorResponseError) Decode(d *jx.Decoder) error

Decode decodes ErrorResponseError from json.

func (*ErrorResponseError) Encode 

func (s *ErrorResponseError) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ErrorResponseError) GetCode 

func (s *ErrorResponseError) GetCode() ErrorResponseErrorCode

GetCode returns the value of Code.

func (*ErrorResponseError) GetDetails added in v0.4.0 

func (s *ErrorResponseError) GetDetails() OptErrorResponseErrorDetails

GetDetails returns the value of Details.

func (*ErrorResponseError) GetGates added in v0.8.0 

func (s *ErrorResponseError) GetGates() []GateDenial

GetGates returns the value of Gates.

func (*ErrorResponseError) GetMessage 

func (s *ErrorResponseError) GetMessage() string

GetMessage returns the value of Message.

func (*ErrorResponseError) GetRequestID added in v0.8.0 

func (s *ErrorResponseError) GetRequestID() OptString

GetRequestID returns the value of RequestID.

func (*ErrorResponseError) MarshalJSON 

func (s *ErrorResponseError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ErrorResponseError) SetCode 

func (s *ErrorResponseError) SetCode(val ErrorResponseErrorCode)

SetCode sets the value of Code.

func (*ErrorResponseError) SetDetails added in v0.4.0 

func (s *ErrorResponseError) SetDetails(val OptErrorResponseErrorDetails)

SetDetails sets the value of Details.

func (*ErrorResponseError) SetGates added in v0.8.0 

func (s *ErrorResponseError) SetGates(val []GateDenial)

SetGates sets the value of Gates.

func (*ErrorResponseError) SetMessage 

func (s *ErrorResponseError) SetMessage(val string)

SetMessage sets the value of Message.

func (*ErrorResponseError) SetRequestID added in v0.8.0 

func (s *ErrorResponseError) SetRequestID(val OptString)

SetRequestID sets the value of RequestID.

func (*ErrorResponseError) UnmarshalJSON 

func (s *ErrorResponseError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ErrorResponseError) Validate 

func (s *ErrorResponseError) Validate() error

type ErrorResponseErrorCode 

type ErrorResponseErrorCode string
const (
	ErrorResponseErrorCodeUnauthorized              ErrorResponseErrorCode = "unauthorized"
	ErrorResponseErrorCodeForbidden                 ErrorResponseErrorCode = "forbidden"
	ErrorResponseErrorCodeNotFound                  ErrorResponseErrorCode = "not_found"
	ErrorResponseErrorCodeValidationError           ErrorResponseErrorCode = "validation_error"
	ErrorResponseErrorCodeRateLimitExceeded         ErrorResponseErrorCode = "rate_limit_exceeded"
	ErrorResponseErrorCodeInternalError             ErrorResponseErrorCode = "internal_error"
	ErrorResponseErrorCodeConflict                  ErrorResponseErrorCode = "conflict"
	ErrorResponseErrorCodeMxConflict                ErrorResponseErrorCode = "mx_conflict"
	ErrorResponseErrorCodeOutboundDisabled          ErrorResponseErrorCode = "outbound_disabled"
	ErrorResponseErrorCodeCannotSendFromDomain      ErrorResponseErrorCode = "cannot_send_from_domain"
	ErrorResponseErrorCodeRecipientNotAllowed       ErrorResponseErrorCode = "recipient_not_allowed"
	ErrorResponseErrorCodeOutboundKeyMissing        ErrorResponseErrorCode = "outbound_key_missing"
	ErrorResponseErrorCodeOutboundUnreachable       ErrorResponseErrorCode = "outbound_unreachable"
	ErrorResponseErrorCodeOutboundKeyInvalid        ErrorResponseErrorCode = "outbound_key_invalid"
	ErrorResponseErrorCodeOutboundCapacityExhausted ErrorResponseErrorCode = "outbound_capacity_exhausted"
	ErrorResponseErrorCodeOutboundResponseMalformed ErrorResponseErrorCode = "outbound_response_malformed"
	ErrorResponseErrorCodeOutboundRelayFailed       ErrorResponseErrorCode = "outbound_relay_failed"
	ErrorResponseErrorCodeDiscardNotEnabled         ErrorResponseErrorCode = "discard_not_enabled"
	ErrorResponseErrorCodeInboundNotRepliable       ErrorResponseErrorCode = "inbound_not_repliable"
	ErrorResponseErrorCodeSearchTimeout             ErrorResponseErrorCode = "search_timeout"
	ErrorResponseErrorCodeAuthorizationPending      ErrorResponseErrorCode = "authorization_pending"
	ErrorResponseErrorCodeSlowDown                  ErrorResponseErrorCode = "slow_down"
	ErrorResponseErrorCodeAccessDenied              ErrorResponseErrorCode = "access_denied"
	ErrorResponseErrorCodeExpiredToken              ErrorResponseErrorCode = "expired_token"
	ErrorResponseErrorCodeInvalidDeviceCode         ErrorResponseErrorCode = "invalid_device_code"
	ErrorResponseErrorCodeInvalidSignupCode         ErrorResponseErrorCode = "invalid_signup_code"
	ErrorResponseErrorCodeInvalidSignupToken        ErrorResponseErrorCode = "invalid_signup_token"
	ErrorResponseErrorCodeInvalidVerificationCode   ErrorResponseErrorCode = "invalid_verification_code"
	ErrorResponseErrorCodeEmailDeliveryFailed       ErrorResponseErrorCode = "email_delivery_failed"
	ErrorResponseErrorCodeClerkSignupFailed         ErrorResponseErrorCode = "clerk_signup_failed"
	ErrorResponseErrorCodeNoOrgsForUser             ErrorResponseErrorCode = "no_orgs_for_user"
	ErrorResponseErrorCodeOrgNotAccessible          ErrorResponseErrorCode = "org_not_accessible"
)

func (ErrorResponseErrorCode) AllValues 

func (ErrorResponseErrorCode) AllValues() []ErrorResponseErrorCode

AllValues returns all ErrorResponseErrorCode values.

func (*ErrorResponseErrorCode) Decode 

func (s *ErrorResponseErrorCode) Decode(d *jx.Decoder) error

Decode decodes ErrorResponseErrorCode from json.

func (ErrorResponseErrorCode) Encode 

func (s ErrorResponseErrorCode) Encode(e *jx.Encoder)

Encode encodes ErrorResponseErrorCode as json.

func (ErrorResponseErrorCode) MarshalJSON 

func (s ErrorResponseErrorCode) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (ErrorResponseErrorCode) MarshalText 

func (s ErrorResponseErrorCode) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*ErrorResponseErrorCode) UnmarshalJSON 

func (s *ErrorResponseErrorCode) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ErrorResponseErrorCode) UnmarshalText 

func (s *ErrorResponseErrorCode) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (ErrorResponseErrorCode) Validate 

func (s ErrorResponseErrorCode) Validate() error

type ErrorResponseErrorDetails added in v0.4.0 

type ErrorResponseErrorDetails struct {
	// Present when `code == mx_conflict`.
	MxConflict OptErrorResponseErrorDetailsMxConflict `json:"mx_conflict"`
	// Entitlements that would allow a denied send when no recipient-scope gate was granted.
	RequiredEntitlements []string `json:"required_entitlements"`
	// ID of the persisted sent-email attempt associated with the error.
	SentEmailID OptString `json:"sent_email_id"`
	// Content hash of the original request on idempotency cache-hit errors.
	ContentHash OptString `json:"content_hash"`
	// Effective idempotency key associated with the original request.
	ClientIdempotencyKey OptString `json:"client_idempotency_key"`
	AdditionalProps      ErrorResponseErrorDetailsAdditional
}

Optional structured data that callers can inspect to recover from the error. The fields present depend on `code`. Additional keys may be added over time without a major-version bump.

func (*ErrorResponseErrorDetails) Decode added in v0.4.0 

func (s *ErrorResponseErrorDetails) Decode(d *jx.Decoder) error

Decode decodes ErrorResponseErrorDetails from json.

func (*ErrorResponseErrorDetails) Encode added in v0.4.0 

func (s *ErrorResponseErrorDetails) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ErrorResponseErrorDetails) GetAdditionalProps added in v0.4.0 

func (s *ErrorResponseErrorDetails) GetAdditionalProps() ErrorResponseErrorDetailsAdditional

GetAdditionalProps returns the value of AdditionalProps.

func (*ErrorResponseErrorDetails) GetClientIdempotencyKey added in v0.8.0 

func (s *ErrorResponseErrorDetails) GetClientIdempotencyKey() OptString

GetClientIdempotencyKey returns the value of ClientIdempotencyKey.

func (*ErrorResponseErrorDetails) GetContentHash added in v0.8.0 

func (s *ErrorResponseErrorDetails) GetContentHash() OptString

GetContentHash returns the value of ContentHash.

func (*ErrorResponseErrorDetails) GetMxConflict added in v0.4.0 

func (s *ErrorResponseErrorDetails) GetMxConflict() OptErrorResponseErrorDetailsMxConflict

GetMxConflict returns the value of MxConflict.

func (*ErrorResponseErrorDetails) GetRequiredEntitlements added in v0.8.0 

func (s *ErrorResponseErrorDetails) GetRequiredEntitlements() []string

GetRequiredEntitlements returns the value of RequiredEntitlements.

func (*ErrorResponseErrorDetails) GetSentEmailID added in v0.8.0 

func (s *ErrorResponseErrorDetails) GetSentEmailID() OptString

GetSentEmailID returns the value of SentEmailID.

func (*ErrorResponseErrorDetails) MarshalJSON added in v0.4.0 

func (s *ErrorResponseErrorDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ErrorResponseErrorDetails) SetAdditionalProps added in v0.4.0 

func (s *ErrorResponseErrorDetails) SetAdditionalProps(val ErrorResponseErrorDetailsAdditional)

SetAdditionalProps sets the value of AdditionalProps.

func (*ErrorResponseErrorDetails) SetClientIdempotencyKey added in v0.8.0 

func (s *ErrorResponseErrorDetails) SetClientIdempotencyKey(val OptString)

SetClientIdempotencyKey sets the value of ClientIdempotencyKey.

func (*ErrorResponseErrorDetails) SetContentHash added in v0.8.0 

func (s *ErrorResponseErrorDetails) SetContentHash(val OptString)

SetContentHash sets the value of ContentHash.

func (*ErrorResponseErrorDetails) SetMxConflict added in v0.4.0 

func (s *ErrorResponseErrorDetails) SetMxConflict(val OptErrorResponseErrorDetailsMxConflict)

SetMxConflict sets the value of MxConflict.

func (*ErrorResponseErrorDetails) SetRequiredEntitlements added in v0.8.0 

func (s *ErrorResponseErrorDetails) SetRequiredEntitlements(val []string)

SetRequiredEntitlements sets the value of RequiredEntitlements.

func (*ErrorResponseErrorDetails) SetSentEmailID added in v0.8.0 

func (s *ErrorResponseErrorDetails) SetSentEmailID(val OptString)

SetSentEmailID sets the value of SentEmailID.

func (*ErrorResponseErrorDetails) UnmarshalJSON added in v0.4.0 

func (s *ErrorResponseErrorDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorResponseErrorDetailsAdditional added in v0.4.0 

type ErrorResponseErrorDetailsAdditional map[string]jx.Raw

func (*ErrorResponseErrorDetailsAdditional) Decode added in v0.4.0 

func (s *ErrorResponseErrorDetailsAdditional) Decode(d *jx.Decoder) error

Decode decodes ErrorResponseErrorDetailsAdditional from json.

func (ErrorResponseErrorDetailsAdditional) Encode added in v0.4.0 

func (s ErrorResponseErrorDetailsAdditional) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (ErrorResponseErrorDetailsAdditional) MarshalJSON added in v0.4.0 

func (s ErrorResponseErrorDetailsAdditional) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ErrorResponseErrorDetailsAdditional) UnmarshalJSON added in v0.4.0 

func (s *ErrorResponseErrorDetailsAdditional) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorResponseErrorDetailsMxConflict added in v0.4.0 

type ErrorResponseErrorDetailsMxConflict struct {
	// Human-readable name of the detected mailbox provider (e.g. "Google Workspace").
	ProviderName string `json:"provider_name"`
	// Subdomain to try instead (e.g. "mail" for `mail.example.com`).
	SuggestedSubdomain string `json:"suggested_subdomain"`
}

Present when `code == mx_conflict`.

func (*ErrorResponseErrorDetailsMxConflict) Decode added in v0.4.0 

func (s *ErrorResponseErrorDetailsMxConflict) Decode(d *jx.Decoder) error

Decode decodes ErrorResponseErrorDetailsMxConflict from json.

func (*ErrorResponseErrorDetailsMxConflict) Encode added in v0.4.0 

func (s *ErrorResponseErrorDetailsMxConflict) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ErrorResponseErrorDetailsMxConflict) GetProviderName added in v0.4.0 

func (s *ErrorResponseErrorDetailsMxConflict) GetProviderName() string

GetProviderName returns the value of ProviderName.

func (*ErrorResponseErrorDetailsMxConflict) GetSuggestedSubdomain added in v0.4.0 

func (s *ErrorResponseErrorDetailsMxConflict) GetSuggestedSubdomain() string

GetSuggestedSubdomain returns the value of SuggestedSubdomain.

func (*ErrorResponseErrorDetailsMxConflict) MarshalJSON added in v0.4.0 

func (s *ErrorResponseErrorDetailsMxConflict) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ErrorResponseErrorDetailsMxConflict) SetProviderName added in v0.4.0 

func (s *ErrorResponseErrorDetailsMxConflict) SetProviderName(val string)

SetProviderName sets the value of ProviderName.

func (*ErrorResponseErrorDetailsMxConflict) SetSuggestedSubdomain added in v0.4.0 

func (s *ErrorResponseErrorDetailsMxConflict) SetSuggestedSubdomain(val string)

SetSuggestedSubdomain sets the value of SuggestedSubdomain.

func (*ErrorResponseErrorDetailsMxConflict) UnmarshalJSON added in v0.4.0 

func (s *ErrorResponseErrorDetailsMxConflict) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ErrorResponseHeaders added in v0.19.0 

type ErrorResponseHeaders struct {
	RetryAfter OptInt
	Response   ErrorResponse
}

ErrorResponseHeaders wraps ErrorResponse with response headers.

func (*ErrorResponseHeaders) GetResponse added in v0.19.0 

func (s *ErrorResponseHeaders) GetResponse() ErrorResponse

GetResponse returns the value of Response.

func (*ErrorResponseHeaders) GetRetryAfter added in v0.19.0 

func (s *ErrorResponseHeaders) GetRetryAfter() OptInt

GetRetryAfter returns the value of RetryAfter.

func (*ErrorResponseHeaders) SetResponse added in v0.19.0 

func (s *ErrorResponseHeaders) SetResponse(val ErrorResponse)

SetResponse sets the value of Response.

func (*ErrorResponseHeaders) SetRetryAfter added in v0.19.0 

func (s *ErrorResponseHeaders) SetRetryAfter(val OptInt)

SetRetryAfter sets the value of RetryAfter.

func (*ErrorResponseHeaders) Validate added in v0.19.0 

func (s *ErrorResponseHeaders) Validate() error

type Filter 

type Filter struct {
	ID    uuid.UUID `json:"id"`
	OrgID uuid.UUID `json:"org_id"`
	// If set, filter applies only to this domain.
	DomainID OptNilUUID `json:"domain_id"`
	Type     FilterType `json:"type"`
	// Email address or pattern to match (stored lowercase).
	Pattern   string    `json:"pattern"`
	Enabled   bool      `json:"enabled"`
	CreatedAt time.Time `json:"created_at"`
}

Ref: #/components/schemas/Filter

func (*Filter) Decode 

func (s *Filter) Decode(d *jx.Decoder) error

Decode decodes Filter from json.

func (*Filter) Encode 

func (s *Filter) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*Filter) GetCreatedAt 

func (s *Filter) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*Filter) GetDomainID 

func (s *Filter) GetDomainID() OptNilUUID

GetDomainID returns the value of DomainID.

func (*Filter) GetEnabled 

func (s *Filter) GetEnabled() bool

GetEnabled returns the value of Enabled.

func (*Filter) GetID 

func (s *Filter) GetID() uuid.UUID

GetID returns the value of ID.

func (*Filter) GetOrgID 

func (s *Filter) GetOrgID() uuid.UUID

GetOrgID returns the value of OrgID.

func (*Filter) GetPattern 

func (s *Filter) GetPattern() string

GetPattern returns the value of Pattern.

func (*Filter) GetType 

func (s *Filter) GetType() FilterType

GetType returns the value of Type.

func (*Filter) MarshalJSON 

func (s *Filter) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Filter) SetCreatedAt 

func (s *Filter) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*Filter) SetDomainID 

func (s *Filter) SetDomainID(val OptNilUUID)

SetDomainID sets the value of DomainID.

func (*Filter) SetEnabled 

func (s *Filter) SetEnabled(val bool)

SetEnabled sets the value of Enabled.

func (*Filter) SetID 

func (s *Filter) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*Filter) SetOrgID 

func (s *Filter) SetOrgID(val uuid.UUID)

SetOrgID sets the value of OrgID.

func (*Filter) SetPattern 

func (s *Filter) SetPattern(val string)

SetPattern sets the value of Pattern.

func (*Filter) SetType 

func (s *Filter) SetType(val FilterType)

SetType sets the value of Type.

func (*Filter) UnmarshalJSON 

func (s *Filter) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Filter) Validate 

func (s *Filter) Validate() error

type FilterType 

type FilterType string
const (
	FilterTypeWhitelist FilterType = "whitelist"
	FilterTypeBlocklist FilterType = "blocklist"
)

func (FilterType) AllValues 

func (FilterType) AllValues() []FilterType

AllValues returns all FilterType values.

func (*FilterType) Decode 

func (s *FilterType) Decode(d *jx.Decoder) error

Decode decodes FilterType from json.

func (FilterType) Encode 

func (s FilterType) Encode(e *jx.Encoder)

Encode encodes FilterType as json.

func (FilterType) MarshalJSON 

func (s FilterType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (FilterType) MarshalText 

func (s FilterType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*FilterType) UnmarshalJSON 

func (s *FilterType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FilterType) UnmarshalText 

func (s *FilterType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (FilterType) Validate 

func (s FilterType) Validate() error

type FunctionDeployStatus added in v0.20.0 

type FunctionDeployStatus string

Lifecycle state of the latest deploy attempt: * `pending` — deploy in flight; the runtime has not yet confirmed the new bundle is live. * `deployed` — the running edge handler is the latest code. * `failed` — the most recent deploy attempt failed; the previously-live code (if any) is still running. The `deploy_error` field carries the error message. Ref: #/components/schemas/FunctionDeployStatus 

const (
	FunctionDeployStatusPending  FunctionDeployStatus = "pending"
	FunctionDeployStatusDeployed FunctionDeployStatus = "deployed"
	FunctionDeployStatusFailed   FunctionDeployStatus = "failed"
)

func (FunctionDeployStatus) AllValues added in v0.20.0 

func (FunctionDeployStatus) AllValues() []FunctionDeployStatus

AllValues returns all FunctionDeployStatus values.

func (*FunctionDeployStatus) Decode added in v0.20.0 

func (s *FunctionDeployStatus) Decode(d *jx.Decoder) error

Decode decodes FunctionDeployStatus from json.

func (FunctionDeployStatus) Encode added in v0.20.0 

func (s FunctionDeployStatus) Encode(e *jx.Encoder)

Encode encodes FunctionDeployStatus as json.

func (FunctionDeployStatus) MarshalJSON added in v0.20.0 

func (s FunctionDeployStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (FunctionDeployStatus) MarshalText added in v0.20.0 

func (s FunctionDeployStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*FunctionDeployStatus) UnmarshalJSON added in v0.20.0 

func (s *FunctionDeployStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionDeployStatus) UnmarshalText added in v0.20.0 

func (s *FunctionDeployStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (FunctionDeployStatus) Validate added in v0.20.0 

func (s FunctionDeployStatus) Validate() error

type FunctionDetail added in v0.20.0 

type FunctionDetail struct {
	ID   uuid.UUID `json:"id"`
	Name string    `json:"name"`
	// The bundled handler source. UTF-8 string up to 1 MiB. The
	// same value most recently passed as `code` to POST or PUT.
	Code         string               `json:"code"`
	DeployStatus FunctionDeployStatus `json:"deploy_status"`
	// Error message from the most recent failed deploy, or null
	// after a successful deploy. Surface this to users to explain
	// a `failed` status without polling.
	DeployError OptNilString   `json:"deploy_error"`
	DeployedAt  OptNilDateTime `json:"deployed_at"`
	CreatedAt   time.Time      `json:"created_at"`
	UpdatedAt   time.Time      `json:"updated_at"`
}

Full function record returned by GET / PUT. Ref: #/components/schemas/FunctionDetail

func (*FunctionDetail) Decode added in v0.20.0 

func (s *FunctionDetail) Decode(d *jx.Decoder) error

Decode decodes FunctionDetail from json.

func (*FunctionDetail) Encode added in v0.20.0 

func (s *FunctionDetail) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionDetail) GetCode added in v0.20.0 

func (s *FunctionDetail) GetCode() string

GetCode returns the value of Code.

func (*FunctionDetail) GetCreatedAt added in v0.20.0 

func (s *FunctionDetail) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*FunctionDetail) GetDeployError added in v0.20.0 

func (s *FunctionDetail) GetDeployError() OptNilString

GetDeployError returns the value of DeployError.

func (*FunctionDetail) GetDeployStatus added in v0.20.0 

func (s *FunctionDetail) GetDeployStatus() FunctionDeployStatus

GetDeployStatus returns the value of DeployStatus.

func (*FunctionDetail) GetDeployedAt added in v0.20.0 

func (s *FunctionDetail) GetDeployedAt() OptNilDateTime

GetDeployedAt returns the value of DeployedAt.

func (*FunctionDetail) GetID added in v0.20.0 

func (s *FunctionDetail) GetID() uuid.UUID

GetID returns the value of ID.

func (*FunctionDetail) GetName added in v0.20.0 

func (s *FunctionDetail) GetName() string

GetName returns the value of Name.

func (*FunctionDetail) GetUpdatedAt added in v0.20.0 

func (s *FunctionDetail) GetUpdatedAt() time.Time

GetUpdatedAt returns the value of UpdatedAt.

func (*FunctionDetail) MarshalJSON added in v0.20.0 

func (s *FunctionDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionDetail) SetCode added in v0.20.0 

func (s *FunctionDetail) SetCode(val string)

SetCode sets the value of Code.

func (*FunctionDetail) SetCreatedAt added in v0.20.0 

func (s *FunctionDetail) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*FunctionDetail) SetDeployError added in v0.20.0 

func (s *FunctionDetail) SetDeployError(val OptNilString)

SetDeployError sets the value of DeployError.

func (*FunctionDetail) SetDeployStatus added in v0.20.0 

func (s *FunctionDetail) SetDeployStatus(val FunctionDeployStatus)

SetDeployStatus sets the value of DeployStatus.

func (*FunctionDetail) SetDeployedAt added in v0.20.0 

func (s *FunctionDetail) SetDeployedAt(val OptNilDateTime)

SetDeployedAt sets the value of DeployedAt.

func (*FunctionDetail) SetID added in v0.20.0 

func (s *FunctionDetail) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*FunctionDetail) SetName added in v0.20.0 

func (s *FunctionDetail) SetName(val string)

SetName sets the value of Name.

func (*FunctionDetail) SetUpdatedAt added in v0.20.0 

func (s *FunctionDetail) SetUpdatedAt(val time.Time)

SetUpdatedAt sets the value of UpdatedAt.

func (*FunctionDetail) UnmarshalJSON added in v0.20.0 

func (s *FunctionDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionDetail) Validate added in v0.20.0 

func (s *FunctionDetail) Validate() error

type FunctionListItem added in v0.20.0 

type FunctionListItem struct {
	// Function id, also the script name in the edge runtime.
	ID uuid.UUID `json:"id"`
	// Slug-style name set on creation. Stable; cannot be changed.
	Name         string               `json:"name"`
	DeployStatus FunctionDeployStatus `json:"deploy_status"`
	// Timestamp of the most recent successful deploy. Null until the first deploy succeeds.
	DeployedAt OptNilDateTime `json:"deployed_at"`
	CreatedAt  time.Time      `json:"created_at"`
	UpdatedAt  time.Time      `json:"updated_at"`
}

One row from the function listing. Ref: #/components/schemas/FunctionListItem

func (*FunctionListItem) Decode added in v0.20.0 

func (s *FunctionListItem) Decode(d *jx.Decoder) error

Decode decodes FunctionListItem from json.

func (*FunctionListItem) Encode added in v0.20.0 

func (s *FunctionListItem) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionListItem) GetCreatedAt added in v0.20.0 

func (s *FunctionListItem) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*FunctionListItem) GetDeployStatus added in v0.20.0 

func (s *FunctionListItem) GetDeployStatus() FunctionDeployStatus

GetDeployStatus returns the value of DeployStatus.

func (*FunctionListItem) GetDeployedAt added in v0.20.0 

func (s *FunctionListItem) GetDeployedAt() OptNilDateTime

GetDeployedAt returns the value of DeployedAt.

func (*FunctionListItem) GetID added in v0.20.0 

func (s *FunctionListItem) GetID() uuid.UUID

GetID returns the value of ID.

func (*FunctionListItem) GetName added in v0.20.0 

func (s *FunctionListItem) GetName() string

GetName returns the value of Name.

func (*FunctionListItem) GetUpdatedAt added in v0.20.0 

func (s *FunctionListItem) GetUpdatedAt() time.Time

GetUpdatedAt returns the value of UpdatedAt.

func (*FunctionListItem) MarshalJSON added in v0.20.0 

func (s *FunctionListItem) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionListItem) SetCreatedAt added in v0.20.0 

func (s *FunctionListItem) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*FunctionListItem) SetDeployStatus added in v0.20.0 

func (s *FunctionListItem) SetDeployStatus(val FunctionDeployStatus)

SetDeployStatus sets the value of DeployStatus.

func (*FunctionListItem) SetDeployedAt added in v0.20.0 

func (s *FunctionListItem) SetDeployedAt(val OptNilDateTime)

SetDeployedAt sets the value of DeployedAt.

func (*FunctionListItem) SetID added in v0.20.0 

func (s *FunctionListItem) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*FunctionListItem) SetName added in v0.20.0 

func (s *FunctionListItem) SetName(val string)

SetName sets the value of Name.

func (*FunctionListItem) SetUpdatedAt added in v0.20.0 

func (s *FunctionListItem) SetUpdatedAt(val time.Time)

SetUpdatedAt sets the value of UpdatedAt.

func (*FunctionListItem) UnmarshalJSON added in v0.20.0 

func (s *FunctionListItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionListItem) Validate added in v0.20.0 

func (s *FunctionListItem) Validate() error

type FunctionLogRow added in v0.26.0 

type FunctionLogRow struct {
	// Unique log row id (stable across pages).
	ID uuid.UUID `json:"id"`
	// The function this log row belongs to.
	FunctionID uuid.UUID `json:"function_id"`
	// Severity. `log` is the runtime's default for unannotated
	// `console.log` calls; the other levels match standard
	// `console.*` methods.
	Level FunctionLogRowLevel `json:"level"`
	// The textual message body. The runtime stringifies non-string
	// arguments before persisting, so this is always a plain
	// string.
	Message string `json:"message"`
	// When the handler emitted this line. Newest-first ordering
	// on this column drives pagination; clock is the runtime's,
	// not the gateway's.
	Ts time.Time `json:"ts"`
	// Optional structured payload the runtime attaches alongside
	// the message (e.g. extra args passed to `console.log`).
	// Shape is opaque; treat keys as untyped.
	Metadata OptNilFunctionLogRowMetadata `json:"metadata"`
}

One row from GET /functions/{id}/logs. Represents a single captured log line emitted by the running handler (e.g. via `console.log` / `console.error`). Ref: #/components/schemas/FunctionLogRow

func (*FunctionLogRow) Decode added in v0.26.0 

func (s *FunctionLogRow) Decode(d *jx.Decoder) error

Decode decodes FunctionLogRow from json.

func (*FunctionLogRow) Encode added in v0.26.0 

func (s *FunctionLogRow) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionLogRow) GetFunctionID added in v0.26.0 

func (s *FunctionLogRow) GetFunctionID() uuid.UUID

GetFunctionID returns the value of FunctionID.

func (*FunctionLogRow) GetID added in v0.26.0 

func (s *FunctionLogRow) GetID() uuid.UUID

GetID returns the value of ID.

func (*FunctionLogRow) GetLevel added in v0.26.0 

func (s *FunctionLogRow) GetLevel() FunctionLogRowLevel

GetLevel returns the value of Level.

func (*FunctionLogRow) GetMessage added in v0.26.0 

func (s *FunctionLogRow) GetMessage() string

GetMessage returns the value of Message.

func (*FunctionLogRow) GetMetadata added in v0.26.0 

func (s *FunctionLogRow) GetMetadata() OptNilFunctionLogRowMetadata

GetMetadata returns the value of Metadata.

func (*FunctionLogRow) GetTs added in v0.26.0 

func (s *FunctionLogRow) GetTs() time.Time

GetTs returns the value of Ts.

func (*FunctionLogRow) MarshalJSON added in v0.26.0 

func (s *FunctionLogRow) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionLogRow) SetFunctionID added in v0.26.0 

func (s *FunctionLogRow) SetFunctionID(val uuid.UUID)

SetFunctionID sets the value of FunctionID.

func (*FunctionLogRow) SetID added in v0.26.0 

func (s *FunctionLogRow) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*FunctionLogRow) SetLevel added in v0.26.0 

func (s *FunctionLogRow) SetLevel(val FunctionLogRowLevel)

SetLevel sets the value of Level.

func (*FunctionLogRow) SetMessage added in v0.26.0 

func (s *FunctionLogRow) SetMessage(val string)

SetMessage sets the value of Message.

func (*FunctionLogRow) SetMetadata added in v0.26.0 

func (s *FunctionLogRow) SetMetadata(val OptNilFunctionLogRowMetadata)

SetMetadata sets the value of Metadata.

func (*FunctionLogRow) SetTs added in v0.26.0 

func (s *FunctionLogRow) SetTs(val time.Time)

SetTs sets the value of Ts.

func (*FunctionLogRow) UnmarshalJSON added in v0.26.0 

func (s *FunctionLogRow) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionLogRow) Validate added in v0.26.0 

func (s *FunctionLogRow) Validate() error

type FunctionLogRowLevel added in v0.26.0 

type FunctionLogRowLevel string

Severity. `log` is the runtime's default for unannotated `console.log` calls; the other levels match standard `console.*` methods. 

const (
	FunctionLogRowLevelDebug FunctionLogRowLevel = "debug"
	FunctionLogRowLevelLog   FunctionLogRowLevel = "log"
	FunctionLogRowLevelInfo  FunctionLogRowLevel = "info"
	FunctionLogRowLevelWarn  FunctionLogRowLevel = "warn"
	FunctionLogRowLevelError FunctionLogRowLevel = "error"
)

func (FunctionLogRowLevel) AllValues added in v0.26.0 

func (FunctionLogRowLevel) AllValues() []FunctionLogRowLevel

AllValues returns all FunctionLogRowLevel values.

func (*FunctionLogRowLevel) Decode added in v0.26.0 

func (s *FunctionLogRowLevel) Decode(d *jx.Decoder) error

Decode decodes FunctionLogRowLevel from json.

func (FunctionLogRowLevel) Encode added in v0.26.0 

func (s FunctionLogRowLevel) Encode(e *jx.Encoder)

Encode encodes FunctionLogRowLevel as json.

func (FunctionLogRowLevel) MarshalJSON added in v0.26.0 

func (s FunctionLogRowLevel) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (FunctionLogRowLevel) MarshalText added in v0.26.0 

func (s FunctionLogRowLevel) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*FunctionLogRowLevel) UnmarshalJSON added in v0.26.0 

func (s *FunctionLogRowLevel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionLogRowLevel) UnmarshalText added in v0.26.0 

func (s *FunctionLogRowLevel) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (FunctionLogRowLevel) Validate added in v0.26.0 

func (s FunctionLogRowLevel) Validate() error

type FunctionLogRowMetadata added in v0.26.0 

type FunctionLogRowMetadata map[string]jx.Raw

Optional structured payload the runtime attaches alongside the message (e.g. extra args passed to `console.log`). Shape is opaque; treat keys as untyped.

func (*FunctionLogRowMetadata) Decode added in v0.26.0 

func (s *FunctionLogRowMetadata) Decode(d *jx.Decoder) error

Decode decodes FunctionLogRowMetadata from json.

func (FunctionLogRowMetadata) Encode added in v0.26.0 

func (s FunctionLogRowMetadata) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (FunctionLogRowMetadata) MarshalJSON added in v0.26.0 

func (s FunctionLogRowMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionLogRowMetadata) UnmarshalJSON added in v0.26.0 

func (s *FunctionLogRowMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type FunctionSecretListItem added in v0.20.0 

type FunctionSecretListItem struct {
	Key string `json:"key"`
	// True for managed system secrets, false for user-set entries.
	Managed bool `json:"managed"`
	// Set on managed entries only; null on user-set entries.
	Description OptNilString `json:"description"`
	// Set on user-set entries only; null on managed entries.
	CreatedAt OptNilDateTime `json:"created_at"`
	// Set on user-set entries only; null on managed entries.
	UpdatedAt OptNilDateTime `json:"updated_at"`
}

One row from GET /functions/{id}/secrets. Discriminate on the `managed` field: * `managed = true` — system secret provisioned by Primitive. `description` is set; `created_at` / `updated_at` are null because the row is virtual (resolved at deploy time from the managed registry, not stored in the secrets table). * `managed = false` — secret the user set via the API. `created_at` / `updated_at` are set; `description` is null. Ref: #/components/schemas/FunctionSecretListItem

func (*FunctionSecretListItem) Decode added in v0.20.0 

func (s *FunctionSecretListItem) Decode(d *jx.Decoder) error

Decode decodes FunctionSecretListItem from json.

func (*FunctionSecretListItem) Encode added in v0.20.0 

func (s *FunctionSecretListItem) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionSecretListItem) GetCreatedAt added in v0.20.0 

func (s *FunctionSecretListItem) GetCreatedAt() OptNilDateTime

GetCreatedAt returns the value of CreatedAt.

func (*FunctionSecretListItem) GetDescription added in v0.20.0 

func (s *FunctionSecretListItem) GetDescription() OptNilString

GetDescription returns the value of Description.

func (*FunctionSecretListItem) GetKey added in v0.20.0 

func (s *FunctionSecretListItem) GetKey() string

GetKey returns the value of Key.

func (*FunctionSecretListItem) GetManaged added in v0.20.0 

func (s *FunctionSecretListItem) GetManaged() bool

GetManaged returns the value of Managed.

func (*FunctionSecretListItem) GetUpdatedAt added in v0.20.0 

func (s *FunctionSecretListItem) GetUpdatedAt() OptNilDateTime

GetUpdatedAt returns the value of UpdatedAt.

func (*FunctionSecretListItem) MarshalJSON added in v0.20.0 

func (s *FunctionSecretListItem) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionSecretListItem) SetCreatedAt added in v0.20.0 

func (s *FunctionSecretListItem) SetCreatedAt(val OptNilDateTime)

SetCreatedAt sets the value of CreatedAt.

func (*FunctionSecretListItem) SetDescription added in v0.20.0 

func (s *FunctionSecretListItem) SetDescription(val OptNilString)

SetDescription sets the value of Description.

func (*FunctionSecretListItem) SetKey added in v0.20.0 

func (s *FunctionSecretListItem) SetKey(val string)

SetKey sets the value of Key.

func (*FunctionSecretListItem) SetManaged added in v0.20.0 

func (s *FunctionSecretListItem) SetManaged(val bool)

SetManaged sets the value of Managed.

func (*FunctionSecretListItem) SetUpdatedAt added in v0.20.0 

func (s *FunctionSecretListItem) SetUpdatedAt(val OptNilDateTime)

SetUpdatedAt sets the value of UpdatedAt.

func (*FunctionSecretListItem) UnmarshalJSON added in v0.20.0 

func (s *FunctionSecretListItem) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type FunctionSecretWriteResult added in v0.20.0 

type FunctionSecretWriteResult struct {
	Key       string    `json:"key"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
	// True if this call inserted a new row, false if it updated an existing one.
	Created bool `json:"created"`
}

Returned by POST and PUT secret routes. Ref: #/components/schemas/FunctionSecretWriteResult

func (*FunctionSecretWriteResult) Decode added in v0.20.0 

func (s *FunctionSecretWriteResult) Decode(d *jx.Decoder) error

Decode decodes FunctionSecretWriteResult from json.

func (*FunctionSecretWriteResult) Encode added in v0.20.0 

func (s *FunctionSecretWriteResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionSecretWriteResult) GetCreated added in v0.20.0 

func (s *FunctionSecretWriteResult) GetCreated() bool

GetCreated returns the value of Created.

func (*FunctionSecretWriteResult) GetCreatedAt added in v0.20.0 

func (s *FunctionSecretWriteResult) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*FunctionSecretWriteResult) GetKey added in v0.20.0 

func (s *FunctionSecretWriteResult) GetKey() string

GetKey returns the value of Key.

func (*FunctionSecretWriteResult) GetUpdatedAt added in v0.20.0 

func (s *FunctionSecretWriteResult) GetUpdatedAt() time.Time

GetUpdatedAt returns the value of UpdatedAt.

func (*FunctionSecretWriteResult) MarshalJSON added in v0.20.0 

func (s *FunctionSecretWriteResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionSecretWriteResult) SetCreated added in v0.20.0 

func (s *FunctionSecretWriteResult) SetCreated(val bool)

SetCreated sets the value of Created.

func (*FunctionSecretWriteResult) SetCreatedAt added in v0.20.0 

func (s *FunctionSecretWriteResult) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*FunctionSecretWriteResult) SetKey added in v0.20.0 

func (s *FunctionSecretWriteResult) SetKey(val string)

SetKey sets the value of Key.

func (*FunctionSecretWriteResult) SetUpdatedAt added in v0.20.0 

func (s *FunctionSecretWriteResult) SetUpdatedAt(val time.Time)

SetUpdatedAt sets the value of UpdatedAt.

func (*FunctionSecretWriteResult) UnmarshalJSON added in v0.20.0 

func (s *FunctionSecretWriteResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type FunctionTestRun added in v0.29.0 

type FunctionTestRun struct {
	ID            uuid.UUID   `json:"id"`
	FunctionID    uuid.UUID   `json:"function_id"`
	InboundDomain string      `json:"inbound_domain"`
	To            string      `json:"to"`
	From          string      `json:"from"`
	Subject       string      `json:"subject"`
	PollSince     time.Time   `json:"poll_since"`
	CreatedAt     time.Time   `json:"created_at"`
	SentAt        NilDateTime `json:"sent_at"`
	SendError     NilString   `json:"send_error"`
}

Ref: #/components/schemas/FunctionTestRun

func (*FunctionTestRun) Decode added in v0.29.0 

func (s *FunctionTestRun) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRun from json.

func (*FunctionTestRun) Encode added in v0.29.0 

func (s *FunctionTestRun) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionTestRun) GetCreatedAt added in v0.29.0 

func (s *FunctionTestRun) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*FunctionTestRun) GetFrom added in v0.29.0 

func (s *FunctionTestRun) GetFrom() string

GetFrom returns the value of From.

func (*FunctionTestRun) GetFunctionID added in v0.29.0 

func (s *FunctionTestRun) GetFunctionID() uuid.UUID

GetFunctionID returns the value of FunctionID.

func (*FunctionTestRun) GetID added in v0.29.0 

func (s *FunctionTestRun) GetID() uuid.UUID

GetID returns the value of ID.

func (*FunctionTestRun) GetInboundDomain added in v0.29.0 

func (s *FunctionTestRun) GetInboundDomain() string

GetInboundDomain returns the value of InboundDomain.

func (*FunctionTestRun) GetPollSince added in v0.29.0 

func (s *FunctionTestRun) GetPollSince() time.Time

GetPollSince returns the value of PollSince.

func (*FunctionTestRun) GetSendError added in v0.29.0 

func (s *FunctionTestRun) GetSendError() NilString

GetSendError returns the value of SendError.

func (*FunctionTestRun) GetSentAt added in v0.29.0 

func (s *FunctionTestRun) GetSentAt() NilDateTime

GetSentAt returns the value of SentAt.

func (*FunctionTestRun) GetSubject added in v0.29.0 

func (s *FunctionTestRun) GetSubject() string

GetSubject returns the value of Subject.

func (*FunctionTestRun) GetTo added in v0.29.0 

func (s *FunctionTestRun) GetTo() string

GetTo returns the value of To.

func (*FunctionTestRun) MarshalJSON added in v0.29.0 

func (s *FunctionTestRun) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionTestRun) SetCreatedAt added in v0.29.0 

func (s *FunctionTestRun) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*FunctionTestRun) SetFrom added in v0.29.0 

func (s *FunctionTestRun) SetFrom(val string)

SetFrom sets the value of From.

func (*FunctionTestRun) SetFunctionID added in v0.29.0 

func (s *FunctionTestRun) SetFunctionID(val uuid.UUID)

SetFunctionID sets the value of FunctionID.

func (*FunctionTestRun) SetID added in v0.29.0 

func (s *FunctionTestRun) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*FunctionTestRun) SetInboundDomain added in v0.29.0 

func (s *FunctionTestRun) SetInboundDomain(val string)

SetInboundDomain sets the value of InboundDomain.

func (*FunctionTestRun) SetPollSince added in v0.29.0 

func (s *FunctionTestRun) SetPollSince(val time.Time)

SetPollSince sets the value of PollSince.

func (*FunctionTestRun) SetSendError added in v0.29.0 

func (s *FunctionTestRun) SetSendError(val NilString)

SetSendError sets the value of SendError.

func (*FunctionTestRun) SetSentAt added in v0.29.0 

func (s *FunctionTestRun) SetSentAt(val NilDateTime)

SetSentAt sets the value of SentAt.

func (*FunctionTestRun) SetSubject added in v0.29.0 

func (s *FunctionTestRun) SetSubject(val string)

SetSubject sets the value of Subject.

func (*FunctionTestRun) SetTo added in v0.29.0 

func (s *FunctionTestRun) SetTo(val string)

SetTo sets the value of To.

func (*FunctionTestRun) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRun) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type FunctionTestRunDelivery added in v0.29.0 

type FunctionTestRunDelivery struct {
	// Webhook delivery id.
	ID            string                             `json:"id"`
	EndpointID    uuid.UUID                          `json:"endpoint_id"`
	EndpointURL   url.URL                            `json:"endpoint_url"`
	Status        FunctionTestRunDeliveryStatus      `json:"status"`
	AttemptCount  int                                `json:"attempt_count"`
	DurationMs    NilInt                             `json:"duration_ms"`
	LastError     NilString                          `json:"last_error"`
	LastErrorCode NilString                          `json:"last_error_code"`
	CreatedAt     time.Time                          `json:"created_at"`
	UpdatedAt     time.Time                          `json:"updated_at"`
	Endpoint      NilFunctionTestRunDeliveryEndpoint `json:"endpoint"`
}

Ref: #/components/schemas/FunctionTestRunDelivery

func (*FunctionTestRunDelivery) Decode added in v0.29.0 

func (s *FunctionTestRunDelivery) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunDelivery from json.

func (*FunctionTestRunDelivery) Encode added in v0.29.0 

func (s *FunctionTestRunDelivery) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionTestRunDelivery) GetAttemptCount added in v0.29.0 

func (s *FunctionTestRunDelivery) GetAttemptCount() int

GetAttemptCount returns the value of AttemptCount.

func (*FunctionTestRunDelivery) GetCreatedAt added in v0.29.0 

func (s *FunctionTestRunDelivery) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*FunctionTestRunDelivery) GetDurationMs added in v0.29.0 

func (s *FunctionTestRunDelivery) GetDurationMs() NilInt

GetDurationMs returns the value of DurationMs.

func (*FunctionTestRunDelivery) GetEndpoint added in v0.29.0 

func (s *FunctionTestRunDelivery) GetEndpoint() NilFunctionTestRunDeliveryEndpoint

GetEndpoint returns the value of Endpoint.

func (*FunctionTestRunDelivery) GetEndpointID added in v0.29.0 

func (s *FunctionTestRunDelivery) GetEndpointID() uuid.UUID

GetEndpointID returns the value of EndpointID.

func (*FunctionTestRunDelivery) GetEndpointURL added in v0.29.0 

func (s *FunctionTestRunDelivery) GetEndpointURL() url.URL

GetEndpointURL returns the value of EndpointURL.

func (*FunctionTestRunDelivery) GetID added in v0.29.0 

func (s *FunctionTestRunDelivery) GetID() string

GetID returns the value of ID.

func (*FunctionTestRunDelivery) GetLastError added in v0.29.0 

func (s *FunctionTestRunDelivery) GetLastError() NilString

GetLastError returns the value of LastError.

func (*FunctionTestRunDelivery) GetLastErrorCode added in v0.29.0 

func (s *FunctionTestRunDelivery) GetLastErrorCode() NilString

GetLastErrorCode returns the value of LastErrorCode.

func (*FunctionTestRunDelivery) GetStatus added in v0.29.0 

func (s *FunctionTestRunDelivery) GetStatus() FunctionTestRunDeliveryStatus

GetStatus returns the value of Status.

func (*FunctionTestRunDelivery) GetUpdatedAt added in v0.29.0 

func (s *FunctionTestRunDelivery) GetUpdatedAt() time.Time

GetUpdatedAt returns the value of UpdatedAt.

func (*FunctionTestRunDelivery) MarshalJSON added in v0.29.0 

func (s *FunctionTestRunDelivery) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionTestRunDelivery) SetAttemptCount added in v0.29.0 

func (s *FunctionTestRunDelivery) SetAttemptCount(val int)

SetAttemptCount sets the value of AttemptCount.

func (*FunctionTestRunDelivery) SetCreatedAt added in v0.29.0 

func (s *FunctionTestRunDelivery) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*FunctionTestRunDelivery) SetDurationMs added in v0.29.0 

func (s *FunctionTestRunDelivery) SetDurationMs(val NilInt)

SetDurationMs sets the value of DurationMs.

func (*FunctionTestRunDelivery) SetEndpoint added in v0.29.0 

func (s *FunctionTestRunDelivery) SetEndpoint(val NilFunctionTestRunDeliveryEndpoint)

SetEndpoint sets the value of Endpoint.

func (*FunctionTestRunDelivery) SetEndpointID added in v0.29.0 

func (s *FunctionTestRunDelivery) SetEndpointID(val uuid.UUID)

SetEndpointID sets the value of EndpointID.

func (*FunctionTestRunDelivery) SetEndpointURL added in v0.29.0 

func (s *FunctionTestRunDelivery) SetEndpointURL(val url.URL)

SetEndpointURL sets the value of EndpointURL.

func (*FunctionTestRunDelivery) SetID added in v0.29.0 

func (s *FunctionTestRunDelivery) SetID(val string)

SetID sets the value of ID.

func (*FunctionTestRunDelivery) SetLastError added in v0.29.0 

func (s *FunctionTestRunDelivery) SetLastError(val NilString)

SetLastError sets the value of LastError.

func (*FunctionTestRunDelivery) SetLastErrorCode added in v0.29.0 

func (s *FunctionTestRunDelivery) SetLastErrorCode(val NilString)

SetLastErrorCode sets the value of LastErrorCode.

func (*FunctionTestRunDelivery) SetStatus added in v0.29.0 

func (s *FunctionTestRunDelivery) SetStatus(val FunctionTestRunDeliveryStatus)

SetStatus sets the value of Status.

func (*FunctionTestRunDelivery) SetUpdatedAt added in v0.29.0 

func (s *FunctionTestRunDelivery) SetUpdatedAt(val time.Time)

SetUpdatedAt sets the value of UpdatedAt.

func (*FunctionTestRunDelivery) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRunDelivery) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionTestRunDelivery) Validate added in v0.29.0 

func (s *FunctionTestRunDelivery) Validate() error

type FunctionTestRunDeliveryEndpoint added in v0.29.0 

type FunctionTestRunDeliveryEndpoint struct {
	ID uuid.UUID `json:"id"`
	// Endpoint kind. Current traces may include `http` or `function`; future endpoint kinds may appear.
	Kind              string      `json:"kind"`
	FunctionID        NilUUID     `json:"function_id"`
	FunctionName      NilString   `json:"function_name"`
	DomainID          NilUUID     `json:"domain_id"`
	Enabled           bool        `json:"enabled"`
	DeactivatedAt     NilDateTime `json:"deactivated_at"`
	IsCurrentFunction bool        `json:"is_current_function"`
}

Ref: #/components/schemas/FunctionTestRunDeliveryEndpoint

func (*FunctionTestRunDeliveryEndpoint) Decode added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunDeliveryEndpoint from json.

func (*FunctionTestRunDeliveryEndpoint) Encode added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionTestRunDeliveryEndpoint) GetDeactivatedAt added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) GetDeactivatedAt() NilDateTime

GetDeactivatedAt returns the value of DeactivatedAt.

func (*FunctionTestRunDeliveryEndpoint) GetDomainID added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) GetDomainID() NilUUID

GetDomainID returns the value of DomainID.

func (*FunctionTestRunDeliveryEndpoint) GetEnabled added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) GetEnabled() bool

GetEnabled returns the value of Enabled.

func (*FunctionTestRunDeliveryEndpoint) GetFunctionID added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) GetFunctionID() NilUUID

GetFunctionID returns the value of FunctionID.

func (*FunctionTestRunDeliveryEndpoint) GetFunctionName added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) GetFunctionName() NilString

GetFunctionName returns the value of FunctionName.

func (*FunctionTestRunDeliveryEndpoint) GetID added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) GetID() uuid.UUID

GetID returns the value of ID.

func (*FunctionTestRunDeliveryEndpoint) GetIsCurrentFunction added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) GetIsCurrentFunction() bool

GetIsCurrentFunction returns the value of IsCurrentFunction.

func (*FunctionTestRunDeliveryEndpoint) GetKind added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) GetKind() string

GetKind returns the value of Kind.

func (*FunctionTestRunDeliveryEndpoint) MarshalJSON added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionTestRunDeliveryEndpoint) SetDeactivatedAt added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) SetDeactivatedAt(val NilDateTime)

SetDeactivatedAt sets the value of DeactivatedAt.

func (*FunctionTestRunDeliveryEndpoint) SetDomainID added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) SetDomainID(val NilUUID)

SetDomainID sets the value of DomainID.

func (*FunctionTestRunDeliveryEndpoint) SetEnabled added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) SetEnabled(val bool)

SetEnabled sets the value of Enabled.

func (*FunctionTestRunDeliveryEndpoint) SetFunctionID added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) SetFunctionID(val NilUUID)

SetFunctionID sets the value of FunctionID.

func (*FunctionTestRunDeliveryEndpoint) SetFunctionName added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) SetFunctionName(val NilString)

SetFunctionName sets the value of FunctionName.

func (*FunctionTestRunDeliveryEndpoint) SetID added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*FunctionTestRunDeliveryEndpoint) SetIsCurrentFunction added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) SetIsCurrentFunction(val bool)

SetIsCurrentFunction sets the value of IsCurrentFunction.

func (*FunctionTestRunDeliveryEndpoint) SetKind added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) SetKind(val string)

SetKind sets the value of Kind.

func (*FunctionTestRunDeliveryEndpoint) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRunDeliveryEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type FunctionTestRunDeliveryStatus added in v0.29.0 

type FunctionTestRunDeliveryStatus string
const (
	FunctionTestRunDeliveryStatusPending         FunctionTestRunDeliveryStatus = "pending"
	FunctionTestRunDeliveryStatusDelivered       FunctionTestRunDeliveryStatus = "delivered"
	FunctionTestRunDeliveryStatusHeaderConfirmed FunctionTestRunDeliveryStatus = "header_confirmed"
	FunctionTestRunDeliveryStatusFailed          FunctionTestRunDeliveryStatus = "failed"
)

func (FunctionTestRunDeliveryStatus) AllValues added in v0.29.0 

func (FunctionTestRunDeliveryStatus) AllValues() []FunctionTestRunDeliveryStatus

AllValues returns all FunctionTestRunDeliveryStatus values.

func (*FunctionTestRunDeliveryStatus) Decode added in v0.29.0 

func (s *FunctionTestRunDeliveryStatus) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunDeliveryStatus from json.

func (FunctionTestRunDeliveryStatus) Encode added in v0.29.0 

func (s FunctionTestRunDeliveryStatus) Encode(e *jx.Encoder)

Encode encodes FunctionTestRunDeliveryStatus as json.

func (FunctionTestRunDeliveryStatus) MarshalJSON added in v0.29.0 

func (s FunctionTestRunDeliveryStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (FunctionTestRunDeliveryStatus) MarshalText added in v0.29.0 

func (s FunctionTestRunDeliveryStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*FunctionTestRunDeliveryStatus) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRunDeliveryStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionTestRunDeliveryStatus) UnmarshalText added in v0.29.0 

func (s *FunctionTestRunDeliveryStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (FunctionTestRunDeliveryStatus) Validate added in v0.29.0 

func (s FunctionTestRunDeliveryStatus) Validate() error

type FunctionTestRunInboundEmail added in v0.29.0 

type FunctionTestRunInboundEmail struct {
	ID                    uuid.UUID             `json:"id"`
	Status                EmailStatus           `json:"status"`
	ReceivedAt            time.Time             `json:"received_at"`
	From                  string                `json:"from"`
	To                    string                `json:"to"`
	Subject               NilString             `json:"subject"`
	WebhookStatus         NilEmailWebhookStatus `json:"webhook_status"`
	WebhookAttemptCount   int                   `json:"webhook_attempt_count"`
	WebhookLastStatusCode NilInt                `json:"webhook_last_status_code"`
	WebhookLastError      NilString             `json:"webhook_last_error"`
}

Ref: #/components/schemas/FunctionTestRunInboundEmail

func (*FunctionTestRunInboundEmail) Decode added in v0.29.0 

func (s *FunctionTestRunInboundEmail) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunInboundEmail from json.

func (*FunctionTestRunInboundEmail) Encode added in v0.29.0 

func (s *FunctionTestRunInboundEmail) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionTestRunInboundEmail) GetFrom added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetFrom() string

GetFrom returns the value of From.

func (*FunctionTestRunInboundEmail) GetID added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetID() uuid.UUID

GetID returns the value of ID.

func (*FunctionTestRunInboundEmail) GetReceivedAt added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetReceivedAt() time.Time

GetReceivedAt returns the value of ReceivedAt.

func (*FunctionTestRunInboundEmail) GetStatus added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetStatus() EmailStatus

GetStatus returns the value of Status.

func (*FunctionTestRunInboundEmail) GetSubject added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetSubject() NilString

GetSubject returns the value of Subject.

func (*FunctionTestRunInboundEmail) GetTo added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetTo() string

GetTo returns the value of To.

func (*FunctionTestRunInboundEmail) GetWebhookAttemptCount added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetWebhookAttemptCount() int

GetWebhookAttemptCount returns the value of WebhookAttemptCount.

func (*FunctionTestRunInboundEmail) GetWebhookLastError added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetWebhookLastError() NilString

GetWebhookLastError returns the value of WebhookLastError.

func (*FunctionTestRunInboundEmail) GetWebhookLastStatusCode added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetWebhookLastStatusCode() NilInt

GetWebhookLastStatusCode returns the value of WebhookLastStatusCode.

func (*FunctionTestRunInboundEmail) GetWebhookStatus added in v0.29.0 

func (s *FunctionTestRunInboundEmail) GetWebhookStatus() NilEmailWebhookStatus

GetWebhookStatus returns the value of WebhookStatus.

func (*FunctionTestRunInboundEmail) MarshalJSON added in v0.29.0 

func (s *FunctionTestRunInboundEmail) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionTestRunInboundEmail) SetFrom added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetFrom(val string)

SetFrom sets the value of From.

func (*FunctionTestRunInboundEmail) SetID added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*FunctionTestRunInboundEmail) SetReceivedAt added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetReceivedAt(val time.Time)

SetReceivedAt sets the value of ReceivedAt.

func (*FunctionTestRunInboundEmail) SetStatus added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetStatus(val EmailStatus)

SetStatus sets the value of Status.

func (*FunctionTestRunInboundEmail) SetSubject added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetSubject(val NilString)

SetSubject sets the value of Subject.

func (*FunctionTestRunInboundEmail) SetTo added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetTo(val string)

SetTo sets the value of To.

func (*FunctionTestRunInboundEmail) SetWebhookAttemptCount added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetWebhookAttemptCount(val int)

SetWebhookAttemptCount sets the value of WebhookAttemptCount.

func (*FunctionTestRunInboundEmail) SetWebhookLastError added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetWebhookLastError(val NilString)

SetWebhookLastError sets the value of WebhookLastError.

func (*FunctionTestRunInboundEmail) SetWebhookLastStatusCode added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetWebhookLastStatusCode(val NilInt)

SetWebhookLastStatusCode sets the value of WebhookLastStatusCode.

func (*FunctionTestRunInboundEmail) SetWebhookStatus added in v0.29.0 

func (s *FunctionTestRunInboundEmail) SetWebhookStatus(val NilEmailWebhookStatus)

SetWebhookStatus sets the value of WebhookStatus.

func (*FunctionTestRunInboundEmail) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRunInboundEmail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionTestRunInboundEmail) Validate added in v0.29.0 

func (s *FunctionTestRunInboundEmail) Validate() error

type FunctionTestRunOutboundRequest added in v0.29.0 

type FunctionTestRunOutboundRequest struct {
	ID                uuid.UUID `json:"id"`
	FunctionID        uuid.UUID `json:"function_id"`
	WebhookDeliveryID NilString `json:"webhook_delivery_id"`
	EmailID           NilUUID   `json:"email_id"`
	EndpointID        NilUUID   `json:"endpoint_id"`
	Method            string    `json:"method"`
	URL               url.URL   `json:"url"`
	Host              string    `json:"host"`
	Path              string    `json:"path"`
	StatusCode        NilInt    `json:"status_code"`
	Ok                NilBool   `json:"ok"`
	DurationMs        int       `json:"duration_ms"`
	Error             NilString `json:"error"`
	Ts                time.Time `json:"ts"`
}

Ref: #/components/schemas/FunctionTestRunOutboundRequest

func (*FunctionTestRunOutboundRequest) Decode added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunOutboundRequest from json.

func (*FunctionTestRunOutboundRequest) Encode added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionTestRunOutboundRequest) GetDurationMs added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetDurationMs() int

GetDurationMs returns the value of DurationMs.

func (*FunctionTestRunOutboundRequest) GetEmailID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetEmailID() NilUUID

GetEmailID returns the value of EmailID.

func (*FunctionTestRunOutboundRequest) GetEndpointID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetEndpointID() NilUUID

GetEndpointID returns the value of EndpointID.

func (*FunctionTestRunOutboundRequest) GetError added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetError() NilString

GetError returns the value of Error.

func (*FunctionTestRunOutboundRequest) GetFunctionID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetFunctionID() uuid.UUID

GetFunctionID returns the value of FunctionID.

func (*FunctionTestRunOutboundRequest) GetHost added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetHost() string

GetHost returns the value of Host.

func (*FunctionTestRunOutboundRequest) GetID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetID() uuid.UUID

GetID returns the value of ID.

func (*FunctionTestRunOutboundRequest) GetMethod added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetMethod() string

GetMethod returns the value of Method.

func (*FunctionTestRunOutboundRequest) GetOk added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetOk() NilBool

GetOk returns the value of Ok.

func (*FunctionTestRunOutboundRequest) GetPath added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetPath() string

GetPath returns the value of Path.

func (*FunctionTestRunOutboundRequest) GetStatusCode added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetStatusCode() NilInt

GetStatusCode returns the value of StatusCode.

func (*FunctionTestRunOutboundRequest) GetTs added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetTs() time.Time

GetTs returns the value of Ts.

func (*FunctionTestRunOutboundRequest) GetURL added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetURL() url.URL

GetURL returns the value of URL.

func (*FunctionTestRunOutboundRequest) GetWebhookDeliveryID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) GetWebhookDeliveryID() NilString

GetWebhookDeliveryID returns the value of WebhookDeliveryID.

func (*FunctionTestRunOutboundRequest) MarshalJSON added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionTestRunOutboundRequest) SetDurationMs added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetDurationMs(val int)

SetDurationMs sets the value of DurationMs.

func (*FunctionTestRunOutboundRequest) SetEmailID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetEmailID(val NilUUID)

SetEmailID sets the value of EmailID.

func (*FunctionTestRunOutboundRequest) SetEndpointID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetEndpointID(val NilUUID)

SetEndpointID sets the value of EndpointID.

func (*FunctionTestRunOutboundRequest) SetError added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetError(val NilString)

SetError sets the value of Error.

func (*FunctionTestRunOutboundRequest) SetFunctionID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetFunctionID(val uuid.UUID)

SetFunctionID sets the value of FunctionID.

func (*FunctionTestRunOutboundRequest) SetHost added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetHost(val string)

SetHost sets the value of Host.

func (*FunctionTestRunOutboundRequest) SetID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*FunctionTestRunOutboundRequest) SetMethod added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetMethod(val string)

SetMethod sets the value of Method.

func (*FunctionTestRunOutboundRequest) SetOk added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetOk(val NilBool)

SetOk sets the value of Ok.

func (*FunctionTestRunOutboundRequest) SetPath added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetPath(val string)

SetPath sets the value of Path.

func (*FunctionTestRunOutboundRequest) SetStatusCode added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetStatusCode(val NilInt)

SetStatusCode sets the value of StatusCode.

func (*FunctionTestRunOutboundRequest) SetTs added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetTs(val time.Time)

SetTs sets the value of Ts.

func (*FunctionTestRunOutboundRequest) SetURL added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetURL(val url.URL)

SetURL sets the value of URL.

func (*FunctionTestRunOutboundRequest) SetWebhookDeliveryID added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) SetWebhookDeliveryID(val NilString)

SetWebhookDeliveryID sets the value of WebhookDeliveryID.

func (*FunctionTestRunOutboundRequest) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRunOutboundRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type FunctionTestRunReply added in v0.29.0 

type FunctionTestRunReply struct {
	ID        uuid.UUID       `json:"id"`
	Status    SentEmailStatus `json:"status"`
	To        string          `json:"to"`
	Subject   string          `json:"subject"`
	QueueID   NilString       `json:"queue_id"`
	CreatedAt time.Time       `json:"created_at"`
}

Ref: #/components/schemas/FunctionTestRunReply

func (*FunctionTestRunReply) Decode added in v0.29.0 

func (s *FunctionTestRunReply) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunReply from json.

func (*FunctionTestRunReply) Encode added in v0.29.0 

func (s *FunctionTestRunReply) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionTestRunReply) GetCreatedAt added in v0.29.0 

func (s *FunctionTestRunReply) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*FunctionTestRunReply) GetID added in v0.29.0 

func (s *FunctionTestRunReply) GetID() uuid.UUID

GetID returns the value of ID.

func (*FunctionTestRunReply) GetQueueID added in v0.29.0 

func (s *FunctionTestRunReply) GetQueueID() NilString

GetQueueID returns the value of QueueID.

func (*FunctionTestRunReply) GetStatus added in v0.29.0 

func (s *FunctionTestRunReply) GetStatus() SentEmailStatus

GetStatus returns the value of Status.

func (*FunctionTestRunReply) GetSubject added in v0.29.0 

func (s *FunctionTestRunReply) GetSubject() string

GetSubject returns the value of Subject.

func (*FunctionTestRunReply) GetTo added in v0.29.0 

func (s *FunctionTestRunReply) GetTo() string

GetTo returns the value of To.

func (*FunctionTestRunReply) MarshalJSON added in v0.29.0 

func (s *FunctionTestRunReply) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionTestRunReply) SetCreatedAt added in v0.29.0 

func (s *FunctionTestRunReply) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*FunctionTestRunReply) SetID added in v0.29.0 

func (s *FunctionTestRunReply) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*FunctionTestRunReply) SetQueueID added in v0.29.0 

func (s *FunctionTestRunReply) SetQueueID(val NilString)

SetQueueID sets the value of QueueID.

func (*FunctionTestRunReply) SetStatus added in v0.29.0 

func (s *FunctionTestRunReply) SetStatus(val SentEmailStatus)

SetStatus sets the value of Status.

func (*FunctionTestRunReply) SetSubject added in v0.29.0 

func (s *FunctionTestRunReply) SetSubject(val string)

SetSubject sets the value of Subject.

func (*FunctionTestRunReply) SetTo added in v0.29.0 

func (s *FunctionTestRunReply) SetTo(val string)

SetTo sets the value of To.

func (*FunctionTestRunReply) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRunReply) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionTestRunReply) Validate added in v0.29.0 

func (s *FunctionTestRunReply) Validate() error

type FunctionTestRunSend added in v0.29.0 

type FunctionTestRunSend struct {
	ID        uuid.UUID       `json:"id"`
	Status    SentEmailStatus `json:"status"`
	QueueID   NilString       `json:"queue_id"`
	CreatedAt time.Time       `json:"created_at"`
	UpdatedAt time.Time       `json:"updated_at"`
}

Ref: #/components/schemas/FunctionTestRunSend

func (*FunctionTestRunSend) Decode added in v0.29.0 

func (s *FunctionTestRunSend) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunSend from json.

func (*FunctionTestRunSend) Encode added in v0.29.0 

func (s *FunctionTestRunSend) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionTestRunSend) GetCreatedAt added in v0.29.0 

func (s *FunctionTestRunSend) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*FunctionTestRunSend) GetID added in v0.29.0 

func (s *FunctionTestRunSend) GetID() uuid.UUID

GetID returns the value of ID.

func (*FunctionTestRunSend) GetQueueID added in v0.29.0 

func (s *FunctionTestRunSend) GetQueueID() NilString

GetQueueID returns the value of QueueID.

func (*FunctionTestRunSend) GetStatus added in v0.29.0 

func (s *FunctionTestRunSend) GetStatus() SentEmailStatus

GetStatus returns the value of Status.

func (*FunctionTestRunSend) GetUpdatedAt added in v0.29.0 

func (s *FunctionTestRunSend) GetUpdatedAt() time.Time

GetUpdatedAt returns the value of UpdatedAt.

func (*FunctionTestRunSend) MarshalJSON added in v0.29.0 

func (s *FunctionTestRunSend) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionTestRunSend) SetCreatedAt added in v0.29.0 

func (s *FunctionTestRunSend) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*FunctionTestRunSend) SetID added in v0.29.0 

func (s *FunctionTestRunSend) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*FunctionTestRunSend) SetQueueID added in v0.29.0 

func (s *FunctionTestRunSend) SetQueueID(val NilString)

SetQueueID sets the value of QueueID.

func (*FunctionTestRunSend) SetStatus added in v0.29.0 

func (s *FunctionTestRunSend) SetStatus(val SentEmailStatus)

SetStatus sets the value of Status.

func (*FunctionTestRunSend) SetUpdatedAt added in v0.29.0 

func (s *FunctionTestRunSend) SetUpdatedAt(val time.Time)

SetUpdatedAt sets the value of UpdatedAt.

func (*FunctionTestRunSend) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRunSend) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionTestRunSend) Validate added in v0.29.0 

func (s *FunctionTestRunSend) Validate() error

type FunctionTestRunState added in v0.29.0 

type FunctionTestRunState string

High-level state for a function test run trace: - `send_failed`: the initial test email send failed. - `waiting_for_send`: the test run was created but no send result has been recorded yet. - `waiting_for_inbound`: the test send was queued and the matching inbound email has not arrived yet. - `waiting_for_function`: the inbound email arrived and webhook/function processing is still in flight. - `completed`: the function webhook completed successfully. - `failed`: webhook delivery exhausted retries. Ref: #/components/schemas/FunctionTestRunState 

const (
	FunctionTestRunStateSendFailed         FunctionTestRunState = "send_failed"
	FunctionTestRunStateWaitingForSend     FunctionTestRunState = "waiting_for_send"
	FunctionTestRunStateWaitingForInbound  FunctionTestRunState = "waiting_for_inbound"
	FunctionTestRunStateWaitingForFunction FunctionTestRunState = "waiting_for_function"
	FunctionTestRunStateCompleted          FunctionTestRunState = "completed"
	FunctionTestRunStateFailed             FunctionTestRunState = "failed"
)

func (FunctionTestRunState) AllValues added in v0.29.0 

func (FunctionTestRunState) AllValues() []FunctionTestRunState

AllValues returns all FunctionTestRunState values.

func (*FunctionTestRunState) Decode added in v0.29.0 

func (s *FunctionTestRunState) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunState from json.

func (FunctionTestRunState) Encode added in v0.29.0 

func (s FunctionTestRunState) Encode(e *jx.Encoder)

Encode encodes FunctionTestRunState as json.

func (FunctionTestRunState) MarshalJSON added in v0.29.0 

func (s FunctionTestRunState) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (FunctionTestRunState) MarshalText added in v0.29.0 

func (s FunctionTestRunState) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*FunctionTestRunState) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRunState) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionTestRunState) UnmarshalText added in v0.29.0 

func (s *FunctionTestRunState) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (FunctionTestRunState) Validate added in v0.29.0 

func (s FunctionTestRunState) Validate() error

type FunctionTestRunTrace added in v0.29.0 

type FunctionTestRunTrace struct {
	State            FunctionTestRunState             `json:"state"`
	TestRun          FunctionTestRun                  `json:"test_run"`
	TestSend         NilFunctionTestRunSend           `json:"test_send"`
	InboundEmail     NilFunctionTestRunInboundEmail   `json:"inbound_email"`
	Deliveries       []FunctionTestRunDelivery        `json:"deliveries"`
	OutboundRequests []FunctionTestRunOutboundRequest `json:"outbound_requests"`
	Logs             []FunctionLogRow                 `json:"logs"`
	Replies          []FunctionTestRunReply           `json:"replies"`
}

End-to-end trace for a `POST /functions/{id}/test` run. The shape is stable, but many nested sections are null or empty until the corresponding phase has happened. Ref: #/components/schemas/FunctionTestRunTrace

func (*FunctionTestRunTrace) Decode added in v0.29.0 

func (s *FunctionTestRunTrace) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunTrace from json.

func (*FunctionTestRunTrace) Encode added in v0.29.0 

func (s *FunctionTestRunTrace) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*FunctionTestRunTrace) GetDeliveries added in v0.29.0 

func (s *FunctionTestRunTrace) GetDeliveries() []FunctionTestRunDelivery

GetDeliveries returns the value of Deliveries.

func (*FunctionTestRunTrace) GetInboundEmail added in v0.29.0 

func (s *FunctionTestRunTrace) GetInboundEmail() NilFunctionTestRunInboundEmail

GetInboundEmail returns the value of InboundEmail.

func (*FunctionTestRunTrace) GetLogs added in v0.29.0 

func (s *FunctionTestRunTrace) GetLogs() []FunctionLogRow

GetLogs returns the value of Logs.

func (*FunctionTestRunTrace) GetOutboundRequests added in v0.29.0 

func (s *FunctionTestRunTrace) GetOutboundRequests() []FunctionTestRunOutboundRequest

GetOutboundRequests returns the value of OutboundRequests.

func (*FunctionTestRunTrace) GetReplies added in v0.29.0 

func (s *FunctionTestRunTrace) GetReplies() []FunctionTestRunReply

GetReplies returns the value of Replies.

func (*FunctionTestRunTrace) GetState added in v0.29.0 

func (s *FunctionTestRunTrace) GetState() FunctionTestRunState

GetState returns the value of State.

func (*FunctionTestRunTrace) GetTestRun added in v0.29.0 

func (s *FunctionTestRunTrace) GetTestRun() FunctionTestRun

GetTestRun returns the value of TestRun.

func (*FunctionTestRunTrace) GetTestSend added in v0.29.0 

func (s *FunctionTestRunTrace) GetTestSend() NilFunctionTestRunSend

GetTestSend returns the value of TestSend.

func (*FunctionTestRunTrace) MarshalJSON added in v0.29.0 

func (s *FunctionTestRunTrace) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FunctionTestRunTrace) SetDeliveries added in v0.29.0 

func (s *FunctionTestRunTrace) SetDeliveries(val []FunctionTestRunDelivery)

SetDeliveries sets the value of Deliveries.

func (*FunctionTestRunTrace) SetInboundEmail added in v0.29.0 

func (s *FunctionTestRunTrace) SetInboundEmail(val NilFunctionTestRunInboundEmail)

SetInboundEmail sets the value of InboundEmail.

func (*FunctionTestRunTrace) SetLogs added in v0.29.0 

func (s *FunctionTestRunTrace) SetLogs(val []FunctionLogRow)

SetLogs sets the value of Logs.

func (*FunctionTestRunTrace) SetOutboundRequests added in v0.29.0 

func (s *FunctionTestRunTrace) SetOutboundRequests(val []FunctionTestRunOutboundRequest)

SetOutboundRequests sets the value of OutboundRequests.

func (*FunctionTestRunTrace) SetReplies added in v0.29.0 

func (s *FunctionTestRunTrace) SetReplies(val []FunctionTestRunReply)

SetReplies sets the value of Replies.

func (*FunctionTestRunTrace) SetState added in v0.29.0 

func (s *FunctionTestRunTrace) SetState(val FunctionTestRunState)

SetState sets the value of State.

func (*FunctionTestRunTrace) SetTestRun added in v0.29.0 

func (s *FunctionTestRunTrace) SetTestRun(val FunctionTestRun)

SetTestRun sets the value of TestRun.

func (*FunctionTestRunTrace) SetTestSend added in v0.29.0 

func (s *FunctionTestRunTrace) SetTestSend(val NilFunctionTestRunSend)

SetTestSend sets the value of TestSend.

func (*FunctionTestRunTrace) UnmarshalJSON added in v0.29.0 

func (s *FunctionTestRunTrace) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FunctionTestRunTrace) Validate added in v0.29.0 

func (s *FunctionTestRunTrace) Validate() error

type GateDenial added in v0.8.0 

type GateDenial struct {
	// Public recipient-scope gate name that denied the send.
	Name GateDenialName `json:"name"`
	// Stable machine-readable denial reason.
	Reason GateDenialReason `json:"reason"`
	// Human-readable explanation of the gate denial.
	Message string `json:"message"`
	// Domain or address the gate evaluated.
	Subject string     `json:"subject"`
	Fix     OptGateFix `json:"fix"`
	// Public docs URL with more context.
	DocsURL OptString `json:"docs_url"`
}

Ref: #/components/schemas/GateDenial

func (*GateDenial) Decode added in v0.8.0 

func (s *GateDenial) Decode(d *jx.Decoder) error

Decode decodes GateDenial from json.

func (*GateDenial) Encode added in v0.8.0 

func (s *GateDenial) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GateDenial) GetDocsURL added in v0.8.0 

func (s *GateDenial) GetDocsURL() OptString

GetDocsURL returns the value of DocsURL.

func (*GateDenial) GetFix added in v0.8.0 

func (s *GateDenial) GetFix() OptGateFix

GetFix returns the value of Fix.

func (*GateDenial) GetMessage added in v0.8.0 

func (s *GateDenial) GetMessage() string

GetMessage returns the value of Message.

func (*GateDenial) GetName added in v0.8.0 

func (s *GateDenial) GetName() GateDenialName

GetName returns the value of Name.

func (*GateDenial) GetReason added in v0.8.0 

func (s *GateDenial) GetReason() GateDenialReason

GetReason returns the value of Reason.

func (*GateDenial) GetSubject added in v0.8.0 

func (s *GateDenial) GetSubject() string

GetSubject returns the value of Subject.

func (*GateDenial) MarshalJSON added in v0.8.0 

func (s *GateDenial) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GateDenial) SetDocsURL added in v0.8.0 

func (s *GateDenial) SetDocsURL(val OptString)

SetDocsURL sets the value of DocsURL.

func (*GateDenial) SetFix added in v0.8.0 

func (s *GateDenial) SetFix(val OptGateFix)

SetFix sets the value of Fix.

func (*GateDenial) SetMessage added in v0.8.0 

func (s *GateDenial) SetMessage(val string)

SetMessage sets the value of Message.

func (*GateDenial) SetName added in v0.8.0 

func (s *GateDenial) SetName(val GateDenialName)

SetName sets the value of Name.

func (*GateDenial) SetReason added in v0.8.0 

func (s *GateDenial) SetReason(val GateDenialReason)

SetReason sets the value of Reason.

func (*GateDenial) SetSubject added in v0.8.0 

func (s *GateDenial) SetSubject(val string)

SetSubject sets the value of Subject.

func (*GateDenial) UnmarshalJSON added in v0.8.0 

func (s *GateDenial) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GateDenial) Validate added in v0.8.0 

func (s *GateDenial) Validate() error

type GateDenialName added in v0.8.0 

type GateDenialName string

Public recipient-scope gate name that denied the send. 

const (
	GateDenialNameSendToConfirmedDomains GateDenialName = "send_to_confirmed_domains"
	GateDenialNameSendToKnownAddresses   GateDenialName = "send_to_known_addresses"
)

func (GateDenialName) AllValues added in v0.8.0 

func (GateDenialName) AllValues() []GateDenialName

AllValues returns all GateDenialName values.

func (*GateDenialName) Decode added in v0.8.0 

func (s *GateDenialName) Decode(d *jx.Decoder) error

Decode decodes GateDenialName from json.

func (GateDenialName) Encode added in v0.8.0 

func (s GateDenialName) Encode(e *jx.Encoder)

Encode encodes GateDenialName as json.

func (GateDenialName) MarshalJSON added in v0.8.0 

func (s GateDenialName) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (GateDenialName) MarshalText added in v0.8.0 

func (s GateDenialName) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*GateDenialName) UnmarshalJSON added in v0.8.0 

func (s *GateDenialName) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GateDenialName) UnmarshalText added in v0.8.0 

func (s *GateDenialName) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (GateDenialName) Validate added in v0.8.0 

func (s GateDenialName) Validate() error

type GateDenialReason added in v0.8.0 

type GateDenialReason string

Stable machine-readable denial reason. 

const (
	GateDenialReasonDomainNotConfirmed       GateDenialReason = "domain_not_confirmed"
	GateDenialReasonRecipientUnauthenticated GateDenialReason = "recipient_unauthenticated"
	GateDenialReasonRecipientNotKnown        GateDenialReason = "recipient_not_known"
)

func (GateDenialReason) AllValues added in v0.8.0 

func (GateDenialReason) AllValues() []GateDenialReason

AllValues returns all GateDenialReason values.

func (*GateDenialReason) Decode added in v0.8.0 

func (s *GateDenialReason) Decode(d *jx.Decoder) error

Decode decodes GateDenialReason from json.

func (GateDenialReason) Encode added in v0.8.0 

func (s GateDenialReason) Encode(e *jx.Encoder)

Encode encodes GateDenialReason as json.

func (GateDenialReason) MarshalJSON added in v0.8.0 

func (s GateDenialReason) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (GateDenialReason) MarshalText added in v0.8.0 

func (s GateDenialReason) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*GateDenialReason) UnmarshalJSON added in v0.8.0 

func (s *GateDenialReason) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GateDenialReason) UnmarshalText added in v0.8.0 

func (s *GateDenialReason) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (GateDenialReason) Validate added in v0.8.0 

func (s GateDenialReason) Validate() error

type GateFix added in v0.8.0 

type GateFix struct {
	// Suggested next action for the caller.
	Action GateFixAction `json:"action"`
	// Entity the action applies to.
	Subject string `json:"subject"`
}

Ref: #/components/schemas/GateFix

func (*GateFix) Decode added in v0.8.0 

func (s *GateFix) Decode(d *jx.Decoder) error

Decode decodes GateFix from json.

func (*GateFix) Encode added in v0.8.0 

func (s *GateFix) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GateFix) GetAction added in v0.8.0 

func (s *GateFix) GetAction() GateFixAction

GetAction returns the value of Action.

func (*GateFix) GetSubject added in v0.8.0 

func (s *GateFix) GetSubject() string

GetSubject returns the value of Subject.

func (*GateFix) MarshalJSON added in v0.8.0 

func (s *GateFix) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GateFix) SetAction added in v0.8.0 

func (s *GateFix) SetAction(val GateFixAction)

SetAction sets the value of Action.

func (*GateFix) SetSubject added in v0.8.0 

func (s *GateFix) SetSubject(val string)

SetSubject sets the value of Subject.

func (*GateFix) UnmarshalJSON added in v0.8.0 

func (s *GateFix) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GateFix) Validate added in v0.8.0 

func (s *GateFix) Validate() error

type GateFixAction added in v0.8.0 

type GateFixAction string

Suggested next action for the caller. 

const (
	GateFixActionConfirmDomain               GateFixAction = "confirm_domain"
	GateFixActionSenderMustFixAuthentication GateFixAction = "sender_must_fix_authentication"
	GateFixActionWaitForInbound              GateFixAction = "wait_for_inbound"
)

func (GateFixAction) AllValues added in v0.8.0 

func (GateFixAction) AllValues() []GateFixAction

AllValues returns all GateFixAction values.

func (*GateFixAction) Decode added in v0.8.0 

func (s *GateFixAction) Decode(d *jx.Decoder) error

Decode decodes GateFixAction from json.

func (GateFixAction) Encode added in v0.8.0 

func (s GateFixAction) Encode(e *jx.Encoder)

Encode encodes GateFixAction as json.

func (GateFixAction) MarshalJSON added in v0.8.0 

func (s GateFixAction) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (GateFixAction) MarshalText added in v0.8.0 

func (s GateFixAction) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*GateFixAction) UnmarshalJSON added in v0.8.0 

func (s *GateFixAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GateFixAction) UnmarshalText added in v0.8.0 

func (s *GateFixAction) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (GateFixAction) Validate added in v0.8.0 

func (s GateFixAction) Validate() error

type GetAccountNotFound 

type GetAccountNotFound ErrorResponse

func (*GetAccountNotFound) Decode 

func (s *GetAccountNotFound) Decode(d *jx.Decoder) error

Decode decodes GetAccountNotFound from json.

func (*GetAccountNotFound) Encode 

func (s *GetAccountNotFound) Encode(e *jx.Encoder)

Encode encodes GetAccountNotFound as json.

func (*GetAccountNotFound) MarshalJSON 

func (s *GetAccountNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetAccountNotFound) UnmarshalJSON 

func (s *GetAccountNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetAccountNotFound) Validate 

func (s *GetAccountNotFound) Validate() error

type GetAccountOK 

type GetAccountOK struct {
	Success bool    `json:"success"`
	Data    Account `json:"data"`
}

Merged schema.

func (*GetAccountOK) Decode 

func (s *GetAccountOK) Decode(d *jx.Decoder) error

Decode decodes GetAccountOK from json.

func (*GetAccountOK) Encode 

func (s *GetAccountOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GetAccountOK) GetData 

func (s *GetAccountOK) GetData() Account

GetData returns the value of Data.

func (*GetAccountOK) GetSuccess 

func (s *GetAccountOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*GetAccountOK) MarshalJSON 

func (s *GetAccountOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetAccountOK) SetData 

func (s *GetAccountOK) SetData(val Account)

SetData sets the value of Data.

func (*GetAccountOK) SetSuccess 

func (s *GetAccountOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*GetAccountOK) UnmarshalJSON 

func (s *GetAccountOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetAccountOK) Validate 

func (s *GetAccountOK) Validate() error

type GetAccountRes 

type GetAccountRes interface {
	// contains filtered or unexported methods
}

type GetAccountUnauthorized 

type GetAccountUnauthorized ErrorResponse

func (*GetAccountUnauthorized) Decode 

func (s *GetAccountUnauthorized) Decode(d *jx.Decoder) error

Decode decodes GetAccountUnauthorized from json.

func (*GetAccountUnauthorized) Encode 

func (s *GetAccountUnauthorized) Encode(e *jx.Encoder)

Encode encodes GetAccountUnauthorized as json.

func (*GetAccountUnauthorized) MarshalJSON 

func (s *GetAccountUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetAccountUnauthorized) UnmarshalJSON 

func (s *GetAccountUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetAccountUnauthorized) Validate 

func (s *GetAccountUnauthorized) Validate() error

type GetEmailBadRequest 

type GetEmailBadRequest ErrorResponse

func (*GetEmailBadRequest) Decode 

func (s *GetEmailBadRequest) Decode(d *jx.Decoder) error

Decode decodes GetEmailBadRequest from json.

func (*GetEmailBadRequest) Encode 

func (s *GetEmailBadRequest) Encode(e *jx.Encoder)

Encode encodes GetEmailBadRequest as json.

func (*GetEmailBadRequest) MarshalJSON 

func (s *GetEmailBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetEmailBadRequest) UnmarshalJSON 

func (s *GetEmailBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetEmailBadRequest) Validate 

func (s *GetEmailBadRequest) Validate() error

type GetEmailNotFound 

type GetEmailNotFound ErrorResponse

func (*GetEmailNotFound) Decode 

func (s *GetEmailNotFound) Decode(d *jx.Decoder) error

Decode decodes GetEmailNotFound from json.

func (*GetEmailNotFound) Encode 

func (s *GetEmailNotFound) Encode(e *jx.Encoder)

Encode encodes GetEmailNotFound as json.

func (*GetEmailNotFound) MarshalJSON 

func (s *GetEmailNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetEmailNotFound) UnmarshalJSON 

func (s *GetEmailNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetEmailNotFound) Validate 

func (s *GetEmailNotFound) Validate() error

type GetEmailOK 

type GetEmailOK struct {
	Success bool        `json:"success"`
	Data    EmailDetail `json:"data"`
}

Merged schema.

func (*GetEmailOK) Decode 

func (s *GetEmailOK) Decode(d *jx.Decoder) error

Decode decodes GetEmailOK from json.

func (*GetEmailOK) Encode 

func (s *GetEmailOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GetEmailOK) GetData 

func (s *GetEmailOK) GetData() EmailDetail

GetData returns the value of Data.

func (*GetEmailOK) GetSuccess 

func (s *GetEmailOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*GetEmailOK) MarshalJSON 

func (s *GetEmailOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetEmailOK) SetData 

func (s *GetEmailOK) SetData(val EmailDetail)

SetData sets the value of Data.

func (*GetEmailOK) SetSuccess 

func (s *GetEmailOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*GetEmailOK) UnmarshalJSON 

func (s *GetEmailOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetEmailOK) Validate 

func (s *GetEmailOK) Validate() error

type GetEmailParams 

type GetEmailParams struct {
	// Resource UUID.
	ID uuid.UUID
}

GetEmailParams is parameters of getEmail operation.

type GetEmailRes 

type GetEmailRes interface {
	// contains filtered or unexported methods
}

type GetEmailUnauthorized 

type GetEmailUnauthorized ErrorResponse

func (*GetEmailUnauthorized) Decode 

func (s *GetEmailUnauthorized) Decode(d *jx.Decoder) error

Decode decodes GetEmailUnauthorized from json.

func (*GetEmailUnauthorized) Encode 

func (s *GetEmailUnauthorized) Encode(e *jx.Encoder)

Encode encodes GetEmailUnauthorized as json.

func (*GetEmailUnauthorized) MarshalJSON 

func (s *GetEmailUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetEmailUnauthorized) UnmarshalJSON 

func (s *GetEmailUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetEmailUnauthorized) Validate 

func (s *GetEmailUnauthorized) Validate() error

type GetFunctionNotFound added in v0.20.0 

type GetFunctionNotFound ErrorResponse

func (*GetFunctionNotFound) Decode added in v0.20.0 

func (s *GetFunctionNotFound) Decode(d *jx.Decoder) error

Decode decodes GetFunctionNotFound from json.

func (*GetFunctionNotFound) Encode added in v0.20.0 

func (s *GetFunctionNotFound) Encode(e *jx.Encoder)

Encode encodes GetFunctionNotFound as json.

func (*GetFunctionNotFound) MarshalJSON added in v0.20.0 

func (s *GetFunctionNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetFunctionNotFound) UnmarshalJSON added in v0.20.0 

func (s *GetFunctionNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetFunctionNotFound) Validate added in v0.20.0 

func (s *GetFunctionNotFound) Validate() error

type GetFunctionOK added in v0.20.0 

type GetFunctionOK struct {
	Success bool           `json:"success"`
	Data    FunctionDetail `json:"data"`
}

Merged schema.

func (*GetFunctionOK) Decode added in v0.20.0 

func (s *GetFunctionOK) Decode(d *jx.Decoder) error

Decode decodes GetFunctionOK from json.

func (*GetFunctionOK) Encode added in v0.20.0 

func (s *GetFunctionOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GetFunctionOK) GetData added in v0.20.0 

func (s *GetFunctionOK) GetData() FunctionDetail

GetData returns the value of Data.

func (*GetFunctionOK) GetSuccess added in v0.20.0 

func (s *GetFunctionOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*GetFunctionOK) MarshalJSON added in v0.20.0 

func (s *GetFunctionOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetFunctionOK) SetData added in v0.20.0 

func (s *GetFunctionOK) SetData(val FunctionDetail)

SetData sets the value of Data.

func (*GetFunctionOK) SetSuccess added in v0.20.0 

func (s *GetFunctionOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*GetFunctionOK) UnmarshalJSON added in v0.20.0 

func (s *GetFunctionOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetFunctionOK) Validate added in v0.20.0 

func (s *GetFunctionOK) Validate() error

type GetFunctionParams added in v0.20.0 

type GetFunctionParams struct {
	// Resource UUID.
	ID uuid.UUID
}

GetFunctionParams is parameters of getFunction operation.

type GetFunctionRes added in v0.20.0 

type GetFunctionRes interface {
	// contains filtered or unexported methods
}

type GetFunctionTestRunTraceBadRequest added in v0.29.0 

type GetFunctionTestRunTraceBadRequest ErrorResponse

func (*GetFunctionTestRunTraceBadRequest) Decode added in v0.29.0 

func (s *GetFunctionTestRunTraceBadRequest) Decode(d *jx.Decoder) error

Decode decodes GetFunctionTestRunTraceBadRequest from json.

func (*GetFunctionTestRunTraceBadRequest) Encode added in v0.29.0 

func (s *GetFunctionTestRunTraceBadRequest) Encode(e *jx.Encoder)

Encode encodes GetFunctionTestRunTraceBadRequest as json.

func (*GetFunctionTestRunTraceBadRequest) MarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetFunctionTestRunTraceBadRequest) UnmarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetFunctionTestRunTraceBadRequest) Validate added in v0.29.0 

func (s *GetFunctionTestRunTraceBadRequest) Validate() error

type GetFunctionTestRunTraceForbidden added in v0.29.0 

type GetFunctionTestRunTraceForbidden ErrorResponse

func (*GetFunctionTestRunTraceForbidden) Decode added in v0.29.0 

func (s *GetFunctionTestRunTraceForbidden) Decode(d *jx.Decoder) error

Decode decodes GetFunctionTestRunTraceForbidden from json.

func (*GetFunctionTestRunTraceForbidden) Encode added in v0.29.0 

func (s *GetFunctionTestRunTraceForbidden) Encode(e *jx.Encoder)

Encode encodes GetFunctionTestRunTraceForbidden as json.

func (*GetFunctionTestRunTraceForbidden) MarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetFunctionTestRunTraceForbidden) UnmarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetFunctionTestRunTraceForbidden) Validate added in v0.29.0 

func (s *GetFunctionTestRunTraceForbidden) Validate() error

type GetFunctionTestRunTraceNotFound added in v0.29.0 

type GetFunctionTestRunTraceNotFound ErrorResponse

func (*GetFunctionTestRunTraceNotFound) Decode added in v0.29.0 

func (s *GetFunctionTestRunTraceNotFound) Decode(d *jx.Decoder) error

Decode decodes GetFunctionTestRunTraceNotFound from json.

func (*GetFunctionTestRunTraceNotFound) Encode added in v0.29.0 

func (s *GetFunctionTestRunTraceNotFound) Encode(e *jx.Encoder)

Encode encodes GetFunctionTestRunTraceNotFound as json.

func (*GetFunctionTestRunTraceNotFound) MarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetFunctionTestRunTraceNotFound) UnmarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetFunctionTestRunTraceNotFound) Validate added in v0.29.0 

func (s *GetFunctionTestRunTraceNotFound) Validate() error

type GetFunctionTestRunTraceOK added in v0.29.0 

type GetFunctionTestRunTraceOK struct {
	Success bool                 `json:"success"`
	Data    FunctionTestRunTrace `json:"data"`
}

Merged schema.

func (*GetFunctionTestRunTraceOK) Decode added in v0.29.0 

func (s *GetFunctionTestRunTraceOK) Decode(d *jx.Decoder) error

Decode decodes GetFunctionTestRunTraceOK from json.

func (*GetFunctionTestRunTraceOK) Encode added in v0.29.0 

func (s *GetFunctionTestRunTraceOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GetFunctionTestRunTraceOK) GetData added in v0.29.0 

func (s *GetFunctionTestRunTraceOK) GetData() FunctionTestRunTrace

GetData returns the value of Data.

func (*GetFunctionTestRunTraceOK) GetSuccess added in v0.29.0 

func (s *GetFunctionTestRunTraceOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*GetFunctionTestRunTraceOK) MarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetFunctionTestRunTraceOK) SetData added in v0.29.0 

func (s *GetFunctionTestRunTraceOK) SetData(val FunctionTestRunTrace)

SetData sets the value of Data.

func (*GetFunctionTestRunTraceOK) SetSuccess added in v0.29.0 

func (s *GetFunctionTestRunTraceOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*GetFunctionTestRunTraceOK) UnmarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetFunctionTestRunTraceOK) Validate added in v0.29.0 

func (s *GetFunctionTestRunTraceOK) Validate() error

type GetFunctionTestRunTraceParams added in v0.29.0 

type GetFunctionTestRunTraceParams struct {
	// Resource UUID.
	ID uuid.UUID
	// Function test run id returned by POST /functions/{id}/test.
	RunID uuid.UUID
}

GetFunctionTestRunTraceParams is parameters of getFunctionTestRunTrace operation.

type GetFunctionTestRunTraceRes added in v0.29.0 

type GetFunctionTestRunTraceRes interface {
	// contains filtered or unexported methods
}

type GetFunctionTestRunTraceUnauthorized added in v0.29.0 

type GetFunctionTestRunTraceUnauthorized ErrorResponse

func (*GetFunctionTestRunTraceUnauthorized) Decode added in v0.29.0 

func (s *GetFunctionTestRunTraceUnauthorized) Decode(d *jx.Decoder) error

Decode decodes GetFunctionTestRunTraceUnauthorized from json.

func (*GetFunctionTestRunTraceUnauthorized) Encode added in v0.29.0 

func (s *GetFunctionTestRunTraceUnauthorized) Encode(e *jx.Encoder)

Encode encodes GetFunctionTestRunTraceUnauthorized as json.

func (*GetFunctionTestRunTraceUnauthorized) MarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetFunctionTestRunTraceUnauthorized) UnmarshalJSON added in v0.29.0 

func (s *GetFunctionTestRunTraceUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetFunctionTestRunTraceUnauthorized) Validate added in v0.29.0 

func (s *GetFunctionTestRunTraceUnauthorized) Validate() error

type GetFunctionUnauthorized added in v0.20.0 

type GetFunctionUnauthorized ErrorResponse

func (*GetFunctionUnauthorized) Decode added in v0.20.0 

func (s *GetFunctionUnauthorized) Decode(d *jx.Decoder) error

Decode decodes GetFunctionUnauthorized from json.

func (*GetFunctionUnauthorized) Encode added in v0.20.0 

func (s *GetFunctionUnauthorized) Encode(e *jx.Encoder)

Encode encodes GetFunctionUnauthorized as json.

func (*GetFunctionUnauthorized) MarshalJSON added in v0.20.0 

func (s *GetFunctionUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetFunctionUnauthorized) UnmarshalJSON added in v0.20.0 

func (s *GetFunctionUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetFunctionUnauthorized) Validate added in v0.20.0 

func (s *GetFunctionUnauthorized) Validate() error

type GetInboxStatusOK added in v0.29.3 

type GetInboxStatusOK struct {
	Success bool        `json:"success"`
	Data    InboxStatus `json:"data"`
}

Merged schema.

func (*GetInboxStatusOK) Decode added in v0.29.3 

func (s *GetInboxStatusOK) Decode(d *jx.Decoder) error

Decode decodes GetInboxStatusOK from json.

func (*GetInboxStatusOK) Encode added in v0.29.3 

func (s *GetInboxStatusOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GetInboxStatusOK) GetData added in v0.29.3 

func (s *GetInboxStatusOK) GetData() InboxStatus

GetData returns the value of Data.

func (*GetInboxStatusOK) GetSuccess added in v0.29.3 

func (s *GetInboxStatusOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*GetInboxStatusOK) MarshalJSON added in v0.29.3 

func (s *GetInboxStatusOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetInboxStatusOK) SetData added in v0.29.3 

func (s *GetInboxStatusOK) SetData(val InboxStatus)

SetData sets the value of Data.

func (*GetInboxStatusOK) SetSuccess added in v0.29.3 

func (s *GetInboxStatusOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*GetInboxStatusOK) UnmarshalJSON added in v0.29.3 

func (s *GetInboxStatusOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetInboxStatusOK) Validate added in v0.29.3 

func (s *GetInboxStatusOK) Validate() error

type GetInboxStatusRes added in v0.29.3 

type GetInboxStatusRes interface {
	// contains filtered or unexported methods
}

type GetSendPermissionsOK added in v0.19.0 

type GetSendPermissionsOK struct {
	Success bool                 `json:"success"`
	Data    []SendPermissionRule `json:"data"`
	Meta    SendPermissionsMeta  `json:"meta"`
}

Merged schema.

func (*GetSendPermissionsOK) Decode added in v0.19.0 

func (s *GetSendPermissionsOK) Decode(d *jx.Decoder) error

Decode decodes GetSendPermissionsOK from json.

func (*GetSendPermissionsOK) Encode added in v0.19.0 

func (s *GetSendPermissionsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GetSendPermissionsOK) GetData added in v0.19.0 

func (s *GetSendPermissionsOK) GetData() []SendPermissionRule

GetData returns the value of Data.

func (*GetSendPermissionsOK) GetMeta added in v0.19.0 

func (s *GetSendPermissionsOK) GetMeta() SendPermissionsMeta

GetMeta returns the value of Meta.

func (*GetSendPermissionsOK) GetSuccess added in v0.19.0 

func (s *GetSendPermissionsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*GetSendPermissionsOK) MarshalJSON added in v0.19.0 

func (s *GetSendPermissionsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetSendPermissionsOK) SetData added in v0.19.0 

func (s *GetSendPermissionsOK) SetData(val []SendPermissionRule)

SetData sets the value of Data.

func (*GetSendPermissionsOK) SetMeta added in v0.19.0 

func (s *GetSendPermissionsOK) SetMeta(val SendPermissionsMeta)

SetMeta sets the value of Meta.

func (*GetSendPermissionsOK) SetSuccess added in v0.19.0 

func (s *GetSendPermissionsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*GetSendPermissionsOK) UnmarshalJSON added in v0.19.0 

func (s *GetSendPermissionsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetSendPermissionsOK) Validate added in v0.19.0 

func (s *GetSendPermissionsOK) Validate() error

type GetSendPermissionsRes added in v0.19.0 

type GetSendPermissionsRes interface {
	// contains filtered or unexported methods
}

type GetSentEmailBadRequest added in v0.19.0 

type GetSentEmailBadRequest ErrorResponse

func (*GetSentEmailBadRequest) Decode added in v0.19.0 

func (s *GetSentEmailBadRequest) Decode(d *jx.Decoder) error

Decode decodes GetSentEmailBadRequest from json.

func (*GetSentEmailBadRequest) Encode added in v0.19.0 

func (s *GetSentEmailBadRequest) Encode(e *jx.Encoder)

Encode encodes GetSentEmailBadRequest as json.

func (*GetSentEmailBadRequest) MarshalJSON added in v0.19.0 

func (s *GetSentEmailBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetSentEmailBadRequest) UnmarshalJSON added in v0.19.0 

func (s *GetSentEmailBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetSentEmailBadRequest) Validate added in v0.19.0 

func (s *GetSentEmailBadRequest) Validate() error

type GetSentEmailNotFound added in v0.19.0 

type GetSentEmailNotFound ErrorResponse

func (*GetSentEmailNotFound) Decode added in v0.19.0 

func (s *GetSentEmailNotFound) Decode(d *jx.Decoder) error

Decode decodes GetSentEmailNotFound from json.

func (*GetSentEmailNotFound) Encode added in v0.19.0 

func (s *GetSentEmailNotFound) Encode(e *jx.Encoder)

Encode encodes GetSentEmailNotFound as json.

func (*GetSentEmailNotFound) MarshalJSON added in v0.19.0 

func (s *GetSentEmailNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetSentEmailNotFound) UnmarshalJSON added in v0.19.0 

func (s *GetSentEmailNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetSentEmailNotFound) Validate added in v0.19.0 

func (s *GetSentEmailNotFound) Validate() error

type GetSentEmailOK added in v0.19.0 

type GetSentEmailOK struct {
	Success bool            `json:"success"`
	Data    SentEmailDetail `json:"data"`
}

Merged schema.

func (*GetSentEmailOK) Decode added in v0.19.0 

func (s *GetSentEmailOK) Decode(d *jx.Decoder) error

Decode decodes GetSentEmailOK from json.

func (*GetSentEmailOK) Encode added in v0.19.0 

func (s *GetSentEmailOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GetSentEmailOK) GetData added in v0.19.0 

func (s *GetSentEmailOK) GetData() SentEmailDetail

GetData returns the value of Data.

func (*GetSentEmailOK) GetSuccess added in v0.19.0 

func (s *GetSentEmailOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*GetSentEmailOK) MarshalJSON added in v0.19.0 

func (s *GetSentEmailOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetSentEmailOK) SetData added in v0.19.0 

func (s *GetSentEmailOK) SetData(val SentEmailDetail)

SetData sets the value of Data.

func (*GetSentEmailOK) SetSuccess added in v0.19.0 

func (s *GetSentEmailOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*GetSentEmailOK) UnmarshalJSON added in v0.19.0 

func (s *GetSentEmailOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetSentEmailOK) Validate added in v0.19.0 

func (s *GetSentEmailOK) Validate() error

type GetSentEmailParams added in v0.19.0 

type GetSentEmailParams struct {
	// Resource UUID.
	ID uuid.UUID
}

GetSentEmailParams is parameters of getSentEmail operation.

type GetSentEmailRes added in v0.19.0 

type GetSentEmailRes interface {
	// contains filtered or unexported methods
}

type GetSentEmailUnauthorized added in v0.19.0 

type GetSentEmailUnauthorized ErrorResponse

func (*GetSentEmailUnauthorized) Decode added in v0.19.0 

func (s *GetSentEmailUnauthorized) Decode(d *jx.Decoder) error

Decode decodes GetSentEmailUnauthorized from json.

func (*GetSentEmailUnauthorized) Encode added in v0.19.0 

func (s *GetSentEmailUnauthorized) Encode(e *jx.Encoder)

Encode encodes GetSentEmailUnauthorized as json.

func (*GetSentEmailUnauthorized) MarshalJSON added in v0.19.0 

func (s *GetSentEmailUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetSentEmailUnauthorized) UnmarshalJSON added in v0.19.0 

func (s *GetSentEmailUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetSentEmailUnauthorized) Validate added in v0.19.0 

func (s *GetSentEmailUnauthorized) Validate() error

type GetStorageStatsNotFound 

type GetStorageStatsNotFound ErrorResponse

func (*GetStorageStatsNotFound) Decode 

func (s *GetStorageStatsNotFound) Decode(d *jx.Decoder) error

Decode decodes GetStorageStatsNotFound from json.

func (*GetStorageStatsNotFound) Encode 

func (s *GetStorageStatsNotFound) Encode(e *jx.Encoder)

Encode encodes GetStorageStatsNotFound as json.

func (*GetStorageStatsNotFound) MarshalJSON 

func (s *GetStorageStatsNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetStorageStatsNotFound) UnmarshalJSON 

func (s *GetStorageStatsNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetStorageStatsNotFound) Validate 

func (s *GetStorageStatsNotFound) Validate() error

type GetStorageStatsOK 

type GetStorageStatsOK struct {
	Success bool         `json:"success"`
	Data    StorageStats `json:"data"`
}

Merged schema.

func (*GetStorageStatsOK) Decode 

func (s *GetStorageStatsOK) Decode(d *jx.Decoder) error

Decode decodes GetStorageStatsOK from json.

func (*GetStorageStatsOK) Encode 

func (s *GetStorageStatsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GetStorageStatsOK) GetData 

func (s *GetStorageStatsOK) GetData() StorageStats

GetData returns the value of Data.

func (*GetStorageStatsOK) GetSuccess 

func (s *GetStorageStatsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*GetStorageStatsOK) MarshalJSON 

func (s *GetStorageStatsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetStorageStatsOK) SetData 

func (s *GetStorageStatsOK) SetData(val StorageStats)

SetData sets the value of Data.

func (*GetStorageStatsOK) SetSuccess 

func (s *GetStorageStatsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*GetStorageStatsOK) UnmarshalJSON 

func (s *GetStorageStatsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetStorageStatsOK) Validate 

func (s *GetStorageStatsOK) Validate() error

type GetStorageStatsRes 

type GetStorageStatsRes interface {
	// contains filtered or unexported methods
}

type GetStorageStatsUnauthorized 

type GetStorageStatsUnauthorized ErrorResponse

func (*GetStorageStatsUnauthorized) Decode 

func (s *GetStorageStatsUnauthorized) Decode(d *jx.Decoder) error

Decode decodes GetStorageStatsUnauthorized from json.

func (*GetStorageStatsUnauthorized) Encode 

func (s *GetStorageStatsUnauthorized) Encode(e *jx.Encoder)

Encode encodes GetStorageStatsUnauthorized as json.

func (*GetStorageStatsUnauthorized) MarshalJSON 

func (s *GetStorageStatsUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetStorageStatsUnauthorized) UnmarshalJSON 

func (s *GetStorageStatsUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetStorageStatsUnauthorized) Validate 

func (s *GetStorageStatsUnauthorized) Validate() error

type GetWebhookSecretNotFound 

type GetWebhookSecretNotFound ErrorResponse

func (*GetWebhookSecretNotFound) Decode 

func (s *GetWebhookSecretNotFound) Decode(d *jx.Decoder) error

Decode decodes GetWebhookSecretNotFound from json.

func (*GetWebhookSecretNotFound) Encode 

func (s *GetWebhookSecretNotFound) Encode(e *jx.Encoder)

Encode encodes GetWebhookSecretNotFound as json.

func (*GetWebhookSecretNotFound) MarshalJSON 

func (s *GetWebhookSecretNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetWebhookSecretNotFound) UnmarshalJSON 

func (s *GetWebhookSecretNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetWebhookSecretNotFound) Validate 

func (s *GetWebhookSecretNotFound) Validate() error

type GetWebhookSecretOK 

type GetWebhookSecretOK struct {
	Success bool          `json:"success"`
	Data    WebhookSecret `json:"data"`
}

Merged schema.

func (*GetWebhookSecretOK) Decode 

func (s *GetWebhookSecretOK) Decode(d *jx.Decoder) error

Decode decodes GetWebhookSecretOK from json.

func (*GetWebhookSecretOK) Encode 

func (s *GetWebhookSecretOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*GetWebhookSecretOK) GetData 

func (s *GetWebhookSecretOK) GetData() WebhookSecret

GetData returns the value of Data.

func (*GetWebhookSecretOK) GetSuccess 

func (s *GetWebhookSecretOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*GetWebhookSecretOK) MarshalJSON 

func (s *GetWebhookSecretOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetWebhookSecretOK) SetData 

func (s *GetWebhookSecretOK) SetData(val WebhookSecret)

SetData sets the value of Data.

func (*GetWebhookSecretOK) SetSuccess 

func (s *GetWebhookSecretOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*GetWebhookSecretOK) UnmarshalJSON 

func (s *GetWebhookSecretOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type GetWebhookSecretRes 

type GetWebhookSecretRes interface {
	// contains filtered or unexported methods
}

type GetWebhookSecretUnauthorized 

type GetWebhookSecretUnauthorized ErrorResponse

func (*GetWebhookSecretUnauthorized) Decode 

func (s *GetWebhookSecretUnauthorized) Decode(d *jx.Decoder) error

Decode decodes GetWebhookSecretUnauthorized from json.

func (*GetWebhookSecretUnauthorized) Encode 

func (s *GetWebhookSecretUnauthorized) Encode(e *jx.Encoder)

Encode encodes GetWebhookSecretUnauthorized as json.

func (*GetWebhookSecretUnauthorized) MarshalJSON 

func (s *GetWebhookSecretUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetWebhookSecretUnauthorized) UnmarshalJSON 

func (s *GetWebhookSecretUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetWebhookSecretUnauthorized) Validate 

func (s *GetWebhookSecretUnauthorized) Validate() error

type Handler 

type Handler interface {
	// AddDomain implements addDomain operation.
	//
	// Creates an unverified domain claim and returns the exact
	// DNS records to publish in `dns_records`. Publish those
	// records before calling the verify endpoint. To give users
	// an importable DNS file, call `downloadDomainZoneFile` or run
	// `primitive domains zone-file --id <domain-id>`.
	//
	// POST /domains
	AddDomain(ctx context.Context, req *AddDomainInput) (AddDomainRes, error)
	// CliLogout implements cliLogout operation.
	//
	// Revokes the OAuth grant used to authenticate the request. API-key
	// authenticated legacy logout requests succeed without deleting server API
	// keys so old local CLI state can be cleared safely.
	//
	// POST /cli/logout
	CliLogout(ctx context.Context, req OptCliLogoutInput) (CliLogoutRes, error)
	// CreateEndpoint implements createEndpoint operation.
	//
	// Creates a new webhook endpoint. If a deactivated endpoint
	// with the same URL and domain exists, it is reactivated
	// instead. Subject to plan limits on the number of active
	// endpoints.
	// **Signing is account-scoped, not per-endpoint.** This call
	// does not return any signing material; every endpoint on the
	// account uses the same webhook secret, fetched via
	// `GET /account/webhook-secret`. See the API-level "Webhook
	// signing" section for the full wire format (header name,
	// signed string, hash algo, secret format, tolerance) and a
	// language-agnostic verification recipe.
	// After creating the endpoint, fire a test delivery against
	// it via `POST /endpoints/{id}/test` to confirm your verifier
	// accepts the signature.
	//
	// POST /endpoints
	CreateEndpoint(ctx context.Context, req *CreateEndpointInput) (CreateEndpointRes, error)
	// CreateFilter implements createFilter operation.
	//
	// Creates a new whitelist or blocklist filter. Per-domain filters
	// require a Pro plan. Patterns are stored as lowercase.
	//
	// POST /filters
	CreateFilter(ctx context.Context, req *CreateFilterInput) (CreateFilterRes, error)
	// CreateFunction implements createFunction operation.
	//
	// Creates and deploys a new function. The handler must be a single
	// ESM module whose default export is an object with an async
	// `fetch(request, env)` method (Workers-style). Primitive signs
	// each delivery and forwards the `Primitive-Signature` header to
	// the handler. Verify the raw request body with
	// `PRIMITIVE_WEBHOOK_SECRET` before parsing JSON; after verification
	// the request body parses to an `email.received` event (see
	// `EmailReceivedEvent` and the Webhook payload section for the full
	// schema). Code is bundled before being uploaded; ship a single
	// self-contained file rather than relying on external imports.
	// **Code limits.** `code` is capped at 1 MiB UTF-8. `sourceMap`
	// (optional) is capped at 5 MiB UTF-8, stored with each deployment
	// attempt, and sent to the runtime so stack traces can resolve to
	// original source files.
	// **Auto-wiring.** On successful deploy, Primitive automatically
	// creates a webhook endpoint that delivers inbound mail to the
	// function. There is nothing to configure on the Endpoints API
	// for this to work; the internal runtime URL is not returned by
	// the API and is not a customer-facing integration surface.
	// **Secrets.** New functions ship with the managed secrets
	// (`PRIMITIVE_WEBHOOK_SECRET`, `PRIMITIVE_API_KEY`,
	// `PRIMITIVE_API_BASE_URL`) already bound. Add user-set secrets via
	// `POST /functions/{id}/secrets`; secret writes only land in the
	// running handler on the next redeploy.
	//
	// POST /functions
	CreateFunction(ctx context.Context, req *CreateFunctionInput) (CreateFunctionRes, error)
	// CreateFunctionSecret implements createFunctionSecret operation.
	//
	// Idempotent insert-or-update keyed on `(function_id, key)`.
	// Returns 201 the first time the key is set, 200 on subsequent
	// updates. Values are encrypted at rest and only become visible
	// to the running handler on the next deploy (`PUT /functions/{id}`
	// with the existing code is sufficient to refresh bindings).
	// Keys must match `^[A-Z_][A-Z0-9_]*$` (uppercase letters,
	// digits, underscores; first character is a letter or
	// underscore). Values are at most 4096 UTF-8 bytes. System-
	// managed keys are reserved and rejected.
	//
	// POST /functions/{id}/secrets
	CreateFunctionSecret(ctx context.Context, req *CreateFunctionSecretInput, params CreateFunctionSecretParams) (CreateFunctionSecretRes, error)
	// DeleteDomain implements deleteDomain operation.
	//
	// Deletes a verified or unverified domain claim.
	//
	// DELETE /domains/{id}
	DeleteDomain(ctx context.Context, params DeleteDomainParams) (DeleteDomainRes, error)
	// DeleteEmail implements deleteEmail operation.
	//
	// Delete an email.
	//
	// DELETE /emails/{id}
	DeleteEmail(ctx context.Context, params DeleteEmailParams) (DeleteEmailRes, error)
	// DeleteEndpoint implements deleteEndpoint operation.
	//
	// Soft-deletes a webhook endpoint. The endpoint will no longer
	// receive webhook deliveries.
	//
	// DELETE /endpoints/{id}
	DeleteEndpoint(ctx context.Context, params DeleteEndpointParams) (DeleteEndpointRes, error)
	// DeleteFilter implements deleteFilter operation.
	//
	// Delete a filter rule.
	//
	// DELETE /filters/{id}
	DeleteFilter(ctx context.Context, params DeleteFilterParams) (DeleteFilterRes, error)
	// DeleteFunction implements deleteFunction operation.
	//
	// Soft-deletes the function row, removes the script from the edge
	// runtime, and deactivates the auto-wired webhook endpoint so no
	// further inbound mail is delivered. Past deploy history,
	// invocations, and logs are retained.
	// Returns 502 if the runtime delete fails partway; the function
	// row stays in place and the call is safe to retry until it
	// succeeds.
	//
	// DELETE /functions/{id}
	DeleteFunction(ctx context.Context, params DeleteFunctionParams) (DeleteFunctionRes, error)
	// DeleteFunctionSecret implements deleteFunctionSecret operation.
	//
	// Removes the secret. The binding stays live in the running
	// handler until the next deploy refreshes the binding set
	// (`PUT /functions/{id}` with the existing code is sufficient).
	// Returns 404 if the key did not exist. Managed system keys
	// cannot be deleted.
	//
	// DELETE /functions/{id}/secrets/{key}
	DeleteFunctionSecret(ctx context.Context, params DeleteFunctionSecretParams) (DeleteFunctionSecretRes, error)
	// DiscardEmailContent implements discardEmailContent operation.
	//
	// Permanently deletes the email's raw bytes, parsed body (text + HTML),
	// and attachments while preserving metadata (sender, recipient,
	// subject, timestamps, hashes, attachment manifest) for audit logs.
	// Idempotent: a second call returns success with
	// `already_discarded: true` and does no work.
	// **Gated** on the customer's discard-content opt-in (managed in the
	// dashboard at Settings > Webhooks). When the toggle is off, this
	// endpoint returns `403` with code `discard_not_enabled` and a
	// message pointing the human at the dashboard. There is intentionally
	// no API to flip this toggle. Opting in to a destructive,
	// non-reversible operation must be a deliberate human click in the
	// UI.
	//
	// POST /emails/{id}/discard-content
	DiscardEmailContent(ctx context.Context, params DiscardEmailContentParams) (DiscardEmailContentRes, error)
	// DownloadAttachments implements downloadAttachments operation.
	//
	// Downloads all attachments as a gzip-compressed tar archive.
	// Authenticates via a signed download token (provided in webhook
	// payloads) or a valid session.
	//
	// GET /emails/{id}/attachments.tar.gz
	DownloadAttachments(ctx context.Context, params DownloadAttachmentsParams) (DownloadAttachmentsRes, error)
	// DownloadDomainZoneFile implements downloadDomainZoneFile operation.
	//
	// Downloads a BIND-format DNS zone file containing the DNS records
	// required for a domain claim. Agents should offer this after
	// `addDomain` when users want to import DNS records instead of
	// copying each record manually.
	//
	// GET /domains/{id}/zone-file
	DownloadDomainZoneFile(ctx context.Context, params DownloadDomainZoneFileParams) (DownloadDomainZoneFileRes, error)
	// DownloadRawEmail implements downloadRawEmail operation.
	//
	// Downloads the raw RFC 822 email file (.eml). Authenticates via
	// a signed download token (provided in webhook payloads) or a
	// valid session.
	//
	// GET /emails/{id}/raw
	DownloadRawEmail(ctx context.Context, params DownloadRawEmailParams) (DownloadRawEmailRes, error)
	// GetAccount implements getAccount operation.
	//
	// Get account info.
	//
	// GET /account
	GetAccount(ctx context.Context) (GetAccountRes, error)
	// GetEmail implements getEmail operation.
	//
	// Returns the full record for an inbound email received at one
	// of your verified domains, including the parsed text and HTML
	// bodies, threading metadata, SMTP envelope detail, webhook
	// delivery state, and a `replies` array for any outbound sends
	// recorded as replies to this inbound.
	// For listing inbound emails (with cursor pagination, status
	// and date filters, and free-text search), use
	// `/emails`. Outbound (sent) email records are NOT returned
	// here; use `/sent-emails/{id}` for those.
	// The response carries four sender-shaped fields whose
	// meanings overlap. `from_email` is the canonical "who sent
	// this" field for most use cases (parsed bare address from
	// the `From:` header, with a `sender` fallback). `from_header`
	// is the raw header including any display name. `sender` and
	// `smtp_mail_from` both carry the SMTP envelope MAIL FROM
	// (return-path) and are equal by construction; `sender` is
	// the older field name retained for compatibility. See
	// `primitive describe emails:get-email | jq '.responseSchema.properties'`
	// for per-field detail.
	//
	// GET /emails/{id}
	GetEmail(ctx context.Context, params GetEmailParams) (GetEmailRes, error)
	// GetFunction implements getFunction operation.
	//
	// Returns the full record for a function, including its current
	// source code and the deploy status / error from the most recent
	// deploy attempt.
	//
	// GET /functions/{id}
	GetFunction(ctx context.Context, params GetFunctionParams) (GetFunctionRes, error)
	// GetFunctionTestRunTrace implements getFunctionTestRunTrace operation.
	//
	// Returns the current end-to-end trace for a function test run.
	// The trace is intentionally partial while the test is still in
	// flight: callers can poll this endpoint and watch it fill in
	// from send -> inbound -> webhook deliveries -> outbound
	// requests, logs, and replies.
	//
	// GET /functions/{id}/test-runs/{run_id}/trace
	GetFunctionTestRunTrace(ctx context.Context, params GetFunctionTestRunTraceParams) (GetFunctionTestRunTraceRes, error)
	// GetInboxStatus implements getInboxStatus operation.
	//
	// Returns one consolidated view of inbound domain readiness,
	// webhook/function processing routes, deployed Functions, and
	// recent inbound email activity.
	// Agents should call this before guiding a user through inbound
	// setup. It answers the practical questions "can I receive mail",
	// "will anything process that mail", and "what should I do next"
	// without forcing clients to stitch together domains, endpoints,
	// functions, and emails manually.
	//
	// GET /inbox/status
	GetInboxStatus(ctx context.Context) (GetInboxStatusRes, error)
	// GetSendPermissions implements getSendPermissions operation.
	//
	// Returns a flat list of rules describing every recipient the
	// caller may send to. Each rule has a `type`, a kind-specific
	// payload, and a human-readable `description`. If any rule
	// matches the recipient, /send-mail will accept the send under
	// the recipient-scope check.
	// The endpoint is the answer to "where can I send" without
	// exposing internal entitlement names. Agents that don't
	// recognize a `type` can still read the `description` prose
	// and act on it.
	// Rule kinds, ordered broadest-first so an agent can stop
	// scanning at the first match:
	// 1. `any_recipient` (one entry, only when the org can send
	// anywhere): every other rule below it is redundant.
	// 2. `managed_zone` (always emitted, one per Primitive-managed
	// zone): sends to any address at *.primitive.email or
	// *.email.works always succeed; no entitlement required.
	// 3. `your_domain` (one per active verified outbound domain
	// owned by the org): sends to that domain are approved.
	// 4. `address` (one per address that has authenticated
	// inbound mail to the org, capped at `meta.address_cap`):
	// sends to that exact address are approved.
	// The list is informational, not an authorization check.
	// /send-mail remains the source of truth on whether an
	// individual send will succeed (it also enforces the
	// from-address and the `send_mail` entitlement, which are
	// not recipient-scope concerns and are not represented here).
	//
	// GET /send-permissions
	GetSendPermissions(ctx context.Context) (GetSendPermissionsRes, error)
	// GetSentEmail implements getSentEmail operation.
	//
	// Returns the full sent-email record by id, including
	// `body_text` and `body_html` (omitted from the listing
	// endpoint to keep paginated responses small). Use this when
	// diagnosing a specific send, e.g. inspecting the receiver's
	// SMTP response on a `bounced` row or pulling the gate
	// denial detail on a `gate_denied` row.
	//
	// GET /sent-emails/{id}
	GetSentEmail(ctx context.Context, params GetSentEmailParams) (GetSentEmailRes, error)
	// GetStorageStats implements getStorageStats operation.
	//
	// Get storage usage.
	//
	// GET /account/storage
	GetStorageStats(ctx context.Context) (GetStorageStatsRes, error)
	// GetWebhookSecret implements getWebhookSecret operation.
	//
	// Returns the webhook signing secret for your account. If no
	// secret exists yet, one is generated automatically on first
	// access.
	// Signing is account-scoped, not per-endpoint. Every webhook
	// delivery from any of your registered endpoints is signed
	// with this single secret. Rotate via
	// `POST /account/webhook-secret/rotate`.
	// **Secret format**: the returned string looks base64-shaped
	// (e.g. `XNHBBW8VqoBjRfNs1tkZj11jTk...`) but is NOT base64.
	// Use it AS-IS as a UTF-8 string when computing HMAC over a
	// delivery body. Base64-decoding before HMAC will silently
	// produce mismatched signatures.
	// See the API-level "Webhook signing" section for the full
	// wire format (header name, signed string shape, hash algo,
	// tolerance) including a language-agnostic verification
	// recipe.
	//
	// GET /account/webhook-secret
	GetWebhookSecret(ctx context.Context) (GetWebhookSecretRes, error)
	// ListDeliveries implements listDeliveries operation.
	//
	// Returns a paginated list of webhook delivery attempts. Each delivery
	// includes a nested `email` object with sender, recipient, and subject.
	//
	// GET /webhooks/deliveries
	ListDeliveries(ctx context.Context, params ListDeliveriesParams) (ListDeliveriesRes, error)
	// ListDomains implements listDomains operation.
	//
	// Returns all verified and unverified domains for your organization,
	// sorted by creation date (newest first). Each domain includes a
	// `verified` boolean to distinguish between the two states.
	//
	// GET /domains
	ListDomains(ctx context.Context) (ListDomainsRes, error)
	// ListEmails implements listEmails operation.
	//
	// Returns a paginated list of INBOUND emails received at your
	// verified domains. Outbound messages sent via /send-mail are
	// not included; this endpoint is the inbox view, not a
	// unified send/receive history.
	// Supports filtering by domain, status, date range, and
	// free-text search across subject, sender, and recipient
	// fields.
	// For a compact text-table summary of the most recent N
	// inbounds (no filters, no cursor pagination), the CLI ships
	// `primitive emails:latest` as a one-line-per-email shortcut.
	// It's TTY-aware so id columns are full UUIDs when piped, and
	// a `--json` flag returns the same envelope this endpoint
	// does. Use whichever fits the call site.
	//
	// GET /emails
	ListEmails(ctx context.Context, params ListEmailsParams) (ListEmailsRes, error)
	// ListEndpoints implements listEndpoints operation.
	//
	// Returns all active (non-deleted) webhook endpoints.
	//
	// GET /endpoints
	ListEndpoints(ctx context.Context) (ListEndpointsRes, error)
	// ListFilters implements listFilters operation.
	//
	// Returns all whitelist and blocklist filter rules.
	//
	// GET /filters
	ListFilters(ctx context.Context) (ListFiltersRes, error)
	// ListFunctionLogs implements listFunctionLogs operation.
	//
	// Returns the most recent `function_logs` rows for the function,
	// newest first. Each row is a single `console.log` / `console.error`
	// invocation captured from the running handler.
	// Page through history with the opaque `cursor` returned as
	// `next_cursor`; pass it back as the `cursor` query param on the
	// next call. `next_cursor` is `null` when there are no further
	// rows. The cursor format is an implementation detail and should
	// not be parsed by callers.
	//
	// GET /functions/{id}/logs
	ListFunctionLogs(ctx context.Context, params ListFunctionLogsParams) (ListFunctionLogsRes, error)
	// ListFunctionSecrets implements listFunctionSecrets operation.
	//
	// Returns metadata for every secret bound to the function, with
	// managed entries (provisioned by Primitive) listed first and
	// user-set entries listed alphabetically after. **Values are
	// never returned.** Secret writes are write-only.
	// Managed entries (e.g. `PRIMITIVE_WEBHOOK_SECRET`,
	// `PRIMITIVE_API_KEY`, `PRIMITIVE_API_BASE_URL`) carry a
	// `description` instead of `created_at` / `updated_at`. They
	// cannot be created, updated, or deleted via this API.
	//
	// GET /functions/{id}/secrets
	ListFunctionSecrets(ctx context.Context, params ListFunctionSecretsParams) (ListFunctionSecretsRes, error)
	// ListFunctions implements listFunctions operation.
	//
	// Returns every active (non-deleted) function in the org, newest
	// first. Each entry carries deploy status and timestamps. To
	// inspect the source code or deploy errors, use `GET /functions/{id}`.
	//
	// GET /functions
	ListFunctions(ctx context.Context) (ListFunctionsRes, error)
	// ListSentEmails implements listSentEmails operation.
	//
	// Returns a paginated list of OUTBOUND emails the caller's
	// org has sent via /send-mail (and /emails/{id}/reply, which
	// forwards through /send-mail). Includes every recorded
	// attempt, including gate-denied attempts that the agent
	// never called and rows still in `queued` state.
	// For inbound mail received at your verified domains, see
	// /emails. There is no unified send/receive history endpoint;
	// the two surfaces are intentionally separate because the
	// underlying tables, statuses, and lifecycle differ.
	// Email bodies (`body_text`, `body_html`) are NOT included on
	// list rows so a 50-row page can't balloon into a multi-MB
	// response when sends are near the 5MB body cap. Use
	// /sent-emails/{id} to fetch a single row with bodies, or
	// cross-reference by `client_idempotency_key` if the caller
	// already has the body locally.
	//
	// GET /sent-emails
	ListSentEmails(ctx context.Context, params ListSentEmailsParams) (ListSentEmailsRes, error)
	// PollCliLogin implements pollCliLogin operation.
	//
	// Polls a CLI login session until the browser approval either succeeds,
	// is denied, expires, or is polled too quickly. The OAuth token set is
	// created only after approval and is returned exactly once.
	//
	// POST /cli/login/poll
	PollCliLogin(ctx context.Context, req *PollCliLoginInput) (PollCliLoginRes, error)
	// ReplayDelivery implements replayDelivery operation.
	//
	// Re-sends the stored webhook payload from a previous delivery attempt.
	// If the original endpoint is still active, it is targeted. If the
	// original endpoint was deleted, the oldest active endpoint is used.
	// Deactivated endpoints cannot be replayed to. Rate limited per-org,
	// sharing an org-wide budget with email replays.
	//
	// POST /webhooks/deliveries/{id}/replay
	ReplayDelivery(ctx context.Context, params ReplayDeliveryParams) (ReplayDeliveryRes, error)
	// ReplayEmailWebhooks implements replayEmailWebhooks operation.
	//
	// Re-delivers the webhook payload for this email to all active
	// endpoints matching the email's domain. Rate limited per-email
	// (short cooldown between successive replays of the same email)
	// and per-org (burst + sustained windows), sharing an org-wide
	// budget with delivery replays.
	//
	// POST /emails/{id}/replay
	ReplayEmailWebhooks(ctx context.Context, params ReplayEmailWebhooksParams) (ReplayEmailWebhooksRes, error)
	// ReplyToEmail implements replyToEmail operation.
	//
	// Sends an outbound reply to the inbound email identified by `id`.
	// Threading headers (`In-Reply-To`, `References`), recipient
	// derivation (Reply-To, then From, then bare sender), and the
	// `Re:` subject prefix are all derived server-side from the
	// stored inbound row. The request body carries only the message
	// body and optional `wait` flag; passing any header or recipient
	// override is rejected by the schema (`additionalProperties:
	// false`).
	// Forwards through the same gates as `/send-mail`: the response
	// status, error envelope, and `idempotent_replay` flag mirror
	// the send-mail contract verbatim.
	//
	// POST /emails/{id}/reply
	ReplyToEmail(ctx context.Context, req *ReplyInput, params ReplyToEmailParams) (ReplyToEmailRes, error)
	// ResendAgentSignupVerification implements resendAgentSignupVerification operation.
	//
	// Sends a new email verification code for a pending agent signup session.
	// This endpoint does not require an API key.
	//
	// POST /agent/signup/resend
	ResendAgentSignupVerification(ctx context.Context, req *ResendAgentSignupVerificationInput) (ResendAgentSignupVerificationRes, error)
	// ResendCliSignupVerification implements resendCliSignupVerification operation.
	//
	// Sends a new email verification code for a pending CLI signup session.
	// This endpoint does not require an API key.
	//
	// POST /cli/signup/resend
	ResendCliSignupVerification(ctx context.Context, req *ResendCliSignupVerificationInput) (ResendCliSignupVerificationRes, error)
	// RotateWebhookSecret implements rotateWebhookSecret operation.
	//
	// Generates a new webhook signing secret, replacing the current one.
	// Rate limited to once per 60 minutes.
	//
	// POST /account/webhook-secret/rotate
	RotateWebhookSecret(ctx context.Context) (RotateWebhookSecretRes, error)
	// SearchEmails implements searchEmails operation.
	//
	// Searches inbound emails with structured filters and optional
	// full-text matching across parsed email fields. This endpoint is
	// optimized for filtered inbox views and CLI polling workflows:
	// callers that only need new accepted mail can pass
	// `sort=received_at_asc`, `snippet=false`, `include_facets=false`,
	// and a `date_from` timestamp.
	// `q`, `subject`, and `body` use the same English full-text index
	// as the web inbox search. Structured filters such as `from`, `to`,
	// `domain_id`, status, attachment presence, and spam score bounds
	// are combined with the text query.
	//
	// GET /emails/search
	SearchEmails(ctx context.Context, params SearchEmailsParams) (SearchEmailsRes, error)
	// SendEmail implements sendEmail operation.
	//
	// Sends an outbound email through Primitive's outbound relay. By default
	// the request returns once the relay accepts the message for delivery.
	// Set `wait: true` to wait for the first downstream SMTP delivery outcome.
	// **Host routing.** /send-mail is served by the attachments-
	// supporting host (`https://api.primitive.dev/v1`) so the
	// request body can carry inline attachments up to ~30 MiB raw.
	// The primary host (`https://www.primitive.dev/api/v1`) also
	// accepts /send-mail for attachment-free sends; sends WITH
	// attachments to the primary host return 413
	// `attachments_unsupported_on_this_endpoint`. The typed SDKs
	// route /send-mail to the attachments host automatically.
	//
	// POST /send-mail
	SendEmail(ctx context.Context, req *SendMailInput, params SendEmailParams) (SendEmailRes, error)
	// SetFunctionSecret implements setFunctionSecret operation.
	//
	// Path-keyed companion to `POST /functions/{id}/secrets`.
	// Idempotent: returns 201 the first time the key is set, 200 on
	// subsequent updates. Same validation rules and same write-only
	// guarantees as the POST verb; the new value lands in the running
	// handler on the next deploy.
	//
	// PUT /functions/{id}/secrets/{key}
	SetFunctionSecret(ctx context.Context, req *SetFunctionSecretInput, params SetFunctionSecretParams) (SetFunctionSecretRes, error)
	// StartAgentSignup implements startAgentSignup operation.
	//
	// Starts an agent-native signup session. The API validates the signup code,
	// creates a pending signup session, sends an email verification code, and
	// returns an opaque signup token used by the resend and verify steps. This
	// endpoint does not require an API key.
	//
	// POST /agent/signup/start
	StartAgentSignup(ctx context.Context, req *StartAgentSignupInput) (StartAgentSignupRes, error)
	// StartCliLogin implements startCliLogin operation.
	//
	// Starts a browser-assisted CLI login session. The response includes a
	// device code for polling and a user code that the user approves in the
	// browser. This endpoint does not require an API key.
	//
	// POST /cli/login/start
	StartCliLogin(ctx context.Context, req OptStartCliLoginInput) (StartCliLoginRes, error)
	// StartCliSignup implements startCliSignup operation.
	//
	// Starts a terminal-native CLI signup. The API validates the signup code,
	// creates a pending signup session, sends an email verification code, and
	// returns an opaque signup token used by the resend and verify steps. This
	// endpoint does not require an API key.
	//
	// POST /cli/signup/start
	StartCliSignup(ctx context.Context, req *StartCliSignupInput) (StartCliSignupRes, error)
	// TestEndpoint implements testEndpoint operation.
	//
	// Sends a sample `email.received` event to the endpoint. The request
	// includes SSRF protection (private IP rejection and DNS pinning).
	// Rate limited to 4 per minute and 30 per hour (non-exempt).
	// Successful deliveries and verified-domain endpoints are exempt
	// from the rate limit.
	//
	// POST /endpoints/{id}/test
	TestEndpoint(ctx context.Context, params TestEndpointParams) (TestEndpointRes, error)
	// TestFunction implements testFunction operation.
	//
	// Sends a real test email from a Primitive-controlled sender to a
	// local-part on one of the org's verified inbound domains. By
	// default the recipient is a synthetic
	// `__primitive_function_test+<random>@<domain>` address on a
	// domain selected to route to the function. Scoped functions use
	// their scoped domain; fallback functions use a domain that has
	// no enabled domain-scoped endpoint. Pass `local_part` to
	// override and exercise routing logic that branches on a specific
	// recipient (the common pattern when one function handles multiple
	// inboxes like `summarize@` and `action@`). The function fires
	// through the normal MX delivery path, so reply / send-mail calls
	// from inside the handler against the inbound's `email.id` work
	// the same as in production. Returns immediately after the send is
	// queued; the invocation appears on the function's invocations
	// list within a few seconds.
	// Requires that the function is currently `deployed`. Returns 422
	// if the function is in `pending` or `failed` state, or if the
	// org has no verified inbound domain to receive the test mail.
	// Returns 400 if `local_part` is set to a value that does not
	// match the local-part character set.
	//
	// POST /functions/{id}/test
	TestFunction(ctx context.Context, req OptTestFunctionReq, params TestFunctionParams) (TestFunctionRes, error)
	// UpdateAccount implements updateAccount operation.
	//
	// Update account settings.
	//
	// PATCH /account
	UpdateAccount(ctx context.Context, req *UpdateAccountInput) (UpdateAccountRes, error)
	// UpdateDomain implements updateDomain operation.
	//
	// Update a verified domain's settings. Only verified domains can be
	// updated. Per-domain spam thresholds require a Pro plan.
	//
	// PATCH /domains/{id}
	UpdateDomain(ctx context.Context, req *UpdateDomainInput, params UpdateDomainParams) (UpdateDomainRes, error)
	// UpdateEndpoint implements updateEndpoint operation.
	//
	// Updates an active webhook endpoint. If the URL is changed, the old
	// endpoint is deactivated and a new one is created (or an existing
	// deactivated endpoint with the new URL is reactivated).
	//
	// PATCH /endpoints/{id}
	UpdateEndpoint(ctx context.Context, req *UpdateEndpointInput, params UpdateEndpointParams) (UpdateEndpointRes, error)
	// UpdateFilter implements updateFilter operation.
	//
	// Toggle a filter's enabled state.
	//
	// PATCH /filters/{id}
	UpdateFilter(ctx context.Context, req *UpdateFilterInput, params UpdateFilterParams) (UpdateFilterRes, error)
	// UpdateFunction implements updateFunction operation.
	//
	// Replaces the function's source code with the body's `code` and
	// triggers a redeploy. Same size limits as `POST /functions`.
	// Use this verb to push secret writes into the running handler:
	// passing the same `code` re-runs the deploy and refreshes the
	// binding set with the latest values from the secrets table.
	// On deploy failure, the previously-deployed code stays live; the
	// runtime never serves a half-built bundle. The response uses
	// `error.code` `deploy_failed`, and the function's `deploy_error`
	// field carries the latest deploy error for dashboard/API reads.
	//
	// PUT /functions/{id}
	UpdateFunction(ctx context.Context, req *UpdateFunctionInput, params UpdateFunctionParams) (UpdateFunctionRes, error)
	// VerifyAgentSignup implements verifyAgentSignup operation.
	//
	// Verifies the email code for an agent signup session, creates the account
	// when needed, redeems the reserved signup code, mints an org-scoped OAuth
	// session for CLI authentication, and returns the raw tokens exactly once.
	// For existing users, the optional `org_id` selects which accessible
	// workspace should receive the new session.
	//
	// POST /agent/signup/verify
	VerifyAgentSignup(ctx context.Context, req *VerifyAgentSignupInput) (VerifyAgentSignupRes, error)
	// VerifyCliSignup implements verifyCliSignup operation.
	//
	// Verifies the email code for a CLI signup session, creates the account,
	// redeems the reserved signup code, creates an org-scoped OAuth CLI
	// session, and returns the token set exactly once. This endpoint does not
	// require an API key.
	//
	// POST /cli/signup/verify
	VerifyCliSignup(ctx context.Context, req *VerifyCliSignupInput) (VerifyCliSignupRes, error)
	// VerifyDomain implements verifyDomain operation.
	//
	// Checks DNS records required for inbound routing, ownership,
	// and outbound authentication: MX, ownership TXT, SPF, DKIM,
	// DMARC, and TLS-RPT.
	// On success, the domain is promoted from unverified to verified.
	// On failure, returns which checks passed and which failed,
	// plus the exact DNS records still expected. To give users
	// an importable DNS file for missing records, call
	// `downloadDomainZoneFile` or run
	// `primitive domains zone-file --id <domain-id>`.
	//
	// POST /domains/{id}/verify
	VerifyDomain(ctx context.Context, params VerifyDomainParams) (VerifyDomainRes, error)
}

Handler handles operations described by OpenAPI v3 specification.

type InboxStatus added in v0.29.3 

type InboxStatus struct {
	// True when at least one active inbound domain has an enabled processing route.
	Ready bool `json:"ready"`
	// True when at least one active verified or managed domain can receive mail.
	ReceivingReady bool `json:"receiving_ready"`
	// True when at least one receiving-ready domain has an enabled webhook or function route.
	ProcessingReady bool `json:"processing_ready"`
	// Short human-readable status summary.
	Summary      string                        `json:"summary"`
	NextActions  []InboxStatusNextAction       `json:"next_actions"`
	Domains      []InboxStatusDomain           `json:"domains"`
	Endpoints    InboxStatusEndpointSummary    `json:"endpoints"`
	Functions    InboxStatusFunctionSummary    `json:"functions"`
	RecentEmails InboxStatusRecentEmailSummary `json:"recent_emails"`
}

Ref: #/components/schemas/InboxStatus

func (*InboxStatus) Decode added in v0.29.3 

func (s *InboxStatus) Decode(d *jx.Decoder) error

Decode decodes InboxStatus from json.

func (*InboxStatus) Encode added in v0.29.3 

func (s *InboxStatus) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*InboxStatus) GetDomains added in v0.29.3 

func (s *InboxStatus) GetDomains() []InboxStatusDomain

GetDomains returns the value of Domains.

func (*InboxStatus) GetEndpoints added in v0.29.3 

func (s *InboxStatus) GetEndpoints() InboxStatusEndpointSummary

GetEndpoints returns the value of Endpoints.

func (*InboxStatus) GetFunctions added in v0.29.3 

func (s *InboxStatus) GetFunctions() InboxStatusFunctionSummary

GetFunctions returns the value of Functions.

func (*InboxStatus) GetNextActions added in v0.29.3 

func (s *InboxStatus) GetNextActions() []InboxStatusNextAction

GetNextActions returns the value of NextActions.

func (*InboxStatus) GetProcessingReady added in v0.29.3 

func (s *InboxStatus) GetProcessingReady() bool

GetProcessingReady returns the value of ProcessingReady.

func (*InboxStatus) GetReady added in v0.29.3 

func (s *InboxStatus) GetReady() bool

GetReady returns the value of Ready.

func (*InboxStatus) GetReceivingReady added in v0.29.3 

func (s *InboxStatus) GetReceivingReady() bool

GetReceivingReady returns the value of ReceivingReady.

func (*InboxStatus) GetRecentEmails added in v0.29.3 

func (s *InboxStatus) GetRecentEmails() InboxStatusRecentEmailSummary

GetRecentEmails returns the value of RecentEmails.

func (*InboxStatus) GetSummary added in v0.29.3 

func (s *InboxStatus) GetSummary() string

GetSummary returns the value of Summary.

func (*InboxStatus) MarshalJSON added in v0.29.3 

func (s *InboxStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*InboxStatus) SetDomains added in v0.29.3 

func (s *InboxStatus) SetDomains(val []InboxStatusDomain)

SetDomains sets the value of Domains.

func (*InboxStatus) SetEndpoints added in v0.29.3 

func (s *InboxStatus) SetEndpoints(val InboxStatusEndpointSummary)

SetEndpoints sets the value of Endpoints.

func (*InboxStatus) SetFunctions added in v0.29.3 

func (s *InboxStatus) SetFunctions(val InboxStatusFunctionSummary)

SetFunctions sets the value of Functions.

func (*InboxStatus) SetNextActions added in v0.29.3 

func (s *InboxStatus) SetNextActions(val []InboxStatusNextAction)

SetNextActions sets the value of NextActions.

func (*InboxStatus) SetProcessingReady added in v0.29.3 

func (s *InboxStatus) SetProcessingReady(val bool)

SetProcessingReady sets the value of ProcessingReady.

func (*InboxStatus) SetReady added in v0.29.3 

func (s *InboxStatus) SetReady(val bool)

SetReady sets the value of Ready.

func (*InboxStatus) SetReceivingReady added in v0.29.3 

func (s *InboxStatus) SetReceivingReady(val bool)

SetReceivingReady sets the value of ReceivingReady.

func (*InboxStatus) SetRecentEmails added in v0.29.3 

func (s *InboxStatus) SetRecentEmails(val InboxStatusRecentEmailSummary)

SetRecentEmails sets the value of RecentEmails.

func (*InboxStatus) SetSummary added in v0.29.3 

func (s *InboxStatus) SetSummary(val string)

SetSummary sets the value of Summary.

func (*InboxStatus) UnmarshalJSON added in v0.29.3 

func (s *InboxStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*InboxStatus) Validate added in v0.29.3 

func (s *InboxStatus) Validate() error

type InboxStatusDomain added in v0.29.3 

type InboxStatusDomain struct {
	ID                    string `json:"id"`
	Domain                string `json:"domain"`
	Verified              bool   `json:"verified"`
	Active                bool   `json:"active"`
	Managed               bool   `json:"managed"`
	ReceivingReady        bool   `json:"receiving_ready"`
	ProcessingReady       bool   `json:"processing_ready"`
	ProcessingRouteCount  int    `json:"processing_route_count"`
	EndpointCount         int    `json:"endpoint_count"`
	EnabledEndpointCount  int    `json:"enabled_endpoint_count"`
	FunctionEndpointCount int    `json:"function_endpoint_count"`
	// Number of inbound emails received for this domain in the last 30 days.
	EmailCount int `json:"email_count"`
	// Most recent inbound email received for this domain in the last 30 days.
	LatestEmailReceivedAt NilDateTime             `json:"latest_email_received_at"`
	Status                InboxStatusDomainStatus `json:"status"`
}

Ref: #/components/schemas/InboxStatusDomain

func (*InboxStatusDomain) Decode added in v0.29.3 

func (s *InboxStatusDomain) Decode(d *jx.Decoder) error

Decode decodes InboxStatusDomain from json.

func (*InboxStatusDomain) Encode added in v0.29.3 

func (s *InboxStatusDomain) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*InboxStatusDomain) GetActive added in v0.29.3 

func (s *InboxStatusDomain) GetActive() bool

GetActive returns the value of Active.

func (*InboxStatusDomain) GetDomain added in v0.29.3 

func (s *InboxStatusDomain) GetDomain() string

GetDomain returns the value of Domain.

func (*InboxStatusDomain) GetEmailCount added in v0.29.3 

func (s *InboxStatusDomain) GetEmailCount() int

GetEmailCount returns the value of EmailCount.

func (*InboxStatusDomain) GetEnabledEndpointCount added in v0.29.3 

func (s *InboxStatusDomain) GetEnabledEndpointCount() int

GetEnabledEndpointCount returns the value of EnabledEndpointCount.

func (*InboxStatusDomain) GetEndpointCount added in v0.29.3 

func (s *InboxStatusDomain) GetEndpointCount() int

GetEndpointCount returns the value of EndpointCount.

func (*InboxStatusDomain) GetFunctionEndpointCount added in v0.29.3 

func (s *InboxStatusDomain) GetFunctionEndpointCount() int

GetFunctionEndpointCount returns the value of FunctionEndpointCount.

func (*InboxStatusDomain) GetID added in v0.29.3 

func (s *InboxStatusDomain) GetID() string

GetID returns the value of ID.

func (*InboxStatusDomain) GetLatestEmailReceivedAt added in v0.29.3 

func (s *InboxStatusDomain) GetLatestEmailReceivedAt() NilDateTime

GetLatestEmailReceivedAt returns the value of LatestEmailReceivedAt.

func (*InboxStatusDomain) GetManaged added in v0.29.3 

func (s *InboxStatusDomain) GetManaged() bool

GetManaged returns the value of Managed.

func (*InboxStatusDomain) GetProcessingReady added in v0.29.3 

func (s *InboxStatusDomain) GetProcessingReady() bool

GetProcessingReady returns the value of ProcessingReady.

func (*InboxStatusDomain) GetProcessingRouteCount added in v0.29.3 

func (s *InboxStatusDomain) GetProcessingRouteCount() int

GetProcessingRouteCount returns the value of ProcessingRouteCount.

func (*InboxStatusDomain) GetReceivingReady added in v0.29.3 

func (s *InboxStatusDomain) GetReceivingReady() bool

GetReceivingReady returns the value of ReceivingReady.

func (*InboxStatusDomain) GetStatus added in v0.29.3 

func (s *InboxStatusDomain) GetStatus() InboxStatusDomainStatus

GetStatus returns the value of Status.

func (*InboxStatusDomain) GetVerified added in v0.29.3 

func (s *InboxStatusDomain) GetVerified() bool

GetVerified returns the value of Verified.

func (*InboxStatusDomain) MarshalJSON added in v0.29.3 

func (s *InboxStatusDomain) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*InboxStatusDomain) SetActive added in v0.29.3 

func (s *InboxStatusDomain) SetActive(val bool)

SetActive sets the value of Active.

func (*InboxStatusDomain) SetDomain added in v0.29.3 

func (s *InboxStatusDomain) SetDomain(val string)

SetDomain sets the value of Domain.

func (*InboxStatusDomain) SetEmailCount added in v0.29.3 

func (s *InboxStatusDomain) SetEmailCount(val int)

SetEmailCount sets the value of EmailCount.

func (*InboxStatusDomain) SetEnabledEndpointCount added in v0.29.3 

func (s *InboxStatusDomain) SetEnabledEndpointCount(val int)

SetEnabledEndpointCount sets the value of EnabledEndpointCount.

func (*InboxStatusDomain) SetEndpointCount added in v0.29.3 

func (s *InboxStatusDomain) SetEndpointCount(val int)

SetEndpointCount sets the value of EndpointCount.

func (*InboxStatusDomain) SetFunctionEndpointCount added in v0.29.3 

func (s *InboxStatusDomain) SetFunctionEndpointCount(val int)

SetFunctionEndpointCount sets the value of FunctionEndpointCount.

func (*InboxStatusDomain) SetID added in v0.29.3 

func (s *InboxStatusDomain) SetID(val string)

SetID sets the value of ID.

func (*InboxStatusDomain) SetLatestEmailReceivedAt added in v0.29.3 

func (s *InboxStatusDomain) SetLatestEmailReceivedAt(val NilDateTime)

SetLatestEmailReceivedAt sets the value of LatestEmailReceivedAt.

func (*InboxStatusDomain) SetManaged added in v0.29.3 

func (s *InboxStatusDomain) SetManaged(val bool)

SetManaged sets the value of Managed.

func (*InboxStatusDomain) SetProcessingReady added in v0.29.3 

func (s *InboxStatusDomain) SetProcessingReady(val bool)

SetProcessingReady sets the value of ProcessingReady.

func (*InboxStatusDomain) SetProcessingRouteCount added in v0.29.3 

func (s *InboxStatusDomain) SetProcessingRouteCount(val int)

SetProcessingRouteCount sets the value of ProcessingRouteCount.

func (*InboxStatusDomain) SetReceivingReady added in v0.29.3 

func (s *InboxStatusDomain) SetReceivingReady(val bool)

SetReceivingReady sets the value of ReceivingReady.

func (*InboxStatusDomain) SetStatus added in v0.29.3 

func (s *InboxStatusDomain) SetStatus(val InboxStatusDomainStatus)

SetStatus sets the value of Status.

func (*InboxStatusDomain) SetVerified added in v0.29.3 

func (s *InboxStatusDomain) SetVerified(val bool)

SetVerified sets the value of Verified.

func (*InboxStatusDomain) UnmarshalJSON added in v0.29.3 

func (s *InboxStatusDomain) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*InboxStatusDomain) Validate added in v0.29.3 

func (s *InboxStatusDomain) Validate() error

type InboxStatusDomainStatus added in v0.29.3 

type InboxStatusDomainStatus string
const (
	InboxStatusDomainStatusReady      InboxStatusDomainStatus = "ready"
	InboxStatusDomainStatusStoredOnly InboxStatusDomainStatus = "stored_only"
	InboxStatusDomainStatusPendingDNS InboxStatusDomainStatus = "pending_dns"
	InboxStatusDomainStatusInactive   InboxStatusDomainStatus = "inactive"
)

func (InboxStatusDomainStatus) AllValues added in v0.29.3 

func (InboxStatusDomainStatus) AllValues() []InboxStatusDomainStatus

AllValues returns all InboxStatusDomainStatus values.

func (*InboxStatusDomainStatus) Decode added in v0.29.3 

func (s *InboxStatusDomainStatus) Decode(d *jx.Decoder) error

Decode decodes InboxStatusDomainStatus from json.

func (InboxStatusDomainStatus) Encode added in v0.29.3 

func (s InboxStatusDomainStatus) Encode(e *jx.Encoder)

Encode encodes InboxStatusDomainStatus as json.

func (InboxStatusDomainStatus) MarshalJSON added in v0.29.3 

func (s InboxStatusDomainStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (InboxStatusDomainStatus) MarshalText added in v0.29.3 

func (s InboxStatusDomainStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*InboxStatusDomainStatus) UnmarshalJSON added in v0.29.3 

func (s *InboxStatusDomainStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*InboxStatusDomainStatus) UnmarshalText added in v0.29.3 

func (s *InboxStatusDomainStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (InboxStatusDomainStatus) Validate added in v0.29.3 

func (s InboxStatusDomainStatus) Validate() error

type InboxStatusEndpointSummary added in v0.29.3 

type InboxStatusEndpointSummary struct {
	Total               int `json:"total"`
	Enabled             int `json:"enabled"`
	Disabled            int `json:"disabled"`
	FallbackEnabled     int `json:"fallback_enabled"`
	DomainScopedEnabled int `json:"domain_scoped_enabled"`
	HTTPEnabled         int `json:"http_enabled"`
	FunctionEnabled     int `json:"function_enabled"`
}

Ref: #/components/schemas/InboxStatusEndpointSummary

func (*InboxStatusEndpointSummary) Decode added in v0.29.3 

func (s *InboxStatusEndpointSummary) Decode(d *jx.Decoder) error

Decode decodes InboxStatusEndpointSummary from json.

func (*InboxStatusEndpointSummary) Encode added in v0.29.3 

func (s *InboxStatusEndpointSummary) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*InboxStatusEndpointSummary) GetDisabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) GetDisabled() int

GetDisabled returns the value of Disabled.

func (*InboxStatusEndpointSummary) GetDomainScopedEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) GetDomainScopedEnabled() int

GetDomainScopedEnabled returns the value of DomainScopedEnabled.

func (*InboxStatusEndpointSummary) GetEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) GetEnabled() int

GetEnabled returns the value of Enabled.

func (*InboxStatusEndpointSummary) GetFallbackEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) GetFallbackEnabled() int

GetFallbackEnabled returns the value of FallbackEnabled.

func (*InboxStatusEndpointSummary) GetFunctionEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) GetFunctionEnabled() int

GetFunctionEnabled returns the value of FunctionEnabled.

func (*InboxStatusEndpointSummary) GetHTTPEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) GetHTTPEnabled() int

GetHTTPEnabled returns the value of HTTPEnabled.

func (*InboxStatusEndpointSummary) GetTotal added in v0.29.3 

func (s *InboxStatusEndpointSummary) GetTotal() int

GetTotal returns the value of Total.

func (*InboxStatusEndpointSummary) MarshalJSON added in v0.29.3 

func (s *InboxStatusEndpointSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*InboxStatusEndpointSummary) SetDisabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) SetDisabled(val int)

SetDisabled sets the value of Disabled.

func (*InboxStatusEndpointSummary) SetDomainScopedEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) SetDomainScopedEnabled(val int)

SetDomainScopedEnabled sets the value of DomainScopedEnabled.

func (*InboxStatusEndpointSummary) SetEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) SetEnabled(val int)

SetEnabled sets the value of Enabled.

func (*InboxStatusEndpointSummary) SetFallbackEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) SetFallbackEnabled(val int)

SetFallbackEnabled sets the value of FallbackEnabled.

func (*InboxStatusEndpointSummary) SetFunctionEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) SetFunctionEnabled(val int)

SetFunctionEnabled sets the value of FunctionEnabled.

func (*InboxStatusEndpointSummary) SetHTTPEnabled added in v0.29.3 

func (s *InboxStatusEndpointSummary) SetHTTPEnabled(val int)

SetHTTPEnabled sets the value of HTTPEnabled.

func (*InboxStatusEndpointSummary) SetTotal added in v0.29.3 

func (s *InboxStatusEndpointSummary) SetTotal(val int)

SetTotal sets the value of Total.

func (*InboxStatusEndpointSummary) UnmarshalJSON added in v0.29.3 

func (s *InboxStatusEndpointSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type InboxStatusFunctionSummary added in v0.29.3 

type InboxStatusFunctionSummary struct {
	Total    int `json:"total"`
	Deployed int `json:"deployed"`
	Pending  int `json:"pending"`
	Failed   int `json:"failed"`
}

Ref: #/components/schemas/InboxStatusFunctionSummary

func (*InboxStatusFunctionSummary) Decode added in v0.29.3 

func (s *InboxStatusFunctionSummary) Decode(d *jx.Decoder) error

Decode decodes InboxStatusFunctionSummary from json.

func (*InboxStatusFunctionSummary) Encode added in v0.29.3 

func (s *InboxStatusFunctionSummary) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*InboxStatusFunctionSummary) GetDeployed added in v0.29.3 

func (s *InboxStatusFunctionSummary) GetDeployed() int

GetDeployed returns the value of Deployed.

func (*InboxStatusFunctionSummary) GetFailed added in v0.29.3 

func (s *InboxStatusFunctionSummary) GetFailed() int

GetFailed returns the value of Failed.

func (*InboxStatusFunctionSummary) GetPending added in v0.29.3 

func (s *InboxStatusFunctionSummary) GetPending() int

GetPending returns the value of Pending.

func (*InboxStatusFunctionSummary) GetTotal added in v0.29.3 

func (s *InboxStatusFunctionSummary) GetTotal() int

GetTotal returns the value of Total.

func (*InboxStatusFunctionSummary) MarshalJSON added in v0.29.3 

func (s *InboxStatusFunctionSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*InboxStatusFunctionSummary) SetDeployed added in v0.29.3 

func (s *InboxStatusFunctionSummary) SetDeployed(val int)

SetDeployed sets the value of Deployed.

func (*InboxStatusFunctionSummary) SetFailed added in v0.29.3 

func (s *InboxStatusFunctionSummary) SetFailed(val int)

SetFailed sets the value of Failed.

func (*InboxStatusFunctionSummary) SetPending added in v0.29.3 

func (s *InboxStatusFunctionSummary) SetPending(val int)

SetPending sets the value of Pending.

func (*InboxStatusFunctionSummary) SetTotal added in v0.29.3 

func (s *InboxStatusFunctionSummary) SetTotal(val int)

SetTotal sets the value of Total.

func (*InboxStatusFunctionSummary) UnmarshalJSON added in v0.29.3 

func (s *InboxStatusFunctionSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type InboxStatusNextAction added in v0.29.3 

type InboxStatusNextAction struct {
	Kind InboxStatusNextActionKind `json:"kind"`
	// Human-readable next step.
	Message string `json:"message"`
	// Suggested Primitive CLI command when there is an obvious next step.
	Command OptString `json:"command"`
}

Ref: #/components/schemas/InboxStatusNextAction

func (*InboxStatusNextAction) Decode added in v0.29.3 

func (s *InboxStatusNextAction) Decode(d *jx.Decoder) error

Decode decodes InboxStatusNextAction from json.

func (*InboxStatusNextAction) Encode added in v0.29.3 

func (s *InboxStatusNextAction) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*InboxStatusNextAction) GetCommand added in v0.29.3 

func (s *InboxStatusNextAction) GetCommand() OptString

GetCommand returns the value of Command.

func (*InboxStatusNextAction) GetKind added in v0.29.3 

func (s *InboxStatusNextAction) GetKind() InboxStatusNextActionKind

GetKind returns the value of Kind.

func (*InboxStatusNextAction) GetMessage added in v0.29.3 

func (s *InboxStatusNextAction) GetMessage() string

GetMessage returns the value of Message.

func (*InboxStatusNextAction) MarshalJSON added in v0.29.3 

func (s *InboxStatusNextAction) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*InboxStatusNextAction) SetCommand added in v0.29.3 

func (s *InboxStatusNextAction) SetCommand(val OptString)

SetCommand sets the value of Command.

func (*InboxStatusNextAction) SetKind added in v0.29.3 

func (s *InboxStatusNextAction) SetKind(val InboxStatusNextActionKind)

SetKind sets the value of Kind.

func (*InboxStatusNextAction) SetMessage added in v0.29.3 

func (s *InboxStatusNextAction) SetMessage(val string)

SetMessage sets the value of Message.

func (*InboxStatusNextAction) UnmarshalJSON added in v0.29.3 

func (s *InboxStatusNextAction) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*InboxStatusNextAction) Validate added in v0.29.3 

func (s *InboxStatusNextAction) Validate() error

type InboxStatusNextActionKind added in v0.29.3 

type InboxStatusNextActionKind string
const (
	InboxStatusNextActionKindAddDomain           InboxStatusNextActionKind = "add_domain"
	InboxStatusNextActionKindVerifyDomain        InboxStatusNextActionKind = "verify_domain"
	InboxStatusNextActionKindConfigureProcessing InboxStatusNextActionKind = "configure_processing"
	InboxStatusNextActionKindSendTestEmail       InboxStatusNextActionKind = "send_test_email"
	InboxStatusNextActionKindFixFailedFunctions  InboxStatusNextActionKind = "fix_failed_functions"
)

func (InboxStatusNextActionKind) AllValues added in v0.29.3 

func (InboxStatusNextActionKind) AllValues() []InboxStatusNextActionKind

AllValues returns all InboxStatusNextActionKind values.

func (*InboxStatusNextActionKind) Decode added in v0.29.3 

func (s *InboxStatusNextActionKind) Decode(d *jx.Decoder) error

Decode decodes InboxStatusNextActionKind from json.

func (InboxStatusNextActionKind) Encode added in v0.29.3 

func (s InboxStatusNextActionKind) Encode(e *jx.Encoder)

Encode encodes InboxStatusNextActionKind as json.

func (InboxStatusNextActionKind) MarshalJSON added in v0.29.3 

func (s InboxStatusNextActionKind) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (InboxStatusNextActionKind) MarshalText added in v0.29.3 

func (s InboxStatusNextActionKind) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*InboxStatusNextActionKind) UnmarshalJSON added in v0.29.3 

func (s *InboxStatusNextActionKind) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*InboxStatusNextActionKind) UnmarshalText added in v0.29.3 

func (s *InboxStatusNextActionKind) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (InboxStatusNextActionKind) Validate added in v0.29.3 

func (s InboxStatusNextActionKind) Validate() error

type InboxStatusRecentEmailSummary added in v0.29.3 

type InboxStatusRecentEmailSummary struct {
	// Number of inbound emails received in the last 30 days.
	Total int `json:"total"`
	// Most recent inbound email received in the last 30 days.
	LatestReceivedAt NilDateTime `json:"latest_received_at"`
}

Inbound email activity from the last 30 days. Ref: #/components/schemas/InboxStatusRecentEmailSummary

func (*InboxStatusRecentEmailSummary) Decode added in v0.29.3 

func (s *InboxStatusRecentEmailSummary) Decode(d *jx.Decoder) error

Decode decodes InboxStatusRecentEmailSummary from json.

func (*InboxStatusRecentEmailSummary) Encode added in v0.29.3 

func (s *InboxStatusRecentEmailSummary) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*InboxStatusRecentEmailSummary) GetLatestReceivedAt added in v0.29.3 

func (s *InboxStatusRecentEmailSummary) GetLatestReceivedAt() NilDateTime

GetLatestReceivedAt returns the value of LatestReceivedAt.

func (*InboxStatusRecentEmailSummary) GetTotal added in v0.29.3 

func (s *InboxStatusRecentEmailSummary) GetTotal() int

GetTotal returns the value of Total.

func (*InboxStatusRecentEmailSummary) MarshalJSON added in v0.29.3 

func (s *InboxStatusRecentEmailSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*InboxStatusRecentEmailSummary) SetLatestReceivedAt added in v0.29.3 

func (s *InboxStatusRecentEmailSummary) SetLatestReceivedAt(val NilDateTime)

SetLatestReceivedAt sets the value of LatestReceivedAt.

func (*InboxStatusRecentEmailSummary) SetTotal added in v0.29.3 

func (s *InboxStatusRecentEmailSummary) SetTotal(val int)

SetTotal sets the value of Total.

func (*InboxStatusRecentEmailSummary) UnmarshalJSON added in v0.29.3 

func (s *InboxStatusRecentEmailSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type Invoker 

type Invoker interface {
	// AddDomain invokes addDomain operation.
	//
	// Creates an unverified domain claim and returns the exact
	// DNS records to publish in `dns_records`. Publish those
	// records before calling the verify endpoint. To give users
	// an importable DNS file, call `downloadDomainZoneFile` or run
	// `primitive domains zone-file --id <domain-id>`.
	//
	// POST /domains
	AddDomain(ctx context.Context, request *AddDomainInput) (AddDomainRes, error)
	// CliLogout invokes cliLogout operation.
	//
	// Revokes the OAuth grant used to authenticate the request. API-key
	// authenticated legacy logout requests succeed without deleting server API
	// keys so old local CLI state can be cleared safely.
	//
	// POST /cli/logout
	CliLogout(ctx context.Context, request OptCliLogoutInput) (CliLogoutRes, error)
	// CreateEndpoint invokes createEndpoint operation.
	//
	// Creates a new webhook endpoint. If a deactivated endpoint
	// with the same URL and domain exists, it is reactivated
	// instead. Subject to plan limits on the number of active
	// endpoints.
	// **Signing is account-scoped, not per-endpoint.** This call
	// does not return any signing material; every endpoint on the
	// account uses the same webhook secret, fetched via
	// `GET /account/webhook-secret`. See the API-level "Webhook
	// signing" section for the full wire format (header name,
	// signed string, hash algo, secret format, tolerance) and a
	// language-agnostic verification recipe.
	// After creating the endpoint, fire a test delivery against
	// it via `POST /endpoints/{id}/test` to confirm your verifier
	// accepts the signature.
	//
	// POST /endpoints
	CreateEndpoint(ctx context.Context, request *CreateEndpointInput) (CreateEndpointRes, error)
	// CreateFilter invokes createFilter operation.
	//
	// Creates a new whitelist or blocklist filter. Per-domain filters
	// require a Pro plan. Patterns are stored as lowercase.
	//
	// POST /filters
	CreateFilter(ctx context.Context, request *CreateFilterInput) (CreateFilterRes, error)
	// CreateFunction invokes createFunction operation.
	//
	// Creates and deploys a new function. The handler must be a single
	// ESM module whose default export is an object with an async
	// `fetch(request, env)` method (Workers-style). Primitive signs
	// each delivery and forwards the `Primitive-Signature` header to
	// the handler. Verify the raw request body with
	// `PRIMITIVE_WEBHOOK_SECRET` before parsing JSON; after verification
	// the request body parses to an `email.received` event (see
	// `EmailReceivedEvent` and the Webhook payload section for the full
	// schema). Code is bundled before being uploaded; ship a single
	// self-contained file rather than relying on external imports.
	// **Code limits.** `code` is capped at 1 MiB UTF-8. `sourceMap`
	// (optional) is capped at 5 MiB UTF-8, stored with each deployment
	// attempt, and sent to the runtime so stack traces can resolve to
	// original source files.
	// **Auto-wiring.** On successful deploy, Primitive automatically
	// creates a webhook endpoint that delivers inbound mail to the
	// function. There is nothing to configure on the Endpoints API
	// for this to work; the internal runtime URL is not returned by
	// the API and is not a customer-facing integration surface.
	// **Secrets.** New functions ship with the managed secrets
	// (`PRIMITIVE_WEBHOOK_SECRET`, `PRIMITIVE_API_KEY`,
	// `PRIMITIVE_API_BASE_URL`) already bound. Add user-set secrets via
	// `POST /functions/{id}/secrets`; secret writes only land in the
	// running handler on the next redeploy.
	//
	// POST /functions
	CreateFunction(ctx context.Context, request *CreateFunctionInput) (CreateFunctionRes, error)
	// CreateFunctionSecret invokes createFunctionSecret operation.
	//
	// Idempotent insert-or-update keyed on `(function_id, key)`.
	// Returns 201 the first time the key is set, 200 on subsequent
	// updates. Values are encrypted at rest and only become visible
	// to the running handler on the next deploy (`PUT /functions/{id}`
	// with the existing code is sufficient to refresh bindings).
	// Keys must match `^[A-Z_][A-Z0-9_]*$` (uppercase letters,
	// digits, underscores; first character is a letter or
	// underscore). Values are at most 4096 UTF-8 bytes. System-
	// managed keys are reserved and rejected.
	//
	// POST /functions/{id}/secrets
	CreateFunctionSecret(ctx context.Context, request *CreateFunctionSecretInput, params CreateFunctionSecretParams) (CreateFunctionSecretRes, error)
	// DeleteDomain invokes deleteDomain operation.
	//
	// Deletes a verified or unverified domain claim.
	//
	// DELETE /domains/{id}
	DeleteDomain(ctx context.Context, params DeleteDomainParams) (DeleteDomainRes, error)
	// DeleteEmail invokes deleteEmail operation.
	//
	// Delete an email.
	//
	// DELETE /emails/{id}
	DeleteEmail(ctx context.Context, params DeleteEmailParams) (DeleteEmailRes, error)
	// DeleteEndpoint invokes deleteEndpoint operation.
	//
	// Soft-deletes a webhook endpoint. The endpoint will no longer
	// receive webhook deliveries.
	//
	// DELETE /endpoints/{id}
	DeleteEndpoint(ctx context.Context, params DeleteEndpointParams) (DeleteEndpointRes, error)
	// DeleteFilter invokes deleteFilter operation.
	//
	// Delete a filter rule.
	//
	// DELETE /filters/{id}
	DeleteFilter(ctx context.Context, params DeleteFilterParams) (DeleteFilterRes, error)
	// DeleteFunction invokes deleteFunction operation.
	//
	// Soft-deletes the function row, removes the script from the edge
	// runtime, and deactivates the auto-wired webhook endpoint so no
	// further inbound mail is delivered. Past deploy history,
	// invocations, and logs are retained.
	// Returns 502 if the runtime delete fails partway; the function
	// row stays in place and the call is safe to retry until it
	// succeeds.
	//
	// DELETE /functions/{id}
	DeleteFunction(ctx context.Context, params DeleteFunctionParams) (DeleteFunctionRes, error)
	// DeleteFunctionSecret invokes deleteFunctionSecret operation.
	//
	// Removes the secret. The binding stays live in the running
	// handler until the next deploy refreshes the binding set
	// (`PUT /functions/{id}` with the existing code is sufficient).
	// Returns 404 if the key did not exist. Managed system keys
	// cannot be deleted.
	//
	// DELETE /functions/{id}/secrets/{key}
	DeleteFunctionSecret(ctx context.Context, params DeleteFunctionSecretParams) (DeleteFunctionSecretRes, error)
	// DiscardEmailContent invokes discardEmailContent operation.
	//
	// Permanently deletes the email's raw bytes, parsed body (text + HTML),
	// and attachments while preserving metadata (sender, recipient,
	// subject, timestamps, hashes, attachment manifest) for audit logs.
	// Idempotent: a second call returns success with
	// `already_discarded: true` and does no work.
	// **Gated** on the customer's discard-content opt-in (managed in the
	// dashboard at Settings > Webhooks). When the toggle is off, this
	// endpoint returns `403` with code `discard_not_enabled` and a
	// message pointing the human at the dashboard. There is intentionally
	// no API to flip this toggle. Opting in to a destructive,
	// non-reversible operation must be a deliberate human click in the
	// UI.
	//
	// POST /emails/{id}/discard-content
	DiscardEmailContent(ctx context.Context, params DiscardEmailContentParams) (DiscardEmailContentRes, error)
	// DownloadAttachments invokes downloadAttachments operation.
	//
	// Downloads all attachments as a gzip-compressed tar archive.
	// Authenticates via a signed download token (provided in webhook
	// payloads) or a valid session.
	//
	// GET /emails/{id}/attachments.tar.gz
	DownloadAttachments(ctx context.Context, params DownloadAttachmentsParams) (DownloadAttachmentsRes, error)
	// DownloadDomainZoneFile invokes downloadDomainZoneFile operation.
	//
	// Downloads a BIND-format DNS zone file containing the DNS records
	// required for a domain claim. Agents should offer this after
	// `addDomain` when users want to import DNS records instead of
	// copying each record manually.
	//
	// GET /domains/{id}/zone-file
	DownloadDomainZoneFile(ctx context.Context, params DownloadDomainZoneFileParams) (DownloadDomainZoneFileRes, error)
	// DownloadRawEmail invokes downloadRawEmail operation.
	//
	// Downloads the raw RFC 822 email file (.eml). Authenticates via
	// a signed download token (provided in webhook payloads) or a
	// valid session.
	//
	// GET /emails/{id}/raw
	DownloadRawEmail(ctx context.Context, params DownloadRawEmailParams) (DownloadRawEmailRes, error)
	// GetAccount invokes getAccount operation.
	//
	// Get account info.
	//
	// GET /account
	GetAccount(ctx context.Context) (GetAccountRes, error)
	// GetEmail invokes getEmail operation.
	//
	// Returns the full record for an inbound email received at one
	// of your verified domains, including the parsed text and HTML
	// bodies, threading metadata, SMTP envelope detail, webhook
	// delivery state, and a `replies` array for any outbound sends
	// recorded as replies to this inbound.
	// For listing inbound emails (with cursor pagination, status
	// and date filters, and free-text search), use
	// `/emails`. Outbound (sent) email records are NOT returned
	// here; use `/sent-emails/{id}` for those.
	// The response carries four sender-shaped fields whose
	// meanings overlap. `from_email` is the canonical "who sent
	// this" field for most use cases (parsed bare address from
	// the `From:` header, with a `sender` fallback). `from_header`
	// is the raw header including any display name. `sender` and
	// `smtp_mail_from` both carry the SMTP envelope MAIL FROM
	// (return-path) and are equal by construction; `sender` is
	// the older field name retained for compatibility. See
	// `primitive describe emails:get-email | jq '.responseSchema.properties'`
	// for per-field detail.
	//
	// GET /emails/{id}
	GetEmail(ctx context.Context, params GetEmailParams) (GetEmailRes, error)
	// GetFunction invokes getFunction operation.
	//
	// Returns the full record for a function, including its current
	// source code and the deploy status / error from the most recent
	// deploy attempt.
	//
	// GET /functions/{id}
	GetFunction(ctx context.Context, params GetFunctionParams) (GetFunctionRes, error)
	// GetFunctionTestRunTrace invokes getFunctionTestRunTrace operation.
	//
	// Returns the current end-to-end trace for a function test run.
	// The trace is intentionally partial while the test is still in
	// flight: callers can poll this endpoint and watch it fill in
	// from send -> inbound -> webhook deliveries -> outbound
	// requests, logs, and replies.
	//
	// GET /functions/{id}/test-runs/{run_id}/trace
	GetFunctionTestRunTrace(ctx context.Context, params GetFunctionTestRunTraceParams) (GetFunctionTestRunTraceRes, error)
	// GetInboxStatus invokes getInboxStatus operation.
	//
	// Returns one consolidated view of inbound domain readiness,
	// webhook/function processing routes, deployed Functions, and
	// recent inbound email activity.
	// Agents should call this before guiding a user through inbound
	// setup. It answers the practical questions "can I receive mail",
	// "will anything process that mail", and "what should I do next"
	// without forcing clients to stitch together domains, endpoints,
	// functions, and emails manually.
	//
	// GET /inbox/status
	GetInboxStatus(ctx context.Context) (GetInboxStatusRes, error)
	// GetSendPermissions invokes getSendPermissions operation.
	//
	// Returns a flat list of rules describing every recipient the
	// caller may send to. Each rule has a `type`, a kind-specific
	// payload, and a human-readable `description`. If any rule
	// matches the recipient, /send-mail will accept the send under
	// the recipient-scope check.
	// The endpoint is the answer to "where can I send" without
	// exposing internal entitlement names. Agents that don't
	// recognize a `type` can still read the `description` prose
	// and act on it.
	// Rule kinds, ordered broadest-first so an agent can stop
	// scanning at the first match:
	// 1. `any_recipient` (one entry, only when the org can send
	// anywhere): every other rule below it is redundant.
	// 2. `managed_zone` (always emitted, one per Primitive-managed
	// zone): sends to any address at *.primitive.email or
	// *.email.works always succeed; no entitlement required.
	// 3. `your_domain` (one per active verified outbound domain
	// owned by the org): sends to that domain are approved.
	// 4. `address` (one per address that has authenticated
	// inbound mail to the org, capped at `meta.address_cap`):
	// sends to that exact address are approved.
	// The list is informational, not an authorization check.
	// /send-mail remains the source of truth on whether an
	// individual send will succeed (it also enforces the
	// from-address and the `send_mail` entitlement, which are
	// not recipient-scope concerns and are not represented here).
	//
	// GET /send-permissions
	GetSendPermissions(ctx context.Context) (GetSendPermissionsRes, error)
	// GetSentEmail invokes getSentEmail operation.
	//
	// Returns the full sent-email record by id, including
	// `body_text` and `body_html` (omitted from the listing
	// endpoint to keep paginated responses small). Use this when
	// diagnosing a specific send, e.g. inspecting the receiver's
	// SMTP response on a `bounced` row or pulling the gate
	// denial detail on a `gate_denied` row.
	//
	// GET /sent-emails/{id}
	GetSentEmail(ctx context.Context, params GetSentEmailParams) (GetSentEmailRes, error)
	// GetStorageStats invokes getStorageStats operation.
	//
	// Get storage usage.
	//
	// GET /account/storage
	GetStorageStats(ctx context.Context) (GetStorageStatsRes, error)
	// GetWebhookSecret invokes getWebhookSecret operation.
	//
	// Returns the webhook signing secret for your account. If no
	// secret exists yet, one is generated automatically on first
	// access.
	// Signing is account-scoped, not per-endpoint. Every webhook
	// delivery from any of your registered endpoints is signed
	// with this single secret. Rotate via
	// `POST /account/webhook-secret/rotate`.
	// **Secret format**: the returned string looks base64-shaped
	// (e.g. `XNHBBW8VqoBjRfNs1tkZj11jTk...`) but is NOT base64.
	// Use it AS-IS as a UTF-8 string when computing HMAC over a
	// delivery body. Base64-decoding before HMAC will silently
	// produce mismatched signatures.
	// See the API-level "Webhook signing" section for the full
	// wire format (header name, signed string shape, hash algo,
	// tolerance) including a language-agnostic verification
	// recipe.
	//
	// GET /account/webhook-secret
	GetWebhookSecret(ctx context.Context) (GetWebhookSecretRes, error)
	// ListDeliveries invokes listDeliveries operation.
	//
	// Returns a paginated list of webhook delivery attempts. Each delivery
	// includes a nested `email` object with sender, recipient, and subject.
	//
	// GET /webhooks/deliveries
	ListDeliveries(ctx context.Context, params ListDeliveriesParams) (ListDeliveriesRes, error)
	// ListDomains invokes listDomains operation.
	//
	// Returns all verified and unverified domains for your organization,
	// sorted by creation date (newest first). Each domain includes a
	// `verified` boolean to distinguish between the two states.
	//
	// GET /domains
	ListDomains(ctx context.Context) (ListDomainsRes, error)
	// ListEmails invokes listEmails operation.
	//
	// Returns a paginated list of INBOUND emails received at your
	// verified domains. Outbound messages sent via /send-mail are
	// not included; this endpoint is the inbox view, not a
	// unified send/receive history.
	// Supports filtering by domain, status, date range, and
	// free-text search across subject, sender, and recipient
	// fields.
	// For a compact text-table summary of the most recent N
	// inbounds (no filters, no cursor pagination), the CLI ships
	// `primitive emails:latest` as a one-line-per-email shortcut.
	// It's TTY-aware so id columns are full UUIDs when piped, and
	// a `--json` flag returns the same envelope this endpoint
	// does. Use whichever fits the call site.
	//
	// GET /emails
	ListEmails(ctx context.Context, params ListEmailsParams) (ListEmailsRes, error)
	// ListEndpoints invokes listEndpoints operation.
	//
	// Returns all active (non-deleted) webhook endpoints.
	//
	// GET /endpoints
	ListEndpoints(ctx context.Context) (ListEndpointsRes, error)
	// ListFilters invokes listFilters operation.
	//
	// Returns all whitelist and blocklist filter rules.
	//
	// GET /filters
	ListFilters(ctx context.Context) (ListFiltersRes, error)
	// ListFunctionLogs invokes listFunctionLogs operation.
	//
	// Returns the most recent `function_logs` rows for the function,
	// newest first. Each row is a single `console.log` / `console.error`
	// invocation captured from the running handler.
	// Page through history with the opaque `cursor` returned as
	// `next_cursor`; pass it back as the `cursor` query param on the
	// next call. `next_cursor` is `null` when there are no further
	// rows. The cursor format is an implementation detail and should
	// not be parsed by callers.
	//
	// GET /functions/{id}/logs
	ListFunctionLogs(ctx context.Context, params ListFunctionLogsParams) (ListFunctionLogsRes, error)
	// ListFunctionSecrets invokes listFunctionSecrets operation.
	//
	// Returns metadata for every secret bound to the function, with
	// managed entries (provisioned by Primitive) listed first and
	// user-set entries listed alphabetically after. **Values are
	// never returned.** Secret writes are write-only.
	// Managed entries (e.g. `PRIMITIVE_WEBHOOK_SECRET`,
	// `PRIMITIVE_API_KEY`, `PRIMITIVE_API_BASE_URL`) carry a
	// `description` instead of `created_at` / `updated_at`. They
	// cannot be created, updated, or deleted via this API.
	//
	// GET /functions/{id}/secrets
	ListFunctionSecrets(ctx context.Context, params ListFunctionSecretsParams) (ListFunctionSecretsRes, error)
	// ListFunctions invokes listFunctions operation.
	//
	// Returns every active (non-deleted) function in the org, newest
	// first. Each entry carries deploy status and timestamps. To
	// inspect the source code or deploy errors, use `GET /functions/{id}`.
	//
	// GET /functions
	ListFunctions(ctx context.Context) (ListFunctionsRes, error)
	// ListSentEmails invokes listSentEmails operation.
	//
	// Returns a paginated list of OUTBOUND emails the caller's
	// org has sent via /send-mail (and /emails/{id}/reply, which
	// forwards through /send-mail). Includes every recorded
	// attempt, including gate-denied attempts that the agent
	// never called and rows still in `queued` state.
	// For inbound mail received at your verified domains, see
	// /emails. There is no unified send/receive history endpoint;
	// the two surfaces are intentionally separate because the
	// underlying tables, statuses, and lifecycle differ.
	// Email bodies (`body_text`, `body_html`) are NOT included on
	// list rows so a 50-row page can't balloon into a multi-MB
	// response when sends are near the 5MB body cap. Use
	// /sent-emails/{id} to fetch a single row with bodies, or
	// cross-reference by `client_idempotency_key` if the caller
	// already has the body locally.
	//
	// GET /sent-emails
	ListSentEmails(ctx context.Context, params ListSentEmailsParams) (ListSentEmailsRes, error)
	// PollCliLogin invokes pollCliLogin operation.
	//
	// Polls a CLI login session until the browser approval either succeeds,
	// is denied, expires, or is polled too quickly. The OAuth token set is
	// created only after approval and is returned exactly once.
	//
	// POST /cli/login/poll
	PollCliLogin(ctx context.Context, request *PollCliLoginInput) (PollCliLoginRes, error)
	// ReplayDelivery invokes replayDelivery operation.
	//
	// Re-sends the stored webhook payload from a previous delivery attempt.
	// If the original endpoint is still active, it is targeted. If the
	// original endpoint was deleted, the oldest active endpoint is used.
	// Deactivated endpoints cannot be replayed to. Rate limited per-org,
	// sharing an org-wide budget with email replays.
	//
	// POST /webhooks/deliveries/{id}/replay
	ReplayDelivery(ctx context.Context, params ReplayDeliveryParams) (ReplayDeliveryRes, error)
	// ReplayEmailWebhooks invokes replayEmailWebhooks operation.
	//
	// Re-delivers the webhook payload for this email to all active
	// endpoints matching the email's domain. Rate limited per-email
	// (short cooldown between successive replays of the same email)
	// and per-org (burst + sustained windows), sharing an org-wide
	// budget with delivery replays.
	//
	// POST /emails/{id}/replay
	ReplayEmailWebhooks(ctx context.Context, params ReplayEmailWebhooksParams) (ReplayEmailWebhooksRes, error)
	// ReplyToEmail invokes replyToEmail operation.
	//
	// Sends an outbound reply to the inbound email identified by `id`.
	// Threading headers (`In-Reply-To`, `References`), recipient
	// derivation (Reply-To, then From, then bare sender), and the
	// `Re:` subject prefix are all derived server-side from the
	// stored inbound row. The request body carries only the message
	// body and optional `wait` flag; passing any header or recipient
	// override is rejected by the schema (`additionalProperties:
	// false`).
	// Forwards through the same gates as `/send-mail`: the response
	// status, error envelope, and `idempotent_replay` flag mirror
	// the send-mail contract verbatim.
	//
	// POST /emails/{id}/reply
	ReplyToEmail(ctx context.Context, request *ReplyInput, params ReplyToEmailParams) (ReplyToEmailRes, error)
	// ResendAgentSignupVerification invokes resendAgentSignupVerification operation.
	//
	// Sends a new email verification code for a pending agent signup session.
	// This endpoint does not require an API key.
	//
	// POST /agent/signup/resend
	ResendAgentSignupVerification(ctx context.Context, request *ResendAgentSignupVerificationInput) (ResendAgentSignupVerificationRes, error)
	// ResendCliSignupVerification invokes resendCliSignupVerification operation.
	//
	// Sends a new email verification code for a pending CLI signup session.
	// This endpoint does not require an API key.
	//
	// POST /cli/signup/resend
	ResendCliSignupVerification(ctx context.Context, request *ResendCliSignupVerificationInput) (ResendCliSignupVerificationRes, error)
	// RotateWebhookSecret invokes rotateWebhookSecret operation.
	//
	// Generates a new webhook signing secret, replacing the current one.
	// Rate limited to once per 60 minutes.
	//
	// POST /account/webhook-secret/rotate
	RotateWebhookSecret(ctx context.Context) (RotateWebhookSecretRes, error)
	// SearchEmails invokes searchEmails operation.
	//
	// Searches inbound emails with structured filters and optional
	// full-text matching across parsed email fields. This endpoint is
	// optimized for filtered inbox views and CLI polling workflows:
	// callers that only need new accepted mail can pass
	// `sort=received_at_asc`, `snippet=false`, `include_facets=false`,
	// and a `date_from` timestamp.
	// `q`, `subject`, and `body` use the same English full-text index
	// as the web inbox search. Structured filters such as `from`, `to`,
	// `domain_id`, status, attachment presence, and spam score bounds
	// are combined with the text query.
	//
	// GET /emails/search
	SearchEmails(ctx context.Context, params SearchEmailsParams) (SearchEmailsRes, error)
	// SendEmail invokes sendEmail operation.
	//
	// Sends an outbound email through Primitive's outbound relay. By default
	// the request returns once the relay accepts the message for delivery.
	// Set `wait: true` to wait for the first downstream SMTP delivery outcome.
	// **Host routing.** /send-mail is served by the attachments-
	// supporting host (`https://api.primitive.dev/v1`) so the
	// request body can carry inline attachments up to ~30 MiB raw.
	// The primary host (`https://www.primitive.dev/api/v1`) also
	// accepts /send-mail for attachment-free sends; sends WITH
	// attachments to the primary host return 413
	// `attachments_unsupported_on_this_endpoint`. The typed SDKs
	// route /send-mail to the attachments host automatically.
	//
	// POST /send-mail
	SendEmail(ctx context.Context, request *SendMailInput, params SendEmailParams) (SendEmailRes, error)
	// SetFunctionSecret invokes setFunctionSecret operation.
	//
	// Path-keyed companion to `POST /functions/{id}/secrets`.
	// Idempotent: returns 201 the first time the key is set, 200 on
	// subsequent updates. Same validation rules and same write-only
	// guarantees as the POST verb; the new value lands in the running
	// handler on the next deploy.
	//
	// PUT /functions/{id}/secrets/{key}
	SetFunctionSecret(ctx context.Context, request *SetFunctionSecretInput, params SetFunctionSecretParams) (SetFunctionSecretRes, error)
	// StartAgentSignup invokes startAgentSignup operation.
	//
	// Starts an agent-native signup session. The API validates the signup code,
	// creates a pending signup session, sends an email verification code, and
	// returns an opaque signup token used by the resend and verify steps. This
	// endpoint does not require an API key.
	//
	// POST /agent/signup/start
	StartAgentSignup(ctx context.Context, request *StartAgentSignupInput) (StartAgentSignupRes, error)
	// StartCliLogin invokes startCliLogin operation.
	//
	// Starts a browser-assisted CLI login session. The response includes a
	// device code for polling and a user code that the user approves in the
	// browser. This endpoint does not require an API key.
	//
	// POST /cli/login/start
	StartCliLogin(ctx context.Context, request OptStartCliLoginInput) (StartCliLoginRes, error)
	// StartCliSignup invokes startCliSignup operation.
	//
	// Starts a terminal-native CLI signup. The API validates the signup code,
	// creates a pending signup session, sends an email verification code, and
	// returns an opaque signup token used by the resend and verify steps. This
	// endpoint does not require an API key.
	//
	// POST /cli/signup/start
	StartCliSignup(ctx context.Context, request *StartCliSignupInput) (StartCliSignupRes, error)
	// TestEndpoint invokes testEndpoint operation.
	//
	// Sends a sample `email.received` event to the endpoint. The request
	// includes SSRF protection (private IP rejection and DNS pinning).
	// Rate limited to 4 per minute and 30 per hour (non-exempt).
	// Successful deliveries and verified-domain endpoints are exempt
	// from the rate limit.
	//
	// POST /endpoints/{id}/test
	TestEndpoint(ctx context.Context, params TestEndpointParams) (TestEndpointRes, error)
	// TestFunction invokes testFunction operation.
	//
	// Sends a real test email from a Primitive-controlled sender to a
	// local-part on one of the org's verified inbound domains. By
	// default the recipient is a synthetic
	// `__primitive_function_test+<random>@<domain>` address on a
	// domain selected to route to the function. Scoped functions use
	// their scoped domain; fallback functions use a domain that has
	// no enabled domain-scoped endpoint. Pass `local_part` to
	// override and exercise routing logic that branches on a specific
	// recipient (the common pattern when one function handles multiple
	// inboxes like `summarize@` and `action@`). The function fires
	// through the normal MX delivery path, so reply / send-mail calls
	// from inside the handler against the inbound's `email.id` work
	// the same as in production. Returns immediately after the send is
	// queued; the invocation appears on the function's invocations
	// list within a few seconds.
	// Requires that the function is currently `deployed`. Returns 422
	// if the function is in `pending` or `failed` state, or if the
	// org has no verified inbound domain to receive the test mail.
	// Returns 400 if `local_part` is set to a value that does not
	// match the local-part character set.
	//
	// POST /functions/{id}/test
	TestFunction(ctx context.Context, request OptTestFunctionReq, params TestFunctionParams) (TestFunctionRes, error)
	// UpdateAccount invokes updateAccount operation.
	//
	// Update account settings.
	//
	// PATCH /account
	UpdateAccount(ctx context.Context, request *UpdateAccountInput) (UpdateAccountRes, error)
	// UpdateDomain invokes updateDomain operation.
	//
	// Update a verified domain's settings. Only verified domains can be
	// updated. Per-domain spam thresholds require a Pro plan.
	//
	// PATCH /domains/{id}
	UpdateDomain(ctx context.Context, request *UpdateDomainInput, params UpdateDomainParams) (UpdateDomainRes, error)
	// UpdateEndpoint invokes updateEndpoint operation.
	//
	// Updates an active webhook endpoint. If the URL is changed, the old
	// endpoint is deactivated and a new one is created (or an existing
	// deactivated endpoint with the new URL is reactivated).
	//
	// PATCH /endpoints/{id}
	UpdateEndpoint(ctx context.Context, request *UpdateEndpointInput, params UpdateEndpointParams) (UpdateEndpointRes, error)
	// UpdateFilter invokes updateFilter operation.
	//
	// Toggle a filter's enabled state.
	//
	// PATCH /filters/{id}
	UpdateFilter(ctx context.Context, request *UpdateFilterInput, params UpdateFilterParams) (UpdateFilterRes, error)
	// UpdateFunction invokes updateFunction operation.
	//
	// Replaces the function's source code with the body's `code` and
	// triggers a redeploy. Same size limits as `POST /functions`.
	// Use this verb to push secret writes into the running handler:
	// passing the same `code` re-runs the deploy and refreshes the
	// binding set with the latest values from the secrets table.
	// On deploy failure, the previously-deployed code stays live; the
	// runtime never serves a half-built bundle. The response uses
	// `error.code` `deploy_failed`, and the function's `deploy_error`
	// field carries the latest deploy error for dashboard/API reads.
	//
	// PUT /functions/{id}
	UpdateFunction(ctx context.Context, request *UpdateFunctionInput, params UpdateFunctionParams) (UpdateFunctionRes, error)
	// VerifyAgentSignup invokes verifyAgentSignup operation.
	//
	// Verifies the email code for an agent signup session, creates the account
	// when needed, redeems the reserved signup code, mints an org-scoped OAuth
	// session for CLI authentication, and returns the raw tokens exactly once.
	// For existing users, the optional `org_id` selects which accessible
	// workspace should receive the new session.
	//
	// POST /agent/signup/verify
	VerifyAgentSignup(ctx context.Context, request *VerifyAgentSignupInput) (VerifyAgentSignupRes, error)
	// VerifyCliSignup invokes verifyCliSignup operation.
	//
	// Verifies the email code for a CLI signup session, creates the account,
	// redeems the reserved signup code, creates an org-scoped OAuth CLI
	// session, and returns the token set exactly once. This endpoint does not
	// require an API key.
	//
	// POST /cli/signup/verify
	VerifyCliSignup(ctx context.Context, request *VerifyCliSignupInput) (VerifyCliSignupRes, error)
	// VerifyDomain invokes verifyDomain operation.
	//
	// Checks DNS records required for inbound routing, ownership,
	// and outbound authentication: MX, ownership TXT, SPF, DKIM,
	// DMARC, and TLS-RPT.
	// On success, the domain is promoted from unverified to verified.
	// On failure, returns which checks passed and which failed,
	// plus the exact DNS records still expected. To give users
	// an importable DNS file for missing records, call
	// `downloadDomainZoneFile` or run
	// `primitive domains zone-file --id <domain-id>`.
	//
	// POST /domains/{id}/verify
	VerifyDomain(ctx context.Context, params VerifyDomainParams) (VerifyDomainRes, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Labeler 

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

Labeler is used to allow adding custom attributes to the server request metrics.

func LabelerFromContext 

func LabelerFromContext(ctx context.Context) (*Labeler, bool)

LabelerFromContext retrieves the Labeler from the provided context, if present.

If no Labeler was found in the provided context a new, empty Labeler is returned and the second return value is false. In this case it is safe to use the Labeler but any attributes added to it will not be used.

func (*Labeler) Add 

func (l *Labeler) Add(attrs ...attribute.KeyValue)

Add attributes to the Labeler.

func (*Labeler) AttributeSet 

func (l *Labeler) AttributeSet() attribute.Set

AttributeSet returns the attributes added to the Labeler as an attribute.Set.

type ListDeliveriesBadRequest 

type ListDeliveriesBadRequest ErrorResponse

func (*ListDeliveriesBadRequest) Decode 

func (s *ListDeliveriesBadRequest) Decode(d *jx.Decoder) error

Decode decodes ListDeliveriesBadRequest from json.

func (*ListDeliveriesBadRequest) Encode 

func (s *ListDeliveriesBadRequest) Encode(e *jx.Encoder)

Encode encodes ListDeliveriesBadRequest as json.

func (*ListDeliveriesBadRequest) MarshalJSON 

func (s *ListDeliveriesBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListDeliveriesBadRequest) UnmarshalJSON 

func (s *ListDeliveriesBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListDeliveriesBadRequest) Validate 

func (s *ListDeliveriesBadRequest) Validate() error

type ListDeliveriesOK 

type ListDeliveriesOK struct {
	Success bool              `json:"success"`
	Meta    PaginationMeta    `json:"meta"`
	Data    []DeliverySummary `json:"data"`
}

Merged schema.

func (*ListDeliveriesOK) Decode 

func (s *ListDeliveriesOK) Decode(d *jx.Decoder) error

Decode decodes ListDeliveriesOK from json.

func (*ListDeliveriesOK) Encode 

func (s *ListDeliveriesOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListDeliveriesOK) GetData 

func (s *ListDeliveriesOK) GetData() []DeliverySummary

GetData returns the value of Data.

func (*ListDeliveriesOK) GetMeta 

func (s *ListDeliveriesOK) GetMeta() PaginationMeta

GetMeta returns the value of Meta.

func (*ListDeliveriesOK) GetSuccess 

func (s *ListDeliveriesOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ListDeliveriesOK) MarshalJSON 

func (s *ListDeliveriesOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListDeliveriesOK) SetData 

func (s *ListDeliveriesOK) SetData(val []DeliverySummary)

SetData sets the value of Data.

func (*ListDeliveriesOK) SetMeta 

func (s *ListDeliveriesOK) SetMeta(val PaginationMeta)

SetMeta sets the value of Meta.

func (*ListDeliveriesOK) SetSuccess 

func (s *ListDeliveriesOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ListDeliveriesOK) UnmarshalJSON 

func (s *ListDeliveriesOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListDeliveriesOK) Validate 

func (s *ListDeliveriesOK) Validate() error

type ListDeliveriesParams 

type ListDeliveriesParams struct {
	// Pagination cursor from a previous response's `meta.cursor` field.
	// Format: `{ISO-datetime}|{id}`.
	Cursor OptString `json:",omitempty,omitzero"`
	// Number of results per page.
	Limit OptInt `json:",omitempty,omitzero"`
	// Filter by email ID.
	EmailID OptUUID `json:",omitempty,omitzero"`
	// Filter by delivery status.
	Status OptListDeliveriesStatus `json:",omitempty,omitzero"`
	// Filter deliveries created on or after this timestamp.
	DateFrom OptDateTime `json:",omitempty,omitzero"`
	// Filter deliveries created on or before this timestamp.
	DateTo OptDateTime `json:",omitempty,omitzero"`
}

ListDeliveriesParams is parameters of listDeliveries operation.

type ListDeliveriesRes 

type ListDeliveriesRes interface {
	// contains filtered or unexported methods
}

type ListDeliveriesStatus 

type ListDeliveriesStatus string
const (
	ListDeliveriesStatusPending         ListDeliveriesStatus = "pending"
	ListDeliveriesStatusDelivered       ListDeliveriesStatus = "delivered"
	ListDeliveriesStatusHeaderConfirmed ListDeliveriesStatus = "header_confirmed"
	ListDeliveriesStatusFailed          ListDeliveriesStatus = "failed"
)

func (ListDeliveriesStatus) AllValues 

func (ListDeliveriesStatus) AllValues() []ListDeliveriesStatus

AllValues returns all ListDeliveriesStatus values.

func (ListDeliveriesStatus) MarshalText 

func (s ListDeliveriesStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*ListDeliveriesStatus) UnmarshalText 

func (s *ListDeliveriesStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (ListDeliveriesStatus) Validate 

func (s ListDeliveriesStatus) Validate() error

type ListDeliveriesUnauthorized 

type ListDeliveriesUnauthorized ErrorResponse

func (*ListDeliveriesUnauthorized) Decode 

func (s *ListDeliveriesUnauthorized) Decode(d *jx.Decoder) error

Decode decodes ListDeliveriesUnauthorized from json.

func (*ListDeliveriesUnauthorized) Encode 

func (s *ListDeliveriesUnauthorized) Encode(e *jx.Encoder)

Encode encodes ListDeliveriesUnauthorized as json.

func (*ListDeliveriesUnauthorized) MarshalJSON 

func (s *ListDeliveriesUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListDeliveriesUnauthorized) UnmarshalJSON 

func (s *ListDeliveriesUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListDeliveriesUnauthorized) Validate 

func (s *ListDeliveriesUnauthorized) Validate() error

type ListDomainsOK 

type ListDomainsOK struct {
	Success bool     `json:"success"`
	Data    []Domain `json:"data"`
}

Merged schema.

func (*ListDomainsOK) Decode 

func (s *ListDomainsOK) Decode(d *jx.Decoder) error

Decode decodes ListDomainsOK from json.

func (*ListDomainsOK) Encode 

func (s *ListDomainsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListDomainsOK) GetData 

func (s *ListDomainsOK) GetData() []Domain

GetData returns the value of Data.

func (*ListDomainsOK) GetSuccess 

func (s *ListDomainsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ListDomainsOK) MarshalJSON 

func (s *ListDomainsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListDomainsOK) SetData 

func (s *ListDomainsOK) SetData(val []Domain)

SetData sets the value of Data.

func (*ListDomainsOK) SetSuccess 

func (s *ListDomainsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ListDomainsOK) UnmarshalJSON 

func (s *ListDomainsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListDomainsOK) Validate 

func (s *ListDomainsOK) Validate() error

type ListDomainsRes 

type ListDomainsRes interface {
	// contains filtered or unexported methods
}

type ListEmailsBadRequest 

type ListEmailsBadRequest ErrorResponse

func (*ListEmailsBadRequest) Decode 

func (s *ListEmailsBadRequest) Decode(d *jx.Decoder) error

Decode decodes ListEmailsBadRequest from json.

func (*ListEmailsBadRequest) Encode 

func (s *ListEmailsBadRequest) Encode(e *jx.Encoder)

Encode encodes ListEmailsBadRequest as json.

func (*ListEmailsBadRequest) MarshalJSON 

func (s *ListEmailsBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListEmailsBadRequest) UnmarshalJSON 

func (s *ListEmailsBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListEmailsBadRequest) Validate 

func (s *ListEmailsBadRequest) Validate() error

type ListEmailsOK 

type ListEmailsOK struct {
	Success bool           `json:"success"`
	Meta    PaginationMeta `json:"meta"`
	Data    []EmailSummary `json:"data"`
}

Merged schema.

func (*ListEmailsOK) Decode 

func (s *ListEmailsOK) Decode(d *jx.Decoder) error

Decode decodes ListEmailsOK from json.

func (*ListEmailsOK) Encode 

func (s *ListEmailsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListEmailsOK) GetData 

func (s *ListEmailsOK) GetData() []EmailSummary

GetData returns the value of Data.

func (*ListEmailsOK) GetMeta 

func (s *ListEmailsOK) GetMeta() PaginationMeta

GetMeta returns the value of Meta.

func (*ListEmailsOK) GetSuccess 

func (s *ListEmailsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ListEmailsOK) MarshalJSON 

func (s *ListEmailsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListEmailsOK) SetData 

func (s *ListEmailsOK) SetData(val []EmailSummary)

SetData sets the value of Data.

func (*ListEmailsOK) SetMeta 

func (s *ListEmailsOK) SetMeta(val PaginationMeta)

SetMeta sets the value of Meta.

func (*ListEmailsOK) SetSuccess 

func (s *ListEmailsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ListEmailsOK) UnmarshalJSON 

func (s *ListEmailsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListEmailsOK) Validate 

func (s *ListEmailsOK) Validate() error

type ListEmailsParams 

type ListEmailsParams struct {
	// Pagination cursor from a previous response's `meta.cursor` field.
	// Format: `{ISO-datetime}|{id}`.
	Cursor OptString `json:",omitempty,omitzero"`
	// Number of results per page.
	Limit OptInt `json:",omitempty,omitzero"`
	// Filter by domain ID.
	DomainID OptUUID `json:",omitempty,omitzero"`
	// Filter inbound rows by lifecycle status. See `EmailStatus`
	// for what each value means. Note that the webhook delivery
	// state is a SEPARATE lifecycle on the same row; filter by
	// `webhook_status` semantics is not currently supported on
	// this endpoint.
	Status OptEmailStatus `json:",omitempty,omitzero"`
	// Search subject, sender, and recipient (case-insensitive).
	Search OptString `json:",omitempty,omitzero"`
	// Filter emails created on or after this timestamp.
	DateFrom OptDateTime `json:",omitempty,omitzero"`
	// Filter emails created on or before this timestamp.
	DateTo OptDateTime `json:",omitempty,omitzero"`
}

ListEmailsParams is parameters of listEmails operation.

type ListEmailsRes 

type ListEmailsRes interface {
	// contains filtered or unexported methods
}

type ListEmailsUnauthorized 

type ListEmailsUnauthorized ErrorResponse

func (*ListEmailsUnauthorized) Decode 

func (s *ListEmailsUnauthorized) Decode(d *jx.Decoder) error

Decode decodes ListEmailsUnauthorized from json.

func (*ListEmailsUnauthorized) Encode 

func (s *ListEmailsUnauthorized) Encode(e *jx.Encoder)

Encode encodes ListEmailsUnauthorized as json.

func (*ListEmailsUnauthorized) MarshalJSON 

func (s *ListEmailsUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListEmailsUnauthorized) UnmarshalJSON 

func (s *ListEmailsUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListEmailsUnauthorized) Validate 

func (s *ListEmailsUnauthorized) Validate() error

type ListEndpointsOK 

type ListEndpointsOK struct {
	Success bool       `json:"success"`
	Data    []Endpoint `json:"data"`
}

Merged schema.

func (*ListEndpointsOK) Decode 

func (s *ListEndpointsOK) Decode(d *jx.Decoder) error

Decode decodes ListEndpointsOK from json.

func (*ListEndpointsOK) Encode 

func (s *ListEndpointsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListEndpointsOK) GetData 

func (s *ListEndpointsOK) GetData() []Endpoint

GetData returns the value of Data.

func (*ListEndpointsOK) GetSuccess 

func (s *ListEndpointsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ListEndpointsOK) MarshalJSON 

func (s *ListEndpointsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListEndpointsOK) SetData 

func (s *ListEndpointsOK) SetData(val []Endpoint)

SetData sets the value of Data.

func (*ListEndpointsOK) SetSuccess 

func (s *ListEndpointsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ListEndpointsOK) UnmarshalJSON 

func (s *ListEndpointsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListEndpointsOK) Validate 

func (s *ListEndpointsOK) Validate() error

type ListEndpointsRes 

type ListEndpointsRes interface {
	// contains filtered or unexported methods
}

type ListFiltersOK 

type ListFiltersOK struct {
	Success bool     `json:"success"`
	Data    []Filter `json:"data"`
}

Merged schema.

func (*ListFiltersOK) Decode 

func (s *ListFiltersOK) Decode(d *jx.Decoder) error

Decode decodes ListFiltersOK from json.

func (*ListFiltersOK) Encode 

func (s *ListFiltersOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListFiltersOK) GetData 

func (s *ListFiltersOK) GetData() []Filter

GetData returns the value of Data.

func (*ListFiltersOK) GetSuccess 

func (s *ListFiltersOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ListFiltersOK) MarshalJSON 

func (s *ListFiltersOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFiltersOK) SetData 

func (s *ListFiltersOK) SetData(val []Filter)

SetData sets the value of Data.

func (*ListFiltersOK) SetSuccess 

func (s *ListFiltersOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ListFiltersOK) UnmarshalJSON 

func (s *ListFiltersOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFiltersOK) Validate 

func (s *ListFiltersOK) Validate() error

type ListFiltersRes 

type ListFiltersRes interface {
	// contains filtered or unexported methods
}

type ListFunctionLogsBadRequest added in v0.26.0 

type ListFunctionLogsBadRequest ErrorResponse

func (*ListFunctionLogsBadRequest) Decode added in v0.26.0 

func (s *ListFunctionLogsBadRequest) Decode(d *jx.Decoder) error

Decode decodes ListFunctionLogsBadRequest from json.

func (*ListFunctionLogsBadRequest) Encode added in v0.26.0 

func (s *ListFunctionLogsBadRequest) Encode(e *jx.Encoder)

Encode encodes ListFunctionLogsBadRequest as json.

func (*ListFunctionLogsBadRequest) MarshalJSON added in v0.26.0 

func (s *ListFunctionLogsBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionLogsBadRequest) UnmarshalJSON added in v0.26.0 

func (s *ListFunctionLogsBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionLogsBadRequest) Validate added in v0.26.0 

func (s *ListFunctionLogsBadRequest) Validate() error

type ListFunctionLogsForbidden added in v0.26.0 

type ListFunctionLogsForbidden ErrorResponse

func (*ListFunctionLogsForbidden) Decode added in v0.26.0 

func (s *ListFunctionLogsForbidden) Decode(d *jx.Decoder) error

Decode decodes ListFunctionLogsForbidden from json.

func (*ListFunctionLogsForbidden) Encode added in v0.26.0 

func (s *ListFunctionLogsForbidden) Encode(e *jx.Encoder)

Encode encodes ListFunctionLogsForbidden as json.

func (*ListFunctionLogsForbidden) MarshalJSON added in v0.26.0 

func (s *ListFunctionLogsForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionLogsForbidden) UnmarshalJSON added in v0.26.0 

func (s *ListFunctionLogsForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionLogsForbidden) Validate added in v0.26.0 

func (s *ListFunctionLogsForbidden) Validate() error

type ListFunctionLogsNotFound added in v0.26.0 

type ListFunctionLogsNotFound ErrorResponse

func (*ListFunctionLogsNotFound) Decode added in v0.26.0 

func (s *ListFunctionLogsNotFound) Decode(d *jx.Decoder) error

Decode decodes ListFunctionLogsNotFound from json.

func (*ListFunctionLogsNotFound) Encode added in v0.26.0 

func (s *ListFunctionLogsNotFound) Encode(e *jx.Encoder)

Encode encodes ListFunctionLogsNotFound as json.

func (*ListFunctionLogsNotFound) MarshalJSON added in v0.26.0 

func (s *ListFunctionLogsNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionLogsNotFound) UnmarshalJSON added in v0.26.0 

func (s *ListFunctionLogsNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionLogsNotFound) Validate added in v0.26.0 

func (s *ListFunctionLogsNotFound) Validate() error

type ListFunctionLogsOK added in v0.26.0 

type ListFunctionLogsOK struct {
	Success bool                   `json:"success"`
	Data    ListFunctionLogsOKData `json:"data"`
}

Merged schema.

func (*ListFunctionLogsOK) Decode added in v0.26.0 

func (s *ListFunctionLogsOK) Decode(d *jx.Decoder) error

Decode decodes ListFunctionLogsOK from json.

func (*ListFunctionLogsOK) Encode added in v0.26.0 

func (s *ListFunctionLogsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListFunctionLogsOK) GetData added in v0.26.0 

func (s *ListFunctionLogsOK) GetData() ListFunctionLogsOKData

GetData returns the value of Data.

func (*ListFunctionLogsOK) GetSuccess added in v0.26.0 

func (s *ListFunctionLogsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ListFunctionLogsOK) MarshalJSON added in v0.26.0 

func (s *ListFunctionLogsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionLogsOK) SetData added in v0.26.0 

func (s *ListFunctionLogsOK) SetData(val ListFunctionLogsOKData)

SetData sets the value of Data.

func (*ListFunctionLogsOK) SetSuccess added in v0.26.0 

func (s *ListFunctionLogsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ListFunctionLogsOK) UnmarshalJSON added in v0.26.0 

func (s *ListFunctionLogsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionLogsOK) Validate added in v0.26.0 

func (s *ListFunctionLogsOK) Validate() error

type ListFunctionLogsOKData added in v0.26.0 

type ListFunctionLogsOKData struct {
	Items []FunctionLogRow `json:"items"`
	// Pass back as `cursor` to fetch the next
	// page. `null` when no further rows exist.
	NextCursor NilString `json:"next_cursor"`
}

func (*ListFunctionLogsOKData) Decode added in v0.26.0 

func (s *ListFunctionLogsOKData) Decode(d *jx.Decoder) error

Decode decodes ListFunctionLogsOKData from json.

func (*ListFunctionLogsOKData) Encode added in v0.26.0 

func (s *ListFunctionLogsOKData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListFunctionLogsOKData) GetItems added in v0.26.0 

func (s *ListFunctionLogsOKData) GetItems() []FunctionLogRow

GetItems returns the value of Items.

func (*ListFunctionLogsOKData) GetNextCursor added in v0.26.0 

func (s *ListFunctionLogsOKData) GetNextCursor() NilString

GetNextCursor returns the value of NextCursor.

func (*ListFunctionLogsOKData) MarshalJSON added in v0.26.0 

func (s *ListFunctionLogsOKData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionLogsOKData) SetItems added in v0.26.0 

func (s *ListFunctionLogsOKData) SetItems(val []FunctionLogRow)

SetItems sets the value of Items.

func (*ListFunctionLogsOKData) SetNextCursor added in v0.26.0 

func (s *ListFunctionLogsOKData) SetNextCursor(val NilString)

SetNextCursor sets the value of NextCursor.

func (*ListFunctionLogsOKData) UnmarshalJSON added in v0.26.0 

func (s *ListFunctionLogsOKData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionLogsOKData) Validate added in v0.26.0 

func (s *ListFunctionLogsOKData) Validate() error

type ListFunctionLogsParams added in v0.26.0 

type ListFunctionLogsParams struct {
	// Maximum number of rows to return. Clamped to 1..200; default
	// 50.
	Limit OptInt `json:",omitempty,omitzero"`
	// Opaque pagination cursor from a previous response's
	// `next_cursor`. Omit on the first call.
	Cursor OptString `json:",omitempty,omitzero"`
	// Resource UUID.
	ID uuid.UUID
}

ListFunctionLogsParams is parameters of listFunctionLogs operation.

type ListFunctionLogsRes added in v0.26.0 

type ListFunctionLogsRes interface {
	// contains filtered or unexported methods
}

type ListFunctionLogsUnauthorized added in v0.26.0 

type ListFunctionLogsUnauthorized ErrorResponse

func (*ListFunctionLogsUnauthorized) Decode added in v0.26.0 

func (s *ListFunctionLogsUnauthorized) Decode(d *jx.Decoder) error

Decode decodes ListFunctionLogsUnauthorized from json.

func (*ListFunctionLogsUnauthorized) Encode added in v0.26.0 

func (s *ListFunctionLogsUnauthorized) Encode(e *jx.Encoder)

Encode encodes ListFunctionLogsUnauthorized as json.

func (*ListFunctionLogsUnauthorized) MarshalJSON added in v0.26.0 

func (s *ListFunctionLogsUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionLogsUnauthorized) UnmarshalJSON added in v0.26.0 

func (s *ListFunctionLogsUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionLogsUnauthorized) Validate added in v0.26.0 

func (s *ListFunctionLogsUnauthorized) Validate() error

type ListFunctionSecretsNotFound added in v0.20.0 

type ListFunctionSecretsNotFound ErrorResponse

func (*ListFunctionSecretsNotFound) Decode added in v0.20.0 

func (s *ListFunctionSecretsNotFound) Decode(d *jx.Decoder) error

Decode decodes ListFunctionSecretsNotFound from json.

func (*ListFunctionSecretsNotFound) Encode added in v0.20.0 

func (s *ListFunctionSecretsNotFound) Encode(e *jx.Encoder)

Encode encodes ListFunctionSecretsNotFound as json.

func (*ListFunctionSecretsNotFound) MarshalJSON added in v0.20.0 

func (s *ListFunctionSecretsNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionSecretsNotFound) UnmarshalJSON added in v0.20.0 

func (s *ListFunctionSecretsNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionSecretsNotFound) Validate added in v0.20.0 

func (s *ListFunctionSecretsNotFound) Validate() error

type ListFunctionSecretsOK added in v0.20.0 

type ListFunctionSecretsOK struct {
	Success bool                      `json:"success"`
	Data    ListFunctionSecretsOKData `json:"data"`
}

Merged schema.

func (*ListFunctionSecretsOK) Decode added in v0.20.0 

func (s *ListFunctionSecretsOK) Decode(d *jx.Decoder) error

Decode decodes ListFunctionSecretsOK from json.

func (*ListFunctionSecretsOK) Encode added in v0.20.0 

func (s *ListFunctionSecretsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListFunctionSecretsOK) GetData added in v0.20.0 

func (s *ListFunctionSecretsOK) GetData() ListFunctionSecretsOKData

GetData returns the value of Data.

func (*ListFunctionSecretsOK) GetSuccess added in v0.20.0 

func (s *ListFunctionSecretsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ListFunctionSecretsOK) MarshalJSON added in v0.20.0 

func (s *ListFunctionSecretsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionSecretsOK) SetData added in v0.20.0 

func (s *ListFunctionSecretsOK) SetData(val ListFunctionSecretsOKData)

SetData sets the value of Data.

func (*ListFunctionSecretsOK) SetSuccess added in v0.20.0 

func (s *ListFunctionSecretsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ListFunctionSecretsOK) UnmarshalJSON added in v0.20.0 

func (s *ListFunctionSecretsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionSecretsOK) Validate added in v0.20.0 

func (s *ListFunctionSecretsOK) Validate() error

type ListFunctionSecretsOKData added in v0.20.0 

type ListFunctionSecretsOKData struct {
	Items []FunctionSecretListItem `json:"items"`
}

func (*ListFunctionSecretsOKData) Decode added in v0.20.0 

func (s *ListFunctionSecretsOKData) Decode(d *jx.Decoder) error

Decode decodes ListFunctionSecretsOKData from json.

func (*ListFunctionSecretsOKData) Encode added in v0.20.0 

func (s *ListFunctionSecretsOKData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListFunctionSecretsOKData) GetItems added in v0.20.0 

func (s *ListFunctionSecretsOKData) GetItems() []FunctionSecretListItem

GetItems returns the value of Items.

func (*ListFunctionSecretsOKData) MarshalJSON added in v0.20.0 

func (s *ListFunctionSecretsOKData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionSecretsOKData) SetItems added in v0.20.0 

func (s *ListFunctionSecretsOKData) SetItems(val []FunctionSecretListItem)

SetItems sets the value of Items.

func (*ListFunctionSecretsOKData) UnmarshalJSON added in v0.20.0 

func (s *ListFunctionSecretsOKData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionSecretsOKData) Validate added in v0.20.0 

func (s *ListFunctionSecretsOKData) Validate() error

type ListFunctionSecretsParams added in v0.20.0 

type ListFunctionSecretsParams struct {
	// Resource UUID.
	ID uuid.UUID
}

ListFunctionSecretsParams is parameters of listFunctionSecrets operation.

type ListFunctionSecretsRes added in v0.20.0 

type ListFunctionSecretsRes interface {
	// contains filtered or unexported methods
}

type ListFunctionSecretsUnauthorized added in v0.20.0 

type ListFunctionSecretsUnauthorized ErrorResponse

func (*ListFunctionSecretsUnauthorized) Decode added in v0.20.0 

func (s *ListFunctionSecretsUnauthorized) Decode(d *jx.Decoder) error

Decode decodes ListFunctionSecretsUnauthorized from json.

func (*ListFunctionSecretsUnauthorized) Encode added in v0.20.0 

func (s *ListFunctionSecretsUnauthorized) Encode(e *jx.Encoder)

Encode encodes ListFunctionSecretsUnauthorized as json.

func (*ListFunctionSecretsUnauthorized) MarshalJSON added in v0.20.0 

func (s *ListFunctionSecretsUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionSecretsUnauthorized) UnmarshalJSON added in v0.20.0 

func (s *ListFunctionSecretsUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionSecretsUnauthorized) Validate added in v0.20.0 

func (s *ListFunctionSecretsUnauthorized) Validate() error

type ListFunctionsOK added in v0.20.0 

type ListFunctionsOK struct {
	Success bool               `json:"success"`
	Data    []FunctionListItem `json:"data"`
}

Merged schema.

func (*ListFunctionsOK) Decode added in v0.20.0 

func (s *ListFunctionsOK) Decode(d *jx.Decoder) error

Decode decodes ListFunctionsOK from json.

func (*ListFunctionsOK) Encode added in v0.20.0 

func (s *ListFunctionsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListFunctionsOK) GetData added in v0.20.0 

func (s *ListFunctionsOK) GetData() []FunctionListItem

GetData returns the value of Data.

func (*ListFunctionsOK) GetSuccess added in v0.20.0 

func (s *ListFunctionsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ListFunctionsOK) MarshalJSON added in v0.20.0 

func (s *ListFunctionsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListFunctionsOK) SetData added in v0.20.0 

func (s *ListFunctionsOK) SetData(val []FunctionListItem)

SetData sets the value of Data.

func (*ListFunctionsOK) SetSuccess added in v0.20.0 

func (s *ListFunctionsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ListFunctionsOK) UnmarshalJSON added in v0.20.0 

func (s *ListFunctionsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListFunctionsOK) Validate added in v0.20.0 

func (s *ListFunctionsOK) Validate() error

type ListFunctionsRes added in v0.20.0 

type ListFunctionsRes interface {
	// contains filtered or unexported methods
}

type ListSentEmailsBadRequest added in v0.19.0 

type ListSentEmailsBadRequest ErrorResponse

func (*ListSentEmailsBadRequest) Decode added in v0.19.0 

func (s *ListSentEmailsBadRequest) Decode(d *jx.Decoder) error

Decode decodes ListSentEmailsBadRequest from json.

func (*ListSentEmailsBadRequest) Encode added in v0.19.0 

func (s *ListSentEmailsBadRequest) Encode(e *jx.Encoder)

Encode encodes ListSentEmailsBadRequest as json.

func (*ListSentEmailsBadRequest) MarshalJSON added in v0.19.0 

func (s *ListSentEmailsBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListSentEmailsBadRequest) UnmarshalJSON added in v0.19.0 

func (s *ListSentEmailsBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListSentEmailsBadRequest) Validate added in v0.19.0 

func (s *ListSentEmailsBadRequest) Validate() error

type ListSentEmailsOK added in v0.19.0 

type ListSentEmailsOK struct {
	Success bool               `json:"success"`
	Meta    PaginationMeta     `json:"meta"`
	Data    []SentEmailSummary `json:"data"`
}

Merged schema.

func (*ListSentEmailsOK) Decode added in v0.19.0 

func (s *ListSentEmailsOK) Decode(d *jx.Decoder) error

Decode decodes ListSentEmailsOK from json.

func (*ListSentEmailsOK) Encode added in v0.19.0 

func (s *ListSentEmailsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ListSentEmailsOK) GetData added in v0.19.0 

func (s *ListSentEmailsOK) GetData() []SentEmailSummary

GetData returns the value of Data.

func (*ListSentEmailsOK) GetMeta added in v0.19.0 

func (s *ListSentEmailsOK) GetMeta() PaginationMeta

GetMeta returns the value of Meta.

func (*ListSentEmailsOK) GetSuccess added in v0.19.0 

func (s *ListSentEmailsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ListSentEmailsOK) MarshalJSON added in v0.19.0 

func (s *ListSentEmailsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListSentEmailsOK) SetData added in v0.19.0 

func (s *ListSentEmailsOK) SetData(val []SentEmailSummary)

SetData sets the value of Data.

func (*ListSentEmailsOK) SetMeta added in v0.19.0 

func (s *ListSentEmailsOK) SetMeta(val PaginationMeta)

SetMeta sets the value of Meta.

func (*ListSentEmailsOK) SetSuccess added in v0.19.0 

func (s *ListSentEmailsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ListSentEmailsOK) UnmarshalJSON added in v0.19.0 

func (s *ListSentEmailsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListSentEmailsOK) Validate added in v0.19.0 

func (s *ListSentEmailsOK) Validate() error

type ListSentEmailsParams added in v0.19.0 

type ListSentEmailsParams struct {
	// Pagination cursor from a previous response's `meta.cursor` field.
	// Format: `{ISO-datetime}|{id}`.
	Cursor OptString `json:",omitempty,omitzero"`
	// Number of results per page.
	Limit OptInt `json:",omitempty,omitzero"`
	// Filter to rows in this status. Useful for polling
	// queued rows that haven't transitioned, auditing
	// gate-denied attempts, or listing only successful
	// deliveries.
	Status OptSentEmailStatus `json:",omitempty,omitzero"`
	// Filter to the row matching a specific server-issued
	// `request_id`. The /send-mail response surfaces
	// `request_id` on every send; this lookup lets the
	// caller find the historical row for a given live call
	// without remembering its `id`.
	RequestID OptUUID `json:",omitempty,omitzero"`
	// Filter to rows with the given `client_idempotency_key`.
	// Multiple rows can share a key (a retry that hit the
	// idempotent-replay path returns the same row, but a
	// retry with a DIFFERENT canonical payload under the
	// same key is rejected by /send-mail before the row is
	// written, so duplicates are bounded).
	IdempotencyKey OptString `json:",omitempty,omitzero"`
	// Inclusive lower bound on `created_at`.
	DateFrom OptDateTime `json:",omitempty,omitzero"`
	// Inclusive upper bound on `created_at`.
	DateTo OptDateTime `json:",omitempty,omitzero"`
}

ListSentEmailsParams is parameters of listSentEmails operation.

type ListSentEmailsRes added in v0.19.0 

type ListSentEmailsRes interface {
	// contains filtered or unexported methods
}

type ListSentEmailsUnauthorized added in v0.19.0 

type ListSentEmailsUnauthorized ErrorResponse

func (*ListSentEmailsUnauthorized) Decode added in v0.19.0 

func (s *ListSentEmailsUnauthorized) Decode(d *jx.Decoder) error

Decode decodes ListSentEmailsUnauthorized from json.

func (*ListSentEmailsUnauthorized) Encode added in v0.19.0 

func (s *ListSentEmailsUnauthorized) Encode(e *jx.Encoder)

Encode encodes ListSentEmailsUnauthorized as json.

func (*ListSentEmailsUnauthorized) MarshalJSON added in v0.19.0 

func (s *ListSentEmailsUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListSentEmailsUnauthorized) UnmarshalJSON added in v0.19.0 

func (s *ListSentEmailsUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ListSentEmailsUnauthorized) Validate added in v0.19.0 

func (s *ListSentEmailsUnauthorized) Validate() error

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type NilBool added in v0.29.0 

type NilBool struct {
	Value bool
	Null  bool
}

NilBool is nullable bool.

func NewNilBool added in v0.29.0 

func NewNilBool(v bool) NilBool

NewNilBool returns new NilBool with value set to v.

func (*NilBool) Decode added in v0.29.0 

func (o *NilBool) Decode(d *jx.Decoder) error

Decode decodes bool from json.

func (NilBool) Encode added in v0.29.0 

func (o NilBool) Encode(e *jx.Encoder)

Encode encodes bool as json.

func (NilBool) Get added in v0.29.0 

func (o NilBool) Get() (v bool, ok bool)

Get returns value and boolean that denotes whether value was set.

func (NilBool) IsNull added in v0.29.0 

func (o NilBool) IsNull() bool

IsNull returns true if value is Null.

func (NilBool) MarshalJSON added in v0.29.0 

func (s NilBool) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (NilBool) Or added in v0.29.0 

func (o NilBool) Or(d bool) bool

Or returns value if set, or given parameter if does not.

func (*NilBool) SetTo added in v0.29.0 

func (o *NilBool) SetTo(v bool)

SetTo sets value to v.

func (*NilBool) SetToNull added in v0.29.0 

func (o *NilBool) SetToNull()

SetToNull sets value to null.

func (*NilBool) UnmarshalJSON added in v0.29.0 

func (s *NilBool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type NilDateTime added in v0.29.0 

type NilDateTime struct {
	Value time.Time
	Null  bool
}

NilDateTime is nullable time.Time.

func NewNilDateTime added in v0.29.0 

func NewNilDateTime(v time.Time) NilDateTime

NewNilDateTime returns new NilDateTime with value set to v.

func (*NilDateTime) Decode added in v0.29.0 

func (o *NilDateTime) Decode(d *jx.Decoder, format func(*jx.Decoder) (time.Time, error)) error

Decode decodes time.Time from json.

func (NilDateTime) Encode added in v0.29.0 

func (o NilDateTime) Encode(e *jx.Encoder, format func(*jx.Encoder, time.Time))

Encode encodes time.Time as json.

func (NilDateTime) Get added in v0.29.0 

func (o NilDateTime) Get() (v time.Time, ok bool)

Get returns value and boolean that denotes whether value was set.

func (NilDateTime) IsNull added in v0.29.0 

func (o NilDateTime) IsNull() bool

IsNull returns true if value is Null.

func (NilDateTime) MarshalJSON added in v0.29.0 

func (s NilDateTime) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (NilDateTime) Or added in v0.29.0 

func (o NilDateTime) Or(d time.Time) time.Time

Or returns value if set, or given parameter if does not.

func (*NilDateTime) SetTo added in v0.29.0 

func (o *NilDateTime) SetTo(v time.Time)

SetTo sets value to v.

func (*NilDateTime) SetToNull added in v0.29.0 

func (o *NilDateTime) SetToNull()

SetToNull sets value to null.

func (*NilDateTime) UnmarshalJSON added in v0.29.0 

func (s *NilDateTime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type NilEmailWebhookStatus added in v0.29.0 

type NilEmailWebhookStatus struct {
	Value EmailWebhookStatus
	Null  bool
}

NilEmailWebhookStatus is nullable EmailWebhookStatus.

func NewNilEmailWebhookStatus added in v0.29.0 

func NewNilEmailWebhookStatus(v EmailWebhookStatus) NilEmailWebhookStatus

NewNilEmailWebhookStatus returns new NilEmailWebhookStatus with value set to v.

func (*NilEmailWebhookStatus) Decode added in v0.29.0 

func (o *NilEmailWebhookStatus) Decode(d *jx.Decoder) error

Decode decodes EmailWebhookStatus from json.

func (NilEmailWebhookStatus) Encode added in v0.29.0 

func (o NilEmailWebhookStatus) Encode(e *jx.Encoder)

Encode encodes EmailWebhookStatus as json.

func (NilEmailWebhookStatus) Get added in v0.29.0 

func (o NilEmailWebhookStatus) Get() (v EmailWebhookStatus, ok bool)

Get returns value and boolean that denotes whether value was set.

func (NilEmailWebhookStatus) IsNull added in v0.29.0 

func (o NilEmailWebhookStatus) IsNull() bool

IsNull returns true if value is Null.

func (NilEmailWebhookStatus) MarshalJSON added in v0.29.0 

func (s NilEmailWebhookStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (NilEmailWebhookStatus) Or added in v0.29.0 

func (o NilEmailWebhookStatus) Or(d EmailWebhookStatus) EmailWebhookStatus

Or returns value if set, or given parameter if does not.

func (*NilEmailWebhookStatus) SetTo added in v0.29.0 

func (o *NilEmailWebhookStatus) SetTo(v EmailWebhookStatus)

SetTo sets value to v.

func (*NilEmailWebhookStatus) SetToNull added in v0.29.0 

func (o *NilEmailWebhookStatus) SetToNull()

SetToNull sets value to null.

func (*NilEmailWebhookStatus) UnmarshalJSON added in v0.29.0 

func (s *NilEmailWebhookStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type NilFunctionTestRunDeliveryEndpoint added in v0.29.0 

type NilFunctionTestRunDeliveryEndpoint struct {
	Value FunctionTestRunDeliveryEndpoint
	Null  bool
}

NilFunctionTestRunDeliveryEndpoint is nullable FunctionTestRunDeliveryEndpoint.

func NewNilFunctionTestRunDeliveryEndpoint added in v0.29.0 

func NewNilFunctionTestRunDeliveryEndpoint(v FunctionTestRunDeliveryEndpoint) NilFunctionTestRunDeliveryEndpoint

NewNilFunctionTestRunDeliveryEndpoint returns new NilFunctionTestRunDeliveryEndpoint with value set to v.

func (*NilFunctionTestRunDeliveryEndpoint) Decode added in v0.29.0 

func (o *NilFunctionTestRunDeliveryEndpoint) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunDeliveryEndpoint from json.

func (NilFunctionTestRunDeliveryEndpoint) Encode added in v0.29.0 

func (o NilFunctionTestRunDeliveryEndpoint) Encode(e *jx.Encoder)

Encode encodes FunctionTestRunDeliveryEndpoint as json.

func (NilFunctionTestRunDeliveryEndpoint) Get added in v0.29.0 

func (o NilFunctionTestRunDeliveryEndpoint) Get() (v FunctionTestRunDeliveryEndpoint, ok bool)

Get returns value and boolean that denotes whether value was set.

func (NilFunctionTestRunDeliveryEndpoint) IsNull added in v0.29.0 

func (o NilFunctionTestRunDeliveryEndpoint) IsNull() bool

IsNull returns true if value is Null.

func (NilFunctionTestRunDeliveryEndpoint) MarshalJSON added in v0.29.0 

func (s NilFunctionTestRunDeliveryEndpoint) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (NilFunctionTestRunDeliveryEndpoint) Or added in v0.29.0 

func (o NilFunctionTestRunDeliveryEndpoint) Or(d FunctionTestRunDeliveryEndpoint) FunctionTestRunDeliveryEndpoint

Or returns value if set, or given parameter if does not.

func (*NilFunctionTestRunDeliveryEndpoint) SetTo added in v0.29.0 

func (o *NilFunctionTestRunDeliveryEndpoint) SetTo(v FunctionTestRunDeliveryEndpoint)

SetTo sets value to v.

func (*NilFunctionTestRunDeliveryEndpoint) SetToNull added in v0.29.0 

func (o *NilFunctionTestRunDeliveryEndpoint) SetToNull()

SetToNull sets value to null.

func (*NilFunctionTestRunDeliveryEndpoint) UnmarshalJSON added in v0.29.0 

func (s *NilFunctionTestRunDeliveryEndpoint) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type NilFunctionTestRunInboundEmail added in v0.29.0 

type NilFunctionTestRunInboundEmail struct {
	Value FunctionTestRunInboundEmail
	Null  bool
}

NilFunctionTestRunInboundEmail is nullable FunctionTestRunInboundEmail.

func NewNilFunctionTestRunInboundEmail added in v0.29.0 

func NewNilFunctionTestRunInboundEmail(v FunctionTestRunInboundEmail) NilFunctionTestRunInboundEmail

NewNilFunctionTestRunInboundEmail returns new NilFunctionTestRunInboundEmail with value set to v.

func (*NilFunctionTestRunInboundEmail) Decode added in v0.29.0 

func (o *NilFunctionTestRunInboundEmail) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunInboundEmail from json.

func (NilFunctionTestRunInboundEmail) Encode added in v0.29.0 

func (o NilFunctionTestRunInboundEmail) Encode(e *jx.Encoder)

Encode encodes FunctionTestRunInboundEmail as json.

func (NilFunctionTestRunInboundEmail) Get added in v0.29.0 

func (o NilFunctionTestRunInboundEmail) Get() (v FunctionTestRunInboundEmail, ok bool)

Get returns value and boolean that denotes whether value was set.

func (NilFunctionTestRunInboundEmail) IsNull added in v0.29.0 

func (o NilFunctionTestRunInboundEmail) IsNull() bool

IsNull returns true if value is Null.

func (NilFunctionTestRunInboundEmail) MarshalJSON added in v0.29.0 

func (s NilFunctionTestRunInboundEmail) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (NilFunctionTestRunInboundEmail) Or added in v0.29.0 

func (o NilFunctionTestRunInboundEmail) Or(d FunctionTestRunInboundEmail) FunctionTestRunInboundEmail

Or returns value if set, or given parameter if does not.

func (*NilFunctionTestRunInboundEmail) SetTo added in v0.29.0 

func (o *NilFunctionTestRunInboundEmail) SetTo(v FunctionTestRunInboundEmail)

SetTo sets value to v.

func (*NilFunctionTestRunInboundEmail) SetToNull added in v0.29.0 

func (o *NilFunctionTestRunInboundEmail) SetToNull()

SetToNull sets value to null.

func (*NilFunctionTestRunInboundEmail) UnmarshalJSON added in v0.29.0 

func (s *NilFunctionTestRunInboundEmail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type NilFunctionTestRunSend added in v0.29.0 

type NilFunctionTestRunSend struct {
	Value FunctionTestRunSend
	Null  bool
}

NilFunctionTestRunSend is nullable FunctionTestRunSend.

func NewNilFunctionTestRunSend added in v0.29.0 

func NewNilFunctionTestRunSend(v FunctionTestRunSend) NilFunctionTestRunSend

NewNilFunctionTestRunSend returns new NilFunctionTestRunSend with value set to v.

func (*NilFunctionTestRunSend) Decode added in v0.29.0 

func (o *NilFunctionTestRunSend) Decode(d *jx.Decoder) error

Decode decodes FunctionTestRunSend from json.

func (NilFunctionTestRunSend) Encode added in v0.29.0 

func (o NilFunctionTestRunSend) Encode(e *jx.Encoder)

Encode encodes FunctionTestRunSend as json.

func (NilFunctionTestRunSend) Get added in v0.29.0 

func (o NilFunctionTestRunSend) Get() (v FunctionTestRunSend, ok bool)

Get returns value and boolean that denotes whether value was set.

func (NilFunctionTestRunSend) IsNull added in v0.29.0 

func (o NilFunctionTestRunSend) IsNull() bool

IsNull returns true if value is Null.

func (NilFunctionTestRunSend) MarshalJSON added in v0.29.0 

func (s NilFunctionTestRunSend) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (NilFunctionTestRunSend) Or added in v0.29.0 

func (o NilFunctionTestRunSend) Or(d FunctionTestRunSend) FunctionTestRunSend

Or returns value if set, or given parameter if does not.

func (*NilFunctionTestRunSend) SetTo added in v0.29.0 

func (o *NilFunctionTestRunSend) SetTo(v FunctionTestRunSend)

SetTo sets value to v.

func (*NilFunctionTestRunSend) SetToNull added in v0.29.0 

func (o *NilFunctionTestRunSend) SetToNull()

SetToNull sets value to null.

func (*NilFunctionTestRunSend) UnmarshalJSON added in v0.29.0 

func (s *NilFunctionTestRunSend) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type NilInt added in v0.29.0 

type NilInt struct {
	Value int
	Null  bool
}

NilInt is nullable int.

func NewNilInt added in v0.29.0 

func NewNilInt(v int) NilInt

NewNilInt returns new NilInt with value set to v.

func (*NilInt) Decode added in v0.29.0 

func (o *NilInt) Decode(d *jx.Decoder) error

Decode decodes int from json.

func (NilInt) Encode added in v0.29.0 

func (o NilInt) Encode(e *jx.Encoder)

Encode encodes int as json.

func (NilInt) Get added in v0.29.0 

func (o NilInt) Get() (v int, ok bool)

Get returns value and boolean that denotes whether value was set.

func (NilInt) IsNull added in v0.29.0 

func (o NilInt) IsNull() bool

IsNull returns true if value is Null.

func (NilInt) MarshalJSON added in v0.29.0 

func (s NilInt) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (NilInt) Or added in v0.29.0 

func (o NilInt) Or(d int) int

Or returns value if set, or given parameter if does not.

func (*NilInt) SetTo added in v0.29.0 

func (o *NilInt) SetTo(v int)

SetTo sets value to v.

func (*NilInt) SetToNull added in v0.29.0 

func (o *NilInt) SetToNull()

SetToNull sets value to null.

func (*NilInt) UnmarshalJSON added in v0.29.0 

func (s *NilInt) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type NilString 

type NilString struct {
	Value string
	Null  bool
}

NilString is nullable string.

func NewNilString 

func NewNilString(v string) NilString

NewNilString returns new NilString with value set to v.

func (*NilString) Decode 

func (o *NilString) Decode(d *jx.Decoder) error

Decode decodes string from json.

func (NilString) Encode 

func (o NilString) Encode(e *jx.Encoder)

Encode encodes string as json.

func (NilString) Get 

func (o NilString) Get() (v string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (NilString) IsNull 

func (o NilString) IsNull() bool

IsNull returns true if value is Null.

func (NilString) MarshalJSON 

func (s NilString) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (NilString) Or 

func (o NilString) Or(d string) string

Or returns value if set, or given parameter if does not.

func (*NilString) SetTo 

func (o *NilString) SetTo(v string)

SetTo sets value to v.

func (*NilString) SetToNull 

func (o *NilString) SetToNull()

SetToNull sets value to null.

func (*NilString) UnmarshalJSON 

func (s *NilString) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type NilUUID added in v0.29.0 

type NilUUID struct {
	Value uuid.UUID
	Null  bool
}

NilUUID is nullable uuid.UUID.

func NewNilUUID added in v0.29.0 

func NewNilUUID(v uuid.UUID) NilUUID

NewNilUUID returns new NilUUID with value set to v.

func (*NilUUID) Decode added in v0.29.0 

func (o *NilUUID) Decode(d *jx.Decoder) error

Decode decodes uuid.UUID from json.

func (NilUUID) Encode added in v0.29.0 

func (o NilUUID) Encode(e *jx.Encoder)

Encode encodes uuid.UUID as json.

func (NilUUID) Get added in v0.29.0 

func (o NilUUID) Get() (v uuid.UUID, ok bool)

Get returns value and boolean that denotes whether value was set.

func (NilUUID) IsNull added in v0.29.0 

func (o NilUUID) IsNull() bool

IsNull returns true if value is Null.

func (NilUUID) MarshalJSON added in v0.29.0 

func (s NilUUID) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (NilUUID) Or added in v0.29.0 

func (o NilUUID) Or(d uuid.UUID) uuid.UUID

Or returns value if set, or given parameter if does not.

func (*NilUUID) SetTo added in v0.29.0 

func (o *NilUUID) SetTo(v uuid.UUID)

SetTo sets value to v.

func (*NilUUID) SetToNull added in v0.29.0 

func (o *NilUUID) SetToNull()

SetToNull sets value to null.

func (*NilUUID) UnmarshalJSON added in v0.29.0 

func (s *NilUUID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OperationName 

type OperationName = string

OperationName is the ogen operation name 

const (
	AddDomainOperation                     OperationName = "AddDomain"
	CliLogoutOperation                     OperationName = "CliLogout"
	CreateEndpointOperation                OperationName = "CreateEndpoint"
	CreateFilterOperation                  OperationName = "CreateFilter"
	CreateFunctionOperation                OperationName = "CreateFunction"
	CreateFunctionSecretOperation          OperationName = "CreateFunctionSecret"
	DeleteDomainOperation                  OperationName = "DeleteDomain"
	DeleteEmailOperation                   OperationName = "DeleteEmail"
	DeleteEndpointOperation                OperationName = "DeleteEndpoint"
	DeleteFilterOperation                  OperationName = "DeleteFilter"
	DeleteFunctionOperation                OperationName = "DeleteFunction"
	DeleteFunctionSecretOperation          OperationName = "DeleteFunctionSecret"
	DiscardEmailContentOperation           OperationName = "DiscardEmailContent"
	DownloadAttachmentsOperation           OperationName = "DownloadAttachments"
	DownloadDomainZoneFileOperation        OperationName = "DownloadDomainZoneFile"
	DownloadRawEmailOperation              OperationName = "DownloadRawEmail"
	GetAccountOperation                    OperationName = "GetAccount"
	GetEmailOperation                      OperationName = "GetEmail"
	GetFunctionOperation                   OperationName = "GetFunction"
	GetFunctionTestRunTraceOperation       OperationName = "GetFunctionTestRunTrace"
	GetInboxStatusOperation                OperationName = "GetInboxStatus"
	GetSendPermissionsOperation            OperationName = "GetSendPermissions"
	GetSentEmailOperation                  OperationName = "GetSentEmail"
	GetStorageStatsOperation               OperationName = "GetStorageStats"
	GetWebhookSecretOperation              OperationName = "GetWebhookSecret"
	ListDeliveriesOperation                OperationName = "ListDeliveries"
	ListDomainsOperation                   OperationName = "ListDomains"
	ListEmailsOperation                    OperationName = "ListEmails"
	ListEndpointsOperation                 OperationName = "ListEndpoints"
	ListFiltersOperation                   OperationName = "ListFilters"
	ListFunctionLogsOperation              OperationName = "ListFunctionLogs"
	ListFunctionSecretsOperation           OperationName = "ListFunctionSecrets"
	ListFunctionsOperation                 OperationName = "ListFunctions"
	ListSentEmailsOperation                OperationName = "ListSentEmails"
	PollCliLoginOperation                  OperationName = "PollCliLogin"
	ReplayDeliveryOperation                OperationName = "ReplayDelivery"
	ReplayEmailWebhooksOperation           OperationName = "ReplayEmailWebhooks"
	ReplyToEmailOperation                  OperationName = "ReplyToEmail"
	ResendAgentSignupVerificationOperation OperationName = "ResendAgentSignupVerification"
	ResendCliSignupVerificationOperation   OperationName = "ResendCliSignupVerification"
	RotateWebhookSecretOperation           OperationName = "RotateWebhookSecret"
	SearchEmailsOperation                  OperationName = "SearchEmails"
	SendEmailOperation                     OperationName = "SendEmail"
	SetFunctionSecretOperation             OperationName = "SetFunctionSecret"
	StartAgentSignupOperation              OperationName = "StartAgentSignup"
	StartCliLoginOperation                 OperationName = "StartCliLogin"
	StartCliSignupOperation                OperationName = "StartCliSignup"
	TestEndpointOperation                  OperationName = "TestEndpoint"
	TestFunctionOperation                  OperationName = "TestFunction"
	UpdateAccountOperation                 OperationName = "UpdateAccount"
	UpdateDomainOperation                  OperationName = "UpdateDomain"
	UpdateEndpointOperation                OperationName = "UpdateEndpoint"
	UpdateFilterOperation                  OperationName = "UpdateFilter"
	UpdateFunctionOperation                OperationName = "UpdateFunction"
	VerifyAgentSignupOperation             OperationName = "VerifyAgentSignup"
	VerifyCliSignupOperation               OperationName = "VerifyCliSignup"
	VerifyDomainOperation                  OperationName = "VerifyDomain"
)

type OptBool 

type OptBool struct {
	Value bool
	Set   bool
}

OptBool is optional bool.

func NewOptBool 

func NewOptBool(v bool) OptBool

NewOptBool returns new OptBool with value set to v.

func (*OptBool) Decode 

func (o *OptBool) Decode(d *jx.Decoder) error

Decode decodes bool from json.

func (OptBool) Encode 

func (o OptBool) Encode(e *jx.Encoder)

Encode encodes bool as json.

func (OptBool) Get 

func (o OptBool) Get() (v bool, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptBool) IsSet 

func (o OptBool) IsSet() bool

IsSet returns true if OptBool was set.

func (OptBool) MarshalJSON 

func (s OptBool) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptBool) Or 

func (o OptBool) Or(d bool) bool

Or returns value if set, or given parameter if does not.

func (*OptBool) Reset 

func (o *OptBool) Reset()

Reset unsets value.

func (*OptBool) SetTo 

func (o *OptBool) SetTo(v bool)

SetTo sets value to v.

func (*OptBool) UnmarshalJSON 

func (s *OptBool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptCliLogoutInput added in v0.19.0 

type OptCliLogoutInput struct {
	Value CliLogoutInput
	Set   bool
}

OptCliLogoutInput is optional CliLogoutInput.

func NewOptCliLogoutInput added in v0.19.0 

func NewOptCliLogoutInput(v CliLogoutInput) OptCliLogoutInput

NewOptCliLogoutInput returns new OptCliLogoutInput with value set to v.

func (*OptCliLogoutInput) Decode added in v0.19.0 

func (o *OptCliLogoutInput) Decode(d *jx.Decoder) error

Decode decodes CliLogoutInput from json.

func (OptCliLogoutInput) Encode added in v0.19.0 

func (o OptCliLogoutInput) Encode(e *jx.Encoder)

Encode encodes CliLogoutInput as json.

func (OptCliLogoutInput) Get added in v0.19.0 

func (o OptCliLogoutInput) Get() (v CliLogoutInput, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptCliLogoutInput) IsSet added in v0.19.0 

func (o OptCliLogoutInput) IsSet() bool

IsSet returns true if OptCliLogoutInput was set.

func (OptCliLogoutInput) MarshalJSON added in v0.19.0 

func (s OptCliLogoutInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptCliLogoutInput) Or added in v0.19.0 

func (o OptCliLogoutInput) Or(d CliLogoutInput) CliLogoutInput

Or returns value if set, or given parameter if does not.

func (*OptCliLogoutInput) Reset added in v0.19.0 

func (o *OptCliLogoutInput) Reset()

Reset unsets value.

func (*OptCliLogoutInput) SetTo added in v0.19.0 

func (o *OptCliLogoutInput) SetTo(v CliLogoutInput)

SetTo sets value to v.

func (*OptCliLogoutInput) UnmarshalJSON added in v0.19.0 

func (s *OptCliLogoutInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptDateTime 

type OptDateTime struct {
	Value time.Time
	Set   bool
}

OptDateTime is optional time.Time.

func NewOptDateTime 

func NewOptDateTime(v time.Time) OptDateTime

NewOptDateTime returns new OptDateTime with value set to v.

func (OptDateTime) Get 

func (o OptDateTime) Get() (v time.Time, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptDateTime) IsSet 

func (o OptDateTime) IsSet() bool

IsSet returns true if OptDateTime was set.

func (OptDateTime) Or 

func (o OptDateTime) Or(d time.Time) time.Time

Or returns value if set, or given parameter if does not.

func (*OptDateTime) Reset 

func (o *OptDateTime) Reset()

Reset unsets value.

func (*OptDateTime) SetTo 

func (o *OptDateTime) SetTo(v time.Time)

SetTo sets value to v.

type OptDeliveryStatus added in v0.8.0 

type OptDeliveryStatus struct {
	Value DeliveryStatus
	Set   bool
}

OptDeliveryStatus is optional DeliveryStatus.

func NewOptDeliveryStatus added in v0.8.0 

func NewOptDeliveryStatus(v DeliveryStatus) OptDeliveryStatus

NewOptDeliveryStatus returns new OptDeliveryStatus with value set to v.

func (*OptDeliveryStatus) Decode added in v0.8.0 

func (o *OptDeliveryStatus) Decode(d *jx.Decoder) error

Decode decodes DeliveryStatus from json.

func (OptDeliveryStatus) Encode added in v0.8.0 

func (o OptDeliveryStatus) Encode(e *jx.Encoder)

Encode encodes DeliveryStatus as json.

func (OptDeliveryStatus) Get added in v0.8.0 

func (o OptDeliveryStatus) Get() (v DeliveryStatus, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptDeliveryStatus) IsSet added in v0.8.0 

func (o OptDeliveryStatus) IsSet() bool

IsSet returns true if OptDeliveryStatus was set.

func (OptDeliveryStatus) MarshalJSON added in v0.8.0 

func (s OptDeliveryStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptDeliveryStatus) Or added in v0.8.0 

func (o OptDeliveryStatus) Or(d DeliveryStatus) DeliveryStatus

Or returns value if set, or given parameter if does not.

func (*OptDeliveryStatus) Reset added in v0.8.0 

func (o *OptDeliveryStatus) Reset()

Reset unsets value.

func (*OptDeliveryStatus) SetTo added in v0.8.0 

func (o *OptDeliveryStatus) SetTo(v DeliveryStatus)

SetTo sets value to v.

func (*OptDeliveryStatus) UnmarshalJSON added in v0.8.0 

func (s *OptDeliveryStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptEmailSearchFacets added in v0.21.0 

type OptEmailSearchFacets struct {
	Value EmailSearchFacets
	Set   bool
}

OptEmailSearchFacets is optional EmailSearchFacets.

func NewOptEmailSearchFacets added in v0.21.0 

func NewOptEmailSearchFacets(v EmailSearchFacets) OptEmailSearchFacets

NewOptEmailSearchFacets returns new OptEmailSearchFacets with value set to v.

func (*OptEmailSearchFacets) Decode added in v0.21.0 

func (o *OptEmailSearchFacets) Decode(d *jx.Decoder) error

Decode decodes EmailSearchFacets from json.

func (OptEmailSearchFacets) Encode added in v0.21.0 

func (o OptEmailSearchFacets) Encode(e *jx.Encoder)

Encode encodes EmailSearchFacets as json.

func (OptEmailSearchFacets) Get added in v0.21.0 

func (o OptEmailSearchFacets) Get() (v EmailSearchFacets, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptEmailSearchFacets) IsSet added in v0.21.0 

func (o OptEmailSearchFacets) IsSet() bool

IsSet returns true if OptEmailSearchFacets was set.

func (OptEmailSearchFacets) MarshalJSON added in v0.21.0 

func (s OptEmailSearchFacets) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptEmailSearchFacets) Or added in v0.21.0 

func (o OptEmailSearchFacets) Or(d EmailSearchFacets) EmailSearchFacets

Or returns value if set, or given parameter if does not.

func (*OptEmailSearchFacets) Reset added in v0.21.0 

func (o *OptEmailSearchFacets) Reset()

Reset unsets value.

func (*OptEmailSearchFacets) SetTo added in v0.21.0 

func (o *OptEmailSearchFacets) SetTo(v EmailSearchFacets)

SetTo sets value to v.

func (*OptEmailSearchFacets) UnmarshalJSON added in v0.21.0 

func (s *OptEmailSearchFacets) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptEmailSearchHighlights added in v0.21.0 

type OptEmailSearchHighlights struct {
	Value EmailSearchHighlights
	Set   bool
}

OptEmailSearchHighlights is optional EmailSearchHighlights.

func NewOptEmailSearchHighlights added in v0.21.0 

func NewOptEmailSearchHighlights(v EmailSearchHighlights) OptEmailSearchHighlights

NewOptEmailSearchHighlights returns new OptEmailSearchHighlights with value set to v.

func (*OptEmailSearchHighlights) Decode added in v0.21.0 

func (o *OptEmailSearchHighlights) Decode(d *jx.Decoder) error

Decode decodes EmailSearchHighlights from json.

func (OptEmailSearchHighlights) Encode added in v0.21.0 

func (o OptEmailSearchHighlights) Encode(e *jx.Encoder)

Encode encodes EmailSearchHighlights as json.

func (OptEmailSearchHighlights) Get added in v0.21.0 

func (o OptEmailSearchHighlights) Get() (v EmailSearchHighlights, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptEmailSearchHighlights) IsSet added in v0.21.0 

func (o OptEmailSearchHighlights) IsSet() bool

IsSet returns true if OptEmailSearchHighlights was set.

func (OptEmailSearchHighlights) MarshalJSON added in v0.21.0 

func (s OptEmailSearchHighlights) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptEmailSearchHighlights) Or added in v0.21.0 

func (o OptEmailSearchHighlights) Or(d EmailSearchHighlights) EmailSearchHighlights

Or returns value if set, or given parameter if does not.

func (*OptEmailSearchHighlights) Reset added in v0.21.0 

func (o *OptEmailSearchHighlights) Reset()

Reset unsets value.

func (*OptEmailSearchHighlights) SetTo added in v0.21.0 

func (o *OptEmailSearchHighlights) SetTo(v EmailSearchHighlights)

SetTo sets value to v.

func (*OptEmailSearchHighlights) UnmarshalJSON added in v0.21.0 

func (s *OptEmailSearchHighlights) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptEmailStatus added in v0.19.0 

type OptEmailStatus struct {
	Value EmailStatus
	Set   bool
}

OptEmailStatus is optional EmailStatus.

func NewOptEmailStatus added in v0.19.0 

func NewOptEmailStatus(v EmailStatus) OptEmailStatus

NewOptEmailStatus returns new OptEmailStatus with value set to v.

func (*OptEmailStatus) Decode added in v0.21.0 

func (o *OptEmailStatus) Decode(d *jx.Decoder) error

Decode decodes EmailStatus from json.

func (OptEmailStatus) Encode added in v0.21.0 

func (o OptEmailStatus) Encode(e *jx.Encoder)

Encode encodes EmailStatus as json.

func (OptEmailStatus) Get added in v0.19.0 

func (o OptEmailStatus) Get() (v EmailStatus, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptEmailStatus) IsSet added in v0.19.0 

func (o OptEmailStatus) IsSet() bool

IsSet returns true if OptEmailStatus was set.

func (OptEmailStatus) MarshalJSON added in v0.21.0 

func (s OptEmailStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptEmailStatus) Or added in v0.19.0 

func (o OptEmailStatus) Or(d EmailStatus) EmailStatus

Or returns value if set, or given parameter if does not.

func (*OptEmailStatus) Reset added in v0.19.0 

func (o *OptEmailStatus) Reset()

Reset unsets value.

func (*OptEmailStatus) SetTo added in v0.19.0 

func (o *OptEmailStatus) SetTo(v EmailStatus)

SetTo sets value to v.

func (*OptEmailStatus) UnmarshalJSON added in v0.21.0 

func (s *OptEmailStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptErrorResponseErrorDetails added in v0.4.0 

type OptErrorResponseErrorDetails struct {
	Value ErrorResponseErrorDetails
	Set   bool
}

OptErrorResponseErrorDetails is optional ErrorResponseErrorDetails.

func NewOptErrorResponseErrorDetails added in v0.4.0 

func NewOptErrorResponseErrorDetails(v ErrorResponseErrorDetails) OptErrorResponseErrorDetails

NewOptErrorResponseErrorDetails returns new OptErrorResponseErrorDetails with value set to v.

func (*OptErrorResponseErrorDetails) Decode added in v0.4.0 

func (o *OptErrorResponseErrorDetails) Decode(d *jx.Decoder) error

Decode decodes ErrorResponseErrorDetails from json.

func (OptErrorResponseErrorDetails) Encode added in v0.4.0 

func (o OptErrorResponseErrorDetails) Encode(e *jx.Encoder)

Encode encodes ErrorResponseErrorDetails as json.

func (OptErrorResponseErrorDetails) Get added in v0.4.0 

func (o OptErrorResponseErrorDetails) Get() (v ErrorResponseErrorDetails, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptErrorResponseErrorDetails) IsSet added in v0.4.0 

func (o OptErrorResponseErrorDetails) IsSet() bool

IsSet returns true if OptErrorResponseErrorDetails was set.

func (OptErrorResponseErrorDetails) MarshalJSON added in v0.4.0 

func (s OptErrorResponseErrorDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptErrorResponseErrorDetails) Or added in v0.4.0 

func (o OptErrorResponseErrorDetails) Or(d ErrorResponseErrorDetails) ErrorResponseErrorDetails

Or returns value if set, or given parameter if does not.

func (*OptErrorResponseErrorDetails) Reset added in v0.4.0 

func (o *OptErrorResponseErrorDetails) Reset()

Reset unsets value.

func (*OptErrorResponseErrorDetails) SetTo added in v0.4.0 

func (o *OptErrorResponseErrorDetails) SetTo(v ErrorResponseErrorDetails)

SetTo sets value to v.

func (*OptErrorResponseErrorDetails) UnmarshalJSON added in v0.4.0 

func (s *OptErrorResponseErrorDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptErrorResponseErrorDetailsMxConflict added in v0.4.0 

type OptErrorResponseErrorDetailsMxConflict struct {
	Value ErrorResponseErrorDetailsMxConflict
	Set   bool
}

OptErrorResponseErrorDetailsMxConflict is optional ErrorResponseErrorDetailsMxConflict.

func NewOptErrorResponseErrorDetailsMxConflict added in v0.4.0 

func NewOptErrorResponseErrorDetailsMxConflict(v ErrorResponseErrorDetailsMxConflict) OptErrorResponseErrorDetailsMxConflict

NewOptErrorResponseErrorDetailsMxConflict returns new OptErrorResponseErrorDetailsMxConflict with value set to v.

func (*OptErrorResponseErrorDetailsMxConflict) Decode added in v0.4.0 

func (o *OptErrorResponseErrorDetailsMxConflict) Decode(d *jx.Decoder) error

Decode decodes ErrorResponseErrorDetailsMxConflict from json.

func (OptErrorResponseErrorDetailsMxConflict) Encode added in v0.4.0 

func (o OptErrorResponseErrorDetailsMxConflict) Encode(e *jx.Encoder)

Encode encodes ErrorResponseErrorDetailsMxConflict as json.

func (OptErrorResponseErrorDetailsMxConflict) Get added in v0.4.0 

func (o OptErrorResponseErrorDetailsMxConflict) Get() (v ErrorResponseErrorDetailsMxConflict, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptErrorResponseErrorDetailsMxConflict) IsSet added in v0.4.0 

func (o OptErrorResponseErrorDetailsMxConflict) IsSet() bool

IsSet returns true if OptErrorResponseErrorDetailsMxConflict was set.

func (OptErrorResponseErrorDetailsMxConflict) MarshalJSON added in v0.4.0 

func (s OptErrorResponseErrorDetailsMxConflict) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptErrorResponseErrorDetailsMxConflict) Or added in v0.4.0 

func (o OptErrorResponseErrorDetailsMxConflict) Or(d ErrorResponseErrorDetailsMxConflict) ErrorResponseErrorDetailsMxConflict

Or returns value if set, or given parameter if does not.

func (*OptErrorResponseErrorDetailsMxConflict) Reset added in v0.4.0 

func (o *OptErrorResponseErrorDetailsMxConflict) Reset()

Reset unsets value.

func (*OptErrorResponseErrorDetailsMxConflict) SetTo added in v0.4.0 

func (o *OptErrorResponseErrorDetailsMxConflict) SetTo(v ErrorResponseErrorDetailsMxConflict)

SetTo sets value to v.

func (*OptErrorResponseErrorDetailsMxConflict) UnmarshalJSON added in v0.4.0 

func (s *OptErrorResponseErrorDetailsMxConflict) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptFloat64 added in v0.21.0 

type OptFloat64 struct {
	Value float64
	Set   bool
}

OptFloat64 is optional float64.

func NewOptFloat64 added in v0.21.0 

func NewOptFloat64(v float64) OptFloat64

NewOptFloat64 returns new OptFloat64 with value set to v.

func (*OptFloat64) Decode added in v0.21.0 

func (o *OptFloat64) Decode(d *jx.Decoder) error

Decode decodes float64 from json.

func (OptFloat64) Encode added in v0.21.0 

func (o OptFloat64) Encode(e *jx.Encoder)

Encode encodes float64 as json.

func (OptFloat64) Get added in v0.21.0 

func (o OptFloat64) Get() (v float64, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptFloat64) IsSet added in v0.21.0 

func (o OptFloat64) IsSet() bool

IsSet returns true if OptFloat64 was set.

func (OptFloat64) MarshalJSON added in v0.21.0 

func (s OptFloat64) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptFloat64) Or added in v0.21.0 

func (o OptFloat64) Or(d float64) float64

Or returns value if set, or given parameter if does not.

func (*OptFloat64) Reset added in v0.21.0 

func (o *OptFloat64) Reset()

Reset unsets value.

func (*OptFloat64) SetTo added in v0.21.0 

func (o *OptFloat64) SetTo(v float64)

SetTo sets value to v.

func (*OptFloat64) UnmarshalJSON added in v0.21.0 

func (s *OptFloat64) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptGateFix added in v0.8.0 

type OptGateFix struct {
	Value GateFix
	Set   bool
}

OptGateFix is optional GateFix.

func NewOptGateFix added in v0.8.0 

func NewOptGateFix(v GateFix) OptGateFix

NewOptGateFix returns new OptGateFix with value set to v.

func (*OptGateFix) Decode added in v0.8.0 

func (o *OptGateFix) Decode(d *jx.Decoder) error

Decode decodes GateFix from json.

func (OptGateFix) Encode added in v0.8.0 

func (o OptGateFix) Encode(e *jx.Encoder)

Encode encodes GateFix as json.

func (OptGateFix) Get added in v0.8.0 

func (o OptGateFix) Get() (v GateFix, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptGateFix) IsSet added in v0.8.0 

func (o OptGateFix) IsSet() bool

IsSet returns true if OptGateFix was set.

func (OptGateFix) MarshalJSON added in v0.8.0 

func (s OptGateFix) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptGateFix) Or added in v0.8.0 

func (o OptGateFix) Or(d GateFix) GateFix

Or returns value if set, or given parameter if does not.

func (*OptGateFix) Reset added in v0.8.0 

func (o *OptGateFix) Reset()

Reset unsets value.

func (*OptGateFix) SetTo added in v0.8.0 

func (o *OptGateFix) SetTo(v GateFix)

SetTo sets value to v.

func (*OptGateFix) UnmarshalJSON added in v0.8.0 

func (s *OptGateFix) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptInt 

type OptInt struct {
	Value int
	Set   bool
}

OptInt is optional int.

func NewOptInt 

func NewOptInt(v int) OptInt

NewOptInt returns new OptInt with value set to v.

func (*OptInt) Decode added in v0.8.0 

func (o *OptInt) Decode(d *jx.Decoder) error

Decode decodes int from json.

func (OptInt) Encode added in v0.8.0 

func (o OptInt) Encode(e *jx.Encoder)

Encode encodes int as json.

func (OptInt) Get 

func (o OptInt) Get() (v int, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptInt) IsSet 

func (o OptInt) IsSet() bool

IsSet returns true if OptInt was set.

func (OptInt) MarshalJSON added in v0.8.0 

func (s OptInt) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptInt) Or 

func (o OptInt) Or(d int) int

Or returns value if set, or given parameter if does not.

func (*OptInt) Reset 

func (o *OptInt) Reset()

Reset unsets value.

func (*OptInt) SetTo 

func (o *OptInt) SetTo(v int)

SetTo sets value to v.

func (*OptInt) UnmarshalJSON added in v0.8.0 

func (s *OptInt) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptListDeliveriesStatus 

type OptListDeliveriesStatus struct {
	Value ListDeliveriesStatus
	Set   bool
}

OptListDeliveriesStatus is optional ListDeliveriesStatus.

func NewOptListDeliveriesStatus 

func NewOptListDeliveriesStatus(v ListDeliveriesStatus) OptListDeliveriesStatus

NewOptListDeliveriesStatus returns new OptListDeliveriesStatus with value set to v.

func (OptListDeliveriesStatus) Get 

func (o OptListDeliveriesStatus) Get() (v ListDeliveriesStatus, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptListDeliveriesStatus) IsSet 

func (o OptListDeliveriesStatus) IsSet() bool

IsSet returns true if OptListDeliveriesStatus was set.

func (OptListDeliveriesStatus) Or 

func (o OptListDeliveriesStatus) Or(d ListDeliveriesStatus) ListDeliveriesStatus

Or returns value if set, or given parameter if does not.

func (*OptListDeliveriesStatus) Reset 

func (o *OptListDeliveriesStatus) Reset()

Reset unsets value.

func (*OptListDeliveriesStatus) SetTo 

func (o *OptListDeliveriesStatus) SetTo(v ListDeliveriesStatus)

SetTo sets value to v.

type OptNilBool 

type OptNilBool struct {
	Value bool
	Set   bool
	Null  bool
}

OptNilBool is optional nullable bool.

func NewOptNilBool 

func NewOptNilBool(v bool) OptNilBool

NewOptNilBool returns new OptNilBool with value set to v.

func (*OptNilBool) Decode 

func (o *OptNilBool) Decode(d *jx.Decoder) error

Decode decodes bool from json.

func (OptNilBool) Encode 

func (o OptNilBool) Encode(e *jx.Encoder)

Encode encodes bool as json.

func (OptNilBool) Get 

func (o OptNilBool) Get() (v bool, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilBool) IsNull 

func (o OptNilBool) IsNull() bool

IsNull returns true if value is Null.

func (OptNilBool) IsSet 

func (o OptNilBool) IsSet() bool

IsSet returns true if OptNilBool was set.

func (OptNilBool) MarshalJSON 

func (s OptNilBool) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilBool) Or 

func (o OptNilBool) Or(d bool) bool

Or returns value if set, or given parameter if does not.

func (*OptNilBool) Reset 

func (o *OptNilBool) Reset()

Reset unsets value.

func (*OptNilBool) SetTo 

func (o *OptNilBool) SetTo(v bool)

SetTo sets value to v.

func (*OptNilBool) SetToNull 

func (o *OptNilBool) SetToNull()

SetToNull sets value to null.

func (*OptNilBool) UnmarshalJSON 

func (s *OptNilBool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilDateTime 

type OptNilDateTime struct {
	Value time.Time
	Set   bool
	Null  bool
}

OptNilDateTime is optional nullable time.Time.

func NewOptNilDateTime 

func NewOptNilDateTime(v time.Time) OptNilDateTime

NewOptNilDateTime returns new OptNilDateTime with value set to v.

func (*OptNilDateTime) Decode 

func (o *OptNilDateTime) Decode(d *jx.Decoder, format func(*jx.Decoder) (time.Time, error)) error

Decode decodes time.Time from json.

func (OptNilDateTime) Encode 

func (o OptNilDateTime) Encode(e *jx.Encoder, format func(*jx.Encoder, time.Time))

Encode encodes time.Time as json.

func (OptNilDateTime) Get 

func (o OptNilDateTime) Get() (v time.Time, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilDateTime) IsNull 

func (o OptNilDateTime) IsNull() bool

IsNull returns true if value is Null.

func (OptNilDateTime) IsSet 

func (o OptNilDateTime) IsSet() bool

IsSet returns true if OptNilDateTime was set.

func (OptNilDateTime) MarshalJSON 

func (s OptNilDateTime) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilDateTime) Or 

func (o OptNilDateTime) Or(d time.Time) time.Time

Or returns value if set, or given parameter if does not.

func (*OptNilDateTime) Reset 

func (o *OptNilDateTime) Reset()

Reset unsets value.

func (*OptNilDateTime) SetTo 

func (o *OptNilDateTime) SetTo(v time.Time)

SetTo sets value to v.

func (*OptNilDateTime) SetToNull 

func (o *OptNilDateTime) SetToNull()

SetToNull sets value to null.

func (*OptNilDateTime) UnmarshalJSON 

func (s *OptNilDateTime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilDeliverySummaryEmail 

type OptNilDeliverySummaryEmail struct {
	Value DeliverySummaryEmail
	Set   bool
	Null  bool
}

OptNilDeliverySummaryEmail is optional nullable DeliverySummaryEmail.

func NewOptNilDeliverySummaryEmail 

func NewOptNilDeliverySummaryEmail(v DeliverySummaryEmail) OptNilDeliverySummaryEmail

NewOptNilDeliverySummaryEmail returns new OptNilDeliverySummaryEmail with value set to v.

func (*OptNilDeliverySummaryEmail) Decode 

func (o *OptNilDeliverySummaryEmail) Decode(d *jx.Decoder) error

Decode decodes DeliverySummaryEmail from json.

func (OptNilDeliverySummaryEmail) Encode 

func (o OptNilDeliverySummaryEmail) Encode(e *jx.Encoder)

Encode encodes DeliverySummaryEmail as json.

func (OptNilDeliverySummaryEmail) Get 

func (o OptNilDeliverySummaryEmail) Get() (v DeliverySummaryEmail, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilDeliverySummaryEmail) IsNull 

func (o OptNilDeliverySummaryEmail) IsNull() bool

IsNull returns true if value is Null.

func (OptNilDeliverySummaryEmail) IsSet 

func (o OptNilDeliverySummaryEmail) IsSet() bool

IsSet returns true if OptNilDeliverySummaryEmail was set.

func (OptNilDeliverySummaryEmail) MarshalJSON 

func (s OptNilDeliverySummaryEmail) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilDeliverySummaryEmail) Or 

func (o OptNilDeliverySummaryEmail) Or(d DeliverySummaryEmail) DeliverySummaryEmail

Or returns value if set, or given parameter if does not.

func (*OptNilDeliverySummaryEmail) Reset 

func (o *OptNilDeliverySummaryEmail) Reset()

Reset unsets value.

func (*OptNilDeliverySummaryEmail) SetTo 

func (o *OptNilDeliverySummaryEmail) SetTo(v DeliverySummaryEmail)

SetTo sets value to v.

func (*OptNilDeliverySummaryEmail) SetToNull 

func (o *OptNilDeliverySummaryEmail) SetToNull()

SetToNull sets value to null.

func (*OptNilDeliverySummaryEmail) UnmarshalJSON 

func (s *OptNilDeliverySummaryEmail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilEmailWebhookStatus added in v0.19.0 

type OptNilEmailWebhookStatus struct {
	Value EmailWebhookStatus
	Set   bool
	Null  bool
}

OptNilEmailWebhookStatus is optional nullable EmailWebhookStatus.

func NewOptNilEmailWebhookStatus added in v0.19.0 

func NewOptNilEmailWebhookStatus(v EmailWebhookStatus) OptNilEmailWebhookStatus

NewOptNilEmailWebhookStatus returns new OptNilEmailWebhookStatus with value set to v.

func (*OptNilEmailWebhookStatus) Decode added in v0.19.0 

func (o *OptNilEmailWebhookStatus) Decode(d *jx.Decoder) error

Decode decodes EmailWebhookStatus from json.

func (OptNilEmailWebhookStatus) Encode added in v0.19.0 

func (o OptNilEmailWebhookStatus) Encode(e *jx.Encoder)

Encode encodes EmailWebhookStatus as json.

func (OptNilEmailWebhookStatus) Get added in v0.19.0 

func (o OptNilEmailWebhookStatus) Get() (v EmailWebhookStatus, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilEmailWebhookStatus) IsNull added in v0.19.0 

func (o OptNilEmailWebhookStatus) IsNull() bool

IsNull returns true if value is Null.

func (OptNilEmailWebhookStatus) IsSet added in v0.19.0 

func (o OptNilEmailWebhookStatus) IsSet() bool

IsSet returns true if OptNilEmailWebhookStatus was set.

func (OptNilEmailWebhookStatus) MarshalJSON added in v0.19.0 

func (s OptNilEmailWebhookStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilEmailWebhookStatus) Or added in v0.19.0 

func (o OptNilEmailWebhookStatus) Or(d EmailWebhookStatus) EmailWebhookStatus

Or returns value if set, or given parameter if does not.

func (*OptNilEmailWebhookStatus) Reset added in v0.19.0 

func (o *OptNilEmailWebhookStatus) Reset()

Reset unsets value.

func (*OptNilEmailWebhookStatus) SetTo added in v0.19.0 

func (o *OptNilEmailWebhookStatus) SetTo(v EmailWebhookStatus)

SetTo sets value to v.

func (*OptNilEmailWebhookStatus) SetToNull added in v0.19.0 

func (o *OptNilEmailWebhookStatus) SetToNull()

SetToNull sets value to null.

func (*OptNilEmailWebhookStatus) UnmarshalJSON added in v0.19.0 

func (s *OptNilEmailWebhookStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilFloat64 

type OptNilFloat64 struct {
	Value float64
	Set   bool
	Null  bool
}

OptNilFloat64 is optional nullable float64.

func NewOptNilFloat64 

func NewOptNilFloat64(v float64) OptNilFloat64

NewOptNilFloat64 returns new OptNilFloat64 with value set to v.

func (*OptNilFloat64) Decode 

func (o *OptNilFloat64) Decode(d *jx.Decoder) error

Decode decodes float64 from json.

func (OptNilFloat64) Encode 

func (o OptNilFloat64) Encode(e *jx.Encoder)

Encode encodes float64 as json.

func (OptNilFloat64) Get 

func (o OptNilFloat64) Get() (v float64, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilFloat64) IsNull 

func (o OptNilFloat64) IsNull() bool

IsNull returns true if value is Null.

func (OptNilFloat64) IsSet 

func (o OptNilFloat64) IsSet() bool

IsSet returns true if OptNilFloat64 was set.

func (OptNilFloat64) MarshalJSON 

func (s OptNilFloat64) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilFloat64) Or 

func (o OptNilFloat64) Or(d float64) float64

Or returns value if set, or given parameter if does not.

func (*OptNilFloat64) Reset 

func (o *OptNilFloat64) Reset()

Reset unsets value.

func (*OptNilFloat64) SetTo 

func (o *OptNilFloat64) SetTo(v float64)

SetTo sets value to v.

func (*OptNilFloat64) SetToNull 

func (o *OptNilFloat64) SetToNull()

SetToNull sets value to null.

func (*OptNilFloat64) UnmarshalJSON 

func (s *OptNilFloat64) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilFunctionLogRowMetadata added in v0.26.0 

type OptNilFunctionLogRowMetadata struct {
	Value FunctionLogRowMetadata
	Set   bool
	Null  bool
}

OptNilFunctionLogRowMetadata is optional nullable FunctionLogRowMetadata.

func NewOptNilFunctionLogRowMetadata added in v0.26.0 

func NewOptNilFunctionLogRowMetadata(v FunctionLogRowMetadata) OptNilFunctionLogRowMetadata

NewOptNilFunctionLogRowMetadata returns new OptNilFunctionLogRowMetadata with value set to v.

func (*OptNilFunctionLogRowMetadata) Decode added in v0.26.0 

func (o *OptNilFunctionLogRowMetadata) Decode(d *jx.Decoder) error

Decode decodes FunctionLogRowMetadata from json.

func (OptNilFunctionLogRowMetadata) Encode added in v0.26.0 

func (o OptNilFunctionLogRowMetadata) Encode(e *jx.Encoder)

Encode encodes FunctionLogRowMetadata as json.

func (OptNilFunctionLogRowMetadata) Get added in v0.26.0 

func (o OptNilFunctionLogRowMetadata) Get() (v FunctionLogRowMetadata, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilFunctionLogRowMetadata) IsNull added in v0.26.0 

func (o OptNilFunctionLogRowMetadata) IsNull() bool

IsNull returns true if value is Null.

func (OptNilFunctionLogRowMetadata) IsSet added in v0.26.0 

func (o OptNilFunctionLogRowMetadata) IsSet() bool

IsSet returns true if OptNilFunctionLogRowMetadata was set.

func (OptNilFunctionLogRowMetadata) MarshalJSON added in v0.26.0 

func (s OptNilFunctionLogRowMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilFunctionLogRowMetadata) Or added in v0.26.0 

func (o OptNilFunctionLogRowMetadata) Or(d FunctionLogRowMetadata) FunctionLogRowMetadata

Or returns value if set, or given parameter if does not.

func (*OptNilFunctionLogRowMetadata) Reset added in v0.26.0 

func (o *OptNilFunctionLogRowMetadata) Reset()

Reset unsets value.

func (*OptNilFunctionLogRowMetadata) SetTo added in v0.26.0 

func (o *OptNilFunctionLogRowMetadata) SetTo(v FunctionLogRowMetadata)

SetTo sets value to v.

func (*OptNilFunctionLogRowMetadata) SetToNull added in v0.26.0 

func (o *OptNilFunctionLogRowMetadata) SetToNull()

SetToNull sets value to null.

func (*OptNilFunctionLogRowMetadata) UnmarshalJSON added in v0.26.0 

func (s *OptNilFunctionLogRowMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilGateDenialArray added in v0.19.0 

type OptNilGateDenialArray struct {
	Value []GateDenial
	Set   bool
	Null  bool
}

OptNilGateDenialArray is optional nullable []GateDenial.

func NewOptNilGateDenialArray added in v0.19.0 

func NewOptNilGateDenialArray(v []GateDenial) OptNilGateDenialArray

NewOptNilGateDenialArray returns new OptNilGateDenialArray with value set to v.

func (*OptNilGateDenialArray) Decode added in v0.19.0 

func (o *OptNilGateDenialArray) Decode(d *jx.Decoder) error

Decode decodes []GateDenial from json.

func (OptNilGateDenialArray) Encode added in v0.19.0 

func (o OptNilGateDenialArray) Encode(e *jx.Encoder)

Encode encodes []GateDenial as json.

func (OptNilGateDenialArray) Get added in v0.19.0 

func (o OptNilGateDenialArray) Get() (v []GateDenial, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilGateDenialArray) IsNull added in v0.19.0 

func (o OptNilGateDenialArray) IsNull() bool

IsNull returns true if value is Null.

func (OptNilGateDenialArray) IsSet added in v0.19.0 

func (o OptNilGateDenialArray) IsSet() bool

IsSet returns true if OptNilGateDenialArray was set.

func (OptNilGateDenialArray) MarshalJSON added in v0.19.0 

func (s OptNilGateDenialArray) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilGateDenialArray) Or added in v0.19.0 

func (o OptNilGateDenialArray) Or(d []GateDenial) []GateDenial

Or returns value if set, or given parameter if does not.

func (*OptNilGateDenialArray) Reset added in v0.19.0 

func (o *OptNilGateDenialArray) Reset()

Reset unsets value.

func (*OptNilGateDenialArray) SetTo added in v0.19.0 

func (o *OptNilGateDenialArray) SetTo(v []GateDenial)

SetTo sets value to v.

func (*OptNilGateDenialArray) SetToNull added in v0.19.0 

func (o *OptNilGateDenialArray) SetToNull()

SetToNull sets value to null.

func (*OptNilGateDenialArray) UnmarshalJSON added in v0.19.0 

func (s *OptNilGateDenialArray) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilInt 

type OptNilInt struct {
	Value int
	Set   bool
	Null  bool
}

OptNilInt is optional nullable int.

func NewOptNilInt 

func NewOptNilInt(v int) OptNilInt

NewOptNilInt returns new OptNilInt with value set to v.

func (*OptNilInt) Decode 

func (o *OptNilInt) Decode(d *jx.Decoder) error

Decode decodes int from json.

func (OptNilInt) Encode 

func (o OptNilInt) Encode(e *jx.Encoder)

Encode encodes int as json.

func (OptNilInt) Get 

func (o OptNilInt) Get() (v int, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilInt) IsNull 

func (o OptNilInt) IsNull() bool

IsNull returns true if value is Null.

func (OptNilInt) IsSet 

func (o OptNilInt) IsSet() bool

IsSet returns true if OptNilInt was set.

func (OptNilInt) MarshalJSON 

func (s OptNilInt) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilInt) Or 

func (o OptNilInt) Or(d int) int

Or returns value if set, or given parameter if does not.

func (*OptNilInt) Reset 

func (o *OptNilInt) Reset()

Reset unsets value.

func (*OptNilInt) SetTo 

func (o *OptNilInt) SetTo(v int)

SetTo sets value to v.

func (*OptNilInt) SetToNull 

func (o *OptNilInt) SetToNull()

SetToNull sets value to null.

func (*OptNilInt) UnmarshalJSON 

func (s *OptNilInt) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilString 

type OptNilString struct {
	Value string
	Set   bool
	Null  bool
}

OptNilString is optional nullable string.

func NewOptNilString 

func NewOptNilString(v string) OptNilString

NewOptNilString returns new OptNilString with value set to v.

func (*OptNilString) Decode 

func (o *OptNilString) Decode(d *jx.Decoder) error

Decode decodes string from json.

func (OptNilString) Encode 

func (o OptNilString) Encode(e *jx.Encoder)

Encode encodes string as json.

func (OptNilString) Get 

func (o OptNilString) Get() (v string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilString) IsNull 

func (o OptNilString) IsNull() bool

IsNull returns true if value is Null.

func (OptNilString) IsSet 

func (o OptNilString) IsSet() bool

IsSet returns true if OptNilString was set.

func (OptNilString) MarshalJSON 

func (s OptNilString) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilString) Or 

func (o OptNilString) Or(d string) string

Or returns value if set, or given parameter if does not.

func (*OptNilString) Reset 

func (o *OptNilString) Reset()

Reset unsets value.

func (*OptNilString) SetTo 

func (o *OptNilString) SetTo(v string)

SetTo sets value to v.

func (*OptNilString) SetToNull 

func (o *OptNilString) SetToNull()

SetToNull sets value to null.

func (*OptNilString) UnmarshalJSON 

func (s *OptNilString) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilStringArray 

type OptNilStringArray struct {
	Value []string
	Set   bool
	Null  bool
}

OptNilStringArray is optional nullable []string.

func NewOptNilStringArray 

func NewOptNilStringArray(v []string) OptNilStringArray

NewOptNilStringArray returns new OptNilStringArray with value set to v.

func (*OptNilStringArray) Decode 

func (o *OptNilStringArray) Decode(d *jx.Decoder) error

Decode decodes []string from json.

func (OptNilStringArray) Encode 

func (o OptNilStringArray) Encode(e *jx.Encoder)

Encode encodes []string as json.

func (OptNilStringArray) Get 

func (o OptNilStringArray) Get() (v []string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilStringArray) IsNull 

func (o OptNilStringArray) IsNull() bool

IsNull returns true if value is Null.

func (OptNilStringArray) IsSet 

func (o OptNilStringArray) IsSet() bool

IsSet returns true if OptNilStringArray was set.

func (OptNilStringArray) MarshalJSON 

func (s OptNilStringArray) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilStringArray) Or 

func (o OptNilStringArray) Or(d []string) []string

Or returns value if set, or given parameter if does not.

func (*OptNilStringArray) Reset 

func (o *OptNilStringArray) Reset()

Reset unsets value.

func (*OptNilStringArray) SetTo 

func (o *OptNilStringArray) SetTo(v []string)

SetTo sets value to v.

func (*OptNilStringArray) SetToNull 

func (o *OptNilStringArray) SetToNull()

SetToNull sets value to null.

func (*OptNilStringArray) UnmarshalJSON 

func (s *OptNilStringArray) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilUUID 

type OptNilUUID struct {
	Value uuid.UUID
	Set   bool
	Null  bool
}

OptNilUUID is optional nullable uuid.UUID.

func NewOptNilUUID 

func NewOptNilUUID(v uuid.UUID) OptNilUUID

NewOptNilUUID returns new OptNilUUID with value set to v.

func (*OptNilUUID) Decode 

func (o *OptNilUUID) Decode(d *jx.Decoder) error

Decode decodes uuid.UUID from json.

func (OptNilUUID) Encode 

func (o OptNilUUID) Encode(e *jx.Encoder)

Encode encodes uuid.UUID as json.

func (OptNilUUID) Get 

func (o OptNilUUID) Get() (v uuid.UUID, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilUUID) IsNull 

func (o OptNilUUID) IsNull() bool

IsNull returns true if value is Null.

func (OptNilUUID) IsSet 

func (o OptNilUUID) IsSet() bool

IsSet returns true if OptNilUUID was set.

func (OptNilUUID) MarshalJSON 

func (s OptNilUUID) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilUUID) Or 

func (o OptNilUUID) Or(d uuid.UUID) uuid.UUID

Or returns value if set, or given parameter if does not.

func (*OptNilUUID) Reset 

func (o *OptNilUUID) Reset()

Reset unsets value.

func (*OptNilUUID) SetTo 

func (o *OptNilUUID) SetTo(v uuid.UUID)

SetTo sets value to v.

func (*OptNilUUID) SetToNull 

func (o *OptNilUUID) SetToNull()

SetToNull sets value to null.

func (*OptNilUUID) UnmarshalJSON 

func (s *OptNilUUID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSearchEmailsHasAttachment added in v0.21.0 

type OptSearchEmailsHasAttachment struct {
	Value SearchEmailsHasAttachment
	Set   bool
}

OptSearchEmailsHasAttachment is optional SearchEmailsHasAttachment.

func NewOptSearchEmailsHasAttachment added in v0.21.0 

func NewOptSearchEmailsHasAttachment(v SearchEmailsHasAttachment) OptSearchEmailsHasAttachment

NewOptSearchEmailsHasAttachment returns new OptSearchEmailsHasAttachment with value set to v.

func (OptSearchEmailsHasAttachment) Get added in v0.21.0 

func (o OptSearchEmailsHasAttachment) Get() (v SearchEmailsHasAttachment, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSearchEmailsHasAttachment) IsSet added in v0.21.0 

func (o OptSearchEmailsHasAttachment) IsSet() bool

IsSet returns true if OptSearchEmailsHasAttachment was set.

func (OptSearchEmailsHasAttachment) Or added in v0.21.0 

func (o OptSearchEmailsHasAttachment) Or(d SearchEmailsHasAttachment) SearchEmailsHasAttachment

Or returns value if set, or given parameter if does not.

func (*OptSearchEmailsHasAttachment) Reset added in v0.21.0 

func (o *OptSearchEmailsHasAttachment) Reset()

Reset unsets value.

func (*OptSearchEmailsHasAttachment) SetTo added in v0.21.0 

func (o *OptSearchEmailsHasAttachment) SetTo(v SearchEmailsHasAttachment)

SetTo sets value to v.

type OptSearchEmailsIncludeFacets added in v0.21.0 

type OptSearchEmailsIncludeFacets struct {
	Value SearchEmailsIncludeFacets
	Set   bool
}

OptSearchEmailsIncludeFacets is optional SearchEmailsIncludeFacets.

func NewOptSearchEmailsIncludeFacets added in v0.21.0 

func NewOptSearchEmailsIncludeFacets(v SearchEmailsIncludeFacets) OptSearchEmailsIncludeFacets

NewOptSearchEmailsIncludeFacets returns new OptSearchEmailsIncludeFacets with value set to v.

func (OptSearchEmailsIncludeFacets) Get added in v0.21.0 

func (o OptSearchEmailsIncludeFacets) Get() (v SearchEmailsIncludeFacets, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSearchEmailsIncludeFacets) IsSet added in v0.21.0 

func (o OptSearchEmailsIncludeFacets) IsSet() bool

IsSet returns true if OptSearchEmailsIncludeFacets was set.

func (OptSearchEmailsIncludeFacets) Or added in v0.21.0 

func (o OptSearchEmailsIncludeFacets) Or(d SearchEmailsIncludeFacets) SearchEmailsIncludeFacets

Or returns value if set, or given parameter if does not.

func (*OptSearchEmailsIncludeFacets) Reset added in v0.21.0 

func (o *OptSearchEmailsIncludeFacets) Reset()

Reset unsets value.

func (*OptSearchEmailsIncludeFacets) SetTo added in v0.21.0 

func (o *OptSearchEmailsIncludeFacets) SetTo(v SearchEmailsIncludeFacets)

SetTo sets value to v.

type OptSearchEmailsSnippet added in v0.21.0 

type OptSearchEmailsSnippet struct {
	Value SearchEmailsSnippet
	Set   bool
}

OptSearchEmailsSnippet is optional SearchEmailsSnippet.

func NewOptSearchEmailsSnippet added in v0.21.0 

func NewOptSearchEmailsSnippet(v SearchEmailsSnippet) OptSearchEmailsSnippet

NewOptSearchEmailsSnippet returns new OptSearchEmailsSnippet with value set to v.

func (OptSearchEmailsSnippet) Get added in v0.21.0 

func (o OptSearchEmailsSnippet) Get() (v SearchEmailsSnippet, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSearchEmailsSnippet) IsSet added in v0.21.0 

func (o OptSearchEmailsSnippet) IsSet() bool

IsSet returns true if OptSearchEmailsSnippet was set.

func (OptSearchEmailsSnippet) Or added in v0.21.0 

func (o OptSearchEmailsSnippet) Or(d SearchEmailsSnippet) SearchEmailsSnippet

Or returns value if set, or given parameter if does not.

func (*OptSearchEmailsSnippet) Reset added in v0.21.0 

func (o *OptSearchEmailsSnippet) Reset()

Reset unsets value.

func (*OptSearchEmailsSnippet) SetTo added in v0.21.0 

func (o *OptSearchEmailsSnippet) SetTo(v SearchEmailsSnippet)

SetTo sets value to v.

type OptSearchEmailsSort added in v0.21.0 

type OptSearchEmailsSort struct {
	Value SearchEmailsSort
	Set   bool
}

OptSearchEmailsSort is optional SearchEmailsSort.

func NewOptSearchEmailsSort added in v0.21.0 

func NewOptSearchEmailsSort(v SearchEmailsSort) OptSearchEmailsSort

NewOptSearchEmailsSort returns new OptSearchEmailsSort with value set to v.

func (OptSearchEmailsSort) Get added in v0.21.0 

func (o OptSearchEmailsSort) Get() (v SearchEmailsSort, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSearchEmailsSort) IsSet added in v0.21.0 

func (o OptSearchEmailsSort) IsSet() bool

IsSet returns true if OptSearchEmailsSort was set.

func (OptSearchEmailsSort) Or added in v0.21.0 

func (o OptSearchEmailsSort) Or(d SearchEmailsSort) SearchEmailsSort

Or returns value if set, or given parameter if does not.

func (*OptSearchEmailsSort) Reset added in v0.21.0 

func (o *OptSearchEmailsSort) Reset()

Reset unsets value.

func (*OptSearchEmailsSort) SetTo added in v0.21.0 

func (o *OptSearchEmailsSort) SetTo(v SearchEmailsSort)

SetTo sets value to v.

type OptSentEmailStatus added in v0.19.0 

type OptSentEmailStatus struct {
	Value SentEmailStatus
	Set   bool
}

OptSentEmailStatus is optional SentEmailStatus.

func NewOptSentEmailStatus added in v0.19.0 

func NewOptSentEmailStatus(v SentEmailStatus) OptSentEmailStatus

NewOptSentEmailStatus returns new OptSentEmailStatus with value set to v.

func (*OptSentEmailStatus) Decode added in v0.19.0 

func (o *OptSentEmailStatus) Decode(d *jx.Decoder) error

Decode decodes SentEmailStatus from json.

func (OptSentEmailStatus) Encode added in v0.19.0 

func (o OptSentEmailStatus) Encode(e *jx.Encoder)

Encode encodes SentEmailStatus as json.

func (OptSentEmailStatus) Get added in v0.19.0 

func (o OptSentEmailStatus) Get() (v SentEmailStatus, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSentEmailStatus) IsSet added in v0.19.0 

func (o OptSentEmailStatus) IsSet() bool

IsSet returns true if OptSentEmailStatus was set.

func (OptSentEmailStatus) MarshalJSON added in v0.19.0 

func (s OptSentEmailStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSentEmailStatus) Or added in v0.19.0 

func (o OptSentEmailStatus) Or(d SentEmailStatus) SentEmailStatus

Or returns value if set, or given parameter if does not.

func (*OptSentEmailStatus) Reset added in v0.19.0 

func (o *OptSentEmailStatus) Reset()

Reset unsets value.

func (*OptSentEmailStatus) SetTo added in v0.19.0 

func (o *OptSentEmailStatus) SetTo(v SentEmailStatus)

SetTo sets value to v.

func (*OptSentEmailStatus) UnmarshalJSON added in v0.19.0 

func (s *OptSentEmailStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptStartAgentSignupInputMetadata added in v0.29.2 

type OptStartAgentSignupInputMetadata struct {
	Value StartAgentSignupInputMetadata
	Set   bool
}

OptStartAgentSignupInputMetadata is optional StartAgentSignupInputMetadata.

func NewOptStartAgentSignupInputMetadata added in v0.29.2 

func NewOptStartAgentSignupInputMetadata(v StartAgentSignupInputMetadata) OptStartAgentSignupInputMetadata

NewOptStartAgentSignupInputMetadata returns new OptStartAgentSignupInputMetadata with value set to v.

func (*OptStartAgentSignupInputMetadata) Decode added in v0.29.2 

func (o *OptStartAgentSignupInputMetadata) Decode(d *jx.Decoder) error

Decode decodes StartAgentSignupInputMetadata from json.

func (OptStartAgentSignupInputMetadata) Encode added in v0.29.2 

func (o OptStartAgentSignupInputMetadata) Encode(e *jx.Encoder)

Encode encodes StartAgentSignupInputMetadata as json.

func (OptStartAgentSignupInputMetadata) Get added in v0.29.2 

func (o OptStartAgentSignupInputMetadata) Get() (v StartAgentSignupInputMetadata, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptStartAgentSignupInputMetadata) IsSet added in v0.29.2 

func (o OptStartAgentSignupInputMetadata) IsSet() bool

IsSet returns true if OptStartAgentSignupInputMetadata was set.

func (OptStartAgentSignupInputMetadata) MarshalJSON added in v0.29.2 

func (s OptStartAgentSignupInputMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptStartAgentSignupInputMetadata) Or added in v0.29.2 

func (o OptStartAgentSignupInputMetadata) Or(d StartAgentSignupInputMetadata) StartAgentSignupInputMetadata

Or returns value if set, or given parameter if does not.

func (*OptStartAgentSignupInputMetadata) Reset added in v0.29.2 

func (o *OptStartAgentSignupInputMetadata) Reset()

Reset unsets value.

func (*OptStartAgentSignupInputMetadata) SetTo added in v0.29.2 

func (o *OptStartAgentSignupInputMetadata) SetTo(v StartAgentSignupInputMetadata)

SetTo sets value to v.

func (*OptStartAgentSignupInputMetadata) UnmarshalJSON added in v0.29.2 

func (s *OptStartAgentSignupInputMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptStartCliLoginInput added in v0.19.0 

type OptStartCliLoginInput struct {
	Value StartCliLoginInput
	Set   bool
}

OptStartCliLoginInput is optional StartCliLoginInput.

func NewOptStartCliLoginInput added in v0.19.0 

func NewOptStartCliLoginInput(v StartCliLoginInput) OptStartCliLoginInput

NewOptStartCliLoginInput returns new OptStartCliLoginInput with value set to v.

func (*OptStartCliLoginInput) Decode added in v0.19.0 

func (o *OptStartCliLoginInput) Decode(d *jx.Decoder) error

Decode decodes StartCliLoginInput from json.

func (OptStartCliLoginInput) Encode added in v0.19.0 

func (o OptStartCliLoginInput) Encode(e *jx.Encoder)

Encode encodes StartCliLoginInput as json.

func (OptStartCliLoginInput) Get added in v0.19.0 

func (o OptStartCliLoginInput) Get() (v StartCliLoginInput, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptStartCliLoginInput) IsSet added in v0.19.0 

func (o OptStartCliLoginInput) IsSet() bool

IsSet returns true if OptStartCliLoginInput was set.

func (OptStartCliLoginInput) MarshalJSON added in v0.19.0 

func (s OptStartCliLoginInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptStartCliLoginInput) Or added in v0.19.0 

func (o OptStartCliLoginInput) Or(d StartCliLoginInput) StartCliLoginInput

Or returns value if set, or given parameter if does not.

func (*OptStartCliLoginInput) Reset added in v0.19.0 

func (o *OptStartCliLoginInput) Reset()

Reset unsets value.

func (*OptStartCliLoginInput) SetTo added in v0.19.0 

func (o *OptStartCliLoginInput) SetTo(v StartCliLoginInput)

SetTo sets value to v.

func (*OptStartCliLoginInput) UnmarshalJSON added in v0.19.0 

func (s *OptStartCliLoginInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptStartCliLoginInputMetadata added in v0.19.0 

type OptStartCliLoginInputMetadata struct {
	Value StartCliLoginInputMetadata
	Set   bool
}

OptStartCliLoginInputMetadata is optional StartCliLoginInputMetadata.

func NewOptStartCliLoginInputMetadata added in v0.19.0 

func NewOptStartCliLoginInputMetadata(v StartCliLoginInputMetadata) OptStartCliLoginInputMetadata

NewOptStartCliLoginInputMetadata returns new OptStartCliLoginInputMetadata with value set to v.

func (*OptStartCliLoginInputMetadata) Decode added in v0.19.0 

func (o *OptStartCliLoginInputMetadata) Decode(d *jx.Decoder) error

Decode decodes StartCliLoginInputMetadata from json.

func (OptStartCliLoginInputMetadata) Encode added in v0.19.0 

func (o OptStartCliLoginInputMetadata) Encode(e *jx.Encoder)

Encode encodes StartCliLoginInputMetadata as json.

func (OptStartCliLoginInputMetadata) Get added in v0.19.0 

func (o OptStartCliLoginInputMetadata) Get() (v StartCliLoginInputMetadata, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptStartCliLoginInputMetadata) IsSet added in v0.19.0 

func (o OptStartCliLoginInputMetadata) IsSet() bool

IsSet returns true if OptStartCliLoginInputMetadata was set.

func (OptStartCliLoginInputMetadata) MarshalJSON added in v0.19.0 

func (s OptStartCliLoginInputMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptStartCliLoginInputMetadata) Or added in v0.19.0 

func (o OptStartCliLoginInputMetadata) Or(d StartCliLoginInputMetadata) StartCliLoginInputMetadata

Or returns value if set, or given parameter if does not.

func (*OptStartCliLoginInputMetadata) Reset added in v0.19.0 

func (o *OptStartCliLoginInputMetadata) Reset()

Reset unsets value.

func (*OptStartCliLoginInputMetadata) SetTo added in v0.19.0 

func (o *OptStartCliLoginInputMetadata) SetTo(v StartCliLoginInputMetadata)

SetTo sets value to v.

func (*OptStartCliLoginInputMetadata) UnmarshalJSON added in v0.19.0 

func (s *OptStartCliLoginInputMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptStartCliSignupInputMetadata added in v0.28.0 

type OptStartCliSignupInputMetadata struct {
	Value StartCliSignupInputMetadata
	Set   bool
}

OptStartCliSignupInputMetadata is optional StartCliSignupInputMetadata.

func NewOptStartCliSignupInputMetadata added in v0.28.0 

func NewOptStartCliSignupInputMetadata(v StartCliSignupInputMetadata) OptStartCliSignupInputMetadata

NewOptStartCliSignupInputMetadata returns new OptStartCliSignupInputMetadata with value set to v.

func (*OptStartCliSignupInputMetadata) Decode added in v0.28.0 

func (o *OptStartCliSignupInputMetadata) Decode(d *jx.Decoder) error

Decode decodes StartCliSignupInputMetadata from json.

func (OptStartCliSignupInputMetadata) Encode added in v0.28.0 

func (o OptStartCliSignupInputMetadata) Encode(e *jx.Encoder)

Encode encodes StartCliSignupInputMetadata as json.

func (OptStartCliSignupInputMetadata) Get added in v0.28.0 

func (o OptStartCliSignupInputMetadata) Get() (v StartCliSignupInputMetadata, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptStartCliSignupInputMetadata) IsSet added in v0.28.0 

func (o OptStartCliSignupInputMetadata) IsSet() bool

IsSet returns true if OptStartCliSignupInputMetadata was set.

func (OptStartCliSignupInputMetadata) MarshalJSON added in v0.28.0 

func (s OptStartCliSignupInputMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptStartCliSignupInputMetadata) Or added in v0.28.0 

func (o OptStartCliSignupInputMetadata) Or(d StartCliSignupInputMetadata) StartCliSignupInputMetadata

Or returns value if set, or given parameter if does not.

func (*OptStartCliSignupInputMetadata) Reset added in v0.28.0 

func (o *OptStartCliSignupInputMetadata) Reset()

Reset unsets value.

func (*OptStartCliSignupInputMetadata) SetTo added in v0.28.0 

func (o *OptStartCliSignupInputMetadata) SetTo(v StartCliSignupInputMetadata)

SetTo sets value to v.

func (*OptStartCliSignupInputMetadata) UnmarshalJSON added in v0.28.0 

func (s *OptStartCliSignupInputMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptString 

type OptString struct {
	Value string
	Set   bool
}

OptString is optional string.

func NewOptString 

func NewOptString(v string) OptString

NewOptString returns new OptString with value set to v.

func (*OptString) Decode 

func (o *OptString) Decode(d *jx.Decoder) error

Decode decodes string from json.

func (OptString) Encode 

func (o OptString) Encode(e *jx.Encoder)

Encode encodes string as json.

func (OptString) Get 

func (o OptString) Get() (v string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptString) IsSet 

func (o OptString) IsSet() bool

IsSet returns true if OptString was set.

func (OptString) MarshalJSON 

func (s OptString) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptString) Or 

func (o OptString) Or(d string) string

Or returns value if set, or given parameter if does not.

func (*OptString) Reset 

func (o *OptString) Reset()

Reset unsets value.

func (*OptString) SetTo 

func (o *OptString) SetTo(v string)

SetTo sets value to v.

func (*OptString) UnmarshalJSON 

func (s *OptString) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptTestFunctionReq added in v0.25.0 

type OptTestFunctionReq struct {
	Value TestFunctionReq
	Set   bool
}

OptTestFunctionReq is optional TestFunctionReq.

func NewOptTestFunctionReq added in v0.25.0 

func NewOptTestFunctionReq(v TestFunctionReq) OptTestFunctionReq

NewOptTestFunctionReq returns new OptTestFunctionReq with value set to v.

func (*OptTestFunctionReq) Decode added in v0.25.0 

func (o *OptTestFunctionReq) Decode(d *jx.Decoder) error

Decode decodes TestFunctionReq from json.

func (OptTestFunctionReq) Encode added in v0.25.0 

func (o OptTestFunctionReq) Encode(e *jx.Encoder)

Encode encodes TestFunctionReq as json.

func (OptTestFunctionReq) Get added in v0.25.0 

func (o OptTestFunctionReq) Get() (v TestFunctionReq, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptTestFunctionReq) IsSet added in v0.25.0 

func (o OptTestFunctionReq) IsSet() bool

IsSet returns true if OptTestFunctionReq was set.

func (OptTestFunctionReq) MarshalJSON added in v0.25.0 

func (s OptTestFunctionReq) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptTestFunctionReq) Or added in v0.25.0 

func (o OptTestFunctionReq) Or(d TestFunctionReq) TestFunctionReq

Or returns value if set, or given parameter if does not.

func (*OptTestFunctionReq) Reset added in v0.25.0 

func (o *OptTestFunctionReq) Reset()

Reset unsets value.

func (*OptTestFunctionReq) SetTo added in v0.25.0 

func (o *OptTestFunctionReq) SetTo(v TestFunctionReq)

SetTo sets value to v.

func (*OptTestFunctionReq) UnmarshalJSON added in v0.25.0 

func (s *OptTestFunctionReq) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptUUID 

type OptUUID struct {
	Value uuid.UUID
	Set   bool
}

OptUUID is optional uuid.UUID.

func NewOptUUID 

func NewOptUUID(v uuid.UUID) OptUUID

NewOptUUID returns new OptUUID with value set to v.

func (*OptUUID) Decode added in v0.19.0 

func (o *OptUUID) Decode(d *jx.Decoder) error

Decode decodes uuid.UUID from json.

func (OptUUID) Encode added in v0.19.0 

func (o OptUUID) Encode(e *jx.Encoder)

Encode encodes uuid.UUID as json.

func (OptUUID) Get 

func (o OptUUID) Get() (v uuid.UUID, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptUUID) IsSet 

func (o OptUUID) IsSet() bool

IsSet returns true if OptUUID was set.

func (OptUUID) MarshalJSON added in v0.19.0 

func (s OptUUID) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptUUID) Or 

func (o OptUUID) Or(d uuid.UUID) uuid.UUID

Or returns value if set, or given parameter if does not.

func (*OptUUID) Reset 

func (o *OptUUID) Reset()

Reset unsets value.

func (*OptUUID) SetTo 

func (o *OptUUID) SetTo(v uuid.UUID)

SetTo sets value to v.

func (*OptUUID) UnmarshalJSON added in v0.19.0 

func (s *OptUUID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type Option 

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

func WithAttributes 

func WithAttributes(attributes ...attribute.KeyValue) Option

WithAttributes specifies default otel attributes.

func WithMeterProvider 

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a meter provider to use for creating a meter.

If none is specified, the otel.GetMeterProvider() is used.

func WithTracerProvider 

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer.

If none is specified, the global provider is used.

type PaginationMeta 

type PaginationMeta struct {
	// Total number of matching records.
	Total int `json:"total"`
	// Page size used for this request.
	Limit int `json:"limit"`
	// Cursor for the next page, or null if no more results.
	Cursor NilString `json:"cursor"`
}

Ref: #/components/schemas/PaginationMeta

func (*PaginationMeta) Decode 

func (s *PaginationMeta) Decode(d *jx.Decoder) error

Decode decodes PaginationMeta from json.

func (*PaginationMeta) Encode 

func (s *PaginationMeta) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*PaginationMeta) GetCursor 

func (s *PaginationMeta) GetCursor() NilString

GetCursor returns the value of Cursor.

func (*PaginationMeta) GetLimit 

func (s *PaginationMeta) GetLimit() int

GetLimit returns the value of Limit.

func (*PaginationMeta) GetTotal 

func (s *PaginationMeta) GetTotal() int

GetTotal returns the value of Total.

func (*PaginationMeta) MarshalJSON 

func (s *PaginationMeta) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*PaginationMeta) SetCursor 

func (s *PaginationMeta) SetCursor(val NilString)

SetCursor sets the value of Cursor.

func (*PaginationMeta) SetLimit 

func (s *PaginationMeta) SetLimit(val int)

SetLimit sets the value of Limit.

func (*PaginationMeta) SetTotal 

func (s *PaginationMeta) SetTotal(val int)

SetTotal sets the value of Total.

func (*PaginationMeta) UnmarshalJSON 

func (s *PaginationMeta) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type PollCliLoginInput added in v0.19.0 

type PollCliLoginInput struct {
	DeviceCode string `json:"device_code"`
}

Ref: #/components/schemas/PollCliLoginInput

func (*PollCliLoginInput) Decode added in v0.19.0 

func (s *PollCliLoginInput) Decode(d *jx.Decoder) error

Decode decodes PollCliLoginInput from json.

func (*PollCliLoginInput) Encode added in v0.19.0 

func (s *PollCliLoginInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*PollCliLoginInput) GetDeviceCode added in v0.19.0 

func (s *PollCliLoginInput) GetDeviceCode() string

GetDeviceCode returns the value of DeviceCode.

func (*PollCliLoginInput) MarshalJSON added in v0.19.0 

func (s *PollCliLoginInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*PollCliLoginInput) SetDeviceCode added in v0.19.0 

func (s *PollCliLoginInput) SetDeviceCode(val string)

SetDeviceCode sets the value of DeviceCode.

func (*PollCliLoginInput) UnmarshalJSON added in v0.19.0 

func (s *PollCliLoginInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*PollCliLoginInput) Validate added in v0.19.0 

func (s *PollCliLoginInput) Validate() error

type PollCliLoginOK added in v0.19.0 

type PollCliLoginOK struct {
	Success bool               `json:"success"`
	Data    CliLoginPollResult `json:"data"`
}

Merged schema.

func (*PollCliLoginOK) Decode added in v0.19.0 

func (s *PollCliLoginOK) Decode(d *jx.Decoder) error

Decode decodes PollCliLoginOK from json.

func (*PollCliLoginOK) Encode added in v0.19.0 

func (s *PollCliLoginOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*PollCliLoginOK) GetData added in v0.19.0 

func (s *PollCliLoginOK) GetData() CliLoginPollResult

GetData returns the value of Data.

func (*PollCliLoginOK) GetSuccess added in v0.19.0 

func (s *PollCliLoginOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*PollCliLoginOK) MarshalJSON added in v0.19.0 

func (s *PollCliLoginOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*PollCliLoginOK) SetData added in v0.19.0 

func (s *PollCliLoginOK) SetData(val CliLoginPollResult)

SetData sets the value of Data.

func (*PollCliLoginOK) SetSuccess added in v0.19.0 

func (s *PollCliLoginOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*PollCliLoginOK) UnmarshalJSON added in v0.19.0 

func (s *PollCliLoginOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*PollCliLoginOK) Validate added in v0.29.2 

func (s *PollCliLoginOK) Validate() error

type PollCliLoginOKHeaders added in v0.19.0 

type PollCliLoginOKHeaders struct {
	CacheControl OptString
	Response     PollCliLoginOK
}

PollCliLoginOKHeaders wraps PollCliLoginOK with response headers.

func (*PollCliLoginOKHeaders) GetCacheControl added in v0.19.0 

func (s *PollCliLoginOKHeaders) GetCacheControl() OptString

GetCacheControl returns the value of CacheControl.

func (*PollCliLoginOKHeaders) GetResponse added in v0.19.0 

func (s *PollCliLoginOKHeaders) GetResponse() PollCliLoginOK

GetResponse returns the value of Response.

func (*PollCliLoginOKHeaders) SetCacheControl added in v0.19.0 

func (s *PollCliLoginOKHeaders) SetCacheControl(val OptString)

SetCacheControl sets the value of CacheControl.

func (*PollCliLoginOKHeaders) SetResponse added in v0.19.0 

func (s *PollCliLoginOKHeaders) SetResponse(val PollCliLoginOK)

SetResponse sets the value of Response.

func (*PollCliLoginOKHeaders) Validate added in v0.29.2 

func (s *PollCliLoginOKHeaders) Validate() error

type PollCliLoginRes added in v0.19.0 

type PollCliLoginRes interface {
	// contains filtered or unexported methods
}

type RateLimitedHeaders 

type RateLimitedHeaders struct {
	RetryAfter OptInt
	Response   ErrorResponse
}

RateLimitedHeaders wraps ErrorResponse with response headers.

func (*RateLimitedHeaders) GetResponse 

func (s *RateLimitedHeaders) GetResponse() ErrorResponse

GetResponse returns the value of Response.

func (*RateLimitedHeaders) GetRetryAfter 

func (s *RateLimitedHeaders) GetRetryAfter() OptInt

GetRetryAfter returns the value of RetryAfter.

func (*RateLimitedHeaders) SetResponse 

func (s *RateLimitedHeaders) SetResponse(val ErrorResponse)

SetResponse sets the value of Response.

func (*RateLimitedHeaders) SetRetryAfter 

func (s *RateLimitedHeaders) SetRetryAfter(val OptInt)

SetRetryAfter sets the value of RetryAfter.

func (*RateLimitedHeaders) Validate 

func (s *RateLimitedHeaders) Validate() error

type ReplayDeliveryBadRequest 

type ReplayDeliveryBadRequest ErrorResponse

func (*ReplayDeliveryBadRequest) Decode 

func (s *ReplayDeliveryBadRequest) Decode(d *jx.Decoder) error

Decode decodes ReplayDeliveryBadRequest from json.

func (*ReplayDeliveryBadRequest) Encode 

func (s *ReplayDeliveryBadRequest) Encode(e *jx.Encoder)

Encode encodes ReplayDeliveryBadRequest as json.

func (*ReplayDeliveryBadRequest) MarshalJSON 

func (s *ReplayDeliveryBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplayDeliveryBadRequest) UnmarshalJSON 

func (s *ReplayDeliveryBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplayDeliveryBadRequest) Validate 

func (s *ReplayDeliveryBadRequest) Validate() error

type ReplayDeliveryNotFound 

type ReplayDeliveryNotFound ErrorResponse

func (*ReplayDeliveryNotFound) Decode 

func (s *ReplayDeliveryNotFound) Decode(d *jx.Decoder) error

Decode decodes ReplayDeliveryNotFound from json.

func (*ReplayDeliveryNotFound) Encode 

func (s *ReplayDeliveryNotFound) Encode(e *jx.Encoder)

Encode encodes ReplayDeliveryNotFound as json.

func (*ReplayDeliveryNotFound) MarshalJSON 

func (s *ReplayDeliveryNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplayDeliveryNotFound) UnmarshalJSON 

func (s *ReplayDeliveryNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplayDeliveryNotFound) Validate 

func (s *ReplayDeliveryNotFound) Validate() error

type ReplayDeliveryOK 

type ReplayDeliveryOK struct {
	Success bool         `json:"success"`
	Data    ReplayResult `json:"data"`
}

Merged schema.

func (*ReplayDeliveryOK) Decode 

func (s *ReplayDeliveryOK) Decode(d *jx.Decoder) error

Decode decodes ReplayDeliveryOK from json.

func (*ReplayDeliveryOK) Encode 

func (s *ReplayDeliveryOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ReplayDeliveryOK) GetData 

func (s *ReplayDeliveryOK) GetData() ReplayResult

GetData returns the value of Data.

func (*ReplayDeliveryOK) GetSuccess 

func (s *ReplayDeliveryOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ReplayDeliveryOK) MarshalJSON 

func (s *ReplayDeliveryOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplayDeliveryOK) SetData 

func (s *ReplayDeliveryOK) SetData(val ReplayResult)

SetData sets the value of Data.

func (*ReplayDeliveryOK) SetSuccess 

func (s *ReplayDeliveryOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ReplayDeliveryOK) UnmarshalJSON 

func (s *ReplayDeliveryOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ReplayDeliveryParams 

type ReplayDeliveryParams struct {
	// Delivery ID (numeric).
	ID string
}

ReplayDeliveryParams is parameters of replayDelivery operation.

type ReplayDeliveryRes 

type ReplayDeliveryRes interface {
	// contains filtered or unexported methods
}

type ReplayDeliveryUnauthorized 

type ReplayDeliveryUnauthorized ErrorResponse

func (*ReplayDeliveryUnauthorized) Decode 

func (s *ReplayDeliveryUnauthorized) Decode(d *jx.Decoder) error

Decode decodes ReplayDeliveryUnauthorized from json.

func (*ReplayDeliveryUnauthorized) Encode 

func (s *ReplayDeliveryUnauthorized) Encode(e *jx.Encoder)

Encode encodes ReplayDeliveryUnauthorized as json.

func (*ReplayDeliveryUnauthorized) MarshalJSON 

func (s *ReplayDeliveryUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplayDeliveryUnauthorized) UnmarshalJSON 

func (s *ReplayDeliveryUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplayDeliveryUnauthorized) Validate 

func (s *ReplayDeliveryUnauthorized) Validate() error

type ReplayEmailWebhooksBadRequest 

type ReplayEmailWebhooksBadRequest ErrorResponse

func (*ReplayEmailWebhooksBadRequest) Decode 

func (s *ReplayEmailWebhooksBadRequest) Decode(d *jx.Decoder) error

Decode decodes ReplayEmailWebhooksBadRequest from json.

func (*ReplayEmailWebhooksBadRequest) Encode 

func (s *ReplayEmailWebhooksBadRequest) Encode(e *jx.Encoder)

Encode encodes ReplayEmailWebhooksBadRequest as json.

func (*ReplayEmailWebhooksBadRequest) MarshalJSON 

func (s *ReplayEmailWebhooksBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplayEmailWebhooksBadRequest) UnmarshalJSON 

func (s *ReplayEmailWebhooksBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplayEmailWebhooksBadRequest) Validate 

func (s *ReplayEmailWebhooksBadRequest) Validate() error

type ReplayEmailWebhooksNotFound 

type ReplayEmailWebhooksNotFound ErrorResponse

func (*ReplayEmailWebhooksNotFound) Decode 

func (s *ReplayEmailWebhooksNotFound) Decode(d *jx.Decoder) error

Decode decodes ReplayEmailWebhooksNotFound from json.

func (*ReplayEmailWebhooksNotFound) Encode 

func (s *ReplayEmailWebhooksNotFound) Encode(e *jx.Encoder)

Encode encodes ReplayEmailWebhooksNotFound as json.

func (*ReplayEmailWebhooksNotFound) MarshalJSON 

func (s *ReplayEmailWebhooksNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplayEmailWebhooksNotFound) UnmarshalJSON 

func (s *ReplayEmailWebhooksNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplayEmailWebhooksNotFound) Validate 

func (s *ReplayEmailWebhooksNotFound) Validate() error

type ReplayEmailWebhooksOK 

type ReplayEmailWebhooksOK struct {
	Success bool         `json:"success"`
	Data    ReplayResult `json:"data"`
}

Merged schema.

func (*ReplayEmailWebhooksOK) Decode 

func (s *ReplayEmailWebhooksOK) Decode(d *jx.Decoder) error

Decode decodes ReplayEmailWebhooksOK from json.

func (*ReplayEmailWebhooksOK) Encode 

func (s *ReplayEmailWebhooksOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ReplayEmailWebhooksOK) GetData 

func (s *ReplayEmailWebhooksOK) GetData() ReplayResult

GetData returns the value of Data.

func (*ReplayEmailWebhooksOK) GetSuccess 

func (s *ReplayEmailWebhooksOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ReplayEmailWebhooksOK) MarshalJSON 

func (s *ReplayEmailWebhooksOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplayEmailWebhooksOK) SetData 

func (s *ReplayEmailWebhooksOK) SetData(val ReplayResult)

SetData sets the value of Data.

func (*ReplayEmailWebhooksOK) SetSuccess 

func (s *ReplayEmailWebhooksOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ReplayEmailWebhooksOK) UnmarshalJSON 

func (s *ReplayEmailWebhooksOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ReplayEmailWebhooksParams 

type ReplayEmailWebhooksParams struct {
	// Resource UUID.
	ID uuid.UUID
}

ReplayEmailWebhooksParams is parameters of replayEmailWebhooks operation.

type ReplayEmailWebhooksRes 

type ReplayEmailWebhooksRes interface {
	// contains filtered or unexported methods
}

type ReplayEmailWebhooksUnauthorized 

type ReplayEmailWebhooksUnauthorized ErrorResponse

func (*ReplayEmailWebhooksUnauthorized) Decode 

func (s *ReplayEmailWebhooksUnauthorized) Decode(d *jx.Decoder) error

Decode decodes ReplayEmailWebhooksUnauthorized from json.

func (*ReplayEmailWebhooksUnauthorized) Encode 

func (s *ReplayEmailWebhooksUnauthorized) Encode(e *jx.Encoder)

Encode encodes ReplayEmailWebhooksUnauthorized as json.

func (*ReplayEmailWebhooksUnauthorized) MarshalJSON 

func (s *ReplayEmailWebhooksUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplayEmailWebhooksUnauthorized) UnmarshalJSON 

func (s *ReplayEmailWebhooksUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplayEmailWebhooksUnauthorized) Validate 

func (s *ReplayEmailWebhooksUnauthorized) Validate() error

type ReplayResult 

type ReplayResult struct {
	// Number of successful deliveries.
	Delivered int `json:"delivered"`
	// Number of failed deliveries.
	Failed int `json:"failed"`
}

Ref: #/components/schemas/ReplayResult

func (*ReplayResult) Decode 

func (s *ReplayResult) Decode(d *jx.Decoder) error

Decode decodes ReplayResult from json.

func (*ReplayResult) Encode 

func (s *ReplayResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ReplayResult) GetDelivered 

func (s *ReplayResult) GetDelivered() int

GetDelivered returns the value of Delivered.

func (*ReplayResult) GetFailed 

func (s *ReplayResult) GetFailed() int

GetFailed returns the value of Failed.

func (*ReplayResult) MarshalJSON 

func (s *ReplayResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplayResult) SetDelivered 

func (s *ReplayResult) SetDelivered(val int)

SetDelivered sets the value of Delivered.

func (*ReplayResult) SetFailed 

func (s *ReplayResult) SetFailed(val int)

SetFailed sets the value of Failed.

func (*ReplayResult) UnmarshalJSON 

func (s *ReplayResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type ReplyInput added in v0.10.0 

type ReplyInput struct {
	// Plain-text reply body. At least one of body_text or body_html is required. The combined UTF-8 byte
	// length of body_text and body_html must be at most 262144 bytes (same cap as send-mail).
	BodyText OptString `json:"body_text"`
	// HTML reply body. At least one of body_text or body_html is required.
	BodyHTML OptString `json:"body_html"`
	// Optional override for the reply's From header. Defaults to
	// the inbound's recipient. Use to add a display name (`"Acme
	// Support" <agent@company.com>`) or to reply from a different
	// verified outbound address (e.g. multi-team routing where
	// support@ triages to billing@). The from-domain must be a
	// verified outbound domain for your org, same as send-mail.
	From OptString `json:"from"`
	// When true, wait for the first downstream SMTP delivery outcome before returning, mirroring the
	// send-mail `wait` semantics.
	Wait OptBool `json:"wait"`
}

Body shape for `/emails/{id}/reply`. Intentionally narrow: recipients (`to`), subject, and threading headers (`in_reply_to`, `references`) are derived server-side from the inbound row referenced by the path id and are rejected by `additionalProperties` if passed (returns 400). `from` IS allowed because of legitimate use cases (display-name addition, replying from a different verified outbound address, multi-team triage). Send-mail's per-send `canSendFrom` gate validates the from-domain regardless, so the override carries no extra privilege. Ref: #/components/schemas/ReplyInput

func (*ReplyInput) Decode added in v0.10.0 

func (s *ReplyInput) Decode(d *jx.Decoder) error

Decode decodes ReplyInput from json.

func (*ReplyInput) Encode added in v0.10.0 

func (s *ReplyInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ReplyInput) GetBodyHTML added in v0.10.0 

func (s *ReplyInput) GetBodyHTML() OptString

GetBodyHTML returns the value of BodyHTML.

func (*ReplyInput) GetBodyText added in v0.10.0 

func (s *ReplyInput) GetBodyText() OptString

GetBodyText returns the value of BodyText.

func (*ReplyInput) GetFrom added in v0.10.0 

func (s *ReplyInput) GetFrom() OptString

GetFrom returns the value of From.

func (*ReplyInput) GetWait added in v0.10.0 

func (s *ReplyInput) GetWait() OptBool

GetWait returns the value of Wait.

func (*ReplyInput) MarshalJSON added in v0.10.0 

func (s *ReplyInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyInput) SetBodyHTML added in v0.10.0 

func (s *ReplyInput) SetBodyHTML(val OptString)

SetBodyHTML sets the value of BodyHTML.

func (*ReplyInput) SetBodyText added in v0.10.0 

func (s *ReplyInput) SetBodyText(val OptString)

SetBodyText sets the value of BodyText.

func (*ReplyInput) SetFrom added in v0.10.0 

func (s *ReplyInput) SetFrom(val OptString)

SetFrom sets the value of From.

func (*ReplyInput) SetWait added in v0.10.0 

func (s *ReplyInput) SetWait(val OptBool)

SetWait sets the value of Wait.

func (*ReplyInput) UnmarshalJSON added in v0.10.0 

func (s *ReplyInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyInput) Validate added in v0.10.0 

func (s *ReplyInput) Validate() error

type ReplyToEmailBadGateway added in v0.10.0 

type ReplyToEmailBadGateway ErrorResponse

func (*ReplyToEmailBadGateway) Decode added in v0.10.0 

func (s *ReplyToEmailBadGateway) Decode(d *jx.Decoder) error

Decode decodes ReplyToEmailBadGateway from json.

func (*ReplyToEmailBadGateway) Encode added in v0.10.0 

func (s *ReplyToEmailBadGateway) Encode(e *jx.Encoder)

Encode encodes ReplyToEmailBadGateway as json.

func (*ReplyToEmailBadGateway) MarshalJSON added in v0.10.0 

func (s *ReplyToEmailBadGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyToEmailBadGateway) UnmarshalJSON added in v0.10.0 

func (s *ReplyToEmailBadGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyToEmailBadGateway) Validate added in v0.10.0 

func (s *ReplyToEmailBadGateway) Validate() error

type ReplyToEmailBadRequest added in v0.10.0 

type ReplyToEmailBadRequest ErrorResponse

func (*ReplyToEmailBadRequest) Decode added in v0.10.0 

func (s *ReplyToEmailBadRequest) Decode(d *jx.Decoder) error

Decode decodes ReplyToEmailBadRequest from json.

func (*ReplyToEmailBadRequest) Encode added in v0.10.0 

func (s *ReplyToEmailBadRequest) Encode(e *jx.Encoder)

Encode encodes ReplyToEmailBadRequest as json.

func (*ReplyToEmailBadRequest) MarshalJSON added in v0.10.0 

func (s *ReplyToEmailBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyToEmailBadRequest) UnmarshalJSON added in v0.10.0 

func (s *ReplyToEmailBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyToEmailBadRequest) Validate added in v0.10.0 

func (s *ReplyToEmailBadRequest) Validate() error

type ReplyToEmailForbidden added in v0.10.0 

type ReplyToEmailForbidden ErrorResponse

func (*ReplyToEmailForbidden) Decode added in v0.10.0 

func (s *ReplyToEmailForbidden) Decode(d *jx.Decoder) error

Decode decodes ReplyToEmailForbidden from json.

func (*ReplyToEmailForbidden) Encode added in v0.10.0 

func (s *ReplyToEmailForbidden) Encode(e *jx.Encoder)

Encode encodes ReplyToEmailForbidden as json.

func (*ReplyToEmailForbidden) MarshalJSON added in v0.10.0 

func (s *ReplyToEmailForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyToEmailForbidden) UnmarshalJSON added in v0.10.0 

func (s *ReplyToEmailForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyToEmailForbidden) Validate added in v0.10.0 

func (s *ReplyToEmailForbidden) Validate() error

type ReplyToEmailInternalServerError added in v0.10.0 

type ReplyToEmailInternalServerError ErrorResponse

func (*ReplyToEmailInternalServerError) Decode added in v0.10.0 

func (s *ReplyToEmailInternalServerError) Decode(d *jx.Decoder) error

Decode decodes ReplyToEmailInternalServerError from json.

func (*ReplyToEmailInternalServerError) Encode added in v0.10.0 

func (s *ReplyToEmailInternalServerError) Encode(e *jx.Encoder)

Encode encodes ReplyToEmailInternalServerError as json.

func (*ReplyToEmailInternalServerError) MarshalJSON added in v0.10.0 

func (s *ReplyToEmailInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyToEmailInternalServerError) UnmarshalJSON added in v0.10.0 

func (s *ReplyToEmailInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyToEmailInternalServerError) Validate added in v0.10.0 

func (s *ReplyToEmailInternalServerError) Validate() error

type ReplyToEmailNotFound added in v0.10.0 

type ReplyToEmailNotFound ErrorResponse

func (*ReplyToEmailNotFound) Decode added in v0.10.0 

func (s *ReplyToEmailNotFound) Decode(d *jx.Decoder) error

Decode decodes ReplyToEmailNotFound from json.

func (*ReplyToEmailNotFound) Encode added in v0.10.0 

func (s *ReplyToEmailNotFound) Encode(e *jx.Encoder)

Encode encodes ReplyToEmailNotFound as json.

func (*ReplyToEmailNotFound) MarshalJSON added in v0.10.0 

func (s *ReplyToEmailNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyToEmailNotFound) UnmarshalJSON added in v0.10.0 

func (s *ReplyToEmailNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyToEmailNotFound) Validate added in v0.10.0 

func (s *ReplyToEmailNotFound) Validate() error

type ReplyToEmailOK added in v0.10.0 

type ReplyToEmailOK struct {
	Success bool           `json:"success"`
	Data    SendMailResult `json:"data"`
}

Merged schema.

func (*ReplyToEmailOK) Decode added in v0.10.0 

func (s *ReplyToEmailOK) Decode(d *jx.Decoder) error

Decode decodes ReplyToEmailOK from json.

func (*ReplyToEmailOK) Encode added in v0.10.0 

func (s *ReplyToEmailOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ReplyToEmailOK) GetData added in v0.10.0 

func (s *ReplyToEmailOK) GetData() SendMailResult

GetData returns the value of Data.

func (*ReplyToEmailOK) GetSuccess added in v0.10.0 

func (s *ReplyToEmailOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ReplyToEmailOK) MarshalJSON added in v0.10.0 

func (s *ReplyToEmailOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyToEmailOK) SetData added in v0.10.0 

func (s *ReplyToEmailOK) SetData(val SendMailResult)

SetData sets the value of Data.

func (*ReplyToEmailOK) SetSuccess added in v0.10.0 

func (s *ReplyToEmailOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ReplyToEmailOK) UnmarshalJSON added in v0.10.0 

func (s *ReplyToEmailOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyToEmailOK) Validate added in v0.10.0 

func (s *ReplyToEmailOK) Validate() error

type ReplyToEmailParams added in v0.10.0 

type ReplyToEmailParams struct {
	// Resource UUID.
	ID uuid.UUID
}

ReplyToEmailParams is parameters of replyToEmail operation.

type ReplyToEmailRes added in v0.10.0 

type ReplyToEmailRes interface {
	// contains filtered or unexported methods
}

type ReplyToEmailServiceUnavailable added in v0.10.0 

type ReplyToEmailServiceUnavailable ErrorResponse

func (*ReplyToEmailServiceUnavailable) Decode added in v0.10.0 

func (s *ReplyToEmailServiceUnavailable) Decode(d *jx.Decoder) error

Decode decodes ReplyToEmailServiceUnavailable from json.

func (*ReplyToEmailServiceUnavailable) Encode added in v0.10.0 

func (s *ReplyToEmailServiceUnavailable) Encode(e *jx.Encoder)

Encode encodes ReplyToEmailServiceUnavailable as json.

func (*ReplyToEmailServiceUnavailable) MarshalJSON added in v0.10.0 

func (s *ReplyToEmailServiceUnavailable) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyToEmailServiceUnavailable) UnmarshalJSON added in v0.10.0 

func (s *ReplyToEmailServiceUnavailable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyToEmailServiceUnavailable) Validate added in v0.10.0 

func (s *ReplyToEmailServiceUnavailable) Validate() error

type ReplyToEmailUnauthorized added in v0.10.0 

type ReplyToEmailUnauthorized ErrorResponse

func (*ReplyToEmailUnauthorized) Decode added in v0.10.0 

func (s *ReplyToEmailUnauthorized) Decode(d *jx.Decoder) error

Decode decodes ReplyToEmailUnauthorized from json.

func (*ReplyToEmailUnauthorized) Encode added in v0.10.0 

func (s *ReplyToEmailUnauthorized) Encode(e *jx.Encoder)

Encode encodes ReplyToEmailUnauthorized as json.

func (*ReplyToEmailUnauthorized) MarshalJSON added in v0.10.0 

func (s *ReplyToEmailUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyToEmailUnauthorized) UnmarshalJSON added in v0.10.0 

func (s *ReplyToEmailUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyToEmailUnauthorized) Validate added in v0.10.0 

func (s *ReplyToEmailUnauthorized) Validate() error

type ReplyToEmailUnprocessableEntity added in v0.10.0 

type ReplyToEmailUnprocessableEntity ErrorResponse

func (*ReplyToEmailUnprocessableEntity) Decode added in v0.10.0 

func (s *ReplyToEmailUnprocessableEntity) Decode(d *jx.Decoder) error

Decode decodes ReplyToEmailUnprocessableEntity from json.

func (*ReplyToEmailUnprocessableEntity) Encode added in v0.10.0 

func (s *ReplyToEmailUnprocessableEntity) Encode(e *jx.Encoder)

Encode encodes ReplyToEmailUnprocessableEntity as json.

func (*ReplyToEmailUnprocessableEntity) MarshalJSON added in v0.10.0 

func (s *ReplyToEmailUnprocessableEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReplyToEmailUnprocessableEntity) UnmarshalJSON added in v0.10.0 

func (s *ReplyToEmailUnprocessableEntity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReplyToEmailUnprocessableEntity) Validate added in v0.10.0 

func (s *ReplyToEmailUnprocessableEntity) Validate() error

type ResendAgentSignupVerificationInput added in v0.29.2 

type ResendAgentSignupVerificationInput struct {
	SignupToken string `json:"signup_token"`
}

Ref: #/components/schemas/ResendAgentSignupVerificationInput

func (*ResendAgentSignupVerificationInput) Decode added in v0.29.2 

func (s *ResendAgentSignupVerificationInput) Decode(d *jx.Decoder) error

Decode decodes ResendAgentSignupVerificationInput from json.

func (*ResendAgentSignupVerificationInput) Encode added in v0.29.2 

func (s *ResendAgentSignupVerificationInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ResendAgentSignupVerificationInput) GetSignupToken added in v0.29.2 

func (s *ResendAgentSignupVerificationInput) GetSignupToken() string

GetSignupToken returns the value of SignupToken.

func (*ResendAgentSignupVerificationInput) MarshalJSON added in v0.29.2 

func (s *ResendAgentSignupVerificationInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ResendAgentSignupVerificationInput) SetSignupToken added in v0.29.2 

func (s *ResendAgentSignupVerificationInput) SetSignupToken(val string)

SetSignupToken sets the value of SignupToken.

func (*ResendAgentSignupVerificationInput) UnmarshalJSON added in v0.29.2 

func (s *ResendAgentSignupVerificationInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ResendAgentSignupVerificationInput) Validate added in v0.29.2 

func (s *ResendAgentSignupVerificationInput) Validate() error

type ResendAgentSignupVerificationOK added in v0.29.2 

type ResendAgentSignupVerificationOK struct {
	Success bool                    `json:"success"`
	Data    AgentSignupResendResult `json:"data"`
}

Merged schema.

func (*ResendAgentSignupVerificationOK) Decode added in v0.29.2 

func (s *ResendAgentSignupVerificationOK) Decode(d *jx.Decoder) error

Decode decodes ResendAgentSignupVerificationOK from json.

func (*ResendAgentSignupVerificationOK) Encode added in v0.29.2 

func (s *ResendAgentSignupVerificationOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ResendAgentSignupVerificationOK) GetData added in v0.29.2 

func (s *ResendAgentSignupVerificationOK) GetData() AgentSignupResendResult

GetData returns the value of Data.

func (*ResendAgentSignupVerificationOK) GetSuccess added in v0.29.2 

func (s *ResendAgentSignupVerificationOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ResendAgentSignupVerificationOK) MarshalJSON added in v0.29.2 

func (s *ResendAgentSignupVerificationOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ResendAgentSignupVerificationOK) SetData added in v0.29.2 

func (s *ResendAgentSignupVerificationOK) SetData(val AgentSignupResendResult)

SetData sets the value of Data.

func (*ResendAgentSignupVerificationOK) SetSuccess added in v0.29.2 

func (s *ResendAgentSignupVerificationOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ResendAgentSignupVerificationOK) UnmarshalJSON added in v0.29.2 

func (s *ResendAgentSignupVerificationOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ResendAgentSignupVerificationOK) Validate added in v0.29.2 

func (s *ResendAgentSignupVerificationOK) Validate() error

type ResendAgentSignupVerificationOKHeaders added in v0.29.2 

type ResendAgentSignupVerificationOKHeaders struct {
	CacheControl OptString
	Response     ResendAgentSignupVerificationOK
}

ResendAgentSignupVerificationOKHeaders wraps ResendAgentSignupVerificationOK with response headers.

func (*ResendAgentSignupVerificationOKHeaders) GetCacheControl added in v0.29.2 

func (s *ResendAgentSignupVerificationOKHeaders) GetCacheControl() OptString

GetCacheControl returns the value of CacheControl.

func (*ResendAgentSignupVerificationOKHeaders) GetResponse added in v0.29.2 

func (s *ResendAgentSignupVerificationOKHeaders) GetResponse() ResendAgentSignupVerificationOK

GetResponse returns the value of Response.

func (*ResendAgentSignupVerificationOKHeaders) SetCacheControl added in v0.29.2 

func (s *ResendAgentSignupVerificationOKHeaders) SetCacheControl(val OptString)

SetCacheControl sets the value of CacheControl.

func (*ResendAgentSignupVerificationOKHeaders) SetResponse added in v0.29.2 

func (s *ResendAgentSignupVerificationOKHeaders) SetResponse(val ResendAgentSignupVerificationOK)

SetResponse sets the value of Response.

func (*ResendAgentSignupVerificationOKHeaders) Validate added in v0.29.2 

func (s *ResendAgentSignupVerificationOKHeaders) Validate() error

type ResendAgentSignupVerificationRes added in v0.29.2 

type ResendAgentSignupVerificationRes interface {
	// contains filtered or unexported methods
}

type ResendCliSignupVerificationInput added in v0.28.0 

type ResendCliSignupVerificationInput struct {
	SignupToken string `json:"signup_token"`
}

Ref: #/components/schemas/ResendCliSignupVerificationInput

func (*ResendCliSignupVerificationInput) Decode added in v0.28.0 

func (s *ResendCliSignupVerificationInput) Decode(d *jx.Decoder) error

Decode decodes ResendCliSignupVerificationInput from json.

func (*ResendCliSignupVerificationInput) Encode added in v0.28.0 

func (s *ResendCliSignupVerificationInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ResendCliSignupVerificationInput) GetSignupToken added in v0.28.0 

func (s *ResendCliSignupVerificationInput) GetSignupToken() string

GetSignupToken returns the value of SignupToken.

func (*ResendCliSignupVerificationInput) MarshalJSON added in v0.28.0 

func (s *ResendCliSignupVerificationInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ResendCliSignupVerificationInput) SetSignupToken added in v0.28.0 

func (s *ResendCliSignupVerificationInput) SetSignupToken(val string)

SetSignupToken sets the value of SignupToken.

func (*ResendCliSignupVerificationInput) UnmarshalJSON added in v0.28.0 

func (s *ResendCliSignupVerificationInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ResendCliSignupVerificationInput) Validate added in v0.28.0 

func (s *ResendCliSignupVerificationInput) Validate() error

type ResendCliSignupVerificationOK added in v0.28.0 

type ResendCliSignupVerificationOK struct {
	Success bool                  `json:"success"`
	Data    CliSignupResendResult `json:"data"`
}

Merged schema.

func (*ResendCliSignupVerificationOK) Decode added in v0.28.0 

func (s *ResendCliSignupVerificationOK) Decode(d *jx.Decoder) error

Decode decodes ResendCliSignupVerificationOK from json.

func (*ResendCliSignupVerificationOK) Encode added in v0.28.0 

func (s *ResendCliSignupVerificationOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ResendCliSignupVerificationOK) GetData added in v0.28.0 

func (s *ResendCliSignupVerificationOK) GetData() CliSignupResendResult

GetData returns the value of Data.

func (*ResendCliSignupVerificationOK) GetSuccess added in v0.28.0 

func (s *ResendCliSignupVerificationOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*ResendCliSignupVerificationOK) MarshalJSON added in v0.28.0 

func (s *ResendCliSignupVerificationOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ResendCliSignupVerificationOK) SetData added in v0.28.0 

func (s *ResendCliSignupVerificationOK) SetData(val CliSignupResendResult)

SetData sets the value of Data.

func (*ResendCliSignupVerificationOK) SetSuccess added in v0.28.0 

func (s *ResendCliSignupVerificationOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*ResendCliSignupVerificationOK) UnmarshalJSON added in v0.28.0 

func (s *ResendCliSignupVerificationOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ResendCliSignupVerificationOK) Validate added in v0.28.0 

func (s *ResendCliSignupVerificationOK) Validate() error

type ResendCliSignupVerificationOKHeaders added in v0.28.0 

type ResendCliSignupVerificationOKHeaders struct {
	CacheControl OptString
	Response     ResendCliSignupVerificationOK
}

ResendCliSignupVerificationOKHeaders wraps ResendCliSignupVerificationOK with response headers.

func (*ResendCliSignupVerificationOKHeaders) GetCacheControl added in v0.28.0 

func (s *ResendCliSignupVerificationOKHeaders) GetCacheControl() OptString

GetCacheControl returns the value of CacheControl.

func (*ResendCliSignupVerificationOKHeaders) GetResponse added in v0.28.0 

func (s *ResendCliSignupVerificationOKHeaders) GetResponse() ResendCliSignupVerificationOK

GetResponse returns the value of Response.

func (*ResendCliSignupVerificationOKHeaders) SetCacheControl added in v0.28.0 

func (s *ResendCliSignupVerificationOKHeaders) SetCacheControl(val OptString)

SetCacheControl sets the value of CacheControl.

func (*ResendCliSignupVerificationOKHeaders) SetResponse added in v0.28.0 

func (s *ResendCliSignupVerificationOKHeaders) SetResponse(val ResendCliSignupVerificationOK)

SetResponse sets the value of Response.

func (*ResendCliSignupVerificationOKHeaders) Validate added in v0.28.0 

func (s *ResendCliSignupVerificationOKHeaders) Validate() error

type ResendCliSignupVerificationRes added in v0.28.0 

type ResendCliSignupVerificationRes interface {
	// contains filtered or unexported methods
}

type RotateWebhookSecretBadRequest 

type RotateWebhookSecretBadRequest ErrorResponse

func (*RotateWebhookSecretBadRequest) Decode 

func (s *RotateWebhookSecretBadRequest) Decode(d *jx.Decoder) error

Decode decodes RotateWebhookSecretBadRequest from json.

func (*RotateWebhookSecretBadRequest) Encode 

func (s *RotateWebhookSecretBadRequest) Encode(e *jx.Encoder)

Encode encodes RotateWebhookSecretBadRequest as json.

func (*RotateWebhookSecretBadRequest) MarshalJSON 

func (s *RotateWebhookSecretBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*RotateWebhookSecretBadRequest) UnmarshalJSON 

func (s *RotateWebhookSecretBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*RotateWebhookSecretBadRequest) Validate 

func (s *RotateWebhookSecretBadRequest) Validate() error

type RotateWebhookSecretNotFound 

type RotateWebhookSecretNotFound ErrorResponse

func (*RotateWebhookSecretNotFound) Decode 

func (s *RotateWebhookSecretNotFound) Decode(d *jx.Decoder) error

Decode decodes RotateWebhookSecretNotFound from json.

func (*RotateWebhookSecretNotFound) Encode 

func (s *RotateWebhookSecretNotFound) Encode(e *jx.Encoder)

Encode encodes RotateWebhookSecretNotFound as json.

func (*RotateWebhookSecretNotFound) MarshalJSON 

func (s *RotateWebhookSecretNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*RotateWebhookSecretNotFound) UnmarshalJSON 

func (s *RotateWebhookSecretNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*RotateWebhookSecretNotFound) Validate 

func (s *RotateWebhookSecretNotFound) Validate() error

type RotateWebhookSecretOK 

type RotateWebhookSecretOK struct {
	Success bool          `json:"success"`
	Data    WebhookSecret `json:"data"`
}

Merged schema.

func (*RotateWebhookSecretOK) Decode 

func (s *RotateWebhookSecretOK) Decode(d *jx.Decoder) error

Decode decodes RotateWebhookSecretOK from json.

func (*RotateWebhookSecretOK) Encode 

func (s *RotateWebhookSecretOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*RotateWebhookSecretOK) GetData 

func (s *RotateWebhookSecretOK) GetData() WebhookSecret

GetData returns the value of Data.

func (*RotateWebhookSecretOK) GetSuccess 

func (s *RotateWebhookSecretOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*RotateWebhookSecretOK) MarshalJSON 

func (s *RotateWebhookSecretOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*RotateWebhookSecretOK) SetData 

func (s *RotateWebhookSecretOK) SetData(val WebhookSecret)

SetData sets the value of Data.

func (*RotateWebhookSecretOK) SetSuccess 

func (s *RotateWebhookSecretOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*RotateWebhookSecretOK) UnmarshalJSON 

func (s *RotateWebhookSecretOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type RotateWebhookSecretRes 

type RotateWebhookSecretRes interface {
	// contains filtered or unexported methods
}

type RotateWebhookSecretUnauthorized 

type RotateWebhookSecretUnauthorized ErrorResponse

func (*RotateWebhookSecretUnauthorized) Decode 

func (s *RotateWebhookSecretUnauthorized) Decode(d *jx.Decoder) error

Decode decodes RotateWebhookSecretUnauthorized from json.

func (*RotateWebhookSecretUnauthorized) Encode 

func (s *RotateWebhookSecretUnauthorized) Encode(e *jx.Encoder)

Encode encodes RotateWebhookSecretUnauthorized as json.

func (*RotateWebhookSecretUnauthorized) MarshalJSON 

func (s *RotateWebhookSecretUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*RotateWebhookSecretUnauthorized) UnmarshalJSON 

func (s *RotateWebhookSecretUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*RotateWebhookSecretUnauthorized) Validate 

func (s *RotateWebhookSecretUnauthorized) Validate() error

type Route 

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

Route is route object.

func (Route) Args 

func (r Route) Args() []string

Args returns parsed arguments.

func (Route) Name 

func (r Route) Name() string

Name returns ogen operation name.

It is guaranteed to be unique and not empty.

func (Route) OperationGroup 

func (r Route) OperationGroup() string

OperationGroup returns the x-ogen-operation-group value.

func (Route) OperationID 

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

func (Route) PathPattern 

func (r Route) PathPattern() string

PathPattern returns OpenAPI path.

func (Route) Summary 

func (r Route) Summary() string

Summary returns OpenAPI summary.

type SearchEmailsBadRequest added in v0.21.0 

type SearchEmailsBadRequest ErrorResponse

func (*SearchEmailsBadRequest) Decode added in v0.21.0 

func (s *SearchEmailsBadRequest) Decode(d *jx.Decoder) error

Decode decodes SearchEmailsBadRequest from json.

func (*SearchEmailsBadRequest) Encode added in v0.21.0 

func (s *SearchEmailsBadRequest) Encode(e *jx.Encoder)

Encode encodes SearchEmailsBadRequest as json.

func (*SearchEmailsBadRequest) MarshalJSON added in v0.21.0 

func (s *SearchEmailsBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SearchEmailsBadRequest) UnmarshalJSON added in v0.21.0 

func (s *SearchEmailsBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SearchEmailsBadRequest) Validate added in v0.21.0 

func (s *SearchEmailsBadRequest) Validate() error

type SearchEmailsGatewayTimeout added in v0.21.0 

type SearchEmailsGatewayTimeout ErrorResponse

func (*SearchEmailsGatewayTimeout) Decode added in v0.21.0 

func (s *SearchEmailsGatewayTimeout) Decode(d *jx.Decoder) error

Decode decodes SearchEmailsGatewayTimeout from json.

func (*SearchEmailsGatewayTimeout) Encode added in v0.21.0 

func (s *SearchEmailsGatewayTimeout) Encode(e *jx.Encoder)

Encode encodes SearchEmailsGatewayTimeout as json.

func (*SearchEmailsGatewayTimeout) MarshalJSON added in v0.21.0 

func (s *SearchEmailsGatewayTimeout) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SearchEmailsGatewayTimeout) UnmarshalJSON added in v0.21.0 

func (s *SearchEmailsGatewayTimeout) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SearchEmailsGatewayTimeout) Validate added in v0.21.0 

func (s *SearchEmailsGatewayTimeout) Validate() error

type SearchEmailsHasAttachment added in v0.21.0 

type SearchEmailsHasAttachment string
const (
	SearchEmailsHasAttachmentTrue  SearchEmailsHasAttachment = "true"
	SearchEmailsHasAttachmentFalse SearchEmailsHasAttachment = "false"
)

func (SearchEmailsHasAttachment) AllValues added in v0.21.0 

func (SearchEmailsHasAttachment) AllValues() []SearchEmailsHasAttachment

AllValues returns all SearchEmailsHasAttachment values.

func (SearchEmailsHasAttachment) MarshalText added in v0.21.0 

func (s SearchEmailsHasAttachment) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SearchEmailsHasAttachment) UnmarshalText added in v0.21.0 

func (s *SearchEmailsHasAttachment) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SearchEmailsHasAttachment) Validate added in v0.21.0 

func (s SearchEmailsHasAttachment) Validate() error

type SearchEmailsIncludeFacets added in v0.21.0 

type SearchEmailsIncludeFacets string
const (
	SearchEmailsIncludeFacetsTrue  SearchEmailsIncludeFacets = "true"
	SearchEmailsIncludeFacetsFalse SearchEmailsIncludeFacets = "false"
)

func (SearchEmailsIncludeFacets) AllValues added in v0.21.0 

func (SearchEmailsIncludeFacets) AllValues() []SearchEmailsIncludeFacets

AllValues returns all SearchEmailsIncludeFacets values.

func (SearchEmailsIncludeFacets) MarshalText added in v0.21.0 

func (s SearchEmailsIncludeFacets) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SearchEmailsIncludeFacets) UnmarshalText added in v0.21.0 

func (s *SearchEmailsIncludeFacets) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SearchEmailsIncludeFacets) Validate added in v0.21.0 

func (s SearchEmailsIncludeFacets) Validate() error

type SearchEmailsOK added in v0.21.0 

type SearchEmailsOK struct {
	Success bool                 `json:"success"`
	Data    []EmailSearchResult  `json:"data"`
	Meta    EmailSearchMeta      `json:"meta"`
	Facets  OptEmailSearchFacets `json:"facets"`
}

Merged schema.

func (*SearchEmailsOK) Decode added in v0.21.0 

func (s *SearchEmailsOK) Decode(d *jx.Decoder) error

Decode decodes SearchEmailsOK from json.

func (*SearchEmailsOK) Encode added in v0.21.0 

func (s *SearchEmailsOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SearchEmailsOK) GetData added in v0.21.0 

func (s *SearchEmailsOK) GetData() []EmailSearchResult

GetData returns the value of Data.

func (*SearchEmailsOK) GetFacets added in v0.21.0 

func (s *SearchEmailsOK) GetFacets() OptEmailSearchFacets

GetFacets returns the value of Facets.

func (*SearchEmailsOK) GetMeta added in v0.21.0 

func (s *SearchEmailsOK) GetMeta() EmailSearchMeta

GetMeta returns the value of Meta.

func (*SearchEmailsOK) GetSuccess added in v0.21.0 

func (s *SearchEmailsOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*SearchEmailsOK) MarshalJSON added in v0.21.0 

func (s *SearchEmailsOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SearchEmailsOK) SetData added in v0.21.0 

func (s *SearchEmailsOK) SetData(val []EmailSearchResult)

SetData sets the value of Data.

func (*SearchEmailsOK) SetFacets added in v0.21.0 

func (s *SearchEmailsOK) SetFacets(val OptEmailSearchFacets)

SetFacets sets the value of Facets.

func (*SearchEmailsOK) SetMeta added in v0.21.0 

func (s *SearchEmailsOK) SetMeta(val EmailSearchMeta)

SetMeta sets the value of Meta.

func (*SearchEmailsOK) SetSuccess added in v0.21.0 

func (s *SearchEmailsOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*SearchEmailsOK) UnmarshalJSON added in v0.21.0 

func (s *SearchEmailsOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SearchEmailsOK) Validate added in v0.21.0 

func (s *SearchEmailsOK) Validate() error

type SearchEmailsParams added in v0.21.0 

type SearchEmailsParams struct {
	// Full-text search DSL query.
	Q OptString `json:",omitempty,omitzero"`
	// Filter by sender address or sender domain.
	From OptString `json:",omitempty,omitzero"`
	// Filter by recipient address or recipient domain.
	To OptString `json:",omitempty,omitzero"`
	// Full-text search restricted to the subject field.
	Subject OptString `json:",omitempty,omitzero"`
	// Full-text search restricted to the parsed text body.
	Body OptString `json:",omitempty,omitzero"`
	// Filter by domain ID.
	DomainID OptUUID `json:",omitempty,omitzero"`
	// Filter to inbound emails that are replies to a specific
	// outbound send. The value is a `sent_emails.id` (UUID). At
	// inbound ingest, Primitive matches the parsed In-Reply-To
	// header (or References as a fallback) against
	// `sent_emails.message_id` in the same org and records the
	// resolved id on `emails.reply_to_sent_email_id`. This filter
	// is the strict-threading lookup behind `primitive chat` and
	// any UI that wants to show the inbound reply to a given
	// send. NULL on inbound that isn't a threaded reply to one
	// of your sends, so existing emails received before this
	// ingestion landed will not match.
	ReplyToSentEmailID OptUUID `json:",omitempty,omitzero"`
	// Filter by inbound email lifecycle status.
	Status OptEmailStatus `json:",omitempty,omitzero"`
	// Filter emails received on or after this timestamp.
	DateFrom OptDateTime `json:",omitempty,omitzero"`
	// Filter emails received on or before this timestamp.
	DateTo OptDateTime `json:",omitempty,omitzero"`
	// Filter by whether the email has one or more attachments.
	HasAttachment OptSearchEmailsHasAttachment `json:",omitempty,omitzero"`
	// Filter to emails with spam score below this value.
	SpamScoreLt OptFloat64 `json:",omitempty,omitzero"`
	// Filter to emails with spam score greater than or equal to this value.
	SpamScoreGte OptFloat64 `json:",omitempty,omitzero"`
	// Sort mode. Defaults to relevance when a text query is present,
	// otherwise `received_at_desc`.
	Sort OptSearchEmailsSort `json:",omitempty,omitzero"`
	// Opaque pagination cursor from a previous search response.
	Cursor OptString `json:",omitempty,omitzero"`
	// Number of results per page.
	Limit OptInt `json:",omitempty,omitzero"`
	// Include subject/body highlight snippets when text search is active.
	Snippet OptSearchEmailsSnippet `json:",omitempty,omitzero"`
	// Include facet counts for sender, domain, status, and attachment presence.
	IncludeFacets OptSearchEmailsIncludeFacets `json:",omitempty,omitzero"`
}

SearchEmailsParams is parameters of searchEmails operation.

type SearchEmailsRes added in v0.21.0 

type SearchEmailsRes interface {
	// contains filtered or unexported methods
}

type SearchEmailsSnippet added in v0.21.0 

type SearchEmailsSnippet string
const (
	SearchEmailsSnippetTrue  SearchEmailsSnippet = "true"
	SearchEmailsSnippetFalse SearchEmailsSnippet = "false"
)

func (SearchEmailsSnippet) AllValues added in v0.21.0 

func (SearchEmailsSnippet) AllValues() []SearchEmailsSnippet

AllValues returns all SearchEmailsSnippet values.

func (SearchEmailsSnippet) MarshalText added in v0.21.0 

func (s SearchEmailsSnippet) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SearchEmailsSnippet) UnmarshalText added in v0.21.0 

func (s *SearchEmailsSnippet) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SearchEmailsSnippet) Validate added in v0.21.0 

func (s SearchEmailsSnippet) Validate() error

type SearchEmailsSort added in v0.21.0 

type SearchEmailsSort string
const (
	SearchEmailsSortRelevance      SearchEmailsSort = "relevance"
	SearchEmailsSortReceivedAtDesc SearchEmailsSort = "received_at_desc"
	SearchEmailsSortReceivedAtAsc  SearchEmailsSort = "received_at_asc"
)

func (SearchEmailsSort) AllValues added in v0.21.0 

func (SearchEmailsSort) AllValues() []SearchEmailsSort

AllValues returns all SearchEmailsSort values.

func (SearchEmailsSort) MarshalText added in v0.21.0 

func (s SearchEmailsSort) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SearchEmailsSort) UnmarshalText added in v0.21.0 

func (s *SearchEmailsSort) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SearchEmailsSort) Validate added in v0.21.0 

func (s SearchEmailsSort) Validate() error

type SearchEmailsUnauthorized added in v0.21.0 

type SearchEmailsUnauthorized ErrorResponse

func (*SearchEmailsUnauthorized) Decode added in v0.21.0 

func (s *SearchEmailsUnauthorized) Decode(d *jx.Decoder) error

Decode decodes SearchEmailsUnauthorized from json.

func (*SearchEmailsUnauthorized) Encode added in v0.21.0 

func (s *SearchEmailsUnauthorized) Encode(e *jx.Encoder)

Encode encodes SearchEmailsUnauthorized as json.

func (*SearchEmailsUnauthorized) MarshalJSON added in v0.21.0 

func (s *SearchEmailsUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SearchEmailsUnauthorized) UnmarshalJSON added in v0.21.0 

func (s *SearchEmailsUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SearchEmailsUnauthorized) Validate added in v0.21.0 

func (s *SearchEmailsUnauthorized) Validate() error

type SecurityHandler 

type SecurityHandler interface {
	// HandleBearerAuth handles BearerAuth security.
	// API key with `prim_` prefix: `Authorization: Bearer prim_<key>`.
	HandleBearerAuth(ctx context.Context, operationName OperationName, t BearerAuth) (context.Context, error)
	// HandleDownloadToken handles DownloadToken security.
	// Signed download token provided in webhook payloads.
	HandleDownloadToken(ctx context.Context, operationName OperationName, t DownloadToken) (context.Context, error)
}

SecurityHandler is handler for security parameters.

type SecuritySource 

type SecuritySource interface {
	// BearerAuth provides BearerAuth security value.
	// API key with `prim_` prefix: `Authorization: Bearer prim_<key>`.
	BearerAuth(ctx context.Context, operationName OperationName) (BearerAuth, error)
	// DownloadToken provides DownloadToken security value.
	// Signed download token provided in webhook payloads.
	DownloadToken(ctx context.Context, operationName OperationName) (DownloadToken, error)
}

SecuritySource is provider of security values (tokens, passwords, etc.).

type SendEmailBadGateway added in v0.8.0 

type SendEmailBadGateway ErrorResponse

func (*SendEmailBadGateway) Decode added in v0.8.0 

func (s *SendEmailBadGateway) Decode(d *jx.Decoder) error

Decode decodes SendEmailBadGateway from json.

func (*SendEmailBadGateway) Encode added in v0.8.0 

func (s *SendEmailBadGateway) Encode(e *jx.Encoder)

Encode encodes SendEmailBadGateway as json.

func (*SendEmailBadGateway) MarshalJSON added in v0.8.0 

func (s *SendEmailBadGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendEmailBadGateway) UnmarshalJSON added in v0.8.0 

func (s *SendEmailBadGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendEmailBadGateway) Validate added in v0.8.0 

func (s *SendEmailBadGateway) Validate() error

type SendEmailBadRequest added in v0.8.0 

type SendEmailBadRequest ErrorResponse

func (*SendEmailBadRequest) Decode added in v0.8.0 

func (s *SendEmailBadRequest) Decode(d *jx.Decoder) error

Decode decodes SendEmailBadRequest from json.

func (*SendEmailBadRequest) Encode added in v0.8.0 

func (s *SendEmailBadRequest) Encode(e *jx.Encoder)

Encode encodes SendEmailBadRequest as json.

func (*SendEmailBadRequest) MarshalJSON added in v0.8.0 

func (s *SendEmailBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendEmailBadRequest) UnmarshalJSON added in v0.8.0 

func (s *SendEmailBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendEmailBadRequest) Validate added in v0.8.0 

func (s *SendEmailBadRequest) Validate() error

type SendEmailForbidden added in v0.8.0 

type SendEmailForbidden ErrorResponse

func (*SendEmailForbidden) Decode added in v0.8.0 

func (s *SendEmailForbidden) Decode(d *jx.Decoder) error

Decode decodes SendEmailForbidden from json.

func (*SendEmailForbidden) Encode added in v0.8.0 

func (s *SendEmailForbidden) Encode(e *jx.Encoder)

Encode encodes SendEmailForbidden as json.

func (*SendEmailForbidden) MarshalJSON added in v0.8.0 

func (s *SendEmailForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendEmailForbidden) UnmarshalJSON added in v0.8.0 

func (s *SendEmailForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendEmailForbidden) Validate added in v0.8.0 

func (s *SendEmailForbidden) Validate() error

type SendEmailInternalServerError added in v0.8.0 

type SendEmailInternalServerError ErrorResponse

func (*SendEmailInternalServerError) Decode added in v0.8.0 

func (s *SendEmailInternalServerError) Decode(d *jx.Decoder) error

Decode decodes SendEmailInternalServerError from json.

func (*SendEmailInternalServerError) Encode added in v0.8.0 

func (s *SendEmailInternalServerError) Encode(e *jx.Encoder)

Encode encodes SendEmailInternalServerError as json.

func (*SendEmailInternalServerError) MarshalJSON added in v0.8.0 

func (s *SendEmailInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendEmailInternalServerError) UnmarshalJSON added in v0.8.0 

func (s *SendEmailInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendEmailInternalServerError) Validate added in v0.8.0 

func (s *SendEmailInternalServerError) Validate() error

type SendEmailOK added in v0.8.0 

type SendEmailOK struct {
	Success bool           `json:"success"`
	Data    SendMailResult `json:"data"`
}

Merged schema.

func (*SendEmailOK) Decode added in v0.8.0 

func (s *SendEmailOK) Decode(d *jx.Decoder) error

Decode decodes SendEmailOK from json.

func (*SendEmailOK) Encode added in v0.8.0 

func (s *SendEmailOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SendEmailOK) GetData added in v0.8.0 

func (s *SendEmailOK) GetData() SendMailResult

GetData returns the value of Data.

func (*SendEmailOK) GetSuccess added in v0.8.0 

func (s *SendEmailOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*SendEmailOK) MarshalJSON added in v0.8.0 

func (s *SendEmailOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendEmailOK) SetData added in v0.8.0 

func (s *SendEmailOK) SetData(val SendMailResult)

SetData sets the value of Data.

func (*SendEmailOK) SetSuccess added in v0.8.0 

func (s *SendEmailOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*SendEmailOK) UnmarshalJSON added in v0.8.0 

func (s *SendEmailOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendEmailOK) Validate added in v0.8.0 

func (s *SendEmailOK) Validate() error

type SendEmailParams added in v0.8.0 

type SendEmailParams struct {
	// Optional customer-supplied idempotency key. If omitted, Primitive
	// derives one from the canonical request payload and echoes the
	// effective value in the `Idempotency-Key` response header.
	IdempotencyKey OptString `json:",omitempty,omitzero"`
}

SendEmailParams is parameters of sendEmail operation.

type SendEmailRes added in v0.8.0 

type SendEmailRes interface {
	// contains filtered or unexported methods
}

type SendEmailServiceUnavailable added in v0.8.0 

type SendEmailServiceUnavailable ErrorResponse

func (*SendEmailServiceUnavailable) Decode added in v0.8.0 

func (s *SendEmailServiceUnavailable) Decode(d *jx.Decoder) error

Decode decodes SendEmailServiceUnavailable from json.

func (*SendEmailServiceUnavailable) Encode added in v0.8.0 

func (s *SendEmailServiceUnavailable) Encode(e *jx.Encoder)

Encode encodes SendEmailServiceUnavailable as json.

func (*SendEmailServiceUnavailable) MarshalJSON added in v0.8.0 

func (s *SendEmailServiceUnavailable) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendEmailServiceUnavailable) UnmarshalJSON added in v0.8.0 

func (s *SendEmailServiceUnavailable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendEmailServiceUnavailable) Validate added in v0.8.0 

func (s *SendEmailServiceUnavailable) Validate() error

type SendEmailUnauthorized added in v0.8.0 

type SendEmailUnauthorized ErrorResponse

func (*SendEmailUnauthorized) Decode added in v0.8.0 

func (s *SendEmailUnauthorized) Decode(d *jx.Decoder) error

Decode decodes SendEmailUnauthorized from json.

func (*SendEmailUnauthorized) Encode added in v0.8.0 

func (s *SendEmailUnauthorized) Encode(e *jx.Encoder)

Encode encodes SendEmailUnauthorized as json.

func (*SendEmailUnauthorized) MarshalJSON added in v0.8.0 

func (s *SendEmailUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendEmailUnauthorized) UnmarshalJSON added in v0.8.0 

func (s *SendEmailUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendEmailUnauthorized) Validate added in v0.8.0 

func (s *SendEmailUnauthorized) Validate() error

type SendMailAttachment added in v0.29.2 

type SendMailAttachment struct {
	// Attachment filename. Control characters are rejected.
	Filename string `json:"filename"`
	// Optional MIME content type. Control characters are rejected.
	ContentType OptString `json:"content_type"`
	// Base64-encoded attachment bytes.
	ContentBase64 string `json:"content_base64"`
}

Ref: #/components/schemas/SendMailAttachment

func (*SendMailAttachment) Decode added in v0.29.2 

func (s *SendMailAttachment) Decode(d *jx.Decoder) error

Decode decodes SendMailAttachment from json.

func (*SendMailAttachment) Encode added in v0.29.2 

func (s *SendMailAttachment) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SendMailAttachment) GetContentBase64 added in v0.29.2 

func (s *SendMailAttachment) GetContentBase64() string

GetContentBase64 returns the value of ContentBase64.

func (*SendMailAttachment) GetContentType added in v0.29.2 

func (s *SendMailAttachment) GetContentType() OptString

GetContentType returns the value of ContentType.

func (*SendMailAttachment) GetFilename added in v0.29.2 

func (s *SendMailAttachment) GetFilename() string

GetFilename returns the value of Filename.

func (*SendMailAttachment) MarshalJSON added in v0.29.2 

func (s *SendMailAttachment) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendMailAttachment) SetContentBase64 added in v0.29.2 

func (s *SendMailAttachment) SetContentBase64(val string)

SetContentBase64 sets the value of ContentBase64.

func (*SendMailAttachment) SetContentType added in v0.29.2 

func (s *SendMailAttachment) SetContentType(val OptString)

SetContentType sets the value of ContentType.

func (*SendMailAttachment) SetFilename added in v0.29.2 

func (s *SendMailAttachment) SetFilename(val string)

SetFilename sets the value of Filename.

func (*SendMailAttachment) UnmarshalJSON added in v0.29.2 

func (s *SendMailAttachment) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendMailAttachment) Validate added in v0.29.2 

func (s *SendMailAttachment) Validate() error

type SendMailInput added in v0.8.0 

type SendMailInput struct {
	// RFC 5322 From header. The sender domain must be a verified outbound domain for your organization.
	From string `json:"from"`
	// Recipient address. Recipient eligibility depends on your account's outbound entitlements.
	To string `json:"to"`
	// Subject line for the outbound message.
	Subject string `json:"subject"`
	// Plain-text message body. At least one of body_text or body_html is required. The combined UTF-8
	// byte length of body_text and body_html must be at most 262144 bytes.
	BodyText OptString `json:"body_text"`
	// HTML message body. At least one of body_text or body_html is required. The combined UTF-8 byte
	// length of body_text and body_html must be at most 262144 bytes.
	BodyHTML OptString `json:"body_html"`
	// Message-ID of the direct parent email when sending a threaded reply.
	InReplyTo OptString `json:"in_reply_to"`
	// Full ordered message-id chain for the thread.
	References []string `json:"references"`
	// Inline attachments. Send requests with attachments to https://api.primitive.dev/v1/send-mail.
	// Combined raw decoded attachment bytes must be at most 31457280.
	Attachments []SendMailAttachment `json:"attachments"`
	// When true, wait for the first downstream SMTP delivery outcome before returning.
	Wait OptBool `json:"wait"`
	// Maximum time to wait for a delivery outcome when wait is true. Defaults to 30000.
	WaitTimeoutMs OptInt `json:"wait_timeout_ms"`
}

Ref: #/components/schemas/SendMailInput

func (*SendMailInput) Decode added in v0.8.0 

func (s *SendMailInput) Decode(d *jx.Decoder) error

Decode decodes SendMailInput from json.

func (*SendMailInput) Encode added in v0.8.0 

func (s *SendMailInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SendMailInput) GetAttachments added in v0.29.2 

func (s *SendMailInput) GetAttachments() []SendMailAttachment

GetAttachments returns the value of Attachments.

func (*SendMailInput) GetBodyHTML added in v0.8.0 

func (s *SendMailInput) GetBodyHTML() OptString

GetBodyHTML returns the value of BodyHTML.

func (*SendMailInput) GetBodyText added in v0.8.0 

func (s *SendMailInput) GetBodyText() OptString

GetBodyText returns the value of BodyText.

func (*SendMailInput) GetFrom added in v0.8.0 

func (s *SendMailInput) GetFrom() string

GetFrom returns the value of From.

func (*SendMailInput) GetInReplyTo added in v0.8.0 

func (s *SendMailInput) GetInReplyTo() OptString

GetInReplyTo returns the value of InReplyTo.

func (*SendMailInput) GetReferences added in v0.8.0 

func (s *SendMailInput) GetReferences() []string

GetReferences returns the value of References.

func (*SendMailInput) GetSubject added in v0.8.0 

func (s *SendMailInput) GetSubject() string

GetSubject returns the value of Subject.

func (*SendMailInput) GetTo added in v0.8.0 

func (s *SendMailInput) GetTo() string

GetTo returns the value of To.

func (*SendMailInput) GetWait added in v0.8.0 

func (s *SendMailInput) GetWait() OptBool

GetWait returns the value of Wait.

func (*SendMailInput) GetWaitTimeoutMs added in v0.8.0 

func (s *SendMailInput) GetWaitTimeoutMs() OptInt

GetWaitTimeoutMs returns the value of WaitTimeoutMs.

func (*SendMailInput) MarshalJSON added in v0.8.0 

func (s *SendMailInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendMailInput) SetAttachments added in v0.29.2 

func (s *SendMailInput) SetAttachments(val []SendMailAttachment)

SetAttachments sets the value of Attachments.

func (*SendMailInput) SetBodyHTML added in v0.8.0 

func (s *SendMailInput) SetBodyHTML(val OptString)

SetBodyHTML sets the value of BodyHTML.

func (*SendMailInput) SetBodyText added in v0.8.0 

func (s *SendMailInput) SetBodyText(val OptString)

SetBodyText sets the value of BodyText.

func (*SendMailInput) SetFrom added in v0.8.0 

func (s *SendMailInput) SetFrom(val string)

SetFrom sets the value of From.

func (*SendMailInput) SetInReplyTo added in v0.8.0 

func (s *SendMailInput) SetInReplyTo(val OptString)

SetInReplyTo sets the value of InReplyTo.

func (*SendMailInput) SetReferences added in v0.8.0 

func (s *SendMailInput) SetReferences(val []string)

SetReferences sets the value of References.

func (*SendMailInput) SetSubject added in v0.8.0 

func (s *SendMailInput) SetSubject(val string)

SetSubject sets the value of Subject.

func (*SendMailInput) SetTo added in v0.8.0 

func (s *SendMailInput) SetTo(val string)

SetTo sets the value of To.

func (*SendMailInput) SetWait added in v0.8.0 

func (s *SendMailInput) SetWait(val OptBool)

SetWait sets the value of Wait.

func (*SendMailInput) SetWaitTimeoutMs added in v0.8.0 

func (s *SendMailInput) SetWaitTimeoutMs(val OptInt)

SetWaitTimeoutMs sets the value of WaitTimeoutMs.

func (*SendMailInput) UnmarshalJSON added in v0.8.0 

func (s *SendMailInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendMailInput) Validate added in v0.8.0 

func (s *SendMailInput) Validate() error

type SendMailResult added in v0.8.0 

type SendMailResult struct {
	// Persisted sent-email attempt ID.
	ID     string          `json:"id"`
	Status SentEmailStatus `json:"status"`
	// Bare from-address actually written on the wire. Echoed
	// on every success branch so callers can confirm what
	// went out, particularly useful for the /emails/{id}/reply
	// path where `from` is server-derived from the inbound's
	// recipient when the caller doesn't override.
	// For sends where the caller passed a from-header that
	// included a display name (e.g. `"Acme Support" <support@acme.test>`),
	// this field is the parsed bare address (`support@acme.test`).
	// The display name was sent on the wire intact; this field
	// just makes the address easy to compare against allowlists.
	From string `json:"from"`
	// Message identifier assigned by Primitive's OUTBOUND relay
	// (the box that signs your mail and submits it to the
	// receiving MTA). NOT the receiver's queue id.
	// The receiver may also report its own queue id in
	// `smtp_response_text` (e.g. `"250 2.0.0 Ok: queued as
	// 99D111927CDA"` from a Postfix receiver). Those two ids
	// refer to different mail systems and are NOT comparable.
	// Treat `queue_id` as Primitive-internal and the
	// receiver's id as remote-system-internal.
	// Null on rows that never reached the relay (queued,
	// gate_denied, agent_failed before signing).
	QueueID NilString `json:"queue_id"`
	// Recipient addresses accepted by the relay.
	Accepted []string `json:"accepted"`
	// Recipient addresses rejected by the relay.
	Rejected []string `json:"rejected"`
	// Effective idempotency key used for this send.
	ClientIdempotencyKey string `json:"client_idempotency_key"`
	// Server-issued request identifier for support and tracing.
	RequestID string `json:"request_id"`
	// Stable hash of the canonical send payload.
	ContentHash    string            `json:"content_hash"`
	DeliveryStatus OptDeliveryStatus `json:"delivery_status"`
	// SMTP response code from the first downstream delivery outcome when wait is true.
	SMTPResponseCode OptNilInt `json:"smtp_response_code"`
	// SMTP response text from the first downstream delivery outcome when wait is true.
	SMTPResponseText OptString `json:"smtp_response_text"`
	// True when the response replays a previously-recorded send
	// keyed by `client_idempotency_key` (same key, same canonical
	// payload). False on a fresh send and on gate-denied
	// responses. Lets callers branch on cache state without
	// diffing fields.
	IdempotentReplay bool `json:"idempotent_replay"`
}

Ref: #/components/schemas/SendMailResult

func (*SendMailResult) Decode added in v0.8.0 

func (s *SendMailResult) Decode(d *jx.Decoder) error

Decode decodes SendMailResult from json.

func (*SendMailResult) Encode added in v0.8.0 

func (s *SendMailResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SendMailResult) GetAccepted added in v0.8.0 

func (s *SendMailResult) GetAccepted() []string

GetAccepted returns the value of Accepted.

func (*SendMailResult) GetClientIdempotencyKey added in v0.8.0 

func (s *SendMailResult) GetClientIdempotencyKey() string

GetClientIdempotencyKey returns the value of ClientIdempotencyKey.

func (*SendMailResult) GetContentHash added in v0.8.0 

func (s *SendMailResult) GetContentHash() string

GetContentHash returns the value of ContentHash.

func (*SendMailResult) GetDeliveryStatus added in v0.8.0 

func (s *SendMailResult) GetDeliveryStatus() OptDeliveryStatus

GetDeliveryStatus returns the value of DeliveryStatus.

func (*SendMailResult) GetFrom added in v0.19.0 

func (s *SendMailResult) GetFrom() string

GetFrom returns the value of From.

func (*SendMailResult) GetID added in v0.8.0 

func (s *SendMailResult) GetID() string

GetID returns the value of ID.

func (*SendMailResult) GetIdempotentReplay added in v0.10.0 

func (s *SendMailResult) GetIdempotentReplay() bool

GetIdempotentReplay returns the value of IdempotentReplay.

func (*SendMailResult) GetQueueID added in v0.8.0 

func (s *SendMailResult) GetQueueID() NilString

GetQueueID returns the value of QueueID.

func (*SendMailResult) GetRejected added in v0.8.0 

func (s *SendMailResult) GetRejected() []string

GetRejected returns the value of Rejected.

func (*SendMailResult) GetRequestID added in v0.8.0 

func (s *SendMailResult) GetRequestID() string

GetRequestID returns the value of RequestID.

func (*SendMailResult) GetSMTPResponseCode added in v0.8.0 

func (s *SendMailResult) GetSMTPResponseCode() OptNilInt

GetSMTPResponseCode returns the value of SMTPResponseCode.

func (*SendMailResult) GetSMTPResponseText added in v0.8.0 

func (s *SendMailResult) GetSMTPResponseText() OptString

GetSMTPResponseText returns the value of SMTPResponseText.

func (*SendMailResult) GetStatus added in v0.8.0 

func (s *SendMailResult) GetStatus() SentEmailStatus

GetStatus returns the value of Status.

func (*SendMailResult) MarshalJSON added in v0.8.0 

func (s *SendMailResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendMailResult) SetAccepted added in v0.8.0 

func (s *SendMailResult) SetAccepted(val []string)

SetAccepted sets the value of Accepted.

func (*SendMailResult) SetClientIdempotencyKey added in v0.8.0 

func (s *SendMailResult) SetClientIdempotencyKey(val string)

SetClientIdempotencyKey sets the value of ClientIdempotencyKey.

func (*SendMailResult) SetContentHash added in v0.8.0 

func (s *SendMailResult) SetContentHash(val string)

SetContentHash sets the value of ContentHash.

func (*SendMailResult) SetDeliveryStatus added in v0.8.0 

func (s *SendMailResult) SetDeliveryStatus(val OptDeliveryStatus)

SetDeliveryStatus sets the value of DeliveryStatus.

func (*SendMailResult) SetFrom added in v0.19.0 

func (s *SendMailResult) SetFrom(val string)

SetFrom sets the value of From.

func (*SendMailResult) SetID added in v0.8.0 

func (s *SendMailResult) SetID(val string)

SetID sets the value of ID.

func (*SendMailResult) SetIdempotentReplay added in v0.10.0 

func (s *SendMailResult) SetIdempotentReplay(val bool)

SetIdempotentReplay sets the value of IdempotentReplay.

func (*SendMailResult) SetQueueID added in v0.8.0 

func (s *SendMailResult) SetQueueID(val NilString)

SetQueueID sets the value of QueueID.

func (*SendMailResult) SetRejected added in v0.8.0 

func (s *SendMailResult) SetRejected(val []string)

SetRejected sets the value of Rejected.

func (*SendMailResult) SetRequestID added in v0.8.0 

func (s *SendMailResult) SetRequestID(val string)

SetRequestID sets the value of RequestID.

func (*SendMailResult) SetSMTPResponseCode added in v0.8.0 

func (s *SendMailResult) SetSMTPResponseCode(val OptNilInt)

SetSMTPResponseCode sets the value of SMTPResponseCode.

func (*SendMailResult) SetSMTPResponseText added in v0.8.0 

func (s *SendMailResult) SetSMTPResponseText(val OptString)

SetSMTPResponseText sets the value of SMTPResponseText.

func (*SendMailResult) SetStatus added in v0.8.0 

func (s *SendMailResult) SetStatus(val SentEmailStatus)

SetStatus sets the value of Status.

func (*SendMailResult) UnmarshalJSON added in v0.8.0 

func (s *SendMailResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendMailResult) Validate added in v0.8.0 

func (s *SendMailResult) Validate() error

type SendPermissionAddress added in v0.19.0 

type SendPermissionAddress struct {
	Type SendPermissionAddressType `json:"type"`
	// The bare email address this rule grants sends to.
	Address string `json:"address"`
	// Most recent inbound email from this address that
	// authenticated successfully (DMARC pass + DKIM/SPF
	// alignment). Updated on each new authenticated receipt.
	LastReceivedAt time.Time `json:"last_received_at"`
	// Total number of authenticated inbound emails from this
	// address. Increments only when `last_received_at` advances.
	ReceivedCount int `json:"received_count"`
	// Human-prose summary of the rule.
	Description string `json:"description"`
}

The caller can send to a specific address that has authenticated inbound mail to the org. Emitted once per row in the org's `known_send_addresses` table, capped at `meta.address_cap`. Ref: #/components/schemas/SendPermissionAddress

func (*SendPermissionAddress) Decode added in v0.19.0 

func (s *SendPermissionAddress) Decode(d *jx.Decoder) error

Decode decodes SendPermissionAddress from json.

func (*SendPermissionAddress) Encode added in v0.19.0 

func (s *SendPermissionAddress) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SendPermissionAddress) GetAddress added in v0.19.0 

func (s *SendPermissionAddress) GetAddress() string

GetAddress returns the value of Address.

func (*SendPermissionAddress) GetDescription added in v0.19.0 

func (s *SendPermissionAddress) GetDescription() string

GetDescription returns the value of Description.

func (*SendPermissionAddress) GetLastReceivedAt added in v0.19.0 

func (s *SendPermissionAddress) GetLastReceivedAt() time.Time

GetLastReceivedAt returns the value of LastReceivedAt.

func (*SendPermissionAddress) GetReceivedCount added in v0.19.0 

func (s *SendPermissionAddress) GetReceivedCount() int

GetReceivedCount returns the value of ReceivedCount.

func (*SendPermissionAddress) GetType added in v0.19.0 

func (s *SendPermissionAddress) GetType() SendPermissionAddressType

GetType returns the value of Type.

func (*SendPermissionAddress) MarshalJSON added in v0.19.0 

func (s *SendPermissionAddress) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendPermissionAddress) SetAddress added in v0.19.0 

func (s *SendPermissionAddress) SetAddress(val string)

SetAddress sets the value of Address.

func (*SendPermissionAddress) SetDescription added in v0.19.0 

func (s *SendPermissionAddress) SetDescription(val string)

SetDescription sets the value of Description.

func (*SendPermissionAddress) SetLastReceivedAt added in v0.19.0 

func (s *SendPermissionAddress) SetLastReceivedAt(val time.Time)

SetLastReceivedAt sets the value of LastReceivedAt.

func (*SendPermissionAddress) SetReceivedCount added in v0.19.0 

func (s *SendPermissionAddress) SetReceivedCount(val int)

SetReceivedCount sets the value of ReceivedCount.

func (*SendPermissionAddress) SetType added in v0.19.0 

func (s *SendPermissionAddress) SetType(val SendPermissionAddressType)

SetType sets the value of Type.

func (*SendPermissionAddress) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionAddress) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendPermissionAddress) Validate added in v0.19.0 

func (s *SendPermissionAddress) Validate() error

type SendPermissionAddressType added in v0.19.0 

type SendPermissionAddressType string
const (
	SendPermissionAddressTypeAddress SendPermissionAddressType = "address"
)

func (SendPermissionAddressType) AllValues added in v0.19.0 

func (SendPermissionAddressType) AllValues() []SendPermissionAddressType

AllValues returns all SendPermissionAddressType values.

func (*SendPermissionAddressType) Decode added in v0.19.0 

func (s *SendPermissionAddressType) Decode(d *jx.Decoder) error

Decode decodes SendPermissionAddressType from json.

func (SendPermissionAddressType) Encode added in v0.19.0 

func (s SendPermissionAddressType) Encode(e *jx.Encoder)

Encode encodes SendPermissionAddressType as json.

func (SendPermissionAddressType) MarshalJSON added in v0.19.0 

func (s SendPermissionAddressType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SendPermissionAddressType) MarshalText added in v0.19.0 

func (s SendPermissionAddressType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SendPermissionAddressType) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionAddressType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendPermissionAddressType) UnmarshalText added in v0.19.0 

func (s *SendPermissionAddressType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SendPermissionAddressType) Validate added in v0.19.0 

func (s SendPermissionAddressType) Validate() error

type SendPermissionAnyRecipient added in v0.19.0 

type SendPermissionAnyRecipient struct {
	Type SendPermissionAnyRecipientType `json:"type"`
	// Human-prose summary of the rule.
	Description string `json:"description"`
}

The caller can send to any recipient. When this rule is present, every other rule in the response is redundant. Ref: #/components/schemas/SendPermissionAnyRecipient

func (*SendPermissionAnyRecipient) Decode added in v0.19.0 

func (s *SendPermissionAnyRecipient) Decode(d *jx.Decoder) error

Decode decodes SendPermissionAnyRecipient from json.

func (*SendPermissionAnyRecipient) Encode added in v0.19.0 

func (s *SendPermissionAnyRecipient) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SendPermissionAnyRecipient) GetDescription added in v0.19.0 

func (s *SendPermissionAnyRecipient) GetDescription() string

GetDescription returns the value of Description.

func (*SendPermissionAnyRecipient) GetType added in v0.19.0 

func (s *SendPermissionAnyRecipient) GetType() SendPermissionAnyRecipientType

GetType returns the value of Type.

func (*SendPermissionAnyRecipient) MarshalJSON added in v0.19.0 

func (s *SendPermissionAnyRecipient) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendPermissionAnyRecipient) SetDescription added in v0.19.0 

func (s *SendPermissionAnyRecipient) SetDescription(val string)

SetDescription sets the value of Description.

func (*SendPermissionAnyRecipient) SetType added in v0.19.0 

func (s *SendPermissionAnyRecipient) SetType(val SendPermissionAnyRecipientType)

SetType sets the value of Type.

func (*SendPermissionAnyRecipient) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionAnyRecipient) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendPermissionAnyRecipient) Validate added in v0.19.0 

func (s *SendPermissionAnyRecipient) Validate() error

type SendPermissionAnyRecipientType added in v0.19.0 

type SendPermissionAnyRecipientType string
const (
	SendPermissionAnyRecipientTypeAnyRecipient SendPermissionAnyRecipientType = "any_recipient"
)

func (SendPermissionAnyRecipientType) AllValues added in v0.19.0 

func (SendPermissionAnyRecipientType) AllValues() []SendPermissionAnyRecipientType

AllValues returns all SendPermissionAnyRecipientType values.

func (*SendPermissionAnyRecipientType) Decode added in v0.19.0 

func (s *SendPermissionAnyRecipientType) Decode(d *jx.Decoder) error

Decode decodes SendPermissionAnyRecipientType from json.

func (SendPermissionAnyRecipientType) Encode added in v0.19.0 

func (s SendPermissionAnyRecipientType) Encode(e *jx.Encoder)

Encode encodes SendPermissionAnyRecipientType as json.

func (SendPermissionAnyRecipientType) MarshalJSON added in v0.19.0 

func (s SendPermissionAnyRecipientType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SendPermissionAnyRecipientType) MarshalText added in v0.19.0 

func (s SendPermissionAnyRecipientType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SendPermissionAnyRecipientType) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionAnyRecipientType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendPermissionAnyRecipientType) UnmarshalText added in v0.19.0 

func (s *SendPermissionAnyRecipientType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SendPermissionAnyRecipientType) Validate added in v0.19.0 

func (s SendPermissionAnyRecipientType) Validate() error

type SendPermissionManagedZone added in v0.19.0 

type SendPermissionManagedZone struct {
	Type SendPermissionManagedZoneType `json:"type"`
	// The managed apex domain. Sends are accepted to any
	// address at the apex itself or any subdomain (e.g.
	// `alice@primitive.email` and `alice@acme.primitive.email`
	// both match the `primitive.email` zone rule).
	Zone string `json:"zone"`
	// Human-prose summary of the rule.
	Description string `json:"description"`
}

The caller can send to any address at the named Primitive-managed zone. Always emitted (no entitlement required) because Primitive owns the zone and every mailbox belongs to a Primitive customer by construction. Ref: #/components/schemas/SendPermissionManagedZone

func (*SendPermissionManagedZone) Decode added in v0.19.0 

func (s *SendPermissionManagedZone) Decode(d *jx.Decoder) error

Decode decodes SendPermissionManagedZone from json.

func (*SendPermissionManagedZone) Encode added in v0.19.0 

func (s *SendPermissionManagedZone) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SendPermissionManagedZone) GetDescription added in v0.19.0 

func (s *SendPermissionManagedZone) GetDescription() string

GetDescription returns the value of Description.

func (*SendPermissionManagedZone) GetType added in v0.19.0 

func (s *SendPermissionManagedZone) GetType() SendPermissionManagedZoneType

GetType returns the value of Type.

func (*SendPermissionManagedZone) GetZone added in v0.19.0 

func (s *SendPermissionManagedZone) GetZone() string

GetZone returns the value of Zone.

func (*SendPermissionManagedZone) MarshalJSON added in v0.19.0 

func (s *SendPermissionManagedZone) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendPermissionManagedZone) SetDescription added in v0.19.0 

func (s *SendPermissionManagedZone) SetDescription(val string)

SetDescription sets the value of Description.

func (*SendPermissionManagedZone) SetType added in v0.19.0 

func (s *SendPermissionManagedZone) SetType(val SendPermissionManagedZoneType)

SetType sets the value of Type.

func (*SendPermissionManagedZone) SetZone added in v0.19.0 

func (s *SendPermissionManagedZone) SetZone(val string)

SetZone sets the value of Zone.

func (*SendPermissionManagedZone) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionManagedZone) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendPermissionManagedZone) Validate added in v0.19.0 

func (s *SendPermissionManagedZone) Validate() error

type SendPermissionManagedZoneType added in v0.19.0 

type SendPermissionManagedZoneType string
const (
	SendPermissionManagedZoneTypeManagedZone SendPermissionManagedZoneType = "managed_zone"
)

func (SendPermissionManagedZoneType) AllValues added in v0.19.0 

func (SendPermissionManagedZoneType) AllValues() []SendPermissionManagedZoneType

AllValues returns all SendPermissionManagedZoneType values.

func (*SendPermissionManagedZoneType) Decode added in v0.19.0 

func (s *SendPermissionManagedZoneType) Decode(d *jx.Decoder) error

Decode decodes SendPermissionManagedZoneType from json.

func (SendPermissionManagedZoneType) Encode added in v0.19.0 

func (s SendPermissionManagedZoneType) Encode(e *jx.Encoder)

Encode encodes SendPermissionManagedZoneType as json.

func (SendPermissionManagedZoneType) MarshalJSON added in v0.19.0 

func (s SendPermissionManagedZoneType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SendPermissionManagedZoneType) MarshalText added in v0.19.0 

func (s SendPermissionManagedZoneType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SendPermissionManagedZoneType) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionManagedZoneType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendPermissionManagedZoneType) UnmarshalText added in v0.19.0 

func (s *SendPermissionManagedZoneType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SendPermissionManagedZoneType) Validate added in v0.19.0 

func (s SendPermissionManagedZoneType) Validate() error

type SendPermissionRule added in v0.19.0 

type SendPermissionRule struct {
	Type                       SendPermissionRuleType // switch on this field
	SendPermissionAnyRecipient SendPermissionAnyRecipient
	SendPermissionManagedZone  SendPermissionManagedZone
	SendPermissionYourDomain   SendPermissionYourDomain
	SendPermissionAddress      SendPermissionAddress
}

One recipient-scope rule describing a destination the caller may send to. Discriminated on `type`. Each rule carries a human-prose `description` field intended for display. Rule kinds are stable within an SDK release. A response containing a `type` value not enumerated in this schema means the server is running a newer version than the SDK; upgrade the SDK to the release that matches the server's schema. Strict-parsing SDKs (Go, Python) will raise a decode error in that case rather than silently dropping the unknown rule, since silent drops would let an outbound agent reason from an incomplete view of its own permissions. Ref: #/components/schemas/SendPermissionRule SendPermissionRule represents sum type.

func NewSendPermissionAddressSendPermissionRule added in v0.19.0 

func NewSendPermissionAddressSendPermissionRule(v SendPermissionAddress) SendPermissionRule

NewSendPermissionAddressSendPermissionRule returns new SendPermissionRule from SendPermissionAddress.

func NewSendPermissionAnyRecipientSendPermissionRule added in v0.19.0 

func NewSendPermissionAnyRecipientSendPermissionRule(v SendPermissionAnyRecipient) SendPermissionRule

NewSendPermissionAnyRecipientSendPermissionRule returns new SendPermissionRule from SendPermissionAnyRecipient.

func NewSendPermissionManagedZoneSendPermissionRule added in v0.19.0 

func NewSendPermissionManagedZoneSendPermissionRule(v SendPermissionManagedZone) SendPermissionRule

NewSendPermissionManagedZoneSendPermissionRule returns new SendPermissionRule from SendPermissionManagedZone.

func NewSendPermissionYourDomainSendPermissionRule added in v0.19.0 

func NewSendPermissionYourDomainSendPermissionRule(v SendPermissionYourDomain) SendPermissionRule

NewSendPermissionYourDomainSendPermissionRule returns new SendPermissionRule from SendPermissionYourDomain.

func (*SendPermissionRule) Decode added in v0.19.0 

func (s *SendPermissionRule) Decode(d *jx.Decoder) error

Decode decodes SendPermissionRule from json.

func (SendPermissionRule) Encode added in v0.19.0 

func (s SendPermissionRule) Encode(e *jx.Encoder)

Encode encodes SendPermissionRule as json.

func (SendPermissionRule) GetSendPermissionAddress added in v0.19.0 

func (s SendPermissionRule) GetSendPermissionAddress() (v SendPermissionAddress, ok bool)

GetSendPermissionAddress returns SendPermissionAddress and true boolean if SendPermissionRule is SendPermissionAddress.

func (SendPermissionRule) GetSendPermissionAnyRecipient added in v0.19.0 

func (s SendPermissionRule) GetSendPermissionAnyRecipient() (v SendPermissionAnyRecipient, ok bool)

GetSendPermissionAnyRecipient returns SendPermissionAnyRecipient and true boolean if SendPermissionRule is SendPermissionAnyRecipient.

func (SendPermissionRule) GetSendPermissionManagedZone added in v0.19.0 

func (s SendPermissionRule) GetSendPermissionManagedZone() (v SendPermissionManagedZone, ok bool)

GetSendPermissionManagedZone returns SendPermissionManagedZone and true boolean if SendPermissionRule is SendPermissionManagedZone.

func (SendPermissionRule) GetSendPermissionYourDomain added in v0.19.0 

func (s SendPermissionRule) GetSendPermissionYourDomain() (v SendPermissionYourDomain, ok bool)

GetSendPermissionYourDomain returns SendPermissionYourDomain and true boolean if SendPermissionRule is SendPermissionYourDomain.

func (SendPermissionRule) IsSendPermissionAddress added in v0.19.0 

func (s SendPermissionRule) IsSendPermissionAddress() bool

IsSendPermissionAddress reports whether SendPermissionRule is SendPermissionAddress.

func (SendPermissionRule) IsSendPermissionAnyRecipient added in v0.19.0 

func (s SendPermissionRule) IsSendPermissionAnyRecipient() bool

IsSendPermissionAnyRecipient reports whether SendPermissionRule is SendPermissionAnyRecipient.

func (SendPermissionRule) IsSendPermissionManagedZone added in v0.19.0 

func (s SendPermissionRule) IsSendPermissionManagedZone() bool

IsSendPermissionManagedZone reports whether SendPermissionRule is SendPermissionManagedZone.

func (SendPermissionRule) IsSendPermissionYourDomain added in v0.19.0 

func (s SendPermissionRule) IsSendPermissionYourDomain() bool

IsSendPermissionYourDomain reports whether SendPermissionRule is SendPermissionYourDomain.

func (SendPermissionRule) MarshalJSON added in v0.19.0 

func (s SendPermissionRule) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendPermissionRule) SetSendPermissionAddress added in v0.19.0 

func (s *SendPermissionRule) SetSendPermissionAddress(v SendPermissionAddress)

SetSendPermissionAddress sets SendPermissionRule to SendPermissionAddress.

func (*SendPermissionRule) SetSendPermissionAnyRecipient added in v0.19.0 

func (s *SendPermissionRule) SetSendPermissionAnyRecipient(v SendPermissionAnyRecipient)

SetSendPermissionAnyRecipient sets SendPermissionRule to SendPermissionAnyRecipient.

func (*SendPermissionRule) SetSendPermissionManagedZone added in v0.19.0 

func (s *SendPermissionRule) SetSendPermissionManagedZone(v SendPermissionManagedZone)

SetSendPermissionManagedZone sets SendPermissionRule to SendPermissionManagedZone.

func (*SendPermissionRule) SetSendPermissionYourDomain added in v0.19.0 

func (s *SendPermissionRule) SetSendPermissionYourDomain(v SendPermissionYourDomain)

SetSendPermissionYourDomain sets SendPermissionRule to SendPermissionYourDomain.

func (*SendPermissionRule) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionRule) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SendPermissionRule) Validate added in v0.19.0 

func (s SendPermissionRule) Validate() error

type SendPermissionRuleType added in v0.19.0 

type SendPermissionRuleType string

SendPermissionRuleType is oneOf type of SendPermissionRule. 

const (
	SendPermissionAnyRecipientSendPermissionRule SendPermissionRuleType = "any_recipient"
	SendPermissionManagedZoneSendPermissionRule  SendPermissionRuleType = "managed_zone"
	SendPermissionYourDomainSendPermissionRule   SendPermissionRuleType = "your_domain"
	SendPermissionAddressSendPermissionRule      SendPermissionRuleType = "address"
)

Possible values for SendPermissionRuleType.

type SendPermissionYourDomain added in v0.19.0 

type SendPermissionYourDomain struct {
	Type SendPermissionYourDomainType `json:"type"`
	// A verified outbound domain owned by the caller's org.
	Domain string `json:"domain"`
	// Human-prose summary of the rule.
	Description string `json:"description"`
}

The caller can send to any address at one of their own verified outbound domains. Emitted once per active row in the org's `domains` table. Ref: #/components/schemas/SendPermissionYourDomain

func (*SendPermissionYourDomain) Decode added in v0.19.0 

func (s *SendPermissionYourDomain) Decode(d *jx.Decoder) error

Decode decodes SendPermissionYourDomain from json.

func (*SendPermissionYourDomain) Encode added in v0.19.0 

func (s *SendPermissionYourDomain) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SendPermissionYourDomain) GetDescription added in v0.19.0 

func (s *SendPermissionYourDomain) GetDescription() string

GetDescription returns the value of Description.

func (*SendPermissionYourDomain) GetDomain added in v0.19.0 

func (s *SendPermissionYourDomain) GetDomain() string

GetDomain returns the value of Domain.

func (*SendPermissionYourDomain) GetType added in v0.19.0 

func (s *SendPermissionYourDomain) GetType() SendPermissionYourDomainType

GetType returns the value of Type.

func (*SendPermissionYourDomain) MarshalJSON added in v0.19.0 

func (s *SendPermissionYourDomain) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendPermissionYourDomain) SetDescription added in v0.19.0 

func (s *SendPermissionYourDomain) SetDescription(val string)

SetDescription sets the value of Description.

func (*SendPermissionYourDomain) SetDomain added in v0.19.0 

func (s *SendPermissionYourDomain) SetDomain(val string)

SetDomain sets the value of Domain.

func (*SendPermissionYourDomain) SetType added in v0.19.0 

func (s *SendPermissionYourDomain) SetType(val SendPermissionYourDomainType)

SetType sets the value of Type.

func (*SendPermissionYourDomain) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionYourDomain) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendPermissionYourDomain) Validate added in v0.19.0 

func (s *SendPermissionYourDomain) Validate() error

type SendPermissionYourDomainType added in v0.19.0 

type SendPermissionYourDomainType string
const (
	SendPermissionYourDomainTypeYourDomain SendPermissionYourDomainType = "your_domain"
)

func (SendPermissionYourDomainType) AllValues added in v0.19.0 

func (SendPermissionYourDomainType) AllValues() []SendPermissionYourDomainType

AllValues returns all SendPermissionYourDomainType values.

func (*SendPermissionYourDomainType) Decode added in v0.19.0 

func (s *SendPermissionYourDomainType) Decode(d *jx.Decoder) error

Decode decodes SendPermissionYourDomainType from json.

func (SendPermissionYourDomainType) Encode added in v0.19.0 

func (s SendPermissionYourDomainType) Encode(e *jx.Encoder)

Encode encodes SendPermissionYourDomainType as json.

func (SendPermissionYourDomainType) MarshalJSON added in v0.19.0 

func (s SendPermissionYourDomainType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SendPermissionYourDomainType) MarshalText added in v0.19.0 

func (s SendPermissionYourDomainType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SendPermissionYourDomainType) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionYourDomainType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SendPermissionYourDomainType) UnmarshalText added in v0.19.0 

func (s *SendPermissionYourDomainType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SendPermissionYourDomainType) Validate added in v0.19.0 

func (s SendPermissionYourDomainType) Validate() error

type SendPermissionsMeta added in v0.19.0 

type SendPermissionsMeta struct {
	// Maximum number of `address` rules included in `data`.
	AddressCap int `json:"address_cap"`
	// True when the org has more than `address_cap` known
	// addresses and the list was truncated. False when every
	// known address is represented or when the org holds no
	// address rules at all.
	Truncated bool `json:"truncated"`
}

Response metadata for /send-permissions. The `address_cap` bounds the size of the `address` rule subset; orgs with more than `address_cap` known addresses almost always also hold a broader rule type (`any_recipient` or `your_domain`), so the cap is a response-size bound rather than a meaningful product limit. Ref: #/components/schemas/SendPermissionsMeta

func (*SendPermissionsMeta) Decode added in v0.19.0 

func (s *SendPermissionsMeta) Decode(d *jx.Decoder) error

Decode decodes SendPermissionsMeta from json.

func (*SendPermissionsMeta) Encode added in v0.19.0 

func (s *SendPermissionsMeta) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SendPermissionsMeta) GetAddressCap added in v0.19.0 

func (s *SendPermissionsMeta) GetAddressCap() int

GetAddressCap returns the value of AddressCap.

func (*SendPermissionsMeta) GetTruncated added in v0.19.0 

func (s *SendPermissionsMeta) GetTruncated() bool

GetTruncated returns the value of Truncated.

func (*SendPermissionsMeta) MarshalJSON added in v0.19.0 

func (s *SendPermissionsMeta) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SendPermissionsMeta) SetAddressCap added in v0.19.0 

func (s *SendPermissionsMeta) SetAddressCap(val int)

SetAddressCap sets the value of AddressCap.

func (*SendPermissionsMeta) SetTruncated added in v0.19.0 

func (s *SendPermissionsMeta) SetTruncated(val bool)

SetTruncated sets the value of Truncated.

func (*SendPermissionsMeta) UnmarshalJSON added in v0.19.0 

func (s *SendPermissionsMeta) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SentEmailDetail added in v0.19.0 

type SentEmailDetail struct {
	ID     uuid.UUID       `json:"id"`
	Status SentEmailStatus `json:"status"`
	// Timestamp of the most recent status transition.
	// Polling clients should treat `status='queued'` AND
	// `status_changed_at` older than 5 minutes as
	// "stuck-queued" (the post-tx UPDATE failed and the
	// actual delivery state is recoverable from on-box logs
	// via `queue_id` when populated, or `request_id`).
	StatusChangedAt time.Time `json:"status_changed_at"`
	CreatedAt       time.Time `json:"created_at"`
	UpdatedAt       time.Time `json:"updated_at"`
	// Effective idempotency key used for this send. If the
	// caller passed the `Idempotency-Key` header, this is
	// that value; otherwise it's a server-derived hash of
	// the canonical request payload.
	ClientIdempotencyKey OptNilString `json:"client_idempotency_key"`
	// Stable hash of the canonical send payload.
	ContentHash string `json:"content_hash"`
	// Raw `From:` header as sent on the wire, including any
	// display name (e.g. `"Acme Support" <agent@acme.test>`).
	FromHeader string `json:"from_header"`
	// Bare email address parsed from `from_header`.
	FromAddress string `json:"from_address"`
	// Raw `To:` header as sent on the wire, including any
	// display name.
	ToHeader string `json:"to_header"`
	// Bare email address parsed from `to_header`.
	ToAddress string `json:"to_address"`
	Subject   string `json:"subject"`
	// Total UTF-8 byte length of `body_text` + `body_html`.
	// Surfaced on the list endpoint so callers can see "this
	// row has a 4MB body" without fetching it.
	BodySizeBytes int `json:"body_size_bytes"`
	// Timestamp at which the bodies were discarded by an
	// entitlement-driven retention policy. Null when bodies
	// are still present. The detail endpoint returns
	// null-valued `body_text`/`body_html` for discarded rows.
	ContentDiscardedAt OptNilDateTime `json:"content_discarded_at"`
	// Wire-level Message-ID assigned to the outbound message
	// (RFC 5322). Null on rows that never reached signing
	// (queued, gate_denied, agent_failed before signing).
	MessageID OptNilString `json:"message_id"`
	// Wire-level In-Reply-To header value, when this send
	// was a reply.
	InReplyTo OptNilString `json:"in_reply_to"`
	// Wire-level References header value, when this send
	// was a reply.
	EmailReferences OptNilString `json:"email_references"`
	// Reference to the inbound `emails.id` that this send
	// replied to, when known. Populated when the caller used
	// /emails/{id}/reply or when /send-mail's `in_reply_to`
	// matched a stored inbound message_id in the same org.
	InReplyToEmailID OptNilUUID `json:"in_reply_to_email_id"`
	// Message identifier assigned by Primitive's outbound
	// relay once the agent accepts the message. Null on
	// queued, gate_denied, and agent_failed rows.
	QueueID OptNilString `json:"queue_id"`
	// Receiver's 3-digit SMTP code (e.g. 250, 550, 451).
	// Populated on terminal delivery statuses; may be null
	// on a deferred where the agent never got an SMTP-level
	// response (TCP refused, DNS failed, TLS handshake
	// failed). `smtp_response_text` still carries Postfix's
	// descriptive text in those cases.
	SMTPResponseCode OptNilInt `json:"smtp_response_code"`
	// Free-form text portion of the receiver's SMTP
	// response. The most useful debugging signal on a
	// `bounced` or `deferred` row.
	SMTPResponseText OptNilString `json:"smtp_response_text"`
	// RFC 3463 enhanced status code (e.g. `5.1.1` for "Bad
	// destination mailbox address"). Distinct from
	// `smtp_response_code`: the basic 3-digit code is coarse
	// (550 = "permanent failure"), the enhanced code is
	// finer-grained.
	SMTPEnhancedStatusCode OptNilString `json:"smtp_enhanced_status_code"`
	// DKIM selector used to sign the outbound message.
	// Public DNS data; useful for diagnosing why a downstream
	// verifier rejected the signature.
	DkimSelector OptNilString `json:"dkim_selector"`
	// DKIM signing domain.
	DkimDomain OptNilString `json:"dkim_domain"`
	// Stable public error code on `agent_failed` rows. The
	// agent's internal codes are remapped to a stable public
	// taxonomy (see `publicAgentError` in the server) so this
	// field is safe to branch on across agent versions.
	ErrorCode OptNilString `json:"error_code"`
	// Free-form error message accompanying `error_code`.
	ErrorMessage OptNilString `json:"error_message"`
	// Gate-denial detail on `gate_denied` rows. Mirrors the
	// synchronous /send-mail 403 contract so a caller's
	// GateDenial handler is the same across live denies and
	// historical lookups. Null on every other status.
	Gates OptNilGateDenialArray `json:"gates"`
	// Server-issued request identifier from the original
	// /send-mail call. Surfaced as the `X-Request-Id`
	// response header on the live send and recorded here
	// for support escalation.
	RequestID OptNilString `json:"request_id"`
	// Plain-text body sent on the wire. Null when the
	// send carried only an HTML body, or when bodies have
	// been discarded post-send (`content_discarded_at`
	// set).
	BodyText OptNilString `json:"body_text"`
	// HTML body sent on the wire. Null when the send
	// carried only a plain-text body, or when bodies
	// have been discarded post-send.
	BodyHTML OptNilString `json:"body_html"`
}

Merged schema. Ref: #/components/schemas/SentEmailDetail

func (*SentEmailDetail) Decode added in v0.19.0 

func (s *SentEmailDetail) Decode(d *jx.Decoder) error

Decode decodes SentEmailDetail from json.

func (*SentEmailDetail) Encode added in v0.19.0 

func (s *SentEmailDetail) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SentEmailDetail) GetBodyHTML added in v0.19.0 

func (s *SentEmailDetail) GetBodyHTML() OptNilString

GetBodyHTML returns the value of BodyHTML.

func (*SentEmailDetail) GetBodySizeBytes added in v0.19.0 

func (s *SentEmailDetail) GetBodySizeBytes() int

GetBodySizeBytes returns the value of BodySizeBytes.

func (*SentEmailDetail) GetBodyText added in v0.19.0 

func (s *SentEmailDetail) GetBodyText() OptNilString

GetBodyText returns the value of BodyText.

func (*SentEmailDetail) GetClientIdempotencyKey added in v0.19.0 

func (s *SentEmailDetail) GetClientIdempotencyKey() OptNilString

GetClientIdempotencyKey returns the value of ClientIdempotencyKey.

func (*SentEmailDetail) GetContentDiscardedAt added in v0.19.0 

func (s *SentEmailDetail) GetContentDiscardedAt() OptNilDateTime

GetContentDiscardedAt returns the value of ContentDiscardedAt.

func (*SentEmailDetail) GetContentHash added in v0.19.0 

func (s *SentEmailDetail) GetContentHash() string

GetContentHash returns the value of ContentHash.

func (*SentEmailDetail) GetCreatedAt added in v0.19.0 

func (s *SentEmailDetail) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*SentEmailDetail) GetDkimDomain added in v0.19.0 

func (s *SentEmailDetail) GetDkimDomain() OptNilString

GetDkimDomain returns the value of DkimDomain.

func (*SentEmailDetail) GetDkimSelector added in v0.19.0 

func (s *SentEmailDetail) GetDkimSelector() OptNilString

GetDkimSelector returns the value of DkimSelector.

func (*SentEmailDetail) GetEmailReferences added in v0.19.0 

func (s *SentEmailDetail) GetEmailReferences() OptNilString

GetEmailReferences returns the value of EmailReferences.

func (*SentEmailDetail) GetErrorCode added in v0.19.0 

func (s *SentEmailDetail) GetErrorCode() OptNilString

GetErrorCode returns the value of ErrorCode.

func (*SentEmailDetail) GetErrorMessage added in v0.19.0 

func (s *SentEmailDetail) GetErrorMessage() OptNilString

GetErrorMessage returns the value of ErrorMessage.

func (*SentEmailDetail) GetFromAddress added in v0.19.0 

func (s *SentEmailDetail) GetFromAddress() string

GetFromAddress returns the value of FromAddress.

func (*SentEmailDetail) GetFromHeader added in v0.19.0 

func (s *SentEmailDetail) GetFromHeader() string

GetFromHeader returns the value of FromHeader.

func (*SentEmailDetail) GetGates added in v0.19.0 

func (s *SentEmailDetail) GetGates() OptNilGateDenialArray

GetGates returns the value of Gates.

func (*SentEmailDetail) GetID added in v0.19.0 

func (s *SentEmailDetail) GetID() uuid.UUID

GetID returns the value of ID.

func (*SentEmailDetail) GetInReplyTo added in v0.19.0 

func (s *SentEmailDetail) GetInReplyTo() OptNilString

GetInReplyTo returns the value of InReplyTo.

func (*SentEmailDetail) GetInReplyToEmailID added in v0.19.0 

func (s *SentEmailDetail) GetInReplyToEmailID() OptNilUUID

GetInReplyToEmailID returns the value of InReplyToEmailID.

func (*SentEmailDetail) GetMessageID added in v0.19.0 

func (s *SentEmailDetail) GetMessageID() OptNilString

GetMessageID returns the value of MessageID.

func (*SentEmailDetail) GetQueueID added in v0.19.0 

func (s *SentEmailDetail) GetQueueID() OptNilString

GetQueueID returns the value of QueueID.

func (*SentEmailDetail) GetRequestID added in v0.19.0 

func (s *SentEmailDetail) GetRequestID() OptNilString

GetRequestID returns the value of RequestID.

func (*SentEmailDetail) GetSMTPEnhancedStatusCode added in v0.19.0 

func (s *SentEmailDetail) GetSMTPEnhancedStatusCode() OptNilString

GetSMTPEnhancedStatusCode returns the value of SMTPEnhancedStatusCode.

func (*SentEmailDetail) GetSMTPResponseCode added in v0.19.0 

func (s *SentEmailDetail) GetSMTPResponseCode() OptNilInt

GetSMTPResponseCode returns the value of SMTPResponseCode.

func (*SentEmailDetail) GetSMTPResponseText added in v0.19.0 

func (s *SentEmailDetail) GetSMTPResponseText() OptNilString

GetSMTPResponseText returns the value of SMTPResponseText.

func (*SentEmailDetail) GetStatus added in v0.19.0 

func (s *SentEmailDetail) GetStatus() SentEmailStatus

GetStatus returns the value of Status.

func (*SentEmailDetail) GetStatusChangedAt added in v0.19.0 

func (s *SentEmailDetail) GetStatusChangedAt() time.Time

GetStatusChangedAt returns the value of StatusChangedAt.

func (*SentEmailDetail) GetSubject added in v0.19.0 

func (s *SentEmailDetail) GetSubject() string

GetSubject returns the value of Subject.

func (*SentEmailDetail) GetToAddress added in v0.19.0 

func (s *SentEmailDetail) GetToAddress() string

GetToAddress returns the value of ToAddress.

func (*SentEmailDetail) GetToHeader added in v0.19.0 

func (s *SentEmailDetail) GetToHeader() string

GetToHeader returns the value of ToHeader.

func (*SentEmailDetail) GetUpdatedAt added in v0.19.0 

func (s *SentEmailDetail) GetUpdatedAt() time.Time

GetUpdatedAt returns the value of UpdatedAt.

func (*SentEmailDetail) MarshalJSON added in v0.19.0 

func (s *SentEmailDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SentEmailDetail) SetBodyHTML added in v0.19.0 

func (s *SentEmailDetail) SetBodyHTML(val OptNilString)

SetBodyHTML sets the value of BodyHTML.

func (*SentEmailDetail) SetBodySizeBytes added in v0.19.0 

func (s *SentEmailDetail) SetBodySizeBytes(val int)

SetBodySizeBytes sets the value of BodySizeBytes.

func (*SentEmailDetail) SetBodyText added in v0.19.0 

func (s *SentEmailDetail) SetBodyText(val OptNilString)

SetBodyText sets the value of BodyText.

func (*SentEmailDetail) SetClientIdempotencyKey added in v0.19.0 

func (s *SentEmailDetail) SetClientIdempotencyKey(val OptNilString)

SetClientIdempotencyKey sets the value of ClientIdempotencyKey.

func (*SentEmailDetail) SetContentDiscardedAt added in v0.19.0 

func (s *SentEmailDetail) SetContentDiscardedAt(val OptNilDateTime)

SetContentDiscardedAt sets the value of ContentDiscardedAt.

func (*SentEmailDetail) SetContentHash added in v0.19.0 

func (s *SentEmailDetail) SetContentHash(val string)

SetContentHash sets the value of ContentHash.

func (*SentEmailDetail) SetCreatedAt added in v0.19.0 

func (s *SentEmailDetail) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*SentEmailDetail) SetDkimDomain added in v0.19.0 

func (s *SentEmailDetail) SetDkimDomain(val OptNilString)

SetDkimDomain sets the value of DkimDomain.

func (*SentEmailDetail) SetDkimSelector added in v0.19.0 

func (s *SentEmailDetail) SetDkimSelector(val OptNilString)

SetDkimSelector sets the value of DkimSelector.

func (*SentEmailDetail) SetEmailReferences added in v0.19.0 

func (s *SentEmailDetail) SetEmailReferences(val OptNilString)

SetEmailReferences sets the value of EmailReferences.

func (*SentEmailDetail) SetErrorCode added in v0.19.0 

func (s *SentEmailDetail) SetErrorCode(val OptNilString)

SetErrorCode sets the value of ErrorCode.

func (*SentEmailDetail) SetErrorMessage added in v0.19.0 

func (s *SentEmailDetail) SetErrorMessage(val OptNilString)

SetErrorMessage sets the value of ErrorMessage.

func (*SentEmailDetail) SetFromAddress added in v0.19.0 

func (s *SentEmailDetail) SetFromAddress(val string)

SetFromAddress sets the value of FromAddress.

func (*SentEmailDetail) SetFromHeader added in v0.19.0 

func (s *SentEmailDetail) SetFromHeader(val string)

SetFromHeader sets the value of FromHeader.

func (*SentEmailDetail) SetGates added in v0.19.0 

func (s *SentEmailDetail) SetGates(val OptNilGateDenialArray)

SetGates sets the value of Gates.

func (*SentEmailDetail) SetID added in v0.19.0 

func (s *SentEmailDetail) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*SentEmailDetail) SetInReplyTo added in v0.19.0 

func (s *SentEmailDetail) SetInReplyTo(val OptNilString)

SetInReplyTo sets the value of InReplyTo.

func (*SentEmailDetail) SetInReplyToEmailID added in v0.19.0 

func (s *SentEmailDetail) SetInReplyToEmailID(val OptNilUUID)

SetInReplyToEmailID sets the value of InReplyToEmailID.

func (*SentEmailDetail) SetMessageID added in v0.19.0 

func (s *SentEmailDetail) SetMessageID(val OptNilString)

SetMessageID sets the value of MessageID.

func (*SentEmailDetail) SetQueueID added in v0.19.0 

func (s *SentEmailDetail) SetQueueID(val OptNilString)

SetQueueID sets the value of QueueID.

func (*SentEmailDetail) SetRequestID added in v0.19.0 

func (s *SentEmailDetail) SetRequestID(val OptNilString)

SetRequestID sets the value of RequestID.

func (*SentEmailDetail) SetSMTPEnhancedStatusCode added in v0.19.0 

func (s *SentEmailDetail) SetSMTPEnhancedStatusCode(val OptNilString)

SetSMTPEnhancedStatusCode sets the value of SMTPEnhancedStatusCode.

func (*SentEmailDetail) SetSMTPResponseCode added in v0.19.0 

func (s *SentEmailDetail) SetSMTPResponseCode(val OptNilInt)

SetSMTPResponseCode sets the value of SMTPResponseCode.

func (*SentEmailDetail) SetSMTPResponseText added in v0.19.0 

func (s *SentEmailDetail) SetSMTPResponseText(val OptNilString)

SetSMTPResponseText sets the value of SMTPResponseText.

func (*SentEmailDetail) SetStatus added in v0.19.0 

func (s *SentEmailDetail) SetStatus(val SentEmailStatus)

SetStatus sets the value of Status.

func (*SentEmailDetail) SetStatusChangedAt added in v0.19.0 

func (s *SentEmailDetail) SetStatusChangedAt(val time.Time)

SetStatusChangedAt sets the value of StatusChangedAt.

func (*SentEmailDetail) SetSubject added in v0.19.0 

func (s *SentEmailDetail) SetSubject(val string)

SetSubject sets the value of Subject.

func (*SentEmailDetail) SetToAddress added in v0.19.0 

func (s *SentEmailDetail) SetToAddress(val string)

SetToAddress sets the value of ToAddress.

func (*SentEmailDetail) SetToHeader added in v0.19.0 

func (s *SentEmailDetail) SetToHeader(val string)

SetToHeader sets the value of ToHeader.

func (*SentEmailDetail) SetUpdatedAt added in v0.19.0 

func (s *SentEmailDetail) SetUpdatedAt(val time.Time)

SetUpdatedAt sets the value of UpdatedAt.

func (*SentEmailDetail) UnmarshalJSON added in v0.19.0 

func (s *SentEmailDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SentEmailDetail) Validate added in v0.19.0 

func (s *SentEmailDetail) Validate() error

type SentEmailStatus added in v0.8.0 

type SentEmailStatus string

Lifecycle status of a sent_emails row. Possible values: - `queued`: pre-call INSERT; the outbound agent has not yet replied. - `submitted_to_agent`: agent accepted; `queue_id` is set. - `agent_failed`: agent rejected; `error_code` and `error_message` carry the reason. - `gate_denied`: a recipient-scope gate denied the send; the agent was never called. The `gates` array carries the denial detail. /send-mail returns 403 in this case so callers see the denial synchronously; /sent-emails additionally records the row for historical lookup, which is when this status appears in a listing. - `unknown`: terminal indeterminate; the on-box log poller couldn't classify the receiver's response. - `delivered` / `bounced` / `deferred` / `wait_timeout`: terminal delivery outcomes (see DeliveryStatus). Ref: #/components/schemas/SentEmailStatus 

const (
	SentEmailStatusQueued           SentEmailStatus = "queued"
	SentEmailStatusSubmittedToAgent SentEmailStatus = "submitted_to_agent"
	SentEmailStatusAgentFailed      SentEmailStatus = "agent_failed"
	SentEmailStatusGateDenied       SentEmailStatus = "gate_denied"
	SentEmailStatusUnknown          SentEmailStatus = "unknown"
	SentEmailStatusDelivered        SentEmailStatus = "delivered"
	SentEmailStatusBounced          SentEmailStatus = "bounced"
	SentEmailStatusDeferred         SentEmailStatus = "deferred"
	SentEmailStatusWaitTimeout      SentEmailStatus = "wait_timeout"
)

func (SentEmailStatus) AllValues added in v0.8.0 

func (SentEmailStatus) AllValues() []SentEmailStatus

AllValues returns all SentEmailStatus values.

func (*SentEmailStatus) Decode added in v0.8.0 

func (s *SentEmailStatus) Decode(d *jx.Decoder) error

Decode decodes SentEmailStatus from json.

func (SentEmailStatus) Encode added in v0.8.0 

func (s SentEmailStatus) Encode(e *jx.Encoder)

Encode encodes SentEmailStatus as json.

func (SentEmailStatus) MarshalJSON added in v0.8.0 

func (s SentEmailStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SentEmailStatus) MarshalText added in v0.8.0 

func (s SentEmailStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SentEmailStatus) UnmarshalJSON added in v0.8.0 

func (s *SentEmailStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SentEmailStatus) UnmarshalText added in v0.8.0 

func (s *SentEmailStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SentEmailStatus) Validate added in v0.8.0 

func (s SentEmailStatus) Validate() error

type SentEmailSummary added in v0.19.0 

type SentEmailSummary struct {
	ID     uuid.UUID       `json:"id"`
	Status SentEmailStatus `json:"status"`
	// Timestamp of the most recent status transition.
	// Polling clients should treat `status='queued'` AND
	// `status_changed_at` older than 5 minutes as
	// "stuck-queued" (the post-tx UPDATE failed and the
	// actual delivery state is recoverable from on-box logs
	// via `queue_id` when populated, or `request_id`).
	StatusChangedAt time.Time `json:"status_changed_at"`
	CreatedAt       time.Time `json:"created_at"`
	UpdatedAt       time.Time `json:"updated_at"`
	// Effective idempotency key used for this send. If the
	// caller passed the `Idempotency-Key` header, this is
	// that value; otherwise it's a server-derived hash of
	// the canonical request payload.
	ClientIdempotencyKey OptNilString `json:"client_idempotency_key"`
	// Stable hash of the canonical send payload.
	ContentHash string `json:"content_hash"`
	// Raw `From:` header as sent on the wire, including any
	// display name (e.g. `"Acme Support" <agent@acme.test>`).
	FromHeader string `json:"from_header"`
	// Bare email address parsed from `from_header`.
	FromAddress string `json:"from_address"`
	// Raw `To:` header as sent on the wire, including any
	// display name.
	ToHeader string `json:"to_header"`
	// Bare email address parsed from `to_header`.
	ToAddress string `json:"to_address"`
	Subject   string `json:"subject"`
	// Total UTF-8 byte length of `body_text` + `body_html`.
	// Surfaced on the list endpoint so callers can see "this
	// row has a 4MB body" without fetching it.
	BodySizeBytes int `json:"body_size_bytes"`
	// Timestamp at which the bodies were discarded by an
	// entitlement-driven retention policy. Null when bodies
	// are still present. The detail endpoint returns
	// null-valued `body_text`/`body_html` for discarded rows.
	ContentDiscardedAt OptNilDateTime `json:"content_discarded_at"`
	// Wire-level Message-ID assigned to the outbound message
	// (RFC 5322). Null on rows that never reached signing
	// (queued, gate_denied, agent_failed before signing).
	MessageID OptNilString `json:"message_id"`
	// Wire-level In-Reply-To header value, when this send
	// was a reply.
	InReplyTo OptNilString `json:"in_reply_to"`
	// Wire-level References header value, when this send
	// was a reply.
	EmailReferences OptNilString `json:"email_references"`
	// Reference to the inbound `emails.id` that this send
	// replied to, when known. Populated when the caller used
	// /emails/{id}/reply or when /send-mail's `in_reply_to`
	// matched a stored inbound message_id in the same org.
	InReplyToEmailID OptNilUUID `json:"in_reply_to_email_id"`
	// Message identifier assigned by Primitive's outbound
	// relay once the agent accepts the message. Null on
	// queued, gate_denied, and agent_failed rows.
	QueueID OptNilString `json:"queue_id"`
	// Receiver's 3-digit SMTP code (e.g. 250, 550, 451).
	// Populated on terminal delivery statuses; may be null
	// on a deferred where the agent never got an SMTP-level
	// response (TCP refused, DNS failed, TLS handshake
	// failed). `smtp_response_text` still carries Postfix's
	// descriptive text in those cases.
	SMTPResponseCode OptNilInt `json:"smtp_response_code"`
	// Free-form text portion of the receiver's SMTP
	// response. The most useful debugging signal on a
	// `bounced` or `deferred` row.
	SMTPResponseText OptNilString `json:"smtp_response_text"`
	// RFC 3463 enhanced status code (e.g. `5.1.1` for "Bad
	// destination mailbox address"). Distinct from
	// `smtp_response_code`: the basic 3-digit code is coarse
	// (550 = "permanent failure"), the enhanced code is
	// finer-grained.
	SMTPEnhancedStatusCode OptNilString `json:"smtp_enhanced_status_code"`
	// DKIM selector used to sign the outbound message.
	// Public DNS data; useful for diagnosing why a downstream
	// verifier rejected the signature.
	DkimSelector OptNilString `json:"dkim_selector"`
	// DKIM signing domain.
	DkimDomain OptNilString `json:"dkim_domain"`
	// Stable public error code on `agent_failed` rows. The
	// agent's internal codes are remapped to a stable public
	// taxonomy (see `publicAgentError` in the server) so this
	// field is safe to branch on across agent versions.
	ErrorCode OptNilString `json:"error_code"`
	// Free-form error message accompanying `error_code`.
	ErrorMessage OptNilString `json:"error_message"`
	// Gate-denial detail on `gate_denied` rows. Mirrors the
	// synchronous /send-mail 403 contract so a caller's
	// GateDenial handler is the same across live denies and
	// historical lookups. Null on every other status.
	Gates OptNilGateDenialArray `json:"gates"`
	// Server-issued request identifier from the original
	// /send-mail call. Surfaced as the `X-Request-Id`
	// response header on the live send and recorded here
	// for support escalation.
	RequestID OptNilString `json:"request_id"`
}

List-row projection of a sent-email record. Drops `body_text` and `body_html` to keep paginated responses small; fetch /sent-emails/{id} for the full record with bodies. Ref: #/components/schemas/SentEmailSummary

func (*SentEmailSummary) Decode added in v0.19.0 

func (s *SentEmailSummary) Decode(d *jx.Decoder) error

Decode decodes SentEmailSummary from json.

func (*SentEmailSummary) Encode added in v0.19.0 

func (s *SentEmailSummary) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SentEmailSummary) GetBodySizeBytes added in v0.19.0 

func (s *SentEmailSummary) GetBodySizeBytes() int

GetBodySizeBytes returns the value of BodySizeBytes.

func (*SentEmailSummary) GetClientIdempotencyKey added in v0.19.0 

func (s *SentEmailSummary) GetClientIdempotencyKey() OptNilString

GetClientIdempotencyKey returns the value of ClientIdempotencyKey.

func (*SentEmailSummary) GetContentDiscardedAt added in v0.19.0 

func (s *SentEmailSummary) GetContentDiscardedAt() OptNilDateTime

GetContentDiscardedAt returns the value of ContentDiscardedAt.

func (*SentEmailSummary) GetContentHash added in v0.19.0 

func (s *SentEmailSummary) GetContentHash() string

GetContentHash returns the value of ContentHash.

func (*SentEmailSummary) GetCreatedAt added in v0.19.0 

func (s *SentEmailSummary) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*SentEmailSummary) GetDkimDomain added in v0.19.0 

func (s *SentEmailSummary) GetDkimDomain() OptNilString

GetDkimDomain returns the value of DkimDomain.

func (*SentEmailSummary) GetDkimSelector added in v0.19.0 

func (s *SentEmailSummary) GetDkimSelector() OptNilString

GetDkimSelector returns the value of DkimSelector.

func (*SentEmailSummary) GetEmailReferences added in v0.19.0 

func (s *SentEmailSummary) GetEmailReferences() OptNilString

GetEmailReferences returns the value of EmailReferences.

func (*SentEmailSummary) GetErrorCode added in v0.19.0 

func (s *SentEmailSummary) GetErrorCode() OptNilString

GetErrorCode returns the value of ErrorCode.

func (*SentEmailSummary) GetErrorMessage added in v0.19.0 

func (s *SentEmailSummary) GetErrorMessage() OptNilString

GetErrorMessage returns the value of ErrorMessage.

func (*SentEmailSummary) GetFromAddress added in v0.19.0 

func (s *SentEmailSummary) GetFromAddress() string

GetFromAddress returns the value of FromAddress.

func (*SentEmailSummary) GetFromHeader added in v0.19.0 

func (s *SentEmailSummary) GetFromHeader() string

GetFromHeader returns the value of FromHeader.

func (*SentEmailSummary) GetGates added in v0.19.0 

func (s *SentEmailSummary) GetGates() OptNilGateDenialArray

GetGates returns the value of Gates.

func (*SentEmailSummary) GetID added in v0.19.0 

func (s *SentEmailSummary) GetID() uuid.UUID

GetID returns the value of ID.

func (*SentEmailSummary) GetInReplyTo added in v0.19.0 

func (s *SentEmailSummary) GetInReplyTo() OptNilString

GetInReplyTo returns the value of InReplyTo.

func (*SentEmailSummary) GetInReplyToEmailID added in v0.19.0 

func (s *SentEmailSummary) GetInReplyToEmailID() OptNilUUID

GetInReplyToEmailID returns the value of InReplyToEmailID.

func (*SentEmailSummary) GetMessageID added in v0.19.0 

func (s *SentEmailSummary) GetMessageID() OptNilString

GetMessageID returns the value of MessageID.

func (*SentEmailSummary) GetQueueID added in v0.19.0 

func (s *SentEmailSummary) GetQueueID() OptNilString

GetQueueID returns the value of QueueID.

func (*SentEmailSummary) GetRequestID added in v0.19.0 

func (s *SentEmailSummary) GetRequestID() OptNilString

GetRequestID returns the value of RequestID.

func (*SentEmailSummary) GetSMTPEnhancedStatusCode added in v0.19.0 

func (s *SentEmailSummary) GetSMTPEnhancedStatusCode() OptNilString

GetSMTPEnhancedStatusCode returns the value of SMTPEnhancedStatusCode.

func (*SentEmailSummary) GetSMTPResponseCode added in v0.19.0 

func (s *SentEmailSummary) GetSMTPResponseCode() OptNilInt

GetSMTPResponseCode returns the value of SMTPResponseCode.

func (*SentEmailSummary) GetSMTPResponseText added in v0.19.0 

func (s *SentEmailSummary) GetSMTPResponseText() OptNilString

GetSMTPResponseText returns the value of SMTPResponseText.

func (*SentEmailSummary) GetStatus added in v0.19.0 

func (s *SentEmailSummary) GetStatus() SentEmailStatus

GetStatus returns the value of Status.

func (*SentEmailSummary) GetStatusChangedAt added in v0.19.0 

func (s *SentEmailSummary) GetStatusChangedAt() time.Time

GetStatusChangedAt returns the value of StatusChangedAt.

func (*SentEmailSummary) GetSubject added in v0.19.0 

func (s *SentEmailSummary) GetSubject() string

GetSubject returns the value of Subject.

func (*SentEmailSummary) GetToAddress added in v0.19.0 

func (s *SentEmailSummary) GetToAddress() string

GetToAddress returns the value of ToAddress.

func (*SentEmailSummary) GetToHeader added in v0.19.0 

func (s *SentEmailSummary) GetToHeader() string

GetToHeader returns the value of ToHeader.

func (*SentEmailSummary) GetUpdatedAt added in v0.19.0 

func (s *SentEmailSummary) GetUpdatedAt() time.Time

GetUpdatedAt returns the value of UpdatedAt.

func (*SentEmailSummary) MarshalJSON added in v0.19.0 

func (s *SentEmailSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SentEmailSummary) SetBodySizeBytes added in v0.19.0 

func (s *SentEmailSummary) SetBodySizeBytes(val int)

SetBodySizeBytes sets the value of BodySizeBytes.

func (*SentEmailSummary) SetClientIdempotencyKey added in v0.19.0 

func (s *SentEmailSummary) SetClientIdempotencyKey(val OptNilString)

SetClientIdempotencyKey sets the value of ClientIdempotencyKey.

func (*SentEmailSummary) SetContentDiscardedAt added in v0.19.0 

func (s *SentEmailSummary) SetContentDiscardedAt(val OptNilDateTime)

SetContentDiscardedAt sets the value of ContentDiscardedAt.

func (*SentEmailSummary) SetContentHash added in v0.19.0 

func (s *SentEmailSummary) SetContentHash(val string)

SetContentHash sets the value of ContentHash.

func (*SentEmailSummary) SetCreatedAt added in v0.19.0 

func (s *SentEmailSummary) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*SentEmailSummary) SetDkimDomain added in v0.19.0 

func (s *SentEmailSummary) SetDkimDomain(val OptNilString)

SetDkimDomain sets the value of DkimDomain.

func (*SentEmailSummary) SetDkimSelector added in v0.19.0 

func (s *SentEmailSummary) SetDkimSelector(val OptNilString)

SetDkimSelector sets the value of DkimSelector.

func (*SentEmailSummary) SetEmailReferences added in v0.19.0 

func (s *SentEmailSummary) SetEmailReferences(val OptNilString)

SetEmailReferences sets the value of EmailReferences.

func (*SentEmailSummary) SetErrorCode added in v0.19.0 

func (s *SentEmailSummary) SetErrorCode(val OptNilString)

SetErrorCode sets the value of ErrorCode.

func (*SentEmailSummary) SetErrorMessage added in v0.19.0 

func (s *SentEmailSummary) SetErrorMessage(val OptNilString)

SetErrorMessage sets the value of ErrorMessage.

func (*SentEmailSummary) SetFromAddress added in v0.19.0 

func (s *SentEmailSummary) SetFromAddress(val string)

SetFromAddress sets the value of FromAddress.

func (*SentEmailSummary) SetFromHeader added in v0.19.0 

func (s *SentEmailSummary) SetFromHeader(val string)

SetFromHeader sets the value of FromHeader.

func (*SentEmailSummary) SetGates added in v0.19.0 

func (s *SentEmailSummary) SetGates(val OptNilGateDenialArray)

SetGates sets the value of Gates.

func (*SentEmailSummary) SetID added in v0.19.0 

func (s *SentEmailSummary) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*SentEmailSummary) SetInReplyTo added in v0.19.0 

func (s *SentEmailSummary) SetInReplyTo(val OptNilString)

SetInReplyTo sets the value of InReplyTo.

func (*SentEmailSummary) SetInReplyToEmailID added in v0.19.0 

func (s *SentEmailSummary) SetInReplyToEmailID(val OptNilUUID)

SetInReplyToEmailID sets the value of InReplyToEmailID.

func (*SentEmailSummary) SetMessageID added in v0.19.0 

func (s *SentEmailSummary) SetMessageID(val OptNilString)

SetMessageID sets the value of MessageID.

func (*SentEmailSummary) SetQueueID added in v0.19.0 

func (s *SentEmailSummary) SetQueueID(val OptNilString)

SetQueueID sets the value of QueueID.

func (*SentEmailSummary) SetRequestID added in v0.19.0 

func (s *SentEmailSummary) SetRequestID(val OptNilString)

SetRequestID sets the value of RequestID.

func (*SentEmailSummary) SetSMTPEnhancedStatusCode added in v0.19.0 

func (s *SentEmailSummary) SetSMTPEnhancedStatusCode(val OptNilString)

SetSMTPEnhancedStatusCode sets the value of SMTPEnhancedStatusCode.

func (*SentEmailSummary) SetSMTPResponseCode added in v0.19.0 

func (s *SentEmailSummary) SetSMTPResponseCode(val OptNilInt)

SetSMTPResponseCode sets the value of SMTPResponseCode.

func (*SentEmailSummary) SetSMTPResponseText added in v0.19.0 

func (s *SentEmailSummary) SetSMTPResponseText(val OptNilString)

SetSMTPResponseText sets the value of SMTPResponseText.

func (*SentEmailSummary) SetStatus added in v0.19.0 

func (s *SentEmailSummary) SetStatus(val SentEmailStatus)

SetStatus sets the value of Status.

func (*SentEmailSummary) SetStatusChangedAt added in v0.19.0 

func (s *SentEmailSummary) SetStatusChangedAt(val time.Time)

SetStatusChangedAt sets the value of StatusChangedAt.

func (*SentEmailSummary) SetSubject added in v0.19.0 

func (s *SentEmailSummary) SetSubject(val string)

SetSubject sets the value of Subject.

func (*SentEmailSummary) SetToAddress added in v0.19.0 

func (s *SentEmailSummary) SetToAddress(val string)

SetToAddress sets the value of ToAddress.

func (*SentEmailSummary) SetToHeader added in v0.19.0 

func (s *SentEmailSummary) SetToHeader(val string)

SetToHeader sets the value of ToHeader.

func (*SentEmailSummary) SetUpdatedAt added in v0.19.0 

func (s *SentEmailSummary) SetUpdatedAt(val time.Time)

SetUpdatedAt sets the value of UpdatedAt.

func (*SentEmailSummary) UnmarshalJSON added in v0.19.0 

func (s *SentEmailSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SentEmailSummary) Validate added in v0.19.0 

func (s *SentEmailSummary) Validate() error

type Server 

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

Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.

func NewServer 

func NewServer(h Handler, sec SecurityHandler, opts ...ServerOption) (*Server, error)

NewServer creates new Server.

func (*Server) FindPath 

func (s *Server) FindPath(method string, u *url.URL) (r Route, _ bool)

FindPath finds Route for given method and URL.

func (*Server) FindRoute 

func (s *Server) FindRoute(method, path string) (Route, bool)

FindRoute finds Route for given method and path.

Note: this method does not unescape path or handle reserved characters in path properly. Use FindPath instead.

func (*Server) ServeHTTP 

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves http request as defined by OpenAPI v3 specification, calling handler that matches the path or returning not found error.

type ServerOption 

type ServerOption interface {
	// contains filtered or unexported methods
}

ServerOption is server config option.

func WithErrorHandler 

func WithErrorHandler(h ErrorHandler) ServerOption

WithErrorHandler specifies error handler to use.

func WithMaxMultipartMemory 

func WithMaxMultipartMemory(max int64) ServerOption

WithMaxMultipartMemory specifies limit of memory for storing file parts. File parts which can't be stored in memory will be stored on disk in temporary files.

func WithMethodNotAllowed 

func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption

WithMethodNotAllowed specifies Method Not Allowed handler to use.

func WithMiddleware 

func WithMiddleware(m ...Middleware) ServerOption

WithMiddleware specifies middlewares to use.

func WithNotFound 

func WithNotFound(notFound http.HandlerFunc) ServerOption

WithNotFound specifies Not Found handler to use.

func WithPathPrefix 

func WithPathPrefix(prefix string) ServerOption

WithPathPrefix specifies server path prefix.

type SetFunctionSecretBadRequest added in v0.20.0 

type SetFunctionSecretBadRequest ErrorResponse

func (*SetFunctionSecretBadRequest) Decode added in v0.20.0 

func (s *SetFunctionSecretBadRequest) Decode(d *jx.Decoder) error

Decode decodes SetFunctionSecretBadRequest from json.

func (*SetFunctionSecretBadRequest) Encode added in v0.20.0 

func (s *SetFunctionSecretBadRequest) Encode(e *jx.Encoder)

Encode encodes SetFunctionSecretBadRequest as json.

func (*SetFunctionSecretBadRequest) MarshalJSON added in v0.20.0 

func (s *SetFunctionSecretBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SetFunctionSecretBadRequest) UnmarshalJSON added in v0.20.0 

func (s *SetFunctionSecretBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SetFunctionSecretBadRequest) Validate added in v0.20.0 

func (s *SetFunctionSecretBadRequest) Validate() error

type SetFunctionSecretCreated added in v0.20.0 

type SetFunctionSecretCreated struct {
	Success bool                      `json:"success"`
	Data    FunctionSecretWriteResult `json:"data"`
}

Merged schema.

func (*SetFunctionSecretCreated) Decode added in v0.20.0 

func (s *SetFunctionSecretCreated) Decode(d *jx.Decoder) error

Decode decodes SetFunctionSecretCreated from json.

func (*SetFunctionSecretCreated) Encode added in v0.20.0 

func (s *SetFunctionSecretCreated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SetFunctionSecretCreated) GetData added in v0.20.0 

func (s *SetFunctionSecretCreated) GetData() FunctionSecretWriteResult

GetData returns the value of Data.

func (*SetFunctionSecretCreated) GetSuccess added in v0.20.0 

func (s *SetFunctionSecretCreated) GetSuccess() bool

GetSuccess returns the value of Success.

func (*SetFunctionSecretCreated) MarshalJSON added in v0.20.0 

func (s *SetFunctionSecretCreated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SetFunctionSecretCreated) SetData added in v0.20.0 

func (s *SetFunctionSecretCreated) SetData(val FunctionSecretWriteResult)

SetData sets the value of Data.

func (*SetFunctionSecretCreated) SetSuccess added in v0.20.0 

func (s *SetFunctionSecretCreated) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*SetFunctionSecretCreated) UnmarshalJSON added in v0.20.0 

func (s *SetFunctionSecretCreated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SetFunctionSecretInput added in v0.20.0 

type SetFunctionSecretInput struct {
	Value string `json:"value"`
}

Body for PUT /functions/{id}/secrets/{key}. Key comes from the path. Ref: #/components/schemas/SetFunctionSecretInput

func (*SetFunctionSecretInput) Decode added in v0.20.0 

func (s *SetFunctionSecretInput) Decode(d *jx.Decoder) error

Decode decodes SetFunctionSecretInput from json.

func (*SetFunctionSecretInput) Encode added in v0.20.0 

func (s *SetFunctionSecretInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SetFunctionSecretInput) GetValue added in v0.20.0 

func (s *SetFunctionSecretInput) GetValue() string

GetValue returns the value of Value.

func (*SetFunctionSecretInput) MarshalJSON added in v0.20.0 

func (s *SetFunctionSecretInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SetFunctionSecretInput) SetValue added in v0.20.0 

func (s *SetFunctionSecretInput) SetValue(val string)

SetValue sets the value of Value.

func (*SetFunctionSecretInput) UnmarshalJSON added in v0.20.0 

func (s *SetFunctionSecretInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SetFunctionSecretInput) Validate added in v0.20.0 

func (s *SetFunctionSecretInput) Validate() error

type SetFunctionSecretNotFound added in v0.20.0 

type SetFunctionSecretNotFound ErrorResponse

func (*SetFunctionSecretNotFound) Decode added in v0.20.0 

func (s *SetFunctionSecretNotFound) Decode(d *jx.Decoder) error

Decode decodes SetFunctionSecretNotFound from json.

func (*SetFunctionSecretNotFound) Encode added in v0.20.0 

func (s *SetFunctionSecretNotFound) Encode(e *jx.Encoder)

Encode encodes SetFunctionSecretNotFound as json.

func (*SetFunctionSecretNotFound) MarshalJSON added in v0.20.0 

func (s *SetFunctionSecretNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SetFunctionSecretNotFound) UnmarshalJSON added in v0.20.0 

func (s *SetFunctionSecretNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SetFunctionSecretNotFound) Validate added in v0.20.0 

func (s *SetFunctionSecretNotFound) Validate() error

type SetFunctionSecretOK added in v0.20.0 

type SetFunctionSecretOK struct {
	Success bool                      `json:"success"`
	Data    FunctionSecretWriteResult `json:"data"`
}

Merged schema.

func (*SetFunctionSecretOK) Decode added in v0.20.0 

func (s *SetFunctionSecretOK) Decode(d *jx.Decoder) error

Decode decodes SetFunctionSecretOK from json.

func (*SetFunctionSecretOK) Encode added in v0.20.0 

func (s *SetFunctionSecretOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SetFunctionSecretOK) GetData added in v0.20.0 

func (s *SetFunctionSecretOK) GetData() FunctionSecretWriteResult

GetData returns the value of Data.

func (*SetFunctionSecretOK) GetSuccess added in v0.20.0 

func (s *SetFunctionSecretOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*SetFunctionSecretOK) MarshalJSON added in v0.20.0 

func (s *SetFunctionSecretOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SetFunctionSecretOK) SetData added in v0.20.0 

func (s *SetFunctionSecretOK) SetData(val FunctionSecretWriteResult)

SetData sets the value of Data.

func (*SetFunctionSecretOK) SetSuccess added in v0.20.0 

func (s *SetFunctionSecretOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*SetFunctionSecretOK) UnmarshalJSON added in v0.20.0 

func (s *SetFunctionSecretOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SetFunctionSecretParams added in v0.20.0 

type SetFunctionSecretParams struct {
	// Resource UUID.
	ID uuid.UUID
	// Secret key. Must match `^[A-Z_][A-Z0-9_]*$`.
	Key string
}

SetFunctionSecretParams is parameters of setFunctionSecret operation.

type SetFunctionSecretRes added in v0.20.0 

type SetFunctionSecretRes interface {
	// contains filtered or unexported methods
}

type SetFunctionSecretUnauthorized added in v0.20.0 

type SetFunctionSecretUnauthorized ErrorResponse

func (*SetFunctionSecretUnauthorized) Decode added in v0.20.0 

func (s *SetFunctionSecretUnauthorized) Decode(d *jx.Decoder) error

Decode decodes SetFunctionSecretUnauthorized from json.

func (*SetFunctionSecretUnauthorized) Encode added in v0.20.0 

func (s *SetFunctionSecretUnauthorized) Encode(e *jx.Encoder)

Encode encodes SetFunctionSecretUnauthorized as json.

func (*SetFunctionSecretUnauthorized) MarshalJSON added in v0.20.0 

func (s *SetFunctionSecretUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SetFunctionSecretUnauthorized) UnmarshalJSON added in v0.20.0 

func (s *SetFunctionSecretUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SetFunctionSecretUnauthorized) Validate added in v0.20.0 

func (s *SetFunctionSecretUnauthorized) Validate() error

type StartAgentSignupCreated added in v0.29.2 

type StartAgentSignupCreated struct {
	Success bool                   `json:"success"`
	Data    AgentSignupStartResult `json:"data"`
}

Merged schema.

func (*StartAgentSignupCreated) Decode added in v0.29.2 

func (s *StartAgentSignupCreated) Decode(d *jx.Decoder) error

Decode decodes StartAgentSignupCreated from json.

func (*StartAgentSignupCreated) Encode added in v0.29.2 

func (s *StartAgentSignupCreated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*StartAgentSignupCreated) GetData added in v0.29.2 

func (s *StartAgentSignupCreated) GetData() AgentSignupStartResult

GetData returns the value of Data.

func (*StartAgentSignupCreated) GetSuccess added in v0.29.2 

func (s *StartAgentSignupCreated) GetSuccess() bool

GetSuccess returns the value of Success.

func (*StartAgentSignupCreated) MarshalJSON added in v0.29.2 

func (s *StartAgentSignupCreated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StartAgentSignupCreated) SetData added in v0.29.2 

func (s *StartAgentSignupCreated) SetData(val AgentSignupStartResult)

SetData sets the value of Data.

func (*StartAgentSignupCreated) SetSuccess added in v0.29.2 

func (s *StartAgentSignupCreated) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*StartAgentSignupCreated) UnmarshalJSON added in v0.29.2 

func (s *StartAgentSignupCreated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*StartAgentSignupCreated) Validate added in v0.29.2 

func (s *StartAgentSignupCreated) Validate() error

type StartAgentSignupCreatedHeaders added in v0.29.2 

type StartAgentSignupCreatedHeaders struct {
	CacheControl OptString
	Response     StartAgentSignupCreated
}

StartAgentSignupCreatedHeaders wraps StartAgentSignupCreated with response headers.

func (*StartAgentSignupCreatedHeaders) GetCacheControl added in v0.29.2 

func (s *StartAgentSignupCreatedHeaders) GetCacheControl() OptString

GetCacheControl returns the value of CacheControl.

func (*StartAgentSignupCreatedHeaders) GetResponse added in v0.29.2 

func (s *StartAgentSignupCreatedHeaders) GetResponse() StartAgentSignupCreated

GetResponse returns the value of Response.

func (*StartAgentSignupCreatedHeaders) SetCacheControl added in v0.29.2 

func (s *StartAgentSignupCreatedHeaders) SetCacheControl(val OptString)

SetCacheControl sets the value of CacheControl.

func (*StartAgentSignupCreatedHeaders) SetResponse added in v0.29.2 

func (s *StartAgentSignupCreatedHeaders) SetResponse(val StartAgentSignupCreated)

SetResponse sets the value of Response.

func (*StartAgentSignupCreatedHeaders) Validate added in v0.29.2 

func (s *StartAgentSignupCreatedHeaders) Validate() error

type StartAgentSignupInput added in v0.29.2 

type StartAgentSignupInput struct {
	Email      string `json:"email"`
	SignupCode string `json:"signup_code"`
	// Must be true to confirm acceptance of Primitive's Terms of Service and Privacy Policy.
	TermsAccepted bool `json:"terms_accepted"`
	// Human-readable device name used for the created agent OAuth session.
	DeviceName OptString `json:"device_name"`
	// Optional client metadata stored with the signup session; serialized JSON must be 2048 bytes or
	// fewer.
	Metadata OptStartAgentSignupInputMetadata `json:"metadata"`
}

Ref: #/components/schemas/StartAgentSignupInput

func (*StartAgentSignupInput) Decode added in v0.29.2 

func (s *StartAgentSignupInput) Decode(d *jx.Decoder) error

Decode decodes StartAgentSignupInput from json.

func (*StartAgentSignupInput) Encode added in v0.29.2 

func (s *StartAgentSignupInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*StartAgentSignupInput) GetDeviceName added in v0.29.2 

func (s *StartAgentSignupInput) GetDeviceName() OptString

GetDeviceName returns the value of DeviceName.

func (*StartAgentSignupInput) GetEmail added in v0.29.2 

func (s *StartAgentSignupInput) GetEmail() string

GetEmail returns the value of Email.

func (*StartAgentSignupInput) GetMetadata added in v0.29.2 

func (s *StartAgentSignupInput) GetMetadata() OptStartAgentSignupInputMetadata

GetMetadata returns the value of Metadata.

func (*StartAgentSignupInput) GetSignupCode added in v0.29.2 

func (s *StartAgentSignupInput) GetSignupCode() string

GetSignupCode returns the value of SignupCode.

func (*StartAgentSignupInput) GetTermsAccepted added in v0.29.2 

func (s *StartAgentSignupInput) GetTermsAccepted() bool

GetTermsAccepted returns the value of TermsAccepted.

func (*StartAgentSignupInput) MarshalJSON added in v0.29.2 

func (s *StartAgentSignupInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StartAgentSignupInput) SetDeviceName added in v0.29.2 

func (s *StartAgentSignupInput) SetDeviceName(val OptString)

SetDeviceName sets the value of DeviceName.

func (*StartAgentSignupInput) SetEmail added in v0.29.2 

func (s *StartAgentSignupInput) SetEmail(val string)

SetEmail sets the value of Email.

func (*StartAgentSignupInput) SetMetadata added in v0.29.2 

func (s *StartAgentSignupInput) SetMetadata(val OptStartAgentSignupInputMetadata)

SetMetadata sets the value of Metadata.

func (*StartAgentSignupInput) SetSignupCode added in v0.29.2 

func (s *StartAgentSignupInput) SetSignupCode(val string)

SetSignupCode sets the value of SignupCode.

func (*StartAgentSignupInput) SetTermsAccepted added in v0.29.2 

func (s *StartAgentSignupInput) SetTermsAccepted(val bool)

SetTermsAccepted sets the value of TermsAccepted.

func (*StartAgentSignupInput) UnmarshalJSON added in v0.29.2 

func (s *StartAgentSignupInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*StartAgentSignupInput) Validate added in v0.29.2 

func (s *StartAgentSignupInput) Validate() error

type StartAgentSignupInputMetadata added in v0.29.2 

type StartAgentSignupInputMetadata map[string]jx.Raw

Optional client metadata stored with the signup session; serialized JSON must be 2048 bytes or fewer.

func (*StartAgentSignupInputMetadata) Decode added in v0.29.2 

func (s *StartAgentSignupInputMetadata) Decode(d *jx.Decoder) error

Decode decodes StartAgentSignupInputMetadata from json.

func (StartAgentSignupInputMetadata) Encode added in v0.29.2 

func (s StartAgentSignupInputMetadata) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (StartAgentSignupInputMetadata) MarshalJSON added in v0.29.2 

func (s StartAgentSignupInputMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StartAgentSignupInputMetadata) UnmarshalJSON added in v0.29.2 

func (s *StartAgentSignupInputMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type StartAgentSignupRes added in v0.29.2 

type StartAgentSignupRes interface {
	// contains filtered or unexported methods
}

type StartCliLoginCreated added in v0.19.0 

type StartCliLoginCreated struct {
	Success bool                `json:"success"`
	Data    CliLoginStartResult `json:"data"`
}

Merged schema.

func (*StartCliLoginCreated) Decode added in v0.19.0 

func (s *StartCliLoginCreated) Decode(d *jx.Decoder) error

Decode decodes StartCliLoginCreated from json.

func (*StartCliLoginCreated) Encode added in v0.19.0 

func (s *StartCliLoginCreated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*StartCliLoginCreated) GetData added in v0.19.0 

func (s *StartCliLoginCreated) GetData() CliLoginStartResult

GetData returns the value of Data.

func (*StartCliLoginCreated) GetSuccess added in v0.19.0 

func (s *StartCliLoginCreated) GetSuccess() bool

GetSuccess returns the value of Success.

func (*StartCliLoginCreated) MarshalJSON added in v0.19.0 

func (s *StartCliLoginCreated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StartCliLoginCreated) SetData added in v0.19.0 

func (s *StartCliLoginCreated) SetData(val CliLoginStartResult)

SetData sets the value of Data.

func (*StartCliLoginCreated) SetSuccess added in v0.19.0 

func (s *StartCliLoginCreated) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*StartCliLoginCreated) UnmarshalJSON added in v0.19.0 

func (s *StartCliLoginCreated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*StartCliLoginCreated) Validate added in v0.19.0 

func (s *StartCliLoginCreated) Validate() error

type StartCliLoginCreatedHeaders added in v0.19.0 

type StartCliLoginCreatedHeaders struct {
	CacheControl OptString
	Response     StartCliLoginCreated
}

StartCliLoginCreatedHeaders wraps StartCliLoginCreated with response headers.

func (*StartCliLoginCreatedHeaders) GetCacheControl added in v0.19.0 

func (s *StartCliLoginCreatedHeaders) GetCacheControl() OptString

GetCacheControl returns the value of CacheControl.

func (*StartCliLoginCreatedHeaders) GetResponse added in v0.19.0 

func (s *StartCliLoginCreatedHeaders) GetResponse() StartCliLoginCreated

GetResponse returns the value of Response.

func (*StartCliLoginCreatedHeaders) SetCacheControl added in v0.19.0 

func (s *StartCliLoginCreatedHeaders) SetCacheControl(val OptString)

SetCacheControl sets the value of CacheControl.

func (*StartCliLoginCreatedHeaders) SetResponse added in v0.19.0 

func (s *StartCliLoginCreatedHeaders) SetResponse(val StartCliLoginCreated)

SetResponse sets the value of Response.

func (*StartCliLoginCreatedHeaders) Validate added in v0.19.0 

func (s *StartCliLoginCreatedHeaders) Validate() error

type StartCliLoginInput added in v0.19.0 

type StartCliLoginInput struct {
	// Human-readable device name shown during browser approval.
	DeviceName OptString `json:"device_name"`
	// Optional client metadata stored with the login session; serialized JSON must be 2048 bytes or fewer.
	Metadata OptStartCliLoginInputMetadata `json:"metadata"`
}

Ref: #/components/schemas/StartCliLoginInput

func (*StartCliLoginInput) Decode added in v0.19.0 

func (s *StartCliLoginInput) Decode(d *jx.Decoder) error

Decode decodes StartCliLoginInput from json.

func (*StartCliLoginInput) Encode added in v0.19.0 

func (s *StartCliLoginInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*StartCliLoginInput) GetDeviceName added in v0.19.0 

func (s *StartCliLoginInput) GetDeviceName() OptString

GetDeviceName returns the value of DeviceName.

func (*StartCliLoginInput) GetMetadata added in v0.19.0 

func (s *StartCliLoginInput) GetMetadata() OptStartCliLoginInputMetadata

GetMetadata returns the value of Metadata.

func (*StartCliLoginInput) MarshalJSON added in v0.19.0 

func (s *StartCliLoginInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StartCliLoginInput) SetDeviceName added in v0.19.0 

func (s *StartCliLoginInput) SetDeviceName(val OptString)

SetDeviceName sets the value of DeviceName.

func (*StartCliLoginInput) SetMetadata added in v0.19.0 

func (s *StartCliLoginInput) SetMetadata(val OptStartCliLoginInputMetadata)

SetMetadata sets the value of Metadata.

func (*StartCliLoginInput) UnmarshalJSON added in v0.19.0 

func (s *StartCliLoginInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*StartCliLoginInput) Validate added in v0.19.0 

func (s *StartCliLoginInput) Validate() error

type StartCliLoginInputMetadata added in v0.19.0 

type StartCliLoginInputMetadata map[string]jx.Raw

Optional client metadata stored with the login session; serialized JSON must be 2048 bytes or fewer.

func (*StartCliLoginInputMetadata) Decode added in v0.19.0 

func (s *StartCliLoginInputMetadata) Decode(d *jx.Decoder) error

Decode decodes StartCliLoginInputMetadata from json.

func (StartCliLoginInputMetadata) Encode added in v0.19.0 

func (s StartCliLoginInputMetadata) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (StartCliLoginInputMetadata) MarshalJSON added in v0.19.0 

func (s StartCliLoginInputMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StartCliLoginInputMetadata) UnmarshalJSON added in v0.19.0 

func (s *StartCliLoginInputMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type StartCliLoginRes added in v0.19.0 

type StartCliLoginRes interface {
	// contains filtered or unexported methods
}

type StartCliSignupCreated added in v0.28.0 

type StartCliSignupCreated struct {
	Success bool                 `json:"success"`
	Data    CliSignupStartResult `json:"data"`
}

Merged schema.

func (*StartCliSignupCreated) Decode added in v0.28.0 

func (s *StartCliSignupCreated) Decode(d *jx.Decoder) error

Decode decodes StartCliSignupCreated from json.

func (*StartCliSignupCreated) Encode added in v0.28.0 

func (s *StartCliSignupCreated) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*StartCliSignupCreated) GetData added in v0.28.0 

func (s *StartCliSignupCreated) GetData() CliSignupStartResult

GetData returns the value of Data.

func (*StartCliSignupCreated) GetSuccess added in v0.28.0 

func (s *StartCliSignupCreated) GetSuccess() bool

GetSuccess returns the value of Success.

func (*StartCliSignupCreated) MarshalJSON added in v0.28.0 

func (s *StartCliSignupCreated) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StartCliSignupCreated) SetData added in v0.28.0 

func (s *StartCliSignupCreated) SetData(val CliSignupStartResult)

SetData sets the value of Data.

func (*StartCliSignupCreated) SetSuccess added in v0.28.0 

func (s *StartCliSignupCreated) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*StartCliSignupCreated) UnmarshalJSON added in v0.28.0 

func (s *StartCliSignupCreated) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*StartCliSignupCreated) Validate added in v0.28.0 

func (s *StartCliSignupCreated) Validate() error

type StartCliSignupCreatedHeaders added in v0.28.0 

type StartCliSignupCreatedHeaders struct {
	CacheControl OptString
	Response     StartCliSignupCreated
}

StartCliSignupCreatedHeaders wraps StartCliSignupCreated with response headers.

func (*StartCliSignupCreatedHeaders) GetCacheControl added in v0.28.0 

func (s *StartCliSignupCreatedHeaders) GetCacheControl() OptString

GetCacheControl returns the value of CacheControl.

func (*StartCliSignupCreatedHeaders) GetResponse added in v0.28.0 

func (s *StartCliSignupCreatedHeaders) GetResponse() StartCliSignupCreated

GetResponse returns the value of Response.

func (*StartCliSignupCreatedHeaders) SetCacheControl added in v0.28.0 

func (s *StartCliSignupCreatedHeaders) SetCacheControl(val OptString)

SetCacheControl sets the value of CacheControl.

func (*StartCliSignupCreatedHeaders) SetResponse added in v0.28.0 

func (s *StartCliSignupCreatedHeaders) SetResponse(val StartCliSignupCreated)

SetResponse sets the value of Response.

func (*StartCliSignupCreatedHeaders) Validate added in v0.28.0 

func (s *StartCliSignupCreatedHeaders) Validate() error

type StartCliSignupInput added in v0.28.0 

type StartCliSignupInput struct {
	Email      string `json:"email"`
	SignupCode string `json:"signup_code"`
	// Must be true to confirm acceptance of Primitive's Terms of Service and Privacy Policy.
	TermsAccepted bool `json:"terms_accepted"`
	// Human-readable device name used for the created CLI OAuth grant.
	DeviceName OptString `json:"device_name"`
	// Optional client metadata stored with the signup session; serialized JSON must be 2048 bytes or
	// fewer.
	Metadata OptStartCliSignupInputMetadata `json:"metadata"`
}

Ref: #/components/schemas/StartCliSignupInput

func (*StartCliSignupInput) Decode added in v0.28.0 

func (s *StartCliSignupInput) Decode(d *jx.Decoder) error

Decode decodes StartCliSignupInput from json.

func (*StartCliSignupInput) Encode added in v0.28.0 

func (s *StartCliSignupInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*StartCliSignupInput) GetDeviceName added in v0.28.0 

func (s *StartCliSignupInput) GetDeviceName() OptString

GetDeviceName returns the value of DeviceName.

func (*StartCliSignupInput) GetEmail added in v0.28.0 

func (s *StartCliSignupInput) GetEmail() string

GetEmail returns the value of Email.

func (*StartCliSignupInput) GetMetadata added in v0.28.0 

func (s *StartCliSignupInput) GetMetadata() OptStartCliSignupInputMetadata

GetMetadata returns the value of Metadata.

func (*StartCliSignupInput) GetSignupCode added in v0.28.0 

func (s *StartCliSignupInput) GetSignupCode() string

GetSignupCode returns the value of SignupCode.

func (*StartCliSignupInput) GetTermsAccepted added in v0.28.0 

func (s *StartCliSignupInput) GetTermsAccepted() bool

GetTermsAccepted returns the value of TermsAccepted.

func (*StartCliSignupInput) MarshalJSON added in v0.28.0 

func (s *StartCliSignupInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StartCliSignupInput) SetDeviceName added in v0.28.0 

func (s *StartCliSignupInput) SetDeviceName(val OptString)

SetDeviceName sets the value of DeviceName.

func (*StartCliSignupInput) SetEmail added in v0.28.0 

func (s *StartCliSignupInput) SetEmail(val string)

SetEmail sets the value of Email.

func (*StartCliSignupInput) SetMetadata added in v0.28.0 

func (s *StartCliSignupInput) SetMetadata(val OptStartCliSignupInputMetadata)

SetMetadata sets the value of Metadata.

func (*StartCliSignupInput) SetSignupCode added in v0.28.0 

func (s *StartCliSignupInput) SetSignupCode(val string)

SetSignupCode sets the value of SignupCode.

func (*StartCliSignupInput) SetTermsAccepted added in v0.28.0 

func (s *StartCliSignupInput) SetTermsAccepted(val bool)

SetTermsAccepted sets the value of TermsAccepted.

func (*StartCliSignupInput) UnmarshalJSON added in v0.28.0 

func (s *StartCliSignupInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*StartCliSignupInput) Validate added in v0.28.0 

func (s *StartCliSignupInput) Validate() error

type StartCliSignupInputMetadata added in v0.28.0 

type StartCliSignupInputMetadata map[string]jx.Raw

Optional client metadata stored with the signup session; serialized JSON must be 2048 bytes or fewer.

func (*StartCliSignupInputMetadata) Decode added in v0.28.0 

func (s *StartCliSignupInputMetadata) Decode(d *jx.Decoder) error

Decode decodes StartCliSignupInputMetadata from json.

func (StartCliSignupInputMetadata) Encode added in v0.28.0 

func (s StartCliSignupInputMetadata) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (StartCliSignupInputMetadata) MarshalJSON added in v0.28.0 

func (s StartCliSignupInputMetadata) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StartCliSignupInputMetadata) UnmarshalJSON added in v0.28.0 

func (s *StartCliSignupInputMetadata) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type StartCliSignupRes added in v0.28.0 

type StartCliSignupRes interface {
	// contains filtered or unexported methods
}

type StaticTokenSource 

type StaticTokenSource struct {
	APIKey             string
	DownloadTokenValue string
}

func NewStaticTokenSource 

func NewStaticTokenSource(apiKey string, downloadToken string) StaticTokenSource

func (StaticTokenSource) BearerAuth 

func (s StaticTokenSource) BearerAuth(_ context.Context, _ OperationName) (BearerAuth, error)

func (StaticTokenSource) DownloadToken 

func (s StaticTokenSource) DownloadToken(_ context.Context, _ OperationName) (DownloadToken, error)

type StorageStats 

type StorageStats struct {
	// Total storage used in bytes.
	UsedBytes int `json:"used_bytes"`
	// Total storage used in kilobytes (1 decimal).
	UsedKB float64 `json:"used_kb"`
	// Total storage used in megabytes (2 decimals).
	UsedMB float64 `json:"used_mb"`
	// Storage quota in megabytes (based on plan).
	QuotaMB float64 `json:"quota_mb"`
	// Percentage of quota used (1 decimal).
	Percentage float64 `json:"percentage"`
	// Number of stored emails.
	EmailsCount int `json:"emails_count"`
}

Ref: #/components/schemas/StorageStats

func (*StorageStats) Decode 

func (s *StorageStats) Decode(d *jx.Decoder) error

Decode decodes StorageStats from json.

func (*StorageStats) Encode 

func (s *StorageStats) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*StorageStats) GetEmailsCount 

func (s *StorageStats) GetEmailsCount() int

GetEmailsCount returns the value of EmailsCount.

func (*StorageStats) GetPercentage 

func (s *StorageStats) GetPercentage() float64

GetPercentage returns the value of Percentage.

func (*StorageStats) GetQuotaMB 

func (s *StorageStats) GetQuotaMB() float64

GetQuotaMB returns the value of QuotaMB.

func (*StorageStats) GetUsedBytes 

func (s *StorageStats) GetUsedBytes() int

GetUsedBytes returns the value of UsedBytes.

func (*StorageStats) GetUsedKB 

func (s *StorageStats) GetUsedKB() float64

GetUsedKB returns the value of UsedKB.

func (*StorageStats) GetUsedMB 

func (s *StorageStats) GetUsedMB() float64

GetUsedMB returns the value of UsedMB.

func (*StorageStats) MarshalJSON 

func (s *StorageStats) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*StorageStats) SetEmailsCount 

func (s *StorageStats) SetEmailsCount(val int)

SetEmailsCount sets the value of EmailsCount.

func (*StorageStats) SetPercentage 

func (s *StorageStats) SetPercentage(val float64)

SetPercentage sets the value of Percentage.

func (*StorageStats) SetQuotaMB 

func (s *StorageStats) SetQuotaMB(val float64)

SetQuotaMB sets the value of QuotaMB.

func (*StorageStats) SetUsedBytes 

func (s *StorageStats) SetUsedBytes(val int)

SetUsedBytes sets the value of UsedBytes.

func (*StorageStats) SetUsedKB 

func (s *StorageStats) SetUsedKB(val float64)

SetUsedKB sets the value of UsedKB.

func (*StorageStats) SetUsedMB 

func (s *StorageStats) SetUsedMB(val float64)

SetUsedMB sets the value of UsedMB.

func (*StorageStats) UnmarshalJSON 

func (s *StorageStats) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*StorageStats) Validate 

func (s *StorageStats) Validate() error

type TestEndpointBadRequest 

type TestEndpointBadRequest ErrorResponse

func (*TestEndpointBadRequest) Decode 

func (s *TestEndpointBadRequest) Decode(d *jx.Decoder) error

Decode decodes TestEndpointBadRequest from json.

func (*TestEndpointBadRequest) Encode 

func (s *TestEndpointBadRequest) Encode(e *jx.Encoder)

Encode encodes TestEndpointBadRequest as json.

func (*TestEndpointBadRequest) MarshalJSON 

func (s *TestEndpointBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestEndpointBadRequest) UnmarshalJSON 

func (s *TestEndpointBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestEndpointBadRequest) Validate 

func (s *TestEndpointBadRequest) Validate() error

type TestEndpointNotFound 

type TestEndpointNotFound ErrorResponse

func (*TestEndpointNotFound) Decode 

func (s *TestEndpointNotFound) Decode(d *jx.Decoder) error

Decode decodes TestEndpointNotFound from json.

func (*TestEndpointNotFound) Encode 

func (s *TestEndpointNotFound) Encode(e *jx.Encoder)

Encode encodes TestEndpointNotFound as json.

func (*TestEndpointNotFound) MarshalJSON 

func (s *TestEndpointNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestEndpointNotFound) UnmarshalJSON 

func (s *TestEndpointNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestEndpointNotFound) Validate 

func (s *TestEndpointNotFound) Validate() error

type TestEndpointOK 

type TestEndpointOK struct {
	Success bool       `json:"success"`
	Data    TestResult `json:"data"`
}

Merged schema.

func (*TestEndpointOK) Decode 

func (s *TestEndpointOK) Decode(d *jx.Decoder) error

Decode decodes TestEndpointOK from json.

func (*TestEndpointOK) Encode 

func (s *TestEndpointOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*TestEndpointOK) GetData 

func (s *TestEndpointOK) GetData() TestResult

GetData returns the value of Data.

func (*TestEndpointOK) GetSuccess 

func (s *TestEndpointOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*TestEndpointOK) MarshalJSON 

func (s *TestEndpointOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestEndpointOK) SetData 

func (s *TestEndpointOK) SetData(val TestResult)

SetData sets the value of Data.

func (*TestEndpointOK) SetSuccess 

func (s *TestEndpointOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*TestEndpointOK) UnmarshalJSON 

func (s *TestEndpointOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type TestEndpointParams 

type TestEndpointParams struct {
	// Resource UUID.
	ID uuid.UUID
}

TestEndpointParams is parameters of testEndpoint operation.

type TestEndpointRes 

type TestEndpointRes interface {
	// contains filtered or unexported methods
}

type TestEndpointUnauthorized 

type TestEndpointUnauthorized ErrorResponse

func (*TestEndpointUnauthorized) Decode 

func (s *TestEndpointUnauthorized) Decode(d *jx.Decoder) error

Decode decodes TestEndpointUnauthorized from json.

func (*TestEndpointUnauthorized) Encode 

func (s *TestEndpointUnauthorized) Encode(e *jx.Encoder)

Encode encodes TestEndpointUnauthorized as json.

func (*TestEndpointUnauthorized) MarshalJSON 

func (s *TestEndpointUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestEndpointUnauthorized) UnmarshalJSON 

func (s *TestEndpointUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestEndpointUnauthorized) Validate 

func (s *TestEndpointUnauthorized) Validate() error

type TestFunctionBadGateway added in v0.20.0 

type TestFunctionBadGateway ErrorResponse

func (*TestFunctionBadGateway) Decode added in v0.20.0 

func (s *TestFunctionBadGateway) Decode(d *jx.Decoder) error

Decode decodes TestFunctionBadGateway from json.

func (*TestFunctionBadGateway) Encode added in v0.20.0 

func (s *TestFunctionBadGateway) Encode(e *jx.Encoder)

Encode encodes TestFunctionBadGateway as json.

func (*TestFunctionBadGateway) MarshalJSON added in v0.20.0 

func (s *TestFunctionBadGateway) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestFunctionBadGateway) UnmarshalJSON added in v0.20.0 

func (s *TestFunctionBadGateway) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestFunctionBadGateway) Validate added in v0.20.0 

func (s *TestFunctionBadGateway) Validate() error

type TestFunctionBadRequest added in v0.20.0 

type TestFunctionBadRequest ErrorResponse

func (*TestFunctionBadRequest) Decode added in v0.20.0 

func (s *TestFunctionBadRequest) Decode(d *jx.Decoder) error

Decode decodes TestFunctionBadRequest from json.

func (*TestFunctionBadRequest) Encode added in v0.20.0 

func (s *TestFunctionBadRequest) Encode(e *jx.Encoder)

Encode encodes TestFunctionBadRequest as json.

func (*TestFunctionBadRequest) MarshalJSON added in v0.20.0 

func (s *TestFunctionBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestFunctionBadRequest) UnmarshalJSON added in v0.20.0 

func (s *TestFunctionBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestFunctionBadRequest) Validate added in v0.20.0 

func (s *TestFunctionBadRequest) Validate() error

type TestFunctionNotFound added in v0.20.0 

type TestFunctionNotFound ErrorResponse

func (*TestFunctionNotFound) Decode added in v0.20.0 

func (s *TestFunctionNotFound) Decode(d *jx.Decoder) error

Decode decodes TestFunctionNotFound from json.

func (*TestFunctionNotFound) Encode added in v0.20.0 

func (s *TestFunctionNotFound) Encode(e *jx.Encoder)

Encode encodes TestFunctionNotFound as json.

func (*TestFunctionNotFound) MarshalJSON added in v0.20.0 

func (s *TestFunctionNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestFunctionNotFound) UnmarshalJSON added in v0.20.0 

func (s *TestFunctionNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestFunctionNotFound) Validate added in v0.20.0 

func (s *TestFunctionNotFound) Validate() error

type TestFunctionOK added in v0.20.0 

type TestFunctionOK struct {
	Success bool                 `json:"success"`
	Data    TestInvocationResult `json:"data"`
}

Merged schema.

func (*TestFunctionOK) Decode added in v0.20.0 

func (s *TestFunctionOK) Decode(d *jx.Decoder) error

Decode decodes TestFunctionOK from json.

func (*TestFunctionOK) Encode added in v0.20.0 

func (s *TestFunctionOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*TestFunctionOK) GetData added in v0.20.0 

func (s *TestFunctionOK) GetData() TestInvocationResult

GetData returns the value of Data.

func (*TestFunctionOK) GetSuccess added in v0.20.0 

func (s *TestFunctionOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*TestFunctionOK) MarshalJSON added in v0.20.0 

func (s *TestFunctionOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestFunctionOK) SetData added in v0.20.0 

func (s *TestFunctionOK) SetData(val TestInvocationResult)

SetData sets the value of Data.

func (*TestFunctionOK) SetSuccess added in v0.20.0 

func (s *TestFunctionOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*TestFunctionOK) UnmarshalJSON added in v0.20.0 

func (s *TestFunctionOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type TestFunctionParams added in v0.20.0 

type TestFunctionParams struct {
	// Resource UUID.
	ID uuid.UUID
}

TestFunctionParams is parameters of testFunction operation.

type TestFunctionReq added in v0.25.0 

type TestFunctionReq struct {
	// Override the synthetic local-part. When set, the
	// test email is sent to `<local_part>@<picked-domain>`
	// instead of the default
	// `__primitive_function_test+<random>@<picked-domain>`.
	// Must start with an alphanumeric and contain only
	// letters, digits, dots, plus signs, hyphens, or
	// underscores; 1-64 characters total.
	LocalPart OptString `json:"local_part"`
}

func (*TestFunctionReq) Decode added in v0.25.0 

func (s *TestFunctionReq) Decode(d *jx.Decoder) error

Decode decodes TestFunctionReq from json.

func (*TestFunctionReq) Encode added in v0.25.0 

func (s *TestFunctionReq) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*TestFunctionReq) GetLocalPart added in v0.25.0 

func (s *TestFunctionReq) GetLocalPart() OptString

GetLocalPart returns the value of LocalPart.

func (*TestFunctionReq) MarshalJSON added in v0.25.0 

func (s *TestFunctionReq) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestFunctionReq) SetLocalPart added in v0.25.0 

func (s *TestFunctionReq) SetLocalPart(val OptString)

SetLocalPart sets the value of LocalPart.

func (*TestFunctionReq) UnmarshalJSON added in v0.25.0 

func (s *TestFunctionReq) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestFunctionReq) Validate added in v0.25.0 

func (s *TestFunctionReq) Validate() error

type TestFunctionRes added in v0.20.0 

type TestFunctionRes interface {
	// contains filtered or unexported methods
}

type TestFunctionServiceUnavailable added in v0.20.0 

type TestFunctionServiceUnavailable ErrorResponse

func (*TestFunctionServiceUnavailable) Decode added in v0.20.0 

func (s *TestFunctionServiceUnavailable) Decode(d *jx.Decoder) error

Decode decodes TestFunctionServiceUnavailable from json.

func (*TestFunctionServiceUnavailable) Encode added in v0.20.0 

func (s *TestFunctionServiceUnavailable) Encode(e *jx.Encoder)

Encode encodes TestFunctionServiceUnavailable as json.

func (*TestFunctionServiceUnavailable) MarshalJSON added in v0.20.0 

func (s *TestFunctionServiceUnavailable) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestFunctionServiceUnavailable) UnmarshalJSON added in v0.20.0 

func (s *TestFunctionServiceUnavailable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestFunctionServiceUnavailable) Validate added in v0.20.0 

func (s *TestFunctionServiceUnavailable) Validate() error

type TestFunctionUnauthorized added in v0.20.0 

type TestFunctionUnauthorized ErrorResponse

func (*TestFunctionUnauthorized) Decode added in v0.20.0 

func (s *TestFunctionUnauthorized) Decode(d *jx.Decoder) error

Decode decodes TestFunctionUnauthorized from json.

func (*TestFunctionUnauthorized) Encode added in v0.20.0 

func (s *TestFunctionUnauthorized) Encode(e *jx.Encoder)

Encode encodes TestFunctionUnauthorized as json.

func (*TestFunctionUnauthorized) MarshalJSON added in v0.20.0 

func (s *TestFunctionUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestFunctionUnauthorized) UnmarshalJSON added in v0.20.0 

func (s *TestFunctionUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestFunctionUnauthorized) Validate added in v0.20.0 

func (s *TestFunctionUnauthorized) Validate() error

type TestFunctionUnprocessableEntity added in v0.20.0 

type TestFunctionUnprocessableEntity ErrorResponse

func (*TestFunctionUnprocessableEntity) Decode added in v0.20.0 

func (s *TestFunctionUnprocessableEntity) Decode(d *jx.Decoder) error

Decode decodes TestFunctionUnprocessableEntity from json.

func (*TestFunctionUnprocessableEntity) Encode added in v0.20.0 

func (s *TestFunctionUnprocessableEntity) Encode(e *jx.Encoder)

Encode encodes TestFunctionUnprocessableEntity as json.

func (*TestFunctionUnprocessableEntity) MarshalJSON added in v0.20.0 

func (s *TestFunctionUnprocessableEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestFunctionUnprocessableEntity) UnmarshalJSON added in v0.20.0 

func (s *TestFunctionUnprocessableEntity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*TestFunctionUnprocessableEntity) Validate added in v0.20.0 

func (s *TestFunctionUnprocessableEntity) Validate() error

type TestInvocationResult added in v0.20.0 

type TestInvocationResult struct {
	// Durable test run id used to fetch the run trace.
	TestRunID uuid.UUID `json:"test_run_id"`
	// Verified inbound domain the test email was sent to.
	InboundDomain string `json:"inbound_domain"`
	// Synthetic local-part plus inbound_domain. Visible in the org's inbox.
	To string `json:"to"`
	// Primitive-controlled outbound sender used for the test.
	From string `json:"from"`
	// Outbound message id from the underlying send. NOT the
	// inbound email's id; the inbound id is created when the
	// email arrives via MX and lands on the function's
	// invocations list.
	SendID string `json:"send_id"`
	// Subject placed on the test email so it can be located in the inbox.
	Subject string `json:"subject"`
	// ISO timestamp suitable as a `since` lower bound when
	// polling /emails for the inbound's arrival. Captured
	// slightly before the send to absorb light clock skew.
	PollSince time.Time `json:"poll_since"`
	// Function detail page where invocations show up live.
	WatchURL url.URL `json:"watch_url"`
	// Relative API URL for GET /functions/{id}/test-runs/{test_run_id}/trace.
	TraceURL string `json:"trace_url"`
}

Metadata returned by POST /functions/{id}/test. The send is queued; poll `trace_url` to watch the run progress through send -> inbound -> webhook deliveries -> outbound requests, logs, and replies. Ref: #/components/schemas/TestInvocationResult

func (*TestInvocationResult) Decode added in v0.20.0 

func (s *TestInvocationResult) Decode(d *jx.Decoder) error

Decode decodes TestInvocationResult from json.

func (*TestInvocationResult) Encode added in v0.20.0 

func (s *TestInvocationResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*TestInvocationResult) GetFrom added in v0.20.0 

func (s *TestInvocationResult) GetFrom() string

GetFrom returns the value of From.

func (*TestInvocationResult) GetInboundDomain added in v0.20.0 

func (s *TestInvocationResult) GetInboundDomain() string

GetInboundDomain returns the value of InboundDomain.

func (*TestInvocationResult) GetPollSince added in v0.20.0 

func (s *TestInvocationResult) GetPollSince() time.Time

GetPollSince returns the value of PollSince.

func (*TestInvocationResult) GetSendID added in v0.20.0 

func (s *TestInvocationResult) GetSendID() string

GetSendID returns the value of SendID.

func (*TestInvocationResult) GetSubject added in v0.20.0 

func (s *TestInvocationResult) GetSubject() string

GetSubject returns the value of Subject.

func (*TestInvocationResult) GetTestRunID added in v0.29.0 

func (s *TestInvocationResult) GetTestRunID() uuid.UUID

GetTestRunID returns the value of TestRunID.

func (*TestInvocationResult) GetTo added in v0.20.0 

func (s *TestInvocationResult) GetTo() string

GetTo returns the value of To.

func (*TestInvocationResult) GetTraceURL added in v0.29.0 

func (s *TestInvocationResult) GetTraceURL() string

GetTraceURL returns the value of TraceURL.

func (*TestInvocationResult) GetWatchURL added in v0.20.0 

func (s *TestInvocationResult) GetWatchURL() url.URL

GetWatchURL returns the value of WatchURL.

func (*TestInvocationResult) MarshalJSON added in v0.20.0 

func (s *TestInvocationResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestInvocationResult) SetFrom added in v0.20.0 

func (s *TestInvocationResult) SetFrom(val string)

SetFrom sets the value of From.

func (*TestInvocationResult) SetInboundDomain added in v0.20.0 

func (s *TestInvocationResult) SetInboundDomain(val string)

SetInboundDomain sets the value of InboundDomain.

func (*TestInvocationResult) SetPollSince added in v0.20.0 

func (s *TestInvocationResult) SetPollSince(val time.Time)

SetPollSince sets the value of PollSince.

func (*TestInvocationResult) SetSendID added in v0.20.0 

func (s *TestInvocationResult) SetSendID(val string)

SetSendID sets the value of SendID.

func (*TestInvocationResult) SetSubject added in v0.20.0 

func (s *TestInvocationResult) SetSubject(val string)

SetSubject sets the value of Subject.

func (*TestInvocationResult) SetTestRunID added in v0.29.0 

func (s *TestInvocationResult) SetTestRunID(val uuid.UUID)

SetTestRunID sets the value of TestRunID.

func (*TestInvocationResult) SetTo added in v0.20.0 

func (s *TestInvocationResult) SetTo(val string)

SetTo sets the value of To.

func (*TestInvocationResult) SetTraceURL added in v0.29.0 

func (s *TestInvocationResult) SetTraceURL(val string)

SetTraceURL sets the value of TraceURL.

func (*TestInvocationResult) SetWatchURL added in v0.20.0 

func (s *TestInvocationResult) SetWatchURL(val url.URL)

SetWatchURL sets the value of WatchURL.

func (*TestInvocationResult) UnmarshalJSON added in v0.20.0 

func (s *TestInvocationResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type TestResult 

type TestResult struct {
	// HTTP status code returned by the endpoint.
	Status int `json:"status"`
	// Response body (truncated to 1000 characters).
	Body string `json:"body"`
	// The signature header value sent (if webhook secret is configured).
	Signature OptString `json:"signature"`
}

Ref: #/components/schemas/TestResult

func (*TestResult) Decode 

func (s *TestResult) Decode(d *jx.Decoder) error

Decode decodes TestResult from json.

func (*TestResult) Encode 

func (s *TestResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*TestResult) GetBody 

func (s *TestResult) GetBody() string

GetBody returns the value of Body.

func (*TestResult) GetSignature 

func (s *TestResult) GetSignature() OptString

GetSignature returns the value of Signature.

func (*TestResult) GetStatus 

func (s *TestResult) GetStatus() int

GetStatus returns the value of Status.

func (*TestResult) MarshalJSON 

func (s *TestResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*TestResult) SetBody 

func (s *TestResult) SetBody(val string)

SetBody sets the value of Body.

func (*TestResult) SetSignature 

func (s *TestResult) SetSignature(val OptString)

SetSignature sets the value of Signature.

func (*TestResult) SetStatus 

func (s *TestResult) SetStatus(val int)

SetStatus sets the value of Status.

func (*TestResult) UnmarshalJSON 

func (s *TestResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type UnimplementedHandler 

type UnimplementedHandler struct{}

UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.

func (UnimplementedHandler) AddDomain 

func (UnimplementedHandler) AddDomain(ctx context.Context, req *AddDomainInput) (r AddDomainRes, _ error)

AddDomain implements addDomain operation.

Creates an unverified domain claim and returns the exact DNS records to publish in `dns_records`. Publish those records before calling the verify endpoint. To give users an importable DNS file, call `downloadDomainZoneFile` or run `primitive domains zone-file --id <domain-id>`.

POST /domains

func (UnimplementedHandler) CliLogout added in v0.19.0 

func (UnimplementedHandler) CliLogout(ctx context.Context, req OptCliLogoutInput) (r CliLogoutRes, _ error)

CliLogout implements cliLogout operation.

Revokes the OAuth grant used to authenticate the request. API-key authenticated legacy logout requests succeed without deleting server API keys so old local CLI state can be cleared safely.

POST /cli/logout

func (UnimplementedHandler) CreateEndpoint 

func (UnimplementedHandler) CreateEndpoint(ctx context.Context, req *CreateEndpointInput) (r CreateEndpointRes, _ error)

CreateEndpoint implements createEndpoint operation.

Creates a new webhook endpoint. If a deactivated endpoint with the same URL and domain exists, it is reactivated instead. Subject to plan limits on the number of active endpoints. **Signing is account-scoped, not per-endpoint.** This call does not return any signing material; every endpoint on the account uses the same webhook secret, fetched via `GET /account/webhook-secret`. See the API-level "Webhook signing" section for the full wire format (header name, signed string, hash algo, secret format, tolerance) and a language-agnostic verification recipe. After creating the endpoint, fire a test delivery against it via `POST /endpoints/{id}/test` to confirm your verifier accepts the signature.

POST /endpoints

func (UnimplementedHandler) CreateFilter 

func (UnimplementedHandler) CreateFilter(ctx context.Context, req *CreateFilterInput) (r CreateFilterRes, _ error)

CreateFilter implements createFilter operation.

Creates a new whitelist or blocklist filter. Per-domain filters require a Pro plan. Patterns are stored as lowercase.

POST /filters

func (UnimplementedHandler) CreateFunction added in v0.20.0 

func (UnimplementedHandler) CreateFunction(ctx context.Context, req *CreateFunctionInput) (r CreateFunctionRes, _ error)

CreateFunction implements createFunction operation.

Creates and deploys a new function. The handler must be a single ESM module whose default export is an object with an async `fetch(request, env)` method (Workers-style). Primitive signs each delivery and forwards the `Primitive-Signature` header to the handler. Verify the raw request body with `PRIMITIVE_WEBHOOK_SECRET` before parsing JSON; after verification the request body parses to an `email.received` event (see `EmailReceivedEvent` and the Webhook payload section for the full schema). Code is bundled before being uploaded; ship a single self-contained file rather than relying on external imports. **Code limits.** `code` is capped at 1 MiB UTF-8. `sourceMap` (optional) is capped at 5 MiB UTF-8, stored with each deployment attempt, and sent to the runtime so stack traces can resolve to original source files. **Auto-wiring.** On successful deploy, Primitive automatically creates a webhook endpoint that delivers inbound mail to the function. There is nothing to configure on the Endpoints API for this to work; the internal runtime URL is not returned by the API and is not a customer-facing integration surface. **Secrets.** New functions ship with the managed secrets (`PRIMITIVE_WEBHOOK_SECRET`, `PRIMITIVE_API_KEY`, `PRIMITIVE_API_BASE_URL`) already bound. Add user-set secrets via `POST /functions/{id}/secrets`; secret writes only land in the running handler on the next redeploy.

POST /functions

func (UnimplementedHandler) CreateFunctionSecret added in v0.20.0 

func (UnimplementedHandler) CreateFunctionSecret(ctx context.Context, req *CreateFunctionSecretInput, params CreateFunctionSecretParams) (r CreateFunctionSecretRes, _ error)

CreateFunctionSecret implements createFunctionSecret operation.

Idempotent insert-or-update keyed on `(function_id, key)`. Returns 201 the first time the key is set, 200 on subsequent updates. Values are encrypted at rest and only become visible to the running handler on the next deploy (`PUT /functions/{id}` with the existing code is sufficient to refresh bindings). Keys must match `^[A-Z_][A-Z0-9_]*$` (uppercase letters, digits, underscores; first character is a letter or underscore). Values are at most 4096 UTF-8 bytes. System- managed keys are reserved and rejected.

POST /functions/{id}/secrets

func (UnimplementedHandler) DeleteDomain 

func (UnimplementedHandler) DeleteDomain(ctx context.Context, params DeleteDomainParams) (r DeleteDomainRes, _ error)

DeleteDomain implements deleteDomain operation.

Deletes a verified or unverified domain claim.

DELETE /domains/{id}

func (UnimplementedHandler) DeleteEmail 

func (UnimplementedHandler) DeleteEmail(ctx context.Context, params DeleteEmailParams) (r DeleteEmailRes, _ error)

DeleteEmail implements deleteEmail operation.

Delete an email.

DELETE /emails/{id}

func (UnimplementedHandler) DeleteEndpoint 

func (UnimplementedHandler) DeleteEndpoint(ctx context.Context, params DeleteEndpointParams) (r DeleteEndpointRes, _ error)

DeleteEndpoint implements deleteEndpoint operation.

Soft-deletes a webhook endpoint. The endpoint will no longer receive webhook deliveries.

DELETE /endpoints/{id}

func (UnimplementedHandler) DeleteFilter 

func (UnimplementedHandler) DeleteFilter(ctx context.Context, params DeleteFilterParams) (r DeleteFilterRes, _ error)

DeleteFilter implements deleteFilter operation.

Delete a filter rule.

DELETE /filters/{id}

func (UnimplementedHandler) DeleteFunction added in v0.20.0 

func (UnimplementedHandler) DeleteFunction(ctx context.Context, params DeleteFunctionParams) (r DeleteFunctionRes, _ error)

DeleteFunction implements deleteFunction operation.

Soft-deletes the function row, removes the script from the edge runtime, and deactivates the auto-wired webhook endpoint so no further inbound mail is delivered. Past deploy history, invocations, and logs are retained. Returns 502 if the runtime delete fails partway; the function row stays in place and the call is safe to retry until it succeeds.

DELETE /functions/{id}

func (UnimplementedHandler) DeleteFunctionSecret added in v0.20.0 

func (UnimplementedHandler) DeleteFunctionSecret(ctx context.Context, params DeleteFunctionSecretParams) (r DeleteFunctionSecretRes, _ error)

DeleteFunctionSecret implements deleteFunctionSecret operation.

Removes the secret. The binding stays live in the running handler until the next deploy refreshes the binding set (`PUT /functions/{id}` with the existing code is sufficient). Returns 404 if the key did not exist. Managed system keys cannot be deleted.

DELETE /functions/{id}/secrets/{key}

func (UnimplementedHandler) DiscardEmailContent added in v0.19.0 

func (UnimplementedHandler) DiscardEmailContent(ctx context.Context, params DiscardEmailContentParams) (r DiscardEmailContentRes, _ error)

DiscardEmailContent implements discardEmailContent operation.

Permanently deletes the email's raw bytes, parsed body (text + HTML), and attachments while preserving metadata (sender, recipient, subject, timestamps, hashes, attachment manifest) for audit logs. Idempotent: a second call returns success with `already_discarded: true` and does no work. **Gated** on the customer's discard-content opt-in (managed in the dashboard at Settings > Webhooks). When the toggle is off, this endpoint returns `403` with code `discard_not_enabled` and a message pointing the human at the dashboard. There is intentionally no API to flip this toggle. Opting in to a destructive, non-reversible operation must be a deliberate human click in the UI.

POST /emails/{id}/discard-content

func (UnimplementedHandler) DownloadAttachments 

func (UnimplementedHandler) DownloadAttachments(ctx context.Context, params DownloadAttachmentsParams) (r DownloadAttachmentsRes, _ error)

DownloadAttachments implements downloadAttachments operation.

Downloads all attachments as a gzip-compressed tar archive. Authenticates via a signed download token (provided in webhook payloads) or a valid session.

GET /emails/{id}/attachments.tar.gz

func (UnimplementedHandler) DownloadDomainZoneFile added in v0.29.2 

func (UnimplementedHandler) DownloadDomainZoneFile(ctx context.Context, params DownloadDomainZoneFileParams) (r DownloadDomainZoneFileRes, _ error)

DownloadDomainZoneFile implements downloadDomainZoneFile operation.

Downloads a BIND-format DNS zone file containing the DNS records required for a domain claim. Agents should offer this after `addDomain` when users want to import DNS records instead of copying each record manually.

GET /domains/{id}/zone-file

func (UnimplementedHandler) DownloadRawEmail 

func (UnimplementedHandler) DownloadRawEmail(ctx context.Context, params DownloadRawEmailParams) (r DownloadRawEmailRes, _ error)

DownloadRawEmail implements downloadRawEmail operation.

Downloads the raw RFC 822 email file (.eml). Authenticates via a signed download token (provided in webhook payloads) or a valid session.

GET /emails/{id}/raw

func (UnimplementedHandler) GetAccount 

func (UnimplementedHandler) GetAccount(ctx context.Context) (r GetAccountRes, _ error)

GetAccount implements getAccount operation.

Get account info.

GET /account

func (UnimplementedHandler) GetEmail 

func (UnimplementedHandler) GetEmail(ctx context.Context, params GetEmailParams) (r GetEmailRes, _ error)

GetEmail implements getEmail operation.

Returns the full record for an inbound email received at one of your verified domains, including the parsed text and HTML bodies, threading metadata, SMTP envelope detail, webhook delivery state, and a `replies` array for any outbound sends recorded as replies to this inbound. For listing inbound emails (with cursor pagination, status and date filters, and free-text search), use `/emails`. Outbound (sent) email records are NOT returned here; use `/sent-emails/{id}` for those. The response carries four sender-shaped fields whose meanings overlap. `from_email` is the canonical "who sent this" field for most use cases (parsed bare address from the `From:` header, with a `sender` fallback). `from_header` is the raw header including any display name. `sender` and `smtp_mail_from` both carry the SMTP envelope MAIL FROM (return-path) and are equal by construction; `sender` is the older field name retained for compatibility. See `primitive describe emails:get-email | jq '.responseSchema.properties'` for per-field detail.

GET /emails/{id}

func (UnimplementedHandler) GetFunction added in v0.20.0 

func (UnimplementedHandler) GetFunction(ctx context.Context, params GetFunctionParams) (r GetFunctionRes, _ error)

GetFunction implements getFunction operation.

Returns the full record for a function, including its current source code and the deploy status / error from the most recent deploy attempt.

GET /functions/{id}

func (UnimplementedHandler) GetFunctionTestRunTrace added in v0.29.0 

func (UnimplementedHandler) GetFunctionTestRunTrace(ctx context.Context, params GetFunctionTestRunTraceParams) (r GetFunctionTestRunTraceRes, _ error)

GetFunctionTestRunTrace implements getFunctionTestRunTrace operation.

Returns the current end-to-end trace for a function test run. The trace is intentionally partial while the test is still in flight: callers can poll this endpoint and watch it fill in from send -> inbound -> webhook deliveries -> outbound requests, logs, and replies.

GET /functions/{id}/test-runs/{run_id}/trace

func (UnimplementedHandler) GetInboxStatus added in v0.29.3 

func (UnimplementedHandler) GetInboxStatus(ctx context.Context) (r GetInboxStatusRes, _ error)

GetInboxStatus implements getInboxStatus operation.

Returns one consolidated view of inbound domain readiness, webhook/function processing routes, deployed Functions, and recent inbound email activity. Agents should call this before guiding a user through inbound setup. It answers the practical questions "can I receive mail", "will anything process that mail", and "what should I do next" without forcing clients to stitch together domains, endpoints, functions, and emails manually.

GET /inbox/status

func (UnimplementedHandler) GetSendPermissions added in v0.19.0 

func (UnimplementedHandler) GetSendPermissions(ctx context.Context) (r GetSendPermissionsRes, _ error)

GetSendPermissions implements getSendPermissions operation.

Returns a flat list of rules describing every recipient the caller may send to. Each rule has a `type`, a kind-specific payload, and a human-readable `description`. If any rule matches the recipient, /send-mail will accept the send under the recipient-scope check. The endpoint is the answer to "where can I send" without exposing internal entitlement names. Agents that don't recognize a `type` can still read the `description` prose and act on it. Rule kinds, ordered broadest-first so an agent can stop scanning at the first match: 1. `any_recipient` (one entry, only when the org can send anywhere): every other rule below it is redundant. 2. `managed_zone` (always emitted, one per Primitive-managed zone): sends to any address at *.primitive.email or *.email.works always succeed; no entitlement required. 3. `your_domain` (one per active verified outbound domain owned by the org): sends to that domain are approved. 4. `address` (one per address that has authenticated inbound mail to the org, capped at `meta.address_cap`): sends to that exact address are approved. The list is informational, not an authorization check. /send-mail remains the source of truth on whether an individual send will succeed (it also enforces the from-address and the `send_mail` entitlement, which are not recipient-scope concerns and are not represented here).

GET /send-permissions

func (UnimplementedHandler) GetSentEmail added in v0.19.0 

func (UnimplementedHandler) GetSentEmail(ctx context.Context, params GetSentEmailParams) (r GetSentEmailRes, _ error)

GetSentEmail implements getSentEmail operation.

Returns the full sent-email record by id, including `body_text` and `body_html` (omitted from the listing endpoint to keep paginated responses small). Use this when diagnosing a specific send, e.g. inspecting the receiver's SMTP response on a `bounced` row or pulling the gate denial detail on a `gate_denied` row.

GET /sent-emails/{id}

func (UnimplementedHandler) GetStorageStats 

func (UnimplementedHandler) GetStorageStats(ctx context.Context) (r GetStorageStatsRes, _ error)

GetStorageStats implements getStorageStats operation.

Get storage usage.

GET /account/storage

func (UnimplementedHandler) GetWebhookSecret 

func (UnimplementedHandler) GetWebhookSecret(ctx context.Context) (r GetWebhookSecretRes, _ error)

GetWebhookSecret implements getWebhookSecret operation.

Returns the webhook signing secret for your account. If no secret exists yet, one is generated automatically on first access. Signing is account-scoped, not per-endpoint. Every webhook delivery from any of your registered endpoints is signed with this single secret. Rotate via `POST /account/webhook-secret/rotate`. **Secret format**: the returned string looks base64-shaped (e.g. `XNHBBW8VqoBjRfNs1tkZj11jTk...`) but is NOT base64. Use it AS-IS as a UTF-8 string when computing HMAC over a delivery body. Base64-decoding before HMAC will silently produce mismatched signatures. See the API-level "Webhook signing" section for the full wire format (header name, signed string shape, hash algo, tolerance) including a language-agnostic verification recipe.

GET /account/webhook-secret

func (UnimplementedHandler) ListDeliveries 

func (UnimplementedHandler) ListDeliveries(ctx context.Context, params ListDeliveriesParams) (r ListDeliveriesRes, _ error)

ListDeliveries implements listDeliveries operation.

Returns a paginated list of webhook delivery attempts. Each delivery includes a nested `email` object with sender, recipient, and subject.

GET /webhooks/deliveries

func (UnimplementedHandler) ListDomains 

func (UnimplementedHandler) ListDomains(ctx context.Context) (r ListDomainsRes, _ error)

ListDomains implements listDomains operation.

Returns all verified and unverified domains for your organization, sorted by creation date (newest first). Each domain includes a `verified` boolean to distinguish between the two states.

GET /domains

func (UnimplementedHandler) ListEmails 

func (UnimplementedHandler) ListEmails(ctx context.Context, params ListEmailsParams) (r ListEmailsRes, _ error)

ListEmails implements listEmails operation.

Returns a paginated list of INBOUND emails received at your verified domains. Outbound messages sent via /send-mail are not included; this endpoint is the inbox view, not a unified send/receive history. Supports filtering by domain, status, date range, and free-text search across subject, sender, and recipient fields. For a compact text-table summary of the most recent N inbounds (no filters, no cursor pagination), the CLI ships `primitive emails:latest` as a one-line-per-email shortcut. It's TTY-aware so id columns are full UUIDs when piped, and a `--json` flag returns the same envelope this endpoint does. Use whichever fits the call site.

GET /emails

func (UnimplementedHandler) ListEndpoints 

func (UnimplementedHandler) ListEndpoints(ctx context.Context) (r ListEndpointsRes, _ error)

ListEndpoints implements listEndpoints operation.

Returns all active (non-deleted) webhook endpoints.

GET /endpoints

func (UnimplementedHandler) ListFilters 

func (UnimplementedHandler) ListFilters(ctx context.Context) (r ListFiltersRes, _ error)

ListFilters implements listFilters operation.

Returns all whitelist and blocklist filter rules.

GET /filters

func (UnimplementedHandler) ListFunctionLogs added in v0.26.0 

func (UnimplementedHandler) ListFunctionLogs(ctx context.Context, params ListFunctionLogsParams) (r ListFunctionLogsRes, _ error)

ListFunctionLogs implements listFunctionLogs operation.

Returns the most recent `function_logs` rows for the function, newest first. Each row is a single `console.log` / `console.error` invocation captured from the running handler. Page through history with the opaque `cursor` returned as `next_cursor`; pass it back as the `cursor` query param on the next call. `next_cursor` is `null` when there are no further rows. The cursor format is an implementation detail and should not be parsed by callers.

GET /functions/{id}/logs

func (UnimplementedHandler) ListFunctionSecrets added in v0.20.0 

func (UnimplementedHandler) ListFunctionSecrets(ctx context.Context, params ListFunctionSecretsParams) (r ListFunctionSecretsRes, _ error)

ListFunctionSecrets implements listFunctionSecrets operation.

Returns metadata for every secret bound to the function, with managed entries (provisioned by Primitive) listed first and user-set entries listed alphabetically after. **Values are never returned.** Secret writes are write-only. Managed entries (e.g. `PRIMITIVE_WEBHOOK_SECRET`, `PRIMITIVE_API_KEY`, `PRIMITIVE_API_BASE_URL`) carry a `description` instead of `created_at` / `updated_at`. They cannot be created, updated, or deleted via this API.

GET /functions/{id}/secrets

func (UnimplementedHandler) ListFunctions added in v0.20.0 

func (UnimplementedHandler) ListFunctions(ctx context.Context) (r ListFunctionsRes, _ error)

ListFunctions implements listFunctions operation.

Returns every active (non-deleted) function in the org, newest first. Each entry carries deploy status and timestamps. To inspect the source code or deploy errors, use `GET /functions/{id}`.

GET /functions

func (UnimplementedHandler) ListSentEmails added in v0.19.0 

func (UnimplementedHandler) ListSentEmails(ctx context.Context, params ListSentEmailsParams) (r ListSentEmailsRes, _ error)

ListSentEmails implements listSentEmails operation.

Returns a paginated list of OUTBOUND emails the caller's org has sent via /send-mail (and /emails/{id}/reply, which forwards through /send-mail). Includes every recorded attempt, including gate-denied attempts that the agent never called and rows still in `queued` state. For inbound mail received at your verified domains, see /emails. There is no unified send/receive history endpoint; the two surfaces are intentionally separate because the underlying tables, statuses, and lifecycle differ. Email bodies (`body_text`, `body_html`) are NOT included on list rows so a 50-row page can't balloon into a multi-MB response when sends are near the 5MB body cap. Use /sent-emails/{id} to fetch a single row with bodies, or cross-reference by `client_idempotency_key` if the caller already has the body locally.

GET /sent-emails

func (UnimplementedHandler) PollCliLogin added in v0.19.0 

func (UnimplementedHandler) PollCliLogin(ctx context.Context, req *PollCliLoginInput) (r PollCliLoginRes, _ error)

PollCliLogin implements pollCliLogin operation.

Polls a CLI login session until the browser approval either succeeds, is denied, expires, or is polled too quickly. The OAuth token set is created only after approval and is returned exactly once.

POST /cli/login/poll

func (UnimplementedHandler) ReplayDelivery 

func (UnimplementedHandler) ReplayDelivery(ctx context.Context, params ReplayDeliveryParams) (r ReplayDeliveryRes, _ error)

ReplayDelivery implements replayDelivery operation.

Re-sends the stored webhook payload from a previous delivery attempt. If the original endpoint is still active, it is targeted. If the original endpoint was deleted, the oldest active endpoint is used. Deactivated endpoints cannot be replayed to. Rate limited per-org, sharing an org-wide budget with email replays.

POST /webhooks/deliveries/{id}/replay

func (UnimplementedHandler) ReplayEmailWebhooks 

func (UnimplementedHandler) ReplayEmailWebhooks(ctx context.Context, params ReplayEmailWebhooksParams) (r ReplayEmailWebhooksRes, _ error)

ReplayEmailWebhooks implements replayEmailWebhooks operation.

Re-delivers the webhook payload for this email to all active endpoints matching the email's domain. Rate limited per-email (short cooldown between successive replays of the same email) and per-org (burst + sustained windows), sharing an org-wide budget with delivery replays.

POST /emails/{id}/replay

func (UnimplementedHandler) ReplyToEmail added in v0.10.0 

func (UnimplementedHandler) ReplyToEmail(ctx context.Context, req *ReplyInput, params ReplyToEmailParams) (r ReplyToEmailRes, _ error)

ReplyToEmail implements replyToEmail operation.

Sends an outbound reply to the inbound email identified by `id`. Threading headers (`In-Reply-To`, `References`), recipient derivation (Reply-To, then From, then bare sender), and the `Re:` subject prefix are all derived server-side from the stored inbound row. The request body carries only the message body and optional `wait` flag; passing any header or recipient override is rejected by the schema (`additionalProperties: false`). Forwards through the same gates as `/send-mail`: the response status, error envelope, and `idempotent_replay` flag mirror the send-mail contract verbatim.

POST /emails/{id}/reply

func (UnimplementedHandler) ResendAgentSignupVerification added in v0.29.2 

func (UnimplementedHandler) ResendAgentSignupVerification(ctx context.Context, req *ResendAgentSignupVerificationInput) (r ResendAgentSignupVerificationRes, _ error)

ResendAgentSignupVerification implements resendAgentSignupVerification operation.

Sends a new email verification code for a pending agent signup session. This endpoint does not require an API key.

POST /agent/signup/resend

func (UnimplementedHandler) ResendCliSignupVerification added in v0.28.0 

func (UnimplementedHandler) ResendCliSignupVerification(ctx context.Context, req *ResendCliSignupVerificationInput) (r ResendCliSignupVerificationRes, _ error)

ResendCliSignupVerification implements resendCliSignupVerification operation.

Sends a new email verification code for a pending CLI signup session. This endpoint does not require an API key.

POST /cli/signup/resend

func (UnimplementedHandler) RotateWebhookSecret 

func (UnimplementedHandler) RotateWebhookSecret(ctx context.Context) (r RotateWebhookSecretRes, _ error)

RotateWebhookSecret implements rotateWebhookSecret operation.

Generates a new webhook signing secret, replacing the current one. Rate limited to once per 60 minutes.

POST /account/webhook-secret/rotate

func (UnimplementedHandler) SearchEmails added in v0.21.0 

func (UnimplementedHandler) SearchEmails(ctx context.Context, params SearchEmailsParams) (r SearchEmailsRes, _ error)

SearchEmails implements searchEmails operation.

Searches inbound emails with structured filters and optional full-text matching across parsed email fields. This endpoint is optimized for filtered inbox views and CLI polling workflows: callers that only need new accepted mail can pass `sort=received_at_asc`, `snippet=false`, `include_facets=false`, and a `date_from` timestamp. `q`, `subject`, and `body` use the same English full-text index as the web inbox search. Structured filters such as `from`, `to`, `domain_id`, status, attachment presence, and spam score bounds are combined with the text query.

GET /emails/search

func (UnimplementedHandler) SendEmail added in v0.8.0 

func (UnimplementedHandler) SendEmail(ctx context.Context, req *SendMailInput, params SendEmailParams) (r SendEmailRes, _ error)

SendEmail implements sendEmail operation.

Sends an outbound email through Primitive's outbound relay. By default the request returns once the relay accepts the message for delivery. Set `wait: true` to wait for the first downstream SMTP delivery outcome. **Host routing.** /send-mail is served by the attachments- supporting host (`https://api.primitive.dev/v1`) so the request body can carry inline attachments up to ~30 MiB raw. The primary host (`https://www.primitive.dev/api/v1`) also accepts /send-mail for attachment-free sends; sends WITH attachments to the primary host return 413 `attachments_unsupported_on_this_endpoint`. The typed SDKs route /send-mail to the attachments host automatically.

POST /send-mail

func (UnimplementedHandler) SetFunctionSecret added in v0.20.0 

func (UnimplementedHandler) SetFunctionSecret(ctx context.Context, req *SetFunctionSecretInput, params SetFunctionSecretParams) (r SetFunctionSecretRes, _ error)

SetFunctionSecret implements setFunctionSecret operation.

Path-keyed companion to `POST /functions/{id}/secrets`. Idempotent: returns 201 the first time the key is set, 200 on subsequent updates. Same validation rules and same write-only guarantees as the POST verb; the new value lands in the running handler on the next deploy.

PUT /functions/{id}/secrets/{key}

func (UnimplementedHandler) StartAgentSignup added in v0.29.2 

func (UnimplementedHandler) StartAgentSignup(ctx context.Context, req *StartAgentSignupInput) (r StartAgentSignupRes, _ error)

StartAgentSignup implements startAgentSignup operation.

Starts an agent-native signup session. The API validates the signup code, creates a pending signup session, sends an email verification code, and returns an opaque signup token used by the resend and verify steps. This endpoint does not require an API key.

POST /agent/signup/start

func (UnimplementedHandler) StartCliLogin added in v0.19.0 

func (UnimplementedHandler) StartCliLogin(ctx context.Context, req OptStartCliLoginInput) (r StartCliLoginRes, _ error)

StartCliLogin implements startCliLogin operation.

Starts a browser-assisted CLI login session. The response includes a device code for polling and a user code that the user approves in the browser. This endpoint does not require an API key.

POST /cli/login/start

func (UnimplementedHandler) StartCliSignup added in v0.28.0 

func (UnimplementedHandler) StartCliSignup(ctx context.Context, req *StartCliSignupInput) (r StartCliSignupRes, _ error)

StartCliSignup implements startCliSignup operation.

Starts a terminal-native CLI signup. The API validates the signup code, creates a pending signup session, sends an email verification code, and returns an opaque signup token used by the resend and verify steps. This endpoint does not require an API key.

POST /cli/signup/start

func (UnimplementedHandler) TestEndpoint 

func (UnimplementedHandler) TestEndpoint(ctx context.Context, params TestEndpointParams) (r TestEndpointRes, _ error)

TestEndpoint implements testEndpoint operation.

Sends a sample `email.received` event to the endpoint. The request includes SSRF protection (private IP rejection and DNS pinning). Rate limited to 4 per minute and 30 per hour (non-exempt). Successful deliveries and verified-domain endpoints are exempt from the rate limit.

POST /endpoints/{id}/test

func (UnimplementedHandler) TestFunction added in v0.20.0 

func (UnimplementedHandler) TestFunction(ctx context.Context, req OptTestFunctionReq, params TestFunctionParams) (r TestFunctionRes, _ error)

TestFunction implements testFunction operation.

Sends a real test email from a Primitive-controlled sender to a local-part on one of the org's verified inbound domains. By default the recipient is a synthetic `__primitive_function_test+<random>@<domain>` address on a domain selected to route to the function. Scoped functions use their scoped domain; fallback functions use a domain that has no enabled domain-scoped endpoint. Pass `local_part` to override and exercise routing logic that branches on a specific recipient (the common pattern when one function handles multiple inboxes like `summarize@` and `action@`). The function fires through the normal MX delivery path, so reply / send-mail calls from inside the handler against the inbound's `email.id` work the same as in production. Returns immediately after the send is queued; the invocation appears on the function's invocations list within a few seconds. Requires that the function is currently `deployed`. Returns 422 if the function is in `pending` or `failed` state, or if the org has no verified inbound domain to receive the test mail. Returns 400 if `local_part` is set to a value that does not match the local-part character set.

POST /functions/{id}/test

func (UnimplementedHandler) UpdateAccount 

func (UnimplementedHandler) UpdateAccount(ctx context.Context, req *UpdateAccountInput) (r UpdateAccountRes, _ error)

UpdateAccount implements updateAccount operation.

Update account settings.

PATCH /account

func (UnimplementedHandler) UpdateDomain 

func (UnimplementedHandler) UpdateDomain(ctx context.Context, req *UpdateDomainInput, params UpdateDomainParams) (r UpdateDomainRes, _ error)

UpdateDomain implements updateDomain operation.

Update a verified domain's settings. Only verified domains can be updated. Per-domain spam thresholds require a Pro plan.

PATCH /domains/{id}

func (UnimplementedHandler) UpdateEndpoint 

func (UnimplementedHandler) UpdateEndpoint(ctx context.Context, req *UpdateEndpointInput, params UpdateEndpointParams) (r UpdateEndpointRes, _ error)

UpdateEndpoint implements updateEndpoint operation.

Updates an active webhook endpoint. If the URL is changed, the old endpoint is deactivated and a new one is created (or an existing deactivated endpoint with the new URL is reactivated).

PATCH /endpoints/{id}

func (UnimplementedHandler) UpdateFilter 

func (UnimplementedHandler) UpdateFilter(ctx context.Context, req *UpdateFilterInput, params UpdateFilterParams) (r UpdateFilterRes, _ error)

UpdateFilter implements updateFilter operation.

Toggle a filter's enabled state.

PATCH /filters/{id}

func (UnimplementedHandler) UpdateFunction added in v0.20.0 

func (UnimplementedHandler) UpdateFunction(ctx context.Context, req *UpdateFunctionInput, params UpdateFunctionParams) (r UpdateFunctionRes, _ error)

UpdateFunction implements updateFunction operation.

Replaces the function's source code with the body's `code` and triggers a redeploy. Same size limits as `POST /functions`. Use this verb to push secret writes into the running handler: passing the same `code` re-runs the deploy and refreshes the binding set with the latest values from the secrets table. On deploy failure, the previously-deployed code stays live; the runtime never serves a half-built bundle. The response uses `error.code` `deploy_failed`, and the function's `deploy_error` field carries the latest deploy error for dashboard/API reads.

PUT /functions/{id}

func (UnimplementedHandler) VerifyAgentSignup added in v0.29.2 

func (UnimplementedHandler) VerifyAgentSignup(ctx context.Context, req *VerifyAgentSignupInput) (r VerifyAgentSignupRes, _ error)

VerifyAgentSignup implements verifyAgentSignup operation.

Verifies the email code for an agent signup session, creates the account when needed, redeems the reserved signup code, mints an org-scoped OAuth session for CLI authentication, and returns the raw tokens exactly once. For existing users, the optional `org_id` selects which accessible workspace should receive the new session.

POST /agent/signup/verify

func (UnimplementedHandler) VerifyCliSignup added in v0.28.0 

func (UnimplementedHandler) VerifyCliSignup(ctx context.Context, req *VerifyCliSignupInput) (r VerifyCliSignupRes, _ error)

VerifyCliSignup implements verifyCliSignup operation.

Verifies the email code for a CLI signup session, creates the account, redeems the reserved signup code, creates an org-scoped OAuth CLI session, and returns the token set exactly once. This endpoint does not require an API key.

POST /cli/signup/verify

func (UnimplementedHandler) VerifyDomain 

func (UnimplementedHandler) VerifyDomain(ctx context.Context, params VerifyDomainParams) (r VerifyDomainRes, _ error)

VerifyDomain implements verifyDomain operation.

Checks DNS records required for inbound routing, ownership, and outbound authentication: MX, ownership TXT, SPF, DKIM, DMARC, and TLS-RPT. On success, the domain is promoted from unverified to verified. On failure, returns which checks passed and which failed, plus the exact DNS records still expected. To give users an importable DNS file for missing records, call `downloadDomainZoneFile` or run `primitive domains zone-file --id <domain-id>`.

POST /domains/{id}/verify

type UnverifiedDomain 

type UnverifiedDomain struct {
	ID       uuid.UUID `json:"id"`
	OrgID    uuid.UUID `json:"org_id"`
	Domain   string    `json:"domain"`
	Verified bool      `json:"verified"`
	// Add this value as a TXT record to verify ownership.
	VerificationToken string `json:"verification_token"`
	// Exact DNS records to publish for this pending domain claim.
	DNSRecords []DomainDnsRecord `json:"dns_records"`
	CreatedAt  time.Time         `json:"created_at"`
}

Ref: #/components/schemas/UnverifiedDomain

func (*UnverifiedDomain) Decode 

func (s *UnverifiedDomain) Decode(d *jx.Decoder) error

Decode decodes UnverifiedDomain from json.

func (*UnverifiedDomain) Encode 

func (s *UnverifiedDomain) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UnverifiedDomain) GetCreatedAt 

func (s *UnverifiedDomain) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*UnverifiedDomain) GetDNSRecords added in v0.29.2 

func (s *UnverifiedDomain) GetDNSRecords() []DomainDnsRecord

GetDNSRecords returns the value of DNSRecords.

func (*UnverifiedDomain) GetDomain 

func (s *UnverifiedDomain) GetDomain() string

GetDomain returns the value of Domain.

func (*UnverifiedDomain) GetID 

func (s *UnverifiedDomain) GetID() uuid.UUID

GetID returns the value of ID.

func (*UnverifiedDomain) GetOrgID 

func (s *UnverifiedDomain) GetOrgID() uuid.UUID

GetOrgID returns the value of OrgID.

func (*UnverifiedDomain) GetVerificationToken 

func (s *UnverifiedDomain) GetVerificationToken() string

GetVerificationToken returns the value of VerificationToken.

func (*UnverifiedDomain) GetVerified 

func (s *UnverifiedDomain) GetVerified() bool

GetVerified returns the value of Verified.

func (*UnverifiedDomain) MarshalJSON 

func (s *UnverifiedDomain) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UnverifiedDomain) SetCreatedAt 

func (s *UnverifiedDomain) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*UnverifiedDomain) SetDNSRecords added in v0.29.2 

func (s *UnverifiedDomain) SetDNSRecords(val []DomainDnsRecord)

SetDNSRecords sets the value of DNSRecords.

func (*UnverifiedDomain) SetDomain 

func (s *UnverifiedDomain) SetDomain(val string)

SetDomain sets the value of Domain.

func (*UnverifiedDomain) SetID 

func (s *UnverifiedDomain) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*UnverifiedDomain) SetOrgID 

func (s *UnverifiedDomain) SetOrgID(val uuid.UUID)

SetOrgID sets the value of OrgID.

func (*UnverifiedDomain) SetVerificationToken 

func (s *UnverifiedDomain) SetVerificationToken(val string)

SetVerificationToken sets the value of VerificationToken.

func (*UnverifiedDomain) SetVerified 

func (s *UnverifiedDomain) SetVerified(val bool)

SetVerified sets the value of Verified.

func (*UnverifiedDomain) UnmarshalJSON 

func (s *UnverifiedDomain) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UnverifiedDomain) Validate added in v0.29.2 

func (s *UnverifiedDomain) Validate() error

type UpdateAccountBadRequest 

type UpdateAccountBadRequest ErrorResponse

func (*UpdateAccountBadRequest) Decode 

func (s *UpdateAccountBadRequest) Decode(d *jx.Decoder) error

Decode decodes UpdateAccountBadRequest from json.

func (*UpdateAccountBadRequest) Encode 

func (s *UpdateAccountBadRequest) Encode(e *jx.Encoder)

Encode encodes UpdateAccountBadRequest as json.

func (*UpdateAccountBadRequest) MarshalJSON 

func (s *UpdateAccountBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateAccountBadRequest) UnmarshalJSON 

func (s *UpdateAccountBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateAccountBadRequest) Validate 

func (s *UpdateAccountBadRequest) Validate() error

type UpdateAccountInput 

type UpdateAccountInput struct {
	// Global spam score threshold (0-15). Emails scoring above this are rejected. Set to null to disable.
	SpamThreshold OptNilFloat64 `json:"spam_threshold"`
	// Whether to discard email content after the webhook endpoint confirms receipt.
	DiscardContentOnWebhookConfirmed OptBool `json:"discard_content_on_webhook_confirmed"`
}

Ref: #/components/schemas/UpdateAccountInput

func (*UpdateAccountInput) Decode 

func (s *UpdateAccountInput) Decode(d *jx.Decoder) error

Decode decodes UpdateAccountInput from json.

func (*UpdateAccountInput) Encode 

func (s *UpdateAccountInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateAccountInput) GetDiscardContentOnWebhookConfirmed 

func (s *UpdateAccountInput) GetDiscardContentOnWebhookConfirmed() OptBool

GetDiscardContentOnWebhookConfirmed returns the value of DiscardContentOnWebhookConfirmed.

func (*UpdateAccountInput) GetSpamThreshold 

func (s *UpdateAccountInput) GetSpamThreshold() OptNilFloat64

GetSpamThreshold returns the value of SpamThreshold.

func (*UpdateAccountInput) MarshalJSON 

func (s *UpdateAccountInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateAccountInput) SetDiscardContentOnWebhookConfirmed 

func (s *UpdateAccountInput) SetDiscardContentOnWebhookConfirmed(val OptBool)

SetDiscardContentOnWebhookConfirmed sets the value of DiscardContentOnWebhookConfirmed.

func (*UpdateAccountInput) SetSpamThreshold 

func (s *UpdateAccountInput) SetSpamThreshold(val OptNilFloat64)

SetSpamThreshold sets the value of SpamThreshold.

func (*UpdateAccountInput) UnmarshalJSON 

func (s *UpdateAccountInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateAccountInput) Validate 

func (s *UpdateAccountInput) Validate() error

type UpdateAccountNotFound 

type UpdateAccountNotFound ErrorResponse

func (*UpdateAccountNotFound) Decode 

func (s *UpdateAccountNotFound) Decode(d *jx.Decoder) error

Decode decodes UpdateAccountNotFound from json.

func (*UpdateAccountNotFound) Encode 

func (s *UpdateAccountNotFound) Encode(e *jx.Encoder)

Encode encodes UpdateAccountNotFound as json.

func (*UpdateAccountNotFound) MarshalJSON 

func (s *UpdateAccountNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateAccountNotFound) UnmarshalJSON 

func (s *UpdateAccountNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateAccountNotFound) Validate 

func (s *UpdateAccountNotFound) Validate() error

type UpdateAccountOK 

type UpdateAccountOK struct {
	Success bool           `json:"success"`
	Data    AccountUpdated `json:"data"`
}

Merged schema.

func (*UpdateAccountOK) Decode 

func (s *UpdateAccountOK) Decode(d *jx.Decoder) error

Decode decodes UpdateAccountOK from json.

func (*UpdateAccountOK) Encode 

func (s *UpdateAccountOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateAccountOK) GetData 

func (s *UpdateAccountOK) GetData() AccountUpdated

GetData returns the value of Data.

func (*UpdateAccountOK) GetSuccess 

func (s *UpdateAccountOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*UpdateAccountOK) MarshalJSON 

func (s *UpdateAccountOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateAccountOK) SetData 

func (s *UpdateAccountOK) SetData(val AccountUpdated)

SetData sets the value of Data.

func (*UpdateAccountOK) SetSuccess 

func (s *UpdateAccountOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*UpdateAccountOK) UnmarshalJSON 

func (s *UpdateAccountOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateAccountOK) Validate 

func (s *UpdateAccountOK) Validate() error

type UpdateAccountRes 

type UpdateAccountRes interface {
	// contains filtered or unexported methods
}

type UpdateAccountUnauthorized 

type UpdateAccountUnauthorized ErrorResponse

func (*UpdateAccountUnauthorized) Decode 

func (s *UpdateAccountUnauthorized) Decode(d *jx.Decoder) error

Decode decodes UpdateAccountUnauthorized from json.

func (*UpdateAccountUnauthorized) Encode 

func (s *UpdateAccountUnauthorized) Encode(e *jx.Encoder)

Encode encodes UpdateAccountUnauthorized as json.

func (*UpdateAccountUnauthorized) MarshalJSON 

func (s *UpdateAccountUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateAccountUnauthorized) UnmarshalJSON 

func (s *UpdateAccountUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateAccountUnauthorized) Validate 

func (s *UpdateAccountUnauthorized) Validate() error

type UpdateDomainBadRequest 

type UpdateDomainBadRequest ErrorResponse

func (*UpdateDomainBadRequest) Decode 

func (s *UpdateDomainBadRequest) Decode(d *jx.Decoder) error

Decode decodes UpdateDomainBadRequest from json.

func (*UpdateDomainBadRequest) Encode 

func (s *UpdateDomainBadRequest) Encode(e *jx.Encoder)

Encode encodes UpdateDomainBadRequest as json.

func (*UpdateDomainBadRequest) MarshalJSON 

func (s *UpdateDomainBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateDomainBadRequest) UnmarshalJSON 

func (s *UpdateDomainBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateDomainBadRequest) Validate 

func (s *UpdateDomainBadRequest) Validate() error

type UpdateDomainInput 

type UpdateDomainInput struct {
	// Whether the domain accepts incoming emails.
	IsActive OptBool `json:"is_active"`
	// Per-domain spam threshold override (Pro plan required).
	SpamThreshold OptNilFloat64 `json:"spam_threshold"`
}

Ref: #/components/schemas/UpdateDomainInput

func (*UpdateDomainInput) Decode 

func (s *UpdateDomainInput) Decode(d *jx.Decoder) error

Decode decodes UpdateDomainInput from json.

func (*UpdateDomainInput) Encode 

func (s *UpdateDomainInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateDomainInput) GetIsActive 

func (s *UpdateDomainInput) GetIsActive() OptBool

GetIsActive returns the value of IsActive.

func (*UpdateDomainInput) GetSpamThreshold 

func (s *UpdateDomainInput) GetSpamThreshold() OptNilFloat64

GetSpamThreshold returns the value of SpamThreshold.

func (*UpdateDomainInput) MarshalJSON 

func (s *UpdateDomainInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateDomainInput) SetIsActive 

func (s *UpdateDomainInput) SetIsActive(val OptBool)

SetIsActive sets the value of IsActive.

func (*UpdateDomainInput) SetSpamThreshold 

func (s *UpdateDomainInput) SetSpamThreshold(val OptNilFloat64)

SetSpamThreshold sets the value of SpamThreshold.

func (*UpdateDomainInput) UnmarshalJSON 

func (s *UpdateDomainInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateDomainInput) Validate 

func (s *UpdateDomainInput) Validate() error

type UpdateDomainNotFound 

type UpdateDomainNotFound ErrorResponse

func (*UpdateDomainNotFound) Decode 

func (s *UpdateDomainNotFound) Decode(d *jx.Decoder) error

Decode decodes UpdateDomainNotFound from json.

func (*UpdateDomainNotFound) Encode 

func (s *UpdateDomainNotFound) Encode(e *jx.Encoder)

Encode encodes UpdateDomainNotFound as json.

func (*UpdateDomainNotFound) MarshalJSON 

func (s *UpdateDomainNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateDomainNotFound) UnmarshalJSON 

func (s *UpdateDomainNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateDomainNotFound) Validate 

func (s *UpdateDomainNotFound) Validate() error

type UpdateDomainOK 

type UpdateDomainOK struct {
	Success bool           `json:"success"`
	Data    VerifiedDomain `json:"data"`
}

Merged schema.

func (*UpdateDomainOK) Decode 

func (s *UpdateDomainOK) Decode(d *jx.Decoder) error

Decode decodes UpdateDomainOK from json.

func (*UpdateDomainOK) Encode 

func (s *UpdateDomainOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateDomainOK) GetData 

func (s *UpdateDomainOK) GetData() VerifiedDomain

GetData returns the value of Data.

func (*UpdateDomainOK) GetSuccess 

func (s *UpdateDomainOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*UpdateDomainOK) MarshalJSON 

func (s *UpdateDomainOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateDomainOK) SetData 

func (s *UpdateDomainOK) SetData(val VerifiedDomain)

SetData sets the value of Data.

func (*UpdateDomainOK) SetSuccess 

func (s *UpdateDomainOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*UpdateDomainOK) UnmarshalJSON 

func (s *UpdateDomainOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateDomainOK) Validate 

func (s *UpdateDomainOK) Validate() error

type UpdateDomainParams 

type UpdateDomainParams struct {
	// Resource UUID.
	ID uuid.UUID
}

UpdateDomainParams is parameters of updateDomain operation.

type UpdateDomainRes 

type UpdateDomainRes interface {
	// contains filtered or unexported methods
}

type UpdateDomainUnauthorized 

type UpdateDomainUnauthorized ErrorResponse

func (*UpdateDomainUnauthorized) Decode 

func (s *UpdateDomainUnauthorized) Decode(d *jx.Decoder) error

Decode decodes UpdateDomainUnauthorized from json.

func (*UpdateDomainUnauthorized) Encode 

func (s *UpdateDomainUnauthorized) Encode(e *jx.Encoder)

Encode encodes UpdateDomainUnauthorized as json.

func (*UpdateDomainUnauthorized) MarshalJSON 

func (s *UpdateDomainUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateDomainUnauthorized) UnmarshalJSON 

func (s *UpdateDomainUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateDomainUnauthorized) Validate 

func (s *UpdateDomainUnauthorized) Validate() error

type UpdateEndpointBadRequest 

type UpdateEndpointBadRequest ErrorResponse

func (*UpdateEndpointBadRequest) Decode 

func (s *UpdateEndpointBadRequest) Decode(d *jx.Decoder) error

Decode decodes UpdateEndpointBadRequest from json.

func (*UpdateEndpointBadRequest) Encode 

func (s *UpdateEndpointBadRequest) Encode(e *jx.Encoder)

Encode encodes UpdateEndpointBadRequest as json.

func (*UpdateEndpointBadRequest) MarshalJSON 

func (s *UpdateEndpointBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateEndpointBadRequest) UnmarshalJSON 

func (s *UpdateEndpointBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateEndpointBadRequest) Validate 

func (s *UpdateEndpointBadRequest) Validate() error

type UpdateEndpointInput 

type UpdateEndpointInput struct {
	// New webhook URL (triggers endpoint rotation).
	URL      OptString                 `json:"url"`
	Enabled  OptBool                   `json:"enabled"`
	DomainID OptNilUUID                `json:"domain_id"`
	Rules    *UpdateEndpointInputRules `json:"rules"`
}

Ref: #/components/schemas/UpdateEndpointInput

func (*UpdateEndpointInput) Decode 

func (s *UpdateEndpointInput) Decode(d *jx.Decoder) error

Decode decodes UpdateEndpointInput from json.

func (*UpdateEndpointInput) Encode 

func (s *UpdateEndpointInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateEndpointInput) GetDomainID 

func (s *UpdateEndpointInput) GetDomainID() OptNilUUID

GetDomainID returns the value of DomainID.

func (*UpdateEndpointInput) GetEnabled 

func (s *UpdateEndpointInput) GetEnabled() OptBool

GetEnabled returns the value of Enabled.

func (*UpdateEndpointInput) GetRules 

func (s *UpdateEndpointInput) GetRules() *UpdateEndpointInputRules

GetRules returns the value of Rules.

func (*UpdateEndpointInput) GetURL 

func (s *UpdateEndpointInput) GetURL() OptString

GetURL returns the value of URL.

func (*UpdateEndpointInput) MarshalJSON 

func (s *UpdateEndpointInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateEndpointInput) SetDomainID 

func (s *UpdateEndpointInput) SetDomainID(val OptNilUUID)

SetDomainID sets the value of DomainID.

func (*UpdateEndpointInput) SetEnabled 

func (s *UpdateEndpointInput) SetEnabled(val OptBool)

SetEnabled sets the value of Enabled.

func (*UpdateEndpointInput) SetRules 

func (s *UpdateEndpointInput) SetRules(val *UpdateEndpointInputRules)

SetRules sets the value of Rules.

func (*UpdateEndpointInput) SetURL 

func (s *UpdateEndpointInput) SetURL(val OptString)

SetURL sets the value of URL.

func (*UpdateEndpointInput) UnmarshalJSON 

func (s *UpdateEndpointInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateEndpointInput) Validate 

func (s *UpdateEndpointInput) Validate() error

type UpdateEndpointInputRules 

type UpdateEndpointInputRules struct{}

func (*UpdateEndpointInputRules) Decode 

func (s *UpdateEndpointInputRules) Decode(d *jx.Decoder) error

Decode decodes UpdateEndpointInputRules from json.

func (*UpdateEndpointInputRules) Encode 

func (s *UpdateEndpointInputRules) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateEndpointInputRules) MarshalJSON 

func (s *UpdateEndpointInputRules) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateEndpointInputRules) UnmarshalJSON 

func (s *UpdateEndpointInputRules) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type UpdateEndpointNotFound 

type UpdateEndpointNotFound ErrorResponse

func (*UpdateEndpointNotFound) Decode 

func (s *UpdateEndpointNotFound) Decode(d *jx.Decoder) error

Decode decodes UpdateEndpointNotFound from json.

func (*UpdateEndpointNotFound) Encode 

func (s *UpdateEndpointNotFound) Encode(e *jx.Encoder)

Encode encodes UpdateEndpointNotFound as json.

func (*UpdateEndpointNotFound) MarshalJSON 

func (s *UpdateEndpointNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateEndpointNotFound) UnmarshalJSON 

func (s *UpdateEndpointNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateEndpointNotFound) Validate 

func (s *UpdateEndpointNotFound) Validate() error

type UpdateEndpointOK 

type UpdateEndpointOK struct {
	Success bool     `json:"success"`
	Data    Endpoint `json:"data"`
}

Merged schema.

func (*UpdateEndpointOK) Decode 

func (s *UpdateEndpointOK) Decode(d *jx.Decoder) error

Decode decodes UpdateEndpointOK from json.

func (*UpdateEndpointOK) Encode 

func (s *UpdateEndpointOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateEndpointOK) GetData 

func (s *UpdateEndpointOK) GetData() Endpoint

GetData returns the value of Data.

func (*UpdateEndpointOK) GetSuccess 

func (s *UpdateEndpointOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*UpdateEndpointOK) MarshalJSON 

func (s *UpdateEndpointOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateEndpointOK) SetData 

func (s *UpdateEndpointOK) SetData(val Endpoint)

SetData sets the value of Data.

func (*UpdateEndpointOK) SetSuccess 

func (s *UpdateEndpointOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*UpdateEndpointOK) UnmarshalJSON 

func (s *UpdateEndpointOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type UpdateEndpointParams 

type UpdateEndpointParams struct {
	// Resource UUID.
	ID uuid.UUID
}

UpdateEndpointParams is parameters of updateEndpoint operation.

type UpdateEndpointRes 

type UpdateEndpointRes interface {
	// contains filtered or unexported methods
}

type UpdateEndpointUnauthorized 

type UpdateEndpointUnauthorized ErrorResponse

func (*UpdateEndpointUnauthorized) Decode 

func (s *UpdateEndpointUnauthorized) Decode(d *jx.Decoder) error

Decode decodes UpdateEndpointUnauthorized from json.

func (*UpdateEndpointUnauthorized) Encode 

func (s *UpdateEndpointUnauthorized) Encode(e *jx.Encoder)

Encode encodes UpdateEndpointUnauthorized as json.

func (*UpdateEndpointUnauthorized) MarshalJSON 

func (s *UpdateEndpointUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateEndpointUnauthorized) UnmarshalJSON 

func (s *UpdateEndpointUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateEndpointUnauthorized) Validate 

func (s *UpdateEndpointUnauthorized) Validate() error

type UpdateFilterBadRequest 

type UpdateFilterBadRequest ErrorResponse

func (*UpdateFilterBadRequest) Decode 

func (s *UpdateFilterBadRequest) Decode(d *jx.Decoder) error

Decode decodes UpdateFilterBadRequest from json.

func (*UpdateFilterBadRequest) Encode 

func (s *UpdateFilterBadRequest) Encode(e *jx.Encoder)

Encode encodes UpdateFilterBadRequest as json.

func (*UpdateFilterBadRequest) MarshalJSON 

func (s *UpdateFilterBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFilterBadRequest) UnmarshalJSON 

func (s *UpdateFilterBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFilterBadRequest) Validate 

func (s *UpdateFilterBadRequest) Validate() error

type UpdateFilterInput 

type UpdateFilterInput struct {
	Enabled bool `json:"enabled"`
}

Ref: #/components/schemas/UpdateFilterInput

func (*UpdateFilterInput) Decode 

func (s *UpdateFilterInput) Decode(d *jx.Decoder) error

Decode decodes UpdateFilterInput from json.

func (*UpdateFilterInput) Encode 

func (s *UpdateFilterInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateFilterInput) GetEnabled 

func (s *UpdateFilterInput) GetEnabled() bool

GetEnabled returns the value of Enabled.

func (*UpdateFilterInput) MarshalJSON 

func (s *UpdateFilterInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFilterInput) SetEnabled 

func (s *UpdateFilterInput) SetEnabled(val bool)

SetEnabled sets the value of Enabled.

func (*UpdateFilterInput) UnmarshalJSON 

func (s *UpdateFilterInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type UpdateFilterNotFound 

type UpdateFilterNotFound ErrorResponse

func (*UpdateFilterNotFound) Decode 

func (s *UpdateFilterNotFound) Decode(d *jx.Decoder) error

Decode decodes UpdateFilterNotFound from json.

func (*UpdateFilterNotFound) Encode 

func (s *UpdateFilterNotFound) Encode(e *jx.Encoder)

Encode encodes UpdateFilterNotFound as json.

func (*UpdateFilterNotFound) MarshalJSON 

func (s *UpdateFilterNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFilterNotFound) UnmarshalJSON 

func (s *UpdateFilterNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFilterNotFound) Validate 

func (s *UpdateFilterNotFound) Validate() error

type UpdateFilterOK 

type UpdateFilterOK struct {
	Success bool   `json:"success"`
	Data    Filter `json:"data"`
}

Merged schema.

func (*UpdateFilterOK) Decode 

func (s *UpdateFilterOK) Decode(d *jx.Decoder) error

Decode decodes UpdateFilterOK from json.

func (*UpdateFilterOK) Encode 

func (s *UpdateFilterOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateFilterOK) GetData 

func (s *UpdateFilterOK) GetData() Filter

GetData returns the value of Data.

func (*UpdateFilterOK) GetSuccess 

func (s *UpdateFilterOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*UpdateFilterOK) MarshalJSON 

func (s *UpdateFilterOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFilterOK) SetData 

func (s *UpdateFilterOK) SetData(val Filter)

SetData sets the value of Data.

func (*UpdateFilterOK) SetSuccess 

func (s *UpdateFilterOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*UpdateFilterOK) UnmarshalJSON 

func (s *UpdateFilterOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFilterOK) Validate 

func (s *UpdateFilterOK) Validate() error

type UpdateFilterParams 

type UpdateFilterParams struct {
	// Resource UUID.
	ID uuid.UUID
}

UpdateFilterParams is parameters of updateFilter operation.

type UpdateFilterRes 

type UpdateFilterRes interface {
	// contains filtered or unexported methods
}

type UpdateFilterUnauthorized 

type UpdateFilterUnauthorized ErrorResponse

func (*UpdateFilterUnauthorized) Decode 

func (s *UpdateFilterUnauthorized) Decode(d *jx.Decoder) error

Decode decodes UpdateFilterUnauthorized from json.

func (*UpdateFilterUnauthorized) Encode 

func (s *UpdateFilterUnauthorized) Encode(e *jx.Encoder)

Encode encodes UpdateFilterUnauthorized as json.

func (*UpdateFilterUnauthorized) MarshalJSON 

func (s *UpdateFilterUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFilterUnauthorized) UnmarshalJSON 

func (s *UpdateFilterUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFilterUnauthorized) Validate 

func (s *UpdateFilterUnauthorized) Validate() error

type UpdateFunctionBadRequest added in v0.20.0 

type UpdateFunctionBadRequest ErrorResponse

func (*UpdateFunctionBadRequest) Decode added in v0.20.0 

func (s *UpdateFunctionBadRequest) Decode(d *jx.Decoder) error

Decode decodes UpdateFunctionBadRequest from json.

func (*UpdateFunctionBadRequest) Encode added in v0.20.0 

func (s *UpdateFunctionBadRequest) Encode(e *jx.Encoder)

Encode encodes UpdateFunctionBadRequest as json.

func (*UpdateFunctionBadRequest) MarshalJSON added in v0.20.0 

func (s *UpdateFunctionBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFunctionBadRequest) UnmarshalJSON added in v0.20.0 

func (s *UpdateFunctionBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFunctionBadRequest) Validate added in v0.20.0 

func (s *UpdateFunctionBadRequest) Validate() error

type UpdateFunctionFailedDependency added in v0.28.0 

type UpdateFunctionFailedDependency ErrorResponse

func (*UpdateFunctionFailedDependency) Decode added in v0.28.0 

func (s *UpdateFunctionFailedDependency) Decode(d *jx.Decoder) error

Decode decodes UpdateFunctionFailedDependency from json.

func (*UpdateFunctionFailedDependency) Encode added in v0.28.0 

func (s *UpdateFunctionFailedDependency) Encode(e *jx.Encoder)

Encode encodes UpdateFunctionFailedDependency as json.

func (*UpdateFunctionFailedDependency) MarshalJSON added in v0.28.0 

func (s *UpdateFunctionFailedDependency) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFunctionFailedDependency) UnmarshalJSON added in v0.28.0 

func (s *UpdateFunctionFailedDependency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFunctionFailedDependency) Validate added in v0.28.0 

func (s *UpdateFunctionFailedDependency) Validate() error

type UpdateFunctionInput added in v0.20.0 

type UpdateFunctionInput struct {
	// New bundled handler. Same rules as CreateFunctionInput.code.
	Code      string    `json:"code"`
	SourceMap OptString `json:"sourceMap"`
}

Ref: #/components/schemas/UpdateFunctionInput

func (*UpdateFunctionInput) Decode added in v0.20.0 

func (s *UpdateFunctionInput) Decode(d *jx.Decoder) error

Decode decodes UpdateFunctionInput from json.

func (*UpdateFunctionInput) Encode added in v0.20.0 

func (s *UpdateFunctionInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateFunctionInput) GetCode added in v0.20.0 

func (s *UpdateFunctionInput) GetCode() string

GetCode returns the value of Code.

func (*UpdateFunctionInput) GetSourceMap added in v0.20.0 

func (s *UpdateFunctionInput) GetSourceMap() OptString

GetSourceMap returns the value of SourceMap.

func (*UpdateFunctionInput) MarshalJSON added in v0.20.0 

func (s *UpdateFunctionInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFunctionInput) SetCode added in v0.20.0 

func (s *UpdateFunctionInput) SetCode(val string)

SetCode sets the value of Code.

func (*UpdateFunctionInput) SetSourceMap added in v0.20.0 

func (s *UpdateFunctionInput) SetSourceMap(val OptString)

SetSourceMap sets the value of SourceMap.

func (*UpdateFunctionInput) UnmarshalJSON added in v0.20.0 

func (s *UpdateFunctionInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFunctionInput) Validate added in v0.20.0 

func (s *UpdateFunctionInput) Validate() error

type UpdateFunctionNotFound added in v0.20.0 

type UpdateFunctionNotFound ErrorResponse

func (*UpdateFunctionNotFound) Decode added in v0.20.0 

func (s *UpdateFunctionNotFound) Decode(d *jx.Decoder) error

Decode decodes UpdateFunctionNotFound from json.

func (*UpdateFunctionNotFound) Encode added in v0.20.0 

func (s *UpdateFunctionNotFound) Encode(e *jx.Encoder)

Encode encodes UpdateFunctionNotFound as json.

func (*UpdateFunctionNotFound) MarshalJSON added in v0.20.0 

func (s *UpdateFunctionNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFunctionNotFound) UnmarshalJSON added in v0.20.0 

func (s *UpdateFunctionNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFunctionNotFound) Validate added in v0.20.0 

func (s *UpdateFunctionNotFound) Validate() error

type UpdateFunctionOK added in v0.20.0 

type UpdateFunctionOK struct {
	Success bool           `json:"success"`
	Data    FunctionDetail `json:"data"`
}

Merged schema.

func (*UpdateFunctionOK) Decode added in v0.20.0 

func (s *UpdateFunctionOK) Decode(d *jx.Decoder) error

Decode decodes UpdateFunctionOK from json.

func (*UpdateFunctionOK) Encode added in v0.20.0 

func (s *UpdateFunctionOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UpdateFunctionOK) GetData added in v0.20.0 

func (s *UpdateFunctionOK) GetData() FunctionDetail

GetData returns the value of Data.

func (*UpdateFunctionOK) GetSuccess added in v0.20.0 

func (s *UpdateFunctionOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*UpdateFunctionOK) MarshalJSON added in v0.20.0 

func (s *UpdateFunctionOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFunctionOK) SetData added in v0.20.0 

func (s *UpdateFunctionOK) SetData(val FunctionDetail)

SetData sets the value of Data.

func (*UpdateFunctionOK) SetSuccess added in v0.20.0 

func (s *UpdateFunctionOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*UpdateFunctionOK) UnmarshalJSON added in v0.20.0 

func (s *UpdateFunctionOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFunctionOK) Validate added in v0.20.0 

func (s *UpdateFunctionOK) Validate() error

type UpdateFunctionParams added in v0.20.0 

type UpdateFunctionParams struct {
	// Resource UUID.
	ID uuid.UUID
}

UpdateFunctionParams is parameters of updateFunction operation.

type UpdateFunctionRes added in v0.20.0 

type UpdateFunctionRes interface {
	// contains filtered or unexported methods
}

type UpdateFunctionServiceUnavailable added in v0.28.0 

type UpdateFunctionServiceUnavailable ErrorResponse

func (*UpdateFunctionServiceUnavailable) Decode added in v0.28.0 

func (s *UpdateFunctionServiceUnavailable) Decode(d *jx.Decoder) error

Decode decodes UpdateFunctionServiceUnavailable from json.

func (*UpdateFunctionServiceUnavailable) Encode added in v0.28.0 

func (s *UpdateFunctionServiceUnavailable) Encode(e *jx.Encoder)

Encode encodes UpdateFunctionServiceUnavailable as json.

func (*UpdateFunctionServiceUnavailable) MarshalJSON added in v0.28.0 

func (s *UpdateFunctionServiceUnavailable) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFunctionServiceUnavailable) UnmarshalJSON added in v0.28.0 

func (s *UpdateFunctionServiceUnavailable) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFunctionServiceUnavailable) Validate added in v0.28.0 

func (s *UpdateFunctionServiceUnavailable) Validate() error

type UpdateFunctionTooManyRequests added in v0.28.0 

type UpdateFunctionTooManyRequests ErrorResponse

func (*UpdateFunctionTooManyRequests) Decode added in v0.28.0 

func (s *UpdateFunctionTooManyRequests) Decode(d *jx.Decoder) error

Decode decodes UpdateFunctionTooManyRequests from json.

func (*UpdateFunctionTooManyRequests) Encode added in v0.28.0 

func (s *UpdateFunctionTooManyRequests) Encode(e *jx.Encoder)

Encode encodes UpdateFunctionTooManyRequests as json.

func (*UpdateFunctionTooManyRequests) MarshalJSON added in v0.28.0 

func (s *UpdateFunctionTooManyRequests) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFunctionTooManyRequests) UnmarshalJSON added in v0.28.0 

func (s *UpdateFunctionTooManyRequests) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFunctionTooManyRequests) Validate added in v0.28.0 

func (s *UpdateFunctionTooManyRequests) Validate() error

type UpdateFunctionUnauthorized added in v0.20.0 

type UpdateFunctionUnauthorized ErrorResponse

func (*UpdateFunctionUnauthorized) Decode added in v0.20.0 

func (s *UpdateFunctionUnauthorized) Decode(d *jx.Decoder) error

Decode decodes UpdateFunctionUnauthorized from json.

func (*UpdateFunctionUnauthorized) Encode added in v0.20.0 

func (s *UpdateFunctionUnauthorized) Encode(e *jx.Encoder)

Encode encodes UpdateFunctionUnauthorized as json.

func (*UpdateFunctionUnauthorized) MarshalJSON added in v0.20.0 

func (s *UpdateFunctionUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UpdateFunctionUnauthorized) UnmarshalJSON added in v0.20.0 

func (s *UpdateFunctionUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*UpdateFunctionUnauthorized) Validate added in v0.20.0 

func (s *UpdateFunctionUnauthorized) Validate() error

type VerifiedDomain 

type VerifiedDomain struct {
	ID                uuid.UUID     `json:"id"`
	OrgID             uuid.UUID     `json:"org_id"`
	Domain            string        `json:"domain"`
	Verified          bool          `json:"verified"`
	IsActive          bool          `json:"is_active"`
	SpamThreshold     OptNilFloat64 `json:"spam_threshold"`
	VerificationToken OptNilString  `json:"verification_token"`
	CreatedAt         time.Time     `json:"created_at"`
}

Ref: #/components/schemas/VerifiedDomain

func (*VerifiedDomain) Decode 

func (s *VerifiedDomain) Decode(d *jx.Decoder) error

Decode decodes VerifiedDomain from json.

func (*VerifiedDomain) Encode 

func (s *VerifiedDomain) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*VerifiedDomain) GetCreatedAt 

func (s *VerifiedDomain) GetCreatedAt() time.Time

GetCreatedAt returns the value of CreatedAt.

func (*VerifiedDomain) GetDomain 

func (s *VerifiedDomain) GetDomain() string

GetDomain returns the value of Domain.

func (*VerifiedDomain) GetID 

func (s *VerifiedDomain) GetID() uuid.UUID

GetID returns the value of ID.

func (*VerifiedDomain) GetIsActive 

func (s *VerifiedDomain) GetIsActive() bool

GetIsActive returns the value of IsActive.

func (*VerifiedDomain) GetOrgID 

func (s *VerifiedDomain) GetOrgID() uuid.UUID

GetOrgID returns the value of OrgID.

func (*VerifiedDomain) GetSpamThreshold 

func (s *VerifiedDomain) GetSpamThreshold() OptNilFloat64

GetSpamThreshold returns the value of SpamThreshold.

func (*VerifiedDomain) GetVerificationToken 

func (s *VerifiedDomain) GetVerificationToken() OptNilString

GetVerificationToken returns the value of VerificationToken.

func (*VerifiedDomain) GetVerified 

func (s *VerifiedDomain) GetVerified() bool

GetVerified returns the value of Verified.

func (*VerifiedDomain) MarshalJSON 

func (s *VerifiedDomain) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifiedDomain) SetCreatedAt 

func (s *VerifiedDomain) SetCreatedAt(val time.Time)

SetCreatedAt sets the value of CreatedAt.

func (*VerifiedDomain) SetDomain 

func (s *VerifiedDomain) SetDomain(val string)

SetDomain sets the value of Domain.

func (*VerifiedDomain) SetID 

func (s *VerifiedDomain) SetID(val uuid.UUID)

SetID sets the value of ID.

func (*VerifiedDomain) SetIsActive 

func (s *VerifiedDomain) SetIsActive(val bool)

SetIsActive sets the value of IsActive.

func (*VerifiedDomain) SetOrgID 

func (s *VerifiedDomain) SetOrgID(val uuid.UUID)

SetOrgID sets the value of OrgID.

func (*VerifiedDomain) SetSpamThreshold 

func (s *VerifiedDomain) SetSpamThreshold(val OptNilFloat64)

SetSpamThreshold sets the value of SpamThreshold.

func (*VerifiedDomain) SetVerificationToken 

func (s *VerifiedDomain) SetVerificationToken(val OptNilString)

SetVerificationToken sets the value of VerificationToken.

func (*VerifiedDomain) SetVerified 

func (s *VerifiedDomain) SetVerified(val bool)

SetVerified sets the value of Verified.

func (*VerifiedDomain) UnmarshalJSON 

func (s *VerifiedDomain) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifiedDomain) Validate 

func (s *VerifiedDomain) Validate() error

type VerifyAgentSignupBadRequest added in v0.29.2 

type VerifyAgentSignupBadRequest ErrorResponse

func (*VerifyAgentSignupBadRequest) Decode added in v0.29.2 

func (s *VerifyAgentSignupBadRequest) Decode(d *jx.Decoder) error

Decode decodes VerifyAgentSignupBadRequest from json.

func (*VerifyAgentSignupBadRequest) Encode added in v0.29.2 

func (s *VerifyAgentSignupBadRequest) Encode(e *jx.Encoder)

Encode encodes VerifyAgentSignupBadRequest as json.

func (*VerifyAgentSignupBadRequest) MarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyAgentSignupBadRequest) UnmarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyAgentSignupBadRequest) Validate added in v0.29.2 

func (s *VerifyAgentSignupBadRequest) Validate() error

type VerifyAgentSignupConflict added in v0.29.2 

type VerifyAgentSignupConflict ErrorResponse

func (*VerifyAgentSignupConflict) Decode added in v0.29.2 

func (s *VerifyAgentSignupConflict) Decode(d *jx.Decoder) error

Decode decodes VerifyAgentSignupConflict from json.

func (*VerifyAgentSignupConflict) Encode added in v0.29.2 

func (s *VerifyAgentSignupConflict) Encode(e *jx.Encoder)

Encode encodes VerifyAgentSignupConflict as json.

func (*VerifyAgentSignupConflict) MarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupConflict) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyAgentSignupConflict) UnmarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupConflict) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyAgentSignupConflict) Validate added in v0.29.2 

func (s *VerifyAgentSignupConflict) Validate() error

type VerifyAgentSignupForbidden added in v0.29.2 

type VerifyAgentSignupForbidden ErrorResponse

func (*VerifyAgentSignupForbidden) Decode added in v0.29.2 

func (s *VerifyAgentSignupForbidden) Decode(d *jx.Decoder) error

Decode decodes VerifyAgentSignupForbidden from json.

func (*VerifyAgentSignupForbidden) Encode added in v0.29.2 

func (s *VerifyAgentSignupForbidden) Encode(e *jx.Encoder)

Encode encodes VerifyAgentSignupForbidden as json.

func (*VerifyAgentSignupForbidden) MarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyAgentSignupForbidden) UnmarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyAgentSignupForbidden) Validate added in v0.29.2 

func (s *VerifyAgentSignupForbidden) Validate() error

type VerifyAgentSignupInput added in v0.29.2 

type VerifyAgentSignupInput struct {
	SignupToken      string `json:"signup_token"`
	VerificationCode string `json:"verification_code"`
	// Optional workspace id to target when the verified email already belongs to multiple workspaces.
	OrgID OptUUID `json:"org_id"`
}

Ref: #/components/schemas/VerifyAgentSignupInput

func (*VerifyAgentSignupInput) Decode added in v0.29.2 

func (s *VerifyAgentSignupInput) Decode(d *jx.Decoder) error

Decode decodes VerifyAgentSignupInput from json.

func (*VerifyAgentSignupInput) Encode added in v0.29.2 

func (s *VerifyAgentSignupInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*VerifyAgentSignupInput) GetOrgID added in v0.29.2 

func (s *VerifyAgentSignupInput) GetOrgID() OptUUID

GetOrgID returns the value of OrgID.

func (*VerifyAgentSignupInput) GetSignupToken added in v0.29.2 

func (s *VerifyAgentSignupInput) GetSignupToken() string

GetSignupToken returns the value of SignupToken.

func (*VerifyAgentSignupInput) GetVerificationCode added in v0.29.2 

func (s *VerifyAgentSignupInput) GetVerificationCode() string

GetVerificationCode returns the value of VerificationCode.

func (*VerifyAgentSignupInput) MarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyAgentSignupInput) SetOrgID added in v0.29.2 

func (s *VerifyAgentSignupInput) SetOrgID(val OptUUID)

SetOrgID sets the value of OrgID.

func (*VerifyAgentSignupInput) SetSignupToken added in v0.29.2 

func (s *VerifyAgentSignupInput) SetSignupToken(val string)

SetSignupToken sets the value of SignupToken.

func (*VerifyAgentSignupInput) SetVerificationCode added in v0.29.2 

func (s *VerifyAgentSignupInput) SetVerificationCode(val string)

SetVerificationCode sets the value of VerificationCode.

func (*VerifyAgentSignupInput) UnmarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyAgentSignupInput) Validate added in v0.29.2 

func (s *VerifyAgentSignupInput) Validate() error

type VerifyAgentSignupOK added in v0.29.2 

type VerifyAgentSignupOK struct {
	Success bool                    `json:"success"`
	Data    AgentSignupVerifyResult `json:"data"`
}

Merged schema.

func (*VerifyAgentSignupOK) Decode added in v0.29.2 

func (s *VerifyAgentSignupOK) Decode(d *jx.Decoder) error

Decode decodes VerifyAgentSignupOK from json.

func (*VerifyAgentSignupOK) Encode added in v0.29.2 

func (s *VerifyAgentSignupOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*VerifyAgentSignupOK) GetData added in v0.29.2 

func (s *VerifyAgentSignupOK) GetData() AgentSignupVerifyResult

GetData returns the value of Data.

func (*VerifyAgentSignupOK) GetSuccess added in v0.29.2 

func (s *VerifyAgentSignupOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*VerifyAgentSignupOK) MarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyAgentSignupOK) SetData added in v0.29.2 

func (s *VerifyAgentSignupOK) SetData(val AgentSignupVerifyResult)

SetData sets the value of Data.

func (*VerifyAgentSignupOK) SetSuccess added in v0.29.2 

func (s *VerifyAgentSignupOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*VerifyAgentSignupOK) UnmarshalJSON added in v0.29.2 

func (s *VerifyAgentSignupOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyAgentSignupOK) Validate added in v0.29.2 

func (s *VerifyAgentSignupOK) Validate() error

type VerifyAgentSignupOKHeaders added in v0.29.2 

type VerifyAgentSignupOKHeaders struct {
	CacheControl OptString
	Response     VerifyAgentSignupOK
}

VerifyAgentSignupOKHeaders wraps VerifyAgentSignupOK with response headers.

func (*VerifyAgentSignupOKHeaders) GetCacheControl added in v0.29.2 

func (s *VerifyAgentSignupOKHeaders) GetCacheControl() OptString

GetCacheControl returns the value of CacheControl.

func (*VerifyAgentSignupOKHeaders) GetResponse added in v0.29.2 

func (s *VerifyAgentSignupOKHeaders) GetResponse() VerifyAgentSignupOK

GetResponse returns the value of Response.

func (*VerifyAgentSignupOKHeaders) SetCacheControl added in v0.29.2 

func (s *VerifyAgentSignupOKHeaders) SetCacheControl(val OptString)

SetCacheControl sets the value of CacheControl.

func (*VerifyAgentSignupOKHeaders) SetResponse added in v0.29.2 

func (s *VerifyAgentSignupOKHeaders) SetResponse(val VerifyAgentSignupOK)

SetResponse sets the value of Response.

func (*VerifyAgentSignupOKHeaders) Validate added in v0.29.2 

func (s *VerifyAgentSignupOKHeaders) Validate() error

type VerifyAgentSignupRes added in v0.29.2 

type VerifyAgentSignupRes interface {
	// contains filtered or unexported methods
}

type VerifyCliSignupInput added in v0.28.0 

type VerifyCliSignupInput struct {
	SignupToken      string    `json:"signup_token"`
	VerificationCode string    `json:"verification_code"`
	Password         OptString `json:"password"`
}

Ref: #/components/schemas/VerifyCliSignupInput

func (*VerifyCliSignupInput) Decode added in v0.28.0 

func (s *VerifyCliSignupInput) Decode(d *jx.Decoder) error

Decode decodes VerifyCliSignupInput from json.

func (*VerifyCliSignupInput) Encode added in v0.28.0 

func (s *VerifyCliSignupInput) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*VerifyCliSignupInput) GetPassword added in v0.28.0 

func (s *VerifyCliSignupInput) GetPassword() OptString

GetPassword returns the value of Password.

func (*VerifyCliSignupInput) GetSignupToken added in v0.28.0 

func (s *VerifyCliSignupInput) GetSignupToken() string

GetSignupToken returns the value of SignupToken.

func (*VerifyCliSignupInput) GetVerificationCode added in v0.28.0 

func (s *VerifyCliSignupInput) GetVerificationCode() string

GetVerificationCode returns the value of VerificationCode.

func (*VerifyCliSignupInput) MarshalJSON added in v0.28.0 

func (s *VerifyCliSignupInput) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyCliSignupInput) SetPassword added in v0.28.0 

func (s *VerifyCliSignupInput) SetPassword(val OptString)

SetPassword sets the value of Password.

func (*VerifyCliSignupInput) SetSignupToken added in v0.28.0 

func (s *VerifyCliSignupInput) SetSignupToken(val string)

SetSignupToken sets the value of SignupToken.

func (*VerifyCliSignupInput) SetVerificationCode added in v0.28.0 

func (s *VerifyCliSignupInput) SetVerificationCode(val string)

SetVerificationCode sets the value of VerificationCode.

func (*VerifyCliSignupInput) UnmarshalJSON added in v0.28.0 

func (s *VerifyCliSignupInput) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyCliSignupInput) Validate added in v0.28.0 

func (s *VerifyCliSignupInput) Validate() error

type VerifyCliSignupOK added in v0.28.0 

type VerifyCliSignupOK struct {
	Success bool                  `json:"success"`
	Data    CliSignupVerifyResult `json:"data"`
}

Merged schema.

func (*VerifyCliSignupOK) Decode added in v0.28.0 

func (s *VerifyCliSignupOK) Decode(d *jx.Decoder) error

Decode decodes VerifyCliSignupOK from json.

func (*VerifyCliSignupOK) Encode added in v0.28.0 

func (s *VerifyCliSignupOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*VerifyCliSignupOK) GetData added in v0.28.0 

func (s *VerifyCliSignupOK) GetData() CliSignupVerifyResult

GetData returns the value of Data.

func (*VerifyCliSignupOK) GetSuccess added in v0.28.0 

func (s *VerifyCliSignupOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*VerifyCliSignupOK) MarshalJSON added in v0.28.0 

func (s *VerifyCliSignupOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyCliSignupOK) SetData added in v0.28.0 

func (s *VerifyCliSignupOK) SetData(val CliSignupVerifyResult)

SetData sets the value of Data.

func (*VerifyCliSignupOK) SetSuccess added in v0.28.0 

func (s *VerifyCliSignupOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*VerifyCliSignupOK) UnmarshalJSON added in v0.28.0 

func (s *VerifyCliSignupOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyCliSignupOK) Validate added in v0.29.2 

func (s *VerifyCliSignupOK) Validate() error

type VerifyCliSignupOKHeaders added in v0.28.0 

type VerifyCliSignupOKHeaders struct {
	CacheControl OptString
	Response     VerifyCliSignupOK
}

VerifyCliSignupOKHeaders wraps VerifyCliSignupOK with response headers.

func (*VerifyCliSignupOKHeaders) GetCacheControl added in v0.28.0 

func (s *VerifyCliSignupOKHeaders) GetCacheControl() OptString

GetCacheControl returns the value of CacheControl.

func (*VerifyCliSignupOKHeaders) GetResponse added in v0.28.0 

func (s *VerifyCliSignupOKHeaders) GetResponse() VerifyCliSignupOK

GetResponse returns the value of Response.

func (*VerifyCliSignupOKHeaders) SetCacheControl added in v0.28.0 

func (s *VerifyCliSignupOKHeaders) SetCacheControl(val OptString)

SetCacheControl sets the value of CacheControl.

func (*VerifyCliSignupOKHeaders) SetResponse added in v0.28.0 

func (s *VerifyCliSignupOKHeaders) SetResponse(val VerifyCliSignupOK)

SetResponse sets the value of Response.

func (*VerifyCliSignupOKHeaders) Validate added in v0.29.2 

func (s *VerifyCliSignupOKHeaders) Validate() error

type VerifyCliSignupRes added in v0.28.0 

type VerifyCliSignupRes interface {
	// contains filtered or unexported methods
}

type VerifyDomainBadRequest 

type VerifyDomainBadRequest ErrorResponse

func (*VerifyDomainBadRequest) Decode 

func (s *VerifyDomainBadRequest) Decode(d *jx.Decoder) error

Decode decodes VerifyDomainBadRequest from json.

func (*VerifyDomainBadRequest) Encode 

func (s *VerifyDomainBadRequest) Encode(e *jx.Encoder)

Encode encodes VerifyDomainBadRequest as json.

func (*VerifyDomainBadRequest) MarshalJSON 

func (s *VerifyDomainBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyDomainBadRequest) UnmarshalJSON 

func (s *VerifyDomainBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyDomainBadRequest) Validate 

func (s *VerifyDomainBadRequest) Validate() error

type VerifyDomainNotFound 

type VerifyDomainNotFound ErrorResponse

func (*VerifyDomainNotFound) Decode 

func (s *VerifyDomainNotFound) Decode(d *jx.Decoder) error

Decode decodes VerifyDomainNotFound from json.

func (*VerifyDomainNotFound) Encode 

func (s *VerifyDomainNotFound) Encode(e *jx.Encoder)

Encode encodes VerifyDomainNotFound as json.

func (*VerifyDomainNotFound) MarshalJSON 

func (s *VerifyDomainNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyDomainNotFound) UnmarshalJSON 

func (s *VerifyDomainNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyDomainNotFound) Validate 

func (s *VerifyDomainNotFound) Validate() error

type VerifyDomainOK 

type VerifyDomainOK struct {
	Success bool               `json:"success"`
	Data    DomainVerifyResult `json:"data"`
}

Merged schema.

func (*VerifyDomainOK) Decode 

func (s *VerifyDomainOK) Decode(d *jx.Decoder) error

Decode decodes VerifyDomainOK from json.

func (*VerifyDomainOK) Encode 

func (s *VerifyDomainOK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*VerifyDomainOK) GetData 

func (s *VerifyDomainOK) GetData() DomainVerifyResult

GetData returns the value of Data.

func (*VerifyDomainOK) GetSuccess 

func (s *VerifyDomainOK) GetSuccess() bool

GetSuccess returns the value of Success.

func (*VerifyDomainOK) MarshalJSON 

func (s *VerifyDomainOK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyDomainOK) SetData 

func (s *VerifyDomainOK) SetData(val DomainVerifyResult)

SetData sets the value of Data.

func (*VerifyDomainOK) SetSuccess 

func (s *VerifyDomainOK) SetSuccess(val bool)

SetSuccess sets the value of Success.

func (*VerifyDomainOK) UnmarshalJSON 

func (s *VerifyDomainOK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyDomainOK) Validate added in v0.29.2 

func (s *VerifyDomainOK) Validate() error

type VerifyDomainParams 

type VerifyDomainParams struct {
	// Resource UUID.
	ID uuid.UUID
}

VerifyDomainParams is parameters of verifyDomain operation.

type VerifyDomainRes 

type VerifyDomainRes interface {
	// contains filtered or unexported methods
}

type VerifyDomainUnauthorized 

type VerifyDomainUnauthorized ErrorResponse

func (*VerifyDomainUnauthorized) Decode 

func (s *VerifyDomainUnauthorized) Decode(d *jx.Decoder) error

Decode decodes VerifyDomainUnauthorized from json.

func (*VerifyDomainUnauthorized) Encode 

func (s *VerifyDomainUnauthorized) Encode(e *jx.Encoder)

Encode encodes VerifyDomainUnauthorized as json.

func (*VerifyDomainUnauthorized) MarshalJSON 

func (s *VerifyDomainUnauthorized) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*VerifyDomainUnauthorized) UnmarshalJSON 

func (s *VerifyDomainUnauthorized) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*VerifyDomainUnauthorized) Validate 

func (s *VerifyDomainUnauthorized) Validate() error

type WebhookSecret 

type WebhookSecret struct {
	// The webhook signing secret value.
	Secret string `json:"secret"`
}

Ref: #/components/schemas/WebhookSecret

func (*WebhookSecret) Decode 

func (s *WebhookSecret) Decode(d *jx.Decoder) error

Decode decodes WebhookSecret from json.

func (*WebhookSecret) Encode 

func (s *WebhookSecret) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*WebhookSecret) GetSecret 

func (s *WebhookSecret) GetSecret() string

GetSecret returns the value of Secret.

func (*WebhookSecret) MarshalJSON 

func (s *WebhookSecret) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*WebhookSecret) SetSecret 

func (s *WebhookSecret) SetSecret(val string)

SetSecret sets the value of Secret.

func (*WebhookSecret) UnmarshalJSON 

func (s *WebhookSecret) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.