components

type AWSKinesisConfig struct {
	// The name of the AWS Kinesis stream.
	StreamName string `json:"stream_name"`
	// The AWS region where the Kinesis stream is located.
	Region string `json:"region"`
	// Optional. Custom AWS endpoint URL (e.g., for LocalStack or VPC endpoints).
	Endpoint *string `json:"endpoint,omitempty"`
	// Optional. JMESPath template to extract the partition key from the event payload (e.g., `metadata."event-id"`). Defaults to event ID.
	PartitionKeyTemplate *string `json:"partition_key_template,omitempty"`
}

type AWSKinesisCredentials struct {
	// AWS Access Key ID.
	Key string `json:"key"`
	// AWS Secret Access Key.
	Secret string `json:"secret"`
	// Optional AWS Session Token (for temporary credentials).
	Session *string `json:"session,omitempty"`
}

type AWSSQSConfig struct {
	// Optional. Custom AWS endpoint URL (e.g., for LocalStack or specific regions).
	Endpoint *string `json:"endpoint,omitempty"`
	// The URL of the SQS queue.
	QueueURL string `json:"queue_url"`
}

type AWSSQSCredentials struct {
	// AWS Access Key ID.
	Key string `json:"key"`
	// AWS Secret Access Key.
	Secret string `json:"secret"`
	// Optional AWS Session Token (for temporary credentials).
	Session *string `json:"session,omitempty"`
}

type Awss3Config struct {
	// The name of your AWS S3 bucket.
	Bucket string `json:"bucket"`
	// The AWS region where your bucket is located.
	Region string `json:"region"`
	// JMESPath expression for generating S3 object keys. Default is join(”, [time.rfc3339_nano, '_', metadata."event-id", '.json']).
	KeyTemplate *string `json:"key_template,omitempty"`
	// The storage class for the S3 objects (e.g., STANDARD, INTELLIGENT_TIERING, GLACIER, etc.). Defaults to "STANDARD".
	StorageClass *string `json:"storage_class,omitempty"`
}

type Awss3Credentials struct {
	// AWS Access Key ID.
	Key string `json:"key"`
	// AWS Secret Access Key.
	Secret string `json:"secret"`
	// Optional AWS Session Token (for temporary credentials).
	Session *string `json:"session,omitempty"`
}

type AzureServiceBusConfig struct {
	// The name of the Azure Service Bus queue or topic to publish messages to.
	Name string `json:"name"`
}

type AzureServiceBusCredentials struct {
	// The connection string for the Azure Service Bus namespace.
	ConnectionString string `json:"connection_string"`
}

type DeliveryAttempt struct {
	DeliveredAt        *time.Time        `json:"delivered_at,omitempty"`
	Status             *Status           `json:"status,omitempty"`
	ResponseStatusCode *int64            `json:"response_status_code,omitempty"`
	ResponseBody       *string           `json:"response_body,omitempty"`
	ResponseHeaders    map[string]string `json:"response_headers,omitempty"`
}

type Destination struct {
	DestinationWebhook         *DestinationWebhook         `queryParam:"inline" name:"Destination"`
	DestinationAWSSQS          *DestinationAWSSQS          `queryParam:"inline" name:"Destination"`
	DestinationRabbitMQ        *DestinationRabbitMQ        `queryParam:"inline" name:"Destination"`
	DestinationHookdeck        *DestinationHookdeck        `queryParam:"inline" name:"Destination"`
	DestinationAWSKinesis      *DestinationAWSKinesis      `queryParam:"inline" name:"Destination"`
	DestinationAzureServiceBus *DestinationAzureServiceBus `queryParam:"inline" name:"Destination"`
	DestinationAwss3           *DestinationAwss3           `queryParam:"inline" name:"Destination"`

	Type DestinationType
}

