models

package
v1.77.0 Latest Latest
Warning

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

Go to latest
Published: Oct 10, 2025 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file was hand written

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Package svix this file is @generated DO NOT EDIT

Index

Constants

This section is empty.

Variables

View Source
var AppPortalCapabilityFromString = map[string]AppPortalCapability{
	"ViewBase":              APPPORTALCAPABILITY_VIEW_BASE,
	"ViewEndpointSecret":    APPPORTALCAPABILITY_VIEW_ENDPOINT_SECRET,
	"ManageEndpointSecret":  APPPORTALCAPABILITY_MANAGE_ENDPOINT_SECRET,
	"ManageTransformations": APPPORTALCAPABILITY_MANAGE_TRANSFORMATIONS,
	"CreateAttempts":        APPPORTALCAPABILITY_CREATE_ATTEMPTS,
	"ManageEndpoint":        APPPORTALCAPABILITY_MANAGE_ENDPOINT,
}
View Source
var ApplicationAlertEventFromString = map[string]ApplicationAlertEvent{
	"endpoint.disabled":         APPLICATIONALERTEVENT_ENDPOINT_DISABLED,
	"message.attempt.exhausted": APPLICATIONALERTEVENT_MESSAGE_ATTEMPT_EXHAUSTED,
	"stream.sink.disabled":      APPLICATIONALERTEVENT_STREAM_SINK_DISABLED,
}
View Source
var BackgroundTaskStatusFromString = map[string]BackgroundTaskStatus{
	"running":  BACKGROUNDTASKSTATUS_RUNNING,
	"finished": BACKGROUNDTASKSTATUS_FINISHED,
	"failed":   BACKGROUNDTASKSTATUS_FAILED,
}
View Source
var BackgroundTaskTypeFromString = map[string]BackgroundTaskType{
	"endpoint.replay":           BACKGROUNDTASKTYPE_ENDPOINT_REPLAY,
	"endpoint.recover":          BACKGROUNDTASKTYPE_ENDPOINT_RECOVER,
	"application.stats":         BACKGROUNDTASKTYPE_APPLICATION_STATS,
	"message.broadcast":         BACKGROUNDTASKTYPE_MESSAGE_BROADCAST,
	"sdk.generate":              BACKGROUNDTASKTYPE_SDK_GENERATE,
	"event-type.aggregate":      BACKGROUNDTASKTYPE_EVENT_TYPE_AGGREGATE,
	"application.purge_content": BACKGROUNDTASKTYPE_APPLICATION_PURGE_CONTENT,
}
View Source
var BorderRadiusEnumFromString = map[string]BorderRadiusEnum{
	"none": BORDERRADIUSENUM_NONE,
	"lg":   BORDERRADIUSENUM_LG,
	"md":   BORDERRADIUSENUM_MD,
	"sm":   BORDERRADIUSENUM_SM,
	"full": BORDERRADIUSENUM_FULL,
}
View Source
var ConnectorKindFromString = map[string]ConnectorKind{
	"Custom":                  CONNECTORKIND_CUSTOM,
	"AgenticCommerceProtocol": CONNECTORKIND_AGENTIC_COMMERCE_PROTOCOL,
	"CloseCRM":                CONNECTORKIND_CLOSE_CRM,
	"CustomerIO":              CONNECTORKIND_CUSTOMER_IO,
	"Discord":                 CONNECTORKIND_DISCORD,
	"Hubspot":                 CONNECTORKIND_HUBSPOT,
	"Inngest":                 CONNECTORKIND_INNGEST,
	"Loops":                   CONNECTORKIND_LOOPS,
	"Resend":                  CONNECTORKIND_RESEND,
	"Salesforce":              CONNECTORKIND_SALESFORCE,
	"Segment":                 CONNECTORKIND_SEGMENT,
	"Sendgrid":                CONNECTORKIND_SENDGRID,
	"Slack":                   CONNECTORKIND_SLACK,
	"Teams":                   CONNECTORKIND_TEAMS,
	"TriggerDev":              CONNECTORKIND_TRIGGER_DEV,
	"Windmill":                CONNECTORKIND_WINDMILL,
	"Zapier":                  CONNECTORKIND_ZAPIER,
}
View Source
var EndpointDisabledTriggerFromString = map[string]EndpointDisabledTrigger{
	"manual":    ENDPOINTDISABLEDTRIGGER_MANUAL,
	"automatic": ENDPOINTDISABLEDTRIGGER_AUTOMATIC,
}
View Source
var EnvironmentTypeFromString = map[string]EnvironmentType{
	"development": ENVIRONMENTTYPE_DEVELOPMENT,
	"production":  ENVIRONMENTTYPE_PRODUCTION,
}
View Source
var IngestSourceInTypeWithNoConfig = map[string]bool{
	"generic-webhook": true,
}
View Source
var IngestSourceOutTypeWithNoConfig = map[string]bool{
	"generic-webhook": true,
}
View Source
var MessageStatusTextFromString = map[string]MessageStatusText{
	"success": MESSAGESTATUSTEXT_SUCCESS,
	"pending": MESSAGESTATUSTEXT_PENDING,
	"fail":    MESSAGESTATUSTEXT_FAIL,
	"sending": MESSAGESTATUSTEXT_SENDING,
}
View Source
var OrderingFromString = map[string]Ordering{
	"ascending":  ORDERING_ASCENDING,
	"descending": ORDERING_DESCENDING,
}
View Source
var SinkStatusFromString = map[string]SinkStatus{
	"enabled":  SINKSTATUS_ENABLED,
	"paused":   SINKSTATUS_PAUSED,
	"disabled": SINKSTATUS_DISABLED,
	"retrying": SINKSTATUS_RETRYING,
}
View Source
var SinkStatusInFromString = map[string]SinkStatusIn{
	"enabled":  SINKSTATUSIN_ENABLED,
	"disabled": SINKSTATUSIN_DISABLED,
}
View Source
var StreamSinkInTypeFromString = map[string]StreamSinkInType{
	"poller":             StreamSinkInTypePoller,
	"azureBlobStorage":   StreamSinkInTypeAzureBlobStorage,
	"otelTracing":        StreamSinkInTypeOtelTracing,
	"http":               StreamSinkInTypeHttp,
	"amazonS3":           StreamSinkInTypeAmazonS3,
	"googleCloudStorage": StreamSinkInTypeGoogleCloudStorage,
}
View Source
var StreamSinkInTypeWithNoConfig = map[string]bool{
	"poller": true,
}
View Source
var StreamSinkOutTypeFromString = map[string]StreamSinkOutType{
	"poller":             StreamSinkOutTypePoller,
	"azureBlobStorage":   StreamSinkOutTypeAzureBlobStorage,
	"otelTracing":        StreamSinkOutTypeOtelTracing,
	"http":               StreamSinkOutTypeHttp,
	"amazonS3":           StreamSinkOutTypeAmazonS3,
	"googleCloudStorage": StreamSinkOutTypeGoogleCloudStorage,
}
View Source
var StreamSinkOutTypeWithNoConfig = map[string]bool{
	"poller": true,
}
View Source
var StreamSinkPatchTypeFromString = map[string]StreamSinkPatchType{
	"poller":             StreamSinkPatchTypePoller,
	"azureBlobStorage":   StreamSinkPatchTypeAzureBlobStorage,
	"otelTracing":        StreamSinkPatchTypeOtelTracing,
	"http":               StreamSinkPatchTypeHttp,
	"amazonS3":           StreamSinkPatchTypeAmazonS3,
	"googleCloudStorage": StreamSinkPatchTypeGoogleCloudStorage,
}
View Source
var StreamSinkPatchTypeWithNoConfig = map[string]bool{
	"poller": true,
}

Functions

This section is empty.

Types

type AdobeSignConfig added in v1.63.0

type AdobeSignConfig struct {
	ClientId string `json:"clientId"`
}

type AdobeSignConfigOut added in v1.63.0

type AdobeSignConfigOut struct {
}

type AggregateEventTypesOut

type AggregateEventTypesOut struct {
	Id     string               `json:"id"` // The QueueBackgroundTask's ID.
	Status BackgroundTaskStatus `json:"status"`
	Task   BackgroundTaskType   `json:"task"`
}

type AirwallexConfig added in v1.70.0

type AirwallexConfig struct {
	Secret string `json:"secret"`
}

type AirwallexConfigOut added in v1.70.0

type AirwallexConfigOut struct {
}

type AmazonS3PatchConfig added in v1.77.0

type AmazonS3PatchConfig struct {
	AccessKeyId     *string `json:"accessKeyId,omitempty"`
	Bucket          *string `json:"bucket,omitempty"`
	Region          *string `json:"region,omitempty"`
	SecretAccessKey *string `json:"secretAccessKey,omitempty"`
}

type ApiTokenExpireIn added in v1.63.1

type ApiTokenExpireIn struct {
	Expiry *int32 `json:"expiry,omitempty"` // How many seconds until the old key is expired.
}

type ApiTokenIn added in v1.63.1

type ApiTokenIn struct {
	Name   string   `json:"name"`
	Scopes []string `json:"scopes,omitempty"`
}

type ApiTokenOut added in v1.63.1

type ApiTokenOut struct {
	CreatedAt time.Time  `json:"createdAt"`
	ExpiresAt *time.Time `json:"expiresAt,omitempty"`
	Id        string     `json:"id"` // The GlobalApplicationToken's ID.
	Name      *string    `json:"name,omitempty"`
	Scopes    []string   `json:"scopes,omitempty"`
	Token     string     `json:"token"`
}

type AppPortalAccessIn

type AppPortalAccessIn struct {
	// Optionally creates a new application while generating the access link.
	//
	// If the application id or uid that is used in the path already exists, this argument is ignored.
	Application *ApplicationIn `json:"application,omitempty"`
	// Custom capabilities attached to the token, You can combine as many capabilities as necessary.
	//
	// The `ViewBase` capability is always required
	//
	// - `ViewBase`: Basic read only permissions, does not allow the user to see the endpoint secret.
	//
	// - `ViewEndpointSecret`: Allows user to view the endpoint secret.
	//
	// - `ManageEndpointSecret`: Allows user to rotate and view the endpoint secret.
	//
	// - `ManageTransformations`: Allows user to modify the endpoint transformations.
	//
	// - `CreateAttempts`: Allows user to replay missing messages and send example messages.
	//
	// - `ManageEndpoint`: Allows user to read/modify any field or configuration of an endpoint (including secrets)
	Capabilities []AppPortalCapability `json:"capabilities,omitempty"`
	// How long the token will be valid for, in seconds.
	//
	// Valid values are between 1 hour and 7 days. The default is 7 days.
	Expiry       *uint64  `json:"expiry,omitempty"`
	FeatureFlags []string `json:"featureFlags,omitempty"` // The set of feature flags the created token will have access to.
	ReadOnly     *bool    `json:"readOnly,omitempty"`     // Whether the app portal should be in read-only mode.
	// An optional session ID to attach to the token.
	//
	// When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID.
	SessionId *string `json:"sessionId,omitempty"`
}

type AppPortalAccessOut

type AppPortalAccessOut struct {
	Token string `json:"token"`
	Url   string `json:"url"`
}

type AppPortalCapability added in v1.75.1

type AppPortalCapability string
const (
	APPPORTALCAPABILITY_VIEW_BASE              AppPortalCapability = "ViewBase"
	APPPORTALCAPABILITY_VIEW_ENDPOINT_SECRET   AppPortalCapability = "ViewEndpointSecret"
	APPPORTALCAPABILITY_MANAGE_ENDPOINT_SECRET AppPortalCapability = "ManageEndpointSecret"
	APPPORTALCAPABILITY_MANAGE_TRANSFORMATIONS AppPortalCapability = "ManageTransformations"
	APPPORTALCAPABILITY_CREATE_ATTEMPTS        AppPortalCapability = "CreateAttempts"
	APPPORTALCAPABILITY_MANAGE_ENDPOINT        AppPortalCapability = "ManageEndpoint"
)

func (*AppPortalCapability) UnmarshalJSON added in v1.75.1

func (v *AppPortalCapability) UnmarshalJSON(src []byte) error

type AppUsageStatsIn

type AppUsageStatsIn struct {
	// Specific app IDs or UIDs to aggregate stats for.
	//
	// Note that if none of the given IDs or UIDs are resolved, a 422 response will be given.
	AppIds []string  `json:"appIds,omitempty"`
	Since  time.Time `json:"since"`
	Until  time.Time `json:"until"`
}

type AppUsageStatsOut

type AppUsageStatsOut struct {
	Id     string               `json:"id"` // The QueueBackgroundTask's ID.
	Status BackgroundTaskStatus `json:"status"`
	Task   BackgroundTaskType   `json:"task"`
	// Any app IDs or UIDs received in the request that weren't found.
	//
	// Stats will be produced for all the others.
	UnresolvedAppIds []string `json:"unresolvedAppIds"`
}

type ApplicationAlertEvent added in v1.70.0

type ApplicationAlertEvent string
const (
	APPLICATIONALERTEVENT_ENDPOINT_DISABLED         ApplicationAlertEvent = "endpoint.disabled"
	APPLICATIONALERTEVENT_MESSAGE_ATTEMPT_EXHAUSTED ApplicationAlertEvent = "message.attempt.exhausted"
	APPLICATIONALERTEVENT_STREAM_SINK_DISABLED      ApplicationAlertEvent = "stream.sink.disabled"
)

func (*ApplicationAlertEvent) UnmarshalJSON added in v1.70.0

func (v *ApplicationAlertEvent) UnmarshalJSON(src []byte) error

type ApplicationIn

