models

package
v1.62.0 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 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 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

This section is empty.

Functions

This section is empty.

Types

type AggregateEventTypesOut 

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

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"`
	// 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.
}

type AppPortalAccessOut 

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

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 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.
}

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 ConnectorIn added in v1.58.2 

type ConnectorIn struct {
	Description      *string        `json:"description,omitempty"`
	FeatureFlag      *string        `json:"featureFlag,omitempty"`
	FilterTypes      []string       `json:"filterTypes,omitempty"`
	Instructions     *string        `json:"instructions,omitempty"`
	InstructionsLink *string        `json:"instructionsLink,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_CUSTOMER_IO ConnectorKind = "CustomerIO"
	CONNECTORKIND_DISCORD     ConnectorKind = "Discord"
	CONNECTORKIND_HUBSPOT     ConnectorKind = "Hubspot"
	CONNECTORKIND_INNGEST     ConnectorKind = "Inngest"
	CONNECTORKIND_SALESFORCE  ConnectorKind = "Salesforce"
	CONNECTORKIND_SEGMENT     ConnectorKind = "Segment"
	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 DashboardAccessOut 

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

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 {
	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
	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"`
	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 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 EnvironmentIn 

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

type EnvironmentOut 

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

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 EventTypeFromOpenApi 

type EventTypeFromOpenApi struct {
	Deprecated  bool            `json:"deprecated"`
	Description string          `json:"description"`
	FeatureFlag *string         `json:"featureFlag,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"`
	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"`
	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"`
	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"`
	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 ExpungAllContentsOut added in v1.58.2 

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

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 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 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 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 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 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 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"`
	Timestamp          time.Time                 `json:"timestamp"`
	TriggerType        MessageAttemptTriggerType `json:"triggerType"`
	Url                string                    `json:"url"`
}

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"`
	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
	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
	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 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 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 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 TemplateOut 

type TemplateOut struct {
	CreatedAt        time.Time     `json:"createdAt"`
	Description      string        `json:"description"`
	FeatureFlag      *string       `json:"featureFlag,omitempty"`
	FilterTypes      []string      `json:"filterTypes,omitempty"`
	Id               string        `json:"id"` // The TransformationTemplate's ID.
	Instructions     string        `json:"instructions"`
	InstructionsLink *string       `json:"instructionsLink,omitempty"`
	Kind             ConnectorKind `json:"kind"`
	Name             string        `json:"name"`
	OrgId            string        `json:"orgId"` // The Organization's ID.
	Transformation   string        `json:"transformation"`
	UpdatedAt        time.Time     `json:"updatedAt"`
}

type TransformationTemplateKind 

type TransformationTemplateKind string
const (
	TRANSFORMATIONTEMPLATEKIND_CUSTOM      TransformationTemplateKind = "Custom"
	TRANSFORMATIONTEMPLATEKIND_CUSTOMER_IO TransformationTemplateKind = "CustomerIO"
	TRANSFORMATIONTEMPLATEKIND_DISCORD     TransformationTemplateKind = "Discord"
	TRANSFORMATIONTEMPLATEKIND_HUBSPOT     TransformationTemplateKind = "Hubspot"
	TRANSFORMATIONTEMPLATEKIND_INNGEST     TransformationTemplateKind = "Inngest"
	TRANSFORMATIONTEMPLATEKIND_SALESFORCE  TransformationTemplateKind = "Salesforce"
	TRANSFORMATIONTEMPLATEKIND_SEGMENT     TransformationTemplateKind = "Segment"
	TRANSFORMATIONTEMPLATEKIND_SLACK       TransformationTemplateKind = "Slack"
	TRANSFORMATIONTEMPLATEKIND_TEAMS       TransformationTemplateKind = "Teams"
	TRANSFORMATIONTEMPLATEKIND_TRIGGER_DEV TransformationTemplateKind = "TriggerDev"
	TRANSFORMATIONTEMPLATEKIND_WINDMILL    TransformationTemplateKind = "Windmill"
	TRANSFORMATIONTEMPLATEKIND_ZAPIER      TransformationTemplateKind = "Zapier"
)

func (*TransformationTemplateKind) UnmarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.