type DestinationAWSKinesis struct {
	// Control plane generated ID or user provided ID for the destination.
	ID string `json:"id"`
	// Type of the destination.
	Type DestinationAWSKinesisType `json:"type"`
	// "*" or an array of enabled topics.
	Topics Topics `json:"topics"`
	// ISO Date when the destination was disabled, or null if enabled.
	DisabledAt *time.Time `json:"disabled_at"`
	// ISO Date when the destination was created.
	CreatedAt   time.Time             `json:"created_at"`
	Config      AWSKinesisConfig      `json:"config"`
	Credentials AWSKinesisCredentials `json:"credentials"`
	// A human-readable representation of the destination target (Kinesis stream name). Read-only.
	Target *string `json:"target,omitempty"`
	// A URL link to the destination target (AWS Console link to the stream). Read-only.
	TargetURL *string `json:"target_url,omitempty"`
}

type DestinationAWSKinesisType string

type DestinationAWSSQS struct {
	// Control plane generated ID or user provided ID for the destination.
	ID string `json:"id"`
	// Type of the destination.
	Type DestinationAWSSQSType `json:"type"`
	// "*" or an array of enabled topics.
	Topics Topics `json:"topics"`
	// ISO Date when the destination was disabled, or null if enabled.
	DisabledAt *time.Time `json:"disabled_at"`
	// ISO Date when the destination was created.
	CreatedAt   time.Time         `json:"created_at"`
	Config      AWSSQSConfig      `json:"config"`
	Credentials AWSSQSCredentials `json:"credentials"`
	// A human-readable representation of the destination target (SQS queue name). Read-only.
	Target *string `json:"target,omitempty"`
	// A URL link to the destination target (AWS Console link to the queue). Read-only.
	TargetURL *string `json:"target_url,omitempty"`
}

type DestinationAWSSQSType string

type DestinationAwss3 struct {
	// Control plane generated ID or user provided ID for the destination.
	ID string `json:"id"`
	// Type of the destination.
	Type DestinationAwss3Type `json:"type"`
	// "*" or an array of enabled topics.
	Topics Topics `json:"topics"`
	// ISO Date when the destination was disabled, or null if enabled.
	DisabledAt *time.Time `json:"disabled_at"`
	// ISO Date when the destination was created.
	CreatedAt   time.Time        `json:"created_at"`
	Config      Awss3Config      `json:"config"`
	Credentials Awss3Credentials `json:"credentials"`
	// A human-readable representation of the destination target (bucket and region). Read-only.
	Target *string `json:"target,omitempty"`
	// A URL link to the destination target (AWS Console link to the bucket). Read-only.
	TargetURL *string `json:"target_url,omitempty"`
}

type DestinationAwss3Type string

type DestinationAzureServiceBus struct {
	// Control plane generated ID or user provided ID for the destination.
	ID string `json:"id"`
	// Type of the destination.
	Type DestinationAzureServiceBusType `json:"type"`
	// "*" or an array of enabled topics.
	Topics Topics `json:"topics"`
	// ISO Date when the destination was disabled, or null if enabled.
	DisabledAt *time.Time `json:"disabled_at"`
	// ISO Date when the destination was created.
	CreatedAt   time.Time                  `json:"created_at"`
	Config      AzureServiceBusConfig      `json:"config"`
	Credentials AzureServiceBusCredentials `json:"credentials"`
	// A human-readable representation of the destination target (Azure Service Bus queue/topic name). Read-only.
	Target *string `json:"target,omitempty"`
	// A URL link to the destination target (Azure Portal link to the Service Bus). Read-only.
	TargetURL *string `json:"target_url,omitempty"`
}

type DestinationAzureServiceBusType string

type DestinationCreate struct {
	DestinationCreateWebhook         *DestinationCreateWebhook         `queryParam:"inline" name:"DestinationCreate"`
	DestinationCreateAWSSQS          *DestinationCreateAWSSQS          `queryParam:"inline" name:"DestinationCreate"`
	DestinationCreateRabbitMQ        *DestinationCreateRabbitMQ        `queryParam:"inline" name:"DestinationCreate"`
	DestinationCreateHookdeck        *DestinationCreateHookdeck        `queryParam:"inline" name:"DestinationCreate"`
	DestinationCreateAWSKinesis      *DestinationCreateAWSKinesis      `queryParam:"inline" name:"DestinationCreate"`
	DestinationCreateAzureServiceBus *DestinationCreateAzureServiceBus `queryParam:"inline" name:"DestinationCreate"`
	DestinationCreateAwss3           *DestinationCreateAwss3           `queryParam:"inline" name:"DestinationCreate"`

	Type DestinationCreateType
}