type ApplicationIn struct {
	Metadata  *map[string]string `json:"metadata,omitempty"`
	Name      string             `json:"name"`
	RateLimit *uint16            `json:"rateLimit,omitempty"`
	Uid       *string            `json:"uid,omitempty"` // Optional unique identifier for the application.
}

type ApplicationOut

type ApplicationOut struct {
	CreatedAt time.Time         `json:"createdAt"`
	Id        string            `json:"id"` // The Application's ID.
	Metadata  map[string]string `json:"metadata"`
	Name      string            `json:"name"`
	RateLimit *uint16           `json:"rateLimit,omitempty"`
	Uid       *string           `json:"uid,omitempty"` // The Application's UID.
	UpdatedAt time.Time         `json:"updatedAt"`
}

type ApplicationPatch

type ApplicationPatch struct {
	Metadata  *map[string]string     `json:"metadata,omitempty"`
	Name      *string                `json:"name,omitempty"`
	RateLimit utils.Nullable[uint16] `json:"rateLimit"`
	Uid       utils.Nullable[string] `json:"uid"` // The Application's UID.
}

func (ApplicationPatch) MarshalJSON

func (o ApplicationPatch) MarshalJSON() ([]byte, error)

type ApplicationTokenExpireIn

type ApplicationTokenExpireIn struct {
	Expiry *int64 `json:"expiry,omitempty"` // How many seconds until the old key is expired.
	// An optional list of session ids.
	//
	// If any session ids are specified, only Application tokens created with that session id will be expired.
	SessionIds []string `json:"sessionIds,omitempty"`
}

type AzureBlobStorageConfig added in v1.77.0

type AzureBlobStorageConfig struct {
	AccessKey string `json:"accessKey"`
	Account   string `json:"account"`
	Container string `json:"container"`
}

type AzureBlobStoragePatchConfig added in v1.77.0

type AzureBlobStoragePatchConfig struct {
	AccessKey *string `json:"accessKey,omitempty"`
	Account   *string `json:"account,omitempty"`
	Container *string `json:"container,omitempty"`
}

type BackgroundTaskFinishedEvent added in v1.63.0

type BackgroundTaskFinishedEvent struct {
	Data BackgroundTaskFinishedEvent2 `json:"data"`
	Type string                       `json:"type"`
}

Sent when a background task is finished.

type BackgroundTaskFinishedEvent2 added in v1.63.0

type BackgroundTaskFinishedEvent2 struct {
	Data   map[string]any       `json:"data"`
	Status BackgroundTaskStatus `json:"status"`
	Task   BackgroundTaskType   `json:"task"`
	TaskId string               `json:"taskId"` // The QueueBackgroundTask's ID.
}

type BackgroundTaskOut

type BackgroundTaskOut struct {
	Data   map[string]any       `json:"data"`
	Id     string               `json:"id"` // The QueueBackgroundTask's ID.
	Status BackgroundTaskStatus `json:"status"`
	Task   BackgroundTaskType   `json:"task"`
}

type BackgroundTaskStatus

type BackgroundTaskStatus string
const (
	BACKGROUNDTASKSTATUS_RUNNING  BackgroundTaskStatus = "running"
	BACKGROUNDTASKSTATUS_FINISHED BackgroundTaskStatus = "finished"
	BACKGROUNDTASKSTATUS_FAILED   BackgroundTaskStatus = "failed"
)

func (*BackgroundTaskStatus) UnmarshalJSON

func (v *BackgroundTaskStatus) UnmarshalJSON(src []byte) error

type BackgroundTaskType

type BackgroundTaskType string
const (
	BACKGROUNDTASKTYPE_ENDPOINT_REPLAY           BackgroundTaskType = "endpoint.replay"
	BACKGROUNDTASKTYPE_ENDPOINT_RECOVER          BackgroundTaskType = "endpoint.recover"
	BACKGROUNDTASKTYPE_APPLICATION_STATS         BackgroundTaskType = "application.stats"
	BACKGROUNDTASKTYPE_MESSAGE_BROADCAST         BackgroundTaskType = "message.broadcast"
	BACKGROUNDTASKTYPE_SDK_GENERATE              BackgroundTaskType = "sdk.generate"
	BACKGROUNDTASKTYPE_EVENT_TYPE_AGGREGATE      BackgroundTaskType = "event-type.aggregate"
	BACKGROUNDTASKTYPE_APPLICATION_PURGE_CONTENT BackgroundTaskType = "application.purge_content"
)

func (*BackgroundTaskType) UnmarshalJSON

func (v *BackgroundTaskType) UnmarshalJSON(src []byte) error

type BorderRadiusConfig added in v1.64.1

type BorderRadiusConfig struct {
	Button *BorderRadiusEnum `json:"button,omitempty"`
	Card   *BorderRadiusEnum `json:"card,omitempty"`
	Input  *BorderRadiusEnum `json:"input,omitempty"`
}

type BorderRadiusEnum added in v1.64.1

type BorderRadiusEnum string
const (
	BORDERRADIUSENUM_NONE BorderRadiusEnum = "none"
	BORDERRADIUSENUM_LG   BorderRadiusEnum = "lg"
	BORDERRADIUSENUM_MD   BorderRadiusEnum = "md"
	BORDERRADIUSENUM_SM   BorderRadiusEnum = "sm"
	BORDERRADIUSENUM_FULL BorderRadiusEnum = "full"
)

func (*BorderRadiusEnum) UnmarshalJSON added in v1.64.1

func (v *BorderRadiusEnum) UnmarshalJSON(src []byte) error

type CheckbookConfig added in v1.70.0

type CheckbookConfig struct {
	Secret string `json:"secret"`
}

type CheckbookConfigOut added in v1.70.0

type CheckbookConfigOut struct {
}

type ConnectorIn added in v1.58.2

type ConnectorIn struct {
	Description    *string        `json:"description,omitempty"`
	FeatureFlags   []string       `json:"featureFlags,omitempty"`
	FilterTypes    []string       `json:"filterTypes,omitempty"`
	Instructions   *string        `json:"instructions,omitempty"`
	Kind           *ConnectorKind `json:"kind,omitempty"`
	Name           string         `json:"name"`
	Transformation string         `json:"transformation"`
}

type ConnectorKind added in v1.58.2

type ConnectorKind string
const (
	CONNECTORKIND_CUSTOM                    ConnectorKind = "Custom"
	CONNECTORKIND_AGENTIC_COMMERCE_PROTOCOL ConnectorKind = "AgenticCommerceProtocol"
	CONNECTORKIND_CLOSE_CRM                 ConnectorKind = "CloseCRM"
	CONNECTORKIND_CUSTOMER_IO               ConnectorKind = "CustomerIO"
	CONNECTORKIND_DISCORD                   ConnectorKind = "Discord"
	CONNECTORKIND_HUBSPOT                   ConnectorKind = "Hubspot"
	CONNECTORKIND_INNGEST                   ConnectorKind = "Inngest"
	CONNECTORKIND_LOOPS                     ConnectorKind = "Loops"
	CONNECTORKIND_RESEND                    ConnectorKind = "Resend"
	CONNECTORKIND_SALESFORCE                ConnectorKind = "Salesforce"
	CONNECTORKIND_SEGMENT                   ConnectorKind = "Segment"
	CONNECTORKIND_SENDGRID                  ConnectorKind = "Sendgrid"
	CONNECTORKIND_SLACK                     ConnectorKind = "Slack"
	CONNECTORKIND_TEAMS                     ConnectorKind = "Teams"
	CONNECTORKIND_TRIGGER_DEV               ConnectorKind = "TriggerDev"
	CONNECTORKIND_WINDMILL                  ConnectorKind = "Windmill"
	CONNECTORKIND_ZAPIER                    ConnectorKind = "Zapier"
)

func (*ConnectorKind) UnmarshalJSON added in v1.58.2

func (v *ConnectorKind) UnmarshalJSON(src []byte) error

type ConnectorOut added in v1.63.0

type ConnectorOut struct {
	CreatedAt      time.Time     `json:"createdAt"`
	Description    string        `json:"description"`
	FeatureFlags   []string      `json:"featureFlags,omitempty"`
	FilterTypes    []string      `json:"filterTypes,omitempty"`
	Id             string        `json:"id"` // The Connector's ID.
	Instructions   string        `json:"instructions"`
	Kind           ConnectorKind `json:"kind"`
	Name           string        `json:"name"`
	OrgId          string        `json:"orgId"` // The Environment's ID.
	Transformation string        `json:"transformation"`
	UpdatedAt      time.Time     `json:"updatedAt"`
}

type CreateStreamEventsIn added in v1.77.0

type CreateStreamEventsIn struct {
	Events []EventIn `json:"events"`
	// Optionally creates a new Stream alongside the events.
	//
	// If the stream id or uid that is used in the path already exists, this argument is ignored.
	Stream *StreamIn `json:"stream,omitempty"`
}

type CreateStreamEventsOut added in v1.77.0

type CreateStreamEventsOut struct {
}

type CronConfig added in v1.63.0

type CronConfig struct {
	// Override the default content-type.
	//
	// Recommended if the payload is not JSON.
	ContentType *string `json:"contentType,omitempty"`
	Payload     string  `json:"payload"`
	Schedule    string  `json:"schedule"`
}

type CustomColorPalette added in v1.64.1

type CustomColorPalette struct {
	BackgroundHover     *string `json:"backgroundHover,omitempty"`
	BackgroundPrimary   *string `json:"backgroundPrimary,omitempty"`
	BackgroundSecondary *string `json:"backgroundSecondary,omitempty"`
	ButtonPrimary       *string `json:"buttonPrimary,omitempty"`
	InteractiveAccent   *string `json:"interactiveAccent,omitempty"`
	NavigationAccent    *string `json:"navigationAccent,omitempty"`
	Primary             *string `json:"primary,omitempty"`
	TextDanger          *string `json:"textDanger,omitempty"`
	TextPrimary         *string `json:"textPrimary,omitempty"`
}

type CustomStringsOverride added in v1.64.1

type CustomStringsOverride struct {
	ChannelsHelp *string `json:"channelsHelp,omitempty"`
	ChannelsMany *string `json:"channelsMany,omitempty"`
	ChannelsOne  *string `json:"channelsOne,omitempty"`
}

type CustomThemeOverride added in v1.64.1

type CustomThemeOverride struct {
	BorderRadius *BorderRadiusConfig `json:"borderRadius,omitempty"`
	FontSize     *FontSizeConfig     `json:"fontSize,omitempty"`
}

type DashboardAccessOut

type DashboardAccessOut struct {
	Token string `json:"token"`
	Url   string `json:"url"`
}

type DocusignConfig added in v1.63.0

type DocusignConfig struct {
	Secret *string `json:"secret,omitempty"`
}

type DocusignConfigOut added in v1.63.0

type DocusignConfigOut struct {
}

type EasypostConfig added in v1.70.0

type EasypostConfig struct {
	Secret *string `json:"secret,omitempty"`
}

type EasypostConfigOut added in v1.70.0

type EasypostConfigOut struct {
}

type EmptyResponse added in v1.77.0

type EmptyResponse struct {
}

type EndpointCreatedEvent added in v1.63.0

type EndpointCreatedEvent struct {
	Data EndpointCreatedEventData `json:"data"`
	Type string                   `json:"type"`
}

Sent when an endpoint is created.

type EndpointCreatedEventData added in v1.63.0

type EndpointCreatedEventData struct {
	AppId       string  `json:"appId"`                 // The Application's ID.
	AppUid      *string `json:"appUid,omitempty"`      // The Application's UID.
	EndpointId  string  `json:"endpointId"`            // The Endpoint's ID.
	EndpointUid *string `json:"endpointUid,omitempty"` // The Endpoint's UID.
}

Sent when an endpoint is created, updated, or deleted

type EndpointDeletedEvent added in v1.63.0

type EndpointDeletedEvent struct {
	Data EndpointDeletedEventData `json:"data"`
	Type string                   `json:"type"`
}

Sent when an endpoint is deleted.

type EndpointDeletedEventData added in v1.63.0

type EndpointDeletedEventData struct {
	AppId       string  `json:"appId"`                 // The Application's ID.
	AppUid      *string `json:"appUid,omitempty"`      // The Application's UID.
	EndpointId  string  `json:"endpointId"`            // The Endpoint's ID.
	EndpointUid *string `json:"endpointUid,omitempty"` // The Endpoint's UID.
}

Sent when an endpoint is created, updated, or deleted

type EndpointDisabledEvent added in v1.63.0

type EndpointDisabledEvent struct {
	Data EndpointDisabledEventData `json:"data"`
	Type string                    `json:"type"`
}

Sent when an endpoint has been automatically disabled after continuous failures, or manually via an API call.

type EndpointDisabledEventData added in v1.63.0

type EndpointDisabledEventData struct {
	AppId       string                   `json:"appId"`                 // The Application's ID.
	AppUid      *string                  `json:"appUid,omitempty"`      // The Application's UID.
	EndpointId  string                   `json:"endpointId"`            // The Endpoint's ID.
	EndpointUid *string                  `json:"endpointUid,omitempty"` // The Endpoint's UID.
	FailSince   *time.Time               `json:"failSince,omitempty"`
	Trigger     *EndpointDisabledTrigger `json:"trigger,omitempty"`
}

Sent when an endpoint has been automatically disabled after continuous failures, or manually via an API call.

type EndpointDisabledTrigger added in v1.63.0

type EndpointDisabledTrigger string
const (
	ENDPOINTDISABLEDTRIGGER_MANUAL    EndpointDisabledTrigger = "manual"
	ENDPOINTDISABLEDTRIGGER_AUTOMATIC EndpointDisabledTrigger = "automatic"
)

func (*EndpointDisabledTrigger) UnmarshalJSON added in v1.63.0