type DestinationCreateAWSKinesis struct {
	// Optional user-provided ID. A UUID will be generated if empty.
	ID *string `json:"id,omitempty"`
	// Type of the destination. Must be 'aws_kinesis'.
	Type DestinationCreateAWSKinesisType `json:"type"`
	// "*" or an array of enabled topics.
	Topics      Topics                `json:"topics"`
	Config      AWSKinesisConfig      `json:"config"`
	Credentials AWSKinesisCredentials `json:"credentials"`
}

type DestinationCreateAWSKinesisType string

type DestinationCreateAWSSQS struct {
	// Optional user-provided ID. A UUID will be generated if empty.
	ID *string `json:"id,omitempty"`
	// Type of the destination. Must be 'aws_sqs'.
	Type DestinationCreateAWSSQSType `json:"type"`
	// "*" or an array of enabled topics.
	Topics      Topics            `json:"topics"`
	Config      AWSSQSConfig      `json:"config"`
	Credentials AWSSQSCredentials `json:"credentials"`
}

type DestinationCreateAWSSQSType string

type DestinationCreateAwss3 struct {
	// Optional user-provided ID. A UUID will be generated if empty.
	ID *string `json:"id,omitempty"`
	// Type of the destination. Must be 'aws_s3'.
	Type DestinationCreateAwss3Type `json:"type"`
	// "*" or an array of enabled topics.
	Topics      Topics           `json:"topics"`
	Config      Awss3Config      `json:"config"`
	Credentials Awss3Credentials `json:"credentials"`
}

type DestinationCreateAwss3Type string

type DestinationCreateAzureServiceBus struct {
	// Optional user-provided ID. A UUID will be generated if empty.
	ID *string `json:"id,omitempty"`
	// Type of the destination. Must be 'azure_servicebus'.
	Type DestinationCreateAzureServiceBusType `json:"type"`
	// "*" or an array of enabled topics.
	Topics      Topics                     `json:"topics"`
	Config      AzureServiceBusConfig      `json:"config"`
	Credentials AzureServiceBusCredentials `json:"credentials"`
}

type DestinationCreateAzureServiceBusType string

type DestinationCreateHookdeck struct {
	// Optional user-provided ID. A UUID will be generated if empty.
	ID *string `json:"id,omitempty"`
	// Type of the destination. Must be 'hookdeck'.
	Type DestinationCreateHookdeckType `json:"type"`
	// "*" or an array of enabled topics.
	Topics      Topics              `json:"topics"`
	Config      any                 `json:"config,omitempty"`
	Credentials HookdeckCredentials `json:"credentials"`
}

type DestinationCreateHookdeckType string

type DestinationCreateRabbitMQ struct {
	// Optional user-provided ID. A UUID will be generated if empty.
	ID *string `json:"id,omitempty"`
	// Type of the destination. Must be 'rabbitmq'.
	Type DestinationCreateRabbitMQType `json:"type"`
	// "*" or an array of enabled topics.
	Topics      Topics              `json:"topics"`
	Config      RabbitMQConfig      `json:"config"`
	Credentials RabbitMQCredentials `json:"credentials"`
}

type DestinationCreateRabbitMQType string

type DestinationCreateType string

type DestinationCreateWebhook struct {
	// Optional user-provided ID. A UUID will be generated if empty.
	ID *string `json:"id,omitempty"`
	// Type of the destination. Must be 'webhook'.
	Type DestinationCreateWebhookType `json:"type"`
	// "*" or an array of enabled topics.
	Topics      Topics              `json:"topics"`
	Config      WebhookConfig       `json:"config"`
	Credentials *WebhookCredentials `json:"credentials,omitempty"`
}

type DestinationCreateWebhookType string

type DestinationHookdeck struct {
	// Control plane generated ID or user provided ID for the destination.
	ID string `json:"id"`
	// Type of the destination.
	Type DestinationHookdeckType `json:"type"`
	// "*" or an array of enabled topics.
	Topics Topics `json:"topics"`
	// ISO Date when the destination was disabled, or null if enabled.
	DisabledAt *time.Time `json:"disabled_at"`
	// ISO Date when the destination was created.
	CreatedAt   time.Time           `json:"created_at"`
	Config      any                 `json:"config,omitempty"`
	Credentials HookdeckCredentials `json:"credentials"`
	// A human-readable representation of the destination target (Hookdeck). Read-only.
	Target *string `json:"target,omitempty"`
	// A URL link to the destination target (e.g., Hookdeck dashboard). Read-only.
	TargetURL *string `json:"target_url,omitempty"`
}

type DestinationHookdeckType string

type DestinationRabbitMQ struct {
	// Control plane generated ID or user provided ID for the destination.
	ID string `json:"id"`
	// Type of the destination.
	Type DestinationRabbitMQType `json:"type"`
	// "*" or an array of enabled topics.
	Topics Topics `json:"topics"`
	// ISO Date when the destination was disabled, or null if enabled.
	DisabledAt *time.Time `json:"disabled_at"`
	// ISO Date when the destination was created.
	CreatedAt   time.Time           `json:"created_at"`
	Config      RabbitMQConfig      `json:"config"`
	Credentials RabbitMQCredentials `json:"credentials"`
	// A human-readable representation of the destination target (RabbitMQ exchange). Read-only.
	Target *string `json:"target,omitempty"`
	// A URL link to the destination target (not applicable for RabbitMQ exchange). Read-only.
	TargetURL *string `json:"target_url,omitempty"`
}

type DestinationRabbitMQType string

type DestinationSchemaField struct {
	Type        DestinationSchemaFieldType `json:"type"`
	Label       *string                    `json:"label,omitempty"`
	Description *string                    `json:"description,omitempty"`
	Required    bool                       `json:"required"`
	// Indicates if the field contains sensitive information.
	Sensitive *bool `json:"sensitive,omitempty"`
	// Default value for the field.
	Default *string `json:"default,omitempty"`
	// Minimum length for a text input.
	Minlength *int64 `json:"minlength,omitempty"`
	// Maximum length for a text input.
	Maxlength *int64 `json:"maxlength,omitempty"`
	// Regex pattern for validation (compatible with HTML5 pattern attribute).
	Pattern *string `json:"pattern,omitempty"`
}

type DestinationSchemaFieldType string

type DestinationType string

type DestinationTypeSchema struct {
	Type        *string `json:"type,omitempty"`
	Label       *string `json:"label,omitempty"`
	Description *string `json:"description,omitempty"`
	// SVG icon string.
	Icon *string `json:"icon,omitempty"`
	// Markdown instructions.
	Instructions *string `json:"instructions,omitempty"`
	// Some destinations may have Oauth flow or other managed-setup flow that can be triggered with a link. If a `remote_setup_url` is set then the user should be prompted to follow the link to configure the destination.
	// See the [building your own UI guide](https://outpost.hookdeck.com/guides/building-your-own-ui.mdx) for recommended UI patterns and wireframes for implementation in your own app.
	RemoteSetupURL *string `json:"remote_setup_url,omitempty"`
	// Config fields are non-secret values that can be stored and displayed to the user in plain text.
	ConfigFields []DestinationSchemaField `json:"config_fields,omitempty"`
	// Credential fields are secret values that will be AES encrypted and obfuscated to the user. Some credentials may not be obfuscated; the destination type dictates the obfuscation logic.
	CredentialFields []DestinationSchemaField `json:"credential_fields,omitempty"`
}