func (v *EndpointDisabledTrigger) UnmarshalJSON(src []byte) error

type EndpointEnabledEvent added in v1.63.0

type EndpointEnabledEvent struct {
	Data EndpointEnabledEventData `json:"data"`
	Type string                   `json:"type"`
}

Sent when an endpoint has been enabled.

type EndpointEnabledEventData added in v1.63.0

type EndpointEnabledEventData struct {
	AppId       string  `json:"appId"`                 // The Application's ID.
	AppUid      *string `json:"appUid,omitempty"`      // The Application's UID.
	EndpointId  string  `json:"endpointId"`            // The Endpoint's ID.
	EndpointUid *string `json:"endpointUid,omitempty"` // The Endpoint's UID.
}

Sent when an endpoint has been enabled.

type EndpointHeadersIn

type EndpointHeadersIn struct {
	Headers map[string]string `json:"headers"`
}

type EndpointHeadersOut

type EndpointHeadersOut struct {
	Headers   map[string]string `json:"headers"`
	Sensitive []string          `json:"sensitive"`
}

The value of the headers is returned in the `headers` field.

Sensitive headers that have been redacted are returned in the sensitive field.

type EndpointHeadersPatchIn

type EndpointHeadersPatchIn struct {
	DeleteHeaders []string          `json:"deleteHeaders,omitempty"` // A list of headers be be removed
	Headers       map[string]string `json:"headers"`
}

type EndpointIn

type EndpointIn struct {
	Channels    []string           `json:"channels,omitempty"` // List of message channels this endpoint listens to (omit for all).
	Description *string            `json:"description,omitempty"`
	Disabled    *bool              `json:"disabled,omitempty"`
	FilterTypes []string           `json:"filterTypes,omitempty"`
	Headers     *map[string]string `json:"headers,omitempty"`
	Metadata    *map[string]string `json:"metadata,omitempty"`
	RateLimit   *uint16            `json:"rateLimit,omitempty"`
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Secret  *string `json:"secret,omitempty"`
	Uid     *string `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	Url     string  `json:"url"`
	Version *uint16 `json:"version,omitempty"`
}

type EndpointMessageOut

type EndpointMessageOut struct {
	Channels    []string          `json:"channels,omitempty"` // List of free-form identifiers that endpoints can filter by
	DeliverAt   *time.Time        `json:"deliverAt,omitempty"`
	EventId     *string           `json:"eventId,omitempty"` // Optional unique identifier for the message
	EventType   string            `json:"eventType"`         // The event type's name
	Id          string            `json:"id"`                // The Message's ID.
	NextAttempt *time.Time        `json:"nextAttempt,omitempty"`
	Payload     map[string]any    `json:"payload"`
	Status      MessageStatus     `json:"status"`
	StatusText  MessageStatusText `json:"statusText"`
	Tags        []string          `json:"tags,omitempty"`
	Timestamp   time.Time         `json:"timestamp"`
}

A model containing information on a given message plus additional fields on the last attempt for that message.

type EndpointOut

type EndpointOut struct {
	Channels    []string          `json:"channels,omitempty"` // List of message channels this endpoint listens to (omit for all).
	CreatedAt   time.Time         `json:"createdAt"`
	Description string            `json:"description"` // An example endpoint name.
	Disabled    *bool             `json:"disabled,omitempty"`
	FilterTypes []string          `json:"filterTypes,omitempty"`
	Id          string            `json:"id"` // The Endpoint's ID.
	Metadata    map[string]string `json:"metadata"`
	RateLimit   *uint16           `json:"rateLimit,omitempty"`
	Uid         *string           `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	UpdatedAt   time.Time         `json:"updatedAt"`
	Url         string            `json:"url"`
	Version     int32             `json:"version"`
}

type EndpointPatch

type EndpointPatch struct {
	Channels    utils.Nullable[[]string] `json:"channels"`
	Description *string                  `json:"description,omitempty"`
	Disabled    *bool                    `json:"disabled,omitempty"`
	FilterTypes utils.Nullable[[]string] `json:"filterTypes"`
	Metadata    *map[string]string       `json:"metadata,omitempty"`
	RateLimit   utils.Nullable[uint16]   `json:"rateLimit"`
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Secret  utils.Nullable[string] `json:"secret"`
	Uid     utils.Nullable[string] `json:"uid"` // The Endpoint's UID.
	Url     *string                `json:"url,omitempty"`
	Version *uint16                `json:"version,omitempty"`
}

func (EndpointPatch) MarshalJSON

func (o EndpointPatch) MarshalJSON() ([]byte, error)

type EndpointSecretOut

type EndpointSecretOut struct {
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Key string `json:"key"`
}

type EndpointSecretRotateIn

type EndpointSecretRotateIn struct {
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Key *string `json:"key,omitempty"`
}

type EndpointStats

type EndpointStats struct {
	Fail    int64 `json:"fail"`
	Pending int64 `json:"pending"`
	Sending int64 `json:"sending"`
	Success int64 `json:"success"`
}

type EndpointTransformationIn

type EndpointTransformationIn struct {
	Code    *string `json:"code,omitempty"`
	Enabled *bool   `json:"enabled,omitempty"`
}

type EndpointTransformationOut

type EndpointTransformationOut struct {
	Code    *string `json:"code,omitempty"`
	Enabled *bool   `json:"enabled,omitempty"`
}

type EndpointTransformationPatch added in v1.70.0

type EndpointTransformationPatch struct {
	Code    utils.Nullable[string] `json:"code"`
	Enabled *bool                  `json:"enabled,omitempty"`
}

func (EndpointTransformationPatch) MarshalJSON added in v1.70.0

func (o EndpointTransformationPatch) MarshalJSON() ([]byte, error)

type EndpointUpdate

type EndpointUpdate struct {
	Channels    []string           `json:"channels,omitempty"` // List of message channels this endpoint listens to (omit for all).
	Description *string            `json:"description,omitempty"`
	Disabled    *bool              `json:"disabled,omitempty"`
	FilterTypes []string           `json:"filterTypes,omitempty"`
	Metadata    *map[string]string `json:"metadata,omitempty"`
	RateLimit   *uint16            `json:"rateLimit,omitempty"`
	Uid         *string            `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	Url         string             `json:"url"`
	Version     *uint16            `json:"version,omitempty"`
}

type EndpointUpdatedEvent added in v1.63.0

type EndpointUpdatedEvent struct {
	Data EndpointUpdatedEventData `json:"data"`
	Type string                   `json:"type"`
}

Sent when an endpoint is updated.

type EndpointUpdatedEventData added in v1.63.0

type EndpointUpdatedEventData struct {
	AppId       string  `json:"appId"`                 // The Application's ID.
	AppUid      *string `json:"appUid,omitempty"`      // The Application's UID.
	EndpointId  string  `json:"endpointId"`            // The Endpoint's ID.
	EndpointUid *string `json:"endpointUid,omitempty"` // The Endpoint's UID.
}

Sent when an endpoint is created, updated, or deleted

type EnvironmentIn

type EnvironmentIn struct {
	Connectors []ConnectorIn   `json:"connectors,omitempty"`
	EventTypes []EventTypeIn   `json:"eventTypes,omitempty"`
	Settings   *map[string]any `json:"settings,omitempty"`
}

type EnvironmentModelIn added in v1.64.1

type EnvironmentModelIn struct {
	Name string          `json:"name"`
	Type EnvironmentType `json:"type"`
}

type EnvironmentModelOut added in v1.64.1

type EnvironmentModelOut struct {
	CreatedAt time.Time         `json:"createdAt"`
	Id        string            `json:"id"` // The Environment's ID.
	Name      string            `json:"name"`
	Region    EnvironmentRegion `json:"region"`
	Type      EnvironmentType   `json:"type"`
	UpdatedAt time.Time         `json:"updatedAt"`
}

type EnvironmentModelUpdate added in v1.64.1

type EnvironmentModelUpdate struct {
	Name string `json:"name"`
}

type EnvironmentOut

type EnvironmentOut struct {
	CreatedAt               time.Time       `json:"createdAt"`
	EventTypes              []EventTypeOut  `json:"eventTypes"`
	Settings                *map[string]any `json:"settings,omitempty"`
	TransformationTemplates []ConnectorOut  `json:"transformationTemplates"`
	Version                 *int64          `json:"version,omitempty"`
}

type EnvironmentRegion added in v1.64.1

type EnvironmentRegion string
const (
	ENVIRONMENTREGION_EU          EnvironmentRegion = "eu"
	ENVIRONMENTREGION_US          EnvironmentRegion = "us"
	ENVIRONMENTREGION_IN          EnvironmentRegion = "in"
	ENVIRONMENTREGION_AU          EnvironmentRegion = "au"
	ENVIRONMENTREGION_CA          EnvironmentRegion = "ca"
	ENVIRONMENTREGION_SELF_HOSTED EnvironmentRegion = "self-hosted"
)

func (*EnvironmentRegion) UnmarshalJSON added in v1.64.1

func (v *EnvironmentRegion) UnmarshalJSON(src []byte) error

type EnvironmentType added in v1.64.1

type EnvironmentType string
const (
	ENVIRONMENTTYPE_DEVELOPMENT EnvironmentType = "development"
	ENVIRONMENTTYPE_PRODUCTION  EnvironmentType = "production"
)

func (*EnvironmentType) UnmarshalJSON added in v1.64.1

func (v *EnvironmentType) UnmarshalJSON(src []byte) error

type EventExampleIn

type EventExampleIn struct {
	EventType string `json:"eventType"` // The event type's name
	// If the event type schema contains an array of examples, chooses which one to send.
	//
	// Defaults to the first example. Ignored if the schema doesn't contain an array of examples.
	ExampleIndex *uint64 `json:"exampleIndex,omitempty"`
}

type EventIn added in v1.77.0

type EventIn struct {
	EventType string `json:"eventType"` // The event type's name
	Payload   string `json:"payload"`
}

type EventOut added in v1.77.0

type EventOut struct {
	EventType string    `json:"eventType"` // The event type's name
	Payload   string    `json:"payload"`
	Timestamp time.Time `json:"timestamp"`
}

type EventStreamOut added in v1.77.0

type EventStreamOut struct {
	Data     []EventOut `json:"data"`
	Done     bool       `json:"done"`
	Iterator string     `json:"iterator"`
}

type EventTypeFromOpenApi

type EventTypeFromOpenApi struct {
	Deprecated   bool            `json:"deprecated"`
	Description  string          `json:"description"`
	FeatureFlag  *string         `json:"featureFlag,omitempty"`
	FeatureFlags []string        `json:"featureFlags,omitempty"`
	GroupName    *string         `json:"groupName,omitempty"` // The event type group's name
	Name         string          `json:"name"`                // The event type's name
	Schemas      *map[string]any `json:"schemas,omitempty"`
}

type EventTypeImportOpenApiIn

type EventTypeImportOpenApiIn struct {
	DryRun     *bool           `json:"dryRun,omitempty"`     // If `true`, return the event types that would be modified without actually modifying them.
	ReplaceAll *bool           `json:"replaceAll,omitempty"` // If `true`, all existing event types that are not in the spec will be archived.
	Spec       *map[string]any `json:"spec,omitempty"`       // A pre-parsed JSON spec.
	SpecRaw    *string         `json:"specRaw,omitempty"`    // A string, parsed by the server as YAML or JSON.
}

Import a list of event types from webhooks defined in an OpenAPI spec.

The OpenAPI spec can be specified as either `spec` given the spec as a JSON object, or as `specRaw` (a `string`) which will be parsed as YAML or JSON by the server. Sending neither or both is invalid, resulting in a `400` **Bad Request**.

type EventTypeImportOpenApiOut

type EventTypeImportOpenApiOut struct {
	Data EventTypeImportOpenApiOutData `json:"data"`
}

type EventTypeImportOpenApiOutData

type EventTypeImportOpenApiOutData struct {
	Modified []string               `json:"modified"`
	ToModify []EventTypeFromOpenApi `json:"to_modify,omitempty"`
}

type EventTypeIn

type EventTypeIn struct {
	Archived     *bool           `json:"archived,omitempty"`
	Deprecated   *bool           `json:"deprecated,omitempty"`
	Description  string          `json:"description"`
	FeatureFlag  *string         `json:"featureFlag,omitempty"` // Deprecated - prefer featureFlags instead.
	FeatureFlags []string        `json:"featureFlags,omitempty"`
	GroupName    *string         `json:"groupName,omitempty"` // The event type group's name
	Name         string          `json:"name"`                // The event type's name
	Schemas      *map[string]any `json:"schemas,omitempty"`   // The schema for the event type for a specific version as a JSON schema.
}

type EventTypeOut

type EventTypeOut struct {
	Archived     *bool           `json:"archived,omitempty"`
	CreatedAt    time.Time       `json:"createdAt"`
	Deprecated   bool            `json:"deprecated"`
	Description  string          `json:"description"`
	FeatureFlag  *string         `json:"featureFlag,omitempty"`
	FeatureFlags []string        `json:"featureFlags,omitempty"`
	GroupName    *string         `json:"groupName,omitempty"` // The event type group's name
	Name         string          `json:"name"`                // The event type's name
	Schemas      *map[string]any `json:"schemas,omitempty"`   // The schema for the event type for a specific version as a JSON schema.
	UpdatedAt    time.Time       `json:"updatedAt"`
}

type EventTypePatch

type EventTypePatch struct {
	Archived     *bool                          `json:"archived,omitempty"`
	Deprecated   *bool                          `json:"deprecated,omitempty"`
	Description  *string                        `json:"description,omitempty"`
	FeatureFlag  utils.Nullable[string]         `json:"featureFlag"`
	FeatureFlags utils.Nullable[[]string]       `json:"featureFlags"`
	GroupName    utils.Nullable[string]         `json:"groupName"` // The event type group's name
	Schemas      utils.Nullable[map[string]any] `json:"schemas"`
}

func (EventTypePatch) MarshalJSON

func (o EventTypePatch) MarshalJSON() ([]byte, error)

type EventTypeUpdate

type EventTypeUpdate struct {
	Archived     *bool           `json:"archived,omitempty"`
	Deprecated   *bool           `json:"deprecated,omitempty"`
	Description  string          `json:"description"`
	FeatureFlag  *string         `json:"featureFlag,omitempty"`
	FeatureFlags []string        `json:"featureFlags,omitempty"`
	GroupName    *string         `json:"groupName,omitempty"` // The event type group's name
	Schemas      *map[string]any `json:"schemas,omitempty"`   // The schema for the event type for a specific version as a JSON schema.
}

type ExpungeAllContentsOut added in v1.61.1

type ExpungeAllContentsOut struct {
	Id     string               `json:"id"` // The QueueBackgroundTask's ID.
	Status BackgroundTaskStatus `json:"status"`
	Task   BackgroundTaskType   `json:"task"`
}

type FontSizeConfig added in v1.64.1

type FontSizeConfig struct {
	Base *uint16 `json:"base,omitempty"`
}

type GithubConfig added in v1.63.0

type GithubConfig struct {
	Secret *string `json:"secret,omitempty"`
}

type GithubConfigOut added in v1.63.0

type GithubConfigOut struct {
}

type GoogleCloudStorageConfig added in v1.77.0

type GoogleCloudStorageConfig struct {
	Bucket      string `json:"bucket"`
	Credentials string `json:"credentials"` // Google Cloud Credentials JSON Object as a string.
}

Configuration for a Google Cloud Storage sink.

Write stream events into the named bucket using the supplied Google Cloud credentials.

type GoogleCloudStoragePatchConfig added in v1.77.0

type GoogleCloudStoragePatchConfig struct {
	Bucket      *string `json:"bucket,omitempty"`
	Credentials *string `json:"credentials,omitempty"`
}

type HttpPatchConfig added in v1.77.0

type HttpPatchConfig struct {
	Url *string `json:"url,omitempty"`
}

type HttpSinkHeadersPatchIn added in v1.77.0

type HttpSinkHeadersPatchIn struct {
	Headers map[string]string `json:"headers"`
}

type HubspotConfig added in v1.63.0

type HubspotConfig struct {
	Secret *string `json:"secret,omitempty"`
}

type HubspotConfigOut added in v1.63.0

type HubspotConfigOut struct {
}

type IngestEndpointDisabledEvent added in v1.77.0

type IngestEndpointDisabledEvent struct {
	Data IngestEndpointDisabledEventData `json:"data"`
	Type string                          `json:"type"`
}

Sent when an ingest endpoint has been automatically disabled after continuous failures, or manually via an API call.

type IngestEndpointDisabledEventData added in v1.77.0

type IngestEndpointDisabledEventData struct {
	EndpointId  string                   `json:"endpointId"`            // The Endpoint's ID.
	EndpointUid *string                  `json:"endpointUid,omitempty"` // The Endpoint's UID.
	FailSince   *time.Time               `json:"failSince,omitempty"`
	SourceId    string                   `json:"sourceId"` // The Source's ID.
	Trigger     *EndpointDisabledTrigger `json:"trigger,omitempty"`
}

Sent when an ingest endpoint has been automatically disabled after continuous failures, or manually via an API call.

type IngestEndpointHeadersIn added in v1.61.1

type IngestEndpointHeadersIn struct {
	Headers map[string]string `json:"headers"`
}

type IngestEndpointHeadersOut added in v1.61.1

type IngestEndpointHeadersOut struct {
	Headers   map[string]string `json:"headers"`
	Sensitive []string          `json:"sensitive"`
}

type IngestEndpointIn added in v1.61.1

type IngestEndpointIn struct {
	Description *string            `json:"description,omitempty"`
	Disabled    *bool              `json:"disabled,omitempty"`
	Metadata    *map[string]string `json:"metadata,omitempty"`
	RateLimit   *uint16            `json:"rateLimit,omitempty"`
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Secret *string `json:"secret,omitempty"`
	Uid    *string `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	Url    string  `json:"url"`
}