type DestinationUpdate struct {
	DestinationUpdateWebhook    *DestinationUpdateWebhook    `queryParam:"inline" name:"DestinationUpdate"`
	DestinationUpdateAWSSQS     *DestinationUpdateAWSSQS     `queryParam:"inline" name:"DestinationUpdate"`
	DestinationUpdateRabbitMQ   *DestinationUpdateRabbitMQ   `queryParam:"inline" name:"DestinationUpdate"`
	DestinationUpdateHookdeck   *DestinationUpdateHookdeck   `queryParam:"inline" name:"DestinationUpdate"`
	DestinationUpdateAWSKinesis *DestinationUpdateAWSKinesis `queryParam:"inline" name:"DestinationUpdate"`
	DestinationUpdateAwss3      *DestinationUpdateAwss3      `queryParam:"inline" name:"DestinationUpdate"`

	Type DestinationUpdateType
}

type DestinationUpdateAWSKinesis struct {
	// "*" or an array of enabled topics.
	Topics      *Topics                `json:"topics,omitempty"`
	Config      *AWSKinesisConfig      `json:"config,omitempty"`
	Credentials *AWSKinesisCredentials `json:"credentials,omitempty"`
}

type DestinationUpdateAWSSQS struct {
	// "*" or an array of enabled topics.
	Topics      *Topics            `json:"topics,omitempty"`
	Config      *AWSSQSConfig      `json:"config,omitempty"`
	Credentials *AWSSQSCredentials `json:"credentials,omitempty"`
}

type DestinationUpdateAwss3 struct {
	// "*" or an array of enabled topics.
	Topics      *Topics           `json:"topics,omitempty"`
	Config      *Awss3Config      `json:"config,omitempty"`
	Credentials *Awss3Credentials `json:"credentials,omitempty"`
}

type DestinationUpdateHookdeck struct {
	// "*" or an array of enabled topics.
	Topics      *Topics              `json:"topics,omitempty"`
	Config      any                  `json:"config,omitempty"`
	Credentials *HookdeckCredentials `json:"credentials,omitempty"`
}

type DestinationUpdateRabbitMQ struct {
	// "*" or an array of enabled topics.
	Topics      *Topics              `json:"topics,omitempty"`
	Config      *RabbitMQConfig      `json:"config,omitempty"`
	Credentials *RabbitMQCredentials `json:"credentials,omitempty"`
}

type DestinationUpdateType string

type DestinationUpdateWebhook struct {
	// "*" or an array of enabled topics.
	Topics      *Topics                   `json:"topics,omitempty"`
	Config      *WebhookConfig            `json:"config,omitempty"`
	Credentials *WebhookCredentialsUpdate `json:"credentials,omitempty"`
}

type DestinationWebhook struct {
	// Control plane generated ID or user provided ID for the destination.
	ID string `json:"id"`
	// Type of the destination.
	Type DestinationWebhookType `json:"type"`
	// "*" or an array of enabled topics.
	Topics Topics `json:"topics"`
	// ISO Date when the destination was disabled, or null if enabled.
	DisabledAt *time.Time `json:"disabled_at"`
	// ISO Date when the destination was created.
	CreatedAt   time.Time          `json:"created_at"`
	Config      WebhookConfig      `json:"config"`
	Credentials WebhookCredentials `json:"credentials"`
	// A human-readable representation of the destination target (e.g., URL host). Read-only.
	Target *string `json:"target,omitempty"`
	// A URL link to the destination target (the webhook URL). Read-only.
	TargetURL *string `json:"target_url,omitempty"`
}

type DestinationWebhookType string

type Event struct {
	ID            *string `json:"id,omitempty"`
	DestinationID *string `json:"destination_id,omitempty"`
	Topic         *string `json:"topic,omitempty"`
	// Time the event was received/processed.
	Time *time.Time `json:"time,omitempty"`
	// Time the event was successfully delivered.
	SuccessfulAt *time.Time `json:"successful_at,omitempty"`
	// Key-value string pairs of metadata associated with the event.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Freeform JSON data of the event.
	Data map[string]any `json:"data,omitempty"`
}

type HTTPMetadata struct {
	// Raw HTTP response; suitable for custom response parsing
	Response *http.Response `json:"-"`
	// Raw HTTP request; suitable for debugging
	Request *http.Request `json:"-"`
}

type HookdeckCredentials struct {
	// Hookdeck authentication token.
	Token string `json:"token"`
}