type IngestEndpointOut added in v1.61.1

type IngestEndpointOut struct {
	CreatedAt   time.Time         `json:"createdAt"`
	Description string            `json:"description"` // An example endpoint name.
	Disabled    *bool             `json:"disabled,omitempty"`
	Id          string            `json:"id"` // The Endpoint's ID.
	Metadata    map[string]string `json:"metadata"`
	RateLimit   *uint16           `json:"rateLimit,omitempty"`
	Uid         *string           `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	UpdatedAt   time.Time         `json:"updatedAt"`
	Url         string            `json:"url"`
}

type IngestEndpointSecretIn added in v1.61.1

type IngestEndpointSecretIn struct {
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Key *string `json:"key,omitempty"`
}

type IngestEndpointSecretOut added in v1.61.1

type IngestEndpointSecretOut struct {
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Key string `json:"key"`
}

type IngestEndpointTransformationOut added in v1.75.1

type IngestEndpointTransformationOut struct {
	Code    *string `json:"code,omitempty"`
	Enabled *bool   `json:"enabled,omitempty"`
}

type IngestEndpointTransformationPatch added in v1.75.1

type IngestEndpointTransformationPatch struct {
	Code    utils.Nullable[string] `json:"code"`
	Enabled *bool                  `json:"enabled,omitempty"`
}

func (IngestEndpointTransformationPatch) MarshalJSON added in v1.75.1

func (o IngestEndpointTransformationPatch) MarshalJSON() ([]byte, error)

type IngestEndpointUpdate added in v1.61.1

type IngestEndpointUpdate struct {
	Description *string            `json:"description,omitempty"`
	Disabled    *bool              `json:"disabled,omitempty"`
	Metadata    *map[string]string `json:"metadata,omitempty"`
	RateLimit   *uint16            `json:"rateLimit,omitempty"`
	Uid         *string            `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	Url         string             `json:"url"`
}

type IngestMessageAttemptExhaustedEvent added in v1.77.0

type IngestMessageAttemptExhaustedEvent struct {
	Data IngestMessageAttemptExhaustedEventData `json:"data"`
	Type string                                 `json:"type"`
}

Sent when a message delivery has failed (all of the retry attempts have been exhausted).

type IngestMessageAttemptExhaustedEventData added in v1.77.0

type IngestMessageAttemptExhaustedEventData struct {
	EndpointId  string                   `json:"endpointId"` // The Endpoint's ID.
	LastAttempt MessageAttemptFailedData `json:"lastAttempt"`
	MsgEventId  *string                  `json:"msgEventId,omitempty"` // The Message's UID.
	MsgId       string                   `json:"msgId"`                // The Message's ID.
	SourceId    string                   `json:"sourceId"`             // The Source's ID.
}

Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "ingest.message.attempt.exhausted" type, after it's failed four times as a "ingest.message.attempt.failing" event, or after it's recovered as a "ingest.message.attempt.recovered" event.

type IngestMessageAttemptFailingEvent added in v1.77.0

type IngestMessageAttemptFailingEvent struct {
	Data IngestMessageAttemptFailingEventData `json:"data"`
	Type string                               `json:"type"`
}

Sent after a message has been failing for a few times. It's sent on the fourth failure. It complements `ingest.message.attempt.exhausted` which is sent after the last failure.

type IngestMessageAttemptFailingEventData added in v1.77.0

type IngestMessageAttemptFailingEventData struct {
	EndpointId  string                   `json:"endpointId"` // The Endpoint's ID.
	LastAttempt MessageAttemptFailedData `json:"lastAttempt"`
	MsgEventId  *string                  `json:"msgEventId,omitempty"` // The Message's UID.
	MsgId       string                   `json:"msgId"`                // The Message's ID.
	SourceId    string                   `json:"sourceId"`             // The Source's ID.
}

Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "ingest.message.attempt.exhausted" type, after it's failed four times as a "ingest.message.attempt.failing" event, or after it's recovered as a "ingest.message.attempt.recovered" event.

type IngestMessageAttemptRecoveredEvent added in v1.77.0

type IngestMessageAttemptRecoveredEvent struct {
	Data IngestMessageAttemptRecoveredEventData `json:"data"`
	Type string                                 `json:"type"`
}

Sent on a successful dispatch after an earlier failure op webhook has already been sent.

type IngestMessageAttemptRecoveredEventData added in v1.77.0

type IngestMessageAttemptRecoveredEventData struct {
	EndpointId  string                   `json:"endpointId"` // The Endpoint's ID.
	LastAttempt MessageAttemptFailedData `json:"lastAttempt"`
	MsgEventId  *string                  `json:"msgEventId,omitempty"` // The Message's UID.
	MsgId       string                   `json:"msgId"`                // The Message's ID.
	SourceId    string                   `json:"sourceId"`             // The Source's ID.
}

Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "ingest.message.attempt.exhausted" type, after it's failed four times as a "ingest.message.attempt.failing" event, or after it's recovered as a "ingest.message.attempt.recovered" event.

type IngestSourceConsumerPortalAccessIn added in v1.63.0

type IngestSourceConsumerPortalAccessIn struct {
	// How long the token will be valid for, in seconds.
	//
	// Valid values are between 1 hour and 7 days. The default is 7 days.
	Expiry   *uint64 `json:"expiry,omitempty"`
	ReadOnly *bool   `json:"readOnly,omitempty"` // Whether the app portal should be in read-only mode.
}

type IngestSourceIn added in v1.63.0

type IngestSourceIn struct {
	Metadata *map[string]string   `json:"metadata,omitempty"`
	Name     string               `json:"name"`
	Uid      *string              `json:"uid,omitempty"` // The Source's UID.
	Type     IngestSourceInType   `json:"type"`
	Config   IngestSourceInConfig `json:"config"`
}

When creating an IngestSourceIn, use the appropriate config structure based on the Type:

  • "generic-webhook": No config needed (nil or just ignore the config field)
  • "adobe-sign": Use AdobeSignConfig
  • "airwallex": Use AirwallexConfig
  • "checkbook": Use CheckbookConfig
  • "cron": Use CronConfig
  • "docusign": Use DocusignConfig
  • "easypost": Use EasypostConfig
  • "github": Use GithubConfig
  • "hubspot": Use HubspotConfig
  • "orum-io": Use OrumIoConfig
  • "panda-doc": Use PandaDocConfig
  • "port-io": Use PortIoConfig
  • "rutter": Use RutterConfig
  • "segment": Use SegmentConfig
  • "shopify": Use ShopifyConfig
  • "slack": Use SlackConfig
  • "stripe": Use StripeConfig
  • "beehiiv","brex","clerk","guesty","incident-io","lithic","nash","pleo","replicate","resend","safebase","sardine","stych","svix","open-ai","render": Use SvixConfig
  • "telnyx": Use TelnyxConfig
  • "vapi": Use VapiConfig
  • "veriff": Use VeriffConfig
  • "zoom": Use ZoomConfig

func (IngestSourceIn) MarshalJSON added in v1.63.0

func (i IngestSourceIn) MarshalJSON() ([]byte, error)

func (*IngestSourceIn) UnmarshalJSON added in v1.63.0

func (i *IngestSourceIn) UnmarshalJSON(data []byte) error

type IngestSourceInConfig added in v1.63.0

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

type IngestSourceInType added in v1.63.0

type IngestSourceInType string
const (
	IngestSourceInTypeGenericWebhook IngestSourceInType = "generic-webhook"
	IngestSourceInTypeCron           IngestSourceInType = "cron"
	IngestSourceInTypeAdobeSign      IngestSourceInType = "adobe-sign"
	IngestSourceInTypeBeehiiv        IngestSourceInType = "beehiiv"
	IngestSourceInTypeBrex           IngestSourceInType = "brex"
	IngestSourceInTypeCheckbook      IngestSourceInType = "checkbook"
	IngestSourceInTypeClerk          IngestSourceInType = "clerk"
	IngestSourceInTypeDocusign       IngestSourceInType = "docusign"
	IngestSourceInTypeEasypost       IngestSourceInType = "easypost"
	IngestSourceInTypeGithub         IngestSourceInType = "github"
	IngestSourceInTypeGuesty         IngestSourceInType = "guesty"
	IngestSourceInTypeHubspot        IngestSourceInType = "hubspot"
	IngestSourceInTypeIncidentIo     IngestSourceInType = "incident-io"
	IngestSourceInTypeLithic         IngestSourceInType = "lithic"
	IngestSourceInTypeNash           IngestSourceInType = "nash"
	IngestSourceInTypeOrumIo         IngestSourceInType = "orum-io"
	IngestSourceInTypePandaDoc       IngestSourceInType = "panda-doc"
	IngestSourceInTypePortIo         IngestSourceInType = "port-io"
	IngestSourceInTypePleo           IngestSourceInType = "pleo"
	IngestSourceInTypeReplicate      IngestSourceInType = "replicate"
	IngestSourceInTypeResend         IngestSourceInType = "resend"
	IngestSourceInTypeRutter         IngestSourceInType = "rutter"
	IngestSourceInTypeSafebase       IngestSourceInType = "safebase"
	IngestSourceInTypeSardine        IngestSourceInType = "sardine"
	IngestSourceInTypeSegment        IngestSourceInType = "segment"
	IngestSourceInTypeShopify        IngestSourceInType = "shopify"
	IngestSourceInTypeSlack          IngestSourceInType = "slack"
	IngestSourceInTypeStripe         IngestSourceInType = "stripe"
	IngestSourceInTypeStych          IngestSourceInType = "stych"
	IngestSourceInTypeSvix           IngestSourceInType = "svix"
	IngestSourceInTypeZoom           IngestSourceInType = "zoom"
	IngestSourceInTypeTelnyx         IngestSourceInType = "telnyx"
	IngestSourceInTypeVapi           IngestSourceInType = "vapi"
	IngestSourceInTypeOpenAi         IngestSourceInType = "open-ai"
	IngestSourceInTypeRender         IngestSourceInType = "render"
	IngestSourceInTypeVeriff         IngestSourceInType = "veriff"
	IngestSourceInTypeAirwallex      IngestSourceInType = "airwallex"
)

type IngestSourceOut added in v1.63.0

type IngestSourceOut struct {
	CreatedAt time.Time             `json:"createdAt"`
	Id        string                `json:"id"` // The Source's ID.
	IngestUrl *string               `json:"ingestUrl,omitempty"`
	Metadata  map[string]string     `json:"metadata"`
	Name      string                `json:"name"`
	Uid       *string               `json:"uid,omitempty"` // The Source's UID.
	UpdatedAt time.Time             `json:"updatedAt"`
	Type      IngestSourceOutType   `json:"type"`
	Config    IngestSourceOutConfig `json:"config"`
}

When creating an IngestSourceOut, use the appropriate config structure based on the Type:

  • "generic-webhook": No config needed (nil or just ignore the config field)
  • "adobe-sign": Use AdobeSignConfigOut
  • "airwallex": Use AirwallexConfigOut
  • "checkbook": Use CheckbookConfigOut
  • "cron": Use CronConfig
  • "docusign": Use DocusignConfigOut
  • "easypost": Use EasypostConfigOut
  • "github": Use GithubConfigOut
  • "hubspot": Use HubspotConfigOut
  • "orum-io": Use OrumIoConfigOut
  • "panda-doc": Use PandaDocConfigOut
  • "port-io": Use PortIoConfigOut
  • "rutter": Use RutterConfigOut
  • "segment": Use SegmentConfigOut
  • "shopify": Use ShopifyConfigOut
  • "slack": Use SlackConfigOut
  • "stripe": Use StripeConfigOut
  • "beehiiv","brex","clerk","guesty","incident-io","lithic","nash","pleo","replicate","resend","safebase","sardine","stych","svix","open-ai","render": Use SvixConfigOut
  • "telnyx": Use TelnyxConfigOut
  • "vapi": Use VapiConfigOut
  • "veriff": Use VeriffConfigOut
  • "zoom": Use ZoomConfigOut

func (IngestSourceOut) MarshalJSON added in v1.63.0

func (i IngestSourceOut) MarshalJSON() ([]byte, error)

func (*IngestSourceOut) UnmarshalJSON added in v1.63.0

func (i *IngestSourceOut) UnmarshalJSON(data []byte) error

type IngestSourceOutConfig added in v1.63.0

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

type IngestSourceOutType added in v1.63.0

type IngestSourceOutType string
const (
	IngestSourceOutTypeGenericWebhook IngestSourceOutType = "generic-webhook"
	IngestSourceOutTypeCron           IngestSourceOutType = "cron"
	IngestSourceOutTypeAdobeSign      IngestSourceOutType = "adobe-sign"
	IngestSourceOutTypeBeehiiv        IngestSourceOutType = "beehiiv"
	IngestSourceOutTypeBrex           IngestSourceOutType = "brex"
	IngestSourceOutTypeCheckbook      IngestSourceOutType = "checkbook"
	IngestSourceOutTypeClerk          IngestSourceOutType = "clerk"
	IngestSourceOutTypeDocusign       IngestSourceOutType = "docusign"
	IngestSourceOutTypeEasypost       IngestSourceOutType = "easypost"
	IngestSourceOutTypeGithub         IngestSourceOutType = "github"
	IngestSourceOutTypeGuesty         IngestSourceOutType = "guesty"
	IngestSourceOutTypeHubspot        IngestSourceOutType = "hubspot"
	IngestSourceOutTypeIncidentIo     IngestSourceOutType = "incident-io"
	IngestSourceOutTypeLithic         IngestSourceOutType = "lithic"
	IngestSourceOutTypeNash           IngestSourceOutType = "nash"
	IngestSourceOutTypeOrumIo         IngestSourceOutType = "orum-io"
	IngestSourceOutTypePandaDoc       IngestSourceOutType = "panda-doc"
	IngestSourceOutTypePortIo         IngestSourceOutType = "port-io"
	IngestSourceOutTypePleo           IngestSourceOutType = "pleo"
	IngestSourceOutTypeReplicate      IngestSourceOutType = "replicate"
	IngestSourceOutTypeResend         IngestSourceOutType = "resend"
	IngestSourceOutTypeRutter         IngestSourceOutType = "rutter"
	IngestSourceOutTypeSafebase       IngestSourceOutType = "safebase"
	IngestSourceOutTypeSardine        IngestSourceOutType = "sardine"
	IngestSourceOutTypeSegment        IngestSourceOutType = "segment"
	IngestSourceOutTypeShopify        IngestSourceOutType = "shopify"
	IngestSourceOutTypeSlack          IngestSourceOutType = "slack"
	IngestSourceOutTypeStripe         IngestSourceOutType = "stripe"
	IngestSourceOutTypeStych          IngestSourceOutType = "stych"
	IngestSourceOutTypeSvix           IngestSourceOutType = "svix"
	IngestSourceOutTypeZoom           IngestSourceOutType = "zoom"
	IngestSourceOutTypeTelnyx         IngestSourceOutType = "telnyx"
	IngestSourceOutTypeVapi           IngestSourceOutType = "vapi"
	IngestSourceOutTypeOpenAi         IngestSourceOutType = "open-ai"
	IngestSourceOutTypeRender         IngestSourceOutType = "render"
	IngestSourceOutTypeVeriff         IngestSourceOutType = "veriff"
	IngestSourceOutTypeAirwallex      IngestSourceOutType = "airwallex"
)

type IntegrationIn

type IntegrationIn struct {
	FeatureFlags []string `json:"featureFlags,omitempty"` // The set of feature flags the integration will have access to.
	Name         string   `json:"name"`
}

type IntegrationKeyOut

type IntegrationKeyOut struct {
	Key string `json:"key"`
}

type IntegrationOut

type IntegrationOut struct {
	CreatedAt    time.Time `json:"createdAt"`
	FeatureFlags []string  `json:"featureFlags,omitempty"` // The set of feature flags the integration has access to.
	Id           string    `json:"id"`                     // The Integration's ID.
	Name         string    `json:"name"`
	UpdatedAt    time.Time `json:"updatedAt"`
}

type IntegrationUpdate

type IntegrationUpdate struct {
	FeatureFlags []string `json:"featureFlags,omitempty"` // The set of feature flags the integration will have access to.
	Name         string   `json:"name"`
}

type ListResponseApplicationOut

type ListResponseApplicationOut struct {
	Data         []ApplicationOut `json:"data"`
	Done         bool             `json:"done"`
	Iterator     *string          `json:"iterator,omitempty"`
	PrevIterator *string          `json:"prevIterator,omitempty"`
}

type ListResponseBackgroundTaskOut

type ListResponseBackgroundTaskOut struct {
	Data         []BackgroundTaskOut `json:"data"`
	Done         bool                `json:"done"`
	Iterator     *string             `json:"iterator,omitempty"`
	PrevIterator *string             `json:"prevIterator,omitempty"`
}

type ListResponseEndpointMessageOut

type ListResponseEndpointMessageOut struct {
	Data         []EndpointMessageOut `json:"data"`
	Done         bool                 `json:"done"`
	Iterator     *string              `json:"iterator,omitempty"`
	PrevIterator *string              `json:"prevIterator,omitempty"`
}

type ListResponseEndpointOut

type ListResponseEndpointOut struct {
	Data         []EndpointOut `json:"data"`
	Done         bool          `json:"done"`
	Iterator     *string       `json:"iterator,omitempty"`
	PrevIterator *string       `json:"prevIterator,omitempty"`
}

type ListResponseEnvironmentModelOut added in v1.64.1

type ListResponseEnvironmentModelOut struct {
	Data         []EnvironmentModelOut `json:"data"`
	Done         bool                  `json:"done"`
	Iterator     *string               `json:"iterator,omitempty"`
	PrevIterator *string               `json:"prevIterator,omitempty"`
}

type ListResponseEventTypeOut

type ListResponseEventTypeOut struct {
	Data         []EventTypeOut `json:"data"`
	Done         bool           `json:"done"`
	Iterator     *string        `json:"iterator,omitempty"`
	PrevIterator *string        `json:"prevIterator,omitempty"`
}

type ListResponseIngestEndpointOut added in v1.61.1

type ListResponseIngestEndpointOut struct {
	Data         []IngestEndpointOut `json:"data"`
	Done         bool                `json:"done"`
	Iterator     *string             `json:"iterator,omitempty"`
	PrevIterator *string             `json:"prevIterator,omitempty"`
}

type ListResponseIngestSourceOut added in v1.63.0

type ListResponseIngestSourceOut struct {
	Data         []IngestSourceOut `json:"data"`
	Done         bool              `json:"done"`
	Iterator     *string           `json:"iterator,omitempty"`
	PrevIterator *string           `json:"prevIterator,omitempty"`
}

type ListResponseIntegrationOut

type ListResponseIntegrationOut struct {
	Data         []IntegrationOut `json:"data"`
	Done         bool             `json:"done"`
	Iterator     *string          `json:"iterator,omitempty"`
	PrevIterator *string          `json:"prevIterator,omitempty"`
}

type ListResponseMessageAttemptOut

type ListResponseMessageAttemptOut struct {
	Data         []MessageAttemptOut `json:"data"`
	Done         bool                `json:"done"`
	Iterator     *string             `json:"iterator,omitempty"`
	PrevIterator *string             `json:"prevIterator,omitempty"`
}

type ListResponseMessageEndpointOut

type ListResponseMessageEndpointOut struct {
	Data         []MessageEndpointOut `json:"data"`
	Done         bool                 `json:"done"`
	Iterator     *string              `json:"iterator,omitempty"`
	PrevIterator *string              `json:"prevIterator,omitempty"`
}

type ListResponseMessageOut

type ListResponseMessageOut struct {
	Data         []MessageOut `json:"data"`
	Done         bool         `json:"done"`
	Iterator     *string      `json:"iterator,omitempty"`
	PrevIterator *string      `json:"prevIterator,omitempty"`
}

type ListResponseOperationalWebhookEndpointOut

type ListResponseOperationalWebhookEndpointOut struct {
	Data         []OperationalWebhookEndpointOut `json:"data"`
	Done         bool                            `json:"done"`
	Iterator     *string                         `json:"iterator,omitempty"`
	PrevIterator *string                         `json:"prevIterator,omitempty"`
}

type ListResponseStreamEventTypeOut added in v1.77.0

type ListResponseStreamEventTypeOut struct {
	Data         []StreamEventTypeOut `json:"data"`
	Done         bool                 `json:"done"`
	Iterator     *string              `json:"iterator,omitempty"`
	PrevIterator *string              `json:"prevIterator,omitempty"`
}

type ListResponseStreamOut added in v1.77.0

type ListResponseStreamOut struct {
	Data         []StreamOut `json:"data"`
	Done         bool        `json:"done"`
	Iterator     *string     `json:"iterator,omitempty"`
	PrevIterator *string     `json:"prevIterator,omitempty"`
}

type ListResponseStreamSinkOut added in v1.77.0

type ListResponseStreamSinkOut struct {
	Data         []StreamSinkOut `json:"data"`
	Done         bool            `json:"done"`
	Iterator     *string         `json:"iterator,omitempty"`
	PrevIterator *string         `json:"prevIterator,omitempty"`
}

type MessageAttemptExhaustedEvent added in v1.63.0

type MessageAttemptExhaustedEvent struct {
	Data MessageAttemptExhaustedEventData `json:"data"`
	Type string                           `json:"type"`
}

Sent when a message delivery has failed (all of the retry attempts have been exhausted).

type MessageAttemptExhaustedEventData added in v1.63.0

type MessageAttemptExhaustedEventData struct {
	AppId       string                   `json:"appId"`            // The Application's ID.
	AppUid      *string                  `json:"appUid,omitempty"` // The Application's UID.
	EndpointId  string                   `json:"endpointId"`       // The Endpoint's ID.
	LastAttempt MessageAttemptFailedData `json:"lastAttempt"`
	MsgEventId  *string                  `json:"msgEventId,omitempty"` // The Message's UID.
	MsgId       string                   `json:"msgId"`                // The Message's ID.
}

Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times as a "message.attempt.failing" event.

type MessageAttemptFailedData added in v1.63.0

type MessageAttemptFailedData struct {
	Id                 string    `json:"id"` // The MessageAttempt's ID.
	ResponseStatusCode int16     `json:"responseStatusCode"`
	Timestamp          time.Time `json:"timestamp"`
}

type MessageAttemptFailingEvent added in v1.63.0

type MessageAttemptFailingEvent struct {
	Data MessageAttemptFailingEventData `json:"data"`
	Type string                         `json:"type"`
}

Sent after a message has been failing for a few times. It's sent on the fourth failure. It complements `message.attempt.exhausted` which is sent after the last failure.

type MessageAttemptFailingEventData added in v1.63.0

type MessageAttemptFailingEventData struct {
	AppId       string                   `json:"appId"`            // The Application's ID.
	AppUid      *string                  `json:"appUid,omitempty"` // The Application's UID.
	EndpointId  string                   `json:"endpointId"`       // The Endpoint's ID.
	LastAttempt MessageAttemptFailedData `json:"lastAttempt"`
	MsgEventId  *string                  `json:"msgEventId,omitempty"` // The Message's UID.
	MsgId       string                   `json:"msgId"`                // The Message's ID.
}

Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times as a "message.attempt.failing" event.