type PortalRedirect struct {
	// Redirect URL containing a JWT to authenticate the user with the portal.
	RedirectURL *string `json:"redirect_url,omitempty"`
}

type PublishRequest struct {
	// Optional. A unique identifier for the event. If not provided, a UUID will be generated.
	ID *string `json:"id,omitempty"`
	// The ID of the tenant to publish for.
	TenantID *string `json:"tenant_id,omitempty"`
	// Optional. Route event to a specific destination.
	DestinationID *string `json:"destination_id,omitempty"`
	// Topic name for the event. Required if Outpost has been configured with topics.
	Topic *string `json:"topic,omitempty"`
	// Should event delivery be retried on failure.
	EligibleForRetry *bool `json:"eligible_for_retry,omitempty"`
	// Any key-value string pairs for metadata.
	Metadata map[string]string `json:"metadata,omitempty"`
	// Any JSON payload for the event data.
	Data map[string]any `json:"data"`
}

type PublishResponse struct {
	// The ID of the event that was accepted for publishing. This will be the ID provided in the request's `id` field if present, otherwise it's a server-generated UUID.
	ID string `json:"id"`
}

type RabbitMQConfig struct {
	// RabbitMQ server address (host:port).
	ServerURL string `json:"server_url"`
	// The exchange to publish messages to.
	Exchange string `json:"exchange"`
	// Whether to use TLS connection (amqps). Defaults to "false".
	TLS *TLS `json:"tls,omitempty"`
}

type RabbitMQCredentials struct {
	// RabbitMQ username.
	Username string `json:"username"`
	// RabbitMQ password.
	Password string `json:"password"`
}

type Security struct {
	AdminAPIKey *string `security:"scheme,type=http,subtype=bearer,name=Authorization"`
	TenantJwt   *string `security:"scheme,type=http,subtype=bearer,name=Authorization"`
}

type Status string

type SuccessResponse struct {
	Success *bool `json:"success,omitempty"`
}

type TLS string

type Tenant struct {
	// User-defined system ID for the tenant.
	ID *string `json:"id,omitempty"`
	// Number of destinations associated with the tenant.
	DestinationsCount *int64 `json:"destinations_count,omitempty"`
	// List of subscribed topics across all destinations for this tenant.
	Topics []string `json:"topics,omitempty"`
	// ISO Date when the tenant was created.
	CreatedAt *time.Time `json:"created_at,omitempty"`
}

type TenantToken struct {
	// JWT token scoped to the tenant for safe browser API calls.
	Token *string `json:"token,omitempty"`
}

type Topics struct {
	TopicsEnum *TopicsEnum `queryParam:"inline" name:"Topics"`
	ArrayOfStr []string    `queryParam:"inline" name:"Topics"`

	Type TopicsType
}

type TopicsEnum string

type TopicsType string

type WebhookConfig struct {
	// The URL to send the webhook events to.
	URL string `json:"url"`
}

type WebhookCredentials struct {
	// The secret used for signing webhook requests. Auto-generated if omitted on creation by admin. Read-only for tenants unless rotating.
	Secret *string `json:"secret,omitempty"`
	// The previous secret used during rotation. Valid for 24 hours by default. Read-only.
	PreviousSecret *string `json:"previous_secret,omitempty"`
	// ISO timestamp when the previous secret becomes invalid. Read-only.
	PreviousSecretInvalidAt *time.Time `json:"previous_secret_invalid_at,omitempty"`
}

type WebhookCredentialsUpdate struct {
	// New secret (only allowed for admin).
	Secret *string `json:"secret,omitempty"`
	// Previous secret for rotation (only allowed for admin).
	PreviousSecret *string `json:"previous_secret,omitempty"`
	// Invalidation time for previous secret (only allowed for admin).
	PreviousSecretInvalidAt *time.Time `json:"previous_secret_invalid_at,omitempty"`
	// Set to true to rotate the secret. The current secret becomes the previous_secret, and a new secret is generated. `previous_secret_invalid_at` defaults to 24h if not provided.
	RotateSecret *bool `json:"rotate_secret,omitempty"`
}