type MessageAttemptOut

type MessageAttemptOut struct {
	EndpointId         string                    `json:"endpointId"` // The Endpoint's ID.
	Id                 string                    `json:"id"`         // The MessageAttempt's ID.
	Msg                *MessageOut               `json:"msg,omitempty"`
	MsgId              string                    `json:"msgId"` // The Message's ID.
	Response           string                    `json:"response"`
	ResponseDurationMs int64                     `json:"responseDurationMs"` // Response duration in milliseconds.
	ResponseStatusCode int16                     `json:"responseStatusCode"`
	Status             MessageStatus             `json:"status"`
	StatusText         MessageStatusText         `json:"statusText"`
	Timestamp          time.Time                 `json:"timestamp"`
	TriggerType        MessageAttemptTriggerType `json:"triggerType"`
	Url                string                    `json:"url"`
}

type MessageAttemptRecoveredEvent added in v1.63.0

type MessageAttemptRecoveredEvent struct {
	Data MessageAttemptRecoveredEventData `json:"data"`
	Type string                           `json:"type"`
}

Sent on a successful dispatch after an earlier failure op webhook has already been sent.

type MessageAttemptRecoveredEventData added in v1.63.0

type MessageAttemptRecoveredEventData struct {
	AppId       string                   `json:"appId"`            // The Application's ID.
	AppUid      *string                  `json:"appUid,omitempty"` // The Application's UID.
	EndpointId  string                   `json:"endpointId"`       // The Endpoint's ID.
	LastAttempt MessageAttemptFailedData `json:"lastAttempt"`
	MsgEventId  *string                  `json:"msgEventId,omitempty"` // The Message's UID.
	MsgId       string                   `json:"msgId"`                // The Message's ID.
}

Sent when a message delivery has failed (all of the retry attempts have been exhausted) as a "message.attempt.exhausted" type or after it's failed four times as a "message.attempt.failing" event.

type MessageAttemptTriggerType

type MessageAttemptTriggerType int64

The reason an attempt was made:

- Scheduled = 0 - Manual = 1

const (
	MESSAGEATTEMPTTRIGGERTYPE_SCHEDULED MessageAttemptTriggerType = 0
	MESSAGEATTEMPTTRIGGERTYPE_MANUAL    MessageAttemptTriggerType = 1
)

func (*MessageAttemptTriggerType) UnmarshalJSON

func (v *MessageAttemptTriggerType) UnmarshalJSON(src []byte) error

type MessageEndpointOut

type MessageEndpointOut struct {
	Channels    []string          `json:"channels,omitempty"` // List of message channels this endpoint listens to (omit for all).
	CreatedAt   time.Time         `json:"createdAt"`
	Description string            `json:"description"` // An example endpoint name.
	Disabled    *bool             `json:"disabled,omitempty"`
	FilterTypes []string          `json:"filterTypes,omitempty"`
	Id          string            `json:"id"` // The Endpoint's ID.
	NextAttempt *time.Time        `json:"nextAttempt,omitempty"`
	RateLimit   *uint16           `json:"rateLimit,omitempty"`
	Status      MessageStatus     `json:"status"`
	StatusText  MessageStatusText `json:"statusText"`
	Uid         *string           `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	UpdatedAt   time.Time         `json:"updatedAt"`
	Url         string            `json:"url"`
	Version     int32             `json:"version"`
}

type MessageIn

type MessageIn struct {
	// Optionally creates a new application alongside the message.
	//
	// If the application id or uid that is used in the path already exists, this argument is ignored.
	Application *ApplicationIn `json:"application,omitempty"`
	Channels    []string       `json:"channels,omitempty"` // List of free-form identifiers that endpoints can filter by
	// The date and time at which the message will be delivered.
	//
	// Note that this time is best-effort-only. Must be at least one minute and no more than 24 hours in the future.
	DeliverAt *time.Time `json:"deliverAt,omitempty"`
	EventId   *string    `json:"eventId,omitempty"` // Optional unique identifier for the message
	EventType string     `json:"eventType"`         // The event type's name
	// JSON payload to send as the request body of the webhook.
	//
	// We also support sending non-JSON payloads. Please contact us for more information.
	Payload                map[string]any  `json:"payload"`
	PayloadRetentionHours  *int64          `json:"payloadRetentionHours,omitempty"`  // Optional number of hours to retain the message payload. Note that this is mutually exclusive with `payloadRetentionPeriod`.
	PayloadRetentionPeriod *int64          `json:"payloadRetentionPeriod,omitempty"` // Optional number of days to retain the message payload. Defaults to 90. Note that this is mutually exclusive with `payloadRetentionHours`.
	Tags                   []string        `json:"tags,omitempty"`                   // List of free-form tags that can be filtered by when listing messages
	TransformationsParams  *map[string]any `json:"transformationsParams,omitempty"`  // Extra parameters to pass to Transformations (for future use)
}

type MessageOut

type MessageOut struct {
	Channels  []string       `json:"channels,omitempty"` // List of free-form identifiers that endpoints can filter by
	DeliverAt *time.Time     `json:"deliverAt,omitempty"`
	EventId   *string        `json:"eventId,omitempty"` // Optional unique identifier for the message
	EventType string         `json:"eventType"`         // The event type's name
	Id        string         `json:"id"`                // The Message's ID.
	Payload   map[string]any `json:"payload"`
	Tags      []string       `json:"tags,omitempty"`
	Timestamp time.Time      `json:"timestamp"`
}

type MessageStatus

type MessageStatus int64

The sending status of the message:

- Success = 0 - Pending = 1 - Fail = 2 - Sending = 3

const (
	MESSAGESTATUS_SUCCESS MessageStatus = 0
	MESSAGESTATUS_PENDING MessageStatus = 1
	MESSAGESTATUS_FAIL    MessageStatus = 2
	MESSAGESTATUS_SENDING MessageStatus = 3
)

func (*MessageStatus) UnmarshalJSON

func (v *MessageStatus) UnmarshalJSON(src []byte) error

type MessageStatusText added in v1.75.1

type MessageStatusText string
const (
	MESSAGESTATUSTEXT_SUCCESS MessageStatusText = "success"
	MESSAGESTATUSTEXT_PENDING MessageStatusText = "pending"
	MESSAGESTATUSTEXT_FAIL    MessageStatusText = "fail"
	MESSAGESTATUSTEXT_SENDING MessageStatusText = "sending"
)

func (*MessageStatusText) UnmarshalJSON added in v1.75.1

func (v *MessageStatusText) UnmarshalJSON(src []byte) error

type OperationalWebhookEndpointHeadersIn

type OperationalWebhookEndpointHeadersIn struct {
	Headers map[string]string `json:"headers"`
}

type OperationalWebhookEndpointHeadersOut

type OperationalWebhookEndpointHeadersOut struct {
	Headers   map[string]string `json:"headers"`
	Sensitive []string          `json:"sensitive"`
}

type OperationalWebhookEndpointIn

type OperationalWebhookEndpointIn struct {
	Description *string            `json:"description,omitempty"`
	Disabled    *bool              `json:"disabled,omitempty"`
	FilterTypes []string           `json:"filterTypes,omitempty"`
	Metadata    *map[string]string `json:"metadata,omitempty"`
	RateLimit   *uint16            `json:"rateLimit,omitempty"`
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Secret *string `json:"secret,omitempty"`
	Uid    *string `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	Url    string  `json:"url"`
}

type OperationalWebhookEndpointOut

type OperationalWebhookEndpointOut struct {
	CreatedAt   time.Time         `json:"createdAt"`
	Description string            `json:"description"` // An example endpoint name.
	Disabled    *bool             `json:"disabled,omitempty"`
	FilterTypes []string          `json:"filterTypes,omitempty"`
	Id          string            `json:"id"` // The Endpoint's ID.
	Metadata    map[string]string `json:"metadata"`
	RateLimit   *uint16           `json:"rateLimit,omitempty"`
	Uid         *string           `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	UpdatedAt   time.Time         `json:"updatedAt"`
	Url         string            `json:"url"`
}

type OperationalWebhookEndpointSecretIn

type OperationalWebhookEndpointSecretIn struct {
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Key *string `json:"key,omitempty"`
}

type OperationalWebhookEndpointSecretOut

type OperationalWebhookEndpointSecretOut struct {
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Key string `json:"key"`
}

type OperationalWebhookEndpointUpdate

type OperationalWebhookEndpointUpdate struct {
	Description *string            `json:"description,omitempty"`
	Disabled    *bool              `json:"disabled,omitempty"`
	FilterTypes []string           `json:"filterTypes,omitempty"`
	Metadata    *map[string]string `json:"metadata,omitempty"`
	RateLimit   *uint16            `json:"rateLimit,omitempty"`
	Uid         *string            `json:"uid,omitempty"` // Optional unique identifier for the endpoint.
	Url         string             `json:"url"`
}

type Ordering

type Ordering string

Defines the ordering in a listing of results.

const (
	ORDERING_ASCENDING  Ordering = "ascending"
	ORDERING_DESCENDING Ordering = "descending"
)

func (*Ordering) UnmarshalJSON

func (v *Ordering) UnmarshalJSON(src []byte) error

type OrumIoConfig added in v1.70.0

type OrumIoConfig struct {
	PublicKey string `json:"publicKey"`
}

type OrumIoConfigOut added in v1.70.0

type OrumIoConfigOut struct {
	PublicKey string `json:"publicKey"`
}

type OtelTracingPatchConfig added in v1.77.0

type OtelTracingPatchConfig struct {
	Url *string `json:"url,omitempty"`
}

type PandaDocConfig added in v1.67.0

type PandaDocConfig struct {
	Secret string `json:"secret"`
}

type PandaDocConfigOut added in v1.67.0

type PandaDocConfigOut struct {
}

type PollingEndpointConsumerSeekIn added in v1.63.0

type PollingEndpointConsumerSeekIn struct {
	After time.Time `json:"after"`
}

type PollingEndpointConsumerSeekOut added in v1.63.0

type PollingEndpointConsumerSeekOut struct {
	Iterator string `json:"iterator"`
}

type PollingEndpointMessageOut added in v1.63.0

type PollingEndpointMessageOut struct {
	Channels  []string           `json:"channels,omitempty"` // List of free-form identifiers that endpoints can filter by
	DeliverAt *time.Time         `json:"deliverAt,omitempty"`
	EventId   *string            `json:"eventId,omitempty"` // Optional unique identifier for the message
	EventType string             `json:"eventType"`         // The event type's name
	Headers   *map[string]string `json:"headers,omitempty"`
	Id        string             `json:"id"` // The Message's ID.
	Payload   map[string]any     `json:"payload"`
	Tags      []string           `json:"tags,omitempty"`
	Timestamp time.Time          `json:"timestamp"`
}

The MessageOut equivalent of polling endpoint

type PollingEndpointOut added in v1.63.0

type PollingEndpointOut struct {
	Data     []PollingEndpointMessageOut `json:"data"`
	Done     bool                        `json:"done"`
	Iterator string                      `json:"iterator"`
}

type PortIoConfig added in v1.70.0

type PortIoConfig struct {
	Secret string `json:"secret"`
}

type PortIoConfigOut added in v1.70.0

type PortIoConfigOut struct {
}

type RecoverIn

type RecoverIn struct {
	Since time.Time  `json:"since"`
	Until *time.Time `json:"until,omitempty"`
}

type RecoverOut

type RecoverOut struct {
	Id     string               `json:"id"` // The QueueBackgroundTask's ID.
	Status BackgroundTaskStatus `json:"status"`
	Task   BackgroundTaskType   `json:"task"`
}

type ReplayIn

type ReplayIn struct {
	Since time.Time  `json:"since"`
	Until *time.Time `json:"until,omitempty"`
}

type ReplayOut

type ReplayOut struct {
	Id     string               `json:"id"` // The QueueBackgroundTask's ID.
	Status BackgroundTaskStatus `json:"status"`
	Task   BackgroundTaskType   `json:"task"`
}

type RotatePollerTokenIn added in v1.77.0

type RotatePollerTokenIn struct {
	Expiry *int64 `json:"expiry,omitempty"` // How long the token will be valid for, in seconds. Can be up to 31,536,000 seconds (1 year).
	// Updates the previous token's expiration, in seconds.
	//
	// If set to 0, the old token will immediately be revoked. Must be between 0 and 86,400 seconds (1 day).
	//
	// Defaults to 300 seconds (5 minutes).
	OldTokenExpiry *int64 `json:"oldTokenExpiry,omitempty"`
}

type RotateTokenOut added in v1.63.0

type RotateTokenOut struct {
	IngestUrl string `json:"ingestUrl"`
}

type RutterConfig added in v1.70.0

type RutterConfig struct {
	Secret string `json:"secret"`
}

type RutterConfigOut added in v1.70.0

type RutterConfigOut struct {
}

type S3Config added in v1.77.0

type S3Config struct {
	AccessKeyId     string `json:"accessKeyId"`
	Bucket          string `json:"bucket"`
	Region          string `json:"region"`
	SecretAccessKey string `json:"secretAccessKey"`
}

type SegmentConfig added in v1.63.0

type SegmentConfig struct {
	Secret *string `json:"secret,omitempty"`
}

type SegmentConfigOut added in v1.63.0

type SegmentConfigOut struct {
}

type SettingsInternalIn added in v1.64.1

type SettingsInternalIn struct {
	ApplicationAlertEvents        []ApplicationAlertEvent `json:"applicationAlertEvents,omitempty"`
	ApplicationAlertsDashboardUrl *string                 `json:"applicationAlertsDashboardUrl,omitempty"`
	ApplicationAlertsLogoUrl      *string                 `json:"applicationAlertsLogoUrl,omitempty"`
	ColorPaletteDark              *CustomColorPalette     `json:"colorPaletteDark,omitempty"`
	ColorPaletteLight             *CustomColorPalette     `json:"colorPaletteLight,omitempty"`
	CustomBaseFontSize            *int64                  `json:"customBaseFontSize,omitempty"`
	CustomColor                   *string                 `json:"customColor,omitempty"`
	CustomFontFamily              *string                 `json:"customFontFamily,omitempty"`
	CustomFontFamilyUrl           *string                 `json:"customFontFamilyUrl,omitempty"`
	CustomLogoUrl                 *string                 `json:"customLogoUrl,omitempty"`
	CustomStringsOverride         *CustomStringsOverride  `json:"customStringsOverride,omitempty"`
	CustomThemeOverride           *CustomThemeOverride    `json:"customThemeOverride,omitempty"`
	DisableEndpointOnFailure      *bool                   `json:"disableEndpointOnFailure,omitempty"`
	DisplayName                   *string                 `json:"displayName,omitempty"`
	EnableApplicationAlerts       *bool                   `json:"enableApplicationAlerts,omitempty"`
	EnableChannels                *bool                   `json:"enableChannels,omitempty"`
	EnableEndpointMtlsConfig      *bool                   `json:"enableEndpointMtlsConfig,omitempty"`
	EnableEndpointOauthConfig     *bool                   `json:"enableEndpointOauthConfig,omitempty"`
	EnableIntegrationManagement   *bool                   `json:"enableIntegrationManagement,omitempty"`
	EnableMessageStream           *bool                   `json:"enableMessageStream,omitempty"`
	EnableMsgAtmptLog             *bool                   `json:"enableMsgAtmptLog,omitempty"`
	EnableOtlp                    *bool                   `json:"enableOtlp,omitempty"`
	EnableTransformations         *bool                   `json:"enableTransformations,omitempty"`
	EnforceHttps                  *bool                   `json:"enforceHttps,omitempty"`
	EventCatalogPublished         *bool                   `json:"eventCatalogPublished,omitempty"`
	ReadOnly                      *bool                   `json:"readOnly,omitempty"`
	RequireEndpointChannel        *bool                   `json:"requireEndpointChannel,omitempty"`
	RequireEndpointFilterTypes    *bool                   `json:"requireEndpointFilterTypes,omitempty"`
	RetryPolicy                   []int32                 `json:"retryPolicy,omitempty"`
	SendSvixWebhookHeaders        *bool                   `json:"sendSvixWebhookHeaders,omitempty"`
	ShowUseSvixPlay               *bool                   `json:"showUseSvixPlay,omitempty"`
	WhitelabelHeaders             *bool                   `json:"whitelabelHeaders,omitempty"`
	WipeSuccessfulPayload         *bool                   `json:"wipeSuccessfulPayload,omitempty"`
}

type SettingsInternalOut added in v1.64.1

type SettingsInternalOut struct {
	ApplicationAlertEvents        []ApplicationAlertEvent `json:"applicationAlertEvents,omitempty"`
	ApplicationAlertsDashboardUrl *string                 `json:"applicationAlertsDashboardUrl,omitempty"`
	ApplicationAlertsLogoUrl      *string                 `json:"applicationAlertsLogoUrl,omitempty"`
	ColorPaletteDark              *CustomColorPalette     `json:"colorPaletteDark,omitempty"`
	ColorPaletteLight             *CustomColorPalette     `json:"colorPaletteLight,omitempty"`
	CustomBaseFontSize            *int64                  `json:"customBaseFontSize,omitempty"`
	CustomColor                   *string                 `json:"customColor,omitempty"`
	CustomFontFamily              *string                 `json:"customFontFamily,omitempty"`
	CustomFontFamilyUrl           *string                 `json:"customFontFamilyUrl,omitempty"`
	CustomLogoUrl                 *string                 `json:"customLogoUrl,omitempty"`
	CustomStringsOverride         *CustomStringsOverride  `json:"customStringsOverride,omitempty"`
	CustomThemeOverride           *CustomThemeOverride    `json:"customThemeOverride,omitempty"`
	DisableEndpointOnFailure      *bool                   `json:"disableEndpointOnFailure,omitempty"`
	DisplayName                   *string                 `json:"displayName,omitempty"`
	EnableApplicationAlerts       *bool                   `json:"enableApplicationAlerts,omitempty"`
	EnableChannels                *bool                   `json:"enableChannels,omitempty"`
	EnableEndpointMtlsConfig      *bool                   `json:"enableEndpointMtlsConfig,omitempty"`
	EnableEndpointOauthConfig     *bool                   `json:"enableEndpointOauthConfig,omitempty"`
	EnableIntegrationManagement   *bool                   `json:"enableIntegrationManagement,omitempty"`
	EnableMessageStream           *bool                   `json:"enableMessageStream,omitempty"`
	EnableMsgAtmptLog             *bool                   `json:"enableMsgAtmptLog,omitempty"`
	EnableOtlp                    *bool                   `json:"enableOtlp,omitempty"`
	EnableTransformations         *bool                   `json:"enableTransformations,omitempty"`
	EnforceHttps                  *bool                   `json:"enforceHttps,omitempty"`
	EventCatalogPublished         *bool                   `json:"eventCatalogPublished,omitempty"`
	ReadOnly                      *bool                   `json:"readOnly,omitempty"`
	RequireEndpointChannel        *bool                   `json:"requireEndpointChannel,omitempty"`
	RequireEndpointFilterTypes    *bool                   `json:"requireEndpointFilterTypes,omitempty"`
	RetryPolicy                   []int32                 `json:"retryPolicy,omitempty"`
	SendSvixWebhookHeaders        *bool                   `json:"sendSvixWebhookHeaders,omitempty"`
	ShowSvixBrandFooter           *bool                   `json:"showSvixBrandFooter,omitempty"`
	ShowUseSvixPlay               *bool                   `json:"showUseSvixPlay,omitempty"`
	WhitelabelHeaders             *bool                   `json:"whitelabelHeaders,omitempty"`
	WipeSuccessfulPayload         *bool                   `json:"wipeSuccessfulPayload,omitempty"`
}

type SettingsInternalPatch added in v1.70.0

type SettingsInternalPatch struct {
	ApplicationAlertEvents        []ApplicationAlertEvent               `json:"applicationAlertEvents,omitempty"`
	ApplicationAlertsDashboardUrl utils.Nullable[string]                `json:"applicationAlertsDashboardUrl"`
	ApplicationAlertsLogoUrl      utils.Nullable[string]                `json:"applicationAlertsLogoUrl"`
	ColorPaletteDark              utils.Nullable[CustomColorPalette]    `json:"colorPaletteDark"`
	ColorPaletteLight             utils.Nullable[CustomColorPalette]    `json:"colorPaletteLight"`
	CustomBaseFontSize            utils.Nullable[int64]                 `json:"customBaseFontSize"`
	CustomColor                   utils.Nullable[string]                `json:"customColor"`
	CustomFontFamily              utils.Nullable[string]                `json:"customFontFamily"`
	CustomFontFamilyUrl           utils.Nullable[string]                `json:"customFontFamilyUrl"`
	CustomLogoUrl                 utils.Nullable[string]                `json:"customLogoUrl"`
	CustomStringsOverride         utils.Nullable[CustomStringsOverride] `json:"customStringsOverride"`
	CustomThemeOverride           utils.Nullable[CustomThemeOverride]   `json:"customThemeOverride"`
	DisableEndpointOnFailure      *bool                                 `json:"disableEndpointOnFailure,omitempty"`
	DisplayName                   utils.Nullable[string]                `json:"displayName"`
	EnableApplicationAlerts       *bool                                 `json:"enableApplicationAlerts,omitempty"`
	EnableChannels                *bool                                 `json:"enableChannels,omitempty"`
	EnableEndpointMtlsConfig      *bool                                 `json:"enableEndpointMtlsConfig,omitempty"`
	EnableEndpointOauthConfig     *bool                                 `json:"enableEndpointOauthConfig,omitempty"`
	EnableIntegrationManagement   *bool                                 `json:"enableIntegrationManagement,omitempty"`
	EnableMessageStream           *bool                                 `json:"enableMessageStream,omitempty"`
	EnableMsgAtmptLog             *bool                                 `json:"enableMsgAtmptLog,omitempty"`
	EnableOtlp                    *bool                                 `json:"enableOtlp,omitempty"`
	EnableTransformations         *bool                                 `json:"enableTransformations,omitempty"`
	EnforceHttps                  *bool                                 `json:"enforceHttps,omitempty"`
	EventCatalogPublished         *bool                                 `json:"eventCatalogPublished,omitempty"`
	ReadOnly                      *bool                                 `json:"readOnly,omitempty"`
	RequireEndpointChannel        *bool                                 `json:"requireEndpointChannel,omitempty"`
	RequireEndpointFilterTypes    *bool                                 `json:"requireEndpointFilterTypes,omitempty"`
	RetryPolicy                   utils.Nullable[[]int32]               `json:"retryPolicy"`
	SendSvixWebhookHeaders        *bool                                 `json:"sendSvixWebhookHeaders,omitempty"`
	ShowUseSvixPlay               *bool                                 `json:"showUseSvixPlay,omitempty"`
	WhitelabelHeaders             *bool                                 `json:"whitelabelHeaders,omitempty"`
	WipeSuccessfulPayload         *bool                                 `json:"wipeSuccessfulPayload,omitempty"`
}

func (SettingsInternalPatch) MarshalJSON added in v1.70.0

func (o SettingsInternalPatch) MarshalJSON() ([]byte, error)

type SettingsInternalUpdateOut added in v1.67.0

type SettingsInternalUpdateOut struct {
	ApplicationAlertEvents        []ApplicationAlertEvent `json:"applicationAlertEvents,omitempty"`
	ApplicationAlertsDashboardUrl *string                 `json:"applicationAlertsDashboardUrl,omitempty"`
	ApplicationAlertsLogoUrl      *string                 `json:"applicationAlertsLogoUrl,omitempty"`
	ColorPaletteDark              *CustomColorPalette     `json:"colorPaletteDark,omitempty"`
	ColorPaletteLight             *CustomColorPalette     `json:"colorPaletteLight,omitempty"`
	CustomBaseFontSize            *int64                  `json:"customBaseFontSize,omitempty"`
	CustomColor                   *string                 `json:"customColor,omitempty"`
	CustomFontFamily              *string                 `json:"customFontFamily,omitempty"`
	CustomFontFamilyUrl           *string                 `json:"customFontFamilyUrl,omitempty"`
	CustomLogoUrl                 *string                 `json:"customLogoUrl,omitempty"`
	CustomStringsOverride         *CustomStringsOverride  `json:"customStringsOverride,omitempty"`
	CustomThemeOverride           *CustomThemeOverride    `json:"customThemeOverride,omitempty"`
	DisableEndpointOnFailure      *bool                   `json:"disableEndpointOnFailure,omitempty"`
	DisplayName                   *string                 `json:"displayName,omitempty"`
	EnableApplicationAlerts       *bool                   `json:"enableApplicationAlerts,omitempty"`
	EnableChannels                *bool                   `json:"enableChannels,omitempty"`
	EnableEndpointMtlsConfig      *bool                   `json:"enableEndpointMtlsConfig,omitempty"`
	EnableEndpointOauthConfig     *bool                   `json:"enableEndpointOauthConfig,omitempty"`
	EnableIntegrationManagement   *bool                   `json:"enableIntegrationManagement,omitempty"`
	EnableMessageStream           *bool                   `json:"enableMessageStream,omitempty"`
	EnableMsgAtmptLog             *bool                   `json:"enableMsgAtmptLog,omitempty"`
	EnableOtlp                    *bool                   `json:"enableOtlp,omitempty"`
	EnableTransformations         *bool                   `json:"enableTransformations,omitempty"`
	EnforceHttps                  *bool                   `json:"enforceHttps,omitempty"`
	EventCatalogPublished         *bool                   `json:"eventCatalogPublished,omitempty"`
	ReadOnly                      *bool                   `json:"readOnly,omitempty"`
	RequireEndpointChannel        *bool                   `json:"requireEndpointChannel,omitempty"`
	RequireEndpointFilterTypes    *bool                   `json:"requireEndpointFilterTypes,omitempty"`
	RetryPolicy                   []int32                 `json:"retryPolicy,omitempty"`
	SendSvixWebhookHeaders        *bool                   `json:"sendSvixWebhookHeaders,omitempty"`
	ShowUseSvixPlay               *bool                   `json:"showUseSvixPlay,omitempty"`
	WhitelabelHeaders             *bool                   `json:"whitelabelHeaders,omitempty"`
	WipeSuccessfulPayload         *bool                   `json:"wipeSuccessfulPayload,omitempty"`
}

type ShopifyConfig added in v1.63.0

type ShopifyConfig struct {
	Secret string `json:"secret"`
}

type ShopifyConfigOut added in v1.63.0

type ShopifyConfigOut struct {
}

type SinkHttpConfig added in v1.77.0

type SinkHttpConfig struct {
	Headers *map[string]string `json:"headers,omitempty"`
	Key     *string            `json:"key,omitempty"`
	Url     string             `json:"url"`
}

type SinkOtelV1Config added in v1.77.0

type SinkOtelV1Config struct {
	Headers *map[string]string `json:"headers,omitempty"`
	Url     string             `json:"url"`
}

type SinkSecretOut added in v1.77.0

type SinkSecretOut struct {
	// The endpoint's verification secret.
	//
	// Format: `base64` encoded random bytes optionally prefixed with `whsec_`.
	// It is recommended to not set this and let the server generate the secret.
	Key *string `json:"key,omitempty"`
}

type SinkStatus added in v1.77.0

type SinkStatus string
const (
	SINKSTATUS_ENABLED  SinkStatus = "enabled"
	SINKSTATUS_PAUSED   SinkStatus = "paused"
	SINKSTATUS_DISABLED SinkStatus = "disabled"
	SINKSTATUS_RETRYING SinkStatus = "retrying"
)

func (*SinkStatus) UnmarshalJSON added in v1.77.0

func (v *SinkStatus) UnmarshalJSON(src []byte) error

type SinkStatusIn added in v1.77.0

type SinkStatusIn string
const (
	SINKSTATUSIN_ENABLED  SinkStatusIn = "enabled"
	SINKSTATUSIN_DISABLED SinkStatusIn = "disabled"
)

func (*SinkStatusIn) UnmarshalJSON added in v1.77.0

func (v *SinkStatusIn) UnmarshalJSON(src []byte) error

type SinkTransformIn added in v1.77.0

type SinkTransformIn struct {
	Code *string `json:"code,omitempty"`
}

type SinkTransformationOut added in v1.77.0

type SinkTransformationOut struct {
	Code    *string `json:"code,omitempty"`
	Enabled bool    `json:"enabled"`
}

type SlackConfig added in v1.63.0

type SlackConfig struct {
	Secret string `json:"secret"`
}

type SlackConfigOut added in v1.63.0

type SlackConfigOut struct {
}

type StatusCodeClass

type StatusCodeClass int64

The different classes of HTTP status codes:

- CodeNone = 0 - Code1xx = 100 - Code2xx = 200 - Code3xx = 300 - Code4xx = 400 - Code5xx = 500

const (
	STATUSCODECLASS_CODE_NONE StatusCodeClass = 0
	STATUSCODECLASS_CODE1XX   StatusCodeClass = 100
	STATUSCODECLASS_CODE2XX   StatusCodeClass = 200
	STATUSCODECLASS_CODE3XX   StatusCodeClass = 300
	STATUSCODECLASS_CODE4XX   StatusCodeClass = 400
	STATUSCODECLASS_CODE5XX   StatusCodeClass = 500
)

func (*StatusCodeClass) UnmarshalJSON

func (v *StatusCodeClass) UnmarshalJSON(src []byte) error

type StreamEventTypeIn added in v1.77.0

type StreamEventTypeIn struct {
	Archived     *bool    `json:"archived,omitempty"`
	Deprecated   *bool    `json:"deprecated,omitempty"`
	Description  *string  `json:"description,omitempty"`
	FeatureFlags []string `json:"featureFlags,omitempty"`
	Name         string   `json:"name"` // The event type's name
}

type StreamEventTypeOut added in v1.77.0

type StreamEventTypeOut struct {
	Archived     bool      `json:"archived"`
	CreatedAt    time.Time `json:"createdAt"`
	Deprecated   bool      `json:"deprecated"`
	Description  *string   `json:"description,omitempty"`
	FeatureFlags []string  `json:"featureFlags,omitempty"`
	Name         string    `json:"name"` // The event type's name
	UpdatedAt    time.Time `json:"updatedAt"`
}

type StreamEventTypePatch added in v1.77.0

type StreamEventTypePatch struct {
	Archived     *bool                    `json:"archived,omitempty"`
	Deprecated   *bool                    `json:"deprecated,omitempty"`
	Description  utils.Nullable[string]   `json:"description"`
	FeatureFlags utils.Nullable[[]string] `json:"featureFlags"`
	Name         utils.Nullable[string]   `json:"name"` // The event type's name
}

func (StreamEventTypePatch) MarshalJSON added in v1.77.0

func (o StreamEventTypePatch) MarshalJSON() ([]byte, error)

type StreamIn added in v1.77.0

type StreamIn struct {
	Metadata *map[string]string `json:"metadata,omitempty"`
	Name     string             `json:"name"`          // The stream's name.
	Uid      *string            `json:"uid,omitempty"` // An optional unique identifier for the stream.
}

type StreamOut added in v1.77.0

type StreamOut struct {
	CreatedAt time.Time         `json:"createdAt"`
	Id        string            `json:"id"` // The stream's ID.
	Metadata  map[string]string `json:"metadata"`
	Name      *string           `json:"name,omitempty"` // The stream's name.
	Uid       *string           `json:"uid,omitempty"`  // The stream's UID.
	UpdatedAt time.Time         `json:"updatedAt"`
}

type StreamPatch added in v1.77.0

type StreamPatch struct {
	Description *string                `json:"description,omitempty"` // The Stream's description.
	Metadata    *map[string]string     `json:"metadata,omitempty"`
	Uid         utils.Nullable[string] `json:"uid"` // An optional unique identifier for the stream.
}

func (StreamPatch) MarshalJSON added in v1.77.0

func (o StreamPatch) MarshalJSON() ([]byte, error)

type StreamPortalAccessIn added in v1.77.0

type StreamPortalAccessIn struct {
	// How long the token will be valid for, in seconds.
	//
	// Valid values are between 1 hour and 7 days. The default is 7 days.
	Expiry       *uint64  `json:"expiry,omitempty"`
	FeatureFlags []string `json:"featureFlags,omitempty"` // The set of feature flags the created token will have access to.
	// An optional session ID to attach to the token.
	//
	// When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID.
	SessionId *string `json:"sessionId,omitempty"`
}

type StreamSinkIn added in v1.77.0

type StreamSinkIn struct {
	BatchSize  *uint16  `json:"batchSize,omitempty"`  // How many events will be batched in a request to the Sink.
	EventTypes []string `json:"eventTypes,omitempty"` // A list of event types that filter which events are dispatched to the Sink. An empty list (or null) will not filter out any events.
	// How long to wait before a batch of events is sent, if the `batchSize` is not reached.
	//
	// For example, with a `batchSize` of 100 and `maxWaitSecs` of 10, we will send a request after 10 seconds or 100 events, whichever comes first.
	//
	// Note that we will never send an empty batch of events to the Sink.
	MaxWaitSecs *uint16            `json:"maxWaitSecs,omitempty"`
	Metadata    *map[string]string `json:"metadata,omitempty"`
	// Whether the sink will receive events.
	//
	// If the sink is `enabled`, any events posted to the stream will be dispatched to the Sink in the same order that events were posted to the stream.
	//
	// If the sink is `disabled`, events will not be dispatched to the sink until the sink is reenabled.
	Status *SinkStatusIn      `json:"status,omitempty"`
	Uid    *string            `json:"uid,omitempty"` // An optional unique identifier for the sink.
	Type   StreamSinkInType   `json:"type"`
	Config StreamSinkInConfig `json:"config"`
}

When creating an StreamSinkIn, use the appropriate config structure based on the Type:

  • "poller": No config needed (nil or just ignore the config field)
  • "azureBlobStorage": Use AzureBlobStorageConfig
  • "googleCloudStorage": Use GoogleCloudStorageConfig
  • "amazonS3": Use S3Config
  • "http": Use SinkHttpConfig
  • "otelTracing": Use SinkOtelV1Config

func (StreamSinkIn) MarshalJSON added in v1.77.0

func (i StreamSinkIn) MarshalJSON() ([]byte, error)

func (*StreamSinkIn) UnmarshalJSON added in v1.77.0

func (i *StreamSinkIn) UnmarshalJSON(data []byte) error

type StreamSinkInConfig added in v1.77.0

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

type StreamSinkInType added in v1.77.0

type StreamSinkInType string
const (
	StreamSinkInTypePoller             StreamSinkInType = "poller"
	StreamSinkInTypeAzureBlobStorage   StreamSinkInType = "azureBlobStorage"
	StreamSinkInTypeOtelTracing        StreamSinkInType = "otelTracing"
	StreamSinkInTypeHttp               StreamSinkInType = "http"
	StreamSinkInTypeAmazonS3           StreamSinkInType = "amazonS3"
	StreamSinkInTypeGoogleCloudStorage StreamSinkInType = "googleCloudStorage"
)

type StreamSinkOut added in v1.77.0

type StreamSinkOut struct {
	BatchSize       int32               `json:"batchSize"`
	CreatedAt       time.Time           `json:"createdAt"`
	CurrentIterator string              `json:"currentIterator"`
	EventTypes      []string            `json:"eventTypes,omitempty"`
	FailureReason   *string             `json:"failureReason,omitempty"`
	Id              string              `json:"id"` // The sink's ID.
	MaxWaitSecs     int32               `json:"maxWaitSecs"`
	Metadata        map[string]string   `json:"metadata"`
	NextRetryAt     *time.Time          `json:"nextRetryAt,omitempty"`
	Status          SinkStatus          `json:"status"`
	Uid             *string             `json:"uid,omitempty"` // The sink's UID.
	UpdatedAt       time.Time           `json:"updatedAt"`
	Type            StreamSinkOutType   `json:"type"`
	Config          StreamSinkOutConfig `json:"config"`
}

When creating an StreamSinkOut, use the appropriate config structure based on the Type:

  • "poller": No config needed (nil or just ignore the config field)
  • "azureBlobStorage": Use AzureBlobStorageConfig
  • "googleCloudStorage": Use GoogleCloudStorageConfig
  • "amazonS3": Use S3Config
  • "http": Use SinkHttpConfig
  • "otelTracing": Use SinkOtelV1Config

func (StreamSinkOut) MarshalJSON added in v1.77.0

func (i StreamSinkOut) MarshalJSON() ([]byte, error)

func (*StreamSinkOut) UnmarshalJSON added in v1.77.0

func (i *StreamSinkOut) UnmarshalJSON(data []byte) error

type StreamSinkOutConfig added in v1.77.0

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

type StreamSinkOutType added in v1.77.0

type StreamSinkOutType string
const (
	StreamSinkOutTypePoller             StreamSinkOutType = "poller"
	StreamSinkOutTypeAzureBlobStorage   StreamSinkOutType = "azureBlobStorage"
	StreamSinkOutTypeOtelTracing        StreamSinkOutType = "otelTracing"
	StreamSinkOutTypeHttp               StreamSinkOutType = "http"
	StreamSinkOutTypeAmazonS3           StreamSinkOutType = "amazonS3"
	StreamSinkOutTypeGoogleCloudStorage StreamSinkOutType = "googleCloudStorage"
)

type StreamSinkPatch added in v1.77.0

type StreamSinkPatch struct {
	BatchSize   utils.Nullable[uint16]       `json:"batchSize"`
	EventTypes  []string                     `json:"eventTypes,omitempty"`
	MaxWaitSecs utils.Nullable[uint16]       `json:"maxWaitSecs"`
	Metadata    *map[string]string           `json:"metadata,omitempty"`
	Status      utils.Nullable[SinkStatusIn] `json:"status"`
	Uid         utils.Nullable[string]       `json:"uid"` // The StreamSink's UID.
	Type        StreamSinkPatchType          `json:"type"`
	Config      StreamSinkPatchConfig        `json:"config"`
}

When creating an StreamSinkPatch, use the appropriate config structure based on the Type:

  • "poller": No config needed (nil or just ignore the config field)
  • "amazonS3": Use AmazonS3PatchConfig
  • "azureBlobStorage": Use AzureBlobStoragePatchConfig
  • "googleCloudStorage": Use GoogleCloudStoragePatchConfig
  • "http": Use HttpPatchConfig
  • "otelTracing": Use OtelTracingPatchConfig

func (StreamSinkPatch) MarshalJSON added in v1.77.0

func (i StreamSinkPatch) MarshalJSON() ([]byte, error)

func (*StreamSinkPatch) UnmarshalJSON added in v1.77.0

func (i *StreamSinkPatch) UnmarshalJSON(data []byte) error

type StreamSinkPatchConfig added in v1.77.0

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

type StreamSinkPatchType added in v1.77.0

type StreamSinkPatchType string
const (
	StreamSinkPatchTypePoller             StreamSinkPatchType = "poller"
	StreamSinkPatchTypeAzureBlobStorage   StreamSinkPatchType = "azureBlobStorage"
	StreamSinkPatchTypeOtelTracing        StreamSinkPatchType = "otelTracing"
	StreamSinkPatchTypeHttp               StreamSinkPatchType = "http"
	StreamSinkPatchTypeAmazonS3           StreamSinkPatchType = "amazonS3"
	StreamSinkPatchTypeGoogleCloudStorage StreamSinkPatchType = "googleCloudStorage"
)

type StripeConfig added in v1.63.0

type StripeConfig struct {
	Secret string `json:"secret"`
}

type StripeConfigOut added in v1.63.0

type StripeConfigOut struct {
}

type SvixConfig added in v1.63.0

type SvixConfig struct {
	Secret string `json:"secret"`
}

type SvixConfigOut added in v1.63.0

type SvixConfigOut struct {
}

type TelnyxConfig added in v1.70.0

type TelnyxConfig struct {
	PublicKey string `json:"publicKey"`
}

type TelnyxConfigOut added in v1.70.0

type TelnyxConfigOut struct {
	PublicKey string `json:"publicKey"`
}

type VapiConfig added in v1.70.0

type VapiConfig struct {
	Secret string `json:"secret"`
}

type VapiConfigOut added in v1.70.0

type VapiConfigOut struct {
}

type VeriffConfig added in v1.70.0

type VeriffConfig struct {
	Secret string `json:"secret"`
}

type VeriffConfigOut added in v1.70.0

type VeriffConfigOut struct {
}

type ZoomConfig added in v1.63.0

type ZoomConfig struct {
	Secret string `json:"secret"`
}

type ZoomConfigOut added in v1.63.0

type ZoomConfigOut struct {
}

Source Files

Jump to

Keyboard shortcuts

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